Api.h File Reference

#include "colony_map.h"
#include "Cpl/Text/FString.h"
#include "Cpl/Type/Traverser.h"
#include <time.h>

Include dependency graph for Api.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	Cpl::Io::File::Api
	This concrete class defines the interface for handling and manipulating entries in the System's File system. More...
struct	Cpl::Io::File::Api::Info
	This data structure defines status attributes for a file system entry. More...
class	Cpl::Io::File::Api::DirectoryWalker
	This abstract class defines the client interface for walking the contents of a directory, i.e. More...

Namespaces
namespace	Cpl
	The 'Cpl' namespace is the root name space for the Colony.
namespace	Cpl::Io
	The Io namespace provides the base/common interfaces for reading and writing data from/to streams and files.
namespace	Cpl::Io::File
	The File namespace provides the base/common interfaces for reading and writing data from/to Files.

Macros
#define	CPL_IO_FILE_NATIVE_DIR_SEP   CPL_IO_FILE_NATIVE_DIR_SEP_MAP
	The platform's native directory separator.
#define	CPL_IO_FILE_MAX_NAME   CPL_IO_FILE_MAX_NAME_MAP
	The size, in bytes, of the maximum allowed path/file name.

Typedefs
typedef Cpl::Text::FString< CPL_IO_FILE_MAX_NAME >	Cpl::Io::File::NameString
	This typed FString is guaranteed to be large enough to hold the maximum allowed file system name for the native OS/Platform.

---

Class Documentation

Cpl::Io::File::Api::Info

struct Cpl::Io::File::Api::Info

This data structure defines status attributes for a file system entry.

Class Members
bool	m_isDir	True if the file entry is a directory.
bool	m_isFile	True if the file entry is a file.
time_t	m_mtime	Time the file entry was last modified/written.
bool	m_readable	True if the file entry is readable by the application.
unsigned long	m_size	Size, in bytes, of the file entry.
bool	m_writeable	True if the file entry is writable by the application.

Macro Definition Documentation

CPL_IO_FILE_MAX_NAME

#define CPL_IO_FILE_MAX_NAME   CPL_IO_FILE_MAX_NAME_MAP

The size, in bytes, of the maximum allowed path/file name.

CPL_IO_FILE_NATIVE_DIR_SEP

#define CPL_IO_FILE_NATIVE_DIR_SEP   CPL_IO_FILE_NATIVE_DIR_SEP_MAP

The platform's native directory separator.