2011-05-21 Nikolas Zimmermann <nzimmermann@rim.com>
[WebKit-https.git] / Source / WebCore / svg / SVGFEImageElement.cpp
1 /*
2  * Copyright (C) 2004, 2005, 2007 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2004, 2005 Rob Buis <buis@kde.org>
4  * Copyright (C) 2010 Dirk Schulze <krit@webkit.org>
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 #include "config.h"
23
24 #if ENABLE(SVG) && ENABLE(FILTERS)
25 #include "SVGFEImageElement.h"
26
27 #include "Attr.h"
28 #include "CachedImage.h"
29 #include "CachedResourceLoader.h"
30 #include "ColorSpace.h"
31 #include "Document.h"
32 #include "Image.h"
33 #include "RenderObject.h"
34 #include "RenderSVGResource.h"
35 #include "SVGElementInstance.h"
36 #include "SVGImageBufferTools.h"
37 #include "SVGNames.h"
38 #include "SVGPreserveAspectRatio.h"
39
40 namespace WebCore {
41
42 // Animated property definitions
43 DEFINE_ANIMATED_PRESERVEASPECTRATIO(SVGFEImageElement, SVGNames::preserveAspectRatioAttr, PreserveAspectRatio, preserveAspectRatio)
44 DEFINE_ANIMATED_STRING(SVGFEImageElement, XLinkNames::hrefAttr, Href, href)
45 DEFINE_ANIMATED_BOOLEAN(SVGFEImageElement, SVGNames::externalResourcesRequiredAttr, ExternalResourcesRequired, externalResourcesRequired)
46
47 inline SVGFEImageElement::SVGFEImageElement(const QualifiedName& tagName, Document* document)
48     : SVGFilterPrimitiveStandardAttributes(tagName, document)
49 {
50     ASSERT(hasTagName(SVGNames::feImageTag));
51 }
52
53 PassRefPtr<SVGFEImageElement> SVGFEImageElement::create(const QualifiedName& tagName, Document* document)
54 {
55     return adoptRef(new SVGFEImageElement(tagName, document));
56 }
57
58 SVGFEImageElement::~SVGFEImageElement()
59 {
60     if (m_cachedImage)
61         m_cachedImage->removeClient(this);
62 }
63
64 void SVGFEImageElement::requestImageResource()
65 {
66     if (m_cachedImage) {
67         m_cachedImage->removeClient(this);
68         m_cachedImage = 0;
69     }
70
71     Element* hrefElement = treeScope()->getElementById(SVGURIReference::getTarget(href()));
72     if (hrefElement && hrefElement->isSVGElement() && hrefElement->renderer())
73         return;
74
75     m_cachedImage = ownerDocument()->cachedResourceLoader()->requestImage(href());
76
77     if (m_cachedImage)
78         m_cachedImage->addClient(this);
79 }
80
81 bool SVGFEImageElement::isSupportedAttribute(const QualifiedName& attrName)
82 {
83     DEFINE_STATIC_LOCAL(HashSet<QualifiedName>, supportedAttributes, ());
84     if (supportedAttributes.isEmpty()) {
85         SVGURIReference::addSupportedAttributes(supportedAttributes);
86         SVGLangSpace::addSupportedAttributes(supportedAttributes);
87         SVGExternalResourcesRequired::addSupportedAttributes(supportedAttributes);
88         supportedAttributes.add(SVGNames::preserveAspectRatioAttr);
89     }
90     return supportedAttributes.contains(attrName);
91 }
92
93 void SVGFEImageElement::parseMappedAttribute(Attribute* attr)
94 {
95     if (!isSupportedAttribute(attr->name())) {
96         SVGFilterPrimitiveStandardAttributes::parseMappedAttribute(attr);
97         return;
98     }
99
100     const AtomicString& value = attr->value();
101     if (attr->name() == SVGNames::preserveAspectRatioAttr) {
102         SVGPreserveAspectRatio::parsePreserveAspectRatio(this, value);
103         return;
104     }
105
106     if (SVGURIReference::parseMappedAttribute(attr)) {
107         requestImageResource();
108         return;
109     }
110
111     if (SVGLangSpace::parseMappedAttribute(attr))
112         return;
113     if (SVGExternalResourcesRequired::parseMappedAttribute(attr))
114         return;
115
116     ASSERT_NOT_REACHED();
117 }
118
119 void SVGFEImageElement::svgAttributeChanged(const QualifiedName& attrName)
120 {
121     if (!isSupportedAttribute(attrName)) {
122         SVGFilterPrimitiveStandardAttributes::svgAttributeChanged(attrName);
123         return;
124     }
125
126     SVGElementInstance::InvalidationGuard invalidationGuard(this);
127     
128     if (attrName == SVGNames::preserveAspectRatioAttr) {
129         invalidate();
130         return;
131     }
132
133     // FIXME: This can't be correct, I'm just preserving existing code. <feImage> + SVG DOM 'href' changes need testing.
134     if (SVGLangSpace::isKnownAttribute(attrName) || SVGExternalResourcesRequired::isKnownAttribute(attrName) || SVGURIReference::isKnownAttribute(attrName))
135         return;
136
137     ASSERT_NOT_REACHED();
138 }
139
140 void SVGFEImageElement::synchronizeProperty(const QualifiedName& attrName)
141 {
142     if (attrName == anyQName()) {
143         synchronizePreserveAspectRatio();
144         synchronizeHref();
145         synchronizeExternalResourcesRequired();
146         SVGFilterPrimitiveStandardAttributes::synchronizeProperty(attrName);
147         return;
148     }
149
150     if (!isSupportedAttribute(attrName)) {
151         SVGFilterPrimitiveStandardAttributes::synchronizeProperty(attrName);
152         return;
153     }   
154
155     if (attrName == SVGNames::preserveAspectRatioAttr) {
156         synchronizePreserveAspectRatio();
157         return;
158     }
159
160     if (SVGURIReference::isKnownAttribute(attrName)) {
161         synchronizeHref();
162         return;
163     }
164
165     if (SVGExternalResourcesRequired::isKnownAttribute(attrName)) {
166         synchronizeExternalResourcesRequired();
167         return;
168     }
169
170     ASSERT_NOT_REACHED();
171 }
172
173 AttributeToPropertyTypeMap& SVGFEImageElement::attributeToPropertyTypeMap()
174 {
175     DEFINE_STATIC_LOCAL(AttributeToPropertyTypeMap, s_attributeToPropertyTypeMap, ());
176     return s_attributeToPropertyTypeMap;
177 }
178
179 void SVGFEImageElement::fillAttributeToPropertyTypeMap()
180 {
181     AttributeToPropertyTypeMap& attributeToPropertyTypeMap = this->attributeToPropertyTypeMap();
182
183     SVGFilterPrimitiveStandardAttributes::fillPassedAttributeToPropertyTypeMap(attributeToPropertyTypeMap);
184     attributeToPropertyTypeMap.set(SVGNames::preserveAspectRatioAttr, AnimatedPreserveAspectRatio);
185     attributeToPropertyTypeMap.set(XLinkNames::hrefAttr, AnimatedString);
186 }
187
188 void SVGFEImageElement::notifyFinished(CachedResource*)
189 {
190     if (!inDocument())
191         return;
192
193     Element* parent = parentElement();
194     ASSERT(parent);
195
196     if (!parent->hasTagName(SVGNames::filterTag) || !parent->renderer())
197         return;
198
199     RenderSVGResource::markForLayoutAndParentResourceInvalidation(parent->renderer());
200 }
201
202 PassRefPtr<FilterEffect> SVGFEImageElement::build(SVGFilterBuilder*, Filter* filter)
203 {
204     if (!m_cachedImage && !m_targetImage) {
205         Element* hrefElement = treeScope()->getElementById(SVGURIReference::getTarget(href()));
206         if (!hrefElement || !hrefElement->isSVGElement())
207             return 0;
208
209         RenderObject* renderer = hrefElement->renderer();
210         if (!renderer)
211             return 0;
212
213         IntRect targetRect = enclosingIntRect(renderer->objectBoundingBox());
214         m_targetImage = ImageBuffer::create(targetRect.size(), ColorSpaceLinearRGB);
215
216         AffineTransform contentTransformation;
217         SVGImageBufferTools::renderSubtreeToImageBuffer(m_targetImage.get(), renderer, contentTransformation);
218     }
219
220     return FEImage::create(filter, m_targetImage ? m_targetImage->copyImage() : m_cachedImage->image(), preserveAspectRatio());
221 }
222
223 void SVGFEImageElement::addSubresourceAttributeURLs(ListHashSet<KURL>& urls) const
224 {
225     SVGFilterPrimitiveStandardAttributes::addSubresourceAttributeURLs(urls);
226
227     addSubresourceURL(urls, document()->completeURL(href()));
228 }
229
230 }
231
232 #endif // ENABLE(SVG)