1/*
2 * Copyright (C) 2018-2019 Apple Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#pragma once
27
28#include "SVGPropertyOwner.h"
29#include <wtf/Optional.h>
30#include <wtf/RefCounted.h>
31#include <wtf/text/WTFString.h>
32
33namespace WebCore {
34
35class SVGElement;
36
37class SVGAnimatedProperty : public RefCounted<SVGAnimatedProperty>, public SVGPropertyOwner {
38public:
39 virtual ~SVGAnimatedProperty() = default;
40
41 // Manage the relationship with the owner.
42 bool isAttached() const { return m_contextElement; }
43 void detach() { m_contextElement = nullptr; }
44 SVGElement* contextElement() const { return m_contextElement; }
45
46 virtual String baseValAsString() const { return emptyString(); }
47 virtual String animValAsString() const { return emptyString(); }
48
49 // Control the synchronization between the attribute and its reflection in baseVal.
50 virtual bool isDirty() const { return false; }
51 virtual void setDirty() { }
52 virtual Optional<String> synchronize() { return WTF::nullopt; }
53
54 // Control the animation life cycle.
55 bool isAnimating() const { return m_isAnimating; }
56 virtual void startAnimation() { m_isAnimating = true; }
57 virtual void stopAnimation() { m_isAnimating = false; }
58
59 // Attach/Detach the animVal of the traget element's property by the instance element's property.
60 virtual void instanceStartAnimation(SVGAnimatedProperty&) { m_isAnimating = true; }
61 virtual void instanceStopAnimation() { m_isAnimating = false; }
62
63protected:
64 SVGAnimatedProperty(SVGElement* contextElement)
65 : m_contextElement(contextElement)
66 {
67 }
68
69 SVGPropertyOwner* owner() const override;
70 void commitPropertyChange(SVGProperty*) override;
71
72 SVGElement* m_contextElement { nullptr };
73 bool m_isAnimating { false };
74};
75
76} // namespace WebCore
77
78