///////////////////////////////////////////////////////////////////////////////
-// Name: fileconf.cpp
+// Name: src/common/fileconf.cpp
// Purpose: implementation of wxFileConfig derivation of wxConfig
// Author: Vadim Zeitlin
// Modified by:
// RCS-ID: $Id$
// Copyright: (c) 1997 Karsten Ballüder & Vadim Zeitlin
// Ballueder@usa.net <zeitlin@dptmaths.ens-cachan.fr>
-// Licence: wxWindows license
+// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
-#pragma implementation "fileconf.h"
-#endif
-
// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------
#pragma hdrstop
#endif //__BORLANDC__
-#if wxUSE_CONFIG
+#if wxUSE_CONFIG && wxUSE_FILECONFIG
#ifndef WX_PRECOMP
#include "wx/string.h"
#include "wx/memtext.h"
#include "wx/config.h"
#include "wx/fileconf.h"
+#include "wx/filefn.h"
#if wxUSE_STREAMS
#include "wx/stream.h"
#include "wx/utils.h" // for wxGetHomeDir
-// _WINDOWS_ is defined when windows.h is included,
-// __WXMSW__ is defined for MS Windows compilation
-#if defined(__WXMSW__) && !defined(_WINDOWS_)
- #include <windows.h>
+#if defined(__WXMAC__)
+ #include "wx/mac/private.h" // includes mac headers
+ #include "wx/filename.h" // for MacSetTypeAndCreator
+#endif
+
+#if defined(__WXMSW__)
+ #include "wx/msw/private.h"
#endif //windows.h
#if defined(__WXPM__)
#define INCL_DOS
#include <stdlib.h>
#include <ctype.h>
-// headers needed for umask()
-#ifdef __UNIX__
- #include <sys/types.h>
- #include <sys/stat.h>
-#endif // __UNIX__
-
// ----------------------------------------------------------------------------
// macros
// ----------------------------------------------------------------------------
#define MAX_PATH 512
#endif
+#define FILECONF_TRACE_MASK _T("fileconf")
+
// ----------------------------------------------------------------------------
// global functions declarations
// ----------------------------------------------------------------------------
// "template" array types
// ----------------------------------------------------------------------------
-WX_DEFINE_SORTED_EXPORTED_ARRAY(wxFileConfigEntry *, ArrayEntries);
-WX_DEFINE_SORTED_EXPORTED_ARRAY(wxFileConfigGroup *, ArrayGroups);
+#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
wxString m_strLine; // line contents
wxFileConfigLineList *m_pNext, // next node
*m_pPrev; // previous one
+
+ DECLARE_NO_COPY_CLASS(wxFileConfigLineList)
};
// ----------------------------------------------------------------------------
wxString m_strName, // entry name
m_strValue; // value
- bool m_bDirty:1, // changed since last read?
- m_bImmutable:1, // can be overriden locally?
+ bool m_bImmutable:1, // can be overriden locally?
m_bHasValue:1; // set after first call to SetValue()
int m_nLine; // used if m_pLine == NULL only
const wxString& Name() const { return m_strName; }
const wxString& Value() const { return m_strValue; }
wxFileConfigGroup *Group() const { return m_pParent; }
- bool IsDirty() const { return m_bDirty; }
bool IsImmutable() const { return m_bImmutable; }
bool IsLocal() const { return m_pLine != 0; }
int Line() const { return m_nLine; }
GetLine() const { return m_pLine; }
// modify entry attributes
- void SetValue(const wxString& strValue, bool bUser = TRUE);
- void SetDirty();
+ void SetValue(const wxString& strValue, bool bUser = true);
void SetLine(wxFileConfigLineList *pLine);
+
+ DECLARE_NO_COPY_CLASS(wxFileConfigEntry)
};
// ----------------------------------------------------------------------------
ArrayEntries m_aEntries; // entries in this group
ArrayGroups m_aSubgroups; // subgroups
wxString m_strName; // group's name
- bool m_bDirty; // if FALSE => all subgroups are not dirty
wxFileConfigLineList *m_pLine; // pointer to our line in the linked list
wxFileConfigEntry *m_pLastEntry; // last entry/subgroup of this group in the
wxFileConfigGroup *m_pLastGroup; // local file (we insert new ones after it)
// DeleteSubgroupByName helper
bool DeleteSubgroup(wxFileConfigGroup *pGroup);
+ // used by Rename()
+ void UpdateGroupAndSubgroupsLines();
+
public:
// ctor
wxFileConfigGroup(wxFileConfigGroup *pParent, const wxString& strName, wxFileConfig *);
const wxString& Name() const { return m_strName; }
wxFileConfigGroup *Parent() const { return m_pParent; }
wxFileConfig *Config() const { return m_pConfig; }
- bool IsDirty() const { return m_bDirty; }
const ArrayEntries& Entries() const { return m_aEntries; }
const ArrayGroups& Groups() const { return m_aSubgroups; }
wxFileConfigGroup *FindSubgroup(const wxChar *szName) const;
wxFileConfigEntry *FindEntry (const wxChar *szName) const;
- // delete entry/subgroup, return FALSE if doesn't exist
+ // delete entry/subgroup, return false if doesn't exist
bool DeleteSubgroupByName(const wxChar *szName);
bool DeleteEntry(const wxChar *szName);
wxFileConfigGroup *AddSubgroup(const wxString& strName);
wxFileConfigEntry *AddEntry (const wxString& strName, int nLine = wxNOT_FOUND);
- // will also recursively set parent's dirty flag
- void SetDirty();
void SetLine(wxFileConfigLineList *pLine);
// rename: no checks are done to ensure that the name is unique!
wxFileConfigLineList *GetLastGroupLine(); // after which the next group starts
// called by entries/subgroups when they're created/deleted
- void SetLastEntry(wxFileConfigEntry *pEntry) { m_pLastEntry = pEntry; }
- void SetLastGroup(wxFileConfigGroup *pGroup) { m_pLastGroup = pGroup; }
+ void SetLastEntry(wxFileConfigEntry *pEntry);
+ void SetLastGroup(wxFileConfigGroup *pGroup)
+ { m_pLastGroup = pGroup; }
+
+ DECLARE_NO_COPY_CLASS(wxFileConfigGroup)
};
// ============================================================================
{
wxString strDir;
- #ifdef __VMS__ // Note if __VMS is defined __UNIX is also defined
+#ifdef __VMS__ // Note if __VMS is defined __UNIX is also defined
strDir = wxT("sys$manager:");
- #elif defined(__WXMAC__)
+#elif defined(__WXMAC__)
strDir = wxMacFindFolder( (short) kOnSystemDisk, kPreferencesFolderType, kDontCreateFolder ) ;
- #elif defined( __UNIX__ )
+#elif defined( __UNIX__ )
strDir = wxT("/etc/");
- #elif defined(__WXPM__)
- ULONG aulSysInfo[QSV_MAX] = {0};
- UINT drive;
- APIRET rc;
+#elif defined(__OS2__)
+ ULONG aulSysInfo[QSV_MAX] = {0};
+ UINT drive;
+ APIRET rc;
rc = DosQuerySysInfo( 1L, QSV_MAX, (PVOID)aulSysInfo, sizeof(ULONG)*QSV_MAX);
if (rc == 0)
drive = aulSysInfo[QSV_BOOT_DRIVE - 1];
strDir.Printf(wxT("%c:\\OS2\\"), 'A'+drive-1);
}
- #elif defined(__WXSTUBS__)
- wxASSERT_MSG( FALSE, wxT("TODO") ) ;
- #elif defined(__DOS__)
+#elif defined(__WXSTUBS__)
+ wxASSERT_MSG( false, wxT("TODO") ) ;
+#elif defined(__DOS__)
// There's no such thing as global cfg dir in MS-DOS, let's return
// current directory (FIXME_MGL?)
return wxT(".\\");
- #else // Windows
+#elif defined(__WXWINCE__)
+ strDir = wxT("\\Windows\\");
+#else // Windows
+
wxChar szWinDir[MAX_PATH];
::GetWindowsDirectory(szWinDir, MAX_PATH);
strDir = szWinDir;
strDir << wxT('\\');
- #endif // Unix/Windows
+#endif // Unix/Windows
- return strDir;
+ return strDir;
}
wxString wxFileConfig::GetLocalDir()
{
- wxString strDir;
+ wxString strDir;
-#if defined(__WXMAC__)
- // no local dir concept on Mac OS 9
- return GetGlobalDir() ;
+#if defined(__WXMAC__) || defined(__DOS__)
+ // no local dir concept on Mac OS 9 or MS-DOS
+ return GetGlobalDir() ;
+#else
+ wxGetHomeDir(&strDir);
+
+#ifdef __UNIX__
+#ifdef __VMS
+ if (strDir.Last() != wxT(']'))
+#endif
+ if (strDir.Last() != wxT('/')) strDir << wxT('/');
#else
- wxGetHomeDir(&strDir);
-
-# ifdef __UNIX__
-# ifdef __VMS
- if (strDir.Last() != wxT(']'))
-# endif
- if (strDir.Last() != wxT('/')) strDir << wxT('/');
-# else
- if (strDir.Last() != wxT('\\')) strDir << wxT('\\');
-# endif
+ if (strDir.Last() != wxT('\\')) strDir << wxT('\\');
+#endif
#endif
- return strDir;
+ return strDir;
}
wxString wxFileConfig::GetGlobalFileName(const wxChar *szFile)
{
- wxString str = GetGlobalDir();
- str << szFile;
-
- if ( wxStrchr(szFile, wxT('.')) == NULL )
- #if defined( __WXMAC__ )
- str << " Preferences";
- #elif defined( __UNIX__ )
- str << wxT(".conf");
- #else // Windows
- str << wxT(".ini");
- #endif // UNIX/Win
+ wxString str = GetGlobalDir();
+ str << szFile;
- return str;
+ if ( wxStrchr(szFile, wxT('.')) == NULL )
+#if defined( __WXMAC__ )
+ str << wxT(" Preferences") ;
+#elif defined( __UNIX__ )
+ str << wxT(".conf");
+#else // Windows
+ str << wxT(".ini");
+#endif // UNIX/Win
+
+ return str;
}
wxString wxFileConfig::GetLocalFileName(const wxChar *szFile)
{
-#ifdef __VMS__ // On VMS I saw the problem that the home directory was appended
- // twice for the configuration file. Does that also happen for other
- // platforms?
- wxString str = wxT( '.' );
+#ifdef __VMS__
+ // On VMS I saw the problem that the home directory was appended
+ // twice for the configuration file. Does that also happen for
+ // other platforms?
+ wxString str = wxT( '.' );
#else
- wxString str = GetLocalDir();
+ wxString str = GetLocalDir();
#endif
-
- #if defined( __UNIX__ ) && !defined( __VMS ) && !defined( __WXMAC__ )
+
+#if defined( __UNIX__ ) && !defined( __VMS ) && !defined( __WXMAC__ )
str << wxT('.');
- #endif
+#endif
- str << szFile;
+ str << szFile;
- #ifdef __WXMSW__
+#if defined(__WINDOWS__) || defined(__DOS__)
if ( wxStrchr(szFile, wxT('.')) == NULL )
- str << wxT(".ini");
- #endif
+ str << wxT(".ini");
+#endif
- #ifdef __WXMAC__
- str << " Preferences";
- #endif
- return str;
+#ifdef __WXMAC__
+ str << wxT(" Preferences") ;
+#endif
+
+ return str;
}
// ----------------------------------------------------------------------------
void wxFileConfig::Init()
{
- m_pCurrentGroup =
- m_pRootGroup = new wxFileConfigGroup(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
+ // It's not an error if (one of the) file(s) doesn't exist.
- // parse the global file
- if ( !m_strGlobalFile.IsEmpty() && wxFile::Exists(m_strGlobalFile) ) {
- wxTextFile fileGlobal(m_strGlobalFile);
+ // parse the global file
+ if ( !m_strGlobalFile.empty() && wxFile::Exists(m_strGlobalFile) )
+ {
+ wxTextFile fileGlobal(m_strGlobalFile);
- if ( fileGlobal.Open() ) {
- Parse(fileGlobal, FALSE /* global */);
- SetRootPath();
+ if ( fileGlobal.Open(m_conv/*ignored in ANSI build*/) )
+ {
+ Parse(fileGlobal, false /* global */);
+ SetRootPath();
+ }
+ else
+ {
+ wxLogWarning(_("can't open global configuration file '%s'."), m_strGlobalFile.c_str());
+ }
}
- else
- wxLogWarning(_("can't open global configuration file '%s'."),
- m_strGlobalFile.c_str());
- }
- // parse the local file
- if ( !m_strLocalFile.IsEmpty() && wxFile::Exists(m_strLocalFile) ) {
- wxTextFile fileLocal(m_strLocalFile);
- if ( fileLocal.Open() ) {
- Parse(fileLocal, TRUE /* local */);
- SetRootPath();
+ // parse the local file
+ if ( !m_strLocalFile.empty() && wxFile::Exists(m_strLocalFile) )
+ {
+ wxTextFile fileLocal(m_strLocalFile);
+ if ( fileLocal.Open(m_conv/*ignored in ANSI build*/) )
+ {
+ Parse(fileLocal, true /* local */);
+ SetRootPath();
+ }
+ else
+ {
+ wxLogWarning(_("can't open user configuration file '%s'."), m_strLocalFile.c_str() );
+ }
}
- else
- wxLogWarning(_("can't open user configuration file '%s'."),
- m_strLocalFile.c_str());
- }
+
+ m_isDirty = false;
}
// constructor supports creation of wxFileConfig objects of any type
wxFileConfig::wxFileConfig(const wxString& appName, const wxString& vendorName,
const wxString& strLocal, const wxString& strGlobal,
- long style)
+ long style, wxMBConv& conv)
: wxConfigBase(::GetAppName(appName), vendorName,
strLocal, strGlobal,
style),
- m_strLocalFile(strLocal), m_strGlobalFile(strGlobal)
+ m_strLocalFile(strLocal), m_strGlobalFile(strGlobal),
+ m_conv(conv)
{
- // Make up names for files if empty
- if ( m_strLocalFile.IsEmpty() && (style & wxCONFIG_USE_LOCAL_FILE) )
- {
- m_strLocalFile = GetLocalFileName(GetAppName());
- }
+ // Make up names for files if empty
+ if ( m_strLocalFile.empty() && (style & wxCONFIG_USE_LOCAL_FILE) )
+ m_strLocalFile = GetLocalFileName(GetAppName());
- if ( m_strGlobalFile.IsEmpty() && (style & wxCONFIG_USE_GLOBAL_FILE) )
- {
- m_strGlobalFile = GetGlobalFileName(GetAppName());
- }
+ if ( m_strGlobalFile.empty() && (style & wxCONFIG_USE_GLOBAL_FILE) )
+ m_strGlobalFile = GetGlobalFileName(GetAppName());
- // Check if styles are not supplied, but filenames are, in which case
- // add the correct styles.
- if ( !m_strLocalFile.IsEmpty() )
- 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.empty() )
+ SetStyle(GetStyle() | wxCONFIG_USE_LOCAL_FILE);
- if ( !m_strGlobalFile.IsEmpty() )
- SetStyle(GetStyle() | wxCONFIG_USE_GLOBAL_FILE);
+ if ( !m_strGlobalFile.empty() )
+ SetStyle(GetStyle() | wxCONFIG_USE_GLOBAL_FILE);
- // if the path is not absolute, prepend the standard directory to it
- // UNLESS wxCONFIG_USE_RELATIVE_PATH style is set
- if ( !(style & wxCONFIG_USE_RELATIVE_PATH) )
- {
- if ( !m_strLocalFile.IsEmpty() && !wxIsAbsolutePath(m_strLocalFile) )
- {
- wxString strLocal = m_strLocalFile;
- m_strLocalFile = GetLocalDir();
- m_strLocalFile << strLocal;
- }
+ // if the path is not absolute, prepend the standard directory to it
+ // UNLESS wxCONFIG_USE_RELATIVE_PATH style is set
+ if ( !(style & wxCONFIG_USE_RELATIVE_PATH) )
+ {
+ if ( !m_strLocalFile.empty() && !wxIsAbsolutePath(m_strLocalFile) )
+ {
+ const wxString strLocalOrig = m_strLocalFile;
+ m_strLocalFile = GetLocalDir();
+ m_strLocalFile << strLocalOrig;
+ }
- if ( !m_strGlobalFile.IsEmpty() && !wxIsAbsolutePath(m_strGlobalFile) )
- {
- wxString strGlobal = m_strGlobalFile;
- m_strGlobalFile = GetGlobalDir();
- m_strGlobalFile << strGlobal;
- }
- }
+ if ( !m_strGlobalFile.empty() && !wxIsAbsolutePath(m_strGlobalFile) )
+ {
+ const wxString strGlobalOrig = m_strGlobalFile;
+ m_strGlobalFile = GetGlobalDir();
+ m_strGlobalFile << strGlobalOrig;
+ }
+ }
- SetUmask(-1);
+ SetUmask(-1);
- Init();
+ Init();
}
#if wxUSE_STREAMS
-wxFileConfig::wxFileConfig(wxInputStream &inStream)
+wxFileConfig::wxFileConfig(wxInputStream &inStream, wxMBConv& conv)
+ : m_conv(conv)
{
// always local_file when this constructor is called (?)
SetStyle(GetStyle() | wxCONFIG_USE_LOCAL_FILE);
m_pCurrentGroup =
- m_pRootGroup = new wxFileConfigGroup(NULL, "", this);
+ m_pRootGroup = new wxFileConfigGroup(NULL, wxEmptyString, this);
m_linesHead =
m_linesTail = NULL;
wxString strTmp;
char buf[1024];
- while ( !inStream.Read(buf, WXSIZEOF(buf)).Eof() )
- strTmp.append(wxConvertMB2WX(buf), inStream.LastRead());
-
- strTmp.append(wxConvertMB2WX(buf), inStream.LastRead());
+ do
+ {
+ inStream.Read(buf, WXSIZEOF(buf)-1); // leave room for the NULL
+
+ const wxStreamError err = inStream.GetLastError();
+
+ if ( err != wxSTREAM_NO_ERROR && err != wxSTREAM_EOF )
+ {
+ wxLogError(_("Error reading config options."));
+ break;
+ }
+
+ // FIXME: this is broken because if we have part of multibyte
+ // character in the buffer (and another part hasn't been
+ // read yet) we're going to lose data because of conversion
+ // errors
+ buf[inStream.LastRead()] = '\0';
+ strTmp += conv.cMB2WX(buf);
+ }
+ while ( !inStream.Eof() );
strTrans = wxTextBuffer::Translate(strTmp);
}
}
// also add whatever we have left in the translated string.
- memText.AddLine(strTrans);
+ if ( !strTrans.empty() )
+ memText.AddLine(strTrans);
// Finally we can parse it all.
- Parse(memText, TRUE /* local */);
+ Parse(memText, true /* local */);
SetRootPath();
+ ResetDirty();
}
#endif // wxUSE_STREAMS
// parse a config file
// ----------------------------------------------------------------------------
-void wxFileConfig::Parse(wxTextBuffer& buffer, bool bLocal)
+void wxFileConfig::Parse(const wxTextBuffer& buffer, bool bLocal)
{
const wxChar *pStart;
const wxChar *pEnd;
wxString strLine;
size_t nLineCount = buffer.GetLineCount();
- for ( size_t n = 0; n < nLineCount; n++ ) {
+
+ for ( size_t n = 0; n < nLineCount; n++ )
+ {
strLine = buffer[n];
// add the line to linked list
if ( bLocal )
+ {
LineListAppend(strLine);
+ // let the root group have its start line as well
+ if ( !n )
+ {
+ m_pCurrentGroup->SetLine(m_linesTail);
+ }
+ }
+
+
// skip leading spaces
for ( pStart = strLine; wxIsspace(*pStart); pStart++ )
;
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;
+ bool bCont = true;
while ( *++pEnd != wxT('\0') && bCont ) {
switch ( *pEnd ) {
case wxT('#'):
case wxT(';'):
- bCont = FALSE;
+ bCont = false;
break;
case wxT(' '):
default:
wxLogWarning(_("file '%s', line %d: '%s' ignored after group header."),
buffer.GetName(), n + 1, pEnd);
- bCont = FALSE;
+ bCont = false;
}
}
}
else { // a key
- const wxChar *pEnd = pStart;
- while ( *pEnd && *pEnd != wxT('=') && !wxIsspace(*pEnd) ) {
+ pEnd = pStart;
+ while ( *pEnd && *pEnd != wxT('=') /* && !wxIsspace(*pEnd)*/ ) {
if ( *pEnd == wxT('\\') ) {
// next character may be space or not - still take it because it's
// quoted (unless there is nothing)
pEnd++;
}
- wxString strKey(FilterInEntryName(wxString(pStart, pEnd)));
+ wxString strKey(FilterInEntryName(wxString(pStart, pEnd).Trim()));
// skip whitespace
while ( wxIsspace(*pEnd) )
if ( pEntry == NULL ) {
// new entry
pEntry = m_pCurrentGroup->AddEntry(strKey, n);
-
- if ( bLocal )
- pEntry->SetLine(m_linesTail);
}
else {
if ( bLocal && pEntry->IsImmutable() ) {
wxLogWarning(_("file '%s', line %d: key '%s' was first found at line %d."),
buffer.GetName(), n + 1, strKey.c_str(), pEntry->Line());
- if ( bLocal )
- pEntry->SetLine(m_linesTail);
}
}
+ if ( bLocal )
+ pEntry->SetLine(m_linesTail);
+
// skip whitespace
while ( wxIsspace(*pEnd) )
pEnd++;
- pEntry->SetValue(FilterInValue(pEnd), FALSE /* read from file */);
+ wxString value = pEnd;
+ if ( !(GetStyle() & wxCONFIG_USE_NO_ESCAPE_CHARACTERS) )
+ value = FilterInValue(value);
+
+ pEntry->SetValue(value, false);
}
}
}
m_pCurrentGroup = m_pRootGroup;
}
-void wxFileConfig::SetPath(const wxString& strPath)
+bool
+wxFileConfig::DoSetPath(const wxString& strPath, bool createMissingComponents)
{
wxArrayString aParts;
- if ( strPath.IsEmpty() ) {
+ if ( strPath.empty() ) {
SetRootPath();
- return;
+ return true;
}
if ( strPath[0] == wxCONFIG_PATH_SEPARATOR ) {
for ( n = 0; n < aParts.Count(); n++ ) {
wxFileConfigGroup *pNextGroup = m_pCurrentGroup->FindSubgroup(aParts[n]);
if ( pNextGroup == NULL )
+ {
+ if ( !createMissingComponents )
+ return false;
+
pNextGroup = m_pCurrentGroup->AddSubgroup(aParts[n]);
+ }
+
m_pCurrentGroup = pNextGroup;
}
for ( n = 0; n < aParts.Count(); n++ ) {
m_strPath << wxCONFIG_PATH_SEPARATOR << aParts[n];
}
+
+ return true;
+}
+
+void wxFileConfig::SetPath(const wxString& strPath)
+{
+ DoSetPath(strPath, true /* create missing path components */);
}
// ----------------------------------------------------------------------------
{
if ( size_t(lIndex) < m_pCurrentGroup->Groups().Count() ) {
str = m_pCurrentGroup->Groups()[(size_t)lIndex++]->Name();
- return TRUE;
+ return true;
}
else
- return FALSE;
+ return false;
}
bool wxFileConfig::GetFirstEntry(wxString& str, long& lIndex) const
{
if ( size_t(lIndex) < m_pCurrentGroup->Entries().Count() ) {
str = m_pCurrentGroup->Entries()[(size_t)lIndex++]->Name();
- return TRUE;
+ return true;
}
else
- return FALSE;
+ return false;
}
size_t wxFileConfig::GetNumberOfEntries(bool bRecursive) const
size_t nSubgroups = m_pCurrentGroup->Groups().Count();
for ( size_t nGroup = 0; nGroup < nSubgroups; nGroup++ ) {
CONST_CAST m_pCurrentGroup = m_pCurrentGroup->Groups()[nGroup];
- n += GetNumberOfEntries(TRUE);
+ n += GetNumberOfEntries(true);
CONST_CAST m_pCurrentGroup = pOldCurrentGroup;
}
}
size_t nSubgroups = m_pCurrentGroup->Groups().Count();
for ( size_t nGroup = 0; nGroup < nSubgroups; nGroup++ ) {
CONST_CAST m_pCurrentGroup = m_pCurrentGroup->Groups()[nGroup];
- n += GetNumberOfGroups(TRUE);
+ n += GetNumberOfGroups(true);
CONST_CAST m_pCurrentGroup = pOldCurrentGroup;
}
}
bool wxFileConfig::HasGroup(const wxString& strName) const
{
- wxConfigPathChanger path(this, strName);
+ // special case: DoSetPath("") does work as it's equivalent to DoSetPath("/")
+ // but there is no group with empty name so treat this separately
+ if ( strName.empty() )
+ return false;
+
+ const wxString pathOld = GetPath();
+
+ wxFileConfig *self = wx_const_cast(wxFileConfig *, this);
+ const bool
+ rc = self->DoSetPath(strName, false /* don't create missing components */);
+
+ self->SetPath(pathOld);
- wxFileConfigGroup *pGroup = m_pCurrentGroup->FindSubgroup(path.Name());
- return pGroup != NULL;
+ return rc;
}
bool wxFileConfig::HasEntry(const wxString& strName) const
// read/write values
// ----------------------------------------------------------------------------
-bool wxFileConfig::Read(const wxString& key,
- wxString* pStr) const
+bool wxFileConfig::DoReadString(const wxString& key, wxString* pStr) const
{
wxConfigPathChanger path(this, key);
wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name());
if (pEntry == NULL) {
- return FALSE;
+ return false;
}
- *pStr = ExpandEnvVars(pEntry->Value());
- return TRUE;
+ *pStr = pEntry->Value();
+
+ return true;
}
-bool wxFileConfig::Read(const wxString& key,
- wxString* pStr, const wxString& defVal) const
+bool wxFileConfig::DoReadLong(const wxString& key, long *pl) const
{
- wxConfigPathChanger path(this, key);
+ wxString str;
+ if ( !Read(key, &str) )
+ return false;
- wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name());
- bool ok;
- if (pEntry == NULL) {
- if( IsRecordingDefaults() )
- ((wxFileConfig *)this)->Write(key,defVal);
- *pStr = ExpandEnvVars(defVal);
- ok = FALSE;
- }
- else {
- *pStr = ExpandEnvVars(pEntry->Value());
- ok = TRUE;
- }
+ // extra spaces shouldn't prevent us from reading numeric values
+ str.Trim();
- return ok;
+ return str.ToLong(pl);
}
-bool wxFileConfig::Read(const wxString& key, long *pl) const
+bool wxFileConfig::DoWriteString(const wxString& key, const wxString& szValue)
{
- wxString str;
- if ( !Read(key, & str) )
- {
- return FALSE;
- }
+ wxConfigPathChanger path(this, key);
+ wxString strName = path.Name();
- *pl = wxAtol(str);
- return TRUE;
-}
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" Writing String '%s' = '%s' to Group '%s'"),
+ strName.c_str(),
+ szValue.c_str(),
+ GetPath().c_str() );
-bool wxFileConfig::Write(const wxString& key, const wxString& szValue)
-{
- wxConfigPathChanger path(this, key);
+ if ( strName.empty() )
+ {
+ // setting the value of a group is an error
- wxString strName = path.Name();
- if ( strName.IsEmpty() ) {
- // setting the value of a group is an error
- wxASSERT_MSG( wxIsEmpty(szValue), wxT("can't set value of a group!") );
+ wxASSERT_MSG( szValue.empty(), wxT("can't set value of a group!") );
- // ... except if it's empty in which case it's a way to force it's creation
- m_pCurrentGroup->SetDirty();
+ // ... except if it's empty in which case it's a way to force it's creation
- // this will add a line for this group if it didn't have it before
- (void)m_pCurrentGroup->GetGroupLine();
- }
- else {
- // writing an entry
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" Creating group %s"),
+ m_pCurrentGroup->Name().c_str() );
+
+ SetDirty();
- // 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;
+ // this will add a line for this group if it didn't have it before
+
+ (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 == NULL )
- pEntry = m_pCurrentGroup->AddEntry(strName);
+ wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(strName);
- pEntry->SetValue(szValue);
- }
+ if ( pEntry == 0 )
+ {
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" Adding Entry %s"),
+ strName.c_str() );
+ pEntry = m_pCurrentGroup->AddEntry(strName);
+ }
+
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" Setting value %s"),
+ szValue.c_str() );
+ pEntry->SetValue(szValue);
- return TRUE;
+ SetDirty();
+ }
+
+ return true;
}
-bool wxFileConfig::Write(const wxString& key, long lValue)
+bool wxFileConfig::DoWriteLong(const wxString& key, long lValue)
{
- // ltoa() is not ANSI :-(
- wxString buf;
- buf.Printf(wxT("%ld"), lValue);
- return Write(key, buf);
+ return Write(key, wxString::Format(_T("%ld"), lValue));
}
bool wxFileConfig::Flush(bool /* bCurrentOnly */)
{
- if ( LineListIsEmpty() || !m_pRootGroup->IsDirty() || !m_strLocalFile )
- return TRUE;
+ if ( !IsDirty() || !m_strLocalFile )
+ return true;
-#ifdef __UNIX__
// set the umask if needed
- mode_t umaskOld = 0;
- if ( m_umask != -1 )
- {
- umaskOld = umask((mode_t)m_umask);
- }
-#endif // __UNIX__
+ wxCHANGE_UMASK(m_umask);
wxTempFile file(m_strLocalFile);
- if ( !file.IsOpened() ) {
+ if ( !file.IsOpened() )
+ {
wxLogError(_("can't open user configuration file."));
- return FALSE;
+ return false;
}
// write all strings to file
- for ( wxFileConfigLineList *p = m_linesHead; p != NULL; p = p->Next() ) {
- if ( !file.Write(p->Text() + wxTextFile::GetEOL()) ) {
+ for ( wxFileConfigLineList *p = m_linesHead; p != NULL; p = p->Next() )
+ {
+ wxString line = p->Text();
+ line += wxTextFile::GetEOL();
+ if ( !file.Write(line, m_conv) )
+ {
wxLogError(_("can't write user configuration file."));
- return FALSE;
+ return false;
}
}
- bool ret = file.Commit();
-
-#if defined(__WXMAC__)
- if ( ret )
+ if ( !file.Commit() )
{
- FSSpec spec ;
-
- wxMacFilename2FSSpec( m_strLocalFile , &spec ) ;
- FInfo finfo ;
- if ( FSpGetFInfo( &spec , &finfo ) == noErr )
- {
- finfo.fdType = 'TEXT' ;
- finfo.fdCreator = 'ttxt' ;
- FSpSetFInfo( &spec , &finfo ) ;
- }
+ wxLogError(_("Failed to update user configuration file."));
+
+ return false;
}
+
+ ResetDirty();
+
+#if defined(__WXMAC__)
+ wxFileName(m_strLocalFile).MacSetTypeAndCreator('TEXT', 'ttxt');
#endif // __WXMAC__
-#ifdef __UNIX__
- // restore the old umask if we changed it
- if ( m_umask != -1 )
- {
- (void)umask(umaskOld);
- }
-#endif // __UNIX__
+ return true;
+}
+
+#if wxUSE_STREAMS
+
+bool wxFileConfig::Save(wxOutputStream& os, wxMBConv& conv)
+{
+ // save unconditionally, even if not dirty
+ for ( wxFileConfigLineList *p = m_linesHead; p != NULL; p = p->Next() )
+ {
+ wxString line = p->Text();
+ line += wxTextFile::GetEOL();
+
+ wxCharBuffer buf(line.mb_str(conv));
+ if ( !os.Write(buf, strlen(buf)) )
+ {
+ wxLogError(_("Error saving user configuration data."));
- return ret;
+ return false;
+ }
+ }
+
+ ResetDirty();
+
+ return true;
}
+#endif // wxUSE_STREAMS
+
// ----------------------------------------------------------------------------
// renaming groups/entries
// ----------------------------------------------------------------------------
bool wxFileConfig::RenameEntry(const wxString& oldName,
const wxString& newName)
{
+ wxASSERT_MSG( !wxStrchr(oldName, wxCONFIG_PATH_SEPARATOR),
+ _T("RenameEntry(): paths are not supported") );
+
// check that the entry exists
wxFileConfigEntry *oldEntry = m_pCurrentGroup->FindEntry(oldName);
if ( !oldEntry )
- return FALSE;
+ return false;
// check that the new entry doesn't already exist
if ( m_pCurrentGroup->FindEntry(newName) )
- return FALSE;
+ return false;
// delete the old entry, create the new one
wxString value = oldEntry->Value();
if ( !m_pCurrentGroup->DeleteEntry(oldName) )
- return FALSE;
+ return false;
+
+ SetDirty();
wxFileConfigEntry *newEntry = m_pCurrentGroup->AddEntry(newName);
newEntry->SetValue(value);
- return TRUE;
+ return true;
}
bool wxFileConfig::RenameGroup(const wxString& oldName,
// check that the group exists
wxFileConfigGroup *group = m_pCurrentGroup->FindSubgroup(oldName);
if ( !group )
- return FALSE;
+ return false;
// check that the new group doesn't already exist
if ( m_pCurrentGroup->FindSubgroup(newName) )
- return FALSE;
+ return false;
group->Rename(newName);
- return TRUE;
+ SetDirty();
+
+ return true;
}
// ----------------------------------------------------------------------------
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 ) {
//else: never delete the root group
}
- return TRUE;
+ return true;
}
bool wxFileConfig::DeleteGroup(const wxString& key)
{
wxConfigPathChanger path(this, key);
- return m_pCurrentGroup->DeleteSubgroupByName(path.Name());
+ if ( !m_pCurrentGroup->DeleteSubgroupByName(path.Name()) )
+ return false;
+
+ SetDirty();
+
+ return true;
}
bool wxFileConfig::DeleteAll()
{
CleanUp();
- if ( wxRemove(m_strLocalFile) == -1 )
- wxLogSysError(_("can't delete user configuration file '%s'"), m_strLocalFile.c_str());
+ if ( !m_strLocalFile.empty() )
+ {
+ if ( wxFile::Exists(m_strLocalFile) && wxRemove(m_strLocalFile) == -1 )
+ {
+ wxLogSysError(_("can't delete user configuration file '%s'"),
+ m_strLocalFile.c_str());
+ return false;
+ }
+
+ m_strLocalFile =
+ m_strGlobalFile = wxEmptyString;
+ }
- m_strLocalFile = m_strGlobalFile = wxT("");
Init();
- return TRUE;
+ return true;
}
// ----------------------------------------------------------------------------
// linked list functions
// ----------------------------------------------------------------------------
-// append a new line to the end of the list
+ // append a new line to the end of the list
+
wxFileConfigLineList *wxFileConfig::LineListAppend(const wxString& str)
{
- wxFileConfigLineList *pLine = new wxFileConfigLineList(str);
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" ** Adding Line '%s'"),
+ str.c_str() );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" head: %s"),
+ ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" tail: %s"),
+ ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) );
- if ( m_linesTail == NULL ) {
- // list is empty
- m_linesHead = pLine;
- }
- else {
- // adjust pointers
- m_linesTail->SetNext(pLine);
- pLine->SetPrev(m_linesTail);
- }
+ 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);
+ }
+
+ m_linesTail = pLine;
- m_linesTail = pLine;
- return m_linesTail;
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" head: %s"),
+ ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" tail: %s"),
+ ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) );
+
+ return m_linesTail;
}
// insert a new line after the given one or in the very beginning if !pLine
wxFileConfigLineList *wxFileConfig::LineListInsert(const wxString& str,
- wxFileConfigLineList *pLine)
-{
- if ( pLine == m_linesTail )
- return LineListAppend(str);
+ wxFileConfigLineList *pLine)
+{
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" ** Inserting Line '%s' after '%s'"),
+ str.c_str(),
+ ((pLine) ? pLine->Text().c_str() : wxEmptyString) );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" head: %s"),
+ ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" tail: %s"),
+ ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) );
+
+ if ( pLine == m_linesTail )
+ return LineListAppend(str);
+
+ wxFileConfigLineList *pNewLine = new wxFileConfigLineList(str);
+ if ( pLine == NULL )
+ {
+ // prepend to the list
+ pNewLine->SetNext(m_linesHead);
+ m_linesHead->SetPrev(pNewLine);
+ m_linesHead = pNewLine;
+ }
+ else
+ {
+ // insert before pLine
+ wxFileConfigLineList *pNext = pLine->Next();
+ pNewLine->SetNext(pNext);
+ pNewLine->SetPrev(pLine);
+ pNext->SetPrev(pNewLine);
+ pLine->SetNext(pNewLine);
+ }
- 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,
+ _T(" head: %s"),
+ ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" tail: %s"),
+ ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) );
- return pNewLine;
+ return pNewLine;
}
void wxFileConfig::LineListRemove(wxFileConfigLineList *pLine)
{
- wxFileConfigLineList *pPrev = pLine->Prev(),
- *pNext = pLine->Next();
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" ** Removing Line '%s'"),
+ pLine->Text().c_str() );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" head: %s"),
+ ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" tail: %s"),
+ ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) );
- // first entry?
- if ( pPrev == NULL )
- m_linesHead = pNext;
- else
- pPrev->SetNext(pNext);
+ wxFileConfigLineList *pPrev = pLine->Prev(),
+ *pNext = pLine->Next();
- // last entry?
- if ( pNext == NULL )
- m_linesTail = pPrev;
- else
- pNext->SetPrev(pPrev);
+ // first entry?
+
+ if ( pPrev == NULL )
+ m_linesHead = pNext;
+ else
+ pPrev->SetNext(pNext);
+
+ // last entry?
+
+ if ( pNext == NULL )
+ m_linesTail = pPrev;
+ else
+ pNext->SetPrev(pPrev);
+
+ if ( m_pRootGroup->GetGroupLine() == pLine )
+ m_pRootGroup->SetLine(m_linesHead);
- delete pLine;
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" head: %s"),
+ ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" tail: %s"),
+ ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) );
+
+ delete pLine;
}
bool wxFileConfig::LineListIsEmpty()
{
- return m_linesHead == NULL;
+ return m_linesHead == NULL;
}
// ============================================================================
{
m_pConfig = pConfig;
m_pParent = pParent;
- m_bDirty = FALSE;
m_pLine = NULL;
m_pLastEntry = NULL;
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,
+ _T("changing line for a non-root group?") );
- m_pLine = pLine;
+ m_pLine = pLine;
}
/*
// have it or in the very beginning if we're the root group.
wxFileConfigLineList *wxFileConfigGroup::GetGroupLine()
{
- if ( m_pLine == NULL ) {
- wxFileConfigGroup *pParent = Parent();
-
- // this group wasn't present in local config file, add it now
- if ( pParent != NULL ) {
- wxString strFullName;
- strFullName << wxT("[")
- // +1: no '/'
- << 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 {
- // we return NULL, so that LineListInsert() will insert us in the
- // very beginning
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" GetGroupLine() for Group '%s'"),
+ Name().c_str() );
+
+ if ( !m_pLine )
+ {
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" Getting Line item pointer") );
+
+ wxFileConfigGroup *pParent = Parent();
+
+ // this group wasn't present in local config file, add it now
+ if ( pParent )
+ {
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" checking parent '%s'"),
+ pParent->Name().c_str() );
+
+ wxString strFullName;
+
+ // add 1 to the name because we don't want to start with '/'
+ strFullName << wxT("[")
+ << FilterOutEntryName(GetFullName().c_str() + 1)
+ << wxT("]");
+ m_pLine = m_pConfig->LineListInsert(strFullName,
+ pParent->GetLastGroupLine());
+ pParent->SetLastGroup(this); // we're surely after all the others
+ }
+ //else: this is the root group and so we return NULL because we don't
+ // have any group line
}
- }
- return m_pLine;
+ return m_pLine;
}
// Return the last line belonging to the subgroups of this group (after which
// 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 != NULL ) {
- wxFileConfigLineList *pLine = m_pLastGroup->GetLastGroupLine();
+ // if we have any subgroups, our last line is the last line of the last
+ // subgroup
+ if ( m_pLastGroup )
+ {
+ wxFileConfigLineList *pLine = m_pLastGroup->GetLastGroupLine();
- wxASSERT( pLine != NULL ); // last group must have !NULL associated line
- return pLine;
- }
+ wxASSERT_MSG( pLine, _T("last group must have !NULL associated line") );
+
+ return pLine;
+ }
- // no subgroups, so the last line is the line of thelast entry (if any)
- return GetLastEntryLine();
+ // no subgroups, so the last line is the line of thelast entry (if any)
+ return GetLastEntryLine();
}
// return the last line belonging to the entries of this group (after which
// one immediately after the group line itself.
wxFileConfigLineList *wxFileConfigGroup::GetLastEntryLine()
{
- if ( m_pLastEntry != NULL ) {
- wxFileConfigLineList *pLine = m_pLastEntry->GetLine();
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" GetLastEntryLine() for Group '%s'"),
+ Name().c_str() );
- wxASSERT( pLine != NULL ); // last entry must have !NULL associated line
- return pLine;
- }
+ if ( m_pLastEntry )
+ {
+ wxFileConfigLineList *pLine = m_pLastEntry->GetLine();
+
+ wxASSERT_MSG( pLine, _T("last entry must have !NULL associated line") );
+
+ return pLine;
+ }
+
+ // no entries: insert after the group header, if any
+ return GetGroupLine();
+}
+
+void wxFileConfigGroup::SetLastEntry(wxFileConfigEntry *pEntry)
+{
+ m_pLastEntry = pEntry;
+
+ if ( !m_pLine )
+ {
+ // the only situation in which a group without its own line can have
+ // an entry is when the first entry is added to the initially empty
+ // root pseudo-group
+ wxASSERT_MSG( !m_pParent, _T("unexpected for non root group") );
- // no entries: 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
// ----------------------------------------------------------------------------
+void wxFileConfigGroup::UpdateGroupAndSubgroupsLines()
+{
+ // update the line of this group
+ wxFileConfigLineList *line = GetGroupLine();
+ wxCHECK_RET( line, _T("a non root group must have a corresponding line!") );
+
+ // +1: skip the leading '/'
+ line->SetText(wxString::Format(_T("[%s]"), GetFullName().c_str() + 1));
+
+
+ // also update all subgroups as they have this groups name in their lines
+ const size_t nCount = m_aSubgroups.Count();
+ for ( size_t n = 0; n < nCount; n++ )
+ {
+ m_aSubgroups[n]->UpdateGroupAndSubgroupsLines();
+ }
+}
+
void wxFileConfigGroup::Rename(const wxString& newName)
{
- m_strName = newName;
+ wxCHECK_RET( m_pParent, _T("the root group can't be renamed") );
- wxFileConfigLineList *line = GetGroupLine();
- wxString strFullName;
- strFullName << wxT("[") << (GetFullName().c_str() + 1) << wxT("]"); // +1: no '/'
- line->SetText(strFullName);
+ m_strName = newName;
- SetDirty();
+ // update the group lines recursively
+ UpdateGroupAndSubgroupsLines();
}
wxString wxFileConfigGroup::GetFullName() const
{
- if ( Parent() )
- return Parent()->GetFullName() + wxCONFIG_PATH_SEPARATOR + Name();
- else
- return wxT("");
+ wxString fullname;
+ if ( Parent() )
+ fullname = Parent()->GetFullName() + wxCONFIG_PATH_SEPARATOR + Name();
+
+ return fullname;
}
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
// create a new entry and add it to the current group
-wxFileConfigEntry *
-wxFileConfigGroup::AddEntry(const wxString& strName, int nLine)
+wxFileConfigEntry *wxFileConfigGroup::AddEntry(const wxString& strName, int nLine)
{
- wxASSERT( FindEntry(strName) == NULL );
+ wxASSERT( FindEntry(strName) == 0 );
- wxFileConfigEntry *pEntry = new wxFileConfigEntry(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
-wxFileConfigGroup *
-wxFileConfigGroup::AddSubgroup(const wxString& strName)
+wxFileConfigGroup *wxFileConfigGroup::AddSubgroup(const wxString& strName)
{
- wxASSERT( FindSubgroup(strName) == NULL );
+ wxASSERT( FindSubgroup(strName) == 0 );
- wxFileConfigGroup *pGroup = new wxFileConfigGroup(this, strName, m_pConfig);
- m_aSubgroups.Add(pGroup);
+ wxFileConfigGroup *pGroup = new wxFileConfigGroup(this, strName, m_pConfig);
- return pGroup;
+ m_aSubgroups.Add(pGroup);
+ return pGroup;
}
// ----------------------------------------------------------------------------
bool wxFileConfigGroup::DeleteSubgroupByName(const wxChar *szName)
{
- return DeleteSubgroup(FindSubgroup(szName));
+ wxFileConfigGroup * const pGroup = FindSubgroup(szName);
+
+ return pGroup ? DeleteSubgroup(pGroup) : false;
}
-// doesn't delete the subgroup itself, but does remove references to it from
-// all other data structures (and normally the returned pointer should be
-// deleted a.s.a.p. because there is nothing much to be done with it anyhow)
+// Delete the subgroup and remove all references to it from
+// other data structures.
bool wxFileConfigGroup::DeleteSubgroup(wxFileConfigGroup *pGroup)
{
- wxCHECK( pGroup != NULL, FALSE ); // deleting non existing group?
+ wxCHECK_MSG( pGroup, false, _T("deleting non existing group?") );
- // delete all entries
- size_t nCount = pGroup->m_aEntries.Count();
- for ( size_t nEntry = 0; nEntry < nCount; nEntry++ ) {
- wxFileConfigLineList *pLine = pGroup->m_aEntries[nEntry]->GetLine();
- if ( pLine != NULL )
- m_pConfig->LineListRemove(pLine);
- }
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T("Deleting group '%s' from '%s'"),
+ pGroup->Name().c_str(),
+ Name().c_str() );
- // and subgroups of this sungroup
- nCount = pGroup->m_aSubgroups.Count();
- for ( size_t nGroup = 0; nGroup < nCount; nGroup++ ) {
- pGroup->DeleteSubgroup(pGroup->m_aSubgroups[0]);
- }
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" (m_pLine) = prev: %p, this %p, next %p"),
+ ((m_pLine) ? m_pLine->Prev() : 0),
+ m_pLine,
+ ((m_pLine) ? m_pLine->Next() : 0) );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" text: '%s'"),
+ ((m_pLine) ? m_pLine->Text().c_str() : wxEmptyString) );
- wxFileConfigLineList *pLine = pGroup->m_pLine;
- if ( pLine != NULL ) {
- // notice that we may do this test inside the previous "if" because the
- // last entry's line is surely !NULL
- if ( pGroup == m_pLastGroup ) {
- // our last entry is being deleted - find the last one which stays
- wxASSERT( m_pLine != NULL ); // we have a subgroup with !NULL pLine...
+ // delete all entries...
+ size_t nCount = pGroup->m_aEntries.Count();
- // go back until we find a subgroup or reach the group's line
- wxFileConfigGroup *pNewLast = NULL;
- size_t n, nSubgroups = m_aSubgroups.Count();
- wxFileConfigLineList *pl;
- for ( pl = pLine->Prev(); pl != m_pLine; pl = pl->Prev() ) {
- // is it our subgroup?
- for ( n = 0; (pNewLast == NULL) && (n < nSubgroups); n++ ) {
- // do _not_ call GetGroupLine! we don't want to add it to the local
- // file if it's not already there
- if ( m_aSubgroups[n]->m_pLine == m_pLine )
- pNewLast = m_aSubgroups[n];
+ wxLogTrace(FILECONF_TRACE_MASK,
+ _T("Removing %lu entries"), (unsigned long)nCount );
+
+ for ( size_t nEntry = 0; nEntry < nCount; nEntry++ )
+ {
+ wxFileConfigLineList *pLine = pGroup->m_aEntries[nEntry]->GetLine();
+
+ if ( pLine )
+ {
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" '%s'"),
+ pLine->Text().c_str() );
+ m_pConfig->LineListRemove(pLine);
}
+ }
- if ( pNewLast != NULL ) // found?
- break;
- }
+ // ...and subgroups of this subgroup
+ nCount = pGroup->m_aSubgroups.Count();
- if ( pl == m_pLine ) {
- wxASSERT( !pNewLast ); // how comes it has the same line as we?
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T("Removing %lu subgroups"), (unsigned long)nCount );
- // we've reached the group line without finding any subgroups
- m_pLastGroup = NULL;
- }
- else
- m_pLastGroup = pNewLast;
+ for ( size_t nGroup = 0; nGroup < nCount; nGroup++ )
+ {
+ pGroup->DeleteSubgroup(pGroup->m_aSubgroups[0]);
}
- m_pConfig->LineListRemove(pLine);
- }
+ // and then finally the group itself
+ wxFileConfigLineList *pLine = pGroup->m_pLine;
+ if ( pLine )
+ {
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" Removing line for group '%s' : '%s'"),
+ pGroup->Name().c_str(),
+ pLine->Text().c_str() );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" Removing from group '%s' : '%s'"),
+ Name().c_str(),
+ ((m_pLine) ? m_pLine->Text().c_str() : wxEmptyString) );
+
+ // notice that we may do this test inside the previous "if"
+ // because the last entry's line is surely !NULL
+ if ( pGroup == m_pLastGroup )
+ {
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" Removing last group") );
+
+ // our last entry is being deleted, so find the last one which
+ // stays by going back until we find a subgroup or reach the
+ // group line
+ const size_t nSubgroups = m_aSubgroups.Count();
+
+ m_pLastGroup = NULL;
+ for ( wxFileConfigLineList *pl = pLine->Prev();
+ pl && pl != m_pLine && !m_pLastGroup;
+ pl = pl->Prev() )
+ {
+ // does this line belong to our subgroup?
+ for ( size_t n = 0; n < nSubgroups; n++ )
+ {
+ // do _not_ call GetGroupLine! we don't want to add it to
+ // the local file if it's not already there
+ if ( m_aSubgroups[n]->m_pLine == pl )
+ {
+ m_pLastGroup = m_aSubgroups[n];
+ break;
+ }
+ }
+ }
+ }
- SetDirty();
+ m_pConfig->LineListRemove(pLine);
+ }
+ else
+ {
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" No line entry for Group '%s'?"),
+ pGroup->Name().c_str() );
+ }
- m_aSubgroups.Remove(pGroup);
- delete pGroup;
+ m_aSubgroups.Remove(pGroup);
+ delete pGroup;
- return TRUE;
+ return true;
}
bool wxFileConfigGroup::DeleteEntry(const wxChar *szName)
{
wxFileConfigEntry *pEntry = FindEntry(szName);
- wxCHECK( pEntry != NULL, FALSE ); // deleting non existing item?
+ if ( !pEntry )
+ {
+ // entry doesn't exist, nothing to do
+ return false;
+ }
wxFileConfigLineList *pLine = pEntry->GetLine();
if ( pLine != NULL ) {
m_pConfig->LineListRemove(pLine);
}
- // we must be written back for the changes to be saved
- SetDirty();
-
m_aEntries.Remove(pEntry);
delete pEntry;
- return TRUE;
-}
-
-// ----------------------------------------------------------------------------
-//
-// ----------------------------------------------------------------------------
-void wxFileConfigGroup::SetDirty()
-{
- m_bDirty = TRUE;
- if ( Parent() != NULL ) // propagate upwards
- Parent()->SetDirty();
+ return true;
}
// ============================================================================
int nLine)
: m_strName(strName)
{
- wxASSERT( !strName.IsEmpty() );
+ wxASSERT( !strName.empty() );
m_pParent = pParent;
m_nLine = nLine;
m_pLine = NULL;
- m_bDirty =
- m_bHasValue = FALSE;
+ m_bHasValue = false;
m_bImmutable = strName[0] == wxCONFIG_IMMUTABLE_PREFIX;
if ( m_bImmutable )
Group()->SetLastEntry(this);
}
-// second parameter is FALSE if we read the value from file and prevents the
+// second parameter is false if we read the value from file and prevents the
// entry from being marked as 'dirty'
void wxFileConfigEntry::SetValue(const wxString& strValue, bool bUser)
{
- if ( bUser && IsImmutable() ) {
- wxLogWarning(_("attempt to change immutable key '%s' ignored."),
- Name().c_str());
- 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;
+ if ( bUser && IsImmutable() )
+ {
+ wxLogWarning( _("attempt to change immutable key '%s' ignored."),
+ Name().c_str());
+ return;
+ }
- m_bHasValue = TRUE;
- m_strValue = strValue;
+ // 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;
- if ( bUser ) {
- wxString strVal = FilterOutValue(strValue);
- wxString strLine;
- strLine << FilterOutEntryName(m_strName) << wxT('=') << strVal;
+ m_bHasValue = true;
+ m_strValue = strValue;
- if ( m_pLine != NULL ) {
- // entry was read from the local config file, just modify the line
- m_pLine->SetText(strLine);
- }
- else {
- // add a new line to the file
- wxASSERT( m_nLine == wxNOT_FOUND ); // consistency check
+ if ( bUser )
+ {
+ wxString strValFiltered;
- m_pLine = Group()->Config()->LineListInsert(strLine,
- Group()->GetLastEntryLine());
- Group()->SetLastEntry(this);
- }
+ if ( Group()->Config()->GetStyle() & wxCONFIG_USE_NO_ESCAPE_CHARACTERS )
+ {
+ strValFiltered = strValue;
+ }
+ else {
+ strValFiltered = FilterOutValue(strValue);
+ }
- SetDirty();
- }
-}
+ wxString strLine;
+ strLine << FilterOutEntryName(m_strName) << wxT('=') << strValFiltered;
-void wxFileConfigEntry::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);
+ }
+ }
}
// ============================================================================
wxString strResult;
strResult.Alloc(str.Len());
- bool bQuoted = !str.IsEmpty() && str[0] == '"';
+ bool bQuoted = !str.empty() && str[0] == '"';
for ( size_t n = bQuoted ? 1 : 0; n < str.Len(); n++ ) {
if ( str[n] == wxT('\\') ) {
strResult.Alloc(str.Len());
for ( const wxChar *pc = str.c_str(); *pc != wxT('\0'); pc++ ) {
- wxChar c = *pc;
+ const wxChar c = *pc;
// we explicitly allow some of "safe" chars and 8bit ASCII characters
- // which will probably never have special meaning
+ // which will probably never have special meaning and with which we can't
+ // use isalnum() anyhow (in ASCII built, in Unicode it's just fine)
+ //
// NB: note that wxCONFIG_IMMUTABLE_PREFIX and wxCONFIG_PATH_SEPARATOR
// should *not* be quoted
- if ( !wxIsalnum(c) && !wxStrchr(wxT("@_/-!.*%"), c) && ((c & 0x80) == 0) )
+ if (
+#if !wxUSE_UNICODE
+ ((unsigned char)c < 127) &&
+#endif // ANSI
+ !wxIsalnum(c) && !wxStrchr(wxT("@_/-!.*%"), c) )
+ {
strResult += wxT('\\');
+ }
strResult += c;
}
}
#endif // wxUSE_CONFIG
-
projects / wxWidgets.git / blobdiff