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 // declarations
  15 // ============================================================================
  16
  17 // ----------------------------------------------------------------------------
  18 // headers
  19 // ----------------------------------------------------------------------------
  20 #ifdef __GNUG__
  21   #pragma implementation "confbase.h"
  22 #endif
  23
  24 #include  "wx/wxprec.h"
  25
  26 #ifdef    __BORLANDC__
  27   #pragma hdrstop
  28 #endif  //__BORLANDC__
  29
  30 #ifndef WX_PRECOMP
  31   #include  <wx/string.h>
  32   #include  <wx/intl.h>
  33 #endif //WX_PRECOMP
  34
  35 #include  <wx/app.h>
  36 #include  <wx/file.h>
  37 #include  <wx/log.h>
  38 #include  <wx/textfile.h>
  39 #include  <wx/confbase.h>
  40 #include  <wx/utils.h>
  41
  42 // we must include (one of) these files for wxConfigBase::Create
  43 #if defined(__WXMSW__) && defined(wxCONFIG_WIN32_NATIVE)
  44   #ifdef __WIN32__
  45     #include  <wx/msw/iniconf.h>
  46   #else  //WIN16
  47     #include  <wx/msw/iniconf.h>
  48   #endif
  49 #else // either we're under Unix or wish to use files even under Windows
  50   #include  <wx/fileconf.h>
  51 #endif
  52
  53 #include  <stdlib.h>
  54 #include  <math.h>
  55 #include  <ctype.h>       // for isalnum()
  56
  57 // ----------------------------------------------------------------------------
  58 // global and class static variables
  59 // ----------------------------------------------------------------------------
  60
  61 wxConfigBase *wxConfigBase::ms_pConfig     = NULL;
  62 bool          wxConfigBase::ms_bAutoCreate = TRUE;
  63
  64 // ============================================================================
  65 // implementation
  66 // ============================================================================
  67
  68 // ----------------------------------------------------------------------------
  69 // wxConfigBase
  70 // ----------------------------------------------------------------------------
  71
  72 // Not all args will always be used by derived classes, but
  73 // including them all in each class ensures compatibility.
  74 wxConfigBase::wxConfigBase(const wxString& appName, const wxString& vendorName,
  75     const wxString& WXUNUSED(localFilename), const wxString& WXUNUSED(globalFilename), long style):
  76         m_appName(appName), m_vendorName(vendorName), m_style(style)
  77 {
  78     m_bExpandEnvVars = TRUE; m_bRecordDefaults = FALSE;
  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__) && defined(wxCONFIG_WIN32_NATIVE)
  93       #ifdef __WIN32__
  94         new wxRegConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
  95       #else  //WIN16
  96         new wxIniConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
  97       #endif
  98     #else // either we're under Unix or wish to use files even under Windows
  99       new wxFileConfig(wxTheApp->GetAppName());
 100     #endif
 101   }
 102
 103   return ms_pConfig;
 104 }
 105
 106 wxString wxConfigBase::Read(const wxString& key, const wxString& defVal) const
 107 {
 108   wxString s;
 109   Read(key, &s, defVal);
 110   return s;
 111 }
 112
 113 bool wxConfigBase::Read(const wxString& key, wxString *str, const wxString& defVal) const
 114 {
 115     if (!Read(key, str))
 116     {
 117         *str = ExpandEnvVars(defVal);
 118         return FALSE;
 119     }
 120     else
 121         return TRUE;
 122 }
 123
 124 bool wxConfigBase::Read(const wxString& key, long *pl, long defVal) const
 125 {
 126     if (!Read(key, pl))
 127     {
 128         *pl = defVal;
 129         return FALSE;
 130     }
 131     else
 132         return TRUE;
 133 }
 134
 135 bool wxConfigBase::Read(const wxString& key, double* val) const
 136 {
 137     wxString str;
 138     if (Read(key, & str))
 139     {
 140         *val = atof(str);
 141         return TRUE;
 142     }
 143     else
 144         return FALSE;
 145 }
 146
 147 bool wxConfigBase::Read(const wxString& key, double* val, double defVal) const
 148 {
 149     if (!Read(key, val))
 150     {
 151         *val = defVal;
 152         return FALSE;
 153     }
 154     else
 155         return TRUE;
 156 }
 157
 158 bool wxConfigBase::Read(const wxString& key, bool* val) const
 159 {
 160     long l;
 161     if (Read(key, & l))
 162     {
 163         *val = (l != 0);
 164         return TRUE;
 165     }
 166     else
 167         return FALSE;
 168 }
 169
 170 bool wxConfigBase::Read(const wxString& key, bool* val, bool defVal) const
 171 {
 172     if (!Read(key, val))
 173     {
 174         *val = defVal;
 175         return FALSE;
 176     }
 177     else
 178         return TRUE;
 179 }
 180
 181 // Convenience functions
 182
 183 bool wxConfigBase::Read(const wxString& key, int *pi) const
 184 {
 185     long l;
 186     bool ret = Read(key, &l);
 187     if (ret)
 188         *pi = (int) l;
 189     return ret;
 190 }
 191
 192 bool wxConfigBase::Read(const wxString& key, int *pi, int defVal) const
 193 {
 194     long l;
 195     bool ret = Read(key, &l, (long) defVal);
 196     *pi = (int) l;
 197     return ret;
 198 }
 199
 200 bool wxConfigBase::Write(const wxString& key, double val)
 201 {
 202     wxString str;
 203     str.Printf("%f", val);
 204     return Write(key, str);
 205 }
 206
 207 bool wxConfigBase::Write(const wxString& key, bool value)
 208 {
 209     long l = (value ? 1 : 0);
 210     return Write(key, l);
 211 }
 212
 213 wxString wxConfigBase::ExpandEnvVars(const wxString& str) const
 214 {
 215     wxString tmp; // Required for BC++
 216     if (IsExpandingEnvVars())
 217         tmp = wxExpandEnvVars(str);
 218     else
 219         tmp = str;
 220     return tmp;
 221 }
 222
 223 // ----------------------------------------------------------------------------
 224 // wxConfigPathChanger
 225 // ----------------------------------------------------------------------------
 226
 227 wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer,
 228                                  const wxString& strEntry)
 229 {
 230   m_pContainer = (wxConfigBase *)pContainer;
 231   wxString strPath = strEntry.Before(wxCONFIG_PATH_SEPARATOR);
 232
 233   // special case of "/keyname" when there is nothing before "/"
 234   if ( strPath.IsEmpty() && ((!strEntry.IsEmpty()) && strEntry[0] == wxCONFIG_PATH_SEPARATOR ))
 235     strPath = wxCONFIG_PATH_SEPARATOR;
 236
 237   if ( !strPath.IsEmpty() ) {
 238     // do change the path
 239     m_bChanged = TRUE;
 240     m_strName = strEntry.Right(wxCONFIG_PATH_SEPARATOR);
 241     m_strOldPath = m_pContainer->GetPath();
 242     m_strOldPath += wxCONFIG_PATH_SEPARATOR;
 243     m_pContainer->SetPath(strPath);
 244   }
 245   else {
 246     // it's a name only, without path - nothing to do
 247     m_bChanged = FALSE;
 248     m_strName = strEntry;
 249   }
 250 }
 251
 252 wxConfigPathChanger::~wxConfigPathChanger()
 253 {
 254   // only restore path if it was changed
 255   if ( m_bChanged ) {
 256     m_pContainer->SetPath(m_strOldPath);
 257   }
 258 }
 259
 260 // ----------------------------------------------------------------------------
 261 // static & global functions
 262 // ----------------------------------------------------------------------------
 263
 264 // understands both Unix and Windows (but only under Windows) environment
 265 // variables expansion: i.e. $var, $(var) and ${var} are always understood
 266 // and in addition under Windows %var% is also.
 267 wxString wxExpandEnvVars(const wxString& str)
 268 {
 269   wxString strResult;
 270   strResult.Alloc(str.Len());
 271
 272   // don't change the values the enum elements: they must be equal
 273   // to the matching [closing] delimiter.
 274   enum Bracket
 275   {
 276     Bracket_None,
 277     Bracket_Normal  = ')',
 278     Bracket_Curly   = '}',
 279 #ifdef  __WXMSW__
 280     Bracket_Windows = '%'     // yeah, Windows people are a bit strange ;-)
 281 #endif
 282   };
 283
 284   size_t m;
 285   for ( size_t n = 0; n < str.Len(); n++ ) {
 286     switch ( str[n] ) {
 287 #ifdef  __WXMSW__
 288       case '%':
 289 #endif  //WINDOWS
 290       case '$':
 291         {
 292           Bracket bracket;
 293           #ifdef  __WXMSW__
 294             if ( str[n] == '%' )
 295               bracket = Bracket_Windows;
 296             else
 297           #endif  //WINDOWS
 298           if ( n == str.Len() - 1 ) {
 299             bracket = Bracket_None;
 300           }
 301           else {
 302             switch ( str[n + 1] ) {
 303               case '(':
 304                 bracket = Bracket_Normal;
 305                 n++;                   // skip the bracket
 306                 break;
 307
 308               case '{':
 309                 bracket = Bracket_Curly;
 310                 n++;                   // skip the bracket
 311                 break;
 312
 313               default:
 314                 bracket = Bracket_None;
 315             }
 316           }
 317
 318           m = n + 1;
 319
 320           while ( m < str.Len() && (isalnum(str[m]) || str[m] == '_') )
 321             m++;
 322
 323           wxString strVarName(str.c_str() + n + 1, m - n - 1);
 324
 325           const char *pszValue = getenv(strVarName);
 326           if ( pszValue != NULL ) {
 327             strResult += pszValue;
 328           }
 329           else {
 330             // variable doesn't exist => don't change anything
 331             #ifdef  __WXMSW__
 332               if ( bracket != Bracket_Windows )
 333             #endif
 334                 if ( bracket != Bracket_None )
 335                   strResult << str[n - 1];
 336             strResult << str[n] << strVarName;
 337           }
 338
 339           // check the closing bracket
 340           if ( bracket != Bracket_None ) {
 341             if ( m == str.Len() || str[m] != (char)bracket ) {
 342               wxLogWarning(_("Environment variables expansion failed: "
 343                              "missing '%c' at position %d in '%s'."),
 344                            (char)bracket, m + 1, str.c_str());
 345             }
 346             else {
 347               // skip closing bracket unless the variables wasn't expanded
 348               if ( pszValue == NULL )
 349                 strResult << (char)bracket;
 350               m++;
 351             }
 352           }
 353
 354           n = m - 1;  // skip variable name
 355         }
 356         break;
 357
 358       case '\\':
 359         // backslash can be used to suppress special meaning of % and $
 360         if ( n != str.Len() && (str[n + 1] == '%' || str[n + 1] == '$') ) {
 361           strResult += str[++n];
 362
 363           break;
 364         }
 365         //else: fall through
 366
 367       default:
 368         strResult += str[n];
 369     }
 370   }
 371
 372   return strResult;
 373 }
 374
 375 // this function is used to properly interpret '..' in path
 376 void wxSplitPath(wxArrayString& aParts, const char *sz)
 377 {
 378   aParts.Empty();
 379
 380   wxString strCurrent;
 381   const char *pc = sz;
 382   for ( ;; ) {
 383     if ( *pc == '\0' || *pc == wxCONFIG_PATH_SEPARATOR ) {
 384       if ( strCurrent == "." ) {
 385         // ignore
 386       }
 387       else if ( strCurrent == ".." ) {
 388         // go up one level
 389         if ( aParts.IsEmpty() )
 390           wxLogWarning(_("'%s' has extra '..', ignored."), sz);
 391         else
 392           aParts.Remove(aParts.Count() - 1);
 393
 394         strCurrent.Empty();
 395       }
 396       else if ( !strCurrent.IsEmpty() ) {
 397         aParts.Add(strCurrent);
 398         strCurrent.Empty();
 399       }
 400       //else:
 401         // could log an error here, but we prefer to ignore extra '/'
 402
 403       if ( *pc == '\0' )
 404         return;
 405     }
 406     else
 407       strCurrent += *pc;
 408
 409     pc++;
 410   }
 411 }