Unreviewed, rolling out r167478.
[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 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 "RenderMultiColumnFlowThread.h"
31 #include "RenderRegionSet.h"
32 #include <wtf/Vector.h>
33
34 namespace WebCore {
35
36 // RenderMultiColumnSet represents a set of columns that all have the same width and height. By combining runs of same-size columns into a single
37 // object, we significantly reduce the number of unique RenderObjects required to represent columns.
38 //
39 // A simple multi-column block will have exactly one RenderMultiColumnSet child. A simple paginated multi-column block will have three
40 // RenderMultiColumnSet children: one for the content at the bottom of the first page (whose columns will have a shorter height), one
41 // 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
42 // as well).
43 //
44 // 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
45 // come before and after the span.
46 class RenderMultiColumnSet final : public RenderRegionSet {
47 public:
48     RenderMultiColumnSet(RenderFlowThread&, PassRef<RenderStyle>);
49
50     virtual bool isRenderMultiColumnSet() const override { return true; }
51
52     RenderBlockFlow* multiColumnBlockFlow() const { return toRenderBlockFlow(parent()); }
53     RenderMultiColumnFlowThread* multiColumnFlowThread() const { return static_cast<RenderMultiColumnFlowThread*>(flowThread()); }
54
55     RenderMultiColumnSet* nextSiblingMultiColumnSet() const;
56     RenderMultiColumnSet* previousSiblingMultiColumnSet() const;
57
58     // Return the first object in the flow thread that's rendered inside this set.
59     RenderObject* firstRendererInFlowThread() const;
60     // Return the last object in the flow thread that's rendered inside this set.
61     RenderObject* lastRendererInFlowThread() const;
62
63     // Return true if the specified renderer (descendant of the flow thread) is inside this column set.
64     bool containsRendererInFlowThread(RenderObject*) const;
65
66     void setLogicalTopInFlowThread(LayoutUnit);
67     LayoutUnit logicalTopInFlowThread() const { return isHorizontalWritingMode() ? flowThreadPortionRect().y() : flowThreadPortionRect().x(); }
68     void setLogicalBottomInFlowThread(LayoutUnit);
69     LayoutUnit logicalBottomInFlowThread() const { return isHorizontalWritingMode() ? flowThreadPortionRect().maxY() : flowThreadPortionRect().maxX(); }
70     LayoutUnit logicalHeightInFlowThread() const { return isHorizontalWritingMode() ? flowThreadPortionRect().height() : flowThreadPortionRect().width(); }
71
72     unsigned computedColumnCount() const { return m_computedColumnCount; }
73     LayoutUnit computedColumnWidth() const { return m_computedColumnWidth; }
74     LayoutUnit computedColumnHeight() const { return m_computedColumnHeight; }
75
76     void setComputedColumnWidthAndCount(LayoutUnit width, unsigned count)
77     {
78         m_computedColumnWidth = width;
79         m_computedColumnCount = count;
80     }
81
82     LayoutUnit heightAdjustedForSetOffset(LayoutUnit height) const;
83
84     void updateMinimumColumnHeight(LayoutUnit height) { m_minimumColumnHeight = std::max(height, m_minimumColumnHeight); }
85     LayoutUnit minimumColumnHeight() const { return m_minimumColumnHeight; }
86
87     unsigned forcedBreaksCount() const { return m_contentRuns.size(); }
88     void clearForcedBreaks();
89     void addForcedBreak(LayoutUnit offsetFromFirstPage);
90
91     // (Re-)calculate the column height. This is first and foremost needed by sets that are to
92     // balance the column height, but even when it isn't to be balanced, this is necessary if the
93     // multicol container's height is constrained. If |initial| is set, and we are to balance, guess
94     // an initial column height; otherwise, stretch the column height a tad. Return true if column
95     // height changed and another layout pass is required.
96     bool recalculateColumnHeight(bool initial);
97
98     // Record space shortage (the amount of space that would have been enough to prevent some
99     // element from being moved to the next column) at a column break. The smallest amount of space
100     // shortage we find is the amount with which we will stretch the column height, if it turns out
101     // after layout that the columns weren't tall enough.
102     void recordSpaceShortage(LayoutUnit spaceShortage);
103
104     virtual void updateLogicalWidth() override;
105
106     void prepareForLayout(bool initial);
107     // Begin laying out content for this column set. This happens at the beginning of flow thread
108     // layout, and when advancing from a previous column set or spanner to this one.
109     void beginFlow(RenderBlock* container);
110     // Finish laying out content for this column set. This happens at end of flow thread layout, and
111     // when advancing to the next column set or spanner.
112     void endFlow(RenderBlock* container, LayoutUnit bottomInContainer);
113     // Has this set been flowed in this layout pass?
114     bool hasBeenFlowed() const { return logicalBottomInFlowThread() != RenderFlowThread::maxLogicalHeight(); }
115
116     bool requiresBalancing() const;
117
118     LayoutPoint columnTranslationForOffset(const LayoutUnit&) const;
119     
120     void paintColumnRules(PaintInfo&, const LayoutPoint& paintOffset);
121
122 protected:
123     void addOverflowFromChildren() override;
124     
125 private:
126     virtual void layout() override;
127
128     virtual void computeLogicalHeight(LayoutUnit logicalHeight, LayoutUnit logicalTop, LogicalExtentComputedValues&) const override;
129
130     virtual void paintObject(PaintInfo&, const LayoutPoint&) override { }
131
132     virtual LayoutUnit pageLogicalWidth() const override { return m_computedColumnWidth; }
133     virtual LayoutUnit pageLogicalHeight() const override { return m_computedColumnHeight; }
134
135     virtual LayoutUnit pageLogicalTopForOffset(LayoutUnit offset) const override;
136
137     virtual LayoutUnit logicalHeightOfAllFlowThreadContent() const override { return logicalHeightInFlowThread(); }
138
139     virtual void repaintFlowThreadContent(const LayoutRect& repaintRect) override;
140
141     virtual void collectLayerFragments(LayerFragments&, const LayoutRect& layerBoundingBox, const LayoutRect& dirtyRect) override;
142
143     virtual void adjustRegionBoundsFromFlowThreadPortionRect(const LayoutPoint& layerOffset, LayoutRect& regionBounds) override;
144
145     virtual VisiblePosition positionForPoint(const LayoutPoint&) override;
146
147     virtual const char* renderName() const;
148
149     LayoutUnit calculateMaxColumnHeight() const;
150     LayoutUnit columnGap() const;
151     LayoutRect columnRectAt(unsigned index) const;
152     unsigned columnCount() const;
153
154     LayoutRect flowThreadPortionRectAt(unsigned index) const;
155     LayoutRect flowThreadPortionOverflowRect(const LayoutRect& flowThreadPortion, unsigned index, unsigned colCount, LayoutUnit colGap);
156
157     LayoutUnit initialBlockOffsetForPainting() const;
158
159     enum ColumnIndexCalculationMode {
160         ClampToExistingColumns, // Stay within the range of already existing columns.
161         AssumeNewColumns // Allow column indices outside the range of already existing columns.
162     };
163     unsigned columnIndexAtOffset(LayoutUnit, ColumnIndexCalculationMode = ClampToExistingColumns) const;
164
165     void setAndConstrainColumnHeight(LayoutUnit);
166
167     // Return the index of the content run with the currently tallest columns, taking all implicit
168     // breaks assumed so far into account.
169     unsigned findRunWithTallestColumns() const;
170
171     // Given the current list of content runs, make assumptions about where we need to insert
172     // implicit breaks (if there's room for any at all; depending on the number of explicit breaks),
173     // and store the results. This is needed in order to balance the columns.
174     void distributeImplicitBreaks();
175
176     LayoutUnit calculateBalancedHeight(bool initial) const;
177
178     unsigned m_computedColumnCount; // Used column count (the resulting 'N' from the pseudo-algorithm in the multicol spec)
179     LayoutUnit m_computedColumnWidth; // Used column width (the resulting 'W' from the pseudo-algorithm in the multicol spec)
180     LayoutUnit m_computedColumnHeight;
181     
182     // The following variables are used when balancing the column set.
183     LayoutUnit m_maxColumnHeight; // Maximum column height allowed.
184     LayoutUnit m_minSpaceShortage; // The smallest amout of space shortage that caused a column break.
185     LayoutUnit m_minimumColumnHeight;
186
187     // A run of content without explicit (forced) breaks; i.e. a flow thread portion between two
188     // explicit breaks, between flow thread start and an explicit break, between an explicit break
189     // and flow thread end, or, in cases when there are no explicit breaks at all: between flow flow
190     // thread start and flow thread end. We need to know where the explicit breaks are, in order to
191     // figure out where the implicit breaks will end up, so that we get the columns properly
192     // balanced. A content run starts out as representing one single column, and will represent one
193     // additional column for each implicit break "inserted" there.
194     class ContentRun {
195     public:
196         ContentRun(LayoutUnit breakOffset)
197             : m_breakOffset(breakOffset)
198             , m_assumedImplicitBreaks(0) { }
199
200         unsigned assumedImplicitBreaks() const { return m_assumedImplicitBreaks; }
201         void assumeAnotherImplicitBreak() { m_assumedImplicitBreaks++; }
202         LayoutUnit breakOffset() const { return m_breakOffset; }
203
204         // Return the column height that this content run would require, considering the implicit
205         // breaks assumed so far.
206         LayoutUnit columnLogicalHeight(LayoutUnit startOffset) const { return ceilf(float(m_breakOffset - startOffset) / float(m_assumedImplicitBreaks + 1)); }
207
208     private:
209         LayoutUnit m_breakOffset; // Flow thread offset where this run ends.
210         unsigned m_assumedImplicitBreaks; // Number of implicit breaks in this run assumed so far.
211     };
212     Vector<ContentRun, 1> m_contentRuns;
213 };
214
215 RENDER_OBJECT_TYPE_CASTS(RenderMultiColumnSet, isRenderMultiColumnSet())
216
217 } // namespace WebCore
218
219 #endif // RenderMultiColumnSet_h
220