X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1824493628261b2cb7ceceb431d85c427f1c976b..1f2f0331455e0a91fdbc57afefe8f8c7c0db9392:/src/common/fileconf.cpp?ds=sidebyside diff --git a/src/common/fileconf.cpp b/src/common/fileconf.cpp index bdf11498cb..dd99938e9a 100644 --- a/src/common/fileconf.cpp +++ b/src/common/fileconf.cpp @@ -28,17 +28,19 @@ #endif //__BORLANDC__ #ifndef WX_PRECOMP - #include - #include + #include "wx/string.h" + #include "wx/intl.h" #endif //WX_PRECOMP -#include -#include -#include -#include -#include -#include -#include +#include "wx/app.h" +#include "wx/dynarray.h" +#include "wx/file.h" +#include "wx/log.h" +#include "wx/textfile.h" +#include "wx/config.h" +#include "wx/fileconf.h" + +#include "wx/utils.h" // for wxGetHomeDir // _WINDOWS_ is defined when windows.h is included, // __WXMSW__ is defined for MS Windows compilation @@ -54,6 +56,13 @@ // ---------------------------------------------------------------------------- #define CONST_CAST ((wxFileConfig *)this)-> +// ---------------------------------------------------------------------------- +// constants +// ---------------------------------------------------------------------------- +#ifndef MAX_PATH + #define MAX_PATH 512 +#endif + // ---------------------------------------------------------------------------- // global functions declarations // ---------------------------------------------------------------------------- @@ -64,10 +73,8 @@ inline bool IsValid(char c) { return isalnum(c) || strchr("@_/-!.*%", c); } // compare functions for sorting the arrays -static int CompareEntries(wxFileConfig::ConfigEntry *p1, - wxFileConfig::ConfigEntry *p2); -static int CompareGroups(wxFileConfig::ConfigGroup *p1, - wxFileConfig::ConfigGroup *p2); +static int CompareEntries(ConfigEntry *p1, ConfigEntry *p2); +static int CompareGroups(ConfigGroup *p1, ConfigGroup *p2); // filter strings static wxString FilterIn(const wxString& str); @@ -87,15 +94,10 @@ wxString wxFileConfig::GetGlobalDir() #ifdef __UNIX__ strDir = "/etc/"; #elif defined(__WXSTUBS__) - // TODO - wxASSERT( TRUE ) ; + wxASSERT_MSG( FALSE, "TODO" ) ; #else // Windows - #ifndef _MAX_PATH - #define _MAX_PATH 512 - #endif - - char szWinDir[_MAX_PATH]; - ::GetWindowsDirectory(szWinDir, _MAX_PATH); + char szWinDir[MAX_PATH]; + ::GetWindowsDirectory(szWinDir, MAX_PATH); strDir = szWinDir; strDir << '\\'; @@ -108,29 +110,13 @@ wxString wxFileConfig::GetLocalDir() { wxString strDir; - #ifdef __UNIX__ - const char *szHome = getenv("HOME"); - if ( szHome == NULL ) { - // we're homeless... - wxLogWarning(_("can't find user's HOME, using current directory.")); - strDir = "."; - } - else - strDir = szHome; - strDir << '/'; // a double slash is no problem, a missin one yes - #else // Windows - #ifdef __WIN32__ - const char *szHome = getenv("HOMEDRIVE"); - if ( szHome != NULL ) - strDir << szHome; - szHome = getenv("HOMEPATH"); - if ( szHome != NULL ) - strDir << szHome; - #else // Win16 - // Win16 has no idea about home, so use the current directory instead - strDir = ".\\"; - #endif // WIN16/32 - #endif // UNIX/Win + wxGetHomeDir(&strDir); + +#ifdef __UNIX__ + if (strDir.Last() != '/') strDir << '/'; +#else + if (strDir.Last() != '\\') strDir << '\\'; +#endif return strDir; } @@ -208,82 +194,51 @@ void wxFileConfig::Init() } } -#if 0 -wxFileConfig::wxFileConfig(const char *szAppName, bool bLocalOnly) -{ - wxASSERT( !IsEmpty(szAppName) ); // invent a name for your application! - - m_strLocalFile = GetLocalFileName(szAppName); - if ( !bLocalOnly ) - m_strGlobalFile = GetGlobalFileName(szAppName); - //else: it's going to be empty and we won't use the global file - - Init(); -} - -wxFileConfig::wxFileConfig(const wxString& strLocal, const wxString& strGlobal) - : m_strLocalFile(strLocal), m_strGlobalFile(strGlobal) -{ - // if the path is not absolute, prepend the standard directory to it - if ( !strLocal.IsEmpty() && !wxIsAbsolutePath(strLocal) ) - { - m_strLocalFile = GetLocalDir(); - m_strLocalFile << strLocal; - } - - if ( !strGlobal.IsEmpty() && !wxIsAbsolutePath(strGlobal) ) - { - m_strGlobalFile = GetGlobalDir(); - m_strGlobalFile << strGlobal; - } - - Init(); -} -#endif - -// New-style constructor +// 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) + const wxString& strLocal, const wxString& strGlobal, + long style) : wxConfigBase(appName, vendorName, strLocal, strGlobal, style), m_strLocalFile(strLocal), m_strGlobalFile(strGlobal) { - // Make up an application name if not supplied - if (appName.IsEmpty() && wxTheApp) - { - SetAppName(wxTheApp->GetAppName()); - } + // Make up an application name if not supplied + if (appName.IsEmpty() && wxTheApp) + { + SetAppName(wxTheApp->GetAppName()); + } - // Make up names for files if empty - if (m_strLocalFile.IsEmpty() && (style & wxCONFIG_USE_LOCAL_FILE) && wxTheApp) - { - m_strLocalFile = wxTheApp->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)) - { - // TODO: What should the default global filename be? - m_strGlobalFile = "global"; - } + 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() && ((style & wxCONFIG_USE_LOCAL_FILE) != wxCONFIG_USE_LOCAL_FILE)) - SetStyle(GetStyle() | wxCONFIG_USE_LOCAL_FILE); + // 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() && ((style & wxCONFIG_USE_GLOBAL_FILE) != wxCONFIG_USE_GLOBAL_FILE)) - SetStyle(GetStyle() | wxCONFIG_USE_GLOBAL_FILE); + if ( !m_strGlobalFile.IsEmpty() ) + SetStyle(GetStyle() | wxCONFIG_USE_GLOBAL_FILE); // if the path is not absolute, prepend the standard directory to it - if ( !strLocal.IsEmpty() && !wxIsAbsolutePath(strLocal) ) + if ( !m_strLocalFile.IsEmpty() && !wxIsAbsolutePath(m_strLocalFile) ) { - m_strLocalFile = GetLocalDir(); - m_strLocalFile << strLocal; + wxString strLocal = m_strLocalFile; + m_strLocalFile = GetLocalDir(); + m_strLocalFile << strLocal; } - - if ( !strGlobal.IsEmpty() && !wxIsAbsolutePath(strGlobal) ) + + if ( !m_strGlobalFile.IsEmpty() && !wxIsAbsolutePath(m_strGlobalFile) ) { - m_strGlobalFile = GetGlobalDir(); - m_strGlobalFile << strGlobal; + wxString strGlobal = m_strGlobalFile; + m_strGlobalFile = GetGlobalDir(); + m_strGlobalFile << strGlobal; } Init(); @@ -669,9 +624,9 @@ bool wxFileConfig::Write(const wxString& key, const wxString& szValue) bool wxFileConfig::Write(const wxString& key, long lValue) { // ltoa() is not ANSI :-( - char szBuf[40]; // should be good for sizeof(long) <= 16 (128 bits) - sprintf(szBuf, "%ld", lValue); - return Write(key, szBuf); + wxString buf; + buf.Printf("%ld", lValue); + return Write(key, buf); } bool wxFileConfig::Flush(bool /* bCurrentOnly */) @@ -697,6 +652,50 @@ bool wxFileConfig::Flush(bool /* bCurrentOnly */) return file.Commit(); } +// ---------------------------------------------------------------------------- +// renaming groups/entries +// ---------------------------------------------------------------------------- + +bool wxFileConfig::RenameEntry(const wxString& oldName, + const wxString& newName) +{ + // check that the entry exists + ConfigEntry *oldEntry = m_pCurrentGroup->FindEntry(oldName); + if ( !oldEntry ) + return FALSE; + + // check that the new entry doesn't already exist + if ( m_pCurrentGroup->FindEntry(newName) ) + return FALSE; + + // delete the old entry, create the new one + wxString value = oldEntry->Value(); + if ( !m_pCurrentGroup->DeleteEntry(oldName) ) + return FALSE; + + ConfigEntry *newEntry = m_pCurrentGroup->AddEntry(newName); + newEntry->SetValue(value); + + return TRUE; +} + +bool wxFileConfig::RenameGroup(const wxString& oldName, + const wxString& newName) +{ + // check that the group exists + ConfigGroup *group = m_pCurrentGroup->FindSubgroup(oldName); + if ( !group ) + return FALSE; + + // check that the new group doesn't already exist + if ( m_pCurrentGroup->FindSubgroup(newName) ) + return FALSE; + + group->Rename(newName); + + return TRUE; +} + // ---------------------------------------------------------------------------- // delete groups/entries // ---------------------------------------------------------------------------- @@ -747,7 +746,7 @@ bool wxFileConfig::DeleteAll() // ---------------------------------------------------------------------------- // append a new line to the end of the list -wxFileConfig::LineList *wxFileConfig::LineListAppend(const wxString& str) +LineList *wxFileConfig::LineListAppend(const wxString& str) { LineList *pLine = new LineList(str); @@ -766,7 +765,7 @@ wxFileConfig::LineList *wxFileConfig::LineListAppend(const wxString& str) } // insert a new line after the given one or in the very beginning if !pLine -wxFileConfig::LineList *wxFileConfig::LineListInsert(const wxString& str, +LineList *wxFileConfig::LineListInsert(const wxString& str, LineList *pLine) { if ( pLine == m_linesTail ) @@ -805,7 +804,7 @@ void wxFileConfig::LineListRemove(LineList *pLine) // last entry? if ( pNext == NULL ) m_linesTail = pPrev; - else + else pNext->SetPrev(pPrev); delete pLine; @@ -825,7 +824,7 @@ bool wxFileConfig::LineListIsEmpty() // ---------------------------------------------------------------------------- // ctor -wxFileConfig::ConfigGroup::ConfigGroup(wxFileConfig::ConfigGroup *pParent, +ConfigGroup::ConfigGroup(ConfigGroup *pParent, const wxString& strName, wxFileConfig *pConfig) : m_aEntries(CompareEntries), @@ -842,7 +841,7 @@ wxFileConfig::ConfigGroup::ConfigGroup(wxFileConfig::ConfigGroup *pParent, } // dtor deletes all children -wxFileConfig::ConfigGroup::~ConfigGroup() +ConfigGroup::~ConfigGroup() { // entries size_t n, nCount = m_aEntries.Count(); @@ -859,7 +858,7 @@ wxFileConfig::ConfigGroup::~ConfigGroup() // line // ---------------------------------------------------------------------------- -void wxFileConfig::ConfigGroup::SetLine(LineList *pLine) +void ConfigGroup::SetLine(LineList *pLine) { wxASSERT( m_pLine == NULL ); // shouldn't be called twice @@ -895,12 +894,12 @@ void wxFileConfig::ConfigGroup::SetLine(LineList *pLine) backwards in the config file (OTOH, it's not that important) and as we would still need to do it for the subgroups the code wouldn't have been significantly less complicated. - */ +*/ // 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. -wxFileConfig::LineList *wxFileConfig::ConfigGroup::GetGroupLine() +LineList *ConfigGroup::GetGroupLine() { if ( m_pLine == NULL ) { ConfigGroup *pParent = Parent(); @@ -908,7 +907,7 @@ wxFileConfig::LineList *wxFileConfig::ConfigGroup::GetGroupLine() // this group wasn't present in local config file, add it now if ( pParent != NULL ) { wxString strFullName; - strFullName << "[" << GetFullName().c_str() + 1 << "]"; // +1: no '/' + strFullName << "[" << (GetFullName().c_str() + 1) << "]"; // +1: no '/' m_pLine = m_pConfig->LineListInsert(strFullName, pParent->GetLastGroupLine()); pParent->SetLastGroup(this); // we're surely after all the others @@ -925,12 +924,12 @@ wxFileConfig::LineList *wxFileConfig::ConfigGroup::GetGroupLine() // Return the last line belonging to the subgroups of this group (after which // we can add a new subgroup), if we don't have any subgroups or entries our // last line is the group line (m_pLine) itself. -wxFileConfig::LineList *wxFileConfig::ConfigGroup::GetLastGroupLine() +LineList *ConfigGroup::GetLastGroupLine() { // if we have any subgroups, our last line is the last line of the last // subgroup if ( m_pLastGroup != NULL ) { - wxFileConfig::LineList *pLine = m_pLastGroup->GetLastGroupLine(); + LineList *pLine = m_pLastGroup->GetLastGroupLine(); wxASSERT( pLine != NULL ); // last group must have !NULL associated line return pLine; @@ -943,10 +942,10 @@ wxFileConfig::LineList *wxFileConfig::ConfigGroup::GetLastGroupLine() // return the last line belonging to the entries of this group (after which // we can add a new entry), if we don't have any entries we will add the new // one immediately after the group line itself. -wxFileConfig::LineList *wxFileConfig::ConfigGroup::GetLastEntryLine() +LineList *ConfigGroup::GetLastEntryLine() { if ( m_pLastEntry != NULL ) { - wxFileConfig::LineList *pLine = m_pLastEntry->GetLine(); + LineList *pLine = m_pLastEntry->GetLine(); wxASSERT( pLine != NULL ); // last entry must have !NULL associated line return pLine; @@ -960,7 +959,19 @@ wxFileConfig::LineList *wxFileConfig::ConfigGroup::GetLastEntryLine() // group name // ---------------------------------------------------------------------------- -wxString wxFileConfig::ConfigGroup::GetFullName() const +void ConfigGroup::Rename(const wxString& newName) +{ + m_strName = newName; + + LineList *line = GetGroupLine(); + wxString strFullName; + strFullName << "[" << (GetFullName().c_str() + 1) << "]"; // +1: no '/' + line->SetText(strFullName); + + SetDirty(); +} + +wxString ConfigGroup::GetFullName() const { if ( Parent() ) return Parent()->GetFullName() + wxCONFIG_PATH_SEPARATOR + Name(); @@ -973,14 +984,14 @@ wxString wxFileConfig::ConfigGroup::GetFullName() const // ---------------------------------------------------------------------------- // use binary search because the array is sorted -wxFileConfig::ConfigEntry * -wxFileConfig::ConfigGroup::FindEntry(const char *szName) const +ConfigEntry * +ConfigGroup::FindEntry(const char *szName) const { size_t i, lo = 0, hi = m_aEntries.Count(); int res; - wxFileConfig::ConfigEntry *pEntry; + ConfigEntry *pEntry; while ( lo < hi ) { i = (lo + hi)/2; @@ -1003,14 +1014,14 @@ wxFileConfig::ConfigGroup::FindEntry(const char *szName) const return NULL; } -wxFileConfig::ConfigGroup * -wxFileConfig::ConfigGroup::FindSubgroup(const char *szName) const +ConfigGroup * +ConfigGroup::FindSubgroup(const char *szName) const { size_t i, lo = 0, hi = m_aSubgroups.Count(); int res; - wxFileConfig::ConfigGroup *pGroup; + ConfigGroup *pGroup; while ( lo < hi ) { i = (lo + hi)/2; @@ -1038,8 +1049,8 @@ wxFileConfig::ConfigGroup::FindSubgroup(const char *szName) const // ---------------------------------------------------------------------------- // create a new entry and add it to the current group -wxFileConfig::ConfigEntry * -wxFileConfig::ConfigGroup::AddEntry(const wxString& strName, int nLine) +ConfigEntry * +ConfigGroup::AddEntry(const wxString& strName, int nLine) { wxASSERT( FindEntry(strName) == NULL ); @@ -1050,8 +1061,8 @@ wxFileConfig::ConfigGroup::AddEntry(const wxString& strName, int nLine) } // create a new group and add it to the current group -wxFileConfig::ConfigGroup * -wxFileConfig::ConfigGroup::AddSubgroup(const wxString& strName) +ConfigGroup * +ConfigGroup::AddSubgroup(const wxString& strName) { wxASSERT( FindSubgroup(strName) == NULL ); @@ -1072,7 +1083,7 @@ wxFileConfig::ConfigGroup::AddSubgroup(const wxString& strName) delete several of them. */ -bool wxFileConfig::ConfigGroup::DeleteSubgroupByName(const char *szName) +bool ConfigGroup::DeleteSubgroupByName(const char *szName) { return DeleteSubgroup(FindSubgroup(szName)); } @@ -1080,7 +1091,7 @@ bool wxFileConfig::ConfigGroup::DeleteSubgroupByName(const char *szName) // doesn't delete the subgroup itself, but does remove references to it from // all other data structures (and normally the returned pointer should be // deleted a.s.a.p. because there is nothing much to be done with it anyhow) -bool wxFileConfig::ConfigGroup::DeleteSubgroup(ConfigGroup *pGroup) +bool ConfigGroup::DeleteSubgroup(ConfigGroup *pGroup) { wxCHECK( pGroup != NULL, FALSE ); // deleting non existing group? @@ -1144,7 +1155,7 @@ bool wxFileConfig::ConfigGroup::DeleteSubgroup(ConfigGroup *pGroup) return TRUE; } -bool wxFileConfig::ConfigGroup::DeleteEntry(const char *szName) +bool ConfigGroup::DeleteEntry(const char *szName) { ConfigEntry *pEntry = FindEntry(szName); wxCHECK( pEntry != NULL, FALSE ); // deleting non existing item? @@ -1197,7 +1208,7 @@ bool wxFileConfig::ConfigGroup::DeleteEntry(const char *szName) // ---------------------------------------------------------------------------- // // ---------------------------------------------------------------------------- -void wxFileConfig::ConfigGroup::SetDirty() +void ConfigGroup::SetDirty() { m_bDirty = TRUE; if ( Parent() != NULL ) // propagate upwards @@ -1211,7 +1222,7 @@ void wxFileConfig::ConfigGroup::SetDirty() // ---------------------------------------------------------------------------- // ctor // ---------------------------------------------------------------------------- -wxFileConfig::ConfigEntry::ConfigEntry(wxFileConfig::ConfigGroup *pParent, +ConfigEntry::ConfigEntry(ConfigGroup *pParent, const wxString& strName, int nLine) : m_strName(strName) @@ -1233,7 +1244,7 @@ wxFileConfig::ConfigEntry::ConfigEntry(wxFileConfig::ConfigGroup *pParent, // set value // ---------------------------------------------------------------------------- -void wxFileConfig::ConfigEntry::SetLine(LineList *pLine) +void ConfigEntry::SetLine(LineList *pLine) { if ( m_pLine != NULL ) { wxLogWarning(_("entry '%s' appears more than once in group '%s'"), @@ -1246,7 +1257,7 @@ void wxFileConfig::ConfigEntry::SetLine(LineList *pLine) // second parameter is FALSE if we read the value from file and prevents the // entry from being marked as 'dirty' -void wxFileConfig::ConfigEntry::SetValue(const wxString& strValue, bool bUser) +void ConfigEntry::SetValue(const wxString& strValue, bool bUser) { if ( bUser && IsImmutable() ) { wxLogWarning(_("attempt to change immutable key '%s' ignored."), @@ -1271,7 +1282,7 @@ void wxFileConfig::ConfigEntry::SetValue(const wxString& strValue, bool bUser) } else { // add a new line to the file - wxASSERT( m_nLine == NOT_FOUND ); // consistency check + wxASSERT( m_nLine == wxNOT_FOUND ); // consistency check m_pLine = Group()->Config()->LineListInsert(strLine, Group()->GetLastEntryLine()); @@ -1282,7 +1293,7 @@ void wxFileConfig::ConfigEntry::SetValue(const wxString& strValue, bool bUser) } } -void wxFileConfig::ConfigEntry::SetDirty() +void ConfigEntry::SetDirty() { m_bDirty = TRUE; Group()->SetDirty(); @@ -1296,8 +1307,8 @@ void wxFileConfig::ConfigEntry::SetDirty() // compare functions for array sorting // ---------------------------------------------------------------------------- -int CompareEntries(wxFileConfig::ConfigEntry *p1, - wxFileConfig::ConfigEntry *p2) +int CompareEntries(ConfigEntry *p1, + ConfigEntry *p2) { #if wxCONFIG_CASE_SENSITIVE return strcmp(p1->Name(), p2->Name()); @@ -1306,8 +1317,8 @@ int CompareEntries(wxFileConfig::ConfigEntry *p1, #endif } -int CompareGroups(wxFileConfig::ConfigGroup *p1, - wxFileConfig::ConfigGroup *p2) +int CompareGroups(ConfigGroup *p1, + ConfigGroup *p2) { #if wxCONFIG_CASE_SENSITIVE return strcmp(p1->Name(), p2->Name()); @@ -1371,7 +1382,7 @@ wxString FilterOut(const wxString& str) { if(str.IsEmpty()) return str; - + wxString strResult; strResult.Alloc(str.Len()); @@ -1421,3 +1432,10 @@ wxString FilterOut(const wxString& str) return strResult; } + + + + + + +