Source/WebCore/rendering/RenderView.h

   1 /*
   2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
   3  * Copyright (C) 2006, 2015 Apple Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public License
  16  * along with this library; see the file COPYING.LIB.  If not, write to
  17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18  * Boston, MA 02110-1301, USA.
  19  *
  20  */
  21
  22 #ifndef RenderView_h
  23 #define RenderView_h
  24
  25 #include "FrameView.h"
  26 #include "LayoutState.h"
  27 #include "Region.h"
  28 #include "RenderBlockFlow.h"
  29 #include "RenderWidget.h"
  30 #include "SelectionSubtreeRoot.h"
  31 #include <memory>
  32 #include <wtf/HashSet.h>
  33
  34 #if ENABLE(SERVICE_CONTROLS)
  35 #include "SelectionRectGatherer.h"
  36 #endif
  37
  38 namespace WebCore {
  39
  40 class FlowThreadController;
  41 class ImageQualityController;
  42 class RenderLayerCompositor;
  43 class RenderQuote;
  44
  45 class RenderView final : public RenderBlockFlow, public SelectionSubtreeRoot {
  46 public:
  47     RenderView(Document&, Ref<RenderStyle>&&);
  48     virtual ~RenderView();
  49
  50     WEBCORE_EXPORT bool hitTest(const HitTestRequest&, HitTestResult&);
  51     bool hitTest(const HitTestRequest&, const HitTestLocation&, HitTestResult&);
  52
  53     virtual const char* renderName() const override { return "RenderView"; }
  54
  55     virtual bool requiresLayer() const override { return true; }
  56
  57     virtual bool isChildAllowed(const RenderObject&, const RenderStyle&) const override;
  58
  59     virtual void layout() override;
  60     virtual void updateLogicalWidth() override;
  61     virtual void computeLogicalHeight(LayoutUnit logicalHeight, LayoutUnit logicalTop, LogicalExtentComputedValues&) const override;
  62
  63     virtual LayoutUnit availableLogicalHeight(AvailableLogicalHeightType) const override;
  64
  65     // The same as the FrameView's layoutHeight/layoutWidth but with null check guards.
  66     int viewHeight() const;
  67     int viewWidth() const;
  68     int viewLogicalWidth() const { return style().isHorizontalWritingMode() ? viewWidth() : viewHeight(); }
  69     int viewLogicalHeight() const;
  70
  71     LayoutUnit clientLogicalWidthForFixedPosition() const;
  72     LayoutUnit clientLogicalHeightForFixedPosition() const;
  73
  74     float zoomFactor() const;
  75
  76     FrameView& frameView() const { return m_frameView; }
  77
  78     virtual LayoutRect visualOverflowRect() const override;
  79     virtual void computeRectForRepaint(const RenderLayerModelObject* repaintContainer, LayoutRect&, bool fixed = false) const override;
  80     void repaintRootContents();
  81     void repaintViewRectangle(const LayoutRect&) const;
  82     void repaintViewAndCompositedLayers();
  83
  84     virtual void paint(PaintInfo&, const LayoutPoint&) override;
  85     virtual void paintBoxDecorations(PaintInfo&, const LayoutPoint&) override;
  86
  87     enum SelectionRepaintMode { RepaintNewXOROld, RepaintNewMinusOld, RepaintNothing };
  88     void setSelection(RenderObject* start, int startPos, RenderObject* end, int endPos, SelectionRepaintMode = RepaintNewXOROld);
  89     void getSelection(RenderObject*& startRenderer, int& startOffset, RenderObject*& endRenderer, int& endOffset) const;
  90     void clearSelection();
  91     RenderObject* selectionUnsplitStart() const { return m_selectionUnsplitStart; }
  92     RenderObject* selectionUnsplitEnd() const { return m_selectionUnsplitEnd; }
  93     IntRect selectionBounds(bool clipToVisibleContent = true) const;
  94     void repaintSelection() const;
  95
  96     bool printing() const;
  97
  98     virtual void absoluteRects(Vector<IntRect>&, const LayoutPoint& accumulatedOffset) const override;
  99     virtual void absoluteQuads(Vector<FloatQuad>&, bool* wasFixed) const override;
 100
 101     void setMaximalOutlineSize(int o);
 102     int maximalOutlineSize() const { return m_maximalOutlineSize; }
 103
 104     LayoutRect viewRect() const;
 105
 106     // layoutDelta is used transiently during layout to store how far an object has moved from its
 107     // last layout location, in order to repaint correctly.
 108     // If we're doing a full repaint m_layoutState will be 0, but in that case layoutDelta doesn't matter.
 109     LayoutSize layoutDelta() const
 110     {
 111         return m_layoutState ? m_layoutState->m_layoutDelta : LayoutSize();
 112     }
 113     void addLayoutDelta(const LayoutSize& delta)
 114     {
 115         if (m_layoutState) {
 116             m_layoutState->m_layoutDelta += delta;
 117 #if !ASSERT_DISABLED && ENABLE(SATURATED_LAYOUT_ARITHMETIC)
 118             m_layoutState->m_layoutDeltaXSaturated |= m_layoutState->m_layoutDelta.width() == LayoutUnit::max() || m_layoutState->m_layoutDelta.width() == LayoutUnit::min();
 119             m_layoutState->m_layoutDeltaYSaturated |= m_layoutState->m_layoutDelta.height() == LayoutUnit::max() || m_layoutState->m_layoutDelta.height() == LayoutUnit::min();
 120 #endif
 121         }
 122     }
 123
 124 #if !ASSERT_DISABLED
 125     bool layoutDeltaMatches(const LayoutSize& delta)
 126     {
 127         if (!m_layoutState)
 128             return false;
 129 #if ENABLE(SATURATED_LAYOUT_ARITHMETIC)
 130         return (delta.width() == m_layoutState->m_layoutDelta.width() || m_layoutState->m_layoutDeltaXSaturated) && (delta.height() == m_layoutState->m_layoutDelta.height() || m_layoutState->m_layoutDeltaYSaturated);
 131 #else
 132         return delta == m_layoutState->m_layoutDelta;
 133 #endif
 134     }
 135 #endif
 136
 137     bool doingFullRepaint() const { return frameView().needsFullRepaint(); }
 138
 139     // Subtree push/pop
 140     void pushLayoutState(RenderObject&);
 141     void popLayoutState(RenderObject&) { return popLayoutState(); } // Just doing this to keep popLayoutState() private and to make the subtree calls symmetrical.
 142
 143     bool shouldDisableLayoutStateForSubtree(RenderObject*) const;
 144
 145     // Returns true if layoutState should be used for its cached offset and clip.
 146     bool layoutStateEnabled() const { return m_layoutStateDisableCount == 0 && m_layoutState; }
 147     LayoutState* layoutState() const { return m_layoutState.get(); }
 148
 149     virtual void updateHitTestResult(HitTestResult&, const LayoutPoint&) override;
 150
 151     LayoutUnit pageLogicalHeight() const { return m_pageLogicalHeight; }
 152     void setPageLogicalHeight(LayoutUnit height)
 153     {
 154         if (m_pageLogicalHeight != height) {
 155             m_pageLogicalHeight = height;
 156             m_pageLogicalHeightChanged = true;
 157         }
 158     }
 159     LayoutUnit pageOrViewLogicalHeight() const;
 160
 161     // This method is used to assign a page number only when pagination modes have
 162     // a block progression. This happens with vertical-rl books for example, but it
 163     // doesn't happen for normal horizontal-tb books. This is a very specialized
 164     // function and should not be mistaken for a general page number API.
 165     unsigned pageNumberForBlockProgressionOffset(int offset) const;
 166
 167     unsigned pageCount() const;
 168
 169     // FIXME: These functions are deprecated. No code should be added that uses these.
 170     int bestTruncatedAt() const { return m_legacyPrinting.m_bestTruncatedAt; }
 171     void setBestTruncatedAt(int y, RenderBoxModelObject* forRenderer, bool forcedBreak = false);
 172     int truncatedAt() const { return m_legacyPrinting.m_truncatedAt; }
 173     void setTruncatedAt(int y)
 174     {
 175         m_legacyPrinting.m_truncatedAt = y;
 176         m_legacyPrinting.m_bestTruncatedAt = 0;
 177         m_legacyPrinting.m_truncatorWidth = 0;
 178         m_legacyPrinting.m_forcedPageBreak = false;
 179     }
 180     const IntRect& printRect() const { return m_legacyPrinting.m_printRect; }
 181     void setPrintRect(const IntRect& r) { m_legacyPrinting.m_printRect = r; }
 182     // End deprecated functions.
 183
 184     // Notification that this view moved into or out of a native window.
 185     void setIsInWindow(bool);
 186
 187     WEBCORE_EXPORT RenderLayerCompositor& compositor();
 188     WEBCORE_EXPORT bool usesCompositing() const;
 189
 190     WEBCORE_EXPORT IntRect unscaledDocumentRect() const;
 191     LayoutRect unextendedBackgroundRect(RenderBox* backgroundRenderer) const;
 192     LayoutRect backgroundRect(RenderBox* backgroundRenderer) const;
 193
 194     WEBCORE_EXPORT IntRect documentRect() const;
 195
 196     // Renderer that paints the root background has background-images which all have background-attachment: fixed.
 197     bool rootBackgroundIsEntirelyFixed() const;
 198
 199     bool hasRenderNamedFlowThreads() const;
 200     bool checkTwoPassLayoutForAutoHeightRegions() const;
 201     FlowThreadController& flowThreadController();
 202
 203     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
 204
 205     IntSize viewportSizeForCSSViewportUnits() const;
 206
 207     void setRenderQuoteHead(RenderQuote* head) { m_renderQuoteHead = head; }
 208     RenderQuote* renderQuoteHead() const { return m_renderQuoteHead; }
 209
 210     // FIXME: This is a work around because the current implementation of counters
 211     // requires walking the entire tree repeatedly and most pages don't actually use either
 212     // feature so we shouldn't take the performance hit when not needed. Long term we should
 213     // rewrite the counter and quotes code.
 214     void addRenderCounter() { m_renderCounterCount++; }
 215     void removeRenderCounter() { ASSERT(m_renderCounterCount > 0); m_renderCounterCount--; }
 216     bool hasRenderCounters() { return m_renderCounterCount; }
 217
 218     ImageQualityController& imageQualityController();
 219
 220     void setHasSoftwareFilters(bool hasSoftwareFilters) { m_hasSoftwareFilters = hasSoftwareFilters; }
 221     bool hasSoftwareFilters() const { return m_hasSoftwareFilters; }
 222
 223     uint64_t rendererCount() const { return m_rendererCount; }
 224     void didCreateRenderer() { ++m_rendererCount; }
 225     void didDestroyRenderer() { --m_rendererCount; }
 226
 227     void resumePausedImageAnimationsIfNeeded(IntRect visibleRect);
 228     void addRendererWithPausedImageAnimations(RenderElement&);
 229     void removeRendererWithPausedImageAnimations(RenderElement&);
 230
 231     class RepaintRegionAccumulator {
 232         WTF_MAKE_NONCOPYABLE(RepaintRegionAccumulator);
 233     public:
 234         RepaintRegionAccumulator(RenderView*);
 235         ~RepaintRegionAccumulator();
 236
 237     private:
 238         RenderView* m_rootView;
 239         bool m_wasAccumulatingRepaintRegion;
 240     };
 241
 242     void scheduleLazyRepaint(RenderBox&);
 243     void unscheduleLazyRepaint(RenderBox&);
 244
 245     void protectRenderWidgetUntilLayoutIsDone(RenderWidget& widget) { m_protectedRenderWidgets.append(&widget); }
 246     void releaseProtectedRenderWidgets() { m_protectedRenderWidgets.clear(); }
 247
 248 #if ENABLE(CSS_SCROLL_SNAP)
 249     void registerBoxWithScrollSnapCoordinates(const RenderBox&);
 250     void unregisterBoxWithScrollSnapCoordinates(const RenderBox&);
 251     const HashSet<const RenderBox*>& boxesWithScrollSnapCoordinates() { return m_boxesWithScrollSnapCoordinates; }
 252 #endif
 253
 254 protected:
 255     virtual void mapLocalToContainer(const RenderLayerModelObject* repaintContainer, TransformState&, MapCoordinatesFlags, bool* wasFixed) const override;
 256     virtual const RenderObject* pushMappingToContainer(const RenderLayerModelObject* ancestorToStopAt, RenderGeometryMap&) const override;
 257     virtual void mapAbsoluteToLocalPoint(MapCoordinatesFlags, TransformState&) const override;
 258     virtual bool requiresColumns(int desiredColumnCount) const override;
 259
 260 private:
 261     void initializeLayoutState(LayoutState&);
 262
 263     virtual void computeColumnCountAndWidth() override;
 264
 265     bool shouldRepaint(const LayoutRect&) const;
 266     void flushAccumulatedRepaintRegion() const;
 267
 268     // These functions may only be accessed by LayoutStateMaintainer.
 269     bool pushLayoutState(RenderBox& renderer, const LayoutSize& offset, LayoutUnit pageHeight = 0, bool pageHeightChanged = false)
 270     {
 271         // We push LayoutState even if layoutState is disabled because it stores layoutDelta too.
 272         if (!doingFullRepaint() || m_layoutState->isPaginated() || renderer.flowThreadContainingBlock()
 273             || m_layoutState->lineGrid() || (renderer.style().lineGrid() != RenderStyle::initialLineGrid() && renderer.isRenderBlockFlow())) {
 274             m_layoutState = std::make_unique<LayoutState>(WTF::move(m_layoutState), &renderer, offset, pageHeight, pageHeightChanged);
 275             pushLayoutStateForCurrentFlowThread(renderer);
 276             return true;
 277         }
 278         return false;
 279     }
 280
 281     void popLayoutState()
 282     {
 283         popLayoutStateForCurrentFlowThread();
 284         m_layoutState = WTF::move(m_layoutState->m_next);
 285     }
 286
 287     // Suspends the LayoutState optimization. Used under transforms that cannot be represented by
 288     // LayoutState (common in SVG) and when manipulating the render tree during layout in ways
 289     // that can trigger repaint of a non-child (e.g. when a list item moves its list marker around).
 290     // Note that even when disabled, LayoutState is still used to store layoutDelta.
 291     // These functions may only be accessed by LayoutStateMaintainer or LayoutStateDisabler.
 292     void disableLayoutState() { m_layoutStateDisableCount++; }
 293     void enableLayoutState() { ASSERT(m_layoutStateDisableCount > 0); m_layoutStateDisableCount--; }
 294
 295     void layoutContent(const LayoutState&);
 296     void layoutContentInAutoLogicalHeightRegions(const LayoutState&);
 297     void layoutContentToComputeOverflowInRegions(const LayoutState&);
 298 #ifndef NDEBUG
 299     void checkLayoutState(const LayoutState&);
 300 #endif
 301
 302     void pushLayoutStateForCurrentFlowThread(const RenderObject&);
 303     void popLayoutStateForCurrentFlowThread();
 304
 305     friend class LayoutStateMaintainer;
 306     friend class LayoutStateDisabler;
 307
 308     virtual bool isScrollableOrRubberbandableBox() const override;
 309
 310     void splitSelectionBetweenSubtrees(const RenderObject* startRenderer, int startPos, const RenderObject* endRenderer, int endPos, SelectionRepaintMode blockRepaintMode);
 311     void clearSubtreeSelection(const SelectionSubtreeRoot&, SelectionRepaintMode, OldSelectionData&) const;
 312     void updateSelectionForSubtrees(RenderSubtreesMap&, SelectionRepaintMode);
 313     void applySubtreeSelection(const SelectionSubtreeRoot&, SelectionRepaintMode, const OldSelectionData&);
 314     LayoutRect subtreeSelectionBounds(const SelectionSubtreeRoot&, bool clipToVisibleContent = true) const;
 315     void repaintSubtreeSelection(const SelectionSubtreeRoot&) const;
 316
 317 private:
 318     FrameView& m_frameView;
 319
 320     RenderObject* m_selectionUnsplitStart;
 321     RenderObject* m_selectionUnsplitEnd;
 322     int m_selectionUnsplitStartPos;
 323     int m_selectionUnsplitEndPos;
 324
 325     uint64_t m_rendererCount;
 326
 327     mutable std::unique_ptr<Region> m_accumulatedRepaintRegion;
 328
 329     // FIXME: Only used by embedded WebViews inside AppKit NSViews.  Find a way to remove.
 330     struct LegacyPrinting {
 331         LegacyPrinting()
 332             : m_bestTruncatedAt(0)
 333             , m_truncatedAt(0)
 334             , m_truncatorWidth(0)
 335             , m_forcedPageBreak(false)
 336         { }
 337
 338         int m_bestTruncatedAt;
 339         int m_truncatedAt;
 340         int m_truncatorWidth;
 341         IntRect m_printRect;
 342         bool m_forcedPageBreak;
 343     };
 344     LegacyPrinting m_legacyPrinting;
 345     // End deprecated members.
 346
 347     int m_maximalOutlineSize; // Used to apply a fudge factor to dirty-rect checks on blocks/tables.
 348
 349     bool shouldUsePrintingLayout() const;
 350
 351     void lazyRepaintTimerFired();
 352
 353     Timer m_lazyRepaintTimer;
 354     HashSet<RenderBox*> m_renderersNeedingLazyRepaint;
 355
 356     std::unique_ptr<ImageQualityController> m_imageQualityController;
 357     LayoutUnit m_pageLogicalHeight;
 358     bool m_pageLogicalHeightChanged;
 359     std::unique_ptr<LayoutState> m_layoutState;
 360     unsigned m_layoutStateDisableCount;
 361     std::unique_ptr<RenderLayerCompositor> m_compositor;
 362     std::unique_ptr<FlowThreadController> m_flowThreadController;
 363
 364     RenderQuote* m_renderQuoteHead;
 365     unsigned m_renderCounterCount;
 366
 367     bool m_selectionWasCaret;
 368     bool m_hasSoftwareFilters;
 369
 370     HashSet<RenderElement*> m_renderersWithPausedImageAnimation;
 371     Vector<RefPtr<RenderWidget>> m_protectedRenderWidgets;
 372
 373 #if ENABLE(SERVICE_CONTROLS)
 374     SelectionRectGatherer m_selectionRectGatherer;
 375 #endif
 376 #if ENABLE(CSS_SCROLL_SNAP)
 377     HashSet<const RenderBox*> m_boxesWithScrollSnapCoordinates;
 378 #endif
 379 };
 380
 381 // Stack-based class to assist with LayoutState push/pop
 382 class LayoutStateMaintainer {
 383     WTF_MAKE_NONCOPYABLE(LayoutStateMaintainer);
 384 public:
 385     // Constructor to push now.
 386     explicit LayoutStateMaintainer(RenderView& view, RenderBox& root, LayoutSize offset, bool disableState = false, LayoutUnit pageHeight = 0, bool pageHeightChanged = false)
 387         : m_view(view)
 388         , m_disabled(disableState)
 389         , m_didStart(false)
 390         , m_didEnd(false)
 391         , m_didCreateLayoutState(false)
 392     {
 393         push(root, offset, pageHeight, pageHeightChanged);
 394     }
 395
 396     // Constructor to maybe push later.
 397     explicit LayoutStateMaintainer(RenderView& view)
 398         : m_view(view)
 399         , m_disabled(false)
 400         , m_didStart(false)
 401         , m_didEnd(false)
 402         , m_didCreateLayoutState(false)
 403     {
 404     }
 405
 406     ~LayoutStateMaintainer()
 407     {
 408         ASSERT(m_didStart == m_didEnd);   // if this fires, it means that someone did a push(), but forgot to pop().
 409     }
 410
 411     void push(RenderBox& root, LayoutSize offset, LayoutUnit pageHeight = 0, bool pageHeightChanged = false)
 412     {
 413         ASSERT(!m_didStart);
 414         // We push state even if disabled, because we still need to store layoutDelta
 415         m_didCreateLayoutState = m_view.pushLayoutState(root, offset, pageHeight, pageHeightChanged);
 416         if (m_disabled && m_didCreateLayoutState)
 417             m_view.disableLayoutState();
 418         m_didStart = true;
 419     }
 420
 421     void pop()
 422     {
 423         if (m_didStart) {
 424             ASSERT(!m_didEnd);
 425             if (m_didCreateLayoutState) {
 426                 m_view.popLayoutState();
 427                 if (m_disabled)
 428                     m_view.enableLayoutState();
 429             }
 430
 431             m_didEnd = true;
 432         }
 433     }
 434
 435     bool didPush() const { return m_didStart; }
 436
 437 private:
 438     RenderView& m_view;
 439     bool m_disabled : 1;        // true if the offset and clip part of layoutState is disabled
 440     bool m_didStart : 1;        // true if we did a push or disable
 441     bool m_didEnd : 1;          // true if we popped or re-enabled
 442     bool m_didCreateLayoutState : 1; // true if we actually made a layout state.
 443 };
 444
 445 class LayoutStateDisabler {
 446     WTF_MAKE_NONCOPYABLE(LayoutStateDisabler);
 447 public:
 448     LayoutStateDisabler(RenderView* view)
 449         : m_view(view)
 450     {
 451         if (m_view)
 452             m_view->disableLayoutState();
 453     }
 454
 455     ~LayoutStateDisabler()
 456     {
 457         if (m_view)
 458             m_view->enableLayoutState();
 459     }
 460 private:
 461     RenderView* m_view;
 462 };
 463
 464 } // namespace WebCore
 465
 466 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderView, isRenderView())
 467
 468 #endif // RenderView_h