Core - FrameHandler update object lifespan (again)

- Only OnFrameCreated provides a heap managed IFrame reference
  this should be sufficient to keep track of frames using a
  Dictionary in FrameHandler
- Xml doc updates
- Reorder IFrameHandler methods

Issue #3588

Author: amaitland

CefSharp.Core.Runtime/Internals/ClientAdapter.cpp

@@ -1139,9 +1139,9 @@ namespace CefSharp
             if (handler != nullptr)
             {
                 auto browserWrapper = GetBrowserWrapper(browser->GetIdentifier(), browser->IsPopup());
-                auto frameWrapper = gcnew CefFrameWrapper(frame);
+                CefFrameWrapper frameWrapper(frame);
 
-                handler->OnFrameAttached(_browserControl, browserWrapper, frameWrapper);
+                handler->OnFrameAttached(_browserControl, browserWrapper, % frameWrapper);
             }
         }
 
@@ -1152,9 +1152,9 @@ namespace CefSharp
             if (handler != nullptr)
             {
                 auto browserWrapper = GetBrowserWrapper(browser->GetIdentifier(), browser->IsPopup());
-                auto frameWrapper = gcnew CefFrameWrapper(frame);
+                CefFrameWrapper frameWrapper(frame);
 
-                handler->OnFrameDetached(_browserControl, browserWrapper, frameWrapper);
+                handler->OnFrameDetached(_browserControl, browserWrapper, % frameWrapper);
             }
         }
 
@@ -1165,18 +1165,23 @@ namespace CefSharp
             if (handler != nullptr)
             {
                 auto browserWrapper = GetBrowserWrapper(browser->GetIdentifier(), browser->IsPopup());
+
                 CefFrameWrapper^ oldFrameWrapper = nullptr;
                 if (oldFrame.get())
                 {
                     oldFrameWrapper = gcnew CefFrameWrapper(oldFrame);
                 }
+
                 CefFrameWrapper^ newFrameWrapper = nullptr;
                 if (newFrame.get())
                 {
                     newFrameWrapper = gcnew CefFrameWrapper(newFrame);
                 }
 
                 handler->OnMainFrameChanged(_browserControl, browserWrapper, oldFrameWrapper, newFrameWrapper);
+
+                delete oldFrameWrapper;
+                delete newFrameWrapper;
             }
         }
 

CefSharp/Handler/FrameHandler.cs

@@ -17,10 +17,8 @@ void IFrameHandler.OnFrameAttached(IWebBrowser chromiumWebBrowser, IBrowser brow
         }
 
         /// <summary>
-        /// Called when a new frame is created. This will be the first notification
-        /// that references <paramref name="frame"/>. Any commands that require transport to the
-        /// associated renderer process (LoadRequest, SendProcessMessage, GetSource,
-        /// etc.) will be queued until OnFrameAttached is called for <paramref name="frame"/>.
+        /// Called when a frame can begin routing commands to/from the associated
+        /// renderer process. Any commands that were queued have now been dispatched.
         /// </summary>
         /// <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
         /// <param name="browser">the browser object</param>
@@ -37,8 +35,10 @@ void IFrameHandler.OnFrameCreated(IWebBrowser chromiumWebBrowser, IBrowser brows
         }
 
         /// <summary>
-        /// Called when a frame can begin routing commands to/from the associated
-        /// renderer process. Any commands that were queued have now been dispatched.
+        /// Called when a new frame is created. This will be the first notification
+        /// that references <paramref name="frame"/>. Any commands that require transport to the
+        /// associated renderer process (LoadRequest, SendProcessMessage, GetSource,
+        /// etc.) will be queued until OnFrameAttached is called for <paramref name="frame"/>.
         /// </summary>
         /// <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
         /// <param name="browser">the browser object</param>
@@ -76,23 +76,27 @@ void IFrameHandler.OnMainFrameChanged(IWebBrowser chromiumWebBrowser, IBrowser b
         }
 
         /// <summary>
-        /// Called when the main frame changes due to (a) initial browser creation, (b)
-        /// final browser destruction, (c) cross-origin navigation or (d) re-navigation
-        /// after renderer process termination (due to crashes, etc). <paramref name="oldFrame"/> will
-        /// be <c>null</c> and <paramref name="newFrame"/> will be non-<c>null</c> when a main frame is assigned to
-        /// <paramref name="browser"/> for the first time. <paramref name="oldFrame"/> will be non-<c>null</c> and <paramref name="newFrame"/>
-        /// will be <c>null</c> and  when a main frame is removed from <paramref name="browser"/> for the last
-        /// time. Both <paramref name="oldFrame"/> and <paramref name="newFrame"/> will be non-<c>null</c>for cross-origin
-        /// navigations or re-navigation after renderer process termination. This
-        /// method will be called after <see cref="OnFrameCreated(IWebBrowser, IBrowser, IFrame)"/> for <paramref name="newFrame"/> and/or after
+        /// Called when the main frame changes due to one of the following:
+        /// - (a) initial browser creation
+        /// - (b) final browser destruction
+        /// - (c) cross-origin navigation
+        /// - (d) re-navigation after renderer process termination (due to crashes, etc).
+        /// 
+        /// <paramref name="oldFrame"/> will be <c>null</c> and <paramref name="newFrame"/> will be non-<c>null</c> when a main frame is assigned
+        /// to <paramref name="browser"/> for the first time.
+        /// <paramref name="oldFrame"/> will be non-<c>null</c> and <paramref name="newFrame"/> will be <c>null</c> when a main frame is
+        /// removed from <paramref name="browser"/> for the last time.
+        /// Both <paramref name="oldFrame"/> and <paramref name="newFrame"/> will be non-<c>null</c>for cross-origin
+        /// navigations or re-navigation after renderer process termination.
+        /// This method will be called after <see cref="OnFrameCreated(IWebBrowser, IBrowser, IFrame)"/> for <paramref name="newFrame"/> and/or after
         /// <see cref="OnFrameDetached(IWebBrowser, IBrowser, IFrame)"/> for <paramref name="oldFrame"/>. If called after
         /// <see cref="ILifeSpanHandler.OnBeforeClose(IWebBrowser, IBrowser)"/> during browser destruction then
         /// <see cref="IBrowser.IsValid"/> will return <c>false</c> for <paramref name="browser"/>.
         /// </summary>
         /// <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
         /// <param name="browser">the browser object</param>
