PyCrust updates

[wxWidgets.git] / src / common / config.cpp

diff --git a/src/common/config.cpp b/src/common/config.cpp
index ddb5a9d71658bcb3fe50d5440a2898ad51521cf9..286e2123aa6844bc58ee27d52af6feb2b74ed210 100644 (file)
--- a/src/common/config.cpp
+++ b/src/common/config.cpp
@@ -1,49 +1,265 @@
 ///////////////////////////////////////////////////////////////////////////////
 // Name:        config.cpp
 ///////////////////////////////////////////////////////////////////////////////
 // Name:        config.cpp

-// Purpose:     implementation of wxConfig class
+// Purpose:     implementation of wxConfigBase class

 // Author:      Vadim Zeitlin
 // Author:      Vadim Zeitlin

-// Modified by: 
+// Modified by:

 // Created:     07.04.98
 // RCS-ID:      $Id$
 // Created:     07.04.98
 // RCS-ID:      $Id$

-// Copyright:   (c) 1997 Karsten Ballüder   Ballueder@usa.net  
+// Copyright:   (c) 1997 Karsten Ballüder   Ballueder@usa.net

 //                       Vadim Zeitlin      <zeitlin@dptmaths.ens-cachan.fr>
 // Licence:     wxWindows license
 ///////////////////////////////////////////////////////////////////////////////
 
 //                       Vadim Zeitlin      <zeitlin@dptmaths.ens-cachan.fr>
 // Licence:     wxWindows license
 ///////////////////////////////////////////////////////////////////////////////
 

-// ============================================================================
+// ----------------------------------------------------------------------------

 // headers
 // headers

-// ============================================================================
+// ----------------------------------------------------------------------------

 #ifdef __GNUG__
 #ifdef __GNUG__

-#pragma implementation "app.h"
+    #pragma implementation "confbase.h"

 #endif
 
 #endif
 

-#include  "wx/wxprec.h"
+#include "wx/wxprec.h"

 
 #ifdef    __BORLANDC__
   #pragma hdrstop
 #endif  //__BORLANDC__
 
 
 #ifdef    __BORLANDC__
   #pragma hdrstop
 #endif  //__BORLANDC__
 

-#include  <wx/string.h>
-#include  <wx/intl.h>
-#include  <wx/file.h>
-#include  <wx/log.h>
-#include  <wx/textfile.h>
-#include  <wx/config.h>
+#ifndef wxUSE_CONFIG_NATIVE
+    #define wxUSE_CONFIG_NATIVE 1
+#endif
+
+#include "wx/config.h"
+#include "wx/intl.h"
+#include "wx/log.h"
+
+#if wxUSE_CONFIG && ((wxUSE_FILE && wxUSE_TEXTFILE) || wxUSE_CONFIG_NATIVE)
+
+#include "wx/app.h"
+#include "wx/file.h"
+#include "wx/textfile.h"
+#include "wx/utils.h"
+#include "wx/utils.h"

 
 #include <stdlib.h>
 
 #include <stdlib.h>

+#include <math.h>

 #include <ctype.h>
 #include <ctype.h>

+#include <limits.h>     // for INT_MAX
+
+// ----------------------------------------------------------------------------
+// global and class static variables
+// ----------------------------------------------------------------------------
+
+wxConfigBase *wxConfigBase::ms_pConfig     = NULL;
+bool          wxConfigBase::ms_bAutoCreate = TRUE;

 
 // ============================================================================
 // implementation
 // ============================================================================
 
 // ----------------------------------------------------------------------------
 
 // ============================================================================
 // implementation
 // ============================================================================
 
 // ----------------------------------------------------------------------------

