A map wrapper that allows using UniquePersistent as a mapped value. More...

#include <v8-util.h>

Inheritance diagram for v8::PersistentValueMap< K, V, Traits >:

Collaboration diagram for v8::PersistentValueMap< K, V, Traits >:

Classes
class	PersistentValueReference
	Helper class for GetReference/SetWithReference. More...

Public Member Functions
	PersistentValueMap (Isolate *isolate)

	~PersistentValueMap ()

Isolate *	GetIsolate ()

size_t	Size ()
	Return size of the map. More...

bool	IsWeak ()
	Return whether the map holds weak persistents. More...

Local< V >	Get (const K &key)
	Get value stored in map. More...

bool	Contains (const K &key)
	Check whether a value is contained in the map. More...

bool	SetReturnValue (const K &key, ReturnValue< Value > returnValue)
	Get value stored in map and set it in returnValue. More...

void	SetReference (const K &key, const Persistent< Object > &parent)
	Call Isolate::SetReference with the given parent and the map value. More...

UniquePersistent< V >	Set (const K &key, Local< V > value)
	Put value into map. More...

UniquePersistent< V >	Set (const K &key, UniquePersistent< V > value)
	Put value into map, like Set(const K&, Local<V>). More...

UniquePersistent< V >	Remove (const K &key)
	Return value for key and remove it from the map. More...

void	Clear ()
	Traverses the map repeatedly, in case side effects of disposal cause insertions. More...

PersistentValueReference	GetReference (const K &key)
	Get a reference to a map value. More...

UniquePersistent< V >	Set (const K &key, UniquePersistent< V > value, PersistentValueReference *reference)
	Put a value into the map and update the reference. More...

Private Member Functions
	PersistentValueMap (PersistentValueMap &)

void	operator= (PersistentValueMap &)

UniquePersistent< V >	SetUnique (const K &key, UniquePersistent< V > *persistent)
	Put the value into the map, and set the 'weak' callback when demanded by the Traits class. More...

Static Private Member Functions
static void	WeakCallback (const WeakCallbackData< V, typename Traits::WeakCallbackDataType > &data)

static V *	FromVal (PersistentContainerValue v)

static bool	SetReturnValueFromVal (ReturnValue< Value > *returnValue, PersistentContainerValue value)

static PersistentContainerValue	ClearAndLeak (UniquePersistent< V > *persistent)

static PersistentContainerValue	Leak (UniquePersistent< V > *persistent)

static UniquePersistent< V >	Release (PersistentContainerValue v)
	Return a container value as UniquePersistent and make sure the weak callback is properly disposed of. More...

Private Attributes
Isolate *	isolate_

Traits::Impl	impl_

Detailed Description

template<typename K, typename V, typename Traits>
class v8::PersistentValueMap< K, V, Traits >

A map wrapper that allows using UniquePersistent as a mapped value.

C++11 embedders don't need this class, as they can use UniquePersistent directly in std containers.

The map relies on a backing map, whose type and accessors are described by the Traits class. The backing map will handle values of type PersistentContainerValue, with all conversion into and out of V8 handles being transparently handled by this class.

Definition at line 119 of file v8-util.h.

Constructor & Destructor Documentation

◆ PersistentValueMap() [1/2]

template<typename K , typename V , typename Traits >

v8::PersistentValueMap< K, V, Traits >::PersistentValueMap ( Isolate * isolate )

inlineexplicit

Definition at line 121 of file v8-util.h.

121 : isolate_(isolate) {}

v8::PersistentValueMap::isolate_

Isolate * isolate_

Definition: v8-util.h:348

◆ ~PersistentValueMap()

template<typename K , typename V , typename Traits >

v8::PersistentValueMap< K, V, Traits >::~PersistentValueMap ( )

inline

Definition at line 123 of file v8-util.h.

123 { Clear(); }

v8::PersistentValueMap::Clear

void Clear()

Traverses the map repeatedly, in case side effects of disposal cause insertions.

Definition: v8-util.h:198

References v8::PersistentValueMap< K, V, Traits >::Clear().

Here is the call graph for this function:

◆ PersistentValueMap() [2/2]

template<typename K , typename V , typename Traits >

