fingers crossed..

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

diff --git a/src/common/config.cpp b/src/common/config.cpp
index 667d25e5fe854dea4885f14fb414ee26d31b0436..1b614016b2750f3951157b227aff3b60d4e37490 100644 (file)
--- a/src/common/config.cpp
+++ b/src/common/config.cpp
@@ -1,6 +1,6 @@
 ///////////////////////////////////////////////////////////////////////////////
 // Name:        config.cpp
 ///////////////////////////////////////////////////////////////////////////////
 // Name:        config.cpp

-// Purpose:     implementation of wxConfig class
+// Purpose:     implementation of wxConfigBase class

 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     07.04.98
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     07.04.98


@@ -10,97 +10,245 @@
 // Licence:     wxWindows license
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 ///////////////////////////////////////////////////////////////////////////////
 

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

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

-  #pragma implementation "config.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/config.h>
-#include  <wx/fileconf.h>
-#include <stdlib.h>
+#ifndef wxUSE_CONFIG_NATIVE
+    #define wxUSE_CONFIG_NATIVE 1
+#endif

 
 

-#include  <ctype.h>       // for isalnum()
+#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/log.h"
+#include "wx/utils.h"
+#include "wx/intl.h"
+
+#include "wx/config.h"
+
+#include <stdlib.h>
+#include <math.h>
+#include <ctype.h>

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

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

-wxConfig::~wxConfig()
+
+// 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;

 }
 
 }
 

-wxConfig *wxConfig::Set(wxConfig *pConfig)
+wxConfigBase::~wxConfigBase()

 {
 {

-  wxConfig *pOld = ms_pConfig;
+}
+
+wxConfigBase *wxConfigBase::Set(wxConfigBase *pConfig)
+{
+  wxConfigBase *pOld = ms_pConfig;

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

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

 {
 {

-  ms_pConfig = wxTheApp->CreateConfig();
+  if ( ms_bAutoCreate && ms_pConfig == NULL ) {
+    ms_pConfig =
+    #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
+      #ifdef __WIN32__
+        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
+  }
+
+  return ms_pConfig;

 }
 
 }
 

-const char *wxConfig::Read(const char *szKey, const char *szDefault) const
+wxString wxConfigBase::Read(const wxString& key, const wxString& defVal) const

 {
 {

-  static char s_szBuf[1024];

   wxString s;
   wxString s;

-  Read(&s, szKey, szDefault);
-  strncpy(s_szBuf, s, WXSIZEOF(s_szBuf));
+  Read(key, &s, defVal);
+  return s;
+}
+
+bool wxConfigBase::Read(const wxString& key, wxString *str, const wxString& defVal) const
+{
+    if (!Read(key, str))
+    {
+        *str = ExpandEnvVars(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) )
+    {
+        return str.ToDouble(val);
+    }
+
+    return FALSE;
+}
+
+bool wxConfigBase::Read(const wxString& key, double* val, double defVal) const
+{
+    if (!Read(key, val))
+    {
+        *val = defVal;
+        return FALSE;
+    }
+    else
+        return TRUE;
+}

 
 

-  return s_szBuf;
+bool wxConfigBase::Read(const wxString& key, bool* val) const
+{
+    long l;
+    if (Read(key, & l))
+    {
+        *val = (l != 0);
+        return TRUE;
+    }
+    else
+        return FALSE;
+}
+
+bool wxConfigBase::Read(const wxString& key, bool* val, bool defVal) const
+{
+    if (!Read(key, val))
+    {
+        *val = defVal;
+        return FALSE;
+    }
+    else
+        return TRUE;
+}
+
+// Convenience functions
+
+bool wxConfigBase::Read(const wxString& key, int *pi) const
+{
+    long l;
+    bool ret = Read(key, &l);
+    if (ret)
+        *pi = (int) l;
+    return ret;
+}
+
+bool wxConfigBase::Read(const wxString& key, int *pi, int defVal) const
+{
+    long l;
+    bool ret = Read(key, &l, (long) defVal);
+    if (ret)
+        *pi = (int) l;
+    return ret;
+}
+
+bool wxConfigBase::Write(const wxString& key, double val)
+{
+    wxString str;
+    str.Printf(wxT("%g"), val);
+    return Write(key, str);
+}
+
+bool wxConfigBase::Write(const wxString& key, bool value)
+{
+    return Write(key, value ? 1l : 0l);
+}
+
+bool wxConfigBase::Write(const wxString& key, const wxChar *value)
+{
+    // explicit cast needed, otherwise value would have been converted to bool
+    return Write(key, wxString(value));
+}
+
+wxString wxConfigBase::ExpandEnvVars(const wxString& str) const
+{
+    wxString tmp; // Required for BC++
+    if (IsExpandingEnvVars())
+        tmp = wxExpandEnvVars(str);
+    else
+        tmp = str;
+    return tmp;

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

-// Config::PathChanger
+// wxConfigPathChanger

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

-wxConfig::PathChanger::PathChanger(const wxConfig *pContainer,
+wxConfigPathChanger::wxConfigPathChanger(const wxConfigBase *pContainer,

                                  const wxString& strEntry)
 {
                                  const wxString& strEntry)
 {

-  m_pContainer = (wxConfig *)pContainer;
-  wxString strPath = strEntry.Before(APPCONF_PATH_SEPARATOR);
+  m_pContainer = (wxConfigBase *)pContainer;

 
 

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

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

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

     m_strOldPath = m_pContainer->GetPath();
     m_strOldPath = m_pContainer->GetPath();

-    m_strOldPath += APPCONF_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 {


@@ -110,7 +258,7 @@ wxConfig::PathChanger::PathChanger(const wxConfig *pContainer,
   }
 }
 
   }
 }
 

-wxConfig::PathChanger::~PathChanger()
+wxConfigPathChanger::~wxConfigPathChanger()

 {
   // only restore path if it was changed
   if ( m_bChanged ) {
 {
   // only restore path if it was changed
   if ( m_bChanged ) {


@@ -125,7 +273,7 @@ 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 ExpandEnvVars(const wxString& str)
+wxString wxExpandEnvVars(const wxString& str)

 {
   wxString strResult;
   strResult.Alloc(str.Len());
 {
   wxString strResult;
   strResult.Alloc(str.Len());


@@ -136,23 +284,23 @@ wxString ExpandEnvVars(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
   };
 

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

     switch ( str[n] ) {
 #ifdef  __WXMSW__
     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


@@ -161,12 +309,12 @@ wxString ExpandEnvVars(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;


@@ -178,12 +326,12 @@ wxString ExpandEnvVars(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;
           }


@@ -200,11 +348,11 @@ wxString ExpandEnvVars(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(_("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 {

-              // skip closing bracket
+              // skip closing bracket unless the variables wasn't expanded

               if ( pszValue == NULL )
                 strResult << (char)bracket;
               m++;
               if ( pszValue == NULL )
                 strResult << (char)bracket;
               m++;


@@ -215,6 +363,15 @@ wxString ExpandEnvVars(const wxString& str)
         }
         break;
 
         }
         break;
 

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

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


@@ -224,18 +381,18 @@ wxString ExpandEnvVars(const wxString& str)
 }
 
 // this function is used to properly interpret '..' in path
 }
 
 // this function is used to properly interpret '..' in path

-void SplitPath(wxArrayString& aParts, const char *sz)
+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 == APPCONF_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);


@@ -251,8 +408,8 @@ void SplitPath(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;


@@ -261,3 +418,5 @@ void SplitPath(wxArrayString& aParts, const char *sz)
   }
 }
 
   }
 }
 

+#endif // wxUSE_CONFIG
+