1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
3 /* This Source Code Form is subject to the terms of the Mozilla Public
4 * License, v. 2.0. If a copy of the MPL was not distributed with this
5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
7 #include "DOMSVGNumberList.h"
9 #include "SVGElement.h"
10 #include "DOMSVGNumber.h"
11 #include "mozAutoDocUpdate.h"
13 #include "SVGAnimatedNumberList.h"
14 #include "mozilla/dom/SVGNumberListBinding.h"
15 #include "mozilla/RefPtr.h"
18 // See the comment in this file's header.
20 // local helper functions
23 using mozilla::dom::DOMSVGNumber
;
25 void UpdateListIndicesFromIndex(FallibleTArray
<DOMSVGNumber
*>& aItemsArray
,
26 uint32_t aStartingIndex
) {
27 uint32_t length
= aItemsArray
.Length();
29 for (uint32_t i
= aStartingIndex
; i
< length
; ++i
) {
31 aItemsArray
[i
]->UpdateListIndex(i
);
41 // We could use NS_IMPL_CYCLE_COLLECTION(, except that in Unlink() we need to
42 // clear our DOMSVGAnimatedNumberList's weak ref to us to be safe. (The other
43 // option would be to not unlink and rely on the breaking of the other edges in
44 // the cycle, as NS_SVG_VAL_IMPL_CYCLE_COLLECTION does.)
45 NS_IMPL_CYCLE_COLLECTION_CLASS(DOMSVGNumberList
)
47 NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN(DOMSVGNumberList
)
49 if (tmp
->IsAnimValList()) {
50 tmp
->mAList
->mAnimVal
= nullptr;
52 tmp
->mAList
->mBaseVal
= nullptr;
54 NS_IMPL_CYCLE_COLLECTION_UNLINK(mAList
)
56 NS_IMPL_CYCLE_COLLECTION_UNLINK_PRESERVED_WRAPPER
57 NS_IMPL_CYCLE_COLLECTION_UNLINK_END
58 NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN(DOMSVGNumberList
)
59 NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mAList
)
60 NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
61 NS_IMPL_CYCLE_COLLECTION_TRACE_BEGIN(DOMSVGNumberList
)
62 NS_IMPL_CYCLE_COLLECTION_TRACE_PRESERVED_WRAPPER
63 NS_IMPL_CYCLE_COLLECTION_TRACE_END
65 NS_IMPL_CYCLE_COLLECTING_ADDREF(DOMSVGNumberList
)
66 NS_IMPL_CYCLE_COLLECTING_RELEASE(DOMSVGNumberList
)
68 NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(DOMSVGNumberList
)
69 NS_WRAPPERCACHE_INTERFACE_MAP_ENTRY
70 NS_INTERFACE_MAP_ENTRY(nsISupports
)
73 JSObject
* DOMSVGNumberList::WrapObject(JSContext
* cx
,
74 JS::Handle
<JSObject
*> aGivenProto
) {
75 return mozilla::dom::SVGNumberList_Binding::Wrap(cx
, this, aGivenProto
);
78 //----------------------------------------------------------------------
79 // Helper class: AutoChangeNumberListNotifier
80 // Stack-based helper class to pair calls to WillChangeNumberList and
81 // DidChangeNumberList.
82 class MOZ_RAII AutoChangeNumberListNotifier
: public mozAutoDocUpdate
{
84 explicit AutoChangeNumberListNotifier(
85 DOMSVGNumberList
* aNumberList MOZ_GUARD_OBJECT_NOTIFIER_PARAM
)
86 : mozAutoDocUpdate(aNumberList
->Element()->GetComposedDoc(), true),
87 mNumberList(aNumberList
) {
88 MOZ_GUARD_OBJECT_NOTIFIER_INIT
;
89 MOZ_ASSERT(mNumberList
, "Expecting non-null numberList");
90 mEmptyOrOldValue
= mNumberList
->Element()->WillChangeNumberList(
91 mNumberList
->AttrEnum(), *this);
94 ~AutoChangeNumberListNotifier() {
95 mNumberList
->Element()->DidChangeNumberList(mNumberList
->AttrEnum(),
96 mEmptyOrOldValue
, *this);
97 if (mNumberList
->IsAnimating()) {
98 mNumberList
->Element()->AnimationNeedsResample();
103 DOMSVGNumberList
* const mNumberList
;
104 nsAttrValue mEmptyOrOldValue
;
105 MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
108 void DOMSVGNumberList::InternalListLengthWillChange(uint32_t aNewLength
) {
109 uint32_t oldLength
= mItems
.Length();
111 if (aNewLength
> DOMSVGNumber::MaxListIndex()) {
112 // It's safe to get out of sync with our internal list as long as we have
113 // FEWER items than it does.
114 aNewLength
= DOMSVGNumber::MaxListIndex();
117 RefPtr
<DOMSVGNumberList
> kungFuDeathGrip
;
118 if (aNewLength
< oldLength
) {
119 // RemovingFromList() might clear last reference to |this|.
120 // Retain a temporary reference to keep from dying before returning.
121 kungFuDeathGrip
= this;
124 // If our length will decrease, notify the items that will be removed:
125 for (uint32_t i
= aNewLength
; i
< oldLength
; ++i
) {
127 mItems
[i
]->RemovingFromList();
131 if (!mItems
.SetLength(aNewLength
, fallible
)) {
132 // We silently ignore SetLength OOM failure since being out of sync is safe
133 // so long as we have *fewer* items than our internal list.
138 // If our length has increased, null out the new pointers:
139 for (uint32_t i
= oldLength
; i
< aNewLength
; ++i
) {
144 SVGNumberList
& DOMSVGNumberList::InternalList() const {
145 SVGAnimatedNumberList
* alist
= Element()->GetAnimatedNumberList(AttrEnum());
146 return IsAnimValList() && alist
->mAnimVal
? *alist
->mAnimVal
150 void DOMSVGNumberList::Clear(ErrorResult
& error
) {
151 if (IsAnimValList()) {
152 error
.Throw(NS_ERROR_DOM_NO_MODIFICATION_ALLOWED_ERR
);
156 if (LengthNoFlush() > 0) {
157 AutoChangeNumberListNotifier
notifier(this);
158 // Notify any existing DOM items of removal *before* truncating the lists
159 // so that they can find their SVGNumber internal counterparts and copy
160 // their values. This also notifies the animVal list:
161 mAList
->InternalBaseValListWillChangeTo(SVGNumberList());
164 InternalList().Clear();
168 already_AddRefed
<DOMSVGNumber
> DOMSVGNumberList::Initialize(
169 DOMSVGNumber
& aItem
, ErrorResult
& error
) {
170 if (IsAnimValList()) {
171 error
.Throw(NS_ERROR_DOM_NO_MODIFICATION_ALLOWED_ERR
);
175 // If newItem is already in a list we should insert a clone of newItem, and
176 // for consistency, this should happen even if *this* is the list that
177 // newItem is currently in. Note that in the case of newItem being in this
178 // list, the Clear() call before the InsertItemBefore() call would remove it
179 // from this list, and so the InsertItemBefore() call would not insert a
180 // clone of newItem, it would actually insert newItem. To prevent that from
181 // happening we have to do the clone here, if necessary.
182 RefPtr
<DOMSVGNumber
> domItem
= aItem
.HasOwner() ? aItem
.Clone() : &aItem
;
185 MOZ_ASSERT(!error
.Failed());
186 return InsertItemBefore(*domItem
, 0, error
);
189 already_AddRefed
<DOMSVGNumber
> DOMSVGNumberList::GetItem(uint32_t index
,
190 ErrorResult
& error
) {
192 RefPtr
<DOMSVGNumber
> item
= IndexedGetter(index
, found
, error
);
194 error
.Throw(NS_ERROR_DOM_INDEX_SIZE_ERR
);
196 return item
.forget();
199 already_AddRefed
<DOMSVGNumber
> DOMSVGNumberList::IndexedGetter(
200 uint32_t index
, bool& found
, ErrorResult
& error
) {
201 if (IsAnimValList()) {
202 Element()->FlushAnimations();
204 found
= index
< LengthNoFlush();
206 return GetItemAt(index
);
211 already_AddRefed
<DOMSVGNumber
> DOMSVGNumberList::InsertItemBefore(
212 DOMSVGNumber
& aItem
, uint32_t index
, ErrorResult
& error
) {
213 if (IsAnimValList()) {
214 error
.Throw(NS_ERROR_DOM_NO_MODIFICATION_ALLOWED_ERR
);
218 index
= std::min(index
, LengthNoFlush());
219 if (index
>= DOMSVGNumber::MaxListIndex()) {
220 error
.Throw(NS_ERROR_DOM_INDEX_SIZE_ERR
);
224 // must do this before changing anything!
225 RefPtr
<DOMSVGNumber
> domItem
= aItem
.HasOwner() ? aItem
.Clone() : &aItem
;
227 // Ensure we have enough memory so we can avoid complex error handling below:
228 if (!mItems
.SetCapacity(mItems
.Length() + 1, fallible
) ||
229 !InternalList().SetCapacity(InternalList().Length() + 1)) {
230 error
.Throw(NS_ERROR_OUT_OF_MEMORY
);
233 if (AnimListMirrorsBaseList()) {
234 if (!mAList
->mAnimVal
->mItems
.SetCapacity(
235 mAList
->mAnimVal
->mItems
.Length() + 1, fallible
)) {
236 error
.Throw(NS_ERROR_OUT_OF_MEMORY
);
241 AutoChangeNumberListNotifier
notifier(this);
242 // Now that we know we're inserting, keep animVal list in sync as necessary.
243 MaybeInsertNullInAnimValListAt(index
);
245 InternalList().InsertItem(index
, domItem
->ToSVGNumber());
246 MOZ_ALWAYS_TRUE(mItems
.InsertElementAt(index
, domItem
, fallible
));
248 // This MUST come after the insertion into InternalList(), or else under the
249 // insertion into InternalList() the values read from domItem would be bad
250 // data from InternalList() itself!:
251 domItem
->InsertingIntoList(this, AttrEnum(), index
, IsAnimValList());
253 UpdateListIndicesFromIndex(mItems
, index
+ 1);
255 return domItem
.forget();
258 already_AddRefed
<DOMSVGNumber
> DOMSVGNumberList::ReplaceItem(
259 DOMSVGNumber
& aItem
, uint32_t index
, ErrorResult
& error
) {
260 if (IsAnimValList()) {
261 error
.Throw(NS_ERROR_DOM_NO_MODIFICATION_ALLOWED_ERR
);
265 if (index
>= LengthNoFlush()) {
266 error
.Throw(NS_ERROR_DOM_INDEX_SIZE_ERR
);
270 // must do this before changing anything!
271 RefPtr
<DOMSVGNumber
> domItem
= aItem
.HasOwner() ? aItem
.Clone() : &aItem
;
273 AutoChangeNumberListNotifier
notifier(this);
275 // Notify any existing DOM item of removal *before* modifying the lists so
276 // that the DOM item can copy the *old* value at its index:
277 mItems
[index
]->RemovingFromList();
280 InternalList()[index
] = domItem
->ToSVGNumber();
281 mItems
[index
] = domItem
;
283 // This MUST come after the ToSVGPoint() call, otherwise that call
284 // would end up reading bad data from InternalList()!
285 domItem
->InsertingIntoList(this, AttrEnum(), index
, IsAnimValList());
287 return domItem
.forget();
290 already_AddRefed
<DOMSVGNumber
> DOMSVGNumberList::RemoveItem(
291 uint32_t index
, ErrorResult
& error
) {
292 if (IsAnimValList()) {
293 error
.Throw(NS_ERROR_DOM_NO_MODIFICATION_ALLOWED_ERR
);
297 if (index
>= LengthNoFlush()) {
298 error
.Throw(NS_ERROR_DOM_INDEX_SIZE_ERR
);
302 // Now that we know we're removing, keep animVal list in sync as necessary.
303 // Do this *before* touching InternalList() so the removed item can get its
305 MaybeRemoveItemFromAnimValListAt(index
);
307 // We have to return the removed item, so get it, creating it if necessary:
308 RefPtr
<DOMSVGNumber
> result
= GetItemAt(index
);
310 AutoChangeNumberListNotifier
notifier(this);
311 // Notify the DOM item of removal *before* modifying the lists so that the
312 // DOM item can copy its *old* value:
313 mItems
[index
]->RemovingFromList();
315 InternalList().RemoveItem(index
);
316 mItems
.RemoveElementAt(index
);
318 UpdateListIndicesFromIndex(mItems
, index
);
320 return result
.forget();
323 already_AddRefed
<DOMSVGNumber
> DOMSVGNumberList::GetItemAt(uint32_t aIndex
) {
324 MOZ_ASSERT(aIndex
< mItems
.Length());
326 if (!mItems
[aIndex
]) {
328 new DOMSVGNumber(this, AttrEnum(), aIndex
, IsAnimValList());
330 RefPtr
<DOMSVGNumber
> result
= mItems
[aIndex
];
331 return result
.forget();
334 void DOMSVGNumberList::MaybeInsertNullInAnimValListAt(uint32_t aIndex
) {
335 MOZ_ASSERT(!IsAnimValList(), "call from baseVal to animVal");
337 if (!AnimListMirrorsBaseList()) {
341 DOMSVGNumberList
* animVal
= mAList
->mAnimVal
;
343 MOZ_ASSERT(animVal
, "AnimListMirrorsBaseList() promised a non-null animVal");
344 MOZ_ASSERT(animVal
->mItems
.Length() == mItems
.Length(),
345 "animVal list not in sync!");
346 MOZ_ALWAYS_TRUE(animVal
->mItems
.InsertElementAt(aIndex
, nullptr, fallible
));
348 UpdateListIndicesFromIndex(animVal
->mItems
, aIndex
+ 1);
351 void DOMSVGNumberList::MaybeRemoveItemFromAnimValListAt(uint32_t aIndex
) {
352 MOZ_ASSERT(!IsAnimValList(), "call from baseVal to animVal");
354 if (!AnimListMirrorsBaseList()) {
358 // This needs to be a strong reference; otherwise, the RemovingFromList call
359 // below might drop the last reference to animVal before we're done with it.
360 RefPtr
<DOMSVGNumberList
> animVal
= mAList
->mAnimVal
;
362 MOZ_ASSERT(animVal
, "AnimListMirrorsBaseList() promised a non-null animVal");
363 MOZ_ASSERT(animVal
->mItems
.Length() == mItems
.Length(),
364 "animVal list not in sync!");
366 if (animVal
->mItems
[aIndex
]) {
367 animVal
->mItems
[aIndex
]->RemovingFromList();
369 animVal
->mItems
.RemoveElementAt(aIndex
);
371 UpdateListIndicesFromIndex(animVal
->mItems
, aIndex
);
375 } // namespace mozilla