Define the type of SVGPropertyOwnerRegistry for all SVG elements
[WebKit-https.git] / Source / WebCore / svg / SVGFilterPrimitiveStandardAttributes.h
1 /*
2  * Copyright (C) 2004, 2005, 2006, 2007 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2004, 2005, 2006 Rob Buis <buis@kde.org>
4  * Copyright (C) 2018-2019 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 "RenderSVGResourceFilter.h"
25 #include "RenderSVGResourceFilterPrimitive.h"
26 #include "SVGAnimatedLength.h"
27 #include "SVGAnimatedString.h"
28 #include "SVGElement.h"
29 #include "SVGNames.h"
30 #include <wtf/RefPtr.h>
31
32 namespace WebCore {
33
34 class Filter;
35 class FilterEffect;
36 class SVGFilterBuilder;
37
38 class SVGFilterPrimitiveStandardAttributes : public SVGElement {
39     WTF_MAKE_ISO_ALLOCATED(SVGFilterPrimitiveStandardAttributes);
40 public:
41     void setStandardAttributes(FilterEffect*) const;
42
43     virtual RefPtr<FilterEffect> build(SVGFilterBuilder*, Filter&) = 0;
44     // Returns true, if the new value is different from the old one.
45     virtual bool setFilterEffectAttribute(FilterEffect*, const QualifiedName&);
46
47     using AttributeOwnerProxy = SVGAttributeOwnerProxyImpl<SVGFilterPrimitiveStandardAttributes, SVGElement>;
48     static AttributeOwnerProxy::AttributeRegistry& attributeRegistry() { return AttributeOwnerProxy::attributeRegistry(); }
49
50     using PropertyRegistry = SVGPropertyOwnerRegistry<SVGFilterPrimitiveStandardAttributes, SVGElement>;
51
52     const SVGLengthValue& x() const { return m_x.currentValue(attributeOwnerProxy()); }
53     const SVGLengthValue& y() const { return m_y.currentValue(attributeOwnerProxy()); }
54     const SVGLengthValue& width() const { return m_width.currentValue(attributeOwnerProxy()); }
55     const SVGLengthValue& height() const { return m_height.currentValue(attributeOwnerProxy()); }
56     const String& result() const { return m_result.currentValue(attributeOwnerProxy()); }
57
58     RefPtr<SVGAnimatedLength> xAnimated() { return m_x.animatedProperty(attributeOwnerProxy()); }
59     RefPtr<SVGAnimatedLength> yAnimated() { return m_y.animatedProperty(attributeOwnerProxy()); }
60     RefPtr<SVGAnimatedLength> widthAnimated() { return m_width.animatedProperty(attributeOwnerProxy()); }
61     RefPtr<SVGAnimatedLength> heightAnimated() { return m_height.animatedProperty(attributeOwnerProxy()); }
62     RefPtr<SVGAnimatedString> resultAnimated() { return m_result.animatedProperty(attributeOwnerProxy()); }
63
64 protected:
65     SVGFilterPrimitiveStandardAttributes(const QualifiedName&, Document&);
66
67     void parseAttribute(const QualifiedName&, const AtomicString&) override;
68     void svgAttributeChanged(const QualifiedName&) override;
69     void childrenChanged(const ChildChange&) override;
70
71     void invalidate();
72     void primitiveAttributeChanged(const QualifiedName& attributeName);
73
74 private:
75     static void registerAttributes();
76     const SVGAttributeOwnerProxy& attributeOwnerProxy() const override { return m_attributeOwnerProxy; }
77
78     const SVGPropertyRegistry& propertyRegistry() const override { return m_propertyRegistry; }
79
80     static bool isKnownAttribute(const QualifiedName& attributeName)
81     {
82         return AttributeOwnerProxy::isKnownAttribute(attributeName) || PropertyRegistry::isKnownAttribute(attributeName);
83     }
84
85     bool isFilterEffect() const override { return true; }
86
87     RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) override;
88     bool rendererIsNeeded(const RenderStyle&) override;
89     bool childShouldCreateRenderer(const Node&) const override { return false; }
90
91     AttributeOwnerProxy m_attributeOwnerProxy { *this };
92     PropertyRegistry m_propertyRegistry { *this };
93     // Spec: If the x/y attribute is not specified, the effect is as if a value of "0%" were specified.
94     // Spec: If the width/height attribute is not specified, the effect is as if a value of "100%" were specified.
95     SVGAnimatedLengthAttribute m_x { LengthModeWidth, "0%" };
96     SVGAnimatedLengthAttribute m_y { LengthModeHeight, "0%" };
97     SVGAnimatedLengthAttribute m_width { LengthModeWidth, "100%" };
98     SVGAnimatedLengthAttribute m_height { LengthModeHeight, "100%" };
99     SVGAnimatedStringAttribute m_result;
100 };
101
102 void invalidateFilterPrimitiveParent(SVGElement*);
103
104 inline void SVGFilterPrimitiveStandardAttributes::invalidate()
105 {
106     if (auto* primitiveRenderer = renderer())
107         RenderSVGResource::markForLayoutAndParentResourceInvalidation(*primitiveRenderer);
108 }
109
110 inline void SVGFilterPrimitiveStandardAttributes::primitiveAttributeChanged(const QualifiedName& attribute)
111 {
112     if (auto* primitiveRenderer = renderer())
113         static_cast<RenderSVGResourceFilterPrimitive*>(primitiveRenderer)->primitiveAttributeChanged(attribute);
114 }
115
116 } // namespace WebCore
117
118 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::SVGFilterPrimitiveStandardAttributes)
119     static bool isType(const WebCore::SVGElement& element) { return element.isFilterEffect(); }
120     static bool isType(const WebCore::Node& node) { return is<WebCore::SVGElement>(node) && isType(downcast<WebCore::SVGElement>(node)); }
121 SPECIALIZE_TYPE_TRAITS_END()