no real changes, just extract private classes from msw/dc.cpp into a private header...

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

diff --git a/src/msw/regconf.cpp b/src/msw/regconf.cpp
index c7b7a470e60c3648793b5cf8c65d2f16114c0591..363987830b781998034fb8baf9d8c0e4e1088e53 100644 (file)
--- a/src/msw/regconf.cpp
+++ b/src/msw/regconf.cpp
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        msw/regconf.cpp
+// Name:        src/msw/regconf.cpp

 // Purpose:
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:
 // Author:      Vadim Zeitlin
 // Modified by:


@@ -9,31 +9,24 @@
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma implementation "regconf.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-#pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #endif
 

-#ifndef WX_PRECOMP
-  #include  "wx/string.h"
-  #include  "wx/intl.h"
-#endif //WX_PRECOMP
-
-#include "wx/event.h"
-#include "wx/app.h"
-#include "wx/log.h"
-
-#if wxUSE_CONFIG
+#if wxUSE_CONFIG && wxUSE_REGKEY

 
 #include "wx/config.h"
 
 
 #include "wx/config.h"
 

-#ifndef __WIN16__
+#ifndef WX_PRECOMP
+    #include  "wx/string.h"
+    #include  "wx/intl.h"
+    #include "wx/log.h"
+    #include "wx/event.h"
+    #include "wx/app.h"
+#endif //WX_PRECOMP

 
 #include "wx/msw/registry.h"
 #include "wx/msw/regconf.h"
 
 #include "wx/msw/registry.h"
 #include "wx/msw/regconf.h"


@@ -60,6 +53,11 @@ bool TryGetValue(const wxRegKey& key, const wxString& str, long *plVal)
   return key.IsOpened() && key.HasValue(str) && key.QueryValue(str, plVal);
 }
 
   return key.IsOpened() && key.HasValue(str) && key.QueryValue(str, plVal);
 }
 

+bool TryGetValue(const wxRegKey& key, const wxString& str, wxMemoryBuffer &plVal)
+{
+  return key.IsOpened() && key.HasValue(str) && key.QueryValue(str, plVal);
+}
+

 // ============================================================================
 // implementation
 // ============================================================================
 // ============================================================================
 // implementation
 // ============================================================================


@@ -67,6 +65,7 @@ bool TryGetValue(const wxRegKey& key, const wxString& str, long *plVal)
 // ----------------------------------------------------------------------------
 // ctor/dtor
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // ctor/dtor
 // ----------------------------------------------------------------------------

+IMPLEMENT_ABSTRACT_CLASS(wxRegConfig, wxConfigBase)

 
 // create the config object which stores its data under HKCU\vendor\app and, if
 // style & wxCONFIG_USE_GLOBAL_FILE, under HKLM\vendor\app
 
 // create the config object which stores its data under HKCU\vendor\app and, if
 // style & wxCONFIG_USE_GLOBAL_FILE, under HKLM\vendor\app


