11c7717d119dedadd7475e2e104c5c4ed92837b6
[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 "FloatingState.h"
32 #include <wtf/IsoMalloc.h>
33 #include <wtf/WeakPtr.h>
34
35 namespace WebCore {
36
37 class LayoutPoint;
38 class LayoutUnit;
39
40 namespace Layout {
41
42 class Box;
43 class Container;
44 class FormattingState;
45 class LayoutContext;
46
47 class FormattingContext {
48     WTF_MAKE_ISO_ALLOCATED(FormattingContext);
49 public:
50     FormattingContext(const Box& formattingContextRoot);
51     virtual ~FormattingContext();
52
53     virtual void layout(LayoutContext&, FormattingState&) const = 0;
54     void layoutOutOfFlowDescendants(LayoutContext&, const Box&) const;
55
56     struct InstrinsicWidthConstraints {
57         LayoutUnit minimum;
58         LayoutUnit maximum;
59     };
60     virtual InstrinsicWidthConstraints instrinsicWidthConstraints(LayoutContext&, const Box&) const = 0;
61
62     static Display::Box mapBoxToAncestor(const LayoutContext&, const Box&, const Container& ancestor);
63     static Position mapTopLeftToAncestor(const LayoutContext&, const Box&, const Container& ancestor);
64     static Position mapCoordinateToAncestor(const LayoutContext&, Position, const Container& containingBlock, const Container& ancestor);
65
66 protected:
67     struct BoxPair {
68         const Box& layout;
69         Display::Box& display;
70     };
71     using LayoutQueue = Vector<std::unique_ptr<BoxPair>>;
72
73     const Box& root() const { return *m_root; }
74
75     virtual void computeStaticPosition(LayoutContext&, const Box&, Display::Box&) const = 0;
76     virtual void computeInFlowPositionedPosition(LayoutContext&, const Box&, Display::Box&) const = 0;
77
78     void computeBorderAndPadding(LayoutContext&, const Box&, Display::Box&) const;
79
80     void placeInFlowPositionedChildren(LayoutContext&, const Container&) const;
81
82 #ifndef NDEBUG
83     virtual void validateGeometryConstraintsAfterLayout(const LayoutContext&) const;
84 #endif
85
86     // This class implements generic positioning and sizing.
87     class Geometry {
88     public:
89         static VerticalGeometry outOfFlowVerticalGeometry(LayoutContext&, const Box&);
90         static HorizontalGeometry outOfFlowHorizontalGeometry(LayoutContext&, const FormattingContext&, const Box&);
91
92         static HeightAndMargin floatingHeightAndMargin(LayoutContext&, const Box&);
93         static WidthAndMargin floatingWidthAndMargin(LayoutContext&, const FormattingContext&, const Box&);
94
95         static HeightAndMargin inlineReplacedHeightAndMargin(LayoutContext&, const Box&);
96         static WidthAndMargin inlineReplacedWidthAndMargin(LayoutContext&, const Box&, std::optional<LayoutUnit> precomputedMarginLeft = { },
97             std::optional<LayoutUnit> precomputedMarginRight = { });
98
99         static HeightAndMargin complicatedCases(LayoutContext&, const Box&);
100
101         static Edges computedBorder(LayoutContext&, const Box&);
102         static std::optional<Edges> computedPadding(LayoutContext&, const Box&);
103
104         static HorizontalEdges computedNonCollapsedHorizontalMarginValue(const LayoutContext&, const Box&);
105         static VerticalEdges computedNonCollapsedVerticalMarginValue(const LayoutContext&, const Box&);
106
107         static std::optional<LayoutUnit> computedValueIfNotAuto(const Length& geometryProperty, LayoutUnit containingBlockWidth);
108         static std::optional<LayoutUnit> fixedValue(const Length& geometryProperty);
109
110     private:
111         static VerticalGeometry outOfFlowReplacedVerticalGeometry(LayoutContext&, const Box&);
112         static HorizontalGeometry outOfFlowReplacedHorizontalGeometry(LayoutContext&, const Box&);
113
114         static VerticalGeometry outOfFlowNonReplacedVerticalGeometry(LayoutContext&, const Box&);
115         static HorizontalGeometry outOfFlowNonReplacedHorizontalGeometry(LayoutContext&, const FormattingContext&, const Box&);
116
117         static HeightAndMargin floatingReplacedHeightAndMargin(LayoutContext&, const Box&);
118         static WidthAndMargin floatingReplacedWidthAndMargin(LayoutContext&, const Box&);
119
120         static WidthAndMargin floatingNonReplacedWidthAndMargin(LayoutContext&, const FormattingContext&, const Box&);
121
122         static LayoutUnit shrinkToFitWidth(LayoutContext&, const FormattingContext&, const Box&);
123     };
124
125 private:
126     void computeOutOfFlowVerticalGeometry(LayoutContext&, const Box&, Display::Box&) const;
127     void computeOutOfFlowHorizontalGeometry(LayoutContext&, const Box&, Display::Box&) const;
128
129     WeakPtr<Box> m_root;
130 };
131
132 }
133 }
134 #endif