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 #if wxUSE_CONFIG && ((wxUSE_FILE && wxUSE_TEXTFILE) || defined(wxCONFIG_WIN32_NATIVE))
  27
  28 #include "wx/app.h"
  29 #include "wx/file.h"
  30 #include "wx/log.h"
  31 #include "wx/textfile.h"
  32 #include "wx/utils.h"
  33 #include "wx/log.h"
  34 #include "wx/utils.h"
  35 #include "wx/intl.h"
  36
  37 #include "wx/config.h"
  38
  39 #include <stdlib.h>
  40 #include <math.h>
  41 #include <ctype.h>    // for isalnum()
  42
  43 // ----------------------------------------------------------------------------
  44 // global and class static variables
  45 // ----------------------------------------------------------------------------
  46
  47 wxConfigBase *wxConfigBase::ms_pConfig     = NULL;
  48 bool          wxConfigBase::ms_bAutoCreate = TRUE;
  49
  50 // ============================================================================
  51 // implementation
  52 // ============================================================================
  53
  54 // ----------------------------------------------------------------------------
  55 // wxConfigBase
  56 // ----------------------------------------------------------------------------
  57
  58 // Not all args will always be used by derived classes, but
  59 // including them all in each class ensures compatibility.
  60 wxConfigBase::wxConfigBase(const wxString& appName, const wxString& vendorName,
  61     const wxString& WXUNUSED(localFilename), const wxString& WXUNUSED(globalFilename), long style):
  62         m_appName(appName), m_vendorName(vendorName), m_style(style)
  63 {
  64     m_bExpandEnvVars = TRUE; m_bRecordDefaults = FALSE;
  65 }
  66
  67 wxConfigBase *wxConfigBase::Set(wxConfigBase *pConfig)
  68 {
  69   wxConfigBase *pOld = ms_pConfig;
  70   ms_pConfig = pConfig;
  71   return pOld;
  72 }
  73
  74 wxConfigBase *wxConfigBase::Create()
  75 {
  76   if ( ms_bAutoCreate && ms_pConfig == NULL ) {
  77     ms_pConfig =
  78     #if defined(__WXMSW__) && defined(wxCONFIG_WIN32_NATIVE)
  79       #ifdef __WIN32__
  80         new wxRegConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
  81       #else  //WIN16
  82         new wxIniConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
  83       #endif
  84     #else // either we're under Unix or wish to use files even under Windows
  85       new wxFileConfig(wxTheApp->GetAppName());
  86     #endif
  87   }
  88
  89   return ms_pConfig;
  90 }
  91
  92 wxString wxConfigBase::Read(const wxString& key, const wxString& defVal) const
  93 {
  94   wxString s;
  95   Read(key, &s, defVal);
  96   return s;
  97 }
  98
  99 bool wxConfigBase::Read(const wxString& key, wxString *str, const wxString& defVal) const
 100 {
 101     if (!Read(key, str))
 102     {
 103         *str = ExpandEnvVars(defVal);
 104         return FALSE;
 105     }
 106     else
 107         return TRUE;
 108 }
 109
 110 bool wxConfigBase::Read(const wxString& key, long *pl, long defVal) const
 111 {
 112     if (!Read(key, pl))
 113     {
 114         *pl = defVal;
 115         return FALSE;
 116     }
 117     else
 118         return TRUE;
 119 }
 120
 121 bool wxConfigBase::Read(const wxString& key, double* val) const
 122 {
 123     wxString str;
 124     if (Read(key, & str))
 125     {
 126         *val = wxAtof(str);
 127         return TRUE;
 128     }
 129     else
 130         return FALSE;
 131 }
 132
 133 bool wxConfigBase::Read(const wxString& key, double* val, double defVal) const
 134 {
 135     if (!Read(key, val))
 136     {
 137         *val = defVal;
 138         return FALSE;
 139     }
 140     else
 141         return TRUE;
 142 }
 143
 144 bool wxConfigBase::Read(const wxString& key, bool* val) const
 145 {
 146     long l;
 147     if (Read(key, & l))
 148     {
 149         *val = (l != 0);
 150         return TRUE;
 151     }
 152     else
 153         return FALSE;
 154 }
 155
 156 bool wxConfigBase::Read(const wxString& key, bool* val, bool defVal) const
 157 {
 158     if (!Read(key, val))
 159     {
 160         *val = defVal;
 161         return FALSE;
 162     }
 163     else
 164         return TRUE;
 165 }
 166
 167 // Convenience functions
 168
 169 bool wxConfigBase::Read(const wxString& key, int *pi) const
 170 {
 171     long l;
 172     bool ret = Read(key, &l);
 173     if (ret)
 174         *pi = (int) l;
 175     return ret;
 176 }
 177
 178 bool wxConfigBase::Read(const wxString& key, int *pi, int defVal) const
 179 {
 180     long l;
 181     bool ret = Read(key, &l, (long) defVal);
 182     *pi = (int) l;
 183     return ret;
 184 }
 185
 186 bool wxConfigBase::Write(const wxString& key, double val)
 187 {
 188     wxString str;
 189     str.Printf(wxT("%f"), val);
 190     return Write(key, str);
 191 }
 192
 193 bool wxConfigBase::Write(const wxString& key, bool value)
 194 {
 195     long l = (value ? 1 : 0);
 196     return Write(key, l);
 197 }
 198
 199 wxString wxConfigBase::ExpandEnvVars(const wxString& str) const
 200 {
 201     wxString tmp; // Required for BC++
 202     if (IsExpandingEnvVars())
 203         tmp = wxExpandEnvVars(str);
 204     else
 205         tmp = str;
 206     return tmp;
 207 }
 208
 209 // ----------------------------------------------------------------------------
 210 // wxConfigPathChanger
 211 // ----------------------------------------------------------------------------
 212
 213 wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer,
 214                                  const wxString& strEntry)
 215 {
 216   m_pContainer = (wxConfigBase *)pContainer;
 217
 218   // the path is everything which precedes the last slash
 219   wxString strPath = strEntry.BeforeLast(wxCONFIG_PATH_SEPARATOR);
 220
 221   // except in the special case of "/keyname" when there is nothing before "/"
 222   if ( strPath.IsEmpty() &&
 223        ((!strEntry.IsEmpty()) && strEntry[0] == wxCONFIG_PATH_SEPARATOR) )
 224   {
 225     strPath = wxCONFIG_PATH_SEPARATOR;
 226   }
 227
 228   if ( !strPath.IsEmpty() ) {
 229     // do change the path
 230     m_bChanged = TRUE;
 231     m_strName = strEntry.AfterLast(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 wxChar *pszValue = wxGetenv(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 wxChar *sz)
 368 {
 369   aParts.Empty();
 370
 371   wxString strCurrent;
 372   const wxChar *pc = sz;
 373   for ( ;; ) {
 374     if ( *pc == wxT('\0') || *pc == wxCONFIG_PATH_SEPARATOR ) {
 375       if ( strCurrent == wxT(".") ) {
 376         // ignore
 377       }
 378       else if ( strCurrent == wxT("..") ) {
 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 == wxT('\0') )
 395         return;
 396     }
 397     else
 398       strCurrent += *pc;
 399
 400     pc++;
 401   }
 402 }
 403
 404 #endif // wxUSE_CONFIG
 405