fix memory leak in wxScreenDC, fixes #13249

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

diff --git a/src/common/config.cpp b/src/common/config.cpp
index 62013b23e4cf72010a1ec3bd7bfb744be7d8ffe1..12c8213002a893d41cd3d70c232dec5a4cc113dc 100644 (file)
--- a/src/common/config.cpp
+++ b/src/common/config.cpp
@@ -1,11 +1,11 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        config.cpp
+// Name:        src/common/config.cpp

 // Purpose:     implementation of wxConfigBase class
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     07.04.98
 // RCS-ID:      $Id$
 // Purpose:     implementation of wxConfigBase class
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     07.04.98
 // RCS-ID:      $Id$

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

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


@@ -16,8 +16,8 @@
 
 #include "wx/wxprec.h"
 
 
 #include "wx/wxprec.h"
 

-#ifdef    __BORLANDC__
-  #pragma hdrstop
+#ifdef __BORLANDC__
+    #pragma hdrstop

 #endif  //__BORLANDC__
 
 #ifndef wxUSE_CONFIG_NATIVE
 #endif  //__BORLANDC__
 
 #ifndef wxUSE_CONFIG_NATIVE


@@ -25,20 +25,25 @@
 #endif
 
 #include "wx/config.h"
 #endif
 
 #include "wx/config.h"

-#include "wx/intl.h"
-#include "wx/log.h"
-#include "wx/arrstr.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/intl.h"
+    #include "wx/log.h"
+    #include "wx/app.h"
+    #include "wx/utils.h"
+    #include "wx/arrstr.h"
+    #include "wx/math.h"
+#endif //WX_PRECOMP

 
 #if wxUSE_CONFIG && ((wxUSE_FILE && wxUSE_TEXTFILE) || wxUSE_CONFIG_NATIVE)
 
 
 #if wxUSE_CONFIG && ((wxUSE_FILE && wxUSE_TEXTFILE) || wxUSE_CONFIG_NATIVE)
 

-#include "wx/app.h"
+#include "wx/apptrait.h"

 #include "wx/file.h"
 #include "wx/file.h"

-#include "wx/utils.h"
-#include "wx/math.h"

 
 #include <stdlib.h>
 #include <ctype.h>
 #include <limits.h>     // for INT_MAX
 
 #include <stdlib.h>
 #include <ctype.h>
 #include <limits.h>     // for INT_MAX

+#include <float.h>      // for FLT_MAX

 
 // ----------------------------------------------------------------------------
 // global and class static variables
 
 // ----------------------------------------------------------------------------
 // global and class static variables


@@ -51,9 +56,26 @@ bool          wxConfigBase::ms_bAutoCreate = true;
 // implementation
 // ============================================================================
 
 // implementation
 // ============================================================================
 

+// ----------------------------------------------------------------------------
+// wxAppTraitsBase
+// ----------------------------------------------------------------------------
+
+wxConfigBase *wxAppTraitsBase::CreateConfig()
+{
+    return new
+    #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
+        wxRegConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
+    #elif defined(__WXPALMOS__) && wxUSE_CONFIG_NATIVE
+        wxPrefConfig(wxTheApp->GetAppName());
+    #else // either we're under Unix or wish to use files even under Windows
+        wxFileConfig(wxTheApp->GetAppName());
+    #endif
+}
+

 // ----------------------------------------------------------------------------
 // wxConfigBase
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxConfigBase
 // ----------------------------------------------------------------------------

+IMPLEMENT_ABSTRACT_CLASS(wxConfigBase, wxObject)

 
 // Not all args will always be used by derived classes, but including them all
 // in each class ensures compatibility.
 
 // Not all args will always be used by derived classes, but including them all
 // in each class ensures compatibility.


