Implement visual-viewport based position:fixed handling for Mac async scrolling
[WebKit-https.git] / Source / WebCore / page / FrameView.h
1 /*
2    Copyright (C) 1997 Martin Jones (mjones@kde.org)
3              (C) 1998 Waldo Bastian (bastian@kde.org)
4              (C) 1998, 1999 Torben Weis (weis@kde.org)
5              (C) 1999 Lars Knoll (knoll@kde.org)
6              (C) 1999 Antti Koivisto (koivisto@kde.org)
7    Copyright (C) 2004-2009, 2014-2016 Apple Inc. All rights reserved.
8
9    This library is free software; you can redistribute it and/or
10    modify it under the terms of the GNU Library General Public
11    License as published by the Free Software Foundation; either
12    version 2 of the License, or (at your option) any later version.
13
14    This library is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17    Library General Public License for more details.
18
19    You should have received a copy of the GNU Library General Public License
20    along with this library; see the file COPYING.LIB.  If not, write to
21    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22    Boston, MA 02110-1301, USA.
23 */
24
25 #pragma once
26
27 #include "AdjustViewSizeOrNot.h"
28 #include "Color.h"
29 #include "ContainerNode.h"
30 #include "LayoutMilestones.h"
31 #include "LayoutRect.h"
32 #include "Pagination.h"
33 #include "PaintPhase.h"
34 #include "RenderPtr.h"
35 #include "ScrollView.h"
36 #include <memory>
37 #include <wtf/Forward.h>
38 #include <wtf/Function.h>
39 #include <wtf/HashSet.h>
40 #include <wtf/ListHashSet.h>
41 #include <wtf/text/WTFString.h>
42
43 namespace WebCore {
44
45 class AXObjectCache;
46 class Element;
47 class FloatSize;
48 class Frame;
49 class HTMLFrameOwnerElement;
50 class URL;
51 class Node;
52 class Page;
53 class RenderBox;
54 class RenderElement;
55 class RenderEmbeddedObject;
56 class RenderLayer;
57 class RenderObject;
58 class RenderScrollbarPart;
59 class RenderStyle;
60 class RenderView;
61 class RenderWidget;
62
63 Pagination::Mode paginationModeForRenderStyle(const RenderStyle&);
64
65 typedef unsigned long long DOMTimeStamp;
66
67 class FrameView final : public ScrollView {
68 public:
69     friend class RenderView;
70     friend class Internals;
71
72     WEBCORE_EXPORT static Ref<FrameView> create(Frame&);
73     static Ref<FrameView> create(Frame&, const IntSize& initialSize);
74
75     virtual ~FrameView();
76
77     HostWindow* hostWindow() const override;
78     
79     WEBCORE_EXPORT void invalidateRect(const IntRect&) override;
80     void setFrameRect(const IntRect&) override;
81
82 #if ENABLE(REQUEST_ANIMATION_FRAME)
83     bool scheduleAnimation() override;
84 #endif
85
86     Frame& frame() const { return const_cast<Frame&>(m_frame.get()); }
87
88     WEBCORE_EXPORT RenderView* renderView() const;
89
90     int mapFromLayoutToCSSUnits(LayoutUnit) const;
91     LayoutUnit mapFromCSSToLayoutUnits(int) const;
92
93     LayoutUnit marginWidth() const { return m_margins.width(); } // -1 means default
94     LayoutUnit marginHeight() const { return m_margins.height(); } // -1 means default
95     void setMarginWidth(LayoutUnit);
96     void setMarginHeight(LayoutUnit);
97
98     WEBCORE_EXPORT void setCanHaveScrollbars(bool) override;
99     WEBCORE_EXPORT void updateCanHaveScrollbars();
100
101     Ref<Scrollbar> createScrollbar(ScrollbarOrientation) override;
102
103     bool avoidScrollbarCreation() const override;
104
105     void setContentsSize(const IntSize&) override;
106     void updateContentsSize() override;
107
108     void layout(bool allowSubtree = true);
109     WEBCORE_EXPORT bool didFirstLayout() const;
110     void layoutTimerFired();
111     void scheduleRelayout();
112     void scheduleRelayoutOfSubtree(RenderElement&);
113     void unscheduleRelayout();
114     void queuePostLayoutCallback(WTF::Function<void ()>&&);
115     bool layoutPending() const;
116     bool isInLayout() const { return m_layoutPhase != OutsideLayout; }
117     bool isInRenderTreeLayout() const { return m_layoutPhase == InRenderTreeLayout; }
118     WEBCORE_EXPORT bool inPaintableState() { return m_layoutPhase != InRenderTreeLayout && m_layoutPhase != InViewSizeAdjust && m_layoutPhase != InPostLayout; }
119
120     RenderElement* layoutRoot() const { return m_layoutRoot; }
121     void clearLayoutRoot() { m_layoutRoot = nullptr; }
122     int layoutCount() const { return m_layoutCount; }
123
124     WEBCORE_EXPORT bool needsLayout() const;
125     WEBCORE_EXPORT void setNeedsLayout();
126     void setViewportConstrainedObjectsNeedLayout();
127
128     bool needsStyleRecalcOrLayout(bool includeSubframes = true) const;
129
130     bool needsFullRepaint() const { return m_needsFullRepaint; }
131
132     WEBCORE_EXPORT bool renderedCharactersExceed(unsigned threshold);
133
134     WEBCORE_EXPORT void setViewportIsStable(bool stable) { m_viewportIsStable = stable; }
135     bool viewportIsStable() const { return m_viewportIsStable; }
136
137 #if PLATFORM(IOS)
138     bool useCustomFixedPositionLayoutRect() const;
139     IntRect customFixedPositionLayoutRect() const { return m_customFixedPositionLayoutRect; }
140     WEBCORE_EXPORT void setCustomFixedPositionLayoutRect(const IntRect&);
141     bool updateFixedPositionLayoutRect();
142
143     IntSize customSizeForResizeEvent() const { return m_customSizeForResizeEvent; }
144     WEBCORE_EXPORT void setCustomSizeForResizeEvent(IntSize);
145
146     WEBCORE_EXPORT void setScrollVelocity(double horizontalVelocity, double verticalVelocity, double scaleChangeRate, double timestamp);
147 #else
148     bool useCustomFixedPositionLayoutRect() const { return false; }
149 #endif
150
151 #if ENABLE(REQUEST_ANIMATION_FRAME)
152     WEBCORE_EXPORT void serviceScriptedAnimations();
153 #endif
154
155     void willRecalcStyle();
156     bool updateCompositingLayersAfterStyleChange();
157     void updateCompositingLayersAfterLayout();
158
159     void clearBackingStores();
160     void restoreBackingStores();
161
162     // Called when changes to the GraphicsLayer hierarchy have to be synchronized with
163     // content rendered via the normal painting path.
164     void setNeedsOneShotDrawingSynchronization();
165
166     WEBCORE_EXPORT GraphicsLayer* graphicsLayerForPlatformWidget(PlatformWidget);
167     WEBCORE_EXPORT void scheduleLayerFlushAllowingThrottling();
168
169     WEBCORE_EXPORT TiledBacking* tiledBacking() const override;
170
171     // In the future when any ScrollableArea can have a node in th ScrollingTree, this should
172     // become a virtual function on ScrollableArea.
173     uint64_t scrollLayerID() const;
174     ScrollableArea* scrollableAreaForScrollLayerID(uint64_t) const;
175
176     bool hasCompositedContent() const;
177     WEBCORE_EXPORT void enterCompositingMode();
178     WEBCORE_EXPORT bool isEnclosedInCompositingLayer() const;
179
180     // Only used with accelerated compositing, but outside the #ifdef to make linkage easier.
181     // Returns true if the flush was completed.
182     WEBCORE_EXPORT bool flushCompositingStateIncludingSubframes();
183
184     // Returns true when a paint with the PaintBehaviorFlattenCompositingLayers flag set gives
185     // a faithful representation of the content.
186     WEBCORE_EXPORT bool isSoftwareRenderable() const;
187
188     void setIsInWindow(bool);
189
190     void resetScrollbars();
191     void resetScrollbarsAndClearContentsSize();
192     void prepareForDetach();
193     void detachCustomScrollbars();
194     WEBCORE_EXPORT void recalculateScrollbarOverlayStyle();
195
196     void clear();
197
198     WEBCORE_EXPORT bool isTransparent() const;
199     WEBCORE_EXPORT void setTransparent(bool isTransparent);
200     
201     // True if the FrameView is not transparent, and the base background color is opaque.
202     bool hasOpaqueBackground() const;
203
204     WEBCORE_EXPORT Color baseBackgroundColor() const;
205     WEBCORE_EXPORT void setBaseBackgroundColor(const Color&);
206     void updateBackgroundRecursively(const Color&, bool);
207
208     enum ExtendedBackgroundModeFlags {
209         ExtendedBackgroundModeNone          = 0,
210         ExtendedBackgroundModeVertical      = 1 << 0,
211         ExtendedBackgroundModeHorizontal    = 1 << 1,
212         ExtendedBackgroundModeAll           = ExtendedBackgroundModeVertical | ExtendedBackgroundModeHorizontal,
213     };
214     typedef unsigned ExtendedBackgroundMode;
215
216     void updateExtendBackgroundIfNecessary();
217     void updateTilesForExtendedBackgroundMode(ExtendedBackgroundMode);
218     ExtendedBackgroundMode calculateExtendedBackgroundMode() const;
219
220     bool hasExtendedBackgroundRectForPainting() const;
221     IntRect extendedBackgroundRectForPainting() const;
222
223     bool shouldUpdateWhileOffscreen() const;
224     WEBCORE_EXPORT void setShouldUpdateWhileOffscreen(bool);
225     bool shouldUpdate() const;
226
227     WEBCORE_EXPORT void adjustViewSize();
228     
229     WEBCORE_EXPORT void setViewportSizeForCSSViewportUnits(IntSize);
230     IntSize viewportSizeForCSSViewportUnits() const;
231     
232     IntRect windowClipRect() const override;
233     WEBCORE_EXPORT IntRect windowClipRectForFrameOwner(const HTMLFrameOwnerElement*, bool clipToLayerContents) const;
234
235     float visibleContentScaleFactor() const override;
236
237 #if USE(COORDINATED_GRAPHICS)
238     void setFixedVisibleContentRect(const IntRect&) override;
239 #endif
240     WEBCORE_EXPORT void setScrollPosition(const ScrollPosition&) override;
241     void updateLayerPositionsAfterScrolling() override;
242     void updateCompositingLayersAfterScrolling() override;
243     bool requestScrollPositionUpdate(const ScrollPosition&) override;
244     bool isRubberBandInProgress() const override;
245     WEBCORE_EXPORT ScrollPosition minimumScrollPosition() const override;
246     WEBCORE_EXPORT ScrollPosition maximumScrollPosition() const override;
247
248     // The scrollOrigin, scrollPosition, minimumScrollPosition and maximumScrollPosition are all affected by frame scale,
249     // but layoutViewport computations require unscaled scroll positions.
250     ScrollPosition unscaledMinimumScrollPosition() const;
251     ScrollPosition unscaledMaximumScrollPosition() const;
252
253     IntPoint unscaledScrollOrigin() const;
254
255     enum class TriggerLayoutOrNot {
256         No,
257         Yes
258     };
259     void setLayoutViewportOrigin(LayoutPoint, TriggerLayoutOrNot = TriggerLayoutOrNot::Yes);
260     LayoutPoint layoutViewportOrigin() const { return m_layoutViewportOrigin; }
261     
262     LayoutPoint minStableLayoutViewportOrigin() const;
263     LayoutPoint maxStableLayoutViewportOrigin() const;
264
265     // These are in document coordinates, unaffected by zooming.
266     WEBCORE_EXPORT LayoutRect layoutViewportRect() const;
267     WEBCORE_EXPORT LayoutRect visualViewportRect() const;
268
269     // This is different than visibleContentRect() in that it ignores negative (or overly positive)
270     // offsets from rubber-banding, and it takes zooming into account. 
271     LayoutRect viewportConstrainedVisibleContentRect() const;
272     
273     LayoutRect rectForFixedPositionLayout() const;
274
275     void viewportContentsChanged();
276     WEBCORE_EXPORT void resumeVisibleImageAnimationsIncludingSubframes();
277
278     String mediaType() const;
279     WEBCORE_EXPORT void setMediaType(const String&);
280     void adjustMediaTypeForPrinting(bool printing);
281
282     void setCannotBlitToWindow();
283     void setIsOverlapped(bool);
284     void setContentIsOpaque(bool);
285
286     void addSlowRepaintObject(RenderElement*);
287     void removeSlowRepaintObject(RenderElement*);
288     bool hasSlowRepaintObject(const RenderElement& renderer) const { return m_slowRepaintObjects && m_slowRepaintObjects->contains(&renderer); }
289     bool hasSlowRepaintObjects() const { return m_slowRepaintObjects && m_slowRepaintObjects->size(); }
290
291     // Includes fixed- and sticky-position objects.
292     typedef HashSet<RenderElement*> ViewportConstrainedObjectSet;
293     void addViewportConstrainedObject(RenderElement*);
294     void removeViewportConstrainedObject(RenderElement*);
295     const ViewportConstrainedObjectSet* viewportConstrainedObjects() const { return m_viewportConstrainedObjects.get(); }
296     bool hasViewportConstrainedObjects() const { return m_viewportConstrainedObjects && m_viewportConstrainedObjects->size() > 0; }
297     
298     float frameScaleFactor() const;
299
300     // Functions for querying the current scrolled position, negating the effects of overhang
301     // and adjusting for page scale.
302     LayoutPoint scrollPositionForFixedPosition() const;
303     
304     // Static function can be called from another thread.
305     static LayoutPoint scrollPositionForFixedPosition(const LayoutRect& visibleContentRect, const LayoutSize& totalContentsSize, const LayoutPoint& scrollPosition, const LayoutPoint& scrollOrigin, float frameScaleFactor, bool fixedElementsLayoutRelativeToFrame, ScrollBehaviorForFixedElements, int headerHeight, int footerHeight);
306
307     static LayoutPoint computeLayoutViewportOrigin(const LayoutRect& visualViewport, const LayoutPoint& stableLayoutViewportOriginMin, const LayoutPoint& stableLayoutViewportOriginMax, const LayoutRect& layoutViewport);
308
309     // These layers are positioned differently when there is a topContentInset, a header, or a footer. These value need to be computed
310     // on both the main thread and the scrolling thread.
311     static float yPositionForInsetClipLayer(const FloatPoint& scrollPosition, float topContentInset);
312     WEBCORE_EXPORT static FloatPoint positionForRootContentLayer(const FloatPoint& scrollPosition, const FloatPoint& scrollOrigin, float topContentInset, float headerHeight);
313     WEBCORE_EXPORT FloatPoint positionForRootContentLayer() const;
314
315     static float yPositionForHeaderLayer(const FloatPoint& scrollPosition, float topContentInset);
316     static float yPositionForFooterLayer(const FloatPoint& scrollPosition, float topContentInset, float totalContentsHeight, float footerHeight);
317
318 #if PLATFORM(IOS)
319     WEBCORE_EXPORT LayoutRect viewportConstrainedObjectsRect() const;
320     // Static function can be called from another thread.
321     WEBCORE_EXPORT static LayoutRect rectForViewportConstrainedObjects(const LayoutRect& visibleContentRect, const LayoutSize& totalContentsSize, float frameScaleFactor, bool fixedElementsLayoutRelativeToFrame, ScrollBehaviorForFixedElements);
322 #endif
323     
324     bool fixedElementsLayoutRelativeToFrame() const;
325
326     WEBCORE_EXPORT void disableLayerFlushThrottlingTemporarilyForInteraction();
327     bool speculativeTilingEnabled() const { return m_speculativeTilingEnabled; }
328     void loadProgressingStatusChanged();
329
330 #if ENABLE(DASHBOARD_SUPPORT)
331     void updateAnnotatedRegions();
332 #endif
333     WEBCORE_EXPORT void updateControlTints();
334
335     void restoreScrollbar();
336
337     WEBCORE_EXPORT bool wasScrolledByUser() const;
338     WEBCORE_EXPORT void setWasScrolledByUser(bool);
339
340     bool safeToPropagateScrollToParent() const { return m_safeToPropagateScrollToParent; }
341     void setSafeToPropagateScrollToParent(bool isSafe) { m_safeToPropagateScrollToParent = isSafe; }
342
343     void addEmbeddedObjectToUpdate(RenderEmbeddedObject&);
344     void removeEmbeddedObjectToUpdate(RenderEmbeddedObject&);
345
346     WEBCORE_EXPORT void paintContents(GraphicsContext&, const IntRect& dirtyRect) override;
347
348     struct PaintingState {
349         PaintBehavior paintBehavior;
350         bool isTopLevelPainter;
351         bool isFlatteningPaintOfRootFrame;
352         PaintingState()
353             : paintBehavior()
354             , isTopLevelPainter(false)
355             , isFlatteningPaintOfRootFrame(false)
356         {
357         }
358     };
359
360     void willPaintContents(GraphicsContext&, const IntRect& dirtyRect, PaintingState&);
361     void didPaintContents(GraphicsContext&, const IntRect& dirtyRect, PaintingState&);
362
363 #if PLATFORM(IOS)
364     WEBCORE_EXPORT void didReplaceMultipartContent();
365 #endif
366
367     WEBCORE_EXPORT void setPaintBehavior(PaintBehavior);
368     WEBCORE_EXPORT PaintBehavior paintBehavior() const;
369     bool isPainting() const;
370     bool hasEverPainted() const { return m_lastPaintTime; }
371     void setLastPaintTime(double lastPaintTime) { m_lastPaintTime = lastPaintTime; }
372     WEBCORE_EXPORT void setNodeToDraw(Node*);
373
374     enum SelectionInSnapshot { IncludeSelection, ExcludeSelection };
375     enum CoordinateSpaceForSnapshot { DocumentCoordinates, ViewCoordinates };
376     WEBCORE_EXPORT void paintContentsForSnapshot(GraphicsContext&, const IntRect& imageRect, SelectionInSnapshot shouldPaintSelection, CoordinateSpaceForSnapshot);
377
378     void paintOverhangAreas(GraphicsContext&, const IntRect& horizontalOverhangArea, const IntRect& verticalOverhangArea, const IntRect& dirtyRect) override;
379     void paintScrollCorner(GraphicsContext&, const IntRect& cornerRect) override;
380     void paintScrollbar(GraphicsContext&, Scrollbar&, const IntRect&) override;
381
382     WEBCORE_EXPORT Color documentBackgroundColor() const;
383
384     bool isInChildFrameWithFrameFlattening() const;
385
386     void startDisallowingLayout() { ++m_layoutDisallowedCount; }
387     void endDisallowingLayout() { ASSERT(m_layoutDisallowedCount > 0); --m_layoutDisallowedCount; }
388     bool layoutDisallowed() const { return m_layoutDisallowedCount; }
389
390     static double currentPaintTimeStamp() { return sCurrentPaintTimeStamp; } // returns 0 if not painting
391     
392     WEBCORE_EXPORT void updateLayoutAndStyleIfNeededRecursive();
393
394     void incrementVisuallyNonEmptyCharacterCount(unsigned);
395     void incrementVisuallyNonEmptyPixelCount(const IntSize&);
396     void updateIsVisuallyNonEmpty();
397     bool isVisuallyNonEmpty() const { return m_isVisuallyNonEmpty; }
398     WEBCORE_EXPORT void enableAutoSizeMode(bool enable, const IntSize& minSize, const IntSize& maxSize);
399     WEBCORE_EXPORT void setAutoSizeFixedMinimumHeight(int);
400     IntSize autoSizingIntrinsicContentSize() const { return m_autoSizeContentSize; }
401
402     WEBCORE_EXPORT void forceLayout(bool allowSubtree = false);
403     WEBCORE_EXPORT void forceLayoutForPagination(const FloatSize& pageSize, const FloatSize& originalPageSize, float maximumShrinkFactor, AdjustViewSizeOrNot);
404
405     // FIXME: This method is retained because of embedded WebViews in AppKit.  When a WebView is embedded inside
406     // some enclosing view with auto-pagination, no call happens to resize the view.  The new pagination model
407     // needs the view to resize as a result of the breaks, but that means that the enclosing view has to potentially
408     // resize around that view.  Auto-pagination uses the bounds of the actual view that's being printed to determine
409     // the edges of the print operation, so the resize is necessary if the enclosing view's bounds depend on the
410     // web document's bounds.
411     // 
412     // This is already a problem if the view needs to be a different size because of printer fonts or because of print stylesheets.
413     // Mail/Dictionary work around this problem by using the _layoutForPrinting SPI
414     // to at least get print stylesheets and printer fonts into play, but since WebKit doesn't know about the page offset or
415     // page size, it can't actually paginate correctly during _layoutForPrinting.
416     //
417     // We can eventually move Mail to a newer SPI that would let them opt in to the layout-time pagination model,
418     // but that doesn't solve the general problem of how other AppKit views could opt in to the better model.
419     //
420     // NO OTHER PLATFORM BESIDES MAC SHOULD USE THIS METHOD.
421     WEBCORE_EXPORT void adjustPageHeightDeprecated(float* newBottom, float oldTop, float oldBottom, float bottomLimit);
422
423     bool scrollToFragment(const URL&);
424     bool scrollToAnchor(const String&);
425     void maintainScrollPositionAtAnchor(ContainerNode*);
426     WEBCORE_EXPORT void scrollElementToRect(const Element&, const IntRect&);
427
428     // Methods to convert points and rects between the coordinate space of the renderer, and this view.
429     WEBCORE_EXPORT IntRect convertFromRendererToContainingView(const RenderElement*, const IntRect&) const;
430     WEBCORE_EXPORT IntRect convertFromContainingViewToRenderer(const RenderElement*, const IntRect&) const;
431     WEBCORE_EXPORT IntPoint convertFromRendererToContainingView(const RenderElement*, const IntPoint&) const;
432     WEBCORE_EXPORT IntPoint convertFromContainingViewToRenderer(const RenderElement*, const IntPoint&) const;
433
434     // Override ScrollView methods to do point conversion via renderers, in order to take transforms into account.
435     IntRect convertToContainingView(const IntRect&) const override;
436     IntRect convertFromContainingView(const IntRect&) const override;
437     IntPoint convertToContainingView(const IntPoint&) const override;
438     IntPoint convertFromContainingView(const IntPoint&) const override;
439
440     bool isFrameViewScrollCorner(const RenderScrollbarPart& scrollCorner) const { return m_scrollCorner == &scrollCorner; }
441
442     // isScrollable() takes an optional Scrollability parameter that allows the caller to define what they mean by 'scrollable.'
443     // Most callers are interested in the default value, Scrollability::Scrollable, which means that there is actually content
444     // to scroll to, and a scrollbar that will allow you to access it. In some cases, callers want to know if the FrameView is allowed
445     // to rubber-band, which the main frame might be allowed to do even if there is no content to scroll to. In that case,
446     // callers use Scrollability::ScrollableOrRubberbandable.
447     enum class Scrollability { Scrollable, ScrollableOrRubberbandable };
448     WEBCORE_EXPORT bool isScrollable(Scrollability definitionOfScrollable = Scrollability::Scrollable);
449
450     bool isScrollableOrRubberbandable() override;
451     bool hasScrollableOrRubberbandableAncestor() override;
452
453     enum ScrollbarModesCalculationStrategy { RulesFromWebContentOnly, AnyRule };
454     void calculateScrollbarModesForLayout(ScrollbarMode& hMode, ScrollbarMode& vMode, ScrollbarModesCalculationStrategy = AnyRule);
455
456     IntPoint lastKnownMousePosition() const override;
457     bool isHandlingWheelEvent() const override;
458     bool shouldSetCursor() const;
459
460     // FIXME: Remove this method once plugin loading is decoupled from layout.
461     void flushAnyPendingPostLayoutTasks();
462
463     bool shouldSuspendScrollAnimations() const override;
464     void scrollbarStyleChanged(ScrollbarStyle, bool forceUpdate) override;
465
466     RenderBox* embeddedContentBox() const;
467     
468     WEBCORE_EXPORT void setTracksRepaints(bool);
469     bool isTrackingRepaints() const { return m_isTrackingRepaints; }
470     WEBCORE_EXPORT void resetTrackedRepaints();
471     const Vector<FloatRect>& trackedRepaintRects() const { return m_trackedRepaintRects; }
472     String trackedRepaintRectsAsText() const;
473
474     typedef HashSet<ScrollableArea*> ScrollableAreaSet;
475     // Returns whether the scrollable area has just been newly added.
476     WEBCORE_EXPORT bool addScrollableArea(ScrollableArea*);
477     // Returns whether the scrollable area has just been removed.
478     WEBCORE_EXPORT bool removeScrollableArea(ScrollableArea*);
479     bool containsScrollableArea(ScrollableArea*) const;
480     const ScrollableAreaSet* scrollableAreas() const { return m_scrollableAreas.get(); }
481
482     void removeChild(Widget&) override;
483
484     // This function exists for ports that need to handle wheel events manually.
485     // On Mac WebKit1 the underlying NSScrollView just does the scrolling, but on most other platforms
486     // we need this function in order to do the scroll ourselves.
487     bool wheelEvent(const PlatformWheelEvent&);
488
489     WEBCORE_EXPORT void setScrollingPerformanceLoggingEnabled(bool);
490
491     // Page and FrameView both store a Pagination value. Page::pagination() is set only by API,
492     // and FrameView::pagination() is set only by CSS. Page::pagination() will affect all
493     // FrameViews in the page cache, but FrameView::pagination() only affects the current
494     // FrameView. FrameView::pagination() will return m_pagination if it has been set. Otherwise,
495     // it will return Page::pagination() since currently there are no callers that need to
496     // distinguish between the two.
497     const Pagination& pagination() const;
498     void setPagination(const Pagination&);
499     
500     bool inProgrammaticScroll() const override { return m_inProgrammaticScroll; }
501     void setInProgrammaticScroll(bool programmaticScroll) { m_inProgrammaticScroll = programmaticScroll; }
502
503 #if ENABLE(CSS_DEVICE_ADAPTATION)
504     IntSize initialViewportSize() const { return m_initialViewportSize; }
505     void setInitialViewportSize(const IntSize& size) { m_initialViewportSize = size; }
506 #endif
507
508     bool isActive() const override;
509     bool forceUpdateScrollbarsOnMainThreadForPerformanceTesting() const override;
510
511 #if ENABLE(RUBBER_BANDING)
512     WEBCORE_EXPORT GraphicsLayer* setWantsLayerForTopOverHangArea(bool) const;
513     WEBCORE_EXPORT GraphicsLayer* setWantsLayerForBottomOverHangArea(bool) const;
514 #endif
515
516     // This function "smears" the "position:fixed" uninflatedBounds for scrolling, returning a rect that is the union of
517     // all possible locations of the given rect under page scrolling.
518     LayoutRect fixedScrollableAreaBoundsInflatedForScrolling(const LayoutRect& uninflatedBounds) const;
519
520     LayoutPoint scrollPositionRespectingCustomFixedPosition() const;
521
522     int headerHeight() const override { return m_headerHeight; }
523     WEBCORE_EXPORT void setHeaderHeight(int);
524     int footerHeight() const override { return m_footerHeight; }
525     WEBCORE_EXPORT void setFooterHeight(int);
526
527     WEBCORE_EXPORT float topContentInset(TopContentInsetType = TopContentInsetType::WebCoreContentInset) const override;
528     void topContentInsetDidChange(float newTopContentInset);
529
530     void topContentDirectionDidChange();
531
532     WEBCORE_EXPORT void willStartLiveResize() override;
533     WEBCORE_EXPORT void willEndLiveResize() override;
534
535     WEBCORE_EXPORT void availableContentSizeChanged(AvailableSizeChangeReason) override;
536
537     void adjustTiledBackingScrollability();
538
539     void addPaintPendingMilestones(LayoutMilestones);
540     void firePaintRelatedMilestonesIfNeeded();
541     void fireLayoutRelatedMilestonesIfNeeded();
542     LayoutMilestones milestonesPendingPaint() const { return m_milestonesPendingPaint; }
543
544     bool visualUpdatesAllowedByClient() const { return m_visualUpdatesAllowedByClient; }
545     WEBCORE_EXPORT void setVisualUpdatesAllowedByClient(bool);
546
547     WEBCORE_EXPORT void setScrollPinningBehavior(ScrollPinningBehavior);
548
549     ScrollBehaviorForFixedElements scrollBehaviorForFixedElements() const;
550
551     bool hasFlippedBlockRenderers() const { return m_hasFlippedBlockRenderers; }
552     void setHasFlippedBlockRenderers(bool b) { m_hasFlippedBlockRenderers = b; }
553
554     void updateWidgetPositions();
555     void didAddWidgetToRenderTree(Widget&);
556     void willRemoveWidgetFromRenderTree(Widget&);
557
558     const HashSet<Widget*>& widgetsInRenderTree() const { return m_widgetsInRenderTree; }
559
560     typedef Vector<Ref<FrameView>, 16> FrameViewList;
561     FrameViewList renderedChildFrameViews() const;
562
563     void addTrackedRepaintRect(const FloatRect&);
564
565     // exposedRect represents WebKit's understanding of what part
566     // of the view is actually exposed on screen (taking into account
567     // clipping by other UI elements), whereas visibleContentRect is
568     // internal to WebCore and doesn't respect those things.
569     WEBCORE_EXPORT void setViewExposedRect(Optional<FloatRect>);
570     Optional<FloatRect> viewExposedRect() const { return m_viewExposedRect; }
571
572 #if ENABLE(CSS_SCROLL_SNAP)
573     void updateSnapOffsets() override;
574     bool isScrollSnapInProgress() const override;
575     void updateScrollingCoordinatorScrollSnapProperties() const;
576 #endif
577
578     float adjustScrollStepForFixedContent(float step, ScrollbarOrientation, ScrollGranularity) override;
579
580     void didChangeScrollOffset();
581
582     void show() override;
583
584     bool shouldPlaceBlockDirectionScrollbarOnLeft() const final;
585
586 protected:
587     bool scrollContentsFastPath(const IntSize& scrollDelta, const IntRect& rectToScroll, const IntRect& clipRect) override;
588     void scrollContentsSlowPath(const IntRect& updateRect) override;
589     
590     void repaintSlowRepaintObjects();
591
592     bool isVerticalDocument() const override;
593     bool isFlippedDocument() const override;
594
595 private:
596     explicit FrameView(Frame&);
597
598     void reset();
599     void init();
600
601     enum LayoutPhase {
602         OutsideLayout,
603         InPreLayout,
604         InPreLayoutStyleUpdate,
605         InRenderTreeLayout,
606         InViewSizeAdjust,
607         InPostLayout,
608         InPostLayerPositionsUpdatedAfterLayout,
609     };
610     LayoutPhase layoutPhase() const { return m_layoutPhase; }
611
612     bool inPreLayoutStyleUpdate() const { return m_layoutPhase == InPreLayoutStyleUpdate; }
613
614     bool isFrameView() const override { return true; }
615
616     friend class RenderWidget;
617     bool useSlowRepaints(bool considerOverlap = true) const;
618     bool useSlowRepaintsIfNotOverlapped() const;
619     void updateCanBlitOnScrollRecursively();
620     bool shouldLayoutAfterContentsResized() const;
621
622     bool shouldUpdateCompositingLayersAfterScrolling() const;
623     bool flushCompositingStateForThisFrame(const Frame& rootFrameForFlush);
624
625     bool shouldDeferScrollUpdateAfterContentSizeChange() override;
626
627     void scrollOffsetChangedViaPlatformWidgetImpl(const ScrollOffset& oldOffset, const ScrollOffset& newOffset) override;
628
629     void applyOverflowToViewport(const RenderElement&, ScrollbarMode& hMode, ScrollbarMode& vMode);
630     void applyPaginationToViewport();
631
632     void updateOverflowStatus(bool horizontalOverflow, bool verticalOverflow);
633
634     WEBCORE_EXPORT void paintControlTints();
635
636     void forceLayoutParentViewIfNeeded();
637     void flushPostLayoutTasksQueue();
638     void performPostLayoutTasks();
639     void autoSizeIfEnabled();
640
641     void applyRecursivelyWithVisibleRect(const std::function<void (FrameView& frameView, const IntRect& visibleRect)>&);
642     void resumeVisibleImageAnimations(const IntRect& visibleRect);
643     void updateScriptedAnimationsAndTimersThrottlingState(const IntRect& visibleRect);
644
645     void updateLayerFlushThrottling();
646     WEBCORE_EXPORT void adjustTiledBackingCoverage();
647
648     void repaintContentRectangle(const IntRect&) override;
649     void addedOrRemovedScrollbar() override;
650
651     void delegatesScrollingDidChange() override;
652
653     // ScrollableArea interface
654     void invalidateScrollbarRect(Scrollbar&, const IntRect&) override;
655     void scrollTo(const ScrollPosition&) override;
656     void setVisibleScrollerThumbRect(const IntRect&) override;
657     ScrollableArea* enclosingScrollableArea() const override;
658     IntRect scrollableAreaBoundingBox(bool* = nullptr) const override;
659     bool scrollAnimatorEnabled() const override;
660     GraphicsLayer* layerForScrolling() const override;
661     GraphicsLayer* layerForHorizontalScrollbar() const override;
662     GraphicsLayer* layerForVerticalScrollbar() const override;
663     GraphicsLayer* layerForScrollCorner() const override;
664 #if ENABLE(RUBBER_BANDING)
665     GraphicsLayer* layerForOverhangAreas() const override;
666 #endif
667     void contentsResized() override;
668
669 #if PLATFORM(IOS)
670     void unobscuredContentSizeChanged() override;
671 #endif
672
673     bool usesCompositedScrolling() const override;
674     bool usesAsyncScrolling() const override;
675     bool usesMockScrollAnimator() const override;
676     void logMockScrollAnimatorMessage(const String&) const override;
677
678     // Override scrollbar notifications to update the AXObject cache.
679     void didAddScrollbar(Scrollbar*, ScrollbarOrientation) override;
680     void willRemoveScrollbar(Scrollbar*, ScrollbarOrientation) override;
681
682     IntSize sizeForResizeEvent() const;
683     void sendResizeEventIfNeeded();
684
685     void handleDeferredScrollbarsUpdateAfterDirectionChange();
686
687     void updateScrollableAreaSet();
688     void updateLayoutViewport();
689
690     void notifyPageThatContentAreaWillPaint() const override;
691
692     void enableSpeculativeTilingIfNeeded();
693     void speculativeTilingEnableTimerFired();
694
695     void updateEmbeddedObjectsTimerFired();
696     bool updateEmbeddedObjects();
697     void updateEmbeddedObject(RenderEmbeddedObject&);
698     void scrollToAnchor();
699     void scrollPositionChanged(const ScrollPosition& oldPosition, const ScrollPosition& newPosition);
700     void scrollableAreaSetChanged();
701     void sendScrollEvent();
702
703     bool hasCustomScrollbars() const;
704
705     void updateScrollCorner() override;
706
707     FrameView* parentFrameView() const;
708
709     void startLayoutAtMainFrameViewIfNeeded(bool allowSubtree);
710     bool frameFlatteningEnabled() const;
711     bool isFrameFlatteningValidForThisFrame() const;
712
713     bool qualifiesAsVisuallyNonEmpty() const;
714     bool isViewForDocumentInFrame() const;
715
716     AXObjectCache* axObjectCache() const;
717     void notifyWidgetsInAllFrames(WidgetNotification);
718     void removeFromAXObjectCache();
719     void notifyWidgets(WidgetNotification);
720
721     void convertSubtreeLayoutToFullLayout();
722
723     RenderElement* viewportRenderer() const;
724
725     HashSet<Widget*> m_widgetsInRenderTree;
726
727     static double sCurrentPaintTimeStamp; // used for detecting decoded resource thrash in the cache
728
729     LayoutSize m_size;
730     LayoutSize m_margins;
731
732     std::unique_ptr<ListHashSet<RenderEmbeddedObject*>> m_embeddedObjectsToUpdate;
733     const Ref<Frame> m_frame;
734
735     std::unique_ptr<HashSet<const RenderElement*>> m_slowRepaintObjects;
736
737     bool m_needsFullRepaint;
738     
739     bool m_canHaveScrollbars;
740     bool m_cannotBlitToWindow;
741     bool m_isOverlapped { false };
742     bool m_contentIsOpaque;
743
744     Timer m_layoutTimer;
745     bool m_delayedLayout;
746     RenderElement* m_layoutRoot { nullptr };
747
748     LayoutPhase m_layoutPhase;
749     bool m_layoutSchedulingEnabled;
750     bool m_inSynchronousPostLayout;
751     int m_layoutCount;
752     unsigned m_nestedLayoutCount;
753     Timer m_postLayoutTasksTimer;
754     Timer m_updateEmbeddedObjectsTimer;
755     bool m_firstLayoutCallbackPending;
756
757     bool m_firstLayout;
758     bool m_isTransparent;
759     Color m_baseBackgroundColor;
760     IntSize m_lastViewportSize;
761     float m_lastZoomFactor;
762
763     String m_mediaType;
764     String m_mediaTypeWhenNotPrinting;
765
766     bool m_overflowStatusDirty;
767     bool m_horizontalOverflow;
768     bool m_verticalOverflow;
769     enum class ViewportRendererType { None, Document, Body };
770     ViewportRendererType m_viewportRendererType { ViewportRendererType::None };
771
772     Pagination m_pagination;
773
774     bool m_wasScrolledByUser;
775     bool m_inProgrammaticScroll;
776     bool m_safeToPropagateScrollToParent;
777     Timer m_delayedScrollEventTimer;
778
779     double m_lastPaintTime;
780
781     bool m_isTrackingRepaints; // Used for testing.
782     Vector<FloatRect> m_trackedRepaintRects;
783
784     bool m_shouldUpdateWhileOffscreen;
785
786     Optional<FloatRect> m_viewExposedRect;
787     
788     LayoutPoint m_layoutViewportOrigin;
789
790     unsigned m_deferSetNeedsLayoutCount;
791     bool m_setNeedsLayoutWasDeferred;
792     int m_layoutDisallowedCount { 0 };
793
794     RefPtr<Node> m_nodeToDraw;
795     PaintBehavior m_paintBehavior;
796     bool m_isPainting;
797
798     unsigned m_visuallyNonEmptyCharacterCount;
799     unsigned m_visuallyNonEmptyPixelCount;
800     bool m_isVisuallyNonEmpty;
801     bool m_firstVisuallyNonEmptyLayoutCallbackPending;
802
803     bool m_viewportIsStable { true };
804
805     bool m_needsDeferredScrollbarsUpdate { false };
806
807     RefPtr<ContainerNode> m_maintainScrollPositionAnchor;
808
809     // Renderer to hold our custom scroll corner.
810     RenderPtr<RenderScrollbarPart> m_scrollCorner;
811
812     bool m_speculativeTilingEnabled;
813     Timer m_speculativeTilingEnableTimer;
814
815 #if PLATFORM(IOS)
816     bool m_useCustomFixedPositionLayoutRect;
817     IntRect m_customFixedPositionLayoutRect;
818
819     bool m_useCustomSizeForResizeEvent;
820     IntSize m_customSizeForResizeEvent;
821 #endif
822
823     IntSize m_overrideViewportSize;
824     bool m_hasOverrideViewportSize;
825
826     // If true, automatically resize the frame view around its content.
827     bool m_shouldAutoSize;
828     bool m_inAutoSize;
829     // True if autosize has been run since m_shouldAutoSize was set.
830     bool m_didRunAutosize;
831     // The lower bound on the size when autosizing.
832     IntSize m_minAutoSize;
833     // The upper bound on the size when autosizing.
834     IntSize m_maxAutoSize;
835     // The fixed height to resize the view to after autosizing is complete.
836     int m_autoSizeFixedMinimumHeight;
837     // The intrinsic content size decided by autosizing.
838     IntSize m_autoSizeContentSize;
839
840     std::unique_ptr<ScrollableAreaSet> m_scrollableAreas;
841     std::unique_ptr<ViewportConstrainedObjectSet> m_viewportConstrainedObjects;
842
843     int m_headerHeight;
844     int m_footerHeight;
845
846     LayoutMilestones m_milestonesPendingPaint;
847
848     static const unsigned visualCharacterThreshold = 200;
849     static const unsigned visualPixelThreshold = 32 * 32;
850
851 #if ENABLE(CSS_DEVICE_ADAPTATION)
852     // Size of viewport before any UA or author styles have overridden
853     // the viewport given by the window or viewing area of the UA.
854     IntSize m_initialViewportSize;
855 #endif
856
857     bool m_visualUpdatesAllowedByClient;
858     bool m_hasFlippedBlockRenderers;
859
860     ScrollPinningBehavior m_scrollPinningBehavior;
861
862     IntRect* m_cachedWindowClipRect { nullptr };
863     Vector<WTF::Function<void ()>> m_postLayoutCallbackQueue;
864 };
865
866 inline void FrameView::incrementVisuallyNonEmptyCharacterCount(unsigned count)
867 {
868     if (m_isVisuallyNonEmpty)
869         return;
870     m_visuallyNonEmptyCharacterCount += count;
871     if (m_visuallyNonEmptyCharacterCount <= visualCharacterThreshold)
872         return;
873     updateIsVisuallyNonEmpty();
874 }
875
876 inline void FrameView::incrementVisuallyNonEmptyPixelCount(const IntSize& size)
877 {
878     if (m_isVisuallyNonEmpty)
879         return;
880     m_visuallyNonEmptyPixelCount += size.width() * size.height();
881     if (m_visuallyNonEmptyPixelCount <= visualPixelThreshold)
882         return;
883     updateIsVisuallyNonEmpty();
884 }
885
886 } // namespace WebCore
887
888 SPECIALIZE_TYPE_TRAITS_WIDGET(FrameView, isFrameView())