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