]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/registry.cpp
Added dummy DeleteChildren so the sample will at least link.
[wxWidgets.git] / src / msw / registry.cpp
index c6d0142dc1fb940c9637b4a19935fcc8a4e3c3ad..f4cdd7b3a5d48216eb32ee18d5910cadfe61776d 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"
@@ -32,6 +28,8 @@
 #include  "wx/intl.h"
 #include  "wx/log.h"
 
+#include  "wx/config.h"    // for wxExpandEnvVars
+
 // Windows headers
 /*
 #define   STRICT
@@ -86,6 +84,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 +106,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 +124,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 +132,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 +144,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 +168,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 +187,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 +202,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 +212,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 +241,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 +251,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
@@ -256,9 +260,10 @@ void wxRegKey::SetName(const wxRegKey& keyParent, const wxString& strKey)
   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);
 
@@ -266,7 +271,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();
 
@@ -287,7 +292,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() )
@@ -296,6 +301,49 @@ 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__
+  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
 // ----------------------------------------------------------------------------
@@ -306,14 +354,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'", 
+    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
@@ -327,23 +379,27 @@ 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'", 
+    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'", 
+      wxLogSysError(m_dwLastError, _("can't close registry key '%s'"),
                     GetName().c_str());
 
       m_hKey = 0;
@@ -383,8 +439,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;
@@ -393,9 +449,10 @@ 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());
+    wxLogSysError(m_dwLastError, _("can't delete key '%s'"),
+                  GetName().c_str());
     return FALSE;
   }
 
@@ -417,9 +474,9 @@ bool wxRegKey::DeleteValue(const char *szValue)
     return FALSE;
 
   #ifdef  __WIN32__
-    m_dwLastError = RegDeleteValue(m_hKey, szValue);
+    m_dwLastError = RegDeleteValue((HKEY) m_hKey, 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;
     }
@@ -428,9 +485,9 @@ 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'", 
+      wxLogSysError(m_dwLastError, _("can't delete value of key '%s'"),
                     GetName().c_str());
       return FALSE;
     }
@@ -446,9 +503,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, szValue, RESERVED,
                              NULL, NULL, NULL) == ERROR_SUCCESS;
     }
     else
@@ -462,6 +522,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;
@@ -471,6 +534,9 @@ 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
@@ -484,10 +550,10 @@ wxRegKey::ValueType wxRegKey::GetValueType(const char *szValue)
       return Type_None;
 
     DWORD dwType;
-    m_dwLastError = RegQueryValueEx(m_hKey, szValue, RESERVED,
+    m_dwLastError = RegQueryValueEx((HKEY) m_hKey, 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;
     }
@@ -502,13 +568,13 @@ wxRegKey::ValueType wxRegKey::GetValueType(const char *szValue)
 bool wxRegKey::SetValue(const char *szValue, long lValue)
 {
   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;
   }
 
-  wxLogSysError(m_dwLastError, "can't set value of '%s'", 
+  wxLogSysError(m_dwLastError, _("can't set value of '%s'"),
                 GetFullName(this, szValue));
   return FALSE;
 }
@@ -518,10 +584,10 @@ 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, 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;
     }
@@ -545,12 +611,13 @@ 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, 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, szValue, RESERVED,
                                         &dwType, pBuf, &dwSize);
+        strValue.UngetWriteBuf();
         if ( m_dwLastError == ERROR_SUCCESS ) {
           // check that it was the right type
           wxASSERT_MSG( dwType == REG_SZ, 
@@ -563,13 +630,14 @@ 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;
     #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;
 }
@@ -578,7 +646,7 @@ bool wxRegKey::SetValue(const char *szValue, const wxString& strValue)
 {
   if ( CONST_CAST Open() ) {
     #ifdef  __WIN32__
-      m_dwLastError = RegSetValueEx(m_hKey, szValue, RESERVED, REG_SZ, 
+      m_dwLastError = RegSetValueEx((HKEY) m_hKey, szValue, (DWORD) RESERVED, REG_SZ,
                                     (RegString)strValue.c_str(), 
                                     strValue.Len() + 1);
       if ( m_dwLastError == ERROR_SUCCESS )
@@ -587,13 +655,13 @@ 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
   }
 
-  wxLogSysError(m_dwLastError, "can't set value of '%s'", 
+  wxLogSysError(m_dwLastError, _("can't set value of '%s'"),
                 GetFullName(this, szValue));
   return FALSE;
 }
@@ -633,7 +701,7 @@ bool wxRegKey::GetNextValue(wxString& strValueName, long& lIndex) const
     DWORD dwValueLen = WXSIZEOF(szValueName);
 
     lIndex++;
-    m_dwLastError = RegEnumValue(m_hKey, lIndex, 
+    m_dwLastError = RegEnumValue((HKEY) m_hKey, lIndex,
                                  szValueName, &dwValueLen,
                                  RESERVED, 
                                  NULL,            // [out] type 
@@ -646,7 +714,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());
       }
 
@@ -683,7 +751,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 ) {
@@ -691,7 +759,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());
     }
 
@@ -703,12 +771,12 @@ bool wxRegKey::GetNextKey(wxString& strKeyName, long& lIndex) const
 }
 
 // ============================================================================
-// 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;
   }