1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
/* -*- 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 mozilla_HoldDropJSObjects_h
#define mozilla_HoldDropJSObjects_h
#include <type_traits>
#include "nsCycleCollectionNoteChild.h"
class nsISupports;
class nsScriptObjectTracer;
class nsCycleCollectionParticipant;
namespace JS {
class Zone;
}
// Only HoldJSObjects and DropJSObjects should be called directly.
namespace mozilla {
namespace cyclecollector {
void HoldJSObjectsImpl(void* aHolder, nsScriptObjectTracer* aTracer,
JS::Zone* aZone = nullptr);
void HoldJSObjectsImpl(nsISupports* aHolder);
void DropJSObjectsImpl(void* aHolder);
void DropJSObjectsImpl(nsISupports* aHolder);
} // namespace cyclecollector
template <class T, bool isISupports = std::is_base_of<nsISupports, T>::value,
typename P = typename T::NS_CYCLE_COLLECTION_INNERCLASS>
struct HoldDropJSObjectsHelper {
static void Hold(T* aHolder) {
cyclecollector::HoldJSObjectsImpl(aHolder,
NS_CYCLE_COLLECTION_PARTICIPANT(T));
}
static void Drop(T* aHolder) { cyclecollector::DropJSObjectsImpl(aHolder); }
};
template <class T>
struct HoldDropJSObjectsHelper<T, true> {
static void Hold(T* aHolder) {
cyclecollector::HoldJSObjectsImpl(ToSupports(aHolder));
}
static void Drop(T* aHolder) {
cyclecollector::DropJSObjectsImpl(ToSupports(aHolder));
}
};
/**
Classes that hold strong references to JS GC things such as `JSObjects` and
`JS::Values` (e.g. `JS::Heap<JSObject*> mFoo;`) must use these, generally by
calling `HoldJSObjects(this)` and `DropJSObjects(this)` in the ctor and dtor
respectively.
For classes that are wrapper cached and hold no other strong references to JS
GC things, there's no need to call these; it will be taken care of
automatically by nsWrapperCache.
**/
template <class T>
void HoldJSObjects(T* aHolder) {
static_assert(!std::is_base_of<nsCycleCollectionParticipant, T>::value,
"Don't call this on the CC participant but on the object that "
"it's for (in an Unlink implementation it's usually stored in "
"a variable named 'tmp').");
HoldDropJSObjectsHelper<T>::Hold(aHolder);
}
template <class T>
void DropJSObjects(T* aHolder) {
static_assert(!std::is_base_of<nsCycleCollectionParticipant, T>::value,
"Don't call this on the CC participant but on the object that "
"it's for (in an Unlink implementation it's usually stored in "
"a variable named 'tmp').");
HoldDropJSObjectsHelper<T>::Drop(aHolder);
}
} // namespace mozilla
#endif // mozilla_HoldDropJSObjects_h
|
