FileSystem.hpp File Reference

#include "blocxx/BLOCXX_config.h"
#include "blocxx/Types.hpp"
#include "blocxx/ArrayFwd.hpp"
#include "blocxx/Exception.hpp"
#include "blocxx/CommonFwd.hpp"
#include <sys/param.h>

Go to the source code of this file.

Namespaces

namespace  BLOCXX_NAMESPACE
namespace  BLOCXX_NAMESPACE::FileSystem
namespace  BLOCXX_NAMESPACE::FileSystem::Path

Classes

class  BLOCXX_NAMESPACE::FileSystemException

Defines

#define MAXPATHLEN   1024

Functions

File BLOCXX_NAMESPACE::FileSystem::openFile (const String &path)
 Open a file for read/write and return an File object that can be used for reading and writing.
File BLOCXX_NAMESPACE::FileSystem::createFile (const String &path)
 Create the file for the given name.
File BLOCXX_NAMESPACE::FileSystem::openOrCreateFile (const String &path)
 Opens or creates the file for the given name.
int BLOCXX_NAMESPACE::FileSystem::changeFileOwner (const String &filename, const UserId &userId)
 Change the given file ownership.
bool BLOCXX_NAMESPACE::FileSystem::exists (const String &path)
bool BLOCXX_NAMESPACE::FileSystem::isExecutable (const String &path)
 Tests if a file is executable.
bool BLOCXX_NAMESPACE::FileSystem::canRead (const String &path)
bool BLOCXX_NAMESPACE::FileSystem::canWrite (const String &path)
bool BLOCXX_NAMESPACE::FileSystem::isLink (const String &path)
 Tests if a file is a symbolic link.
bool BLOCXX_NAMESPACE::FileSystem::isDirectory (const String &path)
bool BLOCXX_NAMESPACE::FileSystem::changeDirectory (const String &path)
 Change to the given directory.
bool BLOCXX_NAMESPACE::FileSystem::makeDirectory (const String &path, int mode=0777)
 Create a directory.
bool BLOCXX_NAMESPACE::FileSystem::getFileSize (const String &path, off_t &size)
 Get the size of the file in bytes.
bool BLOCXX_NAMESPACE::FileSystem::removeDirectory (const String &path)
 Remove the given directory.
bool BLOCXX_NAMESPACE::FileSystem::removeFile (const String &path)
 Remove the given file.
bool BLOCXX_NAMESPACE::FileSystem::getDirectoryContents (const String &path, StringArray &dirEntries)
 Get the names of the files (and directories) in the given directory.
bool BLOCXX_NAMESPACE::FileSystem::renameFile (const String &oldFileName, const String &newFileName)
 Rename the given file to the new name.
size_t BLOCXX_NAMESPACE::FileSystem::read (const FileHandle &hdl, void *bfr, size_t numberOfBytes, off_t offset=-1L)
 Read data from file.
size_t BLOCXX_NAMESPACE::FileSystem::write (FileHandle &hdl, const void *bfr, size_t numberOfBytes, off_t offset=-1L)
 Write data to a file.
off_t BLOCXX_NAMESPACE::FileSystem::seek (const FileHandle &hdl, off_t offset, int whence)
 Seek to a given offset within the file.
off_t BLOCXX_NAMESPACE::FileSystem::tell (const FileHandle &hdl)
void BLOCXX_NAMESPACE::FileSystem::rewind (const FileHandle &hdl)
 Position the file pointer associated with the given file handle to the beginning of the file.
int BLOCXX_NAMESPACE::FileSystem::close (const FileHandle &hdl)
 Close file handle.
int BLOCXX_NAMESPACE::FileSystem::flush (FileHandle &hdl)
 Flush any buffered data to the file if buffering supported.
String BLOCXX_NAMESPACE::FileSystem::getFileContents (const String &filename)
 Read and return the contents of a text file.
StringArray BLOCXX_NAMESPACE::FileSystem::getFileLines (const String &filename)
 Read and return the lines of a test file.
String BLOCXX_NAMESPACE::FileSystem::readSymbolicLink (const String &path)
 Read the value of a symbolic link.
String BLOCXX_NAMESPACE::FileSystem::Path::realPath (const String &path)
 Convert path to the canonicalized absolute pathname by expanding all symbolic links and resolving references to /.
String BLOCXX_NAMESPACE::FileSystem::Path::dirname (const String &filename)
 Take a string that contains a pathname, and return a string that is a pathname of the parent directory of that file.
String BLOCXX_NAMESPACE::FileSystem::Path::getCurrentWorkingDirectory ()
 Get the process's current working directory.


Define Documentation

#define MAXPATHLEN   1024
 

Author:
Jon Carey

Dan Nuffer

Definition at line 53 of file FileSystem.hpp.

Referenced by BLOCXX_NAMESPACE::FileSystem::Path::getCurrentWorkingDirectory(), and BLOCXX_NAMESPACE::FileSystem::readSymbolicLink().


Generated on Fri Jun 16 15:39:09 2006 for blocxx by  doxygen 1.4.6