Reviewed by Nikolas Zimmermann.
[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  *
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)
27 #include "SVGMaskElement.h"
28
29 #include "Attribute.h"
30 #include "CSSStyleSelector.h"
31 #include "RenderSVGResourceMasker.h"
32 #include "SVGElementInstance.h"
33 #include "SVGNames.h"
34 #include "SVGRenderSupport.h"
35 #include "SVGUnitTypes.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(SVGStyledLocatableElement)
57     REGISTER_PARENT_ANIMATED_PROPERTIES(SVGTests)
58 END_REGISTER_ANIMATED_PROPERTIES
59
60 inline SVGMaskElement::SVGMaskElement(const QualifiedName& tagName, Document* document)
61     : SVGStyledLocatableElement(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     DEFINE_STATIC_LOCAL(HashSet<QualifiedName>, supportedAttributes, ());
83     if (supportedAttributes.isEmpty()) {
84         SVGTests::addSupportedAttributes(supportedAttributes);
85         SVGLangSpace::addSupportedAttributes(supportedAttributes);
86         SVGExternalResourcesRequired::addSupportedAttributes(supportedAttributes);
87         supportedAttributes.add(SVGNames::maskUnitsAttr);
88         supportedAttributes.add(SVGNames::maskContentUnitsAttr);
89         supportedAttributes.add(SVGNames::xAttr);
90         supportedAttributes.add(SVGNames::yAttr);
91         supportedAttributes.add(SVGNames::widthAttr);
92         supportedAttributes.add(SVGNames::heightAttr);
93     }
94     return supportedAttributes.contains(attrName);
95 }
96
97 void SVGMaskElement::parseMappedAttribute(Attribute* attr)
98 {
99     SVGParsingError parseError = NoError;
100
101     if (!isSupportedAttribute(attr->name()))
102         SVGStyledElement::parseMappedAttribute(attr);
103     else if (attr->name() == SVGNames::maskUnitsAttr) {
104         SVGUnitTypes::SVGUnitType propertyValue = SVGPropertyTraits<SVGUnitTypes::SVGUnitType>::fromString(attr->value());
105         if (propertyValue > 0)
106             setMaskUnitsBaseValue(propertyValue);
107         return;
108     } else if (attr->name() == SVGNames::maskContentUnitsAttr) {
109         SVGUnitTypes::SVGUnitType propertyValue = SVGPropertyTraits<SVGUnitTypes::SVGUnitType>::fromString(attr->value());
110         if (propertyValue > 0)
111             setMaskContentUnitsBaseValue(propertyValue);
112         return;
113     } else if (attr->name() == SVGNames::xAttr)
114         setXBaseValue(SVGLength::construct(LengthModeWidth, attr->value(), parseError));
115     else if (attr->name() == SVGNames::yAttr)
116         setYBaseValue(SVGLength::construct(LengthModeHeight, attr->value(), parseError));
117     else if (attr->name() == SVGNames::widthAttr)
118         setWidthBaseValue(SVGLength::construct(LengthModeWidth, attr->value(), parseError));
119     else if (attr->name() == SVGNames::heightAttr)
120         setHeightBaseValue(SVGLength::construct(LengthModeHeight, attr->value(), parseError));
121     else if (SVGTests::parseMappedAttribute(attr)
122              || SVGLangSpace::parseMappedAttribute(attr)
123              || SVGExternalResourcesRequired::parseMappedAttribute(attr)) {
124     } else
125         ASSERT_NOT_REACHED();
126
127     reportAttributeParsingError(parseError, attr);
128 }
129
130 void SVGMaskElement::svgAttributeChanged(const QualifiedName& attrName)
131 {
132     if (!isSupportedAttribute(attrName)) {
133         SVGStyledElement::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         updateRelativeLengthsInformation();
144
145     if (RenderObject* object = renderer())
146         object->setNeedsLayout(true);
147 }
148
149 void SVGMaskElement::childrenChanged(bool changedByParser, Node* beforeChange, Node* afterChange, int childCountDelta)
150 {
151     SVGStyledElement::childrenChanged(changedByParser, beforeChange, afterChange, childCountDelta);
152
153     if (changedByParser)
154         return;
155
156     if (RenderObject* object = renderer())
157         object->setNeedsLayout(true);
158 }
159
160 FloatRect SVGMaskElement::maskBoundingBox(const FloatRect& objectBoundingBox) const
161 {
162     FloatRect maskBBox;
163     if (maskUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX)
164         maskBBox = FloatRect(x().valueAsPercentage() * objectBoundingBox.width() + objectBoundingBox.x(),
165                              y().valueAsPercentage() * objectBoundingBox.height() + objectBoundingBox.y(),
166                              width().valueAsPercentage() * objectBoundingBox.width(),
167                              height().valueAsPercentage() * objectBoundingBox.height());
168     else
169         maskBBox = FloatRect(x().value(this),
170                              y().value(this),
171                              width().value(this),
172                              height().value(this));
173
174     return maskBBox;
175 }
176
177 RenderObject* SVGMaskElement::createRenderer(RenderArena* arena, RenderStyle*)
178 {
179     return new (arena) RenderSVGResourceMasker(this);
180 }
181
182 bool SVGMaskElement::selfHasRelativeLengths() const
183 {
184     return x().isRelative()
185         || y().isRelative()
186         || width().isRelative()
187         || height().isRelative();
188 }
189
190 }
191
192 #endif // ENABLE(SVG)