config.h

Go to the documentation of this file.

/*
 * config.h
 *
 * Application/System configuration access class.
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-1998 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
 * All Rights Reserved.
 *
 * Contributor(s): ______________________________________.
 *
 * $Log: config.h,v $
 * Revision 1.28  2005/11/25 03:43:47  csoutheren
 * Fixed function argument comments to be compatible with Doxygen
 *
 * Revision 1.27  2005/01/26 05:37:44  csoutheren
 * Added ability to remove config file support
 *
 * Revision 1.26  2004/01/06 21:16:38  csoutheren
 * Added "virtual" keyword to methods to allow descendant classes.
 * Thanks to Cristian Bullokles for pointing out this issue
 *
 * Revision 1.25  2003/09/17 05:41:58  csoutheren
 * Removed recursive includes
 *
 * Revision 1.24  2003/09/17 01:18:02  csoutheren
 * Removed recursive include file system and removed all references
 * to deprecated coooperative threading support
 *
 * Revision 1.23  2002/09/16 01:08:59  robertj
 * Added #define so can select if #pragma interface/implementation is used on
 *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
 *
 * Revision 1.22  2001/05/22 12:49:32  robertj
 * Did some seriously wierd rewrite of platform headers to eliminate the
 *   stupid GNU compiler warning about braces not matching.
 *
 * Revision 1.21  2000/05/25 11:07:26  robertj
 * Added PConfig::HasKey() function to determine if value actually set.
 *
 * Revision 1.20  1999/03/09 02:59:49  robertj
 * Changed comments to doc++ compatible documentation.
 *
 * Revision 1.19  1999/02/16 08:07:11  robertj
 * MSVC 6.0 compatibility changes.
 *
 * Revision 1.18  1998/10/30 12:23:55  robertj
 * Added ability to get all key values as a dictionary.
 *
 * Revision 1.17  1998/09/23 06:20:21  robertj
 * Added open source copyright license.
 *
 * Revision 1.16  1998/01/26 00:29:26  robertj
 * Added functions to get/set 64bit integers from a PConfig.
 *
 * Revision 1.15  1997/08/07 11:58:01  robertj
 * Added ability to get registry data from other applications and anywhere in system registry.
 *
 * Revision 1.14  1996/02/25 02:50:33  robertj
 * Added consts to all GetXxxx functions.
 *
 * Revision 1.13  1996/01/28 14:10:10  robertj
 * Added time functions to PConfig.
 *
 * Revision 1.12  1995/12/10 11:54:30  robertj
 * Added WIN32 registry support for PConfig objects.
 *
 * Revision 1.11  1995/03/14 12:41:12  robertj
 * Updated documentation to use HTML codes.
 *
 * Revision 1.10  1995/01/27  11:06:20  robertj
 * Changed single string default constructor to be section name not file name.
 *
 * Revision 1.9  1994/12/12  10:11:59  robertj
 * Documentation.
 *
 * Revision 1.8  1994/08/23  11:32:52  robertj
 * Oops
 *
 * Revision 1.7  1994/08/22  00:46:48  robertj
 * Added pragma fro GNU C++ compiler.
 *
 * Revision 1.6  1994/08/21  23:43:02  robertj
 * Removed default argument when of PString type (MSC crashes).
 *
 * Revision 1.5  1994/07/27  05:58:07  robertj
 * Synchronisation.
 *
 * Revision 1.4  1994/06/25  11:55:15  robertj
 * Unix version synchronisation.
 *
 * Revision 1.3  1994/01/03  04:42:23  robertj
 * Mass changes to common container classes and interactors etc etc etc.
 *
 * Revision 1.2  1993/07/14  12:49:16  robertj
 * Fixed RCS keywords.
 *
 */


#ifndef _PCONFIG
#define _PCONFIG

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include "ptbuildopts.h"
#ifdef P_CONFIG_FILE

class PXConfig;

class PConfig : public PObject
{
  PCLASSINFO(PConfig, PObject);

  public:
    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     
    );

    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;

    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                
    );


    /* Get an 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.

       @return integer value of the variable.
     */
    virtual long GetInteger(
      const PString & key,      
      long dflt = 0             
    ) const;
    /* Get an integer variable determined by the key in the section. */
    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:
    // Member variables
    PString defaultSection;


  private:
    // Do common construction code.
    void Construct(
      Source src,               
      const PString & appname,  
      const PString & manuf     
    );
    void Construct(
      const PFilePath & filename  
    );


// Include platform dependent part of class
#ifdef _WIN32
#include "msos/ptlib/config.h"
#else
#include "unix/ptlib/config.h"
#endif
};

#endif // P_CONFIG_FILE

#endif

// End Of File ///////////////////////////////////////////////////////////////

---