add const synonyms for wxGridTableBase::GetNumberRows/Cols(), using const_cast<>...

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

diff --git a/include/wx/confbase.h b/include/wx/confbase.h
index e0fcf84ebf23ab47284f453dcb6180c93414c57a..91871da380e1762fe05e7ca2d6ce2143cf6f920d 100644 (file)
--- a/include/wx/confbase.h
+++ b/include/wx/confbase.h
@@ -2,22 +2,24 @@
 // Name:        confbase.h
 // Purpose:     declaration of the base class of all config implementations
 //              (see also: fileconf.h and msw/regconf.h and iniconf.h)
 // Name:        confbase.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)
 // RCS-ID:      $Id$
 // 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
 ///////////////////////////////////////////////////////////////////////////////
 

-#ifndef   _WX_CONFBASE_H_
-#define   _WX_CONFBASE_H_
+#ifndef _WX_CONFBASE_H_
+#define _WX_CONFBASE_H_

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

+#include "wx/object.h"
+#include "wx/base64.h"

 
 

-class WXDLLIMPEXP_BASE wxArrayString;
+class WXDLLIMPEXP_FWD_BASE wxArrayString;

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


@@ -56,7 +58,8 @@ enum
     wxCONFIG_USE_LOCAL_FILE = 1,
     wxCONFIG_USE_GLOBAL_FILE = 2,
     wxCONFIG_USE_RELATIVE_PATH = 4,
     wxCONFIG_USE_LOCAL_FILE = 1,
     wxCONFIG_USE_GLOBAL_FILE = 2,
     wxCONFIG_USE_RELATIVE_PATH = 4,

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

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


@@ -71,7 +74,7 @@ enum
 // (long) type (TODO doubles and other types such as wxDate coming soon).
 // ----------------------------------------------------------------------------
 
 // (long) type (TODO doubles and other types such as wxDate coming soon).
 // ----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_BASE wxConfigBase
+class WXDLLIMPEXP_BASE wxConfigBase : public wxObject

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


@@ -163,7 +166,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;
 


@@ -175,35 +178,135 @@ public:
   bool Read(const wxString& key, bool* val) const;
   bool Read(const wxString& key, bool* val, bool defVal) const;
 
   bool Read(const wxString& key, bool* val) const;
   bool Read(const wxString& key, bool* val, bool defVal) const;
 

-  // 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)
+#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 and OpenVMS (at least)
+#if ( (!defined(__VISUALC__) || __VISUALC__ > 1200) && !defined( __VMS ) && !defined (__DMC__))
+  // 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; }
 
   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)); }
+#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; }
 
     { 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, bool value)
     { return DoWriteBool(key, value); }
 
   bool Write(const wxString& key, double value)
     { return DoWriteDouble(key, value); }
 
   bool Write(const wxString& key, bool value)
     { return DoWriteBool(key, 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!

-  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)); }
     { 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, 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
   virtual bool Flush(bool bCurrentOnly = false) = 0;
 
   // permanently writes all changes
   virtual bool Flush(bool bCurrentOnly = false) = 0;


@@ -225,7 +328,7 @@ public:
     // 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
   virtual bool DeleteAll() = 0;
 
   // options


@@ -254,18 +357,29 @@ 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;
   // 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;
   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 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);
   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?
 
 private:
   // are we doing automatic environment variable expansion?


@@ -283,6 +397,8 @@ 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
 };
 
 // a handy little class which changes current path to the path of given entry


@@ -293,13 +409,21 @@ private:
 class WXDLLIMPEXP_BASE wxConfigPathChanger
 {
 public:
 class WXDLLIMPEXP_BASE wxConfigPathChanger
 {
 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)
 private:
   wxConfigBase *m_pContainer;   // object we live in
   wxString      m_strName,      // name of entry (i.e. name only)


@@ -310,18 +434,6 @@ private:
 };
 
 
 };
 
 

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


@@ -335,9 +447,7 @@ WXDLLIMPEXP_BASE wxString wxExpandEnvVars(const wxString &sz);
 /*
   Split path into parts removing '..' in progress
  */
 /*
   Split path into parts removing '..' in progress
  */

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

 
 

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