Implement surface-based browser process hit testing for Mac and Aura

content/browser/renderer_host/render_widget_host_view_mac.mm

 // 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.
 
 #include "content/browser/renderer_host/render_widget_host_view_mac.h"
 
 #import <objc/runtime.h>
 #include <OpenGL/gl.h>
 #include <QuartzCore/QuartzCore.h>
 
@@ skipping 21 matching lines @@
 #import "content/browser/cocoa/system_hotkey_helper_mac.h"
 #import "content/browser/cocoa/system_hotkey_map.h"
 #include "content/browser/compositor/resize_lock.h"
 #include "content/browser/frame_host/frame_tree.h"
 #include "content/browser/frame_host/frame_tree_node.h"
 #include "content/browser/frame_host/render_frame_host_impl.h"
 #include "content/browser/gpu/compositor_util.h"
 #include "content/browser/renderer_host/render_view_host_impl.h"
 #include "content/browser/renderer_host/render_widget_helper.h"
 #include "content/browser/renderer_host/render_widget_host_delegate.h"
+#include "content/browser/renderer_host/render_widget_host_input_event_router.h"
 #import "content/browser/renderer_host/render_widget_host_view_mac_dictionary_helper.h"
 #import "content/browser/renderer_host/render_widget_host_view_mac_editcommand_helper.h"
 #include "content/browser/renderer_host/render_widget_resize_helper.h"
 #import "content/browser/renderer_host/text_input_client_mac.h"
 #include "content/common/accessibility_messages.h"
 #include "content/common/edit_command.h"
 #include "content/common/gpu/gpu_messages.h"
 #include "content/common/input_messages.h"
 #include "content/common/view_messages.h"
 #include "content/common/webplugin_geometry.h"
@@ skipping 539 matching lines @@
 
   if (IsDelegatedRendererEnabled()) {
     root_layer_.reset(new ui::Layer(ui::LAYER_SOLID_COLOR));
     delegated_frame_host_.reset(new DelegatedFrameHost(this));
   }
 
   gfx::Screen::GetScreenFor(cocoa_view_)->AddObserver(this);
 
   if (!is_guest_view_hack_)
     render_widget_host_->SetView(this);
