X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/14f355c2b5c71fc7c3d680aea366582d2ac60f7b..7fbff8020342123aa6d2e5a01ac21cc3caeb1fe3:/src/msw/registry.cpp diff --git a/src/msw/registry.cpp b/src/msw/registry.cpp index 8305c63eb8..57eea64341 100644 --- a/src/msw/registry.cpp +++ b/src/msw/registry.cpp @@ -1,5 +1,5 @@ /////////////////////////////////////////////////////////////////////////////// -// Name: msw/registry.cpp +// Name: src/msw/registry.cpp // Purpose: implementation of registry classes and functions // Author: Vadim Zeitlin // Modified by: @@ -12,32 +12,27 @@ // - add high level functions (RegisterOleServer, ...) /////////////////////////////////////////////////////////////////////////////// -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) -#pragma implementation "registry.h" -#endif - // 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 __WIN16__ - -// Windows headers -/* -#define STRICT -#define WIN32_LEAN_AND_MEAN -*/ +#ifndef WX_PRECOMP + #include "wx/msw/wrapwin.h" + #include "wx/string.h" + #include "wx/intl.h" + #include "wx/log.h" + #include "wx/crt.h" +#endif -#include "wx/msw/wrapwin.h" +#include "wx/file.h" +#include "wx/wfstream.h" +// Windows headers #ifdef __WXWINCE__ #include "wx/msw/private.h" #include @@ -57,6 +52,19 @@ // 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 // ---------------------------------------------------------------------------- // constants @@ -73,20 +81,12 @@ static struct aStdKeys[] = { { HKEY_CLASSES_ROOT, wxT("HKEY_CLASSES_ROOT"), wxT("HKCR") }, -#ifdef __WIN32__ { 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 -#if WINVER >= 0x0400 && !defined(__WXWINCE__) { HKEY_CURRENT_CONFIG, wxT("HKEY_CURRENT_CONFIG"), wxT("HKCC") }, -#if !defined(__GNUWIN32__) && !defined(__WXWINCE__) { HKEY_DYN_DATA, wxT("HKEY_DYN_DATA"), wxT("HKDD") }, // short name? -#endif //GNUWIN32 -#endif //WINVER >= 4.0 -#endif //WIN32 }; // the registry name separator (perhaps one day MS will change it to '/' ;-) @@ -113,12 +113,17 @@ 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(WXHKEY hRootKey, const wxChar *szKey); +// returns true if given registry key exists +static bool KeyExists(WXHKEY hRootKey, const wxString& szKey); -// combines value and key name (uses static buffer!) -static const wxChar *GetFullName(const wxRegKey *pKey, - const wxChar *szValue = NULL); +// 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 @@ -152,12 +157,10 @@ wxRegKey::StdKey wxRegKey::ExtractKeyName(wxString& strKey) { wxString strRoot = strKey.BeforeFirst(REG_SEPARATOR); - HKEY hRootKey = 0; size_t ui; for ( ui = 0; ui < nStdKeys; ui++ ) { if ( strRoot.CmpNoCase(aStdKeys[ui].szName) == 0 || strRoot.CmpNoCase(aStdKeys[ui].szShortName) == 0 ) { - hRootKey = aStdKeys[ui].hkey; break; } } @@ -165,21 +168,21 @@ wxRegKey::StdKey wxRegKey::ExtractKeyName(wxString& strKey) if ( ui == nStdKeys ) { 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; } @@ -220,8 +223,8 @@ 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 ( !m_strKey.IsEmpty() && - (strKey.IsEmpty() || strKey[0] != REG_SEPARATOR) ) { + if ( !m_strKey.empty() && + (strKey.empty() || strKey[0] != REG_SEPARATOR) ) { m_strKey += REG_SEPARATOR; } @@ -276,7 +279,7 @@ void wxRegKey::SetName(const wxRegKey& keyParent, const wxString& strKey) // next line! m_strKey.clear(); m_strKey += keyParent.m_strKey; - if ( !strKey.IsEmpty() && strKey[0] != REG_SEPARATOR ) + if ( !strKey.empty() && strKey[0] != REG_SEPARATOR ) m_strKey += REG_SEPARATOR; m_strKey += strKey; @@ -291,17 +294,29 @@ void wxRegKey::SetHkey(WXHKEY hKey) 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.empty(); + 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.wx_str()); } // returns the full name of the key (prefix is abbreviated if bShortPrefix) @@ -310,8 +325,8 @@ wxString wxRegKey::GetName(bool bShortPrefix) const StdKey key = GetStdKeyFromHkey((WXHKEY) m_hRootKey); wxString str = bShortPrefix ? aStdKeys[key].szShortName : aStdKeys[key].szName; - if ( !m_strKey.IsEmpty() ) - str << _T("\\") << m_strKey; + if ( !m_strKey.empty() ) + str << wxT("\\") << m_strKey; return str; } @@ -321,8 +336,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 *) @@ -331,7 +344,7 @@ bool wxRegKey::GetKeyInfo(size_t *pnSubKeys, #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") ); + wxASSERT_MSG( IsOpened(), wxT("key should be opened in GetKeyInfo") ); m_dwLastError = ::RegQueryInfoKey ( @@ -358,15 +371,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,18 +382,24 @@ 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; + { + 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, + m_strKey.t_str(), RESERVED, - KEY_ALL_ACCESS, + mode == Read ? KEY_READ : KEY_ALL_ACCESS, &tmpKey ); @@ -393,11 +407,13 @@ 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; + m_mode = mode; + + return true; } // creates key, failing if it exists and !bOkIfExists @@ -405,15 +421,15 @@ 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__ DWORD disposition; - m_dwLastError = RegCreateKeyEx((HKEY) m_hRootKey, m_strKey, + m_dwLastError = RegCreateKeyEx((HKEY) m_hRootKey, m_strKey.wx_str(), NULL, // reserved NULL, // class string 0, @@ -422,17 +438,17 @@ bool wxRegKey::Create(bool bOkIfExists) &tmpKey, &disposition); #else - m_dwLastError = RegCreateKey((HKEY) m_hRootKey, m_strKey, &tmpKey); + m_dwLastError = RegCreateKey((HKEY) m_hRootKey, m_strKey.t_str(), &tmpKey); #endif 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 +463,21 @@ 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 +wxRegKey::RenameValue(const wxString& szValueOld, const wxString& szValueNew) { - bool ok = TRUE; + bool ok = true; if ( HasValue(szValueNew) ) { wxLogError(_("Registry value '%s' already exists."), szValueNew); - ok = FALSE; + ok = false; } if ( !ok || @@ -469,19 +486,20 @@ 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, +bool wxRegKey::CopyValue(const wxString& szValue, wxRegKey& keyDst, - const wxChar *szValueNew) + const wxString& szValueNew) { - if ( !szValueNew ) { + wxString valueNew(szValueNew); + if ( valueNew.empty() ) { // by default, use the same name - szValueNew = szValue; + valueNew = szValue; } switch ( GetValueType(szValue) ) { @@ -489,7 +507,7 @@ bool wxRegKey::CopyValue(const wxChar *szValue, { wxString strVal; return QueryValue(szValue, strVal) && - keyDst.SetValue(szValueNew, strVal); + keyDst.SetValue(valueNew, strVal); } case Type_Dword: @@ -497,40 +515,44 @@ bool wxRegKey::CopyValue(const wxChar *szValue, { long dwVal; return QueryValue(szValue, &dwVal) && - keyDst.SetValue(szValueNew, 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) -#ifdef __WIN32__ case Type_None: case Type_Expand_String: - case Type_Binary: 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: -#endif // Win32 default: wxLogError(_("Can't copy values of unsupported type %d."), GetValueType(szValue)); - return FALSE; + return false; } } -bool wxRegKey::Rename(const wxChar *szNewName) +bool wxRegKey::Rename(const wxString& szNewName) { - wxCHECK_MSG( !!m_strKey, FALSE, _T("registry hives can't be renamed") ); + 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; + return false; } // do we stay in the same hive? @@ -542,7 +564,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.empty() ) { // don't add '\\' in the start if strFullNewName is empty strKey += REG_SEPARATOR; } @@ -556,7 +578,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)); @@ -577,11 +599,11 @@ bool wxRegKey::Rename(const wxChar *szNewName) return ok; } -bool wxRegKey::Copy(const wxChar *szNewName) +bool wxRegKey::Copy(const wxString& 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 +618,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; @@ -606,10 +628,14 @@ bool wxRegKey::Copy(wxRegKey& keyDst) wxRegKey key(*this, strKey); wxString keyName; keyName << GetFullName(&keyDst) << REG_SEPARATOR << strKey; - ok = key.Copy((const wxChar*) keyName); + 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 @@ -629,7 +655,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,19 +671,20 @@ 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() || + 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)); + 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,88 +704,73 @@ 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 ) { + m_dwLastError = RegDeleteKey((HKEY) m_hRootKey, m_strKey.t_str()); + // 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) +bool wxRegKey::DeleteKey(const wxString& szKey) { if ( !Open() ) - return FALSE; + return false; wxRegKey key(*this, szKey); return key.DeleteSelf(); } -bool wxRegKey::DeleteValue(const wxChar *szValue) +bool wxRegKey::DeleteValue(const wxString& szValue) { - if ( !Open() ) - return FALSE; + if ( !Open() ) + return false; -#if defined(__WIN32__) - m_dwLastError = RegDeleteValue((HKEY) m_hKey, WXSTRINGCAST szValue); + m_dwLastError = RegDeleteValue((HKEY) m_hKey, RegValueStr(szValue)); // 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 - // 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; + (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 wxChar *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() - wxLogNull nolog; + // 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, + RegValueStr(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 +782,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,26 +794,25 @@ bool wxRegKey::HasSubkeys() const return CONST_CAST GetFirstKey(str, l); } -// returns TRUE if given subkey exists -bool wxRegKey::HasSubKey(const wxChar *szKey) const +// returns true if given subkey exists +bool wxRegKey::HasSubKey(const wxString& 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 +wxRegKey::ValueType wxRegKey::GetValueType(const wxString& szValue) const { - #ifdef __WIN32__ - if ( ! CONST_CAST Open() ) + if ( ! CONST_CAST Open(Read) ) return Type_None; DWORD dwType; - m_dwLastError = RegQueryValueEx((HKEY) m_hKey, WXSTRINGCAST 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'"), @@ -809,155 +821,197 @@ 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__ -bool wxRegKey::SetValue(const wxChar *szValue, long lValue) +bool wxRegKey::SetValue(const wxString& szValue, long lValue) { if ( CONST_CAST Open() ) { - m_dwLastError = RegSetValueEx((HKEY) m_hKey, szValue, (DWORD) 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'"), GetFullName(this, szValue)); - return FALSE; + return false; } -bool wxRegKey::QueryValue(const wxChar *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, WXSTRINGCAST 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'"), 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; } -#endif //Win32 - -bool wxRegKey::QueryValue(const wxChar *szValue, - wxString& strValue, - bool raw) 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, WXSTRINGCAST 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 = 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, - WXSTRINGCAST szValue, + RegValueStr(szValue), RESERVED, &dwType, - (RegString)(wxChar*)wxStringBuffer(strValue, dwSize), + pBuf, &dwSize); + buffer.UngetWriteBuf(dwSize); + } else { + buffer.SetDataLen(0); + } + } - // 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 ) + 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 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 ) { - wxLogLastError(_T("ExpandEnvironmentStrings")); + 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__ - } + // __WXWINCE__ + } - if ( m_dwLastError == ERROR_SUCCESS ) { - // check that it was the right type - wxASSERT_MSG( !IsNumericValue(szValue), - wxT("Type mismatch in wxRegKey::QueryValue().") ); + if ( m_dwLastError == ERROR_SUCCESS ) + { + // check that it was the right type + 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; + wxLogSysError(m_dwLastError, _("Can't read value of '%s'"), + GetFullName(this, szValue)); + return false; } -bool wxRegKey::SetValue(const wxChar *szValue, const wxString& strValue) +bool wxRegKey::SetValue(const wxString& 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(), + m_dwLastError = RegSetValueEx((HKEY) m_hKey, + RegValueStr(szValue), + (DWORD) RESERVED, REG_SZ, + (RegString)strValue.wx_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 { wxString str; - QueryValue(NULL, str); + QueryValue(wxEmptyString, str, false); return str; } @@ -969,8 +1023,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); @@ -982,9 +1036,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); @@ -1005,25 +1058,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); @@ -1035,7 +1081,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]; @@ -1057,72 +1103,360 @@ 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) -bool wxRegKey::IsNumericValue(const wxChar *szValue) const - { - ValueType type = GetValueType(szValue); - switch ( type ) { +// returns true if the value contains a number (else it's some string) +bool wxRegKey::IsNumericValue(const wxString& 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; + return true; default: - return FALSE; - } - } + return false; + } +} + +// ---------------------------------------------------------------------------- +// 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) +{ + 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.mb_str(), s.length()); +#endif + + return ostr.IsOk(); +} + +#endif // wxUSE_STREAMS + +bool wxRegKey::Export(const wxString& filename) const +{ +#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; + } + + wxFFileOutputStream ostr(filename, wxT("w")); + + return ostr.Ok() && Export(ostr); +#else + wxUnusedVar(filename); + return false; +#endif +} + +#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 + +static +wxString +FormatAsHex(const void *data, + size_t size, + wxRegKey::ValueType type = wxRegKey::Type_Binary) +{ + 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(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]); + } + + 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 = 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); + } + + return rhs; +} + +#if wxUSE_STREAMS + +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 = const_cast(*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; +} + +#endif // wxUSE_STREAMS // ============================================================================ // implementation of global private functions // ============================================================================ -bool KeyExists(WXHKEY hRootKey, const wxChar *szKey) +bool KeyExists(WXHKEY hRootKey, const wxString& szKey) { // don't close this key itself for the case of empty szKey! - if ( wxIsEmpty(szKey) ) - return TRUE; + if ( szKey.empty() ) + return true; HKEY hkeyDummy; if ( ::RegOpenKeyEx ( (HKEY)hRootKey, - szKey, + szKey.t_str(), 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) +wxString GetFullName(const wxRegKey *pKey, const wxString& szValue) { - static wxString s_str; - s_str = pKey->GetName(); - if ( !wxIsEmpty(szValue) ) - s_str << wxT("\\") << szValue; + wxString str(pKey->GetName()); + if ( !szValue.empty() ) + str << wxT("\\") << szValue; - return s_str.c_str(); + return str; } -void RemoveTrailingSeparator(wxString& str) +wxString GetFullName(const wxRegKey *pKey) { - if ( !str.IsEmpty() && str.Last() == REG_SEPARATOR ) + return pKey->GetName(); +} + +inline void RemoveTrailingSeparator(wxString& str) +{ + if ( !str.empty() && str.Last() == REG_SEPARATOR ) str.Truncate(str.Len() - 1); } -#endif - // __WIN16__ +inline const wxChar *RegValueStr(const wxString& szValue) +{ + return szValue.empty() ? (const wxChar*)NULL : szValue.t_str(); +} +#endif // wxUSE_REGKEY