]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/config.cpp
fixed 3 infinite loops -- the person who tested this code must have had a lot of...
[wxWidgets.git] / src / common / config.cpp
index e3286e8aaa21e5d83bef2d432782bfe392b3c58a..014c2ab297182c16d64d514a787f9511e9ad83ed 100644 (file)
     #define wxUSE_CONFIG_NATIVE 1
 #endif
 
-#if wxUSE_CONFIG && ((wxUSE_FILE && wxUSE_TEXTFILE) || wxUSE_CONFIG_NATIVE))
+#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/log.h"
 #include "wx/textfile.h"
 #include "wx/utils.h"
-#include "wx/log.h"
 #include "wx/utils.h"
-#include "wx/intl.h"
-
-#include "wx/config.h"
 
 #include <stdlib.h>
 #include <math.h>
-#include <ctype.h>    // for isalnum()
+#include <ctype.h>
+#include <limits.h>     // for INT_MAX
 
 // ----------------------------------------------------------------------------
 // global and class static variables
@@ -59,13 +59,21 @@ bool          wxConfigBase::ms_bAutoCreate = TRUE;
 // 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)
+// 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()
 {
-    m_bExpandEnvVars = TRUE; m_bRecordDefaults = FALSE;
 }
 
 wxConfigBase *wxConfigBase::Set(wxConfigBase *pConfig)
@@ -93,118 +101,99 @@ wxConfigBase *wxConfigBase::Create()
   return ms_pConfig;
 }
 
-wxString wxConfigBase::Read(const wxString& key, const wxString& defVal) const
-{
-  wxString s;
-  Read(key, &s, defVal);
-  return s;
-}
+// ----------------------------------------------------------------------------
+// wxConfigBase reading entries
+// ----------------------------------------------------------------------------
 
-bool wxConfigBase::Read(const wxString& key, wxString *str, const wxString& defVal) const
-{
-    if (!Read(key, str))
-    {
-        *str = ExpandEnvVars(defVal);
-        return FALSE;
+// 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") );  \
+                                                                            \
+        if ( !DoRead##name(key, val) )                                      \
+            return FALSE;                                                   \
+                                                                            \
+        *val = extra(*val);                                                 \
+                                                                            \
+        return TRUE;                                                        \
+    }                                                                       \
+                                                                            \
+    bool wxConfigBase::Read(const wxString& key,                            \
+                            type *val,                                      \
+                            deftype defVal) const                           \
+    {                                                                       \
+        wxCHECK_MSG( val, FALSE, _T("wxConfig::Read(): NULL parameter") );  \
+                                                                            \
+        bool read = DoRead##name(key, val);                                 \
+        if ( !read )                                                        \
+        {                                                                   \
+            if ( IsRecordingDefaults() )                                    \
+            {                                                               \
+                ((wxConfigBase *)this)->DoWrite##name(key, defVal);         \
+            }                                                               \
+                                                                            \
+            *val = defVal;                                                  \
+        }                                                                   \
+                                                                            \
+        *val = extra(*val);                                                 \
+                                                                            \
+        return read;                                                        \
     }
-    else
-        return TRUE;
-}
 
-bool wxConfigBase::Read(const wxString& key, long *pl, long defVal) const
-{
-    if (!Read(key, pl))
-    {
-        *pl = defVal;
-        return FALSE;
-    }
-    else
-        return TRUE;
-}
 
-bool wxConfigBase::Read(const wxString& key, double* val) const
-{
-    wxString str;
-    if (Read(key, & str))
-    {
-        *val = wxAtof(str);
-        return TRUE;
-    }
-    else
-        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)
 
-bool wxConfigBase::Read(const wxString& key, double* val, double defVal) const
-{
-    if (!Read(key, val))
-    {
-        *val = defVal;
-        return FALSE;
-    }
-    else
-        return TRUE;
-}
+#undef IMPLEMENT_READ_FOR_TYPE
 
-bool wxConfigBase::Read(const wxString& key, bool* val) const
+// 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 (Read(key, & l))
-    {
-        *val = (l != 0);
-        return TRUE;
-    }
-    else
+    if ( !DoReadLong(key, &l) )
         return FALSE;
-}
 
-bool wxConfigBase::Read(const wxString& key, bool* val, bool defVal) const
-{
-    if (!Read(key, val))
-    {
-        *val = defVal;
-        return FALSE;
-    }
-    else
-        return TRUE;
-}
+    wxASSERT_MSG( l < INT_MAX, _T("overflow in wxConfig::DoReadInt") );
 
-// Convenience functions
+    *pi = (int)l;
 
-bool wxConfigBase::Read(const wxString& key, int *pi) const
-{
-    long l;
-    bool ret = Read(key, &l);
-    if (ret)
-        *pi = (int) l;
-    return ret;
+    return TRUE;
 }
 
