Introduce RenderTreeBuilder
[WebKit-https.git] / Source / WebCore / rendering / svg / RenderSVGRoot.h
1 /*
2  * Copyright (C) 2004, 2005, 2007 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2004, 2005, 2007 Rob Buis <buis@kde.org>
4  * Copyright (C) 2009 Google, Inc.  All rights reserved.
5  * Copyright (C) 2009 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #pragma once
24
25 #include "FloatRect.h"
26 #include "RenderReplaced.h"
27 #include "SVGRenderSupport.h"
28
29 namespace WebCore {
30
31 class AffineTransform;
32 class RenderSVGResourceContainer;
33 class SVGSVGElement;
34
35 class RenderSVGRoot final : public RenderReplaced {
36     WTF_MAKE_ISO_ALLOCATED(RenderSVGRoot);
37 public:
38     RenderSVGRoot(SVGSVGElement&, RenderStyle&&);
39     virtual ~RenderSVGRoot();
40
41     SVGSVGElement& svgSVGElement() const;
42
43     bool isEmbeddedThroughSVGImage() const;
44     bool isEmbeddedThroughFrameContainingSVGDocument() const;
45
46     void computeIntrinsicRatioInformation(FloatSize& intrinsicSize, double& intrinsicRatio) const override;
47
48     bool isLayoutSizeChanged() const { return m_isLayoutSizeChanged; }
49     void setNeedsBoundariesUpdate() override { m_needsBoundariesOrTransformUpdate = true; }
50     bool needsBoundariesUpdate() override { return m_needsBoundariesOrTransformUpdate; }
51     void setNeedsTransformUpdate() override { m_needsBoundariesOrTransformUpdate = true; }
52
53     IntSize containerSize() const { return m_containerSize; }
54     void setContainerSize(const IntSize& containerSize) { m_containerSize = containerSize; }
55
56     bool hasRelativeDimensions() const override;
57
58     // localToBorderBoxTransform maps local SVG viewport coordinates to local CSS box coordinates.  
59     const AffineTransform& localToBorderBoxTransform() const { return m_localToBorderBoxTransform; }
60
61     // The flag is cleared at the beginning of each layout() pass. Elements then call this
62     // method during layout when they are invalidated by a filter.
63     static void addResourceForClientInvalidation(RenderSVGResourceContainer*);
64
65     bool hasSVGShadow() const { return m_hasSVGShadow; }
66     void setHasSVGShadow(bool hasShadow) { m_hasSVGShadow = hasShadow; }
67
68 private:
69     void element() const = delete;
70
71     bool isSVGRoot() const override { return true; }
72     const char* renderName() const override { return "RenderSVGRoot"; }
73
74     LayoutUnit computeReplacedLogicalWidth(ShouldComputePreferred  = ComputeActual) const override;
75     LayoutUnit computeReplacedLogicalHeight(std::optional<LayoutUnit> estimatedUsedWidth = std::nullopt) const override;
76     void layout() override;
77     void paintReplaced(PaintInfo&, const LayoutPoint&) override;
78
79     void willBeDestroyed() override;
80
81     void insertedIntoTree() override;
82     void willBeRemovedFromTree() override;
83
84     void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
85     void addChild(RenderTreeBuilder&, RenderPtr<RenderObject> child, RenderObject* beforeChild = 0) override;
86     RenderPtr<RenderObject> takeChild(RenderObject&) override;
87
88     const AffineTransform& localToParentTransform() const override;
89
90     bool fillContains(const FloatPoint&) const;
91     bool strokeContains(const FloatPoint&) const;
92
93     FloatRect objectBoundingBox() const override { return m_objectBoundingBox; }
94     FloatRect strokeBoundingBox() const override { return m_strokeBoundingBox; }
95     FloatRect repaintRectInLocalCoordinates() const override { return m_repaintBoundingBox; }
96     FloatRect repaintRectInLocalCoordinatesExcludingSVGShadow() const { return m_repaintBoundingBoxExcludingShadow; }
97
98     bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) override;
99
100     LayoutRect clippedOverflowRectForRepaint(const RenderLayerModelObject* repaintContainer) const override;
101     FloatRect computeFloatRectForRepaint(const FloatRect&, const RenderLayerModelObject* repaintContainer, bool fixed) const override;
102
103     void mapLocalToContainer(const RenderLayerModelObject* repaintContainer, TransformState&, MapCoordinatesFlags, bool* wasFixed) const override;
104     const RenderObject* pushMappingToContainer(const RenderLayerModelObject* ancestorToStopAt, RenderGeometryMap&) const override;
105
106     bool canBeSelectionLeaf() const override { return false; }
107     bool canHaveChildren() const override { return true; }
108
109     bool shouldApplyViewportClip() const;
110     void updateCachedBoundaries();
111     void buildLocalToBorderBoxTransform();
112
113     IntSize m_containerSize;
114     FloatRect m_objectBoundingBox;
115     bool m_objectBoundingBoxValid;
116     FloatRect m_strokeBoundingBox;
117     FloatRect m_repaintBoundingBox;
118     FloatRect m_repaintBoundingBoxExcludingShadow;
119     mutable AffineTransform m_localToParentTransform;
120     AffineTransform m_localToBorderBoxTransform;
121     HashSet<RenderSVGResourceContainer*> m_resourcesNeedingToInvalidateClients;
122     bool m_isLayoutSizeChanged : 1;
123     bool m_needsBoundariesOrTransformUpdate : 1;
124     bool m_hasSVGShadow : 1;
125     bool m_hasBoxDecorations : 1;
126 };
127
128 } // namespace WebCore
129
130 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderSVGRoot, isSVGRoot())