///////////////////////////////////////////////////////////////////////////////
-// Name: fileconf.cpp
+// Name: src/common/fileconf.cpp
// Purpose: implementation of wxFileConfig derivation of wxConfig
// Author: Vadim Zeitlin
// Modified by:
// Created: 07.04.98 (adapted from appconf.cpp)
// RCS-ID: $Id$
-// Copyright: (c) 1997 Karsten Ballüder & Vadim Zeitlin
+// Copyright: (c) 1997 Karsten Ballueder & Vadim Zeitlin
// Ballueder@usa.net <zeitlin@dptmaths.ens-cachan.fr>
-// Licence: wxWindows license
+// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
-#pragma implementation "fileconf.h"
-#endif
-
-// ============================================================================
-// declarations
-// ============================================================================
-
// ----------------------------------------------------------------------------
// 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/dynarray.h>
-#include <wx/file.h>
-#include <wx/log.h>
-#include <wx/textfile.h>
-#include <wx/config.h>
-#include <wx/fileconf.h>
-
-// _WINDOWS_ is defined when windows.h is included,
-// __WXMSW__ is defined for MS Windows compilation
-#if defined(__WXMSW__) && !defined(_WINDOWS_)
- #include <windows.h>
+#include "wx/file.h"
+#include "wx/textfile.h"
+#include "wx/memtext.h"
+#include "wx/config.h"
+#include "wx/fileconf.h"
+#include "wx/filefn.h"
+
+#include "wx/base64.h"
+
+#include "wx/stdpaths.h"
+
+#if defined(__WXMSW__)
+ #include "wx/msw/private.h"
#endif //windows.h
+#if defined(__WXPM__)
+ #define INCL_DOS
+ #include <os2.h>
+#endif
#include <stdlib.h>
#include <ctype.h>
+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
+#ifndef MAX_PATH
+ #define MAX_PATH 512
+#endif
+
+#define FILECONF_TRACE_MASK wxT("fileconf")
+
// ----------------------------------------------------------------------------
// global functions declarations
// ----------------------------------------------------------------------------
-// is 'c' a valid character in group name?
-// NB: APPCONF_IMMUTABLE_PREFIX and APPCONF_PATH_SEPARATOR must be valid chars,
-// but _not_ ']' (group name delimiter)
-inline bool IsValid(char c) { return isalnum(c) || strchr("@_/-!.*%", c); }
+// compare functions for sorting the arrays
+static int LINKAGEMODE CompareEntries(wxFileConfigEntry *p1, wxFileConfigEntry *p2);
+static int LINKAGEMODE CompareGroups(wxFileConfigGroup *p1, wxFileConfigGroup *p2);
// filter strings
-static wxString FilterIn(const wxString& str);
-static wxString FilterOut(const wxString& str);
+static wxString FilterInValue(const wxString& str);
+static wxString FilterOutValue(const wxString& str);
+
+static wxString FilterInEntryName(const wxString& str);
+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
+
+ wxDECLARE_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 overridden 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);
+
+ wxDECLARE_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 wxString& name) const;
+ wxFileConfigEntry *FindEntry (const wxString& name) const;
+
+ // 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);
+
+ 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]
+ // may be NULL for "/" only
+ 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; }
+
+ wxDECLARE_NO_COPY_CLASS(wxFileConfigGroup);
+};
// ============================================================================
// implementation
// ----------------------------------------------------------------------------
// static functions
// ----------------------------------------------------------------------------
-wxString wxFileConfig::GetGlobalFileName(const char *szFile)
+
+// 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)
{
- wxString str;
+ if ( !fn.HasExt() )
+ {
+#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
+ }
+}
- bool bNoExt = strchr(szFile, '.') == NULL;
+wxString wxFileConfig::GetGlobalDir()
+{
+ return wxStandardPaths::Get().GetConfigDir();
+}
- #ifdef __UNIX__
- str << "/etc/" << szFile;
- if ( bNoExt )
- str << ".conf";
- #else // Windows
- #ifndef _MAX_PATH
- #define _MAX_PATH 512
- #endif
+wxString wxFileConfig::GetLocalDir(int style)
+{
+ wxUnusedVar(style);
- char szWinDir[_MAX_PATH];
- ::GetWindowsDirectory(szWinDir, _MAX_PATH);
- str << szWinDir << "\\" << szFile;
- if ( bNoExt )
- str << ".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 char *szFile)
+wxFileName wxFileConfig::GetGlobalFile(const wxString& szFile)
{
- wxString str;
+ wxFileName fn(GetGlobalDir(), szFile);
- #ifdef __UNIX__
- const char *szHome = getenv("HOME");
- if ( szHome == NULL ) {
- // we're homeless...
- wxLogWarning("can't find user's HOME, using current directory.");
- szHome = ".";
+ AddConfFileExtIfNeeded(fn);
+
+ return fn;
+}
+
+wxFileName wxFileConfig::GetLocalFile(const wxString& szFile, int style)
+{
+ wxFileName fn(GetLocalDir(style), szFile);
+
+#if defined( __UNIX__ ) && !defined( __WXMAC__ )
+ 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());
}
- str << szHome << "/." << szFile;
- #else // Windows
- #ifdef __WIN32__
- const char *szHome = getenv("HOMEDRIVE");
- if ( szHome != NULL )
- str << szHome;
- szHome = getenv("HOMEPATH");
- if ( szHome != NULL )
- str << szHome;
- str << szFile;
- if ( strchr(szFile, '.') == NULL )
- str << ".ini";
- #else // Win16
- // Win16 has no idea about home, so use the current directory instead
- str << ".\\" << szFile;
- #endif // WIN16/32
- #endif // UNIX/Win
-
- return str;
+ else // we do append ".conf" extension to config files in subdirectories
+#endif // defined( __UNIX__ ) && !defined( __WXMAC__ )
+ {
+ AddConfFileExtIfNeeded(fn);
+ }
+
+ return fn;
}
// ----------------------------------------------------------------------------
// ctor
// ----------------------------------------------------------------------------
+IMPLEMENT_ABSTRACT_CLASS(wxFileConfig, wxConfigBase)
void wxFileConfig::Init()
{
- m_pCurrentGroup =
- m_pRootGroup = new ConfigGroup(NULL, "", this);
+ m_pCurrentGroup =
+ m_pRootGroup = new wxFileConfigGroup(NULL, wxEmptyString, 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.
- m_bExpandEnvVars = TRUE;
+ // parse the global file
+ if ( m_fnGlobalFile.IsOk() && m_fnGlobalFile.FileExists() )
+ {
+ wxTextFile fileGlobal(m_fnGlobalFile.GetFullPath());
- m_strPath.Empty();
+ if ( fileGlobal.Open(*m_conv/*ignored in ANSI build*/) )
+ {
+ Parse(fileGlobal, false /* global */);
+ SetRootPath();
+ }
+ else
+ {
+ wxLogWarning(_("can't open global configuration file '%s'."), m_fnGlobalFile.GetFullPath().c_str());
+ }
+ }
+
+ // parse the local file
+ if ( m_fnLocalFile.IsOk() && m_fnLocalFile.FileExists() )
+ {
+ wxTextFile fileLocal(m_fnLocalFile.GetFullPath());
+ if ( fileLocal.Open(*m_conv/*ignored in ANSI build*/) )
+ {
+ Parse(fileLocal, true /* local */);
+ SetRootPath();
+ }
+ else
+ {
+ const wxString path = m_fnLocalFile.GetFullPath();
+ wxLogWarning(_("can't open user configuration file '%s'."),
+ path.c_str());
+
+ if ( m_fnLocalFile.FileExists() )
+ {
+ wxLogWarning(_("Changes won't be saved to avoid overwriting the existing file \"%s\""),
+ path.c_str());
+ m_fnLocalFile.Clear();
+ }
+ }
+ }
+
+ m_isDirty = false;
}
-wxFileConfig::wxFileConfig(const wxString& strLocal, const wxString& strGlobal)
- : m_strLocalFile(strLocal), m_strGlobalFile(strGlobal)
+// 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 wxMBConv& conv)
+ : wxConfigBase(::GetAppName(appName), vendorName,
+ strLocal, strGlobal,
+ style),
+ m_fnLocalFile(strLocal),
+ m_fnGlobalFile(strGlobal),
+ m_conv(conv.Clone())
{
- Init();
+ // Make up names for files if empty
+ if ( !m_fnLocalFile.IsOk() && (style & wxCONFIG_USE_LOCAL_FILE) )
+ m_fnLocalFile = GetLocalFile(GetAppName(), style);
+
+ 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_fnLocalFile.IsOk() )
+ SetStyle(GetStyle() | wxCONFIG_USE_LOCAL_FILE);
+
+ if ( m_fnGlobalFile.IsOk() )
+ SetStyle(GetStyle() | wxCONFIG_USE_GLOBAL_FILE);
+
+ // if the path is not absolute, prepend the standard directory to it
+ // unless explicitly asked not to
+ if ( !(style & wxCONFIG_USE_RELATIVE_PATH) )
+ {
+ if ( m_fnLocalFile.IsOk() )
+ m_fnLocalFile.MakeAbsolute(GetLocalDir(style));
+
+ if ( m_fnGlobalFile.IsOk() )
+ m_fnGlobalFile.MakeAbsolute(GetGlobalDir());
+ }
- // it's not an error if (one of the) file(s) doesn't exist
+ SetUmask(-1);
- // parse the global file
- if ( !strGlobal.IsEmpty() ) {
- if ( wxFile::Exists(strGlobal) ) {
- wxTextFile fileGlobal(strGlobal);
+ Init();
+}
- if ( fileGlobal.Open() ) {
- Parse(fileGlobal, FALSE /* global */);
- SetRootPath();
- }
- else
- wxLogWarning("Can't open global configuration file '%s'.",
- strGlobal.c_str());
+#if wxUSE_STREAMS
+
+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, wxEmptyString, this);
+
+ m_linesHead =
+ m_linesTail = NULL;
+
+ // read the entire stream contents in memory
+ wxWxCharBuffer cbuf;
+ static const size_t chunkLen = 1024;
+
+ wxMemoryBuffer buf(chunkLen);
+ do
+ {
+ inStream.Read(buf.GetAppendBuf(chunkLen), chunkLen);
+ buf.UngetAppendBuf(inStream.LastRead());
+
+ const wxStreamError err = inStream.GetLastError();
+
+ if ( err != wxSTREAM_NO_ERROR && err != wxSTREAM_EOF )
+ {
+ wxLogError(_("Error reading config options."));
+ break;
+ }
}
- }
+ while ( !inStream.Eof() );
+
+#if wxUSE_UNICODE
+ size_t len;
+ cbuf = conv.cMB2WC((char *)buf.GetData(), buf.GetDataLen() + 1, &len);
+ if ( !len && buf.GetDataLen() )
+ {
+ wxLogError(_("Failed to read config options."));
+ }
+#else // !wxUSE_UNICODE
+ // no need for conversion
+ cbuf = wxCharBuffer::CreateNonOwned((char *)buf.GetData(), buf.GetDataLen());
+#endif // wxUSE_UNICODE/!wxUSE_UNICODE
+
+ // parse the input contents if there is anything to parse
+ if ( cbuf )
+ {
+ // now break it into lines
+ wxMemoryText memText;
+ for ( const wxChar *s = cbuf; ; ++s )
+ {
+ const wxChar *e = s;
+ while ( *e != '\0' && *e != '\n' && *e != '\r' )
+ ++e;
+
+ // notice that we throw away the original EOL kind here, maybe we
+ // should preserve it?
+ if ( e != s )
+ memText.AddLine(wxString(s, e));
+
+ if ( *e == '\0' )
+ break;
+
+ // skip the second EOL byte if it's a DOS one
+ if ( *e == '\r' && e[1] == '\n' )
+ ++e;
+
+ s = e;
+ }
- // parse the local file
- if ( wxFile::Exists(strLocal) ) {
- wxTextFile fileLocal(strLocal);
- if ( fileLocal.Open() ) {
- Parse(fileLocal, TRUE /* local */);
- SetRootPath();
+ // Finally we can parse it all.
+ Parse(memText, true /* local */);
+ }
+
+ SetRootPath();
+ ResetDirty();
+}
+
+#endif // wxUSE_STREAMS
+
+void wxFileConfig::CleanUp()
+{
+ delete m_pRootGroup;
+
+ wxFileConfigLineList *pCur = m_linesHead;
+ while ( pCur != NULL ) {
+ wxFileConfigLineList *pNext = pCur->Next();
+ delete pCur;
+ pCur = pNext;
}
- else
- wxLogWarning("Can't open user configuration file '%s'.",
- strLocal.c_str());
- }
}
wxFileConfig::~wxFileConfig()
{
- Flush();
- delete m_pRootGroup;
+ Flush();
+
+ CleanUp();
+
+ delete m_conv;
}
// ----------------------------------------------------------------------------
// parse a config file
// ----------------------------------------------------------------------------
-void wxFileConfig::Parse(wxTextFile& file, bool bLocal)
+void wxFileConfig::Parse(const wxTextBuffer& buffer, bool bLocal)
{
- const char *pStart;
- const char *pEnd;
- for ( uint n = 0; n < file.GetLineCount(); n++ ) {
+ size_t nLineCount = buffer.GetLineCount();
+
+ for ( size_t n = 0; n < nLineCount; 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(file[n]);
+ LineListAppend(strLine);
+
// skip leading spaces
- for ( pStart = file[n]; isspace(*pStart); pStart++ )
+ for ( pStart = buf; wxIsspace(*pStart); pStart++ )
;
// skip blank/comment lines
- if ( *pStart == '\0'|| *pStart == ';' || *pStart == '#' )
+ if ( *pStart == wxT('\0')|| *pStart == wxT(';') || *pStart == wxT('#') )
continue;
- if ( *pStart == '[' ) { // a new group
+ if ( *pStart == wxT('[') ) { // a new group
pEnd = pStart;
- while ( *++pEnd != ']' ) {
- if ( !IsValid(*pEnd) && *pEnd != ' ' ) // allow spaces in group names
- break;
+ 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 != ']' ) {
- wxLogError("file '%s': unexpected character at line %d (missing ']'?)",
- file.GetName(), n + 1);
+ if ( *pEnd != wxT(']') ) {
+ wxLogError(_("file '%s': unexpected character %c at line %d."),
+ buffer.GetName(), *pEnd, n + 1);
continue; // skip this line
}
// group name here is always considered as abs path
wxString strGroup;
pStart++;
- strGroup << APPCONF_PATH_SEPARATOR << wxString(pStart, pEnd - pStart);
+ strGroup << wxCONFIG_PATH_SEPARATOR
+ << FilterInEntryName(wxString(pStart, pEnd - pStart));
// will create it if doesn't yet exist
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 != '\0' && bCont ) {
+ bool bCont = true;
+ while ( *++pEnd != wxT('\0') && bCont ) {
switch ( *pEnd ) {
- case '#':
- case ';':
- bCont = FALSE;
+ case wxT('#'):
+ case wxT(';'):
+ bCont = false;
break;
- case ' ':
- case '\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 char *pEnd = pStart;
- while ( IsValid(*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)
+ pEnd++;
+ if ( !*pEnd ) {
+ // the error message will be given below anyhow
+ break;
+ }
+ }
+
pEnd++;
+ }
- wxString strKey(pStart, pEnd);
+ wxString strKey(FilterInEntryName(wxString(pStart, pEnd).Trim()));
// skip whitespace
- while ( isspace(*pEnd) )
+ while ( wxIsspace(*pEnd) )
pEnd++;
- if ( *pEnd++ != '=' ) {
- wxLogError("file '%s', line %d: '=' expected.", file.GetName(), n + 1);
+ if ( *pEnd++ != wxT('=') ) {
+ wxLogError(_("file '%s', line %d: '=' expected."),
+ 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):
// (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(), (int)n + 1, strKey.c_str(), pEntry->Line());
- if ( bLocal )
- pEntry->SetLine(m_linesTail);
}
}
+ if ( bLocal )
+ pEntry->SetLine(m_linesTail);
+
// skip whitespace
- while ( isspace(*pEnd) )
+ while ( wxIsspace(*pEnd) )
pEnd++;
- wxString strValue;
- if (m_bExpandEnvVars)
- strValue = ExpandEnvVars(FilterIn(pEnd));
- else
- strValue = FilterIn(pEnd);
- pEntry->SetValue(strValue, FALSE);
+ wxString value = pEnd;
+ if ( !(GetStyle() & wxCONFIG_USE_NO_ESCAPE_CHARACTERS) )
+ value = FilterInValue(value);
+
+ pEntry->SetValue(value, false);
}
}
}
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] == APPCONF_PATH_SEPARATOR ) {
- // absolute path
- SplitPath(aParts, strPath);
- }
- else {
- // relative path, combine with current one
- wxString strFullPath = m_strPath;
- strFullPath << APPCONF_PATH_SEPARATOR << strPath;
- SplitPath(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
- uint n;
- m_pCurrentGroup = m_pRootGroup;
- for ( n = 0; n < aParts.Count(); n++ ) {
- ConfigGroup *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;
+
+ pNextGroup = m_pCurrentGroup->AddSubgroup(aParts[n]);
+ }
- // recombine path parts in one variable
- m_strPath.Empty();
- for ( n = 0; n < aParts.Count(); n++ ) {
- m_strPath << APPCONF_PATH_SEPARATOR << 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 */);
+}
+
+const wxString& wxFileConfig::GetPath() const
+{
+ return m_strPath;
}
// ----------------------------------------------------------------------------
// enumeration
// ----------------------------------------------------------------------------
-bool wxFileConfig::GetFirstGroup(wxString& str, long& lIndex)
+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)
+bool wxFileConfig::GetNextGroup (wxString& str, long& lIndex) const
{
- if ( uint(lIndex) < m_pCurrentGroup->Groups().Count() ) {
- str = m_pCurrentGroup->Groups()[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)
+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)
+bool wxFileConfig::GetNextEntry (wxString& str, long& lIndex) const
{
- if ( uint(lIndex) < m_pCurrentGroup->Entries().Count() ) {
- str = m_pCurrentGroup->Entries()[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().GetCount();
+ if ( bRecursive ) {
+ wxFileConfig * const self = const_cast<wxFileConfig *>(this);
+
+ wxFileConfigGroup *pOldCurrentGroup = m_pCurrentGroup;
+ size_t nSubgroups = m_pCurrentGroup->Groups().GetCount();
+ for ( size_t nGroup = 0; nGroup < nSubgroups; nGroup++ ) {
+ self->m_pCurrentGroup = m_pCurrentGroup->Groups()[nGroup];
+ n += GetNumberOfEntries(true);
+ self->m_pCurrentGroup = pOldCurrentGroup;
+ }
+ }
+
+ return n;
+}
+
+size_t wxFileConfig::GetNumberOfGroups(bool bRecursive) const
+{
+ size_t n = m_pCurrentGroup->Groups().GetCount();
+ if ( bRecursive ) {
+ wxFileConfig * const self = const_cast<wxFileConfig *>(this);
+
+ wxFileConfigGroup *pOldCurrentGroup = m_pCurrentGroup;
+ size_t nSubgroups = m_pCurrentGroup->Groups().GetCount();
+ for ( size_t nGroup = 0; nGroup < nSubgroups; nGroup++ ) {
+ self->m_pCurrentGroup = m_pCurrentGroup->Groups()[nGroup];
+ n += GetNumberOfGroups(true);
+ self->m_pCurrentGroup = pOldCurrentGroup;
+ }
+ }
+
+ return n;
}
// ----------------------------------------------------------------------------
bool wxFileConfig::HasGroup(const wxString& strName) const
{
- PathChanger 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();
- ConfigGroup *pGroup = m_pCurrentGroup->FindSubgroup(path.Name());
- return pGroup != NULL;
+ wxFileConfig *self = const_cast<wxFileConfig *>(this);
+ const bool
+ rc = self->DoSetPath(strName, false /* don't create missing components */);
+
+ self->SetPath(pathOld);
+
+ return rc;
}
-bool wxFileConfig::HasEntry(const wxString& strName) const
+bool wxFileConfig::HasEntry(const wxString& entry) const
{
- PathChanger 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 = 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;
+ }
+ }
- ConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name());
- return pEntry != NULL;
+ // 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);
+ }
+
+ return exists;
}
// ----------------------------------------------------------------------------
// read/write values
// ----------------------------------------------------------------------------
-const char *wxFileConfig::Read(const char *szKey,
- const char *szDefault) const
+bool wxFileConfig::DoReadString(const wxString& key, wxString* pStr) const
{
- PathChanger path(this, szKey);
+ wxConfigPathChanger path(this, key);
- ConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name());
- return pEntry == NULL ? szDefault : pEntry->Value().c_str();
+ wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name());
+ if (pEntry == NULL) {
+ return false;
+ }
+
+ *pStr = pEntry->Value();
+
+ return true;
}
-bool wxFileConfig::Read(wxString *pstr,
- const char *szKey,
- const char *szDefault) const
+bool wxFileConfig::DoReadLong(const wxString& key, long *pl) const
{
- PathChanger path(this, szKey);
+ wxString str;
+ if ( !Read(key, &str) )
+ return false;
- ConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name());
- if (pEntry == NULL) {
- *pstr = szDefault;
- return FALSE;
- }
- else {
- *pstr = pEntry->Value();
- return TRUE;
- }
+ // extra spaces shouldn't prevent us from reading numeric values
+ str.Trim();
+
+ return str.ToLong(pl);
}
-bool wxFileConfig::Read(long *pl, const char *szKey, long lDefault) const
+#if wxUSE_BASE64
+
+bool wxFileConfig::DoReadBinary(const wxString& key, wxMemoryBuffer* buf) const
{
- wxString str;
- if ( Read(&str, szKey) ) {
- *pl = atol(str);
- return TRUE;
- }
- else {
- *pl = lDefault;
- return FALSE;
- }
+ wxCHECK_MSG( buf, false, wxT("NULL buffer") );
+
+ wxString str;
+ if ( !Read(key, &str) )
+ return false;
+
+ *buf = wxBase64Decode(str);
+ return true;
}
-bool wxFileConfig::Write(const char *szKey, const char *szValue)
+#endif // wxUSE_BASE64
+
+bool wxFileConfig::DoWriteString(const wxString& key, const wxString& szValue)
{
- PathChanger path(this, szKey);
+ wxConfigPathChanger path(this, key);
+ wxString strName = path.Name();
+
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" Writing String '%s' = '%s' to Group '%s'"),
+ strName.c_str(),
+ szValue.c_str(),
+ GetPath().c_str() );
+
+ if ( strName.empty() )
+ {
+ // setting the value of a group is an error
+
+ 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( FILECONF_TRACE_MASK,
+ wxT(" Creating group %s"),
+ m_pCurrentGroup->Name().c_str() );
+
+ SetDirty();
+
+ // this will add a line for this group if it didn't have it before (or
+ // do nothing for the root but it's ok as it always exists anyhow)
+ (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;
+ }
+
+ wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(strName);
+
+ if ( pEntry == 0 )
+ {
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" Adding Entry %s"),
+ strName.c_str() );
+ pEntry = m_pCurrentGroup->AddEntry(strName);
+ }
+
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" Setting value %s"),
+ szValue.c_str() );
+ pEntry->SetValue(szValue);
- ConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name());
- if ( pEntry == NULL )
- pEntry = m_pCurrentGroup->AddEntry(path.Name());
- pEntry->SetValue(szValue);
+ SetDirty();
+ }
- return TRUE;
+ return true;
}
-bool wxFileConfig::Write(const char *szKey, long lValue)
+bool wxFileConfig::DoWriteLong(const wxString& key, long lValue)
+{
+ return Write(key, wxString::Format(wxT("%ld"), lValue));
+}
+
+#if wxUSE_BASE64
+
+bool wxFileConfig::DoWriteBinary(const wxString& key, const wxMemoryBuffer& buf)
{
- // ltoa() is not ANSI :-(
- char szBuf[40]; // should be good for sizeof(long) <= 16 (128 bits)
- sprintf(szBuf, "%ld", lValue);
- return Write(szKey, szBuf);
+ return Write(key, wxBase64Encode(buf));
}
+#endif // wxUSE_BASE64
+
bool wxFileConfig::Flush(bool /* bCurrentOnly */)
{
- if ( LineListIsEmpty() || !m_pRootGroup->IsDirty() )
- return TRUE;
+ if ( !IsDirty() || !m_fnLocalFile.GetFullPath() )
+ return true;
+
+ // set the umask if needed
+ 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;
+ if ( !file.IsOpened() )
+ {
+ wxLogError(_("can't open user configuration file."));
+ return false;
}
// write all strings to file
- for ( LineList *p = m_linesHead; p != NULL; p = p->Next() ) {
- if ( !file.Write(p->Text() + wxTextFile::GetEOL()) ) {
- wxLogError("Can't write user configuration file.");
- return FALSE;
- }
+ wxString filetext;
+ filetext.reserve(4096);
+ for ( wxFileConfigLineList *p = m_linesHead; p != NULL; p = p->Next() )
+ {
+ filetext << p->Text() << wxTextFile::GetEOL();
+ }
+
+ if ( !file.Write(filetext, *m_conv) )
+ {
+ wxLogError(_("can't write user configuration file."));
+ return false;
+ }
+
+ if ( !file.Commit() )
+ {
+ wxLogError(_("Failed to update user configuration file."));
+
+ return false;
}
- return file.Commit();
+ ResetDirty();
+
+#if defined( __WXOSX_MAC__ ) && wxOSX_USE_CARBON
+ 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
+// ----------------------------------------------------------------------------
+
+bool wxFileConfig::RenameEntry(const wxString& oldName,
+ const wxString& newName)
+{
+ wxASSERT_MSG( oldName.find(wxCONFIG_PATH_SEPARATOR) == wxString::npos,
+ wxT("RenameEntry(): paths are not supported") );
+
+ // check that the entry exists
+ wxFileConfigEntry *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;
+
+ SetDirty();
+
+ wxFileConfigEntry *newEntry = m_pCurrentGroup->AddEntry(newName);
+ newEntry->SetValue(value);
+
+ return true;
+}
+
+bool wxFileConfig::RenameGroup(const wxString& oldName,
+ const wxString& newName)
+{
+ // check that the group exists
+ wxFileConfigGroup *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);
+
+ SetDirty();
+
+ return true;
}
// ----------------------------------------------------------------------------
// delete groups/entries
// ----------------------------------------------------------------------------
-bool wxFileConfig::DeleteEntry(const char *szKey, bool bGroupIfEmptyAlso)
+bool wxFileConfig::DeleteEntry(const wxString& key, bool bGroupIfEmptyAlso)
{
- PathChanger path(this, szKey);
+ 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 ) {
- ConfigGroup *pGroup = m_pCurrentGroup;
- SetPath(".."); // changes m_pCurrentGroup!
- m_pCurrentGroup->DeleteSubgroup(pGroup->Name());
+ wxFileConfigGroup *pGroup = m_pCurrentGroup;
+ SetPath(wxT("..")); // changes m_pCurrentGroup!
+ m_pCurrentGroup->DeleteSubgroupByName(pGroup->Name());
}
//else: never delete the root group
}
- return TRUE;
+ return true;
}
-bool wxFileConfig::DeleteGroup(const char *szKey)
+bool wxFileConfig::DeleteGroup(const wxString& key)
{
- PathChanger path(this, szKey);
+ wxConfigPathChanger path(this, RemoveTrailingSeparator(key));
- return m_pCurrentGroup->DeleteSubgroup(path.Name());
+ if ( !m_pCurrentGroup->DeleteSubgroupByName(path.Name()) )
+ return false;
+
+ path.UpdateIfDeleted();
+
+ SetDirty();
+
+ return true;
}
bool wxFileConfig::DeleteAll()
{
- const char *szFile = m_strLocalFile;
- delete m_pRootGroup;
- Init();
-
- if ( remove(szFile) == -1 )
- wxLogSysError("Can't delete user configuration file '%s'", szFile);
+ CleanUp();
+
+ if ( m_fnLocalFile.IsOk() )
+ {
+ if ( m_fnLocalFile.FileExists() &&
+ !wxRemoveFile(m_fnLocalFile.GetFullPath()) )
+ {
+ wxLogSysError(_("can't delete user configuration file '%s'"),
+ m_fnLocalFile.GetFullPath().c_str());
+ return false;
+ }
+ }
- szFile = m_strGlobalFile;
- if ( remove(szFile) )
- wxLogSysError("Can't delete system configuration file '%s'", szFile);
+ Init();
- return TRUE;
+ return true;
}
// ----------------------------------------------------------------------------
// linked list functions
// ----------------------------------------------------------------------------
-// append a new line to the end of the list
-wxFileConfig::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,
+ wxT(" ** Adding Line '%s'"),
+ str.c_str() );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" head: %s"),
+ ((m_linesHead) ? (const wxChar*)m_linesHead->Text().c_str()
+ : wxEmptyString) );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" tail: %s"),
+ ((m_linesTail) ? (const wxChar*)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,
+ wxT(" head: %s"),
+ ((m_linesHead) ? (const wxChar*)m_linesHead->Text().c_str()
+ : wxEmptyString) );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" tail: %s"),
+ ((m_linesTail) ? (const wxChar*)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
-wxFileConfig::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,
+ wxT(" ** Inserting Line '%s' after '%s'"),
+ str.c_str(),
+ ((pLine) ? (const wxChar*)pLine->Text().c_str()
+ : wxEmptyString) );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" head: %s"),
+ ((m_linesHead) ? (const wxChar*)m_linesHead->Text().c_str()
+ : wxEmptyString) );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" tail: %s"),
+ ((m_linesTail) ? (const wxChar*)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);
+ }
+
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" head: %s"),
+ ((m_linesHead) ? (const wxChar*)m_linesHead->Text().c_str()
+ : wxEmptyString) );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" tail: %s"),
+ ((m_linesTail) ? (const wxChar*)m_linesTail->Text().c_str()
+ : wxEmptyString) );
- return pNewLine;
+ return pNewLine;
}
-void wxFileConfig::LineListRemove(LineList *pLine)
+void wxFileConfig::LineListRemove(wxFileConfigLineList *pLine)
{
- LineList *pPrev = pLine->Prev(),
- *pNext = pLine->Next();
- if ( pPrev == NULL ) {
- // deleting the first entry
- m_linesHead = pNext;
- }
- else {
- // not the first entry
- pPrev->SetNext(pNext);
- }
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" ** Removing Line '%s'"),
+ pLine->Text().c_str() );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" head: %s"),
+ ((m_linesHead) ? (const wxChar*)m_linesHead->Text().c_str()
+ : wxEmptyString) );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" tail: %s"),
+ ((m_linesTail) ? (const wxChar*)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);
- pNext->SetPrev(pPrev);
+ // last entry?
- delete pLine;
+ if ( pNext == NULL )
+ m_linesTail = pPrev;
+ else
+ pNext->SetPrev(pPrev);
+
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" head: %s"),
+ ((m_linesHead) ? (const wxChar*)m_linesHead->Text().c_str()
+ : wxEmptyString) );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" tail: %s"),
+ ((m_linesTail) ? (const wxChar*)m_linesTail->Text().c_str()
+ : wxEmptyString) );
+
+ delete pLine;
}
bool wxFileConfig::LineListIsEmpty()
{
- return m_linesHead == NULL;
+ return m_linesHead == NULL;
}
// ============================================================================
-// wxFileConfig::ConfigGroup
+// wxFileConfig::wxFileConfigGroup
// ============================================================================
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
// ctor
-wxFileConfig::ConfigGroup::ConfigGroup(wxFileConfig::ConfigGroup *pParent,
+wxFileConfigGroup::wxFileConfigGroup(wxFileConfigGroup *pParent,
const wxString& strName,
wxFileConfig *pConfig)
- : m_strName(strName)
+ : m_aEntries(CompareEntries),
+ m_aSubgroups(CompareGroups),
+ m_strName(strName)
{
m_pConfig = pConfig;
m_pParent = pParent;
m_pLine = NULL;
- m_bDirty = FALSE;
+
m_pLastEntry = NULL;
m_pLastGroup = NULL;
}
// dtor deletes all children
-wxFileConfig::ConfigGroup::~ConfigGroup()
+wxFileConfigGroup::~wxFileConfigGroup()
{
// entries
- uint 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];
}
// line
// ----------------------------------------------------------------------------
-void wxFileConfig::ConfigGroup::SetLine(LineList *pLine)
+void wxFileConfigGroup::SetLine(wxFileConfigLineList *pLine)
{
- wxASSERT( m_pLine == NULL ); // 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,
+ wxT("changing line for a non-root group?") );
- m_pLine = pLine;
+ m_pLine = pLine;
}
-// return the line which contains "[our name]"
-wxFileConfig::LineList *wxFileConfig::ConfigGroup::GetGroupLine()
+/*
+ This is a bit complicated, so let me explain it in details. All lines that
+ were read from the local file (the only one we will ever modify) are stored
+ in a (doubly) linked list. Our problem is to know at which position in this
+ list should we insert the new entries/subgroups. To solve it we keep three
+ variables for each group: m_pLine, m_pLastEntry and m_pLastGroup.
+
+ m_pLine points to the line containing "[group_name]"
+ m_pLastEntry points to the last entry of this group in the local file.
+ m_pLastGroup subgroup
+
+ Initially, they're NULL all three. When the group (an entry/subgroup) is read
+ from the local file, the corresponding variable is set. However, if the group
+ was read from the global file and then modified or created by the application
+ these variables are still NULL and we need to create the corresponding lines.
+ See the following functions (and comments preceding them) for the details of
+ how we do it.
+
+ Also, when our last entry/group are deleted we need to find the new last
+ element - the code in DeleteEntry/Subgroup does this by backtracking the list
+ of lines until it either founds an entry/subgroup (and this is the new last
+ element) or the m_pLine of the group, in which case there are no more entries
+ (or subgroups) left and m_pLast<element> becomes NULL.
+
+ NB: This last problem could be avoided for entries if we added new entries
+ immediately after m_pLine, but in this case the entries would appear
+ 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.
+wxFileConfigLineList *wxFileConfigGroup::GetGroupLine()
{
- if ( m_pLine == NULL ) {
- // this group wasn't present in local config file, add it now
- if ( Parent() != NULL ) {
- wxString strFullName;
- strFullName << "[" << GetFullName().c_str() + 1 << "]"; // +1: no '/'
- m_pLine = m_pConfig->LineListInsert(strFullName,
- Parent()->GetLastGroupLine());
- Parent()->SetLastGroup(this);
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" GetGroupLine() for Group '%s'"),
+ Name().c_str() );
+
+ if ( !m_pLine )
+ {
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" 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,
+ wxT(" 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
}
- else {
- // we return NULL, so that LineListInsert() will insert us in the
- // very beginning
+
+ 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.
+wxFileConfigLineList *wxFileConfigGroup::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_MSG( pLine, wxT("last group must have !NULL associated line") );
+
+ return pLine;
}
- }
- return m_pLine;
+ // no subgroups, so the last line is the line of thelast entry (if any)
+ return GetLastEntryLine();
}
-// return the last line belonging to the subgroups of this group
-// (after which we can add a new subgroup)
-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.
+wxFileConfigLineList *wxFileConfigGroup::GetLastEntryLine()
{
- // if we have any subgroups, our last line is the last line of the last
- // subgroup
- if ( m_pLastGroup != NULL )
- return m_pLastGroup->GetLastGroupLine();
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" GetLastEntryLine() for Group '%s'"),
+ Name().c_str() );
- // if we have any entries, our last line is the last entry
- if ( m_pLastEntry != NULL )
- return m_pLastEntry->GetLine();
+ if ( m_pLastEntry )
+ {
+ wxFileConfigLineList *pLine = m_pLastEntry->GetLine();
+
+ wxASSERT_MSG( pLine, wxT("last entry must have !NULL associated line") );
+
+ return pLine;
+ }
- // nothing at all: last line is the first one
- return GetGroupLine();
+ // no entries: insert after the group header, if any
+ return GetGroupLine();
}
-// return the last line belonging to the entries of this group
-// (after which we can add a new entry)
-wxFileConfig::LineList *wxFileConfig::ConfigGroup::GetLastEntryLine()
+void wxFileConfigGroup::SetLastEntry(wxFileConfigEntry *pEntry)
{
- if ( m_pLastEntry != NULL ) {
- wxFileConfig::LineList *pLine = m_pLastEntry->GetLine();
+ m_pLastEntry = pEntry;
- wxASSERT( pLine != NULL ); // last entry must have !NULL associated line
- return pLine;
- }
+ 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, wxT("unexpected for non root group") );
- // no entrues: insert after the group header
- return GetGroupLine();
+ // let the group know that it does have a line in the file now
+ m_pLine = pEntry->GetLine();
+ }
}
// ----------------------------------------------------------------------------
// group name
// ----------------------------------------------------------------------------
-wxString wxFileConfig::ConfigGroup::GetFullName() const
+void wxFileConfigGroup::UpdateGroupAndSubgroupsLines()
{
- if ( Parent() )
- return Parent()->GetFullName() + APPCONF_PATH_SEPARATOR + Name();
- else
- return "";
+ // update the line of this group
+ wxFileConfigLineList *line = GetGroupLine();
+ wxCHECK_RET( line, wxT("a non root group must have a corresponding line!") );
+
+ // +1: skip the leading '/'
+ line->SetText(wxString::Format(wxT("[%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, wxT("the root group can't be renamed") );
+
+ if ( newName == m_strName )
+ return;
+
+ // 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);
+
+ m_strName = newName;
+
+ m_pParent->m_aSubgroups.Add(this);
+
+ // update the group lines recursively
+ UpdateGroupAndSubgroupsLines();
+}
+
+wxString wxFileConfigGroup::GetFullName() const
+{
+ wxString fullname;
+ if ( Parent() )
+ fullname = Parent()->GetFullName() + wxCONFIG_PATH_SEPARATOR + Name();
+
+ return fullname;
}
// ----------------------------------------------------------------------------
// find an item
// ----------------------------------------------------------------------------
-wxFileConfig::ConfigEntry *
-wxFileConfig::ConfigGroup::FindEntry(const char *szName) const
+// use binary search because the array is sorted
+wxFileConfigEntry *
+wxFileConfigGroup::FindEntry(const wxString& name) const
{
- uint nCount = m_aEntries.Count();
- for ( uint n = 0; n < nCount; n++ ) {
- if ( m_aEntries[n]->Name().IsSameAs(szName, APPCONF_CASE_SENSITIVE) )
- return m_aEntries[n];
+ size_t i,
+ lo = 0,
+ hi = m_aEntries.GetCount();
+ int res;
+ wxFileConfigEntry *pEntry;
+
+ while ( lo < hi ) {
+ i = (lo + hi)/2;
+ pEntry = m_aEntries[i];
+
+ #if wxCONFIG_CASE_SENSITIVE
+ res = pEntry->Name().compare(name);
+ #else
+ res = pEntry->Name().CmpNoCase(name);
+ #endif
+
+ if ( res > 0 )
+ hi = i;
+ else if ( res < 0 )
+ lo = i + 1;
+ else
+ return pEntry;
}
return NULL;
}
-wxFileConfig::ConfigGroup *
-wxFileConfig::ConfigGroup::FindSubgroup(const char *szName) const
+wxFileConfigGroup *
+wxFileConfigGroup::FindSubgroup(const wxString& name) const
{
- uint nCount = m_aSubgroups.Count();
- for ( uint n = 0; n < nCount; n++ ) {
- if ( m_aSubgroups[n]->Name().IsSameAs(szName, APPCONF_CASE_SENSITIVE) )
- return m_aSubgroups[n];
+ size_t i,
+ lo = 0,
+ hi = m_aSubgroups.GetCount();
+ int res;
+ wxFileConfigGroup *pGroup;
+
+ while ( lo < hi ) {
+ i = (lo + hi)/2;
+ pGroup = m_aSubgroups[i];
+
+ #if wxCONFIG_CASE_SENSITIVE
+ res = pGroup->Name().compare(name);
+ #else
+ res = pGroup->Name().CmpNoCase(name);
+ #endif
+
+ if ( res > 0 )
+ hi = i;
+ else if ( res < 0 )
+ lo = i + 1;
+ else
+ return pGroup;
}
return NULL;
// ----------------------------------------------------------------------------
// create a new entry and add it to the current group
-wxFileConfig::ConfigEntry *
-wxFileConfig::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
-wxFileConfig::ConfigGroup *
-wxFileConfig::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;
}
// ----------------------------------------------------------------------------
// delete an item
// ----------------------------------------------------------------------------
-bool wxFileConfig::ConfigGroup::DeleteSubgroup(const char *szName)
+/*
+ The delete operations are _very_ slow if we delete the last item of this
+ group (see comments before GetXXXLineXXX functions for more details),
+ so it's much better to start with the first entry/group if we want to
+ delete several of them.
+ */
+
+bool wxFileConfigGroup::DeleteSubgroupByName(const wxString& name)
{
- uint n, nCount = m_aSubgroups.Count();
- for ( n = 0; n < nCount; n++ ) {
- if ( m_aSubgroups[n]->Name().IsSameAs(szName, APPCONF_CASE_SENSITIVE) )
- break;
- }
+ wxFileConfigGroup * const pGroup = FindSubgroup(name);
+
+ return pGroup ? DeleteSubgroup(pGroup) : false;
+}
- if ( n == nCount )
- return FALSE;
+// Delete the subgroup and remove all references to it from
+// other data structures.
+bool wxFileConfigGroup::DeleteSubgroup(wxFileConfigGroup *pGroup)
+{
+ wxCHECK_MSG( pGroup, false, wxT("deleting non existing group?") );
+
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT("Deleting group '%s' from '%s'"),
+ pGroup->Name().c_str(),
+ Name().c_str() );
+
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" (m_pLine) = prev: %p, this %p, next %p"),
+ m_pLine ? static_cast<void*>(m_pLine->Prev()) : 0,
+ static_cast<void*>(m_pLine),
+ m_pLine ? static_cast<void*>(m_pLine->Next()) : 0 );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" text: '%s'"),
+ m_pLine ? (const wxChar*)m_pLine->Text().c_str()
+ : wxEmptyString );
+
+ // delete all entries...
+ size_t nCount = pGroup->m_aEntries.GetCount();
+
+ wxLogTrace(FILECONF_TRACE_MASK,
+ wxT("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,
+ wxT(" '%s'"),
+ pLine->Text().c_str() );
+ m_pConfig->LineListRemove(pLine);
+ }
+ }
- nCount = m_aEntries.Count();
- for ( n = 0; n < nCount; n++ ) {
- LineList *pLine = m_aEntries[n]->GetLine();
- if ( pLine != NULL )
- m_pConfig->LineListRemove(pLine);
- }
+ // ...and subgroups of this subgroup
+ nCount = pGroup->m_aSubgroups.GetCount();
- ConfigGroup *pGroup = m_aSubgroups[n];
- LineList *pLine = pGroup->m_pLine;
- if ( pLine != NULL )
- m_pConfig->LineListRemove(pLine);
- delete pGroup;
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT("Removing %lu subgroups"), (unsigned long)nCount );
- SetDirty();
+ for ( size_t nGroup = 0; nGroup < nCount; nGroup++ )
+ {
+ pGroup->DeleteSubgroup(pGroup->m_aSubgroups[0]);
+ }
+
+ // and then finally the group itself
+ wxFileConfigLineList *pLine = pGroup->m_pLine;
+ if ( pLine )
+ {
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" Removing line for group '%s' : '%s'"),
+ pGroup->Name().c_str(),
+ pLine->Text().c_str() );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" Removing from group '%s' : '%s'"),
+ Name().c_str(),
+ ((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( FILECONF_TRACE_MASK,
+ wxT(" 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() )
+ {
+ // 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;
+ }
+ }
+
+ if ( pl == m_pLine )
+ break;
+ }
+ }
+
+ m_pConfig->LineListRemove(pLine);
+ }
+ else
+ {
+ wxLogTrace( FILECONF_TRACE_MASK,
+ wxT(" No line entry for Group '%s'?"),
+ pGroup->Name().c_str() );
+ }
- m_aSubgroups.Remove(n);
- return TRUE;
+ m_aSubgroups.Remove(pGroup);
+ delete pGroup;
+
+ return true;
}
-bool wxFileConfig::ConfigGroup::DeleteEntry(const char *szName)
+bool wxFileConfigGroup::DeleteEntry(const wxString& name)
{
- uint n, nCount = m_aEntries.Count();
- for ( n = 0; n < nCount; n++ ) {
- if ( m_aEntries[n]->Name().IsSameAs(szName, APPCONF_CASE_SENSITIVE) )
- break;
+ wxFileConfigEntry *pEntry = FindEntry(name);
+ if ( !pEntry )
+ {
+ // entry doesn't exist, nothing to do
+ return false;
}
- if ( n == nCount )
- return FALSE;
+ 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
+ if ( pEntry == m_pLastEntry ) {
+ // our last entry is being deleted - find the last one which stays
+ wxASSERT( m_pLine != NULL ); // if we have an entry with !NULL pLine...
+
+ // find the previous entry (if any)
+ wxFileConfigEntry *pNewLast = NULL;
+ const wxFileConfigLineList * const
+ pNewLastLine = m_pLastEntry->GetLine()->Prev();
+ const size_t nEntries = m_aEntries.GetCount();
+ for ( size_t n = 0; n < nEntries; n++ ) {
+ if ( m_aEntries[n]->GetLine() == pNewLastLine ) {
+ pNewLast = m_aEntries[n];
+ break;
+ }
+ }
- ConfigEntry *pEntry = m_aEntries[n];
- LineList *pLine = pEntry->GetLine();
- if ( pLine != NULL )
- m_pConfig->LineListRemove(pLine);
- delete pEntry;
+ // pNewLast can be NULL here -- it's ok and can happen if we have no
+ // entries left
+ m_pLastEntry = pNewLast;
+ }
- SetDirty();
+ m_pConfig->LineListRemove(pLine);
+ }
- m_aEntries.Remove(n);
- return TRUE;
-}
+ m_aEntries.Remove(pEntry);
+ delete pEntry;
-// ----------------------------------------------------------------------------
-//
-// ----------------------------------------------------------------------------
-void wxFileConfig::ConfigGroup::SetDirty()
-{
- m_bDirty = TRUE;
- if ( Parent() != NULL ) // propagate upwards
- Parent()->SetDirty();
+ return true;
}
// ============================================================================
-// wxFileConfig::ConfigEntry
+// wxFileConfig::wxFileConfigEntry
// ============================================================================
// ----------------------------------------------------------------------------
// ctor
// ----------------------------------------------------------------------------
-wxFileConfig::ConfigEntry::ConfigEntry(wxFileConfig::ConfigGroup *pParent,
+wxFileConfigEntry::wxFileConfigEntry(wxFileConfigGroup *pParent,
const wxString& strName,
int nLine)
: m_strName(strName)
{
+ wxASSERT( !strName.empty() );
+
m_pParent = pParent;
m_nLine = nLine;
m_pLine = NULL;
- m_bDirty = FALSE;
+ m_bHasValue = false;
- m_bImmutable = strName[0] == APPCONF_IMMUTABLE_PREFIX;
+ m_bImmutable = strName[0] == wxCONFIG_IMMUTABLE_PREFIX;
if ( m_bImmutable )
m_strName.erase(0, 1); // remove first character
}
// set value
// ----------------------------------------------------------------------------
-void wxFileConfig::ConfigEntry::SetLine(LineList *pLine)
+void wxFileConfigEntry::SetLine(wxFileConfigLineList *pLine)
{
if ( m_pLine != NULL ) {
- wxLogWarning("Entry '%s' appears more than once in group '%s'",
+ wxLogWarning(_("entry '%s' appears more than once in group '%s'"),
Name().c_str(), m_pParent->GetFullName().c_str());
}
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 wxFileConfig::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 = FilterOut(strValue);
- wxString strLine;
- strLine << m_strName << " = " << 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 == NOT_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();
- }
-}
-
-void wxFileConfig::ConfigEntry::SetDirty()
-{
- m_bDirty = TRUE;
- Group()->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: 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);
+ }
+ }
}
// ============================================================================
// global functions
// ============================================================================
-// undo FilterOut
-wxString FilterIn(const wxString& str)
-{
- wxString strResult;
-
- bool bQuoted = !str.IsEmpty() && str[0] == '"';
+// ----------------------------------------------------------------------------
+// compare functions for array sorting
+// ----------------------------------------------------------------------------
- for ( uint n = bQuoted ? 1 : 0; n < str.Len(); n++ ) {
- if ( str[n] == '\\' ) {
- switch ( str[++n] ) {
- case 'n':
- strResult += '\n';
- break;
+int CompareEntries(wxFileConfigEntry *p1, wxFileConfigEntry *p2)
+{
+#if wxCONFIG_CASE_SENSITIVE
+ return p1->Name().compare(p2->Name());
+#else
+ return p1->Name().CmpNoCase(p2->Name());
+#endif
+}
- case 't':
- strResult += '\t';
- break;
+int CompareGroups(wxFileConfigGroup *p1, wxFileConfigGroup *p2)
+{
+#if wxCONFIG_CASE_SENSITIVE
+ return p1->Name().compare(p2->Name());
+#else
+ return p1->Name().CmpNoCase(p2->Name());
+#endif
+}
- case '\\':
- strResult += '\\';
- break;
+// ----------------------------------------------------------------------------
+// filter functions
+// ----------------------------------------------------------------------------
- case '"':
- strResult += '"';
- break;
- }
- }
- else {
- if ( str[n] != '"' || !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
+// undo FilterOutValue
+static wxString FilterInValue(const wxString& str)
+{
+ wxString strResult;
+ if ( str.empty() )
+ return strResult;
+
+ strResult.reserve(str.length());
+
+ wxString::const_iterator i = str.begin();
+ const bool bQuoted = *i == '"';
+ if ( bQuoted )
+ ++i;
+
+ 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;
+ }
+
+ switch ( (*i).GetValue() )
+ {
+ case wxT('n'):
+ strResult += wxT('\n');
+ break;
+
+ case wxT('r'):
+ strResult += wxT('\r');
+ break;
+
+ 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
-wxString FilterOut(const wxString& str)
+static wxString FilterOutValue(const wxString& str)
{
+ if ( !str )
+ return str;
+
wxString strResult;
+ strResult.Alloc(str.Len());
// quoting is necessary to preserve spaces in the beginning of the string
- bool bQuote = isspace(str[0]) || str[0] == '"';
+ bool bQuote = wxIsspace(str[0]) || str[0] == wxT('"');
if ( bQuote )
- strResult += '"';
+ strResult += wxT('"');
+
+ wxChar c;
+ for ( size_t n = 0; n < str.Len(); n++ ) {
+ switch ( str[n].GetValue() ) {
+ case wxT('\n'):
+ c = wxT('n');
+ break;
- char c;
- for ( uint n = 0; n < str.Len(); n++ ) {
- switch ( str[n] ) {
- case '\n':
- c = 'n';
+ case wxT('\r'):
+ c = wxT('r');
break;
- case '\t':
- c = 't';
+ case wxT('\t'):
+ c = wxT('t');
break;
- case '\\':
- c = '\\';
+ case wxT('\\'):
+ c = wxT('\\');
break;
- case '"':
- if ( bQuote )
- c = '"';
+ case wxT('"'):
+ if ( bQuote ) {
+ c = wxT('"');
+ break;
+ }
//else: fall through
default:
}
// we get here only for special characters
- strResult << '\\' << c;
+ strResult << wxT('\\') << c;
}
if ( bQuote )
- strResult += '"';
+ strResult += wxT('"');
+
+ return strResult;
+}
+
+// undo FilterOutEntryName
+static wxString FilterInEntryName(const wxString& str)
+{
+ wxString strResult;
+ strResult.Alloc(str.Len());
+
+ for ( const wxChar *pc = str.c_str(); *pc != '\0'; pc++ ) {
+ if ( *pc == wxT('\\') ) {
+ // we need to test it here or we'd skip past the NUL in the loop line
+ if ( *++pc == wxT('\0') )
+ break;
+ }
+
+ strResult += *pc;
+ }
return strResult;
}
+
+// sanitize entry or group name: insert '\\' before any special characters
+static wxString FilterOutEntryName(const wxString& str)
+{
+ wxString strResult;
+ strResult.Alloc(str.Len());
+
+ 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 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 (
+#if !wxUSE_UNICODE
+ ((unsigned char)c < 127) &&
+#endif // ANSI
+ !wxIsalnum(c) && !wxStrchr(wxT("@_/-!.*%"), c) )
+ {
+ strResult += wxT('\\');
+ }
+
+ strResult += c;
+ }
+
+ return strResult;
+}
+
+// we can't put ?: in the ctor initializer list because it confuses some
+// broken compilers (Borland C++)
+static wxString GetAppName(const wxString& appName)
+{
+ if ( !appName && wxTheApp )
+ return wxTheApp->GetAppName();
+ else
+ return appName;
+}
+
+#endif // wxUSE_CONFIG
projects / wxWidgets.git / blobdiff