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