v8::PersistentValueMap< K, V, Traits >::PersistentValueMap ( PersistentValueMap< K, V, Traits > & )

private

Member Function Documentation

◆ Clear()

template<typename K , typename V , typename Traits >

void v8::PersistentValueMap< K, V, Traits >::Clear ( )

inline

Traverses the map repeatedly, in case side effects of disposal cause insertions.

Definition at line 198 of file v8-util.h.

                {
     typedef typename Traits::Iterator It;
     HandleScope handle_scope(isolate_);
     // TODO(dcarney): figure out if this swap and loop is necessary.
     while (!Traits::Empty(&impl_)) {
       typename Traits::Impl impl;
       Traits::Swap(impl_, impl);
       for (It i = Traits::Begin(&impl); i != Traits::End(&impl); ++i) {
         Traits::Dispose(isolate_, Release(Traits::Value(i)).Pass(),
                         Traits::Key(i));
       }
     }
   }

References v8::PersistentValueMap< K, V, Traits >::impl_, v8::PersistentValueMap< K, V, Traits >::isolate_, and v8::PersistentValueMap< K, V, Traits >::Release().

Referenced by v8::PersistentValueMap< K, V, Traits >::~PersistentValueMap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClearAndLeak()

template<typename K , typename V , typename Traits >

static PersistentContainerValue v8::PersistentValueMap< K, V, Traits >::ClearAndLeak ( UniquePersistent< V > * persistent )

inlinestaticprivate

Definition at line 321 of file v8-util.h.

                                        {
     V* v = persistent->val_;
     persistent->val_ = 0;
     return reinterpret_cast<PersistentContainerValue>(v);
   }

References v8::PersistentBase< T >::val_.

Referenced by v8::PersistentValueMap< K, V, Traits >::SetUnique().

Here is the caller graph for this function:

◆ Contains()

template<typename K , typename V , typename Traits >

bool v8::PersistentValueMap< K, V, Traits >::Contains ( const K & key )

inline

Check whether a value is contained in the map.

Definition at line 147 of file v8-util.h.

                               {
     return Traits::Get(&impl_, key) != kPersistentContainerNotFound;
   }

References v8::PersistentValueMap< K, V, Traits >::impl_, and v8::kPersistentContainerNotFound.

◆ FromVal()

template<typename K , typename V , typename Traits >

static V* v8::PersistentValueMap< K, V, Traits >::FromVal ( PersistentContainerValue v )

inlinestaticprivate

Definition at line 307 of file v8-util.h.

                                                 {
     return reinterpret_cast<V*>(v);
   }

Referenced by v8::PersistentValueMap< K, V, Traits >::Get(), v8::PersistentValueMap< K, V, Traits >::PersistentValueReference::NewLocal(), v8::PersistentValueMap< K, V, Traits >::Release(), v8::PersistentValueMap< K, V, Traits >::SetReference(), and v8::PersistentValueMap< K, V, Traits >::SetReturnValueFromVal().

Here is the caller graph for this function:

◆ Get()

template<typename K , typename V , typename Traits >

Local<V> v8::PersistentValueMap< K, V, Traits >::Get ( const K & key )

inline

Get value stored in map.

Definition at line 140 of file v8-util.h.

                              {
     return Local<V>::New(isolate_, FromVal(Traits::Get(&impl_, key)));
   }

References v8::PersistentValueMap< K, V, Traits >::FromVal(), v8::PersistentValueMap< K, V, Traits >::impl_, v8::PersistentValueMap< K, V, Traits >::isolate_, and v8::Local< T >::New().

Here is the call graph for this function:

◆ GetIsolate()

template<typename K , typename V , typename Traits >

Isolate* v8::PersistentValueMap< K, V, Traits >::GetIsolate ( )

inline

Definition at line 125 of file v8-util.h.

125 { return isolate_; }

References v8::PersistentValueMap< K, V, Traits >::isolate_.

Referenced by v8::PersistentValueMap< K, V, Traits >::SetReference().

Here is the caller graph for this function:

◆ GetReference()

template<typename K , typename V , typename Traits >

PersistentValueReference v8::PersistentValueMap< K, V, Traits >::GetReference ( const K & key )

inline

Get a reference to a map value.

