Support frame tree propagation between renderers in the same browsing instance.

content/renderer/render_view_impl.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CONTENT_RENDERER_RENDER_VIEW_IMPL_H_
 #define CONTENT_RENDERER_RENDER_VIEW_IMPL_H_
 
 #include <deque>
 #include <map>
 #include <set>
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/gtest_prod_util.h"
 #include "base/id_map.h"
 #include "base/memory/linked_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "base/observer_list.h"
 #include "base/timer.h"
+#include "base/values.h"
 #include "build/build_config.h"
 #include "content/common/content_export.h"
 #include "content/common/edit_command.h"
 #include "content/common/gpu/client/webgraphicscontext3d_command_buffer_impl.h"
 #include "content/common/navigation_gesture.h"
 #include "content/common/view_message_enums.h"
 #include "content/public/common/javascript_message_type.h"
 #include "content/public/common/page_zoom.h"
 #include "content/public/common/referrer.h"
 #include "content/public/common/renderer_preferences.h"
@@ skipping 489 matching lines @@
       WebKit::WebFrame* frame,
       WebKit::WebMediaPlayerClient* client);
   virtual WebKit::WebMediaPlayer* createMediaPlayer(
       WebKit::WebFrame* frame,
       const WebKit::WebURL& url,
       WebKit::WebMediaPlayerClient* client);
   virtual WebKit::WebApplicationCacheHost* createApplicationCacheHost(
       WebKit::WebFrame* frame,
       WebKit::WebApplicationCacheHostClient* client);
   virtual WebKit::WebCookieJar* cookieJar(WebKit::WebFrame* frame);
