[FrameView::layout cleanup] Subtree should read subtreeLayout.
[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 "LayoutMilestones.h"
31 #include "LayoutRect.h"
32 #include "Pagination.h"
33 #include "PaintPhase.h"
34 #include "RenderPtr.h"
35 #include "ScrollView.h"
36 #include "TiledBacking.h"
37 #include <memory>
38 #include <wtf/Forward.h>
39 #include <wtf/Function.h>
40 #include <wtf/HashSet.h>
41 #include <wtf/ListHashSet.h>
42 #include <wtf/text/WTFString.h>
43
44 namespace WebCore {
45
46 class AXObjectCache;
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 enum class FrameFlattening;
65
66 Pagination::Mode paginationModeForRenderStyle(const RenderStyle&);
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     HostWindow* hostWindow() const final;
79     
80     WEBCORE_EXPORT void invalidateRect(const IntRect&) final;
81     void setFrameRect(const IntRect&) final;
82
83     bool scheduleAnimation() final;
84
85     Frame& frame() const { return m_frame; }
86
87     WEBCORE_EXPORT RenderView* renderView() const;
88
89     int mapFromLayoutToCSSUnits(LayoutUnit) const;
90     LayoutUnit mapFromCSSToLayoutUnits(int) const;
91
92     LayoutUnit marginWidth() const { return m_margins.width(); } // -1 means default
93     LayoutUnit marginHeight() const { return m_margins.height(); } // -1 means default
94     void setMarginWidth(LayoutUnit);
95     void setMarginHeight(LayoutUnit);
96
97     WEBCORE_EXPORT void setCanHaveScrollbars(bool) final;
98     WEBCORE_EXPORT void updateCanHaveScrollbars();
99
100     Ref<Scrollbar> createScrollbar(ScrollbarOrientation) final;
101
102     bool avoidScrollbarCreation() const final;
103
104     void setContentsSize(const IntSize&) final;
105     void updateContentsSize() final;
106
107     void layout(bool allowSubtree = true);
108     WEBCORE_EXPORT bool didFirstLayout() const;
109     void layoutTimerFired();
110     void scheduleRelayout();
111     void scheduleRelayoutOfSubtree(RenderElement&);
112     void unscheduleRelayout();
113     void queuePostLayoutCallback(WTF::Function<void ()>&&);
114     bool layoutPending() const;
115     bool isInLayout() const { return m_layoutPhase != OutsideLayout; }
116     bool isInRenderTreeLayout() const { return m_layoutPhase == InRenderTreeLayout; }
117     bool inPaintableState() { return m_layoutPhase != InRenderTreeLayout && m_layoutPhase != InViewSizeAdjust && m_layoutPhase != InPostLayout; }
118
119     RenderElement* subtreeLayoutRoot() const { return m_subtreeLayoutRoot; }
120     void clearSubtreeLayoutRoot() { m_subtreeLayoutRoot = 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 needsFullRepaint() const { return m_needsFullRepaint; }
128
129     WEBCORE_EXPORT bool renderedCharactersExceed(unsigned threshold);
130
131 #if PLATFORM(IOS)
132     bool useCustomFixedPositionLayoutRect() const;
133     IntRect customFixedPositionLayoutRect() const { return m_customFixedPositionLayoutRect; }
134     WEBCORE_EXPORT void setCustomFixedPositionLayoutRect(const IntRect&);
135     bool updateFixedPositionLayoutRect();
136
137     IntSize customSizeForResizeEvent() const { return m_customSizeForResizeEvent; }
138     WEBCORE_EXPORT void setCustomSizeForResizeEvent(IntSize);
139
140     WEBCORE_EXPORT void setScrollVelocity(double horizontalVelocity, double verticalVelocity, double scaleChangeRate, MonotonicTime timestamp);
141 #else
142     bool useCustomFixedPositionLayoutRect() const { return false; }
143 #endif
144
145     WEBCORE_EXPORT void serviceScriptedAnimations();
146
147     void willRecalcStyle();
148     bool updateCompositingLayersAfterStyleChange();
149     void updateCompositingLayersAfterLayout();
150
151     void clearBackingStores();
152
153     // Called when changes to the GraphicsLayer hierarchy have to be synchronized with
154     // content rendered via the normal painting path.
155     void setNeedsOneShotDrawingSynchronization();
156
157     WEBCORE_EXPORT GraphicsLayer* graphicsLayerForPlatformWidget(PlatformWidget);
158     WEBCORE_EXPORT void scheduleLayerFlushAllowingThrottling();
159
160     WEBCORE_EXPORT TiledBacking* tiledBacking() const final;
161
162     // In the future when any ScrollableArea can have a node in th ScrollingTree, this should
163     // become a virtual function on ScrollableArea.
164     uint64_t scrollLayerID() const;
165     ScrollableArea* scrollableAreaForScrollLayerID(uint64_t) const;
166
167     bool hasCompositedContent() const;
168     WEBCORE_EXPORT void enterCompositingMode();
169     WEBCORE_EXPORT bool isEnclosedInCompositingLayer() const;
170
171     // Only used with accelerated compositing, but outside the #ifdef to make linkage easier.
172     // Returns true if the flush was completed.
173     WEBCORE_EXPORT bool flushCompositingStateIncludingSubframes();
174
175     // Returns true when a paint with the PaintBehaviorFlattenCompositingLayers flag set gives
176     // a faithful representation of the content.
177     WEBCORE_EXPORT bool isSoftwareRenderable() const;
178
179     void setIsInWindow(bool);
180
181     void resetScrollbars();
182     void resetScrollbarsAndClearContentsSize();
183     void prepareForDetach();
184     void detachCustomScrollbars();
185     WEBCORE_EXPORT void recalculateScrollbarOverlayStyle();
186
187     void clear();
188
189     WEBCORE_EXPORT bool isTransparent() const;
190     WEBCORE_EXPORT void setTransparent(bool isTransparent);
191     
192     // True if the FrameView is not transparent, and the base background color is opaque.
193     bool hasOpaqueBackground() const;
194
195     WEBCORE_EXPORT Color baseBackgroundColor() const;
196     WEBCORE_EXPORT void setBaseBackgroundColor(const Color&);
197     void updateBackgroundRecursively(const Color&, bool);
198
199     enum ExtendedBackgroundModeFlags {
200         ExtendedBackgroundModeNone          = 0,
201         ExtendedBackgroundModeVertical      = 1 << 0,
202         ExtendedBackgroundModeHorizontal    = 1 << 1,
203         ExtendedBackgroundModeAll           = ExtendedBackgroundModeVertical | ExtendedBackgroundModeHorizontal,
204     };
205     typedef unsigned ExtendedBackgroundMode;
206
207     void updateExtendBackgroundIfNecessary();
208     void updateTilesForExtendedBackgroundMode(ExtendedBackgroundMode);
209     ExtendedBackgroundMode calculateExtendedBackgroundMode() const;
210
211     bool hasExtendedBackgroundRectForPainting() const;
212     IntRect extendedBackgroundRectForPainting() const;
213
214     bool shouldUpdateWhileOffscreen() const;
215     WEBCORE_EXPORT void setShouldUpdateWhileOffscreen(bool);
216     bool shouldUpdate() const;
217
218     WEBCORE_EXPORT void adjustViewSize();
219     IntSize layoutSizeForMediaQuery() const;
220
221     WEBCORE_EXPORT void setViewportSizeForCSSViewportUnits(IntSize);
222     IntSize viewportSizeForCSSViewportUnits() const;
223     
224     IntRect windowClipRect() const final;
225     WEBCORE_EXPORT IntRect windowClipRectForFrameOwner(const HTMLFrameOwnerElement*, bool clipToLayerContents) const;
226
227     float visibleContentScaleFactor() const final;
228
229 #if USE(COORDINATED_GRAPHICS)
230     void setFixedVisibleContentRect(const IntRect&) final;
231 #endif
232     WEBCORE_EXPORT void setScrollPosition(const ScrollPosition&) final;
233     void updateLayerPositionsAfterScrolling() final;
234     void updateCompositingLayersAfterScrolling() final;
235     bool requestScrollPositionUpdate(const ScrollPosition&) final;
236     bool isRubberBandInProgress() const final;
237     WEBCORE_EXPORT ScrollPosition minimumScrollPosition() const final;
238     WEBCORE_EXPORT ScrollPosition maximumScrollPosition() const final;
239
240     // The scrollOrigin, scrollPosition, minimumScrollPosition and maximumScrollPosition are all affected by frame scale,
241     // but layoutViewport computations require unscaled scroll positions.
242     ScrollPosition unscaledMinimumScrollPosition() const;
243     ScrollPosition unscaledMaximumScrollPosition() const;
244
245     IntPoint unscaledScrollOrigin() const;
246
247     WEBCORE_EXPORT LayoutPoint minStableLayoutViewportOrigin() const;
248     WEBCORE_EXPORT LayoutPoint maxStableLayoutViewportOrigin() const;
249
250     enum class TriggerLayoutOrNot {
251         No,
252         Yes
253     };
254     // This origin can be overridden by setLayoutViewportOverrideRect.
255     void setBaseLayoutViewportOrigin(LayoutPoint, TriggerLayoutOrNot = TriggerLayoutOrNot::Yes);
256     // This size can be overridden by setLayoutViewportOverrideRect.
257     WEBCORE_EXPORT LayoutSize baseLayoutViewportSize() const;
258     
259     // If set, overrides the default "m_layoutViewportOrigin, size of initial containing block" rect.
260     // Used with delegated scrolling (i.e. iOS).
261     WEBCORE_EXPORT void setLayoutViewportOverrideRect(std::optional<LayoutRect>, TriggerLayoutOrNot = TriggerLayoutOrNot::Yes);
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     enum class LayoutViewportConstraint { ConstrainedToDocumentRect, Unconstrained };
308     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);
309     
310     WEBCORE_EXPORT static LayoutPoint computeLayoutViewportOrigin(const LayoutRect& visualViewport, const LayoutPoint& stableLayoutViewportOriginMin, const LayoutPoint& stableLayoutViewportOriginMax, const LayoutRect& layoutViewport, ScrollBehaviorForFixedElements);
311
312     // These layers are positioned differently when there is a topContentInset, a header, or a footer. These value need to be computed
313     // on both the main thread and the scrolling thread.
314     static float yPositionForInsetClipLayer(const FloatPoint& scrollPosition, float topContentInset);
315     WEBCORE_EXPORT static FloatPoint positionForRootContentLayer(const FloatPoint& scrollPosition, const FloatPoint& scrollOrigin, float topContentInset, float headerHeight);
316     WEBCORE_EXPORT FloatPoint positionForRootContentLayer() const;
317
318     static float yPositionForHeaderLayer(const FloatPoint& scrollPosition, float topContentInset);
319     static float yPositionForFooterLayer(const FloatPoint& scrollPosition, float topContentInset, float totalContentsHeight, float footerHeight);
320
321 #if PLATFORM(IOS)
322     WEBCORE_EXPORT LayoutRect viewportConstrainedObjectsRect() const;
323     // Static function can be called from another thread.
324     WEBCORE_EXPORT static LayoutRect rectForViewportConstrainedObjects(const LayoutRect& visibleContentRect, const LayoutSize& totalContentsSize, float frameScaleFactor, bool fixedElementsLayoutRelativeToFrame, ScrollBehaviorForFixedElements);
325 #endif
326     
327     bool fixedElementsLayoutRelativeToFrame() const;
328
329     WEBCORE_EXPORT void disableLayerFlushThrottlingTemporarilyForInteraction();
330     bool speculativeTilingEnabled() const { return m_speculativeTilingEnabled; }
331     void loadProgressingStatusChanged();
332
333 #if ENABLE(DASHBOARD_SUPPORT)
334     void updateAnnotatedRegions();
335 #endif
336     WEBCORE_EXPORT void updateControlTints();
337
338     void restoreScrollbar();
339
340     WEBCORE_EXPORT bool wasScrolledByUser() const;
341     WEBCORE_EXPORT void setWasScrolledByUser(bool);
342
343     bool safeToPropagateScrollToParent() const { return m_safeToPropagateScrollToParent; }
344     void setSafeToPropagateScrollToParent(bool isSafe) { m_safeToPropagateScrollToParent = isSafe; }
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         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)
367     WEBCORE_EXPORT void didReplaceMultipartContent();
368 #endif
369
370     WEBCORE_EXPORT void setPaintBehavior(PaintBehavior);
371     WEBCORE_EXPORT PaintBehavior paintBehavior() const;
372     bool isPainting() const;
373     bool hasEverPainted() const { return m_lastPaintTime; }
374     void setLastPaintTime(double 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() { ++m_layoutDisallowedCount; }
390     void endDisallowingLayout() { ASSERT(m_layoutDisallowedCount > 0); --m_layoutDisallowedCount; }
391     bool layoutDisallowed() const { return m_layoutDisallowedCount; }
392
393     static double currentPaintTimeStamp() { return sCurrentPaintTimeStamp; } // returns 0 if not painting
394     
395     WEBCORE_EXPORT void updateLayoutAndStyleIfNeededRecursive();
396
397     void incrementVisuallyNonEmptyCharacterCount(unsigned);
398     void incrementVisuallyNonEmptyPixelCount(const IntSize&);
399     void updateIsVisuallyNonEmpty();
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 allowSubtree = 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 IntPoint convertFromRendererToContainingView(const RenderElement*, const IntPoint&) const;
463     WEBCORE_EXPORT IntPoint convertFromContainingViewToRenderer(const RenderElement*, const IntPoint&) const;
464
465     // Override ScrollView methods to do point conversion via renderers, in order to take transforms into account.
466     IntRect convertToContainingView(const IntRect&) const final;
467     IntRect convertFromContainingView(const IntRect&) const final;
468     IntPoint convertToContainingView(const IntPoint&) const final;
469     IntPoint convertFromContainingView(const IntPoint&) const final;
470
471     float documentToAbsoluteScaleFactor(std::optional<float> effectiveZoom = std::nullopt) const;
472     float absoluteToDocumentScaleFactor(std::optional<float> effectiveZoom = std::nullopt) const;
473
474     FloatRect absoluteToDocumentRect(FloatRect, std::optional<float> effectiveZoom = std::nullopt) const;
475     FloatPoint absoluteToDocumentPoint(FloatPoint, std::optional<float> effectiveZoom = std::nullopt) const;
476
477     FloatSize documentToClientOffset() const;
478     FloatRect documentToClientRect(FloatRect) const;
479     FloatPoint documentToClientPoint(FloatPoint) const;
480     WEBCORE_EXPORT FloatPoint clientToDocumentPoint(FloatPoint) const;
481
482     FloatRect layoutViewportToAbsoluteRect(FloatRect) const;
483     FloatPoint layoutViewportToAbsolutePoint(FloatPoint) const;
484
485     // Unlike client coordinates, layout viewport coordinates are affected by page zoom.
486     FloatPoint clientToLayoutViewportPoint(FloatPoint) const;
487
488     bool isFrameViewScrollCorner(const RenderScrollbarPart& scrollCorner) const { return m_scrollCorner.get() == &scrollCorner; }
489
490     // isScrollable() takes an optional Scrollability parameter that allows the caller to define what they mean by 'scrollable.'
491     // Most callers are interested in the default value, Scrollability::Scrollable, which means that there is actually content
492     // 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
493     // to rubber-band, which the main frame might be allowed to do even if there is no content to scroll to. In that case,
494     // callers use Scrollability::ScrollableOrRubberbandable.
495     enum class Scrollability { Scrollable, ScrollableOrRubberbandable };
496     WEBCORE_EXPORT bool isScrollable(Scrollability definitionOfScrollable = Scrollability::Scrollable);
497
498     bool isScrollableOrRubberbandable() final;
499     bool hasScrollableOrRubberbandableAncestor() final;
500
501     enum ScrollbarModesCalculationStrategy { RulesFromWebContentOnly, AnyRule };
502     void calculateScrollbarModesForLayout(ScrollbarMode& hMode, ScrollbarMode& vMode, ScrollbarModesCalculationStrategy = AnyRule);
503
504     IntPoint lastKnownMousePosition() const final;
505     bool isHandlingWheelEvent() const final;
506     bool shouldSetCursor() const;
507
508     // FIXME: Remove this method once plugin loading is decoupled from layout.
509     void flushAnyPendingPostLayoutTasks();
510
511     bool shouldSuspendScrollAnimations() const final;
512     void scrollbarStyleChanged(ScrollbarStyle, bool forceUpdate) override;
513
514     RenderBox* embeddedContentBox() const;
515     
516     WEBCORE_EXPORT void setTracksRepaints(bool);
517     bool isTrackingRepaints() const { return m_isTrackingRepaints; }
518     WEBCORE_EXPORT void resetTrackedRepaints();
519     const Vector<FloatRect>& trackedRepaintRects() const { return m_trackedRepaintRects; }
520     String trackedRepaintRectsAsText() const;
521
522     typedef HashSet<ScrollableArea*> ScrollableAreaSet;
523     // Returns whether the scrollable area has just been newly added.
524     WEBCORE_EXPORT bool addScrollableArea(ScrollableArea*);
525     // Returns whether the scrollable area has just been removed.
526     WEBCORE_EXPORT bool removeScrollableArea(ScrollableArea*);
527     bool containsScrollableArea(ScrollableArea*) const;
528     const ScrollableAreaSet* scrollableAreas() const { return m_scrollableAreas.get(); }
529
530     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 didAddWidgetToRenderTree(Widget&);
605     void willRemoveWidgetFromRenderTree(Widget&);
606
607     const HashSet<Widget*>& widgetsInRenderTree() const { return m_widgetsInRenderTree; }
608
609     void addTrackedRepaintRect(const FloatRect&);
610
611     // exposedRect represents WebKit's understanding of what part
612     // of the view is actually exposed on screen (taking into account
613     // clipping by other UI elements), whereas visibleContentRect is
614     // internal to WebCore and doesn't respect those things.
615     WEBCORE_EXPORT void setViewExposedRect(std::optional<FloatRect>);
616     std::optional<FloatRect> viewExposedRect() const { return m_viewExposedRect; }
617
618 #if ENABLE(CSS_SCROLL_SNAP)
619     void updateSnapOffsets() final;
620     bool isScrollSnapInProgress() const final;
621     void updateScrollingCoordinatorScrollSnapProperties() const;
622 #endif
623
624     float adjustScrollStepForFixedContent(float step, ScrollbarOrientation, ScrollGranularity) final;
625
626     void didChangeScrollOffset();
627
628     void show() final;
629     void hide() final;
630
631     bool shouldPlaceBlockDirectionScrollbarOnLeft() const final;
632
633     void didRestoreFromPageCache();
634
635     void willDestroyRenderTree();
636     void didDestroyRenderTree();
637
638     void setSpeculativeTilingDelayDisabledForTesting(bool disabled) { m_speculativeTilingDelayDisabledForTesting = disabled; }
639
640     WEBCORE_EXPORT FrameFlattening effectiveFrameFlattening() const;
641
642 protected:
643     bool scrollContentsFastPath(const IntSize& scrollDelta, const IntRect& rectToScroll, const IntRect& clipRect) final;
644     void scrollContentsSlowPath(const IntRect& updateRect) final;
645     
646     void repaintSlowRepaintObjects();
647
648     bool isVerticalDocument() const final;
649     bool isFlippedDocument() const final;
650
651 private:
652     explicit FrameView(Frame&);
653
654     void reset();
655     void init();
656
657     enum LayoutPhase {
658         OutsideLayout,
659         InPreLayout,
660         InPreLayoutStyleUpdate,
661         InRenderTreeLayout,
662         InViewSizeAdjust,
663         InPostLayout,
664         InPostLayerPositionsUpdatedAfterLayout,
665     };
666     LayoutPhase layoutPhase() const { return m_layoutPhase; }
667
668     bool inPreLayoutStyleUpdate() const { return m_layoutPhase == InPreLayoutStyleUpdate; }
669
670     bool isFrameView() const final { return true; }
671
672     friend class RenderWidget;
673     bool useSlowRepaints(bool considerOverlap = true) const;
674     bool useSlowRepaintsIfNotOverlapped() const;
675     void updateCanBlitOnScrollRecursively();
676     bool shouldLayoutAfterContentsResized() const;
677
678     bool shouldUpdateCompositingLayersAfterScrolling() const;
679     bool flushCompositingStateForThisFrame(const Frame& rootFrameForFlush);
680
681     bool shouldDeferScrollUpdateAfterContentSizeChange() final;
682
683     void scrollOffsetChangedViaPlatformWidgetImpl(const ScrollOffset& oldOffset, const ScrollOffset& newOffset) final;
684
685     void applyOverflowToViewport(const RenderElement&, ScrollbarMode& hMode, ScrollbarMode& vMode);
686     void applyPaginationToViewport();
687
688     void updateOverflowStatus(bool horizontalOverflow, bool verticalOverflow);
689
690     WEBCORE_EXPORT void paintControlTints();
691
692     void forceLayoutParentViewIfNeeded();
693     void flushPostLayoutTasksQueue();
694     void performPostLayoutTasks();
695     void autoSizeIfEnabled();
696
697     void applyRecursivelyWithVisibleRect(const WTF::Function<void (FrameView& frameView, const IntRect& visibleRect)>&);
698     void resumeVisibleImageAnimations(const IntRect& visibleRect);
699     void updateScriptedAnimationsAndTimersThrottlingState(const IntRect& visibleRect);
700
701     void updateLayerFlushThrottling();
702     WEBCORE_EXPORT void adjustTiledBackingCoverage();
703
704     void repaintContentRectangle(const IntRect&) final;
705     void addedOrRemovedScrollbar() final;
706
707     void delegatesScrollingDidChange() final;
708
709     // ScrollableArea interface
710     void invalidateScrollbarRect(Scrollbar&, const IntRect&) final;
711     void scrollTo(const ScrollPosition&) final;
712     void setVisibleScrollerThumbRect(const IntRect&) final;
713     ScrollableArea* enclosingScrollableArea() const final;
714     IntRect scrollableAreaBoundingBox(bool* = nullptr) const final;
715     bool scrollAnimatorEnabled() const final;
716     GraphicsLayer* layerForScrolling() const final;
717     GraphicsLayer* layerForHorizontalScrollbar() const final;
718     GraphicsLayer* layerForVerticalScrollbar() const final;
719     GraphicsLayer* layerForScrollCorner() const final;
720 #if ENABLE(RUBBER_BANDING)
721     GraphicsLayer* layerForOverhangAreas() const final;
722 #endif
723     void contentsResized() final;
724
725 #if PLATFORM(IOS)
726     void unobscuredContentSizeChanged() final;
727 #endif
728
729     bool usesCompositedScrolling() const final;
730     bool usesAsyncScrolling() const final;
731     bool usesMockScrollAnimator() const final;
732     void logMockScrollAnimatorMessage(const String&) const final;
733
734     // Override scrollbar notifications to update the AXObject cache.
735     void didAddScrollbar(Scrollbar*, ScrollbarOrientation) final;
736     void willRemoveScrollbar(Scrollbar*, ScrollbarOrientation) final;
737
738     IntSize sizeForResizeEvent() const;
739     void sendResizeEventIfNeeded();
740
741     void handleDeferredScrollbarsUpdateAfterDirectionChange();
742
743     void updateScrollableAreaSet();
744     void updateLayoutViewport();
745
746     void notifyPageThatContentAreaWillPaint() const final;
747
748     void enableSpeculativeTilingIfNeeded();
749     void speculativeTilingEnableTimerFired();
750
751     void updateEmbeddedObjectsTimerFired();
752     bool updateEmbeddedObjects();
753     void updateEmbeddedObject(RenderEmbeddedObject&);
754     void scrollToAnchor();
755     void scrollPositionChanged(const ScrollPosition& oldPosition, const ScrollPosition& newPosition);
756     void scrollableAreaSetChanged();
757     void sendScrollEvent();
758
759     bool hasCustomScrollbars() const;
760
761     void updateScrollCorner() final;
762
763     FrameView* parentFrameView() const;
764
765     void startLayoutAtMainFrameViewIfNeeded(bool allowSubtree);
766     bool frameFlatteningEnabled() const;
767     bool isFrameFlatteningValidForThisFrame() const;
768
769     bool qualifiesAsVisuallyNonEmpty() const;
770     bool isViewForDocumentInFrame() const;
771
772     AXObjectCache* axObjectCache() const;
773     void notifyWidgetsInAllFrames(WidgetNotification);
774     void removeFromAXObjectCache();
775     void notifyWidgets(WidgetNotification);
776
777     void convertSubtreeLayoutToFullLayout();
778
779     RenderElement* viewportRenderer() const;
780
781     HashSet<Widget*> m_widgetsInRenderTree;
782
783     static double sCurrentPaintTimeStamp; // used for detecting decoded resource thrash in the cache
784
785     LayoutSize m_size;
786     LayoutSize m_margins;
787
788     std::unique_ptr<ListHashSet<RenderEmbeddedObject*>> m_embeddedObjectsToUpdate;
789     const Ref<Frame> m_frame;
790
791     std::unique_ptr<HashSet<const RenderElement*>> m_slowRepaintObjects;
792
793     bool m_needsFullRepaint;
794     
795     bool m_canHaveScrollbars;
796     bool m_cannotBlitToWindow;
797     bool m_isOverlapped { false };
798     bool m_contentIsOpaque;
799
800     Timer m_layoutTimer;
801     bool m_delayedLayout;
802     RenderElement* m_subtreeLayoutRoot { nullptr };
803
804     LayoutPhase m_layoutPhase;
805     bool m_layoutSchedulingEnabled;
806     bool m_inSynchronousPostLayout;
807     int m_layoutCount;
808     unsigned m_nestedLayoutCount;
809     Timer m_postLayoutTasksTimer;
810     Timer m_updateEmbeddedObjectsTimer;
811     bool m_firstLayoutCallbackPending;
812
813     bool m_firstLayout;
814     bool m_isTransparent;
815     Color m_baseBackgroundColor;
816     IntSize m_lastViewportSize;
817     float m_lastZoomFactor;
818
819     String m_mediaType;
820     String m_mediaTypeWhenNotPrinting;
821
822     bool m_overflowStatusDirty;
823     bool m_horizontalOverflow;
824     bool m_verticalOverflow;
825     enum class ViewportRendererType { None, Document, Body };
826     ViewportRendererType m_viewportRendererType { ViewportRendererType::None };
827
828     Pagination m_pagination;
829
830     bool m_wasScrolledByUser;
831     bool m_inProgrammaticScroll;
832     bool m_safeToPropagateScrollToParent;
833     Timer m_delayedScrollEventTimer;
834
835     double m_lastPaintTime;
836
837     bool m_isTrackingRepaints; // Used for testing.
838     Vector<FloatRect> m_trackedRepaintRects;
839
840     bool m_shouldUpdateWhileOffscreen;
841
842     std::optional<FloatRect> m_viewExposedRect;
843     
844     LayoutPoint m_layoutViewportOrigin;
845     std::optional<LayoutRect> m_layoutViewportOverrideRect;
846
847     unsigned m_deferSetNeedsLayoutCount;
848     bool m_setNeedsLayoutWasDeferred;
849     int m_layoutDisallowedCount { 0 };
850
851     RefPtr<Node> m_nodeToDraw;
852     PaintBehavior m_paintBehavior;
853     bool m_isPainting;
854
855     unsigned m_visuallyNonEmptyCharacterCount;
856     unsigned m_visuallyNonEmptyPixelCount;
857     bool m_isVisuallyNonEmpty;
858     bool m_firstVisuallyNonEmptyLayoutCallbackPending;
859
860     bool m_needsDeferredScrollbarsUpdate { false };
861
862     RefPtr<ContainerNode> m_maintainScrollPositionAnchor;
863
864     // Renderer to hold our custom scroll corner.
865     RenderPtr<RenderScrollbarPart> m_scrollCorner;
866
867     bool m_speculativeTilingEnabled;
868     Timer m_speculativeTilingEnableTimer;
869
870 #if PLATFORM(IOS)
871     bool m_useCustomFixedPositionLayoutRect;
872     IntRect m_customFixedPositionLayoutRect;
873
874     bool m_useCustomSizeForResizeEvent;
875     IntSize m_customSizeForResizeEvent;
876 #endif
877
878     IntSize m_overrideViewportSize;
879     bool m_hasOverrideViewportSize;
880
881     // If true, automatically resize the frame view around its content.
882     bool m_shouldAutoSize;
883     bool m_inAutoSize;
884     // True if autosize has been run since m_shouldAutoSize was set.
885     bool m_didRunAutosize;
886     // The lower bound on the size when autosizing.
887     IntSize m_minAutoSize;
888     // The upper bound on the size when autosizing.
889     IntSize m_maxAutoSize;
890     // The fixed height to resize the view to after autosizing is complete.
891     int m_autoSizeFixedMinimumHeight;
892     // The intrinsic content size decided by autosizing.
893     IntSize m_autoSizeContentSize;
894     // Report the first computed frame view size to media queries.
895     std::optional<IntSize> m_frameFlatteningViewSizeForMediaQuery;
896
897     std::unique_ptr<ScrollableAreaSet> m_scrollableAreas;
898     std::unique_ptr<ViewportConstrainedObjectSet> m_viewportConstrainedObjects;
899
900     int m_headerHeight;
901     int m_footerHeight;
902
903     LayoutMilestones m_milestonesPendingPaint;
904
905     static const unsigned visualCharacterThreshold = 200;
906     static const unsigned visualPixelThreshold = 32 * 32;
907
908 #if ENABLE(CSS_DEVICE_ADAPTATION)
909     // Size of viewport before any UA or author styles have overridden
910     // the viewport given by the window or viewing area of the UA.
911     IntSize m_initialViewportSize;
912 #endif
913
914     bool m_visualUpdatesAllowedByClient;
915     bool m_hasFlippedBlockRenderers;
916     bool m_speculativeTilingDelayDisabledForTesting { false };
917
918     ScrollPinningBehavior m_scrollPinningBehavior;
919
920     IntRect* m_cachedWindowClipRect { nullptr };
921     Vector<WTF::Function<void ()>> m_postLayoutCallbackQueue;
922 };
923
924 inline void FrameView::incrementVisuallyNonEmptyCharacterCount(unsigned count)
925 {
926     if (m_isVisuallyNonEmpty)
927         return;
928     m_visuallyNonEmptyCharacterCount += count;
929     if (m_visuallyNonEmptyCharacterCount <= visualCharacterThreshold)
930         return;
931     updateIsVisuallyNonEmpty();
932 }
933
934 inline void FrameView::incrementVisuallyNonEmptyPixelCount(const IntSize& size)
935 {
936     if (m_isVisuallyNonEmpty)
937         return;
938     m_visuallyNonEmptyPixelCount += size.width() * size.height();
939     if (m_visuallyNonEmptyPixelCount <= visualPixelThreshold)
940         return;
941     updateIsVisuallyNonEmpty();
942 }
943
944 } // namespace WebCore
945
946 SPECIALIZE_TYPE_TRAITS_WIDGET(FrameView, isFrameView())