corrected conditional compilation tests

[wxWidgets.git] / include / wx / confbase.h

diff --git a/include/wx/confbase.h b/include/wx/confbase.h
index 619589b04c79df1fbd10fcb32c43bd43b3394a57..25b97678b819c4d3919dbf16ab5f147e96bc0d52 100644 (file)
--- a/include/wx/confbase.h
+++ b/include/wx/confbase.h
@@ -1,7 +1,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 // Name:        confbase.h
 // Purpose:     declaration of the base class of all config implementations
 ///////////////////////////////////////////////////////////////////////////////
 // Name:        confbase.h
 // Purpose:     declaration of the base class of all config implementations

-//              (see also: fileconf.h and msw/regconf.h)
+//              (see also: fileconf.h and msw/regconf.h and iniconf.h)

 // Author:      Karsten Ballüder & Vadim Zeitlin
 // Modified by:
 // Created:     07.04.98 (adapted from appconf.h)
 // Author:      Karsten Ballüder & Vadim Zeitlin
 // Modified by:
 // Created:     07.04.98 (adapted from appconf.h)


@@ -18,14 +18,8 @@
 #pragma interface "confbase.h"
 #endif
 
 #pragma interface "confbase.h"
 #endif
 

-// ----------------------------------------------------------------------------
-// compile options
-// ----------------------------------------------------------------------------
-
-// it won't compile without it anyhow
-#ifndef USE_WXCONFIG
-  #error "Please define USE_WXCONFIG or remove config.cpp from your makefile"
-#endif // USE_WXCONFIG
+#include "wx/defs.h"
+#include "wx/string.h"

 
 // ----------------------------------------------------------------------------
 // constants
 
 // ----------------------------------------------------------------------------
 // constants


@@ -38,41 +32,37 @@
 
 /// separates group and entry names (probably shouldn't be changed)
 #ifndef wxCONFIG_PATH_SEPARATOR
 
 /// separates group and entry names (probably shouldn't be changed)
 #ifndef wxCONFIG_PATH_SEPARATOR

-  #define   wxCONFIG_PATH_SEPARATOR     '/'
+  #define   wxCONFIG_PATH_SEPARATOR     _T('/')

 #endif
 
 /// introduces immutable entries
 // (i.e. the ones which can't be changed from the local config file)
 #ifndef wxCONFIG_IMMUTABLE_PREFIX
 #endif
 
 /// introduces immutable entries
 // (i.e. the ones which can't be changed from the local config file)
 #ifndef wxCONFIG_IMMUTABLE_PREFIX

-  #define   wxCONFIG_IMMUTABLE_PREFIX   '!'
+  #define   wxCONFIG_IMMUTABLE_PREFIX   _T('!')

 #endif
 
 #endif
 

-/// should we use registry instead of configuration files under Win32?
+#if wxUSE_CONFIG
+
+#include "wx/string.h"
+
+/// should we use registry instead of configuration files under Windows?

 // (i.e. whether wxConfigBase::Create() will create a wxFileConfig (if it's
 //  FALSE) or wxRegConfig (if it's true and we're under Win32) or wxIniConfig
 //  (under Win16))
 // (i.e. whether wxConfigBase::Create() will create a wxFileConfig (if it's
 //  FALSE) or wxRegConfig (if it's true and we're under Win32) or wxIniConfig
 //  (under Win16))

-#ifndef   wxCONFIG_WIN32_NATIVE
-  #define wxCONFIG_WIN32_NATIVE          TRUE
+#ifndef   wxUSE_CONFIG_NATIVE
+  #define wxUSE_CONFIG_NATIVE 1

 #endif
 
 #endif
 

-// ----------------------------------------------------------------------------
-// various helper global functions
-// ----------------------------------------------------------------------------
-
-/*
-  Replace environment variables ($SOMETHING) with their values. The format is
-  $VARNAME or ${VARNAME} where VARNAME contains alphanumeric characters and
-  '_' only. '$' must be escaped ('\$') in order to be taken literally.
- */
-extern wxString wxExpandEnvVars(const wxString &sz);
-
-/*
-  Split path into parts removing '..' in progress
- */
-extern void wxSplitPath(wxArrayString& aParts, const char *sz);
+// Style flags for constructor style parameter
+enum
+{
+    wxCONFIG_USE_LOCAL_FILE = 1,
+    wxCONFIG_USE_GLOBAL_FILE = 2,
+    wxCONFIG_USE_RELATIVE_PATH = 4
+};

 
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------

