remove phantom naming from the api

include/v8-util.h

 // Copyright 2014 the V8 project authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef V8_UTIL_H_
 #define V8_UTIL_H_
 
 #include "v8.h"
 #include <map>
 #include <vector>
 
 /**
  * Support for Persistent containers.
  *
- * C++11 embedders can use STL containers with UniquePersistent values,
+ * C++11 embedders can use STL containers with Global values,
  * but pre-C++11 does not support the required move semantic and hence
  * may want these container classes.
  */
 namespace v8 {
 
 typedef uintptr_t PersistentContainerValue;
 static const uintptr_t kPersistentContainerNotFound = 0;
 enum PersistentContainerCallbackType {
   kNotWeak,
-  kWeak
+  // These correspond to v8::WeakCallbackType
+  kWeakWithParameter,
+  kWeakWithInternalFields,
+  kWeak = kWeakWithParameter  // For backwards compatibility.  Deprecate.
 };
 
 
 /**
  * A default trait implemenation for PersistentValueMap which uses std::map
  * as a backing map.
  *
  * Users will have to implement their own weak callbacks & dispose traits.
  */
 template<typename K, typename V>
@@ skipping 58 matching lines @@
   }
   static MapType* MapFromWeakCallbackData(
           const WeakCallbackData<V, WeakCallbackDataType>& data) {
     return NULL;
   }
   static K KeyFromWeakCallbackData(
       const WeakCallbackData<V, WeakCallbackDataType>& data) {
     return K();
   }
   static void DisposeCallbackData(WeakCallbackDataType* data) { }
-  static void Dispose(Isolate* isolate, UniquePersistent<V> value, K key) { }
+  static void Dispose(Isolate* isolate, Global<V> value, K key) {}
 };
 
 
 template <typename K, typename V>
