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 };
  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 (TODO doubles and other types such as wxDate coming soon).
  88 // ----------------------------------------------------------------------------
  89 class WXDLLEXPORT wxConfigBase
  90 {
  91 public:
  92   // constants
  93     // the type of an entry
  94   enum EntryType
  95   {
  96     Type_Unknown,
  97     Type_String,
  98     Type_Boolean,
  99     Type_Integer,    // use Read(long *)
 100     Type_Float       // use Read(double *)
 101   };
 102
 103   // static functions
 104     // sets the config object, returns the previous pointer
 105   static wxConfigBase *Set(wxConfigBase *pConfig);
 106     // get the config object, creates it on demand unless DontCreateOnDemand
 107     // was called
 108   static wxConfigBase *Get() { if ( !ms_pConfig ) Create(); return ms_pConfig; }
 109     // create a new config object: this function will create the "best"
 110     // implementation of wxConfig available for the current platform, see
 111     // comments near definition wxCONFIG_WIN32_NATIVE for details. It returns
 112     // the created object and also sets it as ms_pConfig.
 113   static wxConfigBase *Create();
 114     // should Get() try to create a new log object if the current one is NULL?
 115   static void DontCreateOnDemand() { ms_bAutoCreate = FALSE; }
 116
 117   // ctor & virtual dtor
 118       // ctor (can be used as default ctor too)
 119       //
 120       // Not all args will always be used by derived classes, but including
 121       // them all in each class ensures compatibility. If appName is empty,
 122       // uses wxApp name
 123   wxConfigBase(const wxString& appName = wxEmptyString,
 124                const wxString& vendorName = wxEmptyString,
 125                const wxString& localFilename = wxEmptyString,
 126                const wxString& globalFilename = wxEmptyString,
 127                long style = 0);
 128
 129     // empty but ensures that dtor of all derived classes is virtual
 130   virtual ~wxConfigBase() { }
 131
 132   // path management
 133     // set current path: if the first character is '/', it's the absolute path,
 134     // otherwise it's a relative path. '..' is supported. If the strPath
 135     // doesn't exist it is created.
 136   virtual void SetPath(const wxString& strPath) = 0;
 137     // retrieve the current path (always as absolute path)
 138   virtual const wxString& GetPath() const = 0;
 139
 140   // enumeration: all functions here return false when there are no more items.
 141   // you must pass the same lIndex to GetNext and GetFirst (don't modify it)
 142     // enumerate subgroups
 143   virtual bool GetFirstGroup(wxString& str, long& lIndex) const = 0;
 144   virtual bool GetNextGroup (wxString& str, long& lIndex) const = 0;
 145     // enumerate entries
 146   virtual bool GetFirstEntry(wxString& str, long& lIndex) const = 0;
 147   virtual bool GetNextEntry (wxString& str, long& lIndex) const = 0;
 148     // get number of entries/subgroups in the current group, with or without
 149     // it's subgroups
 150   virtual size_t GetNumberOfEntries(bool bRecursive = FALSE) const = 0;
 151   virtual size_t GetNumberOfGroups(bool bRecursive = FALSE) const = 0;
 152
 153   // tests of existence
 154     // returns TRUE if the group by this name exists
 155   virtual bool HasGroup(const wxString& strName) const = 0;
 156     // same as above, but for an entry
 157   virtual bool HasEntry(const wxString& strName) const = 0;
 158     // returns TRUE if either a group or an entry with a given name exist
 159   bool Exists(const wxString& strName) const
 160     { return HasGroup(strName) || HasEntry(strName); }
 161
 162     // get the entry type
 163   virtual EntryType GetEntryType(const wxString& name) const
 164   {
 165     // by default all entries are strings
 166     return HasEntry(name) ? Type_String : Type_Unknown;
 167   }
 168
 169   // key access: returns TRUE if value was really read, FALSE if default used
 170   // (and if the key is not found the default value is returned.)
 171     // read a string from the key
 172   virtual bool Read(const wxString& key, wxString *pStr) const = 0;
 173   virtual bool Read(const wxString& key, wxString *pStr, const wxString& defVal) const;
 174
 175   virtual wxString Read(const wxString& key, const wxString& defVal = wxEmptyString) const;
 176
 177   virtual bool Read(const wxString& key, long *pl) const = 0;
 178   virtual bool Read(const wxString& key, long *pl, long defVal) const;
 179
 180   virtual long Read(const wxString& strKey, long defVal) const
 181     { long l; Read(strKey, &l, defVal); return l; }
 182
 183   // Convenience functions that are built on other forms
 184
 185   // int
 186   virtual bool Read(const wxString& key, int *pi) const;
 187   virtual bool Read(const wxString& key, int *pi, int defVal) const;
 188
 189   // double
 190   virtual bool Read(const wxString& key, double* val) const;
 191   virtual bool Read(const wxString& key, double* val, double defVal) const;
 192
 193   // bool
 194   virtual bool Read(const wxString& key, bool* val) const;
 195   virtual bool Read(const wxString& key, bool* val, bool defVal) const;
 196
 197     // write the value (return true on success)
 198   virtual bool Write(const wxString& key, const wxString& value) = 0;
 199   virtual bool Write(const wxString& key, long value) = 0;
 200
 201   // Convenience functions
 202   virtual bool Write(const wxString& key, double value);
 203   virtual bool Write(const wxString& key, bool value);
 204
 205     // permanently writes all changes
 206   virtual bool Flush(bool bCurrentOnly = FALSE) = 0;
 207
 208   // renaming, all functions return FALSE on failure (probably because the new
 209   // name is already taken by an existing entry)
 210     // rename an entry
 211   virtual bool RenameEntry(const wxString& oldName,
 212                            const wxString& newName) = 0;
 213     // rename a group
 214   virtual bool RenameGroup(const wxString& oldName,
 215                            const wxString& newName) = 0;
 216
 217   // delete entries/groups
 218     // deletes the specified entry and the group it belongs to if
 219     // it was the last key in it and the second parameter is true
 220   virtual bool DeleteEntry(const wxString& key,
 221                            bool bDeleteGroupIfEmpty = TRUE) = 0;
 222     // delete the group (with all subgroups)
 223   virtual bool DeleteGroup(const wxString& key) = 0;
 224     // delete the whole underlying object (disk file, registry key, ...)
 225     // primarly for use by desinstallation routine.
 226   virtual bool DeleteAll() = 0;
 227
 228   // options
 229     // we can automatically expand environment variables in the config entries
 230     // (this option is on by default, you can turn it on/off at any time)
 231   bool IsExpandingEnvVars() const { return m_bExpandEnvVars; }
 232   void SetExpandEnvVars(bool bDoIt = TRUE) { m_bExpandEnvVars = bDoIt; }
 233     // recording of default values
 234   void SetRecordDefaults(bool bDoIt = TRUE) { m_bRecordDefaults = bDoIt; }
 235   bool IsRecordingDefaults() const { return m_bRecordDefaults; }
 236   // does expansion only if needed
 237   wxString ExpandEnvVars(const wxString& str) const;
 238
 239     // misc accessors
 240   wxString GetAppName() const { return m_appName; }
 241   wxString GetVendorName() const { return m_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