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