Ase::ResourceCrawler Class Reference

Helper to crawl hierarchical resources. More...

#include "api.hh"

Inheritance diagram for Ase::ResourceCrawler:

Public Types
using	String2 = std::pair< String, String >

Public Member Functions
virtual Resource	get_folder () const =0
	Describe current folder.
virtual void	set_folder (const Resource &newfolder)=0
virtual ResourceS	get_entries () const =0
	List entries of a folder.
virtual void	set_entries (const ResourceS &newentries)=0
virtual String2	assign (const String &utf8path, bool existingfile=false)=0
virtual Resource	canonify (const String &utf8cwd, const String &utf8fragment, bool constraindir, bool constrainfile)=0
	Return absolute path, slash-terminated if directory, constrain to existing paths.
Public Member Functions inherited from Ase::Emittable
virtual void	emit_event (const String &type, const String &detail, const ValueR fields={})=0
virtual void	emit_notify (const String &detail)=0
void	js_trigger (const String &eventselector, JsTrigger callback)
Public Member Functions inherited from std::enable_shared_from_this< SharedBase >
T	enable_shared_from_this (T... args)
T	operator= (T... args)
T	shared_from_this (T... args)
T	weak_from_this (T... args)
T	~enable_shared_from_this (T... args)

Public Attributes
Member<&ResourceCrawler::get_folder,&ResourceCrawler::set_folder >	folder
	The folder currently being browsed, UTF-8 encoded.
Member<&ResourceCrawler::get_entries,&ResourceCrawler::set_entries >	entries
	The entries in the current folder, UTF-8 encoded.
Public Attributes inherited from Ase::Emittable
const EventHandler &	eventhandler

Detailed Description

Helper to crawl hierarchical resources.

Definition at line 368 of file api.hh.

Member Typedef Documentation

String2

using Ase::ResourceCrawler::String2 = std::pair<String,String>

Definition at line 376 of file api.hh.

Constructor & Destructor Documentation

ResourceCrawler()

Ase::ResourceCrawler::ResourceCrawler ( )

explicitprotected

Definition at line 22 of file crawler.cc.

Member Function Documentation

assign()

virtual String2 Ase::ResourceCrawler::assign ( const String &  utf8path, bool  existingfile = false  )

pure virtual

Move to a different path.

Implemented in Ase::FileCrawler.

canonify()

virtual Resource Ase::ResourceCrawler::canonify ( const String &  utf8cwd, const String &  utf8fragment, bool  constraindir, bool  constrainfile  )

pure virtual

Return absolute path, slash-terminated if directory, constrain to existing paths.

Implemented in Ase::FileCrawler.

get_entries()

virtual ResourceS Ase::ResourceCrawler::get_entries ( ) const

pure virtual

List entries of a folder.

Implemented in Ase::FileCrawler.

get_folder()

virtual Resource Ase::ResourceCrawler::get_folder ( ) const

pure virtual

Describe current folder.

Implemented in Ase::FileCrawler.

Member Data Documentation

entries

Member<&ResourceCrawler::get_entries,&ResourceCrawler::set_entries> Ase::ResourceCrawler::entries

The entries in the current folder, UTF-8 encoded.

Definition at line 382 of file api.hh.

folder

Member<&ResourceCrawler::get_folder,&ResourceCrawler::set_folder> Ase::ResourceCrawler::folder

The folder currently being browsed, UTF-8 encoded.

Definition at line 381 of file api.hh.

---

The documentation for this class was generated from the following files:

• ase/api.hh
• ase/crawler.cc