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