Warning fix.

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

diff --git a/src/common/config.cpp b/src/common/config.cpp
index 05ca5af209b99fccdf4516182e5c91e6a0894ca3..4b509a7fc0d8a41eaf22e3538e171d801b7ad8fc 100644 (file)
--- a/src/common/config.cpp
+++ b/src/common/config.cpp
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     implementation of wxConfigBase class
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:     implementation of wxConfigBase class
 // Author:      Vadim Zeitlin
 // Modified by:


@@ -7,20 +7,17 @@
 // RCS-ID:      $Id$
 // Copyright:   (c) 1997 Karsten Ballüder   Ballueder@usa.net
 //                       Vadim Zeitlin      <zeitlin@dptmaths.ens-cachan.fr>
 // RCS-ID:      $Id$
 // Copyright:   (c) 1997 Karsten Ballüder   Ballueder@usa.net
 //                       Vadim Zeitlin      <zeitlin@dptmaths.ens-cachan.fr>

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 ///////////////////////////////////////////////////////////////////////////////
 
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------

-#ifdef __GNUG__
-    #pragma implementation "confbase.h"
-#endif

 
 #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


@@ -28,27 +25,30 @@
 #endif
 
 #include "wx/config.h"
 #endif
 
 #include "wx/config.h"

-#include "wx/intl.h"
-#include "wx/log.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/file.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;
 
 // ----------------------------------------------------------------------------
 // global and class static variables
 // ----------------------------------------------------------------------------
 
 wxConfigBase *wxConfigBase::ms_pConfig     = NULL;

-bool          wxConfigBase::ms_bAutoCreate = TRUE;
+bool          wxConfigBase::ms_bAutoCreate = true;

 
 // ============================================================================
 // implementation
 
 // ============================================================================
 // implementation


@@ -67,11 +67,13 @@ wxConfigBase::wxConfigBase(const wxString& appName,
                            long style)
             : m_appName(appName), m_vendorName(vendorName), m_style(style)
 {
                            long style)
             : m_appName(appName), m_vendorName(vendorName), m_style(style)
 {

-    m_bExpandEnvVars = TRUE; m_bRecordDefaults = FALSE;
+    m_bExpandEnvVars = true;
+    m_bRecordDefaults = false;

 }
 
 wxConfigBase::~wxConfigBase()
 {
 }
 
 wxConfigBase::~wxConfigBase()
 {

+    // required here for Darwin

 }
 
 wxConfigBase *wxConfigBase::Set(wxConfigBase *pConfig)
 }
 
 wxConfigBase *wxConfigBase::Set(wxConfigBase *pConfig)


@@ -86,11 +88,9 @@ wxConfigBase *wxConfigBase::Create()
   if ( ms_bAutoCreate && ms_pConfig == NULL ) {
     ms_pConfig =
     #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
   if ( ms_bAutoCreate && ms_pConfig == NULL ) {
     ms_pConfig =
     #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE

-      #ifdef __WIN32__

         new wxRegConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
         new wxRegConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());

-      #else  //WIN16
-        new wxIniConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
-      #endif
+    #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
     #else // either we're under Unix or wish to use files even under Windows
       new wxFileConfig(wxTheApp->GetAppName());
     #endif


@@ -99,118 +99,99 @@ wxConfigBase *wxConfigBase::Create()
   return ms_pConfig;
 }
 
   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) )
-    {
-        return str.ToDouble(val);
-    }
+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)

 
 

-    return FALSE;
-}
+#undef IMPLEMENT_READ_FOR_TYPE

 
 

-bool wxConfigBase::Read(const wxString& key, double* val, double defVal) 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

 {
 {

-    if (!Read(key, val))
-    {
-        *val = defVal;
-        return FALSE;
-    }
-    else
-        return TRUE;
-}
+    wxCHECK_MSG( pi, false, _T("wxConfig::Read(): NULL parameter") );

 
 

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

     long l;
     long l;

-    if (Read(key, & l))
-    {
-        *val = (l != 0);
-        return TRUE;
-    }
-    else
-        return FALSE;
-}
+    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;
     long l;

-    bool ret = Read(key, &l, (long) defVal);
-    if (ret)
-        *pi = (int) l;
-    return ret;
-}
+    if ( !DoReadLong(key, &l) )
+        return false;

 
 

-bool wxConfigBase::Write(const wxString& key, double val)
-{
-    wxString str;
-    str.Printf(wxT("%g"), val);
-    return Write(key, str);
-}
+    wxASSERT_MSG( l == 0 || l == 1, _T("bad bool value in wxConfig::DoReadInt") );

 
 

-bool wxConfigBase::Write(const wxString& key, bool value)
-{
-    return Write(key, value ? 1l : 0l);
+    *val = l != 0;
+
+    return true;

 }
 
 }
 

-bool wxConfigBase::Write(const wxString& key, const wxChar *value)
+bool wxConfigBase::DoReadDouble(const wxString& key, double* val) const

 {
 {

-    // explicit cast needed, otherwise value would have been converted to bool
-    return Write(key, wxString(value));
+    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++
 wxString wxConfigBase::ExpandEnvVars(const wxString& str) const
 {
     wxString tmp; // Required for BC++


@@ -221,42 +202,93 @@ wxString wxConfigBase::ExpandEnvVars(const wxString& str) const
     return tmp;
 }
 
     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
 // ----------------------------------------------------------------------------
 
 wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer,
 // ----------------------------------------------------------------------------
 // wxConfigPathChanger
 // ----------------------------------------------------------------------------
 
 wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer,

-                                 const wxString& strEntry)
+                                         const wxString& strEntry)

 {
 {

+  m_bChanged = false;

   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 "/"
   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) )
