0fe4fec4f92b65fa1d569e2fe644188cbfdc2feb
[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 #ifndef LayoutState_h
27 #define LayoutState_h
28
29 #include "LayoutRect.h"
30 #include <wtf/HashMap.h>
31 #include <wtf/Noncopyable.h>
32
33 namespace WebCore {
34
35 class RenderBlock;
36 class RenderBlockFlow;
37 class RenderBox;
38 class RenderElement;
39 class RenderFlowThread;
40 class RenderObject;
41 class ShapeInsideInfo;
42
43 class LayoutState {
44     WTF_MAKE_NONCOPYABLE(LayoutState); WTF_MAKE_FAST_ALLOCATED;
45
46 public:
47     LayoutState()
48         : m_clipped(false)
49         , m_isPaginated(false)
50         , m_pageLogicalHeightChanged(false)
51 #if !ASSERT_DISABLED && ENABLE(SATURATED_LAYOUT_ARITHMETIC)
52         , m_layoutDeltaXSaturated(false)
53         , m_layoutDeltaYSaturated(false)
54 #endif
55     {
56     }
57
58     LayoutState(std::unique_ptr<LayoutState>, RenderBox*, const LayoutSize& offset, LayoutUnit pageHeight, bool pageHeightChanged);
59     explicit LayoutState(RenderObject&);
60
61     void clearPaginationInformation();
62     bool isPaginated() const { return m_isPaginated; }
63     
64     // The page logical offset is the object's offset from the top of the page in the page progression
65     // direction (so an x-offset in vertical text and a y-offset for horizontal text).
66     LayoutUnit pageLogicalOffset(RenderBox*, LayoutUnit childLogicalOffset) const;
67     
68     LayoutUnit pageLogicalHeight() const { return m_pageLogicalHeight; }
69     bool pageLogicalHeightChanged() const { return m_pageLogicalHeightChanged; }
70
71     RenderBlockFlow* lineGrid() const { return m_lineGrid; }
72     LayoutSize lineGridOffset() const { return m_lineGridOffset; }
73     LayoutSize lineGridPaginationOrigin() const { return m_lineGridPaginationOrigin; }
74
75     LayoutSize layoutOffset() const { return m_layoutOffset; }
76
77     LayoutSize pageOffset() const { return m_pageOffset; }
78     void setLineGridPaginationOrigin(const LayoutSize& origin) { m_lineGridPaginationOrigin = origin; }
79     
80     bool needsBlockDirectionLocationSetBeforeLayout() const { return m_lineGrid || (m_isPaginated && m_pageLogicalHeight); }
81
82     RenderFlowThread* currentRenderFlowThread() const { return m_currentRenderFlowThread; }
83     void setCurrentRenderFlowThread(RenderFlowThread* flowThread) { m_currentRenderFlowThread = flowThread; }
84
85 private:
86     void propagateLineGridInfo(RenderBox*);
87     void establishLineGrid(RenderBlockFlow*);
88
89 public:
90     // Do not add anything apart from bitfields. See https://bugs.webkit.org/show_bug.cgi?id=100173
91     bool m_clipped : 1;
92     bool m_isPaginated : 1;
93     // If our page height has changed, this will force all blocks to relayout.
94     bool m_pageLogicalHeightChanged : 1;
95 #if !ASSERT_DISABLED && ENABLE(SATURATED_LAYOUT_ARITHMETIC)
96     bool m_layoutDeltaXSaturated : 1;
97     bool m_layoutDeltaYSaturated : 1;
98 #endif
99
100     // The current line grid that we're snapping to and the offset of the start of the grid.
101     RenderBlockFlow* m_lineGrid { nullptr };
102     std::unique_ptr<LayoutState> m_next;
103
104     // FIXME: Distinguish between the layout clip rect and the paint clip rect which may be larger,
105     // e.g., because of composited scrolling.
106     LayoutRect m_clipRect;
107     
108     // x/y offset from container. Includes relative positioning and scroll offsets.
109     LayoutSize m_paintOffset;
110     // x/y offset from container. Does not include relative positioning or scroll offsets.
111     LayoutSize m_layoutOffset;
112     // Transient offset from the final position of the object
113     // used to ensure that repaints happen in the correct place.
114     // This is a total delta accumulated from the root. 
115     LayoutSize m_layoutDelta;
116
117     // The current page height for the pagination model that encloses us.
118     LayoutUnit m_pageLogicalHeight;
119     // The offset of the start of the first page in the nearest enclosing pagination model.
120     LayoutSize m_pageOffset;
121     LayoutSize m_lineGridOffset;
122     LayoutSize m_lineGridPaginationOrigin;
123
124     RenderFlowThread* m_currentRenderFlowThread { nullptr };
125
126 #ifndef NDEBUG
127     RenderObject* m_renderer { nullptr };
128 #endif
129 };
130
131 } // namespace WebCore
132
133 #endif // LayoutState_h