X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3a5bcc4db0851bf8cd3063917511b0b17c7f9679..b404a8f3b072129c107c6d9a5e0f6f53cd34807b:/src/common/config.cpp diff --git a/src/common/config.cpp b/src/common/config.cpp index 535a272f1e..12c8213002 100644 --- a/src/common/config.cpp +++ b/src/common/config.cpp @@ -1,11 +1,11 @@ /////////////////////////////////////////////////////////////////////////////// -// Name: config.cpp +// Name: src/common/config.cpp // Purpose: implementation of wxConfigBase class // Author: Vadim Zeitlin // Modified by: // Created: 07.04.98 // RCS-ID: $Id$ -// Copyright: (c) 1997 Karsten Ballüder Ballueder@usa.net +// Copyright: (c) 1997 Karsten Ballueder Ballueder@usa.net // Vadim Zeitlin // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// @@ -13,14 +13,11 @@ // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma implementation "confbase.h" -#endif #include "wx/wxprec.h" -#ifdef __BORLANDC__ - #pragma hdrstop +#ifdef __BORLANDC__ + #pragma hdrstop #endif //__BORLANDC__ #ifndef wxUSE_CONFIG_NATIVE @@ -28,36 +25,57 @@ #endif #include "wx/config.h" -#include "wx/intl.h" -#include "wx/log.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/app.h" +#include "wx/apptrait.h" #include "wx/file.h" -#include "wx/textfile.h" -#include "wx/utils.h" -#include "wx/utils.h" #include -#include #include #include // for INT_MAX +#include // for FLT_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. @@ -68,12 +86,13 @@ wxConfigBase::wxConfigBase(const wxString& appName, long style) : m_appName(appName), m_vendorName(vendorName), m_style(style) { - m_bExpandEnvVars = TRUE; - m_bRecordDefaults = FALSE; + m_bExpandEnvVars = true; + m_bRecordDefaults = false; } wxConfigBase::~wxConfigBase() { + // required here for Darwin } wxConfigBase *wxConfigBase::Set(wxConfigBase *pConfig) @@ -86,12 +105,10 @@ wxConfigBase *wxConfigBase::Set(wxConfigBase *pConfig) wxConfigBase *wxConfigBase::Create() { if ( ms_bAutoCreate && ms_pConfig == NULL ) { - ms_pConfig = - #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE - new wxRegConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName()); - #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, wxT("create wxApp before calling this") ); + + ms_pConfig = traits->CreateConfig(); } return ms_pConfig; @@ -105,21 +122,21 @@ wxConfigBase *wxConfigBase::Create() #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") ); \ + wxCHECK_MSG( val, false, wxT("wxConfig::Read(): NULL parameter") ); \ \ if ( !DoRead##name(key, val) ) \ - return FALSE; \ + return false; \ \ *val = extra(*val); \ \ - return TRUE; \ + return true; \ } \ \ bool wxConfigBase::Read(const wxString& key, \ type *val, \ deftype defVal) const \ { \ - wxCHECK_MSG( val, FALSE, _T("wxConfig::Read(): NULL parameter") ); \ + wxCHECK_MSG( val, false, wxT("wxConfig::Read(): NULL parameter") ); \ \ bool read = DoRead##name(key, val); \ if ( !read ) \ @@ -140,42 +157,83 @@ wxConfigBase *wxConfigBase::Create() IMPLEMENT_READ_FOR_TYPE(String, wxString, const wxString&, ExpandEnvVars) IMPLEMENT_READ_FOR_TYPE(Long, long, long, long) -IMPLEMENT_READ_FOR_TYPE(Int, int, int, int) IMPLEMENT_READ_FOR_TYPE(Double, double, double, double) IMPLEMENT_READ_FOR_TYPE(Bool, bool, bool, bool) #undef IMPLEMENT_READ_FOR_TYPE -// the DoReadXXX() for the other types have implementation in the base class -// but can be overridden in the derived ones -bool wxConfigBase::DoReadInt(const wxString& key, int *pi) const +// int is stored as long +bool wxConfigBase::Read(const wxString& key, int *pi) const +{ + long l = *pi; + bool r = Read(key, &l); + wxASSERT_MSG( l < INT_MAX, wxT("int overflow in wxConfig::Read") ); + *pi = (int)l; + return r; +} + +bool wxConfigBase::Read(const wxString& key, int *pi, int defVal) const { - wxCHECK_MSG( pi, FALSE, _T("wxConfig::Read(): NULL parameter") ); + long l = *pi; + bool r = Read(key, &l, defVal); + wxASSERT_MSG( l < INT_MAX, wxT("int overflow in wxConfig::Read") ); + *pi = (int)l; + return r; +} - long l; - if ( !DoReadLong(key, &l) ) - return FALSE; +// Read floats as doubles then just type cast it down. +bool wxConfigBase::Read(const wxString& key, float* val) const +{ + wxCHECK_MSG( val, false, wxT("wxConfig::Read(): NULL parameter") ); - wxASSERT_MSG( l < INT_MAX, _T("overflow in wxConfig::DoReadInt") ); + double temp; + if ( !Read(key, &temp) ) + return false; - *pi = (int)l; + wxCHECK_MSG( fabs(temp) <= FLT_MAX, false, + wxT("float overflow in wxConfig::Read") ); + wxCHECK_MSG( (temp == 0.0) || (fabs(temp) >= FLT_MIN), false, + wxT("float underflow in wxConfig::Read") ); - return TRUE; + *val = static_cast(temp); + + return true; } +bool wxConfigBase::Read(const wxString& key, float* val, float defVal) const +{ + wxCHECK_MSG( val, false, wxT("wxConfig::Read(): NULL parameter") ); + + if ( Read(key, val) ) + return true; + + *val = defVal; + return false; +} + +// 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 { - wxCHECK_MSG( val, FALSE, _T("wxConfig::Read(): NULL parameter") ); + wxCHECK_MSG( val, false, wxT("wxConfig::Read(): NULL parameter") ); long l; if ( !DoReadLong(key, &l) ) - return FALSE; + return false; - wxASSERT_MSG( l == 0 || l == 1, _T("bad bool value in wxConfig::DoReadInt") ); + if ( l != 0 && l != 1 ) + { + // Don't assert here as this could happen in the result of user editing + // the file directly and this not indicate a bug in the program but + // still complain that something is wrong. + wxLogWarning(_("Invalid value %ld for a boolean key \"%s\" in " + "config file."), + l, key); + } *val = l != 0; - return TRUE; + return true; } bool wxConfigBase::DoReadDouble(const wxString& key, double* val) const @@ -183,10 +241,17 @@ bool wxConfigBase::DoReadDouble(const wxString& key, double* val) const wxString str; if ( Read(key, &str) ) { - return str.ToDouble(val); + if ( str.ToCDouble(val) ) + return true; + + // Previous versions of wxFileConfig wrote the numbers out using the + // current locale and not the C one as now, so attempt to parse the + // string as a number in the current locale too, for compatibility. + if ( str.ToDouble(val) ) + return true; } - return FALSE; + return false; } // string reading helper @@ -206,12 +271,10 @@ wxString wxConfigBase::ExpandEnvVars(const wxString& str) const bool wxConfigBase::DoWriteDouble(const wxString& key, double val) { - return DoWriteString(key, wxString::Format(_T("%g"), val)); -} - -bool wxConfigBase::DoWriteInt(const wxString& key, int value) -{ - return DoWriteLong(key, (long)value); + // Notice that we always write out the numbers in C locale and not the + // current one. This makes the config files portable between machines using + // different locales. + return DoWriteString(key, wxString::FromCDouble(val)); } bool wxConfigBase::DoWriteBool(const wxString& key, bool value) @@ -224,37 +287,63 @@ bool wxConfigBase::DoWriteBool(const wxString& key, bool value) // ---------------------------------------------------------------------------- wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer, - const wxString& strEntry) + const wxString& strEntry) { - m_pContainer = (wxConfigBase *)pContainer; + m_bChanged = false; + m_pContainer = const_cast(pContainer); - // the path is everything which precedes the last slash - wxString strPath = strEntry.BeforeLast(wxCONFIG_PATH_SEPARATOR); + // the path is everything which precedes the last slash and the name is + // everything after it -- and this works correctly if there is no slash too + wxString strPath = strEntry.BeforeLast(wxCONFIG_PATH_SEPARATOR, &m_strName); // 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; - m_strName = strEntry.AfterLast(wxCONFIG_PATH_SEPARATOR); - m_strOldPath = m_pContainer->GetPath(); - if ( m_strOldPath.Len() == 0 || - m_strOldPath.Last() != wxCONFIG_PATH_SEPARATOR ) - 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; + 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(wxT("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); + } } } +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 @@ -263,6 +352,24 @@ wxConfigPathChanger::~wxConfigPathChanger() } } +// 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 // ---------------------------------------------------------------------------- @@ -272,27 +379,28 @@ wxConfigPathChanger::~wxConfigPathChanger() // 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 - }; + 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 wxT('%'): #endif //WINDOWS @@ -304,11 +412,11 @@ wxString wxExpandEnvVars(const wxString& str) bracket = Bracket_Windows; else #endif //WINDOWS - if ( n == str.Len() - 1 ) { + if ( n == str.length() - 1 ) { bracket = Bracket_None; } else { - switch ( str[n + 1] ) { + switch ( str[n + 1].GetValue() ) { case wxT('('): bracket = Bracket_Normal; n++; // skip the bracket @@ -326,20 +434,26 @@ wxString wxExpandEnvVars(const wxString& str) m = n + 1; - while ( m < str.Len() && (wxIsalnum(str[m]) || str[m] == wxT('_')) ) + while ( m < str.length() && (wxIsalnum(str[m]) || str[m] == wxT('_')) ) m++; wxString strVarName(str.c_str() + n + 1, m - n - 1); #ifdef __WXWINCE__ - const wxChar *pszValue = NULL; + const bool expanded = false; #else - const wxChar *pszValue = wxGetenv(strVarName); -#endif - if ( pszValue != NULL ) { - strResult += pszValue; + // 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 ) @@ -351,7 +465,7 @@ wxString wxExpandEnvVars(const wxString& str) // check the closing bracket if ( bracket != Bracket_None ) { - if ( m == str.Len() || str[m] != (char)bracket ) { + 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 @@ -359,14 +473,14 @@ wxString wxExpandEnvVars(const wxString& str) // 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 %d in '%s'."), - (char)bracket, m + 1, str.c_str()); + 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++; } } @@ -375,9 +489,10 @@ wxString wxExpandEnvVars(const wxString& str) } break; - case '\\': + case wxT('\\'): // backslash can be used to suppress special meaning of % and $ - if ( n != str.Len() && (str[n + 1] == wxT('%') || str[n + 1] == wxT('$')) ) { + if ( n != str.length() - 1 && + (str[n + 1] == wxT('%') || str[n + 1] == wxT('$')) ) { strResult += str[++n]; break; @@ -393,41 +508,43 @@ wxString wxExpandEnvVars(const wxString& str) } // this function is used to properly interpret '..' in path -void wxSplitPath(wxArrayString& aParts, const wxChar *sz) +void wxSplitPath(wxArrayString& aParts, const wxString& path) { aParts.clear(); wxString strCurrent; - const wxChar *pc = sz; + wxString::const_iterator pc = path.begin(); for ( ;; ) { - if ( *pc == wxT('\0') || *pc == wxCONFIG_PATH_SEPARATOR ) { + if ( pc == path.end() || *pc == wxCONFIG_PATH_SEPARATOR ) { if ( strCurrent == wxT(".") ) { // ignore } else if ( strCurrent == wxT("..") ) { // go up one level if ( aParts.size() == 0 ) - wxLogWarning(_("'%s' has extra '..', ignored."), sz); + { + wxLogWarning(_("'%s' has extra '..', ignored."), path); + } else + { aParts.erase(aParts.end() - 1); + } strCurrent.Empty(); } - else if ( !strCurrent.IsEmpty() ) { + else if ( !strCurrent.empty() ) { aParts.push_back(strCurrent); strCurrent.Empty(); } //else: // could log an error here, but we prefer to ignore extra '/' - if ( *pc == wxT('\0') ) + if ( pc == path.end() ) break; } else strCurrent += *pc; - pc++; + ++pc; } } - -