Unreviewed, rolling out r157916.
[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 #ifndef RenderFlexibleBox_h
32 #define RenderFlexibleBox_h
33
34 #include "RenderBlock.h"
35
36 namespace WebCore {
37
38 class RenderFlexibleBox : public RenderBlock {
39 public:
40     explicit RenderFlexibleBox(Element&);
41     explicit RenderFlexibleBox(Document&);
42     virtual ~RenderFlexibleBox();
43
44     virtual const char* renderName() const OVERRIDE;
45
46     virtual bool isFlexibleBox() const OVERRIDE FINAL { return true; }
47     virtual bool avoidsFloats() const OVERRIDE FINAL { return true; }
48     virtual bool canCollapseAnonymousBlockChild() const OVERRIDE FINAL { return false; }
49     virtual void layoutBlock(bool relayoutChildren, LayoutUnit pageLogicalHeight = 0) OVERRIDE FINAL;
50
51     virtual int baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const OVERRIDE;
52     virtual int firstLineBaseline() const OVERRIDE;
53     virtual int inlineBlockBaseline(LineDirectionMode) const OVERRIDE;
54
55     virtual void paintChildren(PaintInfo& forSelf, const LayoutPoint&, PaintInfo& forChild, bool usePrintRect) OVERRIDE;
56
57     bool isHorizontalFlow() const;
58
59 protected:
60     virtual void computeIntrinsicLogicalWidths(LayoutUnit& minLogicalWidth, LayoutUnit& maxLogicalWidth) const OVERRIDE;
61     virtual void computePreferredLogicalWidths() OVERRIDE;
62
63     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle) OVERRIDE;
64
65 private:
66     enum FlexSign {
67         PositiveFlexibility,
68         NegativeFlexibility,
69     };
70
71     enum PositionedLayoutMode {
72         FlipForRowReverse,
73         NoFlipForRowReverse,
74     };
75
76     struct OrderHashTraits;
77     typedef HashSet<int, DefaultHash<int>::Hash, OrderHashTraits> OrderHashSet;
78
79     class OrderIterator {
80         WTF_MAKE_NONCOPYABLE(OrderIterator);
81     public:
82         OrderIterator(const RenderFlexibleBox*);
83         void setOrderValues(const OrderHashSet&);
84         RenderBox* currentChild() const { return m_currentChild; }
85         RenderBox* first();
86         RenderBox* next();
87         void reset();
88
89     private:
90         const RenderFlexibleBox* m_flexibleBox;
91         RenderBox* m_currentChild;
92         Vector<int> m_orderValues;
93         Vector<int>::const_iterator m_orderValuesIterator;
94     };
95
96     typedef HashMap<const RenderBox*, LayoutUnit> InflexibleFlexItemSize;
97     typedef Vector<RenderBox*> OrderedFlexItemList;
98
99     struct LineContext;
100     struct Violation;
101
102     // Use an inline capacity of 8, since flexbox containers usually have less than 8 children.
103     typedef Vector<LayoutRect, 8> ChildFrameRects;
104
105     bool hasOrthogonalFlow(RenderBox& child) const;
106     bool isColumnFlow() const;
107     bool isLeftToRightFlow() const;
108     bool isMultiline() const;
109     Length flexBasisForChild(RenderBox& child) const;
110     void setCrossAxisExtent(LayoutUnit);
111     LayoutUnit crossAxisExtentForChild(RenderBox& child) const;
112     LayoutUnit mainAxisExtentForChild(RenderBox& child) const;
113     LayoutUnit crossAxisExtent() const;
114     LayoutUnit mainAxisExtent() const;
115     LayoutUnit crossAxisContentExtent() const;
116     LayoutUnit mainAxisContentExtent(LayoutUnit contentLogicalHeight);
117     LayoutUnit computeMainAxisExtentForChild(RenderBox& child, SizeType, const Length& size);
118     WritingMode transformedWritingMode() const;
119     LayoutUnit flowAwareBorderStart() const;
120     LayoutUnit flowAwareBorderEnd() const;
121     LayoutUnit flowAwareBorderBefore() const;
122     LayoutUnit flowAwareBorderAfter() const;
123     LayoutUnit flowAwarePaddingStart() const;
124     LayoutUnit flowAwarePaddingEnd() const;
125     LayoutUnit flowAwarePaddingBefore() const;
126     LayoutUnit flowAwarePaddingAfter() const;
127     LayoutUnit flowAwareMarginStartForChild(RenderBox& child) const;
128     LayoutUnit flowAwareMarginEndForChild(RenderBox& child) const;
129     LayoutUnit flowAwareMarginBeforeForChild(RenderBox& child) const;
130     LayoutUnit flowAwareMarginAfterForChild(RenderBox& child) const;
131     LayoutUnit crossAxisMarginExtentForChild(RenderBox& child) const;
132     LayoutUnit crossAxisScrollbarExtent() const;
133     LayoutPoint flowAwareLocationForChild(RenderBox& child) const;
134     // FIXME: Supporting layout deltas.
135     void setFlowAwareLocationForChild(RenderBox& child, const LayoutPoint&);
136     void adjustAlignmentForChild(RenderBox& child, LayoutUnit);
137     EAlignItems alignmentForChild(RenderBox& child) const;
138     LayoutUnit mainAxisBorderAndPaddingExtentForChild(RenderBox& child) const;
139     LayoutUnit mainAxisScrollbarExtentForChild(RenderBox& child) const;
140     LayoutUnit preferredMainAxisContentExtentForChild(RenderBox& child, bool hasInfiniteLineLength);
141
142     void layoutFlexItems(bool relayoutChildren, Vector<LineContext>&);
143     LayoutUnit autoMarginOffsetInMainAxis(const OrderedFlexItemList&, LayoutUnit& availableFreeSpace);
144     void updateAutoMarginsInMainAxis(RenderBox& child, LayoutUnit autoMarginOffset);
145     bool hasAutoMarginsInCrossAxis(RenderBox& child) const;
146     bool updateAutoMarginsInCrossAxis(RenderBox& child, LayoutUnit availableAlignmentSpace);
147     void repositionLogicalHeightDependentFlexItems(Vector<LineContext>&);
148     LayoutUnit clientLogicalBottomAfterRepositioning();
149     void appendChildFrameRects(ChildFrameRects&);
150     void repaintChildrenDuringLayoutIfMoved(const ChildFrameRects&);
151
152     LayoutUnit availableAlignmentSpaceForChild(LayoutUnit lineCrossAxisExtent, RenderBox&);
153     LayoutUnit marginBoxAscentForChild(RenderBox&);
154
155     LayoutUnit computeChildMarginValue(const Length& margin);
156     void computeMainAxisPreferredSizes(OrderHashSet&);
157     LayoutUnit adjustChildSizeForMinAndMax(RenderBox&, LayoutUnit childSize);
158     bool computeNextFlexLine(OrderedFlexItemList& orderedChildren, LayoutUnit& preferredMainAxisExtent, double& totalFlexGrow, double& totalWeightedFlexShrink, LayoutUnit& minMaxAppliedMainAxisExtent, bool& hasInfiniteLineLength);
159
160     bool resolveFlexibleLengths(FlexSign, const OrderedFlexItemList&, LayoutUnit& availableFreeSpace, double& totalFlexGrow, double& totalWeightedFlexShrink, InflexibleFlexItemSize&, Vector<LayoutUnit>& childSizes, bool hasInfiniteLineLength);
161     void freezeViolations(const Vector<Violation>&, LayoutUnit& availableFreeSpace, double& totalFlexGrow, double& totalWeightedFlexShrink, InflexibleFlexItemSize&, bool hasInfiniteLineLength);
162
163     void resetAutoMarginsAndLogicalTopInCrossAxis(RenderBox&);
164     bool needToStretchChild(RenderBox&);
165     void setLogicalOverrideSize(RenderBox& child, LayoutUnit childPreferredSize);
166     void prepareChildForPositionedLayout(RenderBox& child, LayoutUnit mainAxisOffset, LayoutUnit crossAxisOffset, PositionedLayoutMode);
167     size_t numberOfInFlowPositionedChildren(const OrderedFlexItemList&) const;
168     void layoutAndPlaceChildren(LayoutUnit& crossAxisOffset, const OrderedFlexItemList&, const Vector<LayoutUnit>& childSizes, LayoutUnit availableFreeSpace, bool relayoutChildren, Vector<LineContext>&);
169     void layoutColumnReverse(const OrderedFlexItemList&, LayoutUnit crossAxisOffset, LayoutUnit availableFreeSpace);
170     void alignFlexLines(Vector<LineContext>&);
171     void alignChildren(const Vector<LineContext>&);
172     void applyStretchAlignmentToChild(RenderBox&, LayoutUnit lineCrossAxisExtent);
173     void flipForRightToLeftColumn();
174     void flipForWrapReverse(const Vector<LineContext>&, LayoutUnit crossAxisStartEdge);
175
176     mutable OrderIterator m_orderIterator;
177     int m_numberOfInFlowChildrenOnFirstLine;
178 };
179
180 RENDER_OBJECT_TYPE_CASTS(RenderFlexibleBox, isFlexibleBox())
181
182 } // namespace WebCore
183
184 #endif // RenderFlexibleBox_h