-// wxConfig
+// wxConfigBase
+// ----------------------------------------------------------------------------
+
+// Not all args will always be used by derived classes, but including them all
+// in each class ensures compatibility.
+wxConfigBase::wxConfigBase(const wxString& appName,
+                           const wxString& vendorName,
+                           const wxString& WXUNUSED(localFilename),
+                           const wxString& WXUNUSED(globalFilename),
+                           long style)
+            : m_appName(appName), m_vendorName(vendorName), m_style(style)
+{
+    m_bExpandEnvVars = TRUE; m_bRecordDefaults = FALSE;
+}
+
+wxConfigBase::~wxConfigBase()
+{
+}
+
+wxConfigBase *wxConfigBase::Set(wxConfigBase *pConfig)
+{
+  wxConfigBase *pOld = ms_pConfig;
+  ms_pConfig = pConfig;
+  return pOld;
+}
+
+wxConfigBase *wxConfigBase::Create()
+{
+  if ( ms_bAutoCreate && ms_pConfig == NULL ) {
+    ms_pConfig =
+    #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
+      #ifdef __WIN32__
+        new wxRegConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
+      #else  //WIN16
+        new wxIniConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
+      #endif
+    #else // either we're under Unix or wish to use files even under Windows
+      new wxFileConfig(wxTheApp->GetAppName());
+    #endif
+  }
+
+  return ms_pConfig;
+}
+
+// ----------------------------------------------------------------------------
+// wxConfigBase reading entries
+// ----------------------------------------------------------------------------
+
+// implement both Read() overloads for the given type in terms of DoRead()
+#define IMPLEMENT_READ_FOR_TYPE(name, type, deftype, extra)                 \
+    bool wxConfigBase::Read(const wxString& key, type *val) const           \
+    {                                                                       \
+        wxCHECK_MSG( val, FALSE, _T("wxConfig::Read(): NULL parameter") );  \
+                                                                            \
+        return DoRead##name(key, val);                                      \
+    }                                                                       \
+                                                                            \
+    bool wxConfigBase::Read(const wxString& key,                            \
+                            type *val,                                      \
+                            deftype defVal) const                           \
+    {                                                                       \
+        wxCHECK_MSG( val, FALSE, _T("wxConfig::Read(): NULL parameter") );  \
+                                                                            \
+        if ( DoRead##name(key, val) )                                       \
+            return TRUE;                                                    \
+                                                                            \
+        if ( IsRecordingDefaults() )                                        \
+        {                                                                   \
+            ((wxConfigBase *)this)->DoWrite##name(key, defVal);             \
+        }                                                                   \
+                                                                            \
+        *val = extra(defVal);                                               \
+                                                                            \
+        return FALSE;                                                       \
+    }
+
+
+IMPLEMENT_READ_FOR_TYPE(String, wxString, const wxString&, ExpandEnvVars)
+IMPLEMENT_READ_FOR_TYPE(Long, long, long, long)
+IMPLEMENT_READ_FOR_TYPE(Int, int, int, int)
+IMPLEMENT_READ_FOR_TYPE(Double, double, double, double)
+IMPLEMENT_READ_FOR_TYPE(Bool, bool, bool, bool)
+
+#undef IMPLEMENT_READ_FOR_TYPE
+
+// the DoReadXXX() for the other types have implementation in the base class
+// but can be overridden in the derived ones
+bool wxConfigBase::DoReadInt(const wxString& key, int *pi) const
+{
+    wxCHECK_MSG( pi, FALSE, _T("wxConfig::Read(): NULL parameter") );
+
+    long l;
+    if ( !DoReadLong(key, &l) )
+        return FALSE;
+
+    wxASSERT_MSG( l < INT_MAX, _T("overflow in wxConfig::DoReadInt") );
+
+    *pi = (int)l;
+
+    return TRUE;
+}
+
+bool wxConfigBase::DoReadBool(const wxString& key, bool* val) const
+{
+    wxCHECK_MSG( val, FALSE, _T("wxConfig::Read(): NULL parameter") );
+
+    long l;
+    if ( !DoReadLong(key, &l) )
+        return FALSE;
+
+    wxASSERT_MSG( l == 0 || l == 1, _T("bad bool value in wxConfig::DoReadInt") );
+
+    *val = l != 0;
+
+    return TRUE;
+}
+
+bool wxConfigBase::DoReadDouble(const wxString& key, double* val) const
+{
+    wxString str;
+    if ( Read(key, &str) )
+    {
+        return str.ToDouble(val);
+    }
+
+    return FALSE;
+}
+
+// string reading helper
+wxString wxConfigBase::ExpandEnvVars(const wxString& str) const
+{
+    wxString tmp; // Required for BC++
+    if (IsExpandingEnvVars())
+        tmp = wxExpandEnvVars(str);
+    else
+        tmp = str;
+    return tmp;
+}
+
+// ----------------------------------------------------------------------------
+// wxConfigBase writing

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

-wxConfig::~wxConfig()
+
+bool wxConfigBase::DoWriteDouble(const wxString& key, double val)

 {
 {

+    return DoWriteString(key, wxString::Format(_T("%g"), val));

 }
 
 }
 

+bool wxConfigBase::DoWriteInt(const wxString& key, int value)
+{
+    return DoWriteLong(key, (long)value);
+}
+
+bool wxConfigBase::DoWriteBool(const wxString& key, bool value)
+{
+    return DoWriteLong(key, value ? 1l : 0l);
+}
+
+// ----------------------------------------------------------------------------
+// wxConfigPathChanger
+// ----------------------------------------------------------------------------
+
+wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer,
+                                 const wxString& strEntry)
+{
+  m_pContainer = (wxConfigBase *)pContainer;
+
+  // the path is everything which precedes the last slash
+  wxString strPath = strEntry.BeforeLast(wxCONFIG_PATH_SEPARATOR);
+
+  // except in the special case of "/keyname" when there is nothing before "/"
+  if ( strPath.IsEmpty() &&
+       ((!strEntry.IsEmpty()) && strEntry[0] == wxCONFIG_PATH_SEPARATOR) )
+  {
+    strPath = wxCONFIG_PATH_SEPARATOR;
+  }
+
+  if ( !strPath.IsEmpty() ) {
+    // do change the path
+    m_bChanged = TRUE;
+    m_strName = strEntry.AfterLast(wxCONFIG_PATH_SEPARATOR);
+    m_strOldPath = m_pContainer->GetPath();
+    if ( m_strOldPath.Len() == 0 || 
+         m_strOldPath.Last() != wxCONFIG_PATH_SEPARATOR )
+        m_strOldPath += wxCONFIG_PATH_SEPARATOR;
+    m_pContainer->SetPath(strPath);
+  }
+  else {
+    // it's a name only, without path - nothing to do
+    m_bChanged = FALSE;
+    m_strName = strEntry;
+  }
+}
+
+wxConfigPathChanger::~wxConfigPathChanger()
+{
+  // only restore path if it was changed
+  if ( m_bChanged ) {
+    m_pContainer->SetPath(m_strOldPath);
+  }
+}
+
+#endif // wxUSE_CONFIG
+

 // ----------------------------------------------------------------------------
 // static & global functions
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // static & global functions
 // ----------------------------------------------------------------------------


