X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/01b18927f5d2ebde31f0e096283cb993a3cbdfcd..69659fd770f615210efac4b4fa741b3ad6223616:/src/common/fileconf.cpp?ds=sidebyside diff --git a/src/common/fileconf.cpp b/src/common/fileconf.cpp index 071b90f243..ab3c4a0f49 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,63 +10,57 @@ // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) -#pragma implementation "fileconf.h" -#endif - // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- +// For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #ifdef __BORLANDC__ - #pragma hdrstop + #pragma hdrstop #endif //__BORLANDC__ #if wxUSE_CONFIG && wxUSE_FILECONFIG #ifndef WX_PRECOMP - #include "wx/string.h" - #include "wx/intl.h" + #include "wx/dynarray.h" + #include "wx/string.h" + #include "wx/intl.h" + #include "wx/log.h" + #include "wx/app.h" + #include "wx/utils.h" // for wxGetHomeDir + #if wxUSE_STREAMS + #include "wx/stream.h" + #endif // wxUSE_STREAMS #endif //WX_PRECOMP -#include "wx/app.h" -#include "wx/dynarray.h" #include "wx/file.h" -#include "wx/log.h" #include "wx/textfile.h" #include "wx/memtext.h" #include "wx/config.h" #include "wx/fileconf.h" +#include "wx/filefn.h" -#if wxUSE_STREAMS - #include "wx/stream.h" -#endif // wxUSE_STREAMS +#include "wx/base64.h" -#include "wx/utils.h" // for wxGetHomeDir +#include "wx/stdpaths.h" #if defined(__WXMAC__) - #include "wx/mac/private.h" // includes mac headers + #include "wx/mac/private.h" // includes mac headers #endif #if defined(__WXMSW__) - #include "wx/msw/private.h" + #include "wx/msw/private.h" #endif //windows.h #if defined(__WXPM__) - #define INCL_DOS - #include + #define INCL_DOS + #include #endif #include #include -// headers needed for umask() -#ifdef __UNIX__ - #include - #include -#endif // __UNIX__ - // ---------------------------------------------------------------------------- // macros // ---------------------------------------------------------------------------- @@ -77,9 +71,11 @@ // ---------------------------------------------------------------------------- #ifndef MAX_PATH - #define MAX_PATH 512 + #define MAX_PATH 512 #endif +#define FILECONF_TRACE_MASK _T("fileconf") + // ---------------------------------------------------------------------------- // global functions declarations // ---------------------------------------------------------------------------- @@ -159,8 +155,7 @@ private: wxString m_strName, // entry name m_strValue; // value - bool m_bDirty:1, // changed since last read? - m_bImmutable:1, // can be overriden locally? + bool 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 @@ -177,7 +172,6 @@ public: 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; } @@ -185,8 +179,7 @@ public: GetLine() const { return m_pLine; } // modify entry attributes - void SetValue(const wxString& strValue, bool bUser = TRUE); - void SetDirty(); + void SetValue(const wxString& strValue, bool bUser = true); void SetLine(wxFileConfigLineList *pLine); DECLARE_NO_COPY_CLASS(wxFileConfigEntry) @@ -204,7 +197,6 @@ private: 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) @@ -212,6 +204,9 @@ private: // DeleteSubgroupByName helper bool DeleteSubgroup(wxFileConfigGroup *pGroup); + // used by Rename() + void UpdateGroupAndSubgroupsLines(); + public: // ctor wxFileConfigGroup(wxFileConfigGroup *pParent, const wxString& strName, wxFileConfig *); @@ -223,26 +218,23 @@ public: 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; + wxFileConfigGroup *FindSubgroup(const wxString& name) const; + wxFileConfigEntry *FindEntry (const wxString& name) const; - // delete entry/subgroup, return FALSE if doesn't exist - bool DeleteSubgroupByName(const wxChar *szName); - bool DeleteEntry(const wxChar *szName); + // delete entry/subgroup, return false if doesn't exist + bool DeleteSubgroupByName(const wxString& name); + bool DeleteEntry(const wxString& name); // 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! @@ -271,121 +263,82 @@ public: // ---------------------------------------------------------------------------- // static functions // ---------------------------------------------------------------------------- -wxString wxFileConfig::GetGlobalDir() -{ - wxString strDir; -#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__) - ULONG aulSysInfo[QSV_MAX] = {0}; - UINT drive; - APIRET rc; - - rc = DosQuerySysInfo( 1L, QSV_MAX, (PVOID)aulSysInfo, sizeof(ULONG)*QSV_MAX); - if (rc == 0) +// this function modifies in place the given wxFileName object if it doesn't +// already have an extension +// +// note that it's slightly misnamed under Mac as there it doesn't add an +// extension but modifies the file name instead, so you shouldn't suppose that +// fn.HasExt() is true after it returns +static void AddConfFileExtIfNeeded(wxFileName& fn) +{ + if ( !fn.HasExt() ) { - drive = aulSysInfo[QSV_BOOT_DRIVE - 1]; - strDir.Printf(wxT("%c:\\OS2\\"), 'A'+drive-1); +#if defined( __WXMAC__ ) + fn.SetName(fn.GetName() + wxT(" Preferences")); +#elif defined( __UNIX__ ) + fn.SetExt(wxT(".conf")); +#else // Windows + fn.SetExt(wxT(".ini")); +#endif // UNIX/Win } -#elif defined(__WXSTUBS__) - wxASSERT_MSG( FALSE, wxT("TODO") ) ; -#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); - - strDir = szWinDir; - strDir << wxT('\\'); -#endif // Unix/Windows - - return strDir; } -wxString wxFileConfig::GetLocalDir() +wxString wxFileConfig::GetGlobalDir() { - wxString strDir; - -#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 - if (strDir.Last() != wxT('\\')) strDir << wxT('\\'); -#endif -#endif - - return strDir; + return wxStandardPaths::Get().GetConfigDir(); } -wxString wxFileConfig::GetGlobalFileName(const wxChar *szFile) +wxString wxFileConfig::GetLocalDir(int style) { - wxString str = GetGlobalDir(); - str << szFile; + wxUnusedVar(style); - if ( wxStrchr(szFile, wxT('.')) == NULL ) -#if defined( __WXMAC__ ) - str << wxT(" Preferences") ; -#elif defined( __UNIX__ ) - str << wxT(".conf"); -#else // Windows - str << wxT(".ini"); -#endif // UNIX/Win + wxStandardPathsBase& stdp = wxStandardPaths::Get(); - return str; + // it so happens that user data directory is a subdirectory of user config + // directory on all supported platforms, which explains why we use it here + return style & wxCONFIG_USE_SUBDIR ? stdp.GetUserDataDir() + : stdp.GetUserConfigDir(); } -wxString wxFileConfig::GetLocalFileName(const wxChar *szFile) +wxFileName wxFileConfig::GetGlobalFile(const wxString& szFile) { -#ifdef __VMS__ - // On VMS I saw the problem that the home directory was appended - // twice for the configuration file. Does that also happen for - // other platforms? - wxString str = wxT( '.' ); -#else - wxString str = GetLocalDir(); -#endif + wxFileName fn(GetGlobalDir(), szFile); -#if defined( __UNIX__ ) && !defined( __VMS ) && !defined( __WXMAC__ ) - str << wxT('.'); -#endif + AddConfFileExtIfNeeded(fn); - str << szFile; + return fn; +} -#if defined(__WINDOWS__) || defined(__DOS__) - if ( wxStrchr(szFile, wxT('.')) == NULL ) - str << wxT(".ini"); -#endif +wxFileName wxFileConfig::GetLocalFile(const wxString& szFile, int style) +{ + wxFileName fn(GetLocalDir(style), szFile); -#ifdef __WXMAC__ - str << wxT(" Preferences") ; -#endif +#ifdef __UNIX__ + if ( !(style & wxCONFIG_USE_SUBDIR) ) + { + // dot-files under Unix start with, well, a dot (but OTOH they usually + // don't have any specific extension) + fn.SetName(wxT('.') + fn.GetName()); + } + else // we do append ".conf" extension to config files in subdirectories +#endif // __UNIX__ + { + AddConfFileExtIfNeeded(fn); + } - return str; + return fn; } // ---------------------------------------------------------------------------- // ctor // ---------------------------------------------------------------------------- +IMPLEMENT_ABSTRACT_CLASS(wxFileConfig, wxConfigBase) void wxFileConfig::Init() { m_pCurrentGroup = - m_pRootGroup = new wxFileConfigGroup(NULL, wxT(""), this); + m_pRootGroup = new wxFileConfigGroup(NULL, wxEmptyString, this); m_linesHead = m_linesTail = NULL; @@ -393,79 +346,75 @@ 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_fnGlobalFile.IsOk() && m_fnGlobalFile.FileExists() ) { - wxTextFile fileGlobal(m_strGlobalFile); + wxTextFile fileGlobal(m_fnGlobalFile.GetFullPath()); - if ( fileGlobal.Open(m_conv/*ignored in ANSI build*/) ) + if ( fileGlobal.Open(*m_conv/*ignored in ANSI build*/) ) { - Parse(fileGlobal, FALSE /* global */); + Parse(fileGlobal, false /* global */); SetRootPath(); } else { - wxLogWarning(_("can't open global configuration file '%s'."), m_strGlobalFile.c_str()); + wxLogWarning(_("can't open global configuration file '%s'."), m_fnGlobalFile.GetFullPath().c_str()); } } // parse the local file - if ( !m_strLocalFile.IsEmpty() && wxFile::Exists(m_strLocalFile) ) + if ( m_fnLocalFile.IsOk() && m_fnLocalFile.FileExists() ) { - wxTextFile fileLocal(m_strLocalFile); - if ( fileLocal.Open(m_conv/*ignored in ANSI build*/) ) + wxTextFile fileLocal(m_fnLocalFile.GetFullPath()); + if ( fileLocal.Open(*m_conv/*ignored in ANSI build*/) ) { - Parse(fileLocal, TRUE /* local */); + Parse(fileLocal, true /* local */); SetRootPath(); } else { - wxLogWarning(_("can't open user configuration file '%s'."), m_strLocalFile.c_str() ); + wxLogWarning(_("can't open user configuration file '%s'."), m_fnLocalFile.GetFullPath().c_str() ); } } + + m_isDirty = false; } // constructor supports creation of wxFileConfig objects of any type wxFileConfig::wxFileConfig(const wxString& appName, const wxString& vendorName, const wxString& strLocal, const wxString& strGlobal, - long style, wxMBConv& conv) + long style, + const wxMBConv& conv) : wxConfigBase(::GetAppName(appName), vendorName, strLocal, strGlobal, style), - m_strLocalFile(strLocal), m_strGlobalFile(strGlobal), - m_conv(conv) + m_fnLocalFile(strLocal), + m_fnGlobalFile(strGlobal), + m_conv(conv.Clone()) { // Make up names for files if empty - if ( m_strLocalFile.IsEmpty() && (style & wxCONFIG_USE_LOCAL_FILE) ) - m_strLocalFile = GetLocalFileName(GetAppName()); + if ( !m_fnLocalFile.IsOk() && (style & wxCONFIG_USE_LOCAL_FILE) ) + m_fnLocalFile = GetLocalFile(GetAppName(), style); - if ( m_strGlobalFile.IsEmpty() && (style & wxCONFIG_USE_GLOBAL_FILE) ) - m_strGlobalFile = GetGlobalFileName(GetAppName()); + if ( !m_fnGlobalFile.IsOk() && (style & wxCONFIG_USE_GLOBAL_FILE) ) + m_fnGlobalFile = GetGlobalFile(GetAppName()); // Check if styles are not supplied, but filenames are, in which case // add the correct styles. - if ( !m_strLocalFile.IsEmpty() ) + if ( m_fnLocalFile.IsOk() ) SetStyle(GetStyle() | wxCONFIG_USE_LOCAL_FILE); - if ( !m_strGlobalFile.IsEmpty() ) + if ( m_fnGlobalFile.IsOk() ) 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 + // unless explicitly asked not to if ( !(style & wxCONFIG_USE_RELATIVE_PATH) ) { - if ( !m_strLocalFile.IsEmpty() && !wxIsAbsolutePath(m_strLocalFile) ) - { - wxString strLocal = m_strLocalFile; - m_strLocalFile = GetLocalDir(); - m_strLocalFile << strLocal; - } + if ( m_fnLocalFile.IsOk() ) + m_fnLocalFile.MakeAbsolute(GetLocalDir(style)); - if ( !m_strGlobalFile.IsEmpty() && !wxIsAbsolutePath(m_strGlobalFile) ) - { - wxString strGlobal = m_strGlobalFile; - m_strGlobalFile = GetGlobalDir(); - m_strGlobalFile << strGlobal; - } + if ( m_fnGlobalFile.IsOk() ) + m_fnGlobalFile.MakeAbsolute(GetGlobalDir()); } SetUmask(-1); @@ -475,119 +424,126 @@ wxFileConfig::wxFileConfig(const wxString& appName, const wxString& vendorName, #if wxUSE_STREAMS -wxFileConfig::wxFileConfig(wxInputStream &inStream, wxMBConv& conv) - : m_conv(conv) +wxFileConfig::wxFileConfig(wxInputStream &inStream, const wxMBConv& conv) + : m_conv(conv.Clone()) { // always local_file when this constructor is called (?) 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; - // translate everything to the current (platform-dependent) line - // termination character - wxString strTrans; - { - wxString strTmp; - - char buf[1024]; - do - { - inStream.Read(buf, WXSIZEOF(buf)); + // read the entire stream contents in memory + wxWxCharBuffer cbuf; + static const size_t chunkLen = 1024; - const wxStreamError err = inStream.GetLastError(); + wxMemoryBuffer buf(chunkLen); + do + { + inStream.Read(buf.GetAppendBuf(chunkLen), chunkLen); + buf.UngetAppendBuf(inStream.LastRead()); - if ( err != wxSTREAM_NO_ERROR && err != wxSTREAM_EOF ) - { - wxLogError(_("Error reading config options.")); - break; - } + const wxStreamError err = inStream.GetLastError(); - strTmp.append(wxConvertMB2WX(buf), inStream.LastRead()); + if ( err != wxSTREAM_NO_ERROR && err != wxSTREAM_EOF ) + { + wxLogError(_("Error reading config options.")); + break; } - while ( !inStream.Eof() ); - - strTrans = wxTextBuffer::Translate(strTmp); } + while ( !inStream.Eof() ); - 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) +#if wxUSE_UNICODE + size_t len; + cbuf = conv.cMB2WC((char *)buf.GetData(), buf.GetDataLen(), &len); + if ( !len && buf.GetDataLen() ) + { + wxLogError(_("Failed to read config options.")); + } +#else // !wxUSE_UNICODE + // no need for conversion + cbuf = wxCharBuffer::CreateNonOwned((char *)buf.GetData()); +#endif // wxUSE_UNICODE/!wxUSE_UNICODE - const wxChar *pEOL = wxTextBuffer::GetEOL(wxTextBuffer::typeDefault); - const size_t EOLLen = wxStrlen(pEOL); - int posLineStart = strTrans.Find(pEOL); - while ( posLineStart != -1 ) + // now break it into lines + wxMemoryText memText; + for ( const wxChar *s = cbuf; ; ++s ) { - wxString line(strTrans.Left(posLineStart)); + const wxChar *e = s; + while ( *e != '\0' && *e != '\n' && *e != '\r' ) + ++e; - memText.AddLine(line); + // notice that we throw away the original EOL kind here, maybe we + // should preserve it? + memText.AddLine(wxString(s, e)); - strTrans = strTrans.Mid(posLineStart + EOLLen); + if ( *e == '\0' ) + break; - posLineStart = strTrans.Find(pEOL); - } + // skip the second EOL byte if it's a DOS one + if ( *e == '\r' && e[1] == '\n' ) + ++e; - // also add whatever we have left in the translated string. - memText.AddLine(strTrans); + s = e; + } // Finally we can parse it all. - Parse(memText, TRUE /* local */); + 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(); + + delete m_conv; } // ---------------------------------------------------------------------------- // 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; - wxString strLine; size_t nLineCount = buffer.GetLineCount(); for ( size_t n = 0; n < nLineCount; n++ ) { - strLine = buffer[n]; + wxString strLine = buffer[n]; + // FIXME-UTF8: rewrite using iterators, without this buffer + wxWxCharBuffer buf(strLine.c_str()); + const wxChar *pStart; + const wxChar *pEnd; // add the line to linked list if ( 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); @@ -596,7 +552,7 @@ void wxFileConfig::Parse(wxTextBuffer& buffer, bool bLocal) // skip leading spaces - for ( pStart = strLine; wxIsspace(*pStart); pStart++ ) + for ( pStart = buf; wxIsspace(*pStart); pStart++ ) ; // skip blank/comment lines @@ -641,12 +597,12 @@ void wxFileConfig::Parse(wxTextBuffer& buffer, bool bLocal) } // check that there is nothing except comments left on this line - bool bCont = TRUE; + bool bCont = true; while ( *++pEnd != wxT('\0') && bCont ) { switch ( *pEnd ) { case wxT('#'): case wxT(';'): - bCont = FALSE; + bCont = false; break; case wxT(' '): @@ -657,13 +613,13 @@ void wxFileConfig::Parse(wxTextBuffer& buffer, bool bLocal) default: wxLogWarning(_("file '%s', line %d: '%s' ignored after group header."), buffer.GetName(), n + 1, pEnd); - bCont = FALSE; + bCont = false; } } } else { // a key - const wxChar *pEnd = pStart; - while ( *pEnd && *pEnd != wxT('=') && !wxIsspace(*pEnd) ) { + pEnd = pStart; + while ( *pEnd && *pEnd != wxT('=') /* && !wxIsspace(*pEnd)*/ ) { if ( *pEnd == wxT('\\') ) { // next character may be space or not - still take it because it's // quoted (unless there is nothing) @@ -677,7 +633,7 @@ void wxFileConfig::Parse(wxTextBuffer& buffer, bool bLocal) pEnd++; } - wxString strKey(FilterInEntryName(wxString(pStart, pEnd))); + wxString strKey(FilterInEntryName(wxString(pStart, pEnd).Trim())); // skip whitespace while ( wxIsspace(*pEnd) ) @@ -724,7 +680,7 @@ void wxFileConfig::Parse(wxTextBuffer& buffer, bool bLocal) if ( !(GetStyle() & wxCONFIG_USE_NO_ESCAPE_CHARACTERS) ) value = FilterInValue(value); - pEntry->SetValue(value, FALSE); + pEntry->SetValue(value, false); } } } @@ -736,45 +692,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.GetCount(); 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.GetCount(); n++ ) { + m_strPath << wxCONFIG_PATH_SEPARATOR << aParts[n]; + } + + return true; +} + +void wxFileConfig::SetPath(const wxString& strPath) +{ + DoSetPath(strPath, true /* create missing path components */); } // ---------------------------------------------------------------------------- @@ -783,66 +753,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().GetCount() ) { + 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().GetCount() ) { + 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().GetCount(); + if ( bRecursive ) { + wxFileConfigGroup *pOldCurrentGroup = m_pCurrentGroup; + size_t nSubgroups = m_pCurrentGroup->Groups().GetCount(); + 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().GetCount(); + if ( bRecursive ) { + wxFileConfigGroup *pOldCurrentGroup = m_pCurrentGroup; + size_t nSubgroups = m_pCurrentGroup->Groups().GetCount(); + 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; } // ---------------------------------------------------------------------------- @@ -851,18 +821,60 @@ 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 +bool wxFileConfig::HasEntry(const wxString& entry) const { - wxConfigPathChanger path(this, strName); + // path is the part before the last "/" + wxString path = entry.BeforeLast(wxCONFIG_PATH_SEPARATOR); + + // except in the special case of "/keyname" when there is nothing before "/" + if ( path.empty() && *entry.c_str() == wxCONFIG_PATH_SEPARATOR ) + { + path = wxCONFIG_PATH_SEPARATOR; + } + + // change to the path of the entry if necessary and remember the old path + // to restore it later + wxString pathOld; + wxFileConfig * const self = wx_const_cast(wxFileConfig *, this); + if ( !path.empty() ) + { + pathOld = GetPath(); + if ( pathOld.empty() ) + pathOld = wxCONFIG_PATH_SEPARATOR; + + if ( !self->DoSetPath(path, false /* don't create if doesn't exist */) ) + { + return false; + } + } + + // check if the entry exists in this group + const bool exists = m_pCurrentGroup->FindEntry( + entry.AfterLast(wxCONFIG_PATH_SEPARATOR)) != NULL; + + // restore the old path if we changed it above + if ( !pathOld.empty() ) + { + self->SetPath(pathOld); + } - wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name()); - return pEntry != NULL; + return exists; } // ---------------------------------------------------------------------------- @@ -871,23 +883,23 @@ 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 { wxString str; if ( !Read(key, &str) ) - return FALSE; + return false; // extra spaces shouldn't prevent us from reading numeric values str.Trim(); @@ -895,30 +907,46 @@ bool wxFileConfig::DoReadLong(const wxString& key, long *pl) const return str.ToLong(pl); } +#if wxUSE_BASE64 + +bool wxFileConfig::DoReadBinary(const wxString& key, wxMemoryBuffer* buf) const +{ + wxCHECK_MSG( buf, false, _T("NULL buffer") ); + + wxString str; + if ( !Read(key, &str) ) + return false; + + *buf = wxBase64Decode(str.ToAscii()); + return true; +} + +#endif // wxUSE_BASE64 + bool wxFileConfig::DoWriteString(const wxString& key, const wxString& szValue) { wxConfigPathChanger path(this, key); wxString strName = path.Name(); - wxLogTrace( _T("wxFileConfig"), + wxLogTrace( FILECONF_TRACE_MASK, _T(" Writing String '%s' = '%s' to Group '%s'"), strName.c_str(), 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 - wxLogTrace( _T("wxFileConfig"), + wxLogTrace( FILECONF_TRACE_MASK, _T(" Creating group %s"), m_pCurrentGroup->Name().c_str() ); - m_pCurrentGroup->SetDirty(); + SetDirty(); // this will add a line for this group if it didn't have it before @@ -926,33 +954,33 @@ bool wxFileConfig::DoWriteString(const wxString& key, const wxString& szValue) } else { - // writing an entry - // check that the name is reasonable - + // writing an entry check that the name is reasonable if ( strName[0u] == wxCONFIG_IMMUTABLE_PREFIX ) { wxLogError( _("Config entry name cannot start with '%c'."), wxCONFIG_IMMUTABLE_PREFIX); - return FALSE; + return false; } wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(strName); if ( pEntry == 0 ) { - wxLogTrace( _T("wxFileConfig"), + wxLogTrace( FILECONF_TRACE_MASK, _T(" Adding Entry %s"), strName.c_str() ); pEntry = m_pCurrentGroup->AddEntry(strName); } - wxLogTrace( _T("wxFileConfig"), + wxLogTrace( FILECONF_TRACE_MASK, _T(" Setting value %s"), szValue.c_str() ); pEntry->SetValue(szValue); + + SetDirty(); } - return TRUE; + return true; } bool wxFileConfig::DoWriteLong(const wxString& key, long lValue) @@ -960,69 +988,87 @@ bool wxFileConfig::DoWriteLong(const wxString& key, long lValue) return Write(key, wxString::Format(_T("%ld"), lValue)); } +#if wxUSE_BASE64 + +bool wxFileConfig::DoWriteBinary(const wxString& key, const wxMemoryBuffer& buf) +{ + return Write(key, wxBase64Encode(buf)); +} + +#endif // wxUSE_BASE64 + bool wxFileConfig::Flush(bool /* bCurrentOnly */) { - if ( LineListIsEmpty() || !m_pRootGroup->IsDirty() || !m_strLocalFile ) - return TRUE; + if ( !IsDirty() || !m_fnLocalFile.GetFullPath() ) + return true; -#ifdef __UNIX__ // set the umask if needed - mode_t umaskOld = 0; - if ( m_umask != -1 ) - { - umaskOld = umask((mode_t)m_umask); - } -#endif // __UNIX__ + wxCHANGE_UMASK(m_umask); - wxTempFile file(m_strLocalFile); + wxTempFile file(m_fnLocalFile.GetFullPath()); if ( !file.IsOpened() ) { wxLogError(_("can't open user configuration file.")); - return FALSE; + return false; } // write all strings to file + wxString filetext; + filetext.reserve(4096); for ( wxFileConfigLineList *p = m_linesHead; p != NULL; p = p->Next() ) { - wxString line = p->Text(); - line += wxTextFile::GetEOL(); - if ( !file.Write(line, m_conv) ) - { - wxLogError(_("can't write user configuration file.")); - return FALSE; - } + filetext << p->Text() << wxTextFile::GetEOL(); } - bool ret = file.Commit(); - -#if defined(__WXMAC__) - if ( ret ) + if ( !file.Write(filetext, *m_conv) ) { - FSSpec spec ; - - wxMacFilename2FSSpec( m_strLocalFile , &spec ) ; - FInfo finfo ; - if ( FSpGetFInfo( &spec , &finfo ) == noErr ) - { - finfo.fdType = 'TEXT' ; - finfo.fdCreator = 'ttxt' ; - FSpSetFInfo( &spec , &finfo ) ; - } + wxLogError(_("can't write user configuration file.")); + return false; } -#endif // __WXMAC__ -#ifdef __UNIX__ - // restore the old umask if we changed it - if ( m_umask != -1 ) + if ( !file.Commit() ) { - (void)umask(umaskOld); + wxLogError(_("Failed to update user configuration file.")); + + return false; } -#endif // __UNIX__ - return ret; + ResetDirty(); + +#if defined(__WXMAC__) + m_fnLocalFile.MacSetTypeAndCreator('TEXT', 'ttxt'); +#endif // __WXMAC__ + + return true; } +#if wxUSE_STREAMS + +bool wxFileConfig::Save(wxOutputStream& os, const wxMBConv& conv) +{ + // save unconditionally, even if not dirty + for ( wxFileConfigLineList *p = m_linesHead; p != NULL; p = p->Next() ) + { + wxString line = p->Text(); + line += wxTextFile::GetEOL(); + + wxCharBuffer buf(line.mb_str(conv)); + if ( !os.Write(buf, strlen(buf)) ) + { + wxLogError(_("Error saving user configuration data.")); + + return false; + } + } + + ResetDirty(); + + return true; +} + +#endif // wxUSE_STREAMS + // ---------------------------------------------------------------------------- // renaming groups/entries // ---------------------------------------------------------------------------- @@ -1030,24 +1076,29 @@ bool wxFileConfig::Flush(bool /* bCurrentOnly */) bool wxFileConfig::RenameEntry(const wxString& oldName, const wxString& newName) { + wxASSERT_MSG( oldName.find(wxCONFIG_PATH_SEPARATOR) == wxString::npos, + _T("RenameEntry(): paths are not supported") ); + // check that the entry exists wxFileConfigEntry *oldEntry = m_pCurrentGroup->FindEntry(oldName); if ( !oldEntry ) - return FALSE; + return false; // check that the new entry doesn't already exist if ( m_pCurrentGroup->FindEntry(newName) ) - return FALSE; + return false; // delete the old entry, create the new one wxString value = oldEntry->Value(); if ( !m_pCurrentGroup->DeleteEntry(oldName) ) - return FALSE; + return false; + + SetDirty(); wxFileConfigEntry *newEntry = m_pCurrentGroup->AddEntry(newName); newEntry->SetValue(value); - return TRUE; + return true; } bool wxFileConfig::RenameGroup(const wxString& oldName, @@ -1056,15 +1107,17 @@ bool wxFileConfig::RenameGroup(const wxString& oldName, // check that the group exists wxFileConfigGroup *group = m_pCurrentGroup->FindSubgroup(oldName); if ( !group ) - return FALSE; + return false; // check that the new group doesn't already exist if ( m_pCurrentGroup->FindSubgroup(newName) ) - return FALSE; + return false; group->Rename(newName); - return TRUE; + SetDirty(); + + return true; } // ---------------------------------------------------------------------------- @@ -1076,7 +1129,9 @@ bool wxFileConfig::DeleteEntry(const wxString& key, bool bGroupIfEmptyAlso) wxConfigPathChanger path(this, key); if ( !m_pCurrentGroup->DeleteEntry(path.Name()) ) - return FALSE; + return false; + + SetDirty(); if ( bGroupIfEmptyAlso && m_pCurrentGroup->IsEmpty() ) { if ( m_pCurrentGroup != m_pRootGroup ) { @@ -1087,30 +1142,41 @@ bool wxFileConfig::DeleteEntry(const wxString& key, bool bGroupIfEmptyAlso) //else: never delete the root group } - return TRUE; + return true; } bool wxFileConfig::DeleteGroup(const wxString& key) { - wxConfigPathChanger path(this, key); + wxConfigPathChanger path(this, RemoveTrailingSeparator(key)); + + if ( !m_pCurrentGroup->DeleteSubgroupByName(path.Name()) ) + return false; + + path.UpdateIfDeleted(); + + SetDirty(); - return m_pCurrentGroup->DeleteSubgroupByName(path.Name()); + return true; } bool wxFileConfig::DeleteAll() { CleanUp(); - if ( wxFile::Exists(m_strLocalFile) && wxRemove(m_strLocalFile) == -1 ) + if ( m_fnLocalFile.IsOk() ) { - wxLogSysError(_("can't delete user configuration file '%s'"), m_strLocalFile.c_str()); - return FALSE; + if ( m_fnLocalFile.FileExists() && + !wxRemoveFile(m_fnLocalFile.GetFullPath()) ) + { + wxLogSysError(_("can't delete user configuration file '%s'"), + m_fnLocalFile.GetFullPath().c_str()); + return false; + } } - m_strLocalFile = m_strGlobalFile = wxT(""); Init(); - return TRUE; + return true; } // ---------------------------------------------------------------------------- @@ -1121,15 +1187,17 @@ bool wxFileConfig::DeleteAll() wxFileConfigLineList *wxFileConfig::LineListAppend(const wxString& str) { - wxLogTrace( _T("wxFileConfig"), + wxLogTrace( FILECONF_TRACE_MASK, _T(" ** Adding Line '%s'"), str.c_str() ); - wxLogTrace( _T("wxFileConfig"), + wxLogTrace( FILECONF_TRACE_MASK, _T(" head: %s"), - ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) ); - wxLogTrace( _T("wxFileConfig"), + ((m_linesHead) ? (const wxChar*)m_linesHead->Text().c_str() + : wxEmptyString) ); + wxLogTrace( FILECONF_TRACE_MASK, _T(" tail: %s"), - ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) ); + ((m_linesTail) ? (const wxChar*)m_linesTail->Text().c_str() + : wxEmptyString) ); wxFileConfigLineList *pLine = new wxFileConfigLineList(str); @@ -1147,12 +1215,14 @@ wxFileConfigLineList *wxFileConfig::LineListAppend(const wxString& str) m_linesTail = pLine; - wxLogTrace( _T("wxFileConfig"), + wxLogTrace( FILECONF_TRACE_MASK, _T(" head: %s"), - ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) ); - wxLogTrace( _T("wxFileConfig"), + ((m_linesHead) ? (const wxChar*)m_linesHead->Text().c_str() + : wxEmptyString) ); + wxLogTrace( FILECONF_TRACE_MASK, _T(" tail: %s"), - ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) ); + ((m_linesTail) ? (const wxChar*)m_linesTail->Text().c_str() + : wxEmptyString) ); return m_linesTail; } @@ -1161,16 +1231,19 @@ wxFileConfigLineList *wxFileConfig::LineListAppend(const wxString& str) wxFileConfigLineList *wxFileConfig::LineListInsert(const wxString& str, wxFileConfigLineList *pLine) { - wxLogTrace( _T("wxFileConfig"), + wxLogTrace( FILECONF_TRACE_MASK, _T(" ** Inserting Line '%s' after '%s'"), str.c_str(), - ((pLine) ? pLine->Text().c_str() : wxEmptyString) ); - wxLogTrace( _T("wxFileConfig"), + ((pLine) ? (const wxChar*)pLine->Text().c_str() + : wxEmptyString) ); + wxLogTrace( FILECONF_TRACE_MASK, _T(" head: %s"), - ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) ); - wxLogTrace( _T("wxFileConfig"), + ((m_linesHead) ? (const wxChar*)m_linesHead->Text().c_str() + : wxEmptyString) ); + wxLogTrace( FILECONF_TRACE_MASK, _T(" tail: %s"), - ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) ); + ((m_linesTail) ? (const wxChar*)m_linesTail->Text().c_str() + : wxEmptyString) ); if ( pLine == m_linesTail ) return LineListAppend(str); @@ -1193,27 +1266,31 @@ wxFileConfigLineList *wxFileConfig::LineListInsert(const wxString& str, pLine->SetNext(pNewLine); } - wxLogTrace( _T("wxFileConfig"), + wxLogTrace( FILECONF_TRACE_MASK, _T(" head: %s"), - ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) ); - wxLogTrace( _T("wxFileConfig"), + ((m_linesHead) ? (const wxChar*)m_linesHead->Text().c_str() + : wxEmptyString) ); + wxLogTrace( FILECONF_TRACE_MASK, _T(" tail: %s"), - ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) ); + ((m_linesTail) ? (const wxChar*)m_linesTail->Text().c_str() + : wxEmptyString) ); return pNewLine; } void wxFileConfig::LineListRemove(wxFileConfigLineList *pLine) { - wxLogTrace( _T("wxFileConfig"), + wxLogTrace( FILECONF_TRACE_MASK, _T(" ** Removing Line '%s'"), pLine->Text().c_str() ); - wxLogTrace( _T("wxFileConfig"), + wxLogTrace( FILECONF_TRACE_MASK, _T(" head: %s"), - ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) ); - wxLogTrace( _T("wxFileConfig"), + ((m_linesHead) ? (const wxChar*)m_linesHead->Text().c_str() + : wxEmptyString) ); + wxLogTrace( FILECONF_TRACE_MASK, _T(" tail: %s"), - ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) ); + ((m_linesTail) ? (const wxChar*)m_linesTail->Text().c_str() + : wxEmptyString) ); wxFileConfigLineList *pPrev = pLine->Prev(), *pNext = pLine->Next(); @@ -1232,12 +1309,17 @@ void wxFileConfig::LineListRemove(wxFileConfigLineList *pLine) else pNext->SetPrev(pPrev); - wxLogTrace( _T("wxFileConfig"), + 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) ); - wxLogTrace( _T("wxFileConfig"), + ((m_linesHead) ? (const wxChar*)m_linesHead->Text().c_str() + : wxEmptyString) ); + wxLogTrace( FILECONF_TRACE_MASK, _T(" tail: %s"), - ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) ); + ((m_linesTail) ? (const wxChar*)m_linesTail->Text().c_str() + : wxEmptyString) ); delete pLine; } @@ -1265,7 +1347,6 @@ wxFileConfigGroup::wxFileConfigGroup(wxFileConfigGroup *pParent, { m_pConfig = pConfig; m_pParent = pParent; - m_bDirty = FALSE; m_pLine = NULL; m_pLastEntry = NULL; @@ -1276,12 +1357,12 @@ wxFileConfigGroup::wxFileConfigGroup(wxFileConfigGroup *pParent, wxFileConfigGroup::~wxFileConfigGroup() { // entries - size_t n, nCount = m_aEntries.Count(); + size_t n, nCount = m_aEntries.GetCount(); for ( n = 0; n < nCount; n++ ) delete m_aEntries[n]; // subgroups - nCount = m_aSubgroups.Count(); + nCount = m_aSubgroups.GetCount(); for ( n = 0; n < nCount; n++ ) delete m_aSubgroups[n]; } @@ -1292,7 +1373,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; } @@ -1332,13 +1417,13 @@ void wxFileConfigGroup::SetLine(wxFileConfigLineList *pLine) // have it or in the very beginning if we're the root group. wxFileConfigLineList *wxFileConfigGroup::GetGroupLine() { - wxLogTrace( _T("wxFileConfig"), + wxLogTrace( FILECONF_TRACE_MASK, _T(" GetGroupLine() for Group '%s'"), Name().c_str() ); if ( !m_pLine ) { - wxLogTrace( _T("wxFileConfig"), + wxLogTrace( FILECONF_TRACE_MASK, _T(" Getting Line item pointer") ); wxFileConfigGroup *pParent = Parent(); @@ -1346,7 +1431,7 @@ wxFileConfigLineList *wxFileConfigGroup::GetGroupLine() // this group wasn't present in local config file, add it now if ( pParent ) { - wxLogTrace( _T("wxFileConfig"), + wxLogTrace( FILECONF_TRACE_MASK, _T(" checking parent '%s'"), pParent->Name().c_str() ); @@ -1392,7 +1477,7 @@ wxFileConfigLineList *wxFileConfigGroup::GetLastGroupLine() // one immediately after the group line itself. wxFileConfigLineList *wxFileConfigGroup::GetLastEntryLine() { - wxLogTrace( _T("wxFileConfig"), + wxLogTrace( FILECONF_TRACE_MASK, _T(" GetLastEntryLine() for Group '%s'"), Name().c_str() ); @@ -1429,30 +1514,50 @@ 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.GetCount(); + 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; + if ( newName == m_strName ) + return; - // +1: no leading '/' - wxString strFullName; - strFullName << wxT("[") << (GetFullName().c_str() + 1) << wxT("]"); + // we need to remove the group from the parent and it back under the new + // name to keep the parents array of subgroups alphabetically sorted + m_pParent->m_aSubgroups.Remove(this); - wxFileConfigLineList *line = GetGroupLine(); - wxCHECK_RET( line, _T("a non root group must have a corresponding line!") ); + m_strName = newName; - line->SetText(strFullName); + m_pParent->m_aSubgroups.Add(this); - SetDirty(); + // 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; } // ---------------------------------------------------------------------------- @@ -1461,11 +1566,11 @@ wxString wxFileConfigGroup::GetFullName() const // use binary search because the array is sorted wxFileConfigEntry * -wxFileConfigGroup::FindEntry(const wxChar *szName) const +wxFileConfigGroup::FindEntry(const wxString& name) const { size_t i, lo = 0, - hi = m_aEntries.Count(); + hi = m_aEntries.GetCount(); int res; wxFileConfigEntry *pEntry; @@ -1474,9 +1579,9 @@ wxFileConfigGroup::FindEntry(const wxChar *szName) const pEntry = m_aEntries[i]; #if wxCONFIG_CASE_SENSITIVE - res = wxStrcmp(pEntry->Name(), szName); + res = pEntry->Name().compare(name); #else - res = wxStricmp(pEntry->Name(), szName); + res = pEntry->Name().CmpNoCase(name); #endif if ( res > 0 ) @@ -1491,11 +1596,11 @@ wxFileConfigGroup::FindEntry(const wxChar *szName) const } wxFileConfigGroup * -wxFileConfigGroup::FindSubgroup(const wxChar *szName) const +wxFileConfigGroup::FindSubgroup(const wxString& name) const { size_t i, lo = 0, - hi = m_aSubgroups.Count(); + hi = m_aSubgroups.GetCount(); int res; wxFileConfigGroup *pGroup; @@ -1504,9 +1609,9 @@ wxFileConfigGroup::FindSubgroup(const wxChar *szName) const pGroup = m_aSubgroups[i]; #if wxCONFIG_CASE_SENSITIVE - res = wxStrcmp(pGroup->Name(), szName); + res = pGroup->Name().compare(name); #else - res = wxStricmp(pGroup->Name(), szName); + res = pGroup->Name().CmpNoCase(name); #endif if ( res > 0 ) @@ -1557,158 +1662,135 @@ wxFileConfigGroup *wxFileConfigGroup::AddSubgroup(const wxString& strName) delete several of them. */ -bool wxFileConfigGroup::DeleteSubgroupByName(const wxChar *szName) +bool wxFileConfigGroup::DeleteSubgroupByName(const wxString& name) { - wxFileConfigGroup * const pGroup = FindSubgroup(szName); + wxFileConfigGroup * const pGroup = FindSubgroup(name); - return pGroup ? DeleteSubgroup(pGroup) : FALSE; + return pGroup ? DeleteSubgroup(pGroup) : false; } // Delete the subgroup and remove all references to it from // other data structures. bool wxFileConfigGroup::DeleteSubgroup(wxFileConfigGroup *pGroup) { - wxCHECK_MSG( pGroup, FALSE, _T("deleting non existing group?") ); + wxCHECK_MSG( pGroup, false, _T("deleting non existing group?") ); - wxLogTrace( _T("wxFileConfig"), + wxLogTrace( FILECONF_TRACE_MASK, _T("Deleting group '%s' from '%s'"), pGroup->Name().c_str(), Name().c_str() ); - wxLogTrace( _T("wxFileConfig"), + wxLogTrace( FILECONF_TRACE_MASK, _T(" (m_pLine) = prev: %p, this %p, next %p"), - ((m_pLine) ? m_pLine->Prev() : 0), - m_pLine, - ((m_pLine) ? m_pLine->Next() : 0) ); - wxLogTrace( _T("wxFileConfig"), + m_pLine ? wx_static_cast(void*, m_pLine->Prev()) : 0, + wx_static_cast(void*, m_pLine), + m_pLine ? wx_static_cast(void*, m_pLine->Next()) : 0 ); + wxLogTrace( FILECONF_TRACE_MASK, _T(" text: '%s'"), - ((m_pLine) ? m_pLine->Text().c_str() : wxEmptyString) ); + m_pLine ? (const wxChar*)m_pLine->Text().c_str() + : wxEmptyString ); - // delete all entries - size_t nCount = pGroup->m_aEntries.Count(); + // delete all entries... + size_t nCount = pGroup->m_aEntries.GetCount(); - wxLogTrace(_T("wxFileConfig"), - _T("Removing %lu Entries"), - (unsigned long)nCount ); + wxLogTrace(FILECONF_TRACE_MASK, + _T("Removing %lu entries"), (unsigned long)nCount ); for ( size_t nEntry = 0; nEntry < nCount; nEntry++ ) { - wxFileConfigLineList *pLine = pGroup->m_aEntries[nEntry]->GetLine(); + wxFileConfigLineList *pLine = pGroup->m_aEntries[nEntry]->GetLine(); - if ( pLine != 0 ) + if ( pLine ) { - wxLogTrace( _T("wxFileConfig"), + wxLogTrace( FILECONF_TRACE_MASK, _T(" '%s'"), pLine->Text().c_str() ); m_pConfig->LineListRemove(pLine); } } - // and subgroups of this subgroup - - nCount = pGroup->m_aSubgroups.Count(); + // ...and subgroups of this subgroup + nCount = pGroup->m_aSubgroups.GetCount(); - wxLogTrace( _T("wxFileConfig"), - _T("Removing %lu SubGroups"), - (unsigned long)nCount ); + wxLogTrace( FILECONF_TRACE_MASK, + _T("Removing %lu subgroups"), (unsigned long)nCount ); for ( size_t nGroup = 0; nGroup < nCount; nGroup++ ) { pGroup->DeleteSubgroup(pGroup->m_aSubgroups[0]); } - // finally the group itself - - wxFileConfigLineList *pLine = pGroup->m_pLine; - - if ( pLine != 0 ) + // and then finally the group itself + wxFileConfigLineList *pLine = pGroup->m_pLine; + if ( pLine ) { - wxLogTrace( _T("wxFileConfig"), - _T(" Removing line entry for Group '%s' : '%s'"), + wxLogTrace( FILECONF_TRACE_MASK, + _T(" Removing line for group '%s' : '%s'"), pGroup->Name().c_str(), pLine->Text().c_str() ); - wxLogTrace( _T("wxFileConfig"), - _T(" Removing from Group '%s' : '%s'"), + wxLogTrace( FILECONF_TRACE_MASK, + _T(" Removing from group '%s' : '%s'"), Name().c_str(), - ((m_pLine) ? m_pLine->Text().c_str() : wxEmptyString) ); - - // notice that we may do this test inside the previous "if" - // because the last entry's line is surely !NULL + ((m_pLine) ? (const wxChar*)m_pLine->Text().c_str() + : wxEmptyString) ); + // notice that we may do this test inside the previous "if" + // because the last entry's line is surely !NULL if ( pGroup == m_pLastGroup ) { - wxLogTrace( _T("wxFileConfig"), - _T(" ------- Removing last group -------") ); - - // our last entry is being deleted, so find the last one which stays. - // go back until we find a subgroup or reach the group's line, unless - // we are the root group, which we'll notice shortly. - - wxFileConfigGroup *pNewLast = 0; - size_t nSubgroups = m_aSubgroups.Count(); - wxFileConfigLineList *pl; - - for ( pl = pLine->Prev(); pl != m_pLine; pl = pl->Prev() ) + wxLogTrace( FILECONF_TRACE_MASK, + _T(" Removing last group") ); + + // our last entry is being deleted, so find the last one which + // stays by going back until we find a subgroup or reach the + // group line + const size_t nSubgroups = m_aSubgroups.GetCount(); + + m_pLastGroup = NULL; + for ( wxFileConfigLineList *pl = pLine->Prev(); + pl && !m_pLastGroup; + pl = pl->Prev() ) { - // is it our subgroup? - - for ( size_t n = 0; (pNewLast == 0) && (n < nSubgroups); n++ ) + // does this line belong to our subgroup? + for ( size_t n = 0; n < nSubgroups; n++ ) { - // do _not_ call GetGroupLine! we don't want to add it to the local - // file if it's not already there - - if ( m_aSubgroups[n]->m_pLine == m_pLine ) - pNewLast = m_aSubgroups[n]; + // do _not_ call GetGroupLine! we don't want to add it to + // the local file if it's not already there + if ( m_aSubgroups[n]->m_pLine == pl ) + { + m_pLastGroup = m_aSubgroups[n]; + break; + } } - if ( pNewLast != 0 ) // found? + if ( pl == m_pLine ) break; } - - if ( pl == m_pLine || m_pParent == 0 ) - { - wxLogTrace( _T("wxFileConfig"), - _T(" ------- No previous group found -------") ); - - wxASSERT_MSG( !pNewLast || m_pLine == 0, - _T("how comes it has the same line as we?") ); - - // we've reached the group line without finding any subgroups, - // or realised we removed the last group from the root. - - m_pLastGroup = 0; - } - else - { - wxLogTrace( _T("wxFileConfig"), - _T(" ------- Last Group set to '%s' -------"), - pNewLast->Name().c_str() ); - - m_pLastGroup = pNewLast; - } } m_pConfig->LineListRemove(pLine); } else { - wxLogTrace( _T("wxFileConfig"), + wxLogTrace( FILECONF_TRACE_MASK, _T(" No line entry for Group '%s'?"), pGroup->Name().c_str() ); } - SetDirty(); - m_aSubgroups.Remove(pGroup); delete pGroup; - return TRUE; + return true; } -bool wxFileConfigGroup::DeleteEntry(const wxChar *szName) +bool wxFileConfigGroup::DeleteEntry(const wxString& name) { - wxFileConfigEntry *pEntry = FindEntry(szName); - wxCHECK( pEntry != NULL, FALSE ); // deleting non existing item? + wxFileConfigEntry *pEntry = FindEntry(name); + if ( !pEntry ) + { + // entry doesn't exist, nothing to do + return false; + } wxFileConfigLineList *pLine = pEntry->GetLine(); if ( pLine != NULL ) { @@ -1720,7 +1802,7 @@ bool wxFileConfigGroup::DeleteEntry(const wxChar *szName) // go back until we find another entry or reach the group's line wxFileConfigEntry *pNewLast = NULL; - size_t n, nEntries = m_aEntries.Count(); + size_t n, nEntries = m_aEntries.GetCount(); wxFileConfigLineList *pl; for ( pl = pLine->Prev(); pl != m_pLine; pl = pl->Prev() ) { // is it our subgroup? @@ -1746,23 +1828,10 @@ bool wxFileConfigGroup::DeleteEntry(const wxChar *szName) m_pConfig->LineListRemove(pLine); } - // we must be written back for the changes to be saved - SetDirty(); - m_aEntries.Remove(pEntry); delete pEntry; - return TRUE; -} - -// ---------------------------------------------------------------------------- -// -// ---------------------------------------------------------------------------- -void wxFileConfigGroup::SetDirty() -{ - m_bDirty = TRUE; - if ( Parent() != NULL ) // propagate upwards - Parent()->SetDirty(); + return true; } // ============================================================================ @@ -1777,14 +1846,13 @@ wxFileConfigEntry::wxFileConfigEntry(wxFileConfigGroup *pParent, int nLine) : m_strName(strName) { - wxASSERT( !strName.IsEmpty() ); + wxASSERT( !strName.empty() ); m_pParent = pParent; m_nLine = nLine; m_pLine = NULL; - m_bDirty = - m_bHasValue = FALSE; + m_bHasValue = false; m_bImmutable = strName[0] == wxCONFIG_IMMUTABLE_PREFIX; if ( m_bImmutable ) @@ -1806,7 +1874,7 @@ void wxFileConfigEntry::SetLine(wxFileConfigLineList *pLine) Group()->SetLastEntry(this); } -// second parameter is FALSE if we read the value from file and prevents the +// second parameter is false if we read the value from file and prevents the // entry from being marked as 'dirty' void wxFileConfigEntry::SetValue(const wxString& strValue, bool bUser) { @@ -1817,19 +1885,17 @@ void wxFileConfigEntry::SetValue(const wxString& strValue, bool bUser) return; } - // 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 - + // 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_bHasValue = true; m_strValue = strValue; if ( bUser ) { - wxString strValFiltered; + wxString strValFiltered; if ( Group()->Config()->GetStyle() & wxCONFIG_USE_NO_ESCAPE_CHARACTERS ) { @@ -1849,23 +1915,18 @@ 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); Group()->SetLastEntry(this); } - - SetDirty(); } } -void wxFileConfigEntry::SetDirty() -{ - m_bDirty = TRUE; - Group()->SetDirty(); -} - // ============================================================================ // global functions // ============================================================================ @@ -1876,20 +1937,20 @@ void wxFileConfigEntry::SetDirty() int CompareEntries(wxFileConfigEntry *p1, wxFileConfigEntry *p2) { - #if wxCONFIG_CASE_SENSITIVE - return wxStrcmp(p1->Name(), p2->Name()); - #else - return wxStricmp(p1->Name(), p2->Name()); - #endif +#if wxCONFIG_CASE_SENSITIVE + return p1->Name().compare(p2->Name()); +#else + return p1->Name().CmpNoCase(p2->Name()); +#endif } int CompareGroups(wxFileConfigGroup *p1, wxFileConfigGroup *p2) { - #if wxCONFIG_CASE_SENSITIVE - return wxStrcmp(p1->Name(), p2->Name()); - #else - return wxStricmp(p1->Name(), p2->Name()); - #endif +#if wxCONFIG_CASE_SENSITIVE + return p1->Name().compare(p2->Name()); +#else + return p1->Name().CmpNoCase(p2->Name()); +#endif } // ---------------------------------------------------------------------------- @@ -1899,47 +1960,66 @@ int CompareGroups(wxFileConfigGroup *p1, wxFileConfigGroup *p2) // undo FilterOutValue static wxString FilterInValue(const wxString& str) { - wxString strResult; - strResult.Alloc(str.Len()); + wxString strResult; + if ( str.empty() ) + return strResult; - bool bQuoted = !str.IsEmpty() && str[0] == '"'; + strResult.reserve(str.length()); - for ( size_t n = bQuoted ? 1 : 0; n < str.Len(); n++ ) { - if ( str[n] == wxT('\\') ) { - switch ( str[++n] ) { - case wxT('n'): - strResult += wxT('\n'); - break; + wxString::const_iterator i = str.begin(); + const bool bQuoted = *i == '"'; + if ( bQuoted ) + ++i; - case wxT('r'): - strResult += wxT('\r'); - break; + for ( const wxString::const_iterator end = str.end(); i != end; ++i ) + { + if ( *i == wxT('\\') ) + { + if ( ++i == end ) + { + wxLogWarning(_("trailing backslash ignored in '%s'"), str.c_str()); + break; + } - case wxT('t'): - strResult += wxT('\t'); - break; + switch ( (*i).GetValue() ) + { + case wxT('n'): + strResult += wxT('\n'); + break; - case wxT('\\'): - strResult += wxT('\\'); - break; + case wxT('r'): + strResult += wxT('\r'); + break; - case wxT('"'): - strResult += wxT('"'); - break; - } - } - else { - if ( str[n] != wxT('"') || !bQuoted ) - strResult += str[n]; - else if ( n != str.Len() - 1 ) { - wxLogWarning(_("unexpected \" at position %d in '%s'."), - n, str.c_str()); - } - //else: it's the last quote of a quoted string, ok + case wxT('t'): + strResult += wxT('\t'); + break; + + case wxT('\\'): + strResult += wxT('\\'); + break; + + case wxT('"'): + strResult += wxT('"'); + break; + } + } + else // not a backslash + { + if ( *i != wxT('"') || !bQuoted ) + { + strResult += *i; + } + else if ( i != end - 1 ) + { + wxLogWarning(_("unexpected \" at position %d in '%s'."), + i - str.begin(), str.c_str()); + } + //else: it's the last quote of a quoted string, ok + } } - } - return strResult; + return strResult; } // quote the string before writing it to file @@ -1959,7 +2039,7 @@ static wxString FilterOutValue(const wxString& str) wxChar c; for ( size_t n = 0; n < str.Len(); n++ ) { - switch ( str[n] ) { + switch ( str[n].GetValue() ) { case wxT('\n'): c = wxT('n'); break; @@ -2005,8 +2085,11 @@ static wxString FilterInEntryName(const wxString& str) strResult.Alloc(str.Len()); for ( const wxChar *pc = str.c_str(); *pc != '\0'; pc++ ) { - if ( *pc == wxT('\\') ) - pc++; + if ( *pc == wxT('\\') ) { + // we need to test it here or we'd skip past the NUL in the loop line + if ( *++pc == _T('\0') ) + break; + } strResult += *pc; } @@ -2021,14 +2104,22 @@ static wxString FilterOutEntryName(const wxString& str) strResult.Alloc(str.Len()); for ( const wxChar *pc = str.c_str(); *pc != wxT('\0'); pc++ ) { - wxChar c = *pc; + const wxChar c = *pc; // we explicitly allow some of "safe" chars and 8bit ASCII characters - // which will probably never have special meaning + // which will probably never have special meaning and with which we can't + // use isalnum() anyhow (in ASCII built, in Unicode it's just fine) + // // NB: note that wxCONFIG_IMMUTABLE_PREFIX and wxCONFIG_PATH_SEPARATOR // should *not* be quoted - if ( !wxIsalnum(c) && !wxStrchr(wxT("@_/-!.*%"), c) && ((c & 0x80) == 0) ) + if ( +#if !wxUSE_UNICODE + ((unsigned char)c < 127) && +#endif // ANSI + !wxIsalnum(c) && !wxStrchr(wxT("@_/-!.*%"), c) ) + { strResult += wxT('\\'); + } strResult += c; } @@ -2047,6 +2138,3 @@ static wxString GetAppName(const wxString& appName) } #endif // wxUSE_CONFIG - - -// vi:sts=4:sw=4:et