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 license
  11 ///////////////////////////////////////////////////////////////////////////////
  12
  13 // ----------------------------------------------------------------------------
  14 // headers
  15 // ----------------------------------------------------------------------------
  16 #ifdef __GNUG__
  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 #if wxUSE_CONFIG && ((wxUSE_FILE && wxUSE_TEXTFILE) || wxUSE_CONFIG_NATIVE)
  31
  32 #include "wx/app.h"
  33 #include "wx/file.h"
  34 #include "wx/log.h"
  35 #include "wx/textfile.h"
  36 #include "wx/utils.h"
  37 #include "wx/log.h"
  38 #include "wx/utils.h"
  39 #include "wx/intl.h"
  40
  41 #include "wx/config.h"
  42
  43 #include <stdlib.h>
  44 #include <math.h>
  45 #include <ctype.h>
  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; m_bRecordDefaults = FALSE;
  72 }
  73
  74 wxConfigBase::~wxConfigBase()
  75 {
  76 }
  77
  78 wxConfigBase *wxConfigBase::Set(wxConfigBase *pConfig)
  79 {
  80   wxConfigBase *pOld = ms_pConfig;
  81   ms_pConfig = pConfig;
  82   return pOld;
  83 }
  84
  85 wxConfigBase *wxConfigBase::Create()
  86 {
  87   if ( ms_bAutoCreate && ms_pConfig == NULL ) {
  88     ms_pConfig =
  89     #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
  90       #ifdef __WIN32__
  91         new wxRegConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
  92       #else  //WIN16
  93         new wxIniConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
  94       #endif
  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 wxString wxConfigBase::Read(const wxString& key, const wxString& defVal) const
 104 {
 105   wxString s;
 106   Read(key, &s, defVal);
 107   return s;
 108 }
 109
 110 bool wxConfigBase::Read(const wxString& key, wxString *str, const wxString& defVal) const
 111 {
 112     if (!Read(key, str))
 113     {
 114         *str = ExpandEnvVars(defVal);
 115         return FALSE;
 116     }
 117     else
 118         return TRUE;
 119 }
 120
 121 bool wxConfigBase::Read(const wxString& key, long *pl, long defVal) const
 122 {
 123     if (!Read(key, pl))
 124     {
 125         *pl = defVal;
 126         return FALSE;
 127     }
 128     else
 129         return TRUE;
 130 }
 131
 132 bool wxConfigBase::Read(const wxString& key, double* val) const
 133 {
 134     wxString str;
 135     if (Read(key, & str))
 136     {
 137         return wxSscanf(str, _T("%g"), val) == 1;
 138     }
 139
 140     return FALSE;
 141 }
 142
 143 bool wxConfigBase::Read(const wxString& key, double* val, double defVal) const
 144 {
 145     if (!Read(key, val))
 146     {
 147         *val = defVal;
 148         return FALSE;
 149     }
 150     else
 151         return TRUE;
 152 }
 153
 154 bool wxConfigBase::Read(const wxString& key, bool* val) const
 155 {
 156     long l;
 157     if (Read(key, & l))
 158     {
 159         *val = (l != 0);
 160         return TRUE;
 161     }
 162     else
 163         return FALSE;
 164 }
 165
 166 bool wxConfigBase::Read(const wxString& key, bool* val, bool defVal) const
 167 {
 168     if (!Read(key, val))
 169     {
 170         *val = defVal;
 171         return FALSE;
 172     }
 173     else
 174         return TRUE;
 175 }
 176
 177 // Convenience functions
 178
 179 bool wxConfigBase::Read(const wxString& key, int *pi) const
 180 {
 181     long l;
 182     bool ret = Read(key, &l);
 183     if (ret)
 184         *pi = (int) l;
 185     return ret;
 186 }
 187
 188 bool wxConfigBase::Read(const wxString& key, int *pi, int defVal) const
 189 {
 190     long l;
 191     bool ret = Read(key, &l, (long) defVal);
 192     if (ret)
 193         *pi = (int) l;
 194     return ret;
 195 }
 196
 197 bool wxConfigBase::Write(const wxString& key, double val)
 198 {
 199     wxString str;
 200     str.Printf(wxT("%g"), val);
 201     return Write(key, str);
 202 }
 203
 204 bool wxConfigBase::Write(const wxString& key, bool value)
 205 {
 206     return Write(key, value ? 1l : 0l);
 207 }
 208
 209 wxString wxConfigBase::ExpandEnvVars(const wxString& str) const
 210 {
 211     wxString tmp; // Required for BC++
 212     if (IsExpandingEnvVars())
 213         tmp = wxExpandEnvVars(str);
 214     else
 215         tmp = str;
 216     return tmp;
 217 }
 218
 219 // ----------------------------------------------------------------------------
 220 // wxConfigPathChanger
 221 // ----------------------------------------------------------------------------
 222
 223 wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer,
 224                                  const wxString& strEntry)
 225 {
 226   m_pContainer = (wxConfigBase *)pContainer;
 227
 228   // the path is everything which precedes the last slash
 229   wxString strPath = strEntry.BeforeLast(wxCONFIG_PATH_SEPARATOR);
 230
 231   // except in the special case of "/keyname" when there is nothing before "/"
 232   if ( strPath.IsEmpty() &&
 233        ((!strEntry.IsEmpty()) && strEntry[0] == wxCONFIG_PATH_SEPARATOR) )
 234   {
 235     strPath = wxCONFIG_PATH_SEPARATOR;
 236   }
 237
 238   if ( !strPath.IsEmpty() ) {
 239     // do change the path
 240     m_bChanged = TRUE;
 241     m_strName = strEntry.AfterLast(wxCONFIG_PATH_SEPARATOR);
 242     m_strOldPath = m_pContainer->GetPath();
 243     if ( m_strOldPath.Len() == 0 ||
 244          m_strOldPath.Last() != wxCONFIG_PATH_SEPARATOR )
 245         m_strOldPath += wxCONFIG_PATH_SEPARATOR;
 246     m_pContainer->SetPath(strPath);
 247   }
 248   else {
 249     // it's a name only, without path - nothing to do
 250     m_bChanged = FALSE;
 251     m_strName = strEntry;
 252   }
 253 }
 254
 255 wxConfigPathChanger::~wxConfigPathChanger()
 256 {
 257   // only restore path if it was changed
 258   if ( m_bChanged ) {
 259     m_pContainer->SetPath(m_strOldPath);
 260   }
 261 }
 262
 263 // ----------------------------------------------------------------------------
 264 // static & global functions
 265 // ----------------------------------------------------------------------------
 266
 267 // understands both Unix and Windows (but only under Windows) environment
 268 // variables expansion: i.e. $var, $(var) and ${var} are always understood
 269 // and in addition under Windows %var% is also.
 270 wxString wxExpandEnvVars(const wxString& str)
 271 {
 272   wxString strResult;
 273   strResult.Alloc(str.Len());
 274
 275   // don't change the values the enum elements: they must be equal
 276   // to the matching [closing] delimiter.
 277   enum Bracket
 278   {
 279     Bracket_None,
 280     Bracket_Normal  = ')',
 281     Bracket_Curly   = '}'
 282 #ifdef  __WXMSW__
 283     ,Bracket_Windows = '%'     // yeah, Windows people are a bit strange ;-)
 284 #endif
 285   };
 286
 287   size_t m;
 288   for ( size_t n = 0; n < str.Len(); n++ ) {
 289     switch ( str[n] ) {
 290 #ifdef  __WXMSW__
 291       case wxT('%'):
 292 #endif  //WINDOWS
 293       case wxT('$'):
 294         {
 295           Bracket bracket;
 296           #ifdef  __WXMSW__
 297             if ( str[n] == wxT('%') )
 298               bracket = Bracket_Windows;
 299             else
 300           #endif  //WINDOWS
 301           if ( n == str.Len() - 1 ) {
 302             bracket = Bracket_None;
 303           }
 304           else {
 305             switch ( str[n + 1] ) {
 306               case wxT('('):
 307                 bracket = Bracket_Normal;
 308                 n++;                   // skip the bracket
 309                 break;
 310
 311               case wxT('{'):
 312                 bracket = Bracket_Curly;
 313                 n++;                   // skip the bracket
 314                 break;
 315
 316               default:
 317                 bracket = Bracket_None;
 318             }
 319           }
 320
 321           m = n + 1;
 322
 323           while ( m < str.Len() && (wxIsalnum(str[m]) || str[m] == wxT('_')) )
 324             m++;
 325
 326           wxString strVarName(str.c_str() + n + 1, m - n - 1);
 327
 328           const wxChar *pszValue = wxGetenv(strVarName);
 329           if ( pszValue != NULL ) {
 330             strResult += pszValue;
 331           }
 332           else {
 333             // variable doesn't exist => don't change anything
 334             #ifdef  __WXMSW__
 335               if ( bracket != Bracket_Windows )
 336             #endif
 337                 if ( bracket != Bracket_None )
 338                   strResult << str[n - 1];
 339             strResult << str[n] << strVarName;
 340           }
 341
 342           // check the closing bracket
 343           if ( bracket != Bracket_None ) {
 344             if ( m == str.Len() || str[m] != (char)bracket ) {
 345               wxLogWarning(_("Environment variables expansion failed: missing '%c' at position %d in '%s'."),
 346                            (char)bracket, m + 1, str.c_str());
 347             }
 348             else {
 349               // skip closing bracket unless the variables wasn't expanded
 350               if ( pszValue == NULL )
 351                 strResult << (char)bracket;
 352               m++;
 353             }
 354           }
 355
 356           n = m - 1;  // skip variable name
 357         }
 358         break;
 359
 360       case '\\':
 361         // backslash can be used to suppress special meaning of % and $
 362         if ( n != str.Len() && (str[n + 1] == wxT('%') || str[n + 1] == wxT('$')) ) {
 363           strResult += str[++n];
 364
 365           break;
 366         }
 367         //else: fall through
 368
 369       default:
 370         strResult += str[n];
 371     }
 372   }
 373
 374   return strResult;
 375 }
 376
 377 // this function is used to properly interpret '..' in path
 378 void wxSplitPath(wxArrayString& aParts, const wxChar *sz)
 379 {
 380   aParts.Empty();
 381
 382   wxString strCurrent;
 383   const wxChar *pc = sz;
 384   for ( ;; ) {
 385     if ( *pc == wxT('\0') || *pc == wxCONFIG_PATH_SEPARATOR ) {
 386       if ( strCurrent == wxT(".") ) {
 387         // ignore
 388       }
 389       else if ( strCurrent == wxT("..") ) {
 390         // go up one level
 391         if ( aParts.IsEmpty() )
 392           wxLogWarning(_("'%s' has extra '..', ignored."), sz);
 393         else
 394           aParts.Remove(aParts.Count() - 1);
 395
 396         strCurrent.Empty();
 397       }
 398       else if ( !strCurrent.IsEmpty() ) {
 399         aParts.Add(strCurrent);
 400         strCurrent.Empty();
 401       }
 402       //else:
 403         // could log an error here, but we prefer to ignore extra '/'
 404
 405       if ( *pc == wxT('\0') )
 406         break;
 407     }
 408     else
 409       strCurrent += *pc;
 410
 411     pc++;
 412   }
 413 }
 414
 415 #endif // wxUSE_CONFIG
 416