@@ -82,9 +81,9 @@ wxRegConfig::wxRegConfig(const wxString& appName, const wxString& vendorName,
   // the convention is to put the programs keys under <vendor>\<appname>
   // (but it can be overriden by specifying the pathes explicitly in strLocal
   // and/or strGlobal)
   // the convention is to put the programs keys under <vendor>\<appname>
   // (but it can be overriden by specifying the pathes explicitly in strLocal
   // and/or strGlobal)

-  if ( strLocal.IsEmpty() || (strGlobal.IsEmpty() && bDoUseGlobal) )
+  if ( strLocal.empty() || (strGlobal.empty() && bDoUseGlobal) )

   {
   {

-    if ( vendorName.IsEmpty() )
+    if ( vendorName.empty() )

     {
       if ( wxTheApp )
         strRoot = wxTheApp->GetVendorName();
     {
       if ( wxTheApp )
         strRoot = wxTheApp->GetVendorName();


@@ -95,12 +94,12 @@ wxRegConfig::wxRegConfig(const wxString& appName, const wxString& vendorName,
     }
 
     // no '\\' needed if no vendor name
     }
 
     // no '\\' needed if no vendor name

-    if ( !strRoot.IsEmpty() )
+    if ( !strRoot.empty() )

     {
       strRoot += '\\';
     }
 
     {
       strRoot += '\\';
     }
 

-    if ( appName.IsEmpty() )
+    if ( appName.empty() )

     {
       wxCHECK_RET( wxTheApp, wxT("No application name in wxRegConfig ctor!") );
       strRoot << wxTheApp->GetAppName();
     {
       wxCHECK_RET( wxTheApp, wxT("No application name in wxRegConfig ctor!") );
       strRoot << wxTheApp->GetAppName();


@@ -112,7 +111,7 @@ wxRegConfig::wxRegConfig(const wxString& appName, const wxString& vendorName,
   }
   //else: we don't need to do all the complicated stuff above
 
   }
   //else: we don't need to do all the complicated stuff above
 

-  wxString str = strLocal.IsEmpty() ? strRoot : strLocal;
+  wxString str = strLocal.empty() ? strRoot : strLocal;

 
   // as we're going to change the name of these keys fairly often and as
   // there are only few of wxRegConfig objects (usually 1), we can allow
 
   // as we're going to change the name of these keys fairly often and as
   // there are only few of wxRegConfig objects (usually 1), we can allow


@@ -128,7 +127,7 @@ wxRegConfig::wxRegConfig(const wxString& appName, const wxString& vendorName,
 
   if ( bDoUseGlobal )
   {
 
   if ( bDoUseGlobal )
   {

-    str = strGlobal.IsEmpty() ? strRoot : strGlobal;
+    str = strGlobal.empty() ? strRoot : strGlobal;

 
     m_keyGlobalRoot.ReserveMemoryForName(MEMORY_PREALLOC);
     m_keyGlobal.ReserveMemoryForName(MEMORY_PREALLOC);
 
     m_keyGlobalRoot.ReserveMemoryForName(MEMORY_PREALLOC);
     m_keyGlobal.ReserveMemoryForName(MEMORY_PREALLOC);


@@ -148,16 +147,11 @@ wxRegConfig::wxRegConfig(const wxString& appName, const wxString& vendorName,
   if ( bDoUseGlobal )
   {
     wxLogNull nolog;
   if ( bDoUseGlobal )
   {
     wxLogNull nolog;

-    m_keyGlobalRoot.Open();
-    m_keyGlobal.Open();
+    m_keyGlobalRoot.Open(wxRegKey::Read);
+    m_keyGlobal.Open(wxRegKey::Read);

   }
 }
 
   }
 }
 

-wxRegConfig::~wxRegConfig()
-{
-  // nothing to do - key will be closed in their dtors
-}
-

 // ----------------------------------------------------------------------------
 // path management
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // path management
 // ----------------------------------------------------------------------------


@@ -182,7 +176,7 @@ void wxRegConfig::SetPath(const wxString& strPath)
 
         // because GetPath() returns "" when we're at root, we must understand
         // empty string as "/"
 
         // because GetPath() returns "" when we're at root, we must understand
         // empty string as "/"

-        if ( strPath.IsEmpty() || (strPath[0] == wxCONFIG_PATH_SEPARATOR) ) {
+        if ( strPath.empty() || (strPath[0] == wxCONFIG_PATH_SEPARATOR) ) {

             // absolute path
             wxSplitPath(aParts, strPath);
         }
             // absolute path
             wxSplitPath(aParts, strPath);
         }


@@ -222,9 +216,9 @@ void wxRegConfig::SetPath(const wxString& strPath)
             strFullPath.reserve(2*m_strPath.length());
 
             strFullPath << m_strPath;
             strFullPath.reserve(2*m_strPath.length());
 
             strFullPath << m_strPath;

-            if ( strFullPath.Len() == 0 || 
+            if ( strFullPath.Len() == 0 ||

                  strFullPath.Last() != wxCONFIG_PATH_SEPARATOR )
                  strFullPath.Last() != wxCONFIG_PATH_SEPARATOR )

-                strFullPath << wxCONFIG_PATH_SEPARATOR; 
+                strFullPath << wxCONFIG_PATH_SEPARATOR;

             strFullPath << strPath;
         }
 
             strFullPath << strPath;
         }
 


@@ -386,13 +380,14 @@ void wxRegConfig::SetPath(const wxString& strPath)
 
     // change current key(s)
     m_keyLocal.SetName(m_keyLocalRoot, strRegPath);
 
     // change current key(s)
     m_keyLocal.SetName(m_keyLocalRoot, strRegPath);

-    m_keyGlobal.SetName(m_keyGlobalRoot, strRegPath);

 
 

-    // don't create it right now, wait until it is accessed
-    //m_keyLocal.Create();
+    if ( GetStyle() & wxCONFIG_USE_GLOBAL_FILE )
+    {
+      m_keyGlobal.SetName(m_keyGlobalRoot, strRegPath);

 
 

-    wxLogNull nolog;
-    m_keyGlobal.Open();
+      wxLogNull nolog;
+      m_keyGlobal.Open(wxRegKey::Read);
+    }

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


@@ -424,7 +419,7 @@ bool wxRegConfig::GetNextGroup(wxString& str, long& lIndex) const
     while ( m_keyGlobal.GetNextKey(str, lIndex) ) {
       if ( !m_keyLocal.Exists() || !LocalKey().HasSubKey(str) ) {
         // ok, found one - return it
     while ( m_keyGlobal.GetNextKey(str, lIndex) ) {
       if ( !m_keyLocal.Exists() || !LocalKey().HasSubKey(str) ) {
         // ok, found one - return it

-        return TRUE;
+        return true;

       }
     }
 
       }
     }
 


@@ -434,7 +429,7 @@ bool wxRegConfig::GetNextGroup(wxString& str, long& lIndex) const
 
   // if we don't have the key at all, don't try to enumerate anything under it
   if ( !m_keyLocal.Exists() )
 
   // if we don't have the key at all, don't try to enumerate anything under it
   if ( !m_keyLocal.Exists() )

-      return FALSE;
+      return false;

 
   // much easier with local entries: get the next one we find
   // (don't forget to clear our flag bit and set it again later)
 
   // much easier with local entries: get the next one we find
   // (don't forget to clear our flag bit and set it again later)


@@ -459,7 +454,7 @@ bool wxRegConfig::GetNextEntry(wxString& str, long& lIndex) const
     while ( m_keyGlobal.GetNextValue(str, lIndex) ) {
       if ( !m_keyLocal.Exists() || !LocalKey().HasValue(str) ) {
         // ok, found one - return it
     while ( m_keyGlobal.GetNextValue(str, lIndex) ) {
       if ( !m_keyLocal.Exists() || !LocalKey().HasValue(str) ) {
         // ok, found one - return it

-        return TRUE;
+        return true;

       }
     }
 
       }
     }
 


@@ -469,7 +464,7 @@ bool wxRegConfig::GetNextEntry(wxString& str, long& lIndex) const
 
   // if we don't have the key at all, don't try to enumerate anything under it
   if ( !m_keyLocal.Exists() )
 
   // if we don't have the key at all, don't try to enumerate anything under it
   if ( !m_keyLocal.Exists() )

-      return FALSE;
+      return false;

 
   // much easier with local entries: get the next one we find
   // (don't forget to clear our flag bit and set it again later)
 
   // much easier with local entries: get the next one we find
   // (don't forget to clear our flag bit and set it again later)


@@ -561,11 +556,11 @@ wxConfigBase::EntryType wxRegConfig::GetEntryType(const wxString& key) const
 
 bool wxRegConfig::DoReadString(const wxString& key, wxString *pStr) const
 {
 
 bool wxRegConfig::DoReadString(const wxString& key, wxString *pStr) const
 {

-    wxCHECK_MSG( pStr, FALSE, _T("wxRegConfig::Read(): NULL param") );
+    wxCHECK_MSG( pStr, false, _T("wxRegConfig::Read(): NULL param") );

 
   wxConfigPathChanger path(this, key);
 
 
   wxConfigPathChanger path(this, key);
 

-  bool bQueryGlobal = TRUE;
+  bool bQueryGlobal = true;

 
   // if immutable key exists in global key we must check that it's not
   // overriden by the local key with the same name
 
   // if immutable key exists in global key we must check that it's not
   // overriden by the local key with the same name


@@ -576,21 +571,21 @@ bool wxRegConfig::DoReadString(const wxString& key, wxString *pStr) const
                    path.Name().c_str());
       }
 
                    path.Name().c_str());
       }
 

-      return TRUE;
+      return true;

     }
     else {
       // don't waste time - it's not there anyhow
     }
     else {
       // don't waste time - it's not there anyhow

-      bQueryGlobal = FALSE;
+      bQueryGlobal = false;

     }
   }
 
   // first try local key
   if ( (m_keyLocal.Exists() && TryGetValue(LocalKey(), path.Name(), *pStr)) ||
        (bQueryGlobal && TryGetValue(m_keyGlobal, path.Name(), *pStr)) ) {
     }
   }
 
   // first try local key
   if ( (m_keyLocal.Exists() && TryGetValue(LocalKey(), path.Name(), *pStr)) ||
        (bQueryGlobal && TryGetValue(m_keyGlobal, path.Name(), *pStr)) ) {

-    return TRUE;
+    return true;

   }
 
   }
 

