]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/iniconf.cpp
Make wxMSW wxSpinCtrl "not enough space" messages more helpful.
[wxWidgets.git] / src / msw / iniconf.cpp
index 6a33921c5bb4e73d43fedcb0005ff08391dcf684..7d7505636fb79ebb6fdb7a88f89309f4de14b9b3 100644 (file)
@@ -2,42 +2,37 @@
 // 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>
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
-// ============================================================================
-// declarations
-// ============================================================================
+// For compilers that support precompilation, includes "wx.h".
+#include "wx/wxprec.h"
 
-// ----------------------------------------------------------------------------
-// headers
-// ----------------------------------------------------------------------------
-#include  "wx/wxprec.h"
+#ifdef __BORLANDC__
+    #pragma hdrstop
+#endif
 
-#ifdef    __BORLANDC__
-  #pragma hdrstop
-#endif  //__BORLANDC__
+#if wxUSE_INICONF
 
 #ifndef   WX_PRECOMP
-  #include  <wx/string.h>
-  #include  <wx/intl.h>
+    #include "wx/msw/wrapwin.h"
+    #include "wx/dynarray.h"
+    #include "wx/string.h"
+    #include "wx/intl.h"
+    #include "wx/event.h"
+    #include "wx/app.h"
+    #include "wx/utils.h"
+    #include "wx/log.h"
 #endif  //WX_PRECOMP
 
-#include  <wx/dynarray.h>
-#include  <wx/log.h>
-#include  <wx/config.h>
-
-#include  <wx/msw/iniconf.h>
+#include  "wx/config.h"
+#include  "wx/file.h"
 
-// _WINDOWS_ is defined when windows.h is included,
-// __WXMSW__ is defined for MS Windows compilation
-#if       defined(__WXMSW__) && !defined(_WINDOWS_)
-  #include  <windows.h>
-#endif  //windows.h
+#include  "wx/msw/iniconf.h"
 
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 // ctor & dtor
 // ----------------------------------------------------------------------------
-
-wxIniConfig::wxIniConfig(const wxString& strAppName, const wxString& strVendor)
-           : m_strAppName(strAppName), m_strVendor(strVendor)
+IMPLEMENT_ABSTRACT_CLASS(wxIniConfig, wxConfigBase)
+
+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.empty() && wxTheApp) ? wxTheApp->GetAppName()
+                                               : strAppName,
+                          strVendor.empty() ? (wxTheApp ? wxTheApp->GetVendorName()
+                                                  : strAppName)
+                                      : strVendor,
+                          localFilename, globalFilename, style)
+#endif
 {
-  if ( strVendor.IsEmpty() )
-    m_strVendor = strAppName;
-
-  // 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_strAppName[0u]) &&
-        m_strAppName.Find('.') == NOT_FOUND ) {
-    m_strAppName << ".ini";
-  }
+    if (strAppName.empty() && wxTheApp)
+        SetAppName(wxTheApp->GetAppName());
+    if (strVendor.empty() && wxTheApp)
+        SetVendorName(wxTheApp->GetVendorName());
+
+    m_strLocalFilename = localFilename;
+    if (m_strLocalFilename.empty())
+    {
+        m_strLocalFilename = GetAppName() + wxT(".ini");
+    }
 
-  // set root path
-  SetPath("");
+    // 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(wxT('.')) == wxNOT_FOUND )
+    {
+        m_strLocalFilename << wxT(".ini");
+    }
+
+    // set root path
+    SetPath(wxEmptyString);
 }
 
 wxIniConfig::~wxIniConfig()
