Recursive wxSizer::Show for subsizer and return value if element was found.

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

diff --git a/src/common/config.cpp b/src/common/config.cpp
index be417c42432ca4d1b22db32f62627db51e1b5997..2e8372db9366eb0ae3cbfdee29a6ae899d9e60ff 100644 (file)
--- a/src/common/config.cpp
+++ b/src/common/config.cpp
@@ -7,13 +7,13 @@
 // 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__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma implementation "confbase.h"
 #endif
 
     #pragma implementation "confbase.h"
 #endif
 


@@ -27,29 +27,30 @@
     #define wxUSE_CONFIG_NATIVE 1
 #endif
 
     #define wxUSE_CONFIG_NATIVE 1
 #endif
 

+#include "wx/config.h"
+#include "wx/intl.h"
+#include "wx/log.h"
+#include "wx/arrstr.h"
+

 #if wxUSE_CONFIG && ((wxUSE_FILE && wxUSE_TEXTFILE) || wxUSE_CONFIG_NATIVE)
 
 #include "wx/app.h"
 #include "wx/file.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/textfile.h"
 #include "wx/utils.h"

-#include "wx/log.h"

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

-#include "wx/intl.h"
-
-#include "wx/config.h"

 
 #include <stdlib.h>
 #include <math.h>
 #include <ctype.h>
 
 #include <stdlib.h>
 #include <math.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


@@ -68,7 +69,8 @@ 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()


@@ -87,11 +89,7 @@ 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

     #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


@@ -100,118 +98,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))
-    {
-        *val = wxAtof(str);
-        return TRUE;
-    }
+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);
-    *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;
 {
     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++
 wxString wxConfigBase::ExpandEnvVars(const wxString& str) const
 {
     wxString tmp; // Required for BC++


@@ -222,6 +201,25 @@ 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
 // ----------------------------------------------------------------------------


@@ -243,17 +241,17 @@ wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer,
 
   if ( !strPath.IsEmpty() ) {
     // do change the path
 
   if ( !strPath.IsEmpty() ) {
     // do change the path

-    m_bChanged = TRUE;
+    m_bChanged = true;

     m_strName = strEntry.AfterLast(wxCONFIG_PATH_SEPARATOR);
     m_strOldPath = m_pContainer->GetPath();
     m_strName = strEntry.AfterLast(wxCONFIG_PATH_SEPARATOR);
     m_strOldPath = m_pContainer->GetPath();

-    if ( m_strOldPath.Len() == 0 || 
+    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_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_bChanged = false;

     m_strName = strEntry;
   }
 }
     m_strName = strEntry;
   }
 }


@@ -266,6 +264,8 @@ wxConfigPathChanger::~wxConfigPathChanger()
   }
 }
 
   }
 }
 

+#endif // wxUSE_CONFIG
+

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


@@ -284,10 +284,11 @@ wxString wxExpandEnvVars(const wxString& str)
   {
     Bracket_None,
     Bracket_Normal  = ')',
   {
     Bracket_None,
     Bracket_Normal  = ')',

-    Bracket_Curly   = '}'
+    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

   };
 
   size_t m;
   };
 
   size_t m;


@@ -331,7 +332,11 @@ wxString wxExpandEnvVars(const wxString& str)
 
           wxString strVarName(str.c_str() + n + 1, m - n - 1);
 
 
           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,8 +353,16 @@ wxString wxExpandEnvVars(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(_("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
             }
             else {
               // skip closing bracket unless the variables wasn't expanded


@@ -383,7 +396,7 @@ wxString wxExpandEnvVars(const wxString& str)
 // this function is used to properly interpret '..' in path
 void wxSplitPath(wxArrayString& aParts, const wxChar *sz)
 {
 // this function is used to properly interpret '..' in path
 void wxSplitPath(wxArrayString& aParts, const wxChar *sz)
 {

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

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


@@ -394,15 +407,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();
       }
       else if ( !strCurrent.IsEmpty() ) {
 
         strCurrent.Empty();
       }
       else if ( !strCurrent.IsEmpty() ) {

-        aParts.Add(strCurrent);
+        aParts.push_back(strCurrent);

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


@@ -418,5 +431,4 @@ void wxSplitPath(wxArrayString& aParts, const wxChar *sz)
   }
 }
 
   }
 }
 

-#endif // wxUSE_CONFIG