]> git.saurik.com Git - wxWidgets.git/blob - include/wx/confbase.h
Window management and sizer layout corrections
[wxWidgets.git] / include / wx / confbase.h
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: confbase.h
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
6 // Modified by:
7 // Created: 07.04.98 (adapted from appconf.h)
8 // RCS-ID: $Id$
9 // Copyright: (c) 1997 Karsten Ballüder Ballueder@usa.net
10 // Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
11 // Licence: wxWindows license
12 ///////////////////////////////////////////////////////////////////////////////
13
14 #ifndef _WX_CONFBASE_H_
15 #define _WX_CONFBASE_H_
16
17 #ifdef __GNUG__
18 #pragma interface "confbase.h"
19 #endif
20
21 #include "wx/defs.h"
22 #include "wx/string.h"
23
24 // ----------------------------------------------------------------------------
25 // constants
26 // ----------------------------------------------------------------------------
27
28 /// shall we be case sensitive in parsing variable names?
29 #ifndef wxCONFIG_CASE_SENSITIVE
30 #define wxCONFIG_CASE_SENSITIVE FALSE
31 #endif
32
33 /// separates group and entry names (probably shouldn't be changed)
34 #ifndef wxCONFIG_PATH_SEPARATOR
35 #define wxCONFIG_PATH_SEPARATOR _T('/')
36 #endif
37
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('!')
42 #endif
43
44 #if wxUSE_CONFIG
45
46 #include "wx/string.h"
47
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
51 // (under Win16))
52 #ifndef wxUSE_CONFIG_NATIVE
53 #define wxUSE_CONFIG_NATIVE 1
54 #endif
55
56 // Style flags for constructor style parameter
57 enum
58 {
59 wxCONFIG_USE_LOCAL_FILE = 1,
60 wxCONFIG_USE_GLOBAL_FILE = 2,
61 wxCONFIG_USE_RELATIVE_PATH = 4
62 };
63
64 // ----------------------------------------------------------------------------
65 // abstract base class wxConfigBase which defines the interface for derived
66 // classes
67 //
68 // wxConfig organizes the items in a tree-like structure (modeled after the
69 // Unix/Dos filesystem). There are groups (directories) and keys (files).
70 // There is always one current group given by the current path.
71 //
72 // Keys are pairs "key_name = value" where value may be of string or integer
73 // (long) type (TODO doubles and other types such as wxDate coming soon).
74 // ----------------------------------------------------------------------------
75 class WXDLLEXPORT wxConfigBase
76 {
77 public:
78 // constants
79 // the type of an entry
80 enum EntryType
81 {
82 Type_Unknown,
83 Type_String,
84 Type_Boolean,
85 Type_Integer, // use Read(long *)
86 Type_Float // use Read(double *)
87 };
88
89 // static functions
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
93 // was called
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; }
103
104 // ctor & virtual dtor
105 // ctor (can be used as default ctor too)
106 //
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,
109 // uses wxApp name
110 wxConfigBase(const wxString& appName = wxEmptyString,
111 const wxString& vendorName = wxEmptyString,
112 const wxString& localFilename = wxEmptyString,
113 const wxString& globalFilename = wxEmptyString,
114 long style = 0);
115
116 // empty but ensures that dtor of all derived classes is virtual
117 virtual ~wxConfigBase();
118
119 // path management
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;
126
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;
132 // enumerate entries
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
136 // it's subgroups
137 virtual size_t GetNumberOfEntries(bool bRecursive = FALSE) const = 0;
138 virtual size_t GetNumberOfGroups(bool bRecursive = FALSE) const = 0;
139
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); }
148
149 // get the entry type
150 virtual EntryType GetEntryType(const wxString& name) const
151 {
152 // by default all entries are strings
153 return HasEntry(name) ? Type_String : Type_Unknown;
154 }
155
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.)
158
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;
162
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;
166
167 // read an int
168 bool Read(const wxString& key, int *pi) const;
169 bool Read(const wxString& key, int *pi, int defVal) const;
170
171 // read a double
172 bool Read(const wxString& key, double* val) const;
173 bool Read(const wxString& key, double* val, double defVal) const;
174
175 // read a bool
176 bool Read(const wxString& key, bool* val) const;
177 bool Read(const wxString& key, bool* val, bool defVal) const;
178
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; }
184
185 long Read(const wxString& key, long defVal) const
186 { long l; (void)Read(key, &l, defVal); return l; }
187
188 // write the value (return true on success)
189 bool Write(const wxString& key, const wxString& value)
190 { return DoWriteString(key, value); }
191
192 bool Write(const wxString& key, long value)
193 { return DoWriteLong(key, value); }
194
195 bool Write(const wxString& key, int value)
196 { return DoWriteInt(key, value); }
197
198 bool Write(const wxString& key, double value)
199 { return DoWriteDouble(key, value); }
200
201 bool Write(const wxString& key, bool value)
202 { return DoWriteBool(key, value); }
203
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 wxChar *value)
207 { return Write(key, wxString(value)); }
208
209 // permanently writes all changes
210 virtual bool Flush(bool bCurrentOnly = FALSE) = 0;
211
212 // renaming, all functions return FALSE on failure (probably because the new
213 // name is already taken by an existing entry)
214 // rename an entry
215 virtual bool RenameEntry(const wxString& oldName,
216 const wxString& newName) = 0;
217 // rename a group
218 virtual bool RenameGroup(const wxString& oldName,
219 const wxString& newName) = 0;
220
221 // delete entries/groups
222 // deletes the specified entry and the group it belongs to if
223 // it was the last key in it and the second parameter is true
224 virtual bool DeleteEntry(const wxString& key,
225 bool bDeleteGroupIfEmpty = TRUE) = 0;
226 // delete the group (with all subgroups)
227 virtual bool DeleteGroup(const wxString& key) = 0;
228 // delete the whole underlying object (disk file, registry key, ...)
229 // primarly for use by desinstallation routine.
230 virtual bool DeleteAll() = 0;
231
232 // options
233 // we can automatically expand environment variables in the config entries
234 // (this option is on by default, you can turn it on/off at any time)
235 bool IsExpandingEnvVars() const { return m_bExpandEnvVars; }
236 void SetExpandEnvVars(bool bDoIt = TRUE) { m_bExpandEnvVars = bDoIt; }
237 // recording of default values
238 void SetRecordDefaults(bool bDoIt = TRUE) { m_bRecordDefaults = bDoIt; }
239 bool IsRecordingDefaults() const { return m_bRecordDefaults; }
240 // does expansion only if needed
241 wxString ExpandEnvVars(const wxString& str) const;
242
243 // misc accessors
244 wxString GetAppName() const { return m_appName; }
245 wxString GetVendorName() const { return m_vendorName; }
246
247 // Used wxIniConfig to set members in constructor
248 void SetAppName(const wxString& appName) { m_appName = appName; }
249 void SetVendorName(const wxString& vendorName) { m_vendorName = vendorName; }
250
251 void SetStyle(long style) { m_style = style; }
252 long GetStyle() const { return m_style; }
253
254 protected:
255 static bool IsImmutable(const wxString& key)
256 { return !key.IsEmpty() && key[0] == wxCONFIG_IMMUTABLE_PREFIX; }
257
258 // do read/write the values of different types
259 virtual bool DoReadString(const wxString& key, wxString *pStr) const = 0;
260 virtual bool DoReadLong(const wxString& key, long *pl) const = 0;
261 virtual bool DoReadInt(const wxString& key, int *pi) const;
262 virtual bool DoReadDouble(const wxString& key, double* val) const;
263 virtual bool DoReadBool(const wxString& key, bool* val) const;
264
265 virtual bool DoWriteString(const wxString& key, const wxString& value) = 0;
266 virtual bool DoWriteLong(const wxString& key, long value) = 0;
267 virtual bool DoWriteInt(const wxString& key, int value);
268 virtual bool DoWriteDouble(const wxString& key, double value);
269 virtual bool DoWriteBool(const wxString& key, bool value);
270
271 private:
272 // are we doing automatic environment variable expansion?
273 bool m_bExpandEnvVars;
274 // do we record default values?
275 bool m_bRecordDefaults;
276
277 // static variables
278 static wxConfigBase *ms_pConfig;
279 static bool ms_bAutoCreate;
280
281 // Application name and organisation name
282 wxString m_appName;
283 wxString m_vendorName;
284
285 // Style flag
286 long m_style;
287 };
288
289 // a handy little class which changes current path to the path of given entry
290 // and restores it in dtor: so if you declare a local variable of this type,
291 // you work in the entry directory and the path is automatically restored
292 // when the function returns
293 // Taken out of wxConfig since not all compilers can cope with nested classes.
294 class wxConfigPathChanger
295 {
296 public:
297 // ctor/dtor do path changing/restorin
298 wxConfigPathChanger(const wxConfigBase *pContainer, const wxString& strEntry);
299 ~wxConfigPathChanger();
300
301 // get the key name
302 const wxString& Name() const { return m_strName; }
303
304 private:
305 wxConfigBase *m_pContainer; // object we live in
306 wxString m_strName, // name of entry (i.e. name only)
307 m_strOldPath; // saved path
308 bool m_bChanged; // was the path changed?
309 };
310
311
312 // ----------------------------------------------------------------------------
313 // the native wxConfigBase implementation
314 // ----------------------------------------------------------------------------
315
316 // under Windows we prefer to use the native implementation
317 #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
318 #ifdef __WIN32__
319 #define wxConfig wxRegConfig
320 #define sm_classwxConfig sm_classwxRegConfig
321 #else //WIN16
322 #define wxConfig wxIniConfig
323 #define sm_classwxConfig sm_classwxIniConfig
324 #endif
325 #else // either we're under Unix or wish to use files even under Windows
326 #define wxConfig wxFileConfig
327 #define sm_classwxConfig sm_classwxFileConfig
328 #endif
329
330 #endif // wxUSE_CONFIG
331
332 /*
333 Replace environment variables ($SOMETHING) with their values. The format is
334 $VARNAME or ${VARNAME} where VARNAME contains alphanumeric characters and
335 '_' only. '$' must be escaped ('\$') in order to be taken literally.
336 */
337
338 WXDLLEXPORT wxString wxExpandEnvVars(const wxString &sz);
339
340 /*
341 Split path into parts removing '..' in progress
342 */
343 WXDLLEXPORT void wxSplitPath(wxArrayString& aParts, const wxChar *sz);
344
345
346 #endif
347 // _WX_CONFIG_H_
348