include/wx/msw/iniconf.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        include/wx/msw/iniconf.h
   3 // Purpose:     INI-file based wxConfigBase implementation
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     27.07.98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef   _INICONF_H
  13 #define   _INICONF_H
  14
  15 // ----------------------------------------------------------------------------
  16 // wxIniConfig is a wxConfig implementation which uses MS Windows INI files to
  17 // store the data. Because INI files don't really support arbitrary nesting of
  18 // groups, we do the following:
  19 //  (1) in win.ini file we store all entries in the [vendor] section and
  20 //      the value group1/group2/key is mapped to the value group1_group2_key
  21 //      in this section, i.e. all path separators are replaced with underscore
  22 //  (2) in appname.ini file we map group1/group2/group3/key to the entry
  23 //      group2_group3_key in [group1]
  24 //
  25 // Of course, it might lead to indesirable results if '_' is also used in key
  26 // names (i.e. group/key is the same as group_key) and also GetPath() result
  27 // may be not what you would expect it to be.
  28 //
  29 // Another limitation: the keys and section names are never case-sensitive
  30 // which might differ from wxFileConfig it it was compiled with
  31 // wxCONFIG_CASE_SENSITIVE option.
  32 // ----------------------------------------------------------------------------
  33
  34 // for this class, "local" file is the file appname.ini and the global file
  35 // is the [vendor] subsection of win.ini (default for "vendor" is to be the
  36 // same as appname). The file name (strAppName parameter) may, in fact,
  37 // contain the full path to the file. If it doesn't, the file is searched for
  38 // in the Windows directory.
  39 class wxIniConfig : public wxConfigBase
  40 {
  41 public:
  42   // ctor & dtor
  43     // if strAppName doesn't contain the extension and is not an absolute path,
  44     // ".ini" is appended to it. if strVendor is empty, it's taken to be the
  45     // same as strAppName.
  46   wxIniConfig(const wxString& strAppName, const wxString& strVendor = "");
  47   virtual ~wxIniConfig();
  48
  49   // implement inherited pure virtual functions
  50   virtual void SetPath(const wxString& strPath);
  51   virtual const wxString& GetPath() const;
  52
  53   virtual bool GetFirstGroup(wxString& str, long& lIndex) const;
  54   virtual bool GetNextGroup (wxString& str, long& lIndex) const;
  55   virtual bool GetFirstEntry(wxString& str, long& lIndex) const;
  56   virtual bool GetNextEntry (wxString& str, long& lIndex) const;
  57
  58   virtual uint GetNumberOfEntries(bool bRecursive = FALSE) const;
  59   virtual uint GetNumberOfGroups(bool bRecursive = FALSE) const;
  60
  61   virtual bool HasGroup(const wxString& strName) const;
  62   virtual bool HasEntry(const wxString& strName) const;
  63
  64   // return TRUE if the current group is empty
  65   bool IsEmpty() const;
  66
  67   virtual bool Read(wxString *pstr, const char *szKey,
  68                     const char *szDefault = 0) const;
  69   virtual const char *Read(const char *szKey,
  70                            const char *szDefault = 0) const;
  71   virtual bool Read(long *pl, const char *szKey, long lDefault) const;
  72   virtual long Read(const char *szKey, long lDefault) const;
  73   virtual bool Write(const char *szKey, const char *szValue);
  74   virtual bool Write(const char *szKey, long lValue);
  75   virtual bool Flush(bool bCurrentOnly = FALSE);
  76
  77   virtual bool DeleteEntry(const char *szKey, bool bGroupIfEmptyAlso);
  78   virtual bool DeleteGroup(const char *szKey);
  79   virtual bool DeleteAll();
  80
  81 private:
  82   // helpers
  83   wxString GetPrivateKeyName(const char *szKey) const;
  84   wxString GetKeyName(const char *szKey) const;
  85
  86   wxString m_strAppName,  // name of the private INI file
  87            m_strVendor;   // name of our section in WIN.INI
  88   wxString m_strGroup,    // current group in appname.ini file
  89            m_strPath;     // the rest of the path (no trailing '_'!)
  90 };
  91
  92 #endif  //_INICONF_H