]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/registry.cpp
Menu/toolbar event handling now tries the window with the focus first.
[wxWidgets.git] / src / msw / registry.cpp
index 4717b97ebbc9b92d49fc73507f07c8738486910c..099b376cfd5dffd1f0b1ef33e1401988efe9fec7 100644 (file)
 //              - 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"
@@ -31,6 +27,9 @@
 #include  "wx/string.h"
 #include  "wx/intl.h"
 #include  "wx/log.h"
+#include  "wx/config.h"    // for wxExpandEnvVars
+
+#ifndef __WIN16__
 
 // Windows headers
 /*
@@ -86,6 +85,10 @@ aStdKeys[] =
 // 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
 // ----------------------------------------------------------------------------
@@ -104,7 +107,7 @@ aStdKeys[] =
 static inline void RemoveTrailingSeparator(wxString& str);
 
 // returns TRUE if given registry key exists
-static bool KeyExists(HKEY hRootKey, const char *szKey);
+static bool KeyExists(WXHKEY hRootKey, const char *szKey);
 
 // combines value and key name (uses static buffer!)
 static const char *GetFullName(const wxRegKey *pKey, 
@@ -122,7 +125,7 @@ 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(uint key)
+const char *wxRegKey::GetStdKeyName(size_t key)
 {
   // return empty string if key is invalid
   wxCHECK_MSG( key < nStdKeys, "", "invalid key in wxRegKey::GetStdKeyName" );
@@ -130,7 +133,7 @@ const char *wxRegKey::GetStdKeyName(uint key)
   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( key < nStdKeys, "" );
@@ -142,8 +145,8 @@ wxRegKey::StdKey wxRegKey::ExtractKeyName(wxString& strKey)
 {
   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 ) {
@@ -166,10 +169,10 @@ wxRegKey::StdKey wxRegKey::ExtractKeyName(wxString& strKey)
   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;
   }
   
@@ -185,14 +188,14 @@ wxRegKey::StdKey wxRegKey::GetStdKeyFromHkey(HKEY hkey)
 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;
 }
 
@@ -200,8 +203,8 @@ wxRegKey::wxRegKey(const wxString& strKey) : m_strKey(strKey)
 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;
 }
 
@@ -210,14 +213,16 @@ 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 ( !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;
 }
 
@@ -237,7 +242,7 @@ void wxRegKey::SetName(const wxString& strKey)
   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
@@ -247,7 +252,7 @@ void wxRegKey::SetName(StdKey keyParent, const wxString& strKey)
 
   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
@@ -267,7 +272,7 @@ void wxRegKey::SetName(const wxRegKey& keyParent, const wxString& strKey)
 }
 
 // hKey should be opened and will be closed in wxRegKey dtor
-void wxRegKey::SetHkey(HKEY hKey)
+void wxRegKey::SetHkey(WXHKEY hKey)
 {
   Close();
 
@@ -288,7 +293,7 @@ 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(m_hRootKey);
+  StdKey key = GetStdKeyFromHkey((StdKey) m_hRootKey);
   wxString str = bShortPrefix ? aStdKeys[key].szShortName 
                               : aStdKeys[key].szName;
   if ( !m_strKey.IsEmpty() )
@@ -297,15 +302,22 @@ wxString wxRegKey::GetName(bool bShortPrefix) const
   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
 {
-#ifdef  __WIN32__
+#if defined(__WIN32__) && !defined(__TWIN32__)
   m_dwLastError = ::RegQueryInfoKey
                   (
-                    m_hKey,
+                    (HKEY) m_hKey,
                     NULL,           // class name
                     NULL,           // (ptr to) size of class name buffer
                     RESERVED,
@@ -343,14 +355,18 @@ bool wxRegKey::Open()
   if ( IsOpened() )
     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'"),
                   GetName().c_str());
     return FALSE;
   }
   else
+  {
+    m_hKey = (WXHKEY) tmpKey;
     return TRUE;
+  }
 }
 
 // creates key, failing if it exists and !bOkIfExists
@@ -364,21 +380,25 @@ bool wxRegKey::Create(bool bOkIfExists)
   if ( IsOpened() )
     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'"),
                   GetName().c_str());
     return FALSE;
   }
   else
+  {
+    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'"),
                     GetName().c_str());
@@ -407,6 +427,18 @@ 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));
+
+      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;
@@ -420,8 +452,8 @@ bool wxRegKey::DeleteSelf()
     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;
@@ -430,7 +462,7 @@ bool wxRegKey::DeleteSelf()
   // 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());
@@ -454,8 +486,8 @@ bool wxRegKey::DeleteValue(const char *szValue)
   if ( !Open() )
     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'"),
                     szValue, GetName().c_str());
@@ -466,7 +498,7 @@ bool wxRegKey::DeleteValue(const char *szValue)
     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'"),
                     GetName().c_str());
@@ -484,9 +516,12 @@ bool wxRegKey::DeleteValue(const char *szValue)
 // 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
@@ -500,6 +535,9 @@ bool wxRegKey::HasValue(const char *szValue) const
 // 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;
@@ -509,20 +547,23 @@ bool wxRegKey::HasSubkeys() const
 // 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;
 }
 
-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'"),
@@ -539,8 +580,12 @@ wxRegKey::ValueType wxRegKey::GetValueType(const char *szValue)
 #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;
@@ -549,6 +594,7 @@ bool wxRegKey::SetValue(const char *szValue, long lValue)
   wxLogSysError(m_dwLastError, _("can't set value of '%s'"),
                 GetFullName(this, szValue));
   return FALSE;
+#endif
 }
 
 bool wxRegKey::QueryValue(const char *szValue, long *plValue) const
@@ -556,7 +602,7 @@ 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'"),
@@ -583,11 +629,11 @@ bool wxRegKey::QueryValue(const char *szValue, wxString& strValue) const
     #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 ) {
@@ -602,7 +648,7 @@ bool wxRegKey::QueryValue(const char *szValue, wxString& strValue) const
       // 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;
@@ -617,8 +663,8 @@ bool wxRegKey::QueryValue(const char *szValue, wxString& strValue) const
 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 )
@@ -627,7 +673,7 @@ bool wxRegKey::SetValue(const char *szValue, const wxString& strValue)
       // 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;
     #endif  //WIN16/32
@@ -668,12 +714,12 @@ bool wxRegKey::GetNextValue(wxString& strValueName, long& lIndex) const
   if ( lIndex == -1 )
     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 
@@ -723,7 +769,7 @@ bool wxRegKey::GetNextKey(wxString& strKeyName, long& lIndex) const
     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 ) {
@@ -742,13 +788,28 @@ 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 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;
   }
@@ -771,3 +832,7 @@ void RemoveTrailingSeparator(wxString& str)
   if ( !str.IsEmpty() && str.Last() == REG_SEPARATOR )
     str.Truncate(str.Len() - 1);
 }
+
+#endif
+  // __WIN16__
+