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