Unreviewed, rolling out r149955.
[WebKit-https.git] / Source / WebCore / rendering / RenderMultiColumnSet.h
1 /*
2  * Copyright (C) 2012 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 COMPUTER, 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
27 #ifndef RenderMultiColumnSet_h
28 #define RenderMultiColumnSet_h
29
30 #include "RenderRegionSet.h"
31
32 namespace WebCore {
33
34 // RenderMultiColumnSet represents a set of columns that all have the same width and height. By combining runs of same-size columns into a single
35 // object, we significantly reduce the number of unique RenderObjects required to represent columns.
36 //
37 // A simple multi-column block will have exactly one RenderMultiColumnSet child. A simple paginated multi-column block will have three
38 // RenderMultiColumnSet children: one for the content at the bottom of the first page (whose columns will have a shorter height), one
39 // for the 2nd to n-1 pages, and then one last column set that will hold the shorter columns on the final page (that may have to be balanced
40 // as well).
41 //
42 // Column spans result in the creation of new column sets as well, since a spanning region has to be placed in between the column sets that
43 // come before and after the span.
44 class RenderMultiColumnSet : public RenderRegionSet {
45 public:
46     static RenderMultiColumnSet* createAnonymous(RenderFlowThread*);
47
48     virtual bool isRenderMultiColumnSet() const OVERRIDE { return true; }
49
50     unsigned computedColumnCount() const { return m_computedColumnCount; }
51     LayoutUnit computedColumnWidth() const { return m_computedColumnWidth; }
52     LayoutUnit computedColumnHeight() const { return m_computedColumnHeight; }
53
54     void setComputedColumnWidthAndCount(LayoutUnit width, unsigned count)
55     {
56         m_computedColumnWidth = width;
57         m_computedColumnCount = count;
58     }
59     void setComputedColumnHeight(LayoutUnit height)
60     {
61         m_computedColumnHeight = height;
62     }
63
64     void updateMinimumColumnHeight(LayoutUnit height) { m_minimumColumnHeight = std::max(height, m_minimumColumnHeight); }
65     LayoutUnit minimumColumnHeight() const { return m_minimumColumnHeight; }
66
67     unsigned forcedBreaksCount() const { return m_forcedBreaksCount; }
68     LayoutUnit forcedBreakOffset() const { return m_forcedBreakOffset; }
69     LayoutUnit maximumDistanceBetweenForcedBreaks() const { return m_maximumDistanceBetweenForcedBreaks; }
70     void clearForcedBreaks()
71     { 
72         m_forcedBreaksCount = 0;
73         m_maximumDistanceBetweenForcedBreaks = 0;
74         m_forcedBreakOffset = 0;
75     }
76     void addForcedBreak(LayoutUnit offsetFromFirstPage)
77     { 
78         ASSERT(!computedColumnHeight());
79         LayoutUnit distanceFromLastBreak = offsetFromFirstPage - m_forcedBreakOffset;
80         if (!distanceFromLastBreak)
81             return;
82         m_forcedBreaksCount++;
83         m_maximumDistanceBetweenForcedBreaks = std::max(m_maximumDistanceBetweenForcedBreaks, distanceFromLastBreak);
84         m_forcedBreakOffset = offsetFromFirstPage;
85     }
86
87     bool requiresBalancing() const { return m_requiresBalancing; }
88     void setRequiresBalancing(bool balancing) { m_requiresBalancing = balancing; }
89
90     virtual void updateLogicalWidth() OVERRIDE;
91     virtual void updateLogicalHeight() OVERRIDE;
92     
93 private:
94     RenderMultiColumnSet(RenderFlowThread*);
95
96     virtual void computeLogicalHeight(LayoutUnit logicalHeight, LayoutUnit logicalTop, LogicalExtentComputedValues&) const OVERRIDE;
97
98     virtual void paintObject(PaintInfo&, const LayoutPoint& paintOffset) OVERRIDE;
99
100     virtual LayoutUnit pageLogicalWidth() const OVERRIDE { return m_computedColumnWidth; }
101     virtual LayoutUnit pageLogicalHeight() const OVERRIDE { return m_computedColumnHeight; }
102
103     virtual LayoutUnit pageLogicalTopForOffset(LayoutUnit offset) const OVERRIDE;
104     
105     // FIXME: This will change once we have column sets constrained by enclosing pages, etc.
106     virtual LayoutUnit logicalHeightOfAllFlowThreadContent() const OVERRIDE { return m_computedColumnHeight; }
107
108     // FIXME: For now we return false, but it's likely we will leverage the auto height region code to do column
109     // balancing. That's why we have an override of this function that is distinct from RenderRegionSet's override.
110     virtual bool shouldHaveAutoLogicalHeight() const OVERRIDE { return false; }
111     
112     virtual void repaintFlowThreadContent(const LayoutRect& repaintRect, bool immediate) const OVERRIDE;
113
114     virtual void collectLayerFragments(LayerFragments&, const LayoutRect& layerBoundingBox, const LayoutRect& dirtyRect) OVERRIDE;
115
116     virtual const char* renderName() const;
117     
118     void paintColumnRules(PaintInfo&, const LayoutPoint& paintOffset);
119
120     LayoutUnit columnGap() const;
121     LayoutRect columnRectAt(unsigned index) const;
122     unsigned columnCount() const;
123
124     LayoutRect flowThreadPortionRectAt(unsigned index) const;
125     LayoutRect flowThreadPortionOverflowRect(const LayoutRect& flowThreadPortion, unsigned index, unsigned colCount, LayoutUnit colGap) const;
126     
127     unsigned columnIndexAtOffset(LayoutUnit) const;
128     
129     unsigned m_computedColumnCount;
130     LayoutUnit m_computedColumnWidth;
131     LayoutUnit m_computedColumnHeight;
132     
133     // The following variables are used when balancing the column set.
134     bool m_requiresBalancing; // Whether or not the columns in the column set have to be balanced, i.e., made to be similar logical heights.
135     LayoutUnit m_minimumColumnHeight;
136     unsigned m_forcedBreaksCount; // FIXME: We will ultimately need to cache more information to balance around forced breaks properly.
137     LayoutUnit m_maximumDistanceBetweenForcedBreaks;
138     LayoutUnit m_forcedBreakOffset;
139 };
140
141 inline RenderMultiColumnSet* toRenderMultiColumnSet(RenderObject* object)
142 {
143     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isRenderMultiColumnSet());
144     return static_cast<RenderMultiColumnSet*>(object);
145 }
146
147 inline const RenderMultiColumnSet* toRenderMultiColumnSet(const RenderObject* object)
148 {
149     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isRenderMultiColumnSet());
150     return static_cast<const RenderMultiColumnSet*>(object);
151 }
152
153 // This will catch anyone doing an unnecessary cast.
154 void toRenderMultiColumnSet(const RenderMultiColumnSet*);
155
156 } // namespace WebCore
157
158 #endif // RenderMultiColumnSet_h
159