HDK_Sample::FS_HomeInfoHelper Class Reference

Class to stat a file. The class tests for a "home:" prefix and replaces it with $HOME. More...

#include <FS_HomeHelper.h>

Inheritance diagram for HDK_Sample::FS_HomeInfoHelper:

Public Member Functions
	FS_HomeInfoHelper ()
	~FS_HomeInfoHelper () override
bool	canHandle (const char *source) override
	Determine whether this helper can process the filename. More...
bool	hasAccess (const char *source, int mode) override
bool	getIsDirectory (const char *source) override
	Return whether the filename is a directory. More...
int	getModTime (const char *source) override
	Get the modification timestamp (returns time_t) More...
int64	getSize (const char *source) override
	Get the file size in bytes. More...
UT_String	getExtension (const char *source) override
bool	getContents (const char *source, UT_StringArray &contents, UT_StringArray *dirs) override
Public Member Functions inherited from FS_InfoHelper
	FS_InfoHelper ()
virtual	~FS_InfoHelper ()
virtual char	getNextSepChar (const char *)
	Next separator character. More...
virtual char	getPrevSepChar (const char *)
	Previous separator character. More...
virtual bool	customNavigatePath (UT_String &path, const char *file)
virtual bool	getPathOnDisk (UT_String &path, const char *file)

Detailed Description

Class to stat a file. The class tests for a "home:" prefix and replaces it with $HOME.

Examples:

FS/FS_HomeHelper.C.

Definition at line 93 of file FS_HomeHelper.h.

Constructor & Destructor Documentation

FS_HomeInfoHelper::FS_HomeInfoHelper

(

)

Examples:

FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 465 of file FS_HomeHelper.C.

FS_HomeInfoHelper::~FS_HomeInfoHelper ( )

override

Examples:

FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 470 of file FS_HomeHelper.C.

Member Function Documentation

bool FS_HomeInfoHelper::canHandle ( const char *  source )

overridevirtual

Determine whether this helper can process the filename.

Implements FS_InfoHelper.

Examples:

FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 475 of file FS_HomeHelper.C.

bool FS_HomeInfoHelper::getContents ( const char *  source, UT_StringArray &  contents, UT_StringArray *  dirs  )

overridevirtual

Read the contents of a directory

Parameters

source	- The directory to read
contents	- The list of files in the directory
dirs	- The list of directories in the directory If dirs is NULL, then all directories should be included in the contents.

Implements FS_InfoHelper.

Examples:

FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 569 of file FS_HomeHelper.C.

UT_String FS_HomeInfoHelper::getExtension ( const char *  source )

overridevirtual

Reimplemented from FS_InfoHelper.

Examples:

FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 541 of file FS_HomeHelper.C.

bool FS_HomeInfoHelper::getIsDirectory ( const char *  source )

overridevirtual

Return whether the filename is a directory.

Implements FS_InfoHelper.

Examples:

FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 496 of file FS_HomeHelper.C.

int FS_HomeInfoHelper::getModTime ( const char *  source )

overridevirtual

Get the modification timestamp (returns time_t)

Implements FS_InfoHelper.

Examples:

FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 511 of file FS_HomeHelper.C.

int64 FS_HomeInfoHelper::getSize ( const char *  source )

overridevirtual

Get the file size in bytes.

Implements FS_InfoHelper.

Examples:

FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 526 of file FS_HomeHelper.C.

bool FS_HomeInfoHelper::hasAccess ( const char *  source, int  mode  )

overridevirtual

Parameters

source	Filename for access check
mode	The read/write/execute status

See Also

FS_FileAccessMode

Implements FS_InfoHelper.

Examples:

FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 481 of file FS_HomeHelper.C.

---

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

• samples/FS/FS_HomeHelper.h
• samples/FS/FS_HomeHelper.C