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
58 wxCONFIG_USE_LOCAL_FILE
= 1,
59 wxCONFIG_USE_GLOBAL_FILE
= 2,
60 wxCONFIG_USE_RELATIVE_PATH
= 4
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 // ----------------------------------------------------------------------------
74 class WXDLLEXPORT wxConfigBase
78 // the type of an entry
84 Type_Integer
, // use Read(long *)
85 Type_Float
// use Read(double *)
89 // sets the config object, returns the previous pointer
90 static wxConfigBase
*Set(wxConfigBase
*pConfig
);
91 // get the config object, creates it on demand unless DontCreateOnDemand
93 static wxConfigBase
*Get() { if ( !ms_pConfig
) Create(); return ms_pConfig
; }
94 // create a new config object: this function will create the "best"
95 // implementation of wxConfig available for the current platform, see
96 // comments near definition wxCONFIG_WIN32_NATIVE for details. It returns
97 // the created object and also sets it as ms_pConfig.
98 static wxConfigBase
*Create();
99 // should Get() try to create a new log object if the current one is NULL?
100 static void DontCreateOnDemand() { ms_bAutoCreate
= FALSE
; }
102 // ctor & virtual dtor
103 // ctor (can be used as default ctor too)
105 // Not all args will always be used by derived classes, but including
106 // them all in each class ensures compatibility. If appName is empty,
108 wxConfigBase(const wxString
& appName
= wxEmptyString
,
109 const wxString
& vendorName
= wxEmptyString
,
110 const wxString
& localFilename
= wxEmptyString
,
111 const wxString
& globalFilename
= wxEmptyString
,
114 // empty but ensures that dtor of all derived classes is virtual
115 virtual ~wxConfigBase() { }
118 // set current path: if the first character is '/', it's the absolute path,
119 // otherwise it's a relative path. '..' is supported. If the strPath
120 // doesn't exist it is created.
121 virtual void SetPath(const wxString
& strPath
) = 0;
122 // retrieve the current path (always as absolute path)
123 virtual const wxString
& GetPath() const = 0;
125 // enumeration: all functions here return false when there are no more items.
126 // you must pass the same lIndex to GetNext and GetFirst (don't modify it)
127 // enumerate subgroups
128 virtual bool GetFirstGroup(wxString
& str
, long& lIndex
) const = 0;
129 virtual bool GetNextGroup (wxString
& str
, long& lIndex
) const = 0;
131 virtual bool GetFirstEntry(wxString
& str
, long& lIndex
) const = 0;
132 virtual bool GetNextEntry (wxString
& str
, long& lIndex
) const = 0;
133 // get number of entries/subgroups in the current group, with or without
135 virtual size_t GetNumberOfEntries(bool bRecursive
= FALSE
) const = 0;
136 virtual size_t GetNumberOfGroups(bool bRecursive
= FALSE
) const = 0;
138 // tests of existence
139 // returns TRUE if the group by this name exists
140 virtual bool HasGroup(const wxString
& strName
) const = 0;
141 // same as above, but for an entry
142 virtual bool HasEntry(const wxString
& strName
) const = 0;
143 // returns TRUE if either a group or an entry with a given name exist
144 bool Exists(const wxString
& strName
) const
145 { return HasGroup(strName
) || HasEntry(strName
); }
147 // get the entry type
148 virtual EntryType
GetEntryType(const wxString
& name
) const
150 // by default all entries are strings
151 return HasEntry(name
) ? Type_String
: Type_Unknown
;
154 // key access: returns TRUE if value was really read, FALSE if default used
155 // (and if the key is not found the default value is returned.)
156 // read a string from the key
157 virtual bool Read(const wxString
& key
, wxString
*pStr
) const = 0;
158 virtual bool Read(const wxString
& key
, wxString
*pStr
, const wxString
& defVal
) const;
160 virtual wxString
Read(const wxString
& key
, const wxString
& defVal
= wxEmptyString
) const;
162 virtual bool Read(const wxString
& key
, long *pl
) const = 0;
163 virtual bool Read(const wxString
& key
, long *pl
, long defVal
) const;
165 virtual long Read(const wxString
& strKey
, long defVal
) const
166 { long l
; Read(strKey
, &l
, defVal
); return l
; }
168 // Convenience functions that are built on other forms
171 virtual bool Read(const wxString
& key
, int *pi
) const;
172 virtual bool Read(const wxString
& key
, int *pi
, int defVal
) const;
175 virtual bool Read(const wxString
& key
, double* val
) const;
176 virtual bool Read(const wxString
& key
, double* val
, double defVal
) const;
179 virtual bool Read(const wxString
& key
, bool* val
) const;
180 virtual bool Read(const wxString
& key
, bool* val
, bool defVal
) const;
182 // write the value (return true on success)
183 virtual bool Write(const wxString
& key
, const wxString
& value
) = 0;
184 virtual bool Write(const wxString
& key
, long value
) = 0;
186 // Convenience functions
187 virtual bool Write(const wxString
& key
, double value
);
188 virtual bool Write(const wxString
& key
, bool value
);
190 // permanently writes all changes
191 virtual bool Flush(bool bCurrentOnly
= FALSE
) = 0;
193 // renaming, all functions return FALSE on failure (probably because the new
194 // name is already taken by an existing entry)
196 virtual bool RenameEntry(const wxString
& oldName
,
197 const wxString
& newName
) = 0;
199 virtual bool RenameGroup(const wxString
& oldName
,
200 const wxString
& newName
) = 0;
202 // delete entries/groups
203 // deletes the specified entry and the group it belongs to if
204 // it was the last key in it and the second parameter is true
205 virtual bool DeleteEntry(const wxString
& key
,
206 bool bDeleteGroupIfEmpty
= TRUE
) = 0;
207 // delete the group (with all subgroups)
208 virtual bool DeleteGroup(const wxString
& key
) = 0;
209 // delete the whole underlying object (disk file, registry key, ...)
210 // primarly for use by desinstallation routine.
211 virtual bool DeleteAll() = 0;
214 // we can automatically expand environment variables in the config entries
215 // (this option is on by default, you can turn it on/off at any time)
216 bool IsExpandingEnvVars() const { return m_bExpandEnvVars
; }
217 void SetExpandEnvVars(bool bDoIt
= TRUE
) { m_bExpandEnvVars
= bDoIt
; }
218 // recording of default values
219 void SetRecordDefaults(bool bDoIt
= TRUE
) { m_bRecordDefaults
= bDoIt
; }
220 bool IsRecordingDefaults() const { return m_bRecordDefaults
; }
221 // does expansion only if needed
222 wxString
ExpandEnvVars(const wxString
& str
) const;
225 wxString
GetAppName() const { return m_appName
; }
226 wxString
GetVendorName() const { return m_vendorName
; }
228 void SetStyle(long style
) { m_style
= style
; }
229 long GetStyle() const { return m_style
; }
232 static bool IsImmutable(const wxString
& key
)
233 #if !defined(__WXMAC__) && !defined(__EMX__)
234 { return !key
.IsEmpty() && key
[0u] == wxCONFIG_IMMUTABLE_PREFIX
; }
236 { return !key
.IsEmpty() && key
[0ul] == wxCONFIG_IMMUTABLE_PREFIX
; }
240 // are we doing automatic environment variable expansion?
241 bool m_bExpandEnvVars
;
242 // do we record default values?
243 bool m_bRecordDefaults
;
246 static wxConfigBase
*ms_pConfig
;
247 static bool ms_bAutoCreate
;
249 // Application name and organisation name
251 wxString m_vendorName
;
257 // a handy little class which changes current path to the path of given entry
258 // and restores it in dtor: so if you declare a local variable of this type,
259 // you work in the entry directory and the path is automatically restored
260 // when the function returns
261 // Taken out of wxConfig since not all compilers can cope with nested classes.
262 class wxConfigPathChanger
265 // ctor/dtor do path changing/restorin
266 wxConfigPathChanger(const wxConfigBase
*pContainer
, const wxString
& strEntry
);
267 ~wxConfigPathChanger();
270 const wxString
& Name() const { return m_strName
; }
273 wxConfigBase
*m_pContainer
; // object we live in
274 wxString m_strName
, // name of entry (i.e. name only)
275 m_strOldPath
; // saved path
276 bool m_bChanged
; // was the path changed?
280 // ----------------------------------------------------------------------------
281 // the native wxConfigBase implementation
282 // ----------------------------------------------------------------------------
284 // under Windows we prefer to use the native implementation
285 #if defined(__WXMSW__) && wxCONFIG_WIN32_NATIVE
287 #define wxConfig wxRegConfig
288 #define sm_classwxConfig sm_classwxRegConfig
290 #define wxConfig wxIniConfig
291 #define sm_classwxConfig sm_classwxIniConfig
293 #else // either we're under Unix or wish to use files even under Windows
294 #define wxConfig wxFileConfig
295 #define sm_classwxConfig sm_classwxFileConfig
298 #endif // wxUSE_CONFIG
300 // ----------------------------------------------------------------------------
301 // various helper global functions (defined even if !wxUSE_CONFIG)
302 // ----------------------------------------------------------------------------
305 Replace environment variables ($SOMETHING) with their values. The format is
306 $VARNAME or ${VARNAME} where VARNAME contains alphanumeric characters and
307 '_' only. '$' must be escaped ('\$') in order to be taken literally.
309 extern wxString
wxExpandEnvVars(const wxString
&sz
);
312 Split path into parts removing '..' in progress
314 extern void wxSplitPath(wxArrayString
& aParts
, const wxChar
*sz
);