src/common/config.cpp

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