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_
17 #if defined(__GNUG__) && !defined(__APPLE__)
18 #pragma interface "confbase.h"
22 #include "wx/string.h"
24 // ----------------------------------------------------------------------------
26 // ----------------------------------------------------------------------------
28 /// shall we be case sensitive in parsing variable names?
29 #ifndef wxCONFIG_CASE_SENSITIVE
30 #define wxCONFIG_CASE_SENSITIVE 0
33 /// separates group and entry names (probably shouldn't be changed)
34 #ifndef wxCONFIG_PATH_SEPARATOR
35 #define wxCONFIG_PATH_SEPARATOR _T('/')
38 /// introduces immutable entries
39 // (i.e. the ones which can't be changed from the local config file)
40 #ifndef wxCONFIG_IMMUTABLE_PREFIX
41 #define wxCONFIG_IMMUTABLE_PREFIX _T('!')
46 #include "wx/string.h"
48 /// should we use registry instead of configuration files under Windows?
49 // (i.e. whether wxConfigBase::Create() will create a wxFileConfig (if it's
50 // FALSE) or wxRegConfig (if it's true and we're under Win32) or wxIniConfig
52 #ifndef wxUSE_CONFIG_NATIVE
53 #define wxUSE_CONFIG_NATIVE 1
56 // Style flags for constructor style parameter
59 wxCONFIG_USE_LOCAL_FILE
= 1,
60 wxCONFIG_USE_GLOBAL_FILE
= 2,
61 wxCONFIG_USE_RELATIVE_PATH
= 4,
62 wxCONFIG_USE_NO_ESCAPE_CHARACTERS
= 8
65 // ----------------------------------------------------------------------------
66 // abstract base class wxConfigBase which defines the interface for derived
69 // wxConfig organizes the items in a tree-like structure (modeled after the
70 // Unix/Dos filesystem). There are groups (directories) and keys (files).
71 // There is always one current group given by the current path.
73 // Keys are pairs "key_name = value" where value may be of string or integer
74 // (long) type (TODO doubles and other types such as wxDate coming soon).
75 // ----------------------------------------------------------------------------
77 class WXDLLEXPORT_BASE wxConfigBase
81 // the type of an entry
87 Type_Integer
, // use Read(long *)
88 Type_Float
// use Read(double *)
92 // sets the config object, returns the previous pointer
93 static wxConfigBase
*Set(wxConfigBase
*pConfig
);
94 // get the config object, creates it on demand unless DontCreateOnDemand
96 static wxConfigBase
*Get(bool createOnDemand
= TRUE
)
97 { if ( createOnDemand
&& (!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 wxUSE_CONFIG_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 // ctor (can be used as default ctor too)
109 // Not all args will always be used by derived classes, but including
110 // them all in each class ensures compatibility. If appName is empty,
112 wxConfigBase(const wxString
& appName
= wxEmptyString
,
113 const wxString
& vendorName
= wxEmptyString
,
114 const wxString
& localFilename
= wxEmptyString
,
115 const wxString
& globalFilename
= wxEmptyString
,
118 // empty but ensures that dtor of all derived classes is virtual
119 virtual ~wxConfigBase();
122 // set current path: if the first character is '/', it's the absolute path,
123 // otherwise it's a relative path. '..' is supported. If the strPath
124 // doesn't exist it is created.
125 virtual void SetPath(const wxString
& strPath
) = 0;
126 // retrieve the current path (always as absolute path)
127 virtual const wxString
& GetPath() const = 0;
129 // enumeration: all functions here return false when there are no more items.
130 // you must pass the same lIndex to GetNext and GetFirst (don't modify it)
131 // enumerate subgroups
132 virtual bool GetFirstGroup(wxString
& str
, long& lIndex
) const = 0;
133 virtual bool GetNextGroup (wxString
& str
, long& lIndex
) const = 0;
135 virtual bool GetFirstEntry(wxString
& str
, long& lIndex
) const = 0;
136 virtual bool GetNextEntry (wxString
& str
, long& lIndex
) const = 0;
137 // get number of entries/subgroups in the current group, with or without
139 virtual size_t GetNumberOfEntries(bool bRecursive
= FALSE
) const = 0;
140 virtual size_t GetNumberOfGroups(bool bRecursive
= FALSE
) const = 0;
142 // tests of existence
143 // returns TRUE if the group by this name exists
144 virtual bool HasGroup(const wxString
& strName
) const = 0;
145 // same as above, but for an entry
146 virtual bool HasEntry(const wxString
& strName
) const = 0;
147 // returns TRUE if either a group or an entry with a given name exist
148 bool Exists(const wxString
& strName
) const
149 { return HasGroup(strName
) || HasEntry(strName
); }
151 // get the entry type
152 virtual EntryType
GetEntryType(const wxString
& name
) const
154 // by default all entries are strings
155 return HasEntry(name
) ? Type_String
: Type_Unknown
;
158 // key access: returns TRUE if value was really read, FALSE if default used
159 // (and if the key is not found the default value is returned.)
161 // read a string from the key
162 bool Read(const wxString
& key
, wxString
*pStr
) const;
163 bool Read(const wxString
& key
, wxString
*pStr
, const wxString
& defVal
) const;
165 // read a number (long)
166 bool Read(const wxString
& key
, long *pl
) const;
167 bool Read(const wxString
& key
, long *pl
, long defVal
) const;
170 bool Read(const wxString
& key
, int *pi
) const;
171 bool Read(const wxString
& key
, int *pi
, int defVal
) const;
174 bool Read(const wxString
& key
, double* val
) const;
175 bool Read(const wxString
& key
, double* val
, double defVal
) const;
178 bool Read(const wxString
& key
, bool* val
) const;
179 bool Read(const wxString
& key
, bool* val
, bool defVal
) const;
181 // convenience functions returning directly the value (we don't have them for
182 // int/double/bool as there would be ambiguities with the long one then)
183 wxString
Read(const wxString
& key
,
184 const wxString
& defVal
= wxEmptyString
) const
185 { wxString s
; (void)Read(key
, &s
, defVal
); return s
; }
187 long Read(const wxString
& key
, long defVal
) const
188 { long l
; (void)Read(key
, &l
, defVal
); return l
; }
190 // write the value (return true on success)
191 bool Write(const wxString
& key
, const wxString
& value
)
192 { return DoWriteString(key
, value
); }
194 bool Write(const wxString
& key
, long value
)
195 { return DoWriteLong(key
, value
); }
197 bool Write(const wxString
& key
, int value
)
198 { return DoWriteInt(key
, value
); }
200 bool Write(const wxString
& key
, double value
)
201 { return DoWriteDouble(key
, value
); }
203 bool Write(const wxString
& key
, bool value
)
204 { return DoWriteBool(key
, value
); }
206 // we have to provide a separate version for C strings as otherwise they
207 // would be converted to bool and not to wxString as expected!
208 bool Write(const wxString
& key
, const wxChar
*value
)
209 { return Write(key
, wxString(value
)); }
211 // permanently writes all changes
212 virtual bool Flush(bool bCurrentOnly
= FALSE
) = 0;
214 // renaming, all functions return FALSE on failure (probably because the new
215 // name is already taken by an existing entry)
217 virtual bool RenameEntry(const wxString
& oldName
,
218 const wxString
& newName
) = 0;
220 virtual bool RenameGroup(const wxString
& oldName
,
221 const wxString
& newName
) = 0;
223 // delete entries/groups
224 // deletes the specified entry and the group it belongs to if
225 // it was the last key in it and the second parameter is true
226 virtual bool DeleteEntry(const wxString
& key
,
227 bool bDeleteGroupIfEmpty
= TRUE
) = 0;
228 // delete the group (with all subgroups)
229 virtual bool DeleteGroup(const wxString
& key
) = 0;
230 // delete the whole underlying object (disk file, registry key, ...)
231 // primarly for use by desinstallation routine.
232 virtual bool DeleteAll() = 0;
235 // we can automatically expand environment variables in the config entries
236 // (this option is on by default, you can turn it on/off at any time)
237 bool IsExpandingEnvVars() const { return m_bExpandEnvVars
; }
238 void SetExpandEnvVars(bool bDoIt
= TRUE
) { m_bExpandEnvVars
= bDoIt
; }
239 // recording of default values
240 void SetRecordDefaults(bool bDoIt
= TRUE
) { m_bRecordDefaults
= bDoIt
; }
241 bool IsRecordingDefaults() const { return m_bRecordDefaults
; }
242 // does expansion only if needed
243 wxString
ExpandEnvVars(const wxString
& str
) const;
246 wxString
GetAppName() const { return m_appName
; }
247 wxString
GetVendorName() const { return m_vendorName
; }
249 // Used wxIniConfig to set members in constructor
250 void SetAppName(const wxString
& appName
) { m_appName
= appName
; }
251 void SetVendorName(const wxString
& vendorName
) { m_vendorName
= vendorName
; }
253 void SetStyle(long style
) { m_style
= style
; }
254 long GetStyle() const { return m_style
; }
257 static bool IsImmutable(const wxString
& key
)
258 { return !key
.IsEmpty() && key
[0] == wxCONFIG_IMMUTABLE_PREFIX
; }
260 // do read/write the values of different types
261 virtual bool DoReadString(const wxString
& key
, wxString
*pStr
) const = 0;
262 virtual bool DoReadLong(const wxString
& key
, long *pl
) const = 0;
263 virtual bool DoReadInt(const wxString
& key
, int *pi
) const;
264 virtual bool DoReadDouble(const wxString
& key
, double* val
) const;
265 virtual bool DoReadBool(const wxString
& key
, bool* val
) const;
267 virtual bool DoWriteString(const wxString
& key
, const wxString
& value
) = 0;
268 virtual bool DoWriteLong(const wxString
& key
, long value
) = 0;
269 virtual bool DoWriteInt(const wxString
& key
, int value
);
270 virtual bool DoWriteDouble(const wxString
& key
, double value
);
271 virtual bool DoWriteBool(const wxString
& key
, bool value
);
274 // are we doing automatic environment variable expansion?
275 bool m_bExpandEnvVars
;
276 // do we record default values?
277 bool m_bRecordDefaults
;
280 static wxConfigBase
*ms_pConfig
;
281 static bool ms_bAutoCreate
;
283 // Application name and organisation name
285 wxString m_vendorName
;
291 // a handy little class which changes current path to the path of given entry
292 // and restores it in dtor: so if you declare a local variable of this type,
293 // you work in the entry directory and the path is automatically restored
294 // when the function returns
295 // Taken out of wxConfig since not all compilers can cope with nested classes.
296 class WXDLLEXPORT_BASE wxConfigPathChanger
299 // ctor/dtor do path changing/restorin
300 wxConfigPathChanger(const wxConfigBase
*pContainer
, const wxString
& strEntry
);
301 ~wxConfigPathChanger();
304 const wxString
& Name() const { return m_strName
; }
307 wxConfigBase
*m_pContainer
; // object we live in
308 wxString m_strName
, // name of entry (i.e. name only)
309 m_strOldPath
; // saved path
310 bool m_bChanged
; // was the path changed?
312 DECLARE_NO_COPY_CLASS(wxConfigPathChanger
)
316 // ----------------------------------------------------------------------------
317 // the native wxConfigBase implementation
318 // ----------------------------------------------------------------------------
320 // under Windows we prefer to use the native implementation
321 #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
323 #define wxConfig wxRegConfig
324 #define sm_classwxConfig sm_classwxRegConfig
326 #define wxConfig wxIniConfig
327 #define sm_classwxConfig sm_classwxIniConfig
329 #else // either we're under Unix or wish to use files even under Windows
330 #define wxConfig wxFileConfig
331 #define sm_classwxConfig sm_classwxFileConfig
334 #endif // wxUSE_CONFIG
337 Replace environment variables ($SOMETHING) with their values. The format is
338 $VARNAME or ${VARNAME} where VARNAME contains alphanumeric characters and
339 '_' only. '$' must be escaped ('\$') in order to be taken literally.
342 WXDLLEXPORT_BASE wxString
wxExpandEnvVars(const wxString
&sz
);
345 Split path into parts removing '..' in progress
347 WXDLLEXPORT_BASE
void wxSplitPath(wxArrayString
& aParts
, const wxChar
*sz
);