X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/007007c5e4da49affb67de71524372ab8706dd36..2d0c2e79c27e46a238cf44562fb98c99e65d79b4:/src/msw/registry.cpp diff --git a/src/msw/registry.cpp b/src/msw/registry.cpp index 188b50632b..276e481c52 100644 --- a/src/msw/registry.cpp +++ b/src/msw/registry.cpp @@ -12,7 +12,7 @@ // - add high level functions (RegisterOleServer, ...) /////////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma implementation "registry.h" #endif @@ -23,20 +23,18 @@ #pragma hdrstop #endif -// other wxWindows headers +// other wxWidgets headers #include "wx/string.h" #include "wx/intl.h" #include "wx/log.h" -#ifndef __WIN16__ - // Windows headers /* #define STRICT #define WIN32_LEAN_AND_MEAN */ -#include +#include "wx/msw/wrapwin.h" #ifdef __WXWINCE__ #include "wx/msw/private.h" @@ -57,6 +55,7 @@ // some registry functions don't like signed chars typedef unsigned char *RegString; +typedef BYTE* RegBinary; // ---------------------------------------------------------------------------- // constants @@ -113,7 +112,7 @@ 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 +// returns true if given registry key exists static bool KeyExists(WXHKEY hRootKey, const wxChar *szKey); // combines value and key name (uses static buffer!) @@ -297,11 +296,11 @@ void wxRegKey::SetHkey(WXHKEY 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) @@ -321,8 +320,6 @@ bool wxRegKey::GetKeyInfo(size_t *pnSubKeys, size_t *pnValues, size_t *pnMaxValueLen) const { -#if defined(__WIN32__) - // old gcc headers incorrectly prototype RegQueryInfoKey() #if defined(__GNUWIN32_OLD__) && !defined(__CYGWIN10__) #define REG_PARAM (size_t *) @@ -358,15 +355,10 @@ bool wxRegKey::GetKeyInfo(size_t *pnSubKeys, if ( m_dwLastError != ERROR_SUCCESS ) { wxLogSysError(m_dwLastError, _("Can't get info about registry key '%s'"), GetName().c_str()); - return FALSE; + return false; } - return TRUE; -#else // Win16 - wxFAIL_MSG("GetKeyInfo() not implemented"); - - return FALSE; -#endif + return true; } // ---------------------------------------------------------------------------- @@ -374,10 +366,10 @@ bool wxRegKey::GetKeyInfo(size_t *pnSubKeys, // ---------------------------------------------------------------------------- // 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; + return true; HKEY tmpKey; m_dwLastError = ::RegOpenKeyEx @@ -385,7 +377,7 @@ bool wxRegKey::Open() (HKEY) m_hRootKey, m_strKey, RESERVED, - KEY_ALL_ACCESS, + mode == Read ? KEY_READ : KEY_ALL_ACCESS, &tmpKey ); @@ -393,11 +385,11 @@ bool wxRegKey::Open() { wxLogSysError(m_dwLastError, _("Can't open registry key '%s'"), GetName().c_str()); - return FALSE; + return false; } m_hKey = (WXHKEY) tmpKey; - return TRUE; + return true; } // creates key, failing if it exists and !bOkIfExists @@ -405,10 +397,10 @@ bool wxRegKey::Create(bool bOkIfExists) { // check for existence only if asked (i.e. order is important!) if ( !bOkIfExists && Exists() ) - return FALSE; + return false; if ( IsOpened() ) - return TRUE; + return true; HKEY tmpKey; #ifdef __WXWINCE__ @@ -427,12 +419,12 @@ bool wxRegKey::Create(bool bOkIfExists) if ( m_dwLastError != ERROR_SUCCESS ) { wxLogSysError(m_dwLastError, _("Can't create registry key '%s'"), GetName().c_str()); - return FALSE; + return false; } else { m_hKey = (WXHKEY) tmpKey; - return TRUE; + return true; } } @@ -447,20 +439,20 @@ bool wxRegKey::Close() wxLogSysError(m_dwLastError, _("Can't close registry key '%s'"), GetName().c_str()); - return FALSE; + return false; } } - return TRUE; + return true; } bool wxRegKey::RenameValue(const wxChar *szValueOld, const wxChar *szValueNew) { - bool ok = TRUE; + bool ok = true; if ( HasValue(szValueNew) ) { wxLogError(_("Registry value '%s' already exists."), szValueNew); - ok = FALSE; + ok = false; } if ( !ok || @@ -469,10 +461,10 @@ bool wxRegKey::RenameValue(const wxChar *szValueOld, const wxChar *szValueNew) wxLogError(_("Failed to rename registry value '%s' to '%s'."), szValueOld, szValueNew); - return FALSE; + return false; } - return TRUE; + return true; } bool wxRegKey::CopyValue(const wxChar *szValue, @@ -500,14 +492,19 @@ bool wxRegKey::CopyValue(const wxChar *szValue, keyDst.SetValue(szValueNew, dwVal); } +#ifdef __WIN32__ + 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) -#ifdef __WIN32__ case Type_None: case Type_Expand_String: - case Type_Binary: case Type_Dword_big_endian: case Type_Link: case Type_Multi_String: @@ -518,19 +515,19 @@ bool wxRegKey::CopyValue(const wxChar *szValue, default: wxLogError(_("Can't copy values of unsupported type %d."), GetValueType(szValue)); - return FALSE; + return false; } } bool wxRegKey::Rename(const wxChar *szNewName) { - wxCHECK_MSG( !!m_strKey, FALSE, _T("registry hives can't be renamed") ); + 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; + return false; } // do we stay in the same hive? @@ -542,7 +539,7 @@ bool wxRegKey::Rename(const wxChar *szNewName) if ( inSameHive ) { // rename the key to the new name under the same parent wxString strKey = m_strKey.BeforeLast(REG_SEPARATOR); - if ( !!strKey ) { + if ( !strKey.IsEmpty() ) { // don't add '\\' in the start if strFullNewName is empty strKey += REG_SEPARATOR; } @@ -556,7 +553,7 @@ bool wxRegKey::Rename(const wxChar *szNewName) keyDst.SetName(szNewName); } - bool ok = keyDst.Create(FALSE /* fail if alredy exists */); + bool ok = keyDst.Create(false /* fail if alredy exists */); if ( !ok ) { wxLogError(_("Registry key '%s' already exists."), GetFullName(&keyDst)); @@ -581,7 +578,7 @@ bool wxRegKey::Copy(const wxChar *szNewName) { // create the new key first wxRegKey keyDst(szNewName); - bool ok = keyDst.Create(FALSE /* fail if alredy exists */); + bool ok = keyDst.Create(false /* fail if alredy exists */); if ( ok ) { ok = Copy(keyDst); @@ -596,7 +593,7 @@ bool wxRegKey::Copy(const wxChar *szNewName) bool wxRegKey::Copy(wxRegKey& keyDst) { - bool ok = TRUE; + bool ok = true; // copy all sub keys to the new location wxString strKey; @@ -610,6 +607,10 @@ bool wxRegKey::Copy(wxRegKey& keyDst) 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 @@ -629,7 +630,8 @@ 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; @@ -644,7 +646,7 @@ bool wxRegKey::DeleteSelf() wxLogNull nolog; if ( !Open() ) { // it already doesn't exist - ok! - return TRUE; + return true; } } @@ -654,9 +656,10 @@ bool wxRegKey::DeleteSelf() 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)); + wxLogError(_("Registry key '%s' is needed for normal system operation,\ndeleting it will leave your system in unusable state:\noperation aborted."), + GetFullName(this)); - return FALSE; + return false; } // we can't delete keys while enumerating because it confuses GetNextKey, so @@ -676,26 +679,28 @@ bool wxRegKey::DeleteSelf() 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 ) { + // deleting a key which doesn't exist is not considered an error + if ( m_dwLastError != ERROR_SUCCESS && + m_dwLastError != ERROR_FILE_NOT_FOUND ) { wxLogSysError(m_dwLastError, _("Can't delete key '%s'"), GetName().c_str()); - return FALSE; + return false; } - return TRUE; + return true; } bool wxRegKey::DeleteKey(const wxChar *szKey) { if ( !Open() ) - return FALSE; + return false; wxRegKey key(*this, szKey); return key.DeleteSelf(); @@ -704,9 +709,8 @@ bool wxRegKey::DeleteKey(const wxChar *szKey) bool wxRegKey::DeleteValue(const wxChar *szValue) { if ( !Open() ) - return FALSE; + return false; -#if defined(__WIN32__) m_dwLastError = RegDeleteValue((HKEY) m_hKey, WXSTRINGCAST szValue); // deleting a value which doesn't exist is not considered an error @@ -714,50 +718,33 @@ bool wxRegKey::DeleteValue(const wxChar *szValue) (m_dwLastError != ERROR_FILE_NOT_FOUND) ) { wxLogSysError(m_dwLastError, _("Can't delete value '%s' from key '%s'"), szValue, GetName().c_str()); - return FALSE; + return false; } -#else //WIN16 - // named registry values don't exist in Win16 world - wxASSERT( IsEmpty(szValue) ); - // just set the (default and unique) value of the key to "" - m_dwLastError = RegSetValue((HKEY) m_hKey, NULL, REG_SZ, "", RESERVED); - if ( m_dwLastError != ERROR_SUCCESS ) { - wxLogSysError(m_dwLastError, _("Can't delete value of key '%s'"), - GetName().c_str()); - return FALSE; - } -#endif //WIN16/32 - - return TRUE; + return true; } // ---------------------------------------------------------------------------- // access to values and subkeys // ---------------------------------------------------------------------------- -// return TRUE if value exists +// return true if value exists bool wxRegKey::HasValue(const wxChar *szValue) const { // this function should be silent, so suppress possible messages from Open() wxLogNull nolog; - #ifdef __WIN32__ - if ( !CONST_CAST Open() ) - return FALSE; + if ( !CONST_CAST Open(Read) ) + return false; LONG dwRet = ::RegQueryValueEx((HKEY) m_hKey, WXSTRINGCAST szValue, RESERVED, NULL, NULL, NULL); return dwRet == ERROR_SUCCESS; - #else // WIN16 - // only unnamed value exists - return IsEmpty(szValue); - #endif // WIN16/32 } -// returns TRUE if this key has any values +// returns true if this key has any values bool wxRegKey::HasValues() const { // suppress possible messages from GetFirstValue() @@ -769,7 +756,7 @@ bool wxRegKey::HasValues() const 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() @@ -781,22 +768,21 @@ bool wxRegKey::HasSubkeys() const return CONST_CAST GetFirstKey(str, l); } -// returns TRUE if given subkey exists +// returns true if given subkey exists 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 FALSE; + if ( !CONST_CAST Open(Read) ) + return false; return KeyExists(m_hKey, szKey); } wxRegKey::ValueType wxRegKey::GetValueType(const wxChar *szValue) const { - #ifdef __WIN32__ - if ( ! CONST_CAST Open() ) + if ( ! CONST_CAST Open(Read) ) return Type_None; DWORD dwType; @@ -809,9 +795,6 @@ wxRegKey::ValueType wxRegKey::GetValueType(const wxChar *szValue) const } return (ValueType)dwType; - #else //WIN16 - return IsEmpty(szValue) ? Type_String : Type_None; - #endif //WIN16/32 } #ifdef __WIN32__ @@ -821,17 +804,17 @@ bool wxRegKey::SetValue(const wxChar *szValue, long lValue) 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'"), GetFullName(this, szValue)); - return FALSE; + return false; } 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((HKEY) m_hKey, WXSTRINGCAST szValue, RESERVED, @@ -839,28 +822,83 @@ bool wxRegKey::QueryValue(const wxChar *szValue, long *plValue) const if ( m_dwLastError != ERROR_SUCCESS ) { wxLogSysError(m_dwLastError, _("Can't read value of key '%s'"), GetName().c_str()); - return FALSE; + return false; } else { // check that we read the value of right type wxASSERT_MSG( IsNumericValue(szValue), wxT("Type mismatch in wxRegKey::QueryValue().") ); - return TRUE; + return true; } } else - return FALSE; + return false; +} + +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 wxChar *szValue, wxMemoryBuffer& buffer) const +{ + if ( CONST_CAST Open() ) { + // 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; } + + #endif //Win32 bool wxRegKey::QueryValue(const wxChar *szValue, wxString& strValue, bool raw) const { - if ( CONST_CAST Open() ) { - #ifdef __WIN32__ + if ( CONST_CAST Open(Read) ) { + // first get the type and size of the data DWORD dwType, dwSize; m_dwLastError = RegQueryValueEx((HKEY) m_hKey, WXSTRINGCAST szValue, RESERVED, @@ -872,14 +910,12 @@ bool wxRegKey::QueryValue(const wxChar *szValue, 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__ @@ -893,10 +929,9 @@ bool wxRegKey::QueryValue(const wxChar *szValue, ok = ::ExpandEnvironmentStrings ( strValue, - strExpValue.GetWriteBuf(dwExpSize), + wxStringBuffer(strExpValue, dwExpSize), dwExpSize ) != 0; - strExpValue.UngetWriteBuf(); strValue = strExpValue; } @@ -905,6 +940,8 @@ bool wxRegKey::QueryValue(const wxChar *szValue, wxLogLastError(_T("ExpandEnvironmentStrings")); } } +#else + wxUnusedVar(raw); #endif // __WXWINCE__ } @@ -914,47 +951,29 @@ bool wxRegKey::QueryValue(const wxChar *szValue, wxASSERT_MSG( !IsNumericValue(szValue), wxT("Type mismatch in wxRegKey::QueryValue().") ); - return TRUE; + return true; } } - #else //WIN16 - // named registry values don't exist in Win16 - wxASSERT( IsEmpty(szValue) ); - - m_dwLastError = RegQueryValue((HKEY) m_hKey, 0, strValue.GetWriteBuf(256), &l); - strValue.UngetWriteBuf(); - if ( m_dwLastError == ERROR_SUCCESS ) - return TRUE; - #endif //WIN16/32 } wxLogSysError(m_dwLastError, _("Can't read value of '%s'"), GetFullName(this, szValue)); - return FALSE; + return false; } bool wxRegKey::SetValue(const wxChar *szValue, const wxString& strValue) { if ( CONST_CAST Open() ) { -#if defined( __WIN32__) 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; -#else //WIN16 - // named registry values don't exist in Win16 - wxASSERT( IsEmpty(szValue) ); - - m_dwLastError = RegSetValue((HKEY) m_hKey, NULL, REG_SZ, strValue, NULL); - if ( m_dwLastError == ERROR_SUCCESS ) - return TRUE; -#endif //WIN16/32 + return true; } wxLogSysError(m_dwLastError, _("Can't set value of '%s'"), GetFullName(this, szValue)); - return FALSE; + return false; } wxString wxRegKey::QueryDefaultValue() const @@ -972,8 +991,8 @@ wxString wxRegKey::QueryDefaultValue() const bool wxRegKey::GetFirstValue(wxString& strValueName, long& lIndex) { - if ( !Open() ) - return FALSE; + if ( !Open(Read) ) + return false; lIndex = 0; return GetNextValue(strValueName, lIndex); @@ -985,9 +1004,8 @@ bool wxRegKey::GetNextValue(wxString& strValueName, long& lIndex) const // are we already at the end of enumeration? if ( lIndex == -1 ) - return FALSE; + return false; -#if defined( __WIN32__) wxChar szValueName[1024]; // @@ use RegQueryInfoKey... DWORD dwValueLen = WXSIZEOF(szValueName); @@ -1008,25 +1026,18 @@ bool wxRegKey::GetNextValue(wxString& strValueName, long& lIndex) const 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); @@ -1038,7 +1049,7 @@ bool wxRegKey::GetNextKey(wxString& strKeyName, long& lIndex) const // are we already at the end of enumeration? if ( lIndex == -1 ) - return FALSE; + return false; wxChar szKeyName[_MAX_PATH + 1]; @@ -1060,27 +1071,27 @@ bool wxRegKey::GetNextKey(wxString& strKeyName, long& lIndex) const 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) +// 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 ) { +{ + ValueType type = GetValueType(szValue); + switch ( type ) { case Type_Dword: /* case Type_Dword_little_endian: == Type_Dword */ case Type_Dword_big_endian: - return TRUE; + return true; default: - return FALSE; - } - } + return false; + } +} // ============================================================================ // implementation of global private functions @@ -1090,7 +1101,7 @@ bool KeyExists(WXHKEY hRootKey, const wxChar *szKey) { // don't close this key itself for the case of empty szKey! if ( wxIsEmpty(szKey) ) - return TRUE; + return true; HKEY hkeyDummy; if ( ::RegOpenKeyEx @@ -1098,16 +1109,16 @@ bool KeyExists(WXHKEY hRootKey, const wxChar *szKey) (HKEY)hRootKey, szKey, RESERVED, - KEY_ALL_ACCESS, + KEY_READ, // we might not have enough rights for rw access &hkeyDummy ) == ERROR_SUCCESS ) { ::RegCloseKey(hkeyDummy); - return TRUE; + return true; } - return FALSE; + return false; } const wxChar *GetFullName(const wxRegKey *pKey, const wxChar *szValue) @@ -1126,6 +1137,3 @@ void RemoveTrailingSeparator(wxString& str) str.Truncate(str.Len() - 1); } -#endif - // __WIN16__ -