Use #pragma once in WebCore
[WebKit-https.git] / Source / WebCore / rendering / RenderFlexibleBox.h
1 /*
2  * Copyright (C) 2011 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #pragma once
32
33 #include "OrderIterator.h"
34 #include "RenderBlock.h"
35
36 namespace WebCore {
37
38 class RenderFlexibleBox : public RenderBlock {
39 public:
40     RenderFlexibleBox(Element&, RenderStyle&&);
41     RenderFlexibleBox(Document&, RenderStyle&&);
42     virtual ~RenderFlexibleBox();
43
44     const char* renderName() const override;
45
46     bool avoidsFloats() const final { return true; }
47     bool canDropAnonymousBlockChild() const final { return false; }
48     void layoutBlock(bool relayoutChildren, LayoutUnit pageLogicalHeight = 0) final;
49
50     int baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const override;
51     Optional<int> firstLineBaseline() const override;
52     Optional<int> inlineBlockBaseline(LineDirectionMode) const override;
53
54     void paintChildren(PaintInfo& forSelf, const LayoutPoint&, PaintInfo& forChild, bool usePrintRect) override;
55
56     bool isHorizontalFlow() const;
57
58     bool isTopLayoutOverflowAllowed() const override;
59     bool isLeftLayoutOverflowAllowed() const override;
60
61 protected:
62     void computeIntrinsicLogicalWidths(LayoutUnit& minLogicalWidth, LayoutUnit& maxLogicalWidth) const override;
63     void computePreferredLogicalWidths() override;
64
65     void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
66
67 private:
68     enum FlexSign {
69         PositiveFlexibility,
70         NegativeFlexibility,
71     };
72
73     enum PositionedLayoutMode {
74         FlipForRowReverse,
75         NoFlipForRowReverse,
76     };
77
78     typedef HashMap<const RenderBox*, LayoutUnit> InflexibleFlexItemSize;
79     typedef Vector<RenderBox*> OrderedFlexItemList;
80
81     struct LineContext;
82     struct Violation;
83
84     // Use an inline capacity of 8, since flexbox containers usually have less than 8 children.
85     typedef Vector<LayoutRect, 8> ChildFrameRects;
86
87     bool isFlexibleBox() const final { return true; }
88     bool hasOrthogonalFlow(const RenderBox& child) const;
89     bool isColumnFlow() const;
90     bool isLeftToRightFlow() const;
91     bool isMultiline() const;
92     Length flexBasisForChild(RenderBox& child) const;
93     void setCrossAxisExtent(LayoutUnit);
94     LayoutUnit crossAxisExtentForChild(RenderBox& child) const;
95     LayoutUnit mainAxisExtentForChild(RenderBox& child) const;
96     LayoutUnit crossAxisExtent() const;
97     LayoutUnit mainAxisExtent() const;
98     LayoutUnit crossAxisContentExtent() const;
99     LayoutUnit mainAxisContentExtent(LayoutUnit contentLogicalHeight);
100     Optional<LayoutUnit> computeMainAxisExtentForChild(const RenderBox& child, SizeType, const Length& size);
101     WritingMode transformedWritingMode() const;
102     LayoutUnit flowAwareBorderStart() const;
103     LayoutUnit flowAwareBorderEnd() const;
104     LayoutUnit flowAwareBorderBefore() const;
105     LayoutUnit flowAwareBorderAfter() const;
106     LayoutUnit flowAwarePaddingStart() const;
107     LayoutUnit flowAwarePaddingEnd() const;
108     LayoutUnit flowAwarePaddingBefore() const;
109     LayoutUnit flowAwarePaddingAfter() const;
110     LayoutUnit flowAwareMarginStartForChild(RenderBox& child) const;
111     LayoutUnit flowAwareMarginEndForChild(RenderBox& child) const;
112     LayoutUnit flowAwareMarginBeforeForChild(RenderBox& child) const;
113     LayoutUnit flowAwareMarginAfterForChild(RenderBox& child) const;
114     LayoutUnit crossAxisMarginExtentForChild(RenderBox& child) const;
115     LayoutUnit crossAxisScrollbarExtent() const;
116     LayoutPoint flowAwareLocationForChild(RenderBox& child) const;
117     // FIXME: Supporting layout deltas.
118     void setFlowAwareLocationForChild(RenderBox& child, const LayoutPoint&);
119     void adjustAlignmentForChild(RenderBox& child, LayoutUnit);
120     ItemPosition alignmentForChild(RenderBox& child) const;
121     LayoutUnit mainAxisBorderAndPaddingExtentForChild(RenderBox& child) const;
122     LayoutUnit mainAxisScrollbarExtentForChild(RenderBox& child) const;
123     LayoutUnit preferredMainAxisContentExtentForChild(RenderBox& child, bool hasInfiniteLineLength);
124     EOverflow mainAxisOverflowForChild(const RenderBox&) const;
125
126     void layoutFlexItems(bool relayoutChildren, Vector<LineContext>&);
127     LayoutUnit autoMarginOffsetInMainAxis(const OrderedFlexItemList&, LayoutUnit& availableFreeSpace);
128     void updateAutoMarginsInMainAxis(RenderBox& child, LayoutUnit autoMarginOffset);
129     bool hasAutoMarginsInCrossAxis(RenderBox& child) const;
130     bool updateAutoMarginsInCrossAxis(RenderBox& child, LayoutUnit availableAlignmentSpace);
131     void repositionLogicalHeightDependentFlexItems(Vector<LineContext>&);
132     LayoutUnit clientLogicalBottomAfterRepositioning();
133     void appendChildFrameRects(ChildFrameRects&);
134     void repaintChildrenDuringLayoutIfMoved(const ChildFrameRects&);
135
136     LayoutUnit availableAlignmentSpaceForChild(LayoutUnit lineCrossAxisExtent, RenderBox&);
137     LayoutUnit marginBoxAscentForChild(RenderBox&);
138
139     LayoutUnit computeChildMarginValue(const Length& margin);
140     void prepareOrderIteratorAndMargins();
141     LayoutUnit adjustChildSizeForMinAndMax(const RenderBox&, LayoutUnit childSize);
142     LayoutUnit adjustChildSizeForAspectRatioCrossAxisMinAndMax(const RenderBox&, LayoutUnit childSize);
143     bool computeNextFlexLine(OrderedFlexItemList& orderedChildren, LayoutUnit& preferredMainAxisExtent, double& totalFlexGrow, double& totalWeightedFlexShrink, LayoutUnit& minMaxAppliedMainAxisExtent, bool& hasInfiniteLineLength);
144
145     bool resolveFlexibleLengths(FlexSign, const OrderedFlexItemList&, LayoutUnit& availableFreeSpace, double& totalFlexGrow, double& totalWeightedFlexShrink, InflexibleFlexItemSize&, Vector<LayoutUnit>& childSizes, bool hasInfiniteLineLength);
146     void freezeViolations(const Vector<Violation>&, LayoutUnit& availableFreeSpace, double& totalFlexGrow, double& totalWeightedFlexShrink, InflexibleFlexItemSize&, bool hasInfiniteLineLength);
147
148     void resetAutoMarginsAndLogicalTopInCrossAxis(RenderBox&);
149     bool needToStretchChild(RenderBox&);
150     void setLogicalOverrideSize(RenderBox& child, LayoutUnit childPreferredSize);
151     void prepareChildForPositionedLayout(RenderBox& child, LayoutUnit mainAxisOffset, LayoutUnit crossAxisOffset, PositionedLayoutMode);
152     size_t numberOfInFlowPositionedChildren(const OrderedFlexItemList&) const;
153     void layoutAndPlaceChildren(LayoutUnit& crossAxisOffset, const OrderedFlexItemList&, const Vector<LayoutUnit>& childSizes, LayoutUnit availableFreeSpace, bool relayoutChildren, Vector<LineContext>&);
154     void layoutColumnReverse(const OrderedFlexItemList&, LayoutUnit crossAxisOffset, LayoutUnit availableFreeSpace);
155     void alignFlexLines(Vector<LineContext>&);
156     void alignChildren(const Vector<LineContext>&);
157     void applyStretchAlignmentToChild(RenderBox&, LayoutUnit lineCrossAxisExtent);
158     void flipForRightToLeftColumn();
159     void flipForWrapReverse(const Vector<LineContext>&, LayoutUnit crossAxisStartEdge);
160
161     bool mainAxisLengthIsDefinite(const RenderBox&, const Length&) const;
162     bool crossAxisLengthIsDefinite(const RenderBox&, const Length&) const;
163     bool useChildAspectRatio(const RenderBox&) const;
164     Optional<LayoutUnit> computeMainSizeFromAspectRatioUsing(const RenderBox& child, Length crossSizeLength) const;
165     
166     virtual bool isFlexibleBoxImpl() const { return false; };
167
168     mutable OrderIterator m_orderIterator;
169     int m_numberOfInFlowChildrenOnFirstLine;
170 };
171
172 } // namespace WebCore
173
174 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderFlexibleBox, isFlexibleBox())