CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

csConfigManager Class Reference

A configuration manager makes a number of individual configuration files appear to be a single configuration object. More...

#include <cfgmgr.h>

Inheritance diagram for csConfigManager:

iConfigManager iConfigFile iBase List of all members.

Public Methods

 csConfigManager (iConfigFile *DynamicDomain, bool Optimize)
 Create a new config manager object. More...

virtual ~csConfigManager ()
 Delete this config manager. More...

virtual void AddDomain (iConfigFile *, int priority)
 add a configuration domain. More...

virtual iConfigFileAddDomain (char const *path, iVFS *, int priority)
 add a configuration domain. More...

virtual void RemoveDomain (iConfigFile *)
 remove a configuration domain. More...

virtual void RemoveDomain (char const *path)
 remove a configuration domain. More...

virtual iConfigFileLookupDomain (char const *path) const
 return a pointer to a single config domain. More...

virtual void SetDomainPriority (char const *path, int priority)
 set the priority of a config domain. More...

virtual void SetDomainPriority (iConfigFile *, int priority)
 set the priority of a config domain. More...

virtual int GetDomainPriority (char const *path) const
 return the priority of a config domain. More...

virtual int GetDomainPriority (iConfigFile *) const
 return the priority of a config domain. More...

virtual bool SetDynamicDomain (iConfigFile *)
 Change the dynamic domain. More...

virtual iConfigFileGetDynamicDomain () const
 return a pointer to the dynamic config domain. More...

virtual void SetDynamicDomainPriority (int priority)
 set the priority of the dynamic config domain. More...

virtual int GetDynamicDomainPriority () const
 return the priority of the dynamic config domain. More...

virtual void FlushRemoved ()
 flush all removed config files (only required in optimize mode). More...

virtual const char * GetFileName () const
 Get configuration file name. More...

virtual iVFSGetVFS () const
 Get the VFS object on which this file is stored (if any). More...

virtual void SetFileName (const char *, iVFS *)
 Set config file name. More...

virtual bool Load (const char *iFileName, iVFS *=0, bool Merge=false, bool NewWins=true)
 Load a configuration file. More...

virtual bool Save ()
 Save configuration to the same place from which it was loaded. More...

virtual bool Save (const char *iFileName, iVFS *=0)
 Save configuration into the given file (on VFS or on the physical filesystem). More...

virtual void Clear ()
 Delete all options and rewind all iterators. More...

void CleanUp ()
 FlushRemoved() and delete all domains. More...

virtual csPtr< iConfigIteratorEnumerate (const char *Subsection=0)
 Enumerate selected keys. More...

virtual bool KeyExists (const char *Key) const
 Test if a key exists. More...

virtual bool SubsectionExists (const char *Subsection) const
 Test if at least one key exists with the given Subsection prefix. More...

virtual int GetInt (const char *Key, int Def=0) const
 Get an integer value from the configuration. More...

virtual float GetFloat (const char *Key, float Def=0.0) const
 Get a float value from the configuration. More...

virtual const char * GetStr (const char *Key, const char *Def="") const
 Get a string value from the configuration. More...

virtual bool GetBool (const char *Key, bool Def=false) const
 Get a boolean value from the configuration. More...

virtual const char * GetComment (const char *Key) const
 Get the comment of the given key, or 0 if no comment exists. More...

virtual void SetStr (const char *Key, const char *Val)
 Set an null-terminated string value. More...

virtual void SetInt (const char *Key, int Value)
 Set an integer value. More...

virtual void SetFloat (const char *Key, float Value)
 Set a floating-point value. More...

virtual void SetBool (const char *Key, bool Value)
 Set a boolean value. More...

virtual bool SetComment (const char *Key, const char *Text)
 Set the comment for given key. More...

virtual void DeleteKey (const char *Key)
 Delete a key and its value and comment. More...

virtual const char * GetEOFComment () const
 return the final comment at the end of the configuration file. More...

virtual void SetEOFComment (const char *Text)
 set the final comment at the end of the configuration file. More...


