Export recently added wxRichTextXMLHelper to fix link errors.

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

diff --git a/include/wx/confbase.h b/include/wx/confbase.h
index 39d06305b844675df9a0a2e3e0f0eb25ac8d5588..9fd9df782a5717fe3ee8fe027c170d9ebe459497 100644 (file)
--- a/include/wx/confbase.h
+++ b/include/wx/confbase.h
@@ -1,12 +1,11 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        confbase.h
+// Name:        wx/confbase.h

 // Purpose:     declaration of the base class of all config implementations
 //              (see also: fileconf.h and msw/regconf.h and iniconf.h)
 // Purpose:     declaration of the base class of all config implementations
 //              (see also: fileconf.h and msw/regconf.h and iniconf.h)

-// Author:      Karsten Ballüder & Vadim Zeitlin
+// Author:      Karsten Ballueder & Vadim Zeitlin

 // Modified by:
 // Created:     07.04.98 (adapted from appconf.h)
 // Modified by:
 // Created:     07.04.98 (adapted from appconf.h)

-// RCS-ID:      $Id$
-// Copyright:   (c) 1997 Karsten Ballüder   Ballueder@usa.net
+// Copyright:   (c) 1997 Karsten Ballueder   Ballueder@usa.net

 //                       Vadim Zeitlin      <zeitlin@dptmaths.ens-cachan.fr>
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 //                       Vadim Zeitlin      <zeitlin@dptmaths.ens-cachan.fr>
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////


@@ -32,19 +31,17 @@ class WXDLLIMPEXP_FWD_BASE wxArrayString;
 
 /// 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     _T('/')
+  #define   wxCONFIG_PATH_SEPARATOR     wxT('/')

 #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   _T('!')
+  #define   wxCONFIG_IMMUTABLE_PREFIX   wxT('!')

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


@@ -52,6 +49,15 @@ class WXDLLIMPEXP_FWD_BASE wxArrayString;
   #define wxUSE_CONFIG_NATIVE 1
 #endif
 
   #define wxUSE_CONFIG_NATIVE 1
 #endif
 