+  if ( strPath.empty() &&
+       ((!strEntry.empty()) && strEntry[0] == wxCONFIG_PATH_SEPARATOR) )

   {
     strPath = wxCONFIG_PATH_SEPARATOR;
   }
 
   {
     strPath = wxCONFIG_PATH_SEPARATOR;
   }
 

-  if ( !strPath.IsEmpty() ) {
-    // do change the path
-    m_bChanged = TRUE;
+  if ( !strPath.empty() )
+  {
+    if ( m_pContainer->GetPath() != strPath )
+    {
+        // we do change the path so restore it later
+        m_bChanged = true;
+
+        /* 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
+           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);
+        */
+        m_strOldPath = (const wxChar*) m_pContainer->GetPath();
+        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);
     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
   }
   else {
     // it's a name only, without path - nothing to do

-    m_bChanged = FALSE;

     m_strName = strEntry;
   }
 }
 
     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


@@ -274,25 +306,27 @@ wxConfigPathChanger::~wxConfigPathChanger()
 // 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 wxExpandEnvVars(const wxString& str)
-{
-  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
-  {
-    Bracket_None,
-    Bracket_Normal  = ')',
-    Bracket_Curly   = '}'
+// 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  __WXMSW__
 #ifdef  __WXMSW__

-    ,Bracket_Windows = '%'     // yeah, Windows people are a bit strange ;-)
+  Bracket_Windows = '%',    // yeah, Windows people are a bit strange ;-)

 #endif
 #endif

-  };
+  Bracket_Max
+};
+
+wxString wxExpandEnvVars(const wxString& str)
+{
+  wxString strResult;
+  strResult.Alloc(str.length());

 
   size_t m;
 
   size_t m;

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

     switch ( str[n] ) {
 #ifdef  __WXMSW__
       case wxT('%'):
     switch ( str[n] ) {
 #ifdef  __WXMSW__
       case wxT('%'):


@@ -305,7 +339,7 @@ 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 {


@@ -327,12 +361,16 @@ 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);
 
             m++;
 
           wxString strVarName(str.c_str() + n + 1, m - n - 1);
 

+#ifdef __WXWINCE__
+          const wxChar *pszValue = NULL;
+#else

           const wxChar *pszValue = wxGetenv(strVarName);
           const wxChar *pszValue = wxGetenv(strVarName);

+#endif

           if ( pszValue != NULL ) {
             strResult += pszValue;
           }
           if ( pszValue != NULL ) {
             strResult += pszValue;
           }


@@ -348,9 +386,17 @@ 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] != (char)bracket ) {
-              wxLogWarning(_("Environment variables expansion failed: missing '%c' at position %d in '%s'."),
-                           (char)bracket, m + 1, str.c_str());
+            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 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 %u in '%s'."),
+                             (char)bracket, (unsigned int) (m + 1), str.c_str());
+              #endif // __WXMSW__

             }
             else {
               // skip closing bracket unless the variables wasn't expanded
             }
             else {
               // skip closing bracket unless the variables wasn't expanded


@@ -366,7 +412,8 @@ wxString wxExpandEnvVars(const wxString& str)
 
       case '\\':
         // backslash can be used to suppress special meaning of % and $
 
       case '\\':
         // backslash can be used to suppress special meaning of % and $

-        if ( n != str.Len() && (str[n + 1] == wxT('%') || str[n + 1] == wxT('$')) ) {
+        if ( n != str.length() - 1 &&
+                (str[n + 1] == wxT('%') || str[n + 1] == wxT('$')) ) {

           strResult += str[++n];
 
           break;
           strResult += str[++n];
 
           break;


@@ -382,11 +429,9 @@ wxString wxExpandEnvVars(const wxString& str)
 }
 
 // this function is used to properly interpret '..' in path
 }
 
 // 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)
 {
 void wxSplitPath(wxArrayString& aParts, const wxChar *sz)
 {

-  aParts.Empty();
+  aParts.clear();

 
   wxString strCurrent;
   const wxChar *pc = sz;
 
   wxString strCurrent;
   const wxChar *pc = sz;


@@ -397,15 +442,15 @@ void wxSplitPath(wxArrayString& aParts, const wxChar *sz)
       }
       else if ( strCurrent == wxT("..") ) {
         // go up one level
       }
       else if ( strCurrent == wxT("..") ) {
         // go up one level

-        if ( aParts.IsEmpty() )
+        if ( aParts.size() == 0 )

           wxLogWarning(_("'%s' has extra '..', ignored."), sz);
         else
           wxLogWarning(_("'%s' has extra '..', ignored."), sz);
         else

-          aParts.Remove(aParts.Count() - 1);
+          aParts.erase(aParts.end() - 1);

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

-      else if ( !strCurrent.IsEmpty() ) {
-        aParts.Add(strCurrent);
+      else if ( !strCurrent.empty() ) {
+        aParts.push_back(strCurrent);

         strCurrent.Empty();
       }
       //else:
         strCurrent.Empty();
       }
       //else:


@@ -420,5 +465,3 @@ void wxSplitPath(wxArrayString& aParts, const wxChar *sz)
     pc++;
   }
 }
     pc++;
   }
 }

-
-