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