removing dependancy on mac headers from public wx headers (eventually adding wx/mac...

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

diff --git a/src/common/config.cpp b/src/common/config.cpp
index 6a4eff0b33a32f6917fec10d582371ab72431e65..286e2123aa6844bc58ee27d52af6feb2b74ed210 100644 (file)
--- a/src/common/config.cpp
+++ b/src/common/config.cpp
@@ -10,49 +10,39 @@
 // Licence:     wxWindows license
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 ///////////////////////////////////////////////////////////////////////////////
 

-// ============================================================================
-// declarations
-// ============================================================================
-

 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 #ifdef __GNUG__
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 #ifdef __GNUG__

-  #pragma implementation "confbase.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__
 

-#ifndef WX_PRECOMP
-  #include  <wx/string.h>
-  #include  <wx/intl.h>
-#endif //WX_PRECOMP
-
-#include  <wx/app.h>
-#include  <wx/file.h>
-#include  <wx/log.h>
-#include  <wx/textfile.h>
-#include  <wx/confbase.h>
-#include  <wx/utils.h>
-
-// we must include (one of) these files for wxConfigBase::Create
-#if defined(__WXMSW__) && defined(wxCONFIG_WIN32_NATIVE)
-  #ifdef __WIN32__
-    #include  <wx/msw/regconf.h>
-  #else  //WIN16
-    #include  <wx/msw/iniconf.h>
-  #endif
-#else // either we're under Unix or wish to use files even under Windows
-  #include  <wx/fileconf.h>
+#ifndef wxUSE_CONFIG_NATIVE
+    #define wxUSE_CONFIG_NATIVE 1

 #endif
 
 #endif
 

-#include  <stdlib.h>
-#include  <math.h>
-#include  <ctype.h>       // for isalnum()
+#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 <math.h>
+#include <ctype.h>
+#include <limits.h>     // for INT_MAX

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


@@ -69,15 +59,22 @@ bool          wxConfigBase::ms_bAutoCreate = TRUE;
 // wxConfigBase
 // ----------------------------------------------------------------------------
 
 // 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;
 }
 
 {
     m_bExpandEnvVars = TRUE; m_bRecordDefaults = FALSE;
 }
 

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

 wxConfigBase *wxConfigBase::Set(wxConfigBase *pConfig)
 {
   wxConfigBase *pOld = ms_pConfig;
 wxConfigBase *wxConfigBase::Set(wxConfigBase *pConfig)
 {
   wxConfigBase *pOld = ms_pConfig;


@@ -89,7 +86,7 @@ wxConfigBase *wxConfigBase::Create()
 {
   if ( ms_bAutoCreate && ms_pConfig == NULL ) {
     ms_pConfig =
 {
   if ( ms_bAutoCreate && ms_pConfig == NULL ) {
     ms_pConfig =

-    #if defined(__WXMSW__) && defined(wxCONFIG_WIN32_NATIVE)
+    #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE

       #ifdef __WIN32__
         new wxRegConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
       #else  //WIN16
       #ifdef __WIN32__
         new wxRegConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
       #else  //WIN16


@@ -103,124 +100,120 @@ 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") );  \
+                                                                            \
+        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;                                                       \

     }
     }

-    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 = atof(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)
+
+#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;
+    wxCHECK_MSG( pi, FALSE, _T("wxConfig::Read(): NULL parameter") );
+
+    long l;
+    if ( !DoReadLong(key, &l) )

         return FALSE;
         return FALSE;

-    }
-    else
-        return TRUE;
+
+    wxASSERT_MSG( l < INT_MAX, _T("overflow in wxConfig::DoReadInt") );
+
+    *pi = (int)l;
+
+    return TRUE;

 }
 
 }
 

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

 {
 {

+    wxCHECK_MSG( val, FALSE, _T("wxConfig::Read(): NULL parameter") );
+

     long l;
     long l;

-    if (Read(key, & l))
-    {
-        *val = (l != 0);
-        return TRUE;
-    }
-    else
+    if ( !DoReadLong(key, &l) )

         return FALSE;
         return FALSE;

+
+    wxASSERT_MSG( l == 0 || l == 1, _T("bad bool value in wxConfig::DoReadInt") );
+
+    *val = l != 0;
+
+    return TRUE;

 }
 
 }
 

-bool wxConfigBase::Read(const wxString& key, bool* val, bool defVal) const
+bool wxConfigBase::DoReadDouble(const wxString& key, double* val) const

 {
 {

-    if (!Read(key, val))
+    wxString str;
+    if ( Read(key, &str) )

     {
     {

-        *val = defVal;
-        return FALSE;
+        return str.ToDouble(val);

     }
     }

-    else
-        return TRUE;
-}

 
 

-// Convenience functions
+    return FALSE;
+}

 
 

-bool wxConfigBase::Read(const wxString& key, int *pi) const
+// string reading helper
+wxString wxConfigBase::ExpandEnvVars(const wxString& str) const

 {
 {

-    long l;
-    bool ret = Read(key, &l);
-    if (ret)
-        *pi = (int) l;
-    return ret;
+    wxString tmp; // Required for BC++
+    if (IsExpandingEnvVars())
+        tmp = wxExpandEnvVars(str);
+    else
+        tmp = str;
+    return tmp;

 }
 
 }
 

-bool wxConfigBase::Read(const wxString& key, int *pi, int defVal) const
+// ----------------------------------------------------------------------------
+// wxConfigBase writing
+// ----------------------------------------------------------------------------
+
+bool wxConfigBase::DoWriteDouble(const wxString& key, double val)

 {
 {

-    long l;
-    bool ret = Read(key, &l, (long) defVal);
-    *pi = (int) l;
-    return ret;
+    return DoWriteString(key, wxString::Format(_T("%g"), val));

 }
 
 }
 

-bool wxConfigBase::Write(const wxString& key, double val)
+bool wxConfigBase::DoWriteInt(const wxString& key, int value)

 {
 {

-    wxString str;
-    str.Printf("%f", val);
-    return Write(key, str);
+    return DoWriteLong(key, (long)value);

 }
 
 }
 

-bool wxConfigBase::Write(const wxString& key, bool value)
+bool wxConfigBase::DoWriteBool(const wxString& key, bool value)

 {
 {

-    long l = (value ? 1 : 0);
-    return Write(key, l);
+    return DoWriteLong(key, value ? 1l : 0l);

 }
 
 }
 

-wxString wxConfigBase::ExpandEnvVars(const wxString& str) const
-    {
-        wxString tmp; // Required for BC++
-        if (IsExpandingEnvVars())
-            tmp = wxExpandEnvVars(str);
-        else
-            tmp = str;
-        return tmp;
-    }
-
-

 // ----------------------------------------------------------------------------
 // wxConfigPathChanger
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxConfigPathChanger
 // ----------------------------------------------------------------------------


@@ -229,18 +222,25 @@ wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer,
                                  const wxString& strEntry)
 {
   m_pContainer = (wxConfigBase *)pContainer;
                                  const wxString& strEntry)
 {
   m_pContainer = (wxConfigBase *)pContainer;

-  wxString strPath = strEntry.Before(wxCONFIG_PATH_SEPARATOR);

 
 

-  // special case of "/keyname" when there is nothing before "/"
-  if ( strPath.IsEmpty() && ((!strEntry.IsEmpty()) && strEntry[0] == wxCONFIG_PATH_SEPARATOR ))
+  // 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;
     strPath = wxCONFIG_PATH_SEPARATOR;

+  }

 
   if ( !strPath.IsEmpty() ) {
     // do change the path
     m_bChanged = TRUE;
 
   if ( !strPath.IsEmpty() ) {
     // do change the path
     m_bChanged = TRUE;

-    m_strName = strEntry.Right(wxCONFIG_PATH_SEPARATOR);
+    m_strName = strEntry.AfterLast(wxCONFIG_PATH_SEPARATOR);

     m_strOldPath = m_pContainer->GetPath();
     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 {
     m_pContainer->SetPath(strPath);
   }
   else {


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

+#endif // wxUSE_CONFIG
+

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


@@ -276,9 +278,9 @@ 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
   };
 


@@ -286,13 +288,13 @@ wxString wxExpandEnvVars(const wxString& str)
   for ( size_t n = 0; n < str.Len(); n++ ) {
     switch ( str[n] ) {
 #ifdef  __WXMSW__
   for ( size_t n = 0; n < str.Len(); n++ ) {
     switch ( str[n] ) {
 #ifdef  __WXMSW__

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

 #endif  //WINDOWS
 #endif  //WINDOWS

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

         {
           Bracket bracket;
           #ifdef  __WXMSW__
         {
           Bracket bracket;
           #ifdef  __WXMSW__

-            if ( str[n] == '%' )
+            if ( str[n] == wxT('%') )

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


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

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

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

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

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


@@ -318,12 +320,12 @@ wxString wxExpandEnvVars(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;
           }
           if ( pszValue != NULL ) {
             strResult += pszValue;
           }


@@ -340,8 +342,7 @@ 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'."),
+              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 {


@@ -358,7 +359,7 @@ 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] == '%' || str[n + 1] == '$') ) {
+        if ( n != str.Len() && (str[n + 1] == wxT('%') || str[n + 1] == wxT('$')) ) {

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


@@ -374,18 +375,20 @@ 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 char *sz)
+/// separates group and entry names (probably shouldn't be changed)
+
+void wxSplitPath(wxArrayString& aParts, const wxChar *sz)

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

-  const char *pc = sz;
+  const wxChar *pc = sz;

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

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

         // ignore
       }
         // ignore
       }

-      else if ( strCurrent == ".." ) {
+      else if ( strCurrent == wxT("..") ) {

         // go up one level
         if ( aParts.IsEmpty() )
           wxLogWarning(_("'%s' has extra '..', ignored."), sz);
         // go up one level
         if ( aParts.IsEmpty() )
           wxLogWarning(_("'%s' has extra '..', ignored."), sz);


@@ -401,8 +404,8 @@ void wxSplitPath(wxArrayString& aParts, const char *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 == '\0' )
-        return;
+      if ( *pc == wxT('\0') )
+        break;

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