This enables fast, repeated access to a value stored in the map while the map remains unchanged.

Careful: This is potentially unsafe, so please use with care. The value will become invalid if the value for this key changes in the underlying map, as a result of Set or Remove for the same key; as a result of the weak callback for the same key; or as a result of calling Clear() or destruction of the map.

Definition at line 262 of file v8-util.h.

                                                       {
     return PersistentValueReference(Traits::Get(&impl_, key));
   }

References v8::PersistentValueMap< K, V, Traits >::impl_.

◆ IsWeak()

template<typename K , typename V , typename Traits >

bool v8::PersistentValueMap< K, V, Traits >::IsWeak ( )

inline

Return whether the map holds weak persistents.

Definition at line 135 of file v8-util.h.

135 { return Traits::kCallbackType != kNotWeak; }

v8::kNotWeak

@ kNotWeak

Definition: v8-util.h:24

References v8::kNotWeak.

◆ Leak()

template<typename K , typename V , typename Traits >

static PersistentContainerValue v8::PersistentValueMap< K, V, Traits >::Leak ( UniquePersistent< V > * persistent )

inlinestaticprivate

Definition at line 328 of file v8-util.h.

                                        {
     return reinterpret_cast<PersistentContainerValue>(persistent->val_);
   }

References v8::PersistentBase< T >::val_.

Referenced by v8::PersistentValueMap< K, V, Traits >::Set().

Here is the caller graph for this function:

◆ operator=()

template<typename K , typename V , typename Traits >

void v8::PersistentValueMap< K, V, Traits >::operator= ( PersistentValueMap< K, V, Traits > & )

private

◆ Release()

template<typename K , typename V , typename Traits >

static UniquePersistent<V> v8::PersistentValueMap< K, V, Traits >::Release ( PersistentContainerValue v )

inlinestaticprivate

Return a container value as UniquePersistent and make sure the weak callback is properly disposed of.

All remove functionality should go through this.

Definition at line 338 of file v8-util.h.

                                                                  {
     UniquePersistent<V> p;
     p.val_ = FromVal(v);
     if (Traits::kCallbackType != kNotWeak && p.IsWeak()) {
       Traits::DisposeCallbackData(
           p.template ClearWeak<typename Traits::WeakCallbackDataType>());
     }
     return p.Pass();
   }

References v8::PersistentValueMap< K, V, Traits >::FromVal(), v8::PersistentBase< T >::IsWeak(), v8::kNotWeak, v8::UniquePersistent< T >::Pass(), and v8::PersistentBase< T >::val_.

Referenced by v8::PersistentValueMap< K, V, Traits >::Clear(), v8::PersistentValueMap< K, V, Traits >::Remove(), and v8::PersistentValueMap< K, V, Traits >::SetUnique().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Remove()

template<typename K , typename V , typename Traits >

UniquePersistent<V> v8::PersistentValueMap< K, V, Traits >::Remove ( const K & key )

inline

Return value for key and remove it from the map.

Definition at line 190 of file v8-util.h.

                                            {
     return Release(Traits::Remove(&impl_, key)).Pass();
   }

References v8::PersistentValueMap< K, V, Traits >::impl_, and v8::PersistentValueMap< K, V, Traits >::Release().

Referenced by v8::PersistentValueMap< K, V, Traits >::WeakCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Set() [1/3]

template<typename K , typename V , typename Traits >

UniquePersistent<V> v8::PersistentValueMap< K, V, Traits >::Set	(	const K &	key,
		Local< V >	value
	)

inline

Put value into map.

Depending on Traits::kIsWeak, the value will be held by the map strongly or weakly. Returns old value as UniquePersistent.

Definition at line 175 of file v8-util.h.

                                                         {
     UniquePersistent<V> persistent(isolate_, value);
     return SetUnique(key, &persistent);
   }

References v8::PersistentValueMap< K, V, Traits >::isolate_, and v8::PersistentValueMap< K, V, Traits >::SetUnique().

Here is the call graph for this function:

◆ Set() [2/3]

template<typename K , typename V , typename Traits >

UniquePersistent<V> v8::PersistentValueMap< K, V, Traits >::Set	(	const K &	key,
		UniquePersistent< V >	value
	)