-  return FALSE;
+  return false;

 }
 
 // this exactly reproduces the string version above except for ExpandEnvVars(),
 }
 
 // this exactly reproduces the string version above except for ExpandEnvVars(),


@@ -598,11 +593,11 @@ bool wxRegConfig::DoReadString(const wxString& key, wxString *pStr) const
 
 bool wxRegConfig::DoReadLong(const wxString& key, long *plResult) const
 {
 
 bool wxRegConfig::DoReadLong(const wxString& key, long *plResult) const
 {

-    wxCHECK_MSG( plResult, FALSE, _T("wxRegConfig::Read(): NULL param") );
+    wxCHECK_MSG( plResult, false, _T("wxRegConfig::Read(): NULL param") );

 
   wxConfigPathChanger path(this, key);
 
 
   wxConfigPathChanger path(this, key);
 

-  bool bQueryGlobal = TRUE;
+  bool bQueryGlobal = true;

 
   // if immutable key exists in global key we must check that it's not
   // overriden by the local key with the same name
 
   // if immutable key exists in global key we must check that it's not
   // overriden by the local key with the same name


@@ -613,21 +608,55 @@ bool wxRegConfig::DoReadLong(const wxString& key, long *plResult) const
                      path.Name().c_str());
       }
 
                      path.Name().c_str());
       }
 

