FileSystem Class Reference
[Operating system support]

File System Class This class is a wrapper around some very basic properties of the machine's file system properties. More...

#include <fileSystem.h>

List of all members.

Public Types
Enums
enum	{ MAX_FILENAME_LENGTH = 256, MAX_PATH_LENGTH = BALL_PATH_MAX }
Static Public Member Functions
Static methods
void	canonizePath (String &path) throw ()
	Convert a given filename to a canonical name.
String	baseName (const String &filename)
	Return the base name of a file.
String	path (const String &filename)
	Return the path to a file.
Static Public Attributes
Char Constants
const char	PATH_SEPARATOR
	The character separating directories in a path.
const char *const	CURRENT_DIRECTORY
	The string used to indicate the current directory.
const char *const	PARENT_DIRECTORY
	The string indicating the parent directory.

---

Detailed Description

File System Class This class is a wrapper around some very basic properties of the machine's file system properties.

The method ( canonizePath ) is mainly used by File to obtain a unique and unambiguous representation of a path.

---

Member Enumeration Documentation

anonymous enum

Enumeration values: MAX_FILENAME_LENGTH  The maximum length of a filename. MAX_PATH_LENGTH  The maximum length for a full path.

---

Member Function Documentation

String FileSystem::baseName (  const String &  filename  )  [static]

Return the base name of a file. This strips the path from the filename, i.e. everything before and including the last occurence of PATH_SEPARATOR .

void FileSystem::canonizePath (  String &  path  )  throw () [static]

Convert a given filename to a canonical name. This method creates a unique and unambiguous representation of any absolute or relative path. It expands the user's homedirectory ('~') and duplicate or redundant separators, e.g. '//' is reduced to /'/' and '/./' is removed.

String FileSystem::path (  const String &  filename  )  [static]

Return the path to a file. This method returns the path to a file, i.e. everything up to and including the last occurence of PATH_SEPARATOR .

---

Member Data Documentation

const char* const FileSystem::CURRENT_DIRECTORY [static]

The string used to indicate the current directory. This is usually '.'

const char* const FileSystem::PARENT_DIRECTORY [static]

The string indicating the parent directory. This is usually '..'

const char FileSystem::PATH_SEPARATOR [static]

The character separating directories in a path. This is usually '/'.