Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Class Members | File Members

PConfig Class Reference

#include <config.h>

Inheritance diagram for PConfig:

PObject PSecureConfig List of all members.

Construction

enum  Source { Environment, System, Application, NumSources }
 PConfig (Source src=Application)
 PConfig (Source src, const PString &appname)
 PConfig (Source src, const PString &appname, const PString &manuf)
 PConfig (const PString &section, Source src=Application)
 PConfig (const PString &section, Source src, const PString &appname)
 PConfig (const PString &section, Source src, const PString &appname, const PString &manuf)
 PConfig (const PFilePath &filename, const PString &section)

Public Member Functions

 PConfig (int, const PString &name)
 ~PConfig ()
Section functions
virtual void SetDefaultSection (const PString &section)
virtual PString GetDefaultSection () const
virtual PStringList GetSections () const
virtual PStringList GetKeys () const
virtual PStringList GetKeys (const PString &section) const
virtual PStringToString GetAllKeyValues () const
virtual PStringToString GetAllKeyValues (const PString &section) const
virtual void DeleteSection ()
virtual void DeleteSection (const PString &section)
virtual void DeleteKey (const PString &key)
virtual void DeleteKey (const PString &section, const PString &key)
virtual BOOL HasKey (const PString &key) const
virtual BOOL HasKey (const PString &section, const PString &key) const
Get/Set variables
virtual PString GetString (const PString &key) const
virtual PString GetString (const PString &key, const PString &dflt) const
virtual PString GetString (const PString &section, const PString &key, const PString &dflt) const
virtual void SetString (const PString &key, const PString &value)
virtual void SetString (const PString &section, const PString &key, const PString &value)
virtual BOOL GetBoolean (const PString &key, BOOL dflt=FALSE) const
virtual BOOL GetBoolean (const PString &section, const PString &key, BOOL dflt=FALSE) const
virtual void SetBoolean (const PString &key, BOOL value)
virtual void SetBoolean (const PString &section, const PString &key, BOOL value)
virtual long GetInteger (const PString &key, long dflt=0) const
virtual long GetInteger (const PString &section, const PString &key, long dflt=0) const
virtual void SetInteger (const PString &key, long value)
virtual void SetInteger (const PString &section, const PString &key, long value)
virtual PInt64 GetInt64 (const PString &key, PInt64 dflt=0) const
virtual PInt64 GetInt64 (const PString &section, const PString &key, PInt64 dflt=0) const
virtual void SetInt64 (const PString &key, PInt64 value)
virtual void SetInt64 (const PString &section, const PString &key, PInt64 value)
virtual double GetReal (const PString &key, double dflt=0) const
virtual double GetReal (const PString &section, const PString &key, double dflt=0) const
virtual void SetReal (const PString &key, double value)
virtual void SetReal (const PString &section, const PString &key, double value)
virtual PTime GetTime (const PString &key) const
virtual PTime GetTime (const PString &key, const PTime &dflt) const
virtual PTime GetTime (const PString &section, const PString &key) const
virtual PTime GetTime (const PString &section, const PString &key, const PTime &dflt) const
virtual void SetTime (const PString &key, const PTime &value)
virtual void SetTime (const PString &section, const PString &key, const PTime &value)

Protected Attributes

PString defaultSection
 The current section for variable values.
PXConfig * config

Detailed Description

A class representing a configuration for the application. There are four sources of configuration information. The system environment, a system wide configuration file, an application specific configuration file or an explicit configuration file.

Configuration information follows a three level hierarchy: { file}, { section} and { variable}. Thus, a configuration file consists of a number of sections each with a number of variables selected by a { key}. Each variable has an associated value.

Note that the evironment source for configuration information does not have sections. The section is ignored and the same set of keys are available.

The configuration file is a standard text file for the platform with its internals appearing in the form: {verbatim} [Section String] Key Name=Value String {verbatim}


Member Enumeration Documentation

enum PConfig::Source
 

Description of the standard source for configuration information.

Enumeration values:
Environment  The platform specific environment. For Unix, MSDOS, NT etc this is { the} environment current when the program was run. For the MacOS this is a subset of the Gestalt and SysEnviron information.
System  The platform specific system wide configuration file. For MS-Windows this is the WIN.INI file. For Unix, plain MS-DOS, etc this is a configuration file similar to that for applications except there is only a single file that applies to all PWLib applications.
Application  The application specific configuration file. This is the most common source of configuration for an application. The location of this file is platform dependent, but its contents are always the same. For MS-Windows the file should be either in the same directory as the executable or in the Windows directory. For the MacOS this would be either in the System Folder or the Preferences folder within it. For Unix this would be the users home directory.
NumSources 


