mac support as stubs added

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

diff --git a/src/msw/iniconf.cpp b/src/msw/iniconf.cpp
index 18a824f274b07e1a4182ccafd6a615769e5ed642..ff65d00f8a3fdade858c87bdbe082f78bb36fb29 100644 (file)
--- a/src/msw/iniconf.cpp
+++ b/src/msw/iniconf.cpp
@@ -9,22 +9,21 @@
 // Licence:     wxWindows license
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 ///////////////////////////////////////////////////////////////////////////////
 

-// ============================================================================
-// declarations
-// ============================================================================
+#ifdef __GNUG__
+#pragma implementation "iniconf.h"
+#endif

 
 

-// ----------------------------------------------------------------------------
-// headers
-// ----------------------------------------------------------------------------
-#include  "wx/wxprec.h"
+// For compilers that support precompilation, includes "wx.h".
+#include "wx/wxprec.h"

 
 

-#ifdef    __BORLANDC__
-  #pragma hdrstop
-#endif  //__BORLANDC__
+#ifdef __BORLANDC__
+#pragma hdrstop
+#endif

 
 #ifndef   WX_PRECOMP
   #include  <wx/string.h>
   #include  <wx/intl.h>
 
 #ifndef   WX_PRECOMP
   #include  <wx/string.h>
   #include  <wx/intl.h>

+  #include  <wx/app.h>

 #endif  //WX_PRECOMP
 
 #include  <wx/dynarray.h>
 #endif  //WX_PRECOMP
 
 #include  <wx/dynarray.h>


@@ -54,21 +53,47 @@
 // ctor & dtor
 // ----------------------------------------------------------------------------
 
 // ctor & dtor
 // ----------------------------------------------------------------------------
 

-wxIniConfig::wxIniConfig(const wxString& strAppName, const wxString& strVendor)
-           : m_strAppName(strAppName), m_strVendor(strVendor)
+wxIniConfig::wxIniConfig(const wxString& strAppName, const wxString& strVendor,
+    const wxString& localFilename, const wxString& globalFilename, long style):
+     wxConfigBase(strAppName, strVendor, localFilename, globalFilename, style)

 {
 {

-  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 ( 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);
+    }
+
+    m_strLocalFilename = localFilename;
+    if (m_strLocalFilename.IsEmpty())
+    {
+        m_strLocalFilename = GetAppName() + ".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('.') == NOT_FOUND )
+    {
+        m_strLocalFilename << ".ini";
+    }
+
+    // set root path
+    SetPath("");

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


@@ -97,7 +122,7 @@ void wxIniConfig::SetPath(const wxString& strPath)
     wxSplitPath(aParts, strFullPath);
   }
 
     wxSplitPath(aParts, strFullPath);
   }
 

-  uint nPartsCount = aParts.Count();
+  size_t nPartsCount = aParts.Count();

   m_strPath.Empty();
   if ( nPartsCount == 0 ) {
     // go to the root
   m_strPath.Empty();
   if ( nPartsCount == 0 ) {
     // go to the root


@@ -106,7 +131,7 @@ void wxIniConfig::SetPath(const wxString& strPath)
   else {
     // translate
     m_strGroup = aParts[0u];
   else {
     // translate
     m_strGroup = aParts[0u];

-    for ( uint nPart = 1; nPart < nPartsCount; nPart++ ) {
+    for ( size_t nPart = 1; nPart < nPartsCount; nPart++ ) {

       if ( nPart > 1 )
         m_strPath << PATH_SEP_REPLACE;
       m_strPath << aParts[nPart];
       if ( nPart > 1 )
         m_strPath << PATH_SEP_REPLACE;
       m_strPath << aParts[nPart];


@@ -116,7 +141,7 @@ 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) &&
   // 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 ||
+            (m_strGroup == wxString(PATH_SEP_REPLACE) ||

              m_strGroup.Last() != PATH_SEP_REPLACE) );
 }
 
              m_strGroup.Last() != PATH_SEP_REPLACE) );
 }
 


@@ -127,7 +152,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 == PATH_SEP_REPLACE ) {
+  if ( m_strGroup == (const char*) PATH_SEP_REPLACE ) {

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


@@ -142,7 +167,7 @@ const wxString& wxIniConfig::GetPath() const
   return s_str;
 }
 
   return s_str;
 }
 

-wxString wxIniConfig::GetPrivateKeyName(const char *szKey) const
+wxString wxIniConfig::GetPrivateKeyName(const wxString& szKey) const

 {
   wxString strKey;
 
 {
   wxString strKey;
 


@@ -154,11 +179,11 @@ wxString wxIniConfig::GetPrivateKeyName(const char *szKey) const
   return strKey;
 }
 
   return strKey;
 }
 

