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