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