-wxString wxIniConfig::GetKeyName(const char *szKey) const
+wxString wxIniConfig::GetKeyName(const wxString& szKey) const

 {
   wxString strKey;
 
 {
   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() )
     strKey << m_strPath << PATH_SEP_REPLACE;
     strKey << m_strGroup << PATH_SEP_REPLACE;
   if ( !m_strPath.IsEmpty() )
     strKey << m_strPath << PATH_SEP_REPLACE;


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

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

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

-  return (uint)-1;
+  return (size_t)-1;

 }
 
 }
 

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

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

-  return (uint)-1;
+  return (size_t)-1;

 }
 
 bool wxIniConfig::HasGroup(const wxString& strName) const
 }
 
 bool wxIniConfig::HasGroup(const wxString& strName) const


@@ -240,7 +265,7 @@ bool wxIniConfig::IsEmpty() const
   char szBuf[1024];
 
   GetPrivateProfileString(m_strGroup, NULL, "",
   char szBuf[1024];
 
   GetPrivateProfileString(m_strGroup, NULL, "",

-                          szBuf, WXSIZEOF(szBuf), m_strAppName);
+                          szBuf, WXSIZEOF(szBuf), m_strLocalFilename);

   if ( !::IsEmpty(szBuf) )
     return FALSE;
 
   if ( !::IsEmpty(szBuf) )
     return FALSE;
 


@@ -255,11 +280,9 @@ bool wxIniConfig::IsEmpty() const
 // read/write
 // ----------------------------------------------------------------------------
 
 // read/write
 // ----------------------------------------------------------------------------
 

-bool wxIniConfig::Read(wxString *pstr,
-                       const char *szKey,
-                       const char *szDefault) const
+bool wxIniConfig::Read(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...
   wxString strKey = GetPrivateKeyName(path.Name());
 
   char szBuf[1024]; // @@ should dynamically allocate memory...


@@ -268,7 +291,7 @@ bool wxIniConfig::Read(wxString *pstr,
 
   // NB: the lpDefault param to GetPrivateProfileString can't be NULL
   GetPrivateProfileString(m_strGroup, strKey, "",
 
   // NB: the lpDefault param to GetPrivateProfileString can't be NULL
   GetPrivateProfileString(m_strGroup, strKey, "",

-                          szBuf, WXSIZEOF(szBuf), m_strAppName);
+                          szBuf, WXSIZEOF(szBuf), m_strLocalFilename);

   if ( ::IsEmpty(szBuf) ) {
     // now look in win.ini
     wxString strKey = GetKeyName(path.Name());
   if ( ::IsEmpty(szBuf) ) {
     // now look in win.ini
     wxString strKey = GetKeyName(path.Name());


@@ -276,7 +299,6 @@ bool wxIniConfig::Read(wxString *pstr,
   }
 
   if ( ::IsEmpty(szBuf) ) {
   }
 
   if ( ::IsEmpty(szBuf) ) {

-    *pstr = szDefault;

     return FALSE;
   }
   else {
     return FALSE;
   }
   else {


@@ -284,18 +306,37 @@ bool wxIniConfig::Read(wxString *pstr,
   }
 }
 
   }
 }
 

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

 {
 {

-  static wxString s_str;
-  Read(&s_str, szKey, szDefault);
+  wxConfigPathChanger path(this, szKey);
+  wxString strKey = GetPrivateKeyName(path.Name());

 
 

-  return s_str.c_str();
+  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;
+  }

 }
 
 }
 

-bool wxIniConfig::Read(long *pl, const char *szKey, long lDefault) const
+bool wxIniConfig::Read(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
   wxString strKey = GetPrivateKeyName(path.Name());
 
   // hack: we have no mean to know if it really found the default value or


@@ -303,7 +344,7 @@ 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
 
   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, strKey, nMagic, m_strLocalFilename);

   if ( lVal != nMagic ) {
     // the value was read from the file
     *pl = lVal;
   if ( lVal != nMagic ) {
     // the value was read from the file
     *pl = lVal;


@@ -311,7 +352,7 @@ bool wxIniConfig::Read(long *pl, const char *szKey, long lDefault) const
   }
 
   // is it really nMagic?
   }
 
   // is it really nMagic?

-  lVal = GetPrivateProfileInt(m_strGroup, strKey, nMagic2, m_strAppName);
+  lVal = GetPrivateProfileInt(m_strGroup, strKey, nMagic2, m_strLocalFilename);

   if ( lVal == nMagic ) {
     // the nMagic it returned was indeed read from the file
     *pl = lVal;
   if ( lVal == nMagic ) {
     // the nMagic it returned was indeed read from the file
     *pl = lVal;


@@ -319,28 +360,18 @@ bool wxIniConfig::Read(long *pl, const char *szKey, long lDefault) const
   }
 
   // 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(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;
 }
 

-long wxIniConfig::Read(const char *szKey, long lDefault) const
+bool wxIniConfig::Write(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,
   wxString strKey = GetPrivateKeyName(path.Name());
 
   bool bOk = WritePrivateProfileString(m_strGroup, strKey,

-                                       szValue, m_strAppName) != 0;
+                                       szValue, m_strLocalFilename) != 0;

 
   if ( !bOk )
     wxLogLastError("WritePrivateProfileString");
 
   if ( !bOk )
     wxLogLastError("WritePrivateProfileString");


@@ -348,7 +379,7 @@ bool wxIniConfig::Write(const char *szKey, const char *szValue)
   return bOk;
 }
 
   return bOk;
 }
 

