FileCrawler

#include "crawler.hh"

Inheritance diagram for FileCrawler:

Public Member Functions
	ASE_DEFINE_MAKE_SHARED (FileCrawler)
String2	assign (const String &utf8path, bool existingfile) override
Resource	canonify (const String &utf8cwd, const String &utf8fragment, bool constraindir, bool constrainfile) override
String	canonify_fspath (const String &fspath, const String &fsfragment, bool constraindir, bool constrainfile)
Resource	current_folder ()
String	expand_fsdir (const String &fsdir)
ResourceS	list_entries ()
Public Member Functions inherited from EmittableImpl
void	emit_event (const String &type, const String &detail, const ValueR fields={}) override
void	emit_notify (const String &detail) override
ASE_USE_RESULT Connection	on_event (const String &eventselector, const EventHandler &eventhandler) override
Public Member Functions inherited from Emittable
void	js_trigger (const String &eventselector, JsTrigger callback)

Protected Member Functions
String2	assign_ (const String &utf8path, bool existingfile, bool notify=true)
ResourceS	get_entries () const override
Resource	get_folder () const override
void	set_entries (const ResourceS &newentries) override
void	set_folder (const Resource &newfolder) override
Protected Member Functions inherited from ObjectImpl
virtual	~ObjectImpl ()=0
Protected Member Functions inherited from EmittableImpl
virtual	~EmittableImpl ()
Protected Member Functions inherited from VirtualBase
virtual	~VirtualBase () noexcept=0
Protected Member Functions inherited from Object
virtual	~Object ()=0
Protected Member Functions inherited from ResourceCrawler
	ResourceCrawler ()

Additional Inherited Members
Public Types inherited from ResourceCrawler
using	String2 = std::pair< String, String >
Public Attributes inherited from ResourceCrawler
Member<&ResourceCrawler::get_entries,&ResourceCrawler::set_entries >	entries
Member<&ResourceCrawler::get_folder,&ResourceCrawler::set_folder >	folder

Detailed Description

Class implementing a file system crawler.

Member Function Documentation

assign_()

FileCrawler::String2 assign_ ( const String & utf8path, bool existingfile, bool notify = true )

protected

Open a new folder and make it the current folder.

get_folder()

Resource get_folder ( ) const

overrideprotectedvirtual

Describe current folder.

Implements ResourceCrawler.

set_folder()

void set_folder ( const Resource & newfolder )

overrideprotectedvirtual

Implements ResourceCrawler.

get_entries()

ResourceS get_entries ( ) const

overrideprotectedvirtual

List entries of a folder.

Implements ResourceCrawler.

set_entries()

void set_entries ( const ResourceS & newentries )

overrideprotectedvirtual

Implements ResourceCrawler.

ASE_DEFINE_MAKE_SHARED()

ASE_DEFINE_MAKE_SHARED

(

FileCrawler

)

list_entries()

ResourceS list_entries

(

)

List all entries in the current folder.

current_folder()

Resource current_folder

(

)

Return the current folder.

assign()

String2 assign ( const String & utf8path, bool existingfile )

overridevirtual

Move to a different path.

Implements ResourceCrawler.

canonify()

Resource canonify ( const String & utf8cwd, const String & utf8fragment, bool constraindir, bool constrainfile )

overridevirtual

Canonify a UTF-8 path name, optionally constraining it to a folder or file.

Implements ResourceCrawler.

canonify_fspath()

String canonify_fspath	(	const String &	fspath,
		const String &	fsfragment,
		bool	constraindir,
		bool	constrainfile
	)

Canonify a path (file system encoding), optionally constraining it to a directory or file.

expand_fsdir()

String expand_fsdir

(

const String &

fsdir

)

Expand directory name (file system encoding) to absolute folder path.