compilation

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

diff --git a/include/wx/confbase.h b/include/wx/confbase.h
index 4b06078b0ebb0482eed9684dbed6b337b804f65d..30d436b3e4929188e2b833b1e377c68bec3d464b 100644 (file)
--- a/include/wx/confbase.h
+++ b/include/wx/confbase.h
@@ -8,21 +8,18 @@
 // RCS-ID:      $Id$
 // Copyright:   (c) 1997 Karsten Ballüder   Ballueder@usa.net
 //                       Vadim Zeitlin      <zeitlin@dptmaths.ens-cachan.fr>
 // RCS-ID:      $Id$
 // Copyright:   (c) 1997 Karsten Ballüder   Ballueder@usa.net
 //                       Vadim Zeitlin      <zeitlin@dptmaths.ens-cachan.fr>

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 ///////////////////////////////////////////////////////////////////////////////
 

-#ifndef   _WX_CONFBASE_H_
-#define   _WX_CONFBASE_H_
-
-#ifdef __GNUG__
-#pragma interface "confbase.h"
-#endif
+#ifndef _WX_CONFBASE_H_
+#define _WX_CONFBASE_H_

 
 #include "wx/defs.h"
 
 #include "wx/defs.h"

-
-#if wxUSE_CONFIG
-

 #include "wx/string.h"
 #include "wx/string.h"

+#include "wx/object.h"
+#include "wx/base64.h"
+
+class WXDLLIMPEXP_FWD_BASE wxArrayString;

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


@@ -30,7 +27,7 @@
 
 /// shall we be case sensitive in parsing variable names?
 #ifndef wxCONFIG_CASE_SENSITIVE
 
 /// shall we be case sensitive in parsing variable names?
 #ifndef wxCONFIG_CASE_SENSITIVE

-  #define  wxCONFIG_CASE_SENSITIVE       FALSE
+  #define  wxCONFIG_CASE_SENSITIVE       0

 #endif
 
 /// separates group and entry names (probably shouldn't be changed)
 #endif
 
 /// separates group and entry names (probably shouldn't be changed)


@@ -44,10 +41,13 @@
   #define   wxCONFIG_IMMUTABLE_PREFIX   _T('!')
 #endif
 
   #define   wxCONFIG_IMMUTABLE_PREFIX   _T('!')
 #endif
 

+#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
 /// 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))
+//  false) or wxRegConfig (if it's true and we're under Win32))

 #ifndef   wxUSE_CONFIG_NATIVE
   #define wxUSE_CONFIG_NATIVE 1
 #endif
 #ifndef   wxUSE_CONFIG_NATIVE
   #define wxUSE_CONFIG_NATIVE 1
 #endif


