1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: include/wx/msw/iniconf.h
3 // Purpose: INI-file based wxConfigBase implementation
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
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]
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.
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 // ----------------------------------------------------------------------------
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 WXDLLEXPORT wxIniConfig
: public wxConfigBase
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
= wxEmptyString
, const wxString
& strVendor
= wxEmptyString
,
47 const wxString
& localFilename
= wxEmptyString
, const wxString
& globalFilename
= wxEmptyString
, long style
= wxCONFIG_USE_LOCAL_FILE
);
48 virtual ~wxIniConfig();
50 // implement inherited pure virtual functions
51 virtual void SetPath(const wxString
& strPath
);
52 virtual const wxString
& GetPath() const;
54 virtual bool GetFirstGroup(wxString
& str
, long& lIndex
) const;
55 virtual bool GetNextGroup (wxString
& str
, long& lIndex
) const;
56 virtual bool GetFirstEntry(wxString
& str
, long& lIndex
) const;
57 virtual bool GetNextEntry (wxString
& str
, long& lIndex
) const;
59 virtual size_t GetNumberOfEntries(bool bRecursive
= FALSE
) const;
60 virtual size_t GetNumberOfGroups(bool bRecursive
= FALSE
) const;
62 virtual bool HasGroup(const wxString
& strName
) const;
63 virtual bool HasEntry(const wxString
& strName
) const;
65 // return TRUE if the current group is empty
68 virtual bool Flush(bool bCurrentOnly
= FALSE
);
70 virtual bool RenameEntry(const wxString
& oldName
, const wxString
& newName
);
71 virtual bool RenameGroup(const wxString
& oldName
, const wxString
& newName
);
73 virtual bool DeleteEntry(const wxString
& Key
, bool bGroupIfEmptyAlso
= TRUE
);
74 virtual bool DeleteGroup(const wxString
& szKey
);
75 virtual bool DeleteAll();
79 bool DoReadString(const wxString
& key
, wxString
*pStr
) const;
80 bool DoReadLong(const wxString
& key
, long *plResult
) const;
82 bool DoWriteString(const wxString
& key
, const wxString
& szValue
);
83 bool DoWriteLong(const wxString
& key
, long lValue
);
87 wxString
GetPrivateKeyName(const wxString
& szKey
) const;
88 wxString
GetKeyName(const wxString
& szKey
) const;
90 wxString m_strLocalFilename
; // name of the private INI file
91 wxString m_strGroup
, // current group in appname.ini file
92 m_strPath
; // the rest of the path (no trailing '_'!)