BALL  1.4.79
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
BALL::ResourceFile Class Reference

#include <BALL/FORMAT/resourceFile.h>

Inheritance diagram for BALL::ResourceFile:
BALL::File

Public Types

typedef Entry::Iterator Iterator
 
typedef Entry::ConstIterator ConstIterator
 
Type Definition
typedef ResourceEntry Entry
 
- Public Types inherited from BALL::File
typedef std::ios::openmode OpenMode
 
enum  Transformation { TRANSFORMATION__EXEC = 1, TRANSFORMATION__FILTER = 2, TRANSFORMATION__URL = 3 }
 
enum  Type {
  TYPE__UNKNOWN = 0, TYPE__DIRECTORY = 1, TYPE__CHAR_SPECIAL_FILE = 2, TYPE__BLOCK_SPECIAL_FILE = 3,
  TYPE__REGULAR_FILE = 4, TYPE__SYMBOLIC_LINK = 5, TYPE__SOCKET = 6, TYPE__FIFO_SPECIAL_FILE = 7
}
 

Public Member Functions

Iterator begin ()
 
Iterator end ()
 
ConstIterator begin () const
 
ConstIterator end () const
 
Constructors and Destructors
 ResourceFile ()
 
 ResourceFile (const String &name)
 
virtual ~ResourceFile ()
 
void destroy ()
 
virtual void clear ()
 
Accessors
Size getSize () const
 
EntrygetRoot ()
 
const EntrygetRoot () const
 
EntrygetEntry (const String &key_path)
 
const EntrygetEntry (const String &key_path) const
 
StringgetValue (const String &key_path)
 
const StringgetValue (const String &key_path) const
 
Entryinsert (const String &key_path, const String &name)
 
bool removeKey (const String &key_path)
 
Attributes
bool operator== (const ResourceFile &entry) const
 
bool operator!= (const ResourceFile &entry) const
 
bool hasKey (const String &key_path) const
 
bool isEmpty () const
 
Debugging and Diagnostics
bool isValid () const
 
void dump (std::ostream &s=std::cout, Size depth=0) const
 
- Public Member Functions inherited from BALL::File
 File ()
 
 File (const String &name, OpenMode open_mode=std::ios::in)
 
virtual ~File ()
 
bool isValid () const
 
bool open (const String &name, File::OpenMode open_mode=std::ios::in)
 
bool reopen ()
 
bool reopen (File::OpenMode open_mode)
 
void close ()
 
const StringgetName () const
 
void setName (const String &name)
 
const StringgetOriginalName () const
 
Size getSize ()
 
File::OpenMode getOpenMode () const
 
Type getType (bool trace_link) const
 
bool copyTo (const String &destination_name, Size buffer_size=4096)
 
bool moveTo (const String &destination_name)
 
bool remove ()
 
bool renameTo (const String &new_path)
 
bool truncate (Size size=0)
 
std::fstream & getFileStream ()
 
TransformationManagergetTransformationManager ()
 
const TransformationManagergetTransformationManager () const
 
bool operator== (const File &file) const
 
bool operator!= (const File &file) const
 
bool isOpen () const
 
bool isClosed () const
 
bool isAccessible () const
 
bool isCanonized () const
 
bool isReadable () const
 
bool isWritable () const
 
bool isExecutable () const
 

Static Public Attributes

Constants
static char ENTRY_BEGIN
 
static char ENTRY_END
 
static char SEPARATOR
 
- Static Public Attributes inherited from BALL::File
static const OpenMode MODE_IN
 Open for input (default) More...
 
static const OpenMode MODE_OUT
 Open for output. More...
 
static const OpenMode MODE_APP
 Append. Seek to end before each write operation. More...
 
static const OpenMode MODE_BINARY
 Binary mode. More...
 
static const OpenMode MODE_ATE
 Seek to end directly after opening. More...
 
static const OpenMode MODE_TRUNC
 Truncate an existing file. More...
 
static const String TRANSFORMATION_EXEC_PREFIX
 Prefix for filenames that are created through the execution of commands "exec:". More...
 
static const String TRANSFORMATION_FILE_PREFIX
 Prefix for files (to mimick URL-like behavior) "file:". More...
 
static const String TRANSFORMATION_FTP_PREFIX
 Prefix for FTP-transfers "ftp://". More...
 
static const String TRANSFORMATION_HTTP_PREFIX
 Prefix for HTTP-transfer "http://". More...
 

Friends

Storers
std::istream & operator>> (std::istream &s, ResourceFile &resource_file)
 

File-related methods.

bool open (const String &name)
 
void close ()
 
void saveAs (const String &name)
 
void save (const Entry &entry)
 
void save ()
 
static void saveAs (const Entry &entry, const String &name)
 

Processor and Visitor related methods

void host (Visitor< ResourceFile > &visitor)
 
