v8  4.6.85(node5.12.0)
V8 is Google's open source JavaScript engine
v8.h
Go to the documentation of this file.
1 // Copyright 2012 the V8 project authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 /** \mainpage V8 API Reference Guide
6  *
7  * V8 is Google's open source JavaScript engine.
8  *
9  * This set of documents provides reference material generated from the
10  * V8 header file, include/v8.h.
11  *
12  * For other documentation see http://code.google.com/apis/v8/
13  */
14 
15 #ifndef V8_H_
16 #define V8_H_
17 
18 #include <stddef.h>
19 #include <stdint.h>
20 #include <stdio.h>
21 
22 #include "v8-version.h"
23 #include "v8config.h"
24 
25 // We reserve the V8_* prefix for macros defined in V8 public API and
26 // assume there are no name conflicts with the embedder's code.
27 
28 #ifdef V8_OS_WIN
29 
30 // Setup for Windows DLL export/import. When building the V8 DLL the
31 // BUILDING_V8_SHARED needs to be defined. When building a program which uses
32 // the V8 DLL USING_V8_SHARED needs to be defined. When either building the V8
33 // static library or building a program which uses the V8 static library neither
34 // BUILDING_V8_SHARED nor USING_V8_SHARED should be defined.
35 #if defined(BUILDING_V8_SHARED) && defined(USING_V8_SHARED)
36 #error both BUILDING_V8_SHARED and USING_V8_SHARED are set - please check the
37  build configuration to ensure that at most one of these is set
38 #endif
39 
40 #ifdef BUILDING_V8_SHARED
41 # define V8_EXPORT __declspec(dllexport)
42 #elif USING_V8_SHARED
43 # define V8_EXPORT __declspec(dllimport)
44 #else
45 # define V8_EXPORT
46 #endif // BUILDING_V8_SHARED
47 
48 #else // V8_OS_WIN
49 
50 // Setup for Linux shared library export.
51 #if V8_HAS_ATTRIBUTE_VISIBILITY && defined(V8_SHARED)
52 # ifdef BUILDING_V8_SHARED
53 # define V8_EXPORT __attribute__ ((visibility("default")))
54 # else
55 # define V8_EXPORT
56 # endif
57 #else
58 # define V8_EXPORT
59 #endif
60 
61 #endif // V8_OS_WIN
62 
63 /**
64  * The v8 JavaScript engine.
65  */
66 namespace v8 {
67 
68 class AccessorSignature;
69 class Array;
70 class Boolean;
71 class BooleanObject;
72 class Context;
73 class CpuProfiler;
74 class Data;
75 class Date;
76 class External;
77 class Function;
78 class FunctionTemplate;
79 class HeapProfiler;
80 class ImplementationUtilities;
81 class Int32;
82 class Integer;
83 class Isolate;
84 template <class T>
85 class Maybe;
86 class Name;
87 class Number;
88 class NumberObject;
89 class Object;
90 class ObjectOperationDescriptor;
91 class ObjectTemplate;
92 class Platform;
93 class Primitive;
94 class Promise;
95 class RawOperationDescriptor;
96 class Script;
97 class SharedArrayBuffer;
98 class Signature;
99 class StartupData;
100 class StackFrame;
101 class StackTrace;
102 class String;
103 class StringObject;
104 class Symbol;
105 class SymbolObject;
106 class Uint32;
107 class Utils;
108 class Value;
109 template <class T> class Local;
110 template <class T>
111 class MaybeLocal;
112 template <class T> class Eternal;
113 template<class T> class NonCopyablePersistentTraits;
114 template<class T> class PersistentBase;
115 template<class T,
116  class M = NonCopyablePersistentTraits<T> > class Persistent;
117 template <class T>
118 class Global;
119 template<class K, class V, class T> class PersistentValueMap;
120 template <class K, class V, class T>
122 template <class K, class V, class T>
123 class GlobalValueMap;
124 template<class V, class T> class PersistentValueVector;
125 template<class T, class P> class WeakCallbackObject;
126 class FunctionTemplate;
127 class ObjectTemplate;
128 class Data;
129 template<typename T> class FunctionCallbackInfo;
130 template<typename T> class PropertyCallbackInfo;
131 class StackTrace;
132 class StackFrame;
133 class Isolate;
134 class CallHandlerHelper;
136 template<typename T> class ReturnValue;
137 
138 namespace internal {
139 class Arguments;
140 class Heap;
141 class HeapObject;
142 class Isolate;
143 class Object;
144 struct StreamedSource;
145 template<typename T> class CustomArguments;
146 class PropertyCallbackArguments;
147 class FunctionCallbackArguments;
148 class GlobalHandles;
149 }
150 
151 
152 /**
153  * General purpose unique identifier.
154  */
155 class UniqueId {
156  public:
157  explicit UniqueId(intptr_t data)
158  : data_(data) {}
159 
160  bool operator==(const UniqueId& other) const {
161  return data_ == other.data_;
162  }
163 
164  bool operator!=(const UniqueId& other) const {
165  return data_ != other.data_;
166  }
167 
168  bool operator<(const UniqueId& other) const {
169  return data_ < other.data_;
170  }
171 
172  private:
173  intptr_t data_;
174 };
175 
176 // --- Handles ---
177 
178 #define TYPE_CHECK(T, S)
179  while (false) {
180  *(static_cast<T* volatile*>(0)) = static_cast<S*>(0);
181  }
182 
183 
184 /**
185  * An object reference managed by the v8 garbage collector.
186  *
187  * All objects returned from v8 have to be tracked by the garbage
188  * collector so that it knows that the objects are still alive. Also,
189  * because the garbage collector may move objects, it is unsafe to
190  * point directly to an object. Instead, all objects are stored in
191  * handles which are known by the garbage collector and updated
192  * whenever an object moves. Handles should always be passed by value
193  * (except in cases like out-parameters) and they should never be
194  * allocated on the heap.
195  *
196  * There are two types of handles: local and persistent handles.
197  * Local handles are light-weight and transient and typically used in
198  * local operations. They are managed by HandleScopes. Persistent
199  * handles can be used when storing objects across several independent
200  * operations and have to be explicitly deallocated when they're no
201  * longer used.
202  *
203  * It is safe to extract the object stored in the handle by
204  * dereferencing the handle (for instance, to extract the Object* from
205  * a Local<Object>); the value will still be governed by a handle
206  * behind the scenes and the same rules apply to these values as to
207  * their handles.
208  */
209 template <class T>
210 class Local {
211  public:
212  V8_INLINE Local() : val_(0) {}
213  template <class S>
214  V8_INLINE Local(Local<S> that)
215  : val_(reinterpret_cast<T*>(*that)) {
216  /**
217  * This check fails when trying to convert between incompatible
218  * handles. For example, converting from a Local<String> to a
219  * Local<Number>.
220  */
221  TYPE_CHECK(T, S);
222  }
223 
224  /**
225  * Returns true if the handle is empty.
226  */
227  V8_INLINE bool IsEmpty() const { return val_ == 0; }
228 
229  /**
230  * Sets the handle to be empty. IsEmpty() will then return true.
231  */
232  V8_INLINE void Clear() { val_ = 0; }
233 
234  V8_INLINE T* operator->() const { return val_; }
235 
236  V8_INLINE T* operator*() const { return val_; }
237 
238  /**
239  * Checks whether two handles are the same.
240  * Returns true if both are empty, or if the objects
241  * to which they refer are identical.
242  * The handles' references are not checked.
243  */
244  template <class S>
245  V8_INLINE bool operator==(const Local<S>& that) const {
246  internal::Object** a = reinterpret_cast<internal::Object**>(this->val_);
247  internal::Object** b = reinterpret_cast<internal::Object**>(that.val_);
248  if (a == 0) return b == 0;
249  if (b == 0) return false;
250  return *a == *b;
251  }
252 
253  template <class S> V8_INLINE bool operator==(
254  const PersistentBase<S>& that) const {
255  internal::Object** a = reinterpret_cast<internal::Object**>(this->val_);
256  internal::Object** b = reinterpret_cast<internal::Object**>(that.val_);
257  if (a == 0) return b == 0;
258  if (b == 0) return false;
259  return *a == *b;
260  }
261 
262  /**
263  * Checks whether two handles are different.
264  * Returns true if only one of the handles is empty, or if
265  * the objects to which they refer are different.
266  * The handles' references are not checked.
267  */
268  template <class S>
269  V8_INLINE bool operator!=(const Local<S>& that) const {
270  return !operator==(that);
271  }
272 
273  template <class S> V8_INLINE bool operator!=(
274  const Persistent<S>& that) const {
275  return !operator==(that);
276  }
277 
278  template <class S> V8_INLINE static Local<T> Cast(Local<S> that) {
279 #ifdef V8_ENABLE_CHECKS
280  // If we're going to perform the type check then we have to check
281  // that the handle isn't empty before doing the checked cast.
282  if (that.IsEmpty()) return Local<T>();
283 #endif
284  return Local<T>(T::Cast(*that));
285  }
286 
287 
288  template <class S> V8_INLINE Local<S> As() {
289  return Local<S>::Cast(*this);
290  }
291 
292  /**
293  * Create a local handle for the content of another handle.
294  * The referee is kept alive by the local handle even when
295  * the original handle is destroyed/disposed.
296  */
297  V8_INLINE static Local<T> New(Isolate* isolate, Local<T> that);
298  V8_INLINE static Local<T> New(Isolate* isolate,
299  const PersistentBase<T>& that);
300 
301  private:
302  friend class Utils;
303  template<class F> friend class Eternal;
304  template<class F> friend class PersistentBase;
305  template<class F, class M> friend class Persistent;
306  template<class F> friend class Local;
307  template <class F>
308  friend class MaybeLocal;
309  template<class F> friend class FunctionCallbackInfo;
310  template<class F> friend class PropertyCallbackInfo;
311  friend class String;
312  friend class Object;
313  friend class Context;
314  template<class F> friend class internal::CustomArguments;
316  friend Local<Primitive> Null(Isolate* isolate);
317  friend Local<Boolean> True(Isolate* isolate);
318  friend Local<Boolean> False(Isolate* isolate);
319  friend class HandleScope;
320  friend class EscapableHandleScope;
321  template <class F1, class F2, class F3>
323  template<class F1, class F2> friend class PersistentValueVector;
324 
325  template <class S>
326  V8_INLINE Local(S* that)
327  : val_(that) {}
328  V8_INLINE static Local<T> New(Isolate* isolate, T* that);
329  T* val_;
330 };
331 
332 
333 #if !defined(V8_IMMINENT_DEPRECATION_WARNINGS)
334 // Local is an alias for Local for historical reasons.
335 template <class T>
336 using Handle = Local<T>;
337 #endif
338 
339 
340 /**
341  * A MaybeLocal<> is a wrapper around Local<> that enforces a check whether
342  * the Local<> is empty before it can be used.
343  *
344  * If an API method returns a MaybeLocal<>, the API method can potentially fail
345  * either because an exception is thrown, or because an exception is pending,
346  * e.g. because a previous API call threw an exception that hasn't been caught
347  * yet, or because a TerminateExecution exception was thrown. In that case, an
348  * empty MaybeLocal is returned.
349  */
350 template <class T>
351 class MaybeLocal {
352  public:
354  template <class S>
355  V8_INLINE MaybeLocal(Local<S> that)
356  : val_(reinterpret_cast<T*>(*that)) {
357  TYPE_CHECK(T, S);
358  }
359 
360  V8_INLINE bool IsEmpty() const { return val_ == nullptr; }
361 
362  template <class S>
363  V8_WARN_UNUSED_RESULT V8_INLINE bool ToLocal(Local<S>* out) const {
364  out->val_ = IsEmpty() ? nullptr : this->val_;
365  return !IsEmpty();
366  }
367 
368  // Will crash if the MaybeLocal<> is empty.
369  V8_INLINE Local<T> ToLocalChecked();
370 
371  template <class S>
372  V8_INLINE Local<S> FromMaybe(Local<S> default_value) const {
373  return IsEmpty() ? default_value : Local<S>(val_);
374  }
375 
376  private:
377  T* val_;
378 };
379 
380 
381 // Eternal handles are set-once handles that live for the life of the isolate.
382 template <class T> class Eternal {
383  public:
384  V8_INLINE Eternal() : index_(kInitialValue) { }
385  template<class S>
386  V8_INLINE Eternal(Isolate* isolate, Local<S> handle) : index_(kInitialValue) {
387  Set(isolate, handle);
388  }
389  // Can only be safely called if already set.
390  V8_INLINE Local<T> Get(Isolate* isolate);
391  V8_INLINE bool IsEmpty() { return index_ == kInitialValue; }
392  template<class S> V8_INLINE void Set(Isolate* isolate, Local<S> handle);
393 
394  private:
395  static const int kInitialValue = -1;
396  int index_;
397 };
398 
399 
400 static const int kInternalFieldsInWeakCallback = 2;
401 
402 
403 template <typename T>
405  public:
406  typedef void (*Callback)(const WeakCallbackInfo<T>& data);
407 
408  WeakCallbackInfo(Isolate* isolate, T* parameter,
409  void* internal_fields[kInternalFieldsInWeakCallback],
410  Callback* callback)
411  : isolate_(isolate), parameter_(parameter), callback_(callback) {
412  for (int i = 0; i < kInternalFieldsInWeakCallback; ++i) {
413  internal_fields_[i] = internal_fields[i];
414  }
415  }
416 
417  V8_INLINE Isolate* GetIsolate() const { return isolate_; }
418  V8_INLINE T* GetParameter() const { return parameter_; }
419  V8_INLINE void* GetInternalField(int index) const;
420 
421  V8_INLINE V8_DEPRECATE_SOON("use indexed version",
422  void* GetInternalField1() const) {
423  return internal_fields_[0];
424  }
425  V8_INLINE V8_DEPRECATE_SOON("use indexed version",
426  void* GetInternalField2() const) {
427  return internal_fields_[1];
428  }
429 
430  bool IsFirstPass() const { return callback_ != nullptr; }
431 
432  // When first called, the embedder MUST Reset() the Global which triggered the
433  // callback. The Global itself is unusable for anything else. No v8 other api
434  // calls may be called in the first callback. Should additional work be
435  // required, the embedder must set a second pass callback, which will be
436  // called after all the initial callbacks are processed.
437  // Calling SetSecondPassCallback on the second pass will immediately crash.
438  void SetSecondPassCallback(Callback callback) const { *callback_ = callback; }
439 
440  private:
441  Isolate* isolate_;
442  T* parameter_;
443  Callback* callback_;
444  void* internal_fields_[kInternalFieldsInWeakCallback];
445 };
446 
447 
448 template <class T, class P>
450  public:
451  typedef void (*Callback)(const WeakCallbackData<T, P>& data);
452 
453  WeakCallbackData(Isolate* isolate, P* parameter, Local<T> handle)
454  : isolate_(isolate), parameter_(parameter), handle_(handle) {}
455 
456  V8_INLINE Isolate* GetIsolate() const { return isolate_; }
457  V8_INLINE P* GetParameter() const { return parameter_; }
458  V8_INLINE Local<T> GetValue() const { return handle_; }
459 
460  private:
461  Isolate* isolate_;
462  P* parameter_;
463  Local<T> handle_;
464 };
465 
466 
467 // TODO(dcarney): delete this with WeakCallbackData
468 template <class T>
469 using PhantomCallbackData = WeakCallbackInfo<T>;
470 
471 
473 
474 
475 /**
476  * An object reference that is independent of any handle scope. Where
477  * a Local handle only lives as long as the HandleScope in which it was
478  * allocated, a PersistentBase handle remains valid until it is explicitly
479  * disposed.
480  *
481  * A persistent handle contains a reference to a storage cell within
482  * the v8 engine which holds an object value and which is updated by
483  * the garbage collector whenever the object is moved. A new storage
484  * cell can be created using the constructor or PersistentBase::Reset and
485  * existing handles can be disposed using PersistentBase::Reset.
486  *
487  */
488 template <class T> class PersistentBase {
489  public:
490  /**
491  * If non-empty, destroy the underlying storage cell
492  * IsEmpty() will return true after this call.
493  */
494  V8_INLINE void Reset();
495  /**
496  * If non-empty, destroy the underlying storage cell
497  * and create a new one with the contents of other if other is non empty
498  */
499  template <class S>
500  V8_INLINE void Reset(Isolate* isolate, const Local<S>& other);
501 
502  /**
503  * If non-empty, destroy the underlying storage cell
504  * and create a new one with the contents of other if other is non empty
505  */
506  template <class S>
507  V8_INLINE void Reset(Isolate* isolate, const PersistentBase<S>& other);
508 
509  V8_INLINE bool IsEmpty() const { return val_ == NULL; }
510  V8_INLINE void Empty() { val_ = 0; }
511 
512  V8_INLINE Local<T> Get(Isolate* isolate) const {
513  return Local<T>::New(isolate, *this);
514  }
515 
516  template <class S>
517  V8_INLINE bool operator==(const PersistentBase<S>& that) const {
518  internal::Object** a = reinterpret_cast<internal::Object**>(this->val_);
519  internal::Object** b = reinterpret_cast<internal::Object**>(that.val_);
520  if (a == NULL) return b == NULL;
521  if (b == NULL) return false;
522  return *a == *b;
523  }
524 
525  template <class S>
526  V8_INLINE bool operator==(const Local<S>& that) const {
527  internal::Object** a = reinterpret_cast<internal::Object**>(this->val_);
528  internal::Object** b = reinterpret_cast<internal::Object**>(that.val_);
529  if (a == NULL) return b == NULL;
530  if (b == NULL) return false;
531  return *a == *b;
532  }
533 
534  template <class S>
535  V8_INLINE bool operator!=(const PersistentBase<S>& that) const {
536  return !operator==(that);
537  }
538 
539  template <class S>
540  V8_INLINE bool operator!=(const Local<S>& that) const {
541  return !operator==(that);
542  }
543 
544  /**
545  * Install a finalization callback on this object.
546  * NOTE: There is no guarantee as to *when* or even *if* the callback is
547  * invoked. The invocation is performed solely on a best effort basis.
548  * As always, GC-based finalization should *not* be relied upon for any
549  * critical form of resource management!
550  */
551  template <typename P>
553  "use WeakCallbackInfo version",
554  void SetWeak(P* parameter,
555  typename WeakCallbackData<T, P>::Callback callback));
556 
557  template <typename S, typename P>
559  "use WeakCallbackInfo version",
560  void SetWeak(P* parameter,
561  typename WeakCallbackData<S, P>::Callback callback));
562 
563  // Phantom persistents work like weak persistents, except that the pointer to
564  // the object being collected is not available in the finalization callback.
565  // This enables the garbage collector to collect the object and any objects
566  // it references transitively in one GC cycle. At the moment you can either
567  // specify a parameter for the callback or the location of two internal
568  // fields in the dying object.
569  template <typename P>
571  "use SetWeak",
572  void SetPhantom(P* parameter,
573  typename WeakCallbackInfo<P>::Callback callback,
574  int internal_field_index1 = -1,
575  int internal_field_index2 = -1));
576 
577  template <typename P>
578  V8_INLINE void SetWeak(P* parameter,
579  typename WeakCallbackInfo<P>::Callback callback,
580  WeakCallbackType type);
581 
582  template<typename P>
583  V8_INLINE P* ClearWeak();
584 
585  // TODO(dcarney): remove this.
586  V8_INLINE void ClearWeak() { ClearWeak<void>(); }
587 
588  /**
589  * Marks the reference to this object independent. Garbage collector is free
590  * to ignore any object groups containing this object. Weak callback for an
591  * independent handle should not assume that it will be preceded by a global
592  * GC prologue callback or followed by a global GC epilogue callback.
593  */
594  V8_INLINE void MarkIndependent();
595 
596  /**
597  * Marks the reference to this object partially dependent. Partially dependent
598  * handles only depend on other partially dependent handles and these
599  * dependencies are provided through object groups. It provides a way to build
600  * smaller object groups for young objects that represent only a subset of all
601  * external dependencies. This mark is automatically cleared after each
602  * garbage collection.
603  */
605 
606  V8_INLINE bool IsIndependent() const;
607 
608  /** Checks if the handle holds the only reference to an object. */
609  V8_INLINE bool IsNearDeath() const;
610 
611  /** Returns true if the handle's reference is weak. */
612  V8_INLINE bool IsWeak() const;
613 
614  /**
615  * Assigns a wrapper class ID to the handle. See RetainedObjectInfo interface
616  * description in v8-profiler.h for details.
617  */
618  V8_INLINE void SetWrapperClassId(uint16_t class_id);
619 
620  /**
621  * Returns the class ID previously assigned to this handle or 0 if no class ID
622  * was previously assigned.
623  */
624  V8_INLINE uint16_t WrapperClassId() const;
625 
626  private:
627  friend class Isolate;
628  friend class Utils;
629  template<class F> friend class Local;
630  template<class F1, class F2> friend class Persistent;
631  template <class F>
632  friend class Global;
633  template<class F> friend class PersistentBase;
634  template<class F> friend class ReturnValue;
635  template <class F1, class F2, class F3>
637  template<class F1, class F2> friend class PersistentValueVector;
638  friend class Object;
639 
640  explicit V8_INLINE PersistentBase(T* val) : val_(val) {}
641  PersistentBase(const PersistentBase& other) = delete; // NOLINT
642  void operator=(const PersistentBase&) = delete;
643  V8_INLINE static T* New(Isolate* isolate, T* that);
644 
645  T* val_;
646 };
647 
648 
649 /**
650  * Default traits for Persistent. This class does not allow
651  * use of the copy constructor or assignment operator.
652  * At present kResetInDestructor is not set, but that will change in a future
653  * version.
654  */
655 template<class T>
656 class NonCopyablePersistentTraits {
657  public:
658  typedef Persistent<T, NonCopyablePersistentTraits<T> > NonCopyablePersistent;
659  static const bool kResetInDestructor = false;
660  template<class S, class M>
661  V8_INLINE static void Copy(const Persistent<S, M>& source,
662  NonCopyablePersistent* dest) {
663  Uncompilable<Object>();
664  }
665  // TODO(dcarney): come up with a good compile error here.
666  template<class O> V8_INLINE static void Uncompilable() {
667  TYPE_CHECK(O, Primitive);
668  }
669 };
670 
671 
672 /**
673  * Helper class traits to allow copying and assignment of Persistent.
674  * This will clone the contents of storage cell, but not any of the flags, etc.
675  */
676 template<class T>
678  typedef Persistent<T, CopyablePersistentTraits<T> > CopyablePersistent;
679  static const bool kResetInDestructor = true;
680  template<class S, class M>
681  static V8_INLINE void Copy(const Persistent<S, M>& source,
682  CopyablePersistent* dest) {
683  // do nothing, just allow copy
684  }
685 };
686 
687 
688 /**
689  * A PersistentBase which allows copy and assignment.
690  *
691  * Copy, assignment and destructor bevavior is controlled by the traits
692  * class M.
693  *
694  * Note: Persistent class hierarchy is subject to future changes.
695  */
696 template <class T, class M> class Persistent : public PersistentBase<T> {
697  public:
698  /**
699  * A Persistent with no storage cell.
700  */
701  V8_INLINE Persistent() : PersistentBase<T>(0) { }
702  /**
703  * Construct a Persistent from a Local.
704  * When the Local is non-empty, a new storage cell is created
705  * pointing to the same object, and no flags are set.
706  */
707  template <class S>
708  V8_INLINE Persistent(Isolate* isolate, Local<S> that)
709  : PersistentBase<T>(PersistentBase<T>::New(isolate, *that)) {
710  TYPE_CHECK(T, S);
711  }
712  /**
713  * Construct a Persistent from a Persistent.
714  * When the Persistent is non-empty, a new storage cell is created
715  * pointing to the same object, and no flags are set.
716  */
717  template <class S, class M2>
718  V8_INLINE Persistent(Isolate* isolate, const Persistent<S, M2>& that)
719  : PersistentBase<T>(PersistentBase<T>::New(isolate, *that)) {
720  TYPE_CHECK(T, S);
721  }
722  /**
723  * The copy constructors and assignment operator create a Persistent
724  * exactly as the Persistent constructor, but the Copy function from the
725  * traits class is called, allowing the setting of flags based on the
726  * copied Persistent.
727  */
728  V8_INLINE Persistent(const Persistent& that) : PersistentBase<T>(0) {
729  Copy(that);
730  }
731  template <class S, class M2>
732  V8_INLINE Persistent(const Persistent<S, M2>& that) : PersistentBase<T>(0) {
733  Copy(that);
734  }
735  V8_INLINE Persistent& operator=(const Persistent& that) { // NOLINT
736  Copy(that);
737  return *this;
738  }
739  template <class S, class M2>
740  V8_INLINE Persistent& operator=(const Persistent<S, M2>& that) { // NOLINT
741  Copy(that);
742  return *this;
743  }
744  /**
745  * The destructor will dispose the Persistent based on the
746  * kResetInDestructor flags in the traits class. Since not calling dispose
747  * can result in a memory leak, it is recommended to always set this flag.
748  */
750  if (M::kResetInDestructor) this->Reset();
751  }
752 
753  // TODO(dcarney): this is pretty useless, fix or remove
754  template <class S>
755  V8_INLINE static Persistent<T>& Cast(Persistent<S>& that) { // NOLINT
756 #ifdef V8_ENABLE_CHECKS
757  // If we're going to perform the type check then we have to check
758  // that the handle isn't empty before doing the checked cast.
759  if (!that.IsEmpty()) T::Cast(*that);
760 #endif
761  return reinterpret_cast<Persistent<T>&>(that);
762  }
763 
764  // TODO(dcarney): this is pretty useless, fix or remove
765  template <class S> V8_INLINE Persistent<S>& As() { // NOLINT
766  return Persistent<S>::Cast(*this);
767  }
768 
769  private:
770  friend class Isolate;
771  friend class Utils;
772  template<class F> friend class Local;
773  template<class F1, class F2> friend class Persistent;
774  template<class F> friend class ReturnValue;
775 
776  template <class S> V8_INLINE Persistent(S* that) : PersistentBase<T>(that) { }
777  V8_INLINE T* operator*() const { return this->val_; }
778  template<class S, class M2>
779  V8_INLINE void Copy(const Persistent<S, M2>& that);
780 };
781 
782 
783 /**
784  * A PersistentBase which has move semantics.
785  *
786  * Note: Persistent class hierarchy is subject to future changes.
787  */
788 template <class T>
789 class Global : public PersistentBase<T> {
790  public:
791  /**
792  * A Global with no storage cell.
793  */
795  /**
796  * Construct a Global from a Local.
797  * When the Local is non-empty, a new storage cell is created
798  * pointing to the same object, and no flags are set.
799  */
800  template <class S>
801  V8_INLINE Global(Isolate* isolate, Local<S> that)
802  : PersistentBase<T>(PersistentBase<T>::New(isolate, *that)) {
803  TYPE_CHECK(T, S);
804  }
805  /**
806  * Construct a Global from a PersistentBase.
807  * When the Persistent is non-empty, a new storage cell is created
808  * pointing to the same object, and no flags are set.
809  */
810  template <class S>
811  V8_INLINE Global(Isolate* isolate, const PersistentBase<S>& that)
812  : PersistentBase<T>(PersistentBase<T>::New(isolate, that.val_)) {
813  TYPE_CHECK(T, S);
814  }
815  /**
816  * Move constructor.
817  */
818  V8_INLINE Global(Global&& other) : PersistentBase<T>(other.val_) {
819  other.val_ = nullptr;
820  }
821  V8_INLINE ~Global() { this->Reset(); }
822  /**
823  * Move via assignment.
824  */
825  template <class S>
826  V8_INLINE Global& operator=(Global<S>&& rhs) {
827  TYPE_CHECK(T, S);
828  if (this != &rhs) {
829  this->Reset();
830  this->val_ = rhs.val_;
831  rhs.val_ = nullptr;
832  }
833  return *this;
834  }
835  /**
836  * Pass allows returning uniques from functions, etc.
837  */
838  Global Pass() { return static_cast<Global&&>(*this); }
839 
840  /*
841  * For compatibility with Chromium's base::Bind (base::Passed).
842  */
843  typedef void MoveOnlyTypeForCPP03;
844 
845  private:
846  template <class F>
847  friend class ReturnValue;
848  Global(const Global&) = delete;
849  void operator=(const Global&) = delete;
850  V8_INLINE T* operator*() const { return this->val_; }
851 };
852 
853 
854 // UniquePersistent is an alias for Global for historical reason.
855 template <class T>
856 using UniquePersistent = Global<T>;
857 
858 
859  /**
860  * A stack-allocated class that governs a number of local handles.
861  * After a handle scope has been created, all local handles will be
862  * allocated within that handle scope until either the handle scope is
863  * deleted or another handle scope is created. If there is already a
864  * handle scope and a new one is created, all allocations will take
865  * place in the new handle scope until it is deleted. After that,
866  * new handles will again be allocated in the original handle scope.
867  *
868  * After the handle scope of a local handle has been deleted the
869  * garbage collector will no longer track the object stored in the
870  * handle and may deallocate it. The behavior of accessing a handle
871  * for which the handle scope has been deleted is undefined.
872  */
874  public:
875  HandleScope(Isolate* isolate);
876 
877  ~HandleScope();
878 
879  /**
880  * Counts the number of allocated handles.
881  */
882  static int NumberOfHandles(Isolate* isolate);
883 
885  return reinterpret_cast<Isolate*>(isolate_);
886  }
887 
888  protected:
890 
891  void Initialize(Isolate* isolate);
892 
893  static internal::Object** CreateHandle(internal::Isolate* isolate,
894  internal::Object* value);
895 
896  private:
897  // Uses heap_object to obtain the current Isolate.
898  static internal::Object** CreateHandle(internal::HeapObject* heap_object,
899  internal::Object* value);
900 
901  // Make it hard to create heap-allocated or illegal handle scopes by
902  // disallowing certain operations.
903  HandleScope(const HandleScope&);
904  void operator=(const HandleScope&);
905  void* operator new(size_t size);
906  void operator delete(void*, size_t);
907 
908  internal::Isolate* isolate_;
909  internal::Object** prev_next_;
910  internal::Object** prev_limit_;
911 
912  // Local::New uses CreateHandle with an Isolate* parameter.
913  template<class F> friend class Local;
914 
915  // Object::GetInternalField and Context::GetEmbedderData use CreateHandle with
916  // a HeapObject* in their shortcuts.
917  friend class Object;
918  friend class Context;
919 };
920 
921 
922 /**
923  * A HandleScope which first allocates a handle in the current scope
924  * which will be later filled with the escape value.
925  */
927  public:
928  EscapableHandleScope(Isolate* isolate);
930 
931  /**
932  * Pushes the value into the previous scope and returns a handle to it.
933  * Cannot be called twice.
934  */
935  template <class T>
936  V8_INLINE Local<T> Escape(Local<T> value) {
937  internal::Object** slot =
938  Escape(reinterpret_cast<internal::Object**>(*value));
939  return Local<T>(reinterpret_cast<T*>(slot));
940  }
941 
942  private:
943  internal::Object** Escape(internal::Object** escape_value);
944 
945  // Make it hard to create heap-allocated or illegal handle scopes by
946  // disallowing certain operations.
947  EscapableHandleScope(const EscapableHandleScope&);
948  void operator=(const EscapableHandleScope&);
949  void* operator new(size_t size);
950  void operator delete(void*, size_t);
951 
952  internal::Object** escape_slot_;
953 };
954 
956  public:
957  SealHandleScope(Isolate* isolate);
958  ~SealHandleScope();
959 
960  private:
961  // Make it hard to create heap-allocated or illegal handle scopes by
962  // disallowing certain operations.
963  SealHandleScope(const SealHandleScope&);
964  void operator=(const SealHandleScope&);
965  void* operator new(size_t size);
966  void operator delete(void*, size_t);
967 
968  internal::Isolate* isolate_;
969  int prev_level_;
970  internal::Object** prev_limit_;
971 };
972 
973 
974 // --- Special objects ---
975 
976 
977 /**
978  * The superclass of values and API object templates.
979  */
981  private:
982  Data();
983 };
984 
985 
986 /**
987  * The optional attributes of ScriptOrigin.
988  */
990  public:
991  V8_INLINE ScriptOriginOptions(bool is_embedder_debug_script = false,
992  bool is_shared_cross_origin = false,
993  bool is_opaque = false)
994  : flags_((is_embedder_debug_script ? kIsEmbedderDebugScript : 0) |
995  (is_shared_cross_origin ? kIsSharedCrossOrigin : 0) |
996  (is_opaque ? kIsOpaque : 0)) {}
998  : flags_(flags &
999  (kIsEmbedderDebugScript | kIsSharedCrossOrigin | kIsOpaque)) {}
1000  bool IsEmbedderDebugScript() const {
1001  return (flags_ & kIsEmbedderDebugScript) != 0;
1002  }
1003  bool IsSharedCrossOrigin() const {
1004  return (flags_ & kIsSharedCrossOrigin) != 0;
1005  }
1006  bool IsOpaque() const { return (flags_ & kIsOpaque) != 0; }
1007  int Flags() const { return flags_; }
1008 
1009  private:
1010  enum {
1011  kIsEmbedderDebugScript = 1,
1012  kIsSharedCrossOrigin = 1 << 1,
1013  kIsOpaque = 1 << 2
1014  };
1015  const int flags_;
1016 };
1017 
1018 /**
1019  * The origin, within a file, of a script.
1020  */
1022  public:
1024  Local<Value> resource_name,
1025  Local<Integer> resource_line_offset = Local<Integer>(),
1026  Local<Integer> resource_column_offset = Local<Integer>(),
1027  Local<Boolean> resource_is_shared_cross_origin = Local<Boolean>(),
1028  Local<Integer> script_id = Local<Integer>(),
1029  Local<Boolean> resource_is_embedder_debug_script = Local<Boolean>(),
1030  Local<Value> source_map_url = Local<Value>(),
1031  Local<Boolean> resource_is_opaque = Local<Boolean>());
1032  V8_INLINE Local<Value> ResourceName() const;
1033  V8_INLINE Local<Integer> ResourceLineOffset() const;
1034  V8_INLINE Local<Integer> ResourceColumnOffset() const;
1035  /**
1036  * Returns true for embedder's debugger scripts
1037  */
1038  V8_INLINE Local<Integer> ScriptID() const;
1039  V8_INLINE Local<Value> SourceMapUrl() const;
1040  V8_INLINE ScriptOriginOptions Options() const { return options_; }
1041 
1042  private:
1043  Local<Value> resource_name_;
1044  Local<Integer> resource_line_offset_;
1045  Local<Integer> resource_column_offset_;
1046  ScriptOriginOptions options_;
1047  Local<Integer> script_id_;
1048  Local<Value> source_map_url_;
1049 };
1050 
1051 
1052 /**
1053  * A compiled JavaScript script, not yet tied to a Context.
1054  */
1056  public:
1057  /**
1058  * Binds the script to the currently entered context.
1059  */
1060  Local<Script> BindToCurrentContext();
1061 
1062  int GetId();
1063  Local<Value> GetScriptName();
1064 
1065  /**
1066  * Data read from magic sourceURL comments.
1067  */
1068  Local<Value> GetSourceURL();
1069  /**
1070  * Data read from magic sourceMappingURL comments.
1071  */
1072  Local<Value> GetSourceMappingURL();
1073 
1074  /**
1075  * Returns zero based line number of the code_pos location in the script.
1076  * -1 will be returned if no information available.
1077  */
1078  int GetLineNumber(int code_pos);
1079 
1080  static const int kNoScriptId = 0;
1081 };
1082 
1083 
1084 /**
1085  * A compiled JavaScript script, tied to a Context which was active when the
1086  * script was compiled.
1087  */
1089  public:
1090  /**
1091  * A shorthand for ScriptCompiler::Compile().
1092  */
1093  static V8_DEPRECATE_SOON(
1094  "Use maybe version",
1095  Local<Script> Compile(Local<String> source,
1096  ScriptOrigin* origin = nullptr));
1097  static V8_WARN_UNUSED_RESULT MaybeLocal<Script> Compile(
1098  Local<Context> context, Local<String> source,
1099  ScriptOrigin* origin = nullptr);
1100 
1101  static Local<Script> V8_DEPRECATE_SOON("Use maybe version",
1102  Compile(Local<String> source,
1103  Local<String> file_name));
1104 
1105  /**
1106  * Runs the script returning the resulting value. It will be run in the
1107  * context in which it was created (ScriptCompiler::CompileBound or
1108  * UnboundScript::BindToCurrentContext()).
1109  */
1110  V8_DEPRECATE_SOON("Use maybe version", Local<Value> Run());
1111  V8_WARN_UNUSED_RESULT MaybeLocal<Value> Run(Local<Context> context);
1112 
1113  /**
1114  * Returns the corresponding context-unbound script.
1115  */
1117 };
1118 
1119 
1120 /**
1121  * For compiling scripts.
1122  */
1124  public:
1125  /**
1126  * Compilation data that the embedder can cache and pass back to speed up
1127  * future compilations. The data is produced if the CompilerOptions passed to
1128  * the compilation functions in ScriptCompiler contains produce_data_to_cache
1129  * = true. The data to cache can then can be retrieved from
1130  * UnboundScript.
1131  */
1136  };
1137 
1139  : data(NULL),
1140  length(0),
1141  rejected(false),
1143 
1144  // If buffer_policy is BufferNotOwned, the caller keeps the ownership of
1145  // data and guarantees that it stays alive until the CachedData object is
1146  // destroyed. If the policy is BufferOwned, the given data will be deleted
1147  // (with delete[]) when the CachedData object is destroyed.
1148  CachedData(const uint8_t* data, int length,
1149  BufferPolicy buffer_policy = BufferNotOwned);
1150  ~CachedData();
1151  // TODO(marja): Async compilation; add constructors which take a callback
1152  // which will be called when V8 no longer needs the data.
1153  const uint8_t* data;
1154  int length;
1155  bool rejected;
1157 
1158  private:
1159  // Prevent copying. Not implemented.
1160  CachedData(const CachedData&);
1161  CachedData& operator=(const CachedData&);
1162  };
1163 
1164  /**
1165  * Source code which can be then compiled to a UnboundScript or Script.
1166  */
1167  class Source {
1168  public:
1169  // Source takes ownership of CachedData.
1170  V8_INLINE Source(Local<String> source_string, const ScriptOrigin& origin,
1171  CachedData* cached_data = NULL);
1172  V8_INLINE Source(Local<String> source_string,
1173  CachedData* cached_data = NULL);
1174  V8_INLINE ~Source();
1175 
1176  // Ownership of the CachedData or its buffers is *not* transferred to the
1177  // caller. The CachedData object is alive as long as the Source object is
1178  // alive.
1179  V8_INLINE const CachedData* GetCachedData() const;
1180 
1181  private:
1182  friend class ScriptCompiler;
1183  // Prevent copying. Not implemented.
1184  Source(const Source&);
1185  Source& operator=(const Source&);
1186 
1187  Local<String> source_string;
1188 
1189  // Origin information
1190  Local<Value> resource_name;
1191  Local<Integer> resource_line_offset;
1192  Local<Integer> resource_column_offset;
1193  ScriptOriginOptions resource_options;
1194  Local<Value> source_map_url;
1195 
1196  // Cached data from previous compilation (if a kConsume*Cache flag is
1197  // set), or hold newly generated cache data (kProduce*Cache flags) are
1198  // set when calling a compile method.
1199  CachedData* cached_data;
1200  };
1201 
1202  /**
1203  * For streaming incomplete script data to V8. The embedder should implement a
1204  * subclass of this class.
1205  */
1207  public:
1208  virtual ~ExternalSourceStream() {}
1209 
1210  /**
1211  * V8 calls this to request the next chunk of data from the embedder. This
1212  * function will be called on a background thread, so it's OK to block and
1213  * wait for the data, if the embedder doesn't have data yet. Returns the
1214  * length of the data returned. When the data ends, GetMoreData should
1215  * return 0. Caller takes ownership of the data.
1216  *
1217  * When streaming UTF-8 data, V8 handles multi-byte characters split between
1218  * two data chunks, but doesn't handle multi-byte characters split between
1219  * more than two data chunks. The embedder can avoid this problem by always
1220  * returning at least 2 bytes of data.
1221  *
1222  * If the embedder wants to cancel the streaming, they should make the next
1223  * GetMoreData call return 0. V8 will interpret it as end of data (and most
1224  * probably, parsing will fail). The streaming task will return as soon as
1225  * V8 has parsed the data it received so far.
1226  */
1227  virtual size_t GetMoreData(const uint8_t** src) = 0;
1228 
1229  /**
1230  * V8 calls this method to set a 'bookmark' at the current position in
1231  * the source stream, for the purpose of (maybe) later calling
1232  * ResetToBookmark. If ResetToBookmark is called later, then subsequent
1233  * calls to GetMoreData should return the same data as they did when
1234  * SetBookmark was called earlier.
1235  *
1236  * The embedder may return 'false' to indicate it cannot provide this
1237  * functionality.
1238  */
1239  virtual bool SetBookmark();
1240 
1241  /**
1242  * V8 calls this to return to a previously set bookmark.
1243  */
1244  virtual void ResetToBookmark();
1245  };
1246 
1247 
1248  /**
1249  * Source code which can be streamed into V8 in pieces. It will be parsed
1250  * while streaming. It can be compiled after the streaming is complete.
1251  * StreamedSource must be kept alive while the streaming task is ran (see
1252  * ScriptStreamingTask below).
1253  */
1255  public:
1257 
1258  StreamedSource(ExternalSourceStream* source_stream, Encoding encoding);
1259  ~StreamedSource();
1260 
1261  // Ownership of the CachedData or its buffers is *not* transferred to the
1262  // caller. The CachedData object is alive as long as the StreamedSource
1263  // object is alive.
1264  const CachedData* GetCachedData() const;
1265 
1266  internal::StreamedSource* impl() const { return impl_; }
1267 
1268  private:
1269  // Prevent copying. Not implemented.
1270  StreamedSource(const StreamedSource&);
1271  StreamedSource& operator=(const StreamedSource&);
1272 
1273  internal::StreamedSource* impl_;
1274  };
1275 
1276  /**
1277  * A streaming task which the embedder must run on a background thread to
1278  * stream scripts into V8. Returned by ScriptCompiler::StartStreamingScript.
1279  */
1281  public:
1282  virtual ~ScriptStreamingTask() {}
1283  virtual void Run() = 0;
1284  };
1285 
1292  };
1293 
1294  /**
1295  * Compiles the specified script (context-independent).
1296  * Cached data as part of the source object can be optionally produced to be
1297  * consumed later to speed up compilation of identical source scripts.
1298  *
1299  * Note that when producing cached data, the source must point to NULL for
1300  * cached data. When consuming cached data, the cached data must have been
1301  * produced by the same version of V8.
1302  *
1303  * \param source Script source code.
1304  * \return Compiled script object (context independent; for running it must be
1305  * bound to a context).
1306  */
1307  static V8_DEPRECATE_SOON("Use maybe version",
1308  Local<UnboundScript> CompileUnbound(
1309  Isolate* isolate, Source* source,
1310  CompileOptions options = kNoCompileOptions));
1312  Isolate* isolate, Source* source,
1313  CompileOptions options = kNoCompileOptions);
1314 
1315  /**
1316  * Compiles the specified script (bound to current context).
1317  *
1318  * \param source Script source code.
1319  * \param pre_data Pre-parsing data, as obtained by ScriptData::PreCompile()
1320  * using pre_data speeds compilation if it's done multiple times.
1321  * Owned by caller, no references are kept when this function returns.
1322  * \return Compiled script object, bound to the context that was active
1323  * when this function was called. When run it will always use this
1324  * context.
1325  */
1326  static V8_DEPRECATE_SOON(
1327  "Use maybe version",
1328  Local<Script> Compile(Isolate* isolate, Source* source,
1329  CompileOptions options = kNoCompileOptions));
1330  static V8_WARN_UNUSED_RESULT MaybeLocal<Script> Compile(
1331  Local<Context> context, Source* source,
1332  CompileOptions options = kNoCompileOptions);
1333 
1334  /**
1335  * Returns a task which streams script data into V8, or NULL if the script
1336  * cannot be streamed. The user is responsible for running the task on a
1337  * background thread and deleting it. When ran, the task starts parsing the
1338  * script, and it will request data from the StreamedSource as needed. When
1339  * ScriptStreamingTask::Run exits, all data has been streamed and the script
1340  * can be compiled (see Compile below).
1341  *
1342  * This API allows to start the streaming with as little data as possible, and
1343  * the remaining data (for example, the ScriptOrigin) is passed to Compile.
1344  */
1346  Isolate* isolate, StreamedSource* source,
1347  CompileOptions options = kNoCompileOptions);
1348 
1349  /**
1350  * Compiles a streamed script (bound to current context).
1351  *
1352  * This can only be called after the streaming has finished
1353  * (ScriptStreamingTask has been run). V8 doesn't construct the source string
1354  * during streaming, so the embedder needs to pass the full source here.
1355  */
1356  static V8_DEPRECATE_SOON(
1357  "Use maybe version",
1358  Local<Script> Compile(Isolate* isolate, StreamedSource* source,
1359  Local<String> full_source_string,
1360  const ScriptOrigin& origin));
1361  static V8_WARN_UNUSED_RESULT MaybeLocal<Script> Compile(
1362  Local<Context> context, StreamedSource* source,
1363  Local<String> full_source_string, const ScriptOrigin& origin);
1364 
1365  /**
1366  * Return a version tag for CachedData for the current V8 version & flags.
1367  *
1368  * This value is meant only for determining whether a previously generated
1369  * CachedData instance is still valid; the tag has no other meaing.
1370  *
1371  * Background: The data carried by CachedData may depend on the exact
1372  * V8 version number or currently compiler flags. This means when
1373  * persisting CachedData, the embedder must take care to not pass in
1374  * data from another V8 version, or the same version with different
1375  * features enabled.
1376  *
1377  * The easiest way to do so is to clear the embedder's cache on any
1378  * such change.
1379  *
1380  * Alternatively, this tag can be stored alongside the cached data and
1381  * compared when it is being used.
1382  */
1383  static uint32_t CachedDataVersionTag();
1384 
1385  /**
1386  * Compile an ES6 module.
1387  *
1388  * This is an unfinished experimental feature, and is only exposed
1389  * here for internal testing purposes.
1390  * Only parsing works at the moment. Do not use.
1391  *
1392  * TODO(adamk): Script is likely the wrong return value for this;
1393  * should return some new Module type.
1394  */
1395  static V8_WARN_UNUSED_RESULT MaybeLocal<Script> CompileModule(
1396  Local<Context> context, Source* source,
1397  CompileOptions options = kNoCompileOptions);
1398 
1399  /**
1400  * Compile a function for a given context. This is equivalent to running
1401  *
1402  * with (obj) {
1403  * return function(args) { ... }
1404  * }
1405  *
1406  * It is possible to specify multiple context extensions (obj in the above
1407  * example).
1408  */
1409  static V8_DEPRECATE_SOON("Use maybe version",
1410  Local<Function> CompileFunctionInContext(
1411  Isolate* isolate, Source* source,
1412  Local<Context> context, size_t arguments_count,
1413  Local<String> arguments[],
1414  size_t context_extension_count,
1415  Local<Object> context_extensions[]));
1417  Local<Context> context, Source* source, size_t arguments_count,
1418  Local<String> arguments[], size_t context_extension_count,
1419  Local<Object> context_extensions[]);
1420 
1421  private:
1422  static V8_WARN_UNUSED_RESULT MaybeLocal<UnboundScript> CompileUnboundInternal(
1423  Isolate* isolate, Source* source, CompileOptions options, bool is_module);
1424 };
1425 
1426 
1427 /**
1428  * An error message.
1429  */
1431  public:
1432  Local<String> Get() const;
1433 
1434  V8_DEPRECATE_SOON("Use maybe version", Local<String> GetSourceLine() const);
1436  Local<Context> context) const;
1437 
1438  /**
1439  * Returns the origin for the script from where the function causing the
1440  * error originates.
1441  */
1442  ScriptOrigin GetScriptOrigin() const;
1443 
1444  /**
1445  * Returns the resource name for the script from where the function causing
1446  * the error originates.
1447  */
1448  Local<Value> GetScriptResourceName() const;
1449 
1450  /**
1451  * Exception stack trace. By default stack traces are not captured for
1452  * uncaught exceptions. SetCaptureStackTraceForUncaughtExceptions allows
1453  * to change this option.
1454  */
1455  Local<StackTrace> GetStackTrace() const;
1456 
1457  /**
1458  * Returns the number, 1-based, of the line where the error occurred.
1459  */
1460  V8_DEPRECATE_SOON("Use maybe version", int GetLineNumber() const);
1461  V8_WARN_UNUSED_RESULT Maybe<int> GetLineNumber(Local<Context> context) const;
1462 
1463  /**
1464  * Returns the index within the script of the first character where
1465  * the error occurred.
1466  */
1467  int GetStartPosition() const;
1468 
1469  /**
1470  * Returns the index within the script of the last character where
1471  * the error occurred.
1472  */
1473  int GetEndPosition() const;
1474 
1475  /**
1476  * Returns the index within the line of the first character where
1477  * the error occurred.
1478  */
1479  V8_DEPRECATE_SOON("Use maybe version", int GetStartColumn() const);
1480  V8_WARN_UNUSED_RESULT Maybe<int> GetStartColumn(Local<Context> context) const;
1481 
1482  /**
1483  * Returns the index within the line of the last character where
1484  * the error occurred.
1485  */
1486  V8_DEPRECATE_SOON("Use maybe version", int GetEndColumn() const);
1487  V8_WARN_UNUSED_RESULT Maybe<int> GetEndColumn(Local<Context> context) const;
1488 
1489  /**
1490  * Passes on the value set by the embedder when it fed the script from which
1491  * this Message was generated to V8.
1492  */
1493  bool IsSharedCrossOrigin() const;
1494  bool IsOpaque() const;
1495 
1496  // TODO(1245381): Print to a string instead of on a FILE.
1497  static void PrintCurrentStackTrace(Isolate* isolate, FILE* out);
1498 
1499  static const int kNoLineNumberInfo = 0;
1500  static const int kNoColumnInfo = 0;
1501  static const int kNoScriptIdInfo = 0;
1502 };
1503 
1504 
1505 /**
1506  * Representation of a JavaScript stack trace. The information collected is a
1507  * snapshot of the execution stack and the information remains valid after
1508  * execution continues.
1509  */
1511  public:
1512  /**
1513  * Flags that determine what information is placed captured for each
1514  * StackFrame when grabbing the current stack trace.
1515  */
1519  kScriptName = 1 << 2,
1520  kFunctionName = 1 << 3,
1521  kIsEval = 1 << 4,
1522  kIsConstructor = 1 << 5,
1524  kScriptId = 1 << 7,
1528  };
1529 
1530  /**
1531  * Returns a StackFrame at a particular index.
1532  */
1533  Local<StackFrame> GetFrame(uint32_t index) const;
1534 
1535  /**
1536  * Returns the number of StackFrames.
1537  */
1538  int GetFrameCount() const;
1539 
1540  /**
1541  * Returns StackTrace as a v8::Array that contains StackFrame objects.
1542  */
1543  Local<Array> AsArray();
1544 
1545  /**
1546  * Grab a snapshot of the current JavaScript execution stack.
1547  *
1548  * \param frame_limit The maximum number of stack frames we want to capture.
1549  * \param options Enumerates the set of things we will capture for each
1550  * StackFrame.
1551  */
1552  static Local<StackTrace> CurrentStackTrace(
1553  Isolate* isolate,
1554  int frame_limit,
1555  StackTraceOptions options = kOverview);
1556 };
1557 
1558 
1559 /**
1560  * A single JavaScript stack frame.
1561  */
1563  public:
1564  /**
1565  * Returns the number, 1-based, of the line for the associate function call.
1566  * This method will return Message::kNoLineNumberInfo if it is unable to
1567  * retrieve the line number, or if kLineNumber was not passed as an option
1568  * when capturing the StackTrace.
1569  */
1570  int GetLineNumber() const;
1571 
1572  /**
1573  * Returns the 1-based column offset on the line for the associated function
1574  * call.
1575  * This method will return Message::kNoColumnInfo if it is unable to retrieve
1576  * the column number, or if kColumnOffset was not passed as an option when
1577  * capturing the StackTrace.
1578  */
1579  int GetColumn() const;
1580 
1581  /**
1582  * Returns the id of the script for the function for this StackFrame.
1583  * This method will return Message::kNoScriptIdInfo if it is unable to
1584  * retrieve the script id, or if kScriptId was not passed as an option when
1585  * capturing the StackTrace.
1586  */
1587  int GetScriptId() const;
1588 
1589  /**
1590  * Returns the name of the resource that contains the script for the
1591  * function for this StackFrame.
1592  */
1593  Local<String> GetScriptName() const;
1594 
1595  /**
1596  * Returns the name of the resource that contains the script for the
1597  * function for this StackFrame or sourceURL value if the script name
1598  * is undefined and its source ends with //# sourceURL=... string or
1599  * deprecated //@ sourceURL=... string.
1600  */
1601  Local<String> GetScriptNameOrSourceURL() const;
1602 
1603  /**
1604  * Returns the name of the function associated with this stack frame.
1605  */
1606  Local<String> GetFunctionName() const;
1607 
1608  /**
1609  * Returns whether or not the associated function is compiled via a call to
1610  * eval().
1611  */
1612  bool IsEval() const;
1613 
1614  /**
1615  * Returns whether or not the associated function is called as a
1616  * constructor via "new".
1617  */
1618  bool IsConstructor() const;
1619 };
1620 
1621 
1622 // A StateTag represents a possible state of the VM.
1624 
1625 
1626 // A RegisterState represents the current state of registers used
1627 // by the sampling profiler API.
1629  RegisterState() : pc(NULL), sp(NULL), fp(NULL) {}
1630  void* pc; // Instruction pointer.
1631  void* sp; // Stack pointer.
1632  void* fp; // Frame pointer.
1633 };
1634 
1635 
1636 // The output structure filled up by GetStackSample API function.
1637 struct SampleInfo {
1640 };
1641 
1642 
1643 /**
1644  * A JSON Parser.
1645  */
1647  public:
1648  /**
1649  * Tries to parse the string |json_string| and returns it as value if
1650  * successful.
1651  *
1652  * \param json_string The string to parse.
1653  * \return The corresponding value if successfully parsed.
1654  */
1655  static V8_DEPRECATE_SOON("Use maybe version",
1656  Local<Value> Parse(Local<String> json_string));
1657  static V8_WARN_UNUSED_RESULT MaybeLocal<Value> Parse(
1658  Isolate* isolate, Local<String> json_string);
1659 };
1660 
1661 
1662 /**
1663  * A map whose keys are referenced weakly. It is similar to JavaScript WeakMap
1664  * but can be created without entering a v8::Context and hence shouldn't
1665  * escape to JavaScript.
1666  */
1667 class V8_EXPORT NativeWeakMap : public Data {
1668  public:
1669  static Local<NativeWeakMap> New(Isolate* isolate);
1670  void Set(Local<Value> key, Local<Value> value);
1671  Local<Value> Get(Local<Value> key);
1672  bool Has(Local<Value> key);
1673  bool Delete(Local<Value> key);
1674 };
1675 
1676 
1677 // --- Value ---
1678 
1679 
1680 /**
1681  * The superclass of all JavaScript values and objects.
1682  */
1683 class V8_EXPORT Value : public Data {
1684  public:
1685  /**
1686  * Returns true if this value is the undefined value. See ECMA-262
1687  * 4.3.10.
1688  */
1689  V8_INLINE bool IsUndefined() const;
1690 
1691  /**
1692  * Returns true if this value is the null value. See ECMA-262
1693  * 4.3.11.
1694  */
1695  V8_INLINE bool IsNull() const;
1696 
1697  /**
1698  * Returns true if this value is true.
1699  */
1700  bool IsTrue() const;
1701 
1702  /**
1703  * Returns true if this value is false.
1704  */
1705  bool IsFalse() const;
1706 
1707  /**
1708  * Returns true if this value is a symbol or a string.
1709  * This is an experimental feature.
1710  */
1711  bool IsName() const;
1712 
1713  /**
1714  * Returns true if this value is an instance of the String type.
1715  * See ECMA-262 8.4.
1716  */
1717  V8_INLINE bool IsString() const;
1718 
1719  /**
1720  * Returns true if this value is a symbol.
1721  * This is an experimental feature.
1722  */
1723  bool IsSymbol() const;
1724 
1725  /**
1726  * Returns true if this value is a function.
1727  */
1728  bool IsFunction() const;
1729 
1730  /**
1731  * Returns true if this value is an array.
1732  */
1733  bool IsArray() const;
1734 
1735  /**
1736  * Returns true if this value is an object.
1737  */
1738  bool IsObject() const;
1739 
1740  /**
1741  * Returns true if this value is boolean.
1742  */
1743  bool IsBoolean() const;
1744 
1745  /**
1746  * Returns true if this value is a number.
1747  */
1748  bool IsNumber() const;
1749 
1750  /**
1751  * Returns true if this value is external.
1752  */
1753  bool IsExternal() const;
1754 
1755  /**
1756  * Returns true if this value is a 32-bit signed integer.
1757  */
1758  bool IsInt32() const;
1759 
1760  /**
1761  * Returns true if this value is a 32-bit unsigned integer.
1762  */
1763  bool IsUint32() const;
1764 
1765  /**
1766  * Returns true if this value is a Date.
1767  */
1768  bool IsDate() const;
1769 
1770  /**
1771  * Returns true if this value is an Arguments object.
1772  */
1773  bool IsArgumentsObject() const;
1774 
1775  /**
1776  * Returns true if this value is a Boolean object.
1777  */
1778  bool IsBooleanObject() const;
1779 
1780  /**
1781  * Returns true if this value is a Number object.
1782  */
1783  bool IsNumberObject() const;
1784 
1785  /**
1786  * Returns true if this value is a String object.
1787  */
1788  bool IsStringObject() const;
1789 
1790  /**
1791  * Returns true if this value is a Symbol object.
1792  * This is an experimental feature.
1793  */
1794  bool IsSymbolObject() const;
1795 
1796  /**
1797  * Returns true if this value is a NativeError.
1798  */
1799  bool IsNativeError() const;
1800 
1801  /**
1802  * Returns true if this value is a RegExp.
1803  */
1804  bool IsRegExp() const;
1805 
1806  /**
1807  * Returns true if this value is a Generator function.
1808  * This is an experimental feature.
1809  */
1810  bool IsGeneratorFunction() const;
1811 
1812  /**
1813  * Returns true if this value is a Generator object (iterator).
1814  * This is an experimental feature.
1815  */
1816  bool IsGeneratorObject() const;
1817 
1818  /**
1819  * Returns true if this value is a Promise.
1820  * This is an experimental feature.
1821  */
1822  bool IsPromise() const;
1823 
1824  /**
1825  * Returns true if this value is a Map.
1826  */
1827  bool IsMap() const;
1828 
1829  /**
1830  * Returns true if this value is a Set.
1831  */
1832  bool IsSet() const;
1833 
1834  /**
1835  * Returns true if this value is a Map Iterator.
1836  */
1837  bool IsMapIterator() const;
1838 
1839  /**
1840  * Returns true if this value is a Set Iterator.
1841  */
1842  bool IsSetIterator() const;
1843 
1844  /**
1845  * Returns true if this value is a WeakMap.
1846  */
1847  bool IsWeakMap() const;
1848 
1849  /**
1850  * Returns true if this value is a WeakSet.
1851  */
1852  bool IsWeakSet() const;
1853 
1854  /**
1855  * Returns true if this value is an ArrayBuffer.
1856  * This is an experimental feature.
1857  */
1858  bool IsArrayBuffer() const;
1859 
1860  /**
1861  * Returns true if this value is an ArrayBufferView.
1862  * This is an experimental feature.
1863  */
1864  bool IsArrayBufferView() const;
1865 
1866  /**
1867  * Returns true if this value is one of TypedArrays.
1868  * This is an experimental feature.
1869  */
1870  bool IsTypedArray() const;
1871 
1872  /**
1873  * Returns true if this value is an Uint8Array.
1874  * This is an experimental feature.
1875  */
1876  bool IsUint8Array() const;
1877 
1878  /**
1879  * Returns true if this value is an Uint8ClampedArray.
1880  * This is an experimental feature.
1881  */
1882  bool IsUint8ClampedArray() const;
1883 
1884  /**
1885  * Returns true if this value is an Int8Array.
1886  * This is an experimental feature.
1887  */
1888  bool IsInt8Array() const;
1889 
1890  /**
1891  * Returns true if this value is an Uint16Array.
1892  * This is an experimental feature.
1893  */
1894  bool IsUint16Array() const;
1895 
1896  /**
1897  * Returns true if this value is an Int16Array.
1898  * This is an experimental feature.
1899  */
1900  bool IsInt16Array() const;
1901 
1902  /**
1903  * Returns true if this value is an Uint32Array.
1904  * This is an experimental feature.
1905  */
1906  bool IsUint32Array() const;
1907 
1908  /**
1909  * Returns true if this value is an Int32Array.
1910  * This is an experimental feature.
1911  */
1912  bool IsInt32Array() const;
1913 
1914  /**
1915  * Returns true if this value is a Float32Array.
1916  * This is an experimental feature.
1917  */
1918  bool IsFloat32Array() const;
1919 
1920  /**
1921  * Returns true if this value is a Float64Array.
1922  * This is an experimental feature.
1923  */
1924  bool IsFloat64Array() const;
1925 
1926  /**
1927  * Returns true if this value is a SIMD Float32x4.
1928  * This is an experimental feature.
1929  */
1930  bool IsFloat32x4() const;
1931 
1932  /**
1933  * Returns true if this value is a DataView.
1934  * This is an experimental feature.
1935  */
1936  bool IsDataView() const;
1937 
1938  /**
1939  * Returns true if this value is a SharedArrayBuffer.
1940  * This is an experimental feature.
1941  */
1942  bool IsSharedArrayBuffer() const;
1943 
1944 
1946  Local<Context> context) const;
1948  Local<Context> context) const;
1950  Local<Context> context) const;
1952  Local<Context> context) const;
1954  Local<Context> context) const;
1956  Local<Context> context) const;
1958  Local<Context> context) const;
1959  V8_WARN_UNUSED_RESULT MaybeLocal<Int32> ToInt32(Local<Context> context) const;
1960 
1961  V8_DEPRECATE_SOON("Use maybe version",
1962  Local<Boolean> ToBoolean(Isolate* isolate) const);
1963  V8_DEPRECATE_SOON("Use maybe version",
1964  Local<Number> ToNumber(Isolate* isolate) const);
1965  V8_DEPRECATE_SOON("Use maybe version",
1966  Local<String> ToString(Isolate* isolate) const);
1967  V8_DEPRECATE_SOON("Use maybe version",
1968  Local<String> ToDetailString(Isolate* isolate) const);
1969  V8_DEPRECATE_SOON("Use maybe version",
1970  Local<Object> ToObject(Isolate* isolate) const);
1971  V8_DEPRECATE_SOON("Use maybe version",
1972  Local<Integer> ToInteger(Isolate* isolate) const);
1973  V8_DEPRECATE_SOON("Use maybe version",
1974  Local<Uint32> ToUint32(Isolate* isolate) const);
1975  V8_DEPRECATE_SOON("Use maybe version",
1976  Local<Int32> ToInt32(Isolate* isolate) const);
1977 
1978  inline V8_DEPRECATE_SOON("Use maybe version",
1979  Local<Boolean> ToBoolean() const);
1980  inline V8_DEPRECATE_SOON("Use maybe version", Local<Number> ToNumber() const);
1981  inline V8_DEPRECATE_SOON("Use maybe version", Local<String> ToString() const);
1982  inline V8_DEPRECATE_SOON("Use maybe version",
1983  Local<String> ToDetailString() const);
1984  inline V8_DEPRECATE_SOON("Use maybe version", Local<Object> ToObject() const);
1985  inline V8_DEPRECATE_SOON("Use maybe version",
1986  Local<Integer> ToInteger() const);
1987  inline V8_DEPRECATE_SOON("Use maybe version", Local<Uint32> ToUint32() const);
1988  inline V8_DEPRECATE_SOON("Use maybe version", Local<Int32> ToInt32() const);
1989 
1990  /**
1991  * Attempts to convert a string to an array index.
1992  * Returns an empty handle if the conversion fails.
1993  */
1994  V8_DEPRECATE_SOON("Use maybe version", Local<Uint32> ToArrayIndex() const);
1996  Local<Context> context) const;
1997 
1998  V8_WARN_UNUSED_RESULT Maybe<bool> BooleanValue(Local<Context> context) const;
1999  V8_WARN_UNUSED_RESULT Maybe<double> NumberValue(Local<Context> context) const;
2000  V8_WARN_UNUSED_RESULT Maybe<int64_t> IntegerValue(
2001  Local<Context> context) const;
2002  V8_WARN_UNUSED_RESULT Maybe<uint32_t> Uint32Value(
2003  Local<Context> context) const;
2004  V8_WARN_UNUSED_RESULT Maybe<int32_t> Int32Value(Local<Context> context) const;
2005 
2006  V8_DEPRECATE_SOON("Use maybe version", bool BooleanValue() const);
2007  V8_DEPRECATE_SOON("Use maybe version", double NumberValue() const);
2008  V8_DEPRECATE_SOON("Use maybe version", int64_t IntegerValue() const);
2009  V8_DEPRECATE_SOON("Use maybe version", uint32_t Uint32Value() const);
2010  V8_DEPRECATE_SOON("Use maybe version", int32_t Int32Value() const);
2011 
2012  /** JS == */
2013  V8_DEPRECATE_SOON("Use maybe version", bool Equals(Local<Value> that) const);
2014  V8_WARN_UNUSED_RESULT Maybe<bool> Equals(Local<Context> context,
2015  Local<Value> that) const;
2016  bool StrictEquals(Local<Value> that) const;
2017  bool SameValue(Local<Value> that) const;
2018 
2019  template <class T> V8_INLINE static Value* Cast(T* value);
2020 
2021  private:
2022  V8_INLINE bool QuickIsUndefined() const;
2023  V8_INLINE bool QuickIsNull() const;
2024  V8_INLINE bool QuickIsString() const;
2025  bool FullIsUndefined() const;
2026  bool FullIsNull() const;
2027  bool FullIsString() const;
2028 };
2029 
2030 
2031 /**
2032  * The superclass of primitive values. See ECMA-262 4.3.2.
2033  */
2034 class V8_EXPORT Primitive : public Value { };
2035 
2036 
2037 /**
2038  * A primitive boolean value (ECMA-262, 4.3.14). Either the true
2039  * or false value.
2040  */
2041 class V8_EXPORT Boolean : public Primitive {
2042  public:
2043  bool Value() const;
2044  V8_INLINE static Boolean* Cast(v8::Value* obj);
2045  V8_INLINE static Local<Boolean> New(Isolate* isolate, bool value);
2046 
2047  private:
2048  static void CheckCast(v8::Value* obj);
2049 };
2050 
2051 
2052 /**
2053  * A superclass for symbols and strings.
2054  */
2055 class V8_EXPORT Name : public Primitive {
2056  public:
2057  /**
2058  * Returns the identity hash for this object. The current implementation
2059  * uses an inline property on the object to store the identity hash.
2060  *
2061  * The return value will never be 0. Also, it is not guaranteed to be
2062  * unique.
2063  */
2064  int GetIdentityHash();
2065 
2066  V8_INLINE static Name* Cast(v8::Value* obj);
2067  private:
2068  static void CheckCast(v8::Value* obj);
2069 };
2070 
2071 
2073 
2074 
2075 /**
2076  * A JavaScript string value (ECMA-262, 4.3.17).
2077  */
2078 class V8_EXPORT String : public Name {
2079  public:
2080  static const int kMaxLength = (1 << 28) - 16;
2081 
2082  enum Encoding {
2086  };
2087  /**
2088  * Returns the number of characters in this string.
2089  */
2090  int Length() const;
2091 
2092  /**
2093  * Returns the number of bytes in the UTF-8 encoded
2094  * representation of this string.
2095  */
2096  int Utf8Length() const;
2097 
2098  /**
2099  * Returns whether this string is known to contain only one byte data.
2100  * Does not read the string.
2101  * False negatives are possible.
2102  */
2103  bool IsOneByte() const;
2104 
2105  /**
2106  * Returns whether this string contain only one byte data.
2107  * Will read the entire string in some cases.
2108  */
2109  bool ContainsOnlyOneByte() const;
2110 
2111  /**
2112  * Write the contents of the string to an external buffer.
2113  * If no arguments are given, expects the buffer to be large
2114  * enough to hold the entire string and NULL terminator. Copies
2115  * the contents of the string and the NULL terminator into the
2116  * buffer.
2117  *
2118  * WriteUtf8 will not write partial UTF-8 sequences, preferring to stop
2119  * before the end of the buffer.
2120  *
2121  * Copies up to length characters into the output buffer.
2122  * Only null-terminates if there is enough space in the buffer.
2123  *
2124  * \param buffer The buffer into which the string will be copied.
2125  * \param start The starting position within the string at which
2126  * copying begins.
2127  * \param length The number of characters to copy from the string. For
2128  * WriteUtf8 the number of bytes in the buffer.
2129  * \param nchars_ref The number of characters written, can be NULL.
2130  * \param options Various options that might affect performance of this or
2131  * subsequent operations.
2132  * \return The number of characters copied to the buffer excluding the null
2133  * terminator. For WriteUtf8: The number of bytes copied to the buffer
2134  * including the null terminator (if written).
2135  */
2141  // Used by WriteUtf8 to replace orphan surrogate code units with the
2142  // unicode replacement character. Needs to be set to guarantee valid UTF-8
2143  // output.
2145  };
2146 
2147  // 16-bit character codes.
2148  int Write(uint16_t* buffer,
2149  int start = 0,
2150  int length = -1,
2151  int options = NO_OPTIONS) const;
2152  // One byte characters.
2153  int WriteOneByte(uint8_t* buffer,
2154  int start = 0,
2155  int length = -1,
2156  int options = NO_OPTIONS) const;
2157  // UTF-8 encoded characters.
2158  int WriteUtf8(char* buffer,
2159  int length = -1,
2160  int* nchars_ref = NULL,
2161  int options = NO_OPTIONS) const;
2162 
2163  /**
2164  * A zero length string.
2165  */
2166  V8_INLINE static v8::Local<v8::String> Empty(Isolate* isolate);
2167 
2168  /**
2169  * Returns true if the string is external
2170  */
2171  bool IsExternal() const;
2172 
2173  /**
2174  * Returns true if the string is both external and one-byte.
2175  */
2176  bool IsExternalOneByte() const;
2177 
2179  public:
2181 
2182  protected:
2184 
2185  /**
2186  * Internally V8 will call this Dispose method when the external string
2187  * resource is no longer needed. The default implementation will use the
2188  * delete operator. This method can be overridden in subclasses to
2189  * control how allocated external string resources are disposed.
2190  */
2191  virtual void Dispose() { delete this; }
2192 
2193  private:
2194  // Disallow copying and assigning.
2195  ExternalStringResourceBase(const ExternalStringResourceBase&);
2196  void operator=(const ExternalStringResourceBase&);
2197 
2198  friend class v8::internal::Heap;
2199  };
2200 
2201  /**
2202  * An ExternalStringResource is a wrapper around a two-byte string
2203  * buffer that resides outside V8's heap. Implement an
2204  * ExternalStringResource to manage the life cycle of the underlying
2205  * buffer. Note that the string data must be immutable.
2206  */
2208  : public ExternalStringResourceBase {
2209  public:
2210  /**
2211  * Override the destructor to manage the life cycle of the underlying
2212  * buffer.
2213  */
2215 
2216  /**
2217  * The string data from the underlying buffer.
2218  */
2219  virtual const uint16_t* data() const = 0;
2220 
2221  /**
2222  * The length of the string. That is, the number of two-byte characters.
2223  */
2224  virtual size_t length() const = 0;
2225 
2226  protected:
2228  };
2229 
2230  /**
2231  * An ExternalOneByteStringResource is a wrapper around an one-byte
2232  * string buffer that resides outside V8's heap. Implement an
2233  * ExternalOneByteStringResource to manage the life cycle of the
2234  * underlying buffer. Note that the string data must be immutable
2235  * and that the data must be Latin-1 and not UTF-8, which would require
2236  * special treatment internally in the engine and do not allow efficient
2237  * indexing. Use String::New or convert to 16 bit data for non-Latin1.
2238  */
2239 
2241  : public ExternalStringResourceBase {
2242  public:
2243  /**
2244  * Override the destructor to manage the life cycle of the underlying
2245  * buffer.
2246  */
2248  /** The string data from the underlying buffer.*/
2249  virtual const char* data() const = 0;
2250  /** The number of Latin-1 characters in the string.*/
2251  virtual size_t length() const = 0;
2252  protected:
2254  };
2255 
2256  /**
2257  * If the string is an external string, return the ExternalStringResourceBase
2258  * regardless of the encoding, otherwise return NULL. The encoding of the
2259  * string is returned in encoding_out.
2260  */
2262  Encoding* encoding_out) const;
2263 
2264  /**
2265  * Get the ExternalStringResource for an external string. Returns
2266  * NULL if IsExternal() doesn't return true.
2267  */
2269 
2270  /**
2271  * Get the ExternalOneByteStringResource for an external one-byte string.
2272  * Returns NULL if IsExternalOneByte() doesn't return true.
2273  */
2275 
2276  V8_INLINE static String* Cast(v8::Value* obj);
2277 
2278  // TODO(dcarney): remove with deprecation of New functions.
2280  kNormalString = static_cast<int>(v8::NewStringType::kNormal),
2282  };
2283 
2284  /** Allocates a new string from UTF-8 data.*/
2285  static V8_DEPRECATE_SOON(
2286  "Use maybe version",
2287  Local<String> NewFromUtf8(Isolate* isolate, const char* data,
2289  int length = -1));
2290 
2291  /** Allocates a new string from UTF-8 data. Only returns an empty value when
2292  * length > kMaxLength. **/
2293  static V8_WARN_UNUSED_RESULT MaybeLocal<String> NewFromUtf8(
2294  Isolate* isolate, const char* data, v8::NewStringType type,
2295  int length = -1);
2296 
2297  /** Allocates a new string from Latin-1 data.*/
2298  static V8_DEPRECATE_SOON(
2299  "Use maybe version",
2300  Local<String> NewFromOneByte(Isolate* isolate, const uint8_t* data,
2302  int length = -1));
2303 
2304  /** Allocates a new string from Latin-1 data. Only returns an empty value
2305  * when length > kMaxLength. **/
2306  static V8_WARN_UNUSED_RESULT MaybeLocal<String> NewFromOneByte(
2307  Isolate* isolate, const uint8_t* data, v8::NewStringType type,
2308  int length = -1);
2309 
2310  /** Allocates a new string from UTF-16 data.*/
2311  static V8_DEPRECATE_SOON(
2312  "Use maybe version",
2313  Local<String> NewFromTwoByte(Isolate* isolate, const uint16_t* data,
2315  int length = -1));
2316 
2317  /** Allocates a new string from UTF-16 data. Only returns an empty value when
2318  * length > kMaxLength. **/
2319  static V8_WARN_UNUSED_RESULT MaybeLocal<String> NewFromTwoByte(
2320  Isolate* isolate, const uint16_t* data, v8::NewStringType type,
2321  int length = -1);
2322 
2323  /**
2324  * Creates a new string by concatenating the left and the right strings
2325  * passed in as parameters.
2326  */
2327  static Local<String> Concat(Local<String> left, Local<String> right);
2328 
2329  /**
2330  * Creates a new external string using the data defined in the given
2331  * resource. When the external string is no longer live on V8's heap the
2332  * resource will be disposed by calling its Dispose method. The caller of
2333  * this function should not otherwise delete or modify the resource. Neither
2334  * should the underlying buffer be deallocated or modified except through the
2335  * destructor of the external string resource.
2336  */
2337  static V8_DEPRECATE_SOON(
2338  "Use maybe version",
2339  Local<String> NewExternal(Isolate* isolate,
2340  ExternalStringResource* resource));
2341  static V8_WARN_UNUSED_RESULT MaybeLocal<String> NewExternalTwoByte(
2342  Isolate* isolate, ExternalStringResource* resource);
2343 
2344  /**
2345  * Associate an external string resource with this string by transforming it
2346  * in place so that existing references to this string in the JavaScript heap
2347  * will use the external string resource. The external string resource's
2348  * character contents need to be equivalent to this string.
2349  * Returns true if the string has been changed to be an external string.
2350  * The string is not modified if the operation fails. See NewExternal for
2351  * information on the lifetime of the resource.
2352  */
2353  bool MakeExternal(ExternalStringResource* resource);
2354 
2355  /**
2356  * Creates a new external string using the one-byte data defined in the given
2357  * resource. When the external string is no longer live on V8's heap the
2358  * resource will be disposed by calling its Dispose method. The caller of
2359  * this function should not otherwise delete or modify the resource. Neither
2360  * should the underlying buffer be deallocated or modified except through the
2361  * destructor of the external string resource.
2362  */
2363  static V8_DEPRECATE_SOON(
2364  "Use maybe version",
2365  Local<String> NewExternal(Isolate* isolate,
2366  ExternalOneByteStringResource* resource));
2367  static V8_WARN_UNUSED_RESULT MaybeLocal<String> NewExternalOneByte(
2368  Isolate* isolate, ExternalOneByteStringResource* resource);
2369 
2370  /**
2371  * Associate an external string resource with this string by transforming it
2372  * in place so that existing references to this string in the JavaScript heap
2373  * will use the external string resource. The external string resource's
2374  * character contents need to be equivalent to this string.
2375  * Returns true if the string has been changed to be an external string.
2376  * The string is not modified if the operation fails. See NewExternal for
2377  * information on the lifetime of the resource.
2378  */
2380 
2381  /**
2382  * Returns true if this string can be made external.
2383  */
2384  bool CanMakeExternal();
2385 
2386  /**
2387  * Converts an object to a UTF-8-encoded character array. Useful if
2388  * you want to print the object. If conversion to a string fails
2389  * (e.g. due to an exception in the toString() method of the object)
2390  * then the length() method returns 0 and the * operator returns
2391  * NULL.
2392  */
2394  public:
2395  explicit Utf8Value(Local<v8::Value> obj);
2396  ~Utf8Value();
2397  char* operator*() { return str_; }
2398  const char* operator*() const { return str_; }
2399  int length() const { return length_; }
2400  private:
2401  char* str_;
2402  int length_;
2403 
2404  // Disallow copying and assigning.
2405  Utf8Value(const Utf8Value&);
2406  void operator=(const Utf8Value&);
2407  };
2408 
2409  /**
2410  * Converts an object to a two-byte string.
2411  * If conversion to a string fails (eg. due to an exception in the toString()
2412  * method of the object) then the length() method returns 0 and the * operator
2413  * returns NULL.
2414  */
2416  public:
2417  explicit Value(Local<v8::Value> obj);
2418  ~Value();
2419  uint16_t* operator*() { return str_; }
2420  const uint16_t* operator*() const { return str_; }
2421  int length() const { return length_; }
2422  private:
2423  uint16_t* str_;
2424  int length_;
2425 
2426  // Disallow copying and assigning.
2427  Value(const Value&);
2428  void operator=(const Value&);
2429  };
2430 
2431  private:
2432  void VerifyExternalStringResourceBase(ExternalStringResourceBase* v,
2433  Encoding encoding) const;
2434  void VerifyExternalStringResource(ExternalStringResource* val) const;
2435  static void CheckCast(v8::Value* obj);
2436 };
2437 
2438 
2439 /**
2440  * A JavaScript symbol (ECMA-262 edition 6)
2441  *
2442  * This is an experimental feature. Use at your own risk.
2443  */
2444 class V8_EXPORT Symbol : public Name {
2445  public:
2446  // Returns the print name string of the symbol, or undefined if none.
2447  Local<Value> Name() const;
2448 
2449  // Create a symbol. If name is not empty, it will be used as the description.
2450  static Local<Symbol> New(
2451  Isolate *isolate, Local<String> name = Local<String>());
2452 
2453  // Access global symbol registry.
2454  // Note that symbols created this way are never collected, so
2455  // they should only be used for statically fixed properties.
2456  // Also, there is only one global name space for the names used as keys.
2457  // To minimize the potential for clashes, use qualified names as keys.
2458  static Local<Symbol> For(Isolate *isolate, Local<String> name);
2459 
2460  // Retrieve a global symbol. Similar to |For|, but using a separate
2461  // registry that is not accessible by (and cannot clash with) JavaScript code.
2462  static Local<Symbol> ForApi(Isolate *isolate, Local<String> name);
2463 
2464  // Well-known symbols
2465  static Local<Symbol> GetIterator(Isolate* isolate);
2466  static Local<Symbol> GetUnscopables(Isolate* isolate);
2467  static Local<Symbol> GetToStringTag(Isolate* isolate);
2468 
2469  V8_INLINE static Symbol* Cast(v8::Value* obj);
2470 
2471  private:
2472  Symbol();
2473  static void CheckCast(v8::Value* obj);
2474 };
2475 
2476 
2477 /**
2478  * A JavaScript number value (ECMA-262, 4.3.20)
2479  */
2480 class V8_EXPORT Number : public Primitive {
2481  public:
2482  double Value() const;
2483  static Local<Number> New(Isolate* isolate, double value);
2484  V8_INLINE static Number* Cast(v8::Value* obj);
2485  private:
2486  Number();
2487  static void CheckCast(v8::Value* obj);
2488 };
2489 
2490 
2491 /**
2492  * A JavaScript value representing a signed integer.
2493  */
2494 class V8_EXPORT Integer : public Number {
2495  public:
2496  static Local<Integer> New(Isolate* isolate, int32_t value);
2497  static Local<Integer> NewFromUnsigned(Isolate* isolate, uint32_t value);
2498  int64_t Value() const;
2499  V8_INLINE static Integer* Cast(v8::Value* obj);
2500  private:
2501  Integer();
2502  static void CheckCast(v8::Value* obj);
2503 };
2504 
2505 
2506 /**
2507  * A JavaScript value representing a 32-bit signed integer.
2508  */
2509 class V8_EXPORT Int32 : public Integer {
2510  public:
2511  int32_t Value() const;
2512  V8_INLINE static Int32* Cast(v8::Value* obj);
2513 
2514  private:
2515  Int32();
2516  static void CheckCast(v8::Value* obj);
2517 };
2518 
2519 
2520 /**
2521  * A JavaScript value representing a 32-bit unsigned integer.
2522  */
2523 class V8_EXPORT Uint32 : public Integer {
2524  public:
2525  uint32_t Value() const;
2526  V8_INLINE static Uint32* Cast(v8::Value* obj);
2527 
2528  private:
2529  Uint32();
2530  static void CheckCast(v8::Value* obj);
2531 };
2532 
2533 
2535  None = 0,
2536  ReadOnly = 1 << 0,
2537  DontEnum = 1 << 1,
2538  DontDelete = 1 << 2
2539 };
2540 
2541 /**
2542  * Accessor[Getter|Setter] are used as callback functions when
2543  * setting|getting a particular property. See Object and ObjectTemplate's
2544  * method SetAccessor.
2545  */
2546 typedef void (*AccessorGetterCallback)(
2547  Local<String> property,
2548  const PropertyCallbackInfo<Value>& info);
2550  Local<Name> property,
2551  const PropertyCallbackInfo<Value>& info);
2552 
2553 
2554 typedef void (*AccessorSetterCallback)(
2555  Local<String> property,
2556  Local<Value> value,
2557  const PropertyCallbackInfo<void>& info);
2559  Local<Name> property,
2560  Local<Value> value,
2561  const PropertyCallbackInfo<void>& info);
2562 
2563 
2564 /**
2565  * Access control specifications.
2566  *
2567  * Some accessors should be accessible across contexts. These
2568  * accessors have an explicit access control parameter which specifies
2569  * the kind of cross-context access that should be allowed.
2570  *
2571  * TODO(dcarney): Remove PROHIBITS_OVERWRITING as it is now unused.
2572  */
2574  DEFAULT = 0,
2576  ALL_CAN_WRITE = 1 << 1,
2578 };
2579 
2580 
2581 /**
2582  * A JavaScript object (ECMA-262, 4.3.3)
2583  */
2584 class V8_EXPORT Object : public Value {
2585  public:
2586  V8_DEPRECATE_SOON("Use maybe version",
2587  bool Set(Local<Value> key, Local<Value> value));
2588  V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context,
2589  Local<Value> key, Local<Value> value);
2590 
2591  V8_DEPRECATE_SOON("Use maybe version",
2592  bool Set(uint32_t index, Local<Value> value));
2593  V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context, uint32_t index,
2594  Local<Value> value);
2595 
2596  // Implements CreateDataProperty (ECMA-262, 7.3.4).
2597  //
2598  // Defines a configurable, writable, enumerable property with the given value
2599  // on the object unless the property already exists and is not configurable
2600  // or the object is not extensible.
2601  //
2602  // Returns true on success.
2603  V8_WARN_UNUSED_RESULT Maybe<bool> CreateDataProperty(Local<Context> context,
2604  Local<Name> key,
2605  Local<Value> value);
2606  V8_WARN_UNUSED_RESULT Maybe<bool> CreateDataProperty(Local<Context> context,
2607  uint32_t index,
2608  Local<Value> value);
2609 
2610  // Implements DefineOwnProperty.
2611  //
2612  // In general, CreateDataProperty will be faster, however, does not allow
2613  // for specifying attributes.
2614  //
2615  // Returns true on success.
2617  Local<Context> context, Local<Name> key, Local<Value> value,
2618  PropertyAttribute attributes = None);
2619 
2620  // Sets an own property on this object bypassing interceptors and
2621  // overriding accessors or read-only properties.
2622  //
2623  // Note that if the object has an interceptor the property will be set
2624  // locally, but since the interceptor takes precedence the local property
2625  // will only be returned if the interceptor doesn't return a value.
2626  //
2627  // Note also that this only works for named properties.
2628  V8_DEPRECATE_SOON("Use CreateDataProperty",
2629  bool ForceSet(Local<Value> key, Local<Value> value,
2630  PropertyAttribute attribs = None));
2631  V8_DEPRECATE_SOON("Use CreateDataProperty",
2632  Maybe<bool> ForceSet(Local<Context> context,
2633  Local<Value> key, Local<Value> value,
2634  PropertyAttribute attribs = None));
2635 
2636  V8_DEPRECATE_SOON("Use maybe version", Local<Value> Get(Local<Value> key));
2637  V8_WARN_UNUSED_RESULT MaybeLocal<Value> Get(Local<Context> context,
2638  Local<Value> key);
2639 
2640  V8_DEPRECATE_SOON("Use maybe version", Local<Value> Get(uint32_t index));
2641  V8_WARN_UNUSED_RESULT MaybeLocal<Value> Get(Local<Context> context,
2642  uint32_t index);
2643 
2644  /**
2645  * Gets the property attributes of a property which can be None or
2646  * any combination of ReadOnly, DontEnum and DontDelete. Returns
2647  * None when the property doesn't exist.
2648  */
2649  V8_DEPRECATE_SOON("Use maybe version",
2650  PropertyAttribute GetPropertyAttributes(Local<Value> key));
2652  Local<Context> context, Local<Value> key);
2653 
2654  /**
2655  * Returns Object.getOwnPropertyDescriptor as per ES5 section 15.2.3.3.
2656  */
2657  V8_DEPRECATE_SOON("Use maybe version",
2658  Local<Value> GetOwnPropertyDescriptor(Local<String> key));
2660  Local<Context> context, Local<String> key);
2661 
2662  V8_DEPRECATE_SOON("Use maybe version", bool Has(Local<Value> key));
2663  V8_WARN_UNUSED_RESULT Maybe<bool> Has(Local<Context> context,
2664  Local<Value> key);
2665 
2666  V8_DEPRECATE_SOON("Use maybe version", bool Delete(Local<Value> key));
2667  // TODO(dcarney): mark V8_WARN_UNUSED_RESULT
2668  Maybe<bool> Delete(Local<Context> context, Local<Value> key);
2669 
2670  V8_DEPRECATE_SOON("Use maybe version", bool Has(uint32_t index));
2671  V8_WARN_UNUSED_RESULT Maybe<bool> Has(Local<Context> context, uint32_t index);
2672 
2673  V8_DEPRECATE_SOON("Use maybe version", bool Delete(uint32_t index));
2674  // TODO(dcarney): mark V8_WARN_UNUSED_RESULT
2675  Maybe<bool> Delete(Local<Context> context, uint32_t index);
2676 
2677  V8_DEPRECATE_SOON("Use maybe version",
2678  bool SetAccessor(Local<String> name,
2679  AccessorGetterCallback getter,
2680  AccessorSetterCallback setter = 0,
2681  Local<Value> data = Local<Value>(),
2682  AccessControl settings = DEFAULT,
2683  PropertyAttribute attribute = None));
2684  V8_DEPRECATE_SOON("Use maybe version",
2685  bool SetAccessor(Local<Name> name,
2687  AccessorNameSetterCallback setter = 0,
2688  Local<Value> data = Local<Value>(),
2689  AccessControl settings = DEFAULT,
2690  PropertyAttribute attribute = None));
2691  // TODO(dcarney): mark V8_WARN_UNUSED_RESULT
2692  Maybe<bool> SetAccessor(Local<Context> context, Local<Name> name,
2694  AccessorNameSetterCallback setter = 0,
2695  MaybeLocal<Value> data = MaybeLocal<Value>(),
2696  AccessControl settings = DEFAULT,
2697  PropertyAttribute attribute = None);
2698 
2699  void SetAccessorProperty(Local<Name> name, Local<Function> getter,
2700  Local<Function> setter = Local<Function>(),
2701  PropertyAttribute attribute = None,
2702  AccessControl settings = DEFAULT);
2703 
2704  /**
2705  * Returns an array containing the names of the enumerable properties
2706  * of this object, including properties from prototype objects. The
2707  * array returned by this method contains the same values as would
2708  * be enumerated by a for-in statement over this object.
2709  */
2710  V8_DEPRECATE_SOON("Use maybe version", Local<Array> GetPropertyNames());
2712  Local<Context> context);
2713 
2714  /**
2715  * This function has the same functionality as GetPropertyNames but
2716  * the returned array doesn't contain the names of properties from
2717  * prototype objects.
2718  */
2719  V8_DEPRECATE_SOON("Use maybe version", Local<Array> GetOwnPropertyNames());
2721  Local<Context> context);
2722 
2723  /**
2724  * Get the prototype object. This does not skip objects marked to
2725  * be skipped by __proto__ and it does not consult the security
2726  * handler.
2727  */
2728  Local<Value> GetPrototype();
2729 
2730  /**
2731  * Set the prototype object. This does not skip objects marked to
2732  * be skipped by __proto__ and it does not consult the security
2733  * handler.
2734  */
2735  V8_DEPRECATE_SOON("Use maybe version",
2736  bool SetPrototype(Local<Value> prototype));
2737  V8_WARN_UNUSED_RESULT Maybe<bool> SetPrototype(Local<Context> context,
2738  Local<Value> prototype);
2739 
2740  /**
2741  * Finds an instance of the given function template in the prototype
2742  * chain.
2743  */
2745 
2746  /**
2747  * Call builtin Object.prototype.toString on this object.
2748  * This is different from Value::ToString() that may call
2749  * user-defined toString function. This one does not.
2750  */
2751  V8_DEPRECATE_SOON("Use maybe version", Local<String> ObjectProtoToString());
2753  Local<Context> context);
2754 
2755  /**
2756  * Returns the name of the function invoked as a constructor for this object.
2757  */
2758  Local<String> GetConstructorName();
2759 
2760  /** Gets the number of internal fields for this Object. */
2761  int InternalFieldCount();
2762 
2763  /** Same as above, but works for Persistents */
2765  const PersistentBase<Object>& object) {
2766  return object.val_->InternalFieldCount();
2767  }
2768 
2769  /** Gets the value from an internal field. */
2770  V8_INLINE Local<Value> GetInternalField(int index);
2771 
2772  /** Sets the value in an internal field. */
2773  void SetInternalField(int index, Local<Value> value);
2774 
2775  /**
2776  * Gets a 2-byte-aligned native pointer from an internal field. This field
2777  * must have been set by SetAlignedPointerInInternalField, everything else
2778  * leads to undefined behavior.
2779  */
2781 
2782  /** Same as above, but works for Persistents */
2784  const PersistentBase<Object>& object, int index) {
2785  return object.val_->GetAlignedPointerFromInternalField(index);
2786  }
2787 
2788  /**
2789  * Sets a 2-byte-aligned native pointer in an internal field. To retrieve such
2790  * a field, GetAlignedPointerFromInternalField must be used, everything else
2791  * leads to undefined behavior.
2792  */
2793  void SetAlignedPointerInInternalField(int index, void* value);
2794 
2795  // Testers for local properties.
2796  V8_DEPRECATE_SOON("Use maybe version",
2797  bool HasOwnProperty(Local<String> key));
2798  V8_WARN_UNUSED_RESULT Maybe<bool> HasOwnProperty(Local<Context> context,
2799  Local<Name> key);
2800  V8_DEPRECATE_SOON("Use maybe version",
2801  bool HasRealNamedProperty(Local<String> key));
2802  V8_WARN_UNUSED_RESULT Maybe<bool> HasRealNamedProperty(Local<Context> context,
2803  Local<Name> key);
2804  V8_DEPRECATE_SOON("Use maybe version",
2805  bool HasRealIndexedProperty(uint32_t index));
2807  Local<Context> context, uint32_t index);
2808  V8_DEPRECATE_SOON("Use maybe version",
2809  bool HasRealNamedCallbackProperty(Local<String> key));
2811  Local<Context> context, Local<Name> key);
2812 
2813  /**
2814  * If result.IsEmpty() no real property was located in the prototype chain.
2815  * This means interceptors in the prototype chain are not called.
2816  */
2818  "Use maybe version",
2819  Local<Value> GetRealNamedPropertyInPrototypeChain(Local<String> key));
2821  Local<Context> context, Local<Name> key);
2822 
2823  /**
2824  * Gets the property attributes of a real property in the prototype chain,
2825  * which can be None or any combination of ReadOnly, DontEnum and DontDelete.
2826  * Interceptors in the prototype chain are not called.
2827  */
2829  "Use maybe version",
2830  Maybe<PropertyAttribute> GetRealNamedPropertyAttributesInPrototypeChain(
2831  Local<String> key));
2834  Local<Name> key);
2835 
2836  /**
2837  * If result.IsEmpty() no real property was located on the object or
2838  * in the prototype chain.
2839  * This means interceptors in the prototype chain are not called.
2840  */
2841  V8_DEPRECATE_SOON("Use maybe version",
2842  Local<Value> GetRealNamedProperty(Local<String> key));
2844  Local<Context> context, Local<Name> key);
2845 
2846  /**
2847  * Gets the property attributes of a real property which can be
2848  * None or any combination of ReadOnly, DontEnum and DontDelete.
2849  * Interceptors in the prototype chain are not called.
2850  */
2851  V8_DEPRECATE_SOON("Use maybe version",
2852  Maybe<PropertyAttribute> GetRealNamedPropertyAttributes(
2853  Local<String> key));
2855  Local<Context> context, Local<Name> key);
2856 
2857  /** Tests for a named lookup interceptor.*/
2859 
2860  /** Tests for an index lookup interceptor.*/
2862 
2863  /**
2864  * Returns the identity hash for this object. The current implementation
2865  * uses a hidden property on the object to store the identity hash.
2866  *
2867  * The return value will never be 0. Also, it is not guaranteed to be
2868  * unique.
2869  */
2870  int GetIdentityHash();
2871 
2872  /**
2873  * Access hidden properties on JavaScript objects. These properties are
2874  * hidden from the executing JavaScript and only accessible through the V8
2875  * C++ API. Hidden properties introduced by V8 internally (for example the
2876  * identity hash) are prefixed with "v8::".
2877  */
2878  // TODO(dcarney): convert these to take a isolate and optionally bailout?
2879  bool SetHiddenValue(Local<String> key, Local<Value> value);
2880  Local<Value> GetHiddenValue(Local<String> key);
2881  bool DeleteHiddenValue(Local<String> key);
2882 
2883  /**
2884  * Clone this object with a fast but shallow copy. Values will point
2885  * to the same values as the original object.
2886  */
2887  // TODO(dcarney): take an isolate and optionally bail out?
2888  Local<Object> Clone();
2889 
2890  /**
2891  * Returns the context in which the object was created.
2892  */
2893  Local<Context> CreationContext();
2894 
2895  /**
2896  * Checks whether a callback is set by the
2897  * ObjectTemplate::SetCallAsFunctionHandler method.
2898  * When an Object is callable this method returns true.
2899  */
2900  bool IsCallable();
2901 
2902  /**
2903  * Call an Object as a function if a callback is set by the
2904  * ObjectTemplate::SetCallAsFunctionHandler method.
2905  */
2906  V8_DEPRECATE_SOON("Use maybe version",
2907  Local<Value> CallAsFunction(Local<Value> recv, int argc,
2908  Local<Value> argv[]));
2909  V8_WARN_UNUSED_RESULT MaybeLocal<Value> CallAsFunction(Local<Context> context,
2910  Local<Value> recv,
2911  int argc,
2912  Local<Value> argv[]);
2913 
2914  /**
2915  * Call an Object as a constructor if a callback is set by the
2916  * ObjectTemplate::SetCallAsFunctionHandler method.
2917  * Note: This method behaves like the Function::NewInstance method.
2918  */
2919  V8_DEPRECATE_SOON("Use maybe version",
2920  Local<Value> CallAsConstructor(int argc,
2921  Local<Value> argv[]));
2923  Local<Context> context, int argc, Local<Value> argv[]);
2924 
2925  /**
2926  * Return the isolate to which the Object belongs to.
2927  */
2928  V8_DEPRECATE_SOON("Keep track of isolate correctly", Isolate* GetIsolate());
2929 
2930  static Local<Object> New(Isolate* isolate);
2931 
2932  V8_INLINE static Object* Cast(Value* obj);
2933 
2934  private:
2935  Object();
2936  static void CheckCast(Value* obj);
2937  Local<Value> SlowGetInternalField(int index);
2938  void* SlowGetAlignedPointerFromInternalField(int index);
2939 };
2940 
2941 
2942 /**
2943  * An instance of the built-in array constructor (ECMA-262, 15.4.2).
2944  */
2945 class V8_EXPORT Array : public Object {
2946  public:
2947  uint32_t Length() const;
2948 
2949  /**
2950  * Clones an element at index |index|. Returns an empty
2951  * handle if cloning fails (for any reason).
2952  */
2953  V8_DEPRECATE_SOON("Use maybe version",
2954  Local<Object> CloneElementAt(uint32_t index));
2956  Local<Context> context, uint32_t index);
2957 
2958  /**
2959  * Creates a JavaScript array with the given length. If the length
2960  * is negative the returned array will have length 0.
2961  */
2962  static Local<Array> New(Isolate* isolate, int length = 0);
2963 
2964  V8_INLINE static Array* Cast(Value* obj);
2965  private:
2966  Array();
2967  static void CheckCast(Value* obj);
2968 };
2969 
2970 
2971 /**
2972  * An instance of the built-in Map constructor (ECMA-262, 6th Edition, 23.1.1).
2973  */
2974 class V8_EXPORT Map : public Object {
2975  public:
2976  size_t Size() const;
2977  void Clear();
2978  V8_WARN_UNUSED_RESULT MaybeLocal<Value> Get(Local<Context> context,
2979  Local<Value> key);
2980  V8_WARN_UNUSED_RESULT MaybeLocal<Map> Set(Local<Context> context,
2981  Local<Value> key,
2982  Local<Value> value);
2983  V8_WARN_UNUSED_RESULT Maybe<bool> Has(Local<Context> context,
2984  Local<Value> key);
2985  V8_WARN_UNUSED_RESULT Maybe<bool> Delete(Local<Context> context,
2986  Local<Value> key);
2987 
2988  /**
2989  * Returns an array of length Size() * 2, where index N is the Nth key and
2990  * index N + 1 is the Nth value.
2991  */
2992  Local<Array> AsArray() const;
2993 
2994  /**
2995  * Creates a new empty Map.
2996  */
2997  static Local<Map> New(Isolate* isolate);
2998 
2999  /**
3000  * Creates a new Map containing the elements of array, which must be formatted
3001  * in the same manner as the array returned from AsArray().
3002  * Guaranteed to be side-effect free if the array contains no holes.
3003  */
3005  "Use mutation methods instead",
3006  MaybeLocal<Map> FromArray(Local<Context> context, Local<Array> array));
3007 
3008  V8_INLINE static Map* Cast(Value* obj);
3009 
3010  private:
3011  Map();
3012  static void CheckCast(Value* obj);
3013 };
3014 
3015 
3016 /**
3017  * An instance of the built-in Set constructor (ECMA-262, 6th Edition, 23.2.1).
3018  */
3019 class V8_EXPORT Set : public Object {
3020  public:
3021  size_t Size() const;
3022  void Clear();
3023  V8_WARN_UNUSED_RESULT MaybeLocal<Set> Add(Local<Context> context,
3024  Local<Value> key);
3025  V8_WARN_UNUSED_RESULT Maybe<bool> Has(Local<Context> context,
3026  Local<Value> key);
3027  V8_WARN_UNUSED_RESULT Maybe<bool> Delete(Local<Context> context,
3028  Local<Value> key);
3029 
3030  /**
3031  * Returns an array of the keys in this Set.
3032  */
3033  Local<Array> AsArray() const;
3034 
3035  /**
3036  * Creates a new empty Set.
3037  */
3038  static Local<Set> New(Isolate* isolate);
3039 
3040  /**
3041  * Creates a new Set containing the items in array.
3042  * Guaranteed to be side-effect free if the array contains no holes.
3043  */
3045  "Use mutation methods instead",
3046  MaybeLocal<Set> FromArray(Local<Context> context, Local<Array> array));
3047 
3048  V8_INLINE static Set* Cast(Value* obj);
3049 
3050  private:
3051  Set();
3052  static void CheckCast(Value* obj);
3053 };
3054 
3055 
3056 template<typename T>
3057 class ReturnValue {
3058  public:
3059  template <class S> V8_INLINE ReturnValue(const ReturnValue<S>& that)
3060  : value_(that.value_) {
3061  TYPE_CHECK(T, S);
3062  }
3063  // Local setters
3064  template <typename S>
3065  V8_INLINE V8_DEPRECATE_SOON("Use Global<> instead",
3066  void Set(const Persistent<S>& handle));
3067  template <typename S>
3068  V8_INLINE void Set(const Global<S>& handle);
3069  template <typename S>
3070  V8_INLINE void Set(const Local<S> handle);
3071  // Fast primitive setters
3072  V8_INLINE void Set(bool value);
3073  V8_INLINE void Set(double i);
3074  V8_INLINE void Set(int32_t i);
3075  V8_INLINE void Set(uint32_t i);
3076  // Fast JS primitive setters
3077  V8_INLINE void SetNull();
3078  V8_INLINE void SetUndefined();
3079  V8_INLINE void SetEmptyString();
3080  // Convenience getter for Isolate
3082 
3083  // Pointer setter: Uncompilable to prevent inadvertent misuse.
3084  template <typename S>
3085  V8_INLINE void Set(S* whatever);
3086 
3087  private:
3088  template<class F> friend class ReturnValue;
3089  template<class F> friend class FunctionCallbackInfo;
3090  template<class F> friend class PropertyCallbackInfo;
3091  template <class F, class G, class H>
3093  V8_INLINE void SetInternal(internal::Object* value) { *value_ = value; }
3094  V8_INLINE internal::Object* GetDefaultValue();
3095  V8_INLINE explicit ReturnValue(internal::Object** slot);
3096  internal::Object** value_;
3097 };
3098 
3099 
3100 /**
3101  * The argument information given to function call callbacks. This
3102  * class provides access to information about the context of the call,
3103  * including the receiver, the number and values of arguments, and
3104  * the holder of the function.
3105  */
3106 template<typename T>
3107 class FunctionCallbackInfo {
3108  public:
3109  V8_INLINE int Length() const;
3110  V8_INLINE Local<Value> operator[](int i) const;
3111  V8_INLINE Local<Function> Callee() const;
3112  V8_INLINE Local<Object> This() const;
3113  V8_INLINE Local<Object> Holder() const;
3114  V8_INLINE bool IsConstructCall() const;
3115  V8_INLINE Local<Value> Data() const;
3116  V8_INLINE Isolate* GetIsolate() const;
3117  V8_INLINE ReturnValue<T> GetReturnValue() const;
3118  // This shouldn't be public, but the arm compiler needs it.
3119  static const int kArgsLength = 7;
3120 
3121  protected:
3124  static const int kHolderIndex = 0;
3125  static const int kIsolateIndex = 1;
3126  static const int kReturnValueDefaultValueIndex = 2;
3127  static const int kReturnValueIndex = 3;
3128  static const int kDataIndex = 4;
3129  static const int kCalleeIndex = 5;
3130  static const int kContextSaveIndex = 6;
3131 
3132  V8_INLINE FunctionCallbackInfo(internal::Object** implicit_args,
3133  internal::Object** values,
3134  int length,
3135  bool is_construct_call);
3137  internal::Object** values_;
3138  int length_;
3140 };
3141 
3142 
3143 /**
3144  * The information passed to a property callback about the context
3145  * of the property access.
3146  */
3147 template<typename T>
3148 class PropertyCallbackInfo {
3149  public:
3150  V8_INLINE Isolate* GetIsolate() const;
3151  V8_INLINE Local<Value> Data() const;
3152  V8_INLINE Local<Object> This() const;
3153  V8_INLINE Local<Object> Holder() const;
3154  V8_INLINE ReturnValue<T> GetReturnValue() const;
3155  // This shouldn't be public, but the arm compiler needs it.
3156  static const int kArgsLength = 6;
3157 
3158  protected:
3159  friend class MacroAssembler;
3162  static const int kHolderIndex = 0;
3163  static const int kIsolateIndex = 1;
3164  static const int kReturnValueDefaultValueIndex = 2;
3165  static const int kReturnValueIndex = 3;
3166  static const int kDataIndex = 4;
3167  static const int kThisIndex = 5;
3168 
3169  V8_INLINE PropertyCallbackInfo(internal::Object** args) : args_(args) {}
3170  internal::Object** args_;
3171 };
3172 
3173 
3174 typedef void (*FunctionCallback)(const FunctionCallbackInfo<Value>& info);
3175 
3176 
3177 /**
3178  * A JavaScript function object (ECMA-262, 15.3).
3179  */
3180 class V8_EXPORT Function : public Object {
3181  public:
3182  /**
3183  * Create a function in the current execution context
3184  * for a given FunctionCallback.
3185  */
3186  static MaybeLocal<Function> New(Local<Context> context,
3187  FunctionCallback callback,
3188  Local<Value> data = Local<Value>(),
3189  int length = 0);
3190  static V8_DEPRECATE_SOON(
3191  "Use maybe version",
3192  Local<Function> New(Isolate* isolate, FunctionCallback callback,
3193  Local<Value> data = Local<Value>(), int length = 0));
3194 
3195  V8_DEPRECATE_SOON("Use maybe version",
3196  Local<Object> NewInstance(int argc, Local<Value> argv[])
3197  const);
3199  Local<Context> context, int argc, Local<Value> argv[]) const;
3200 
3201  V8_DEPRECATE_SOON("Use maybe version", Local<Object> NewInstance() const);
3203  Local<Context> context) const {
3204  return NewInstance(context, 0, nullptr);
3205  }
3206 
3207  V8_DEPRECATE_SOON("Use maybe version",
3208  Local<Value> Call(Local<Value> recv, int argc,
3209  Local<Value> argv[]));
3210  V8_WARN_UNUSED_RESULT MaybeLocal<Value> Call(Local<Context> context,
3211  Local<Value> recv, int argc,
3212  Local<Value> argv[]);
3213 
3214  void SetName(Local<String> name);
3215  Local<Value> GetName() const;
3216 
3217  /**
3218  * Name inferred from variable or property assignment of this function.
3219  * Used to facilitate debugging and profiling of JavaScript code written
3220  * in an OO style, where many functions are anonymous but are assigned
3221  * to object properties.
3222  */
3223  Local<Value> GetInferredName() const;
3224 
3225  /**
3226  * User-defined name assigned to the "displayName" property of this function.
3227  * Used to facilitate debugging and profiling of JavaScript code.
3228  */
3229  Local<Value> GetDisplayName() const;
3230 
3231  /**
3232  * Returns zero based line number of function body and
3233  * kLineOffsetNotFound if no information available.
3234  */
3235  int GetScriptLineNumber() const;
3236  /**
3237  * Returns zero based column number of function body and
3238  * kLineOffsetNotFound if no information available.
3239  */
3240  int GetScriptColumnNumber() const;
3241 
3242  /**
3243  * Tells whether this function is builtin.
3244  */
3245  bool IsBuiltin() const;
3246 
3247  /**
3248  * Returns scriptId.
3249  */
3250  int ScriptId() const;
3251 
3252  /**
3253  * Returns the original function if this function is bound, else returns
3254  * v8::Undefined.
3255  */
3256  Local<Value> GetBoundFunction() const;
3257 
3258  ScriptOrigin GetScriptOrigin() const;
3259  V8_INLINE static Function* Cast(Value* obj);
3260  static const int kLineOffsetNotFound;
3261 
3262  private:
3263  Function();
3264  static void CheckCast(Value* obj);
3265 };
3266 
3267 
3268 /**
3269  * An instance of the built-in Promise constructor (ES6 draft).
3270  * This API is experimental. Only works with --harmony flag.
3271  */
3272 class V8_EXPORT Promise : public Object {
3273  public:
3274  class V8_EXPORT Resolver : public Object {
3275  public:
3276  /**
3277  * Create a new resolver, along with an associated promise in pending state.
3278  */
3279  static V8_DEPRECATE_SOON("Use maybe version",
3280  Local<Resolver> New(Isolate* isolate));
3281  static V8_WARN_UNUSED_RESULT MaybeLocal<Resolver> New(
3282  Local<Context> context);
3283 
3284  /**
3285  * Extract the associated promise.
3286  */
3287  Local<Promise> GetPromise();
3288 
3289  /**
3290  * Resolve/reject the associated promise with a given value.
3291  * Ignored if the promise is no longer pending.
3292  */
3293  V8_DEPRECATE_SOON("Use maybe version", void Resolve(Local<Value> value));
3294  // TODO(dcarney): mark V8_WARN_UNUSED_RESULT
3295  Maybe<bool> Resolve(Local<Context> context, Local<Value> value);
3296 
3297  V8_DEPRECATE_SOON("Use maybe version", void Reject(Local<Value> value));
3298  // TODO(dcarney): mark V8_WARN_UNUSED_RESULT
3299  Maybe<bool> Reject(Local<Context> context, Local<Value> value);
3300 
3301  V8_INLINE static Resolver* Cast(Value* obj);
3302 
3303  private:
3304  Resolver();
3305  static void CheckCast(Value* obj);
3306  };
3307 
3308  /**
3309  * Register a resolution/rejection handler with a promise.
3310  * The handler is given the respective resolution/rejection value as
3311  * an argument. If the promise is already resolved/rejected, the handler is
3312  * invoked at the end of turn.
3313  */
3314  V8_DEPRECATE_SOON("Use maybe version",
3315  Local<Promise> Chain(Local<Function> handler));
3316  V8_WARN_UNUSED_RESULT MaybeLocal<Promise> Chain(Local<Context> context,
3317  Local<Function> handler);
3318 
3319  V8_DEPRECATE_SOON("Use maybe version",
3320  Local<Promise> Catch(Local<Function> handler));
3321  V8_WARN_UNUSED_RESULT MaybeLocal<Promise> Catch(Local<Context> context,
3322  Local<Function> handler);
3323 
3324  V8_DEPRECATE_SOON("Use maybe version",
3325  Local<Promise> Then(Local<Function> handler));
3326  V8_WARN_UNUSED_RESULT MaybeLocal<Promise> Then(Local<Context> context,
3327  Local<Function> handler);
3328 
3329  /**
3330  * Returns true if the promise has at least one derived promise, and
3331  * therefore resolve/reject handlers (including default handler).
3332  */
3333  bool HasHandler();
3334 
3335  V8_INLINE static Promise* Cast(Value* obj);
3336 
3337  private:
3338  Promise();
3339  static void CheckCast(Value* obj);
3340 };
3341 
3342 
3343 #ifndef V8_ARRAY_BUFFER_INTERNAL_FIELD_COUNT
3344 // The number of required internal fields can be defined by embedder.
3345 #define V8_ARRAY_BUFFER_INTERNAL_FIELD_COUNT 2
3346 #endif
3347 
3348 
3350 
3351 
3352 /**
3353  * An instance of the built-in ArrayBuffer constructor (ES6 draft 15.13.5).
3354  * This API is experimental and may change significantly.
3355  */
3356 class V8_EXPORT ArrayBuffer : public Object {
3357  public:
3358  /**
3359  * Allocator that V8 uses to allocate |ArrayBuffer|'s memory.
3360  * The allocator is a global V8 setting. It has to be set via
3361  * Isolate::CreateParams.
3362  *
3363  * This API is experimental and may change significantly.
3364  */
3365  class V8_EXPORT Allocator { // NOLINT
3366  public:
3367  virtual ~Allocator() {}
3368 
3369  /**
3370  * Allocate |length| bytes. Return NULL if allocation is not successful.
3371  * Memory should be initialized to zeroes.
3372  */
3373  virtual void* Allocate(size_t length) = 0;
3374 
3375  /**
3376  * Allocate |length| bytes. Return NULL if allocation is not successful.
3377  * Memory does not have to be initialized.
3378  */
3379  virtual void* AllocateUninitialized(size_t length) = 0;
3380  /**
3381  * Free the memory block of size |length|, pointed to by |data|.
3382  * That memory is guaranteed to be previously allocated by |Allocate|.
3383  */
3384  virtual void Free(void* data, size_t length) = 0;
3385  };
3386 
3387  /**
3388  * The contents of an |ArrayBuffer|. Externalization of |ArrayBuffer|
3389  * returns an instance of this class, populated, with a pointer to data
3390  * and byte length.
3391  *
3392  * The Data pointer of ArrayBuffer::Contents is always allocated with
3393  * Allocator::Allocate that is set via Isolate::CreateParams.
3394  *
3395  * This API is experimental and may change significantly.
3396  */
3397  class V8_EXPORT Contents { // NOLINT
3398  public:
3399  Contents() : data_(NULL), byte_length_(0) {}
3400 
3401  void* Data() const { return data_; }
3402  size_t ByteLength() const { return byte_length_; }
3403 
3404  private:
3405  void* data_;
3406  size_t byte_length_;
3407 
3408  friend class ArrayBuffer;
3409  };
3410 
3411 
3412  /**
3413  * Data length in bytes.
3414  */
3415  size_t ByteLength() const;
3416 
3417  /**
3418  * Create a new ArrayBuffer. Allocate |byte_length| bytes.
3419  * Allocated memory will be owned by a created ArrayBuffer and
3420  * will be deallocated when it is garbage-collected,
3421  * unless the object is externalized.
3422  */
3423  static Local<ArrayBuffer> New(Isolate* isolate, size_t byte_length);
3424 
3425  /**
3426  * Create a new ArrayBuffer over an existing memory block.
3427  * The created array buffer is by default immediately in externalized state.
3428  * The memory block will not be reclaimed when a created ArrayBuffer
3429  * is garbage-collected.
3430  */
3431  static Local<ArrayBuffer> New(
3432  Isolate* isolate, void* data, size_t byte_length,
3434 
3435  /**
3436  * Returns true if ArrayBuffer is externalized, that is, does not
3437  * own its memory block.
3438  */
3439  bool IsExternal() const;
3440 
3441  /**
3442  * Returns true if this ArrayBuffer may be neutered.
3443  */
3444  bool IsNeuterable() const;
3445 
3446  /**
3447  * Neuters this ArrayBuffer and all its views (typed arrays).
3448  * Neutering sets the byte length of the buffer and all typed arrays to zero,
3449  * preventing JavaScript from ever accessing underlying backing store.
3450  * ArrayBuffer should have been externalized and must be neuterable.
3451  */
3452  void Neuter();
3453 
3454  /**
3455  * Make this ArrayBuffer external. The pointer to underlying memory block
3456  * and byte length are returned as |Contents| structure. After ArrayBuffer
3457  * had been etxrenalized, it does no longer owns the memory block. The caller
3458  * should take steps to free memory when it is no longer needed.
3459  *
3460  * The memory block is guaranteed to be allocated with |Allocator::Allocate|
3461  * that has been set via Isolate::CreateParams.
3462  */
3464 
3465  /**
3466  * Get a pointer to the ArrayBuffer's underlying memory block without
3467  * externalizing it. If the ArrayBuffer is not externalized, this pointer
3468  * will become invalid as soon as the ArrayBuffer became garbage collected.
3469  *
3470  * The embedder should make sure to hold a strong reference to the
3471  * ArrayBuffer while accessing this pointer.
3472  *
3473  * The memory block is guaranteed to be allocated with |Allocator::Allocate|.
3474  */
3476 
3477  V8_INLINE static ArrayBuffer* Cast(Value* obj);
3478 
3480 
3481  private:
3482  ArrayBuffer();
3483  static void CheckCast(Value* obj);
3484 };
3485 
3486 
3487 #ifndef V8_ARRAY_BUFFER_VIEW_INTERNAL_FIELD_COUNT
3488 // The number of required internal fields can be defined by embedder.
3489 #define V8_ARRAY_BUFFER_VIEW_INTERNAL_FIELD_COUNT 2
3490 #endif
3491 
3492 
3493 /**
3494  * A base class for an instance of one of "views" over ArrayBuffer,
3495  * including TypedArrays and DataView (ES6 draft 15.13).
3496  *
3497  * This API is experimental and may change significantly.
3498  */
3500  public:
3501  /**
3502  * Returns underlying ArrayBuffer.
3503  */
3504  Local<ArrayBuffer> Buffer();
3505  /**
3506  * Byte offset in |Buffer|.
3507  */
3508  size_t ByteOffset();
3509  /**
3510  * Size of a view in bytes.
3511  */
3512  size_t ByteLength();
3513 
3514  /**
3515  * Copy the contents of the ArrayBufferView's buffer to an embedder defined
3516  * memory without additional overhead that calling ArrayBufferView::Buffer
3517  * might incur.
3518  *
3519  * Will write at most min(|byte_length|, ByteLength) bytes starting at
3520  * ByteOffset of the underling buffer to the memory starting at |dest|.
3521  * Returns the number of bytes actually written.
3522  */
3524 
3525  /**
3526  * Returns true if ArrayBufferView's backing ArrayBuffer has already been
3527  * allocated.
3528  */
3529  bool HasBuffer() const;
3530 
3531  V8_INLINE static ArrayBufferView* Cast(Value* obj);
3532 
3533  static const int kInternalFieldCount =
3535 
3536  private:
3537  ArrayBufferView();
3538  static void CheckCast(Value* obj);
3539 };
3540 
3541 
3542 /**
3543  * A base class for an instance of TypedArray series of constructors
3544  * (ES6 draft 15.13.6).
3545  * This API is experimental and may change significantly.
3546  */
3548  public:
3549  /**
3550  * Number of elements in this typed array
3551  * (e.g. for Int16Array, |ByteLength|/2).
3552  */
3553  size_t Length();
3554 
3555  V8_INLINE static TypedArray* Cast(Value* obj);
3556 
3557  private:
3558  TypedArray();
3559  static void CheckCast(Value* obj);
3560 };
3561 
3562 
3563 /**
3564  * An instance of Uint8Array constructor (ES6 draft 15.13.6).
3565  * This API is experimental and may change significantly.
3566  */
3568  public:
3569  static Local<Uint8Array> New(Local<ArrayBuffer> array_buffer,
3570  size_t byte_offset, size_t length);
3571  static Local<Uint8Array> New(Local<SharedArrayBuffer> shared_array_buffer,
3572  size_t byte_offset, size_t length);
3573  V8_INLINE static Uint8Array* Cast(Value* obj);
3574 
3575  private:
3576  Uint8Array();
3577  static void CheckCast(Value* obj);
3578 };
3579 
3580 
3581 /**
3582  * An instance of Uint8ClampedArray constructor (ES6 draft 15.13.6).
3583  * This API is experimental and may change significantly.
3584  */
3586  public:
3587  static Local<Uint8ClampedArray> New(Local<ArrayBuffer> array_buffer,
3588  size_t byte_offset, size_t length);
3589  static Local<Uint8ClampedArray> New(
3590  Local<SharedArrayBuffer> shared_array_buffer, size_t byte_offset,
3591  size_t length);
3592  V8_INLINE static Uint8ClampedArray* Cast(Value* obj);
3593 
3594  private:
3595  Uint8ClampedArray();
3596  static void CheckCast(Value* obj);
3597 };
3598 
3599 /**
3600  * An instance of Int8Array constructor (ES6 draft 15.13.6).
3601  * This API is experimental and may change significantly.
3602  */
3604  public:
3605  static Local<Int8Array> New(Local<ArrayBuffer> array_buffer,
3606  size_t byte_offset, size_t length);
3607  static Local<Int8Array> New(Local<SharedArrayBuffer> shared_array_buffer,
3608  size_t byte_offset, size_t length);
3609  V8_INLINE static Int8Array* Cast(Value* obj);
3610 
3611  private:
3612  Int8Array();
3613  static void CheckCast(Value* obj);
3614 };
3615 
3616 
3617 /**
3618  * An instance of Uint16Array constructor (ES6 draft 15.13.6).
3619  * This API is experimental and may change significantly.
3620  */
3622  public:
3623  static Local<Uint16Array> New(Local<ArrayBuffer> array_buffer,
3624  size_t byte_offset, size_t length);
3625  static Local<Uint16Array> New(Local<SharedArrayBuffer> shared_array_buffer,
3626  size_t byte_offset, size_t length);
3627  V8_INLINE static Uint16Array* Cast(Value* obj);
3628 
3629  private:
3630  Uint16Array();
3631  static void CheckCast(Value* obj);
3632 };
3633 
3634 
3635 /**
3636  * An instance of Int16Array constructor (ES6 draft 15.13.6).
3637  * This API is experimental and may change significantly.
3638  */
3640  public:
3641  static Local<Int16Array> New(Local<ArrayBuffer> array_buffer,
3642  size_t byte_offset, size_t length);
3643  static Local<Int16Array> New(Local<SharedArrayBuffer> shared_array_buffer,
3644  size_t byte_offset, size_t length);
3645  V8_INLINE static Int16Array* Cast(Value* obj);
3646 
3647  private:
3648  Int16Array();
3649  static void CheckCast(Value* obj);
3650 };
3651 
3652 
3653 /**
3654  * An instance of Uint32Array constructor (ES6 draft 15.13.6).
3655  * This API is experimental and may change significantly.
3656  */
3658  public:
3659  static Local<Uint32Array> New(Local<ArrayBuffer> array_buffer,
3660  size_t byte_offset, size_t length);
3661  static Local<Uint32Array> New(Local<SharedArrayBuffer> shared_array_buffer,
3662  size_t byte_offset, size_t length);
3663  V8_INLINE static Uint32Array* Cast(Value* obj);
3664 
3665  private:
3666  Uint32Array();
3667  static void CheckCast(Value* obj);
3668 };
3669 
3670 
3671 /**
3672  * An instance of Int32Array constructor (ES6 draft 15.13.6).
3673  * This API is experimental and may change significantly.
3674  */
3676  public:
3677  static Local<Int32Array> New(Local<ArrayBuffer> array_buffer,
3678  size_t byte_offset, size_t length);
3679  static Local<Int32Array> New(Local<SharedArrayBuffer> shared_array_buffer,
3680  size_t byte_offset, size_t length);
3681  V8_INLINE static Int32Array* Cast(Value* obj);
3682 
3683  private:
3684  Int32Array();
3685  static void CheckCast(Value* obj);
3686 };
3687 
3688 
3689 /**
3690  * An instance of Float32Array constructor (ES6 draft 15.13.6).
3691  * This API is experimental and may change significantly.
3692  */
3694  public:
3695  static Local<Float32Array> New(Local<ArrayBuffer> array_buffer,
3696  size_t byte_offset, size_t length);
3697  static Local<Float32Array> New(Local<SharedArrayBuffer> shared_array_buffer,
3698  size_t byte_offset, size_t length);
3699  V8_INLINE static Float32Array* Cast(Value* obj);
3700 
3701  private:
3702  Float32Array();
3703  static void CheckCast(Value* obj);
3704 };
3705 
3706 
3707 /**
3708  * An instance of Float64Array constructor (ES6 draft 15.13.6).
3709  * This API is experimental and may change significantly.
3710  */
3712  public:
3713  static Local<Float64Array> New(Local<ArrayBuffer> array_buffer,
3714  size_t byte_offset, size_t length);
3715  static Local<Float64Array> New(Local<SharedArrayBuffer> shared_array_buffer,
3716  size_t byte_offset, size_t length);
3717  V8_INLINE static Float64Array* Cast(Value* obj);
3718 
3719  private:
3720  Float64Array();
3721  static void CheckCast(Value* obj);
3722 };
3723 
3724 
3725 /**
3726  * An instance of DataView constructor (ES6 draft 15.13.7).
3727  * This API is experimental and may change significantly.
3728  */
3730  public:
3731  static Local<DataView> New(Local<ArrayBuffer> array_buffer,
3732  size_t byte_offset, size_t length);
3733  static Local<DataView> New(Local<SharedArrayBuffer> shared_array_buffer,
3734  size_t byte_offset, size_t length);
3735  V8_INLINE static DataView* Cast(Value* obj);
3736 
3737  private:
3738  DataView();
3739  static void CheckCast(Value* obj);
3740 };
3741 
3742 
3743 /**
3744  * An instance of the built-in SharedArrayBuffer constructor.
3745  * This API is experimental and may change significantly.
3746  */
3748  public:
3749  /**
3750  * The contents of an |SharedArrayBuffer|. Externalization of
3751  * |SharedArrayBuffer| returns an instance of this class, populated, with a
3752  * pointer to data and byte length.
3753  *
3754  * The Data pointer of SharedArrayBuffer::Contents is always allocated with
3755  * |ArrayBuffer::Allocator::Allocate| by the allocator specified in
3756  * v8::Isolate::CreateParams::array_buffer_allocator.
3757  *
3758  * This API is experimental and may change significantly.
3759  */
3760  class V8_EXPORT Contents { // NOLINT
3761  public:
3762  Contents() : data_(NULL), byte_length_(0) {}
3763 
3764  void* Data() const { return data_; }
3765  size_t ByteLength() const { return byte_length_; }
3766 
3767  private:
3768  void* data_;
3769  size_t byte_length_;
3770 
3771  friend class SharedArrayBuffer;
3772  };
3773 
3774 
3775  /**
3776  * Data length in bytes.
3777  */
3778  size_t ByteLength() const;
3779 
3780  /**
3781  * Create a new SharedArrayBuffer. Allocate |byte_length| bytes.
3782  * Allocated memory will be owned by a created SharedArrayBuffer and
3783  * will be deallocated when it is garbage-collected,
3784  * unless the object is externalized.
3785  */
3786  static Local<SharedArrayBuffer> New(Isolate* isolate, size_t byte_length);
3787 
3788  /**
3789  * Create a new SharedArrayBuffer over an existing memory block. The created
3790  * array buffer is immediately in externalized state unless otherwise
3791  * specified. The memory block will not be reclaimed when a created
3792  * SharedArrayBuffer is garbage-collected.
3793  */
3794  static Local<SharedArrayBuffer> New(
3795  Isolate* isolate, void* data, size_t byte_length,
3797 
3798  /**
3799  * Returns true if SharedArrayBuffer is externalized, that is, does not
3800  * own its memory block.
3801  */
3802  bool IsExternal() const;
3803 
3804  /**
3805  * Make this SharedArrayBuffer external. The pointer to underlying memory
3806  * block and byte length are returned as |Contents| structure. After
3807  * SharedArrayBuffer had been etxrenalized, it does no longer owns the memory
3808  * block. The caller should take steps to free memory when it is no longer
3809  * needed.
3810  *
3811  * The memory block is guaranteed to be allocated with |Allocator::Allocate|
3812  * by the allocator specified in
3813  * v8::Isolate::CreateParams::array_buffer_allocator.
3814  *
3815  */
3817 
3818  /**
3819  * Get a pointer to the ArrayBuffer's underlying memory block without
3820  * externalizing it. If the ArrayBuffer is not externalized, this pointer
3821  * will become invalid as soon as the ArrayBuffer became garbage collected.
3822  *
3823  * The embedder should make sure to hold a strong reference to the
3824  * ArrayBuffer while accessing this pointer.
3825  *
3826  * The memory block is guaranteed to be allocated with |Allocator::Allocate|
3827  * by the allocator specified in
3828  * v8::Isolate::CreateParams::array_buffer_allocator.
3829  */
3831 
3832  V8_INLINE static SharedArrayBuffer* Cast(Value* obj);
3833 
3835 
3836  private:
3837  SharedArrayBuffer();
3838  static void CheckCast(Value* obj);
3839 };
3840 
3841 
3842 /**
3843  * An instance of the built-in Date constructor (ECMA-262, 15.9).
3844  */
3845 class V8_EXPORT Date : public Object {
3846  public:
3847  static V8_DEPRECATE_SOON("Use maybe version.",
3848  Local<Value> New(Isolate* isolate, double time));
3849  static V8_WARN_UNUSED_RESULT MaybeLocal<Value> New(Local<Context> context,
3850  double time);
3851 
3852  /**
3853  * A specialization of Value::NumberValue that is more efficient
3854  * because we know the structure of this object.
3855  */
3856  double ValueOf() const;
3857 
3858  V8_INLINE static Date* Cast(v8::Value* obj);
3859 
3860  /**
3861  * Notification that the embedder has changed the time zone,
3862  * daylight savings time, or other date / time configuration
3863  * parameters. V8 keeps a cache of various values used for
3864  * date / time computation. This notification will reset
3865  * those cached values for the current context so that date /
3866  * time configuration changes would be reflected in the Date
3867  * object.
3868  *
3869  * This API should not be called more than needed as it will
3870  * negatively impact the performance of date operations.
3871  */
3872  static void DateTimeConfigurationChangeNotification(Isolate* isolate);
3873 
3874  private:
3875  static void CheckCast(v8::Value* obj);
3876 };
3877 
3878 
3879 /**
3880  * A Number object (ECMA-262, 4.3.21).
3881  */
3883  public:
3884  static Local<Value> New(Isolate* isolate, double value);
3885 
3886  double ValueOf() const;
3887 
3888  V8_INLINE static NumberObject* Cast(v8::Value* obj);
3889 
3890  private:
3891  static void CheckCast(v8::Value* obj);
3892 };
3893 
3894 
3895 /**
3896  * A Boolean object (ECMA-262, 4.3.15).
3897  */
3899  public:
3900  static Local<Value> New(bool value);
3901 
3902  bool ValueOf() const;
3903 
3904  V8_INLINE static BooleanObject* Cast(v8::Value* obj);
3905 
3906  private:
3907  static void CheckCast(v8::Value* obj);
3908 };
3909 
3910 
3911 /**
3912  * A String object (ECMA-262, 4.3.18).
3913  */
3915  public:
3916  static Local<Value> New(Local<String> value);
3917 
3918  Local<String> ValueOf() const;
3919 
3920  V8_INLINE static StringObject* Cast(v8::Value* obj);
3921 
3922  private:
3923  static void CheckCast(v8::Value* obj);
3924 };
3925 
3926 
3927 /**
3928  * A Symbol object (ECMA-262 edition 6).
3929  *
3930  * This is an experimental feature. Use at your own risk.
3931  */
3933  public:
3934  static Local<Value> New(Isolate* isolate, Local<Symbol> value);
3935 
3936  Local<Symbol> ValueOf() const;
3937 
3938  V8_INLINE static SymbolObject* Cast(v8::Value* obj);
3939 
3940  private:
3941  static void CheckCast(v8::Value* obj);
3942 };
3943 
3944 
3945 /**
3946  * An instance of the built-in RegExp constructor (ECMA-262, 15.10).
3947  */
3948 class V8_EXPORT RegExp : public Object {
3949  public:
3950  /**
3951  * Regular expression flag bits. They can be or'ed to enable a set
3952  * of flags.
3953  */
3954  enum Flags {
3955  kNone = 0,
3956  kGlobal = 1,
3959  };
3960 
3961  /**
3962  * Creates a regular expression from the given pattern string and
3963  * the flags bit field. May throw a JavaScript exception as
3964  * described in ECMA-262, 15.10.4.1.
3965  *
3966  * For example,
3967  * RegExp::New(v8::String::New("foo"),
3968  * static_cast<RegExp::Flags>(kGlobal | kMultiline))
3969  * is equivalent to evaluating "/foo/gm".
3970  */
3971  static V8_DEPRECATE_SOON("Use maybe version",
3972  Local<RegExp> New(Local<String> pattern,
3973  Flags flags));
3974  static V8_WARN_UNUSED_RESULT MaybeLocal<RegExp> New(Local<Context> context,
3975  Local<String> pattern,
3976  Flags flags);
3977 
3978  /**
3979  * Returns the value of the source property: a string representing
3980  * the regular expression.
3981  */
3982  Local<String> GetSource() const;
3983 
3984  /**
3985  * Returns the flags bit field.
3986  */
3987  Flags GetFlags() const;
3988 
3989  V8_INLINE static RegExp* Cast(v8::Value* obj);
3990 
3991  private:
3992  static void CheckCast(v8::Value* obj);
3993 };
3994 
3995 
3996 /**
3997  * A JavaScript value that wraps a C++ void*. This type of value is mainly used
3998  * to associate C++ data structures with JavaScript objects.
3999  */
4000 class V8_EXPORT External : public Value {
4001  public:
4002  static Local<External> New(Isolate* isolate, void* value);
4003  V8_INLINE static External* Cast(Value* obj);
4004  void* Value() const;
4005  private:
4006  static void CheckCast(v8::Value* obj);
4007 };
4008 
4009 
4010 // --- Templates ---
4011 
4012 
4013 /**
4014  * The superclass of object and function templates.
4015  */
4016 class V8_EXPORT Template : public Data {
4017  public:
4018  /** Adds a property to each instance created by this template.*/
4019  void Set(Local<Name> name, Local<Data> value,
4020  PropertyAttribute attributes = None);
4021  V8_INLINE void Set(Isolate* isolate, const char* name, Local<Data> value);
4022 
4023  void SetAccessorProperty(
4024  Local<Name> name,
4025  Local<FunctionTemplate> getter = Local<FunctionTemplate>(),
4026  Local<FunctionTemplate> setter = Local<FunctionTemplate>(),
4027  PropertyAttribute attribute = None,
4028  AccessControl settings = DEFAULT);
4029 
4030  /**
4031  * Whenever the property with the given name is accessed on objects
4032  * created from this Template the getter and setter callbacks
4033  * are called instead of getting and setting the property directly
4034  * on the JavaScript object.
4035  *
4036  * \param name The name of the property for which an accessor is added.
4037  * \param getter The callback to invoke when getting the property.
4038  * \param setter The callback to invoke when setting the property.
4039  * \param data A piece of data that will be passed to the getter and setter
4040  * callbacks whenever they are invoked.
4041  * \param settings Access control settings for the accessor. This is a bit
4042  * field consisting of one of more of
4043  * DEFAULT = 0, ALL_CAN_READ = 1, or ALL_CAN_WRITE = 2.
4044  * The default is to not allow cross-context access.
4045  * ALL_CAN_READ means that all cross-context reads are allowed.
4046  * ALL_CAN_WRITE means that all cross-context writes are allowed.
4047  * The combination ALL_CAN_READ | ALL_CAN_WRITE can be used to allow all
4048  * cross-context access.
4049  * \param attribute The attributes of the property for which an accessor
4050  * is added.
4051  * \param signature The signature describes valid receivers for the accessor
4052  * and is used to perform implicit instance checks against them. If the
4053  * receiver is incompatible (i.e. is not an instance of the constructor as
4054  * defined by FunctionTemplate::HasInstance()), an implicit TypeError is
4055  * thrown and no callback is invoked.
4056  */
4057  void SetNativeDataProperty(
4058  Local<String> name, AccessorGetterCallback getter,
4059  AccessorSetterCallback setter = 0,
4060  // TODO(dcarney): gcc can't handle Local below
4061  Local<Value> data = Local<Value>(), PropertyAttribute attribute = None,
4062  Local<AccessorSignature> signature = Local<AccessorSignature>(),
4063  AccessControl settings = DEFAULT);
4064  void SetNativeDataProperty(
4065  Local<Name> name, AccessorNameGetterCallback getter,
4066  AccessorNameSetterCallback setter = 0,
4067  // TODO(dcarney): gcc can't handle Local below
4068  Local<Value> data = Local<Value>(), PropertyAttribute attribute = None,
4069  Local<AccessorSignature> signature = Local<AccessorSignature>(),
4070  AccessControl settings = DEFAULT);
4071 
4072  private:
4073  Template();
4074 
4075  friend class ObjectTemplate;
4076  friend class FunctionTemplate;
4077 };
4078 
4079 
4080 /**
4081  * NamedProperty[Getter|Setter] are used as interceptors on object.
4082  * See ObjectTemplate::SetNamedPropertyHandler.
4083  */
4085  Local<String> property,
4086  const PropertyCallbackInfo<Value>& info);
4087 
4088 
4089 /**
4090  * Returns the value if the setter intercepts the request.
4091  * Otherwise, returns an empty handle.
4092  */
4094  Local<String> property,
4095  Local<Value> value,
4096  const PropertyCallbackInfo<Value>& info);
4097 
4098 
4099 /**
4100  * Returns a non-empty handle if the interceptor intercepts the request.
4101  * The result is an integer encoding property attributes (like v8::None,
4102  * v8::DontEnum, etc.)
4103  */
4105  Local<String> property,
4106  const PropertyCallbackInfo<Integer>& info);
4107 
4108 
4109 /**
4110  * Returns a non-empty handle if the deleter intercepts the request.
4111  * The return value is true if the property could be deleted and false
4112  * otherwise.
4113  */
4115  Local<String> property,
4116  const PropertyCallbackInfo<Boolean>& info);
4117 
4118 
4119 /**
4120  * Returns an array containing the names of the properties the named
4121  * property getter intercepts.
4122  */
4124  const PropertyCallbackInfo<Array>& info);
4125 
4126 
4127 // TODO(dcarney): Deprecate and remove previous typedefs, and replace
4128 // GenericNamedPropertyFooCallback with just NamedPropertyFooCallback.
4129 /**
4130  * GenericNamedProperty[Getter|Setter] are used as interceptors on object.
4131  * See ObjectTemplate::SetNamedPropertyHandler.
4132  */
4134  Local<Name> property, const PropertyCallbackInfo<Value>& info);
4135 
4136 
4137 /**
4138  * Returns the value if the setter intercepts the request.
4139  * Otherwise, returns an empty handle.
4140  */
4142  Local<Name> property, Local<Value> value,
4143  const PropertyCallbackInfo<Value>& info);
4144 
4145 
4146 /**
4147  * Returns a non-empty handle if the interceptor intercepts the request.
4148  * The result is an integer encoding property attributes (like v8::None,
4149  * v8::DontEnum, etc.)
4150  */
4152  Local<Name> property, const PropertyCallbackInfo<Integer>& info);
4153 
4154 
4155 /**
4156  * Returns a non-empty handle if the deleter intercepts the request.
4157  * The return value is true if the property could be deleted and false
4158  * otherwise.
4159  */
4161  Local<Name> property, const PropertyCallbackInfo<Boolean>& info);
4162 
4163 
4164 /**
4165  * Returns an array containing the names of the properties the named
4166  * property getter intercepts.
4167  */
4169  const PropertyCallbackInfo<Array>& info);
4170 
4171 
4172 /**
4173  * Returns the value of the property if the getter intercepts the
4174  * request. Otherwise, returns an empty handle.
4175  */
4177  uint32_t index,
4178  const PropertyCallbackInfo<Value>& info);
4179 
4180 
4181 /**
4182  * Returns the value if the setter intercepts the request.
4183  * Otherwise, returns an empty handle.
4184  */
4186  uint32_t index,
4187  Local<Value> value,
4188  const PropertyCallbackInfo<Value>& info);
4189 
4190 
4191 /**
4192  * Returns a non-empty handle if the interceptor intercepts the request.
4193  * The result is an integer encoding property attributes.
4194  */
4196  uint32_t index,
4197  const PropertyCallbackInfo<Integer>& info);
4198 
4199 
4200 /**
4201  * Returns a non-empty handle if the deleter intercepts the request.
4202  * The return value is true if the property could be deleted and false
4203  * otherwise.
4204  */
4206  uint32_t index,
4207  const PropertyCallbackInfo<Boolean>& info);
4208 
4209 
4210 /**
4211  * Returns an array containing the indices of the properties the
4212  * indexed property getter intercepts.
4213  */
4215  const PropertyCallbackInfo<Array>& info);
4216 
4217 
4218 /**
4219  * Access type specification.
4220  */
4227 };
4228 
4229 
4230 /**
4231  * Returns true if cross-context access should be allowed to the named
4232  * property with the given key on the host object.
4233  */
4234 typedef bool (*NamedSecurityCallback)(Local<Object> host,
4235  Local<Value> key,
4236  AccessType type,
4237  Local<Value> data);
4238 
4239 
4240 /**
4241  * Returns true if cross-context access should be allowed to the indexed
4242  * property with the given index on the host object.
4243  */
4244 typedef bool (*IndexedSecurityCallback)(Local<Object> host,
4245  uint32_t index,
4246  AccessType type,
4247  Local<Value> data);
4248 
4249 
4250 /**
4251  * A FunctionTemplate is used to create functions at runtime. There
4252  * can only be one function created from a FunctionTemplate in a
4253  * context. The lifetime of the created function is equal to the
4254  * lifetime of the context. So in case the embedder needs to create
4255  * temporary functions that can be collected using Scripts is
4256  * preferred.
4257  *
4258  * Any modification of a FunctionTemplate after first instantiation will trigger
4259  *a crash.
4260  *
4261  * A FunctionTemplate can have properties, these properties are added to the
4262  * function object when it is created.
4263  *
4264  * A FunctionTemplate has a corresponding instance template which is
4265  * used to create object instances when the function is used as a
4266  * constructor. Properties added to the instance template are added to
4267  * each object instance.
4268  *
4269  * A FunctionTemplate can have a prototype template. The prototype template
4270  * is used to create the prototype object of the function.
4271  *
4272  * The following example shows how to use a FunctionTemplate:
4273  *
4274  * \code
4275  * v8::Local<v8::FunctionTemplate> t = v8::FunctionTemplate::New();
4276  * t->Set("func_property", v8::Number::New(1));
4277  *
4278  * v8::Local<v8::Template> proto_t = t->PrototypeTemplate();
4279  * proto_t->Set("proto_method", v8::FunctionTemplate::New(InvokeCallback));
4280  * proto_t->Set("proto_const", v8::Number::New(2));
4281  *
4282  * v8::Local<v8::ObjectTemplate> instance_t = t->InstanceTemplate();
4283  * instance_t->SetAccessor("instance_accessor", InstanceAccessorCallback);
4284  * instance_t->SetNamedPropertyHandler(PropertyHandlerCallback, ...);
4285  * instance_t->Set("instance_property", Number::New(3));
4286  *
4287  * v8::Local<v8::Function> function = t->GetFunction();
4288  * v8::Local<v8::Object> instance = function->NewInstance();
4289  * \endcode
4290  *
4291  * Let's use "function" as the JS variable name of the function object
4292  * and "instance" for the instance object created above. The function
4293  * and the instance will have the following properties:
4294  *
4295  * \code
4296  * func_property in function == true;
4297  * function.func_property == 1;
4298  *
4299  * function.prototype.proto_method() invokes 'InvokeCallback'
4300  * function.prototype.proto_const == 2;
4301  *
4302  * instance instanceof function == true;
4303  * instance.instance_accessor calls 'InstanceAccessorCallback'
4304  * instance.instance_property == 3;
4305  * \endcode
4306  *
4307  * A FunctionTemplate can inherit from another one by calling the
4308  * FunctionTemplate::Inherit method. The following graph illustrates
4309  * the semantics of inheritance:
4310  *
4311  * \code
4312  * FunctionTemplate Parent -> Parent() . prototype -> { }
4313  * ^ ^
4314  * | Inherit(Parent) | .__proto__
4315  * | |
4316  * FunctionTemplate Child -> Child() . prototype -> { }
4317  * \endcode
4318  *
4319  * A FunctionTemplate 'Child' inherits from 'Parent', the prototype
4320  * object of the Child() function has __proto__ pointing to the
4321  * Parent() function's prototype object. An instance of the Child
4322  * function has all properties on Parent's instance templates.
4323  *
4324  * Let Parent be the FunctionTemplate initialized in the previous
4325  * section and create a Child FunctionTemplate by:
4326  *
4327  * \code
4328  * Local<FunctionTemplate> parent = t;
4329  * Local<FunctionTemplate> child = FunctionTemplate::New();
4330  * child->Inherit(parent);
4331  *
4332  * Local<Function> child_function = child->GetFunction();
4333  * Local<Object> child_instance = child_function->NewInstance();
4334  * \endcode
4335  *
4336  * The Child function and Child instance will have the following
4337  * properties:
4338  *
4339  * \code
4340  * child_func.prototype.__proto__ == function.prototype;
4341  * child_instance.instance_accessor calls 'InstanceAccessorCallback'
4342  * child_instance.instance_property == 3;
4343  * \endcode
4344  */
4346  public:
4347  /** Creates a function template.*/
4348  static Local<FunctionTemplate> New(
4349  Isolate* isolate, FunctionCallback callback = 0,
4350  Local<Value> data = Local<Value>(),
4351  Local<Signature> signature = Local<Signature>(), int length = 0);
4352 
4353  /** Returns the unique function instance in the current execution context.*/
4354  V8_DEPRECATE_SOON("Use maybe version", Local<Function> GetFunction());
4356  Local<Context> context);
4357 
4358  /**
4359  * Set the call-handler callback for a FunctionTemplate. This
4360  * callback is called whenever the function created from this
4361  * FunctionTemplate is called.
4362  */
4363  void SetCallHandler(FunctionCallback callback,
4364  Local<Value> data = Local<Value>());
4365 
4366  /** Set the predefined length property for the FunctionTemplate. */
4367  void SetLength(int length);
4368 
4369  /** Get the InstanceTemplate. */
4371 
4372  /** Causes the function template to inherit from a parent function template.*/
4373  void Inherit(Local<FunctionTemplate> parent);
4374 
4375  /**
4376  * A PrototypeTemplate is the template used to create the prototype object
4377  * of the function created by this template.
4378  */
4380 
4381  /**
4382  * Set the class name of the FunctionTemplate. This is used for
4383  * printing objects created with the function created from the
4384  * FunctionTemplate as its constructor.
4385  */
4386  void SetClassName(Local<String> name);
4387 
4388 
4389  /**
4390  * When set to true, no access check will be performed on the receiver of a
4391  * function call. Currently defaults to true, but this is subject to change.
4392  */
4393  void SetAcceptAnyReceiver(bool value);
4394 
4395  /**
4396  * Determines whether the __proto__ accessor ignores instances of
4397  * the function template. If instances of the function template are
4398  * ignored, __proto__ skips all instances and instead returns the
4399  * next object in the prototype chain.
4400  *
4401  * Call with a value of true to make the __proto__ accessor ignore
4402  * instances of the function template. Call with a value of false
4403  * to make the __proto__ accessor not ignore instances of the
4404  * function template. By default, instances of a function template
4405  * are not ignored.
4406  */
4407  void SetHiddenPrototype(bool value);
4408 
4409  /**
4410  * Sets the ReadOnly flag in the attributes of the 'prototype' property
4411  * of functions created from this FunctionTemplate to true.
4412  */
4413  void ReadOnlyPrototype();
4414 
4415  /**
4416  * Removes the prototype property from functions created from this
4417  * FunctionTemplate.
4418  */
4419  void RemovePrototype();
4420 
4421  /**
4422  * Returns true if the given object is an instance of this function
4423  * template.
4424  */
4425  bool HasInstance(Local<Value> object);
4426 
4427  private:
4428  FunctionTemplate();
4429  friend class Context;
4430  friend class ObjectTemplate;
4431 };
4432 
4433 
4435  kNone = 0,
4436  // See ALL_CAN_READ above.
4437  kAllCanRead = 1,
4438  // Will not call into interceptor for properties on the receiver or prototype
4439  // chain. Currently only valid for named interceptors.
4440  kNonMasking = 1 << 1,
4441  // Will not call into interceptor for symbol lookup. Only meaningful for
4442  // named interceptors.
4443  kOnlyInterceptStrings = 1 << 2,
4444 };
4445 
4446 
4449  /** Note: getter is required **/
4455  Local<Value> data = Local<Value>(),
4457  : getter(getter),
4458  setter(setter),
4459  query(query),
4460  deleter(deleter),
4461  enumerator(enumerator),
4462  data(data),
4463  flags(flags) {}
4464 
4470  Local<Value> data;
4472 };
4473 
4474 
4477  /** Note: getter is required **/
4478  IndexedPropertyGetterCallback getter = 0,
4479  IndexedPropertySetterCallback setter = 0,
4480  IndexedPropertyQueryCallback query = 0,
4481  IndexedPropertyDeleterCallback deleter = 0,
4482  IndexedPropertyEnumeratorCallback enumerator = 0,
4483  Local<Value> data = Local<Value>(),
4485  : getter(getter),
4486  setter(setter),
4487  query(query),
4488  deleter(deleter),
4489  enumerator(enumerator),
4490  data(data),
4491  flags(flags) {}
4492 
4498  Local<Value> data;
4500 };
4501 
4502 
4503 /**
4504  * An ObjectTemplate is used to create objects at runtime.
4505  *
4506  * Properties added to an ObjectTemplate are added to each object
4507  * created from the ObjectTemplate.
4508  */
4510  public:
4511  /** Creates an ObjectTemplate. */
4512  static Local<ObjectTemplate> New(
4513  Isolate* isolate,
4514  Local<FunctionTemplate> constructor = Local<FunctionTemplate>());
4515  static V8_DEPRECATE_SOON("Use isolate version", Local<ObjectTemplate> New());
4516 
4517  /** Creates a new instance of this template.*/
4518  V8_DEPRECATE_SOON("Use maybe version", Local<Object> NewInstance());
4519  V8_WARN_UNUSED_RESULT MaybeLocal<Object> NewInstance(Local<Context> context);
4520 
4521  /**
4522  * Sets an accessor on the object template.
4523  *
4524  * Whenever the property with the given name is accessed on objects
4525  * created from this ObjectTemplate the getter and setter callbacks
4526  * are called instead of getting and setting the property directly
4527  * on the JavaScript object.
4528  *
4529  * \param name The name of the property for which an accessor is added.
4530  * \param getter The callback to invoke when getting the property.
4531  * \param setter The callback to invoke when setting the property.
4532  * \param data A piece of data that will be passed to the getter and setter
4533  * callbacks whenever they are invoked.
4534  * \param settings Access control settings for the accessor. This is a bit
4535  * field consisting of one of more of
4536  * DEFAULT = 0, ALL_CAN_READ = 1, or ALL_CAN_WRITE = 2.
4537  * The default is to not allow cross-context access.
4538  * ALL_CAN_READ means that all cross-context reads are allowed.
4539  * ALL_CAN_WRITE means that all cross-context writes are allowed.
4540  * The combination ALL_CAN_READ | ALL_CAN_WRITE can be used to allow all
4541  * cross-context access.
4542  * \param attribute The attributes of the property for which an accessor
4543  * is added.
4544  * \param signature The signature describes valid receivers for the accessor
4545  * and is used to perform implicit instance checks against them. If the
4546  * receiver is incompatible (i.e. is not an instance of the constructor as
4547  * defined by FunctionTemplate::HasInstance()), an implicit TypeError is
4548  * thrown and no callback is invoked.
4549  */
4550  void SetAccessor(
4551  Local<String> name, AccessorGetterCallback getter,
4552  AccessorSetterCallback setter = 0, Local<Value> data = Local<Value>(),
4553  AccessControl settings = DEFAULT, PropertyAttribute attribute = None,
4554  Local<AccessorSignature> signature = Local<AccessorSignature>());
4555  void SetAccessor(
4556  Local<Name> name, AccessorNameGetterCallback getter,
4557  AccessorNameSetterCallback setter = 0, Local<Value> data = Local<Value>(),
4558  AccessControl settings = DEFAULT, PropertyAttribute attribute = None,
4559  Local<AccessorSignature> signature = Local<AccessorSignature>());
4560 
4561  /**
4562  * Sets a named property handler on the object template.
4563  *
4564  * Whenever a property whose name is a string is accessed on objects created
4565  * from this object template, the provided callback is invoked instead of
4566  * accessing the property directly on the JavaScript object.
4567  *
4568  * Note that new code should use the second version that can intercept
4569  * symbol-named properties as well as string-named properties.
4570  *
4571  * \param getter The callback to invoke when getting a property.
4572  * \param setter The callback to invoke when setting a property.
4573  * \param query The callback to invoke to check if a property is present,
4574  * and if present, get its attributes.
4575  * \param deleter The callback to invoke when deleting a property.
4576  * \param enumerator The callback to invoke to enumerate all the named
4577  * properties of an object.
4578  * \param data A piece of data that will be passed to the callbacks
4579  * whenever they are invoked.
4580  */
4581  // TODO(dcarney): deprecate
4583  NamedPropertySetterCallback setter = 0,
4584  NamedPropertyQueryCallback query = 0,
4585  NamedPropertyDeleterCallback deleter = 0,
4586  NamedPropertyEnumeratorCallback enumerator = 0,
4587  Local<Value> data = Local<Value>());
4588  void SetHandler(const NamedPropertyHandlerConfiguration& configuration);
4589 
4590  /**
4591  * Sets an indexed property handler on the object template.
4592  *
4593  * Whenever an indexed property is accessed on objects created from
4594  * this object template, the provided callback is invoked instead of
4595  * accessing the property directly on the JavaScript object.
4596  *
4597  * \param getter The callback to invoke when getting a property.
4598  * \param setter The callback to invoke when setting a property.
4599  * \param query The callback to invoke to check if an object has a property.
4600  * \param deleter The callback to invoke when deleting a property.
4601  * \param enumerator The callback to invoke to enumerate all the indexed
4602  * properties of an object.
4603  * \param data A piece of data that will be passed to the callbacks
4604  * whenever they are invoked.
4605  */
4606  void SetHandler(const IndexedPropertyHandlerConfiguration& configuration);
4607  // TODO(dcarney): deprecate
4610  IndexedPropertySetterCallback setter = 0,
4611  IndexedPropertyQueryCallback query = 0,
4612  IndexedPropertyDeleterCallback deleter = 0,
4613  IndexedPropertyEnumeratorCallback enumerator = 0,
4614  Local<Value> data = Local<Value>()) {
4616  deleter, enumerator, data));
4617  }
4618  /**
4619  * Sets the callback to be used when calling instances created from
4620  * this template as a function. If no callback is set, instances
4621  * behave like normal JavaScript objects that cannot be called as a
4622  * function.
4623  */
4625  Local<Value> data = Local<Value>());
4626 
4627  /**
4628  * Mark object instances of the template as undetectable.
4629  *
4630  * In many ways, undetectable objects behave as though they are not
4631  * there. They behave like 'undefined' in conditionals and when
4632  * printed. However, properties can be accessed and called as on
4633  * normal objects.
4634  */
4635  void MarkAsUndetectable();
4636 
4637  /**
4638  * Sets access check callbacks on the object template and enables
4639  * access checks.
4640  *
4641  * When accessing properties on instances of this object template,
4642  * the access check callback will be called to determine whether or
4643  * not to allow cross-context access to the properties.
4644  */
4646  IndexedSecurityCallback indexed_handler,
4647  Local<Value> data = Local<Value>());
4648 
4649  /**
4650  * Gets the number of internal fields for objects generated from
4651  * this template.
4652  */
4653  int InternalFieldCount();
4654 
4655  /**
4656  * Sets the number of internal fields for objects generated from
4657  * this template.
4658  */
4659  void SetInternalFieldCount(int value);
4660 
4661  private:
4662  ObjectTemplate();
4663  static Local<ObjectTemplate> New(internal::Isolate* isolate,
4664  Local<FunctionTemplate> constructor);
4665  friend class FunctionTemplate;
4666 };
4667 
4668 
4669 /**
4670  * A Signature specifies which receiver is valid for a function.
4671  */
4672 class V8_EXPORT Signature : public Data {
4673  public:
4674  static Local<Signature> New(
4675  Isolate* isolate,
4676  Local<FunctionTemplate> receiver = Local<FunctionTemplate>());
4677 
4678  private:
4679  Signature();
4680 };
4681 
4682 
4683 /**
4684  * An AccessorSignature specifies which receivers are valid parameters
4685  * to an accessor callback.
4686  */
4688  public:
4689  static Local<AccessorSignature> New(
4690  Isolate* isolate,
4691  Local<FunctionTemplate> receiver = Local<FunctionTemplate>());
4692 
4693  private:
4694  AccessorSignature();
4695 };
4696 
4697 
4698 /**
4699  * A utility for determining the type of objects based on the template
4700  * they were constructed from.
4701  */
4702 class V8_EXPORT TypeSwitch : public Data {
4703  public:
4704  static Local<TypeSwitch> New(Local<FunctionTemplate> type);
4705  static Local<TypeSwitch> New(int argc, Local<FunctionTemplate> types[]);
4706  int match(Local<Value> value);
4707 
4708  private:
4709  TypeSwitch();
4710 };
4711 
4712 
4713 // --- Extensions ---
4714 
4717  public:
4719  ExternalOneByteStringResourceImpl(const char* data, size_t length)
4720  : data_(data), length_(length) {}
4721  const char* data() const { return data_; }
4722  size_t length() const { return length_; }
4723 
4724  private:
4725  const char* data_;
4726  size_t length_;
4727 };
4728 
4729 /**
4730  * Ignore
4731  */
4732 class V8_EXPORT Extension { // NOLINT
4733  public:
4734  // Note that the strings passed into this constructor must live as long
4735  // as the Extension itself.
4736  Extension(const char* name,
4737  const char* source = 0,
4738  int dep_count = 0,
4739  const char** deps = 0,
4740  int source_length = -1);
4741  virtual ~Extension() { }
4743  v8::Isolate* isolate, v8::Local<v8::String> name) {
4744  return v8::Local<v8::FunctionTemplate>();
4745  }
4746 
4747  const char* name() const { return name_; }
4748  size_t source_length() const { return source_length_; }
4750  return &source_; }
4751  int dependency_count() { return dep_count_; }
4752  const char** dependencies() { return deps_; }
4753  void set_auto_enable(bool value) { auto_enable_ = value; }
4754  bool auto_enable() { return auto_enable_; }
4755 
4756  private:
4757  const char* name_;
4758  size_t source_length_; // expected to initialize before source_
4760  int dep_count_;
4761  const char** deps_;
4762  bool auto_enable_;
4763 
4764  // Disallow copying and assigning.
4765  Extension(const Extension&);
4766  void operator=(const Extension&);
4767 };
4768 
4769 
4770 void V8_EXPORT RegisterExtension(Extension* extension);
4771 
4772 
4773 // --- Statics ---
4774 
4775 V8_INLINE Local<Primitive> Undefined(Isolate* isolate);
4776 V8_INLINE Local<Primitive> Null(Isolate* isolate);
4777 V8_INLINE Local<Boolean> True(Isolate* isolate);
4778 V8_INLINE Local<Boolean> False(Isolate* isolate);
4779 
4780 
4781 /**
4782  * A set of constraints that specifies the limits of the runtime's memory use.
4783  * You must set the heap size before initializing the VM - the size cannot be
4784  * adjusted after the VM is initialized.
4785  *
4786  * If you are using threads then you should hold the V8::Locker lock while
4787  * setting the stack limit and you must set a non-default stack limit separately
4788  * for each thread.
4789  */
4791  public:
4793 
4794  /**
4795  * Configures the constraints with reasonable default values based on the
4796  * capabilities of the current device the VM is running on.
4797  *
4798  * \param physical_memory The total amount of physical memory on the current
4799  * device, in bytes.
4800  * \param virtual_memory_limit The amount of virtual memory on the current
4801  * device, in bytes, or zero, if there is no limit.
4802  */
4803  void ConfigureDefaults(uint64_t physical_memory,
4804  uint64_t virtual_memory_limit);
4805 
4806  int max_semi_space_size() const { return max_semi_space_size_; }
4807  void set_max_semi_space_size(int value) { max_semi_space_size_ = value; }
4808  int max_old_space_size() const { return max_old_space_size_; }
4809  void set_max_old_space_size(int value) { max_old_space_size_ = value; }
4810  int max_executable_size() const { return max_executable_size_; }
4811  void set_max_executable_size(int value) { max_executable_size_ = value; }
4812  uint32_t* stack_limit() const { return stack_limit_; }
4813  // Sets an address beyond which the VM's stack may not grow.
4814  void set_stack_limit(uint32_t* value) { stack_limit_ = value; }
4815  size_t code_range_size() const { return code_range_size_; }
4816  void set_code_range_size(size_t value) {
4817  code_range_size_ = value;
4818  }
4819 
4820  private:
4821  int max_semi_space_size_;
4822  int max_old_space_size_;
4823  int max_executable_size_;
4824  uint32_t* stack_limit_;
4825  size_t code_range_size_;
4826 };
4827 
4828 
4829 // --- Exceptions ---
4830 
4831 
4832 typedef void (*FatalErrorCallback)(const char* location, const char* message);
4833 
4834 
4835 typedef void (*MessageCallback)(Local<Message> message, Local<Value> error);
4836 
4837 // --- Tracing ---
4838 
4839 typedef void (*LogEventCallback)(const char* name, int event);
4840 
4841 /**
4842  * Create new error objects by calling the corresponding error object
4843  * constructor with the message.
4844  */
4846  public:
4847  static Local<Value> RangeError(Local<String> message);
4848  static Local<Value> ReferenceError(Local<String> message);
4849  static Local<Value> SyntaxError(Local<String> message);
4850  static Local<Value> TypeError(Local<String> message);
4851  static Local<Value> Error(Local<String> message);
4852 
4853  /**
4854  * Creates an error message for the given exception.
4855  * Will try to reconstruct the original stack trace from the exception value,
4856  * or capture the current stack trace if not available.
4857  */
4858  static Local<Message> CreateMessage(Local<Value> exception);
4859 
4860  /**
4861  * Returns the original stack trace that was captured at the creation time
4862  * of a given exception, or an empty handle if not available.
4863  */
4864  static Local<StackTrace> GetStackTrace(Local<Value> exception);
4865 };
4866 
4867 
4868 // --- Counters Callbacks ---
4869 
4870 typedef int* (*CounterLookupCallback)(const char* name);
4871 
4872 typedef void* (*CreateHistogramCallback)(const char* name,
4873  int min,
4874  int max,
4875  size_t buckets);
4876 
4877 typedef void (*AddHistogramSampleCallback)(void* histogram, int sample);
4878 
4879 // --- Memory Allocation Callback ---
4889 };
4890 
4895  };
4896 
4898  AllocationAction action,
4899  int size);
4900 
4901 // --- Leave Script Callback ---
4902 typedef void (*CallCompletedCallback)();
4903 
4904 // --- Promise Reject Callback ---
4908 };
4909 
4911  public:
4913  Local<Value> value, Local<StackTrace> stack_trace)
4914  : promise_(promise),
4915  event_(event),
4916  value_(value),
4917  stack_trace_(stack_trace) {}
4918 
4919  V8_INLINE Local<Promise> GetPromise() const { return promise_; }
4920  V8_INLINE PromiseRejectEvent GetEvent() const { return event_; }
4921  V8_INLINE Local<Value> GetValue() const { return value_; }
4922 
4923  // DEPRECATED. Use v8::Exception::CreateMessage(GetValue())->GetStackTrace()
4924  V8_INLINE Local<StackTrace> GetStackTrace() const { return stack_trace_; }
4925 
4926  private:
4927  Local<Promise> promise_;
4928  PromiseRejectEvent event_;
4929  Local<Value> value_;
4930  Local<StackTrace> stack_trace_;
4931 };
4932 
4934 
4935 // --- Microtask Callback ---
4936 typedef void (*MicrotaskCallback)(void* data);
4937 
4938 // --- Failed Access Check Callback ---
4939 typedef void (*FailedAccessCheckCallback)(Local<Object> target,
4940  AccessType type,
4941  Local<Value> data);
4942 
4943 // --- AllowCodeGenerationFromStrings callbacks ---
4944 
4945 /**
4946  * Callback to check if code generation from strings is allowed. See
4947  * Context::AllowCodeGenerationFromStrings.
4948  */
4949 typedef bool (*AllowCodeGenerationFromStringsCallback)(Local<Context> context);
4950 
4951 // --- Garbage Collection Callbacks ---
4952 
4953 /**
4954  * Applications can register callback functions which will be called before and
4955  * after certain garbage collection operations. Allocations are not allowed in
4956  * the callback functions, you therefore cannot manipulate objects (set or
4957  * delete properties for example) since it is possible such operations will
4958  * result in the allocation of objects.
4959  */
4960 enum GCType {
4967 };
4968 
4974 };
4975 
4976 V8_DEPRECATE_SOON("Use GCCallBack instead",
4977  typedef void (*GCPrologueCallback)(GCType type,
4978  GCCallbackFlags flags));
4979 V8_DEPRECATE_SOON("Use GCCallBack instead",
4980  typedef void (*GCEpilogueCallback)(GCType type,
4981  GCCallbackFlags flags));
4982 typedef void (*GCCallback)(GCType type, GCCallbackFlags flags);
4983 
4984 typedef void (*InterruptCallback)(Isolate* isolate, void* data);
4985 
4986 
4987 /**
4988  * Collection of V8 heap information.
4989  *
4990  * Instances of this class can be passed to v8::V8::HeapStatistics to
4991  * get heap statistics from V8.
4992  */
4994  public:
4995  HeapStatistics();
4996  size_t total_heap_size() { return total_heap_size_; }
4997  size_t total_heap_size_executable() { return total_heap_size_executable_; }
4998  size_t total_physical_size() { return total_physical_size_; }
4999  size_t total_available_size() { return total_available_size_; }
5000  size_t used_heap_size() { return used_heap_size_; }
5001  size_t heap_size_limit() { return heap_size_limit_; }
5002 
5003  private:
5004  size_t total_heap_size_;
5005  size_t total_heap_size_executable_;
5006  size_t total_physical_size_;
5007  size_t total_available_size_;
5008  size_t used_heap_size_;
5009  size_t heap_size_limit_;
5010 
5011  friend class V8;
5012  friend class Isolate;
5013 };
5014 
5015 
5017  public:
5019  const char* space_name() { return space_name_; }
5020  size_t space_size() { return space_size_; }
5021  size_t space_used_size() { return space_used_size_; }
5022  size_t space_available_size() { return space_available_size_; }
5023  size_t physical_space_size() { return physical_space_size_; }
5024 
5025  private:
5026  const char* space_name_;
5027  size_t space_size_;
5028  size_t space_used_size_;
5029  size_t space_available_size_;
5030  size_t physical_space_size_;
5031 
5032  friend class Isolate;
5033 };
5034 
5035 
5037  public:
5039  const char* object_type() { return object_type_; }
5040  const char* object_sub_type() { return object_sub_type_; }
5041  size_t object_count() { return object_count_; }
5042  size_t object_size() { return object_size_; }
5043 
5044  private:
5045  const char* object_type_;
5046  const char* object_sub_type_;
5047  size_t object_count_;
5048  size_t object_size_;
5049 
5050  friend class Isolate;
5051 };
5052 
5053 
5054 class RetainedObjectInfo;
5055 
5056 
5057 /**
5058  * FunctionEntryHook is the type of the profile entry hook called at entry to
5059  * any generated function when function-level profiling is enabled.
5060  *
5061  * \param function the address of the function that's being entered.
5062  * \param return_addr_location points to a location on stack where the machine
5063  * return address resides. This can be used to identify the caller of
5064  * \p function, and/or modified to divert execution when \p function exits.
5065  *
5066  * \note the entry hook must not cause garbage collection.
5067  */
5068 typedef void (*FunctionEntryHook)(uintptr_t function,
5069  uintptr_t return_addr_location);
5070 
5071 /**
5072  * A JIT code event is issued each time code is added, moved or removed.
5073  *
5074  * \note removal events are not currently issued.
5075  */
5077  enum EventType {
5084  };
5085  // Definition of the code position type. The "POSITION" type means the place
5086  // in the source code which are of interest when making stack traces to
5087  // pin-point the source location of a stack frame as close as possible.
5088  // The "STATEMENT_POSITION" means the place at the beginning of each
5089  // statement, and is used to indicate possible break locations.
5091 
5092  // Type of event.
5094  // Start of the instructions.
5095  void* code_start;
5096  // Size of the instructions.
5098  // Script info for CODE_ADDED event.
5100  // User-defined data for *_LINE_INFO_* event. It's used to hold the source
5101  // code line information which is returned from the
5102  // CODE_START_LINE_INFO_RECORDING event. And it's passed to subsequent
5103  // CODE_ADD_LINE_POS_INFO and CODE_END_LINE_INFO_RECORDING events.
5104  void* user_data;
5105 
5106  struct name_t {
5107  // Name of the object associated with the code, note that the string is not
5108  // zero-terminated.
5109  const char* str;
5110  // Number of chars in str.
5112  };
5113 
5114  struct line_info_t {
5115  // PC offset
5117  // Code postion
5119  // The position type.
5121  };
5122 
5123  union {
5124  // Only valid for CODE_ADDED.</