1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: implementation of wxFileConfig derivation of wxConfig
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 license
11 ///////////////////////////////////////////////////////////////////////////////
14 #pragma implementation "fileconf.h"
17 // ============================================================================
19 // ============================================================================
21 // ----------------------------------------------------------------------------
23 // ----------------------------------------------------------------------------
24 #include "wx/wxprec.h"
31 #include "wx/string.h"
36 #include "wx/dynarray.h"
39 #include "wx/textfile.h"
40 #include "wx/config.h"
41 #include "wx/fileconf.h"
43 #include "wx/utils.h" // for wxGetHomeDir
45 // _WINDOWS_ is defined when windows.h is included,
46 // __WXMSW__ is defined for MS Windows compilation
47 #if defined(__WXMSW__) && !defined(_WINDOWS_)
54 // ----------------------------------------------------------------------------
56 // ----------------------------------------------------------------------------
57 #define CONST_CAST ((wxFileConfig *)this)->
59 // ----------------------------------------------------------------------------
61 // ----------------------------------------------------------------------------
66 // ----------------------------------------------------------------------------
67 // global functions declarations
68 // ----------------------------------------------------------------------------
70 // compare functions for sorting the arrays
71 static int CompareEntries(ConfigEntry
*p1
, ConfigEntry
*p2
);
72 static int CompareGroups(ConfigGroup
*p1
, ConfigGroup
*p2
);
75 static wxString
FilterInValue(const wxString
& str
);
76 static wxString
FilterOutValue(const wxString
& str
);
78 static wxString
FilterInEntryName(const wxString
& str
);
79 static wxString
FilterOutEntryName(const wxString
& str
);
81 // ============================================================================
83 // ============================================================================
85 // ----------------------------------------------------------------------------
87 // ----------------------------------------------------------------------------
88 wxString
wxFileConfig::GetGlobalDir()
94 #elif defined(__WXSTUBS__)
95 wxASSERT_MSG( FALSE
, "TODO" ) ;
96 #elif defined(__WXMAC__)
97 wxASSERT_MSG( FALSE
, "TODO" ) ;
99 char szWinDir
[MAX_PATH
];
100 ::GetWindowsDirectory(szWinDir
, MAX_PATH
);
104 #endif // Unix/Windows
109 wxString
wxFileConfig::GetLocalDir()
113 wxGetHomeDir(&strDir
);
116 if (strDir
.Last() != '/') strDir
<< '/';
118 if (strDir
.Last() != '\\') strDir
<< '\\';
124 wxString
wxFileConfig::GetGlobalFileName(const char *szFile
)
126 wxString str
= GetGlobalDir();
129 if ( strchr(szFile
, '.') == NULL
)
139 wxString
wxFileConfig::GetLocalFileName(const char *szFile
)
141 wxString str
= GetLocalDir();
150 if ( strchr(szFile
, '.') == NULL
)
157 // ----------------------------------------------------------------------------
159 // ----------------------------------------------------------------------------
161 void wxFileConfig::Init()
164 m_pRootGroup
= new ConfigGroup(NULL
, "", this);
169 // it's not an error if (one of the) file(s) doesn't exist
171 // parse the global file
172 if ( !m_strGlobalFile
.IsEmpty() && wxFile::Exists(m_strGlobalFile
) ) {
173 wxTextFile
fileGlobal(m_strGlobalFile
);
175 if ( fileGlobal
.Open() ) {
176 Parse(fileGlobal
, FALSE
/* global */);
180 wxLogWarning(_("can't open global configuration file '%s'."),
181 m_strGlobalFile
.c_str());
184 // parse the local file
185 if ( !m_strLocalFile
.IsEmpty() && wxFile::Exists(m_strLocalFile
) ) {
186 wxTextFile
fileLocal(m_strLocalFile
);
187 if ( fileLocal
.Open() ) {
188 Parse(fileLocal
, TRUE
/* local */);
192 wxLogWarning(_("can't open user configuration file '%s'."),
193 m_strLocalFile
.c_str());
197 // constructor supports creation of wxFileConfig objects of any type
198 wxFileConfig::wxFileConfig(const wxString
& appName
, const wxString
& vendorName
,
199 const wxString
& strLocal
, const wxString
& strGlobal
,
201 : wxConfigBase(appName
, vendorName
, strLocal
, strGlobal
, style
),
202 m_strLocalFile(strLocal
), m_strGlobalFile(strGlobal
)
204 // Make up an application name if not supplied
205 if (appName
.IsEmpty() && wxTheApp
)
207 SetAppName(wxTheApp
->GetAppName());
210 // Make up names for files if empty
211 if ( m_strLocalFile
.IsEmpty() && (style
& wxCONFIG_USE_LOCAL_FILE
) )
213 m_strLocalFile
= GetLocalFileName(GetAppName());
216 if ( m_strGlobalFile
.IsEmpty() && (style
& wxCONFIG_USE_GLOBAL_FILE
) )
218 m_strGlobalFile
= GetGlobalFileName(GetAppName());
221 // Check if styles are not supplied, but filenames are, in which case
222 // add the correct styles.
223 if ( !m_strLocalFile
.IsEmpty() )
224 SetStyle(GetStyle() | wxCONFIG_USE_LOCAL_FILE
);
226 if ( !m_strGlobalFile
.IsEmpty() )
227 SetStyle(GetStyle() | wxCONFIG_USE_GLOBAL_FILE
);
229 // if the path is not absolute, prepend the standard directory to it
230 if ( !m_strLocalFile
.IsEmpty() && !wxIsAbsolutePath(m_strLocalFile
) )
232 wxString strLocal
= m_strLocalFile
;
233 m_strLocalFile
= GetLocalDir();
234 m_strLocalFile
<< strLocal
;
237 if ( !m_strGlobalFile
.IsEmpty() && !wxIsAbsolutePath(m_strGlobalFile
) )
239 wxString strGlobal
= m_strGlobalFile
;
240 m_strGlobalFile
= GetGlobalDir();
241 m_strGlobalFile
<< strGlobal
;
247 void wxFileConfig::CleanUp()
251 LineList
*pCur
= m_linesHead
;
252 while ( pCur
!= NULL
) {
253 LineList
*pNext
= pCur
->Next();
259 wxFileConfig::~wxFileConfig()
266 // ----------------------------------------------------------------------------
267 // parse a config file
268 // ----------------------------------------------------------------------------
270 void wxFileConfig::Parse(wxTextFile
& file
, bool bLocal
)
276 size_t nLineCount
= file
.GetLineCount();
277 for ( size_t n
= 0; n
< nLineCount
; n
++ ) {
280 // add the line to linked list
282 LineListAppend(strLine
);
284 // skip leading spaces
285 for ( pStart
= strLine
; isspace(*pStart
); pStart
++ )
288 // skip blank/comment lines
289 if ( *pStart
== '\0'|| *pStart
== ';' || *pStart
== '#' )
292 if ( *pStart
== '[' ) { // a new group
295 while ( *++pEnd
!= ']' ) {
296 if ( *pEnd
== '\n' || *pEnd
== '\0' )
300 if ( *pEnd
!= ']' ) {
301 wxLogError(_("file '%s': unexpected character %c at line %d."),
302 file
.GetName(), *pEnd
, n
+ 1);
303 continue; // skip this line
306 // group name here is always considered as abs path
309 strGroup
<< wxCONFIG_PATH_SEPARATOR
310 << FilterInEntryName(wxString(pStart
, pEnd
- pStart
));
312 // will create it if doesn't yet exist
316 m_pCurrentGroup
->SetLine(m_linesTail
);
318 // check that there is nothing except comments left on this line
320 while ( *++pEnd
!= '\0' && bCont
) {
329 // ignore whitespace ('\n' impossible here)
333 wxLogWarning(_("file '%s', line %d: '%s' "
334 "ignored after group header."),
335 file
.GetName(), n
+ 1, pEnd
);
341 const char *pEnd
= pStart
;
342 while ( !isspace(*pEnd
) ) {
343 if ( *pEnd
== '\\' ) {
344 // next character may be space or not - still take it because it's
352 wxString
strKey(FilterInEntryName(wxString(pStart
, pEnd
)));
355 while ( isspace(*pEnd
) )
358 if ( *pEnd
++ != '=' ) {
359 wxLogError(_("file '%s', line %d: '=' expected."),
360 file
.GetName(), n
+ 1);
363 ConfigEntry
*pEntry
= m_pCurrentGroup
->FindEntry(strKey
);
365 if ( pEntry
== NULL
) {
367 pEntry
= m_pCurrentGroup
->AddEntry(strKey
, n
);
370 pEntry
->SetLine(m_linesTail
);
373 if ( bLocal
&& pEntry
->IsImmutable() ) {
374 // immutable keys can't be changed by user
375 wxLogWarning(_("file '%s', line %d: value for "
376 "immutable key '%s' ignored."),
377 file
.GetName(), n
+ 1, strKey
.c_str());
380 // the condition below catches the cases (a) and (b) but not (c):
381 // (a) global key found second time in global file
382 // (b) key found second (or more) time in local file
383 // (c) key from global file now found in local one
384 // which is exactly what we want.
385 else if ( !bLocal
|| pEntry
->IsLocal() ) {
386 wxLogWarning(_("file '%s', line %d: key '%s' was first "
387 "found at line %d."),
388 file
.GetName(), n
+ 1, strKey
.c_str(), pEntry
->Line());
391 pEntry
->SetLine(m_linesTail
);
396 while ( isspace(*pEnd
) )
399 pEntry
->SetValue(FilterInValue(pEnd
), FALSE
/* read from file */);
405 // ----------------------------------------------------------------------------
407 // ----------------------------------------------------------------------------
409 void wxFileConfig::SetRootPath()
412 m_pCurrentGroup
= m_pRootGroup
;
415 void wxFileConfig::SetPath(const wxString
& strPath
)
417 wxArrayString aParts
;
419 if ( strPath
.IsEmpty() ) {
424 if ( strPath
[0] == wxCONFIG_PATH_SEPARATOR
) {
426 wxSplitPath(aParts
, strPath
);
429 // relative path, combine with current one
430 wxString strFullPath
= m_strPath
;
431 strFullPath
<< wxCONFIG_PATH_SEPARATOR
<< strPath
;
432 wxSplitPath(aParts
, strFullPath
);
435 // change current group
437 m_pCurrentGroup
= m_pRootGroup
;
438 for ( n
= 0; n
< aParts
.Count(); n
++ ) {
439 ConfigGroup
*pNextGroup
= m_pCurrentGroup
->FindSubgroup(aParts
[n
]);
440 if ( pNextGroup
== NULL
)
441 pNextGroup
= m_pCurrentGroup
->AddSubgroup(aParts
[n
]);
442 m_pCurrentGroup
= pNextGroup
;
445 // recombine path parts in one variable
447 for ( n
= 0; n
< aParts
.Count(); n
++ ) {
448 m_strPath
<< wxCONFIG_PATH_SEPARATOR
<< aParts
[n
];
452 // ----------------------------------------------------------------------------
454 // ----------------------------------------------------------------------------
456 bool wxFileConfig::GetFirstGroup(wxString
& str
, long& lIndex
) const
459 return GetNextGroup(str
, lIndex
);
462 bool wxFileConfig::GetNextGroup (wxString
& str
, long& lIndex
) const
464 if ( size_t(lIndex
) < m_pCurrentGroup
->Groups().Count() ) {
465 str
= m_pCurrentGroup
->Groups()[lIndex
++]->Name();
472 bool wxFileConfig::GetFirstEntry(wxString
& str
, long& lIndex
) const
475 return GetNextEntry(str
, lIndex
);
478 bool wxFileConfig::GetNextEntry (wxString
& str
, long& lIndex
) const
480 if ( size_t(lIndex
) < m_pCurrentGroup
->Entries().Count() ) {
481 str
= m_pCurrentGroup
->Entries()[lIndex
++]->Name();
488 size_t wxFileConfig::GetNumberOfEntries(bool bRecursive
) const
490 size_t n
= m_pCurrentGroup
->Entries().Count();
492 ConfigGroup
*pOldCurrentGroup
= m_pCurrentGroup
;
493 size_t nSubgroups
= m_pCurrentGroup
->Groups().Count();
494 for ( size_t nGroup
= 0; nGroup
< nSubgroups
; nGroup
++ ) {
495 CONST_CAST m_pCurrentGroup
= m_pCurrentGroup
->Groups()[nGroup
];
496 n
+= GetNumberOfEntries(TRUE
);
497 CONST_CAST m_pCurrentGroup
= pOldCurrentGroup
;
504 size_t wxFileConfig::GetNumberOfGroups(bool bRecursive
) const
506 size_t n
= m_pCurrentGroup
->Groups().Count();
508 ConfigGroup
*pOldCurrentGroup
= m_pCurrentGroup
;
509 size_t nSubgroups
= m_pCurrentGroup
->Groups().Count();
510 for ( size_t nGroup
= 0; nGroup
< nSubgroups
; nGroup
++ ) {
511 CONST_CAST m_pCurrentGroup
= m_pCurrentGroup
->Groups()[nGroup
];
512 n
+= GetNumberOfGroups(TRUE
);
513 CONST_CAST m_pCurrentGroup
= pOldCurrentGroup
;
520 // ----------------------------------------------------------------------------
521 // tests for existence
522 // ----------------------------------------------------------------------------
524 bool wxFileConfig::HasGroup(const wxString
& strName
) const
526 wxConfigPathChanger
path(this, strName
);
528 ConfigGroup
*pGroup
= m_pCurrentGroup
->FindSubgroup(path
.Name());
529 return pGroup
!= NULL
;
532 bool wxFileConfig::HasEntry(const wxString
& strName
) const
534 wxConfigPathChanger
path(this, strName
);
536 ConfigEntry
*pEntry
= m_pCurrentGroup
->FindEntry(path
.Name());
537 return pEntry
!= NULL
;
540 // ----------------------------------------------------------------------------
542 // ----------------------------------------------------------------------------
544 bool wxFileConfig::Read(const wxString
& key
,
545 wxString
* pStr
) const
547 wxConfigPathChanger
path(this, key
);
549 ConfigEntry
*pEntry
= m_pCurrentGroup
->FindEntry(path
.Name());
550 if (pEntry
== NULL
) {
554 *pStr
= ExpandEnvVars(pEntry
->Value());
559 bool wxFileConfig::Read(const wxString
& key
,
560 wxString
* pStr
, const wxString
& defVal
) const
562 wxConfigPathChanger
path(this, key
);
564 ConfigEntry
*pEntry
= m_pCurrentGroup
->FindEntry(path
.Name());
565 if (pEntry
== NULL
) {
566 if( IsRecordingDefaults() )
567 ((wxFileConfig
*)this)->Write(key
,defVal
);
568 *pStr
= ExpandEnvVars(defVal
);
572 *pStr
= ExpandEnvVars(pEntry
->Value());
577 bool wxFileConfig::Read(const wxString
& key
, long *pl
) const
580 if ( Read(key
, & str
) ) {
589 bool wxFileConfig::Write(const wxString
& key
, const wxString
& szValue
)
591 wxConfigPathChanger
path(this, key
);
593 wxString strName
= path
.Name();
594 if ( strName
.IsEmpty() ) {
595 // setting the value of a group is an error
596 wxASSERT_MSG( IsEmpty(szValue
), "can't set value of a group!" );
598 // ... except if it's empty in which case it's a way to force it's creation
599 m_pCurrentGroup
->SetDirty();
601 // this will add a line for this group if it didn't have it before
602 (void)m_pCurrentGroup
->GetGroupLine();
607 // check that the name is reasonable
608 if ( strName
[0u] == wxCONFIG_IMMUTABLE_PREFIX
) {
609 wxLogError(_("Config entry name cannot start with '%c'."),
610 wxCONFIG_IMMUTABLE_PREFIX
);
614 strName
= FilterOutEntryName(strName
);
616 ConfigEntry
*pEntry
= m_pCurrentGroup
->FindEntry(strName
);
617 if ( pEntry
== NULL
)
618 pEntry
= m_pCurrentGroup
->AddEntry(strName
);
620 pEntry
->SetValue(szValue
);
626 bool wxFileConfig::Write(const wxString
& key
, long lValue
)
628 // ltoa() is not ANSI :-(
630 buf
.Printf("%ld", lValue
);
631 return Write(key
, buf
);
634 bool wxFileConfig::Flush(bool /* bCurrentOnly */)
636 if ( LineListIsEmpty() || !m_pRootGroup
->IsDirty() )
639 wxTempFile
file(m_strLocalFile
);
641 if ( !file
.IsOpened() ) {
642 wxLogError(_("can't open user configuration file."));
646 // write all strings to file
647 for ( LineList
*p
= m_linesHead
; p
!= NULL
; p
= p
->Next() ) {
648 if ( !file
.Write(p
->Text() + wxTextFile::GetEOL()) ) {
649 wxLogError(_("can't write user configuration file."));
654 return file
.Commit();
657 // ----------------------------------------------------------------------------
658 // renaming groups/entries
659 // ----------------------------------------------------------------------------
661 bool wxFileConfig::RenameEntry(const wxString
& oldName
,
662 const wxString
& newName
)
664 // check that the entry exists
665 ConfigEntry
*oldEntry
= m_pCurrentGroup
->FindEntry(oldName
);
669 // check that the new entry doesn't already exist
670 if ( m_pCurrentGroup
->FindEntry(newName
) )
673 // delete the old entry, create the new one
674 wxString value
= oldEntry
->Value();
675 if ( !m_pCurrentGroup
->DeleteEntry(oldName
) )
678 ConfigEntry
*newEntry
= m_pCurrentGroup
->AddEntry(newName
);
679 newEntry
->SetValue(value
);
684 bool wxFileConfig::RenameGroup(const wxString
& oldName
,
685 const wxString
& newName
)
687 // check that the group exists
688 ConfigGroup
*group
= m_pCurrentGroup
->FindSubgroup(oldName
);
692 // check that the new group doesn't already exist
693 if ( m_pCurrentGroup
->FindSubgroup(newName
) )
696 group
->Rename(newName
);
701 // ----------------------------------------------------------------------------
702 // delete groups/entries
703 // ----------------------------------------------------------------------------
705 bool wxFileConfig::DeleteEntry(const wxString
& key
, bool bGroupIfEmptyAlso
)
707 wxConfigPathChanger
path(this, key
);
709 if ( !m_pCurrentGroup
->DeleteEntry(path
.Name()) )
712 if ( bGroupIfEmptyAlso
&& m_pCurrentGroup
->IsEmpty() ) {
713 if ( m_pCurrentGroup
!= m_pRootGroup
) {
714 ConfigGroup
*pGroup
= m_pCurrentGroup
;
715 SetPath(".."); // changes m_pCurrentGroup!
716 m_pCurrentGroup
->DeleteSubgroupByName(pGroup
->Name());
718 //else: never delete the root group
724 bool wxFileConfig::DeleteGroup(const wxString
& key
)
726 wxConfigPathChanger
path(this, key
);
728 return m_pCurrentGroup
->DeleteSubgroupByName(path
.Name());
731 bool wxFileConfig::DeleteAll()
735 const char *szFile
= m_strLocalFile
;
737 if ( remove(szFile
) == -1 )
738 wxLogSysError(_("can't delete user configuration file '%s'"), szFile
);
740 m_strLocalFile
= m_strGlobalFile
= "";
746 // ----------------------------------------------------------------------------
747 // linked list functions
748 // ----------------------------------------------------------------------------
750 // append a new line to the end of the list
751 LineList
*wxFileConfig::LineListAppend(const wxString
& str
)
753 LineList
*pLine
= new LineList(str
);
755 if ( m_linesTail
== NULL
) {
761 m_linesTail
->SetNext(pLine
);
762 pLine
->SetPrev(m_linesTail
);
769 // insert a new line after the given one or in the very beginning if !pLine
770 LineList
*wxFileConfig::LineListInsert(const wxString
& str
,
773 if ( pLine
== m_linesTail
)
774 return LineListAppend(str
);
776 LineList
*pNewLine
= new LineList(str
);
777 if ( pLine
== NULL
) {
778 // prepend to the list
779 pNewLine
->SetNext(m_linesHead
);
780 m_linesHead
->SetPrev(pNewLine
);
781 m_linesHead
= pNewLine
;
784 // insert before pLine
785 LineList
*pNext
= pLine
->Next();
786 pNewLine
->SetNext(pNext
);
787 pNewLine
->SetPrev(pLine
);
788 pNext
->SetPrev(pNewLine
);
789 pLine
->SetNext(pNewLine
);
795 void wxFileConfig::LineListRemove(LineList
*pLine
)
797 LineList
*pPrev
= pLine
->Prev(),
798 *pNext
= pLine
->Next();
804 pPrev
->SetNext(pNext
);
810 pNext
->SetPrev(pPrev
);
815 bool wxFileConfig::LineListIsEmpty()
817 return m_linesHead
== NULL
;
820 // ============================================================================
821 // wxFileConfig::ConfigGroup
822 // ============================================================================
824 // ----------------------------------------------------------------------------
826 // ----------------------------------------------------------------------------
829 ConfigGroup::ConfigGroup(ConfigGroup
*pParent
,
830 const wxString
& strName
,
831 wxFileConfig
*pConfig
)
832 : m_aEntries(CompareEntries
),
833 m_aSubgroups(CompareGroups
),
845 // dtor deletes all children
846 ConfigGroup::~ConfigGroup()
849 size_t n
, nCount
= m_aEntries
.Count();
850 for ( n
= 0; n
< nCount
; n
++ )
851 delete m_aEntries
[n
];
854 nCount
= m_aSubgroups
.Count();
855 for ( n
= 0; n
< nCount
; n
++ )
856 delete m_aSubgroups
[n
];
859 // ----------------------------------------------------------------------------
861 // ----------------------------------------------------------------------------
863 void ConfigGroup::SetLine(LineList
*pLine
)
865 wxASSERT( m_pLine
== NULL
); // shouldn't be called twice
871 This is a bit complicated, so let me explain it in details. All lines that
872 were read from the local file (the only one we will ever modify) are stored
873 in a (doubly) linked list. Our problem is to know at which position in this
874 list should we insert the new entries/subgroups. To solve it we keep three
875 variables for each group: m_pLine, m_pLastEntry and m_pLastGroup.
877 m_pLine points to the line containing "[group_name]"
878 m_pLastEntry points to the last entry of this group in the local file.
879 m_pLastGroup subgroup
881 Initially, they're NULL all three. When the group (an entry/subgroup) is read
882 from the local file, the corresponding variable is set. However, if the group
883 was read from the global file and then modified or created by the application
884 these variables are still NULL and we need to create the corresponding lines.
885 See the following functions (and comments preceding them) for the details of
888 Also, when our last entry/group are deleted we need to find the new last
889 element - the code in DeleteEntry/Subgroup does this by backtracking the list
890 of lines until it either founds an entry/subgroup (and this is the new last
891 element) or the m_pLine of the group, in which case there are no more entries
892 (or subgroups) left and m_pLast<element> becomes NULL.
894 NB: This last problem could be avoided for entries if we added new entries
895 immediately after m_pLine, but in this case the entries would appear
896 backwards in the config file (OTOH, it's not that important) and as we
897 would still need to do it for the subgroups the code wouldn't have been
898 significantly less complicated.
901 // Return the line which contains "[our name]". If we're still not in the list,
902 // add our line to it immediately after the last line of our parent group if we
903 // have it or in the very beginning if we're the root group.
904 LineList
*ConfigGroup::GetGroupLine()
906 if ( m_pLine
== NULL
) {
907 ConfigGroup
*pParent
= Parent();
909 // this group wasn't present in local config file, add it now
910 if ( pParent
!= NULL
) {
911 wxString strFullName
;
912 strFullName
<< "[" << (GetFullName().c_str() + 1) << "]"; // +1: no '/'
913 m_pLine
= m_pConfig
->LineListInsert(strFullName
,
914 pParent
->GetLastGroupLine());
915 pParent
->SetLastGroup(this); // we're surely after all the others
918 // we return NULL, so that LineListInsert() will insert us in the
926 // Return the last line belonging to the subgroups of this group (after which
927 // we can add a new subgroup), if we don't have any subgroups or entries our
928 // last line is the group line (m_pLine) itself.
929 LineList
*ConfigGroup::GetLastGroupLine()
931 // if we have any subgroups, our last line is the last line of the last
933 if ( m_pLastGroup
!= NULL
) {
934 LineList
*pLine
= m_pLastGroup
->GetLastGroupLine();
936 wxASSERT( pLine
!= NULL
); // last group must have !NULL associated line
940 // no subgroups, so the last line is the line of thelast entry (if any)
941 return GetLastEntryLine();
944 // return the last line belonging to the entries of this group (after which
945 // we can add a new entry), if we don't have any entries we will add the new
946 // one immediately after the group line itself.
947 LineList
*ConfigGroup::GetLastEntryLine()
949 if ( m_pLastEntry
!= NULL
) {
950 LineList
*pLine
= m_pLastEntry
->GetLine();
952 wxASSERT( pLine
!= NULL
); // last entry must have !NULL associated line
956 // no entries: insert after the group header
957 return GetGroupLine();
960 // ----------------------------------------------------------------------------
962 // ----------------------------------------------------------------------------
964 void ConfigGroup::Rename(const wxString
& newName
)
968 LineList
*line
= GetGroupLine();
969 wxString strFullName
;
970 strFullName
<< "[" << (GetFullName().c_str() + 1) << "]"; // +1: no '/'
971 line
->SetText(strFullName
);
976 wxString
ConfigGroup::GetFullName() const
979 return Parent()->GetFullName() + wxCONFIG_PATH_SEPARATOR
+ Name();
984 // ----------------------------------------------------------------------------
986 // ----------------------------------------------------------------------------
988 // use binary search because the array is sorted
990 ConfigGroup::FindEntry(const char *szName
) const
994 hi
= m_aEntries
.Count();
1000 pEntry
= m_aEntries
[i
];
1002 #if wxCONFIG_CASE_SENSITIVE
1003 res
= strcmp(pEntry
->Name(), szName
);
1005 res
= Stricmp(pEntry
->Name(), szName
);
1020 ConfigGroup::FindSubgroup(const char *szName
) const
1024 hi
= m_aSubgroups
.Count();
1026 ConfigGroup
*pGroup
;
1030 pGroup
= m_aSubgroups
[i
];
1032 #if wxCONFIG_CASE_SENSITIVE
1033 res
= strcmp(pGroup
->Name(), szName
);
1035 res
= Stricmp(pGroup
->Name(), szName
);
1049 // ----------------------------------------------------------------------------
1050 // create a new item
1051 // ----------------------------------------------------------------------------
1053 // create a new entry and add it to the current group
1055 ConfigGroup::AddEntry(const wxString
& strName
, int nLine
)
1057 wxASSERT( FindEntry(strName
) == NULL
);
1059 ConfigEntry
*pEntry
= new ConfigEntry(this, strName
, nLine
);
1060 m_aEntries
.Add(pEntry
);
1065 // create a new group and add it to the current group
1067 ConfigGroup::AddSubgroup(const wxString
& strName
)
1069 wxASSERT( FindSubgroup(strName
) == NULL
);
1071 ConfigGroup
*pGroup
= new ConfigGroup(this, strName
, m_pConfig
);
1072 m_aSubgroups
.Add(pGroup
);
1077 // ----------------------------------------------------------------------------
1079 // ----------------------------------------------------------------------------
1082 The delete operations are _very_ slow if we delete the last item of this
1083 group (see comments before GetXXXLineXXX functions for more details),
1084 so it's much better to start with the first entry/group if we want to
1085 delete several of them.
1088 bool ConfigGroup::DeleteSubgroupByName(const char *szName
)
1090 return DeleteSubgroup(FindSubgroup(szName
));
1093 // doesn't delete the subgroup itself, but does remove references to it from
1094 // all other data structures (and normally the returned pointer should be
1095 // deleted a.s.a.p. because there is nothing much to be done with it anyhow)
1096 bool ConfigGroup::DeleteSubgroup(ConfigGroup
*pGroup
)
1098 wxCHECK( pGroup
!= NULL
, FALSE
); // deleting non existing group?
1100 // delete all entries
1101 size_t nCount
= pGroup
->m_aEntries
.Count();
1102 for ( size_t nEntry
= 0; nEntry
< nCount
; nEntry
++ ) {
1103 LineList
*pLine
= pGroup
->m_aEntries
[nEntry
]->GetLine();
1104 if ( pLine
!= NULL
)
1105 m_pConfig
->LineListRemove(pLine
);
1108 // and subgroups of this sungroup
1110 // pGroup->m_aSubgroups.Count() gets decremented in DeleteSubgroup(),
1111 // so we cannot do this.
1113 nCount
= pGroup
->m_aSubgroups
.Count();
1114 for ( size_t nGroup
= 0; nGroup
< nCount
; nGroup
++ ) {
1115 pGroup
->DeleteSubgroup(pGroup
->m_aSubgroups
[nGroup
]);
1118 while(pGroup
->m_aSubgroups
.Count() > 0)
1119 pGroup
->DeleteSubgroup(pGroup
->m_aSubgroups
[0]);
1121 LineList
*pLine
= pGroup
->m_pLine
;
1122 if ( pLine
!= NULL
) {
1123 // notice that we may do this test inside the previous "if" because the
1124 // last entry's line is surely !NULL
1125 if ( pGroup
== m_pLastGroup
) {
1126 // our last entry is being deleted - find the last one which stays
1127 wxASSERT( m_pLine
!= NULL
); // we have a subgroup with !NULL pLine...
1129 // go back until we find a subgroup or reach the group's line
1130 ConfigGroup
*pNewLast
= NULL
;
1131 size_t n
, nSubgroups
= m_aSubgroups
.Count();
1133 for ( pl
= pLine
->Prev(); pl
!= m_pLine
; pl
= pl
->Prev() ) {
1134 // is it our subgroup?
1135 for ( n
= 0; (pNewLast
== NULL
) && (n
< nSubgroups
); n
++ ) {
1136 // do _not_ call GetGroupLine! we don't want to add it to the local
1137 // file if it's not already there
1138 if ( m_aSubgroups
[n
]->m_pLine
== m_pLine
)
1139 pNewLast
= m_aSubgroups
[n
];
1142 if ( pNewLast
!= NULL
) // found?
1146 if ( pl
== m_pLine
) {
1147 wxASSERT( !pNewLast
); // how comes it has the same line as we?
1149 // we've reached the group line without finding any subgroups
1150 m_pLastGroup
= NULL
;
1153 m_pLastGroup
= pNewLast
;
1156 m_pConfig
->LineListRemove(pLine
);
1161 m_aSubgroups
.Remove(pGroup
);
1167 bool ConfigGroup::DeleteEntry(const char *szName
)
1169 ConfigEntry
*pEntry
= FindEntry(szName
);
1170 wxCHECK( pEntry
!= NULL
, FALSE
); // deleting non existing item?
1172 LineList
*pLine
= pEntry
->GetLine();
1173 if ( pLine
!= NULL
) {
1174 // notice that we may do this test inside the previous "if" because the
1175 // last entry's line is surely !NULL
1176 if ( pEntry
== m_pLastEntry
) {
1177 // our last entry is being deleted - find the last one which stays
1178 wxASSERT( m_pLine
!= NULL
); // if we have an entry with !NULL pLine...
1180 // go back until we find another entry or reach the group's line
1181 ConfigEntry
*pNewLast
= NULL
;
1182 size_t n
, nEntries
= m_aEntries
.Count();
1184 for ( pl
= pLine
->Prev(); pl
!= m_pLine
; pl
= pl
->Prev() ) {
1185 // is it our subgroup?
1186 for ( n
= 0; (pNewLast
== NULL
) && (n
< nEntries
); n
++ ) {
1187 if ( m_aEntries
[n
]->GetLine() == m_pLine
)
1188 pNewLast
= m_aEntries
[n
];
1191 if ( pNewLast
!= NULL
) // found?
1195 if ( pl
== m_pLine
) {
1196 wxASSERT( !pNewLast
); // how comes it has the same line as we?
1198 // we've reached the group line without finding any subgroups
1199 m_pLastEntry
= NULL
;
1202 m_pLastEntry
= pNewLast
;
1205 m_pConfig
->LineListRemove(pLine
);
1208 // we must be written back for the changes to be saved
1211 m_aEntries
.Remove(pEntry
);
1217 // ----------------------------------------------------------------------------
1219 // ----------------------------------------------------------------------------
1220 void ConfigGroup::SetDirty()
1223 if ( Parent() != NULL
) // propagate upwards
1224 Parent()->SetDirty();
1227 // ============================================================================
1228 // wxFileConfig::ConfigEntry
1229 // ============================================================================
1231 // ----------------------------------------------------------------------------
1233 // ----------------------------------------------------------------------------
1234 ConfigEntry::ConfigEntry(ConfigGroup
*pParent
,
1235 const wxString
& strName
,
1237 : m_strName(strName
)
1239 wxASSERT( !strName
.IsEmpty() );
1241 m_pParent
= pParent
;
1247 m_bImmutable
= strName
[0] == wxCONFIG_IMMUTABLE_PREFIX
;
1249 m_strName
.erase(0, 1); // remove first character
1252 // ----------------------------------------------------------------------------
1254 // ----------------------------------------------------------------------------
1256 void ConfigEntry::SetLine(LineList
*pLine
)
1258 if ( m_pLine
!= NULL
) {
1259 wxLogWarning(_("entry '%s' appears more than once in group '%s'"),
1260 Name().c_str(), m_pParent
->GetFullName().c_str());
1264 Group()->SetLastEntry(this);
1267 // second parameter is FALSE if we read the value from file and prevents the
1268 // entry from being marked as 'dirty'
1269 void ConfigEntry::SetValue(const wxString
& strValue
, bool bUser
)
1271 if ( bUser
&& IsImmutable() ) {
1272 wxLogWarning(_("attempt to change immutable key '%s' ignored."),
1277 // do nothing if it's the same value
1278 if ( strValue
== m_strValue
)
1281 m_strValue
= strValue
;
1284 wxString strVal
= FilterOutValue(strValue
);
1286 strLine
<< m_strName
<< " = " << strVal
;
1288 if ( m_pLine
!= NULL
) {
1289 // entry was read from the local config file, just modify the line
1290 m_pLine
->SetText(strLine
);
1293 // add a new line to the file
1294 wxASSERT( m_nLine
== wxNOT_FOUND
); // consistency check
1296 m_pLine
= Group()->Config()->LineListInsert(strLine
,
1297 Group()->GetLastEntryLine());
1298 Group()->SetLastEntry(this);
1305 void ConfigEntry::SetDirty()
1308 Group()->SetDirty();
1311 // ============================================================================
1313 // ============================================================================
1315 // ----------------------------------------------------------------------------
1316 // compare functions for array sorting
1317 // ----------------------------------------------------------------------------
1319 int CompareEntries(ConfigEntry
*p1
,
1322 #if wxCONFIG_CASE_SENSITIVE
1323 return strcmp(p1
->Name(), p2
->Name());
1325 return Stricmp(p1
->Name(), p2
->Name());
1329 int CompareGroups(ConfigGroup
*p1
,
1332 #if wxCONFIG_CASE_SENSITIVE
1333 return strcmp(p1
->Name(), p2
->Name());
1335 return Stricmp(p1
->Name(), p2
->Name());
1339 // ----------------------------------------------------------------------------
1341 // ----------------------------------------------------------------------------
1343 // undo FilterOutValue
1344 static wxString
FilterInValue(const wxString
& str
)
1347 strResult
.Alloc(str
.Len());
1349 bool bQuoted
= !str
.IsEmpty() && str
[0] == '"';
1351 for ( size_t n
= bQuoted
? 1 : 0; n
< str
.Len(); n
++ ) {
1352 if ( str
[n
] == '\\' ) {
1353 switch ( str
[++n
] ) {
1376 if ( str
[n
] != '"' || !bQuoted
)
1377 strResult
+= str
[n
];
1378 else if ( n
!= str
.Len() - 1 ) {
1379 wxLogWarning(_("unexpected \" at position %d in '%s'."),
1382 //else: it's the last quote of a quoted string, ok
1389 // quote the string before writing it to file
1390 static wxString
FilterOutValue(const wxString
& str
)
1396 strResult
.Alloc(str
.Len());
1398 // quoting is necessary to preserve spaces in the beginning of the string
1399 bool bQuote
= isspace(str
[0]) || str
[0] == '"';
1405 for ( size_t n
= 0; n
< str
.Len(); n
++ ) {
1428 //else: fall through
1431 strResult
+= str
[n
];
1432 continue; // nothing special to do
1435 // we get here only for special characters
1436 strResult
<< '\\' << c
;
1445 // undo FilterOutEntryName
1446 static wxString
FilterInEntryName(const wxString
& str
)
1449 strResult
.Alloc(str
.Len());
1451 for ( const char *pc
= str
.c_str(); *pc
!= '\0'; pc
++ ) {
1461 // sanitize entry or group name: insert '\\' before any special characters
1462 static wxString
FilterOutEntryName(const wxString
& str
)
1465 strResult
.Alloc(str
.Len());
1467 for ( const char *pc
= str
.c_str(); *pc
!= '\0'; pc
++ ) {
1470 // we explicitly allow some of "safe" chars and 8bit ASCII characters
1471 // which will probably never have special meaning
1472 // NB: note that wxCONFIG_IMMUTABLE_PREFIX and wxCONFIG_PATH_SEPARATOR
1473 // should *not* be quoted
1474 if ( !isalnum(c
) && !strchr("@_/-!.*%", c
) && ((c
& 0x80) == 0) )