///////////////////////////////////////////////////////////////////////////////
-// Name: config.cpp
+// Name: src/common/config.cpp
// Purpose: implementation of wxConfigBase class
// Author: Vadim Zeitlin
// Modified by:
// RCS-ID: $Id$
// Copyright: (c) 1997 Karsten Ballüder Ballueder@usa.net
// Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence: wxWindows license
+// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
- #pragma implementation "confbase.h"
-#endif
#include "wx/wxprec.h"
-#ifdef __BORLANDC__
- #pragma hdrstop
+#ifdef __BORLANDC__
+ #pragma hdrstop
#endif //__BORLANDC__
-#if wxUSE_CONFIG && ((wxUSE_FILE && wxUSE_TEXTFILE) || defined(wxCONFIG_WIN32_NATIVE))
-
-#include "wx/app.h"
-#include "wx/file.h"
-#include "wx/log.h"
-#include "wx/textfile.h"
-#include "wx/utils.h"
-#include "wx/log.h"
-#include "wx/utils.h"
-#include "wx/intl.h"
+#ifndef wxUSE_CONFIG_NATIVE
+ #define wxUSE_CONFIG_NATIVE 1
+#endif
#include "wx/config.h"
+#ifndef WX_PRECOMP
+ #include "wx/intl.h"
+ #include "wx/log.h"
+ #include "wx/app.h"
+ #include "wx/utils.h"
+ #include "wx/arrstr.h"
+ #include "wx/math.h"
+#endif //WX_PRECOMP
+
+#if wxUSE_CONFIG && ((wxUSE_FILE && wxUSE_TEXTFILE) || wxUSE_CONFIG_NATIVE)
+
+#include "wx/apptrait.h"
+#include "wx/file.h"
+
#include <stdlib.h>
-#include <math.h>
-#include <ctype.h> // for isalnum()
+#include <ctype.h>
+#include <limits.h> // for INT_MAX
// ----------------------------------------------------------------------------
// global and class static variables
// ----------------------------------------------------------------------------
wxConfigBase *wxConfigBase::ms_pConfig = NULL;
-bool wxConfigBase::ms_bAutoCreate = TRUE;
+bool wxConfigBase::ms_bAutoCreate = true;
// ============================================================================
// implementation
// ============================================================================
+// ----------------------------------------------------------------------------
+// wxAppTraitsBase
+// ----------------------------------------------------------------------------
+
+wxConfigBase *wxAppTraitsBase::CreateConfig()
+{
+ return new
+ #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
+ wxRegConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
+ #elif defined(__WXPALMOS__) && wxUSE_CONFIG_NATIVE
+ wxPrefConfig(wxTheApp->GetAppName());
+ #else // either we're under Unix or wish to use files even under Windows
+ wxFileConfig(wxTheApp->GetAppName());
+ #endif
+}
+
// ----------------------------------------------------------------------------
// wxConfigBase
// ----------------------------------------------------------------------------
+IMPLEMENT_ABSTRACT_CLASS(wxConfigBase, wxObject)
+
+// Not all args will always be used by derived classes, but including them all
+// in each class ensures compatibility.
+wxConfigBase::wxConfigBase(const wxString& appName,
+ const wxString& vendorName,
+ const wxString& WXUNUSED(localFilename),
+ const wxString& WXUNUSED(globalFilename),
+ long style)
+ : m_appName(appName), m_vendorName(vendorName), m_style(style)
+{
+ m_bExpandEnvVars = true;
+ m_bRecordDefaults = false;
+}
-// Not all args will always be used by derived classes, but
-// including them all in each class ensures compatibility.
-wxConfigBase::wxConfigBase(const wxString& appName, const wxString& vendorName,
- const wxString& WXUNUSED(localFilename), const wxString& WXUNUSED(globalFilename), long style):
- m_appName(appName), m_vendorName(vendorName), m_style(style)
+wxConfigBase::~wxConfigBase()
{
- m_bExpandEnvVars = TRUE; m_bRecordDefaults = FALSE;
+ // required here for Darwin
}
wxConfigBase *wxConfigBase::Set(wxConfigBase *pConfig)
wxConfigBase *wxConfigBase::Create()
{
if ( ms_bAutoCreate && ms_pConfig == NULL ) {
- ms_pConfig =
- #if defined(__WXMSW__) && defined(wxCONFIG_WIN32_NATIVE)
- #ifdef __WIN32__
- new wxRegConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
- #else //WIN16
- new wxIniConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
- #endif
- #else // either we're under Unix or wish to use files even under Windows
- new wxFileConfig(wxTheApp->GetAppName());
- #endif
+ wxAppTraits * const traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+ wxCHECK_MSG( traits, NULL, _T("create wxApp before calling this") );
+
+ ms_pConfig = traits->CreateConfig();
}
return ms_pConfig;
}
-wxString wxConfigBase::Read(const wxString& key, const wxString& defVal) const
-{
- wxString s;
- Read(key, &s, defVal);
- return s;
-}
+// ----------------------------------------------------------------------------
+// wxConfigBase reading entries
+// ----------------------------------------------------------------------------
-bool wxConfigBase::Read(const wxString& key, wxString *str, const wxString& defVal) const
-{
- if (!Read(key, str))
- {
- *str = ExpandEnvVars(defVal);
- return FALSE;
+// implement both Read() overloads for the given type in terms of DoRead()
+#define IMPLEMENT_READ_FOR_TYPE(name, type, deftype, extra) \
+ bool wxConfigBase::Read(const wxString& key, type *val) const \
+ { \
+ wxCHECK_MSG( val, false, _T("wxConfig::Read(): NULL parameter") ); \
+ \
+ if ( !DoRead##name(key, val) ) \
+ return false; \
+ \
+ *val = extra(*val); \
+ \
+ return true; \
+ } \
+ \
+ bool wxConfigBase::Read(const wxString& key, \
+ type *val, \
+ deftype defVal) const \
+ { \
+ wxCHECK_MSG( val, false, _T("wxConfig::Read(): NULL parameter") ); \
+ \
+ bool read = DoRead##name(key, val); \
+ if ( !read ) \
+ { \
+ if ( IsRecordingDefaults() ) \
+ { \
+ ((wxConfigBase *)this)->DoWrite##name(key, defVal); \
+ } \
+ \
+ *val = defVal; \
+ } \
+ \
+ *val = extra(*val); \
+ \
+ return read; \
}
- else
- return TRUE;
-}
-bool wxConfigBase::Read(const wxString& key, long *pl, long defVal) const
-{
- if (!Read(key, pl))
- {
- *pl = defVal;
- return FALSE;
- }
- else
- return TRUE;
-}
-bool wxConfigBase::Read(const wxString& key, double* val) const
-{
- wxString str;
- if (Read(key, & str))
- {
- *val = wxAtof(str);
- return TRUE;
- }
- else
- return FALSE;
-}
+IMPLEMENT_READ_FOR_TYPE(String, wxString, const wxString&, ExpandEnvVars)
+IMPLEMENT_READ_FOR_TYPE(Long, long, long, long)
+IMPLEMENT_READ_FOR_TYPE(Double, double, double, double)
+IMPLEMENT_READ_FOR_TYPE(Bool, bool, bool, bool)
-bool wxConfigBase::Read(const wxString& key, double* val, double defVal) const
-{
- if (!Read(key, val))
- {
- *val = defVal;
- return FALSE;
- }
- else
- return TRUE;
-}
+#undef IMPLEMENT_READ_FOR_TYPE
-bool wxConfigBase::Read(const wxString& key, bool* val) const
+// int is stored as long
+bool wxConfigBase::Read(const wxString& key, int *pi) const
{
- long l;
- if (Read(key, & l))
- {
- *val = (l != 0);
- return TRUE;
- }
- else
- return FALSE;
+ long l = *pi;
+ bool r = Read(key, &l);
+ wxASSERT_MSG( l < INT_MAX, _T("int overflow in wxConfig::Read") );
+ *pi = (int)l;
+ return r;
}
-bool wxConfigBase::Read(const wxString& key, bool* val, bool defVal) const
+bool wxConfigBase::Read(const wxString& key, int *pi, int defVal) const
{
- if (!Read(key, val))
- {
- *val = defVal;
- return FALSE;
- }
- else
- return TRUE;
+ long l = *pi;
+ bool r = Read(key, &l, defVal);
+ wxASSERT_MSG( l < INT_MAX, _T("int overflow in wxConfig::Read") );
+ *pi = (int)l;
+ return r;
}
-// Convenience functions
-
-bool wxConfigBase::Read(const wxString& key, int *pi) const
+// the DoReadXXX() for the other types have implementation in the base class
+// but can be overridden in the derived ones
+bool wxConfigBase::DoReadBool(const wxString& key, bool* val) const
{
- long l;
- bool ret = Read(key, &l);
- if (ret)
- *pi = (int) l;
- return ret;
-}
+ wxCHECK_MSG( val, false, _T("wxConfig::Read(): NULL parameter") );
-bool wxConfigBase::Read(const wxString& key, int *pi, int defVal) const
-{
long l;
- bool ret = Read(key, &l, (long) defVal);
- *pi = (int) l;
- return ret;
+ if ( !DoReadLong(key, &l) )
+ return false;
+
+ wxASSERT_MSG( l == 0 || l == 1, _T("bad bool value in wxConfig::DoReadInt") );
+
+ *val = l != 0;
+
+ return true;
}
-bool wxConfigBase::Write(const wxString& key, double val)
+bool wxConfigBase::DoReadDouble(const wxString& key, double* val) const
{
wxString str;
- str.Printf(T("%f"), val);
- return Write(key, str);
-}
+ if ( Read(key, &str) )
+ {
+ return str.ToDouble(val);
+ }
-bool wxConfigBase::Write(const wxString& key, bool value)
-{
- long l = (value ? 1 : 0);
- return Write(key, l);
+ return false;
}
+// string reading helper
wxString wxConfigBase::ExpandEnvVars(const wxString& str) const
{
wxString tmp; // Required for BC++
return tmp;
}
+// ----------------------------------------------------------------------------
+// wxConfigBase writing
+// ----------------------------------------------------------------------------
+
+bool wxConfigBase::DoWriteDouble(const wxString& key, double val)
+{
+ return DoWriteString(key, wxString::Format(_T("%g"), val));
+}
+
+bool wxConfigBase::DoWriteBool(const wxString& key, bool value)
+{
+ return DoWriteLong(key, value ? 1l : 0l);
+}
+
// ----------------------------------------------------------------------------
// wxConfigPathChanger
// ----------------------------------------------------------------------------
wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer,
- const wxString& strEntry)
+ const wxString& strEntry)
{
+ m_bChanged = false;
m_pContainer = (wxConfigBase *)pContainer;
// the path is everything which precedes the last slash
wxString strPath = strEntry.BeforeLast(wxCONFIG_PATH_SEPARATOR);
// except in the special case of "/keyname" when there is nothing before "/"
- if ( strPath.IsEmpty() &&
- ((!strEntry.IsEmpty()) && strEntry[0] == wxCONFIG_PATH_SEPARATOR) )
+ if ( strPath.empty() &&
+ ((!strEntry.empty()) && strEntry[0] == wxCONFIG_PATH_SEPARATOR) )
{
strPath = wxCONFIG_PATH_SEPARATOR;
}
- if ( !strPath.IsEmpty() ) {
- // do change the path
- m_bChanged = TRUE;
+ if ( !strPath.empty() )
+ {
+ if ( m_pContainer->GetPath() != strPath )
+ {
+ // we do change the path so restore it later
+ m_bChanged = true;
+
+ /* JACS: work around a memory bug that causes an assert
+ when using wxRegConfig, related to reference-counting.
+ Can be reproduced by removing .wc_str() below and
+ adding the following code to the config sample OnInit under
+ Windows:
+
+ pConfig->SetPath(wxT("MySettings"));
+ pConfig->SetPath(wxT(".."));
+ int value;
+ pConfig->Read(_T("MainWindowX"), & value);
+ */
+ m_strOldPath = m_pContainer->GetPath().wc_str();
+ if ( *m_strOldPath.c_str() != wxCONFIG_PATH_SEPARATOR )
+ m_strOldPath += wxCONFIG_PATH_SEPARATOR;
+ m_pContainer->SetPath(strPath);
+ }
+
+ // in any case, use the just the name, not full path
m_strName = strEntry.AfterLast(wxCONFIG_PATH_SEPARATOR);
- m_strOldPath = m_pContainer->GetPath();
- m_strOldPath += wxCONFIG_PATH_SEPARATOR;
- m_pContainer->SetPath(strPath);
}
else {
// it's a name only, without path - nothing to do
- m_bChanged = FALSE;
m_strName = strEntry;
}
}
+void wxConfigPathChanger::UpdateIfDeleted()
+{
+ // we don't have to do anything at all if we didn't change the path
+ if ( !m_bChanged )
+ return;
+
+ // find the deepest still existing parent path of the original path
+ while ( !m_pContainer->HasGroup(m_strOldPath) )
+ {
+ m_strOldPath = m_strOldPath.BeforeLast(wxCONFIG_PATH_SEPARATOR);
+ if ( m_strOldPath.empty() )
+ m_strOldPath = wxCONFIG_PATH_SEPARATOR;
+ }
+}
+
wxConfigPathChanger::~wxConfigPathChanger()
{
// only restore path if it was changed
}
}
+// this is a wxConfig method but it's mainly used with wxConfigPathChanger
+/* static */
+wxString wxConfigBase::RemoveTrailingSeparator(const wxString& key)
+{
+ wxString path(key);
+
+ // don't remove the only separator from a root group path!
+ while ( path.length() > 1 )
+ {
+ if ( *path.rbegin() != wxCONFIG_PATH_SEPARATOR )
+ break;
+
+ path.erase(path.end() - 1);
+ }
+
+ return path;
+}
+
+#endif // wxUSE_CONFIG
+
// ----------------------------------------------------------------------------
// static & global functions
// ----------------------------------------------------------------------------
// understands both Unix and Windows (but only under Windows) environment
// variables expansion: i.e. $var, $(var) and ${var} are always understood
// and in addition under Windows %var% is also.
-wxString wxExpandEnvVars(const wxString& str)
-{
- wxString strResult;
- strResult.Alloc(str.Len());
- // don't change the values the enum elements: they must be equal
- // to the matching [closing] delimiter.
- enum Bracket
- {
- Bracket_None,
- Bracket_Normal = ')',
- Bracket_Curly = '}'
+// don't change the values the enum elements: they must be equal
+// to the matching [closing] delimiter.
+enum Bracket
+{
+ Bracket_None,
+ Bracket_Normal = ')',
+ Bracket_Curly = '}',
#ifdef __WXMSW__
- ,Bracket_Windows = '%' // yeah, Windows people are a bit strange ;-)
+ Bracket_Windows = '%', // yeah, Windows people are a bit strange ;-)
#endif
- };
+ Bracket_Max
+};
+
+wxString wxExpandEnvVars(const wxString& str)
+{
+ wxString strResult;
+ strResult.Alloc(str.length());
size_t m;
- for ( size_t n = 0; n < str.Len(); n++ ) {
- switch ( str[n] ) {
+ for ( size_t n = 0; n < str.length(); n++ ) {
+ switch ( str[n].GetValue() ) {
#ifdef __WXMSW__
- case '%':
+ case wxT('%'):
#endif //WINDOWS
- case '$':
+ case wxT('$'):
{
Bracket bracket;
#ifdef __WXMSW__
- if ( str[n] == '%' )
+ if ( str[n] == wxT('%') )
bracket = Bracket_Windows;
else
#endif //WINDOWS
- if ( n == str.Len() - 1 ) {
+ if ( n == str.length() - 1 ) {
bracket = Bracket_None;
}
else {
- switch ( str[n + 1] ) {
- case '(':
+ switch ( str[n + 1].GetValue() ) {
+ case wxT('('):
bracket = Bracket_Normal;
n++; // skip the bracket
break;
- case '{':
+ case wxT('{'):
bracket = Bracket_Curly;
n++; // skip the bracket
break;
m = n + 1;
- while ( m < str.Len() && (isalnum(str[m]) || str[m] == '_') )
+ while ( m < str.length() && (wxIsalnum(str[m]) || str[m] == wxT('_')) )
m++;
-
+
wxString strVarName(str.c_str() + n + 1, m - n - 1);
- const wxChar *pszValue = wxGetenv(strVarName);
- if ( pszValue != NULL ) {
- strResult += pszValue;
+#ifdef __WXWINCE__
+ const bool expanded = false;
+#else
+ // NB: use wxGetEnv instead of wxGetenv as otherwise variables
+ // set through wxSetEnv may not be read correctly!
+ bool expanded = false;
+ wxString tmp;
+ if (wxGetEnv(strVarName, &tmp))
+ {
+ strResult += tmp;
+ expanded = true;
}
- else {
+ else
+#endif
+ {
// variable doesn't exist => don't change anything
#ifdef __WXMSW__
if ( bracket != Bracket_Windows )
// check the closing bracket
if ( bracket != Bracket_None ) {
- if ( m == str.Len() || str[m] != (char)bracket ) {
- wxLogWarning(_("Environment variables expansion failed: "
- "missing '%c' at position %d in '%s'."),
- (char)bracket, m + 1, str.c_str());
+ if ( m == str.length() || str[m] != (wxChar)bracket ) {
+ // under MSW it's common to have '%' characters in the registry
+ // and it's annoying to have warnings about them each time, so
+ // ignroe them silently if they are not used for env vars
+ //
+ // under Unix, OTOH, this warning could be useful for the user to
+ // understand why isn't the variable expanded as intended
+ #ifndef __WXMSW__
+ wxLogWarning(_("Environment variables expansion failed: missing '%c' at position %u in '%s'."),
+ (char)bracket, (unsigned int) (m + 1), str.c_str());
+ #endif // __WXMSW__
}
else {
// skip closing bracket unless the variables wasn't expanded
- if ( pszValue == NULL )
- strResult << (char)bracket;
+ if ( !expanded )
+ strResult << (wxChar)bracket;
m++;
}
}
}
break;
- case '\\':
+ case wxT('\\'):
// backslash can be used to suppress special meaning of % and $
- if ( n != str.Len() && (str[n + 1] == '%' || str[n + 1] == '$') ) {
+ if ( n != str.length() - 1 &&
+ (str[n + 1] == wxT('%') || str[n + 1] == wxT('$')) ) {
strResult += str[++n];
break;
}
// this function is used to properly interpret '..' in path
-void wxSplitPath(wxArrayString& aParts, const wxChar *sz)
+void wxSplitPath(wxArrayString& aParts, const wxString& path)
{
- aParts.Empty();
+ aParts.clear();
wxString strCurrent;
- const wxChar *pc = sz;
+ wxString::const_iterator pc = path.begin();
for ( ;; ) {
- if ( *pc == T('\0') || *pc == wxCONFIG_PATH_SEPARATOR ) {
- if ( strCurrent == T(".") ) {
+ if ( pc == path.end() || *pc == wxCONFIG_PATH_SEPARATOR ) {
+ if ( strCurrent == wxT(".") ) {
// ignore
}
- else if ( strCurrent == T("..") ) {
+ else if ( strCurrent == wxT("..") ) {
// go up one level
- if ( aParts.IsEmpty() )
- wxLogWarning(_("'%s' has extra '..', ignored."), sz);
+ if ( aParts.size() == 0 )
+ wxLogWarning(_("'%s' has extra '..', ignored."), path);
else
- aParts.Remove(aParts.Count() - 1);
+ aParts.erase(aParts.end() - 1);
strCurrent.Empty();
}
- else if ( !strCurrent.IsEmpty() ) {
- aParts.Add(strCurrent);
+ else if ( !strCurrent.empty() ) {
+ aParts.push_back(strCurrent);
strCurrent.Empty();
}
//else:
// could log an error here, but we prefer to ignore extra '/'
- if ( *pc == T('\0') )
- return;
+ if ( pc == path.end() )
+ break;
}
else
strCurrent += *pc;
- pc++;
+ ++pc;
}
}
-
-#endif // wxUSE_CONFIG
-
projects / wxWidgets.git / blobdiff