applied patch 890642: wxRE_ADVANCED flag and docs

[wxWidgets.git] / src / msw / iniconf.cpp

diff --git a/src/msw/iniconf.cpp b/src/msw/iniconf.cpp
index ff65d00f8a3fdade858c87bdbe082f78bb36fb29..0184d5ab1f835dfb925985d8903c2bfc1fa4b0c7 100644 (file)
--- a/src/msw/iniconf.cpp
+++ b/src/msw/iniconf.cpp
@@ -2,14 +2,14 @@
 // Name:        src/msw/iniconf.cpp
 // Purpose:     implementation of wxIniConfig class
 // Author:      Vadim Zeitlin
 // Name:        src/msw/iniconf.cpp
 // Purpose:     implementation of wxIniConfig class
 // Author:      Vadim Zeitlin

-// Modified by: 
+// Modified by:

 // Created:     27.07.98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     27.07.98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

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

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

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

 #pragma implementation "iniconf.h"
 #endif
 
 #pragma implementation "iniconf.h"
 #endif
 


@@ -21,21 +21,28 @@
 #endif
 
 #ifndef   WX_PRECOMP
 #endif
 
 #ifndef   WX_PRECOMP

-  #include  <wx/string.h>
-  #include  <wx/intl.h>
-  #include  <wx/app.h>
+  #include  "wx/string.h"
+  #include  "wx/intl.h"
+  #include  "wx/event.h"
+  #include  "wx/app.h"
+  #include  "wx/utils.h"

 #endif  //WX_PRECOMP
 
 #endif  //WX_PRECOMP
 

-#include  <wx/dynarray.h>
-#include  <wx/log.h>
-#include  <wx/config.h>
+// Doesn't yet compile in Unicode mode

 
 

-#include  <wx/msw/iniconf.h>
+#if wxUSE_CONFIG && !wxUSE_UNICODE
+
+#include  "wx/dynarray.h"
+#include  "wx/log.h"
+#include  "wx/config.h"
+#include  "wx/file.h"
+
+#include  "wx/msw/iniconf.h"

 
 // _WINDOWS_ is defined when windows.h is included,
 // __WXMSW__ is defined for MS Windows compilation
 #if       defined(__WXMSW__) && !defined(_WINDOWS_)
 
 // _WINDOWS_ is defined when windows.h is included,
 // __WXMSW__ is defined for MS Windows compilation
 #if       defined(__WXMSW__) && !defined(_WINDOWS_)

-  #include  <windows.h>
+  #include  "wx/msw/wrapwin.h"

 #endif  //windows.h
 
 // ----------------------------------------------------------------------------
 #endif  //windows.h
 
 // ----------------------------------------------------------------------------


@@ -53,47 +60,43 @@
 // ctor & dtor
 // ----------------------------------------------------------------------------
 
 // ctor & dtor
 // ----------------------------------------------------------------------------
 

