Source code

Revision control

Copy as Markdown

Other Tools

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at */
#include "nsHTMLParts.h"
#include "nsStyleConsts.h"
#include "nsGkAtoms.h"
#include "nsBoxFrame.h"
#include "nsDisplayList.h"
#include "nsStackLayout.h"
#include "nsIPopupContainer.h"
#include "nsIContent.h"
#include "nsFrameManager.h"
#include "nsLayoutUtils.h"
#include "mozilla/BasicEvents.h"
#include "mozilla/DisplayPortUtils.h"
#include "mozilla/PresShell.h"
using namespace mozilla;
// Interface IDs
// static
nsIPopupContainer* nsIPopupContainer::GetPopupContainer(PresShell* aPresShell) {
if (!aPresShell) {
return nullptr;
nsIFrame* rootFrame = aPresShell->GetRootFrame();
if (!rootFrame) {
return nullptr;
if (rootFrame) {
rootFrame = rootFrame->PrincipalChildList().FirstChild();
nsIPopupContainer* rootBox = do_QueryFrame(rootFrame);
// If the rootBox was not found yet this may be a top level non-XUL document.
if (rootFrame && !rootBox) {
// In a non-XUL document the rootFrame here will be a nsHTMLScrollFrame,
// get the nsCanvasFrame (which is the popup container) from it.
rootFrame = rootFrame->GetContentInsertionFrame();
rootBox = do_QueryFrame(rootFrame);
return rootBox;
class nsRootBoxFrame final : public nsBoxFrame, public nsIPopupContainer {
friend nsIFrame* NS_NewBoxFrame(mozilla::PresShell* aPresShell,
ComputedStyle* aStyle);
explicit nsRootBoxFrame(ComputedStyle* aStyle, nsPresContext* aPresContext);
virtual nsPopupSetFrame* GetPopupSetFrame() override;
virtual void SetPopupSetFrame(nsPopupSetFrame* aPopupSet) override;
virtual dom::Element* GetDefaultTooltip() override;
virtual void SetDefaultTooltip(dom::Element* aTooltip) override;
virtual void AppendFrames(ChildListID aListID,
nsFrameList& aFrameList) override;
virtual void InsertFrames(ChildListID aListID, nsIFrame* aPrevFrame,
const nsLineList::iterator* aPrevFrameLine,
nsFrameList& aFrameList) override;
virtual void RemoveFrame(ChildListID aListID, nsIFrame* aOldFrame) override;
virtual void Reflow(nsPresContext* aPresContext, ReflowOutput& aDesiredSize,
const ReflowInput& aReflowInput,
nsReflowStatus& aStatus) override;
virtual nsresult HandleEvent(nsPresContext* aPresContext,
WidgetGUIEvent* aEvent,
nsEventStatus* aEventStatus) override;
virtual void BuildDisplayList(nsDisplayListBuilder* aBuilder,
const nsDisplayListSet& aLists) override;
virtual bool IsFrameOfType(uint32_t aFlags) const override {
// Override bogus IsFrameOfType in nsBoxFrame.
if (aFlags & (nsIFrame::eReplacedContainsBlock | nsIFrame::eReplaced))
return false;
return nsBoxFrame::IsFrameOfType(aFlags);
virtual nsresult GetFrameName(nsAString& aResult) const override;
nsPopupSetFrame* mPopupSetFrame;
dom::Element* mDefaultTooltip;
nsContainerFrame* NS_NewRootBoxFrame(PresShell* aPresShell,
ComputedStyle* aStyle) {
return new (aPresShell) nsRootBoxFrame(aStyle, aPresShell->GetPresContext());
nsRootBoxFrame::nsRootBoxFrame(ComputedStyle* aStyle,
nsPresContext* aPresContext)
: nsBoxFrame(aStyle, aPresContext, kClassID, true),
mDefaultTooltip(nullptr) {
nsCOMPtr<nsBoxLayout> layout;
void nsRootBoxFrame::AppendFrames(ChildListID aListID,
nsFrameList& aFrameList) {
MOZ_ASSERT(aListID == kPrincipalList, "unexpected child list ID");
MOZ_ASSERT(mFrames.IsEmpty(), "already have a child frame");
nsBoxFrame::AppendFrames(aListID, aFrameList);
void nsRootBoxFrame::InsertFrames(ChildListID aListID, nsIFrame* aPrevFrame,
const nsLineList::iterator* aPrevFrameLine,
nsFrameList& aFrameList) {
// Because we only support a single child frame inserting is the same
// as appending.
MOZ_ASSERT(!aPrevFrame, "unexpected previous sibling frame");
AppendFrames(aListID, aFrameList);
void nsRootBoxFrame::RemoveFrame(ChildListID aListID, nsIFrame* aOldFrame) {
NS_ASSERTION(aListID == kPrincipalList, "unexpected child list ID");
if (aOldFrame == mFrames.FirstChild()) {
nsBoxFrame::RemoveFrame(aListID, aOldFrame);
} else {
MOZ_CRASH("unknown aOldFrame");
void nsRootBoxFrame::Reflow(nsPresContext* aPresContext,
ReflowOutput& aDesiredSize,
const ReflowInput& aReflowInput,
nsReflowStatus& aStatus) {
MOZ_ASSERT(aStatus.IsEmpty(), "Caller should pass a fresh reflow status!");
return nsBoxFrame::Reflow(aPresContext, aDesiredSize, aReflowInput, aStatus);
void nsRootBoxFrame::BuildDisplayList(nsDisplayListBuilder* aBuilder,
const nsDisplayListSet& aLists) {
if (mContent && mContent->GetProperty(nsGkAtoms::DisplayPortMargins)) {
// The XUL document's root element may have displayport margins set in
// ChromeProcessController::InitializeRoot, and we should to supply the
// base rect.
nsRect displayPortBase =
aBuilder->GetVisibleRect().Intersect(nsRect(nsPoint(0, 0), GetSize()));
DisplayPortUtils::SetDisplayPortBase(mContent, displayPortBase);
// root boxes don't need a debug border/outline or a selection overlay...
// They *may* have a background propagated to them, so force creation
// of a background display list element.
DisplayBorderBackgroundOutline(aBuilder, aLists, true);
BuildDisplayListForChildren(aBuilder, aLists);
nsresult nsRootBoxFrame::HandleEvent(nsPresContext* aPresContext,
WidgetGUIEvent* aEvent,
nsEventStatus* aEventStatus) {
if (nsEventStatus_eConsumeNoDefault == *aEventStatus) {
return NS_OK;
if (aEvent->mMessage == eMouseUp) {
nsIFrame::HandleEvent(aPresContext, aEvent, aEventStatus);
return NS_OK;
nsPopupSetFrame* nsRootBoxFrame::GetPopupSetFrame() { return mPopupSetFrame; }
void nsRootBoxFrame::SetPopupSetFrame(nsPopupSetFrame* aPopupSet) {
// Under normal conditions this should only be called once. However,
// if something triggers ReconstructDocElementHierarchy, we will
// destroy this frame's child (the nsDocElementBoxFrame), but not this
// frame. This will cause the popupset to remove itself by calling
// |SetPopupSetFrame(nullptr)|, and then we'll be able to accept a new
// popupset. Since the anonymous content is associated with the
// nsDocElementBoxFrame, we'll get a new popupset when the new doc
// element box frame is created.
MOZ_ASSERT(!aPopupSet || !mPopupSetFrame,
"Popup set is already defined! Only 1 allowed.");
mPopupSetFrame = aPopupSet;
dom::Element* nsRootBoxFrame::GetDefaultTooltip() { return mDefaultTooltip; }
void nsRootBoxFrame::SetDefaultTooltip(dom::Element* aTooltip) {
mDefaultTooltip = aTooltip;
nsresult nsRootBoxFrame::GetFrameName(nsAString& aResult) const {
return MakeFrameName(u"RootBox"_ns, aResult);