added Unicode-friendly wxSTRINGIZE_T()

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

diff --git a/include/wx/confbase.h b/include/wx/confbase.h
index b2a576c8582988bd9072c8524dc67a78cd9e6e7c..63b755f0f92467eaf722536a514ae65a649d7e4e 100644 (file)
--- a/include/wx/confbase.h
+++ b/include/wx/confbase.h
@@ -8,19 +8,17 @@
 // 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_
 
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef   _WX_CONFBASE_H_
 #define   _WX_CONFBASE_H_
 

-#ifdef __GNUG__
-#pragma interface "confbase.h"
-#endif
-

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

+class WXDLLIMPEXP_BASE wxArrayString;
+

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


@@ -47,8 +45,7 @@
 
 /// 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


@@ -73,7 +70,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:
   // constants
 {
 public:
   // constants


@@ -92,7 +90,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


@@ -100,7 +98,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)


@@ -135,15 +133,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); }
 


@@ -154,7 +152,7 @@ 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.)
 
     // read a string from the key
   // (and if the key is not found the default value is returned.)
 
     // read a string from the key


@@ -208,9 +206,9 @@ public:
     { return Write(key, wxString(value)); }
 
   // permanently writes all changes
     { return Write(key, wxString(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
+  // 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,


@@ -223,7 +221,7 @@ 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, ...)


@@ -234,9 +232,9 @@ public:
     // 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; }
     // 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;


@@ -292,21 +290,31 @@ private:
 // 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.
 // 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
+class WXDLLIMPEXP_BASE wxConfigPathChanger

 {
 public:
 {
 public:

-  // ctor/dtor do path changing/restorin
+  // 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; }
 
   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?
 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)

 };
 
 
 };
 
 


@@ -315,17 +323,11 @@ 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


@@ -336,12 +338,12 @@ private:
   '_' only. '$' must be escaped ('\$') in order to be taken literally.
 */
 
   '_' only. '$' must be escaped ('\$') in order to be taken literally.
 */
 

-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
  */

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

 
 
 #endif
 
 
 #endif