]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/registry.cpp
Corrected the signature for wxFrame::Maximize
[wxWidgets.git] / src / msw / registry.cpp
index 480206990e06e7cf456e908a3866cbac179d6861..1fcc78c55f926aa263b3b8a403cfd0164cf72e73 100644 (file)
 #include  "wx/log.h"
 
 // Windows headers
+/*
 #define   STRICT
 #define   WIN32_LEAN_AND_MEAN
+*/
+
 #include  <windows.h>
 
 // other std headers
 #include  <stdlib.h>      // for _MAX_PATH
 
 #ifndef _MAX_PATH
-#define _MAX_PATH 256
+       #define _MAX_PATH 512
 #endif
 
 // our header
@@ -75,7 +78,7 @@ aStdKeys[] =
   { HKEY_CURRENT_CONFIG,    "HKEY_CURRENT_CONFIG",    "HKCC" },
 #ifndef __GNUWIN32__
   { HKEY_DYN_DATA,          "HKEY_DYN_DATA",          "HKDD" }, // short name?
-#endif  //_GNUWIN32__
+#endif  //GNUWIN32
 #endif  //WINVER >= 4.0
 #endif  //WIN32
 };
@@ -97,6 +100,9 @@ aStdKeys[] =
 // non member functions
 // ----------------------------------------------------------------------------
 
+// 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);
 
@@ -119,7 +125,7 @@ const size_t wxRegKey::nStdKeys = WXSIZEOF(aStdKeys);
 const char *wxRegKey::GetStdKeyName(uint 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;
 }
@@ -127,7 +133,7 @@ const char *wxRegKey::GetStdKeyName(uint key)
 const char *wxRegKey::GetStdKeyShortName(uint key)
 {
   // return empty string if key is invalid
-  wxCHECK_RET( key < nStdKeys, "" );
+  wxCHECK( key < nStdKeys, "" );
 
   return aStdKeys[key].szShortName;
 }
@@ -193,9 +199,7 @@ wxRegKey::wxRegKey(const wxString& strKey) : m_strKey(strKey)
 // parent is a predefined (and preopened) key
 wxRegKey::wxRegKey(StdKey keyParent, const wxString& strKey) : m_strKey(strKey)
 {
-  if ( !m_strKey.IsEmpty() && m_strKey.Last() == REG_SEPARATOR )
-    m_strKey.Truncate(m_strKey.Len() - 1);
-
+  RemoveTrailingSeparator(m_strKey);
   m_hRootKey  = aStdKeys[keyParent].hkey;
   m_hKey      = NULL;
   m_dwLastError = 0;
@@ -206,12 +210,11 @@ 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 ( !strKey.IsEmpty() && strKey[0] != REG_SEPARATOR )
       m_strKey  += REG_SEPARATOR;
 
   m_strKey += strKey;
-  if ( !m_strKey.IsEmpty() && m_strKey.Last() == REG_SEPARATOR )
-    m_strKey.Truncate(m_strKey.Len() - 1);
+  RemoveTrailingSeparator(m_strKey);
 
   m_hRootKey  = keyParent.m_hRootKey;
   m_hKey      = NULL;
@@ -224,6 +227,53 @@ wxRegKey::~wxRegKey()
   Close();
 }
 
+// ----------------------------------------------------------------------------
+// change the key name/hkey
+// ----------------------------------------------------------------------------
+
+// set the full key name
+void wxRegKey::SetName(const wxString& strKey)
+{
+  Close();
+
+  m_strKey = strKey;
+  m_hRootKey = aStdKeys[ExtractKeyName(m_strKey)].hkey;
+}
+
+// the name is relative to the parent key
+void wxRegKey::SetName(StdKey keyParent, const wxString& strKey)
+{
+  Close();
+
+  m_strKey = strKey;
+  RemoveTrailingSeparator(m_strKey);
+  m_hRootKey = aStdKeys[keyParent].hkey;
+}
+
+// the name is relative to the parent key
+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;
+  if ( !strKey.IsEmpty() && strKey[0] != REG_SEPARATOR )
+    m_strKey += REG_SEPARATOR;
+  m_strKey += strKey;
+
+  RemoveTrailingSeparator(m_strKey);
+
+  m_hRootKey = keyParent.m_hRootKey;
+}
+
+// hKey should be opened and will be closed in wxRegKey dtor
+void wxRegKey::SetHkey(HKEY hKey)
+{
+  Close();
+
+  m_hKey = hKey;
+}
+
 // ----------------------------------------------------------------------------
 // info about the key
 // ----------------------------------------------------------------------------
