File: DisplayBox.h

package info (click to toggle)
webkit2gtk 2.42.2-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 362,452 kB
  • sloc: cpp: 2,881,971; javascript: 282,447; ansic: 134,088; python: 43,789; ruby: 18,308; perl: 15,872; asm: 14,389; xml: 4,395; yacc: 2,350; sh: 2,074; java: 1,734; lex: 1,323; makefile: 288; pascal: 60
file content (107 lines) | stat: -rw-r--r-- 4,264 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/*
 * Copyright (C) 2020 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include "DisplayGeometryTypes.h"
#include "DisplayStyle.h"
#include "FloatRect.h"
#include <wtf/IsoMalloc.h>
#include <wtf/OptionSet.h>

namespace WebCore {
namespace Display {

class ContainerBox;
class Tree;

DECLARE_ALLOCATOR_WITH_HEAP_IDENTIFIER(Box);
class Box {
    WTF_MAKE_FAST_ALLOCATED_WITH_HEAP_IDENTIFIER(Box);
public:
    enum class TypeFlags : uint8_t {
        BoxModelBox     = 1 << 0,
        ContainerBox    = 1 << 1,
        ImageBox        = 1 << 2,
        TextBox         = 1 << 3,
        LineBreakBox    = 1 << 4, // FIXME: Workaround for webkit.org/b/219335
    };

    enum class StyleFlags : uint8_t {
        HasTransform     = 1 << 0,
    };

    Box(Tree&, UnadjustedAbsoluteFloatRect, Style&&, OptionSet<TypeFlags> = { });
    virtual ~Box();

    const Style& style() const { return m_style; }

    UnadjustedAbsoluteFloatRect absoluteBoxRect() const { return m_absoluteBoxRect; }

    virtual UnadjustedAbsoluteFloatRect absolutePaintingExtent() const { return m_absoluteBoxRect; }

    bool isBoxModelBox() const { return m_typeFlags.contains(TypeFlags::BoxModelBox); }
    bool isContainerBox() const { return m_typeFlags.contains(TypeFlags::ContainerBox); }
    bool isImageBox() const { return m_typeFlags.contains(TypeFlags::ImageBox); }
    bool isReplacedBox() const { return m_typeFlags.contains(TypeFlags::ImageBox); /* and other types later. */ }
    bool isTextBox() const { return m_typeFlags.contains(TypeFlags::TextBox); }
    bool isLineBreakBox() const { return m_typeFlags.contains(TypeFlags::LineBreakBox); }

    bool participatesInZOrderSorting() const;

    ContainerBox* parent() const { return m_parent; }
    void setParent(ContainerBox* parent) { m_parent = parent; }

    const Box* nextSibling() const { return m_nextSibling.get(); }
    void setNextSibling(std::unique_ptr<Box>&&);

    // FIXME: we need to check this name is correct in light of https://bugs.webkit.org/show_bug.cgi?id=250901.
    void setHasTransform(bool value) { m_styleFlags.set(StyleFlags::HasTransform, value); }
    bool hasTransform() const { return m_styleFlags.contains(StyleFlags::HasTransform); }

    void setNeedsDisplay(std::optional<UnadjustedAbsoluteFloatRect> subrect = std::nullopt);

    virtual String debugDescription() const;

private:
    virtual const char* boxName() const;

    const Tree& m_tree;
    UnadjustedAbsoluteFloatRect m_absoluteBoxRect;
    Style m_style;
    ContainerBox* m_parent { nullptr };
    std::unique_ptr<Box> m_nextSibling;
    const OptionSet<TypeFlags> m_typeFlags;
    OptionSet<StyleFlags> m_styleFlags;
};

} // namespace Display
} // namespace WebCore

#define SPECIALIZE_TYPE_TRAITS_DISPLAY_BOX(ToValueTypeName, predicate) \
SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::Display::ToValueTypeName) \
    static bool isType(const WebCore::Display::Box& box) { return box.predicate; } \
SPECIALIZE_TYPE_TRAITS_END()