1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: declaration of the base class of all config implementations
4 // (see also: fileconf.h and msw/regconf.h and iniconf.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"
25 #include "wx/string.h"
27 // ----------------------------------------------------------------------------
29 // ----------------------------------------------------------------------------
31 /// shall we be case sensitive in parsing variable names?
32 #ifndef wxCONFIG_CASE_SENSITIVE
33 #define wxCONFIG_CASE_SENSITIVE FALSE
36 /// separates group and entry names (probably shouldn't be changed)
37 #ifndef wxCONFIG_PATH_SEPARATOR
38 #define wxCONFIG_PATH_SEPARATOR '/'
41 /// introduces immutable entries
42 // (i.e. the ones which can't be changed from the local config file)
43 #ifndef wxCONFIG_IMMUTABLE_PREFIX
44 #define wxCONFIG_IMMUTABLE_PREFIX '!'
47 /// should we use registry instead of configuration files under Win32?
48 // (i.e. whether wxConfigBase::Create() will create a wxFileConfig (if it's
49 // FALSE) or wxRegConfig (if it's true and we're under Win32) or wxIniConfig
51 #ifndef wxCONFIG_WIN32_NATIVE
52 #define wxCONFIG_WIN32_NATIVE TRUE
55 // Style flags for constructor style parameter
56 #define wxCONFIG_USE_LOCAL_FILE 1
57 #define wxCONFIG_USE_GLOBAL_FILE 2
59 // ----------------------------------------------------------------------------
60 // various helper global functions
61 // ----------------------------------------------------------------------------
64 Replace environment variables ($SOMETHING) with their values. The format is
65 $VARNAME or ${VARNAME} where VARNAME contains alphanumeric characters and
66 '_' only. '$' must be escaped ('\$') in order to be taken literally.
68 extern wxString
wxExpandEnvVars(const wxString
&sz
);
71 Split path into parts removing '..' in progress
73 extern void wxSplitPath(wxArrayString
& aParts
, const char *sz
);
75 // ----------------------------------------------------------------------------
76 // abstract base class wxConfigBase which defines the interface for derived
79 // wxConfig organizes the items in a tree-like structure (modeled after the
80 // Unix/Dos filesystem). There are groups (directories) and keys (files).
81 // There is always one current group given by the current path.
83 // Keys are pairs "key_name = value" where value may be of string or integer
84 // (long) type (@@@ doubles and other types such as wxDate coming soon).
85 // ----------------------------------------------------------------------------
86 class WXDLLEXPORT wxConfigBase
90 // the type of an entry
96 Type_Integer
, // use Read(long *)
97 Type_Float
// use Read(double *)
101 // sets the config object, returns the previous pointer
102 static wxConfigBase
*Set(wxConfigBase
*pConfig
);
103 // get the config object, creates it on demand unless DontCreateOnDemand
105 static wxConfigBase
*Get() { if ( !ms_pConfig
) Create(); return ms_pConfig
; }
106 // create a new config object: this function will create the "best"
107 // implementation of wxConfig available for the current platform, see
108 // comments near definition wxCONFIG_WIN32_NATIVE for details. It returns
109 // the created object and also sets it as ms_pConfig.
110 static wxConfigBase
*Create();
111 // should Get() try to create a new log object if the current one is NULL?
112 static void DontCreateOnDemand() { ms_bAutoCreate
= FALSE
; }
114 // ctors & virtual dtor
115 // Not all args will always be used by derived classes, but including
116 // them all in each class ensures compatibility. If appName is empty,
118 wxConfigBase(const wxString
& appName
= wxEmptyString
,
119 const wxString
& vendorName
= wxEmptyString
,
120 const wxString
& localFilename
= wxEmptyString
,
121 const wxString
& globalFilename
= wxEmptyString
,
124 // empty but ensures that dtor of all derived classes is virtual
125 virtual ~wxConfigBase() { }
128 // set current path: if the first character is '/', it's the absolute path,
129 // otherwise it's a relative path. '..' is supported. If the strPath
130 // doesn't exist it is created.
131 virtual void SetPath(const wxString
& strPath
) = 0;
132 // retrieve the current path (always as absolute path)
133 virtual const wxString
& GetPath() const = 0;
135 // enumeration: all functions here return false when there are no more items.
136 // you must pass the same lIndex to GetNext and GetFirst (don't modify it)
137 // enumerate subgroups
138 virtual bool GetFirstGroup(wxString
& str
, long& lIndex
) const = 0;
139 virtual bool GetNextGroup (wxString
& str
, long& lIndex
) const = 0;
141 virtual bool GetFirstEntry(wxString
& str
, long& lIndex
) const = 0;
142 virtual bool GetNextEntry (wxString
& str
, long& lIndex
) const = 0;
143 // get number of entries/subgroups in the current group, with or without
145 virtual size_t GetNumberOfEntries(bool bRecursive
= FALSE
) const = 0;
146 virtual size_t GetNumberOfGroups(bool bRecursive
= FALSE
) const = 0;
148 // tests of existence
149 // returns TRUE if the group by this name exists
150 virtual bool HasGroup(const wxString
& strName
) const = 0;
151 // same as above, but for an entry
152 virtual bool HasEntry(const wxString
& strName
) const = 0;
153 // returns TRUE if either a group or an entry with a given name exist
154 bool Exists(const wxString
& strName
) const
155 { return HasGroup(strName
) || HasEntry(strName
); }
157 // get the entry type
158 virtual EntryType
GetEntryType(const wxString
& name
) const
160 // by default all entries are strings
161 return HasEntry(name
) ? Type_String
: Type_Unknown
;
164 // key access: returns TRUE if value was really read, FALSE if default used
165 // (and if the key is not found the default value is returned.)
166 // read a string from the key
167 virtual bool Read(const wxString
& key
, wxString
*pStr
) const = 0;
168 virtual bool Read(const wxString
& key
, wxString
*pStr
, const wxString
& defVal
) const;
170 virtual wxString
Read(const wxString
& key
, const wxString
& defVal
= wxEmptyString
) const;
172 virtual bool Read(const wxString
& key
, long *pl
) const = 0;
173 virtual bool Read(const wxString
& key
, long *pl
, long defVal
) const;
175 virtual long Read(const wxString
& strKey
, long defVal
) const
176 { long l
; Read(strKey
, &l
, defVal
); return l
; }
178 // Convenience functions that are built on other forms
181 virtual bool Read(const wxString
& key
, int *pi
) const;
182 virtual bool Read(const wxString
& key
, int *pi
, int defVal
) const;
185 virtual bool Read(const wxString
& key
, double* val
) const;
186 virtual bool Read(const wxString
& key
, double* val
, double defVal
) const;
189 virtual bool Read(const wxString
& key
, bool* val
) const;
190 virtual bool Read(const wxString
& key
, bool* val
, bool defVal
) const;
192 // write the value (return true on success)
193 virtual bool Write(const wxString
& key
, const wxString
& value
) = 0;
194 virtual bool Write(const wxString
& key
, long value
) = 0;
196 // Convenience functions
197 virtual bool Write(const wxString
& key
, double value
);
198 virtual bool Write(const wxString
& key
, bool value
);
200 // permanently writes all changes
201 virtual bool Flush(bool bCurrentOnly
= FALSE
) = 0;
203 // renaming, all functions return FALSE on failure (probably because the new
204 // name is already taken by an existing entry)
206 virtual bool RenameEntry(const wxString
& oldName
,
207 const wxString
& newName
) = 0;
209 virtual bool RenameGroup(const wxString
& oldName
,
210 const wxString
& newName
) = 0;
212 // delete entries/groups
213 // deletes the specified entry and the group it belongs to if
214 // it was the last key in it and the second parameter is true
215 virtual bool DeleteEntry(const wxString
& key
,
216 bool bDeleteGroupIfEmpty
= TRUE
) = 0;
217 // delete the group (with all subgroups)
218 virtual bool DeleteGroup(const wxString
& key
) = 0;
219 // delete the whole underlying object (disk file, registry key, ...)
220 // primarly for use by desinstallation routine.
221 virtual bool DeleteAll() = 0;
224 // we can automatically expand environment variables in the config entries
225 // (this option is on by default, you can turn it on/off at any time)
226 bool IsExpandingEnvVars() const { return m_bExpandEnvVars
; }
227 void SetExpandEnvVars(bool bDoIt
= TRUE
) { m_bExpandEnvVars
= bDoIt
; }
228 // recording of default values
229 void SetRecordDefaults(bool bDoIt
= TRUE
) { m_bRecordDefaults
= bDoIt
; }
230 bool IsRecordingDefaults() const { return m_bRecordDefaults
; }
231 // does expansion only if needed
232 wxString
ExpandEnvVars(const wxString
& str
) const;
235 wxString
GetAppName() const { return m_appName
; }
236 wxString
GetVendorName() const { return m_vendorName
; }
238 virtual void SetAppName(const wxString
& appName
)
239 { m_appName
= appName
; }
240 virtual void SetVendorName(const wxString
& vendorName
)
241 { m_vendorName
= vendorName
; }
243 void SetStyle(long style
) { m_style
= style
; }
244 long GetStyle() const { return m_style
; }
247 static bool IsImmutable(const wxString
& key
)
249 { return !key
.IsEmpty() && key
[0u] == wxCONFIG_IMMUTABLE_PREFIX
; }
251 { return !key
.IsEmpty() && key
[0ul] == wxCONFIG_IMMUTABLE_PREFIX
; }
255 // are we doing automatic environment variable expansion?
256 bool m_bExpandEnvVars
;
257 // do we record default values?
258 bool m_bRecordDefaults
;
261 static wxConfigBase
*ms_pConfig
;
262 static bool ms_bAutoCreate
;
264 // Application name and organisation name
266 wxString m_vendorName
;
272 // a handy little class which changes current path to the path of given entry
273 // and restores it in dtor: so if you declare a local variable of this type,
274 // you work in the entry directory and the path is automatically restored
275 // when the function returns
276 // Taken out of wxConfig since not all compilers can cope with nested classes.
277 class wxConfigPathChanger
280 // ctor/dtor do path changing/restorin
281 wxConfigPathChanger(const wxConfigBase
*pContainer
, const wxString
& strEntry
);
282 ~wxConfigPathChanger();
285 const wxString
& Name() const { return m_strName
; }
288 wxConfigBase
*m_pContainer
; // object we live in
289 wxString m_strName
, // name of entry (i.e. name only)
290 m_strOldPath
; // saved path
291 bool m_bChanged
; // was the path changed?
295 // ----------------------------------------------------------------------------
296 // the native wxConfigBase implementation
297 // ----------------------------------------------------------------------------
299 // under Windows we prefer to use the native implementation
300 #if defined(__WXMSW__) && wxCONFIG_WIN32_NATIVE
302 #define wxConfig wxRegConfig
303 #define sm_classwxConfig sm_classwxRegConfig
305 #define wxConfig wxIniConfig
306 #define sm_classwxConfig sm_classwxIniConfig
308 #else // either we're under Unix or wish to use files even under Windows
309 #define wxConfig wxFileConfig
310 #define sm_classwxConfig sm_classwxFileConfig