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