#endif
/// should we use registry instead of configuration files under Win32?
-// (i.e. whether wxConfig::Create() will create a wxFileConfig (if it's FALSE) or
-// wxRegConfig (if it's true and we're under Win32) or wxIniConfig (Win16))
+// (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
+// (under Win16))
#ifndef wxCONFIG_WIN32_NATIVE
#define wxCONFIG_WIN32_NATIVE TRUE
#endif
extern void wxSplitPath(wxArrayString& aParts, const char *sz);
// ----------------------------------------------------------------------------
-// abstract base class wxConfig 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
// Unix/Dos filesystem). There are groups (directories) and keys (files).
// 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 wxConfig
+class wxConfigBase
{
public:
// static functions
// sets the config object, returns the previous pointer
- static wxConfig *Set(wxConfig *pConfig);
- // get the config object, creates it on demand
- static wxConfig *Get() { if ( !ms_pConfig ) Create(); return ms_pConfig; }
+ static wxConfigBase *Set(wxConfigBase *pConfig);
+ // get the config object, creates it on demand unless DontCreateOnDemand
+ // was called
+ static wxConfigBase *Get() { if ( !ms_pConfig ) Create(); return ms_pConfig; }
// create a new config object: this function will create the "best"
// implementation of wxConfig available for the current platform, see
// comments near definition wxCONFIG_WIN32_NATIVE for details. It returns
// the created object and also sets it as ms_pConfig.
- static wxConfig *Create();
+ static wxConfigBase *Create();
+ // should Get() try to create a new log object if the current one is NULL?
+ static void DontCreateOnDemand() { ms_bAutoCreate = FALSE; }
// ctor & virtual dtor
// environment variable expansion is on by default
- wxConfig() { m_bExpandEnvVars = TRUE; }
+ wxConfigBase() { m_bExpandEnvVars = TRUE; m_bRecordDefaults = FALSE; }
// empty but ensures that dtor of all derived classes is virtual
- virtual ~wxConfig() { }
+ virtual ~wxConfigBase() { }
// path management
// set current path: if the first character is '/', it's the absolute path,
// enumeration: all functions here return false when there are no more items.
// you must pass the same lIndex to GetNext and GetFirst (don't modify it)
// enumerate subgroups
- virtual bool GetFirstGroup(wxString& str, long& lIndex) = 0;
- virtual bool GetNextGroup (wxString& str, long& lIndex) = 0;
+ virtual bool GetFirstGroup(wxString& str, long& lIndex) const = 0;
+ virtual bool GetNextGroup (wxString& str, long& lIndex) const = 0;
// enumerate entries
- virtual bool GetFirstEntry(wxString& str, long& lIndex) = 0;
- virtual bool GetNextEntry (wxString& str, long& lIndex) = 0;
+ virtual bool GetFirstEntry(wxString& str, long& lIndex) const = 0;
+ virtual bool GetNextEntry (wxString& str, long& lIndex) const = 0;
// get number of entries/subgroups in the current group, with or without
// it's subgroups
virtual uint GetNumberOfEntries(bool bRecursive = FALSE) const = 0;
// (this option is on by default, you can turn it on/off at any time)
bool IsExpandingEnvVars() const { return m_bExpandEnvVars; }
void SetExpandEnvVars(bool bDoIt = TRUE) { m_bExpandEnvVars = bDoIt; }
- // does expansion only if needed
+ // recording of default values
+ 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++
{
public:
// ctor/dtor do path changing/restorin
- PathChanger(const wxConfig *pContainer, const wxString& strEntry);
+ PathChanger(const wxConfigBase *pContainer, const wxString& strEntry);
~PathChanger();
// get the key name
const wxString& Name() const { return m_strName; }
private:
- wxConfig *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?
+ 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?
};
private:
// are we doing automatic environment variable expansion?
bool m_bExpandEnvVars;
-
+ // do we record default values?
+ bool m_bRecordDefaults;
+
// static variables
- static wxConfig *ms_pConfig;
+ static wxConfigBase *ms_pConfig;
+ static bool ms_bAutoCreate;
};
+// ----------------------------------------------------------------------------
+// the native wxConfigBase implementation
+// ----------------------------------------------------------------------------
+
+// under Windows we prefer to use the native implementation
+#if defined(__WXMSW__) && wxCONFIG_WIN32_NATIVE
+ #ifdef __WIN32__
+ #define wxConfig wxRegConfig
+ #else //WIN16
+ #define wxConfig wxIniConfig
+ #endif
+#else // either we're under Unix or wish to use files even under Windows
+ #define wxConfig wxFileConfig
+#endif
+
#endif //_wxCONFIG_H