[LayoutState cleanup] LayoutContext should own the stack of LayoutState objects
[WebKit-https.git] / Source / WebCore / rendering / LayoutState.h
1 /*
2  * Copyright (C) 2007, 2013 Apple Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #pragma once
27
28 #include "LayoutContext.h"
29 #include "LayoutRect.h"
30 #include <wtf/Noncopyable.h>
31
32 namespace WebCore {
33
34 class LayoutContext;
35 class RenderBlockFlow;
36 class RenderBox;
37 class RenderElement;
38 class RenderFragmentedFlow;
39 class RenderObject;
40
41 class LayoutState {
42     WTF_MAKE_NONCOPYABLE(LayoutState); WTF_MAKE_FAST_ALLOCATED;
43
44 public:
45     LayoutState()
46         : m_clipped(false)
47         , m_isPaginated(false)
48         , m_pageLogicalHeightChanged(false)
49 #if !ASSERT_DISABLED
50         , m_layoutDeltaXSaturated(false)
51         , m_layoutDeltaYSaturated(false)
52 #endif
53     {
54     }
55     LayoutState(const LayoutContext::LayoutStateStack&, RenderBox&, const LayoutSize& offset, LayoutUnit pageHeight, bool pageHeightChanged);
56     explicit LayoutState(RenderElement&);
57
58     bool isPaginated() const { return m_isPaginated; }
59     void setIsPaginated() { m_isPaginated = true; }
60
61     // The page logical offset is the object's offset from the top of the page in the page progression
62     // direction (so an x-offset in vertical text and a y-offset for horizontal text).
63     LayoutUnit pageLogicalOffset(RenderBox*, LayoutUnit childLogicalOffset) const;
64     
65     void setPageLogicalHeight(LayoutUnit logicalHeight) { m_pageLogicalHeight = logicalHeight; }
66     LayoutUnit pageLogicalHeight() const { return m_pageLogicalHeight; }
67     bool pageLogicalHeightChanged() const { return m_pageLogicalHeightChanged; }
68
69     RenderBlockFlow* lineGrid() const { return m_lineGrid; }
70     LayoutSize lineGridOffset() const { return m_lineGridOffset; }
71     LayoutSize lineGridPaginationOrigin() const { return m_lineGridPaginationOrigin; }
72
73     LayoutSize paintOffset() const { return m_paintOffset; }
74     LayoutSize layoutOffset() const { return m_layoutOffset; }
75
76     LayoutSize pageOffset() const { return m_pageOffset; }
77     void setLineGridPaginationOrigin(const LayoutSize& origin) { m_lineGridPaginationOrigin = origin; }
78     
79     bool needsBlockDirectionLocationSetBeforeLayout() const { return m_lineGrid || (m_isPaginated && m_pageLogicalHeight); }
80
81     RenderFragmentedFlow* currentRenderFragmentedFlow() const { return m_currentRenderFragmentedFlow; }
82     void setCurrentRenderFragmentedFlow(RenderFragmentedFlow* fragmentedFlow) { m_currentRenderFragmentedFlow = fragmentedFlow; }
83 #ifndef NDEBUG
84     RenderElement* renderer() const { return m_renderer; }
85 #endif
86     LayoutRect clipRect() const { return m_clipRect; }
87     bool isClipped() const { return m_clipped; }
88
89     void addLayoutDelta(LayoutSize);
90     LayoutSize layoutDelta() const { return m_layoutDelta; }
91 #if !ASSERT_DISABLED
92     bool layoutDeltaMatches(LayoutSize);
93 #endif
94
95 private:
96     void computeOffsets(const LayoutState& ancestor, RenderBox&, LayoutSize offset);
97     void computeClipRect(const LayoutState& ancestor, RenderBox&);
98     void computePaginationInformation(const LayoutContext::LayoutStateStack&, RenderBox&, LayoutUnit pageLogicalHeight, bool pageLogicalHeightChanged);
99     void propagateLineGridInfo(const LayoutState& ancestor, RenderBox&);
100     void establishLineGrid(const LayoutContext::LayoutStateStack&, RenderBlockFlow&);
101
102     // Do not add anything apart from bitfields. See https://bugs.webkit.org/show_bug.cgi?id=100173
103     bool m_clipped : 1;
104     bool m_isPaginated : 1;
105     // If our page height has changed, this will force all blocks to relayout.
106     bool m_pageLogicalHeightChanged : 1;
107 #if !ASSERT_DISABLED
108     bool m_layoutDeltaXSaturated : 1;
109     bool m_layoutDeltaYSaturated : 1;
110 #endif
111     // The current line grid that we're snapping to and the offset of the start of the grid.
112     RenderBlockFlow* m_lineGrid { nullptr };
113
114     // FIXME: Distinguish between the layout clip rect and the paint clip rect which may be larger,
115     // e.g., because of composited scrolling.
116     LayoutRect m_clipRect;
117     
118     // x/y offset from layout root. Includes in-flow positioning and scroll offsets.
119     LayoutSize m_paintOffset;
120     // x/y offset from layout root. Does not include in-flow positioning or scroll offsets.
121     LayoutSize m_layoutOffset;
122     // Transient offset from the final position of the object
123     // used to ensure that repaints happen in the correct place.
124     // This is a total delta accumulated from the root. 
125     LayoutSize m_layoutDelta;
126
127     // The current page height for the pagination model that encloses us.
128     LayoutUnit m_pageLogicalHeight;
129     // The offset of the start of the first page in the nearest enclosing pagination model.
130     LayoutSize m_pageOffset;
131     LayoutSize m_lineGridOffset;
132     LayoutSize m_lineGridPaginationOrigin;
133
134     RenderFragmentedFlow* m_currentRenderFragmentedFlow { nullptr };
135 #ifndef NDEBUG
136     RenderElement* m_renderer { nullptr };
137 #endif
138 };
139
140 // Stack-based class to assist with LayoutState push/pop
141 class LayoutStateMaintainer {
142     WTF_MAKE_NONCOPYABLE(LayoutStateMaintainer);
143 public:
144     // Constructor to push now.
145     explicit LayoutStateMaintainer(RenderBox&, LayoutSize offset, bool disableState = false, LayoutUnit pageHeight = 0, bool pageHeightChanged = false);
146     // Constructor to maybe push later.
147     explicit LayoutStateMaintainer(LayoutContext&);
148     ~LayoutStateMaintainer();
149
150     void push(RenderBox& root, LayoutSize offset, LayoutUnit pageHeight = 0, bool pageHeightChanged = false);
151     void pop();
152     bool didPush() const { return m_didCallPush; }
153
154 private:
155     LayoutContext& m_layoutContext;
156     bool m_paintOffsetCacheIsDisabled { false };
157     bool m_didCallPush { false };
158     bool m_didCallPop { false };
159     bool m_didPushLayoutState { false };
160 };
161
162 class SubtreeLayoutStateMaintainer {
163 public:
164     SubtreeLayoutStateMaintainer(RenderElement* subtreeLayoutRoot);
165     ~SubtreeLayoutStateMaintainer();
166
167 private:
168     RenderElement* m_subtreeLayoutRoot { nullptr };
169     bool m_didDisablePaintOffsetCache { false };
170 };
171
172 class LayoutStateDisabler {
173     WTF_MAKE_NONCOPYABLE(LayoutStateDisabler);
174 public:
175     LayoutStateDisabler(LayoutContext&);
176     ~LayoutStateDisabler();
177
178 private:
179     LayoutContext& m_layoutContext;
180 };
181
182 class PaginatedLayoutStateMaintainer {
183 public:
184     PaginatedLayoutStateMaintainer(RenderBlockFlow&);
185     ~PaginatedLayoutStateMaintainer();
186
187 private:
188     RenderBlockFlow& m_flow;
189     bool m_pushed { false };
190 };
191
192 } // namespace WebCore