]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/confbase.h
Fixed typo in my last commit (it did break socket detection code :-( ).
[wxWidgets.git] / include / wx / confbase.h
index 4b06078b0ebb0482eed9684dbed6b337b804f65d..fbd1e57a132cd6c4ccbaa960ca0880ac7af98b6b 100644 (file)
@@ -19,9 +19,6 @@
 #endif
 
 #include "wx/defs.h"
-
-#if wxUSE_CONFIG
-
 #include "wx/string.h"
 
 // ----------------------------------------------------------------------------
   #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
 //  FALSE) or wxRegConfig (if it's true and we're under Win32) or wxIniConfig
@@ -154,43 +155,56 @@ public:
 
   // 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 = wxEmptyString) const;
+    // read a string from the key
+  bool Read(const wxString& key, wxString *pStr) const;
+  bool Read(const wxString& key, wxString *pStr, const wxString& defVal) const;
 
-  virtual bool Read(const wxString& key, long *pl) const = 0;
-  virtual bool Read(const wxString& key, long *pl, long defVal) const;
+    // read a number (long)
+  bool Read(const wxString& key, long *pl) const;
+  bool Read(const wxString& key, long *pl, long defVal) const;
 
-  virtual long Read(const wxString& strKey, long defVal) const
-    { long l; Read(strKey, &l, defVal); return l; }
+    // read an int
+  bool Read(const wxString& key, int *pi) const;
+  bool Read(const wxString& key, int *pi, int defVal) const;
 
-  // Convenience functions that are built on other forms
+    // read a double
+  bool Read(const wxString& key, double* val) const;
+  bool Read(const wxString& key, double* val, double defVal) const;
 
-  // int
-  virtual bool Read(const wxString& key, int *pi) const;
-  virtual bool Read(const wxString& key, int *pi, int defVal) const;
+    // read a bool
+  bool Read(const wxString& key, bool* val) const;
+  bool Read(const wxString& key, bool* val, bool defVal) const;
 
-  // double
-  virtual bool Read(const wxString& key, double* val) const;
-  virtual bool Read(const wxString& key, double* val, double 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)
+  wxString Read(const wxString& key,
+                const wxString& defVal = wxEmptyString) const
+    { wxString s; (void)Read(key, &s, defVal); return s; }
 
-  // bool
-  virtual bool Read(const wxString& key, bool* val) const;
-  virtual bool Read(const wxString& key, bool* val, bool defVal) const;
+  long Read(const wxString& key, long defVal) const
+    { long l; (void)Read(key, &l, defVal); return l; }
 
     // 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, 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); }
 
-  // convenience functions
-  virtual bool Write(const wxString& key, double value);
-  virtual bool Write(const wxString& key, bool value);
+  bool Write(const wxString& key, double value)
+    { return DoWriteDouble(key, value); }
+
+  bool Write(const wxString& key, bool value)
+    { return DoWriteBool(key, value); }
 
   // 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 wxChar *value)
+    { return Write(key, wxString(value)); }
 
   // permanently writes all changes
   virtual bool Flush(bool bCurrentOnly = FALSE) = 0;
@@ -241,6 +255,19 @@ protected:
   static bool IsImmutable(const wxString& key)
     { return !key.IsEmpty() && key[0] == wxCONFIG_IMMUTABLE_PREFIX; }
 
+  // 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 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);
+
 private:
   // are we doing automatic environment variable expansion?
   bool m_bExpandEnvVars;
@@ -259,27 +286,27 @@ private:
   long              m_style;
 };
 
-  // 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 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?
+};
 
 
 // ----------------------------------------------------------------------------
@@ -302,21 +329,19 @@ private:
 
 #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.
- */
-extern WXDLLEXPORT wxString wxExpandEnvVars(const wxString &sz);
+*/
+
+WXDLLEXPORT wxString wxExpandEnvVars(const wxString &sz);
 
 /*
   Split path into parts removing '..' in progress
  */
-extern WXDLLEXPORT void wxSplitPath(wxArrayString& aParts, const wxChar *sz);
+WXDLLEXPORT void wxSplitPath(wxArrayString& aParts, const wxChar *sz);
+
 
 #endif
   // _WX_CONFIG_H_