5#ifndef INCLUDE_V8_LOCAL_HANDLE_H_
6#define INCLUDE_V8_LOCAL_HANDLE_H_
33class NonCopyablePersistentTraits;
36template <
class T,
class M = NonCopyablePersistentTraits<T>>
39class TracedReferenceBase;
41class BasicTracedReference;
47class EscapableHandleScope;
49class FunctionCallbackInfo;
52template <
class F1,
class F2,
class F3>
53class PersistentValueMapBase;
57class PropertyCallbackInfo;
67class ConsoleCallArguments;
75class SamplingHeapProfiler;
78namespace api_internal {
109 return reinterpret_cast<Isolate*
>(i_isolate_);
129 void*
operator new(
size_t size);
130 void*
operator new[](
size_t size);
131 void operator delete(
void*, size_t);
132 void operator delete[](
void*, size_t);
134 internal::Isolate* i_isolate_;
137#ifdef V8_ENABLE_CHECKS
138 int scope_level_ = 0;
142 template <
typename T>
157#ifdef V8_ENABLE_DIRECT_HANDLE
160class LocalBase :
public api_internal::DirectHandleBase {
169 template <
typename S>
173 return LocalBase<T>(
value);
176 V8_INLINE static LocalBase<T>
New(Isolate* isolate, T* that) {
182 return LocalBase<T>(*
slot);
199 template <
typename S>
204 reinterpret_cast<internal::Isolate*
>(isolate),
value));
251#ifdef V8_ENABLE_LOCAL_OFF_STACK_CHECK
267 static_assert(std::is_base_of<T, S>::value,
"type check");
287 return internal::HandleHelper::EqualHandles(*
this, that);
292 return internal::HandleHelper::EqualHandles(*
this, that);
297 return !operator==(that);
302 return !operator==(that);
312#ifdef V8_ENABLE_CHECKS
316 T::Cast(that.template value<S>());
337 return New(isolate, that.template value<T, true>());
342 return New(isolate, that.template value<T, true>());
347 return New(isolate, that.template value<T, true>());
361 template <
class F,
class M>
381 template <
class F1,
class F2,
class F3>
387 friend class internal::SamplingHeapProfiler;
389 friend class debug::ConsoleCallArguments;
392 explicit Local(no_checking_tag do_not_check)
393 :
LocalBase<T>(), StackAllocated(do_not_check) {}
394 explicit Local(
const Local<T>& other, no_checking_tag do_not_check)
395 :
LocalBase<T>(other), StackAllocated(do_not_check) {}
397 V8_INLINE explicit Local(
const LocalBase<T>& other) : LocalBase<T>(other) {}
399 V8_INLINE static Local<T> FromSlot(internal::Address* slot) {
400 return Local<T>(LocalBase<T>::FromSlot(slot));
403#ifdef V8_ENABLE_DIRECT_HANDLE
404 friend class TypecheckWitness;
406 V8_INLINE static Local<T> FromAddress(internal::Address ptr) {
407 return Local<T>(LocalBase<T>(ptr));
411 V8_INLINE static Local<T> New(Isolate* isolate, internal::Address value) {
412 return Local<T>(LocalBase<T>::New(isolate, value));
415 V8_INLINE static Local<T> New(Isolate* isolate, T* that) {
416 return Local<T>(LocalBase<T>::New(isolate, that));
422 return Local<S>(LocalBase<S>(*
this));
434#if defined(V8_ENABLE_LOCAL_OFF_STACK_CHECK) && V8_HAS_ATTRIBUTE_TRIVIAL_ABI
438 :
Local<T>(other,
Local<T>::do_not_check) noexcept {}
447#ifdef V8_ENABLE_DIRECT_HANDLE
452class StrongRootAllocator<LocalUnchecked<T>> :
public StrongRootAllocatorBase {
454 using value_type = LocalUnchecked<T>;
455 static_assert(std::is_standard_layout_v<value_type>);
456 static_assert(
sizeof(value_type) ==
sizeof(Address));
458 explicit StrongRootAllocator(Heap* heap) : StrongRootAllocatorBase(heap) {}
459 explicit StrongRootAllocator(Isolate* isolate)
460 : StrongRootAllocatorBase(isolate) {}
462 : StrongRootAllocatorBase(reinterpret_cast<Isolate*>(isolate)) {}
463 template <
typename U>
464 StrongRootAllocator(
const StrongRootAllocator<U>& other) noexcept
465 : StrongRootAllocatorBase(other) {}
467 value_type* allocate(
size_t n) {
468 return reinterpret_cast<value_type*
>(allocate_impl(n));
470 void deallocate(value_type* p,
size_t n)
noexcept {
471 return deallocate_impl(
reinterpret_cast<Address*
>(p), n);
482#ifdef V8_ENABLE_DIRECT_HANDLE
485 static allocator_type make_allocator(
Isolate* isolate)
noexcept {
486 return allocator_type(isolate);
489 using allocator_type = std::allocator<element_type>;
491 static allocator_type make_allocator(
Isolate* isolate)
noexcept {
492 return allocator_type();
496 using vector_type = std::vector<element_type, allocator_type>;
512 : backing_(n, make_allocator(isolate)) {}
514 : backing_(make_allocator(isolate)) {
515 if (init.size() == 0)
return;
516 backing_.reserve(init.size());
517 backing_.insert(backing_.end(), init.begin(), init.end());
527 size_t size() const noexcept {
return backing_.size(); }
528 bool empty() const noexcept {
return backing_.empty(); }
529 void reserve(
size_t n) { backing_.reserve(n); }
536 const Local<T>&
at(
size_t n)
const {
return backing_.at(n); }
550 template <
typename InputIt>
552 return iterator(backing_.insert(pos.
base(), first, last));
556 return iterator(backing_.insert(pos.
base(), init.begin(), init.end()));
561 backing_.reserve(init.size());
562 backing_.insert(backing_.end(), init.begin(), init.end());
570 void clear() noexcept { backing_.clear(); }
571 void resize(
size_t n) { backing_.resize(n); }
575 return x.backing_ == y.backing_;
578 return x.backing_ != y.backing_;
581 return x.backing_ < y.backing_;
584 return x.backing_ > y.backing_;
587 return x.backing_ <= y.backing_;
590 return x.backing_ >= y.backing_;
594 vector_type backing_;
597#if !defined(V8_IMMINENT_DEPRECATION_WARNINGS)
657#ifdef V8_ENABLE_CHECKS
661 T::Cast(that.local_.template value<S>());
679 template <
typename S>
694 void*
operator new(
size_t size) =
delete;
695 void*
operator new[](
size_t size) =
delete;
696 void operator delete(
void*, size_t) =
delete;
697 void operator delete[](
void*, size_t) =
delete;
718#ifdef V8_ENABLE_DIRECT_HANDLE
721 if (value.
IsEmpty())
return value;
744 void*
operator new(
size_t size) =
delete;
745 void*
operator new[](
size_t size) =
delete;
746 void operator delete(
void*, size_t) =
delete;
747 void operator delete[](
void*, size_t) =
delete;
750 internal::Isolate*
const i_isolate_;
752 int prev_sealed_level_;
Definition: v8-traced-handle.h:125
Definition: v8-context.h:48
Definition: v8-local-handle.h:687
EscapableHandleScopeBase(Isolate *isolate)
internal::Address * EscapeSlot(internal::Address *escape_value)
EscapableHandleScopeBase(const EscapableHandleScopeBase &)=delete
void operator=(const EscapableHandleScopeBase &)=delete
~EscapableHandleScopeBase()=default
Definition: v8-local-handle.h:711
~EscapableHandleScope()=default
Local< T > Escape(Local< T > value)
Definition: v8-local-handle.h:717
MaybeLocal< T > EscapeMaybe(MaybeLocal< T > value)
Definition: v8-local-handle.h:727
EscapableHandleScope(Isolate *isolate)
Definition: v8-local-handle.h:713
Definition: v8-local-handle.h:97
void operator=(const HandleScope &)=delete
void Initialize(Isolate *isolate)
HandleScope(const HandleScope &)=delete
Isolate * GetIsolate() const
Definition: v8-local-handle.h:108
static int NumberOfHandles(Isolate *isolate)
static internal::Address * CreateHandleForCurrentIsolate(internal::Address value)
static internal::Address * CreateHandle(internal::Isolate *i_isolate, internal::Address value)
HandleScope(Isolate *isolate)
Definition: v8-isolate.h:211
Definition: v8-local-handle.h:189
static LocalBase< T > New(Isolate *isolate, T *that)
Definition: v8-local-handle.h:207
static LocalBase< T > FromSlot(internal::Address *slot)
Definition: v8-local-handle.h:213
LocalBase(const LocalBase< S > &other)
Definition: v8-local-handle.h:200
LocalBase(internal::Address *location)
Definition: v8-local-handle.h:196
static LocalBase< T > New(Isolate *isolate, internal::Address value)
Definition: v8-local-handle.h:202
Definition: v8-local-handle.h:478
LocalVector< T > & operator=(std::initializer_list< Local< T > > init)
Definition: v8-local-handle.h:559
const Local< T > & front() const
Definition: v8-local-handle.h:539
friend bool operator>=(const LocalVector< T > &x, const LocalVector< T > &y)
Definition: v8-local-handle.h:589
bool empty() const noexcept
Definition: v8-local-handle.h:528
const Local< T > * data() const noexcept
Definition: v8-local-handle.h:544
const_iterator end() const noexcept
Definition: v8-local-handle.h:525
const Local< T > & operator[](size_t n) const
Definition: v8-local-handle.h:533
friend bool operator<(const LocalVector< T > &x, const LocalVector< T > &y)
Definition: v8-local-handle.h:580
const Local< T > & back() const
Definition: v8-local-handle.h:541
void shrink_to_fit()
Definition: v8-local-handle.h:530
Local< T > * data() noexcept
Definition: v8-local-handle.h:543
void reserve(size_t n)
Definition: v8-local-handle.h:529
Local< T > & front()
Definition: v8-local-handle.h:538
internal::WrappedIterator< typename vector_type::iterator, Local< T > > iterator
Definition: v8-local-handle.h:505
friend bool operator<=(const LocalVector< T > &x, const LocalVector< T > &y)
Definition: v8-local-handle.h:586
friend bool operator!=(const LocalVector< T > &x, const LocalVector< T > &y)
Definition: v8-local-handle.h:577
Local< T > & operator[](size_t n)
Definition: v8-local-handle.h:532
size_t size_type
Definition: v8-local-handle.h:502
const_iterator begin() const noexcept
Definition: v8-local-handle.h:521
iterator insert(const_iterator pos, std::initializer_list< Local< T > > init)
Definition: v8-local-handle.h:555
Local< T > & at(size_t n)
Definition: v8-local-handle.h:535
ptrdiff_t difference_type
Definition: v8-local-handle.h:503
iterator insert(const_iterator pos, const Local< T > &value)
Definition: v8-local-handle.h:546
internal::WrappedIterator< typename vector_type::const_iterator, const Local< T > > const_iterator
Definition: v8-local-handle.h:508
void pop_back()
Definition: v8-local-handle.h:567
LocalVector(Isolate *isolate, std::initializer_list< Local< T > > init)
Definition: v8-local-handle.h:513
iterator end() noexcept
Definition: v8-local-handle.h:524
const Local< T > & at(size_t n) const
Definition: v8-local-handle.h:536
void clear() noexcept
Definition: v8-local-handle.h:570
void emplace_back(const Local< T > &x)
Definition: v8-local-handle.h:568
void swap(LocalVector< T > &other)
Definition: v8-local-handle.h:572
iterator insert(const_iterator pos, InputIt first, InputIt last)
Definition: v8-local-handle.h:551
friend bool operator==(const LocalVector< T > &x, const LocalVector< T > &y)
Definition: v8-local-handle.h:574
LocalVector(Isolate *isolate)
Definition: v8-local-handle.h:510
size_t size() const noexcept
Definition: v8-local-handle.h:527
void resize(size_t n)
Definition: v8-local-handle.h:571
Local< T > & back()
Definition: v8-local-handle.h:540
LocalVector(Isolate *isolate, size_t n)
Definition: v8-local-handle.h:511
void push_back(const Local< T > &x)
Definition: v8-local-handle.h:566
iterator begin() noexcept
Definition: v8-local-handle.h:520
friend bool operator>(const LocalVector< T > &x, const LocalVector< T > &y)
Definition: v8-local-handle.h:583
Definition: v8-local-handle.h:256
friend class TracedReferenceBase
Definition: v8-local-handle.h:351
friend class Object
Definition: v8-local-handle.h:368
friend class PersistentValueMapBase
Definition: v8-local-handle.h:382
static Local< T > New(Isolate *isolate, const PersistentBase< T > &that)
Definition: v8-local-handle.h:340
friend class PropertyCallbackInfo
Definition: v8-local-handle.h:366
friend class ReturnValue
Definition: v8-local-handle.h:384
friend class HandleScope
Definition: v8-local-handle.h:378
friend class Traced
Definition: v8-local-handle.h:386
T * operator*() const
Definition: v8-local-handle.h:272
static Local< T > Cast(Local< S > that)
Definition: v8-local-handle.h:311
friend class FunctionCallbackInfo
Definition: v8-local-handle.h:364
Local< S > As() const
Definition: v8-local-handle.h:327
friend class String
Definition: v8-local-handle.h:367
bool operator!=(const Local< S > &that) const
Definition: v8-local-handle.h:296
friend class MaybeLocal
Definition: v8-local-handle.h:360
static Local< T > New(Isolate *isolate, const BasicTracedReference< T > &that)
Definition: v8-local-handle.h:345
bool operator==(const PersistentBase< S > &that) const
Definition: v8-local-handle.h:291
bool operator!=(const Persistent< S > &that) const
Definition: v8-local-handle.h:301
friend class Isolate
Definition: v8-local-handle.h:370
friend class Utils
Definition: v8-local-handle.h:352
static Local< T > New(Isolate *isolate, Local< T > that)
Definition: v8-local-handle.h:336
friend class Context
Definition: v8-local-handle.h:369
friend class Private
Definition: v8-local-handle.h:371
friend class Persistent
Definition: v8-local-handle.h:362
friend class Global
Definition: v8-local-handle.h:356
T * operator->() const
Definition: v8-local-handle.h:270
friend class EscapableHandleScope
Definition: v8-local-handle.h:379
friend class Eternal
Definition: v8-local-handle.h:354
bool operator==(const Local< S > &that) const
Definition: v8-local-handle.h:286
friend class InternalEscapableScope
Definition: v8-local-handle.h:380
Local(Local< S > that)
Definition: v8-local-handle.h:261
friend class Local
Definition: v8-local-handle.h:358
Definition: v8-local-handle.h:614
bool ToLocal(Local< S > *out) const
Definition: v8-local-handle.h:627
static MaybeLocal< T > Cast(MaybeLocal< S > that)
Definition: v8-local-handle.h:656
MaybeLocal< S > As() const
Definition: v8-local-handle.h:672
Local< T > ToLocalChecked()
Definition: v8-local-handle.h:636
Local< S > FromMaybe(Local< S > default_value) const
Definition: v8-local-handle.h:646
MaybeLocal()
Definition: v8-local-handle.h:616
bool IsEmpty() const
Definition: v8-local-handle.h:620
MaybeLocal(Local< S > that)
Definition: v8-local-handle.h:618
Definition: v8-object.h:233
Definition: v8-persistent-handle.h:89
Definition: v8-persistent-handle.h:246
Definition: v8-local-handle.h:737
SealHandleScope(const SealHandleScope &)=delete
void operator=(const SealHandleScope &)=delete
SealHandleScope(Isolate *isolate)
Definition: v8-local-handle.h:62
Definition: v8-value.h:497
Definition: v8-handle-base.h:53
T * value() const
Definition: v8-handle-base.h:85
internal::Address ptr() const
Definition: v8-handle-base.h:76
IndirectHandleBase()=default
internal::Address *const & slot() const
Definition: v8-handle-base.h:79
bool IsEmpty() const
Definition: v8-handle-base.h:56
Definition: v8-handle-base.h:13
Definition: v8-local-handle.h:72
Definition: v8-internal.h:1610
Definition: v8-local-handle.h:430
LocalUnchecked()
Definition: v8-local-handle.h:432
LocalUnchecked(const Local< T > &other) noexcept
Definition: v8-local-handle.h:443
Definition: v8-internal.h:1379
static Address ValueAsAddress(const T *value)
Definition: v8-internal.h:1595
static bool IsEmpty(T *value)
Definition: v8-internal.h:1564
Definition: v8-internal.h:1398
constexpr Iterator base() const noexcept
Definition: v8-internal.h:1476
internal::BasicPersistent< T, internal::StrongPersistentPolicy > Persistent
Definition: persistent.h:363
uintptr_t Address
Definition: v8-internal.h:33
Definition: libplatform.h:15
Local< Primitive > Null(Isolate *isolate)
Definition: v8-primitive.h:938
Local< Primitive > Undefined(Isolate *isolate)
Definition: v8-primitive.h:930
Local< Boolean > False(Isolate *isolate)
Definition: v8-primitive.h:954
Local< Boolean > True(Isolate *isolate)
Definition: v8-primitive.h:946
#define V8_EXPORT
Definition: v8config.h:779
#define V8_INLINE
Definition: v8config.h:493
#define V8_WARN_UNUSED_RESULT
Definition: v8config.h:654
#define V8_UNLIKELY(condition)
Definition: v8config.h:643
#define V8_TRIVIAL_ABI
Definition: v8config.h:729
#define V8_NODISCARD
Definition: v8config.h:676