981de8651c1e6c6c3695861417bd5be6fdc9df67
[WebKit-https.git] / Source / WebCore / svg / SVGPathElement.h
1 /*
2  * Copyright (C) 2004, 2005, 2006, 2008 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2004, 2005, 2006, 2007 Rob Buis <buis@kde.org>
4  * Copyright (C) 2018 Apple Inc. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #pragma once
23
24 #include "Path.h"
25 #include "SVGAnimatedBoolean.h"
26 #include "SVGAnimatedNumber.h"
27 #include "SVGAnimatedPath.h"
28 #include "SVGExternalResourcesRequired.h"
29 #include "SVGGeometryElement.h"
30 #include "SVGNames.h"
31 #include "SVGPathByteStream.h"
32 #include "SVGPathSegListValues.h"
33
34 namespace WebCore {
35
36 class SVGPathSegArcAbs;
37 class SVGPathSegArcRel;
38 class SVGPathSegClosePath;
39 class SVGPathSegLinetoAbs;
40 class SVGPathSegLinetoRel;
41 class SVGPathSegMovetoAbs;
42 class SVGPathSegMovetoRel;
43 class SVGPathSegCurvetoCubicAbs;
44 class SVGPathSegCurvetoCubicRel;
45 class SVGPathSegLinetoVerticalAbs;
46 class SVGPathSegLinetoVerticalRel;
47 class SVGPathSegLinetoHorizontalAbs;
48 class SVGPathSegLinetoHorizontalRel;
49 class SVGPathSegCurvetoQuadraticAbs;
50 class SVGPathSegCurvetoQuadraticRel;
51 class SVGPathSegCurvetoCubicSmoothAbs;
52 class SVGPathSegCurvetoCubicSmoothRel;
53 class SVGPathSegCurvetoQuadraticSmoothAbs;
54 class SVGPathSegCurvetoQuadraticSmoothRel;
55 class SVGPathSegList;
56 class SVGPoint;
57
58 class SVGPathElement final : public SVGGeometryElement, public SVGExternalResourcesRequired {
59     WTF_MAKE_ISO_ALLOCATED(SVGPathElement);
60 public:
61     static Ref<SVGPathElement> create(const QualifiedName&, Document&);
62     
63     float getTotalLength() const final;
64     Ref<SVGPoint> getPointAtLength(float distance) const final;
65     unsigned getPathSegAtLength(float distance) const;
66
67     Ref<SVGPathSegClosePath> createSVGPathSegClosePath(SVGPathSegRole = PathSegUndefinedRole);
68     Ref<SVGPathSegMovetoAbs> createSVGPathSegMovetoAbs(float x, float y, SVGPathSegRole = PathSegUndefinedRole);
69     Ref<SVGPathSegMovetoRel> createSVGPathSegMovetoRel(float x, float y, SVGPathSegRole = PathSegUndefinedRole);
70     Ref<SVGPathSegLinetoAbs> createSVGPathSegLinetoAbs(float x, float y, SVGPathSegRole = PathSegUndefinedRole);
71     Ref<SVGPathSegLinetoRel> createSVGPathSegLinetoRel(float x, float y, SVGPathSegRole = PathSegUndefinedRole);
72     Ref<SVGPathSegCurvetoCubicAbs> createSVGPathSegCurvetoCubicAbs(float x, float y, float x1, float y1, float x2, float y2, SVGPathSegRole = PathSegUndefinedRole);
73     Ref<SVGPathSegCurvetoCubicRel> createSVGPathSegCurvetoCubicRel(float x, float y, float x1, float y1, float x2, float y2, SVGPathSegRole = PathSegUndefinedRole);
74     Ref<SVGPathSegCurvetoQuadraticAbs> createSVGPathSegCurvetoQuadraticAbs(float x, float y, float x1, float y1, SVGPathSegRole = PathSegUndefinedRole);
75     Ref<SVGPathSegCurvetoQuadraticRel> createSVGPathSegCurvetoQuadraticRel(float x, float y, float x1, float y1, SVGPathSegRole = PathSegUndefinedRole);
76     Ref<SVGPathSegArcAbs> createSVGPathSegArcAbs(float x, float y, float r1, float r2, float angle, bool largeArcFlag, bool sweepFlag, SVGPathSegRole = PathSegUndefinedRole);
77     Ref<SVGPathSegArcRel> createSVGPathSegArcRel(float x, float y, float r1, float r2, float angle, bool largeArcFlag, bool sweepFlag, SVGPathSegRole = PathSegUndefinedRole);
78     Ref<SVGPathSegLinetoHorizontalAbs> createSVGPathSegLinetoHorizontalAbs(float x, SVGPathSegRole = PathSegUndefinedRole);
79     Ref<SVGPathSegLinetoHorizontalRel> createSVGPathSegLinetoHorizontalRel(float x, SVGPathSegRole = PathSegUndefinedRole);
80     Ref<SVGPathSegLinetoVerticalAbs> createSVGPathSegLinetoVerticalAbs(float y, SVGPathSegRole = PathSegUndefinedRole);
81     Ref<SVGPathSegLinetoVerticalRel> createSVGPathSegLinetoVerticalRel(float y, SVGPathSegRole = PathSegUndefinedRole);
82     Ref<SVGPathSegCurvetoCubicSmoothAbs> createSVGPathSegCurvetoCubicSmoothAbs(float x, float y, float x2, float y2, SVGPathSegRole = PathSegUndefinedRole);
83     Ref<SVGPathSegCurvetoCubicSmoothRel> createSVGPathSegCurvetoCubicSmoothRel(float x, float y, float x2, float y2, SVGPathSegRole = PathSegUndefinedRole);
84     Ref<SVGPathSegCurvetoQuadraticSmoothAbs> createSVGPathSegCurvetoQuadraticSmoothAbs(float x, float y, SVGPathSegRole = PathSegUndefinedRole);
85     Ref<SVGPathSegCurvetoQuadraticSmoothRel> createSVGPathSegCurvetoQuadraticSmoothRel(float x, float y, SVGPathSegRole = PathSegUndefinedRole);
86
87     // Used in the bindings only.
88     Ref<SVGPathSegList> pathSegList();
89     Ref<SVGPathSegList> animatedPathSegList();
90     RefPtr<SVGPathSegList> normalizedPathSegList();
91     RefPtr<SVGPathSegList> animatedNormalizedPathSegList();
92
93     const SVGPathByteStream& pathByteStream() const;
94     Path pathForByteStream() const;
95
96     void pathSegListChanged(SVGPathSegRole, ListModification = ListModificationUnknown);
97
98     FloatRect getBBox(StyleUpdateStrategy = AllowStyleUpdate) final;
99
100     bool isAnimValObserved() const { return m_isAnimValObserved; }
101
102     void animatedPropertyWillBeDeleted();
103
104     size_t approximateMemoryCost() const final;
105
106     const SVGPathSegListValues& pathSegList() const { return m_pathSegList.currentValue(attributeOwnerProxy()); }
107     RefPtr<SVGAnimatedPathSegList> pathSegListAnimated() { return m_pathSegList.animatedProperty(attributeOwnerProxy()); }
108
109 private:
110     SVGPathElement(const QualifiedName&, Document&);
111
112     using AttributeOwnerProxy = SVGAttributeOwnerProxyImpl<SVGPathElement, SVGGeometryElement, SVGExternalResourcesRequired>;
113     static auto& attributeRegistry() { return AttributeOwnerProxy::attributeRegistry(); }
114     static bool isKnownAttribute(const QualifiedName& attributeName) { return AttributeOwnerProxy::isKnownAttribute(attributeName); }
115     static void registerAttributes();
116
117     const SVGAttributeOwnerProxy& attributeOwnerProxy() const final { return m_attributeOwnerProxy; }
118     void parseAttribute(const QualifiedName&, const AtomicString&) final;
119     void svgAttributeChanged(const QualifiedName&) final;
120
121     bool isValid() const final { return SVGTests::isValid(); }
122     bool supportsMarkers() const final { return true; }
123     RefPtr<SVGLegacyAnimatedProperty> lookupOrCreateDWrapper();
124
125     RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) final;
126
127     Node::InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode&) final;
128     void removedFromAncestor(RemovalType, ContainerNode&) final;
129
130     void invalidateMPathDependencies();
131
132 private:
133     SVGPathByteStream m_pathByteStream;
134     mutable Optional<Path> m_cachedPath;
135     bool m_isAnimValObserved { false };
136
137     class SVGAnimatedCustomPathSegListAttribute : public SVGAnimatedPathSegListAttribute {
138     public:
139         SVGAnimatedCustomPathSegListAttribute(SVGPathElement& element)
140             : SVGAnimatedPathSegListAttribute(PathSegUnalteredRole)
141             , m_element(element)
142         {
143         }
144
145         SVGPathSegListValues& value(bool shouldBuildSegListValues = true)
146         {
147             if (shouldBuildSegListValues && m_property.isEmpty())
148                 buildSVGPathSegListValuesFromByteStream(m_element.m_pathByteStream, m_element, m_property, UnalteredParsing);
149             return m_property;
150         }
151
152     private:
153         SVGPathElement& m_element;
154     };
155
156     using SVGAnimatedCustomPathSegListAttributeAccessor = SVGAnimatedAttributeAccessor<SVGPathElement, SVGAnimatedCustomPathSegListAttribute, AnimatedPath>;
157
158     AttributeOwnerProxy m_attributeOwnerProxy { *this };
159     SVGAnimatedCustomPathSegListAttribute m_pathSegList { *this };
160 };
161
162 } // namespace WebCore