Detailed Description

A configuration manager makes a number of individual configuration files appear to be a single configuration object.

See the description of the SCF interface iConfigManager for full details.

Definition at line 31 of file csutil/cfgmgr.h.


Constructor & Destructor Documentation

csConfigManager::csConfigManager iConfigFile   DynamicDomain,
bool    Optimize
 

Create a new config manager object.

If 'Optimize' is set to 'true', then the config manager will enable some optimizations, which you may or may not want:

  • When a config file is added via Add(name, vfs), the config manager first looks through all registered config files. If a file with the same name and vfs pointer are found, it is added a second time, so the file is not loaded twice.
  • When a config file is removed, the config manager keeps a reference to it until Flush() is called. If you add the file again in the meantime with Add(name, vfs), this reference is used instead.

virtual csConfigManager::~csConfigManager   [virtual]
 

Delete this config manager.


Member Function Documentation

virtual iConfigFile* csConfigManager::AddDomain char const *    path,
iVFS  ,
int    priority
[virtual]
 

add a configuration domain.

Implements iConfigManager.

virtual void csConfigManager::AddDomain iConfigFile  ,
int    priority
[virtual]
 

add a configuration domain.

Implements iConfigManager.

void csConfigManager::CleanUp  
 

FlushRemoved() and delete all domains.

virtual void csConfigManager::Clear   [virtual]
 

Delete all options and rewind all iterators.

Implements iConfigFile.

virtual void csConfigManager::DeleteKey const char *    Key [virtual]
 

Delete a key and its value and comment.

Implements iConfigFile.

virtual csPtr<iConfigIterator> csConfigManager::Enumerate const char *    Subsection = 0 [virtual]
 

Enumerate selected keys.

If a subsection is given, only those keys which are prefixed by the subsection string will be enumerated. The returned iterator does not yet point to a valid key. You must call Next() to set it to the first key.

Implements iConfigFile.

virtual void csConfigManager::FlushRemoved   [virtual]
 

flush all removed config files (only required in optimize mode).

Implements iConfigManager.

virtual bool csConfigManager::GetBool const char *    Key,
bool    Def = false
const [virtual]
 

Get a boolean value from the configuration.

Implements iConfigFile.

virtual const char* csConfigManager::GetComment const char *    Key const [virtual]
 

Get the comment of the given key, or 0 if no comment exists.

Implements iConfigFile.

virtual int csConfigManager::GetDomainPriority iConfigFile   const [virtual]
 

return the priority of a config domain.

Implements iConfigManager.

virtual int csConfigManager::GetDomainPriority char const *    path const [virtual]
 

return the priority of a config domain.

Implements iConfigManager.

virtual iConfigFile* csConfigManager::GetDynamicDomain   const [virtual]
 

return a pointer to the dynamic config domain.

Implements iConfigManager.

virtual int csConfigManager::GetDynamicDomainPriority   const [virtual]
 

return the priority of the dynamic config domain.

Implements iConfigManager.

virtual const char* csConfigManager::GetEOFComment   const [virtual]
 

return the final comment at the end of the configuration file.

Implements iConfigFile.

virtual const char* csConfigManager::GetFileName   const [virtual]
 

Get configuration file name.

Also consult GetVFS() to determine which (if any) VFS object was used for the file's storage.

Implements iConfigFile.

virtual float csConfigManager::GetFloat const char *    Key,
float    Def = 0.0
const [virtual]
 

Get a float value from the configuration.

Implements iConfigFile.

virtual int csConfigManager::GetInt const char *    Key,
int    Def = 0
const [virtual]
 

Get an integer value from the configuration.

Implements iConfigFile.

virtual const char* csConfigManager::GetStr const char *    Key,
const char *    Def = ""
const [virtual]
 

Get a string value from the configuration.

Implements iConfigFile.

virtual iVFS* csConfigManager::GetVFS   const [virtual]
 

Get the VFS object on which this file is stored (if any).

Returns 0 if this file resides within the real (non-VFS) filesystem.

