Make createRenderer() return RenderElement
[WebKit.git] / Source / WebCore / svg / SVGFilterElement.cpp
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) 2006 Samuel Weinig <sam.weinig@gmail.com>
5  * Copyright (C) 2009 Dirk Schulze <krit@webkit.org>
6  * Copyright (C) Research In Motion Limited 2010. All rights reserved.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  */
23
24 #include "config.h"
25
26 #if ENABLE(SVG) && ENABLE(FILTERS)
27 #include "SVGFilterElement.h"
28
29 #include "Attr.h"
30 #include "RenderSVGResourceFilter.h"
31 #include "SVGElementInstance.h"
32 #include "SVGFilterBuilder.h"
33 #include "SVGFilterPrimitiveStandardAttributes.h"
34 #include "SVGNames.h"
35 #include "SVGParserUtilities.h"
36 #include "XLinkNames.h"
37
38 namespace WebCore {
39
40 // Animated property definitions
41 DEFINE_ANIMATED_ENUMERATION(SVGFilterElement, SVGNames::filterUnitsAttr, FilterUnits, filterUnits, SVGUnitTypes::SVGUnitType)
42 DEFINE_ANIMATED_ENUMERATION(SVGFilterElement, SVGNames::primitiveUnitsAttr, PrimitiveUnits, primitiveUnits, SVGUnitTypes::SVGUnitType)
43 DEFINE_ANIMATED_LENGTH(SVGFilterElement, SVGNames::xAttr, X, x)
44 DEFINE_ANIMATED_LENGTH(SVGFilterElement, SVGNames::yAttr, Y, y)
45 DEFINE_ANIMATED_LENGTH(SVGFilterElement, SVGNames::widthAttr, Width, width)
46 DEFINE_ANIMATED_LENGTH(SVGFilterElement, SVGNames::heightAttr, Height, height)
47 DEFINE_ANIMATED_INTEGER_MULTIPLE_WRAPPERS(SVGFilterElement, SVGNames::filterResAttr, filterResXIdentifier(), FilterResX, filterResX)
48 DEFINE_ANIMATED_INTEGER_MULTIPLE_WRAPPERS(SVGFilterElement, SVGNames::filterResAttr, filterResYIdentifier(), FilterResY, filterResY)
49 DEFINE_ANIMATED_STRING(SVGFilterElement, XLinkNames::hrefAttr, Href, href)
50 DEFINE_ANIMATED_BOOLEAN(SVGFilterElement, SVGNames::externalResourcesRequiredAttr, ExternalResourcesRequired, externalResourcesRequired)
51
52 BEGIN_REGISTER_ANIMATED_PROPERTIES(SVGFilterElement)
53     REGISTER_LOCAL_ANIMATED_PROPERTY(filterUnits)
54     REGISTER_LOCAL_ANIMATED_PROPERTY(primitiveUnits)
55     REGISTER_LOCAL_ANIMATED_PROPERTY(x)
56     REGISTER_LOCAL_ANIMATED_PROPERTY(y)
57     REGISTER_LOCAL_ANIMATED_PROPERTY(width)
58     REGISTER_LOCAL_ANIMATED_PROPERTY(height)
59     REGISTER_LOCAL_ANIMATED_PROPERTY(filterResX)
60     REGISTER_LOCAL_ANIMATED_PROPERTY(filterResY)
61     REGISTER_LOCAL_ANIMATED_PROPERTY(href)
62     REGISTER_LOCAL_ANIMATED_PROPERTY(externalResourcesRequired)
63 END_REGISTER_ANIMATED_PROPERTIES
64
65 inline SVGFilterElement::SVGFilterElement(const QualifiedName& tagName, Document& document)
66     : SVGElement(tagName, document)
67     , m_filterUnits(SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX)
68     , m_primitiveUnits(SVGUnitTypes::SVG_UNIT_TYPE_USERSPACEONUSE)
69     , m_x(LengthModeWidth, "-10%")
70     , m_y(LengthModeHeight, "-10%")
71     , m_width(LengthModeWidth, "120%")
72     , m_height(LengthModeHeight, "120%")
73 {
74     // Spec: If the x/y attribute is not specified, the effect is as if a value of "-10%" were specified.
75     // Spec: If the width/height attribute is not specified, the effect is as if a value of "120%" were specified.
76     ASSERT(hasTagName(SVGNames::filterTag));
77     registerAnimatedPropertiesForSVGFilterElement();
78 }
79
80 PassRefPtr<SVGFilterElement> SVGFilterElement::create(const QualifiedName& tagName, Document& document)
81 {
82     return adoptRef(new SVGFilterElement(tagName, document));
83 }
84
85 const AtomicString& SVGFilterElement::filterResXIdentifier()
86 {
87     DEFINE_STATIC_LOCAL(AtomicString, s_identifier, ("SVGFilterResX", AtomicString::ConstructFromLiteral));
88     return s_identifier;
89 }
90
91 const AtomicString& SVGFilterElement::filterResYIdentifier()
92 {
93     DEFINE_STATIC_LOCAL(AtomicString, s_identifier, ("SVGFilterResY", AtomicString::ConstructFromLiteral));
94     return s_identifier;
95 }
96
97 void SVGFilterElement::setFilterRes(unsigned filterResX, unsigned filterResY)
98 {
99     setFilterResXBaseValue(filterResX);
100     setFilterResYBaseValue(filterResY);
101
102     if (RenderObject* object = renderer())
103         object->setNeedsLayout(true);
104 }
105
106 bool SVGFilterElement::isSupportedAttribute(const QualifiedName& attrName)
107 {
108     DEFINE_STATIC_LOCAL(HashSet<QualifiedName>, supportedAttributes, ());
109     if (supportedAttributes.isEmpty()) {
110         SVGURIReference::addSupportedAttributes(supportedAttributes);
111         SVGLangSpace::addSupportedAttributes(supportedAttributes);
112         SVGExternalResourcesRequired::addSupportedAttributes(supportedAttributes);
113         supportedAttributes.add(SVGNames::filterUnitsAttr);
114         supportedAttributes.add(SVGNames::primitiveUnitsAttr);
115         supportedAttributes.add(SVGNames::xAttr);
116         supportedAttributes.add(SVGNames::yAttr);
117         supportedAttributes.add(SVGNames::widthAttr);
118         supportedAttributes.add(SVGNames::heightAttr);
119         supportedAttributes.add(SVGNames::filterResAttr);
120     }
121     return supportedAttributes.contains<SVGAttributeHashTranslator>(attrName);
122 }
123
124 void SVGFilterElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
125 {
126     SVGParsingError parseError = NoError;
127
128     if (!isSupportedAttribute(name))
129         SVGElement::parseAttribute(name, value);
130     else if (name == SVGNames::filterUnitsAttr) {
131         SVGUnitTypes::SVGUnitType propertyValue = SVGPropertyTraits<SVGUnitTypes::SVGUnitType>::fromString(value);
132         if (propertyValue > 0)
133             setFilterUnitsBaseValue(propertyValue);
134     } else if (name == SVGNames::primitiveUnitsAttr) {
135         SVGUnitTypes::SVGUnitType propertyValue = SVGPropertyTraits<SVGUnitTypes::SVGUnitType>::fromString(value);
136         if (propertyValue > 0)
137             setPrimitiveUnitsBaseValue(propertyValue);
138     } else if (name == SVGNames::xAttr)
139         setXBaseValue(SVGLength::construct(LengthModeWidth, value, parseError));
140     else if (name == SVGNames::yAttr)
141         setYBaseValue(SVGLength::construct(LengthModeHeight, value, parseError));
142     else if (name == SVGNames::widthAttr)
143         setWidthBaseValue(SVGLength::construct(LengthModeWidth, value, parseError));
144     else if (name == SVGNames::heightAttr)
145         setHeightBaseValue(SVGLength::construct(LengthModeHeight, value, parseError));
146     else if (name == SVGNames::filterResAttr) {
147         float x, y;
148         if (parseNumberOptionalNumber(value, x, y)) {
149             setFilterResXBaseValue(x);
150             setFilterResYBaseValue(y);
151         }
152     } else if (SVGURIReference::parseAttribute(name, value)
153              || SVGLangSpace::parseAttribute(name, value)
154              || SVGExternalResourcesRequired::parseAttribute(name, value)) {
155     } else
156         ASSERT_NOT_REACHED();
157
158     reportAttributeParsingError(parseError, name, value);
159 }
160
161 void SVGFilterElement::svgAttributeChanged(const QualifiedName& attrName)
162 {
163     if (!isSupportedAttribute(attrName)) {
164         SVGElement::svgAttributeChanged(attrName);
165         return;
166     }
167
168     SVGElementInstance::InvalidationGuard invalidationGuard(this);
169     
170     if (attrName == SVGNames::xAttr
171         || attrName == SVGNames::yAttr
172         || attrName == SVGNames::widthAttr
173         || attrName == SVGNames::heightAttr)
174         updateRelativeLengthsInformation();
175
176     if (RenderObject* object = renderer())
177         object->setNeedsLayout(true);
178 }
179
180 void SVGFilterElement::childrenChanged(const ChildChange& change)
181 {
182     SVGElement::childrenChanged(change);
183
184     if (change.source == ChildChangeSourceParser)
185         return;
186
187     if (RenderObject* object = renderer())
188         object->setNeedsLayout(true);
189 }
190
191 RenderElement* SVGFilterElement::createRenderer(RenderArena& arena, RenderStyle&)
192 {
193     return new (arena) RenderSVGResourceFilter(*this);
194 }
195
196 bool SVGFilterElement::childShouldCreateRenderer(const Node* child) const
197 {
198     if (!child->isSVGElement())
199         return false;
200
201     const SVGElement* svgElement = toSVGElement(child);
202
203     DEFINE_STATIC_LOCAL(HashSet<QualifiedName>, allowedChildElementTags, ());
204     if (allowedChildElementTags.isEmpty()) {
205         allowedChildElementTags.add(SVGNames::feBlendTag);
206         allowedChildElementTags.add(SVGNames::feColorMatrixTag);
207         allowedChildElementTags.add(SVGNames::feComponentTransferTag);
208         allowedChildElementTags.add(SVGNames::feCompositeTag);
209         allowedChildElementTags.add(SVGNames::feConvolveMatrixTag);
210         allowedChildElementTags.add(SVGNames::feDiffuseLightingTag);
211         allowedChildElementTags.add(SVGNames::feDisplacementMapTag);
212         allowedChildElementTags.add(SVGNames::feDistantLightTag);
213         allowedChildElementTags.add(SVGNames::feDropShadowTag);
214         allowedChildElementTags.add(SVGNames::feFloodTag);
215         allowedChildElementTags.add(SVGNames::feFuncATag);
216         allowedChildElementTags.add(SVGNames::feFuncBTag);
217         allowedChildElementTags.add(SVGNames::feFuncGTag);
218         allowedChildElementTags.add(SVGNames::feFuncRTag);
219         allowedChildElementTags.add(SVGNames::feGaussianBlurTag);
220         allowedChildElementTags.add(SVGNames::feImageTag);
221         allowedChildElementTags.add(SVGNames::feMergeTag);
222         allowedChildElementTags.add(SVGNames::feMergeNodeTag);
223         allowedChildElementTags.add(SVGNames::feMorphologyTag);
224         allowedChildElementTags.add(SVGNames::feOffsetTag);
225         allowedChildElementTags.add(SVGNames::fePointLightTag);
226         allowedChildElementTags.add(SVGNames::feSpecularLightingTag);
227         allowedChildElementTags.add(SVGNames::feSpotLightTag);
228         allowedChildElementTags.add(SVGNames::feTileTag);
229         allowedChildElementTags.add(SVGNames::feTurbulenceTag);
230     }
231
232     return allowedChildElementTags.contains<SVGAttributeHashTranslator>(svgElement->tagQName());
233 }
234
235 bool SVGFilterElement::selfHasRelativeLengths() const
236 {
237     return x().isRelative()
238         || y().isRelative()
239         || width().isRelative()
240         || height().isRelative();
241 }
242
243 }
244
245 #endif