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