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-2009, 2014 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 #ifndef FrameView_h
  26 #define FrameView_h
  27
  28 #include "AdjustViewSizeOrNot.h"
  29 #include "Color.h"
  30 #include "ContainerNode.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 <memory>
  38 #include <wtf/Forward.h>
  39 #include <wtf/HashSet.h>
  40 #include <wtf/ListHashSet.h>
  41 #include <wtf/text/WTFString.h>
  42
  43 namespace WebCore {
  44
  45 class AXObjectCache;
  46 class DOMTimer;
  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     virtual HostWindow* hostWindow() const override;
  79
  80     WEBCORE_EXPORT virtual void invalidateRect(const IntRect&) override;
  81     virtual void setFrameRect(const IntRect&) override;
  82
  83 #if ENABLE(REQUEST_ANIMATION_FRAME)
  84     virtual bool scheduleAnimation() override;
  85 #endif
  86
  87     Frame& frame() const { return *m_frame; }
  88
  89     WEBCORE_EXPORT RenderView* renderView() const;
  90
  91     int mapFromLayoutToCSSUnits(LayoutUnit) const;
  92     LayoutUnit mapFromCSSToLayoutUnits(int) const;
  93
  94     LayoutUnit marginWidth() const { return m_margins.width(); } // -1 means default
  95     LayoutUnit marginHeight() const { return m_margins.height(); } // -1 means default
  96     void setMarginWidth(LayoutUnit);
  97     void setMarginHeight(LayoutUnit);
  98
  99     WEBCORE_EXPORT virtual void setCanHaveScrollbars(bool) override;
 100     WEBCORE_EXPORT void updateCanHaveScrollbars();
 101
 102     virtual PassRefPtr<Scrollbar> createScrollbar(ScrollbarOrientation) override;
 103
 104     virtual bool avoidScrollbarCreation() const override;
 105
 106     virtual void setContentsSize(const IntSize&) override;
 107
 108     void layout(bool allowSubtree = true);
 109     WEBCORE_EXPORT bool didFirstLayout() const;
 110     void layoutTimerFired();
 111     void scheduleRelayout();
 112     void scheduleRelayoutOfSubtree(RenderElement&);
 113     void unscheduleRelayout();
 114     bool layoutPending() const;
 115     bool isInLayout() const { return m_layoutPhase == InLayout; }
 116
 117     RenderObject* layoutRoot(bool onlyDuringLayout = false) const;
 118     void clearLayoutRoot() { m_layoutRoot = nullptr; }
 119     int layoutCount() const { return m_layoutCount; }
 120
 121     WEBCORE_EXPORT bool needsLayout() const;
 122     WEBCORE_EXPORT void setNeedsLayout();
 123     void setViewportConstrainedObjectsNeedLayout();
 124
 125     bool needsStyleRecalcOrLayout(bool includeSubframes = true) const;
 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 { return m_useCustomFixedPositionLayoutRect; }
 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, double timestamp);
 141     FloatRect computeCoverageRect(double horizontalMargin, double verticalMargin) const;
 142 #else
 143     bool useCustomFixedPositionLayoutRect() const { return false; }
 144 #endif
 145
 146 #if ENABLE(REQUEST_ANIMATION_FRAME)
 147     WEBCORE_EXPORT void serviceScriptedAnimations(double monotonicAnimationStartTime);
 148 #endif
 149
 150     void updateCompositingLayersAfterStyleChange();
 151     void updateCompositingLayersAfterLayout();
 152     bool flushCompositingStateForThisFrame(Frame* rootFrameForFlush);
 153
 154     void clearBackingStores();
 155     void restoreBackingStores();
 156
 157     // Called when changes to the GraphicsLayer hierarchy have to be synchronized with
 158     // content rendered via the normal painting path.
 159     void setNeedsOneShotDrawingSynchronization();
 160
 161     WEBCORE_EXPORT GraphicsLayer* graphicsLayerForPlatformWidget(PlatformWidget);
 162     WEBCORE_EXPORT void scheduleLayerFlushAllowingThrottling();
 163
 164     WEBCORE_EXPORT virtual TiledBacking* tiledBacking() const override;
 165
 166     // In the future when any ScrollableArea can have a node in th ScrollingTree, this should
 167     // become a virtual function on ScrollableArea.
 168     uint64_t scrollLayerID() const;
 169     ScrollableArea* scrollableAreaForScrollLayerID(uint64_t) const;
 170
 171     bool hasCompositedContent() const;
 172     bool hasCompositedContentIncludingDescendants() const;
 173     bool hasCompositingAncestor() const;
 174     WEBCORE_EXPORT void enterCompositingMode();
 175     WEBCORE_EXPORT bool isEnclosedInCompositingLayer() const;
 176
 177     // Only used with accelerated compositing, but outside the #ifdef to make linkage easier.
 178     // Returns true if the flush was completed.
 179     WEBCORE_EXPORT bool flushCompositingStateIncludingSubframes();
 180
 181     // Returns true when a paint with the PaintBehaviorFlattenCompositingLayers flag set gives
 182     // a faithful representation of the content.
 183     WEBCORE_EXPORT bool isSoftwareRenderable() const;
 184
 185     void setIsInWindow(bool);
 186
 187     void resetScrollbars();
 188     void resetScrollbarsAndClearContentsSize();
 189     void prepareForDetach();
 190     void detachCustomScrollbars();
 191     void recalculateScrollbarOverlayStyle();
 192
 193     void clear();
 194
 195     WEBCORE_EXPORT bool isTransparent() const;
 196     WEBCORE_EXPORT void setTransparent(bool isTransparent);
 197
 198     // True if the FrameView is not transparent, and the base background color is opaque.
 199     bool hasOpaqueBackground() const;
 200
 201     WEBCORE_EXPORT Color baseBackgroundColor() const;
 202     WEBCORE_EXPORT void setBaseBackgroundColor(const Color&);
 203     void updateBackgroundRecursively(const Color&, bool);
 204
 205     enum ExtendedBackgroundModeFlags {
 206         ExtendedBackgroundModeNone          = 0,
 207         ExtendedBackgroundModeVertical      = 1 << 0,
 208         ExtendedBackgroundModeHorizontal    = 1 << 1,
 209         ExtendedBackgroundModeAll           = ExtendedBackgroundModeVertical | ExtendedBackgroundModeHorizontal,
 210     };
 211     typedef unsigned ExtendedBackgroundMode;
 212
 213     void updateExtendBackgroundIfNecessary();
 214     void updateTilesForExtendedBackgroundMode(ExtendedBackgroundMode);
 215     ExtendedBackgroundMode calculateExtendedBackgroundMode() const;
 216
 217     bool hasExtendedBackgroundRectForPainting() const;
 218     IntRect extendedBackgroundRectForPainting() const;
 219
 220     bool shouldUpdateWhileOffscreen() const;
 221     WEBCORE_EXPORT void setShouldUpdateWhileOffscreen(bool);
 222     bool shouldUpdate() const;
 223
 224     WEBCORE_EXPORT void adjustViewSize();
 225
 226     WEBCORE_EXPORT void setViewportSizeForCSSViewportUnits(IntSize);
 227     IntSize viewportSizeForCSSViewportUnits() const;
 228
 229     virtual IntRect windowClipRect() const override;
 230     WEBCORE_EXPORT IntRect windowClipRectForFrameOwner(const HTMLFrameOwnerElement*, bool clipToLayerContents) const;
 231
 232     virtual IntRect windowResizerRect() const override;
 233
 234     virtual float visibleContentScaleFactor() const override;
 235
 236 #if USE(TILED_BACKING_STORE)
 237     virtual void setFixedVisibleContentRect(const IntRect&) override;
 238 #endif
 239     WEBCORE_EXPORT virtual void setScrollPosition(const IntPoint&) override;
 240     virtual void updateLayerPositionsAfterScrolling() override;
 241     virtual void updateCompositingLayersAfterScrolling() override;
 242     virtual bool requestScrollPositionUpdate(const IntPoint&) override;
 243     virtual bool isRubberBandInProgress() const override;
 244     WEBCORE_EXPORT virtual IntPoint minimumScrollPosition() const override;
 245     WEBCORE_EXPORT virtual IntPoint maximumScrollPosition() const override;
 246     void delayedScrollEventTimerFired();
 247
 248     void viewportContentsChanged();
 249     WEBCORE_EXPORT void resumeVisibleImageAnimationsIncludingSubframes();
 250
 251     // This is different than visibleContentRect() in that it ignores negative (or overly positive)
 252     // offsets from rubber-banding, and it takes zooming into account.
 253     LayoutRect viewportConstrainedVisibleContentRect() const;
 254
 255     String mediaType() const;
 256     WEBCORE_EXPORT void setMediaType(const String&);
 257     void adjustMediaTypeForPrinting(bool printing);
 258
 259     void setCannotBlitToWindow();
 260     void setIsOverlapped(bool);
 261     bool isOverlapped() const { return m_isOverlapped; }
 262     bool isOverlappedIncludingAncestors() const;
 263     void setContentIsOpaque(bool);
 264
 265     void addSlowRepaintObject(RenderElement*);
 266     void removeSlowRepaintObject(RenderElement*);
 267     bool hasSlowRepaintObject(RenderElement* o) const { return m_slowRepaintObjects && m_slowRepaintObjects->contains(o); }
 268     bool hasSlowRepaintObjects() const { return m_slowRepaintObjects && m_slowRepaintObjects->size(); }
 269
 270     // Includes fixed- and sticky-position objects.
 271     typedef HashSet<RenderElement*> ViewportConstrainedObjectSet;
 272     void addViewportConstrainedObject(RenderElement*);
 273     void removeViewportConstrainedObject(RenderElement*);
 274     const ViewportConstrainedObjectSet* viewportConstrainedObjects() const { return m_viewportConstrainedObjects.get(); }
 275     bool hasViewportConstrainedObjects() const { return m_viewportConstrainedObjects && m_viewportConstrainedObjects->size() > 0; }
 276
 277     // Functions for querying the current scrolled position, negating the effects of overhang
 278     // and adjusting for page scale.
 279     LayoutSize scrollOffsetForFixedPosition() const;
 280     // Static function can be called from another thread.
 281     static LayoutSize scrollOffsetForFixedPosition(const LayoutRect& visibleContentRect, const LayoutSize& totalContentsSize, const LayoutPoint& scrollPosition, const LayoutPoint& scrollOrigin, float frameScaleFactor, bool fixedElementsLayoutRelativeToFrame, ScrollBehaviorForFixedElements, int headerHeight, int footerHeight);
 282
 283     // These layers are positioned differently when there is a topContentInset, a header, or a footer. These value need to be computed
 284     // on both the main thread and the scrolling thread.
 285     static float yPositionForInsetClipLayer(const FloatPoint& scrollPosition, float topContentInset);
 286     WEBCORE_EXPORT static float yPositionForRootContentLayer(const FloatPoint& scrollPosition, float topContentInset, float headerHeight);
 287     static float yPositionForHeaderLayer(const FloatPoint& scrollPosition, float topContentInset);
 288     static float yPositionForFooterLayer(const FloatPoint& scrollPosition, float topContentInset, float totalContentsHeight, float footerHeight);
 289
 290 #if PLATFORM(IOS)
 291     WEBCORE_EXPORT LayoutRect viewportConstrainedObjectsRect() const;
 292     // Static function can be called from another thread.
 293     WEBCORE_EXPORT static LayoutRect rectForViewportConstrainedObjects(const LayoutRect& visibleContentRect, const LayoutSize& totalContentsSize, float frameScaleFactor, bool fixedElementsLayoutRelativeToFrame, ScrollBehaviorForFixedElements);
 294 #endif
 295
 296     bool fixedElementsLayoutRelativeToFrame() const;
 297
 298     WEBCORE_EXPORT void disableLayerFlushThrottlingTemporarilyForInteraction();
 299     bool speculativeTilingEnabled() const { return m_speculativeTilingEnabled; }
 300     void loadProgressingStatusChanged();
 301
 302 #if ENABLE(DASHBOARD_SUPPORT)
 303     void updateAnnotatedRegions();
 304 #endif
 305     WEBCORE_EXPORT void updateControlTints();
 306
 307     void restoreScrollbar();
 308
 309     void postLayoutTimerFired();
 310
 311     void registerThrottledDOMTimer(DOMTimer*);
 312     void unregisterThrottledDOMTimer(DOMTimer*);
 313
 314     WEBCORE_EXPORT bool wasScrolledByUser() const;
 315     WEBCORE_EXPORT void setWasScrolledByUser(bool);
 316
 317     bool safeToPropagateScrollToParent() const { return m_safeToPropagateScrollToParent; }
 318     void setSafeToPropagateScrollToParent(bool isSafe) { m_safeToPropagateScrollToParent = isSafe; }
 319
 320     void addEmbeddedObjectToUpdate(RenderEmbeddedObject&);
 321     void removeEmbeddedObjectToUpdate(RenderEmbeddedObject&);
 322
 323     WEBCORE_EXPORT virtual void paintContents(GraphicsContext*, const IntRect& dirtyRect) override;
 324
 325     struct PaintingState {
 326         PaintBehavior paintBehavior;
 327         bool isTopLevelPainter;
 328         bool isFlatteningPaintOfRootFrame;
 329         PaintingState()
 330             : paintBehavior()
 331             , isTopLevelPainter(false)
 332             , isFlatteningPaintOfRootFrame(false)
 333         {
 334         }
 335     };
 336
 337     void willPaintContents(GraphicsContext*, const IntRect& dirtyRect, PaintingState&);
 338     void didPaintContents(GraphicsContext*, const IntRect& dirtyRect, PaintingState&);
 339
 340     WEBCORE_EXPORT void setPaintBehavior(PaintBehavior);
 341     WEBCORE_EXPORT PaintBehavior paintBehavior() const;
 342     bool isPainting() const;
 343     bool hasEverPainted() const { return m_lastPaintTime; }
 344     void setLastPaintTime(double lastPaintTime) { m_lastPaintTime = lastPaintTime; }
 345     WEBCORE_EXPORT void setNodeToDraw(Node*);
 346
 347     enum SelectionInSnapshot { IncludeSelection, ExcludeSelection };
 348     enum CoordinateSpaceForSnapshot { DocumentCoordinates, ViewCoordinates };
 349     WEBCORE_EXPORT void paintContentsForSnapshot(GraphicsContext*, const IntRect& imageRect, SelectionInSnapshot shouldPaintSelection, CoordinateSpaceForSnapshot);
 350
 351     virtual void paintOverhangAreas(GraphicsContext*, const IntRect& horizontalOverhangArea, const IntRect& verticalOverhangArea, const IntRect& dirtyRect) override;
 352     virtual void paintScrollCorner(GraphicsContext*, const IntRect& cornerRect) override;
 353     virtual void paintScrollbar(GraphicsContext*, Scrollbar*, const IntRect&) override;
 354
 355     WEBCORE_EXPORT Color documentBackgroundColor() const;
 356
 357     bool isInChildFrameWithFrameFlattening() const;
 358
 359     static double currentPaintTimeStamp() { return sCurrentPaintTimeStamp; } // returns 0 if not painting
 360
 361     WEBCORE_EXPORT void updateLayoutAndStyleIfNeededRecursive();
 362
 363     void incrementVisuallyNonEmptyCharacterCount(unsigned);
 364     void incrementVisuallyNonEmptyPixelCount(const IntSize&);
 365     void updateIsVisuallyNonEmpty();
 366     bool isVisuallyNonEmpty() const { return m_isVisuallyNonEmpty; }
 367     WEBCORE_EXPORT void enableAutoSizeMode(bool enable, const IntSize& minSize, const IntSize& maxSize);
 368     WEBCORE_EXPORT void setAutoSizeFixedMinimumHeight(int);
 369     IntSize autoSizingIntrinsicContentSize() const { return m_autoSizeContentSize; }
 370
 371     WEBCORE_EXPORT void forceLayout(bool allowSubtree = false);
 372     WEBCORE_EXPORT void forceLayoutForPagination(const FloatSize& pageSize, const FloatSize& originalPageSize, float maximumShrinkFactor, AdjustViewSizeOrNot);
 373
 374     // FIXME: This method is retained because of embedded WebViews in AppKit.  When a WebView is embedded inside
 375     // some enclosing view with auto-pagination, no call happens to resize the view.  The new pagination model
 376     // needs the view to resize as a result of the breaks, but that means that the enclosing view has to potentially
 377     // resize around that view.  Auto-pagination uses the bounds of the actual view that's being printed to determine
 378     // the edges of the print operation, so the resize is necessary if the enclosing view's bounds depend on the
 379     // web document's bounds.
 380     //
 381     // This is already a problem if the view needs to be a different size because of printer fonts or because of print stylesheets.
 382     // Mail/Dictionary work around this problem by using the _layoutForPrinting SPI
 383     // to at least get print stylesheets and printer fonts into play, but since WebKit doesn't know about the page offset or
 384     // page size, it can't actually paginate correctly during _layoutForPrinting.
 385     //
 386     // We can eventually move Mail to a newer SPI that would let them opt in to the layout-time pagination model,
 387     // but that doesn't solve the general problem of how other AppKit views could opt in to the better model.
 388     //
 389     // NO OTHER PLATFORM BESIDES MAC SHOULD USE THIS METHOD.
 390     WEBCORE_EXPORT void adjustPageHeightDeprecated(float* newBottom, float oldTop, float oldBottom, float bottomLimit);
 391
 392     bool scrollToFragment(const URL&);
 393     bool scrollToAnchor(const String&);
 394     void maintainScrollPositionAtAnchor(ContainerNode*);
 395     WEBCORE_EXPORT void scrollElementToRect(Element*, const IntRect&);
 396
 397     // Methods to convert points and rects between the coordinate space of the renderer, and this view.
 398     WEBCORE_EXPORT IntRect convertFromRendererToContainingView(const RenderElement*, const IntRect&) const;
 399     WEBCORE_EXPORT IntRect convertFromContainingViewToRenderer(const RenderElement*, const IntRect&) const;
 400     WEBCORE_EXPORT IntPoint convertFromRendererToContainingView(const RenderElement*, const IntPoint&) const;
 401     WEBCORE_EXPORT IntPoint convertFromContainingViewToRenderer(const RenderElement*, const IntPoint&) const;
 402
 403     bool isFrameViewScrollCorner(RenderScrollbarPart* scrollCorner) const { return m_scrollCorner == scrollCorner; }
 404
 405     // isScrollable() takes an optional Scrollability parameter that allows the caller to define what they mean by 'scrollable.'
 406     // Most callers are interested in the default value, Scrollability::Scrollable, which means that there is actually content
 407     // 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
 408     // to rubber-band, which the main frame might be allowed to do even if there is no content to scroll to. In that case,
 409     // callers use Scrollability::ScrollableOrRubberbandable.
 410     enum class Scrollability { Scrollable, ScrollableOrRubberbandable };
 411     bool isScrollable(Scrollability definitionOfScrollable = Scrollability::Scrollable);
 412
 413     virtual bool isScrollableOrRubberbandable() override;
 414     virtual bool hasScrollableOrRubberbandableAncestor() override;
 415
 416     enum ScrollbarModesCalculationStrategy { RulesFromWebContentOnly, AnyRule };
 417     void calculateScrollbarModesForLayout(ScrollbarMode& hMode, ScrollbarMode& vMode, ScrollbarModesCalculationStrategy = AnyRule);
 418
 419     virtual IntPoint lastKnownMousePosition() const override;
 420     virtual bool isHandlingWheelEvent() const override;
 421     bool shouldSetCursor() const;
 422
 423     // FIXME: Remove this method once plugin loading is decoupled from layout.
 424     void flushAnyPendingPostLayoutTasks();
 425
 426     virtual bool shouldSuspendScrollAnimations() const override;
 427     virtual void scrollbarStyleChanged(int newStyle, bool forceUpdate) override;
 428
 429     RenderBox* embeddedContentBox() const;
 430
 431     WEBCORE_EXPORT void setTracksRepaints(bool);
 432     bool isTrackingRepaints() const { return m_isTrackingRepaints; }
 433     WEBCORE_EXPORT void resetTrackedRepaints();
 434     const Vector<FloatRect>& trackedRepaintRects() const { return m_trackedRepaintRects; }
 435     String trackedRepaintRectsAsText() const;
 436
 437     typedef HashSet<ScrollableArea*> ScrollableAreaSet;
 438     // Returns whether the scrollable area has just been newly added.
 439     WEBCORE_EXPORT bool addScrollableArea(ScrollableArea*);
 440     // Returns whether the scrollable area has just been removed.
 441     WEBCORE_EXPORT bool removeScrollableArea(ScrollableArea*);
 442     bool containsScrollableArea(ScrollableArea*) const;
 443     const ScrollableAreaSet* scrollableAreas() const { return m_scrollableAreas.get(); }
 444
 445     virtual void removeChild(Widget&) override;
 446
 447     // This function exists for ports that need to handle wheel events manually.
 448     // On Mac WebKit1 the underlying NSScrollView just does the scrolling, but on most other platforms
 449     // we need this function in order to do the scroll ourselves.
 450     bool wheelEvent(const PlatformWheelEvent&);
 451
 452     WEBCORE_EXPORT void setScrollingPerformanceLoggingEnabled(bool);
 453
 454     // Page and FrameView both store a Pagination value. Page::pagination() is set only by API,
 455     // and FrameView::pagination() is set only by CSS. Page::pagination() will affect all
 456     // FrameViews in the page cache, but FrameView::pagination() only affects the current
 457     // FrameView. FrameView::pagination() will return m_pagination if it has been set. Otherwise,
 458     // it will return Page::pagination() since currently there are no callers that need to
 459     // distinguish between the two.
 460     const Pagination& pagination() const;
 461     void setPagination(const Pagination&);
 462
 463     bool inProgrammaticScroll() const override { return m_inProgrammaticScroll; }
 464     void setInProgrammaticScroll(bool programmaticScroll) { m_inProgrammaticScroll = programmaticScroll; }
 465
 466 #if ENABLE(CSS_DEVICE_ADAPTATION)
 467     IntSize initialViewportSize() const { return m_initialViewportSize; }
 468     void setInitialViewportSize(const IntSize& size) { m_initialViewportSize = size; }
 469 #endif
 470
 471     virtual bool isActive() const override;
 472     virtual bool updatesScrollLayerPositionOnMainThread() const override;
 473     virtual bool forceUpdateScrollbarsOnMainThreadForPerformanceTesting() const override;
 474
 475 #if ENABLE(RUBBER_BANDING)
 476     WEBCORE_EXPORT GraphicsLayer* setWantsLayerForTopOverHangArea(bool) const;
 477     WEBCORE_EXPORT GraphicsLayer* setWantsLayerForBottomOverHangArea(bool) const;
 478 #endif
 479
 480     virtual int headerHeight() const override { return m_headerHeight; }
 481     WEBCORE_EXPORT void setHeaderHeight(int);
 482     virtual int footerHeight() const override { return m_footerHeight; }
 483     WEBCORE_EXPORT void setFooterHeight(int);
 484
 485     WEBCORE_EXPORT virtual float topContentInset(TopContentInsetType = TopContentInsetType::WebCoreContentInset) const override;
 486     void topContentInsetDidChange(float newTopContentInset);
 487
 488     WEBCORE_EXPORT virtual void willStartLiveResize() override;
 489     WEBCORE_EXPORT virtual void willEndLiveResize() override;
 490
 491     void addPaintPendingMilestones(LayoutMilestones);
 492     void firePaintRelatedMilestonesIfNeeded();
 493     void fireLayoutRelatedMilestonesIfNeeded();
 494     LayoutMilestones milestonesPendingPaint() const { return m_milestonesPendingPaint; }
 495
 496     bool visualUpdatesAllowedByClient() const { return m_visualUpdatesAllowedByClient; }
 497     WEBCORE_EXPORT void setVisualUpdatesAllowedByClient(bool);
 498
 499     WEBCORE_EXPORT void setScrollPinningBehavior(ScrollPinningBehavior);
 500
 501     ScrollBehaviorForFixedElements scrollBehaviorForFixedElements() const;
 502
 503     void updateWidgetPositions();
 504     void didAddWidgetToRenderTree(Widget&);
 505     void willRemoveWidgetFromRenderTree(Widget&);
 506
 507     void addTrackedRepaintRect(const FloatRect&);
 508
 509     // exposedRect represents WebKit's understanding of what part
 510     // of the view is actually exposed on screen (taking into account
 511     // clipping by other UI elements), whereas visibleContentRect is
 512     // internal to WebCore and doesn't respect those things.
 513     WEBCORE_EXPORT void setExposedRect(FloatRect);
 514     FloatRect exposedRect() const { return m_exposedRect; }
 515
 516 #if ENABLE(CSS_SCROLL_SNAP)
 517     virtual void updateSnapOffsets() override;
 518 #endif
 519
 520     virtual float adjustScrollStepForFixedContent(float step, ScrollbarOrientation, ScrollGranularity) override;
 521
 522     void didChangeScrollOffset();
 523
 524 protected:
 525     virtual bool scrollContentsFastPath(const IntSize& scrollDelta, const IntRect& rectToScroll, const IntRect& clipRect) override;
 526     virtual void scrollContentsSlowPath(const IntRect& updateRect) override;
 527
 528     void repaintSlowRepaintObjects();
 529
 530     virtual bool isVerticalDocument() const override;
 531     virtual bool isFlippedDocument() const override;
 532
 533 private:
 534     explicit FrameView(Frame&);
 535
 536     void reset();
 537     void init();
 538
 539     enum LayoutPhase {
 540         OutsideLayout,
 541         InPreLayout,
 542         InPreLayoutStyleUpdate,
 543         InLayout,
 544         InViewSizeAdjust,
 545         InPostLayout,
 546         InPostLayerPositionsUpdatedAfterLayout,
 547     };
 548     LayoutPhase layoutPhase() const { return m_layoutPhase; }
 549
 550     bool inPreLayoutStyleUpdate() const { return m_layoutPhase == InPreLayoutStyleUpdate; }
 551
 552     virtual bool isFrameView() const override { return true; }
 553
 554     friend class RenderWidget;
 555     bool useSlowRepaints(bool considerOverlap = true) const;
 556     bool useSlowRepaintsIfNotOverlapped() const;
 557     void updateCanBlitOnScrollRecursively();
 558     bool contentsInCompositedLayer() const;
 559     bool shouldLayoutAfterContentsResized() const;
 560
 561     bool shouldUpdateCompositingLayersAfterScrolling() const;
 562
 563     virtual bool shouldDeferScrollUpdateAfterContentSizeChange() override;
 564
 565     virtual void scrollPositionChangedViaPlatformWidgetImpl(const IntPoint& oldPosition, const IntPoint& newPosition) override;
 566
 567     void applyOverflowToViewport(RenderElement*, ScrollbarMode& hMode, ScrollbarMode& vMode);
 568     void applyPaginationToViewport();
 569
 570     void updateOverflowStatus(bool horizontalOverflow, bool verticalOverflow);
 571
 572     WEBCORE_EXPORT void paintControlTints();
 573
 574     void forceLayoutParentViewIfNeeded();
 575     void performPostLayoutTasks();
 576     void autoSizeIfEnabled();
 577     void updateThrottledDOMTimersState();
 578
 579     void updateLayerFlushThrottling();
 580     WEBCORE_EXPORT void adjustTiledBackingCoverage();
 581
 582     virtual void repaintContentRectangle(const IntRect&) override;
 583     virtual void contentsResized() override;
 584     virtual void visibleContentsResized() override;
 585     virtual void addedOrRemovedScrollbar() override;
 586     virtual void fixedLayoutSizeChanged() override;
 587
 588     virtual void delegatesScrollingDidChange() override;
 589
 590     // Override ScrollView methods to do point conversion via renderers, in order to
 591     // take transforms into account.
 592     virtual IntRect convertToContainingView(const IntRect&) const override;
 593     virtual IntRect convertFromContainingView(const IntRect&) const override;
 594     virtual IntPoint convertToContainingView(const IntPoint&) const override;
 595     virtual IntPoint convertFromContainingView(const IntPoint&) const override;
 596
 597     // ScrollableArea interface
 598     virtual void invalidateScrollbarRect(Scrollbar*, const IntRect&) override;
 599     virtual void scrollTo(const IntSize&) override;
 600     virtual void setVisibleScrollerThumbRect(const IntRect&) override;
 601     virtual ScrollableArea* enclosingScrollableArea() const override;
 602     virtual IntRect scrollableAreaBoundingBox() const override;
 603     virtual bool scrollAnimatorEnabled() const override;
 604     virtual GraphicsLayer* layerForScrolling() const override;
 605     virtual GraphicsLayer* layerForHorizontalScrollbar() const override;
 606     virtual GraphicsLayer* layerForVerticalScrollbar() const override;
 607     virtual GraphicsLayer* layerForScrollCorner() const override;
 608 #if ENABLE(RUBBER_BANDING)
 609     virtual GraphicsLayer* layerForOverhangAreas() const override;
 610 #endif
 611
 612     // Override scrollbar notifications to update the AXObject cache.
 613     virtual void didAddScrollbar(Scrollbar*, ScrollbarOrientation) override;
 614     virtual void willRemoveScrollbar(Scrollbar*, ScrollbarOrientation) override;
 615
 616     IntSize sizeForResizeEvent() const;
 617     void sendResizeEventIfNeeded();
 618
 619     void updateScrollableAreaSet();
 620
 621     virtual void notifyPageThatContentAreaWillPaint() const override;
 622
 623     void enableSpeculativeTilingIfNeeded();
 624     void speculativeTilingEnableTimerFired();
 625
 626     void updateEmbeddedObjectsTimerFired();
 627     bool updateEmbeddedObjects();
 628     void updateEmbeddedObject(RenderEmbeddedObject&);
 629     void scrollToAnchor();
 630     void scrollPositionChanged(const IntPoint& oldPosition, const IntPoint& newPosition);
 631     void scrollableAreaSetChanged();
 632     void sendScrollEvent();
 633
 634     bool hasCustomScrollbars() const;
 635
 636     virtual void updateScrollCorner() override;
 637
 638     FrameView* parentFrameView() const;
 639
 640     void startLayoutAtMainFrameViewIfNeeded(bool allowSubtree);
 641     bool frameFlatteningEnabled() const;
 642     bool isFrameFlatteningValidForThisFrame() const;
 643
 644     bool qualifiesAsVisuallyNonEmpty() const;
 645
 646     AXObjectCache* axObjectCache() const;
 647     void notifyWidgetsInAllFrames(WidgetNotification);
 648     void removeFromAXObjectCache();
 649     void notifyWidgets(WidgetNotification);
 650
 651     HashSet<Widget*> m_widgetsInRenderTree;
 652
 653     static double sCurrentPaintTimeStamp; // used for detecting decoded resource thrash in the cache
 654
 655     LayoutSize m_size;
 656     LayoutSize m_margins;
 657
 658     std::unique_ptr<ListHashSet<RenderEmbeddedObject*>> m_embeddedObjectsToUpdate;
 659     const RefPtr<Frame> m_frame;
 660
 661     std::unique_ptr<HashSet<RenderElement*>> m_slowRepaintObjects;
 662
 663     bool m_needsFullRepaint;
 664
 665     bool m_canHaveScrollbars;
 666     bool m_cannotBlitToWindow;
 667     bool m_isOverlapped;
 668     bool m_contentIsOpaque;
 669
 670     Timer m_layoutTimer;
 671     bool m_delayedLayout;
 672     RenderElement* m_layoutRoot;
 673
 674     LayoutPhase m_layoutPhase;
 675     bool m_layoutSchedulingEnabled;
 676     bool m_inSynchronousPostLayout;
 677     int m_layoutCount;
 678     unsigned m_nestedLayoutCount;
 679     Timer m_postLayoutTasksTimer;
 680     Timer m_updateEmbeddedObjectsTimer;
 681     bool m_firstLayoutCallbackPending;
 682
 683     bool m_firstLayout;
 684     bool m_isTransparent;
 685     Color m_baseBackgroundColor;
 686     IntSize m_lastViewportSize;
 687     float m_lastZoomFactor;
 688
 689     String m_mediaType;
 690     String m_mediaTypeWhenNotPrinting;
 691
 692     bool m_overflowStatusDirty;
 693     bool m_horizontalOverflow;
 694     bool m_verticalOverflow;
 695     RenderElement* m_viewportRenderer;
 696
 697     Pagination m_pagination;
 698
 699     bool m_wasScrolledByUser;
 700     bool m_inProgrammaticScroll;
 701     bool m_safeToPropagateScrollToParent;
 702     Timer m_delayedScrollEventTimer;
 703
 704     double m_lastPaintTime;
 705
 706     bool m_isTrackingRepaints; // Used for testing.
 707     Vector<FloatRect> m_trackedRepaintRects;
 708
 709     bool m_shouldUpdateWhileOffscreen;
 710
 711     FloatRect m_exposedRect;
 712
 713     unsigned m_deferSetNeedsLayoutCount;
 714     bool m_setNeedsLayoutWasDeferred;
 715
 716     RefPtr<Node> m_nodeToDraw;
 717     PaintBehavior m_paintBehavior;
 718     bool m_isPainting;
 719
 720     unsigned m_visuallyNonEmptyCharacterCount;
 721     unsigned m_visuallyNonEmptyPixelCount;
 722     bool m_isVisuallyNonEmpty;
 723     bool m_firstVisuallyNonEmptyLayoutCallbackPending;
 724
 725     RefPtr<ContainerNode> m_maintainScrollPositionAnchor;
 726
 727     // Renderer to hold our custom scroll corner.
 728     RenderPtr<RenderScrollbarPart> m_scrollCorner;
 729
 730     bool m_speculativeTilingEnabled;
 731     Timer m_speculativeTilingEnableTimer;
 732
 733 #if PLATFORM(IOS)
 734     bool m_useCustomFixedPositionLayoutRect;
 735     IntRect m_customFixedPositionLayoutRect;
 736
 737     bool m_useCustomSizeForResizeEvent;
 738     IntSize m_customSizeForResizeEvent;
 739
 740     double m_horizontalVelocity;
 741     double m_verticalVelocity;
 742     double m_scaleChangeRate;
 743     double m_lastVelocityUpdateTime;
 744 #endif
 745
 746     IntSize m_overrideViewportSize;
 747     bool m_hasOverrideViewportSize;
 748
 749     // If true, automatically resize the frame view around its content.
 750     bool m_shouldAutoSize;
 751     bool m_inAutoSize;
 752     // True if autosize has been run since m_shouldAutoSize was set.
 753     bool m_didRunAutosize;
 754     // The lower bound on the size when autosizing.
 755     IntSize m_minAutoSize;
 756     // The upper bound on the size when autosizing.
 757     IntSize m_maxAutoSize;
 758     // The fixed height to resize the view to after autosizing is complete.
 759     int m_autoSizeFixedMinimumHeight;
 760     // The intrinsic content size decided by autosizing.
 761     IntSize m_autoSizeContentSize;
 762
 763     std::unique_ptr<ScrollableAreaSet> m_scrollableAreas;
 764     std::unique_ptr<ViewportConstrainedObjectSet> m_viewportConstrainedObjects;
 765
 766     HashSet<DOMTimer*> m_throttledTimers;
 767
 768     int m_headerHeight;
 769     int m_footerHeight;
 770
 771     LayoutMilestones m_milestonesPendingPaint;
 772
 773     static const unsigned visualCharacterThreshold = 200;
 774     static const unsigned visualPixelThreshold = 32 * 32;
 775
 776 #if ENABLE(CSS_DEVICE_ADAPTATION)
 777     // Size of viewport before any UA or author styles have overridden
 778     // the viewport given by the window or viewing area of the UA.
 779     IntSize m_initialViewportSize;
 780 #endif
 781
 782     bool m_visualUpdatesAllowedByClient;
 783
 784     ScrollPinningBehavior m_scrollPinningBehavior;
 785 };
 786
 787 inline void FrameView::incrementVisuallyNonEmptyCharacterCount(unsigned count)
 788 {
 789     if (m_isVisuallyNonEmpty)
 790         return;
 791     m_visuallyNonEmptyCharacterCount += count;
 792     if (m_visuallyNonEmptyCharacterCount <= visualCharacterThreshold)
 793         return;
 794     updateIsVisuallyNonEmpty();
 795 }
 796
 797 inline void FrameView::incrementVisuallyNonEmptyPixelCount(const IntSize& size)
 798 {
 799     if (m_isVisuallyNonEmpty)
 800         return;
 801     m_visuallyNonEmptyPixelCount += size.width() * size.height();
 802     if (m_visuallyNonEmptyPixelCount <= visualPixelThreshold)
 803         return;
 804     updateIsVisuallyNonEmpty();
 805 }
 806
 807 } // namespace WebCore
 808
 809 SPECIALIZE_TYPE_TRAITS_WIDGET(FrameView, isFrameView())
 810
 811 #endif // FrameView_h