File: SVGAnimatedString.h

package info (click to toggle)
firefox 149.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,767,760 kB
  • sloc: cpp: 7,416,064; javascript: 6,752,859; ansic: 3,774,850; python: 1,250,473; xml: 641,578; asm: 439,191; java: 186,617; sh: 56,634; makefile: 18,856; objc: 13,092; perl: 12,763; pascal: 5,960; yacc: 4,583; cs: 3,846; lex: 1,720; ruby: 1,002; php: 436; lisp: 258; awk: 105; sql: 66; sed: 53; csh: 10; exp: 6
file content (124 lines) | stat: -rw-r--r-- 4,539 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef DOM_SVG_SVGANIMATEDSTRING_H_
#define DOM_SVG_SVGANIMATEDSTRING_H_

#include <memory>

#include "mozilla/Attributes.h"
#include "mozilla/SMILAttr.h"
#include "mozilla/SVGAnimatedClassOrString.h"
#include "mozilla/dom/SVGElement.h"
#include "nsError.h"
#include "nsString.h"

namespace mozilla {

class ErrorResult;
class SMILValue;

namespace dom {
class SVGElement;
class OwningTrustedScriptURLOrString;
class TrustedScriptURLOrString;
}  // namespace dom

class SVGAnimatedString : public SVGAnimatedClassOrString {
 public:
  using SVGElement = dom::SVGElement;
  using OwningTrustedScriptURLOrString = dom::OwningTrustedScriptURLOrString;
  using TrustedScriptURLOrString = dom::TrustedScriptURLOrString;

  void Init(uint8_t aAttrEnum) {
    mAnimVal = VoidString();
    mAttrEnum = aAttrEnum;
    mIsBaseSet = false;
  }

  void SetBaseValue(const nsAString& aValue, SVGElement* aSVGElement,
                    bool aDoSetAttr) override;
  MOZ_CAN_RUN_SCRIPT void SetBaseValue(const TrustedScriptURLOrString& aValue,
                                       SVGElement* aSVGElement, bool aDoSetAttr,
                                       nsIPrincipal* aSubjectPrincipal,
                                       ErrorResult& aRv) override {
    SVGAnimatedClassOrString::SetBaseValue(aValue, aSVGElement, aDoSetAttr,
                                           aSubjectPrincipal, aRv);
  }
  void GetBaseValue(nsAString& aValue,
                    const SVGElement* aSVGElement) const override {
    aSVGElement->GetStringBaseValue(mAttrEnum, aValue);
  }

  void SetAnimValue(const nsAString& aValue, SVGElement* aSVGElement);
  void GetAnimValue(nsAString& aResult,
                    const SVGElement* aSVGElement) const override;

  // Returns true if the animated value of this string has been explicitly
  // set (either by animation, or by taking on the base value which has been
  // explicitly set by markup or a DOM call), false otherwise.
  // If this returns false, the animated value is still valid, that is,
  // usable, and represents the default base value of the attribute.
  bool IsExplicitlySet() const { return !mAnimVal.IsVoid() || mIsBaseSet; }

  std::unique_ptr<SMILAttr> ToSMILAttr(SVGElement* aSVGElement);

  SVGAnimatedString() = default;

  SVGAnimatedString& operator=(const SVGAnimatedString& aOther) {
    mAnimVal = aOther.mAnimVal;
    mAttrEnum = aOther.mAttrEnum;
    mIsBaseSet = aOther.mIsBaseSet;
    return *this;
  }

  SVGAnimatedString(const SVGAnimatedString& aOther) : SVGAnimatedString() {
    *this = aOther;
  }

 private:
  nsString mAnimVal = VoidString();
  uint8_t mAttrEnum = 0;  // element specified tracking for attribute
  bool mIsBaseSet = false;

 public:
  struct SMILString : public SMILAttr {
   public:
    SMILString(SVGAnimatedString* aVal, SVGElement* aSVGElement)
        : mVal(aVal), mSVGElement(aSVGElement) {}

    // These will stay alive because a SMILAttr only lives as long
    // as the Compositing step, and DOM elements don't get a chance to
    // die during that.
    SVGAnimatedString* mVal;
    SVGElement* mSVGElement;

    // SMILAttr methods
    nsresult ValueFromString(const nsAString& aStr,
                             const dom::SVGAnimationElement* aSrcElement,
                             SMILValue& aValue,
                             bool& aPreventCachingOfSandwich) const override;
    SMILValue GetBaseValue() const override;
    void ClearAnimValue() override;
    nsresult SetAnimValue(const SMILValue& aValue) override;
  };
};

class SVGAnimatedScriptHrefString final : public SVGAnimatedString {
 public:
  using SVGElement = dom::SVGElement;
  using OwningTrustedScriptURLOrString = dom::OwningTrustedScriptURLOrString;
  using TrustedScriptURLOrString = dom::TrustedScriptURLOrString;
  MOZ_CAN_RUN_SCRIPT void SetBaseValue(const TrustedScriptURLOrString& aValue,
                                       SVGElement* aSVGElement, bool aDoSetAttr,
                                       nsIPrincipal* aSubjectPrincipal,
                                       ErrorResult& aRv) override;
  SVGAnimatedScriptHrefString() = default;
};

}  // namespace mozilla

#endif  // DOM_SVG_SVGANIMATEDSTRING_H_