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 #include "wx/defs.h"
  22
  23 #ifdef 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   // static functions
  90     // sets the config object, returns the previous pointer
  91   static wxConfigBase *Set(wxConfigBase *pConfig);
  92     // get the config object, creates it on demand unless DontCreateOnDemand
  93     // was called
  94   static wxConfigBase *Get() { if ( !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 wxCONFIG_WIN32_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     // environment variable expansion is on by default
 105 //  wxConfigBase() { m_bExpandEnvVars = TRUE; m_bRecordDefaults = FALSE; }
 106
 107   // ctor
 108
 109   // Not all args will always be used by derived classes, but
 110   // including them all in each class ensures compatibility.
 111   // If appName is empty, uses wxApp name
 112   wxConfigBase(const wxString& appName = "", const wxString& vendorName = "",
 113                const wxString& localFilename = "", const wxString& globalFilename = "",
 114                long style = 0);
 115
 116     // empty but ensures that dtor of all derived classes is virtual
 117   virtual ~wxConfigBase() { }
 118
 119   // path management
 120     // set current path: if the first character is '/', it's the absolute path,
 121     // otherwise it's a relative path. '..' is supported. If the strPath
 122     // doesn't exist it is created.
 123   virtual void SetPath(const wxString& strPath) = 0;
 124     // retrieve the current path (always as absolute path)
 125   virtual const wxString& GetPath() const = 0;
 126
 127   // enumeration: all functions here return false when there are no more items.
 128   // you must pass the same lIndex to GetNext and GetFirst (don't modify it)
 129     // enumerate subgroups
 130   virtual bool GetFirstGroup(wxString& str, long& lIndex) const = 0;
 131   virtual bool GetNextGroup (wxString& str, long& lIndex) const = 0;
 132     // enumerate entries
 133   virtual bool GetFirstEntry(wxString& str, long& lIndex) const = 0;
 134   virtual bool GetNextEntry (wxString& str, long& lIndex) const = 0;
 135     // get number of entries/subgroups in the current group, with or without
 136     // it's subgroups
 137   virtual size_t GetNumberOfEntries(bool bRecursive = FALSE) const = 0;
 138   virtual size_t GetNumberOfGroups(bool bRecursive = FALSE) const = 0;
 139
 140   // tests of existence
 141     // returns TRUE if the group by this name exists
 142   virtual bool HasGroup(const wxString& strName) const = 0;
 143     // same as above, but for an entry
 144   virtual bool HasEntry(const wxString& strName) const = 0;
 145     // returns TRUE if either a group or an entry with a given name exist
 146   bool Exists(const wxString& strName) const
 147     { return HasGroup(strName) || HasEntry(strName); }
 148
 149   // key access: returns TRUE if value was really read, FALSE if default used
 150   // (and if the key is not found the default value is returned.)
 151     // read a string from the key
 152   virtual bool Read(const wxString& key, wxString *pStr) const = 0;
 153   virtual bool Read(const wxString& key, wxString *pStr, const wxString& defVal) const;
 154
 155   virtual wxString Read(const wxString& key, const wxString& defVal = "") const;
 156
 157   virtual bool Read(const wxString& key, long *pl) const = 0;
 158   virtual bool Read(const wxString& key, long *pl, long defVal) const;
 159
 160   virtual long Read(const wxString& strKey, long defVal) const
 161     { long l; Read(strKey, &l, defVal); return l; }
 162
 163   // Convenience functions that are built on other forms
 164
 165   // int
 166   virtual bool Read(const wxString& key, int *pi) const;
 167   virtual bool Read(const wxString& key, int *pi, int defVal) const;
 168
 169   // double
 170   virtual bool Read(const wxString& key, double* val) const;
 171   virtual bool Read(const wxString& key, double* val, double defVal) const;
 172
 173   // bool
 174   virtual bool Read(const wxString& key, bool* val) const;
 175   virtual bool Read(const wxString& key, bool* val, bool defVal) const;
 176
 177     // write the value (return true on success)
 178   virtual bool Write(const wxString& key, const wxString& value) = 0;
 179   virtual bool Write(const wxString& key, long value) = 0;
 180
 181   // Convenience functions
 182   virtual bool Write(const wxString& key, double value);
 183   virtual bool Write(const wxString& key, bool value);
 184
 185     // permanently writes all changes
 186   virtual bool Flush(bool bCurrentOnly = FALSE) = 0;
 187
 188   // renaming, all functions return FALSE on failure (probably because the new
 189   // name is already taken by an existing entry)
 190     // rename an entry
 191   virtual bool RenameEntry(const wxString& oldName,
 192                            const wxString& newName) = 0;
 193     // rename a group
 194   virtual bool RenameGroup(const wxString& oldName,
 195                            const wxString& newName) = 0;
 196
 197   // delete entries/groups
 198     // deletes the specified entry and the group it belongs to if
 199     // it was the last key in it and the second parameter is true
 200   virtual bool DeleteEntry(const wxString& key,
 201                            bool bDeleteGroupIfEmpty = TRUE) = 0;
 202     // delete the group (with all subgroups)
 203   virtual bool DeleteGroup(const wxString& key) = 0;
 204     // delete the whole underlying object (disk file, registry key, ...)
 205     // primarly for use by desinstallation routine.
 206   virtual bool DeleteAll() = 0;
 207
 208   // options
 209     // we can automatically expand environment variables in the config entries
 210     // (this option is on by default, you can turn it on/off at any time)
 211   bool IsExpandingEnvVars() const { return m_bExpandEnvVars; }
 212   void SetExpandEnvVars(bool bDoIt = TRUE) { m_bExpandEnvVars = bDoIt; }
 213     // recording of default values
 214   void SetRecordDefaults(bool bDoIt = TRUE) { m_bRecordDefaults = bDoIt; }
 215   bool IsRecordingDefaults() const { return m_bRecordDefaults; }
 216   // does expansion only if needed
 217   wxString ExpandEnvVars(const wxString& str) const;
 218
 219     // misc accessors
 220   inline wxString GetAppName() const { return m_appName; }
 221   inline wxString GetVendorName() const { return m_vendorName; }
 222
 223   inline void SetAppName(const wxString& appName) { m_appName = appName; }
 224   inline void SetVendorName(const wxString& vendorName) { m_vendorName = vendorName; }
 225
 226   inline void SetStyle(long style) { m_style = style; }
 227   inline long GetStyle() const { return m_style; }
 228
 229 protected:
 230   static bool IsImmutable(const wxString& key)
 231   #ifndef __WXMAC__
 232     { return !key.IsEmpty() && key[0u] == wxCONFIG_IMMUTABLE_PREFIX; }
 233   #else
 234     { return !key.IsEmpty() && key[0ul] == wxCONFIG_IMMUTABLE_PREFIX; }
 235   #endif
 236
 237 private:
 238   // are we doing automatic environment variable expansion?
 239   bool m_bExpandEnvVars;
 240   // do we record default values?
 241   bool m_bRecordDefaults;
 242
 243   // static variables
 244   static wxConfigBase *ms_pConfig;
 245   static bool          ms_bAutoCreate;
 246
 247   // Application name and organisation name
 248   wxString          m_appName;
 249   wxString          m_vendorName;
 250
 251   // Style flag
 252   long              m_style;
 253 };
 254
 255   // a handy little class which changes current path to the path of given entry
 256   // and restores it in dtor: so if you declare a local variable of this type,
 257   // you work in the entry directory and the path is automatically restored
 258   // when the function returns
 259   // Taken out of wxConfig since not all compilers can cope with nested classes.
 260   class wxConfigPathChanger
 261   {
 262   public:
 263     // ctor/dtor do path changing/restorin
 264     wxConfigPathChanger(const wxConfigBase *pContainer, const wxString& strEntry);
 265    ~wxConfigPathChanger();
 266
 267     // get the key name
 268     const wxString& Name() const { return m_strName; }
 269
 270   private:
 271     wxConfigBase *m_pContainer;   // object we live in
 272     wxString      m_strName,      // name of entry (i.e. name only)
 273                   m_strOldPath;   // saved path
 274     bool          m_bChanged;     // was the path changed?
 275   };
 276
 277
 278 // ----------------------------------------------------------------------------
 279 // the native wxConfigBase implementation
 280 // ----------------------------------------------------------------------------
 281
 282 // under Windows we prefer to use the native implementation
 283 #if defined(__WXMSW__) && wxCONFIG_WIN32_NATIVE
 284   #ifdef __WIN32__
 285     #define wxConfig  wxRegConfig
 286     #define sm_classwxConfig sm_classwxRegConfig
 287   #else  //WIN16
 288     #define wxConfig  wxIniConfig
 289     #define sm_classwxConfig sm_classwxIniConfig
 290   #endif
 291 #else // either we're under Unix or wish to use files even under Windows
 292   #define wxConfig  wxFileConfig
 293   #define sm_classwxConfig sm_classwxFileConfig
 294 #endif
 295
 296 #endif
 297
 298   // wxUSE_CONFIG
 299
 300 #endif
 301   // _WX_CONFIG_H_
 302