v8.h 315 KB
Newer Older
1
// Copyright 2012 the V8 project authors. All rights reserved.
2 3
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
4

5
/** \mainpage V8 API Reference Guide
6 7
 *
 * V8 is Google's open source JavaScript engine.
8 9 10 11 12
 *
 * This set of documents provides reference material generated from the
 * V8 header file, include/v8.h.
 *
 * For other documentation see http://code.google.com/apis/v8/
13
 */
14

15 16
#ifndef INCLUDE_V8_H_
#define INCLUDE_V8_H_
17

18 19 20
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
21
#include <memory>
hlopko's avatar
hlopko committed
22 23
#include <utility>
#include <vector>
24

25 26
#include "v8-version.h"  // NOLINT(build/include)
#include "v8config.h"    // NOLINT(build/include)
27

28 29 30
// We reserve the V8_* prefix for macros defined in V8 public API and
// assume there are no name conflicts with the embedder's code.

31
#ifdef V8_OS_WIN
32 33 34 35 36 37 38

// Setup for Windows DLL export/import. When building the V8 DLL the
// BUILDING_V8_SHARED needs to be defined. When building a program which uses
// the V8 DLL USING_V8_SHARED needs to be defined. When either building the V8
// static library or building a program which uses the V8 static library neither
// BUILDING_V8_SHARED nor USING_V8_SHARED should be defined.
#ifdef BUILDING_V8_SHARED
39
# define V8_EXPORT __declspec(dllexport)
40
#elif USING_V8_SHARED
41
# define V8_EXPORT __declspec(dllimport)
42
#else
43
# define V8_EXPORT
44 45
#endif  // BUILDING_V8_SHARED

46
#else  // V8_OS_WIN
47

48
// Setup for Linux shared library export.
49
#if V8_HAS_ATTRIBUTE_VISIBILITY
50 51 52 53 54
# ifdef BUILDING_V8_SHARED
#  define V8_EXPORT __attribute__ ((visibility("default")))
# else
#  define V8_EXPORT
# endif
55
#else
56
# define V8_EXPORT
57 58
#endif

59
#endif  // V8_OS_WIN
60

61
/**
62
 * The v8 JavaScript engine.
63 64 65
 */
namespace v8 {

66
class AccessorSignature;
67
class Array;
68
class ArrayBuffer;
69
class Boolean;
70
class BooleanObject;
71
class Context;
72
class CpuProfiler;
73
class Data;
74
class Date;
75 76 77
class External;
class Function;
class FunctionTemplate;
78
class HeapProfiler;
79
class ImplementationUtilities;
80 81 82
class Int32;
class Integer;
class Isolate;
83 84
template <class T>
class Maybe;
85
class Name;
86 87 88 89 90
class Number;
class NumberObject;
class Object;
class ObjectOperationDescriptor;
class ObjectTemplate;
91
class Platform;
92
class Primitive;
93
class Promise;
94
class PropertyDescriptor;
95
class Proxy;
96
class RawOperationDescriptor;
97
class Script;
98
class SharedArrayBuffer;
99
class Signature;
100
class StartupData;
101 102 103 104
class StackFrame;
class StackTrace;
class String;
class StringObject;
105 106
class Symbol;
class SymbolObject;
107
class Private;
108 109 110
class Uint32;
class Utils;
class Value;
111
template <class T> class Local;
112 113
template <class T>
class MaybeLocal;
114
template <class T> class Eternal;
115
template<class T> class NonCopyablePersistentTraits;
116
template<class T> class PersistentBase;
117 118
template <class T, class M = NonCopyablePersistentTraits<T> >
class Persistent;
119 120
template <class T>
class Global;
121
template<class K, class V, class T> class PersistentValueMap;
122 123 124
template <class K, class V, class T>
class PersistentValueMapBase;
template <class K, class V, class T>
125
class GlobalValueMap;
126
template<class V, class T> class PersistentValueVector;
127
template<class T, class P> class WeakCallbackObject;
128 129 130
class FunctionTemplate;
class ObjectTemplate;
class Data;
131
template<typename T> class FunctionCallbackInfo;
132 133 134 135
template<typename T> class PropertyCallbackInfo;
class StackTrace;
class StackFrame;
class Isolate;
136
class CallHandlerHelper;
137
class EscapableHandleScope;
138
template<typename T> class ReturnValue;
139

140
namespace internal {
141
class Arguments;
142
class Heap;
143 144
class HeapObject;
class Isolate;
145
class Object;
146
struct StreamedSource;
147
template<typename T> class CustomArguments;
148 149
class PropertyCallbackArguments;
class FunctionCallbackArguments;
150
class GlobalHandles;
151
}  // namespace internal
152

153

154
// --- Handles ---
155

156 157 158
#define TYPE_CHECK(T, S)                                       \
  while (false) {                                              \
    *(static_cast<T* volatile*>(0)) = static_cast<S*>(0);      \
159 160
  }

161

162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
/**
 * An object reference managed by the v8 garbage collector.
 *
 * All objects returned from v8 have to be tracked by the garbage
 * collector so that it knows that the objects are still alive.  Also,
 * because the garbage collector may move objects, it is unsafe to
 * point directly to an object.  Instead, all objects are stored in
 * handles which are known by the garbage collector and updated
 * whenever an object moves.  Handles should always be passed by value
 * (except in cases like out-parameters) and they should never be
 * allocated on the heap.
 *
 * There are two types of handles: local and persistent handles.
 * Local handles are light-weight and transient and typically used in
 * local operations.  They are managed by HandleScopes.  Persistent
 * handles can be used when storing objects across several independent
 * operations and have to be explicitly deallocated when they're no
 * longer used.
 *
 * It is safe to extract the object stored in the handle by
 * dereferencing the handle (for instance, to extract the Object* from
183
 * a Local<Object>); the value will still be governed by a handle
184 185 186
 * behind the scenes and the same rules apply to these values as to
 * their handles.
 */
187 188
template <class T>
class Local {
189
 public:
190 191 192
  V8_INLINE Local() : val_(0) {}
  template <class S>
  V8_INLINE Local(Local<S> that)
193 194 195
      : val_(reinterpret_cast<T*>(*that)) {
    /**
     * This check fails when trying to convert between incompatible
196 197
     * handles. For example, converting from a Local<String> to a
     * Local<Number>.
198 199 200 201 202 203 204
     */
    TYPE_CHECK(T, S);
  }

  /**
   * Returns true if the handle is empty.
   */
205
  V8_INLINE bool IsEmpty() const { return val_ == 0; }
206 207 208 209

  /**
   * Sets the handle to be empty. IsEmpty() will then return true.
   */
210
  V8_INLINE void Clear() { val_ = 0; }
211

212
  V8_INLINE T* operator->() const { return val_; }
213

214
  V8_INLINE T* operator*() const { return val_; }
215 216 217 218 219 220 221

  /**
   * Checks whether two handles are the same.
   * Returns true if both are empty, or if the objects
   * to which they refer are identical.
   * The handles' references are not checked.
   */
222 223
  template <class S>
  V8_INLINE bool operator==(const Local<S>& that) const {
224 225
    internal::Object** a = reinterpret_cast<internal::Object**>(this->val_);
    internal::Object** b = reinterpret_cast<internal::Object**>(that.val_);
226 227 228 229 230
    if (a == 0) return b == 0;
    if (b == 0) return false;
    return *a == *b;
  }

231
  template <class S> V8_INLINE bool operator==(
232 233 234
      const PersistentBase<S>& that) const {
    internal::Object** a = reinterpret_cast<internal::Object**>(this->val_);
    internal::Object** b = reinterpret_cast<internal::Object**>(that.val_);
235 236 237 238 239
    if (a == 0) return b == 0;
    if (b == 0) return false;
    return *a == *b;
  }

240 241 242 243 244 245
  /**
   * Checks whether two handles are different.
   * Returns true if only one of the handles is empty, or if
   * the objects to which they refer are different.
   * The handles' references are not checked.
   */
246 247
  template <class S>
  V8_INLINE bool operator!=(const Local<S>& that) const {
248 249 250
    return !operator==(that);
  }

251 252
  template <class S> V8_INLINE bool operator!=(
      const Persistent<S>& that) const {
253 254 255
    return !operator==(that);
  }

256
  template <class S> V8_INLINE static Local<T> Cast(Local<S> that) {
257 258 259
#ifdef V8_ENABLE_CHECKS
    // If we're going to perform the type check then we have to check
    // that the handle isn't empty before doing the checked cast.
260
    if (that.IsEmpty()) return Local<T>();
261
#endif
262 263
    return Local<T>(T::Cast(*that));
  }
264

265 266
  template <class S>
  V8_INLINE Local<S> As() const {
267 268 269
    return Local<S>::Cast(*this);
  }

270 271 272 273
  /**
   * Create a local handle for the content of another handle.
   * The referee is kept alive by the local handle even when
   * the original handle is destroyed/disposed.
274
   */
275
  V8_INLINE static Local<T> New(Isolate* isolate, Local<T> that);
276
  V8_INLINE static Local<T> New(Isolate* isolate,
277
                                const PersistentBase<T>& that);
278

279
 private:
280
  friend class Utils;
281
  template<class F> friend class Eternal;
282
  template<class F> friend class PersistentBase;
283
  template<class F, class M> friend class Persistent;
284
  template<class F> friend class Local;
285 286
  template <class F>
  friend class MaybeLocal;
287 288
  template<class F> friend class FunctionCallbackInfo;
  template<class F> friend class PropertyCallbackInfo;
289 290 291
  friend class String;
  friend class Object;
  friend class Context;
292
  friend class Private;
293
  template<class F> friend class internal::CustomArguments;
294 295 296 297
  friend Local<Primitive> Undefined(Isolate* isolate);
  friend Local<Primitive> Null(Isolate* isolate);
  friend Local<Boolean> True(Isolate* isolate);
  friend Local<Boolean> False(Isolate* isolate);
298
  friend class HandleScope;
299
  friend class EscapableHandleScope;
300 301
  template <class F1, class F2, class F3>
  friend class PersistentValueMapBase;
302
  template<class F1, class F2> friend class PersistentValueVector;
303 304
  template <class F>
  friend class ReturnValue;
305

xaxxon's avatar
xaxxon committed
306
  explicit V8_INLINE Local(T* that) : val_(that) {}
307
  V8_INLINE static Local<T> New(Isolate* isolate, T* that);
308
  T* val_;
309
};
310

311

312
#if !defined(V8_IMMINENT_DEPRECATION_WARNINGS)
franzih's avatar
franzih committed
313
// Handle is an alias for Local for historical reasons.
314 315
template <class T>
using Handle = Local<T>;
316
#endif
317 318


319 320 321 322 323 324 325 326 327 328
/**
 * A MaybeLocal<> is a wrapper around Local<> that enforces a check whether
 * the Local<> is empty before it can be used.
 *
 * If an API method returns a MaybeLocal<>, the API method can potentially fail
 * either because an exception is thrown, or because an exception is pending,
 * e.g. because a previous API call threw an exception that hasn't been caught
 * yet, or because a TerminateExecution exception was thrown. In that case, an
 * empty MaybeLocal is returned.
 */
329 330 331 332 333 334 335 336 337 338
template <class T>
class MaybeLocal {
 public:
  V8_INLINE MaybeLocal() : val_(nullptr) {}
  template <class S>
  V8_INLINE MaybeLocal(Local<S> that)
      : val_(reinterpret_cast<T*>(*that)) {
    TYPE_CHECK(T, S);
  }

339
  V8_INLINE bool IsEmpty() const { return val_ == nullptr; }
340 341 342

  template <class S>
  V8_WARN_UNUSED_RESULT V8_INLINE bool ToLocal(Local<S>* out) const {
343
    out->val_ = IsEmpty() ? nullptr : this->val_;
344
    return !IsEmpty();
345 346
  }

347
  // Will crash if the MaybeLocal<> is empty.
348
  V8_INLINE Local<T> ToLocalChecked();
349

350 351 352 353 354
  template <class S>
  V8_INLINE Local<S> FromMaybe(Local<S> default_value) const {
    return IsEmpty() ? default_value : Local<S>(val_);
  }

355 356 357 358 359
 private:
  T* val_;
};


360 361 362
// Eternal handles are set-once handles that live for the life of the isolate.
template <class T> class Eternal {
 public:
363
  V8_INLINE Eternal() : index_(kInitialValue) { }
364
  template<class S>
365
  V8_INLINE Eternal(Isolate* isolate, Local<S> handle) : index_(kInitialValue) {
366 367 368
    Set(isolate, handle);
  }
  // Can only be safely called if already set.
369 370 371
  V8_INLINE Local<T> Get(Isolate* isolate);
  V8_INLINE bool IsEmpty() { return index_ == kInitialValue; }
  template<class S> V8_INLINE void Set(Isolate* isolate, Local<S> handle);
372 373 374 375 376 377 378

 private:
  static const int kInitialValue = -1;
  int index_;
};


379 380 381
static const int kInternalFieldsInWeakCallback = 2;


382
template <typename T>
383
class WeakCallbackInfo {
384
 public:
385
  typedef void (*Callback)(const WeakCallbackInfo<T>& data);
386

dcarney's avatar
dcarney committed
387 388 389 390 391 392 393
  WeakCallbackInfo(Isolate* isolate, T* parameter,
                   void* internal_fields[kInternalFieldsInWeakCallback],
                   Callback* callback)
      : isolate_(isolate), parameter_(parameter), callback_(callback) {
    for (int i = 0; i < kInternalFieldsInWeakCallback; ++i) {
      internal_fields_[i] = internal_fields[i];
    }
394
  }
395

396 397
  V8_INLINE Isolate* GetIsolate() const { return isolate_; }
  V8_INLINE T* GetParameter() const { return parameter_; }
398 399
  V8_INLINE void* GetInternalField(int index) const;

400 401
  V8_INLINE V8_DEPRECATED("use indexed version",
                          void* GetInternalField1() const) {
402 403
    return internal_fields_[0];
  }
404 405
  V8_INLINE V8_DEPRECATED("use indexed version",
                          void* GetInternalField2() const) {
406 407
    return internal_fields_[1];
  }
408

409 410 411 412
  V8_DEPRECATED("Not realiable once SetSecondPassCallback() was used.",
                bool IsFirstPass() const) {
    return callback_ != nullptr;
  }
dcarney's avatar
dcarney committed
413 414 415 416 417 418 419 420 421

  // When first called, the embedder MUST Reset() the Global which triggered the
  // callback. The Global itself is unusable for anything else. No v8 other api
  // calls may be called in the first callback. Should additional work be
  // required, the embedder must set a second pass callback, which will be
  // called after all the initial callbacks are processed.
  // Calling SetSecondPassCallback on the second pass will immediately crash.
  void SetSecondPassCallback(Callback callback) const { *callback_ = callback; }

422
 private:
423 424
  Isolate* isolate_;
  T* parameter_;
dcarney's avatar
dcarney committed
425 426
  Callback* callback_;
  void* internal_fields_[kInternalFieldsInWeakCallback];
427 428 429
};


430 431 432 433 434 435
// kParameter will pass a void* parameter back to the callback, kInternalFields
// will pass the first two internal fields back to the callback, kFinalizer
// will pass a void* parameter back, but is invoked before the object is
// actually collected, so it can be resurrected. In the last case, it is not
// possible to request a second pass callback.
enum class WeakCallbackType { kParameter, kInternalFields, kFinalizer };
436

437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
/**
 * An object reference that is independent of any handle scope.  Where
 * a Local handle only lives as long as the HandleScope in which it was
 * allocated, a PersistentBase handle remains valid until it is explicitly
 * disposed.
 *
 * A persistent handle contains a reference to a storage cell within
 * the v8 engine which holds an object value and which is updated by
 * the garbage collector whenever the object is moved.  A new storage
 * cell can be created using the constructor or PersistentBase::Reset and
 * existing handles can be disposed using PersistentBase::Reset.
 *
 */
template <class T> class PersistentBase {
 public:
  /**
   * If non-empty, destroy the underlying storage cell
   * IsEmpty() will return true after this call.
   */
  V8_INLINE void Reset();
  /**
   * If non-empty, destroy the underlying storage cell
   * and create a new one with the contents of other if other is non empty
   */
  template <class S>
462
  V8_INLINE void Reset(Isolate* isolate, const Local<S>& other);
463 464 465 466 467 468 469 470

  /**
   * If non-empty, destroy the underlying storage cell
   * and create a new one with the contents of other if other is non empty
   */
  template <class S>
  V8_INLINE void Reset(Isolate* isolate, const PersistentBase<S>& other);

471 472
  V8_INLINE bool IsEmpty() const { return val_ == NULL; }
  V8_INLINE void Empty() { val_ = 0; }
473

474 475 476 477
  V8_INLINE Local<T> Get(Isolate* isolate) const {
    return Local<T>::New(isolate, *this);
  }

478 479 480 481
  template <class S>
  V8_INLINE bool operator==(const PersistentBase<S>& that) const {
    internal::Object** a = reinterpret_cast<internal::Object**>(this->val_);
    internal::Object** b = reinterpret_cast<internal::Object**>(that.val_);
482 483
    if (a == NULL) return b == NULL;
    if (b == NULL) return false;
484 485 486
    return *a == *b;
  }

487 488
  template <class S>
  V8_INLINE bool operator==(const Local<S>& that) const {
489 490
    internal::Object** a = reinterpret_cast<internal::Object**>(this->val_);
    internal::Object** b = reinterpret_cast<internal::Object**>(that.val_);
491 492
    if (a == NULL) return b == NULL;
    if (b == NULL) return false;
493 494 495 496 497 498 499 500
    return *a == *b;
  }

  template <class S>
  V8_INLINE bool operator!=(const PersistentBase<S>& that) const {
    return !operator==(that);
  }

501 502
  template <class S>
  V8_INLINE bool operator!=(const Local<S>& that) const {
503 504 505
    return !operator==(that);
  }

506 507 508 509 510 511 512
  /**
   *  Install a finalization callback on this object.
   *  NOTE: There is no guarantee as to *when* or even *if* the callback is
   *  invoked. The invocation is performed solely on a best effort basis.
   *  As always, GC-based finalization should *not* be relied upon for any
   *  critical form of resource management!
   */
513 514 515 516
  template <typename P>
  V8_INLINE void SetWeak(P* parameter,
                         typename WeakCallbackInfo<P>::Callback callback,
                         WeakCallbackType type);
517

518 519 520 521 522 523 524 525 526
  /**
   * Turns this handle into a weak phantom handle without finalization callback.
   * The handle will be reset automatically when the garbage collector detects
   * that the object is no longer reachable.
   * A related function Isolate::NumberOfPhantomHandleResetsSinceLastCall
   * returns how many phantom handles were reset by the garbage collector.
   */
  V8_INLINE void SetWeak();

527 528 529 530 531
  template<typename P>
  V8_INLINE P* ClearWeak();

  // TODO(dcarney): remove this.
  V8_INLINE void ClearWeak() { ClearWeak<void>(); }
532

hlopko's avatar
hlopko committed
533 534 535 536 537
  /**
   * Allows the embedder to tell the v8 garbage collector that a certain object
   * is alive. Only allowed when the embedder is asked to trace its heap by
   * EmbedderHeapTracer.
   */
538
  V8_INLINE void RegisterExternalReference(Isolate* isolate) const;
hlopko's avatar
hlopko committed
539

540 541 542 543 544 545 546 547
  /**
   * Marks the reference to this object independent. Garbage collector is free
   * to ignore any object groups containing this object. Weak callback for an
   * independent handle should not assume that it will be preceded by a global
   * GC prologue callback or followed by a global GC epilogue callback.
   */
  V8_INLINE void MarkIndependent();

548 549 550 551 552 553 554
  /**
   * Marks the reference to this object as active. The scavenge garbage
   * collection should not reclaim the objects marked as active.
   * This bit is cleared after the each garbage collection pass.
   */
  V8_INLINE void MarkActive();

555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
  V8_INLINE bool IsIndependent() const;

  /** Checks if the handle holds the only reference to an object. */
  V8_INLINE bool IsNearDeath() const;

  /** Returns true if the handle's reference is weak.  */
  V8_INLINE bool IsWeak() const;

  /**
   * Assigns a wrapper class ID to the handle. See RetainedObjectInfo interface
   * description in v8-profiler.h for details.
   */
  V8_INLINE void SetWrapperClassId(uint16_t class_id);

  /**
   * Returns the class ID previously assigned to this handle or 0 if no class ID
   * was previously assigned.
   */
  V8_INLINE uint16_t WrapperClassId() const;

575 576 577
  PersistentBase(const PersistentBase& other) = delete;  // NOLINT
  void operator=(const PersistentBase&) = delete;

578 579 580 581 582
 private:
  friend class Isolate;
  friend class Utils;
  template<class F> friend class Local;
  template<class F1, class F2> friend class Persistent;
583 584
  template <class F>
  friend class Global;
585 586
  template<class F> friend class PersistentBase;
  template<class F> friend class ReturnValue;
587 588
  template <class F1, class F2, class F3>
  friend class PersistentValueMapBase;
589
  template<class F1, class F2> friend class PersistentValueVector;
590
  friend class Object;
591 592 593 594 595 596 597 598

  explicit V8_INLINE PersistentBase(T* val) : val_(val) {}
  V8_INLINE static T* New(Isolate* isolate, T* that);

  T* val_;
};


599 600 601 602 603 604 605 606 607 608 609 610
/**
 * Default traits for Persistent. This class does not allow
 * use of the copy constructor or assignment operator.
 * At present kResetInDestructor is not set, but that will change in a future
 * version.
 */
template<class T>
class NonCopyablePersistentTraits {
 public:
  typedef Persistent<T, NonCopyablePersistentTraits<T> > NonCopyablePersistent;
  static const bool kResetInDestructor = false;
  template<class S, class M>
611 612
  V8_INLINE static void Copy(const Persistent<S, M>& source,
                             NonCopyablePersistent* dest) {
613 614 615
    Uncompilable<Object>();
  }
  // TODO(dcarney): come up with a good compile error here.
616
  template<class O> V8_INLINE static void Uncompilable() {
617 618 619 620 621
    TYPE_CHECK(O, Primitive);
  }
};


622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
/**
 * Helper class traits to allow copying and assignment of Persistent.
 * This will clone the contents of storage cell, but not any of the flags, etc.
 */
template<class T>
struct CopyablePersistentTraits {
  typedef Persistent<T, CopyablePersistentTraits<T> > CopyablePersistent;
  static const bool kResetInDestructor = true;
  template<class S, class M>
  static V8_INLINE void Copy(const Persistent<S, M>& source,
                             CopyablePersistent* dest) {
    // do nothing, just allow copy
  }
};


638
/**
639
 * A PersistentBase which allows copy and assignment.
640
 *
641
 * Copy, assignment and destructor behavior is controlled by the traits
642
 * class M.
643 644
 *
 * Note: Persistent class hierarchy is subject to future changes.
645
 */
646
template <class T, class M> class Persistent : public PersistentBase<T> {
647
 public:
648 649 650
  /**
   * A Persistent with no storage cell.
   */
651
  V8_INLINE Persistent() : PersistentBase<T>(0) { }
652
  /**
653 654
   * Construct a Persistent from a Local.
   * When the Local is non-empty, a new storage cell is created
655
   * pointing to the same object, and no flags are set.
656
   */
657 658
  template <class S>
  V8_INLINE Persistent(Isolate* isolate, Local<S> that)
659
      : PersistentBase<T>(PersistentBase<T>::New(isolate, *that)) {
660 661
    TYPE_CHECK(T, S);
  }
662
  /**
663 664 665
   * Construct a Persistent from a Persistent.
   * When the Persistent is non-empty, a new storage cell is created
   * pointing to the same object, and no flags are set.
666
   */
667
  template <class S, class M2>
668
  V8_INLINE Persistent(Isolate* isolate, const Persistent<S, M2>& that)
669
    : PersistentBase<T>(PersistentBase<T>::New(isolate, *that)) {
670 671
    TYPE_CHECK(T, S);
  }
672
  /**
673 674 675 676
   * The copy constructors and assignment operator create a Persistent
   * exactly as the Persistent constructor, but the Copy function from the
   * traits class is called, allowing the setting of flags based on the
   * copied Persistent.
677
   */
678
  V8_INLINE Persistent(const Persistent& that) : PersistentBase<T>(0) {
679 680 681
    Copy(that);
  }
  template <class S, class M2>
682
  V8_INLINE Persistent(const Persistent<S, M2>& that) : PersistentBase<T>(0) {
683 684
    Copy(that);
  }
685
  V8_INLINE Persistent& operator=(const Persistent& that) { // NOLINT
686 687 688 689
    Copy(that);
    return *this;
  }
  template <class S, class M2>
690
  V8_INLINE Persistent& operator=(const Persistent<S, M2>& that) { // NOLINT
691 692
    Copy(that);
    return *this;
693
  }
694 695 696 697 698
  /**
   * The destructor will dispose the Persistent based on the
   * kResetInDestructor flags in the traits class.  Since not calling dispose
   * can result in a memory leak, it is recommended to always set this flag.
   */
699
  V8_INLINE ~Persistent() {
700
    if (M::kResetInDestructor) this->Reset();
701
  }
702

703
  // TODO(dcarney): this is pretty useless, fix or remove
704
  template <class S>
705
  V8_INLINE static Persistent<T>& Cast(const Persistent<S>& that) {  // NOLINT
706 707 708 709 710
#ifdef V8_ENABLE_CHECKS
    // If we're going to perform the type check then we have to check
    // that the handle isn't empty before doing the checked cast.
    if (!that.IsEmpty()) T::Cast(*that);
#endif
711
    return reinterpret_cast<Persistent<T>&>(const_cast<Persistent<S>&>(that));
712 713
  }

714
  // TODO(dcarney): this is pretty useless, fix or remove
715 716
  template <class S>
  V8_INLINE Persistent<S>& As() const {  // NOLINT
717 718 719
    return Persistent<S>::Cast(*this);
  }

720
 private:
721
  friend class Isolate;
722
  friend class Utils;
723
  template<class F> friend class Local;
724
  template<class F1, class F2> friend class Persistent;
725
  template<class F> friend class ReturnValue;
726

xaxxon's avatar
xaxxon committed
727
  explicit V8_INLINE Persistent(T* that) : PersistentBase<T>(that) {}
728
  V8_INLINE T* operator*() const { return this->val_; }
729
  template<class S, class M2>
730
  V8_INLINE void Copy(const Persistent<S, M2>& that);
731
};
732

733 734 735 736 737 738

/**
 * A PersistentBase which has move semantics.
 *
 * Note: Persistent class hierarchy is subject to future changes.
 */
739 740
template <class T>
class Global : public PersistentBase<T> {
741
 public:
742
  /**
743
   * A Global with no storage cell.
744
   */
745
  V8_INLINE Global() : PersistentBase<T>(nullptr) {}
746
  /**
747 748
   * Construct a Global from a Local.
   * When the Local is non-empty, a new storage cell is created
749 750 751
   * pointing to the same object, and no flags are set.
   */
  template <class S>
752
  V8_INLINE Global(Isolate* isolate, Local<S> that)
753 754 755 756
      : PersistentBase<T>(PersistentBase<T>::New(isolate, *that)) {
    TYPE_CHECK(T, S);
  }
  /**
757
   * Construct a Global from a PersistentBase.
758 759 760 761
   * When the Persistent is non-empty, a new storage cell is created
   * pointing to the same object, and no flags are set.
   */
  template <class S>
762 763
  V8_INLINE Global(Isolate* isolate, const PersistentBase<S>& that)
      : PersistentBase<T>(PersistentBase<T>::New(isolate, that.val_)) {
764 765 766 767 768
    TYPE_CHECK(T, S);
  }
  /**
   * Move constructor.
   */
769
  V8_INLINE Global(Global&& other) : PersistentBase<T>(other.val_) {  // NOLINT
770
    other.val_ = nullptr;
771
  }
772
  V8_INLINE ~Global() { this->Reset(); }
773 774 775
  /**
   * Move via assignment.
   */
776
  template <class S>
777
  V8_INLINE Global& operator=(Global<S>&& rhs) {  // NOLINT
778
    TYPE_CHECK(T, S);
779 780 781 782 783
    if (this != &rhs) {
      this->Reset();
      this->val_ = rhs.val_;
      rhs.val_ = nullptr;
    }
784 785 786 787 788
    return *this;
  }
  /**
   * Pass allows returning uniques from functions, etc.
   */
789
  Global Pass() { return static_cast<Global&&>(*this); }  // NOLINT
790

791 792 793 794 795
  /*
   * For compatibility with Chromium's base::Bind (base::Passed).
   */
  typedef void MoveOnlyTypeForCPP03;

796 797 798
  Global(const Global&) = delete;
  void operator=(const Global&) = delete;

799
 private:
800 801 802
  template <class F>
  friend class ReturnValue;
  V8_INLINE T* operator*() const { return this->val_; }
803 804
};

805

806 807 808 809 810
// UniquePersistent is an alias for Global for historical reason.
template <class T>
using UniquePersistent = Global<T>;


811
 /**
812 813 814 815 816
 * A stack-allocated class that governs a number of local handles.
 * After a handle scope has been created, all local handles will be
 * allocated within that handle scope until either the handle scope is
 * deleted or another handle scope is created.  If there is already a
 * handle scope and a new one is created, all allocations will take
817
 * place in the new handle scope until it is deleted.  After that,
818 819 820 821 822 823 824
 * new handles will again be allocated in the original handle scope.
 *
 * After the handle scope of a local handle has been deleted the
 * garbage collector will no longer track the object stored in the
 * handle and may deallocate it.  The behavior of accessing a handle
 * for which the handle scope has been deleted is undefined.
 */
825
class V8_EXPORT HandleScope {
826
 public:
827
  explicit HandleScope(Isolate* isolate);
828

829
  ~HandleScope();
830 831 832 833

  /**
   * Counts the number of allocated handles.
   */
834
  static int NumberOfHandles(Isolate* isolate);
835

836 837 838 839
  V8_INLINE Isolate* GetIsolate() const {
    return reinterpret_cast<Isolate*>(isolate_);
  }

840 841
  HandleScope(const HandleScope&) = delete;
  void operator=(const HandleScope&) = delete;
842 843
  void* operator new(size_t size);
  void operator delete(void*, size_t);
844

845 846 847 848 849
 protected:
  V8_INLINE HandleScope() {}

  void Initialize(Isolate* isolate);

850 851
  static internal::Object** CreateHandle(internal::Isolate* isolate,
                                         internal::Object* value);
852 853 854

 private:
  // Uses heap_object to obtain the current Isolate.
855 856
  static internal::Object** CreateHandle(internal::HeapObject* heap_object,
                                         internal::Object* value);
857

858
  internal::Isolate* isolate_;
859 860
  internal::Object** prev_next_;
  internal::Object** prev_limit_;
861

862
  // Local::New uses CreateHandle with an Isolate* parameter.
863
  template<class F> friend class Local;
864 865 866

  // Object::GetInternalField and Context::GetEmbedderData use CreateHandle with
  // a HeapObject* in their shortcuts.
867 868
  friend class Object;
  friend class Context;
869 870 871 872 873 874 875 876 877
};


/**
 * A HandleScope which first allocates a handle in the current scope
 * which will be later filled with the escape value.
 */
class V8_EXPORT EscapableHandleScope : public HandleScope {
 public:
878
  explicit EscapableHandleScope(Isolate* isolate);
879 880 881 882 883 884 885 886 887 888 889 890 891
  V8_INLINE ~EscapableHandleScope() {}

  /**
   * Pushes the value into the previous scope and returns a handle to it.
   * Cannot be called twice.
   */
  template <class T>
  V8_INLINE Local<T> Escape(Local<T> value) {
    internal::Object** slot =
        Escape(reinterpret_cast<internal::Object**>(*value));
    return Local<T>(reinterpret_cast<T*>(slot));
  }

892 893
  EscapableHandleScope(const EscapableHandleScope&) = delete;
  void operator=(const EscapableHandleScope&) = delete;
894 895
  void* operator new(size_t size);
  void operator delete(void*, size_t);
896

897 898 899
 private:
  internal::Object** Escape(internal::Object** escape_value);
  internal::Object** escape_slot_;
900 901
};

fedor's avatar
fedor committed
902 903 904 905 906
class V8_EXPORT SealHandleScope {
 public:
  SealHandleScope(Isolate* isolate);
  ~SealHandleScope();

907 908
  SealHandleScope(const SealHandleScope&) = delete;
  void operator=(const SealHandleScope&) = delete;
909 910
  void* operator new(size_t size);
  void operator delete(void*, size_t);
911

fedor's avatar
fedor committed
912
 private:
913
  internal::Isolate* const isolate_;
fedor's avatar
fedor committed
914
  internal::Object** prev_limit_;
915
  int prev_sealed_level_;
fedor's avatar
fedor committed
916 917
};

918

919
// --- Special objects ---
920 921 922 923 924


/**
 * The superclass of values and API object templates.
 */
925
class V8_EXPORT Data {
926 927 928 929 930
 private:
  Data();
};


931 932 933 934 935
/**
 * The optional attributes of ScriptOrigin.
 */
class ScriptOriginOptions {
 public:
936
  V8_INLINE ScriptOriginOptions(bool is_shared_cross_origin = false,
937 938
                                bool is_opaque = false, bool is_wasm = false,
                                bool is_module = false)
939
      : flags_((is_shared_cross_origin ? kIsSharedCrossOrigin : 0) |
940 941
               (is_wasm ? kIsWasm : 0) | (is_opaque ? kIsOpaque : 0) |
               (is_module ? kIsModule : 0)) {}
942
  V8_INLINE ScriptOriginOptions(int flags)
943 944 945
      : flags_(flags &
               (kIsSharedCrossOrigin | kIsOpaque | kIsWasm | kIsModule)) {}

946 947 948 949
  bool IsSharedCrossOrigin() const {
    return (flags_ & kIsSharedCrossOrigin) != 0;
  }
  bool IsOpaque() const { return (flags_ & kIsOpaque) != 0; }
950
  bool IsWasm() const { return (flags_ & kIsWasm) != 0; }
951 952
  bool IsModule() const { return (flags_ & kIsModule) != 0; }

953 954 955
  int Flags() const { return flags_; }

 private:
956 957 958 959 960 961
  enum {
    kIsSharedCrossOrigin = 1,
    kIsOpaque = 1 << 1,
    kIsWasm = 1 << 2,
    kIsModule = 1 << 3
  };
962 963 964
  const int flags_;
};

965 966 967
/**
 * The origin, within a file, of a script.
 */
968
class ScriptOrigin {
969
 public:
970
  V8_INLINE ScriptOrigin(
971 972 973 974 975 976
      Local<Value> resource_name,
      Local<Integer> resource_line_offset = Local<Integer>(),
      Local<Integer> resource_column_offset = Local<Integer>(),
      Local<Boolean> resource_is_shared_cross_origin = Local<Boolean>(),
      Local<Integer> script_id = Local<Integer>(),
      Local<Value> source_map_url = Local<Value>(),
977
      Local<Boolean> resource_is_opaque = Local<Boolean>(),
978 979
      Local<Boolean> is_wasm = Local<Boolean>(),
      Local<Boolean> is_module = Local<Boolean>());
980

981 982 983
  V8_INLINE Local<Value> ResourceName() const;
  V8_INLINE Local<Integer> ResourceLineOffset() const;
  V8_INLINE Local<Integer> ResourceColumnOffset() const;
984 985 986
  /**
    * Returns true for embedder's debugger scripts
    */
987 988
  V8_INLINE Local<Integer> ScriptID() const;
  V8_INLINE Local<Value> SourceMapUrl() const;
989
  V8_INLINE ScriptOriginOptions Options() const { return options_; }
990

991
 private:
992 993 994
  Local<Value> resource_name_;
  Local<Integer> resource_line_offset_;
  Local<Integer> resource_column_offset_;
995
  ScriptOriginOptions options_;
996 997
  Local<Integer> script_id_;
  Local<Value> source_map_url_;
998 999 1000 1001
};


/**
1002
 * A compiled JavaScript script, not yet tied to a Context.
1003
 */
1004
class V8_EXPORT UnboundScript {
1005
 public:
1006
  /**
1007
   * Binds the script to the currently entered context.
1008
   */
1009 1010 1011
  Local<Script> BindToCurrentContext();

  int GetId();
1012
  Local<Value> GetScriptName();
1013

1014 1015 1016
  /**
   * Data read from magic sourceURL comments.
   */
1017
  Local<Value> GetSourceURL();
1018 1019 1020
  /**
   * Data read from magic sourceMappingURL comments.
   */
1021
  Local<Value> GetSourceMappingURL();
1022

1023
  /**
1024 1025
   * Returns zero based line number of the code_pos location in the script.
   * -1 will be returned if no information available.
1026
   */
1027
  int GetLineNumber(int code_pos);
1028

1029 1030 1031
  static const int kNoScriptId = 0;
};

1032 1033 1034 1035 1036 1037 1038 1039
/**
 * This is an unfinished experimental feature, and is only exposed
 * here for internal testing purposes. DO NOT USE.
 *
 * A compiled JavaScript module.
 */
class V8_EXPORT Module {
 public:
1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
  /**
   * Returns the number of modules requested by this module.
   */
  int GetModuleRequestsLength() const;

  /**
   * Returns the ith module specifier in this module.
   * i must be < GetModuleRequestsLength() and >= 0.
   */
  Local<String> GetModuleRequest(int i) const;

1051 1052 1053 1054
  /**
   * Returns the identity hash for this object.
   */
  int GetIdentityHash() const;
1055

1056 1057
  typedef MaybeLocal<Module> (*ResolveCallback)(Local<Context> context,
                                                Local<String> specifier,
1058
                                                Local<Module> referrer);
1059

1060 1061 1062 1063 1064
  /**
   * ModuleDeclarationInstantiation
   *
   * Returns false if an exception occurred during instantiation.
   */
1065 1066
  V8_WARN_UNUSED_RESULT bool Instantiate(Local<Context> context,
                                         ResolveCallback callback);
1067 1068 1069

  /**
   * ModuleEvaluation
1070 1071
   *
   * Returns the completion value.
1072 1073 1074
   */
  V8_WARN_UNUSED_RESULT MaybeLocal<Value> Evaluate(Local<Context> context);
};
1075 1076 1077 1078 1079 1080 1081

/**
 * A compiled JavaScript script, tied to a Context which was active when the
 * script was compiled.
 */
class V8_EXPORT Script {
 public:
1082
  /**
1083
   * A shorthand for ScriptCompiler::Compile().
1084
   */
1085 1086
  static V8_DEPRECATE_SOON(
      "Use maybe version",
1087
      Local<Script> Compile(Local<String> source,
1088
                            ScriptOrigin* origin = nullptr));
1089
  static V8_WARN_UNUSED_RESULT MaybeLocal<Script> Compile(
1090
      Local<Context> context, Local<String> source,
1091
      ScriptOrigin* origin = nullptr);
1092

1093
  static Local<Script> V8_DEPRECATE_SOON("Use maybe version",
1094 1095
                                         Compile(Local<String> source,
                                                 Local<String> file_name));
1096 1097

  /**
1098 1099
   * Runs the script returning the resulting value. It will be run in the
   * context in which it was created (ScriptCompiler::CompileBound or
1100
   * UnboundScript::BindToCurrentContext()).
1101
   */
1102
  V8_DEPRECATE_SOON("Use maybe version", Local<Value> Run());
1103
  V8_WARN_UNUSED_RESULT MaybeLocal<Value> Run(Local<Context> context);
1104 1105

  /**
1106
   * Returns the corresponding context-unbound script.
1107
   */
1108 1109
  Local<UnboundScript> GetUnboundScript();
};
1110

1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124

/**
 * For compiling scripts.
 */
class V8_EXPORT ScriptCompiler {
 public:
  /**
   * Compilation data that the embedder can cache and pass back to speed up
   * future compilations. The data is produced if the CompilerOptions passed to
   * the compilation functions in ScriptCompiler contains produce_data_to_cache
   * = true. The data to cache can then can be retrieved from
   * UnboundScript.
   */
  struct V8_EXPORT CachedData {
1125 1126 1127 1128 1129
    enum BufferPolicy {
      BufferNotOwned,
      BufferOwned
    };

1130 1131 1132 1133 1134
    CachedData()
        : data(NULL),
          length(0),
          rejected(false),
          buffer_policy(BufferNotOwned) {}
1135 1136 1137 1138 1139 1140 1141 1142

    // If buffer_policy is BufferNotOwned, the caller keeps the ownership of
    // data and guarantees that it stays alive until the CachedData object is
    // destroyed. If the policy is BufferOwned, the given data will be deleted
    // (with delete[]) when the CachedData object is destroyed.
    CachedData(const uint8_t* data, int length,
               BufferPolicy buffer_policy = BufferNotOwned);
    ~CachedData();
1143 1144 1145 1146
    // TODO(marja): Async compilation; add constructors which take a callback
    // which will be called when V8 no longer needs the data.
    const uint8_t* data;
    int length;
1147
    bool rejected;
1148 1149
    BufferPolicy buffer_policy;

1150 1151 1152
    // Prevent copying.
    CachedData(const CachedData&) = delete;
    CachedData& operator=(const CachedData&) = delete;
1153 1154 1155
  };

  /**
1156
   * Source code which can be then compiled to a UnboundScript or Script.
1157
   */
1158
  class Source {
1159 1160
   public:
    // Source takes ownership of CachedData.
1161
    V8_INLINE Source(Local<String> source_string, const ScriptOrigin& origin,
1162
           CachedData* cached_data = NULL);
1163 1164 1165
    V8_INLINE Source(Local<String> source_string,
                     CachedData* cached_data = NULL);
    V8_INLINE ~Source();
1166 1167 1168 1169

    // Ownership of the CachedData or its buffers is *not* transferred to the
    // caller. The CachedData object is alive as long as the Source object is
    // alive.
1170
    V8_INLINE const CachedData* GetCachedData() const;
1171

1172 1173
    V8_INLINE const ScriptOriginOptions& GetResourceOptions() const;

1174 1175 1176 1177
    // Prevent copying.
    Source(const Source&) = delete;
    Source& operator=(const Source&) = delete;

1178 1179
   private:
    friend class ScriptCompiler;
1180 1181 1182 1183

    Local<String> source_string;

    // Origin information
1184 1185 1186
    Local<Value> resource_name;
    Local<Integer> resource_line_offset;
    Local<Integer> resource_column_offset;
1187
    ScriptOriginOptions resource_options;
1188
    Local<Value> source_map_url;
1189

1190 1191 1192
    // Cached data from previous compilation (if a kConsume*Cache flag is
    // set), or hold newly generated cache data (kProduce*Cache flags) are
    // set when calling a compile method.
1193
    CachedData* cached_data;
1194 1195
  };

1196 1197 1198 1199
  /**
   * For streaming incomplete script data to V8. The embedder should implement a
   * subclass of this class.
   */
1200
  class V8_EXPORT ExternalSourceStream {
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
   public:
    virtual ~ExternalSourceStream() {}

    /**
     * V8 calls this to request the next chunk of data from the embedder. This
     * function will be called on a background thread, so it's OK to block and
     * wait for the data, if the embedder doesn't have data yet. Returns the
     * length of the data returned. When the data ends, GetMoreData should
     * return 0. Caller takes ownership of the data.
     *
     * When streaming UTF-8 data, V8 handles multi-byte characters split between
     * two data chunks, but doesn't handle multi-byte characters split between
     * more than two data chunks. The embedder can avoid this problem by always
     * returning at least 2 bytes of data.
     *
     * If the embedder wants to cancel the streaming, they should make the next
     * GetMoreData call return 0. V8 will interpret it as end of data (and most
     * probably, parsing will fail). The streaming task will return as soon as
     * V8 has parsed the data it received so far.
     */
    virtual size_t GetMoreData(const uint8_t** src) = 0;
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238

    /**
     * V8 calls this method to set a 'bookmark' at the current position in
     * the source stream, for the purpose of (maybe) later calling
     * ResetToBookmark. If ResetToBookmark is called later, then subsequent
     * calls to GetMoreData should return the same data as they did when
     * SetBookmark was called earlier.
     *
     * The embedder may return 'false' to indicate it cannot provide this
     * functionality.
     */
    virtual bool SetBookmark();

    /**
     * V8 calls this to return to a previously set bookmark.
     */
    virtual void ResetToBookmark();
1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261
  };


  /**
   * Source code which can be streamed into V8 in pieces. It will be parsed
   * while streaming. It can be compiled after the streaming is complete.
   * StreamedSource must be kept alive while the streaming task is ran (see
   * ScriptStreamingTask below).
   */
  class V8_EXPORT StreamedSource {
   public:
    enum Encoding { ONE_BYTE, TWO_BYTE, UTF8 };

    StreamedSource(ExternalSourceStream* source_stream, Encoding encoding);
    ~StreamedSource();

    // Ownership of the CachedData or its buffers is *not* transferred to the
    // caller. The CachedData object is alive as long as the StreamedSource
    // object is alive.
    const CachedData* GetCachedData() const;

    internal::StreamedSource* impl() const { return impl_; }

1262 1263 1264
    // Prevent copying.
    StreamedSource(const StreamedSource&) = delete;
    StreamedSource& operator=(const StreamedSource&) = delete;
1265

1266
   private:
1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279
    internal::StreamedSource* impl_;
  };

  /**
   * A streaming task which the embedder must run on a background thread to
   * stream scripts into V8. Returned by ScriptCompiler::StartStreamingScript.
   */
  class ScriptStreamingTask {
   public:
    virtual ~ScriptStreamingTask() {}
    virtual void Run() = 0;
  };

1280
  enum CompileOptions {
1281 1282 1283 1284
    kNoCompileOptions = 0,
    kProduceParserCache,
    kConsumeParserCache,
    kProduceCodeCache,
1285
    kConsumeCodeCache
1286 1287 1288 1289
  };

  /**
   * Compiles the specified script (context-independent).
1290 1291 1292 1293 1294 1295
   * Cached data as part of the source object can be optionally produced to be
   * consumed later to speed up compilation of identical source scripts.
   *
   * Note that when producing cached data, the source must point to NULL for
   * cached data. When consuming cached data, the cached data must have been
   * produced by the same version of V8.
1296 1297 1298 1299 1300
   *
   * \param source Script source code.
   * \return Compiled script object (context independent; for running it must be
   *   bound to a context).
   */
1301 1302 1303 1304
  static V8_DEPRECATED("Use maybe version",
                       Local<UnboundScript> CompileUnbound(
                           Isolate* isolate, Source* source,
                           CompileOptions options = kNoCompileOptions));
1305
  static V8_WARN_UNUSED_RESULT MaybeLocal<UnboundScript> CompileUnboundScript(
1306 1307
      Isolate* isolate, Source* source,
      CompileOptions options = kNoCompileOptions);
1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319

  /**
   * Compiles the specified script (bound to current context).
   *
   * \param source Script source code.
   * \param pre_data Pre-parsing data, as obtained by ScriptData::PreCompile()
   *   using pre_data speeds compilation if it's done multiple times.
   *   Owned by caller, no references are kept when this function returns.
   * \return Compiled script object, bound to the context that was active
   *   when this function was called. When run it will always use this
   *   context.
   */
1320
  static V8_DEPRECATED(
1321 1322 1323
      "Use maybe version",
      Local<Script> Compile(Isolate* isolate, Source* source,
                            CompileOptions options = kNoCompileOptions));
1324 1325 1326
  static V8_WARN_UNUSED_RESULT MaybeLocal<Script> Compile(
      Local<Context> context, Source* source,
      CompileOptions options = kNoCompileOptions);
1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349

  /**
   * Returns a task which streams script data into V8, or NULL if the script
   * cannot be streamed. The user is responsible for running the task on a
   * background thread and deleting it. When ran, the task starts parsing the
   * script, and it will request data from the StreamedSource as needed. When
   * ScriptStreamingTask::Run exits, all data has been streamed and the script
   * can be compiled (see Compile below).
   *
   * This API allows to start the streaming with as little data as possible, and
   * the remaining data (for example, the ScriptOrigin) is passed to Compile.
   */
  static ScriptStreamingTask* StartStreamingScript(
      Isolate* isolate, StreamedSource* source,
      CompileOptions options = kNoCompileOptions);

  /**
   * Compiles a streamed script (bound to current context).
   *
   * This can only be called after the streaming has finished
   * (ScriptStreamingTask has been run). V8 doesn't construct the source string
   * during streaming, so the embedder needs to pass the full source here.
   */
1350 1351 1352 1353 1354
  static V8_DEPRECATED("Use maybe version",
                       Local<Script> Compile(Isolate* isolate,
                                             StreamedSource* source,
                                             Local<String> full_source_string,
                                             const ScriptOrigin& origin));
1355 1356
  static V8_WARN_UNUSED_RESULT MaybeLocal<Script> Compile(
      Local<Context> context, StreamedSource* source,
1357
      Local<String> full_source_string, const ScriptOrigin& origin);
1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377

  /**
   * Return a version tag for CachedData for the current V8 version & flags.
   *
   * This value is meant only for determining whether a previously generated
   * CachedData instance is still valid; the tag has no other meaing.
   *
   * Background: The data carried by CachedData may depend on the exact
   *   V8 version number or currently compiler flags. This means when
   *   persisting CachedData, the embedder must take care to not pass in
   *   data from another V8 version, or the same version with different
   *   features enabled.
   *
   *   The easiest way to do so is to clear the embedder's cache on any
   *   such change.
   *
   *   Alternatively, this tag can be stored alongside the cached data and
   *   compared when it is being used.
   */
  static uint32_t CachedDataVersionTag();
1378 1379

  /**
1380
   * This is an unfinished experimental feature, and is only exposed
1381
   * here for internal testing purposes. DO NOT USE.
1382
   *
1383 1384 1385 1386 1387
   * Compile an ES module, returning a Module that encapsulates
   * the compiled code.
   *
   * Corresponds to the ParseModule abstract operation in the
   * ECMAScript specification.
1388
   */
1389 1390
  static V8_WARN_UNUSED_RESULT MaybeLocal<Module> CompileModule(
      Isolate* isolate, Source* source);
1391

1392 1393 1394 1395
  /**
   * Compile a function for a given context. This is equivalent to running
   *
   * with (obj) {
1396
   *   return function(args) { ... }
1397 1398 1399 1400 1401
   * }
   *
   * It is possible to specify multiple context extensions (obj in the above
   * example).
   */
1402 1403 1404 1405 1406 1407 1408
  static V8_DEPRECATE_SOON("Use maybe version",
                           Local<Function> CompileFunctionInContext(
                               Isolate* isolate, Source* source,
                               Local<Context> context, size_t arguments_count,
                               Local<String> arguments[],
                               size_t context_extension_count,
                               Local<Object> context_extensions[]));
1409
  static V8_WARN_UNUSED_RESULT MaybeLocal<Function> CompileFunctionInContext(
1410 1411 1412
      Local<Context> context, Source* source, size_t arguments_count,
      Local<String> arguments[], size_t context_extension_count,
      Local<Object> context_extensions[]);
1413

1414
 private:
1415
  static V8_WARN_UNUSED_RESULT MaybeLocal<UnboundScript> CompileUnboundInternal(
1416
      Isolate* isolate, Source* source, CompileOptions options);
1417 1418 1419 1420 1421 1422
};


/**
 * An error message.
 */
1423
class V8_EXPORT Message {
1424
 public:
1425
  Local<String> Get() const;
dcarney's avatar
dcarney committed
1426

1427
  V8_DEPRECATE_SOON("Use maybe version", Local<String> GetSourceLine() const);
1428 1429
  V8_WARN_UNUSED_RESULT MaybeLocal<String> GetSourceLine(
      Local<Context> context) const;
1430

1431 1432 1433 1434 1435 1436
  /**
   * Returns the origin for the script from where the function causing the
   * error originates.
   */
  ScriptOrigin GetScriptOrigin() const;

1437 1438 1439 1440
  /**
   * Returns the resource name for the script from where the function causing
   * the error originates.
   */
1441
  Local<Value> GetScriptResourceName() const;
1442

1443 1444 1445 1446 1447
  /**
   * Exception stack trace. By default stack traces are not captured for
   * uncaught exceptions. SetCaptureStackTraceForUncaughtExceptions allows
   * to change this option.
   */
1448
  Local<StackTrace> GetStackTrace() const;
1449

1450 1451 1452
  /**
   * Returns the number, 1-based, of the line where the error occurred.
   */
1453
  V8_DEPRECATE_SOON("Use maybe version", int GetLineNumber() const);
1454
  V8_WARN_UNUSED_RESULT Maybe<int> GetLineNumber(Local<Context> context) const;
1455

1456 1457 1458 1459
  /**
   * Returns the index within the script of the first character where
   * the error occurred.
   */
1460
  int GetStartPosition() const;
1461 1462 1463 1464 1465

  /**
   * Returns the index within the script of the last character where
   * the error occurred.
   */
1466
  int GetEndPosition() const;
1467

1468 1469 1470 1471 1472
  /**
   * Returns the error level of the message.
   */
  int ErrorLevel() const;

1473 1474 1475 1476
  /**
   * Returns the index within the line of the first character where
   * the error occurred.
   */
1477
  V8_DEPRECATE_SOON("Use maybe version", int GetStartColumn() const);
1478
  V8_WARN_UNUSED_RESULT Maybe<int> GetStartColumn(Local<Context> context) const;
1479 1480 1481 1482 1483

  /**
   * Returns the index within the line of the last character where
   * the error occurred.
   */
1484
  V8_DEPRECATED("Use maybe version", int GetEndColumn() const);
1485
  V8_WARN_UNUSED_RESULT Maybe<int> GetEndColumn(Local<Context> context) const;
1486

1487 1488 1489 1490 1491
  /**
   * Passes on the value set by the embedder when it fed the script from which
   * this Message was generated to V8.
   */
  bool IsSharedCrossOrigin() const;
1492
  bool IsOpaque() const;
1493

1494
  // TODO(1245381): Print to a string instead of on a FILE.
1495
  static void PrintCurrentStackTrace(Isolate* isolate, FILE* out);
1496 1497 1498

  static const int kNoLineNumberInfo = 0;
  static const int kNoColumnInfo = 0;
1499
  static const int kNoScriptIdInfo = 0;
1500 1501 1502 1503 1504 1505 1506 1507
};


/**
 * Representation of a JavaScript stack trace. The information collected is a
 * snapshot of the execution stack and the information remains valid after
 * execution continues.
 */
1508
class V8_EXPORT StackTrace {
1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520
 public:
  /**
   * Flags that determine what information is placed captured for each
   * StackFrame when grabbing the current stack trace.
   */
  enum StackTraceOptions {
    kLineNumber = 1,
    kColumnOffset = 1 << 1 | kLineNumber,
    kScriptName = 1 << 2,
    kFunctionName = 1 << 3,
    kIsEval = 1 << 4,
    kIsConstructor = 1 << 5,
1521
    kScriptNameOrSourceURL = 1 << 6,
1522
    kScriptId = 1 << 7,
1523
    kExposeFramesAcrossSecurityOrigins = 1 << 8,
1524
    kOverview = kLineNumber | kColumnOffset | kScriptName | kFunctionName,
1525
    kDetailed = kOverview | kIsEval | kIsConstructor | kScriptNameOrSourceURL
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543
  };

  /**
   * Returns a StackFrame at a particular index.
   */
  Local<StackFrame> GetFrame(uint32_t index) const;

  /**
   * Returns the number of StackFrames.
   */
  int GetFrameCount() const;

  /**
   * Returns StackTrace as a v8::Array that contains StackFrame objects.
   */
  Local<Array> AsArray();

  /**
1544
   * Grab a snapshot of the current JavaScript execution stack.
1545 1546 1547 1548 1549
   *
   * \param frame_limit The maximum number of stack frames we want to capture.
   * \param options Enumerates the set of things we will capture for each
   *   StackFrame.
   */
1550 1551 1552 1553
  static Local<StackTrace> CurrentStackTrace(
      Isolate* isolate,
      int frame_limit,
      StackTraceOptions options = kOverview);
1554 1555 1556 1557 1558 1559
};


/**
 * A single JavaScript stack frame.
 */
1560
class V8_EXPORT StackFrame {
1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578
 public:
  /**
   * Returns the number, 1-based, of the line for the associate function call.
   * This method will return Message::kNoLineNumberInfo if it is unable to
   * retrieve the line number, or if kLineNumber was not passed as an option
   * when capturing the StackTrace.
   */
  int GetLineNumber() const;

  /**
   * Returns the 1-based column offset on the line for the associated function
   * call.
   * This method will return Message::kNoColumnInfo if it is unable to retrieve
   * the column number, or if kColumnOffset was not passed as an option when
   * capturing the StackTrace.
   */
  int GetColumn() const;

1579 1580 1581 1582 1583 1584 1585 1586
  /**
   * Returns the id of the script for the function for this StackFrame.
   * This method will return Message::kNoScriptIdInfo if it is unable to
   * retrieve the script id, or if kScriptId was not passed as an option when
   * capturing the StackTrace.
   */
  int GetScriptId() const;

1587 1588 1589 1590 1591 1592
  /**
   * Returns the name of the resource that contains the script for the
   * function for this StackFrame.
   */
  Local<String> GetScriptName() const;

1593 1594 1595
  /**
   * Returns the name of the resource that contains the script for the
   * function for this StackFrame or sourceURL value if the script name
1596 1597
   * is undefined and its source ends with //# sourceURL=... string or
   * deprecated //@ sourceURL=... string.
1598 1599 1600
   */
  Local<String> GetScriptNameOrSourceURL() const;

1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612
  /**
   * Returns the name of the function associated with this stack frame.
   */
  Local<String> GetFunctionName() const;

  /**
   * Returns whether or not the associated function is compiled via a call to
   * eval().
   */
  bool IsEval() const;

  /**
1613
   * Returns whether or not the associated function is called as a
1614 1615 1616
   * constructor via "new".
   */
  bool IsConstructor() const;
1617 1618 1619
};


1620 1621 1622 1623 1624 1625
// A StateTag represents a possible state of the VM.
enum StateTag { JS, GC, COMPILER, OTHER, EXTERNAL, IDLE };

// A RegisterState represents the current state of registers used
// by the sampling profiler API.
struct RegisterState {
1626
  RegisterState() : pc(nullptr), sp(nullptr), fp(nullptr) {}
1627 1628 1629 1630 1631 1632 1633
  void* pc;  // Instruction pointer.
  void* sp;  // Stack pointer.
  void* fp;  // Frame pointer.
};

// The output structure filled up by GetStackSample API function.
struct SampleInfo {
1634 1635 1636 1637
  size_t frames_count;            // Number of frames collected.
  StateTag vm_state;              // Current VM state.
  void* external_callback_entry;  // External callback address if VM is
                                  // executing an external callback.
1638 1639
};

1640
/**
1641
 * A JSON Parser and Stringifier.
1642
 */
1643
class V8_EXPORT JSON {
1644 1645
 public:
  /**
1646
   * Tries to parse the string |json_string| and returns it as value if
1647 1648 1649
   * successful.
   *
   * \param json_string The string to parse.
1650
   * \return The corresponding value if successfully parsed.
1651
   */
1652
  static V8_DEPRECATED("Use the maybe version taking context",
1653
                       Local<Value> Parse(Local<String> json_string));
1654 1655 1656
  static V8_DEPRECATE_SOON("Use the maybe version taking context",
                           MaybeLocal<Value> Parse(Isolate* isolate,
                                                   Local<String> json_string));
1657
  static V8_WARN_UNUSED_RESULT MaybeLocal<Value> Parse(
1658 1659 1660 1661 1662 1663 1664 1665 1666 1667
      Local<Context> context, Local<String> json_string);

  /**
   * Tries to stringify the JSON-serializable object |json_object| and returns
   * it as string if successful.
   *
   * \param json_object The JSON-serializable object to stringify.
   * \return The corresponding string if successfully stringified.
   */
  static V8_WARN_UNUSED_RESULT MaybeLocal<String> Stringify(
1668 1669
      Local<Context> context, Local<Object> json_object,
      Local<String> gap = Local<String>());
1670 1671
};

1672 1673 1674 1675 1676 1677 1678 1679 1680 1681
/**
 * Value serialization compatible with the HTML structured clone algorithm.
 * The format is backward-compatible (i.e. safe to store to disk).
 *
 * WARNING: This API is under development, and changes (including incompatible
 * changes to the API or wire format) may occur without notice until this
 * warning is removed.
 */
class V8_EXPORT ValueSerializer {
 public:
1682 1683 1684 1685 1686 1687 1688 1689 1690 1691
  class V8_EXPORT Delegate {
   public:
    virtual ~Delegate() {}

    /*
     * Handles the case where a DataCloneError would be thrown in the structured
     * clone spec. Other V8 embedders may throw some other appropriate exception
     * type.
     */
    virtual void ThrowDataCloneError(Local<String> message) = 0;
1692 1693 1694 1695 1696 1697 1698

    /*
     * The embedder overrides this method to write some kind of host object, if
     * possible. If not, a suitable exception should be thrown and
     * Nothing<bool>() returned.
     */
    virtual Maybe<bool> WriteHostObject(Isolate* isolate, Local<Object> object);
1699

1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712
    /*
     * Called when the ValueSerializer is going to serialize a
     * SharedArrayBuffer object. The embedder must return an ID for the
     * object, using the same ID if this SharedArrayBuffer has already been
     * serialized in this buffer. When deserializing, this ID will be passed to
     * ValueDeserializer::TransferSharedArrayBuffer as |transfer_id|.
     *
     * If the object cannot be serialized, an
     * exception should be thrown and Nothing<uint32_t>() returned.
     */
    virtual Maybe<uint32_t> GetSharedArrayBufferId(
        Isolate* isolate, Local<SharedArrayBuffer> shared_array_buffer);

1713 1714 1715 1716
    /*
     * Allocates memory for the buffer of at least the size provided. The actual
     * size (which may be greater or equal) is written to |actual_size|. If no
     * buffer has been allocated yet, nullptr will be provided.
1717 1718 1719 1720
     *
     * If the memory cannot be allocated, nullptr should be returned.
     * |actual_size| will be ignored. It is assumed that |old_buffer| is still
     * valid in this case and has not been modified.
1721 1722 1723 1724 1725 1726 1727 1728
     */
    virtual void* ReallocateBufferMemory(void* old_buffer, size_t size,
                                         size_t* actual_size);

    /*
     * Frees a buffer allocated with |ReallocateBufferMemory|.
     */
    virtual void FreeBufferMemory(void* buffer);
1729 1730
  };

1731
  explicit ValueSerializer(Isolate* isolate);
1732
  ValueSerializer(Isolate* isolate, Delegate* delegate);
1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749
  ~ValueSerializer();

  /*
   * Writes out a header, which includes the format version.
   */
  void WriteHeader();

  /*
   * Serializes a JavaScript value into the buffer.
   */
  V8_WARN_UNUSED_RESULT Maybe<bool> WriteValue(Local<Context> context,
                                               Local<Value> value);

  /*
   * Returns the stored data. This serializer should not be used once the buffer
   * is released. The contents are undefined if a previous write has failed.
   */
1750 1751 1752 1753 1754 1755 1756 1757 1758
  V8_DEPRECATE_SOON("Use Release()", std::vector<uint8_t> ReleaseBuffer());

  /*
   * Returns the stored data (allocated using the delegate's
   * AllocateBufferMemory) and its size. This serializer should not be used once
   * the buffer is released. The contents are undefined if a previous write has
   * failed.
   */
  V8_WARN_UNUSED_RESULT std::pair<uint8_t*, size_t> Release();
1759

1760 1761
  /*
   * Marks an ArrayBuffer as havings its contents transferred out of band.
1762
   * Pass the corresponding ArrayBuffer in the deserializing context to
1763 1764 1765 1766 1767
   * ValueDeserializer::TransferArrayBuffer.
   */
  void TransferArrayBuffer(uint32_t transfer_id,
                           Local<ArrayBuffer> array_buffer);

1768 1769 1770
  /*
   * Similar to TransferArrayBuffer, but for SharedArrayBuffer.
   */
1771 1772 1773 1774
  V8_DEPRECATE_SOON("Use Delegate::GetSharedArrayBufferId",
                    void TransferSharedArrayBuffer(
                        uint32_t transfer_id,
                        Local<SharedArrayBuffer> shared_array_buffer));
1775

1776 1777 1778 1779 1780 1781 1782 1783 1784
  /*
   * Indicate whether to treat ArrayBufferView objects as host objects,
   * i.e. pass them to Delegate::WriteHostObject. This should not be
   * called when no Delegate was passed.
   *
   * The default is not to treat ArrayBufferViews as host objects.
   */
  void SetTreatArrayBufferViewsAsHostObjects(bool mode);

1785 1786 1787 1788 1789 1790 1791
  /*
   * Write raw data in various common formats to the buffer.
   * Note that integer types are written in base-128 varint format, not with a
   * binary copy. For use during an override of Delegate::WriteHostObject.
   */
  void WriteUint32(uint32_t value);
  void WriteUint64(uint64_t value);
1792
  void WriteDouble(double value);
1793 1794
  void WriteRawBytes(const void* source, size_t length);

1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812
 private:
  ValueSerializer(const ValueSerializer&) = delete;
  void operator=(const ValueSerializer&) = delete;

  struct PrivateData;
  PrivateData* private_;
};

/**
 * Deserializes values from data written with ValueSerializer, or a compatible
 * implementation.
 *
 * WARNING: This API is under development, and changes (including incompatible
 * changes to the API or wire format) may occur without notice until this
 * warning is removed.
 */
class V8_EXPORT ValueDeserializer {
 public:
1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824
  class V8_EXPORT Delegate {
   public:
    virtual ~Delegate() {}

    /*
     * The embedder overrides this method to read some kind of host object, if
     * possible. If not, a suitable exception should be thrown and
     * MaybeLocal<Object>() returned.
     */
    virtual MaybeLocal<Object> ReadHostObject(Isolate* isolate);
  };

1825
  ValueDeserializer(Isolate* isolate, const uint8_t* data, size_t size);
1826 1827
  ValueDeserializer(Isolate* isolate, const uint8_t* data, size_t size,
                    Delegate* delegate);
1828 1829 1830 1831 1832 1833
  ~ValueDeserializer();

  /*
   * Reads and validates a header (including the format version).
   * May, for example, reject an invalid or unsupported wire format.
   */
1834
  V8_WARN_UNUSED_RESULT Maybe<bool> ReadHeader(Local<Context> context);
1835 1836 1837 1838 1839 1840

  /*
   * Deserializes a JavaScript value from the buffer.
   */
  V8_WARN_UNUSED_RESULT MaybeLocal<Value> ReadValue(Local<Context> context);

1841 1842 1843 1844 1845 1846 1847
  /*
   * Accepts the array buffer corresponding to the one passed previously to
   * ValueSerializer::TransferArrayBuffer.
   */
  void TransferArrayBuffer(uint32_t transfer_id,
                           Local<ArrayBuffer> array_buffer);

1848 1849
  /*
   * Similar to TransferArrayBuffer, but for SharedArrayBuffer.
1850 1851
   * The id is not necessarily in the same namespace as unshared ArrayBuffer
   * objects.
1852
   */
1853
  void TransferSharedArrayBuffer(uint32_t id,
1854 1855
                                 Local<SharedArrayBuffer> shared_array_buffer);

1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871
  /*
   * Must be called before ReadHeader to enable support for reading the legacy
   * wire format (i.e., which predates this being shipped).
   *
   * Don't use this unless you need to read data written by previous versions of
   * blink::ScriptValueSerializer.
   */
  void SetSupportsLegacyWireFormat(bool supports_legacy_wire_format);

  /*
   * Reads the underlying wire format version. Likely mostly to be useful to
   * legacy code reading old wire format versions. Must be called after
   * ReadHeader.
   */
  uint32_t GetWireFormatVersion() const;

1872 1873 1874 1875 1876 1877 1878
  /*
   * Reads raw data in various common formats to the buffer.
   * Note that integer types are read in base-128 varint format, not with a
   * binary copy. For use during an override of Delegate::ReadHostObject.
   */
  V8_WARN_UNUSED_RESULT bool ReadUint32(uint32_t* value);
  V8_WARN_UNUSED_RESULT bool ReadUint64(uint64_t* value);
1879
  V8_WARN_UNUSED_RESULT bool ReadDouble(double* value);
1880 1881
  V8_WARN_UNUSED_RESULT bool ReadRawBytes(size_t length, const void** data);

1882 1883 1884 1885 1886 1887 1888
 private:
  ValueDeserializer(const ValueDeserializer&) = delete;
  void operator=(const ValueDeserializer&) = delete;

  struct PrivateData;
  PrivateData* private_;
};
1889

yurys's avatar
yurys committed
1890 1891 1892 1893 1894 1895 1896 1897
/**
 * A map whose keys are referenced weakly. It is similar to JavaScript WeakMap
 * but can be created without entering a v8::Context and hence shouldn't
 * escape to JavaScript.
 */
class V8_EXPORT NativeWeakMap : public Data {
 public:
  static Local<NativeWeakMap> New(Isolate* isolate);
1898 1899 1900 1901
  void Set(Local<Value> key, Local<Value> value);
  Local<Value> Get(Local<Value> key);
  bool Has(Local<Value> key);
  bool Delete(Local<Value> key);
yurys's avatar
yurys committed
1902 1903 1904
};


1905
// --- Value ---
1906 1907 1908


/**
1909
 * The superclass of all JavaScript values and objects.
1910
 */
1911
class V8_EXPORT Value : public Data {
1912 1913 1914 1915 1916
 public:
  /**
   * Returns true if this value is the undefined value.  See ECMA-262
   * 4.3.10.
   */
1917
  V8_INLINE bool IsUndefined() const;
1918 1919 1920 1921 1922

  /**
   * Returns true if this value is the null value.  See ECMA-262
   * 4.3.11.
   */
1923
  V8_INLINE bool IsNull() const;
1924

1925 1926 1927 1928
  /**
   * Returns true if this value is either the null or the undefined value.
   * See ECMA-262
   * 4.3.11. and 4.3.12
1929
   */
1930 1931 1932 1933 1934
  V8_INLINE bool IsNullOrUndefined() const;

  /**
  * Returns true if this value is true.
  */
1935
  bool IsTrue() const;
1936 1937 1938 1939

  /**
   * Returns true if this value is false.
   */
1940
  bool IsFalse() const;
1941

1942 1943 1944 1945 1946
  /**
   * Returns true if this value is a symbol or a string.
   */
  bool IsName() const;

1947 1948 1949 1950
  /**
   * Returns true if this value is an instance of the String type.
   * See ECMA-262 8.4.
   */
1951
  V8_INLINE bool IsString() const;
1952

1953 1954 1955 1956 1957
  /**
   * Returns true if this value is a symbol.
   */
  bool IsSymbol() const;

1958 1959 1960
  /**
   * Returns true if this value is a function.
   */
1961
  bool IsFunction() const;
1962 1963

  /**
1964 1965
   * Returns true if this value is an array. Note that it will return false for
   * an Proxy for an array.
1966
   */
1967
  bool IsArray() const;
1968

1969
  /**
1970 1971
   * Returns true if this value is an object.
   */
1972
  bool IsObject() const;
1973

1974
  /**
1975 1976
   * Returns true if this value is boolean.
   */
1977
  bool IsBoolean() const;
1978

1979
  /**
1980 1981
   * Returns true if this value is a number.
   */
1982
  bool IsNumber() const;
1983

1984
  /**
1985 1986
   * Returns true if this value is external.
   */
1987
  bool IsExternal() const;
1988

1989
  /**
1990 1991
   * Returns true if this value is a 32-bit signed integer.
   */
1992
  bool IsInt32() const;
1993

1994
  /**
1995
   * Returns true if this value is a 32-bit unsigned integer.
1996
   */
1997
  bool IsUint32() const;
1998

1999 2000 2001
  /**
   * Returns true if this value is a Date.
   */
2002
  bool IsDate() const;
2003

2004 2005 2006 2007 2008
  /**
   * Returns true if this value is an Arguments object.
   */
  bool IsArgumentsObject() const;

2009 2010 2011
  /**
   * Returns true if this value is a Boolean object.
   */
2012
  bool IsBooleanObject() const;
2013 2014 2015 2016

  /**
   * Returns true if this value is a Number object.
   */
2017
  bool IsNumberObject() const;
2018 2019 2020 2021

  /**
   * Returns true if this value is a String object.
   */
2022
  bool IsStringObject() const;
2023

2024 2025 2026 2027 2028
  /**
   * Returns true if this value is a Symbol object.
   */
  bool IsSymbolObject() const;

2029 2030 2031
  /**
   * Returns true if this value is a NativeError.
   */
2032
  bool IsNativeError() const;
2033

2034 2035 2036
  /**
   * Returns true if this value is a RegExp.
   */
2037
  bool IsRegExp() const;
2038

2039 2040 2041 2042 2043
  /**
   * Returns true if this value is an async function.
   */
  bool IsAsyncFunction() const;

2044 2045 2046 2047 2048 2049 2050 2051 2052 2053
  /**
   * Returns true if this value is a Generator function.
   */
  bool IsGeneratorFunction() const;

  /**
   * Returns true if this value is a Generator object (iterator).
   */
  bool IsGeneratorObject() const;

2054 2055 2056 2057
  /**
   * Returns true if this value is a Promise.
   */
  bool IsPromise() const;
2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068

  /**
   * Returns true if this value is a Map.
   */
  bool IsMap() const;

  /**
   * Returns true if this value is a Set.
   */
  bool IsSet() const;

2069 2070 2071 2072 2073 2074 2075 2076 2077 2078
  /**
   * Returns true if this value is a Map Iterator.
   */
  bool IsMapIterator() const;

  /**
   * Returns true if this value is a Set Iterator.
   */
  bool IsSetIterator() const;

2079 2080 2081 2082 2083 2084 2085 2086 2087
  /**
   * Returns true if this value is a WeakMap.
   */
  bool IsWeakMap() const;

  /**
   * Returns true if this value is a WeakSet.
   */
  bool IsWeakSet() const;
2088 2089 2090 2091 2092 2093

  /**
   * Returns true if this value is an ArrayBuffer.
   */
  bool IsArrayBuffer() const;

dslomov@chromium.org's avatar
dslomov@chromium.org committed
2094 2095 2096 2097 2098
  /**
   * Returns true if this value is an ArrayBufferView.
   */
  bool IsArrayBufferView() const;

2099 2100 2101 2102 2103 2104 2105 2106 2107 2108
  /**
   * Returns true if this value is one of TypedArrays.
   */
  bool IsTypedArray() const;

  /**
   * Returns true if this value is an Uint8Array.
   */
  bool IsUint8Array() const;

2109 2110 2111 2112 2113
  /**
   * Returns true if this value is an Uint8ClampedArray.
   */
  bool IsUint8ClampedArray() const;

2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148
  /**
   * Returns true if this value is an Int8Array.
   */
  bool IsInt8Array() const;

  /**
   * Returns true if this value is an Uint16Array.
   */
  bool IsUint16Array() const;

  /**
   * Returns true if this value is an Int16Array.
   */
  bool IsInt16Array() const;

  /**
   * Returns true if this value is an Uint32Array.
   */
  bool IsUint32Array() const;

  /**
   * Returns true if this value is an Int32Array.
   */
  bool IsInt32Array() const;

  /**
   * Returns true if this value is a Float32Array.
   */
  bool IsFloat32Array() const;

  /**
   * Returns true if this value is a Float64Array.
   */
  bool IsFloat64Array() const;

dslomov@chromium.org's avatar
dslomov@chromium.org committed
2149 2150 2151 2152 2153
  /**
   * Returns true if this value is a DataView.
   */
  bool IsDataView() const;

binji's avatar
binji committed
2154 2155 2156 2157 2158 2159
  /**
   * Returns true if this value is a SharedArrayBuffer.
   * This is an experimental feature.
   */
  bool IsSharedArrayBuffer() const;

2160 2161 2162 2163 2164
  /**
   * Returns true if this value is a JavaScript Proxy.
   */
  bool IsProxy() const;

2165
  bool IsWebAssemblyCompiledModule() const;
binji's avatar
binji committed
2166

2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181
  V8_WARN_UNUSED_RESULT MaybeLocal<Boolean> ToBoolean(
      Local<Context> context) const;
  V8_WARN_UNUSED_RESULT MaybeLocal<Number> ToNumber(
      Local<Context> context) const;
  V8_WARN_UNUSED_RESULT MaybeLocal<String> ToString(
      Local<Context> context) const;
  V8_WARN_UNUSED_RESULT MaybeLocal<String> ToDetailString(
      Local<Context> context) const;
  V8_WARN_UNUSED_RESULT MaybeLocal<Object> ToObject(
      Local<Context> context) const;
  V8_WARN_UNUSED_RESULT MaybeLocal<Integer> ToInteger(
      Local<Context> context) const;
  V8_WARN_UNUSED_RESULT MaybeLocal<Uint32> ToUint32(
      Local<Context> context) const;
  V8_WARN_UNUSED_RESULT MaybeLocal<Int32> ToInt32(Local<Context> context) const;
2182

2183
  V8_DEPRECATE_SOON("Use maybe version",
2184
                    Local<Boolean> ToBoolean(Isolate* isolate) const);
2185
  V8_DEPRECATE_SOON("Use maybe version",
2186
                    Local<Number> ToNumber(Isolate* isolate) const);
2187
  V8_DEPRECATE_SOON("Use maybe version",
2188
                    Local<String> ToString(Isolate* isolate) const);
2189 2190
  V8_DEPRECATED("Use maybe version",
                Local<String> ToDetailString(Isolate* isolate) const);
2191
  V8_DEPRECATE_SOON("Use maybe version",
2192
                    Local<Object> ToObject(Isolate* isolate) const);
2193
  V8_DEPRECATE_SOON("Use maybe version",
2194
                    Local<Integer> ToInteger(Isolate* isolate) const);
2195 2196
  V8_DEPRECATED("Use maybe version",
                Local<Uint32> ToUint32(Isolate* isolate) const);
2197
  V8_DEPRECATE_SOON("Use maybe version",
2198
                    Local<Int32> ToInt32(Isolate* isolate) const);
2199 2200

  inline V8_DEPRECATE_SOON("Use maybe version",
2201
                           Local<Boolean> ToBoolean() const);
2202
  inline V8_DEPRECATED("Use maybe version", Local<Number> ToNumber() const);
2203
  inline V8_DEPRECATE_SOON("Use maybe version", Local<String> ToString() const);
2204 2205
  inline V8_DEPRECATED("Use maybe version",
                       Local<String> ToDetailString() const);
2206
  inline V8_DEPRECATE_SOON("Use maybe version", Local<Object> ToObject() const);
2207
  inline V8_DEPRECATE_SOON("Use maybe version",
2208
                           Local<Integer> ToInteger() const);
2209 2210
  inline V8_DEPRECATED("Use maybe version", Local<Uint32> ToUint32() const);
  inline V8_DEPRECATED("Use maybe version", Local<Int32> ToInt32() const);
2211 2212 2213 2214 2215

  /**
   * Attempts to convert a string to an array index.
   * Returns an empty handle if the conversion fails.
   */
2216
  V8_DEPRECATED("Use maybe version", Local<Uint32> ToArrayIndex() const);
2217 2218
  V8_WARN_UNUSED_RESULT MaybeLocal<Uint32> ToArrayIndex(
      Local<Context> context) const;
2219

2220 2221 2222 2223 2224 2225 2226
  V8_WARN_UNUSED_RESULT Maybe<bool> BooleanValue(Local<Context> context) const;
  V8_WARN_UNUSED_RESULT Maybe<double> NumberValue(Local<Context> context) const;
  V8_WARN_UNUSED_RESULT Maybe<int64_t> IntegerValue(
      Local<Context> context) const;
  V8_WARN_UNUSED_RESULT Maybe<uint32_t> Uint32Value(
      Local<Context> context) const;
  V8_WARN_UNUSED_RESULT Maybe<int32_t> Int32Value(Local<Context> context) const;
2227

2228 2229 2230 2231 2232
  V8_DEPRECATE_SOON("Use maybe version", bool BooleanValue() const);
  V8_DEPRECATE_SOON("Use maybe version", double NumberValue() const);
  V8_DEPRECATE_SOON("Use maybe version", int64_t IntegerValue() const);
  V8_DEPRECATE_SOON("Use maybe version", uint32_t Uint32Value() const);
  V8_DEPRECATE_SOON("Use maybe version", int32_t Int32Value() const);
2233 2234

  /** JS == */
2235
  V8_DEPRECATE_SOON("Use maybe version", bool Equals(Local<Value> that) const);
2236
  V8_WARN_UNUSED_RESULT Maybe<bool> Equals(Local<Context> context,
2237 2238 2239
                                           Local<Value> that) const;
  bool StrictEquals(Local<Value> that) const;
  bool SameValue(Local<Value> that) const;
lrn@chromium.org's avatar
lrn@chromium.org committed
2240

2241
  template <class T> V8_INLINE static Value* Cast(T* value);
dcarney@chromium.org's avatar
dcarney@chromium.org committed
2242

2243
  Local<String> TypeOf(Isolate*);
2244

2245
 private:
2246 2247
  V8_INLINE bool QuickIsUndefined() const;
  V8_INLINE bool QuickIsNull() const;
2248
  V8_INLINE bool QuickIsNullOrUndefined() const;
2249
  V8_INLINE bool QuickIsString() const;
2250 2251 2252
  bool FullIsUndefined() const;
  bool FullIsNull() const;
  bool FullIsString() const;
2253 2254 2255 2256 2257 2258
};


/**
 * The superclass of primitive values.  See ECMA-262 4.3.2.
 */
2259
class V8_EXPORT Primitive : public Value { };
2260 2261 2262 2263 2264 2265


/**
 * A primitive boolean value (ECMA-262, 4.3.14).  Either the true
 * or false value.
 */
2266
class V8_EXPORT Boolean : public Primitive {
2267
 public:
2268
  bool Value() const;
bashi's avatar
bashi committed
2269
  V8_INLINE static Boolean* Cast(v8::Value* obj);
2270 2271
  V8_INLINE static Local<Boolean> New(Isolate* isolate, bool value);

bashi's avatar
bashi committed
2272 2273
 private:
  static void CheckCast(v8::Value* obj);
2274 2275 2276
};


2277 2278 2279 2280 2281
/**
 * A superclass for symbols and strings.
 */
class V8_EXPORT Name : public Primitive {
 public:
2282 2283 2284 2285 2286 2287 2288 2289 2290
  /**
   * Returns the identity hash for this object. The current implementation
   * uses an inline property on the object to store the identity hash.
   *
   * The return value will never be 0. Also, it is not guaranteed to be
   * unique.
   */
  int GetIdentityHash();

2291 2292
  V8_INLINE static Name* Cast(Value* obj);

2293
 private:
2294
  static void CheckCast(Value* obj);
2295 2296 2297
};


2298 2299 2300
enum class NewStringType { kNormal, kInternalized };


2301
/**
2302
 * A JavaScript string value (ECMA-262, 4.3.17).
2303
 */
2304
class V8_EXPORT String : public Name {
2305
 public:
2306 2307
  static const int kMaxLength = (1 << 28) - 16;

2308 2309 2310
  enum Encoding {
    UNKNOWN_ENCODING = 0x1,
    TWO_BYTE_ENCODING = 0x0,
2311
    ONE_BYTE_ENCODING = 0x8
2312
  };
2313 2314 2315
  /**
   * Returns the number of characters in this string.
   */
2316
  int Length() const;
2317

2318 2319 2320 2321
  /**
   * Returns the number of bytes in the UTF-8 encoded
   * representation of this string.
   */
2322
  int Utf8Length() const;
2323

2324
  /**
2325 2326 2327
   * Returns whether this string is known to contain only one byte data.
   * Does not read the string.
   * False negatives are possible.
2328
   */
2329
  bool IsOneByte() const;
2330

2331 2332 2333 2334 2335 2336
  /**
   * Returns whether this string contain only one byte data.
   * Will read the entire string in some cases.
   */
  bool ContainsOnlyOneByte() const;

2337 2338 2339 2340 2341 2342 2343
  /**
   * Write the contents of the string to an external buffer.
   * If no arguments are given, expects the buffer to be large
   * enough to hold the entire string and NULL terminator. Copies
   * the contents of the string and the NULL terminator into the
   * buffer.
   *
2344 2345 2346
   * WriteUtf8 will not write partial UTF-8 sequences, preferring to stop
   * before the end of the buffer.
   *
2347 2348 2349 2350 2351 2352
   * Copies up to length characters into the output buffer.
   * Only null-terminates if there is enough space in the buffer.
   *
   * \param buffer The buffer into which the string will be copied.
   * \param start The starting position within the string at which
   * copying begins.
2353 2354
   * \param length The number of characters to copy from the string.  For
   *    WriteUtf8 the number of bytes in the buffer.
2355
   * \param nchars_ref The number of characters written, can be NULL.
2356
   * \param options Various options that might affect performance of this or
2357
   *    subsequent operations.
2358 2359
   * \return The number of characters copied to the buffer excluding the null
   *    terminator.  For WriteUtf8: The number of bytes copied to the buffer
2360
   *    including the null terminator (if written).
2361
   */
2362 2363 2364
  enum WriteOptions {
    NO_OPTIONS = 0,
    HINT_MANY_WRITES_EXPECTED = 1,
2365
    NO_NULL_TERMINATION = 2,
2366
    PRESERVE_ONE_BYTE_NULL = 4,
2367 2368 2369 2370
    // Used by WriteUtf8 to replace orphan surrogate code units with the
    // unicode replacement character. Needs to be set to guarantee valid UTF-8
    // output.
    REPLACE_INVALID_UTF8 = 8
2371 2372
  };

2373
  // 16-bit character codes.
2374 2375 2376 2377
  int Write(uint16_t* buffer,
            int start = 0,
            int length = -1,
            int options = NO_OPTIONS) const;
2378
  // One byte characters.
2379
  int WriteOneByte(uint8_t* buffer,
2380 2381 2382
                   int start = 0,
                   int length = -1,
                   int options = NO_OPTIONS) const;
2383
  // UTF-8 encoded characters.
2384 2385 2386 2387
  int WriteUtf8(char* buffer,
                int length = -1,
                int* nchars_ref = NULL,
                int options = NO_OPTIONS) const;
2388

2389 2390 2391
  /**
   * A zero length string.
   */
2392
  V8_INLINE static Local<String> Empty(Isolate* isolate);
2393

2394 2395 2396
  /**
   * Returns true if the string is external
   */
2397
  bool IsExternal() const;
2398

2399
  /**
2400
   * Returns true if the string is both external and one-byte.
2401
   */
2402 2403
  bool IsExternalOneByte() const;

2404
  class V8_EXPORT ExternalStringResourceBase {  // NOLINT
2405 2406
   public:
    virtual ~ExternalStringResourceBase() {}
2407

2408 2409
    virtual bool IsCompressible() const { return false; }

2410 2411
   protected:
    ExternalStringResourceBase() {}
2412 2413 2414 2415 2416 2417 2418 2419 2420

    /**
     * Internally V8 will call this Dispose method when the external string
     * resource is no longer needed. The default implementation will use the
     * delete operator. This method can be overridden in subclasses to
     * control how allocated external string resources are disposed.
     */
    virtual void Dispose() { delete this; }

2421
    // Disallow copying and assigning.
2422 2423
    ExternalStringResourceBase(const ExternalStringResourceBase&) = delete;
    void operator=(const ExternalStringResourceBase&) = delete;
2424

2425
   private:
2426
    friend class internal::Heap;
2427
    friend class v8::String;
2428 2429
  };

2430 2431 2432 2433
  /**
   * An ExternalStringResource is a wrapper around a two-byte string
   * buffer that resides outside V8's heap. Implement an
   * ExternalStringResource to manage the life cycle of the underlying
2434
   * buffer.  Note that the string data must be immutable.
2435
   */
2436
  class V8_EXPORT ExternalStringResource
2437
      : public ExternalStringResourceBase {
2438 2439 2440 2441 2442 2443
   public:
    /**
     * Override the destructor to manage the life cycle of the underlying
     * buffer.
     */
    virtual ~ExternalStringResource() {}
2444 2445 2446 2447

    /**
     * The string data from the underlying buffer.
     */
2448
    virtual const uint16_t* data() const = 0;
2449 2450 2451 2452

    /**
     * The length of the string. That is, the number of two-byte characters.
     */
2453
    virtual size_t length() const = 0;
2454

2455 2456 2457 2458 2459
   protected:
    ExternalStringResource() {}
  };

  /**
2460
   * An ExternalOneByteStringResource is a wrapper around an one-byte
2461
   * string buffer that resides outside V8's heap. Implement an
2462
   * ExternalOneByteStringResource to manage the life cycle of the
2463
   * underlying buffer.  Note that the string data must be immutable
2464 2465 2466
   * and that the data must be Latin-1 and not UTF-8, which would require
   * special treatment internally in the engine and do not allow efficient
   * indexing.  Use String::New or convert to 16 bit data for non-Latin1.
2467
   */
2468

2469
  class V8_EXPORT ExternalOneByteStringResource
2470
      : public ExternalStringResourceBase {
2471 2472 2473 2474 2475
   public:
    /**
     * Override the destructor to manage the life cycle of the underlying
     * buffer.
     */
2476
    virtual ~ExternalOneByteStringResource() {}
2477 2478
    /** The string data from the underlying buffer.*/
    virtual const char* data() const = 0;
2479
    /** The number of Latin-1 characters in the string.*/
2480 2481
    virtual size_t length() const = 0;
   protected:
2482
    ExternalOneByteStringResource() {}
2483 2484
  };

2485 2486 2487 2488 2489
  /**
   * If the string is an external string, return the ExternalStringResourceBase
   * regardless of the encoding, otherwise return NULL.  The encoding of the
   * string is returned in encoding_out.
   */
2490 2491
  V8_INLINE ExternalStringResourceBase* GetExternalStringResourceBase(
      Encoding* encoding_out) const;
2492

2493
  /**
2494 2495
   * Get the ExternalStringResource for an external string.  Returns
   * NULL if IsExternal() doesn't return true.
2496
   */
2497
  V8_INLINE ExternalStringResource* GetExternalStringResource() const;
2498 2499

  /**
2500 2501
   * Get the ExternalOneByteStringResource for an external one-byte string.
   * Returns NULL if IsExternalOneByte() doesn't return true.
2502
   */
2503 2504
  const ExternalOneByteStringResource* GetExternalOneByteStringResource() const;

2505
  V8_INLINE static String* Cast(v8::Value* obj);
2506

2507 2508 2509 2510 2511
  // TODO(dcarney): remove with deprecation of New functions.
  enum NewStringType {
    kNormalString = static_cast<int>(v8::NewStringType::kNormal),
    kInternalizedString = static_cast<int>(v8::NewStringType::kInternalized)
  };
2512 2513

  /** Allocates a new string from UTF-8 data.*/
2514 2515 2516 2517 2518 2519 2520 2521
  static V8_DEPRECATE_SOON(
      "Use maybe version",
      Local<String> NewFromUtf8(Isolate* isolate, const char* data,
                                NewStringType type = kNormalString,
                                int length = -1));

  /** Allocates a new string from UTF-8 data. Only returns an empty value when
   * length > kMaxLength. **/
2522 2523 2524
  static V8_WARN_UNUSED_RESULT MaybeLocal<String> NewFromUtf8(
      Isolate* isolate, const char* data, v8::NewStringType type,
      int length = -1);
2525 2526

  /** Allocates a new string from Latin-1 data.*/
2527
  static V8_DEPRECATED(
2528 2529 2530 2531 2532 2533 2534
      "Use maybe version",
      Local<String> NewFromOneByte(Isolate* isolate, const uint8_t* data,
                                   NewStringType type = kNormalString,
                                   int length = -1));

  /** Allocates a new string from Latin-1 data.  Only returns an empty value
   * when length > kMaxLength. **/
2535 2536 2537
  static V8_WARN_UNUSED_RESULT MaybeLocal<String> NewFromOneByte(
      Isolate* isolate, const uint8_t* data, v8::NewStringType type,
      int length = -1);
2538 2539

  /** Allocates a new string from UTF-16 data.*/
2540 2541 2542 2543 2544 2545 2546 2547
  static V8_DEPRECATE_SOON(
      "Use maybe version",
      Local<String> NewFromTwoByte(Isolate* isolate, const uint16_t* data,
                                   NewStringType type = kNormalString,
                                   int length = -1));

  /** Allocates a new string from UTF-16 data. Only returns an empty value when
   * length > kMaxLength. **/
2548 2549 2550
  static V8_WARN_UNUSED_RESULT MaybeLocal<String> NewFromTwoByte(
      Isolate* isolate, const uint16_t* data, v8::NewStringType type,
      int length = -1);
2551

2552 2553 2554 2555
  /**
   * Creates a new string by concatenating the left and the right strings
   * passed in as parameters.
   */
2556
  static Local<String> Concat(Local<String> left, Local<String> right);
2557

2558 2559
  /**
   * Creates a new external string using the data defined in the given
2560
   * resource. When the external string is no longer live on V8's heap the
2561 2562 2563 2564
   * resource will be disposed by calling its Dispose method. The caller of
   * this function should not otherwise delete or modify the resource. Neither
   * should the underlying buffer be deallocated or modified except through the
   * destructor of the external string resource.
2565
   */
2566 2567 2568
  static V8_DEPRECATED("Use maybe version",
                       Local<String> NewExternal(
                           Isolate* isolate, ExternalStringResource* resource));
2569
  static V8_WARN_UNUSED_RESULT MaybeLocal<String> NewExternalTwoByte(
2570
      Isolate* isolate, ExternalStringResource* resource);
2571

2572 2573 2574 2575
  /**
   * Associate an external string resource with this string by transforming it
   * in place so that existing references to this string in the JavaScript heap
   * will use the external string resource. The external string resource's
2576
   * character contents need to be equivalent to this string.
2577
   * Returns true if the string has been changed to be an external string.
2578 2579
   * The string is not modified if the operation fails. See NewExternal for
   * information on the lifetime of the resource.
2580
   */
2581
  bool MakeExternal(ExternalStringResource* resource);
2582

2583
  /**
2584
   * Creates a new external string using the one-byte data defined in the given
2585
   * resource. When the external string is no longer live on V8's heap the
2586 2587 2588 2589
   * resource will be disposed by calling its Dispose method. The caller of
   * this function should not otherwise delete or modify the resource. Neither
   * should the underlying buffer be deallocated or modified except through the
   * destructor of the external string resource.
2590
   */
2591 2592 2593 2594
  static V8_DEPRECATE_SOON(
      "Use maybe version",
      Local<String> NewExternal(Isolate* isolate,
                                ExternalOneByteStringResource* resource));
2595
  static V8_WARN_UNUSED_RESULT MaybeLocal<String> NewExternalOneByte(
2596
      Isolate* isolate, ExternalOneByteStringResource* resource);
2597

2598 2599 2600 2601
  /**
   * Associate an external string resource with this string by transforming it
   * in place so that existing references to this string in the JavaScript heap
   * will use the external string resource. The external string resource's
2602
   * character contents need to be equivalent to this string.
2603
   * Returns true if the string has been changed to be an external string.
2604 2605
   * The string is not modified if the operation fails. See NewExternal for
   * information on the lifetime of the resource.
2606
   */
2607
  bool MakeExternal(ExternalOneByteStringResource* resource);
2608

2609 2610 2611
  /**
   * Returns true if this string can be made external.
   */
2612
  bool CanMakeExternal();
2613

2614
  /**
2615
   * Converts an object to a UTF-8-encoded character array.  Useful if
2616
   * you want to print the object.  If conversion to a string fails
2617
   * (e.g. due to an exception in the toString() method of the object)
2618 2619
   * then the length() method returns 0 and the * operator returns
   * NULL.
2620
   */
2621
  class V8_EXPORT Utf8Value {
2622
   public:
2623
    explicit Utf8Value(Local<v8::Value> obj);
2624
    ~Utf8Value();
2625 2626 2627
    char* operator*() { return str_; }
    const char* operator*() const { return str_; }
    int length() const { return length_; }
2628 2629 2630 2631 2632

    // Disallow copying and assigning.
    Utf8Value(const Utf8Value&) = delete;
    void operator=(const Utf8Value&) = delete;

2633 2634 2635 2636 2637
   private:
    char* str_;
    int length_;
  };

2638 2639
  /**
   * Converts an object to a two-byte string.
2640 2641 2642
   * If conversion to a string fails (eg. due to an exception in the toString()
   * method of the object) then the length() method returns 0 and the * operator
   * returns NULL.
2643
   */
2644
  class V8_EXPORT Value {
2645
   public:
2646
    explicit Value(Local<v8::Value> obj);
2647
    ~Value();
2648 2649
    uint16_t* operator*() { return str_; }
    const uint16_t* operator*() const { return str_; }
2650
    int length() const { return length_; }
2651 2652 2653 2654 2655

    // Disallow copying and assigning.
    Value(const Value&) = delete;
    void operator=(const Value&) = delete;

2656 2657
   private:
    uint16_t* str_;
2658
    int length_;
2659
  };
lrn@chromium.org's avatar
lrn@chromium.org committed
2660

2661
 private:
2662 2663 2664 2665
  void VerifyExternalStringResourceBase(ExternalStringResourceBase* v,
                                        Encoding encoding) const;
  void VerifyExternalStringResource(ExternalStringResource* val) const;
  static void CheckCast(v8::Value* obj);
2666 2667 2668
};


2669 2670 2671
/**
 * A JavaScript symbol (ECMA-262 edition 6)
 */
2672
class V8_EXPORT Symbol : public Name {
2673 2674 2675 2676
 public:
  // Returns the print name string of the symbol, or undefined if none.
  Local<Value> Name() const;

2677
  // Create a symbol. If name is not empty, it will be used as the description.
2678 2679
  static Local<Symbol> New(Isolate* isolate,
                           Local<String> name = Local<String>());
2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690

  // Access global symbol registry.
  // Note that symbols created this way are never collected, so
  // they should only be used for statically fixed properties.
  // Also, there is only one global name space for the names used as keys.
  // To minimize the potential for clashes, use qualified names as keys.
  static Local<Symbol> For(Isolate *isolate, Local<String> name);

  // Retrieve a global symbol. Similar to |For|, but using a separate
  // registry that is not accessible by (and cannot clash with) JavaScript code.
  static Local<Symbol> ForApi(Isolate *isolate, Local<String> name);
2691

2692 2693 2694
  // Well-known symbols
  static Local<Symbol> GetIterator(Isolate* isolate);
  static Local<Symbol> GetUnscopables(Isolate* isolate);
2695
  static Local<Symbol> GetToPrimitive(Isolate* isolate);
2696
  static Local<Symbol> GetToStringTag(Isolate* isolate);
2697
  static Local<Symbol> GetIsConcatSpreadable(Isolate* isolate);
2698

2699
  V8_INLINE static Symbol* Cast(Value* obj);
2700

2701 2702
 private:
  Symbol();
2703
  static void CheckCast(Value* obj);
2704 2705 2706
};


2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734
/**
 * A private symbol
 *
 * This is an experimental feature. Use at your own risk.
 */
class V8_EXPORT Private : public Data {
 public:
  // Returns the print name string of the private symbol, or undefined if none.
  Local<Value> Name() const;

  // Create a private symbol. If name is not empty, it will be the description.
  static Local<Private> New(Isolate* isolate,
                            Local<String> name = Local<String>());

  // Retrieve a global private symbol. If a symbol with this name has not
  // been retrieved in the same isolate before, it is created.
  // Note that private symbols created this way are never collected, so
  // they should only be used for statically fixed properties.
  // Also, there is only one global name space for the names used as keys.
  // To minimize the potential for clashes, use qualified names as keys,
  // e.g., "Class#property".
  static Local<Private> ForApi(Isolate* isolate, Local<String> name);

 private:
  Private();
};


2735
/**
2736
 * A JavaScript number value (ECMA-262, 4.3.20)
2737
 */
2738
class V8_EXPORT Number : public Primitive {
2739
 public:
2740
  double Value() const;
2741
  static Local<Number> New(Isolate* isolate, double value);
2742
  V8_INLINE static Number* Cast(v8::Value* obj);
2743
 private:
2744 2745
  Number();
  static void CheckCast(v8::Value* obj);
2746 2747 2748 2749
};


/**
2750
 * A JavaScript value representing a signed integer.
2751
 */
2752
class V8_EXPORT Integer : public Number {
2753
 public:
2754 2755
  static Local<Integer> New(Isolate* isolate, int32_t value);
  static Local<Integer> NewFromUnsigned(Isolate* isolate, uint32_t value);
2756
  int64_t Value() const;
2757
  V8_INLINE static Integer* Cast(v8::Value* obj);
2758
 private:
2759 2760
  Integer();
  static void CheckCast(v8::Value* obj);
2761 2762 2763 2764
};


/**
2765
 * A JavaScript value representing a 32-bit signed integer.
2766
 */
2767
class V8_EXPORT Int32 : public Integer {
2768
 public:
2769
  int32_t Value() const;
bashi's avatar
bashi committed
2770 2771
  V8_INLINE static Int32* Cast(v8::Value* obj);

2772
 private:
2773
  Int32();
bashi's avatar
bashi committed
2774
  static void CheckCast(v8::Value* obj);
2775 2776 2777 2778
};


/**
2779
 * A JavaScript value representing a 32-bit unsigned integer.
2780
 */
2781
class V8_EXPORT Uint32 : public Integer {
2782
 public:
2783
  uint32_t Value() const;
bashi's avatar
bashi committed
2784 2785
  V8_INLINE static Uint32* Cast(v8::Value* obj);

2786
 private:
2787
  Uint32();
bashi's avatar
bashi committed
2788
  static void CheckCast(v8::Value* obj);
2789 2790
};

2791 2792 2793
/**
 * PropertyAttribute.
 */
2794
enum PropertyAttribute {
2795 2796 2797 2798 2799 2800 2801
  /** None. **/
  None = 0,
  /** ReadOnly, i.e., not writable. **/
  ReadOnly = 1 << 0,
  /** DontEnum, i.e., not enumerable. **/
  DontEnum = 1 << 1,
  /** DontDelete, i.e., not configurable. **/
2802 2803 2804
  DontDelete = 1 << 2
};

2805 2806 2807 2808 2809
/**
 * Accessor[Getter|Setter] are used as callback functions when
 * setting|getting a particular property. See Object and ObjectTemplate's
 * method SetAccessor.
 */
2810 2811 2812
typedef void (*AccessorGetterCallback)(
    Local<String> property,
    const PropertyCallbackInfo<Value>& info);
2813 2814 2815
typedef void (*AccessorNameGetterCallback)(
    Local<Name> property,
    const PropertyCallbackInfo<Value>& info);
2816 2817


2818 2819 2820 2821
typedef void (*AccessorSetterCallback)(
    Local<String> property,
    Local<Value> value,
    const PropertyCallbackInfo<void>& info);
2822 2823 2824 2825
typedef void (*AccessorNameSetterCallback)(
    Local<Name> property,
    Local<Value> value,
    const PropertyCallbackInfo<void>& info);
2826 2827 2828 2829 2830 2831 2832 2833 2834


/**
 * Access control specifications.
 *
 * Some accessors should be accessible across contexts.  These
 * accessors have an explicit access control parameter which specifies
 * the kind of cross-context access that should be allowed.
 *
2835
 * TODO(dcarney): Remove PROHIBITS_OVERWRITING as it is now unused.
2836 2837 2838 2839 2840 2841 2842 2843
 */
enum AccessControl {
  DEFAULT               = 0,
  ALL_CAN_READ          = 1,
  ALL_CAN_WRITE         = 1 << 1,
  PROHIBITS_OVERWRITING = 1 << 2
};

2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855
/**
 * Property filter bits. They can be or'ed to build a composite filter.
 */
enum PropertyFilter {
  ALL_PROPERTIES = 0,
  ONLY_WRITABLE = 1,
  ONLY_ENUMERABLE = 2,
  ONLY_CONFIGURABLE = 4,
  SKIP_STRINGS = 8,
  SKIP_SYMBOLS = 16
};

2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870
/**
 * Keys/Properties filter enums:
 *
 * KeyCollectionMode limits the range of collected properties. kOwnOnly limits
 * the collected properties to the given Object only. kIncludesPrototypes will
 * include all keys of the objects's prototype chain as well.
 */
enum class KeyCollectionMode { kOwnOnly, kIncludePrototypes };

/**
 * kIncludesIndices allows for integer indices to be collected, while
 * kSkipIndices will exclude integer indicies from being collected.
 */
enum class IndexFilter { kIncludeIndices, kSkipIndices };

2871 2872 2873 2874
/**
 * Integrity level for objects.
 */
enum class IntegrityLevel { kFrozen, kSealed };
2875

2876
/**
2877
 * A JavaScript object (ECMA-262, 4.3.3)
2878
 */
2879
class V8_EXPORT Object : public Value {
2880
 public:
2881
  V8_DEPRECATE_SOON("Use maybe version",
2882
                    bool Set(Local<Value> key, Local<Value> value));
2883 2884
  V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context,
                                        Local<Value> key, Local<Value> value);
christian.plesner.hansen@gmail.com's avatar
christian.plesner.hansen@gmail.com committed
2885

2886
  V8_DEPRECATE_SOON("Use maybe version",
2887
                    bool Set(uint32_t index, Local<Value> value));
2888 2889
  V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context, uint32_t index,
                                        Local<Value> value);
2890

2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904
  // Implements CreateDataProperty (ECMA-262, 7.3.4).
  //
  // Defines a configurable, writable, enumerable property with the given value
  // on the object unless the property already exists and is not configurable
  // or the object is not extensible.
  //
  // Returns true on success.
  V8_WARN_UNUSED_RESULT Maybe<bool> CreateDataProperty(Local<Context> context,
                                                       Local<Name> key,
                                                       Local<Value> value);
  V8_WARN_UNUSED_RESULT Maybe<bool> CreateDataProperty(Local<Context> context,
                                                       uint32_t index,
                                                       Local<Value> value);

jochen's avatar
jochen committed
2905 2906 2907 2908 2909 2910 2911 2912 2913 2914
  // Implements DefineOwnProperty.
  //
  // In general, CreateDataProperty will be faster, however, does not allow
  // for specifying attributes.
  //
  // Returns true on success.
  V8_WARN_UNUSED_RESULT Maybe<bool> DefineOwnProperty(
      Local<Context> context, Local<Name> key, Local<Value> value,
      PropertyAttribute attributes = None);

2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930
  // Implements Object.DefineProperty(O, P, Attributes), see Ecma-262 19.1.2.4.
  //
  // The defineProperty function is used to add an own property or
  // update the attributes of an existing own property of an object.
  //
  // Both data and accessor descriptors can be used.
  //
  // In general, CreateDataProperty is faster, however, does not allow
  // for specifying attributes or an accessor descriptor.
  //
  // The PropertyDescriptor can change when redefining a property.
  //
  // Returns true on success.
  V8_WARN_UNUSED_RESULT Maybe<bool> DefineProperty(
      Local<Context> context, Local<Name> key, PropertyDescriptor& descriptor);

2931
  // Sets an own property on this object bypassing interceptors and
christian.plesner.hansen@gmail.com's avatar
christian.plesner.hansen@gmail.com committed
2932 2933 2934 2935 2936
  // overriding accessors or read-only properties.
  //
  // Note that if the object has an interceptor the property will be set
  // locally, but since the interceptor takes precedence the local property
  // will only be returned if the interceptor doesn't return a value.
2937 2938
  //
  // Note also that this only works for named properties.
2939 2940 2941
  V8_DEPRECATED("Use CreateDataProperty / DefineOwnProperty",
                bool ForceSet(Local<Value> key, Local<Value> value,
                              PropertyAttribute attribs = None));
2942 2943 2944 2945
  V8_DEPRECATE_SOON("Use CreateDataProperty / DefineOwnProperty",
                    Maybe<bool> ForceSet(Local<Context> context,
                                         Local<Value> key, Local<Value> value,
                                         PropertyAttribute attribs = None));
2946

2947
  V8_DEPRECATE_SOON("Use maybe version", Local<Value> Get(Local<Value> key));
2948 2949
  V8_WARN_UNUSED_RESULT MaybeLocal<Value> Get(Local<Context> context,
                                              Local<Value> key);
2950

2951
  V8_DEPRECATE_SOON("Use maybe version", Local<Value> Get(uint32_t index));
2952 2953
  V8_WARN_UNUSED_RESULT MaybeLocal<Value> Get(Local<Context> context,
                                              uint32_t index);
2954

2955 2956 2957 2958 2959
  /**
   * Gets the property attributes of a property which can be None or
   * any combination of ReadOnly, DontEnum and DontDelete. Returns
   * None when the property doesn't exist.
   */
2960 2961
  V8_DEPRECATED("Use maybe version",
                PropertyAttribute GetPropertyAttributes(Local<Value> key));
2962 2963
  V8_WARN_UNUSED_RESULT Maybe<PropertyAttribute> GetPropertyAttributes(
      Local<Context> context, Local<Value> key);
2964

2965 2966 2967
  /**
   * Returns Object.getOwnPropertyDescriptor as per ES5 section 15.2.3.3.
   */
2968 2969
  V8_DEPRECATED("Use maybe version",
                Local<Value> GetOwnPropertyDescriptor(Local<String> key));
2970 2971
  V8_WARN_UNUSED_RESULT MaybeLocal<Value> GetOwnPropertyDescriptor(
      Local<Context> context, Local<String> key);
2972

2973
  V8_DEPRECATE_SOON("Use maybe version", bool Has(Local<Value> key));
2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988
  /**
   * Object::Has() calls the abstract operation HasProperty(O, P) described
   * in ECMA-262, 7.3.10. Has() returns
   * true, if the object has the property, either own or on the prototype chain.
   * Interceptors, i.e., PropertyQueryCallbacks, are called if present.
   *
   * Has() has the same side effects as JavaScript's `variable in object`.
   * For example, calling Has() on a revoked proxy will throw an exception.
   *
   * \note Has() converts the key to a name, which possibly calls back into
   * JavaScript.
   *
   * See also v8::Object::HasOwnProperty() and
   * v8::Object::HasRealNamedProperty().
   */
2989 2990
  V8_WARN_UNUSED_RESULT Maybe<bool> Has(Local<Context> context,
                                        Local<Value> key);
2991

2992
  V8_DEPRECATE_SOON("Use maybe version", bool Delete(Local<Value> key));
2993
  // TODO(dcarney): mark V8_WARN_UNUSED_RESULT
2994
  Maybe<bool> Delete(Local<Context> context, Local<Value> key);
2995

2996
  V8_DEPRECATED("Use maybe version", bool Has(uint32_t index));
2997
  V8_WARN_UNUSED_RESULT Maybe<bool> Has(Local<Context> context, uint32_t index);
2998

2999
  V8_DEPRECATED("Use maybe version", bool Delete(uint32_t index));
3000
  // TODO(dcarney): mark V8_WARN_UNUSED_RESULT
3001
  Maybe<bool> Delete(Local<Context> context, uint32_t index);
3002

3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016
  V8_DEPRECATED("Use maybe version",
                bool SetAccessor(Local<String> name,
                                 AccessorGetterCallback getter,
                                 AccessorSetterCallback setter = 0,
                                 Local<Value> data = Local<Value>(),
                                 AccessControl settings = DEFAULT,
                                 PropertyAttribute attribute = None));
  V8_DEPRECATED("Use maybe version",
                bool SetAccessor(Local<Name> name,
                                 AccessorNameGetterCallback getter,
                                 AccessorNameSetterCallback setter = 0,
                                 Local<Value> data = Local<Value>(),
                                 AccessControl settings = DEFAULT,
                                 PropertyAttribute attribute = None));
3017
  // TODO(dcarney): mark V8_WARN_UNUSED_RESULT
3018 3019 3020 3021 3022 3023
  Maybe<bool> SetAccessor(Local<Context> context, Local<Name> name,
                          AccessorNameGetterCallback getter,
                          AccessorNameSetterCallback setter = 0,
                          MaybeLocal<Value> data = MaybeLocal<Value>(),
                          AccessControl settings = DEFAULT,
                          PropertyAttribute attribute = None);
3024

3025 3026
  void SetAccessorProperty(Local<Name> name, Local<Function> getter,
                           Local<Function> setter = Local<Function>(),
3027 3028 3029
                           PropertyAttribute attribute = None,
                           AccessControl settings = DEFAULT);

3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041
  /**
   * Functionality for private properties.
   * This is an experimental feature, use at your own risk.
   * Note: Private properties are not inherited. Do not rely on this, since it
   * may change.
   */
  Maybe<bool> HasPrivate(Local<Context> context, Local<Private> key);
  Maybe<bool> SetPrivate(Local<Context> context, Local<Private> key,
                         Local<Value> value);
  Maybe<bool> DeletePrivate(Local<Context> context, Local<Private> key);
  MaybeLocal<Value> GetPrivate(Local<Context> context, Local<Private> key);

3042 3043 3044 3045 3046 3047
  /**
   * Returns an array containing the names of the enumerable properties
   * of this object, including properties from prototype objects.  The
   * array returned by this method contains the same values as would
   * be enumerated by a for-in statement over this object.
   */
3048
  V8_DEPRECATE_SOON("Use maybe version", Local<Array> GetPropertyNames());
3049 3050
  V8_WARN_UNUSED_RESULT MaybeLocal<Array> GetPropertyNames(
      Local<Context> context);
3051 3052 3053
  V8_WARN_UNUSED_RESULT MaybeLocal<Array> GetPropertyNames(
      Local<Context> context, KeyCollectionMode mode,
      PropertyFilter property_filter, IndexFilter index_filter);
3054

3055 3056 3057 3058 3059
  /**
   * This function has the same functionality as GetPropertyNames but
   * the returned array doesn't contain the names of properties from
   * prototype objects.
   */
3060
  V8_DEPRECATE_SOON("Use maybe version", Local<Array> GetOwnPropertyNames());
3061 3062
  V8_WARN_UNUSED_RESULT MaybeLocal<Array> GetOwnPropertyNames(
      Local<Context> context);
3063

3064 3065 3066 3067 3068 3069 3070 3071 3072
  /**
   * Returns an array containing the names of the filtered properties
   * of this object, including properties from prototype objects.  The
   * array returned by this method contains the same values as would
   * be enumerated by a for-in statement over this object.
   */
  V8_WARN_UNUSED_RESULT MaybeLocal<Array> GetOwnPropertyNames(
      Local<Context> context, PropertyFilter filter);

3073 3074 3075 3076 3077
  /**
   * Get the prototype object.  This does not skip objects marked to
   * be skipped by __proto__ and it does not consult the security
   * handler.
   */
3078
  Local<Value> GetPrototype();
3079

3080 3081 3082 3083 3084
  /**
   * Set the prototype object.  This does not skip objects marked to
   * be skipped by __proto__ and it does not consult the security
   * handler.
   */
3085
  V8_DEPRECATED("Use maybe version", bool SetPrototype(Local<Value> prototype));
3086 3087
  V8_WARN_UNUSED_RESULT Maybe<bool> SetPrototype(Local<Context> context,
                                                 Local<Value> prototype);
3088

3089 3090 3091 3092
  /**
   * Finds an instance of the given function template in the prototype
   * chain.
   */
3093
  Local<Object> FindInstanceInPrototypeChain(Local<FunctionTemplate> tmpl);
3094

3095 3096 3097 3098 3099
  /**
   * Call builtin Object.prototype.toString on this object.
   * This is different from Value::ToString() that may call
   * user-defined toString function. This one does not.
   */
3100
  V8_DEPRECATED("Use maybe version", Local<String> ObjectProtoToString());
3101 3102
  V8_WARN_UNUSED_RESULT MaybeLocal<String> ObjectProtoToString(
      Local<Context> context);
3103

3104 3105 3106
  /**
   * Returns the name of the function invoked as a constructor for this object.
   */
3107
  Local<String> GetConstructorName();
3108

3109 3110 3111 3112 3113
  /**
   * Sets the integrity level of the object.
   */
  Maybe<bool> SetIntegrityLevel(Local<Context> context, IntegrityLevel level);

3114
  /** Gets the number of internal fields for this Object. */
3115
  int InternalFieldCount();
3116

3117 3118 3119 3120 3121 3122
  /** Same as above, but works for Persistents */
  V8_INLINE static int InternalFieldCount(
      const PersistentBase<Object>& object) {
    return object.val_->InternalFieldCount();
  }

3123
  /** Gets the value from an internal field. */
3124
  V8_INLINE Local<Value> GetInternalField(int index);
3125

3126
  /** Sets the value in an internal field. */
3127
  void SetInternalField(int index, Local<Value> value);
3128

3129 3130 3131 3132 3133
  /**
   * Gets a 2-byte-aligned native pointer from an internal field. This field
   * must have been set by SetAlignedPointerInInternalField, everything else
   * leads to undefined behavior.
   */
3134
  V8_INLINE void* GetAlignedPointerFromInternalField(int index);
3135

3136 3137 3138 3139 3140 3141
  /** Same as above, but works for Persistents */
  V8_INLINE static void* GetAlignedPointerFromInternalField(
      const PersistentBase<Object>& object, int index) {
    return object.val_->GetAlignedPointerFromInternalField(index);
  }

3142 3143 3144 3145 3146
  /**
   * Sets a 2-byte-aligned native pointer in an internal field. To retrieve such
   * a field, GetAlignedPointerFromInternalField must be used, everything else
   * leads to undefined behavior.
   */
3147
  void SetAlignedPointerInInternalField(int index, void* value);
3148 3149
  void SetAlignedPointerInInternalFields(int argc, int indices[],
                                         void* values[]);
3150

3151
  // Testers for local properties.
3152
  V8_DEPRECATED("Use maybe version", bool HasOwnProperty(Local<String> key));
3153 3154 3155 3156 3157 3158

  /**
   * HasOwnProperty() is like JavaScript's Object.prototype.hasOwnProperty().
   *
   * See also v8::Object::Has() and v8::Object::HasRealNamedProperty().
   */
3159 3160
  V8_WARN_UNUSED_RESULT Maybe<bool> HasOwnProperty(Local<Context> context,
                                                   Local<Name> key);
3161 3162
  V8_WARN_UNUSED_RESULT Maybe<bool> HasOwnProperty(Local<Context> context,
                                                   uint32_t index);
3163
  V8_DEPRECATE_SOON("Use maybe version",
3164
                    bool HasRealNamedProperty(Local<String> key));
3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177
  /**
   * Use HasRealNamedProperty() if you want to check if an object has an own
   * property without causing side effects, i.e., without calling interceptors.
   *
   * This function is similar to v8::Object::HasOwnProperty(), but it does not
   * call interceptors.
   *
   * \note Consider using non-masking interceptors, i.e., the interceptors are
   * not called if the receiver has the real named property. See
   * `v8::PropertyHandlerFlags::kNonMasking`.
   *
   * See also v8::Object::Has().
   */
3178 3179
  V8_WARN_UNUSED_RESULT Maybe<bool> HasRealNamedProperty(Local<Context> context,
                                                         Local<Name> key);
3180 3181
  V8_DEPRECATE_SOON("Use maybe version",
                    bool HasRealIndexedProperty(uint32_t index));
3182 3183
  V8_WARN_UNUSED_RESULT Maybe<bool> HasRealIndexedProperty(
      Local<Context> context, uint32_t index);
3184
  V8_DEPRECATE_SOON("Use maybe version",
3185
                    bool HasRealNamedCallbackProperty(Local<String> key));
3186 3187
  V8_WARN_UNUSED_RESULT Maybe<bool> HasRealNamedCallbackProperty(
      Local<Context> context, Local<Name> key);
3188 3189 3190 3191 3192

  /**
   * If result.IsEmpty() no real property was located in the prototype chain.
   * This means interceptors in the prototype chain are not called.
   */
3193
  V8_DEPRECATED(
3194
      "Use maybe version",
3195
      Local<Value> GetRealNamedPropertyInPrototypeChain(Local<String> key));
3196 3197
  V8_WARN_UNUSED_RESULT MaybeLocal<Value> GetRealNamedPropertyInPrototypeChain(
      Local<Context> context, Local<Name> key);
3198

3199 3200 3201 3202 3203
  /**
   * Gets the property attributes of a real property in the prototype chain,
   * which can be None or any combination of ReadOnly, DontEnum and DontDelete.
   * Interceptors in the prototype chain are not called.
   */
3204
  V8_DEPRECATED(
3205 3206
      "Use maybe version",
      Maybe<PropertyAttribute> GetRealNamedPropertyAttributesInPrototypeChain(
3207
          Local<String> key));
3208 3209 3210
  V8_WARN_UNUSED_RESULT Maybe<PropertyAttribute>
  GetRealNamedPropertyAttributesInPrototypeChain(Local<Context> context,
                                                 Local<Name> key);
3211

3212 3213 3214 3215 3216
  /**
   * If result.IsEmpty() no real property was located on the object or
   * in the prototype chain.
   * This means interceptors in the prototype chain are not called.
   */
3217 3218
  V8_DEPRECATED("Use maybe version",
                Local<Value> GetRealNamedProperty(Local<String> key));
3219 3220
  V8_WARN_UNUSED_RESULT MaybeLocal<Value> GetRealNamedProperty(
      Local<Context> context, Local<Name> key);
3221

3222 3223 3224 3225 3226
  /**
   * Gets the property attributes of a real property which can be
   * None or any combination of ReadOnly, DontEnum and DontDelete.
   * Interceptors in the prototype chain are not called.
   */
3227 3228 3229
  V8_DEPRECATED("Use maybe version",
                Maybe<PropertyAttribute> GetRealNamedPropertyAttributes(
                    Local<String> key));
3230
  V8_WARN_UNUSED_RESULT Maybe<PropertyAttribute> GetRealNamedPropertyAttributes(
3231
      Local<Context> context, Local<Name> key);
3232

3233
  /** Tests for a named lookup interceptor.*/
3234
  bool HasNamedLookupInterceptor();
3235

3236
  /** Tests for an index lookup interceptor.*/
3237
  bool HasIndexedLookupInterceptor();
3238

3239
  /**
3240 3241
   * Returns the identity hash for this object. The current implementation
   * uses a hidden property on the object to store the identity hash.
3242
   *
3243
   * The return value will never be 0. Also, it is not guaranteed to be
3244
   * unique.
3245
   */
3246
  int GetIdentityHash();
3247

3248 3249 3250 3251
  /**
   * Clone this object with a fast but shallow copy.  Values will point
   * to the same values as the original object.
   */
3252
  // TODO(dcarney): take an isolate and optionally bail out?
3253
  Local<Object> Clone();
3254

3255 3256 3257
  /**
   * Returns the context in which the object was created.
   */
3258
  Local<Context> CreationContext();
3259

3260 3261 3262 3263 3264 3265
  /** Same as above, but works for Persistents */
  V8_INLINE static Local<Context> CreationContext(
      const PersistentBase<Object>& object) {
    return object.val_->CreationContext();
  }

3266 3267 3268 3269 3270
  /**
   * Checks whether a callback is set by the
   * ObjectTemplate::SetCallAsFunctionHandler method.
   * When an Object is callable this method returns true.
   */
3271
  bool IsCallable();
3272

3273 3274 3275 3276 3277
  /**
   * True if this object is a constructor.
   */
  bool IsConstructor();

3278
  /**
3279
   * Call an Object as a function if a callback is set by the
3280 3281
   * ObjectTemplate::SetCallAsFunctionHandler method.
   */
3282 3283 3284
  V8_DEPRECATED("Use maybe version",
                Local<Value> CallAsFunction(Local<Value> recv, int argc,
                                            Local<Value> argv[]));
3285
  V8_WARN_UNUSED_RESULT MaybeLocal<Value> CallAsFunction(Local<Context> context,
3286
                                                         Local<Value> recv,
3287
                                                         int argc,
3288
                                                         Local<Value> argv[]);
3289

3290
  /**
3291
   * Call an Object as a constructor if a callback is set by the
3292 3293 3294
   * ObjectTemplate::SetCallAsFunctionHandler method.
   * Note: This method behaves like the Function::NewInstance method.
   */
3295 3296
  V8_DEPRECATED("Use maybe version",
                Local<Value> CallAsConstructor(int argc, Local<Value> argv[]));
3297 3298
  V8_WARN_UNUSED_RESULT MaybeLocal<Value> CallAsConstructor(
      Local<Context> context, int argc, Local<Value> argv[]);
3299

3300 3301 3302
  /**
   * Return the isolate to which the Object belongs to.
   */
3303
  V8_DEPRECATE_SOON("Keep track of isolate correctly", Isolate* GetIsolate());
3304

3305
  static Local<Object> New(Isolate* isolate);
3306

3307
  V8_INLINE static Object* Cast(Value* obj);
3308

3309
 private:
3310 3311 3312 3313
  Object();
  static void CheckCast(Value* obj);
  Local<Value> SlowGetInternalField(int index);
  void* SlowGetAlignedPointerFromInternalField(int index);
3314 3315 3316 3317 3318 3319
};


/**
 * An instance of the built-in array constructor (ECMA-262, 15.4.2).
 */
3320
class V8_EXPORT Array : public Object {
3321
 public:
3322
  uint32_t Length() const;
3323

3324 3325 3326 3327
  /**
   * Clones an element at index |index|.  Returns an empty
   * handle if cloning fails (for any reason).
   */
3328 3329 3330 3331 3332
  V8_DEPRECATED("Cloning is not supported.",
                Local<Object> CloneElementAt(uint32_t index));
  V8_DEPRECATED("Cloning is not supported.",
                MaybeLocal<Object> CloneElementAt(Local<Context> context,
                                                  uint32_t index));
3333

3334 3335 3336 3337
  /**
   * Creates a JavaScript array with the given length. If the length
   * is negative the returned array will have length 0.
   */
3338
  static Local<Array> New(Isolate* isolate, int length = 0);
3339

3340
  V8_INLINE static Array* Cast(Value* obj);
3341
 private:
3342 3343
  Array();
  static void CheckCast(Value* obj);
3344 3345 3346
};


3347 3348 3349 3350 3351 3352
/**
 * An instance of the built-in Map constructor (ECMA-262, 6th Edition, 23.1.1).
 */
class V8_EXPORT Map : public Object {
 public:
  size_t Size() const;
3353 3354 3355 3356 3357 3358 3359 3360 3361 3362
  void Clear();
  V8_WARN_UNUSED_RESULT MaybeLocal<Value> Get(Local<Context> context,
                                              Local<Value> key);
  V8_WARN_UNUSED_RESULT MaybeLocal<Map> Set(Local<Context> context,
                                            Local<Value> key,
                                            Local<Value> value);
  V8_WARN_UNUSED_RESULT Maybe<bool> Has(Local<Context> context,
                                        Local<Value> key);
  V8_WARN_UNUSED_RESULT Maybe<bool> Delete(Local<Context> context,
                                           Local<Value> key);
3363

3364
  /**
3365 3366
   * Returns an array of length Size() * 2, where index N is the Nth key and
   * index N + 1 is the Nth value.
3367 3368 3369
   */
  Local<Array> AsArray() const;

3370
  /**
3371
   * Creates a new empty Map.
3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388
   */
  static Local<Map> New(Isolate* isolate);

  V8_INLINE static Map* Cast(Value* obj);

 private:
  Map();
  static void CheckCast(Value* obj);
};


/**
 * An instance of the built-in Set constructor (ECMA-262, 6th Edition, 23.2.1).
 */
class V8_EXPORT Set : public Object {
 public:
  size_t Size() const;
3389 3390 3391 3392 3393 3394 3395
  void Clear();
  V8_WARN_UNUSED_RESULT MaybeLocal<Set> Add(Local<Context> context,
                                            Local<Value> key);
  V8_WARN_UNUSED_RESULT Maybe<bool> Has(Local<Context> context,
                                        Local<Value> key);
  V8_WARN_UNUSED_RESULT Maybe<bool> Delete(Local<Context> context,
                                           Local<Value> key);
3396

3397 3398 3399 3400 3401
  /**
   * Returns an array of the keys in this Set.
   */
  Local<Array> AsArray() const;

3402
  /**
3403
   * Creates a new empty Set.
3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414
   */
  static Local<Set> New(Isolate* isolate);

  V8_INLINE static Set* Cast(Value* obj);

 private:
  Set();
  static void CheckCast(Value* obj);
};


3415 3416 3417
template<typename T>
class ReturnValue {
 public:
3418
  template <class S> V8_INLINE ReturnValue(const ReturnValue<S>& that)
3419 3420 3421
      : value_(that.value_) {
    TYPE_CHECK(T, S);
  }
3422
  // Local setters
3423 3424 3425 3426 3427 3428 3429
  template <typename S>
  V8_INLINE V8_DEPRECATE_SOON("Use Global<> instead",
                              void Set(const Persistent<S>& handle));
  template <typename S>
  V8_INLINE void Set(const Global<S>& handle);
  template <typename S>
  V8_INLINE void Set(const Local<S> handle);
3430
  // Fast primitive setters
3431 3432 3433 3434
  V8_INLINE void Set(bool value);
  V8_INLINE void Set(double i);
  V8_INLINE void Set(int32_t i);
  V8_INLINE void Set(uint32_t i);
3435
  // Fast JS primitive setters
3436 3437 3438
  V8_INLINE void SetNull();
  V8_INLINE void SetUndefined();
  V8_INLINE void SetEmptyString();
3439
  // Convenience getter for Isolate
3440
  V8_INLINE Isolate* GetIsolate() const;
3441

3442 3443 3444 3445
  // Pointer setter: Uncompilable to prevent inadvertent misuse.
  template <typename S>
  V8_INLINE void Set(S* whatever);

3446 3447 3448 3449 3450
  // Getter. Creates a new Local<> so it comes with a certain performance
  // hit. If the ReturnValue was not yet set, this will return the undefined
  // value.
  V8_INLINE Local<Value> Get() const;

3451 3452 3453 3454
 private:
  template<class F> friend class ReturnValue;
  template<class F> friend class FunctionCallbackInfo;
  template<class F> friend class PropertyCallbackInfo;
3455 3456
  template <class F, class G, class H>
  friend class PersistentValueMapBase;
3457
  V8_INLINE void SetInternal(internal::Object* value) { *value_ = value; }
3458 3459
  V8_INLINE internal::Object* GetDefaultValue();
  V8_INLINE explicit ReturnValue(internal::Object** slot);
3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472
  internal::Object** value_;
};


/**
 * The argument information given to function call callbacks.  This
 * class provides access to information about the context of the call,
 * including the receiver, the number and values of arguments, and
 * the holder of the function.
 */
template<typename T>
class FunctionCallbackInfo {
 public:
3473 3474
  V8_INLINE int Length() const;
  V8_INLINE Local<Value> operator[](int i) const;
3475 3476
  V8_INLINE V8_DEPRECATED("Use Data() to explicitly pass Callee instead",
                          Local<Function> Callee() const);
3477 3478
  V8_INLINE Local<Object> This() const;
  V8_INLINE Local<Object> Holder() const;
3479
  V8_INLINE Local<Value> NewTarget() const;
3480 3481 3482 3483
  V8_INLINE bool IsConstructCall() const;
  V8_INLINE Local<Value> Data() const;
  V8_INLINE Isolate* GetIsolate() const;
  V8_INLINE ReturnValue<T> GetReturnValue() const;
3484
  // This shouldn't be public, but the arm compiler needs it.
3485
  static const int kArgsLength = 8;
3486 3487 3488 3489

 protected:
  friend class internal::FunctionCallbackArguments;
  friend class internal::CustomArguments<FunctionCallbackInfo>;
3490 3491 3492 3493 3494
  static const int kHolderIndex = 0;
  static const int kIsolateIndex = 1;
  static const int kReturnValueDefaultValueIndex = 2;
  static const int kReturnValueIndex = 3;
  static const int kDataIndex = 4;
3495 3496
  static const int kCalleeIndex = 5;
  static const int kContextSaveIndex = 6;
3497
  static const int kNewTargetIndex = 7;
3498

3499
  V8_INLINE FunctionCallbackInfo(internal::Object** implicit_args,
3500
                                 internal::Object** values, int length);
3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513
  internal::Object** implicit_args_;
  internal::Object** values_;
  int length_;
};


/**
 * The information passed to a property callback about the context
 * of the property access.
 */
template<typename T>
class PropertyCallbackInfo {
 public:
3514 3515 3516
  /**
   * \return The isolate of the property access.
   */
3517
  V8_INLINE Isolate* GetIsolate() const;
3518 3519 3520 3521 3522 3523

  /**
   * \return The data set in the configuration, i.e., in
   * `NamedPropertyHandlerConfiguration` or
   * `IndexedPropertyHandlerConfiguration.`
   */
3524
  V8_INLINE Local<Value> Data() const;
3525

3526 3527 3528
  /**
   * \return The receiver. In many cases, this is the object on which the
   * property access was intercepted. When using
neis's avatar
neis committed
3529
   * `Reflect.get`, `Function.prototype.call`, or similar functions, it is the
3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566
   * object passed in as receiver or thisArg.
   *
   * \code
   *  void GetterCallback(Local<Name> name,
   *                      const v8::PropertyCallbackInfo<v8::Value>& info) {
   *     auto context = info.GetIsolate()->GetCurrentContext();
   *
   *     v8::Local<v8::Value> a_this =
   *         info.This()
   *             ->GetRealNamedProperty(context, v8_str("a"))
   *             .ToLocalChecked();
   *     v8::Local<v8::Value> a_holder =
   *         info.Holder()
   *             ->GetRealNamedProperty(context, v8_str("a"))
   *             .ToLocalChecked();
   *
   *    CHECK(v8_str("r")->Equals(context, a_this).FromJust());
   *    CHECK(v8_str("obj")->Equals(context, a_holder).FromJust());
   *
   *    info.GetReturnValue().Set(name);
   *  }
   *
   *  v8::Local<v8::FunctionTemplate> templ =
   *  v8::FunctionTemplate::New(isolate);
   *  templ->InstanceTemplate()->SetHandler(
   *      v8::NamedPropertyHandlerConfiguration(GetterCallback));
   *  LocalContext env;
   *  env->Global()
   *      ->Set(env.local(), v8_str("obj"), templ->GetFunction(env.local())
   *                                           .ToLocalChecked()
   *                                           ->NewInstance(env.local())
   *                                           .ToLocalChecked())
   *      .FromJust();
   *
   *  CompileRun("obj.a = 'obj'; var r = {a: 'r'}; Reflect.get(obj, 'x', r)");
   * \endcode
   */
3567
  V8_INLINE Local<Object> This() const;
3568 3569 3570 3571 3572 3573 3574 3575 3576 3577

  /**
   * \return The object in the prototype chain of the receiver that has the
   * interceptor. Suppose you have `x` and its prototype is `y`, and `y`
   * has an interceptor. Then `info.This()` is `x` and `info.Holder()` is `y`.
   * The Holder() could be a hidden object (the global object, rather
   * than the global proxy).
   *
   * \note For security reasons, do not pass the object back into the runtime.
   */
3578
  V8_INLINE Local<Object> Holder() const;
3579 3580 3581 3582 3583 3584 3585 3586 3587

  /**
   * \return The return value of the callback.
   * Can be changed by calling Set().
   * \code
   * info.GetReturnValue().Set(...)
   * \endcode
   *
   */
3588
  V8_INLINE ReturnValue<T> GetReturnValue() const;
3589 3590 3591 3592 3593

  /**
   * \return True if the intercepted function should throw if an error occurs.
   * Usually, `true` corresponds to `'use strict'`.
   *
neis's avatar
neis committed
3594
   * \note Always `false` when intercepting `Reflect.set()`
3595 3596
   * independent of the language mode.
   */
3597
  V8_INLINE bool ShouldThrowOnError() const;
3598

3599
  // This shouldn't be public, but the arm compiler needs it.
3600
  static const int kArgsLength = 7;
3601 3602 3603 3604 3605

 protected:
  friend class MacroAssembler;
  friend class internal::PropertyCallbackArguments;
  friend class internal::CustomArguments<PropertyCallbackInfo>;
3606 3607 3608 3609 3610 3611 3612
  static const int kShouldThrowOnErrorIndex = 0;
  static const int kHolderIndex = 1;
  static const int kIsolateIndex = 2;
  static const int kReturnValueDefaultValueIndex = 3;
  static const int kReturnValueIndex = 4;
  static const int kDataIndex = 5;
  static const int kThisIndex = 6;
3613

3614
  V8_INLINE PropertyCallbackInfo(internal::Object** args) : args_(args) {}
3615 3616 3617 3618 3619 3620
  internal::Object** args_;
};


typedef void (*FunctionCallback)(const FunctionCallbackInfo<Value>& info);

3621
enum class ConstructorBehavior { kThrow, kAllow };
3622

3623
/**
3624
 * A JavaScript function object (ECMA-262, 15.3).
3625
 */
3626
class V8_EXPORT Function : public Object {
3627
 public:
3628 3629 3630 3631
  /**
   * Create a function in the current execution context
   * for a given FunctionCallback.
   */
3632 3633 3634 3635
  static MaybeLocal<Function> New(
      Local<Context> context, FunctionCallback callback,
      Local<Value> data = Local<Value>(), int length = 0,
      ConstructorBehavior behavior = ConstructorBehavior::kAllow);
3636 3637 3638 3639
  static V8_DEPRECATE_SOON(
      "Use maybe version",
      Local<Function> New(Isolate* isolate, FunctionCallback callback,
                          Local<Value> data = Local<Value>(), int length = 0));
3640

3641 3642
  V8_DEPRECATED("Use maybe version",
                Local<Object> NewInstance(int argc, Local<Value> argv[]) const);
3643
  V8_WARN_UNUSED_RESULT MaybeLocal<Object> NewInstance(
3644
      Local<Context> context, int argc, Local<Value> argv[]) const;
3645

3646
  V8_DEPRECATED("Use maybe version", Local<Object> NewInstance() const);
3647 3648
  V8_WARN_UNUSED_RESULT MaybeLocal<Object> NewInstance(
      Local<Context> context) const {
3649 3650 3651 3652
    return NewInstance(context, 0, nullptr);
  }

  V8_DEPRECATE_SOON("Use maybe version",
3653 3654
                    Local<Value> Call(Local<Value> recv, int argc,
                                      Local<Value> argv[]));
3655
  V8_WARN_UNUSED_RESULT MaybeLocal<Value> Call(Local<Context> context,
3656 3657
                                               Local<Value> recv, int argc,
                                               Local<Value> argv[]);
3658

3659 3660
  void SetName(Local<String> name);
  Local<Value> GetName() const;
3661

3662 3663 3664 3665 3666 3667
  /**
   * Name inferred from variable or property assignment of this function.
   * Used to facilitate debugging and profiling of JavaScript code written
   * in an OO style, where many functions are anonymous but are assigned
   * to object properties.
   */
3668
  Local<Value> GetInferredName() const;
3669

3670 3671 3672 3673 3674 3675
  /**
   * displayName if it is set, otherwise name if it is configured, otherwise
   * function name, otherwise inferred name.
   */
  Local<Value> GetDebugName() const;

3676 3677 3678 3679
  /**
   * User-defined name assigned to the "displayName" property of this function.
   * Used to facilitate debugging and profiling of JavaScript code.
   */
3680
  Local<Value> GetDisplayName() const;
3681

3682 3683 3684 3685
  /**
   * Returns zero based line number of function body and
   * kLineOffsetNotFound if no information available.
   */
3686
  int GetScriptLineNumber() const;
3687 3688 3689 3690
  /**
   * Returns zero based column number of function body and
   * kLineOffsetNotFound if no information available.
   */
3691
  int GetScriptColumnNumber() const;
3692

3693 3694 3695
  /**
   * Tells whether this function is builtin.
   */
3696
  V8_DEPRECATED("this should no longer be used.", bool IsBuiltin() const);
3697

3698 3699 3700 3701 3702
  /**
   * Returns scriptId.
   */
  int ScriptId() const;

3703 3704 3705 3706 3707 3708
  /**
   * Returns the original function if this function is bound, else returns
   * v8::Undefined.
   */
  Local<Value> GetBoundFunction() const;

3709
  ScriptOrigin GetScriptOrigin() const;
3710
  V8_INLINE static Function* Cast(Value* obj);
3711
  static const int kLineOffsetNotFound;
3712

3713
 private:
3714 3715
  Function();
  static void CheckCast(Value* obj);
3716 3717
};

3718 3719 3720 3721 3722 3723

/**
 * An instance of the built-in Promise constructor (ES6 draft).
 */
class V8_EXPORT Promise : public Object {
 public:
3724 3725 3726 3727 3728 3729
  /**
   * State of the promise. Each value corresponds to one of the possible values
   * of the [[PromiseState]] field.
   */
  enum PromiseState { kPending, kFulfilled, kRejected };

3730 3731 3732 3733 3734
  class V8_EXPORT Resolver : public Object {
   public:
    /**
     * Create a new resolver, along with an associated promise in pending state.
     */
3735 3736
    static V8_DEPRECATE_SOON("Use maybe version",
                             Local<Resolver> New(Isolate* isolate));
3737 3738
    static V8_WARN_UNUSED_RESULT MaybeLocal<Resolver> New(
        Local<Context> context);
3739

3740 3741 3742 3743 3744 3745 3746 3747 3748
    /**
     * Extract the associated promise.
     */
    Local<Promise> GetPromise();

    /**
     * Resolve/reject the associated promise with a given value.
     * Ignored if the promise is no longer pending.
     */
3749
    V8_DEPRECATE_SOON("Use maybe version", void Resolve(Local<Value> value));
3750
    // TODO(dcarney): mark V8_WARN_UNUSED_RESULT
3751
    Maybe<bool> Resolve(Local<Context> context, Local<Value> value);
3752

3753
    V8_DEPRECATE_SOON("Use maybe version", void Reject(Local<Value> value));
3754
    // TODO(dcarney): mark V8_WARN_UNUSED_RESULT
3755
    Maybe<bool> Reject(Local<Context> context, Local<Value> value);
3756 3757 3758 3759 3760 3761 3762

    V8_INLINE static Resolver* Cast(Value* obj);

   private:
    Resolver();
    static void CheckCast(Value* obj);
  };
3763 3764 3765 3766 3767 3768 3769

  /**
   * Register a resolution/rejection handler with a promise.
   * The handler is given the respective resolution/rejection value as
   * an argument. If the promise is already resolved/rejected, the handler is
   * invoked at the end of turn.
   */
3770 3771
  V8_DEPRECATED("Use maybe version",
                Local<Promise> Catch(Local<Function> handler));
3772
  V8_WARN_UNUSED_RESULT MaybeLocal<Promise> Catch(Local<Context> context,
3773
                                                  Local<Function> handler);
3774

3775 3776
  V8_DEPRECATED("Use maybe version",
                Local<Promise> Then(Local<Function> handler));
3777
  V8_WARN_UNUSED_RESULT MaybeLocal<Promise> Then(Local<Context> context,
3778
                                                 Local<Function> handler);
3779

3780 3781 3782 3783 3784 3785
  /**
   * Returns true if the promise has at least one derived promise, and
   * therefore resolve/reject handlers (including default handler).
   */
  bool HasHandler();

3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796
  /**
   * Returns the content of the [[PromiseResult]] field. The Promise must not
   * be pending.
   */
  Local<Value> Result();

  /**
   * Returns the value of the [[PromiseState]] field.
   */
  PromiseState State();

3797 3798 3799 3800 3801 3802 3803
  V8_INLINE static Promise* Cast(Value* obj);

 private:
  Promise();
  static void CheckCast(Value* obj);
};

3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875
/**
 * An instance of a Property Descriptor, see Ecma-262 6.2.4.
 *
 * Properties in a descriptor are present or absent. If you do not set
 * `enumerable`, `configurable`, and `writable`, they are absent. If `value`,
 * `get`, or `set` are absent, but you must specify them in the constructor, use
 * empty handles.
 *
 * Accessors `get` and `set` must be callable or undefined if they are present.
 *
 * \note Only query properties if they are present, i.e., call `x()` only if
 * `has_x()` returns true.
 *
 * \code
 * // var desc = {writable: false}
 * v8::PropertyDescriptor d(Local<Value>()), false);
 * d.value(); // error, value not set
 * if (d.has_writable()) {
 *   d.writable(); // false
 * }
 *
 * // var desc = {value: undefined}
 * v8::PropertyDescriptor d(v8::Undefined(isolate));
 *
 * // var desc = {get: undefined}
 * v8::PropertyDescriptor d(v8::Undefined(isolate), Local<Value>()));
 * \endcode
 */
class V8_EXPORT PropertyDescriptor {
 public:
  // GenericDescriptor
  PropertyDescriptor();

  // DataDescriptor
  PropertyDescriptor(Local<Value> value);

  // DataDescriptor with writable property
  PropertyDescriptor(Local<Value> value, bool writable);

  // AccessorDescriptor
  PropertyDescriptor(Local<Value> get, Local<Value> set);

  ~PropertyDescriptor();

  Local<Value> value() const;
  bool has_value() const;

  Local<Value> get() const;
  bool has_get() const;
  Local<Value> set() const;
  bool has_set() const;

  void set_enumerable(bool enumerable);
  bool enumerable() const;
  bool has_enumerable() const;

  void set_configurable(bool configurable);
  bool configurable() const;
  bool has_configurable() const;

  bool writable() const;
  bool has_writable() const;

  struct PrivateData;
  PrivateData* get_private() const { return private_; }

  PropertyDescriptor(const PropertyDescriptor&) = delete;
  void operator=(const PropertyDescriptor&) = delete;

 private:
  PrivateData* private_;
};
3876

3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888
/**
 * An instance of the built-in Proxy constructor (ECMA-262, 6th Edition,
 * 26.2.1).
 */
class V8_EXPORT Proxy : public Object {
 public:
  Local<Object> GetTarget();
  Local<Value> GetHandler();
  bool IsRevoked();
  void Revoke();

  /**
3889
   * Creates a new Proxy for the target object.
3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901
   */
  static MaybeLocal<Proxy> New(Local<Context> context,
                               Local<Object> local_target,
                               Local<Object> local_handler);

  V8_INLINE static Proxy* Cast(Value* obj);

 private:
  Proxy();
  static void CheckCast(Value* obj);
};

3902 3903 3904
class V8_EXPORT WasmCompiledModule : public Object {
 public:
  typedef std::pair<std::unique_ptr<const uint8_t[]>, size_t> SerializedModule;
3905 3906 3907 3908
  // A buffer that is owned by the caller.
  typedef std::pair<const uint8_t*, size_t> CallerOwnedBuffer;
  // Get the wasm-encoded bytes that were used to compile this module.
  Local<String> GetWasmWireBytes();
3909

3910 3911
  // Serialize the compiled module. The serialized data does not include the
  // uncompiled bytes.
3912
  SerializedModule Serialize();
3913 3914 3915 3916

  // If possible, deserialize the module, otherwise compile it from the provided
  // uncompiled bytes.
  static MaybeLocal<WasmCompiledModule> DeserializeOrCompile(
3917 3918
      Isolate* isolate, const CallerOwnedBuffer& serialized_module,
      const CallerOwnedBuffer& wire_bytes);
3919 3920 3921
  V8_INLINE static WasmCompiledModule* Cast(Value* obj);

 private:
3922
  static MaybeLocal<WasmCompiledModule> Deserialize(
3923 3924
      Isolate* isolate, const CallerOwnedBuffer& serialized_module,
      const CallerOwnedBuffer& wire_bytes);
3925
  static MaybeLocal<WasmCompiledModule> Compile(Isolate* isolate,
3926 3927
                                                const uint8_t* start,
                                                size_t length);
3928 3929 3930
  WasmCompiledModule();
  static void CheckCast(Value* obj);
};
3931

3932
#ifndef V8_ARRAY_BUFFER_INTERNAL_FIELD_COUNT
3933
// The number of required internal fields can be defined by embedder.
3934 3935
#define V8_ARRAY_BUFFER_INTERNAL_FIELD_COUNT 2
#endif
3936

3937 3938 3939 3940

enum class ArrayBufferCreationMode { kInternalized, kExternalized };


3941 3942 3943
/**
 * An instance of the built-in ArrayBuffer constructor (ES6 draft 15.13.5).
 */
3944
class V8_EXPORT ArrayBuffer : public Object {
3945
 public:
3946
  /**
3947
   * A thread-safe allocator that V8 uses to allocate |ArrayBuffer|'s memory.
3948 3949
   * The allocator is a global V8 setting. It has to be set via
   * Isolate::CreateParams.
3950
   *
3951 3952 3953 3954 3955 3956 3957 3958 3959
   * Memory allocated through this allocator by V8 is accounted for as external
   * memory by V8. Note that V8 keeps track of the memory for all internalized
   * |ArrayBuffer|s. Responsibility for tracking external memory (using
   * Isolate::AdjustAmountOfExternalAllocatedMemory) is handed over to the
   * embedder upon externalization and taken over upon internalization (creating
   * an internalized buffer from an existing buffer).
   *
   * Note that it is unsafe to call back into V8 from any of the allocator
   * functions.
3960
   */
3961
  class V8_EXPORT Allocator { // NOLINT
3962 3963 3964 3965 3966
   public:
    virtual ~Allocator() {}

    /**
     * Allocate |length| bytes. Return NULL if allocation is not successful.
3967
     * Memory should be initialized to zeroes.
3968 3969
     */
    virtual void* Allocate(size_t length) = 0;
3970 3971 3972 3973 3974

    /**
     * Allocate |length| bytes. Return NULL if allocation is not successful.
     * Memory does not have to be initialized.
     */
3975
    virtual void* AllocateUninitialized(size_t length) = 0;
3976

3977
    /**
3978 3979
     * Free the memory block of size |length|, pointed to by |data|.
     * That memory is guaranteed to be previously allocated by |Allocate|.
3980
     */
3981
    virtual void Free(void* data, size_t length) = 0;
3982 3983 3984 3985 3986 3987 3988

    /**
     * malloc/free based convenience allocator.
     *
     * Caller takes ownership.
     */
    static Allocator* NewDefaultAllocator();
3989 3990 3991 3992 3993 3994 3995 3996
  };

  /**
   * The contents of an |ArrayBuffer|. Externalization of |ArrayBuffer|
   * returns an instance of this class, populated, with a pointer to data
   * and byte length.
   *
   * The Data pointer of ArrayBuffer::Contents is always allocated with
3997
   * Allocator::Allocate that is set via Isolate::CreateParams.
3998
   */
3999
  class V8_EXPORT Contents { // NOLINT
4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013
   public:
    Contents() : data_(NULL), byte_length_(0) {}

    void* Data() const { return data_; }
    size_t ByteLength() const { return byte_length_; }

   private:
    void* data_;
    size_t byte_length_;

    friend class ArrayBuffer;
  };


4014 4015 4016 4017 4018 4019 4020 4021
  /**
   * Data length in bytes.
   */
  size_t ByteLength() const;

  /**
   * Create a new ArrayBuffer. Allocate |byte_length| bytes.
   * Allocated memory will be owned by a created ArrayBuffer and
4022 4023
   * will be deallocated when it is garbage-collected,
   * unless the object is externalized.
4024
   */
4025
  static Local<ArrayBuffer> New(Isolate* isolate, size_t byte_length);
4026 4027 4028

  /**
   * Create a new ArrayBuffer over an existing memory block.
4029
   * The created array buffer is by default immediately in externalized state.
4030 4031 4032
   * The memory block will not be reclaimed when a created ArrayBuffer
   * is garbage-collected.
   */
4033 4034 4035
  static Local<ArrayBuffer> New(
      Isolate* isolate, void* data, size_t byte_length,
      ArrayBufferCreationMode mode = ArrayBufferCreationMode::kExternalized);
4036

4037
  /**
binji's avatar
binji committed
4038
   * Returns true if ArrayBuffer is externalized, that is, does not
4039 4040 4041 4042
   * own its memory block.
   */
  bool IsExternal() const;

4043 4044 4045 4046 4047
  /**
   * Returns true if this ArrayBuffer may be neutered.
   */
  bool IsNeuterable() const;

4048 4049 4050 4051
  /**
   * Neuters this ArrayBuffer and all its views (typed arrays).
   * Neutering sets the byte length of the buffer and all typed arrays to zero,
   * preventing JavaScript from ever accessing underlying backing store.
4052
   * ArrayBuffer should have been externalized and must be neuterable.
4053 4054 4055
   */
  void Neuter();

4056
  /**
4057 4058
   * Make this ArrayBuffer external. The pointer to underlying memory block
   * and byte length are returned as |Contents| structure. After ArrayBuffer
4059
   * had been externalized, it does no longer own the memory block. The caller
4060 4061 4062
   * should take steps to free memory when it is no longer needed.
   *
   * The memory block is guaranteed to be allocated with |Allocator::Allocate|
4063
   * that has been set via Isolate::CreateParams.
4064
   */
4065
  Contents Externalize();
4066

4067 4068 4069
  /**
   * Get a pointer to the ArrayBuffer's underlying memory block without
   * externalizing it. If the ArrayBuffer is not externalized, this pointer
4070
   * will become invalid as soon as the ArrayBuffer gets garbage collected.
4071 4072 4073 4074 4075 4076 4077 4078
   *
   * The embedder should make sure to hold a strong reference to the
   * ArrayBuffer while accessing this pointer.
   *
   * The memory block is guaranteed to be allocated with |Allocator::Allocate|.
   */
  Contents GetContents();

4079
  V8_INLINE static ArrayBuffer* Cast(Value* obj);
4080

4081 4082
  static const int kInternalFieldCount = V8_ARRAY_BUFFER_INTERNAL_FIELD_COUNT;

4083 4084 4085 4086 4087 4088
 private:
  ArrayBuffer();
  static void CheckCast(Value* obj);
};


4089 4090 4091 4092 4093 4094
#ifndef V8_ARRAY_BUFFER_VIEW_INTERNAL_FIELD_COUNT
// The number of required internal fields can be defined by embedder.
#define V8_ARRAY_BUFFER_VIEW_INTERNAL_FIELD_COUNT 2
#endif


4095
/**
dslomov@chromium.org's avatar
dslomov@chromium.org committed
4096 4097
 * A base class for an instance of one of "views" over ArrayBuffer,
 * including TypedArrays and DataView (ES6 draft 15.13).
4098
 */
4099
class V8_EXPORT ArrayBufferView : public Object {
4100 4101 4102 4103 4104 4105
 public:
  /**
   * Returns underlying ArrayBuffer.
   */
  Local<ArrayBuffer> Buffer();
  /**
dslomov@chromium.org's avatar
dslomov@chromium.org committed
4106
   * Byte offset in |Buffer|.
4107 4108 4109
   */
  size_t ByteOffset();
  /**
dslomov@chromium.org's avatar
dslomov@chromium.org committed
4110
   * Size of a view in bytes.
4111 4112 4113
   */
  size_t ByteLength();

4114 4115 4116 4117 4118 4119
  /**
   * Copy the contents of the ArrayBufferView's buffer to an embedder defined
   * memory without additional overhead that calling ArrayBufferView::Buffer
   * might incur.
   *
   * Will write at most min(|byte_length|, ByteLength) bytes starting at
4120
   * ByteOffset of the underlying buffer to the memory starting at |dest|.
4121 4122 4123 4124
   * Returns the number of bytes actually written.
   */
  size_t CopyContents(void* dest, size_t byte_length);

4125 4126 4127 4128 4129 4130
  /**
   * Returns true if ArrayBufferView's backing ArrayBuffer has already been
   * allocated.
   */
  bool HasBuffer() const;

4131
  V8_INLINE static ArrayBufferView* Cast(Value* obj);
dslomov@chromium.org's avatar
dslomov@chromium.org committed
4132

4133 4134 4135
  static const int kInternalFieldCount =
      V8_ARRAY_BUFFER_VIEW_INTERNAL_FIELD_COUNT;

dslomov@chromium.org's avatar
dslomov@chromium.org committed
4136 4137 4138 4139 4140 4141 4142 4143 4144 4145
 private:
  ArrayBufferView();
  static void CheckCast(Value* obj);
};


/**
 * A base class for an instance of TypedArray series of constructors
 * (ES6 draft 15.13.6).
 */
4146
class V8_EXPORT TypedArray : public ArrayBufferView {
dslomov@chromium.org's avatar
dslomov@chromium.org committed
4147 4148 4149 4150 4151 4152 4153
 public:
  /**
   * Number of elements in this typed array
   * (e.g. for Int16Array, |ByteLength|/2).
   */
  size_t Length();

4154
  V8_INLINE static TypedArray* Cast(Value* obj);
4155 4156 4157 4158 4159 4160 4161 4162 4163 4164

 private:
  TypedArray();
  static void CheckCast(Value* obj);
};


/**
 * An instance of Uint8Array constructor (ES6 draft 15.13.6).
 */
4165
class V8_EXPORT Uint8Array : public TypedArray {
4166
 public:
4167
  static Local<Uint8Array> New(Local<ArrayBuffer> array_buffer,
4168
                               size_t byte_offset, size_t length);
4169
  static Local<Uint8Array> New(Local<SharedArrayBuffer> shared_array_buffer,
4170
                               size_t byte_offset, size_t length);
4171
  V8_INLINE static Uint8Array* Cast(Value* obj);
4172 4173 4174 4175 4176 4177 4178

 private:
  Uint8Array();
  static void CheckCast(Value* obj);
};


4179 4180 4181
/**
 * An instance of Uint8ClampedArray constructor (ES6 draft 15.13.6).
 */
4182
class V8_EXPORT Uint8ClampedArray : public TypedArray {
4183
 public:
4184 4185
  static Local<Uint8ClampedArray> New(Local<ArrayBuffer> array_buffer,
                                      size_t byte_offset, size_t length);
4186
  static Local<Uint8ClampedArray> New(
4187
      Local<SharedArrayBuffer> shared_array_buffer, size_t byte_offset,
4188
      size_t length);
4189
  V8_INLINE static Uint8ClampedArray* Cast(Value* obj);
4190 4191 4192 4193 4194 4195

 private:
  Uint8ClampedArray();
  static void CheckCast(Value* obj);
};

4196 4197 4198
/**
 * An instance of Int8Array constructor (ES6 draft 15.13.6).
 */
4199
class V8_EXPORT Int8Array : public TypedArray {
4200
 public:
4201 4202 4203
  static Local<Int8Array> New(Local<ArrayBuffer> array_buffer,
                              size_t byte_offset, size_t length);
  static Local<Int8Array> New(Local<SharedArrayBuffer> shared_array_buffer,
4204
                              size_t byte_offset, size_t length);
4205
  V8_INLINE static Int8Array* Cast(Value* obj);
4206 4207 4208 4209 4210 4211 4212 4213 4214 4215

 private:
  Int8Array();
  static void CheckCast(Value* obj);
};


/**
 * An instance of Uint16Array constructor (ES6 draft 15.13.6).
 */
4216
class V8_EXPORT Uint16Array : public TypedArray {
4217
 public:
4218 4219 4220
  static Local<Uint16Array> New(Local<ArrayBuffer> array_buffer,
                                size_t byte_offset, size_t length);
  static Local<Uint16Array> New(Local<SharedArrayBuffer> shared_array_buffer,
4221
                                size_t byte_offset, size_t length);
4222
  V8_INLINE static Uint16Array* Cast(Value* obj);
4223 4224 4225 4226 4227 4228 4229 4230 4231 4232

 private:
  Uint16Array();
  static void CheckCast(Value* obj);
};


/**
 * An instance of Int16Array constructor (ES6 draft 15.13.6).
 */
4233
class V8_EXPORT Int16Array : public TypedArray {
4234
 public:
4235
  static Local<Int16Array> New(Local<ArrayBuffer> array_buffer,
4236
                               size_t byte_offset, size_t length);
4237
  static Local<Int16Array> New(Local<SharedArrayBuffer> shared_array_buffer,
4238
                               size_t byte_offset, size_t length);
4239
  V8_INLINE static Int16Array* Cast(Value* obj);
4240 4241 4242 4243 4244 4245 4246 4247 4248 4249

 private:
  Int16Array();
  static void CheckCast(Value* obj);
};


/**
 * An instance of Uint32Array constructor (ES6 draft 15.13.6).
 */
4250
class V8_EXPORT Uint32Array : public TypedArray {
4251
 public:
4252 4253 4254
  static Local<Uint32Array> New(Local<ArrayBuffer> array_buffer,
                                size_t byte_offset, size_t length);
  static Local<Uint32Array> New(Local<SharedArrayBuffer> shared_array_buffer,
4255
                                size_t byte_offset, size_t length);
4256
  V8_INLINE static Uint32Array* Cast(Value* obj);
4257 4258 4259 4260 4261 4262 4263 4264 4265 4266

 private:
  Uint32Array();
  static void CheckCast(Value* obj);
};


/**
 * An instance of Int32Array constructor (ES6 draft 15.13.6).
 */
4267
class V8_EXPORT Int32Array : public TypedArray {
4268
 public:
4269
  static Local<Int32Array> New(Local<ArrayBuffer> array_buffer,
4270
                               size_t byte_offset, size_t length);
4271
  static Local<Int32Array> New(Local<SharedArrayBuffer> shared_array_buffer,
4272
                               size_t byte_offset, size_t length);
4273
  V8_INLINE static Int32Array* Cast(Value* obj);
4274 4275 4276 4277 4278 4279 4280 4281 4282 4283

 private:
  Int32Array();
  static void CheckCast(Value* obj);
};


/**
 * An instance of Float32Array constructor (ES6 draft 15.13.6).
 */
4284
class V8_EXPORT Float32Array : public TypedArray {
4285
 public:
4286 4287 4288
  static Local<Float32Array> New(Local<ArrayBuffer> array_buffer,
                                 size_t byte_offset, size_t length);
  static Local<Float32Array> New(Local<SharedArrayBuffer> shared_array_buffer,
4289
                                 size_t byte_offset, size_t length);
4290
  V8_INLINE static Float32Array* Cast(Value* obj);
4291 4292 4293 4294 4295 4296 4297 4298 4299 4300

 private:
  Float32Array();
  static void CheckCast(Value* obj);
};


/**
 * An instance of Float64Array constructor (ES6 draft 15.13.6).
 */
4301
class V8_EXPORT Float64Array : public TypedArray {
4302
 public:
4303 4304 4305
  static Local<Float64Array> New(Local<ArrayBuffer> array_buffer,
                                 size_t byte_offset, size_t length);
  static Local<Float64Array> New(Local<SharedArrayBuffer> shared_array_buffer,
4306
                                 size_t byte_offset, size_t length);
4307
  V8_INLINE static Float64Array* Cast(Value* obj);
4308 4309 4310 4311 4312 4313 4314

 private:
  Float64Array();
  static void CheckCast(Value* obj);
};


dslomov@chromium.org's avatar
dslomov@chromium.org committed
4315 4316 4317
/**
 * An instance of DataView constructor (ES6 draft 15.13.7).
 */
4318
class V8_EXPORT DataView : public ArrayBufferView {
dslomov@chromium.org's avatar
dslomov@chromium.org committed
4319
 public:
4320
  static Local<DataView> New(Local<ArrayBuffer> array_buffer,
dslomov@chromium.org's avatar
dslomov@chromium.org committed
4321
                             size_t byte_offset, size_t length);
4322
  static Local<DataView> New(Local<SharedArrayBuffer> shared_array_buffer,
4323
                             size_t byte_offset, size_t length);
4324
  V8_INLINE static DataView* Cast(Value* obj);
dslomov@chromium.org's avatar
dslomov@chromium.org committed
4325 4326 4327 4328 4329 4330 4331

 private:
  DataView();
  static void CheckCast(Value* obj);
};


binji's avatar
binji committed
4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395
/**
 * An instance of the built-in SharedArrayBuffer constructor.
 * This API is experimental and may change significantly.
 */
class V8_EXPORT SharedArrayBuffer : public Object {
 public:
  /**
   * The contents of an |SharedArrayBuffer|. Externalization of
   * |SharedArrayBuffer| returns an instance of this class, populated, with a
   * pointer to data and byte length.
   *
   * The Data pointer of SharedArrayBuffer::Contents is always allocated with
   * |ArrayBuffer::Allocator::Allocate| by the allocator specified in
   * v8::Isolate::CreateParams::array_buffer_allocator.
   *
   * This API is experimental and may change significantly.
   */
  class V8_EXPORT Contents {  // NOLINT
   public:
    Contents() : data_(NULL), byte_length_(0) {}

    void* Data() const { return data_; }
    size_t ByteLength() const { return byte_length_; }

   private:
    void* data_;
    size_t byte_length_;

    friend class SharedArrayBuffer;
  };


  /**
   * Data length in bytes.
   */
  size_t ByteLength() const;

  /**
   * Create a new SharedArrayBuffer. Allocate |byte_length| bytes.
   * Allocated memory will be owned by a created SharedArrayBuffer and
   * will be deallocated when it is garbage-collected,
   * unless the object is externalized.
   */
  static Local<SharedArrayBuffer> New(Isolate* isolate, size_t byte_length);

  /**
   * Create a new SharedArrayBuffer over an existing memory block.  The created
   * array buffer is immediately in externalized state unless otherwise
   * specified. The memory block will not be reclaimed when a created
   * SharedArrayBuffer is garbage-collected.
   */
  static Local<SharedArrayBuffer> New(
      Isolate* isolate, void* data, size_t byte_length,
      ArrayBufferCreationMode mode = ArrayBufferCreationMode::kExternalized);

  /**
   * Returns true if SharedArrayBuffer is externalized, that is, does not
   * own its memory block.
   */
  bool IsExternal() const;

  /**
   * Make this SharedArrayBuffer external. The pointer to underlying memory
   * block and byte length are returned as |Contents| structure. After
4396
   * SharedArrayBuffer had been externalized, it does no longer own the memory
binji's avatar
binji committed
4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430
   * block. The caller should take steps to free memory when it is no longer
   * needed.
   *
   * The memory block is guaranteed to be allocated with |Allocator::Allocate|
   * by the allocator specified in
   * v8::Isolate::CreateParams::array_buffer_allocator.
   *
   */
  Contents Externalize();

  /**
   * Get a pointer to the ArrayBuffer's underlying memory block without
   * externalizing it. If the ArrayBuffer is not externalized, this pointer
   * will become invalid as soon as the ArrayBuffer became garbage collected.
   *
   * The embedder should make sure to hold a strong reference to the
   * ArrayBuffer while accessing this pointer.
   *
   * The memory block is guaranteed to be allocated with |Allocator::Allocate|
   * by the allocator specified in
   * v8::Isolate::CreateParams::array_buffer_allocator.
   */
  Contents GetContents();

  V8_INLINE static SharedArrayBuffer* Cast(Value* obj);

  static const int kInternalFieldCount = V8_ARRAY_BUFFER_INTERNAL_FIELD_COUNT;

 private:
  SharedArrayBuffer();
  static void CheckCast(Value* obj);
};


4431 4432 4433
/**
 * An instance of the built-in Date constructor (ECMA-262, 15.9).
 */
4434
class V8_EXPORT Date : public Object {
4435
 public:
4436 4437
  static V8_DEPRECATE_SOON("Use maybe version.",
                           Local<Value> New(Isolate* isolate, double time));
4438 4439
  static V8_WARN_UNUSED_RESULT MaybeLocal<Value> New(Local<Context> context,
                                                     double time);
4440

4441 4442 4443 4444
  /**
   * A specialization of Value::NumberValue that is more efficient
   * because we know the structure of this object.
   */
4445
  double ValueOf() const;
4446

4447
  V8_INLINE static Date* Cast(Value* obj);
4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460

  /**
   * Notification that the embedder has changed the time zone,
   * daylight savings time, or other date / time configuration
   * parameters.  V8 keeps a cache of various values used for
   * date / time computation.  This notification will reset
   * those cached values for the current context so that date /
   * time configuration changes would be reflected in the Date
   * object.
   *
   * This API should not be called more than needed as it will
   * negatively impact the performance of date operations.
   */
4461
  static void DateTimeConfigurationChangeNotification(Isolate* isolate);
4462 4463

 private:
4464
  static void CheckCast(Value* obj);
4465 4466 4467
};


4468 4469 4470
/**
 * A Number object (ECMA-262, 4.3.21).
 */
4471
class V8_EXPORT NumberObject : public Object {
4472
 public:
4473
  static Local<Value> New(Isolate* isolate, double value);
4474 4475

  double ValueOf() const;
4476

4477
  V8_INLINE static NumberObject* Cast(Value* obj);
4478 4479

 private:
4480
  static void CheckCast(Value* obj);
4481 4482 4483 4484 4485 4486
};


/**
 * A Boolean object (ECMA-262, 4.3.15).
 */
4487
class V8_EXPORT BooleanObject : public Object {
4488
 public:
4489
  static Local<Value> New(Isolate* isolate, bool value);
4490
  V8_DEPRECATED("Pass an isolate", static Local<Value> New(bool value));
4491

4492
  bool ValueOf() const;
4493

4494
  V8_INLINE static BooleanObject* Cast(Value* obj);
4495 4496

 private:
4497
  static void CheckCast(Value* obj);
4498 4499 4500 4501 4502 4503
};


/**
 * A String object (ECMA-262, 4.3.18).
 */
4504
class V8_EXPORT StringObject : public Object {
4505
 public:
4506
  static Local<Value> New(Local<String> value);
4507

4508
  Local<String> ValueOf() const;
4509

4510
  V8_INLINE static StringObject* Cast(Value* obj);
4511 4512

 private:
4513
  static void CheckCast(Value* obj);
4514 4515 4516
};


4517 4518 4519
/**
 * A Symbol object (ECMA-262 edition 6).
 */
4520
class V8_EXPORT SymbolObject : public Object {
4521
 public:
4522
  static Local<Value> New(Isolate* isolate, Local<Symbol> value);
4523

4524
  Local<Symbol> ValueOf() const;
4525

4526
  V8_INLINE static SymbolObject* Cast(Value* obj);
4527 4528

 private:
4529
  static void CheckCast(Value* obj);
4530 4531 4532
};


4533 4534 4535
/**
 * An instance of the built-in RegExp constructor (ECMA-262, 15.10).
 */
4536
class V8_EXPORT RegExp : public Object {
4537 4538 4539 4540 4541 4542 4543 4544 4545
 public:
  /**
   * Regular expression flag bits. They can be or'ed to enable a set
   * of flags.
   */
  enum Flags {
    kNone = 0,
    kGlobal = 1,
    kIgnoreCase = 2,
4546 4547 4548
    kMultiline = 4,
    kSticky = 8,
    kUnicode = 16
4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560
  };

  /**
   * Creates a regular expression from the given pattern string and
   * the flags bit field. May throw a JavaScript exception as
   * described in ECMA-262, 15.10.4.1.
   *
   * For example,
   *   RegExp::New(v8::String::New("foo"),
   *               static_cast<RegExp::Flags>(kGlobal | kMultiline))
   * is equivalent to evaluating "/foo/gm".
   */
4561
  static V8_DEPRECATE_SOON("Use maybe version",
4562
                           Local<RegExp> New(Local<String> pattern,
4563
                                             Flags flags));
4564
  static V8_WARN_UNUSED_RESULT MaybeLocal<RegExp> New(Local<Context> context,
4565
                                                      Local<String> pattern,
4566
                                                      Flags flags);
4567 4568 4569 4570 4571

  /**
   * Returns the value of the source property: a string representing
   * the regular expression.
   */
4572
  Local<String> GetSource() const;
4573 4574 4575 4576

  /**
   * Returns the flags bit field.
   */
4577
  Flags GetFlags() const;
4578

4579
  V8_INLINE static RegExp* Cast(Value* obj);
4580 4581

 private:
4582
  static void CheckCast(Value* obj);
4583 4584 4585
};


4586
/**
4587 4588
 * A JavaScript value that wraps a C++ void*. This type of value is mainly used
 * to associate C++ data structures with JavaScript objects.
4589
 */
4590
class V8_EXPORT External : public Value {
4591
 public:
4592
  static Local<External> New(Isolate* isolate, void* value);
4593
  V8_INLINE static External* Cast(Value* obj);
4594
  void* Value() const;
4595
 private:
4596
  static void CheckCast(v8::Value* obj);
4597 4598
};

4599 4600 4601 4602 4603
#define V8_INTRINSICS_LIST(F)                    \
  F(ArrayProto_entries, array_entries_iterator)  \
  F(ArrayProto_forEach, array_for_each_iterator) \
  F(ArrayProto_keys, array_keys_iterator)        \
  F(ArrayProto_values, array_values_iterator)
4604 4605 4606 4607 4608 4609 4610 4611

enum Intrinsic {
#define V8_DECL_INTRINSIC(name, iname) k##name,
  V8_INTRINSICS_LIST(V8_DECL_INTRINSIC)
#undef V8_DECL_INTRINSIC
};


4612
// --- Templates ---
4613 4614 4615 4616 4617


/**
 * The superclass of object and function templates.
 */
4618
class V8_EXPORT Template : public Data {
4619
 public:
4620 4621 4622 4623 4624
  /**
   * Adds a property to each instance created by this template.
   *
   * The property must be defined either as a primitive value, or a template.
   */
4625
  void Set(Local<Name> name, Local<Data> value,
4626
           PropertyAttribute attributes = None);
4627 4628
  void SetPrivate(Local<Private> name, Local<Data> value,
                  PropertyAttribute attributes = None);
4629
  V8_INLINE void Set(Isolate* isolate, const char* name, Local<Data> value);
4630 4631

  void SetAccessorProperty(
4632
     Local<Name> name,
4633 4634 4635 4636 4637
     Local<FunctionTemplate> getter = Local<FunctionTemplate>(),
     Local<FunctionTemplate> setter = Local<FunctionTemplate>(),
     PropertyAttribute attribute = None,
     AccessControl settings = DEFAULT);

4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664
  /**
   * Whenever the property with the given name is accessed on objects
   * created from this Template the getter and setter callbacks
   * are called instead of getting and setting the property directly
   * on the JavaScript object.
   *
   * \param name The name of the property for which an accessor is added.
   * \param getter The callback to invoke when getting the property.
   * \param setter The callback to invoke when setting the property.
   * \param data A piece of data that will be passed to the getter and setter
   *   callbacks whenever they are invoked.
   * \param settings Access control settings for the accessor. This is a bit
   *   field consisting of one of more of
   *   DEFAULT = 0, ALL_CAN_READ = 1, or ALL_CAN_WRITE = 2.
   *   The default is to not allow cross-context access.
   *   ALL_CAN_READ means that all cross-context reads are allowed.
   *   ALL_CAN_WRITE means that all cross-context writes are allowed.
   *   The combination ALL_CAN_READ | ALL_CAN_WRITE can be used to allow all
   *   cross-context access.
   * \param attribute The attributes of the property for which an accessor
   *   is added.
   * \param signature The signature describes valid receivers for the accessor
   *   and is used to perform implicit instance checks against them. If the
   *   receiver is incompatible (i.e. is not an instance of the constructor as
   *   defined by FunctionTemplate::HasInstance()), an implicit TypeError is
   *   thrown and no callback is invoked.
   */
4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678
  void SetNativeDataProperty(
      Local<String> name, AccessorGetterCallback getter,
      AccessorSetterCallback setter = 0,
      // TODO(dcarney): gcc can't handle Local below
      Local<Value> data = Local<Value>(), PropertyAttribute attribute = None,
      Local<AccessorSignature> signature = Local<AccessorSignature>(),
      AccessControl settings = DEFAULT);
  void SetNativeDataProperty(
      Local<Name> name, AccessorNameGetterCallback getter,
      AccessorNameSetterCallback setter = 0,
      // TODO(dcarney): gcc can't handle Local below
      Local<Value> data = Local<Value>(), PropertyAttribute attribute = None,
      Local<AccessorSignature> signature = Local<AccessorSignature>(),
      AccessControl settings = DEFAULT);
4679

4680 4681 4682 4683 4684 4685 4686 4687
  /**
   * Like SetNativeDataProperty, but V8 will replace the native data property
   * with a real data property on first access.
   */
  void SetLazyDataProperty(Local<Name> name, AccessorNameGetterCallback getter,
                           Local<Value> data = Local<Value>(),
                           PropertyAttribute attribute = None);

4688 4689 4690 4691 4692 4693 4694
  /**
   * During template instantiation, sets the value with the intrinsic property
   * from the correct context.
   */
  void SetIntrinsicDataProperty(Local<Name> name, Intrinsic intrinsic,
                                PropertyAttribute attribute = None);

4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706
 private:
  Template();

  friend class ObjectTemplate;
  friend class FunctionTemplate;
};


/**
 * NamedProperty[Getter|Setter] are used as interceptors on object.
 * See ObjectTemplate::SetNamedPropertyHandler.
 */
4707 4708 4709
typedef void (*NamedPropertyGetterCallback)(
    Local<String> property,
    const PropertyCallbackInfo<Value>& info);
4710 4711 4712 4713 4714 4715


/**
 * Returns the value if the setter intercepts the request.
 * Otherwise, returns an empty handle.
 */
4716 4717 4718 4719 4720
typedef void (*NamedPropertySetterCallback)(
    Local<String> property,
    Local<Value> value,
    const PropertyCallbackInfo<Value>& info);

4721 4722 4723

/**
 * Returns a non-empty handle if the interceptor intercepts the request.
4724 4725
 * The result is an integer encoding property attributes (like v8::None,
 * v8::DontEnum, etc.)
4726
 */
4727 4728 4729
typedef void (*NamedPropertyQueryCallback)(
    Local<String> property,
    const PropertyCallbackInfo<Integer>& info);
4730 4731 4732 4733


/**
 * Returns a non-empty handle if the deleter intercepts the request.
4734 4735
 * The return value is true if the property could be deleted and false
 * otherwise.
4736
 */
4737 4738 4739 4740
typedef void (*NamedPropertyDeleterCallback)(
    Local<String> property,
    const PropertyCallbackInfo<Boolean>& info);

4741 4742

/**
4743 4744
 * Returns an array containing the names of the properties the named
 * property getter intercepts.
4745
 */
4746 4747
typedef void (*NamedPropertyEnumeratorCallback)(
    const PropertyCallbackInfo<Array>& info);
4748

4749

4750 4751
// TODO(dcarney): Deprecate and remove previous typedefs, and replace
// GenericNamedPropertyFooCallback with just NamedPropertyFooCallback.
4752

4753
/**
4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786
 * Interceptor for get requests on an object.
 *
 * Use `info.GetReturnValue().Set()` to set the return value of the
 * intercepted get request.
 *
 * \param property The name of the property for which the request was
 * intercepted.
 * \param info Information about the intercepted request, such as
 * isolate, receiver, return value, or whether running in `'use strict`' mode.
 * See `PropertyCallbackInfo`.
 *
 * \code
 *  void GetterCallback(
 *    Local<Name> name,
 *    const v8::PropertyCallbackInfo<v8::Value>& info) {
 *      info.GetReturnValue().Set(v8_num(42));
 *  }
 *
 *  v8::Local<v8::FunctionTemplate> templ =
 *      v8::FunctionTemplate::New(isolate);
 *  templ->InstanceTemplate()->SetHandler(
 *      v8::NamedPropertyHandlerConfiguration(GetterCallback));
 *  LocalContext env;
 *  env->Global()
 *      ->Set(env.local(), v8_str("obj"), templ->GetFunction(env.local())
 *                                             .ToLocalChecked()
 *                                             ->NewInstance(env.local())
 *                                             .ToLocalChecked())
 *      .FromJust();
 *  v8::Local<v8::Value> result = CompileRun("obj.a = 17; obj.a");
 *  CHECK(v8_num(42)->Equals(env.local(), result).FromJust());
 * \endcode
 *
4787
 * See also `ObjectTemplate::SetHandler`.
4788 4789 4790 4791 4792
 */
typedef void (*GenericNamedPropertyGetterCallback)(
    Local<Name> property, const PropertyCallbackInfo<Value>& info);

/**
4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810
 * Interceptor for set requests on an object.
 *
 * Use `info.GetReturnValue()` to indicate whether the request was intercepted
 * or not. If the setter successfully intercepts the request, i.e., if the
 * request should not be further executed, call
 * `info.GetReturnValue().Set(value)`. If the setter
 * did not intercept the request, i.e., if the request should be handled as
 * if no interceptor is present, do not not call `Set()`.
 *
 * \param property The name of the property for which the request was
 * intercepted.
 * \param value The value which the property will have if the request
 * is not intercepted.
 * \param info Information about the intercepted request, such as
 * isolate, receiver, return value, or whether running in `'use strict'` mode.
 * See `PropertyCallbackInfo`.
 *
 * See also
4811
 * `ObjectTemplate::SetHandler.`
4812 4813 4814 4815 4816 4817
 */
typedef void (*GenericNamedPropertySetterCallback)(
    Local<Name> property, Local<Value> value,
    const PropertyCallbackInfo<Value>& info);

/**
4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835
 * Intercepts all requests that query the attributes of the
 * property, e.g., getOwnPropertyDescriptor(), propertyIsEnumerable(), and
 * defineProperty().
 *
 * Use `info.GetReturnValue().Set(value)` to set the property attributes. The
 * value is an interger encoding a `v8::PropertyAttribute`.
 *
 * \param property The name of the property for which the request was
 * intercepted.
 * \param info Information about the intercepted request, such as
 * isolate, receiver, return value, or whether running in `'use strict'` mode.
 * See `PropertyCallbackInfo`.
 *
 * \note Some functions query the property attributes internally, even though
 * they do not return the attributes. For example, `hasOwnProperty()` can
 * trigger this interceptor depending on the state of the object.
 *
 * See also
4836
 * `ObjectTemplate::SetHandler.`
4837 4838 4839 4840 4841
 */
typedef void (*GenericNamedPropertyQueryCallback)(
    Local<Name> property, const PropertyCallbackInfo<Integer>& info);

/**
4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859
 * Interceptor for delete requests on an object.
 *
 * Use `info.GetReturnValue()` to indicate whether the request was intercepted
 * or not. If the deleter successfully intercepts the request, i.e., if the
 * request should not be further executed, call
 * `info.GetReturnValue().Set(value)` with a boolean `value`. The `value` is
 * used as the return value of `delete`.
 *
 * \param property The name of the property for which the request was
 * intercepted.
 * \param info Information about the intercepted request, such as
 * isolate, receiver, return value, or whether running in `'use strict'` mode.
 * See `PropertyCallbackInfo`.
 *
 * \note If you need to mimic the behavior of `delete`, i.e., throw in strict
 * mode instead of returning false, use `info.ShouldThrowOnError()` to determine
 * if you are in strict mode.
 *
4860
 * See also `ObjectTemplate::SetHandler.`
4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872
 */
typedef void (*GenericNamedPropertyDeleterCallback)(
    Local<Name> property, const PropertyCallbackInfo<Boolean>& info);


/**
 * Returns an array containing the names of the properties the named
 * property getter intercepts.
 */
typedef void (*GenericNamedPropertyEnumeratorCallback)(
    const PropertyCallbackInfo<Array>& info);

4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890
/**
 * Interceptor for defineProperty requests on an object.
 *
 * Use `info.GetReturnValue()` to indicate whether the request was intercepted
 * or not. If the definer successfully intercepts the request, i.e., if the
 * request should not be further executed, call
 * `info.GetReturnValue().Set(value)`. If the definer
 * did not intercept the request, i.e., if the request should be handled as
 * if no interceptor is present, do not not call `Set()`.
 *
 * \param property The name of the property for which the request was
 * intercepted.
 * \param desc The property descriptor which is used to define the
 * property if the request is not intercepted.
 * \param info Information about the intercepted request, such as
 * isolate, receiver, return value, or whether running in `'use strict'` mode.
 * See `PropertyCallbackInfo`.
 *
4891
 * See also `ObjectTemplate::SetHandler`.
4892 4893
 */
typedef void (*GenericNamedPropertyDefinerCallback)(
4894
    Local<Name> property, const PropertyDescriptor& desc,
4895
    const PropertyCallbackInfo<Value>& info);
4896

4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913
/**
 * Interceptor for getOwnPropertyDescriptor requests on an object.
 *
 * Use `info.GetReturnValue().Set()` to set the return value of the
 * intercepted request. The return value must be an object that
 * can be converted to a PropertyDescriptor, e.g., a `v8::value` returned from
 * `v8::Object::getOwnPropertyDescriptor`.
 *
 * \param property The name of the property for which the request was
 * intercepted.
 * \info Information about the intercepted request, such as
 * isolate, receiver, return value, or whether running in `'use strict'` mode.
 * See `PropertyCallbackInfo`.
 *
 * \note If GetOwnPropertyDescriptor is intercepted, it will
 * always return true, i.e., indicate that the property was found.
 *
4914
 * See also `ObjectTemplate::SetHandler`.
4915 4916 4917 4918
 */
typedef void (*GenericNamedPropertyDescriptorCallback)(
    Local<Name> property, const PropertyCallbackInfo<Value>& info);

4919
/**
4920
 * See `v8::GenericNamedPropertyGetterCallback`.
4921
 */
4922 4923 4924
typedef void (*IndexedPropertyGetterCallback)(
    uint32_t index,
    const PropertyCallbackInfo<Value>& info);
4925 4926

/**
4927
 * See `v8::GenericNamedPropertySetterCallback`.
4928
 */
4929 4930 4931 4932
typedef void (*IndexedPropertySetterCallback)(
    uint32_t index,
    Local<Value> value,
    const PropertyCallbackInfo<Value>& info);
4933 4934

/**
4935
 * See `v8::GenericNamedPropertyQueryCallback`.
4936
 */
4937 4938 4939 4940
typedef void (*IndexedPropertyQueryCallback)(
    uint32_t index,
    const PropertyCallbackInfo<Integer>& info);

4941
/**
4942
 * See `v8::GenericNamedPropertyDeleterCallback`.
4943
 */
4944 4945 4946 4947
typedef void (*IndexedPropertyDeleterCallback)(
    uint32_t index,
    const PropertyCallbackInfo<Boolean>& info);

4948
/**
4949
 * See `v8::GenericNamedPropertyEnumeratorCallback`.
4950
 */
4951 4952
typedef void (*IndexedPropertyEnumeratorCallback)(
    const PropertyCallbackInfo<Array>& info);
4953

4954 4955 4956
/**
 * See `v8::GenericNamedPropertyDefinerCallback`.
 */
4957 4958 4959
typedef void (*IndexedPropertyDefinerCallback)(
    uint32_t index, const PropertyDescriptor& desc,
    const PropertyCallbackInfo<Value>& info);
4960

4961 4962 4963
/**
 * See `v8::GenericNamedPropertyDescriptorCallback`.
 */
4964 4965 4966
typedef void (*IndexedPropertyDescriptorCallback)(
    uint32_t index, const PropertyCallbackInfo<Value>& info);

4967
/**
4968
 * Access type specification.
4969 4970 4971 4972 4973 4974 4975 4976 4977
 */
enum AccessType {
  ACCESS_GET,
  ACCESS_SET,
  ACCESS_HAS,
  ACCESS_DELETE,
  ACCESS_KEYS
};

4978

4979 4980 4981 4982 4983
/**
 * Returns true if the given context should be allowed to access the given
 * object.
 */
typedef bool (*AccessCheckCallback)(Local<Context> accessing_context,
4984 4985
                                    Local<Object> accessed_object,
                                    Local<Value> data);
4986 4987

/**
4988
 * A FunctionTemplate is used to create functions at runtime. There
4989
 * can only be one function created from a FunctionTemplate in a
4990 4991 4992 4993
 * context.  The lifetime of the created function is equal to the
 * lifetime of the context.  So in case the embedder needs to create
 * temporary functions that can be collected using Scripts is
 * preferred.
4994
 *
4995
 * Any modification of a FunctionTemplate after first instantiation will trigger
4996
 * a crash.
4997
 *
4998
 * A FunctionTemplate can have properties, these properties are added to the
4999
 * function object when it is created.
5000
 *
5001 5002 5003 5004
 * A FunctionTemplate has a corresponding instance template which is
 * used to create object instances when the function is used as a
 * constructor. Properties added to the instance template are added to
 * each object instance.
5005 5006 5007 5008
 *
 * A FunctionTemplate can have a prototype template. The prototype template
 * is used to create the prototype object of the function.
 *
5009
 * The following example shows how to use a FunctionTemplate:
5010
 *
5011
 * \code
5012 5013
 *    v8::Local<v8::FunctionTemplate> t = v8::FunctionTemplate::New(isolate);
 *    t->Set(isolate, "func_property", v8::Number::New(isolate, 1));
5014 5015
 *
 *    v8::Local<v8::Template> proto_t = t->PrototypeTemplate();
5016 5017 5018 5019
 *    proto_t->Set(isolate,
 *                 "proto_method",
 *                 v8::FunctionTemplate::New(isolate, InvokeCallback));
 *    proto_t->Set(isolate, "proto_const", v8::Number::New(isolate, 2));
5020 5021
 *
 *    v8::Local<v8::ObjectTemplate> instance_t = t->InstanceTemplate();
5022 5023 5024 5025 5026
 *    instance_t->SetAccessor(String::NewFromUtf8(isolate, "instance_accessor"),
 *                            InstanceAccessorCallback);
 *    instance_t->SetNamedPropertyHandler(PropertyHandlerCallback);
 *    instance_t->Set(String::NewFromUtf8(isolate, "instance_property"),
 *                    Number::New(isolate, 3));
5027 5028 5029
 *
 *    v8::Local<v8::Function> function = t->GetFunction();
 *    v8::Local<v8::Object> instance = function->NewInstance();
5030
 * \endcode
5031 5032
 *
 * Let's use "function" as the JS variable name of the function object
5033 5034
 * and "instance" for the instance object created above.  The function
 * and the instance will have the following properties:
5035
 *
5036 5037 5038
 * \code
 *   func_property in function == true;
 *   function.func_property == 1;
5039
 *
5040 5041
 *   function.prototype.proto_method() invokes 'InvokeCallback'
 *   function.prototype.proto_const == 2;
5042
 *
5043 5044 5045 5046
 *   instance instanceof function == true;
 *   instance.instance_accessor calls 'InstanceAccessorCallback'
 *   instance.instance_property == 3;
 * \endcode
5047
 *
5048 5049 5050
 * A FunctionTemplate can inherit from another one by calling the
 * FunctionTemplate::Inherit method.  The following graph illustrates
 * the semantics of inheritance:
5051
 *
5052 5053 5054 5055 5056 5057 5058
 * \code
 *   FunctionTemplate Parent  -> Parent() . prototype -> { }
 *     ^                                                  ^
 *     | Inherit(Parent)                                  | .__proto__
 *     |                                                  |
 *   FunctionTemplate Child   -> Child()  . prototype -> { }
 * \endcode
5059
 *
5060 5061 5062 5063
 * A FunctionTemplate 'Child' inherits from 'Parent', the prototype
 * object of the Child() function has __proto__ pointing to the
 * Parent() function's prototype object. An instance of the Child
 * function has all properties on Parent's instance templates.
5064
 *
5065 5066
 * Let Parent be the FunctionTemplate initialized in the previous
 * section and create a Child FunctionTemplate by:
5067
 *
5068
 * \code
5069 5070 5071 5072 5073 5074
 *   Local<FunctionTemplate> parent = t;
 *   Local<FunctionTemplate> child = FunctionTemplate::New();
 *   child->Inherit(parent);
 *
 *   Local<Function> child_function = child->GetFunction();
 *   Local<Object> child_instance = child_function->NewInstance();
5075 5076 5077 5078
 * \endcode
 *
 * The Child function and Child instance will have the following
 * properties:
5079
 *
5080
 * \code
5081
 *   child_func.prototype.__proto__ == function.prototype;
5082
 *   child_instance.instance_accessor calls 'InstanceAccessorCallback'
5083
 *   child_instance.instance_property == 3;
5084
 * \endcode
5085
 */
5086
class V8_EXPORT FunctionTemplate : public Template {
5087 5088
 public:
  /** Creates a function template.*/
5089
  static Local<FunctionTemplate> New(
5090 5091
      Isolate* isolate, FunctionCallback callback = 0,
      Local<Value> data = Local<Value>(),
5092 5093
      Local<Signature> signature = Local<Signature>(), int length = 0,
      ConstructorBehavior behavior = ConstructorBehavior::kAllow);
5094

5095
  /** Get a template included in the snapshot by index. */
5096 5097
  static MaybeLocal<FunctionTemplate> FromSnapshot(Isolate* isolate,
                                                   size_t index);
5098

5099 5100 5101 5102 5103 5104 5105 5106
  /**
   * Creates a function template backed/cached by a private property.
   */
  static Local<FunctionTemplate> NewWithCache(
      Isolate* isolate, FunctionCallback callback,
      Local<Private> cache_property, Local<Value> data = Local<Value>(),
      Local<Signature> signature = Local<Signature>(), int length = 0);

5107
  /** Returns the unique function instance in the current execution context.*/
5108
  V8_DEPRECATE_SOON("Use maybe version", Local<Function> GetFunction());
5109 5110
  V8_WARN_UNUSED_RESULT MaybeLocal<Function> GetFunction(
      Local<Context> context);
5111

5112 5113 5114 5115 5116 5117 5118 5119 5120
  /**
   * Similar to Context::NewRemoteContext, this creates an instance that
   * isn't backed by an actual object.
   *
   * The InstanceTemplate of this FunctionTemplate must have access checks with
   * handlers installed.
   */
  V8_WARN_UNUSED_RESULT MaybeLocal<Object> NewRemoteInstance();

5121 5122 5123 5124 5125
  /**
   * Set the call-handler callback for a FunctionTemplate.  This
   * callback is called whenever the function created from this
   * FunctionTemplate is called.
   */
5126 5127
  void SetCallHandler(FunctionCallback callback,
                      Local<Value> data = Local<Value>());
5128

5129 5130 5131
  /** Set the predefined length property for the FunctionTemplate. */
  void SetLength(int length);

5132
  /** Get the InstanceTemplate. */
5133 5134
  Local<ObjectTemplate> InstanceTemplate();

5135 5136 5137 5138 5139
  /**
   * Causes the function template to inherit from a parent function template.
   * This means the the function's prototype.__proto__ is set to the parent
   * function's prototype.
   **/
5140
  void Inherit(Local<FunctionTemplate> parent);
5141 5142 5143 5144 5145 5146 5147

  /**
   * A PrototypeTemplate is the template used to create the prototype object
   * of the function created by this template.
   */
  Local<ObjectTemplate> PrototypeTemplate();

5148 5149 5150 5151 5152 5153 5154 5155
  /**
   * A PrototypeProviderTemplate is another function template whose prototype
   * property is used for this template. This is mutually exclusive with setting
   * a prototype template indirectly by calling PrototypeTemplate() or using
   * Inherit().
   **/
  void SetPrototypeProviderTemplate(Local<FunctionTemplate> prototype_provider);

5156 5157 5158 5159 5160
  /**
   * Set the class name of the FunctionTemplate.  This is used for
   * printing objects created with the function created from the
   * FunctionTemplate as its constructor.
   */
5161
  void SetClassName(Local<String> name);
5162

5163 5164 5165 5166 5167 5168 5169

  /**
   * When set to true, no access check will be performed on the receiver of a
   * function call.  Currently defaults to true, but this is subject to change.
   */
  void SetAcceptAnyReceiver(bool value);

5170
  /**
5171 5172 5173 5174 5175 5176 5177 5178 5179 5180
   * Determines whether the __proto__ accessor ignores instances of
   * the function template.  If instances of the function template are
   * ignored, __proto__ skips all instances and instead returns the
   * next object in the prototype chain.
   *
   * Call with a value of true to make the __proto__ accessor ignore
   * instances of the function template.  Call with a value of false
   * to make the __proto__ accessor not ignore instances of the
   * function template.  By default, instances of a function template
   * are not ignored.
5181 5182 5183
   */
  void SetHiddenPrototype(bool value);

5184
  /**
5185 5186
   * Sets the ReadOnly flag in the attributes of the 'prototype' property
   * of functions created from this FunctionTemplate to true.
5187
   */
5188
  void ReadOnlyPrototype();
5189

5190 5191 5192 5193 5194 5195
  /**
   * Removes the prototype property from functions created from this
   * FunctionTemplate.
   */
  void RemovePrototype();

5196
  /**
5197 5198
   * Returns true if the given object is an instance of this function
   * template.
5199
   */
5200
  bool HasInstance(Local<Value> object);
5201 5202 5203 5204 5205 5206 5207

 private:
  FunctionTemplate();
  friend class Context;
  friend class ObjectTemplate;
};

5208 5209 5210 5211
/**
 * Configuration flags for v8::NamedPropertyHandlerConfiguration or
 * v8::IndexedPropertyHandlerConfiguration.
 */
5212
enum class PropertyHandlerFlags {
5213 5214 5215
  /**
   * None.
   */
5216
  kNone = 0,
5217 5218 5219 5220

  /**
   * See ALL_CAN_READ above.
   */
5221
  kAllCanRead = 1,
5222 5223 5224 5225 5226

  /** Will not call into interceptor for properties on the receiver or prototype
   * chain, i.e., only call into interceptor for properties that do not exist.
   * Currently only valid for named interceptors.
   */
5227
  kNonMasking = 1 << 1,
5228 5229 5230 5231 5232

  /**
   * Will not call into interceptor for symbol lookup.  Only meaningful for
   * named interceptors.
   */
5233 5234
  kOnlyInterceptStrings = 1 << 2,
};
5235

5236 5237
struct NamedPropertyHandlerConfiguration {
  NamedPropertyHandlerConfiguration(
5238
      /** Note: getter is required */
5239 5240 5241 5242 5243
      GenericNamedPropertyGetterCallback getter = 0,
      GenericNamedPropertySetterCallback setter = 0,
      GenericNamedPropertyQueryCallback query = 0,
      GenericNamedPropertyDeleterCallback deleter = 0,
      GenericNamedPropertyEnumeratorCallback enumerator = 0,
5244
      Local<Value> data = Local<Value>(),
5245
      PropertyHandlerFlags flags = PropertyHandlerFlags::kNone)
5246 5247 5248 5249 5250
      : getter(getter),
        setter(setter),
        query(query),
        deleter(deleter),
        enumerator(enumerator),
5251
        definer(0),
5252
        descriptor(0),
5253 5254 5255 5256 5257 5258
        data(data),
        flags(flags) {}

  NamedPropertyHandlerConfiguration(
      GenericNamedPropertyGetterCallback getter,
      GenericNamedPropertySetterCallback setter,
5259
      GenericNamedPropertyDescriptorCallback descriptor,
5260 5261 5262 5263 5264 5265 5266
      GenericNamedPropertyDeleterCallback deleter,
      GenericNamedPropertyEnumeratorCallback enumerator,
      GenericNamedPropertyDefinerCallback definer,
      Local<Value> data = Local<Value>(),
      PropertyHandlerFlags flags = PropertyHandlerFlags::kNone)
      : getter(getter),
        setter(setter),
5267
        query(0),
5268 5269 5270
        deleter(deleter),
        enumerator(enumerator),
        definer(definer),
5271
        descriptor(descriptor),
5272 5273
        data(data),
        flags(flags) {}
5274 5275 5276 5277 5278 5279

  GenericNamedPropertyGetterCallback getter;
  GenericNamedPropertySetterCallback setter;
  GenericNamedPropertyQueryCallback query;
  GenericNamedPropertyDeleterCallback deleter;
  GenericNamedPropertyEnumeratorCallback enumerator;
5280
  GenericNamedPropertyDefinerCallback definer;
5281
  GenericNamedPropertyDescriptorCallback descriptor;
5282
  Local<Value> data;
5283
  PropertyHandlerFlags flags;
5284 5285 5286
};


5287 5288
struct IndexedPropertyHandlerConfiguration {
  IndexedPropertyHandlerConfiguration(
5289
      /** Note: getter is required */
5290 5291 5292 5293 5294
      IndexedPropertyGetterCallback getter = 0,
      IndexedPropertySetterCallback setter = 0,
      IndexedPropertyQueryCallback query = 0,
      IndexedPropertyDeleterCallback deleter = 0,
      IndexedPropertyEnumeratorCallback enumerator = 0,
5295
      Local<Value> data = Local<Value>(),
5296
      PropertyHandlerFlags flags = PropertyHandlerFlags::kNone)
5297 5298 5299 5300 5301
      : getter(getter),
        setter(setter),
        query(query),
        deleter(deleter),
        enumerator(enumerator),
5302
        definer(0),
5303
        descriptor(0),
5304 5305 5306 5307 5308
        data(data),
        flags(flags) {}

  IndexedPropertyHandlerConfiguration(
      IndexedPropertyGetterCallback getter,
5309 5310
      IndexedPropertySetterCallback setter,
      IndexedPropertyDescriptorCallback descriptor,
5311 5312 5313 5314 5315 5316 5317
      IndexedPropertyDeleterCallback deleter,
      IndexedPropertyEnumeratorCallback enumerator,
      IndexedPropertyDefinerCallback definer,
      Local<Value> data = Local<Value>(),
      PropertyHandlerFlags flags = PropertyHandlerFlags::kNone)
      : getter(getter),
        setter(setter),
5318
        query(0),
5319 5320 5321
        deleter(deleter),
        enumerator(enumerator),
        definer(definer),
5322
        descriptor(descriptor),
5323 5324
        data(data),
        flags(flags) {}
5325 5326 5327 5328 5329 5330

  IndexedPropertyGetterCallback getter;
  IndexedPropertySetterCallback setter;
  IndexedPropertyQueryCallback query;
  IndexedPropertyDeleterCallback deleter;
  IndexedPropertyEnumeratorCallback enumerator;
5331
  IndexedPropertyDefinerCallback definer;
5332
  IndexedPropertyDescriptorCallback descriptor;
5333
  Local<Value> data;
5334
  PropertyHandlerFlags flags;
5335 5336 5337
};


5338
/**
5339 5340 5341 5342
 * An ObjectTemplate is used to create objects at runtime.
 *
 * Properties added to an ObjectTemplate are added to each object
 * created from the ObjectTemplate.
5343
 */
5344
class V8_EXPORT ObjectTemplate : public Template {
5345
 public:
5346
  /** Creates an ObjectTemplate. */
5347 5348
  static Local<ObjectTemplate> New(
      Isolate* isolate,
5349
      Local<FunctionTemplate> constructor = Local<FunctionTemplate>());
5350
  static V8_DEPRECATED("Use isolate version", Local<ObjectTemplate> New());
5351

5352
  /** Get a template included in the snapshot by index. */
5353 5354
  static MaybeLocal<ObjectTemplate> FromSnapshot(Isolate* isolate,
                                                 size_t index);
5355

5356
  /** Creates a new instance of this template.*/
5357
  V8_DEPRECATE_SOON("Use maybe version", Local<Object> NewInstance());
5358
  V8_WARN_UNUSED_RESULT MaybeLocal<Object> NewInstance(Local<Context> context);
5359 5360 5361

  /**
   * Sets an accessor on the object template.
5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375
   *
   * Whenever the property with the given name is accessed on objects
   * created from this ObjectTemplate the getter and setter callbacks
   * are called instead of getting and setting the property directly
   * on the JavaScript object.
   *
   * \param name The name of the property for which an accessor is added.
   * \param getter The callback to invoke when getting the property.
   * \param setter The callback to invoke when setting the property.
   * \param data A piece of data that will be passed to the getter and setter
   *   callbacks whenever they are invoked.
   * \param settings Access control settings for the accessor. This is a bit
   *   field consisting of one of more of
   *   DEFAULT = 0, ALL_CAN_READ = 1, or ALL_CAN_WRITE = 2.
5376 5377 5378
   *   The default is to not allow cross-context access.
   *   ALL_CAN_READ means that all cross-context reads are allowed.
   *   ALL_CAN_WRITE means that all cross-context writes are allowed.
5379
   *   The combination ALL_CAN_READ | ALL_CAN_WRITE can be used to allow all
5380
   *   cross-context access.
5381 5382
   * \param attribute The attributes of the property for which an accessor
   *   is added.
5383 5384 5385 5386 5387
   * \param signature The signature describes valid receivers for the accessor
   *   and is used to perform implicit instance checks against them. If the
   *   receiver is incompatible (i.e. is not an instance of the constructor as
   *   defined by FunctionTemplate::HasInstance()), an implicit TypeError is
   *   thrown and no callback is invoked.
5388
   */
5389 5390 5391 5392 5393 5394 5395 5396 5397 5398
  void SetAccessor(
      Local<String> name, AccessorGetterCallback getter,
      AccessorSetterCallback setter = 0, Local<Value> data = Local<Value>(),
      AccessControl settings = DEFAULT, PropertyAttribute attribute = None,
      Local<AccessorSignature> signature = Local<AccessorSignature>());
  void SetAccessor(
      Local<Name> name, AccessorNameGetterCallback getter,
      AccessorNameSetterCallback setter = 0, Local<Value> data = Local<Value>(),
      AccessControl settings = DEFAULT, PropertyAttribute attribute = None,
      Local<AccessorSignature> signature = Local<AccessorSignature>());
5399 5400 5401

  /**
   * Sets a named property handler on the object template.
5402
   *
5403 5404
   * Whenever a property whose name is a string is accessed on objects created
   * from this object template, the provided callback is invoked instead of
5405 5406
   * accessing the property directly on the JavaScript object.
   *
5407 5408 5409 5410
   * SetNamedPropertyHandler() is different from SetHandler(), in
   * that the latter can intercept symbol-named properties as well as
   * string-named properties when called with a
   * NamedPropertyHandlerConfiguration. New code should use SetHandler().
5411
   *
5412 5413
   * \param getter The callback to invoke when getting a property.
   * \param setter The callback to invoke when setting a property.
5414 5415
   * \param query The callback to invoke to check if a property is present,
   *   and if present, get its attributes.
5416 5417 5418 5419 5420
   * \param deleter The callback to invoke when deleting a property.
   * \param enumerator The callback to invoke to enumerate all the named
   *   properties of an object.
   * \param data A piece of data that will be passed to the callbacks
   *   whenever they are invoked.
5421
   */
5422
  // TODO(dcarney): deprecate
5423 5424 5425 5426 5427 5428
  void SetNamedPropertyHandler(NamedPropertyGetterCallback getter,
                               NamedPropertySetterCallback setter = 0,
                               NamedPropertyQueryCallback query = 0,
                               NamedPropertyDeleterCallback deleter = 0,
                               NamedPropertyEnumeratorCallback enumerator = 0,
                               Local<Value> data = Local<Value>());
5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440

  /**
   * Sets a named property handler on the object template.
   *
   * Whenever a property whose name is a string or a symbol is accessed on
   * objects created from this object template, the provided callback is
   * invoked instead of accessing the property directly on the JavaScript
   * object.
   *
   * @param configuration The NamedPropertyHandlerConfiguration that defines the
   * callbacks to invoke when accessing a property.
   */
5441
  void SetHandler(const NamedPropertyHandlerConfiguration& configuration);
5442 5443 5444

  /**
   * Sets an indexed property handler on the object template.
5445 5446 5447 5448 5449 5450 5451
   *
   * Whenever an indexed property is accessed on objects created from
   * this object template, the provided callback is invoked instead of
   * accessing the property directly on the JavaScript object.
   *
   * \param getter The callback to invoke when getting a property.
   * \param setter The callback to invoke when setting a property.
5452
   * \param query The callback to invoke to check if an object has a property.
5453 5454 5455 5456 5457
   * \param deleter The callback to invoke when deleting a property.
   * \param enumerator The callback to invoke to enumerate all the indexed
   *   properties of an object.
   * \param data A piece of data that will be passed to the callbacks
   *   whenever they are invoked.
5458
   */
5459
  // TODO(dcarney): deprecate
5460 5461 5462 5463 5464 5465
  void SetIndexedPropertyHandler(
      IndexedPropertyGetterCallback getter,
      IndexedPropertySetterCallback setter = 0,
      IndexedPropertyQueryCallback query = 0,
      IndexedPropertyDeleterCallback deleter = 0,
      IndexedPropertyEnumeratorCallback enumerator = 0,
5466
      Local<Value> data = Local<Value>()) {
5467 5468 5469
    SetHandler(IndexedPropertyHandlerConfiguration(getter, setter, query,
                                                   deleter, enumerator, data));
  }
5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480

  /**
   * Sets an indexed property handler on the object template.
   *
   * Whenever an indexed property is accessed on objects created from
   * this object template, the provided callback is invoked instead of
   * accessing the property directly on the JavaScript object.
   *
   * @param configuration The IndexedPropertyHandlerConfiguration that defines
   * the callbacks to invoke when accessing a property.
   */
5481 5482
  void SetHandler(const IndexedPropertyHandlerConfiguration& configuration);

5483 5484 5485
  /**
   * Sets the callback to be used when calling instances created from
   * this template as a function.  If no callback is set, instances
5486
   * behave like normal JavaScript objects that cannot be called as a
5487 5488
   * function.
   */
5489
  void SetCallAsFunctionHandler(FunctionCallback callback,
5490
                                Local<Value> data = Local<Value>());
5491

5492 5493 5494 5495 5496 5497 5498 5499
  /**
   * Mark object instances of the template as undetectable.
   *
   * In many ways, undetectable objects behave as though they are not
   * there.  They behave like 'undefined' in conditionals and when
   * printed.  However, properties can be accessed and called as on
   * normal objects.
   */
5500 5501
  void MarkAsUndetectable();

5502
  /**
5503 5504
   * Sets access check callback on the object template and enables access
   * checks.
5505 5506 5507
   *
   * When accessing properties on instances of this object template,
   * the access check callback will be called to determine whether or
5508
   * not to allow cross-context access to the properties.
5509
   */
5510 5511
  void SetAccessCheckCallback(AccessCheckCallback callback,
                              Local<Value> data = Local<Value>());
5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524

  /**
   * Like SetAccessCheckCallback but invokes an interceptor on failed access
   * checks instead of looking up all-can-read properties. You can only use
   * either this method or SetAccessCheckCallback, but not both at the same
   * time.
   */
  void SetAccessCheckCallbackAndHandler(
      AccessCheckCallback callback,
      const NamedPropertyHandlerConfiguration& named_handler,
      const IndexedPropertyHandlerConfiguration& indexed_handler,
      Local<Value> data = Local<Value>());

5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536
  /**
   * Gets the number of internal fields for objects generated from
   * this template.
   */
  int InternalFieldCount();

  /**
   * Sets the number of internal fields for objects generated from
   * this template.
   */
  void SetInternalFieldCount(int value);

5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547
  /**
   * Returns true if the object will be an immutable prototype exotic object.
   */
  bool IsImmutableProto();

  /**
   * Makes the ObjectTempate for an immutable prototype exotic object, with an
   * immutable __proto__.
   */
  void SetImmutableProto();

5548 5549
 private:
  ObjectTemplate();
5550
  static Local<ObjectTemplate> New(internal::Isolate* isolate,
5551
                                   Local<FunctionTemplate> constructor);
5552 5553 5554 5555 5556
  friend class FunctionTemplate;
};


/**
5557
 * A Signature specifies which receiver is valid for a function.
5558
 */
5559
class V8_EXPORT Signature : public Data {
5560
 public:
5561 5562
  static Local<Signature> New(
      Isolate* isolate,
5563
      Local<FunctionTemplate> receiver = Local<FunctionTemplate>());
5564

5565 5566 5567 5568 5569
 private:
  Signature();
};


5570 5571 5572 5573
/**
 * An AccessorSignature specifies which receivers are valid parameters
 * to an accessor callback.
 */
5574
class V8_EXPORT AccessorSignature : public Data {
5575
 public:
5576 5577 5578
  static Local<AccessorSignature> New(
      Isolate* isolate,
      Local<FunctionTemplate> receiver = Local<FunctionTemplate>());
5579

5580 5581 5582 5583 5584
 private:
  AccessorSignature();
};


5585
// --- Extensions ---
5586

5587 5588
class V8_EXPORT ExternalOneByteStringResourceImpl
    : public String::ExternalOneByteStringResource {
5589
 public:
5590 5591
  ExternalOneByteStringResourceImpl() : data_(0), length_(0) {}
  ExternalOneByteStringResourceImpl(const char* data, size_t length)
5592 5593 5594 5595 5596 5597 5598 5599
      : data_(data), length_(length) {}
  const char* data() const { return data_; }
  size_t length() const { return length_; }

 private:
  const char* data_;
  size_t length_;
};
5600 5601 5602 5603

/**
 * Ignore
 */
5604
class V8_EXPORT Extension {  // NOLINT
5605
 public:
5606 5607
  // Note that the strings passed into this constructor must live as long
  // as the Extension itself.
5608
  Extension(const char* name,
5609
            const char* source = 0,
5610
            int dep_count = 0,
5611 5612
            const char** deps = 0,
            int source_length = -1);
5613
  virtual ~Extension() { }
5614 5615 5616
  virtual Local<FunctionTemplate> GetNativeFunctionTemplate(
      Isolate* isolate, Local<String> name) {
    return Local<FunctionTemplate>();
5617 5618
  }

5619 5620
  const char* name() const { return name_; }
  size_t source_length() const { return source_length_; }
5621
  const String::ExternalOneByteStringResource* source() const {
5622
    return &source_; }
5623 5624 5625 5626 5627
  int dependency_count() { return dep_count_; }
  const char** dependencies() { return deps_; }
  void set_auto_enable(bool value) { auto_enable_ = value; }
  bool auto_enable() { return auto_enable_; }

5628 5629 5630 5631
  // Disallow copying and assigning.
  Extension(const Extension&) = delete;
  void operator=(const Extension&) = delete;

5632 5633
 private:
  const char* name_;
5634
  size_t source_length_;  // expected to initialize before source_
5635
  ExternalOneByteStringResourceImpl source_;
5636 5637 5638 5639 5640 5641
  int dep_count_;
  const char** deps_;
  bool auto_enable_;
};


5642
void V8_EXPORT RegisterExtension(Extension* extension);
5643 5644


5645
// --- Statics ---
5646

5647 5648 5649 5650
V8_INLINE Local<Primitive> Undefined(Isolate* isolate);
V8_INLINE Local<Primitive> Null(Isolate* isolate);
V8_INLINE Local<Boolean> True(Isolate* isolate);
V8_INLINE Local<Boolean> False(Isolate* isolate);
5651 5652

/**
5653 5654 5655 5656 5657 5658 5659
 * A set of constraints that specifies the limits of the runtime's memory use.
 * You must set the heap size before initializing the VM - the size cannot be
 * adjusted after the VM is initialized.
 *
 * If you are using threads then you should hold the V8::Locker lock while
 * setting the stack limit and you must set a non-default stack limit separately
 * for each thread.
5660 5661 5662
 *
 * The arguments for set_max_semi_space_size, set_max_old_space_size,
 * set_max_executable_size, set_code_range_size specify limits in MB.
5663
 */
5664
class V8_EXPORT ResourceConstraints {
5665 5666
 public:
  ResourceConstraints();
5667 5668 5669 5670 5671 5672 5673

  /**
   * Configures the constraints with reasonable default values based on the
   * capabilities of the current device the VM is running on.
   *
   * \param physical_memory The total amount of physical memory on the current
   *   device, in bytes.
5674 5675
   * \param virtual_memory_limit The amount of virtual memory on the current
   *   device, in bytes, or zero, if there is no limit.
5676
   */
5677 5678 5679
  void ConfigureDefaults(uint64_t physical_memory,
                         uint64_t virtual_memory_limit);

5680
  int max_semi_space_size() const { return max_semi_space_size_; }
5681 5682 5683
  void set_max_semi_space_size(int limit_in_mb) {
    max_semi_space_size_ = limit_in_mb;
  }
5684
  int max_old_space_size() const { return max_old_space_size_; }
5685 5686 5687
  void set_max_old_space_size(int limit_in_mb) {
    max_old_space_size_ = limit_in_mb;
  }
5688
  int max_executable_size() const { return max_executable_size_; }
5689 5690 5691
  void set_max_executable_size(int limit_in_mb) {
    max_executable_size_ = limit_in_mb;
  }
5692
  uint32_t* stack_limit() const { return stack_limit_; }
5693
  // Sets an address beyond which the VM's stack may not grow.
5694
  void set_stack_limit(uint32_t* value) { stack_limit_ = value; }
5695
  size_t code_range_size() const { return code_range_size_; }
5696 5697
  void set_code_range_size(size_t limit_in_mb) {
    code_range_size_ = limit_in_mb;
5698
  }
5699 5700 5701 5702
  size_t max_zone_pool_size() const { return max_zone_pool_size_; }
  void set_max_zone_pool_size(const size_t bytes) {
    max_zone_pool_size_ = bytes;
  }
5703

5704
 private:
5705
  int max_semi_space_size_;
5706
  int max_old_space_size_;
5707
  int max_executable_size_;
5708
  uint32_t* stack_limit_;
5709
  size_t code_range_size_;
5710
  size_t max_zone_pool_size_;
5711 5712 5713
};


5714
// --- Exceptions ---
5715 5716 5717 5718


typedef void (*FatalErrorCallback)(const char* location, const char* message);

5719
typedef void (*OOMErrorCallback)(const char* location, bool is_heap_oom);
5720

5721
typedef void (*MessageCallback)(Local<Message> message, Local<Value> data);
5722

5723 5724 5725
// --- Tracing ---

typedef void (*LogEventCallback)(const char* name, int event);
5726 5727 5728 5729 5730

/**
 * Create new error objects by calling the corresponding error object
 * constructor with the message.
 */
5731
class V8_EXPORT Exception {
5732
 public:
5733 5734 5735 5736 5737
  static Local<Value> RangeError(Local<String> message);
  static Local<Value> ReferenceError(Local<String> message);
  static Local<Value> SyntaxError(Local<String> message);
  static Local<Value> TypeError(Local<String> message);
  static Local<Value> Error(Local<String> message);
5738

5739 5740 5741 5742 5743
  /**
   * Creates an error message for the given exception.
   * Will try to reconstruct the original stack trace from the exception value,
   * or capture the current stack trace if not available.
   */
5744
  static Local<Message> CreateMessage(Isolate* isolate, Local<Value> exception);
5745 5746
  V8_DEPRECATED("Use version with an Isolate*",
                static Local<Message> CreateMessage(Local<Value> exception));
5747

5748 5749 5750 5751
  /**
   * Returns the original stack trace that was captured at the creation time
   * of a given exception, or an empty handle if not available.
   */
5752
  static Local<StackTrace> GetStackTrace(Local<Value> exception);
5753 5754 5755
};


5756
// --- Counters Callbacks ---
5757

5758
typedef int* (*CounterLookupCallback)(const char* name);
5759

5760 5761 5762 5763 5764 5765 5766
typedef void* (*CreateHistogramCallback)(const char* name,
                                         int min,
                                         int max,
                                         size_t buckets);

typedef void (*AddHistogramSampleCallback)(void* histogram, int sample);

5767
// --- Memory Allocation Callback ---
5768 5769
enum ObjectSpace {
  kObjectSpaceNewSpace = 1 << 0,
5770 5771 5772
  kObjectSpaceOldSpace = 1 << 1,
  kObjectSpaceCodeSpace = 1 << 2,
  kObjectSpaceMapSpace = 1 << 3,
5773
  kObjectSpaceLoSpace = 1 << 4,
5774 5775 5776
  kObjectSpaceAll = kObjectSpaceNewSpace | kObjectSpaceOldSpace |
                    kObjectSpaceCodeSpace | kObjectSpaceMapSpace |
                    kObjectSpaceLoSpace
5777
};
5778 5779 5780 5781 5782 5783 5784

  enum AllocationAction {
    kAllocationActionAllocate = 1 << 0,
    kAllocationActionFree = 1 << 1,
    kAllocationActionAll = kAllocationActionAllocate | kAllocationActionFree
  };

5785 5786 5787 5788
// --- Enter/Leave Script Callback ---
typedef void (*BeforeCallEnteredCallback)(Isolate*);
typedef void (*CallCompletedCallback)(Isolate*);
typedef void (*DeprecatedCallCompletedCallback)();
5789

5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810
/**
 * PromiseHook with type kInit is called when a new promise is
 * created. When a new promise is created as part of the chain in the
 * case of Promise.then or in the intermediate promises created by
 * Promise.{race, all}/AsyncFunctionAwait, we pass the parent promise
 * otherwise we pass undefined.
 *
 * PromiseHook with type kResolve is called at the beginning of
 * resolve or reject function defined by CreateResolvingFunctions.
 *
 * PromiseHook with type kBefore is called at the beginning of the
 * PromiseReactionJob.
 *
 * PromiseHook with type kAfter is called right at the end of the
 * PromiseReactionJob.
 */
enum class PromiseHookType { kInit, kResolve, kBefore, kAfter };

typedef void (*PromiseHook)(PromiseHookType type, Local<Promise> promise,
                            Local<Value> parent);

5811 5812 5813 5814 5815 5816
// --- Promise Reject Callback ---
enum PromiseRejectEvent {
  kPromiseRejectWithNoHandler = 0,
  kPromiseHandlerAddedAfterReject = 1
};

5817 5818
class PromiseRejectMessage {
 public:
5819 5820
  PromiseRejectMessage(Local<Promise> promise, PromiseRejectEvent event,
                       Local<Value> value, Local<StackTrace> stack_trace)
5821 5822 5823 5824 5825
      : promise_(promise),
        event_(event),
        value_(value),
        stack_trace_(stack_trace) {}

5826
  V8_INLINE Local<Promise> GetPromise() const { return promise_; }
5827
  V8_INLINE PromiseRejectEvent GetEvent() const { return event_; }
5828
  V8_INLINE Local<Value> GetValue() const { return value_; }
5829

5830 5831 5832 5833
  V8_DEPRECATED("Use v8::Exception::CreateMessage(GetValue())->GetStackTrace()",
                V8_INLINE Local<StackTrace> GetStackTrace() const) {
    return stack_trace_;
  }
5834 5835

 private:
5836
  Local<Promise> promise_;
5837
  PromiseRejectEvent event_;
5838 5839
  Local<Value> value_;
  Local<StackTrace> stack_trace_;
5840 5841 5842
};

typedef void (*PromiseRejectCallback)(PromiseRejectMessage message);
5843

5844 5845
// --- Microtasks Callbacks ---
typedef void (*MicrotasksCompletedCallback)(Isolate*);
5846 5847
typedef void (*MicrotaskCallback)(void* data);

5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884

/**
 * Policy for running microtasks:
 *   - explicit: microtasks are invoked with Isolate::RunMicrotasks() method;
 *   - scoped: microtasks invocation is controlled by MicrotasksScope objects;
 *   - auto: microtasks are invoked when the script call depth decrements
 *           to zero.
 */
enum class MicrotasksPolicy { kExplicit, kScoped, kAuto };


/**
 * This scope is used to control microtasks when kScopeMicrotasksInvocation
 * is used on Isolate. In this mode every non-primitive call to V8 should be
 * done inside some MicrotasksScope.
 * Microtasks are executed when topmost MicrotasksScope marked as kRunMicrotasks
 * exits.
 * kDoNotRunMicrotasks should be used to annotate calls not intended to trigger
 * microtasks.
 */
class V8_EXPORT MicrotasksScope {
 public:
  enum Type { kRunMicrotasks, kDoNotRunMicrotasks };

  MicrotasksScope(Isolate* isolate, Type type);
  ~MicrotasksScope();

  /**
   * Runs microtasks if no kRunMicrotasks scope is currently active.
   */
  static void PerformCheckpoint(Isolate* isolate);

  /**
   * Returns current depth of nested kRunMicrotasks scopes.
   */
  static int GetCurrentDepth(Isolate* isolate);

5885 5886 5887 5888 5889
  /**
   * Returns true while microtasks are being executed.
   */
  static bool IsRunningMicrotasks(Isolate* isolate);

5890 5891 5892 5893
  // Prevent copying.
  MicrotasksScope(const MicrotasksScope&) = delete;
  MicrotasksScope& operator=(const MicrotasksScope&) = delete;

5894 5895 5896 5897 5898 5899
 private:
  internal::Isolate* const isolate_;
  bool run_;
};


5900
// --- Failed Access Check Callback ---
5901 5902 5903 5904
typedef void (*FailedAccessCheckCallback)(Local<Object> target,
                                          AccessType type,
                                          Local<Value> data);

5905 5906 5907 5908 5909 5910 5911 5912
// --- AllowCodeGenerationFromStrings callbacks ---

/**
 * Callback to check if code generation from strings is allowed. See
 * Context::AllowCodeGenerationFromStrings.
 */
typedef bool (*AllowCodeGenerationFromStringsCallback)(Local<Context> context);

5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927
// --- WASM compilation callbacks ---

/**
 * Callback to check if a buffer source may be compiled to WASM, given
 * the compilation is attempted as a promise or not.
 */

typedef bool (*AllowWasmCompileCallback)(Isolate* isolate, Local<Value> source,
                                         bool as_promise);

typedef bool (*AllowWasmInstantiateCallback)(Isolate* isolate,
                                             Local<Value> module_or_bytes,
                                             MaybeLocal<Value> ffi,
                                             bool as_promise);

5928
// --- Garbage Collection Callbacks ---
5929 5930

/**
5931 5932 5933 5934 5935
 * Applications can register callback functions which will be called before and
 * after certain garbage collection operations.  Allocations are not allowed in
 * the callback functions, you therefore cannot manipulate objects (set or
 * delete properties for example) since it is possible such operations will
 * result in the allocation of objects.
5936
 */
5937 5938 5939
enum GCType {
  kGCTypeScavenge = 1 << 0,
  kGCTypeMarkSweepCompact = 1 << 1,
5940 5941 5942 5943
  kGCTypeIncrementalMarking = 1 << 2,
  kGCTypeProcessWeakCallbacks = 1 << 3,
  kGCTypeAll = kGCTypeScavenge | kGCTypeMarkSweepCompact |
               kGCTypeIncrementalMarking | kGCTypeProcessWeakCallbacks
5944 5945
};

5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957
/**
 * GCCallbackFlags is used to notify additional information about the GC
 * callback.
 *   - kGCCallbackFlagConstructRetainedObjectInfos: The GC callback is for
 *     constructing retained object infos.
 *   - kGCCallbackFlagForced: The GC callback is for a forced GC for testing.
 *   - kGCCallbackFlagSynchronousPhantomCallbackProcessing: The GC callback
 *     is called synchronously without getting posted to an idle task.
 *   - kGCCallbackFlagCollectAllAvailableGarbage: The GC callback is called
 *     in a phase where V8 is trying to collect all available garbage
 *     (e.g., handling a low memory notification).
 */
5958 5959
enum GCCallbackFlags {
  kNoGCCallbackFlags = 0,
5960
  kGCCallbackFlagConstructRetainedObjectInfos = 1 << 1,
5961
  kGCCallbackFlagForced = 1 << 2,
5962 5963
  kGCCallbackFlagSynchronousPhantomCallbackProcessing = 1 << 3,
  kGCCallbackFlagCollectAllAvailableGarbage = 1 << 4,
5964
  kGCCallbackFlagCollectAllExternalMemory = 1 << 5,
5965 5966
};

5967
typedef void (*GCCallback)(GCType type, GCCallbackFlags flags);
5968

vegorov@chromium.org's avatar
vegorov@chromium.org committed
5969 5970
typedef void (*InterruptCallback)(Isolate* isolate, void* data);

5971

5972 5973 5974 5975 5976 5977
/**
 * Collection of V8 heap information.
 *
 * Instances of this class can be passed to v8::V8::HeapStatistics to
 * get heap statistics from V8.
 */
5978
class V8_EXPORT HeapStatistics {
5979 5980 5981
 public:
  HeapStatistics();
  size_t total_heap_size() { return total_heap_size_; }
5982
  size_t total_heap_size_executable() { return total_heap_size_executable_; }
5983
  size_t total_physical_size() { return total_physical_size_; }
5984
  size_t total_available_size() { return total_available_size_; }
5985
  size_t used_heap_size() { return used_heap_size_; }
5986
  size_t heap_size_limit() { return heap_size_limit_; }
5987
  size_t malloced_memory() { return malloced_memory_; }
5988
  size_t peak_malloced_memory() { return peak_malloced_memory_; }
5989
  size_t does_zap_garbage() { return does_zap_garbage_; }
5990 5991 5992

 private:
  size_t total_heap_size_;
5993
  size_t total_heap_size_executable_;
5994
  size_t total_physical_size_;
5995
  size_t total_available_size_;
5996
  size_t used_heap_size_;
5997
  size_t heap_size_limit_;
5998
  size_t malloced_memory_;
5999
  size_t peak_malloced_memory_;
6000
  bool does_zap_garbage_;
6001 6002

  friend class V8;
6003
  friend class Isolate;
6004 6005 6006
};


6007
class V8_EXPORT HeapSpaceStatistics {
6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026
 public:
  HeapSpaceStatistics();
  const char* space_name() { return space_name_; }
  size_t space_size() { return space_size_; }
  size_t space_used_size() { return space_used_size_; }
  size_t space_available_size() { return space_available_size_; }
  size_t physical_space_size() { return physical_space_size_; }

 private:
  const char* space_name_;
  size_t space_size_;
  size_t space_used_size_;
  size_t space_available_size_;
  size_t physical_space_size_;

  friend class Isolate;
};


6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043
class V8_EXPORT HeapObjectStatistics {
 public:
  HeapObjectStatistics();
  const char* object_type() { return object_type_; }
  const char* object_sub_type() { return object_sub_type_; }
  size_t object_count() { return object_count_; }
  size_t object_size() { return object_size_; }

 private:
  const char* object_type_;
  const char* object_sub_type_;
  size_t object_count_;
  size_t object_size_;

  friend class Isolate;
};

6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055
class V8_EXPORT HeapCodeStatistics {
 public:
  HeapCodeStatistics();
  size_t code_and_metadata_size() { return code_and_metadata_size_; }
  size_t bytecode_and_metadata_size() { return bytecode_and_metadata_size_; }

 private:
  size_t code_and_metadata_size_;
  size_t bytecode_and_metadata_size_;

  friend class Isolate;
};
6056

6057 6058
class RetainedObjectInfo;

6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101

/**
 * FunctionEntryHook is the type of the profile entry hook called at entry to
 * any generated function when function-level profiling is enabled.
 *
 * \param function the address of the function that's being entered.
 * \param return_addr_location points to a location on stack where the machine
 *    return address resides. This can be used to identify the caller of
 *    \p function, and/or modified to divert execution when \p function exits.
 *
 * \note the entry hook must not cause garbage collection.
 */
typedef void (*FunctionEntryHook)(uintptr_t function,
                                  uintptr_t return_addr_location);

/**
 * A JIT code event is issued each time code is added, moved or removed.
 *
 * \note removal events are not currently issued.
 */
struct JitCodeEvent {
  enum EventType {
    CODE_ADDED,
    CODE_MOVED,
    CODE_REMOVED,
    CODE_ADD_LINE_POS_INFO,
    CODE_START_LINE_INFO_RECORDING,
    CODE_END_LINE_INFO_RECORDING
  };
  // Definition of the code position type. The "POSITION" type means the place
  // in the source code which are of interest when making stack traces to
  // pin-point the source location of a stack frame as close as possible.
  // The "STATEMENT_POSITION" means the place at the beginning of each
  // statement, and is used to indicate possible break locations.
  enum PositionType { POSITION, STATEMENT_POSITION };

  // Type of event.
  EventType type;
  // Start of the instructions.
  void* code_start;
  // Size of the instructions.
  size_t code_len;
  // Script info for CODE_ADDED event.
6102
  Local<UnboundScript> script;
6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137
  // User-defined data for *_LINE_INFO_* event. It's used to hold the source
  // code line information which is returned from the
  // CODE_START_LINE_INFO_RECORDING event. And it's passed to subsequent
  // CODE_ADD_LINE_POS_INFO and CODE_END_LINE_INFO_RECORDING events.
  void* user_data;

  struct name_t {
    // Name of the object associated with the code, note that the string is not
    // zero-terminated.
    const char* str;
    // Number of chars in str.
    size_t len;
  };

  struct line_info_t {
    // PC offset
    size_t offset;
    // Code postion
    size_t pos;
    // The position type.
    PositionType position_type;
  };

  union {
    // Only valid for CODE_ADDED.
    struct name_t name;

    // Only valid for CODE_ADD_LINE_POS_INFO
    struct line_info_t line_info;

    // New location of instructions. Only valid for CODE_MOVED.
    void* new_code_start;
  };
};

hpayer's avatar
hpayer committed
6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149
/**
 * Option flags passed to the SetRAILMode function.
 * See documentation https://developers.google.com/web/tools/chrome-devtools/
 * profile/evaluate-performance/rail
 */
enum RAILMode {
  // Response performance mode: In this mode very low virtual machine latency
  // is provided. V8 will try to avoid JavaScript execution interruptions.
  // Throughput may be throttled.
  PERFORMANCE_RESPONSE,
  // Animation performance mode: In this mode low virtual machine latency is
  // provided. V8 will try to avoid as many JavaScript execution interruptions
6150
  // as possible. Throughput may be throttled. This is the default mode.
hpayer's avatar
hpayer committed
6151 6152 6153 6154 6155 6156 6157 6158 6159
  PERFORMANCE_ANIMATION,
  // Idle performance mode: The embedder is idle. V8 can complete deferred work
  // in this mode.
  PERFORMANCE_IDLE,
  // Load performance mode: In this mode high throughput is provided. V8 may
  // turn off latency optimizations.
  PERFORMANCE_LOAD
};

6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177
/**
 * Option flags passed to the SetJitCodeEventHandler function.
 */
enum JitCodeEventOptions {
  kJitCodeEventDefault = 0,
  // Generate callbacks for already existent code.
  kJitCodeEventEnumExisting = 1
};


/**
 * Callback function passed to SetJitCodeEventHandler.
 *
 * \param event code add, move or removal event.
 */
typedef void (*JitCodeEventHandler)(const JitCodeEvent* event);


6178 6179 6180 6181 6182 6183
/**
 * Interface for iterating through all external resources in the heap.
 */
class V8_EXPORT ExternalResourceVisitor {  // NOLINT
 public:
  virtual ~ExternalResourceVisitor() {}
6184
  virtual void VisitExternalString(Local<String> string) {}
6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197
};


/**
 * Interface for iterating through all the persistent handles in the heap.
 */
class V8_EXPORT PersistentHandleVisitor {  // NOLINT
 public:
  virtual ~PersistentHandleVisitor() {}
  virtual void VisitPersistentHandle(Persistent<Value>* value,
                                     uint16_t class_id) {}
};

6198 6199 6200 6201 6202 6203 6204 6205 6206
/**
 * Memory pressure level for the MemoryPressureNotification.
 * kNone hints V8 that there is no memory pressure.
 * kModerate hints V8 to speed up incremental garbage collection at the cost of
 * of higher latency due to garbage collection pauses.
 * kCritical hints V8 to free memory as soon as possible. Garbage collection
 * pauses at this level will be large.
 */
enum class MemoryPressureLevel { kNone, kModerate, kCritical };
6207

hlopko's avatar
hlopko committed
6208
/**
6209
 * Interface for tracing through the embedder heap. During a v8 garbage
hlopko's avatar
hlopko committed
6210 6211
 * collection, v8 collects hidden fields of all potential wrappers, and at the
 * end of its marking phase iterates the collection and asks the embedder to
6212 6213
 * trace through its heap and use reporter to report each JavaScript object
 * reachable from any of the given wrappers.
hlopko's avatar
hlopko committed
6214
 *
6215 6216 6217
 * Before the first call to the TraceWrappersFrom function TracePrologue will be
 * called. When the garbage collection cycle is finished, TraceEpilogue will be
 * called.
hlopko's avatar
hlopko committed
6218
 */
hlopko's avatar
hlopko committed
6219
class V8_EXPORT EmbedderHeapTracer {
hlopko's avatar
hlopko committed
6220
 public:
6221
  enum ForceCompletionAction { FORCE_COMPLETION, DO_NOT_FORCE_COMPLETION };
6222

6223 6224 6225 6226 6227 6228
  struct AdvanceTracingActions {
    explicit AdvanceTracingActions(ForceCompletionAction force_completion_)
        : force_completion(force_completion_) {}

    ForceCompletionAction force_completion;
  };
6229

6230
  /**
6231 6232 6233 6234
   * Called by v8 to register internal fields of found wrappers.
   *
   * The embedder is expected to store them somewhere and trace reachable
   * wrappers from them when called through |AdvanceTracing|.
6235 6236
   */
  virtual void RegisterV8References(
6237
      const std::vector<std::pair<void*, void*> >& internal_fields) = 0;
6238

hlopko's avatar
hlopko committed
6239
  /**
6240
   * Called at the beginning of a GC cycle.
hlopko's avatar
hlopko committed
6241
   */
6242
  virtual void TracePrologue() = 0;
6243

hlopko's avatar
hlopko committed
6244
  /**
6245 6246 6247 6248 6249 6250
   * Called to to make a tracing step in the embedder.
   *
   * The embedder is expected to trace its heap starting from wrappers reported
   * by RegisterV8References method, and report back all reachable wrappers.
   * Furthermore, the embedder is expected to stop tracing by the given
   * deadline.
6251 6252
   *
   * Returns true if there is still work to do.
hlopko's avatar
hlopko committed
6253
   */
6254
  virtual bool AdvanceTracing(double deadline_in_ms,
6255
                              AdvanceTracingActions actions) = 0;
6256

hlopko's avatar
hlopko committed
6257
  /**
6258
   * Called at the end of a GC cycle.
6259 6260
   *
   * Note that allocation is *not* allowed within |TraceEpilogue|.
hlopko's avatar
hlopko committed
6261
   */
6262
  virtual void TraceEpilogue() = 0;
hlopko's avatar
hlopko committed
6263

6264
  /**
6265 6266
   * Called upon entering the final marking pause. No more incremental marking
   * steps will follow this call.
6267
   */
6268
  virtual void EnterFinalPause() = 0;
6269

6270
  /**
6271 6272 6273 6274
   * Called when tracing is aborted.
   *
   * The embedder is expected to throw away all intermediate data and reset to
   * the initial state.
6275
   */
6276
  virtual void AbortTracing() = 0;
6277

6278 6279 6280 6281 6282
  /**
   * Returns the number of wrappers that are still to be traced by the embedder.
   */
  virtual size_t NumberOfWrappersToTrace() { return 0; }

hlopko's avatar
hlopko committed
6283 6284 6285 6286
 protected:
  virtual ~EmbedderHeapTracer() = default;
};

6287
/**
6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299
 * Callback and supporting data used in SnapshotCreator to implement embedder
 * logic to serialize internal fields.
 */
struct SerializeInternalFieldsCallback {
  typedef StartupData (*CallbackFunction)(Local<Object> holder, int index,
                                          void* data);
  SerializeInternalFieldsCallback(CallbackFunction function = nullptr,
                                  void* data_arg = nullptr)
      : callback(function), data(data_arg) {}
  CallbackFunction callback;
  void* data;
};
6300 6301

/**
6302 6303
 * Callback and supporting data used to implement embedder logic to deserialize
 * internal fields.
6304
 */
6305 6306 6307 6308 6309 6310 6311 6312 6313 6314
struct DeserializeInternalFieldsCallback {
  typedef void (*CallbackFunction)(Local<Object> holder, int index,
                                   StartupData payload, void* data);
  DeserializeInternalFieldsCallback(CallbackFunction function = nullptr,
                                    void* data_arg = nullptr)
      : callback(function), data(data_arg) {}
  void (*callback)(Local<Object> holder, int index, StartupData payload,
                   void* data);
  void* data;
};
6315

6316
/**
6317 6318 6319 6320 6321 6322
 * Isolate represents an isolated instance of the V8 engine.  V8 isolates have
 * completely separate states.  Objects from one isolate must not be used in
 * other isolates.  The embedder can create multiple isolates and use them in
 * parallel in multiple threads.  An isolate can be entered by at most one
 * thread at any given time.  The Locker/Unlocker API must be used to
 * synchronize.
6323
 */
6324
class V8_EXPORT Isolate {
6325
 public:
6326 6327 6328 6329
  /**
   * Initial configuration parameters for a new Isolate.
   */
  struct CreateParams {
6330
    CreateParams()
6331 6332 6333 6334 6335 6336 6337
        : entry_hook(nullptr),
          code_event_handler(nullptr),
          snapshot_blob(nullptr),
          counter_lookup_callback(nullptr),
          create_histogram_callback(nullptr),
          add_histogram_sample_callback(nullptr),
          array_buffer_allocator(nullptr),
6338 6339
          external_references(nullptr),
          allow_atomics_wait(true) {}
6340 6341 6342 6343 6344

    /**
     * The optional entry_hook allows the host application to provide the
     * address of a function that's invoked on entry to every V8-generated
     * function.  Note that entry_hook is invoked at the very start of each
6345 6346 6347
     * generated function.
     * An entry_hook can only be provided in no-snapshot builds; in snapshot
     * builds it must be nullptr.
6348 6349 6350 6351 6352 6353 6354 6355
     */
    FunctionEntryHook entry_hook;

    /**
     * Allows the host application to provide the address of a function that is
     * notified each time code is added, moved or removed.
     */
    JitCodeEventHandler code_event_handler;
6356 6357 6358 6359 6360

    /**
     * ResourceConstraints to use for the new Isolate.
     */
    ResourceConstraints constraints;
6361 6362

    /**
6363
     * Explicitly specify a startup snapshot blob. The embedder owns the blob.
6364
     */
6365
    StartupData* snapshot_blob;
6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381


    /**
     * Enables the host application to provide a mechanism for recording
     * statistics counters.
     */
    CounterLookupCallback counter_lookup_callback;

    /**
     * Enables the host application to provide a mechanism for recording
     * histograms. The CreateHistogram function returns a
     * histogram which will later be passed to the AddHistogramSample
     * function.
     */
    CreateHistogramCallback create_histogram_callback;
    AddHistogramSampleCallback add_histogram_sample_callback;
6382 6383 6384 6385 6386 6387

    /**
     * The ArrayBuffer::Allocator to use for allocating and freeing the backing
     * store of ArrayBuffers.
     */
    ArrayBuffer::Allocator* array_buffer_allocator;
6388 6389 6390 6391 6392 6393 6394 6395

    /**
     * Specifies an optional nullptr-terminated array of raw addresses in the
     * embedder that V8 can match against during serialization and use for
     * deserialization. This array and its content must stay valid for the
     * entire lifetime of the isolate.
     */
    intptr_t* external_references;
6396 6397 6398 6399 6400 6401

    /**
     * Whether calling Atomics.wait (a function that may block) is allowed in
     * this isolate.
     */
    bool allow_atomics_wait;
6402 6403 6404
  };


6405 6406 6407 6408
  /**
   * Stack-allocated class which sets the isolate for all operations
   * executed within a local scope.
   */
6409
  class V8_EXPORT Scope {
6410 6411 6412 6413 6414 6415 6416
   public:
    explicit Scope(Isolate* isolate) : isolate_(isolate) {
      isolate->Enter();
    }

    ~Scope() { isolate_->Exit(); }

6417 6418 6419 6420
    // Prevent copying of Scope objects.
    Scope(const Scope&) = delete;
    Scope& operator=(const Scope&) = delete;

6421 6422 6423 6424
   private:
    Isolate* const isolate_;
  };

6425 6426 6427 6428

  /**
   * Assert that no Javascript code is invoked.
   */
6429
  class V8_EXPORT DisallowJavascriptExecutionScope {
6430
   public:
6431 6432
    enum OnFailure { CRASH_ON_FAILURE, THROW_ON_FAILURE };

6433
    DisallowJavascriptExecutionScope(Isolate* isolate, OnFailure on_failure);
6434 6435
    ~DisallowJavascriptExecutionScope();

6436 6437 6438 6439 6440 6441
    // Prevent copying of Scope objects.
    DisallowJavascriptExecutionScope(const DisallowJavascriptExecutionScope&) =
        delete;
    DisallowJavascriptExecutionScope& operator=(
        const DisallowJavascriptExecutionScope&) = delete;

6442
   private:
6443
    bool on_failure_;
6444 6445 6446 6447 6448 6449 6450
    void* internal_;
  };


  /**
   * Introduce exception to DisallowJavascriptExecutionScope.
   */
6451
  class V8_EXPORT AllowJavascriptExecutionScope {
6452 6453 6454 6455
   public:
    explicit AllowJavascriptExecutionScope(Isolate* isolate);
    ~AllowJavascriptExecutionScope();

6456 6457 6458 6459 6460 6461
    // Prevent copying of Scope objects.
    AllowJavascriptExecutionScope(const AllowJavascriptExecutionScope&) =
        delete;
    AllowJavascriptExecutionScope& operator=(
        const AllowJavascriptExecutionScope&) = delete;

6462
   private:
6463 6464
    void* internal_throws_;
    void* internal_assert_;
6465 6466
  };

6467 6468 6469 6470 6471 6472 6473 6474 6475 6476
  /**
   * Do not run microtasks while this scope is active, even if microtasks are
   * automatically executed otherwise.
   */
  class V8_EXPORT SuppressMicrotaskExecutionScope {
   public:
    explicit SuppressMicrotaskExecutionScope(Isolate* isolate);
    ~SuppressMicrotaskExecutionScope();

    // Prevent copying of Scope objects.
6477 6478
    SuppressMicrotaskExecutionScope(const SuppressMicrotaskExecutionScope&) =
        delete;
6479
    SuppressMicrotaskExecutionScope& operator=(
6480 6481 6482 6483
        const SuppressMicrotaskExecutionScope&) = delete;

   private:
    internal::Isolate* const isolate_;
6484 6485
  };

6486 6487 6488 6489 6490 6491 6492 6493 6494
  /**
   * Types of garbage collections that can be requested via
   * RequestGarbageCollectionForTesting.
   */
  enum GarbageCollectionType {
    kFullGarbageCollection,
    kMinorGarbageCollection
  };

6495
  /**
6496
   * Features reported via the SetUseCounterCallback callback. Do not change
6497 6498 6499 6500
   * assigned numbers of existing items; add new features to the end of this
   * list.
   */
  enum UseCounterFeature {
6501
    kUseAsm = 0,
6502
    kBreakIterator = 1,
6503
    kLegacyConst = 2,
6504 6505 6506
    kMarkDequeOverflow = 3,
    kStoreBufferOverflow = 4,
    kSlotsBufferOverflow = 5,
6507
    kObjectObserve = 6,
6508
    kForcedGC = 7,
6509 6510 6511
    kSloppyMode = 8,
    kStrictMode = 9,
    kStrongMode = 10,
6512 6513
    kRegExpPrototypeStickyGetter = 11,
    kRegExpPrototypeToString = 12,
6514 6515 6516 6517 6518 6519 6520
    kRegExpPrototypeUnicodeGetter = 13,
    kIntlV8Parse = 14,
    kIntlPattern = 15,
    kIntlResolved = 16,
    kPromiseChain = 17,
    kPromiseAccept = 18,
    kPromiseDefer = 19,
6521 6522
    kHtmlCommentInExternalScript = 20,
    kHtmlComment = 21,
6523 6524
    kSloppyModeBlockScopedFunctionRedefinition = 22,
    kForInInitializer = 23,
6525 6526 6527 6528 6529
    kArrayProtectorDirtied = 24,
    kArraySpeciesModified = 25,
    kArrayPrototypeConstructorModified = 26,
    kArrayInstanceProtoModified = 27,
    kArrayInstanceConstructorModified = 28,
6530
    kLegacyFunctionDeclaration = 29,
6531 6532
    kRegExpPrototypeSourceGetter = 30,
    kRegExpPrototypeOldFlagGetter = 31,
6533
    kDecimalWithLeadingZeroInStrictMode = 32,
6534
    kLegacyDateParser = 33,
6535
    kDefineGetterOrSetterWouldThrow = 34,
6536
    kFunctionConstructorReturnedUndefined = 35,
6537 6538
    kAssigmentExpressionLHSIsCallInSloppy = 36,
    kAssigmentExpressionLHSIsCallInStrict = 37,
6539
    kPromiseConstructorReturnedUndefined = 38,
6540

6541 6542
    // If you add new values here, you'll also need to update Chromium's:
    // UseCounter.h, V8PerIsolateData.cpp, histograms.xml
6543
    kUseCounterFeatureCount  // This enum value must be last.
6544 6545
  };

6546 6547 6548 6549 6550 6551 6552 6553 6554 6555
  enum MessageErrorLevel {
    kMessageLog = (1 << 0),
    kMessageDebug = (1 << 1),
    kMessageInfo = (1 << 2),
    kMessageError = (1 << 3),
    kMessageWarning = (1 << 4),
    kMessageAll = kMessageLog | kMessageDebug | kMessageInfo | kMessageError |
                  kMessageWarning,
  };

6556 6557 6558 6559
  typedef void (*UseCounterCallback)(Isolate* isolate,
                                     UseCounterFeature feature);


6560 6561 6562 6563 6564 6565
  /**
   * Creates a new isolate.  Does not change the currently entered
   * isolate.
   *
   * When an isolate is no longer used its resources should be freed
   * by calling Dispose().  Using the delete operator is not allowed.
6566 6567
   *
   * V8::Initialize() must have run prior to this.
6568
   */
6569 6570
  static Isolate* New(const CreateParams& params);

6571 6572 6573
  /**
   * Returns the entered isolate for the current thread or NULL in
   * case there is no current isolate.
6574 6575
   *
   * This method must not be invoked before V8::Initialize() was invoked.
6576 6577 6578
   */
  static Isolate* GetCurrent();

6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591
  /**
   * Custom callback used by embedders to help V8 determine if it should abort
   * when it throws and no internal handler is predicted to catch the
   * exception. If --abort-on-uncaught-exception is used on the command line,
   * then V8 will abort if either:
   * - no custom callback is set.
   * - the custom callback set returns true.
   * Otherwise, the custom callback will not be called and V8 will not abort.
   */
  typedef bool (*AbortOnUncaughtExceptionCallback)(Isolate*);
  void SetAbortOnUncaughtExceptionCallback(
      AbortOnUncaughtExceptionCallback callback);

6592 6593 6594 6595 6596 6597 6598 6599
  /**
   * Optional notification that the system is running low on memory.
   * V8 uses these notifications to guide heuristics.
   * It is allowed to call this function from another thread while
   * the isolate is executing long running JavaScript code.
   */
  void MemoryPressureNotification(MemoryPressureLevel level);

6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626
  /**
   * Methods below this point require holding a lock (using Locker) in
   * a multi-threaded environment.
   */

  /**
   * Sets this isolate as the entered one for the current thread.
   * Saves the previously entered one (if any), so that it can be
   * restored when exiting.  Re-entering an isolate is allowed.
   */
  void Enter();

  /**
   * Exits this isolate by restoring the previously entered one in the
   * current thread.  The isolate may still stay the same, if it was
   * entered more than once.
   *
   * Requires: this == Isolate::GetCurrent().
   */
  void Exit();

  /**
   * Disposes the isolate.  The isolate must not be entered by any
   * thread to be disposable.
   */
  void Dispose();

6627 6628 6629 6630 6631 6632
  /**
   * Dumps activated low-level V8 internal stats. This can be used instead
   * of performing a full isolate disposal.
   */
  void DumpAndResetStats();

6633 6634 6635 6636 6637 6638 6639 6640 6641
  /**
   * Discards all V8 thread-specific data for the Isolate. Should be used
   * if a thread is terminating and it has used an Isolate that will outlive
   * the thread -- all thread-specific data for an Isolate is discarded when
   * an Isolate is disposed so this call is pointless if an Isolate is about
   * to be Disposed.
   */
  void DiscardThreadSpecificMetadata();

6642
  /**
6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659
   * Associate embedder-specific data with the isolate. |slot| has to be
   * between 0 and GetNumberOfDataSlots() - 1.
   */
  V8_INLINE void SetData(uint32_t slot, void* data);

  /**
   * Retrieve embedder-specific data from the isolate.
   * Returns NULL if SetData has never been called for the given |slot|.
   */
  V8_INLINE void* GetData(uint32_t slot);

  /**
   * Returns the maximum number of available embedder data slots. Valid slots
   * are in the range of 0 - GetNumberOfDataSlots() - 1.
   */
  V8_INLINE static uint32_t GetNumberOfDataSlots();

6660 6661 6662 6663 6664
  /**
   * Get statistics about the heap memory usage.
   */
  void GetHeapStatistics(HeapStatistics* heap_statistics);

6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681
  /**
   * Returns the number of spaces in the heap.
   */
  size_t NumberOfHeapSpaces();

  /**
   * Get the memory usage of a space in the heap.
   *
   * \param space_statistics The HeapSpaceStatistics object to fill in
   *   statistics.
   * \param index The index of the space to get statistics from, which ranges
   *   from 0 to NumberOfHeapSpaces() - 1.
   * \returns true on success.
   */
  bool GetHeapSpaceStatistics(HeapSpaceStatistics* space_statistics,
                              size_t index);

6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698
  /**
   * Returns the number of types of objects tracked in the heap at GC.
   */
  size_t NumberOfTrackedHeapObjectTypes();

  /**
   * Get statistics about objects in the heap.
   *
   * \param object_statistics The HeapObjectStatistics object to fill in
   *   statistics of objects of given type, which were live in the previous GC.
   * \param type_index The index of the type of object to fill details about,
   *   which ranges from 0 to NumberOfTrackedHeapObjectTypes() - 1.
   * \returns true on success.
   */
  bool GetHeapObjectStatisticsAtLastGC(HeapObjectStatistics* object_statistics,
                                       size_t type_index);

6699 6700 6701 6702 6703 6704 6705 6706 6707
  /**
   * Get statistics about code and its metadata in the heap.
   *
   * \param object_statistics The HeapCodeStatistics object to fill in
   *   statistics of code, bytecode and their metadata.
   * \returns true on success.
   */
  bool GetHeapCodeAndMetadataStatistics(HeapCodeStatistics* object_statistics);

6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722
  /**
   * Get a call stack sample from the isolate.
   * \param state Execution state.
   * \param frames Caller allocated buffer to store stack frames.
   * \param frames_limit Maximum number of frames to capture. The buffer must
   *                     be large enough to hold the number of frames.
   * \param sample_info The sample info is filled up by the function
   *                    provides number of actual captured stack frames and
   *                    the current VM state.
   * \note GetStackSample should only be called when the JS thread is paused or
   *       interrupted. Otherwise the behavior is undefined.
   */
  void GetStackSample(const RegisterState& state, void** frames,
                      size_t frames_limit, SampleInfo* sample_info);

6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735
  /**
   * Adjusts the amount of registered external memory. Used to give V8 an
   * indication of the amount of externally allocated memory that is kept alive
   * by JavaScript objects. V8 uses this to decide when to perform global
   * garbage collections. Registering externally allocated memory will trigger
   * global garbage collections more often than it would otherwise in an attempt
   * to garbage collect the JavaScript objects that keep the externally
   * allocated memory alive.
   *
   * \param change_in_bytes the change in externally allocated memory that is
   *   kept alive by JavaScript objects.
   * \returns the adjusted value.
   */
6736 6737
  V8_INLINE int64_t
      AdjustAmountOfExternalAllocatedMemory(int64_t change_in_bytes);
6738

6739 6740 6741 6742 6743 6744
  /**
   * Returns the number of phantom handles without callbacks that were reset
   * by the garbage collector since the last call to this function.
   */
  size_t NumberOfPhantomHandleResetsSinceLastCall();

6745 6746 6747 6748 6749 6750
  /**
   * Returns heap profiler for this isolate. Will return NULL until the isolate
   * is initialized.
   */
  HeapProfiler* GetHeapProfiler();

6751
  /**
6752 6753 6754
   * Returns CPU profiler for this isolate. Will return NULL unless the isolate
   * is initialized. It is the embedder's responsibility to stop all CPU
   * profiling activities if it has started any.
6755
   */
6756 6757
  V8_DEPRECATE_SOON("CpuProfiler should be created with CpuProfiler::New call.",
                    CpuProfiler* GetCpuProfiler());
6758

6759 6760 6761
  /** Returns true if this isolate has a current context. */
  bool InContext();

6762 6763 6764 6765
  /**
   * Returns the context of the currently running JavaScript, or the context
   * on the top of the stack if no JavaScript is running.
   */
6766 6767
  Local<Context> GetCurrentContext();

6768 6769 6770 6771 6772
  /**
   * Returns the context of the calling JavaScript code.  That is the
   * context of the top-most JavaScript frame.  If there are no
   * JavaScript frames an empty handle is returned.
   */
6773 6774 6775 6776
  V8_DEPRECATE_SOON(
      "Calling context concept is not compatible with tail calls, and will be "
      "removed.",
      Local<Context> GetCallingContext());
6777

6778
  /** Returns the last context entered through V8's C++ API. */
6779 6780
  Local<Context> GetEnteredContext();

6781 6782 6783 6784 6785 6786 6787 6788
  /**
   * Returns either the last context entered through V8's C++ API, or the
   * context of the currently running microtask while processing microtasks.
   * If a context is entered while executing a microtask, that context is
   * returned.
   */
  Local<Context> GetEnteredOrMicrotaskContext();

6789 6790 6791 6792 6793 6794
  /**
   * Schedules an exception to be thrown when returning to JavaScript.  When an
   * exception has been scheduled it is illegal to invoke any JavaScript
   * operation; the caller must return immediately and only after the exception
   * has been handled does it become legal to invoke JavaScript operations.
   */
6795
  Local<Value> ThrowException(Local<Value> exception);
6796

6797 6798
  typedef void (*GCCallback)(Isolate* isolate, GCType type,
                             GCCallbackFlags flags);
6799 6800 6801

  /**
   * Enables the host application to receive a notification before a
6802 6803 6804 6805 6806 6807
   * garbage collection. Allocations are allowed in the callback function,
   * but the callback is not re-entrant: if the allocation inside it will
   * trigger the garbage collection, the callback won't be called again.
   * It is possible to specify the GCType filter for your callback. But it is
   * not possible to register the same callback function two times with
   * different GCType filters.
6808
   */
6809 6810
  void AddGCPrologueCallback(GCCallback callback,
                             GCType gc_type_filter = kGCTypeAll);
6811 6812 6813 6814 6815

  /**
   * This function removes callback which was installed by
   * AddGCPrologueCallback function.
   */
6816
  void RemoveGCPrologueCallback(GCCallback callback);
6817

hlopko's avatar
hlopko committed
6818 6819 6820 6821 6822
  /**
   * Sets the embedder heap tracer for the isolate.
   */
  void SetEmbedderHeapTracer(EmbedderHeapTracer* tracer);

6823 6824
  /**
   * Enables the host application to receive a notification after a
6825 6826 6827 6828 6829 6830
   * garbage collection. Allocations are allowed in the callback function,
   * but the callback is not re-entrant: if the allocation inside it will
   * trigger the garbage collection, the callback won't be called again.
   * It is possible to specify the GCType filter for your callback. But it is
   * not possible to register the same callback function two times with
   * different GCType filters.
6831
   */
6832 6833
  void AddGCEpilogueCallback(GCCallback callback,
                             GCType gc_type_filter = kGCTypeAll);
6834 6835 6836 6837 6838

  /**
   * This function removes callback which was installed by
   * AddGCEpilogueCallback function.
   */
6839
  void RemoveGCEpilogueCallback(GCCallback callback);
6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875

  /**
   * Forcefully terminate the current thread of JavaScript execution
   * in the given isolate.
   *
   * This method can be used by any thread even if that thread has not
   * acquired the V8 lock with a Locker object.
   */
  void TerminateExecution();

  /**
   * Is V8 terminating JavaScript execution.
   *
   * Returns true if JavaScript execution is currently terminating
   * because of a call to TerminateExecution.  In that case there are
   * still JavaScript frames on the stack and the termination
   * exception is still active.
   */
  bool IsExecutionTerminating();

  /**
   * Resume execution capability in the given isolate, whose execution
   * was previously forcefully terminated using TerminateExecution().
   *
   * When execution is forcefully terminated using TerminateExecution(),
   * the isolate can not resume execution until all JavaScript frames
   * have propagated the uncatchable exception which is generated.  This
   * method allows the program embedding the engine to handle the
   * termination event and resume execution capability, even if
   * JavaScript frames remain on the stack.
   *
   * This method can be used by any thread even if that thread has not
   * acquired the V8 lock with a Locker object.
   */
  void CancelTerminateExecution();

vegorov@chromium.org's avatar
vegorov@chromium.org committed
6876 6877 6878 6879
  /**
   * Request V8 to interrupt long running JavaScript code and invoke
   * the given |callback| passing the given |data| to it. After |callback|
   * returns control will be returned to the JavaScript code.
6880
   * There may be a number of interrupt requests in flight.
vegorov@chromium.org's avatar
vegorov@chromium.org committed
6881 6882 6883 6884 6885
   * Can be called from another thread without acquiring a |Locker|.
   * Registered |callback| must not reenter interrupted Isolate.
   */
  void RequestInterrupt(InterruptCallback callback, void* data);

6886 6887 6888 6889 6890 6891
  /**
   * Request garbage collection in this Isolate. It is only valid to call this
   * function if --expose_gc was specified.
   *
   * This should only be used for testing purposes and not to enforce a garbage
   * collection schedule. It has strong negative impact on the garbage
jochen's avatar
jochen committed
6892 6893 6894
   * collection performance. Use IdleNotificationDeadline() or
   * LowMemoryNotification() instead to influence the garbage collection
   * schedule.
6895 6896 6897
   */
  void RequestGarbageCollectionForTesting(GarbageCollectionType type);

6898 6899 6900 6901 6902
  /**
   * Set the callback to invoke for logging event.
   */
  void SetEventLogger(LogEventCallback that);

6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915
  /**
   * Adds a callback to notify the host application right before a script
   * is about to run. If a script re-enters the runtime during executing, the
   * BeforeCallEnteredCallback is invoked for each re-entrance.
   * Executing scripts inside the callback will re-trigger the callback.
   */
  void AddBeforeCallEnteredCallback(BeforeCallEnteredCallback callback);

  /**
   * Removes callback that was installed by AddBeforeCallEnteredCallback.
   */
  void RemoveBeforeCallEnteredCallback(BeforeCallEnteredCallback callback);

6916 6917 6918 6919 6920 6921 6922 6923
  /**
   * Adds a callback to notify the host application when a script finished
   * running.  If a script re-enters the runtime during executing, the
   * CallCompletedCallback is only invoked when the outer-most script
   * execution ends.  Executing scripts inside the callback do not trigger
   * further callbacks.
   */
  void AddCallCompletedCallback(CallCompletedCallback callback);
6924 6925 6926
  V8_DEPRECATE_SOON(
      "Use callback with parameter",
      void AddCallCompletedCallback(DeprecatedCallCompletedCallback callback));
6927 6928 6929 6930 6931

  /**
   * Removes callback that was installed by AddCallCompletedCallback.
   */
  void RemoveCallCompletedCallback(CallCompletedCallback callback);
6932 6933 6934 6935
  V8_DEPRECATE_SOON(
      "Use callback with parameter",
      void RemoveCallCompletedCallback(
          DeprecatedCallCompletedCallback callback));
6936

6937 6938 6939 6940 6941 6942
  /**
   * Experimental: Set the PromiseHook callback for various promise
   * lifecycle events.
   */
  void SetPromiseHook(PromiseHook hook);

6943 6944 6945 6946 6947 6948
  /**
   * Set callback to notify about promise reject with no handler, or
   * revocation of such a previous notification once the handler is added.
   */
  void SetPromiseRejectCallback(PromiseRejectCallback callback);

6949 6950
  /**
   * Experimental: Runs the Microtask Work Queue until empty
6951
   * Any exceptions thrown by microtask callbacks are swallowed.
6952 6953 6954 6955 6956 6957
   */
  void RunMicrotasks();

  /**
   * Experimental: Enqueues the callback to the Microtask Work Queue
   */
6958
  void EnqueueMicrotask(Local<Function> microtask);
6959

6960 6961 6962 6963 6964
  /**
   * Experimental: Enqueues the callback to the Microtask Work Queue
   */
  void EnqueueMicrotask(MicrotaskCallback microtask, void* data = NULL);

6965 6966 6967
  /**
   * Experimental: Controls how Microtasks are invoked. See MicrotasksPolicy
   * for details.
6968
   */
6969 6970 6971
  void SetMicrotasksPolicy(MicrotasksPolicy policy);
  V8_DEPRECATE_SOON("Use SetMicrotasksPolicy",
                    void SetAutorunMicrotasks(bool autorun));
6972

6973
  /**
6974
   * Experimental: Returns the policy controlling how Microtasks are invoked.
6975
   */
6976 6977 6978
  MicrotasksPolicy GetMicrotasksPolicy() const;
  V8_DEPRECATE_SOON("Use GetMicrotasksPolicy",
                    bool WillAutorunMicrotasks() const);
6979

6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998
  /**
   * Experimental: adds a callback to notify the host application after
   * microtasks were run. The callback is triggered by explicit RunMicrotasks
   * call or automatic microtasks execution (see SetAutorunMicrotasks).
   *
   * Callback will trigger even if microtasks were attempted to run,
   * but the microtasks queue was empty and no single microtask was actually
   * executed.
   *
   * Executing scriptsinside the callback will not re-trigger microtasks and
   * the callback.
   */
  void AddMicrotasksCompletedCallback(MicrotasksCompletedCallback callback);

  /**
   * Removes callback that was installed by AddMicrotasksCompletedCallback.
   */
  void RemoveMicrotasksCompletedCallback(MicrotasksCompletedCallback callback);

6999 7000 7001 7002 7003
  /**
   * Sets a callback for counting the number of times a feature of V8 is used.
   */
  void SetUseCounterCallback(UseCounterCallback callback);

7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018
  /**
   * Enables the host application to provide a mechanism for recording
   * statistics counters.
   */
  void SetCounterFunction(CounterLookupCallback);

  /**
   * Enables the host application to provide a mechanism for recording
   * histograms. The CreateHistogram function returns a
   * histogram which will later be passed to the AddHistogramSample
   * function.
   */
  void SetCreateHistogramFunction(CreateHistogramCallback);
  void SetAddHistogramSampleFunction(AddHistogramSampleCallback);

7019 7020
  /**
   * Optional notification that the embedder is idle.
7021
   * V8 uses the notification to perform garbage collection.
7022
   * This call can be used repeatedly if the embedder remains idle.
jochen's avatar
jochen committed
7023
   * Returns true if the embedder should stop calling IdleNotificationDeadline
7024 7025 7026
   * until real work has been done.  This indicates that V8 has done
   * as much cleanup as it will be able to do.
   *
7027 7028 7029 7030 7031
   * The deadline_in_seconds argument specifies the deadline V8 has to finish
   * garbage collection work. deadline_in_seconds is compared with
   * MonotonicallyIncreasingTime() and should be based on the same timebase as
   * that function. There is no guarantee that the actual work will be done
   * within the time limit.
7032
   */
7033
  bool IdleNotificationDeadline(double deadline_in_seconds);
7034

7035 7036
  V8_DEPRECATED("use IdleNotificationDeadline()",
                bool IdleNotification(int idle_time_in_ms));
jochen's avatar
jochen committed
7037

7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048
  /**
   * Optional notification that the system is running low on memory.
   * V8 uses these notifications to attempt to free memory.
   */
  void LowMemoryNotification();

  /**
   * Optional notification that a context has been disposed. V8 uses
   * these notifications to guide the GC heuristic. Returns the number
   * of context disposals - including this one - since the last time
   * V8 had a chance to clean up.
7049 7050 7051
   *
   * The optional parameter |dependant_context| specifies whether the disposed
   * context was depending on state from other contexts or not.
7052
   */
7053
  int ContextDisposedNotification(bool dependant_context = true);
7054

7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066
  /**
   * Optional notification that the isolate switched to the foreground.
   * V8 uses these notifications to guide heuristics.
   */
  void IsolateInForegroundNotification();

  /**
   * Optional notification that the isolate switched to the background.
   * V8 uses these notifications to guide heuristics.
   */
  void IsolateInBackgroundNotification();

hpayer's avatar
hpayer committed
7067 7068 7069 7070 7071 7072 7073 7074 7075
  /**
   * Optional notification to tell V8 the current performance requirements
   * of the embedder based on RAIL.
   * V8 uses these notifications to guide heuristics.
   * This is an unfinished experimental feature. Semantics and implementation
   * may change frequently.
   */
  void SetRAILMode(RAILMode rail_mode);

7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086
  /**
   * Optional notification to tell V8 the current isolate is used for debugging
   * and requires higher heap limit.
   */
  void IncreaseHeapLimitForDebugging();

  /**
   * Restores the original heap limit after IncreaseHeapLimitForDebugging().
   */
  void RestoreOriginalHeapLimit();

7087 7088 7089 7090 7091 7092
  /**
   * Returns true if the heap limit was increased for debugging and the
   * original heap limit was not restored yet.
   */
  bool IsHeapLimitIncreasedForDebugging();

7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117
  /**
   * Allows the host application to provide the address of a function that is
   * notified each time code is added, moved or removed.
   *
   * \param options options for the JIT code event handler.
   * \param event_handler the JIT code event handler, which will be invoked
   *     each time code is added, moved or removed.
   * \note \p event_handler won't get notified of existent code.
   * \note since code removal notifications are not currently issued, the
   *     \p event_handler may get notifications of code that overlaps earlier
   *     code notifications. This happens when code areas are reused, and the
   *     earlier overlapping code areas should therefore be discarded.
   * \note the events passed to \p event_handler and the strings they point to
   *     are not guaranteed to live past each call. The \p event_handler must
   *     copy strings and other parameters it needs to keep around.
   * \note the set of events declared in JitCodeEvent::EventType is expected to
   *     grow over time, and the JitCodeEvent structure is expected to accrue
   *     new members. The \p event_handler function must ignore event codes
   *     it does not recognize to maintain future compatibility.
   * \note Use Isolate::CreateParams to get events for code executed during
   *     Isolate setup.
   */
  void SetJitCodeEventHandler(JitCodeEventOptions options,
                              JitCodeEventHandler event_handler);

7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128
  /**
   * Modifies the stack limit for this Isolate.
   *
   * \param stack_limit An address beyond which the Vm's stack may not grow.
   *
   * \note  If you are using threads then you should hold the V8::Locker lock
   *     while setting the stack limit and you must set a non-default stack
   *     limit separately for each thread.
   */
  void SetStackLimit(uintptr_t stack_limit);

7129 7130 7131 7132 7133 7134
  /**
   * Returns a memory range that can potentially contain jitted code.
   *
   * On Win64, embedders are advised to install function table callbacks for
   * these ranges, as default SEH won't be able to unwind through jitted code.
   *
7135 7136 7137
   * The first page of the code range is reserved for the embedder and is
   * committed, writable, and executable.
   *
7138 7139 7140 7141 7142 7143
   * Might be empty on other platforms.
   *
   * https://code.google.com/p/v8/issues/detail?id=3598
   */
  void GetCodeRange(void** start, size_t* length_in_bytes);

7144 7145 7146
  /** Set the callback to invoke in case of fatal errors. */
  void SetFatalErrorHandler(FatalErrorCallback that);

7147 7148 7149
  /** Set the callback to invoke in case of OOM errors. */
  void SetOOMErrorHandler(OOMErrorCallback that);

7150 7151 7152 7153 7154 7155 7156
  /**
   * Set the callback to invoke to check if code generation from
   * strings should be allowed.
   */
  void SetAllowCodeGenerationFromStringsCallback(
      AllowCodeGenerationFromStringsCallback callback);

7157 7158 7159 7160 7161 7162 7163 7164 7165 7166
  /**
   * Set the callback to invoke to check if wasm compilation from
   * the specified object is allowed. By default, wasm compilation
   * is allowed.
   *
   * Similar for instantiate.
   */
  void SetAllowWasmCompileCallback(AllowWasmCompileCallback callback);
  void SetAllowWasmInstantiateCallback(AllowWasmInstantiateCallback callback);

7167 7168 7169 7170 7171 7172 7173
  /**
  * Check if V8 is dead and therefore unusable.  This is the case after
  * fatal errors such as out-of-memory situations.
  */
  bool IsDead();

  /**
7174
   * Adds a message listener (errors only).
7175 7176 7177 7178 7179 7180 7181 7182
   *
   * The same message listener can be added more than once and in that
   * case it will be called more than once for each message.
   *
   * If data is specified, it will be passed to the callback when it is called.
   * Otherwise, the exception object will be passed to the callback instead.
   */
  bool AddMessageListener(MessageCallback that,
7183
                          Local<Value> data = Local<Value>());
7184

7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199
  /**
   * Adds a message listener.
   *
   * The same message listener can be added more than once and in that
   * case it will be called more than once for each message.
   *
   * If data is specified, it will be passed to the callback when it is called.
   * Otherwise, the exception object will be passed to the callback instead.
   *
   * A listener can listen for particular error levels by providing a mask.
   */
  bool AddMessageListenerWithErrorLevel(MessageCallback that,
                                        int message_levels,
                                        Local<Value> data = Local<Value>());

7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237
  /**
   * Remove all message listeners from the specified callback function.
   */
  void RemoveMessageListeners(MessageCallback that);

  /** Callback function for reporting failed access checks.*/
  void SetFailedAccessCheckCallbackFunction(FailedAccessCheckCallback);

  /**
   * Tells V8 to capture current stack trace when uncaught exception occurs
   * and report it to the message listeners. The option is off by default.
   */
  void SetCaptureStackTraceForUncaughtExceptions(
      bool capture, int frame_limit = 10,
      StackTrace::StackTraceOptions options = StackTrace::kOverview);

  /**
   * Iterates through all external resources referenced from current isolate
   * heap.  GC is not invoked prior to iterating, therefore there is no
   * guarantee that visited objects are still alive.
   */
  void VisitExternalResources(ExternalResourceVisitor* visitor);

  /**
   * Iterates through all the persistent handles in the current isolate's heap
   * that have class_ids.
   */
  void VisitHandlesWithClassIds(PersistentHandleVisitor* visitor);

  /**
   * Iterates through all the persistent handles in the current isolate's heap
   * that have class_ids and are candidates to be marked as partially dependent
   * handles. This will visit handles to young objects created since the last
   * garbage collection but is free to visit an arbitrary superset of these
   * objects.
   */
  void VisitHandlesForPartialDependence(PersistentHandleVisitor* visitor);

7238 7239 7240 7241 7242 7243 7244
  /**
   * Iterates through all the persistent handles in the current isolate's heap
   * that have class_ids and are weak to be marked as inactive if there is no
   * pending activity for the handle.
   */
  void VisitWeakHandles(PersistentHandleVisitor* visitor);

7245 7246 7247 7248 7249 7250
  /**
   * Check if this isolate is in use.
   * True if at least one thread Enter'ed this isolate.
   */
  bool IsInUse();

7251 7252
  Isolate() = delete;
  ~Isolate() = delete;
7253 7254
  Isolate(const Isolate&) = delete;
  Isolate& operator=(const Isolate&) = delete;
7255 7256
  void* operator new(size_t size) = delete;
  void operator delete(void*, size_t) = delete;
7257

7258
 private:
7259 7260
  template <class K, class V, class Traits>
  friend class PersistentValueMapBase;
7261

7262
  void ReportExternalAllocationLimitReached();
7263
};
7264

7265
class V8_EXPORT StartupData {
7266 7267 7268 7269 7270
 public:
  const char* data;
  int raw_size;
};

7271

7272 7273 7274 7275 7276 7277
/**
 * EntropySource is used as a callback function when v8 needs a source
 * of entropy.
 */
typedef bool (*EntropySource)(unsigned char* buffer, size_t length);

7278 7279 7280 7281 7282
/**
 * ReturnAddressLocationResolver is used as a callback function when v8 is
 * resolving the location of a return address on the stack. Profilers that
 * change the return address on the stack can use this to resolve the stack
 * location to whereever the profiler stashed the original return address.
7283
 *
7284
 * \param return_addr_location A location on stack where a machine
7285
 *    return address resides.
7286
 * \returns Either return_addr_location, or else a pointer to the profiler's
7287 7288
 *    copy of the original return address.
 *
7289
 * \note The resolver function must not cause garbage collection.
7290 7291 7292 7293 7294
 */
typedef uintptr_t (*ReturnAddressLocationResolver)(
    uintptr_t return_addr_location);


7295 7296 7297
/**
 * Container class for static utility functions.
 */
7298
class V8_EXPORT V8 {
7299
 public:
7300
  /** Set the callback to invoke in case of fatal errors. */
7301
  V8_INLINE static V8_DEPRECATED(
7302 7303
      "Use isolate version",
      void SetFatalErrorHandler(FatalErrorCallback that));
7304

7305 7306 7307 7308
  /**
   * Set the callback to invoke to check if code generation from
   * strings should be allowed.
   */
7309
  V8_INLINE static V8_DEPRECATED(
7310 7311
      "Use isolate version", void SetAllowCodeGenerationFromStringsCallback(
                                 AllowCodeGenerationFromStringsCallback that));
7312

7313
  /**
7314 7315 7316
  * Check if V8 is dead and therefore unusable.  This is the case after
  * fatal errors such as out-of-memory situations.
  */
7317
  V8_INLINE static V8_DEPRECATED("Use isolate version", bool IsDead());
7318

7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336
  /**
   * Hand startup data to V8, in case the embedder has chosen to build
   * V8 with external startup data.
   *
   * Note:
   * - By default the startup data is linked into the V8 library, in which
   *   case this function is not meaningful.
   * - If this needs to be called, it needs to be called before V8
   *   tries to make use of its built-ins.
   * - To avoid unnecessary copies of data, V8 will point directly into the
   *   given data blob, so pretty please keep it around until V8 exit.
   * - Compression of the startup blob might be useful, but needs to
   *   handled entirely on the embedders' side.
   * - The call will abort if the data is invalid.
   */
  static void SetNativesDataBlob(StartupData* startup_blob);
  static void SetSnapshotDataBlob(StartupData* startup_blob);

7337
  /**
7338 7339
   * Bootstrap an isolate and a context from scratch to create a startup
   * snapshot. Include the side-effects of running the optional script.
7340
   * Returns { NULL, 0 } on failure.
7341
   * The caller acquires ownership of the data array in the return value.
7342
   */
7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354
  static StartupData CreateSnapshotDataBlob(const char* embedded_source = NULL);

  /**
   * Bootstrap an isolate and a context from the cold startup blob, run the
   * warm-up script to trigger code compilation. The side effects are then
   * discarded. The resulting startup snapshot will include compiled code.
   * Returns { NULL, 0 } on failure.
   * The caller acquires ownership of the data array in the return value.
   * The argument startup blob is untouched.
   */
  static StartupData WarmUpSnapshotDataBlob(StartupData cold_startup_blob,
                                            const char* warmup_source);
7355

7356
  /**
7357 7358
   * Adds a message listener.
   *
7359
   * The same message listener can be added more than once and in that
7360
   * case it will be called more than once for each message.
7361 7362 7363
   *
   * If data is specified, it will be passed to the callback when it is called.
   * Otherwise, the exception object will be passed to the callback instead.
7364
   */
7365
  V8_INLINE static V8_DEPRECATED(
7366 7367
      "Use isolate version",
      bool AddMessageListener(MessageCallback that,
7368
                              Local<Value> data = Local<Value>()));
7369 7370 7371 7372

  /**
   * Remove all message listeners from the specified callback function.
   */
7373
  V8_INLINE static V8_DEPRECATED(
7374
      "Use isolate version", void RemoveMessageListeners(MessageCallback that));
7375

7376 7377 7378 7379
  /**
   * Tells V8 to capture current stack trace when uncaught exception occurs
   * and report it to the message listeners. The option is off by default.
   */
7380
  V8_INLINE static V8_DEPRECATED(
7381 7382 7383 7384
      "Use isolate version",
      void SetCaptureStackTraceForUncaughtExceptions(
          bool capture, int frame_limit = 10,
          StackTrace::StackTraceOptions options = StackTrace::kOverview));
7385

7386
  /**
7387
   * Sets V8 flags from a string.
7388 7389 7390
   */
  static void SetFlagsFromString(const char* str, int length);

7391
  /**
7392
   * Sets V8 flags from the command line.
7393 7394 7395 7396 7397
   */
  static void SetFlagsFromCommandLine(int* argc,
                                      char** argv,
                                      bool remove_flags);

7398 7399
  /** Get the version string. */
  static const char* GetVersion();
7400 7401

  /** Callback function for reporting failed access checks.*/
7402
  V8_INLINE static V8_DEPRECATED(
7403 7404
      "Use isolate version",
      void SetFailedAccessCheckCallbackFunction(FailedAccessCheckCallback));
7405 7406

  /**
7407
   * Enables the host application to receive a notification before a
7408 7409 7410 7411 7412 7413 7414 7415
   * garbage collection.  Allocations are not allowed in the
   * callback function, you therefore cannot manipulate objects (set
   * or delete properties for example) since it is possible such
   * operations will result in the allocation of objects. It is possible
   * to specify the GCType filter for your callback. But it is not possible to
   * register the same callback function two times with different
   * GCType filters.
   */
7416
  static V8_DEPRECATED(
7417
      "Use isolate version",
7418
      void AddGCPrologueCallback(GCCallback callback,
7419
                                 GCType gc_type_filter = kGCTypeAll));
7420 7421 7422 7423 7424

  /**
   * This function removes callback which was installed by
   * AddGCPrologueCallback function.
   */
7425
  V8_INLINE static V8_DEPRECATED(
7426
      "Use isolate version",
7427
      void RemoveGCPrologueCallback(GCCallback callback));
7428

7429
  /**
7430 7431 7432 7433 7434 7435 7436 7437 7438
   * Enables the host application to receive a notification after a
   * garbage collection.  Allocations are not allowed in the
   * callback function, you therefore cannot manipulate objects (set
   * or delete properties for example) since it is possible such
   * operations will result in the allocation of objects. It is possible
   * to specify the GCType filter for your callback. But it is not possible to
   * register the same callback function two times with different
   * GCType filters.
   */
7439
  static V8_DEPRECATED(
7440
      "Use isolate version",
7441
      void AddGCEpilogueCallback(GCCallback callback,
7442
                                 GCType gc_type_filter = kGCTypeAll));
7443 7444 7445 7446 7447

  /**
   * This function removes callback which was installed by
   * AddGCEpilogueCallback function.
   */
7448
  V8_INLINE static V8_DEPRECATED(
7449
      "Use isolate version",
7450
      void RemoveGCEpilogueCallback(GCCallback callback));
7451

7452
  /**
7453 7454
   * Initializes V8. This function needs to be called before the first Isolate
   * is created. It always returns true.
7455 7456 7457
   */
  static bool Initialize();

7458 7459 7460 7461 7462 7463
  /**
   * Allows the host application to provide a callback which can be used
   * as a source of entropy for random number generators.
   */
  static void SetEntropySource(EntropySource source);

7464 7465 7466 7467 7468 7469 7470
  /**
   * Allows the host application to provide a callback that allows v8 to
   * cooperate with a profiler that rewrites return addresses on stack.
   */
  static void SetReturnAddressLocationResolver(
      ReturnAddressLocationResolver return_address_resolver);

7471
  /**
7472
   * Forcefully terminate the current thread of JavaScript execution
7473
   * in the given isolate.
7474 7475 7476
   *
   * This method can be used by any thread even if that thread has not
   * acquired the V8 lock with a Locker object.
7477 7478
   *
   * \param isolate The isolate in which to terminate the current JS execution.
7479
   */
7480 7481
  V8_INLINE static V8_DEPRECATED("Use isolate version",
                                 void TerminateExecution(Isolate* isolate));
7482

7483 7484 7485 7486 7487 7488 7489
  /**
   * Is V8 terminating JavaScript execution.
   *
   * Returns true if JavaScript execution is currently terminating
   * because of a call to TerminateExecution.  In that case there are
   * still JavaScript frames on the stack and the termination
   * exception is still active.
7490 7491
   *
   * \param isolate The isolate in which to check.
7492
   */
7493
  V8_INLINE static V8_DEPRECATED(
7494 7495
      "Use isolate version",
      bool IsExecutionTerminating(Isolate* isolate = NULL));
7496

7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512
  /**
   * Resume execution capability in the given isolate, whose execution
   * was previously forcefully terminated using TerminateExecution().
   *
   * When execution is forcefully terminated using TerminateExecution(),
   * the isolate can not resume execution until all JavaScript frames
   * have propagated the uncatchable exception which is generated.  This
   * method allows the program embedding the engine to handle the
   * termination event and resume execution capability, even if
   * JavaScript frames remain on the stack.
   *
   * This method can be used by any thread even if that thread has not
   * acquired the V8 lock with a Locker object.
   *
   * \param isolate The isolate in which to resume execution capability.
   */
7513
  V8_INLINE static V8_DEPRECATED(
7514
      "Use isolate version", void CancelTerminateExecution(Isolate* isolate));
7515

7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526
  /**
   * Releases any resources used by v8 and stops any utility threads
   * that may be running.  Note that disposing v8 is permanent, it
   * cannot be reinitialized.
   *
   * It should generally not be necessary to dispose v8 before exiting
   * a process, this should happen automatically.  It is only necessary
   * to use if the process needs the resources taken up by v8.
   */
  static bool Dispose();

7527 7528
  /**
   * Iterates through all external resources referenced from current isolate
7529 7530
   * heap.  GC is not invoked prior to iterating, therefore there is no
   * guarantee that visited objects are still alive.
7531
   */
7532
  V8_INLINE static V8_DEPRECATED(
7533
      "Use isolate version",
7534
      void VisitExternalResources(ExternalResourceVisitor* visitor));
7535

7536 7537 7538 7539
  /**
   * Iterates through all the persistent handles in the current isolate's heap
   * that have class_ids.
   */
7540
  V8_INLINE static V8_DEPRECATED(
7541 7542
      "Use isolate version",
      void VisitHandlesWithClassIds(PersistentHandleVisitor* visitor));
7543

7544 7545 7546 7547
  /**
   * Iterates through all the persistent handles in isolate's heap that have
   * class_ids.
   */
7548
  V8_INLINE static V8_DEPRECATED(
7549 7550 7551
      "Use isolate version",
      void VisitHandlesWithClassIds(Isolate* isolate,
                                    PersistentHandleVisitor* visitor));
7552

7553 7554 7555 7556 7557 7558 7559
  /**
   * Iterates through all the persistent handles in the current isolate's heap
   * that have class_ids and are candidates to be marked as partially dependent
   * handles. This will visit handles to young objects created since the last
   * garbage collection but is free to visit an arbitrary superset of these
   * objects.
   */
7560
  V8_INLINE static V8_DEPRECATED(
7561 7562 7563
      "Use isolate version",
      void VisitHandlesForPartialDependence(Isolate* isolate,
                                            PersistentHandleVisitor* visitor));
7564

7565 7566 7567
  /**
   * Initialize the ICU library bundled with V8. The embedder should only
   * invoke this method when using the bundled ICU. Returns true on success.
7568 7569 7570
   *
   * If V8 was compiled with the ICU data in an external file, the location
   * of the data file has to be provided.
7571
   */
7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589
  V8_DEPRECATE_SOON(
      "Use version with default location.",
      static bool InitializeICU(const char* icu_data_file = nullptr));

  /**
   * Initialize the ICU library bundled with V8. The embedder should only
   * invoke this method when using the bundled ICU. If V8 was compiled with
   * the ICU data in an external file and when the default location of that
   * file should be used, a path to the executable must be provided.
   * Returns true on success.
   *
   * The default is a file called icudtl.dat side-by-side with the executable.
   *
   * Optionally, the location of the data file can be provided to override the
   * default.
   */
  static bool InitializeICUDefaultLocation(const char* exec_path,
                                           const char* icu_data_file = nullptr);
7590

vogelheim's avatar
vogelheim committed
7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609
  /**
   * Initialize the external startup data. The embedder only needs to
   * invoke this method when external startup data was enabled in a build.
   *
   * If V8 was compiled with the startup data in an external file, then
   * V8 needs to be given those external files during startup. There are
   * three ways to do this:
   * - InitializeExternalStartupData(const char*)
   *   This will look in the given directory for files "natives_blob.bin"
   *   and "snapshot_blob.bin" - which is what the default build calls them.
   * - InitializeExternalStartupData(const char*, const char*)
   *   As above, but will directly use the two given file names.
   * - Call SetNativesDataBlob, SetNativesDataBlob.
   *   This will read the blobs from the given data structures and will
   *   not perform any file IO.
   */
  static void InitializeExternalStartupData(const char* directory_path);
  static void InitializeExternalStartupData(const char* natives_blob,
                                            const char* snapshot_blob);
7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621
  /**
   * Sets the v8::Platform to use. This should be invoked before V8 is
   * initialized.
   */
  static void InitializePlatform(Platform* platform);

  /**
   * Clears all references to the v8::Platform. This should be invoked after
   * V8 was disposed.
   */
  static void ShutdownPlatform();

eholk's avatar
eholk committed
7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650
#if V8_OS_LINUX && V8_TARGET_ARCH_X64
  /**
   * Give the V8 signal handler a chance to handle a fault.
   *
   * This function determines whether a memory access violation can be recovered
   * by V8. If so, it will return true and modify context to return to a code
   * fragment that can recover from the fault. Otherwise, TryHandleSignal will
   * return false.
   *
   * The parameters to this function correspond to those passed to a Linux
   * signal handler.
   *
   * \param signal_number The signal number.
   *
   * \param info A pointer to the siginfo_t structure provided to the signal
   * handler.
   *
   * \param context The third argument passed to the Linux signal handler, which
   * points to a ucontext_t structure.
   */
  static bool TryHandleSignal(int signal_number, void* info, void* context);
#endif  // V8_OS_LINUX

  /**
   * Enable the default signal handler rather than using one provided by the
   * embedder.
   */
  static bool RegisterDefaultSignalHandler();

7651 7652 7653
 private:
  V8();

7654 7655
  static internal::Object** GlobalizeReference(internal::Isolate* isolate,
                                               internal::Object** handle);
7656
  static internal::Object** CopyPersistent(internal::Object** handle);
7657
  static void DisposeGlobal(internal::Object** global_handle);
7658
  static void MakeWeak(internal::Object** location, void* data,
7659 7660
                       WeakCallbackInfo<void>::Callback weak_callback,
                       WeakCallbackType type);
7661
  static void MakeWeak(internal::Object** location, void* data,
7662 7663 7664 7665 7666
                       // Must be 0 or -1.
                       int internal_field_index1,
                       // Must be 1 or -1.
                       int internal_field_index2,
                       WeakCallbackInfo<void>::Callback weak_callback);
7667 7668
  static void MakeWeak(internal::Object*** location_addr);
  static void* ClearWeak(internal::Object** location);
7669 7670 7671 7672
  static void Eternalize(Isolate* isolate,
                         Value* handle,
                         int* index);
  static Local<Value> GetEternal(Isolate* isolate, int index);
7673

7674 7675 7676
  static void RegisterExternallyReferencedObject(internal::Object** object,
                                                 internal::Isolate* isolate);

7677 7678 7679
  template <class K, class V, class T>
  friend class PersistentValueMapBase;

7680
  static void FromJustIsNothing();
7681
  static void ToLocalEmpty();
7682
  static void InternalFieldOutOfBounds(int index);
7683
  template <class T> friend class Local;
7684
  template <class T>
7685 7686
  friend class MaybeLocal;
  template <class T>
7687
  friend class Maybe;
7688 7689
  template <class T>
  friend class WeakCallbackInfo;
7690
  template <class T> friend class Eternal;
7691
  template <class T> friend class PersistentBase;
7692
  template <class T, class M> friend class Persistent;
7693 7694 7695
  friend class Context;
};

7696 7697 7698
/**
 * Helper class to create a snapshot data blob.
 */
7699
class V8_EXPORT SnapshotCreator {
7700 7701 7702 7703 7704 7705 7706
 public:
  enum class FunctionCodeHandling { kClear, kKeep };

  /**
   * Create and enter an isolate, and set it up for serialization.
   * The isolate is either created from scratch or from an existing snapshot.
   * The caller keeps ownership of the argument snapshot.
7707 7708 7709
   * \param existing_blob existing snapshot from which to create this one.
   * \param external_references a null-terminated array of external references
   *        that must be equivalent to CreateParams::external_references.
7710
   */
7711 7712
  SnapshotCreator(intptr_t* external_references = nullptr,
                  StartupData* existing_blob = nullptr);
7713 7714 7715 7716 7717 7718 7719 7720 7721

  ~SnapshotCreator();

  /**
   * \returns the isolate prepared by the snapshot creator.
   */
  Isolate* GetIsolate();

  /**
7722 7723 7724 7725 7726 7727 7728 7729 7730 7731
   * Set the default context to be included in the snapshot blob.
   * The snapshot will not contain the global proxy, and we expect one or a
   * global object template to create one, to be provided upon deserialization.
   */
  void SetDefaultContext(Local<Context> context);

  /**
   * Add additional context to be included in the snapshot blob.
   * The snapshot will include the global proxy.
   *
7732 7733
   * \param callback optional callback to serialize internal fields.
   *
7734
   * \returns the index of the context in the snapshot blob.
7735
   */
7736
  size_t AddContext(Local<Context> context,
7737 7738
                    SerializeInternalFieldsCallback callback =
                        SerializeInternalFieldsCallback());
7739

7740 7741 7742 7743 7744 7745
  /**
   * Add a template to be included in the snapshot blob.
   * \returns the index of the template in the snapshot blob.
   */
  size_t AddTemplate(Local<Template> template_obj);

7746 7747
  /**
   * Created a snapshot data blob.
7748
   * This must not be called from within a handle scope.
7749 7750 7751 7752 7753
   * \param function_code_handling whether to include compiled function code
   *        in the snapshot.
   * \returns { nullptr, 0 } on failure, and a startup snapshot on success. The
   *        caller acquires ownership of the data array in the return value.
   */
7754
  StartupData CreateBlob(FunctionCodeHandling function_code_handling);
7755

7756 7757 7758 7759
  // Disallow copying and assigning.
  SnapshotCreator(const SnapshotCreator&) = delete;
  void operator=(const SnapshotCreator&) = delete;

7760 7761 7762
 private:
  void* data_;
};
7763

7764 7765
/**
 * A simple Maybe type, representing an object which may or may not have a
7766
 * value, see https://hackage.haskell.org/package/base/docs/Data-Maybe.html.
7767 7768 7769 7770 7771 7772
 *
 * If an API method returns a Maybe<>, the API method can potentially fail
 * either because an exception is thrown, or because an exception is pending,
 * e.g. because a previous API call threw an exception that hasn't been caught
 * yet, or because a TerminateExecution exception was thrown. In that case, a
 * "Nothing" value is returned.
7773 7774 7775 7776
 */
template <class T>
class Maybe {
 public:
7777 7778 7779 7780 7781 7782
  V8_INLINE bool IsNothing() const { return !has_value_; }
  V8_INLINE bool IsJust() const { return has_value_; }

  // Will crash if the Maybe<> is nothing.
  V8_INLINE T ToChecked() const { return FromJust(); }

7783 7784
  V8_WARN_UNUSED_RESULT V8_INLINE bool To(T* out) const {
    if (V8_LIKELY(IsJust())) *out = value_;
7785 7786
    return IsJust();
  }
7787

7788
  // Will crash if the Maybe<> is nothing.
7789
  V8_INLINE T FromJust() const {
7790
    if (V8_UNLIKELY(!IsJust())) V8::FromJustIsNothing();
7791
    return value_;
7792 7793 7794
  }

  V8_INLINE T FromMaybe(const T& default_value) const {
7795
    return has_value_ ? value_ : default_value;
7796 7797
  }

7798 7799 7800 7801 7802 7803 7804 7805 7806 7807
  V8_INLINE bool operator==(const Maybe& other) const {
    return (IsJust() == other.IsJust()) &&
           (!IsJust() || FromJust() == other.FromJust());
  }

  V8_INLINE bool operator!=(const Maybe& other) const {
    return !operator==(other);
  }

 private:
7808 7809
  Maybe() : has_value_(false) {}
  explicit Maybe(const T& t) : has_value_(true), value_(t) {}
7810

7811 7812
  bool has_value_;
  T value_;
7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832

  template <class U>
  friend Maybe<U> Nothing();
  template <class U>
  friend Maybe<U> Just(const U& u);
};


template <class T>
inline Maybe<T> Nothing() {
  return Maybe<T>();
}


template <class T>
inline Maybe<T> Just(const T& t) {
  return Maybe<T>(t);
}


7833 7834 7835
/**
 * An external exception handler.
 */
7836
class V8_EXPORT TryCatch {
7837 7838
 public:
  /**
7839 7840 7841
   * Creates a new try/catch block and registers it with v8.  Note that
   * all TryCatch blocks should be stack allocated because the memory
   * location itself is compared against JavaScript try/catch blocks.
7842
   */
7843
  V8_DEPRECATED("Use isolate version", TryCatch());
7844

7845 7846 7847 7848 7849 7850 7851
  /**
   * Creates a new try/catch block and registers it with v8.  Note that
   * all TryCatch blocks should be stack allocated because the memory
   * location itself is compared against JavaScript try/catch blocks.
   */
  TryCatch(Isolate* isolate);

7852 7853 7854 7855 7856 7857 7858 7859
  /**
   * Unregisters and deletes this try/catch block.
   */
  ~TryCatch();

  /**
   * Returns true if an exception has been caught by this try/catch block.
   */
7860
  bool HasCaught() const;
7861

7862
  /**
7863
   * For certain types of exceptions, it makes no sense to continue execution.
7864
   *
7865 7866 7867 7868
   * If CanContinue returns false, the correct action is to perform any C++
   * cleanup needed and then return.  If CanContinue returns false and
   * HasTerminated returns true, it is possible to call
   * CancelTerminateExecution in order to continue calling into the engine.
7869
   */
7870
  bool CanContinue() const;
7871

7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885
  /**
   * Returns true if an exception has been caught due to script execution
   * being terminated.
   *
   * There is no JavaScript representation of an execution termination
   * exception.  Such exceptions are thrown when the TerminateExecution
   * methods are called to terminate a long-running script.
   *
   * If such an exception has been thrown, HasTerminated will return true,
   * indicating that it is possible to call CancelTerminateExecution in order
   * to continue calling into the engine.
   */
  bool HasTerminated() const;

7886 7887 7888 7889 7890 7891 7892
  /**
   * Throws the exception caught by this TryCatch in a way that avoids
   * it being caught again by this same TryCatch.  As with ThrowException
   * it is illegal to execute any JavaScript operations after calling
   * ReThrow; the caller must return immediately to where the exception
   * is caught.
   */
7893
  Local<Value> ReThrow();
7894

7895 7896 7897 7898 7899 7900
  /**
   * Returns the exception caught by this try/catch block.  If no exception has
   * been caught an empty handle is returned.
   *
   * The returned handle is valid until this TryCatch block has been destroyed.
   */
7901
  Local<Value> Exception() const;
7902

7903 7904 7905 7906
  /**
   * Returns the .stack property of the thrown object.  If no .stack
   * property is present an empty handle is returned.
   */
7907
  V8_DEPRECATE_SOON("Use maybe version.", Local<Value> StackTrace() const);
7908 7909
  V8_WARN_UNUSED_RESULT MaybeLocal<Value> StackTrace(
      Local<Context> context) const;
7910

7911 7912 7913 7914 7915 7916 7917
  /**
   * Returns the message associated with this exception.  If there is
   * no message associated an empty handle is returned.
   *
   * The returned handle is valid until this TryCatch block has been
   * destroyed.
   */
7918
  Local<v8::Message> Message() const;
7919

7920 7921
  /**
   * Clears any exceptions that may have been caught by this try/catch block.
7922 7923
   * After this method has been called, HasCaught() will return false. Cancels
   * the scheduled exception if it is caught and ReThrow() is not called before.
7924 7925 7926 7927 7928 7929 7930 7931
   *
   * It is not necessary to clear a try/catch block before using it again; if
   * another exception is thrown the previously caught exception will just be
   * overwritten.  However, it is often a good idea since it makes it easier
   * to determine which operation threw a given exception.
   */
  void Reset();

7932 7933 7934 7935 7936 7937 7938 7939
  /**
   * Set verbosity of the external exception handler.
   *
   * By default, exceptions that are caught by an external exception
   * handler are not reported.  Call SetVerbose with true on an
   * external exception handler to have exceptions caught by the
   * handler reported as if they were not caught.
   */
7940 7941
  void SetVerbose(bool value);

7942 7943 7944 7945 7946 7947 7948
  /**
   * Set whether or not this TryCatch should capture a Message object
   * which holds source information about where the exception
   * occurred.  True by default.
   */
  void SetCaptureMessage(bool value);

7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959
  /**
   * There are cases when the raw address of C++ TryCatch object cannot be
   * used for comparisons with addresses into the JS stack. The cases are:
   * 1) ARM, ARM64 and MIPS simulators which have separate JS stack.
   * 2) Address sanitizer allocates local C++ object in the heap when
   *    UseAfterReturn mode is enabled.
   * This method returns address that can be used for comparisons with
   * addresses into the JS stack. When neither simulator nor ASAN's
   * UseAfterReturn is enabled, then the address returned will be the address
   * of the C++ try catch handler itself.
   */
7960
  static void* JSStackComparableAddress(TryCatch* handler) {
7961 7962 7963 7964
    if (handler == NULL) return NULL;
    return handler->js_stack_comparable_address_;
  }

7965 7966
  TryCatch(const TryCatch&) = delete;
  void operator=(const TryCatch&) = delete;
7967 7968
  void* operator new(size_t size);
  void operator delete(void*, size_t);
7969

7970
 private:
7971 7972
  void ResetInternal();

7973 7974
  internal::Isolate* isolate_;
  TryCatch* next_;
7975
  void* exception_;
7976
  void* message_obj_;
7977
  void* js_stack_comparable_address_;
7978 7979 7980 7981
  bool is_verbose_ : 1;
  bool can_continue_ : 1;
  bool capture_message_ : 1;
  bool rethrow_ : 1;
7982
  bool has_terminated_ : 1;
7983

7984
  friend class internal::Isolate;
7985 7986 7987
};


7988
// --- Context ---
7989 7990 7991


/**
7992
 * A container for extension names.
7993
 */
7994
class V8_EXPORT ExtensionConfiguration {
7995
 public:
7996
  ExtensionConfiguration() : name_count_(0), names_(NULL) { }
7997 7998
  ExtensionConfiguration(int name_count, const char* names[])
      : name_count_(name_count), names_(names) { }
7999 8000 8001 8002

  const char** begin() const { return &names_[0]; }
  const char** end()  const { return &names_[name_count_]; }

8003
 private:
8004
  const int name_count_;
8005 8006 8007 8008 8009 8010 8011
  const char** names_;
};

/**
 * A sandboxed execution context with its own set of built-in objects
 * and functions.
 */
8012
class V8_EXPORT Context {
8013
 public:
8014
  /**
8015
   * Returns the global proxy object.
8016
   *
8017 8018 8019
   * Global proxy object is a thin wrapper whose prototype points to actual
   * context's global object with the properties like Object, etc. This is done
   * that way for security reasons (for more details see
8020 8021 8022
   * https://wiki.mozilla.org/Gecko:SplitWindow).
   *
   * Please note that changes to global proxy object prototype most probably
8023 8024
   * would break VM---v8 expects only global object as a prototype of global
   * proxy object.
8025
   */
8026 8027
  Local<Object> Global();

8028 8029 8030 8031 8032 8033
  /**
   * Detaches the global object from its context before
   * the global object can be reused to create a new context.
   */
  void DetachGlobal();

8034 8035 8036
  /**
   * Creates a new context and returns a handle to the newly allocated
   * context.
8037
   *
8038
   * \param isolate The isolate in which to create the context.
8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050
   *
   * \param extensions An optional extension configuration containing
   * the extensions to be installed in the newly created context.
   *
   * \param global_template An optional object template from which the
   * global object for the newly created context will be created.
   *
   * \param global_object An optional global object to be reused for
   * the newly created context. This global object must have been
   * created by a previous call to Context::New with the same global
   * template. The state of the global object will be completely reset
   * and only object identify will remain.
8051
   */
8052
  static Local<Context> New(
8053
      Isolate* isolate, ExtensionConfiguration* extensions = NULL,
8054 8055
      MaybeLocal<ObjectTemplate> global_template = MaybeLocal<ObjectTemplate>(),
      MaybeLocal<Value> global_object = MaybeLocal<Value>());
8056

8057 8058
  /**
   * Create a new context from a (non-default) context snapshot. There
8059 8060
   * is no way to provide a global object template since we do not create
   * a new global object from template, but we can reuse a global object.
8061 8062 8063 8064 8065 8066
   *
   * \param isolate See v8::Context::New.
   *
   * \param context_snapshot_index The index of the context snapshot to
   * deserialize from. Use v8::Context::New for the default snapshot.
   *
8067 8068 8069 8070
   * \param internal_fields_deserializer Optional callback to deserialize
   * internal fields. It should match the SerializeInternalFieldCallback used
   * to serialize.
   *
8071
   * \param extensions See v8::Context::New.
8072 8073
   *
   * \param global_object See v8::Context::New.
8074 8075
   */

8076 8077
  static MaybeLocal<Context> FromSnapshot(
      Isolate* isolate, size_t context_snapshot_index,
8078 8079
      DeserializeInternalFieldsCallback internal_fields_deserializer =
          DeserializeInternalFieldsCallback(),
8080 8081
      ExtensionConfiguration* extensions = nullptr,
      MaybeLocal<Value> global_object = MaybeLocal<Value>());
8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096

  /**
   * Returns an global object that isn't backed by an actual context.
   *
   * The global template needs to have access checks with handlers installed.
   * If an existing global object is passed in, the global object is detached
   * from its context.
   *
   * Note that this is different from a detached context where all accesses to
   * the global proxy will fail. Instead, the access check handlers are invoked.
   *
   * It is also not possible to detach an object returned by this method.
   * Instead, the access check handlers need to return nothing to achieve the
   * same effect.
   *
8097
   * It is possible, however, to create a new context from the global object
8098 8099 8100 8101 8102
   * returned by this method.
   */
  static MaybeLocal<Object> NewRemoteContext(
      Isolate* isolate, Local<ObjectTemplate> global_template,
      MaybeLocal<Value> global_object = MaybeLocal<Value>());
8103

8104 8105 8106 8107
  /**
   * Sets the security token for the context.  To access an object in
   * another context, the security tokens must match.
   */
8108
  void SetSecurityToken(Local<Value> token);
8109

8110 8111 8112
  /** Restores the security token to the default value. */
  void UseDefaultSecurityToken();

8113
  /** Returns the security token of this context.*/
8114
  Local<Value> GetSecurityToken();
8115

8116 8117 8118 8119 8120 8121
  /**
   * Enter this context.  After entering a context, all code compiled
   * and run is compiled and run in this context.  If another context
   * is already entered, this old context is saved so it can be
   * restored when the new context is exited.
   */
8122
  void Enter();
8123 8124 8125 8126 8127

  /**
   * Exit this context.  Exiting the current context restores the
   * context that was in place when entering the current context.
   */
8128 8129
  void Exit();

8130
  /** Returns an isolate associated with a current context. */
8131
  Isolate* GetIsolate();
8132

8133 8134 8135 8136 8137 8138 8139
  /**
   * The field at kDebugIdIndex is reserved for V8 debugger implementation.
   * The value is propagated to the scripts compiled in given Context and
   * can be used for filtering scripts.
   */
  enum EmbedderDataFields { kDebugIdIndex = 0 };

8140 8141 8142 8143 8144
  /**
   * Gets the embedder data with the given index, which must have been set by a
   * previous call to SetEmbedderData with the same index. Note that index 0
   * currently has a special meaning for Chrome's debugger.
   */
8145
  V8_INLINE Local<Value> GetEmbedderData(int index);
8146

8147
  /**
8148 8149 8150 8151
   * Gets the binding object used by V8 extras. Extra natives get a reference
   * to this object and can use it to "export" functionality by adding
   * properties. Extra natives can also "import" functionality by accessing
   * properties added by the embedder using the V8 API.
8152
   */
8153
  Local<Object> GetExtrasBindingObject();
8154

8155 8156 8157 8158 8159
  /**
   * Sets the embedder data with the given index, growing the data as
   * needed. Note that index 0 currently has a special meaning for Chrome's
   * debugger.
   */
8160
  void SetEmbedderData(int index, Local<Value> value);
8161 8162 8163

  /**
   * Gets a 2-byte-aligned native pointer from the embedder data with the given
8164
   * index, which must have been set by a previous call to
8165 8166 8167
   * SetAlignedPointerInEmbedderData with the same index. Note that index 0
   * currently has a special meaning for Chrome's debugger.
   */
8168
  V8_INLINE void* GetAlignedPointerFromEmbedderData(int index);
8169 8170 8171 8172 8173 8174 8175

  /**
   * Sets a 2-byte-aligned native pointer in the embedder data with the given
   * index, growing the data as needed. Note that index 0 currently has a
   * special meaning for Chrome's debugger.
   */
  void SetAlignedPointerInEmbedderData(int index, void* value);
8176

8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191
  /**
   * Control whether code generation from strings is allowed. Calling
   * this method with false will disable 'eval' and the 'Function'
   * constructor for code running in this context. If 'eval' or the
   * 'Function' constructor are used an exception will be thrown.
   *
   * If code generation from strings is not allowed the
   * V8::AllowCodeGenerationFromStrings callback will be invoked if
   * set before blocking the call to 'eval' or the 'Function'
   * constructor. If that callback returns true, the call will be
   * allowed, otherwise an exception will be thrown. If no callback is
   * set an exception will be thrown.
   */
  void AllowCodeGenerationFromStrings(bool allow);

8192 8193 8194 8195 8196 8197
  /**
   * Returns true if code generation from strings is allowed for the context.
   * For more details see AllowCodeGenerationFromStrings(bool) documentation.
   */
  bool IsCodeGenerationFromStringsAllowed();

8198 8199 8200 8201 8202
  /**
   * Sets the error description for the exception that is thrown when
   * code generation from strings is not allowed and 'eval' or the 'Function'
   * constructor are called.
   */
8203
  void SetErrorMessageForCodeGenerationFromStrings(Local<String> message);
8204

8205 8206 8207 8208 8209
  /**
   * Estimate the memory in bytes retained by this context.
   */
  size_t EstimatedSize();

8210 8211 8212 8213
  /**
   * Stack-allocated class which sets the execution context for all
   * operations executed within a local scope.
   */
8214
  class Scope {
8215
   public:
8216
    explicit V8_INLINE Scope(Local<Context> context) : context_(context) {
8217 8218
      context_->Enter();
    }
8219
    V8_INLINE ~Scope() { context_->Exit(); }
8220

8221
   private:
8222
    Local<Context> context_;
8223 8224 8225 8226 8227 8228 8229
  };

 private:
  friend class Value;
  friend class Script;
  friend class Object;
  friend class Function;
8230 8231 8232

  Local<Value> SlowGetEmbedderData(int index);
  void* SlowGetAlignedPointerFromEmbedderData(int index);
8233 8234 8235 8236
};


/**
8237 8238 8239 8240 8241 8242 8243
 * Multiple threads in V8 are allowed, but only one thread at a time is allowed
 * to use any given V8 isolate, see the comments in the Isolate class. The
 * definition of 'using a V8 isolate' includes accessing handles or holding onto
 * object pointers obtained from V8 handles while in the particular V8 isolate.
 * It is up to the user of V8 to ensure, perhaps with locking, that this
 * constraint is not violated. In addition to any other synchronization
 * mechanism that may be used, the v8::Locker and v8::Unlocker classes must be
8244
 * used to signal thread switches to V8.
8245
 *
8246 8247 8248 8249
 * v8::Locker is a scoped lock object. While it's active, i.e. between its
 * construction and destruction, the current thread is allowed to use the locked
 * isolate. V8 guarantees that an isolate can be locked by at most one thread at
 * any time. In other words, the scope of a v8::Locker is a critical section.
8250
 *
8251 8252
 * Sample usage:
* \code
8253 8254
 * ...
 * {
8255 8256
 *   v8::Locker locker(isolate);
 *   v8::Isolate::Scope isolate_scope(isolate);
8257
 *   ...
8258
 *   // Code using V8 and isolate goes here.
8259 8260
 *   ...
 * } // Destructor called here
8261
 * \endcode
8262
 *
8263 8264 8265
 * If you wish to stop using V8 in a thread A you can do this either by
 * destroying the v8::Locker object as above or by constructing a v8::Unlocker
 * object:
8266
 *
8267
 * \code
8268
 * {
8269 8270
 *   isolate->Exit();
 *   v8::Unlocker unlocker(isolate);
8271 8272 8273 8274
 *   ...
 *   // Code not using V8 goes here while V8 can run in another thread.
 *   ...
 * } // Destructor called here.
8275
 * isolate->Enter();
8276
 * \endcode
8277
 *
8278 8279
 * The Unlocker object is intended for use in a long-running callback from V8,
 * where you want to release the V8 lock for other threads to use.
8280
 *
8281 8282 8283 8284 8285
 * The v8::Locker is a recursive lock, i.e. you can lock more than once in a
 * given thread. This can be useful if you have code that can be called either
 * from code that holds the lock or from code that does not. The Unlocker is
 * not recursive so you can not have several Unlockers on the stack at once, and
 * you can not use an Unlocker in a thread that is not inside a Locker's scope.
8286
 *
8287 8288
 * An unlocker will unlock several lockers if it has to and reinstate the
 * correct depth of locking on its destruction, e.g.:
8289
 *
8290
 * \code
8291 8292
 * // V8 not locked.
 * {
8293 8294
 *   v8::Locker locker(isolate);
 *   Isolate::Scope isolate_scope(isolate);
8295 8296
 *   // V8 locked.
 *   {
8297
 *     v8::Locker another_locker(isolate);
8298 8299
 *     // V8 still locked (2 levels).
 *     {
8300 8301
 *       isolate->Exit();
 *       v8::Unlocker unlocker(isolate);
8302 8303
 *       // V8 not locked.
 *     }
8304
 *     isolate->Enter();
8305 8306 8307 8308 8309
 *     // V8 locked again (2 levels).
 *   }
 *   // V8 still locked (1 level).
 * }
 * // V8 Now no longer locked.
8310
 * \endcode
8311
 */
8312
class V8_EXPORT Unlocker {
8313
 public:
8314
  /**
8315
   * Initialize Unlocker for a given Isolate.
8316
   */
8317
  V8_INLINE explicit Unlocker(Isolate* isolate) { Initialize(isolate); }
8318

8319
  ~Unlocker();
8320
 private:
8321 8322
  void Initialize(Isolate* isolate);

8323
  internal::Isolate* isolate_;
8324 8325 8326
};


8327
class V8_EXPORT Locker {
8328
 public:
8329
  /**
8330 8331
   * Initialize Locker for a given Isolate.
   */
8332
  V8_INLINE explicit Locker(Isolate* isolate) { Initialize(isolate); }
8333

8334
  ~Locker();
8335

8336
  /**
8337 8338
   * Returns whether or not the locker for a given isolate, is locked by the
   * current thread.
8339
   */
8340
  static bool IsLocked(Isolate* isolate);
8341

8342 8343 8344
  /**
   * Returns whether v8::Locker is being used by this V8 instance.
   */
8345
  static bool IsActive();
8346

8347 8348 8349 8350
  // Disallow copying and assigning.
  Locker(const Locker&) = delete;
  void operator=(const Locker&) = delete;

8351
 private:
8352 8353
  void Initialize(Isolate* isolate);

8354 8355
  bool has_lock_;
  bool top_level_;
8356
  internal::Isolate* isolate_;
8357 8358 8359
};


8360
// --- Implementation ---
8361

8362 8363 8364

namespace internal {

8365 8366
const int kApiPointerSize = sizeof(void*);  // NOLINT
const int kApiIntSize = sizeof(int);  // NOLINT
8367
const int kApiInt64Size = sizeof(int64_t);  // NOLINT
8368 8369 8370 8371 8372 8373 8374 8375 8376 8377

// Tag information for HeapObject.
const int kHeapObjectTag = 1;
const int kHeapObjectTagSize = 2;
const intptr_t kHeapObjectTagMask = (1 << kHeapObjectTagSize) - 1;

// Tag information for Smi.
const int kSmiTag = 0;
const int kSmiTagSize = 1;
const intptr_t kSmiTagMask = (1 << kSmiTagSize) - 1;
8378

8379
template <size_t ptr_size> struct SmiTagging;
8380

8381
template<int kSmiShiftSize>
8382
V8_INLINE internal::Object* IntToSmi(int value) {
8383
  int smi_shift_bits = kSmiTagSize + kSmiShiftSize;
8384 8385
  uintptr_t tagged_value =
      (static_cast<uintptr_t>(value) << smi_shift_bits) | kSmiTag;
8386 8387 8388
  return reinterpret_cast<internal::Object*>(tagged_value);
}

8389
// Smi constants for 32-bit systems.
8390
template <> struct SmiTagging<4> {
8391 8392 8393
  enum { kSmiShiftSize = 0, kSmiValueSize = 31 };
  static int SmiShiftSize() { return kSmiShiftSize; }
  static int SmiValueSize() { return kSmiValueSize; }
8394
  V8_INLINE static int SmiToInt(const internal::Object* value) {
8395 8396 8397 8398
    int shift_bits = kSmiTagSize + kSmiShiftSize;
    // Throw away top 32 bits and shift down (requires >> to be sign extending).
    return static_cast<int>(reinterpret_cast<intptr_t>(value)) >> shift_bits;
  }
8399
  V8_INLINE static internal::Object* IntToSmi(int value) {
8400 8401
    return internal::IntToSmi<kSmiShiftSize>(value);
  }
8402
  V8_INLINE static bool IsValidSmi(intptr_t value) {
8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415
    // To be representable as an tagged small integer, the two
    // most-significant bits of 'value' must be either 00 or 11 due to
    // sign-extension. To check this we add 01 to the two
    // most-significant bits, and check if the most-significant bit is 0
    //
    // CAUTION: The original code below:
    // bool result = ((value + 0x40000000) & 0x80000000) == 0;
    // may lead to incorrect results according to the C language spec, and
    // in fact doesn't work correctly with gcc4.1.1 in some cases: The
    // compiler may produce undefined results in case of signed integer
    // overflow. The computation must be done w/ unsigned ints.
    return static_cast<uintptr_t>(value + 0x40000000U) < 0x80000000U;
  }
8416 8417 8418
};

// Smi constants for 64-bit systems.
8419
template <> struct SmiTagging<8> {
8420 8421 8422
  enum { kSmiShiftSize = 31, kSmiValueSize = 32 };
  static int SmiShiftSize() { return kSmiShiftSize; }
  static int SmiValueSize() { return kSmiValueSize; }
8423
  V8_INLINE static int SmiToInt(const internal::Object* value) {
8424 8425 8426 8427
    int shift_bits = kSmiTagSize + kSmiShiftSize;
    // Shift down and throw away top 32 bits.
    return static_cast<int>(reinterpret_cast<intptr_t>(value) >> shift_bits);
  }
8428
  V8_INLINE static internal::Object* IntToSmi(int value) {
8429 8430
    return internal::IntToSmi<kSmiShiftSize>(value);
  }
8431
  V8_INLINE static bool IsValidSmi(intptr_t value) {
8432 8433 8434
    // To be representable as a long smi, the value must be a 32-bit integer.
    return (value == static_cast<int32_t>(value));
  }
8435 8436
};

8437 8438 8439
typedef SmiTagging<kApiPointerSize> PlatformSmiTagging;
const int kSmiShiftSize = PlatformSmiTagging::kSmiShiftSize;
const int kSmiValueSize = PlatformSmiTagging::kSmiValueSize;
8440 8441
V8_INLINE static bool SmiValuesAre31Bits() { return kSmiValueSize == 31; }
V8_INLINE static bool SmiValuesAre32Bits() { return kSmiValueSize == 32; }
8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452

/**
 * This class exports constants and functionality from within v8 that
 * is necessary to implement inline functions in the v8 api.  Don't
 * depend on functions and constants defined here.
 */
class Internals {
 public:
  // These values match non-compiler-dependent values defined within
  // the implementation of v8.
  static const int kHeapObjectMapOffset = 0;
8453 8454
  static const int kMapInstanceTypeAndBitFieldOffset =
      1 * kApiPointerSize + kApiIntSize;
8455
  static const int kStringResourceOffset = 3 * kApiPointerSize;
8456

8457
  static const int kOddballKindOffset = 4 * kApiPointerSize + sizeof(double);
8458
  static const int kForeignAddressOffset = kApiPointerSize;
8459
  static const int kJSObjectHeaderSize = 3 * kApiPointerSize;
8460 8461
  static const int kFixedArrayHeaderSize = 2 * kApiPointerSize;
  static const int kContextHeaderSize = 2 * kApiPointerSize;
8462
  static const int kContextEmbedderDataIndex = 5;
8463 8464
  static const int kFullStringRepresentationMask = 0x0f;
  static const int kStringEncodingMask = 0x8;
8465
  static const int kExternalTwoByteRepresentationTag = 0x02;
8466
  static const int kExternalOneByteRepresentationTag = 0x0a;
8467

8468
  static const int kIsolateEmbedderDataOffset = 0 * kApiPointerSize;
8469 8470 8471 8472 8473
  static const int kExternalMemoryOffset = 4 * kApiPointerSize;
  static const int kExternalMemoryLimitOffset =
      kExternalMemoryOffset + kApiInt64Size;
  static const int kIsolateRootsOffset = kExternalMemoryLimitOffset +
                                         kApiInt64Size + kApiInt64Size +
8474
                                         kApiPointerSize + kApiPointerSize;
8475
  static const int kUndefinedValueRootIndex = 4;
8476
  static const int kTheHoleValueRootIndex = 5;
8477 8478 8479 8480
  static const int kNullValueRootIndex = 6;
  static const int kTrueValueRootIndex = 7;
  static const int kFalseValueRootIndex = 8;
  static const int kEmptyStringRootIndex = 9;
8481

8482 8483
  static const int kNodeClassIdOffset = 1 * kApiPointerSize;
  static const int kNodeFlagsOffset = 1 * kApiPointerSize + 3;
8484
  static const int kNodeStateMask = 0x7;
8485
  static const int kNodeStateIsWeakValue = 2;
8486
  static const int kNodeStateIsPendingValue = 3;
8487
  static const int kNodeStateIsNearDeathValue = 4;
8488
  static const int kNodeIsIndependentShift = 3;
8489
  static const int kNodeIsActiveShift = 4;
8490

Toon Verwaest's avatar
Toon Verwaest committed
8491 8492
  static const int kJSApiObjectType = 0xb9;
  static const int kJSObjectType = 0xba;
8493
  static const int kFirstNonstringType = 0x80;
bbudge's avatar
bbudge committed
8494 8495
  static const int kOddballType = 0x82;
  static const int kForeignType = 0x86;
8496

8497 8498 8499
  static const int kUndefinedOddballKind = 5;
  static const int kNullOddballKind = 3;

8500 8501
  static const uint32_t kNumIsolateDataSlots = 4;

8502
  V8_EXPORT static void CheckInitializedImpl(v8::Isolate* isolate);
8503
  V8_INLINE static void CheckInitialized(v8::Isolate* isolate) {
8504
#ifdef V8_ENABLE_CHECKS
8505
    CheckInitializedImpl(isolate);
8506
#endif
8507
  }
8508

8509
  V8_INLINE static bool HasHeapObjectTag(const internal::Object* value) {
8510 8511 8512
    return ((reinterpret_cast<intptr_t>(value) & kHeapObjectTagMask) ==
            kHeapObjectTag);
  }
8513

8514
  V8_INLINE static int SmiValue(const internal::Object* value) {
8515
    return PlatformSmiTagging::SmiToInt(value);
8516
  }
8517

8518
  V8_INLINE static internal::Object* IntToSmi(int value) {
8519 8520 8521
    return PlatformSmiTagging::IntToSmi(value);
  }

8522
  V8_INLINE static bool IsValidSmi(intptr_t value) {
8523 8524 8525
    return PlatformSmiTagging::IsValidSmi(value);
  }

8526
  V8_INLINE static int GetInstanceType(const internal::Object* obj) {
8527 8528
    typedef internal::Object O;
    O* map = ReadField<O*>(obj, kHeapObjectMapOffset);
8529 8530 8531
    // Map::InstanceType is defined so that it will always be loaded into
    // the LS 8 bits of one 16-bit word, regardless of endianess.
    return ReadField<uint16_t>(map, kMapInstanceTypeAndBitFieldOffset) & 0xff;
8532 8533
  }

8534
  V8_INLINE static int GetOddballKind(const internal::Object* obj) {
8535 8536 8537 8538
    typedef internal::Object O;
    return SmiValue(ReadField<O*>(obj, kOddballKindOffset));
  }

8539
  V8_INLINE static bool IsExternalTwoByteString(int instance_type) {
8540 8541 8542 8543
    int representation = (instance_type & kFullStringRepresentationMask);
    return representation == kExternalTwoByteRepresentationTag;
  }

8544
  V8_INLINE static uint8_t GetNodeFlag(internal::Object** obj, int shift) {
8545
      uint8_t* addr = reinterpret_cast<uint8_t*>(obj) + kNodeFlagsOffset;
8546
      return *addr & static_cast<uint8_t>(1U << shift);
8547 8548
  }

8549 8550
  V8_INLINE static void UpdateNodeFlag(internal::Object** obj,
                                       bool value, int shift) {
8551
      uint8_t* addr = reinterpret_cast<uint8_t*>(obj) + kNodeFlagsOffset;
8552
      uint8_t mask = static_cast<uint8_t>(1U << shift);
8553
      *addr = static_cast<uint8_t>((*addr & ~mask) | (value << shift));
8554 8555
  }

8556
  V8_INLINE static uint8_t GetNodeState(internal::Object** obj) {
8557 8558 8559 8560
    uint8_t* addr = reinterpret_cast<uint8_t*>(obj) + kNodeFlagsOffset;
    return *addr & kNodeStateMask;
  }

8561 8562
  V8_INLINE static void UpdateNodeState(internal::Object** obj,
                                        uint8_t value) {
8563
    uint8_t* addr = reinterpret_cast<uint8_t*>(obj) + kNodeFlagsOffset;
8564
    *addr = static_cast<uint8_t>((*addr & ~kNodeStateMask) | value);
8565 8566
  }

8567
  V8_INLINE static void SetEmbedderData(v8::Isolate* isolate,
8568
                                        uint32_t slot,
8569
                                        void* data) {
8570
    uint8_t* addr = reinterpret_cast<uint8_t*>(isolate) +
8571
                    kIsolateEmbedderDataOffset + slot * kApiPointerSize;
8572 8573 8574
    *reinterpret_cast<void**>(addr) = data;
  }

8575 8576 8577
  V8_INLINE static void* GetEmbedderData(const v8::Isolate* isolate,
                                         uint32_t slot) {
    const uint8_t* addr = reinterpret_cast<const uint8_t*>(isolate) +
8578
        kIsolateEmbedderDataOffset + slot * kApiPointerSize;
8579
    return *reinterpret_cast<void* const*>(addr);
8580 8581
  }

8582 8583
  V8_INLINE static internal::Object** GetRoot(v8::Isolate* isolate,
                                              int index) {
8584 8585 8586 8587
    uint8_t* addr = reinterpret_cast<uint8_t*>(isolate) + kIsolateRootsOffset;
    return reinterpret_cast<internal::Object**>(addr + index * kApiPointerSize);
  }

8588
  template <typename T>
8589 8590 8591 8592
  V8_INLINE static T ReadField(const internal::Object* ptr, int offset) {
    const uint8_t* addr =
        reinterpret_cast<const uint8_t*>(ptr) + offset - kHeapObjectTag;
    return *reinterpret_cast<const T*>(addr);
8593
  }
8594

8595
  template <typename T>
8596
  V8_INLINE static T ReadEmbedderData(const v8::Context* context, int index) {
8597 8598
    typedef internal::Object O;
    typedef internal::Internals I;
8599
    O* ctx = *reinterpret_cast<O* const*>(context);
8600 8601 8602 8603 8604 8605 8606
    int embedder_data_offset = I::kContextHeaderSize +
        (internal::kApiPointerSize * I::kContextEmbedderDataIndex);
    O* embedder_data = I::ReadField<O*>(ctx, embedder_data_offset);
    int value_offset =
        I::kFixedArrayHeaderSize + (internal::kApiPointerSize * index);
    return I::ReadField<T>(embedder_data, value_offset);
  }
8607 8608
};

8609
}  // namespace internal
8610 8611


8612
template <class T>
8613
Local<T> Local<T>::New(Isolate* isolate, Local<T> that) {
8614 8615 8616 8617
  return New(isolate, that.val_);
}

template <class T>
8618
Local<T> Local<T>::New(Isolate* isolate, const PersistentBase<T>& that) {
8619 8620 8621 8622 8623 8624 8625 8626
  return New(isolate, that.val_);
}


template <class T>
Local<T> Local<T>::New(Isolate* isolate, T* that) {
  if (that == NULL) return Local<T>();
  T* that_ptr = that;
8627 8628 8629 8630 8631 8632
  internal::Object** p = reinterpret_cast<internal::Object**>(that_ptr);
  return Local<T>(reinterpret_cast<T*>(HandleScope::CreateHandle(
      reinterpret_cast<internal::Isolate*>(isolate), *p)));
}


8633
template<class T>
8634 8635 8636
template<class S>
void Eternal<T>::Set(Isolate* isolate, Local<S> handle) {
  TYPE_CHECK(T, S);
dcarney@chromium.org's avatar
dcarney@chromium.org committed
8637
  V8::Eternalize(isolate, reinterpret_cast<Value*>(*handle), &this->index_);
8638 8639 8640 8641
}


template<class T>
8642
Local<T> Eternal<T>::Get(Isolate* isolate) {
dcarney@chromium.org's avatar
dcarney@chromium.org committed
8643
  return Local<T>(reinterpret_cast<T*>(*V8::GetEternal(isolate, index_)));
8644 8645 8646
}


8647 8648
template <class T>
Local<T> MaybeLocal<T>::ToLocalChecked() {
8649
  if (V8_UNLIKELY(val_ == nullptr)) V8::ToLocalEmpty();
8650 8651 8652 8653
  return Local<T>(val_);
}


8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664
template <class T>
void* WeakCallbackInfo<T>::GetInternalField(int index) const {
#ifdef V8_ENABLE_CHECKS
  if (index < 0 || index >= kInternalFieldsInWeakCallback) {
    V8::InternalFieldOutOfBounds(index);
  }
#endif
  return internal_fields_[index];
}


8665 8666
template <class T>
T* PersistentBase<T>::New(Isolate* isolate, T* that) {
8667
  if (that == NULL) return NULL;
8668
  internal::Object** p = reinterpret_cast<internal::Object**>(that);
8669
  return reinterpret_cast<T*>(
8670
      V8::GlobalizeReference(reinterpret_cast<internal::Isolate*>(isolate),
8671
                             p));
8672 8673 8674
}


8675 8676 8677 8678
template <class T, class M>
template <class S, class M2>
void Persistent<T, M>::Copy(const Persistent<S, M2>& that) {
  TYPE_CHECK(T, S);
8679
  this->Reset();
8680 8681 8682 8683 8684 8685 8686
  if (that.IsEmpty()) return;
  internal::Object** p = reinterpret_cast<internal::Object**>(that.val_);
  this->val_ = reinterpret_cast<T*>(V8::CopyPersistent(p));
  M::Copy(that, this);
}


8687 8688
template <class T>
bool PersistentBase<T>::IsIndependent() const {
8689
  typedef internal::Internals I;
8690
  if (this->IsEmpty()) return false;
8691
  return I::GetNodeFlag(reinterpret_cast<internal::Object**>(this->val_),
8692
                        I::kNodeIsIndependentShift);
8693 8694 8695
}


8696 8697
template <class T>
bool PersistentBase<T>::IsNearDeath() const {
8698
  typedef internal::Internals I;
8699
  if (this->IsEmpty()) return false;
8700 8701 8702 8703
  uint8_t node_state =
      I::GetNodeState(reinterpret_cast<internal::Object**>(this->val_));
  return node_state == I::kNodeStateIsNearDeathValue ||
      node_state == I::kNodeStateIsPendingValue;
8704 8705 8706
}


8707 8708
template <class T>
bool PersistentBase<T>::IsWeak() const {
8709
  typedef internal::Internals I;
8710
  if (this->IsEmpty()) return false;
8711
  return I::GetNodeState(reinterpret_cast<internal::Object**>(this->val_)) ==
8712
      I::kNodeStateIsWeakValue;
8713 8714 8715
}


8716 8717
template <class T>
void PersistentBase<T>::Reset() {
8718 8719 8720
  if (this->IsEmpty()) return;
  V8::DisposeGlobal(reinterpret_cast<internal::Object**>(this->val_));
  val_ = 0;
8721 8722 8723
}


8724
template <class T>
8725
template <class S>
8726
void PersistentBase<T>::Reset(Isolate* isolate, const Local<S>& other) {
8727 8728 8729 8730 8731 8732 8733
  TYPE_CHECK(T, S);
  Reset();
  if (other.IsEmpty()) return;
  this->val_ = New(isolate, other.val_);
}


8734 8735 8736 8737
template <class T>
template <class S>
void PersistentBase<T>::Reset(Isolate* isolate,
                              const PersistentBase<S>& other) {
8738 8739 8740 8741 8742 8743 8744
  TYPE_CHECK(T, S);
  Reset();
  if (other.IsEmpty()) return;
  this->val_ = New(isolate, other.val_);
}


8745 8746 8747 8748 8749 8750 8751 8752
template <class T>
template <typename P>
V8_INLINE void PersistentBase<T>::SetWeak(
    P* parameter, typename WeakCallbackInfo<P>::Callback callback,
    WeakCallbackType type) {
  typedef typename WeakCallbackInfo<void>::Callback Callback;
  V8::MakeWeak(reinterpret_cast<internal::Object**>(this->val_), parameter,
               reinterpret_cast<Callback>(callback), type);
8753 8754
}

8755 8756 8757 8758
template <class T>
void PersistentBase<T>::SetWeak() {
  V8::MakeWeak(reinterpret_cast<internal::Object***>(&this->val_));
}
8759 8760 8761

template <class T>
template <typename P>
8762 8763 8764
P* PersistentBase<T>::ClearWeak() {
  return reinterpret_cast<P*>(
    V8::ClearWeak(reinterpret_cast<internal::Object**>(this->val_)));
8765 8766
}

hlopko's avatar
hlopko committed
8767
template <class T>
8768
void PersistentBase<T>::RegisterExternalReference(Isolate* isolate) const {
hlopko's avatar
hlopko committed
8769
  if (IsEmpty()) return;
8770 8771 8772
  V8::RegisterExternallyReferencedObject(
      reinterpret_cast<internal::Object**>(this->val_),
      reinterpret_cast<internal::Isolate*>(isolate));
hlopko's avatar
hlopko committed
8773
}
8774

8775 8776
template <class T>
void PersistentBase<T>::MarkIndependent() {
8777 8778
  typedef internal::Internals I;
  if (this->IsEmpty()) return;
8779
  I::UpdateNodeFlag(reinterpret_cast<internal::Object**>(this->val_),
8780 8781
                    true,
                    I::kNodeIsIndependentShift);
8782 8783
}

8784 8785 8786 8787 8788 8789 8790 8791 8792
template <class T>
void PersistentBase<T>::MarkActive() {
  typedef internal::Internals I;
  if (this->IsEmpty()) return;
  I::UpdateNodeFlag(reinterpret_cast<internal::Object**>(this->val_), true,
                    I::kNodeIsActiveShift);
}


8793 8794
template <class T>
void PersistentBase<T>::SetWrapperClassId(uint16_t class_id) {
8795
  typedef internal::Internals I;
8796
  if (this->IsEmpty()) return;
8797
  internal::Object** obj = reinterpret_cast<internal::Object**>(this->val_);
8798 8799
  uint8_t* addr = reinterpret_cast<uint8_t*>(obj) + I::kNodeClassIdOffset;
  *reinterpret_cast<uint16_t*>(addr) = class_id;
8800
}
8801

8802

8803 8804
template <class T>
uint16_t PersistentBase<T>::WrapperClassId() const {
8805
  typedef internal::Internals I;
8806
  if (this->IsEmpty()) return 0;
8807
  internal::Object** obj = reinterpret_cast<internal::Object**>(this->val_);
8808 8809
  uint8_t* addr = reinterpret_cast<uint8_t*>(obj) + I::kNodeClassIdOffset;
  return *reinterpret_cast<uint16_t*>(addr);
8810 8811
}

8812

8813 8814 8815 8816
template<typename T>
ReturnValue<T>::ReturnValue(internal::Object** slot) : value_(slot) {}

template<typename T>
8817 8818 8819
template<typename S>
void ReturnValue<T>::Set(const Persistent<S>& handle) {
  TYPE_CHECK(T, S);
8820
  if (V8_UNLIKELY(handle.IsEmpty())) {
8821
    *value_ = GetDefaultValue();
8822 8823 8824
  } else {
    *value_ = *reinterpret_cast<internal::Object**>(*handle);
  }
8825 8826
}

8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840
template <typename T>
template <typename S>
void ReturnValue<T>::Set(const Global<S>& handle) {
  TYPE_CHECK(T, S);
  if (V8_UNLIKELY(handle.IsEmpty())) {
    *value_ = GetDefaultValue();
  } else {
    *value_ = *reinterpret_cast<internal::Object**>(*handle);
  }
}

template <typename T>
template <typename S>
void ReturnValue<T>::Set(const Local<S> handle) {
8841
  TYPE_CHECK(T, S);
8842
  if (V8_UNLIKELY(handle.IsEmpty())) {
8843
    *value_ = GetDefaultValue();
8844 8845 8846
  } else {
    *value_ = *reinterpret_cast<internal::Object**>(*handle);
  }
8847 8848
}

8849
template<typename T>
8850
void ReturnValue<T>::Set(double i) {
8851
  TYPE_CHECK(T, Number);
8852
  Set(Number::New(GetIsolate(), i));
8853 8854 8855
}

template<typename T>
8856
void ReturnValue<T>::Set(int32_t i) {
8857
  TYPE_CHECK(T, Integer);
8858 8859 8860 8861 8862
  typedef internal::Internals I;
  if (V8_LIKELY(I::IsValidSmi(i))) {
    *value_ = I::IntToSmi(i);
    return;
  }
8863
  Set(Integer::New(GetIsolate(), i));
8864 8865 8866
}

template<typename T>
8867
void ReturnValue<T>::Set(uint32_t i) {
8868
  TYPE_CHECK(T, Integer);
8869
  // Can't simply use INT32_MAX here for whatever reason.
8870
  bool fits_into_int32_t = (i & (1U << 31)) == 0;
8871
  if (V8_LIKELY(fits_into_int32_t)) {
8872
    Set(static_cast<int32_t>(i));
8873 8874
    return;
  }
8875
  Set(Integer::NewFromUnsigned(GetIsolate(), i));
8876 8877 8878
}

template<typename T>
8879
void ReturnValue<T>::Set(bool value) {
8880
  TYPE_CHECK(T, Boolean);
8881 8882
  typedef internal::Internals I;
  int root_index;
8883
  if (value) {
8884
    root_index = I::kTrueValueRootIndex;
8885
  } else {
8886
    root_index = I::kFalseValueRootIndex;
8887
  }
8888
  *value_ = *I::GetRoot(GetIsolate(), root_index);
8889 8890 8891
}

template<typename T>
8892
void ReturnValue<T>::SetNull() {
8893
  TYPE_CHECK(T, Primitive);
8894
  typedef internal::Internals I;
8895
  *value_ = *I::GetRoot(GetIsolate(), I::kNullValueRootIndex);
8896 8897 8898
}

template<typename T>
8899
void ReturnValue<T>::SetUndefined() {
8900
  TYPE_CHECK(T, Primitive);
8901
  typedef internal::Internals I;
8902
  *value_ = *I::GetRoot(GetIsolate(), I::kUndefinedValueRootIndex);
8903 8904
}

8905 8906
template<typename T>
void ReturnValue<T>::SetEmptyString() {
8907
  TYPE_CHECK(T, String);
8908 8909 8910 8911
  typedef internal::Internals I;
  *value_ = *I::GetRoot(GetIsolate(), I::kEmptyStringRootIndex);
}

8912 8913
template <typename T>
Isolate* ReturnValue<T>::GetIsolate() const {
8914 8915 8916 8917
  // Isolate is always the pointer below the default value on the stack.
  return *reinterpret_cast<Isolate**>(&value_[-2]);
}

8918 8919 8920 8921 8922 8923 8924 8925 8926 8927
template <typename T>
Local<Value> ReturnValue<T>::Get() const {
  typedef internal::Internals I;
  if (*value_ == *I::GetRoot(GetIsolate(), I::kTheHoleValueRootIndex))
    return Local<Value>(*Undefined(GetIsolate()));
  return Local<Value>::New(GetIsolate(), reinterpret_cast<Value*>(value_));
}

template <typename T>
template <typename S>
8928 8929 8930 8931 8932
void ReturnValue<T>::Set(S* whatever) {
  // Uncompilable to prevent inadvertent misuse.
  TYPE_CHECK(S*, Primitive);
}

8933 8934 8935 8936
template<typename T>
internal::Object* ReturnValue<T>::GetDefaultValue() {
  // Default value is always the pointer below value_ on the stack.
  return value_[-1];
8937 8938
}

8939
template <typename T>
8940 8941
FunctionCallbackInfo<T>::FunctionCallbackInfo(internal::Object** implicit_args,
                                              internal::Object** values,
8942 8943
                                              int length)
    : implicit_args_(implicit_args), values_(values), length_(length) {}
8944

8945 8946
template<typename T>
Local<Value> FunctionCallbackInfo<T>::operator[](int i) const {
8947
  if (i < 0 || length_ <= i) return Local<Value>(*Undefined(GetIsolate()));
8948 8949 8950 8951
  return Local<Value>(reinterpret_cast<Value*>(values_ - i));
}


8952 8953 8954 8955 8956 8957 8958
template<typename T>
Local<Function> FunctionCallbackInfo<T>::Callee() const {
  return Local<Function>(reinterpret_cast<Function*>(
      &implicit_args_[kCalleeIndex]));
}


8959 8960
template<typename T>
Local<Object> FunctionCallbackInfo<T>::This() const {
8961 8962 8963 8964
  return Local<Object>(reinterpret_cast<Object*>(values_ + 1));
}


8965 8966
template<typename T>
Local<Object> FunctionCallbackInfo<T>::Holder() const {
8967 8968
  return Local<Object>(reinterpret_cast<Object*>(
      &implicit_args_[kHolderIndex]));
8969 8970
}

8971 8972 8973 8974 8975
template <typename T>
Local<Value> FunctionCallbackInfo<T>::NewTarget() const {
  return Local<Value>(
      reinterpret_cast<Value*>(&implicit_args_[kNewTargetIndex]));
}
8976

8977
template <typename T>
8978
Local<Value> FunctionCallbackInfo<T>::Data() const {
8979
  return Local<Value>(reinterpret_cast<Value*>(&implicit_args_[kDataIndex]));
8980 8981 8982
}


8983 8984
template<typename T>
Isolate* FunctionCallbackInfo<T>::GetIsolate() const {
8985 8986 8987 8988
  return *reinterpret_cast<Isolate**>(&implicit_args_[kIsolateIndex]);
}


8989 8990 8991 8992 8993 8994 8995 8996
template<typename T>
ReturnValue<T> FunctionCallbackInfo<T>::GetReturnValue() const {
  return ReturnValue<T>(&implicit_args_[kReturnValueIndex]);
}


template<typename T>
bool FunctionCallbackInfo<T>::IsConstructCall() const {
8997
  return !NewTarget()->IsUndefined();
8998 8999 9000
}


9001 9002
template<typename T>
int FunctionCallbackInfo<T>::Length() const {
9003 9004 9005
  return length_;
}

9006 9007 9008 9009 9010 9011
ScriptOrigin::ScriptOrigin(Local<Value> resource_name,
                           Local<Integer> resource_line_offset,
                           Local<Integer> resource_column_offset,
                           Local<Boolean> resource_is_shared_cross_origin,
                           Local<Integer> script_id,
                           Local<Value> source_map_url,
9012
                           Local<Boolean> resource_is_opaque,
9013
                           Local<Boolean> is_wasm, Local<Boolean> is_module)
9014 9015 9016 9017
    : resource_name_(resource_name),
      resource_line_offset_(resource_line_offset),
      resource_column_offset_(resource_column_offset),
      options_(!resource_is_shared_cross_origin.IsEmpty() &&
9018
                   resource_is_shared_cross_origin->IsTrue(),
9019
               !resource_is_opaque.IsEmpty() && resource_is_opaque->IsTrue(),
9020 9021
               !is_wasm.IsEmpty() && is_wasm->IsTrue(),
               !is_module.IsEmpty() && is_module->IsTrue()),
9022 9023
      script_id_(script_id),
      source_map_url_(source_map_url) {}
9024

9025
Local<Value> ScriptOrigin::ResourceName() const { return resource_name_; }
9026 9027


9028
Local<Integer> ScriptOrigin::ResourceLineOffset() const {
9029 9030 9031 9032
  return resource_line_offset_;
}


9033
Local<Integer> ScriptOrigin::ResourceColumnOffset() const {
9034 9035 9036
  return resource_column_offset_;
}

9037

9038
Local<Integer> ScriptOrigin::ScriptID() const { return script_id_; }
9039 9040


9041
Local<Value> ScriptOrigin::SourceMapUrl() const { return source_map_url_; }
9042 9043


9044 9045 9046 9047 9048 9049
ScriptCompiler::Source::Source(Local<String> string, const ScriptOrigin& origin,
                               CachedData* data)
    : source_string(string),
      resource_name(origin.ResourceName()),
      resource_line_offset(origin.ResourceLineOffset()),
      resource_column_offset(origin.ResourceColumnOffset()),
9050
      resource_options(origin.Options()),
9051
      source_map_url(origin.SourceMapUrl()),
9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069
      cached_data(data) {}


ScriptCompiler::Source::Source(Local<String> string,
                               CachedData* data)
    : source_string(string), cached_data(data) {}


ScriptCompiler::Source::~Source() {
  delete cached_data;
}


const ScriptCompiler::CachedData* ScriptCompiler::Source::GetCachedData()
    const {
  return cached_data;
}

9070 9071 9072
const ScriptOriginOptions& ScriptCompiler::Source::GetResourceOptions() const {
  return resource_options;
}
9073

9074
Local<Boolean> Boolean::New(Isolate* isolate, bool value) {
9075
  return value ? True(isolate) : False(isolate);
9076 9077
}

9078
void Template::Set(Isolate* isolate, const char* name, Local<Data> value) {
9079
  Set(String::NewFromUtf8(isolate, name, NewStringType::kInternalized)
9080 9081
          .ToLocalChecked(),
      value);
9082 9083 9084
}


9085 9086 9087
Local<Value> Object::GetInternalField(int index) {
#ifndef V8_ENABLE_CHECKS
  typedef internal::Object O;
9088
  typedef internal::HeapObject HO;
9089 9090
  typedef internal::Internals I;
  O* obj = *reinterpret_cast<O**>(this);
9091 9092
  // Fast path: If the object is a plain JSObject, which is the common case, we
  // know where to find the internal fields and can return the value directly.
9093 9094 9095
  auto instance_type = I::GetInstanceType(obj);
  if (instance_type == I::kJSObjectType ||
      instance_type == I::kJSApiObjectType) {
9096
    int offset = I::kJSObjectHeaderSize + (internal::kApiPointerSize * index);
9097
    O* value = I::ReadField<O*>(obj, offset);
9098
    O** result = HandleScope::CreateHandle(reinterpret_cast<HO*>(obj), value);
9099 9100 9101
    return Local<Value>(reinterpret_cast<Value*>(result));
  }
#endif
9102
  return SlowGetInternalField(index);
9103 9104 9105
}


9106 9107
void* Object::GetAlignedPointerFromInternalField(int index) {
#ifndef V8_ENABLE_CHECKS
9108 9109 9110
  typedef internal::Object O;
  typedef internal::Internals I;
  O* obj = *reinterpret_cast<O**>(this);
9111 9112
  // Fast path: If the object is a plain JSObject, which is the common case, we
  // know where to find the internal fields and can return the value directly.
9113 9114 9115
  auto instance_type = I::GetInstanceType(obj);
  if (V8_LIKELY(instance_type == I::kJSObjectType ||
                instance_type == I::kJSApiObjectType)) {
9116
    int offset = I::kJSObjectHeaderSize + (internal::kApiPointerSize * index);
9117
    return I::ReadField<void*>(obj, offset);
9118
  }
9119 9120
#endif
  return SlowGetAlignedPointerFromInternalField(index);
9121 9122 9123 9124 9125 9126 9127 9128 9129 9130
}

String* String::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<String*>(value);
}


9131 9132 9133
Local<String> String::Empty(Isolate* isolate) {
  typedef internal::Object* S;
  typedef internal::Internals I;
9134
  I::CheckInitialized(isolate);
9135
  S* slot = I::GetRoot(isolate, I::kEmptyStringRootIndex);
9136 9137 9138 9139
  return Local<String>(reinterpret_cast<String*>(slot));
}


9140 9141 9142
String::ExternalStringResource* String::GetExternalStringResource() const {
  typedef internal::Object O;
  typedef internal::Internals I;
9143
  O* obj = *reinterpret_cast<O* const*>(this);
9144 9145 9146 9147 9148 9149
  String::ExternalStringResource* result;
  if (I::IsExternalTwoByteString(I::GetInstanceType(obj))) {
    void* value = I::ReadField<void*>(obj, I::kStringResourceOffset);
    result = reinterpret_cast<String::ExternalStringResource*>(value);
  } else {
    result = NULL;
9150 9151
  }
#ifdef V8_ENABLE_CHECKS
9152
  VerifyExternalStringResource(result);
9153 9154 9155 9156 9157
#endif
  return result;
}


9158 9159 9160 9161
String::ExternalStringResourceBase* String::GetExternalStringResourceBase(
    String::Encoding* encoding_out) const {
  typedef internal::Object O;
  typedef internal::Internals I;
9162
  O* obj = *reinterpret_cast<O* const*>(this);
9163 9164 9165
  int type = I::GetInstanceType(obj) & I::kFullStringRepresentationMask;
  *encoding_out = static_cast<Encoding>(type & I::kStringEncodingMask);
  ExternalStringResourceBase* resource = NULL;
9166
  if (type == I::kExternalOneByteRepresentationTag ||
9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177
      type == I::kExternalTwoByteRepresentationTag) {
    void* value = I::ReadField<void*>(obj, I::kStringResourceOffset);
    resource = static_cast<ExternalStringResourceBase*>(value);
  }
#ifdef V8_ENABLE_CHECKS
    VerifyExternalStringResourceBase(resource, *encoding_out);
#endif
  return resource;
}


9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188
bool Value::IsUndefined() const {
#ifdef V8_ENABLE_CHECKS
  return FullIsUndefined();
#else
  return QuickIsUndefined();
#endif
}

bool Value::QuickIsUndefined() const {
  typedef internal::Object O;
  typedef internal::Internals I;
9189
  O* obj = *reinterpret_cast<O* const*>(this);
9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206
  if (!I::HasHeapObjectTag(obj)) return false;
  if (I::GetInstanceType(obj) != I::kOddballType) return false;
  return (I::GetOddballKind(obj) == I::kUndefinedOddballKind);
}


bool Value::IsNull() const {
#ifdef V8_ENABLE_CHECKS
  return FullIsNull();
#else
  return QuickIsNull();
#endif
}

bool Value::QuickIsNull() const {
  typedef internal::Object O;
  typedef internal::Internals I;
9207
  O* obj = *reinterpret_cast<O* const*>(this);
9208 9209 9210 9211 9212
  if (!I::HasHeapObjectTag(obj)) return false;
  if (I::GetInstanceType(obj) != I::kOddballType) return false;
  return (I::GetOddballKind(obj) == I::kNullOddballKind);
}

9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229
bool Value::IsNullOrUndefined() const {
#ifdef V8_ENABLE_CHECKS
  return FullIsNull() || FullIsUndefined();
#else
  return QuickIsNullOrUndefined();
#endif
}

bool Value::QuickIsNullOrUndefined() const {
  typedef internal::Object O;
  typedef internal::Internals I;
  O* obj = *reinterpret_cast<O* const*>(this);
  if (!I::HasHeapObjectTag(obj)) return false;
  if (I::GetInstanceType(obj) != I::kOddballType) return false;
  int kind = I::GetOddballKind(obj);
  return kind == I::kNullOddballKind || kind == I::kUndefinedOddballKind;
}
9230

9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241
bool Value::IsString() const {
#ifdef V8_ENABLE_CHECKS
  return FullIsString();
#else
  return QuickIsString();
#endif
}

bool Value::QuickIsString() const {
  typedef internal::Object O;
  typedef internal::Internals I;
9242
  O* obj = *reinterpret_cast<O* const*>(this);
9243
  if (!I::HasHeapObjectTag(obj)) return false;
9244
  return (I::GetInstanceType(obj) < I::kFirstNonstringType);
9245 9246 9247
}


dcarney@chromium.org's avatar
dcarney@chromium.org committed
9248 9249 9250 9251 9252
template <class T> Value* Value::Cast(T* value) {
  return static_cast<Value*>(value);
}


9253
Local<Boolean> Value::ToBoolean() const {
9254 9255
  return ToBoolean(Isolate::GetCurrent()->GetCurrentContext())
      .FromMaybe(Local<Boolean>());
9256 9257 9258 9259
}


Local<Number> Value::ToNumber() const {
9260 9261
  return ToNumber(Isolate::GetCurrent()->GetCurrentContext())
      .FromMaybe(Local<Number>());
9262 9263 9264 9265
}


Local<String> Value::ToString() const {
9266 9267
  return ToString(Isolate::GetCurrent()->GetCurrentContext())
      .FromMaybe(Local<String>());
9268 9269 9270 9271
}


Local<String> Value::ToDetailString() const {
9272 9273
  return ToDetailString(Isolate::GetCurrent()->GetCurrentContext())
      .FromMaybe(Local<String>());
9274 9275 9276 9277
}


Local<Object> Value::ToObject() const {
9278 9279
  return ToObject(Isolate::GetCurrent()->GetCurrentContext())
      .FromMaybe(Local<Object>());
9280 9281 9282 9283
}


Local<Integer> Value::ToInteger() const {
9284 9285
  return ToInteger(Isolate::GetCurrent()->GetCurrentContext())
      .FromMaybe(Local<Integer>());
9286 9287 9288 9289
}


Local<Uint32> Value::ToUint32() const {
9290 9291
  return ToUint32(Isolate::GetCurrent()->GetCurrentContext())
      .FromMaybe(Local<Uint32>());
9292 9293 9294
}


9295 9296 9297 9298
Local<Int32> Value::ToInt32() const {
  return ToInt32(Isolate::GetCurrent()->GetCurrentContext())
      .FromMaybe(Local<Int32>());
}
9299 9300


bashi's avatar
bashi committed
9301 9302 9303 9304 9305 9306 9307 9308
Boolean* Boolean::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Boolean*>(value);
}


9309 9310 9311 9312 9313 9314 9315 9316
Name* Name::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Name*>(value);
}


9317 9318 9319 9320 9321 9322 9323 9324
Symbol* Symbol::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Symbol*>(value);
}


9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340
Number* Number::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Number*>(value);
}


Integer* Integer::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Integer*>(value);
}


bashi's avatar
bashi committed
9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356
Int32* Int32::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Int32*>(value);
}


Uint32* Uint32::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Uint32*>(value);
}


9357 9358 9359 9360 9361 9362 9363 9364
Date* Date::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Date*>(value);
}


9365 9366 9367 9368 9369 9370 9371 9372
StringObject* StringObject::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<StringObject*>(value);
}


9373 9374 9375 9376 9377 9378 9379 9380
SymbolObject* SymbolObject::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<SymbolObject*>(value);
}


9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396
NumberObject* NumberObject::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<NumberObject*>(value);
}


BooleanObject* BooleanObject::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<BooleanObject*>(value);
}


9397 9398 9399 9400 9401 9402 9403 9404
RegExp* RegExp::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<RegExp*>(value);
}


9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420
Object* Object::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Object*>(value);
}


Array* Array::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Array*>(value);
}


9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436
Map* Map::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Map*>(value);
}


Set* Set::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Set*>(value);
}


9437 9438 9439 9440 9441 9442 9443 9444
Promise* Promise::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Promise*>(value);
}


9445 9446 9447 9448 9449 9450 9451
Proxy* Proxy::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Proxy*>(value);
}

9452 9453 9454 9455 9456 9457
WasmCompiledModule* WasmCompiledModule::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<WasmCompiledModule*>(value);
}
9458

9459 9460 9461 9462 9463 9464 9465 9466
Promise::Resolver* Promise::Resolver::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Promise::Resolver*>(value);
}


9467 9468 9469 9470 9471 9472 9473 9474
ArrayBuffer* ArrayBuffer::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<ArrayBuffer*>(value);
}


dslomov@chromium.org's avatar
dslomov@chromium.org committed
9475 9476 9477 9478 9479 9480 9481 9482
ArrayBufferView* ArrayBufferView::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<ArrayBufferView*>(value);
}


9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554
TypedArray* TypedArray::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<TypedArray*>(value);
}


Uint8Array* Uint8Array::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Uint8Array*>(value);
}


Int8Array* Int8Array::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Int8Array*>(value);
}


Uint16Array* Uint16Array::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Uint16Array*>(value);
}


Int16Array* Int16Array::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Int16Array*>(value);
}


Uint32Array* Uint32Array::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Uint32Array*>(value);
}


Int32Array* Int32Array::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Int32Array*>(value);
}


Float32Array* Float32Array::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Float32Array*>(value);
}


Float64Array* Float64Array::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Float64Array*>(value);
}


9555 9556 9557 9558 9559 9560 9561 9562
Uint8ClampedArray* Uint8ClampedArray::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Uint8ClampedArray*>(value);
}


dslomov@chromium.org's avatar
dslomov@chromium.org committed
9563 9564 9565 9566 9567 9568 9569 9570
DataView* DataView::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<DataView*>(value);
}


binji's avatar
binji committed
9571 9572 9573 9574 9575 9576 9577 9578
SharedArrayBuffer* SharedArrayBuffer::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<SharedArrayBuffer*>(value);
}


9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594
Function* Function::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<Function*>(value);
}


External* External::Cast(v8::Value* value) {
#ifdef V8_ENABLE_CHECKS
  CheckCast(value);
#endif
  return static_cast<External*>(value);
}


9595 9596 9597 9598 9599 9600 9601 9602 9603
template<typename T>
Isolate* PropertyCallbackInfo<T>::GetIsolate() const {
  return *reinterpret_cast<Isolate**>(&args_[kIsolateIndex]);
}


template<typename T>
Local<Value> PropertyCallbackInfo<T>::Data() const {
  return Local<Value>(reinterpret_cast<Value*>(&args_[kDataIndex]));
9604 9605 9606
}


9607
template<typename T>
9608 9609
Local<Object> PropertyCallbackInfo<T>::This() const {
  return Local<Object>(reinterpret_cast<Object*>(&args_[kThisIndex]));
9610 9611 9612
}


9613 9614 9615
template<typename T>
Local<Object> PropertyCallbackInfo<T>::Holder() const {
  return Local<Object>(reinterpret_cast<Object*>(&args_[kHolderIndex]));
9616 9617 9618
}


9619 9620 9621
template<typename T>
ReturnValue<T> PropertyCallbackInfo<T>::GetReturnValue() const {
  return ReturnValue<T>(&args_[kReturnValueIndex]);
9622 9623
}

9624 9625 9626 9627 9628 9629
template <typename T>
bool PropertyCallbackInfo<T>::ShouldThrowOnError() const {
  typedef internal::Internals I;
  return args_[kShouldThrowOnErrorIndex] != I::IntToSmi(0);
}

9630

9631
Local<Primitive> Undefined(Isolate* isolate) {
9632 9633
  typedef internal::Object* S;
  typedef internal::Internals I;
9634
  I::CheckInitialized(isolate);
9635
  S* slot = I::GetRoot(isolate, I::kUndefinedValueRootIndex);
9636
  return Local<Primitive>(reinterpret_cast<Primitive*>(slot));
9637 9638 9639
}


9640
Local<Primitive> Null(Isolate* isolate) {
9641 9642
  typedef internal::Object* S;
  typedef internal::Internals I;
9643
  I::CheckInitialized(isolate);
9644
  S* slot = I::GetRoot(isolate, I::kNullValueRootIndex);
9645
  return Local<Primitive>(reinterpret_cast<Primitive*>(slot));
9646 9647 9648
}


9649
Local<Boolean> True(Isolate* isolate) {
9650 9651
  typedef internal::Object* S;
  typedef internal::Internals I;
9652
  I::CheckInitialized(isolate);
9653
  S* slot = I::GetRoot(isolate, I::kTrueValueRootIndex);
9654
  return Local<Boolean>(reinterpret_cast<Boolean*>(slot));
9655 9656 9657
}


9658
Local<Boolean> False(Isolate* isolate) {
9659 9660
  typedef internal::Object* S;
  typedef internal::Internals I;
9661
  I::CheckInitialized(isolate);
9662
  S* slot = I::GetRoot(isolate, I::kFalseValueRootIndex);
9663
  return Local<Boolean>(reinterpret_cast<Boolean*>(slot));
9664 9665 9666
}


9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681
void Isolate::SetData(uint32_t slot, void* data) {
  typedef internal::Internals I;
  I::SetEmbedderData(this, slot, data);
}


void* Isolate::GetData(uint32_t slot) {
  typedef internal::Internals I;
  return I::GetEmbedderData(this, slot);
}


uint32_t Isolate::GetNumberOfDataSlots() {
  typedef internal::Internals I;
  return I::kNumIsolateDataSlots;
9682 9683 9684
}


9685 9686 9687
int64_t Isolate::AdjustAmountOfExternalAllocatedMemory(
    int64_t change_in_bytes) {
  typedef internal::Internals I;
9688 9689 9690 9691 9692 9693 9694
  int64_t* external_memory = reinterpret_cast<int64_t*>(
      reinterpret_cast<uint8_t*>(this) + I::kExternalMemoryOffset);
  const int64_t external_memory_limit = *reinterpret_cast<int64_t*>(
      reinterpret_cast<uint8_t*>(this) + I::kExternalMemoryLimitOffset);
  const int64_t amount = *external_memory + change_in_bytes;
  *external_memory = amount;
  if (change_in_bytes > 0 && amount > external_memory_limit) {
9695
    ReportExternalAllocationLimitReached();
9696
  }
9697
  return *external_memory;
9698 9699
}

9700 9701 9702
Local<Value> Context::GetEmbedderData(int index) {
#ifndef V8_ENABLE_CHECKS
  typedef internal::Object O;
9703
  typedef internal::HeapObject HO;
9704
  typedef internal::Internals I;
9705 9706 9707
  HO* context = *reinterpret_cast<HO**>(this);
  O** result =
      HandleScope::CreateHandle(context, I::ReadEmbedderData<O*>(this, index));
9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724
  return Local<Value>(reinterpret_cast<Value*>(result));
#else
  return SlowGetEmbedderData(index);
#endif
}


void* Context::GetAlignedPointerFromEmbedderData(int index) {
#ifndef V8_ENABLE_CHECKS
  typedef internal::Internals I;
  return I::ReadEmbedderData<void*>(this, index);
#else
  return SlowGetAlignedPointerFromEmbedderData(index);
#endif
}


9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737
void V8::SetAllowCodeGenerationFromStringsCallback(
    AllowCodeGenerationFromStringsCallback callback) {
  Isolate* isolate = Isolate::GetCurrent();
  isolate->SetAllowCodeGenerationFromStringsCallback(callback);
}


bool V8::IsDead() {
  Isolate* isolate = Isolate::GetCurrent();
  return isolate->IsDead();
}


9738
bool V8::AddMessageListener(MessageCallback that, Local<Value> data) {
9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769
  Isolate* isolate = Isolate::GetCurrent();
  return isolate->AddMessageListener(that, data);
}


void V8::RemoveMessageListeners(MessageCallback that) {
  Isolate* isolate = Isolate::GetCurrent();
  isolate->RemoveMessageListeners(that);
}


void V8::SetFailedAccessCheckCallbackFunction(
    FailedAccessCheckCallback callback) {
  Isolate* isolate = Isolate::GetCurrent();
  isolate->SetFailedAccessCheckCallbackFunction(callback);
}


void V8::SetCaptureStackTraceForUncaughtExceptions(
    bool capture, int frame_limit, StackTrace::StackTraceOptions options) {
  Isolate* isolate = Isolate::GetCurrent();
  isolate->SetCaptureStackTraceForUncaughtExceptions(capture, frame_limit,
                                                     options);
}


void V8::SetFatalErrorHandler(FatalErrorCallback callback) {
  Isolate* isolate = Isolate::GetCurrent();
  isolate->SetFatalErrorHandler(callback);
}

9770
void V8::RemoveGCPrologueCallback(GCCallback callback) {
9771 9772
  Isolate* isolate = Isolate::GetCurrent();
  isolate->RemoveGCPrologueCallback(
9773
      reinterpret_cast<Isolate::GCCallback>(callback));
9774 9775 9776
}


9777
void V8::RemoveGCEpilogueCallback(GCCallback callback) {
9778 9779
  Isolate* isolate = Isolate::GetCurrent();
  isolate->RemoveGCEpilogueCallback(
9780
      reinterpret_cast<Isolate::GCCallback>(callback));
9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821
}

void V8::TerminateExecution(Isolate* isolate) { isolate->TerminateExecution(); }


bool V8::IsExecutionTerminating(Isolate* isolate) {
  if (isolate == NULL) {
    isolate = Isolate::GetCurrent();
  }
  return isolate->IsExecutionTerminating();
}


void V8::CancelTerminateExecution(Isolate* isolate) {
  isolate->CancelTerminateExecution();
}


void V8::VisitExternalResources(ExternalResourceVisitor* visitor) {
  Isolate* isolate = Isolate::GetCurrent();
  isolate->VisitExternalResources(visitor);
}


void V8::VisitHandlesWithClassIds(PersistentHandleVisitor* visitor) {
  Isolate* isolate = Isolate::GetCurrent();
  isolate->VisitHandlesWithClassIds(visitor);
}


void V8::VisitHandlesWithClassIds(Isolate* isolate,
                                  PersistentHandleVisitor* visitor) {
  isolate->VisitHandlesWithClassIds(visitor);
}


void V8::VisitHandlesForPartialDependence(Isolate* isolate,
                                          PersistentHandleVisitor* visitor) {
  isolate->VisitHandlesForPartialDependence(visitor);
}

9822
/**
9823 9824
 * \example shell.cc
 * A simple shell that takes a list of expressions on the
9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839
 * command-line and executes them.
 */


/**
 * \example process.cc
 */


}  // namespace v8


#undef TYPE_CHECK


9840
#endif  // INCLUDE_V8_H_