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