de407b84f26f72b5a0bd66bc41de7cfd86a2b7ab
[WebKit-https.git] / Source / WebCore / rendering / RenderRegion.h
1 /*
2  * Copyright (C) 2011 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 #ifndef RenderRegion_h
31 #define RenderRegion_h
32
33 #include "RenderBlockFlow.h"
34 #include "StyleInheritedData.h"
35
36 namespace WebCore {
37
38 class Element;
39 struct LayerFragment;
40 typedef Vector<LayerFragment, 1> LayerFragments;
41 class RenderBox;
42 class RenderBoxRegionInfo;
43 class RenderFlowThread;
44 class RenderNamedFlowThread;
45
46 class RenderRegion : public RenderBlockFlow {
47 public:
48     virtual bool isRenderRegion() const OVERRIDE FINAL { return true; }
49
50     virtual bool hitTestContents(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) OVERRIDE;
51
52     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
53
54     void setFlowThreadPortionRect(const LayoutRect& rect) { m_flowThreadPortionRect = rect; }
55     LayoutRect flowThreadPortionRect() const { return m_flowThreadPortionRect; }
56     LayoutRect flowThreadPortionOverflowRect() const;
57
58     void attachRegion();
59     void detachRegion();
60
61     RenderNamedFlowThread* parentNamedFlowThread() const { return m_parentNamedFlowThread; }
62     RenderFlowThread* flowThread() const { return m_flowThread; }
63
64     // Valid regions do not create circular dependencies with other flows.
65     bool isValid() const { return m_isValid; }
66     void setIsValid(bool valid) { m_isValid = valid; }
67
68     bool hasCustomRegionStyle() const { return m_hasCustomRegionStyle; }
69     void setHasCustomRegionStyle(bool hasCustomRegionStyle) { m_hasCustomRegionStyle = hasCustomRegionStyle; }
70
71     RenderBoxRegionInfo* renderBoxRegionInfo(const RenderBox*) const;
72     RenderBoxRegionInfo* setRenderBoxRegionInfo(const RenderBox*, LayoutUnit logicalLeftInset, LayoutUnit logicalRightInset,
73         bool containingBlockChainIsInset);
74     OwnPtr<RenderBoxRegionInfo> takeRenderBoxRegionInfo(const RenderBox*);
75     void removeRenderBoxRegionInfo(const RenderBox*);
76
77     void deleteAllRenderBoxRegionInfo();
78
79     bool isFirstRegion() const;
80     bool isLastRegion() const;
81
82     void clearObjectStyleInRegion(const RenderObject*);
83
84     RegionOversetState regionOversetState() const;
85     void setRegionOversetState(RegionOversetState);
86
87     // These methods represent the width and height of a "page" and for a RenderRegion they are just the
88     // content width and content height of a region. For RenderRegionSets, however, they will be the width and
89     // height of a single column or page in the set.
90     virtual LayoutUnit pageLogicalWidth() const;
91     virtual LayoutUnit pageLogicalHeight() const;
92     virtual LayoutUnit maxPageLogicalHeight() const;
93
94     LayoutUnit logicalTopOfFlowThreadContentRect(const LayoutRect&) const;
95     LayoutUnit logicalBottomOfFlowThreadContentRect(const LayoutRect&) const;
96     LayoutUnit logicalTopForFlowThreadContent() const { return logicalTopOfFlowThreadContentRect(flowThreadPortionRect()); };
97     LayoutUnit logicalBottomForFlowThreadContent() const { return logicalBottomOfFlowThreadContentRect(flowThreadPortionRect()); };
98
99     void getRanges(Vector<RefPtr<Range>>&) const;
100
101     // This method represents the logical height of the entire flow thread portion used by the region or set.
102     // For RenderRegions it matches logicalPaginationHeight(), but for sets it is the height of all the pages
103     // or columns added together.
104     virtual LayoutUnit logicalHeightOfAllFlowThreadContent() const;
105
106     bool hasAutoLogicalHeight() const { return m_hasAutoLogicalHeight; }
107
108     LayoutUnit computedAutoHeight() const { return m_computedAutoHeight; }
109
110     void setComputedAutoHeight(LayoutUnit computedAutoHeight)
111     {
112         m_hasComputedAutoHeight = true;
113         m_computedAutoHeight = computedAutoHeight;
114     }
115
116     void clearComputedAutoHeight()
117     {
118         m_hasComputedAutoHeight = false;
119         m_computedAutoHeight = 0;
120     }
121
122     bool hasComputedAutoHeight() const { return m_hasComputedAutoHeight; }
123
124     virtual void updateLogicalHeight() OVERRIDE;
125
126     // The top of the nearest page inside the region. For RenderRegions, this is just the logical top of the
127     // flow thread portion we contain. For sets, we have to figure out the top of the nearest column or
128     // page.
129     virtual LayoutUnit pageLogicalTopForOffset(LayoutUnit offset) const;
130     
131     virtual void expandToEncompassFlowThreadContentsIfNeeded() { };
132
133     // Whether or not this region is a set.
134     virtual bool isRenderRegionSet() const { return false; }
135     
136     virtual void repaintFlowThreadContent(const LayoutRect& repaintRect, bool immediate) const;
137
138     virtual void collectLayerFragments(LayerFragments&, const LayoutRect&, const LayoutRect&) { }
139
140     virtual void adjustRegionBoundsFromFlowThreadPortionRect(const IntPoint& layerOffset, IntRect& regionBounds); // layerOffset is needed for multi-column.
141
142     void addLayoutOverflowForBox(const RenderBox*, const LayoutRect&);
143     void addVisualOverflowForBox(const RenderBox*, const LayoutRect&);
144     LayoutRect layoutOverflowRectForBox(const RenderBox*);
145     LayoutRect visualOverflowRectForBox(const RenderBox*);
146     LayoutRect layoutOverflowRectForBoxForPropagation(const RenderBox*);
147     LayoutRect visualOverflowRectForBoxForPropagation(const RenderBox*);
148
149     LayoutRect rectFlowPortionForBox(const RenderBox*, const LayoutRect&) const;
150
151     virtual bool canHaveChildren() const OVERRIDE { return false; }
152     virtual bool canHaveGeneratedChildren() const OVERRIDE { return true; }
153
154 protected:
155     RenderRegion(Element&, RenderFlowThread*);
156     RenderRegion(Document&, RenderFlowThread*);
157
158     RenderOverflow* ensureOverflowForBox(const RenderBox*);
159
160     void setRegionObjectsRegionStyle();
161     void restoreRegionObjectsOriginalStyle();
162
163     virtual void computePreferredLogicalWidths() OVERRIDE;
164     virtual void computeIntrinsicLogicalWidths(LayoutUnit& minLogicalWidth, LayoutUnit& maxLogicalWidth) const OVERRIDE;
165
166     enum OverflowType {
167         LayoutOverflow = 0,
168         VisualOverflow
169     };
170     LayoutRect overflowRectForFlowThreadPortion(const LayoutRect& flowThreadPortionRect, bool isFirstPortion, bool isLastPortion, OverflowType) const;
171
172     void repaintFlowThreadContentRectangle(const LayoutRect& repaintRect, bool immediate, const LayoutRect& flowThreadPortionRect,
173         const LayoutRect& flowThreadPortionOverflowRect, const LayoutPoint& regionLocation) const;
174
175     virtual bool shouldHaveAutoLogicalHeight() const;
176
177     void computeOverflowFromFlowThread();
178
179 private:
180     virtual const char* renderName() const { return "RenderRegion"; }
181
182     virtual void insertedIntoTree() OVERRIDE;
183     virtual void willBeRemovedFromTree() OVERRIDE;
184
185     virtual void layoutBlock(bool relayoutChildren, LayoutUnit pageLogicalHeight = 0) OVERRIDE;
186     virtual void paintObject(PaintInfo&, const LayoutPoint&) OVERRIDE;
187
188     virtual void installFlowThread();
189
190     PassRefPtr<RenderStyle> computeStyleInRegion(const RenderObject*);
191     void computeChildrenStyleInRegion(const RenderElement*);
192     void setObjectStyleInRegion(RenderObject*, PassRefPtr<RenderStyle>, bool objectRegionStyleCached);
193
194     void checkRegionStyle();
195     void updateRegionHasAutoLogicalHeightFlag();
196
197     void incrementAutoLogicalHeightCount();
198     void decrementAutoLogicalHeightCount();
199
200 protected:
201     RenderFlowThread* m_flowThread;
202
203 private:
204     // If this RenderRegion is displayed as part of another named flow,
205     // we need to create a dependency tree, so that layout of the
206     // regions is always done before the regions themselves.
207     RenderNamedFlowThread* m_parentNamedFlowThread;
208     LayoutRect m_flowThreadPortionRect;
209
210     // This map holds unique information about a block that is split across regions.
211     // A RenderBoxRegionInfo* tells us about any layout information for a RenderBox that
212     // is unique to the region. For now it just holds logical width information for RenderBlocks, but eventually
213     // it will also hold a custom style for any box (for region styling).
214     typedef HashMap<const RenderBox*, OwnPtr<RenderBoxRegionInfo>> RenderBoxRegionInfoMap;
215     RenderBoxRegionInfoMap m_renderBoxRegionInfo;
216
217     struct ObjectRegionStyleInfo {
218         // Used to store the original style of the object in region
219         // so that the original style is properly restored after paint.
220         // Also used to store computed style of the object in region between
221         // region paintings, so that the style in region is computed only
222         // when necessary.
223         RefPtr<RenderStyle> style;
224         // True if the computed style in region is cached.
225         bool cached;
226     };
227     typedef HashMap<const RenderObject*, ObjectRegionStyleInfo > RenderObjectRegionStyleMap;
228     RenderObjectRegionStyleMap m_renderObjectRegionStyle;
229
230     bool m_isValid : 1;
231     bool m_hasCustomRegionStyle : 1;
232     bool m_hasAutoLogicalHeight : 1;
233     bool m_hasComputedAutoHeight : 1;
234
235     LayoutUnit m_computedAutoHeight;
236 };
237
238 inline RenderRegion* toRenderRegion(RenderObject* object)
239 {
240     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isRenderRegion());
241     return static_cast<RenderRegion*>(object);
242 }
243
244 inline const RenderRegion* toRenderRegion(const RenderObject* object)
245 {
246     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isRenderRegion());
247     return static_cast<const RenderRegion*>(object);
248 }
249
250 inline RenderRegion& toRenderRegion(RenderObject& object)
251 {
252     ASSERT_WITH_SECURITY_IMPLICATION(object.isRenderRegion());
253     return static_cast<RenderRegion&>(object);
254 }
255
256 inline const RenderRegion& toRenderRegion(const RenderObject& object)
257 {
258     ASSERT_WITH_SECURITY_IMPLICATION(object.isRenderRegion());
259     return static_cast<const RenderRegion&>(object);
260 }
261
262 // This will catch anyone doing an unnecessary cast.
263 void toRenderRegion(const RenderRegion*);
264 void toRenderRegion(const RenderRegion&);
265
266 } // namespace WebCore
267
268 #endif // RenderRegion_h