Ceylan::System::FileSystemManager Class Reference

Interface (abstract class) that allows to manage a specific filesystem. More...

#include <CeylanFileSystemManager.h>

Inheritance diagram for Ceylan::System::FileSystemManager:

Inheritance graph
[legend]
Collaboration diagram for Ceylan::System::FileSystemManager:

Collaboration graph
[legend]

List of all members.

Public Types

enum  TextOutputFormat { rawText, html }
 Defines what text output formats for TextDisplayable instances are available. More...

Public Member Functions

virtual bool existsAsEntry (const std::string &entryPath) const =0
 Tells whether the filesystem entry entryPath exists, be it a file, a symbolic link, a directory, a character or block device, a FIFO, a socket, etc.
virtual void createSymbolicLink (const std::string &linkTarget, const std::string &linkName)=0
 Creates a symbolic link on filesystem.
virtual time_t getEntryChangeTime (const std::string &entryPath)=0
 Returns the change time time of the entry entryPath, be it a file, a directory, etc.
virtual const std::string & getRootDirectoryPrefix () const =0
virtual Ceylan::Latin1Char getSeparator () const =0
virtual std::string getSeparatorAsString () const
virtual const std::string & getAliasForCurrentDirectory () const
virtual const std::string & getAliasForParentDirectory () const
virtual FilecreateFile (const std::string &filename, OpeningFlag createFlag=File::CreateToWriteBinary, PermissionFlag permissionFlag=File::OwnerReadWrite)=0
 Returns a File reference on a newly created file.
virtual FileopenFile (const std::string &filename, OpeningFlag openFlag=File::OpenToReadBinary)=0
 Returns a File reference on specified already-existing file, which will be opened with specified settings.
virtual bool existsAsFileOrSymbolicLink (const std::string &filename) const =0
 Tells whether the regular file or symbolic link filename exists (and is not a directory).
virtual void removeFile (const std::string &filename)=0
 Removes the file or symbolic link from the filesystem.
virtual void moveFile (const std::string &sourceFilename, const std::string &targetFilename)=0
 Moves the file on filesystem.
virtual void copyFile (const std::string &sourceFilename, const std::string &targetFilename)=0
 Copies the file on filesystem.
virtual Size getSize (const std::string &filename)=0
 Returns the size, in bytes, of the specified file.
virtual time_t getLastChangeTimeFile (const std::string &filename)=0
 Returns the last change time of the specified file.
virtual std::string transformIntoValidFilename (const std::string &rawFilename)
 Takes specified rawFilename and tries to transform it so that the result should be a valid name, from the filesystem's point of view.
virtual void touch (const std::string &filename)=0
 Updates the last access and modification times of specified file.
virtual bool diff (const std::string &firstFilename, const std::string &secondFilename)
 Tells whether the two specified files have exactly the same content (byte-wise).
virtual DirectorycreateDirectory (const std::string &newDirectoryName)=0
 Returns a Directory reference on a directory newly created on filesystem.
