UI process side scrollbars for UI side compositing on Mac
[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-2017 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 #pragma once
26
27 #include "AdjustViewSizeOrNot.h"
28 #include "Color.h"
29 #include "ContainerNode.h"
30 #include "FrameViewLayoutContext.h"
31 #include "GraphicsContext.h"
32 #include "LayoutMilestone.h"
33 #include "LayoutRect.h"
34 #include "Pagination.h"
35 #include "PaintPhase.h"
36 #include "RenderPtr.h"
37 #include "ScrollView.h"
38 #include "StyleColor.h"
39 #include "TiledBacking.h"
40 #include <memory>
41 #include <wtf/Forward.h>
42 #include <wtf/Function.h>
43 #include <wtf/HashSet.h>
44 #include <wtf/IsoMalloc.h>
45 #include <wtf/ListHashSet.h>
46 #include <wtf/OptionSet.h>
47 #include <wtf/text/WTFString.h>
48
49 namespace WebCore {
50
51 class AXObjectCache;
52 class Element;
53 class FloatSize;
54 class Frame;
55 class HTMLFrameOwnerElement;
56 class Page;
57 class RenderBox;
58 class RenderElement;
59 class RenderEmbeddedObject;
60 class RenderLayer;
61 class RenderLayerModelObject;
62 class RenderObject;
63 class RenderScrollbarPart;
64 class RenderStyle;
65 class RenderView;
66 class RenderWidget;
67
68 enum class FrameFlattening;
69 enum class SelectionRevealMode;
70
71 Pagination::Mode paginationModeForRenderStyle(const RenderStyle&);
72
73 class FrameView final : public ScrollView {
74     WTF_MAKE_ISO_ALLOCATED(FrameView);
75 public:
76     friend class RenderView;
77     friend class Internals;
78     friend class FrameViewLayoutContext;
79
80     WEBCORE_EXPORT static Ref<FrameView> create(Frame&);
81     static Ref<FrameView> create(Frame&, const IntSize& initialSize);
82
83     virtual ~FrameView();
84
85     HostWindow* hostWindow() const final;
86     
87     WEBCORE_EXPORT void invalidateRect(const IntRect&) final;
88     void setFrameRect(const IntRect&) final;
89
90     bool scheduleAnimation() final;
91
92     Frame& frame() const { return m_frame; }
93
94     WEBCORE_EXPORT RenderView* renderView() const;
95
96     int mapFromLayoutToCSSUnits(LayoutUnit) const;
97     LayoutUnit mapFromCSSToLayoutUnits(int) const;
98
99     LayoutUnit marginWidth() const { return m_margins.width(); } // -1 means default
100     LayoutUnit marginHeight() const { return m_margins.height(); } // -1 means default
101     void setMarginWidth(LayoutUnit);
102     void setMarginHeight(LayoutUnit);
103
104     WEBCORE_EXPORT void setCanHaveScrollbars(bool) final;
105     WEBCORE_EXPORT void updateCanHaveScrollbars();
106
107     Ref<Scrollbar> createScrollbar(ScrollbarOrientation) final;
108
109     bool avoidScrollbarCreation() const final;
110
111     void setContentsSize(const IntSize&) final;
112     void updateContentsSize() final;
113
114     const FrameViewLayoutContext& layoutContext() const { return m_layoutContext; }
115     FrameViewLayoutContext& layoutContext() { return m_layoutContext; }
116
117     WEBCORE_EXPORT bool didFirstLayout() const;
118     void queuePostLayoutCallback(WTF::Function<void ()>&&);
119
120     WEBCORE_EXPORT bool needsLayout() const;
121     WEBCORE_EXPORT void setNeedsLayout();
122     void setViewportConstrainedObjectsNeedLayout();
123
124     WEBCORE_EXPORT bool renderedCharactersExceed(unsigned threshold);
125
126     void scheduleSelectionUpdate();
127
128 #if PLATFORM(IOS_FAMILY)
129     bool useCustomFixedPositionLayoutRect() const;
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, MonotonicTime timestamp);
138 #else
139     bool useCustomFixedPositionLayoutRect() const { return false; }
140 #endif
141
142     void willRecalcStyle();
143     bool updateCompositingLayersAfterStyleChange();
144     void updateCompositingLayersAfterLayout();
145
146     // Called when changes to the GraphicsLayer hierarchy have to be synchronized with
147     // content rendered via the normal painting path.
148     void setNeedsOneShotDrawingSynchronization();
149
150     WEBCORE_EXPORT GraphicsLayer* graphicsLayerForPlatformWidget(PlatformWidget);
151     WEBCORE_EXPORT void scheduleLayerFlushAllowingThrottling();
152
153     WEBCORE_EXPORT TiledBacking* tiledBacking() const final;
154
155     // In the future when any ScrollableArea can have a node in th ScrollingTree, this should
156     // become a virtual function on ScrollableArea.
157     uint64_t scrollLayerID() const override;
158     ScrollableArea* scrollableAreaForScrollLayerID(uint64_t) const;
159
160     WEBCORE_EXPORT void enterCompositingMode();
161     WEBCORE_EXPORT bool isEnclosedInCompositingLayer() const;
162
163     // Only used with accelerated compositing, but outside the #ifdef to make linkage easier.
164     // Returns true if the flush was completed.
165     WEBCORE_EXPORT bool flushCompositingStateIncludingSubframes();
166
167     // Returns true when a paint with the PaintBehavior::FlattenCompositingLayers flag set gives
168     // a faithful representation of the content.
169     WEBCORE_EXPORT bool isSoftwareRenderable() const;
170
171     void setIsInWindow(bool);
172
173     void resetScrollbars();
174     void resetScrollbarsAndClearContentsSize();
175     void prepareForDetach();
176     void detachCustomScrollbars();
177     WEBCORE_EXPORT void recalculateScrollbarOverlayStyle();
178 #if ENABLE(DARK_MODE_CSS)
179     void recalculateBaseBackgroundColor();
180 #endif
181
182     void clear();
183     void resetLayoutMilestones();
184
185     WEBCORE_EXPORT bool isTransparent() const;
186     WEBCORE_EXPORT void setTransparent(bool isTransparent);
187     
188     // True if the FrameView is not transparent, and the base background color is opaque.
189     bool hasOpaqueBackground() const;
190
191     WEBCORE_EXPORT Color baseBackgroundColor() const;
192     WEBCORE_EXPORT void setBaseBackgroundColor(const Color&);
193     WEBCORE_EXPORT void updateBackgroundRecursively(bool);
194
195     enum ExtendedBackgroundModeFlags {
196         ExtendedBackgroundModeNone          = 0,
197         ExtendedBackgroundModeVertical      = 1 << 0,
198         ExtendedBackgroundModeHorizontal    = 1 << 1,
199         ExtendedBackgroundModeAll           = ExtendedBackgroundModeVertical | ExtendedBackgroundModeHorizontal,
200     };
201     typedef unsigned ExtendedBackgroundMode;
202
203     void updateExtendBackgroundIfNecessary();
204     void updateTilesForExtendedBackgroundMode(ExtendedBackgroundMode);
205     ExtendedBackgroundMode calculateExtendedBackgroundMode() const;
206
207     bool hasExtendedBackgroundRectForPainting() const;
208     IntRect extendedBackgroundRectForPainting() const;
209
210     bool shouldUpdateWhileOffscreen() const;
211     WEBCORE_EXPORT void setShouldUpdateWhileOffscreen(bool);
212     bool shouldUpdate() const;
213
214     WEBCORE_EXPORT void adjustViewSize();
215
216     WEBCORE_EXPORT void setViewportSizeForCSSViewportUnits(IntSize);
217     void clearViewportSizeOverrideForCSSViewportUnits();
218     IntSize viewportSizeForCSSViewportUnits() const;
219
220     IntRect windowClipRect() const final;
221     WEBCORE_EXPORT IntRect windowClipRectForFrameOwner(const HTMLFrameOwnerElement*, bool clipToLayerContents) const;
222
223     float visibleContentScaleFactor() const final;
224
225 #if USE(COORDINATED_GRAPHICS)
226     WEBCORE_EXPORT void setFixedVisibleContentRect(const IntRect&) final;
227 #endif
228     WEBCORE_EXPORT void setScrollPosition(const ScrollPosition&) final;
229     void restoreScrollbar();
230     void scheduleScrollToFocusedElement(SelectionRevealMode);
231     void scrollToFocusedElementImmediatelyIfNeeded();
232     void updateLayerPositionsAfterScrolling() final;
233     void updateCompositingLayersAfterScrolling() final;
234     bool requestScrollPositionUpdate(const ScrollPosition&) final;
235     bool isRubberBandInProgress() const final;
236     WEBCORE_EXPORT ScrollPosition minimumScrollPosition() const final;
237     WEBCORE_EXPORT ScrollPosition maximumScrollPosition() const final;
238
239     // The scrollOrigin, scrollPosition, minimumScrollPosition and maximumScrollPosition are all affected by frame scale,
240     // but layoutViewport computations require unscaled scroll positions.
241     ScrollPosition unscaledMinimumScrollPosition() const;
242     ScrollPosition unscaledMaximumScrollPosition() const;
243
244     IntPoint unscaledScrollOrigin() const;
245
246     WEBCORE_EXPORT LayoutPoint minStableLayoutViewportOrigin() const;
247     WEBCORE_EXPORT LayoutPoint maxStableLayoutViewportOrigin() const;
248
249     enum class TriggerLayoutOrNot {
250         No,
251         Yes
252     };
253     // This origin can be overridden by setLayoutViewportOverrideRect.
254     void setBaseLayoutViewportOrigin(LayoutPoint, TriggerLayoutOrNot = TriggerLayoutOrNot::Yes);
255     // This size can be overridden by setLayoutViewportOverrideRect.
256     WEBCORE_EXPORT LayoutSize baseLayoutViewportSize() const;
257     
258     // If set, overrides the default "m_layoutViewportOrigin, size of initial containing block" rect.
259     // Used with delegated scrolling (i.e. iOS).
260     WEBCORE_EXPORT void setLayoutViewportOverrideRect(Optional<LayoutRect>, TriggerLayoutOrNot = TriggerLayoutOrNot::Yes);
261
262     WEBCORE_EXPORT void setVisualViewportOverrideRect(Optional<LayoutRect>);
263
264     // These are in document coordinates, unaffected by page scale (but affected by zooming).
265     WEBCORE_EXPORT LayoutRect layoutViewportRect() const;
266     WEBCORE_EXPORT LayoutRect visualViewportRect() const;
267     
268     static LayoutRect visibleDocumentRect(const FloatRect& visibleContentRect, float headerHeight, float footerHeight, const FloatSize& totalContentsSize, float pageScaleFactor);
269
270     // This is different than visibleContentRect() in that it ignores negative (or overly positive)
271     // offsets from rubber-banding, and it takes zooming into account. 
272     LayoutRect viewportConstrainedVisibleContentRect() const;
273     
274     LayoutRect rectForFixedPositionLayout() const;
275
276     void viewportContentsChanged();
277     WEBCORE_EXPORT void resumeVisibleImageAnimationsIncludingSubframes();
278
279     String mediaType() const;
280     WEBCORE_EXPORT void setMediaType(const String&);
281     void adjustMediaTypeForPrinting(bool printing);
282
283     void setCannotBlitToWindow();
284     void setIsOverlapped(bool);
285     void setContentIsOpaque(bool);
286
287     void addSlowRepaintObject(RenderElement&);
288     void removeSlowRepaintObject(RenderElement&);
289     bool hasSlowRepaintObject(const RenderElement& renderer) const { return m_slowRepaintObjects && m_slowRepaintObjects->contains(&renderer); }
290     bool hasSlowRepaintObjects() const { return m_slowRepaintObjects && m_slowRepaintObjects->size(); }
291
292     // Includes fixed- and sticky-position objects.
293     typedef HashSet<RenderLayerModelObject*> ViewportConstrainedObjectSet;
294     void addViewportConstrainedObject(RenderLayerModelObject*);
295     void removeViewportConstrainedObject(RenderLayerModelObject*);
296     const ViewportConstrainedObjectSet* viewportConstrainedObjects() const { return m_viewportConstrainedObjects.get(); }
297     bool hasViewportConstrainedObjects() const { return m_viewportConstrainedObjects && m_viewportConstrainedObjects->size() > 0; }
298     
299     float frameScaleFactor() const;
300
301     // Functions for querying the current scrolled position, negating the effects of overhang
302     // and adjusting for page scale.
303     LayoutPoint scrollPositionForFixedPosition() const;
304     
305     // Static function can be called from another thread.
306     static LayoutPoint scrollPositionForFixedPosition(const LayoutRect& visibleContentRect, const LayoutSize& totalContentsSize, const LayoutPoint& scrollPosition, const LayoutPoint& scrollOrigin, float frameScaleFactor, bool fixedElementsLayoutRelativeToFrame, ScrollBehaviorForFixedElements, int headerHeight, int footerHeight);
307
308     WEBCORE_EXPORT static LayoutSize expandedLayoutViewportSize(const LayoutSize& baseLayoutViewportSize, const LayoutSize& documentSize, double heightExpansionFactor);
309
310     enum class LayoutViewportConstraint { ConstrainedToDocumentRect, Unconstrained };
311     WEBCORE_EXPORT static LayoutRect computeUpdatedLayoutViewportRect(const LayoutRect& layoutViewport, const LayoutRect& documentRect, const LayoutSize& unobscuredContentSize, const LayoutRect& unobscuredContentRect, const LayoutSize& baseLayoutViewportSize, const LayoutPoint& stableLayoutViewportOriginMin, const LayoutPoint& stableLayoutViewportOriginMax, LayoutViewportConstraint);
312     
313     WEBCORE_EXPORT static LayoutPoint computeLayoutViewportOrigin(const LayoutRect& visualViewport, const LayoutPoint& stableLayoutViewportOriginMin, const LayoutPoint& stableLayoutViewportOriginMax, const LayoutRect& layoutViewport, ScrollBehaviorForFixedElements);
314
315     // These layers are positioned differently when there is a topContentInset, a header, or a footer. These value need to be computed
316     // on both the main thread and the scrolling thread.
317     static float yPositionForInsetClipLayer(const FloatPoint& scrollPosition, float topContentInset);
318     WEBCORE_EXPORT static FloatPoint positionForRootContentLayer(const FloatPoint& scrollPosition, const FloatPoint& scrollOrigin, float topContentInset, float headerHeight);
319     WEBCORE_EXPORT FloatPoint positionForRootContentLayer() const;
320
321     static float yPositionForHeaderLayer(const FloatPoint& scrollPosition, float topContentInset);
322     static float yPositionForFooterLayer(const FloatPoint& scrollPosition, float topContentInset, float totalContentsHeight, float footerHeight);
323
324 #if PLATFORM(IOS_FAMILY)
325     WEBCORE_EXPORT LayoutRect viewportConstrainedObjectsRect() const;
326     // Static function can be called from another thread.
327     WEBCORE_EXPORT static LayoutRect rectForViewportConstrainedObjects(const LayoutRect& visibleContentRect, const LayoutSize& totalContentsSize, float frameScaleFactor, bool fixedElementsLayoutRelativeToFrame, ScrollBehaviorForFixedElements);
328 #endif
329     
330     bool fixedElementsLayoutRelativeToFrame() const;
331
332     WEBCORE_EXPORT void disableLayerFlushThrottlingTemporarilyForInteraction();
333     bool speculativeTilingEnabled() const { return m_speculativeTilingEnabled; }
334     void loadProgressingStatusChanged();
335
336 #if ENABLE(DASHBOARD_SUPPORT)
337     void updateAnnotatedRegions();
338 #endif
339     WEBCORE_EXPORT void updateControlTints();
340
341     WEBCORE_EXPORT bool wasScrolledByUser() const;
342     WEBCORE_EXPORT void setWasScrolledByUser(bool);
343
344     bool safeToPropagateScrollToParent() const;
345
346     void addEmbeddedObjectToUpdate(RenderEmbeddedObject&);
347     void removeEmbeddedObjectToUpdate(RenderEmbeddedObject&);
348
349     WEBCORE_EXPORT void paintContents(GraphicsContext&, const IntRect& dirtyRect, SecurityOriginPaintPolicy = SecurityOriginPaintPolicy::AnyOrigin) final;
350
351     struct PaintingState {
352         OptionSet<PaintBehavior> paintBehavior;
353         bool isTopLevelPainter;
354         bool isFlatteningPaintOfRootFrame;
355         PaintingState()
356             : paintBehavior()
357             , isTopLevelPainter(false)
358             , isFlatteningPaintOfRootFrame(false)
359         {
360         }
361     };
362
363     void willPaintContents(GraphicsContext&, const IntRect& dirtyRect, PaintingState&);
364     void didPaintContents(GraphicsContext&, const IntRect& dirtyRect, PaintingState&);
365
366 #if PLATFORM(IOS_FAMILY)
367     WEBCORE_EXPORT void didReplaceMultipartContent();
368 #endif
369
370     WEBCORE_EXPORT void setPaintBehavior(OptionSet<PaintBehavior>);
371     WEBCORE_EXPORT OptionSet<PaintBehavior> paintBehavior() const;
372     bool isPainting() const;
373     bool hasEverPainted() const { return !!m_lastPaintTime; }
374     void setLastPaintTime(MonotonicTime lastPaintTime) { m_lastPaintTime = lastPaintTime; }
375     WEBCORE_EXPORT void setNodeToDraw(Node*);
376
377     enum SelectionInSnapshot { IncludeSelection, ExcludeSelection };
378     enum CoordinateSpaceForSnapshot { DocumentCoordinates, ViewCoordinates };
379     WEBCORE_EXPORT void paintContentsForSnapshot(GraphicsContext&, const IntRect& imageRect, SelectionInSnapshot shouldPaintSelection, CoordinateSpaceForSnapshot);
380
381     void paintOverhangAreas(GraphicsContext&, const IntRect& horizontalOverhangArea, const IntRect& verticalOverhangArea, const IntRect& dirtyRect) final;
382     void paintScrollCorner(GraphicsContext&, const IntRect& cornerRect) final;
383     void paintScrollbar(GraphicsContext&, Scrollbar&, const IntRect&) final;
384
385     WEBCORE_EXPORT Color documentBackgroundColor() const;
386
387     bool isInChildFrameWithFrameFlattening() const;
388
389     void startDisallowingLayout() { layoutContext().startDisallowingLayout(); }
390     void endDisallowingLayout() { layoutContext().endDisallowingLayout(); }
391
392     static MonotonicTime currentPaintTimeStamp() { return sCurrentPaintTimeStamp; } // returns 0 if not painting
393     
394     WEBCORE_EXPORT void updateLayoutAndStyleIfNeededRecursive();
395
396     void incrementVisuallyNonEmptyCharacterCount(const String&);
397     void incrementVisuallyNonEmptyPixelCount(const IntSize&);
398     void updateIsVisuallyNonEmpty();
399     void updateSignificantRenderedTextMilestoneIfNeeded();
400     bool isVisuallyNonEmpty() const { return m_isVisuallyNonEmpty; }
401     WEBCORE_EXPORT void enableAutoSizeMode(bool enable, const IntSize& minSize, const IntSize& maxSize);
402     WEBCORE_EXPORT void setAutoSizeFixedMinimumHeight(int);
403     IntSize autoSizingIntrinsicContentSize() const { return m_autoSizeContentSize; }
404
405     WEBCORE_EXPORT void forceLayout(bool allowSubtreeLayout = false);
406     WEBCORE_EXPORT void forceLayoutForPagination(const FloatSize& pageSize, const FloatSize& originalPageSize, float maximumShrinkFactor, AdjustViewSizeOrNot);
407
408     // FIXME: This method is retained because of embedded WebViews in AppKit.  When a WebView is embedded inside
409     // some enclosing view with auto-pagination, no call happens to resize the view.  The new pagination model
410     // needs the view to resize as a result of the breaks, but that means that the enclosing view has to potentially
411     // resize around that view.  Auto-pagination uses the bounds of the actual view that's being printed to determine
412     // the edges of the print operation, so the resize is necessary if the enclosing view's bounds depend on the
413     // web document's bounds.
414     // 
415     // This is already a problem if the view needs to be a different size because of printer fonts or because of print stylesheets.
416     // Mail/Dictionary work around this problem by using the _layoutForPrinting SPI
417     // to at least get print stylesheets and printer fonts into play, but since WebKit doesn't know about the page offset or
418     // page size, it can't actually paginate correctly during _layoutForPrinting.
419     //
420     // We can eventually move Mail to a newer SPI that would let them opt in to the layout-time pagination model,
421     // but that doesn't solve the general problem of how other AppKit views could opt in to the better model.
422     //
423     // NO OTHER PLATFORM BESIDES MAC SHOULD USE THIS METHOD.
424     WEBCORE_EXPORT void adjustPageHeightDeprecated(float* newBottom, float oldTop, float oldBottom, float bottomLimit);
425
426     bool scrollToFragment(const URL&);
427     bool scrollToAnchor(const String&);
428     void maintainScrollPositionAtAnchor(ContainerNode*);
429     WEBCORE_EXPORT void scrollElementToRect(const Element&, const IntRect&);
430
431     // Coordinate systems:
432     //
433     // "View"
434     //     Top left is top left of the FrameView/ScrollView/Widget. Size is Widget::boundsRect().size(). 
435     //
436     // "TotalContents"
437     //    Relative to ScrollView's scrolled contents, including headers and footers. Size is totalContentsSize().
438     //
439     // "Contents"
440     //    Relative to ScrollView's scrolled contents, excluding headers and footers, so top left is top left of the scroll view's
441     //    document, and size is contentsSize().
442     //
443     // "Absolute"
444     //    Relative to the document's scroll origin (non-zero for RTL documents), but affected by page zoom and page scale. Mostly used
445     //    in rendering code.
446     //
447     // "Document"
448     //    Relative to the document's scroll origin, but not affected by page zoom or page scale. Size is equivalent to CSS pixel dimensions.
449     //    FIXME: some uses are affected by page zoom (e.g. layout and visual viewports).
450     //
451     // "Client"
452     //    Relative to the visible part of the document (or, more strictly, the layout viewport rect), and with the same scaling
453     //    as Document coordinates, i.e. matching CSS pixels. Affected by scroll origin.
454     //
455     // "LayoutViewport"
456     //    Similar to client coordinates, but affected by page zoom (but not page scale).
457     //
458
459     // Methods to convert points and rects between the coordinate space of the renderer, and this view.
460     WEBCORE_EXPORT IntRect convertFromRendererToContainingView(const RenderElement*, const IntRect&) const;
461     WEBCORE_EXPORT IntRect convertFromContainingViewToRenderer(const RenderElement*, const IntRect&) const;
462     WEBCORE_EXPORT FloatRect convertFromContainingViewToRenderer(const RenderElement*, const FloatRect&) const;
463     WEBCORE_EXPORT IntPoint convertFromRendererToContainingView(const RenderElement*, const IntPoint&) const;
464     WEBCORE_EXPORT IntPoint convertFromContainingViewToRenderer(const RenderElement*, const IntPoint&) const;
465
466     // Override ScrollView methods to do point conversion via renderers, in order to take transforms into account.
467     IntRect convertToContainingView(const IntRect&) const final;
468     IntRect convertFromContainingView(const IntRect&) const final;
469     FloatRect convertFromContainingView(const FloatRect&) const final;
470     IntPoint convertToContainingView(const IntPoint&) const final;
471     IntPoint convertFromContainingView(const IntPoint&) const final;
472
473     float documentToAbsoluteScaleFactor(Optional<float> effectiveZoom = WTF::nullopt) const;
474     float absoluteToDocumentScaleFactor(Optional<float> effectiveZoom = WTF::nullopt) const;
475
476     FloatRect absoluteToDocumentRect(FloatRect, Optional<float> effectiveZoom = WTF::nullopt) const;
477     FloatPoint absoluteToDocumentPoint(FloatPoint, Optional<float> effectiveZoom = WTF::nullopt) const;
478
479     FloatRect absoluteToClientRect(FloatRect, Optional<float> effectiveZoom = WTF::nullopt) const;
480
481     FloatSize documentToClientOffset() const;
482     FloatRect documentToClientRect(FloatRect) const;
483     FloatPoint documentToClientPoint(FloatPoint) const;
484     WEBCORE_EXPORT FloatRect clientToDocumentRect(FloatRect) const;
485     WEBCORE_EXPORT FloatPoint clientToDocumentPoint(FloatPoint) const;
486
487     FloatPoint layoutViewportToAbsolutePoint(FloatPoint) const;
488
489     // Unlike client coordinates, layout viewport coordinates are affected by page zoom.
490     FloatPoint clientToLayoutViewportPoint(FloatPoint) const;
491
492     bool isFrameViewScrollCorner(const RenderScrollbarPart& scrollCorner) const { return m_scrollCorner.get() == &scrollCorner; }
493
494     // isScrollable() takes an optional Scrollability parameter that allows the caller to define what they mean by 'scrollable.'
495     // Most callers are interested in the default value, Scrollability::Scrollable, which means that there is actually content
496     // 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
497     // to rubber-band, which the main frame might be allowed to do even if there is no content to scroll to. In that case,
498     // callers use Scrollability::ScrollableOrRubberbandable.
499     enum class Scrollability { Scrollable, ScrollableOrRubberbandable };
500     WEBCORE_EXPORT bool isScrollable(Scrollability definitionOfScrollable = Scrollability::Scrollable);
501
502     bool isScrollableOrRubberbandable() final;
503     bool hasScrollableOrRubberbandableAncestor() final;
504
505     enum ScrollbarModesCalculationStrategy { RulesFromWebContentOnly, AnyRule };
506     void calculateScrollbarModesForLayout(ScrollbarMode& hMode, ScrollbarMode& vMode, ScrollbarModesCalculationStrategy = AnyRule);
507
508     IntPoint lastKnownMousePosition() const final;
509     bool isHandlingWheelEvent() const final;
510     bool shouldSetCursor() const;
511
512     WEBCORE_EXPORT bool useDarkAppearance() const final;
513     OptionSet<StyleColor::Options> styleColorOptions() const;
514
515     // FIXME: Remove this method once plugin loading is decoupled from layout.
516     void flushAnyPendingPostLayoutTasks();
517
518     bool shouldSuspendScrollAnimations() const final;
519     void scrollbarStyleChanged(ScrollbarStyle, bool forceUpdate) override;
520
521     RenderBox* embeddedContentBox() const;
522     
523     WEBCORE_EXPORT void setTracksRepaints(bool);
524     bool isTrackingRepaints() const { return m_isTrackingRepaints; }
525     WEBCORE_EXPORT void resetTrackedRepaints();
526     const Vector<FloatRect>& trackedRepaintRects() const { return m_trackedRepaintRects; }
527     String trackedRepaintRectsAsText() const;
528
529     typedef HashSet<ScrollableArea*> ScrollableAreaSet;
530     // Returns whether the scrollable area has just been newly added.
531     WEBCORE_EXPORT bool addScrollableArea(ScrollableArea*);
532     // Returns whether the scrollable area has just been removed.
533     WEBCORE_EXPORT bool removeScrollableArea(ScrollableArea*);
534     bool containsScrollableArea(ScrollableArea*) const;
535     const ScrollableAreaSet* scrollableAreas() const { return m_scrollableAreas.get(); }
536
537     WEBCORE_EXPORT void addChild(Widget&) final;
538     WEBCORE_EXPORT void removeChild(Widget&) final;
539
540     // This function exists for ports that need to handle wheel events manually.
541     // On Mac WebKit1 the underlying NSScrollView just does the scrolling, but on most other platforms
542     // we need this function in order to do the scroll ourselves.
543     bool wheelEvent(const PlatformWheelEvent&);
544
545     WEBCORE_EXPORT void setScrollingPerformanceLoggingEnabled(bool);
546
547     // Page and FrameView both store a Pagination value. Page::pagination() is set only by API,
548     // and FrameView::pagination() is set only by CSS. Page::pagination() will affect all
549     // FrameViews in the page cache, but FrameView::pagination() only affects the current
550     // FrameView. FrameView::pagination() will return m_pagination if it has been set. Otherwise,
551     // it will return Page::pagination() since currently there are no callers that need to
552     // distinguish between the two.
553     const Pagination& pagination() const;
554     void setPagination(const Pagination&);
555     
556     bool inProgrammaticScroll() const final { return m_inProgrammaticScroll; }
557     void setInProgrammaticScroll(bool programmaticScroll) { m_inProgrammaticScroll = programmaticScroll; }
558
559 #if ENABLE(CSS_DEVICE_ADAPTATION)
560     IntSize initialViewportSize() const { return m_initialViewportSize; }
561     void setInitialViewportSize(const IntSize& size) { m_initialViewportSize = size; }
562 #endif
563
564     bool isActive() const final;
565     bool forceUpdateScrollbarsOnMainThreadForPerformanceTesting() const final;
566
567 #if ENABLE(RUBBER_BANDING)
568     WEBCORE_EXPORT GraphicsLayer* setWantsLayerForTopOverHangArea(bool) const;
569     WEBCORE_EXPORT GraphicsLayer* setWantsLayerForBottomOverHangArea(bool) const;
570 #endif
571
572     // This function "smears" the "position:fixed" uninflatedBounds for scrolling, returning a rect that is the union of
573     // all possible locations of the given rect under page scrolling.
574     LayoutRect fixedScrollableAreaBoundsInflatedForScrolling(const LayoutRect& uninflatedBounds) const;
575
576     LayoutPoint scrollPositionRespectingCustomFixedPosition() const;
577
578     int headerHeight() const final { return m_headerHeight; }
579     WEBCORE_EXPORT void setHeaderHeight(int);
580     int footerHeight() const final { return m_footerHeight; }
581     WEBCORE_EXPORT void setFooterHeight(int);
582
583     WEBCORE_EXPORT float topContentInset(TopContentInsetType = TopContentInsetType::WebCoreContentInset) const final;
584     void topContentInsetDidChange(float newTopContentInset);
585
586     void topContentDirectionDidChange();
587
588     WEBCORE_EXPORT void willStartLiveResize() final;
589     WEBCORE_EXPORT void willEndLiveResize() final;
590
591     WEBCORE_EXPORT void availableContentSizeChanged(AvailableSizeChangeReason) final;
592
593     void updateTiledBackingAdaptiveSizing();
594     TiledBacking::Scrollability computeScrollability() const;
595
596     void addPaintPendingMilestones(OptionSet<LayoutMilestone>);
597     void firePaintRelatedMilestonesIfNeeded();
598     void fireLayoutRelatedMilestonesIfNeeded();
599     OptionSet<LayoutMilestone> milestonesPendingPaint() const { return m_milestonesPendingPaint; }
600
601     bool visualUpdatesAllowedByClient() const { return m_visualUpdatesAllowedByClient; }
602     WEBCORE_EXPORT void setVisualUpdatesAllowedByClient(bool);
603
604     WEBCORE_EXPORT void setScrollPinningBehavior(ScrollPinningBehavior);
605
606     ScrollBehaviorForFixedElements scrollBehaviorForFixedElements() const;
607
608     bool hasFlippedBlockRenderers() const { return m_hasFlippedBlockRenderers; }
609     void setHasFlippedBlockRenderers(bool b) { m_hasFlippedBlockRenderers = b; }
610
611     void updateWidgetPositions();
612     void scheduleUpdateWidgetPositions();
613
614     void didAddWidgetToRenderTree(Widget&);
615     void willRemoveWidgetFromRenderTree(Widget&);
616
617     const HashSet<Widget*>& widgetsInRenderTree() const { return m_widgetsInRenderTree; }
618
619     void addTrackedRepaintRect(const FloatRect&);
620
621     // exposedRect represents WebKit's understanding of what part
622     // of the view is actually exposed on screen (taking into account
623     // clipping by other UI elements), whereas visibleContentRect is
624     // internal to WebCore and doesn't respect those things.
625     WEBCORE_EXPORT void setViewExposedRect(Optional<FloatRect>);
626     Optional<FloatRect> viewExposedRect() const { return m_viewExposedRect; }
627
628 #if ENABLE(CSS_SCROLL_SNAP)
629     void updateSnapOffsets() final;
630     bool isScrollSnapInProgress() const final;
631     void updateScrollingCoordinatorScrollSnapProperties() const;
632 #endif
633
634     float adjustScrollStepForFixedContent(float step, ScrollbarOrientation, ScrollGranularity) final;
635
636     void didChangeScrollOffset();
637
638     void show() final;
639     void hide() final;
640
641     bool shouldPlaceBlockDirectionScrollbarOnLeft() const final;
642
643     void didRestoreFromPageCache();
644
645     void willDestroyRenderTree();
646     void didDestroyRenderTree();
647
648     void setSpeculativeTilingDelayDisabledForTesting(bool disabled) { m_speculativeTilingDelayDisabledForTesting = disabled; }
649
650     WEBCORE_EXPORT FrameFlattening effectiveFrameFlattening() const;
651
652     WEBCORE_EXPORT void traverseForPaintInvalidation(GraphicsContext::PaintInvalidationReasons);
653     void invalidateControlTints() { traverseForPaintInvalidation(GraphicsContext::PaintInvalidationReasons::InvalidatingControlTints); }
654     void invalidateImagesWithAsyncDecodes() { traverseForPaintInvalidation(GraphicsContext::PaintInvalidationReasons::InvalidatingImagesWithAsyncDecodes); }
655
656     GraphicsLayer* layerForHorizontalScrollbar() const final;
657     GraphicsLayer* layerForVerticalScrollbar() const final;
658
659 protected:
660     bool scrollContentsFastPath(const IntSize& scrollDelta, const IntRect& rectToScroll, const IntRect& clipRect) final;
661     void scrollContentsSlowPath(const IntRect& updateRect) final;
662     
663     void repaintSlowRepaintObjects();
664
665     bool isVerticalDocument() const final;
666     bool isFlippedDocument() const final;
667
668 private:
669     explicit FrameView(Frame&);
670
671     void reset();
672     void init();
673
674     enum LayoutPhase {
675         OutsideLayout,
676         InPreLayout,
677         InRenderTreeLayout,
678         InViewSizeAdjust,
679         InPostLayout
680     };
681
682     bool isFrameView() const final { return true; }
683
684     friend class RenderWidget;
685     bool useSlowRepaints(bool considerOverlap = true) const;
686     bool useSlowRepaintsIfNotOverlapped() const;
687     void updateCanBlitOnScrollRecursively();
688     bool shouldLayoutAfterContentsResized() const;
689
690     bool shouldUpdateCompositingLayersAfterScrolling() const;
691     bool flushCompositingStateForThisFrame(const Frame& rootFrameForFlush);
692
693     bool shouldDeferScrollUpdateAfterContentSizeChange() final;
694
695     void scrollOffsetChangedViaPlatformWidgetImpl(const ScrollOffset& oldOffset, const ScrollOffset& newOffset) final;
696
697     void applyOverflowToViewport(const RenderElement&, ScrollbarMode& hMode, ScrollbarMode& vMode);
698     void applyPaginationToViewport();
699
700     void updateOverflowStatus(bool horizontalOverflow, bool verticalOverflow);
701
702     void forceLayoutParentViewIfNeeded();
703     void flushPostLayoutTasksQueue();
704     void performPostLayoutTasks();
705     void autoSizeIfEnabled();
706
707     void applyRecursivelyWithVisibleRect(const WTF::Function<void (FrameView& frameView, const IntRect& visibleRect)>&);
708     void resumeVisibleImageAnimations(const IntRect& visibleRect);
709     void updateScriptedAnimationsAndTimersThrottlingState(const IntRect& visibleRect);
710
711     void updateLayerFlushThrottling();
712     WEBCORE_EXPORT void adjustTiledBackingCoverage();
713
714     void repaintContentRectangle(const IntRect&) final;
715     void addedOrRemovedScrollbar() final;
716
717     void scrollToFocusedElementTimerFired();
718     void scrollToFocusedElementInternal();
719
720     void delegatesScrollingDidChange() final;
721
722     // ScrollableArea interface
723     void invalidateScrollbarRect(Scrollbar&, const IntRect&) final;
724     void scrollTo(const ScrollPosition&) final;
725     void setVisibleScrollerThumbRect(const IntRect&) final;
726     ScrollableArea* enclosingScrollableArea() const final;
727     IntRect scrollableAreaBoundingBox(bool* = nullptr) const final;
728     bool scrollAnimatorEnabled() const final;
729     GraphicsLayer* layerForScrolling() const final;
730     GraphicsLayer* layerForScrollCorner() const final;
731 #if ENABLE(RUBBER_BANDING)
732     GraphicsLayer* layerForOverhangAreas() const final;
733 #endif
734     void contentsResized() final;
735
736 #if PLATFORM(IOS_FAMILY)
737     void unobscuredContentSizeChanged() final;
738 #endif
739
740 #if ENABLE(DARK_MODE_CSS)
741     RenderObject* rendererForSupportedColorSchemes() const;
742 #endif
743
744     bool usesCompositedScrolling() const final;
745     bool usesAsyncScrolling() const final;
746     bool usesMockScrollAnimator() const final;
747     void logMockScrollAnimatorMessage(const String&) const final;
748
749     // Override scrollbar notifications to update the AXObject cache.
750     void didAddScrollbar(Scrollbar*, ScrollbarOrientation) final;
751     void willRemoveScrollbar(Scrollbar*, ScrollbarOrientation) final;
752
753     IntSize sizeForResizeEvent() const;
754     void sendResizeEventIfNeeded();
755
756     void adjustScrollbarsForLayout(bool firstLayout);
757
758     void handleDeferredScrollbarsUpdateAfterDirectionChange();
759
760     void updateScrollableAreaSet();
761     void updateLayoutViewport();
762
763     void notifyPageThatContentAreaWillPaint() const final;
764
765     void enableSpeculativeTilingIfNeeded();
766     void speculativeTilingEnableTimerFired();
767
768     void updateEmbeddedObjectsTimerFired();
769     bool updateEmbeddedObjects();
770     void updateEmbeddedObject(RenderEmbeddedObject&);
771
772     void updateWidgetPositionsTimerFired();
773
774     void scrollToAnchor();
775     void scrollPositionChanged(const ScrollPosition& oldPosition, const ScrollPosition& newPosition);
776     void scrollableAreaSetChanged();
777     void sendScrollEvent();
778     void resetScrollAnchor();
779
780     bool hasCustomScrollbars() const;
781
782     void updateScrollCorner() final;
783
784     FrameView* parentFrameView() const;
785
786     bool frameFlatteningEnabled() const;
787     bool isFrameFlatteningValidForThisFrame() const;
788
789     void markRootOrBodyRendererDirty() const;
790
791     bool qualifiesAsVisuallyNonEmpty() const;
792     bool isViewForDocumentInFrame() const;
793
794     AXObjectCache* axObjectCache() const;
795     void notifyWidgetsInAllFrames(WidgetNotification);
796     void removeFromAXObjectCache();
797     void notifyWidgets(WidgetNotification);
798
799     RenderElement* viewportRenderer() const;
800     
801     void willDoLayout(WeakPtr<RenderElement> layoutRoot);
802     void didLayout(WeakPtr<RenderElement> layoutRoot);
803
804     struct OverrideViewportSize {
805         Optional<int> width;
806         Optional<int> height;
807
808         bool operator==(const OverrideViewportSize& rhs) const { return rhs.width == width && rhs.height == height; }
809     };
810     void overrideViewportSizeForCSSViewportUnits(OverrideViewportSize);
811
812     HashSet<Widget*> m_widgetsInRenderTree;
813
814     static MonotonicTime sCurrentPaintTimeStamp; // used for detecting decoded resource thrash in the cache
815
816     LayoutSize m_size;
817     LayoutSize m_margins;
818
819     std::unique_ptr<ListHashSet<RenderEmbeddedObject*>> m_embeddedObjectsToUpdate;
820     const Ref<Frame> m_frame;
821
822     std::unique_ptr<HashSet<const RenderElement*>> m_slowRepaintObjects;
823
824     bool m_canHaveScrollbars;
825     bool m_cannotBlitToWindow;
826     bool m_isOverlapped { false };
827     bool m_contentIsOpaque;
828
829     Timer m_updateEmbeddedObjectsTimer;
830     Timer m_updateWidgetPositionsTimer;
831
832     bool m_firstLayoutCallbackPending;
833
834     bool m_isTransparent;
835 #if ENABLE(DARK_MODE_CSS)
836     bool m_usesDarkAppearance { false };
837 #endif
838     Color m_baseBackgroundColor;
839     IntSize m_lastViewportSize;
840     float m_lastZoomFactor;
841
842     String m_mediaType;
843     String m_mediaTypeWhenNotPrinting;
844
845     bool m_overflowStatusDirty;
846     bool m_horizontalOverflow;
847     bool m_verticalOverflow;
848     enum class ViewportRendererType { None, Document, Body };
849     ViewportRendererType m_viewportRendererType { ViewportRendererType::None };
850
851     Pagination m_pagination;
852
853     bool m_wasScrolledByUser;
854     bool m_inProgrammaticScroll;
855     Timer m_delayedScrollEventTimer;
856     bool m_shouldScrollToFocusedElement { false };
857     SelectionRevealMode m_selectionRevealModeForFocusedElement;
858     Timer m_delayedScrollToFocusedElementTimer;
859
860     MonotonicTime m_lastPaintTime;
861
862     bool m_isTrackingRepaints; // Used for testing.
863     Vector<FloatRect> m_trackedRepaintRects;
864
865     bool m_shouldUpdateWhileOffscreen;
866
867     Optional<FloatRect> m_viewExposedRect;
868     
869     LayoutPoint m_layoutViewportOrigin;
870     Optional<LayoutRect> m_layoutViewportOverrideRect;
871     Optional<LayoutRect> m_visualViewportOverrideRect; // Used when the iOS keyboard is showing.
872
873     RefPtr<Node> m_nodeToDraw;
874     OptionSet<PaintBehavior> m_paintBehavior;
875     bool m_isPainting;
876
877     unsigned m_visuallyNonEmptyCharacterCount;
878     unsigned m_visuallyNonEmptyPixelCount;
879     bool m_isVisuallyNonEmpty;
880     bool m_firstVisuallyNonEmptyLayoutCallbackPending;
881
882     unsigned m_textRendererCountForVisuallyNonEmptyCharacters { 0 };
883     bool m_renderedSignificantAmountOfText;
884     bool m_significantRenderedTextMilestonePending;
885
886     bool m_needsDeferredScrollbarsUpdate { false };
887
888     RefPtr<ContainerNode> m_maintainScrollPositionAnchor;
889
890     // Renderer to hold our custom scroll corner.
891     RenderPtr<RenderScrollbarPart> m_scrollCorner;
892
893     bool m_speculativeTilingEnabled;
894     Timer m_speculativeTilingEnableTimer;
895
896 #if PLATFORM(IOS_FAMILY)
897     bool m_useCustomFixedPositionLayoutRect;
898     IntRect m_customFixedPositionLayoutRect;
899
900     bool m_useCustomSizeForResizeEvent;
901     IntSize m_customSizeForResizeEvent;
902 #endif
903
904     Optional<OverrideViewportSize> m_overrideViewportSize;
905
906     // If true, automatically resize the frame view around its content.
907     bool m_shouldAutoSize;
908     bool m_inAutoSize;
909     // True if autosize has been run since m_shouldAutoSize was set.
910     bool m_didRunAutosize;
911     // The lower bound on the size when autosizing.
912     IntSize m_minAutoSize;
913     // The upper bound on the size when autosizing.
914     IntSize m_maxAutoSize;
915     // The fixed height to resize the view to after autosizing is complete.
916     int m_autoSizeFixedMinimumHeight;
917     // The intrinsic content size decided by autosizing.
918     IntSize m_autoSizeContentSize;
919
920     std::unique_ptr<ScrollableAreaSet> m_scrollableAreas;
921     std::unique_ptr<ViewportConstrainedObjectSet> m_viewportConstrainedObjects;
922
923     int m_headerHeight;
924     int m_footerHeight;
925
926     OptionSet<LayoutMilestone> m_milestonesPendingPaint;
927
928     static const unsigned visualCharacterThreshold = 200;
929     static const unsigned visualPixelThreshold = 32 * 32;
930
931 #if ENABLE(CSS_DEVICE_ADAPTATION)
932     // Size of viewport before any UA or author styles have overridden
933     // the viewport given by the window or viewing area of the UA.
934     IntSize m_initialViewportSize;
935 #endif
936
937     bool m_visualUpdatesAllowedByClient;
938     bool m_hasFlippedBlockRenderers;
939     bool m_speculativeTilingDelayDisabledForTesting { false };
940
941     ScrollPinningBehavior m_scrollPinningBehavior;
942
943     IntRect* m_cachedWindowClipRect { nullptr };
944     Vector<WTF::Function<void ()>> m_postLayoutCallbackQueue;
945
946     FrameViewLayoutContext m_layoutContext;
947 };
948
949 inline void FrameView::incrementVisuallyNonEmptyPixelCount(const IntSize& size)
950 {
951     if (m_isVisuallyNonEmpty)
952         return;
953     m_visuallyNonEmptyPixelCount += size.width() * size.height();
954     if (m_visuallyNonEmptyPixelCount <= visualPixelThreshold)
955         return;
956     updateIsVisuallyNonEmpty();
957 }
958
959 } // namespace WebCore
960
961 SPECIALIZE_TYPE_TRAITS_WIDGET(FrameView, isFrameView())