Remove "virtual" from all lines that have both "virtual" and "override".
[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 "LayerFragment.h"
31 #include "RenderMultiColumnFlowThread.h"
32 #include "RenderRegionSet.h"
33 #include <wtf/Vector.h>
34
35 namespace WebCore {
36
37 // RenderMultiColumnSet represents a set of columns that all have the same width and height. By combining runs of same-size columns into a single
38 // object, we significantly reduce the number of unique RenderObjects required to represent columns.
39 //
40 // A simple multi-column block will have exactly one RenderMultiColumnSet child. A simple paginated multi-column block will have three
41 // RenderMultiColumnSet children: one for the content at the bottom of the first page (whose columns will have a shorter height), one
42 // 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
43 // as well).
44 //
45 // 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
46 // come before and after the span.
47 class RenderMultiColumnSet final : public RenderRegionSet {
48 public:
49     RenderMultiColumnSet(RenderFlowThread&, Ref<RenderStyle>&&);
50
51     RenderBlockFlow* multiColumnBlockFlow() const { return downcast<RenderBlockFlow>(parent()); }
52     RenderMultiColumnFlowThread* multiColumnFlowThread() const { return static_cast<RenderMultiColumnFlowThread*>(flowThread()); }
53
54     RenderMultiColumnSet* nextSiblingMultiColumnSet() const;
55     RenderMultiColumnSet* previousSiblingMultiColumnSet() const;
56
57     // Return the first object in the flow thread that's rendered inside this set.
58     RenderObject* firstRendererInFlowThread() const;
59     // Return the last object in the flow thread that's rendered inside this set.
60     RenderObject* lastRendererInFlowThread() const;
61
62     // Return true if the specified renderer (descendant of the flow thread) is inside this column set.
63     bool containsRendererInFlowThread(RenderObject*) const;
64
65     void setLogicalTopInFlowThread(LayoutUnit);
66     LayoutUnit logicalTopInFlowThread() const { return isHorizontalWritingMode() ? flowThreadPortionRect().y() : flowThreadPortionRect().x(); }
67     void setLogicalBottomInFlowThread(LayoutUnit);
68     LayoutUnit logicalBottomInFlowThread() const { return isHorizontalWritingMode() ? flowThreadPortionRect().maxY() : flowThreadPortionRect().maxX(); }
69     LayoutUnit logicalHeightInFlowThread() const { return isHorizontalWritingMode() ? flowThreadPortionRect().height() : flowThreadPortionRect().width(); }
70
71     unsigned computedColumnCount() const { return m_computedColumnCount; }
72     LayoutUnit computedColumnWidth() const { return m_computedColumnWidth; }
73     LayoutUnit computedColumnHeight() const { return m_computedColumnHeight; }
74     bool columnHeightComputed() const { return m_columnHeightComputed; }
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     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) override;
121
122     enum ColumnHitTestTranslationMode {
123         ClampHitTestTranslationToColumns,
124         DoNotClampHitTestTranslationToColumns
125     };
126     LayoutPoint translateRegionPointToFlowThread(const LayoutPoint & logicalPoint, ColumnHitTestTranslationMode = DoNotClampHitTestTranslationToColumns) const;
127
128     void updateHitTestResult(HitTestResult&, const LayoutPoint&) override;
129     
130     LayoutRect columnRectAt(unsigned index) const;
131     unsigned columnCount() const;
132
133 protected:
134     void addOverflowFromChildren() override;
135     
136 private:
137     bool isRenderMultiColumnSet() const override { return true; }
138     void layout() override;
139
140     void computeLogicalHeight(LayoutUnit logicalHeight, LayoutUnit logicalTop, LogicalExtentComputedValues&) const override;
141
142     void paintObject(PaintInfo&, const LayoutPoint&) override { }
143
144     LayoutUnit pageLogicalWidth() const override { return m_computedColumnWidth; }
145     LayoutUnit pageLogicalHeight() const override { return m_computedColumnHeight; }
146
147     LayoutUnit pageLogicalTopForOffset(LayoutUnit offset) const override;
148
149     LayoutUnit logicalHeightOfAllFlowThreadContent() const override { return logicalHeightInFlowThread(); }
150
151     void repaintFlowThreadContent(const LayoutRect& repaintRect) override;
152
153     void collectLayerFragments(LayerFragments&, const LayoutRect& layerBoundingBox, const LayoutRect& dirtyRect) override;
154
155     void adjustRegionBoundsFromFlowThreadPortionRect(LayoutRect& regionBounds) const override;
156
157     VisiblePosition positionForPoint(const LayoutPoint&, const RenderRegion*) override;
158
159     const char* renderName() const override;
160
161     LayoutUnit calculateMaxColumnHeight() const;
162     LayoutUnit columnGap() const;
163
164     LayoutUnit columnLogicalLeft(unsigned) const;
165     LayoutUnit columnLogicalTop(unsigned) const;
166
167     LayoutRect flowThreadPortionRectAt(unsigned index) const;
168     LayoutRect flowThreadPortionOverflowRect(const LayoutRect& flowThreadPortion, unsigned index, unsigned colCount, LayoutUnit colGap);
169
170     LayoutUnit initialBlockOffsetForPainting() const;
171
172     enum ColumnIndexCalculationMode {
173         ClampToExistingColumns, // Stay within the range of already existing columns.
174         AssumeNewColumns // Allow column indices outside the range of already existing columns.
175     };
176     unsigned columnIndexAtOffset(LayoutUnit, ColumnIndexCalculationMode = ClampToExistingColumns) const;
177
178     void setAndConstrainColumnHeight(LayoutUnit);
179
180     // Return the index of the content run with the currently tallest columns, taking all implicit
181     // breaks assumed so far into account.
182     unsigned findRunWithTallestColumns() const;
183
184     // Given the current list of content runs, make assumptions about where we need to insert
185     // implicit breaks (if there's room for any at all; depending on the number of explicit breaks),
186     // and store the results. This is needed in order to balance the columns.
187     void distributeImplicitBreaks();
188
189     LayoutUnit calculateBalancedHeight(bool initial) const;
190
191     unsigned m_computedColumnCount; // Used column count (the resulting 'N' from the pseudo-algorithm in the multicol spec)
192     LayoutUnit m_computedColumnWidth; // Used column width (the resulting 'W' from the pseudo-algorithm in the multicol spec)
193     LayoutUnit m_computedColumnHeight;
194     LayoutUnit m_availableColumnHeight;
195     bool m_columnHeightComputed;
196
197     // The following variables are used when balancing the column set.
198     LayoutUnit m_maxColumnHeight; // Maximum column height allowed.
199     LayoutUnit m_minSpaceShortage; // The smallest amout of space shortage that caused a column break.
200     LayoutUnit m_minimumColumnHeight;
201
202     // A run of content without explicit (forced) breaks; i.e. a flow thread portion between two
203     // explicit breaks, between flow thread start and an explicit break, between an explicit break
204     // and flow thread end, or, in cases when there are no explicit breaks at all: between flow flow
205     // thread start and flow thread end. We need to know where the explicit breaks are, in order to
206     // figure out where the implicit breaks will end up, so that we get the columns properly
207     // balanced. A content run starts out as representing one single column, and will represent one
208     // additional column for each implicit break "inserted" there.
209     class ContentRun {
210     public:
211         ContentRun(LayoutUnit breakOffset)
212             : m_breakOffset(breakOffset)
213             , m_assumedImplicitBreaks(0) { }
214
215         unsigned assumedImplicitBreaks() const { return m_assumedImplicitBreaks; }
216         void assumeAnotherImplicitBreak() { m_assumedImplicitBreaks++; }
217         LayoutUnit breakOffset() const { return m_breakOffset; }
218
219         // Return the column height that this content run would require, considering the implicit
220         // breaks assumed so far.
221         LayoutUnit columnLogicalHeight(LayoutUnit startOffset) const { return ceilf(float(m_breakOffset - startOffset) / float(m_assumedImplicitBreaks + 1)); }
222
223     private:
224         LayoutUnit m_breakOffset; // Flow thread offset where this run ends.
225         unsigned m_assumedImplicitBreaks; // Number of implicit breaks in this run assumed so far.
226     };
227     Vector<ContentRun, 1> m_contentRuns;
228 };
229
230 } // namespace WebCore
231
232 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderMultiColumnSet, isRenderMultiColumnSet())
233
234 #endif // RenderMultiColumnSet_h
235