d78f97f74b1099ebd2b49ceba08b457ff7e0e28e
[WebKit-https.git] / Source / WebCore / layout / FormattingContext.h
1 /*
2  * Copyright (C) 2018 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(LAYOUT_FORMATTING_CONTEXT)
29
30 #include "DisplayBox.h"
31 #include <wtf/IsoMalloc.h>
32 #include <wtf/WeakPtr.h>
33
34 namespace WebCore {
35
36 class LayoutPoint;
37 class LayoutUnit;
38
39 namespace Layout {
40
41 class Box;
42 class Container;
43 class FormattingState;
44 class LayoutState;
45
46 class FormattingContext {
47     WTF_MAKE_ISO_ALLOCATED(FormattingContext);
48 public:
49     FormattingContext(const Box& formattingContextRoot, FormattingState&);
50     virtual ~FormattingContext();
51
52     virtual void layout() const = 0;
53     void layoutOutOfFlowDescendants(const Box&) const;
54
55     struct InstrinsicWidthConstraints {
56         LayoutUnit minimum;
57         LayoutUnit maximum;
58     };
59     virtual InstrinsicWidthConstraints instrinsicWidthConstraints() const = 0;
60
61     static Display::Box mapBoxToAncestor(const LayoutState&, const Box&, const Container& ancestor);
62     static Position mapTopLeftToAncestor(const LayoutState&, const Box&, const Container& ancestor);
63     static Position mapCoordinateToAncestor(const LayoutState&, Position, const Container& containingBlock, const Container& ancestor);
64
65 protected:
66     using LayoutQueue = Vector<const Box*>;
67
68     FormattingState& formattingState() const;
69     LayoutState& layoutState() const;
70     const Box& root() const { return *m_root; }
71
72     virtual void computeStaticPosition(const Box&) const = 0;
73     virtual void computeInFlowPositionedPosition(const Box&) const = 0;
74
75     void computeBorderAndPadding(const Box&) const;
76
77     void placeInFlowPositionedChildren(const Container&) const;
78
79 #ifndef NDEBUG
80     virtual void validateGeometryConstraintsAfterLayout() const;
81 #endif
82
83     // This class implements generic positioning and sizing.
84     class Geometry {
85     public:
86         static VerticalGeometry outOfFlowVerticalGeometry(const LayoutState&, const Box&, std::optional<LayoutUnit> usedHeight = { });
87         static HorizontalGeometry outOfFlowHorizontalGeometry(LayoutState&, const Box&, std::optional<LayoutUnit> usedWidth = { });
88
89         static HeightAndMargin floatingHeightAndMargin(const LayoutState&, const Box&, std::optional<LayoutUnit> usedHeight = { });
90         static WidthAndMargin floatingWidthAndMargin(LayoutState&, const Box&, std::optional<LayoutUnit> usedWidth = { });
91
92         static HeightAndMargin inlineReplacedHeightAndMargin(const LayoutState&, const Box&, std::optional<LayoutUnit> usedHeight = { });
93         static WidthAndMargin inlineReplacedWidthAndMargin(const LayoutState&, const Box&, std::optional<LayoutUnit> usedWidth = { }, 
94             std::optional<LayoutUnit> precomputedMarginLeft = { }, std::optional<LayoutUnit> precomputedMarginRight = { });
95
96         static HeightAndMargin complicatedCases(const LayoutState&, const Box&, std::optional<LayoutUnit> usedHeight = { });
97         static LayoutUnit shrinkToFitWidth(LayoutState&, const Box&);
98
99         static Edges computedBorder(const LayoutState&, const Box&);
100         static std::optional<Edges> computedPadding(const LayoutState&, const Box&);
101
102         static HorizontalEdges computedNonCollapsedHorizontalMarginValue(const LayoutState&, const Box&);
103         static VerticalEdges computedNonCollapsedVerticalMarginValue(const LayoutState&, const Box&);
104
105         static std::optional<LayoutUnit> computedValueIfNotAuto(const Length& geometryProperty, LayoutUnit containingBlockWidth);
106         static std::optional<LayoutUnit> fixedValue(const Length& geometryProperty);
107
108         static std::optional<LayoutUnit> computedMinHeight(const LayoutState&, const Box&);
109         static std::optional<LayoutUnit> computedMaxHeight(const LayoutState&, const Box&);
110
111     private:
112         static VerticalGeometry outOfFlowReplacedVerticalGeometry(const LayoutState&, const Box&, std::optional<LayoutUnit> usedHeight = { });
113         static HorizontalGeometry outOfFlowReplacedHorizontalGeometry(const LayoutState&, const Box&, std::optional<LayoutUnit> usedWidth = { });
114
115         static VerticalGeometry outOfFlowNonReplacedVerticalGeometry(const LayoutState&, const Box&, std::optional<LayoutUnit> usedHeight = { });
116         static HorizontalGeometry outOfFlowNonReplacedHorizontalGeometry(LayoutState&, const Box&, std::optional<LayoutUnit> usedWidth = { });
117
118         static HeightAndMargin floatingReplacedHeightAndMargin(const LayoutState&, const Box&, std::optional<LayoutUnit> usedHeight = { });
119         static WidthAndMargin floatingReplacedWidthAndMargin(const LayoutState&, const Box&, std::optional<LayoutUnit> usedWidth = { });
120
121         static WidthAndMargin floatingNonReplacedWidthAndMargin(LayoutState&, const Box&, std::optional<LayoutUnit> usedWidth = { });
122     };
123
124 private:
125     void computeOutOfFlowVerticalGeometry(const Box&) const;
126     void computeOutOfFlowHorizontalGeometry(const Box&) const;
127
128     WeakPtr<const Box> m_root;
129     FormattingState& m_formattingState;
130 };
131
132 }
133 }
134 #endif