Change ScrollView::scrollTo() to take a ScrollPosition
[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-2015 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 #ifndef FrameView_h
26 #define FrameView_h
27
28 #include "AdjustViewSizeOrNot.h"
29 #include "Color.h"
30 #include "ContainerNode.h"
31 #include "LayoutMilestones.h"
32 #include "LayoutRect.h"
33 #include "Pagination.h"
34 #include "PaintPhase.h"
35 #include "RenderPtr.h"
36 #include "ScrollView.h"
37 #include <memory>
38 #include <wtf/Forward.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     virtual HostWindow* hostWindow() const override;
78     
79     WEBCORE_EXPORT virtual void invalidateRect(const IntRect&) override;
80     virtual void setFrameRect(const IntRect&) override;
81
82 #if ENABLE(REQUEST_ANIMATION_FRAME)
83     virtual 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 virtual void setCanHaveScrollbars(bool) override;
99     WEBCORE_EXPORT void updateCanHaveScrollbars();
100
101     virtual PassRefPtr<Scrollbar> createScrollbar(ScrollbarOrientation) override;
102
103     virtual bool avoidScrollbarCreation() const override;
104
105     virtual void setContentsSize(const IntSize&) override;
106     virtual void updateContentsSize() override;
107
108     WEBCORE_EXPORT IntSize contentsSizeRespectingOverflow() const;
109
110     void layout(bool allowSubtree = true);
111     WEBCORE_EXPORT bool didFirstLayout() const;
112     void layoutTimerFired();
113     void scheduleRelayout();
114     void scheduleRelayoutOfSubtree(RenderElement&);
115     void unscheduleRelayout();
116     bool layoutPending() const;
117     bool isInLayout() const { return m_layoutPhase == InLayout; }
118     WEBCORE_EXPORT bool inPaintableState() { return m_layoutPhase != InLayout && 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 { return m_useCustomFixedPositionLayoutRect; }
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(double monotonicAnimationStartTime);
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 virtual 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     virtual IntRect windowClipRect() const override;
233     WEBCORE_EXPORT IntRect windowClipRectForFrameOwner(const HTMLFrameOwnerElement*, bool clipToLayerContents) const;
234
235     virtual float visibleContentScaleFactor() const override;
236
237 #if USE(COORDINATED_GRAPHICS)
238     virtual void setFixedVisibleContentRect(const IntRect&) override;
239 #endif
240     WEBCORE_EXPORT virtual void setScrollPosition(const IntPoint&) override;
241     virtual void updateLayerPositionsAfterScrolling() override;
242     virtual void updateCompositingLayersAfterScrolling() override;
243     virtual bool requestScrollPositionUpdate(const IntPoint&) override;
244     virtual bool isRubberBandInProgress() const override;
245     WEBCORE_EXPORT virtual ScrollPosition minimumScrollPosition() const override;
246     WEBCORE_EXPORT virtual ScrollPosition maximumScrollPosition() const override;
247
248     void viewportContentsChanged();
249     WEBCORE_EXPORT void resumeVisibleImageAnimationsIncludingSubframes();
250
251     // This is different than visibleContentRect() in that it ignores negative (or overly positive)
252     // offsets from rubber-banding, and it takes zooming into account. 
253     LayoutRect viewportConstrainedVisibleContentRect() const;
254
255     String mediaType() const;
256     WEBCORE_EXPORT void setMediaType(const String&);
257     void adjustMediaTypeForPrinting(bool printing);
258
259     void setCannotBlitToWindow();
260     void setIsOverlapped(bool);
261     bool isOverlapped() const { return m_isOverlapped; }
262     bool isOverlappedIncludingAncestors() const;
263     void setContentIsOpaque(bool);
264
265     void addSlowRepaintObject(RenderElement*);
266     void removeSlowRepaintObject(RenderElement*);
267     bool hasSlowRepaintObject(const RenderElement& renderer) const { return m_slowRepaintObjects && m_slowRepaintObjects->contains(&renderer); }
268     bool hasSlowRepaintObjects() const { return m_slowRepaintObjects && m_slowRepaintObjects->size(); }
269
270     // Includes fixed- and sticky-position objects.
271     typedef HashSet<RenderElement*> ViewportConstrainedObjectSet;
272     void addViewportConstrainedObject(RenderElement*);
273     void removeViewportConstrainedObject(RenderElement*);
274     const ViewportConstrainedObjectSet* viewportConstrainedObjects() const { return m_viewportConstrainedObjects.get(); }
275     bool hasViewportConstrainedObjects() const { return m_viewportConstrainedObjects && m_viewportConstrainedObjects->size() > 0; }
276     
277     float frameScaleFactor() const;
278
279     // Functions for querying the current scrolled position, negating the effects of overhang
280     // and adjusting for page scale.
281     LayoutPoint scrollPositionForFixedPosition() const
282     {
283         return scrollPositionForFixedPosition(visibleContentRect(), totalContentsSize(), scrollPosition(), scrollOrigin(), frameScaleFactor(), fixedElementsLayoutRelativeToFrame(), scrollBehaviorForFixedElements(), headerHeight(), footerHeight());
284     }
285     
286     // Static function can be called from another thread.
287     static LayoutPoint scrollPositionForFixedPosition(const LayoutRect& visibleContentRect, const LayoutSize& totalContentsSize, const LayoutPoint& scrollPosition, const LayoutPoint& scrollOrigin, float frameScaleFactor, bool fixedElementsLayoutRelativeToFrame, ScrollBehaviorForFixedElements, int headerHeight, int footerHeight);
288
289     // These layers are positioned differently when there is a topContentInset, a header, or a footer. These value need to be computed
290     // on both the main thread and the scrolling thread.
291     static float yPositionForInsetClipLayer(const FloatPoint& scrollPosition, float topContentInset);
292     WEBCORE_EXPORT static float yPositionForRootContentLayer(const FloatPoint& scrollPosition, float topContentInset, float headerHeight);
293     WEBCORE_EXPORT float yPositionForRootContentLayer() const;
294
295     static float yPositionForHeaderLayer(const FloatPoint& scrollPosition, float topContentInset);
296     static float yPositionForFooterLayer(const FloatPoint& scrollPosition, float topContentInset, float totalContentsHeight, float footerHeight);
297
298 #if PLATFORM(IOS)
299     WEBCORE_EXPORT LayoutRect viewportConstrainedObjectsRect() const;
300     // Static function can be called from another thread.
301     WEBCORE_EXPORT static LayoutRect rectForViewportConstrainedObjects(const LayoutRect& visibleContentRect, const LayoutSize& totalContentsSize, float frameScaleFactor, bool fixedElementsLayoutRelativeToFrame, ScrollBehaviorForFixedElements);
302 #endif
303     
304     bool fixedElementsLayoutRelativeToFrame() const;
305
306     WEBCORE_EXPORT void disableLayerFlushThrottlingTemporarilyForInteraction();
307     bool speculativeTilingEnabled() const { return m_speculativeTilingEnabled; }
308     void loadProgressingStatusChanged();
309
310 #if ENABLE(DASHBOARD_SUPPORT)
311     void updateAnnotatedRegions();
312 #endif
313     WEBCORE_EXPORT void updateControlTints();
314
315     void restoreScrollbar();
316
317     WEBCORE_EXPORT bool wasScrolledByUser() const;
318     WEBCORE_EXPORT void setWasScrolledByUser(bool);
319
320     bool safeToPropagateScrollToParent() const { return m_safeToPropagateScrollToParent; }
321     void setSafeToPropagateScrollToParent(bool isSafe) { m_safeToPropagateScrollToParent = isSafe; }
322
323     void addEmbeddedObjectToUpdate(RenderEmbeddedObject&);
324     void removeEmbeddedObjectToUpdate(RenderEmbeddedObject&);
325
326     WEBCORE_EXPORT virtual void paintContents(GraphicsContext&, const IntRect& dirtyRect) override;
327
328     struct PaintingState {
329         PaintBehavior paintBehavior;
330         bool isTopLevelPainter;
331         bool isFlatteningPaintOfRootFrame;
332         PaintingState()
333             : paintBehavior()
334             , isTopLevelPainter(false)
335             , isFlatteningPaintOfRootFrame(false)
336         {
337         }
338     };
339
340     void willPaintContents(GraphicsContext&, const IntRect& dirtyRect, PaintingState&);
341     void didPaintContents(GraphicsContext&, const IntRect& dirtyRect, PaintingState&);
342
343 #if PLATFORM(IOS)
344     WEBCORE_EXPORT void didReplaceMultipartContent();
345 #endif
346
347     WEBCORE_EXPORT void setPaintBehavior(PaintBehavior);
348     WEBCORE_EXPORT PaintBehavior paintBehavior() const;
349     bool isPainting() const;
350     bool hasEverPainted() const { return m_lastPaintTime; }
351     void setLastPaintTime(double lastPaintTime) { m_lastPaintTime = lastPaintTime; }
352     WEBCORE_EXPORT void setNodeToDraw(Node*);
353
354     enum SelectionInSnapshot { IncludeSelection, ExcludeSelection };
355     enum CoordinateSpaceForSnapshot { DocumentCoordinates, ViewCoordinates };
356     WEBCORE_EXPORT void paintContentsForSnapshot(GraphicsContext&, const IntRect& imageRect, SelectionInSnapshot shouldPaintSelection, CoordinateSpaceForSnapshot);
357
358     virtual void paintOverhangAreas(GraphicsContext&, const IntRect& horizontalOverhangArea, const IntRect& verticalOverhangArea, const IntRect& dirtyRect) override;
359     virtual void paintScrollCorner(GraphicsContext&, const IntRect& cornerRect) override;
360     virtual void paintScrollbar(GraphicsContext&, Scrollbar&, const IntRect&) override;
361
362     WEBCORE_EXPORT Color documentBackgroundColor() const;
363
364     bool isInChildFrameWithFrameFlattening() const;
365
366     void startDisallowingLayout() { ++m_layoutDisallowed; }
367     void endDisallowingLayout() { ASSERT(m_layoutDisallowed > 0); --m_layoutDisallowed; }
368     bool layoutDisallowed() const { return m_layoutDisallowed; }
369
370     static double currentPaintTimeStamp() { return sCurrentPaintTimeStamp; } // returns 0 if not painting
371     
372     WEBCORE_EXPORT void updateLayoutAndStyleIfNeededRecursive();
373
374     void incrementVisuallyNonEmptyCharacterCount(unsigned);
375     void incrementVisuallyNonEmptyPixelCount(const IntSize&);
376     void updateIsVisuallyNonEmpty();
377     bool isVisuallyNonEmpty() const { return m_isVisuallyNonEmpty; }
378     WEBCORE_EXPORT void enableAutoSizeMode(bool enable, const IntSize& minSize, const IntSize& maxSize);
379     WEBCORE_EXPORT void setAutoSizeFixedMinimumHeight(int);
380     IntSize autoSizingIntrinsicContentSize() const { return m_autoSizeContentSize; }
381
382     WEBCORE_EXPORT void forceLayout(bool allowSubtree = false);
383     WEBCORE_EXPORT void forceLayoutForPagination(const FloatSize& pageSize, const FloatSize& originalPageSize, float maximumShrinkFactor, AdjustViewSizeOrNot);
384
385     // FIXME: This method is retained because of embedded WebViews in AppKit.  When a WebView is embedded inside
386     // some enclosing view with auto-pagination, no call happens to resize the view.  The new pagination model
387     // needs the view to resize as a result of the breaks, but that means that the enclosing view has to potentially
388     // resize around that view.  Auto-pagination uses the bounds of the actual view that's being printed to determine
389     // the edges of the print operation, so the resize is necessary if the enclosing view's bounds depend on the
390     // web document's bounds.
391     // 
392     // This is already a problem if the view needs to be a different size because of printer fonts or because of print stylesheets.
393     // Mail/Dictionary work around this problem by using the _layoutForPrinting SPI
394     // to at least get print stylesheets and printer fonts into play, but since WebKit doesn't know about the page offset or
395     // page size, it can't actually paginate correctly during _layoutForPrinting.
396     //
397     // We can eventually move Mail to a newer SPI that would let them opt in to the layout-time pagination model,
398     // but that doesn't solve the general problem of how other AppKit views could opt in to the better model.
399     //
400     // NO OTHER PLATFORM BESIDES MAC SHOULD USE THIS METHOD.
401     WEBCORE_EXPORT void adjustPageHeightDeprecated(float* newBottom, float oldTop, float oldBottom, float bottomLimit);
402
403     bool scrollToFragment(const URL&);
404     bool scrollToAnchor(const String&);
405     void maintainScrollPositionAtAnchor(ContainerNode*);
406     WEBCORE_EXPORT void scrollElementToRect(const Element&, const IntRect&);
407
408     // Methods to convert points and rects between the coordinate space of the renderer, and this view.
409     WEBCORE_EXPORT IntRect convertFromRendererToContainingView(const RenderElement*, const IntRect&) const;
410     WEBCORE_EXPORT IntRect convertFromContainingViewToRenderer(const RenderElement*, const IntRect&) const;
411     WEBCORE_EXPORT IntPoint convertFromRendererToContainingView(const RenderElement*, const IntPoint&) const;
412     WEBCORE_EXPORT IntPoint convertFromContainingViewToRenderer(const RenderElement*, const IntPoint&) const;
413
414     // Override ScrollView methods to do point conversion via renderers, in order to take transforms into account.
415     virtual IntRect convertToContainingView(const IntRect&) const override;
416     virtual IntRect convertFromContainingView(const IntRect&) const override;
417     virtual IntPoint convertToContainingView(const IntPoint&) const override;
418     virtual IntPoint convertFromContainingView(const IntPoint&) const override;
419
420     bool isFrameViewScrollCorner(const RenderScrollbarPart& scrollCorner) const { return m_scrollCorner == &scrollCorner; }
421
422     // isScrollable() takes an optional Scrollability parameter that allows the caller to define what they mean by 'scrollable.'
423     // Most callers are interested in the default value, Scrollability::Scrollable, which means that there is actually content
424     // 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
425     // to rubber-band, which the main frame might be allowed to do even if there is no content to scroll to. In that case,
426     // callers use Scrollability::ScrollableOrRubberbandable.
427     enum class Scrollability { Scrollable, ScrollableOrRubberbandable };
428     WEBCORE_EXPORT bool isScrollable(Scrollability definitionOfScrollable = Scrollability::Scrollable);
429
430     virtual bool isScrollableOrRubberbandable() override;
431     virtual bool hasScrollableOrRubberbandableAncestor() override;
432
433     enum ScrollbarModesCalculationStrategy { RulesFromWebContentOnly, AnyRule };
434     void calculateScrollbarModesForLayout(ScrollbarMode& hMode, ScrollbarMode& vMode, ScrollbarModesCalculationStrategy = AnyRule);
435
436     virtual IntPoint lastKnownMousePosition() const override;
437     virtual bool isHandlingWheelEvent() const override;
438     bool shouldSetCursor() const;
439
440     // FIXME: Remove this method once plugin loading is decoupled from layout.
441     void flushAnyPendingPostLayoutTasks();
442
443     virtual bool shouldSuspendScrollAnimations() const override;
444     virtual void scrollbarStyleChanged(ScrollbarStyle, bool forceUpdate) override;
445
446     RenderBox* embeddedContentBox() const;
447     
448     WEBCORE_EXPORT void setTracksRepaints(bool);
449     bool isTrackingRepaints() const { return m_isTrackingRepaints; }
450     WEBCORE_EXPORT void resetTrackedRepaints();
451     const Vector<FloatRect>& trackedRepaintRects() const { return m_trackedRepaintRects; }
452     String trackedRepaintRectsAsText() const;
453
454     typedef HashSet<ScrollableArea*> ScrollableAreaSet;
455     // Returns whether the scrollable area has just been newly added.
456     WEBCORE_EXPORT bool addScrollableArea(ScrollableArea*);
457     // Returns whether the scrollable area has just been removed.
458     WEBCORE_EXPORT bool removeScrollableArea(ScrollableArea*);
459     bool containsScrollableArea(ScrollableArea*) const;
460     const ScrollableAreaSet* scrollableAreas() const { return m_scrollableAreas.get(); }
461     void clearScrollableAreas();
462
463     virtual void removeChild(Widget&) override;
464
465     // This function exists for ports that need to handle wheel events manually.
466     // On Mac WebKit1 the underlying NSScrollView just does the scrolling, but on most other platforms
467     // we need this function in order to do the scroll ourselves.
468     bool wheelEvent(const PlatformWheelEvent&);
469
470     WEBCORE_EXPORT void setScrollingPerformanceLoggingEnabled(bool);
471
472     // Page and FrameView both store a Pagination value. Page::pagination() is set only by API,
473     // and FrameView::pagination() is set only by CSS. Page::pagination() will affect all
474     // FrameViews in the page cache, but FrameView::pagination() only affects the current
475     // FrameView. FrameView::pagination() will return m_pagination if it has been set. Otherwise,
476     // it will return Page::pagination() since currently there are no callers that need to
477     // distinguish between the two.
478     const Pagination& pagination() const;
479     void setPagination(const Pagination&);
480     
481     bool inProgrammaticScroll() const override { return m_inProgrammaticScroll; }
482     void setInProgrammaticScroll(bool programmaticScroll) { m_inProgrammaticScroll = programmaticScroll; }
483
484 #if ENABLE(CSS_DEVICE_ADAPTATION)
485     IntSize initialViewportSize() const { return m_initialViewportSize; }
486     void setInitialViewportSize(const IntSize& size) { m_initialViewportSize = size; }
487 #endif
488
489     virtual bool isActive() const override;
490     virtual bool updatesScrollLayerPositionOnMainThread() const override;
491     virtual bool forceUpdateScrollbarsOnMainThreadForPerformanceTesting() const override;
492
493 #if ENABLE(RUBBER_BANDING)
494     WEBCORE_EXPORT GraphicsLayer* setWantsLayerForTopOverHangArea(bool) const;
495     WEBCORE_EXPORT GraphicsLayer* setWantsLayerForBottomOverHangArea(bool) const;
496 #endif
497
498     LayoutRect fixedScrollableAreaBoundsInflatedForScrolling(const LayoutRect& uninflatedBounds) const;
499     LayoutPoint scrollPositionRespectingCustomFixedPosition() const;
500
501     virtual int headerHeight() const override { return m_headerHeight; }
502     WEBCORE_EXPORT void setHeaderHeight(int);
503     virtual int footerHeight() const override { return m_footerHeight; }
504     WEBCORE_EXPORT void setFooterHeight(int);
505
506     WEBCORE_EXPORT virtual float topContentInset(TopContentInsetType = TopContentInsetType::WebCoreContentInset) const override;
507     void topContentInsetDidChange(float newTopContentInset);
508
509     WEBCORE_EXPORT virtual void willStartLiveResize() override;
510     WEBCORE_EXPORT virtual void willEndLiveResize() override;
511
512     WEBCORE_EXPORT virtual void availableContentSizeChanged(AvailableSizeChangeReason) override;
513
514     void addPaintPendingMilestones(LayoutMilestones);
515     void firePaintRelatedMilestonesIfNeeded();
516     void fireLayoutRelatedMilestonesIfNeeded();
517     LayoutMilestones milestonesPendingPaint() const { return m_milestonesPendingPaint; }
518
519     bool visualUpdatesAllowedByClient() const { return m_visualUpdatesAllowedByClient; }
520     WEBCORE_EXPORT void setVisualUpdatesAllowedByClient(bool);
521
522     WEBCORE_EXPORT void setScrollPinningBehavior(ScrollPinningBehavior);
523
524     ScrollBehaviorForFixedElements scrollBehaviorForFixedElements() const;
525
526     bool hasFlippedBlockRenderers() const { return m_hasFlippedBlockRenderers; }
527     void setHasFlippedBlockRenderers(bool b) { m_hasFlippedBlockRenderers = b; }
528
529     void updateWidgetPositions();
530     void didAddWidgetToRenderTree(Widget&);
531     void willRemoveWidgetFromRenderTree(Widget&);
532
533     const HashSet<Widget*>& widgetsInRenderTree() const { return m_widgetsInRenderTree; }
534
535     typedef Vector<Ref<FrameView>, 16> FrameViewList;
536     FrameViewList renderedChildFrameViews() const;
537
538     void addTrackedRepaintRect(const FloatRect&);
539
540     // exposedRect represents WebKit's understanding of what part
541     // of the view is actually exposed on screen (taking into account
542     // clipping by other UI elements), whereas visibleContentRect is
543     // internal to WebCore and doesn't respect those things.
544     WEBCORE_EXPORT void setExposedRect(FloatRect);
545     FloatRect exposedRect() const { return m_exposedRect; }
546
547 #if ENABLE(CSS_SCROLL_SNAP)
548     void updateSnapOffsets() override;
549     bool isScrollSnapInProgress() const override;
550     void updateScrollingCoordinatorScrollSnapProperties() const;
551 #endif
552
553     virtual float adjustScrollStepForFixedContent(float step, ScrollbarOrientation, ScrollGranularity) override;
554
555     void didChangeScrollOffset();
556
557     void show() override;
558
559 protected:
560     virtual bool scrollContentsFastPath(const IntSize& scrollDelta, const IntRect& rectToScroll, const IntRect& clipRect) override;
561     virtual void scrollContentsSlowPath(const IntRect& updateRect) override;
562     
563     void repaintSlowRepaintObjects();
564
565     virtual bool isVerticalDocument() const override;
566     virtual bool isFlippedDocument() const override;
567
568 private:
569     explicit FrameView(Frame&);
570
571     void reset();
572     void init();
573
574     enum LayoutPhase {
575         OutsideLayout,
576         InPreLayout,
577         InPreLayoutStyleUpdate,
578         InLayout,
579         InViewSizeAdjust,
580         InPostLayout,
581         InPostLayerPositionsUpdatedAfterLayout,
582     };
583     LayoutPhase layoutPhase() const { return m_layoutPhase; }
584
585     bool inPreLayoutStyleUpdate() const { return m_layoutPhase == InPreLayoutStyleUpdate; }
586
587     virtual bool isFrameView() const override { return true; }
588
589     friend class RenderWidget;
590     bool useSlowRepaints(bool considerOverlap = true) const;
591     bool useSlowRepaintsIfNotOverlapped() const;
592     void updateCanBlitOnScrollRecursively();
593     bool shouldLayoutAfterContentsResized() const;
594
595     bool shouldUpdateCompositingLayersAfterScrolling() const;
596     bool flushCompositingStateForThisFrame(const Frame& rootFrameForFlush);
597
598     virtual bool shouldDeferScrollUpdateAfterContentSizeChange() override;
599
600     virtual void scrollPositionChangedViaPlatformWidgetImpl(const IntPoint& oldPosition, const IntPoint& newPosition) override;
601
602     void applyOverflowToViewport(const RenderElement&, ScrollbarMode& hMode, ScrollbarMode& vMode);
603     void applyPaginationToViewport();
604
605     void updateOverflowStatus(bool horizontalOverflow, bool verticalOverflow);
606
607     WEBCORE_EXPORT void paintControlTints();
608
609     void forceLayoutParentViewIfNeeded();
610     void performPostLayoutTasks();
611     void autoSizeIfEnabled();
612
613     void applyRecursivelyWithVisibleRect(const std::function<void (FrameView& frameView, const IntRect& visibleRect)>&);
614     void resumeVisibleImageAnimations(const IntRect& visibleRect);
615     void updateScriptedAnimationsAndTimersThrottlingState(const IntRect& visibleRect);
616
617     void updateLayerFlushThrottling();
618     WEBCORE_EXPORT void adjustTiledBackingCoverage();
619
620     virtual void repaintContentRectangle(const IntRect&) override;
621     virtual void addedOrRemovedScrollbar() override;
622
623     virtual void delegatesScrollingDidChange() override;
624
625     // ScrollableArea interface
626     virtual void invalidateScrollbarRect(Scrollbar*, const IntRect&) override;
627     virtual void scrollTo(const ScrollPosition&) override;
628     virtual void setVisibleScrollerThumbRect(const IntRect&) override;
629     virtual ScrollableArea* enclosingScrollableArea() const override;
630     virtual IntRect scrollableAreaBoundingBox(bool* = nullptr) const override;
631     virtual bool scrollAnimatorEnabled() const override;
632     virtual GraphicsLayer* layerForScrolling() const override;
633     virtual GraphicsLayer* layerForHorizontalScrollbar() const override;
634     virtual GraphicsLayer* layerForVerticalScrollbar() const override;
635     virtual GraphicsLayer* layerForScrollCorner() const override;
636 #if ENABLE(RUBBER_BANDING)
637     virtual GraphicsLayer* layerForOverhangAreas() const override;
638 #endif
639
640     virtual bool usesCompositedScrolling() const override;
641     virtual bool usesAsyncScrolling() const override;
642
643     // Override scrollbar notifications to update the AXObject cache.
644     virtual void didAddScrollbar(Scrollbar*, ScrollbarOrientation) override;
645     virtual void willRemoveScrollbar(Scrollbar*, ScrollbarOrientation) override;
646
647     IntSize sizeForResizeEvent() const;
648     void sendResizeEventIfNeeded();
649
650     void updateScrollableAreaSet();
651
652     virtual void notifyPageThatContentAreaWillPaint() const override;
653
654     void enableSpeculativeTilingIfNeeded();
655     void speculativeTilingEnableTimerFired();
656
657     void updateEmbeddedObjectsTimerFired();
658     bool updateEmbeddedObjects();
659     void updateEmbeddedObject(RenderEmbeddedObject&);
660     void scrollToAnchor();
661     void scrollPositionChanged(const IntPoint& oldPosition, const IntPoint& newPosition);
662     void scrollableAreaSetChanged();
663     void sendScrollEvent();
664
665     bool hasCustomScrollbars() const;
666
667     virtual void updateScrollCorner() override;
668
669     FrameView* parentFrameView() const;
670
671     void startLayoutAtMainFrameViewIfNeeded(bool allowSubtree);
672     bool frameFlatteningEnabled() const;
673     bool isFrameFlatteningValidForThisFrame() const;
674
675     bool qualifiesAsVisuallyNonEmpty() const;
676     bool isViewForDocumentInFrame() const;
677
678     AXObjectCache* axObjectCache() const;
679     void notifyWidgetsInAllFrames(WidgetNotification);
680     void removeFromAXObjectCache();
681     void notifyWidgets(WidgetNotification);
682
683     void convertSubtreeLayoutToFullLayout();
684
685     RenderElement* viewportRenderer() const;
686
687     HashSet<Widget*> m_widgetsInRenderTree;
688
689     static double sCurrentPaintTimeStamp; // used for detecting decoded resource thrash in the cache
690
691     LayoutSize m_size;
692     LayoutSize m_margins;
693
694     std::unique_ptr<ListHashSet<RenderEmbeddedObject*>> m_embeddedObjectsToUpdate;
695     const Ref<Frame> m_frame;
696
697     std::unique_ptr<HashSet<const RenderElement*>> m_slowRepaintObjects;
698
699     bool m_needsFullRepaint;
700     
701     bool m_canHaveScrollbars;
702     bool m_cannotBlitToWindow;
703     bool m_isOverlapped;
704     bool m_contentIsOpaque;
705
706     Timer m_layoutTimer;
707     bool m_delayedLayout;
708     RenderElement* m_layoutRoot { nullptr };
709
710     LayoutPhase m_layoutPhase;
711     bool m_layoutSchedulingEnabled;
712     bool m_inSynchronousPostLayout;
713     int m_layoutCount;
714     unsigned m_nestedLayoutCount;
715     Timer m_postLayoutTasksTimer;
716     Timer m_updateEmbeddedObjectsTimer;
717     bool m_firstLayoutCallbackPending;
718
719     bool m_firstLayout;
720     bool m_isTransparent;
721     Color m_baseBackgroundColor;
722     IntSize m_lastViewportSize;
723     float m_lastZoomFactor;
724
725     String m_mediaType;
726     String m_mediaTypeWhenNotPrinting;
727
728     bool m_overflowStatusDirty;
729     bool m_horizontalOverflow;
730     bool m_verticalOverflow;
731     enum class ViewportRendererType { None, Document, Body };
732     ViewportRendererType m_viewportRendererType { ViewportRendererType::None };
733
734     Pagination m_pagination;
735
736     bool m_wasScrolledByUser;
737     bool m_inProgrammaticScroll;
738     bool m_safeToPropagateScrollToParent;
739     Timer m_delayedScrollEventTimer;
740
741     double m_lastPaintTime;
742
743     bool m_isTrackingRepaints; // Used for testing.
744     Vector<FloatRect> m_trackedRepaintRects;
745
746     bool m_shouldUpdateWhileOffscreen;
747
748     FloatRect m_exposedRect;
749
750     unsigned m_deferSetNeedsLayoutCount;
751     bool m_setNeedsLayoutWasDeferred;
752     int m_layoutDisallowed { 0 };
753
754     RefPtr<Node> m_nodeToDraw;
755     PaintBehavior m_paintBehavior;
756     bool m_isPainting;
757
758     unsigned m_visuallyNonEmptyCharacterCount;
759     unsigned m_visuallyNonEmptyPixelCount;
760     bool m_isVisuallyNonEmpty;
761     bool m_firstVisuallyNonEmptyLayoutCallbackPending;
762
763     bool m_viewportIsStable { true };
764
765     RefPtr<ContainerNode> m_maintainScrollPositionAnchor;
766
767     // Renderer to hold our custom scroll corner.
768     RenderPtr<RenderScrollbarPart> m_scrollCorner;
769
770     bool m_speculativeTilingEnabled;
771     Timer m_speculativeTilingEnableTimer;
772
773 #if PLATFORM(IOS)
774     bool m_useCustomFixedPositionLayoutRect;
775     IntRect m_customFixedPositionLayoutRect;
776
777     bool m_useCustomSizeForResizeEvent;
778     IntSize m_customSizeForResizeEvent;
779 #endif
780
781     IntSize m_overrideViewportSize;
782     bool m_hasOverrideViewportSize;
783
784     // If true, automatically resize the frame view around its content.
785     bool m_shouldAutoSize;
786     bool m_inAutoSize;
787     // True if autosize has been run since m_shouldAutoSize was set.
788     bool m_didRunAutosize;
789     // The lower bound on the size when autosizing.
790     IntSize m_minAutoSize;
791     // The upper bound on the size when autosizing.
792     IntSize m_maxAutoSize;
793     // The fixed height to resize the view to after autosizing is complete.
794     int m_autoSizeFixedMinimumHeight;
795     // The intrinsic content size decided by autosizing.
796     IntSize m_autoSizeContentSize;
797
798     std::unique_ptr<ScrollableAreaSet> m_scrollableAreas;
799     std::unique_ptr<ViewportConstrainedObjectSet> m_viewportConstrainedObjects;
800
801     int m_headerHeight;
802     int m_footerHeight;
803
804     LayoutMilestones m_milestonesPendingPaint;
805
806     static const unsigned visualCharacterThreshold = 200;
807     static const unsigned visualPixelThreshold = 32 * 32;
808
809 #if ENABLE(CSS_DEVICE_ADAPTATION)
810     // Size of viewport before any UA or author styles have overridden
811     // the viewport given by the window or viewing area of the UA.
812     IntSize m_initialViewportSize;
813 #endif
814
815     bool m_visualUpdatesAllowedByClient;
816     bool m_hasFlippedBlockRenderers;
817
818     ScrollPinningBehavior m_scrollPinningBehavior;
819
820     IntRect* m_cachedWindowClipRect { nullptr };
821 };
822
823 inline void FrameView::incrementVisuallyNonEmptyCharacterCount(unsigned count)
824 {
825     if (m_isVisuallyNonEmpty)
826         return;
827     m_visuallyNonEmptyCharacterCount += count;
828     if (m_visuallyNonEmptyCharacterCount <= visualCharacterThreshold)
829         return;
830     updateIsVisuallyNonEmpty();
831 }
832
833 inline void FrameView::incrementVisuallyNonEmptyPixelCount(const IntSize& size)
834 {
835     if (m_isVisuallyNonEmpty)
836         return;
837     m_visuallyNonEmptyPixelCount += size.width() * size.height();
838     if (m_visuallyNonEmptyPixelCount <= visualPixelThreshold)
839         return;
840     updateIsVisuallyNonEmpty();
841 }
842
843 } // namespace WebCore
844
845 SPECIALIZE_TYPE_TRAITS_WIDGET(FrameView, isFrameView())
846
847 #endif // FrameView_h