///////////////////////////////////////////////////////////////////////////////
-// Name: msw/registry.cpp
+// Name: src/msw/registry.cpp
// Purpose: implementation of registry classes and functions
// Author: Vadim Zeitlin
// Modified by:
// Created: 03.04.98
// RCS-ID: $Id$
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence: wxWindows license
+// Licence: wxWindows licence
// TODO: - parsing of registry key names
// - support of other (than REG_SZ/REG_DWORD) registry types
// - add high level functions (RegisterOleServer, ...)
///////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
-#pragma implementation "registry.h"
-#endif
-
// for compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#ifdef __BORLANDC__
-#pragma hdrstop
+ #pragma hdrstop
#endif
-// other wxWindows headers
-#include "wx/string.h"
-#include "wx/intl.h"
-#include "wx/log.h"
+#if wxUSE_REGKEY
-#ifndef __WIN16__
+#ifndef WX_PRECOMP
+ #include "wx/msw/wrapwin.h"
+ #include "wx/string.h"
+ #include "wx/intl.h"
+ #include "wx/log.h"
+ #include "wx/crt.h"
+#endif
-// Windows headers
-/*
-#define STRICT
-#define WIN32_LEAN_AND_MEAN
-*/
+#include "wx/file.h"
+#include "wx/wfstream.h"
-#include <windows.h>
+// Windows headers
+#ifdef __WXWINCE__
+#include "wx/msw/private.h"
+#include <winbase.h>
+#include <winreg.h>
+#endif
// other std headers
#include <stdlib.h> // for _MAX_PATH
// some registry functions don't like signed chars
typedef unsigned char *RegString;
+typedef BYTE* RegBinary;
+
+#ifndef HKEY_PERFORMANCE_DATA
+ #define HKEY_PERFORMANCE_DATA ((HKEY)0x80000004)
+#endif
+
+#ifndef HKEY_CURRENT_CONFIG
+ #define HKEY_CURRENT_CONFIG ((HKEY)0x80000005)
+#endif
+
+#ifndef HKEY_DYN_DATA
+ #define HKEY_DYN_DATA ((HKEY)0x80000006)
+#endif
// ----------------------------------------------------------------------------
// constants
aStdKeys[] =
{
{ HKEY_CLASSES_ROOT, wxT("HKEY_CLASSES_ROOT"), wxT("HKCR") },
-#ifdef __WIN32__
{ HKEY_CURRENT_USER, wxT("HKEY_CURRENT_USER"), wxT("HKCU") },
{ HKEY_LOCAL_MACHINE, wxT("HKEY_LOCAL_MACHINE"), wxT("HKLM") },
{ HKEY_USERS, wxT("HKEY_USERS"), wxT("HKU") }, // short name?
{ HKEY_PERFORMANCE_DATA, wxT("HKEY_PERFORMANCE_DATA"), wxT("HKPD") },
-#if WINVER >= 0x0400
{ HKEY_CURRENT_CONFIG, wxT("HKEY_CURRENT_CONFIG"), wxT("HKCC") },
-#ifndef __GNUWIN32__
{ HKEY_DYN_DATA, wxT("HKEY_DYN_DATA"), wxT("HKDD") }, // short name?
-#endif //GNUWIN32
-#endif //WINVER >= 4.0
-#endif //WIN32
};
// the registry name separator (perhaps one day MS will change it to '/' ;-)
// useful for Windows programmers: makes somewhat more clear all these zeroes
// being passed to Windows APIs
-#define RESERVED (NULL)
+#define RESERVED (0)
// ----------------------------------------------------------------------------
// macros
// removes the trailing backslash from the string if it has one
static inline void RemoveTrailingSeparator(wxString& str);
-// returns TRUE if given registry key exists
-static bool KeyExists(WXHKEY hRootKey, const wxChar *szKey);
+// returns true if given registry key exists
+static bool KeyExists(WXHKEY hRootKey, const wxString& szKey);
+
+// combines value and key name
+static wxString GetFullName(const wxRegKey *pKey);
+static wxString GetFullName(const wxRegKey *pKey, const wxString& szValue);
-// combines value and key name (uses static buffer!)
-static const wxChar *GetFullName(const wxRegKey *pKey,
- const wxChar *szValue = NULL);
+// returns "value" argument of wxRegKey methods converted into a value that can
+// be passed to win32 registry functions; specifically, converts empty string
+// to NULL
+static inline const wxChar *RegValueStr(const wxString& szValue);
// ============================================================================
// implementation of wxRegKey class
const wxChar *wxRegKey::GetStdKeyName(size_t key)
{
// return empty string if key is invalid
- wxCHECK_MSG( key < nStdKeys, wxT(""), wxT("invalid key in wxRegKey::GetStdKeyName") );
+ wxCHECK_MSG( key < nStdKeys, wxEmptyString, wxT("invalid key in wxRegKey::GetStdKeyName") );
return aStdKeys[key].szName;
}
const wxChar *wxRegKey::GetStdKeyShortName(size_t key)
{
// return empty string if key is invalid
- wxCHECK( key < nStdKeys, wxT("") );
+ wxCHECK( key < nStdKeys, wxEmptyString );
return aStdKeys[key].szShortName;
}
{
wxString strRoot = strKey.BeforeFirst(REG_SEPARATOR);
- HKEY hRootKey = 0;
size_t ui;
for ( ui = 0; ui < nStdKeys; ui++ ) {
if ( strRoot.CmpNoCase(aStdKeys[ui].szName) == 0 ||
strRoot.CmpNoCase(aStdKeys[ui].szShortName) == 0 ) {
- hRootKey = aStdKeys[ui].hkey;
break;
}
}
if ( ui == nStdKeys ) {
wxFAIL_MSG(wxT("invalid key prefix in wxRegKey::ExtractKeyName."));
- hRootKey = HKEY_CLASSES_ROOT;
+ ui = HKCR;
}
else {
strKey = strKey.After(REG_SEPARATOR);
- if ( !strKey.IsEmpty() && strKey.Last() == REG_SEPARATOR )
+ if ( !strKey.empty() && strKey.Last() == REG_SEPARATOR )
strKey.Truncate(strKey.Len() - 1);
}
- return (wxRegKey::StdKey)(int)hRootKey;
+ return (StdKey)ui;
}
wxRegKey::StdKey wxRegKey::GetStdKeyFromHkey(WXHKEY hkey)
{
for ( size_t ui = 0; ui < nStdKeys; ui++ ) {
- if ( (int) aStdKeys[ui].hkey == (int) hkey )
+ if ( aStdKeys[ui].hkey == (HKEY)hkey )
return (StdKey)ui;
}
: m_strKey(keyParent.m_strKey)
{
// combine our name with parent's to get the full name
- if ( !m_strKey.IsEmpty() &&
- (strKey.IsEmpty() || strKey[0] != REG_SEPARATOR) ) {
+ if ( !m_strKey.empty() &&
+ (strKey.empty() || strKey[0] != REG_SEPARATOR) ) {
m_strKey += REG_SEPARATOR;
}
// next line!
m_strKey.clear();
m_strKey += keyParent.m_strKey;
- if ( !strKey.IsEmpty() && strKey[0] != REG_SEPARATOR )
+ if ( !strKey.empty() && strKey[0] != REG_SEPARATOR )
m_strKey += REG_SEPARATOR;
m_strKey += strKey;
// info about the key
// ----------------------------------------------------------------------------
-// returns TRUE if the key exists
+// returns true if the key exists
bool wxRegKey::Exists() const
{
// opened key has to exist, try to open it if not done yet
- return IsOpened() ? TRUE : KeyExists(m_hRootKey, m_strKey);
+ return IsOpened() ? true : KeyExists(m_hRootKey, m_strKey.wx_str());
}
// returns the full name of the key (prefix is abbreviated if bShortPrefix)
wxString wxRegKey::GetName(bool bShortPrefix) const
{
- StdKey key = GetStdKeyFromHkey((StdKey) m_hRootKey);
+ StdKey key = GetStdKeyFromHkey((WXHKEY) m_hRootKey);
wxString str = bShortPrefix ? aStdKeys[key].szShortName
: aStdKeys[key].szName;
- if ( !m_strKey.IsEmpty() )
+ if ( !m_strKey.empty() )
str << _T("\\") << m_strKey;
return str;
size_t *pnValues,
size_t *pnMaxValueLen) const
{
-#if defined(__WIN32__) && !defined(__TWIN32__)
-
// old gcc headers incorrectly prototype RegQueryInfoKey()
#if defined(__GNUWIN32_OLD__) && !defined(__CYGWIN10__)
#define REG_PARAM (size_t *)
if ( m_dwLastError != ERROR_SUCCESS ) {
wxLogSysError(m_dwLastError, _("Can't get info about registry key '%s'"),
GetName().c_str());
- return FALSE;
+ return false;
}
- return TRUE;
-#else // Win16
- wxFAIL_MSG("GetKeyInfo() not implemented");
-
- return FALSE;
-#endif
+ return true;
}
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
// opens key (it's not an error to call Open() on an already opened key)
-bool wxRegKey::Open()
+bool wxRegKey::Open(AccessMode mode)
{
- if ( IsOpened() )
- return TRUE;
+ if ( IsOpened() )
+ {
+ if ( mode <= m_mode )
+ return true;
+
+ // we had been opened in read mode but now must be reopened in write
+ Close();
+ }
+
+ HKEY tmpKey;
+ m_dwLastError = ::RegOpenKeyEx
+ (
+ (HKEY) m_hRootKey,
+ m_strKey.wx_str(),
+ RESERVED,
+ mode == Read ? KEY_READ : KEY_ALL_ACCESS,
+ &tmpKey
+ );
+
+ if ( m_dwLastError != ERROR_SUCCESS )
+ {
+ wxLogSysError(m_dwLastError, _("Can't open registry key '%s'"),
+ GetName().c_str());
+ return false;
+ }
- HKEY tmpKey;
- m_dwLastError = RegOpenKey((HKEY) m_hRootKey, m_strKey, &tmpKey);
- if ( m_dwLastError != ERROR_SUCCESS ) {
- wxLogSysError(m_dwLastError, _("Can't open registry key '%s'"),
- GetName().c_str());
- return FALSE;
- }
- else
- {
m_hKey = (WXHKEY) tmpKey;
- return TRUE;
- }
+ m_mode = mode;
+
+ return true;
}
// creates key, failing if it exists and !bOkIfExists
bool wxRegKey::Create(bool bOkIfExists)
{
// check for existence only if asked (i.e. order is important!)
- if ( !bOkIfExists && Exists() ) {
- return FALSE;
- }
+ if ( !bOkIfExists && Exists() )
+ return false;
if ( IsOpened() )
- return TRUE;
+ return true;
HKEY tmpKey;
- m_dwLastError = RegCreateKey((HKEY) m_hRootKey, m_strKey, &tmpKey);
+#ifdef __WXWINCE__
+ DWORD disposition;
+ m_dwLastError = RegCreateKeyEx((HKEY) m_hRootKey, m_strKey.wx_str(),
+ NULL, // reserved
+ NULL, // class string
+ 0,
+ 0,
+ NULL,
+ &tmpKey,
+ &disposition);
+#else
+ m_dwLastError = RegCreateKey((HKEY) m_hRootKey, m_strKey.wx_str(), &tmpKey);
+#endif
if ( m_dwLastError != ERROR_SUCCESS ) {
wxLogSysError(m_dwLastError, _("Can't create registry key '%s'"),
GetName().c_str());
- return FALSE;
+ return false;
}
else
{
m_hKey = (WXHKEY) tmpKey;
- return TRUE;
+ return true;
}
}
wxLogSysError(m_dwLastError, _("Can't close registry key '%s'"),
GetName().c_str());
- return FALSE;
+ return false;
}
}
- return TRUE;
+ return true;
}
-bool wxRegKey::RenameValue(const wxChar *szValueOld, const wxChar *szValueNew)
+bool
+wxRegKey::RenameValue(const wxString& szValueOld, const wxString& szValueNew)
{
- bool ok = TRUE;
+ bool ok = true;
if ( HasValue(szValueNew) ) {
wxLogError(_("Registry value '%s' already exists."), szValueNew);
- ok = FALSE;
+ ok = false;
}
if ( !ok ||
wxLogError(_("Failed to rename registry value '%s' to '%s'."),
szValueOld, szValueNew);
- return FALSE;
+ return false;
}
- return TRUE;
+ return true;
}
-bool wxRegKey::CopyValue(const wxChar *szValue,
+bool wxRegKey::CopyValue(const wxString& szValue,
wxRegKey& keyDst,
- const wxChar *szValueNew)
+ const wxString& szValueNew)
{
- if ( !szValueNew ) {
+ wxString valueNew(szValueNew);
+ if ( valueNew.empty() ) {
// by default, use the same name
- szValueNew = szValue;
+ valueNew = szValue;
}
switch ( GetValueType(szValue) ) {
{
wxString strVal;
return QueryValue(szValue, strVal) &&
- keyDst.SetValue(szValueNew, strVal);
+ keyDst.SetValue(valueNew, strVal);
}
case Type_Dword:
{
long dwVal;
return QueryValue(szValue, &dwVal) &&
- keyDst.SetValue(szValueNew, dwVal);
+ keyDst.SetValue(valueNew, dwVal);
}
+ case Type_Binary:
+ {
+ wxMemoryBuffer buf;
+ return QueryValue(szValue,buf) &&
+ keyDst.SetValue(valueNew,buf);
+ }
+
// these types are unsupported because I am not sure about how
// exactly they should be copied and because they shouldn't
// occur among the application keys (supposedly created with
// this class)
-#ifdef __WIN32__
case Type_None:
case Type_Expand_String:
- case Type_Binary:
case Type_Dword_big_endian:
case Type_Link:
case Type_Multi_String:
case Type_Resource_list:
case Type_Full_resource_descriptor:
case Type_Resource_requirements_list:
-#endif // Win32
default:
wxLogError(_("Can't copy values of unsupported type %d."),
GetValueType(szValue));
- return FALSE;
+ return false;
}
}
-bool wxRegKey::Rename(const wxChar *szNewName)
+bool wxRegKey::Rename(const wxString& szNewName)
{
- wxCHECK_MSG( !!m_strKey, FALSE, _T("registry hives can't be renamed") );
+ wxCHECK_MSG( !m_strKey.empty(), false, _T("registry hives can't be renamed") );
if ( !Exists() ) {
wxLogError(_("Registry key '%s' does not exist, cannot rename it."),
GetFullName(this));
- return FALSE;
+ return false;
}
// do we stay in the same hive?
if ( inSameHive ) {
// rename the key to the new name under the same parent
wxString strKey = m_strKey.BeforeLast(REG_SEPARATOR);
- if ( !!strKey ) {
+ if ( !strKey.empty() ) {
// don't add '\\' in the start if strFullNewName is empty
strKey += REG_SEPARATOR;
}
keyDst.SetName(szNewName);
}
- bool ok = keyDst.Create(FALSE /* fail if alredy exists */);
+ bool ok = keyDst.Create(false /* fail if alredy exists */);
if ( !ok ) {
wxLogError(_("Registry key '%s' already exists."),
GetFullName(&keyDst));
return ok;
}
-bool wxRegKey::Copy(const wxChar *szNewName)
+bool wxRegKey::Copy(const wxString& szNewName)
{
// create the new key first
wxRegKey keyDst(szNewName);
- bool ok = keyDst.Create(FALSE /* fail if alredy exists */);
+ bool ok = keyDst.Create(false /* fail if alredy exists */);
if ( ok ) {
ok = Copy(keyDst);
bool wxRegKey::Copy(wxRegKey& keyDst)
{
- bool ok = TRUE;
+ bool ok = true;
// copy all sub keys to the new location
wxString strKey;
wxRegKey key(*this, strKey);
wxString keyName;
keyName << GetFullName(&keyDst) << REG_SEPARATOR << strKey;
- ok = key.Copy((const wxChar*) keyName);
+ ok = key.Copy(keyName);
if ( ok )
bCont = GetNextKey(strKey, lIndex);
+ else
+ wxLogError(_("Failed to copy the registry subkey '%s' to '%s'."),
+ GetFullName(&key), keyName.c_str());
+
}
// copy all values
}
if ( !ok ) {
- wxLogError(_("Failed to copy the contents of registry key '%s' to '%s'."), GetFullName(this), GetFullName(&keyDst));
+ wxLogError(_("Failed to copy the contents of registry key '%s' to '%s'."),
+ GetFullName(this), GetFullName(&keyDst));
}
return ok;
wxLogNull nolog;
if ( !Open() ) {
// it already doesn't exist - ok!
- return TRUE;
+ return true;
}
}
// prevent a buggy program from erasing one of the root registry keys or an
// immediate subkey (i.e. one which doesn't have '\\' inside) of any other
// key except HKCR (HKCR has some "deleteable" subkeys)
- if ( m_strKey.IsEmpty() ||
+ if ( m_strKey.empty() ||
((m_hRootKey != (WXHKEY) aStdKeys[HKCR].hkey) &&
(m_strKey.Find(REG_SEPARATOR) == wxNOT_FOUND)) ) {
- wxLogError(_("Registry key '%s' is needed for normal system operation,\ndeleting it will leave your system in unusable state:\noperation aborted."), GetFullName(this));
+ wxLogError(_("Registry key '%s' is needed for normal system operation,\ndeleting it will leave your system in unusable state:\noperation aborted."),
+ GetFullName(this));
- return FALSE;
+ return false;
}
// we can't delete keys while enumerating because it confuses GetNextKey, so
for ( size_t nKey = 0; nKey < nKeyCount; nKey++ ) {
wxRegKey key(*this, astrSubkeys[nKey]);
if ( !key.DeleteSelf() )
- return FALSE;
+ return false;
}
// now delete this key itself
Close();
- m_dwLastError = RegDeleteKey((HKEY) m_hRootKey, m_strKey);
- if ( m_dwLastError != ERROR_SUCCESS ) {
+ m_dwLastError = RegDeleteKey((HKEY) m_hRootKey, m_strKey.wx_str());
+ // deleting a key which doesn't exist is not considered an error
+ if ( m_dwLastError != ERROR_SUCCESS &&
+ m_dwLastError != ERROR_FILE_NOT_FOUND ) {
wxLogSysError(m_dwLastError, _("Can't delete key '%s'"),
GetName().c_str());
- return FALSE;
+ return false;
}
- return TRUE;
+ return true;
}
-bool wxRegKey::DeleteKey(const wxChar *szKey)
+bool wxRegKey::DeleteKey(const wxString& szKey)
{
if ( !Open() )
- return FALSE;
+ return false;
wxRegKey key(*this, szKey);
return key.DeleteSelf();
}
-bool wxRegKey::DeleteValue(const wxChar *szValue)
+bool wxRegKey::DeleteValue(const wxString& szValue)
{
- if ( !Open() )
- return FALSE;
-
-#if defined(__WIN32__) && !defined(__TWIN32__)
- m_dwLastError = RegDeleteValue((HKEY) m_hKey, WXSTRINGCAST szValue);
- if ( m_dwLastError != ERROR_SUCCESS ) {
- wxLogSysError(m_dwLastError, _("Can't delete value '%s' from key '%s'"),
- szValue, GetName().c_str());
- return FALSE;
+ if ( !Open() )
+ return false;
+
+ m_dwLastError = RegDeleteValue((HKEY) m_hKey, RegValueStr(szValue));
+
+ // deleting a value which doesn't exist is not considered an error
+ if ( (m_dwLastError != ERROR_SUCCESS) &&
+ (m_dwLastError != ERROR_FILE_NOT_FOUND) )
+ {
+ wxLogSysError(m_dwLastError, _("Can't delete value '%s' from key '%s'"),
+ szValue, GetName().c_str());
+ return false;
}
- #else //WIN16
- // named registry values don't exist in Win16 world
- wxASSERT( IsEmpty(szValue) );
- // just set the (default and unique) value of the key to ""
- m_dwLastError = RegSetValue((HKEY) m_hKey, NULL, REG_SZ, "", RESERVED);
- if ( m_dwLastError != ERROR_SUCCESS ) {
- wxLogSysError(m_dwLastError, _("Can't delete value of key '%s'"),
- GetName().c_str());
- return FALSE;
- }
- #endif //WIN16/32
-
- return TRUE;
+ return true;
}
// ----------------------------------------------------------------------------
// access to values and subkeys
// ----------------------------------------------------------------------------
-// return TRUE if value exists
-bool wxRegKey::HasValue(const wxChar *szValue) const
+// return true if value exists
+bool wxRegKey::HasValue(const wxString& szValue) const
{
- // this function should be silent, so suppress possible messages from Open()
- wxLogNull nolog;
+ // this function should be silent, so suppress possible messages from Open()
+ wxLogNull nolog;
- #ifdef __WIN32__
- if ( !CONST_CAST Open() )
- return FALSE;
+ if ( !CONST_CAST Open(Read) )
+ return false;
LONG dwRet = ::RegQueryValueEx((HKEY) m_hKey,
- WXSTRINGCAST szValue,
+ RegValueStr(szValue),
RESERVED,
NULL, NULL, NULL);
return dwRet == ERROR_SUCCESS;
- #else // WIN16
- // only unnamed value exists
- return IsEmpty(szValue);
- #endif // WIN16/32
}
-// returns TRUE if this key has any values
+// returns true if this key has any values
bool wxRegKey::HasValues() const
{
// suppress possible messages from GetFirstValue()
return CONST_CAST GetFirstValue(str, l);
}
-// returns TRUE if this key has any subkeys
+// returns true if this key has any subkeys
bool wxRegKey::HasSubkeys() const
{
// suppress possible messages from GetFirstKey()
return CONST_CAST GetFirstKey(str, l);
}
-// returns TRUE if given subkey exists
-bool wxRegKey::HasSubKey(const wxChar *szKey) const
+// returns true if given subkey exists
+bool wxRegKey::HasSubKey(const wxString& szKey) const
{
// this function should be silent, so suppress possible messages from Open()
wxLogNull nolog;
- if ( !CONST_CAST Open() )
- return FALSE;
+ if ( !CONST_CAST Open(Read) )
+ return false;
return KeyExists(m_hKey, szKey);
}
-wxRegKey::ValueType wxRegKey::GetValueType(const wxChar *szValue) const
+wxRegKey::ValueType wxRegKey::GetValueType(const wxString& szValue) const
{
- #ifdef __WIN32__
- if ( ! CONST_CAST Open() )
+ if ( ! CONST_CAST Open(Read) )
return Type_None;
DWORD dwType;
- m_dwLastError = RegQueryValueEx((HKEY) m_hKey, WXSTRINGCAST szValue, RESERVED,
+ m_dwLastError = RegQueryValueEx((HKEY) m_hKey, RegValueStr(szValue), RESERVED,
&dwType, NULL, NULL);
if ( m_dwLastError != ERROR_SUCCESS ) {
wxLogSysError(m_dwLastError, _("Can't read value of key '%s'"),
}
return (ValueType)dwType;
- #else //WIN16
- return IsEmpty(szValue) ? Type_String : Type_None;
- #endif //WIN16/32
}
-#ifdef __WIN32__
-bool wxRegKey::SetValue(const wxChar *szValue, long lValue)
+bool wxRegKey::SetValue(const wxString& szValue, long lValue)
{
-#ifdef __TWIN32__
- wxFAIL_MSG("RegSetValueEx not implemented by TWIN32");
- return FALSE;
-#else
if ( CONST_CAST Open() ) {
- m_dwLastError = RegSetValueEx((HKEY) m_hKey, szValue, (DWORD) RESERVED, REG_DWORD,
+ m_dwLastError = RegSetValueEx((HKEY) m_hKey, RegValueStr(szValue),
+ (DWORD) RESERVED, REG_DWORD,
(RegString)&lValue, sizeof(lValue));
if ( m_dwLastError == ERROR_SUCCESS )
- return TRUE;
+ return true;
}
wxLogSysError(m_dwLastError, _("Can't set value of '%s'"),
GetFullName(this, szValue));
- return FALSE;
-#endif
+ return false;
}
-bool wxRegKey::QueryValue(const wxChar *szValue, long *plValue) const
+bool wxRegKey::QueryValue(const wxString& szValue, long *plValue) const
{
- if ( CONST_CAST Open() ) {
+ if ( CONST_CAST Open(Read) ) {
DWORD dwType, dwSize = sizeof(DWORD);
RegString pBuf = (RegString)plValue;
- m_dwLastError = RegQueryValueEx((HKEY) m_hKey, WXSTRINGCAST szValue, RESERVED,
+ m_dwLastError = RegQueryValueEx((HKEY) m_hKey, RegValueStr(szValue),
+ RESERVED,
&dwType, pBuf, &dwSize);
if ( m_dwLastError != ERROR_SUCCESS ) {
wxLogSysError(m_dwLastError, _("Can't read value of key '%s'"),
GetName().c_str());
- return FALSE;
+ return false;
}
else {
// check that we read the value of right type
wxASSERT_MSG( IsNumericValue(szValue),
wxT("Type mismatch in wxRegKey::QueryValue().") );
- return TRUE;
+ return true;
}
}
else
- return FALSE;
+ return false;
}
-#endif //Win32
-
-bool wxRegKey::QueryValue(const wxChar *szValue,
- wxString& strValue,
- bool raw) const
+bool wxRegKey::SetValue(const wxString& szValue, const wxMemoryBuffer& buffer)
{
+#ifdef __TWIN32__
+ wxFAIL_MSG("RegSetValueEx not implemented by TWIN32");
+ return false;
+#else
if ( CONST_CAST Open() ) {
- #ifdef __WIN32__
- // first get the type and size of the data
- DWORD dwType, dwSize;
- m_dwLastError = RegQueryValueEx((HKEY) m_hKey, WXSTRINGCAST szValue, RESERVED,
- &dwType, NULL, &dwSize);
- if ( m_dwLastError == ERROR_SUCCESS ) {
- if ( !dwSize ) {
- // must treat this case specially as GetWriteBuf() doesn't like
- // being called with 0 size
- strValue.Empty();
- }
- else {
- RegString pBuf = (RegString)strValue.GetWriteBuf(dwSize);
+ m_dwLastError = RegSetValueEx((HKEY) m_hKey, RegValueStr(szValue),
+ (DWORD) RESERVED, REG_BINARY,
+ (RegBinary)buffer.GetData(),buffer.GetDataLen());
+ if ( m_dwLastError == ERROR_SUCCESS )
+ return true;
+ }
+
+ wxLogSysError(m_dwLastError, _("Can't set value of '%s'"),
+ GetFullName(this, szValue));
+ return false;
+#endif
+}
+
+bool wxRegKey::QueryValue(const wxString& szValue, wxMemoryBuffer& buffer) const
+{
+ if ( CONST_CAST Open(Read) ) {
+ // first get the type and size of the data
+ DWORD dwType, dwSize;
+ m_dwLastError = RegQueryValueEx((HKEY) m_hKey, RegValueStr(szValue),
+ RESERVED,
+ &dwType, NULL, &dwSize);
+
+ if ( m_dwLastError == ERROR_SUCCESS ) {
+ if ( dwSize ) {
+ const RegBinary pBuf = (RegBinary)buffer.GetWriteBuf(dwSize);
m_dwLastError = RegQueryValueEx((HKEY) m_hKey,
- WXSTRINGCAST szValue,
+ RegValueStr(szValue),
RESERVED,
&dwType,
pBuf,
&dwSize);
- strValue.UngetWriteBuf();
+ buffer.UngetWriteBuf(dwSize);
+ } else {
+ buffer.SetDataLen(0);
+ }
+ }
+
+
+ if ( m_dwLastError != ERROR_SUCCESS ) {
+ wxLogSysError(m_dwLastError, _("Can't read value of key '%s'"),
+ GetName().c_str());
+ return false;
+ }
+ return true;
+ }
+ return false;
+}
- // expand the var expansions in the string unless disabled
- if ( (dwType == REG_EXPAND_SZ) && !raw )
- {
- DWORD dwExpSize = ::ExpandEnvironmentStrings(strValue, NULL, 0);
- bool ok = dwExpSize != 0;
- if ( ok )
- {
- wxString strExpValue;
- ok = ::ExpandEnvironmentStrings
- (
- strValue,
- strExpValue.GetWriteBuf(dwExpSize),
- dwExpSize
- ) != 0;
- strExpValue.UngetWriteBuf();
- strValue = strExpValue;
- }
- if ( !ok )
+
+bool wxRegKey::QueryValue(const wxString& szValue,
+ wxString& strValue,
+ bool WXUNUSED_IN_WINCE(raw)) const
+{
+ if ( CONST_CAST Open(Read) )
+ {
+
+ // first get the type and size of the data
+ DWORD dwType=REG_NONE, dwSize=0;
+ m_dwLastError = RegQueryValueEx((HKEY) m_hKey,
+ RegValueStr(szValue),
+ RESERVED,
+ &dwType, NULL, &dwSize);
+ if ( m_dwLastError == ERROR_SUCCESS )
+ {
+ if ( !dwSize )
+ {
+ // must treat this case specially as GetWriteBuf() doesn't like
+ // being called with 0 size
+ strValue.Empty();
+ }
+ else
+ {
+ m_dwLastError = RegQueryValueEx((HKEY) m_hKey,
+ RegValueStr(szValue),
+ RESERVED,
+ &dwType,
+ (RegString)(wxChar*)wxStringBuffer(strValue, dwSize),
+ &dwSize);
+
+ // expand the var expansions in the string unless disabled
+#ifndef __WXWINCE__
+ if ( (dwType == REG_EXPAND_SZ) && !raw )
{
- wxLogLastError(_T("ExpandEnvironmentStrings"));
+ DWORD dwExpSize = ::ExpandEnvironmentStrings(strValue.wx_str(), NULL, 0);
+ bool ok = dwExpSize != 0;
+ if ( ok )
+ {
+ wxString strExpValue;
+ ok = ::ExpandEnvironmentStrings(strValue.wx_str(),
+ wxStringBuffer(strExpValue, dwExpSize),
+ dwExpSize
+ ) != 0;
+ strValue = strExpValue;
+ }
+
+ if ( !ok )
+ {
+ wxLogLastError(_T("ExpandEnvironmentStrings"));
+ }
}
+#endif
+ // __WXWINCE__
}
- }
- if ( m_dwLastError == ERROR_SUCCESS ) {
- // check that it was the right type
- wxASSERT_MSG( !IsNumericValue(szValue),
- wxT("Type mismatch in wxRegKey::QueryValue().") );
+ if ( m_dwLastError == ERROR_SUCCESS )
+ {
+ // check that it was the right type
+ wxASSERT_MSG( !IsNumericValue(szValue),
+ wxT("Type mismatch in wxRegKey::QueryValue().") );
- return TRUE;
+ return true;
+ }
}
- }
- #else //WIN16
- // named registry values don't exist in Win16
- wxASSERT( IsEmpty(szValue) );
-
- m_dwLastError = RegQueryValue((HKEY) m_hKey, 0, strValue.GetWriteBuf(256), &l);
- strValue.UngetWriteBuf();
- if ( m_dwLastError == ERROR_SUCCESS )
- return TRUE;
- #endif //WIN16/32
- }
+ }
- wxLogSysError(m_dwLastError, _("Can't read value of '%s'"),
- GetFullName(this, szValue));
- return FALSE;
+ wxLogSysError(m_dwLastError, _("Can't read value of '%s'"),
+ GetFullName(this, szValue));
+ return false;
}
-bool wxRegKey::SetValue(const wxChar *szValue, const wxString& strValue)
+bool wxRegKey::SetValue(const wxString& szValue, const wxString& strValue)
{
if ( CONST_CAST Open() ) {
-#if defined( __WIN32__) && !defined(__TWIN32__)
- m_dwLastError = RegSetValueEx((HKEY) m_hKey, szValue, (DWORD) RESERVED, REG_SZ,
- (RegString)strValue.c_str(),
+ m_dwLastError = RegSetValueEx((HKEY) m_hKey,
+ RegValueStr(szValue),
+ (DWORD) RESERVED, REG_SZ,
+ (RegString)strValue.wx_str(),
(strValue.Len() + 1)*sizeof(wxChar));
if ( m_dwLastError == ERROR_SUCCESS )
- return TRUE;
- #else //WIN16
- // named registry values don't exist in Win16
- wxASSERT( IsEmpty(szValue) );
-
- m_dwLastError = RegSetValue((HKEY) m_hKey, NULL, REG_SZ, strValue, NULL);
- if ( m_dwLastError == ERROR_SUCCESS )
- return TRUE;
- #endif //WIN16/32
+ return true;
}
wxLogSysError(m_dwLastError, _("Can't set value of '%s'"),
GetFullName(this, szValue));
- return FALSE;
+ return false;
}
wxString wxRegKey::QueryDefaultValue() const
{
wxString str;
- QueryValue(NULL, str);
+ QueryValue(wxEmptyString, str, false);
return str;
}
bool wxRegKey::GetFirstValue(wxString& strValueName, long& lIndex)
{
- if ( !Open() )
- return FALSE;
+ if ( !Open(Read) )
+ return false;
lIndex = 0;
return GetNextValue(strValueName, lIndex);
// are we already at the end of enumeration?
if ( lIndex == -1 )
- return FALSE;
+ return false;
-#if defined( __WIN32__) && !defined(__TWIN32__)
wxChar szValueName[1024]; // @@ use RegQueryInfoKey...
DWORD dwValueLen = WXSIZEOF(szValueName);
GetName().c_str());
}
- return FALSE;
+ return false;
}
strValueName = szValueName;
- #else //WIN16
- // only one unnamed value
- wxASSERT( lIndex == 0 );
-
- lIndex = -1;
- strValueName.Empty();
- #endif
- return TRUE;
+ return true;
}
bool wxRegKey::GetFirstKey(wxString& strKeyName, long& lIndex)
{
- if ( !Open() )
- return FALSE;
+ if ( !Open(Read) )
+ return false;
lIndex = 0;
return GetNextKey(strKeyName, lIndex);
// are we already at the end of enumeration?
if ( lIndex == -1 )
- return FALSE;
+ return false;
wxChar szKeyName[_MAX_PATH + 1];
+
+#ifdef __WXWINCE__
+ DWORD sizeName = WXSIZEOF(szKeyName);
+ m_dwLastError = RegEnumKeyEx((HKEY) m_hKey, lIndex++, szKeyName, & sizeName,
+ 0, NULL, NULL, NULL);
+#else
m_dwLastError = RegEnumKey((HKEY) m_hKey, lIndex++, szKeyName, WXSIZEOF(szKeyName));
+#endif
if ( m_dwLastError != ERROR_SUCCESS ) {
if ( m_dwLastError == ERROR_NO_MORE_ITEMS ) {
GetName().c_str());
}
- return FALSE;
+ return false;
}
strKeyName = szKeyName;
- return TRUE;
+ return true;
}
-// returns TRUE if the value contains a number (else it's some string)
-bool wxRegKey::IsNumericValue(const wxChar *szValue) const
- {
- ValueType type = GetValueType(szValue);
- switch ( type ) {
+// returns true if the value contains a number (else it's some string)
+bool wxRegKey::IsNumericValue(const wxString& szValue) const
+{
+ ValueType type = GetValueType(szValue);
+ switch ( type ) {
case Type_Dword:
/* case Type_Dword_little_endian: == Type_Dword */
case Type_Dword_big_endian:
- return TRUE;
+ return true;
default:
- return FALSE;
- }
- }
+ return false;
+ }
+}
+
+// ----------------------------------------------------------------------------
+// exporting registry keys to file
+// ----------------------------------------------------------------------------
+
+#if wxUSE_STREAMS
+
+// helper functions for writing ASCII strings (even in Unicode build)
+static inline bool WriteAsciiChar(wxOutputStream& ostr, char ch)
+{
+ ostr.PutC(ch);
+ return ostr.IsOk();
+}
+
+static inline bool WriteAsciiEOL(wxOutputStream& ostr)
+{
+ // as we open the file in text mode, it is enough to write LF without CR
+ return WriteAsciiChar(ostr, '\n');
+}
+
+static inline bool WriteAsciiString(wxOutputStream& ostr, const char *p)
+{
+ return ostr.Write(p, strlen(p)).IsOk();
+}
+
+static inline bool WriteAsciiString(wxOutputStream& ostr, const wxString& s)
+{
+#if wxUSE_UNICODE
+ wxCharBuffer name(s.mb_str());
+ ostr.Write(name, strlen(name));
+#else
+ ostr.Write(s.mb_str(), s.length());
+#endif
+
+ return ostr.IsOk();
+}
+
+#endif // wxUSE_STREAMS
+
+bool wxRegKey::Export(const wxString& filename) const
+{
+#if wxUSE_FFILE && wxUSE_STREAMS
+ if ( wxFile::Exists(filename) )
+ {
+ wxLogError(_("Exporting registry key: file \"%s\" already exists and won't be overwritten."),
+ filename.c_str());
+ return false;
+ }
+
+ wxFFileOutputStream ostr(filename, _T("w"));
+
+ return ostr.Ok() && Export(ostr);
+#else
+ wxUnusedVar(filename);
+ return false;
+#endif
+}
+
+#if wxUSE_STREAMS
+bool wxRegKey::Export(wxOutputStream& ostr) const
+{
+ // write out the header
+ if ( !WriteAsciiString(ostr, "REGEDIT4\n\n") )
+ return false;
+
+ return DoExport(ostr);
+}
+#endif // wxUSE_STREAMS
+
+static
+wxString
+FormatAsHex(const void *data,
+ size_t size,
+ wxRegKey::ValueType type = wxRegKey::Type_Binary)
+{
+ wxString value(_T("hex"));
+
+ // binary values use just "hex:" prefix while the other ones must indicate
+ // the real type
+ if ( type != wxRegKey::Type_Binary )
+ value << _T('(') << type << _T(')');
+ value << _T(':');
+
+ // write all the rest as comma-separated bytes
+ value.reserve(3*size + 10);
+ const char * const p = wx_static_cast(const char *, data);
+ for ( size_t n = 0; n < size; n++ )
+ {
+ // TODO: line wrapping: although not required by regedit, this makes
+ // the generated files easier to read and compare with the files
+ // produced by regedit
+ if ( n )
+ value << _T(',');
+
+ value << wxString::Format(_T("%02x"), (unsigned char)p[n]);
+ }
+
+ return value;
+}
+
+static inline
+wxString FormatAsHex(const wxString& value, wxRegKey::ValueType type)
+{
+ return FormatAsHex(value.c_str(), value.length() + 1, type);
+}
+
+wxString wxRegKey::FormatValue(const wxString& name) const
+{
+ wxString rhs;
+ const ValueType type = GetValueType(name);
+ switch ( type )
+ {
+ case Type_String:
+ {
+ wxString value;
+ if ( !QueryValue(name, value) )
+ break;
+
+ // quotes and backslashes must be quoted, linefeeds are not
+ // allowed in string values
+ rhs.reserve(value.length() + 2);
+ rhs = _T('"');
+
+ // there can be no NULs here
+ bool useHex = false;
+ for ( wxString::const_iterator p = value.begin();
+ p != value.end() && !useHex; ++p )
+ {
+ switch ( (*p).GetValue() )
+ {
+ case _T('\n'):
+ // we can only represent this string in hex
+ useHex = true;
+ break;
+
+ case _T('"'):
+ case _T('\\'):
+ // escape special symbol
+ rhs += _T('\\');
+ // fall through
+
+ default:
+ rhs += *p;
+ }
+ }
+
+ if ( useHex )
+ rhs = FormatAsHex(value, Type_String);
+ else
+ rhs += _T('"');
+ }
+ break;
+
+ case Type_Dword:
+ /* case Type_Dword_little_endian: == Type_Dword */
+ {
+ long value;
+ if ( !QueryValue(name, &value) )
+ break;
+
+ rhs.Printf(_T("dword:%08x"), (unsigned int)value);
+ }
+ break;
+
+ case Type_Expand_String:
+ case Type_Multi_String:
+ {
+ wxString value;
+ if ( !QueryRawValue(name, value) )
+ break;
+
+ rhs = FormatAsHex(value, type);
+ }
+ break;
+
+ case Type_Binary:
+ {
+ wxMemoryBuffer buf;
+ if ( !QueryValue(name, buf) )
+ break;
+
+ rhs = FormatAsHex(buf.GetData(), buf.GetDataLen());
+ }
+ break;
+
+ // no idea how those appear in REGEDIT4 files
+ case Type_None:
+ case Type_Dword_big_endian:
+ case Type_Link:
+ case Type_Resource_list:
+ case Type_Full_resource_descriptor:
+ case Type_Resource_requirements_list:
+ default:
+ wxLogWarning(_("Can't export value of unsupported type %d."), type);
+ }
+
+ return rhs;
+}
+
+#if wxUSE_STREAMS
+
+bool wxRegKey::DoExportValue(wxOutputStream& ostr, const wxString& name) const
+{
+ // first examine the value type: if it's unsupported, simply skip it
+ // instead of aborting the entire export process because we failed to
+ // export a single value
+ wxString value = FormatValue(name);
+ if ( value.empty() )
+ {
+ wxLogWarning(_("Ignoring value \"%s\" of the key \"%s\"."),
+ name.c_str(), GetName().c_str());
+ return true;
+ }
+
+ // we do have the text representation of the value, now write everything
+ // out
+
+ // special case: unnamed/default value is represented as just "@"
+ if ( name.empty() )
+ {
+ if ( !WriteAsciiChar(ostr, '@') )
+ return false;
+ }
+ else // normal, named, value
+ {
+ if ( !WriteAsciiChar(ostr, '"') ||
+ !WriteAsciiString(ostr, name) ||
+ !WriteAsciiChar(ostr, '"') )
+ return false;
+ }
+
+ if ( !WriteAsciiChar(ostr, '=') )
+ return false;
+
+ return WriteAsciiString(ostr, value) && WriteAsciiEOL(ostr);
+}
+
+bool wxRegKey::DoExport(wxOutputStream& ostr) const
+{
+ // write out this key name
+ if ( !WriteAsciiChar(ostr, '[') )
+ return false;
+
+ if ( !WriteAsciiString(ostr, GetName(false /* no short prefix */)) )
+ return false;
+
+ if ( !WriteAsciiChar(ostr, ']') || !WriteAsciiEOL(ostr) )
+ return false;
+
+ // dump all our values
+ long dummy;
+ wxString name;
+ wxRegKey& self = wx_const_cast(wxRegKey&, *this);
+ bool cont = self.GetFirstValue(name, dummy);
+ while ( cont )
+ {
+ if ( !DoExportValue(ostr, name) )
+ return false;
+
+ cont = GetNextValue(name, dummy);
+ }
+
+ // always terminate values by blank line, even if there were no values
+ if ( !WriteAsciiEOL(ostr) )
+ return false;
+
+ // recurse to subkeys
+ cont = self.GetFirstKey(name, dummy);
+ while ( cont )
+ {
+ wxRegKey subkey(*this, name);
+ if ( !subkey.DoExport(ostr) )
+ return false;
+
+ cont = GetNextKey(name, dummy);
+ }
+
+ return true;
+}
+
+#endif // wxUSE_STREAMS
// ============================================================================
// implementation of global private functions
// ============================================================================
-bool KeyExists(WXHKEY hRootKey, const wxChar *szKey)
+bool KeyExists(WXHKEY hRootKey, const wxString& szKey)
{
- // don't close this key itself for the case of empty szKey!
- if ( wxIsEmpty(szKey) )
- return TRUE;
-
- HKEY hkeyDummy;
- if ( RegOpenKey( (HKEY) hRootKey, szKey, &hkeyDummy) == ERROR_SUCCESS ) {
- RegCloseKey(hkeyDummy);
- return TRUE;
- }
- else
- return FALSE;
+ // don't close this key itself for the case of empty szKey!
+ if ( szKey.empty() )
+ return true;
+
+ HKEY hkeyDummy;
+ if ( ::RegOpenKeyEx
+ (
+ (HKEY)hRootKey,
+ szKey.wx_str(),
+ RESERVED,
+ KEY_READ, // we might not have enough rights for rw access
+ &hkeyDummy
+ ) == ERROR_SUCCESS )
+ {
+ ::RegCloseKey(hkeyDummy);
+
+ return true;
+ }
+
+ return false;
}
-const wxChar *GetFullName(const wxRegKey *pKey, const wxChar *szValue)
+wxString GetFullName(const wxRegKey *pKey, const wxString& szValue)
{
- static wxString s_str;
- s_str = pKey->GetName();
- if ( !wxIsEmpty(szValue) )
- s_str << wxT("\\") << szValue;
+ wxString str(pKey->GetName());
+ if ( !szValue.empty() )
+ str << wxT("\\") << szValue;
- return s_str.c_str();
+ return str;
}
-void RemoveTrailingSeparator(wxString& str)
+wxString GetFullName(const wxRegKey *pKey)
{
- if ( !str.IsEmpty() && str.Last() == REG_SEPARATOR )
+ return pKey->GetName();
+}
+
+inline void RemoveTrailingSeparator(wxString& str)
+{
+ if ( !str.empty() && str.Last() == REG_SEPARATOR )
str.Truncate(str.Len() - 1);
}
-#endif
- // __WIN16__
+inline const wxChar *RegValueStr(const wxString& szValue)
+{
+ return szValue.empty() ? (const wxChar*)NULL : szValue.wx_str();
+}
+#endif // wxUSE_REGKEY
projects / wxWidgets.git / blobdiff