-class DefaultPhantomPersistentValueMapTraits : public StdMapTraits<K, V> {
+class DefaultGlobalMapTraits : public StdMapTraits<K, V> {
  private:
   template <typename T>
   struct RemovePointer;
 
  public:
   // Weak callback & friends:
   static const PersistentContainerCallbackType kCallbackType = kNotWeak;
-  typedef PersistentValueMap<
-      K, V, DefaultPhantomPersistentValueMapTraits<K, V> > MapType;
-  typedef void PhantomCallbackDataType;
+  typedef PersistentValueMap<K, V, DefaultGlobalMapTraits<K, V> > MapType;
+  typedef void WeakCallbackInfoType;
 
-  static PhantomCallbackDataType* PhantomCallbackParameter(MapType* map,
-                                                           const K& key,
-                                                           Local<V> value) {
-    return NULL;
+  static WeakCallbackInfoType* WeakCallbackParameter(MapType* map, const K& key,
+                                                     Local<V> value) {
+    return nullptr;
   }
-  static MapType* MapFromPhantomCallbackData(
-      const PhantomCallbackData<PhantomCallbackDataType>& data) {
-    return NULL;
+  static MapType* MapFromWeakCallbackInfo(
+      const WeakCallbackInfo<WeakCallbackInfoType>& data) {
+    return nullptr;
   }
-  static K KeyFromPhantomCallbackData(
-      const PhantomCallbackData<PhantomCallbackDataType>& data) {
+  static K KeyFromWeakCallbackInfo(
+      const WeakCallbackInfo<WeakCallbackInfoType>& data) {
     return K();
   }
-  static void DisposeCallbackData(PhantomCallbackDataType* data) {}
-  static void Dispose(Isolate* isolate, UniquePersistent<V> value, K key) {}
+  static void DisposeCallbackData(WeakCallbackInfoType* data) {}
+  static void Dispose(Isolate* isolate, Global<V> value, K key) {}
 
  private:
   template <typename T>
   struct RemovePointer<T*> {
     typedef T Type;
   };
 };
 
 
 /**
- * A map wrapper that allows using UniquePersistent as a mapped value.
- * C++11 embedders don't need this class, as they can use UniquePersistent
+ * A map wrapper that allows using Global as a mapped value.
+ * C++11 embedders don't need this class, as they can use Global
  * 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.
  */
 template <typename K, typename V, typename Traits>
 class PersistentValueMapBase {
  public:
@@ skipping 38 matching lines @@
   void SetReference(const K& key,
       const Persistent<Object>& parent) {
     GetIsolate()->SetReference(
       reinterpret_cast<internal::Object**>(parent.val_),
       reinterpret_cast<internal::Object**>(FromVal(Traits::Get(&impl_, key))));
   }
 
   /**
    * Return value for key and remove it from the map.
    */
-  UniquePersistent<V> Remove(const K& key) {
+  Global<V> Remove(const K& key) {
     return Release(Traits::Remove(&impl_, key)).Pass();
   }
 
   /**
   * Traverses the map repeatedly,
   * in case side effects of disposal cause insertions.
   **/
   void Clear() {
     typedef typename Traits::Iterator It;
     HandleScope handle_scope(isolate_);
@@ skipping 31 matching lines @@
     void Reset() {
       value_ = kPersistentContainerNotFound;
     }
     void operator=(const PersistentValueReference& other) {
       value_ = other.value_;
     }
 
    private:
     friend class PersistentValueMapBase;
     friend class PersistentValueMap<K, V, Traits>;
-    friend class PhantomPersistentValueMap<K, V, Traits>;
+    friend class GlobalValueMap<K, V, Traits>;
 
     explicit PersistentValueReference(PersistentContainerValue value)
         : value_(value) { }
 
     void operator=(PersistentContainerValue value) {
       value_ = value;
     }
 
     PersistentContainerValue value_;
   };
@@ skipping 17 matching lines @@
 
   ~PersistentValueMapBase() { Clear(); }
 
   Isolate* isolate() { return isolate_; }
   typename Traits::Impl* impl() { return &impl_; }
 
   static V* FromVal(PersistentContainerValue v) {
     return reinterpret_cast<V*>(v);
   }
 
-  static PersistentContainerValue ClearAndLeak(
-      UniquePersistent<V>* persistent) {
+  static PersistentContainerValue ClearAndLeak(Global<V>* persistent) {
     V* v = persistent->val_;
     persistent->val_ = 0;
     return reinterpret_cast<PersistentContainerValue>(v);
   }
 
-  static PersistentContainerValue Leak(UniquePersistent<V>* persistent) {
+  static PersistentContainerValue Leak(Global<V>* persistent) {
     return reinterpret_cast<PersistentContainerValue>(persistent->val_);
   }
 
   /**
-   * Return a container value as UniquePersistent and make sure the weak
+   * Return a container value as Global and make sure the weak
    * callback is properly disposed of. All remove functionality should go
    * through this.
    */
-  static UniquePersistent<V> Release(PersistentContainerValue v) {
-    UniquePersistent<V> p;
+  static Global<V> Release(PersistentContainerValue v) {
+    Global<V> p;
     p.val_ = FromVal(v);
     if (Traits::kCallbackType != kNotWeak && p.IsWeak()) {
       Traits::DisposeCallbackData(
           p.template ClearWeak<typename Traits::WeakCallbackDataType>());
     }
     return p.Pass();
   }
 
  private:
   PersistentValueMapBase(PersistentValueMapBase&);
@@ skipping 20 matching lines @@
   explicit PersistentValueMap(Isolate* isolate)
       : PersistentValueMapBase<K, V, Traits>(isolate) {}
 
   typedef
       typename PersistentValueMapBase<K, V, Traits>::PersistentValueReference
           PersistentValueReference;
 
   /**
    * Put value into map. Depending on Traits::kIsWeak, the value will be held
    * by the map strongly or weakly.
-   * Returns old value as UniquePersistent.
+   * Returns old value as Global.
    */
-  UniquePersistent<V> Set(const K& key, Local<V> value) {
-    UniquePersistent<V> persistent(this->isolate(), value);
+  Global<V> Set(const K& key, Local<V> value) {
+    Global<V> persistent(this->isolate(), value);
     return SetUnique(key, &persistent);
   }
 
   /**
    * Put value into map, like Set(const K&, Local<V>).
    */
-  UniquePersistent<V> Set(const K& key, UniquePersistent<V> value) {
+  Global<V> Set(const K& key, Global<V> value) {
     return SetUnique(key, &value);
   }
 
   /**
    * Put the value into the map, and set the 'weak' callback when demanded
    * by the Traits class.
    */
-  UniquePersistent<V> SetUnique(const K& key, UniquePersistent<V>* persistent) {
+  Global<V> SetUnique(const K& key, Global<V>* persistent) {
     if (Traits::kCallbackType != kNotWeak) {
       Local<V> value(Local<V>::New(this->isolate(), *persistent));
       persistent->template SetWeak<typename Traits::WeakCallbackDataType>(
         Traits::WeakCallbackParameter(this, key, value), WeakCallback);
     }
     PersistentContainerValue old_value =
         Traits::Set(this->impl(), key, this->ClearAndLeak(persistent));
     return this->Release(old_value).Pass();
   }
 
   /**
    * Put a value into the map and update the reference.
    * Restrictions of GetReference apply here as well.
    */
-  UniquePersistent<V> Set(const K& key, UniquePersistent<V> value,
-                          PersistentValueReference* reference) {
+  Global<V> Set(const K& key, Global<V> value,
+                PersistentValueReference* reference) {
     *reference = this->Leak(&value);
     return SetUnique(key, &value);
   }
 
  private:
   static void WeakCallback(
       const WeakCallbackData<V, typename Traits::WeakCallbackDataType>& data) {
     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());
     }
   }
 };
 
 
 template <typename K, typename V, typename Traits>
-class PhantomPersistentValueMap : public PersistentValueMapBase<K, V, Traits> {
+class GlobalValueMap : public PersistentValueMapBase<K, V, Traits> {
  public:
-  explicit PhantomPersistentValueMap(Isolate* isolate)
+  explicit GlobalValueMap(Isolate* isolate)
       : PersistentValueMapBase<K, V, Traits>(isolate) {}
 
   typedef
       typename PersistentValueMapBase<K, V, Traits>::PersistentValueReference
           PersistentValueReference;
 
   /**
    * Put value into map. Depending on Traits::kIsWeak, the value will be held
    * by the map strongly or weakly.
-   * Returns old value as UniquePersistent.
+   * Returns old value as Global.
    */
-  UniquePersistent<V> Set(const K& key, Local<V> value) {
-    UniquePersistent<V> persistent(this->isolate(), value);
+  Global<V> Set(const K& key, Local<V> value) {
+    Global<V> persistent(this->isolate(), value);
     return SetUnique(key, &persistent);
   }
 
   /**
    * Put value into map, like Set(const K&, Local<V>).
    */
-  UniquePersistent<V> Set(const K& key, UniquePersistent<V> value) {
+  Global<V> Set(const K& key, Global<V> value) {
     return SetUnique(key, &value);
   }
 
   /**
    * Put the value into the map, and set the 'weak' callback when demanded
    * by the Traits class.
    */
-  UniquePersistent<V> SetUnique(const K& key, UniquePersistent<V>* persistent) {
+  Global<V> SetUnique(const K& key, Global<V>* persistent) {
     if (Traits::kCallbackType != kNotWeak) {
+      WeakCallbackType callback_type =
+          Traits::kCallbackType == kWeakWithInternalFields
+              ? WeakCallbackType::kInternalFields
+              : WeakCallbackType::kParameter;
       Local<V> value(Local<V>::New(this->isolate(), *persistent));
-      persistent->template SetPhantom<typename Traits::WeakCallbackDataType>(
-          Traits::WeakCallbackParameter(this, key, value), WeakCallback, 0, 1);
+      persistent->template SetWeak<typename Traits::WeakCallbackDataType>(
+          Traits::WeakCallbackParameter(this, key, value), WeakCallback,
+          callback_type);
     }
     PersistentContainerValue old_value =
         Traits::Set(this->impl(), key, this->ClearAndLeak(persistent));
     return this->Release(old_value).Pass();
   }
 
   /**
    * Put a value into the map and update the reference.
    * Restrictions of GetReference apply here as well.
    */
-  UniquePersistent<V> Set(const K& key, UniquePersistent<V> value,
-                          PersistentValueReference* reference) {
+  Global<V> Set(const K& key, Global<V> value,
+                PersistentValueReference* reference) {
     *reference = this->Leak(&value);
     return SetUnique(key, &value);
   }
 
  private:
   static void WeakCallback(
-      const PhantomCallbackData<typename Traits::WeakCallbackDataType>& data) {
+      const WeakCallbackInfo<typename Traits::WeakCallbackDataType>& data) {
     if (Traits::kCallbackType != kNotWeak) {
-      PhantomPersistentValueMap<K, V, Traits>* persistentValueMap =
-          Traits::MapFromPhantomCallbackData(data);
-      K key = Traits::KeyFromPhantomCallbackData(data);
+      GlobalValueMap<K, V, Traits>* persistentValueMap =
+          Traits::MapFromWeakCallbackInfo(data);
+      K key = Traits::KeyFromWeakCallbackInfo(data);
       Traits::Dispose(data.GetIsolate(), persistentValueMap->Remove(key).Pass(),
                       key);
       Traits::DisposeCallbackData(data.GetParameter());
     }
   }
 };
 
 
 /**
- * A map that uses UniquePersistent as value and std::map as the backing
+ * A map that uses Global as value and std::map as the backing
  * implementation. Persistents are held non-weak.
  *
  * C++11 embedders don't need this class, as they can use
- * UniquePersistent directly in std containers.
+ * Global directly in std containers.
  */
 template<typename K, typename V,
     typename Traits = DefaultPersistentValueMapTraits<K, V> >
 class StdPersistentValueMap : public PersistentValueMap<K, V, Traits> {
  public:
   explicit StdPersistentValueMap(Isolate* isolate)
       : PersistentValueMap<K, V, Traits>(isolate) {}
 };
 
 
@@ skipping 16 matching lines @@
   static void ReserveCapacity(Impl* impl, size_t capacity) {
     impl->reserve(capacity);
   }
   static void Clear(Impl* impl) {
     impl->clear();
   }
 };
 
 
 /**
- * A vector wrapper that safely stores UniquePersistent values.
- * C++11 embedders don't need this class, as they can use UniquePersistent
+ * A vector wrapper that safely stores Global values.
+ * C++11 embedders don't need this class, as they can use Global
  * directly in std containers.
  *
  * This class relies on a backing vector implementation, whose type and methods
  * 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.
  */
 template<typename V, typename Traits = DefaultPersistentValueVectorTraits>
 class PersistentValueVector {
  public:
   explicit PersistentValueVector(Isolate* isolate) : isolate_(isolate) { }
 
   ~PersistentValueVector() {
     Clear();
   }
 
   /**
    * Append a value to the vector.
    */
   void Append(Local<V> value) {
-    UniquePersistent<V> persistent(isolate_, value);
+    Global<V> persistent(isolate_, value);
     Traits::Append(&impl_, ClearAndLeak(&persistent));
   }
 
   /**
    * Append a persistent's value to the vector.
    */
-  void Append(UniquePersistent<V> persistent) {
+  void Append(Global<V> persistent) {
     Traits::Append(&impl_, ClearAndLeak(&persistent));
   }
 
   /**
    * Are there any values in the vector?
    */
   bool IsEmpty() const {
     return Traits::IsEmpty(&impl_);
   }
 
@@ skipping 10 matching lines @@
   Local<V> Get(size_t index) const {
     return Local<V>::New(isolate_, FromVal(Traits::Get(&impl_, index)));
   }
 
   /**
    * Remove all elements from the vector.
    */
   void Clear() {
     size_t length = Traits::Size(&impl_);
     for (size_t i = 0; i < length; i++) {
-      UniquePersistent<V> p;
+      Global<V> p;
       p.val_ = FromVal(Traits::Get(&impl_, i));
     }
     Traits::Clear(&impl_);
   }
 
   /**
    * Reserve capacity in the vector.
    * (Efficiency gains depend on the backing implementation.)
    */
   void ReserveCapacity(size_t capacity) {
     Traits::ReserveCapacity(&impl_, capacity);
   }
 
  private:
-  static PersistentContainerValue ClearAndLeak(
-      UniquePersistent<V>* persistent) {
+  static PersistentContainerValue ClearAndLeak(Global<V>* persistent) {
     V* v = persistent->val_;
     persistent->val_ = 0;
     return reinterpret_cast<PersistentContainerValue>(v);
   }
 
   static V* FromVal(PersistentContainerValue v) {
     return reinterpret_cast<V*>(v);
   }
 
   Isolate* isolate_;
   typename Traits::Impl impl_;
 };
 
 }  // namespace v8
 
-#endif  // V8_UTIL_H_
+#endif  // V8_UTIL_H