inline

Put value into map, like Set(const K&, Local<V>).

Definition at line 183 of file v8-util.h.

                                                                    {
     return SetUnique(key, &value);
   }

References v8::PersistentValueMap< K, V, Traits >::SetUnique().

Here is the call graph for this function:

◆ Set() [3/3]

template<typename K , typename V , typename Traits >

UniquePersistent<V> v8::PersistentValueMap< K, V, Traits >::Set	(	const K &	key,
		UniquePersistent< V >	value,
		PersistentValueReference *	reference
	)

inline

Put a value into the map and update the reference.

Restrictions of GetReference apply here as well.

Definition at line 270 of file v8-util.h.

                                                                {
     *reference = Leak(&value);
     return SetUnique(key, &value);
   }

References v8::PersistentValueMap< K, V, Traits >::Leak(), and v8::PersistentValueMap< K, V, Traits >::SetUnique().

Here is the call graph for this function:

◆ SetReference()

template<typename K , typename V , typename Traits >

void v8::PersistentValueMap< K, V, Traits >::SetReference	(	const K &	key,
		const Persistent< Object > &	parent
	)

inline

Call Isolate::SetReference with the given parent and the map value.

Definition at line 163 of file v8-util.h.

                                         {
     GetIsolate()->SetReference(
       reinterpret_cast<internal::Object**>(parent.val_),
       reinterpret_cast<internal::Object**>(FromVal(Traits::Get(&impl_, key))));
   }

References v8::PersistentValueMap< K, V, Traits >::FromVal(), v8::PersistentValueMap< K, V, Traits >::GetIsolate(), v8::PersistentValueMap< K, V, Traits >::impl_, v8::Isolate::SetReference(), and v8::PersistentBase< T >::val_.

Here is the call graph for this function:

◆ SetReturnValue()

template<typename K , typename V , typename Traits >

bool v8::PersistentValueMap< K, V, Traits >::SetReturnValue	(	const K &	key,
		ReturnValue< Value >	returnValue
	)

inline

Get value stored in map and set it in returnValue.

Return true if a value was found.

Definition at line 155 of file v8-util.h.

                                       {
     return SetReturnValueFromVal(&returnValue, Traits::Get(&impl_, key));
   }

References v8::PersistentValueMap< K, V, Traits >::impl_, and v8::PersistentValueMap< K, V, Traits >::SetReturnValueFromVal().

Here is the call graph for this function:

◆ SetReturnValueFromVal()

template<typename K , typename V , typename Traits >

static bool v8::PersistentValueMap< K, V, Traits >::SetReturnValueFromVal	(	ReturnValue< Value > *	returnValue,
		PersistentContainerValue	value
	)

inlinestaticprivate

Definition at line 311 of file v8-util.h.

                                                                        {
     bool hasValue = value != kPersistentContainerNotFound;
     if (hasValue) {
       returnValue->SetInternal(
           *reinterpret_cast<internal::Object**>(FromVal(value)));
     }
     return hasValue;
   }

References v8::PersistentValueMap< K, V, Traits >::FromVal(), v8::kPersistentContainerNotFound, and v8::ReturnValue< T >::SetInternal().

Referenced by v8::PersistentValueMap< K, V, Traits >::SetReturnValue(), and v8::PersistentValueMap< K, V, Traits >::PersistentValueReference::SetReturnValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetUnique()

template<typename K , typename V , typename Traits >

UniquePersistent<V> v8::PersistentValueMap< K, V, Traits >::SetUnique	(	const K &	key,
		UniquePersistent< V > *	persistent
	)

inlineprivate

Put the value into the map, and set the 'weak' callback when demanded by the Traits class.

Definition at line 284 of file v8-util.h.

                                                                                {
     if (Traits::kCallbackType != kNotWeak) {
       Local<V> value(Local<V>::New(isolate_, *persistent));
       persistent->template SetWeak<typename Traits::WeakCallbackDataType>(
         Traits::WeakCallbackParameter(this, key, value), WeakCallback);
     }
     PersistentContainerValue old_value =
         Traits::Set(&impl_, key, ClearAndLeak(persistent));
     return Release(old_value).Pass();
   }