virtual DirectoryopenDirectory (const std::string &directoryName="")=0
 Returns a Directory reference on specified already-existing directory, which will be "opened" (i.e.
virtual bool existsAsDirectory (const std::string &directoryPath) const =0
 Tells whether the directory directoryPath exists and is a directory indeed.
virtual void removeDirectory (const std::string &directoryPath, bool recursive=false)=0
 Removes the directory from filesystem.
virtual void moveDirectory (const std::string &sourceDirectoryPath, const std::string &targetDirectoryPath)=0
 Moves the directory on filesystem.
virtual void copyDirectory (const std::string &sourceDirectoryPath, const std::string &targetDirectoryPath)=0
 Copies the file on filesystem.
virtual time_t getLastChangeTimeDirectory (const std::string &directoryPath)=0
 Returns the last change time of the specified directory.
virtual bool isAValidDirectoryPath (const std::string &directoryString)=0
 Returns whether specified string is a valid directory path.
virtual void removeLeadingSeparator (std::string &path)
 Removes the leading separator, if any, in specified directory's path.
virtual bool isAbsolutePath (const std::string &path)=0
 Tells whether specified path is an absolute path.
virtual std::string getCurrentWorkingDirectoryPath ()=0
 Returns the current working directory path.
virtual void changeWorkingDirectory (const std::string &newWorkingDirectory)=0
 Changes current working directory to newWorkingDirectory.
virtual std::list< std::string > splitPath (const std::string &path)
virtual std::string joinPath (const std::list< std::string > &pathElements)
virtual std::string joinPath (const std::string &firstPath, const std::string &secondPath)
virtual void stripFilename (const std::string &path, std::string *base, std::string *file=0)
 Separates the full pathname path into a basename base and file name file.
virtual const std::string toString (Ceylan::VerbosityLevels level=Ceylan::high) const
 Returns a user-friendly description of the state of this object.

Static Public Member Functions

static bool ExistsAsEntry (const std::string &entryPath)
 Tells whether the filesystem entry entryPath exists, be it a file, a symbolic link, a directory, a character or block device, a FIFO, a socket, etc.
static void CreateSymbolicLink (const std::string &linkTarget, const std::string &linkName)
 Creates a symbolic link on filesystem.
static time_t GetEntryChangeTime (const std::string &entryPath)
 Returns the change time time of the entry entryPath, be it a file, a directory, etc.
static const std::string & GetRootDirectoryPrefix ()
static Ceylan::Latin1Char GetSeparator ()
static std::string GetSeparatorAsString ()
static const std::string & GetAliasForCurrentDirectory ()
static const std::string & GetAliasForParentDirectory ()
static bool IsDefaultFileSystemManagerSet ()
 Returns whether the default filesystem manager is set.
static void SetDefaultFileSystemManager (FileSystemManager &newDefaultFileSystemManager, bool deallocatePreviousIfAny=true)
 Sets the default filesystem manager, the one that will be used if no filesystem manager is specified otherwise.
static void SetDefaultFileSystemManagerToPlatformDefault ()
 Sets the default filesystem manager to the platform default, i.e.
static FileSystemManagerGetExistingDefaultFileSystemManager ()
 Returns a reference to the unique default filesystem manager, that is expected to exist already.
static FileSystemManagerGetAnyDefaultFileSystemManager ()
 Returns a reference to the unique default filesystem manager, that is created from platform defaults if needed.
static void RemoveDefaultFileSystemManager ()
 Removes the current default filesystem manager, if any.
static const std::string ToString (std::list< TextDisplayable * > displayables, Ceylan::VerbosityLevels level=Ceylan::high)
 Returns a user-friendly description of this list of pointers to text displayable instances.
static TextOutputFormat GetOutputFormat ()
 Returns the current overall text format to be used by TextDisplayable instances.
static void SetOutputFormat (TextOutputFormat newOutputFormat)
 Sets the current overall text format to be used by TextDisplayable instances.

Protected Member Functions

 FileSystemManager ()
 Constructs a reference to a filesystem, initializes accordingly any needed subsystem.
virtual ~FileSystemManager () throw ()
 Destroys the Ceylan filesystem reference, not the filesystem itself.

Static Protected Attributes

static FileSystemManager_CurrentDefaultFileSystemManager = 0
 Pointer to the default filesystem manager (if any).
static TextOutputFormat _OutputFormat = rawText
 The text format to be used currently by TextDisplayable instances.

Private Member Functions

 FileSystemManager (const FileSystemManager &source)
 Copy constructor made private to ensure that it will be never called.
FileSystemManageroperator= (const FileSystemManager &source)
 Assignment operator made private to ensure that it will be never called.

Static Private Attributes

static const std::string DefaultAliasForCurrentDirectory = "."
static const std::string DefaultAliasForParentDirectory = ".."


Detailed Description

Interface (abstract class) that allows to manage a specific filesystem.

More than one filesystem can be used at once, and two different filesystems may have to be managed according to very different ways (ex: they have to be initialized differently).

Thus files and directories may be manipulated from various filesystems simultaneously.

Definition at line 158 of file CeylanFileSystemManager.h.


Member Enumeration Documentation

Defines what text output formats for TextDisplayable instances are available.

Enumerator:
rawText 
html 

Definition at line 124 of file CeylanTextDisplayable.h.


Constructor & Destructor Documentation

FileSystemManager::FileSystemManager (  )  [protected]

Constructs a reference to a filesystem, initializes accordingly any needed subsystem.

Cannot be private as has to be subclassed.

Exceptions:
FileSystemManagerException if the operation failed.

Definition at line 651 of file CeylanFileSystemManager.cc.

FileSystemManager::~FileSystemManager (  )  throw () [protected, virtual]

Destroys the Ceylan filesystem reference, not the filesystem itself.

Cannot be private as has to be subclassed.

Definition at line 658 of file CeylanFileSystemManager.cc.

Ceylan::System::FileSystemManager::FileSystemManager ( const FileSystemManager source  )  [private]

Copy constructor made private to ensure that it will be never called.

The compiler should complain whenever this undefined constructor is called, implicitly or not.


Member Function Documentation

virtual void Ceylan::System::FileSystemManager::changeWorkingDirectory ( const std::string &  newWorkingDirectory  )  [pure virtual]

Changes current working directory to newWorkingDirectory.

Parameters:
newWorkingDirectory the target working directory.
Exceptions:
DirectoryChangeFailed if the operation failed or is not supported on the target platform.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by Ceylan::System::Directory::ChangeWorkingDirectory().

virtual void Ceylan::System::FileSystemManager::copyDirectory ( const std::string &  sourceDirectoryPath,
const std::string &  targetDirectoryPath 
) [pure virtual]

Copies the file on filesystem.

Parameters:
sourceDirectoryPath the path of the directory to be copied.
targetDirectoryPath the path of the target directory.
Exceptions:
DirectoryCopyFailed if the operation failed or is not supported on this platform.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by Ceylan::System::Directory::Copy().

virtual void Ceylan::System::FileSystemManager::copyFile ( const std::string &  sourceFilename,
const std::string &  targetFilename 
) [pure virtual]

Copies the file on filesystem.

Parameters:
sourceFilename the filename of the file to be copied.
targetFilename the new filename of the copied file.
Exceptions:
FileCopyFailed if the operation failed or is not supported on this platform.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by Ceylan::System::File::Copy().

virtual Directory& Ceylan::System::FileSystemManager::createDirectory ( const std::string &  newDirectoryName  )  [pure virtual]

Returns a Directory reference on a directory newly created on filesystem.

Parameters:
newDirectoryName the name of the directory to create.
Directory factory, to be used instead of a specific Directory subclass constructor, so that it can return a Directory instance that is actually a specialized one (ex: a StandardDirectory, not an abstract Directory).

Exceptions:
DirectoryException,including DirectoryCreationFailed if the directory creation failed.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by Ceylan::System::Directory::Create().

virtual File& Ceylan::System::FileSystemManager::createFile ( const std::string &  filename,
OpeningFlag  createFlag = File::CreateToWriteBinary,
PermissionFlag  permissionFlag = File::OwnerReadWrite 
) [pure virtual]

Returns a File reference on a newly created file.

By default, it creates a new file on disk. If the name corresponds to an already-existing file, it will be truncated and overwritten.

Parameters:
filename the name of the file.
createFlag the flag describing the creation mode.
permissionFlag the flag describing the requested permissions. On platforms that do not manage permissions, this parameter will be ignored.
See also:
OpeningFlag, PermissionFlag
File factory, to be used instead of a specific File subclass constructor, so that it can return a File instance that is actually a specialized one (ex: a StandardFile, not an abstract File).

Exceptions:
FileException,including FileCreationFailed if the file creation failed or is not supported on this platform.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by Ceylan::System::File::Create().

virtual void Ceylan::System::FileSystemManager::createSymbolicLink ( const std::string &  linkTarget,
const std::string &  linkName 
) [pure virtual]

Creates a symbolic link on filesystem.

Parameters:
linkTarget the full path of the entry the new link should point to.
linkName the filename of the link to create.
Exceptions:
SymlinkFailed if the creation failed, or if the symbolic link feature is not supported.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by CreateSymbolicLink().

void FileSystemManager::CreateSymbolicLink ( const std::string &  linkTarget,
const std::string &  linkName 
) [static]

Creates a symbolic link on filesystem.

Note:
Uses the default filesystem manager.
Parameters:
linkTarget the full path of the entry the new link should point to.
linkName the filename of the link to create.
Exceptions:
FileSystemManagerException,which includes SymlinkFailed if the creation failed or is not supported, and FileSystemManagerDelegatingException if the underlying specialized FileSystemManager instance could not be retrieved.

Definition at line 111 of file CeylanFileSystemManager.cc.

References createSymbolicLink(), and GetAnyDefaultFileSystemManager().

bool FileSystemManager::diff ( const std::string &  firstFilename,
const std::string &  secondFilename 
) [virtual]

Tells whether the two specified files have exactly the same content (byte-wise).

Parameters:
firstFilename the filename of the first file to compare.
secondFilename the filename of the second file to compare.
Returns:
true iff these files exists and have exactly the same content.
Exceptions:
FileDiffFailed if the operation failed or is not supported on this platform.

Definition at line 294 of file CeylanFileSystemManager.cc.

References dataUtils::e, existsAsFileOrSymbolicLink(), generalUtils::false, first, getSize(), openFile(), Ceylan::System::InputStream::readUint8(), Ceylan::Exception::toString(), and generalUtils::true.

Referenced by Ceylan::System::File::Diff().

virtual bool Ceylan::System::FileSystemManager::existsAsDirectory ( const std::string &  directoryPath  )  const [pure virtual]

Tells whether the directory directoryPath exists and is a directory indeed.

Parameters:
directoryPath the directory path to look-up.
Note:
On Windows, files and directories are case-insensitive, and 'c:' is not a directory (it is seen as a drive), whereas 'c:\' is a directory.
Exceptions:
DirectoryLookupFailed if the operation failed (existence test failed with no answer) or is not supported on this platform.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by Ceylan::System::Directory::Exists(), Ceylan::System::Directory::goDown(), Ceylan::System::Directory::isValid(), Ceylan::System::LibfatDirectory::LibfatDirectory(), and Ceylan::System::StandardDirectory::StandardDirectory().

virtual bool Ceylan::System::FileSystemManager::existsAsEntry ( const std::string &  entryPath  )  const [pure virtual]

Tells whether the filesystem entry entryPath exists, be it a file, a symbolic link, a directory, a character or block device, a FIFO, a socket, etc.

Parameters:
entryPath the path of the entry to look-up.
Exceptions:
EntryLookupFailed if the operation failed (existence test failed with no answer) or is not supported on this platform.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by ExistsAsEntry().

bool FileSystemManager::ExistsAsEntry ( const std::string &  entryPath  )  [static]

Tells whether the filesystem entry entryPath exists, be it a file, a symbolic link, a directory, a character or block device, a FIFO, a socket, etc.

Note:
Uses the default filesystem manager.
Parameters:
entryPath the path of the entry to look-up.
Exceptions:
FileSystemManagerException,which includes EntryLookupFailed if the operation failed or is not supported, and FileSystemManagerDelegatingException if the underlying specialized FileSystemManager instance could not be retrieved.

Definition at line 101 of file CeylanFileSystemManager.cc.

References existsAsEntry(), and GetAnyDefaultFileSystemManager().

virtual bool Ceylan::System::FileSystemManager::existsAsFileOrSymbolicLink ( const std::string &  filename  )  const [pure virtual]

Tells whether the regular file or symbolic link filename exists (and is not a directory).

Parameters:
filename the filename to look-up.
This method will work as expected whether the symbolic link feature is enabled or not.

Exceptions:
FileLookupFailed if the operation failed (existence test failed with no answer) or is not supported on this platform.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by diff(), and Ceylan::System::File::ExistsAsFileOrSymbolicLink().

const std::string & FileSystemManager::getAliasForCurrentDirectory (  )  const [virtual]

const string & FileSystemManager::GetAliasForCurrentDirectory (  )  [static]

const std::string & FileSystemManager::getAliasForParentDirectory (  )  const [virtual]

const string & FileSystemManager::GetAliasForParentDirectory (  )  [static]

FileSystemManager & FileSystemManager::GetAnyDefaultFileSystemManager (  )  [static]

Returns a reference to the unique default filesystem manager, that is created from platform defaults if needed.

Ensures that the unique default filesystem manager is set, creates it if needed, ensures it remains a singleton.

If a manager is already available, returns it. Otherwise, it means the user did not wanted to specify a specific one, hence one is created from platform defaults.

Returns:
the current default filesystem manager, either already existing or created from platform defaults.
Exceptions:
FileSystemManagerException if the operation failed.
Note:
This is a helper method to ensure that File and Directory static method can rely in all cases on a filesystem manager.
See also:
GetExistingDefaultFileSystemManager

Definition at line 620 of file CeylanFileSystemManager.cc.

References _CurrentDefaultFileSystemManager, and SetDefaultFileSystemManagerToPlatformDefault().

Referenced by CreateSymbolicLink(), ExistsAsEntry(), GetAliasForCurrentDirectory(), GetAliasForParentDirectory(), Ceylan::System::File::GetCorrespondingFileSystemManager(), Ceylan::System::Directory::GetCorrespondingFileSystemManager(), GetEntryChangeTime(), GetRootDirectoryPrefix(), GetSeparator(), and GetSeparatorAsString().

virtual std::string Ceylan::System::FileSystemManager::getCurrentWorkingDirectoryPath (  )  [pure virtual]

virtual time_t Ceylan::System::FileSystemManager::getEntryChangeTime ( const std::string &  entryPath  )  [pure virtual]

Returns the change time time of the entry entryPath, be it a file, a directory, etc.

Parameters:
entryPath the path of the entry.
Exceptions:
GetChangeTimeFailed if the operation failed or is not supported.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by GetEntryChangeTime().

time_t FileSystemManager::GetEntryChangeTime ( const std::string &  entryPath  )  [static]

Returns the change time time of the entry entryPath, be it a file, a directory, etc.

Note:
Uses the default filesystem manager.
Parameters:
entryPath the path of the entry.
Exceptions:
FileSystemManagerException,which includes GetChangeTimeFailed if the operation failed or is not supported, and FileSystemManagerDelegatingException if the underlying specialized FileSystemManager instance could not be retrieved.

Definition at line 123 of file CeylanFileSystemManager.cc.

References GetAnyDefaultFileSystemManager(), and getEntryChangeTime().

FileSystemManager & FileSystemManager::GetExistingDefaultFileSystemManager (  )  [static]

Returns a reference to the unique default filesystem manager, that is expected to exist already.

Exceptions:
FileSystemManagerException if the operation failed, including if there is no manager available.
See also:
GetAnyDefaultFileSystemManager

Definition at line 606 of file CeylanFileSystemManager.cc.

References _CurrentDefaultFileSystemManager.

virtual time_t Ceylan::System::FileSystemManager::getLastChangeTimeDirectory ( const std::string &  directoryPath  )  [pure virtual]

Returns the last change time of the specified directory.

Parameters:
directoryPath the path of the directory whose last change time is searched.
Exceptions:
DirectoryLastChangeTimeRequestFailed if the operation failed or is not supported on this platform.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by Ceylan::System::Directory::GetLastChangeTime().

virtual time_t Ceylan::System::FileSystemManager::getLastChangeTimeFile ( const std::string &  filename  )  [pure virtual]

Returns the last change time of the specified file.

Parameters:
filename the filename whose last change time is searched.
Exceptions:
FileLastChangeTimeRequestFailed if the operation failed or is not supported on this platform.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by Ceylan::System::File::GetLastChangeTime().

TextDisplayable::TextOutputFormat TextDisplayable::GetOutputFormat (  )  [static, inherited]

virtual const std::string& Ceylan::System::FileSystemManager::getRootDirectoryPrefix (  )  const [pure virtual]

const string & FileSystemManager::GetRootDirectoryPrefix (  )  [static]

virtual Ceylan::Latin1Char Ceylan::System::FileSystemManager::getSeparator (  )  const [pure virtual]

Ceylan::Latin1Char FileSystemManager::GetSeparator (  )  [static]

Definition at line 147 of file CeylanFileSystemManager.cc.

References GetAnyDefaultFileSystemManager(), and getSeparator().

std::string FileSystemManager::getSeparatorAsString (  )  const [virtual]

string FileSystemManager::GetSeparatorAsString (  )  [static]

virtual Size Ceylan::System::FileSystemManager::getSize ( const std::string &  filename  )  [pure virtual]

Returns the size, in bytes, of the specified file.

Parameters:
filename the filename whose size is searched.
Exceptions:
FileSizeRequestFailed if the operation failed (ex: file not found) or is not supported on this platform.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by diff(), Ceylan::System::File::GetSize(), and Ceylan::System::File::size().

virtual bool Ceylan::System::FileSystemManager::isAbsolutePath ( const std::string &  path  )  [pure virtual]

virtual bool Ceylan::System::FileSystemManager::isAValidDirectoryPath ( const std::string &  directoryString  )  [pure virtual]

Returns whether specified string is a valid directory path.

(i.e. checks the name can be used, does not look-up any real filesystem entry).

Parameters:
directoryString the directory string to examine.
Note:
If no regular expression support is available, then the path will be deemed always correct.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by Ceylan::System::Directory::IsAValidDirectoryPath().

bool FileSystemManager::IsDefaultFileSystemManagerSet (  )  [static]

Returns whether the default filesystem manager is set.

Returns:
true iff a default filesystem manager is currently available.

Definition at line 527 of file CeylanFileSystemManager.cc.

References _CurrentDefaultFileSystemManager.

string FileSystemManager::joinPath ( const std::string &  firstPath,
const std::string &  secondPath 
) [virtual]

Definition at line 461 of file CeylanFileSystemManager.cc.

References getSeparatorAsString().

string FileSystemManager::joinPath ( const std::list< std::string > &  pathElements  )  [virtual]

virtual void Ceylan::System::FileSystemManager::moveDirectory ( const std::string &  sourceDirectoryPath,
const std::string &  targetDirectoryPath 
) [pure virtual]

Moves the directory on filesystem.

A special case of directory moving is directory renaming.

Parameters:
sourceDirectoryPath the path of the directory to be moved.
targetDirectoryPath the path of the target directory.
Exceptions:
DirectoryMoveFailed if the operation failed or is not supported on this platform.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by Ceylan::System::Directory::Move().

virtual void Ceylan::System::FileSystemManager::moveFile ( const std::string &  sourceFilename,
const std::string &  targetFilename 
) [pure virtual]

Moves the file on filesystem.

A special case of file moving is file renaming.

Parameters:
sourceFilename the filename of the file to be moved.
targetFilename the target filename of the moved file.
Exceptions:
FileMoveFailed if the operation failed or is not supported on this platform.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by Ceylan::System::File::Move().

virtual Directory& Ceylan::System::FileSystemManager::openDirectory ( const std::string &  directoryName = ""  )  [pure virtual]

Returns a Directory reference on specified already-existing directory, which will be "opened" (i.e.

referred to).

Parameters:
directoryName the name of the directory. If not specified (the string is empty), returns a reference to the current working directory.
Directory factory, to be used instead of a specific Directory subclass constructor, so that it can return a Directory instance that is actually a specialized one (ex: a StandardDirectory, not an abstract Directory).

Exceptions:
DirectoryException,including DirectoryOpeningFailed if the directory opening failed.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by Ceylan::System::Directory::Open().

virtual File& Ceylan::System::FileSystemManager::openFile ( const std::string &  filename,
OpeningFlag  openFlag = File::OpenToReadBinary 
) [pure virtual]

Returns a File reference on specified already-existing file, which will be opened with specified settings.

Parameters:
filename the name of the file.
openFlag the flag describing the opening mode.
See also:
OpeningFlag
File factory, to be used instead of a specific File subclass constructor, so that it can return a File instance that is actually a specialized one (ex: a StandardFile, not an abstract File).

Exceptions:
FileException,including FileOpeningFailed if the file opening failed.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by diff(), and Ceylan::System::File::Open().

FileSystemManager& Ceylan::System::FileSystemManager::operator= ( const FileSystemManager source  )  [private]

Assignment operator made private to ensure that it will be never called.

The compiler should complain whenever this undefined operator is called, implicitly or not.

void FileSystemManager::RemoveDefaultFileSystemManager (  )  [static]

Removes the current default filesystem manager, if any.

Definition at line 632 of file CeylanFileSystemManager.cc.

References _CurrentDefaultFileSystemManager.

virtual void Ceylan::System::FileSystemManager::removeDirectory ( const std::string &  directoryPath,
bool  recursive = false 
) [pure virtual]

Removes the directory from filesystem.

Parameters:
directoryPath the path of the target directory.
recursive if false, the specified directory is expected to be empty, and it will be removed. If true, then the full directory content (including all files and possible subdirectories) and this directory itself will be removed.
Exceptions:
DirectoryRemoveFailed if the operation failed or is not supported.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by Ceylan::System::Directory::Remove().

virtual void Ceylan::System::FileSystemManager::removeFile ( const std::string &  filename  )  [pure virtual]

Removes the file or symbolic link from the filesystem.

Parameters:
filename the filename to remove.
Exceptions:
FileRemoveFailed if the operation failed or is not supported on this platform.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by Ceylan::System::File::remove(), and Ceylan::System::File::Remove().

void FileSystemManager::removeLeadingSeparator ( std::string &  path  )  [virtual]

Removes the leading separator, if any, in specified directory's path.

Parameters:
path the path that will be modified.

Definition at line 377 of file CeylanFileSystemManager.cc.

References getSeparator().

Referenced by Ceylan::System::StandardFileSystemManager::removeDirectory(), Ceylan::System::LibfatFileSystemManager::removeDirectory(), Ceylan::System::Directory::removeLeadingSeparator(), and Ceylan::System::Directory::RemoveLeadingSeparator().

void FileSystemManager::SetDefaultFileSystemManager ( FileSystemManager newDefaultFileSystemManager,
bool  deallocatePreviousIfAny = true 
) [static]

Sets the default filesystem manager, the one that will be used if no filesystem manager is specified otherwise.

Parameters:
deallocatePreviousIfAny if true, any previously existing manager will be deallocated. If false, it would be replaced by not deleted.

Definition at line 536 of file CeylanFileSystemManager.cc.

References _CurrentDefaultFileSystemManager.

void FileSystemManager::SetDefaultFileSystemManagerToPlatformDefault (  )  [static]

Sets the default filesystem manager to the platform default, i.e.

to the manager that is the more natural for the target platform.

On computers (be they UNIX or Windows), the default manager is by default the standard one (StandardFileSystemManager).

On the Nintendo DS, it is the libfat one (LibfatFileSystemManager).

Any previously existing manager will be deallocated first.

Exceptions:
FileSystemManagerException if the operation failed or is not supported.

Definition at line 562 of file CeylanFileSystemManager.cc.

References _CurrentDefaultFileSystemManager, Ceylan::System::LibfatFileSystemManager::GetLibfatFileSystemManager(), and Ceylan::System::StandardFileSystemManager::GetStandardFileSystemManager().

Referenced by GetAnyDefaultFileSystemManager().

void TextDisplayable::SetOutputFormat ( TextOutputFormat  newOutputFormat  )  [static, inherited]

Sets the current overall text format to be used by TextDisplayable instances.

Parameters:
newOutputFormat the new output format.

Definition at line 72 of file CeylanTextDisplayable.cc.

References Ceylan::TextDisplayable::_OutputFormat.

Referenced by Ceylan::Log::LogHolder::LogHolder().

list< string > FileSystemManager::splitPath ( const std::string &  path  )  [virtual]

void FileSystemManager::stripFilename ( const std::string &  path,
std::string *  base,
std::string *  file = 0 
) [virtual]

Separates the full pathname path into a basename base and file name file.

For example, this method applied to "/mnt/raid/md0/LOANI-0.3" returns respectively "/mnt/raid/md0" and "LOANI-0.3", when the separator is '/'.

Parameters:
path the path which is to be stripped.
base if non null, must be a pointer to an already allocated string where the basename will be stored. If not interested in the basename, specify a null (0) pointer instead: this method will act as UNIX "basename".
file if non null, must be a pointer to an already allocated string where the filename will be stored. If not interested in the filename, specify a null (0) pointer instead: this method will act as UNIX "dirname".

Definition at line 471 of file CeylanFileSystemManager.cc.

References getSeparator().

Referenced by Ceylan::System::Directory::StripFilename().

const std::string TextDisplayable::ToString ( std::list< TextDisplayable * >  displayables,
Ceylan::VerbosityLevels  level = Ceylan::high 
) [static, inherited]

Returns a user-friendly description of this list of pointers to text displayable instances.

Parameters:
displayables a list of pointers to TextDisplayable instances/
level the requested verbosity level.
Note:
Text output format is determined from overall settings.
See also:
toString, Ceylan::VerbosityLevels

Definition at line 45 of file CeylanTextDisplayable.cc.

References Ceylan::formatStringList().

const string FileSystemManager::toString ( Ceylan::VerbosityLevels  level = Ceylan::high  )  const [virtual]

Returns a user-friendly description of the state of this object.

Parameters:
level the requested verbosity level.
Note:
Text output format is determined from overall settings.
See also:
TextDisplayable

Implements Ceylan::TextDisplayable.

Reimplemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Definition at line 512 of file CeylanFileSystemManager.cc.

Referenced by getSeparatorAsString().

virtual void Ceylan::System::FileSystemManager::touch ( const std::string &  filename  )  [pure virtual]

Updates the last access and modification times of specified file.

This is not expected to work for directories.

Parameters:
filename the filename of the file whose times must be updated.
Note:
On contrary to the UNIX command touch, if the specified file does not exist, it will not be created. A FileTouchFailed exception would be raised instead.
See also:
File::Create to create empty files.
Exceptions:
FileTouchFailed if the operation failed or is not supported on this platform.

Implemented in Ceylan::System::LibfatFileSystemManager, and Ceylan::System::StandardFileSystemManager.

Referenced by Ceylan::System::File::Touch().

std::string FileSystemManager::transformIntoValidFilename ( const std::string &  rawFilename  )  [virtual]

Takes specified rawFilename and tries to transform it so that the result should be a valid name, from the filesystem's point of view.

Parameters:
rawFilename the filename to convert
Returns:
the converted filename

Definition at line 233 of file CeylanFileSystemManager.cc.

Referenced by Ceylan::System::File::TransformIntoValidFilename().


Member Data Documentation

Pointer to the default filesystem manager (if any).

This default manager is, unless specified otherwise, the one that is deemed the most natural for the target running platform: standard one for computers (either UNIX or Windows), libfat-based one for the Nintendo DS.

Note:
It means it will be the filesystem manager that will be used by default (should no specific manager be specified), which is not necessarily the most usual one for the target platform.
Must be static to allow child classes to unsubscribe their manager if needed.

Definition at line 1146 of file CeylanFileSystemManager.h.

Referenced by GetAnyDefaultFileSystemManager(), GetExistingDefaultFileSystemManager(), IsDefaultFileSystemManagerSet(), RemoveDefaultFileSystemManager(), Ceylan::System::LibfatFileSystemManager::RemoveLibfatFileSystemManager(), Ceylan::System::StandardFileSystemManager::RemoveStandardFileSystemManager(), SetDefaultFileSystemManager(), and SetDefaultFileSystemManagerToPlatformDefault().

TextDisplayable::TextOutputFormat TextDisplayable::_OutputFormat = rawText [static, protected, inherited]

The text format to be used currently by TextDisplayable instances.

Note:
Defaults to raw text.

Definition at line 158 of file CeylanTextDisplayable.h.

Referenced by Ceylan::TextDisplayable::GetOutputFormat(), and Ceylan::TextDisplayable::SetOutputFormat().

const string FileSystemManager::DefaultAliasForCurrentDirectory = "." [static, private]

Definition at line 1160 of file CeylanFileSystemManager.h.

Referenced by getAliasForCurrentDirectory().

const string FileSystemManager::DefaultAliasForParentDirectory = ".." [static, private]

Definition at line 1169 of file CeylanFileSystemManager.h.

Referenced by getAliasForParentDirectory().


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

Generated on Thu Jun 4 20:40:57 2009 for Ceylan by  doxygen 1.5.8