Constructor & Destructor Documentation

PConfig::PConfig Source  src = Application  ) 
 

Create a new configuration object. Once a source is selected for the configuration it cannot be changed. Only at the next level of the hierarchy (sections) are selection able to be made dynamically with an active PConfig object.

Parameters:
src  Standard source for the configuration.

PConfig::PConfig Source  src,
const PString appname
 

Create a new configuration object.

Parameters:
appname  Standard source for the configuration. Name of application

PConfig::PConfig Source  src,
const PString appname,
const PString manuf
 

Create a new configuration object.

Parameters:
appname  Standard source for the configuration.
manuf  Name of application Manufacturer

PConfig::PConfig const PString section,
Source  src = Application
 

Create a new configuration object.

Parameters:
src  Default section to search for variables. Standard source for the configuration.

PConfig::PConfig const PString section,
Source  src,
const PString appname
 

Create a new configuration object.

Parameters:
src  Default section to search for variables.
appname  Standard source for the configuration. Name of application

PConfig::PConfig const PString section,
Source  src,
const PString appname,
const PString manuf
 

Create a new configuration object.

Parameters:
src  Default section to search for variables.
appname  Standard source for the configuration.
manuf  Name of application Manufacturer

PConfig::PConfig const PFilePath filename,
const PString section
 

Create a new configuration object.

Parameters:
section  Explicit name of the configuration file. Default section to search for variables.

PConfig::PConfig int  ,
const PString name
 

PConfig::~PConfig  ) 
 


Member Function Documentation

virtual void PConfig::DeleteKey const PString section,
const PString key
[virtual]
 

Delete the particular variable in the specified section.

Parameters:
key  Section to use instead of the default. Key of the variable to delete.

virtual void PConfig::DeleteKey const PString key  )  [virtual]
 

Delete the particular variable in the specified section. If the section name is not specified then the default section is used.

Note that the variable and key are removed from the file. The key will no longer appear in the GetKeys() function. If you wish to delete the value without deleting the key, use SetString() to set it to the empty string.

Parameters:
key  Key of the variable to delete.

virtual void PConfig::DeleteSection const PString section  )  [virtual]
 

Delete all variables in the specified section.

Parameters:
section  Name of section to delete.

virtual void PConfig::DeleteSection  )  [virtual]
 

Delete all variables in the specified section. If the section name is not specified then the default section is deleted.

Note that the section header is also removed so the section will not appear in the GetSections() function.

virtual PStringToString PConfig::GetAllKeyValues const PString section  )  const [virtual]
 

Get all of the keys in the section and their values.

Parameters:
section  Section to use instead of the default.

virtual PStringToString PConfig::GetAllKeyValues  )  const [virtual]
 

Get all of the keys in the section and their values. If the section name is not specified then use the default section.

Returns:
Dictionary of all key names and their values.

virtual BOOL PConfig::GetBoolean const PString section,
const PString key,
BOOL  dflt = FALSE
const [virtual]
 

Get a boolean variable determined by the key in the section.

Parameters:
key  Section to use instead of the default.
dflt  The key name for the variable. Default value for the variable.

virtual BOOL PConfig::GetBoolean const PString key,
BOOL  dflt = FALSE
const [virtual]
 

Get a boolean variable determined by the key in the section. If the section name is not specified then the default section is used.

The boolean value can be specified in a number of ways. The TRUE value is returned if the string value for the variable begins with either the 'T' character or the 'Y' character. Alternatively if the string can be converted to a numeric value, a non-zero value will also return TRUE. Thus the values can be Key=True, Key=Yes or Key=1 for TRUE and Key=False, Key=No, or Key=0 for FALSE.

If the key is not present the value returned is the that provided by the #dlft# parameter. Note that this is different from the key being present but having no value, in which case FALSE is returned.

Returns:
boolean value of the variable.
Parameters:
dflt  The key name for the variable. Default value for the variable.

virtual PString PConfig::GetDefaultSection  )  const [virtual]
 

Get the default section for variable operations. All functions that deal with keys and get or set configuration values will use this section unless an explicit section name is specified.

