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