Remove the REQUEST_ANIMATION_FRAME flag
[WebKit-https.git] / Source / WebCore / page / FrameView.cpp
1 /*
2  * Copyright (C) 1998, 1999 Torben Weis <weis@kde.org>
3  *                     1999 Lars Knoll <knoll@kde.org>
4  *                     1999 Antti Koivisto <koivisto@kde.org>
5  *                     2000 Dirk Mueller <mueller@kde.org>
6  * Copyright (C) 2004-2017 Apple Inc. All rights reserved.
7  *           (C) 2006 Graham Dennis (graham.dennis@gmail.com)
8  *           (C) 2006 Alexey Proskuryakov (ap@nypop.com)
9  * Copyright (C) 2009 Google Inc. All rights reserved.
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Library General Public
13  * License as published by the Free Software Foundation; either
14  * version 2 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * Library General Public License for more details.
20  *
21  * You should have received a copy of the GNU Library General Public License
22  * along with this library; see the file COPYING.LIB.  If not, write to
23  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24  * Boston, MA 02110-1301, USA.
25  */
26
27 #include "config.h"
28 #include "FrameView.h"
29
30 #include "AXObjectCache.h"
31 #include "AnimationController.h"
32 #include "BackForwardController.h"
33 #include "CachedImage.h"
34 #include "CachedResourceLoader.h"
35 #include "Chrome.h"
36 #include "ChromeClient.h"
37 #include "DOMWindow.h"
38 #include "DebugPageOverlays.h"
39 #include "DocumentMarkerController.h"
40 #include "EventHandler.h"
41 #include "EventNames.h"
42 #include "FloatRect.h"
43 #include "FocusController.h"
44 #include "FrameLoader.h"
45 #include "FrameLoaderClient.h"
46 #include "FrameSelection.h"
47 #include "FrameTree.h"
48 #include "GraphicsContext.h"
49 #include "HTMLBodyElement.h"
50 #include "HTMLDocument.h"
51 #include "HTMLEmbedElement.h"
52 #include "HTMLFrameElement.h"
53 #include "HTMLFrameSetElement.h"
54 #include "HTMLHtmlElement.h"
55 #include "HTMLIFrameElement.h"
56 #include "HTMLNames.h"
57 #include "HTMLObjectElement.h"
58 #include "HTMLPlugInImageElement.h"
59 #include "ImageDocument.h"
60 #include "InspectorClient.h"
61 #include "InspectorController.h"
62 #include "InspectorInstrumentation.h"
63 #include "Logging.h"
64 #include "MainFrame.h"
65 #include "MemoryCache.h"
66 #include "MemoryPressureHandler.h"
67 #include "OverflowEvent.h"
68 #include "Page.h"
69 #include "PageCache.h"
70 #include "PageOverlayController.h"
71 #include "ProgressTracker.h"
72 #include "RenderEmbeddedObject.h"
73 #include "RenderFullScreen.h"
74 #include "RenderIFrame.h"
75 #include "RenderInline.h"
76 #include "RenderLayer.h"
77 #include "RenderLayerBacking.h"
78 #include "RenderLayerCompositor.h"
79 #include "RenderSVGRoot.h"
80 #include "RenderScrollbar.h"
81 #include "RenderScrollbarPart.h"
82 #include "RenderStyle.h"
83 #include "RenderText.h"
84 #include "RenderTheme.h"
85 #include "RenderView.h"
86 #include "RenderWidget.h"
87 #include "SVGDocument.h"
88 #include "SVGSVGElement.h"
89 #include "ScriptedAnimationController.h"
90 #include "ScrollAnimator.h"
91 #include "ScrollingCoordinator.h"
92 #include "Settings.h"
93 #include "StyleResolver.h"
94 #include "StyleScope.h"
95 #include "TextResourceDecoder.h"
96 #include "TextStream.h"
97 #include "TiledBacking.h"
98 #include "WheelEventTestTrigger.h"
99
100 #include <wtf/CurrentTime.h>
101 #include <wtf/Ref.h>
102 #include <wtf/SetForScope.h>
103 #include <wtf/SystemTracing.h>
104
105 #if USE(COORDINATED_GRAPHICS)
106 #include "TiledBackingStore.h"
107 #endif
108
109 #if ENABLE(CSS_SCROLL_SNAP)
110 #include "AxisScrollSnapOffsets.h"
111 #endif
112
113 #if PLATFORM(IOS)
114 #include "DocumentLoader.h"
115 #include "LegacyTileCache.h"
116 #endif
117
118 namespace WebCore {
119
120 using namespace HTMLNames;
121
122 double FrameView::sCurrentPaintTimeStamp = 0.0;
123
124 // The maximum number of updateEmbeddedObjects iterations that should be done before returning.
125 static const unsigned maxUpdateEmbeddedObjectsIterations = 2;
126
127 static RenderLayer::UpdateLayerPositionsFlags updateLayerPositionFlags(RenderLayer* layer, bool isRelayoutingSubtree, bool didFullRepaint)
128 {
129     RenderLayer::UpdateLayerPositionsFlags flags = RenderLayer::defaultFlags;
130     if (didFullRepaint) {
131         flags &= ~RenderLayer::CheckForRepaint;
132         flags |= RenderLayer::NeedsFullRepaintInBacking;
133     }
134     if (isRelayoutingSubtree && layer->enclosingPaginationLayer(RenderLayer::IncludeCompositedPaginatedLayers))
135         flags |= RenderLayer::UpdatePagination;
136     return flags;
137 }
138
139 Pagination::Mode paginationModeForRenderStyle(const RenderStyle& style)
140 {
141     EOverflow overflow = style.overflowY();
142     if (overflow != OPAGEDX && overflow != OPAGEDY)
143         return Pagination::Unpaginated;
144
145     bool isHorizontalWritingMode = style.isHorizontalWritingMode();
146     TextDirection textDirection = style.direction();
147     WritingMode writingMode = style.writingMode();
148
149     // paged-x always corresponds to LeftToRightPaginated or RightToLeftPaginated. If the WritingMode
150     // is horizontal, then we use TextDirection to choose between those options. If the WritingMode
151     // is vertical, then the direction of the verticality dictates the choice.
152     if (overflow == OPAGEDX) {
153         if ((isHorizontalWritingMode && textDirection == LTR) || writingMode == LeftToRightWritingMode)
154             return Pagination::LeftToRightPaginated;
155         return Pagination::RightToLeftPaginated;
156     }
157
158     // paged-y always corresponds to TopToBottomPaginated or BottomToTopPaginated. If the WritingMode
159     // is horizontal, then the direction of the horizontality dictates the choice. If the WritingMode
160     // is vertical, then we use TextDirection to choose between those options. 
161     if (writingMode == TopToBottomWritingMode || (!isHorizontalWritingMode && textDirection == RTL))
162         return Pagination::TopToBottomPaginated;
163     return Pagination::BottomToTopPaginated;
164 }
165
166 class SubtreeLayoutStateMaintainer {
167 public:
168     SubtreeLayoutStateMaintainer(RenderElement* subtreeLayoutRoot)
169         : m_layoutRoot(subtreeLayoutRoot)
170     {
171         if (m_layoutRoot) {
172             RenderView& view = m_layoutRoot->view();
173             view.pushLayoutState(*m_layoutRoot);
174             if (shouldDisableLayoutStateForSubtree()) {
175                 view.disableLayoutState();
176                 m_didDisableLayoutState = true;
177             }
178         }
179     }
180
181     ~SubtreeLayoutStateMaintainer()
182     {
183         if (m_layoutRoot) {
184             RenderView& view = m_layoutRoot->view();
185             view.popLayoutState(*m_layoutRoot);
186             if (m_didDisableLayoutState)
187                 view.enableLayoutState();
188         }
189     }
190
191     bool shouldDisableLayoutStateForSubtree()
192     {
193         for (auto* renderer = m_layoutRoot; renderer; renderer = renderer->container()) {
194             if (renderer->hasTransform() || renderer->hasReflection())
195                 return true;
196         }
197         return false;
198     }
199     
200 private:
201     RenderElement* m_layoutRoot { nullptr };
202     bool m_didDisableLayoutState { false };
203 };
204
205 #ifndef NDEBUG
206 class RenderTreeNeedsLayoutChecker {
207 public :
208     RenderTreeNeedsLayoutChecker(const RenderElement& layoutRoot)
209         : m_layoutRoot(layoutRoot)
210     {
211     }
212
213     ~RenderTreeNeedsLayoutChecker()
214     {
215         auto reportNeedsLayoutError = [] (const RenderObject& renderer) {
216             WTFReportError(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, "post-layout: dirty renderer(s)");
217             renderer.showRenderTreeForThis();
218             ASSERT_NOT_REACHED();
219         };
220
221         if (m_layoutRoot.needsLayout()) {
222             reportNeedsLayoutError(m_layoutRoot);
223             return;
224         }
225
226         for (auto* descendant = m_layoutRoot.firstChild(); descendant; descendant = descendant->nextInPreOrder(&m_layoutRoot)) {
227             if (!descendant->needsLayout())
228                 continue;
229             
230             reportNeedsLayoutError(*descendant);
231             return;
232         }
233     }
234
235 private:
236     const RenderElement& m_layoutRoot;
237 };
238 #endif
239
240 FrameView::FrameView(Frame& frame)
241     : m_frame(frame)
242     , m_canHaveScrollbars(true)
243     , m_layoutTimer(*this, &FrameView::layoutTimerFired)
244     , m_layoutPhase(OutsideLayout)
245     , m_inSynchronousPostLayout(false)
246     , m_postLayoutTasksTimer(*this, &FrameView::performPostLayoutTasks)
247     , m_updateEmbeddedObjectsTimer(*this, &FrameView::updateEmbeddedObjectsTimerFired)
248     , m_isTransparent(false)
249     , m_baseBackgroundColor(Color::white)
250     , m_mediaType("screen")
251     , m_overflowStatusDirty(true)
252     , m_wasScrolledByUser(false)
253     , m_inProgrammaticScroll(false)
254     , m_safeToPropagateScrollToParent(true)
255     , m_delayedScrollEventTimer(*this, &FrameView::sendScrollEvent)
256     , m_isTrackingRepaints(false)
257     , m_shouldUpdateWhileOffscreen(true)
258     , m_deferSetNeedsLayoutCount(0)
259     , m_setNeedsLayoutWasDeferred(false)
260     , m_speculativeTilingEnabled(false)
261     , m_speculativeTilingEnableTimer(*this, &FrameView::speculativeTilingEnableTimerFired)
262 #if PLATFORM(IOS)
263     , m_useCustomFixedPositionLayoutRect(false)
264     , m_useCustomSizeForResizeEvent(false)
265 #endif
266     , m_hasOverrideViewportSize(false)
267     , m_shouldAutoSize(false)
268     , m_inAutoSize(false)
269     , m_didRunAutosize(false)
270     , m_autoSizeFixedMinimumHeight(0)
271     , m_headerHeight(0)
272     , m_footerHeight(0)
273     , m_milestonesPendingPaint(0)
274     , m_visualUpdatesAllowedByClient(true)
275     , m_hasFlippedBlockRenderers(false)
276     , m_scrollPinningBehavior(DoNotPin)
277 {
278     init();
279
280 #if ENABLE(RUBBER_BANDING)
281     ScrollElasticity verticalElasticity = ScrollElasticityNone;
282     ScrollElasticity horizontalElasticity = ScrollElasticityNone;
283     if (m_frame->isMainFrame()) {
284         verticalElasticity = m_frame->page() ? m_frame->page()->verticalScrollElasticity() : ScrollElasticityAllowed;
285         horizontalElasticity = m_frame->page() ? m_frame->page()->horizontalScrollElasticity() : ScrollElasticityAllowed;
286     } else if (m_frame->settings().rubberBandingForSubScrollableRegionsEnabled()) {
287         verticalElasticity = ScrollElasticityAutomatic;
288         horizontalElasticity = ScrollElasticityAutomatic;
289     }
290
291     ScrollableArea::setVerticalScrollElasticity(verticalElasticity);
292     ScrollableArea::setHorizontalScrollElasticity(horizontalElasticity);
293 #endif
294 }
295
296 Ref<FrameView> FrameView::create(Frame& frame)
297 {
298     Ref<FrameView> view = adoptRef(*new FrameView(frame));
299     view->show();
300     return view;
301 }
302
303 Ref<FrameView> FrameView::create(Frame& frame, const IntSize& initialSize)
304 {
305     Ref<FrameView> view = adoptRef(*new FrameView(frame));
306     view->Widget::setFrameRect(IntRect(view->location(), initialSize));
307     view->show();
308     return view;
309 }
310
311 FrameView::~FrameView()
312 {
313     if (m_postLayoutTasksTimer.isActive())
314         m_postLayoutTasksTimer.stop();
315     
316     removeFromAXObjectCache();
317     resetScrollbars();
318
319     // Custom scrollbars should already be destroyed at this point
320     ASSERT(!horizontalScrollbar() || !horizontalScrollbar()->isCustomScrollbar());
321     ASSERT(!verticalScrollbar() || !verticalScrollbar()->isCustomScrollbar());
322
323     setHasHorizontalScrollbar(false); // Remove native scrollbars now before we lose the connection to the HostWindow.
324     setHasVerticalScrollbar(false);
325     
326     ASSERT(!m_scrollCorner);
327
328     ASSERT(frame().view() != this || !frame().contentRenderer());
329 }
330
331 void FrameView::reset()
332 {
333     m_cannotBlitToWindow = false;
334     m_isOverlapped = false;
335     m_contentIsOpaque = false;
336     m_layoutTimer.stop();
337     m_layoutRoot = nullptr;
338     m_delayedLayout = false;
339     m_needsFullRepaint = true;
340     m_layoutSchedulingEnabled = true;
341     m_layoutPhase = OutsideLayout;
342     m_inSynchronousPostLayout = false;
343     m_layoutCount = 0;
344     m_nestedLayoutCount = 0;
345     m_postLayoutTasksTimer.stop();
346     m_updateEmbeddedObjectsTimer.stop();
347     m_firstLayout = true;
348     m_firstLayoutCallbackPending = false;
349     m_wasScrolledByUser = false;
350     m_safeToPropagateScrollToParent = true;
351     m_delayedScrollEventTimer.stop();
352     m_lastViewportSize = IntSize();
353     m_lastZoomFactor = 1.0f;
354     m_isTrackingRepaints = false;
355     m_trackedRepaintRects.clear();
356     m_lastPaintTime = 0;
357     m_paintBehavior = PaintBehaviorNormal;
358     m_isPainting = false;
359     m_visuallyNonEmptyCharacterCount = 0;
360     m_visuallyNonEmptyPixelCount = 0;
361     m_isVisuallyNonEmpty = false;
362     m_firstVisuallyNonEmptyLayoutCallbackPending = true;
363     m_needsDeferredScrollbarsUpdate = false;
364     m_maintainScrollPositionAnchor = nullptr;
365 }
366
367 void FrameView::removeFromAXObjectCache()
368 {
369     if (AXObjectCache* cache = axObjectCache()) {
370         if (HTMLFrameOwnerElement* owner = frame().ownerElement())
371             cache->childrenChanged(owner->renderer());
372         cache->remove(this);
373     }
374 }
375
376 void FrameView::resetScrollbars()
377 {
378     // Reset the document's scrollbars back to our defaults before we yield the floor.
379     m_firstLayout = true;
380     setScrollbarsSuppressed(true);
381     if (m_canHaveScrollbars)
382         setScrollbarModes(ScrollbarAuto, ScrollbarAuto);
383     else
384         setScrollbarModes(ScrollbarAlwaysOff, ScrollbarAlwaysOff);
385     setScrollbarsSuppressed(false);
386 }
387
388 void FrameView::resetScrollbarsAndClearContentsSize()
389 {
390     resetScrollbars();
391
392     setScrollbarsSuppressed(true);
393     setContentsSize(IntSize());
394     setScrollbarsSuppressed(false);
395 }
396
397 void FrameView::init()
398 {
399     reset();
400
401     m_margins = LayoutSize(-1, -1); // undefined
402     m_size = LayoutSize();
403
404     // Propagate the marginwidth/height and scrolling modes to the view.
405     Element* ownerElement = frame().ownerElement();
406     if (is<HTMLFrameElementBase>(ownerElement)) {
407         HTMLFrameElementBase& frameElement = downcast<HTMLFrameElementBase>(*ownerElement);
408         if (frameElement.scrollingMode() == ScrollbarAlwaysOff)
409             setCanHaveScrollbars(false);
410         LayoutUnit marginWidth = frameElement.marginWidth();
411         LayoutUnit marginHeight = frameElement.marginHeight();
412         if (marginWidth != -1)
413             setMarginWidth(marginWidth);
414         if (marginHeight != -1)
415             setMarginHeight(marginHeight);
416     }
417
418     Page* page = frame().page();
419     if (page && page->chrome().client().shouldPaintEntireContents())
420         setPaintsEntireContents(true);
421 }
422     
423 void FrameView::prepareForDetach()
424 {
425     detachCustomScrollbars();
426     // When the view is no longer associated with a frame, it needs to be removed from the ax object cache
427     // right now, otherwise it won't be able to reach the topDocument()'s axObject cache later.
428     removeFromAXObjectCache();
429
430     if (frame().page()) {
431         if (ScrollingCoordinator* scrollingCoordinator = frame().page()->scrollingCoordinator())
432             scrollingCoordinator->willDestroyScrollableArea(*this);
433     }
434 }
435
436 void FrameView::detachCustomScrollbars()
437 {
438     Scrollbar* horizontalBar = horizontalScrollbar();
439     if (horizontalBar && horizontalBar->isCustomScrollbar())
440         setHasHorizontalScrollbar(false);
441
442     Scrollbar* verticalBar = verticalScrollbar();
443     if (verticalBar && verticalBar->isCustomScrollbar())
444         setHasVerticalScrollbar(false);
445
446     m_scrollCorner = nullptr;
447 }
448
449 void FrameView::recalculateScrollbarOverlayStyle()
450 {
451     ScrollbarOverlayStyle oldOverlayStyle = scrollbarOverlayStyle();
452     std::optional<ScrollbarOverlayStyle> clientOverlayStyle = frame().page() ? frame().page()->chrome().client().preferredScrollbarOverlayStyle() : ScrollbarOverlayStyleDefault;
453     if (clientOverlayStyle) {
454         if (clientOverlayStyle.value() != oldOverlayStyle)
455             setScrollbarOverlayStyle(clientOverlayStyle.value());
456         return;
457     }
458
459     ScrollbarOverlayStyle computedOverlayStyle = ScrollbarOverlayStyleDefault;
460
461     Color backgroundColor = documentBackgroundColor();
462     if (backgroundColor.isValid()) {
463         // Reduce the background color from RGB to a lightness value
464         // and determine which scrollbar style to use based on a lightness
465         // heuristic.
466         double hue, saturation, lightness;
467         backgroundColor.getHSL(hue, saturation, lightness);
468         if (lightness <= .5 && backgroundColor.isVisible())
469             computedOverlayStyle = ScrollbarOverlayStyleLight;
470     }
471
472     if (oldOverlayStyle != computedOverlayStyle)
473         setScrollbarOverlayStyle(computedOverlayStyle);
474 }
475
476 void FrameView::clear()
477 {
478     setCanBlitOnScroll(true);
479     
480     reset();
481
482     setScrollbarsSuppressed(true);
483
484 #if PLATFORM(IOS)
485     // To avoid flashes of white, disable tile updates immediately when view is cleared at the beginning of a page load.
486     // Tiling will be re-enabled from UIKit via [WAKWindow setTilingMode:] when we have content to draw.
487     if (LegacyTileCache* tileCache = legacyTileCache())
488         tileCache->setTilingMode(LegacyTileCache::Disabled);
489 #endif
490 }
491
492 #if PLATFORM(IOS)
493 void FrameView::didReplaceMultipartContent()
494 {
495     // Re-enable tile updates that were disabled in clear().
496     if (LegacyTileCache* tileCache = legacyTileCache())
497         tileCache->setTilingMode(LegacyTileCache::Normal);
498 }
499 #endif
500
501 bool FrameView::didFirstLayout() const
502 {
503     return !m_firstLayout;
504 }
505
506 void FrameView::invalidateRect(const IntRect& rect)
507 {
508     if (!parent()) {
509         if (auto* page = frame().page())
510             page->chrome().invalidateContentsAndRootView(rect);
511         return;
512     }
513
514     auto* renderer = frame().ownerRenderer();
515     if (!renderer)
516         return;
517
518     IntRect repaintRect = rect;
519     repaintRect.move(renderer->borderLeft() + renderer->paddingLeft(), renderer->borderTop() + renderer->paddingTop());
520     renderer->repaintRectangle(repaintRect);
521 }
522
523 void FrameView::setFrameRect(const IntRect& newRect)
524 {
525     Ref<FrameView> protectedThis(*this);
526     IntRect oldRect = frameRect();
527     if (newRect == oldRect)
528         return;
529
530     ScrollView::setFrameRect(newRect);
531
532     updateScrollableAreaSet();
533
534     if (RenderView* renderView = this->renderView()) {
535         if (renderView->usesCompositing())
536             renderView->compositor().frameViewDidChangeSize();
537     }
538
539     if (frame().isMainFrame())
540         frame().mainFrame().pageOverlayController().didChangeViewSize();
541
542     viewportContentsChanged();
543 }
544
545 bool FrameView::scheduleAnimation()
546 {
547     auto* page = frame().page();
548     if (!page)
549         return false;
550     page->chrome().scheduleAnimation();
551     return true;
552 }
553
554 void FrameView::setMarginWidth(LayoutUnit w)
555 {
556     // make it update the rendering area when set
557     m_margins.setWidth(w);
558 }
559
560 void FrameView::setMarginHeight(LayoutUnit h)
561 {
562     // make it update the rendering area when set
563     m_margins.setHeight(h);
564 }
565
566 bool FrameView::frameFlatteningEnabled() const
567 {
568     return frame().settings().frameFlatteningEnabled();
569 }
570
571 bool FrameView::isFrameFlatteningValidForThisFrame() const
572 {
573     if (!frameFlatteningEnabled())
574         return false;
575
576     HTMLFrameOwnerElement* owner = frame().ownerElement();
577     if (!owner)
578         return false;
579
580     // Frame flattening is valid only for <frame> and <iframe>.
581     return owner->hasTagName(frameTag) || owner->hasTagName(iframeTag);
582 }
583
584 bool FrameView::avoidScrollbarCreation() const
585 {
586     // with frame flattening no subframe can have scrollbars
587     // but we also cannot turn scrollbars off as we determine
588     // our flattening policy using that.
589     return isFrameFlatteningValidForThisFrame();
590 }
591
592 void FrameView::setCanHaveScrollbars(bool canHaveScrollbars)
593 {
594     m_canHaveScrollbars = canHaveScrollbars;
595     ScrollView::setCanHaveScrollbars(canHaveScrollbars);
596 }
597
598 void FrameView::updateCanHaveScrollbars()
599 {
600     ScrollbarMode hMode;
601     ScrollbarMode vMode;
602     scrollbarModes(hMode, vMode);
603     if (hMode == ScrollbarAlwaysOff && vMode == ScrollbarAlwaysOff)
604         setCanHaveScrollbars(false);
605     else
606         setCanHaveScrollbars(true);
607 }
608
609 Ref<Scrollbar> FrameView::createScrollbar(ScrollbarOrientation orientation)
610 {
611     if (!frame().settings().allowCustomScrollbarInMainFrame() && frame().isMainFrame())
612         return ScrollView::createScrollbar(orientation);
613
614     // FIXME: We need to update the scrollbar dynamically as documents change (or as doc elements and bodies get discovered that have custom styles).
615     Document* doc = frame().document();
616
617     // Try the <body> element first as a scrollbar source.
618     HTMLElement* body = doc ? doc->bodyOrFrameset() : nullptr;
619     if (body && body->renderer() && body->renderer()->style().hasPseudoStyle(SCROLLBAR))
620         return RenderScrollbar::createCustomScrollbar(*this, orientation, body);
621     
622     // If the <body> didn't have a custom style, then the root element might.
623     Element* docElement = doc ? doc->documentElement() : nullptr;
624     if (docElement && docElement->renderer() && docElement->renderer()->style().hasPseudoStyle(SCROLLBAR))
625         return RenderScrollbar::createCustomScrollbar(*this, orientation, docElement);
626         
627     // If we have an owning iframe/frame element, then it can set the custom scrollbar also.
628     RenderWidget* frameRenderer = frame().ownerRenderer();
629     if (frameRenderer && frameRenderer->style().hasPseudoStyle(SCROLLBAR))
630         return RenderScrollbar::createCustomScrollbar(*this, orientation, nullptr, &frame());
631     
632     // Nobody set a custom style, so we just use a native scrollbar.
633     return ScrollView::createScrollbar(orientation);
634 }
635
636 void FrameView::didRestoreFromPageCache()
637 {
638     // When restoring from page cache, the main frame stays in place while subframes get swapped in.
639     // We update the scrollable area set to ensure that scrolling data structures get invalidated.
640     updateScrollableAreaSet();
641 }
642
643 void FrameView::willDestroyRenderTree()
644 {
645     detachCustomScrollbars();
646     m_layoutRoot = nullptr;
647 }
648
649 void FrameView::didDestroyRenderTree()
650 {
651     ASSERT(!m_layoutRoot);
652     ASSERT(m_widgetsInRenderTree.isEmpty());
653
654     // If the render tree is destroyed below FrameView::updateEmbeddedObjects(), there will still be a null sentinel in the set.
655     // Everything else should have removed itself as the tree was felled.
656     ASSERT(!m_embeddedObjectsToUpdate || m_embeddedObjectsToUpdate->isEmpty() || (m_embeddedObjectsToUpdate->size() == 1 && m_embeddedObjectsToUpdate->first() == nullptr));
657
658     ASSERT(!m_viewportConstrainedObjects || m_viewportConstrainedObjects->isEmpty());
659     ASSERT(!m_slowRepaintObjects || m_slowRepaintObjects->isEmpty());
660
661     ASSERT(!frame().animation().hasAnimations());
662 }
663
664 void FrameView::setContentsSize(const IntSize& size)
665 {
666     if (size == contentsSize())
667         return;
668
669     m_deferSetNeedsLayoutCount++;
670
671     ScrollView::setContentsSize(size);
672     contentsResized();
673     
674     Page* page = frame().page();
675     if (!page)
676         return;
677
678     updateScrollableAreaSet();
679
680     page->chrome().contentsSizeChanged(&frame(), size); // Notify only.
681
682     if (frame().isMainFrame()) {
683         frame().mainFrame().pageOverlayController().didChangeDocumentSize();
684         PageCache::singleton().markPagesForContentsSizeChanged(*page);
685     }
686
687     ASSERT(m_deferSetNeedsLayoutCount);
688     m_deferSetNeedsLayoutCount--;
689     
690     if (!m_deferSetNeedsLayoutCount)
691         m_setNeedsLayoutWasDeferred = false; // FIXME: Find a way to make the deferred layout actually happen.
692 }
693
694 void FrameView::adjustViewSize()
695 {
696     RenderView* renderView = this->renderView();
697     if (!renderView)
698         return;
699
700     ASSERT(frame().view() == this);
701
702     const IntRect rect = renderView->documentRect();
703     const IntSize& size = rect.size();
704     ScrollView::setScrollOrigin(IntPoint(-rect.x(), -rect.y()), !frame().document()->printing(), size == contentsSize());
705
706     LOG_WITH_STREAM(Layout, stream << "FrameView " << this << " adjustViewSize: unscaled document rect changed to " << renderView->unscaledDocumentRect() << " (scaled to " << size << ")");
707
708     setContentsSize(size);
709 }
710
711 void FrameView::applyOverflowToViewport(const RenderElement& renderer, ScrollbarMode& hMode, ScrollbarMode& vMode)
712 {
713     // Handle the overflow:hidden/scroll case for the body/html elements.  WinIE treats
714     // overflow:hidden and overflow:scroll on <body> as applying to the document's
715     // scrollbars.  The CSS2.1 draft states that HTML UAs should use the <html> or <body> element and XML/XHTML UAs should
716     // use the root element.
717
718     // To combat the inability to scroll on a page with overflow:hidden on the root when scaled, disregard hidden when
719     // there is a frameScaleFactor that is greater than one on the main frame. Also disregard hidden if there is a
720     // header or footer.
721
722     bool overrideHidden = frame().isMainFrame() && ((frame().frameScaleFactor() > 1) || headerHeight() || footerHeight());
723
724     EOverflow overflowX = renderer.style().overflowX();
725     EOverflow overflowY = renderer.style().overflowY();
726
727     if (is<RenderSVGRoot>(renderer)) {
728         // FIXME: evaluate if we can allow overflow for these cases too.
729         // Overflow is always hidden when stand-alone SVG documents are embedded.
730         if (downcast<RenderSVGRoot>(renderer).isEmbeddedThroughFrameContainingSVGDocument()) {
731             overflowX = OHIDDEN;
732             overflowY = OHIDDEN;
733         }
734     }
735
736     switch (overflowX) {
737         case OHIDDEN:
738             if (overrideHidden)
739                 hMode = ScrollbarAuto;
740             else
741                 hMode = ScrollbarAlwaysOff;
742             break;
743         case OSCROLL:
744             hMode = ScrollbarAlwaysOn;
745             break;
746         case OAUTO:
747             hMode = ScrollbarAuto;
748             break;
749         default:
750             // Don't set it at all.
751             ;
752     }
753     
754      switch (overflowY) {
755         case OHIDDEN:
756             if (overrideHidden)
757                 vMode = ScrollbarAuto;
758             else
759                 vMode = ScrollbarAlwaysOff;
760             break;
761         case OSCROLL:
762             vMode = ScrollbarAlwaysOn;
763             break;
764         case OAUTO:
765             vMode = ScrollbarAuto;
766             break;
767         default:
768             // Don't set it at all. Values of OPAGEDX and OPAGEDY are handled by applyPaginationToViewPort().
769             ;
770     }
771 }
772
773 void FrameView::applyPaginationToViewport()
774 {
775     auto* document = frame().document();
776     auto* documentElement = document ? document->documentElement() : nullptr;
777     if (!documentElement || !documentElement->renderer()) {
778         setPagination(Pagination());
779         return;
780     }
781
782     auto& documentRenderer = *documentElement->renderer();
783     auto* documentOrBodyRenderer = &documentRenderer;
784
785     auto* body = document->body();
786     if (body && body->renderer()) {
787         documentOrBodyRenderer = documentRenderer.style().overflowX() == OVISIBLE && is<HTMLHtmlElement>(*documentElement) ?
788             body->renderer() : &documentRenderer;
789     }
790
791     Pagination pagination;
792     EOverflow overflowY = documentOrBodyRenderer->style().overflowY();
793     if (overflowY == OPAGEDX || overflowY == OPAGEDY) {
794         pagination.mode = WebCore::paginationModeForRenderStyle(documentOrBodyRenderer->style());
795         pagination.gap = static_cast<unsigned>(documentOrBodyRenderer->style().columnGap());
796     }
797     setPagination(pagination);
798 }
799
800 void FrameView::calculateScrollbarModesForLayout(ScrollbarMode& hMode, ScrollbarMode& vMode, ScrollbarModesCalculationStrategy strategy)
801 {
802     m_viewportRendererType = ViewportRendererType::None;
803
804     const HTMLFrameOwnerElement* owner = frame().ownerElement();
805     if (owner && (owner->scrollingMode() == ScrollbarAlwaysOff)) {
806         hMode = ScrollbarAlwaysOff;
807         vMode = ScrollbarAlwaysOff;
808         return;
809     }  
810     
811     if (m_canHaveScrollbars || strategy == RulesFromWebContentOnly) {
812         hMode = ScrollbarAuto;
813         vMode = ScrollbarAuto;
814     } else {
815         hMode = ScrollbarAlwaysOff;
816         vMode = ScrollbarAlwaysOff;
817     }
818     
819     if (m_layoutRoot)
820         return;
821     
822     auto* document = frame().document();
823     if (!document)
824         return;
825
826     auto* documentElement = document->documentElement();
827     if (!documentElement)
828         return;
829
830     auto* bodyOrFrameset = document->bodyOrFrameset();
831     auto* rootRenderer = documentElement->renderer();
832     if (!bodyOrFrameset || !bodyOrFrameset->renderer()) {
833         if (rootRenderer) {
834             applyOverflowToViewport(*rootRenderer, hMode, vMode);
835             m_viewportRendererType = ViewportRendererType::Document;
836         }
837         return;
838     }
839     
840     if (is<HTMLFrameSetElement>(*bodyOrFrameset) && !frameFlatteningEnabled()) {
841         vMode = ScrollbarAlwaysOff;
842         hMode = ScrollbarAlwaysOff;
843         return;
844     }
845
846     if (is<HTMLBodyElement>(*bodyOrFrameset) && rootRenderer) {
847         // It's sufficient to just check the X overflow,
848         // since it's illegal to have visible in only one direction.
849         if (rootRenderer->style().overflowX() == OVISIBLE && is<HTMLHtmlElement>(documentElement)) {
850             auto* bodyRenderer = bodyOrFrameset->renderer();
851             if (bodyRenderer) {
852                 applyOverflowToViewport(*bodyRenderer, hMode, vMode);
853                 m_viewportRendererType = ViewportRendererType::Body;
854             }
855         } else {
856             applyOverflowToViewport(*rootRenderer, hMode, vMode);
857             m_viewportRendererType = ViewportRendererType::Document;
858         }
859     }
860 }
861
862 void FrameView::willRecalcStyle()
863 {
864     RenderView* renderView = this->renderView();
865     if (!renderView)
866         return;
867
868     renderView->compositor().willRecalcStyle();
869 }
870
871 bool FrameView::updateCompositingLayersAfterStyleChange()
872 {
873     RenderView* renderView = this->renderView();
874     if (!renderView)
875         return false;
876
877     // If we expect to update compositing after an incipient layout, don't do so here.
878     if (inPreLayoutStyleUpdate() || layoutPending() || renderView->needsLayout())
879         return false;
880
881     return renderView->compositor().didRecalcStyleWithNoPendingLayout();
882 }
883
884 void FrameView::updateCompositingLayersAfterLayout()
885 {
886     RenderView* renderView = this->renderView();
887     if (!renderView)
888         return;
889
890     // This call will make sure the cached hasAcceleratedCompositing is updated from the pref
891     renderView->compositor().cacheAcceleratedCompositingFlags();
892     renderView->compositor().updateCompositingLayers(CompositingUpdateAfterLayout);
893 }
894
895 void FrameView::clearBackingStores()
896 {
897     RenderView* renderView = this->renderView();
898     if (!renderView)
899         return;
900
901     RenderLayerCompositor& compositor = renderView->compositor();
902     ASSERT(compositor.inCompositingMode());
903     compositor.enableCompositingMode(false);
904     compositor.clearBackingForAllLayers();
905 }
906
907 GraphicsLayer* FrameView::layerForScrolling() const
908 {
909     RenderView* renderView = this->renderView();
910     if (!renderView)
911         return nullptr;
912     return renderView->compositor().scrollLayer();
913 }
914
915 GraphicsLayer* FrameView::layerForHorizontalScrollbar() const
916 {
917     RenderView* renderView = this->renderView();
918     if (!renderView)
919         return nullptr;
920     return renderView->compositor().layerForHorizontalScrollbar();
921 }
922
923 GraphicsLayer* FrameView::layerForVerticalScrollbar() const
924 {
925     RenderView* renderView = this->renderView();
926     if (!renderView)
927         return nullptr;
928     return renderView->compositor().layerForVerticalScrollbar();
929 }
930
931 GraphicsLayer* FrameView::layerForScrollCorner() const
932 {
933     RenderView* renderView = this->renderView();
934     if (!renderView)
935         return nullptr;
936     return renderView->compositor().layerForScrollCorner();
937 }
938
939 TiledBacking* FrameView::tiledBacking() const
940 {
941     RenderView* renderView = this->renderView();
942     if (!renderView)
943         return nullptr;
944
945     RenderLayerBacking* backing = renderView->layer()->backing();
946     if (!backing)
947         return nullptr;
948
949     return backing->graphicsLayer()->tiledBacking();
950 }
951
952 uint64_t FrameView::scrollLayerID() const
953 {
954     RenderView* renderView = this->renderView();
955     if (!renderView)
956         return 0;
957
958     RenderLayerBacking* backing = renderView->layer()->backing();
959     if (!backing)
960         return 0;
961
962     return backing->scrollingNodeIDForRole(Scrolling);
963 }
964
965 ScrollableArea* FrameView::scrollableAreaForScrollLayerID(uint64_t nodeID) const
966 {
967     RenderView* renderView = this->renderView();
968     if (!renderView)
969         return nullptr;
970
971     return renderView->compositor().scrollableAreaForScrollLayerID(nodeID);
972 }
973
974 #if ENABLE(RUBBER_BANDING)
975 GraphicsLayer* FrameView::layerForOverhangAreas() const
976 {
977     RenderView* renderView = this->renderView();
978     if (!renderView)
979         return nullptr;
980     return renderView->compositor().layerForOverhangAreas();
981 }
982
983 GraphicsLayer* FrameView::setWantsLayerForTopOverHangArea(bool wantsLayer) const
984 {
985     RenderView* renderView = this->renderView();
986     if (!renderView)
987         return nullptr;
988
989     return renderView->compositor().updateLayerForTopOverhangArea(wantsLayer);
990 }
991
992 GraphicsLayer* FrameView::setWantsLayerForBottomOverHangArea(bool wantsLayer) const
993 {
994     RenderView* renderView = this->renderView();
995     if (!renderView)
996         return nullptr;
997
998     return renderView->compositor().updateLayerForBottomOverhangArea(wantsLayer);
999 }
1000
1001 #endif // ENABLE(RUBBER_BANDING)
1002
1003 #if ENABLE(CSS_SCROLL_SNAP)
1004 void FrameView::updateSnapOffsets()
1005 {
1006     if (!frame().document())
1007         return;
1008
1009     // FIXME: Should we allow specifying snap points through <html> tags too?
1010     HTMLElement* body = frame().document()->bodyOrFrameset();
1011     if (!renderView() || !body || !body->renderer())
1012         return;
1013     
1014     updateSnapOffsetsForScrollableArea(*this, *body, *renderView(), body->renderer()->style());
1015 }
1016
1017 bool FrameView::isScrollSnapInProgress() const
1018 {
1019     if (scrollbarsSuppressed())
1020         return false;
1021     
1022     // If the scrolling thread updates the scroll position for this FrameView, then we should return
1023     // ScrollingCoordinator::isScrollSnapInProgress().
1024     if (Page* page = frame().page()) {
1025         if (ScrollingCoordinator* scrollingCoordinator = page->scrollingCoordinator()) {
1026             if (!scrollingCoordinator->shouldUpdateScrollLayerPositionSynchronously(*this))
1027                 return scrollingCoordinator->isScrollSnapInProgress();
1028         }
1029     }
1030     
1031     // If the main thread updates the scroll position for this FrameView, we should return
1032     // ScrollAnimator::isScrollSnapInProgress().
1033     if (ScrollAnimator* scrollAnimator = existingScrollAnimator())
1034         return scrollAnimator->isScrollSnapInProgress();
1035     
1036     return false;
1037 }
1038
1039 void FrameView::updateScrollingCoordinatorScrollSnapProperties() const
1040 {
1041     renderView()->compositor().updateScrollSnapPropertiesWithFrameView(*this);
1042 }
1043 #endif
1044
1045 bool FrameView::flushCompositingStateForThisFrame(const Frame& rootFrameForFlush)
1046 {
1047     RenderView* renderView = this->renderView();
1048     if (!renderView)
1049         return true; // We don't want to keep trying to update layers if we have no renderer.
1050
1051     ASSERT(frame().view() == this);
1052
1053     // If we sync compositing layers when a layout is pending, we may cause painting of compositing
1054     // layer content to occur before layout has happened, which will cause paintContents() to bail.
1055     if (needsLayout())
1056         return false;
1057
1058 #if PLATFORM(IOS)
1059     if (LegacyTileCache* tileCache = legacyTileCache())
1060         tileCache->doPendingRepaints();
1061 #endif
1062
1063     renderView->compositor().flushPendingLayerChanges(&rootFrameForFlush == m_frame.ptr());
1064     return true;
1065 }
1066
1067 void FrameView::setNeedsOneShotDrawingSynchronization()
1068 {
1069     if (Page* page = frame().page())
1070         page->chrome().client().setNeedsOneShotDrawingSynchronization();
1071 }
1072
1073 GraphicsLayer* FrameView::graphicsLayerForPlatformWidget(PlatformWidget platformWidget)
1074 {
1075     // To find the Widget that corresponds with platformWidget we have to do a linear
1076     // search of our child widgets.
1077     const Widget* foundWidget = nullptr;
1078     for (auto& widget : children()) {
1079         if (widget->platformWidget() != platformWidget)
1080             continue;
1081         foundWidget = widget.ptr();
1082         break;
1083     }
1084
1085     if (!foundWidget)
1086         return nullptr;
1087
1088     auto* renderWidget = RenderWidget::find(*foundWidget);
1089     if (!renderWidget)
1090         return nullptr;
1091
1092     auto* widgetLayer = renderWidget->layer();
1093     if (!widgetLayer || !widgetLayer->isComposited())
1094         return nullptr;
1095
1096     return widgetLayer->backing()->parentForSublayers();
1097 }
1098
1099 void FrameView::scheduleLayerFlushAllowingThrottling()
1100 {
1101     RenderView* view = this->renderView();
1102     if (!view)
1103         return;
1104     view->compositor().scheduleLayerFlush(true /* canThrottle */);
1105 }
1106
1107 LayoutRect FrameView::fixedScrollableAreaBoundsInflatedForScrolling(const LayoutRect& uninflatedBounds) const
1108 {
1109     LayoutPoint scrollPosition;
1110     LayoutSize topLeftExpansion;
1111     LayoutSize bottomRightExpansion;
1112
1113     if (frame().settings().visualViewportEnabled()) {
1114         // FIXME: this is wrong under zooming; uninflatedBounds is scaled but the scroll positions are not.
1115         scrollPosition = layoutViewportRect().location();
1116         topLeftExpansion = scrollPosition - unscaledMinimumScrollPosition();
1117         bottomRightExpansion = unscaledMaximumScrollPosition() - scrollPosition;
1118     } else {
1119         scrollPosition = scrollPositionRespectingCustomFixedPosition();
1120         topLeftExpansion = scrollPosition - minimumScrollPosition();
1121         bottomRightExpansion = maximumScrollPosition() - scrollPosition;
1122     }
1123
1124     return LayoutRect(uninflatedBounds.location() - topLeftExpansion, uninflatedBounds.size() + topLeftExpansion + bottomRightExpansion);
1125 }
1126
1127 LayoutPoint FrameView::scrollPositionRespectingCustomFixedPosition() const
1128 {
1129 #if PLATFORM(IOS)
1130     if (!frame().settings().visualViewportEnabled())
1131         return useCustomFixedPositionLayoutRect() ? customFixedPositionLayoutRect().location() : scrollPosition();
1132 #endif
1133
1134     return scrollPositionForFixedPosition();
1135 }
1136
1137 void FrameView::setHeaderHeight(int headerHeight)
1138 {
1139     if (frame().page())
1140         ASSERT(frame().isMainFrame());
1141     m_headerHeight = headerHeight;
1142
1143     if (RenderView* renderView = this->renderView())
1144         renderView->setNeedsLayout();
1145 }
1146
1147 void FrameView::setFooterHeight(int footerHeight)
1148 {
1149     if (frame().page())
1150         ASSERT(frame().isMainFrame());
1151     m_footerHeight = footerHeight;
1152
1153     if (RenderView* renderView = this->renderView())
1154         renderView->setNeedsLayout();
1155 }
1156
1157 float FrameView::topContentInset(TopContentInsetType contentInsetTypeToReturn) const
1158 {
1159     if (platformWidget() && contentInsetTypeToReturn == TopContentInsetType::WebCoreOrPlatformContentInset)
1160         return platformTopContentInset();
1161
1162     if (!frame().isMainFrame())
1163         return 0;
1164     
1165     Page* page = frame().page();
1166     return page ? page->topContentInset() : 0;
1167 }
1168     
1169 void FrameView::topContentInsetDidChange(float newTopContentInset)
1170 {
1171     RenderView* renderView = this->renderView();
1172     if (!renderView)
1173         return;
1174
1175     if (platformWidget())
1176         platformSetTopContentInset(newTopContentInset);
1177     
1178     layout();
1179
1180     updateScrollbars(scrollPosition());
1181     if (renderView->usesCompositing())
1182         renderView->compositor().frameViewDidChangeSize();
1183
1184     if (TiledBacking* tiledBacking = this->tiledBacking())
1185         tiledBacking->setTopContentInset(newTopContentInset);
1186 }
1187
1188 void FrameView::topContentDirectionDidChange()
1189 {
1190     m_needsDeferredScrollbarsUpdate = true;
1191 }
1192
1193 void FrameView::handleDeferredScrollbarsUpdateAfterDirectionChange()
1194 {
1195     if (!m_needsDeferredScrollbarsUpdate)
1196         return;
1197
1198     m_needsDeferredScrollbarsUpdate = false;
1199
1200     ASSERT(m_layoutPhase == InPostLayerPositionsUpdatedAfterLayout);
1201     updateScrollbars(scrollPosition());
1202     positionScrollbarLayers();
1203 }
1204     
1205 bool FrameView::hasCompositedContent() const
1206 {
1207     if (RenderView* renderView = this->renderView())
1208         return renderView->compositor().inCompositingMode();
1209     return false;
1210 }
1211
1212 // Sometimes (for plug-ins) we need to eagerly go into compositing mode.
1213 void FrameView::enterCompositingMode()
1214 {
1215     if (RenderView* renderView = this->renderView()) {
1216         renderView->compositor().enableCompositingMode();
1217         if (!needsLayout())
1218             renderView->compositor().scheduleCompositingLayerUpdate();
1219     }
1220 }
1221
1222 bool FrameView::isEnclosedInCompositingLayer() const
1223 {
1224     auto frameOwnerRenderer = frame().ownerRenderer();
1225     if (frameOwnerRenderer && frameOwnerRenderer->containerForRepaint())
1226         return true;
1227
1228     if (FrameView* parentView = parentFrameView())
1229         return parentView->isEnclosedInCompositingLayer();
1230     return false;
1231 }
1232
1233 bool FrameView::flushCompositingStateIncludingSubframes()
1234 {
1235     InspectorInstrumentation::willComposite(frame());
1236
1237     bool allFramesFlushed = flushCompositingStateForThisFrame(frame());
1238
1239     for (Frame* child = frame().tree().firstRenderedChild(); child; child = child->tree().traverseNextRendered(m_frame.ptr())) {
1240         if (!child->view())
1241             continue;
1242         bool flushed = child->view()->flushCompositingStateForThisFrame(frame());
1243         allFramesFlushed &= flushed;
1244     }
1245     return allFramesFlushed;
1246 }
1247
1248 bool FrameView::isSoftwareRenderable() const
1249 {
1250     RenderView* renderView = this->renderView();
1251     return !renderView || !renderView->compositor().has3DContent();
1252 }
1253
1254 void FrameView::setIsInWindow(bool isInWindow)
1255 {
1256     if (RenderView* renderView = this->renderView())
1257         renderView->setIsInWindow(isInWindow);
1258 }
1259
1260 inline void FrameView::forceLayoutParentViewIfNeeded()
1261 {
1262     RenderWidget* ownerRenderer = frame().ownerRenderer();
1263     if (!ownerRenderer)
1264         return;
1265
1266     RenderBox* contentBox = embeddedContentBox();
1267     if (!contentBox)
1268         return;
1269
1270     auto& svgRoot = downcast<RenderSVGRoot>(*contentBox);
1271     if (svgRoot.everHadLayout() && !svgRoot.needsLayout())
1272         return;
1273
1274     LOG(Layout, "FrameView %p forceLayoutParentViewIfNeeded scheduling layout on parent FrameView %p", this, &ownerRenderer->view().frameView());
1275
1276     // If the embedded SVG document appears the first time, the ownerRenderer has already finished
1277     // layout without knowing about the existence of the embedded SVG document, because RenderReplaced
1278     // embeddedContentBox() returns nullptr, as long as the embedded document isn't loaded yet. Before
1279     // bothering to lay out the SVG document, mark the ownerRenderer needing layout and ask its
1280     // FrameView for a layout. After that the RenderEmbeddedObject (ownerRenderer) carries the
1281     // correct size, which RenderSVGRoot::computeReplacedLogicalWidth/Height rely on, when laying
1282     // out for the first time, or when the RenderSVGRoot size has changed dynamically (eg. via <script>).
1283
1284     ownerRenderer->setNeedsLayoutAndPrefWidthsRecalc();
1285     ownerRenderer->view().frameView().scheduleRelayout();
1286 }
1287
1288 void FrameView::layout(bool allowSubtree)
1289 {
1290     LOG(Layout, "FrameView %p (%dx%d) layout, main frameview %d, allowSubtree=%d", this, size().width(), size().height(), frame().isMainFrame(), allowSubtree);
1291     if (isInRenderTreeLayout()) {
1292         LOG(Layout, "  in layout, bailing");
1293         return;
1294     }
1295
1296     if (layoutDisallowed()) {
1297         LOG(Layout, "  layout is disallowed, bailing");
1298         return;
1299     }
1300
1301     // Protect the view from being deleted during layout (in recalcStyle).
1302     Ref<FrameView> protectedThis(*this);
1303
1304     // Many of the tasks performed during layout can cause this function to be re-entered,
1305     // so save the layout phase now and restore it on exit.
1306     SetForScope<LayoutPhase> layoutPhaseRestorer(m_layoutPhase, InPreLayout);
1307
1308     // Every scroll that happens during layout is programmatic.
1309     SetForScope<bool> changeInProgrammaticScroll(m_inProgrammaticScroll, true);
1310
1311     bool inChildFrameLayoutWithFrameFlattening = isInChildFrameWithFrameFlattening();
1312
1313     if (inChildFrameLayoutWithFrameFlattening) {
1314         startLayoutAtMainFrameViewIfNeeded(allowSubtree);
1315         RenderElement* root = m_layoutRoot ? m_layoutRoot : frame().document()->renderView();
1316         if (!root || !root->needsLayout())
1317             return;
1318     }
1319     
1320     TraceScope tracingScope(LayoutStart, LayoutEnd);
1321
1322 #if PLATFORM(IOS)
1323     if (updateFixedPositionLayoutRect())
1324         allowSubtree = false;
1325 #endif
1326
1327     m_layoutTimer.stop();
1328     m_delayedLayout = false;
1329     m_setNeedsLayoutWasDeferred = false;
1330     
1331     // we shouldn't enter layout() while painting
1332     ASSERT(!isPainting());
1333     if (isPainting())
1334         return;
1335
1336     InspectorInstrumentationCookie cookie = InspectorInstrumentation::willLayout(frame());
1337     AnimationUpdateBlock animationUpdateBlock(&frame().animation());
1338     
1339     if (!allowSubtree && m_layoutRoot)
1340         convertSubtreeLayoutToFullLayout();
1341
1342     ASSERT(frame().view() == this);
1343     ASSERT(frame().document());
1344
1345     Document& document = *frame().document();
1346     ASSERT(document.pageCacheState() == Document::NotInPageCache);
1347
1348     {
1349         SetForScope<bool> changeSchedulingEnabled(m_layoutSchedulingEnabled, false);
1350
1351         if (!m_nestedLayoutCount && !m_inSynchronousPostLayout && m_postLayoutTasksTimer.isActive() && !inChildFrameLayoutWithFrameFlattening) {
1352             // This is a new top-level layout. If there are any remaining tasks from the previous
1353             // layout, finish them now.
1354             SetForScope<bool> inSynchronousPostLayoutChange(m_inSynchronousPostLayout, true);
1355             performPostLayoutTasks();
1356         }
1357
1358         m_layoutPhase = InPreLayoutStyleUpdate;
1359
1360         // Viewport-dependent media queries may cause us to need completely different style information.
1361         auto* styleResolver = document.styleScope().resolverIfExists();
1362         if (!styleResolver || styleResolver->hasMediaQueriesAffectedByViewportChange()) {
1363             LOG(Layout, "  hasMediaQueriesAffectedByViewportChange, enqueueing style recalc");
1364             document.styleScope().didChangeStyleSheetEnvironment();
1365             // FIXME: This instrumentation event is not strictly accurate since cached media query results do not persist across StyleResolver rebuilds.
1366             InspectorInstrumentation::mediaQueryResultChanged(document);
1367         } else
1368             document.evaluateMediaQueryList();
1369
1370         // If there is any pagination to apply, it will affect the RenderView's style, so we should
1371         // take care of that now.
1372         applyPaginationToViewport();
1373
1374         // Always ensure our style info is up-to-date. This can happen in situations where
1375         // the layout beats any sort of style recalc update that needs to occur.
1376         document.updateStyleIfNeeded();
1377         // If there is only one ref to this view left, then its going to be destroyed as soon as we exit,
1378         // so there's no point to continuing to layout
1379         if (hasOneRef())
1380             return;
1381
1382         // Close block here so we can set up the font cache purge preventer, which we will still
1383         // want in scope even after we want m_layoutSchedulingEnabled to be restored again.
1384         // The next block sets m_layoutSchedulingEnabled back to false once again.
1385     }
1386
1387     m_layoutPhase = InPreLayout;
1388
1389     RenderLayer* layer = nullptr;
1390     bool subtree = false;
1391     RenderElement* root = nullptr;
1392
1393     ++m_nestedLayoutCount;
1394
1395     {
1396         SetForScope<bool> changeSchedulingEnabled(m_layoutSchedulingEnabled, false);
1397
1398         autoSizeIfEnabled();
1399
1400         root = m_layoutRoot ? m_layoutRoot : document.renderView();
1401         if (!root)
1402             return;
1403         subtree = m_layoutRoot;
1404
1405         if (!m_layoutRoot) {
1406             auto* body = document.bodyOrFrameset();
1407             if (body && body->renderer()) {
1408                 if (is<HTMLFrameSetElement>(*body) && !frameFlatteningEnabled()) {
1409                     body->renderer()->setChildNeedsLayout();
1410                 } else if (is<HTMLBodyElement>(*body)) {
1411                     if (!m_firstLayout && m_size.height() != layoutHeight() && body->renderer()->enclosingBox().stretchesToViewport())
1412                         body->renderer()->setChildNeedsLayout();
1413                 }
1414             }
1415
1416 #if !LOG_DISABLED
1417             if (m_firstLayout && !frame().ownerElement())
1418                 LOG(Layout, "FrameView %p elapsed time before first layout: %.3fs\n", this, document.timeSinceDocumentCreation().value());
1419 #endif
1420         }
1421
1422         m_needsFullRepaint = !subtree && (m_firstLayout || downcast<RenderView>(*root).printing());
1423
1424         if (!subtree) {
1425             ScrollbarMode hMode;
1426             ScrollbarMode vMode;    
1427             calculateScrollbarModesForLayout(hMode, vMode);
1428
1429             if (m_firstLayout || (hMode != horizontalScrollbarMode() || vMode != verticalScrollbarMode())) {
1430                 if (m_firstLayout) {
1431                     setScrollbarsSuppressed(true);
1432
1433                     m_firstLayout = false;
1434                     m_firstLayoutCallbackPending = true;
1435                     m_lastViewportSize = sizeForResizeEvent();
1436                     m_lastZoomFactor = root->style().zoom();
1437
1438                     // Set the initial vMode to AlwaysOn if we're auto.
1439                     if (vMode == ScrollbarAuto)
1440                         setVerticalScrollbarMode(ScrollbarAlwaysOn); // This causes a vertical scrollbar to appear.
1441                     // Set the initial hMode to AlwaysOff if we're auto.
1442                     if (hMode == ScrollbarAuto)
1443                         setHorizontalScrollbarMode(ScrollbarAlwaysOff); // This causes a horizontal scrollbar to disappear.
1444                     Page* page = frame().page();
1445                     if (page && page->expectsWheelEventTriggers())
1446                         scrollAnimator().setWheelEventTestTrigger(page->testTrigger());
1447                     setScrollbarModes(hMode, vMode);
1448                     setScrollbarsSuppressed(false, true);
1449                 } else
1450                     setScrollbarModes(hMode, vMode);
1451             }
1452
1453             LayoutSize oldSize = m_size;
1454             m_size = layoutSize();
1455
1456             if (oldSize != m_size) {
1457                 LOG(Layout, "  layout size changed from %.3fx%.3f to %.3fx%.3f", oldSize.width().toFloat(), oldSize.height().toFloat(), m_size.width().toFloat(), m_size.height().toFloat());
1458                 m_needsFullRepaint = true;
1459                 if (!m_firstLayout) {
1460                     RenderBox* rootRenderer = document.documentElement() ? document.documentElement()->renderBox() : nullptr;
1461                     auto* body = document.bodyOrFrameset();
1462                     RenderBox* bodyRenderer = rootRenderer && body ? body->renderBox() : nullptr;
1463                     if (bodyRenderer && bodyRenderer->stretchesToViewport())
1464                         bodyRenderer->setChildNeedsLayout();
1465                     else if (rootRenderer && rootRenderer->stretchesToViewport())
1466                         rootRenderer->setChildNeedsLayout();
1467                 }
1468             }
1469
1470             m_layoutPhase = InPreLayout;
1471         }
1472
1473         layer = root->enclosingLayer();
1474         SubtreeLayoutStateMaintainer subtreeLayoutStateMaintainer(m_layoutRoot);
1475
1476         RenderView::RepaintRegionAccumulator repaintRegionAccumulator(&root->view());
1477
1478         ASSERT(m_layoutPhase == InPreLayout);
1479         m_layoutPhase = InRenderTreeLayout;
1480
1481         forceLayoutParentViewIfNeeded();
1482
1483         ASSERT(m_layoutPhase == InRenderTreeLayout);
1484 #ifndef NDEBUG
1485         RenderTreeNeedsLayoutChecker checker(*root);
1486 #endif
1487         root->layout();
1488         ASSERT(!root->view().renderTreeIsBeingMutatedInternally());
1489
1490 #if ENABLE(TEXT_AUTOSIZING)
1491         if (frame().settings().textAutosizingEnabled() && !root->view().printing()) {
1492             float minimumZoomFontSize = frame().settings().minimumZoomFontSize();
1493             float textAutosizingWidth = frame().page() ? frame().page()->textAutosizingWidth() : 0;
1494             if (int overrideWidth = frame().settings().textAutosizingWindowSizeOverride().width())
1495                 textAutosizingWidth = overrideWidth;
1496
1497             LOG(TextAutosizing, "Text Autosizing: minimumZoomFontSize=%.2f textAutosizingWidth=%.2f", minimumZoomFontSize, textAutosizingWidth);
1498             
1499             if (minimumZoomFontSize && textAutosizingWidth) {
1500                 root->adjustComputedFontSizesOnBlocks(minimumZoomFontSize, textAutosizingWidth);
1501                 if (root->needsLayout())
1502                     root->layout();
1503             }
1504         }
1505 #endif
1506
1507         ASSERT(m_layoutPhase == InRenderTreeLayout);
1508         m_layoutRoot = nullptr;
1509         // Close block here to end the scope of changeSchedulingEnabled and SubtreeLayoutStateMaintainer.
1510     }
1511
1512     m_layoutPhase = InViewSizeAdjust;
1513
1514     bool neededFullRepaint = m_needsFullRepaint;
1515
1516     if (!subtree && !downcast<RenderView>(*root).printing())
1517         adjustViewSize();
1518
1519     m_layoutPhase = InPostLayout;
1520
1521     m_needsFullRepaint = neededFullRepaint;
1522
1523     // Now update the positions of all layers.
1524     if (m_needsFullRepaint)
1525         root->view().repaintRootContents();
1526
1527     root->view().releaseProtectedRenderWidgets();
1528
1529     ASSERT(!root->needsLayout());
1530
1531     layer->updateLayerPositionsAfterLayout(renderView()->layer(), updateLayerPositionFlags(layer, subtree, m_needsFullRepaint));
1532
1533     updateCompositingLayersAfterLayout();
1534
1535     m_layoutPhase = InPostLayerPositionsUpdatedAfterLayout;
1536
1537     m_layoutCount++;
1538
1539 #if PLATFORM(COCOA) || PLATFORM(WIN) || PLATFORM(GTK) || PLATFORM(EFL)
1540     if (AXObjectCache* cache = root->document().existingAXObjectCache())
1541         cache->postNotification(root, AXObjectCache::AXLayoutComplete);
1542 #endif
1543
1544 #if ENABLE(DASHBOARD_SUPPORT)
1545     updateAnnotatedRegions();
1546 #endif
1547
1548 #if ENABLE(IOS_TOUCH_EVENTS)
1549     document.dirtyTouchEventRects();
1550 #endif
1551
1552     updateCanBlitOnScrollRecursively();
1553
1554     handleDeferredScrollUpdateAfterContentSizeChange();
1555
1556     handleDeferredScrollbarsUpdateAfterDirectionChange();
1557
1558     if (document.hasListenerType(Document::OVERFLOWCHANGED_LISTENER))
1559         updateOverflowStatus(layoutWidth() < contentsWidth(), layoutHeight() < contentsHeight());
1560
1561     frame().document()->markers().invalidateRectsForAllMarkers();
1562
1563     if (!m_postLayoutTasksTimer.isActive()) {
1564         if (!m_inSynchronousPostLayout) {
1565             if (inChildFrameLayoutWithFrameFlattening)
1566                 updateWidgetPositions();
1567             else {
1568                 SetForScope<bool> inSynchronousPostLayoutChange(m_inSynchronousPostLayout, true);
1569                 performPostLayoutTasks(); // Calls resumeScheduledEvents().
1570             }
1571         }
1572
1573         if (!m_postLayoutTasksTimer.isActive() && (needsLayout() || m_inSynchronousPostLayout || inChildFrameLayoutWithFrameFlattening)) {
1574             // If we need layout or are already in a synchronous call to postLayoutTasks(), 
1575             // defer widget updates and event dispatch until after we return. postLayoutTasks()
1576             // can make us need to update again, and we can get stuck in a nasty cycle unless
1577             // we call it through the timer here.
1578             m_postLayoutTasksTimer.startOneShot(0);
1579             if (needsLayout())
1580                 layout();
1581         }
1582     }
1583
1584     InspectorInstrumentation::didLayout(cookie, *root);
1585     DebugPageOverlays::didLayout(frame());
1586
1587     --m_nestedLayoutCount;
1588 }
1589
1590 bool FrameView::shouldDeferScrollUpdateAfterContentSizeChange()
1591 {
1592     return (m_layoutPhase < InPostLayout) && (m_layoutPhase != OutsideLayout);
1593 }
1594
1595 RenderBox* FrameView::embeddedContentBox() const
1596 {
1597     RenderView* renderView = this->renderView();
1598     if (!renderView)
1599         return nullptr;
1600
1601     RenderObject* firstChild = renderView->firstChild();
1602
1603     // Curently only embedded SVG documents participate in the size-negotiation logic.
1604     if (is<RenderSVGRoot>(firstChild))
1605         return downcast<RenderSVGRoot>(firstChild);
1606
1607     return nullptr;
1608 }
1609
1610 void FrameView::addEmbeddedObjectToUpdate(RenderEmbeddedObject& embeddedObject)
1611 {
1612     if (!m_embeddedObjectsToUpdate)
1613         m_embeddedObjectsToUpdate = std::make_unique<ListHashSet<RenderEmbeddedObject*>>();
1614
1615     HTMLFrameOwnerElement& element = embeddedObject.frameOwnerElement();
1616     if (is<HTMLObjectElement>(element) || is<HTMLEmbedElement>(element)) {
1617         // Tell the DOM element that it needs a widget update.
1618         HTMLPlugInImageElement& pluginElement = downcast<HTMLPlugInImageElement>(element);
1619         if (!pluginElement.needsCheckForSizeChange())
1620             pluginElement.setNeedsWidgetUpdate(true);
1621     }
1622
1623     m_embeddedObjectsToUpdate->add(&embeddedObject);
1624 }
1625
1626 void FrameView::removeEmbeddedObjectToUpdate(RenderEmbeddedObject& embeddedObject)
1627 {
1628     if (!m_embeddedObjectsToUpdate)
1629         return;
1630
1631     m_embeddedObjectsToUpdate->remove(&embeddedObject);
1632 }
1633
1634 void FrameView::setMediaType(const String& mediaType)
1635 {
1636     m_mediaType = mediaType;
1637 }
1638
1639 String FrameView::mediaType() const
1640 {
1641     // See if we have an override type.
1642     String overrideType = frame().loader().client().overrideMediaType();
1643     InspectorInstrumentation::applyEmulatedMedia(frame(), overrideType);
1644     if (!overrideType.isNull())
1645         return overrideType;
1646     return m_mediaType;
1647 }
1648
1649 void FrameView::adjustMediaTypeForPrinting(bool printing)
1650 {
1651     if (printing) {
1652         if (m_mediaTypeWhenNotPrinting.isNull())
1653             m_mediaTypeWhenNotPrinting = mediaType();
1654         setMediaType("print");
1655     } else {
1656         if (!m_mediaTypeWhenNotPrinting.isNull())
1657             setMediaType(m_mediaTypeWhenNotPrinting);
1658         m_mediaTypeWhenNotPrinting = String();
1659     }
1660 }
1661
1662 bool FrameView::useSlowRepaints(bool considerOverlap) const
1663 {
1664     bool mustBeSlow = hasSlowRepaintObjects() || (platformWidget() && hasViewportConstrainedObjects());
1665
1666     // FIXME: WidgetMac.mm makes the assumption that useSlowRepaints ==
1667     // m_contentIsOpaque, so don't take the fast path for composited layers
1668     // if they are a platform widget in order to get painting correctness
1669     // for transparent layers. See the comment in WidgetMac::paint.
1670     if (usesCompositedScrolling() && !platformWidget())
1671         return mustBeSlow;
1672
1673     bool isOverlapped = m_isOverlapped && considerOverlap;
1674
1675     if (mustBeSlow || m_cannotBlitToWindow || isOverlapped || !m_contentIsOpaque)
1676         return true;
1677
1678     if (FrameView* parentView = parentFrameView())
1679         return parentView->useSlowRepaints(considerOverlap);
1680
1681     return false;
1682 }
1683
1684 bool FrameView::useSlowRepaintsIfNotOverlapped() const
1685 {
1686     return useSlowRepaints(false);
1687 }
1688
1689 void FrameView::updateCanBlitOnScrollRecursively()
1690 {
1691     for (auto* frame = m_frame.ptr(); frame; frame = frame->tree().traverseNext(m_frame.ptr())) {
1692         if (FrameView* view = frame->view())
1693             view->setCanBlitOnScroll(!view->useSlowRepaints());
1694     }
1695 }
1696
1697 bool FrameView::usesCompositedScrolling() const
1698 {
1699     RenderView* renderView = this->renderView();
1700     if (renderView && renderView->isComposited()) {
1701         GraphicsLayer* layer = renderView->layer()->backing()->graphicsLayer();
1702         if (layer && layer->drawsContent())
1703             return true;
1704     }
1705
1706     return false;
1707 }
1708
1709 bool FrameView::usesAsyncScrolling() const
1710 {
1711 #if ENABLE(ASYNC_SCROLLING)
1712     if (Page* page = frame().page()) {
1713         if (ScrollingCoordinator* scrollingCoordinator = page->scrollingCoordinator())
1714             return scrollingCoordinator->coordinatesScrollingForFrameView(*this);
1715     }
1716 #endif
1717     return false;
1718 }
1719
1720 bool FrameView::usesMockScrollAnimator() const
1721 {
1722     return Settings::usesMockScrollAnimator();
1723 }
1724
1725 void FrameView::logMockScrollAnimatorMessage(const String& message) const
1726 {
1727     Document* document = frame().document();
1728     if (!document)
1729         return;
1730     StringBuilder builder;
1731     if (frame().isMainFrame())
1732         builder.appendLiteral("Main");
1733     builder.appendLiteral("FrameView: ");
1734     builder.append(message);
1735     document->addConsoleMessage(MessageSource::Other, MessageLevel::Debug, builder.toString());
1736 }
1737
1738 void FrameView::setCannotBlitToWindow()
1739 {
1740     m_cannotBlitToWindow = true;
1741     updateCanBlitOnScrollRecursively();
1742 }
1743
1744 void FrameView::addSlowRepaintObject(RenderElement* o)
1745 {
1746     bool hadSlowRepaintObjects = hasSlowRepaintObjects();
1747
1748     if (!m_slowRepaintObjects)
1749         m_slowRepaintObjects = std::make_unique<HashSet<const RenderElement*>>();
1750
1751     m_slowRepaintObjects->add(o);
1752
1753     if (!hadSlowRepaintObjects) {
1754         updateCanBlitOnScrollRecursively();
1755
1756         if (Page* page = frame().page()) {
1757             if (ScrollingCoordinator* scrollingCoordinator = page->scrollingCoordinator())
1758                 scrollingCoordinator->frameViewHasSlowRepaintObjectsDidChange(*this);
1759         }
1760     }
1761 }
1762
1763 void FrameView::removeSlowRepaintObject(RenderElement* o)
1764 {
1765     if (!m_slowRepaintObjects)
1766         return;
1767
1768     m_slowRepaintObjects->remove(o);
1769     if (m_slowRepaintObjects->isEmpty()) {
1770         m_slowRepaintObjects = nullptr;
1771         updateCanBlitOnScrollRecursively();
1772
1773         if (Page* page = frame().page()) {
1774             if (ScrollingCoordinator* scrollingCoordinator = page->scrollingCoordinator())
1775                 scrollingCoordinator->frameViewHasSlowRepaintObjectsDidChange(*this);
1776         }
1777     }
1778 }
1779
1780 void FrameView::addViewportConstrainedObject(RenderElement* object)
1781 {
1782     if (!m_viewportConstrainedObjects)
1783         m_viewportConstrainedObjects = std::make_unique<ViewportConstrainedObjectSet>();
1784
1785     if (!m_viewportConstrainedObjects->contains(object)) {
1786         m_viewportConstrainedObjects->add(object);
1787         if (platformWidget())
1788             updateCanBlitOnScrollRecursively();
1789
1790         if (Page* page = frame().page()) {
1791             if (ScrollingCoordinator* scrollingCoordinator = page->scrollingCoordinator())
1792                 scrollingCoordinator->frameViewFixedObjectsDidChange(*this);
1793         }
1794     }
1795 }
1796
1797 void FrameView::removeViewportConstrainedObject(RenderElement* object)
1798 {
1799     if (m_viewportConstrainedObjects && m_viewportConstrainedObjects->remove(object)) {
1800         if (Page* page = frame().page()) {
1801             if (ScrollingCoordinator* scrollingCoordinator = page->scrollingCoordinator())
1802                 scrollingCoordinator->frameViewFixedObjectsDidChange(*this);
1803         }
1804
1805         // FIXME: In addFixedObject() we only call this if there's a platform widget,
1806         // why isn't the same check being made here?
1807         updateCanBlitOnScrollRecursively();
1808     }
1809 }
1810
1811 // visualViewport and layoutViewport are both in content coordinates (unzoomed).
1812 LayoutPoint FrameView::computeLayoutViewportOrigin(const LayoutRect& visualViewport, const LayoutPoint& stableLayoutViewportOriginMin, const LayoutPoint& stableLayoutViewportOriginMax, const LayoutRect& layoutViewport)
1813 {
1814     LayoutPoint layoutViewportOrigin = layoutViewport.location();
1815
1816     if (visualViewport.width() > layoutViewport.width())
1817         layoutViewportOrigin.setX(visualViewport.x());
1818     else {
1819         if (visualViewport.x() < layoutViewport.x() || visualViewport.x() < stableLayoutViewportOriginMin.x())
1820             layoutViewportOrigin.setX(visualViewport.x());
1821
1822         if (visualViewport.maxX() > layoutViewport.maxX() || (visualViewport.maxX() - layoutViewport.width()) > stableLayoutViewportOriginMax.x())
1823             layoutViewportOrigin.setX(visualViewport.maxX() - layoutViewport.width());
1824     }
1825
1826     if (visualViewport.height() > layoutViewport.height())
1827         layoutViewportOrigin.setY(visualViewport.y());
1828     else {
1829         if (visualViewport.y() < layoutViewport.y() || visualViewport.y() < stableLayoutViewportOriginMin.y())
1830             layoutViewportOrigin.setY(visualViewport.y());
1831
1832         if (visualViewport.maxY() > layoutViewport.maxY() || (visualViewport.maxY() - layoutViewport.height()) > stableLayoutViewportOriginMax.y())
1833             layoutViewportOrigin.setY(visualViewport.maxY() - layoutViewport.height());
1834     }
1835
1836     return layoutViewportOrigin;
1837 }
1838
1839 void FrameView::setBaseLayoutViewportOrigin(LayoutPoint origin, TriggerLayoutOrNot layoutTriggering)
1840 {
1841     ASSERT(frame().settings().visualViewportEnabled());
1842
1843     if (origin == m_layoutViewportOrigin)
1844         return;
1845
1846     m_layoutViewportOrigin = origin;
1847     if (layoutTriggering == TriggerLayoutOrNot::Yes)
1848         setViewportConstrainedObjectsNeedLayout();
1849     
1850     if (TiledBacking* tiledBacking = this->tiledBacking()) {
1851         FloatRect layoutViewport = layoutViewportRect();
1852         layoutViewport.moveBy(unscaledScrollOrigin()); // tiledBacking deals in top-left relative coordinates.
1853         tiledBacking->setLayoutViewportRect(layoutViewport);
1854     }
1855 }
1856
1857 void FrameView::setLayoutViewportOverrideRect(std::optional<LayoutRect> rect)
1858 {
1859     if (rect == m_layoutViewportOverrideRect)
1860         return;
1861
1862     LayoutRect oldRect = layoutViewportRect();
1863     m_layoutViewportOverrideRect = rect;
1864
1865     LOG_WITH_STREAM(Scrolling, stream << "\nFrameView " << this << " setLayoutViewportOverrideRect() - changing layout viewport from " << oldRect << " to " << m_layoutViewportOverrideRect.value());
1866
1867     if (oldRect != layoutViewportRect())
1868         setViewportConstrainedObjectsNeedLayout();
1869 }
1870
1871 LayoutSize FrameView::baseLayoutViewportSize() const
1872 {
1873     return renderView() ? renderView()->size() : size();
1874 }
1875
1876 void FrameView::updateLayoutViewport()
1877 {
1878     if (!frame().settings().visualViewportEnabled())
1879         return;
1880     
1881     // Don't update the layout viewport if we're in the middle of adjusting scrollbars. We'll get another call
1882     // as a post-layout task.
1883     if (m_layoutPhase == InViewSizeAdjust)
1884         return;
1885     
1886     if (m_layoutViewportOverrideRect) {
1887         LOG_WITH_STREAM(Scrolling, stream << "\nFrameView " << this << " updateLayoutViewport() - has layoutViewportOverrideRect" << m_layoutViewportOverrideRect.value());
1888         return;
1889     }
1890
1891     LayoutRect layoutViewport = layoutViewportRect();
1892
1893     LOG_WITH_STREAM(Scrolling, stream << "\nFrameView " << this << " updateLayoutViewport() totalContentSize " << totalContentsSize() << " unscaledDocumentRect " << (renderView() ? renderView()->unscaledDocumentRect() : IntRect()) << " header height " << headerHeight() << " footer height " << footerHeight());
1894     LOG_WITH_STREAM(Scrolling, stream << "layoutViewport: " << layoutViewport);
1895     LOG_WITH_STREAM(Scrolling, stream << "visualViewport: " << visualViewportRect());
1896     LOG_WITH_STREAM(Scrolling, stream << "scroll positions: min: " << unscaledMinimumScrollPosition() << " max: "<< unscaledMaximumScrollPosition());
1897
1898     LayoutPoint newLayoutViewportOrigin = computeLayoutViewportOrigin(visualViewportRect(), minStableLayoutViewportOrigin(), maxStableLayoutViewportOrigin(), layoutViewport);
1899     if (newLayoutViewportOrigin != m_layoutViewportOrigin) {
1900         setBaseLayoutViewportOrigin(newLayoutViewportOrigin);
1901         LOG_WITH_STREAM(Scrolling, stream << "layoutViewport changed to " << layoutViewportRect());
1902     }
1903 }
1904
1905 LayoutPoint FrameView::minStableLayoutViewportOrigin() const
1906 {
1907     return unscaledMinimumScrollPosition();
1908 }
1909
1910 LayoutPoint FrameView::maxStableLayoutViewportOrigin() const
1911 {
1912     LayoutPoint maxPosition = unscaledMaximumScrollPosition();
1913     maxPosition = (maxPosition - LayoutSize(0, headerHeight() + footerHeight())).expandedTo({ });
1914     return maxPosition;
1915 }
1916
1917 IntPoint FrameView::unscaledScrollOrigin() const
1918 {
1919     if (RenderView* renderView = this->renderView())
1920         return -renderView->unscaledDocumentRect().location(); // Akin to code in adjustViewSize().
1921
1922     return { };
1923 }
1924
1925 LayoutRect FrameView::layoutViewportRect() const
1926 {
1927     if (m_layoutViewportOverrideRect)
1928         return m_layoutViewportOverrideRect.value();
1929
1930     // Size of initial containing block, anchored at scroll position, in document coordinates (unchanged by scale factor).
1931     return LayoutRect(m_layoutViewportOrigin, renderView() ? renderView()->size() : size());
1932 }
1933
1934 // visibleContentRect is in the bounds of the scroll view content. That consists of an
1935 // optional header, the document, and an optional footer. Only the document is scaled,
1936 // so we have to compute the visible part of the document in unscaled document coordinates.
1937 // On iOS, pageScaleFactor is always 1 here, and we never have headers and footers.
1938 LayoutRect FrameView::visibleDocumentRect(const FloatRect& visibleContentRect, float headerHeight, float footerHeight, const FloatSize& totalContentsSize, float pageScaleFactor)
1939 {
1940     FloatRect visibleDocumentRect = visibleContentRect;
1941
1942     float contentsHeight = totalContentsSize.height() - headerHeight - footerHeight;
1943
1944     float visibleScaledDocumentTop = std::max<float>(visibleContentRect.y() - headerHeight, 0);
1945     float visibleScaledDocumentBottom = std::min<float>(visibleContentRect.maxY() - headerHeight, contentsHeight);
1946
1947     visibleDocumentRect.setY(visibleScaledDocumentTop);
1948     visibleDocumentRect.setHeight(std::max<float>(visibleScaledDocumentBottom - visibleScaledDocumentTop, 0));
1949     visibleDocumentRect.scale(1 / pageScaleFactor);
1950     return LayoutRect(visibleDocumentRect);
1951 }
1952
1953 LayoutRect FrameView::visualViewportRect() const
1954 {
1955     FloatRect visibleContentRect = this->visibleContentRect(LegacyIOSDocumentVisibleRect);
1956     return visibleDocumentRect(visibleContentRect, headerHeight(), footerHeight(), totalContentsSize(), frameScaleFactor());
1957 }
1958
1959 LayoutRect FrameView::viewportConstrainedVisibleContentRect() const
1960 {
1961     ASSERT(!frame().settings().visualViewportEnabled());
1962
1963 #if PLATFORM(IOS)
1964     if (useCustomFixedPositionLayoutRect())
1965         return customFixedPositionLayoutRect();
1966 #endif
1967     LayoutRect viewportRect = visibleContentRect();
1968
1969     viewportRect.setLocation(scrollPositionForFixedPosition());
1970     return viewportRect;
1971 }
1972
1973 LayoutRect FrameView::rectForFixedPositionLayout() const
1974 {
1975     if (frame().settings().visualViewportEnabled())
1976         return layoutViewportRect();
1977
1978     return viewportConstrainedVisibleContentRect();
1979 }
1980
1981 float FrameView::frameScaleFactor() const
1982 {
1983     return frame().frameScaleFactor();
1984 }
1985
1986 LayoutPoint FrameView::scrollPositionForFixedPosition() const
1987 {
1988     if (frame().settings().visualViewportEnabled())
1989         return layoutViewportRect().location();
1990
1991     return scrollPositionForFixedPosition(visibleContentRect(), totalContentsSize(), scrollPosition(), scrollOrigin(), frameScaleFactor(), fixedElementsLayoutRelativeToFrame(), scrollBehaviorForFixedElements(), headerHeight(), footerHeight());
1992 }
1993
1994 LayoutPoint FrameView::scrollPositionForFixedPosition(const LayoutRect& visibleContentRect, const LayoutSize& totalContentsSize, const LayoutPoint& scrollPosition, const LayoutPoint& scrollOrigin, float frameScaleFactor, bool fixedElementsLayoutRelativeToFrame, ScrollBehaviorForFixedElements behaviorForFixed, int headerHeight, int footerHeight)
1995 {
1996     LayoutPoint position;
1997     if (behaviorForFixed == StickToDocumentBounds)
1998         position = ScrollableArea::constrainScrollPositionForOverhang(visibleContentRect, totalContentsSize, scrollPosition, scrollOrigin, headerHeight, footerHeight);
1999     else {
2000         position = scrollPosition;
2001         position.setY(position.y() - headerHeight);
2002     }
2003
2004     LayoutSize maxSize = totalContentsSize - visibleContentRect.size();
2005
2006     float dragFactorX = (fixedElementsLayoutRelativeToFrame || !maxSize.width()) ? 1 : (totalContentsSize.width() - visibleContentRect.width() * frameScaleFactor) / maxSize.width();
2007     float dragFactorY = (fixedElementsLayoutRelativeToFrame || !maxSize.height()) ? 1 : (totalContentsSize.height() - visibleContentRect.height() * frameScaleFactor) / maxSize.height();
2008
2009     return LayoutPoint(position.x() * dragFactorX / frameScaleFactor, position.y() * dragFactorY / frameScaleFactor);
2010 }
2011
2012 float FrameView::yPositionForInsetClipLayer(const FloatPoint& scrollPosition, float topContentInset)
2013 {
2014     if (!topContentInset)
2015         return 0;
2016
2017     // The insetClipLayer should not move for negative scroll values.
2018     float scrollY = std::max<float>(0, scrollPosition.y());
2019
2020     if (scrollY >= topContentInset)
2021         return 0;
2022
2023     return topContentInset - scrollY;
2024 }
2025
2026 float FrameView::yPositionForHeaderLayer(const FloatPoint& scrollPosition, float topContentInset)
2027 {
2028     if (!topContentInset)
2029         return 0;
2030
2031     float scrollY = std::max<float>(0, scrollPosition.y());
2032
2033     if (scrollY >= topContentInset)
2034         return topContentInset;
2035
2036     return scrollY;
2037 }
2038
2039 float FrameView::yPositionForFooterLayer(const FloatPoint& scrollPosition, float topContentInset, float totalContentsHeight, float footerHeight)
2040 {
2041     return yPositionForHeaderLayer(scrollPosition, topContentInset) + totalContentsHeight - footerHeight;
2042 }
2043
2044 FloatPoint FrameView::positionForRootContentLayer(const FloatPoint& scrollPosition, const FloatPoint& scrollOrigin, float topContentInset, float headerHeight)
2045 {
2046     return FloatPoint(0, yPositionForHeaderLayer(scrollPosition, topContentInset) + headerHeight) - toFloatSize(scrollOrigin);
2047 }
2048
2049 FloatPoint FrameView::positionForRootContentLayer() const
2050 {
2051     return positionForRootContentLayer(scrollPosition(), scrollOrigin(), topContentInset(), headerHeight());
2052 }
2053
2054 #if PLATFORM(IOS)
2055 LayoutRect FrameView::rectForViewportConstrainedObjects(const LayoutRect& visibleContentRect, const LayoutSize& totalContentsSize, float frameScaleFactor, bool fixedElementsLayoutRelativeToFrame, ScrollBehaviorForFixedElements scrollBehavior)
2056 {
2057     if (fixedElementsLayoutRelativeToFrame)
2058         return visibleContentRect;
2059     
2060     if (totalContentsSize.isEmpty())
2061         return visibleContentRect;
2062
2063     // We impose an lower limit on the size (so an upper limit on the scale) of
2064     // the rect used to position fixed objects so that they don't crowd into the
2065     // center of the screen at larger scales.
2066     const LayoutUnit maxContentWidthForZoomThreshold = LayoutUnit::fromPixel(1024);
2067     float zoomedOutScale = frameScaleFactor * visibleContentRect.width() / std::min(maxContentWidthForZoomThreshold, totalContentsSize.width());
2068     float constraintThresholdScale = 1.5 * zoomedOutScale;
2069     float maxPostionedObjectsRectScale = std::min(frameScaleFactor, constraintThresholdScale);
2070
2071     LayoutRect viewportConstrainedObjectsRect = visibleContentRect;
2072
2073     if (frameScaleFactor > constraintThresholdScale) {
2074         FloatRect contentRect(FloatPoint(), totalContentsSize);
2075         FloatRect viewportRect = visibleContentRect;
2076         
2077         // Scale the rect up from a point that is relative to its position in the viewport.
2078         FloatSize sizeDelta = contentRect.size() - viewportRect.size();
2079
2080         FloatPoint scaleOrigin;
2081         scaleOrigin.setX(contentRect.x() + sizeDelta.width() > 0 ? contentRect.width() * (viewportRect.x() - contentRect.x()) / sizeDelta.width() : 0);
2082         scaleOrigin.setY(contentRect.y() + sizeDelta.height() > 0 ? contentRect.height() * (viewportRect.y() - contentRect.y()) / sizeDelta.height() : 0);
2083         
2084         AffineTransform rescaleTransform = AffineTransform::translation(scaleOrigin.x(), scaleOrigin.y());
2085         rescaleTransform.scale(frameScaleFactor / maxPostionedObjectsRectScale, frameScaleFactor / maxPostionedObjectsRectScale);
2086         rescaleTransform = CGAffineTransformTranslate(rescaleTransform, -scaleOrigin.x(), -scaleOrigin.y());
2087
2088         viewportConstrainedObjectsRect = enclosingLayoutRect(rescaleTransform.mapRect(visibleContentRect));
2089     }
2090     
2091     if (scrollBehavior == StickToDocumentBounds) {
2092         LayoutRect documentBounds(LayoutPoint(), totalContentsSize);
2093         viewportConstrainedObjectsRect.intersect(documentBounds);
2094     }
2095
2096     return viewportConstrainedObjectsRect;
2097 }
2098     
2099 LayoutRect FrameView::viewportConstrainedObjectsRect() const
2100 {
2101     return rectForViewportConstrainedObjects(visibleContentRect(), totalContentsSize(), frame().frameScaleFactor(), fixedElementsLayoutRelativeToFrame(), scrollBehaviorForFixedElements());
2102 }
2103 #endif
2104     
2105 ScrollPosition FrameView::minimumScrollPosition() const
2106 {
2107     ScrollPosition minimumPosition = ScrollView::minimumScrollPosition();
2108
2109     if (frame().isMainFrame() && m_scrollPinningBehavior == PinToBottom)
2110         minimumPosition.setY(maximumScrollPosition().y());
2111     
2112     return minimumPosition;
2113 }
2114
2115 ScrollPosition FrameView::maximumScrollPosition() const
2116 {
2117     ScrollPosition maximumPosition = ScrollView::maximumScrollPosition();
2118
2119     if (frame().isMainFrame() && m_scrollPinningBehavior == PinToTop)
2120         maximumPosition.setY(minimumScrollPosition().y());
2121     
2122     return maximumPosition;
2123 }
2124
2125 ScrollPosition FrameView::unscaledMinimumScrollPosition() const
2126 {
2127     if (RenderView* renderView = this->renderView()) {
2128         IntRect unscaledDocumentRect = renderView->unscaledDocumentRect();
2129         ScrollPosition minimumPosition = unscaledDocumentRect.location();
2130
2131         if (frame().isMainFrame() && m_scrollPinningBehavior == PinToBottom)
2132             minimumPosition.setY(unscaledMaximumScrollPosition().y());
2133
2134         return minimumPosition;
2135     }
2136
2137     return minimumScrollPosition();
2138 }
2139
2140 ScrollPosition FrameView::unscaledMaximumScrollPosition() const
2141 {
2142     if (RenderView* renderView = this->renderView()) {
2143         IntRect unscaledDocumentRect = renderView->unscaledDocumentRect();
2144         unscaledDocumentRect.expand(0, headerHeight() + footerHeight());
2145         ScrollPosition maximumPosition = ScrollPosition(unscaledDocumentRect.maxXMaxYCorner() - visibleSize()).expandedTo({ 0, 0 });
2146
2147         if (frame().isMainFrame() && m_scrollPinningBehavior == PinToTop)
2148             maximumPosition.setY(unscaledMinimumScrollPosition().y());
2149
2150         return maximumPosition;
2151     }
2152
2153     return maximumScrollPosition();
2154 }
2155
2156 void FrameView::viewportContentsChanged()
2157 {
2158     if (!frame().view()) {
2159         // The frame is being destroyed.
2160         return;
2161     }
2162
2163     if (auto* page = frame().page())
2164         page->updateValidationBubbleStateIfNeeded();
2165
2166     // When the viewport contents changes (scroll, resize, style recalc, layout, ...),
2167     // check if we should resume animated images or unthrottle DOM timers.
2168     applyRecursivelyWithVisibleRect([] (FrameView& frameView, const IntRect& visibleRect) {
2169         frameView.resumeVisibleImageAnimations(visibleRect);
2170         frameView.updateScriptedAnimationsAndTimersThrottlingState(visibleRect);
2171
2172         if (auto* renderView = frameView.frame().contentRenderer())
2173             renderView->updateVisibleViewportRect(visibleRect);
2174     });
2175 }
2176
2177 bool FrameView::fixedElementsLayoutRelativeToFrame() const
2178 {
2179     return frame().settings().fixedElementsLayoutRelativeToFrame();
2180 }
2181
2182 IntPoint FrameView::lastKnownMousePosition() const
2183 {
2184     return frame().eventHandler().lastKnownMousePosition();
2185 }
2186
2187 bool FrameView::isHandlingWheelEvent() const
2188 {
2189     return frame().eventHandler().isHandlingWheelEvent();
2190 }
2191
2192 bool FrameView::shouldSetCursor() const
2193 {
2194     Page* page = frame().page();
2195     return page && page->isVisible() && page->focusController().isActive();
2196 }
2197
2198 bool FrameView::scrollContentsFastPath(const IntSize& scrollDelta, const IntRect& rectToScroll, const IntRect& clipRect)
2199 {
2200     if (!m_viewportConstrainedObjects || m_viewportConstrainedObjects->isEmpty()) {
2201         frame().page()->chrome().scroll(scrollDelta, rectToScroll, clipRect);
2202         return true;
2203     }
2204
2205     bool isCompositedContentLayer = usesCompositedScrolling();
2206
2207     // Get the rects of the fixed objects visible in the rectToScroll
2208     Region regionToUpdate;
2209     for (auto& renderer : *m_viewportConstrainedObjects) {
2210         if (!renderer->style().hasViewportConstrainedPosition())
2211             continue;
2212         if (renderer->isComposited())
2213             continue;
2214
2215         // Fixed items should always have layers.
2216         ASSERT(renderer->hasLayer());
2217         RenderLayer* layer = downcast<RenderBoxModelObject>(*renderer).layer();
2218
2219         if (layer->viewportConstrainedNotCompositedReason() == RenderLayer::NotCompositedForBoundsOutOfView
2220             || layer->viewportConstrainedNotCompositedReason() == RenderLayer::NotCompositedForNoVisibleContent) {
2221             // Don't invalidate for invisible fixed layers.
2222             continue;
2223         }
2224
2225         if (layer->hasAncestorWithFilterOutsets()) {
2226             // If the fixed layer has a blur/drop-shadow filter applied on at least one of its parents, we cannot 
2227             // scroll using the fast path, otherwise the outsets of the filter will be moved around the page.
2228             return false;
2229         }
2230
2231         // FIXME: use pixel snapping instead of enclosing when ScrollView has finished transitioning from IntRect to Float/LayoutRect.
2232         IntRect updateRect = enclosingIntRect(layer->repaintRectIncludingNonCompositingDescendants());
2233         updateRect = contentsToRootView(updateRect);
2234         if (!isCompositedContentLayer && clipsRepaints())
2235             updateRect.intersect(rectToScroll);
2236         if (!updateRect.isEmpty())
2237             regionToUpdate.unite(updateRect);
2238     }
2239
2240     // 1) scroll
2241     frame().page()->chrome().scroll(scrollDelta, rectToScroll, clipRect);
2242
2243     // 2) update the area of fixed objects that has been invalidated
2244     for (auto& updateRect : regionToUpdate.rects()) {
2245         IntRect scrolledRect = updateRect;
2246         scrolledRect.move(scrollDelta);
2247         updateRect.unite(scrolledRect);
2248         if (isCompositedContentLayer) {
2249             updateRect = rootViewToContents(updateRect);
2250             ASSERT(renderView());
2251             renderView()->layer()->setBackingNeedsRepaintInRect(updateRect);
2252             continue;
2253         }
2254         if (clipsRepaints())
2255             updateRect.intersect(rectToScroll);
2256         frame().page()->chrome().invalidateContentsAndRootView(updateRect);
2257     }
2258
2259     return true;
2260 }
2261
2262 void FrameView::scrollContentsSlowPath(const IntRect& updateRect)
2263 {
2264     repaintSlowRepaintObjects();
2265
2266     if (!usesCompositedScrolling() && isEnclosedInCompositingLayer()) {
2267         if (RenderWidget* frameRenderer = frame().ownerRenderer()) {
2268             LayoutRect rect(frameRenderer->borderLeft() + frameRenderer->paddingLeft(), frameRenderer->borderTop() + frameRenderer->paddingTop(),
2269                 visibleWidth(), visibleHeight());
2270             frameRenderer->repaintRectangle(rect);
2271             return;
2272         }
2273     }
2274
2275     ScrollView::scrollContentsSlowPath(updateRect);
2276 }
2277
2278 void FrameView::repaintSlowRepaintObjects()
2279 {
2280     if (!m_slowRepaintObjects)
2281         return;
2282
2283     // Renderers with fixed backgrounds may be in compositing layers, so we need to explicitly
2284     // repaint them after scrolling.
2285     for (auto& renderer : *m_slowRepaintObjects)
2286         renderer->repaintSlowRepaintObject();
2287 }
2288
2289 // Note that this gets called at painting time.
2290 void FrameView::setIsOverlapped(bool isOverlapped)
2291 {
2292     if (isOverlapped == m_isOverlapped)
2293         return;
2294
2295     m_isOverlapped = isOverlapped;
2296     updateCanBlitOnScrollRecursively();
2297 }
2298
2299 void FrameView::setContentIsOpaque(bool contentIsOpaque)
2300 {
2301     if (contentIsOpaque == m_contentIsOpaque)
2302         return;
2303
2304     m_contentIsOpaque = contentIsOpaque;
2305     updateCanBlitOnScrollRecursively();
2306 }
2307
2308 void FrameView::restoreScrollbar()
2309 {
2310     setScrollbarsSuppressed(false);
2311 }
2312
2313 bool FrameView::scrollToFragment(const URL& url)
2314 {
2315     // If our URL has no ref, then we have no place we need to jump to.
2316     // OTOH If CSS target was set previously, we want to set it to 0, recalc
2317     // and possibly repaint because :target pseudo class may have been
2318     // set (see bug 11321).
2319     if (!url.hasFragmentIdentifier() && !frame().document()->cssTarget())
2320         return false;
2321
2322     String fragmentIdentifier = url.fragmentIdentifier();
2323     if (scrollToAnchor(fragmentIdentifier))
2324         return true;
2325
2326     // Try again after decoding the ref, based on the document's encoding.
2327     if (TextResourceDecoder* decoder = frame().document()->decoder())
2328         return scrollToAnchor(decodeURLEscapeSequences(fragmentIdentifier, decoder->encoding()));
2329
2330     return false;
2331 }
2332
2333 bool FrameView::scrollToAnchor(const String& name)
2334 {
2335     ASSERT(frame().document());
2336     auto& document = *frame().document();
2337
2338     if (!document.haveStylesheetsLoaded()) {
2339         document.setGotoAnchorNeededAfterStylesheetsLoad(true);
2340         return false;
2341     }
2342
2343     document.setGotoAnchorNeededAfterStylesheetsLoad(false);
2344
2345     Element* anchorElement = document.findAnchor(name);
2346
2347     // Setting to null will clear the current target.
2348     document.setCSSTarget(anchorElement);
2349
2350     if (is<SVGDocument>(document)) {
2351         if (auto* rootElement = SVGDocument::rootElement(document)) {
2352             rootElement->scrollToAnchor(name, anchorElement);
2353             if (!anchorElement)
2354                 return true;
2355         }
2356     }
2357   
2358     // Implement the rule that "" and "top" both mean top of page as in other browsers.
2359     if (!anchorElement && !(name.isEmpty() || equalLettersIgnoringASCIICase(name, "top")))
2360         return false;
2361
2362     ContainerNode* scrollPositionAnchor = anchorElement;
2363     if (!scrollPositionAnchor)
2364         scrollPositionAnchor = frame().document();
2365     maintainScrollPositionAtAnchor(scrollPositionAnchor);
2366     
2367     // If the anchor accepts keyboard focus, move focus there to aid users relying on keyboard navigation.
2368     if (anchorElement) {
2369         if (anchorElement->isFocusable())
2370             document.setFocusedElement(anchorElement);
2371         else {
2372             document.setFocusedElement(nullptr);
2373             document.setFocusNavigationStartingNode(anchorElement);
2374         }
2375     }
2376     
2377     return true;
2378 }
2379
2380 void FrameView::maintainScrollPositionAtAnchor(ContainerNode* anchorNode)
2381 {
2382     m_maintainScrollPositionAnchor = anchorNode;
2383     if (!m_maintainScrollPositionAnchor)
2384         return;
2385
2386     // We need to update the layout before scrolling, otherwise we could
2387     // really mess things up if an anchor scroll comes at a bad moment.
2388     frame().document()->updateStyleIfNeeded();
2389     // Only do a layout if changes have occurred that make it necessary.
2390     RenderView* renderView = this->renderView();
2391     if (renderView && renderView->needsLayout())
2392         layout();
2393     else
2394         scrollToAnchor();
2395 }
2396
2397 void FrameView::scrollElementToRect(const Element& element, const IntRect& rect)
2398 {
2399     frame().document()->updateLayoutIgnorePendingStylesheets();
2400
2401     LayoutRect bounds;
2402     if (RenderElement* renderer = element.renderer())
2403         bounds = renderer->absoluteAnchorRect();
2404     int centeringOffsetX = (rect.width() - bounds.width()) / 2;
2405     int centeringOffsetY = (rect.height() - bounds.height()) / 2;
2406     setScrollPosition(IntPoint(bounds.x() - centeringOffsetX - rect.x(), bounds.y() - centeringOffsetY - rect.y()));
2407 }
2408
2409 void FrameView::setScrollPosition(const ScrollPosition& scrollPosition)
2410 {
2411     SetForScope<bool> changeInProgrammaticScroll(m_inProgrammaticScroll, true);
2412     m_maintainScrollPositionAnchor = nullptr;
2413     Page* page = frame().page();
2414     if (page && page->expectsWheelEventTriggers())
2415         scrollAnimator().setWheelEventTestTrigger(page->testTrigger());
2416     ScrollView::setScrollPosition(scrollPosition);
2417 }
2418
2419 void FrameView::contentsResized()
2420 {
2421     // For non-delegated scrolling, adjustTiledBackingScrollability() is called via addedOrRemovedScrollbar() which occurs less often.
2422     if (delegatesScrolling())
2423         adjustTiledBackingScrollability();
2424 }
2425
2426 void FrameView::delegatesScrollingDidChange()
2427 {
2428     // When we switch to delgatesScrolling mode, we should destroy the scrolling/clipping layers in RenderLayerCompositor.
2429     if (hasCompositedContent())
2430         clearBackingStores();
2431 }
2432
2433 #if USE(COORDINATED_GRAPHICS)
2434 void FrameView::setFixedVisibleContentRect(const IntRect& visibleContentRect)
2435 {
2436     bool visibleContentSizeDidChange = false;
2437     if (visibleContentRect.size() != this->fixedVisibleContentRect().size()) {
2438         // When the viewport size changes or the content is scaled, we need to
2439         // reposition the fixed and sticky positioned elements.
2440         setViewportConstrainedObjectsNeedLayout();
2441         visibleContentSizeDidChange = true;
2442     }
2443
2444     IntPoint oldPosition = scrollPosition();
2445     ScrollView::setFixedVisibleContentRect(visibleContentRect);
2446     IntPoint newPosition = scrollPosition();
2447     if (oldPosition != newPosition) {
2448         updateLayerPositionsAfterScrolling();
2449         if (frame().settings().acceleratedCompositingForFixedPositionEnabled())
2450             updateCompositingLayersAfterScrolling();
2451         scrollAnimator().setCurrentPosition(newPosition);
2452         scrollPositionChanged(oldPosition, newPosition);
2453     }
2454     if (visibleContentSizeDidChange) {
2455         // Update the scroll-bars to calculate new page-step size.
2456         updateScrollbars(scrollPosition());
2457     }
2458     didChangeScrollOffset();
2459 }
2460 #endif
2461
2462 void FrameView::setViewportConstrainedObjectsNeedLayout()
2463 {
2464     if (!hasViewportConstrainedObjects())
2465         return;
2466
2467     for (auto& renderer : *m_viewportConstrainedObjects)
2468         renderer->setNeedsLayout();
2469 }
2470
2471 void FrameView::didChangeScrollOffset()
2472 {
2473     frame().mainFrame().pageOverlayController().didScrollFrame(frame());
2474     frame().loader().client().didChangeScrollOffset();
2475 }
2476
2477 void FrameView::scrollOffsetChangedViaPlatformWidgetImpl(const ScrollOffset& oldOffset, const ScrollOffset& newOffset)
2478 {
2479     updateLayerPositionsAfterScrolling();
2480     updateCompositingLayersAfterScrolling();
2481     repaintSlowRepaintObjects();
2482     scrollPositionChanged(scrollPositionFromOffset(oldOffset), scrollPositionFromOffset(newOffset));
2483 }
2484
2485 // These scroll positions are affected by zooming.
2486 void FrameView::scrollPositionChanged(const ScrollPosition& oldPosition, const ScrollPosition& newPosition)
2487 {
2488     Page* page = frame().page();
2489     Seconds throttlingDelay = page ? page->chrome().client().eventThrottlingDelay() : 0_s;
2490
2491     if (throttlingDelay == 0_s) {
2492         m_delayedScrollEventTimer.stop();
2493         sendScrollEvent();
2494     } else if (!m_delayedScrollEventTimer.isActive())
2495         m_delayedScrollEventTimer.startOneShot(throttlingDelay.value());
2496
2497     if (Document* document = frame().document())
2498         document->sendWillRevealEdgeEventsIfNeeded(oldPosition, newPosition, visibleContentRect(), contentsSize());
2499
2500     if (RenderView* renderView = this->renderView()) {
2501         if (renderView->usesCompositing())
2502             renderView->compositor().frameViewDidScroll();
2503     }
2504
2505     LOG_WITH_STREAM(Scrolling, stream << "FrameView " << this << " scrollPositionChanged from " << oldPosition << " to " << newPosition << " (scale " << frameScaleFactor() << " )");
2506     updateLayoutViewport();
2507     viewportContentsChanged();
2508 }
2509
2510 void FrameView::applyRecursivelyWithVisibleRect(const std::function<void (FrameView& frameView, const IntRect& visibleRect)>& apply)
2511 {
2512     IntRect windowClipRect = this->windowClipRect();
2513     auto visibleRect = windowToContents(windowClipRect);
2514     apply(*this, visibleRect);
2515
2516     // Recursive call for subframes. We cache the current FrameView's windowClipRect to avoid recomputing it for every subframe.
2517     SetForScope<IntRect*> windowClipRectCache(m_cachedWindowClipRect, &windowClipRect);
2518     for (Frame* childFrame = frame().tree().firstChild(); childFrame; childFrame = childFrame->tree().nextSibling()) {
2519         if (auto* childView = childFrame->view())
2520             childView->applyRecursivelyWithVisibleRect(apply);
2521     }
2522 }
2523
2524 void FrameView::resumeVisibleImageAnimations(const IntRect& visibleRect)
2525 {
2526     if (visibleRect.isEmpty())
2527         return;
2528
2529     if (auto* renderView = frame().contentRenderer())
2530         renderView->resumePausedImageAnimationsIfNeeded(visibleRect);
2531 }
2532
2533 void FrameView::updateScriptedAnimationsAndTimersThrottlingState(const IntRect& visibleRect)
2534 {
2535     if (frame().isMainFrame())
2536         return;
2537
2538     auto* document = frame().document();
2539     if (!document)
2540         return;
2541
2542     // We don't throttle zero-size or display:none frames because those are usually utility frames.
2543     bool shouldThrottle = visibleRect.isEmpty() && !m_size.isEmpty() && frame().ownerRenderer();
2544
2545     if (auto* scriptedAnimationController = document->scriptedAnimationController())
2546         scriptedAnimationController->setThrottled(shouldThrottle);
2547
2548     document->setTimerThrottlingEnabled(shouldThrottle);
2549 }
2550
2551
2552 void FrameView::resumeVisibleImageAnimationsIncludingSubframes()
2553 {
2554     applyRecursivelyWithVisibleRect([] (FrameView& frameView, const IntRect& visibleRect) {
2555         frameView.resumeVisibleImageAnimations(visibleRect);
2556     });
2557 }
2558
2559 void FrameView::updateLayerPositionsAfterScrolling()
2560 {
2561     // If we're scrolling as a result of updating the view size after layout, we'll update widgets and layer positions soon anyway.
2562     if (m_layoutPhase == InViewSizeAdjust)
2563         return;
2564
2565     if (m_nestedLayoutCount <= 1 && hasViewportConstrainedObjects()) {
2566         if (RenderView* renderView = this->renderView()) {
2567             updateWidgetPositions();
2568             renderView->layer()->updateLayerPositionsAfterDocumentScroll();
2569         }
2570     }
2571 }
2572
2573 bool FrameView::shouldUpdateCompositingLayersAfterScrolling() const
2574 {
2575 #if ENABLE(ASYNC_SCROLLING)
2576     // If the scrolling thread is updating the fixed elements, then the FrameView should not update them as well.
2577
2578     Page* page = frame().page();
2579     if (!page)
2580         return true;
2581
2582     if (&page->mainFrame() != m_frame.ptr())
2583         return true;
2584
2585     ScrollingCoordinator* scrollingCoordinator = page->scrollingCoordinator();
2586     if (!scrollingCoordinator)
2587         return true;
2588
2589     if (!scrollingCoordinator->supportsFixedPositionLayers())
2590         return true;
2591
2592     if (scrollingCoordinator->shouldUpdateScrollLayerPositionSynchronously(*this))
2593         return true;
2594
2595     if (inProgrammaticScroll())
2596         return true;
2597
2598     return false;
2599 #endif
2600     return true;
2601 }
2602
2603 void FrameView::updateCompositingLayersAfterScrolling()
2604 {
2605     ASSERT(m_layoutPhase >= InPostLayout || m_layoutPhase == OutsideLayout);
2606
2607     if (!shouldUpdateCompositingLayersAfterScrolling())
2608         return;
2609
2610     if (m_nestedLayoutCount <= 1 && hasViewportConstrainedObjects()) {
2611         if (RenderView* renderView = this->renderView())
2612             renderView->compositor().updateCompositingLayers(CompositingUpdateOnScroll);
2613     }
2614 }
2615
2616 bool FrameView::isRubberBandInProgress() const
2617 {
2618     if (scrollbarsSuppressed())
2619         return false;
2620
2621     // If the scrolling thread updates the scroll position for this FrameView, then we should return
2622     // ScrollingCoordinator::isRubberBandInProgress().
2623     if (Page* page = frame().page()) {
2624         if (ScrollingCoordinator* scrollingCoordinator = page->scrollingCoordinator()) {
2625             if (!scrollingCoordinator->shouldUpdateScrollLayerPositionSynchronously(*this))
2626                 return scrollingCoordinator->isRubberBandInProgress();
2627         }
2628     }
2629
2630     // If the main thread updates the scroll position for this FrameView, we should return
2631     // ScrollAnimator::isRubberBandInProgress().
2632     if (ScrollAnimator* scrollAnimator = existingScrollAnimator())
2633         return scrollAnimator->isRubberBandInProgress();
2634
2635     return false;
2636 }
2637
2638 bool FrameView::requestScrollPositionUpdate(const ScrollPosition& position)
2639 {
2640     LOG_WITH_STREAM(Scrolling, stream << "FrameView::requestScrollPositionUpdate " << position);
2641
2642 #if ENABLE(ASYNC_SCROLLING)
2643     if (TiledBacking* tiledBacking = this->tiledBacking())
2644         tiledBacking->prepopulateRect(FloatRect(position, visibleContentRect().size()));
2645 #endif
2646
2647 #if ENABLE(ASYNC_SCROLLING) || USE(COORDINATED_GRAPHICS)
2648     if (Page* page = frame().page()) {
2649         if (ScrollingCoordinator* scrollingCoordinator = page->scrollingCoordinator())
2650             return scrollingCoordinator->requestScrollPositionUpdate(*this, position);
2651     }
2652 #else
2653     UNUSED_PARAM(position);
2654 #endif
2655
2656     return false;
2657 }
2658
2659 HostWindow* FrameView::hostWindow() const
2660 {
2661     auto* page = frame().page();
2662     if (!page)
2663         return nullptr;
2664     return &page->chrome();
2665 }
2666
2667 void FrameView::addTrackedRepaintRect(const FloatRect& r)
2668 {
2669     if (!m_isTrackingRepaints || r.isEmpty())
2670         return;
2671
2672     FloatRect repaintRect = r;
2673     repaintRect.moveBy(-scrollPosition());
2674     m_trackedRepaintRects.append(repaintRect);
2675 }
2676
2677 void FrameView::repaintContentRectangle(const IntRect& r)
2678 {
2679     ASSERT(!frame().ownerElement());
2680
2681     if (!shouldUpdate())
2682         return;
2683
2684     ScrollView::repaintContentRectangle(r);
2685 }
2686
2687 static unsigned countRenderedCharactersInRenderObjectWithThreshold(const RenderElement& renderer, unsigned threshold)
2688 {
2689     unsigned count = 0;
2690     for (const RenderObject* descendant = &renderer; descendant; descendant = descendant->nextInPreOrder()) {
2691         if (is<RenderText>(*descendant)) {
2692             count += downcast<RenderText>(*descendant).text()->length();
2693             if (count >= threshold)
2694                 break;
2695         }
2696     }
2697     return count;
2698 }
2699
2700 bool FrameView::renderedCharactersExceed(unsigned threshold)
2701 {
2702     if (!frame().contentRenderer())
2703         return false;
2704     return countRenderedCharactersInRenderObjectWithThreshold(*frame().contentRenderer(), threshold) >= threshold;
2705 }
2706
2707 void FrameView::availableContentSizeChanged(AvailableSizeChangeReason reason)
2708 {
2709     if (Document* document = frame().document()) {
2710         // FIXME: Merge this logic with m_setNeedsLayoutWasDeferred and find a more appropriate
2711         // way of handling potential recursive layouts when the viewport is resized to accomodate
2712         // the content but the content always overflows the viewport. See webkit.org/b/165781.
2713         if (!(layoutPhase() == InViewSizeAdjust && useFixedLayout()))
2714             document->updateViewportUnitsOnResize();
2715     }
2716
2717     updateLayoutViewport();
2718     setNeedsLayout();
2719     ScrollView::availableContentSizeChanged(reason);
2720 }
2721
2722 bool FrameView::shouldLayoutAfterContentsResized() const
2723 {
2724     return !useFixedLayout() || useCustomFixedPositionLayoutRect();
2725 }
2726
2727 void FrameView::updateContentsSize()
2728 {
2729     // We check to make sure the view is attached to a frame() as this method can
2730     // be triggered before the view is attached by Frame::createView(...) setting
2731     // various values such as setScrollBarModes(...) for example.  An ASSERT is
2732     // triggered when a view is layout before being attached to a frame().
2733     if (!frame().view())
2734         return;
2735
2736 #if PLATFORM(IOS)
2737     if (RenderView* root = m_frame->contentRenderer()) {
2738         if (useCustomFixedPositionLayoutRect() && hasViewportConstrainedObjects()) {
2739             setViewportConstrainedObjectsNeedLayout();
2740             // We must eagerly enter compositing mode because fixed position elements
2741             // will not have been made compositing via a preceding style change before
2742             // m_useCustomFixedPositionLayoutRect was true.
2743             root->compositor().enableCompositingMode();
2744         }
2745     }
2746 #endif
2747
2748     if (shouldLayoutAfterContentsResized() && needsLayout())
2749         layout();
2750
2751     if (RenderView* renderView = this->renderView()) {
2752         if (renderView->usesCompositing())
2753             renderView->compositor().frameViewDidChangeSize();
2754     }
2755 }
2756
2757 void FrameView::addedOrRemovedScrollbar()
2758 {
2759     if (RenderView* renderView = this->renderView()) {
2760         if (renderView->usesCompositing())
2761             renderView->compositor().frameViewDidAddOrRemoveScrollbars();
2762     }
2763
2764     adjustTiledBackingScrollability();
2765 }
2766
2767 void FrameView::adjustTiledBackingScrollability()
2768 {
2769     auto* tiledBacking = this->tiledBacking();
2770     if (!tiledBacking)
2771         return;
2772     
2773     bool horizontallyScrollable;
2774     bool verticallyScrollable;
2775     bool clippedByAncestorView = static_cast<bool>(m_viewExposedRect);
2776
2777 #if PLATFORM(IOS)
2778     if (Page* page = frame().page())
2779         clippedByAncestorView |= page->enclosedInScrollableAncestorView();
2780 #endif
2781
2782     if (delegatesScrolling()) {
2783         IntSize documentSize = contentsSize();
2784         IntSize visibleSize = this->visibleSize();
2785         
2786         horizontallyScrollable = clippedByAncestorView || documentSize.width() > visibleSize.width();
2787         verticallyScrollable = clippedByAncestorView || documentSize.height() > visibleSize.height();
2788     } else {
2789         horizontallyScrollable = clippedByAncestorView || horizontalScrollbar();
2790         verticallyScrollable = clippedByAncestorView || verticalScrollbar();
2791     }
2792
2793     TiledBacking::Scrollability scrollability = TiledBacking::NotScrollable;
2794     if (horizontallyScrollable)
2795         scrollability = TiledBacking::HorizontallyScrollable;
2796
2797     if (verticallyScrollable)
2798         scrollability |= TiledBacking::VerticallyScrollable;
2799
2800     tiledBacking->setScrollability(scrollability);
2801 }
2802
2803 #if PLATFORM(IOS)
2804
2805 void FrameView::unobscuredContentSizeChanged()
2806 {
2807     adjustTiledBackingScrollability();
2808 }
2809
2810 #endif
2811
2812 static LayerFlushThrottleState::Flags determineLayerFlushThrottleState(Page& page)
2813 {
2814     // We only throttle when constantly receiving new data during the inital page load.
2815     if (!page.progress().isMainLoadProgressing())
2816         return 0;
2817     // Scrolling during page loading disables throttling.
2818     if (page.mainFrame().view()->wasScrolledByUser())
2819         return 0;
2820     // Disable for image documents so large GIF animations don't get throttled during loading.
2821     auto* document = page.mainFrame().document();
2822     if (!document || is<ImageDocument>(*document))
2823         return 0;
2824     return LayerFlushThrottleState::Enabled;
2825 }
2826
2827 void FrameView::disableLayerFlushThrottlingTemporarilyForInteraction()
2828 {
2829     if (!frame().page())
2830         return;
2831     auto& page = *frame().page();
2832
2833     LayerFlushThrottleState::Flags flags = LayerFlushThrottleState::UserIsInteracting | determineLayerFlushThrottleState(page);
2834     if (page.chrome().client().adjustLayerFlushThrottling(flags))
2835         return;
2836
2837     if (RenderView* view = renderView())
2838         view->compositor().disableLayerFlushThrottlingTemporarilyForInteraction();
2839 }
2840
2841 void FrameView::loadProgressingStatusChanged()
2842 {
2843     updateLayerFlushThrottling();
2844     adjustTiledBackingCoverage();
2845 }
2846
2847 void FrameView::updateLayerFlushThrottling()
2848 {
2849     Page* page = frame().page();
2850     if (!page)
2851         return;
2852
2853     ASSERT(frame().isMainFrame());
2854
2855     LayerFlushThrottleState::Flags flags = determineLayerFlushThrottleState(*page);
2856
2857     // See if the client is handling throttling.
2858     if (page->chrome().client().adjustLayerFlushThrottling(flags))
2859         return;
2860
2861     for (auto* frame = m_frame.ptr(); frame; frame = frame->tree().traverseNext(m_frame.ptr())) {
2862         if (RenderView* renderView = frame->contentRenderer())
2863             renderView->compositor().setLayerFlushThrottlingEnabled(flags & LayerFlushThrottleState::Enabled);
2864     }
2865 }
2866
2867 void FrameView::adjustTiledBackingCoverage()
2868 {
2869     if (!m_speculativeTilingEnabled)
2870         enableSpeculativeTilingIfNeeded();
2871
2872     RenderView* renderView = this->renderView();
2873     if (renderView && renderView->layer()->backing())
2874         renderView->layer()->backing()->adjustTiledBackingCoverage();
2875 #if PLATFORM(IOS)
2876     if (LegacyTileCache* tileCache = legacyTileCache())
2877         tileCache->setSpeculativeTileCreationEnabled(m_speculativeTilingEnabled);
2878 #endif
2879 }
2880
2881 static bool shouldEnableSpeculativeTilingDuringLoading(const FrameView& view)
2882 {
2883     Page* page = view.frame().page();
2884     return page && view.isVisuallyNonEmpty() && !page->progress().isMainLoadProgressing();
2885 }
2886
2887 void FrameView::enableSpeculativeTilingIfNeeded()
2888 {
2889     ASSERT(!m_speculativeTilingEnabled);
2890     if (m_wasScrolledByUser) {
2891         m_speculativeTilingEnabled = true;
2892         return;
2893     }
2894     if (!shouldEnableSpeculativeTilingDuringLoading(*this))
2895         return;
2896     if (m_speculativeTilingEnableTimer.isActive())
2897         return;
2898     // Delay enabling a bit as load completion may trigger further loading from scripts.
2899     static const double speculativeTilingEnableDelay = 0.5;
2900     m_speculativeTilingEnableTimer.startOneShot(speculativeTilingEnableDelay);
2901 }
2902
2903 void FrameView::speculativeTilingEnableTimerFired()
2904 {
2905     if (m_speculativeTilingEnabled)
2906         return;
2907     m_speculativeTilingEnabled = shouldEnableSpeculativeTilingDuringLoading(*this);
2908     adjustTiledBackingCoverage();
2909 }
2910
2911 void FrameView::show()
2912 {
2913     ScrollView::show();
2914
2915     if (frame().isMainFrame()) {
2916         // Turn off speculative tiling for a brief moment after a FrameView appears on screen.
2917         // Note that adjustTiledBackingCoverage() kicks the (500ms) timer to re-enable it.
2918         m_speculativeTilingEnabled = false;
2919         m_wasScrolledByUser = false;
2920         adjustTiledBackingCoverage();
2921     }
2922 }
2923 void FrameView::convertSubtreeLayoutToFullLayout()
2924 {
2925     ASSERT(m_layoutRoot);
2926     m_layoutRoot->markContainingBlocksForLayout(ScheduleRelayout::No);
2927     m_layoutRoot = nullptr;
2928 }
2929
2930 void FrameView::layoutTimerFired()
2931 {
2932 #if !LOG_DISABLED
2933     if (!frame().document()->ownerElement())
2934         LOG(Layout, "FrameView %p layout timer fired at %.3fs", this, frame().document()->timeSinceDocumentCreation().value());
2935 #endif
2936     layout();
2937 }
2938
2939 void FrameView::scheduleRelayout()
2940 {
2941     // FIXME: We should assert the page is not in the page cache, but that is causing
2942     // too many false assertions.  See <rdar://problem/7218118>.
2943     ASSERT(frame().view() == this);
2944
2945     if (m_layoutRoot)
2946         convertSubtreeLayoutToFullLayout();
2947     if (!m_layoutSchedulingEnabled)
2948         return;
2949     if (!needsLayout())
2950         return;
2951     if (!frame().document()->shouldScheduleLayout())
2952         return;
2953     InspectorInstrumentation::didInvalidateLayout(frame());
2954     // When frame flattening is enabled, the contents of the frame could affect the layout of the parent frames.
2955     // Also invalidate parent frame starting from the owner element of this frame.
2956     if (frame().ownerRenderer() && isInChildFrameWithFrameFlattening())
2957         frame().ownerRenderer()->setNeedsLayout(MarkContainingBlockChain);
2958
2959     Seconds delay = frame().document()->minimumLayoutDelay();
2960     if (m_layoutTimer.isActive() && m_delayedLayout && !delay)
2961         unscheduleRelayout();
2962
2963     if (m_layoutTimer.isActive())
2964         return;
2965
2966     m_delayedLayout = delay.value();
2967
2968 #if !LOG_DISABLED
2969     if (!frame().document()->ownerElement())
2970         LOG(Layout, "FrameView %p scheduling layout for %.3fs", this, delay.value());
2971 #endif
2972
2973     m_layoutTimer.startOneShot(delay);
2974 }
2975
2976 static bool isObjectAncestorContainerOf(RenderObject* ancestor, RenderObject* descendant)
2977 {
2978     for (RenderObject* r = descendant; r; r = r->container()) {
2979         if (r == ancestor)
2980             return true;
2981     }
2982     return false;
2983 }
2984
2985 void FrameView::scheduleRelayoutOfSubtree(RenderElement& newRelayoutRoot)
2986 {
2987     ASSERT(renderView());
2988     const RenderView& renderView = *this->renderView();
2989
2990     // Try to catch unnecessary work during render tree teardown.
2991     ASSERT(!renderView.documentBeingDestroyed());
2992     ASSERT(frame().view() == this);
2993
2994     // When m_layoutRoot is already set, ignore the renderView's needsLayout bit
2995     // since we need to resolve the conflict between the m_layoutRoot and newRelayoutRoot layouts.
2996     if (renderView.needsLayout() && !m_layoutRoot) {
2997         m_layoutRoot = &newRelayoutRoot;
2998         convertSubtreeLayoutToFullLayout();
2999         return;
3000     }
3001
3002     if (!layoutPending() && m_layoutSchedulingEnabled) {
3003         Seconds delay = renderView.document().minimumLayoutDelay();
3004         ASSERT(!newRelayoutRoot.container() || is<RenderView>(newRelayoutRoot.container()) || !newRelayoutRoot.container()->needsLayout());
3005         m_layoutRoot = &newRelayoutRoot;
3006         InspectorInstrumentation::didInvalidateLayout(frame());
3007         m_delayedLayout = delay.value();
3008         m_layoutTimer.startOneShot(delay);
3009         return;
3010     }
3011
3012     if (m_layoutRoot == &newRelayoutRoot)
3013         return;
3014
3015     if (!m_layoutRoot) {
3016         // We already have a pending (full) layout. Just mark the subtree for layout.
3017         newRelayoutRoot.markContainingBlocksForLayout(ScheduleRelayout::No);
3018         InspectorInstrumentation::didInvalidateLayout(frame());
3019         return;
3020     }
3021
3022     if (isObjectAncestorContainerOf(m_layoutRoot, &newRelayoutRoot)) {
3023         // Keep the current root.
3024         newRelayoutRoot.markContainingBlocksForLayout(ScheduleRelayout::No, m_layoutRoot);
3025         ASSERT(!m_layoutRoot->container() || is<RenderView>(m_layoutRoot->container()) || !m_layoutRoot->container()->needsLayout());
3026         return;
3027     }
3028
3029     if (isObjectAncestorContainerOf(&newRelayoutRoot, m_layoutRoot)) {
3030         // Re-root at newRelayoutRoot.
3031         m_layoutRoot->markContainingBlocksForLayout(ScheduleRelayout::No, &newRelayoutRoot);
3032         m_layoutRoot = &newRelayoutRoot;
3033         ASSERT(!m_layoutRoot->container() || is<RenderView>(m_layoutRoot->container()) || !m_layoutRoot->container()->needsLayout());
3034         InspectorInstrumentation::didInvalidateLayout(frame());
3035         return;
3036     }
3037     // Two disjoint subtrees need layout. Mark both of them and issue a full layout instead.
3038     convertSubtreeLayoutToFullLayout();
3039     newRelayoutRoot.markContainingBlocksForLayout(ScheduleRelayout::No);
3040     InspectorInstrumentation::didInvalidateLayout(frame());
3041 }
3042
3043 bool FrameView::layoutPending() const
3044 {
3045     return m_layoutTimer.isActive();
3046 }
3047
3048 bool FrameView::needsStyleRecalcOrLayout(bool includeSubframes) const
3049 {
3050     if (frame().document() && frame().document()->childNeedsStyleRecalc())
3051         return true;
3052     
3053     if (needsLayout())
3054         return true;
3055
3056     if (!includeSubframes)
3057         return false;
3058
3059     for (auto& frameView : renderedChildFrameViews()) {
3060         if (frameView->needsStyleRecalcOrLayout())
3061             return true;
3062     }
3063
3064     return false;
3065 }
3066
3067 bool FrameView::needsLayout() const
3068 {
3069     // This can return true in cases where the document does not have a body yet.
3070     // Document::shouldScheduleLayout takes care of preventing us from scheduling
3071     // layout in that case.
3072     RenderView* renderView = this->renderView();
3073     return layoutPending()
3074         || (renderView && renderView->needsLayout())
3075         || m_layoutRoot
3076         || (m_deferSetNeedsLayoutCount && m_setNeedsLayoutWasDeferred);
3077 }
3078
3079 void FrameView::setNeedsLayout()
3080 {
3081     if (m_deferSetNeedsLayoutCount) {
3082         m_setNeedsLayoutWasDeferred = true;
3083         return;
3084     }
3085
3086     if (auto* renderView = this->renderView()) {
3087         ASSERT(!renderView->inHitTesting());
3088         renderView->setNeedsLayout();
3089     }
3090 }
3091
3092 void FrameView::unscheduleRelayout()
3093 {
3094     if (m_postLayoutTasksTimer.isActive())
3095         m_postLayoutTasksTimer.stop();
3096
3097     if (!m_layoutTimer.isActive())
3098         return;
3099
3100 #if !LOG_DISABLED
3101     if (!frame().document()->ownerElement())
3102         LOG(Layout, "FrameView %p layout timer unscheduled at %.3fs", this, frame().document()->timeSinceDocumentCreation().value());
3103 #endif
3104     
3105     m_layoutTimer.stop();
3106     m_delayedLayout = false;
3107 }
3108
3109 void FrameView::serviceScriptedAnimations()
3110 {
3111     for (auto* frame = m_frame.ptr(); frame; frame = frame->tree().traverseNext()) {
3112         frame->view()->serviceScrollAnimations();
3113         frame->animation().serviceAnimations();
3114     }
3115
3116     if (!frame().document() || !frame().document()->domWindow())
3117         return;
3118
3119     Vector<RefPtr<Document>> documents;
3120     for (auto* frame = m_frame.ptr(); frame; frame = frame->tree().traverseNext())
3121         documents.append(frame->document());
3122
3123     double timestamp = frame().document()->domWindow()->nowTimestamp();
3124     for (auto& document : documents)
3125         document->serviceScriptedAnimations(timestamp);
3126 }
3127
3128 bool FrameView::isTransparent() const
3129 {
3130     return m_isTransparent;
3131 }
3132
3133 void FrameView::setTransparent(bool isTransparent)
3134 {
3135     if (m_isTransparent == isTransparent)
3136         return;
3137
3138     m_isTransparent = isTransparent;
3139
3140     // setTransparent can be called in the window between FrameView initialization
3141     // and switching in the new Document; this means that the RenderView that we
3142     // retrieve is actually attached to the previous Document, which is going away,
3143     // and must not update compositing layers.
3144     if (!isViewForDocumentInFrame())
3145         return;
3146
3147     renderView()->compositor().rootBackgroundTransparencyChanged();
3148 }
3149
3150 bool FrameView::hasOpaqueBackground() const
3151 {
3152     return !m_isTransparent && m_baseBackgroundColor.isOpaque();
3153 }
3154
3155 Color FrameView::baseBackgroundColor() const
3156 {
3157     return m_baseBackgroundColor;
3158 }
3159
3160 void FrameView::setBaseBackgroundColor(const Color& backgroundColor)
3161 {
3162     bool wasOpaque = m_baseBackgroundColor.isOpaque();
3163     
3164     if (!backgroundColor.isValid())
3165         m_baseBackgroundColor = Color::white;
3166     else
3167         m_baseBackgroundColor = backgroundColor;
3168
3169     if (!isViewForDocumentInFrame())
3170         return;
3171
3172     recalculateScrollbarOverlayStyle();
3173
3174     if (m_baseBackgroundColor.isOpaque() != wasOpaque)
3175         renderView()->compositor().rootBackgroundTransparencyChanged();
3176 }
3177
3178 void FrameView::updateBackgroundRecursively(const Color& backgroundColor, bool transparent)
3179 {
3180     for (auto* frame = m_frame.ptr(); frame; frame = frame->tree().traverseNext(m_frame.ptr())) {
3181         if (FrameView* view = frame->view()) {
3182             view->setTransparent(transparent);
3183             view->setBaseBackgroundColor(backgroundColor);
3184         }
3185     }
3186 }
3187
3188 bool FrameView::hasExtendedBackgroundRectForPainting() const
3189 {
3190     if (!frame().settings().backgroundShouldExtendBeyondPage())
3191         return false;
3192
3193     TiledBacking* tiledBacking = this->tiledBacking();
3194     if (!tiledBacking)
3195         return false;
3196
3197     return tiledBacking->hasMargins();
3198 }
3199
3200 void FrameView::updateExtendBackgroundIfNecessary()
3201 {
3202     ExtendedBackgroundMode mode = calculateExtendedBackgroundMode();
3203     if (mode == ExtendedBackgroundModeNone)
3204         return;
3205
3206     updateTilesForExtendedBackgroundMode(mode);
3207 }
3208
3209 FrameView::ExtendedBackgroundMode FrameView::calculateExtendedBackgroundMode() const
3210 {
3211     // Just because Settings::backgroundShouldExtendBeyondPage() is true does not necessarily mean
3212     // that the background rect needs to be extended for painting. Simple backgrounds can be extended
3213     // just with RenderLayerCompositor::setRootExtendedBackgroundColor(). More complicated backgrounds,
3214     // such as images, require extending the background rect to continue painting into the extended
3215     // region. This function finds out if it is necessary to extend the background rect for painting.
3216
3217 #if PLATFORM(IOS)
3218     // <rdar://problem/16201373>
3219     return ExtendedBackgroundModeNone;
3220 #else
3221     if (!frame().settings().backgroundShouldExtendBeyondPage())
3222         return ExtendedBackgroundModeNone;
3223
3224     if (!frame().isMainFrame())
3225         return ExtendedBackgroundModeNone;
3226
3227     Document* document = frame().document();
3228     if (!document)
3229         return ExtendedBackgroundModeNone;
3230
3231     if (!renderView())
3232         return ExtendedBackgroundModeNone;
3233     
3234     auto* rootBackgroundRenderer = renderView()->rendererForRootBackground();
3235     if (!rootBackgroundRenderer)
3236         return ExtendedBackgroundModeNone;
3237
3238     if (!rootBackgroundRenderer->style().hasBackgroundImage())
3239         return ExtendedBackgroundModeNone;
3240
3241     ExtendedBackgroundMode mode = ExtendedBackgroundModeNone;
3242     if (rootBackgroundRenderer->style().backgroundRepeatX() == RepeatFill)
3243         mode |= ExtendedBackgroundModeHorizontal;
3244     if (rootBackgroundRenderer->style().backgroundRepeatY() == RepeatFill)
3245         mode |= ExtendedBackgroundModeVertical;
3246
3247     return mode;
3248 #endif
3249 }
3250
3251 void FrameView::updateTilesForExtendedBackgroundMode(ExtendedBackgroundMode mode)
3252 {
3253     if (!frame().settings().backgroundShouldExtendBeyondPage())
3254         return;
3255
3256     RenderView* renderView = this->renderView();
3257     if (!renderView)
3258         return;
3259
3260     RenderLayerBacking* backing = renderView->layer()->backing();
3261     if (!backing)
3262         return;
3263
3264     TiledBacking* tiledBacking = backing->graphicsLayer()->tiledBacking();
3265     if (!tiledBacking)
3266         return;
3267
3268     ExtendedBackgroundMode existingMode = ExtendedBackgroundModeNone;
3269     if (tiledBacking->hasVerticalMargins())
3270         existingMode |= ExtendedBackgroundModeVertical;
3271     if (tiledBacking->hasHorizontalMargins())
3272         existingMode |= ExtendedBackgroundModeHorizontal;
3273
3274     if (existingMode == mode)
3275         return;
3276
3277     renderView->compositor().setRootExtendedBackgroundColor(mode == ExtendedBackgroundModeAll ? Color() : documentBackgroundColor());
3278     backing->setTiledBackingHasMargins(mode & ExtendedBackgroundModeHorizontal, mode & ExtendedBackgroundModeVertical);
3279 }
3280
3281 IntRect FrameView::extendedBackgroundRectForPainting() const
3282 {
3283     TiledBacking* tiledBacking = this->tiledBacking();
3284     if (!tiledBacking)
3285         return IntRect();
3286     
3287     RenderView* renderView = this->renderView();
3288     if (!renderView)
3289         return IntRect();
3290     
3291     LayoutRect extendedRect = renderView->unextendedBackgroundRect();
3292     if (!tiledBacking->hasMargins())
3293         return snappedIntRect(extendedRect);
3294     
3295     extendedRect.moveBy(LayoutPoint(-tiledBacking->leftMarginWidth(), -tiledBacking->topMarginHeight()));
3296     extendedRect.expand(LayoutSize(tiledBacking->leftMarginWidth() + tiledBacking->rightMarginWidth(), tiledBacking->topMarginHeight() + tiledBacking->bottomMarginHeight()));
3297     return snappedIntRect(extendedRect);
3298 }
3299
3300 bool FrameView::shouldUpdateWhileOffscreen() const
3301 {
3302     return m_shouldUpdateWhileOffscreen;
3303 }
3304
3305 void FrameView::setShouldUpdateWhileOffscreen(bool shouldUpdateWhileOffscreen)
3306 {
3307     m_shouldUpdateWhileOffscreen = shouldUpdateWhileOffscreen;
3308 }
3309
3310 bool FrameView::shouldUpdate() const
3311 {
3312     if (isOffscreen() && !shouldUpdateWhileOffscreen())
3313         return false;
3314     return true;
3315 }
3316
3317 void FrameView::scrollToAnchor()
3318 {
3319     RefPtr<ContainerNode> anchorNode = m_maintainScrollPositionAnchor;
3320     if (!anchorNode)
3321         return;
3322
3323     if (!anchorNode->renderer())
3324         return;
3325
3326     LayoutRect rect;
3327     bool insideFixed = false;
3328     if (anchorNode != frame().document() && anchorNode->renderer())
3329         rect = anchorNode->renderer()->absoluteAnchorRect(&insideFixed);
3330
3331     // Scroll nested layers and frames to reveal the anchor.
3332     // Align to the top and to the closest side (this matches other browsers).
3333     if (anchorNode->renderer()->style().isHorizontalWritingMode())
3334         anchorNode->renderer()->scrollRectToVisible(SelectionRevealMode::Reveal, rect, insideFixed, ScrollAlignment::alignToEdgeIfNeeded, ScrollAlignment::alignTopAlways);
3335     else if (anchorNode->renderer()->style().isFlippedBlocksWritingMode())
3336         anchorNode->renderer()->scrollRectToVisible(SelectionRevealMode::Reveal, rect, insideFixed, ScrollAlignment::alignRightAlways, ScrollAlignment::alignToEdgeIfNeeded);
3337     else
3338         anchorNode->renderer()->scrollRectToVisible(SelectionRevealMode::Reveal, rect, insideFixed, ScrollAlignment::alignLeftAlways, ScrollAlignment::alignToEdgeIfNeeded);
3339
3340     if (AXObjectCache* cache = frame().document()->existingAXObjectCache())
3341         cache->handleScrolledToAnchor(anchorNode.get());
3342
3343     // scrollRectToVisible can call into setScrollPosition(), which resets m_maintainScrollPositionAnchor.
3344     m_maintainScrollPositionAnchor = anchorNode;
3345 }
3346
3347 void FrameView::updateEmbeddedObject(RenderEmbeddedObject& embeddedObject)
3348 {
3349     // No need to update if it's already crashed or known to be missing.
3350     if (embeddedObject.isPluginUnavailable())
3351         return;
3352
3353     HTMLFrameOwnerElement& element = embeddedObject.frameOwnerElement();
3354
3355     if (embeddedObject.isSnapshottedPlugIn()) {
3356         if (is<HTMLObjectElement>(element) || is<HTMLEmbedElement>(element)) {
3357             HTMLPlugInImageElement& pluginElement = downcast<HTMLPlugInImageElement>(element);
3358             pluginElement.checkSnapshotStatus();
3359         }
3360         return;
3361     }
3362
3363     auto weakRenderer = embeddedObject.createWeakPtr();
3364
3365     // FIXME: This could turn into a real virtual dispatch if we defined
3366     // updateWidget(PluginCreationOption) on HTMLElement.
3367     if (is<HTMLPlugInImageElement>(element)) {
3368         HTMLPlugInImageElement& pluginElement = downcast<HTMLPlugInImageElement>(element);
3369         if (pluginElement.needsCheckForSizeChange()) {
3370             pluginElement.checkSnapshotStatus();
3371             return;
3372         }
3373         if (pluginElement.needsWidgetUpdate())
3374             pluginElement.updateWidget(CreatePlugins::Yes);
3375     } else
3376         ASSERT_NOT_REACHED();
3377
3378     // It's possible the renderer was destroyed below updateWidget() since loading a plugin may execute arbitrary JavaScript.
3379     if (!weakRenderer)
3380         return;
3381
3382     auto ignoreWidgetState = embeddedObject.updateWidgetPosition();
3383     UNUSED_PARAM(ignoreWidgetState);
3384 }
3385
3386 bool FrameView::updateEmbeddedObjects()
3387 {
3388     if (m_nestedLayoutCount > 1 || !m_embeddedObjectsToUpdate || m_embeddedObjectsToUpdate->isEmpty())
3389         return true;
3390
3391     WidgetHierarchyUpdatesSuspensionScope suspendWidgetHierarchyUpdates;
3392
3393     // Insert a marker for where we should stop.
3394     ASSERT(!m_embeddedObjectsToUpdate->contains(nullptr));
3395     m_embeddedObjectsToUpdate->add(nullptr);
3396
3397     while (!m_embeddedObjectsToUpdate->isEmpty()) {
3398         RenderEmbeddedObject* embeddedObject = m_embeddedObjectsToUpdate->takeFirst();
3399         if (!embeddedObject)
3400             break;
3401         updateEmbeddedObject(*embeddedObject);
3402     }
3403
3404     return m_embeddedObjectsToUpdate->isEmpty();
3405 }
3406
3407 void FrameView::updateEmbeddedObjectsTimerFired()
3408 {
3409     RefPtr<FrameView> protectedThis(this);
3410     m_updateEmbeddedObjectsTimer.stop();
3411     for (unsigned i = 0; i < maxUpdateEmbeddedObjectsIterations; i++) {
3412         if (updateEmbeddedObjects())
3413             break;
3414     }
3415 }
3416
3417 void FrameView::flushAnyPendingPostLayoutTasks()
3418 {
3419     if (m_postLayoutTasksTimer.isActive())
3420         performPostLayoutTasks();
3421     if (m_updateEmbeddedObjectsTimer.isActive())
3422         updateEmbeddedObjectsTimerFired();
3423 }
3424
3425 void FrameView::queuePostLayoutCallback(Function<void()>&& callback)
3426 {
3427     m_postLayoutCallbackQueue.append(WTFMove(callback));
3428 }
3429
3430 void FrameView::flushPostLayoutTasksQueue()
3431 {
3432     if (m_nestedLayoutCount > 1)
3433         return;
3434
3435     if (!m_postLayoutCallbackQueue.size())
3436         return;
3437
3438     Vector<Function<void()>> queue = WTFMove(m_postLayoutCallbackQueue);
3439     for (auto& task : queue)
3440         task();
3441 }
3442
3443 void FrameView::performPostLayoutTasks()
3444 {
3445     LOG(Layout, "FrameView %p performPostLayoutTasks", this);
3446
3447     // FIXME: We should not run any JavaScript code in this function.
3448
3449     m_postLayoutTasksTimer.stop();
3450
3451     frame().selection().updateAppearanceAfterLayout();
3452
3453     flushPostLayoutTasksQueue();
3454
3455     if (m_nestedLayoutCount <= 1 && frame().document()->documentElement())
3456         fireLayoutRelatedMilestonesIfNeeded();
3457
3458 #if PLATFORM(IOS)
3459     // Only send layout-related delegate callbacks synchronously for the main frame to
3460     // avoid re-entering layout for the main frame while delivering a layout-related delegate
3461     // callback for a subframe.
3462     if (frame().isMainFrame()) {
3463         if (Page* page = frame().page())
3464             page->chrome().client().didLayout();
3465     }
3466 #endif
3467
3468 #if ENABLE(FONT_LOAD_EVENTS)
3469     if (RuntimeEnabledFeatures::sharedFeatures().fontLoadEventsEnabled())
3470         frame().document()->fonts()->didLayout();
3471 #endif
3472     
3473     // FIXME: We should consider adding DidLayout as a LayoutMilestone. That would let us merge this
3474     // with didLayout(LayoutMilestones).
3475     frame().loader().client().dispatchDidLayout();
3476
3477     updateWidgetPositions();
3478
3479 #if ENABLE(CSS_SCROLL_SNAP)
3480     updateSnapOffsets();
3481 #endif
3482
3483     // layout() protects FrameView, but it still can get destroyed when updateEmbeddedObjects()
3484     // is called through the post layout timer.
3485     Ref<FrameView> protectedThis(*this);
3486
3487     m_updateEmbeddedObjectsTimer.startOneShot(0);
3488
3489     if (auto* page = frame().page()) {
3490         if (auto* scrollingCoordinator = page->scrollingCoordinator())
3491             scrollingCoordinator->frameViewLayoutUpdated(*this);
3492     }
3493
3494     if (RenderView* renderView = this->renderView()) {
3495         if (renderView->usesCompositing())
3496             renderView->compositor().frameViewDidLayout();
3497     }
3498
3499     scrollToAnchor();
3500
3501     sendResizeEventIfNeeded();
3502     
3503     updateLayoutViewport();
3504     viewportContentsChanged();
3505
3506     updateScrollSnapState();
3507
3508     if (AXObjectCache* cache = frame().document()->existingAXObjectCache())
3509         cache->performDeferredIsIgnoredChange();
3510 }
3511
3512 IntSize FrameView::sizeForResizeEvent() const
3513 {
3514 #if PLATFORM(IOS)
3515     if (m_useCustomSizeForResizeEvent)
3516         return m_customSizeForResizeEvent;
3517 #endif
3518     if (useFixedLayout() && !fixedLayoutSize().isEmpty() && delegatesScrolling())
3519         return fixedLayoutSize();
3520     return visibleContentRectIncludingScrollbars().size();
3521 }
3522
3523 void FrameView::sendResizeEventIfNeeded()
3524 {
3525     if (isInRenderTreeLayout() || needsLayout())
3526         return;
3527
3528     RenderView* renderView = this->renderView();
3529     if (!renderView || renderView->printing())
3530         return;
3531
3532     if (frame().page() && frame().page()->chrome().client().isSVGImageChromeClient())
3533         return;
3534
3535     IntSize currentSize = sizeForResizeEvent();
3536     float currentZoomFactor = renderView->style().zoom();
3537
3538     if (currentSize == m_lastViewportSize && currentZoomFactor == m_lastZoomFactor)
3539         return;
3540
3541     m_lastViewportSize = currentSize;
3542     m_lastZoomFactor = currentZoomFactor;
3543
3544     if (m_firstLayout)
3545         return;
3546
3547 #if PLATFORM(IOS)
3548     // Don't send the resize event if the document is loading. Some pages automatically reload
3549     // when the window is resized; Safari on iOS often resizes the window while setting up its
3550     // viewport. This obviously can cause problems.
3551     if (DocumentLoader* documentLoader = frame().loader().documentLoader()) {
3552         if (documentLoader->isLoadingInAPISense())
3553             return;
3554     }
3555 #endif
3556
3557     bool isMainFrame = frame().isMainFrame();
3558     bool canSendResizeEventSynchronously = isMainFrame && !m_shouldAutoSize;
3559
3560     Ref<Event> resizeEvent = Event::create(eventNames().resizeEvent, false, false);
3561     if (canSendResizeEventSynchronously)
3562         frame().document()->dispatchWindowEvent(resizeEvent);
3563     else {
3564         // FIXME: Queueing this event for an unpredictable time in the future seems
3565         // intrinsically racy. By the time this resize event fires, the frame might
3566         // be resized again, so we could end up with two resize events for the same size.
3567         frame().document()->enqueueWindowEvent(WTFMove(resizeEvent));
3568     }
3569
3570     if (InspectorInstrumentation::hasFrontends() && isMainFrame) {
3571         if (Page* page = frame().page()) {
3572             if (InspectorClient* inspectorClient = page->inspectorController().inspectorClient())
3573                 inspectorClient->didResizeMainFrame(&frame());
3574         }
3575     }
3576 }
3577
3578 void FrameView::willStartLiveResize()
3579 {
3580     ScrollView::willStartLiveResize();
3581     adjustTiledBackingCoverage();
3582 }
3583     
3584 void FrameView::willEndLiveResize()
3585 {
3586     ScrollView::willEndLiveResize();
3587     adjustTiledBackingCoverage();
3588 }
3589
3590 void FrameView::autoSizeIfEnabled()
3591 {
3592     if (!m_shouldAutoSize)
3593         return;
3594
3595     if (m_inAutoSize)
3596         return;
3597
3598     LOG(Layout, "FrameView %p autoSizeIfEnabled", this);
3599
3600     SetForScope<bool> changeInAutoSize(m_inAutoSize, true);
3601
3602     Document* document = frame().document();
3603     if (!document)
3604         return;
3605
3606     RenderView* documentView = document->renderView();
3607     Element* documentElement = document->documentElement();
3608     if (!documentView || !documentElement)
3609         return;
3610
3611     if (m_layoutRoot)
3612         convertSubtreeLayoutToFullLayout();
3613     // Start from the minimum size and allow it to grow.
3614     resize(m_minAutoSize.width(), m_minAutoSize.height());
3615
3616     IntSize size = frameRect().size();