Get rid of the unused 'immediate' parameters from repaint related functions
[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 #include <wtf/Vector.h>
32
33 namespace WebCore {
34
35 // RenderMultiColumnSet represents a set of columns that all have the same width and height. By combining runs of same-size columns into a single
36 // object, we significantly reduce the number of unique RenderObjects required to represent columns.
37 //
38 // A simple multi-column block will have exactly one RenderMultiColumnSet child. A simple paginated multi-column block will have three
39 // RenderMultiColumnSet children: one for the content at the bottom of the first page (whose columns will have a shorter height), one
40 // 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
41 // as well).
42 //
43 // 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
44 // come before and after the span.
45 class RenderMultiColumnSet final : public RenderRegionSet {
46 public:
47     RenderMultiColumnSet(RenderFlowThread&, PassRef<RenderStyle>);
48
49     virtual bool isRenderMultiColumnSet() const override { return true; }
50
51     unsigned computedColumnCount() const { return m_computedColumnCount; }
52     LayoutUnit computedColumnWidth() const { return m_computedColumnWidth; }
53     LayoutUnit computedColumnHeight() const { return m_computedColumnHeight; }
54
55     void setComputedColumnWidthAndCount(LayoutUnit width, unsigned count)
56     {
57         m_computedColumnWidth = width;
58         m_computedColumnCount = count;
59     }
60
61     LayoutUnit heightAdjustedForSetOffset(LayoutUnit height) const;
62
63     void updateMinimumColumnHeight(LayoutUnit height) { m_minimumColumnHeight = std::max(height, m_minimumColumnHeight); }
64     LayoutUnit minimumColumnHeight() const { return m_minimumColumnHeight; }
65
66     unsigned forcedBreaksCount() const { return m_contentRuns.size(); }
67     void clearForcedBreaks();
68     void addForcedBreak(LayoutUnit offsetFromFirstPage);
69
70     // (Re-)calculate the column height when contents are supposed to be balanced. If 'initial' is
71     // set, guess an initial column height; otherwise, stretch the column height a tad. Return true
72     // if column height changed and another layout pass is required.
73     bool recalculateBalancedHeight(bool initial);
74
75     // Record space shortage (the amount of space that would have been enough to prevent some
76     // element from being moved to the next column) at a column break. The smallest amount of space
77     // shortage we find is the amount with which we will stretch the column height, if it turns out
78     // after layout that the columns weren't tall enough.
79     void recordSpaceShortage(LayoutUnit spaceShortage);
80
81     virtual void updateLogicalWidth() override;
82
83     void prepareForLayout();
84
85 protected:
86     void addOverflowFromChildren() override;
87     
88 private:
89     virtual void computeLogicalHeight(LayoutUnit logicalHeight, LayoutUnit logicalTop, LogicalExtentComputedValues&) const override;
90
91     virtual void paintObject(PaintInfo&, const LayoutPoint& paintOffset) override;
92
93     virtual LayoutUnit pageLogicalWidth() const override { return m_computedColumnWidth; }
94     virtual LayoutUnit pageLogicalHeight() const override { return m_computedColumnHeight; }
95
96     virtual LayoutUnit pageLogicalTopForOffset(LayoutUnit offset) const override;
97     
98     // FIXME: This will change once we have column sets constrained by enclosing pages, etc.
99     virtual LayoutUnit logicalHeightOfAllFlowThreadContent() const override { return m_computedColumnHeight; }
100     
101     virtual void repaintFlowThreadContent(const LayoutRect& repaintRect) override;
102
103     virtual void collectLayerFragments(LayerFragments&, const LayoutRect& layerBoundingBox, const LayoutRect& dirtyRect) override;
104
105     virtual void adjustRegionBoundsFromFlowThreadPortionRect(const LayoutPoint& layerOffset, LayoutRect& regionBounds) override;
106
107     virtual const char* renderName() const;
108     
109     void paintColumnRules(PaintInfo&, const LayoutPoint& paintOffset);
110
111     LayoutUnit columnGap() const;
112     LayoutRect columnRectAt(unsigned index) const;
113     unsigned columnCount() const;
114
115     LayoutRect flowThreadPortionRectAt(unsigned index) const;
116     LayoutRect flowThreadPortionOverflowRect(const LayoutRect& flowThreadPortion, unsigned index, unsigned colCount, LayoutUnit colGap);
117
118     LayoutUnit initialBlockOffsetForPainting() const;
119
120     enum ColumnIndexCalculationMode {
121         ClampToExistingColumns, // Stay within the range of already existing columns.
122         AssumeNewColumns // Allow column indices outside the range of already existing columns.
123     };
124     unsigned columnIndexAtOffset(LayoutUnit, ColumnIndexCalculationMode = ClampToExistingColumns) const;
125
126     void setAndConstrainColumnHeight(LayoutUnit);
127
128     // Return the index of the content run with the currently tallest columns, taking all implicit
129     // breaks assumed so far into account.
130     unsigned findRunWithTallestColumns() const;
131
132     // Given the current list of content runs, make assumptions about where we need to insert
133     // implicit breaks (if there's room for any at all; depending on the number of explicit breaks),
134     // and store the results. This is needed in order to balance the columns.
135     void distributeImplicitBreaks();
136
137     LayoutUnit calculateBalancedHeight(bool initial) const;
138
139     unsigned m_computedColumnCount; // Used column count (the resulting 'N' from the pseudo-algorithm in the multicol spec)
140     LayoutUnit m_computedColumnWidth; // Used column width (the resulting 'W' from the pseudo-algorithm in the multicol spec)
141     LayoutUnit m_computedColumnHeight;
142     
143     // The following variables are used when balancing the column set.
144     LayoutUnit m_maxColumnHeight; // Maximum column height allowed.
145     LayoutUnit m_minSpaceShortage; // The smallest amout of space shortage that caused a column break.
146     LayoutUnit m_minimumColumnHeight;
147
148     // A run of content without explicit (forced) breaks; i.e. a flow thread portion between two
149     // explicit breaks, between flow thread start and an explicit break, between an explicit break
150     // and flow thread end, or, in cases when there are no explicit breaks at all: between flow flow
151     // thread start and flow thread end. We need to know where the explicit breaks are, in order to
152     // figure out where the implicit breaks will end up, so that we get the columns properly
153     // balanced. A content run starts out as representing one single column, and will represent one
154     // additional column for each implicit break "inserted" there.
155     class ContentRun {
156     public:
157         ContentRun(LayoutUnit breakOffset)
158             : m_breakOffset(breakOffset)
159             , m_assumedImplicitBreaks(0) { }
160
161         unsigned assumedImplicitBreaks() const { return m_assumedImplicitBreaks; }
162         void assumeAnotherImplicitBreak() { m_assumedImplicitBreaks++; }
163         LayoutUnit breakOffset() const { return m_breakOffset; }
164
165         // Return the column height that this content run would require, considering the implicit
166         // breaks assumed so far.
167         LayoutUnit columnLogicalHeight(LayoutUnit startOffset) const { return ceilf(float(m_breakOffset - startOffset) / float(m_assumedImplicitBreaks + 1)); }
168
169     private:
170         LayoutUnit m_breakOffset; // Flow thread offset where this run ends.
171         unsigned m_assumedImplicitBreaks; // Number of implicit breaks in this run assumed so far.
172     };
173     Vector<ContentRun, 1> m_contentRuns;
174 };
175
176 RENDER_OBJECT_TYPE_CASTS(RenderMultiColumnSet, isRenderMultiColumnSet())
177
178 } // namespace WebCore
179
180 #endif // RenderMultiColumnSet_h
181