-        /// <param name="oldFrame">the new frame object</param>
-        /// <param name="newFrame">the old frame object</param>
+        /// <param name="oldFrame">the old frame object</param>
+        /// <param name="newFrame">the new frame object</param>
         protected virtual void OnMainFrameChanged(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame oldFrame, IFrame newFrame)
         {
 

CefSharp/Handler/IFrameHandler.cs

@@ -11,24 +11,24 @@ namespace CefSharp
     public interface IFrameHandler
     {
         /// <summary>
-        /// Called when a new frame is created. This will be the first notification
-        /// that references <paramref name="frame"/>. Any commands that require transport to the
-        /// associated renderer process (LoadRequest, SendProcessMessage, GetSource,
-        /// etc.) will be queued until OnFrameAttached is called for <paramref name="frame"/>.
+        /// Called when a frame can begin routing commands to/from the associated
+        /// renderer process. Any commands that were queued have now been dispatched.
         /// </summary>
         /// <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
         /// <param name="browser">the browser object</param>
         /// <param name="frame">the frame object</param>
-        void OnFrameCreated(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame);
+        void OnFrameAttached(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame);
 
         /// <summary>
-        /// Called when a frame can begin routing commands to/from the associated
-        /// renderer process. Any commands that were queued have now been dispatched.
+        /// Called when a new frame is created. This will be the first notification
+        /// that references <paramref name="frame"/>. Any commands that require transport to the
+        /// associated renderer process (LoadRequest, SendProcessMessage, GetSource,
+        /// etc.) will be queued until OnFrameAttached is called for <paramref name="frame"/>.
         /// </summary>
         /// <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
         /// <param name="browser">the browser object</param>
         /// <param name="frame">the frame object</param>
-        void OnFrameAttached(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame);
+        void OnFrameCreated(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame);
 
         /// <summary>
         /// Called when a frame loses its connection to the renderer process and will
@@ -43,23 +43,27 @@ public interface IFrameHandler
         void OnFrameDetached(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame);
 
         /// <summary>
-        /// Called when the main frame changes due to (a) initial browser creation, (b)
-        /// final browser destruction, (c) cross-origin navigation or (d) re-navigation
-        /// after renderer process termination (due to crashes, etc). <paramref name="oldFrame"/> will
-        /// be <c>null</c> and <paramref name="newFrame"/> will be non-<c>null</c> when a main frame is assigned to
-        /// <paramref name="browser"/> for the first time. <paramref name="oldFrame"/> will be non-<c>null</c> and <paramref name="newFrame"/>
-        /// will be <c>null</c> and  when a main frame is removed from <paramref name="browser"/> for the last
-        /// time. Both <paramref name="oldFrame"/> and <paramref name="newFrame"/> will be non-<c>null</c>for cross-origin
-        /// navigations or re-navigation after renderer process termination. This
-        /// method will be called after <see cref="OnFrameCreated(IWebBrowser, IBrowser, IFrame)"/> for <paramref name="newFrame"/> and/or after
+        /// Called when the main frame changes due to one of the following:
+        /// - (a) initial browser creation
+        /// - (b) final browser destruction
+        /// - (c) cross-origin navigation
+        /// - (d) re-navigation after renderer process termination (due to crashes, etc).
+        /// 
+        /// <paramref name="oldFrame"/> will be <c>null</c> and <paramref name="newFrame"/> will be non-<c>null</c> when a main frame is assigned
+        /// to <paramref name="browser"/> for the first time.
+        /// <paramref name="oldFrame"/> will be non-<c>null</c> and <paramref name="newFrame"/> will be <c>null</c> when a main frame is
+        /// removed from <paramref name="browser"/> for the last time.
+        /// Both <paramref name="oldFrame"/> and <paramref name="newFrame"/> will be non-<c>null</c>for cross-origin
+        /// navigations or re-navigation after renderer process termination.
+        /// This method will be called after <see cref="OnFrameCreated(IWebBrowser, IBrowser, IFrame)"/> for <paramref name="newFrame"/> and/or after
         /// <see cref="OnFrameDetached(IWebBrowser, IBrowser, IFrame)"/> for <paramref name="oldFrame"/>. If called after
         /// <see cref="ILifeSpanHandler.OnBeforeClose(IWebBrowser, IBrowser)"/> during browser destruction then
         /// <see cref="IBrowser.IsValid"/> will return <c>false</c> for <paramref name="browser"/>.
         /// </summary>
         /// <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
         /// <param name="browser">the browser object</param>
-        /// <param name="oldFrame">the new frame object</param>
-        /// <param name="newFrame">the old frame object</param>
+        /// <param name="oldFrame">the old frame object</param>
+        /// <param name="newFrame">the new frame object</param>
         void OnMainFrameChanged(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame oldFrame, IFrame newFrame);
     }
 }