-wxIniConfig::wxIniConfig(const wxString& strAppName, const wxString& strVendor,
-    const wxString& localFilename, const wxString& globalFilename, long style):
-     wxConfigBase(strAppName, strVendor, localFilename, globalFilename, style)
+wxIniConfig::wxIniConfig(const wxString& strAppName,
+                         const wxString& strVendor,
+                         const wxString& localFilename,
+                         const wxString& globalFilename,
+                         long style)
+           : wxConfigBase(strAppName, strVendor, localFilename, globalFilename, style)
+
+#if 0 // This is too complex for some compilers, e.g. BC++ 5.01
+           : wxConfigBase((strAppName.IsEmpty() && wxTheApp) ? wxTheApp->GetAppName()
+                                               : strAppName,
+                          strVendor.IsEmpty() ? (wxTheApp ? wxTheApp->GetVendorName()
+                                                  : strAppName)
+                                      : strVendor,
+                          localFilename, globalFilename, style)
+#endif

 {
 {

-    if ( GetAppName().IsEmpty() )
-    {
-        wxString app;
-        if (wxTheApp)
-            app = wxTheApp->GetAppName();
-        wxASSERT( !app.IsEmpty() );
-        SetAppName(app);
-    }
-
-    // Vendor name is required in wxIniConfig.
-    // TODO: should it be required? Why isn't appName used instead? -- JACS
-    if ( GetVendorName().IsEmpty() )
-    {
-        wxString vendor;
-        if (wxTheApp)
-            vendor = wxTheApp->GetVendorName();
-        else
-            vendor = strAppName;
-        SetVendorName(vendor);
-    }
+    if (strAppName.IsEmpty() && wxTheApp)
+        SetAppName(wxTheApp->GetAppName());
+    if (strVendor.IsEmpty() && wxTheApp)
+        SetVendorName(wxTheApp->GetVendorName());

 
     m_strLocalFilename = localFilename;
     if (m_strLocalFilename.IsEmpty())
     {
 
     m_strLocalFilename = localFilename;
     if (m_strLocalFilename.IsEmpty())
     {

-        m_strLocalFilename = GetAppName() + ".ini";
+        m_strLocalFilename = GetAppName() + wxT(".ini");

     }
 
     // append the extension if none given and it's not an absolute file name
     // (otherwise we assume that they know what they're doing)
     if ( !wxIsPathSeparator(m_strLocalFilename[0u]) &&
     }
 
     // append the extension if none given and it's not an absolute file name
     // (otherwise we assume that they know what they're doing)
     if ( !wxIsPathSeparator(m_strLocalFilename[0u]) &&

-        m_strLocalFilename.Find('.') == NOT_FOUND )
+        m_strLocalFilename.Find(wxT('.')) == wxNOT_FOUND )

     {
     {

-        m_strLocalFilename << ".ini";
+        m_strLocalFilename << wxT(".ini");

     }
 
     // set root path
     }
 
     // set root path

-    SetPath("");
+    SetPath(wxEmptyString);

 }
 
 wxIniConfig::~wxIniConfig()
 }
 
 wxIniConfig::~wxIniConfig()


@@ -152,7 +155,7 @@ const wxString& wxIniConfig::GetPath() const
   // always return abs path
   s_str = wxCONFIG_PATH_SEPARATOR;
 
   // always return abs path
   s_str = wxCONFIG_PATH_SEPARATOR;
 

