X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fd6c844b172c174c149a72c8c13363250d990e7a..70e45c91bb677a3fe7eb8152f3c89c08cb0b2496:/src/msw/registry.cpp diff --git a/src/msw/registry.cpp b/src/msw/registry.cpp index b2650bcb6b..b2a25f4391 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" @@ -32,21 +28,25 @@ #include "wx/intl.h" #include "wx/log.h" -#include "wx/config.h" // for wxExpandEnvVars - // Windows headers /* #define STRICT #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 @@ -65,42 +65,44 @@ typedef unsigned char *RegString; static struct { HKEY hkey; - const char *szName; - const char *szShortName; + const wxChar *szName; + const wxChar *szShortName; } -aStdKeys[] = -{ - { HKEY_CLASSES_ROOT, "HKEY_CLASSES_ROOT", "HKCR" }, +aStdKeys[] = +{ + { HKEY_CLASSES_ROOT, wxT("HKEY_CLASSES_ROOT"), wxT("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? + { 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 '/' ;-) -#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 (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 @@ -110,11 +112,11 @@ aStdKeys[] = static inline void RemoveTrailingSeparator(wxString& str); // returns TRUE if given registry key exists -static bool KeyExists(WXHKEY hRootKey, const char *szKey); +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 @@ -127,31 +129,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(size_t 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(size_t 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; + 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; @@ -159,7 +161,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; } @@ -178,8 +180,8 @@ wxRegKey::StdKey wxRegKey::GetStdKeyFromHkey(WXHKEY hkey) 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; } @@ -190,16 +192,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 = NULL; - m_dwLastError = 0; + + Init(); } // parent is a predefined (and preopened) key @@ -207,8 +209,8 @@ wxRegKey::wxRegKey(StdKey keyParent, const wxString& strKey) : m_strKey(strKey) { RemoveTrailingSeparator(m_strKey); m_hRootKey = (WXHKEY) aStdKeys[keyParent].hkey; - m_hKey = NULL; - m_dwLastError = 0; + + Init(); } // parent is a normal regkey @@ -216,7 +218,7 @@ 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() && + if ( !m_strKey.IsEmpty() && (strKey.IsEmpty() || strKey[0] != REG_SEPARATOR) ) { m_strKey += REG_SEPARATOR; } @@ -225,8 +227,8 @@ wxRegKey::wxRegKey(const wxRegKey& keyParent, const wxString& strKey) RemoveTrailingSeparator(m_strKey); m_hRootKey = keyParent.m_hRootKey; - m_hKey = NULL; - m_dwLastError = 0; + + Init(); } // dtor closes the key releasing system resource @@ -264,7 +266,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; @@ -296,56 +305,59 @@ 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); - 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; } -#ifdef __GNUWIN32__ -bool wxRegKey::GetKeyInfo(size_t* pnSubKeys, - size_t* pnMaxKeyLen, - size_t* pnValues, - size_t* pnMaxValueLen) const +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 -bool wxRegKey::GetKeyInfo(ulong *pnSubKeys, - ulong *pnMaxKeyLen, - ulong *pnValues, - ulong *pnMaxValueLen) const + #define REG_PARAM (LPDWORD) #endif -{ -#ifdef __WIN32__ + + // 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'"), + wxLogSysError(m_dwLastError, _("Can't get info about registry key '%s'"), GetName().c_str()); return FALSE; } - else - return TRUE; -#else // Win16 - wxFAIL_MSG("GetKeyInfo() not implemented"); - return FALSE; -#endif + return TRUE; } // ---------------------------------------------------------------------------- @@ -353,40 +365,58 @@ bool wxRegKey::GetKeyInfo(ulong *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 ( IsOpened() ) + return TRUE; + + 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; + } - 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'"), + wxLogSysError(m_dwLastError, _("Can't create registry key '%s'"), GetName().c_str()); return FALSE; } @@ -402,21 +432,200 @@ 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'"), + wxLogSysError(m_dwLastError, _("Can't close registry key '%s'"), GetName().c_str()); - m_hKey = 0; return FALSE; } - else { - m_hKey = 0; - } } 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); + } + + // 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; + } +} + +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(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); + } + + // 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; +} + // ---------------------------------------------------------------------------- // delete keys/values // ---------------------------------------------------------------------------- @@ -430,6 +639,17 @@ 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 != (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; @@ -454,8 +674,10 @@ bool wxRegKey::DeleteSelf() Close(); m_dwLastError = RegDeleteKey((HKEY) m_hRootKey, m_strKey); - if ( m_dwLastError != ERROR_SUCCESS ) { - wxLogSysError(m_dwLastError, _("can't delete key '%s'"), + // 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; } @@ -463,7 +685,7 @@ bool wxRegKey::DeleteSelf() return TRUE; } -bool wxRegKey::DeleteKey(const char *szKey) +bool wxRegKey::DeleteKey(const wxChar *szKey) { if ( !Open() ) return FALSE; @@ -472,30 +694,20 @@ bool wxRegKey::DeleteKey(const char *szKey) return key.DeleteSelf(); } -bool wxRegKey::DeleteValue(const char *szValue) +bool wxRegKey::DeleteValue(const wxChar *szValue) { if ( !Open() ) return FALSE; - #ifdef __WIN32__ - m_dwLastError = RegDeleteValue((HKEY) 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((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()); + // 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; } @@ -505,27 +717,39 @@ bool wxRegKey::DeleteValue(const char *szValue) // ---------------------------------------------------------------------------- // return TRUE if value exists -bool wxRegKey::HasValue(const char *szValue) const +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 RegQueryValueEx((HKEY) m_hKey, szValue, RESERVED, - NULL, NULL, NULL) == ERROR_SUCCESS; - } - else - return FALSE; - #else // WIN16 - // only unnamed value exists - return IsEmpty(szValue); - #endif // WIN16/32 + + if ( !CONST_CAST Open() ) + 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 bool wxRegKey::HasSubkeys() const { + // suppress possible messages from GetFirstKey() + wxLogNull nolog; + // just call GetFirstKey with dummy parameters wxString str; long l; @@ -533,66 +757,65 @@ bool wxRegKey::HasSubkeys() const } // returns TRUE if given subkey exists -bool wxRegKey::HasSubKey(const char *szKey) const +bool wxRegKey::HasSubKey(const wxChar *szKey) const { - if ( CONST_CAST Open() ) - return KeyExists(m_hKey, szKey); - else + // this function should be silent, so suppress possible messages from Open() + wxLogNull nolog; + + if ( !CONST_CAST Open() ) 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() ) return Type_None; DWORD dwType; - m_dwLastError = RegQueryValueEx((HKEY) 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((HKEY) 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; } - wxLogSysError(m_dwLastError, _("can't set value of '%s'"), + wxLogSysError(m_dwLastError, _("Can't set value of '%s'"), GetFullName(this, szValue)); return FALSE; } -bool wxRegKey::QueryValue(const char *szValue, long *plValue) const +bool wxRegKey::QueryValue(const wxChar *szValue, long *plValue) const { if ( CONST_CAST Open() ) { DWORD dwType, dwSize = sizeof(DWORD); RegString pBuf = (RegString)plValue; - m_dwLastError = RegQueryValueEx((HKEY) 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; } 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; } @@ -603,68 +826,88 @@ bool wxRegKey::QueryValue(const char *szValue, long *plValue) const #endif //Win32 -bool wxRegKey::QueryValue(const char *szValue, wxString& strValue) const +bool wxRegKey::QueryValue(const wxChar *szValue, + wxString& strValue, + bool raw) 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, 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((HKEY) m_hKey, szValue, RESERVED, - &dwType, pBuf, &dwSize); - strValue.UngetWriteBuf(); + 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")); + } + } +#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; } } - #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'"), + wxLogSysError(m_dwLastError, _("Can't read value of '%s'"), GetFullName(this, szValue)); 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((HKEY) 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((HKEY) 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 } - wxLogSysError(m_dwLastError, _("can't set value of '%s'"), + wxLogSysError(m_dwLastError, _("Can't set value of '%s'"), GetFullName(this, szValue)); return FALSE; } -wxRegKey::operator wxString() const +wxString wxRegKey::QueryDefaultValue() const { wxString str; QueryValue(NULL, str); @@ -694,15 +937,13 @@ bool wxRegKey::GetNextValue(wxString& strValueName, long& lIndex) const if ( lIndex == -1 ) return FALSE; - #ifdef __WIN32__ - char szValueName[1024]; // @@ use RegQueryInfoKey... + wxChar szValueName[1024]; // @@ use RegQueryInfoKey... DWORD dwValueLen = WXSIZEOF(szValueName); - lIndex++; - m_dwLastError = RegEnumValue((HKEY) 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 @@ -712,7 +953,7 @@ 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()); } @@ -720,13 +961,6 @@ bool wxRegKey::GetNextValue(wxString& strValueName, long& lIndex) const } strValueName = szValueName; - #else //WIN16 - // only one unnamed value - wxASSERT( lIndex == 0 ); - - lIndex = -1; - strValueName.Empty(); - #endif return TRUE; } @@ -748,8 +982,15 @@ bool wxRegKey::GetNextKey(wxString& strKeyName, long& lIndex) const if ( lIndex == -1 ) return FALSE; - char szKeyName[_MAX_PATH + 1]; + 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 ) { @@ -757,7 +998,7 @@ 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()); } @@ -768,26 +1009,55 @@ bool wxRegKey::GetNextKey(wxString& strKeyName, long& lIndex) const 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; + } + } + // ============================================================================ // implementation of global private functions // ============================================================================ -bool KeyExists(WXHKEY hRootKey, const char *szKey) + +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_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(); } @@ -798,138 +1068,3 @@ void RemoveTrailingSeparator(wxString& str) str.Truncate(str.Len() - 1); } -// ============================================================================ -// global public functions -// ============================================================================ - -bool GetExtensionFromMimeType(wxString *pExt, const wxString& strMimeType) -{ - // @@@ VZ: I don't know of any official documentation which mentions this - // location, but as a matter of fact IE uses it, so why not we? - static const char *szMimeDbase = "MIME\\Database\\Content Type\\"; - - wxString strKey = szMimeDbase; - strKey << strMimeType; - - // suppress possible error messages - wxLogNull nolog; - wxRegKey key(wxRegKey::HKCR, strKey); - if ( key.Open() ) { - if ( key.QueryValue("Extension", *pExt) ) - return TRUE; - } - - // no such MIME type or no extension for it - return FALSE; -} - -bool GetMimeTypeFromExtension(wxString *pMimeType, const wxString& strExt) -{ - wxCHECK( !strExt.IsEmpty(), FALSE ); - - // add the leading point if necessary - wxString str; - if ( strExt[0] != '.' ) { - str = '.'; - } - str << strExt; - - // suppress possible error messages - wxLogNull nolog; - wxRegKey key(wxRegKey::HKCR, str); - if ( key.Open() ) { - if ( key.QueryValue("Content Type", *pMimeType) ) - return TRUE; - } - - // no such extension or no content-type - return FALSE; -} - -bool GetFileTypeFromExtension(wxString *pFileType, const wxString& strExt) -{ - wxCHECK( !strExt.IsEmpty(), FALSE ); - - // add the leading point if necessary - wxString str; - if ( strExt[0] != '.' ) { - str = '.'; - } - str << strExt; - - // suppress possible error messages - wxLogNull nolog; - wxRegKey key(wxRegKey::HKCR, str); - if ( key.Open() ) { - if ( key.QueryValue("", *pFileType) ) // it's the default value of the key - return TRUE; - } - - // no such extension or no value - return FALSE; -} - -bool GetFileTypeIcon(wxIcon *pIcon, const wxString& strFileType) -{ - wxCHECK( !strFileType.IsEmpty(), FALSE ); - - wxString strIconKey; - strIconKey << strFileType << REG_SEPARATOR << "DefaultIcon"; - - // suppress possible error messages - wxLogNull nolog; - wxRegKey key(wxRegKey::HKCR, strIconKey); - - if ( key.Open() ) { - wxString strIcon; - if ( key.QueryValue("", strIcon) ) { // it's the default value of the key - // the format is the following: , - // NB: icon index may be negative as well as positive and the full path - // may contain the environment variables inside '%' - wxString strFullPath = strIcon.Before(','), - strIndex = strIcon.After(','); - - // unless I misunderstand the format (may be index may be ommited, I - // don't know) - wxASSERT( !(strFullPath.IsEmpty() || strIndex.IsEmpty()) ); - - wxString strExpPath = wxExpandEnvVars(strFullPath); - int nIndex = atoi(strIndex); - - HICON hIcon = ExtractIcon(GetModuleHandle(NULL), strExpPath, nIndex); - switch ( (int)hIcon ) { - case 0: // means no icons were found - case 1: // means no such file or it wasn't a DLL/EXE/OCX/ICO/... - wxLogDebug("incorrect registry entry '%s': no such icon.", - GetFullName(&key)); - break; - - default: - pIcon->SetHICON((WXHICON)hIcon); - return TRUE; - } - } - } - - // no such file type or no value or incorrect icon entry - return FALSE; -} - -bool GetFileTypeDescription(wxString *pDesc, const wxString& strFileType) -{ - wxCHECK( !strFileType.IsEmpty(), FALSE ); - - // suppress possible error messages - wxLogNull nolog; - wxRegKey key(wxRegKey::HKCR, strFileType); - - if ( key.Open() ) { - if ( key.QueryValue("", *pDesc) ) // it's the default value of the key - return TRUE; - } - - // no such file type or no value - return FALSE; -} - -