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