@@ -247,6 +297,49 @@ wxString wxRegKey::GetName(bool bShortPrefix) const
   return str;
 }
 
+#ifdef __GNUWIN32__
+bool wxRegKey::GetKeyInfo(uint* pnSubKeys,
+                          uint* pnMaxKeyLen,
+                          uint* pnValues,
+                          uint* pnMaxValueLen) const
+#else
+bool wxRegKey::GetKeyInfo(ulong *pnSubKeys,
+                          ulong *pnMaxKeyLen,
+                          ulong *pnValues,
+                          ulong *pnMaxValueLen) const
+#endif
+{
+#ifdef  __WIN32__
+  m_dwLastError = ::RegQueryInfoKey
+                  (
+                    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
 // ----------------------------------------------------------------------------
@@ -259,7 +352,7 @@ bool wxRegKey::Open()
 
   m_dwLastError = RegOpenKey(m_hRootKey, m_strKey, &m_hKey);
   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;
   }
@@ -280,7 +373,7 @@ bool wxRegKey::Create(bool bOkIfExists)
 
   m_dwLastError = RegCreateKey(m_hRootKey, m_strKey, &m_hKey);
   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;
   }
@@ -288,27 +381,66 @@ bool wxRegKey::Create(bool bOkIfExists)
     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);
+    if ( m_dwLastError != ERROR_SUCCESS ) {
+      wxLogSysError(m_dwLastError, _("can't close registry key '%s'"),
+                    GetName().c_str());
+
+      m_hKey = 0;
+      return FALSE;
+    }
+    else {
+      m_hKey = 0;
+    }
+  }
+
+  return TRUE;
+}
+
+// ----------------------------------------------------------------------------
+// delete keys/values
+// ----------------------------------------------------------------------------
 bool wxRegKey::DeleteSelf()
 {
-  if ( !Open() )
-    return FALSE;
+  {
+    wxLogNull nolog;
+    if ( !Open() ) {
+      // it already doesn't exist - ok!
+      return TRUE;
+    }
+  }
+
+  // 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;
 
   wxString strKey;
   long lIndex;
   bool bCont = GetFirstKey(strKey, lIndex);
   while ( bCont ) {
-    wxRegKey key(*this, strKey);
-    if ( !key.DeleteSelf() )
-      return FALSE;
+    astrSubkeys.Add(strKey);
 
     bCont = GetNextKey(strKey, lIndex);
   }
 
+  uint nKeyCount = astrSubkeys.Count();
+  for ( uint 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);
   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;
   }
 
@@ -332,7 +464,7 @@ bool wxRegKey::DeleteValue(const char *szValue)
   #ifdef  __WIN32__
     m_dwLastError = RegDeleteValue(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;
     }
@@ -343,7 +475,7 @@ bool wxRegKey::DeleteValue(const char *szValue)
     // just set the (default and unique) value of the key to ""
     m_dwLastError = RegSetValue(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;
     }
@@ -352,30 +484,26 @@ bool wxRegKey::DeleteValue(const char *szValue)
   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);
-    if ( m_dwLastError != ERROR_SUCCESS ) {
-      wxLogSysError(m_dwLastError, "can't close registry key '%s'", 
-                    GetName().c_str());
-
-      m_hKey = 0;
-      return FALSE;
-    }
-    else {
-      m_hKey = 0;
-    }
-  }
-
-  return TRUE;
-}
-
 // ----------------------------------------------------------------------------
 // access to values and subkeys
 // ----------------------------------------------------------------------------
 
