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 licence
12 ///////////////////////////////////////////////////////////////////////////////
14 #ifndef _WX_CONFBASE_H_
15 #define _WX_CONFBASE_H_
18 #include "wx/string.h"
20 class WXDLLIMPEXP_BASE wxArrayString
;
22 // ----------------------------------------------------------------------------
24 // ----------------------------------------------------------------------------
26 /// shall we be case sensitive in parsing variable names?
27 #ifndef wxCONFIG_CASE_SENSITIVE
28 #define wxCONFIG_CASE_SENSITIVE 0
31 /// separates group and entry names (probably shouldn't be changed)
32 #ifndef wxCONFIG_PATH_SEPARATOR
33 #define wxCONFIG_PATH_SEPARATOR _T('/')
36 /// introduces immutable entries
37 // (i.e. the ones which can't be changed from the local config file)
38 #ifndef wxCONFIG_IMMUTABLE_PREFIX
39 #define wxCONFIG_IMMUTABLE_PREFIX _T('!')
44 #include "wx/string.h"
46 /// should we use registry instead of configuration files under Windows?
47 // (i.e. whether wxConfigBase::Create() will create a wxFileConfig (if it's
48 // false) or wxRegConfig (if it's true and we're under Win32))
49 #ifndef wxUSE_CONFIG_NATIVE
50 #define wxUSE_CONFIG_NATIVE 1
53 // Style flags for constructor style parameter
56 wxCONFIG_USE_LOCAL_FILE
= 1,
57 wxCONFIG_USE_GLOBAL_FILE
= 2,
58 wxCONFIG_USE_RELATIVE_PATH
= 4,
59 wxCONFIG_USE_NO_ESCAPE_CHARACTERS
= 8,
60 wxCONFIG_USE_SUBDIR
= 16
63 // ----------------------------------------------------------------------------
64 // abstract base class wxConfigBase which defines the interface for derived
67 // wxConfig organizes the items in a tree-like structure (modeled after the
68 // Unix/Dos filesystem). There are groups (directories) and keys (files).
69 // There is always one current group given by the current path.
71 // Keys are pairs "key_name = value" where value may be of string or integer
72 // (long) type (TODO doubles and other types such as wxDate coming soon).
73 // ----------------------------------------------------------------------------
75 class WXDLLIMPEXP_BASE wxConfigBase
79 // the type of an entry
85 Type_Integer
, // use Read(long *)
86 Type_Float
// use Read(double *)
90 // sets the config object, returns the previous pointer
91 static wxConfigBase
*Set(wxConfigBase
*pConfig
);
92 // get the config object, creates it on demand unless DontCreateOnDemand
94 static wxConfigBase
*Get(bool createOnDemand
= true)
95 { if ( createOnDemand
&& (!ms_pConfig
) ) Create(); return ms_pConfig
; }
96 // create a new config object: this function will create the "best"
97 // implementation of wxConfig available for the current platform, see
98 // comments near definition wxUSE_CONFIG_NATIVE for details. It returns
99 // the created object and also sets it as ms_pConfig.
100 static wxConfigBase
*Create();
101 // should Get() try to create a new log object if the current one is NULL?
102 static void DontCreateOnDemand() { ms_bAutoCreate
= false; }
104 // ctor & virtual dtor
105 // ctor (can be used as default ctor too)
107 // Not all args will always be used by derived classes, but including
108 // them all in each class ensures compatibility. If appName is empty,
110 wxConfigBase(const wxString
& appName
= wxEmptyString
,
111 const wxString
& vendorName
= wxEmptyString
,
112 const wxString
& localFilename
= wxEmptyString
,
113 const wxString
& globalFilename
= wxEmptyString
,
116 // empty but ensures that dtor of all derived classes is virtual
117 virtual ~wxConfigBase();
120 // set current path: if the first character is '/', it's the absolute path,
121 // otherwise it's a relative path. '..' is supported. If the strPath
122 // doesn't exist it is created.
123 virtual void SetPath(const wxString
& strPath
) = 0;
124 // retrieve the current path (always as absolute path)
125 virtual const wxString
& GetPath() const = 0;
127 // enumeration: all functions here return false when there are no more items.
128 // you must pass the same lIndex to GetNext and GetFirst (don't modify it)
129 // enumerate subgroups
130 virtual bool GetFirstGroup(wxString
& str
, long& lIndex
) const = 0;
131 virtual bool GetNextGroup (wxString
& str
, long& lIndex
) const = 0;
133 virtual bool GetFirstEntry(wxString
& str
, long& lIndex
) const = 0;
134 virtual bool GetNextEntry (wxString
& str
, long& lIndex
) const = 0;
135 // get number of entries/subgroups in the current group, with or without
137 virtual size_t GetNumberOfEntries(bool bRecursive
= false) const = 0;
138 virtual size_t GetNumberOfGroups(bool bRecursive
= false) const = 0;
140 // tests of existence
141 // returns true if the group by this name exists
142 virtual bool HasGroup(const wxString
& strName
) const = 0;
143 // same as above, but for an entry
144 virtual bool HasEntry(const wxString
& strName
) const = 0;
145 // returns true if either a group or an entry with a given name exist
146 bool Exists(const wxString
& strName
) const
147 { return HasGroup(strName
) || HasEntry(strName
); }
149 // get the entry type
150 virtual EntryType
GetEntryType(const wxString
& name
) const
152 // by default all entries are strings
153 return HasEntry(name
) ? Type_String
: Type_Unknown
;
156 // key access: returns true if value was really read, false if default used
157 // (and if the key is not found the default value is returned.)
159 // read a string from the key
160 bool Read(const wxString
& key
, wxString
*pStr
) const;
161 bool Read(const wxString
& key
, wxString
*pStr
, const wxString
& defVal
) const;
163 // read a number (long)
164 bool Read(const wxString
& key
, long *pl
) const;
165 bool Read(const wxString
& key
, long *pl
, long defVal
) const;
168 bool Read(const wxString
& key
, int *pi
) const;
169 bool Read(const wxString
& key
, int *pi
, int defVal
) const;
172 bool Read(const wxString
& key
, double* val
) const;
173 bool Read(const wxString
& key
, double* val
, double defVal
) const;
176 bool Read(const wxString
& key
, bool* val
) const;
177 bool Read(const wxString
& key
, bool* val
, bool defVal
) const;
179 // convenience functions returning directly the value (we don't have them for
180 // int/double/bool as there would be ambiguities with the long one then)
181 wxString
Read(const wxString
& key
,
182 const wxString
& defVal
= wxEmptyString
) const
183 { wxString s
; (void)Read(key
, &s
, defVal
); return s
; }
185 long Read(const wxString
& key
, long defVal
) const
186 { long l
; (void)Read(key
, &l
, defVal
); return l
; }
188 // write the value (return true on success)
189 bool Write(const wxString
& key
, const wxString
& value
)
190 { return DoWriteString(key
, value
); }
192 bool Write(const wxString
& key
, long value
)
193 { return DoWriteLong(key
, value
); }
195 bool Write(const wxString
& key
, int value
)
196 { return DoWriteInt(key
, value
); }
198 bool Write(const wxString
& key
, double value
)
199 { return DoWriteDouble(key
, value
); }
201 bool Write(const wxString
& key
, bool value
)
202 { return DoWriteBool(key
, value
); }
204 // we have to provide a separate version for C strings as otherwise they
205 // would be converted to bool and not to wxString as expected!
206 bool Write(const wxString
& key
, const char *value
)
207 { return Write(key
, wxString(value
)); }
209 bool Write(const wxString
& key
, const wchar_t *value
)
210 { return Write(key
, wxString(value
)); }
213 // permanently writes all changes
214 virtual bool Flush(bool bCurrentOnly
= false) = 0;
216 // renaming, all functions return false on failure (probably because the new
217 // name is already taken by an existing entry)
219 virtual bool RenameEntry(const wxString
& oldName
,
220 const wxString
& newName
) = 0;
222 virtual bool RenameGroup(const wxString
& oldName
,
223 const wxString
& newName
) = 0;
225 // delete entries/groups
226 // deletes the specified entry and the group it belongs to if
227 // it was the last key in it and the second parameter is true
228 virtual bool DeleteEntry(const wxString
& key
,
229 bool bDeleteGroupIfEmpty
= true) = 0;
230 // delete the group (with all subgroups)
231 virtual bool DeleteGroup(const wxString
& key
) = 0;
232 // delete the whole underlying object (disk file, registry key, ...)
233 // primarily for use by uninstallation routine.
234 virtual bool DeleteAll() = 0;
237 // we can automatically expand environment variables in the config entries
238 // (this option is on by default, you can turn it on/off at any time)
239 bool IsExpandingEnvVars() const { return m_bExpandEnvVars
; }
240 void SetExpandEnvVars(bool bDoIt
= true) { m_bExpandEnvVars
= bDoIt
; }
241 // recording of default values
242 void SetRecordDefaults(bool bDoIt
= true) { m_bRecordDefaults
= bDoIt
; }
243 bool IsRecordingDefaults() const { return m_bRecordDefaults
; }
244 // does expansion only if needed
245 wxString
ExpandEnvVars(const wxString
& str
) const;
248 wxString
GetAppName() const { return m_appName
; }
249 wxString
GetVendorName() const { return m_vendorName
; }
251 // Used wxIniConfig to set members in constructor
252 void SetAppName(const wxString
& appName
) { m_appName
= appName
; }
253 void SetVendorName(const wxString
& vendorName
) { m_vendorName
= vendorName
; }
255 void SetStyle(long style
) { m_style
= style
; }
256 long GetStyle() const { return m_style
; }
259 static bool IsImmutable(const wxString
& key
)
260 { return !key
.IsEmpty() && key
[0] == wxCONFIG_IMMUTABLE_PREFIX
; }
262 // return the path without trailing separator, if any: this should be called
263 // to sanitize paths referring to the group names before passing them to
264 // wxConfigPathChanger as "/foo/bar/" should be the same as "/foo/bar" and it
265 // isn't interpreted in the same way by it (and this can't be changed there
266 // as it's not the same for the entries names)
267 static wxString
RemoveTrailingSeparator(const wxString
& key
);
269 // do read/write the values of different types
270 virtual bool DoReadString(const wxString
& key
, wxString
*pStr
) const = 0;
271 virtual bool DoReadLong(const wxString
& key
, long *pl
) const = 0;
272 virtual bool DoReadInt(const wxString
& key
, int *pi
) const;
273 virtual bool DoReadDouble(const wxString
& key
, double* val
) const;
274 virtual bool DoReadBool(const wxString
& key
, bool* val
) const;
276 virtual bool DoWriteString(const wxString
& key
, const wxString
& value
) = 0;
277 virtual bool DoWriteLong(const wxString
& key
, long value
) = 0;
278 virtual bool DoWriteInt(const wxString
& key
, int value
);
279 virtual bool DoWriteDouble(const wxString
& key
, double value
);
280 virtual bool DoWriteBool(const wxString
& key
, bool value
);
283 // are we doing automatic environment variable expansion?
284 bool m_bExpandEnvVars
;
285 // do we record default values?
286 bool m_bRecordDefaults
;
289 static wxConfigBase
*ms_pConfig
;
290 static bool ms_bAutoCreate
;
292 // Application name and organisation name
294 wxString m_vendorName
;
300 // a handy little class which changes current path to the path of given entry
301 // and restores it in dtor: so if you declare a local variable of this type,
302 // you work in the entry directory and the path is automatically restored
303 // when the function returns
304 // Taken out of wxConfig since not all compilers can cope with nested classes.
305 class WXDLLIMPEXP_BASE wxConfigPathChanger
308 // ctor/dtor do path changing/restoring of the path
309 wxConfigPathChanger(const wxConfigBase
*pContainer
, const wxString
& strEntry
);
310 ~wxConfigPathChanger();
313 const wxString
& Name() const { return m_strName
; }
315 // this method must be called if the original path (i.e. the current path at
316 // the moment of creation of this object) could have been deleted to prevent
317 // us from restoring the not existing (any more) path
319 // if the original path doesn't exist any more, the path will be restored to
320 // the deepest still existing component of the old path
321 void UpdateIfDeleted();
324 wxConfigBase
*m_pContainer
; // object we live in
325 wxString m_strName
, // name of entry (i.e. name only)
326 m_strOldPath
; // saved path
327 bool m_bChanged
; // was the path changed?
329 DECLARE_NO_COPY_CLASS(wxConfigPathChanger
)
333 // ----------------------------------------------------------------------------
334 // the native wxConfigBase implementation
335 // ----------------------------------------------------------------------------
337 // under Windows we prefer to use the native implementation
338 // wxIniConfig isn't native anywhere after droping win16 in wxWidgets 2.6
339 #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
340 #define wxConfig wxRegConfig
341 #else // either we're under Unix or wish to use files even under Windows
342 #define wxConfig wxFileConfig
345 #endif // wxUSE_CONFIG
348 Replace environment variables ($SOMETHING) with their values. The format is
349 $VARNAME or ${VARNAME} where VARNAME contains alphanumeric characters and
350 '_' only. '$' must be escaped ('\$') in order to be taken literally.
353 WXDLLIMPEXP_BASE wxString
wxExpandEnvVars(const wxString
&sz
);
356 Split path into parts removing '..' in progress
358 WXDLLIMPEXP_BASE
void wxSplitPath(wxArrayString
& aParts
, const wxChar
*sz
);