3a9e52a6b14c413d5e02be687b3a0217715bd8d0
[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 #include <wtf/OwnPtr.h>
36
37 namespace WebCore {
38
39 class RenderFlexibleBox : public RenderBlock {
40 public:
41     RenderFlexibleBox(Node*);
42     virtual ~RenderFlexibleBox();
43
44     virtual const char* renderName() const OVERRIDE;
45
46     virtual bool isFlexibleBox() const OVERRIDE { return true; }
47     virtual void computePreferredLogicalWidths() OVERRIDE;
48     virtual void layoutBlock(bool relayoutChildren, LayoutUnit pageLogicalHeight = 0) OVERRIDE;
49
50     virtual void paintChildren(PaintInfo& forSelf, const LayoutPoint&, PaintInfo& forChild, bool usePrintRect) OVERRIDE;
51
52     bool isHorizontalFlow() const;
53
54 private:
55     enum FlexSign {
56         PositiveFlexibility,
57         NegativeFlexibility,
58     };
59
60     enum PositionedLayoutMode {
61         FlipForRowReverse,
62         NoFlipForRowReverse,
63     };
64
65     struct OrderHashTraits;
66     typedef HashSet<int, DefaultHash<int>::Hash, OrderHashTraits> OrderHashSet;
67
68     class OrderIterator;
69     typedef WTF::HashMap<const RenderBox*, LayoutUnit> InflexibleFlexItemSize;
70     typedef WTF::Vector<RenderBox*> OrderedFlexItemList;
71
72     struct LineContext;
73     struct Violation;
74
75     bool hasOrthogonalFlow(RenderBox* child) const;
76     bool isColumnFlow() const;
77     bool isLeftToRightFlow() const;
78     bool isMultiline() const;
79     Length crossAxisLength() const;
80     Length flexBasisForChild(RenderBox* child) const;
81     void setCrossAxisExtent(LayoutUnit);
82     LayoutUnit crossAxisExtentForChild(RenderBox* child);
83     LayoutUnit mainAxisExtentForChild(RenderBox* child);
84     LayoutUnit crossAxisExtent() const;
85     LayoutUnit mainAxisExtent() const;
86     LayoutUnit crossAxisContentExtent() const;
87     LayoutUnit mainAxisContentExtent();
88     WritingMode transformedWritingMode() const;
89     LayoutUnit flowAwareBorderStart() const;
90     LayoutUnit flowAwareBorderEnd() const;
91     LayoutUnit flowAwareBorderBefore() const;
92     LayoutUnit flowAwareBorderAfter() const;
93     LayoutUnit flowAwarePaddingStart() const;
94     LayoutUnit flowAwarePaddingEnd() const;
95     LayoutUnit flowAwarePaddingBefore() const;
96     LayoutUnit flowAwarePaddingAfter() const;
97     LayoutUnit flowAwareMarginStartForChild(RenderBox* child) const;
98     LayoutUnit flowAwareMarginEndForChild(RenderBox* child) const;
99     LayoutUnit flowAwareMarginBeforeForChild(RenderBox* child) const;
100     LayoutUnit flowAwareMarginAfterForChild(RenderBox* child) const;
101     LayoutUnit crossAxisMarginExtentForChild(RenderBox* child) const;
102     LayoutUnit crossAxisScrollbarExtent() const;
103     LayoutPoint flowAwareLocationForChild(RenderBox* child) const;
104     // FIXME: Supporting layout deltas.
105     void setFlowAwareLocationForChild(RenderBox* child, const LayoutPoint&);
106     void adjustAlignmentForChild(RenderBox* child, LayoutUnit);
107     LayoutUnit mainAxisBorderAndPaddingExtentForChild(RenderBox* child) const;
108     LayoutUnit mainAxisScrollbarExtentForChild(RenderBox* child) const;
109     LayoutUnit preferredMainAxisContentExtentForChild(RenderBox* child);
110
111     void layoutFlexItems(OrderIterator&, WTF::Vector<LineContext>&);
112     LayoutUnit autoMarginOffsetInMainAxis(const OrderedFlexItemList&, LayoutUnit& availableFreeSpace);
113     void updateAutoMarginsInMainAxis(RenderBox* child, LayoutUnit autoMarginOffset);
114     bool hasAutoMarginsInCrossAxis(RenderBox* child);
115     bool updateAutoMarginsInCrossAxis(RenderBox* child, LayoutUnit availableAlignmentSpace);
116     void repositionLogicalHeightDependentFlexItems(OrderIterator&, WTF::Vector<LineContext>&, LayoutUnit& oldClientAfterEdge);
117
118     LayoutUnit availableAlignmentSpaceForChild(LayoutUnit lineCrossAxisExtent, RenderBox*);
119     LayoutUnit marginBoxAscentForChild(RenderBox*);
120
121     void computeMainAxisPreferredSizes(bool relayoutChildren, OrderHashSet&);
122     LayoutUnit lineBreakLength();
123     LayoutUnit adjustChildSizeForMinAndMax(RenderBox*, LayoutUnit childSize, LayoutUnit flexboxAvailableContentExtent);
124     bool computeNextFlexLine(OrderIterator&, OrderedFlexItemList& orderedChildren, LayoutUnit& preferredMainAxisExtent, float& totalFlexGrow, float& totalWeightedFlexShrink, LayoutUnit& minMaxAppliedMainAxisExtent);
125     LayoutUnit computeAvailableFreeSpace(LayoutUnit preferredMainAxisExtent);
126
127     bool resolveFlexibleLengths(FlexSign, const OrderedFlexItemList&, LayoutUnit& availableFreeSpace, float& totalFlexGrow, float& totalWeightedFlexShrink, InflexibleFlexItemSize&, WTF::Vector<LayoutUnit>& childSizes);
128     void freezeViolations(const WTF::Vector<Violation>&, LayoutUnit& availableFreeSpace, float& totalFlexGrow, float& totalWeightedFlexShrink, InflexibleFlexItemSize&);
129
130     void setLogicalOverrideSize(RenderBox* child, LayoutUnit childPreferredSize);
131     void prepareChildForPositionedLayout(RenderBox* child, LayoutUnit mainAxisOffset, LayoutUnit crossAxisOffset, PositionedLayoutMode);
132     void layoutAndPlaceChildren(LayoutUnit& crossAxisOffset, const OrderedFlexItemList&, const WTF::Vector<LayoutUnit>& childSizes, LayoutUnit availableFreeSpace, WTF::Vector<LineContext>&);
133     void layoutColumnReverse(const OrderedFlexItemList&, const WTF::Vector<LayoutUnit>& childSizes, LayoutUnit crossAxisOffset, LayoutUnit availableFreeSpace);
134     void alignFlexLines(OrderIterator&, WTF::Vector<LineContext>&);
135     void alignChildren(OrderIterator&, const WTF::Vector<LineContext>&);
136     void applyStretchAlignmentToChild(RenderBox*, LayoutUnit lineCrossAxisExtent);
137     void flipForRightToLeftColumn(OrderIterator&);
138     void flipForWrapReverse(OrderIterator&, const WTF::Vector<LineContext>&, LayoutUnit crossAxisStartEdge);
139
140     OwnPtr<OrderIterator> m_orderIterator;
141 };
142
143 } // namespace WebCore
144
145 #endif // RenderFlexibleBox_h