X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d427503c3696486ef84cd0e5081884ccd8d6b434..907173e51df6d2a91d65463ddf6ce810d3fd921a:/src/common/fileconf.cpp diff --git a/src/common/fileconf.cpp b/src/common/fileconf.cpp index 231c156482..7fcaadeb5d 100644 --- a/src/common/fileconf.cpp +++ b/src/common/fileconf.cpp @@ -7,17 +7,13 @@ // RCS-ID: $Id$ // Copyright: (c) 1997 Karsten Ballüder & Vadim Zeitlin // Ballueder@usa.net -// Licence: wxWindows license +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma implementation "fileconf.h" #endif -// ============================================================================ -// declarations -// ============================================================================ - // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- @@ -28,7 +24,7 @@ #pragma hdrstop #endif //__BORLANDC__ -#if wxUSE_CONFIG +#if wxUSE_CONFIG && wxUSE_FILECONFIG #ifndef WX_PRECOMP #include "wx/string.h" @@ -40,16 +36,29 @@ #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/utils.h" // for wxGetHomeDir -// _WINDOWS_ is defined when windows.h is included, -// __WXMSW__ is defined for MS Windows compilation -#if defined(__WXMSW__) && !defined(_WINDOWS_) - #include +#if defined(__WXMAC__) + #include "wx/mac/private.h" // includes mac headers + #include "wx/filename.h" // for MacSetTypeAndCreator +#endif + +#if defined(__WXMSW__) + #include "wx/msw/private.h" #endif //windows.h +#if defined(__WXPM__) + #define INCL_DOS + #include +#endif #include #include @@ -62,17 +71,20 @@ // ---------------------------------------------------------------------------- // constants // ---------------------------------------------------------------------------- + #ifndef MAX_PATH #define MAX_PATH 512 #endif +#define FILECONF_TRACE_MASK _T("fileconf") + // ---------------------------------------------------------------------------- // global functions declarations // ---------------------------------------------------------------------------- // compare functions for sorting the arrays -static int CompareEntries(ConfigEntry *p1, ConfigEntry *p2); -static int 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); @@ -84,6 +96,168 @@ 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 +// ---------------------------------------------------------------------------- + +#ifdef WXMAKINGDLL_BASE + WX_DEFINE_SORTED_USER_EXPORTED_ARRAY(wxFileConfigEntry *, ArrayEntries, + WXDLLIMPEXP_BASE); + WX_DEFINE_SORTED_USER_EXPORTED_ARRAY(wxFileConfigGroup *, ArrayGroups, + WXDLLIMPEXP_BASE); +#else + WX_DEFINE_SORTED_ARRAY(wxFileConfigEntry *, ArrayEntries); + WX_DEFINE_SORTED_ARRAY(wxFileConfigGroup *, ArrayGroups); +#endif + +// ---------------------------------------------------------------------------- +// 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 + + DECLARE_NO_COPY_CLASS(wxFileConfigLineList) +}; + +// ---------------------------------------------------------------------------- +// 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_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 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 SetLine(wxFileConfigLineList *pLine); + + DECLARE_NO_COPY_CLASS(wxFileConfigEntry) +}; + +// ---------------------------------------------------------------------------- +// 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 + 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); + + // used by Rename() + void UpdateGroupAndSubgroupsLines(); + +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; } + + 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); + + 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); + void SetLastGroup(wxFileConfigGroup *pGroup) + { m_pLastGroup = pGroup; } + + DECLARE_NO_COPY_CLASS(wxFileConfigGroup) +}; + // ============================================================================ // implementation // ============================================================================ @@ -95,69 +269,107 @@ wxString wxFileConfig::GetGlobalDir() { wxString strDir; - #ifdef __UNIX__ - strDir = _T("/etc/"); - #elif defined(__WXSTUBS__) - wxASSERT_MSG( FALSE, _T("TODO") ) ; - #elif defined(__WXMAC__) - wxASSERT_MSG( FALSE, _T("TODO") ) ; - #else // Windows +#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) + { + drive = aulSysInfo[QSV_BOOT_DRIVE - 1]; + strDir.Printf(wxT("%c:\\OS2\\"), 'A'+drive-1); + } +#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 << _T('\\'); - #endif // Unix/Windows + strDir << wxT('\\'); +#endif // Unix/Windows - return strDir; + return strDir; } wxString wxFileConfig::GetLocalDir() { - wxString strDir; + wxString strDir; - wxGetHomeDir(&strDir); +#if defined(__WXMAC__) || defined(__DOS__) + // no local dir concept on Mac OS 9 or MS-DOS + return GetGlobalDir() ; +#else + wxGetHomeDir(&strDir); #ifdef __UNIX__ - if (strDir.Last() != _T('/')) strDir << _T('/'); +#ifdef __VMS + if (strDir.Last() != wxT(']')) +#endif + if (strDir.Last() != wxT('/')) strDir << wxT('/'); #else - if (strDir.Last() != _T('\\')) strDir << _T('\\'); + if (strDir.Last() != wxT('\\')) strDir << wxT('\\'); +#endif #endif - return strDir; + return strDir; } wxString wxFileConfig::GetGlobalFileName(const wxChar *szFile) { - wxString str = GetGlobalDir(); - str << szFile; - - if ( wxStrchr(szFile, _T('.')) == NULL ) - #ifdef __UNIX__ - str << _T(".conf"); - #else // Windows - str << _T(".ini"); - #endif // UNIX/Win - - return str; + wxString str = GetGlobalDir(); + str << szFile; + + 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 + + return str; } wxString wxFileConfig::GetLocalFileName(const wxChar *szFile) { - wxString str = GetLocalDir(); +#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 - #ifdef __UNIX__ - str << _T('.'); - #endif +#if defined( __UNIX__ ) && !defined( __VMS ) && !defined( __WXMAC__ ) + str << wxT('.'); +#endif - str << szFile; + str << szFile; - #ifdef __WXMSW__ - if ( wxStrchr(szFile, _T('.')) == NULL ) - str << _T(".ini"); - #endif +#if defined(__WINDOWS__) || defined(__DOS__) + if ( wxStrchr(szFile, wxT('.')) == NULL ) + str << wxT(".ini"); +#endif + +#ifdef __WXMAC__ + str << wxT(" Preferences") ; +#endif - return str; + return str; } // ---------------------------------------------------------------------------- @@ -166,96 +378,179 @@ wxString wxFileConfig::GetLocalFileName(const wxChar *szFile) void wxFileConfig::Init() { - m_pCurrentGroup = - m_pRootGroup = new ConfigGroup(NULL, "", this); + m_pCurrentGroup = + m_pRootGroup = new wxFileConfigGroup(NULL, wxT(""), this); - m_linesHead = - m_linesTail = NULL; + m_linesHead = + m_linesTail = NULL; - // it's not an error if (one of the) file(s) doesn't exist + // 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) ) { - wxTextFile fileGlobal(m_strGlobalFile); + // parse the global file + if ( !m_strGlobalFile.IsEmpty() && wxFile::Exists(m_strGlobalFile) ) + { + wxTextFile fileGlobal(m_strGlobalFile); - if ( fileGlobal.Open() ) { - Parse(fileGlobal, FALSE /* global */); - SetRootPath(); + if ( fileGlobal.Open(m_conv/*ignored in ANSI build*/) ) + { + Parse(fileGlobal, false /* global */); + SetRootPath(); + } + else + { + wxLogWarning(_("can't open global configuration file '%s'."), m_strGlobalFile.c_str()); + } } - else - wxLogWarning(_("can't open global configuration file '%s'."), - m_strGlobalFile.c_str()); - } - // parse the local file - if ( !m_strLocalFile.IsEmpty() && wxFile::Exists(m_strLocalFile) ) { - wxTextFile fileLocal(m_strLocalFile); - if ( fileLocal.Open() ) { - Parse(fileLocal, TRUE /* local */); - SetRootPath(); + // parse the local file + if ( !m_strLocalFile.IsEmpty() && wxFile::Exists(m_strLocalFile) ) + { + wxTextFile fileLocal(m_strLocalFile); + if ( fileLocal.Open(m_conv/*ignored in ANSI build*/) ) + { + Parse(fileLocal, true /* local */); + SetRootPath(); + } + else + { + wxLogWarning(_("can't open user configuration file '%s'."), m_strLocalFile.c_str() ); + } } - else - wxLogWarning(_("can't open user configuration file '%s'."), - m_strLocalFile.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) + long style, wxMBConv& conv) : wxConfigBase(::GetAppName(appName), vendorName, strLocal, strGlobal, style), - m_strLocalFile(strLocal), m_strGlobalFile(strGlobal) + m_strLocalFile(strLocal), m_strGlobalFile(strGlobal), + m_conv(conv) { - // Make up names for files if empty - if ( m_strLocalFile.IsEmpty() && (style & wxCONFIG_USE_LOCAL_FILE) ) - { - m_strLocalFile = GetLocalFileName(GetAppName()); - } + // Make up names for files if empty + if ( m_strLocalFile.IsEmpty() && (style & wxCONFIG_USE_LOCAL_FILE) ) + m_strLocalFile = GetLocalFileName(GetAppName()); + + if ( m_strGlobalFile.IsEmpty() && (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() ) + SetStyle(GetStyle() | wxCONFIG_USE_LOCAL_FILE); + + if ( !m_strGlobalFile.IsEmpty() ) + 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) ) + { + wxString strLocal = m_strLocalFile; + m_strLocalFile = GetLocalDir(); + m_strLocalFile << strLocal; + } - if ( m_strGlobalFile.IsEmpty() && (style & wxCONFIG_USE_GLOBAL_FILE) ) - { - m_strGlobalFile = GetGlobalFileName(GetAppName()); - } + if ( !m_strGlobalFile.IsEmpty() && !wxIsAbsolutePath(m_strGlobalFile) ) + { + wxString strGlobal = m_strGlobalFile; + m_strGlobalFile = GetGlobalDir(); + m_strGlobalFile << strGlobal; + } + } + + SetUmask(-1); + + Init(); +} + +#if wxUSE_STREAMS - // Check if styles are not supplied, but filenames are, in which case - // add the correct styles. - if ( !m_strLocalFile.IsEmpty() ) +wxFileConfig::wxFileConfig(wxInputStream &inStream, wxMBConv& conv) + : m_conv(conv) +{ + // always local_file when this constructor is called (?) SetStyle(GetStyle() | wxCONFIG_USE_LOCAL_FILE); - if ( !m_strGlobalFile.IsEmpty() ) - 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) ) - { - wxString strLocal = m_strLocalFile; - m_strLocalFile = GetLocalDir(); - m_strLocalFile << strLocal; - } - - if ( !m_strGlobalFile.IsEmpty() && !wxIsAbsolutePath(m_strGlobalFile) ) - { - wxString strGlobal = m_strGlobalFile; - m_strGlobalFile = GetGlobalDir(); - m_strGlobalFile << strGlobal; - } - } + m_pCurrentGroup = + m_pRootGroup = new wxFileConfigGroup(NULL, wxT(""), this); - Init(); + 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)); + + const wxStreamError err = inStream.GetLastError(); + + if ( err != wxSTREAM_NO_ERROR && err != wxSTREAM_EOF ) + { + wxLogError(_("Error reading config options.")); + break; + } + + strTmp.append(wxConvertMB2WX(buf), inStream.LastRead()); + } + while ( !inStream.Eof() ); + + 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. + if ( !strTrans.empty() ) + 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; } @@ -272,39 +567,57 @@ 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(); - for ( size_t n = 0; n < nLineCount; n++ ) { - strLine = file[n]; + size_t nLineCount = buffer.GetLineCount(); + + for ( size_t n = 0; n < nLineCount; n++ ) + { + strLine = buffer[n]; // add the line to linked list if ( bLocal ) + { LineListAppend(strLine); + // let the root group have it start line as well + if ( !n ) + { + m_pCurrentGroup->SetLine(m_linesTail); + } + } + + // skip leading spaces for ( pStart = strLine; wxIsspace(*pStart); pStart++ ) ; // skip blank/comment lines - if ( *pStart == _T('\0')|| *pStart == _T(';') || *pStart == _T('#') ) + if ( *pStart == wxT('\0')|| *pStart == wxT(';') || *pStart == wxT('#') ) continue; - if ( *pStart == _T('[') ) { // a new group + if ( *pStart == wxT('[') ) { // a new group pEnd = pStart; - while ( *++pEnd != _T(']') ) { - if ( *pEnd == _T('\n') || *pEnd == _T('\0') ) + while ( *++pEnd != wxT(']') ) { + if ( *pEnd == wxT('\\') ) { + // the next char is escaped, so skip it even if it is ']' + pEnd++; + } + + if ( *pEnd == wxT('\n') || *pEnd == wxT('\0') ) { + // we reached the end of line, break out of the loop break; + } } - if ( *pEnd != _T(']') ) { + 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 } @@ -318,68 +631,71 @@ void wxFileConfig::Parse(wxTextFile& file, bool bLocal) SetPath(strGroup); if ( bLocal ) + { + if ( m_pCurrentGroup->Parent() ) + m_pCurrentGroup->Parent()->SetLastGroup(m_pCurrentGroup); m_pCurrentGroup->SetLine(m_linesTail); + } // check that there is nothing except comments left on this line - bool bCont = TRUE; - while ( *++pEnd != _T('\0') && bCont ) { + bool bCont = true; + while ( *++pEnd != wxT('\0') && bCont ) { switch ( *pEnd ) { - case _T('#'): - case _T(';'): - bCont = FALSE; + case wxT('#'): + case wxT(';'): + bCont = false; break; - case _T(' '): - case _T('\t'): + case wxT(' '): + case wxT('\t'): // ignore whitespace ('\n' impossible here) break; default: - wxLogWarning(_("file '%s', line %d: '%s' " - "ignored after group header."), - file.GetName(), n + 1, pEnd); - bCont = FALSE; + wxLogWarning(_("file '%s', line %d: '%s' ignored after group header."), + buffer.GetName(), n + 1, pEnd); + bCont = false; } } } else { // a key const wxChar *pEnd = pStart; - while ( *pEnd != _T('=') && !wxIsspace(*pEnd) ) { - if ( *pEnd == _T('\\') ) { + while ( *pEnd && *pEnd != wxT('=') /* && !wxIsspace(*pEnd)*/ ) { + if ( *pEnd == wxT('\\') ) { // next character may be space or not - still take it because it's - // quoted + // quoted (unless there is nothing) pEnd++; + if ( !*pEnd ) { + // the error message will be given below anyhow + break; + } } pEnd++; } - wxString strKey(FilterInEntryName(wxString(pStart, pEnd))); + wxString strKey(FilterInEntryName(wxString(pStart, pEnd).Trim())); // skip whitespace - while ( isspace(*pEnd) ) + while ( wxIsspace(*pEnd) ) pEnd++; - if ( *pEnd++ != _T('=') ) { + 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 pEntry = m_pCurrentGroup->AddEntry(strKey, n); - - if ( bLocal ) - pEntry->SetLine(m_linesTail); } else { 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()); + wxLogWarning(_("file '%s', line %d: value for immutable key '%s' ignored."), + buffer.GetName(), n + 1, strKey.c_str()); continue; } // the condition below catches the cases (a) and (b) but not (c): @@ -388,20 +704,24 @@ void wxFileConfig::Parse(wxTextFile& file, bool bLocal) // (c) key from global file now found in local one // 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()); + wxLogWarning(_("file '%s', line %d: key '%s' was first found at line %d."), + buffer.GetName(), n + 1, strKey.c_str(), pEntry->Line()); - if ( bLocal ) - pEntry->SetLine(m_linesTail); } } + if ( bLocal ) + pEntry->SetLine(m_linesTail); + // skip whitespace while ( wxIsspace(*pEnd) ) pEnd++; - pEntry->SetValue(FilterInValue(pEnd), FALSE /* read from file */); + wxString value = pEnd; + if ( !(GetStyle() & wxCONFIG_USE_NO_ESCAPE_CHARACTERS) ) + value = FilterInValue(value); + + pEntry->SetValue(value, false); } } } @@ -441,7 +761,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; @@ -467,11 +787,11 @@ bool wxFileConfig::GetFirstGroup(wxString& str, long& lIndex) const bool wxFileConfig::GetNextGroup (wxString& str, long& lIndex) const { if ( size_t(lIndex) < m_pCurrentGroup->Groups().Count() ) { - str = m_pCurrentGroup->Groups()[lIndex++]->Name(); - return TRUE; + str = m_pCurrentGroup->Groups()[(size_t)lIndex++]->Name(); + return true; } else - return FALSE; + return false; } bool wxFileConfig::GetFirstEntry(wxString& str, long& lIndex) const @@ -483,22 +803,22 @@ bool wxFileConfig::GetFirstEntry(wxString& str, long& lIndex) const bool wxFileConfig::GetNextEntry (wxString& str, long& lIndex) const { if ( size_t(lIndex) < m_pCurrentGroup->Entries().Count() ) { - str = m_pCurrentGroup->Entries()[lIndex++]->Name(); - return TRUE; + str = m_pCurrentGroup->Entries()[(size_t)lIndex++]->Name(); + return true; } else - return FALSE; + return false; } 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]; - n += GetNumberOfEntries(TRUE); + n += GetNumberOfEntries(true); CONST_CAST m_pCurrentGroup = pOldCurrentGroup; } } @@ -510,11 +830,11 @@ 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]; - n += GetNumberOfGroups(TRUE); + n += GetNumberOfGroups(true); CONST_CAST m_pCurrentGroup = pOldCurrentGroup; } } @@ -530,7 +850,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; } @@ -538,7 +858,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; } @@ -546,117 +866,165 @@ 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; + return false; } - else { - *pStr = ExpandEnvVars(pEntry->Value()); - return TRUE; - } -} -bool wxFileConfig::Read(const wxString& key, - wxString* pStr, const wxString& defVal) const -{ - wxConfigPathChanger path(this, key); + *pStr = pEntry->Value(); - ConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name()); - if (pEntry == NULL) { - if( IsRecordingDefaults() ) - ((wxFileConfig *)this)->Write(key,defVal); - *pStr = ExpandEnvVars(defVal); - return FALSE; - } - else { - *pStr = ExpandEnvVars(pEntry->Value()); - return TRUE; - } + 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) ) { - *pl = wxAtol(str); - return TRUE; - } - else { - return FALSE; - } + wxString str; + if ( !Read(key, &str) ) + return false; + + // extra spaces shouldn't prevent us from reading numeric values + str.Trim(); + + 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); + wxConfigPathChanger path(this, key); + wxString strName = path.Name(); - wxString strName = path.Name(); - if ( strName.IsEmpty() ) { - // setting the value of a group is an error - wxASSERT_MSG( wxIsEmpty(szValue), _T("can't set value of a group!") ); + wxLogTrace( FILECONF_TRACE_MASK, + _T(" Writing String '%s' = '%s' to Group '%s'"), + strName.c_str(), + szValue.c_str(), + GetPath().c_str() ); - // ... except if it's empty in which case it's a way to force it's creation - m_pCurrentGroup->SetDirty(); + if ( strName.IsEmpty() ) + { + // setting the value of a group is an error - // this will add a line for this group if it didn't have it before - (void)m_pCurrentGroup->GetGroupLine(); - } - else { - // writing an entry + wxASSERT_MSG( wxIsEmpty(szValue), 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( FILECONF_TRACE_MASK, + _T(" Creating group %s"), + m_pCurrentGroup->Name().c_str() ); + + SetDirty(); + + // this will add a line for this group if it didn't have it before - // 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; + (void)m_pCurrentGroup->GetGroupLine(); } + else + { + // 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; + } - ConfigEntry *pEntry = m_pCurrentGroup->FindEntry(strName); - if ( pEntry == NULL ) - pEntry = m_pCurrentGroup->AddEntry(strName); + wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(strName); - pEntry->SetValue(szValue); - } + if ( pEntry == 0 ) + { + wxLogTrace( FILECONF_TRACE_MASK, + _T(" Adding Entry %s"), + strName.c_str() ); + pEntry = m_pCurrentGroup->AddEntry(strName); + } + + wxLogTrace( FILECONF_TRACE_MASK, + _T(" Setting value %s"), + szValue.c_str() ); + pEntry->SetValue(szValue); - return TRUE; + SetDirty(); + } + + 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(_T("%ld"), lValue); - return Write(key, buf); + return Write(key, wxString::Format(_T("%ld"), lValue)); } bool wxFileConfig::Flush(bool /* bCurrentOnly */) { - if ( LineListIsEmpty() || !m_pRootGroup->IsDirty() ) - return TRUE; + if ( !IsDirty() || !m_strLocalFile ) + return true; + + // set the umask if needed + wxCHANGE_UMASK(m_umask); wxTempFile file(m_strLocalFile); - if ( !file.IsOpened() ) { + if ( !file.IsOpened() ) + { wxLogError(_("can't open user configuration file.")); - return FALSE; + return false; } // write all strings to file - for ( LineList *p = m_linesHead; p != NULL; p = p->Next() ) { - if ( !file.Write(p->Text() + wxTextFile::GetEOL()) ) { + 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; + return false; } } - return file.Commit(); + if ( !file.Commit() ) + { + wxLogError(_("Failed to update user configuration file.")); + + return false; + } + + ResetDirty(); + +#if defined(__WXMAC__) + wxFileName(m_strLocalFile).MacSetTypeAndCreator('TEXT', 'ttxt'); +#endif // __WXMAC__ + + return true; +} + +#if wxUSE_STREAMS + +bool wxFileConfig::Save(wxOutputStream& os, 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(); + if ( !os.Write(line.mb_str(conv), line.length()) ) + { + wxLogError(_("Error saving user configuration data.")); + + return false; + } + } + + ResetDirty(); + + return true; } +#endif // wxUSE_STREAMS + // ---------------------------------------------------------------------------- // renaming groups/entries // ---------------------------------------------------------------------------- @@ -664,41 +1032,48 @@ bool wxFileConfig::Flush(bool /* bCurrentOnly */) 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 - ConfigEntry *oldEntry = m_pCurrentGroup->FindEntry(oldName); + 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; - ConfigEntry *newEntry = m_pCurrentGroup->AddEntry(newName); + SetDirty(); + + wxFileConfigEntry *newEntry = m_pCurrentGroup->AddEntry(newName); newEntry->SetValue(value); - return TRUE; + return true; } 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; + 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; } // ---------------------------------------------------------------------------- @@ -710,116 +1085,191 @@ bool wxFileConfig::DeleteEntry(const wxString& key, bool bGroupIfEmptyAlso) wxConfigPathChanger path(this, key); if ( !m_pCurrentGroup->DeleteEntry(path.Name()) ) - return FALSE; + return false; if ( bGroupIfEmptyAlso && m_pCurrentGroup->IsEmpty() ) { if ( m_pCurrentGroup != m_pRootGroup ) { - ConfigGroup *pGroup = m_pCurrentGroup; - SetPath(_T("..")); // changes m_pCurrentGroup! - m_pCurrentGroup->DeleteSubgroupByName(pGroup->Name()); + wxFileConfigGroup *pGroup = m_pCurrentGroup; + SetPath(wxT("..")); // changes m_pCurrentGroup! + if ( m_pCurrentGroup->DeleteSubgroupByName(pGroup->Name()) ) + SetDirty(); } //else: never delete the root group } - return TRUE; + return true; } bool wxFileConfig::DeleteGroup(const wxString& key) { wxConfigPathChanger path(this, key); - return m_pCurrentGroup->DeleteSubgroupByName(path.Name()); + if ( !m_pCurrentGroup->DeleteSubgroupByName(path.Name()) ) + return false; + + SetDirty(); + + return true; } bool wxFileConfig::DeleteAll() { CleanUp(); - if ( remove(m_strLocalFile.fn_str()) == -1 ) - wxLogSysError(_("can't delete user configuration file '%s'"), m_strLocalFile.c_str()); + if ( !m_strLocalFile.empty() ) + { + if ( wxFile::Exists(m_strLocalFile) && wxRemove(m_strLocalFile) == -1 ) + { + wxLogSysError(_("can't delete user configuration file '%s'"), + m_strLocalFile.c_str()); + return false; + } + + m_strLocalFile = + m_strGlobalFile = wxT(""); + } - m_strLocalFile = m_strGlobalFile = _T(""); Init(); - return TRUE; + return true; } // ---------------------------------------------------------------------------- // linked list functions // ---------------------------------------------------------------------------- -// append a new line to the end of the list -LineList *wxFileConfig::LineListAppend(const wxString& str) + // append a new line to the end of the list + +wxFileConfigLineList *wxFileConfig::LineListAppend(const wxString& str) { - LineList *pLine = new LineList(str); + wxLogTrace( FILECONF_TRACE_MASK, + _T(" ** Adding Line '%s'"), + str.c_str() ); + wxLogTrace( FILECONF_TRACE_MASK, + _T(" head: %s"), + ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) ); + wxLogTrace( FILECONF_TRACE_MASK, + _T(" tail: %s"), + ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) ); + + wxFileConfigLineList *pLine = new wxFileConfigLineList(str); + + if ( m_linesTail == NULL ) + { + // list is empty + m_linesHead = pLine; + } + else + { + // adjust pointers + m_linesTail->SetNext(pLine); + pLine->SetPrev(m_linesTail); + } - if ( m_linesTail == NULL ) { - // list is empty - m_linesHead = pLine; - } - else { - // adjust pointers - m_linesTail->SetNext(pLine); - pLine->SetPrev(m_linesTail); - } + m_linesTail = pLine; + + wxLogTrace( FILECONF_TRACE_MASK, + _T(" head: %s"), + ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) ); + wxLogTrace( FILECONF_TRACE_MASK, + _T(" tail: %s"), + ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) ); - m_linesTail = pLine; - return m_linesTail; + return m_linesTail; } // insert a new line after the given one or in the very beginning if !pLine -LineList *wxFileConfig::LineListInsert(const wxString& str, - LineList *pLine) -{ - if ( pLine == m_linesTail ) - return LineListAppend(str); - - LineList *pNewLine = new LineList(str); - if ( pLine == NULL ) { - // prepend to the list - pNewLine->SetNext(m_linesHead); - m_linesHead->SetPrev(pNewLine); - m_linesHead = pNewLine; - } - else { - // insert before pLine - LineList *pNext = pLine->Next(); - pNewLine->SetNext(pNext); - pNewLine->SetPrev(pLine); - pNext->SetPrev(pNewLine); - pLine->SetNext(pNewLine); - } +wxFileConfigLineList *wxFileConfig::LineListInsert(const wxString& str, + wxFileConfigLineList *pLine) +{ + wxLogTrace( FILECONF_TRACE_MASK, + _T(" ** Inserting Line '%s' after '%s'"), + str.c_str(), + ((pLine) ? pLine->Text().c_str() : wxEmptyString) ); + wxLogTrace( FILECONF_TRACE_MASK, + _T(" head: %s"), + ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) ); + wxLogTrace( FILECONF_TRACE_MASK, + _T(" tail: %s"), + ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) ); + + if ( pLine == m_linesTail ) + return LineListAppend(str); + + wxFileConfigLineList *pNewLine = new wxFileConfigLineList(str); + if ( pLine == NULL ) + { + // prepend to the list + pNewLine->SetNext(m_linesHead); + m_linesHead->SetPrev(pNewLine); + m_linesHead = pNewLine; + } + else + { + // insert before pLine + wxFileConfigLineList *pNext = pLine->Next(); + pNewLine->SetNext(pNext); + pNewLine->SetPrev(pLine); + pNext->SetPrev(pNewLine); + pLine->SetNext(pNewLine); + } - return pNewLine; + wxLogTrace( FILECONF_TRACE_MASK, + _T(" head: %s"), + ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) ); + wxLogTrace( FILECONF_TRACE_MASK, + _T(" tail: %s"), + ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) ); + + return pNewLine; } -void wxFileConfig::LineListRemove(LineList *pLine) +void wxFileConfig::LineListRemove(wxFileConfigLineList *pLine) { - LineList *pPrev = pLine->Prev(), - *pNext = pLine->Next(); + wxLogTrace( FILECONF_TRACE_MASK, + _T(" ** Removing Line '%s'"), + pLine->Text().c_str() ); + wxLogTrace( FILECONF_TRACE_MASK, + _T(" head: %s"), + ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) ); + wxLogTrace( FILECONF_TRACE_MASK, + _T(" tail: %s"), + ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) ); + + wxFileConfigLineList *pPrev = pLine->Prev(), + *pNext = pLine->Next(); + + // first entry? + + if ( pPrev == NULL ) + m_linesHead = pNext; + else + pPrev->SetNext(pNext); - // first entry? - if ( pPrev == NULL ) - m_linesHead = pNext; - else - pPrev->SetNext(pNext); + // last entry? - // last entry? - if ( pNext == NULL ) - m_linesTail = pPrev; - else - pNext->SetPrev(pPrev); + if ( pNext == NULL ) + m_linesTail = pPrev; + else + pNext->SetPrev(pPrev); - delete pLine; + wxLogTrace( FILECONF_TRACE_MASK, + _T(" head: %s"), + ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) ); + wxLogTrace( FILECONF_TRACE_MASK, + _T(" tail: %s"), + ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) ); + + delete pLine; } bool wxFileConfig::LineListIsEmpty() { - return m_linesHead == NULL; + return m_linesHead == NULL; } // ============================================================================ -// wxFileConfig::ConfigGroup +// wxFileConfig::wxFileConfigGroup // ============================================================================ // ---------------------------------------------------------------------------- @@ -827,7 +1277,7 @@ bool wxFileConfig::LineListIsEmpty() // ---------------------------------------------------------------------------- // ctor -ConfigGroup::ConfigGroup(ConfigGroup *pParent, +wxFileConfigGroup::wxFileConfigGroup(wxFileConfigGroup *pParent, const wxString& strName, wxFileConfig *pConfig) : m_aEntries(CompareEntries), @@ -836,7 +1286,6 @@ ConfigGroup::ConfigGroup(ConfigGroup *pParent, { m_pConfig = pConfig; m_pParent = pParent; - m_bDirty = FALSE; m_pLine = NULL; m_pLastEntry = NULL; @@ -844,7 +1293,7 @@ ConfigGroup::ConfigGroup(ConfigGroup *pParent, } // dtor deletes all children -ConfigGroup::~ConfigGroup() +wxFileConfigGroup::~wxFileConfigGroup() { // entries size_t n, nCount = m_aEntries.Count(); @@ -861,11 +1310,10 @@ ConfigGroup::~ConfigGroup() // line // ---------------------------------------------------------------------------- -void ConfigGroup::SetLine(LineList *pLine) +void wxFileConfigGroup::SetLine(wxFileConfigLineList *pLine) { - wxASSERT( m_pLine == NULL ); // shouldn't be called twice - - m_pLine = pLine; + wxASSERT( m_pLine == 0 ); // shouldn't be called twice + m_pLine = pLine; } /* @@ -902,87 +1350,140 @@ 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() -{ - if ( m_pLine == NULL ) { - ConfigGroup *pParent = Parent(); - - // this group wasn't present in local config file, add it now - if ( pParent != NULL ) { - wxString strFullName; - strFullName << _T("[") - // +1: no '/' - << FilterOutEntryName(GetFullName().c_str() + 1) - << _T("]"); - m_pLine = m_pConfig->LineListInsert(strFullName, - pParent->GetLastGroupLine()); - pParent->SetLastGroup(this); // we're surely after all the others - } - else { - // we return NULL, so that LineListInsert() will insert us in the - // very beginning +wxFileConfigLineList *wxFileConfigGroup::GetGroupLine() +{ + wxLogTrace( FILECONF_TRACE_MASK, + _T(" GetGroupLine() for Group '%s'"), + Name().c_str() ); + + if ( !m_pLine ) + { + wxLogTrace( FILECONF_TRACE_MASK, + _T(" Getting Line item pointer") ); + + wxFileConfigGroup *pParent = Parent(); + + // this group wasn't present in local config file, add it now + if ( pParent ) + { + wxLogTrace( FILECONF_TRACE_MASK, + _T(" checking parent '%s'"), + pParent->Name().c_str() ); + + wxString strFullName; + + // add 1 to the name because we don't want to start with '/' + strFullName << wxT("[") + << FilterOutEntryName(GetFullName().c_str() + 1) + << wxT("]"); + m_pLine = m_pConfig->LineListInsert(strFullName, + pParent->GetLastGroupLine()); + pParent->SetLastGroup(this); // we're surely after all the others + } + //else: this is the root group and so we return NULL because we don't + // have any group line } - } - return m_pLine; + return m_pLine; } // 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(); + // if we have any subgroups, our last line is the last line of the last + // subgroup + if ( m_pLastGroup ) + { + wxFileConfigLineList *pLine = m_pLastGroup->GetLastGroupLine(); - wxASSERT( pLine != NULL ); // last group must have !NULL associated line - return pLine; - } + wxASSERT_MSG( pLine, _T("last group must have !NULL associated line") ); - // no subgroups, so the last line is the line of thelast entry (if any) - return GetLastEntryLine(); + return pLine; + } + + // no subgroups, so the last line is the line of thelast entry (if any) + return GetLastEntryLine(); } // 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(); + wxLogTrace( FILECONF_TRACE_MASK, + _T(" GetLastEntryLine() for Group '%s'"), + Name().c_str() ); - wxASSERT( pLine != NULL ); // last entry must have !NULL associated line - return pLine; - } + if ( m_pLastEntry ) + { + wxFileConfigLineList *pLine = m_pLastEntry->GetLine(); - // no entries: insert after the group header - return GetGroupLine(); + wxASSERT_MSG( pLine, _T("last entry must have !NULL associated line") ); + + return pLine; + } + + // no entries: insert after the group header, if any + return GetGroupLine(); +} + +void wxFileConfigGroup::SetLastEntry(wxFileConfigEntry *pEntry) +{ + m_pLastEntry = pEntry; + + if ( !m_pLine ) + { + // the only situation in which a group without its own line can have + // an entry is when the first entry is added to the initially empty + // root pseudo-group + wxASSERT_MSG( !m_pParent, _T("unexpected for non root group") ); + + // let the group know that it does have a line in the file now + m_pLine = pEntry->GetLine(); + } } // ---------------------------------------------------------------------------- // group name // ---------------------------------------------------------------------------- -void ConfigGroup::Rename(const wxString& newName) +void wxFileConfigGroup::UpdateGroupAndSubgroupsLines() { - m_strName = newName; + // update the line of this group + wxFileConfigLineList *line = GetGroupLine(); + wxCHECK_RET( line, _T("a non root group must have a corresponding line!") ); - LineList *line = GetGroupLine(); - wxString strFullName; - strFullName << _T("[") << (GetFullName().c_str() + 1) << _T("]"); // +1: no '/' - line->SetText(strFullName); + // +1: skip the leading '/' + line->SetText(wxString::Format(_T("[%s]"), GetFullName().c_str() + 1)); - SetDirty(); + + // 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(); + } } -wxString ConfigGroup::GetFullName() const +void wxFileConfigGroup::Rename(const wxString& newName) { - if ( Parent() ) - return Parent()->GetFullName() + wxCONFIG_PATH_SEPARATOR + Name(); - else - return _T(""); + wxCHECK_RET( m_pParent, _T("the root group can't be renamed") ); + + m_strName = newName; + + // update the group lines recursively + UpdateGroupAndSubgroupsLines(); +} + +wxString wxFileConfigGroup::GetFullName() const +{ + wxString fullname; + if ( Parent() ) + fullname = Parent()->GetFullName() + wxCONFIG_PATH_SEPARATOR + Name(); + + return fullname; } // ---------------------------------------------------------------------------- @@ -990,14 +1491,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; @@ -1020,14 +1521,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; @@ -1055,27 +1556,25 @@ 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 ); + wxASSERT( FindEntry(strName) == 0 ); - ConfigEntry *pEntry = new ConfigEntry(this, strName, nLine); - m_aEntries.Add(pEntry); + wxFileConfigEntry *pEntry = new wxFileConfigEntry(this, strName, nLine); - return pEntry; + 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 ); + wxASSERT( FindSubgroup(strName) == 0 ); - ConfigGroup *pGroup = new ConfigGroup(this, strName, m_pConfig); - m_aSubgroups.Add(pGroup); + wxFileConfigGroup *pGroup = new wxFileConfigGroup(this, strName, m_pConfig); - return pGroup; + m_aSubgroups.Add(pGroup); + return pGroup; } // ---------------------------------------------------------------------------- @@ -1089,84 +1588,132 @@ 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)); + wxFileConfigGroup * const pGroup = FindSubgroup(szName); + + return pGroup ? DeleteSubgroup(pGroup) : false; } -// 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) +// Delete the subgroup and remove all references to it from +// other data structures. +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(); - if ( pLine != NULL ) - m_pConfig->LineListRemove(pLine); - } - - // and subgroups of this sungroup - nCount = pGroup->m_aSubgroups.Count(); - for ( size_t nGroup = 0; nGroup < nCount; nGroup++ ) { - pGroup->DeleteSubgroup(pGroup->m_aSubgroups[0]); - } - - LineList *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 - if ( pGroup == m_pLastGroup ) { - // our last entry is being deleted - find the last one which stays - 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; - size_t n, nSubgroups = m_aSubgroups.Count(); - LineList *pl; - for ( pl = pLine->Prev(); pl != m_pLine; pl = pl->Prev() ) { - // is it our subgroup? - for ( n = 0; (pNewLast == NULL) && (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]; + wxCHECK_MSG( pGroup, false, _T("deleting non existing group?") ); + + wxLogTrace( FILECONF_TRACE_MASK, + _T("Deleting group '%s' from '%s'"), + pGroup->Name().c_str(), + Name().c_str() ); + + 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( FILECONF_TRACE_MASK, + _T(" text: '%s'"), + ((m_pLine) ? m_pLine->Text().c_str() : wxEmptyString) ); + + // delete all entries... + size_t nCount = pGroup->m_aEntries.Count(); + + 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(); + + if ( pLine ) + { + wxLogTrace( FILECONF_TRACE_MASK, + _T(" '%s'"), + pLine->Text().c_str() ); + m_pConfig->LineListRemove(pLine); } + } - if ( pNewLast != NULL ) // found? - break; - } + // ...and subgroups of this subgroup + nCount = pGroup->m_aSubgroups.Count(); - if ( pl == m_pLine ) { - wxASSERT( !pNewLast ); // how comes it has the same line as we? + wxLogTrace( FILECONF_TRACE_MASK, + _T("Removing %lu subgroups"), (unsigned long)nCount ); - // we've reached the group line without finding any subgroups - m_pLastGroup = NULL; - } - else - m_pLastGroup = pNewLast; + for ( size_t nGroup = 0; nGroup < nCount; nGroup++ ) + { + pGroup->DeleteSubgroup(pGroup->m_aSubgroups[0]); } - m_pConfig->LineListRemove(pLine); - } + // and then finally the group itself + wxFileConfigLineList *pLine = pGroup->m_pLine; + if ( pLine ) + { + wxLogTrace( FILECONF_TRACE_MASK, + _T(" Removing line for group '%s' : '%s'"), + pGroup->Name().c_str(), + pLine->Text().c_str() ); + 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 + if ( pGroup == m_pLastGroup ) + { + 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.Count(); + + m_pLastGroup = NULL; + for ( wxFileConfigLineList *pl = pLine->Prev(); + pl && pl != m_pLine && !m_pLastGroup; + pl = pl->Prev() ) + { + // 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 == pl ) + { + m_pLastGroup = m_aSubgroups[n]; + break; + } + } + } + } - SetDirty(); + m_pConfig->LineListRemove(pLine); + } + else + { + wxLogTrace( FILECONF_TRACE_MASK, + _T(" No line entry for Group '%s'?"), + pGroup->Name().c_str() ); + } - m_aSubgroups.Remove(pGroup); - delete pGroup; + m_aSubgroups.Remove(pGroup); + delete pGroup; - return TRUE; + return true; } -bool ConfigGroup::DeleteEntry(const wxChar *szName) +bool wxFileConfigGroup::DeleteEntry(const wxChar *szName) { - ConfigEntry *pEntry = FindEntry(szName); - wxCHECK( pEntry != NULL, FALSE ); // deleting non existing item? + wxFileConfigEntry *pEntry = FindEntry(szName); + if ( !pEntry ) + { + // entry doesn't exist, nothing to do + return false; + } - 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 @@ -1175,9 +1722,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++ ) { @@ -1202,33 +1749,20 @@ bool ConfigGroup::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 ConfigGroup::SetDirty() -{ - m_bDirty = TRUE; - if ( Parent() != NULL ) // propagate upwards - Parent()->SetDirty(); + return true; } // ============================================================================ -// wxFileConfig::ConfigEntry +// wxFileConfig::wxFileConfigEntry // ============================================================================ // ---------------------------------------------------------------------------- // ctor // ---------------------------------------------------------------------------- -ConfigEntry::ConfigEntry(ConfigGroup *pParent, +wxFileConfigEntry::wxFileConfigEntry(wxFileConfigGroup *pParent, const wxString& strName, int nLine) : m_strName(strName) @@ -1239,7 +1773,7 @@ ConfigEntry::ConfigEntry(ConfigGroup *pParent, m_nLine = nLine; m_pLine = NULL; - m_bDirty = FALSE; + m_bHasValue = false; m_bImmutable = strName[0] == wxCONFIG_IMMUTABLE_PREFIX; if ( m_bImmutable ) @@ -1250,7 +1784,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'"), @@ -1261,48 +1795,54 @@ void ConfigEntry::SetLine(LineList *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 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."), - Name().c_str()); - return; - } + if ( bUser && IsImmutable() ) + { + wxLogWarning( _("attempt to change immutable key '%s' ignored."), + Name().c_str()); + return; + } - // do nothing if it's the same value - if ( strValue == m_strValue ) - 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 + if ( m_bHasValue && strValue == m_strValue ) + return; - m_strValue = strValue; + m_bHasValue = true; + m_strValue = strValue; - if ( bUser ) { - wxString strVal = FilterOutValue(strValue); - wxString strLine; - strLine << FilterOutEntryName(m_strName) << _T('=') << strVal; + if ( bUser ) + { + wxString strValFiltered; - if ( m_pLine != NULL ) { - // entry was read from the local config file, just modify the line - m_pLine->SetText(strLine); - } - else { - // add a new line to the file - wxASSERT( m_nLine == wxNOT_FOUND ); // consistency check + if ( Group()->Config()->GetStyle() & wxCONFIG_USE_NO_ESCAPE_CHARACTERS ) + { + strValFiltered = strValue; + } + else { + strValFiltered = FilterOutValue(strValue); + } - m_pLine = Group()->Config()->LineListInsert(strLine, - Group()->GetLastEntryLine()); - Group()->SetLastEntry(this); - } + wxString strLine; + strLine << FilterOutEntryName(m_strName) << wxT('=') << strValFiltered; - SetDirty(); - } -} + if ( m_pLine ) + { + // entry was read from the local config file, just modify the line + m_pLine->SetText(strLine); + } + else // this entry didn't exist in the local file + { + // add a new line to the file + wxFileConfigLineList *line = Group()->GetLastEntryLine(); + m_pLine = Group()->Config()->LineListInsert(strLine, line); -void ConfigEntry::SetDirty() -{ - m_bDirty = TRUE; - Group()->SetDirty(); + Group()->SetLastEntry(this); + } + } } // ============================================================================ @@ -1313,8 +1853,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()); @@ -1323,8 +1862,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()); @@ -1346,31 +1884,31 @@ static wxString FilterInValue(const wxString& str) bool bQuoted = !str.IsEmpty() && str[0] == '"'; for ( size_t n = bQuoted ? 1 : 0; n < str.Len(); n++ ) { - if ( str[n] == _T('\\') ) { + if ( str[n] == wxT('\\') ) { switch ( str[++n] ) { - case _T('n'): - strResult += _T('\n'); + case wxT('n'): + strResult += wxT('\n'); break; - case _T('r'): - strResult += _T('\r'); + case wxT('r'): + strResult += wxT('\r'); break; - case _T('t'): - strResult += _T('\t'); + case wxT('t'): + strResult += wxT('\t'); break; - case _T('\\'): - strResult += _T('\\'); + case wxT('\\'): + strResult += wxT('\\'); break; - case _T('"'): - strResult += _T('"'); + case wxT('"'): + strResult += wxT('"'); break; } } else { - if ( str[n] != _T('"') || !bQuoted ) + if ( str[n] != wxT('"') || !bQuoted ) strResult += str[n]; else if ( n != str.Len() - 1 ) { wxLogWarning(_("unexpected \" at position %d in '%s'."), @@ -1393,33 +1931,33 @@ static wxString FilterOutValue(const wxString& str) strResult.Alloc(str.Len()); // quoting is necessary to preserve spaces in the beginning of the string - bool bQuote = wxIsspace(str[0]) || str[0] == _T('"'); + bool bQuote = wxIsspace(str[0]) || str[0] == wxT('"'); if ( bQuote ) - strResult += _T('"'); + strResult += wxT('"'); wxChar c; for ( size_t n = 0; n < str.Len(); n++ ) { switch ( str[n] ) { - case _T('\n'): - c = _T('n'); + case wxT('\n'): + c = wxT('n'); break; - case _T('\r'): - c = _T('r'); + case wxT('\r'): + c = wxT('r'); break; - case _T('\t'): - c = _T('t'); + case wxT('\t'): + c = wxT('t'); break; - case _T('\\'): - c = _T('\\'); + case wxT('\\'): + c = wxT('\\'); break; - case _T('"'): + case wxT('"'): if ( bQuote ) { - c = _T('"'); + c = wxT('"'); break; } //else: fall through @@ -1430,11 +1968,11 @@ static wxString FilterOutValue(const wxString& str) } // we get here only for special characters - strResult << _T('\\') << c; + strResult << wxT('\\') << c; } if ( bQuote ) - strResult += _T('"'); + strResult += wxT('"'); return strResult; } @@ -1446,7 +1984,7 @@ static wxString FilterInEntryName(const wxString& str) strResult.Alloc(str.Len()); for ( const wxChar *pc = str.c_str(); *pc != '\0'; pc++ ) { - if ( *pc == _T('\\') ) + if ( *pc == wxT('\\') ) pc++; strResult += *pc; @@ -1461,15 +1999,23 @@ static wxString FilterOutEntryName(const wxString& str) wxString strResult; strResult.Alloc(str.Len()); - for ( const wxChar *pc = str.c_str(); *pc != _T('\0'); pc++ ) { - wxChar c = *pc; + for ( const wxChar *pc = str.c_str(); *pc != wxT('\0'); 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(_T("@_/-!.*%"), c) && ((c & 0x80) == 0) ) - strResult += _T('\\'); + if ( +#if !wxUSE_UNICODE + ((unsigned char)c < 127) && +#endif // ANSI + !wxIsalnum(c) && !wxStrchr(wxT("@_/-!.*%"), c) ) + { + strResult += wxT('\\'); + } strResult += c; }