Improve use of NeverDestroyed
[WebKit-https.git] / Source / WebCore / svg / SVGLinearGradientElement.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) 2008 Eric Seidel <eric@webkit.org>
5  * Copyright (C) 2008 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 #include "SVGLinearGradientElement.h"
26
27 #include "Document.h"
28 #include "FloatPoint.h"
29 #include "LinearGradientAttributes.h"
30 #include "RenderSVGResourceLinearGradient.h"
31 #include "SVGLengthValue.h"
32 #include "SVGNames.h"
33 #include "SVGUnitTypes.h"
34 #include <wtf/NeverDestroyed.h>
35
36 namespace WebCore {
37
38 // Animated property definitions
39 DEFINE_ANIMATED_LENGTH(SVGLinearGradientElement, SVGNames::x1Attr, X1, x1)
40 DEFINE_ANIMATED_LENGTH(SVGLinearGradientElement, SVGNames::y1Attr, Y1, y1)
41 DEFINE_ANIMATED_LENGTH(SVGLinearGradientElement, SVGNames::x2Attr, X2, x2)
42 DEFINE_ANIMATED_LENGTH(SVGLinearGradientElement, SVGNames::y2Attr, Y2, y2)
43
44 BEGIN_REGISTER_ANIMATED_PROPERTIES(SVGLinearGradientElement)
45     REGISTER_LOCAL_ANIMATED_PROPERTY(x1)
46     REGISTER_LOCAL_ANIMATED_PROPERTY(y1)
47     REGISTER_LOCAL_ANIMATED_PROPERTY(x2)
48     REGISTER_LOCAL_ANIMATED_PROPERTY(y2)
49     REGISTER_PARENT_ANIMATED_PROPERTIES(SVGGradientElement)
50 END_REGISTER_ANIMATED_PROPERTIES
51
52 inline SVGLinearGradientElement::SVGLinearGradientElement(const QualifiedName& tagName, Document& document)
53     : SVGGradientElement(tagName, document)
54     , m_x1(LengthModeWidth)
55     , m_y1(LengthModeHeight)
56     , m_x2(LengthModeWidth, "100%")
57     , m_y2(LengthModeHeight)
58 {
59     // Spec: If the x2 attribute is not specified, the effect is as if a value of "100%" were specified.
60     ASSERT(hasTagName(SVGNames::linearGradientTag));
61     registerAnimatedPropertiesForSVGLinearGradientElement();
62 }
63
64 Ref<SVGLinearGradientElement> SVGLinearGradientElement::create(const QualifiedName& tagName, Document& document)
65 {
66     return adoptRef(*new SVGLinearGradientElement(tagName, document));
67 }
68
69 bool SVGLinearGradientElement::isSupportedAttribute(const QualifiedName& attrName)
70 {
71     static const auto supportedAttributes = makeNeverDestroyed(HashSet<QualifiedName> {
72         SVGNames::x1Attr, SVGNames::x2Attr, SVGNames::y1Attr, SVGNames::y2Attr
73     });
74     return supportedAttributes.get().contains<SVGAttributeHashTranslator>(attrName);
75 }
76
77 void SVGLinearGradientElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
78 {
79     SVGParsingError parseError = NoError;
80
81     if (name == SVGNames::x1Attr)
82         setX1BaseValue(SVGLengthValue::construct(LengthModeWidth, value, parseError));
83     else if (name == SVGNames::y1Attr)
84         setY1BaseValue(SVGLengthValue::construct(LengthModeHeight, value, parseError));
85     else if (name == SVGNames::x2Attr)
86         setX2BaseValue(SVGLengthValue::construct(LengthModeWidth, value, parseError));
87     else if (name == SVGNames::y2Attr)
88         setY2BaseValue(SVGLengthValue::construct(LengthModeHeight, value, parseError));
89
90     reportAttributeParsingError(parseError, name, value);
91
92     SVGGradientElement::parseAttribute(name, value);
93 }
94
95 void SVGLinearGradientElement::svgAttributeChanged(const QualifiedName& attrName)
96 {
97     if (!isSupportedAttribute(attrName)) {
98         SVGGradientElement::svgAttributeChanged(attrName);
99         return;
100     }
101
102     InstanceInvalidationGuard guard(*this);
103     
104     updateRelativeLengthsInformation();
105
106     if (RenderObject* object = renderer())
107         object->setNeedsLayout();
108 }
109
110 RenderPtr<RenderElement> SVGLinearGradientElement::createElementRenderer(RenderStyle&& style, const RenderTreePosition&)
111 {
112     return createRenderer<RenderSVGResourceLinearGradient>(*this, WTFMove(style));
113 }
114
115 static void setGradientAttributes(SVGGradientElement& element, LinearGradientAttributes& attributes, bool isLinear = true)
116 {
117     if (!attributes.hasSpreadMethod() && element.hasAttribute(SVGNames::spreadMethodAttr))
118         attributes.setSpreadMethod(element.spreadMethod());
119
120     if (!attributes.hasGradientUnits() && element.hasAttribute(SVGNames::gradientUnitsAttr))
121         attributes.setGradientUnits(element.gradientUnits());
122
123     if (!attributes.hasGradientTransform() && element.hasAttribute(SVGNames::gradientTransformAttr)) {
124         AffineTransform transform;
125         element.gradientTransform().concatenate(transform);
126         attributes.setGradientTransform(transform);
127     }
128
129     if (!attributes.hasStops()) {
130         const Vector<Gradient::ColorStop>& stops(element.buildStops());
131         if (!stops.isEmpty())
132             attributes.setStops(stops);
133     }
134
135     if (isLinear) {
136         SVGLinearGradientElement& linear = downcast<SVGLinearGradientElement>(element);
137
138         if (!attributes.hasX1() && element.hasAttribute(SVGNames::x1Attr))
139             attributes.setX1(linear.x1());
140
141         if (!attributes.hasY1() && element.hasAttribute(SVGNames::y1Attr))
142             attributes.setY1(linear.y1());
143
144         if (!attributes.hasX2() && element.hasAttribute(SVGNames::x2Attr))
145             attributes.setX2(linear.x2());
146
147         if (!attributes.hasY2() && element.hasAttribute(SVGNames::y2Attr))
148             attributes.setY2(linear.y2());
149     }
150 }
151
152 bool SVGLinearGradientElement::collectGradientAttributes(LinearGradientAttributes& attributes)
153 {
154     if (!renderer())
155         return false;
156
157     HashSet<SVGGradientElement*> processedGradients;
158     SVGGradientElement* current = this;
159
160     setGradientAttributes(*current, attributes);
161     processedGradients.add(current);
162
163     while (true) {
164         // Respect xlink:href, take attributes from referenced element
165         Node* refNode = SVGURIReference::targetElementFromIRIString(current->href(), document());
166         if (is<SVGGradientElement>(refNode)) {
167             current = downcast<SVGGradientElement>(refNode);
168
169             // Cycle detection
170             if (processedGradients.contains(current))
171                 return true;
172
173             if (!current->renderer())
174                 return false;
175
176             setGradientAttributes(*current, attributes, current->hasTagName(SVGNames::linearGradientTag));
177             processedGradients.add(current);
178         } else
179             return true;
180     }
181
182     ASSERT_NOT_REACHED();
183     return false;
184 }
185
186 bool SVGLinearGradientElement::selfHasRelativeLengths() const
187 {
188     return x1().isRelative()
189         || y1().isRelative()
190         || x2().isRelative()
191         || y2().isRelative();
192 }
193
194 }