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