Remove the SVG instance tree
[WebKit-https.git] / Source / WebCore / svg / SVGMaskElement.cpp
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) 2005 Alexander Kellett <lypanov@kde.org>
5  * Copyright (C) 2009 Dirk Schulze <krit@webkit.org>
6  * Copyright (C) Research In Motion Limited 2009-2010. All rights reserved.
7  * Copyright (C) 2014 Adobe Systems Incorporated. All rights reserved.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public License
20  * along with this library; see the file COPYING.LIB.  If not, write to
21  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22  * Boston, MA 02110-1301, USA.
23  */
24
25 #include "config.h"
26 #include "SVGMaskElement.h"
27
28 #include "Attribute.h"
29 #include "RenderSVGResourceMasker.h"
30 #include "SVGNames.h"
31 #include "SVGRenderSupport.h"
32 #include "SVGUnitTypes.h"
33 #include "StyleResolver.h"
34 #include <wtf/NeverDestroyed.h>
35
36 namespace WebCore {
37
38 // Animated property definitions
39 DEFINE_ANIMATED_ENUMERATION(SVGMaskElement, SVGNames::maskUnitsAttr, MaskUnits, maskUnits, SVGUnitTypes::SVGUnitType)
40 DEFINE_ANIMATED_ENUMERATION(SVGMaskElement, SVGNames::maskContentUnitsAttr, MaskContentUnits, maskContentUnits, SVGUnitTypes::SVGUnitType)
41 DEFINE_ANIMATED_LENGTH(SVGMaskElement, SVGNames::xAttr, X, x)
42 DEFINE_ANIMATED_LENGTH(SVGMaskElement, SVGNames::yAttr, Y, y)
43 DEFINE_ANIMATED_LENGTH(SVGMaskElement, SVGNames::widthAttr, Width, width)
44 DEFINE_ANIMATED_LENGTH(SVGMaskElement, SVGNames::heightAttr, Height, height)
45 DEFINE_ANIMATED_BOOLEAN(SVGMaskElement, SVGNames::externalResourcesRequiredAttr, ExternalResourcesRequired, externalResourcesRequired)
46
47 BEGIN_REGISTER_ANIMATED_PROPERTIES(SVGMaskElement)
48     REGISTER_LOCAL_ANIMATED_PROPERTY(maskUnits)
49     REGISTER_LOCAL_ANIMATED_PROPERTY(maskContentUnits)
50     REGISTER_LOCAL_ANIMATED_PROPERTY(x)
51     REGISTER_LOCAL_ANIMATED_PROPERTY(y)
52     REGISTER_LOCAL_ANIMATED_PROPERTY(width)
53     REGISTER_LOCAL_ANIMATED_PROPERTY(height)
54     REGISTER_LOCAL_ANIMATED_PROPERTY(externalResourcesRequired)
55     REGISTER_PARENT_ANIMATED_PROPERTIES(SVGElement)
56     REGISTER_PARENT_ANIMATED_PROPERTIES(SVGTests)
57 END_REGISTER_ANIMATED_PROPERTIES
58
59 inline SVGMaskElement::SVGMaskElement(const QualifiedName& tagName, Document& document)
60     : SVGElement(tagName, document)
61     , m_maskUnits(SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX)
62     , m_maskContentUnits(SVGUnitTypes::SVG_UNIT_TYPE_USERSPACEONUSE)
63     , m_x(LengthModeWidth, "-10%")
64     , m_y(LengthModeHeight, "-10%")
65     , m_width(LengthModeWidth, "120%")
66     , m_height(LengthModeHeight, "120%")
67 {
68     // Spec: If the x/y attribute is not specified, the effect is as if a value of "-10%" were specified.
69     // Spec: If the width/height attribute is not specified, the effect is as if a value of "120%" were specified.
70     ASSERT(hasTagName(SVGNames::maskTag));
71     registerAnimatedPropertiesForSVGMaskElement();
72 }
73
74 Ref<SVGMaskElement> SVGMaskElement::create(const QualifiedName& tagName, Document& document)
75 {
76     return adoptRef(*new SVGMaskElement(tagName, document));
77 }
78
79 bool SVGMaskElement::isSupportedAttribute(const QualifiedName& attrName)
80 {
81     static NeverDestroyed<HashSet<QualifiedName>> supportedAttributes;
82     if (supportedAttributes.get().isEmpty()) {
83         SVGTests::addSupportedAttributes(supportedAttributes);
84         SVGLangSpace::addSupportedAttributes(supportedAttributes);
85         SVGExternalResourcesRequired::addSupportedAttributes(supportedAttributes);
86         supportedAttributes.get().add(SVGNames::maskUnitsAttr);
87         supportedAttributes.get().add(SVGNames::maskContentUnitsAttr);
88         supportedAttributes.get().add(SVGNames::xAttr);
89         supportedAttributes.get().add(SVGNames::yAttr);
90         supportedAttributes.get().add(SVGNames::widthAttr);
91         supportedAttributes.get().add(SVGNames::heightAttr);
92     }
93     return supportedAttributes.get().contains<SVGAttributeHashTranslator>(attrName);
94 }
95
96 void SVGMaskElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
97 {
98     SVGParsingError parseError = NoError;
99
100     if (!isSupportedAttribute(name))
101         SVGElement::parseAttribute(name, value);
102     else if (name == SVGNames::maskUnitsAttr) {
103         SVGUnitTypes::SVGUnitType propertyValue = SVGPropertyTraits<SVGUnitTypes::SVGUnitType>::fromString(value);
104         if (propertyValue > 0)
105             setMaskUnitsBaseValue(propertyValue);
106         return;
107     } else if (name == SVGNames::maskContentUnitsAttr) {
108         SVGUnitTypes::SVGUnitType propertyValue = SVGPropertyTraits<SVGUnitTypes::SVGUnitType>::fromString(value);
109         if (propertyValue > 0)
110             setMaskContentUnitsBaseValue(propertyValue);
111         return;
112     } else if (name == SVGNames::xAttr)
113         setXBaseValue(SVGLength::construct(LengthModeWidth, value, parseError));
114     else if (name == SVGNames::yAttr)
115         setYBaseValue(SVGLength::construct(LengthModeHeight, value, parseError));
116     else if (name == SVGNames::widthAttr)
117         setWidthBaseValue(SVGLength::construct(LengthModeWidth, value, parseError));
118     else if (name == SVGNames::heightAttr)
119         setHeightBaseValue(SVGLength::construct(LengthModeHeight, value, parseError));
120     else if (SVGTests::parseAttribute(name, value)
121              || SVGLangSpace::parseAttribute(name, value)
122              || SVGExternalResourcesRequired::parseAttribute(name, value)) {
123     } else
124         ASSERT_NOT_REACHED();
125
126     reportAttributeParsingError(parseError, name, value);
127 }
128
129 void SVGMaskElement::svgAttributeChanged(const QualifiedName& attrName)
130 {
131     if (!isSupportedAttribute(attrName)) {
132         SVGElement::svgAttributeChanged(attrName);
133         return;
134     }
135
136     InstanceInvalidationGuard guard(*this);
137
138     if (attrName == SVGNames::xAttr
139         || attrName == SVGNames::yAttr
140         || attrName == SVGNames::widthAttr
141         || attrName == SVGNames::heightAttr) {
142         invalidateSVGPresentationAttributeStyle();
143         return;
144     }
145
146     if (RenderObject* object = renderer())
147         object->setNeedsLayout();
148 }
149
150 void SVGMaskElement::childrenChanged(const ChildChange& change)
151 {
152     SVGElement::childrenChanged(change);
153
154     if (change.source == ChildChangeSourceParser)
155         return;
156
157     if (RenderObject* object = renderer())
158         object->setNeedsLayout();
159 }
160
161 RenderPtr<RenderElement> SVGMaskElement::createElementRenderer(Ref<RenderStyle>&& style)
162 {
163     RenderPtr<RenderElement> maskRenderer = createRenderer<RenderSVGResourceMasker>(*this, WTF::move(style));
164     
165     // Pass along existing render layer clients.
166     for (auto* clientLayer : m_clientLayers)
167         static_cast<RenderSVGResourceMasker*>(maskRenderer.get())->addClientRenderLayer(clientLayer);
168     
169     return maskRenderer;
170 }
171
172 void SVGMaskElement::addClientRenderLayer(RenderLayer* client)
173 {
174     ASSERT(client);
175     m_clientLayers.add(client);
176     
177     // Pass it along to the renderer.
178     if (renderer())
179         static_cast<RenderSVGResourceMasker*>(renderer())->addClientRenderLayer(client);
180 }
181
182 void SVGMaskElement::removeClientRenderLayer(RenderLayer* client)
183 {
184     ASSERT(client);
185     m_clientLayers.remove(client);
186     
187     // Pass it along to the renderer.
188     if (renderer())
189         static_cast<RenderSVGResourceMasker*>(renderer())->removeClientRenderLayer(client);
190 }
191
192 }