X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5fde6fcc9b551340a194ae4c726db5ab64b5c594..4aaef122cbbd5bbe0e70b824e320458e2329dd13:/src/common/fileconf.cpp diff --git a/src/common/fileconf.cpp b/src/common/fileconf.cpp index b8fec80df7..a6107188c9 100644 --- a/src/common/fileconf.cpp +++ b/src/common/fileconf.cpp @@ -36,9 +36,14 @@ #include "wx/file.h" #include "wx/log.h" #include "wx/textfile.h" +#include "wx/memtext.h" #include "wx/config.h" #include "wx/fileconf.h" +#if wxUSE_STREAMS + #include "wx/stream.h" +#endif // wxUSE_STREAMS + #include "wx/utils.h" // for wxGetHomeDir // _WINDOWS_ is defined when windows.h is included, @@ -68,6 +73,7 @@ // ---------------------------------------------------------------------------- // constants // ---------------------------------------------------------------------------- + #ifndef MAX_PATH #define MAX_PATH 512 #endif @@ -77,8 +83,8 @@ // ---------------------------------------------------------------------------- // compare functions for sorting the arrays -static int LINKAGEMODE CompareEntries(ConfigEntry *p1, ConfigEntry *p2); -static int LINKAGEMODE CompareGroups(ConfigGroup *p1, ConfigGroup *p2); +static int LINKAGEMODE CompareEntries(wxFileConfigEntry *p1, wxFileConfigEntry *p2); +static int LINKAGEMODE CompareGroups(wxFileConfigGroup *p1, wxFileConfigGroup *p2); // filter strings static wxString FilterInValue(const wxString& str); @@ -90,6 +96,158 @@ static wxString FilterOutEntryName(const wxString& str); // get the name to use in wxFileConfig ctor static wxString GetAppName(const wxString& appname); +// ============================================================================ +// private classes +// ============================================================================ + +// ---------------------------------------------------------------------------- +// "template" array types +// ---------------------------------------------------------------------------- + +WX_DEFINE_SORTED_EXPORTED_ARRAY(wxFileConfigEntry *, ArrayEntries); +WX_DEFINE_SORTED_EXPORTED_ARRAY(wxFileConfigGroup *, ArrayGroups); + +// ---------------------------------------------------------------------------- +// wxFileConfigLineList +// ---------------------------------------------------------------------------- + +// we store all lines of the local config file as a linked list in memory +class wxFileConfigLineList +{ +public: + void SetNext(wxFileConfigLineList *pNext) { m_pNext = pNext; } + void SetPrev(wxFileConfigLineList *pPrev) { m_pPrev = pPrev; } + + // ctor + wxFileConfigLineList(const wxString& str, + wxFileConfigLineList *pNext = NULL) : m_strLine(str) + { SetNext(pNext); SetPrev(NULL); } + + // next/prev nodes in the linked list + wxFileConfigLineList *Next() const { return m_pNext; } + wxFileConfigLineList *Prev() const { return m_pPrev; } + + // get/change lines text + void SetText(const wxString& str) { m_strLine = str; } + const wxString& Text() const { return m_strLine; } + +private: + wxString m_strLine; // line contents + wxFileConfigLineList *m_pNext, // next node + *m_pPrev; // previous one +}; + +// ---------------------------------------------------------------------------- +// wxFileConfigEntry: a name/value pair +// ---------------------------------------------------------------------------- + +class wxFileConfigEntry +{ +private: + wxFileConfigGroup *m_pParent; // group that contains us + + wxString m_strName, // entry name + m_strValue; // value + bool m_bDirty:1, // changed since last read? + m_bImmutable:1, // can be overriden locally? + m_bHasValue:1; // set after first call to SetValue() + + int m_nLine; // used if m_pLine == NULL only + + // pointer to our line in the linked list or NULL if it was found in global + // file (which we don't modify) + wxFileConfigLineList *m_pLine; + +public: + wxFileConfigEntry(wxFileConfigGroup *pParent, + const wxString& strName, int nLine); + + // simple accessors + const wxString& Name() const { return m_strName; } + const wxString& Value() const { return m_strValue; } + wxFileConfigGroup *Group() const { return m_pParent; } + bool IsDirty() const { return m_bDirty; } + bool IsImmutable() const { return m_bImmutable; } + bool IsLocal() const { return m_pLine != 0; } + int Line() const { return m_nLine; } + wxFileConfigLineList * + GetLine() const { return m_pLine; } + + // modify entry attributes + void SetValue(const wxString& strValue, bool bUser = TRUE); + void SetDirty(); + void SetLine(wxFileConfigLineList *pLine); +}; + +// ---------------------------------------------------------------------------- +// wxFileConfigGroup: container of entries and other groups +// ---------------------------------------------------------------------------- + +class wxFileConfigGroup +{ +private: + wxFileConfig *m_pConfig; // config object we belong to + wxFileConfigGroup *m_pParent; // parent group (NULL for root group) + ArrayEntries m_aEntries; // entries in this group + ArrayGroups m_aSubgroups; // subgroups + wxString m_strName; // group's name + bool m_bDirty; // if FALSE => all subgroups are not dirty + wxFileConfigLineList *m_pLine; // pointer to our line in the linked list + wxFileConfigEntry *m_pLastEntry; // last entry/subgroup of this group in the + wxFileConfigGroup *m_pLastGroup; // local file (we insert new ones after it) + + // DeleteSubgroupByName helper + bool DeleteSubgroup(wxFileConfigGroup *pGroup); + +public: + // ctor + wxFileConfigGroup(wxFileConfigGroup *pParent, const wxString& strName, wxFileConfig *); + + // dtor deletes all entries and subgroups also + ~wxFileConfigGroup(); + + // simple accessors + const wxString& Name() const { return m_strName; } + wxFileConfigGroup *Parent() const { return m_pParent; } + wxFileConfig *Config() const { return m_pConfig; } + bool IsDirty() const { return m_bDirty; } + + const ArrayEntries& Entries() const { return m_aEntries; } + const ArrayGroups& Groups() const { return m_aSubgroups; } + bool IsEmpty() const { return Entries().IsEmpty() && Groups().IsEmpty(); } + + // find entry/subgroup (NULL if not found) + wxFileConfigGroup *FindSubgroup(const wxChar *szName) const; + wxFileConfigEntry *FindEntry (const wxChar *szName) const; + + // delete entry/subgroup, return FALSE if doesn't exist + bool DeleteSubgroupByName(const wxChar *szName); + bool DeleteEntry(const wxChar *szName); + + // create new entry/subgroup returning pointer to newly created element + wxFileConfigGroup *AddSubgroup(const wxString& strName); + wxFileConfigEntry *AddEntry (const wxString& strName, int nLine = wxNOT_FOUND); + + // will also recursively set parent's dirty flag + void SetDirty(); + void SetLine(wxFileConfigLineList *pLine); + + // rename: no checks are done to ensure that the name is unique! + void Rename(const wxString& newName); + + // + wxString GetFullName() const; + + // get the last line belonging to an entry/subgroup of this group + wxFileConfigLineList *GetGroupLine(); // line which contains [group] + wxFileConfigLineList *GetLastEntryLine(); // after which our subgroups start + wxFileConfigLineList *GetLastGroupLine(); // after which the next group starts + + // called by entries/subgroups when they're created/deleted + void SetLastEntry(wxFileConfigEntry *pEntry) { m_pLastEntry = pEntry; } + void SetLastGroup(wxFileConfigGroup *pGroup) { m_pLastGroup = pGroup; } +}; + // ============================================================================ // implementation // ============================================================================ @@ -103,6 +261,8 @@ wxString wxFileConfig::GetGlobalDir() #ifdef __VMS__ // Note if __VMS is defined __UNIX is also defined strDir = wxT("sys$manager:"); + #elif defined(__WXMAC__) + strDir = wxMacFindFolder( (short) kOnSystemDisk, kPreferencesFolderType, kDontCreateFolder ) ; #elif defined( __UNIX__ ) strDir = wxT("/etc/"); #elif defined(__WXPM__) @@ -114,92 +274,14 @@ wxString wxFileConfig::GetGlobalDir() if (rc == 0) { drive = aulSysInfo[QSV_BOOT_DRIVE - 1]; - switch(drive) - { - case 1: - strDir = "A:\\OS2\\"; - break; - case 2: - strDir = "B:\\OS2\\"; - break; - case 3: - strDir = "C:\\OS2\\"; - break; - case 4: - strDir = "D:\\OS2\\"; - break; - case 5: - strDir = "E:\\OS2\\"; - break; - case 6: - strDir = "F:\\OS2\\"; - break; - case 7: - strDir = "G:\\OS2\\"; - break; - case 8: - strDir = "H:\\OS2\\"; - break; - case 9: - strDir = "I:\\OS2\\"; - break; - case 10: - strDir = "J:\\OS2\\"; - break; - case 11: - strDir = "K:\\OS2\\"; - break; - case 12: - strDir = "L:\\OS2\\"; - break; - case 13: - strDir = "M:\\OS2\\"; - break; - case 14: - strDir = "N:\\OS2\\"; - break; - case 15: - strDir = "O:\\OS2\\"; - break; - case 16: - strDir = "P:\\OS2\\"; - break; - case 17: - strDir = "Q:\\OS2\\"; - break; - case 18: - strDir = "R:\\OS2\\"; - break; - case 19: - strDir = "S:\\OS2\\"; - break; - case 20: - strDir = "T:\\OS2\\"; - break; - case 21: - strDir = "U:\\OS2\\"; - break; - case 22: - strDir = "V:\\OS2\\"; - break; - case 23: - strDir = "W:\\OS2\\"; - break; - case 24: - strDir = "X:\\OS2\\"; - break; - case 25: - strDir = "Y:\\OS2\\"; - break; - case 26: - strDir = "Z:\\OS2\\"; - break; - } + strDir.Printf(wxT("%c:\\OS2\\"), 'A'+drive-1); } #elif defined(__WXSTUBS__) wxASSERT_MSG( FALSE, wxT("TODO") ) ; - #elif defined(__WXMAC__) - strDir = wxMacFindFolder( (short) kOnSystemDisk, kPreferencesFolderType, kDontCreateFolder ) ; + #elif defined(__DOS__) + // There's no such thing as global cfg dir in MS-DOS, let's return + // current directory (FIXME_MGL?) + return wxT(".\\"); #else // Windows wxChar szWinDir[MAX_PATH]; ::GetWindowsDirectory(szWinDir, MAX_PATH); @@ -215,20 +297,20 @@ wxString wxFileConfig::GetLocalDir() { wxString strDir; -#ifndef __WXMAC__ +#if defined(__WXMAC__) || defined(__DOS__) + // no local dir concept on Mac OS 9 or MS-DOS + return GetGlobalDir() ; +#else wxGetHomeDir(&strDir); -#ifdef __UNIX__ -#ifdef __VMS - if (strDir.Last() != wxT(']')) -#endif - if (strDir.Last() != wxT('/')) strDir << wxT('/'); -#else +# ifdef __UNIX__ +# ifdef __VMS + if (strDir.Last() != wxT(']')) +# endif + if (strDir.Last() != wxT('/')) strDir << wxT('/'); +# else if (strDir.Last() != wxT('\\')) strDir << wxT('\\'); -#endif -#else - // no local dir concept on mac - return GetGlobalDir() ; +# endif #endif return strDir; @@ -240,10 +322,10 @@ wxString wxFileConfig::GetGlobalFileName(const wxChar *szFile) str << szFile; if ( wxStrchr(szFile, wxT('.')) == NULL ) - #ifdef __UNIX__ - str << wxT(".conf"); - #elif defined( __WXMAC__ ) + #if defined( __WXMAC__ ) str << " Preferences"; + #elif defined( __UNIX__ ) + str << wxT(".conf"); #else // Windows str << wxT(".ini"); #endif // UNIX/Win @@ -261,18 +343,17 @@ wxString wxFileConfig::GetLocalFileName(const wxChar *szFile) wxString str = GetLocalDir(); #endif - #if defined( __UNIX__ ) && !defined( __VMS ) + #if defined( __UNIX__ ) && !defined( __VMS ) && !defined( __WXMAC__ ) str << wxT('.'); #endif str << szFile; - #ifdef __WXMSW__ + #if defined(__WINDOWS__) || defined(__DOS__) if ( wxStrchr(szFile, wxT('.')) == NULL ) str << wxT(".ini"); #endif - #ifdef __WXMAC__ str << " Preferences"; #endif @@ -286,7 +367,7 @@ wxString wxFileConfig::GetLocalFileName(const wxChar *szFile) void wxFileConfig::Init() { m_pCurrentGroup = - m_pRootGroup = new ConfigGroup(NULL, "", this); + m_pRootGroup = new wxFileConfigGroup(NULL, "", this); m_linesHead = m_linesTail = NULL; @@ -371,13 +452,75 @@ wxFileConfig::wxFileConfig(const wxString& appName, const wxString& vendorName, Init(); } +#if wxUSE_STREAMS + +wxFileConfig::wxFileConfig(wxInputStream &inStream) +{ + // always local_file when this constructor is called (?) + SetStyle(GetStyle() | wxCONFIG_USE_LOCAL_FILE); + + m_pCurrentGroup = + m_pRootGroup = new wxFileConfigGroup(NULL, "", this); + + m_linesHead = + m_linesTail = NULL; + + // translate everything to the current (platform-dependent) line + // termination character + wxString strTrans; + { + wxString strTmp; + + char buf[1024]; + while ( !inStream.Read(buf, WXSIZEOF(buf)).Eof() ) + strTmp.append(wxConvertMB2WX(buf), inStream.LastRead()); + + strTmp.append(wxConvertMB2WX(buf), inStream.LastRead()); + + strTrans = wxTextBuffer::Translate(strTmp); + } + + wxMemoryText memText; + + // Now we can add the text to the memory text. To do this we extract line + // by line from the translated string, until we've reached the end. + // + // VZ: all this is horribly inefficient, we should do the translation on + // the fly in one pass saving both memory and time (TODO) + + const wxChar *pEOL = wxTextBuffer::GetEOL(wxTextBuffer::typeDefault); + const size_t EOLLen = wxStrlen(pEOL); + + int posLineStart = strTrans.Find(pEOL); + while ( posLineStart != -1 ) + { + wxString line(strTrans.Left(posLineStart)); + + memText.AddLine(line); + + strTrans = strTrans.Mid(posLineStart + EOLLen); + + posLineStart = strTrans.Find(pEOL); + } + + // also add whatever we have left in the translated string. + memText.AddLine(strTrans); + + // Finally we can parse it all. + Parse(memText, TRUE /* local */); + + SetRootPath(); +} + +#endif // wxUSE_STREAMS + void wxFileConfig::CleanUp() { delete m_pRootGroup; - LineList *pCur = m_linesHead; + wxFileConfigLineList *pCur = m_linesHead; while ( pCur != NULL ) { - LineList *pNext = pCur->Next(); + wxFileConfigLineList *pNext = pCur->Next(); delete pCur; pCur = pNext; } @@ -394,15 +537,15 @@ wxFileConfig::~wxFileConfig() // parse a config file // ---------------------------------------------------------------------------- -void wxFileConfig::Parse(wxTextFile& file, bool bLocal) +void wxFileConfig::Parse(wxTextBuffer& buffer, bool bLocal) { const wxChar *pStart; const wxChar *pEnd; wxString strLine; - size_t nLineCount = file.GetLineCount(); + size_t nLineCount = buffer.GetLineCount(); for ( size_t n = 0; n < nLineCount; n++ ) { - strLine = file[n]; + strLine = buffer[n]; // add the line to linked list if ( bLocal ) @@ -433,7 +576,7 @@ void wxFileConfig::Parse(wxTextFile& file, bool bLocal) if ( *pEnd != wxT(']') ) { wxLogError(_("file '%s': unexpected character %c at line %d."), - file.GetName(), *pEnd, n + 1); + buffer.GetName(), *pEnd, n + 1); continue; // skip this line } @@ -465,7 +608,7 @@ void wxFileConfig::Parse(wxTextFile& file, bool bLocal) default: wxLogWarning(_("file '%s', line %d: '%s' ignored after group header."), - file.GetName(), n + 1, pEnd); + buffer.GetName(), n + 1, pEnd); bCont = FALSE; } } @@ -494,10 +637,10 @@ void wxFileConfig::Parse(wxTextFile& file, bool bLocal) if ( *pEnd++ != wxT('=') ) { wxLogError(_("file '%s', line %d: '=' expected."), - file.GetName(), n + 1); + buffer.GetName(), n + 1); } else { - ConfigEntry *pEntry = m_pCurrentGroup->FindEntry(strKey); + wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(strKey); if ( pEntry == NULL ) { // new entry @@ -510,7 +653,7 @@ void wxFileConfig::Parse(wxTextFile& file, bool bLocal) if ( bLocal && pEntry->IsImmutable() ) { // immutable keys can't be changed by user wxLogWarning(_("file '%s', line %d: value for immutable key '%s' ignored."), - file.GetName(), n + 1, strKey.c_str()); + buffer.GetName(), n + 1, strKey.c_str()); continue; } // the condition below catches the cases (a) and (b) but not (c): @@ -520,7 +663,7 @@ void wxFileConfig::Parse(wxTextFile& file, bool bLocal) // which is exactly what we want. else if ( !bLocal || pEntry->IsLocal() ) { wxLogWarning(_("file '%s', line %d: key '%s' was first found at line %d."), - file.GetName(), n + 1, strKey.c_str(), pEntry->Line()); + buffer.GetName(), n + 1, strKey.c_str(), pEntry->Line()); if ( bLocal ) pEntry->SetLine(m_linesTail); @@ -571,7 +714,7 @@ void wxFileConfig::SetPath(const wxString& strPath) size_t n; m_pCurrentGroup = m_pRootGroup; for ( n = 0; n < aParts.Count(); n++ ) { - ConfigGroup *pNextGroup = m_pCurrentGroup->FindSubgroup(aParts[n]); + wxFileConfigGroup *pNextGroup = m_pCurrentGroup->FindSubgroup(aParts[n]); if ( pNextGroup == NULL ) pNextGroup = m_pCurrentGroup->AddSubgroup(aParts[n]); m_pCurrentGroup = pNextGroup; @@ -624,7 +767,7 @@ size_t wxFileConfig::GetNumberOfEntries(bool bRecursive) const { size_t n = m_pCurrentGroup->Entries().Count(); if ( bRecursive ) { - ConfigGroup *pOldCurrentGroup = m_pCurrentGroup; + wxFileConfigGroup *pOldCurrentGroup = m_pCurrentGroup; size_t nSubgroups = m_pCurrentGroup->Groups().Count(); for ( size_t nGroup = 0; nGroup < nSubgroups; nGroup++ ) { CONST_CAST m_pCurrentGroup = m_pCurrentGroup->Groups()[nGroup]; @@ -640,7 +783,7 @@ size_t wxFileConfig::GetNumberOfGroups(bool bRecursive) const { size_t n = m_pCurrentGroup->Groups().Count(); if ( bRecursive ) { - ConfigGroup *pOldCurrentGroup = m_pCurrentGroup; + wxFileConfigGroup *pOldCurrentGroup = m_pCurrentGroup; size_t nSubgroups = m_pCurrentGroup->Groups().Count(); for ( size_t nGroup = 0; nGroup < nSubgroups; nGroup++ ) { CONST_CAST m_pCurrentGroup = m_pCurrentGroup->Groups()[nGroup]; @@ -660,7 +803,7 @@ bool wxFileConfig::HasGroup(const wxString& strName) const { wxConfigPathChanger path(this, strName); - ConfigGroup *pGroup = m_pCurrentGroup->FindSubgroup(path.Name()); + wxFileConfigGroup *pGroup = m_pCurrentGroup->FindSubgroup(path.Name()); return pGroup != NULL; } @@ -668,7 +811,7 @@ bool wxFileConfig::HasEntry(const wxString& strName) const { wxConfigPathChanger path(this, strName); - ConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name()); + wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name()); return pEntry != NULL; } @@ -676,42 +819,21 @@ bool wxFileConfig::HasEntry(const wxString& strName) const // read/write values // ---------------------------------------------------------------------------- -bool wxFileConfig::Read(const wxString& key, - wxString* pStr) const +bool wxFileConfig::DoReadString(const wxString& key, wxString* pStr) const { wxConfigPathChanger path(this, key); - ConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name()); + wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name()); if (pEntry == NULL) { return FALSE; } - *pStr = ExpandEnvVars(pEntry->Value()); - return TRUE; -} - -bool wxFileConfig::Read(const wxString& key, - wxString* pStr, const wxString& defVal) const -{ - wxConfigPathChanger path(this, key); - - ConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name()); - bool ok; - if (pEntry == NULL) { - if( IsRecordingDefaults() ) - ((wxFileConfig *)this)->Write(key,defVal); - *pStr = ExpandEnvVars(defVal); - ok = FALSE; - } - else { - *pStr = ExpandEnvVars(pEntry->Value()); - ok = TRUE; - } + *pStr = pEntry->Value(); - return ok; + return TRUE; } -bool wxFileConfig::Read(const wxString& key, long *pl) const +bool wxFileConfig::DoReadLong(const wxString& key, long *pl) const { wxString str; if ( !Read(key, & str) ) @@ -719,11 +841,10 @@ bool wxFileConfig::Read(const wxString& key, long *pl) const return FALSE; } - *pl = wxAtol(str); - return TRUE; + return str.ToLong(pl); } -bool wxFileConfig::Write(const wxString& key, const wxString& szValue) +bool wxFileConfig::DoWriteString(const wxString& key, const wxString& szValue) { wxConfigPathChanger path(this, key); @@ -748,7 +869,7 @@ bool wxFileConfig::Write(const wxString& key, const wxString& szValue) return FALSE; } - ConfigEntry *pEntry = m_pCurrentGroup->FindEntry(strName); + wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(strName); if ( pEntry == NULL ) pEntry = m_pCurrentGroup->AddEntry(strName); @@ -758,12 +879,9 @@ bool wxFileConfig::Write(const wxString& key, const wxString& szValue) return TRUE; } -bool wxFileConfig::Write(const wxString& key, long lValue) +bool wxFileConfig::DoWriteLong(const wxString& key, long lValue) { - // ltoa() is not ANSI :-( - wxString buf; - buf.Printf(wxT("%ld"), lValue); - return Write(key, buf); + return Write(key, wxString::Format(_T("%ld"), lValue)); } bool wxFileConfig::Flush(bool /* bCurrentOnly */) @@ -788,7 +906,7 @@ bool wxFileConfig::Flush(bool /* bCurrentOnly */) } // write all strings to file - for ( LineList *p = m_linesHead; p != NULL; p = p->Next() ) { + for ( wxFileConfigLineList *p = m_linesHead; p != NULL; p = p->Next() ) { if ( !file.Write(p->Text() + wxTextFile::GetEOL()) ) { wxLogError(_("can't write user configuration file.")); return FALSE; @@ -797,12 +915,12 @@ bool wxFileConfig::Flush(bool /* bCurrentOnly */) bool ret = file.Commit(); -#if defined(__WXMAC__) && !defined(__UNIX__) +#if defined(__WXMAC__) if ( ret ) { FSSpec spec ; - wxUnixFilename2FSSpec( m_strLocalFile , &spec ) ; + wxMacFilename2FSSpec( m_strLocalFile , &spec ) ; FInfo finfo ; if ( FSpGetFInfo( &spec , &finfo ) == noErr ) { @@ -811,7 +929,7 @@ bool wxFileConfig::Flush(bool /* bCurrentOnly */) FSpSetFInfo( &spec , &finfo ) ; } } -#endif // __WXMAC__ && !__UNIX__ +#endif // __WXMAC__ #ifdef __UNIX__ // restore the old umask if we changed it @@ -832,7 +950,7 @@ bool wxFileConfig::RenameEntry(const wxString& oldName, const wxString& newName) { // check that the entry exists - ConfigEntry *oldEntry = m_pCurrentGroup->FindEntry(oldName); + wxFileConfigEntry *oldEntry = m_pCurrentGroup->FindEntry(oldName); if ( !oldEntry ) return FALSE; @@ -845,7 +963,7 @@ bool wxFileConfig::RenameEntry(const wxString& oldName, if ( !m_pCurrentGroup->DeleteEntry(oldName) ) return FALSE; - ConfigEntry *newEntry = m_pCurrentGroup->AddEntry(newName); + wxFileConfigEntry *newEntry = m_pCurrentGroup->AddEntry(newName); newEntry->SetValue(value); return TRUE; @@ -855,7 +973,7 @@ bool wxFileConfig::RenameGroup(const wxString& oldName, const wxString& newName) { // check that the group exists - ConfigGroup *group = m_pCurrentGroup->FindSubgroup(oldName); + wxFileConfigGroup *group = m_pCurrentGroup->FindSubgroup(oldName); if ( !group ) return FALSE; @@ -881,7 +999,7 @@ bool wxFileConfig::DeleteEntry(const wxString& key, bool bGroupIfEmptyAlso) if ( bGroupIfEmptyAlso && m_pCurrentGroup->IsEmpty() ) { if ( m_pCurrentGroup != m_pRootGroup ) { - ConfigGroup *pGroup = m_pCurrentGroup; + wxFileConfigGroup *pGroup = m_pCurrentGroup; SetPath(wxT("..")); // changes m_pCurrentGroup! m_pCurrentGroup->DeleteSubgroupByName(pGroup->Name()); } @@ -916,9 +1034,9 @@ bool wxFileConfig::DeleteAll() // ---------------------------------------------------------------------------- // append a new line to the end of the list -LineList *wxFileConfig::LineListAppend(const wxString& str) +wxFileConfigLineList *wxFileConfig::LineListAppend(const wxString& str) { - LineList *pLine = new LineList(str); + wxFileConfigLineList *pLine = new wxFileConfigLineList(str); if ( m_linesTail == NULL ) { // list is empty @@ -935,13 +1053,13 @@ LineList *wxFileConfig::LineListAppend(const wxString& str) } // insert a new line after the given one or in the very beginning if !pLine -LineList *wxFileConfig::LineListInsert(const wxString& str, - LineList *pLine) +wxFileConfigLineList *wxFileConfig::LineListInsert(const wxString& str, + wxFileConfigLineList *pLine) { if ( pLine == m_linesTail ) return LineListAppend(str); - LineList *pNewLine = new LineList(str); + wxFileConfigLineList *pNewLine = new wxFileConfigLineList(str); if ( pLine == NULL ) { // prepend to the list pNewLine->SetNext(m_linesHead); @@ -950,7 +1068,7 @@ LineList *wxFileConfig::LineListInsert(const wxString& str, } else { // insert before pLine - LineList *pNext = pLine->Next(); + wxFileConfigLineList *pNext = pLine->Next(); pNewLine->SetNext(pNext); pNewLine->SetPrev(pLine); pNext->SetPrev(pNewLine); @@ -960,9 +1078,9 @@ LineList *wxFileConfig::LineListInsert(const wxString& str, return pNewLine; } -void wxFileConfig::LineListRemove(LineList *pLine) +void wxFileConfig::LineListRemove(wxFileConfigLineList *pLine) { - LineList *pPrev = pLine->Prev(), + wxFileConfigLineList *pPrev = pLine->Prev(), *pNext = pLine->Next(); // first entry? @@ -986,7 +1104,7 @@ bool wxFileConfig::LineListIsEmpty() } // ============================================================================ -// wxFileConfig::ConfigGroup +// wxFileConfig::wxFileConfigGroup // ============================================================================ // ---------------------------------------------------------------------------- @@ -994,7 +1112,7 @@ bool wxFileConfig::LineListIsEmpty() // ---------------------------------------------------------------------------- // ctor -ConfigGroup::ConfigGroup(ConfigGroup *pParent, +wxFileConfigGroup::wxFileConfigGroup(wxFileConfigGroup *pParent, const wxString& strName, wxFileConfig *pConfig) : m_aEntries(CompareEntries), @@ -1011,7 +1129,7 @@ ConfigGroup::ConfigGroup(ConfigGroup *pParent, } // dtor deletes all children -ConfigGroup::~ConfigGroup() +wxFileConfigGroup::~wxFileConfigGroup() { // entries size_t n, nCount = m_aEntries.Count(); @@ -1028,7 +1146,7 @@ ConfigGroup::~ConfigGroup() // line // ---------------------------------------------------------------------------- -void ConfigGroup::SetLine(LineList *pLine) +void wxFileConfigGroup::SetLine(wxFileConfigLineList *pLine) { wxASSERT( m_pLine == NULL ); // shouldn't be called twice @@ -1069,10 +1187,10 @@ void ConfigGroup::SetLine(LineList *pLine) // Return the line which contains "[our name]". If we're still not in the list, // add our line to it immediately after the last line of our parent group if we // have it or in the very beginning if we're the root group. -LineList *ConfigGroup::GetGroupLine() +wxFileConfigLineList *wxFileConfigGroup::GetGroupLine() { if ( m_pLine == NULL ) { - ConfigGroup *pParent = Parent(); + wxFileConfigGroup *pParent = Parent(); // this group wasn't present in local config file, add it now if ( pParent != NULL ) { @@ -1097,12 +1215,12 @@ LineList *ConfigGroup::GetGroupLine() // Return the last line belonging to the subgroups of this group (after which // we can add a new subgroup), if we don't have any subgroups or entries our // last line is the group line (m_pLine) itself. -LineList *ConfigGroup::GetLastGroupLine() +wxFileConfigLineList *wxFileConfigGroup::GetLastGroupLine() { // if we have any subgroups, our last line is the last line of the last // subgroup if ( m_pLastGroup != NULL ) { - LineList *pLine = m_pLastGroup->GetLastGroupLine(); + wxFileConfigLineList *pLine = m_pLastGroup->GetLastGroupLine(); wxASSERT( pLine != NULL ); // last group must have !NULL associated line return pLine; @@ -1115,10 +1233,10 @@ LineList *ConfigGroup::GetLastGroupLine() // return the last line belonging to the entries of this group (after which // we can add a new entry), if we don't have any entries we will add the new // one immediately after the group line itself. -LineList *ConfigGroup::GetLastEntryLine() +wxFileConfigLineList *wxFileConfigGroup::GetLastEntryLine() { if ( m_pLastEntry != NULL ) { - LineList *pLine = m_pLastEntry->GetLine(); + wxFileConfigLineList *pLine = m_pLastEntry->GetLine(); wxASSERT( pLine != NULL ); // last entry must have !NULL associated line return pLine; @@ -1132,11 +1250,11 @@ LineList *ConfigGroup::GetLastEntryLine() // group name // ---------------------------------------------------------------------------- -void ConfigGroup::Rename(const wxString& newName) +void wxFileConfigGroup::Rename(const wxString& newName) { m_strName = newName; - LineList *line = GetGroupLine(); + wxFileConfigLineList *line = GetGroupLine(); wxString strFullName; strFullName << wxT("[") << (GetFullName().c_str() + 1) << wxT("]"); // +1: no '/' line->SetText(strFullName); @@ -1144,7 +1262,7 @@ void ConfigGroup::Rename(const wxString& newName) SetDirty(); } -wxString ConfigGroup::GetFullName() const +wxString wxFileConfigGroup::GetFullName() const { if ( Parent() ) return Parent()->GetFullName() + wxCONFIG_PATH_SEPARATOR + Name(); @@ -1157,14 +1275,14 @@ wxString ConfigGroup::GetFullName() const // ---------------------------------------------------------------------------- // use binary search because the array is sorted -ConfigEntry * -ConfigGroup::FindEntry(const wxChar *szName) const +wxFileConfigEntry * +wxFileConfigGroup::FindEntry(const wxChar *szName) const { size_t i, lo = 0, hi = m_aEntries.Count(); int res; - ConfigEntry *pEntry; + wxFileConfigEntry *pEntry; while ( lo < hi ) { i = (lo + hi)/2; @@ -1187,14 +1305,14 @@ ConfigGroup::FindEntry(const wxChar *szName) const return NULL; } -ConfigGroup * -ConfigGroup::FindSubgroup(const wxChar *szName) const +wxFileConfigGroup * +wxFileConfigGroup::FindSubgroup(const wxChar *szName) const { size_t i, lo = 0, hi = m_aSubgroups.Count(); int res; - ConfigGroup *pGroup; + wxFileConfigGroup *pGroup; while ( lo < hi ) { i = (lo + hi)/2; @@ -1222,24 +1340,24 @@ ConfigGroup::FindSubgroup(const wxChar *szName) const // ---------------------------------------------------------------------------- // create a new entry and add it to the current group -ConfigEntry * -ConfigGroup::AddEntry(const wxString& strName, int nLine) +wxFileConfigEntry * +wxFileConfigGroup::AddEntry(const wxString& strName, int nLine) { wxASSERT( FindEntry(strName) == NULL ); - ConfigEntry *pEntry = new ConfigEntry(this, strName, nLine); + wxFileConfigEntry *pEntry = new wxFileConfigEntry(this, strName, nLine); m_aEntries.Add(pEntry); return pEntry; } // create a new group and add it to the current group -ConfigGroup * -ConfigGroup::AddSubgroup(const wxString& strName) +wxFileConfigGroup * +wxFileConfigGroup::AddSubgroup(const wxString& strName) { wxASSERT( FindSubgroup(strName) == NULL ); - ConfigGroup *pGroup = new ConfigGroup(this, strName, m_pConfig); + wxFileConfigGroup *pGroup = new wxFileConfigGroup(this, strName, m_pConfig); m_aSubgroups.Add(pGroup); return pGroup; @@ -1256,7 +1374,7 @@ ConfigGroup::AddSubgroup(const wxString& strName) delete several of them. */ -bool ConfigGroup::DeleteSubgroupByName(const wxChar *szName) +bool wxFileConfigGroup::DeleteSubgroupByName(const wxChar *szName) { return DeleteSubgroup(FindSubgroup(szName)); } @@ -1264,14 +1382,14 @@ bool ConfigGroup::DeleteSubgroupByName(const wxChar *szName) // doesn't delete the subgroup itself, but does remove references to it from // all other data structures (and normally the returned pointer should be // deleted a.s.a.p. because there is nothing much to be done with it anyhow) -bool ConfigGroup::DeleteSubgroup(ConfigGroup *pGroup) +bool wxFileConfigGroup::DeleteSubgroup(wxFileConfigGroup *pGroup) { wxCHECK( pGroup != NULL, FALSE ); // deleting non existing group? // delete all entries size_t nCount = pGroup->m_aEntries.Count(); for ( size_t nEntry = 0; nEntry < nCount; nEntry++ ) { - LineList *pLine = pGroup->m_aEntries[nEntry]->GetLine(); + wxFileConfigLineList *pLine = pGroup->m_aEntries[nEntry]->GetLine(); if ( pLine != NULL ) m_pConfig->LineListRemove(pLine); } @@ -1282,7 +1400,7 @@ bool ConfigGroup::DeleteSubgroup(ConfigGroup *pGroup) pGroup->DeleteSubgroup(pGroup->m_aSubgroups[0]); } - LineList *pLine = pGroup->m_pLine; + wxFileConfigLineList *pLine = pGroup->m_pLine; if ( pLine != NULL ) { // notice that we may do this test inside the previous "if" because the // last entry's line is surely !NULL @@ -1291,9 +1409,9 @@ bool ConfigGroup::DeleteSubgroup(ConfigGroup *pGroup) wxASSERT( m_pLine != NULL ); // we have a subgroup with !NULL pLine... // go back until we find a subgroup or reach the group's line - ConfigGroup *pNewLast = NULL; + wxFileConfigGroup *pNewLast = NULL; size_t n, nSubgroups = m_aSubgroups.Count(); - LineList *pl; + wxFileConfigLineList *pl; for ( pl = pLine->Prev(); pl != m_pLine; pl = pl->Prev() ) { // is it our subgroup? for ( n = 0; (pNewLast == NULL) && (n < nSubgroups); n++ ) { @@ -1328,12 +1446,12 @@ bool ConfigGroup::DeleteSubgroup(ConfigGroup *pGroup) return TRUE; } -bool ConfigGroup::DeleteEntry(const wxChar *szName) +bool wxFileConfigGroup::DeleteEntry(const wxChar *szName) { - ConfigEntry *pEntry = FindEntry(szName); + wxFileConfigEntry *pEntry = FindEntry(szName); wxCHECK( pEntry != NULL, FALSE ); // deleting non existing item? - LineList *pLine = pEntry->GetLine(); + wxFileConfigLineList *pLine = pEntry->GetLine(); if ( pLine != NULL ) { // notice that we may do this test inside the previous "if" because the // last entry's line is surely !NULL @@ -1342,9 +1460,9 @@ bool ConfigGroup::DeleteEntry(const wxChar *szName) wxASSERT( m_pLine != NULL ); // if we have an entry with !NULL pLine... // go back until we find another entry or reach the group's line - ConfigEntry *pNewLast = NULL; + wxFileConfigEntry *pNewLast = NULL; size_t n, nEntries = m_aEntries.Count(); - LineList *pl; + wxFileConfigLineList *pl; for ( pl = pLine->Prev(); pl != m_pLine; pl = pl->Prev() ) { // is it our subgroup? for ( n = 0; (pNewLast == NULL) && (n < nEntries); n++ ) { @@ -1381,7 +1499,7 @@ bool ConfigGroup::DeleteEntry(const wxChar *szName) // ---------------------------------------------------------------------------- // // ---------------------------------------------------------------------------- -void ConfigGroup::SetDirty() +void wxFileConfigGroup::SetDirty() { m_bDirty = TRUE; if ( Parent() != NULL ) // propagate upwards @@ -1389,13 +1507,13 @@ void ConfigGroup::SetDirty() } // ============================================================================ -// wxFileConfig::ConfigEntry +// wxFileConfig::wxFileConfigEntry // ============================================================================ // ---------------------------------------------------------------------------- // ctor // ---------------------------------------------------------------------------- -ConfigEntry::ConfigEntry(ConfigGroup *pParent, +wxFileConfigEntry::wxFileConfigEntry(wxFileConfigGroup *pParent, const wxString& strName, int nLine) : m_strName(strName) @@ -1406,7 +1524,8 @@ ConfigEntry::ConfigEntry(ConfigGroup *pParent, m_nLine = nLine; m_pLine = NULL; - m_bDirty = FALSE; + m_bDirty = + m_bHasValue = FALSE; m_bImmutable = strName[0] == wxCONFIG_IMMUTABLE_PREFIX; if ( m_bImmutable ) @@ -1417,7 +1536,7 @@ ConfigEntry::ConfigEntry(ConfigGroup *pParent, // set value // ---------------------------------------------------------------------------- -void ConfigEntry::SetLine(LineList *pLine) +void wxFileConfigEntry::SetLine(wxFileConfigLineList *pLine) { if ( m_pLine != NULL ) { wxLogWarning(_("entry '%s' appears more than once in group '%s'"), @@ -1430,7 +1549,7 @@ void ConfigEntry::SetLine(LineList *pLine) // second parameter is FALSE if we read the value from file and prevents the // entry from being marked as 'dirty' -void ConfigEntry::SetValue(const wxString& strValue, bool bUser) +void wxFileConfigEntry::SetValue(const wxString& strValue, bool bUser) { if ( bUser && IsImmutable() ) { wxLogWarning(_("attempt to change immutable key '%s' ignored."), @@ -1438,10 +1557,12 @@ void ConfigEntry::SetValue(const wxString& strValue, bool bUser) return; } - // do nothing if it's the same value - if ( strValue == m_strValue ) + // do nothing if it's the same value: but don't test for it if m_bHasValue + // hadn't been set yet or we'd never write empty values to the file + if ( m_bHasValue && strValue == m_strValue ) return; + m_bHasValue = TRUE; m_strValue = strValue; if ( bUser ) { @@ -1466,7 +1587,7 @@ void ConfigEntry::SetValue(const wxString& strValue, bool bUser) } } -void ConfigEntry::SetDirty() +void wxFileConfigEntry::SetDirty() { m_bDirty = TRUE; Group()->SetDirty(); @@ -1480,8 +1601,7 @@ void ConfigEntry::SetDirty() // compare functions for array sorting // ---------------------------------------------------------------------------- -int CompareEntries(ConfigEntry *p1, - ConfigEntry *p2) +int CompareEntries(wxFileConfigEntry *p1, wxFileConfigEntry *p2) { #if wxCONFIG_CASE_SENSITIVE return wxStrcmp(p1->Name(), p2->Name()); @@ -1490,8 +1610,7 @@ int CompareEntries(ConfigEntry *p1, #endif } -int CompareGroups(ConfigGroup *p1, - ConfigGroup *p2) +int CompareGroups(wxFileConfigGroup *p1, wxFileConfigGroup *p2) { #if wxCONFIG_CASE_SENSITIVE return wxStrcmp(p1->Name(), p2->Name());