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/regconf.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
 214 // ----------------------------------------------------------------------------
 215 // wxConfigPathChanger
 216 // ----------------------------------------------------------------------------
 217
 218 wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer,
 219                                  const wxString& strEntry)
 220 {
 221   m_pContainer = (wxConfigBase *)pContainer;
 222   wxString strPath = strEntry.Before(wxCONFIG_PATH_SEPARATOR);
 223
 224   // special case of "/keyname" when there is nothing before "/"
 225   if ( strPath.IsEmpty() && ((!strEntry.IsEmpty()) && strEntry[0] == wxCONFIG_PATH_SEPARATOR ))
 226     strPath = wxCONFIG_PATH_SEPARATOR;
 227
 228   if ( !strPath.IsEmpty() ) {
 229     // do change the path
 230     m_bChanged = TRUE;
 231     m_strName = strEntry.Right(wxCONFIG_PATH_SEPARATOR);
 232     m_strOldPath = m_pContainer->GetPath();
 233     m_strOldPath += wxCONFIG_PATH_SEPARATOR;
 234     m_pContainer->SetPath(strPath);
 235   }
 236   else {
 237     // it's a name only, without path - nothing to do
 238     m_bChanged = FALSE;
 239     m_strName = strEntry;
 240   }
 241 }
 242
 243 wxConfigPathChanger::~wxConfigPathChanger()
 244 {
 245   // only restore path if it was changed
 246   if ( m_bChanged ) {
 247     m_pContainer->SetPath(m_strOldPath);
 248   }
 249 }
 250
 251 // ----------------------------------------------------------------------------
 252 // static & global functions
 253 // ----------------------------------------------------------------------------
 254
 255 // understands both Unix and Windows (but only under Windows) environment
 256 // variables expansion: i.e. $var, $(var) and ${var} are always understood
 257 // and in addition under Windows %var% is also.
 258 wxString wxExpandEnvVars(const wxString& str)
 259 {
 260   wxString strResult;
 261   strResult.Alloc(str.Len());
 262
 263   // don't change the values the enum elements: they must be equal
 264   // to the matching [closing] delimiter.
 265   enum Bracket
 266   {
 267     Bracket_None,
 268     Bracket_Normal  = ')',
 269     Bracket_Curly   = '}',
 270 #ifdef  __WXMSW__
 271     Bracket_Windows = '%'     // yeah, Windows people are a bit strange ;-)
 272 #endif
 273   };
 274
 275   size_t m;
 276   for ( size_t n = 0; n < str.Len(); n++ ) {
 277     switch ( str[n] ) {
 278 #ifdef  __WXMSW__
 279       case '%':
 280 #endif  //WINDOWS
 281       case '$':
 282         {
 283           Bracket bracket;
 284           #ifdef  __WXMSW__
 285             if ( str[n] == '%' )
 286               bracket = Bracket_Windows;
 287             else
 288           #endif  //WINDOWS
 289           if ( n == str.Len() - 1 ) {
 290             bracket = Bracket_None;
 291           }
 292           else {
 293             switch ( str[n + 1] ) {
 294               case '(':
 295                 bracket = Bracket_Normal;
 296                 n++;                   // skip the bracket
 297                 break;
 298
 299               case '{':
 300                 bracket = Bracket_Curly;
 301                 n++;                   // skip the bracket
 302                 break;
 303
 304               default:
 305                 bracket = Bracket_None;
 306             }
 307           }
 308
 309           m = n + 1;
 310
 311           while ( m < str.Len() && (isalnum(str[m]) || str[m] == '_') )
 312             m++;
 313
 314           wxString strVarName(str.c_str() + n + 1, m - n - 1);
 315
 316           const char *pszValue = getenv(strVarName);
 317           if ( pszValue != NULL ) {
 318             strResult += pszValue;
 319           }
 320           else {
 321             // variable doesn't exist => don't change anything
 322             #ifdef  __WXMSW__
 323               if ( bracket != Bracket_Windows )
 324             #endif
 325                 if ( bracket != Bracket_None )
 326                   strResult << str[n - 1];
 327             strResult << str[n] << strVarName;
 328           }
 329
 330           // check the closing bracket
 331           if ( bracket != Bracket_None ) {
 332             if ( m == str.Len() || str[m] != (char)bracket ) {
 333               wxLogWarning(_("Environment variables expansion failed: "
 334                              "missing '%c' at position %d in '%s'."),
 335                            (char)bracket, m + 1, str.c_str());
 336             }
 337             else {
 338               // skip closing bracket unless the variables wasn't expanded
 339               if ( pszValue == NULL )
 340                 strResult << (char)bracket;
 341               m++;
 342             }
 343           }
 344
 345           n = m - 1;  // skip variable name
 346         }
 347         break;
 348
 349       case '\\':
 350         // backslash can be used to suppress special meaning of % and $
 351         if ( n != str.Len() && (str[n + 1] == '%' || str[n + 1] == '$') ) {
 352           strResult += str[++n];
 353
 354           break;
 355         }
 356         //else: fall through
 357
 358       default:
 359         strResult += str[n];
 360     }
 361   }
 362
 363   return strResult;
 364 }
 365
 366 // this function is used to properly interpret '..' in path
 367 void wxSplitPath(wxArrayString& aParts, const char *sz)
 368 {
 369   aParts.Empty();
 370
 371   wxString strCurrent;
 372   const char *pc = sz;
 373   for ( ;; ) {
 374     if ( *pc == '\0' || *pc == wxCONFIG_PATH_SEPARATOR ) {
 375       if ( strCurrent == "." ) {
 376         // ignore
 377       }
 378       else if ( strCurrent == ".." ) {
 379         // go up one level
 380         if ( aParts.IsEmpty() )
 381           wxLogWarning(_("'%s' has extra '..', ignored."), sz);
 382         else
 383           aParts.Remove(aParts.Count() - 1);
 384
 385         strCurrent.Empty();
 386       }
 387       else if ( !strCurrent.IsEmpty() ) {
 388         aParts.Add(strCurrent);
 389         strCurrent.Empty();
 390       }
 391       //else:
 392         // could log an error here, but we prefer to ignore extra '/'
 393
 394       if ( *pc == '\0' )
 395         return;
 396     }
 397     else
 398       strCurrent += *pc;
 399
 400     pc++;
 401   }
 402 }
 403
 404