Source code
Revision control
Copy as Markdown
Other Tools
/* -*- 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
#include "SVGAnimatedPointList.h"
#include <utility>
#include "DOMSVGPointList.h"
#include "SVGPointListSMILType.h"
#include "mozilla/SMILValue.h"
#include "mozilla/dom/SVGElement.h"
using namespace mozilla::dom;
// See the comments in this file's header!
namespace mozilla {
nsresult SVGAnimatedPointList::SetBaseValueString(const nsAString& aValue) {
SVGPointList newBaseValue;
// The spec says that the point data is parsed and accepted up to the first
// error encountered, so we don't return early if an error occurs. However,
// we do want to throw any error code from setAttribute if there's a problem.
nsresult rv = newBaseValue.SetValueFromString(aValue);
// We must send these notifications *before* changing mBaseVal! Our baseVal's
// DOM wrapper list may have to remove DOM items from itself, and any removed
// DOM items need to copy their internal counterpart's values *before* we
// change them. See the comments in
// DOMSVGPointList::InternalListWillChangeTo().
DOMSVGPointList* baseValWrapper =
DOMSVGPointList::GetDOMWrapperIfExists(GetBaseValKey());
if (baseValWrapper) {
baseValWrapper->InternalListWillChangeTo(newBaseValue);
}
DOMSVGPointList* animValWrapper = nullptr;
if (!IsAnimating()) { // DOM anim val wraps our base val too!
animValWrapper = DOMSVGPointList::GetDOMWrapperIfExists(GetAnimValKey());
if (animValWrapper) {
animValWrapper->InternalListWillChangeTo(newBaseValue);
}
}
// Only now may we modify mBaseVal!
// We don't need to call DidChange* here - we're only called by
// SVGElement::ParseAttribute under Element::SetAttr,
// which takes care of notifying.
mBaseVal.SwapWith(newBaseValue);
return rv;
}
void SVGAnimatedPointList::ClearBaseValue() {
// We must send these notifications *before* changing mBaseVal! (See above.)
DOMSVGPointList* baseValWrapper =
DOMSVGPointList::GetDOMWrapperIfExists(GetBaseValKey());
if (baseValWrapper) {
baseValWrapper->InternalListWillChangeTo(SVGPointList());
}
if (!IsAnimating()) { // DOM anim val wraps our base val too!
DOMSVGPointList* animValWrapper =
DOMSVGPointList::GetDOMWrapperIfExists(GetAnimValKey());
if (animValWrapper) {
animValWrapper->InternalListWillChangeTo(SVGPointList());
}
}
mBaseVal.Clear();
// Caller notifies
}
nsresult SVGAnimatedPointList::SetAnimValue(const SVGPointList& aNewAnimValue,
SVGElement* aElement) {
// Note that a new animation may totally change the number of items in the
// animVal list, either replacing what was essentially a mirror of the
// baseVal list, or else replacing and overriding an existing animation.
// It is not possible for us to reliably distinguish between calls to this
// method that are setting a new sample for an existing animation (in which
// case our list length isn't changing and we wouldn't need to notify our DOM
// wrapper to keep its length in sync), and calls to this method that are
// setting the first sample of a new animation that will override the base
// value/an existing animation (in which case our length may be changing and
// our DOM wrapper may need to be notified). Happily though, it's cheap to
// just blindly notify our animVal's DOM wrapper of our new value each time
// this method is called, so that's what we do.
// We must send this notification *before* changing mAnimVal! (See above.)
DOMSVGPointList* domWrapper =
DOMSVGPointList::GetDOMWrapperIfExists(GetAnimValKey());
if (domWrapper) {
domWrapper->InternalListWillChangeTo(aNewAnimValue);
}
if (!mAnimVal) {
mAnimVal = MakeUnique<SVGPointList>();
}
nsresult rv = mAnimVal->CopyFrom(aNewAnimValue);
if (NS_FAILED(rv)) {
// OOM. We clear the animation and, importantly, ClearAnimValue() ensures
// that mAnimVal's DOM wrapper (if any) is kept in sync!
ClearAnimValue(aElement);
return rv;
}
aElement->DidAnimatePointList();
return NS_OK;
}
void SVGAnimatedPointList::ClearAnimValue(SVGElement* aElement) {
// We must send these notifications *before* changing mAnimVal! (See above.)
DOMSVGPointList* domWrapper =
DOMSVGPointList::GetDOMWrapperIfExists(GetAnimValKey());
if (domWrapper) {
// When all animation ends, animVal simply mirrors baseVal, which may have
// a different number of items to the last active animated value.
//
domWrapper->InternalListWillChangeTo(mBaseVal);
}
mAnimVal = nullptr;
aElement->DidAnimatePointList();
}
UniquePtr<SMILAttr> SVGAnimatedPointList::ToSMILAttr(SVGElement* aElement) {
return MakeUnique<SMILAnimatedPointList>(this, aElement);
}
nsresult SVGAnimatedPointList::SMILAnimatedPointList::ValueFromString(
const nsAString& aStr, const dom::SVGAnimationElement* /*aSrcElement*/,
SMILValue& aValue, bool& aPreventCachingOfSandwich) const {
SMILValue val(&SVGPointListSMILType::sSingleton);
SVGPointListAndInfo* list = static_cast<SVGPointListAndInfo*>(val.mU.mPtr);
nsresult rv = list->SetValueFromString(aStr);
if (NS_SUCCEEDED(rv)) {
list->SetInfo(mElement);
aValue = std::move(val);
}
return rv;
}
SMILValue SVGAnimatedPointList::SMILAnimatedPointList::GetBaseValue() const {
// To benefit from Return Value Optimization and avoid copy constructor calls
// due to our use of return-by-value, we must return the exact same object
// from ALL return points. This function must only return THIS variable:
SMILValue val;
SMILValue tmp(&SVGPointListSMILType::sSingleton);
auto* list = static_cast<SVGPointListAndInfo*>(tmp.mU.mPtr);
nsresult rv = list->CopyFrom(mVal->mBaseVal);
if (NS_SUCCEEDED(rv)) {
list->SetInfo(mElement);
std::swap(val, tmp);
}
return val;
}
nsresult SVGAnimatedPointList::SMILAnimatedPointList::SetAnimValue(
const SMILValue& aValue) {
NS_ASSERTION(aValue.mType == &SVGPointListSMILType::sSingleton,
"Unexpected type to assign animated value");
if (aValue.mType == &SVGPointListSMILType::sSingleton) {
mVal->SetAnimValue(*static_cast<SVGPointListAndInfo*>(aValue.mU.mPtr),
mElement);
}
return NS_OK;
}
void SVGAnimatedPointList::SMILAnimatedPointList::ClearAnimValue() {
if (mVal->mAnimVal) {
mVal->ClearAnimValue(mElement);
}
}
} // namespace mozilla