X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b14391d1c8fde767eabedd2243dd6583f685f53f..b600ed13625645eb985acf49eecd06fd111eb061:/src/msw/registry.cpp diff --git a/src/msw/registry.cpp b/src/msw/registry.cpp index 50da59b181..c0f5e6a304 100644 --- a/src/msw/registry.cpp +++ b/src/msw/registry.cpp @@ -6,7 +6,7 @@ // 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, ...) @@ -27,7 +27,6 @@ #include "wx/string.h" #include "wx/intl.h" #include "wx/log.h" -#include "wx/config.h" // for wxExpandEnvVars #ifndef __WIN16__ @@ -92,12 +91,12 @@ aStdKeys[] = // ---------------------------------------------------------------------------- // 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 @@ -187,16 +186,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 +203,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 +221,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 +260,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 +299,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 +313,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 +352,8 @@ bool wxRegKey::GetKeyInfo(size_t *pnSubKeys, GetName().c_str()); return FALSE; } - else - return TRUE; + + return TRUE; #else // Win16 wxFAIL_MSG("GetKeyInfo() not implemented"); @@ -406,16 +415,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; @@ -573,7 +580,7 @@ bool wxRegKey::Copy(wxRegKey& keyDst) wxRegKey key(*this, strKey); wxString keyName; keyName << GetFullName(&keyDst) << REG_SEPARATOR << strKey; - ok = key.Copy((const char*) keyName); + ok = key.Copy((const wxChar*) keyName); if ( ok ) bCont = GetNextKey(strKey, lIndex); @@ -596,8 +603,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; @@ -619,11 +625,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; } @@ -675,14 +680,14 @@ 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 ) { 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) ); @@ -693,7 +698,7 @@ bool wxRegKey::DeleteValue(const wxChar *szValue) GetName().c_str()); return FALSE; } - #endif //WIN16/32 +#endif //WIN16/32 return TRUE; } @@ -709,12 +714,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); @@ -751,10 +758,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 @@ -781,10 +788,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)); @@ -795,7 +798,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 @@ -824,7 +826,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__ @@ -847,6 +851,30 @@ bool wxRegKey::QueryValue(const wxChar *szValue, wxString& strValue) const pBuf, &dwSize); strValue.UngetWriteBuf(); + + // expand the var expansions in the string unless disabled + if ( (dwType == REG_EXPAND_SZ) && !raw ) + { + DWORD dwExpSize = ::ExpandEnvironmentStrings(strValue, NULL, 0); + bool ok = dwExpSize != 0; + if ( ok ) + { + wxString strExpValue; + ok = ::ExpandEnvironmentStrings + ( + strValue, + strExpValue.GetWriteBuf(dwExpSize), + dwExpSize + ) != 0; + strExpValue.UngetWriteBuf(); + strValue = strExpValue; + } + + if ( !ok ) + { + wxLogLastError(_T("ExpandEnvironmentStrings")); + } + } } if ( m_dwLastError == ERROR_SUCCESS ) { @@ -876,20 +904,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'"), @@ -897,7 +925,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); @@ -927,7 +955,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); @@ -952,13 +980,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; } @@ -1018,8 +1046,13 @@ bool wxRegKey::IsNumericValue(const wxChar *szValue) const // ============================================================================ // implementation of global private functions // ============================================================================ + bool KeyExists(WXHKEY hRootKey, const wxChar *szKey) { + // don't close this key itself for the case of empty szKey! + if ( wxIsEmpty(szKey) ) + return TRUE; + HKEY hkeyDummy; if ( RegOpenKey( (HKEY) hRootKey, szKey, &hkeyDummy) == ERROR_SUCCESS ) { RegCloseKey(hkeyDummy);