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