Added comments

[wxWidgets.git] / src / msw / regconf.cpp

diff --git a/src/msw/regconf.cpp b/src/msw/regconf.cpp
index f06413bf318de948a27c597244b87066f459d836..5d18e7f81a97959947bf22760b30e40d0f7e3eb2 100644 (file)
--- a/src/msw/regconf.cpp
+++ b/src/msw/regconf.cpp
@@ -21,18 +21,18 @@
 #endif
 
 #ifndef WX_PRECOMP
 #endif
 
 #ifndef WX_PRECOMP

-  #include  <wx/string.h>
+  #include  "wx/string.h"

 #endif //WX_PRECOMP
 
 #endif //WX_PRECOMP
 

-#include <wx/event.h>
-#include <wx/app.h>
-#include <wx/log.h>
-#include <wx/config.h>
+#include "wx/event.h"
+#include "wx/app.h"
+#include "wx/log.h"
+#include "wx/config.h"

 
 #ifndef __WIN16__
 
 
 #ifndef __WIN16__
 

-#include <wx/msw/registry.h>
-#include <wx/msw/regconf.h>
+#include "wx/msw/registry.h"
+#include "wx/msw/regconf.h"

 
 // ----------------------------------------------------------------------------
 // constants
 
 // ----------------------------------------------------------------------------
 // constants