-      return TRUE;
+      return true;

     }
     else {
       // don't waste time - it's not there anyhow
     }
     else {
       // don't waste time - it's not there anyhow

-      bQueryGlobal = FALSE;
+      bQueryGlobal = false;

     }
   }
 
   // first try local key
   if ( (m_keyLocal.Exists() && TryGetValue(LocalKey(), path.Name(), plResult)) ||
        (bQueryGlobal && TryGetValue(m_keyGlobal, path.Name(), plResult)) ) {
     }
   }
 
   // first try local key
   if ( (m_keyLocal.Exists() && TryGetValue(LocalKey(), path.Name(), plResult)) ||
        (bQueryGlobal && TryGetValue(m_keyGlobal, path.Name(), plResult)) ) {

-    return TRUE;
+    return true;
+  }
+
+  return false;
+}
+
+bool wxRegConfig::DoReadBinary(const wxString& key, wxMemoryBuffer *buf) const
+{
+    wxCHECK_MSG( buf, false, _T("wxRegConfig::Read(): NULL param") );
+
+  wxConfigPathChanger path(this, key);
+
+  bool bQueryGlobal = true;
+
+  // if immutable key exists in global key we must check that it's not
+  // overriden by the local key with the same name
+  if ( IsImmutable(path.Name()) ) {
+    if ( TryGetValue(m_keyGlobal, path.Name(), *buf) ) {
+      if ( m_keyLocal.Exists() && LocalKey().HasValue(path.Name()) ) {
+        wxLogWarning(wxT("User value for immutable key '%s' ignored."),
+                   path.Name().c_str());
+      }
+
+      return true;
+    }
+    else {
+      // don't waste time - it's not there anyhow
+      bQueryGlobal = false;
+    }

   }
 
   }
 

-  return FALSE;
+  // first try local key
+  if ( (m_keyLocal.Exists() && TryGetValue(LocalKey(), path.Name(), *buf)) ||
+       (bQueryGlobal && TryGetValue(m_keyGlobal, path.Name(), *buf)) ) {
+    return true;
+  }
+
+  return false;

 }
 
 bool wxRegConfig::DoWriteString(const wxString& key, const wxString& szValue)
 }
 
 bool wxRegConfig::DoWriteString(const wxString& key, const wxString& szValue)


@@ -636,7 +665,7 @@ bool wxRegConfig::DoWriteString(const wxString& key, const wxString& szValue)
 
   if ( IsImmutable(path.Name()) ) {
     wxLogError(wxT("Can't change immutable entry '%s'."), path.Name().c_str());
 
   if ( IsImmutable(path.Name()) ) {
     wxLogError(wxT("Can't change immutable entry '%s'."), path.Name().c_str());

-    return FALSE;
+    return false;

   }
 
   return LocalKey().SetValue(path.Name(), szValue);
   }
 
   return LocalKey().SetValue(path.Name(), szValue);


@@ -648,12 +677,24 @@ bool wxRegConfig::DoWriteLong(const wxString& key, long lValue)
 
   if ( IsImmutable(path.Name()) ) {
     wxLogError(wxT("Can't change immutable entry '%s'."), path.Name().c_str());
 
   if ( IsImmutable(path.Name()) ) {
     wxLogError(wxT("Can't change immutable entry '%s'."), path.Name().c_str());

-    return FALSE;
+    return false;

   }
 
   return LocalKey().SetValue(path.Name(), lValue);
 }
 
   }
 
   return LocalKey().SetValue(path.Name(), lValue);
 }
 

