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