src/common/config.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/config.cpp
   3 // Purpose:     implementation of wxConfigBase class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     07.04.98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1997 Karsten Ballüder   Ballueder@usa.net
   9 //                       Vadim Zeitlin      <zeitlin@dptmaths.ens-cachan.fr>
  10 // Licence:     wxWindows licence
  11 ///////////////////////////////////////////////////////////////////////////////
  12
  13 // ----------------------------------------------------------------------------
  14 // headers
  15 // ----------------------------------------------------------------------------
  16
  17 #include "wx/wxprec.h"
  18
  19 #ifdef __BORLANDC__
  20     #pragma hdrstop
  21 #endif  //__BORLANDC__
  22
  23 #ifndef wxUSE_CONFIG_NATIVE
  24     #define wxUSE_CONFIG_NATIVE 1
  25 #endif
  26
  27 #include "wx/config.h"
  28
  29 #ifndef WX_PRECOMP
  30     #include "wx/intl.h"
  31     #include "wx/log.h"
  32     #include "wx/app.h"
  33     #include "wx/utils.h"
  34 #endif //WX_PRECOMP
  35
  36 #include "wx/arrstr.h"
  37
  38 #if wxUSE_CONFIG && ((wxUSE_FILE && wxUSE_TEXTFILE) || wxUSE_CONFIG_NATIVE)
  39
  40 #include "wx/file.h"
  41 #include "wx/math.h"
  42
  43 #include <stdlib.h>
  44 #include <ctype.h>
  45 #include <limits.h>     // for INT_MAX
  46
  47 // ----------------------------------------------------------------------------
  48 // global and class static variables
  49 // ----------------------------------------------------------------------------
  50
  51 wxConfigBase *wxConfigBase::ms_pConfig     = NULL;
  52 bool          wxConfigBase::ms_bAutoCreate = true;
  53
  54 // ============================================================================
  55 // implementation
  56 // ============================================================================
  57
  58 // ----------------------------------------------------------------------------
  59 // wxConfigBase
  60 // ----------------------------------------------------------------------------
  61
  62 // Not all args will always be used by derived classes, but including them all
  63 // in each class ensures compatibility.
  64 wxConfigBase::wxConfigBase(const wxString& appName,
  65                            const wxString& vendorName,
  66                            const wxString& WXUNUSED(localFilename),
  67                            const wxString& WXUNUSED(globalFilename),
  68                            long style)
  69             : m_appName(appName), m_vendorName(vendorName), m_style(style)
  70 {
  71     m_bExpandEnvVars = true;
  72     m_bRecordDefaults = false;
  73 }
  74
  75 wxConfigBase::~wxConfigBase()
  76 {
  77     // required here for Darwin
  78 }
  79
  80 wxConfigBase *wxConfigBase::Set(wxConfigBase *pConfig)
  81 {
  82   wxConfigBase *pOld = ms_pConfig;
  83   ms_pConfig = pConfig;
  84   return pOld;
  85 }
  86
  87 wxConfigBase *wxConfigBase::Create()
  88 {
  89   if ( ms_bAutoCreate && ms_pConfig == NULL ) {
  90     ms_pConfig =
  91     #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
  92         new wxRegConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
  93     #elif defined(__WXPALMOS__) && wxUSE_CONFIG_NATIVE
  94         new wxPrefConfig(wxTheApp->GetAppName());
  95     #else // either we're under Unix or wish to use files even under Windows
  96       new wxFileConfig(wxTheApp->GetAppName());
  97     #endif
  98   }
  99
 100   return ms_pConfig;
 101 }
 102
 103 // ----------------------------------------------------------------------------
 104 // wxConfigBase reading entries
 105 // ----------------------------------------------------------------------------
 106
 107 // implement both Read() overloads for the given type in terms of DoRead()
 108 #define IMPLEMENT_READ_FOR_TYPE(name, type, deftype, extra)                 \
 109     bool wxConfigBase::Read(const wxString& key, type *val) const           \
 110     {                                                                       \
 111         wxCHECK_MSG( val, false, _T("wxConfig::Read(): NULL parameter") );  \
 112                                                                             \
 113         if ( !DoRead##name(key, val) )                                      \
 114             return false;                                                   \
 115                                                                             \
 116         *val = extra(*val);                                                 \
 117                                                                             \
 118         return true;                                                        \
 119     }                                                                       \
 120                                                                             \
 121     bool wxConfigBase::Read(const wxString& key,                            \
 122                             type *val,                                      \
 123                             deftype defVal) const                           \
 124     {                                                                       \
 125         wxCHECK_MSG( val, false, _T("wxConfig::Read(): NULL parameter") );  \
 126                                                                             \
 127         bool read = DoRead##name(key, val);                                 \
 128         if ( !read )                                                        \
 129         {                                                                   \
 130             if ( IsRecordingDefaults() )                                    \
 131             {                                                               \
 132                 ((wxConfigBase *)this)->DoWrite##name(key, defVal);         \
 133             }                                                               \
 134                                                                             \
 135             *val = defVal;                                                  \
 136         }                                                                   \
 137                                                                             \
 138         *val = extra(*val);                                                 \
 139                                                                             \
 140         return read;                                                        \
 141     }
 142
 143
 144 IMPLEMENT_READ_FOR_TYPE(String, wxString, const wxString&, ExpandEnvVars)
 145 IMPLEMENT_READ_FOR_TYPE(Long, long, long, long)
 146 IMPLEMENT_READ_FOR_TYPE(Int, int, int, int)
 147 IMPLEMENT_READ_FOR_TYPE(Double, double, double, double)
 148 IMPLEMENT_READ_FOR_TYPE(Bool, bool, bool, bool)
 149
 150 #undef IMPLEMENT_READ_FOR_TYPE
 151
 152 // the DoReadXXX() for the other types have implementation in the base class
 153 // but can be overridden in the derived ones
 154 bool wxConfigBase::DoReadInt(const wxString& key, int *pi) const
 155 {
 156     wxCHECK_MSG( pi, false, _T("wxConfig::Read(): NULL parameter") );
 157
 158     long l;
 159     if ( !DoReadLong(key, &l) )
 160         return false;
 161
 162     wxASSERT_MSG( l < INT_MAX, _T("overflow in wxConfig::DoReadInt") );
 163
 164     *pi = (int)l;
 165
 166     return true;
 167 }
 168
 169 bool wxConfigBase::DoReadBool(const wxString& key, bool* val) const
 170 {
 171     wxCHECK_MSG( val, false, _T("wxConfig::Read(): NULL parameter") );
 172
 173     long l;
 174     if ( !DoReadLong(key, &l) )
 175         return false;
 176
 177     wxASSERT_MSG( l == 0 || l == 1, _T("bad bool value in wxConfig::DoReadInt") );
 178
 179     *val = l != 0;
 180
 181     return true;
 182 }
 183
 184 bool wxConfigBase::DoReadDouble(const wxString& key, double* val) const
 185 {
 186     wxString str;
 187     if ( Read(key, &str) )
 188     {
 189         return str.ToDouble(val);
 190     }
 191
 192     return false;
 193 }
 194
 195 // string reading helper
 196 wxString wxConfigBase::ExpandEnvVars(const wxString& str) const
 197 {
 198     wxString tmp; // Required for BC++
 199     if (IsExpandingEnvVars())
 200         tmp = wxExpandEnvVars(str);
 201     else
 202         tmp = str;
 203     return tmp;
 204 }
 205
 206 // ----------------------------------------------------------------------------
 207 // wxConfigBase writing
 208 // ----------------------------------------------------------------------------
 209
 210 bool wxConfigBase::DoWriteDouble(const wxString& key, double val)
 211 {
 212     return DoWriteString(key, wxString::Format(_T("%g"), val));
 213 }
 214
 215 bool wxConfigBase::DoWriteInt(const wxString& key, int value)
 216 {
 217     return DoWriteLong(key, (long)value);
 218 }
 219
 220 bool wxConfigBase::DoWriteBool(const wxString& key, bool value)
 221 {
 222     return DoWriteLong(key, value ? 1l : 0l);
 223 }
 224
 225 // ----------------------------------------------------------------------------
 226 // wxConfigPathChanger
 227 // ----------------------------------------------------------------------------
 228
 229 wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer,
 230                                          const wxString& strEntry)
 231 {
 232   m_bChanged = false;
 233   m_pContainer = (wxConfigBase *)pContainer;
 234
 235   // the path is everything which precedes the last slash
 236   wxString strPath = strEntry.BeforeLast(wxCONFIG_PATH_SEPARATOR);
 237
 238   // except in the special case of "/keyname" when there is nothing before "/"
 239   if ( strPath.empty() &&
 240        ((!strEntry.empty()) && strEntry[0] == wxCONFIG_PATH_SEPARATOR) )
 241   {
 242     strPath = wxCONFIG_PATH_SEPARATOR;
 243   }
 244
 245   if ( !strPath.empty() )
 246   {
 247     if ( m_pContainer->GetPath() != strPath )
 248     {
 249         // we do change the path so restore it later
 250         m_bChanged = true;
 251
 252         /* JACS: work around a memory bug that causes an assert
 253            when using wxRegConfig, related to reference-counting.
 254            Can be reproduced by removing (const wxChar*) below and
 255            adding the following code to the config sample OnInit under
 256            Windows:
 257
 258            pConfig->SetPath(wxT("MySettings"));
 259            pConfig->SetPath(wxT(".."));
 260            int value;
 261            pConfig->Read(_T("MainWindowX"), & value);
 262         */
 263         m_strOldPath = (const wxChar*) m_pContainer->GetPath();
 264         if ( *m_strOldPath.c_str() != wxCONFIG_PATH_SEPARATOR )
 265           m_strOldPath += wxCONFIG_PATH_SEPARATOR;
 266         m_pContainer->SetPath(strPath);
 267     }
 268
 269     // in any case, use the just the name, not full path
 270     m_strName = strEntry.AfterLast(wxCONFIG_PATH_SEPARATOR);
 271   }
 272   else {
 273     // it's a name only, without path - nothing to do
 274     m_strName = strEntry;
 275   }
 276 }
 277
 278 wxConfigPathChanger::~wxConfigPathChanger()
 279 {
 280   // only restore path if it was changed
 281   if ( m_bChanged ) {
 282     m_pContainer->SetPath(m_strOldPath);
 283   }
 284 }
 285
 286 #endif // wxUSE_CONFIG
 287
 288 // ----------------------------------------------------------------------------
 289 // static & global functions
 290 // ----------------------------------------------------------------------------
 291
 292 // understands both Unix and Windows (but only under Windows) environment
 293 // variables expansion: i.e. $var, $(var) and ${var} are always understood
 294 // and in addition under Windows %var% is also.
 295
 296 // don't change the values the enum elements: they must be equal
 297 // to the matching [closing] delimiter.
 298 enum Bracket
 299 {
 300   Bracket_None,
 301   Bracket_Normal  = ')',
 302   Bracket_Curly   = '}',
 303 #ifdef  __WXMSW__
 304   Bracket_Windows = '%',    // yeah, Windows people are a bit strange ;-)
 305 #endif
 306   Bracket_Max
 307 };
 308
 309 wxString wxExpandEnvVars(const wxString& str)
 310 {
 311   wxString strResult;
 312   strResult.Alloc(str.Len());
 313
 314   size_t m;
 315   for ( size_t n = 0; n < str.Len(); n++ ) {
 316     switch ( str[n] ) {
 317 #ifdef  __WXMSW__
 318       case wxT('%'):
 319 #endif  //WINDOWS
 320       case wxT('$'):
 321         {
 322           Bracket bracket;
 323           #ifdef  __WXMSW__
 324             if ( str[n] == wxT('%') )
 325               bracket = Bracket_Windows;
 326             else
 327           #endif  //WINDOWS
 328           if ( n == str.Len() - 1 ) {
 329             bracket = Bracket_None;
 330           }
 331           else {
 332             switch ( str[n + 1] ) {
 333               case wxT('('):
 334                 bracket = Bracket_Normal;
 335                 n++;                   // skip the bracket
 336                 break;
 337
 338               case wxT('{'):
 339                 bracket = Bracket_Curly;
 340                 n++;                   // skip the bracket
 341                 break;
 342
 343               default:
 344                 bracket = Bracket_None;
 345             }
 346           }
 347
 348           m = n + 1;
 349
 350           while ( m < str.Len() && (wxIsalnum(str[m]) || str[m] == wxT('_')) )
 351             m++;
 352
 353           wxString strVarName(str.c_str() + n + 1, m - n - 1);
 354
 355 #ifdef __WXWINCE__
 356           const wxChar *pszValue = NULL;
 357 #else
 358           const wxChar *pszValue = wxGetenv(strVarName);
 359 #endif
 360           if ( pszValue != NULL ) {
 361             strResult += pszValue;
 362           }
 363           else {
 364             // variable doesn't exist => don't change anything
 365             #ifdef  __WXMSW__
 366               if ( bracket != Bracket_Windows )
 367             #endif
 368                 if ( bracket != Bracket_None )
 369                   strResult << str[n - 1];
 370             strResult << str[n] << strVarName;
 371           }
 372
 373           // check the closing bracket
 374           if ( bracket != Bracket_None ) {
 375             if ( m == str.Len() || str[m] != (wxChar)bracket ) {
 376               // under MSW it's common to have '%' characters in the registry
 377               // and it's annoying to have warnings about them each time, so
 378               // ignroe them silently if they are not used for env vars
 379               //
 380               // under Unix, OTOH, this warning could be useful for the user to
 381               // understand why isn't the variable expanded as intended
 382               #ifndef __WXMSW__
 383                 wxLogWarning(_("Environment variables expansion failed: missing '%c' at position %u in '%s'."),
 384                              (char)bracket, (unsigned int) (m + 1), str.c_str());
 385               #endif // __WXMSW__
 386             }
 387             else {
 388               // skip closing bracket unless the variables wasn't expanded
 389               if ( pszValue == NULL )
 390                 strResult << (char)bracket;
 391               m++;
 392             }
 393           }
 394
 395           n = m - 1;  // skip variable name
 396         }
 397         break;
 398
 399       case '\\':
 400         // backslash can be used to suppress special meaning of % and $
 401         if ( n != str.Len() - 1 &&
 402                 (str[n + 1] == wxT('%') || str[n + 1] == wxT('$')) ) {
 403           strResult += str[++n];
 404
 405           break;
 406         }
 407         //else: fall through
 408
 409       default:
 410         strResult += str[n];
 411     }
 412   }
 413
 414   return strResult;
 415 }
 416
 417 // this function is used to properly interpret '..' in path
 418 void wxSplitPath(wxArrayString& aParts, const wxChar *sz)
 419 {
 420   aParts.clear();
 421
 422   wxString strCurrent;
 423   const wxChar *pc = sz;
 424   for ( ;; ) {
 425     if ( *pc == wxT('\0') || *pc == wxCONFIG_PATH_SEPARATOR ) {
 426       if ( strCurrent == wxT(".") ) {
 427         // ignore
 428       }
 429       else if ( strCurrent == wxT("..") ) {
 430         // go up one level
 431         if ( aParts.size() == 0 )
 432           wxLogWarning(_("'%s' has extra '..', ignored."), sz);
 433         else
 434           aParts.erase(aParts.end() - 1);
 435
 436         strCurrent.Empty();
 437       }
 438       else if ( !strCurrent.empty() ) {
 439         aParts.push_back(strCurrent);
 440         strCurrent.Empty();
 441       }
 442       //else:
 443         // could log an error here, but we prefer to ignore extra '/'
 444
 445       if ( *pc == wxT('\0') )
 446         break;
 447     }
 448     else
 449       strCurrent += *pc;
 450
 451     pc++;
 452   }
 453 }