X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/57a7b7c1484fda95240972aae876bdbdbbc98344..b9efe021b554fa3967d1442cf758435c5cd5ae8f:/src/msw/registry.cpp diff --git a/src/msw/registry.cpp b/src/msw/registry.cpp index c6d0142dc1..2607a3f2c7 100644 --- a/src/msw/registry.cpp +++ b/src/msw/registry.cpp @@ -2,23 +2,19 @@ // Name: 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 -// 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 -// ---------------------------------------------------------------------------- +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) +#pragma implementation "registry.h" +#endif // for compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -27,24 +23,27 @@ #pragma hdrstop #endif -// other wxWindows headers +// other wxWidgets headers #include "wx/string.h" #include "wx/intl.h" #include "wx/log.h" +#include "wx/file.h" +#include "wx/wfstream.h" // Windows headers -/* -#define STRICT -#define WIN32_LEAN_AND_MEAN -*/ +#include "wx/msw/wrapwin.h" -#include +#ifdef __WXWINCE__ +#include "wx/msw/private.h" +#include +#include +#endif // other std headers #include // for _MAX_PATH #ifndef _MAX_PATH - #define _MAX_PATH 512 + #define _MAX_PATH 512 #endif // our header @@ -53,6 +52,7 @@ // some registry functions don't like signed chars typedef unsigned char *RegString; +typedef BYTE* RegBinary; // ---------------------------------------------------------------------------- // constants @@ -63,38 +63,42 @@ typedef unsigned char *RegString; 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? +#ifndef __WXWINCE__ + { HKEY_PERFORMANCE_DATA, wxT("HKEY_PERFORMANCE_DATA"), wxT("HKPD") }, +#endif +#ifdef HKEY_CURRENT_CONFIG + { HKEY_CURRENT_CONFIG, wxT("HKEY_CURRENT_CONFIG"), wxT("HKCC") }, +#endif +#ifdef HKEY_DYN_DATA + { HKEY_DYN_DATA, wxT("HKEY_DYN_DATA"), wxT("HKDD") }, // short name? +#endif }; // 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 (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 @@ -103,12 +107,12 @@ aStdKeys[] = // 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(HKEY hRootKey, const char *szKey); +// returns true if given registry key exists +static bool KeyExists(WXHKEY hRootKey, const wxChar *szKey); // combines value and key name (uses static buffer!) -static const char *GetFullName(const wxRegKey *pKey, - const char *szValue = NULL); +static const wxChar *GetFullName(const wxRegKey *pKey, + const wxChar *szValue = NULL); // ============================================================================ // implementation of wxRegKey class @@ -121,31 +125,31 @@ static const char *GetFullName(const wxRegKey *pKey, 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(uint 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(uint 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; - uint ui; + HKEY hRootKey = 0; + 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; @@ -153,7 +157,7 @@ wxRegKey::StdKey wxRegKey::ExtractKeyName(wxString& strKey) } if ( ui == nStdKeys ) { - wxFAIL_MSG("invalid key prefix in wxRegKey::ExtractKeyName."); + wxFAIL_MSG(wxT("invalid key prefix in wxRegKey::ExtractKeyName.")); hRootKey = HKEY_CLASSES_ROOT; } @@ -166,14 +170,14 @@ wxRegKey::StdKey wxRegKey::ExtractKeyName(wxString& strKey) return (wxRegKey::StdKey)(int)hRootKey; } -wxRegKey::StdKey wxRegKey::GetStdKeyFromHkey(HKEY hkey) +wxRegKey::StdKey wxRegKey::GetStdKeyFromHkey(WXHKEY hkey) { - for ( uint ui = 0; ui < nStdKeys; ui++ ) { - if ( aStdKeys[ui].hkey == hkey ) + for ( size_t ui = 0; ui < nStdKeys; ui++ ) { + if ( (int) aStdKeys[ui].hkey == (int) 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; } @@ -184,25 +188,25 @@ wxRegKey::StdKey wxRegKey::GetStdKeyFromHkey(HKEY hkey) wxRegKey::wxRegKey() { - m_hKey = 0; - m_hRootKey = aStdKeys[HKCR].hkey; - m_dwLastError = 0; + m_hRootKey = (WXHKEY) aStdKeys[HKCR].hkey; + + Init(); } wxRegKey::wxRegKey(const wxString& strKey) : m_strKey(strKey) { - m_hRootKey = aStdKeys[ExtractKeyName(m_strKey)].hkey; - m_hKey = NULL; - m_dwLastError = 0; + m_hRootKey = (WXHKEY) aStdKeys[ExtractKeyName(m_strKey)].hkey; + + Init(); } // parent is a predefined (and preopened) key wxRegKey::wxRegKey(StdKey keyParent, const wxString& strKey) : m_strKey(strKey) { RemoveTrailingSeparator(m_strKey); - m_hRootKey = aStdKeys[keyParent].hkey; - m_hKey = NULL; - m_dwLastError = 0; + m_hRootKey = (WXHKEY) aStdKeys[keyParent].hkey; + + Init(); } // parent is a normal regkey @@ -210,15 +214,17 @@ wxRegKey::wxRegKey(const wxRegKey& keyParent, const wxString& strKey) : m_strKey(keyParent.m_strKey) { // combine our name with parent's to get the full name - if ( !strKey.IsEmpty() && strKey[0] != REG_SEPARATOR ) - m_strKey += REG_SEPARATOR; + if ( !m_strKey.IsEmpty() && + (strKey.IsEmpty() || strKey[0] != REG_SEPARATOR) ) { + m_strKey += REG_SEPARATOR; + } m_strKey += strKey; RemoveTrailingSeparator(m_strKey); m_hRootKey = keyParent.m_hRootKey; - m_hKey = NULL; - m_dwLastError = 0; + + Init(); } // dtor closes the key releasing system resource @@ -237,7 +243,7 @@ void wxRegKey::SetName(const wxString& strKey) Close(); m_strKey = strKey; - m_hRootKey = aStdKeys[ExtractKeyName(m_strKey)].hkey; + m_hRootKey = (WXHKEY) aStdKeys[ExtractKeyName(m_strKey)].hkey; } // the name is relative to the parent key @@ -247,7 +253,7 @@ void wxRegKey::SetName(StdKey keyParent, const wxString& strKey) m_strKey = strKey; RemoveTrailingSeparator(m_strKey); - m_hRootKey = aStdKeys[keyParent].hkey; + m_hRootKey = (WXHKEY) aStdKeys[keyParent].hkey; } // the name is relative to the parent key @@ -256,9 +262,17 @@ void wxRegKey::SetName(const wxRegKey& keyParent, const wxString& strKey) Close(); // combine our name with parent's to get the full name - m_strKey = strKey; + + // 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.IsEmpty() && strKey[0] != REG_SEPARATOR ) m_strKey += REG_SEPARATOR; + m_strKey += strKey; RemoveTrailingSeparator(m_strKey); @@ -266,7 +280,7 @@ void wxRegKey::SetName(const wxRegKey& keyParent, const wxString& strKey) } // hKey should be opened and will be closed in wxRegKey dtor -void wxRegKey::SetHkey(HKEY hKey) +void wxRegKey::SetHkey(WXHKEY hKey) { Close(); @@ -277,84 +291,352 @@ void wxRegKey::SetHkey(HKEY hKey) // 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); } // returns the full name of the key (prefix is abbreviated if bShortPrefix) wxString wxRegKey::GetName(bool bShortPrefix) const { - StdKey key = GetStdKeyFromHkey(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; + str << _T("\\") << m_strKey; return str; } +bool wxRegKey::GetKeyInfo(size_t *pnSubKeys, + size_t *pnMaxKeyLen, + size_t *pnValues, + size_t *pnMaxValueLen) const +{ + // old gcc headers incorrectly prototype RegQueryInfoKey() +#if defined(__GNUWIN32_OLD__) && !defined(__CYGWIN10__) + #define REG_PARAM (size_t *) +#else + #define REG_PARAM (LPDWORD) +#endif + + // it might be unexpected to some that this function doesn't open the key + wxASSERT_MSG( IsOpened(), _T("key should be opened in GetKeyInfo") ); + + m_dwLastError = ::RegQueryInfoKey + ( + (HKEY) m_hKey, + NULL, // class name + NULL, // (ptr to) size of class name buffer + RESERVED, + REG_PARAM + pnSubKeys, // [out] number of subkeys + REG_PARAM + pnMaxKeyLen, // [out] max length of a subkey name + NULL, // longest subkey class name + REG_PARAM + pnValues, // [out] number of values + REG_PARAM + pnMaxValueLen, // [out] max length of a value name + NULL, // longest value data + NULL, // security descriptor + NULL // time of last modification + ); + +#undef REG_PARAM + + if ( m_dwLastError != ERROR_SUCCESS ) { + wxLogSysError(m_dwLastError, _("Can't get info about registry key '%s'"), + GetName().c_str()); + return false; + } + + return true; +} + // ---------------------------------------------------------------------------- // operations // ---------------------------------------------------------------------------- // 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; - m_dwLastError = RegOpenKey(m_hRootKey, m_strKey, &m_hKey); - if ( m_dwLastError != ERROR_SUCCESS ) { - wxLogSysError(m_dwLastError, "can't open registry key '%s'", - GetName().c_str()); - return FALSE; - } - else - 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, + 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; + } + + m_hKey = (WXHKEY) tmpKey; + 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; - - m_dwLastError = RegCreateKey(m_hRootKey, m_strKey, &m_hKey); + return true; + + HKEY tmpKey; +#ifdef __WXWINCE__ + DWORD disposition; + m_dwLastError = RegCreateKeyEx((HKEY) m_hRootKey, m_strKey, + NULL, // reserved + NULL, // class string + 0, + 0, + NULL, + &tmpKey, + &disposition); +#else + m_dwLastError = RegCreateKey((HKEY) m_hRootKey, m_strKey, &tmpKey); +#endif 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 - return TRUE; + { + m_hKey = (WXHKEY) tmpKey; + return true; + } } // close the key, it's not an error to call it when not opened bool wxRegKey::Close() { if ( IsOpened() ) { - m_dwLastError = RegCloseKey(m_hKey); + 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 wxChar *szValueOld, const wxChar *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 wxChar *szValue, + wxRegKey& keyDst, + const wxChar *szValueNew) +{ + if ( !szValueNew ) { + // by default, use the same name + szValueNew = szValue; + } + + switch ( GetValueType(szValue) ) { + case Type_String: + { + wxString strVal; + return QueryValue(szValue, strVal) && + keyDst.SetValue(szValueNew, strVal); + } + + case Type_Dword: + /* case Type_Dword_little_endian: == Type_Dword */ + { + long dwVal; + return QueryValue(szValue, &dwVal) && + keyDst.SetValue(szValueNew, dwVal); + } + + case Type_Binary: + { + wxMemoryBuffer buf; + return QueryValue(szValue,buf) && + keyDst.SetValue(szValueNew,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 wxChar *szNewName) +{ + wxCHECK_MSG( !m_strKey.IsEmpty(), false, _T("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.IsEmpty() ) { + // 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); } - } - return TRUE; + 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 ok; +} + +bool wxRegKey::Copy(const wxChar *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((const wxChar*) 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; } // ---------------------------------------------------------------------------- @@ -366,10 +648,22 @@ bool wxRegKey::DeleteSelf() 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() || + ((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; @@ -383,222 +677,305 @@ bool wxRegKey::DeleteSelf() bCont = GetNextKey(strKey, lIndex); } - uint nKeyCount = astrSubkeys.Count(); - for ( uint nKey = 0; nKey < nKeyCount; nKey++ ) { + size_t nKeyCount = astrSubkeys.Count(); + 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(m_hRootKey, m_strKey); - if ( m_dwLastError != ERROR_SUCCESS ) { - wxLogSysError(m_dwLastError, "can't delete key '%s'", GetName().c_str()); - return FALSE; + m_dwLastError = RegDeleteKey((HKEY) m_hRootKey, m_strKey); + // 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 TRUE; + return true; } -bool wxRegKey::DeleteKey(const char *szKey) +bool wxRegKey::DeleteKey(const wxChar *szKey) { if ( !Open() ) - return FALSE; + return false; wxRegKey key(*this, szKey); return key.DeleteSelf(); } -bool wxRegKey::DeleteValue(const char *szValue) +bool wxRegKey::DeleteValue(const wxChar *szValue) { if ( !Open() ) - return FALSE; + return false; - #ifdef __WIN32__ - m_dwLastError = RegDeleteValue(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, WXSTRINGCAST szValue); - // just set the (default and unique) value of the key to "" - m_dwLastError = RegSetValue(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 wxChar *szValue) const { - #ifdef __WIN32__ - if ( CONST_CAST Open() ) { - return RegQueryValueEx(m_hKey, szValue, RESERVED, - NULL, NULL, NULL) == ERROR_SUCCESS; - } - else - return FALSE; - #else // WIN16 - // only unnamed value exists - return IsEmpty(szValue); - #endif // WIN16/32 + // 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, + WXSTRINGCAST 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; + + // 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 wxChar *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); } -wxRegKey::ValueType wxRegKey::GetValueType(const char *szValue) +wxRegKey::ValueType wxRegKey::GetValueType(const wxChar *szValue) const { - #ifdef __WIN32__ - if ( !Open() ) + if ( ! CONST_CAST Open(Read) ) return Type_None; DWORD dwType; - m_dwLastError = RegQueryValueEx(m_hKey, szValue, RESERVED, + m_dwLastError = RegQueryValueEx((HKEY) m_hKey, WXSTRINGCAST 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 wxChar *szValue, long lValue) { if ( CONST_CAST Open() ) { - m_dwLastError = RegSetValueEx(m_hKey, szValue, RESERVED, REG_DWORD, + m_dwLastError = RegSetValueEx((HKEY) m_hKey, 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 wxChar *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(m_hKey, szValue, RESERVED, + m_dwLastError = RegQueryValueEx((HKEY) m_hKey, WXSTRINGCAST 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::SetValue(const wxChar *szValue,const wxMemoryBuffer& buffer) +{ +#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_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 char *szValue, wxString& strValue) const +bool wxRegKey::QueryValue(const wxChar *szValue, wxMemoryBuffer& buffer) const { 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 ) { + const RegBinary pBuf = (RegBinary)buffer.GetWriteBuf(dwSize); + m_dwLastError = RegQueryValueEx((HKEY) m_hKey, + WXSTRINGCAST szValue, + RESERVED, + &dwType, + pBuf, + &dwSize); + 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; +} + + + +bool wxRegKey::QueryValue(const wxChar *szValue, + wxString& strValue, + bool raw) const +{ + if ( CONST_CAST Open(Read) ) { + // first get the type and size of the data DWORD dwType, dwSize; - m_dwLastError = RegQueryValueEx(m_hKey, szValue, RESERVED, + m_dwLastError = RegQueryValueEx((HKEY) m_hKey, WXSTRINGCAST szValue, RESERVED, &dwType, NULL, &dwSize); if ( m_dwLastError == ERROR_SUCCESS ) { - RegString pBuf = (RegString)strValue.GetWriteBuf(dwSize); - m_dwLastError = RegQueryValueEx(m_hKey, szValue, RESERVED, - &dwType, pBuf, &dwSize); + 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, + WXSTRINGCAST 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, NULL, 0); + bool ok = dwExpSize != 0; + if ( ok ) + { + wxString strExpValue; + ok = ::ExpandEnvironmentStrings + ( + strValue, + wxStringBuffer(strExpValue, dwExpSize), + dwExpSize + ) != 0; + strValue = strExpValue; + } + + if ( !ok ) + { + wxLogLastError(_T("ExpandEnvironmentStrings")); + } + } +#else + wxUnusedVar(raw); +#endif + // __WXWINCE__ + } + if ( m_dwLastError == ERROR_SUCCESS ) { // check that it was the right type - wxASSERT_MSG( dwType == REG_SZ, - "Type mismatch in wxRegKey::QueryValue()." ); + 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(m_hKey, 0, strValue.GetWriteBuf(256), &l); - if ( m_dwLastError == ERROR_SUCCESS ) - return TRUE; - #endif //WIN16/32 } - wxLogSysError(m_dwLastError, "can't read value of '%s'", + wxLogSysError(m_dwLastError, _("Can't read value of '%s'"), GetFullName(this, szValue)); - return FALSE; + return false; } -bool wxRegKey::SetValue(const char *szValue, const wxString& strValue) +bool wxRegKey::SetValue(const wxChar *szValue, const wxString& strValue) { if ( CONST_CAST Open() ) { - #ifdef __WIN32__ - m_dwLastError = RegSetValueEx(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(m_hKey, NULL, REG_SZ, strValue, NULL); + m_dwLastError = RegSetValueEx((HKEY) m_hKey, szValue, (DWORD) RESERVED, REG_SZ, + (RegString)strValue.c_str(), + (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); @@ -613,8 +990,8 @@ wxRegKey::operator wxString() const bool wxRegKey::GetFirstValue(wxString& strValueName, long& lIndex) { - if ( !Open() ) - return FALSE; + if ( !Open(Read) ) + return false; lIndex = 0; return GetNextValue(strValueName, lIndex); @@ -626,17 +1003,15 @@ bool wxRegKey::GetNextValue(wxString& strValueName, long& lIndex) const // 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(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 @@ -646,29 +1021,22 @@ bool wxRegKey::GetNextValue(wxString& strValueName, long& lIndex) const 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); @@ -680,10 +1048,17 @@ bool wxRegKey::GetNextKey(wxString& strKeyName, long& lIndex) const // are we already at the end of enumeration? if ( lIndex == -1 ) - return FALSE; + return false; - char szKeyName[_MAX_PATH + 1]; - m_dwLastError = RegEnumKey(m_hKey, lIndex++, szKeyName, WXSIZEOF(szKeyName)); + 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 ) { @@ -691,37 +1066,331 @@ bool wxRegKey::GetNextKey(wxString& strKeyName, long& lIndex) const 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; +} + +// 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 ) { + case Type_Dword: + /* case Type_Dword_little_endian: == Type_Dword */ + case Type_Dword_big_endian: + return true; + + default: + return false; + } +} + +// ---------------------------------------------------------------------------- +// exporting registry keys to file +// ---------------------------------------------------------------------------- + +// 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, s.length()); +#endif + + return ostr.IsOk(); +} + +bool wxRegKey::Export(const wxString& filename) const +{ + 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); +} + +bool wxRegKey::Export(wxOutputStream& ostr) const +{ + // write out the header + if ( !WriteAsciiString(ostr, "REGEDIT4\n\n") ) + return false; + + return DoExport(ostr); +} + +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 ( const wxChar *p = value.c_str(); *p && !useHex; p++ ) + { + switch ( *p ) + { + 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; +} + +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; } // ============================================================================ -// implementation of global functions +// implementation of global private functions // ============================================================================ -bool KeyExists(HKEY hRootKey, const char *szKey) + +bool KeyExists(WXHKEY hRootKey, const wxChar *szKey) { - HKEY hkeyDummy; - if ( RegOpenKey(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 ( wxIsEmpty(szKey) ) + return true; + + HKEY hkeyDummy; + if ( ::RegOpenKeyEx + ( + (HKEY)hRootKey, + szKey, + RESERVED, + KEY_READ, // we might not have enough rights for rw access + &hkeyDummy + ) == ERROR_SUCCESS ) + { + ::RegCloseKey(hkeyDummy); + + return true; + } + + return false; } -const char *GetFullName(const wxRegKey *pKey, const char *szValue) +const wxChar *GetFullName(const wxRegKey *pKey, const wxChar *szValue) { static wxString s_str; s_str = pKey->GetName(); - if ( !IsEmpty(szValue) ) - s_str << "\\" << szValue; + if ( !wxIsEmpty(szValue) ) + s_str << wxT("\\") << szValue; return s_str.c_str(); } @@ -731,3 +1400,4 @@ void RemoveTrailingSeparator(wxString& str) if ( !str.IsEmpty() && str.Last() == REG_SEPARATOR ) str.Truncate(str.Len() - 1); } +