+// return TRUE if value exists
+bool wxRegKey::HasValue(const char *szValue) const
+{
+  #ifdef  __WIN32__
+    if ( CONST_CAST Open() ) {
+      return RegQueryValueEx(m_hKey, szValue, RESERVED, 
+                             NULL, NULL, NULL) == ERROR_SUCCESS;
+    }
+    else
+      return FALSE;
+  #else   // WIN16
+    // only unnamed value exists
+    return IsEmpty(szValue);
+  #endif  // WIN16/32
+}
+
 // returns TRUE if this key has any subkeys
 bool wxRegKey::HasSubkeys() const
 {
@@ -404,7 +532,7 @@ wxRegKey::ValueType wxRegKey::GetValueType(const char *szValue)
     m_dwLastError = RegQueryValueEx(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;
     }
@@ -425,7 +553,7 @@ bool wxRegKey::SetValue(const char *szValue, long lValue)
       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;
 }
@@ -438,7 +566,7 @@ bool wxRegKey::QueryValue(const char *szValue, long *plValue) const
     m_dwLastError = RegQueryValueEx(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;
     }
@@ -468,6 +596,7 @@ bool wxRegKey::QueryValue(const char *szValue, wxString& strValue) const
         RegString pBuf = (RegString)strValue.GetWriteBuf(dwSize);
         m_dwLastError = RegQueryValueEx(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, 
@@ -481,12 +610,13 @@ bool wxRegKey::QueryValue(const char *szValue, wxString& strValue) const
       wxASSERT( IsEmpty(szValue) );
 
       m_dwLastError = RegQueryValue(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;
 }
@@ -510,7 +640,7 @@ bool wxRegKey::SetValue(const char *szValue, const wxString& strValue)
     #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;
 }
@@ -528,105 +658,79 @@ wxRegKey::operator wxString() const
 //     several concurrently running indexations on the same key
 // ----------------------------------------------------------------------------
 
