///////////////////////////////////////////////////////////////////////////////
-// Name: fileconf.cpp
+// Name: src/common/fileconf.cpp
// Purpose: implementation of wxFileConfig derivation of wxConfig
// Author: Vadim Zeitlin
// Modified by:
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma implementation "fileconf.h"
-#endif
-
// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------
#include "wx/memtext.h"
#include "wx/config.h"
#include "wx/fileconf.h"
+#include "wx/filefn.h"
#if wxUSE_STREAMS
#include "wx/stream.h"
#if defined(__WXMAC__)
#include "wx/mac/private.h" // includes mac headers
+ #include "wx/filename.h" // for MacSetTypeAndCreator
#endif
#if defined(__WXMSW__)
#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
// ----------------------------------------------------------------------------
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!
strDir = wxMacFindFolder( (short) kOnSystemDisk, kPreferencesFolderType, kDontCreateFolder ) ;
#elif defined( __UNIX__ )
strDir = wxT("/etc/");
-#elif defined(__WXPM__)
+#elif defined(__OS2__)
ULONG aulSysInfo[QSV_MAX] = {0};
UINT drive;
APIRET rc;
strDir.Printf(wxT("%c:\\OS2\\"), 'A'+drive-1);
}
#elif defined(__WXSTUBS__)
- wxASSERT_MSG( FALSE, wxT("TODO") ) ;
+ 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(".\\");
+ strDir = wxT(".\\");
+#elif defined(__WXWINCE__)
+ strDir = wxT("\\Windows\\");
#else // Windows
+
wxChar szWinDir[MAX_PATH];
::GetWindowsDirectory(szWinDir, MAX_PATH);
void wxFileConfig::Init()
{
m_pCurrentGroup =
- m_pRootGroup = new wxFileConfigGroup(NULL, wxT(""), this);
+ m_pRootGroup = new wxFileConfigGroup(NULL, wxEmptyString, this);
m_linesHead =
m_linesTail = NULL;
// 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) )
+ if ( !m_strGlobalFile.empty() && wxFile::Exists(m_strGlobalFile) )
{
wxTextFile fileGlobal(m_strGlobalFile);
if ( fileGlobal.Open(m_conv/*ignored in ANSI build*/) )
{
- Parse(fileGlobal, FALSE /* global */);
+ Parse(fileGlobal, false /* global */);
SetRootPath();
}
else
}
// parse the local file
- if ( !m_strLocalFile.IsEmpty() && wxFile::Exists(m_strLocalFile) )
+ 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 */);
+ Parse(fileLocal, true /* local */);
SetRootPath();
}
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
m_conv(conv)
{
// Make up names for files if empty
- if ( m_strLocalFile.IsEmpty() && (style & wxCONFIG_USE_LOCAL_FILE) )
+ if ( m_strLocalFile.empty() && (style & wxCONFIG_USE_LOCAL_FILE) )
m_strLocalFile = GetLocalFileName(GetAppName());
- if ( m_strGlobalFile.IsEmpty() && (style & wxCONFIG_USE_GLOBAL_FILE) )
+ 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() )
+ if ( !m_strLocalFile.empty() )
SetStyle(GetStyle() | wxCONFIG_USE_LOCAL_FILE);
- if ( !m_strGlobalFile.IsEmpty() )
+ 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) )
+ if ( !m_strLocalFile.empty() && !wxIsAbsolutePath(m_strLocalFile) )
{
- wxString strLocal = m_strLocalFile;
+ const wxString strLocalOrig = m_strLocalFile;
m_strLocalFile = GetLocalDir();
- m_strLocalFile << strLocal;
+ m_strLocalFile << strLocalOrig;
}
- if ( !m_strGlobalFile.IsEmpty() && !wxIsAbsolutePath(m_strGlobalFile) )
+ if ( !m_strGlobalFile.empty() && !wxIsAbsolutePath(m_strGlobalFile) )
{
- wxString strGlobal = m_strGlobalFile;
+ const wxString strGlobalOrig = m_strGlobalFile;
m_strGlobalFile = GetGlobalDir();
- m_strGlobalFile << strGlobal;
+ m_strGlobalFile << strGlobalOrig;
}
}
#if wxUSE_STREAMS
wxFileConfig::wxFileConfig(wxInputStream &inStream, wxMBConv& conv)
- : m_conv(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, wxT(""), this);
+ m_pRootGroup = new wxFileConfigGroup(NULL, wxEmptyString, this);
m_linesHead =
m_linesTail = NULL;
char buf[1024];
do
{
- inStream.Read(buf, WXSIZEOF(buf));
+ inStream.Read(buf, WXSIZEOF(buf)-1); // leave room for the NULL
const wxStreamError err = inStream.GetLastError();
break;
}
- strTmp.append(wxConvertMB2WX(buf), inStream.LastRead());
+ // 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() );
}
// 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
void wxFileConfig::CleanUp()
{
- delete m_pRootGroup;
+ delete m_pRootGroup;
- wxFileConfigLineList *pCur = m_linesHead;
- while ( pCur != NULL ) {
- wxFileConfigLineList *pNext = pCur->Next();
- delete pCur;
- pCur = pNext;
- }
+ wxFileConfigLineList *pCur = m_linesHead;
+ while ( pCur != NULL ) {
+ wxFileConfigLineList *pNext = pCur->Next();
+ delete pCur;
+ pCur = pNext;
+ }
}
wxFileConfig::~wxFileConfig()
{
- Flush();
+ Flush();
- CleanUp();
+ CleanUp();
}
// ----------------------------------------------------------------------------
// 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;
{
LineListAppend(strLine);
- // let the root group have it start line as well
+ // let the root group have its start line as well
if ( !n )
{
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;
+ pEnd = pStart;
while ( *pEnd && *pEnd != wxT('=') /* && !wxIsspace(*pEnd)*/ ) {
if ( *pEnd == wxT('\\') ) {
// next character may be space or not - still take it because it's
if ( !(GetStyle() & wxCONFIG_USE_NO_ESCAPE_CHARACTERS) )
value = FilterInValue(value);
- pEntry->SetValue(value, FALSE);
+ 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] == 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);
- }
+ 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
- size_t n;
- m_pCurrentGroup = m_pRootGroup;
- for ( n = 0; n < aParts.Count(); n++ ) {
- wxFileConfigGroup *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.Count(); n++ ) {
+ wxFileConfigGroup *pNextGroup = m_pCurrentGroup->FindSubgroup(aParts[n]);
+ if ( pNextGroup == NULL )
+ {
+ if ( !createMissingComponents )
+ return false;
- // recombine path parts in one variable
- m_strPath.Empty();
- for ( n = 0; n < aParts.Count(); n++ ) {
- m_strPath << wxCONFIG_PATH_SEPARATOR << aParts[n];
- }
+ 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 << wxCONFIG_PATH_SEPARATOR << aParts[n];
+ }
+
+ return true;
+}
+
+void wxFileConfig::SetPath(const wxString& strPath)
+{
+ DoSetPath(strPath, true /* create missing path components */);
}
// ----------------------------------------------------------------------------
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) const
{
- if ( size_t(lIndex) < m_pCurrentGroup->Groups().Count() ) {
- str = m_pCurrentGroup->Groups()[(size_t)lIndex++]->Name();
- return TRUE;
- }
- else
- return FALSE;
+ if ( size_t(lIndex) < m_pCurrentGroup->Groups().Count() ) {
+ str = m_pCurrentGroup->Groups()[(size_t)lIndex++]->Name();
+ return true;
+ }
+ else
+ return false;
}
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) const
{
- if ( size_t(lIndex) < m_pCurrentGroup->Entries().Count() ) {
- str = m_pCurrentGroup->Entries()[(size_t)lIndex++]->Name();
- return TRUE;
- }
- else
- return FALSE;
+ if ( size_t(lIndex) < m_pCurrentGroup->Entries().Count() ) {
+ 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().Count();
- if ( bRecursive ) {
- wxFileConfigGroup *pOldCurrentGroup = m_pCurrentGroup;
- size_t nSubgroups = m_pCurrentGroup->Groups().Count();
- for ( size_t nGroup = 0; nGroup < nSubgroups; nGroup++ ) {
- CONST_CAST m_pCurrentGroup = m_pCurrentGroup->Groups()[nGroup];
- n += GetNumberOfEntries(TRUE);
- CONST_CAST m_pCurrentGroup = pOldCurrentGroup;
+ size_t n = m_pCurrentGroup->Entries().Count();
+ if ( bRecursive ) {
+ wxFileConfigGroup *pOldCurrentGroup = m_pCurrentGroup;
+ size_t nSubgroups = m_pCurrentGroup->Groups().Count();
+ for ( size_t nGroup = 0; nGroup < nSubgroups; nGroup++ ) {
+ CONST_CAST m_pCurrentGroup = m_pCurrentGroup->Groups()[nGroup];
+ n += GetNumberOfEntries(true);
+ CONST_CAST m_pCurrentGroup = pOldCurrentGroup;
+ }
}
- }
- return n;
+ return n;
}
size_t wxFileConfig::GetNumberOfGroups(bool bRecursive) const
{
- size_t n = m_pCurrentGroup->Groups().Count();
- if ( bRecursive ) {
- wxFileConfigGroup *pOldCurrentGroup = m_pCurrentGroup;
- size_t nSubgroups = m_pCurrentGroup->Groups().Count();
- for ( size_t nGroup = 0; nGroup < nSubgroups; nGroup++ ) {
- CONST_CAST m_pCurrentGroup = m_pCurrentGroup->Groups()[nGroup];
- n += GetNumberOfGroups(TRUE);
- CONST_CAST m_pCurrentGroup = pOldCurrentGroup;
+ size_t n = m_pCurrentGroup->Groups().Count();
+ if ( bRecursive ) {
+ wxFileConfigGroup *pOldCurrentGroup = m_pCurrentGroup;
+ size_t nSubgroups = m_pCurrentGroup->Groups().Count();
+ for ( size_t nGroup = 0; nGroup < nSubgroups; nGroup++ ) {
+ CONST_CAST m_pCurrentGroup = m_pCurrentGroup->Groups()[nGroup];
+ n += GetNumberOfGroups(true);
+ CONST_CAST m_pCurrentGroup = pOldCurrentGroup;
+ }
}
- }
- return n;
+ return n;
}
// ----------------------------------------------------------------------------
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
{
- wxConfigPathChanger path(this, strName);
+ wxConfigPathChanger path(this, strName);
- wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name());
- return pEntry != NULL;
+ wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name());
+ return pEntry != NULL;
}
// ----------------------------------------------------------------------------
bool wxFileConfig::DoReadString(const wxString& key, wxString* pStr) const
{
- wxConfigPathChanger path(this, key);
+ wxConfigPathChanger path(this, key);
- wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name());
- if (pEntry == NULL) {
- return FALSE;
- }
+ wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name());
+ if (pEntry == NULL) {
+ return false;
+ }
- *pStr = pEntry->Value();
+ *pStr = pEntry->Value();
- return TRUE;
+ return true;
}
bool wxFileConfig::DoReadLong(const wxString& key, long *pl) const
{
wxString str;
if ( !Read(key, &str) )
- return FALSE;
+ return false;
// extra spaces shouldn't prevent us from reading numeric values
str.Trim();
wxConfigPathChanger path(this, key);
wxString strName = path.Name();
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" Writing String '%s' = '%s' to Group '%s'"),
strName.c_str(),
szValue.c_str(),
GetPath().c_str() );
- if ( strName.IsEmpty() )
+ if ( strName.empty() )
{
// 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
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" Creating group %s"),
m_pCurrentGroup->Name().c_str() );
- m_pCurrentGroup->SetDirty();
+ SetDirty();
// this will add a line for this group if it didn't have it before
}
else
{
- // writing an entry
- // check that the name is reasonable
-
+ // 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;
+ return false;
}
wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(strName);
if ( pEntry == 0 )
{
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" Adding Entry %s"),
strName.c_str() );
pEntry = m_pCurrentGroup->AddEntry(strName);
}
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" Setting value %s"),
szValue.c_str() );
pEntry->SetValue(szValue);
+
+ SetDirty();
}
- return TRUE;
+ return true;
}
bool wxFileConfig::DoWriteLong(const wxString& key, long 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() )
{
wxLogError(_("can't open user configuration file."));
- return FALSE;
+ return false;
}
// write all strings to file
if ( !file.Write(line, m_conv) )
{
wxLogError(_("can't write user configuration file."));
- return FALSE;
+ return false;
}
}
- bool ret = file.Commit();
+ if ( !file.Commit() )
+ {
+ wxLogError(_("Failed to update user configuration file."));
+
+ return false;
+ }
+
+ ResetDirty();
#if defined(__WXMAC__)
- if ( ret )
+ wxFileName(m_strLocalFile).MacSetTypeAndCreator('TEXT', 'ttxt');
+#endif // __WXMAC__
+
+ return true;
+}
+
+#if wxUSE_STREAMS
+
+bool wxFileConfig::Save(wxOutputStream& os, wxMBConv& conv)
+{
+ // save unconditionally, even if not dirty
+ for ( wxFileConfigLineList *p = m_linesHead; p != NULL; p = p->Next() )
{
- FSRef fsRef ;
- FSCatalogInfo catInfo;
- FileInfo *finfo ;
-
- if ( wxMacPathToFSRef( m_strLocalFile , &fsRef ) == noErr )
- {
- if ( FSGetCatalogInfo (&fsRef, kFSCatInfoFinderInfo, &catInfo, NULL, NULL, NULL) == noErr )
- {
- finfo = (FileInfo*)&catInfo.finderInfo;
- finfo->fileType = 'TEXT' ;
- finfo->fileCreator = 'ttxt' ;
- FSSetCatalogInfo( &fsRef, kFSCatInfoFinderInfo, &catInfo ) ;
- }
- }
+ 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;
+ }
}
-#endif // __WXMAC__
-#ifdef __UNIX__
- // restore the old umask if we changed it
- if ( m_umask != -1 )
- {
- (void)umask(umaskOld);
- }
-#endif // __UNIX__
+ ResetDirty();
- return ret;
+ 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 ( wxFile::Exists(m_strLocalFile) && wxRemove(m_strLocalFile) == -1 )
+ if ( !m_strLocalFile.empty() )
{
- wxLogSysError(_("can't delete user configuration file '%s'"), m_strLocalFile.c_str());
- return FALSE;
+ 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;
}
// ----------------------------------------------------------------------------
wxFileConfigLineList *wxFileConfig::LineListAppend(const wxString& str)
{
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" ** Adding Line '%s'"),
str.c_str() );
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" head: %s"),
((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" tail: %s"),
((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) );
m_linesTail = pLine;
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" head: %s"),
((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" tail: %s"),
((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) );
wxFileConfigLineList *wxFileConfig::LineListInsert(const wxString& str,
wxFileConfigLineList *pLine)
{
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" ** Inserting Line '%s' after '%s'"),
str.c_str(),
((pLine) ? pLine->Text().c_str() : wxEmptyString) );
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" head: %s"),
((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" tail: %s"),
((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) );
pLine->SetNext(pNewLine);
}
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" head: %s"),
((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" tail: %s"),
((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) );
void wxFileConfig::LineListRemove(wxFileConfigLineList *pLine)
{
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" ** Removing Line '%s'"),
pLine->Text().c_str() );
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" head: %s"),
((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" tail: %s"),
((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) );
else
pNext->SetPrev(pPrev);
- wxLogTrace( _T("wxFileConfig"),
+ if ( m_pRootGroup->GetGroupLine() == pLine )
+ m_pRootGroup->SetLine(m_linesHead);
+
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" head: %s"),
((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" tail: %s"),
((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) );
{
m_pConfig = pConfig;
m_pParent = pParent;
- m_bDirty = FALSE;
m_pLine = NULL;
m_pLastEntry = NULL;
void wxFileConfigGroup::SetLine(wxFileConfigLineList *pLine)
{
- wxASSERT( m_pLine == 0 ); // 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;
}
// have it or in the very beginning if we're the root group.
wxFileConfigLineList *wxFileConfigGroup::GetGroupLine()
{
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" GetGroupLine() for Group '%s'"),
Name().c_str() );
if ( !m_pLine )
{
- wxLogTrace( _T("wxFileConfig"),
+ 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( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" checking parent '%s'"),
pParent->Name().c_str() );
// one immediately after the group line itself.
wxFileConfigLineList *wxFileConfigGroup::GetLastEntryLine()
{
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" GetLastEntryLine() for Group '%s'"),
Name().c_str() );
// group name
// ----------------------------------------------------------------------------
-void wxFileConfigGroup::Rename(const wxString& newName)
+void wxFileConfigGroup::UpdateGroupAndSubgroupsLines()
{
- wxCHECK_RET( m_pParent, _T("the root group can't be renamed") );
+ // update the line of this group
+ wxFileConfigLineList *line = GetGroupLine();
+ wxCHECK_RET( line, _T("a non root group must have a corresponding line!") );
- m_strName = newName;
+ // +1: skip the leading '/'
+ line->SetText(wxString::Format(_T("[%s]"), GetFullName().c_str() + 1));
- // +1: no leading '/'
- wxString strFullName;
- strFullName << wxT("[") << (GetFullName().c_str() + 1) << wxT("]");
- wxFileConfigLineList *line = GetGroupLine();
- wxCHECK_RET( line, _T("a non root group must have a corresponding line!") );
+ // 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();
+ }
+}
- line->SetText(strFullName);
+void wxFileConfigGroup::Rename(const wxString& newName)
+{
+ wxCHECK_RET( m_pParent, _T("the root group can't be renamed") );
- SetDirty();
+ m_strName = newName;
+
+ // 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;
}
// ----------------------------------------------------------------------------
{
wxFileConfigGroup * const pGroup = FindSubgroup(szName);
- return pGroup ? DeleteSubgroup(pGroup) : FALSE;
+ return pGroup ? DeleteSubgroup(pGroup) : false;
}
// Delete the subgroup and remove all references to it from
// other data structures.
bool wxFileConfigGroup::DeleteSubgroup(wxFileConfigGroup *pGroup)
{
- wxCHECK_MSG( pGroup, FALSE, _T("deleting non existing group?") );
+ wxCHECK_MSG( pGroup, false, _T("deleting non existing group?") );
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T("Deleting group '%s' from '%s'"),
pGroup->Name().c_str(),
Name().c_str() );
- wxLogTrace( _T("wxFileConfig"),
+ 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( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" text: '%s'"),
((m_pLine) ? m_pLine->Text().c_str() : wxEmptyString) );
- // delete all entries
+ // delete all entries...
size_t nCount = pGroup->m_aEntries.Count();
- wxLogTrace(_T("wxFileConfig"),
- _T("Removing %lu Entries"),
- (unsigned long)nCount );
+ 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();
+ wxFileConfigLineList *pLine = pGroup->m_aEntries[nEntry]->GetLine();
- if ( pLine != 0 )
+ if ( pLine )
{
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" '%s'"),
pLine->Text().c_str() );
m_pConfig->LineListRemove(pLine);
}
}
- // and subgroups of this subgroup
-
+ // ...and subgroups of this subgroup
nCount = pGroup->m_aSubgroups.Count();
- wxLogTrace( _T("wxFileConfig"),
- _T("Removing %lu SubGroups"),
- (unsigned long)nCount );
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T("Removing %lu subgroups"), (unsigned long)nCount );
for ( size_t nGroup = 0; nGroup < nCount; nGroup++ )
{
pGroup->DeleteSubgroup(pGroup->m_aSubgroups[0]);
}
- // finally the group itself
-
- wxFileConfigLineList *pLine = pGroup->m_pLine;
-
- if ( pLine != 0 )
+ // and then finally the group itself
+ wxFileConfigLineList *pLine = pGroup->m_pLine;
+ if ( pLine )
{
- wxLogTrace( _T("wxFileConfig"),
- _T(" Removing line entry for Group '%s' : '%s'"),
+ wxLogTrace( FILECONF_TRACE_MASK,
+ _T(" Removing line for group '%s' : '%s'"),
pGroup->Name().c_str(),
pLine->Text().c_str() );
- wxLogTrace( _T("wxFileConfig"),
- _T(" Removing from Group '%s' : '%s'"),
+ 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
-
+ // 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( _T("wxFileConfig"),
- _T(" ------- Removing last group -------") );
-
- // our last entry is being deleted, so find the last one which stays.
- // go back until we find a subgroup or reach the group's line, unless
- // we are the root group, which we'll notice shortly.
-
- wxFileConfigGroup *pNewLast = 0;
- size_t nSubgroups = m_aSubgroups.Count();
- wxFileConfigLineList *pl;
-
- for ( pl = pLine->Prev(); pl != m_pLine; pl = pl->Prev() )
+ 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() )
{
- // is it our subgroup?
-
- for ( size_t n = 0; (pNewLast == 0) && (n < nSubgroups); n++ )
+ // 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 == m_pLine )
- pNewLast = m_aSubgroups[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 ( pNewLast != 0 ) // found?
- break;
- }
-
- if ( pl == m_pLine || m_pParent == 0 )
- {
- wxLogTrace( _T("wxFileConfig"),
- _T(" ------- No previous group found -------") );
-
- wxASSERT_MSG( !pNewLast || m_pLine == 0,
- _T("how comes it has the same line as we?") );
-
- // we've reached the group line without finding any subgroups,
- // or realised we removed the last group from the root.
-
- m_pLastGroup = 0;
- }
- else
- {
- wxLogTrace( _T("wxFileConfig"),
- _T(" ------- Last Group set to '%s' -------"),
- pNewLast->Name().c_str() );
-
- m_pLastGroup = pNewLast;
}
}
}
else
{
- wxLogTrace( _T("wxFileConfig"),
+ wxLogTrace( FILECONF_TRACE_MASK,
_T(" No line entry for Group '%s'?"),
pGroup->Name().c_str() );
}
- SetDirty();
-
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)
{
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
-
+ // 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_bHasValue = TRUE;
+ m_bHasValue = true;
m_strValue = strValue;
if ( bUser )
{
- wxString strValFiltered;
+ wxString strValFiltered;
if ( Group()->Config()->GetStyle() & wxCONFIG_USE_NO_ESCAPE_CHARACTERS )
{
}
else // this entry didn't exist in the local file
{
- // add a new line to the 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);
}
-
- SetDirty();
}
}
-void wxFileConfigEntry::SetDirty()
-{
- m_bDirty = TRUE;
- Group()->SetDirty();
-}
-
// ============================================================================
// global functions
// ============================================================================
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('\\') ) {
//
// NB: note that wxCONFIG_IMMUTABLE_PREFIX and wxCONFIG_PATH_SEPARATOR
// should *not* be quoted
- if (
+ if (
#if !wxUSE_UNICODE
((unsigned char)c < 127) &&
#endif // ANSI
}
#endif // wxUSE_CONFIG
-
-
-// vi:sts=4:sw=4:et
projects / wxWidgets.git / blobdiff