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 Ballueder  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     #include "wx/arrstr.h"
  35     #include "wx/math.h"
  36 #endif //WX_PRECOMP
  37
  38 #if wxUSE_CONFIG && ((wxUSE_FILE && wxUSE_TEXTFILE) || wxUSE_CONFIG_NATIVE)
  39
  40 #include "wx/apptrait.h"
  41 #include "wx/file.h"
  42
  43 #include <stdlib.h>
  44 #include <ctype.h>
  45 #include <limits.h>     // for INT_MAX
  46 #include <float.h>      // for FLT_MAX
  47
  48 // ----------------------------------------------------------------------------
  49 // global and class static variables
  50 // ----------------------------------------------------------------------------
  51
  52 wxConfigBase *wxConfigBase::ms_pConfig     = NULL;
  53 bool          wxConfigBase::ms_bAutoCreate = true;
  54
  55 // ============================================================================
  56 // implementation
  57 // ============================================================================
  58
  59 // ----------------------------------------------------------------------------
  60 // wxAppTraitsBase
  61 // ----------------------------------------------------------------------------
  62
  63 wxConfigBase *wxAppTraitsBase::CreateConfig()
  64 {
  65     return new
  66     #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
  67         wxRegConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
  68     #elif defined(__WXPALMOS__) && wxUSE_CONFIG_NATIVE
  69         wxPrefConfig(wxTheApp->GetAppName());
  70     #else // either we're under Unix or wish to use files even under Windows
  71         wxFileConfig(wxTheApp->GetAppName());
  72     #endif
  73 }
  74
  75 // ----------------------------------------------------------------------------
  76 // wxConfigBase
  77 // ----------------------------------------------------------------------------
  78 IMPLEMENT_ABSTRACT_CLASS(wxConfigBase, wxObject)
  79
  80 // Not all args will always be used by derived classes, but including them all
  81 // in each class ensures compatibility.
  82 wxConfigBase::wxConfigBase(const wxString& appName,
  83                            const wxString& vendorName,
  84                            const wxString& WXUNUSED(localFilename),
  85                            const wxString& WXUNUSED(globalFilename),
  86                            long style)
  87             : m_appName(appName), m_vendorName(vendorName), m_style(style)
  88 {
  89     m_bExpandEnvVars = true;
  90     m_bRecordDefaults = false;
  91 }
  92
  93 wxConfigBase::~wxConfigBase()
  94 {
  95     // required here for Darwin
  96 }
  97
  98 wxConfigBase *wxConfigBase::Set(wxConfigBase *pConfig)
  99 {
 100   wxConfigBase *pOld = ms_pConfig;
 101   ms_pConfig = pConfig;
 102   return pOld;
 103 }
 104
 105 wxConfigBase *wxConfigBase::Create()
 106 {
 107   if ( ms_bAutoCreate && ms_pConfig == NULL ) {
 108     wxAppTraits * const traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
 109     wxCHECK_MSG( traits, NULL, wxT("create wxApp before calling this") );
 110
 111     ms_pConfig = traits->CreateConfig();
 112   }
 113
 114   return ms_pConfig;
 115 }
 116
 117 // ----------------------------------------------------------------------------
 118 // wxConfigBase reading entries
 119 // ----------------------------------------------------------------------------
 120
 121 // implement both Read() overloads for the given type in terms of DoRead()
 122 #define IMPLEMENT_READ_FOR_TYPE(name, type, deftype, extra)                 \
 123     bool wxConfigBase::Read(const wxString& key, type *val) const           \
 124     {                                                                       \
 125         wxCHECK_MSG( val, false, wxT("wxConfig::Read(): NULL parameter") );  \
 126                                                                             \
 127         if ( !DoRead##name(key, val) )                                      \
 128             return false;                                                   \
 129                                                                             \
 130         *val = extra(*val);                                                 \
 131                                                                             \
 132         return true;                                                        \
 133     }                                                                       \
 134                                                                             \
 135     bool wxConfigBase::Read(const wxString& key,                            \
 136                             type *val,                                      \
 137                             deftype defVal) const                           \
 138     {                                                                       \
 139         wxCHECK_MSG( val, false, wxT("wxConfig::Read(): NULL parameter") );  \
 140                                                                             \
 141         bool read = DoRead##name(key, val);                                 \
 142         if ( !read )                                                        \
 143         {                                                                   \
 144             if ( IsRecordingDefaults() )                                    \
 145             {                                                               \
 146                 ((wxConfigBase *)this)->DoWrite##name(key, defVal);         \
 147             }                                                               \
 148                                                                             \
 149             *val = defVal;                                                  \
 150         }                                                                   \
 151                                                                             \
 152         *val = extra(*val);                                                 \
 153                                                                             \
 154         return read;                                                        \
 155     }
 156
 157
 158 IMPLEMENT_READ_FOR_TYPE(String, wxString, const wxString&, ExpandEnvVars)
 159 IMPLEMENT_READ_FOR_TYPE(Long, long, long, long)
 160 IMPLEMENT_READ_FOR_TYPE(Double, double, double, double)
 161 IMPLEMENT_READ_FOR_TYPE(Bool, bool, bool, bool)
 162
 163 #undef IMPLEMENT_READ_FOR_TYPE
 164
 165 // int is stored as long
 166 bool wxConfigBase::Read(const wxString& key, int *pi) const
 167 {
 168     long l = *pi;
 169     bool r = Read(key, &l);
 170     wxASSERT_MSG( l < INT_MAX, wxT("int overflow in wxConfig::Read") );
 171     *pi = (int)l;
 172     return r;
 173 }
 174
 175 bool wxConfigBase::Read(const wxString& key, int *pi, int defVal) const
 176 {
 177     long l = *pi;
 178     bool r = Read(key, &l, defVal);
 179     wxASSERT_MSG( l < INT_MAX, wxT("int overflow in wxConfig::Read") );
 180     *pi = (int)l;
 181     return r;
 182 }
 183
 184 // Read floats as doubles then just type cast it down.
 185 bool wxConfigBase::Read(const wxString& key, float* val) const
 186 {
 187     wxCHECK_MSG( val, false, wxT("wxConfig::Read(): NULL parameter") );
 188
 189     double temp;
 190     if ( !Read(key, &temp) )
 191         return false;
 192
 193     wxCHECK_MSG( fabs(temp) <= FLT_MAX, false,
 194                      wxT("float overflow in wxConfig::Read") );
 195     wxCHECK_MSG( (temp == 0.0) || (fabs(temp) >= FLT_MIN), false,
 196                      wxT("float underflow in wxConfig::Read") );
 197
 198     *val = static_cast<float>(temp);
 199
 200     return true;
 201 }
 202
 203 bool wxConfigBase::Read(const wxString& key, float* val, float defVal) const
 204 {
 205     wxCHECK_MSG( val, false, wxT("wxConfig::Read(): NULL parameter") );
 206
 207     if ( Read(key, val) )
 208         return true;
 209
 210     *val = defVal;
 211     return false;
 212 }
 213
 214 // the DoReadXXX() for the other types have implementation in the base class
 215 // but can be overridden in the derived ones
 216 bool wxConfigBase::DoReadBool(const wxString& key, bool* val) const
 217 {
 218     wxCHECK_MSG( val, false, wxT("wxConfig::Read(): NULL parameter") );
 219
 220     long l;
 221     if ( !DoReadLong(key, &l) )
 222         return false;
 223
 224     wxASSERT_MSG( l == 0 || l == 1, wxT("bad bool value in wxConfig::DoReadInt") );
 225
 226     *val = l != 0;
 227
 228     return true;
 229 }
 230
 231 bool wxConfigBase::DoReadDouble(const wxString& key, double* val) const
 232 {
 233     wxString str;
 234     if ( Read(key, &str) )
 235     {
 236         if ( str.ToCDouble(val) )
 237             return true;
 238
 239         // Previous versions of wxFileConfig wrote the numbers out using the
 240         // current locale and not the C one as now, so attempt to parse the
 241         // string as a number in the current locale too, for compatibility.
 242         if ( str.ToDouble(val) )
 243             return true;
 244     }
 245
 246     return false;
 247 }
 248
 249 // string reading helper
 250 wxString wxConfigBase::ExpandEnvVars(const wxString& str) const
 251 {
 252     wxString tmp; // Required for BC++
 253     if (IsExpandingEnvVars())
 254         tmp = wxExpandEnvVars(str);
 255     else
 256         tmp = str;
 257     return tmp;
 258 }
 259
 260 // ----------------------------------------------------------------------------
 261 // wxConfigBase writing
 262 // ----------------------------------------------------------------------------
 263
 264 bool wxConfigBase::DoWriteDouble(const wxString& key, double val)
 265 {
 266     // Notice that we always write out the numbers in C locale and not the
 267     // current one. This makes the config files portable between machines using
 268     // different locales.
 269     return DoWriteString(key, wxString::FromCDouble(val));
 270 }
 271
 272 bool wxConfigBase::DoWriteBool(const wxString& key, bool value)
 273 {
 274     return DoWriteLong(key, value ? 1l : 0l);
 275 }
 276
 277 // ----------------------------------------------------------------------------
 278 // wxConfigPathChanger
 279 // ----------------------------------------------------------------------------
 280
 281 wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer,
 282                                          const wxString& strEntry)
 283 {
 284   m_bChanged = false;
 285   m_pContainer = const_cast<wxConfigBase *>(pContainer);
 286
 287   // the path is everything which precedes the last slash and the name is
 288   // everything after it -- and this works correctly if there is no slash too
 289   wxString strPath = strEntry.BeforeLast(wxCONFIG_PATH_SEPARATOR, &m_strName);
 290
 291   // except in the special case of "/keyname" when there is nothing before "/"
 292   if ( strPath.empty() &&
 293        ((!strEntry.empty()) && strEntry[0] == wxCONFIG_PATH_SEPARATOR) )
 294   {
 295     strPath = wxCONFIG_PATH_SEPARATOR;
 296   }
 297
 298   if ( !strPath.empty() )
 299   {
 300     if ( m_pContainer->GetPath() != strPath )
 301     {
 302         // we do change the path so restore it later
 303         m_bChanged = true;
 304
 305         /* JACS: work around a memory bug that causes an assert
 306            when using wxRegConfig, related to reference-counting.
 307            Can be reproduced by removing .wc_str() below and
 308            adding the following code to the config sample OnInit under
 309            Windows:
 310
 311            pConfig->SetPath(wxT("MySettings"));
 312            pConfig->SetPath(wxT(".."));
 313            int value;
 314            pConfig->Read(wxT("MainWindowX"), & value);
 315         */
 316         m_strOldPath = m_pContainer->GetPath().wc_str();
 317         if ( *m_strOldPath.c_str() != wxCONFIG_PATH_SEPARATOR )
 318           m_strOldPath += wxCONFIG_PATH_SEPARATOR;
 319         m_pContainer->SetPath(strPath);
 320     }
 321   }
 322 }
 323
 324 void wxConfigPathChanger::UpdateIfDeleted()
 325 {
 326     // we don't have to do anything at all if we didn't change the path
 327     if ( !m_bChanged )
 328         return;
 329
 330     // find the deepest still existing parent path of the original path
 331     while ( !m_pContainer->HasGroup(m_strOldPath) )
 332     {
 333         m_strOldPath = m_strOldPath.BeforeLast(wxCONFIG_PATH_SEPARATOR);
 334         if ( m_strOldPath.empty() )
 335             m_strOldPath = wxCONFIG_PATH_SEPARATOR;
 336     }
 337 }
 338
 339 wxConfigPathChanger::~wxConfigPathChanger()
 340 {
 341   // only restore path if it was changed
 342   if ( m_bChanged ) {
 343     m_pContainer->SetPath(m_strOldPath);
 344   }
 345 }
 346
 347 // this is a wxConfig method but it's mainly used with wxConfigPathChanger
 348 /* static */
 349 wxString wxConfigBase::RemoveTrailingSeparator(const wxString& key)
 350 {
 351     wxString path(key);
 352
 353     // don't remove the only separator from a root group path!
 354     while ( path.length() > 1 )
 355     {
 356         if ( *path.rbegin() != wxCONFIG_PATH_SEPARATOR )
 357             break;
 358
 359         path.erase(path.end() - 1);
 360     }
 361
 362     return path;
 363 }
 364
 365 #endif // wxUSE_CONFIG
 366
 367 // ----------------------------------------------------------------------------
 368 // static & global functions
 369 // ----------------------------------------------------------------------------
 370
 371 // understands both Unix and Windows (but only under Windows) environment
 372 // variables expansion: i.e. $var, $(var) and ${var} are always understood
 373 // and in addition under Windows %var% is also.
 374
 375 // don't change the values the enum elements: they must be equal
 376 // to the matching [closing] delimiter.
 377 enum Bracket
 378 {
 379   Bracket_None,
 380   Bracket_Normal  = ')',
 381   Bracket_Curly   = '}',
 382 #ifdef  __WXMSW__
 383   Bracket_Windows = '%',    // yeah, Windows people are a bit strange ;-)
 384 #endif
 385   Bracket_Max
 386 };
 387
 388 wxString wxExpandEnvVars(const wxString& str)
 389 {
 390   wxString strResult;
 391   strResult.Alloc(str.length());
 392
 393   size_t m;
 394   for ( size_t n = 0; n < str.length(); n++ ) {
 395     switch ( str[n].GetValue() ) {
 396 #ifdef  __WXMSW__
 397       case wxT('%'):
 398 #endif  //WINDOWS
 399       case wxT('$'):
 400         {
 401           Bracket bracket;
 402           #ifdef  __WXMSW__
 403             if ( str[n] == wxT('%') )
 404               bracket = Bracket_Windows;
 405             else
 406           #endif  //WINDOWS
 407           if ( n == str.length() - 1 ) {
 408             bracket = Bracket_None;
 409           }
 410           else {
 411             switch ( str[n + 1].GetValue() ) {
 412               case wxT('('):
 413                 bracket = Bracket_Normal;
 414                 n++;                   // skip the bracket
 415                 break;
 416
 417               case wxT('{'):
 418                 bracket = Bracket_Curly;
 419                 n++;                   // skip the bracket
 420                 break;
 421
 422               default:
 423                 bracket = Bracket_None;
 424             }
 425           }
 426
 427           m = n + 1;
 428
 429           while ( m < str.length() && (wxIsalnum(str[m]) || str[m] == wxT('_')) )
 430             m++;
 431
 432           wxString strVarName(str.c_str() + n + 1, m - n - 1);
 433
 434 #ifdef __WXWINCE__
 435           const bool expanded = false;
 436 #else
 437           // NB: use wxGetEnv instead of wxGetenv as otherwise variables
 438           //     set through wxSetEnv may not be read correctly!
 439           bool expanded = false;
 440           wxString tmp;
 441           if (wxGetEnv(strVarName, &tmp))
 442           {
 443               strResult += tmp;
 444               expanded = true;
 445           }
 446           else
 447 #endif
 448           {
 449             // variable doesn't exist => don't change anything
 450             #ifdef  __WXMSW__
 451               if ( bracket != Bracket_Windows )
 452             #endif
 453                 if ( bracket != Bracket_None )
 454                   strResult << str[n - 1];
 455             strResult << str[n] << strVarName;
 456           }
 457
 458           // check the closing bracket
 459           if ( bracket != Bracket_None ) {
 460             if ( m == str.length() || str[m] != (wxChar)bracket ) {
 461               // under MSW it's common to have '%' characters in the registry
 462               // and it's annoying to have warnings about them each time, so
 463               // ignroe them silently if they are not used for env vars
 464               //
 465               // under Unix, OTOH, this warning could be useful for the user to
 466               // understand why isn't the variable expanded as intended
 467               #ifndef __WXMSW__
 468                 wxLogWarning(_("Environment variables expansion failed: missing '%c' at position %u in '%s'."),
 469                              (char)bracket, (unsigned int) (m + 1), str.c_str());
 470               #endif // __WXMSW__
 471             }
 472             else {
 473               // skip closing bracket unless the variables wasn't expanded
 474               if ( !expanded )
 475                 strResult << (wxChar)bracket;
 476               m++;
 477             }
 478           }
 479
 480           n = m - 1;  // skip variable name
 481         }
 482         break;
 483
 484       case wxT('\\'):
 485         // backslash can be used to suppress special meaning of % and $
 486         if ( n != str.length() - 1 &&
 487                 (str[n + 1] == wxT('%') || str[n + 1] == wxT('$')) ) {
 488           strResult += str[++n];
 489
 490           break;
 491         }
 492         //else: fall through
 493
 494       default:
 495         strResult += str[n];
 496     }
 497   }
 498
 499   return strResult;
 500 }
 501
 502 // this function is used to properly interpret '..' in path
 503 void wxSplitPath(wxArrayString& aParts, const wxString& path)
 504 {
 505   aParts.clear();
 506
 507   wxString strCurrent;
 508   wxString::const_iterator pc = path.begin();
 509   for ( ;; ) {
 510     if ( pc == path.end() || *pc == wxCONFIG_PATH_SEPARATOR ) {
 511       if ( strCurrent == wxT(".") ) {
 512         // ignore
 513       }
 514       else if ( strCurrent == wxT("..") ) {
 515         // go up one level
 516         if ( aParts.size() == 0 )
 517         {
 518           wxLogWarning(_("'%s' has extra '..', ignored."), path);
 519         }
 520         else
 521         {
 522           aParts.erase(aParts.end() - 1);
 523         }
 524
 525         strCurrent.Empty();
 526       }
 527       else if ( !strCurrent.empty() ) {
 528         aParts.push_back(strCurrent);
 529         strCurrent.Empty();
 530       }
 531       //else:
 532         // could log an error here, but we prefer to ignore extra '/'
 533
 534       if ( pc == path.end() )
 535         break;
 536     }
 537     else
 538       strCurrent += *pc;
 539
 540     ++pc;
 541   }
 542 }