Bug 1933181 - Stop using nsView for popups. r=layout-reviewers,tnikkel

Make the popup frame listener to the widget events itself, rather than
via the view tree.

This is a first step towards getting rid of views as a whole.

This creates the (annoying, but temporary) subtlety of the view tree
jumping across popups, so nsIFrame::GetNearestWidget and co need to
become a bit careful and avoid doing that.

Similarly a couple places relied on view visibility, which now need to
check nsMenuPopupFrame::IsOpen() as well.

Other than that this seems to just work.

Differential Revision: https://phabricator.services.mozilla.com/D230106

Author: emilio

accessible/generic/LocalAccessible.cpp

@@ -17,6 +17,7 @@
 #include "mozilla/a11y/Platform.h"
 #include "mozilla/FocusModel.h"
 #include "nsAccUtils.h"
+#include "nsMenuPopupFrame.h"
 #include "nsAccessibilityService.h"
 #include "ApplicationAccessible.h"
 #include "nsGenericHTMLElement.h"
@@ -316,13 +317,14 @@ uint64_t LocalAccessible::VisibilityState() const {
   // scrolled out.
   nsIFrame* curFrame = frame;
   do {
-    nsView* view = curFrame->GetView();
-    if (view && view->GetVisibility() == ViewVisibility::Hide) {
-      return states::INVISIBLE;
+    if (nsView* view = curFrame->GetView()) {
+      if (view->GetVisibility() == ViewVisibility::Hide) {
+        return states::INVISIBLE;
+      }
     }
 
-    if (nsLayoutUtils::IsPopup(curFrame)) {
-      return 0;
+    if (nsMenuPopupFrame* popup = do_QueryFrame(curFrame)) {
+      return popup->IsOpen() ? 0 : states::INVISIBLE;
     }
 
     if (curFrame->StyleUIReset()->mMozSubtreeHiddenOnlyVisually) {

dom/base/nsContentUtils.cpp

@@ -117,6 +117,7 @@
 #include "mozilla/StaticPrefs_dom.h"
 #include "mozilla/extensions/WebExtensionPolicy.h"
 #include "nsIOService.h"
+#include "nsMenuPopupFrame.h"
 #include "nsObjectLoadingContent.h"
 #ifdef FUZZING
 #  include "mozilla/StaticPrefs_fuzzing.h"

dom/base/nsDOMWindowUtils.cpp

@@ -67,6 +67,7 @@
 #include "nsJSEnvironment.h"
 #include "nsJSUtils.h"
 #include "nsLayoutUtils.h"
+#include "nsMenuPopupFrame.h"
 #include "nsPresContext.h"
 #include "nsQueryContentEventResult.h"
 #include "nsQueryObject.h"

layout/base/PresShell.cpp

@@ -4146,20 +4146,6 @@ void PresShell::SchedulePaint() {
   }
 }
 
-void PresShell::DispatchSynthMouseOrPointerMove(
-    WidgetMouseEvent* aMouseOrPointerMoveEvent) {
-  AUTO_PROFILER_TRACING_MARKER_DOCSHELL("Paint",
-                                        "DispatchSynthMouseOrPointerMove",
-                                        GRAPHICS, mPresContext->GetDocShell());
-  nsEventStatus status = nsEventStatus_eIgnore;
-  nsView* targetView = nsView::GetViewFor(aMouseOrPointerMoveEvent->mWidget);
-  if (!targetView) {
-    return;
-  }
-  RefPtr<nsViewManager> viewManager = targetView->GetViewManager();
-  viewManager->DispatchEvent(aMouseOrPointerMoveEvent, targetView, &status);
-}
-
 void PresShell::ClearMouseCaptureOnView(nsView* aView) {
   if (nsIContent* capturingContent = GetCapturingContent()) {
     if (aView) {
@@ -5910,13 +5896,12 @@ void PresShell::SynthesizeMouseMove(bool aFromScroll) {
   }
 }
 
-static nsView* FindFloatingViewContaining(nsPresContext* aRootPresContext,
-                                          nsIWidget* aRootWidget,
-                                          const LayoutDeviceIntPoint& aPt) {
-  nsIFrame* popupFrame = nsLayoutUtils::GetPopupFrameForPoint(
+static nsMenuPopupFrame* FindPopupFrame(nsPresContext* aRootPresContext,
+                                        nsIWidget* aRootWidget,
+                                        const LayoutDeviceIntPoint& aPt) {
+  return nsLayoutUtils::GetPopupFrameForPoint(
       aRootPresContext, aRootWidget, aPt,
       nsLayoutUtils::GetPopupFrameForPointFlags::OnlyReturnFramesWithWidgets);
-  return popupFrame ? popupFrame->GetView() : nullptr;
 }
 
 /*
@@ -5925,8 +5910,7 @@ static nsView* FindFloatingViewContaining(nsPresContext* aRootPresContext,
  * floating view.  It assumes that only floating views extend outside the bounds
  * of their parents.
  *
- * This methods should only be called if FindFloatingViewContaining returns
- * null.
+ * This methods should only be called if FindPopupFrame returns null.
  *
  * aPt is relative aRelativeToView with the viewport type
  * aRelativeToViewportType. aRelativeToView will always have a frame. If aView
@@ -6123,82 +6107,77 @@ void PresShell::ProcessSynthMouseOrPointerMoveEvent(
 
   int32_t APD = mPresContext->AppUnitsPerDevPixel();
 
-  // We need a widget to put in the event we are going to dispatch so we look
-  // for a view that has a widget and the mouse location is over. We first look
-  // for floating views, if there isn't one we use the root view. |view| holds
-  // that view.
-  nsView* view = nullptr;
-
-  // The appunits per devpixel ratio of |view|.
-  int32_t viewAPD;
-
   // mRefPoint will be mMouseLocation relative to the widget of |view|, the
-  // widget we will put in the event we dispatch, in viewAPD appunits
+  // widget we will put in the event we dispatch, in widgetAPD appunits
   nsPoint refpoint(0, 0);
 
-  // We always dispatch the event to the pres shell that contains the view that
-  // the mouse is over. pointVM is the VM of that pres shell.
-  nsViewManager* pointVM = nullptr;
-
   nsView* const rootView = mViewManager ? mViewManager->GetRootView() : nullptr;
   if (!rootView || !rootView->HasWidget()) {
     return;
   }
-#ifdef DEBUG
-  nsCOMPtr<nsIDragSession> dragSession =
-      nsContentUtils::GetDragSession(rootView->GetWidget());
-  MOZ_ASSERT(!dragSession);
-#endif
+  MOZ_ASSERT(!nsCOMPtr{nsContentUtils::GetDragSession(rootView->GetWidget())});
 
+  // We need a widget to put in the event we are going to dispatch so we look
+  // for a view that has a widget and the mouse location is over. We first look
+  // for floating views, if there isn't one we use the root view. |view| holds
+  // that view.
+  nsCOMPtr<nsIWidget> widget;
+  // We always dispatch the event to the pres shell that contains the view that
+  // the mouse is over. pointShell is that.
+  RefPtr<PresShell> pointShell;
+  // The appunits per devpixel ratio of |widget|.
+  int32_t widgetAPD;
+  // If we're in a child process and the view points to an OOP iframe, this is
+  // its BrowserBridgeChild.
+  RefPtr<BrowserBridgeChild> bbc;
+
+  // We either dispatch the event to a popup, or a view.
+  nsMenuPopupFrame* popupFrame = nullptr;
   if (rootView->GetFrame()) {
-    view =
-        FindFloatingViewContaining(mPresContext, rootView->GetWidget(),
-                                   LayoutDeviceIntPoint::FromAppUnitsToNearest(
-                                       aPointerInfo.mLastRefPointInRootDoc +
-                                           rootView->ViewToWidgetOffset(),
-                                       APD));
-  }
-
-  nsView* pointView = view;
-  if (!view) {
-    view = rootView;
+    popupFrame = FindPopupFrame(mPresContext, rootView->GetWidget(),
+                                LayoutDeviceIntPoint::FromAppUnitsToNearest(
+                                    aPointerInfo.mLastRefPointInRootDoc +
+                                        rootView->ViewToWidgetOffset(),
+                                    APD));
+    if (popupFrame) {
+      pointShell = popupFrame->PresShell();
+      widget = popupFrame->GetWidget();
+      widgetAPD = popupFrame->PresContext()->AppUnitsPerDevPixel();
+      refpoint = aPointerInfo.mLastRefPointInRootDoc;
+      DebugOnly<nsLayoutUtils::TransformResult> result =
+          nsLayoutUtils::TransformPoint(
+              RelativeTo{rootView->GetFrame(), ViewportType::Visual},
+              RelativeTo{popupFrame, ViewportType::Layout}, refpoint);
+      MOZ_ASSERT(result == nsLayoutUtils::TRANSFORM_SUCCEEDED);
+    }
+  }
+  if (!widget) {
+    widget = rootView->GetWidget();
+    widgetAPD = APD;
+    nsView* pointView = rootView;
     if (rootView->GetFrame()) {
       pointView = FindViewContaining(rootView, ViewportType::Visual, rootView,
                                      aPointerInfo.mLastRefPointInRootDoc);
-    } else {
-      pointView = rootView;
     }
     // pointView can be null in situations related to mouse capture
-    pointVM = (pointView ? pointView : view)->GetViewManager();
+    pointShell = (pointView ? pointView : rootView)->GetPresShell();
+    bbc = GetChildBrowser(pointView);
     refpoint =
         aPointerInfo.mLastRefPointInRootDoc + rootView->ViewToWidgetOffset();
-    viewAPD = APD;
-  } else {
-    pointVM = view->GetViewManager();
-    nsIFrame* frame = view->GetFrame();
-    NS_ASSERTION(frame, "floating views can't be anonymous");
-    viewAPD = frame->PresContext()->AppUnitsPerDevPixel();
-    refpoint = aPointerInfo.mLastRefPointInRootDoc;
-    DebugOnly<nsLayoutUtils::TransformResult> result =
-        nsLayoutUtils::TransformPoint(
-            RelativeTo{rootView->GetFrame(), ViewportType::Visual},
-            RelativeTo{frame, ViewportType::Layout}, refpoint);
-    MOZ_ASSERT(result == nsLayoutUtils::TRANSFORM_SUCCEEDED);
-    refpoint += view->ViewToWidgetOffset();
-  }
-  NS_ASSERTION(view->GetWidget(), "view should have a widget here");
+  }
+  NS_ASSERTION(widget, "view should have a widget here");
   Maybe<WidgetMouseEvent> mouseMoveEvent;
   Maybe<WidgetPointerEvent> pointerMoveEvent;
   if (aMoveMessage == eMouseMove) {
-    mouseMoveEvent.emplace(true, eMouseMove, view->GetWidget(),
+    mouseMoveEvent.emplace(true, eMouseMove, widget,
                            WidgetMouseEvent::eSynthesized);
     mouseMoveEvent->mButton = MouseButton::ePrimary;
     // We don't want to dispatch preceding pointer event since the caller
     // should've already been dispatched it.  However, if the target is an OOP
     // iframe, we'll set this to true again below.
     mouseMoveEvent->convertToPointer = false;
   } else {
-    pointerMoveEvent.emplace(true, ePointerMove, view->GetWidget());
+    pointerMoveEvent.emplace(true, ePointerMove, widget);
     pointerMoveEvent->mButton = MouseButton::eNotPressed;
     pointerMoveEvent->mReason = WidgetMouseEvent::eSynthesized;
   }
@@ -6214,13 +6193,13 @@ void PresShell::ProcessSynthMouseOrPointerMoveEvent(
   event.mFlags.mIsSynthesizedForTests = aPointerInfo.mIsSynthesizedForTests;
 
   event.mRefPoint =
-      LayoutDeviceIntPoint::FromAppUnitsToNearest(refpoint, viewAPD);
+      LayoutDeviceIntPoint::FromAppUnitsToNearest(refpoint, widgetAPD);
   event.mButtons = aPointerInfo.mLastButtons;
   event.mInputSource = aPointerInfo.mInputSource;
   event.pointerId = aPointerId;
   event.mModifiers = PresShell::GetCurrentModifiers();
 
-  if (BrowserBridgeChild* bbc = GetChildBrowser(pointView)) {
+  if (bbc) {
     // If we have a BrowserBridgeChild, we're going to be dispatching this
     // mouse event into an OOP iframe of the current document if and only if
     // we're synthesizing a mouse move.
@@ -6237,7 +6216,7 @@ void PresShell::ProcessSynthMouseOrPointerMoveEvent(
     return;
   }
 
-  if (RefPtr<PresShell> presShell = pointVM->GetPresShell()) {
+  if (pointShell) {
     // Since this gets run in a refresh tick there isn't an InputAPZContext on
     // the stack from the nsBaseWidget. We need to simulate one with at least
     // the correct target guid, so that the correct callback transform gets
@@ -6246,7 +6225,16 @@ void PresShell::ProcessSynthMouseOrPointerMoveEvent(
     // input block. Same for the APZ response field.
     InputAPZContext apzContext(aPointerInfo.mLastTargetGuid, 0,
                                nsEventStatus_eIgnore);
-    presShell->DispatchSynthMouseOrPointerMove(&event);
+    AUTO_PROFILER_TRACING_MARKER_DOCSHELL(
+        "Paint", "DispatchSynthMouseOrPointerMove", GRAPHICS,
+        pointShell->GetPresContext()->GetDocShell());
+    nsEventStatus status = nsEventStatus_eIgnore;
+    if (popupFrame) {
+      pointShell->HandleEvent(popupFrame, &event, false, &status);
+    } else {
+      RefPtr<nsViewManager> viewManager = rootView->GetViewManager();
+      viewManager->DispatchEvent(&event, rootView, &status);
+    }
   }
 }
 

layout/base/PresShell.h

@@ -1091,9 +1091,6 @@ class PresShell final : public nsStubDocumentObserver,
     mUnderHiddenEmbedderElement = aUnderHiddenEmbedderElement;
   }
 
-  MOZ_CAN_RUN_SCRIPT void DispatchSynthMouseOrPointerMove(
-      WidgetMouseEvent* aMouseOrPointerMoveEvent);
-
   /* Temporarily ignore the Displayport for better paint performance. We
    * trigger a repaint once suppression is disabled. Without that
    * the displayport may get left at the suppressed size for an extended

layout/base/nsDocumentViewer.cpp

@@ -3245,6 +3245,8 @@ bool nsDocumentViewer::ShouldAttachToTopLevel() {
   nsIWidgetListener* parentListener = mParentWidget->GetWidgetListener();
   MOZ_ASSERT(!parentListener || !parentListener->GetView(),
              "Expect a top level widget");
+  MOZ_ASSERT(!parentListener || !parentListener->GetAsMenuPopupFrame(),
+             "Expect a top level widget");
 #endif
   return true;
 }

layout/base/nsLayoutUtils.cpp

@@ -1582,7 +1582,7 @@ nsIFrame* nsLayoutUtils::GetPopupFrameForEventCoordinates(
                                guiEvent->mRefPoint);
 }
 
-nsIFrame* nsLayoutUtils::GetPopupFrameForPoint(
+nsMenuPopupFrame* nsLayoutUtils::GetPopupFrameForPoint(
     nsPresContext* aRootPresContext, nsIWidget* aWidget,
     const mozilla::LayoutDeviceIntPoint& aPoint,
     GetPopupFrameForPointFlags aFlags /* = GetPopupFrameForPointFlags(0) */) {

layout/base/nsLayoutUtils.h

@@ -719,7 +719,7 @@ class nsLayoutUtils {
   enum class GetPopupFrameForPointFlags : uint8_t {
     OnlyReturnFramesWithWidgets = 0x1,
   };
-  static nsIFrame* GetPopupFrameForPoint(
+  static nsMenuPopupFrame* GetPopupFrameForPoint(
       nsPresContext* aRootPresContext, nsIWidget* aWidget,
       const mozilla::LayoutDeviceIntPoint& aPoint,
       GetPopupFrameForPointFlags aFlags = GetPopupFrameForPointFlags(0));

layout/base/nsRefreshDriver.cpp

@@ -2638,6 +2638,10 @@ bool nsRefreshDriver::PaintIfNeeded() {
   {
     PaintTelemetry::AutoRecordPaint record;
     vm->ProcessPendingUpdates();
+    // Paint our popups.
+    if (nsXULPopupManager* pm = nsXULPopupManager::GetInstance()) {
+      pm->PaintPopups(this);
+    }
   }
   return true;
 }

layout/generic/FrameClasses.py

@@ -95,7 +95,7 @@
     Frame("nsMathMLmtrFrame", "TableRow", TABLE_PART | MATHML),
     Frame("nsMathMLmunderoverFrame", "None", MATHML_CONTAINER),
     Frame("nsMathMLTokenFrame", "None", MATHML_CONTAINER),
-    Frame("nsMenuPopupFrame", "MenuPopup", BLOCK | MAY_HAVE_VIEW),
+    Frame("nsMenuPopupFrame", "MenuPopup", BLOCK),
     Frame("nsNumberControlFrame", "TextInput", REPLACED | LEAF),
     Frame("nsPageBreakFrame", "PageBreak", COMMON | LEAF),
     Frame("nsPageContentFrame", "PageContent", BLOCK),