Replace PassRef with Ref/Ref&& across the board.
[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 "SVGElementInstance.h"
31 #include "SVGNames.h"
32 #include "SVGRenderSupport.h"
33 #include "SVGUnitTypes.h"
34 #include "StyleResolver.h"
35 #include <wtf/NeverDestroyed.h>
36
37 namespace WebCore {
38
39 // Animated property definitions
40 DEFINE_ANIMATED_ENUMERATION(SVGMaskElement, SVGNames::maskUnitsAttr, MaskUnits, maskUnits, SVGUnitTypes::SVGUnitType)
41 DEFINE_ANIMATED_ENUMERATION(SVGMaskElement, SVGNames::maskContentUnitsAttr, MaskContentUnits, maskContentUnits, SVGUnitTypes::SVGUnitType)
42 DEFINE_ANIMATED_LENGTH(SVGMaskElement, SVGNames::xAttr, X, x)
43 DEFINE_ANIMATED_LENGTH(SVGMaskElement, SVGNames::yAttr, Y, y)
44 DEFINE_ANIMATED_LENGTH(SVGMaskElement, SVGNames::widthAttr, Width, width)
45 DEFINE_ANIMATED_LENGTH(SVGMaskElement, SVGNames::heightAttr, Height, height)
46 DEFINE_ANIMATED_BOOLEAN(SVGMaskElement, SVGNames::externalResourcesRequiredAttr, ExternalResourcesRequired, externalResourcesRequired)
47
48 BEGIN_REGISTER_ANIMATED_PROPERTIES(SVGMaskElement)
49     REGISTER_LOCAL_ANIMATED_PROPERTY(maskUnits)
50     REGISTER_LOCAL_ANIMATED_PROPERTY(maskContentUnits)
51     REGISTER_LOCAL_ANIMATED_PROPERTY(x)
52     REGISTER_LOCAL_ANIMATED_PROPERTY(y)
53     REGISTER_LOCAL_ANIMATED_PROPERTY(width)
54     REGISTER_LOCAL_ANIMATED_PROPERTY(height)
55     REGISTER_LOCAL_ANIMATED_PROPERTY(externalResourcesRequired)
56     REGISTER_PARENT_ANIMATED_PROPERTIES(SVGElement)
57     REGISTER_PARENT_ANIMATED_PROPERTIES(SVGTests)
58 END_REGISTER_ANIMATED_PROPERTIES
59
60 inline SVGMaskElement::SVGMaskElement(const QualifiedName& tagName, Document& document)
61     : SVGElement(tagName, document)
62     , m_maskUnits(SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX)
63     , m_maskContentUnits(SVGUnitTypes::SVG_UNIT_TYPE_USERSPACEONUSE)
64     , m_x(LengthModeWidth, "-10%")
65     , m_y(LengthModeHeight, "-10%")
66     , m_width(LengthModeWidth, "120%")
67     , m_height(LengthModeHeight, "120%")
68 {
69     // Spec: If the x/y attribute is not specified, the effect is as if a value of "-10%" were specified.
70     // Spec: If the width/height attribute is not specified, the effect is as if a value of "120%" were specified.
71     ASSERT(hasTagName(SVGNames::maskTag));
72     registerAnimatedPropertiesForSVGMaskElement();
73 }
74
75 PassRefPtr<SVGMaskElement> SVGMaskElement::create(const QualifiedName& tagName, Document& document)
76 {
77     return adoptRef(new SVGMaskElement(tagName, document));
78 }
79
80 bool SVGMaskElement::isSupportedAttribute(const QualifiedName& attrName)
81 {
82     static NeverDestroyed<HashSet<QualifiedName>> supportedAttributes;
83     if (supportedAttributes.get().isEmpty()) {
84         SVGTests::addSupportedAttributes(supportedAttributes);
85         SVGLangSpace::addSupportedAttributes(supportedAttributes);
86         SVGExternalResourcesRequired::addSupportedAttributes(supportedAttributes);
87         supportedAttributes.get().add(SVGNames::maskUnitsAttr);
88         supportedAttributes.get().add(SVGNames::maskContentUnitsAttr);
89         supportedAttributes.get().add(SVGNames::xAttr);
90         supportedAttributes.get().add(SVGNames::yAttr);
91         supportedAttributes.get().add(SVGNames::widthAttr);
92         supportedAttributes.get().add(SVGNames::heightAttr);
93     }
94     return supportedAttributes.get().contains<SVGAttributeHashTranslator>(attrName);
95 }
96
97 void SVGMaskElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
98 {
99     SVGParsingError parseError = NoError;
100
101     if (!isSupportedAttribute(name))
102         SVGElement::parseAttribute(name, value);
103     else if (name == SVGNames::maskUnitsAttr) {
104         SVGUnitTypes::SVGUnitType propertyValue = SVGPropertyTraits<SVGUnitTypes::SVGUnitType>::fromString(value);
105         if (propertyValue > 0)
106             setMaskUnitsBaseValue(propertyValue);
107         return;
108     } else if (name == SVGNames::maskContentUnitsAttr) {
109         SVGUnitTypes::SVGUnitType propertyValue = SVGPropertyTraits<SVGUnitTypes::SVGUnitType>::fromString(value);
110         if (propertyValue > 0)
111             setMaskContentUnitsBaseValue(propertyValue);
112         return;
113     } else if (name == SVGNames::xAttr)
114         setXBaseValue(SVGLength::construct(LengthModeWidth, value, parseError));
115     else if (name == SVGNames::yAttr)
116         setYBaseValue(SVGLength::construct(LengthModeHeight, value, parseError));
117     else if (name == SVGNames::widthAttr)
118         setWidthBaseValue(SVGLength::construct(LengthModeWidth, value, parseError));
119     else if (name == SVGNames::heightAttr)
120         setHeightBaseValue(SVGLength::construct(LengthModeHeight, value, parseError));
121     else if (SVGTests::parseAttribute(name, value)
122              || SVGLangSpace::parseAttribute(name, value)
123              || SVGExternalResourcesRequired::parseAttribute(name, value)) {
124     } else
125         ASSERT_NOT_REACHED();
126
127     reportAttributeParsingError(parseError, name, value);
128 }
129
130 void SVGMaskElement::svgAttributeChanged(const QualifiedName& attrName)
131 {
132     if (!isSupportedAttribute(attrName)) {
133         SVGElement::svgAttributeChanged(attrName);
134         return;
135     }
136
137     SVGElementInstance::InvalidationGuard invalidationGuard(this);
138
139     if (attrName == SVGNames::xAttr
140         || attrName == SVGNames::yAttr
141         || attrName == SVGNames::widthAttr
142         || attrName == SVGNames::heightAttr) {
143         invalidateSVGPresentationAttributeStyle();
144         return;
145     }
146
147     if (RenderObject* object = renderer())
148         object->setNeedsLayout();
149 }
150
151 void SVGMaskElement::childrenChanged(const ChildChange& change)
152 {
153     SVGElement::childrenChanged(change);
154
155     if (change.source == ChildChangeSourceParser)
156         return;
157
158     if (RenderObject* object = renderer())
159         object->setNeedsLayout();
160 }
161
162 RenderPtr<RenderElement> SVGMaskElement::createElementRenderer(Ref<RenderStyle>&& style)
163 {
164     RenderPtr<RenderElement> maskRenderer = createRenderer<RenderSVGResourceMasker>(*this, WTF::move(style));
165     
166     // Pass along existing render layer clients.
167     for (auto* clientLayer : m_clientLayers)
168         static_cast<RenderSVGResourceMasker*>(maskRenderer.get())->addClientRenderLayer(clientLayer);
169     
170     return maskRenderer;
171 }
172
173 void SVGMaskElement::addClientRenderLayer(RenderLayer* client)
174 {
175     ASSERT(client);
176     m_clientLayers.add(client);
177     
178     // Pass it along to the renderer.
179     if (renderer())
180         static_cast<RenderSVGResourceMasker*>(renderer())->addClientRenderLayer(client);
181 }
182
183 void SVGMaskElement::removeClientRenderLayer(RenderLayer* client)
184 {
185     ASSERT(client);
186     m_clientLayers.remove(client);
187     
188     // Pass it along to the renderer.
189     if (renderer())
190         static_cast<RenderSVGResourceMasker*>(renderer())->removeClientRenderLayer(client);
191 }
192
193 }