@@ -51,33 +267,34 @@ wxConfig::~wxConfig()
 // understands both Unix and Windows (but only under Windows) environment
 // variables expansion: i.e. $var, $(var) and ${var} are always understood
 // and in addition under Windows %var% is also.
 // understands both Unix and Windows (but only under Windows) environment
 // variables expansion: i.e. $var, $(var) and ${var} are always understood
 // and in addition under Windows %var% is also.

-wxString ExpandEnvVars(const wxString& str)
+wxString wxExpandEnvVars(const wxString& str)

 {
   wxString strResult;
 {
   wxString strResult;

+  strResult.Alloc(str.Len());

 
   // don't change the values the enum elements: they must be equal
   // to the matching [closing] delimiter.
   enum Bracket
 
   // don't change the values the enum elements: they must be equal
   // to the matching [closing] delimiter.
   enum Bracket

-  { 
-    Bracket_None, 
-    Bracket_Normal  = ')', 
-    Bracket_Curly   = '}',
-#ifdef  __WINDOWS__
-    Bracket_Windows = '%'     // yeah, Windows people are a bit strange ;-)
+  {
+    Bracket_None,
+    Bracket_Normal  = ')',
+    Bracket_Curly   = '}'
+#ifdef  __WXMSW__
+    ,Bracket_Windows = '%'     // yeah, Windows people are a bit strange ;-)

 #endif
   };
 
 #endif
   };
 

-  uint m;
-  for ( uint n = 0; n < str.Len(); n++ ) {
+  size_t m;
+  for ( size_t n = 0; n < str.Len(); n++ ) {

     switch ( str[n] ) {
     switch ( str[n] ) {

-#ifdef  __WINDOWS__
-      case '%':
+#ifdef  __WXMSW__
+      case wxT('%'):

 #endif  //WINDOWS
 #endif  //WINDOWS

-      case '$':
+      case wxT('$'):

         {
           Bracket bracket;
         {
           Bracket bracket;

-          #ifdef  __WINDOWS__
-            if ( str[n] == '%' )
+          #ifdef  __WXMSW__
+            if ( str[n] == wxT('%') )

               bracket = Bracket_Windows;
             else
           #endif  //WINDOWS
               bracket = Bracket_Windows;
             else
           #endif  //WINDOWS


@@ -86,12 +303,12 @@ wxString ExpandEnvVars(const wxString& str)
           }
           else {
             switch ( str[n + 1] ) {
           }
           else {
             switch ( str[n + 1] ) {

-              case '(': 
-                bracket = Bracket_Normal; 
+              case wxT('('):
+                bracket = Bracket_Normal;

                 n++;                   // skip the bracket
                 break;
 
                 n++;                   // skip the bracket
                 break;
 

-              case '{':
+              case wxT('{'):

                 bracket = Bracket_Curly;
                 n++;                   // skip the bracket
                 break;
                 bracket = Bracket_Curly;
                 n++;                   // skip the bracket
                 break;


@@ -103,18 +320,18 @@ wxString ExpandEnvVars(const wxString& str)
 
           m = n + 1;
 
 
           m = n + 1;
 

-          while ( m < str.Len() && (isalnum(str[m]) || str[m] == '_') )
+          while ( m < str.Len() && (wxIsalnum(str[m]) || str[m] == wxT('_')) )

             m++;
 
           wxString strVarName(str.c_str() + n + 1, m - n - 1);
 
             m++;
 
           wxString strVarName(str.c_str() + n + 1, m - n - 1);
 

-          const char *pszValue = getenv(strVarName);
+          const wxChar *pszValue = wxGetenv(strVarName);

           if ( pszValue != NULL ) {
             strResult += pszValue;
           }
           else {
             // variable doesn't exist => don't change anything
           if ( pszValue != NULL ) {
             strResult += pszValue;
           }
           else {
             // variable doesn't exist => don't change anything

-            #ifdef  __WINDOWS__
+            #ifdef  __WXMSW__

               if ( bracket != Bracket_Windows )
             #endif
                 if ( bracket != Bracket_None )
               if ( bracket != Bracket_Windows )
             #endif
                 if ( bracket != Bracket_None )


@@ -125,11 +342,11 @@ wxString ExpandEnvVars(const wxString& str)
           // check the closing bracket
           if ( bracket != Bracket_None ) {
             if ( m == str.Len() || str[m] != (char)bracket ) {
           // check the closing bracket
           if ( bracket != Bracket_None ) {
             if ( m == str.Len() || str[m] != (char)bracket ) {

-              wxLogWarning("missing '%c' at position %d in '%s'.",
+              wxLogWarning(_("Environment variables expansion failed: missing '%c' at position %d in '%s'."),

                            (char)bracket, m + 1, str.c_str());
             }
             else {
                            (char)bracket, m + 1, str.c_str());
             }
             else {

-              // skip closing bracket
+              // skip closing bracket unless the variables wasn't expanded

               if ( pszValue == NULL )
                 strResult << (char)bracket;
               m++;
               if ( pszValue == NULL )
                 strResult << (char)bracket;
               m++;


@@ -141,8 +358,13 @@ wxString ExpandEnvVars(const wxString& str)
         break;
 
       case '\\':
         break;
 
       case '\\':

-        n++;
-        // fall through
+        // backslash can be used to suppress special meaning of % and $
+        if ( n != str.Len() && (str[n + 1] == wxT('%') || str[n + 1] == wxT('$')) ) {
+          strResult += str[++n];
+
+          break;
+        }
+        //else: fall through

 
       default:
         strResult += str[n];
 
       default:
         strResult += str[n];


@@ -151,3 +373,45 @@ wxString ExpandEnvVars(const wxString& str)
 
   return strResult;
 }
 
   return strResult;
 }

+
+// this function is used to properly interpret '..' in path
+/// separates group and entry names (probably shouldn't be changed)
+
+void wxSplitPath(wxArrayString& aParts, const wxChar *sz)
+{
+  aParts.Empty();
+
+  wxString strCurrent;
+  const wxChar *pc = sz;
+  for ( ;; ) {
+    if ( *pc == wxT('\0') || *pc == wxCONFIG_PATH_SEPARATOR ) {
+      if ( strCurrent == wxT(".") ) {
+        // ignore
+      }
+      else if ( strCurrent == wxT("..") ) {
+        // go up one level
+        if ( aParts.IsEmpty() )
+          wxLogWarning(_("'%s' has extra '..', ignored."), sz);
+        else
+          aParts.Remove(aParts.Count() - 1);
+
+        strCurrent.Empty();
+      }
+      else if ( !strCurrent.IsEmpty() ) {
+        aParts.Add(strCurrent);
+        strCurrent.Empty();
+      }
+      //else:
+        // could log an error here, but we prefer to ignore extra '/'
+
+      if ( *pc == wxT('\0') )
+        break;
+    }
+    else
+      strCurrent += *pc;
+
+    pc++;
+  }
+}
+
+