References v8::PersistentValueMap< K, V, Traits >::ClearAndLeak(), v8::PersistentValueMap< K, V, Traits >::impl_, v8::PersistentValueMap< K, V, Traits >::isolate_, v8::kNotWeak, v8::PersistentValueMap< K, V, Traits >::Release(), and v8::PersistentValueMap< K, V, Traits >::WeakCallback().

Referenced by v8::PersistentValueMap< K, V, Traits >::Set().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Size()

template<typename K , typename V , typename Traits >

size_t v8::PersistentValueMap< K, V, Traits >::Size ( )

inline

Return size of the map.

Definition at line 130 of file v8-util.h.

130 { return Traits::Size(&impl_); }

References v8::PersistentValueMap< K, V, Traits >::impl_.

◆ WeakCallback()

template<typename K , typename V , typename Traits >

static void v8::PersistentValueMap< K, V, Traits >::WeakCallback ( const WeakCallbackData< V, typename Traits::WeakCallbackDataType > & data )

inlinestaticprivate

Definition at line 295 of file v8-util.h.

                                                                             {
     if (Traits::kCallbackType != kNotWeak) {
       PersistentValueMap<K, V, Traits>* persistentValueMap =
           Traits::MapFromWeakCallbackData(data);
       K key = Traits::KeyFromWeakCallbackData(data);
       Traits::Dispose(data.GetIsolate(),
                       persistentValueMap->Remove(key).Pass(), key);
       Traits::DisposeCallbackData(data.GetParameter());
     }
   }

References v8::WeakCallbackData< T, P >::GetIsolate(), v8::WeakCallbackData< T, P >::GetParameter(), v8::kNotWeak, and v8::PersistentValueMap< K, V, Traits >::Remove().

Referenced by v8::PersistentValueMap< K, V, Traits >::SetUnique().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ impl_

template<typename K , typename V , typename Traits >

Traits::Impl v8::PersistentValueMap< K, V, Traits >::impl_

private

Definition at line 349 of file v8-util.h.

Referenced by v8::PersistentValueMap< K, V, Traits >::Clear(), v8::PersistentValueMap< K, V, Traits >::Contains(), v8::PersistentValueMap< K, V, Traits >::Get(), v8::PersistentValueMap< K, V, Traits >::GetReference(), v8::PersistentValueMap< K, V, Traits >::Remove(), v8::PersistentValueMap< K, V, Traits >::SetReference(), v8::PersistentValueMap< K, V, Traits >::SetReturnValue(), v8::PersistentValueMap< K, V, Traits >::SetUnique(), and v8::PersistentValueMap< K, V, Traits >::Size().

◆ isolate_

template<typename K , typename V , typename Traits >

Isolate* v8::PersistentValueMap< K, V, Traits >::isolate_

private

Definition at line 348 of file v8-util.h.

Referenced by v8::PersistentValueMap< K, V, Traits >::Clear(), v8::PersistentValueMap< K, V, Traits >::Get(), v8::PersistentValueMap< K, V, Traits >::GetIsolate(), v8::PersistentValueMap< K, V, Traits >::Set(), and v8::PersistentValueMap< K, V, Traits >::SetUnique().

The documentation for this class was generated from the following file:

/mnt/V8SourceCode/include/v8-util.h

Classes

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

template<typename K, typename V, typename Traits> class v8::PersistentValueMap< K, V, Traits >

Constructor & Destructor Documentation

◆ PersistentValueMap() [1/2]

◆ ~PersistentValueMap()

◆ PersistentValueMap() [2/2]

Member Function Documentation

◆ Clear()

◆ ClearAndLeak()

◆ Contains()

◆ FromVal()

◆ Get()

◆ GetIsolate()

◆ GetReference()

◆ IsWeak()

◆ Leak()

◆ operator=()

◆ Release()

◆ Remove()

◆ Set() [1/3]

◆ Set() [2/3]

◆ Set() [3/3]

◆ SetReference()

◆ SetReturnValue()

◆ SetReturnValueFromVal()

◆ SetUnique()

◆ Size()

◆ WeakCallback()

Member Data Documentation

◆ impl_

◆ isolate_

template<typename K, typename V, typename Traits>
class v8::PersistentValueMap< K, V, Traits >