-// abstract base class wxConfigBase which defines the interface for derived 
+// abstract base class wxConfigBase which defines the interface for derived

 // classes
 //
 // wxConfig organizes the items in a tree-like structure (modeled after the
 // classes
 //
 // wxConfig organizes the items in a tree-like structure (modeled after the


@@ -80,30 +70,51 @@ extern void wxSplitPath(wxArrayString& aParts, const char *sz);
 // There is always one current group given by the current path.
 //
 // Keys are pairs "key_name = value" where value may be of string or integer
 // There is always one current group given by the current path.
 //
 // Keys are pairs "key_name = value" where value may be of string or integer

-// (long) type (@@@ doubles and other types such as wxDate coming soon).
+// (long) type (TODO doubles and other types such as wxDate coming soon).

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

-class wxConfigBase
+class WXDLLEXPORT wxConfigBase

 {
 public:
 {
 public:

+  // constants
+    // the type of an entry
+  enum EntryType
+  {
+    Type_Unknown,
+    Type_String,
+    Type_Boolean,
+    Type_Integer,    // use Read(long *)
+    Type_Float       // use Read(double *)
+  };
+

   // static functions
     // sets the config object, returns the previous pointer
   static wxConfigBase *Set(wxConfigBase *pConfig);
     // get the config object, creates it on demand unless DontCreateOnDemand
     // was called
   // static functions
     // sets the config object, returns the previous pointer
   static wxConfigBase *Set(wxConfigBase *pConfig);
     // get the config object, creates it on demand unless DontCreateOnDemand
     // was called

-  static wxConfigBase *Get() { if ( !ms_pConfig ) Create(); return ms_pConfig; }
+  static wxConfigBase *Get(bool createOnDemand = TRUE) 
+       { if ( createOnDemand && (!ms_pConfig) ) Create(); return ms_pConfig; }

     // create a new config object: this function will create the "best"
     // implementation of wxConfig available for the current platform, see
     // create a new config object: this function will create the "best"
     // implementation of wxConfig available for the current platform, see

-    // comments near definition wxCONFIG_WIN32_NATIVE for details. It returns
+    // comments near definition wxUSE_CONFIG_NATIVE for details. It returns

     // the created object and also sets it as ms_pConfig.
   static wxConfigBase *Create();
     // should Get() try to create a new log object if the current one is NULL?
   static void DontCreateOnDemand() { ms_bAutoCreate = FALSE; }
 
   // ctor & virtual dtor
     // the created object and also sets it as ms_pConfig.
   static wxConfigBase *Create();
     // should Get() try to create a new log object if the current one is NULL?
   static void DontCreateOnDemand() { ms_bAutoCreate = FALSE; }
 
   // ctor & virtual dtor

-    // environment variable expansion is on by default
-  wxConfigBase() { m_bExpandEnvVars = TRUE; m_bRecordDefaults = FALSE; }
+      // ctor (can be used as default ctor too)
+      //
+      // Not all args will always be used by derived classes, but including
+      // them all in each class ensures compatibility. If appName is empty,
+      // uses wxApp name
+  wxConfigBase(const wxString& appName = wxEmptyString,
+               const wxString& vendorName = wxEmptyString,
+               const wxString& localFilename = wxEmptyString,
+               const wxString& globalFilename = wxEmptyString,
+               long style = 0);
+

     // empty but ensures that dtor of all derived classes is virtual
     // empty but ensures that dtor of all derived classes is virtual

-  virtual ~wxConfigBase() { }
+  virtual ~wxConfigBase();

 
   // path management
     // set current path: if the first character is '/', it's the absolute path,
 
   // path management
     // set current path: if the first character is '/', it's the absolute path,


@@ -135,34 +146,72 @@ public:
   bool Exists(const wxString& strName) const
     { return HasGroup(strName) || HasEntry(strName); }
 
   bool Exists(const wxString& strName) const
     { return HasGroup(strName) || HasEntry(strName); }
 

+    // get the entry type
+  virtual EntryType GetEntryType(const wxString& name) const
+  {
+    // by default all entries are strings
+    return HasEntry(name) ? Type_String : Type_Unknown;
+  }
+

   // key access: returns TRUE if value was really read, FALSE if default used
   // (and if the key is not found the default value is returned.)
     // read a string from the key
   // key access: returns TRUE if value was really read, FALSE if default used
   // (and if the key is not found the default value is returned.)
     // read a string from the key

-  virtual bool Read(wxString *pStr, const char *szKey,
-                    const char *szDefault = NULL) const = 0;
-    // another version using statis buffer - it means it will be overwritten
-    // after each call to this function!
-  virtual const char *Read(const char *szKey,
-                           const char *szDefault = NULL) const;
-    // the same for longs
-  virtual long Read(const char *szKey, long lDefault) const
-    { long l; Read(&l, szKey, lDefault); return l; }
-    // and another version: returns true if default value is returned
-  virtual bool Read(long *pl, const char *szKey, long lDefault = 0) const = 0;
+  virtual bool Read(const wxString& key, wxString *pStr) const = 0;
+  virtual bool Read(const wxString& key, wxString *pStr, const wxString& defVal) const;
+
+  virtual wxString Read(const wxString& key, const wxString& defVal = wxEmptyString) const;
+
+  virtual bool Read(const wxString& key, long *pl) const = 0;
+  virtual bool Read(const wxString& key, long *pl, long defVal) const;
+
+  virtual long Read(const wxString& strKey, long defVal) const
+    { long l; Read(strKey, &l, defVal); return l; }
+
+  // Convenience functions that are built on other forms
+
+  // int
+  virtual bool Read(const wxString& key, int *pi) const;
+  virtual bool Read(const wxString& key, int *pi, int defVal) const;
+
+  // double
+  virtual bool Read(const wxString& key, double* val) const;
+  virtual bool Read(const wxString& key, double* val, double defVal) const;
+
+  // bool
+  virtual bool Read(const wxString& key, bool* val) const;
+  virtual bool Read(const wxString& key, bool* val, bool defVal) const;

 
     // write the value (return true on success)
 
     // write the value (return true on success)

-  virtual bool Write(const char *szKey, const char *szValue) = 0;
-  virtual bool Write(const char *szKey, long lValue) = 0;
-    // permanently writes all changes
+  virtual bool Write(const wxString& key, const wxString& value) = 0;
+  virtual bool Write(const wxString& key, long value) = 0;
+
+  // convenience functions
+  virtual bool Write(const wxString& key, double value);
+  virtual bool Write(const wxString& key, bool value);
+
+  // we have to provide a separate version for C strings as otherwise they
+  // would be converted to bool and not to wxString as expected!
+  virtual bool Write(const wxString& key, const wxChar *value);
+
+  // permanently writes all changes

   virtual bool Flush(bool bCurrentOnly = FALSE) = 0;
 
   virtual bool Flush(bool bCurrentOnly = FALSE) = 0;
 

+  // renaming, all functions return FALSE on failure (probably because the new
+  // name is already taken by an existing entry)
+    // rename an entry
+  virtual bool RenameEntry(const wxString& oldName,
+                           const wxString& newName) = 0;
+    // rename a group
+  virtual bool RenameGroup(const wxString& oldName,
+                           const wxString& newName) = 0;
+

   // delete entries/groups
     // deletes the specified entry and the group it belongs to if
     // it was the last key in it and the second parameter is true
   // delete entries/groups
     // deletes the specified entry and the group it belongs to if
     // it was the last key in it and the second parameter is true

-  virtual bool DeleteEntry(const char *szKey,
+  virtual bool DeleteEntry(const wxString& key,

                            bool bDeleteGroupIfEmpty = TRUE) = 0;
     // delete the group (with all subgroups)
                            bool bDeleteGroupIfEmpty = TRUE) = 0;
     // delete the group (with all subgroups)

-  virtual bool DeleteGroup(const char *szKey) = 0;
+  virtual bool DeleteGroup(const wxString& key) = 0;

     // delete the whole underlying object (disk file, registry key, ...)
     // primarly for use by desinstallation routine.
   virtual bool DeleteAll() = 0;
     // delete the whole underlying object (disk file, registry key, ...)
     // primarly for use by desinstallation routine.
   virtual bool DeleteAll() = 0;


@@ -176,30 +225,52 @@ public:
   void SetRecordDefaults(bool bDoIt = TRUE) { m_bRecordDefaults = bDoIt; }
   bool IsRecordingDefaults() const { return m_bRecordDefaults; }
   // does expansion only if needed
   void SetRecordDefaults(bool bDoIt = TRUE) { m_bRecordDefaults = bDoIt; }
   bool IsRecordingDefaults() const { return m_bRecordDefaults; }
   // does expansion only if needed

-  wxString ExpandEnvVars(const wxString& str) const
-    {
-        wxString tmp; // Required for BC++
-        if (IsExpandingEnvVars())
-            tmp = wxExpandEnvVars(str);
-        else
-            tmp = str;
-        return tmp;
-    }
+  wxString ExpandEnvVars(const wxString& str) const;
+
+    // misc accessors
+  wxString GetAppName() const { return m_appName; }
+  wxString GetVendorName() const { return m_vendorName; }
+
+  // Used wxIniConfig to set members in constructor
+  void SetAppName(const wxString& appName) { m_appName = appName; }
+  void SetVendorName(const wxString& vendorName) { m_vendorName = vendorName; }
+
+  void SetStyle(long style) { m_style = style; }
+  long GetStyle() const { return m_style; }

 
 protected:
 
 protected:

-  static bool IsImmutable(const char *szKey)
-    { return *szKey == wxCONFIG_IMMUTABLE_PREFIX; }
+  static bool IsImmutable(const wxString& key)
+    { return !key.IsEmpty() && key[0] == wxCONFIG_IMMUTABLE_PREFIX; }
+
+private:
+  // are we doing automatic environment variable expansion?
+  bool m_bExpandEnvVars;
+  // do we record default values?
+  bool m_bRecordDefaults;
+
+  // static variables
+  static wxConfigBase *ms_pConfig;
+  static bool          ms_bAutoCreate;
+
+  // Application name and organisation name
+  wxString          m_appName;
+  wxString          m_vendorName;
+
+  // Style flag
+  long              m_style;
+};

 
   // a handy little class which changes current path to the path of given entry
   // and restores it in dtor: so if you declare a local variable of this type,
   // you work in the entry directory and the path is automatically restored
   // when the function returns
 
   // a handy little class which changes current path to the path of given entry
   // and restores it in dtor: so if you declare a local variable of this type,
   // you work in the entry directory and the path is automatically restored
   // when the function returns

-  class PathChanger
+  // Taken out of wxConfig since not all compilers can cope with nested classes.
+  class wxConfigPathChanger

   {
   public:
     // ctor/dtor do path changing/restorin
   {
   public:
     // ctor/dtor do path changing/restorin

-    PathChanger(const wxConfigBase *pContainer, const wxString& strEntry);
-   ~PathChanger();
+    wxConfigPathChanger(const wxConfigBase *pContainer, const wxString& strEntry);
+   ~wxConfigPathChanger();

 
     // get the key name
     const wxString& Name() const { return m_strName; }
 
     // get the key name
     const wxString& Name() const { return m_strName; }


@@ -211,34 +282,41 @@ protected:
     bool          m_bChanged;     // was the path changed?
   };
 
     bool          m_bChanged;     // was the path changed?
   };
 

-private:
-  // are we doing automatic environment variable expansion?
-  bool m_bExpandEnvVars;
-  // do we record default values?
-  bool m_bRecordDefaults;
-  
-  // static variables
-  static wxConfigBase *ms_pConfig;
-  static bool          ms_bAutoCreate;
-};

 
 // ----------------------------------------------------------------------------
 // the native wxConfigBase implementation
 // ----------------------------------------------------------------------------
 
 // under Windows we prefer to use the native implementation
 
 // ----------------------------------------------------------------------------
 // the native wxConfigBase implementation
 // ----------------------------------------------------------------------------
 
 // under Windows we prefer to use the native implementation

