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