3f66f6a5b3
This keyword is not expanded by Git which means it's not replaced with the correct revision value in the releases made using git-based scripts and it's confusing to have lines with unexpanded "$Id$" in the released files. As expanding them with Git is not that simple (it could be done with git archive and export-subst attribute) and there are not many benefits in having them in the first place, just remove all these lines. If nothing else, this will make an eventual transition to Git simpler. Closes #14487. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74602 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
480 lines
13 KiB
C++
480 lines
13 KiB
C++
///////////////////////////////////////////////////////////////////////////////
|
|
// Name: src/msw/iniconf.cpp
|
|
// Purpose: implementation of wxIniConfig class
|
|
// Author: Vadim Zeitlin
|
|
// Modified by:
|
|
// Created: 27.07.98
|
|
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
|
|
// Licence: wxWindows licence
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
// For compilers that support precompilation, includes "wx.h".
|
|
#include "wx/wxprec.h"
|
|
|
|
#ifdef __BORLANDC__
|
|
#pragma hdrstop
|
|
#endif
|
|
|
|
#if wxUSE_INICONF
|
|
|
|
#ifndef WX_PRECOMP
|
|
#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/config.h"
|
|
#include "wx/file.h"
|
|
|
|
#include "wx/msw/iniconf.h"
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// constants
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// we replace all path separators with this character
|
|
#define PATH_SEP_REPLACE '_'
|
|
|
|
// ============================================================================
|
|
// implementation
|
|
// ============================================================================
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// ctor & dtor
|
|
// ----------------------------------------------------------------------------
|
|
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 (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");
|
|
}
|
|
|
|
// 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()
|
|
{
|
|
}
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// path management
|
|
// ----------------------------------------------------------------------------
|
|
|
|
void wxIniConfig::SetPath(const wxString& strPath)
|
|
{
|
|
wxArrayString aParts;
|
|
|
|
if ( strPath.empty() ) {
|
|
// 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);
|
|
}
|
|
|
|
size_t 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 ( size_t 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.empty() || m_strPath.Last() != PATH_SEP_REPLACE) &&
|
|
(m_strGroup == wxString(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 == wxString(PATH_SEP_REPLACE) ) {
|
|
// we're at the root level, nothing to do
|
|
}
|
|
else {
|
|
s_str << m_strGroup;
|
|
if ( !m_strPath.empty() )
|
|
s_str << wxCONFIG_PATH_SEPARATOR;
|
|
for ( const wxStringCharType *p = m_strPath.wx_str(); *p != '\0'; p++ ) {
|
|
s_str << (*p == PATH_SEP_REPLACE ? wxCONFIG_PATH_SEPARATOR : *p);
|
|
}
|
|
}
|
|
|
|
return s_str;
|
|
}
|
|
|
|
wxString wxIniConfig::GetPrivateKeyName(const wxString& szKey) const
|
|
{
|
|
wxString strKey;
|
|
|
|
if ( !m_strPath.empty() )
|
|
strKey << m_strPath << PATH_SEP_REPLACE;
|
|
|
|
strKey << szKey;
|
|
|
|
return strKey;
|
|
}
|
|
|
|
wxString wxIniConfig::GetKeyName(const wxString& szKey) const
|
|
{
|
|
wxString strKey;
|
|
|
|
if ( m_strGroup != wxString(PATH_SEP_REPLACE) )
|
|
strKey << m_strGroup << PATH_SEP_REPLACE;
|
|
if ( !m_strPath.empty() )
|
|
strKey << m_strPath << PATH_SEP_REPLACE;
|
|
|
|
strKey << szKey;
|
|
|
|
return strKey;
|
|
}
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// enumeration
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// not implemented
|
|
bool wxIniConfig::GetFirstGroup(wxString& WXUNUSED(str), long& WXUNUSED(lIndex)) const
|
|
{
|
|
wxFAIL_MSG("not implemented");
|
|
|
|
return false;
|
|
}
|
|
|
|
bool wxIniConfig::GetNextGroup (wxString& WXUNUSED(str), long& WXUNUSED(lIndex)) const
|
|
{
|
|
wxFAIL_MSG("not implemented");
|
|
|
|
return false;
|
|
}
|
|
|
|
bool wxIniConfig::GetFirstEntry(wxString& WXUNUSED(str), long& WXUNUSED(lIndex)) const
|
|
{
|
|
wxFAIL_MSG("not implemented");
|
|
|
|
return false;
|
|
}
|
|
|
|
bool wxIniConfig::GetNextEntry (wxString& WXUNUSED(str), long& WXUNUSED(lIndex)) const
|
|
{
|
|
wxFAIL_MSG("not implemented");
|
|
|
|
return false;
|
|
}
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// misc info
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// not implemented
|
|
size_t wxIniConfig::GetNumberOfEntries(bool WXUNUSED(bRecursive)) const
|
|
{
|
|
wxFAIL_MSG("not implemented");
|
|
|
|
return (size_t)-1;
|
|
}
|
|
|
|
size_t wxIniConfig::GetNumberOfGroups(bool WXUNUSED(bRecursive)) const
|
|
{
|
|
wxFAIL_MSG("not implemented");
|
|
|
|
return (size_t)-1;
|
|
}
|
|
|
|
bool wxIniConfig::HasGroup(const wxString& WXUNUSED(strName)) const
|
|
{
|
|
wxFAIL_MSG("not implemented");
|
|
|
|
return false;
|
|
}
|
|
|
|
bool wxIniConfig::HasEntry(const wxString& WXUNUSED(strName)) const
|
|
{
|
|
wxFAIL_MSG("not implemented");
|
|
|
|
return false;
|
|
}
|
|
|
|
// is current group empty?
|
|
bool wxIniConfig::IsEmpty() const
|
|
{
|
|
wxChar szBuf[1024];
|
|
|
|
GetPrivateProfileString(m_strGroup.t_str(), NULL, wxT(""),
|
|
szBuf, WXSIZEOF(szBuf),
|
|
m_strLocalFilename.t_str());
|
|
if ( !wxIsEmpty(szBuf) )
|
|
return false;
|
|
|
|
GetProfileString(m_strGroup.t_str(), NULL, wxT(""), szBuf, WXSIZEOF(szBuf));
|
|
if ( !wxIsEmpty(szBuf) )
|
|
return false;
|
|
|
|
return true;
|
|
}
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// read/write
|
|
// ----------------------------------------------------------------------------
|
|
|
|
bool wxIniConfig::DoReadString(const wxString& szKey, wxString *pstr) const
|
|
{
|
|
wxConfigPathChanger path(this, szKey);
|
|
wxString strKey = GetPrivateKeyName(path.Name());
|
|
|
|
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.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.t_str(), strKey.t_str(),
|
|
wxT(""), szBuf, WXSIZEOF(szBuf));
|
|
}
|
|
|
|
if ( wxIsEmpty(szBuf) )
|
|
return false;
|
|
|
|
*pstr = szBuf;
|
|
return true;
|
|
}
|
|
|
|
bool wxIniConfig::DoReadLong(const wxString& szKey, long *pl) const
|
|
{
|
|
wxConfigPathChanger 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.t_str(), strKey.t_str(),
|
|
nMagic, m_strLocalFilename.t_str());
|
|
if ( lVal != nMagic ) {
|
|
// the value was read from the file
|
|
*pl = lVal;
|
|
return true;
|
|
}
|
|
|
|
// is it really 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;
|
|
}
|
|
|
|
// 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(GetVendorName(), GetKeyName(szKey), *pl);
|
|
|
|
return true;
|
|
#endif
|
|
return false ;
|
|
}
|
|
|
|
bool wxIniConfig::DoWriteString(const wxString& szKey, const wxString& szValue)
|
|
{
|
|
wxConfigPathChanger path(this, szKey);
|
|
wxString strKey = GetPrivateKeyName(path.Name());
|
|
|
|
bool bOk = WritePrivateProfileString(m_strGroup.t_str(), strKey.t_str(),
|
|
szValue.t_str(),
|
|
m_strLocalFilename.t_str()) != 0;
|
|
|
|
if ( !bOk )
|
|
{
|
|
wxLogLastError(wxT("WritePrivateProfileString"));
|
|
}
|
|
|
|
return bOk;
|
|
}
|
|
|
|
bool wxIniConfig::DoWriteLong(const wxString& szKey, long 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 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_strLocalFilename.t_str()) != 0;
|
|
}
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// delete
|
|
// ----------------------------------------------------------------------------
|
|
|
|
bool wxIniConfig::DeleteEntry(const wxString& szKey, bool bGroupIfEmptyAlso)
|
|
{
|
|
// passing NULL as value to WritePrivateProfileString deletes the key
|
|
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;
|
|
|
|
// delete the current group too
|
|
bool bOk = WritePrivateProfileString(m_strGroup.t_str(), NULL,
|
|
NULL, m_strLocalFilename.t_str()) != 0;
|
|
|
|
if ( !bOk )
|
|
{
|
|
wxLogLastError(wxT("WritePrivateProfileString"));
|
|
}
|
|
|
|
return bOk;
|
|
}
|
|
|
|
bool wxIniConfig::DeleteGroup(const wxString& 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().t_str(), NULL,
|
|
NULL, m_strLocalFilename.t_str()) != 0;
|
|
|
|
if ( !bOk )
|
|
{
|
|
wxLogLastError(wxT("WritePrivateProfileString"));
|
|
}
|
|
|
|
return bOk;
|
|
}
|
|
|
|
#ifndef MAX_PATH
|
|
#define MAX_PATH 256
|
|
#endif
|
|
|
|
bool wxIniConfig::DeleteAll()
|
|
{
|
|
// first delete our group in win.ini
|
|
WriteProfileString(GetVendorName().t_str(), NULL, NULL);
|
|
|
|
// then delete our own ini file
|
|
wxChar szBuf[MAX_PATH];
|
|
size_t nRc = GetWindowsDirectory(szBuf, WXSIZEOF(szBuf));
|
|
if ( nRc == 0 )
|
|
{
|
|
wxLogLastError(wxT("GetWindowsDirectory"));
|
|
}
|
|
else if ( nRc > WXSIZEOF(szBuf) )
|
|
{
|
|
wxFAIL_MSG(wxT("buffer is too small for Windows directory."));
|
|
}
|
|
|
|
wxString strFile = szBuf;
|
|
strFile << '\\' << m_strLocalFilename;
|
|
|
|
if ( wxFile::Exists(strFile) && !wxRemoveFile(strFile) ) {
|
|
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_INICONF
|