+///////////////////////////////////////////////////////////////////////////////
+// Name: src/msw/iniconf.cpp
+// Purpose: implementation of wxIniConfig class
+// Author: Vadim Zeitlin
+// Modified by:
+// Created: 27.07.98
+// RCS-ID: $Id$
+// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
+// Licence: wxWindows license
+///////////////////////////////////////////////////////////////////////////////
+
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+#include "wx/wxprec.h"
+
+#ifdef __BORLANDC__
+ #pragma hdrstop
+#endif //__BORLANDC__
+
+#ifndef WX_PRECOMP
+ #include <wx/string.h>
+ #include <wx/intl.h>
+#endif //WX_PRECOMP
+
+#include <wx/dynarray.h>
+#include <wx/log.h>
+#include <wx/config.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_)
+ #include <windows.h>
+#endif //windows.h
+
+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
+// we replace all path separators with this character
+#define PATH_SEP_REPLACE '_'
+
+// ============================================================================
+// implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// ctor & dtor
+// ----------------------------------------------------------------------------
+
+wxIniConfig::wxIniConfig(const wxString& strAppName, const wxString& strVendor)
+ : m_strAppName(strAppName), m_strVendor(strVendor)
+{
+ 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";
+ }
+
+ // set root path
+ SetPath("");
+}
+
+wxIniConfig::~wxIniConfig()
+{
+}
+
+// ----------------------------------------------------------------------------
+// path management
+// ----------------------------------------------------------------------------
+
+void wxIniConfig::SetPath(const wxString& strPath)
+{
+ wxArrayString aParts;
+
+ if ( strPath.IsEmpty() ) {
+ // nothing
+ }
+ else if ( strPath[0u] == wxCONFIG_PATH_SEPARATOR ) {
+ // absolute path
+ wxSplitPath(aParts, strPath);
+ }
+ else {
+ // relative path, combine with current one
+ wxString strFullPath = GetPath();
+ strFullPath << wxCONFIG_PATH_SEPARATOR << strPath;
+ wxSplitPath(aParts, strFullPath);
+ }
+
+ uint nPartsCount = aParts.Count();
+ m_strPath.Empty();
+ if ( nPartsCount == 0 ) {
+ // go to the root
+ m_strGroup = PATH_SEP_REPLACE;
+ }
+ else {
+ // translate
+ m_strGroup = aParts[0u];
+ for ( uint nPart = 1; nPart < nPartsCount; nPart++ ) {
+ if ( nPart > 1 )
+ m_strPath << PATH_SEP_REPLACE;
+ m_strPath << aParts[nPart];
+ }
+ }
+
+ // 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.Last() != PATH_SEP_REPLACE) );
+}
+
+const wxString& wxIniConfig::GetPath() const
+{
+ static wxString s_str;
+
+ // always return abs path
+ s_str = wxCONFIG_PATH_SEPARATOR;
+
+ if ( m_strGroup == PATH_SEP_REPLACE ) {
+ // we're at the root level, nothing to do
+ }
+ else {
+ s_str << m_strGroup;
+ if ( !m_strPath.IsEmpty() )
+ s_str << wxCONFIG_PATH_SEPARATOR;
+ for ( const char *p = m_strPath; *p != '\0'; p++ ) {
+ s_str << (*p == PATH_SEP_REPLACE ? wxCONFIG_PATH_SEPARATOR : *p);
+ }
+ }
+
+ return s_str;
+}
+
+wxString wxIniConfig::GetPrivateKeyName(const char *szKey) const
+{
+ wxString strKey;
+
+ if ( !m_strPath.IsEmpty() )
+ strKey << m_strPath << PATH_SEP_REPLACE;
+
+ strKey << szKey;
+
+ return strKey;
+}
+
+wxString wxIniConfig::GetKeyName(const char *szKey) const
+{
+ wxString strKey;
+
+ if ( m_strGroup != PATH_SEP_REPLACE )
+ strKey << m_strGroup << PATH_SEP_REPLACE;
+ if ( !m_strPath.IsEmpty() )
+ strKey << m_strPath << PATH_SEP_REPLACE;
+
+ strKey << szKey;
+
+ return strKey;
+}
+
+// ----------------------------------------------------------------------------
+// enumeration
+// ----------------------------------------------------------------------------
+
+// not implemented
+bool wxIniConfig::GetFirstGroup(wxString& str, long& lIndex) const
+{
+ wxFAIL_MSG("not implemented");
+
+ return FALSE;
+}
+
+bool wxIniConfig::GetNextGroup (wxString& str, long& lIndex) const
+{
+ wxFAIL_MSG("not implemented");
+
+ return FALSE;
+}
+
+bool wxIniConfig::GetFirstEntry(wxString& str, long& lIndex) const
+{
+ wxFAIL_MSG("not implemented");
+
+ return FALSE;
+}
+
+bool wxIniConfig::GetNextEntry (wxString& str, long& lIndex) const
+{
+ wxFAIL_MSG("not implemented");
+
+ return FALSE;
+}
+
+// ----------------------------------------------------------------------------
+// misc info
+// ----------------------------------------------------------------------------
+
+// not implemented
+uint wxIniConfig::GetNumberOfEntries(bool bRecursive) const
+{
+ wxFAIL_MSG("not implemented");
+
+ return (uint)-1;
+}
+
+uint wxIniConfig::GetNumberOfGroups(bool bRecursive) const
+{
+ wxFAIL_MSG("not implemented");
+
+ return (uint)-1;
+}
+
+bool wxIniConfig::HasGroup(const wxString& strName) const
+{
+ wxFAIL_MSG("not implemented");
+
+ return FALSE;
+}
+
+bool wxIniConfig::HasEntry(const wxString& strName) const
+{
+ wxFAIL_MSG("not implemented");
+
+ return FALSE;
+}
+
+// is current group empty?
+bool wxIniConfig::IsEmpty() const
+{
+ char szBuf[1024];
+
+ GetPrivateProfileString(m_strGroup, NULL, "",
+ szBuf, WXSIZEOF(szBuf), m_strAppName);
+ if ( !::IsEmpty(szBuf) )
+ return FALSE;
+
+ GetProfileString(m_strGroup, NULL, "", szBuf, WXSIZEOF(szBuf));
+ if ( !::IsEmpty(szBuf) )
+ return FALSE;
+
+ return TRUE;
+}
+
+// ----------------------------------------------------------------------------
+// read/write
+// ----------------------------------------------------------------------------
+
+bool wxIniConfig::Read(wxString *pstr,
+ const char *szKey,
+ const char *szDefault) const
+{
+ PathChanger 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_strAppName);
+ 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;
+ }
+}
+
+const char *wxIniConfig::Read(const char *szKey,
+ const char *szDefault) const
+{
+ static wxString s_str;
+ Read(&s_str, szKey, szDefault);
+
+ return s_str.c_str();
+}
+
+bool wxIniConfig::Read(long *pl, const char *szKey, long lDefault) const
+{
+ PathChanger path(this, szKey);
+ wxString strKey = GetPrivateKeyName(path.Name());
+
+ // hack: we have no mean to know if it really found the default value or
+ // didn't find anything, so we call it twice
+
+ 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);
+ if ( lVal != nMagic ) {
+ // the value was read from the file
+ *pl = lVal;
+ return TRUE;
+ }
+
+ // is it really nMagic?
+ lVal = GetPrivateProfileInt(m_strGroup, strKey, nMagic2, m_strAppName);
+ if ( lVal == nMagic ) {
+ // the nMagic it returned was indeed read from the file
+ *pl = lVal;
+ return TRUE;
+ }
+
+ // no, it was just returning the default value, so now look in win.ini
+ *pl = GetProfileInt(m_strVendor, GetKeyName(szKey), lDefault);
+
+ // we're not going to check here whether it read the default or not: it's
+ // not that important
+ return TRUE;
+}
+
+long wxIniConfig::Read(const char *szKey, long lDefault) const
+{
+ long lVal;
+ Read(&lVal, szKey, lDefault);
+
+ return lVal;
+}
+
+bool wxIniConfig::Write(const char *szKey, const char *szValue)
+{
+ PathChanger path(this, szKey);
+ wxString strKey = GetPrivateKeyName(path.Name());
+
+ bool bOk = WritePrivateProfileString(m_strGroup, strKey,
+ szValue, m_strAppName) != 0;
+
+ if ( !bOk )
+ wxLogLastError("WritePrivateProfileString");
+
+ return bOk;
+}
+
+bool wxIniConfig::Write(const char *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, szBuf);
+}
+
+bool wxIniConfig::Flush(bool /* bCurrentOnly */)
+{
+ // this is just the way it works
+ return WritePrivateProfileString(NULL, NULL, NULL, m_strAppName) != 0;
+}
+
+// ----------------------------------------------------------------------------
+// delete
+// ----------------------------------------------------------------------------
+
+bool wxIniConfig::DeleteEntry(const char *szKey, bool bGroupIfEmptyAlso)
+{
+ // passing NULL as value to WritePrivateProfileString deletes the key
+ if ( !Write(szKey, (const char *)NULL) )
+ return FALSE;
+
+ if ( !bGroupIfEmptyAlso || !IsEmpty() )
+ return TRUE;
+
+ // delete the current group too
+ bool bOk = WritePrivateProfileString(m_strGroup, NULL,
+ NULL, m_strAppName) != 0;
+
+ if ( !bOk )
+ wxLogLastError("WritePrivateProfileString");
+
+ return bOk;
+}
+
+bool wxIniConfig::DeleteGroup(const char *szKey)
+{
+ PathChanger path(this, szKey);
+
+ // 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;
+
+ if ( !bOk )
+ wxLogLastError("WritePrivateProfileString");
+
+ return bOk;
+}
+
+bool wxIniConfig::DeleteAll()
+{
+ // first delete our group in win.ini
+ WriteProfileString(m_strVendor, NULL, NULL);
+
+ // then delete our own ini file
+ char szBuf[MAX_PATH];
+ uint 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;
+ strFile << '\\' << m_strAppName;
+
+ if ( !DeleteFile(strFile) ) {
+ wxLogSysError(_("Can't delete the INI file '%s'"), strFile.c_str());
+ return FALSE;
+ }
+
+ return TRUE;
+}
projects / wxWidgets.git / commitdiff
