X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7502ba2975bfd348dc50fef2a978e91f543d6bfe..6eccc0c485e57fe27fc56673f4f4dd191a09b2e6:/src/common/config.cpp diff --git a/src/common/config.cpp b/src/common/config.cpp index 667d25e5fe..014c2ab297 100644 --- a/src/common/config.cpp +++ b/src/common/config.cpp @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// // Name: config.cpp -// Purpose: implementation of wxConfig class +// Purpose: implementation of wxConfigBase class // Author: Vadim Zeitlin // Modified by: // Created: 07.04.98 @@ -10,97 +10,246 @@ // Licence: wxWindows license /////////////////////////////////////////////////////////////////////////////// -// ============================================================================ -// declarations -// ============================================================================ - // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- #ifdef __GNUG__ - #pragma implementation "config.h" + #pragma implementation "confbase.h" #endif -#include "wx/wxprec.h" +#include "wx/wxprec.h" #ifdef __BORLANDC__ #pragma hdrstop #endif //__BORLANDC__ -#ifndef WX_PRECOMP - #include - #include -#endif //WX_PRECOMP - -#include -#include -#include -#include -#include -#include -#include +#ifndef wxUSE_CONFIG_NATIVE + #define wxUSE_CONFIG_NATIVE 1 +#endif + +#include "wx/config.h" +#include "wx/intl.h" +#include "wx/log.h" + +#if wxUSE_CONFIG && ((wxUSE_FILE && wxUSE_TEXTFILE) || wxUSE_CONFIG_NATIVE) + +#include "wx/app.h" +#include "wx/file.h" +#include "wx/textfile.h" +#include "wx/utils.h" +#include "wx/utils.h" -#include // for isalnum() +#include +#include +#include +#include // for INT_MAX // ---------------------------------------------------------------------------- // global and class static variables // ---------------------------------------------------------------------------- -wxConfig *wxConfig::ms_pConfig = NULL; +wxConfigBase *wxConfigBase::ms_pConfig = NULL; +bool wxConfigBase::ms_bAutoCreate = TRUE; // ============================================================================ // implementation // ============================================================================ // ---------------------------------------------------------------------------- -// wxConfig +// wxConfigBase // ---------------------------------------------------------------------------- -wxConfig::~wxConfig() + +// 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; +} + +wxConfigBase::~wxConfigBase() { } -wxConfig *wxConfig::Set(wxConfig *pConfig) +wxConfigBase *wxConfigBase::Set(wxConfigBase *pConfig) { - wxConfig *pOld = ms_pConfig; + wxConfigBase *pOld = ms_pConfig; ms_pConfig = pConfig; return pOld; } -void wxConfig::Create() +wxConfigBase *wxConfigBase::Create() { - ms_pConfig = wxTheApp->CreateConfig(); + if ( ms_bAutoCreate && ms_pConfig == NULL ) { + ms_pConfig = + #if defined(__WXMSW__) && wxUSE_CONFIG_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 + } + + return ms_pConfig; } -const char *wxConfig::Read(const char *szKey, const char *szDefault) const +// ---------------------------------------------------------------------------- +// wxConfigBase reading entries +// ---------------------------------------------------------------------------- + +// 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; \ + } + + +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 { - static char s_szBuf[1024]; - wxString s; - Read(&s, szKey, szDefault); - strncpy(s_szBuf, s, WXSIZEOF(s_szBuf)); + wxCHECK_MSG( pi, FALSE, _T("wxConfig::Read(): NULL parameter") ); + + long l; + if ( !DoReadLong(key, &l) ) + return FALSE; - return s_szBuf; + wxASSERT_MSG( l < INT_MAX, _T("overflow in wxConfig::DoReadInt") ); + + *pi = (int)l; + + return TRUE; +} + +bool wxConfigBase::DoReadBool(const wxString& key, bool* val) const +{ + wxCHECK_MSG( val, FALSE, _T("wxConfig::Read(): NULL parameter") ); + + long l; + 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::DoReadDouble(const wxString& key, double* val) const +{ + wxString str; + if ( Read(key, &str) ) + { + return str.ToDouble(val); + } + + return FALSE; +} + +// string reading helper +wxString wxConfigBase::ExpandEnvVars(const wxString& str) const +{ + wxString tmp; // Required for BC++ + if (IsExpandingEnvVars()) + tmp = wxExpandEnvVars(str); + else + tmp = str; + return tmp; } // ---------------------------------------------------------------------------- -// Config::PathChanger +// wxConfigBase writing // ---------------------------------------------------------------------------- -wxConfig::PathChanger::PathChanger(const wxConfig *pContainer, +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); +} + +bool wxConfigBase::DoWriteBool(const wxString& key, bool value) +{ + return DoWriteLong(key, value ? 1l : 0l); +} + +// ---------------------------------------------------------------------------- +// wxConfigPathChanger +// ---------------------------------------------------------------------------- + +wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer, const wxString& strEntry) { - m_pContainer = (wxConfig *)pContainer; - wxString strPath = strEntry.Before(APPCONF_PATH_SEPARATOR); + m_pContainer = (wxConfigBase *)pContainer; - // special case of "/keyname" when there is nothing before "/" - if ( strPath.IsEmpty() && strEntry[0] == APPCONF_PATH_SEPARATOR ) - strPath = APPCONF_PATH_SEPARATOR; + // 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) ) + { + strPath = wxCONFIG_PATH_SEPARATOR; + } if ( !strPath.IsEmpty() ) { // do change the path m_bChanged = TRUE; - m_strName = strEntry.Right(APPCONF_PATH_SEPARATOR); + m_strName = strEntry.AfterLast(wxCONFIG_PATH_SEPARATOR); m_strOldPath = m_pContainer->GetPath(); - m_strOldPath += APPCONF_PATH_SEPARATOR; + if ( m_strOldPath.Len() == 0 || + m_strOldPath.Last() != wxCONFIG_PATH_SEPARATOR ) + m_strOldPath += wxCONFIG_PATH_SEPARATOR; m_pContainer->SetPath(strPath); } else { @@ -110,7 +259,7 @@ wxConfig::PathChanger::PathChanger(const wxConfig *pContainer, } } -wxConfig::PathChanger::~PathChanger() +wxConfigPathChanger::~wxConfigPathChanger() { // only restore path if it was changed if ( m_bChanged ) { @@ -118,6 +267,8 @@ wxConfig::PathChanger::~PathChanger() } } +#endif // wxUSE_CONFIG + // ---------------------------------------------------------------------------- // static & global functions // ---------------------------------------------------------------------------- @@ -125,7 +276,7 @@ wxConfig::PathChanger::~PathChanger() // 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 ExpandEnvVars(const wxString& str) +wxString wxExpandEnvVars(const wxString& str) { wxString strResult; strResult.Alloc(str.Len()); @@ -138,21 +289,22 @@ wxString ExpandEnvVars(const wxString& str) 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 }; - uint m; - for ( uint n = 0; n < str.Len(); n++ ) { + size_t m; + for ( size_t n = 0; n < str.Len(); n++ ) { switch ( str[n] ) { #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 @@ -161,12 +313,12 @@ wxString ExpandEnvVars(const wxString& str) } else { switch ( str[n + 1] ) { - case '(': + case wxT('('): bracket = Bracket_Normal; n++; // skip the bracket break; - case '{': + case wxT('{'): bracket = Bracket_Curly; n++; // skip the bracket break; @@ -178,12 +330,12 @@ wxString ExpandEnvVars(const wxString& str) m = n + 1; - while ( m < str.Len() && (isalnum(str[m]) || str[m] == '_') ) + while ( m < str.Len() && (wxIsalnum(str[m]) || str[m] == wxT('_')) ) m++; wxString strVarName(str.c_str() + n + 1, m - n - 1); - const char *pszValue = getenv(strVarName); + const wxChar *pszValue = wxGetenv(strVarName); if ( pszValue != NULL ) { strResult += pszValue; } @@ -200,11 +352,19 @@ wxString ExpandEnvVars(const wxString& str) // check the closing bracket if ( bracket != Bracket_None ) { if ( m == str.Len() || str[m] != (char)bracket ) { - wxLogWarning(_("missing '%c' at position %d in '%s'."), - (char)bracket, m + 1, str.c_str()); + // 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 %d in '%s'."), + (char)bracket, m + 1, str.c_str()); + #endif // __WXMSW__ } else { - // skip closing bracket + // skip closing bracket unless the variables wasn't expanded if ( pszValue == NULL ) strResult << (char)bracket; m++; @@ -215,6 +375,15 @@ wxString ExpandEnvVars(const wxString& str) } break; + case '\\': + // backslash can be used to suppress special meaning of % and $ + if ( n != str.Len() && (str[n + 1] == wxT('%') || str[n + 1] == wxT('$')) ) { + strResult += str[++n]; + + break; + } + //else: fall through + default: strResult += str[n]; } @@ -224,18 +393,18 @@ wxString ExpandEnvVars(const wxString& str) } // this function is used to properly interpret '..' in path -void SplitPath(wxArrayString& aParts, const char *sz) +void wxSplitPath(wxArrayString& aParts, const wxChar *sz) { aParts.Empty(); wxString strCurrent; - const char *pc = sz; + const wxChar *pc = sz; for ( ;; ) { - if ( *pc == '\0' || *pc == APPCONF_PATH_SEPARATOR ) { - if ( strCurrent == "." ) { + if ( *pc == wxT('\0') || *pc == wxCONFIG_PATH_SEPARATOR ) { + if ( strCurrent == wxT(".") ) { // ignore } - else if ( strCurrent == ".." ) { + else if ( strCurrent == wxT("..") ) { // go up one level if ( aParts.IsEmpty() ) wxLogWarning(_("'%s' has extra '..', ignored."), sz); @@ -251,8 +420,8 @@ void SplitPath(wxArrayString& aParts, const char *sz) //else: // could log an error here, but we prefer to ignore extra '/' - if ( *pc == '\0' ) - return; + if ( *pc == wxT('\0') ) + break; } else strCurrent += *pc; @@ -261,3 +430,4 @@ void SplitPath(wxArrayString& aParts, const char *sz) } } +