Use NeverDestroyed instead of DEPRECATED_DEFINE_STATIC_LOCAL
[WebKit-https.git] / Source / WebCore / svg / SVGFEConvolveMatrixElement.cpp
1 /*
2  * Copyright (C) 2009 Dirk Schulze <krit@webkit.org>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19
20 #include "config.h"
21 #include "SVGFEConvolveMatrixElement.h"
22
23 #include "FilterEffect.h"
24 #include "FloatPoint.h"
25 #include "IntPoint.h"
26 #include "IntSize.h"
27 #include "SVGFilterBuilder.h"
28 #include "SVGNames.h"
29 #include "SVGParserUtilities.h"
30
31 namespace WebCore {
32
33 // Animated property definitions
34 DEFINE_ANIMATED_STRING(SVGFEConvolveMatrixElement, SVGNames::inAttr, In1, in1)
35 DEFINE_ANIMATED_INTEGER_MULTIPLE_WRAPPERS(SVGFEConvolveMatrixElement, SVGNames::orderAttr, orderXIdentifier(), OrderX, orderX)
36 DEFINE_ANIMATED_INTEGER_MULTIPLE_WRAPPERS(SVGFEConvolveMatrixElement, SVGNames::orderAttr, orderYIdentifier(), OrderY, orderY) 
37 DEFINE_ANIMATED_NUMBER_LIST(SVGFEConvolveMatrixElement, SVGNames::kernelMatrixAttr, KernelMatrix, kernelMatrix)
38 DEFINE_ANIMATED_NUMBER(SVGFEConvolveMatrixElement, SVGNames::divisorAttr, Divisor, divisor)
39 DEFINE_ANIMATED_NUMBER(SVGFEConvolveMatrixElement, SVGNames::biasAttr, Bias, bias)
40 DEFINE_ANIMATED_INTEGER(SVGFEConvolveMatrixElement, SVGNames::targetXAttr, TargetX, targetX)
41 DEFINE_ANIMATED_INTEGER(SVGFEConvolveMatrixElement, SVGNames::targetYAttr, TargetY, targetY)
42 DEFINE_ANIMATED_ENUMERATION(SVGFEConvolveMatrixElement, SVGNames::edgeModeAttr, EdgeMode, edgeMode, EdgeModeType)
43 DEFINE_ANIMATED_NUMBER_MULTIPLE_WRAPPERS(SVGFEConvolveMatrixElement, SVGNames::kernelUnitLengthAttr, kernelUnitLengthXIdentifier(), KernelUnitLengthX, kernelUnitLengthX)
44 DEFINE_ANIMATED_NUMBER_MULTIPLE_WRAPPERS(SVGFEConvolveMatrixElement, SVGNames::kernelUnitLengthAttr, kernelUnitLengthYIdentifier(), KernelUnitLengthY, kernelUnitLengthY)
45 DEFINE_ANIMATED_BOOLEAN(SVGFEConvolveMatrixElement, SVGNames::preserveAlphaAttr, PreserveAlpha, preserveAlpha)
46
47 BEGIN_REGISTER_ANIMATED_PROPERTIES(SVGFEConvolveMatrixElement)
48     REGISTER_LOCAL_ANIMATED_PROPERTY(in1)
49     REGISTER_LOCAL_ANIMATED_PROPERTY(orderX)
50     REGISTER_LOCAL_ANIMATED_PROPERTY(orderY)
51     REGISTER_LOCAL_ANIMATED_PROPERTY(kernelMatrix)
52     REGISTER_LOCAL_ANIMATED_PROPERTY(divisor)
53     REGISTER_LOCAL_ANIMATED_PROPERTY(bias)
54     REGISTER_LOCAL_ANIMATED_PROPERTY(targetX)
55     REGISTER_LOCAL_ANIMATED_PROPERTY(targetY)
56     REGISTER_LOCAL_ANIMATED_PROPERTY(edgeMode)
57     REGISTER_LOCAL_ANIMATED_PROPERTY(kernelUnitLengthX)
58     REGISTER_LOCAL_ANIMATED_PROPERTY(kernelUnitLengthY)
59     REGISTER_LOCAL_ANIMATED_PROPERTY(preserveAlpha)
60     REGISTER_PARENT_ANIMATED_PROPERTIES(SVGFilterPrimitiveStandardAttributes)
61 END_REGISTER_ANIMATED_PROPERTIES
62
63 inline SVGFEConvolveMatrixElement::SVGFEConvolveMatrixElement(const QualifiedName& tagName, Document& document)
64     : SVGFilterPrimitiveStandardAttributes(tagName, document)
65     , m_edgeMode(EDGEMODE_DUPLICATE)
66 {
67     ASSERT(hasTagName(SVGNames::feConvolveMatrixTag));
68     registerAnimatedPropertiesForSVGFEConvolveMatrixElement();
69 }
70
71 Ref<SVGFEConvolveMatrixElement> SVGFEConvolveMatrixElement::create(const QualifiedName& tagName, Document& document)
72 {
73     return adoptRef(*new SVGFEConvolveMatrixElement(tagName, document));
74 }
75
76 const AtomicString& SVGFEConvolveMatrixElement::kernelUnitLengthXIdentifier()
77 {
78     static NeverDestroyed<AtomicString> s_identifier("SVGKernelUnitLengthX", AtomicString::ConstructFromLiteral);
79     return s_identifier;
80 }
81
82 const AtomicString& SVGFEConvolveMatrixElement::kernelUnitLengthYIdentifier()
83 {
84     static NeverDestroyed<AtomicString> s_identifier("SVGKernelUnitLengthY", AtomicString::ConstructFromLiteral);
85     return s_identifier;
86 }
87
88 const AtomicString& SVGFEConvolveMatrixElement::orderXIdentifier()
89 {
90     static NeverDestroyed<AtomicString> s_identifier("SVGOrderX", AtomicString::ConstructFromLiteral);
91     return s_identifier;
92 }
93
94 const AtomicString& SVGFEConvolveMatrixElement::orderYIdentifier()
95 {
96     static NeverDestroyed<AtomicString> s_identifier("SVGOrderY", AtomicString::ConstructFromLiteral);
97     return s_identifier;
98 }
99
100 void SVGFEConvolveMatrixElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
101 {
102     if (name == SVGNames::inAttr) {
103         setIn1BaseValue(value);
104         return;
105     }
106
107     if (name == SVGNames::orderAttr) {
108         float x, y;
109         if (parseNumberOptionalNumber(value, x, y) && x >= 1 && y >= 1) {
110             setOrderXBaseValue(x);
111             setOrderYBaseValue(y);
112         } else
113             document().accessSVGExtensions().reportWarning("feConvolveMatrix: problem parsing order=\"" + value + "\". Filtered element will not be displayed.");
114         return;
115     }
116
117     if (name == SVGNames::edgeModeAttr) {
118         EdgeModeType propertyValue = SVGPropertyTraits<EdgeModeType>::fromString(value);
119         if (propertyValue > 0)
120             setEdgeModeBaseValue(propertyValue);
121         else
122             document().accessSVGExtensions().reportWarning("feConvolveMatrix: problem parsing edgeMode=\"" + value + "\". Filtered element will not be displayed.");
123         return;
124     }
125
126     if (name == SVGNames::kernelMatrixAttr) {
127         SVGNumberList newList;
128         newList.parse(value);
129         detachAnimatedKernelMatrixListWrappers(newList.size());
130         setKernelMatrixBaseValue(newList);
131         return;
132     }
133
134     if (name == SVGNames::divisorAttr) {
135         float divisor = value.toFloat();
136         if (divisor)
137             setDivisorBaseValue(divisor);
138         else
139             document().accessSVGExtensions().reportWarning("feConvolveMatrix: problem parsing divisor=\"" + value + "\". Filtered element will not be displayed.");
140         return;
141     }
142     
143     if (name == SVGNames::biasAttr) {
144         setBiasBaseValue(value.toFloat());
145         return;
146     }
147
148     if (name == SVGNames::targetXAttr) {
149         setTargetXBaseValue(value.string().toUIntStrict());
150         return;
151     }
152
153     if (name == SVGNames::targetYAttr) {
154         setTargetYBaseValue(value.string().toUIntStrict());
155         return;
156     }
157
158     if (name == SVGNames::kernelUnitLengthAttr) {
159         float x, y;
160         if (parseNumberOptionalNumber(value, x, y) && x > 0 && y > 0) {
161             setKernelUnitLengthXBaseValue(x);
162             setKernelUnitLengthYBaseValue(y);
163         } else
164             document().accessSVGExtensions().reportWarning("feConvolveMatrix: problem parsing kernelUnitLength=\"" + value + "\". Filtered element will not be displayed.");
165         return;
166     }
167
168     if (name == SVGNames::preserveAlphaAttr) {
169         if (value == "true")
170             setPreserveAlphaBaseValue(true);
171         else if (value == "false")
172             setPreserveAlphaBaseValue(false);
173         else
174             document().accessSVGExtensions().reportWarning("feConvolveMatrix: problem parsing preserveAlphaAttr=\"" + value  + "\". Filtered element will not be displayed.");
175         return;
176     }
177
178     SVGFilterPrimitiveStandardAttributes::parseAttribute(name, value);
179 }
180
181 bool SVGFEConvolveMatrixElement::setFilterEffectAttribute(FilterEffect* effect, const QualifiedName& attrName)
182 {
183     FEConvolveMatrix* convolveMatrix = static_cast<FEConvolveMatrix*>(effect);
184     if (attrName == SVGNames::edgeModeAttr)
185         return convolveMatrix->setEdgeMode(edgeMode());
186     if (attrName == SVGNames::divisorAttr)
187         return convolveMatrix->setDivisor(divisor());
188     if (attrName == SVGNames::biasAttr)
189         return convolveMatrix->setBias(bias());
190     if (attrName == SVGNames::targetXAttr)
191        return convolveMatrix->setTargetOffset(IntPoint(targetX(), targetY()));
192     if (attrName == SVGNames::targetYAttr)
193        return convolveMatrix->setTargetOffset(IntPoint(targetX(), targetY()));
194     if (attrName == SVGNames::kernelUnitLengthAttr)
195        return convolveMatrix->setKernelUnitLength(FloatPoint(kernelUnitLengthX(), kernelUnitLengthY()));
196     if (attrName == SVGNames::preserveAlphaAttr)
197         return convolveMatrix->setPreserveAlpha(preserveAlpha());
198
199     ASSERT_NOT_REACHED();
200     return false;
201 }
202
203 void SVGFEConvolveMatrixElement::setOrder(float x, float y)
204 {
205     setOrderXBaseValue(x);
206     setOrderYBaseValue(y);
207     invalidate();
208 }
209
210 void SVGFEConvolveMatrixElement::setKernelUnitLength(float x, float y)
211 {
212     setKernelUnitLengthXBaseValue(x);
213     setKernelUnitLengthYBaseValue(y);
214     invalidate();
215 }
216
217 void SVGFEConvolveMatrixElement::svgAttributeChanged(const QualifiedName& attrName)
218 {
219     if (attrName == SVGNames::edgeModeAttr || attrName == SVGNames::divisorAttr || attrName == SVGNames::biasAttr || attrName == SVGNames::targetXAttr || attrName == SVGNames::targetYAttr || attrName == SVGNames::kernelUnitLengthAttr || attrName == SVGNames::preserveAlphaAttr) {
220         InstanceInvalidationGuard guard(*this);
221         primitiveAttributeChanged(attrName);
222         return;
223     }
224
225     if (attrName == SVGNames::inAttr || attrName == SVGNames::orderAttr || attrName == SVGNames::kernelMatrixAttr) {
226         InstanceInvalidationGuard guard(*this);
227         invalidate();
228         return;
229     }
230
231     SVGFilterPrimitiveStandardAttributes::svgAttributeChanged(attrName);
232 }
233
234 RefPtr<FilterEffect> SVGFEConvolveMatrixElement::build(SVGFilterBuilder* filterBuilder, Filter& filter)
235 {
236     FilterEffect* input1 = filterBuilder->getEffectById(in1());
237
238     if (!input1)
239         return nullptr;
240
241     int orderXValue = orderX();
242     int orderYValue = orderY();
243     if (!hasAttribute(SVGNames::orderAttr)) {
244         orderXValue = 3;
245         orderYValue = 3;
246     }
247     // Spec says order must be > 0. Bail if it is not.
248     if (orderXValue < 1 || orderYValue < 1)
249         return nullptr;
250     SVGNumberList& kernelMatrix = this->kernelMatrix();
251     int kernelMatrixSize = kernelMatrix.size();
252     // The spec says this is a requirement, and should bail out if fails
253     if (orderXValue * orderYValue != kernelMatrixSize)
254         return nullptr;
255
256     int targetXValue = targetX();
257     int targetYValue = targetY();
258     if (hasAttribute(SVGNames::targetXAttr) && (targetXValue < 0 || targetXValue >= orderXValue))
259         return nullptr;
260     // The spec says the default value is: targetX = floor ( orderX / 2 ))
261     if (!hasAttribute(SVGNames::targetXAttr))
262         targetXValue = static_cast<int>(floorf(orderXValue / 2));
263     if (hasAttribute(SVGNames::targetYAttr) && (targetYValue < 0 || targetYValue >= orderYValue))
264         return nullptr;
265     // The spec says the default value is: targetY = floor ( orderY / 2 ))
266     if (!hasAttribute(SVGNames::targetYAttr))
267         targetYValue = static_cast<int>(floorf(orderYValue / 2));
268
269     // Spec says default kernelUnitLength is 1.0, and a specified length cannot be 0.
270     int kernelUnitLengthXValue = kernelUnitLengthX();
271     int kernelUnitLengthYValue = kernelUnitLengthY();
272     if (!hasAttribute(SVGNames::kernelUnitLengthAttr)) {
273         kernelUnitLengthXValue = 1;
274         kernelUnitLengthYValue = 1;
275     }
276     if (kernelUnitLengthXValue <= 0 || kernelUnitLengthYValue <= 0)
277         return nullptr;
278
279     float divisorValue = divisor();
280     if (hasAttribute(SVGNames::divisorAttr) && !divisorValue)
281         return nullptr;
282     if (!hasAttribute(SVGNames::divisorAttr)) {
283         for (int i = 0; i < kernelMatrixSize; ++i)
284             divisorValue += kernelMatrix.at(i);
285         if (!divisorValue)
286             divisorValue = 1;
287     }
288
289     RefPtr<FilterEffect> effect = FEConvolveMatrix::create(filter,
290                     IntSize(orderXValue, orderYValue), divisorValue,
291                     bias(), IntPoint(targetXValue, targetYValue), edgeMode(),
292                     FloatPoint(kernelUnitLengthXValue, kernelUnitLengthYValue), preserveAlpha(), kernelMatrix);
293     effect->inputEffects().append(input1);
294     return effect;
295 }
296
297 } // namespace WebCore