+
+  // Let the page-level input event router know about our surface ID
+  // namespace for surface-based hit testing.
+  if (UseSurfacesEnabled() &&
+      render_widget_host_->delegate()->GetInputEventRouter()) {
+    render_widget_host_->delegate()
+        ->GetInputEventRouter()
+        ->AddSurfaceIdNamespaceOwner(GetSurfaceIdNamespace(), this);
+  }
 }
 
 RenderWidgetHostViewMac::~RenderWidgetHostViewMac() {
   gfx::Screen::GetScreenFor(cocoa_view_)->RemoveObserver(this);
 
   // This is being called from |cocoa_view_|'s destructor, so invalidate the
   // pointer.
   cocoa_view_ = nil;
 
   UnlockMouse();
 
+  if (UseSurfacesEnabled() && render_widget_host_ &&
+      render_widget_host_->delegate()->GetInputEventRouter()) {
+    render_widget_host_->delegate()
+        ->GetInputEventRouter()
+        ->RemoveSurfaceIdNamespaceOwner(GetSurfaceIdNamespace());
+  }
+
   // Ensure that the browser compositor is destroyed in a safe order.
   ShutdownBrowserCompositor();
 
   // We are owned by RenderWidgetHostViewCocoa, so if we go away before the
   // RenderWidgetHost does we need to tell it not to hold a stale pointer to
   // us.
   if (render_widget_host_) {
     // If this is a RenderWidgetHostViewGuest's platform_view_, we're not the
     // RWH's view, the RenderWidgetHostViewGuest is. So don't reset the RWH's
     // view, the RenderWidgetHostViewGuest will do it.
@@ skipping 468 matching lines @@
   composition_range_ = range;
   composition_bounds_ = character_bounds;
 }
 
 void RenderWidgetHostViewMac::RenderProcessGone(base::TerminationStatus status,
                                                 int error_code) {
   Destroy();
 }
 
 void RenderWidgetHostViewMac::RenderWidgetHostGone() {
+  // Clear SurfaceID namespace ownership before we shutdown the
+  // compositor.
+  if (UseSurfacesEnabled() && render_widget_host_ &&
+      render_widget_host_->delegate()->GetInputEventRouter()) {
+    render_widget_host_->delegate()
+        ->GetInputEventRouter()
+        ->RemoveSurfaceIdNamespaceOwner(GetSurfaceIdNamespace());
+  }
+
   // Destroy the DelegatedFrameHost, to prevent crashes when Destroy is never
   // called on the view.
   // http://crbug.com/404828
   ShutdownBrowserCompositor();
 }
 
 void RenderWidgetHostViewMac::Destroy() {
   [[NSNotificationCenter defaultCenter]
       removeObserver:cocoa_view_
                 name:NSWindowWillCloseNotification
               object:popup_window_];
 
   // We've been told to destroy.
   [cocoa_view_ retain];
   [cocoa_view_ removeFromSuperview];
   [cocoa_view_ autorelease];
 
   [popup_window_ close];
   popup_window_.autorelease();
 
   [fullscreen_window_manager_ exitFullscreenMode];
   fullscreen_window_manager_.reset();
   [pepper_fullscreen_window_ close];
 
   // This can be called as part of processing the window's responder
   // chain, for instance |-performKeyEquivalent:|.  In that case the
   // object needs to survive until the stack unwinds.
   pepper_fullscreen_window_.autorelease();
 
+  // Clear SurfaceID namespace ownership before we shutdown the
+  // compositor.
+  if (UseSurfacesEnabled() && render_widget_host_ &&
+      render_widget_host_->delegate()->GetInputEventRouter()) {

[lazyboy, 2015/09/01 21:29:42]

FYI, the mac failures seems to be b/c render_widget_host_->delegate() is NULL

[kenrb, 2015/09/02 16:35:05]

Thanks for helping with debugging this! I didn't realize that WebContents can be
destroyed before RenderWidgetHosts, and have added null checks to cover that.

+    render_widget_host_->delegate()
+        ->GetInputEventRouter()
+        ->RemoveSurfaceIdNamespaceOwner(GetSurfaceIdNamespace());
+  }
+
   // Delete the delegated frame state, which will reach back into
   // render_widget_host_.
   ShutdownBrowserCompositor();
 
   // We get this call just before |render_widget_host_| deletes
   // itself.  But we are owned by |cocoa_view_|, which may be retained
   // by some other code.  Examples are WebContentsViewMac's
   // |latent_focus_view_| and TabWindowController's
   // |cachedContentView_|.
   render_widget_host_ = NULL;
@@ skipping 455 matching lines @@
     [cocoa_view_ processedWheelEvent:event consumed:consumed];
 }
 
 uint32_t RenderWidgetHostViewMac::GetSurfaceIdNamespace() {
   if (delegated_frame_host_)
     return delegated_frame_host_->GetSurfaceIdNamespace();
 
   return 0;
 }
 
+uint32_t RenderWidgetHostViewMac::SurfaceIdNamespaceAtPoint(
+    const gfx::Point& point,
+    gfx::Point* transformed_point) {
+  cc::SurfaceId id =
+      delegated_frame_host_->SurfaceIdAtPoint(point, transformed_point);
+  // It is possible that the renderer has not yet produced a surface, in which
+  // case we return our current namespace.
+  if (id.is_null())
+    return GetSurfaceIdNamespace();
+  return cc::SurfaceIdAllocator::NamespaceForId(id);
+}
+
+void RenderWidgetHostViewMac::ProcessMouseEvent(
+    const blink::WebMouseEvent& event) {
+  render_widget_host_->ForwardMouseEvent(event);
+}
+void RenderWidgetHostViewMac::ProcessMouseWheelEvent(
+    const blink::WebMouseWheelEvent& event) {
+  render_widget_host_->ForwardWheelEvent(event);
+}
+
 bool RenderWidgetHostViewMac::Send(IPC::Message* message) {
   if (render_widget_host_)
     return render_widget_host_->Send(message);
   delete message;
   return false;
 }
 
 void RenderWidgetHostViewMac::ShutdownHost() {
   weak_factory_.InvalidateWeakPtrs();
   render_widget_host_->Shutdown();
@@ skipping 315 matching lines @@
   }
 
   if (mouseEventWasIgnored_) {
     // If this is the first mouse event after a previous event that was ignored
     // due to the hitTest, send a mouse enter event to the host view.
     if (renderWidgetHostView_->render_widget_host_) {
       WebMouseEvent enterEvent =
           WebInputEventFactory::mouseEvent(theEvent, self);
       enterEvent.type = WebInputEvent::MouseMove;
       enterEvent.button = WebMouseEvent::ButtonNone;
-      renderWidgetHostView_->ForwardMouseEvent(enterEvent);
+      if (renderWidgetHostView_->render_widget_host_->delegate()
+              ->GetInputEventRouter()) {
+        renderWidgetHostView_->render_widget_host_->delegate()
+            ->GetInputEventRouter()
+            ->RouteMouseEvent(renderWidgetHostView_.get(), &enterEvent);
+      } else {
+        renderWidgetHostView_->ForwardMouseEvent(enterEvent);
+      }
     }
   }
   mouseEventWasIgnored_ = NO;
 
   // Don't cancel child popups; killing them on a mouse click would prevent the
   // user from positioning the insertion point in the text field spawning the
   // popup. A click outside the text field would cause the text field to drop
   // the focus, and then EditorClientImpl::textFieldDidEndEditing() would cancel
   // the popup anyway, so we're OK.
 
   NSEventType type = [theEvent type];
   if (type == NSLeftMouseDown)
     hasOpenMouseDown_ = YES;
   else if (type == NSLeftMouseUp)
     hasOpenMouseDown_ = NO;
 
   // TODO(suzhe): We should send mouse events to the input method first if it
   // wants to handle them. But it won't work without implementing method
   // - (NSUInteger)characterIndexForPoint:.
   // See: http://code.google.com/p/chromium/issues/detail?id=47141
   // Instead of sending mouse events to the input method first, we now just
   // simply confirm all ongoing composition here.
   if (type == NSLeftMouseDown || type == NSRightMouseDown ||
       type == NSOtherMouseDown) {
     [self confirmComposition];
   }
 
-  const WebMouseEvent event =
-      WebInputEventFactory::mouseEvent(theEvent, self);
-  renderWidgetHostView_->ForwardMouseEvent(event);
+  WebMouseEvent event = WebInputEventFactory::mouseEvent(theEvent, self);
+  if (renderWidgetHostView_->render_widget_host_->delegate()
+          ->GetInputEventRouter()) {
+    renderWidgetHostView_->render_widget_host_->delegate()
+        ->GetInputEventRouter()
+        ->RouteMouseEvent(renderWidgetHostView_.get(), &event);
+  } else {
+    renderWidgetHostView_->ForwardMouseEvent(event);
+  }
 }
 
 - (BOOL)performKeyEquivalent:(NSEvent*)theEvent {
   // |performKeyEquivalent:| is sent to all views of a window, not only down the
   // responder chain (cf. "Handling Key Equivalents" in
   // http://developer.apple.com/mac/library/documentation/Cocoa/Conceptual/EventOverview/HandlingKeyEvents/HandlingKeyEvents.html
   // ). We only want to handle key equivalents if we're first responder.
   if ([[self window] firstResponder] != self)
     return NO;
 
@@ skipping 437 matching lines @@
       }];
   }
 
   // This is responsible for content scrolling!
   if (renderWidgetHostView_->render_widget_host_) {
     BOOL canRubberbandLeft = [responderDelegate_ canRubberbandLeft:self];
     BOOL canRubberbandRight = [responderDelegate_ canRubberbandRight:self];
     WebMouseWheelEvent webEvent = WebInputEventFactory::mouseWheelEvent(
         event, self, canRubberbandLeft, canRubberbandRight);
     webEvent.railsMode = mouseWheelFilter_.UpdateRailsMode(webEvent);
-    renderWidgetHostView_->render_widget_host_->ForwardWheelEvent(webEvent);
+    if (renderWidgetHostView_->render_widget_host_->delegate()
+            ->GetInputEventRouter()) {
+      renderWidgetHostView_->render_widget_host_->delegate()
+          ->GetInputEventRouter()
+          ->RouteMouseWheelEvent(renderWidgetHostView_.get(), &webEvent);
+    } else {
+      renderWidgetHostView_->render_widget_host_->ForwardWheelEvent(webEvent);
+    }
   }
 }
 
 // Called repeatedly during a pinch gesture, with incremental change values.
 - (void)magnifyWithEvent:(NSEvent*)event {
   if (!renderWidgetHostView_->render_widget_host_)
     return;
 
   // If, due to nesting of multiple gestures (e.g, from multiple touch
   // devices), the beginning of the gesture has been lost, skip the remainder
@@ skipping 885 matching lines @@
 
 // "-webkit-app-region: drag | no-drag" is implemented on Mac by excluding
 // regions that are not draggable. (See ControlRegionView in
 // native_app_window_cocoa.mm). This requires the render host view to be
 // draggable by default.
 - (BOOL)mouseDownCanMoveWindow {
   return YES;
 }
 
 @end