@@ -57,7 +57,9 @@ enum
 {
     wxCONFIG_USE_LOCAL_FILE = 1,
     wxCONFIG_USE_GLOBAL_FILE = 2,
 {
     wxCONFIG_USE_LOCAL_FILE = 1,
     wxCONFIG_USE_GLOBAL_FILE = 2,

-    wxCONFIG_USE_RELATIVE_PATH = 4
+    wxCONFIG_USE_RELATIVE_PATH = 4,
+    wxCONFIG_USE_NO_ESCAPE_CHARACTERS = 8,
+    wxCONFIG_USE_SUBDIR = 16

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -71,7 +73,8 @@ enum
 // Keys are pairs "key_name = value" where value may be of string or integer
 // (long) type (TODO doubles and other types such as wxDate coming soon).
 // ----------------------------------------------------------------------------
 // Keys are pairs "key_name = value" where value may be of string or integer
 // (long) type (TODO doubles and other types such as wxDate coming soon).
 // ----------------------------------------------------------------------------

-class WXDLLEXPORT wxConfigBase
+
+class WXDLLIMPEXP_BASE wxConfigBase : public wxObject

 {
 public:
   // constants
 {
 public:
   // constants


@@ -90,7 +93,7 @@ public:
   static wxConfigBase *Set(wxConfigBase *pConfig);
     // get the config object, creates it on demand unless DontCreateOnDemand
     // was called
   static wxConfigBase *Set(wxConfigBase *pConfig);
     // get the config object, creates it on demand unless DontCreateOnDemand
     // was called

-  static wxConfigBase *Get(bool createOnDemand = TRUE) 
+  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
        { 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


@@ -98,7 +101,7 @@ public:
     // 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?
     // 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; }
+  static void DontCreateOnDemand() { ms_bAutoCreate = false; }

 
   // ctor & virtual dtor
       // ctor (can be used as default ctor too)
 
   // ctor & virtual dtor
       // ctor (can be used as default ctor too)


@@ -133,15 +136,15 @@ public:
   virtual bool GetNextEntry (wxString& str, long& lIndex) const = 0;
     // get number of entries/subgroups in the current group, with or without
     // it's subgroups
   virtual bool GetNextEntry (wxString& str, long& lIndex) const = 0;
     // get number of entries/subgroups in the current group, with or without
     // it's subgroups

-  virtual size_t GetNumberOfEntries(bool bRecursive = FALSE) const = 0;
-  virtual size_t GetNumberOfGroups(bool bRecursive = FALSE) const = 0;
+  virtual size_t GetNumberOfEntries(bool bRecursive = false) const = 0;
+  virtual size_t GetNumberOfGroups(bool bRecursive = false) const = 0;

 
   // tests of existence
 
   // tests of existence

-    // returns TRUE if the group by this name exists
+    // returns true if the group by this name exists

   virtual bool HasGroup(const wxString& strName) const = 0;
     // same as above, but for an entry
   virtual bool HasEntry(const wxString& strName) const = 0;
   virtual bool HasGroup(const wxString& strName) const = 0;
     // same as above, but for an entry
   virtual bool HasEntry(const wxString& strName) const = 0;

-    // returns TRUE if either a group or an entry with a given name exist
+    // returns true if either a group or an entry with a given name exist

   bool Exists(const wxString& strName) const
     { return HasGroup(strName) || HasEntry(strName); }
 
   bool Exists(const wxString& strName) const
     { return HasGroup(strName) || HasEntry(strName); }
 


@@ -152,50 +155,157 @@ public:
     return HasEntry(name) ? Type_String : Type_Unknown;
   }
 
     return HasEntry(name) ? Type_String : Type_Unknown;
   }
 

-  // key access: returns TRUE if value was really read, FALSE if default used
+  // 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.)
   // (and if the key is not found the default value is returned.)

+

     // read a string from the key
     // read a string from the key

-  virtual bool Read(const wxString& key, wxString *pStr) const = 0;
-  virtual bool Read(const wxString& key, wxString *pStr, const wxString& defVal) const;
+  bool Read(const wxString& key, wxString *pStr) const;
+  bool Read(const wxString& key, wxString *pStr, const wxString& defVal) const;
+
+    // read a number (long)
+  bool Read(const wxString& key, long *pl) const;
+  bool Read(const wxString& key, long *pl, long defVal) const;
+
+    // read an int (wrapper around `long' version)
+  bool Read(const wxString& key, int *pi) const;
+  bool Read(const wxString& key, int *pi, int defVal) const;
+
+    // read a double
+  bool Read(const wxString& key, double* val) const;
+  bool Read(const wxString& key, double* val, double defVal) const;
+
+    // read a bool
+  bool Read(const wxString& key, bool* val) const;
+  bool Read(const wxString& key, bool* val, bool defVal) const;
+
+#if wxUSE_BASE64
+    // read a binary data block
+  bool Read(const wxString& key, wxMemoryBuffer* data) const
+    { return DoReadBinary(key, data); }
+   // no default version since it does not make sense for binary data
+#endif // wxUSE_BASE64
+
+  // Causes ambiguities in VC++ 6 (at least)
+#if (!defined(__VISUALC__) || __VISUALC__ > 1200)
+  // read other types, for which wxFromString is defined
+  template <typename T>
+  bool Read(const wxString& key, T* value) const
+  {
+      wxString s;
+      if ( !Read(key, &s) )
+          return false;
+      return wxFromString(s, value);
+  }
+
+  template <typename T>
+  bool Read(const wxString& key, T* value, const T& defVal) const
+  {
+      const bool found = Read(key, value);
+      if ( !found )
+      {
+          if (IsRecordingDefaults())
+              ((wxConfigBase *)this)->Write(key, defVal);
+          *value = defVal;
+      }
+      return found;
+  }
+#endif
+
+  // convenience functions returning directly the value 
+  wxString Read(const wxString& key,
+                const wxString& defVal = wxEmptyString) const
+    { wxString s; (void)Read(key, &s, defVal); return s; }
+
+  // we have to provide a separate version for C strings as otherwise the
+  // template Read() would be used
+  wxString Read(const wxString& key, const char* defVal) const
+    { return Read(key, wxString(defVal)); }
+#if wxUSE_WCHAR_T
+  wxString Read(const wxString& key, const wchar_t* defVal) const
+    { return Read(key, wxString(defVal)); }
+#endif
+
+  long ReadLong(const wxString& key, long defVal) const
+    { long l; (void)Read(key, &l, defVal); return l; }
+
+  double ReadDouble(const wxString& key, double defVal) const
+    { double d; (void)Read(key, &d, defVal); return d; }

 
 

-  virtual wxString Read(const wxString& key, const wxString& defVal = wxEmptyString) const;
+  bool ReadBool(const wxString& key, bool defVal) const
+    { bool b; (void)Read(key, &b, defVal); return b; }

 
 

-  virtual bool Read(const wxString& key, long *pl) const = 0;
-  virtual bool Read(const wxString& key, long *pl, long defVal) const;
+  template <typename T>
+  T ReadObject(const wxString& key, T const& defVal) const
+    { T t; (void)Read(key, &t, defVal); return t; }

 
 

-  virtual long Read(const wxString& strKey, long defVal) const
-    { long l; Read(strKey, &l, defVal); return l; }
+  // for compatibility with wx 2.8
+  long Read(const wxString& key, long defVal) const
+    { return ReadLong(key, defVal); }

 
 

-  // 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;
+  // write the value (return true on success)
+  bool Write(const wxString& key, const wxString& value)
+    { return DoWriteString(key, value); }

 
 

-  // double
-  virtual bool Read(const wxString& key, double* val) const;
-  virtual bool Read(const wxString& key, double* val, double defVal) const;
+  bool Write(const wxString& key, long value)
+    { return DoWriteLong(key, value); }

 
 

-  // bool
-  virtual bool Read(const wxString& key, bool* val) const;
-  virtual bool Read(const wxString& key, bool* val, bool defVal) const;
+  bool Write(const wxString& key, double value)
+    { return DoWriteDouble(key, value); }

 
 

-    // write the value (return true on success)
-  virtual bool Write(const wxString& key, const wxString& value) = 0;
-  virtual bool Write(const wxString& key, long value) = 0;
+  bool Write(const wxString& key, bool value)
+    { return DoWriteBool(key, value); }

 
 

-  // convenience functions
-  virtual bool Write(const wxString& key, double value);
-  virtual bool Write(const wxString& key, bool value);
+#if wxUSE_BASE64
+  bool Write(const wxString& key, const wxMemoryBuffer& buf)
+    { return DoWriteBinary(key, buf); }
+#endif // wxUSE_BASE64

 
   // we have to provide a separate version for C strings as otherwise they
   // would be converted to bool and not to wxString as expected!
 
   // 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);
+  bool Write(const wxString& key, const char *value)
+    { return Write(key, wxString(value)); }
+  bool Write(const wxString& key, const unsigned char *value)
+    { return Write(key, wxString(value)); }
+#if wxUSE_WCHAR_T
+  bool Write(const wxString& key, const wchar_t *value)
+    { return Write(key, wxString(value)); }
+#endif
+
+
+  // we also have to provide specializations for other types which we want to
+  // handle using the specialized DoWriteXXX() instead of the generic template
+  // version below
+  bool Write(const wxString& key, short value)
+    { return DoWriteLong(key, value); }
+
+  bool Write(const wxString& key, unsigned short value)
+    { return DoWriteLong(key, value); }
+
+  bool Write(const wxString& key, unsigned int value)
+    { return DoWriteLong(key, value); }
+
+  bool Write(const wxString& key, int value)
+    { return DoWriteLong(key, value); }
+
+  bool Write(const wxString& key, unsigned long value)
+    { return DoWriteLong(key, value); }
+
+  bool Write(const wxString& key, float value)
+    { return DoWriteDouble(key, value); }
+
+  // Causes ambiguities in VC++ 6 (at least)
+#if (!defined(__VISUALC__) || __VISUALC__ > 1200)
+  // for other types, use wxToString()
+  template <typename T>
+  bool Write(const wxString& key, T const& value)
+    { return Write(key, wxToString(value)); }
+#endif

 
   // permanently writes all changes
 
   // 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
+  // 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,
   // name is already taken by an existing entry)
     // rename an entry
   virtual bool RenameEntry(const wxString& oldName,


@@ -208,20 +318,20 @@ public:
     // 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 wxString& key,
     // 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 wxString& key,

-                           bool bDeleteGroupIfEmpty = TRUE) = 0;
+                           bool bDeleteGroupIfEmpty = true) = 0;

     // delete the group (with all subgroups)
   virtual bool DeleteGroup(const wxString& key) = 0;
     // delete the whole underlying object (disk file, registry key, ...)
     // delete the group (with all subgroups)
   virtual bool DeleteGroup(const wxString& key) = 0;
     // delete the whole underlying object (disk file, registry key, ...)

-    // primarly for use by desinstallation routine.
+    // primarily for use by uninstallation routine.

   virtual bool DeleteAll() = 0;
 
   // options
     // we can automatically expand environment variables in the config entries
     // (this option is on by default, you can turn it on/off at any time)
   bool IsExpandingEnvVars() const { return m_bExpandEnvVars; }
   virtual bool DeleteAll() = 0;
 
   // options
     // we can automatically expand environment variables in the config entries
     // (this option is on by default, you can turn it on/off at any time)
   bool IsExpandingEnvVars() const { return m_bExpandEnvVars; }

-  void SetExpandEnvVars(bool bDoIt = TRUE) { m_bExpandEnvVars = bDoIt; }
+  void SetExpandEnvVars(bool bDoIt = true) { m_bExpandEnvVars = bDoIt; }

     // recording of default values
     // recording of default values

-  void SetRecordDefaults(bool bDoIt = TRUE) { m_bRecordDefaults = bDoIt; }
+  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;
   bool IsRecordingDefaults() const { return m_bRecordDefaults; }
   // does expansion only if needed
   wxString ExpandEnvVars(const wxString& str) const;


@@ -241,6 +351,30 @@ protected:
   static bool IsImmutable(const wxString& key)
     { return !key.IsEmpty() && key[0] == wxCONFIG_IMMUTABLE_PREFIX; }
 
   static bool IsImmutable(const wxString& key)
     { return !key.IsEmpty() && key[0] == wxCONFIG_IMMUTABLE_PREFIX; }
 

+  // return the path without trailing separator, if any: this should be called
+  // to sanitize paths referring to the group names before passing them to
+  // wxConfigPathChanger as "/foo/bar/" should be the same as "/foo/bar" and it
+  // isn't interpreted in the same way by it (and this can't be changed there
+  // as it's not the same for the entries names)
+  static wxString RemoveTrailingSeparator(const wxString& key);
+
+  // do read/write the values of different types
+  virtual bool DoReadString(const wxString& key, wxString *pStr) const = 0;
+  virtual bool DoReadLong(const wxString& key, long *pl) const = 0;
+  virtual bool DoReadDouble(const wxString& key, double* val) const;
+  virtual bool DoReadBool(const wxString& key, bool* val) const;
+#if wxUSE_BASE64
+  virtual bool DoReadBinary(const wxString& key, wxMemoryBuffer* buf) const = 0;
+#endif // wxUSE_BASE64
+
+  virtual bool DoWriteString(const wxString& key, const wxString& value) = 0;
+  virtual bool DoWriteLong(const wxString& key, long value) = 0;
+  virtual bool DoWriteDouble(const wxString& key, double value);
+  virtual bool DoWriteBool(const wxString& key, bool value);
+#if wxUSE_BASE64
+  virtual bool DoWriteBinary(const wxString& key, const wxMemoryBuffer& buf) = 0;
+#endif // wxUSE_BASE64
+

 private:
   // are we doing automatic environment variable expansion?
   bool m_bExpandEnvVars;
 private:
   // are we doing automatic environment variable expansion?
   bool m_bExpandEnvVars;


@@ -257,29 +391,41 @@ private:
 
   // Style flag
   long              m_style;
 
   // Style flag
   long              m_style;

+
+  DECLARE_ABSTRACT_CLASS(wxConfigBase)

 };
 
 };
 

