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
  21 class WXDLLIMPEXP_FWD_BASE wxArrayString;
  22
  23 // ----------------------------------------------------------------------------
  24 // constants
  25 // ----------------------------------------------------------------------------
  26
  27 /// shall we be case sensitive in parsing variable names?
  28 #ifndef wxCONFIG_CASE_SENSITIVE
  29   #define  wxCONFIG_CASE_SENSITIVE       0
  30 #endif
  31
  32 /// separates group and entry names (probably shouldn't be changed)
  33 #ifndef wxCONFIG_PATH_SEPARATOR
  34   #define   wxCONFIG_PATH_SEPARATOR     _T('/')
  35 #endif
  36
  37 /// introduces immutable entries
  38 // (i.e. the ones which can't be changed from the local config file)
  39 #ifndef wxCONFIG_IMMUTABLE_PREFIX
  40   #define   wxCONFIG_IMMUTABLE_PREFIX   _T('!')
  41 #endif
  42
  43 #if wxUSE_CONFIG
  44
  45 #include "wx/string.h"
  46
  47 /// should we use registry instead of configuration files under Windows?
  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))
  50 #ifndef   wxUSE_CONFIG_NATIVE
  51   #define wxUSE_CONFIG_NATIVE 1
  52 #endif
  53
  54 // Style flags for constructor style parameter
  55 enum
  56 {
  57     wxCONFIG_USE_LOCAL_FILE = 1,
  58     wxCONFIG_USE_GLOBAL_FILE = 2,
  59     wxCONFIG_USE_RELATIVE_PATH = 4,
  60     wxCONFIG_USE_NO_ESCAPE_CHARACTERS = 8,
  61     wxCONFIG_USE_SUBDIR = 16
  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
  76 class WXDLLIMPEXP_BASE wxConfigBase : public wxObject
  77 {
  78 public:
  79   // constants
  80     // the type of an entry
  81   enum EntryType
  82   {
  83     Type_Unknown,
  84     Type_String,
  85     Type_Boolean,
  86     Type_Integer,    // use Read(long *)
  87     Type_Float       // use Read(double *)
  88   };
  89
  90   // static functions
  91     // sets the config object, returns the previous pointer
  92   static wxConfigBase *Set(wxConfigBase *pConfig);
  93     // get the config object, creates it on demand unless DontCreateOnDemand
  94     // was called
  95   static wxConfigBase *Get(bool createOnDemand = true)
  96        { if ( createOnDemand && (!ms_pConfig) ) Create(); return ms_pConfig; }
  97     // create a new config object: this function will create the "best"
  98     // implementation of wxConfig available for the current platform, see
  99     // comments near definition wxUSE_CONFIG_NATIVE for details. It returns
 100     // the created object and also sets it as ms_pConfig.
 101   static wxConfigBase *Create();
 102     // should Get() try to create a new log object if the current one is NULL?
 103   static void DontCreateOnDemand() { ms_bAutoCreate = false; }
 104
 105   // ctor & virtual dtor
 106       // ctor (can be used as default ctor too)
 107       //
 108       // Not all args will always be used by derived classes, but including
 109       // them all in each class ensures compatibility. If appName is empty,
 110       // uses wxApp name
 111   wxConfigBase(const wxString& appName = wxEmptyString,
 112                const wxString& vendorName = wxEmptyString,
 113                const wxString& localFilename = wxEmptyString,
 114                const wxString& globalFilename = wxEmptyString,
 115                long style = 0);
 116
 117     // empty but ensures that dtor of all derived classes is virtual
 118   virtual ~wxConfigBase();
 119
 120   // path management
 121     // set current path: if the first character is '/', it's the absolute path,
 122     // otherwise it's a relative path. '..' is supported. If the strPath
 123     // doesn't exist it is created.
 124   virtual void SetPath(const wxString& strPath) = 0;
 125     // retrieve the current path (always as absolute path)
 126   virtual const wxString& GetPath() const = 0;
 127
 128   // enumeration: all functions here return false when there are no more items.
 129   // you must pass the same lIndex to GetNext and GetFirst (don't modify it)
 130     // enumerate subgroups
 131   virtual bool GetFirstGroup(wxString& str, long& lIndex) const = 0;
 132   virtual bool GetNextGroup (wxString& str, long& lIndex) const = 0;
 133     // enumerate entries
 134   virtual bool GetFirstEntry(wxString& str, long& lIndex) const = 0;
 135   virtual bool GetNextEntry (wxString& str, long& lIndex) const = 0;
 136     // get number of entries/subgroups in the current group, with or without
 137     // it's subgroups
 138   virtual size_t GetNumberOfEntries(bool bRecursive = false) const = 0;
 139   virtual size_t GetNumberOfGroups(bool bRecursive = false) const = 0;
 140
 141   // tests of existence
 142     // returns true if the group by this name exists
 143   virtual bool HasGroup(const wxString& strName) const = 0;
 144     // same as above, but for an entry
 145   virtual bool HasEntry(const wxString& strName) const = 0;
 146     // returns true if either a group or an entry with a given name exist
 147   bool Exists(const wxString& strName) const
 148     { return HasGroup(strName) || HasEntry(strName); }
 149
 150     // get the entry type
 151   virtual EntryType GetEntryType(const wxString& name) const
 152   {
 153     // by default all entries are strings
 154     return HasEntry(name) ? Type_String : Type_Unknown;
 155   }
 156
 157   // key access: returns true if value was really read, false if default used
 158   // (and if the key is not found the default value is returned.)
 159
 160     // read a string from the key
 161   bool Read(const wxString& key, wxString *pStr) const;
 162   bool Read(const wxString& key, wxString *pStr, const wxString& defVal) const;
 163
 164     // read a number (long)
 165   bool Read(const wxString& key, long *pl) const;
 166   bool Read(const wxString& key, long *pl, long defVal) const;
 167
 168     // read an int
 169   bool Read(const wxString& key, int *pi) const;
 170   bool Read(const wxString& key, int *pi, int defVal) const;
 171
 172     // read a double
 173   bool Read(const wxString& key, double* val) const;
 174   bool Read(const wxString& key, double* val, double defVal) const;
 175
 176     // read a bool
 177   bool Read(const wxString& key, bool* val) const;
 178   bool Read(const wxString& key, bool* val, bool defVal) const;
 179
 180   // convenience functions returning directly the value (we don't have them for
 181   // int/double/bool as there would be ambiguities with the long one then)
 182   wxString Read(const wxString& key,
 183                 const wxString& defVal = wxEmptyString) const
 184     { wxString s; (void)Read(key, &s, defVal); return s; }
 185
 186   long Read(const wxString& key, long defVal) const
 187     { long l; (void)Read(key, &l, defVal); return l; }
 188
 189     // write the value (return true on success)
 190   bool Write(const wxString& key, const wxString& value)
 191     { return DoWriteString(key, value); }
 192
 193   bool Write(const wxString& key, long value)
 194     { return DoWriteLong(key, value); }
 195
 196   bool Write(const wxString& key, int value)
 197     { return DoWriteInt(key, value); }
 198
 199   bool Write(const wxString& key, double value)
 200     { return DoWriteDouble(key, value); }
 201
 202   bool Write(const wxString& key, bool value)
 203     { return DoWriteBool(key, value); }
 204
 205   // we have to provide a separate version for C strings as otherwise they
 206   // would be converted to bool and not to wxString as expected!
 207   bool Write(const wxString& key, const char *value)
 208     { return Write(key, wxString(value)); }
 209 #if wxUSE_WCHAR_T
 210   bool Write(const wxString& key, const wchar_t *value)
 211     { return Write(key, wxString(value)); }
 212 #endif
 213
 214   // permanently writes all changes
 215   virtual bool Flush(bool bCurrentOnly = false) = 0;
 216
 217   // renaming, all functions return false on failure (probably because the new
 218   // name is already taken by an existing entry)
 219     // rename an entry
 220   virtual bool RenameEntry(const wxString& oldName,
 221                            const wxString& newName) = 0;
 222     // rename a group
 223   virtual bool RenameGroup(const wxString& oldName,
 224                            const wxString& newName) = 0;
 225
 226   // delete entries/groups
 227     // deletes the specified entry and the group it belongs to if
 228     // it was the last key in it and the second parameter is true
 229   virtual bool DeleteEntry(const wxString& key,
 230                            bool bDeleteGroupIfEmpty = true) = 0;
 231     // delete the group (with all subgroups)
 232   virtual bool DeleteGroup(const wxString& key) = 0;
 233     // delete the whole underlying object (disk file, registry key, ...)
 234     // primarily for use by uninstallation routine.
 235   virtual bool DeleteAll() = 0;
 236
 237   // options
 238     // we can automatically expand environment variables in the config entries
 239     // (this option is on by default, you can turn it on/off at any time)
 240   bool IsExpandingEnvVars() const { return m_bExpandEnvVars; }
 241   void SetExpandEnvVars(bool bDoIt = true) { m_bExpandEnvVars = bDoIt; }
 242     // recording of default values
 243   void SetRecordDefaults(bool bDoIt = true) { m_bRecordDefaults = bDoIt; }
 244   bool IsRecordingDefaults() const { return m_bRecordDefaults; }
 245   // does expansion only if needed
 246   wxString ExpandEnvVars(const wxString& str) const;
 247
 248     // misc accessors
 249   wxString GetAppName() const { return m_appName; }
 250   wxString GetVendorName() const { return m_vendorName; }
 251
 252   // Used wxIniConfig to set members in constructor
 253   void SetAppName(const wxString& appName) { m_appName = appName; }
 254   void SetVendorName(const wxString& vendorName) { m_vendorName = vendorName; }
 255
 256   void SetStyle(long style) { m_style = style; }
 257   long GetStyle() const { return m_style; }
 258
 259 protected:
 260   static bool IsImmutable(const wxString& key)
 261     { return !key.IsEmpty() && key[0] == wxCONFIG_IMMUTABLE_PREFIX; }
 262
 263   // return the path without trailing separator, if any: this should be called
 264   // to sanitize paths referring to the group names before passing them to
 265   // wxConfigPathChanger as "/foo/bar/" should be the same as "/foo/bar" and it
 266   // isn't interpreted in the same way by it (and this can't be changed there
 267   // as it's not the same for the entries names)
 268   static wxString RemoveTrailingSeparator(const wxString& key);
 269
 270   // do read/write the values of different types
 271   virtual bool DoReadString(const wxString& key, wxString *pStr) const = 0;
 272   virtual bool DoReadLong(const wxString& key, long *pl) const = 0;
 273   virtual bool DoReadInt(const wxString& key, int *pi) const;
 274   virtual bool DoReadDouble(const wxString& key, double* val) const;
 275   virtual bool DoReadBool(const wxString& key, bool* val) const;
 276
 277   virtual bool DoWriteString(const wxString& key, const wxString& value) = 0;
 278   virtual bool DoWriteLong(const wxString& key, long value) = 0;
 279   virtual bool DoWriteInt(const wxString& key, int value);
 280   virtual bool DoWriteDouble(const wxString& key, double value);
 281   virtual bool DoWriteBool(const wxString& key, bool value);
 282
 283 private:
 284   // are we doing automatic environment variable expansion?
 285   bool m_bExpandEnvVars;
 286   // do we record default values?
 287   bool m_bRecordDefaults;
 288
 289   // static variables
 290   static wxConfigBase *ms_pConfig;
 291   static bool          ms_bAutoCreate;
 292
 293   // Application name and organisation name
 294   wxString          m_appName;
 295   wxString          m_vendorName;
 296
 297   // Style flag
 298   long              m_style;
 299
 300   DECLARE_ABSTRACT_CLASS(wxConfigBase)
 301 };
 302
 303 // a handy little class which changes current path to the path of given entry
 304 // and restores it in dtor: so if you declare a local variable of this type,
 305 // you work in the entry directory and the path is automatically restored
 306 // when the function returns
 307 // Taken out of wxConfig since not all compilers can cope with nested classes.
 308 class WXDLLIMPEXP_BASE wxConfigPathChanger
 309 {
 310 public:
 311   // ctor/dtor do path changing/restoring of the path
 312   wxConfigPathChanger(const wxConfigBase *pContainer, const wxString& strEntry);
 313  ~wxConfigPathChanger();
 314
 315   // get the key name
 316   const wxString& Name() const { return m_strName; }
 317
 318   // this method must be called if the original path (i.e. the current path at
 319   // the moment of creation of this object) could have been deleted to prevent
 320   // us from restoring the not existing (any more) path
 321   //
 322   // if the original path doesn't exist any more, the path will be restored to
 323   // the deepest still existing component of the old path
 324   void UpdateIfDeleted();
 325
 326 private:
 327   wxConfigBase *m_pContainer;   // object we live in
 328   wxString      m_strName,      // name of entry (i.e. name only)
 329                 m_strOldPath;   // saved path
 330   bool          m_bChanged;     // was the path changed?
 331
 332   DECLARE_NO_COPY_CLASS(wxConfigPathChanger)
 333 };
 334
 335
 336 // ----------------------------------------------------------------------------
 337 // the native wxConfigBase implementation
 338 // ----------------------------------------------------------------------------
 339
 340 // under Windows we prefer to use the native implementation
 341 // wxIniConfig isn't native anywhere after droping win16 in wxWidgets 2.6
 342 #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
 343     #define wxConfig  wxRegConfig
 344 #else // either we're under Unix or wish to use files even under Windows
 345   #define wxConfig  wxFileConfig
 346 #endif
 347
 348 #endif // wxUSE_CONFIG
 349
 350 /*
 351   Replace environment variables ($SOMETHING) with their values. The format is
 352   $VARNAME or ${VARNAME} where VARNAME contains alphanumeric characters and
 353   '_' only. '$' must be escaped ('\$') in order to be taken literally.
 354 */
 355
 356 WXDLLIMPEXP_BASE wxString wxExpandEnvVars(const wxString &sz);
 357
 358 /*
 359   Split path into parts removing '..' in progress
 360  */
 361 WXDLLIMPEXP_BASE void wxSplitPath(wxArrayString& aParts, const wxString& path);
 362
 363 #endif // _WX_CONFBASE_H_
 364