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): ______________________________________.
 *
 * $Revision: 27762 $
 * $Author: rjongbloed $
 * $Date: 2012-06-04 17:02:25 +1000 (Mon, 04 Jun 2012) $
 */


#ifndef PTLIB_CONFIG_H
#define PTLIB_CONFIG_H

#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 PStringArray GetSections() const;

    virtual PStringArray GetKeys() const;
    virtual PStringArray 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 PBoolean HasKey(
      const PString & key       
    ) const;
    virtual PBoolean 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 PBoolean GetBoolean(
      const PString & key,      
      PBoolean dflt = false         
    ) const;
    virtual PBoolean GetBoolean(
      const PString & section,  
      const PString & key,      
      PBoolean dflt = false         
    ) const;

    virtual void SetBoolean(
      const PString & key,      
      PBoolean value                
    );
    virtual void SetBoolean(
      const PString & section,  
      const PString & key,      
      PBoolean 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 <code>dlft</code> 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                
    );


    /* Get an enum variable determined by the key in the section. If the
       section name is not specified then the default section is used.

       @return enum value of the variable.
     */
    template <typename Enumeration>
    Enumeration GetEnum(
      const PString & key,      
      Enumeration dflt          
    ) const { return (Enumeration)GetInteger(key, dflt); }
    /* Get an enum variable determined by the key in the section. */
    template <typename Enumeration>
    Enumeration GetEnum(
      const PString & section,  
      const PString & key,      
      Enumeration dflt          
    ) const { return (Enumeration)GetInteger(section, key, dflt); }

    template <typename Enumeration>
    void SetEnum(
      const PString & key,      
      Enumeration value         
    ) { SetInteger(key, value); }
    template <typename Enumeration>
    void SetEnum(
      const PString & section,  
      const PString & key,      
      Enumeration value         
    ) { SetInteger(section, key, 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 // PTLIB_CONFIG_H

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