-bool wxIniConfig::Write(const char *szKey, long lValue)
+bool wxIniConfig::Write(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)


@@ -360,14 +391,14 @@ bool wxIniConfig::Write(const char *szKey, long lValue)
 bool wxIniConfig::Flush(bool /* bCurrentOnly */)
 {
   // this is just the way it works
 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) != 0;

 }
 
 // ----------------------------------------------------------------------------
 // delete
 // ----------------------------------------------------------------------------
 
 }
 
 // ----------------------------------------------------------------------------
 // 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) )
 {
   // passing NULL as value to WritePrivateProfileString deletes the key
   if ( !Write(szKey, (const char *)NULL) )


@@ -378,7 +409,7 @@ bool wxIniConfig::DeleteEntry(const char *szKey, bool bGroupIfEmptyAlso)
 
   // delete the current group too
   bool bOk = WritePrivateProfileString(m_strGroup, NULL,
 
   // delete the current group too
   bool bOk = WritePrivateProfileString(m_strGroup, NULL,

-                                       NULL, m_strAppName) != 0;
+                                       NULL, m_strLocalFilename) != 0;

 
   if ( !bOk )
     wxLogLastError("WritePrivateProfileString");
 
   if ( !bOk )
     wxLogLastError("WritePrivateProfileString");


@@ -386,14 +417,14 @@ bool wxIniConfig::DeleteEntry(const char *szKey, bool bGroupIfEmptyAlso)
   return bOk;
 }
 
   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 
   // whole section according to the docs
   bool bOk = WritePrivateProfileString(path.Name(), NULL,
 
   // 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;
+                                       NULL, m_strLocalFilename) != 0;

 
   if ( !bOk )
     wxLogLastError("WritePrivateProfileString");
 
   if ( !bOk )
     wxLogLastError("WritePrivateProfileString");


@@ -401,23 +432,27 @@ bool wxIniConfig::DeleteGroup(const char *szKey)
   return bOk;
 }
 
   return bOk;
 }
 

+#ifndef MAX_PATH
+#define MAX_PATH 256
+#endif
+

 bool wxIniConfig::DeleteAll()
 {
   // first delete our group in win.ini
 bool wxIniConfig::DeleteAll()
 {
   // first delete our group in win.ini

-  WriteProfileString(m_strVendor, NULL, NULL);
+  WriteProfileString(GetVendorName(), NULL, NULL);

 
   // then delete our own ini file
   char szBuf[MAX_PATH];
 
   // then delete our own ini file
   char szBuf[MAX_PATH];

-  uint nRc = GetWindowsDirectory(szBuf, WXSIZEOF(szBuf));
+  size_t nRc = GetWindowsDirectory(szBuf, WXSIZEOF(szBuf));

   if ( nRc == 0 )
     wxLogLastError("GetWindowsDirectory");
   else if ( nRc > WXSIZEOF(szBuf) )
     wxFAIL_MSG("buffer is too small for Windows directory.");
 
   wxString strFile = szBuf;
   if ( nRc == 0 )
     wxLogLastError("GetWindowsDirectory");
   else if ( nRc > WXSIZEOF(szBuf) )
     wxFAIL_MSG("buffer is too small for Windows directory.");
 
   wxString strFile = szBuf;

-  strFile << '\\' << m_strAppName;
+  strFile << '\\' << m_strLocalFilename;

 
 

-  if ( !DeleteFile(strFile) ) {
+  if ( !wxRemoveFile(strFile) ) {

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