-  // 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
-  // Taken out of wxConfig since not all compilers can cope with nested classes.
-  class wxConfigPathChanger
-  {
-  public:
-    // ctor/dtor do path changing/restorin
-    wxConfigPathChanger(const wxConfigBase *pContainer, const wxString& strEntry);
-   ~wxConfigPathChanger();
-
-    // get the key name
-    const wxString& Name() const { return m_strName; }
-
-  private:
-    wxConfigBase *m_pContainer;   // object we live in
-    wxString      m_strName,      // name of entry (i.e. name only)
-                  m_strOldPath;   // saved path
-    bool          m_bChanged;     // was the path changed?
-  };
+// 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
+// Taken out of wxConfig since not all compilers can cope with nested classes.
+class WXDLLIMPEXP_BASE wxConfigPathChanger
+{
+public:
+  // ctor/dtor do path changing/restoring of the path
+  wxConfigPathChanger(const wxConfigBase *pContainer, const wxString& strEntry);
+ ~wxConfigPathChanger();
+
+  // get the key name
+  const wxString& Name() const { return m_strName; }
+
+  // this method must be called if the original path (i.e. the current path at
+  // the moment of creation of this object) could have been deleted to prevent
+  // us from restoring the not existing (any more) path
+  //
+  // if the original path doesn't exist any more, the path will be restored to
+  // the deepest still existing component of the old path
+  void UpdateIfDeleted();
+
+private:
+  wxConfigBase *m_pContainer;   // object we live in
+  wxString      m_strName,      // name of entry (i.e. name only)
+                m_strOldPath;   // saved path
+  bool          m_bChanged;     // was the path changed?
+
+  DECLARE_NO_COPY_CLASS(wxConfigPathChanger)
+};

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