-#if defined(__WXMSW__) && wxCONFIG_WIN32_NATIVE
+#if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE

   #ifdef __WIN32__
     #define wxConfig  wxRegConfig
   #ifdef __WIN32__
     #define wxConfig  wxRegConfig

-    #define classwxConfig classwxRegConfig
+    #define sm_classwxConfig sm_classwxRegConfig

   #else  //WIN16
     #define wxConfig  wxIniConfig
   #else  //WIN16
     #define wxConfig  wxIniConfig

-    #define classwxConfig classwxIniConfig
+    #define sm_classwxConfig sm_classwxIniConfig

   #endif
 #else // either we're under Unix or wish to use files even under Windows
   #define wxConfig  wxFileConfig
   #endif
 #else // either we're under Unix or wish to use files even under Windows
   #define wxConfig  wxFileConfig

-  #define classwxConfig classwxFileConfig
+  #define sm_classwxConfig sm_classwxFileConfig

 #endif
 
 #endif
 

-#endif  // _WX_CONFIG_H_
+#endif // wxUSE_CONFIG
+
+/*
+  Replace environment variables ($SOMETHING) with their values. The format is
+  $VARNAME or ${VARNAME} where VARNAME contains alphanumeric characters and
+  '_' only. '$' must be escaped ('\$') in order to be taken literally.
+*/
+
+WXDLLEXPORT wxString wxExpandEnvVars(const wxString &sz);
+
+/*
+  Split path into parts removing '..' in progress
+ */
+WXDLLEXPORT void wxSplitPath(wxArrayString& aParts, const wxChar *sz);
+
+
+#endif
+  // _WX_CONFIG_H_