auto margins on flexbox should allocate space in the cross direction
[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     struct FlexOrderHashTraits;
58     typedef HashSet<int, DefaultHash<int>::Hash, FlexOrderHashTraits> FlexOrderHashSet;
59
60     class FlexOrderIterator;
61     typedef WTF::HashMap<const RenderBox*, LayoutUnit> InflexibleFlexItemSize;
62     typedef WTF::Vector<RenderBox*> OrderedFlexItemList;
63
64     struct LineContext;
65     struct Violation;
66
67     bool hasOrthogonalFlow(RenderBox* child) const;
68     bool isColumnFlow() const;
69     bool isLeftToRightFlow() const;
70     bool isMultiline() const;
71     Length crossAxisLength() const;
72     Length preferredLengthForChild(RenderBox* child) const;
73     void setCrossAxisExtent(LayoutUnit);
74     LayoutUnit crossAxisExtentForChild(RenderBox* child);
75     LayoutUnit mainAxisExtentForChild(RenderBox* child);
76     LayoutUnit crossAxisExtent() const;
77     LayoutUnit mainAxisExtent() const;
78     LayoutUnit crossAxisContentExtent() const;
79     LayoutUnit mainAxisContentExtent() const;
80     WritingMode transformedWritingMode() const;
81     LayoutUnit flowAwareBorderStart() const;
82     LayoutUnit flowAwareBorderEnd() const;
83     LayoutUnit flowAwareBorderBefore() const;
84     LayoutUnit flowAwareBorderAfter() const;
85     LayoutUnit flowAwarePaddingStart() const;
86     LayoutUnit flowAwarePaddingEnd() const;
87     LayoutUnit flowAwarePaddingBefore() const;
88     LayoutUnit flowAwarePaddingAfter() const;
89     LayoutUnit flowAwareMarginStartForChild(RenderBox* child) const;
90     LayoutUnit flowAwareMarginEndForChild(RenderBox* child) const;
91     LayoutUnit flowAwareMarginBeforeForChild(RenderBox* child) const;
92     LayoutUnit flowAwareMarginAfterForChild(RenderBox* child) const;
93     LayoutUnit crossAxisMarginExtentForChild(RenderBox* child) const;
94     LayoutUnit crossAxisScrollbarExtent() const;
95     LayoutPoint flowAwareLocationForChild(RenderBox* child) const;
96     // FIXME: Supporting layout deltas.
97     void setFlowAwareLocationForChild(RenderBox* child, const LayoutPoint&);
98     void adjustAlignmentForChild(RenderBox* child, LayoutUnit);
99     LayoutUnit mainAxisBorderAndPaddingExtentForChild(RenderBox* child) const;
100     LayoutUnit mainAxisScrollbarExtentForChild(RenderBox* child) const;
101     LayoutUnit preferredMainAxisContentExtentForChild(RenderBox* child) const;
102
103     void layoutFlexItems(FlexOrderIterator&, WTF::Vector<LineContext>&);
104     LayoutUnit autoMarginOffsetInMainAxis(const OrderedFlexItemList&, LayoutUnit& availableFreeSpace);
105     void updateAutoMarginsInMainAxis(RenderBox* child, LayoutUnit autoMarginOffset);
106     bool hasAutoMarginsInCrossAxis(RenderBox* child);
107     bool updateAutoMarginsInCrossAxis(RenderBox* child, LayoutUnit availableAlignmentSpace);
108     void repositionLogicalHeightDependentFlexItems(FlexOrderIterator&, WTF::Vector<LineContext>&, LayoutUnit& oldClientAfterEdge);
109
110     LayoutUnit availableAlignmentSpaceForChild(LayoutUnit lineCrossAxisExtent, RenderBox*);
111     LayoutUnit marginBoxAscentForChild(RenderBox*);
112
113     void computeMainAxisPreferredSizes(bool relayoutChildren, FlexOrderHashSet&);
114     LayoutUnit lineBreakLength();
115     LayoutUnit adjustChildSizeForMinAndMax(RenderBox*, LayoutUnit childSize, LayoutUnit flexboxAvailableContentExtent);
116     bool computeNextFlexLine(FlexOrderIterator&, OrderedFlexItemList& orderedChildren, LayoutUnit& preferredMainAxisExtent, float& totalPositiveFlexibility, float& totalNegativeFlexibility, LayoutUnit& minMaxAppliedMainAxisExtent);
117     LayoutUnit computeAvailableFreeSpace(LayoutUnit preferredMainAxisExtent);
118
119     bool resolveFlexibleLengths(FlexSign, const OrderedFlexItemList&, LayoutUnit& availableFreeSpace, float& totalPositiveFlexibility, float& totalNegativeFlexibility, InflexibleFlexItemSize&, WTF::Vector<LayoutUnit>& childSizes);
120     void freezeViolations(const WTF::Vector<Violation>&, LayoutUnit& availableFreeSpace, float& totalPositiveFlexibility, float& totalNegativeFlexibility, InflexibleFlexItemSize&);
121
122     void setLogicalOverrideSize(RenderBox* child, LayoutUnit childPreferredSize);
123     void prepareChildForPositionedLayout(RenderBox* child, LayoutUnit mainAxisOffset, LayoutUnit crossAxisOffset);
124     void layoutAndPlaceChildren(LayoutUnit& crossAxisOffset, const OrderedFlexItemList&, const WTF::Vector<LayoutUnit>& childSizes, LayoutUnit availableFreeSpace, WTF::Vector<LineContext>&);
125     void layoutColumnReverse(const OrderedFlexItemList&, const WTF::Vector<LayoutUnit>& childSizes, LayoutUnit crossAxisOffset, LayoutUnit availableFreeSpace);
126     void packFlexLines(FlexOrderIterator&, WTF::Vector<LineContext>&);
127     void alignChildren(FlexOrderIterator&, const WTF::Vector<LineContext>&);
128     void applyStretchAlignmentToChild(RenderBox*, LayoutUnit lineCrossAxisExtent);
129     void flipForRightToLeftColumn(FlexOrderIterator&);
130     void flipForWrapReverse(FlexOrderIterator&, const WTF::Vector<LineContext>&, LayoutUnit crossAxisStartEdge);
131 };
132
133 } // namespace WebCore
134
135 #endif // RenderFlexibleBox_h