Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
7228ab483e3b0fc1d341d4cf1723e5c39096c63e
wxWidgets/src/common/fileconf.cpp
Vadim Zeitlin 7228ab483e warning under gcc removed 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@320 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
1998-07-22 11:33:15 +00:00

1292 lines
35 KiB
C++
Raw Blame History

///////////////////////////////////////////////////////////////////////////////
// Name: 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
// Ballueder@usa.net <zeitlin@dptmaths.ens-cachan.fr>
// Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////////
#ifdef __GNUG__
#pragma implementation "fileconf.h"
#endif
// ============================================================================
// declarations
// ============================================================================
// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------
#include "wx/wxprec.h"
#ifdef __BORLANDC__
#pragma hdrstop
#endif //__BORLANDC__
#ifndef WX_PRECOMP
#include <wx/string.h>
#include <wx/intl.h>
#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>
#endif //windows.h
#include <stdlib.h>
#include <ctype.h>
// ----------------------------------------------------------------------------
// macros
// ----------------------------------------------------------------------------
#define CONST_CAST ((wxFileConfig *)this)->
// ----------------------------------------------------------------------------
// 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 CompareEntries(wxFileConfig::ConfigEntry *p1,
wxFileConfig::ConfigEntry *p2);
static int CompareGroups(wxFileConfig::ConfigGroup *p1,
wxFileConfig::ConfigGroup *p2);
// filter strings
static wxString FilterIn(const wxString& str);
static wxString FilterOut(const wxString& str);
// ============================================================================
// implementation
// ============================================================================
// ----------------------------------------------------------------------------
// static functions
// ----------------------------------------------------------------------------
wxString wxFileConfig::GetGlobalFileName(const char *szFile)
{
wxString str;
bool bNoExt = strchr(szFile, '.') == NULL;
#ifdef __UNIX__
str << "/etc/" << szFile;
if ( bNoExt )
str << ".conf";
#else // Windows
#ifndef _MAX_PATH
#define _MAX_PATH 512
#endif
char szWinDir[_MAX_PATH];
::GetWindowsDirectory(szWinDir, _MAX_PATH);
str << szWinDir << "\\" << szFile;
if ( bNoExt )
str << ".ini";
#endif // UNIX/Win
return str;
}
wxString wxFileConfig::GetLocalFileName(const char *szFile)
{
wxString str;
#ifdef __UNIX__
const char *szHome = getenv("HOME");
if ( szHome == NULL ) {
// we're homeless...
wxLogWarning(_("can't find user's HOME, using current directory."));
szHome = ".";
}
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;
}
// ----------------------------------------------------------------------------
// ctor
// ----------------------------------------------------------------------------
void wxFileConfig::Init()
{
m_pCurrentGroup =
m_pRootGroup = new ConfigGroup(NULL, "", this);
m_linesHead =
m_linesTail = NULL;
m_strPath.Empty();
}
wxFileConfig::wxFileConfig(const wxString& strLocal, const wxString& strGlobal)
: m_strLocalFile(strLocal), m_strGlobalFile(strGlobal)
{
Init();
// it's not an error if (one of the) file(s) doesn't exist
// parse the global file
if ( !strGlobal.IsEmpty() ) {
if ( wxFile::Exists(strGlobal) ) {
wxTextFile fileGlobal(strGlobal);
if ( fileGlobal.Open() ) {
Parse(fileGlobal, FALSE /* global */);
SetRootPath();
}
else
wxLogWarning(_("can't open global configuration file '%s'."),
strGlobal.c_str());
}
}
// parse the local file
if ( wxFile::Exists(strLocal) ) {
wxTextFile fileLocal(strLocal);
if ( fileLocal.Open() ) {
Parse(fileLocal, TRUE /* local */);
SetRootPath();
}
else
wxLogWarning(_("can't open user configuration file '%s'."),
strLocal.c_str());
}
}
wxFileConfig::~wxFileConfig()
{
Flush();
delete m_pRootGroup;
LineList *pCur = m_linesHead;
while ( pCur != NULL ) {
LineList *pNext = pCur->Next();
delete pCur;
pCur = pNext;
}
}
// ----------------------------------------------------------------------------
// parse a config file
// ----------------------------------------------------------------------------
void wxFileConfig::Parse(wxTextFile& file, bool bLocal)
{
const char *pStart;
const char *pEnd;
wxString strLine;
uint nLineCount = file.GetLineCount();
for ( uint n = 0; n < nLineCount; n++ ) {
strLine = file[n];
// add the line to linked list
if ( bLocal )
LineListAppend(strLine);
// skip leading spaces
for ( pStart = strLine; isspace(*pStart); pStart++ )
;
// skip blank/comment lines
if ( *pStart == '\0'|| *pStart == ';' || *pStart == '#' )
continue;
if ( *pStart == '[' ) { // a new group
pEnd = pStart;
while ( *++pEnd != ']' ) {
if ( !IsValid(*pEnd) && *pEnd != ' ' ) // allow spaces in group names
break;
}
if ( *pEnd != ']' ) {
wxLogError(_("file '%s': unexpected character %c at line %d."),
file.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);
// will create it if doesn't yet exist
SetPath(strGroup);
if ( bLocal )
m_pCurrentGroup->SetLine(m_linesTail);
// check that there is nothing except comments left on this line
bool bCont = TRUE;
while ( *++pEnd != '\0' && bCont ) {
switch ( *pEnd ) {
case '#':
case ';':
bCont = FALSE;
break;
case ' ':
case '\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;
}
}
}
else { // a key
const char *pEnd = pStart;
while ( IsValid(*pEnd) )
pEnd++;
wxString strKey(pStart, pEnd);
// skip whitespace
while ( isspace(*pEnd) )
pEnd++;
if ( *pEnd++ != '=' ) {
wxLogError(_("file '%s', line %d: '=' expected."),
file.GetName(), n + 1);
}
else {
ConfigEntry *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());
continue;
}
// the condition below catches the cases (a) and (b) but not (c):
// (a) global key found second time in global file
// (b) key found second (or more) time in local file
// (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());
if ( bLocal )
pEntry->SetLine(m_linesTail);
}
}
// skip whitespace
while ( isspace(*pEnd) )
pEnd++;
pEntry->SetValue(FilterIn(pEnd), FALSE /* read from file */);
}
}
}
}
// ----------------------------------------------------------------------------
// set/retrieve path
// ----------------------------------------------------------------------------
void wxFileConfig::SetRootPath()
{
m_strPath.Empty();
m_pCurrentGroup = m_pRootGroup;
}
void wxFileConfig::SetPath(const wxString& strPath)
{
wxArrayString aParts;
if ( strPath.IsEmpty() ) {
SetRootPath();
return;
}
if ( strPath[0] == APPCONF_PATH_SEPARATOR ) {
// absolute path
wxSplitPath(aParts, strPath);
}
else {
// relative path, combine with current one
wxString strFullPath = m_strPath;
strFullPath << APPCONF_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;
}
// recombine path parts in one variable
m_strPath.Empty();
for ( n = 0; n < aParts.Count(); n++ ) {
m_strPath << APPCONF_PATH_SEPARATOR << aParts[n];
}
}
// ----------------------------------------------------------------------------
// enumeration
// ----------------------------------------------------------------------------
bool wxFileConfig::GetFirstGroup(wxString& str, long& lIndex)
{
lIndex = 0;
return GetNextGroup(str, lIndex);
}
bool wxFileConfig::GetNextGroup (wxString& str, long& lIndex)
{
if ( uint(lIndex) < m_pCurrentGroup->Groups().Count() ) {
str = m_pCurrentGroup->Groups()[lIndex++]->Name();
return TRUE;
}
else
return FALSE;
}
bool wxFileConfig::GetFirstEntry(wxString& str, long& lIndex)
{
lIndex = 0;
return GetNextEntry(str, lIndex);
}
bool wxFileConfig::GetNextEntry (wxString& str, long& lIndex)
{
if ( uint(lIndex) < m_pCurrentGroup->Entries().Count() ) {
str = m_pCurrentGroup->Entries()[lIndex++]->Name();
return TRUE;
}
else
return FALSE;
}
uint wxFileConfig::GetNumberOfEntries(bool bRecursive) const
{
uint n = m_pCurrentGroup->Entries().Count();
if ( bRecursive ) {
ConfigGroup *pOldCurrentGroup = m_pCurrentGroup;
uint nSubgroups = m_pCurrentGroup->Groups().Count();
for ( uint nGroup = 0; nGroup < nSubgroups; nGroup++ ) {
CONST_CAST m_pCurrentGroup = m_pCurrentGroup->Groups()[nGroup];
n += GetNumberOfEntries(TRUE);
CONST_CAST m_pCurrentGroup = pOldCurrentGroup;
}
}
return n;
}
uint wxFileConfig::GetNumberOfGroups(bool bRecursive) const
{
uint n = m_pCurrentGroup->Groups().Count();
if ( bRecursive ) {
ConfigGroup *pOldCurrentGroup = m_pCurrentGroup;
uint nSubgroups = m_pCurrentGroup->Groups().Count();
for ( uint nGroup = 0; nGroup < nSubgroups; nGroup++ ) {
CONST_CAST m_pCurrentGroup = m_pCurrentGroup->Groups()[nGroup];
n += GetNumberOfGroups(TRUE);
CONST_CAST m_pCurrentGroup = pOldCurrentGroup;
}
}
return n;
}
// ----------------------------------------------------------------------------
// tests for existence
// ----------------------------------------------------------------------------
bool wxFileConfig::HasGroup(const wxString& strName) const
{
PathChanger path(this, strName);
ConfigGroup *pGroup = m_pCurrentGroup->FindSubgroup(path.Name());
return pGroup != NULL;
}
bool wxFileConfig::HasEntry(const wxString& strName) const
{
PathChanger path(this, strName);
ConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name());
return pEntry != NULL;
}
// ----------------------------------------------------------------------------
// read/write values
// ----------------------------------------------------------------------------
bool wxFileConfig::Read(wxString *pstr,
const char *szKey,
const char *szDefault) const
{
PathChanger path(this, szKey);
ConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name());
if (pEntry == NULL) {
*pstr = ExpandEnvVars(szDefault);
return FALSE;
}
else {
*pstr = ExpandEnvVars(pEntry->Value());
return TRUE;
}
}
const char *wxFileConfig::Read(const char *szKey,
const char *szDefault) const
{
static wxString s_str;
Read(&s_str, szKey, szDefault);
return s_str.c_str();
}
bool wxFileConfig::Read(long *pl, const char *szKey, long lDefault) const
{
wxString str;
if ( Read(&str, szKey) ) {
*pl = atol(str);
return TRUE;
}
else {
*pl = lDefault;
return FALSE;
}
}
bool wxFileConfig::Write(const char *szKey, const char *szValue)
{
PathChanger path(this, szKey);
wxString strName = path.Name();
if ( strName.IsEmpty() ) {
// setting the value of a group is an error
wxASSERT_MSG( IsEmpty(szValue), "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();
// 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] == APPCONF_IMMUTABLE_PREFIX ) {
wxLogError(_("Entry name can't start with '%c'."),
APPCONF_IMMUTABLE_PREFIX);
return FALSE;
}
for ( const char *pc = strName; *pc != '\0'; pc++ ) {
if ( !IsValid(*pc) ) {
wxLogError(_("Character '%c' is invalid in a config entry name."),
*pc);
return FALSE;
}
}
ConfigEntry *pEntry = m_pCurrentGroup->FindEntry(strName);
if ( pEntry == NULL )
pEntry = m_pCurrentGroup->AddEntry(strName);
pEntry->SetValue(szValue);
}
return TRUE;
}
bool wxFileConfig::Write(const char *szKey, long lValue)
{
// ltoa() is not ANSI :-(
char szBuf[40]; // should be good for sizeof(long) <= 16 (128 bits)
sprintf(szBuf, "%ld", lValue);
return Write(szKey, szBuf);
}
bool wxFileConfig::Flush(bool /* bCurrentOnly */)
{
if ( LineListIsEmpty() || !m_pRootGroup->IsDirty() )
return TRUE;
wxTempFile file(m_strLocalFile);
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;
}
}
return file.Commit();
}
// ----------------------------------------------------------------------------
// delete groups/entries
// ----------------------------------------------------------------------------
bool wxFileConfig::DeleteEntry(const char *szKey, bool bGroupIfEmptyAlso)
{
PathChanger path(this, szKey);
if ( !m_pCurrentGroup->DeleteEntry(path.Name()) )
return FALSE;
if ( bGroupIfEmptyAlso && m_pCurrentGroup->IsEmpty() ) {
if ( m_pCurrentGroup != m_pRootGroup ) {
ConfigGroup *pGroup = m_pCurrentGroup;
SetPath(".."); // changes m_pCurrentGroup!
m_pCurrentGroup->DeleteSubgroup(pGroup->Name());
}
//else: never delete the root group
}
return TRUE;
}
bool wxFileConfig::DeleteGroup(const char *szKey)
{
PathChanger path(this, szKey);
return m_pCurrentGroup->DeleteSubgroup(path.Name());
}
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);
szFile = m_strGlobalFile;
if ( remove(szFile) )
wxLogSysError(_("can't delete system configuration file '%s'"), szFile);
return TRUE;
}
// ----------------------------------------------------------------------------
// linked list functions
// ----------------------------------------------------------------------------
// append a new line to the end of the list
wxFileConfig::LineList *wxFileConfig::LineListAppend(const wxString& str)
{
LineList *pLine = new LineList(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;
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);
}
return pNewLine;
}
void wxFileConfig::LineListRemove(LineList *pLine)
{
LineList *pPrev = pLine->Prev(),
*pNext = pLine->Next();
// first entry?
if ( pPrev == NULL )
m_linesHead = pNext;
else
pPrev->SetNext(pNext);
// last entry?
if ( pNext == NULL )
m_linesTail = pPrev;
else
pNext->SetPrev(pPrev);
delete pLine;
}
bool wxFileConfig::LineListIsEmpty()
{
return m_linesHead == NULL;
}
// ============================================================================
// wxFileConfig::ConfigGroup
// ============================================================================
// ----------------------------------------------------------------------------
// ctor/dtor
// ----------------------------------------------------------------------------
// ctor
wxFileConfig::ConfigGroup::ConfigGroup(wxFileConfig::ConfigGroup *pParent,
const wxString& strName,
wxFileConfig *pConfig)
: m_aEntries(CompareEntries),
m_aSubgroups(CompareGroups),
m_strName(strName)
{
m_pConfig = pConfig;
m_pParent = pParent;
m_bDirty = FALSE;
m_pLine = NULL;
m_pLastEntry = NULL;
m_pLastGroup = NULL;
}
// dtor deletes all children
wxFileConfig::ConfigGroup::~ConfigGroup()
{
// entries
uint n, nCount = m_aEntries.Count();
for ( n = 0; n < nCount; n++ )
delete m_aEntries[n];
// subgroups
nCount = m_aSubgroups.Count();
for ( n = 0; n < nCount; n++ )
delete m_aSubgroups[n];
}
// ----------------------------------------------------------------------------
// line
// ----------------------------------------------------------------------------
void wxFileConfig::ConfigGroup::SetLine(LineList *pLine)
{
wxASSERT( m_pLine == NULL ); // shouldn't be called twice
m_pLine = pLine;
}
/*
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.
wxFileConfig::LineList *wxFileConfig::ConfigGroup::GetGroupLine()
{
if ( m_pLine == NULL ) {
ConfigGroup *pParent = Parent();
// this group wasn't present in local config file, add it now
if ( pParent != NULL ) {
wxString strFullName;
strFullName << "[" << GetFullName().c_str() + 1 << "]"; // +1: no '/'
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
}
}
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.
wxFileConfig::LineList *wxFileConfig::ConfigGroup::GetLastGroupLine()
{
// if we have any subgroups, our last line is the last line of the last
// subgroup
if ( m_pLastGroup != NULL ) {
wxFileConfig::LineList *pLine = m_pLastGroup->GetLastGroupLine();
wxASSERT( pLine != NULL ); // 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();
}
// return the last line belonging to the entries of this group (after which
// we can add a new entry), if we don't have any entries we will add the new
// one immediately after the group line itself.
wxFileConfig::LineList *wxFileConfig::ConfigGroup::GetLastEntryLine()
{
if ( m_pLastEntry != NULL ) {
wxFileConfig::LineList *pLine = m_pLastEntry->GetLine();
wxASSERT( pLine != NULL ); // last entry must have !NULL associated line
return pLine;
}
// no entries: insert after the group header
return GetGroupLine();
}
// ----------------------------------------------------------------------------
// group name
// ----------------------------------------------------------------------------
wxString wxFileConfig::ConfigGroup::GetFullName() const
{
if ( Parent() )
return Parent()->GetFullName() + APPCONF_PATH_SEPARATOR + Name();
else
return "";
}
// ----------------------------------------------------------------------------
// find an item
// ----------------------------------------------------------------------------
// use binary search because the array is sorted
wxFileConfig::ConfigEntry *
wxFileConfig::ConfigGroup::FindEntry(const char *szName) const
{
uint i,
lo = 0,
hi = m_aEntries.Count();
int res;
wxFileConfig::ConfigEntry *pEntry;
while ( lo < hi ) {
i = (lo + hi)/2;
pEntry = m_aEntries[i];
#if APPCONF_CASE_SENSITIVE
res = strcmp(pEntry->Name(), szName);
#else
res = Stricmp(pEntry->Name(), szName);
#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
{
uint i,
lo = 0,
hi = m_aSubgroups.Count();
int res;
wxFileConfig::ConfigGroup *pGroup;
while ( lo < hi ) {
i = (lo + hi)/2;
pGroup = m_aSubgroups[i];
#if APPCONF_CASE_SENSITIVE
res = strcmp(pGroup->Name(), szName);
#else
res = Stricmp(pGroup->Name(), szName);
#endif
if ( res > 0 )
hi = i;
else if ( res < 0 )
lo = i + 1;
else
return pGroup;
}
return NULL;
}
// ----------------------------------------------------------------------------
// create a new item
// ----------------------------------------------------------------------------
// create a new entry and add it to the current group
wxFileConfig::ConfigEntry *
wxFileConfig::ConfigGroup::AddEntry(const wxString& strName, int nLine)
{
wxASSERT( FindEntry(strName) == NULL );
ConfigEntry *pEntry = new ConfigEntry(this, strName, nLine);
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)
{
wxASSERT( FindSubgroup(strName) == NULL );
ConfigGroup *pGroup = new ConfigGroup(this, strName, m_pConfig);
m_aSubgroups.Add(pGroup);
return pGroup;
}
// ----------------------------------------------------------------------------
// delete an item
// ----------------------------------------------------------------------------
/*
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 wxFileConfig::ConfigGroup::DeleteSubgroup(const char *szName)
{
ConfigGroup *pGroup = FindSubgroup(szName);
wxCHECK( pGroup != NULL, FALSE ); // deleting non existing group?
// delete all entries
uint nCount = pGroup->m_aEntries.Count();
for ( uint nEntry = 0; nEntry < nCount; nEntry++ ) {
LineList *pLine = pGroup->m_aEntries[nEntry]->GetLine();
if ( pLine != NULL )
m_pConfig->LineListRemove(pLine);
}
LineList *pLine = pGroup->m_pLine;
if ( pLine != NULL ) {
// notice that we may do this test inside the previous "if" because the
// last entry's line is surely !NULL
if ( pGroup == m_pLastGroup ) {
// our last entry is being deleted - find the last one which stays
wxASSERT( m_pLine != NULL ); // we have a subgroup with !NULL pLine...
// go back until we find a subgroup or reach the group's line
ConfigGroup *pNewLast = NULL;
uint n, nSubgroups = m_aSubgroups.Count();
LineList *pl;
for ( pl = pLine->Prev(); pl != m_pLine; pl = pl->Prev() ) {
// is it our subgroup?
for ( n = 0; (pNewLast == NULL) && (n < nSubgroups); n++ ) {
// do _not_ call GetGroupLine! we don't want to add it to the local
// file if it's not already there
if ( m_aSubgroups[n]->m_pLine == m_pLine )
pNewLast = m_aSubgroups[n];
}
if ( pNewLast != NULL ) // found?
break;
}
if ( pl == m_pLine ) {
wxASSERT( !pNewLast ); // how comes it has the same line as we?
// we've reached the group line without finding any subgroups
m_pLastGroup = NULL;
}
else
m_pLastGroup = pNewLast;
}
m_pConfig->LineListRemove(pLine);
}
SetDirty();
m_aSubgroups.Remove(pGroup);
delete pGroup;
return TRUE;
}
bool wxFileConfig::ConfigGroup::DeleteEntry(const char *szName)
{
ConfigEntry *pEntry = FindEntry(szName);
wxCHECK( pEntry != NULL, FALSE ); // deleting non existing item?
LineList *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...
// go back until we find another entry or reach the group's line
ConfigEntry *pNewLast = NULL;
uint n, nEntries = m_aEntries.Count();
LineList *pl;
for ( pl = pLine->Prev(); pl != m_pLine; pl = pl->Prev() ) {
// is it our subgroup?
for ( n = 0; (pNewLast == NULL) && (n < nEntries); n++ ) {
if ( m_aEntries[n]->GetLine() == m_pLine )
pNewLast = m_aEntries[n];
}
if ( pNewLast != NULL ) // found?
break;
}
if ( pl == m_pLine ) {
wxASSERT( !pNewLast ); // how comes it has the same line as we?
// we've reached the group line without finding any subgroups
m_pLastEntry = NULL;
}
else
m_pLastEntry = pNewLast;
}
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 wxFileConfig::ConfigGroup::SetDirty()
{
m_bDirty = TRUE;
if ( Parent() != NULL ) // propagate upwards
Parent()->SetDirty();
}
// ============================================================================
// wxFileConfig::ConfigEntry
// ============================================================================
// ----------------------------------------------------------------------------
// ctor
// ----------------------------------------------------------------------------
wxFileConfig::ConfigEntry::ConfigEntry(wxFileConfig::ConfigGroup *pParent,
const wxString& strName,
int nLine)
: m_strName(strName)
{
wxASSERT( !strName.IsEmpty() );
m_pParent = pParent;
m_nLine = nLine;
m_pLine = NULL;
m_bDirty = FALSE;
m_bImmutable = strName[0] == APPCONF_IMMUTABLE_PREFIX;
if ( m_bImmutable )
m_strName.erase(0, 1); // remove first character
}
// ----------------------------------------------------------------------------
// set value
// ----------------------------------------------------------------------------
void wxFileConfig::ConfigEntry::SetLine(LineList *pLine)
{
if ( m_pLine != NULL ) {
wxLogWarning(_("entry '%s' appears more than once in group '%s'"),
Name().c_str(), m_pParent->GetFullName().c_str());
}
m_pLine = pLine;
Group()->SetLastEntry(this);
}
// 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)
{
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;
m_strValue = strValue;
if ( bUser ) {
wxString strVal = FilterOut(strValue);
wxString strLine;
strLine << m_strName << " = " << strVal;
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
m_pLine = Group()->Config()->LineListInsert(strLine,
Group()->GetLastEntryLine());
Group()->SetLastEntry(this);
}
SetDirty();
}
}
void wxFileConfig::ConfigEntry::SetDirty()
{
m_bDirty = TRUE;
Group()->SetDirty();
}
// ============================================================================
// global functions
// ============================================================================
// ----------------------------------------------------------------------------
// compare functions for array sorting
// ----------------------------------------------------------------------------
int CompareEntries(wxFileConfig::ConfigEntry *p1,
wxFileConfig::ConfigEntry *p2)
{
#if APPCONF_CASE_SENSITIVE
return strcmp(p1->Name(), p2->Name());
#else
return Stricmp(p1->Name(), p2->Name());
#endif
}
int CompareGroups(wxFileConfig::ConfigGroup *p1,
wxFileConfig::ConfigGroup *p2)
{
#if APPCONF_CASE_SENSITIVE
return strcmp(p1->Name(), p2->Name());
#else
return Stricmp(p1->Name(), p2->Name());
#endif
}
// ----------------------------------------------------------------------------
// filter functions
// ----------------------------------------------------------------------------
// undo FilterOut
wxString FilterIn(const wxString& str)
{
wxString strResult;
strResult.Alloc(str.Len());
bool bQuoted = !str.IsEmpty() && str[0] == '"';
for ( uint n = bQuoted ? 1 : 0; n < str.Len(); n++ ) {
if ( str[n] == '\\' ) {
switch ( str[++n] ) {
case 'n':
strResult += '\n';
break;
case 'r':
strResult += '\r';
break;
case 't':
strResult += '\t';
break;
case '\\':
strResult += '\\';
break;
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
}
}
return strResult;
}
// quote the string before writing it to file
wxString FilterOut(const wxString& 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] == '"';
if ( bQuote )
strResult += '"';
char c;
for ( uint n = 0; n < str.Len(); n++ ) {
switch ( str[n] ) {
case '\n':
c = 'n';
break;
case '\r':
c = 'r';
break;
case '\t':
c = 't';
break;
case '\\':
c = '\\';
break;
case '"':
if ( bQuote )
c = '"';
//else: fall through
default:
strResult += str[n];
continue; // nothing special to do
}
// we get here only for special characters
strResult << '\\' << c;
}
if ( bQuote )
strResult += '"';
return strResult;
}
Reference in New Issue View Git Blame Copy Permalink