Use #pragma once in WebCore
[WebKit-https.git] / Source / WebCore / rendering / RenderMultiColumnFlowThread.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 #pragma once
27
28 #include "RenderFlowThread.h"
29 #include <wtf/HashMap.h>
30
31 namespace WebCore {
32
33 class RenderMultiColumnSet;
34 class RenderMultiColumnSpannerPlaceholder;
35
36 class RenderMultiColumnFlowThread final : public RenderFlowThread {
37 public:
38     RenderMultiColumnFlowThread(Document&, RenderStyle&&);
39     ~RenderMultiColumnFlowThread();
40
41     RenderBlockFlow* multiColumnBlockFlow() const { return downcast<RenderBlockFlow>(parent()); }
42
43     RenderMultiColumnSet* firstMultiColumnSet() const;
44     RenderMultiColumnSet* lastMultiColumnSet() const;
45     RenderBox* firstColumnSetOrSpanner() const;
46     static RenderBox* nextColumnSetOrSpannerSiblingOf(const RenderBox*);
47     static RenderBox* previousColumnSetOrSpannerSiblingOf(const RenderBox*);
48
49     RenderMultiColumnSpannerPlaceholder* findColumnSpannerPlaceholder(RenderBox* spanner) const { return m_spannerMap.get(spanner); }
50
51     void layout() override;
52
53     // Populate the flow thread with what's currently its siblings. Called when a regular block
54     // becomes a multicol container.
55     void populate();
56
57     // Empty the flow thread by moving everything to the parent. Remove all multicol specific
58     // renderers. Then destroy the flow thread. Called when a multicol container becomes a regular
59     // block.
60     void evacuateAndDestroy();
61
62     unsigned columnCount() const { return m_columnCount; }
63     LayoutUnit columnWidth() const { return m_columnWidth; }
64     LayoutUnit columnHeightAvailable() const { return m_columnHeightAvailable; }
65     void setColumnHeightAvailable(LayoutUnit available) { m_columnHeightAvailable = available; }
66     bool inBalancingPass() const { return m_inBalancingPass; }
67     void setInBalancingPass(bool balancing) { m_inBalancingPass = balancing; }
68     bool needsHeightsRecalculation() const { return m_needsHeightsRecalculation; }
69     void setNeedsHeightsRecalculation(bool recalculate) { m_needsHeightsRecalculation = recalculate; }
70
71     bool shouldRelayoutForPagination() const { return !m_inBalancingPass && m_needsHeightsRecalculation; }
72
73     void setColumnCountAndWidth(unsigned count, LayoutUnit width)
74     {
75         m_columnCount = count;
76         m_columnWidth = width;
77     }
78
79     bool progressionIsInline() const { return m_progressionIsInline; }
80     void setProgressionIsInline(bool progressionIsInline) { m_progressionIsInline = progressionIsInline; }
81
82     bool progressionIsReversed() const { return m_progressionIsReversed; }
83     void setProgressionIsReversed(bool reversed) { m_progressionIsReversed = reversed; }
84     
85     void computeLineGridPaginationOrigin(LayoutState&) const;
86     
87     RenderRegion* mapFromFlowToRegion(TransformState&) const override;
88     
89     // This method takes a logical offset and returns a physical translation that can be applied to map
90     // a physical point (corresponding to the logical offset) into the region's physical coordinate space.
91     LayoutSize physicalTranslationOffsetFromFlowToRegion(const RenderRegion*, const LayoutUnit) const;
92     
93     // The point is physical, and the result is a physical location within the region.
94     RenderRegion* physicalTranslationFromFlowToRegion(LayoutPoint&) const;
95     
96     // This method is the inverse of the previous method and goes from region to flow.
97     LayoutSize physicalTranslationFromRegionToFlow(const RenderMultiColumnSet*, const LayoutPoint&) const;
98     
99     bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) override;
100     
101     void mapAbsoluteToLocalPoint(MapCoordinatesFlags, TransformState&) const override;
102     LayoutSize offsetFromContainer(RenderElement&, const LayoutPoint&, bool* offsetDependsOnPoint = nullptr) const override;
103     
104     // FIXME: Eventually as column and region flow threads start nesting, this will end up changing.
105     bool shouldCheckColumnBreaks() const override;
106
107 private:
108     bool isRenderMultiColumnFlowThread() const override { return true; }
109     const char* renderName() const override;
110     void addRegionToThread(RenderRegion*) override;
111     void willBeRemovedFromTree() override;
112     RenderObject* resolveMovedChild(RenderObject* child) const override;
113     void flowThreadDescendantInserted(RenderObject&) override;
114     void flowThreadRelativeWillBeRemoved(RenderObject&) override;
115     void flowThreadDescendantBoxLaidOut(RenderBox*) override;
116     void computeLogicalHeight(LayoutUnit logicalHeight, LayoutUnit logicalTop, LogicalExtentComputedValues&) const override;
117     LayoutUnit initialLogicalWidth() const override;
118     void setPageBreak(const RenderBlock*, LayoutUnit offset, LayoutUnit spaceShortage) override;
119     void updateMinimumPageHeight(const RenderBlock*, LayoutUnit offset, LayoutUnit minHeight) override;
120     RenderRegion* regionAtBlockOffset(const RenderBox*, LayoutUnit, bool extendLastRegion = false) const override;
121     void setRegionRangeForBox(const RenderBox&, RenderRegion*, RenderRegion*) override;
122     bool addForcedRegionBreak(const RenderBlock*, LayoutUnit, RenderBox* breakChild, bool isBefore, LayoutUnit* offsetBreakAdjustment = 0) override;
123     bool isPageLogicalHeightKnown() const override;
124
125     void handleSpannerRemoval(RenderObject& spanner);
126     RenderObject* processPossibleSpannerDescendant(RenderObject*& subtreeRoot, RenderObject& descendant);
127     
128 private:
129     typedef HashMap<RenderBox*, RenderMultiColumnSpannerPlaceholder*> SpannerMap;
130     SpannerMap m_spannerMap;
131
132     // The last set we worked on. It's not to be used as the "current set". The concept of a
133     // "current set" is difficult, since layout may jump back and forth in the tree, due to wrong
134     // top location estimates (due to e.g. margin collapsing), and possibly for other reasons.
135     RenderMultiColumnSet* m_lastSetWorkedOn;
136
137     unsigned m_columnCount;   // The default column count/width that are based off our containing block width. These values represent only the default,
138     LayoutUnit m_columnWidth; // A multi-column block that is split across variable width pages or regions will have different column counts and widths in each.
139                               // These values will be cached (eventually) for multi-column blocks.
140     LayoutUnit m_columnHeightAvailable; // Total height available to columns, or 0 if auto.
141     bool m_inLayout; // Set while we're laying out the flow thread, during which colum set heights are unknown.
142     bool m_inBalancingPass; // Guard to avoid re-entering column balancing.
143     bool m_needsHeightsRecalculation;
144     
145     bool m_progressionIsInline;
146     bool m_progressionIsReversed;
147     bool m_beingEvacuated;
148     
149     static bool gShiftingSpanner;
150 };
151
152 } // namespace WebCore
153
154 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderMultiColumnFlowThread, isRenderMultiColumnFlowThread())