-#ifdef  __WIN32__
 bool wxRegKey::GetFirstValue(wxString& strValueName, long& lIndex)
 {
   if ( !Open() )
     return FALSE;
 
-  char  szValueName[1024];                  // @@ use RegQueryInfoKey...
-  DWORD dwValueLen = WXSIZEOF(szValueName);
-
   lIndex = 0;
-  m_dwLastError = RegEnumValue(m_hKey, lIndex, 
-                               szValueName, &dwValueLen,
-                               RESERVED, 
-                               NULL,            // [out] type 
-                               NULL,            // [out] buffer for value
-                               NULL);           // [i/o]  it's length
-
-  if ( m_dwLastError != ERROR_SUCCESS ) {
-    if ( m_dwLastError == ERROR_NO_MORE_ITEMS )
-      lIndex = -1;
-    else {
-      wxLogSysError(m_dwLastError, "can't enumerate values of key '%s'", 
-                    GetName().c_str());
-    }
-
-    return FALSE;
-  }
-
-  strValueName = szValueName;
-  return TRUE;
+  return GetNextValue(strValueName, lIndex);
 }
 
 bool wxRegKey::GetNextValue(wxString& strValueName, long& lIndex) const
 {
   wxASSERT( IsOpened() );
-  wxASSERT( lIndex != -1 );
 
-  char  szValueName[1024];                  // @@ use RegQueryInfoKey...
-  DWORD dwValueLen = WXSIZEOF(szValueName);
+  // are we already at the end of enumeration?
+  if ( lIndex == -1 )
+    return FALSE;
+
+  #ifdef  __WIN32__
+    char  szValueName[1024];                  // @@ use RegQueryInfoKey...
+    DWORD dwValueLen = WXSIZEOF(szValueName);
 
-  lIndex++;
-  m_dwLastError = RegEnumValue(m_hKey, lIndex, 
-                               szValueName, &dwValueLen,
-                               RESERVED, 
-                               NULL,           // buffer for type 
-                               NULL, NULL);    // buffer for value and length
+    lIndex++;
+    m_dwLastError = RegEnumValue(m_hKey, lIndex, 
+                                 szValueName, &dwValueLen,
+                                 RESERVED, 
+                                 NULL,            // [out] type 
+                                 NULL,            // [out] buffer for value
+                                 NULL);           // [i/o]  it's length
 
-  if ( m_dwLastError != ERROR_SUCCESS ) {
-    if ( m_dwLastError == ERROR_NO_MORE_ITEMS ) {
-      m_dwLastError = ERROR_SUCCESS;
-      lIndex = -1;
-    }
-    else {
-      wxLogSysError(m_dwLastError, "can't enumerate values of key '%s'", 
-                    GetName().c_str());
+    if ( m_dwLastError != ERROR_SUCCESS ) {
+      if ( m_dwLastError == ERROR_NO_MORE_ITEMS ) {
+        m_dwLastError = ERROR_SUCCESS;
+        lIndex = -1;
+      }
+      else {
+        wxLogSysError(m_dwLastError, _("can't enumerate values of key '%s'"),
+                      GetName().c_str());
+      }
+
+      return FALSE;
     }
 
-    return FALSE;
-  }
+    strValueName = szValueName;
+  #else   //WIN16
+    // only one unnamed value
+    wxASSERT( lIndex == 0 );
+
+    lIndex = -1;
+    strValueName.Empty();
+  #endif
 
-  strValueName = szValueName;
   return TRUE;
 }
-#endif  //Win32
 
 bool wxRegKey::GetFirstKey(wxString& strKeyName, long& lIndex)
 {
   if ( !Open() )
     return FALSE;
 
-  char szKeyName[_MAX_PATH + 1];
   lIndex = 0;
-  m_dwLastError = RegEnumKey(m_hKey, lIndex, szKeyName, WXSIZEOF(szKeyName));
-
-  if ( m_dwLastError != ERROR_SUCCESS ) {
-    if ( m_dwLastError == ERROR_NO_MORE_ITEMS ) {
-      m_dwLastError = ERROR_SUCCESS;
-      lIndex = -1;
-    }
-    else {
-      wxLogSysError(m_dwLastError, "can't enumerate subkeys of key '%s'", 
-                    GetName().c_str());
-    }
-
-    return FALSE;
-  }
-
-  strKeyName = szKeyName;
-  return TRUE;
+  return GetNextKey(strKeyName, lIndex);
 }
 
 bool wxRegKey::GetNextKey(wxString& strKeyName, long& lIndex) const
 {
   wxASSERT( IsOpened() );
-  wxASSERT( lIndex != -1 );
+
+  // are we already at the end of enumeration?
+  if ( lIndex == -1 )
+    return FALSE;
 
   char szKeyName[_MAX_PATH + 1];
-  lIndex++;
-  m_dwLastError = RegEnumKey(m_hKey, lIndex, szKeyName, WXSIZEOF(szKeyName));
+  m_dwLastError = RegEnumKey(m_hKey, lIndex++, szKeyName, WXSIZEOF(szKeyName));
 
   if ( m_dwLastError != ERROR_SUCCESS ) {
     if ( m_dwLastError == ERROR_NO_MORE_ITEMS ) {
@@ -634,7 +738,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());
     }
 
@@ -667,4 +771,10 @@ const char *GetFullName(const wxRegKey *pKey, const char *szValue)
     s_str << "\\" << szValue;
 
   return s_str.c_str();
-}
\ No newline at end of file
+}
+
+void RemoveTrailingSeparator(wxString& str)
+{
+  if ( !str.IsEmpty() && str.Last() == REG_SEPARATOR )
+    str.Truncate(str.Len() - 1);
+}