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