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