-  if ( m_strGroup == (const char*) PATH_SEP_REPLACE ) {
+  if ( m_strGroup == wxString(PATH_SEP_REPLACE) ) {

     // we're at the root level, nothing to do
   }
   else {
     // we're at the root level, nothing to do
   }
   else {


@@ -198,28 +201,28 @@ wxString wxIniConfig::GetKeyName(const wxString& szKey) const
 // ----------------------------------------------------------------------------
 
 // not implemented
 // ----------------------------------------------------------------------------
 
 // not implemented

-bool wxIniConfig::GetFirstGroup(wxString& str, long& lIndex) const
+bool wxIniConfig::GetFirstGroup(wxString& WXUNUSED(str), long& WXUNUSED(lIndex)) const

 {
   wxFAIL_MSG("not implemented");
 
   return FALSE;
 }
 
 {
   wxFAIL_MSG("not implemented");
 
   return FALSE;
 }
 

-bool wxIniConfig::GetNextGroup (wxString& str, long& lIndex) const
+bool wxIniConfig::GetNextGroup (wxString& WXUNUSED(str), long& WXUNUSED(lIndex)) const

 {
   wxFAIL_MSG("not implemented");
 
   return FALSE;
 }
 
 {
   wxFAIL_MSG("not implemented");
 
   return FALSE;
 }
 

-bool wxIniConfig::GetFirstEntry(wxString& str, long& lIndex) const
+bool wxIniConfig::GetFirstEntry(wxString& WXUNUSED(str), long& WXUNUSED(lIndex)) const

 {
   wxFAIL_MSG("not implemented");
 
   return FALSE;
 }
 
 {
   wxFAIL_MSG("not implemented");
 
   return FALSE;
 }
 

-bool wxIniConfig::GetNextEntry (wxString& str, long& lIndex) const
+bool wxIniConfig::GetNextEntry (wxString& WXUNUSED(str), long& WXUNUSED(lIndex)) const

 {
   wxFAIL_MSG("not implemented");
 
 {
   wxFAIL_MSG("not implemented");
 


@@ -231,28 +234,28 @@ bool wxIniConfig::GetNextEntry (wxString& str, long& lIndex) const
 // ----------------------------------------------------------------------------
 
 // not implemented
 // ----------------------------------------------------------------------------
 
 // not implemented

-size_t wxIniConfig::GetNumberOfEntries(bool bRecursive) const
+size_t wxIniConfig::GetNumberOfEntries(bool WXUNUSED(bRecursive)) const

 {
   wxFAIL_MSG("not implemented");
 
   return (size_t)-1;
 }
 
 {
   wxFAIL_MSG("not implemented");
 
   return (size_t)-1;
 }
 

-size_t wxIniConfig::GetNumberOfGroups(bool bRecursive) const
+size_t wxIniConfig::GetNumberOfGroups(bool WXUNUSED(bRecursive)) const

 {
   wxFAIL_MSG("not implemented");
 
   return (size_t)-1;
 }
 
 {
   wxFAIL_MSG("not implemented");
 
   return (size_t)-1;
 }
 

-bool wxIniConfig::HasGroup(const wxString& strName) const
+bool wxIniConfig::HasGroup(const wxString& WXUNUSED(strName)) const

 {
   wxFAIL_MSG("not implemented");
 
   return FALSE;
 }
 
 {
   wxFAIL_MSG("not implemented");
 
   return FALSE;
 }
 

-bool wxIniConfig::HasEntry(const wxString& strName) const
+bool wxIniConfig::HasEntry(const wxString& WXUNUSED(strName)) const

 {
   wxFAIL_MSG("not implemented");
 
 {
   wxFAIL_MSG("not implemented");
 


@@ -280,7 +283,7 @@ bool wxIniConfig::IsEmpty() const
 // read/write
 // ----------------------------------------------------------------------------
 
 // read/write
 // ----------------------------------------------------------------------------
 

-bool wxIniConfig::Read(const wxString& szKey, wxString *pstr) const
+bool wxIniConfig::DoReadString(const wxString& szKey, wxString *pstr) const

 {
   wxConfigPathChanger path(this, szKey);
   wxString strKey = GetPrivateKeyName(path.Name());
 {
   wxConfigPathChanger path(this, szKey);
   wxString strKey = GetPrivateKeyName(path.Name());


@@ -298,43 +301,14 @@ bool wxIniConfig::Read(const wxString& szKey, wxString *pstr) const
     GetProfileString(m_strGroup, strKey, "", szBuf, WXSIZEOF(szBuf));
   }
 
     GetProfileString(m_strGroup, strKey, "", szBuf, WXSIZEOF(szBuf));
   }
 

-  if ( ::IsEmpty(szBuf) ) {
+  if ( ::IsEmpty(szBuf) )

     return FALSE;
     return FALSE;

-  }
-  else {
-    return TRUE;
-  }
-}

 
 

-bool wxIniConfig::Read(const wxString& szKey, wxString *pstr,
-                       const wxString& szDefault) const
-{
-  wxConfigPathChanger path(this, szKey);
-  wxString strKey = GetPrivateKeyName(path.Name());
-
-  char szBuf[1024]; // @@ should dynamically allocate memory...
-
-  // first look in the private INI file
-
-  // NB: the lpDefault param to GetPrivateProfileString can't be NULL
-  GetPrivateProfileString(m_strGroup, strKey, "",
-                          szBuf, WXSIZEOF(szBuf), m_strLocalFilename);
-  if ( ::IsEmpty(szBuf) ) {
-    // now look in win.ini
-    wxString strKey = GetKeyName(path.Name());
-    GetProfileString(m_strGroup, strKey, "", szBuf, WXSIZEOF(szBuf));
-  }
-
-  if ( ::IsEmpty(szBuf) ) {
-    *pstr = szDefault;
-    return FALSE;
-  }
-  else {
-    return TRUE;
-  }
+  *pstr = szBuf;
+  return TRUE;

 }
 
 }
 

-bool wxIniConfig::Read(const wxString& szKey, long *pl) const
+bool wxIniConfig::DoReadLong(const wxString& szKey, long *pl) const

 {
   wxConfigPathChanger path(this, szKey);
   wxString strKey = GetPrivateKeyName(path.Name());
 {
   wxConfigPathChanger path(this, szKey);
   wxString strKey = GetPrivateKeyName(path.Name());


@@ -353,19 +327,25 @@ bool wxIniConfig::Read(const wxString& szKey, long *pl) const
 
   // is it really nMagic?
   lVal = GetPrivateProfileInt(m_strGroup, strKey, nMagic2, m_strLocalFilename);
 
   // is it really nMagic?
   lVal = GetPrivateProfileInt(m_strGroup, strKey, nMagic2, m_strLocalFilename);

-  if ( lVal == nMagic ) {
+  if ( lVal != nMagic2 ) {

     // the nMagic it returned was indeed read from the file
     *pl = lVal;
     return TRUE;
   }
 
     // the nMagic it returned was indeed read from the file
     *pl = lVal;
     return TRUE;
   }
 

+  // CS : I have no idea why they should look up in win.ini
+  // and if at all they have to do the same procedure using the two magic numbers
+  // otherwise it always returns true, even if the key was not there at all
+#if 0

   // no, it was just returning the default value, so now look in win.ini
   // no, it was just returning the default value, so now look in win.ini

-  *pl = GetProfileInt(GetVendorName(), GetKeyName(szKey), *pl);
+ *pl = GetProfileInt(GetVendorName(), GetKeyName(szKey), *pl);

 
   return TRUE;
 
   return TRUE;

+#endif
+  return FALSE ;

 }
 
 }
 

-bool wxIniConfig::Write(const wxString& szKey, const wxString& szValue)
+bool wxIniConfig::DoWriteString(const wxString& szKey, const wxString& szValue)

 {
   wxConfigPathChanger path(this, szKey);
   wxString strKey = GetPrivateKeyName(path.Name());
 {
   wxConfigPathChanger path(this, szKey);
   wxString strKey = GetPrivateKeyName(path.Name());


@@ -374,12 +354,12 @@ bool wxIniConfig::Write(const wxString& szKey, const wxString& szValue)
                                        szValue, m_strLocalFilename) != 0;
 
   if ( !bOk )
                                        szValue, m_strLocalFilename) != 0;
 
   if ( !bOk )

-    wxLogLastError("WritePrivateProfileString");
+    wxLogLastError(wxT("WritePrivateProfileString"));

 
   return bOk;
 }
 
 
   return bOk;
 }
 

-bool wxIniConfig::Write(const wxString& szKey, long lValue)
+bool wxIniConfig::DoWriteLong(const wxString& szKey, long lValue)

 {
   // ltoa() is not ANSI :-(
   char szBuf[40];   // should be good for sizeof(long) <= 16 (128 bits)
 {
   // ltoa() is not ANSI :-(
   char szBuf[40];   // should be good for sizeof(long) <= 16 (128 bits)


@@ -401,9 +381,13 @@ bool wxIniConfig::Flush(bool /* bCurrentOnly */)
 bool wxIniConfig::DeleteEntry(const wxString& szKey, bool bGroupIfEmptyAlso)
 {
   // passing NULL as value to WritePrivateProfileString deletes the key
 bool wxIniConfig::DeleteEntry(const wxString& szKey, bool bGroupIfEmptyAlso)
 {
   // passing NULL as value to WritePrivateProfileString deletes the key

-  if ( !Write(szKey, (const char *)NULL) )
+  wxConfigPathChanger path(this, szKey);
+  wxString strKey = GetPrivateKeyName(path.Name());
+
+  if (WritePrivateProfileString(m_strGroup, strKey,
+                                         (const char*) NULL, m_strLocalFilename) == 0)

     return FALSE;
     return FALSE;

-    
+

   if ( !bGroupIfEmptyAlso || !IsEmpty() )
     return TRUE;
 
   if ( !bGroupIfEmptyAlso || !IsEmpty() )
     return TRUE;
 


@@ -412,7 +396,7 @@ bool wxIniConfig::DeleteEntry(const wxString& szKey, bool bGroupIfEmptyAlso)
                                        NULL, m_strLocalFilename) != 0;
 
   if ( !bOk )
                                        NULL, m_strLocalFilename) != 0;
 
   if ( !bOk )

-    wxLogLastError("WritePrivateProfileString");
+    wxLogLastError(wxT("WritePrivateProfileString"));

 
   return bOk;
 }
 
   return bOk;
 }


@@ -421,13 +405,13 @@ bool wxIniConfig::DeleteGroup(const wxString& szKey)
 {
   wxConfigPathChanger path(this, szKey);
 
 {
   wxConfigPathChanger path(this, szKey);
 

-  // passing NULL as section name to WritePrivateProfileString deletes the 
+  // passing NULL as section name to WritePrivateProfileString deletes the

   // whole section according to the docs
   bool bOk = WritePrivateProfileString(path.Name(), NULL,
                                        NULL, m_strLocalFilename) != 0;
 
   if ( !bOk )
   // whole section according to the docs
   bool bOk = WritePrivateProfileString(path.Name(), NULL,
                                        NULL, m_strLocalFilename) != 0;
 
   if ( !bOk )

-    wxLogLastError("WritePrivateProfileString");
+    wxLogLastError(wxT("WritePrivateProfileString"));

 
   return bOk;
 }
 
   return bOk;
 }


@@ -445,17 +429,38 @@ bool wxIniConfig::DeleteAll()
   char szBuf[MAX_PATH];
   size_t nRc = GetWindowsDirectory(szBuf, WXSIZEOF(szBuf));
   if ( nRc == 0 )
   char szBuf[MAX_PATH];
   size_t nRc = GetWindowsDirectory(szBuf, WXSIZEOF(szBuf));
   if ( nRc == 0 )

-    wxLogLastError("GetWindowsDirectory");
+  {
+    wxLogLastError(wxT("GetWindowsDirectory"));
+  }

   else if ( nRc > WXSIZEOF(szBuf) )
   else if ( nRc > WXSIZEOF(szBuf) )

-    wxFAIL_MSG("buffer is too small for Windows directory.");
+  {
+    wxFAIL_MSG(wxT("buffer is too small for Windows directory."));
+  }

 
   wxString strFile = szBuf;
   strFile << '\\' << m_strLocalFilename;
 
 
   wxString strFile = szBuf;
   strFile << '\\' << m_strLocalFilename;
 

-  if ( !wxRemoveFile(strFile) ) {
+  if ( wxFile::Exists(strFile) && !wxRemoveFile(strFile) ) {

     wxLogSysError(_("Can't delete the INI file '%s'"), strFile.c_str());
     return FALSE;
   }
 
   return TRUE;
 }
     wxLogSysError(_("Can't delete the INI file '%s'"), strFile.c_str());
     return FALSE;
   }
 
   return TRUE;
 }

+
+bool wxIniConfig::RenameEntry(const wxString& WXUNUSED(oldName),
+                              const wxString& WXUNUSED(newName))
+{
+    // Not implemented
+    return FALSE;
+}
+
+bool wxIniConfig::RenameGroup(const wxString& WXUNUSED(oldName),
+                              const wxString& WXUNUSED(newName))
+{
+    // Not implemented
+    return FALSE;
+}
+
+#endif
+    // wxUSE_CONFIG && wxUSE_UNICODE