@@ -83,14 +105,10 @@ wxConfigBase *wxConfigBase::Set(wxConfigBase *pConfig)
 wxConfigBase *wxConfigBase::Create()
 {
   if ( ms_bAutoCreate && ms_pConfig == NULL ) {
 wxConfigBase *wxConfigBase::Create()
 {
   if ( ms_bAutoCreate && ms_pConfig == NULL ) {

-    ms_pConfig =
-    #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
-        new wxRegConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
-    #elif defined(__WXPALMOS__) && wxUSE_CONFIG_NATIVE
-        new wxPrefConfig(wxTheApp->GetAppName());
-    #else // either we're under Unix or wish to use files even under Windows
-      new wxFileConfig(wxTheApp->GetAppName());
-    #endif
+    wxAppTraits * const traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+    wxCHECK_MSG( traits, NULL, wxT("create wxApp before calling this") );
+
+    ms_pConfig = traits->CreateConfig();

   }
 
   return ms_pConfig;
   }
 
   return ms_pConfig;


@@ -104,7 +122,7 @@ wxConfigBase *wxConfigBase::Create()
 #define IMPLEMENT_READ_FOR_TYPE(name, type, deftype, extra)                 \
     bool wxConfigBase::Read(const wxString& key, type *val) const           \
     {                                                                       \
 #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") );  \
+        wxCHECK_MSG( val, false, wxT("wxConfig::Read(): NULL parameter") );  \

                                                                             \
         if ( !DoRead##name(key, val) )                                      \
             return false;                                                   \
                                                                             \
         if ( !DoRead##name(key, val) )                                      \
             return false;                                                   \


@@ -118,7 +136,7 @@ wxConfigBase *wxConfigBase::Create()
                             type *val,                                      \
                             deftype defVal) const                           \
     {                                                                       \
                             type *val,                                      \
                             deftype defVal) const                           \
     {                                                                       \

-        wxCHECK_MSG( val, false, _T("wxConfig::Read(): NULL parameter") );  \
+        wxCHECK_MSG( val, false, wxT("wxConfig::Read(): NULL parameter") );  \

                                                                             \
         bool read = DoRead##name(key, val);                                 \
         if ( !read )                                                        \
                                                                             \
         bool read = DoRead##name(key, val);                                 \
         if ( !read )                                                        \


@@ -139,38 +157,79 @@ wxConfigBase *wxConfigBase::Create()
 
 IMPLEMENT_READ_FOR_TYPE(String, wxString, const wxString&, ExpandEnvVars)
 IMPLEMENT_READ_FOR_TYPE(Long, long, long, long)
 
 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
 
 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
+// int is stored as long
+bool wxConfigBase::Read(const wxString& key, int *pi) const

 {
 {

-    wxCHECK_MSG( pi, false, _T("wxConfig::Read(): NULL parameter") );
+    long l = *pi;
+    bool r = Read(key, &l);
+    wxASSERT_MSG( l < INT_MAX, wxT("int overflow in wxConfig::Read") );
+    *pi = (int)l;
+    return r;
+}

 
 

-    long l;
-    if ( !DoReadLong(key, &l) )
+bool wxConfigBase::Read(const wxString& key, int *pi, int defVal) const
+{
+    long l = *pi;
+    bool r = Read(key, &l, defVal);
+    wxASSERT_MSG( l < INT_MAX, wxT("int overflow in wxConfig::Read") );
+    *pi = (int)l;
+    return r;
+}
+
+// Read floats as doubles then just type cast it down.
+bool wxConfigBase::Read(const wxString& key, float* val) const
+{
+    wxCHECK_MSG( val, false, wxT("wxConfig::Read(): NULL parameter") );
+
+    double temp;
+    if ( !Read(key, &temp) )

         return false;
 
         return false;
 

-    wxASSERT_MSG( l < INT_MAX, _T("overflow in wxConfig::DoReadInt") );
+    wxCHECK_MSG( fabs(temp) <= FLT_MAX, false,
+                     wxT("float overflow in wxConfig::Read") );
+    wxCHECK_MSG( (temp == 0.0) || (fabs(temp) >= FLT_MIN), false,
+                     wxT("float underflow in wxConfig::Read") );

 
 

-    *pi = (int)l;
+    *val = static_cast<float>(temp);

 
     return true;
 }
 
 
     return true;
 }
 

+bool wxConfigBase::Read(const wxString& key, float* val, float defVal) const
+{
+    wxCHECK_MSG( val, false, wxT("wxConfig::Read(): NULL parameter") );
+
+    if ( Read(key, val) )
+        return true;
+
+    *val = defVal;
+    return false;
+}
+
+// the DoReadXXX() for the other types have implementation in the base class
+// but can be overridden in the derived ones

 bool wxConfigBase::DoReadBool(const wxString& key, bool* val) const
 {
 bool wxConfigBase::DoReadBool(const wxString& key, bool* val) const
 {

-    wxCHECK_MSG( val, false, _T("wxConfig::Read(): NULL parameter") );
+    wxCHECK_MSG( val, false, wxT("wxConfig::Read(): NULL parameter") );

 
     long l;
     if ( !DoReadLong(key, &l) )
         return false;
 
 
     long l;
     if ( !DoReadLong(key, &l) )
         return false;
 

-    wxASSERT_MSG( l == 0 || l == 1, _T("bad bool value in wxConfig::DoReadInt") );
+    if ( l != 0 && l != 1 )
+    {
+        // Don't assert here as this could happen in the result of user editing
+        // the file directly and this not indicate a bug in the program but
+        // still complain that something is wrong.
+        wxLogWarning(_("Invalid value %ld for a boolean key \"%s\" in "
+                       "config file."),
+                     l, key);
+    }

 
     *val = l != 0;
 
 
     *val = l != 0;
 


@@ -182,7 +241,14 @@ bool wxConfigBase::DoReadDouble(const wxString& key, double* val) const
     wxString str;
     if ( Read(key, &str) )
     {
     wxString str;
     if ( Read(key, &str) )
     {

-        return str.ToDouble(val);
+        if ( str.ToCDouble(val) )
+            return true;
+
+        // Previous versions of wxFileConfig wrote the numbers out using the
+        // current locale and not the C one as now, so attempt to parse the
+        // string as a number in the current locale too, for compatibility.
+        if ( str.ToDouble(val) )
+            return true;

     }
 
     return false;
     }
 
     return false;


@@ -205,12 +271,10 @@ wxString wxConfigBase::ExpandEnvVars(const wxString& str) const
 
 bool wxConfigBase::DoWriteDouble(const wxString& key, double val)
 {
 
 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);
+    // Notice that we always write out the numbers in C locale and not the
+    // current one. This makes the config files portable between machines using
+    // different locales.
+    return DoWriteString(key, wxString::FromCDouble(val));

 }
 
 bool wxConfigBase::DoWriteBool(const wxString& key, bool value)
 }
 
 bool wxConfigBase::DoWriteBool(const wxString& key, bool value)


@@ -226,10 +290,11 @@ wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer,
                                          const wxString& strEntry)
 {
   m_bChanged = false;
                                          const wxString& strEntry)
 {
   m_bChanged = false;

-  m_pContainer = (wxConfigBase *)pContainer;
+  m_pContainer = const_cast<wxConfigBase *>(pContainer);

 
 

-  // the path is everything which precedes the last slash
-  wxString strPath = strEntry.BeforeLast(wxCONFIG_PATH_SEPARATOR);
+  // the path is everything which precedes the last slash and the name is
+  // everything after it -- and this works correctly if there is no slash too
+  wxString strPath = strEntry.BeforeLast(wxCONFIG_PATH_SEPARATOR, &m_strName);

 
   // except in the special case of "/keyname" when there is nothing before "/"
   if ( strPath.empty() &&
 
   // except in the special case of "/keyname" when there is nothing before "/"
   if ( strPath.empty() &&


@@ -247,30 +312,38 @@ wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer,
 
         /* JACS: work around a memory bug that causes an assert
            when using wxRegConfig, related to reference-counting.
 
         /* JACS: work around a memory bug that causes an assert
            when using wxRegConfig, related to reference-counting.

-           Can be reproduced by removing (const wxChar*) below and
+           Can be reproduced by removing .wc_str() below and

            adding the following code to the config sample OnInit under
            Windows:
 
            pConfig->SetPath(wxT("MySettings"));
            pConfig->SetPath(wxT(".."));
            int value;
            adding the following code to the config sample OnInit under
            Windows:
 
            pConfig->SetPath(wxT("MySettings"));
            pConfig->SetPath(wxT(".."));
            int value;

-           pConfig->Read(_T("MainWindowX"), & value);
+           pConfig->Read(wxT("MainWindowX"), & value);

         */
         */

-        m_strOldPath = (const wxChar*) m_pContainer->GetPath();
+        m_strOldPath = m_pContainer->GetPath().wc_str();

         if ( *m_strOldPath.c_str() != wxCONFIG_PATH_SEPARATOR )
           m_strOldPath += wxCONFIG_PATH_SEPARATOR;
         m_pContainer->SetPath(strPath);
     }
         if ( *m_strOldPath.c_str() != wxCONFIG_PATH_SEPARATOR )
           m_strOldPath += wxCONFIG_PATH_SEPARATOR;
         m_pContainer->SetPath(strPath);
     }

-
-    // in any case, use the just the name, not full path
-    m_strName = strEntry.AfterLast(wxCONFIG_PATH_SEPARATOR);
-  }
-  else {
-    // it's a name only, without path - nothing to do
-    m_strName = strEntry;

   }
 }
 
   }
 }
 

+void wxConfigPathChanger::UpdateIfDeleted()
+{
+    // we don't have to do anything at all if we didn't change the path
+    if ( !m_bChanged )
+        return;
+
+    // find the deepest still existing parent path of the original path
+    while ( !m_pContainer->HasGroup(m_strOldPath) )
+    {
+        m_strOldPath = m_strOldPath.BeforeLast(wxCONFIG_PATH_SEPARATOR);
+        if ( m_strOldPath.empty() )
+            m_strOldPath = wxCONFIG_PATH_SEPARATOR;
+    }
+}
+

 wxConfigPathChanger::~wxConfigPathChanger()
 {
   // only restore path if it was changed
 wxConfigPathChanger::~wxConfigPathChanger()
 {
   // only restore path if it was changed


@@ -279,6 +352,24 @@ wxConfigPathChanger::~wxConfigPathChanger()
   }
 }
 
   }
 }
 

