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 licence
  12 ///////////////////////////////////////////////////////////////////////////////
  13
  14 #ifndef _WX_CONFBASE_H_
  15 #define _WX_CONFBASE_H_
  16
  17 #include "wx/defs.h"
  18 #include "wx/string.h"
  19 #include "wx/object.h"
  20 #include "wx/base64.h"
  21
  22 class WXDLLIMPEXP_FWD_BASE wxArrayString;
  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       0
  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))
  51 #ifndef   wxUSE_CONFIG_NATIVE
  52   #define wxUSE_CONFIG_NATIVE 1
  53 #endif
  54
  55 // Style flags for constructor style parameter
  56 enum
  57 {
  58     wxCONFIG_USE_LOCAL_FILE = 1,
  59     wxCONFIG_USE_GLOBAL_FILE = 2,
  60     wxCONFIG_USE_RELATIVE_PATH = 4,
  61     wxCONFIG_USE_NO_ESCAPE_CHARACTERS = 8,
  62     wxCONFIG_USE_SUBDIR = 16
  63 };
  64
  65 // ----------------------------------------------------------------------------
  66 // abstract base class wxConfigBase which defines the interface for derived
  67 // classes
  68 //
  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.
  72 //
  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 // ----------------------------------------------------------------------------
  76
  77 class WXDLLIMPEXP_BASE wxConfigBase : public wxObject
  78 {
  79 public:
  80   // constants
  81     // the type of an entry
  82   enum EntryType
  83   {
  84     Type_Unknown,
  85     Type_String,
  86     Type_Boolean,
  87     Type_Integer,    // use Read(long *)
  88     Type_Float       // use Read(double *)
  89   };
  90
  91   // static functions
  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
  95     // was called
  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; }
 105
 106   // ctor & virtual dtor
 107       // ctor (can be used as default ctor too)
 108       //
 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,
 111       // uses wxApp name
 112   wxConfigBase(const wxString& appName = wxEmptyString,
 113                const wxString& vendorName = wxEmptyString,
 114                const wxString& localFilename = wxEmptyString,
 115                const wxString& globalFilename = wxEmptyString,
 116                long style = 0);
 117
 118     // empty but ensures that dtor of all derived classes is virtual
 119   virtual ~wxConfigBase();
 120
 121   // path management
 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;
 128
 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;
 134     // enumerate entries
 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
 138     // it's subgroups
 139   virtual size_t GetNumberOfEntries(bool bRecursive = false) const = 0;
 140   virtual size_t GetNumberOfGroups(bool bRecursive = false) const = 0;
 141
 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); }
 150
 151     // get the entry type
 152   virtual EntryType GetEntryType(const wxString& name) const
 153   {
 154     // by default all entries are strings
 155     return HasEntry(name) ? Type_String : Type_Unknown;
 156   }
 157
 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.)
 160
 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;
 164
 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;
 168
 169     // read an int
 170   bool Read(const wxString& key, int *pi) const;
 171   bool Read(const wxString& key, int *pi, int defVal) const;
 172
 173     // read a double
 174   bool Read(const wxString& key, double* val) const;
 175   bool Read(const wxString& key, double* val, double defVal) const;
 176
 177     // read a bool
 178   bool Read(const wxString& key, bool* val) const;
 179   bool Read(const wxString& key, bool* val, bool defVal) const;
 180
 181 #if wxUSE_BASE64
 182     // read a binary data block
 183   bool Read(const wxString& key, wxMemoryBuffer* data) const
 184     { return DoReadBinary(key, data); }
 185    // no default version since it does not make sense for binary data
 186 #endif // wxUSE_BASE64
 187
 188   // convenience functions returning directly the value (we don't have them for
 189   // int/double/bool as there would be ambiguities with the long one then)
 190   wxString Read(const wxString& key,
 191                 const wxString& defVal = wxEmptyString) const
 192     { wxString s; (void)Read(key, &s, defVal); return s; }
 193
 194   long Read(const wxString& key, long defVal) const
 195     { long l; (void)Read(key, &l, defVal); return l; }
 196
 197     // write the value (return true on success)
 198   bool Write(const wxString& key, const wxString& value)
 199     { return DoWriteString(key, value); }
 200
 201   bool Write(const wxString& key, long value)
 202     { return DoWriteLong(key, value); }
 203
 204   bool Write(const wxString& key, int value)
 205     { return DoWriteInt(key, value); }
 206
 207   bool Write(const wxString& key, double value)
 208     { return DoWriteDouble(key, value); }
 209
 210   bool Write(const wxString& key, bool value)
 211     { return DoWriteBool(key, value); }
 212
 213 #if wxUSE_BASE64
 214   bool Write(const wxString& key, const wxMemoryBuffer& buf)
 215     { return DoWriteBinary(key, buf); }
 216 #endif // wxUSE_BASE64
 217
 218   // we have to provide a separate version for C strings as otherwise they
 219   // would be converted to bool and not to wxString as expected!
 220   bool Write(const wxString& key, const char *value)
 221     { return Write(key, wxString(value)); }
 222 #if wxUSE_WCHAR_T
 223   bool Write(const wxString& key, const wchar_t *value)
 224     { return Write(key, wxString(value)); }
 225 #endif
 226
 227   // permanently writes all changes
 228   virtual bool Flush(bool bCurrentOnly = false) = 0;
 229
 230   // renaming, all functions return false on failure (probably because the new
 231   // name is already taken by an existing entry)
 232     // rename an entry
 233   virtual bool RenameEntry(const wxString& oldName,
 234                            const wxString& newName) = 0;
 235     // rename a group
 236   virtual bool RenameGroup(const wxString& oldName,
 237                            const wxString& newName) = 0;
 238
 239   // delete entries/groups
 240     // deletes the specified entry and the group it belongs to if
 241     // it was the last key in it and the second parameter is true
 242   virtual bool DeleteEntry(const wxString& key,
 243                            bool bDeleteGroupIfEmpty = true) = 0;
 244     // delete the group (with all subgroups)
 245   virtual bool DeleteGroup(const wxString& key) = 0;
 246     // delete the whole underlying object (disk file, registry key, ...)
 247     // primarily for use by uninstallation routine.
 248   virtual bool DeleteAll() = 0;
 249
 250   // options
 251     // we can automatically expand environment variables in the config entries
 252     // (this option is on by default, you can turn it on/off at any time)
 253   bool IsExpandingEnvVars() const { return m_bExpandEnvVars; }
 254   void SetExpandEnvVars(bool bDoIt = true) { m_bExpandEnvVars = bDoIt; }
 255     // recording of default values
 256   void SetRecordDefaults(bool bDoIt = true) { m_bRecordDefaults = bDoIt; }
 257   bool IsRecordingDefaults() const { return m_bRecordDefaults; }
 258   // does expansion only if needed
 259   wxString ExpandEnvVars(const wxString& str) const;
 260
 261     // misc accessors
 262   wxString GetAppName() const { return m_appName; }
 263   wxString GetVendorName() const { return m_vendorName; }
 264
 265   // Used wxIniConfig to set members in constructor
 266   void SetAppName(const wxString& appName) { m_appName = appName; }
 267   void SetVendorName(const wxString& vendorName) { m_vendorName = vendorName; }
 268
 269   void SetStyle(long style) { m_style = style; }
 270   long GetStyle() const { return m_style; }
 271
 272 protected:
 273   static bool IsImmutable(const wxString& key)
 274     { return !key.IsEmpty() && key[0] == wxCONFIG_IMMUTABLE_PREFIX; }
 275
 276   // return the path without trailing separator, if any: this should be called
 277   // to sanitize paths referring to the group names before passing them to
 278   // wxConfigPathChanger as "/foo/bar/" should be the same as "/foo/bar" and it
 279   // isn't interpreted in the same way by it (and this can't be changed there
 280   // as it's not the same for the entries names)
 281   static wxString RemoveTrailingSeparator(const wxString& key);
 282
 283   // do read/write the values of different types
 284   virtual bool DoReadString(const wxString& key, wxString *pStr) const = 0;
 285   virtual bool DoReadLong(const wxString& key, long *pl) const = 0;
 286   virtual bool DoReadInt(const wxString& key, int *pi) const;
 287   virtual bool DoReadDouble(const wxString& key, double* val) const;
 288   virtual bool DoReadBool(const wxString& key, bool* val) const;
 289 #if wxUSE_BASE64
 290   virtual bool DoReadBinary(const wxString& key, wxMemoryBuffer* buf) const = 0;
 291 #endif // wxUSE_BASE64
 292
 293   virtual bool DoWriteString(const wxString& key, const wxString& value) = 0;
 294   virtual bool DoWriteLong(const wxString& key, long value) = 0;
 295   virtual bool DoWriteInt(const wxString& key, int value);
 296   virtual bool DoWriteDouble(const wxString& key, double value);
 297   virtual bool DoWriteBool(const wxString& key, bool value);
 298 #if wxUSE_BASE64
 299   virtual bool DoWriteBinary(const wxString& key, const wxMemoryBuffer& buf) = 0;
 300 #endif // wxUSE_BASE64
 301
 302 private:
 303   // are we doing automatic environment variable expansion?
 304   bool m_bExpandEnvVars;
 305   // do we record default values?
 306   bool m_bRecordDefaults;
 307
 308   // static variables
 309   static wxConfigBase *ms_pConfig;
 310   static bool          ms_bAutoCreate;
 311
 312   // Application name and organisation name
 313   wxString          m_appName;
 314   wxString          m_vendorName;
 315
 316   // Style flag
 317   long              m_style;
 318
 319   DECLARE_ABSTRACT_CLASS(wxConfigBase)
 320 };
 321
 322 // a handy little class which changes current path to the path of given entry
 323 // and restores it in dtor: so if you declare a local variable of this type,
 324 // you work in the entry directory and the path is automatically restored
 325 // when the function returns
 326 // Taken out of wxConfig since not all compilers can cope with nested classes.
 327 class WXDLLIMPEXP_BASE wxConfigPathChanger
 328 {
 329 public:
 330   // ctor/dtor do path changing/restoring of the path
 331   wxConfigPathChanger(const wxConfigBase *pContainer, const wxString& strEntry);
 332  ~wxConfigPathChanger();
 333
 334   // get the key name
 335   const wxString& Name() const { return m_strName; }
 336
 337   // this method must be called if the original path (i.e. the current path at
 338   // the moment of creation of this object) could have been deleted to prevent
 339   // us from restoring the not existing (any more) path
 340   //
 341   // if the original path doesn't exist any more, the path will be restored to
 342   // the deepest still existing component of the old path
 343   void UpdateIfDeleted();
 344
 345 private:
 346   wxConfigBase *m_pContainer;   // object we live in
 347   wxString      m_strName,      // name of entry (i.e. name only)
 348                 m_strOldPath;   // saved path
 349   bool          m_bChanged;     // was the path changed?
 350
 351   DECLARE_NO_COPY_CLASS(wxConfigPathChanger)
 352 };
 353
 354
 355 // ----------------------------------------------------------------------------
 356 // the native wxConfigBase implementation
 357 // ----------------------------------------------------------------------------
 358
 359 // under Windows we prefer to use the native implementation
 360 // wxIniConfig isn't native anywhere after droping win16 in wxWidgets 2.6
 361 #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
 362     #define wxConfig  wxRegConfig
 363 #else // either we're under Unix or wish to use files even under Windows
 364   #define wxConfig  wxFileConfig
 365 #endif
 366
 367 #endif // wxUSE_CONFIG
 368
 369 /*
 370   Replace environment variables ($SOMETHING) with their values. The format is
 371   $VARNAME or ${VARNAME} where VARNAME contains alphanumeric characters and
 372   '_' only. '$' must be escaped ('\$') in order to be taken literally.
 373 */
 374
 375 WXDLLIMPEXP_BASE wxString wxExpandEnvVars(const wxString &sz);
 376
 377 /*
 378   Split path into parts removing '..' in progress
 379  */
 380 WXDLLIMPEXP_BASE void wxSplitPath(wxArrayString& aParts, const wxString& path);
 381
 382 #endif // _WX_CONFBASE_H_
 383