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