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