use main/cross instead of logical width/height when talking about flow 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 #if ENABLE(CSS3_FLEXBOX)
37
38 namespace WebCore {
39
40 class RenderFlexibleBox : public RenderBlock {
41 public:
42     RenderFlexibleBox(Node*);
43     virtual ~RenderFlexibleBox();
44
45     virtual const char* renderName() const;
46
47     virtual bool isFlexibleBox() const { return true; }
48
49     virtual void layoutBlock(bool relayoutChildren, int pageLogicalHeight = 0, BlockLayoutPass = NormalLayoutPass);
50
51 private:
52     class TreeOrderIterator;
53     class FlexOrderIterator;
54     typedef WTF::HashMap<const RenderBox*, LayoutUnit> InflexibleFlexItemSize;
55
56     bool hasOrthogonalFlow(RenderBox* child) const;
57     bool isColumnFlow() const;
58     bool isHorizontalFlow() const;
59     bool isLeftToRightFlow() const;
60     Length crossAxisLength() const;
61     Length mainAxisLengthForChild(RenderBox* child) const;
62     void setCrossAxisExtent(LayoutUnit);
63     LayoutUnit crossAxisExtentForChild(RenderBox* child);
64     LayoutUnit mainAxisExtentForChild(RenderBox* child);
65     LayoutUnit crossAxisExtent() const;
66     LayoutUnit mainAxisExtent() const;
67     LayoutUnit crossAxisContentExtent() const;
68     LayoutUnit mainAxisContentExtent() const;
69     WritingMode transformedWritingMode() const;
70     LayoutUnit flowAwareBorderStart() const;
71     LayoutUnit flowAwareBorderBefore() const;
72     LayoutUnit flowAwareBorderAfter() const;
73     LayoutUnit crossAxisBorderAndPaddingExtent() const;
74     LayoutUnit flowAwarePaddingStart() const;
75     LayoutUnit flowAwarePaddingBefore() const;
76     LayoutUnit flowAwarePaddingAfter() const;
77     LayoutUnit flowAwareMarginStartForChild(RenderBox* child) const;
78     LayoutUnit flowAwareMarginEndForChild(RenderBox* child) const;
79     LayoutUnit flowAwareMarginBeforeForChild(RenderBox* child) const;
80     LayoutUnit flowAwareMarginAfterForChild(RenderBox* child) const;
81     LayoutUnit crossAxisMarginExtentForChild(RenderBox* child) const;
82     LayoutPoint flowAwareLocationForChild(RenderBox* child) const;
83     void setFlowAwareMarginStartForChild(RenderBox* child, LayoutUnit);
84     void setFlowAwareMarginEndForChild(RenderBox* child, LayoutUnit);
85     // FIXME: Supporting layout deltas.
86     void setFlowAwareLocationForChild(RenderBox* child, const LayoutPoint&);
87     void adjustAlignmentForChild(RenderBox* child, LayoutUnit);
88     LayoutUnit mainAxisBorderAndPaddingExtentForChild(RenderBox* child) const;
89     LayoutUnit mainAxisScrollbarExtentForChild(RenderBox* child) const;
90     Length marginStartStyleForChild(RenderBox* child) const;
91     Length marginEndStyleForChild(RenderBox* child) const;
92     LayoutUnit preferredMainAxisContentExtentForFlexItem(RenderBox* child) const;
93
94     void layoutInlineDirection(bool relayoutChildren);
95
96     float positiveFlexForChild(RenderBox* child) const;
97     float negativeFlexForChild(RenderBox* child) const;
98
99     LayoutUnit availableAlignmentSpaceForChild(RenderBox*);
100     LayoutUnit marginBoxAscent(RenderBox*);
101
102     void computePreferredMainAxisExtent(bool relayoutChildren, TreeOrderIterator&, LayoutUnit&, float& totalPositiveFlexibility, float& totalNegativeFlexibility);
103     bool runFreeSpaceAllocationAlgorithmInlineDirection(FlexOrderIterator&, LayoutUnit& availableFreeSpace, float& totalPositiveFlexibility, float& totalNegativeFlexibility, InflexibleFlexItemSize&, WTF::Vector<LayoutUnit>& childSizes);
104     void setLogicalOverrideSize(RenderBox* child, LayoutUnit childPreferredSize);
105     void layoutAndPlaceChildrenInlineDirection(FlexOrderIterator&, const WTF::Vector<LayoutUnit>& childSizes, LayoutUnit availableFreeSpace, float totalPositiveFlexibility);
106     void alignChildrenBlockDirection(FlexOrderIterator&, LayoutUnit maxAscent);
107 };
108
109 } // namespace WebCore
110
111 #endif // ENABLE(CSS3_FLEXBOX)
112
113 #endif // RenderFlexibleBox_h