summaryrefslogtreecommitdiffstats
path: root/dom/svg/SVGAnimatedPathSegList.cpp
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
commit26a029d407be480d791972afb5975cf62c9360a6 (patch)
treef435a8308119effd964b339f76abb83a57c29483 /dom/svg/SVGAnimatedPathSegList.cpp
parentInitial commit. (diff)
downloadfirefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz
firefox-26a029d407be480d791972afb5975cf62c9360a6.zip
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'dom/svg/SVGAnimatedPathSegList.cpp')
-rw-r--r--dom/svg/SVGAnimatedPathSegList.cpp202
1 files changed, 202 insertions, 0 deletions
diff --git a/dom/svg/SVGAnimatedPathSegList.cpp b/dom/svg/SVGAnimatedPathSegList.cpp
new file mode 100644
index 0000000000..b53a65d6fe
--- /dev/null
+++ b/dom/svg/SVGAnimatedPathSegList.cpp
@@ -0,0 +1,202 @@
+/* -*- 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 "SVGAnimatedPathSegList.h"
+
+#include <utility>
+
+#include "DOMSVGPathSegList.h"
+#include "SVGPathSegListSMILType.h"
+#include "mozilla/SMILValue.h"
+#include "mozilla/StaticPrefs_dom.h"
+#include "mozilla/dom/SVGElement.h"
+
+using namespace mozilla::dom;
+
+// See the comments in this file's header!
+
+namespace mozilla {
+
+nsresult SVGAnimatedPathSegList::SetBaseValueString(const nsAString& aValue) {
+ SVGPathData newBaseValue;
+
+ // The spec says that the path 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
+ // DOMSVGPathSegList::InternalListWillChangeTo().
+ DOMSVGPathSegList* baseValWrapper = nullptr;
+ DOMSVGPathSegList* animValWrapper = nullptr;
+ if (StaticPrefs::dom_svg_pathSeg_enabled()) {
+ baseValWrapper = DOMSVGPathSegList::GetDOMWrapperIfExists(GetBaseValKey());
+ if (baseValWrapper) {
+ baseValWrapper->InternalListWillChangeTo(newBaseValue);
+ }
+
+ if (!IsAnimating()) { // DOM anim val wraps our base val too!
+ animValWrapper =
+ DOMSVGPathSegList::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 SVGAnimatedPathSegList::ClearBaseValue() {
+ if (StaticPrefs::dom_svg_pathSeg_enabled()) {
+ // We must send these notifications *before* changing mBaseVal! (See above.)
+
+ DOMSVGPathSegList* baseValWrapper =
+ DOMSVGPathSegList::GetDOMWrapperIfExists(GetBaseValKey());
+ if (baseValWrapper) {
+ baseValWrapper->InternalListWillChangeTo(SVGPathData());
+ }
+
+ if (!IsAnimating()) { // DOM anim val wraps our base val too!
+ DOMSVGPathSegList* animValWrapper =
+ DOMSVGPathSegList::GetDOMWrapperIfExists(GetAnimValKey());
+ if (animValWrapper) {
+ animValWrapper->InternalListWillChangeTo(SVGPathData());
+ }
+ }
+ }
+
+ mBaseVal.Clear();
+ // Caller notifies
+}
+
+nsresult SVGAnimatedPathSegList::SetAnimValue(const SVGPathData& 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.
+ // Unfortunately it is not possible for us to reliably distinguish between
+ // calls to this method that are setting a new sample for an existing
+ // animation, and calls that are setting the first sample of an animation
+ // that will override an existing animation. In the case of DOMSVGPathSegList
+ // the InternalListWillChangeTo method is not virtually free as it is for the
+ // other DOM list classes, so this is a shame. We'd quite like to be able to
+ // skip the call if possible.
+
+ if (StaticPrefs::dom_svg_pathSeg_enabled()) {
+ // We must send these notifications *before* changing mAnimVal! (See above.)
+
+ DOMSVGPathSegList* domWrapper =
+ DOMSVGPathSegList::GetDOMWrapperIfExists(GetAnimValKey());
+ if (domWrapper) {
+ domWrapper->InternalListWillChangeTo(aNewAnimValue);
+ }
+ }
+ if (!mAnimVal) {
+ mAnimVal = MakeUnique<SVGPathData>();
+ }
+ 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);
+ }
+ aElement->DidAnimatePathSegList();
+ return rv;
+}
+
+void SVGAnimatedPathSegList::ClearAnimValue(SVGElement* aElement) {
+ if (StaticPrefs::dom_svg_pathSeg_enabled()) {
+ // We must send these notifications *before* changing mAnimVal! (See above.)
+
+ DOMSVGPathSegList* domWrapper =
+ DOMSVGPathSegList::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->DidAnimatePathSegList();
+}
+
+bool SVGAnimatedPathSegList::IsRendered() const {
+ return mAnimVal ? !mAnimVal->IsEmpty() : !mBaseVal.IsEmpty();
+}
+
+UniquePtr<SMILAttr> SVGAnimatedPathSegList::ToSMILAttr(SVGElement* aElement) {
+ return MakeUnique<SMILAnimatedPathSegList>(this, aElement);
+}
+
+nsresult SVGAnimatedPathSegList::SMILAnimatedPathSegList::ValueFromString(
+ const nsAString& aStr, const dom::SVGAnimationElement* /*aSrcElement*/,
+ SMILValue& aValue, bool& aPreventCachingOfSandwich) const {
+ SMILValue val(SVGPathSegListSMILType::Singleton());
+ SVGPathDataAndInfo* list = static_cast<SVGPathDataAndInfo*>(val.mU.mPtr);
+ nsresult rv = list->SetValueFromString(aStr);
+ if (NS_SUCCEEDED(rv)) {
+ list->SetElement(mElement);
+ aValue = std::move(val);
+ }
+ return rv;
+}
+
+SMILValue SVGAnimatedPathSegList::SMILAnimatedPathSegList::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(SVGPathSegListSMILType::Singleton());
+ auto* list = static_cast<SVGPathDataAndInfo*>(tmp.mU.mPtr);
+ nsresult rv = list->CopyFrom(mVal->mBaseVal);
+ if (NS_SUCCEEDED(rv)) {
+ list->SetElement(mElement);
+ val = std::move(tmp);
+ }
+ return val;
+}
+
+nsresult SVGAnimatedPathSegList::SMILAnimatedPathSegList::SetAnimValue(
+ const SMILValue& aValue) {
+ NS_ASSERTION(aValue.mType == SVGPathSegListSMILType::Singleton(),
+ "Unexpected type to assign animated value");
+ if (aValue.mType == SVGPathSegListSMILType::Singleton()) {
+ mVal->SetAnimValue(*static_cast<SVGPathDataAndInfo*>(aValue.mU.mPtr),
+ mElement);
+ }
+ return NS_OK;
+}
+
+void SVGAnimatedPathSegList::SMILAnimatedPathSegList::ClearAnimValue() {
+ if (mVal->mAnimVal) {
+ mVal->ClearAnimValue(mElement);
+ }
+}
+
+size_t SVGAnimatedPathSegList::SizeOfExcludingThis(
+ MallocSizeOf aMallocSizeOf) const {
+ size_t total = mBaseVal.SizeOfExcludingThis(aMallocSizeOf);
+ if (mAnimVal) {
+ mAnimVal->SizeOfIncludingThis(aMallocSizeOf);
+ }
+ return total;
+}
+
+} // namespace mozilla