Document wxDocument::DeleteContents().

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

diff --git a/src/common/config.cpp b/src/common/config.cpp
index f9d449b7f22138ec16b49329cf4aba5e933fe1b1..488aa3b118423480617b10992f0f7e5edebd85ef 100644 (file)
--- a/src/common/config.cpp
+++ b/src/common/config.cpp
@@ -1,133 +1,307 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        config.cpp
-// Purpose:     implementation of wxConfig class
+// Name:        src/common/config.cpp
+// Purpose:     implementation of wxConfigBase class

 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     07.04.98
 // RCS-ID:      $Id$
 // 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>
 //                       Vadim Zeitlin      <zeitlin@dptmaths.ens-cachan.fr>

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

 ///////////////////////////////////////////////////////////////////////////////
 
 ///////////////////////////////////////////////////////////////////////////////
 

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

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

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

 
 

-#include  "wx/wxprec.h"
+#include "wx/wxprec.h"

 
 

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

 #endif  //__BORLANDC__
 
 #endif  //__BORLANDC__
 

+#ifndef wxUSE_CONFIG_NATIVE
+    #define wxUSE_CONFIG_NATIVE 1
+#endif
+
+#include "wx/config.h"
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-  #include  <wx/string.h>
-  #include  <wx/intl.h>
+    #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
 
 #endif //WX_PRECOMP
 

-#include  <wx/app.h>
-#include  <wx/file.h>
-#include  <wx/log.h>
-#include  <wx/textfile.h>
-#include  <wx/config.h>
-
-// we must include (one of) these files for wxConfig::Create
-#if defined(__MSWIN__) && 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>
-#endif
+#if wxUSE_CONFIG && ((wxUSE_FILE && wxUSE_TEXTFILE) || wxUSE_CONFIG_NATIVE)
+
+#include "wx/apptrait.h"
+#include "wx/file.h"

 
 

-#include  <stdlib.h>
-#include  <ctype.h>       // for isalnum()
+#include <stdlib.h>
+#include <ctype.h>
+#include <limits.h>     // for INT_MAX

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

-wxConfig *wxConfig::ms_pConfig = NULL;
+wxConfigBase *wxConfigBase::ms_pConfig     = NULL;
+bool          wxConfigBase::ms_bAutoCreate = true;

 
 // ============================================================================
 // implementation
 // ============================================================================
 
 // ----------------------------------------------------------------------------
 
 // ============================================================================
 // implementation
 // ============================================================================
 
 // ----------------------------------------------------------------------------

-// wxConfig
+// wxAppTraitsBase

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-wxConfig *wxConfig::Set(wxConfig *pConfig)
+wxConfigBase *wxAppTraitsBase::CreateConfig()

 {
 {

-  wxConfig *pOld = ms_pConfig;
+    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
+// ----------------------------------------------------------------------------
+IMPLEMENT_ABSTRACT_CLASS(wxConfigBase, wxObject)
+
+// 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()
+{
+    // required here for Darwin
+}
+
+wxConfigBase *wxConfigBase::Set(wxConfigBase *pConfig)
+{
+  wxConfigBase *pOld = ms_pConfig;

   ms_pConfig = pConfig;
   return pOld;
 }
 
   ms_pConfig = pConfig;
   return pOld;
 }
 

-wxConfig *wxConfig::Create()
+wxConfigBase *wxConfigBase::Create()

 {
 {

-  return ms_pConfig =
-#if defined(__MSWIN__) && defined(wxCONFIG_WIN32_NATIVE)
-  #ifdef __WIN32__
-    new wxRegConfig(wxTheApp->GetAppName(), wxTheApp->GetVendorName());
-  #else  //WIN16
-    #error "Sorry, no wxIniConfig yet..."
-    //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
+  if ( ms_bAutoCreate && ms_pConfig == NULL ) {
+    wxAppTraits * const traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+    wxCHECK_MSG( traits, NULL, wxT("create wxApp before calling this") );
+
+    ms_pConfig = traits->CreateConfig();
+  }
+
+  return ms_pConfig;
+}
+
+// ----------------------------------------------------------------------------
+// wxConfigBase reading entries
+// ----------------------------------------------------------------------------
+
+// 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, wxT("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, wxT("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;                                                        \
+    }
+
+
+IMPLEMENT_READ_FOR_TYPE(String, wxString, const wxString&, ExpandEnvVars)
+IMPLEMENT_READ_FOR_TYPE(Long, long, long, long)
+IMPLEMENT_READ_FOR_TYPE(Double, double, double, double)
+IMPLEMENT_READ_FOR_TYPE(Bool, bool, bool, bool)
+
+#undef IMPLEMENT_READ_FOR_TYPE
+
+// int is stored as long
+bool wxConfigBase::Read(const wxString& key, int *pi) const
+{
+    long l = *pi;
+    bool r = Read(key, &l);
+    wxASSERT_MSG( l < INT_MAX, wxT("int overflow in wxConfig::Read") );
+    *pi = (int)l;
+    return r;
+}
+
+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;
+}
+
+// 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
+{
+    wxCHECK_MSG( val, false, wxT("wxConfig::Read(): NULL parameter") );
+
+    long l;
+    if ( !DoReadLong(key, &l) )
+        return false;
+
+    wxASSERT_MSG( l == 0 || l == 1, wxT("bad bool value in wxConfig::DoReadInt") );
+
+    *val = l != 0;
+
+    return true;
+}
+
+bool wxConfigBase::DoReadDouble(const wxString& key, double* val) const
+{
+    wxString str;
+    if ( Read(key, &str) )
+    {
+        return str.ToDouble(val);
+    }
+
+    return false;

 }
 
 }
 