Implements iConfigFile.

virtual bool csConfigManager::KeyExists const char *    Key const [virtual]
 

Test if a key exists.

Implements iConfigFile.

virtual bool csConfigManager::Load const char *    iFileName,
iVFS   = 0,
bool    Merge = false,
bool    NewWins = true
[virtual]
 

Load a configuration file.

If the file resides in a real filesystem, rather than a VFS filesystem, then pass 0 for the VFS argument. This will clear all options before loading the new options, even if the file cannot be opened.

You can set the Merge flag to merge the newly loaded configuration information into the existing information. If you do so, nothing will happen if the named file doesn't exist. The NewWins flag determines the behavior in case of configuration key conflicts. If true, then the new configuration value replaces the old for that key. If false, then the old value is kept, and the new value is ignored. The recorded file name will be set to the name of the newly loaded file if the Merge flag is false; otherwise it will retain the old name.

Implements iConfigFile.

virtual iConfigFile* csConfigManager::LookupDomain char const *    path const [virtual]
 

return a pointer to a single config domain.

Implements iConfigManager.

virtual void csConfigManager::RemoveDomain char const *    path [virtual]
 

remove a configuration domain.

Implements iConfigManager.

virtual void csConfigManager::RemoveDomain iConfigFile   [virtual]
 

remove a configuration domain.

Implements iConfigManager.

virtual bool csConfigManager::Save const char *    iFileName,
iVFS   = 0
[virtual]
 

Save configuration into the given file (on VFS or on the physical filesystem).

If the second parameter is skipped, the file will be written to the physical filesystem, otherwise it is stored on given VFS filesystem. This method does not change the internally stored file name.

Implements iConfigFile.

virtual bool csConfigManager::Save   [virtual]
 

Save configuration to the same place from which it was loaded.

Returns true if the save operation succeeded.

Implements iConfigFile.

virtual void csConfigManager::SetBool const char *    Key,
bool    Value
[virtual]
 

Set a boolean value.

Implements iConfigFile.

virtual bool csConfigManager::SetComment const char *    Key,
const char *    Text
[virtual]
 

Set the comment for given key.

In addition to an actual comment, you can use "" for Text to place an empty comment line before this key, or 0 to remove the comment entirely. The comment may contain newline characters. Returns false if the key does not exist.

Implements iConfigFile.

virtual void csConfigManager::SetDomainPriority iConfigFile  ,
int    priority
[virtual]
 

set the priority of a config domain.

Implements iConfigManager.

virtual void csConfigManager::SetDomainPriority char const *    path,
int    priority
[virtual]
 

set the priority of a config domain.

Implements iConfigManager.

virtual bool csConfigManager::SetDynamicDomain iConfigFile   [virtual]
 

Change the dynamic domain.

The given config object must already be registered with AddDomain(). Returns false if this is not the case.

Implements iConfigManager.

virtual void csConfigManager::SetDynamicDomainPriority int    priority [virtual]
 

set the priority of the dynamic config domain.

Implements iConfigManager.

virtual void csConfigManager::SetEOFComment const char *    Text [virtual]
 

set the final comment at the end of the configuration file.

Implements iConfigFile.

virtual void csConfigManager::SetFileName const char *   ,
iVFS  
[virtual]
 

Set config file name.

You can use this if you want Save() to write to another file. This will set the dirty flag.

Implements iConfigFile.

virtual void csConfigManager::SetFloat const char *    Key,
float    Value
[virtual]
 

Set a floating-point value.

Implements iConfigFile.

virtual void csConfigManager::SetInt const char *    Key,
int    Value
[virtual]
 

Set an integer value.

Implements iConfigFile.

virtual void csConfigManager::SetStr const char *    Key,
const char *    Val
[virtual]
 

Set an null-terminated string value.

Implements iConfigFile.

virtual bool csConfigManager::SubsectionExists const char *    Subsection const [virtual]
 

Test if at least one key exists with the given Subsection prefix.

Implements iConfigFile.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14