1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxFileConfig derivation of wxConfigBase
4 // Author: Vadim Zeitlin
6 // Created: 07.04.98 (adapted from appconf.cpp)
8 // Copyright: (c) 1997 Karsten Ballüder & Vadim Zeitlin
9 // Ballueder@usa.net <zeitlin@dptmaths.ens-cachan.fr>
10 // Licence: wxWindows licence
11 ///////////////////////////////////////////////////////////////////////////////
16 #if defined(__GNUG__) && !defined(__APPLE__)
17 #pragma interface "fileconf.h"
24 #include "wx/textfile.h"
25 #include "wx/string.h"
27 // ----------------------------------------------------------------------------
29 // ----------------------------------------------------------------------------
32 wxFileConfig derives from base Config and implements file based config class,
33 i.e. it uses ASCII disk files to store the information. These files are
34 alternatively called INI, .conf or .rc in the documentation. They are
35 organized in groups or sections, which can nest (i.e. a group contains
36 subgroups, which contain their own subgroups &c). Each group has some
37 number of entries, which are "key = value" pairs. More precisely, the format
40 # comments are allowed after either ';' or '#' (Win/UNIX standard)
42 # blank lines (as above) are ignored
44 # global entries are members of special (no name) top group
48 # the start of the group 'Foo'
49 [Foo] # may put comments like this also
50 # following 3 lines are entries
52 another_key = " strings with spaces in the beginning should be quoted, \
53 otherwise the spaces are lost"
54 last_key = but you don't have to put " normally (nor quote them, like here)
56 # subgroup of the group 'Foo'
57 # (order is not important, only the name is: separator is '/', as in paths)
59 # entries prefixed with "!" are immutable, i.e. can't be changed if they are
60 # set in the system-wide config file
64 [Foo/Bar/Fubar] # depth is (theoretically :-) unlimited
65 # may have the same name as key in another section
66 bar_entry = whatever not
68 You have {read/write/delete}Entry functions (guess what they do) and also
69 setCurrentPath to select current group. enum{Subgroups/Entries} allow you
70 to get all entries in the config file (in the current group). Finally,
71 flush() writes immediately all changed entries to disk (otherwise it would
72 be done automatically in dtor)
74 wxFileConfig manages not less than 2 config files for each program: global
75 and local (or system and user if you prefer). Entries are read from both of
76 them and the local entries override the global ones unless the latter is
77 immutable (prefixed with '!') in which case a warning message is generated
78 and local value is ignored. Of course, the changes are always written to local
81 The names of these files can be specified in a number of ways. First of all,
82 you can use the standard convention: using the ctor which takes 'strAppName'
83 parameter will probably be sufficient for 90% of cases. If, for whatever
84 reason you wish to use the files with some other names, you can always use the
87 wxFileConfig also may automatically expand the values of environment variables
88 in the entries it reads: for example, if you have an entry
89 score_file = $HOME/.score
90 a call to Read(&str, "score_file") will return a complete path to .score file
91 unless the expansion was previousle disabled with SetExpandEnvVars(FALSE) call
92 (it's on by default, the current status can be retrieved with
93 IsExpandingEnvVars function).
95 class WXDLLEXPORT_BASE wxFileConfigGroup
;
96 class WXDLLEXPORT_BASE wxFileConfigEntry
;
97 class WXDLLEXPORT_BASE wxFileConfigLineList
;
98 class WXDLLEXPORT_BASE wxInputStream
;
100 class WXDLLEXPORT_BASE wxFileConfig
: public wxConfigBase
103 // construct the "standard" full name for global (system-wide) and
104 // local (user-specific) config files from the base file name.
106 // the following are the filenames returned by this functions:
108 // Unix /etc/file.ext ~/.file
109 // Win %windir%\file.ext %USERPROFILE%\file.ext
111 // where file is the basename of szFile, ext is it's extension
112 // or .conf (Unix) or .ini (Win) if it has none
113 static wxString
GetGlobalFileName(const wxChar
*szFile
);
114 static wxString
GetLocalFileName(const wxChar
*szFile
);
117 // New constructor: one size fits all. Specify wxCONFIG_USE_LOCAL_FILE or
118 // wxCONFIG_USE_GLOBAL_FILE to say which files should be used.
119 wxFileConfig(const wxString
& appName
= wxT(""),
120 const wxString
& vendorName
= wxT(""),
121 const wxString
& localFilename
= wxT(""),
122 const wxString
& globalFilename
= wxT(""),
123 long style
= wxCONFIG_USE_LOCAL_FILE
,
124 wxMBConv
& conv
= wxConvUTF8
);
127 // ctor that takes an input stream.
128 wxFileConfig(wxInputStream
&inStream
,
129 wxMBConv
& conv
= wxConvUTF8
);
130 #endif // wxUSE_STREAMS
132 // dtor will save unsaved data
133 virtual ~wxFileConfig();
135 // under Unix, set the umask to be used for the file creation, do nothing
136 // under other systems
138 void SetUmask(int mode
) { m_umask
= mode
; }
140 void SetUmask(int WXUNUSED(mode
)) { }
141 #endif // __UNIX__/!__UNIX__
143 // implement inherited pure virtual functions
144 virtual void SetPath(const wxString
& strPath
);
145 virtual const wxString
& GetPath() const { return m_strPath
; }
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;
152 virtual size_t GetNumberOfEntries(bool bRecursive
= FALSE
) const;
153 virtual size_t GetNumberOfGroups(bool bRecursive
= FALSE
) const;
155 virtual bool HasGroup(const wxString
& strName
) const;
156 virtual bool HasEntry(const wxString
& strName
) const;
158 virtual bool Flush(bool bCurrentOnly
= FALSE
);
160 virtual bool RenameEntry(const wxString
& oldName
, const wxString
& newName
);
161 virtual bool RenameGroup(const wxString
& oldName
, const wxString
& newName
);
163 virtual bool DeleteEntry(const wxString
& key
, bool bGroupIfEmptyAlso
= TRUE
);
164 virtual bool DeleteGroup(const wxString
& szKey
);
165 virtual bool DeleteAll();
168 // functions to work with this list
169 wxFileConfigLineList
*LineListAppend(const wxString
& str
);
170 wxFileConfigLineList
*LineListInsert(const wxString
& str
,
171 wxFileConfigLineList
*pLine
); // NULL => Prepend()
172 void LineListRemove(wxFileConfigLineList
*pLine
);
173 bool LineListIsEmpty();
176 virtual bool DoReadString(const wxString
& key
, wxString
*pStr
) const;
177 virtual bool DoReadLong(const wxString
& key
, long *pl
) const;
179 virtual bool DoWriteString(const wxString
& key
, const wxString
& szValue
);
180 virtual bool DoWriteLong(const wxString
& key
, long lValue
);
183 // GetXXXFileName helpers: return ('/' terminated) directory names
184 static wxString
GetGlobalDir();
185 static wxString
GetLocalDir();
187 // common part of all ctors (assumes that m_str{Local|Global}File are already
191 // common part of from dtor and DeleteAll
194 // parse the whole file
195 void Parse(wxTextBuffer
& buffer
, bool bLocal
);
197 // the same as SetPath("/")
202 wxFileConfigLineList
*m_linesHead
, // head of the linked list
203 *m_linesTail
; // tail
205 wxString m_strLocalFile
, // local file name passed to ctor
206 m_strGlobalFile
; // global
207 wxString m_strPath
; // current path (not '/' terminated)
209 wxFileConfigGroup
*m_pRootGroup
, // the top (unnamed) group
210 *m_pCurrentGroup
; // the current group
215 int m_umask
; // the umask to use for file creation
218 DECLARE_NO_COPY_CLASS(wxFileConfig
)