Note when the Environment# source is being used the default section may be retrieved but it is ignored.

Returns:
default section name string.

virtual PInt64 PConfig::GetInt64 const PString section,
const PString key,
PInt64  dflt = 0
const [virtual]
 

Get a 64 bit integer variable determined by the key in the section.

Parameters:
key  Section to use instead of the default.
dflt  The key name for the variable. Default value for the variable.

virtual PInt64 PConfig::GetInt64 const PString key,
PInt64  dflt = 0
const [virtual]
 

Get a 64 bit integer variable determined by the key in the section. If the section name is not specified then the default section is used.

If the key is not present the value returned is the that provided by the #dlft# parameter. Note that this is different from the key being present but having no value, in which case zero is returned.

Returns:
integer value of the variable.
Parameters:
dflt  The key name for the variable. Default value for the variable.

virtual long PConfig::GetInteger const PString section,
const PString key,
long  dflt = 0
const [virtual]
 

Parameters:
key  Section to use instead of the default.
dflt  The key name for the variable. Default value for the variable.

virtual long PConfig::GetInteger const PString key,
long  dflt = 0
const [virtual]
 

Parameters:
dflt  The key name for the variable. Default value for the variable.

virtual PStringList PConfig::GetKeys const PString section  )  const [virtual]
 

Get a list of all the keys in the section.

Parameters:
section  Section to use instead of the default.

virtual PStringList PConfig::GetKeys  )  const [virtual]
 

Get a list of all the keys in the section. If the section name is not specified then use the default section.

Returns:
list of all key names.

virtual double PConfig::GetReal const PString section,
const PString key,
double  dflt = 0
const [virtual]
 

Get a floating point variable determined by the key in the section.

Parameters:
key  Section to use instead of the default.
dflt  The key name for the variable. Default value for the variable.

virtual double PConfig::GetReal const PString key,
double  dflt = 0
const [virtual]
 

Get a floating point variable determined by the key in the section. If the section name is not specified then the default section is used.

If the key is not present the value returned is the that provided by the #dlft# parameter. Note that this is different from the key being present but having no value, in which case zero is returned.

Returns:
floating point value of the variable.
Parameters:
dflt  The key name for the variable. Default value for the variable.

virtual PStringList PConfig::GetSections  )  const [virtual]
 

Get all of the section names currently specified in the file. A section is the part specified by the [ and ] characters.

Note when the Environment# source is being used this will return an empty list as there are no section present.

Returns:
list of all section names.

virtual PString PConfig::GetString const PString section,
const PString key,
const PString dflt
const [virtual]
 

Get a string variable determined by the key in the section.

Parameters:
key  Section to use instead of the default.
dflt  The key name for the variable. Default value for the variable.

virtual PString PConfig::GetString const PString key,
const PString dflt
const [virtual]
 

Get a string variable determined by the key in the section.

Parameters:
dflt  The key name for the variable. Default value for the variable.

virtual PString PConfig::GetString const PString key  )  const [virtual]
 

Get a string variable determined by the key in the section. If the section name is not specified then the default section is used.

If the key is not present the value returned is the that provided by the #dlft# parameter. Note that this is different from the key being present but having no value, in which case an empty string is returned.

Returns:
string value of the variable.
Parameters:
key  The key name for the variable.

virtual PTime PConfig::GetTime const PString section,
const PString key,
const PTime dflt
const [virtual]
 

Get a PTime# variable determined by the key in the section.

Parameters:
key  Section to use instead of the default.
dflt  The key name for the variable. Default value for the variable.

virtual PTime PConfig::GetTime const PString section,
const PString key
const [virtual]
 

Get a PTime# variable determined by the key in the section.

Parameters:
key  Section to use instead of the default. The key name for the variable.

virtual PTime PConfig::GetTime const PString key,
const PTime dflt
const [virtual]
 

Get a PTime# variable determined by the key in the section.

Parameters:
dflt  The key name for the variable. Default value for the variable.

virtual PTime PConfig::GetTime const PString key  )  const [virtual]
 

Get a PTime# variable determined by the key in the section. If the section name is not specified then the default section is used.

If the key is not present the value returned is the that provided by the #dlft# parameter. Note that this is different from the key being present but having no value, in which case zero is returned.

Returns:
time/date value of the variable.
Parameters:
key  The key name for the variable.

