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