bool apply (UnaryProcessor< Entry > &processor)
 
static bool applyChildren (Entry &entry, UnaryProcessor< Entry > &processor)
 

Additional Inherited Members

- Static Public Member Functions inherited from BALL::File
static Size getSize (String name)
 
static Type getType (String name, bool trace_link)
 
static bool copy (String source_name, String destination_name, Size buffer_size=4096)
 
static bool move (const String &source_name, const String &destination_name)
 
static bool remove (String name)
 
static bool rename (String old_path, String new_path)
 
static bool truncate (String path, Size size=0)
 
static bool createTemporaryFilename (String &temporary, const String &suffix=".TMP")
 
static void enableTransformation (Transformation transformation)
 
static void disableTransformation (Transformation transformation)
 
static bool isTransformationEnabled (Transformation transformation)
 
static void registerTransformation (const String &pattern, const String &exec)
 
static void unregisterTransformation (const String &pattern)
 
static bool isAccessible (String name)
 
static bool isReadable (String name)
 
static bool isWritable (String name)
 
static bool isExecutable (String name)
 
- Protected Attributes inherited from BALL::File
String name_
 
String original_name_
 
OpenMode open_mode_
 
bool is_open_
 
bool is_temporary_
 
- Static Protected Attributes inherited from BALL::File
static HashSet< Stringcreated_temp_filenames_
 
static TransformationManager transformation_manager_
 
static Size transformation_methods_
 

Detailed Description

Resource file class

Definition at line 581 of file resourceFile.h.

Member Typedef Documentation

Definition at line 786 of file resourceFile.h.

Definition at line 609 of file resourceFile.h.

Definition at line 773 of file resourceFile.h.

Constructor & Destructor Documentation

BALL::ResourceFile::ResourceFile ( )

Default constructor

BALL::ResourceFile::ResourceFile ( const String name)

Detailed constructor.

Exceptions
Exception::FileNotFoundif the file could not be opened
virtual BALL::ResourceFile::~ResourceFile ( )
virtual

Destructor

Member Function Documentation

bool BALL::ResourceFile::apply ( UnaryProcessor< Entry > &  processor)
static bool BALL::ResourceFile::applyChildren ( Entry entry,
UnaryProcessor< Entry > &  processor 
)
static
Iterator BALL::ResourceFile::begin ( )
inline

Definition at line 775 of file resourceFile.h.

ConstIterator BALL::ResourceFile::begin ( ) const
inline

Definition at line 788 of file resourceFile.h.

virtual void BALL::ResourceFile::clear ( )
virtual

Clear method

Reimplemented from BALL::File.

void BALL::ResourceFile::close ( )
void BALL::ResourceFile::destroy ( )

Destroy method

void BALL::ResourceFile::dump ( std::ostream &  s = std::cout,
Size  depth = 0 
) const
Iterator BALL::ResourceFile::end ( )
inline

Definition at line 780 of file resourceFile.h.

ConstIterator BALL::ResourceFile::end ( ) const
inline

Definition at line 793 of file resourceFile.h.

Entry* BALL::ResourceFile::getEntry ( const String key_path)
const Entry* BALL::ResourceFile::getEntry ( const String key_path) const
Entry& BALL::ResourceFile::getRoot ( )
const Entry& BALL::ResourceFile::getRoot ( ) const
Size BALL::ResourceFile::getSize ( ) const
String* BALL::ResourceFile::getValue ( const String key_path)
const String* BALL::ResourceFile::getValue ( const String key_path) const
bool BALL::ResourceFile::hasKey ( const String key_path) const
void BALL::ResourceFile::host ( Visitor< ResourceFile > &  visitor)
Entry* BALL::ResourceFile::insert ( const String key_path,
const String name 
)
bool BALL::ResourceFile::isEmpty ( ) const
bool BALL::ResourceFile::isValid ( ) const
bool BALL::ResourceFile::open ( const String name)
bool BALL::ResourceFile::operator!= ( const ResourceFile entry) const

Inequality operator

bool BALL::ResourceFile::operator== ( const ResourceFile entry) const

Equality operator

bool BALL::ResourceFile::removeKey ( const String key_path)
void BALL::ResourceFile::save ( const Entry entry)
void BALL::ResourceFile::save ( )
static void BALL::ResourceFile::saveAs ( const Entry entry,
const String name 
)
static
void BALL::ResourceFile::saveAs ( const String name)

Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  s,
ResourceFile resource_file 
)
friend

Member Data Documentation

char BALL::ResourceFile::ENTRY_BEGIN
static

Definition at line 592 of file resourceFile.h.

char BALL::ResourceFile::ENTRY_END
static

Definition at line 596 of file resourceFile.h.

char BALL::ResourceFile::SEPARATOR
static

Definition at line 600 of file resourceFile.h.