+  virtual void didCreateFrame(WebKit::WebFrame* parent,
+                              WebKit::WebFrame* child);
   virtual void frameDetached(WebKit::WebFrame* frame);
   virtual void willClose(WebKit::WebFrame* frame);
   virtual void loadURLExternally(WebKit::WebFrame* frame,
                                  const WebKit::WebURLRequest& request,
                                  WebKit::WebNavigationPolicy policy);
   virtual void loadURLExternally(WebKit::WebFrame* frame,
                                  const WebKit::WebURLRequest& request,
                                  WebKit::WebNavigationPolicy policy,
                                  const WebKit::WebString& suggested_name);
   virtual WebKit::WebNavigationPolicy decidePolicyForNavigation(
@@ skipping 118 matching lines @@
       unsigned long long requested_size,
       WebKit::WebStorageQuotaCallbacks* callbacks);
   virtual void registerIntentService(
       WebKit::WebFrame* frame,
       const WebKit::WebIntentServiceInfo& service);
   virtual void dispatchIntent(WebKit::WebFrame* frame,
                               const WebKit::WebIntentRequest& intentRequest);
   virtual void willOpenSocketStream(
       WebKit::WebSocketStreamHandle* handle);
   virtual bool willCheckAndDispatchMessageEvent(
-      WebKit::WebFrame* source,
+      WebKit::WebFrame* sourceFrame,
+      WebKit::WebFrame* targetFrame,
       WebKit::WebSecurityOrigin targetOrigin,
       WebKit::WebDOMMessageEvent event) OVERRIDE;
   virtual WebKit::WebString userAgentOverride(
       WebKit::WebFrame* frame,
       const WebKit::WebURL& url) OVERRIDE;
 
   // WebKit::WebPageSerializerClient implementation ----------------------------
 
   virtual void didSerializeDataForFrame(
       const WebKit::WebURL& frame_url,
@@ skipping 341 matching lines @@
 #endif
 
   void OnZoom(content::PageZoom zoom);
   void OnZoomFactor(content::PageZoom zoom, int zoom_center_x,
                     int zoom_center_y);
 
   void OnEnableViewSourceMode();
 
   void OnJavaBridgeInit();
 
+  void OnUpdatedFrameTree(int process_id,
+                          int route_id,
+                          const std::string& frame_tree);
+
   // Adding a new message handler? Please add it in alphabetical order above
   // and put it in the same position in the .cc file.
 
   // Misc private functions ----------------------------------------------------
   void ZoomFactorHelper(content::PageZoom zoom, int zoom_center_x,
                         int zoom_center_y, float scaling_increment);
 
   void AltErrorPageFinished(WebKit::WebFrame* frame,
                             const WebKit::WebURLError& original_error,
                             const std::string& html);
 
   // Check whether the preferred size has changed.
   void CheckPreferredSize();
 
   WebKit::WebGraphicsContext3D* CreateGraphicsContext3D(
       const WebKit::WebGraphicsContext3D::Attributes& attributes);
 
+  // This method walks the entire frame tree for the |frame| specified and
+  // returns a JSON serialized version of the tree including the name and id
+  // of each frame.

[awong, 2012/08/21 19:27:28]

This comment seems out of date.  There's no return value.

Also, where is the serialization format defined?

[nasko, 2012/08/21 22:24:13]

Done.

+  void SendUpdatedFrameTree(WebKit::WebFrame* frame, bool exclude);
+
+  // Walks the frame hierarchy and returns the frame which corresponds to the
+  // |remote_frame_id|.
+  WebKit::WebFrame* GetFrameByRemoteID(int remote_frame_id);
+
   void EnsureMediaStreamImpl();
 
   // This callback is triggered when DownloadFavicon completes, either
   // succesfully or with a failure. See DownloadFavicon for more
   // details.
   void DidDownloadFavicon(webkit_glue::ImageResourceFetcher* fetcher,
                           const SkBitmap& image);
 
   // Requests to download a favicon image. When done, the RenderView is notified
   // by way of DidDownloadFavicon. Returns true if the request was successfully
@@ skipping 23 matching lines @@
   // Returns true if the |params| navigation is to an entry that has been
   // cropped due to a recent navigation the browser did not know about.
   bool IsBackForwardToStaleEntry(const ViewMsg_Navigate_Params& params,
                                  bool is_reload);
 
   bool MaybeLoadAlternateErrorPage(WebKit::WebFrame* frame,
                                    const WebKit::WebURLError& error,
                                    bool replace);
 
   // Make this RenderView show an empty, unscriptable page.
-  void NavigateToSwappedOutURL();
+  void NavigateToSwappedOutURL(WebKit::WebFrame* frame,
+                               DictionaryValue* frame_tree);
 
   // If we initiated a navigation, this function will populate |document_state|
   // with the navigation information saved in OnNavigate().
   void PopulateDocumentStateFromPending(content::DocumentState* document_state);
 
   // Returns a new NavigationState populated with the navigation information
   // saved in OnNavigate().
   content::NavigationState* CreateNavigationStateFromPending();
 
   // Processes the command-line flags --enable-viewport and
@@ skipping 330 matching lines @@
   // guest RenderView.
   ppapi::HostResource guest_graphics_resource_;
 
   // This graphics context is initialized once GuestReady() is called.
   WebGraphicsContext3DCommandBufferImpl* guest_uninitialized_context_;
 
   // These are the attributes originally passed into createGraphicsContext3D
   // before the guest_to_embedder_channel was ready.
   WebKit::WebGraphicsContext3D::Attributes guest_attributes_;
 
+  // Boolean indicating whether we are in the process of updating the frame
+  // tree for this renderer. If true, we won't be sending frame tree updates
+  // back to the browser.
+  bool updating_frame_tree_;
+
+  // Boolean indicating that the frame tree has changed, but message has not
+  // been sent to the browser due to loading a resource.

[awong, 2012/08/21 19:27:28]

due to loading a resource -> because a resource is loading.

[nasko, 2012/08/21 22:24:13]

Done.

+  bool pending_frame_tree_update_;
+
+  // If this render view is swapped out mirror of an active render view in a

[awong, 2012/08/21 19:27:28]

is swapped -> is a swapped

Can we add a bit explaining why we record this?

[nasko, 2012/08/21 22:24:13]

Done.

+  // different process, we record the process id and route id for the active RV.
+  int target_process_id_;
+  int target_routing_id_;
+
+  // A mapping of current process frame ids to ids in the remote active render
+  // view, if this is a swapped out mirror render view.
+  std::map<int, int> frames_map_;
+
   // NOTE: pepper_delegate_ should be last member because its constructor calls
   // AddObservers method of RenderViewImpl from c-tor.
   content::PepperPluginDelegateImpl pepper_delegate_;
 
   // ---------------------------------------------------------------------------
   // ADDING NEW DATA? Please see if it fits appropriately in one of the above
   // sections rather than throwing it randomly at the end. If you're adding a
   // bunch of stuff, you should probably create a helper class and put your
   // data and methods on that to avoid bloating RenderView more.  You can
   // use the Observer interface to filter IPC messages and receive frame change
   // notifications.
   // ---------------------------------------------------------------------------
 
   DISALLOW_COPY_AND_ASSIGN(RenderViewImpl);
 };
 
 #endif  // CONTENT_RENDERER_RENDER_VIEW_IMPL_H_