Use #pragma once in WebCore
[WebKit-https.git] / Source / WebCore / rendering / RenderNamedFlowFragment.h
1 /*
2  * Copyright (C) 2013 Adobe Systems Incorporated. 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  *
8  * 1. Redistributions of source code must retain the above
9  *    copyright notice, this list of conditions and the following
10  *    disclaimer.
11  * 2. Redistributions in binary form must reproduce the above
12  *    copyright notice, this list of conditions and the following
13  *    disclaimer in the documentation and/or other materials
14  *    provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER "AS IS" AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
21  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
23  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
25  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
26  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29
30 #pragma once
31
32 #include "RenderRegion.h"
33
34 namespace WebCore {
35
36 class Element;
37 class RenderStyle;
38
39 // RenderNamedFlowFragment represents a region that is responsible for the fragmentation of
40 // the RenderNamedFlowThread content.
41 //
42 // A RenderNamedFlowFragment object is created as an anonymous child for a RenderBlockFlow object
43 // that has a valid -webkit-flow-from property.
44 //
45 // This allows a non-replaced block to behave like a region if needed, following the CSSRegions specification:
46 // http://dev.w3.org/csswg/css-regions/#the-flow-from-property.
47 // list-item, table-caption, table-cell can become regions in addition to block | inline-block.
48
49 class RenderNamedFlowFragment final : public RenderRegion {
50 public:
51     RenderNamedFlowFragment(Document&, RenderStyle&&);
52     virtual ~RenderNamedFlowFragment();
53
54     static RenderStyle createStyle(const RenderStyle& parentStyle);
55
56     void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
57
58     void getRanges(Vector<RefPtr<Range>>&) const;
59
60     LayoutUnit pageLogicalHeight() const override;
61     LayoutUnit maxPageLogicalHeight() const;
62     
63     LayoutRect flowThreadPortionRectForClipping(bool isFirstRegionInRange, bool isLastRegionInRange) const;
64
65     RenderBlockFlow& fragmentContainer() const;
66     RenderLayer& fragmentContainerLayer() const;
67     
68     bool shouldClipFlowThreadContent() const override;
69     
70     LayoutSize offsetFromContainer(RenderElement&, const LayoutPoint&, bool* offsetDependsOnPoint = nullptr) const override;
71
72     bool isPseudoElementRegion() const { return parent() && parent()->isPseudoElement(); }
73
74     // When the content inside the region requires the region to have a layer, the layer will be created on the region's
75     // parent renderer instead.
76     // This method returns that renderer holding the layer.
77     // The return value cannot be null because CSS Regions create Stacking Contexts (which means they create layers).
78     RenderLayerModelObject& layerOwner() const { return downcast<RenderLayerModelObject>(*parent()); }
79
80     bool hasCustomRegionStyle() const { return m_hasCustomRegionStyle; }
81     void clearObjectStyleInRegion(const RenderElement&);
82
83     void setRegionObjectsRegionStyle();
84     void restoreRegionObjectsOriginalStyle();
85     
86     LayoutRect visualOverflowRect() const override;
87
88     RenderNamedFlowThread* namedFlowThread() const;
89
90     bool hasAutoLogicalHeight() const override { return m_hasAutoLogicalHeight; }
91
92     LayoutUnit computedAutoHeight() const { return m_computedAutoHeight; }
93
94     void setComputedAutoHeight(LayoutUnit computedAutoHeight)
95     {
96         m_hasComputedAutoHeight = true;
97         m_computedAutoHeight = computedAutoHeight;
98     }
99
100     void clearComputedAutoHeight()
101     {
102         m_hasComputedAutoHeight = false;
103         m_computedAutoHeight = 0;
104     }
105
106     bool hasComputedAutoHeight() const { return m_hasComputedAutoHeight; }
107
108     RegionOversetState regionOversetState() const;
109
110     void attachRegion() override;
111     void detachRegion() override;
112
113     void updateLogicalHeight() override;
114
115     void updateRegionFlags();
116
117     void absoluteQuadsForBoxInRegion(Vector<FloatQuad>&, bool*, const RenderBox*, float, float) override;
118
119     void invalidateRegionIfNeeded();
120
121 private:
122     bool isRenderNamedFlowFragment() const override { return true; }
123     const char* renderName() const override { return "RenderNamedFlowFragment"; }
124
125     std::unique_ptr<RenderStyle> computeStyleInRegion(RenderElement&, const RenderStyle& parentStyle) const;
126     void computeChildrenStyleInRegion(RenderElement&);
127     void setRendererStyleInRegion(RenderElement&, std::unique_ptr<RenderStyle>, bool objectRegionStyleCached);
128
129     void checkRegionStyle();
130     void setHasCustomRegionStyle(bool hasCustomRegionStyle) { m_hasCustomRegionStyle = hasCustomRegionStyle; }
131
132     void updateRegionHasAutoLogicalHeightFlag();
133
134     void incrementAutoLogicalHeightCount();
135     void decrementAutoLogicalHeightCount();
136
137     bool shouldHaveAutoLogicalHeight() const;
138
139     void updateOversetState();
140     void setRegionOversetState(RegionOversetState);
141
142     void layoutBlock(bool relayoutChildren, LayoutUnit pageLogicalHeight = 0) override;
143
144     struct ObjectRegionStyleInfo {
145         // Used to store the original style of the object in region
146         // so that the original style is properly restored after paint.
147         // Also used to store computed style of the object in region between
148         // region paintings, so that the style in region is computed only
149         // when necessary.
150         std::unique_ptr<RenderStyle> style;
151         // True if the computed style in region is cached.
152         bool cached;
153     };
154
155     using RendererRegionStyleMap = HashMap<const RenderElement*, ObjectRegionStyleInfo>;
156     RendererRegionStyleMap m_rendererRegionStyle;
157
158     bool m_hasCustomRegionStyle : 1;
159     bool m_hasAutoLogicalHeight : 1;
160     bool m_hasComputedAutoHeight : 1;
161
162     LayoutUnit m_computedAutoHeight;
163 };
164
165 } // namespace WebCore
166
167 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderNamedFlowFragment, isRenderNamedFlowFragment())