Filesystem object. More...

#include <FSobject.h>

Inheritance diagram for utl::FSobject:

[legend]

Public Types
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
	FSobject (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 a human-readable representation of self to the given output stream. More...

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

virtual void	serialize (Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize to or from a stream. 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...

virtual void	unlink ()
	Remove the object from the filesystem. 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...

Static Public Member Functions
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...

Additional Inherited Members
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

Filesystem object.

FSobject is an abstract base for classes that represent filesystem objects such as files and directories.

Author: Adam McKee

Definition at line 35 of file FSobject.h.

Member Enumeration Documentation

◆ field_t

enum utl::FSobject::field_t

Filesystem object attributes.

Enumerator
field_path	path
field_filename	filename
field_basename	basename
field_suffix	suffix
field_userId	user id
field_groupId	group id
field_size	size
field_mode	mode
field_accessTime	access time
field_modifyTime	modification time (last write)
field_changeTime	change time (last write or inode change)

Definition at line 185 of file FSobject.h.

Constructor & Destructor Documentation

◆ FSobject()

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

inline

Constructor.

Parameters

path	pathname (relative to dir, if given)
dir	(optional) parent directory

Definition at line 45 of file FSobject.h.

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

Member Function Documentation

◆ compare()

virtual int utl::FSobject::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::Object.

Reimplemented in utl::Directory, and utl::Symlink.

◆ copy()

virtual void utl::FSobject::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::Object.

Reimplemented in utl::Directory, and utl::Symlink.

◆ dump()

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

virtual

Dump a human-readable representation of self to the given output stream.

A common use of this is for debugging & testing.

Parameters

os	stream to dump to
level	level of 'verbosity' for the dump

Reimplemented from utl::Object.

Reimplemented in utl::Directory.

◆ getKey()

virtual const Object& utl::FSobject::getKey ( ) const

inlinevirtual

Get the key for this object.

The key for an object is used to re-start the comparison process when all overridden compare() have failed. Usually an object's key uniquely identifies the object, though it doesn't necessarily need to. By default, a class has no associated key.

See also: compare hasKey

Returns: object's key (= self if the object has no key)

Reimplemented from utl::Object.

Definition at line 58 of file FSobject.h.

References utl::ser_default, and utl::serialize().

◆ serialize()

virtual void utl::FSobject::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::Object.

Reimplemented in utl::Directory, and utl::Symlink.

◆ toString()

virtual String utl::FSobject::toString ( ) const

inlinevirtual

Return a string representation of self.

Reimplemented from utl::Object.

Reimplemented in utl::Symlink.

Definition at line 66 of file FSobject.h.

◆ path()

Pathname utl::FSobject::path ( ) const

Get the path.

◆ setPath()

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

Set the path.

Parameters

path	pathname (relative to dir, if given)
dir	(optional) parent directory

◆ relativePath()

Pathname utl::FSobject::relativePath ( ) const

inline

Get the relative path.

Definition at line 83 of file FSobject.h.

◆ directory()

const Directory* utl::FSobject::directory ( ) const

inline

Get the parent directory.

Definition at line 90 of file FSobject.h.

◆ setDirectory()

void utl::FSobject::setDirectory ( const Directory * dir )

inline

Set the parent directory.

Definition at line 97 of file FSobject.h.

◆ exists()

bool utl::FSobject::exists ( bool ignoreEx = false ) const

Determine whether the object exists in the filesystem.

Returns: true if object found in filesystem, false otherwise

Parameters

ignoreEx (optional : false) ignore exception?

◆ rename()

void utl::FSobject::rename	(	const String &	path,
		bool	relative = `true`
	)

Rename the object.

Parameters

path	new path
relative	new path relative to parent directory?

◆ unlink()

virtual void utl::FSobject::unlink ( )

virtual

Remove the object from the filesystem.

Reimplemented in utl::Directory.

◆ create()

static FSobject* utl::FSobject::create	(	const String &	path,
		const Directory *	dir = `nullptr`,
		bool	followLink = `false`
	)

static

Create an instance of the appropriate FSobject-derived class for the filesystem object at the given path.

Parameters

path	pathname (relative to dir, if given)
dir	(optional) parent directory
followLink	(optional : false) dereference sym-link?

◆ isMarked()

bool utl::FSobject::isMarked ( ) const

inline

Get the marked flag.

Definition at line 131 of file FSobject.h.

◆ setMarked()

void utl::FSobject::setMarked ( bool marked )

inline

Set the marked flag.

Definition at line 138 of file FSobject.h.

◆ takeStat()

void utl::FSobject::takeStat ( FSobject & rhs )

Take stat information from another instance.

◆ lstat()

void utl::FSobject::lstat ( bool force = false ) const

Obtain stat information (don't dereference a symlink).

◆ device()

uint32_t utl::FSobject::device ( ) const

Get the device type.

◆ inode()

uint32_t utl::FSobject::inode ( ) const

Get the inode.

◆ mode()

uint32_t utl::FSobject::mode ( ) const

Get the access mode.

◆ setMode()

void utl::FSobject::setMode ( uint32_t mode )

Set the access mode.

◆ numLinks()

uint32_t utl::FSobject::numLinks ( ) const

Get the number of hard links.

◆ userId()

uint32_t utl::FSobject::userId ( ) const

Get the user id.

◆ groupId()

uint32_t utl::FSobject::groupId ( ) const

Get the group id.

◆ deviceType()

uint32_t utl::FSobject::deviceType ( ) const

Get the device type.

◆ size()

size_t utl::FSobject::size ( ) const

Get the size.

◆ blockSize()

ulong_t utl::FSobject::blockSize ( ) const

Get the preferred block size for I/O.

◆ numBlocks()

ulong_t utl::FSobject::numBlocks ( ) const

Get the number of blocks allocated.

◆ accessTime()

Time utl::FSobject::accessTime ( ) const

Get the time of last access.

◆ modifyTime()

Time utl::FSobject::modifyTime ( ) const

Get the time of last modification (writing).

◆ changeTime()

Time utl::FSobject::changeTime ( ) const

Get the time of last change (writing or changing inode information).

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

FSobject.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ field_t

Constructor & Destructor Documentation

◆ FSobject()

Member Function Documentation

◆ compare()

◆ copy()

◆ dump()

◆ getKey()

◆ serialize()

◆ toString()

◆ path()

◆ setPath()

◆ relativePath()

◆ directory()

◆ setDirectory()

◆ exists()

◆ rename()

◆ unlink()

◆ create()

◆ isMarked()

◆ setMarked()

◆ takeStat()

◆ lstat()

◆ device()

◆ inode()

◆ mode()

◆ setMode()

◆ numLinks()

◆ userId()

◆ groupId()

◆ deviceType()

◆ size()

◆ blockSize()

◆ numBlocks()

◆ accessTime()

◆ modifyTime()

◆ changeTime()