From 5f8de423f190bbb79a62f804151bc24824fa32d8 Mon Sep 17 00:00:00 2001 From: "Matt A. Tobin" Date: Fri, 2 Feb 2018 04:16:08 -0500 Subject: Add m-esr52 at 52.6.0 --- layout/base/nsPresShell.cpp | 11280 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 11280 insertions(+) create mode 100644 layout/base/nsPresShell.cpp (limited to 'layout/base/nsPresShell.cpp') diff --git a/layout/base/nsPresShell.cpp b/layout/base/nsPresShell.cpp new file mode 100644 index 000000000..56ac370b9 --- /dev/null +++ b/layout/base/nsPresShell.cpp @@ -0,0 +1,11280 @@ +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- + * vim: set ts=2 sw=2 et tw=78: + * 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 http://mozilla.org/MPL/2.0/. + * + * This Original Code has been modified by IBM Corporation. + * Modifications made by IBM described herein are + * Copyright (c) International Business Machines + * Corporation, 2000 + * + * Modifications to Mozilla code or documentation + * identified per MPL Section 3.3 + * + * Date Modified by Description of modification + * 05/03/2000 IBM Corp. Observer events for reflow states + */ + +/* a presentation of a document, part 2 */ + +#include "mozilla/Logging.h" + +#include "mozilla/ArrayUtils.h" +#include "mozilla/StyleSheetInlines.h" +#include "mozilla/EventDispatcher.h" +#include "mozilla/EventStateManager.h" +#include "mozilla/EventStates.h" +#include "mozilla/IMEStateManager.h" +#include "mozilla/MemoryReporting.h" +#include "mozilla/dom/TabChild.h" +#include "mozilla/Likely.h" +#include "mozilla/MouseEvents.h" +#include "mozilla/Sprintf.h" +#include "mozilla/TextEvents.h" +#include "mozilla/TouchEvents.h" +#include "mozilla/UniquePtr.h" +#include "mozilla/Unused.h" +#include "mozilla/StyleBackendType.h" +#include + +#ifdef XP_WIN +#include "winuser.h" +#endif + +#include "gfxPrefs.h" +#include "gfxUserFontSet.h" +#include "nsPresShell.h" +#include "nsPresContext.h" +#include "nsIContent.h" +#include "nsIContentIterator.h" +#include "mozilla/dom/BeforeAfterKeyboardEvent.h" +#include "mozilla/dom/Element.h" +#include "mozilla/dom/Event.h" // for Event::GetEventPopupControlState() +#include "mozilla/dom/ShadowRoot.h" +#include "mozilla/dom/PointerEvent.h" +#include "nsIDocument.h" +#include "nsAnimationManager.h" +#include "nsNameSpaceManager.h" // for Pref-related rule management (bugs 22963,20760,31816) +#include "nsFrame.h" +#include "FrameLayerBuilder.h" +#include "nsViewManager.h" +#include "nsView.h" +#include "nsCRTGlue.h" +#include "prprf.h" +#include "prinrval.h" +#include "nsTArray.h" +#include "nsCOMArray.h" +#include "nsContainerFrame.h" +#include "nsISelection.h" +#include "mozilla/dom/Selection.h" +#include "nsGkAtoms.h" +#include "nsIDOMRange.h" +#include "nsIDOMDocument.h" +#include "nsIDOMNode.h" +#include "nsIDOMNodeList.h" +#include "nsIDOMElement.h" +#include "nsRange.h" +#include "nsCOMPtr.h" +#include "nsAutoPtr.h" +#include "nsReadableUtils.h" +#include "nsIPageSequenceFrame.h" +#include "nsIPermissionManager.h" +#include "nsIMozBrowserFrame.h" +#include "nsCaret.h" +#include "AccessibleCaretEventHub.h" +#include "nsIDOMHTMLDocument.h" +#include "nsFrameManager.h" +#include "nsXPCOM.h" +#include "nsILayoutHistoryState.h" +#include "nsILineIterator.h" // for ScrollContentIntoView +#include "PLDHashTable.h" +#include "mozilla/dom/BeforeAfterKeyboardEventBinding.h" +#include "mozilla/dom/Touch.h" +#include "mozilla/dom/TouchEvent.h" +#include "mozilla/dom/PointerEventBinding.h" +#include "nsIObserverService.h" +#include "nsDocShell.h" // for reflow observation +#include "nsIBaseWindow.h" +#include "nsError.h" +#include "nsLayoutUtils.h" +#include "nsViewportInfo.h" +#include "nsCSSRendering.h" + // for |#ifdef DEBUG| code +#include "prenv.h" +#include "nsDisplayList.h" +#include "nsRegion.h" +#include "nsRenderingContext.h" +#include "nsAutoLayoutPhase.h" +#ifdef MOZ_REFLOW_PERF +#include "nsFontMetrics.h" +#endif +#include "PositionedEventTargeting.h" + +#include "nsIReflowCallback.h" + +#include "nsPIDOMWindow.h" +#include "nsFocusManager.h" +#include "nsIObjectFrame.h" +#include "nsIObjectLoadingContent.h" +#include "nsNetUtil.h" +#include "nsThreadUtils.h" +#include "nsStyleSheetService.h" +#include "gfxContext.h" +#include "gfxUtils.h" +#include "nsSMILAnimationController.h" +#include "SVGContentUtils.h" +#include "nsSVGEffects.h" +#include "SVGFragmentIdentifier.h" +#include "nsArenaMemoryStats.h" +#include "nsFrameSelection.h" + +#include "mozilla/dom/Performance.h" +#include "nsRefreshDriver.h" +#include "nsDOMNavigationTiming.h" + +// Drag & Drop, Clipboard +#include "nsIDocShellTreeItem.h" +#include "nsIURI.h" +#include "nsIScrollableFrame.h" +#include "nsITimer.h" +#ifdef ACCESSIBILITY +#include "nsAccessibilityService.h" +#include "mozilla/a11y/DocAccessible.h" +#ifdef DEBUG +#include "mozilla/a11y/Logging.h" +#endif +#endif + +// For style data reconstruction +#include "nsStyleChangeList.h" +#include "nsCSSFrameConstructor.h" +#ifdef MOZ_XUL +#include "nsMenuFrame.h" +#include "nsTreeBodyFrame.h" +#include "nsIBoxObject.h" +#include "nsITreeBoxObject.h" +#include "nsMenuPopupFrame.h" +#include "nsITreeColumns.h" +#include "nsIDOMXULMultSelectCntrlEl.h" +#include "nsIDOMXULSelectCntrlItemEl.h" +#include "nsIDOMXULMenuListElement.h" + +#endif + +#include "mozilla/layers/CompositorBridgeChild.h" +#include "GeckoProfiler.h" +#include "gfxPlatform.h" +#include "Layers.h" +#include "LayerTreeInvalidation.h" +#include "mozilla/css/ImageLoader.h" +#include "mozilla/dom/DocumentTimeline.h" +#include "mozilla/Preferences.h" +#include "mozilla/Telemetry.h" +#include "nsCanvasFrame.h" +#include "nsIImageLoadingContent.h" +#include "nsImageFrame.h" +#include "nsIScreen.h" +#include "nsIScreenManager.h" +#include "nsPlaceholderFrame.h" +#include "nsTransitionManager.h" +#include "ChildIterator.h" +#include "mozilla/RestyleManagerHandle.h" +#include "mozilla/RestyleManagerHandleInlines.h" +#include "nsIDOMHTMLElement.h" +#include "nsIDragSession.h" +#include "nsIFrameInlines.h" +#include "mozilla/gfx/2D.h" +#include "nsSubDocumentFrame.h" +#include "nsQueryObject.h" +#include "nsLayoutStylesheetCache.h" +#include "mozilla/layers/InputAPZContext.h" +#include "mozilla/layers/ScrollInputMethods.h" +#include "nsStyleSet.h" +#include "mozilla/StyleSetHandle.h" +#include "mozilla/StyleSetHandleInlines.h" +#include "mozilla/StyleSheet.h" +#include "mozilla/StyleSheetInlines.h" +#include "mozilla/dom/ImageTracker.h" + +#ifdef ANDROID +#include "nsIDocShellTreeOwner.h" +#endif + +#ifdef MOZ_B2G +#include "nsIHardwareKeyHandler.h" +#endif + +#ifdef MOZ_TASK_TRACER +#include "GeckoTaskTracer.h" +using namespace mozilla::tasktracer; +#endif + +#define ANCHOR_SCROLL_FLAGS \ + (nsIPresShell::SCROLL_OVERFLOW_HIDDEN | nsIPresShell::SCROLL_NO_PARENT_FRAMES) + + // define the scalfactor of drag and drop images + // relative to the max screen height/width +#define RELATIVE_SCALEFACTOR 0.0925f + +using namespace mozilla; +using namespace mozilla::css; +using namespace mozilla::dom; +using namespace mozilla::gfx; +using namespace mozilla::layers; +using namespace mozilla::gfx; +using namespace mozilla::layout; +using PaintFrameFlags = nsLayoutUtils::PaintFrameFlags; + +CapturingContentInfo nsIPresShell::gCaptureInfo = + { false /* mAllowed */, false /* mPointerLock */, false /* mRetargetToElement */, + false /* mPreventDrag */ }; +nsIContent* nsIPresShell::gKeyDownTarget; + +// Keeps a map between pointerId and element that currently capturing pointer +// with such pointerId. If pointerId is absent in this map then nobody is +// capturing it. Additionally keep information about pending capturing content. +static nsClassHashtable* sPointerCaptureList; + +// Keeps information about pointers such as pointerId, activeState, pointerType, +// primaryState +static nsClassHashtable* sActivePointersIds; + +// RangePaintInfo is used to paint ranges to offscreen buffers +struct RangePaintInfo { + RefPtr mRange; + nsDisplayListBuilder mBuilder; + nsDisplayList mList; + + // offset of builder's reference frame to the root frame + nsPoint mRootOffset; + + RangePaintInfo(nsRange* aRange, nsIFrame* aFrame) + : mRange(aRange), mBuilder(aFrame, nsDisplayListBuilderMode::PAINTING, false) + { + MOZ_COUNT_CTOR(RangePaintInfo); + } + + ~RangePaintInfo() + { + mList.DeleteAll(); + MOZ_COUNT_DTOR(RangePaintInfo); + } +}; + +#undef NOISY + +// ---------------------------------------------------------------------- + +#ifdef DEBUG +// Set the environment variable GECKO_VERIFY_REFLOW_FLAGS to one or +// more of the following flags (comma separated) for handy debug +// output. +static uint32_t gVerifyReflowFlags; + +struct VerifyReflowFlags { + const char* name; + uint32_t bit; +}; + +static const VerifyReflowFlags gFlags[] = { + { "verify", VERIFY_REFLOW_ON }, + { "reflow", VERIFY_REFLOW_NOISY }, + { "all", VERIFY_REFLOW_ALL }, + { "list-commands", VERIFY_REFLOW_DUMP_COMMANDS }, + { "noisy-commands", VERIFY_REFLOW_NOISY_RC }, + { "really-noisy-commands", VERIFY_REFLOW_REALLY_NOISY_RC }, + { "resize", VERIFY_REFLOW_DURING_RESIZE_REFLOW }, +}; + +#define NUM_VERIFY_REFLOW_FLAGS (sizeof(gFlags) / sizeof(gFlags[0])) + +static void +ShowVerifyReflowFlags() +{ + printf("Here are the available GECKO_VERIFY_REFLOW_FLAGS:\n"); + const VerifyReflowFlags* flag = gFlags; + const VerifyReflowFlags* limit = gFlags + NUM_VERIFY_REFLOW_FLAGS; + while (flag < limit) { + printf(" %s\n", flag->name); + ++flag; + } + printf("Note: GECKO_VERIFY_REFLOW_FLAGS is a comma separated list of flag\n"); + printf("names (no whitespace)\n"); +} +#endif + +//======================================================================== +//======================================================================== +//======================================================================== +#ifdef MOZ_REFLOW_PERF +class ReflowCountMgr; + +static const char kGrandTotalsStr[] = "Grand Totals"; + +// Counting Class +class ReflowCounter { +public: + explicit ReflowCounter(ReflowCountMgr * aMgr = nullptr); + ~ReflowCounter(); + + void ClearTotals(); + void DisplayTotals(const char * aStr); + void DisplayDiffTotals(const char * aStr); + void DisplayHTMLTotals(const char * aStr); + + void Add() { mTotal++; } + void Add(uint32_t aTotal) { mTotal += aTotal; } + + void CalcDiffInTotals(); + void SetTotalsCache(); + + void SetMgr(ReflowCountMgr * aMgr) { mMgr = aMgr; } + + uint32_t GetTotal() { return mTotal; } + +protected: + void DisplayTotals(uint32_t aTotal, const char * aTitle); + void DisplayHTMLTotals(uint32_t aTotal, const char * aTitle); + + uint32_t mTotal; + uint32_t mCacheTotal; + + ReflowCountMgr * mMgr; // weak reference (don't delete) +}; + +// Counting Class +class IndiReflowCounter { +public: + explicit IndiReflowCounter(ReflowCountMgr * aMgr = nullptr) + : mFrame(nullptr), + mCount(0), + mMgr(aMgr), + mCounter(aMgr), + mHasBeenOutput(false) + {} + virtual ~IndiReflowCounter() {} + + nsAutoString mName; + nsIFrame * mFrame; // weak reference (don't delete) + int32_t mCount; + + ReflowCountMgr * mMgr; // weak reference (don't delete) + + ReflowCounter mCounter; + bool mHasBeenOutput; + +}; + +//-------------------- +// Manager Class +//-------------------- +class ReflowCountMgr { +public: + ReflowCountMgr(); + virtual ~ReflowCountMgr(); + + void ClearTotals(); + void ClearGrandTotals(); + void DisplayTotals(const char * aStr); + void DisplayHTMLTotals(const char * aStr); + void DisplayDiffsInTotals(); + + void Add(const char * aName, nsIFrame * aFrame); + ReflowCounter * LookUp(const char * aName); + + void PaintCount(const char *aName, nsRenderingContext* aRenderingContext, + nsPresContext *aPresContext, nsIFrame *aFrame, + const nsPoint &aOffset, uint32_t aColor); + + FILE * GetOutFile() { return mFD; } + + PLHashTable * GetIndiFrameHT() { return mIndiFrameCounts; } + + void SetPresContext(nsPresContext * aPresContext) { mPresContext = aPresContext; } // weak reference + void SetPresShell(nsIPresShell* aPresShell) { mPresShell= aPresShell; } // weak reference + + void SetDumpFrameCounts(bool aVal) { mDumpFrameCounts = aVal; } + void SetDumpFrameByFrameCounts(bool aVal) { mDumpFrameByFrameCounts = aVal; } + void SetPaintFrameCounts(bool aVal) { mPaintFrameByFrameCounts = aVal; } + + bool IsPaintingFrameCounts() { return mPaintFrameByFrameCounts; } + +protected: + void DisplayTotals(uint32_t aTotal, uint32_t * aDupArray, char * aTitle); + void DisplayHTMLTotals(uint32_t aTotal, uint32_t * aDupArray, char * aTitle); + + static int RemoveItems(PLHashEntry *he, int i, void *arg); + static int RemoveIndiItems(PLHashEntry *he, int i, void *arg); + void CleanUp(); + + // stdout Output Methods + static int DoSingleTotal(PLHashEntry *he, int i, void *arg); + static int DoSingleIndi(PLHashEntry *he, int i, void *arg); + + void DoGrandTotals(); + void DoIndiTotalsTree(); + + // HTML Output Methods + static int DoSingleHTMLTotal(PLHashEntry *he, int i, void *arg); + void DoGrandHTMLTotals(); + + // Zero Out the Totals + static int DoClearTotals(PLHashEntry *he, int i, void *arg); + + // Displays the Diff Totals + static int DoDisplayDiffTotals(PLHashEntry *he, int i, void *arg); + + PLHashTable * mCounts; + PLHashTable * mIndiFrameCounts; + FILE * mFD; + + bool mDumpFrameCounts; + bool mDumpFrameByFrameCounts; + bool mPaintFrameByFrameCounts; + + bool mCycledOnce; + + // Root Frame for Individual Tracking + nsPresContext * mPresContext; + nsIPresShell* mPresShell; + + // ReflowCountMgr gReflowCountMgr; +}; +#endif +//======================================================================== + +// comment out to hide caret +#define SHOW_CARET + +// The upper bound on the amount of time to spend reflowing, in +// microseconds. When this bound is exceeded and reflow commands are +// still queued up, a reflow event is posted. The idea is for reflow +// to not hog the processor beyond the time specifed in +// gMaxRCProcessingTime. This data member is initialized from the +// layout.reflow.timeslice pref. +#define NS_MAX_REFLOW_TIME 1000000 +static int32_t gMaxRCProcessingTime = -1; + +struct nsCallbackEventRequest +{ + nsIReflowCallback* callback; + nsCallbackEventRequest* next; +}; + +// ---------------------------------------------------------------------------- +#define ASSERT_REFLOW_SCHEDULED_STATE() \ + NS_ASSERTION(mReflowScheduled == \ + GetPresContext()->RefreshDriver()-> \ + IsLayoutFlushObserver(this), "Unexpected state") + +class nsAutoCauseReflowNotifier +{ +public: + explicit nsAutoCauseReflowNotifier(PresShell* aShell) + : mShell(aShell) + { + mShell->WillCauseReflow(); + } + ~nsAutoCauseReflowNotifier() + { + // This check should not be needed. Currently the only place that seem + // to need it is the code that deals with bug 337586. + if (!mShell->mHaveShutDown) { + mShell->DidCauseReflow(); + } + else { + nsContentUtils::RemoveScriptBlocker(); + } + } + + PresShell* mShell; +}; + +class MOZ_STACK_CLASS nsPresShellEventCB : public EventDispatchingCallback +{ +public: + explicit nsPresShellEventCB(PresShell* aPresShell) : mPresShell(aPresShell) {} + + virtual void HandleEvent(EventChainPostVisitor& aVisitor) override + { + if (aVisitor.mPresContext && aVisitor.mEvent->mClass != eBasicEventClass) { + if (aVisitor.mEvent->mMessage == eMouseDown || + aVisitor.mEvent->mMessage == eMouseUp) { + // Mouse-up and mouse-down events call nsFrame::HandlePress/Release + // which call GetContentOffsetsFromPoint which requires up-to-date layout. + // Bring layout up-to-date now so that GetCurrentEventFrame() below + // will return a real frame and we don't have to worry about + // destroying it by flushing later. + mPresShell->FlushPendingNotifications(Flush_Layout); + } else if (aVisitor.mEvent->mMessage == eWheel && + aVisitor.mEventStatus != nsEventStatus_eConsumeNoDefault) { + nsIFrame* frame = mPresShell->GetCurrentEventFrame(); + if (frame) { + // chrome (including addons) should be able to know if content + // handles both D3E "wheel" event and legacy mouse scroll events. + // We should dispatch legacy mouse events before dispatching the + // "wheel" event into system group. + RefPtr esm = + aVisitor.mPresContext->EventStateManager(); + esm->DispatchLegacyMouseScrollEvents(frame, + aVisitor.mEvent->AsWheelEvent(), + &aVisitor.mEventStatus); + } + } + nsIFrame* frame = mPresShell->GetCurrentEventFrame(); + if (!frame && + (aVisitor.mEvent->mMessage == eMouseUp || + aVisitor.mEvent->mMessage == eTouchEnd)) { + // Redirect BUTTON_UP and TOUCH_END events to the root frame to ensure + // that capturing is released. + frame = mPresShell->GetRootFrame(); + } + if (frame) { + frame->HandleEvent(aVisitor.mPresContext, + aVisitor.mEvent->AsGUIEvent(), + &aVisitor.mEventStatus); + } + } + } + + RefPtr mPresShell; +}; + +class nsBeforeFirstPaintDispatcher : public Runnable +{ +public: + explicit nsBeforeFirstPaintDispatcher(nsIDocument* aDocument) + : mDocument(aDocument) {} + + // Fires the "before-first-paint" event so that interested parties (right now, the + // mobile browser) are aware of it. + NS_IMETHOD Run() override + { + nsCOMPtr observerService = + mozilla::services::GetObserverService(); + if (observerService) { + observerService->NotifyObservers(mDocument, "before-first-paint", + nullptr); + } + return NS_OK; + } + +private: + nsCOMPtr mDocument; +}; + +bool PresShell::sDisableNonTestMouseEvents = false; + +mozilla::LazyLogModule PresShell::gLog("PresShell"); + +#ifdef DEBUG +static void +VerifyStyleTree(nsPresContext* aPresContext, nsFrameManager* aFrameManager) +{ + if (nsFrame::GetVerifyStyleTreeEnable()) { + if (aPresContext->RestyleManager()->IsServo()) { + NS_ERROR("stylo: cannot verify style tree with a ServoRestyleManager"); + return; + } + nsIFrame* rootFrame = aFrameManager->GetRootFrame(); + aPresContext->RestyleManager()->AsGecko()->DebugVerifyStyleTree(rootFrame); + } +} +#define VERIFY_STYLE_TREE ::VerifyStyleTree(mPresContext, mFrameConstructor) +#else +#define VERIFY_STYLE_TREE +#endif + +static bool gVerifyReflowEnabled; + +bool +nsIPresShell::GetVerifyReflowEnable() +{ +#ifdef DEBUG + static bool firstTime = true; + if (firstTime) { + firstTime = false; + char* flags = PR_GetEnv("GECKO_VERIFY_REFLOW_FLAGS"); + if (flags) { + bool error = false; + + for (;;) { + char* comma = PL_strchr(flags, ','); + if (comma) + *comma = '\0'; + + bool found = false; + const VerifyReflowFlags* flag = gFlags; + const VerifyReflowFlags* limit = gFlags + NUM_VERIFY_REFLOW_FLAGS; + while (flag < limit) { + if (PL_strcasecmp(flag->name, flags) == 0) { + gVerifyReflowFlags |= flag->bit; + found = true; + break; + } + ++flag; + } + + if (! found) + error = true; + + if (! comma) + break; + + *comma = ','; + flags = comma + 1; + } + + if (error) + ShowVerifyReflowFlags(); + } + + if (VERIFY_REFLOW_ON & gVerifyReflowFlags) { + gVerifyReflowEnabled = true; + + printf("Note: verifyreflow is enabled"); + if (VERIFY_REFLOW_NOISY & gVerifyReflowFlags) { + printf(" (noisy)"); + } + if (VERIFY_REFLOW_ALL & gVerifyReflowFlags) { + printf(" (all)"); + } + if (VERIFY_REFLOW_DUMP_COMMANDS & gVerifyReflowFlags) { + printf(" (show reflow commands)"); + } + if (VERIFY_REFLOW_NOISY_RC & gVerifyReflowFlags) { + printf(" (noisy reflow commands)"); + if (VERIFY_REFLOW_REALLY_NOISY_RC & gVerifyReflowFlags) { + printf(" (REALLY noisy reflow commands)"); + } + } + printf("\n"); + } + } +#endif + return gVerifyReflowEnabled; +} + +void +PresShell::AddInvalidateHiddenPresShellObserver(nsRefreshDriver *aDriver) +{ + if (!mHiddenInvalidationObserverRefreshDriver && !mIsDestroying && !mHaveShutDown) { + aDriver->AddPresShellToInvalidateIfHidden(this); + mHiddenInvalidationObserverRefreshDriver = aDriver; + } +} + +void +nsIPresShell::InvalidatePresShellIfHidden() +{ + if (!IsVisible() && mPresContext) { + mPresContext->NotifyInvalidation(0); + } + mHiddenInvalidationObserverRefreshDriver = nullptr; +} + +void +nsIPresShell::CancelInvalidatePresShellIfHidden() +{ + if (mHiddenInvalidationObserverRefreshDriver) { + mHiddenInvalidationObserverRefreshDriver->RemovePresShellToInvalidateIfHidden(this); + mHiddenInvalidationObserverRefreshDriver = nullptr; + } +} + +void +nsIPresShell::SetVerifyReflowEnable(bool aEnabled) +{ + gVerifyReflowEnabled = aEnabled; +} + +/* virtual */ void +nsIPresShell::AddWeakFrameExternal(nsWeakFrame* aWeakFrame) +{ + AddWeakFrameInternal(aWeakFrame); +} + +void +nsIPresShell::AddWeakFrameInternal(nsWeakFrame* aWeakFrame) +{ + if (aWeakFrame->GetFrame()) { + aWeakFrame->GetFrame()->AddStateBits(NS_FRAME_EXTERNAL_REFERENCE); + } + aWeakFrame->SetPreviousWeakFrame(mWeakFrames); + mWeakFrames = aWeakFrame; +} + +/* virtual */ void +nsIPresShell::RemoveWeakFrameExternal(nsWeakFrame* aWeakFrame) +{ + RemoveWeakFrameInternal(aWeakFrame); +} + +void +nsIPresShell::RemoveWeakFrameInternal(nsWeakFrame* aWeakFrame) +{ + if (mWeakFrames == aWeakFrame) { + mWeakFrames = aWeakFrame->GetPreviousWeakFrame(); + return; + } + nsWeakFrame* nextWeak = mWeakFrames; + while (nextWeak && nextWeak->GetPreviousWeakFrame() != aWeakFrame) { + nextWeak = nextWeak->GetPreviousWeakFrame(); + } + if (nextWeak) { + nextWeak->SetPreviousWeakFrame(aWeakFrame->GetPreviousWeakFrame()); + } +} + +already_AddRefed +nsIPresShell::FrameSelection() +{ + RefPtr ret = mSelection; + return ret.forget(); +} + +//---------------------------------------------------------------------- + +static bool sSynthMouseMove = true; +static uint32_t sNextPresShellId; +static bool sPointerEventEnabled = true; +static bool sPointerEventImplicitCapture = false; +static bool sAccessibleCaretEnabled = false; +static bool sAccessibleCaretOnTouch = false; +static bool sBeforeAfterKeyboardEventEnabled = false; + +/* static */ bool +PresShell::AccessibleCaretEnabled(nsIDocShell* aDocShell) +{ + static bool initialized = false; + if (!initialized) { + Preferences::AddBoolVarCache(&sAccessibleCaretEnabled, "layout.accessiblecaret.enabled"); + Preferences::AddBoolVarCache(&sAccessibleCaretOnTouch, "layout.accessiblecaret.enabled_on_touch"); + initialized = true; + } + // If the pref forces it on, then enable it. + if (sAccessibleCaretEnabled) { + return true; + } + // If the touch pref is on, and touch events are enabled (this depends + // on the specific device running), then enable it. + if (sAccessibleCaretOnTouch && dom::TouchEvent::PrefEnabled(aDocShell)) { + return true; + } + // Otherwise, disabled. + return false; +} + +/* static */ bool +PresShell::BeforeAfterKeyboardEventEnabled() +{ + static bool sInitialized = false; + if (!sInitialized) { + Preferences::AddBoolVarCache(&sBeforeAfterKeyboardEventEnabled, + "dom.beforeAfterKeyboardEvent.enabled"); + sInitialized = true; + } + return sBeforeAfterKeyboardEventEnabled; +} + +/* static */ bool +PresShell::IsTargetIframe(nsINode* aTarget) +{ + return aTarget && aTarget->IsHTMLElement(nsGkAtoms::iframe); +} + +PresShell::PresShell() + : mMouseLocation(NS_UNCONSTRAINEDSIZE, NS_UNCONSTRAINEDSIZE) +{ +#ifdef MOZ_REFLOW_PERF + mReflowCountMgr = new ReflowCountMgr(); + mReflowCountMgr->SetPresContext(mPresContext); + mReflowCountMgr->SetPresShell(this); +#endif + mLoadBegin = TimeStamp::Now(); + + mSelectionFlags = nsISelectionDisplay::DISPLAY_TEXT | nsISelectionDisplay::DISPLAY_IMAGES; + mIsThemeSupportDisabled = false; + mIsActive = true; + // FIXME/bug 735029: find a better solution to this problem + mIsFirstPaint = true; + mPresShellId = sNextPresShellId++; + mFrozen = false; + mRenderFlags = 0; + + mScrollPositionClampingScrollPortSizeSet = false; + + static bool addedSynthMouseMove = false; + if (!addedSynthMouseMove) { + Preferences::AddBoolVarCache(&sSynthMouseMove, + "layout.reflow.synthMouseMove", true); + addedSynthMouseMove = true; + } + static bool addedPointerEventEnabled = false; + if (!addedPointerEventEnabled) { + Preferences::AddBoolVarCache(&sPointerEventEnabled, + "dom.w3c_pointer_events.enabled", true); + addedPointerEventEnabled = true; + } + static bool addedPointerEventImplicitCapture = false; + if (!addedPointerEventImplicitCapture) { + Preferences::AddBoolVarCache(&sPointerEventImplicitCapture, + "dom.w3c_pointer_events.implicit_capture", + true); + addedPointerEventImplicitCapture = true; + } + mPaintingIsFrozen = false; + mHasCSSBackgroundColor = true; + mIsLastChromeOnlyEscapeKeyConsumed = false; + mHasReceivedPaintMessage = false; +} + +NS_IMPL_ISUPPORTS(PresShell, nsIPresShell, nsIDocumentObserver, + nsISelectionController, + nsISelectionDisplay, nsIObserver, nsISupportsWeakReference, + nsIMutationObserver) + +PresShell::~PresShell() +{ + if (!mHaveShutDown) { + NS_NOTREACHED("Someone did not call nsIPresShell::destroy"); + Destroy(); + } + + NS_ASSERTION(mCurrentEventContentStack.Count() == 0, + "Huh, event content left on the stack in pres shell dtor!"); + NS_ASSERTION(mFirstCallbackEventRequest == nullptr && + mLastCallbackEventRequest == nullptr, + "post-reflow queues not empty. This means we're leaking"); + + // Verify that if painting was frozen, but we're being removed from the tree, + // that we now re-enable painting on our refresh driver, since it may need to + // be re-used by another presentation. + if (mPaintingIsFrozen) { + mPresContext->RefreshDriver()->Thaw(); + } + + MOZ_ASSERT(mAllocatedPointers.IsEmpty(), "Some pres arena objects were not freed"); + + mStyleSet->Delete(); + delete mFrameConstructor; + + mCurrentEventContent = nullptr; +} + +/** + * Initialize the presentation shell. Create view manager and style + * manager. + * Note this can't be merged into our constructor because caret initialization + * calls AddRef() on us. + */ +void +PresShell::Init(nsIDocument* aDocument, + nsPresContext* aPresContext, + nsViewManager* aViewManager, + StyleSetHandle aStyleSet) +{ + NS_PRECONDITION(aDocument, "null ptr"); + NS_PRECONDITION(aPresContext, "null ptr"); + NS_PRECONDITION(aViewManager, "null ptr"); + NS_PRECONDITION(!mDocument, "already initialized"); + + if (!aDocument || !aPresContext || !aViewManager || mDocument) { + return; + } + + mDocument = aDocument; + mViewManager = aViewManager; + + // Create our frame constructor. + mFrameConstructor = new nsCSSFrameConstructor(mDocument, this); + + mFrameManager = mFrameConstructor; + + // The document viewer owns both view manager and pres shell. + mViewManager->SetPresShell(this); + + // Bind the context to the presentation shell. + mPresContext = aPresContext; + StyleBackendType backend = aStyleSet->IsServo() ? StyleBackendType::Servo + : StyleBackendType::Gecko; + aPresContext->AttachShell(this, backend); + + // Now we can initialize the style set. Make sure to set the member before + // calling Init, since various subroutines need to find the style set off + // the PresContext during initialization. + mStyleSet = aStyleSet; + mStyleSet->Init(aPresContext); + + // Notify our prescontext that it now has a compatibility mode. Note that + // this MUST happen after we set up our style set but before we create any + // frames. + mPresContext->CompatibilityModeChanged(); + + // Add the preference style sheet. + UpdatePreferenceStyles(); + + if (AccessibleCaretEnabled(mDocument->GetDocShell())) { + // Need to happen before nsFrameSelection has been set up. + mAccessibleCaretEventHub = new AccessibleCaretEventHub(this); + } + + mSelection = new nsFrameSelection(); + + RefPtr frameSelection = mSelection; + frameSelection->Init(this, nullptr); + + // Important: this has to happen after the selection has been set up +#ifdef SHOW_CARET + // make the caret + mCaret = new nsCaret(); + mCaret->Init(this); + mOriginalCaret = mCaret; + + //SetCaretEnabled(true); // make it show in browser windows +#endif + //set up selection to be displayed in document + // Don't enable selection for print media + nsPresContext::nsPresContextType type = aPresContext->Type(); + if (type != nsPresContext::eContext_PrintPreview && + type != nsPresContext::eContext_Print) + SetDisplaySelection(nsISelectionController::SELECTION_DISABLED); + + if (gMaxRCProcessingTime == -1) { + gMaxRCProcessingTime = + Preferences::GetInt("layout.reflow.timeslice", NS_MAX_REFLOW_TIME); + } + + { + nsCOMPtr os = mozilla::services::GetObserverService(); + if (os) { + os->AddObserver(this, "agent-sheet-added", false); + os->AddObserver(this, "user-sheet-added", false); + os->AddObserver(this, "author-sheet-added", false); + os->AddObserver(this, "agent-sheet-removed", false); + os->AddObserver(this, "user-sheet-removed", false); + os->AddObserver(this, "author-sheet-removed", false); +#ifdef MOZ_XUL + os->AddObserver(this, "chrome-flush-skin-caches", false); +#endif + os->AddObserver(this, "memory-pressure", false); + } + } + +#ifdef MOZ_REFLOW_PERF + if (mReflowCountMgr) { + bool paintFrameCounts = + Preferences::GetBool("layout.reflow.showframecounts"); + + bool dumpFrameCounts = + Preferences::GetBool("layout.reflow.dumpframecounts"); + + bool dumpFrameByFrameCounts = + Preferences::GetBool("layout.reflow.dumpframebyframecounts"); + + mReflowCountMgr->SetDumpFrameCounts(dumpFrameCounts); + mReflowCountMgr->SetDumpFrameByFrameCounts(dumpFrameByFrameCounts); + mReflowCountMgr->SetPaintFrameCounts(paintFrameCounts); + } +#endif + + if (mDocument->HasAnimationController()) { + nsSMILAnimationController* animCtrl = mDocument->GetAnimationController(); + animCtrl->NotifyRefreshDriverCreated(GetPresContext()->RefreshDriver()); + } + + for (DocumentTimeline* timeline : mDocument->Timelines()) { + timeline->NotifyRefreshDriverCreated(GetPresContext()->RefreshDriver()); + } + + // Get our activeness from the docShell. + QueryIsActive(); + + // Setup our font inflation preferences. + SetupFontInflation(); + + mTouchManager.Init(this, mDocument); + + if (mPresContext->IsRootContentDocument()) { + mZoomConstraintsClient = new ZoomConstraintsClient(); + mZoomConstraintsClient->Init(this, mDocument); + if (gfxPrefs::MetaViewportEnabled() || gfxPrefs::APZAllowZooming()) { + mMobileViewportManager = new MobileViewportManager(this, mDocument); + } + } +} + +enum TextPerfLogType { + eLog_reflow, + eLog_loaddone, + eLog_totals +}; + +static void +LogTextPerfStats(gfxTextPerfMetrics* aTextPerf, + PresShell* aPresShell, + const gfxTextPerfMetrics::TextCounts& aCounts, + float aTime, TextPerfLogType aLogType, const char* aURL) +{ + LogModule* tpLog = gfxPlatform::GetLog(eGfxLog_textperf); + + // ignore XUL contexts unless at debug level + mozilla::LogLevel logLevel = LogLevel::Warning; + if (aCounts.numContentTextRuns == 0) { + logLevel = LogLevel::Debug; + } + + if (!MOZ_LOG_TEST(tpLog, logLevel)) { + return; + } + + char prefix[256]; + + switch (aLogType) { + case eLog_reflow: + SprintfLiteral(prefix, "(textperf-reflow) %p time-ms: %7.0f", aPresShell, aTime); + break; + case eLog_loaddone: + SprintfLiteral(prefix, "(textperf-loaddone) %p time-ms: %7.0f", aPresShell, aTime); + break; + default: + MOZ_ASSERT(aLogType == eLog_totals, "unknown textperf log type"); + SprintfLiteral(prefix, "(textperf-totals) %p", aPresShell); + } + + double hitRatio = 0.0; + uint32_t lookups = aCounts.wordCacheHit + aCounts.wordCacheMiss; + if (lookups) { + hitRatio = double(aCounts.wordCacheHit) / double(lookups); + } + + if (aLogType == eLog_loaddone) { + MOZ_LOG(tpLog, logLevel, + ("%s reflow: %d chars: %d " + "[%s] " + "content-textruns: %d chrome-textruns: %d " + "max-textrun-len: %d " + "word-cache-lookups: %d word-cache-hit-ratio: %4.3f " + "word-cache-space: %d word-cache-long: %d " + "pref-fallbacks: %d system-fallbacks: %d " + "textruns-const: %d textruns-destr: %d " + "generic-lookups: %d " + "cumulative-textruns-destr: %d\n", + prefix, aTextPerf->reflowCount, aCounts.numChars, + (aURL ? aURL : ""), + aCounts.numContentTextRuns, aCounts.numChromeTextRuns, + aCounts.maxTextRunLen, + lookups, hitRatio, + aCounts.wordCacheSpaceRules, aCounts.wordCacheLong, + aCounts.fallbackPrefs, aCounts.fallbackSystem, + aCounts.textrunConst, aCounts.textrunDestr, + aCounts.genericLookups, + aTextPerf->cumulative.textrunDestr)); + } else { + MOZ_LOG(tpLog, logLevel, + ("%s reflow: %d chars: %d " + "content-textruns: %d chrome-textruns: %d " + "max-textrun-len: %d " + "word-cache-lookups: %d word-cache-hit-ratio: %4.3f " + "word-cache-space: %d word-cache-long: %d " + "pref-fallbacks: %d system-fallbacks: %d " + "textruns-const: %d textruns-destr: %d " + "generic-lookups: %d " + "cumulative-textruns-destr: %d\n", + prefix, aTextPerf->reflowCount, aCounts.numChars, + aCounts.numContentTextRuns, aCounts.numChromeTextRuns, + aCounts.maxTextRunLen, + lookups, hitRatio, + aCounts.wordCacheSpaceRules, aCounts.wordCacheLong, + aCounts.fallbackPrefs, aCounts.fallbackSystem, + aCounts.textrunConst, aCounts.textrunDestr, + aCounts.genericLookups, + aTextPerf->cumulative.textrunDestr)); + } +} + +void +PresShell::Destroy() +{ + // Do not add code before this line please! + if (mHaveShutDown) { + return; + } + + NS_ASSERTION(!nsContentUtils::IsSafeToRunScript(), + "destroy called on presshell while scripts not blocked"); + + // dump out cumulative text perf metrics + gfxTextPerfMetrics* tp; + if (mPresContext && (tp = mPresContext->GetTextPerfMetrics())) { + tp->Accumulate(); + if (tp->cumulative.numChars > 0) { + LogTextPerfStats(tp, this, tp->cumulative, 0.0, eLog_totals, nullptr); + } + } + if (mPresContext) { + const bool mayFlushUserFontSet = false; + gfxUserFontSet* fs = mPresContext->GetUserFontSet(mayFlushUserFontSet); + if (fs) { + uint32_t fontCount; + uint64_t fontSize; + fs->GetLoadStatistics(fontCount, fontSize); + Telemetry::Accumulate(Telemetry::WEBFONT_PER_PAGE, fontCount); + Telemetry::Accumulate(Telemetry::WEBFONT_SIZE_PER_PAGE, + uint32_t(fontSize/1024)); + } else { + Telemetry::Accumulate(Telemetry::WEBFONT_PER_PAGE, 0); + Telemetry::Accumulate(Telemetry::WEBFONT_SIZE_PER_PAGE, 0); + } + } + +#ifdef MOZ_REFLOW_PERF + DumpReflows(); + if (mReflowCountMgr) { + delete mReflowCountMgr; + mReflowCountMgr = nullptr; + } +#endif + + if (mZoomConstraintsClient) { + mZoomConstraintsClient->Destroy(); + mZoomConstraintsClient = nullptr; + } + if (mMobileViewportManager) { + mMobileViewportManager->Destroy(); + mMobileViewportManager = nullptr; + } + +#ifdef ACCESSIBILITY + if (mDocAccessible) { +#ifdef DEBUG + if (a11y::logging::IsEnabled(a11y::logging::eDocDestroy)) + a11y::logging::DocDestroy("presshell destroyed", mDocument); +#endif + + mDocAccessible->Shutdown(); + mDocAccessible = nullptr; + } +#endif // ACCESSIBILITY + + MaybeReleaseCapturingContent(); + + if (gKeyDownTarget && gKeyDownTarget->OwnerDoc() == mDocument) { + NS_RELEASE(gKeyDownTarget); + } + + if (mContentToScrollTo) { + mContentToScrollTo->DeleteProperty(nsGkAtoms::scrolling); + mContentToScrollTo = nullptr; + } + + if (mPresContext) { + // We need to notify the destroying the nsPresContext to ESM for + // suppressing to use from ESM. + mPresContext->EventStateManager()->NotifyDestroyPresContext(mPresContext); + } + + { + nsCOMPtr os = mozilla::services::GetObserverService(); + if (os) { + os->RemoveObserver(this, "agent-sheet-added"); + os->RemoveObserver(this, "user-sheet-added"); + os->RemoveObserver(this, "author-sheet-added"); + os->RemoveObserver(this, "agent-sheet-removed"); + os->RemoveObserver(this, "user-sheet-removed"); + os->RemoveObserver(this, "author-sheet-removed"); +#ifdef MOZ_XUL + os->RemoveObserver(this, "chrome-flush-skin-caches"); +#endif + os->RemoveObserver(this, "memory-pressure"); + } + } + + // If our paint suppression timer is still active, kill it. + if (mPaintSuppressionTimer) { + mPaintSuppressionTimer->Cancel(); + mPaintSuppressionTimer = nullptr; + } + + // Same for our reflow continuation timer + if (mReflowContinueTimer) { + mReflowContinueTimer->Cancel(); + mReflowContinueTimer = nullptr; + } + + if (mDelayedPaintTimer) { + mDelayedPaintTimer->Cancel(); + mDelayedPaintTimer = nullptr; + } + + mSynthMouseMoveEvent.Revoke(); + + mUpdateApproximateFrameVisibilityEvent.Revoke(); + + ClearApproximatelyVisibleFramesList(Some(OnNonvisible::DISCARD_IMAGES)); + + if (mCaret) { + mCaret->Terminate(); + mCaret = nullptr; + } + + if (mSelection) { + RefPtr frameSelection = mSelection; + frameSelection->DisconnectFromPresShell(); + } + + if (mAccessibleCaretEventHub) { + mAccessibleCaretEventHub->Terminate(); + mAccessibleCaretEventHub = nullptr; + } + + // release our pref style sheet, if we have one still + RemovePreferenceStyles(); + + mIsDestroying = true; + + // We can't release all the event content in + // mCurrentEventContentStack here since there might be code on the + // stack that will release the event content too. Double release + // bad! + + // The frames will be torn down, so remove them from the current + // event frame stack (since they'd be dangling references if we'd + // leave them in) and null out the mCurrentEventFrame pointer as + // well. + + mCurrentEventFrame = nullptr; + + int32_t i, count = mCurrentEventFrameStack.Length(); + for (i = 0; i < count; i++) { + mCurrentEventFrameStack[i] = nullptr; + } + + mFramesToDirty.Clear(); + + if (mViewManager) { + // Clear the view manager's weak pointer back to |this| in case it + // was leaked. + mViewManager->SetPresShell(nullptr); + mViewManager = nullptr; + } + + // mFrameArena will be destroyed soon. Clear out any ArenaRefPtrs + // pointing to objects in the arena now. This is done: + // + // (a) before mFrameArena's destructor runs so that our + // mAllocatedPointers becomes empty and doesn't trip the assertion + // in ~PresShell, + // (b) before the mPresContext->DetachShell() below, so + // that when we clear the ArenaRefPtrs they'll still be able to + // get back to this PresShell to deregister themselves (e.g. note + // how nsStyleContext::Arena returns the PresShell got from its + // rule node's nsPresContext, which would return null if we'd already + // called mPresContext->DetachShell()), and + // (c) before the mStyleSet->BeginShutdown() call just below, so that + // the nsStyleContexts don't complain they're being destroyed later + // than the rule tree is. + mFrameArena.ClearArenaRefPtrs(); + + mStyleSet->BeginShutdown(); + nsRefreshDriver* rd = GetPresContext()->RefreshDriver(); + + // This shell must be removed from the document before the frame + // hierarchy is torn down to avoid finding deleted frames through + // this presshell while the frames are being torn down + if (mDocument) { + NS_ASSERTION(mDocument->GetShell() == this, "Wrong shell?"); + mDocument->DeleteShell(); + + if (mDocument->HasAnimationController()) { + mDocument->GetAnimationController()->NotifyRefreshDriverDestroying(rd); + } + for (DocumentTimeline* timeline : mDocument->Timelines()) { + timeline->NotifyRefreshDriverDestroying(rd); + } + } + + if (mPresContext) { + mPresContext->AnimationManager()->ClearEventQueue(); + mPresContext->TransitionManager()->ClearEventQueue(); + } + + // Revoke any pending events. We need to do this and cancel pending reflows + // before we destroy the frame manager, since apparently frame destruction + // sometimes spins the event queue when plug-ins are involved(!). + rd->RemoveLayoutFlushObserver(this); + if (mHiddenInvalidationObserverRefreshDriver) { + mHiddenInvalidationObserverRefreshDriver->RemovePresShellToInvalidateIfHidden(this); + } + + if (rd->GetPresContext() == GetPresContext()) { + rd->RevokeViewManagerFlush(); + } + + mResizeEvent.Revoke(); + if (mAsyncResizeTimerIsActive) { + mAsyncResizeEventTimer->Cancel(); + mAsyncResizeTimerIsActive = false; + } + + CancelAllPendingReflows(); + CancelPostedReflowCallbacks(); + + // Destroy the frame manager. This will destroy the frame hierarchy + mFrameConstructor->WillDestroyFrameTree(); + + // Destroy all frame properties (whose destruction was suppressed + // while destroying the frame tree, but which might contain more + // frames within the properties. + if (mPresContext) { + // Clear out the prescontext's property table -- since our frame tree is + // now dead, we shouldn't be looking up any more properties in that table. + // We want to do this before we call DetachShell() on the prescontext, so + // property destructors can usefully call GetPresShell() on the + // prescontext. + mPresContext->PropertyTable()->DeleteAll(); + } + + + NS_WARNING_ASSERTION(!mWeakFrames, + "Weak frames alive after destroying FrameManager"); + while (mWeakFrames) { + mWeakFrames->Clear(this); + } + + // Let the style set do its cleanup. + mStyleSet->Shutdown(); + + if (mPresContext) { + // We hold a reference to the pres context, and it holds a weak link back + // to us. To avoid the pres context having a dangling reference, set its + // pres shell to nullptr + mPresContext->DetachShell(); + + // Clear the link handler (weak reference) as well + mPresContext->SetLinkHandler(nullptr); + } + + mHaveShutDown = true; + + mTouchManager.Destroy(); +} + +void +PresShell::MakeZombie() +{ + mIsZombie = true; + CancelAllPendingReflows(); +} + +nsRefreshDriver* +nsIPresShell::GetRefreshDriver() const +{ + return mPresContext ? mPresContext->RefreshDriver() : nullptr; +} + +void +nsIPresShell::SetAuthorStyleDisabled(bool aStyleDisabled) +{ + if (aStyleDisabled != mStyleSet->GetAuthorStyleDisabled()) { + mStyleSet->SetAuthorStyleDisabled(aStyleDisabled); + RestyleForCSSRuleChanges(); + + nsCOMPtr observerService = + mozilla::services::GetObserverService(); + if (observerService) { + observerService->NotifyObservers(mDocument, + "author-style-disabled-changed", + nullptr); + } + } +} + +bool +nsIPresShell::GetAuthorStyleDisabled() const +{ + return mStyleSet->GetAuthorStyleDisabled(); +} + +void +PresShell::UpdatePreferenceStyles() +{ + if (!mDocument) { + return; + } + + // If the document doesn't have a window there's no need to notify + // its presshell about changes to preferences since the document is + // in a state where it doesn't matter any more (see + // nsDocumentViewer::Close()). + if (!mDocument->GetWindow()) { + return; + } + + // Documents in chrome shells do not have any preference style rules applied. + if (nsContentUtils::IsInChromeDocshell(mDocument)) { + return; + } + + // We need to pass in mPresContext so that if the nsLayoutStylesheetCache + // needs to recreate the pref style sheet, it has somewhere to get the + // pref styling information from. All pres contexts for + // IsChromeOriginImage() == false will have the same pref styling information, + // and similarly for IsChromeOriginImage() == true, so it doesn't really + // matter which pres context we pass in when it does need to be recreated. + // (See nsPresContext::GetDocumentColorPreferences for how whether we + // are a chrome origin image affects some pref styling information.) + auto cache = nsLayoutStylesheetCache::For(mStyleSet->BackendType()); + RefPtr newPrefSheet = + mPresContext->IsChromeOriginImage() ? + cache->ChromePreferenceSheet(mPresContext) : + cache->ContentPreferenceSheet(mPresContext); + + if (mPrefStyleSheet == newPrefSheet) { + return; + } + + mStyleSet->BeginUpdate(); + + RemovePreferenceStyles(); + + mStyleSet->AppendStyleSheet(SheetType::User, newPrefSheet); + mPrefStyleSheet = newPrefSheet; + + mStyleSet->EndUpdate(); +} + +void +PresShell::RemovePreferenceStyles() +{ + if (mPrefStyleSheet) { + mStyleSet->RemoveStyleSheet(SheetType::User, mPrefStyleSheet); + mPrefStyleSheet = nullptr; + } +} + +void +PresShell::AddUserSheet(nsISupports* aSheet) +{ + if (mStyleSet->IsServo()) { + NS_ERROR("stylo: nsStyleSheetService doesn't handle ServoStyleSheets yet"); + return; + } + + // Make sure this does what nsDocumentViewer::CreateStyleSet does wrt + // ordering. We want this new sheet to come after all the existing stylesheet + // service sheets, but before other user sheets; see nsIStyleSheetService.idl + // for the ordering. Just remove and readd all the nsStyleSheetService + // sheets. + nsCOMPtr dummy = + do_GetService(NS_STYLESHEETSERVICE_CONTRACTID); + + mStyleSet->BeginUpdate(); + + nsStyleSheetService* sheetService = nsStyleSheetService::gInstance; + nsTArray>& userSheets = *sheetService->UserStyleSheets(); + // Iterate forwards when removing so the searches for RemoveStyleSheet are as + // short as possible. + for (StyleSheet* sheet : userSheets) { + mStyleSet->RemoveStyleSheet(SheetType::User, sheet); + } + + // Now iterate backwards, so that the order of userSheets will be the same as + // the order of sheets from it in the style set. + for (StyleSheet* sheet : Reversed(userSheets)) { + mStyleSet->PrependStyleSheet(SheetType::User, sheet); + } + + mStyleSet->EndUpdate(); + + RestyleForCSSRuleChanges(); +} + +void +PresShell::AddAgentSheet(nsISupports* aSheet) +{ + // Make sure this does what nsDocumentViewer::CreateStyleSet does + // wrt ordering. + // XXXheycam This needs to work with ServoStyleSheets too. + RefPtr sheet = do_QueryObject(aSheet); + if (!sheet) { + NS_ERROR("stylo: AddAgentSheet needs to support ServoStyleSheets"); + return; + } + + mStyleSet->AppendStyleSheet(SheetType::Agent, sheet); + RestyleForCSSRuleChanges(); +} + +void +PresShell::AddAuthorSheet(nsISupports* aSheet) +{ + // XXXheycam This needs to work with ServoStyleSheets too. + RefPtr sheet = do_QueryObject(aSheet); + if (!sheet) { + NS_ERROR("stylo: AddAuthorSheet needs to support ServoStyleSheets"); + return; + } + + // Document specific "additional" Author sheets should be stronger than the + // ones added with the StyleSheetService. + StyleSheet* firstAuthorSheet = + mDocument->GetFirstAdditionalAuthorSheet(); + if (firstAuthorSheet) { + mStyleSet->InsertStyleSheetBefore(SheetType::Doc, sheet, firstAuthorSheet); + } else { + mStyleSet->AppendStyleSheet(SheetType::Doc, sheet); + } + + RestyleForCSSRuleChanges(); +} + +void +PresShell::RemoveSheet(SheetType aType, nsISupports* aSheet) +{ + RefPtr sheet = do_QueryObject(aSheet); + if (!sheet) { + NS_ERROR("stylo: RemoveSheet needs to support ServoStyleSheets"); + return; + } + + mStyleSet->RemoveStyleSheet(aType, sheet); + RestyleForCSSRuleChanges(); +} + +NS_IMETHODIMP +PresShell::SetDisplaySelection(int16_t aToggle) +{ + RefPtr frameSelection = mSelection; + frameSelection->SetDisplaySelection(aToggle); + return NS_OK; +} + +NS_IMETHODIMP +PresShell::GetDisplaySelection(int16_t *aToggle) +{ + RefPtr frameSelection = mSelection; + *aToggle = frameSelection->GetDisplaySelection(); + return NS_OK; +} + +NS_IMETHODIMP +PresShell::GetSelection(RawSelectionType aRawSelectionType, + nsISelection **aSelection) +{ + if (!aSelection || !mSelection) + return NS_ERROR_NULL_POINTER; + + RefPtr frameSelection = mSelection; + nsCOMPtr selection = + frameSelection->GetSelection(ToSelectionType(aRawSelectionType)); + + if (!selection) { + return NS_ERROR_INVALID_ARG; + } + + selection.forget(aSelection); + return NS_OK; +} + +Selection* +PresShell::GetCurrentSelection(SelectionType aSelectionType) +{ + if (!mSelection) + return nullptr; + + RefPtr frameSelection = mSelection; + return frameSelection->GetSelection(aSelectionType); +} + +already_AddRefed +PresShell::GetSelectionControllerForFocusedContent(nsIContent** aFocusedContent) +{ + if (aFocusedContent) { + *aFocusedContent = nullptr; + } + + if (mDocument) { + nsCOMPtr focusedWindow; + nsCOMPtr focusedContent = + nsFocusManager::GetFocusedDescendant(mDocument->GetWindow(), false, + getter_AddRefs(focusedWindow)); + if (focusedContent) { + nsIFrame* frame = focusedContent->GetPrimaryFrame(); + if (frame) { + nsCOMPtr selectionController; + frame->GetSelectionController(mPresContext, + getter_AddRefs(selectionController)); + if (selectionController) { + if (aFocusedContent) { + focusedContent.forget(aFocusedContent); + } + return selectionController.forget(); + } + } + } + } + nsCOMPtr self(this); + return self.forget(); +} + +NS_IMETHODIMP +PresShell::ScrollSelectionIntoView(RawSelectionType aRawSelectionType, + SelectionRegion aRegion, + int16_t aFlags) +{ + if (!mSelection) + return NS_ERROR_NULL_POINTER; + + RefPtr frameSelection = mSelection; + return frameSelection->ScrollSelectionIntoView( + ToSelectionType(aRawSelectionType), aRegion, aFlags); +} + +NS_IMETHODIMP +PresShell::RepaintSelection(RawSelectionType aRawSelectionType) +{ + if (!mSelection) + return NS_ERROR_NULL_POINTER; + + RefPtr frameSelection = mSelection; + return frameSelection->RepaintSelection(ToSelectionType(aRawSelectionType)); +} + +// Make shell be a document observer +void +PresShell::BeginObservingDocument() +{ + if (mDocument && !mIsDestroying) { + mDocument->AddObserver(this); + if (mIsDocumentGone) { + NS_WARNING("Adding a presshell that was disconnected from the document " + "as a document observer? Sounds wrong..."); + mIsDocumentGone = false; + } + } +} + +// Make shell stop being a document observer +void +PresShell::EndObservingDocument() +{ + // XXXbz do we need to tell the frame constructor that the document + // is gone, perhaps? Except for printing it's NOT gone, sometimes. + mIsDocumentGone = true; + if (mDocument) { + mDocument->RemoveObserver(this); + } +} + +#ifdef DEBUG_kipp +char* nsPresShell_ReflowStackPointerTop; +#endif + +class XBLConstructorRunner : public Runnable +{ +public: + explicit XBLConstructorRunner(nsIDocument* aDocument) + : mDocument(aDocument) + { + } + + NS_IMETHOD Run() override + { + mDocument->BindingManager()->ProcessAttachedQueue(); + return NS_OK; + } + +private: + nsCOMPtr mDocument; +}; + +nsresult +PresShell::Initialize(nscoord aWidth, nscoord aHeight) +{ + if (mIsDestroying) { + return NS_OK; + } + + if (!mDocument) { + // Nothing to do + return NS_OK; + } + + NS_ASSERTION(!mDidInitialize, "Why are we being called?"); + + nsCOMPtr kungFuDeathGrip(this); + mDidInitialize = true; + +#ifdef DEBUG + if (VERIFY_REFLOW_NOISY_RC & gVerifyReflowFlags) { + if (mDocument) { + nsIURI *uri = mDocument->GetDocumentURI(); + if (uri) { + printf("*** PresShell::Initialize (this=%p, url='%s')\n", + (void*)this, uri->GetSpecOrDefault().get()); + } + } + } +#endif + + // XXX Do a full invalidate at the beginning so that invalidates along + // the way don't have region accumulation issues? + + mPresContext->SetVisibleArea(nsRect(0, 0, aWidth, aHeight)); + + if (mStyleSet->IsServo() && mDocument->GetRootElement()) { + // If we have the root element already, go ahead style it along with any + // descendants. + // + // Some things, like nsDocumentViewer::GetPageMode, recreate the PresShell + // while keeping the content tree alive (see bug 1292280) - so we + // unconditionally mark the root as dirty. + mDocument->GetRootElement()->SetIsDirtyForServo(); + mStyleSet->AsServo()->StyleDocument(/* aLeaveDirtyBits = */ false); + } + + // Get the root frame from the frame manager + // XXXbz it would be nice to move this somewhere else... like frame manager + // Init(), say. But we need to make sure our views are all set up by the + // time we do this! + nsIFrame* rootFrame = mFrameConstructor->GetRootFrame(); + NS_ASSERTION(!rootFrame, "How did that happen, exactly?"); + if (!rootFrame) { + nsAutoScriptBlocker scriptBlocker; + mFrameConstructor->BeginUpdate(); + rootFrame = mFrameConstructor->ConstructRootFrame(); + mFrameConstructor->SetRootFrame(rootFrame); + mFrameConstructor->EndUpdate(); + } + + NS_ENSURE_STATE(!mHaveShutDown); + + if (!rootFrame) { + return NS_ERROR_OUT_OF_MEMORY; + } + + nsIFrame* invalidateFrame = nullptr; + for (nsIFrame* f = rootFrame; f; f = nsLayoutUtils::GetCrossDocParentFrame(f)) { + if (f->GetStateBits() & NS_FRAME_NO_COMPONENT_ALPHA) { + invalidateFrame = f; + f->RemoveStateBits(NS_FRAME_NO_COMPONENT_ALPHA); + } + nsCOMPtr shell; + if (f->GetType() == nsGkAtoms::subDocumentFrame && + (shell = static_cast(f)->GetSubdocumentPresShellForPainting(0)) && + shell->GetPresContext()->IsRootContentDocument()) { + // Root content documents build a 'force active' layer, and component alpha flattening + // can't be propagated across that so no need to invalidate above this frame. + break; + } + + + } + if (invalidateFrame) { + invalidateFrame->InvalidateFrameSubtree(); + } + + Element *root = mDocument->GetRootElement(); + + if (root) { + { + nsAutoCauseReflowNotifier reflowNotifier(this); + mFrameConstructor->BeginUpdate(); + + // Have the style sheet processor construct frame for the root + // content object down + mFrameConstructor->ContentInserted(nullptr, root, nullptr, false); + VERIFY_STYLE_TREE; + + // Something in mFrameConstructor->ContentInserted may have caused + // Destroy() to get called, bug 337586. + NS_ENSURE_STATE(!mHaveShutDown); + + mFrameConstructor->EndUpdate(); + } + + // nsAutoCauseReflowNotifier (which sets up a script blocker) going out of + // scope may have killed us too + NS_ENSURE_STATE(!mHaveShutDown); + + // Run the XBL binding constructors for any new frames we've constructed. + // (Do this in a script runner, since our caller might have a script + // blocker on the stack.) + nsContentUtils::AddScriptRunner(new XBLConstructorRunner(mDocument)); + } + + NS_ASSERTION(rootFrame, "How did that happen?"); + + // Note: when the frame was created above it had the NS_FRAME_IS_DIRTY bit + // set, but XBL processing could have caused a reflow which clears it. + if (MOZ_LIKELY(rootFrame->GetStateBits() & NS_FRAME_IS_DIRTY)) { + // Unset the DIRTY bits so that FrameNeedsReflow() will work right. + rootFrame->RemoveStateBits(NS_FRAME_IS_DIRTY | + NS_FRAME_HAS_DIRTY_CHILDREN); + NS_ASSERTION(!mDirtyRoots.Contains(rootFrame), + "Why is the root in mDirtyRoots already?"); + FrameNeedsReflow(rootFrame, nsIPresShell::eResize, NS_FRAME_IS_DIRTY); + NS_ASSERTION(mDirtyRoots.Contains(rootFrame), + "Should be in mDirtyRoots now"); + NS_ASSERTION(mReflowScheduled, "Why no reflow scheduled?"); + } + + // Restore our root scroll position now if we're getting here after EndLoad + // got called, since this is our one chance to do it. Note that we need not + // have reflowed for this to work; when the scrollframe is finally reflowed + // it'll pick up the position we store in it here. + if (!mDocumentLoading) { + RestoreRootScrollPosition(); + } + + // For printing, we just immediately unsuppress. + if (!mPresContext->IsPaginated()) { + // Kick off a one-shot timer based off our pref value. When this timer + // fires, if painting is still locked down, then we will go ahead and + // trigger a full invalidate and allow painting to proceed normally. + mPaintingSuppressed = true; + // Don't suppress painting if the document isn't loading. + nsIDocument::ReadyState readyState = mDocument->GetReadyStateEnum(); + if (readyState != nsIDocument::READYSTATE_COMPLETE) { + mPaintSuppressionTimer = do_CreateInstance("@mozilla.org/timer;1"); + } + if (!mPaintSuppressionTimer) { + mPaintingSuppressed = false; + } else { + // Initialize the timer. + + // Default to PAINTLOCK_EVENT_DELAY if we can't get the pref value. + int32_t delay = + Preferences::GetInt("nglayout.initialpaint.delay", + PAINTLOCK_EVENT_DELAY); + + mPaintSuppressionTimer->InitWithNamedFuncCallback( + sPaintSuppressionCallback, this, delay, nsITimer::TYPE_ONE_SHOT, + "PresShell::sPaintSuppressionCallback"); + } + } + + // If we get here and painting is not suppressed, then we can paint anytime + // and we should fire the before-first-paint notification + if (!mPaintingSuppressed) { + ScheduleBeforeFirstPaint(); + } + + return NS_OK; //XXX this needs to be real. MMP +} + +void +PresShell::sPaintSuppressionCallback(nsITimer *aTimer, void* aPresShell) +{ + RefPtr self = static_cast(aPresShell); + if (self) + self->UnsuppressPainting(); +} + +void +PresShell::AsyncResizeEventCallback(nsITimer* aTimer, void* aPresShell) +{ + static_cast(aPresShell)->FireResizeEvent(); +} + +nsresult +PresShell::ResizeReflow(nscoord aWidth, nscoord aHeight, nscoord aOldWidth, nscoord aOldHeight) +{ + if (mZoomConstraintsClient) { + // If we have a ZoomConstraintsClient and the available screen area + // changed, then we might need to disable double-tap-to-zoom, so notify + // the ZCC to update itself. + mZoomConstraintsClient->ScreenSizeChanged(); + } + if (mMobileViewportManager) { + // If we have a mobile viewport manager, request a reflow from it. It can + // recompute the final CSS viewport and trigger a call to + // ResizeReflowIgnoreOverride if it changed. + mMobileViewportManager->RequestReflow(); + return NS_OK; + } + + return ResizeReflowIgnoreOverride(aWidth, aHeight, aOldWidth, aOldHeight); +} + +nsresult +PresShell::ResizeReflowIgnoreOverride(nscoord aWidth, nscoord aHeight, nscoord aOldWidth, nscoord aOldHeight) +{ + NS_PRECONDITION(!mIsReflowing, "Shouldn't be in reflow here!"); + + // If we don't have a root frame yet, that means we haven't had our initial + // reflow... If that's the case, and aWidth or aHeight is unconstrained, + // ignore them altogether. + nsIFrame* rootFrame = mFrameConstructor->GetRootFrame(); + if (!rootFrame && aHeight == NS_UNCONSTRAINEDSIZE) { + // We can't do the work needed for SizeToContent without a root + // frame, and we want to return before setting the visible area. + return NS_ERROR_NOT_AVAILABLE; + } + + mPresContext->SetVisibleArea(nsRect(0, 0, aWidth, aHeight)); + + // There isn't anything useful we can do if the initial reflow hasn't happened. + if (!rootFrame) { + return NS_OK; + } + + WritingMode wm = rootFrame->GetWritingMode(); + NS_PRECONDITION((wm.IsVertical() ? aHeight : aWidth) != NS_UNCONSTRAINEDSIZE, + "shouldn't use unconstrained isize anymore"); + + const bool isBSizeChanging = wm.IsVertical() + ? aOldWidth != aWidth + : aOldHeight != aHeight; + + RefPtr viewManager = mViewManager; + // Take this ref after viewManager so it'll make sure to go away first. + nsCOMPtr kungFuDeathGrip(this); + + if (!GetPresContext()->SuppressingResizeReflow()) { + // Have to make sure that the content notifications are flushed before we + // start messing with the frame model; otherwise we can get content doubling. + mDocument->FlushPendingNotifications(Flush_ContentAndNotify); + + // Make sure style is up to date + { + nsAutoScriptBlocker scriptBlocker; + mPresContext->RestyleManager()->ProcessPendingRestyles(); + } + + rootFrame = mFrameConstructor->GetRootFrame(); + if (!mIsDestroying && rootFrame) { + // XXX Do a full invalidate at the beginning so that invalidates along + // the way don't have region accumulation issues? + + if (isBSizeChanging) { + // For BSize changes driven by style, RestyleManager handles this. + // For height:auto BSizes (i.e. layout-controlled), descendant + // intrinsic sizes can't depend on them. So the only other case is + // viewport-controlled BSizes which we handle here. + nsLayoutUtils::MarkIntrinsicISizesDirtyIfDependentOnBSize(rootFrame); + } + + { + nsAutoCauseReflowNotifier crNotifier(this); + WillDoReflow(); + + // Kick off a top-down reflow + AUTO_LAYOUT_PHASE_ENTRY_POINT(GetPresContext(), Reflow); + nsViewManager::AutoDisableRefresh refreshBlocker(viewManager); + + mDirtyRoots.RemoveElement(rootFrame); + DoReflow(rootFrame, true); + } + + DidDoReflow(true); + } + } + + rootFrame = mFrameConstructor->GetRootFrame(); + if (rootFrame) { + wm = rootFrame->GetWritingMode(); + if (wm.IsVertical()) { + if (aWidth == NS_UNCONSTRAINEDSIZE) { + mPresContext->SetVisibleArea( + nsRect(0, 0, rootFrame->GetRect().width, aHeight)); + } + } else { + if (aHeight == NS_UNCONSTRAINEDSIZE) { + mPresContext->SetVisibleArea( + nsRect(0, 0, aWidth, rootFrame->GetRect().height)); + } + } + } + + if (!mIsDestroying && !mResizeEvent.IsPending() && + !mAsyncResizeTimerIsActive) { + if (mInResize) { + if (!mAsyncResizeEventTimer) { + mAsyncResizeEventTimer = do_CreateInstance("@mozilla.org/timer;1"); + } + if (mAsyncResizeEventTimer) { + mAsyncResizeTimerIsActive = true; + mAsyncResizeEventTimer->InitWithFuncCallback(AsyncResizeEventCallback, + this, 15, + nsITimer::TYPE_ONE_SHOT); + } + } else { + RefPtr > resizeEvent = + NewRunnableMethod(this, &PresShell::FireResizeEvent); + if (NS_SUCCEEDED(NS_DispatchToCurrentThread(resizeEvent))) { + mResizeEvent = resizeEvent; + mDocument->SetNeedStyleFlush(); + } + } + } + + return NS_OK; //XXX this needs to be real. MMP +} + +void +PresShell::FireResizeEvent() +{ + if (mAsyncResizeTimerIsActive) { + mAsyncResizeTimerIsActive = false; + mAsyncResizeEventTimer->Cancel(); + } + mResizeEvent.Revoke(); + + if (mIsDocumentGone) + return; + + //Send resize event from here. + WidgetEvent event(true, mozilla::eResize); + nsEventStatus status = nsEventStatus_eIgnore; + + if (nsPIDOMWindowOuter* window = mDocument->GetWindow()) { + nsCOMPtr kungFuDeathGrip(this); + mInResize = true; + EventDispatcher::Dispatch(window, mPresContext, &event, nullptr, &status); + mInResize = false; + } +} + +void +PresShell::SetIgnoreFrameDestruction(bool aIgnore) +{ + if (mDocument) { + // We need to tell the ImageLoader to drop all its references to frames + // because they're about to go away and it won't get notifications of that. + mDocument->StyleImageLoader()->ClearFrames(mPresContext); + } + mIgnoreFrameDestruction = aIgnore; +} + +void +PresShell::NotifyDestroyingFrame(nsIFrame* aFrame) +{ + if (!mIgnoreFrameDestruction) { + mDocument->StyleImageLoader()->DropRequestsForFrame(aFrame); + + mFrameConstructor->NotifyDestroyingFrame(aFrame); + + for (int32_t idx = mDirtyRoots.Length(); idx; ) { + --idx; + if (mDirtyRoots[idx] == aFrame) { + mDirtyRoots.RemoveElementAt(idx); + } + } + + // Remove frame properties + mPresContext->NotifyDestroyingFrame(aFrame); + + if (aFrame == mCurrentEventFrame) { + mCurrentEventContent = aFrame->GetContent(); + mCurrentEventFrame = nullptr; + } + + #ifdef DEBUG + if (aFrame == mDrawEventTargetFrame) { + mDrawEventTargetFrame = nullptr; + } + #endif + + for (unsigned int i=0; i < mCurrentEventFrameStack.Length(); i++) { + if (aFrame == mCurrentEventFrameStack.ElementAt(i)) { + //One of our stack frames was deleted. Get its content so that when we + //pop it we can still get its new frame from its content + nsIContent *currentEventContent = aFrame->GetContent(); + mCurrentEventContentStack.ReplaceObjectAt(currentEventContent, i); + mCurrentEventFrameStack[i] = nullptr; + } + } + + mFramesToDirty.RemoveEntry(aFrame); + } else { + // We must delete this property in situ so that its destructor removes the + // frame from FrameLayerBuilder::DisplayItemData::mFrameList -- otherwise + // the DisplayItemData destructor will use the destroyed frame when it + // tries to remove it from the (array) value of this property. + mPresContext->PropertyTable()-> + Delete(aFrame, FrameLayerBuilder::LayerManagerDataProperty()); + } +} + +already_AddRefed PresShell::GetCaret() const +{ + RefPtr caret = mCaret; + return caret.forget(); +} + +already_AddRefed PresShell::GetAccessibleCaretEventHub() const +{ + RefPtr eventHub = mAccessibleCaretEventHub; + return eventHub.forget(); +} + +void PresShell::SetCaret(nsCaret *aNewCaret) +{ + mCaret = aNewCaret; +} + +void PresShell::RestoreCaret() +{ + mCaret = mOriginalCaret; +} + +NS_IMETHODIMP PresShell::SetCaretEnabled(bool aInEnable) +{ + bool oldEnabled = mCaretEnabled; + + mCaretEnabled = aInEnable; + + if (mCaretEnabled != oldEnabled) + { + MOZ_ASSERT(mCaret); + if (mCaret) { + mCaret->SetVisible(mCaretEnabled); + } + } + + return NS_OK; +} + +NS_IMETHODIMP PresShell::SetCaretReadOnly(bool aReadOnly) +{ + if (mCaret) + mCaret->SetCaretReadOnly(aReadOnly); + return NS_OK; +} + +NS_IMETHODIMP PresShell::GetCaretEnabled(bool *aOutEnabled) +{ + NS_ENSURE_ARG_POINTER(aOutEnabled); + *aOutEnabled = mCaretEnabled; + return NS_OK; +} + +NS_IMETHODIMP PresShell::SetCaretVisibilityDuringSelection(bool aVisibility) +{ + if (mCaret) + mCaret->SetVisibilityDuringSelection(aVisibility); + return NS_OK; +} + +NS_IMETHODIMP PresShell::GetCaretVisible(bool *aOutIsVisible) +{ + *aOutIsVisible = false; + if (mCaret) { + *aOutIsVisible = mCaret->IsVisible(); + } + return NS_OK; +} + +NS_IMETHODIMP PresShell::SetSelectionFlags(int16_t aInEnable) +{ + mSelectionFlags = aInEnable; + return NS_OK; +} + +NS_IMETHODIMP PresShell::GetSelectionFlags(int16_t *aOutEnable) +{ + if (!aOutEnable) + return NS_ERROR_INVALID_ARG; + *aOutEnable = mSelectionFlags; + return NS_OK; +} + +//implementation of nsISelectionController + +NS_IMETHODIMP +PresShell::PhysicalMove(int16_t aDirection, int16_t aAmount, bool aExtend) +{ + RefPtr frameSelection = mSelection; + return frameSelection->PhysicalMove(aDirection, aAmount, aExtend); +} + +NS_IMETHODIMP +PresShell::CharacterMove(bool aForward, bool aExtend) +{ + RefPtr frameSelection = mSelection; + return frameSelection->CharacterMove(aForward, aExtend); +} + +NS_IMETHODIMP +PresShell::CharacterExtendForDelete() +{ + RefPtr frameSelection = mSelection; + return frameSelection->CharacterExtendForDelete(); +} + +NS_IMETHODIMP +PresShell::CharacterExtendForBackspace() +{ + RefPtr frameSelection = mSelection; + return frameSelection->CharacterExtendForBackspace(); +} + +NS_IMETHODIMP +PresShell::WordMove(bool aForward, bool aExtend) +{ + RefPtr frameSelection = mSelection; + nsresult result = frameSelection->WordMove(aForward, aExtend); +// if we can't go down/up any more we must then move caret completely to +// end/beginning respectively. + if (NS_FAILED(result)) + result = CompleteMove(aForward, aExtend); + return result; +} + +NS_IMETHODIMP +PresShell::WordExtendForDelete(bool aForward) +{ + RefPtr frameSelection = mSelection; + return frameSelection->WordExtendForDelete(aForward); +} + +NS_IMETHODIMP +PresShell::LineMove(bool aForward, bool aExtend) +{ + RefPtr frameSelection = mSelection; + nsresult result = frameSelection->LineMove(aForward, aExtend); +// if we can't go down/up any more we must then move caret completely to +// end/beginning respectively. + if (NS_FAILED(result)) + result = CompleteMove(aForward,aExtend); + return result; +} + +NS_IMETHODIMP +PresShell::IntraLineMove(bool aForward, bool aExtend) +{ + RefPtr frameSelection = mSelection; + return frameSelection->IntraLineMove(aForward, aExtend); +} + + + +NS_IMETHODIMP +PresShell::PageMove(bool aForward, bool aExtend) +{ + nsIScrollableFrame *scrollableFrame = + GetFrameToScrollAsScrollable(nsIPresShell::eVertical); + if (!scrollableFrame) + return NS_OK; + + RefPtr frameSelection = mSelection; + frameSelection->CommonPageMove(aForward, aExtend, scrollableFrame); + // After ScrollSelectionIntoView(), the pending notifications might be + // flushed and PresShell/PresContext/Frames may be dead. See bug 418470. + return ScrollSelectionIntoView(nsISelectionController::SELECTION_NORMAL, + nsISelectionController::SELECTION_FOCUS_REGION, + nsISelectionController::SCROLL_SYNCHRONOUS | + nsISelectionController::SCROLL_FOR_CARET_MOVE); +} + + + +NS_IMETHODIMP +PresShell::ScrollPage(bool aForward) +{ + nsIScrollableFrame* scrollFrame = + GetFrameToScrollAsScrollable(nsIPresShell::eVertical); + if (scrollFrame) { + mozilla::Telemetry::Accumulate(mozilla::Telemetry::SCROLL_INPUT_METHODS, + (uint32_t) ScrollInputMethod::MainThreadScrollPage); + scrollFrame->ScrollBy(nsIntPoint(0, aForward ? 1 : -1), + nsIScrollableFrame::PAGES, + nsIScrollableFrame::SMOOTH, + nullptr, nullptr, + nsIScrollableFrame::NOT_MOMENTUM, + nsIScrollableFrame::ENABLE_SNAP); + } + return NS_OK; +} + +NS_IMETHODIMP +PresShell::ScrollLine(bool aForward) +{ + nsIScrollableFrame* scrollFrame = + GetFrameToScrollAsScrollable(nsIPresShell::eVertical); + if (scrollFrame) { + mozilla::Telemetry::Accumulate(mozilla::Telemetry::SCROLL_INPUT_METHODS, + (uint32_t) ScrollInputMethod::MainThreadScrollLine); + + int32_t lineCount = Preferences::GetInt("toolkit.scrollbox.verticalScrollDistance", + NS_DEFAULT_VERTICAL_SCROLL_DISTANCE); + scrollFrame->ScrollBy(nsIntPoint(0, aForward ? lineCount : -lineCount), + nsIScrollableFrame::LINES, + nsIScrollableFrame::SMOOTH, + nullptr, nullptr, + nsIScrollableFrame::NOT_MOMENTUM, + nsIScrollableFrame::ENABLE_SNAP); + } + return NS_OK; +} + +NS_IMETHODIMP +PresShell::ScrollCharacter(bool aRight) +{ + nsIScrollableFrame* scrollFrame = + GetFrameToScrollAsScrollable(nsIPresShell::eHorizontal); + if (scrollFrame) { + mozilla::Telemetry::Accumulate(mozilla::Telemetry::SCROLL_INPUT_METHODS, + (uint32_t) ScrollInputMethod::MainThreadScrollCharacter); + int32_t h = Preferences::GetInt("toolkit.scrollbox.horizontalScrollDistance", + NS_DEFAULT_HORIZONTAL_SCROLL_DISTANCE); + scrollFrame->ScrollBy(nsIntPoint(aRight ? h : -h, 0), + nsIScrollableFrame::LINES, + nsIScrollableFrame::SMOOTH, + nullptr, nullptr, + nsIScrollableFrame::NOT_MOMENTUM, + nsIScrollableFrame::ENABLE_SNAP); + } + return NS_OK; +} + +NS_IMETHODIMP +PresShell::CompleteScroll(bool aForward) +{ + nsIScrollableFrame* scrollFrame = + GetFrameToScrollAsScrollable(nsIPresShell::eVertical); + if (scrollFrame) { + mozilla::Telemetry::Accumulate(mozilla::Telemetry::SCROLL_INPUT_METHODS, + (uint32_t) ScrollInputMethod::MainThreadCompleteScroll); + scrollFrame->ScrollBy(nsIntPoint(0, aForward ? 1 : -1), + nsIScrollableFrame::WHOLE, + nsIScrollableFrame::SMOOTH, + nullptr, nullptr, + nsIScrollableFrame::NOT_MOMENTUM, + nsIScrollableFrame::ENABLE_SNAP); + } + return NS_OK; +} + +NS_IMETHODIMP +PresShell::CompleteMove(bool aForward, bool aExtend) +{ + // Beware! This may flush notifications via synchronous + // ScrollSelectionIntoView. + RefPtr frameSelection = mSelection; + nsIContent* limiter = frameSelection->GetAncestorLimiter(); + nsIFrame* frame = limiter ? limiter->GetPrimaryFrame() + : FrameConstructor()->GetRootElementFrame(); + if (!frame) + return NS_ERROR_FAILURE; + nsIFrame::CaretPosition pos = + frame->GetExtremeCaretPosition(!aForward); + frameSelection->HandleClick(pos.mResultContent, pos.mContentOffset, + pos.mContentOffset, aExtend, false, + aForward ? CARET_ASSOCIATE_AFTER : + CARET_ASSOCIATE_BEFORE); + if (limiter) { + // HandleClick resets ancestorLimiter, so set it again. + frameSelection->SetAncestorLimiter(limiter); + } + + // After ScrollSelectionIntoView(), the pending notifications might be + // flushed and PresShell/PresContext/Frames may be dead. See bug 418470. + return ScrollSelectionIntoView(nsISelectionController::SELECTION_NORMAL, + nsISelectionController::SELECTION_FOCUS_REGION, + nsISelectionController::SCROLL_SYNCHRONOUS | + nsISelectionController::SCROLL_FOR_CARET_MOVE); +} + +NS_IMETHODIMP +PresShell::SelectAll() +{ + RefPtr frameSelection = mSelection; + return frameSelection->SelectAll(); +} + +static void +DoCheckVisibility(nsPresContext* aPresContext, + nsIContent* aNode, + int16_t aStartOffset, + int16_t aEndOffset, + bool* aRetval) +{ + nsIFrame* frame = aNode->GetPrimaryFrame(); + if (!frame) { + // No frame to look at so it must not be visible. + return; + } + + // Start process now to go through all frames to find startOffset. Then check + // chars after that to see if anything until EndOffset is visible. + bool finished = false; + frame->CheckVisibility(aPresContext, aStartOffset, aEndOffset, true, + &finished, aRetval); + // Don't worry about other return value. +} + +NS_IMETHODIMP +PresShell::CheckVisibility(nsIDOMNode *node, int16_t startOffset, int16_t EndOffset, bool *_retval) +{ + if (!node || startOffset>EndOffset || !_retval || startOffset<0 || EndOffset<0) + return NS_ERROR_INVALID_ARG; + *_retval = false; //initialize return parameter + nsCOMPtr content(do_QueryInterface(node)); + if (!content) + return NS_ERROR_FAILURE; + + DoCheckVisibility(mPresContext, content, startOffset, EndOffset, _retval); + return NS_OK; +} + +nsresult +PresShell::CheckVisibilityContent(nsIContent* aNode, int16_t aStartOffset, + int16_t aEndOffset, bool* aRetval) +{ + if (!aNode || aStartOffset > aEndOffset || !aRetval || + aStartOffset < 0 || aEndOffset < 0) { + return NS_ERROR_INVALID_ARG; + } + + *aRetval = false; + DoCheckVisibility(mPresContext, aNode, aStartOffset, aEndOffset, aRetval); + return NS_OK; +} + +//end implementations nsISelectionController + +nsIFrame* +nsIPresShell::GetRootFrameExternal() const +{ + return mFrameConstructor->GetRootFrame(); +} + +nsIFrame* +nsIPresShell::GetRootScrollFrame() const +{ + nsIFrame* rootFrame = mFrameConstructor->GetRootFrame(); + // Ensure root frame is a viewport frame + if (!rootFrame || nsGkAtoms::viewportFrame != rootFrame->GetType()) + return nullptr; + nsIFrame* theFrame = rootFrame->PrincipalChildList().FirstChild(); + if (!theFrame || nsGkAtoms::scrollFrame != theFrame->GetType()) + return nullptr; + return theFrame; +} + +nsIScrollableFrame* +nsIPresShell::GetRootScrollFrameAsScrollable() const +{ + nsIFrame* frame = GetRootScrollFrame(); + if (!frame) + return nullptr; + nsIScrollableFrame* scrollableFrame = do_QueryFrame(frame); + NS_ASSERTION(scrollableFrame, + "All scroll frames must implement nsIScrollableFrame"); + return scrollableFrame; +} + +nsIScrollableFrame* +nsIPresShell::GetRootScrollFrameAsScrollableExternal() const +{ + return GetRootScrollFrameAsScrollable(); +} + +nsIPageSequenceFrame* +PresShell::GetPageSequenceFrame() const +{ + nsIFrame* frame = mFrameConstructor->GetPageSequenceFrame(); + return do_QueryFrame(frame); +} + +nsCanvasFrame* +PresShell::GetCanvasFrame() const +{ + nsIFrame* frame = mFrameConstructor->GetDocElementContainingBlock(); + return do_QueryFrame(frame); +} + +void +PresShell::BeginUpdate(nsIDocument *aDocument, nsUpdateType aUpdateType) +{ +#ifdef DEBUG + mUpdateCount++; +#endif + mFrameConstructor->BeginUpdate(); + + if (aUpdateType & UPDATE_STYLE) + mStyleSet->BeginUpdate(); +} + +void +PresShell::EndUpdate(nsIDocument *aDocument, nsUpdateType aUpdateType) +{ +#ifdef DEBUG + NS_PRECONDITION(0 != mUpdateCount, "too many EndUpdate's"); + --mUpdateCount; +#endif + + if (aUpdateType & UPDATE_STYLE) { + mStyleSet->EndUpdate(); + if (mStylesHaveChanged || !mChangedScopeStyleRoots.IsEmpty()) + RestyleForCSSRuleChanges(); + } + + mFrameConstructor->EndUpdate(); +} + +void +PresShell::RestoreRootScrollPosition() +{ + nsIScrollableFrame* scrollableFrame = GetRootScrollFrameAsScrollable(); + if (scrollableFrame) { + scrollableFrame->ScrollToRestoredPosition(); + } +} + +void +PresShell::MaybeReleaseCapturingContent() +{ + RefPtr frameSelection = FrameSelection(); + if (frameSelection) { + frameSelection->SetDragState(false); + } + if (gCaptureInfo.mContent && + gCaptureInfo.mContent->OwnerDoc() == mDocument) { + SetCapturingContent(nullptr, 0); + } +} + +void +PresShell::BeginLoad(nsIDocument *aDocument) +{ + mDocumentLoading = true; + + gfxTextPerfMetrics *tp = nullptr; + if (mPresContext) { + tp = mPresContext->GetTextPerfMetrics(); + } + + bool shouldLog = MOZ_LOG_TEST(gLog, LogLevel::Debug); + if (shouldLog || tp) { + mLoadBegin = TimeStamp::Now(); + } + + if (shouldLog) { + nsIURI* uri = mDocument->GetDocumentURI(); + MOZ_LOG(gLog, LogLevel::Debug, + ("(presshell) %p load begin [%s]\n", + this, uri ? uri->GetSpecOrDefault().get() : "")); + } +} + +void +PresShell::EndLoad(nsIDocument *aDocument) +{ + NS_PRECONDITION(aDocument == mDocument, "Wrong document"); + + RestoreRootScrollPosition(); + + mDocumentLoading = false; +} + +void +PresShell::LoadComplete() +{ + gfxTextPerfMetrics *tp = nullptr; + if (mPresContext) { + tp = mPresContext->GetTextPerfMetrics(); + } + + // log load + bool shouldLog = MOZ_LOG_TEST(gLog, LogLevel::Debug); + if (shouldLog || tp) { + TimeDuration loadTime = TimeStamp::Now() - mLoadBegin; + nsIURI* uri = mDocument->GetDocumentURI(); + nsAutoCString spec; + if (uri) { + spec = uri->GetSpecOrDefault(); + } + if (shouldLog) { + MOZ_LOG(gLog, LogLevel::Debug, + ("(presshell) %p load done time-ms: %9.2f [%s]\n", + this, loadTime.ToMilliseconds(), spec.get())); + } + if (tp) { + tp->Accumulate(); + if (tp->cumulative.numChars > 0) { + LogTextPerfStats(tp, this, tp->cumulative, loadTime.ToMilliseconds(), + eLog_loaddone, spec.get()); + } + } + } +} + +#ifdef DEBUG +void +PresShell::VerifyHasDirtyRootAncestor(nsIFrame* aFrame) +{ + // XXXbz due to bug 372769, can't actually assert anything here... + return; + + // XXXbz shouldn't need this part; remove it once FrameNeedsReflow + // handles the root frame correctly. + if (!aFrame->GetParent()) { + return; + } + + // Make sure that there is a reflow root ancestor of |aFrame| that's + // in mDirtyRoots already. + while (aFrame && (aFrame->GetStateBits() & NS_FRAME_HAS_DIRTY_CHILDREN)) { + if (((aFrame->GetStateBits() & NS_FRAME_REFLOW_ROOT) || + !aFrame->GetParent()) && + mDirtyRoots.Contains(aFrame)) { + return; + } + + aFrame = aFrame->GetParent(); + } + NS_NOTREACHED("Frame has dirty bits set but isn't scheduled to be " + "reflowed?"); +} +#endif + +void +PresShell::FrameNeedsReflow(nsIFrame *aFrame, IntrinsicDirty aIntrinsicDirty, + nsFrameState aBitToAdd, + ReflowRootHandling aRootHandling) +{ + NS_PRECONDITION(aBitToAdd == NS_FRAME_IS_DIRTY || + aBitToAdd == NS_FRAME_HAS_DIRTY_CHILDREN || + !aBitToAdd, + "Unexpected bits being added"); + NS_PRECONDITION(!(aIntrinsicDirty == eStyleChange && + aBitToAdd == NS_FRAME_HAS_DIRTY_CHILDREN), + "bits don't correspond to style change reason"); + + NS_ASSERTION(!mIsReflowing, "can't mark frame dirty during reflow"); + + // If we've not yet done the initial reflow, then don't bother + // enqueuing a reflow command yet. + if (! mDidInitialize) + return; + + // If we're already destroying, don't bother with this either. + if (mIsDestroying) + return; + +#ifdef DEBUG + //printf("gShellCounter: %d\n", gShellCounter++); + if (mInVerifyReflow) + return; + + if (VERIFY_REFLOW_NOISY_RC & gVerifyReflowFlags) { + printf("\nPresShell@%p: frame %p needs reflow\n", (void*)this, (void*)aFrame); + if (VERIFY_REFLOW_REALLY_NOISY_RC & gVerifyReflowFlags) { + printf("Current content model:\n"); + Element *rootElement = mDocument->GetRootElement(); + if (rootElement) { + rootElement->List(stdout, 0); + } + } + } +#endif + + AutoTArray subtrees; + subtrees.AppendElement(aFrame); + + do { + nsIFrame *subtreeRoot = subtrees.ElementAt(subtrees.Length() - 1); + subtrees.RemoveElementAt(subtrees.Length() - 1); + + // Grab |wasDirty| now so we can go ahead and update the bits on + // subtreeRoot. + bool wasDirty = NS_SUBTREE_DIRTY(subtreeRoot); + subtreeRoot->AddStateBits(aBitToAdd); + + // Determine whether we need to keep looking for the next ancestor + // reflow root if subtreeRoot itself is a reflow root. + bool targetNeedsReflowFromParent; + switch (aRootHandling) { + case ePositionOrSizeChange: + targetNeedsReflowFromParent = true; + break; + case eNoPositionOrSizeChange: + targetNeedsReflowFromParent = false; + break; + case eInferFromBitToAdd: + targetNeedsReflowFromParent = (aBitToAdd == NS_FRAME_IS_DIRTY); + break; + } + +#define FRAME_IS_REFLOW_ROOT(_f) \ + ((_f->GetStateBits() & NS_FRAME_REFLOW_ROOT) && \ + (_f != subtreeRoot || !targetNeedsReflowFromParent)) + + + // Mark the intrinsic widths as dirty on the frame, all of its ancestors, + // and all of its descendants, if needed: + + if (aIntrinsicDirty != nsIPresShell::eResize) { + // Mark argument and all ancestors dirty. (Unless we hit a reflow + // root that should contain the reflow. That root could be + // subtreeRoot itself if it's not dirty, or it could be some + // ancestor of subtreeRoot.) + for (nsIFrame *a = subtreeRoot; + a && !FRAME_IS_REFLOW_ROOT(a); + a = a->GetParent()) + a->MarkIntrinsicISizesDirty(); + } + + if (aIntrinsicDirty == eStyleChange) { + // Mark all descendants dirty (using an nsTArray stack rather than + // recursion). + // Note that ReflowInput::InitResizeFlags has some similar + // code; see comments there for how and why it differs. + AutoTArray stack; + stack.AppendElement(subtreeRoot); + + do { + nsIFrame *f = stack.ElementAt(stack.Length() - 1); + stack.RemoveElementAt(stack.Length() - 1); + + if (f->GetType() == nsGkAtoms::placeholderFrame) { + nsIFrame *oof = nsPlaceholderFrame::GetRealFrameForPlaceholder(f); + if (!nsLayoutUtils::IsProperAncestorFrame(subtreeRoot, oof)) { + // We have another distinct subtree we need to mark. + subtrees.AppendElement(oof); + } + } + + nsIFrame::ChildListIterator lists(f); + for (; !lists.IsDone(); lists.Next()) { + for (nsIFrame* kid : lists.CurrentList()) { + kid->MarkIntrinsicISizesDirty(); + stack.AppendElement(kid); + } + } + } while (stack.Length() != 0); + } + + // Skip setting dirty bits up the tree if we weren't given a bit to add. + if (!aBitToAdd) { + continue; + } + + // Set NS_FRAME_HAS_DIRTY_CHILDREN bits (via nsIFrame::ChildIsDirty) + // up the tree until we reach either a frame that's already dirty or + // a reflow root. + nsIFrame *f = subtreeRoot; + for (;;) { + if (FRAME_IS_REFLOW_ROOT(f) || !f->GetParent()) { + // we've hit a reflow root or the root frame + if (!wasDirty) { + mDirtyRoots.AppendElement(f); + mDocument->SetNeedLayoutFlush(); + } +#ifdef DEBUG + else { + VerifyHasDirtyRootAncestor(f); + } +#endif + + break; + } + + nsIFrame *child = f; + f = f->GetParent(); + wasDirty = NS_SUBTREE_DIRTY(f); + f->ChildIsDirty(child); + NS_ASSERTION(f->GetStateBits() & NS_FRAME_HAS_DIRTY_CHILDREN, + "ChildIsDirty didn't do its job"); + if (wasDirty) { + // This frame was already marked dirty. +#ifdef DEBUG + VerifyHasDirtyRootAncestor(f); +#endif + break; + } + } + } while (subtrees.Length() != 0); + + MaybeScheduleReflow(); +} + +void +PresShell::FrameNeedsToContinueReflow(nsIFrame *aFrame) +{ + NS_ASSERTION(mIsReflowing, "Must be in reflow when marking path dirty."); + NS_PRECONDITION(mCurrentReflowRoot, "Must have a current reflow root here"); + NS_ASSERTION(aFrame == mCurrentReflowRoot || + nsLayoutUtils::IsProperAncestorFrame(mCurrentReflowRoot, aFrame), + "Frame passed in is not the descendant of mCurrentReflowRoot"); + NS_ASSERTION(aFrame->GetStateBits() & NS_FRAME_IN_REFLOW, + "Frame passed in not in reflow?"); + + mFramesToDirty.PutEntry(aFrame); +} + +nsIScrollableFrame* +nsIPresShell::GetFrameToScrollAsScrollable( + nsIPresShell::ScrollDirection aDirection) +{ + nsIScrollableFrame* scrollFrame = nullptr; + + nsCOMPtr focusedContent; + nsIFocusManager* fm = nsFocusManager::GetFocusManager(); + if (fm && mDocument) { + nsCOMPtr focusedElement; + fm->GetFocusedElementForWindow(mDocument->GetWindow(), false, nullptr, + getter_AddRefs(focusedElement)); + focusedContent = do_QueryInterface(focusedElement); + } + if (!focusedContent && mSelection) { + nsISelection* domSelection = + mSelection->GetSelection(SelectionType::eNormal); + if (domSelection) { + nsCOMPtr focusedNode; + domSelection->GetFocusNode(getter_AddRefs(focusedNode)); + focusedContent = do_QueryInterface(focusedNode); + } + } + if (focusedContent) { + nsIFrame* startFrame = focusedContent->GetPrimaryFrame(); + if (startFrame) { + scrollFrame = startFrame->GetScrollTargetFrame(); + if (scrollFrame) { + startFrame = scrollFrame->GetScrolledFrame(); + } + if (aDirection == nsIPresShell::eEither) { + scrollFrame = + nsLayoutUtils::GetNearestScrollableFrame(startFrame); + } else { + scrollFrame = + nsLayoutUtils::GetNearestScrollableFrameForDirection(startFrame, + aDirection == eVertical ? nsLayoutUtils::eVertical : + nsLayoutUtils::eHorizontal); + } + } + } + if (!scrollFrame) { + scrollFrame = GetRootScrollFrameAsScrollable(); + } + return scrollFrame; +} + +void +PresShell::CancelAllPendingReflows() +{ + mDirtyRoots.Clear(); + + if (mReflowScheduled) { + GetPresContext()->RefreshDriver()->RemoveLayoutFlushObserver(this); + mReflowScheduled = false; + } + + ASSERT_REFLOW_SCHEDULED_STATE(); +} + +void +PresShell::DestroyFramesFor(nsIContent* aContent, + nsIContent** aDestroyedFramesFor) +{ + MOZ_ASSERT(aContent); + NS_ENSURE_TRUE_VOID(mPresContext); + if (!mDidInitialize) { + return; + } + + nsAutoScriptBlocker scriptBlocker; + + // Mark ourselves as not safe to flush while we're doing frame destruction. + ++mChangeNestCount; + + nsCSSFrameConstructor* fc = FrameConstructor(); + fc->BeginUpdate(); + fc->DestroyFramesFor(aContent, aDestroyedFramesFor); + fc->EndUpdate(); + + --mChangeNestCount; +} + +void +PresShell::CreateFramesFor(nsIContent* aContent) +{ + NS_ENSURE_TRUE_VOID(mPresContext); + if (!mDidInitialize) { + // Nothing to do here. In fact, if we proceed and aContent is the + // root we will crash. + return; + } + + // Don't call RecreateFramesForContent since that is not exported and we want + // to keep the number of entrypoints down. + + NS_ASSERTION(mViewManager, "Should have view manager"); + MOZ_ASSERT(aContent); + + // Have to make sure that the content notifications are flushed before we + // start messing with the frame model; otherwise we can get content doubling. + mDocument->FlushPendingNotifications(Flush_ContentAndNotify); + + nsAutoScriptBlocker scriptBlocker; + + // Mark ourselves as not safe to flush while we're doing frame construction. + ++mChangeNestCount; + + nsCSSFrameConstructor* fc = FrameConstructor(); + nsILayoutHistoryState* layoutState = fc->GetLastCapturedLayoutHistoryState(); + fc->BeginUpdate(); + fc->ContentInserted(aContent->GetParent(), aContent, layoutState, false); + fc->EndUpdate(); + + --mChangeNestCount; +} + +nsresult +PresShell::RecreateFramesFor(nsIContent* aContent) +{ + NS_ENSURE_TRUE(mPresContext, NS_ERROR_FAILURE); + if (!mDidInitialize) { + // Nothing to do here. In fact, if we proceed and aContent is the + // root we will crash. + return NS_OK; + } + + // Don't call RecreateFramesForContent since that is not exported and we want + // to keep the number of entrypoints down. + + NS_ASSERTION(mViewManager, "Should have view manager"); + + // Have to make sure that the content notifications are flushed before we + // start messing with the frame model; otherwise we can get content doubling. + mDocument->FlushPendingNotifications(Flush_ContentAndNotify); + + nsAutoScriptBlocker scriptBlocker; + + nsStyleChangeList changeList; + changeList.AppendChange(nullptr, aContent, nsChangeHint_ReconstructFrame); + + // Mark ourselves as not safe to flush while we're doing frame construction. + ++mChangeNestCount; + RestyleManagerHandle restyleManager = mPresContext->RestyleManager(); + nsresult rv = restyleManager->ProcessRestyledFrames(changeList); + restyleManager->FlushOverflowChangedTracker(); + --mChangeNestCount; + + return rv; +} + +void +nsIPresShell::PostRecreateFramesFor(Element* aElement) +{ + mPresContext->RestyleManager()->PostRestyleEvent(aElement, nsRestyleHint(0), + nsChangeHint_ReconstructFrame); +} + +void +nsIPresShell::RestyleForAnimation(Element* aElement, nsRestyleHint aHint) +{ + // Now that we no longer have separate non-animation and animation + // restyles, this method having a distinct identity is less important, + // but it still seems useful to offer as a "more public" API and as a + // chokepoint for these restyles to go through. + mPresContext->RestyleManager()->PostRestyleEvent(aElement, aHint, + nsChangeHint(0)); +} + +void +nsIPresShell::SetForwardingContainer(const WeakPtr &aContainer) +{ + mForwardingContainer = aContainer; +} + +void +PresShell::ClearFrameRefs(nsIFrame* aFrame) +{ + mPresContext->EventStateManager()->ClearFrameRefs(aFrame); + + nsWeakFrame* weakFrame = mWeakFrames; + while (weakFrame) { + nsWeakFrame* prev = weakFrame->GetPreviousWeakFrame(); + if (weakFrame->GetFrame() == aFrame) { + // This removes weakFrame from mWeakFrames. + weakFrame->Clear(this); + } + weakFrame = prev; + } +} + +already_AddRefed +PresShell::CreateReferenceRenderingContext() +{ + nsDeviceContext* devCtx = mPresContext->DeviceContext(); + RefPtr rc; + if (mPresContext->IsScreen()) { + rc = gfxContext::CreateOrNull(gfxPlatform::GetPlatform()->ScreenReferenceDrawTarget()); + } else { + // We assume the devCtx has positive width and height for this call. + // However, width and height, may be outside of the reasonable range + // so rc may still be null. + rc = devCtx->CreateReferenceRenderingContext(); + } + + return rc ? rc.forget() : nullptr; +} + +nsresult +PresShell::GoToAnchor(const nsAString& aAnchorName, bool aScroll, + uint32_t aAdditionalScrollFlags) +{ + if (!mDocument) { + return NS_ERROR_FAILURE; + } + + const Element *root = mDocument->GetRootElement(); + if (root && root->IsSVGElement(nsGkAtoms::svg)) { + // We need to execute this even if there is an empty anchor name + // so that any existing SVG fragment identifier effect is removed + if (SVGFragmentIdentifier::ProcessFragmentIdentifier(mDocument, aAnchorName)) { + return NS_OK; + } + } + + // Hold a reference to the ESM in case event dispatch tears us down. + RefPtr esm = mPresContext->EventStateManager(); + + if (aAnchorName.IsEmpty()) { + NS_ASSERTION(!aScroll, "can't scroll to empty anchor name"); + esm->SetContentState(nullptr, NS_EVENT_STATE_URLTARGET); + return NS_OK; + } + + nsCOMPtr htmlDoc = do_QueryInterface(mDocument); + nsresult rv = NS_OK; + nsCOMPtr content; + + // Search for an element with a matching "id" attribute + if (mDocument) { + content = mDocument->GetElementById(aAnchorName); + } + + // Search for an anchor element with a matching "name" attribute + if (!content && htmlDoc) { + nsCOMPtr list; + // Find a matching list of named nodes + rv = htmlDoc->GetElementsByName(aAnchorName, getter_AddRefs(list)); + if (NS_SUCCEEDED(rv) && list) { + uint32_t i; + // Loop through the named nodes looking for the first anchor + for (i = 0; true; i++) { + nsCOMPtr node; + rv = list->Item(i, getter_AddRefs(node)); + if (!node) { // End of list + break; + } + // Ensure it's an anchor element + content = do_QueryInterface(node); + if (content) { + if (content->IsHTMLElement(nsGkAtoms::a)) { + break; + } + content = nullptr; + } + } + } + } + + // Search for anchor in the HTML namespace with a matching name + if (!content && !htmlDoc) + { + nsCOMPtr doc = do_QueryInterface(mDocument); + nsCOMPtr list; + NS_NAMED_LITERAL_STRING(nameSpace, "http://www.w3.org/1999/xhtml"); + // Get the list of anchor elements + rv = doc->GetElementsByTagNameNS(nameSpace, NS_LITERAL_STRING("a"), getter_AddRefs(list)); + if (NS_SUCCEEDED(rv) && list) { + uint32_t i; + // Loop through the named nodes looking for the first anchor + for (i = 0; true; i++) { + nsCOMPtr node; + rv = list->Item(i, getter_AddRefs(node)); + if (!node) { // End of list + break; + } + // Compare the name attribute + nsCOMPtr element = do_QueryInterface(node); + nsAutoString value; + if (element && NS_SUCCEEDED(element->GetAttribute(NS_LITERAL_STRING("name"), value))) { + if (value.Equals(aAnchorName)) { + content = do_QueryInterface(element); + break; + } + } + } + } + } + + esm->SetContentState(content, NS_EVENT_STATE_URLTARGET); + +#ifdef ACCESSIBILITY + nsIContent *anchorTarget = content; +#endif + + nsIScrollableFrame* rootScroll = GetRootScrollFrameAsScrollable(); + if (rootScroll && rootScroll->DidHistoryRestore()) { + // Scroll position restored from history trumps scrolling to anchor. + aScroll = false; + rootScroll->ClearDidHistoryRestore(); + } + + if (content) { + if (aScroll) { + rv = ScrollContentIntoView(content, + ScrollAxis(SCROLL_TOP, SCROLL_ALWAYS), + ScrollAxis(), + ANCHOR_SCROLL_FLAGS | aAdditionalScrollFlags); + NS_ENSURE_SUCCESS(rv, rv); + + nsIScrollableFrame* rootScroll = GetRootScrollFrameAsScrollable(); + if (rootScroll) { + mLastAnchorScrolledTo = content; + mLastAnchorScrollPositionY = rootScroll->GetScrollPosition().y; + } + } + + // Should we select the target? This action is controlled by a + // preference: the default is to not select. + bool selectAnchor = Preferences::GetBool("layout.selectanchor"); + + // Even if select anchor pref is false, we must still move the + // caret there. That way tabbing will start from the new + // location + RefPtr jumpToRange = new nsRange(mDocument); + while (content && content->GetFirstChild()) { + content = content->GetFirstChild(); + } + nsCOMPtr node(do_QueryInterface(content)); + NS_ASSERTION(node, "No nsIDOMNode for descendant of anchor"); + jumpToRange->SelectNodeContents(node); + // Select the anchor + RefPtr sel = mSelection->GetSelection(SelectionType::eNormal); + if (sel) { + sel->RemoveAllRanges(); + sel->AddRange(jumpToRange); + if (!selectAnchor) { + // Use a caret (collapsed selection) at the start of the anchor + sel->CollapseToStart(); + } + } + // Selection is at anchor. + // Now focus the document itself if focus is on an element within it. + nsPIDOMWindowOuter *win = mDocument->GetWindow(); + + nsIFocusManager* fm = nsFocusManager::GetFocusManager(); + if (fm && win) { + nsCOMPtr focusedWindow; + fm->GetFocusedWindow(getter_AddRefs(focusedWindow)); + if (SameCOMIdentity(win, focusedWindow)) { + fm->ClearFocus(focusedWindow); + } + } + + // If the target is an animation element, activate the animation + if (content->IsNodeOfType(nsINode::eANIMATION)) { + SVGContentUtils::ActivateByHyperlink(content.get()); + } + } else { + rv = NS_ERROR_FAILURE; + NS_NAMED_LITERAL_STRING(top, "top"); + if (nsContentUtils::EqualsIgnoreASCIICase(aAnchorName, top)) { + // Scroll to the top/left if aAnchorName is "top" and there is no element + // with such a name or id. + rv = NS_OK; + nsIScrollableFrame* sf = GetRootScrollFrameAsScrollable(); + // Check |aScroll| after setting |rv| so we set |rv| to the same + // thing whether or not |aScroll| is true. + if (aScroll && sf) { + // Scroll to the top of the page + sf->ScrollTo(nsPoint(0, 0), nsIScrollableFrame::INSTANT); + } + } + } + +#ifdef ACCESSIBILITY + if (anchorTarget) { + nsAccessibilityService* accService = AccService(); + if (accService) + accService->NotifyOfAnchorJumpTo(anchorTarget); + } +#endif + + return rv; +} + +nsresult +PresShell::ScrollToAnchor() +{ + if (!mLastAnchorScrolledTo) { + return NS_OK; + } + NS_ASSERTION(mDidInitialize, "should have done initial reflow by now"); + + nsIScrollableFrame* rootScroll = GetRootScrollFrameAsScrollable(); + if (!rootScroll || + mLastAnchorScrollPositionY != rootScroll->GetScrollPosition().y) { + return NS_OK; + } + nsresult rv = ScrollContentIntoView(mLastAnchorScrolledTo, + ScrollAxis(SCROLL_TOP, SCROLL_ALWAYS), + ScrollAxis(), + ANCHOR_SCROLL_FLAGS); + mLastAnchorScrolledTo = nullptr; + return rv; +} + +/* + * Helper (per-continuation) for ScrollContentIntoView. + * + * @param aContainerFrame [in] the frame which aRect is relative to + * @param aFrame [in] Frame whose bounds should be unioned + * @param aUseWholeLineHeightForInlines [in] if true, then for inline frames + * we should include the top of the line in the added rectangle + * @param aRect [inout] rect into which its bounds should be unioned + * @param aHaveRect [inout] whether aRect contains data yet + * @param aPrevBlock [inout] the block aLines is a line iterator for + * @param aLines [inout] the line iterator we're using + * @param aCurLine [inout] the line to start looking from in this iterator + */ +static void +AccumulateFrameBounds(nsIFrame* aContainerFrame, + nsIFrame* aFrame, + bool aUseWholeLineHeightForInlines, + nsRect& aRect, + bool& aHaveRect, + nsIFrame*& aPrevBlock, + nsAutoLineIterator& aLines, + int32_t& aCurLine) +{ + nsIFrame* frame = aFrame; + nsRect frameBounds = nsRect(nsPoint(0, 0), aFrame->GetSize()); + + // If this is an inline frame and either the bounds height is 0 (quirks + // layout model) or aUseWholeLineHeightForInlines is set, we need to + // change the top of the bounds to include the whole line. + if (frameBounds.height == 0 || aUseWholeLineHeightForInlines) { + nsIFrame *prevFrame = aFrame; + nsIFrame *f = aFrame; + + while (f && f->IsFrameOfType(nsIFrame::eLineParticipant) && + !f->IsTransformed() && !f->IsAbsPosContainingBlock()) { + prevFrame = f; + f = prevFrame->GetParent(); + } + + if (f != aFrame && + f && + f->GetType() == nsGkAtoms::blockFrame) { + // find the line containing aFrame and increase the top of |offset|. + if (f != aPrevBlock) { + aLines = f->GetLineIterator(); + aPrevBlock = f; + aCurLine = 0; + } + if (aLines) { + int32_t index = aLines->FindLineContaining(prevFrame, aCurLine); + if (index >= 0) { + aCurLine = index; + nsIFrame *trash1; + int32_t trash2; + nsRect lineBounds; + + if (NS_SUCCEEDED(aLines->GetLine(index, &trash1, &trash2, + lineBounds))) { + frameBounds += frame->GetOffsetTo(f); + frame = f; + if (lineBounds.y < frameBounds.y) { + frameBounds.height = frameBounds.YMost() - lineBounds.y; + frameBounds.y = lineBounds.y; + } + } + } + } + } + } + + nsRect transformedBounds = nsLayoutUtils::TransformFrameRectToAncestor(frame, + frameBounds, aContainerFrame); + + if (aHaveRect) { + // We can't use nsRect::UnionRect since it drops empty rects on + // the floor, and we need to include them. (Thus we need + // aHaveRect to know when to drop the initial value on the floor.) + aRect.UnionRectEdges(aRect, transformedBounds); + } else { + aHaveRect = true; + aRect = transformedBounds; + } +} + +static bool +ComputeNeedToScroll(nsIPresShell::WhenToScroll aWhenToScroll, + nscoord aLineSize, + nscoord aRectMin, + nscoord aRectMax, + nscoord aViewMin, + nscoord aViewMax) { + // See how the rect should be positioned vertically + if (nsIPresShell::SCROLL_ALWAYS == aWhenToScroll) { + // The caller wants the frame as visible as possible + return true; + } else if (nsIPresShell::SCROLL_IF_NOT_VISIBLE == aWhenToScroll) { + // Scroll only if no part of the frame is visible in this view + return aRectMax - aLineSize <= aViewMin || + aRectMin + aLineSize >= aViewMax; + } else if (nsIPresShell::SCROLL_IF_NOT_FULLY_VISIBLE == aWhenToScroll) { + // Scroll only if part of the frame is hidden and more can fit in view + return !(aRectMin >= aViewMin && aRectMax <= aViewMax) && + std::min(aViewMax, aRectMax) - std::max(aRectMin, aViewMin) < aViewMax - aViewMin; + } + return false; +} + +static nscoord +ComputeWhereToScroll(int16_t aWhereToScroll, + nscoord aOriginalCoord, + nscoord aRectMin, + nscoord aRectMax, + nscoord aViewMin, + nscoord aViewMax, + nscoord* aRangeMin, + nscoord* aRangeMax) { + nscoord resultCoord = aOriginalCoord; + // Allow the scroll operation to land anywhere that + // makes the whole rectangle visible. + if (nsIPresShell::SCROLL_MINIMUM == aWhereToScroll) { + if (aRectMin < aViewMin) { + // Scroll up so the frame's top edge is visible + resultCoord = aRectMin; + } else if (aRectMax > aViewMax) { + // Scroll down so the frame's bottom edge is visible. Make sure the + // frame's top edge is still visible + resultCoord = aOriginalCoord + aRectMax - aViewMax; + if (resultCoord > aRectMin) { + resultCoord = aRectMin; + } + } + } else { + nscoord frameAlignCoord = + NSToCoordRound(aRectMin + (aRectMax - aRectMin) * (aWhereToScroll / 100.0f)); + resultCoord = NSToCoordRound(frameAlignCoord - (aViewMax - aViewMin) * ( + aWhereToScroll / 100.0f)); + } + nscoord scrollPortLength = aViewMax - aViewMin; + // Force the scroll range to extend to include resultCoord. + *aRangeMin = std::min(resultCoord, aRectMax - scrollPortLength); + *aRangeMax = std::max(resultCoord, aRectMin); + return resultCoord; +} + +/** + * This function takes a scrollable frame, a rect in the coordinate system + * of the scrolled frame, and a desired percentage-based scroll + * position and attempts to scroll the rect to that position in the + * scrollport. + * + * This needs to work even if aRect has a width or height of zero. + */ +static void ScrollToShowRect(nsIScrollableFrame* aFrameAsScrollable, + const nsRect& aRect, + nsIPresShell::ScrollAxis aVertical, + nsIPresShell::ScrollAxis aHorizontal, + uint32_t aFlags) +{ + nsPoint scrollPt = aFrameAsScrollable->GetScrollPosition(); + nsRect visibleRect(scrollPt, + aFrameAsScrollable->GetScrollPositionClampingScrollPortSize()); + + nsSize lineSize; + // Don't call GetLineScrollAmount unless we actually need it. Not only + // does this save time, but it's not safe to call GetLineScrollAmount + // during reflow (because it depends on font size inflation and doesn't + // use the in-reflow-safe font-size inflation path). If we did call it, + // it would assert and possible give the wrong result. + if (aVertical.mWhenToScroll == nsIPresShell::SCROLL_IF_NOT_VISIBLE || + aHorizontal.mWhenToScroll == nsIPresShell::SCROLL_IF_NOT_VISIBLE) { + lineSize = aFrameAsScrollable->GetLineScrollAmount(); + } + ScrollbarStyles ss = aFrameAsScrollable->GetScrollbarStyles(); + nsRect allowedRange(scrollPt, nsSize(0, 0)); + bool needToScroll = false; + uint32_t directions = aFrameAsScrollable->GetPerceivedScrollingDirections(); + + if (((aFlags & nsIPresShell::SCROLL_OVERFLOW_HIDDEN) || + ss.mVertical != NS_STYLE_OVERFLOW_HIDDEN) && + (!aVertical.mOnlyIfPerceivedScrollableDirection || + (directions & nsIScrollableFrame::VERTICAL))) { + + if (ComputeNeedToScroll(aVertical.mWhenToScroll, + lineSize.height, + aRect.y, + aRect.YMost(), + visibleRect.y, + visibleRect.YMost())) { + nscoord maxHeight; + scrollPt.y = ComputeWhereToScroll(aVertical.mWhereToScroll, + scrollPt.y, + aRect.y, + aRect.YMost(), + visibleRect.y, + visibleRect.YMost(), + &allowedRange.y, &maxHeight); + allowedRange.height = maxHeight - allowedRange.y; + needToScroll = true; + } + } + + if (((aFlags & nsIPresShell::SCROLL_OVERFLOW_HIDDEN) || + ss.mHorizontal != NS_STYLE_OVERFLOW_HIDDEN) && + (!aHorizontal.mOnlyIfPerceivedScrollableDirection || + (directions & nsIScrollableFrame::HORIZONTAL))) { + + if (ComputeNeedToScroll(aHorizontal.mWhenToScroll, + lineSize.width, + aRect.x, + aRect.XMost(), + visibleRect.x, + visibleRect.XMost())) { + nscoord maxWidth; + scrollPt.x = ComputeWhereToScroll(aHorizontal.mWhereToScroll, + scrollPt.x, + aRect.x, + aRect.XMost(), + visibleRect.x, + visibleRect.XMost(), + &allowedRange.x, &maxWidth); + allowedRange.width = maxWidth - allowedRange.x; + needToScroll = true; + } + } + + // If we don't need to scroll, then don't try since it might cancel + // a current smooth scroll operation. + if (needToScroll) { + nsIScrollableFrame::ScrollMode scrollMode = nsIScrollableFrame::INSTANT; + bool autoBehaviorIsSmooth = (aFrameAsScrollable->GetScrollbarStyles().mScrollBehavior + == NS_STYLE_SCROLL_BEHAVIOR_SMOOTH); + bool smoothScroll = (aFlags & nsIPresShell::SCROLL_SMOOTH) || + ((aFlags & nsIPresShell::SCROLL_SMOOTH_AUTO) && autoBehaviorIsSmooth); + if (gfxPrefs::ScrollBehaviorEnabled() && smoothScroll) { + scrollMode = nsIScrollableFrame::SMOOTH_MSD; + } + aFrameAsScrollable->ScrollTo(scrollPt, scrollMode, &allowedRange); + } +} + +nsresult +PresShell::ScrollContentIntoView(nsIContent* aContent, + nsIPresShell::ScrollAxis aVertical, + nsIPresShell::ScrollAxis aHorizontal, + uint32_t aFlags) +{ + NS_ENSURE_TRUE(aContent, NS_ERROR_NULL_POINTER); + nsCOMPtr composedDoc = aContent->GetComposedDoc(); + NS_ENSURE_STATE(composedDoc); + + NS_ASSERTION(mDidInitialize, "should have done initial reflow by now"); + + if (mContentToScrollTo) { + mContentToScrollTo->DeleteProperty(nsGkAtoms::scrolling); + } + mContentToScrollTo = aContent; + ScrollIntoViewData* data = new ScrollIntoViewData(); + data->mContentScrollVAxis = aVertical; + data->mContentScrollHAxis = aHorizontal; + data->mContentToScrollToFlags = aFlags; + if (NS_FAILED(mContentToScrollTo->SetProperty(nsGkAtoms::scrolling, data, + nsINode::DeleteProperty))) { + mContentToScrollTo = nullptr; + } + + // Flush layout and attempt to scroll in the process. + composedDoc->SetNeedLayoutFlush(); + composedDoc->FlushPendingNotifications(Flush_InterruptibleLayout); + + // If mContentToScrollTo is non-null, that means we interrupted the reflow + // (or suppressed it altogether because we're suppressing interruptible + // flushes right now) and won't necessarily get the position correct, but do + // a best-effort scroll here. The other option would be to do this inside + // FlushPendingNotifications, but I'm not sure the repeated scrolling that + // could trigger if reflows keep getting interrupted would be more desirable + // than a single best-effort scroll followed by one final scroll on the first + // completed reflow. + if (mContentToScrollTo) { + DoScrollContentIntoView(); + } + return NS_OK; +} + +void +PresShell::DoScrollContentIntoView() +{ + NS_ASSERTION(mDidInitialize, "should have done initial reflow by now"); + + nsIFrame* frame = mContentToScrollTo->GetPrimaryFrame(); + if (!frame) { + mContentToScrollTo->DeleteProperty(nsGkAtoms::scrolling); + mContentToScrollTo = nullptr; + return; + } + + if (frame->GetStateBits() & NS_FRAME_FIRST_REFLOW) { + // The reflow flush before this scroll got interrupted, and this frame's + // coords and size are all zero, and it has no content showing anyway. + // Don't bother scrolling to it. We'll try again when we finish up layout. + return; + } + + // Make sure we skip 'frame' ... if it's scrollable, we should use its + // scrollable ancestor as the container. + nsIFrame* container = + nsLayoutUtils::GetClosestFrameOfType(frame->GetParent(), nsGkAtoms::scrollFrame); + if (!container) { + // nothing can be scrolled + return; + } + + ScrollIntoViewData* data = static_cast( + mContentToScrollTo->GetProperty(nsGkAtoms::scrolling)); + if (MOZ_UNLIKELY(!data)) { + mContentToScrollTo = nullptr; + return; + } + + // This is a two-step process. + // Step 1: Find the bounds of the rect we want to scroll into view. For + // example, for an inline frame we may want to scroll in the whole + // line, or we may want to scroll multiple lines into view. + // Step 2: Walk container frame and its ancestors and scroll them + // appropriately. + // frameBounds is relative to container. We're assuming + // that scrollframes don't split so every continuation of frame will + // be a descendant of container. (Things would still mostly work + // even if that assumption was false.) + nsRect frameBounds; + bool haveRect = false; + bool useWholeLineHeightForInlines = + data->mContentScrollVAxis.mWhenToScroll != nsIPresShell::SCROLL_IF_NOT_FULLY_VISIBLE; + // Reuse the same line iterator across calls to AccumulateFrameBounds. We set + // it every time we detect a new block (stored in prevBlock). + nsIFrame* prevBlock = nullptr; + nsAutoLineIterator lines; + // The last line we found a continuation on in |lines|. We assume that later + // continuations cannot come on earlier lines. + int32_t curLine = 0; + do { + AccumulateFrameBounds(container, frame, useWholeLineHeightForInlines, + frameBounds, haveRect, prevBlock, lines, curLine); + } while ((frame = frame->GetNextContinuation())); + + ScrollFrameRectIntoView(container, frameBounds, data->mContentScrollVAxis, + data->mContentScrollHAxis, + data->mContentToScrollToFlags); +} + +bool +PresShell::ScrollFrameRectIntoView(nsIFrame* aFrame, + const nsRect& aRect, + nsIPresShell::ScrollAxis aVertical, + nsIPresShell::ScrollAxis aHorizontal, + uint32_t aFlags) +{ + bool didScroll = false; + // This function needs to work even if rect has a width or height of 0. + nsRect rect = aRect; + nsIFrame* container = aFrame; + // Walk up the frame hierarchy scrolling the rect into view and + // keeping rect relative to container + do { + nsIScrollableFrame* sf = do_QueryFrame(container); + if (sf) { + nsPoint oldPosition = sf->GetScrollPosition(); + nsRect targetRect = rect; + if (container->StyleDisplay()->mOverflowClipBox == + NS_STYLE_OVERFLOW_CLIP_BOX_CONTENT_BOX) { + nsMargin padding = container->GetUsedPadding(); + targetRect.Inflate(padding); + } + ScrollToShowRect(sf, targetRect - sf->GetScrolledFrame()->GetPosition(), + aVertical, aHorizontal, aFlags); + nsPoint newPosition = sf->LastScrollDestination(); + // If the scroll position increased, that means our content moved up, + // so our rect's offset should decrease + rect += oldPosition - newPosition; + + if (oldPosition != newPosition) { + didScroll = true; + } + + // only scroll one container when this flag is set + if (aFlags & nsIPresShell::SCROLL_FIRST_ANCESTOR_ONLY) { + break; + } + } + nsIFrame* parent; + if (container->IsTransformed()) { + container->GetTransformMatrix(nullptr, &parent); + rect = nsLayoutUtils::TransformFrameRectToAncestor(container, rect, parent); + } else { + rect += container->GetPosition(); + parent = container->GetParent(); + } + if (!parent && !(aFlags & nsIPresShell::SCROLL_NO_PARENT_FRAMES)) { + nsPoint extraOffset(0,0); + parent = nsLayoutUtils::GetCrossDocParentFrame(container, &extraOffset); + if (parent) { + int32_t APD = container->PresContext()->AppUnitsPerDevPixel(); + int32_t parentAPD = parent->PresContext()->AppUnitsPerDevPixel(); + rect = rect.ScaleToOtherAppUnitsRoundOut(APD, parentAPD); + rect += extraOffset; + } + } + container = parent; + } while (container); + + return didScroll; +} + +nsRectVisibility +PresShell::GetRectVisibility(nsIFrame* aFrame, + const nsRect &aRect, + nscoord aMinTwips) const +{ + NS_ASSERTION(aFrame->PresContext() == GetPresContext(), + "prescontext mismatch?"); + nsIFrame* rootFrame = mFrameConstructor->GetRootFrame(); + NS_ASSERTION(rootFrame, + "How can someone have a frame for this presshell when there's no root?"); + nsIScrollableFrame* sf = GetRootScrollFrameAsScrollable(); + nsRect scrollPortRect; + if (sf) { + scrollPortRect = sf->GetScrollPortRect(); + nsIFrame* f = do_QueryFrame(sf); + scrollPortRect += f->GetOffsetTo(rootFrame); + } else { + scrollPortRect = nsRect(nsPoint(0,0), rootFrame->GetSize()); + } + + nsRect r = aRect + aFrame->GetOffsetTo(rootFrame); + // If aRect is entirely visible then we don't need to ensure that + // at least aMinTwips of it is visible + if (scrollPortRect.Contains(r)) + return nsRectVisibility_kVisible; + + nsRect insetRect = scrollPortRect; + insetRect.Deflate(aMinTwips, aMinTwips); + if (r.YMost() <= insetRect.y) + return nsRectVisibility_kAboveViewport; + if (r.y >= insetRect.YMost()) + return nsRectVisibility_kBelowViewport; + if (r.XMost() <= insetRect.x) + return nsRectVisibility_kLeftOfViewport; + if (r.x >= insetRect.XMost()) + return nsRectVisibility_kRightOfViewport; + + return nsRectVisibility_kVisible; +} + +class PaintTimerCallBack final : public nsITimerCallback +{ +public: + explicit PaintTimerCallBack(PresShell* aShell) : mShell(aShell) {} + + NS_DECL_ISUPPORTS + + NS_IMETHOD Notify(nsITimer* aTimer) final + { + mShell->SetNextPaintCompressed(); + mShell->AddInvalidateHiddenPresShellObserver(mShell->GetPresContext()->RefreshDriver()); + mShell->ScheduleViewManagerFlush(); + return NS_OK; + } + +private: + ~PaintTimerCallBack() {} + + PresShell* mShell; +}; + +NS_IMPL_ISUPPORTS(PaintTimerCallBack, nsITimerCallback) + +void +PresShell::ScheduleViewManagerFlush(PaintType aType) +{ + if (aType == PAINT_DELAYED_COMPRESS) { + // Delay paint for 1 second. + static const uint32_t kPaintDelayPeriod = 1000; + if (!mDelayedPaintTimer) { + mDelayedPaintTimer = do_CreateInstance(NS_TIMER_CONTRACTID); + RefPtr cb = new PaintTimerCallBack(this); + mDelayedPaintTimer->InitWithCallback(cb, kPaintDelayPeriod, nsITimer::TYPE_ONE_SHOT); + } + return; + } + + nsPresContext* presContext = GetPresContext(); + if (presContext) { + presContext->RefreshDriver()->ScheduleViewManagerFlush(); + } + if (mDocument) { + mDocument->SetNeedLayoutFlush(); + } +} + +bool +FlushLayoutRecursive(nsIDocument* aDocument, + void* aData = nullptr) +{ + MOZ_ASSERT(!aData); + nsCOMPtr kungFuDeathGrip(aDocument); + aDocument->EnumerateSubDocuments(FlushLayoutRecursive, nullptr); + aDocument->FlushPendingNotifications(Flush_Layout); + return true; +} + +void +PresShell::DispatchSynthMouseMove(WidgetGUIEvent* aEvent, + bool aFlushOnHoverChange) +{ + RestyleManagerHandle restyleManager = mPresContext->RestyleManager(); + uint32_t hoverGenerationBefore = + restyleManager->GetHoverGeneration(); + nsEventStatus status; + nsView* targetView = nsView::GetViewFor(aEvent->mWidget); + if (!targetView) + return; + targetView->GetViewManager()->DispatchEvent(aEvent, targetView, &status); + if (MOZ_UNLIKELY(mIsDestroying)) { + return; + } + if (aFlushOnHoverChange && + hoverGenerationBefore != restyleManager->GetHoverGeneration()) { + // Flush so that the resulting reflow happens now so that our caller + // can suppress any synthesized mouse moves caused by that reflow. + // This code only ever runs for the root document, but :hover changes + // can happen in descendant documents too, so make sure we flush + // all of them. + FlushLayoutRecursive(mDocument); + } +} + +void +PresShell::ClearMouseCaptureOnView(nsView* aView) +{ + if (gCaptureInfo.mContent) { + if (aView) { + // if a view was specified, ensure that the captured content is within + // this view. + nsIFrame* frame = gCaptureInfo.mContent->GetPrimaryFrame(); + if (frame) { + nsView* view = frame->GetClosestView(); + // if there is no view, capturing won't be handled any more, so + // just release the capture. + if (view) { + do { + if (view == aView) { + gCaptureInfo.mContent = nullptr; + // the view containing the captured content likely disappeared so + // disable capture for now. + gCaptureInfo.mAllowed = false; + break; + } + + view = view->GetParent(); + } while (view); + // return if the view wasn't found + return; + } + } + } + + gCaptureInfo.mContent = nullptr; + } + + // disable mouse capture until the next mousedown as a dialog has opened + // or a drag has started. Otherwise, someone could start capture during + // the modal dialog or drag. + gCaptureInfo.mAllowed = false; +} + +void +nsIPresShell::ClearMouseCapture(nsIFrame* aFrame) +{ + if (!gCaptureInfo.mContent) { + gCaptureInfo.mAllowed = false; + return; + } + + // null frame argument means clear the capture + if (!aFrame) { + gCaptureInfo.mContent = nullptr; + gCaptureInfo.mAllowed = false; + return; + } + + nsIFrame* capturingFrame = gCaptureInfo.mContent->GetPrimaryFrame(); + if (!capturingFrame) { + gCaptureInfo.mContent = nullptr; + gCaptureInfo.mAllowed = false; + return; + } + + if (nsLayoutUtils::IsAncestorFrameCrossDoc(aFrame, capturingFrame)) { + gCaptureInfo.mContent = nullptr; + gCaptureInfo.mAllowed = false; + } +} + +nsresult +PresShell::CaptureHistoryState(nsILayoutHistoryState** aState) +{ + NS_PRECONDITION(nullptr != aState, "null state pointer"); + + // We actually have to mess with the docshell here, since we want to + // store the state back in it. + // XXXbz this isn't really right, since this is being called in the + // content viewer's Hide() method... by that point the docshell's + // state could be wrong. We should sort out a better ownership + // model for the layout history state. + nsCOMPtr docShell(mPresContext->GetDocShell()); + if (!docShell) + return NS_ERROR_FAILURE; + + nsCOMPtr historyState; + docShell->GetLayoutHistoryState(getter_AddRefs(historyState)); + if (!historyState) { + // Create the document state object + historyState = NS_NewLayoutHistoryState(); + docShell->SetLayoutHistoryState(historyState); + } + + *aState = historyState; + NS_IF_ADDREF(*aState); + + // Capture frame state for the entire frame hierarchy + nsIFrame* rootFrame = mFrameConstructor->GetRootFrame(); + if (!rootFrame) return NS_OK; + + mFrameConstructor->CaptureFrameState(rootFrame, historyState); + + return NS_OK; +} + +void +PresShell::ScheduleBeforeFirstPaint() +{ + if (!mDocument->IsResourceDoc()) { + // Notify observers that a new page is about to be drawn. Execute this + // as soon as it is safe to run JS, which is guaranteed to be before we + // go back to the event loop and actually draw the page. + nsContentUtils::AddScriptRunner(new nsBeforeFirstPaintDispatcher(mDocument)); + } +} + +void +PresShell::UnsuppressAndInvalidate() +{ + // Note: We ignore the EnsureVisible check for resource documents, because + // they won't have a docshell, so they'll always fail EnsureVisible. + if ((!mDocument->IsResourceDoc() && !mPresContext->EnsureVisible()) || + mHaveShutDown) { + // No point; we're about to be torn down anyway. + return; + } + + ScheduleBeforeFirstPaint(); + + mPaintingSuppressed = false; + nsIFrame* rootFrame = mFrameConstructor->GetRootFrame(); + if (rootFrame) { + // let's assume that outline on a root frame is not supported + rootFrame->InvalidateFrame(); + } + + // now that painting is unsuppressed, focus may be set on the document + if (nsPIDOMWindowOuter* win = mDocument->GetWindow()) + win->SetReadyForFocus(); + + if (!mHaveShutDown) { + SynthesizeMouseMove(false); + ScheduleApproximateFrameVisibilityUpdateNow(); + } +} + +void +PresShell::UnsuppressPainting() +{ + if (mPaintSuppressionTimer) { + mPaintSuppressionTimer->Cancel(); + mPaintSuppressionTimer = nullptr; + } + + if (mIsDocumentGone || !mPaintingSuppressed) + return; + + // If we have reflows pending, just wait until we process + // the reflows and get all the frames where we want them + // before actually unlocking the painting. Otherwise + // go ahead and unlock now. + if (!mDirtyRoots.IsEmpty()) + mShouldUnsuppressPainting = true; + else + UnsuppressAndInvalidate(); +} + +// Post a request to handle an arbitrary callback after reflow has finished. +nsresult +PresShell::PostReflowCallback(nsIReflowCallback* aCallback) +{ + void* result = AllocateMisc(sizeof(nsCallbackEventRequest)); + nsCallbackEventRequest* request = (nsCallbackEventRequest*)result; + + request->callback = aCallback; + request->next = nullptr; + + if (mLastCallbackEventRequest) { + mLastCallbackEventRequest = mLastCallbackEventRequest->next = request; + } else { + mFirstCallbackEventRequest = request; + mLastCallbackEventRequest = request; + } + + return NS_OK; +} + +void +PresShell::CancelReflowCallback(nsIReflowCallback* aCallback) +{ + nsCallbackEventRequest* before = nullptr; + nsCallbackEventRequest* node = mFirstCallbackEventRequest; + while(node) + { + nsIReflowCallback* callback = node->callback; + + if (callback == aCallback) + { + nsCallbackEventRequest* toFree = node; + if (node == mFirstCallbackEventRequest) { + node = node->next; + mFirstCallbackEventRequest = node; + NS_ASSERTION(before == nullptr, "impossible"); + } else { + node = node->next; + before->next = node; + } + + if (toFree == mLastCallbackEventRequest) { + mLastCallbackEventRequest = before; + } + + FreeMisc(sizeof(nsCallbackEventRequest), toFree); + } else { + before = node; + node = node->next; + } + } +} + +void +PresShell::CancelPostedReflowCallbacks() +{ + while (mFirstCallbackEventRequest) { + nsCallbackEventRequest* node = mFirstCallbackEventRequest; + mFirstCallbackEventRequest = node->next; + if (!mFirstCallbackEventRequest) { + mLastCallbackEventRequest = nullptr; + } + nsIReflowCallback* callback = node->callback; + FreeMisc(sizeof(nsCallbackEventRequest), node); + if (callback) { + callback->ReflowCallbackCanceled(); + } + } +} + +void +PresShell::HandlePostedReflowCallbacks(bool aInterruptible) +{ + bool shouldFlush = false; + + while (mFirstCallbackEventRequest) { + nsCallbackEventRequest* node = mFirstCallbackEventRequest; + mFirstCallbackEventRequest = node->next; + if (!mFirstCallbackEventRequest) { + mLastCallbackEventRequest = nullptr; + } + nsIReflowCallback* callback = node->callback; + FreeMisc(sizeof(nsCallbackEventRequest), node); + if (callback) { + if (callback->ReflowFinished()) { + shouldFlush = true; + } + } + } + + mozFlushType flushType = + aInterruptible ? Flush_InterruptibleLayout : Flush_Layout; + if (shouldFlush && !mIsDestroying) { + FlushPendingNotifications(flushType); + } +} + +bool +PresShell::IsSafeToFlush() const +{ + // Not safe if we are reflowing or in the middle of frame construction + bool isSafeToFlush = !mIsReflowing && + !mChangeNestCount; + + if (isSafeToFlush) { + // Not safe if we are painting + nsViewManager* viewManager = GetViewManager(); + if (viewManager) { + bool isPainting = false; + viewManager->IsPainting(isPainting); + if (isPainting) { + isSafeToFlush = false; + } + } + } + + return isSafeToFlush; +} + + +void +PresShell::FlushPendingNotifications(mozFlushType aType) +{ + // by default, flush animations if aType >= Flush_Style + mozilla::ChangesToFlush flush(aType, aType >= Flush_Style); + FlushPendingNotifications(flush); +} + +void +PresShell::FlushPendingNotifications(mozilla::ChangesToFlush aFlush) +{ + if (mIsZombie) { + return; + } + + /** + * VERY IMPORTANT: If you add some sort of new flushing to this + * method, make sure to add the relevant SetNeedLayoutFlush or + * SetNeedStyleFlush calls on the document. + */ + mozFlushType flushType = aFlush.mFlushType; + +#ifdef MOZ_ENABLE_PROFILER_SPS + static const char flushTypeNames[][20] = { + "Content", + "ContentAndNotify", + "Style", + "InterruptibleLayout", + "Layout", + "Display" + }; + + // Make sure that we don't miss things added to mozFlushType! + MOZ_ASSERT(static_cast(flushType) <= ArrayLength(flushTypeNames)); + + PROFILER_LABEL_PRINTF("PresShell", "Flush", + js::ProfileEntry::Category::GRAPHICS, "(Flush_%s)", flushTypeNames[flushType - 1]); +#endif + +#ifdef ACCESSIBILITY +#ifdef DEBUG + nsAccessibilityService* accService = GetAccService(); + if (accService) { + NS_ASSERTION(!accService->IsProcessingRefreshDriverNotification(), + "Flush during accessible tree update!"); + } +#endif +#endif + + NS_ASSERTION(flushType >= Flush_Frames, "Why did we get called?"); + + bool isSafeToFlush = IsSafeToFlush(); + + // If layout could possibly trigger scripts, then it's only safe to flush if + // it's safe to run script. + bool hasHadScriptObject; + if (mDocument->GetScriptHandlingObject(hasHadScriptObject) || + hasHadScriptObject) { + isSafeToFlush = isSafeToFlush && nsContentUtils::IsSafeToRunScript(); + } + + NS_ASSERTION(!isSafeToFlush || mViewManager, "Must have view manager"); + // Make sure the view manager stays alive. + RefPtr viewManager = mViewManager; + bool didStyleFlush = false; + bool didLayoutFlush = false; + nsCOMPtr kungFuDeathGrip; + if (isSafeToFlush && viewManager) { + // Processing pending notifications can kill us, and some callers only + // hold weak refs when calling FlushPendingNotifications(). :( + kungFuDeathGrip = this; + + if (mResizeEvent.IsPending()) { + FireResizeEvent(); + if (mIsDestroying) { + return; + } + } + + // We need to make sure external resource documents are flushed too (for + // example, svg filters that reference a filter in an external document + // need the frames in the external document to be constructed for the + // filter to work). We only need external resources to be flushed when the + // main document is flushing >= Flush_Frames, so we flush external + // resources here instead of nsDocument::FlushPendingNotifications. + mDocument->FlushExternalResources(flushType); + + // Force flushing of any pending content notifications that might have + // queued up while our event was pending. That will ensure that we don't + // construct frames for content right now that's still waiting to be + // notified on, + mDocument->FlushPendingNotifications(Flush_ContentAndNotify); + + // Process pending restyles, since any flush of the presshell wants + // up-to-date style data. + if (!mIsDestroying) { + viewManager->FlushDelayedResize(false); + mPresContext->FlushPendingMediaFeatureValuesChanged(); + + // Flush any pending update of the user font set, since that could + // cause style changes (for updating ex/ch units, and to cause a + // reflow). + mDocument->FlushUserFontSet(); + + mPresContext->FlushCounterStyles(); + + // Flush any requested SMIL samples. + if (mDocument->HasAnimationController()) { + mDocument->GetAnimationController()->FlushResampleRequests(); + } + + if (aFlush.mFlushAnimations && mPresContext->EffectCompositor()) { + mPresContext->EffectCompositor()->PostRestyleForThrottledAnimations(); + } + + // The FlushResampleRequests() above flushed style changes. + if (!mIsDestroying) { + nsAutoScriptBlocker scriptBlocker; + mPresContext->RestyleManager()->ProcessPendingRestyles(); + } + } + + // Process whatever XBL constructors those restyles queued up. This + // ensures that onload doesn't fire too early and that we won't do extra + // reflows after those constructors run. + if (!mIsDestroying) { + mDocument->BindingManager()->ProcessAttachedQueue(); + } + + // Now those constructors or events might have posted restyle + // events. At the same time, we still need up-to-date style data. + // In particular, reflow depends on style being completely up to + // date. If it's not, then style context reparenting, which can + // happen during reflow, might suddenly pick up the new rules and + // we'll end up with frames whose style doesn't match the frame + // type. + if (!mIsDestroying) { + nsAutoScriptBlocker scriptBlocker; + mPresContext->RestyleManager()->ProcessPendingRestyles(); + } + + didStyleFlush = true; + + + // There might be more pending constructors now, but we're not going to + // worry about them. They can't be triggered during reflow, so we should + // be good. + + if (flushType >= (mSuppressInterruptibleReflows ? Flush_Layout : Flush_InterruptibleLayout) && + !mIsDestroying) { + didLayoutFlush = true; + mFrameConstructor->RecalcQuotesAndCounters(); + viewManager->FlushDelayedResize(true); + if (ProcessReflowCommands(flushType < Flush_Layout) && mContentToScrollTo) { + // We didn't get interrupted. Go ahead and scroll to our content + DoScrollContentIntoView(); + if (mContentToScrollTo) { + mContentToScrollTo->DeleteProperty(nsGkAtoms::scrolling); + mContentToScrollTo = nullptr; + } + } + } + + if (flushType >= Flush_Layout) { + if (!mIsDestroying) { + viewManager->UpdateWidgetGeometry(); + } + } + } + + if (!didStyleFlush && flushType >= Flush_Style && !mIsDestroying) { + mDocument->SetNeedStyleFlush(); + } + + if (!didLayoutFlush && !mIsDestroying && + (flushType >= + (mSuppressInterruptibleReflows ? Flush_Layout : Flush_InterruptibleLayout))) { + // We suppressed this flush due to mSuppressInterruptibleReflows or + // !isSafeToFlush, but the document thinks it doesn't + // need to flush anymore. Let it know what's really going on. + mDocument->SetNeedLayoutFlush(); + } +} + +void +PresShell::CharacterDataChanged(nsIDocument *aDocument, + nsIContent* aContent, + CharacterDataChangeInfo* aInfo) +{ + NS_PRECONDITION(!mIsDocumentGone, "Unexpected CharacterDataChanged"); + NS_PRECONDITION(aDocument == mDocument, "Unexpected aDocument"); + + nsAutoCauseReflowNotifier crNotifier(this); + + // Call this here so it only happens for real content mutations and + // not cases when the frame constructor calls its own methods to force + // frame reconstruction. + nsIContent *container = aContent->GetParent(); + uint32_t selectorFlags = + container ? (container->GetFlags() & NODE_ALL_SELECTOR_FLAGS) : 0; + if (selectorFlags != 0 && !aContent->IsRootOfAnonymousSubtree()) { + Element* element = container->AsElement(); + if (aInfo->mAppend && !aContent->GetNextSibling()) + mPresContext->RestyleManager()->RestyleForAppend(element, aContent); + else + mPresContext->RestyleManager()->RestyleForInsertOrChange(element, aContent); + } + + mFrameConstructor->CharacterDataChanged(aContent, aInfo); + VERIFY_STYLE_TREE; +} + +void +PresShell::ContentStateChanged(nsIDocument* aDocument, + nsIContent* aContent, + EventStates aStateMask) +{ + NS_PRECONDITION(!mIsDocumentGone, "Unexpected ContentStateChanged"); + NS_PRECONDITION(aDocument == mDocument, "Unexpected aDocument"); + + if (mDidInitialize) { + nsAutoCauseReflowNotifier crNotifier(this); + mPresContext->RestyleManager()->ContentStateChanged(aContent, aStateMask); + VERIFY_STYLE_TREE; + } +} + +void +PresShell::DocumentStatesChanged(nsIDocument* aDocument, + EventStates aStateMask) +{ + NS_PRECONDITION(!mIsDocumentGone, "Unexpected DocumentStatesChanged"); + NS_PRECONDITION(aDocument == mDocument, "Unexpected aDocument"); + + nsStyleSet* styleSet = mStyleSet->GetAsGecko(); + if (!styleSet) { + // XXXheycam ServoStyleSets don't support document state selectors, + // but these are only used in chrome documents, which we are not + // aiming to support yet. + NS_WARNING("stylo: ServoStyleSets cannot respond to document state " + "changes yet (only matters for chrome documents). See bug 1290285."); + return; + } + + if (mDidInitialize && + styleSet->HasDocumentStateDependentStyle(mDocument->GetRootElement(), + aStateMask)) { + mPresContext->RestyleManager()->PostRestyleEvent(mDocument->GetRootElement(), + eRestyle_Subtree, + nsChangeHint(0)); + VERIFY_STYLE_TREE; + } + + if (aStateMask.HasState(NS_DOCUMENT_STATE_WINDOW_INACTIVE)) { + nsIFrame* root = mFrameConstructor->GetRootFrame(); + if (root) { + root->SchedulePaint(); + } + } +} + +void +PresShell::AttributeWillChange(nsIDocument* aDocument, + Element* aElement, + int32_t aNameSpaceID, + nsIAtom* aAttribute, + int32_t aModType, + const nsAttrValue* aNewValue) +{ + NS_PRECONDITION(!mIsDocumentGone, "Unexpected AttributeWillChange"); + NS_PRECONDITION(aDocument == mDocument, "Unexpected aDocument"); + + // XXXwaterson it might be more elegant to wait until after the + // initial reflow to begin observing the document. That would + // squelch any other inappropriate notifications as well. + if (mDidInitialize) { + nsAutoCauseReflowNotifier crNotifier(this); + mPresContext->RestyleManager()->AttributeWillChange(aElement, aNameSpaceID, + aAttribute, aModType, + aNewValue); + VERIFY_STYLE_TREE; + } +} + +void +PresShell::AttributeChanged(nsIDocument* aDocument, + Element* aElement, + int32_t aNameSpaceID, + nsIAtom* aAttribute, + int32_t aModType, + const nsAttrValue* aOldValue) +{ + NS_PRECONDITION(!mIsDocumentGone, "Unexpected AttributeChanged"); + NS_PRECONDITION(aDocument == mDocument, "Unexpected aDocument"); + + // XXXwaterson it might be more elegant to wait until after the + // initial reflow to begin observing the document. That would + // squelch any other inappropriate notifications as well. + if (mDidInitialize) { + nsAutoCauseReflowNotifier crNotifier(this); + mPresContext->RestyleManager()->AttributeChanged(aElement, aNameSpaceID, + aAttribute, aModType, + aOldValue); + VERIFY_STYLE_TREE; + } +} + +// nsIMutationObserver callbacks have this terrible API where aContainer is +// null in the case that the container is the document (since nsIDocument is +// not an nsIContent), and callees are supposed to figure this out and use the +// document instead. It would be nice to fix that API to just pass a single +// nsINode* parameter in place of the nsIDocument*, nsIContent* pair, but +// there are quite a lot of consumers. So we fix things up locally with this +// routine for now. +static inline nsINode* +RealContainer(nsIDocument* aDocument, nsIContent* aContainer, nsIContent* aContent) +{ + MOZ_ASSERT(aDocument); + MOZ_ASSERT_IF(aContainer, aContainer->OwnerDoc() == aDocument); + MOZ_ASSERT(aContent->OwnerDoc() == aDocument); + MOZ_ASSERT_IF(!aContainer, aContent->GetParentNode() == aDocument); + if (!aContainer) { + return aDocument; + } + return aContainer; +} + +void +PresShell::ContentAppended(nsIDocument *aDocument, + nsIContent* aContainer, + nsIContent* aFirstNewContent, + int32_t aNewIndexInContainer) +{ + NS_PRECONDITION(!mIsDocumentGone, "Unexpected ContentAppended"); + NS_PRECONDITION(aDocument == mDocument, "Unexpected aDocument"); + + // We never call ContentAppended with a document as the container, so we can + // assert that we have an nsIContent container. + MOZ_ASSERT(aContainer); + MOZ_ASSERT(aContainer->IsElement() || + aContainer->IsNodeOfType(nsINode::eDOCUMENT_FRAGMENT)); + if (!mDidInitialize) { + return; + } + + nsAutoCauseReflowNotifier crNotifier(this); + + // Call this here so it only happens for real content mutations and + // not cases when the frame constructor calls its own methods to force + // frame reconstruction. + mPresContext->RestyleManager()->ContentAppended(aContainer, aFirstNewContent); + + mFrameConstructor->ContentAppended(aContainer, aFirstNewContent, true); + + VERIFY_STYLE_TREE; +} + +void +PresShell::ContentInserted(nsIDocument* aDocument, + nsIContent* aMaybeContainer, + nsIContent* aChild, + int32_t aIndexInContainer) +{ + NS_PRECONDITION(!mIsDocumentGone, "Unexpected ContentInserted"); + NS_PRECONDITION(aDocument == mDocument, "Unexpected aDocument"); + nsINode* container = RealContainer(aDocument, aMaybeContainer, aChild); + + if (!mDidInitialize) { + return; + } + + nsAutoCauseReflowNotifier crNotifier(this); + + // Call this here so it only happens for real content mutations and + // not cases when the frame constructor calls its own methods to force + // frame reconstruction. + mPresContext->RestyleManager()->ContentInserted(container, aChild); + + mFrameConstructor->ContentInserted(aMaybeContainer, aChild, nullptr, true); + + if (aChild->NodeType() == nsIDOMNode::DOCUMENT_TYPE_NODE) { + MOZ_ASSERT(container == aDocument); + NotifyFontSizeInflationEnabledIsDirty(); + } + + VERIFY_STYLE_TREE; +} + +void +PresShell::ContentRemoved(nsIDocument *aDocument, + nsIContent* aMaybeContainer, + nsIContent* aChild, + int32_t aIndexInContainer, + nsIContent* aPreviousSibling) +{ + NS_PRECONDITION(!mIsDocumentGone, "Unexpected ContentRemoved"); + NS_PRECONDITION(aDocument == mDocument, "Unexpected aDocument"); + nsINode* container = RealContainer(aDocument, aMaybeContainer, aChild); + + // Notify the ESM that the content has been removed, so that + // it can clean up any state related to the content. + + // XXX_jwir3: There is no null check for aDocument necessary, since, even + // though by nsIMutationObserver, aDocument could be null, the + // precondition check that mDocument == aDocument ensures that + // aDocument will not be null (since mDocument can't be null unless + // we're still intializing). + mPresContext->EventStateManager()->ContentRemoved(aDocument, aChild); + + nsAutoCauseReflowNotifier crNotifier(this); + + // Call this here so it only happens for real content mutations and + // not cases when the frame constructor calls its own methods to force + // frame reconstruction. + nsIContent* oldNextSibling = container->GetChildAt(aIndexInContainer); + + mPresContext->RestyleManager()->ContentRemoved(container, aChild, oldNextSibling); + + // After removing aChild from tree we should save information about live ancestor + if (mPointerEventTarget) { + if (nsContentUtils::ContentIsDescendantOf(mPointerEventTarget, aChild)) { + mPointerEventTarget = aMaybeContainer; + } + } + + // We should check that aChild does not contain pointer capturing elements. + // If it does we should release the pointer capture for the elements. + for (auto iter = sPointerCaptureList->Iter(); !iter.Done(); iter.Next()) { + nsIPresShell::PointerCaptureInfo* data = iter.UserData(); + if (data && data->mPendingContent && + nsContentUtils::ContentIsDescendantOf(data->mPendingContent, aChild)) { + nsIPresShell::ReleasePointerCapturingContent(iter.Key()); + } + } + + bool didReconstruct; + mFrameConstructor->ContentRemoved(aMaybeContainer, aChild, oldNextSibling, + nsCSSFrameConstructor::REMOVE_CONTENT, + &didReconstruct); + + + if (aChild->NodeType() == nsIDOMNode::DOCUMENT_TYPE_NODE) { + MOZ_ASSERT(container == aDocument); + NotifyFontSizeInflationEnabledIsDirty(); + } + + VERIFY_STYLE_TREE; +} + +void +PresShell::NotifyCounterStylesAreDirty() +{ + nsAutoCauseReflowNotifier reflowNotifier(this); + mFrameConstructor->BeginUpdate(); + mFrameConstructor->NotifyCounterStylesAreDirty(); + mFrameConstructor->EndUpdate(); +} + +nsresult +PresShell::ReconstructFrames(void) +{ + NS_PRECONDITION(!mFrameConstructor->GetRootFrame() || mDidInitialize, + "Must not have root frame before initial reflow"); + if (!mDidInitialize || mIsDestroying) { + // Nothing to do here + return NS_OK; + } + + nsCOMPtr kungFuDeathGrip(this); + + // Have to make sure that the content notifications are flushed before we + // start messing with the frame model; otherwise we can get content doubling. + mDocument->FlushPendingNotifications(Flush_ContentAndNotify); + + if (mIsDestroying) { + return NS_OK; + } + + nsAutoCauseReflowNotifier crNotifier(this); + mFrameConstructor->BeginUpdate(); + nsresult rv = mFrameConstructor->ReconstructDocElementHierarchy(); + VERIFY_STYLE_TREE; + mFrameConstructor->EndUpdate(); + + return rv; +} + +void +nsIPresShell::RestyleForCSSRuleChanges() +{ + AutoTArray,1> scopeRoots; + mChangedScopeStyleRoots.SwapElements(scopeRoots); + + if (mStylesHaveChanged) { + // If we need to restyle everything, no need to restyle individual + // scoped style roots. + scopeRoots.Clear(); + } + + mStylesHaveChanged = false; + + if (mIsDestroying) { + // We don't want to mess with restyles at this point + return; + } + + mDocument->RebuildUserFontSet(); + + if (mPresContext) { + mPresContext->RebuildCounterStyles(); + } + + Element* root = mDocument->GetRootElement(); + if (!mDidInitialize) { + // Nothing to do here, since we have no frames yet + return; + } + + if (!root) { + // No content to restyle + return; + } + + RestyleManagerHandle restyleManager = mPresContext->RestyleManager(); + if (scopeRoots.IsEmpty()) { + // If scopeRoots is empty, we know that mStylesHaveChanged was true at + // the beginning of this function, and that we need to restyle the whole + // document. + restyleManager->PostRestyleEvent(root, eRestyle_Subtree, + nsChangeHint(0)); + } else { + for (Element* scopeRoot : scopeRoots) { + restyleManager->PostRestyleEvent(scopeRoot, eRestyle_Subtree, + nsChangeHint(0)); + } + } +} + +void +PresShell::RecordStyleSheetChange(StyleSheet* aStyleSheet) +{ + // too bad we can't check that the update is UPDATE_STYLE + NS_ASSERTION(mUpdateCount != 0, "must be in an update"); + + if (mStylesHaveChanged) + return; + + if (aStyleSheet->IsGecko()) { + // XXXheycam ServoStyleSheets don't support