Logo Search packages:      
Sourcecode: pwlib version File versions  Download package

PDirectory Class Reference

#include <pdirect.h>

Inheritance diagram for PDirectory:


List of all members.

Detailed Description

Class to represent a directory in the operating system file system. A directory is a special file that contains a list of file paths.

The directory paths are highly platform dependent and a minimum number of assumptions should be made.

The PDirectory object is a string consisting of a possible volume name, and a series directory names in the path from the volumes root to the directory that the object represents. Each directory is separated by the platform dependent separator character which is defined by the PDIR_SEPARATOR macro. The path always has a trailing separator.

Some platforms allow more than one character to act as a directory separator so when doing any processing the IsSeparator()# function should be used to determine if a character is a possible separator.

The directory may be opened to gain access to the list of files that it contains. Note that the directory does { not} contain the "." and ".." entries that some platforms support.

The ancestor class is dependent on the platform. For file systems that are case sensitive, eg Unix, the ancestor is PString#. For other platforms, the ancestor class is PCaselessString#.

Definition at line 315 of file pdirect.h.

Conversion functions

PInt64 AsInt64 (unsigned base=10) const
long AsInteger (unsigned base=10) const
double AsReal () const
PWORDArray AsUCS2 () const
DWORD AsUnsigned (unsigned base=10) const
PUInt64 AsUnsigned64 (unsigned base=10) const
 operator const unsigned char * () const
PStringsprintf (const char *cfmt,...)
PString ToLiteral () const
PBYTEArray ToPascal () const
PStringvsprintf (const char *cfmt, va_list args)
PStringvsprintf (const PString &fmt, va_list args)
PString psprintf (const char *cfmt,...)
PString pvsprintf (const PString &fmt, va_list args)
PString pvsprintf (const char *cfmt, va_list args)

File system functions

BOOL Change () const
BOOL Create (int perm=PFileInfo::DefaultDirPerms) const
BOOL Exists () const
BOOL Remove ()
static BOOL Change (const PString &path)
static BOOL Create (const PString &p, int perm=PFileInfo::DefaultDirPerms)
static BOOL Exists (const PString &path)
static BOOL Remove (const PString &path)

Access functions

PDirectory GetParent () const
PStringArray GetPath () const
PDirectory GetRoot () const
PFilePathString GetVolume () const
BOOL GetVolumeSpace (PInt64 &total, PInt64 &free, DWORD &clusterSize) const
BOOL IsRoot () const
static PINLINE BOOL IsSeparator (char ch)


virtual PStringMakeEmpty ()
static PString Empty ()
enum  ConversionType {
  Pascal, Basic, Literal, Signed,
  Unsigned, Decimal, Exponent, Printf,

Concatenation operators

PString operator & (char ch) const
PString operator & (const char *cstr) const
PString operator & (const PString &str) const
PStringoperator &= (char ch)
PStringoperator &= (const char *cstr)
PStringoperator &= (const PString &str)
PString operator+ (char ch) const
PString operator+ (const char *cstr) const
PString operator+ (const PString &str) const
PStringoperator+= (char ch)
PStringoperator+= (const char *cstr)
PStringoperator+= (const PString &str)
PString operator & (char ch, const PString &str)
PString operator & (const char *cstr, const PString &str)
PString operator+ (char c, const PString &str)
PString operator+ (const char *cstr, const PString &str)

Public Member Functions

Overrides from class PObject
virtual PObjectClone () const
virtual Comparison Compare (const PObject &obj) const
virtual PINDEX HashFunction () const
virtual void PrintOn (ostream &strm) const
virtual void ReadFrom (istream &strm)
Directory listing functions
virtual void Close ()
 Close the directory during or after a file list scan.
virtual PFilePathString GetEntryName () const
virtual BOOL GetInfo (PFileInfo &info) const
virtual BOOL IsSubDir () const
BOOL Next ()
virtual BOOL Open (int scanMask=PFileInfo::AllFiles)
virtual BOOL Restart (int scanMask=PFileInfo::AllFiles)
Search & replace functions
void Delete (PINDEX start, PINDEX len)
PINDEX Find (const char *cstr, PINDEX offset=0) const
PINDEX Find (const PString &str, PINDEX offset=0) const
PINDEX Find (char ch, PINDEX offset=0) const
PINDEX FindLast (const char *cstr, PINDEX offset=P_MAX_INDEX) const
PINDEX FindLast (const PString &str, PINDEX offset=P_MAX_INDEX) const
PINDEX FindLast (char ch, PINDEX offset=P_MAX_INDEX) const
PINDEX FindOneOf (const char *cset, PINDEX offset=0) const
PINDEX FindOneOf (const PString &set, PINDEX offset=0) const
BOOL FindRegEx (const PRegularExpression &regex, PINDEX &pos, PINDEX &len, PINDEX offset=0, PINDEX maxPos=P_MAX_INDEX) const
PINDEX FindRegEx (const PRegularExpression &regex, PINDEX offset=0) const
void Replace (const PString &target, const PString &subs, BOOL all=FALSE, PINDEX offset=0)
void Splice (const char *cstr, PINDEX pos, PINDEX len=0)
void Splice (const PString &str, PINDEX pos, PINDEX len=0)
Size/Length functions
PINLINE PINDEX GetLength () const
BOOL MakeMinimumSize ()
bool operator! () const
Overrides from class PContainer
virtual BOOL IsEmpty () const
virtual BOOL MakeUnique ()
virtual BOOL SetSize (PINDEX newSize)
Sub-string functions
PString Left (PINDEX len) const
PString LeftTrim () const
PStringArray Lines () const
PString Mid (PINDEX start, PINDEX len=P_MAX_INDEX) const
PString operator() (PINDEX start, PINDEX end) const
PString Right (PINDEX len) const
PString RightTrim () const
PStringArray Tokenise (const char *cseparators, BOOL onePerSeparator=TRUE) const
PStringArray Tokenise (const PString &separators, BOOL onePerSeparator=TRUE) const
PString ToLower () const
PString ToUpper () const
PString Trim () const
Comparison operators
Comparison NumCompare (const char *cstr, PINDEX count=P_MAX_INDEX, PINDEX offset=0) const
Comparison NumCompare (const PString &str, PINDEX count=P_MAX_INDEX, PINDEX offset=0) const
bool operator!= (const char *cstr) const
bool operator!= (const PObject &str) const
bool operator*= (const char *cstr) const
bool operator*= (const PString &str) const
bool operator< (const char *cstr) const
bool operator< (const PObject &str) const
bool operator<= (const char *cstr) const
bool operator<= (const PObject &str) const
bool operator== (const char *cstr) const
bool operator== (const PObject &str) const
bool operator> (const char *cstr) const
bool operator> (const PObject &str) const
bool operator>= (const char *cstr) const
bool operator>= (const PObject &str) const
PDirectoryoperator= (const char *cpathname)
PDirectoryoperator= (const PString &pathname)
 PDirectory (const PString &pathname)
 PDirectory (const char *cpathname)
 PDirectory ()
 Create a directory object of the current working directory.

Protected Member Functions

void Construct ()
void Destruct ()
virtual Comparison InternalCompare (PINDEX offset, PINDEX length, const char *cstr) const
virtual Comparison InternalCompare (PINDEX offset, char c) const
void InternalFromUCS2 (const WORD *ptr, PINDEX len)

Protected Attributes

DIR * directory
struct dirent * entryBuffer
int scanMask
 Mask of file types that the directory scan will return.

Private Member Functions

 PCONTAINERINFO (PDirectory, PFilePathString)

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

Generated by  Doxygen 1.6.0   Back to index