+// this is a wxConfig method but it's mainly used with wxConfigPathChanger
+/* static */
+wxString wxConfigBase::RemoveTrailingSeparator(const wxString& key)
+{
+    wxString path(key);
+
+    // don't remove the only separator from a root group path!
+    while ( path.length() > 1 )
+    {
+        if ( *path.rbegin() != wxCONFIG_PATH_SEPARATOR )
+            break;
+
+        path.erase(path.end() - 1);
+    }
+
+    return path;
+}
+

 #endif // wxUSE_CONFIG
 
 // ----------------------------------------------------------------------------
 #endif // wxUSE_CONFIG
 
 // ----------------------------------------------------------------------------


@@ -305,11 +396,11 @@ enum Bracket
 wxString wxExpandEnvVars(const wxString& str)
 {
   wxString strResult;
 wxString wxExpandEnvVars(const wxString& str)
 {
   wxString strResult;

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

 
   size_t m;
 
   size_t m;

-  for ( size_t n = 0; n < str.Len(); n++ ) {
-    switch ( str[n] ) {
+  for ( size_t n = 0; n < str.length(); n++ ) {
+    switch ( str[n].GetValue() ) {

 #ifdef  __WXMSW__
       case wxT('%'):
 #endif  //WINDOWS
 #ifdef  __WXMSW__
       case wxT('%'):
 #endif  //WINDOWS


@@ -321,11 +412,11 @@ wxString wxExpandEnvVars(const wxString& str)
               bracket = Bracket_Windows;
             else
           #endif  //WINDOWS
               bracket = Bracket_Windows;
             else
           #endif  //WINDOWS

-          if ( n == str.Len() - 1 ) {
+          if ( n == str.length() - 1 ) {

             bracket = Bracket_None;
           }
           else {
             bracket = Bracket_None;
           }
           else {

-            switch ( str[n + 1] ) {
+            switch ( str[n + 1].GetValue() ) {

               case wxT('('):
                 bracket = Bracket_Normal;
                 n++;                   // skip the bracket
               case wxT('('):
                 bracket = Bracket_Normal;
                 n++;                   // skip the bracket


@@ -343,20 +434,26 @@ wxString wxExpandEnvVars(const wxString& str)
 
           m = n + 1;
 
 
           m = n + 1;
 

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

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

-          const wxChar *pszValue = NULL;
+          const bool expanded = false;

 #else
 #else

-          const wxChar *pszValue = wxGetenv(strVarName);
-#endif
-          if ( pszValue != NULL ) {
-            strResult += pszValue;
+          // NB: use wxGetEnv instead of wxGetenv as otherwise variables
+          //     set through wxSetEnv may not be read correctly!
+          bool expanded = false;
+          wxString tmp;
+          if (wxGetEnv(strVarName, &tmp))
+          {
+              strResult += tmp;
+              expanded = true;

           }
           }

-          else {
+          else
+#endif
+          {

             // variable doesn't exist => don't change anything
             #ifdef  __WXMSW__
               if ( bracket != Bracket_Windows )
             // variable doesn't exist => don't change anything
             #ifdef  __WXMSW__
               if ( bracket != Bracket_Windows )


@@ -368,7 +465,7 @@ wxString wxExpandEnvVars(const wxString& str)
 
           // check the closing bracket
           if ( bracket != Bracket_None ) {
 
           // check the closing bracket
           if ( bracket != Bracket_None ) {

-            if ( m == str.Len() || str[m] != (wxChar)bracket ) {
+            if ( m == str.length() || str[m] != (wxChar)bracket ) {

               // 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 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


@@ -382,8 +479,8 @@ wxString wxExpandEnvVars(const wxString& str)
             }
             else {
               // skip closing bracket unless the variables wasn't expanded
             }
             else {
               // skip closing bracket unless the variables wasn't expanded

-              if ( pszValue == NULL )
-                strResult << (char)bracket;
+              if ( !expanded )
+                strResult << (wxChar)bracket;

               m++;
             }
           }
               m++;
             }
           }


@@ -392,9 +489,9 @@ wxString wxExpandEnvVars(const wxString& str)
         }
         break;
 
         }
         break;
 

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

         // backslash can be used to suppress special meaning of % and $
         // backslash can be used to suppress special meaning of % and $

-        if ( n != str.Len() - 1 &&
+        if ( n != str.length() - 1 &&

                 (str[n + 1] == wxT('%') || str[n + 1] == wxT('$')) ) {
           strResult += str[++n];
 
                 (str[n + 1] == wxT('%') || str[n + 1] == wxT('$')) ) {
           strResult += str[++n];
 


@@ -411,23 +508,27 @@ wxString wxExpandEnvVars(const wxString& str)
 }
 
 // this function is used to properly interpret '..' in path
 }
 
 // this function is used to properly interpret '..' in path

-void wxSplitPath(wxArrayString& aParts, const wxChar *sz)
+void wxSplitPath(wxArrayString& aParts, const wxString& path)

 {
   aParts.clear();
 
   wxString strCurrent;
 {
   aParts.clear();
 
   wxString strCurrent;

-  const wxChar *pc = sz;
+  wxString::const_iterator pc = path.begin();

   for ( ;; ) {
   for ( ;; ) {

-    if ( *pc == wxT('\0') || *pc == wxCONFIG_PATH_SEPARATOR ) {
+    if ( pc == path.end() || *pc == wxCONFIG_PATH_SEPARATOR ) {

       if ( strCurrent == wxT(".") ) {
         // ignore
       }
       else if ( strCurrent == wxT("..") ) {
         // go up one level
         if ( aParts.size() == 0 )
       if ( strCurrent == wxT(".") ) {
         // ignore
       }
       else if ( strCurrent == wxT("..") ) {
         // go up one level
         if ( aParts.size() == 0 )

-          wxLogWarning(_("'%s' has extra '..', ignored."), sz);
+        {
+          wxLogWarning(_("'%s' has extra '..', ignored."), path);
+        }

         else
         else

+        {

           aParts.erase(aParts.end() - 1);
           aParts.erase(aParts.end() - 1);

+        }

 
         strCurrent.Empty();
       }
 
         strCurrent.Empty();
       }


@@ -438,14 +539,12 @@ void wxSplitPath(wxArrayString& aParts, const wxChar *sz)
       //else:
         // could log an error here, but we prefer to ignore extra '/'
 
       //else:
         // could log an error here, but we prefer to ignore extra '/'
 

-      if ( *pc == wxT('\0') )
+      if ( pc == path.end() )

         break;
     }
     else
       strCurrent += *pc;
 
         break;
     }
     else
       strCurrent += *pc;
 

-    pc++;
+    ++pc;

   }
 }
   }
 }

-
-