#include <Directory.h>

Inheritance diagram for utl::Directory:

Public Types
enum	scan_t { scan_recursive = 1, scan_recursive_flat = 2, scan_followLinks = 4, scan_excludeDotDirs = 8, scan_ignoreEx = 16, scan_append = 32 }
	Scan flags. More...

Public Types inherited from utl::FSobject
enum	field_t { field_path , field_filename, field_basename, field_suffix, field_userId, field_groupId, field_size, field_mode, field_accessTime, field_modifyTime, field_changeTime }
	Filesystem object attributes. More...

Public Member Functions
	Directory (const String &path, const Directory *dir=nullptr)
	Constructor. More...

virtual int	compare (const Object &rhs) const
	Compare with another object. More...

virtual void	copy (const Object &rhs)
	Copy another instance. More...

virtual void	dump (Stream &os, uint_t level=uint_t_max) const
	Dump to a stream by dumping entries. More...

virtual void	serialize (Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize to or from a stream. More...

virtual void	unlink ()
	Remove the object from the filesystem. More...

bool	isFlat () const
	Determine whether a flat scan was done. More...

const Collection *	entries () const
	Get the collection of entries. More...

Collection *	entries ()
	Get the collection of entries. More...

void	takeEntries (Directory &rhs)
	"Steal" the given directory's entries. More...

FSobject *	find (const Pathname &path, bool relative=true) const
	Find an entry matching the given path. More...

void	make (uint_t mode=uint_t_max) const
	Create a directory with the given mode. More...

size_t	scan (uint_t flags=0, Factory factory=nullptr, const Predicate pred=nullptr, bool predVal=true)
	Scan the directory to populate the entries collection. More...

void	rescan (uint_t flags=0, Factory factory=nullptr, const Predicate pred=nullptr, bool predVal=true)
	This method cannot be used if isFlat(). More...

Public Member Functions inherited from utl::FSobject
	FSobject (const String &path, const Directory *dir=nullptr)
	Constructor. More...

virtual const Object &	getKey () const
	Get the key for this object. More...

virtual String	toString () const
	Return a string representation of self. More...

Pathname	path () const
	Get the path. More...

void	setPath (const String &path, const Directory *dir=nullptr)
	Set the path. More...

Pathname	relativePath () const
	Get the relative path. More...

const Directory *	directory () const
	Get the parent directory. More...

void	setDirectory (const Directory *dir)
	Set the parent directory. More...

bool	exists (bool ignoreEx=false) const
	Determine whether the object exists in the filesystem. More...

void	rename (const String &path, bool relative=true)
	Rename the object. More...

bool	isMarked () const
	Get the marked flag. More...

void	setMarked (bool marked)
	Set the marked flag. More...

void	clearStat ()
	Clear stat information.

void	takeStat (FSobject &rhs)
	Take stat information from another instance. More...

void	stat (bool force=false) const
	Obtain stat information.

void	lstat (bool force=false) const
	Obtain stat information (don't dereference a symlink). More...

uint32_t	device () const
	Get the device type. More...

uint32_t	inode () const
	Get the inode. More...

uint32_t	mode () const
	Get the access mode. More...

void	setMode (uint32_t mode)
	Set the access mode. More...

uint32_t	numLinks () const
	Get the number of hard links. More...

uint32_t	userId () const
	Get the user id. More...

uint32_t	groupId () const
	Get the group id. More...

uint32_t	deviceType () const
	Get the device type. More...

size_t	size () const
	Get the size. More...

ulong_t	blockSize () const
	Get the preferred block size for I/O. More...

ulong_t	numBlocks () const
	Get the number of blocks allocated. More...

Time	accessTime () const
	Get the time of last access. More...

Time	modifyTime () const
	Get the time of last modification (writing). More...

Time	changeTime () const
	Get the time of last change (writing or changing inode information). More...

Public Member Functions inherited from utl::Object
void	clear ()
	Revert to initial state. More...

virtual void	vclone (const Object &rhs)
	Make an exact copy of another instance. More...

virtual void	steal (Object &rhs)
	"Steal" the internal representation from another instance. More...

void	dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const
	Front-end for dump() that prints the object's class name. More...

bool	hasKey () const
	Determine whether or not the object has a key. More...

virtual const Object &	getProxiedObject () const
	Get the proxied object (= self if none). More...

virtual Object &	getProxiedObject ()
	Get the proxied object (= self if none). More...

virtual size_t	hash (size_t size) const
	Get the hash code for the object. More...

bool	_isA (const RunTimeClass *runTimeClass) const
	Determine whether self's class is a descendent of the given class. More...

	operator String () const
	Conversion to String. More...

size_t	allocatedSize () const
	Get the total allocated size of this object. More...

virtual size_t	innerAllocatedSize () const
	Get the "inner" allocated size. More...

virtual void	addOwnedIt (const class FwdIt *it) const
	Notify self that it owns the given iterator. More...

virtual void	removeOwnedIt (const class FwdIt *it) const
	Notify self that the given owned iterator has been destroyed. More...

bool	operator< (const Object &rhs) const
	Less-than operator. More...

bool	operator<= (const Object &rhs) const
	Less-than-or-equal-to operator. More...

bool	operator> (const Object &rhs) const
	Greater-than operator. More...

bool	operator>= (const Object &rhs) const
	Greater-than-or-equal-to operator. More...

bool	operator== (const Object &rhs) const
	Equal-to operator. More...

bool	operator!= (const Object &rhs) const
	Unequal-to operator. More...

void	serializeIn (Stream &is, uint_t mode=ser_default)
	Serialize from an input stream. More...

void	serializeOut (Stream &os, uint_t mode=ser_default) const
	Serialize to an output stream. More...

void	serializeOutBoxed (Stream &os, uint_t mode=ser_default) const
	Serialize a boxed object to an output stream. More...

Additional Inherited Members
Static Public Member Functions inherited from utl::FSobject
static FSobject *	create (const String &path, const Directory *dir=nullptr, bool followLink=false)
	Create an instance of the appropriate FSobject-derived class for the filesystem object at the given path. More...

Static Public Member Functions inherited from utl::Object
static Object *	serializeInNullable (Stream &is, uint_t mode=ser_default)
	Serialize a nullptr-able object from an input stream. More...

static void	serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default)
	Serialize a nullptr-able object to an output stream. More...

static void	serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a nullptr-able object to or from a stream. More...

static Object *	serializeInBoxed (Stream &is, uint_t mode=ser_default)
	Serialize a boxed object from an input stream. More...

static void	serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a boxed object to or from a stream. More...

Protected Member Functions inherited from utl::FlagsMI
	FlagsMI ()
	Constructor. More...

virtual	~FlagsMI ()
	Destructor. More...

void	copyFlags (const FlagsMI &rhs)
	Copy the given flags. More...

void	copyFlags (const FlagsMI &rhs, uint_t lsb, uint_t msb)
	Copy (some of) the given flags. More...

void	copyFlags (uint64_t flags, uint_t lsb, uint_t msb)
	Copy (some of) the given flags. More...

bool	getFlag (uint_t flagNum) const
	Get a user-defined flag. More...

void	setFlag (uint_t flagNum, bool val)
	Set a user-defined flag. More...

uint64_t	getFlagsNumber (uint64_t mask, uint64_t shift=0)
	Get a multi-bit value in the flags data (which is stored as one 64-bit integer). More...

void	setFlagsNumber (uint64_t mask, uint64_t shift, uint64_t num)
	Set a multi-bit value in the flags data (which is stored as one 64-bit integer). More...

uint64_t	getFlags () const
	Get the flags. More...

void	setFlags (uint64_t flags)
	Set the flags. More...

Detailed Description

Directory filesystem object.

A directory is a filesystem object that contains references to other filesystem objects. Directories permit files and other objects to be organized in a way that is intuitive for people.

Scanning a directory is a process whereby its entries are discovered by reading the directory from the disk. These entries are translated into instances of FSobject-derived classes and added to the entries collection for the Directory. A recursive scan will scan subdirectories (and their subdirectories, etc.) in order to scan the entire directory tree/branch. The organization of FSobject-derived objects will closely mirror the organization of objects on the disk. For example, suppose that the following directory structure exists:

/foo/
/foo/bar.txt
/foo/bar/
/foo/bar/foobar.txt
/foo/bar/foo.bar.gz

If we scan this structure as follows:

Directory foo("/foo/");

foo.scan();

Then foo's entries will include a File named bar.txt and a Directory named bar. scan() will be recursively called on bar, and its entries will consist of File objects called foobar.txt and foo.bar.gz.

It will look like this:

Directory("/foo/")
    File("bar.txt")
    Directory("bar/")
        File("foobar.txt")
        File("foo.bar.gz")

Although this organization is often the most intuitive and efficient, an alternative technique for recursive scanning is allowed. In a flat recursive scan, all entries for the entire tree are added to the root Directory object:

Directory("/foo/")
    File("bar.txt")
    Directory("bar/")
    File("bar/foobar.txt")
    File("bar/foo.bar.gz")

Author: Adam McKee

Definition at line 75 of file Directory.h.

Member Enumeration Documentation

◆ scan_t

enum utl::Directory::scan_t

Scan flags.

Enumerator
scan_recursive	recursive scan
scan_recursive_flat	flat recursive scan
scan_followLinks	follow symbolic links
scan_excludeDotDirs	exclude "." and ".." entries
scan_ignoreEx	ignore exceptions
scan_append	for internal use only

Definition at line 168 of file Directory.h.

Constructor & Destructor Documentation

◆ Directory()

utl::Directory::Directory	(	const String &	path,
		const Directory *	dir = `nullptr`
	)

inline

Constructor.

Parameters

path	directory path
dir	(optional) parent directory

Definition at line 85 of file Directory.h.

References utl::compare(), utl::copy(), utl::dump(), utl::init(), utl::ser_default, utl::serialize(), and utl::uint_t_max.

Member Function Documentation

◆ compare()

virtual int utl::Directory::compare ( const Object & rhs ) const

virtual

Compare with another object.

If no overridden version succeeds in doing the comparison, then an attempt will be made to re-start the comparison process using one or both of the objects' keys. Usually, an override of compare() should call the superclass's compare() if it doesn't know how to compare itself with the rhs object.

See also: getKey

Returns: < 0 if self < rhs, 0 if self = rhs, > 0 if self > rhs

Parameters

rhs	object to compare with

Reimplemented from utl::FSobject.

◆ copy()

virtual void utl::Directory::copy ( const Object & rhs )

virtual

Copy another instance.

When you override copy(), you should usually call the superclass's copy().

Parameters

rhs	object to copy

Reimplemented from utl::FSobject.

◆ dump()

virtual void utl::Directory::dump	(	Stream &	os,
		uint_t	level = `uint_t_max`
	)		const

virtual

Dump to a stream by dumping entries.

Reimplemented from utl::FSobject.

◆ serialize()

virtual void utl::Directory::serialize	(	Stream &	stream,
		uint_t	io,
		uint_t	mode = `ser_default`
	)

virtual

Serialize to or from a stream.

This is the only virtual method for serialization. You must override this in any class that has data to be serialized, and ensure that the superclass's serialize() gets called.

Parameters

stream	stream to serialize from/to
io	see utl::io_t
mode	see utl::serialize_t

Reimplemented from utl::FSobject.

◆ unlink()

virtual void utl::Directory::unlink ( )

virtual

Remove the object from the filesystem.

Reimplemented from utl::FSobject.

◆ isFlat()

bool utl::Directory::isFlat ( ) const

inline

Determine whether a flat scan was done.

Definition at line 106 of file Directory.h.

◆ entries() [1/2]

const Collection* utl::Directory::entries ( ) const

inline

Get the collection of entries.

Definition at line 113 of file Directory.h.

◆ entries() [2/2]

Collection* utl::Directory::entries ( )

inline

Get the collection of entries.

Definition at line 120 of file Directory.h.

References utl::uint_t_max.

◆ takeEntries()

void utl::Directory::takeEntries ( Directory & rhs )

"Steal" the given directory's entries.

◆ find()

FSobject* utl::Directory::find	(	const Pathname &	path,
		bool	relative = `true`
	)		const

Find an entry matching the given path.

The relative flag indicates whether the given path is relative to the directory's path, or if it includes the directory's path.

Returns: found object (nullptr if none)

Parameters

path	pathname
relative	(optional : true) is path relative to self?

◆ make()

void utl::Directory::make ( uint_t mode = uint_t_max ) const

Create a directory with the given mode.

◆ scan()

size_t utl::Directory::scan	(	uint_t	flags = `0`,
		Factory *	factory = `nullptr`,
		const Predicate *	pred = `nullptr`,
		bool	predVal = `true`
	)

inline

Scan the directory to populate the entries collection.

Parameters

flags	(optional) scan flags (see scan_t)
factory	(optional) create Collection-derived object to store entries
pred	(optional) : predicate : require (pred(fsObject) == predVal)
predVal	(optional : true) predicate value

Definition at line 148 of file Directory.h.

◆ rescan()

void utl::Directory::rescan	(	uint_t	flags = `0`,
		Factory *	factory = `nullptr`,
		const Predicate *	pred = `nullptr`,
		bool	predVal = `true`
	)

This method cannot be used if isFlat().

Rescan the directory to learn about added and/or removed entries. The advantage of rescan() over scan() is that it retains entry collections for sub-directories, and it retains "stat" information for all entries. Thus, information that could still be useful is not thrown away.

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

Directory.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ scan_t

Constructor & Destructor Documentation

◆ Directory()

Member Function Documentation

◆ compare()

◆ copy()

◆ dump()

◆ serialize()

◆ unlink()

◆ isFlat()

◆ entries() [1/2]

◆ entries() [2/2]

◆ takeEntries()

◆ find()

◆ make()

◆ scan()

◆ rescan()