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>    // for isalnum()
  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
  63 // including them all in each class ensures compatibility.
  64 wxConfigBase::wxConfigBase(const wxString& appName, const wxString& vendorName,
  65     const wxString& WXUNUSED(localFilename), const wxString& WXUNUSED(globalFilename), long style):
  66         m_appName(appName), m_vendorName(vendorName), m_style(style)
  67 {
  68     m_bExpandEnvVars = TRUE; m_bRecordDefaults = FALSE;
  69 }
  70
  71 wxConfigBase *wxConfigBase::Set(wxConfigBase *pConfig)
  72 {
  73   wxConfigBase *pOld = ms_pConfig;
  74   ms_pConfig = pConfig;
  75   return pOld;
  76 }
  77
  78 wxConfigBase *wxConfigBase::Create()
  79 {
  80   if ( ms_bAutoCreate && ms_pConfig == NULL ) {
  81     ms_pConfig =
  82     #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
  83       #ifdef __WIN32__
  84         new wxRegConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
  85       #else  //WIN16
  86         new wxIniConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
  87       #endif
  88     #else // either we're under Unix or wish to use files even under Windows
  89       new wxFileConfig(wxTheApp->GetAppName());
  90     #endif
  91   }
  92
  93   return ms_pConfig;
  94 }
  95
  96 wxString wxConfigBase::Read(const wxString& key, const wxString& defVal) const
  97 {
  98   wxString s;
  99   Read(key, &s, defVal);
 100   return s;
 101 }
 102
 103 bool wxConfigBase::Read(const wxString& key, wxString *str, const wxString& defVal) const
 104 {
 105     if (!Read(key, str))
 106     {
 107         *str = ExpandEnvVars(defVal);
 108         return FALSE;
 109     }
 110     else
 111         return TRUE;
 112 }
 113
 114 bool wxConfigBase::Read(const wxString& key, long *pl, long defVal) const
 115 {
 116     if (!Read(key, pl))
 117     {
 118         *pl = defVal;
 119         return FALSE;
 120     }
 121     else
 122         return TRUE;
 123 }
 124
 125 bool wxConfigBase::Read(const wxString& key, double* val) const
 126 {
 127     wxString str;
 128     if (Read(key, & str))
 129     {
 130         *val = wxAtof(str);
 131         return TRUE;
 132     }
 133     else
 134         return FALSE;
 135 }
 136
 137 bool wxConfigBase::Read(const wxString& key, double* val, double defVal) const
 138 {
 139     if (!Read(key, val))
 140     {
 141         *val = defVal;
 142         return FALSE;
 143     }
 144     else
 145         return TRUE;
 146 }
 147
 148 bool wxConfigBase::Read(const wxString& key, bool* val) const
 149 {
 150     long l;
 151     if (Read(key, & l))
 152     {
 153         *val = (l != 0);
 154         return TRUE;
 155     }
 156     else
 157         return FALSE;
 158 }
 159
 160 bool wxConfigBase::Read(const wxString& key, bool* val, bool defVal) const
 161 {
 162     if (!Read(key, val))
 163     {
 164         *val = defVal;
 165         return FALSE;
 166     }
 167     else
 168         return TRUE;
 169 }
 170
 171 // Convenience functions
 172
 173 bool wxConfigBase::Read(const wxString& key, int *pi) const
 174 {
 175     long l;
 176     bool ret = Read(key, &l);
 177     if (ret)
 178         *pi = (int) l;
 179     return ret;
 180 }
 181
 182 bool wxConfigBase::Read(const wxString& key, int *pi, int defVal) const
 183 {
 184     long l;
 185     bool ret = Read(key, &l, (long) defVal);
 186     *pi = (int) l;
 187     return ret;
 188 }
 189
 190 bool wxConfigBase::Write(const wxString& key, double val)
 191 {
 192     wxString str;
 193     str.Printf(wxT("%f"), val);
 194     return Write(key, str);
 195 }
 196
 197 bool wxConfigBase::Write(const wxString& key, bool value)
 198 {
 199     long l = (value ? 1 : 0);
 200     return Write(key, l);
 201 }
 202
 203 bool wxConfigBase::Write( const wxString &key, const wxChar *text )
 204 {
 205         wxString str( text ) ;
 206         return Write( key, str ) ;
 207 }
 208 wxString wxConfigBase::ExpandEnvVars(const wxString& str) const
 209 {
 210     wxString tmp; // Required for BC++
 211     if (IsExpandingEnvVars())
 212         tmp = wxExpandEnvVars(str);
 213     else
 214         tmp = str;
 215     return tmp;
 216 }
 217
 218 // ----------------------------------------------------------------------------
 219 // wxConfigPathChanger
 220 // ----------------------------------------------------------------------------
 221
 222 wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer,
 223                                  const wxString& strEntry)
 224 {
 225   m_pContainer = (wxConfigBase *)pContainer;
 226
 227   // the path is everything which precedes the last slash
 228   wxString strPath = strEntry.BeforeLast(wxCONFIG_PATH_SEPARATOR);
 229
 230   // except in the special case of "/keyname" when there is nothing before "/"
 231   if ( strPath.IsEmpty() &&
 232        ((!strEntry.IsEmpty()) && strEntry[0] == wxCONFIG_PATH_SEPARATOR) )
 233   {
 234     strPath = wxCONFIG_PATH_SEPARATOR;
 235   }
 236
 237   if ( !strPath.IsEmpty() ) {
 238     // do change the path
 239     m_bChanged = TRUE;
 240     m_strName = strEntry.AfterLast(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 wxChar *pszValue = wxGetenv(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: missing '%c' at position %d in '%s'."),
 343                            (char)bracket, m + 1, str.c_str());
 344             }
 345             else {
 346               // skip closing bracket unless the variables wasn't expanded
 347               if ( pszValue == NULL )
 348                 strResult << (char)bracket;
 349               m++;
 350             }
 351           }
 352
 353           n = m - 1;  // skip variable name
 354         }
 355         break;
 356
 357       case '\\':
 358         // backslash can be used to suppress special meaning of % and $
 359         if ( n != str.Len() && (str[n + 1] == '%' || str[n + 1] == '$') ) {
 360           strResult += str[++n];
 361
 362           break;
 363         }
 364         //else: fall through
 365
 366       default:
 367         strResult += str[n];
 368     }
 369   }
 370
 371   return strResult;
 372 }
 373
 374 // this function is used to properly interpret '..' in path
 375 void wxSplitPath(wxArrayString& aParts, const wxChar *sz)
 376 {
 377   aParts.Empty();
 378
 379   wxString strCurrent;
 380   const wxChar *pc = sz;
 381   for ( ;; ) {
 382     if ( *pc == wxT('\0') || *pc == wxCONFIG_PATH_SEPARATOR ) {
 383       if ( strCurrent == wxT(".") ) {
 384         // ignore
 385       }
 386       else if ( strCurrent == wxT("..") ) {
 387         // go up one level
 388         if ( aParts.IsEmpty() )
 389           wxLogWarning(_("'%s' has extra '..', ignored."), sz);
 390         else
 391           aParts.Remove(aParts.Count() - 1);
 392
 393         strCurrent.Empty();
 394       }
 395       else if ( !strCurrent.IsEmpty() ) {
 396         aParts.Add(strCurrent);
 397         strCurrent.Empty();
 398       }
 399       //else:
 400         // could log an error here, but we prefer to ignore extra '/'
 401
 402       if ( *pc == wxT('\0') )
 403         return;
 404     }
 405     else
 406       strCurrent += *pc;
 407
 408     pc++;
 409   }
 410 }
 411
 412 #endif // wxUSE_CONFIG
 413