@@ -287,37 +433,27 @@ private:
 // ----------------------------------------------------------------------------
 
 // under Windows we prefer to use the native implementation
 // ----------------------------------------------------------------------------
 
 // under Windows we prefer to use the native implementation

+// wxIniConfig isn't native anywhere after droping win16 in wxWidgets 2.6

 #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
 #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE

-  #ifdef __WIN32__

     #define wxConfig  wxRegConfig
     #define wxConfig  wxRegConfig

-    #define sm_classwxConfig sm_classwxRegConfig
-  #else  //WIN16
-    #define wxConfig  wxIniConfig
-    #define sm_classwxConfig sm_classwxIniConfig
-  #endif

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

-  #define sm_classwxConfig sm_classwxFileConfig

 #endif
 
 #endif // wxUSE_CONFIG
 
 #endif
 
 #endif // wxUSE_CONFIG
 

-// ----------------------------------------------------------------------------
-// various helper global functions (defined even if !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.
 /*
   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 WXDLLEXPORT wxString wxExpandEnvVars(const wxString &sz);
+*/
+
+WXDLLIMPEXP_BASE wxString wxExpandEnvVars(const wxString &sz);

 
 /*
   Split path into parts removing '..' in progress
  */
 
 /*
   Split path into parts removing '..' in progress
  */

-extern WXDLLEXPORT void wxSplitPath(wxArrayString& aParts, const wxChar *sz);
+WXDLLIMPEXP_BASE void wxSplitPath(wxArrayString& aParts, const wxString& path);

 
 

-#endif
-  // _WX_CONFIG_H_
+#endif // _WX_CONFBASE_H_