X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/701fb11eb5c1b04cd903e630e345c977a820e0b6..98cb8dcb0cf3b0e660f1f67e1c02451ab10257de:/src/common/fileconf.cpp diff --git a/src/common/fileconf.cpp b/src/common/fileconf.cpp index 40e7383cf5..3a25662db7 100644 --- a/src/common/fileconf.cpp +++ b/src/common/fileconf.cpp @@ -1,5 +1,5 @@ /////////////////////////////////////////////////////////////////////////////// -// Name: fileconf.cpp +// Name: src/common/fileconf.cpp // Purpose: implementation of wxFileConfig derivation of wxConfig // Author: Vadim Zeitlin // Modified by: @@ -10,10 +10,6 @@ // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) -#pragma implementation "fileconf.h" -#endif - // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- @@ -49,6 +45,7 @@ #if defined(__WXMAC__) #include "wx/mac/private.h" // includes mac headers + #include "wx/filename.h" // for MacSetTypeAndCreator #endif #if defined(__WXMSW__) @@ -205,6 +202,9 @@ private: // DeleteSubgroupByName helper bool DeleteSubgroup(wxFileConfigGroup *pGroup); + // used by Rename() + void UpdateGroupAndSubgroupsLines(); + public: // ctor wxFileConfigGroup(wxFileConfigGroup *pParent, const wxString& strName, wxFileConfig *); @@ -271,7 +271,7 @@ wxString wxFileConfig::GetGlobalDir() strDir = wxMacFindFolder( (short) kOnSystemDisk, kPreferencesFolderType, kDontCreateFolder ) ; #elif defined( __UNIX__ ) strDir = wxT("/etc/"); -#elif defined(__WXPM__) +#elif defined(__OS2__) ULONG aulSysInfo[QSV_MAX] = {0}; UINT drive; APIRET rc; @@ -287,8 +287,11 @@ wxString wxFileConfig::GetGlobalDir() #elif defined(__DOS__) // There's no such thing as global cfg dir in MS-DOS, let's return // current directory (FIXME_MGL?) - return wxT(".\\"); + strDir = wxT(".\\"); +#elif defined(__WXWINCE__) + strDir = wxT("\\Windows\\"); #else // Windows + wxChar szWinDir[MAX_PATH]; ::GetWindowsDirectory(szWinDir, MAX_PATH); @@ -375,7 +378,7 @@ wxString wxFileConfig::GetLocalFileName(const wxChar *szFile) void wxFileConfig::Init() { m_pCurrentGroup = - m_pRootGroup = new wxFileConfigGroup(NULL, wxT(""), this); + m_pRootGroup = new wxFileConfigGroup(NULL, wxEmptyString, this); m_linesHead = m_linesTail = NULL; @@ -383,7 +386,7 @@ void wxFileConfig::Init() // It's not an error if (one of the) file(s) doesn't exist. // parse the global file - if ( !m_strGlobalFile.IsEmpty() && wxFile::Exists(m_strGlobalFile) ) + if ( !m_strGlobalFile.empty() && wxFile::Exists(m_strGlobalFile) ) { wxTextFile fileGlobal(m_strGlobalFile); @@ -399,7 +402,7 @@ void wxFileConfig::Init() } // parse the local file - if ( !m_strLocalFile.IsEmpty() && wxFile::Exists(m_strLocalFile) ) + if ( !m_strLocalFile.empty() && wxFile::Exists(m_strLocalFile) ) { wxTextFile fileLocal(m_strLocalFile); if ( fileLocal.Open(m_conv/*ignored in ANSI build*/) ) @@ -427,36 +430,36 @@ wxFileConfig::wxFileConfig(const wxString& appName, const wxString& vendorName, m_conv(conv) { // Make up names for files if empty - if ( m_strLocalFile.IsEmpty() && (style & wxCONFIG_USE_LOCAL_FILE) ) + if ( m_strLocalFile.empty() && (style & wxCONFIG_USE_LOCAL_FILE) ) m_strLocalFile = GetLocalFileName(GetAppName()); - if ( m_strGlobalFile.IsEmpty() && (style & wxCONFIG_USE_GLOBAL_FILE) ) + if ( m_strGlobalFile.empty() && (style & wxCONFIG_USE_GLOBAL_FILE) ) m_strGlobalFile = GetGlobalFileName(GetAppName()); // Check if styles are not supplied, but filenames are, in which case // add the correct styles. - if ( !m_strLocalFile.IsEmpty() ) + if ( !m_strLocalFile.empty() ) SetStyle(GetStyle() | wxCONFIG_USE_LOCAL_FILE); - if ( !m_strGlobalFile.IsEmpty() ) + if ( !m_strGlobalFile.empty() ) SetStyle(GetStyle() | wxCONFIG_USE_GLOBAL_FILE); // if the path is not absolute, prepend the standard directory to it // UNLESS wxCONFIG_USE_RELATIVE_PATH style is set if ( !(style & wxCONFIG_USE_RELATIVE_PATH) ) { - if ( !m_strLocalFile.IsEmpty() && !wxIsAbsolutePath(m_strLocalFile) ) + if ( !m_strLocalFile.empty() && !wxIsAbsolutePath(m_strLocalFile) ) { - wxString strLocal = m_strLocalFile; + const wxString strLocalOrig = m_strLocalFile; m_strLocalFile = GetLocalDir(); - m_strLocalFile << strLocal; + m_strLocalFile << strLocalOrig; } - if ( !m_strGlobalFile.IsEmpty() && !wxIsAbsolutePath(m_strGlobalFile) ) + if ( !m_strGlobalFile.empty() && !wxIsAbsolutePath(m_strGlobalFile) ) { - wxString strGlobal = m_strGlobalFile; + const wxString strGlobalOrig = m_strGlobalFile; m_strGlobalFile = GetGlobalDir(); - m_strGlobalFile << strGlobal; + m_strGlobalFile << strGlobalOrig; } } @@ -474,7 +477,7 @@ wxFileConfig::wxFileConfig(wxInputStream &inStream, wxMBConv& conv) SetStyle(GetStyle() | wxCONFIG_USE_LOCAL_FILE); m_pCurrentGroup = - m_pRootGroup = new wxFileConfigGroup(NULL, wxT(""), this); + m_pRootGroup = new wxFileConfigGroup(NULL, wxEmptyString, this); m_linesHead = m_linesTail = NULL; @@ -488,7 +491,7 @@ wxFileConfig::wxFileConfig(wxInputStream &inStream, wxMBConv& conv) char buf[1024]; do { - inStream.Read(buf, WXSIZEOF(buf)); + inStream.Read(buf, WXSIZEOF(buf)-1); // leave room for the NULL const wxStreamError err = inStream.GetLastError(); @@ -498,7 +501,12 @@ wxFileConfig::wxFileConfig(wxInputStream &inStream, wxMBConv& conv) break; } - strTmp.append(wxConvertMB2WX(buf), inStream.LastRead()); + // FIXME: this is broken because if we have part of multibyte + // character in the buffer (and another part hasn't been + // read yet) we're going to lose data because of conversion + // errors + buf[inStream.LastRead()] = '\0'; + strTmp += conv.cMB2WX(buf); } while ( !inStream.Eof() ); @@ -536,34 +544,35 @@ wxFileConfig::wxFileConfig(wxInputStream &inStream, wxMBConv& conv) Parse(memText, true /* local */); SetRootPath(); + ResetDirty(); } #endif // wxUSE_STREAMS void wxFileConfig::CleanUp() { - delete m_pRootGroup; + delete m_pRootGroup; - wxFileConfigLineList *pCur = m_linesHead; - while ( pCur != NULL ) { - wxFileConfigLineList *pNext = pCur->Next(); - delete pCur; - pCur = pNext; - } + wxFileConfigLineList *pCur = m_linesHead; + while ( pCur != NULL ) { + wxFileConfigLineList *pNext = pCur->Next(); + delete pCur; + pCur = pNext; + } } wxFileConfig::~wxFileConfig() { - Flush(); + Flush(); - CleanUp(); + CleanUp(); } // ---------------------------------------------------------------------------- // parse a config file // ---------------------------------------------------------------------------- -void wxFileConfig::Parse(wxTextBuffer& buffer, bool bLocal) +void wxFileConfig::Parse(const wxTextBuffer& buffer, bool bLocal) { const wxChar *pStart; const wxChar *pEnd; @@ -580,7 +589,7 @@ void wxFileConfig::Parse(wxTextBuffer& buffer, bool bLocal) { LineListAppend(strLine); - // let the root group have it start line as well + // let the root group have its start line as well if ( !n ) { m_pCurrentGroup->SetLine(m_linesTail); @@ -655,7 +664,7 @@ void wxFileConfig::Parse(wxTextBuffer& buffer, bool bLocal) } } else { // a key - const wxChar *pEnd = pStart; + pEnd = pStart; while ( *pEnd && *pEnd != wxT('=') /* && !wxIsspace(*pEnd)*/ ) { if ( *pEnd == wxT('\\') ) { // next character may be space or not - still take it because it's @@ -729,45 +738,59 @@ void wxFileConfig::Parse(wxTextBuffer& buffer, bool bLocal) void wxFileConfig::SetRootPath() { - m_strPath.Empty(); - m_pCurrentGroup = m_pRootGroup; + m_strPath.Empty(); + m_pCurrentGroup = m_pRootGroup; } -void wxFileConfig::SetPath(const wxString& strPath) +bool +wxFileConfig::DoSetPath(const wxString& strPath, bool createMissingComponents) { - wxArrayString aParts; + wxArrayString aParts; - if ( strPath.IsEmpty() ) { - SetRootPath(); - return; - } + if ( strPath.empty() ) { + SetRootPath(); + return true; + } - if ( strPath[0] == wxCONFIG_PATH_SEPARATOR ) { - // absolute path - wxSplitPath(aParts, strPath); - } - else { - // relative path, combine with current one - wxString strFullPath = m_strPath; - strFullPath << wxCONFIG_PATH_SEPARATOR << strPath; - wxSplitPath(aParts, strFullPath); - } + if ( strPath[0] == wxCONFIG_PATH_SEPARATOR ) { + // absolute path + wxSplitPath(aParts, strPath); + } + else { + // relative path, combine with current one + wxString strFullPath = m_strPath; + strFullPath << wxCONFIG_PATH_SEPARATOR << strPath; + wxSplitPath(aParts, strFullPath); + } - // change current group - size_t n; - m_pCurrentGroup = m_pRootGroup; - for ( n = 0; n < aParts.Count(); n++ ) { - wxFileConfigGroup *pNextGroup = m_pCurrentGroup->FindSubgroup(aParts[n]); - if ( pNextGroup == NULL ) - pNextGroup = m_pCurrentGroup->AddSubgroup(aParts[n]); - m_pCurrentGroup = pNextGroup; - } + // change current group + size_t n; + m_pCurrentGroup = m_pRootGroup; + for ( n = 0; n < aParts.Count(); n++ ) { + wxFileConfigGroup *pNextGroup = m_pCurrentGroup->FindSubgroup(aParts[n]); + if ( pNextGroup == NULL ) + { + if ( !createMissingComponents ) + return false; - // recombine path parts in one variable - m_strPath.Empty(); - for ( n = 0; n < aParts.Count(); n++ ) { - m_strPath << wxCONFIG_PATH_SEPARATOR << aParts[n]; - } + pNextGroup = m_pCurrentGroup->AddSubgroup(aParts[n]); + } + + m_pCurrentGroup = pNextGroup; + } + + // recombine path parts in one variable + m_strPath.Empty(); + for ( n = 0; n < aParts.Count(); n++ ) { + m_strPath << wxCONFIG_PATH_SEPARATOR << aParts[n]; + } + + return true; +} + +void wxFileConfig::SetPath(const wxString& strPath) +{ + DoSetPath(strPath, true /* create missing path components */); } // ---------------------------------------------------------------------------- @@ -776,66 +799,66 @@ void wxFileConfig::SetPath(const wxString& strPath) bool wxFileConfig::GetFirstGroup(wxString& str, long& lIndex) const { - lIndex = 0; - return GetNextGroup(str, lIndex); + lIndex = 0; + return GetNextGroup(str, lIndex); } bool wxFileConfig::GetNextGroup (wxString& str, long& lIndex) const { - if ( size_t(lIndex) < m_pCurrentGroup->Groups().Count() ) { - str = m_pCurrentGroup->Groups()[(size_t)lIndex++]->Name(); - return true; - } - else - return false; + if ( size_t(lIndex) < m_pCurrentGroup->Groups().Count() ) { + str = m_pCurrentGroup->Groups()[(size_t)lIndex++]->Name(); + return true; + } + else + return false; } bool wxFileConfig::GetFirstEntry(wxString& str, long& lIndex) const { - lIndex = 0; - return GetNextEntry(str, lIndex); + lIndex = 0; + return GetNextEntry(str, lIndex); } bool wxFileConfig::GetNextEntry (wxString& str, long& lIndex) const { - if ( size_t(lIndex) < m_pCurrentGroup->Entries().Count() ) { - str = m_pCurrentGroup->Entries()[(size_t)lIndex++]->Name(); - return true; - } - else - return false; + if ( size_t(lIndex) < m_pCurrentGroup->Entries().Count() ) { + str = m_pCurrentGroup->Entries()[(size_t)lIndex++]->Name(); + return true; + } + else + return false; } size_t wxFileConfig::GetNumberOfEntries(bool bRecursive) const { - size_t n = m_pCurrentGroup->Entries().Count(); - if ( bRecursive ) { - 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]; - n += GetNumberOfEntries(true); - CONST_CAST m_pCurrentGroup = pOldCurrentGroup; + size_t n = m_pCurrentGroup->Entries().Count(); + if ( bRecursive ) { + 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]; + n += GetNumberOfEntries(true); + CONST_CAST m_pCurrentGroup = pOldCurrentGroup; + } } - } - return n; + return n; } size_t wxFileConfig::GetNumberOfGroups(bool bRecursive) const { - size_t n = m_pCurrentGroup->Groups().Count(); - if ( bRecursive ) { - 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]; - n += GetNumberOfGroups(true); - CONST_CAST m_pCurrentGroup = pOldCurrentGroup; + size_t n = m_pCurrentGroup->Groups().Count(); + if ( bRecursive ) { + 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]; + n += GetNumberOfGroups(true); + CONST_CAST m_pCurrentGroup = pOldCurrentGroup; + } } - } - return n; + return n; } // ---------------------------------------------------------------------------- @@ -844,18 +867,28 @@ size_t wxFileConfig::GetNumberOfGroups(bool bRecursive) const bool wxFileConfig::HasGroup(const wxString& strName) const { - wxConfigPathChanger path(this, strName); + // special case: DoSetPath("") does work as it's equivalent to DoSetPath("/") + // but there is no group with empty name so treat this separately + if ( strName.empty() ) + return false; + + const wxString pathOld = GetPath(); + + wxFileConfig *self = wx_const_cast(wxFileConfig *, this); + const bool + rc = self->DoSetPath(strName, false /* don't create missing components */); - wxFileConfigGroup *pGroup = m_pCurrentGroup->FindSubgroup(path.Name()); - return pGroup != NULL; + self->SetPath(pathOld); + + return rc; } bool wxFileConfig::HasEntry(const wxString& strName) const { - wxConfigPathChanger path(this, strName); + wxConfigPathChanger path(this, strName); - wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name()); - return pEntry != NULL; + wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name()); + return pEntry != NULL; } // ---------------------------------------------------------------------------- @@ -864,16 +897,16 @@ bool wxFileConfig::HasEntry(const wxString& strName) const bool wxFileConfig::DoReadString(const wxString& key, wxString* pStr) const { - wxConfigPathChanger path(this, key); + wxConfigPathChanger path(this, key); - wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name()); - if (pEntry == NULL) { - return false; - } + wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name()); + if (pEntry == NULL) { + return false; + } - *pStr = pEntry->Value(); + *pStr = pEntry->Value(); - return true; + return true; } bool wxFileConfig::DoReadLong(const wxString& key, long *pl) const @@ -899,11 +932,11 @@ bool wxFileConfig::DoWriteString(const wxString& key, const wxString& szValue) szValue.c_str(), GetPath().c_str() ); - if ( strName.IsEmpty() ) + if ( strName.empty() ) { // setting the value of a group is an error - wxASSERT_MSG( wxIsEmpty(szValue), wxT("can't set value of a group!") ); + wxASSERT_MSG( szValue.empty(), wxT("can't set value of a group!") ); // ... except if it's empty in which case it's a way to force it's creation @@ -1006,7 +1039,9 @@ bool wxFileConfig::Save(wxOutputStream& os, wxMBConv& conv) { wxString line = p->Text(); line += wxTextFile::GetEOL(); - if ( !os.Write(line.mb_str(conv), line.length()) ) + + wxCharBuffer buf(line.mb_str(conv)); + if ( !os.Write(buf, strlen(buf)) ) { wxLogError(_("Error saving user configuration data.")); @@ -1028,6 +1063,9 @@ bool wxFileConfig::Save(wxOutputStream& os, wxMBConv& conv) bool wxFileConfig::RenameEntry(const wxString& oldName, const wxString& newName) { + wxASSERT_MSG( !wxStrchr(oldName, wxCONFIG_PATH_SEPARATOR), + _T("RenameEntry(): paths are not supported") ); + // check that the entry exists wxFileConfigEntry *oldEntry = m_pCurrentGroup->FindEntry(oldName); if ( !oldEntry ) @@ -1080,12 +1118,13 @@ bool wxFileConfig::DeleteEntry(const wxString& key, bool bGroupIfEmptyAlso) if ( !m_pCurrentGroup->DeleteEntry(path.Name()) ) return false; + SetDirty(); + if ( bGroupIfEmptyAlso && m_pCurrentGroup->IsEmpty() ) { if ( m_pCurrentGroup != m_pRootGroup ) { wxFileConfigGroup *pGroup = m_pCurrentGroup; SetPath(wxT("..")); // changes m_pCurrentGroup! - if ( m_pCurrentGroup->DeleteSubgroupByName(pGroup->Name()) ) - SetDirty(); + m_pCurrentGroup->DeleteSubgroupByName(pGroup->Name()); } //else: never delete the root group } @@ -1119,7 +1158,7 @@ bool wxFileConfig::DeleteAll() } m_strLocalFile = - m_strGlobalFile = wxT(""); + m_strGlobalFile = wxEmptyString; } Init(); @@ -1246,6 +1285,9 @@ void wxFileConfig::LineListRemove(wxFileConfigLineList *pLine) else pNext->SetPrev(pPrev); + if ( m_pRootGroup->GetGroupLine() == pLine ) + m_pRootGroup->SetLine(m_linesHead); + wxLogTrace( FILECONF_TRACE_MASK, _T(" head: %s"), ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) ); @@ -1305,7 +1347,11 @@ wxFileConfigGroup::~wxFileConfigGroup() void wxFileConfigGroup::SetLine(wxFileConfigLineList *pLine) { - wxASSERT( m_pLine == 0 ); // shouldn't be called twice + // for a normal (i.e. not root) group this method shouldn't be called twice + // unless we are resetting the line + wxASSERT_MSG( !m_pParent || !m_pLine || !pLine, + _T("changing line for a non-root group?") ); + m_pLine = pLine; } @@ -1442,28 +1488,41 @@ void wxFileConfigGroup::SetLastEntry(wxFileConfigEntry *pEntry) // group name // ---------------------------------------------------------------------------- +void wxFileConfigGroup::UpdateGroupAndSubgroupsLines() +{ + // update the line of this group + wxFileConfigLineList *line = GetGroupLine(); + wxCHECK_RET( line, _T("a non root group must have a corresponding line!") ); + + // +1: skip the leading '/' + line->SetText(wxString::Format(_T("[%s]"), GetFullName().c_str() + 1)); + + + // also update all subgroups as they have this groups name in their lines + const size_t nCount = m_aSubgroups.Count(); + for ( size_t n = 0; n < nCount; n++ ) + { + m_aSubgroups[n]->UpdateGroupAndSubgroupsLines(); + } +} + void wxFileConfigGroup::Rename(const wxString& newName) { wxCHECK_RET( m_pParent, _T("the root group can't be renamed") ); m_strName = newName; - // +1: no leading '/' - wxString strFullName; - strFullName << wxT("[") << (GetFullName().c_str() + 1) << wxT("]"); - - wxFileConfigLineList *line = GetGroupLine(); - wxCHECK_RET( line, _T("a non root group must have a corresponding line!") ); - - line->SetText(strFullName); + // update the group lines recursively + UpdateGroupAndSubgroupsLines(); } wxString wxFileConfigGroup::GetFullName() const { - if ( Parent() ) - return Parent()->GetFullName() + wxCONFIG_PATH_SEPARATOR + Name(); - else - return wxT(""); + wxString fullname; + if ( Parent() ) + fullname = Parent()->GetFullName() + wxCONFIG_PATH_SEPARATOR + Name(); + + return fullname; } // ---------------------------------------------------------------------------- @@ -1747,7 +1806,7 @@ wxFileConfigEntry::wxFileConfigEntry(wxFileConfigGroup *pParent, int nLine) : m_strName(strName) { - wxASSERT( !strName.IsEmpty() ); + wxASSERT( !strName.empty() ); m_pParent = pParent; m_nLine = nLine; @@ -1816,7 +1875,10 @@ void wxFileConfigEntry::SetValue(const wxString& strValue, bool bUser) } else // this entry didn't exist in the local file { - // add a new line to the file + // add a new line to the file: note that line returned by + // GetLastEntryLine() may be NULL if we're in the root group and it + // doesn't have any entries yet, but this is ok as passing NULL + // line to LineListInsert() means to prepend new line to the list wxFileConfigLineList *line = Group()->GetLastEntryLine(); m_pLine = Group()->Config()->LineListInsert(strLine, line); @@ -1861,7 +1923,7 @@ static wxString FilterInValue(const wxString& str) wxString strResult; strResult.Alloc(str.Len()); - bool bQuoted = !str.IsEmpty() && str[0] == '"'; + bool bQuoted = !str.empty() && str[0] == '"'; for ( size_t n = bQuoted ? 1 : 0; n < str.Len(); n++ ) { if ( str[n] == wxT('\\') ) { @@ -2014,4 +2076,3 @@ static wxString GetAppName(const wxString& appName) } #endif // wxUSE_CONFIG -