+bool wxRegConfig::DoWriteBinary(const wxString& key, const wxMemoryBuffer& buf)
+{
+  wxConfigPathChanger path(this, key);
+
+  if ( IsImmutable(path.Name()) ) {
+    wxLogError(wxT("Can't change immutable entry '%s'."), path.Name().c_str());
+    return false;
+  }
+
+  return LocalKey().SetValue(path.Name(), buf);
+}
+

 // ----------------------------------------------------------------------------
 // renaming
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // renaming
 // ----------------------------------------------------------------------------


@@ -662,11 +703,11 @@ bool wxRegConfig::RenameEntry(const wxString& oldName, const wxString& newName)
 {
     // check that the old entry exists...
     if ( !HasEntry(oldName) )
 {
     // check that the old entry exists...
     if ( !HasEntry(oldName) )

-        return FALSE;
+        return false;

 
     // and that the new one doesn't
     if ( HasEntry(newName) )
 
     // and that the new one doesn't
     if ( HasEntry(newName) )

-        return FALSE;
+        return false;

 
     return m_keyLocal.RenameValue(oldName, newName);
 }
 
     return m_keyLocal.RenameValue(oldName, newName);
 }


@@ -675,11 +716,11 @@ bool wxRegConfig::RenameGroup(const wxString& oldName, const wxString& newName)
 {
     // check that the old group exists...
     if ( !HasGroup(oldName) )
 {
     // check that the old group exists...
     if ( !HasGroup(oldName) )

-        return FALSE;
+        return false;

 
     // and that the new one doesn't
     if ( HasGroup(newName) )
 
     // and that the new one doesn't
     if ( HasGroup(newName) )

-        return FALSE;
+        return false;

 
     return wxRegKey(m_keyLocal, oldName).Rename(newName);
 }
 
     return wxRegKey(m_keyLocal, oldName).Rename(newName);
 }


@@ -687,29 +728,41 @@ bool wxRegConfig::RenameGroup(const wxString& oldName, const wxString& newName)
 // ----------------------------------------------------------------------------
 // deleting
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // deleting
 // ----------------------------------------------------------------------------

-bool wxRegConfig::DeleteEntry(const wxString& value, bool WXUNUSED(bGroupIfEmptyAlso))
+
+bool wxRegConfig::DeleteEntry(const wxString& value, bool bGroupIfEmptyAlso)

 {
   wxConfigPathChanger path(this, value);
 
   if ( m_keyLocal.Exists() ) {
     if ( !m_keyLocal.DeleteValue(path.Name()) )
 {
   wxConfigPathChanger path(this, value);
 
   if ( m_keyLocal.Exists() ) {
     if ( !m_keyLocal.DeleteValue(path.Name()) )

-      return FALSE;
+      return false;

 
 

-    if ( m_keyLocal.IsEmpty() ) {
+    if ( bGroupIfEmptyAlso && m_keyLocal.IsEmpty() ) {

       wxString strKey = GetPath().AfterLast(wxCONFIG_PATH_SEPARATOR);
       SetPath(_T(".."));  // changes m_keyLocal
       return LocalKey().DeleteKey(strKey);
     }
   }
 
       wxString strKey = GetPath().AfterLast(wxCONFIG_PATH_SEPARATOR);
       SetPath(_T(".."));  // changes m_keyLocal
       return LocalKey().DeleteKey(strKey);
     }
   }
 

-  return TRUE;
+  return true;

 }
 
 bool wxRegConfig::DeleteGroup(const wxString& key)
 {
 }
 
 bool wxRegConfig::DeleteGroup(const wxString& key)
 {

-  wxConfigPathChanger path(this, key);
+  wxConfigPathChanger path(this, RemoveTrailingSeparator(key));

 
 

-  return m_keyLocal.Exists() ? LocalKey().DeleteKey(path.Name()) : TRUE;
+  if ( !m_keyLocal.Exists() )
+  {
+      // nothing to do
+      return true;
+  }
+
+  if ( !LocalKey().DeleteKey(path.Name()) )
+      return false;
+
+  path.UpdateIfDeleted();
+
+  return true;

 }
 
 bool wxRegConfig::DeleteAll()
 }
 
 bool wxRegConfig::DeleteAll()


@@ -727,8 +780,4 @@ bool wxRegConfig::DeleteAll()
   return bOk;
 }
 
   return bOk;
 }
 

-#endif
-  // __WIN16__
-
-#endif
-  // wxUSE_CONFIG
+#endif // wxUSE_CONFIG && wxUSE_REGKEY