Source/WebCore:
[WebKit-https.git] / Source / WebCore / layout / floats / FloatingContext.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 "FloatingState.h"
31 #include "LayoutUnits.h"
32 #include <wtf/IsoMalloc.h>
33
34 namespace WebCore {
35
36 namespace Layout {
37
38 class FloatAvoider;
39 class Box;
40 class Container;
41 class FloatingPair;
42 class LayoutContext;
43
44 // FloatingContext is responsible for adjusting the position of a box in the current formatting context
45 // by taking the floating boxes into account.
46 class FloatingContext {
47     WTF_MAKE_ISO_ALLOCATED(FloatingContext);
48 public:
49     FloatingContext(FloatingState&);
50
51     FloatingState& floatingState() const { return m_floatingState; }
52
53     PointInContainingBlock positionForFloat(const Box&) const;
54     std::optional<PointInContainingBlock> positionForFloatAvoiding(const Box&) const;
55     std::optional<PositionInContainingBlock> verticalPositionWithClearance(const Box&) const;
56
57 private:
58     LayoutContext& layoutContext() const { return m_floatingState.layoutContext(); }
59
60     void floatingPosition(FloatAvoider&) const;
61
62     FloatingState& m_floatingState;
63 };
64
65 }
66 }
67 #endif