///////////////////////////////////////////////////////////////////////////////
-// Name: msw/registry.cpp
+// Name: src/msw/registry.cpp
// Purpose: implementation of registry classes and functions
// Author: Vadim Zeitlin
-// Modified by:
+// 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, ...)
///////////////////////////////////////////////////////////////////////////////
-// ============================================================================
-// declarations
-// ============================================================================
-
-// ----------------------------------------------------------------------------
-// headers
-// ----------------------------------------------------------------------------
-
// 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 WX_PRECOMP
+ #include "wx/msw/wrapwin.h"
+ #include "wx/string.h"
+ #include "wx/intl.h"
+ #include "wx/log.h"
+ #include "wx/crt.h"
+ #include "wx/utils.h"
+#endif
-#include "wx/config.h" // for wxExpandEnvVars
+#include "wx/dynlib.h"
+#include "wx/file.h"
+#include "wx/wfstream.h"
+#include "wx/msw/private.h"
// Windows headers
-/*
-#define STRICT
-#define WIN32_LEAN_AND_MEAN
-*/
-
-#include <windows.h>
+#ifdef __WXWINCE__
+#include <winbase.h>
+#include <winreg.h>
+#endif
// other std headers
#include <stdlib.h> // for _MAX_PATH
#ifndef _MAX_PATH
- #define _MAX_PATH 512
+ #define _MAX_PATH 512
#endif
// our header
// 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
+
+#ifndef KEY_WOW64_64KEY
+ #define KEY_WOW64_64KEY 0x0100
+#endif
// ----------------------------------------------------------------------------
// constants
static struct
{
HKEY hkey;
- const char *szName;
- const char *szShortName;
-}
-aStdKeys[] =
-{
- { HKEY_CLASSES_ROOT, "HKEY_CLASSES_ROOT", "HKCR" },
-#ifdef __WIN32__
- { HKEY_CURRENT_USER, "HKEY_CURRENT_USER", "HKCU" },
- { HKEY_LOCAL_MACHINE, "HKEY_LOCAL_MACHINE", "HKLM" },
- { HKEY_USERS, "HKEY_USERS", "HKU" }, // short name?
- { HKEY_PERFORMANCE_DATA, "HKEY_PERFORMANCE_DATA", "HKPD" },
-#if WINVER >= 0x0400
- { HKEY_CURRENT_CONFIG, "HKEY_CURRENT_CONFIG", "HKCC" },
-#ifndef __GNUWIN32__
- { HKEY_DYN_DATA, "HKEY_DYN_DATA", "HKDD" }, // short name?
-#endif //GNUWIN32
-#endif //WINVER >= 4.0
-#endif //WIN32
+ const wxChar *szName;
+ const wxChar *szShortName;
+}
+aStdKeys[] =
+{
+ { HKEY_CLASSES_ROOT, wxT("HKEY_CLASSES_ROOT"), wxT("HKCR") },
+ { 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") },
+ { HKEY_CURRENT_CONFIG, wxT("HKEY_CURRENT_CONFIG"), wxT("HKCC") },
+ { HKEY_DYN_DATA, wxT("HKEY_DYN_DATA"), wxT("HKDD") }, // short name?
};
// the registry name separator (perhaps one day MS will change it to '/' ;-)
-#define REG_SEPARATOR '\\'
+#define REG_SEPARATOR wxT('\\')
// useful for Windows programmers: makes somewhat more clear all these zeroes
// being passed to Windows APIs
-#define RESERVED (NULL)
+#define RESERVED (0)
// ----------------------------------------------------------------------------
// macros
// ----------------------------------------------------------------------------
-// @ const_cast<> is not yet supported by all compilers
+
+// const_cast<> is not yet supported by all compilers
#define CONST_CAST ((wxRegKey *)this)->
-#if !USE_MUTABLE
- #define m_dwLastError CONST_CAST m_dwLastError
-#endif
+// and neither is mutable which m_dwLastError should be
+#define m_dwLastError CONST_CAST m_dwLastError
// ----------------------------------------------------------------------------
// non member functions
// 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 char *szKey);
+// returns true if given registry key exists
+static bool KeyExists(
+ WXHKEY hRootKey,
+ const wxString& szKey,
+ wxRegKey::WOW64ViewMode viewMode = wxRegKey::WOW64ViewMode_Default);
+
+// return the WOW64 registry view flag which can be used with MSW registry
+// functions for opening the key in the specified view
+static long GetMSWViewFlags(wxRegKey::WOW64ViewMode viewMode);
-// combines value and key name (uses static buffer!)
-static const char *GetFullName(const wxRegKey *pKey,
- const char *szValue = NULL);
+// return the access rights which can be used with MSW registry functions for
+// opening the key in the specified mode
+static long
+GetMSWAccessFlags(wxRegKey::AccessMode mode, wxRegKey::WOW64ViewMode viewMode);
+
+// combines value and key name
+static wxString GetFullName(const wxRegKey *pKey);
+static wxString GetFullName(const wxRegKey *pKey, const wxString& szValue);
+
+// 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 size_t wxRegKey::nStdKeys = WXSIZEOF(aStdKeys);
// @@ should take a `StdKey key', but as it's often going to be used in loops
-// it would require casts in user code.
-const char *wxRegKey::GetStdKeyName(size_t key)
+// it would require casts in user code.
+const wxChar *wxRegKey::GetStdKeyName(size_t key)
{
// return empty string if key is invalid
- wxCHECK_MSG( key < nStdKeys, "", "invalid key in wxRegKey::GetStdKeyName" );
+ wxCHECK_MSG( key < nStdKeys, wxEmptyString, wxT("invalid key in wxRegKey::GetStdKeyName") );
return aStdKeys[key].szName;
}
-const char *wxRegKey::GetStdKeyShortName(size_t key)
+const wxChar *wxRegKey::GetStdKeyShortName(size_t key)
{
// return empty string if key is invalid
- wxCHECK( key < nStdKeys, "" );
+ wxCHECK( key < nStdKeys, wxEmptyString );
return aStdKeys[key].szShortName;
}
wxRegKey::StdKey wxRegKey::ExtractKeyName(wxString& strKey)
{
- wxString strRoot = strKey.Left(REG_SEPARATOR);
+ wxString strRoot = strKey.BeforeFirst(REG_SEPARATOR);
- HKEY hRootKey;
size_t ui;
for ( ui = 0; ui < nStdKeys; ui++ ) {
- if ( strRoot.CmpNoCase(aStdKeys[ui].szName) == 0 ||
+ if ( strRoot.CmpNoCase(aStdKeys[ui].szName) == 0 ||
strRoot.CmpNoCase(aStdKeys[ui].szShortName) == 0 ) {
- hRootKey = aStdKeys[ui].hkey;
break;
}
}
if ( ui == nStdKeys ) {
- wxFAIL_MSG("invalid key prefix in wxRegKey::ExtractKeyName.");
+ 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;
}
-
- wxFAIL_MSG("non root hkey passed to wxRegKey::GetStdKeyFromHkey.");
+
+ wxFAIL_MSG(wxT("non root hkey passed to wxRegKey::GetStdKeyFromHkey."));
return HKCR;
}
// ctors and dtor
// ----------------------------------------------------------------------------
-wxRegKey::wxRegKey()
+wxRegKey::wxRegKey(WOW64ViewMode viewMode) : m_viewMode(viewMode)
{
- m_hKey = 0;
m_hRootKey = (WXHKEY) aStdKeys[HKCR].hkey;
- m_dwLastError = 0;
+
+ Init();
}
-wxRegKey::wxRegKey(const wxString& strKey) : m_strKey(strKey)
+wxRegKey::wxRegKey(const wxString& strKey, WOW64ViewMode viewMode)
+ : m_strKey(strKey), m_viewMode(viewMode)
{
m_hRootKey = (WXHKEY) aStdKeys[ExtractKeyName(m_strKey)].hkey;
- m_hKey = NULL;
- m_dwLastError = 0;
+
+ Init();
}
// parent is a predefined (and preopened) key
-wxRegKey::wxRegKey(StdKey keyParent, const wxString& strKey) : m_strKey(strKey)
+wxRegKey::wxRegKey(StdKey keyParent,
+ const wxString& strKey,
+ WOW64ViewMode viewMode)
+ : m_strKey(strKey), m_viewMode(viewMode)
{
RemoveTrailingSeparator(m_strKey);
m_hRootKey = (WXHKEY) aStdKeys[keyParent].hkey;
- m_hKey = NULL;
- m_dwLastError = 0;
+
+ Init();
}
// parent is a normal regkey
wxRegKey::wxRegKey(const wxRegKey& keyParent, const wxString& strKey)
- : m_strKey(keyParent.m_strKey)
+ : m_strKey(keyParent.m_strKey), m_viewMode(keyParent.GetView())
{
// 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;
}
RemoveTrailingSeparator(m_strKey);
m_hRootKey = keyParent.m_hRootKey;
- m_hKey = NULL;
- m_dwLastError = 0;
+
+ Init();
}
// dtor closes the key releasing system resource
Close();
// combine our name with parent's to get the full name
- m_strKey = keyParent.m_strKey;
- if ( !strKey.IsEmpty() && strKey[0] != REG_SEPARATOR )
+
+ // NB: this method is called by wxRegConfig::SetPath() which is a performance
+ // critical function and so it preallocates space for our m_strKey to
+ // gain some speed - this is why we only use += here and not = which
+ // would just free the prealloc'd buffer and would have to realloc it the
+ // next line!
+ m_strKey.clear();
+ m_strKey += keyParent.m_strKey;
+ if ( !strKey.empty() && strKey[0] != REG_SEPARATOR )
m_strKey += REG_SEPARATOR;
m_strKey += strKey;
Close();
m_hKey = hKey;
+
+ // we don't know the parent of this key, assume HKLM by default
+ m_hRootKey = HKEY_LOCAL_MACHINE;
+
+ // we don't know in which mode was this key opened but we can't reopen it
+ // anyhow because we don't know its name, so the only thing we can is to hope
+ // that it allows all the operations which we're going to perform on it
+ m_mode = Write;
+
+ // reset old data
+ m_strKey.clear();
+ m_dwLastError = 0;
}
// ----------------------------------------------------------------------------
// 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, m_viewMode);
}
// returns the full name of the key (prefix is abbreviated if bShortPrefix)
wxString wxRegKey::GetName(bool bShortPrefix) const
{
- StdKey key = GetStdKeyFromHkey((StdKey) m_hRootKey);
- wxString str = bShortPrefix ? aStdKeys[key].szShortName
+ StdKey key = GetStdKeyFromHkey((WXHKEY) m_hRootKey);
+ wxString str = bShortPrefix ? aStdKeys[key].szShortName
: aStdKeys[key].szName;
- if ( !m_strKey.IsEmpty() )
- str << "\\" << m_strKey;
+ if ( !m_strKey.empty() )
+ str << wxT("\\") << m_strKey;
return str;
}
-#ifdef __GNUWIN32__
-bool wxRegKey::GetKeyInfo(size_t* pnSubKeys,
- size_t* pnMaxKeyLen,
- size_t* pnValues,
- size_t* pnMaxValueLen) const
-#else
-bool wxRegKey::GetKeyInfo(ulong *pnSubKeys,
- ulong *pnMaxKeyLen,
- ulong *pnValues,
- ulong *pnMaxValueLen) const
-#endif
+bool wxRegKey::GetKeyInfo(size_t *pnSubKeys,
+ size_t *pnMaxKeyLen,
+ size_t *pnValues,
+ size_t *pnMaxValueLen) const
{
-#ifdef __WIN32__
+ // it might be unexpected to some that this function doesn't open the key
+ wxASSERT_MSG( IsOpened(), wxT("key should be opened in GetKeyInfo") );
+
+ // We need to use intermediate variables in 64 bit build as the function
+ // parameters must be 32 bit DWORDs and not 64 bit size_t values.
+#ifdef __WIN64__
+ DWORD dwSubKeys = 0,
+ dwMaxKeyLen = 0,
+ dwValues = 0,
+ dwMaxValueLen = 0;
+
+ #define REG_PARAM(name) &dw##name
+#else // Win32
+ // Old gcc headers incorrectly prototype RegQueryInfoKey() as taking
+ // size_t but normally we need a cast, even when sizeof(size_t) is the same
+ // as sizeof(DWORD).
+ #if defined(__GNUWIN32_OLD__) && !defined(__CYGWIN10__)
+ #define REG_PARAM(name) pn##name
+ #else
+ #define REG_PARAM(name) (LPDWORD)(pn##name)
+ #endif
+#endif
+
+
m_dwLastError = ::RegQueryInfoKey
(
(HKEY) m_hKey,
- NULL, // class name
- NULL, // (ptr to) size of class name buffer
+ NULL, // class name
+ NULL, // (ptr to) size of class name buffer
RESERVED,
- pnSubKeys, // [out] number of subkeys
- pnMaxKeyLen, // [out] max length of a subkey name
- NULL, // longest subkey class name
- pnValues, // [out] number of values
- pnMaxValueLen, // [out] max length of a value name
- NULL, // longest value data
- NULL, // security descriptor
- NULL // time of last modification
+ REG_PARAM(SubKeys), // [out] number of subkeys
+ REG_PARAM(MaxKeyLen), // [out] max length of a subkey name
+ NULL, // longest subkey class name
+ REG_PARAM(Values), // [out] number of values
+ REG_PARAM(MaxValueLen), // [out] max length of a value name
+ NULL, // longest value data
+ NULL, // security descriptor
+ NULL // time of last modification
);
+#ifdef __WIN64__
+ if ( pnSubKeys )
+ *pnSubKeys = dwSubKeys;
+ if ( pnMaxKeyLen )
+ *pnMaxKeyLen = dwMaxKeyLen;
+ if ( pnValues )
+ *pnValues = dwValues;
+ if ( pnMaxValueLen )
+ *pnMaxValueLen = dwMaxValueLen;
+#endif // __WIN64__
+
+#undef REG_PARAM
+
if ( m_dwLastError != ERROR_SUCCESS ) {
- wxLogSysError(m_dwLastError, _("can't get info about registry key '%s'"),
+ wxLogSysError(m_dwLastError, _("Can't get info about registry key '%s'"),
GetName().c_str());
- return FALSE;
+ return false;
}
- else
- 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.t_str(),
+ RESERVED,
+ GetMSWAccessFlags(mode, m_viewMode),
+ &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);
+ DWORD disposition;
+ // Minimum supported OS for RegCreateKeyEx: Win 95, Win NT 3.1, Win CE 1.0
+ m_dwLastError = RegCreateKeyEx((HKEY) m_hRootKey, m_strKey.t_str(),
+ 0, // reserved and must be 0
+ NULL, // The user-defined class type of this key.
+ REG_OPTION_NON_VOLATILE, // supports other values as well; see MS docs
+ GetMSWAccessFlags(wxRegKey::Write, m_viewMode),
+ NULL, // pointer to a SECURITY_ATTRIBUTES structure
+ &tmpKey,
+ &disposition);
+
if ( m_dwLastError != ERROR_SUCCESS ) {
- wxLogSysError(m_dwLastError, _("can't create registry key '%s'"),
+ 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;
}
}
{
if ( IsOpened() ) {
m_dwLastError = RegCloseKey((HKEY) m_hKey);
+ m_hKey = 0;
+
if ( m_dwLastError != ERROR_SUCCESS ) {
- wxLogSysError(m_dwLastError, _("can't close registry key '%s'"),
+ wxLogSysError(m_dwLastError, _("Can't close registry key '%s'"),
GetName().c_str());
- m_hKey = 0;
- return FALSE;
+ return false;
+ }
+ }
+
+ return true;
+}
+
+bool
+wxRegKey::RenameValue(const wxString& szValueOld, const wxString& szValueNew)
+{
+ bool ok = true;
+ if ( HasValue(szValueNew) ) {
+ wxLogError(_("Registry value '%s' already exists."), szValueNew);
+
+ ok = false;
+ }
+
+ if ( !ok ||
+ !CopyValue(szValueOld, *this, szValueNew) ||
+ !DeleteValue(szValueOld) ) {
+ wxLogError(_("Failed to rename registry value '%s' to '%s'."),
+ szValueOld, szValueNew);
+
+ return false;
+ }
+
+ return true;
+}
+
+bool wxRegKey::CopyValue(const wxString& szValue,
+ wxRegKey& keyDst,
+ const wxString& szValueNew)
+{
+ wxString valueNew(szValueNew);
+ if ( valueNew.empty() ) {
+ // by default, use the same name
+ valueNew = szValue;
+ }
+
+ switch ( GetValueType(szValue) ) {
+ case Type_String:
+ {
+ wxString strVal;
+ return QueryValue(szValue, strVal) &&
+ keyDst.SetValue(valueNew, strVal);
+ }
+
+ case Type_Dword:
+ /* case Type_Dword_little_endian: == Type_Dword */
+ {
+ long dwVal;
+ return QueryValue(szValue, &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)
+ case Type_None:
+ case Type_Expand_String:
+ 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:
+ default:
+ wxLogError(_("Can't copy values of unsupported type %d."),
+ GetValueType(szValue));
+ return false;
+ }
+}
+
+bool wxRegKey::Rename(const wxString& szNewName)
+{
+ wxCHECK_MSG( !m_strKey.empty(), false, wxT("registry hives can't be renamed") );
+
+ if ( !Exists() ) {
+ wxLogError(_("Registry key '%s' does not exist, cannot rename it."),
+ GetFullName(this));
+
+ return false;
+ }
+
+ // do we stay in the same hive?
+ bool inSameHive = !wxStrchr(szNewName, REG_SEPARATOR);
+
+ // construct the full new name of the key
+ wxRegKey keyDst;
+
+ if ( inSameHive ) {
+ // rename the key to the new name under the same parent
+ wxString strKey = m_strKey.BeforeLast(REG_SEPARATOR);
+ if ( !strKey.empty() ) {
+ // don't add '\\' in the start if strFullNewName is empty
+ strKey += REG_SEPARATOR;
+ }
+
+ strKey += szNewName;
+
+ keyDst.SetName(GetStdKeyFromHkey(m_hRootKey), strKey);
}
else {
- m_hKey = 0;
+ // this is the full name already
+ keyDst.SetName(szNewName);
+ }
+
+ bool ok = keyDst.Create(false /* fail if alredy exists */);
+ if ( !ok ) {
+ wxLogError(_("Registry key '%s' already exists."),
+ GetFullName(&keyDst));
+ }
+ else {
+ ok = Copy(keyDst) && DeleteSelf();
+ }
+
+ if ( !ok ) {
+ wxLogError(_("Failed to rename the registry key '%s' to '%s'."),
+ GetFullName(this), GetFullName(&keyDst));
+ }
+ else {
+ m_hRootKey = keyDst.m_hRootKey;
+ m_strKey = keyDst.m_strKey;
}
- }
- return TRUE;
+ return ok;
+}
+
+bool wxRegKey::Copy(const wxString& szNewName)
+{
+ // create the new key first
+ wxRegKey keyDst(szNewName);
+ bool ok = keyDst.Create(false /* fail if alredy exists */);
+ if ( ok ) {
+ ok = Copy(keyDst);
+
+ // we created the dest key but copying to it failed - delete it
+ if ( !ok ) {
+ (void)keyDst.DeleteSelf();
+ }
+ }
+
+ return ok;
+}
+
+bool wxRegKey::Copy(wxRegKey& keyDst)
+{
+ bool ok = true;
+
+ // copy all sub keys to the new location
+ wxString strKey;
+ long lIndex;
+ bool bCont = GetFirstKey(strKey, lIndex);
+ while ( ok && bCont ) {
+ wxRegKey key(*this, strKey);
+ wxString keyName;
+ keyName << GetFullName(&keyDst) << REG_SEPARATOR << strKey;
+ 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
+ wxString strVal;
+ bCont = GetFirstValue(strVal, lIndex);
+ while ( ok && bCont ) {
+ ok = CopyValue(strVal, keyDst);
+
+ if ( !ok ) {
+ wxLogSysError(m_dwLastError,
+ _("Failed to copy registry value '%s'"),
+ strVal.c_str());
+ }
+ else {
+ bCont = GetNextValue(strVal, lIndex);
+ }
+ }
+
+ if ( !ok ) {
+ 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.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));
+
+ return false;
+ }
+
// we can't delete keys while enumerating because it confuses GetNextKey, so
// we first save the key names and then delete them all
wxArrayString astrSubkeys;
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 ) {
- wxLogSysError(m_dwLastError, _("can't delete key '%s'"),
+ // deleting a key which doesn't exist is not considered an error
+#if wxUSE_DYNLIB_CLASS
+ wxDynamicLibrary dllAdvapi32(wxT("advapi32"));
+ // Minimum supported OS for RegDeleteKeyEx: Vista, XP Pro x64, Win Server 2008, Win Server 2003 SP1
+ if(dllAdvapi32.HasSymbol(wxT("RegDeleteKeyEx")))
+ {
+ typedef LONG (WINAPI *RegDeleteKeyEx_t)(HKEY, LPCTSTR, REGSAM, DWORD);
+ wxDYNLIB_FUNCTION(RegDeleteKeyEx_t, RegDeleteKeyEx, dllAdvapi32);
+
+ m_dwLastError = (*pfnRegDeleteKeyEx)((HKEY) m_hRootKey, m_strKey.t_str(),
+ GetMSWViewFlags(m_viewMode),
+ 0); // This parameter is reserved and must be zero.
+ }
+ else
+#endif // wxUSE_DYNLIB_CLASS
+ {
+ m_dwLastError = RegDeleteKey((HKEY) m_hRootKey, m_strKey.t_str());
+ }
+
+ 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 char *szKey)
+bool wxRegKey::DeleteKey(const wxString& szKey)
{
if ( !Open() )
- return FALSE;
+ return false;
wxRegKey key(*this, szKey);
return key.DeleteSelf();
}
-bool wxRegKey::DeleteValue(const char *szValue)
+bool wxRegKey::DeleteValue(const wxString& szValue)
{
- if ( !Open() )
- return FALSE;
+ if ( !Open() )
+ return false;
- #ifdef __WIN32__
- m_dwLastError = RegDeleteValue((HKEY) m_hKey, szValue);
- if ( m_dwLastError != ERROR_SUCCESS ) {
- 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) );
+ m_dwLastError = RegDeleteValue((HKEY) m_hKey, RegValueStr(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;
+ // 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;
}
- #endif //WIN16/32
- return TRUE;
+ return true;
}
// ----------------------------------------------------------------------------
// access to values and subkeys
// ----------------------------------------------------------------------------
-// return TRUE if value exists
-bool wxRegKey::HasValue(const char *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()
+ // this function should be silent, so suppress possible messages from Open()
+ wxLogNull nolog;
+
+ if ( !CONST_CAST Open(Read) )
+ return false;
+
+ LONG dwRet = ::RegQueryValueEx((HKEY) m_hKey,
+ RegValueStr(szValue),
+ RESERVED,
+ NULL, NULL, NULL);
+ return dwRet == ERROR_SUCCESS;
+}
+
+// returns true if this key has any values
+bool wxRegKey::HasValues() const
+{
+ // suppress possible messages from GetFirstValue()
wxLogNull nolog;
-
- #ifdef __WIN32__
- if ( CONST_CAST Open() ) {
- return RegQueryValueEx((HKEY) m_hKey, szValue, RESERVED,
- NULL, NULL, NULL) == ERROR_SUCCESS;
- }
- else
- return FALSE;
- #else // WIN16
- // only unnamed value exists
- return IsEmpty(szValue);
- #endif // WIN16/32
+
+ // just call GetFirstValue with dummy parameters
+ wxString str;
+ long l;
+ 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()
+ wxLogNull nolog;
+
// just call GetFirstKey with dummy parameters
wxString str;
long l;
return CONST_CAST GetFirstKey(str, l);
}
-// returns TRUE if given subkey exists
-bool wxRegKey::HasSubKey(const char *szKey) const
+// returns true if given subkey exists
+bool wxRegKey::HasSubKey(const wxString& szKey) const
{
- if ( CONST_CAST Open() )
- return KeyExists(m_hKey, szKey);
- else
- return FALSE;
+ // this function should be silent, so suppress possible messages from Open()
+ wxLogNull nolog;
+
+ if ( !CONST_CAST Open(Read) )
+ return false;
+
+ return KeyExists(m_hKey, szKey, m_viewMode);
}
-wxRegKey::ValueType wxRegKey::GetValueType(const char *szValue)
+wxRegKey::ValueType wxRegKey::GetValueType(const wxString& szValue) const
{
- #ifdef __WIN32__
- if ( !Open() )
+ if ( ! CONST_CAST Open(Read) )
return Type_None;
DWORD dwType;
- m_dwLastError = RegQueryValueEx((HKEY) m_hKey, 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'"),
+ wxLogSysError(m_dwLastError, _("Can't read value of key '%s'"),
GetName().c_str());
return Type_None;
}
return (ValueType)dwType;
- #else //WIN16
- return IsEmpty(szValue) ? Type_String : Type_None;
- #endif //WIN16/32
}
-#ifdef __WIN32__
-bool wxRegKey::SetValue(const char *szValue, long lValue)
+bool wxRegKey::SetValue(const wxString& szValue, long lValue)
{
if ( CONST_CAST Open() ) {
- m_dwLastError = RegSetValueEx((HKEY) m_hKey, szValue, 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'"),
+ wxLogSysError(m_dwLastError, _("Can't set value of '%s'"),
GetFullName(this, szValue));
- return FALSE;
+ return false;
}
-bool wxRegKey::QueryValue(const char *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, 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'"),
+ 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( dwType == REG_DWORD,
- "Type mismatch in wxRegKey::QueryValue()." );
+ 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 char *szValue, wxString& strValue) 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, szValue, RESERVED,
- &dwType, NULL, &dwSize);
- if ( m_dwLastError == ERROR_SUCCESS ) {
- RegString pBuf = (RegString)strValue.GetWriteBuf(dwSize);
- m_dwLastError = RegQueryValueEx((HKEY) m_hKey, szValue, RESERVED,
- &dwType, pBuf, &dwSize);
- strValue.UngetWriteBuf();
- if ( m_dwLastError == ERROR_SUCCESS ) {
- // check that it was the right type
- wxASSERT_MSG( dwType == REG_SZ,
- "Type mismatch in wxRegKey::QueryValue()." );
-
- return TRUE;
+ 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,
+ RegValueStr(szValue),
+ RESERVED,
+ &dwType,
+ pBuf,
+ &dwSize);
+ buffer.UngetWriteBuf(dwSize);
+ } else {
+ buffer.SetDataLen(0);
}
- }
- #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
+
+ if ( m_dwLastError != ERROR_SUCCESS ) {
+ wxLogSysError(m_dwLastError, _("Can't read value of key '%s'"),
+ GetName().c_str());
+ return false;
+ }
+ return true;
}
+ return false;
+}
- wxLogSysError(m_dwLastError, _("can't read value of '%s'"),
- GetFullName(this, szValue));
- return FALSE;
+
+
+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 )
+ {
+ DWORD dwExpSize = ::ExpandEnvironmentStrings(strValue.t_str(), NULL, 0);
+ bool ok = dwExpSize != 0;
+ if ( ok )
+ {
+ wxString strExpValue;
+ ok = ::ExpandEnvironmentStrings(strValue.t_str(),
+ wxStringBuffer(strExpValue, dwExpSize),
+ dwExpSize
+ ) != 0;
+ strValue = strExpValue;
+ }
+
+ if ( !ok )
+ {
+ wxLogLastError(wxT("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().") );
+
+ return true;
+ }
+ }
+ }
+
+ wxLogSysError(m_dwLastError, _("Can't read value of '%s'"),
+ GetFullName(this, szValue));
+ return false;
}
-bool wxRegKey::SetValue(const char *szValue, const wxString& strValue)
+bool wxRegKey::SetValue(const wxString& szValue, const wxString& strValue)
{
if ( CONST_CAST Open() ) {
- #ifdef __WIN32__
- m_dwLastError = RegSetValueEx((HKEY) m_hKey, szValue, RESERVED, REG_SZ,
- (RegString)strValue.c_str(),
- strValue.Len() + 1);
- 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);
+ m_dwLastError = RegSetValueEx((HKEY) m_hKey,
+ RegValueStr(szValue),
+ (DWORD) RESERVED, REG_SZ,
+ (RegString)wxMSW_CONV_LPCTSTR(strValue),
+ (strValue.Len() + 1)*sizeof(wxChar));
if ( m_dwLastError == ERROR_SUCCESS )
- return TRUE;
- #endif //WIN16/32
+ return true;
}
- wxLogSysError(m_dwLastError, _("can't set value of '%s'"),
+ wxLogSysError(m_dwLastError, _("Can't set value of '%s'"),
GetFullName(this, szValue));
- return FALSE;
+ return false;
}
-wxRegKey::operator wxString() const
+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;
- #ifdef __WIN32__
- char szValueName[1024]; // @@ use RegQueryInfoKey...
+ wxChar szValueName[1024]; // @@ use RegQueryInfoKey...
DWORD dwValueLen = WXSIZEOF(szValueName);
- lIndex++;
- m_dwLastError = RegEnumValue((HKEY) m_hKey, lIndex,
+ m_dwLastError = RegEnumValue((HKEY) m_hKey, lIndex++,
szValueName, &dwValueLen,
- RESERVED,
- NULL, // [out] type
+ RESERVED,
+ NULL, // [out] type
NULL, // [out] buffer for value
NULL); // [i/o] it's length
lIndex = -1;
}
else {
- wxLogSysError(m_dwLastError, _("can't enumerate values of key '%s'"),
+ wxLogSysError(m_dwLastError, _("Can't enumerate values of key '%s'"),
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;
- char szKeyName[_MAX_PATH + 1];
+ 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 ) {
lIndex = -1;
}
else {
- wxLogSysError(m_dwLastError, _("can't enumerate subkeys of key '%s'"),
+ wxLogSysError(m_dwLastError, _("Can't enumerate subkeys of key '%s'"),
GetName().c_str());
}
- return FALSE;
+ return false;
}
strKeyName = szKeyName;
- return TRUE;
+ return true;
}
-// ============================================================================
-// implementation of global private functions
-// ============================================================================
-bool KeyExists(WXHKEY hRootKey, const char *szKey)
+// returns true if the value contains a number (else it's some string)
+bool wxRegKey::IsNumericValue(const wxString& szValue) const
{
- HKEY hkeyDummy;
- if ( RegOpenKey( (HKEY) hRootKey, szKey, &hkeyDummy) == ERROR_SUCCESS ) {
- RegCloseKey(hkeyDummy);
- return TRUE;
- }
- else
- return FALSE;
+ ValueType type = GetValueType(szValue);
+ switch ( type ) {
+ case Type_Dword:
+ /* case Type_Dword_little_endian: == Type_Dword */
+ case Type_Dword_big_endian:
+ return true;
+
+ default:
+ return false;
+ }
}
-const char *GetFullName(const wxRegKey *pKey, const char *szValue)
+// ----------------------------------------------------------------------------
+// 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)
{
- static wxString s_str;
- s_str = pKey->GetName();
- if ( !IsEmpty(szValue) )
- s_str << "\\" << szValue;
+ ostr.PutC(ch);
+ return ostr.IsOk();
+}
- return s_str.c_str();
+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');
}
-void RemoveTrailingSeparator(wxString& str)
+static inline bool WriteAsciiString(wxOutputStream& ostr, const char *p)
{
- if ( !str.IsEmpty() && str.Last() == REG_SEPARATOR )
- str.Truncate(str.Len() - 1);
+ return ostr.Write(p, strlen(p)).IsOk();
}
-// ============================================================================
-// global public functions
-// ============================================================================
+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
-bool GetExtensionFromMimeType(wxString *pExt, const wxString& strMimeType)
+ return ostr.IsOk();
+}
+
+#endif // wxUSE_STREAMS
+
+bool wxRegKey::Export(const wxString& filename) const
{
- // @@@ VZ: I don't know of any official documentation which mentions this
- // location, but as a matter of fact IE uses it, so why not we?
- static const char *szMimeDbase = "MIME\\Database\\Content Type\\";
+#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;
+ }
- wxString strKey = szMimeDbase;
- strKey << strMimeType;
+ wxFFileOutputStream ostr(filename, wxT("w"));
- // suppress possible error messages
- wxLogNull nolog;
- wxRegKey key(wxRegKey::HKCR, strKey);
- if ( key.Open() ) {
- if ( key.QueryValue("Extension", *pExt) )
- return TRUE;
- }
+ return ostr.IsOk() && Export(ostr);
+#else
+ wxUnusedVar(filename);
+ return false;
+#endif
+}
- // no such MIME type or no extension for it
- return FALSE;
+#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
-bool GetMimeTypeFromExtension(wxString *pMimeType, const wxString& strExt)
+static
+wxString
+FormatAsHex(const void *data,
+ size_t size,
+ wxRegKey::ValueType type = wxRegKey::Type_Binary)
{
- wxCHECK( !strExt.IsEmpty(), FALSE );
+ wxString value(wxT("hex"));
+
+ // binary values use just "hex:" prefix while the other ones must indicate
+ // the real type
+ if ( type != wxRegKey::Type_Binary )
+ value << wxT('(') << type << wxT(')');
+ value << wxT(':');
+
+ // write all the rest as comma-separated bytes
+ value.reserve(3*size + 10);
+ const char * const p = 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 << wxT(',');
+
+ value << wxString::Format(wxT("%02x"), (unsigned char)p[n]);
+ }
- // add the leading point if necessary
- wxString str;
- if ( strExt[0] != '.' ) {
- str = '.';
- }
- str << strExt;
+ return value;
+}
- // suppress possible error messages
- wxLogNull nolog;
- wxRegKey key(wxRegKey::HKCR, str);
- if ( key.Open() ) {
- if ( key.QueryValue("Content Type", *pMimeType) )
- return TRUE;
- }
+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 = wxT('"');
+
+ // 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 wxT('\n'):
+ // we can only represent this string in hex
+ useHex = true;
+ break;
+
+ case wxT('"'):
+ case wxT('\\'):
+ // escape special symbol
+ rhs += wxT('\\');
+ // fall through
+
+ default:
+ rhs += *p;
+ }
+ }
+
+ if ( useHex )
+ rhs = FormatAsHex(value, Type_String);
+ else
+ rhs += wxT('"');
+ }
+ break;
+
+ case Type_Dword:
+ /* case Type_Dword_little_endian: == Type_Dword */
+ {
+ long value;
+ if ( !QueryValue(name, &value) )
+ break;
+
+ rhs.Printf(wxT("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);
+ }
- // no such extension or no content-type
- return FALSE;
+ return rhs;
}
-bool GetFileTypeFromExtension(wxString *pFileType, const wxString& strExt)
+#if wxUSE_STREAMS
+
+bool wxRegKey::DoExportValue(wxOutputStream& ostr, const wxString& name) const
{
- wxCHECK( !strExt.IsEmpty(), FALSE );
+ // 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;
+ }
- // add the leading point if necessary
- wxString str;
- if ( strExt[0] != '.' ) {
- str = '.';
- }
- str << strExt;
+ // we do have the text representation of the value, now write everything
+ // out
- // suppress possible error messages
- wxLogNull nolog;
- wxRegKey key(wxRegKey::HKCR, str);
- if ( key.Open() ) {
- if ( key.QueryValue("", *pFileType) ) // it's the default value of the key
- return TRUE;
- }
+ // 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;
+ }
- // no such extension or no value
- return FALSE;
+ if ( !WriteAsciiChar(ostr, '=') )
+ return false;
+
+ return WriteAsciiString(ostr, value) && WriteAsciiEOL(ostr);
}
-bool GetFileTypeIcon(wxIcon *pIcon, const wxString& strFileType)
+bool wxRegKey::DoExport(wxOutputStream& ostr) const
{
- wxCHECK( !strFileType.IsEmpty(), FALSE );
+ // 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 = const_cast<wxRegKey&>(*this);
+ bool cont = self.GetFirstValue(name, dummy);
+ while ( cont )
+ {
+ if ( !DoExportValue(ostr, name) )
+ return false;
+
+ cont = GetNextValue(name, dummy);
+ }
- wxString strIconKey;
- strIconKey << strFileType << REG_SEPARATOR << "DefaultIcon";
+ // always terminate values by blank line, even if there were no values
+ if ( !WriteAsciiEOL(ostr) )
+ return false;
- // suppress possible error messages
- wxLogNull nolog;
- wxRegKey key(wxRegKey::HKCR, strIconKey);
-
- if ( key.Open() ) {
- wxString strIcon;
- if ( key.QueryValue("", strIcon) ) { // it's the default value of the key
- // the format is the following: <full path to file>, <icon index>
- // NB: icon index may be negative as well as positive and the full path
- // may contain the environment variables inside '%'
- wxString strFullPath = strIcon.Before(','),
- strIndex = strIcon.Right(',');
-
- // index may be omitted, in which case Before(',') is empty and
- // Right(',') is the whole string
- if ( strFullPath.IsEmpty() ) {
- strFullPath = strIndex;
- strIndex = "0";
- }
+ // 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
- wxString strExpPath = wxExpandEnvVars(strFullPath);
- int nIndex = atoi(strIndex);
+// ============================================================================
+// implementation of global private functions
+// ============================================================================
- HICON hIcon = ExtractIcon(GetModuleHandle(NULL), strExpPath, nIndex);
- switch ( (int)hIcon ) {
- case 0: // means no icons were found
- case 1: // means no such file or it wasn't a DLL/EXE/OCX/ICO/...
- wxLogDebug("incorrect registry entry '%s': no such icon.",
- GetFullName(&key));
- break;
+bool KeyExists(WXHKEY hRootKey,
+ const wxString& szKey,
+ wxRegKey::WOW64ViewMode viewMode)
+{
+ // don't close this key itself for the case of empty szKey!
+ if ( szKey.empty() )
+ return true;
+
+ HKEY hkeyDummy;
+ if ( ::RegOpenKeyEx
+ (
+ (HKEY)hRootKey,
+ szKey.t_str(),
+ RESERVED,
+ // we might not have enough rights for rw access
+ GetMSWAccessFlags(wxRegKey::Read, viewMode),
+ &hkeyDummy
+ ) == ERROR_SUCCESS )
+ {
+ ::RegCloseKey(hkeyDummy);
+
+ return true;
+ }
+
+ return false;
+}
+
+long GetMSWViewFlags(wxRegKey::WOW64ViewMode viewMode)
+{
+ long samWOW64ViewMode = 0;
+
+ switch ( viewMode )
+ {
+ case wxRegKey::WOW64ViewMode_32:
+#ifdef __WIN64__ // the flag is only needed by 64 bit apps
+ samWOW64ViewMode = KEY_WOW64_32KEY;
+#endif // Win64
+ break;
+
+ case wxRegKey::WOW64ViewMode_64:
+#ifndef __WIN64__ // the flag is only needed by 32 bit apps
+ // 64 bit registry can only be accessed under 64 bit platforms
+ if ( wxIsPlatform64Bit() )
+ samWOW64ViewMode = KEY_WOW64_64KEY;
+#endif // Win32
+ break;
default:
- pIcon->SetHICON((WXHICON)hIcon);
- return TRUE;
- }
+ wxFAIL_MSG("Unknown registry view.");
+ // fall through
+
+ case wxRegKey::WOW64ViewMode_Default:
+ // Use default registry view for the current application,
+ // i.e. 32 bits for 32 bit ones and 64 bits for 64 bit apps
+ ;
}
- }
- // no such file type or no value or incorrect icon entry
- return FALSE;
+ return samWOW64ViewMode;
}
-bool GetFileTypeDescription(wxString *pDesc, const wxString& strFileType)
+long GetMSWAccessFlags(wxRegKey::AccessMode mode,
+ wxRegKey::WOW64ViewMode viewMode)
{
- wxCHECK( !strFileType.IsEmpty(), FALSE );
+ long sam = mode == wxRegKey::Read ? KEY_READ : KEY_ALL_ACCESS;
- // suppress possible error messages
- wxLogNull nolog;
- wxRegKey key(wxRegKey::HKCR, strFileType);
+ sam |= GetMSWViewFlags(viewMode);
- if ( key.Open() ) {
- if ( key.QueryValue("", *pDesc) ) // it's the default value of the key
- return TRUE;
- }
+ return sam;
+}
+
+wxString GetFullName(const wxRegKey *pKey, const wxString& szValue)
+{
+ wxString str(pKey->GetName());
+ if ( !szValue.empty() )
+ str << wxT("\\") << szValue;
+
+ return str;
+}
- // no such file type or no value
- return FALSE;
+wxString GetFullName(const wxRegKey *pKey)
+{
+ return pKey->GetName();
}
+inline void RemoveTrailingSeparator(wxString& str)
+{
+ if ( !str.empty() && str.Last() == REG_SEPARATOR )
+ str.Truncate(str.Len() - 1);
+}
+
+inline const wxChar *RegValueStr(const wxString& szValue)
+{
+ return szValue.empty() ? (const wxChar*)NULL : szValue.t_str();
+}
+#endif // wxUSE_REGKEY
projects / wxWidgets.git / blobdiff