virtual BOOL PConfig::HasKey const PString section,
const PString key
const [virtual]
 

Determine if the particular variable in the section is actually present.

Parameters:
key  Section to use instead of the default. Key of the variable.

virtual BOOL PConfig::HasKey const PString key  )  const [virtual]
 

Determine if the particular variable in the section is actually present.

This function allows a caller to distinguish between getting a saved value or using the default value. For example if you called GetString("MyKey", "DefVal") there is no way to distinguish between the default "DefVal" being used, or the user had explicitly saved the value "DefVal" into the PConfig.

Parameters:
key  Key of the variable.

virtual void PConfig::SetBoolean const PString section,
const PString key,
BOOL  value
[virtual]
 

Set a boolean variable determined by the key in the section.

Parameters:
key  Section to use instead of the default.
value  The key name for the variable. New value to set for the variable.

virtual void PConfig::SetBoolean const PString key,
BOOL  value
[virtual]
 

Set a boolean variable determined by the key in the section. If the section name is not specified then the default section is used.

If value is TRUE then the string "True" is written to the variable otherwise the string "False" is set.

Parameters:
value  The key name for the variable. New value to set for the variable.

virtual void PConfig::SetDefaultSection const PString section  )  [virtual]
 

Set the default section for variable operations. All functions that deal with keys and get or set configuration values will use this section unless an explicit section name is specified.

Note when the Environment# source is being used the default section may be set but it is ignored.

Parameters:
section  New default section name.

virtual void PConfig::SetInt64 const PString section,
const PString key,
PInt64  value
[virtual]
 

Set a 64 bit integer variable determined by the key in the section.

Parameters:
key  Section to use instead of the default.
value  The key name for the variable. New value to set for the variable.

virtual void PConfig::SetInt64 const PString key,
PInt64  value
[virtual]
 

Set a 64 bit integer variable determined by the key in the section. If the section name is not specified then the default section is used.

The value is always formatted as a signed number with no leading or trailing blanks.

Parameters:
value  The key name for the variable. New value to set for the variable.

virtual void PConfig::SetInteger const PString section,
const PString key,
long  value
[virtual]
 

Set an integer variable determined by the key in the section.

Parameters:
key  Section to use instead of the default.
value  The key name for the variable. New value to set for the variable.

virtual void PConfig::SetInteger const PString key,
long  value
[virtual]
 

Set an integer variable determined by the key in the section. If the section name is not specified then the default section is used.

The value is always formatted as a signed number with no leading or trailing blanks.

Parameters:
value  The key name for the variable. New value to set for the variable.

virtual void PConfig::SetReal const PString section,
const PString key,
double  value
[virtual]
 

Set a floating point variable determined by the key in the section.

Parameters:
key  Section to use instead of the default.
value  The key name for the variable. New value to set for the variable.

virtual void PConfig::SetReal const PString key,
double  value
[virtual]
 

Set a floating point variable determined by the key in the section. If the section name is not specified then the default section is used.

The value is always formatted as a signed decimal or exponential form number with no leading or trailing blanks, ie it uses the g formatter from the printf() function.

Parameters:
value  The key name for the variable. New value to set for the variable.

virtual void PConfig::SetString const PString section,
const PString key,
const PString value
[virtual]
 

Set a string variable determined by the key in the section.

Parameters:
key  Section to use instead of the default.
value  The key name for the variable. New value to set for the variable.

virtual void PConfig::SetString const PString key,
const PString value
[virtual]
 

Set a string variable determined by the key in the section. If the section name is not specified then the default section is used.

Parameters:
value  The key name for the variable. New value to set for the variable.

virtual void PConfig::SetTime const PString section,
const PString key,
const PTime value
[virtual]
 

Set a PTime# variable determined by the key in the section.

Parameters:
key  Section to use instead of the default.
value  The key name for the variable. New value to set for the variable.

virtual void PConfig::SetTime const PString key,
const PTime value
[virtual]
 

Set a PTime# variable determined by the key in the section. If the section name is not specified then the default section is used.

Parameters:
value  The key name for the variable. New value to set for the variable.


Member Data Documentation

PXConfig* PConfig::config [protected]
 

PString PConfig::defaultSection [protected]
 

The current section for variable values.


The documentation for this class was generated from the following file:
Generated on Sat Dec 22 16:46:52 2007 for PWLib by  doxygen 1.4.2