/* -*- 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/. */ #include "SVGAnimatedPointList.h" #include "DOMSVGPointList.h" #include "mozilla/Move.h" #include "nsSVGElement.h" #include "nsSVGAttrTearoffTable.h" #include "nsSMILValue.h" #include "SVGPointListSMILType.h" // 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 // nsSVGElement::ParseAttribute under Element::SetAttr, // which takes care of notifying. nsresult rv2 = mBaseVal.CopyFrom(newBaseValue); if (NS_FAILED(rv2)) { // Attempting to increase mBaseVal's length failed (mBaseVal is left // unmodified). We MUST keep any DOM wrappers in sync: if (baseValWrapper) { baseValWrapper->InternalListWillChangeTo(mBaseVal); } if (animValWrapper) { animValWrapper->InternalListWillChangeTo(mBaseVal); } return rv2; } 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, nsSVGElement *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 = new 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(nsSVGElement *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(); } nsISMILAttr* SVGAnimatedPointList::ToSMILAttr(nsSVGElement *aElement) { return new SMILAnimatedPointList(this, aElement); } nsresult SVGAnimatedPointList:: SMILAnimatedPointList::ValueFromString(const nsAString& aStr, const dom::SVGAnimationElement* /*aSrcElement*/, nsSMILValue& aValue, bool& aPreventCachingOfSandwich) const { nsSMILValue val(&SVGPointListSMILType::sSingleton); SVGPointListAndInfo *list = static_cast<SVGPointListAndInfo*>(val.mU.mPtr); nsresult rv = list->SetValueFromString(aStr); if (NS_SUCCEEDED(rv)) { list->SetInfo(mElement); aValue = Move(val); } aPreventCachingOfSandwich = false; return rv; } nsSMILValue 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: nsSMILValue val; nsSMILValue tmp(&SVGPointListSMILType::sSingleton); SVGPointListAndInfo *list = static_cast<SVGPointListAndInfo*>(tmp.mU.mPtr); nsresult rv = list->CopyFrom(mVal->mBaseVal); if (NS_SUCCEEDED(rv)) { list->SetInfo(mElement); Swap(val, tmp); } return val; } nsresult SVGAnimatedPointList::SMILAnimatedPointList::SetAnimValue(const nsSMILValue& 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