include/wx/fileconf.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        fileconf.h
   3 // Purpose:     wxFileConfig derivation of wxConfigBase
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     07.04.98 (adapted from appconf.cpp)
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1997 Karsten Ballüder   &  Vadim Zeitlin
   9 //                       Ballueder@usa.net     <zeitlin@dptmaths.ens-cachan.fr>
  10 // Licence:     wxWindows license
  11 ///////////////////////////////////////////////////////////////////////////////
  12
  13 #ifndef   _FILECONF_H
  14 #define   _FILECONF_H
  15
  16 #ifdef __GNUG__
  17 #pragma interface "fileconf.h"
  18 #endif
  19
  20 #include "wx/defs.h"
  21 #include "wx/textfile.h"
  22 #include "wx/string.h"
  23
  24 // ----------------------------------------------------------------------------
  25 // compile options
  26 // ----------------------------------------------------------------------------
  27
  28 // it won't compile without it anyhow
  29 #ifndef wxUSE_CONFIG
  30   #error "Please define wxUSE_CONFIG or remove fileconf.cpp from your makefile"
  31 #endif // wxUSE_CONFIG
  32
  33 // ----------------------------------------------------------------------------
  34 // wxFileConfig
  35 // ----------------------------------------------------------------------------
  36
  37 /*
  38   wxFileConfig derives from base Config and implements file based config class,
  39   i.e. it uses ASCII disk files to store the information. These files are
  40   alternatively called INI, .conf or .rc in the documentation. They are
  41   organized in groups or sections, which can nest (i.e. a group contains
  42   subgroups, which contain their own subgroups &c). Each group has some
  43   number of entries, which are "key = value" pairs. More precisely, the format
  44   is:
  45
  46   # comments are allowed after either ';' or '#' (Win/UNIX standard)
  47
  48   # blank lines (as above) are ignored
  49
  50   # global entries are members of special (no name) top group
  51   written_for = Windows
  52   platform    = Linux
  53
  54   # the start of the group 'Foo'
  55   [Foo]                           # may put comments like this also
  56   # following 3 lines are entries
  57   key = value
  58   another_key = "  strings with spaces in the beginning should be quoted, \
  59                    otherwise the spaces are lost"
  60   last_key = but you don't have to put " normally (nor quote them, like here)
  61
  62   # subgroup of the group 'Foo'
  63   # (order is not important, only the name is: separator is '/', as in paths)
  64   [Foo/Bar]
  65   # entries prefixed with "!" are immutable, i.e. can't be changed if they are
  66   # set in the system-wide config file
  67   !special_key = value
  68   bar_entry = whatever
  69
  70   [Foo/Bar/Fubar]   # depth is (theoretically :-) unlimited
  71   # may have the same name as key in another section
  72   bar_entry = whatever not
  73
  74   You have {read/write/delete}Entry functions (guess what they do) and also
  75   setCurrentPath to select current group. enum{Subgroups/Entries} allow you
  76   to get all entries in the config file (in the current group). Finally,
  77   flush() writes immediately all changed entries to disk (otherwise it would
  78   be done automatically in dtor)
  79
  80   wxFileConfig manages not less than 2 config files for each program: global
  81   and local (or system and user if you prefer). Entries are read from both of
  82   them and the local entries override the global ones unless the latter is
  83   immutable (prefixed with '!') in which case a warning message is generated
  84   and local value is ignored. Of course, the changes are always written to local
  85   file only.
  86
  87   The names of these files can be specified in a number of ways. First of all,
  88   you can use the standard convention: using the ctor which takes 'strAppName'
  89   parameter will probably be sufficient for 90% of cases. If, for whatever
  90   reason you wish to use the files with some other names, you can always use the
  91   second ctor.
  92
  93   wxFileConfig also may automatically expand the values of environment variables
  94   in the entries it reads: for example, if you have an entry
  95     score_file = $HOME/.score
  96   a call to Read(&str, "score_file") will return a complete path to .score file
  97   unless the expansion was previousle disabled with SetExpandEnvVars(FALSE) call
  98   (it's on by default, the current status can be retrieved with
  99    IsExpandingEnvVars function).
 100 */
 101
 102 class wxFileConfig : public wxConfigBase
 103 {
 104 public:
 105   // construct the "standard" full name for global (system-wide) and
 106   // local (user-specific) config files from the base file name.
 107   //
 108   // the following are the filenames returned by this functions:
 109   //            global                local
 110   // Unix   /etc/file.ext           ~/.file
 111   // Win    %windir%\file.ext   %USERPROFILE%\file.ext
 112   //
 113   // where file is the basename of szFile, ext is it's extension
 114   // or .conf (Unix) or .ini (Win) if it has none
 115   static wxString GetGlobalFileName(const char *szFile);
 116   static wxString GetLocalFileName(const char *szFile);
 117
 118   // ctor & dtor
 119
 120 #if 0
 121     // the names of local and global (if not disabled) config files are
 122     // constructed using Get{Local|Global}FileName functions described above
 123     // (szAppName is just the (short) name of your application)
 124   wxFileConfig(const char *szAppName, bool bLocalOnly = FALSE);
 125     // this ctor allows you to specify custom names for both files (if strGlobal
 126     // isn't a full path, it's considered to be relative to the standard
 127     // directory, i.e. /etc under Unix and %windir% under Windows, if strLocal
 128     // is not an absolute path, it's considered to be relative to the user's
 129     // directory). If either of strings is empty, the corresponding file is not
 130     // used.
 131   wxFileConfig(const wxString& strLocal, const wxString& strGlobal);
 132 #endif
 133
 134    // New constructor: one size fits all. Specify wxCONFIG_USE_LOCAL_FILE
 135    // or wxCONFIG_USE_GLOBAL_FILE to say which files should be used.
 136   wxFileConfig(const wxString& appName, const wxString& vendorName = "",
 137                const wxString& localFilename = "", const wxString& globalFilename = "",
 138                long style = wxCONFIG_USE_LOCAL_FILE);
 139
 140     // dtor will save unsaved data
 141   virtual ~wxFileConfig();
 142
 143   // implement inherited pure virtual functions
 144   virtual void SetPath(const wxString& strPath);
 145   virtual const wxString& GetPath() const { return m_strPath; }
 146
 147   virtual bool GetFirstGroup(wxString& str, long& lIndex) const;
 148   virtual bool GetNextGroup (wxString& str, long& lIndex) const;
 149   virtual bool GetFirstEntry(wxString& str, long& lIndex) const;
 150   virtual bool GetNextEntry (wxString& str, long& lIndex) const;
 151
 152   virtual size_t GetNumberOfEntries(bool bRecursive = FALSE) const;
 153   virtual size_t GetNumberOfGroups(bool bRecursive = FALSE) const;
 154
 155   virtual bool HasGroup(const wxString& strName) const;
 156   virtual bool HasEntry(const wxString& strName) const;
 157
 158   virtual bool Read(const wxString& key, wxString *pStr) const;
 159   virtual bool Read(const wxString& key, wxString *pStr, const wxString& defValue) const;
 160   virtual bool Read(const wxString& key, long *pl) const;
 161
 162   // The following are necessary to satisfy the compiler
 163   wxString Read(const wxString& key, const wxString& defVal) const
 164   { return wxConfigBase::Read(key, defVal); }
 165   bool Read(const wxString& key, long *pl, long defVal) const
 166   { return wxConfigBase::Read(key, pl, defVal); }
 167   long Read(const wxString& key, long defVal) const
 168   { return wxConfigBase::Read(key, defVal); }
 169   bool Read(const wxString& key, int *pi, int defVal) const
 170     { return wxConfigBase::Read(key, pi, defVal); }
 171   bool Read(const wxString& key, int *pi) const
 172     { return wxConfigBase::Read(key, pi); }
 173   bool Read(const wxString& key, double* val) const
 174   { return wxConfigBase::Read(key, val); }
 175   bool Read(const wxString& key, double* val, double defVal) const
 176   { return wxConfigBase::Read(key, val, defVal); }
 177
 178   virtual bool Write(const wxString& key, const wxString& szValue);
 179   virtual bool Write(const wxString& key, long lValue);
 180
 181   virtual bool Flush(bool bCurrentOnly = FALSE);
 182
 183   virtual bool DeleteEntry(const wxString& key, bool bGroupIfEmptyAlso);
 184   virtual bool DeleteGroup(const wxString& szKey);
 185   virtual bool DeleteAll();
 186
 187 public:
 188   // fwd decl
 189   class ConfigGroup;
 190   class ConfigEntry;
 191
 192   // we store all lines of the local config file as a linked list in memory
 193   class LineList
 194   {
 195   public:
 196     void      SetNext(LineList *pNext)  { m_pNext = pNext; }
 197     void      SetPrev(LineList *pPrev)  { m_pPrev = pPrev; }
 198
 199     // ctor
 200     LineList(const wxString& str, LineList *pNext = (LineList *) NULL) : m_strLine(str)
 201       { SetNext(pNext); SetPrev((LineList *) NULL); }
 202
 203     //
 204     LineList *Next() const              { return m_pNext;  }
 205     LineList *Prev() const              { return m_pPrev;  }
 206
 207     //
 208     void SetText(const wxString& str) { m_strLine = str;  }
 209     const wxString& Text() const      { return m_strLine; }
 210
 211   private:
 212     wxString  m_strLine;      // line contents
 213     LineList *m_pNext,        // next node
 214              *m_pPrev;        // previous one
 215   };
 216
 217   // functions to work with this list
 218   LineList *LineListAppend(const wxString& str);
 219   LineList *LineListInsert(const wxString& str,
 220                            LineList *pLine);    // NULL => Prepend()
 221   void      LineListRemove(LineList *pLine);
 222   bool      LineListIsEmpty();
 223
 224 private:
 225   // GetXXXFileame helpers: return ('/' terminated) directory names
 226   static wxString GetGlobalDir();
 227   static wxString GetLocalDir();
 228
 229   // common part of all ctors (assumes that m_str{Local|Global}File are already
 230   // initialized
 231   void Init();
 232
 233   // common part of from dtor and DeleteAll
 234   void CleanUp();
 235
 236   // parse the whole file
 237   void Parse(wxTextFile& file, bool bLocal);
 238
 239   // the same as SetPath("/")
 240   void SetRootPath();
 241
 242   // member variables
 243   // ----------------
 244   LineList   *m_linesHead,        // head of the linked list
 245              *m_linesTail;        // tail
 246
 247   wxString    m_strLocalFile,     // local  file name passed to ctor
 248               m_strGlobalFile;    // global
 249   wxString    m_strPath;          // current path (not '/' terminated)
 250
 251   ConfigGroup *m_pRootGroup,      // the top (unnamed) group
 252               *m_pCurrentGroup;   // the current group
 253
 254 //protected: --- if wxFileConfig::ConfigEntry is not public, functions in
 255 //               ConfigGroup such as Find/AddEntry can't return "ConfigEntry *"
 256 public:
 257   WX_DEFINE_SORTED_ARRAY(ConfigEntry *, ArrayEntries);
 258   WX_DEFINE_SORTED_ARRAY(ConfigGroup *, ArrayGroups);
 259
 260   class ConfigEntry
 261   {
 262   private:
 263     ConfigGroup  *m_pParent;      // group that contains us
 264     wxString      m_strName,      // entry name
 265                   m_strValue;     //       value
 266     bool          m_bDirty,       // changed since last read?
 267                   m_bImmutable;   // can be overriden locally?
 268     int           m_nLine;        // used if m_pLine == NULL only
 269     LineList     *m_pLine;        // pointer to our line in the linked list
 270                                   // or NULL if it was found in global file
 271
 272   public:
 273     ConfigEntry(ConfigGroup *pParent, const wxString& strName, int nLine);
 274
 275     // simple accessors
 276     const wxString& Name()        const { return m_strName;    }
 277     const wxString& Value()       const { return m_strValue;   }
 278     ConfigGroup    *Group()       const { return m_pParent;    }
 279     bool            IsDirty()     const { return m_bDirty;     }
 280     bool            IsImmutable() const { return m_bImmutable; }
 281     bool            IsLocal()     const { return m_pLine != 0; }
 282     int             Line()        const { return m_nLine;      }
 283     LineList       *GetLine()     const { return m_pLine;      }
 284
 285     // modify entry attributes
 286     void SetValue(const wxString& strValue, bool bUser = TRUE);
 287     void SetDirty();
 288     void SetLine(LineList *pLine);
 289   };
 290
 291   class ConfigGroup
 292   {
 293   private:
 294     wxFileConfig *m_pConfig;        // config object we belong to
 295     ConfigGroup  *m_pParent;        // parent group (NULL for root group)
 296     ArrayEntries  m_aEntries;       // entries in this group
 297     ArrayGroups   m_aSubgroups;     // subgroups
 298     wxString      m_strName;        // group's name
 299     bool          m_bDirty;         // if FALSE => all subgroups are not dirty
 300     LineList     *m_pLine;          // pointer to our line in the linked list
 301     ConfigEntry  *m_pLastEntry;     // last entry/subgroup of this group in the
 302     ConfigGroup  *m_pLastGroup;     // local file (we insert new ones after it)
 303
 304     // DeleteSubgroupByName helper
 305     bool DeleteSubgroup(ConfigGroup *pGroup);
 306
 307   public:
 308     // ctor
 309     ConfigGroup(ConfigGroup *pParent, const wxString& strName, wxFileConfig *);
 310
 311     // dtor deletes all entries and subgroups also
 312     ~ConfigGroup();
 313
 314     // simple accessors
 315     const wxString& Name()    const { return m_strName; }
 316     ConfigGroup    *Parent()  const { return m_pParent; }
 317     wxFileConfig   *Config()  const { return m_pConfig; }
 318     bool            IsDirty() const { return m_bDirty;  }
 319
 320     const ArrayEntries& Entries() const { return m_aEntries;   }
 321     const ArrayGroups&  Groups()  const { return m_aSubgroups; }
 322     bool  IsEmpty() const { return Entries().IsEmpty() && Groups().IsEmpty(); }
 323
 324     // find entry/subgroup (NULL if not found)
 325     ConfigGroup *FindSubgroup(const char *szName) const;
 326     ConfigEntry *FindEntry   (const char *szName) const;
 327
 328     // delete entry/subgroup, return FALSE if doesn't exist
 329     bool DeleteSubgroupByName(const char *szName);
 330     bool DeleteEntry(const char *szName);
 331
 332     // create new entry/subgroup returning pointer to newly created element
 333     ConfigGroup *AddSubgroup(const wxString& strName);
 334     ConfigEntry *AddEntry   (const wxString& strName, int nLine = NOT_FOUND);
 335
 336     // will also recursively set parent's dirty flag
 337     void SetDirty();
 338     void SetLine(LineList *pLine);
 339
 340     //
 341     wxString GetFullName() const;
 342
 343     // get the last line belonging to an entry/subgroup of this group
 344     LineList *GetGroupLine();     // line which contains [group]
 345     LineList *GetLastEntryLine(); // after which our subgroups start
 346     LineList *GetLastGroupLine(); // after which the next group starts
 347
 348     // called by entries/subgroups when they're created/deleted
 349     void SetLastEntry(ConfigEntry *pEntry) { m_pLastEntry = pEntry; }
 350     void SetLastGroup(ConfigGroup *pGroup) { m_pLastGroup = pGroup; }
 351   };
 352 };
 353
 354 #endif  //_FILECONF_H
 355