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