X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23f681ec4840b44e265e6f71beef5a242306220b..bd947cc9f002826c01e1413e36c5ae99fc6124a8:/src/msw/registry.cpp diff --git a/src/msw/registry.cpp b/src/msw/registry.cpp index 55b6946d0d..8305c63eb8 100644 --- a/src/msw/registry.cpp +++ b/src/msw/registry.cpp @@ -6,13 +6,13 @@ // 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, ...) /////////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma implementation "registry.h" #endif @@ -27,7 +27,6 @@ #include "wx/string.h" #include "wx/intl.h" #include "wx/log.h" -#include "wx/config.h" // for wxExpandEnvVars #ifndef __WIN16__ @@ -37,13 +36,19 @@ #define WIN32_LEAN_AND_MEAN */ -#include +#include "wx/msw/wrapwin.h" + +#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 @@ -72,10 +77,12 @@ aStdKeys[] = { 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") }, -#if WINVER >= 0x0400 +#endif +#if WINVER >= 0x0400 && !defined(__WXWINCE__) { HKEY_CURRENT_CONFIG, wxT("HKEY_CURRENT_CONFIG"), wxT("HKCC") }, -#ifndef __GNUWIN32__ +#if !defined(__GNUWIN32__) && !defined(__WXWINCE__) { HKEY_DYN_DATA, wxT("HKEY_DYN_DATA"), wxT("HKDD") }, // short name? #endif //GNUWIN32 #endif //WINVER >= 4.0 @@ -87,17 +94,17 @@ aStdKeys[] = // 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 @@ -128,7 +135,7 @@ const size_t wxRegKey::nStdKeys = WXSIZEOF(aStdKeys); 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; } @@ -136,14 +143,14 @@ const wxChar *wxRegKey::GetStdKeyName(size_t key) 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; } wxRegKey::StdKey wxRegKey::ExtractKeyName(wxString& strKey) { - wxString strRoot = strKey.Left(REG_SEPARATOR); + wxString strRoot = strKey.BeforeFirst(REG_SEPARATOR); HKEY hRootKey = 0; size_t ui; @@ -187,16 +194,16 @@ wxRegKey::StdKey wxRegKey::GetStdKeyFromHkey(WXHKEY hkey) wxRegKey::wxRegKey() { - m_hKey = 0; m_hRootKey = (WXHKEY) aStdKeys[HKCR].hkey; - m_dwLastError = 0; + + Init(); } wxRegKey::wxRegKey(const wxString& strKey) : m_strKey(strKey) { m_hRootKey = (WXHKEY) aStdKeys[ExtractKeyName(m_strKey)].hkey; - m_hKey = (WXHKEY) NULL; - m_dwLastError = 0; + + Init(); } // parent is a predefined (and preopened) key @@ -204,8 +211,8 @@ wxRegKey::wxRegKey(StdKey keyParent, const wxString& strKey) : m_strKey(strKey) { RemoveTrailingSeparator(m_strKey); m_hRootKey = (WXHKEY) aStdKeys[keyParent].hkey; - m_hKey = (WXHKEY) NULL; - m_dwLastError = 0; + + Init(); } // parent is a normal regkey @@ -222,8 +229,8 @@ wxRegKey::wxRegKey(const wxRegKey& keyParent, const wxString& strKey) RemoveTrailingSeparator(m_strKey); m_hRootKey = keyParent.m_hRootKey; - m_hKey = (WXHKEY) NULL; - m_dwLastError = 0; + + Init(); } // dtor closes the key releasing system resource @@ -261,7 +268,14 @@ void wxRegKey::SetName(const wxRegKey& keyParent, const wxString& strKey) Close(); // combine our name with parent's to get the full name - m_strKey = keyParent.m_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; @@ -293,11 +307,11 @@ bool wxRegKey::Exists() const // 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() ) - str << "\\" << m_strKey; + str << _T("\\") << m_strKey; return str; } @@ -307,15 +321,18 @@ bool wxRegKey::GetKeyInfo(size_t *pnSubKeys, size_t *pnValues, size_t *pnMaxValueLen) const { -#if defined(__WIN32__) && !defined(__TWIN32__) +#if defined(__WIN32__) // old gcc headers incorrectly prototype RegQueryInfoKey() -#ifdef __GNUWIN32_OLD__ +#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, @@ -343,8 +360,8 @@ bool wxRegKey::GetKeyInfo(size_t *pnSubKeys, GetName().c_str()); return FALSE; } - else - return TRUE; + + return TRUE; #else // Win16 wxFAIL_MSG("GetKeyInfo() not implemented"); @@ -359,36 +376,54 @@ bool wxRegKey::GetKeyInfo(size_t *pnSubKeys, // opens key (it's not an error to call Open() on an already opened key) bool wxRegKey::Open() { - if ( IsOpened() ) - return TRUE; + if ( IsOpened() ) + return TRUE; + + HKEY tmpKey; + m_dwLastError = ::RegOpenKeyEx + ( + (HKEY) m_hRootKey, + m_strKey, + RESERVED, + 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; - } } // 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() ) { + if ( !bOkIfExists && Exists() ) return FALSE; - } if ( IsOpened() ) 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'"), GetName().c_str()); @@ -406,16 +441,14 @@ bool wxRegKey::Close() { 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'"), GetName().c_str()); - m_hKey = 0; return FALSE; } - else { - m_hKey = 0; - } } return TRUE; @@ -430,7 +463,9 @@ bool wxRegKey::RenameValue(const wxChar *szValueOld, const wxChar *szValueNew) ok = FALSE; } - if ( !ok || !CopyValue(szValueOld, *this, szValueNew) ) { + if ( !ok || + !CopyValue(szValueOld, *this, szValueNew) || + !DeleteValue(szValueOld) ) { wxLogError(_("Failed to rename registry value '%s' to '%s'."), szValueOld, szValueNew); @@ -444,6 +479,11 @@ 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: { @@ -482,10 +522,65 @@ bool wxRegKey::CopyValue(const wxChar *szValue, } } -bool wxRegKey::Copy(const wxString& strNewName) +bool wxRegKey::Rename(const wxChar *szNewName) +{ + wxCHECK_MSG( !!m_strKey, 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 ) { + // don't add '\\' in the start if strFullNewName is empty + strKey += REG_SEPARATOR; + } + + strKey += szNewName; + + keyDst.SetName(GetStdKeyFromHkey(m_hRootKey), strKey); + } + else { + // 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 ok; +} + +bool wxRegKey::Copy(const wxChar *szNewName) { // create the new key first - wxRegKey keyDst(strNewName); + wxRegKey keyDst(szNewName); bool ok = keyDst.Create(FALSE /* fail if alredy exists */); if ( ok ) { ok = Copy(keyDst); @@ -511,7 +606,7 @@ bool wxRegKey::Copy(wxRegKey& keyDst) wxRegKey key(*this, strKey); wxString keyName; keyName << GetFullName(&keyDst) << REG_SEPARATOR << strKey; - ok = key.Copy(keyName); + ok = key.Copy((const wxChar*) keyName); if ( ok ) bCont = GetNextKey(strKey, lIndex); @@ -534,8 +629,7 @@ bool wxRegKey::Copy(wxRegKey& keyDst) } 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; @@ -557,11 +651,10 @@ bool wxRegKey::DeleteSelf() // 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 != HKCR && - m_strKey.Find(REG_SEPARATOR) == wxNOT_FOUND) ) { - wxLogError(_("Registry key '%s' is needed for normal system operation,\n" - "deleting it will leave your system in unusable state:\n" - "operation aborted."), GetFullName(this)); + 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; } @@ -613,14 +706,17 @@ bool wxRegKey::DeleteValue(const wxChar *szValue) if ( !Open() ) return FALSE; -#if defined(__WIN32__) && !defined(__TWIN32__) +#if defined(__WIN32__) m_dwLastError = RegDeleteValue((HKEY) m_hKey, WXSTRINGCAST szValue); - if ( m_dwLastError != ERROR_SUCCESS ) { + + // 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 +#else //WIN16 // named registry values don't exist in Win16 world wxASSERT( IsEmpty(szValue) ); @@ -631,7 +727,7 @@ bool wxRegKey::DeleteValue(const wxChar *szValue) GetName().c_str()); return FALSE; } - #endif //WIN16/32 +#endif //WIN16/32 return TRUE; } @@ -647,12 +743,14 @@ bool wxRegKey::HasValue(const wxChar *szValue) const wxLogNull nolog; #ifdef __WIN32__ - if ( CONST_CAST Open() ) { - return RegQueryValueEx((HKEY) m_hKey, WXSTRINGCAST szValue, RESERVED, - NULL, NULL, NULL) == ERROR_SUCCESS; - } - else - return FALSE; + if ( !CONST_CAST Open() ) + return FALSE; + + LONG dwRet = ::RegQueryValueEx((HKEY) m_hKey, + WXSTRINGCAST szValue, + RESERVED, + NULL, NULL, NULL); + return dwRet == ERROR_SUCCESS; #else // WIN16 // only unnamed value exists return IsEmpty(szValue); @@ -689,10 +787,10 @@ bool wxRegKey::HasSubKey(const wxChar *szKey) const // this function should be silent, so suppress possible messages from Open() wxLogNull nolog; - if ( CONST_CAST Open() ) - return KeyExists(m_hKey, szKey); - else + if ( !CONST_CAST Open() ) return FALSE; + + return KeyExists(m_hKey, szKey); } wxRegKey::ValueType wxRegKey::GetValueType(const wxChar *szValue) const @@ -719,10 +817,6 @@ wxRegKey::ValueType wxRegKey::GetValueType(const wxChar *szValue) const #ifdef __WIN32__ bool wxRegKey::SetValue(const wxChar *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, (RegString)&lValue, sizeof(lValue)); @@ -733,7 +827,6 @@ bool wxRegKey::SetValue(const wxChar *szValue, long lValue) wxLogSysError(m_dwLastError, _("Can't set value of '%s'"), GetFullName(this, szValue)); return FALSE; -#endif } bool wxRegKey::QueryValue(const wxChar *szValue, long *plValue) const @@ -762,7 +855,9 @@ bool wxRegKey::QueryValue(const wxChar *szValue, long *plValue) const #endif //Win32 -bool wxRegKey::QueryValue(const wxChar *szValue, wxString& strValue) const +bool wxRegKey::QueryValue(const wxChar *szValue, + wxString& strValue, + bool raw) const { if ( CONST_CAST Open() ) { #ifdef __WIN32__ @@ -777,14 +872,38 @@ bool wxRegKey::QueryValue(const wxChar *szValue, wxString& strValue) const strValue.Empty(); } else { - RegString pBuf = (RegString)strValue.GetWriteBuf(dwSize); m_dwLastError = RegQueryValueEx((HKEY) m_hKey, WXSTRINGCAST szValue, RESERVED, &dwType, - pBuf, + (RegString)(wxChar*)wxStringBuffer(strValue, dwSize), &dwSize); - strValue.UngetWriteBuf(); + + // 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")); + } + } +#endif + // __WXWINCE__ } if ( m_dwLastError == ERROR_SUCCESS ) { @@ -814,20 +933,20 @@ bool wxRegKey::QueryValue(const wxChar *szValue, wxString& strValue) const bool wxRegKey::SetValue(const wxChar *szValue, const wxString& strValue) { if ( CONST_CAST Open() ) { -#if defined( __WIN32__) && !defined(__TWIN32__) +#if defined( __WIN32__) m_dwLastError = RegSetValueEx((HKEY) m_hKey, szValue, (DWORD) RESERVED, REG_SZ, (RegString)strValue.c_str(), - strValue.Len() + 1); + (strValue.Len() + 1)*sizeof(wxChar)); if ( m_dwLastError == ERROR_SUCCESS ) return TRUE; - #else //WIN16 +#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 +#endif //WIN16/32 } wxLogSysError(m_dwLastError, _("Can't set value of '%s'"), @@ -835,7 +954,7 @@ bool wxRegKey::SetValue(const wxChar *szValue, const wxString& strValue) return FALSE; } -wxRegKey::operator wxString() const +wxString wxRegKey::QueryDefaultValue() const { wxString str; QueryValue(NULL, str); @@ -865,7 +984,7 @@ bool wxRegKey::GetNextValue(wxString& strValueName, long& lIndex) const if ( lIndex == -1 ) return FALSE; -#if defined( __WIN32__) && !defined(__TWIN32__) +#if defined( __WIN32__) wxChar szValueName[1024]; // @@ use RegQueryInfoKey... DWORD dwValueLen = WXSIZEOF(szValueName); @@ -890,13 +1009,13 @@ bool wxRegKey::GetNextValue(wxString& strValueName, long& lIndex) const } strValueName = szValueName; - #else //WIN16 +#else //WIN16 // only one unnamed value wxASSERT( lIndex == 0 ); lIndex = -1; strValueName.Empty(); - #endif +#endif return TRUE; } @@ -919,7 +1038,14 @@ bool wxRegKey::GetNextKey(wxString& strKeyName, long& lIndex) const 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 ) { @@ -956,14 +1082,28 @@ bool wxRegKey::IsNumericValue(const wxChar *szValue) const // ============================================================================ // implementation of global private functions // ============================================================================ + bool KeyExists(WXHKEY hRootKey, const wxChar *szKey) { - HKEY hkeyDummy; - if ( RegOpenKey( (HKEY) hRootKey, szKey, &hkeyDummy) == ERROR_SUCCESS ) { - RegCloseKey(hkeyDummy); - return TRUE; - } - else + // 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_ALL_ACCESS, + &hkeyDummy + ) == ERROR_SUCCESS ) + { + ::RegCloseKey(hkeyDummy); + + return TRUE; + } + return FALSE; }