#pragma interface "confbase.h"
#endif
-// ----------------------------------------------------------------------------
-// compile options
-// ----------------------------------------------------------------------------
+#include "wx/defs.h"
+
+#ifdef wxUSE_CONFIG
-// it won't compile without it anyhow
-#ifndef USE_WXCONFIG
- #error "Please define USE_WXCONFIG or remove config.cpp from your makefile"
-#endif // USE_WXCONFIG
+#include "wx/string.h"
// ----------------------------------------------------------------------------
// constants
#define wxCONFIG_WIN32_NATIVE TRUE
#endif
+// Style flags for constructor style parameter
+#define wxCONFIG_USE_LOCAL_FILE 1
+#define wxCONFIG_USE_GLOBAL_FILE 2
+
// ----------------------------------------------------------------------------
// various helper global functions
// ----------------------------------------------------------------------------
extern void wxSplitPath(wxArrayString& aParts, const char *sz);
// ----------------------------------------------------------------------------
-// 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
// 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).
// ----------------------------------------------------------------------------
-class wxConfigBase
+class WXDLLEXPORT wxConfigBase
{
public:
// static functions
// ctor & virtual dtor
// environment variable expansion is on by default
- wxConfigBase() { m_bExpandEnvVars = TRUE; m_bRecordDefaults = FALSE; }
+// 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 = "", const wxString& vendorName = "",
+ const wxString& localFilename = "", const wxString& globalFilename = "",
+ long style = 0);
+
// empty but ensures that dtor of all derived classes is virtual
virtual ~wxConfigBase() { }
// 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(wxString *pStr, const char *szKey,
- const char *szDefault = NULL) const = 0;
- // another version using statis buffer - it means it will be overwritten
- // after each call to this function!
- virtual const char *Read(const char *szKey,
- const char *szDefault = NULL) const;
- // the same for longs
- virtual long Read(const char *szKey, long lDefault) const
- { long l; Read(&l, szKey, lDefault); return l; }
- // and another version: returns true if default value is returned
- virtual bool Read(long *pl, const char *szKey, long lDefault = 0) const = 0;
+ 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 bool Read(const wxString& key, long *pl) const = 0;
+ virtual 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; }
+
+ // 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;
+
+ // bool
+ virtual bool Read(const wxString& key, bool* val) const;
+ virtual bool Read(const wxString& key, bool* val, bool defVal) const;
// write the value (return true on success)
- virtual bool Write(const char *szKey, const char *szValue) = 0;
- virtual bool Write(const char *szKey, long lValue) = 0;
+ virtual bool Write(const wxString& key, const wxString& value) = 0;
+ virtual bool Write(const wxString& key, long value) = 0;
+
+ // Convenience functions
+ virtual bool Write(const wxString& key, double value);
+ virtual bool Write(const wxString& key, bool value);
+
// permanently writes all changes
virtual bool Flush(bool bCurrentOnly = FALSE) = 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
- virtual bool DeleteEntry(const char *szKey,
+ virtual bool DeleteEntry(const wxString& key,
bool bDeleteGroupIfEmpty = TRUE) = 0;
// delete the group (with all subgroups)
- virtual bool DeleteGroup(const char *szKey) = 0;
+ virtual bool DeleteGroup(const wxString& key) = 0;
// delete the whole underlying object (disk file, registry key, ...)
// primarly for use by desinstallation routine.
virtual bool DeleteAll() = 0;
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
+ inline wxString GetAppName() const { return m_appName; }
+ inline 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; }
protected:
- static bool IsImmutable(const char *szKey)
- { return *szKey == wxCONFIG_IMMUTABLE_PREFIX; }
+ static bool IsImmutable(const wxString& key)
+ #ifndef __WXMAC__
+ { 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;
+
+ // static variables
+ static wxConfigBase *ms_pConfig;
+ static bool ms_bAutoCreate;
+
+ // Application name and organisation name
+ wxString m_appName;
+ wxString m_vendorName;
+
+ // Style flag
+ 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
- class PathChanger
+ // Taken out of wxConfig since not all compilers can cope with nested classes.
+ class wxConfigPathChanger
{
public:
// ctor/dtor do path changing/restorin
- PathChanger(const wxConfigBase *pContainer, const wxString& strEntry);
- ~PathChanger();
+ wxConfigPathChanger(const wxConfigBase *pContainer, const wxString& strEntry);
+ ~wxConfigPathChanger();
// get the key name
const wxString& Name() const { return m_strName; }
bool m_bChanged; // was the path changed?
};
-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;
-};
// ----------------------------------------------------------------------------
// the native wxConfigBase implementation
#if defined(__WXMSW__) && wxCONFIG_WIN32_NATIVE
#ifdef __WIN32__
#define wxConfig wxRegConfig
- #define classwxConfig classwxRegConfig
+ #define sm_classwxConfig sm_classwxRegConfig
#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
- #define classwxConfig classwxFileConfig
+ #define sm_classwxConfig sm_classwxFileConfig
#endif
-#endif // _WX_CONFIG_H_
+#endif
+
+ // wxUSE_CONFIG
+
+#endif
+ // _WX_CONFIG_H_
projects / wxWidgets.git / blobdiff