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 Ballueder & Vadim Zeitlin
   6 // Modified by:
   7 // Created:     07.04.98 (adapted from appconf.h)
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 1997 Karsten Ballueder   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 // not all compilers can deal with template Read/Write() methods, define this
  56 // symbol if the template functions are available
  57 #if (!defined(__VISUALC__) || __VISUALC__ > 1200) && \
  58     !defined( __VMS ) && \
  59     !defined (__DMC__)
  60     #define wxHAS_CONFIG_TEMPLATE_RW
  61 #endif
  62
  63 // Style flags for constructor style parameter
  64 enum
  65 {
  66     wxCONFIG_USE_LOCAL_FILE = 1,
  67     wxCONFIG_USE_GLOBAL_FILE = 2,
  68     wxCONFIG_USE_RELATIVE_PATH = 4,
  69     wxCONFIG_USE_NO_ESCAPE_CHARACTERS = 8,
  70     wxCONFIG_USE_SUBDIR = 16
  71 };
  72
  73 // ----------------------------------------------------------------------------
  74 // abstract base class wxConfigBase which defines the interface for derived
  75 // classes
  76 //
  77 // wxConfig organizes the items in a tree-like structure (modeled after the
  78 // Unix/Dos filesystem). There are groups (directories) and keys (files).
  79 // There is always one current group given by the current path.
  80 //
  81 // Keys are pairs "key_name = value" where value may be of string or integer
  82 // (long) type (TODO doubles and other types such as wxDate coming soon).
  83 // ----------------------------------------------------------------------------
  84
  85 class WXDLLIMPEXP_BASE wxConfigBase : public wxObject
  86 {
  87 public:
  88   // constants
  89     // the type of an entry
  90   enum EntryType
  91   {
  92     Type_Unknown,
  93     Type_String,
  94     Type_Boolean,
  95     Type_Integer,    // use Read(long *)
  96     Type_Float       // use Read(double *)
  97   };
  98
  99   // static functions
 100     // sets the config object, returns the previous pointer
 101   static wxConfigBase *Set(wxConfigBase *pConfig);
 102     // get the config object, creates it on demand unless DontCreateOnDemand
 103     // was called
 104   static wxConfigBase *Get(bool createOnDemand = true)
 105        { if ( createOnDemand && (!ms_pConfig) ) Create(); return ms_pConfig; }
 106     // create a new config object: this function will create the "best"
 107     // implementation of wxConfig available for the current platform, see
 108     // comments near definition wxUSE_CONFIG_NATIVE for details. It returns
 109     // the created object and also sets it as ms_pConfig.
 110   static wxConfigBase *Create();
 111     // should Get() try to create a new log object if the current one is NULL?
 112   static void DontCreateOnDemand() { ms_bAutoCreate = false; }
 113
 114   // ctor & virtual dtor
 115       // ctor (can be used as default ctor too)
 116       //
 117       // Not all args will always be used by derived classes, but including
 118       // them all in each class ensures compatibility. If appName is empty,
 119       // uses wxApp name
 120   wxConfigBase(const wxString& appName = wxEmptyString,
 121                const wxString& vendorName = wxEmptyString,
 122                const wxString& localFilename = wxEmptyString,
 123                const wxString& globalFilename = wxEmptyString,
 124                long style = 0);
 125
 126     // empty but ensures that dtor of all derived classes is virtual
 127   virtual ~wxConfigBase();
 128
 129   // path management
 130     // set current path: if the first character is '/', it's the absolute path,
 131     // otherwise it's a relative path. '..' is supported. If the strPath
 132     // doesn't exist it is created.
 133   virtual void SetPath(const wxString& strPath) = 0;
 134     // retrieve the current path (always as absolute path)
 135   virtual const wxString& GetPath() const = 0;
 136
 137   // enumeration: all functions here return false when there are no more items.
 138   // you must pass the same lIndex to GetNext and GetFirst (don't modify it)
 139     // enumerate subgroups
 140   virtual bool GetFirstGroup(wxString& str, long& lIndex) const = 0;
 141   virtual bool GetNextGroup (wxString& str, long& lIndex) const = 0;
 142     // enumerate entries
 143   virtual bool GetFirstEntry(wxString& str, long& lIndex) const = 0;
 144   virtual bool GetNextEntry (wxString& str, long& lIndex) const = 0;
 145     // get number of entries/subgroups in the current group, with or without
 146     // it's subgroups
 147   virtual size_t GetNumberOfEntries(bool bRecursive = false) const = 0;
 148   virtual size_t GetNumberOfGroups(bool bRecursive = false) const = 0;
 149
 150   // tests of existence
 151     // returns true if the group by this name exists
 152   virtual bool HasGroup(const wxString& strName) const = 0;
 153     // same as above, but for an entry
 154   virtual bool HasEntry(const wxString& strName) const = 0;
 155     // returns true if either a group or an entry with a given name exist
 156   bool Exists(const wxString& strName) const
 157     { return HasGroup(strName) || HasEntry(strName); }
 158
 159     // get the entry type
 160   virtual EntryType GetEntryType(const wxString& name) const
 161   {
 162     // by default all entries are strings
 163     return HasEntry(name) ? Type_String : Type_Unknown;
 164   }
 165
 166   // key access: returns true if value was really read, false if default used
 167   // (and if the key is not found the default value is returned.)
 168
 169     // read a string from the key
 170   bool Read(const wxString& key, wxString *pStr) const;
 171   bool Read(const wxString& key, wxString *pStr, const wxString& defVal) const;
 172
 173     // read a number (long)
 174   bool Read(const wxString& key, long *pl) const;
 175   bool Read(const wxString& key, long *pl, long defVal) const;
 176
 177     // read an int (wrapper around `long' version)
 178   bool Read(const wxString& key, int *pi) const;
 179   bool Read(const wxString& key, int *pi, int defVal) const;
 180
 181     // read a double
 182   bool Read(const wxString& key, double* val) const;
 183   bool Read(const wxString& key, double* val, double defVal) const;
 184
 185     // read a bool
 186   bool Read(const wxString& key, bool* val) const;
 187   bool Read(const wxString& key, bool* val, bool defVal) const;
 188
 189 #if wxUSE_BASE64
 190     // read a binary data block
 191   bool Read(const wxString& key, wxMemoryBuffer* data) const
 192     { return DoReadBinary(key, data); }
 193    // no default version since it does not make sense for binary data
 194 #endif // wxUSE_BASE64
 195
 196 #ifdef wxHAS_CONFIG_TEMPLATE_RW
 197   // read other types, for which wxFromString is defined
 198   template <typename T>
 199   bool Read(const wxString& key, T* value) const
 200   {
 201       wxString s;
 202       if ( !Read(key, &s) )
 203           return false;
 204       return wxFromString(s, value);
 205   }
 206
 207   template <typename T>
 208   bool Read(const wxString& key, T* value, const T& defVal) const
 209   {
 210       const bool found = Read(key, value);
 211       if ( !found )
 212       {
 213           if (IsRecordingDefaults())
 214               ((wxConfigBase *)this)->Write(key, defVal);
 215           *value = defVal;
 216       }
 217       return found;
 218   }
 219 #endif // wxHAS_CONFIG_TEMPLATE_RW
 220
 221   // convenience functions returning directly the value
 222   wxString Read(const wxString& key,
 223                 const wxString& defVal = wxEmptyString) const
 224     { wxString s; (void)Read(key, &s, defVal); return s; }
 225
 226   // we have to provide a separate version for C strings as otherwise the
 227   // template Read() would be used
 228   wxString Read(const wxString& key, const char* defVal) const
 229     { return Read(key, wxString(defVal)); }
 230 #if wxUSE_WCHAR_T
 231   wxString Read(const wxString& key, const wchar_t* defVal) const
 232     { return Read(key, wxString(defVal)); }
 233 #endif
 234
 235   long ReadLong(const wxString& key, long defVal) const
 236     { long l; (void)Read(key, &l, defVal); return l; }
 237
 238   double ReadDouble(const wxString& key, double defVal) const
 239     { double d; (void)Read(key, &d, defVal); return d; }
 240
 241   bool ReadBool(const wxString& key, bool defVal) const
 242     { bool b; (void)Read(key, &b, defVal); return b; }
 243
 244   template <typename T>
 245   T ReadObject(const wxString& key, T const& defVal) const
 246     { T t; (void)Read(key, &t, defVal); return t; }
 247
 248   // for compatibility with wx 2.8
 249   long Read(const wxString& key, long defVal) const
 250     { return ReadLong(key, defVal); }
 251
 252
 253   // write the value (return true on success)
 254   bool Write(const wxString& key, const wxString& value)
 255     { return DoWriteString(key, value); }
 256
 257   bool Write(const wxString& key, long value)
 258     { return DoWriteLong(key, value); }
 259
 260   bool Write(const wxString& key, double value)
 261     { return DoWriteDouble(key, value); }
 262
 263   bool Write(const wxString& key, bool value)
 264     { return DoWriteBool(key, value); }
 265
 266 #if wxUSE_BASE64
 267   bool Write(const wxString& key, const wxMemoryBuffer& buf)
 268     { return DoWriteBinary(key, buf); }
 269 #endif // wxUSE_BASE64
 270
 271   // we have to provide a separate version for C strings as otherwise they
 272   // would be converted to bool and not to wxString as expected!
 273   bool Write(const wxString& key, const char *value)
 274     { return Write(key, wxString(value)); }
 275   bool Write(const wxString& key, const unsigned char *value)
 276     { return Write(key, wxString(value)); }
 277 #if wxUSE_WCHAR_T
 278   bool Write(const wxString& key, const wchar_t *value)
 279     { return Write(key, wxString(value)); }
 280 #endif
 281
 282
 283   // we also have to provide specializations for other types which we want to
 284   // handle using the specialized DoWriteXXX() instead of the generic template
 285   // version below
 286   bool Write(const wxString& key, char value)
 287     { return DoWriteLong(key, value); }
 288
 289   bool Write(const wxString& key, unsigned char value)
 290     { return DoWriteLong(key, value); }
 291
 292   bool Write(const wxString& key, short value)
 293     { return DoWriteLong(key, value); }
 294
 295   bool Write(const wxString& key, unsigned short value)
 296     { return DoWriteLong(key, value); }
 297
 298   bool Write(const wxString& key, unsigned int value)
 299     { return DoWriteLong(key, value); }
 300
 301   bool Write(const wxString& key, int value)
 302     { return DoWriteLong(key, value); }
 303
 304   bool Write(const wxString& key, unsigned long value)
 305     { return DoWriteLong(key, value); }
 306
 307   bool Write(const wxString& key, float value)
 308     { return DoWriteDouble(key, value); }
 309
 310   // Causes ambiguities in VC++ 6 and OpenVMS (at least)
 311 #if ( (!defined(__VISUALC__) || __VISUALC__ > 1200) && !defined( __VMS ) && !defined (__DMC__))
 312   // for other types, use wxToString()
 313   template <typename T>
 314   bool Write(const wxString& key, T const& value)
 315     { return Write(key, wxToString(value)); }
 316 #endif
 317
 318   // permanently writes all changes
 319   virtual bool Flush(bool bCurrentOnly = false) = 0;
 320
 321   // renaming, all functions return false on failure (probably because the new
 322   // name is already taken by an existing entry)
 323     // rename an entry
 324   virtual bool RenameEntry(const wxString& oldName,
 325                            const wxString& newName) = 0;
 326     // rename a group
 327   virtual bool RenameGroup(const wxString& oldName,
 328                            const wxString& newName) = 0;
 329
 330   // delete entries/groups
 331     // deletes the specified entry and the group it belongs to if
 332     // it was the last key in it and the second parameter is true
 333   virtual bool DeleteEntry(const wxString& key,
 334                            bool bDeleteGroupIfEmpty = true) = 0;
 335     // delete the group (with all subgroups)
 336   virtual bool DeleteGroup(const wxString& key) = 0;
 337     // delete the whole underlying object (disk file, registry key, ...)
 338     // primarily for use by uninstallation routine.
 339   virtual bool DeleteAll() = 0;
 340
 341   // options
 342     // we can automatically expand environment variables in the config entries
 343     // (this option is on by default, you can turn it on/off at any time)
 344   bool IsExpandingEnvVars() const { return m_bExpandEnvVars; }
 345   void SetExpandEnvVars(bool bDoIt = true) { m_bExpandEnvVars = bDoIt; }
 346     // recording of default values
 347   void SetRecordDefaults(bool bDoIt = true) { m_bRecordDefaults = bDoIt; }
 348   bool IsRecordingDefaults() const { return m_bRecordDefaults; }
 349   // does expansion only if needed
 350   wxString ExpandEnvVars(const wxString& str) const;
 351
 352     // misc accessors
 353   wxString GetAppName() const { return m_appName; }
 354   wxString GetVendorName() const { return m_vendorName; }
 355
 356   // Used wxIniConfig to set members in constructor
 357   void SetAppName(const wxString& appName) { m_appName = appName; }
 358   void SetVendorName(const wxString& vendorName) { m_vendorName = vendorName; }
 359
 360   void SetStyle(long style) { m_style = style; }
 361   long GetStyle() const { return m_style; }
 362
 363 protected:
 364   static bool IsImmutable(const wxString& key)
 365     { return !key.IsEmpty() && key[0] == wxCONFIG_IMMUTABLE_PREFIX; }
 366
 367   // return the path without trailing separator, if any: this should be called
 368   // to sanitize paths referring to the group names before passing them to
 369   // wxConfigPathChanger as "/foo/bar/" should be the same as "/foo/bar" and it
 370   // isn't interpreted in the same way by it (and this can't be changed there
 371   // as it's not the same for the entries names)
 372   static wxString RemoveTrailingSeparator(const wxString& key);
 373
 374   // do read/write the values of different types
 375   virtual bool DoReadString(const wxString& key, wxString *pStr) const = 0;
 376   virtual bool DoReadLong(const wxString& key, long *pl) const = 0;
 377   virtual bool DoReadDouble(const wxString& key, double* val) const;
 378   virtual bool DoReadBool(const wxString& key, bool* val) const;
 379 #if wxUSE_BASE64
 380   virtual bool DoReadBinary(const wxString& key, wxMemoryBuffer* buf) const = 0;
 381 #endif // wxUSE_BASE64
 382
 383   virtual bool DoWriteString(const wxString& key, const wxString& value) = 0;
 384   virtual bool DoWriteLong(const wxString& key, long value) = 0;
 385   virtual bool DoWriteDouble(const wxString& key, double value);
 386   virtual bool DoWriteBool(const wxString& key, bool value);
 387 #if wxUSE_BASE64
 388   virtual bool DoWriteBinary(const wxString& key, const wxMemoryBuffer& buf) = 0;
 389 #endif // wxUSE_BASE64
 390
 391 private:
 392   // are we doing automatic environment variable expansion?
 393   bool m_bExpandEnvVars;
 394   // do we record default values?
 395   bool m_bRecordDefaults;
 396
 397   // static variables
 398   static wxConfigBase *ms_pConfig;
 399   static bool          ms_bAutoCreate;
 400
 401   // Application name and organisation name
 402   wxString          m_appName;
 403   wxString          m_vendorName;
 404
 405   // Style flag
 406   long              m_style;
 407
 408   DECLARE_ABSTRACT_CLASS(wxConfigBase)
 409 };
 410
 411 // a handy little class which changes current path to the path of given entry
 412 // and restores it in dtor: so if you declare a local variable of this type,
 413 // you work in the entry directory and the path is automatically restored
 414 // when the function returns
 415 // Taken out of wxConfig since not all compilers can cope with nested classes.
 416 class WXDLLIMPEXP_BASE wxConfigPathChanger
 417 {
 418 public:
 419   // ctor/dtor do path changing/restoring of the path
 420   wxConfigPathChanger(const wxConfigBase *pContainer, const wxString& strEntry);
 421  ~wxConfigPathChanger();
 422
 423   // get the key name
 424   const wxString& Name() const { return m_strName; }
 425
 426   // this method must be called if the original path (i.e. the current path at
 427   // the moment of creation of this object) could have been deleted to prevent
 428   // us from restoring the not existing (any more) path
 429   //
 430   // if the original path doesn't exist any more, the path will be restored to
 431   // the deepest still existing component of the old path
 432   void UpdateIfDeleted();
 433
 434 private:
 435   wxConfigBase *m_pContainer;   // object we live in
 436   wxString      m_strName,      // name of entry (i.e. name only)
 437                 m_strOldPath;   // saved path
 438   bool          m_bChanged;     // was the path changed?
 439
 440   wxDECLARE_NO_COPY_CLASS(wxConfigPathChanger);
 441 };
 442
 443
 444 #endif // wxUSE_CONFIG
 445
 446 /*
 447   Replace environment variables ($SOMETHING) with their values. The format is
 448   $VARNAME or ${VARNAME} where VARNAME contains alphanumeric characters and
 449   '_' only. '$' must be escaped ('\$') in order to be taken literally.
 450 */
 451
 452 WXDLLIMPEXP_BASE wxString wxExpandEnvVars(const wxString &sz);
 453
 454 /*
 455   Split path into parts removing '..' in progress
 456  */
 457 WXDLLIMPEXP_BASE void wxSplitPath(wxArrayString& aParts, const wxString& path);
 458
 459 #endif // _WX_CONFBASE_H_
 460