+// not all compilers can deal with template Read/Write() methods, define this
+// symbol if the template functions are available
+#if (!defined(__VISUALC__) || __VISUALC__ > 1200) && \
+    !defined( __VMS ) && \
+    !(defined(__HP_aCC) && defined(__hppa)) && \
+    !defined (__DMC__)
+    #define wxHAS_CONFIG_TEMPLATE_RW
+#endif
+

 // Style flags for constructor style parameter
 enum
 {
 // Style flags for constructor style parameter
 enum
 {


@@ -66,7 +72,7 @@ enum
 // abstract base class wxConfigBase which defines the interface for derived
 // classes
 //
 // abstract base class wxConfigBase which defines the interface for derived
 // classes
 //

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

 // Unix/Dos filesystem). There are groups (directories) and keys (files).
 // There is always one current group given by the current path.
 //
 // Unix/Dos filesystem). There are groups (directories) and keys (files).
 // There is always one current group given by the current path.
 //


@@ -166,7 +172,7 @@ public:
   bool Read(const wxString& key, long *pl) const;
   bool Read(const wxString& key, long *pl, long defVal) const;
 
   bool Read(const wxString& key, long *pl) const;
   bool Read(const wxString& key, long *pl, long defVal) const;
 

-    // read an int
+    // 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;
 
   bool Read(const wxString& key, int *pi) const;
   bool Read(const wxString& key, int *pi, int defVal) const;
 


@@ -174,6 +180,10 @@ public:
   bool Read(const wxString& key, double* val) const;
   bool Read(const wxString& key, double* val, double defVal) const;
 
   bool Read(const wxString& key, double* val) const;
   bool Read(const wxString& key, double* val, double defVal) const;
 

+    // read a float
+  bool Read(const wxString& key, float* val) const;
+  bool Read(const wxString& key, float* val, float defVal) const;
+

     // read a bool
   bool Read(const wxString& key, bool* val) const;
   bool Read(const wxString& key, bool* val, bool defVal) const;
     // read a bool
   bool Read(const wxString& key, bool* val) const;
   bool Read(const wxString& key, bool* val, bool defVal) const;


@@ -185,25 +195,68 @@ public:
    // no default version since it does not make sense for binary data
 #endif // wxUSE_BASE64
 
    // no default version since it does not make sense for binary data
 #endif // wxUSE_BASE64
 

-  // convenience functions returning directly the value (we don't have them for
-  // int/double/bool as there would be ambiguities with the long one then)
+#ifdef wxHAS_CONFIG_TEMPLATE_RW
+  // 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 // wxHAS_CONFIG_TEMPLATE_RW
+
+  // 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; }
 
   wxString Read(const wxString& key,
                 const wxString& defVal = wxEmptyString) const
     { wxString s; (void)Read(key, &s, defVal); return s; }
 

-  long Read(const wxString& key, long defVal) const
+  // 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)); }
+  wxString Read(const wxString& key, const wchar_t* defVal) const
+    { return Read(key, wxString(defVal)); }
+
+  long ReadLong(const wxString& key, long defVal) const

     { long l; (void)Read(key, &l, defVal); return l; }
 
     { long l; (void)Read(key, &l, defVal); return l; }
 

-    // write the value (return true on success)
+  double ReadDouble(const wxString& key, double defVal) const
+    { double d; (void)Read(key, &d, defVal); return d; }
+
+  bool ReadBool(const wxString& key, bool defVal) const
+    { bool b; (void)Read(key, &b, defVal); return b; }
+
+  template <typename T>
+  T ReadObject(const wxString& key, T const& defVal) const
+    { T t; (void)Read(key, &t, defVal); return t; }
+
+  // for compatibility with wx 2.8
+  long Read(const wxString& key, long defVal) const
+    { return ReadLong(key, defVal); }
+
+
+  // write the value (return true on success)

   bool Write(const wxString& key, const wxString& value)
     { return DoWriteString(key, value); }
 
   bool Write(const wxString& key, long value)
     { return DoWriteLong(key, value); }
 
   bool Write(const wxString& key, const wxString& value)
     { return DoWriteString(key, value); }
 
   bool Write(const wxString& key, long value)
     { return DoWriteLong(key, value); }
 

-  bool Write(const wxString& key, int value)
-    { return DoWriteInt(key, value); }
-

   bool Write(const wxString& key, double value)
     { return DoWriteDouble(key, value); }
 
   bool Write(const wxString& key, double value)
     { return DoWriteDouble(key, value); }
 


@@ -219,9 +272,45 @@ public:
   // would be converted to bool and not to wxString as expected!
   bool Write(const wxString& key, const char *value)
     { return Write(key, wxString(value)); }
   // would be converted to bool and not to wxString as expected!
   bool Write(const wxString& key, const char *value)
     { return Write(key, wxString(value)); }

-#if wxUSE_WCHAR_T
+  bool Write(const wxString& key, const unsigned char *value)
+    { return Write(key, wxString(value)); }

   bool Write(const wxString& key, const wchar_t *value)
     { return Write(key, wxString(value)); }
   bool Write(const wxString& key, const wchar_t *value)
     { return Write(key, wxString(value)); }

+
+
+  // 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, char value)
+    { return DoWriteLong(key, value); }
+
+  bool Write(const wxString& key, unsigned char value)
+    { return DoWriteLong(key, value); }
+
+  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 and OpenVMS (at least)
+#if ( (!defined(__VISUALC__) || __VISUALC__ > 1200) && !defined( __VMS ) && !defined (__DMC__))
+  // 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
 #endif
 
   // permanently writes all changes


@@ -283,7 +372,6 @@ protected:
   // 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;
   // 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 DoReadInt(const wxString& key, int *pi) const;

   virtual bool DoReadDouble(const wxString& key, double* val) const;
   virtual bool DoReadBool(const wxString& key, bool* val) const;
 #if wxUSE_BASE64
   virtual bool DoReadDouble(const wxString& key, double* val) const;
   virtual bool DoReadBool(const wxString& key, bool* val) const;
 #if wxUSE_BASE64


@@ -292,7 +380,6 @@ protected:
 
   virtual bool DoWriteString(const wxString& key, const wxString& value) = 0;
   virtual bool DoWriteLong(const wxString& key, long value) = 0;
 
   virtual bool DoWriteString(const wxString& key, const wxString& value) = 0;
   virtual bool DoWriteLong(const wxString& key, long value) = 0;

-  virtual bool DoWriteInt(const wxString& key, int value);

   virtual bool DoWriteDouble(const wxString& key, double value);
   virtual bool DoWriteBool(const wxString& key, bool value);
 #if wxUSE_BASE64
   virtual bool DoWriteDouble(const wxString& key, double value);
   virtual bool DoWriteBool(const wxString& key, bool value);
 #if wxUSE_BASE64


@@ -348,22 +435,10 @@ private:
                 m_strOldPath;   // saved path
   bool          m_bChanged;     // was the path changed?
 
                 m_strOldPath;   // saved path
   bool          m_bChanged;     // was the path changed?
 

-  DECLARE_NO_COPY_CLASS(wxConfigPathChanger)
+  wxDECLARE_NO_COPY_CLASS(wxConfigPathChanger);

 };
 
 
 };
 
 

-// ----------------------------------------------------------------------------
-// the native wxConfigBase 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
-    #define wxConfig  wxRegConfig
-#else // either we're under Unix or wish to use files even under Windows
-  #define wxConfig  wxFileConfig
-#endif
-

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