// - add high level functions (RegisterOleServer, ...)
///////////////////////////////////////////////////////////////////////////////
-// ============================================================================
-// declarations
-// ============================================================================
-
-// ----------------------------------------------------------------------------
-// headers
-// ----------------------------------------------------------------------------
+#ifdef __GNUG__
+#pragma implementation "registry.h"
+#endif
// for compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#include "wx/string.h"
#include "wx/intl.h"
#include "wx/log.h"
+#include "wx/config.h" // for wxExpandEnvVars
+
+#ifndef __WIN16__
// Windows headers
+/*
#define STRICT
#define WIN32_LEAN_AND_MEAN
+*/
+
#include <windows.h>
// other std headers
// the registry name separator (perhaps one day MS will change it to '/' ;-)
#define REG_SEPARATOR '\\'
+// useful for Windows programmers: makes somewhat more clear all these zeroes
+// being passed to Windows APIs
+#define RESERVED (NULL)
+
// ----------------------------------------------------------------------------
// macros
// ----------------------------------------------------------------------------
// 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(HKEY hRootKey, const char *szKey);
+// returns TRUE if given registry key exists
+static bool KeyExists(WXHKEY hRootKey, const char *szKey);
// combines value and key name (uses static buffer!)
static const char *GetFullName(const wxRegKey *pKey,
// @@ 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(uint key)
+const char *wxRegKey::GetStdKeyName(size_t key)
{
// return empty string if key is invalid
- wxCHECK_RET( key < nStdKeys, "" );
+ wxCHECK_MSG( key < nStdKeys, "", "invalid key in wxRegKey::GetStdKeyName" );
return aStdKeys[key].szName;
}
-const char *wxRegKey::GetStdKeyShortName(uint key)
+const char *wxRegKey::GetStdKeyShortName(size_t key)
{
// return empty string if key is invalid
- wxCHECK_RET( key < nStdKeys, "" );
+ wxCHECK( key < nStdKeys, "" );
return aStdKeys[key].szShortName;
}
{
wxString strRoot = strKey.Left(REG_SEPARATOR);
- HKEY hRootKey;
- uint ui;
+ 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 ) {
return (wxRegKey::StdKey)(int)hRootKey;
}
-wxRegKey::StdKey wxRegKey::GetStdKeyFromHkey(HKEY hkey)
+wxRegKey::StdKey wxRegKey::GetStdKeyFromHkey(WXHKEY hkey)
{
- for ( uint ui = 0; ui < nStdKeys; ui++ ) {
- if ( aStdKeys[ui].hkey == hkey )
+ for ( size_t ui = 0; ui < nStdKeys; ui++ ) {
+ if ( (int) aStdKeys[ui].hkey == (int) hkey )
return (StdKey)ui;
}
wxRegKey::wxRegKey()
{
m_hKey = 0;
- m_hRootKey = aStdKeys[HKCR].hkey;
+ m_hRootKey = (WXHKEY) aStdKeys[HKCR].hkey;
m_dwLastError = 0;
}
wxRegKey::wxRegKey(const wxString& strKey) : m_strKey(strKey)
{
- m_hRootKey = aStdKeys[ExtractKeyName(m_strKey)].hkey;
- m_hKey = NULL;
+ m_hRootKey = (WXHKEY) aStdKeys[ExtractKeyName(m_strKey)].hkey;
+ m_hKey = (WXHKEY) NULL;
m_dwLastError = 0;
}
wxRegKey::wxRegKey(StdKey keyParent, const wxString& strKey) : m_strKey(strKey)
{
RemoveTrailingSeparator(m_strKey);
- m_hRootKey = aStdKeys[keyParent].hkey;
- m_hKey = NULL;
+ m_hRootKey = (WXHKEY) aStdKeys[keyParent].hkey;
+ m_hKey = (WXHKEY) NULL;
m_dwLastError = 0;
}
: m_strKey(keyParent.m_strKey)
{
// combine our name with parent's to get the full name
- if ( !strKey.IsEmpty() && strKey[0] != REG_SEPARATOR )
- m_strKey += REG_SEPARATOR;
+ if ( !m_strKey.IsEmpty() &&
+ (strKey.IsEmpty() || strKey[0] != REG_SEPARATOR) ) {
+ m_strKey += REG_SEPARATOR;
+ }
m_strKey += strKey;
RemoveTrailingSeparator(m_strKey);
m_hRootKey = keyParent.m_hRootKey;
- m_hKey = NULL;
+ m_hKey = (WXHKEY) NULL;
m_dwLastError = 0;
}
Close();
m_strKey = strKey;
- m_hRootKey = aStdKeys[ExtractKeyName(m_strKey)].hkey;
+ m_hRootKey = (WXHKEY) aStdKeys[ExtractKeyName(m_strKey)].hkey;
}
// the name is relative to the parent key
m_strKey = strKey;
RemoveTrailingSeparator(m_strKey);
- m_hRootKey = aStdKeys[keyParent].hkey;
+ m_hRootKey = (WXHKEY) aStdKeys[keyParent].hkey;
}
// the name is relative to the parent key
Close();
// combine our name with parent's to get the full name
- m_strKey = strKey;
+ m_strKey = keyParent.m_strKey;
if ( !strKey.IsEmpty() && strKey[0] != REG_SEPARATOR )
m_strKey += REG_SEPARATOR;
+ m_strKey += strKey;
RemoveTrailingSeparator(m_strKey);
}
// hKey should be opened and will be closed in wxRegKey dtor
-void wxRegKey::SetHkey(HKEY hKey)
+void wxRegKey::SetHkey(WXHKEY hKey)
{
Close();
// 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)
wxString wxRegKey::GetName(bool bShortPrefix) const
{
- StdKey key = GetStdKeyFromHkey(m_hRootKey);
+ StdKey key = GetStdKeyFromHkey((StdKey) m_hRootKey);
wxString str = bShortPrefix ? aStdKeys[key].szShortName
: aStdKeys[key].szName;
if ( !m_strKey.IsEmpty() )
return str;
}
+#ifdef __GNUWIN32__
+bool wxRegKey::GetKeyInfo(size_t* pnSubKeys,
+ size_t* pnMaxKeyLen,
+ size_t* pnValues,
+ size_t* pnMaxValueLen) const
+#else
+bool wxRegKey::GetKeyInfo(ulong *pnSubKeys,
+ ulong *pnMaxKeyLen,
+ ulong *pnValues,
+ ulong *pnMaxValueLen) const
+#endif
+{
+#if defined(__WIN32__) && !defined(__TWIN32__)
+ m_dwLastError = ::RegQueryInfoKey
+ (
+ (HKEY) m_hKey,
+ NULL, // class name
+ NULL, // (ptr to) size of class name buffer
+ RESERVED,
+ pnSubKeys, // [out] number of subkeys
+ pnMaxKeyLen, // [out] max length of a subkey name
+ NULL, // longest subkey class name
+ pnValues, // [out] number of values
+ pnMaxValueLen, // [out] max length of a value name
+ NULL, // longest value data
+ NULL, // security descriptor
+ NULL // time of last modification
+ );
+
+ if ( m_dwLastError != ERROR_SUCCESS ) {
+ 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
+}
+
// ----------------------------------------------------------------------------
// operations
// ----------------------------------------------------------------------------
bool wxRegKey::Open()
{
if ( IsOpened() )
- return true;
+ return TRUE;
- m_dwLastError = RegOpenKey(m_hRootKey, m_strKey, &m_hKey);
+ 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'",
+ wxLogSysError(m_dwLastError, _("can't open registry key '%s'"),
GetName().c_str());
- return false;
+ return FALSE;
}
else
- return true;
+ {
+ m_hKey = (WXHKEY) tmpKey;
+ return TRUE;
+ }
}
// creates key, failing if it exists and !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;
- m_dwLastError = RegCreateKey(m_hRootKey, m_strKey, &m_hKey);
+ HKEY tmpKey;
+ m_dwLastError = RegCreateKey((HKEY) m_hRootKey, m_strKey, &tmpKey);
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;
+ return FALSE;
}
else
- return true;
+ {
+ m_hKey = (WXHKEY) tmpKey;
+ return TRUE;
+ }
}
// close the key, it's not an error to call it when not opened
bool wxRegKey::Close()
{
if ( IsOpened() ) {
- m_dwLastError = RegCloseKey(m_hKey);
+ m_dwLastError = RegCloseKey((HKEY) m_hKey);
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;
+ return FALSE;
}
else {
m_hKey = 0;
}
}
- 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() || (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));
+
+ 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;
bCont = GetNextKey(strKey, lIndex);
}
- uint nKeyCount = astrSubkeys.Count();
- for ( uint nKey = 0; nKey < nKeyCount; nKey++ ) {
+ size_t nKeyCount = astrSubkeys.Count();
+ for ( size_t nKey = 0; nKey < nKeyCount; nKey++ ) {
wxRegKey key(*this, astrSubkeys[nKey]);
if ( !key.DeleteSelf() )
return FALSE;
// now delete this key itself
Close();
- m_dwLastError = RegDeleteKey(m_hRootKey, m_strKey);
+ m_dwLastError = RegDeleteKey((HKEY) m_hRootKey, m_strKey);
if ( m_dwLastError != ERROR_SUCCESS ) {
- wxLogSysError(m_dwLastError, "can't delete key '%s'", GetName().c_str());
+ wxLogSysError(m_dwLastError, _("can't delete key '%s'"),
+ GetName().c_str());
return FALSE;
}
bool wxRegKey::DeleteKey(const char *szKey)
{
if ( !Open() )
- return false;
+ return FALSE;
wxRegKey key(*this, szKey);
return key.DeleteSelf();
bool wxRegKey::DeleteValue(const char *szValue)
{
if ( !Open() )
- return false;
+ return FALSE;
- #ifdef __WIN32__
- m_dwLastError = RegDeleteValue(m_hKey, szValue);
+#if defined(__WIN32__) && !defined(__TWIN32__)
+ m_dwLastError = RegDeleteValue((HKEY) m_hKey, (char*) (const char*) szValue);
if ( m_dwLastError != ERROR_SUCCESS ) {
- wxLogSysError(m_dwLastError, "can't delete value '%s' from key '%s'",
+ 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(m_hKey, NULL, REG_SZ, "", RESERVED);
+ 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'",
+ wxLogSysError(m_dwLastError, _("can't delete value of key '%s'"),
GetName().c_str());
- return false;
+ 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 char *szValue) const
{
+ // this function should be silent, so suppress possible messages from Open()
+ wxLogNull nolog;
+
#ifdef __WIN32__
if ( CONST_CAST Open() ) {
- return RegQueryValueEx(m_hKey, szValue, RESERVED,
+ return RegQueryValueEx((HKEY) m_hKey, (char*) (const char*) szValue, RESERVED,
NULL, NULL, NULL) == ERROR_SUCCESS;
}
else
- return false;
+ return FALSE;
#else // WIN16
// only unnamed value exists
return IsEmpty(szValue);
#endif // WIN16/32
}
-// 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()
+ wxLogNull nolog;
+
// just call GetFirstKey with dummy parameters
wxString str;
long l;
return CONST_CAST GetFirstKey(str, l);
}
-// returns true if given subkey exists
+// returns TRUE if given subkey exists
bool wxRegKey::HasSubKey(const char *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
- return false;
+ return FALSE;
}
-wxRegKey::ValueType wxRegKey::GetValueType(const char *szValue)
+wxRegKey::ValueType wxRegKey::GetValueType(const char *szValue) const
{
#ifdef __WIN32__
- if ( !Open() )
+ if ( ! CONST_CAST Open() )
return Type_None;
DWORD dwType;
- m_dwLastError = RegQueryValueEx(m_hKey, szValue, RESERVED,
+ m_dwLastError = RegQueryValueEx((HKEY) m_hKey, (char*) (const char*) 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;
}
#ifdef __WIN32__
bool wxRegKey::SetValue(const char *szValue, long lValue)
{
+#ifdef __TWIN32__
+ wxFAIL_MSG("RegSetValueEx not implemented by TWIN32");
+ return FALSE;
+#else
if ( CONST_CAST Open() ) {
- m_dwLastError = RegSetValueEx(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;
+ 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;
+ return FALSE;
+#endif
}
bool wxRegKey::QueryValue(const char *szValue, long *plValue) const
if ( CONST_CAST Open() ) {
DWORD dwType, dwSize = sizeof(DWORD);
RegString pBuf = (RegString)plValue;
- m_dwLastError = RegQueryValueEx(m_hKey, szValue, RESERVED,
+ m_dwLastError = RegQueryValueEx((HKEY) m_hKey, (char*) (const char*) 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;
+ return FALSE;
}
else {
// check that we read the value of right type
wxASSERT_MSG( dwType == REG_DWORD,
"Type mismatch in wxRegKey::QueryValue()." );
- return true;
+ return TRUE;
}
}
else
- return false;
+ return FALSE;
}
#endif //Win32
#ifdef __WIN32__
// first get the type and size of the data
DWORD dwType, dwSize;
- m_dwLastError = RegQueryValueEx(m_hKey, szValue, RESERVED,
+ m_dwLastError = RegQueryValueEx((HKEY) m_hKey, (char*) (const char*) szValue, RESERVED,
&dwType, NULL, &dwSize);
if ( m_dwLastError == ERROR_SUCCESS ) {
RegString pBuf = (RegString)strValue.GetWriteBuf(dwSize);
- m_dwLastError = RegQueryValueEx(m_hKey, szValue, RESERVED,
+ m_dwLastError = RegQueryValueEx((HKEY) m_hKey, (char*) (const char*) szValue, RESERVED,
&dwType, pBuf, &dwSize);
+ strValue.UngetWriteBuf();
if ( m_dwLastError == ERROR_SUCCESS ) {
// check that it was the right type
wxASSERT_MSG( dwType == REG_SZ,
"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(m_hKey, 0, strValue.GetWriteBuf(256), &l);
+ m_dwLastError = RegQueryValue((HKEY) m_hKey, 0, strValue.GetWriteBuf(256), &l);
+ strValue.UngetWriteBuf();
if ( m_dwLastError == ERROR_SUCCESS )
- return true;
+ 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;
+ return FALSE;
}
bool wxRegKey::SetValue(const char *szValue, const wxString& strValue)
{
if ( CONST_CAST Open() ) {
- #ifdef __WIN32__
- m_dwLastError = RegSetValueEx(m_hKey, szValue, RESERVED, REG_SZ,
+#if defined( __WIN32__) && !defined(__TWIN32__)
+ m_dwLastError = RegSetValueEx((HKEY) m_hKey, szValue, (DWORD) RESERVED, REG_SZ,
(RegString)strValue.c_str(),
strValue.Len() + 1);
if ( m_dwLastError == ERROR_SUCCESS )
- return true;
+ return TRUE;
#else //WIN16
// named registry values don't exist in Win16
wxASSERT( IsEmpty(szValue) );
- m_dwLastError = RegSetValue(m_hKey, NULL, REG_SZ, strValue, NULL);
+ m_dwLastError = RegSetValue((HKEY) m_hKey, NULL, REG_SZ, strValue, NULL);
if ( m_dwLastError == ERROR_SUCCESS )
- return true;
+ 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;
+ return FALSE;
}
wxRegKey::operator wxString() const
bool wxRegKey::GetFirstValue(wxString& strValueName, long& lIndex)
{
if ( !Open() )
- return false;
+ return FALSE;
lIndex = 0;
return GetNextValue(strValueName, lIndex);
// are we already at the end of enumeration?
if ( lIndex == -1 )
- return false;
+ return FALSE;
- #ifdef __WIN32__
+#if defined( __WIN32__) && !defined(__TWIN32__)
char szValueName[1024]; // @@ use RegQueryInfoKey...
DWORD dwValueLen = WXSIZEOF(szValueName);
lIndex++;
- m_dwLastError = RegEnumValue(m_hKey, lIndex,
+ m_dwLastError = RegEnumValue((HKEY) m_hKey, lIndex,
szValueName, &dwValueLen,
RESERVED,
NULL, // [out] type
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());
}
- return false;
+ return FALSE;
}
strValueName = szValueName;
strValueName.Empty();
#endif
- return true;
+ return TRUE;
}
bool wxRegKey::GetFirstKey(wxString& strKeyName, long& lIndex)
{
if ( !Open() )
- return false;
+ return FALSE;
lIndex = 0;
return GetNextKey(strKeyName, lIndex);
// are we already at the end of enumeration?
if ( lIndex == -1 )
- return false;
+ return FALSE;
char szKeyName[_MAX_PATH + 1];
- m_dwLastError = RegEnumKey(m_hKey, lIndex++, szKeyName, WXSIZEOF(szKeyName));
+ m_dwLastError = RegEnumKey((HKEY) m_hKey, lIndex++, szKeyName, WXSIZEOF(szKeyName));
if ( m_dwLastError != ERROR_SUCCESS ) {
if ( m_dwLastError == ERROR_NO_MORE_ITEMS ) {
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());
}
- 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 char *szValue) const
+ {
+ ValueType type = GetValueType(szValue);
+ switch ( type ) {
+ case Type_Dword:
+ case Type_Dword_little_endian:
+ case Type_Dword_big_endian:
+ return TRUE;
+
+ default:
+ return FALSE;
+ }
+ }
+
// ============================================================================
-// implementation of global functions
+// implementation of global private functions
// ============================================================================
-bool KeyExists(HKEY hRootKey, const char *szKey)
+bool KeyExists(WXHKEY hRootKey, const char *szKey)
{
HKEY hkeyDummy;
- if ( RegOpenKey(hRootKey, szKey, &hkeyDummy) == ERROR_SUCCESS ) {
+ if ( RegOpenKey( (HKEY) hRootKey, szKey, &hkeyDummy) == ERROR_SUCCESS ) {
RegCloseKey(hkeyDummy);
- return true;
+ return TRUE;
}
else
- return false;
+ return FALSE;
}
const char *GetFullName(const wxRegKey *pKey, const char *szValue)
if ( !str.IsEmpty() && str.Last() == REG_SEPARATOR )
str.Truncate(str.Len() - 1);
}
+
+#endif
+ // __WIN16__
+
projects / wxWidgets.git / blobdiff