ResourceCrawler

#include "api.hh"

Inheritance diagram for ResourceCrawler:

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

Public Member Functions
virtual String2	assign (const String &utf8path, bool existingfile=false)=0
virtual Resource	canonify (const String &utf8cwd, const String &utf8fragment, bool constraindir, bool constrainfile)=0
virtual ResourceS	get_entries () const =0
virtual Resource	get_folder () const =0
virtual void	set_entries (const ResourceS &newentries)=0
virtual void	set_folder (const Resource &newfolder)=0
Public Member Functions inherited from 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)
virtual ASE_USE_RESULT Connection	on_event (const String &eventselector, const EventHandler &eventhandler)=0

Public Attributes
Member<&ResourceCrawler::get_entries,&ResourceCrawler::set_entries >	entries
Member<&ResourceCrawler::get_folder,&ResourceCrawler::set_folder >	folder

Protected Member Functions
	ResourceCrawler ()
Protected Member Functions inherited from Object
virtual	~Object ()=0
Protected Member Functions inherited from VirtualBase
virtual	~VirtualBase () noexcept=0

Detailed Description

Helper to crawl hierarchical resources.

Member Typedef Documentation

String2

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

Constructor & Destructor Documentation

ResourceCrawler()

ResourceCrawler ( )

explicitprotected

Member Function Documentation

get_folder()

virtual Resource get_folder ( ) const

pure virtual

Describe current folder.

Implemented in FileCrawler.

set_folder()

virtual void set_folder ( const Resource & newfolder )

pure virtual

Implemented in FileCrawler.

get_entries()

virtual ResourceS get_entries ( ) const

pure virtual

List entries of a folder.

Implemented in FileCrawler.

set_entries()

virtual void set_entries ( const ResourceS & newentries )

pure virtual

Implemented in FileCrawler.

assign()

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

pure virtual

Move to a different path.

Implemented in FileCrawler.

canonify()

virtual Resource 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 FileCrawler.

Member Data Documentation

folder

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

The folder currently being browsed, UTF-8 encoded.

entries

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

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