@@ -98,7 +98,7 @@ wxRegConfig::wxRegConfig(const wxString& appName, const wxString& vendorName,
 
     if ( appName.IsEmpty() )
     {
 
     if ( appName.IsEmpty() )
     {

-      wxCHECK_RET( wxTheApp, "No application name in wxRegConfig ctor!" );
+      wxCHECK_RET( wxTheApp, T("No application name in wxRegConfig ctor!") );

       strRoot << wxTheApp->GetAppName();
     }
     else
       strRoot << wxTheApp->GetAppName();
     }
     else


@@ -287,14 +287,39 @@ size_t wxRegConfig::GetNumberOfGroups(bool bRecursive) const
 // tests for existence
 // ----------------------------------------------------------------------------
 
 // tests for existence
 // ----------------------------------------------------------------------------
 

-bool wxRegConfig::HasGroup(const wxString& strName) const
+bool wxRegConfig::HasGroup(const wxString& key) const

 {
 {

-  return m_keyLocal.HasSubKey(strName) || m_keyGlobal.HasSubKey(strName);
+    wxConfigPathChanger path(this, key);
+
+    wxString strName(path.Name());
+
+    return m_keyLocal.HasSubKey(strName) || m_keyGlobal.HasSubKey(strName);

 }
 
 }
 

-bool wxRegConfig::HasEntry(const wxString& strName) const
+bool wxRegConfig::HasEntry(const wxString& key) const

 {
 {

-  return m_keyLocal.HasValue(strName) || m_keyGlobal.HasValue(strName);
+    wxConfigPathChanger path(this, key);
+
+    wxString strName(path.Name());
+
+    return m_keyLocal.HasValue(strName) || m_keyGlobal.HasValue(strName);
+}
+
+wxConfigBase::EntryType wxRegConfig::GetEntryType(const wxString& key) const
+{
+    wxConfigPathChanger path(this, key);
+
+    wxString strName(path.Name());
+
+    bool isNumeric;
+    if ( m_keyLocal.HasValue(strName) )
+        isNumeric = m_keyLocal.IsNumericValue(strName);
+    else if ( m_keyGlobal.HasValue(strName) )
+        isNumeric = m_keyGlobal.IsNumericValue(strName);
+    else
+        return wxConfigBase::Type_Unknown;
+
+    return isNumeric ? wxConfigBase::Type_Integer : wxConfigBase::Type_String;

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -312,7 +337,7 @@ bool wxRegConfig::Read(const wxString& key, wxString *pStr) const
   if ( IsImmutable(path.Name()) ) {
     if ( TryGetValue(m_keyGlobal, path.Name(), *pStr) ) {
       if ( m_keyLocal.HasValue(path.Name()) ) {
   if ( IsImmutable(path.Name()) ) {
     if ( TryGetValue(m_keyGlobal, path.Name(), *pStr) ) {
       if ( m_keyLocal.HasValue(path.Name()) ) {

-        wxLogWarning("User value for immutable key '%s' ignored.",
+        wxLogWarning(T("User value for immutable key '%s' ignored."),

                    path.Name().c_str());
       }
      *pStr = wxConfigBase::ExpandEnvVars(*pStr);
                    path.Name().c_str());
       }
      *pStr = wxConfigBase::ExpandEnvVars(*pStr);


@@ -329,8 +354,6 @@ bool wxRegConfig::Read(const wxString& key, wxString *pStr) const
        (bQueryGlobal && TryGetValue(m_keyGlobal, path.Name(), *pStr)) ) {
     // nothing to do
 
        (bQueryGlobal && TryGetValue(m_keyGlobal, path.Name(), *pStr)) ) {
     // nothing to do
 

-    // TODO: do we return TRUE? Not in original implementation,
-    // but I don't see why not. -- JACS

     *pStr = wxConfigBase::ExpandEnvVars(*pStr);
     return TRUE;
   }
     *pStr = wxConfigBase::ExpandEnvVars(*pStr);
     return TRUE;
   }


@@ -350,7 +373,7 @@ bool wxRegConfig::Read(const wxString& key, wxString *pStr,
   if ( IsImmutable(path.Name()) ) {
     if ( TryGetValue(m_keyGlobal, path.Name(), *pStr) ) {
       if ( m_keyLocal.HasValue(path.Name()) ) {
   if ( IsImmutable(path.Name()) ) {
     if ( TryGetValue(m_keyGlobal, path.Name(), *pStr) ) {
       if ( m_keyLocal.HasValue(path.Name()) ) {

-        wxLogWarning("User value for immutable key '%s' ignored.",
+        wxLogWarning(T("User value for immutable key '%s' ignored."),

                    path.Name().c_str());
       }
 
                    path.Name().c_str());
       }
 


@@ -393,7 +416,7 @@ bool wxRegConfig::Read(const wxString& key, long *plResult) const
   if ( IsImmutable(path.Name()) ) {
     if ( TryGetValue(m_keyGlobal, path.Name(), plResult) ) {
       if ( m_keyLocal.HasValue(path.Name()) ) {
   if ( IsImmutable(path.Name()) ) {
     if ( TryGetValue(m_keyGlobal, path.Name(), plResult) ) {
       if ( m_keyLocal.HasValue(path.Name()) ) {

-        wxLogWarning("User value for immutable key '%s' ignored.",
+        wxLogWarning(T("User value for immutable key '%s' ignored."),

                      path.Name().c_str());
       }
 
                      path.Name().c_str());
       }
 


@@ -418,7 +441,7 @@ bool wxRegConfig::Write(const wxString& key, const wxString& szValue)
   wxConfigPathChanger path(this, key);
 
   if ( IsImmutable(path.Name()) ) {
   wxConfigPathChanger path(this, key);
 
   if ( IsImmutable(path.Name()) ) {

-    wxLogError("Can't change immutable entry '%s'.", path.Name().c_str());
+    wxLogError(T("Can't change immutable entry '%s'."), path.Name().c_str());

     return FALSE;
   }
 
     return FALSE;
   }
 


@@ -430,13 +453,74 @@ bool wxRegConfig::Write(const wxString& key, long lValue)
   wxConfigPathChanger path(this, key);
 
   if ( IsImmutable(path.Name()) ) {
   wxConfigPathChanger path(this, key);
 
   if ( IsImmutable(path.Name()) ) {

-    wxLogError("Can't change immutable entry '%s'.", path.Name().c_str());
+    wxLogError(T("Can't change immutable entry '%s'."), path.Name().c_str());

     return FALSE;
   }
 
   return m_keyLocal.SetValue(path.Name(), lValue);
 }
 
     return FALSE;
   }
 
   return m_keyLocal.SetValue(path.Name(), lValue);
 }
 

+// ----------------------------------------------------------------------------
+// renaming
+// ----------------------------------------------------------------------------
+
+bool wxRegConfig::RenameEntry(const wxString& oldName, const wxString& newName)
+{
+    // check that the old entry exists...
+    if ( !HasEntry(oldName) )
+        return FALSE;
+
+    // and that the new one doesn't
+    if ( HasEntry(newName) )
+        return FALSE;
+
+    // delete the old entry and create the new one - but do in the reverse
+    // order to not lose the data if Create() fails
+
+    bool ok;
+    if ( m_keyLocal.IsNumericValue(oldName) )
+    {
+        long val;
+        ok = m_keyLocal.QueryValue(oldName, &val) &&
+             m_keyLocal.SetValue(newName, val);
+    }
+    else
+    {
+        wxString val;
+        ok = m_keyLocal.QueryValue(oldName, val) &&
+             m_keyLocal.SetValue(newName, val);
+    }
+
+    if ( !ok )
+        return FALSE;
+
+    if ( !m_keyLocal.DeleteValue(oldName) )
+    {
+        m_keyLocal.DeleteValue(newName);
+
+        return FALSE;
+    }
+
+    return TRUE;
+}
+
+bool wxRegConfig::RenameGroup(const wxString& oldName, const wxString& newName)
+{
+    // check that the old group exists...
+    if ( !HasGroup(oldName) )
+        return FALSE;
+
+    // and that the new one doesn't
+    if ( HasGroup(newName) )
+        return FALSE;
+
+    // TODO there is no way to rename a registry key - we must do a deep copy
+    //      ourselves
+    wxFAIL_MSG(T("Registry key renaming not implemented"));
+
+    return FALSE;
+}
+

 // ----------------------------------------------------------------------------
 // deleting
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // deleting
 // ----------------------------------------------------------------------------


@@ -447,8 +531,8 @@ bool wxRegConfig::DeleteEntry(const wxString& value, bool bGroupIfEmptyAlso)
   if ( !m_keyLocal.DeleteValue(path.Name()) )
     return FALSE;
 
   if ( !m_keyLocal.DeleteValue(path.Name()) )
     return FALSE;
 

-  if ( !m_keyLocal.HasSubkeys() ) {
-    wxString strKey = GetPath().Right(wxCONFIG_PATH_SEPARATOR);
+  if ( m_keyLocal.IsEmpty() ) {
+    wxString strKey = GetPath().AfterLast(wxCONFIG_PATH_SEPARATOR);

     SetPath("..");  // changes m_keyLocal
     return m_keyLocal.DeleteKey(strKey);
   }
     SetPath("..");  // changes m_keyLocal
     return m_keyLocal.DeleteKey(strKey);
   }


@@ -467,16 +551,15 @@ bool wxRegConfig::DeleteAll()
 {
   m_keyLocal.Close();
   m_keyGlobal.Close();
 {
   m_keyLocal.Close();
   m_keyGlobal.Close();

-#if 1
-  wxFAIL_MSG("wxRegConfig::DeleteAll will wipe out your entire registry, so please do not use until it's fixed!");
-  return FALSE;
-#else
+

   bool bOk = m_keyLocalRoot.DeleteSelf();
   bool bOk = m_keyLocalRoot.DeleteSelf();

-  if ( bOk )
+
+  // make sure that we opened m_keyGlobalRoot and so it has a reasonable name:
+  // otherwise we will delete HKEY_CLASSES_ROOT recursively
+  if ( bOk && m_keyGlobalRoot.IsOpened() )

     bOk = m_keyGlobalRoot.DeleteSelf();
 
   return bOk;
     bOk = m_keyGlobalRoot.DeleteSelf();
 
   return bOk;

-#endif

 }
 
 #endif
 }
 
 #endif