/* -*- 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 "nsError.h"
#include "mozilla/Attributes.h"
#include "mozilla/SMILAttr.h"
#include "mozilla/SVGAnimatedClassOrString.h"
#include "mozilla/dom/SVGElement.h"
#include "mozilla/UniquePtr.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 = nullptr;
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,
ErrorResult& aRv) override {
SVGAnimatedClassOrString::SetBaseValue(aValue, aSVGElement, aDoSetAttr,
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 || mIsBaseSet; }
UniquePtr<SMILAttr> ToSMILAttr(SVGElement* aSVGElement);
SVGAnimatedString() =
default;
SVGAnimatedString&
operator=(
const SVGAnimatedString& aOther) {
mAttrEnum = aOther.mAttrEnum;
mIsBaseSet = aOther.mIsBaseSet;
if (aOther.mAnimVal) {
mAnimVal = MakeUnique<nsString>(*aOther.mAnimVal);
}
return *
this;
}
SVGAnimatedString(
const SVGAnimatedString& aOther) : SVGAnimatedString() {
*
this = aOther;
}
private:
// FIXME: Should probably use void string rather than UniquePtr<nsString>.
UniquePtr<nsString> mAnimVal;
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,
ErrorResult& aRv) override;
SVGAnimatedScriptHrefString() =
default;
};
}
// namespace mozilla
#endif // DOM_SVG_SVGANIMATEDSTRING_H_
