1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: declaration of the base class of all config implementations
4 // (see also: fileconf.h and msw/regconf.h)
5 // Author: Karsten Ballüder & Vadim Zeitlin
7 // Created: 07.04.98 (adapted from appconf.h)
9 // Copyright: (c) 1997 Karsten Ballüder Ballueder@usa.net
10 // Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
11 // Licence: wxWindows license
12 ///////////////////////////////////////////////////////////////////////////////
14 #ifndef _WX_CONFBASE_H_
15 #define _WX_CONFBASE_H_
18 #pragma interface "confbase.h"
21 // ----------------------------------------------------------------------------
23 // ----------------------------------------------------------------------------
25 // it won't compile without it anyhow
27 #error "Please define USE_WXCONFIG or remove config.cpp from your makefile"
28 #endif // USE_WXCONFIG
30 // ----------------------------------------------------------------------------
32 // ----------------------------------------------------------------------------
34 /// shall we be case sensitive in parsing variable names?
35 #ifndef wxCONFIG_CASE_SENSITIVE
36 #define wxCONFIG_CASE_SENSITIVE FALSE
39 /// separates group and entry names (probably shouldn't be changed)
40 #ifndef wxCONFIG_PATH_SEPARATOR
41 #define wxCONFIG_PATH_SEPARATOR '/'
44 /// introduces immutable entries
45 // (i.e. the ones which can't be changed from the local config file)
46 #ifndef wxCONFIG_IMMUTABLE_PREFIX
47 #define wxCONFIG_IMMUTABLE_PREFIX '!'
50 /// should we use registry instead of configuration files under Win32?
51 // (i.e. whether wxConfigBase::Create() will create a wxFileConfig (if it's
52 // FALSE) or wxRegConfig (if it's true and we're under Win32) or wxIniConfig
54 #ifndef wxCONFIG_WIN32_NATIVE
55 #define wxCONFIG_WIN32_NATIVE TRUE
58 // Style flags for constructor style parameter
59 #define wxCONFIG_USE_LOCAL_FILE 1
60 #define wxCONFIG_USE_GLOBAL_FILE 2
62 // ----------------------------------------------------------------------------
63 // various helper global functions
64 // ----------------------------------------------------------------------------
67 Replace environment variables ($SOMETHING) with their values. The format is
68 $VARNAME or ${VARNAME} where VARNAME contains alphanumeric characters and
69 '_' only. '$' must be escaped ('\$') in order to be taken literally.
71 extern wxString
wxExpandEnvVars(const wxString
&sz
);
74 Split path into parts removing '..' in progress
76 extern void wxSplitPath(wxArrayString
& aParts
, const char *sz
);
78 // ----------------------------------------------------------------------------
79 // abstract base class wxConfigBase which defines the interface for derived
82 // wxConfig organizes the items in a tree-like structure (modeled after the
83 // Unix/Dos filesystem). There are groups (directories) and keys (files).
84 // There is always one current group given by the current path.
86 // Keys are pairs "key_name = value" where value may be of string or integer
87 // (long) type (@@@ doubles and other types such as wxDate coming soon).
88 // ----------------------------------------------------------------------------
93 // sets the config object, returns the previous pointer
94 static wxConfigBase
*Set(wxConfigBase
*pConfig
);
95 // get the config object, creates it on demand unless DontCreateOnDemand
97 static wxConfigBase
*Get() { if ( !ms_pConfig
) Create(); return ms_pConfig
; }
98 // create a new config object: this function will create the "best"
99 // implementation of wxConfig available for the current platform, see
100 // comments near definition wxCONFIG_WIN32_NATIVE for details. It returns
101 // the created object and also sets it as ms_pConfig.
102 static wxConfigBase
*Create();
103 // should Get() try to create a new log object if the current one is NULL?
104 static void DontCreateOnDemand() { ms_bAutoCreate
= FALSE
; }
106 // ctor & virtual dtor
107 // environment variable expansion is on by default
108 // wxConfigBase() { m_bExpandEnvVars = TRUE; m_bRecordDefaults = FALSE; }
112 // Not all args will always be used by derived classes, but
113 // including them all in each class ensures compatibility.
114 // If appName is empty, uses wxApp name
115 wxConfigBase(const wxString
& appName
= wxEmptyString
, const wxString
& vendorName
= wxEmptyString
,
116 const wxString
& localFilename
= wxEmptyString
, const wxString
& globalFilename
= wxEmptyString
,
119 // empty but ensures that dtor of all derived classes is virtual
120 virtual ~wxConfigBase() { }
123 // set current path: if the first character is '/', it's the absolute path,
124 // otherwise it's a relative path. '..' is supported. If the strPath
125 // doesn't exist it is created.
126 virtual void SetPath(const wxString
& strPath
) = 0;
127 // retrieve the current path (always as absolute path)
128 virtual const wxString
& GetPath() const = 0;
130 // enumeration: all functions here return false when there are no more items.
131 // you must pass the same lIndex to GetNext and GetFirst (don't modify it)
132 // enumerate subgroups
133 virtual bool GetFirstGroup(wxString
& str
, long& lIndex
) const = 0;
134 virtual bool GetNextGroup (wxString
& str
, long& lIndex
) const = 0;
136 virtual bool GetFirstEntry(wxString
& str
, long& lIndex
) const = 0;
137 virtual bool GetNextEntry (wxString
& str
, long& lIndex
) const = 0;
138 // get number of entries/subgroups in the current group, with or without
140 virtual size_t GetNumberOfEntries(bool bRecursive
= FALSE
) const = 0;
141 virtual size_t GetNumberOfGroups(bool bRecursive
= FALSE
) const = 0;
143 // tests of existence
144 // returns TRUE if the group by this name exists
145 virtual bool HasGroup(const wxString
& strName
) const = 0;
146 // same as above, but for an entry
147 virtual bool HasEntry(const wxString
& strName
) const = 0;
148 // returns TRUE if either a group or an entry with a given name exist
149 bool Exists(const wxString
& strName
) const
150 { return HasGroup(strName
) || HasEntry(strName
); }
152 // key access: returns TRUE if value was really read, FALSE if default used
153 // (and if the key is not found the default value is returned.)
154 // read a string from the key
155 virtual bool Read(const wxString
& key
, wxString
*pStr
) const = 0;
156 virtual bool Read(const wxString
& key
, wxString
*pStr
, const wxString
& defVal
) const;
158 virtual wxString
Read(const wxString
& key
, const wxString
& defVal
) const;
160 virtual bool Read(const wxString
& key
, long *pl
) const = 0;
161 virtual bool Read(const wxString
& key
, long *pl
, long defVal
) const;
163 virtual long Read(const wxString
& strKey
, long defVal
) const
164 { long l
; Read(strKey
, &l
, defVal
); return l
; }
166 // Convenience functions that are built on other forms
168 virtual bool Read(const wxString
& key
, double* val
) const;
169 virtual bool Read(const wxString
& key
, double* val
, double defVal
) const;
172 virtual bool Read(const wxString
& key
, bool* val
) const;
173 virtual bool Read(const wxString
& key
, bool* val
, bool defVal
) const;
175 // write the value (return true on success)
176 virtual bool Write(const wxString
& key
, const wxString
& value
) = 0;
177 virtual bool Write(const wxString
& key
, long value
) = 0;
179 // Convenience functions
180 virtual bool Write(const wxString
& key
, double value
);
181 virtual bool Write(const wxString
& key
, bool value
);
183 // permanently writes all changes
184 virtual bool Flush(bool bCurrentOnly
= FALSE
) = 0;
186 // delete entries/groups
187 // deletes the specified entry and the group it belongs to if
188 // it was the last key in it and the second parameter is true
189 virtual bool DeleteEntry(const wxString
& key
,
190 bool bDeleteGroupIfEmpty
= TRUE
) = 0;
191 // delete the group (with all subgroups)
192 virtual bool DeleteGroup(const wxString
& key
) = 0;
193 // delete the whole underlying object (disk file, registry key, ...)
194 // primarly for use by desinstallation routine.
195 virtual bool DeleteAll() = 0;
198 // we can automatically expand environment variables in the config entries
199 // (this option is on by default, you can turn it on/off at any time)
200 bool IsExpandingEnvVars() const { return m_bExpandEnvVars
; }
201 void SetExpandEnvVars(bool bDoIt
= TRUE
) { m_bExpandEnvVars
= bDoIt
; }
202 // recording of default values
203 void SetRecordDefaults(bool bDoIt
= TRUE
) { m_bRecordDefaults
= bDoIt
; }
204 bool IsRecordingDefaults() const { return m_bRecordDefaults
; }
205 // does expansion only if needed
206 wxString
ExpandEnvVars(const wxString
& str
) const
208 wxString tmp
; // Required for BC++
209 if (IsExpandingEnvVars())
210 tmp
= wxExpandEnvVars(str
);
217 inline wxString
GetAppName() const { return m_appName
; }
218 inline wxString
GetVendorName() const { return m_vendorName
; }
220 inline void SetAppName(const wxString
& appName
) { m_appName
= appName
; }
221 inline void SetVendorName(const wxString
& vendorName
) { m_vendorName
= vendorName
; }
223 inline void SetStyle(long style
) { m_style
; }
224 inline long GetStyle() const { return m_style
; }
227 static bool IsImmutable(const wxString
& key
)
228 { return key
[0] == wxCONFIG_IMMUTABLE_PREFIX
; }
231 // are we doing automatic environment variable expansion?
232 bool m_bExpandEnvVars
;
233 // do we record default values?
234 bool m_bRecordDefaults
;
237 static wxConfigBase
*ms_pConfig
;
238 static bool ms_bAutoCreate
;
240 // Application name and organisation name
242 wxString m_vendorName
;
248 // a handy little class which changes current path to the path of given entry
249 // and restores it in dtor: so if you declare a local variable of this type,
250 // you work in the entry directory and the path is automatically restored
251 // when the function returns
252 // Taken out of wxConfig since not all compilers can cope with nested classes.
253 class wxConfigPathChanger
256 // ctor/dtor do path changing/restorin
257 wxConfigPathChanger(const wxConfigBase
*pContainer
, const wxString
& strEntry
);
258 ~wxConfigPathChanger();
261 const wxString
& Name() const { return m_strName
; }
264 wxConfigBase
*m_pContainer
; // object we live in
265 wxString m_strName
, // name of entry (i.e. name only)
266 m_strOldPath
; // saved path
267 bool m_bChanged
; // was the path changed?
271 // ----------------------------------------------------------------------------
272 // the native wxConfigBase implementation
273 // ----------------------------------------------------------------------------
275 // under Windows we prefer to use the native implementation
276 #if defined(__WXMSW__) && wxCONFIG_WIN32_NATIVE
278 #define wxConfig wxRegConfig
279 #define classwxConfig classwxRegConfig
281 #define wxConfig wxIniConfig
282 #define classwxConfig classwxIniConfig
284 #else // either we're under Unix or wish to use files even under Windows
285 #define wxConfig wxFileConfig
286 #define classwxConfig classwxFileConfig
291 #endif // _WX_CONFIG_H_