@@ -83,7 +101,7 @@ void wxIniConfig::SetPath(const wxString& strPath)
 {
   wxArrayString aParts;
 
-  if ( strPath.IsEmpty() ) {
+  if ( strPath.empty() ) {
     // nothing
   }
   else if ( strPath[0u] == wxCONFIG_PATH_SEPARATOR ) {
@@ -115,8 +133,8 @@ void wxIniConfig::SetPath(const wxString& strPath)
 
   // other functions assume that all this is true, i.e. there are no trailing
   // underscores at the end except if the group is the root one
-  wxASSERT( (m_strPath.IsEmpty() || m_strPath.Last() != PATH_SEP_REPLACE) &&
-            (m_strGroup == PATH_SEP_REPLACE ||
+  wxASSERT( (m_strPath.empty() || m_strPath.Last() != PATH_SEP_REPLACE) &&
+            (m_strGroup == wxString(PATH_SEP_REPLACE) ||
              m_strGroup.Last() != PATH_SEP_REPLACE) );
 }
 
@@ -127,14 +145,14 @@ const wxString& wxIniConfig::GetPath() const
   // always return abs path
   s_str = wxCONFIG_PATH_SEPARATOR;
 
-  if ( m_strGroup == PATH_SEP_REPLACE ) {
+  if ( m_strGroup == wxString(PATH_SEP_REPLACE) ) {
     // we're at the root level, nothing to do
   }
   else {
     s_str << m_strGroup;
-    if ( !m_strPath.IsEmpty() )
+    if ( !m_strPath.empty() )
       s_str << wxCONFIG_PATH_SEPARATOR;
-    for ( const char *p = m_strPath; *p != '\0'; p++ ) {
+    for ( const wxStringCharType *p = m_strPath.wx_str(); *p != '\0'; p++ ) {
       s_str << (*p == PATH_SEP_REPLACE ? wxCONFIG_PATH_SEPARATOR : *p);
     }
   }
@@ -142,11 +160,11 @@ const wxString& wxIniConfig::GetPath() const
   return s_str;
 }
 
-wxString wxIniConfig::GetPrivateKeyName(const char *szKey) const
+wxString wxIniConfig::GetPrivateKeyName(const wxString& szKey) const
 {
   wxString strKey;
 
-  if ( !m_strPath.IsEmpty() )
+  if ( !m_strPath.empty() )
     strKey << m_strPath << PATH_SEP_REPLACE;
 
   strKey << szKey;
@@ -154,13 +172,13 @@ wxString wxIniConfig::GetPrivateKeyName(const char *szKey) const
   return strKey;
 }
 
-wxString wxIniConfig::GetKeyName(const char *szKey) const
+wxString wxIniConfig::GetKeyName(const wxString& szKey) const
 {
   wxString strKey;
 
-  if ( m_strGroup != PATH_SEP_REPLACE )
+  if ( m_strGroup != wxString(PATH_SEP_REPLACE) )
     strKey << m_strGroup << PATH_SEP_REPLACE;
-  if ( !m_strPath.IsEmpty() )
+  if ( !m_strPath.empty() )
     strKey << m_strPath << PATH_SEP_REPLACE;
 
   strKey << szKey;
@@ -173,32 +191,32 @@ wxString wxIniConfig::GetKeyName(const char *szKey) const
 // ----------------------------------------------------------------------------
 
 // not implemented
-bool wxIniConfig::GetFirstGroup(wxString& str, long& lIndex) const
+bool wxIniConfig::GetFirstGroup(wxString& WXUNUSED(str), long& WXUNUSED(lIndex)) const
 {
-  wxFAIL_MSG("not implemented");
+    wxFAIL_MSG("not implemented");
 
-  return FALSE;
+    return false;
 }
 
-bool wxIniConfig::GetNextGroup (wxString& str, long& lIndex) const
+bool wxIniConfig::GetNextGroup (wxString& WXUNUSED(str), long& WXUNUSED(lIndex)) const
 {
-  wxFAIL_MSG("not implemented");
+    wxFAIL_MSG("not implemented");
 
-  return FALSE;
+    return false;
 }
 
-bool wxIniConfig::GetFirstEntry(wxString& str, long& lIndex) const
+bool wxIniConfig::GetFirstEntry(wxString& WXUNUSED(str), long& WXUNUSED(lIndex)) const
 {
-  wxFAIL_MSG("not implemented");
+    wxFAIL_MSG("not implemented");
 
-  return FALSE;
+    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");
 
-  return FALSE;
+    return false;
 }
 
 // ----------------------------------------------------------------------------
@@ -206,96 +224,86 @@ bool wxIniConfig::GetNextEntry (wxString& str, long& lIndex) const
 // ----------------------------------------------------------------------------
 
 // not implemented
-size_t wxIniConfig::GetNumberOfEntries(bool bRecursive) const
+size_t wxIniConfig::GetNumberOfEntries(bool WXUNUSED(bRecursive)) const
 {
-  wxFAIL_MSG("not implemented");
+    wxFAIL_MSG("not implemented");
 
-  return (size_t)-1;
+    return (size_t)-1;
 }
 
-size_t wxIniConfig::GetNumberOfGroups(bool bRecursive) const
+size_t wxIniConfig::GetNumberOfGroups(bool WXUNUSED(bRecursive)) const
 {
-  wxFAIL_MSG("not implemented");
+    wxFAIL_MSG("not implemented");
 
-  return (size_t)-1;
+    return (size_t)-1;
 }
 
-bool wxIniConfig::HasGroup(const wxString& strName) const
+bool wxIniConfig::HasGroup(const wxString& WXUNUSED(strName)) const
 {
-  wxFAIL_MSG("not implemented");
+    wxFAIL_MSG("not implemented");
 
-  return FALSE;
+    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");
 
-  return FALSE;
+    return false;
 }
 
 // is current group empty?
 bool wxIniConfig::IsEmpty() const
 {
-  char szBuf[1024];
+    wxChar szBuf[1024];
 
-  GetPrivateProfileString(m_strGroup, NULL, "",
-                          szBuf, WXSIZEOF(szBuf), m_strAppName);
-  if ( !::IsEmpty(szBuf) )
-    return FALSE;
+    GetPrivateProfileString(m_strGroup.t_str(), NULL, wxT(""),
+                            szBuf, WXSIZEOF(szBuf),
+                            m_strLocalFilename.t_str());
+    if ( !wxIsEmpty(szBuf) )
+        return false;
 
-  GetProfileString(m_strGroup, NULL, "", szBuf, WXSIZEOF(szBuf));
-  if ( !::IsEmpty(szBuf) )
-    return FALSE;
+    GetProfileString(m_strGroup.t_str(), NULL, wxT(""), szBuf, WXSIZEOF(szBuf));
+    if ( !wxIsEmpty(szBuf) )
+        return false;
 
-  return TRUE;
+    return true;
 }
 
 // ----------------------------------------------------------------------------
 // read/write
 // ----------------------------------------------------------------------------
 
-bool wxIniConfig::Read(wxString *pstr,
-                       const char *szKey,
-                       const char *szDefault) const
+bool wxIniConfig::DoReadString(const wxString& szKey, wxString *pstr) const
 {
-  PathChanger path(this, szKey);
+  wxConfigPathChanger path(this, szKey);
   wxString strKey = GetPrivateKeyName(path.Name());
 
-  char szBuf[1024]; // @@ should dynamically allocate memory...
+  wxChar szBuf[1024]; // FIXME: 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_strAppName);
-  if ( ::IsEmpty(szBuf) ) {
+  GetPrivateProfileString(m_strGroup.t_str(), strKey.t_str(), wxT(""),
+                          szBuf, WXSIZEOF(szBuf),
+                          m_strLocalFilename.t_str());
+  if ( wxIsEmpty(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;
+    GetProfileString(m_strGroup.t_str(), strKey.t_str(),
+                     wxT(""), szBuf, WXSIZEOF(szBuf));
   }
-}
 
-const char *wxIniConfig::Read(const char *szKey,
-                              const char *szDefault) const
-{
-  static wxString s_str;
-  Read(&s_str, szKey, szDefault);
+  if ( wxIsEmpty(szBuf) )
+    return false;
 
-  return s_str.c_str();
+  *pstr = szBuf;
+  return true;
 }
 
-bool wxIniConfig::Read(long *pl, const char *szKey, long lDefault) const
+bool wxIniConfig::DoReadLong(const wxString& szKey, long *pl) const
 {
-  PathChanger path(this, szKey);
+  wxConfigPathChanger path(this, szKey);
   wxString strKey = GetPrivateKeyName(path.Name());
 
   // hack: we have no mean to know if it really found the default value or
@@ -303,124 +311,170 @@ bool wxIniConfig::Read(long *pl, const char *szKey, long lDefault) const
 
   static const int nMagic  = 17; // 17 is some "rare" number
   static const int nMagic2 = 28; // arbitrary number != nMagic
-  long lVal = GetPrivateProfileInt(m_strGroup, strKey, nMagic, m_strAppName);
+  long lVal = GetPrivateProfileInt(m_strGroup.t_str(), strKey.t_str(),
+                                   nMagic, m_strLocalFilename.t_str());
   if ( lVal != nMagic ) {
     // the value was read from the file
     *pl = lVal;
-    return TRUE;
+    return true;
   }
 
   // is it really nMagic?
-  lVal = GetPrivateProfileInt(m_strGroup, strKey, nMagic2, m_strAppName);
-  if ( lVal == nMagic ) {
+  lVal = GetPrivateProfileInt(m_strGroup.t_str(), strKey.t_str(),
+                              nMagic2, m_strLocalFilename.t_str());
+  if ( lVal != nMagic2 ) {
     // the nMagic it returned was indeed read from the file
     *pl = lVal;
-    return TRUE;
+    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
 *pl = GetProfileInt(m_strVendor, GetKeyName(szKey), lDefault);
*pl = GetProfileInt(GetVendorName(), GetKeyName(szKey), *pl);
 
-  // we're not going to check here whether it read the default or not: it's
-  // not that important
-  return TRUE;
+  return true;
+#endif
+  return false ;
 }
 
-long wxIniConfig::Read(const char *szKey, long lDefault) const
+bool wxIniConfig::DoWriteString(const wxString& szKey, const wxString& szValue)
 {
-  long lVal;
-  Read(&lVal, szKey, lDefault);
-
-  return lVal;
-}
-
-bool wxIniConfig::Write(const char *szKey, const char *szValue)
-{
-  PathChanger path(this, szKey);
+  wxConfigPathChanger path(this, szKey);
   wxString strKey = GetPrivateKeyName(path.Name());
 
-  bool bOk = WritePrivateProfileString(m_strGroup, strKey,
-                                       szValue, m_strAppName) != 0;
+  bool bOk = WritePrivateProfileString(m_strGroup.t_str(), strKey.t_str(),
+                                       szValue.t_str(),
+                                       m_strLocalFilename.t_str()) != 0;
 
   if ( !bOk )
-    wxLogLastError("WritePrivateProfileString");
+  {
+    wxLogLastError(wxT("WritePrivateProfileString"));
+  }
 
   return bOk;
 }
 
-bool wxIniConfig::Write(const char *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)
-  sprintf(szBuf, "%ld", lValue);
+  return Write(szKey, wxString::Format(wxT("%ld"), lValue));
+}
+
+bool wxIniConfig::DoReadBinary(const wxString& WXUNUSED(key),
+                               wxMemoryBuffer * WXUNUSED(buf)) const
+{
+    wxFAIL_MSG("not implemented");
 
-  return Write(szKey, szBuf);
+    return false;
+}
+
+bool wxIniConfig::DoWriteBinary(const wxString& WXUNUSED(key),
+                                const wxMemoryBuffer& WXUNUSED(buf))
+{
+    wxFAIL_MSG("not implemented");
+
+    return false;
 }
 
 bool wxIniConfig::Flush(bool /* bCurrentOnly */)
 {
   // this is just the way it works
-  return WritePrivateProfileString(NULL, NULL, NULL, m_strAppName) != 0;
+  return WritePrivateProfileString(NULL, NULL, NULL,
+                                   m_strLocalFilename.t_str()) != 0;
 }
 
 // ----------------------------------------------------------------------------
 // delete
 // ----------------------------------------------------------------------------
 
-bool wxIniConfig::DeleteEntry(const char *szKey, bool bGroupIfEmptyAlso)
+bool wxIniConfig::DeleteEntry(const wxString& szKey, bool bGroupIfEmptyAlso)
 {
   // passing NULL as value to WritePrivateProfileString deletes the key
-  if ( !Write(szKey, (const char *)NULL) )
-    return FALSE;
-    
+  wxConfigPathChanger path(this, szKey);
+  wxString strKey = GetPrivateKeyName(path.Name());
+
+  if (WritePrivateProfileString(m_strGroup.t_str(), strKey.t_str(),
+                                NULL, m_strLocalFilename.t_str()) == 0)
+    return false;
+
   if ( !bGroupIfEmptyAlso || !IsEmpty() )
-    return TRUE;
+    return true;
 
   // delete the current group too
-  bool bOk = WritePrivateProfileString(m_strGroup, NULL,
-                                       NULL, m_strAppName) != 0;
+  bool bOk = WritePrivateProfileString(m_strGroup.t_str(), NULL,
+                                       NULL, m_strLocalFilename.t_str()) != 0;
 
   if ( !bOk )
-    wxLogLastError("WritePrivateProfileString");
+  {
+    wxLogLastError(wxT("WritePrivateProfileString"));
+  }
 
   return bOk;
 }
 
-bool wxIniConfig::DeleteGroup(const char *szKey)
+bool wxIniConfig::DeleteGroup(const wxString& szKey)
 {
-  PathChanger 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_strAppName) != 0;
+  bool bOk = WritePrivateProfileString(path.Name().t_str(), NULL,
+                                       NULL, m_strLocalFilename.t_str()) != 0;
 
   if ( !bOk )
-    wxLogLastError("WritePrivateProfileString");
+  {
+    wxLogLastError(wxT("WritePrivateProfileString"));
+  }
 
   return bOk;
 }
 
+#ifndef MAX_PATH
+#define MAX_PATH 256
+#endif
+
 bool wxIniConfig::DeleteAll()
 {
   // first delete our group in win.ini
-  WriteProfileString(m_strVendor, NULL, NULL);
+  WriteProfileString(GetVendorName().t_str(), NULL, NULL);
 
   // then delete our own ini file
-  char szBuf[MAX_PATH];
+  wxChar szBuf[MAX_PATH];
   size_t nRc = GetWindowsDirectory(szBuf, WXSIZEOF(szBuf));
   if ( nRc == 0 )
-    wxLogLastError("GetWindowsDirectory");
+  {
+    wxLogLastError(wxT("GetWindowsDirectory"));
+  }
   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_strAppName;
+  strFile << '\\' << m_strLocalFilename;
 
-  if ( !DeleteFile(strFile) ) {
+  if ( wxFile::Exists(strFile) && !wxRemoveFile(strFile) ) {
     wxLogSysError(_("Can't delete the INI file '%s'"), strFile.c_str());
-    return FALSE;
+    return false;
   }
 
-  return TRUE;
+  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_INICONF