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