-const char *wxConfig::Read(const char *szKey, const char *szDefault) const
+// string reading helper
+wxString wxConfigBase::ExpandEnvVars(const wxString& str) const

 {
 {

-  static char s_szBuf[1024];
-  wxString s;
-  Read(&s, szKey, szDefault);
-  strncpy(s_szBuf, s, WXSIZEOF(s_szBuf));
+    wxString tmp; // Required for BC++
+    if (IsExpandingEnvVars())
+        tmp = wxExpandEnvVars(str);
+    else
+        tmp = str;
+    return tmp;
+}

 
 

-  return s_szBuf;
+// ----------------------------------------------------------------------------
+// wxConfigBase writing
+// ----------------------------------------------------------------------------
+
+bool wxConfigBase::DoWriteDouble(const wxString& key, double val)
+{
+    return DoWriteString(key, wxString::Format(wxT("%g"), val));
+}
+
+bool wxConfigBase::DoWriteBool(const wxString& key, bool value)
+{
+    return DoWriteLong(key, value ? 1l : 0l);

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------

-// Config::PathChanger
+// wxConfigPathChanger

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-wxConfig::PathChanger::PathChanger(const wxConfig *pContainer,
-                                 const wxString& strEntry)
+wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer,
+                                         const wxString& strEntry)

 {
 {

-  m_pContainer = (wxConfig *)pContainer;
-  wxString strPath = strEntry.Before(wxCONFIG_PATH_SEPARATOR);
+  m_bChanged = false;
+  m_pContainer = (wxConfigBase *)pContainer;
+
+  // the path is everything which precedes the last slash
+  wxString strPath = strEntry.BeforeLast(wxCONFIG_PATH_SEPARATOR);

 
 

-  // special case of "/keyname" when there is nothing before "/"
-  if ( strPath.IsEmpty() && strEntry[0] == wxCONFIG_PATH_SEPARATOR )
+  // except in the special case of "/keyname" when there is nothing before "/"
+  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;
-    m_strName = strEntry.Right(wxCONFIG_PATH_SEPARATOR);
-    m_strOldPath = m_pContainer->GetPath();
-    m_strOldPath += wxCONFIG_PATH_SEPARATOR;
-    m_pContainer->SetPath(strPath);
+  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 .wc_str() below and
+           adding the following code to the config sample OnInit under
+           Windows:
+
+           pConfig->SetPath(wxT("MySettings"));
+           pConfig->SetPath(wxT(".."));
+           int value;
+           pConfig->Read(wxT("MainWindowX"), & value);
+        */
+        m_strOldPath = m_pContainer->GetPath().wc_str();
+        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
   }
   else {
     // it's a name only, without path - nothing to do

-    m_bChanged = FALSE;

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

-wxConfig::PathChanger::~PathChanger()
+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
   if ( m_bChanged ) {
 {
   // only restore path if it was changed
   if ( m_bChanged ) {


@@ -135,6 +309,26 @@ wxConfig::PathChanger::~PathChanger()
   }
 }
 
   }
 }
 

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

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


@@ -142,48 +336,50 @@ wxConfig::PathChanger::~PathChanger()
 // 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());

 
 

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

 #ifdef  __WXMSW__
 #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

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

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

-            switch ( str[n + 1] ) {
-              case '(':
+            switch ( str[n + 1].GetValue() ) {
+              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;


@@ -195,16 +391,26 @@ wxString wxExpandEnvVars(const wxString& str)
 
           m = n + 1;
 
 
           m = n + 1;
 

-          while ( m < str.Len() && (isalnum(str[m]) || str[m] == '_') )
+          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);
 

-          const char *pszValue = getenv(strVarName);
-          if ( pszValue != NULL ) {
-            strResult += pszValue;
+#ifdef __WXWINCE__
+          const bool expanded = false;
+#else
+          // 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 )


@@ -216,14 +422,22 @@ 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(_("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 {
             }
             else {

-              // skip closing bracket
-              if ( pszValue == NULL )
-                strResult << (char)bracket;
+              // skip closing bracket unless the variables wasn't expanded
+              if ( !expanded )
+                strResult << (wxChar)bracket;

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


@@ -232,6 +446,16 @@ wxString wxExpandEnvVars(const wxString& str)
         }
         break;
 
         }
         break;
 

+      case wxT('\\'):
+        // backslash can be used to suppress special meaning of % and $
+        if ( n != str.length() - 1 &&
+                (str[n + 1] == wxT('%') || str[n + 1] == wxT('$')) ) {
+          strResult += str[++n];
+
+          break;
+        }
+        //else: fall through
+

       default:
         strResult += str[n];
     }
       default:
         strResult += str[n];
     }


@@ -241,40 +465,43 @@ 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)
+void wxSplitPath(wxArrayString& aParts, const wxString& path)

 {
 {

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

 
   wxString strCurrent;
 
   wxString strCurrent;

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

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

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

         // ignore
       }
         // ignore
       }

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

         // go up one level
         // go up one level

-        if ( aParts.IsEmpty() )
-          wxLogWarning(_("'%s' has extra '..', ignored."), sz);
+        if ( aParts.size() == 0 )
+        {
+          wxLogWarning(_("'%s' has extra '..', ignored."), path);
+        }

         else
         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:
         // could log an error here, but we prefer to ignore extra '/'
 
         strCurrent.Empty();
       }
       //else:
         // could log an error here, but we prefer to ignore extra '/'
 

-      if ( *pc == '\0' )
-        return;
+      if ( pc == path.end() )
+        break;

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

-    pc++;
+    ++pc;

   }
 }
   }
 }

-