[LFC] Layout::Box::containingBlock should return a const ContainerBox&
[WebKit-https.git] / Source / WebCore / layout / floats / FloatingState.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 "LayoutContainerBox.h"
32 #include <wtf/IsoMalloc.h>
33 #include <wtf/Ref.h>
34 #include <wtf/WeakPtr.h>
35
36 namespace WebCore {
37
38 namespace Display {
39 class Box;
40 }
41
42 namespace Layout {
43
44 class Box;
45 class FloatingContext;
46 class LayoutState;
47
48 // FloatingState holds the floating boxes per formatting context.
49 class FloatingState : public RefCounted<FloatingState> {
50     WTF_MAKE_ISO_ALLOCATED(FloatingState);
51 public:
52     static Ref<FloatingState> create(LayoutState& layoutState, const ContainerBox& formattingContextRoot) { return adoptRef(*new FloatingState(layoutState, formattingContextRoot)); }
53
54     const ContainerBox& root() const { return *m_formattingContextRoot; }
55
56     Optional<PositionInContextRoot> top(const ContainerBox& formattingContextRoot) const;
57     Optional<PositionInContextRoot> leftBottom(const ContainerBox& formattingContextRoot) const;
58     Optional<PositionInContextRoot> rightBottom(const ContainerBox& formattingContextRoot) const;
59     Optional<PositionInContextRoot> bottom(const ContainerBox& formattingContextRoot) const;
60
61     class FloatItem {
62     public:
63         FloatItem(const Box&, Display::Box absoluteDisplayBox);
64
65         enum class Position { Left, Right };
66         FloatItem(Position, Display::Box absoluteDisplayBox);
67
68         bool isLeftPositioned() const { return m_position == Position::Left; }
69         bool isInFormattingContextOf(const ContainerBox& formattingContextRoot) const { return m_layoutBox->isInFormattingContextOf(formattingContextRoot); }
70
71         Display::Rect rectWithMargin() const { return m_absoluteDisplayBox.rectWithMargin(); }
72         UsedHorizontalMargin horizontalMargin() const { return m_absoluteDisplayBox.horizontalMargin(); }
73         PositionInContextRoot bottom() const { return { m_absoluteDisplayBox.bottom() }; }
74
75     private:
76         WeakPtr<const Box> m_layoutBox;
77         Position m_position;
78         Display::Box m_absoluteDisplayBox;
79     };
80     using FloatList = Vector<FloatItem>;
81     const FloatList& floats() const { return m_floats; }
82     const FloatItem* last() const { return floats().isEmpty() ? nullptr : &m_floats.last(); }
83
84     void append(FloatItem);
85     void clear() { m_floats.clear(); }
86
87 private:
88     friend class FloatingContext;
89     FloatingState(LayoutState&, const ContainerBox& formattingContextRoot);
90
91     LayoutState& layoutState() const { return m_layoutState; }
92
93     Optional<PositionInContextRoot> bottom(const ContainerBox& formattingContextRoot, Clear) const;
94
95     LayoutState& m_layoutState;
96     WeakPtr<const ContainerBox> m_formattingContextRoot;
97     FloatList m_floats;
98 };
99
100 inline Optional<PositionInContextRoot> FloatingState::leftBottom(const ContainerBox& formattingContextRoot) const
101
102     ASSERT(formattingContextRoot.establishesFormattingContext());
103     return bottom(formattingContextRoot, Clear::Left);
104 }
105
106 inline Optional<PositionInContextRoot> FloatingState::rightBottom(const ContainerBox& formattingContextRoot) const
107 {
108     ASSERT(formattingContextRoot.establishesFormattingContext());
109     return bottom(formattingContextRoot, Clear::Right);
110 }
111
112 inline Optional<PositionInContextRoot> FloatingState::bottom(const ContainerBox& formattingContextRoot) const
113 {
114     ASSERT(formattingContextRoot.establishesFormattingContext());
115     return bottom(formattingContextRoot, Clear::Both);
116 }
117
118 }
119 }
120 #endif