*** empty log message ***

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

diff --git a/include/wx/confbase.h b/include/wx/confbase.h
index 438f64735e1eb4c5d02b8efa61e6ab45be013065..c4cfa87538e48ebcaca6ecfaca186c783641364a 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,11 @@
 #pragma interface "confbase.h"
 #endif
 
 #pragma interface "confbase.h"
 #endif
 

-// ----------------------------------------------------------------------------
-// compile options
-// ----------------------------------------------------------------------------
+#include "wx/defs.h"
+
+#if wxUSE_CONFIG

 
 

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

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


@@ -56,27 +53,15 @@
 #endif
 
 // Style flags for constructor style parameter
 #endif
 
 // Style flags for constructor style parameter

-#define wxCONFIG_USE_LOCAL_FILE         1
-#define wxCONFIG_USE_GLOBAL_FILE        2
-
-// ----------------------------------------------------------------------------
-// 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);
+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


@@ -84,11 +69,22 @@ 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);
   // static functions
     // sets the config object, returns the previous pointer
   static wxConfigBase *Set(wxConfigBase *pConfig);


@@ -104,17 +100,16 @@ public:
   static void DontCreateOnDemand() { ms_bAutoCreate = FALSE; }
 
   // ctor & virtual dtor
   static void DontCreateOnDemand() { ms_bAutoCreate = FALSE; }
 
   // ctor & virtual dtor

-    // environment variable expansion is on by default
-//  wxConfigBase() { m_bExpandEnvVars = TRUE; m_bRecordDefaults = FALSE; }
-
-  // ctor
-
-  // 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);
+      // 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
   virtual ~wxConfigBase() { }
 
     // empty but ensures that dtor of all derived classes is virtual
   virtual ~wxConfigBase() { }


@@ -149,13 +144,20 @@ 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
   virtual bool Read(const wxString& key, wxString *pStr) const = 0;
   virtual bool Read(const wxString& key, wxString *pStr, const wxString& defVal) const;
 
   // 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(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) 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 bool Read(const wxString& key, long *pl) const = 0;
   virtual bool Read(const wxString& key, long *pl, long defVal) const;


@@ -164,6 +166,11 @@ public:
     { long l; Read(strKey, &l, defVal); return l; }
 
   // Convenience functions that are built on other forms
     { 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;
   // double
   virtual bool Read(const wxString& key, double* val) const;
   virtual bool Read(const wxString& key, double* val, double defVal) const;


@@ -183,6 +190,15 @@ public:
     // permanently writes all changes
   virtual bool Flush(bool bCurrentOnly = FALSE) = 0;
 
     // permanently writes all changes
   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


@@ -203,36 +219,29 @@ 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
 
     // misc accessors

-  inline wxString GetAppName() const { return m_appName; }
-  inline wxString GetVendorName() const { return m_vendorName; }
+  wxString GetAppName() const { return m_appName; }
+  wxString GetVendorName() const { return m_vendorName; }

 
 

-  inline void SetAppName(const wxString& appName) { m_appName = appName; }
-  inline void SetVendorName(const wxString& vendorName) { m_vendorName = vendorName; }
-
-  inline void SetStyle(long style) { m_style = style; }
-  inline long GetStyle() const { return m_style; }
+  void SetStyle(long style) { m_style = style; }
+  long GetStyle() const { return m_style; }

 
 protected:
   static bool IsImmutable(const wxString& key)
 
 protected:
   static bool IsImmutable(const wxString& key)

-    { return key[0] == wxCONFIG_IMMUTABLE_PREFIX; }
+#if !defined(__WXMAC__) && !defined(__EMX__)
+    { return !key.IsEmpty() && key[0u] == wxCONFIG_IMMUTABLE_PREFIX; }
+#else
+    { return !key.IsEmpty() && key[0ul] == wxCONFIG_IMMUTABLE_PREFIX; }
+#endif

 
 private:
   // are we doing automatic environment variable expansion?
   bool m_bExpandEnvVars;
   // do we record default values?
   bool m_bRecordDefaults;
 
 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;
   // static variables
   static wxConfigBase *ms_pConfig;
   static bool          ms_bAutoCreate;


@@ -276,17 +285,34 @@ private:
 #if defined(__WXMSW__) && wxCONFIG_WIN32_NATIVE
   #ifdef __WIN32__
     #define wxConfig  wxRegConfig
 #if defined(__WXMSW__) && wxCONFIG_WIN32_NATIVE
   #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 // wxUSE_CONFIG

 
 

+// ----------------------------------------------------------------------------
+// various helper global functions (defined even if !wxUSE_CONFIG)
+// ----------------------------------------------------------------------------

 
 

-#endif  // _WX_CONFIG_H_
+/*
+  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 wxChar *sz);
+
+#endif
+  // _WX_CONFIG_H_