-bool wxConfigBase::Read(const wxString& key, int *pi, int defVal) const
+bool wxConfigBase::DoReadBool(const wxString& key, bool* val) const
 {
+    wxCHECK_MSG( val, FALSE, _T("wxConfig::Read(): NULL parameter") );
+
     long l;
-    bool ret = Read(key, &l, (long) defVal);
-    *pi = (int) l;
-    return ret;
+    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::Write(const wxString& key, double val)
+bool wxConfigBase::DoReadDouble(const wxString& key, double* val) const
 {
     wxString str;
-    str.Printf(wxT("%f"), val);
-    return Write(key, str);
-}
+    if ( Read(key, &str) )
+    {
+        return str.ToDouble(val);
+    }
 
-bool wxConfigBase::Write(const wxString& key, bool value)
-{
-    long l = (value ? 1 : 0);
-    return Write(key, l);
+    return FALSE;
 }
 
-bool wxConfigBase::Write( const wxString &key, const wxChar *text )
-{
-       wxString str( text ) ;
-       return Write( key, str ) ;
-}
+// string reading helper
 wxString wxConfigBase::ExpandEnvVars(const wxString& str) const
 {
     wxString tmp; // Required for BC++
@@ -215,6 +204,25 @@ wxString wxConfigBase::ExpandEnvVars(const wxString& str) const
     return tmp;
 }
 
+// ----------------------------------------------------------------------------
+// wxConfigBase writing
+// ----------------------------------------------------------------------------
+
+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
 // ----------------------------------------------------------------------------
@@ -239,7 +247,9 @@ wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer,
     m_bChanged = TRUE;
     m_strName = strEntry.AfterLast(wxCONFIG_PATH_SEPARATOR);
     m_strOldPath = m_pContainer->GetPath();
-    m_strOldPath += wxCONFIG_PATH_SEPARATOR;
+    if ( m_strOldPath.Len() == 0 || 
+         m_strOldPath.Last() != wxCONFIG_PATH_SEPARATOR )
+        m_strOldPath += wxCONFIG_PATH_SEPARATOR;
     m_pContainer->SetPath(strPath);
   }
   else {
@@ -257,6 +267,8 @@ wxConfigPathChanger::~wxConfigPathChanger()
   }
 }
 
+#endif // wxUSE_CONFIG
+
 // ----------------------------------------------------------------------------
 // static & global functions
 // ----------------------------------------------------------------------------
@@ -275,23 +287,24 @@ wxString wxExpandEnvVars(const wxString& str)
   {
     Bracket_None,
     Bracket_Normal  = ')',
-    Bracket_Curly   = '}'
+    Bracket_Curly   = '}',
 #ifdef  __WXMSW__
-    ,Bracket_Windows = '%'     // yeah, Windows people are a bit strange ;-)
+    Bracket_Windows = '%',    // yeah, Windows people are a bit strange ;-)
 #endif
+    Bracket_Max
   };
 
   size_t m;
   for ( size_t n = 0; n < str.Len(); n++ ) {
     switch ( str[n] ) {
 #ifdef  __WXMSW__
-      case '%':
+      case wxT('%'):
 #endif  //WINDOWS
-      case '$':
+      case wxT('$'):
         {
           Bracket bracket;
           #ifdef  __WXMSW__
-            if ( str[n] == '%' )
+            if ( str[n] == wxT('%') )
               bracket = Bracket_Windows;
             else
           #endif  //WINDOWS
@@ -300,12 +313,12 @@ wxString wxExpandEnvVars(const wxString& str)
           }
           else {
             switch ( str[n + 1] ) {
-              case '(':
+              case wxT('('):
                 bracket = Bracket_Normal;
                 n++;                   // skip the bracket
                 break;
 
-              case '{':
+              case wxT('{'):
                 bracket = Bracket_Curly;
                 n++;                   // skip the bracket
                 break;
@@ -317,7 +330,7 @@ wxString wxExpandEnvVars(const wxString& str)
 
           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);
@@ -339,9 +352,16 @@ wxString wxExpandEnvVars(const wxString& str)
           // check the closing bracket
           if ( bracket != Bracket_None ) {
             if ( m == str.Len() || str[m] != (char)bracket ) {
-              wxLogWarning(_("Environment variables expansion failed: "
-                            "missing '%c' at position %d in '%s'."),
-                           (char)bracket, m + 1, str.c_str());
+              // under MSW it's common to have '%' characters in the registry
+              // and it's annoying to have warnings about them each time, so
+              // ignroe them silently if they are not used for env vars
+              //
+              // under Unix, OTOH, this warning could be useful for the user to
+              // understand why isn't the variable expanded as intended
+              #ifndef __WXMSW__
+                wxLogWarning(_("Environment variables expansion failed: missing '%c' at position %d in '%s'."),
+                             (char)bracket, m + 1, str.c_str());
+              #endif // __WXMSW__
             }
             else {
               // skip closing bracket unless the variables wasn't expanded
@@ -357,7 +377,7 @@ wxString wxExpandEnvVars(const wxString& str)
 
       case '\\':
         // backslash can be used to suppress special meaning of % and $
-        if ( n != str.Len() && (str[n + 1] == '%' || str[n + 1] == '$') ) {
+        if ( n != str.Len() && (str[n + 1] == wxT('%') || str[n + 1] == wxT('$')) ) {
           strResult += str[++n];
 
           break;
@@ -401,7 +421,7 @@ void wxSplitPath(wxArrayString& aParts, const wxChar *sz)
         // could log an error here, but we prefer to ignore extra '/'
 
       if ( *pc == wxT('\0') )
-        return;
+        break;
     }
     else
       strCurrent += *pc;
@@ -410,5 +430,4 @@ void wxSplitPath(wxArrayString& aParts, const wxChar *sz)
   }
 }
 
-#endif // wxUSE_CONFIG