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