v8  4.4.63(io.js3.3.1)
V8 is Google's open source JavaScript engine
v8 Namespace Reference

Namespaces

 internal
 
 platform
 

Data Structures

class  AccessorSignature
 
class  ActivityControl
 
class  AlignOfHelper
 
class  Array
 
class  ArrayBuffer
 
class  ArrayBufferView
 
class  Boolean
 
class  BooleanObject
 
class  Context
 
struct  CopyablePersistentTraits
 
class  CpuProfile
 
struct  CpuProfileDeoptFrame
 
struct  CpuProfileDeoptInfo
 
class  CpuProfileNode
 
class  CpuProfiler
 
class  Data
 
class  DataView
 
class  Date
 
class  Debug
 
class  DefaultGlobalMapTraits
 
class  DefaultPersistentValueMapTraits
 
class  DefaultPersistentValueVectorTraits
 
class  EscapableHandleScope
 
class  Eternal
 
class  Exception
 
class  Extension
 
class  ExtensionConfiguration
 
class  External
 
class  ExternalOneByteStringResourceImpl
 
class  ExternalResourceVisitor
 
class  Float32Array
 
class  Float64Array
 
class  Function
 
class  FunctionCallbackInfo
 
class  FunctionTemplate
 
class  Global
 
class  GlobalValueMap
 
class  HandleScope
 
class  HeapGraphEdge
 
class  HeapGraphNode
 
class  HeapProfiler
 
class  HeapSnapshot
 
class  HeapSpaceStatistics
 
class  HeapStatistics
 
struct  HeapStatsUpdate
 
struct  IndexedPropertyHandlerConfiguration
 
class  Int16Array
 
class  Int32
 
class  Int32Array
 
class  Int8Array
 
class  Integer
 
class  Isolate
 
struct  JitCodeEvent
 
class  JSON
 
class  Local
 
class  Locker
 
class  Maybe
 
class  MaybeLocal
 
class  Message
 
class  Name
 
struct  NamedPropertyHandlerConfiguration
 
class  NativeWeakMap
 
class  NonCopyablePersistentTraits
 
class  Number
 
class  NumberObject
 
class  Object
 
class  ObjectTemplate
 
class  OutputStream
 
class  Persistent
 
class  PersistentBase
 
class  PersistentHandleVisitor
 
class  PersistentValueMap
 
class  PersistentValueMapBase
 
class  PersistentValueVector
 
class  Platform
 
class  Primitive
 
class  Private
 
class  Promise
 
class  PromiseRejectMessage
 
class  PropertyCallbackInfo
 
class  RegExp
 
struct  RegisterState
 
class  ResourceConstraints
 
class  RetainedObjectInfo
 
class  ReturnValue
 
struct  SampleInfo
 
class  Script
 
class  ScriptCompiler
 
class  ScriptOrigin
 
class  SealHandleScope
 
class  Signature
 
class  StackFrame
 
class  StackTrace
 
class  StartupData
 
class  StdGlobalValueMap
 
class  StdMapTraits
 
class  StdPersistentValueMap
 
class  String
 
class  StringObject
 
class  Symbol
 
class  SymbolObject
 
class  Task
 
class  Template
 
class  Testing
 
class  TryCatch
 
class  TypedArray
 
class  TypeSwitch
 
class  Uint16Array
 
class  Uint32
 
class  Uint32Array
 
class  Uint8Array
 
class  Uint8ClampedArray
 
class  UnboundScript
 
class  UniqueId
 
class  Unlocker
 
class  V8
 
class  Value
 
class  WeakCallbackData
 
class  WeakCallbackInfo
 
class  WeakCallbackObject
 

Typedefs

typedef uint32_t SnapshotObjectId
 
typedef uintptr_t PersistentContainerValue
 
template<class T >
using Handle = Local< T >
 
template<class T >
using PhantomCallbackData = WeakCallbackInfo< T >
 
template<class T >
using UniquePersistent = Global< T >
 
typedef void(* AccessorGetterCallback) (Local< String > property, const PropertyCallbackInfo< Value > &info)
 
typedef void(* AccessorNameGetterCallback) (Local< Name > property, const PropertyCallbackInfo< Value > &info)
 
typedef void(* AccessorSetterCallback) (Local< String > property, Local< Value > value, const PropertyCallbackInfo< void > &info)
 
typedef void(* AccessorNameSetterCallback) (Local< Name > property, Local< Value > value, const PropertyCallbackInfo< void > &info)
 
typedef void(* FunctionCallback) (const FunctionCallbackInfo< Value > &info)
 
typedef void(* NamedPropertyGetterCallback) (Local< String > property, const PropertyCallbackInfo< Value > &info)
 
typedef void(* NamedPropertySetterCallback) (Local< String > property, Local< Value > value, const PropertyCallbackInfo< Value > &info)
 
typedef void(* NamedPropertyQueryCallback) (Local< String > property, const PropertyCallbackInfo< Integer > &info)
 
typedef void(* NamedPropertyDeleterCallback) (Local< String > property, const PropertyCallbackInfo< Boolean > &info)
 
typedef void(* NamedPropertyEnumeratorCallback) (const PropertyCallbackInfo< Array > &info)
 
typedef void(* GenericNamedPropertyGetterCallback) (Local< Name > property, const PropertyCallbackInfo< Value > &info)
 
typedef void(* GenericNamedPropertySetterCallback) (Local< Name > property, Local< Value > value, const PropertyCallbackInfo< Value > &info)
 
typedef void(* GenericNamedPropertyQueryCallback) (Local< Name > property, const PropertyCallbackInfo< Integer > &info)
 
typedef void(* GenericNamedPropertyDeleterCallback) (Local< Name > property, const PropertyCallbackInfo< Boolean > &info)
 
typedef void(* GenericNamedPropertyEnumeratorCallback) (const PropertyCallbackInfo< Array > &info)
 
typedef void(* IndexedPropertyGetterCallback) (uint32_t index, const PropertyCallbackInfo< Value > &info)
 
typedef void(* IndexedPropertySetterCallback) (uint32_t index, Local< Value > value, const PropertyCallbackInfo< Value > &info)
 
typedef void(* IndexedPropertyQueryCallback) (uint32_t index, const PropertyCallbackInfo< Integer > &info)
 
typedef void(* IndexedPropertyDeleterCallback) (uint32_t index, const PropertyCallbackInfo< Boolean > &info)
 
typedef void(* IndexedPropertyEnumeratorCallback) (const PropertyCallbackInfo< Array > &info)
 
typedef bool(* NamedSecurityCallback) (Local< Object > host, Local< Value > key, AccessType type, Local< Value > data)
 
typedef bool(* IndexedSecurityCallback) (Local< Object > host, uint32_t index, AccessType type, Local< Value > data)
 
typedef void(* FatalErrorCallback) (const char *location, const char *message)
 
typedef void(* MessageCallback) (Handle< Message > message, Handle< Value > error)
 
typedef void(* LogEventCallback) (const char *name, int event)
 
typedef int *(* CounterLookupCallback) (const char *name)
 
typedef void *(* CreateHistogramCallback) (const char *name, int min, int max, size_t buckets)
 
typedef void(* AddHistogramSampleCallback) (void *histogram, int sample)
 
typedef void(* MemoryAllocationCallback) (ObjectSpace space, AllocationAction action, int size)
 
typedef void(* CallCompletedCallback) ()
 
typedef void(* PromiseRejectCallback) (PromiseRejectMessage message)
 
typedef void(* MicrotaskCallback) (void *data)
 
typedef void(* FailedAccessCheckCallback) (Local< Object > target, AccessType type, Local< Value > data)
 
typedef bool(* AllowCodeGenerationFromStringsCallback) (Local< Context > context)
 
typedef void(* GCPrologueCallback) (GCType type, GCCallbackFlags flags)
 
typedef void(* GCEpilogueCallback) (GCType type, GCCallbackFlags flags)
 
typedef void(* InterruptCallback) (Isolate *isolate, void *data)
 
typedef void(* FunctionEntryHook) (uintptr_t function, uintptr_t return_addr_location)
 
typedef void(* JitCodeEventHandler) (const JitCodeEvent *event)
 
typedef bool(* EntropySource) (unsigned char *buffer, size_t length)
 
typedef uintptr_t(* ReturnAddressLocationResolver) (uintptr_t return_addr_location)
 

Enumerations

enum  DebugEvent {
  Break = 1, Exception = 2, NewFunction = 3, BeforeCompile = 4,
  AfterCompile = 5, CompileError = 6, PromiseEvent = 7, AsyncTaskEvent = 8
}
 
enum  PersistentContainerCallbackType { kNotWeak, kWeakWithParameter, kWeakWithInternalFields, kWeak = kWeakWithParameter }
 
enum  WeakCallbackType { kParameter, kInternalFields }
 
enum  StateTag {
  JS, GC, COMPILER, OTHER,
  EXTERNAL, IDLE
}
 
enum  NewStringType { kNormal, kInternalized }
 
enum  PropertyAttribute { None = 0, ReadOnly = 1 << 0, DontEnum = 1 << 1, DontDelete = 1 << 2 }
 
enum  AccessControl { DEFAULT = 0, ALL_CAN_READ = 1, ALL_CAN_WRITE = 1 << 1, PROHIBITS_OVERWRITING = 1 << 2 }
 
enum  ArrayBufferCreationMode { kInternalized, kExternalized }
 
enum  AccessType {
  ACCESS_GET, ACCESS_SET, ACCESS_HAS, ACCESS_DELETE,
  ACCESS_KEYS
}
 
enum  PropertyHandlerFlags { kNone = 0, kAllCanRead = 1, kNonMasking = 1 << 1, kOnlyInterceptStrings = 1 << 2 }
 
enum  ObjectSpace {
  kObjectSpaceNewSpace = 1 << 0, kObjectSpaceOldSpace = 1 << 1, kObjectSpaceCodeSpace = 1 << 2, kObjectSpaceMapSpace = 1 << 3,
  kObjectSpaceLoSpace = 1 << 4, kObjectSpaceAll
}
 
enum  AllocationAction { kAllocationActionAllocate = 1 << 0, kAllocationActionFree = 1 << 1, kAllocationActionAll = kAllocationActionAllocate | kAllocationActionFree }
 
enum  PromiseRejectEvent { kPromiseRejectWithNoHandler = 0, kPromiseHandlerAddedAfterReject = 1 }
 
enum  GCType { kGCTypeScavenge = 1 << 0, kGCTypeMarkSweepCompact = 1 << 1, kGCTypeAll = kGCTypeScavenge | kGCTypeMarkSweepCompact }
 
enum  GCCallbackFlags { kNoGCCallbackFlags = 0, kGCCallbackFlagCompacted = 1 << 0, kGCCallbackFlagConstructRetainedObjectInfos = 1 << 1, kGCCallbackFlagForced = 1 << 2 }
 
enum  JitCodeEventOptions { kJitCodeEventDefault = 0, kJitCodeEventEnumExisting = 1 }
 

Functions

void V8_EXPORT RegisterExtension (Extension *extension)
 
V8_INLINE Handle< PrimitiveUndefined (Isolate *isolate)
 
V8_INLINE Handle< PrimitiveNull (Isolate *isolate)
 
V8_INLINE Handle< BooleanTrue (Isolate *isolate)
 
V8_INLINE Handle< BooleanFalse (Isolate *isolate)
 
template<class T >
Maybe< T > Nothing ()
 
template<class T >
Maybe< T > Just (const T &t)
 

Detailed Description

Debugger support for the V8 JavaScript engine.

Profiler support for the V8 JavaScript engine.

Testing support for the V8 JavaScript engine.

Support for Persistent containers.

C++11 embedders can use STL containers with Global values, but pre-C++11 does not support the required move semantic and hence may want these container classes.

The v8 JavaScript engine.

Typedef Documentation

typedef void(* AccessorGetterCallback) (Local< String > property, const PropertyCallbackInfo< Value > &info)

Accessor[Getter|Setter] are used as callback functions when setting|getting a particular property. See Object and ObjectTemplate's method SetAccessor.

Definition at line 2524 of file v8.h.

typedef void(* AccessorNameGetterCallback) (Local< Name > property, const PropertyCallbackInfo< Value > &info)

Definition at line 2527 of file v8.h.

typedef void(* AccessorNameSetterCallback) (Local< Name > property, Local< Value > value, const PropertyCallbackInfo< void > &info)

Definition at line 2536 of file v8.h.

typedef void(* AccessorSetterCallback) (Local< String > property, Local< Value > value, const PropertyCallbackInfo< void > &info)

Definition at line 2532 of file v8.h.

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

Definition at line 4667 of file v8.h.

typedef bool(* AllowCodeGenerationFromStringsCallback) (Local< Context > context)

Callback to check if code generation from strings is allowed. See Context::AllowCodeGenerationFromStrings.

Definition at line 4739 of file v8.h.

typedef void(* CallCompletedCallback) ()

Definition at line 4692 of file v8.h.

typedef int*(* CounterLookupCallback) (const char *name)

Definition at line 4660 of file v8.h.

typedef void*(* CreateHistogramCallback) (const char *name, int min, int max, size_t buckets)

Definition at line 4662 of file v8.h.

typedef bool(* EntropySource) (unsigned char *buffer, size_t length)

EntropySource is used as a callback function when v8 needs a source of entropy.

Definition at line 5674 of file v8.h.

typedef void(* FailedAccessCheckCallback) (Local< Object > target, AccessType type, Local< Value > data)

Definition at line 4729 of file v8.h.

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

Definition at line 4622 of file v8.h.

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

Definition at line 3057 of file v8.h.

typedef void(* FunctionEntryHook) (uintptr_t function, uintptr_t return_addr_location)

FunctionEntryHook is the type of the profile entry hook called at entry to any generated function when function-level profiling is enabled.

Parameters
functionthe address of the function that's being entered.
return_addr_locationpoints to a location on stack where the machine return address resides. This can be used to identify the caller of function, and/or modified to divert execution when function exits.
Note
the entry hook must not cause garbage collection.

Definition at line 4832 of file v8.h.

typedef void(* GCEpilogueCallback) (GCType type, GCCallbackFlags flags)

Definition at line 4764 of file v8.h.

typedef void(* GCPrologueCallback) (GCType type, GCCallbackFlags flags)

Definition at line 4763 of file v8.h.

typedef void(* GenericNamedPropertyDeleterCallback) (Local< Name > property, const PropertyCallbackInfo< Boolean > &info)

Returns a non-empty handle if the deleter intercepts the request. The return value is true if the property could be deleted and false otherwise.

Definition at line 3923 of file v8.h.

typedef void(* GenericNamedPropertyEnumeratorCallback) (const PropertyCallbackInfo< Array > &info)

Returns an array containing the names of the properties the named property getter intercepts.

Definition at line 3931 of file v8.h.

typedef void(* GenericNamedPropertyGetterCallback) (Local< Name > property, const PropertyCallbackInfo< Value > &info)

GenericNamedProperty[Getter|Setter] are used as interceptors on object. See ObjectTemplate::SetNamedPropertyHandler.

Definition at line 3896 of file v8.h.

typedef void(* GenericNamedPropertyQueryCallback) (Local< Name > property, const PropertyCallbackInfo< Integer > &info)

Returns a non-empty handle if the interceptor intercepts the request. The result is an integer encoding property attributes (like v8::None, v8::DontEnum, etc.)

Definition at line 3914 of file v8.h.

typedef void(* GenericNamedPropertySetterCallback) (Local< Name > property, Local< Value > value, const PropertyCallbackInfo< Value > &info)

Returns the value if the setter intercepts the request. Otherwise, returns an empty handle.

Definition at line 3904 of file v8.h.

using Handle = Local<T>

Definition at line 336 of file v8.h.

typedef void(* IndexedPropertyDeleterCallback) (uint32_t index, const PropertyCallbackInfo< Boolean > &info)

Returns a non-empty handle if the deleter intercepts the request. The return value is true if the property could be deleted and false otherwise.

Definition at line 3968 of file v8.h.

typedef void(* IndexedPropertyEnumeratorCallback) (const PropertyCallbackInfo< Array > &info)

Returns an array containing the indices of the properties the indexed property getter intercepts.

Definition at line 3977 of file v8.h.

typedef void(* IndexedPropertyGetterCallback) (uint32_t index, const PropertyCallbackInfo< Value > &info)

Returns the value of the property if the getter intercepts the request. Otherwise, returns an empty handle.

Definition at line 3939 of file v8.h.

typedef void(* IndexedPropertyQueryCallback) (uint32_t index, const PropertyCallbackInfo< Integer > &info)

Returns a non-empty handle if the interceptor intercepts the request. The result is an integer encoding property attributes.

Definition at line 3958 of file v8.h.

typedef void(* IndexedPropertySetterCallback) (uint32_t index, Local< Value > value, const PropertyCallbackInfo< Value > &info)

Returns the value if the setter intercepts the request. Otherwise, returns an empty handle.

Definition at line 3948 of file v8.h.

typedef bool(* IndexedSecurityCallback) (Local< Object > host, uint32_t index, AccessType type, Local< Value > data)

Returns true if cross-context access should be allowed to the indexed property with the given index on the host object.

Definition at line 4007 of file v8.h.

typedef void(* InterruptCallback) (Isolate *isolate, void *data)

Definition at line 4766 of file v8.h.

typedef void(* JitCodeEventHandler) (const JitCodeEvent *event)

Callback function passed to SetJitCodeEventHandler.

Parameters
eventcode add, move or removal event.

Definition at line 4914 of file v8.h.

typedef void(* LogEventCallback) (const char *name, int event)

Definition at line 4629 of file v8.h.

typedef void(* MemoryAllocationCallback) (ObjectSpace space, AllocationAction action, int size)

Definition at line 4687 of file v8.h.

typedef void(* MessageCallback) (Handle< Message > message, Handle< Value > error)

Definition at line 4625 of file v8.h.

typedef void(* MicrotaskCallback) (void *data)

Definition at line 4726 of file v8.h.

typedef void(* NamedPropertyDeleterCallback) (Local< String > property, const PropertyCallbackInfo< Boolean > &info)

Returns a non-empty handle if the deleter intercepts the request. The return value is true if the property could be deleted and false otherwise.

Definition at line 3877 of file v8.h.

typedef void(* NamedPropertyEnumeratorCallback) (const PropertyCallbackInfo< Array > &info)

Returns an array containing the names of the properties the named property getter intercepts.

Definition at line 3886 of file v8.h.

typedef void(* NamedPropertyGetterCallback) (Local< String > property, const PropertyCallbackInfo< Value > &info)

NamedProperty[Getter|Setter] are used as interceptors on object. See ObjectTemplate::SetNamedPropertyHandler.

Definition at line 3847 of file v8.h.

typedef void(* NamedPropertyQueryCallback) (Local< String > property, const PropertyCallbackInfo< Integer > &info)

Returns a non-empty handle if the interceptor intercepts the request. The result is an integer encoding property attributes (like v8::None, v8::DontEnum, etc.)

Definition at line 3867 of file v8.h.

typedef void(* NamedPropertySetterCallback) (Local< String > property, Local< Value > value, const PropertyCallbackInfo< Value > &info)

Returns the value if the setter intercepts the request. Otherwise, returns an empty handle.

Definition at line 3856 of file v8.h.

typedef bool(* NamedSecurityCallback) (Local< Object > host, Local< Value > key, AccessType type, Local< Value > data)

Returns true if cross-context access should be allowed to the named property with the given key on the host object.

Definition at line 3997 of file v8.h.

typedef uintptr_t PersistentContainerValue

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

Definition at line 468 of file v8.h.

typedef void(* PromiseRejectCallback) (PromiseRejectMessage message)

Definition at line 4723 of file v8.h.

typedef uintptr_t(* ReturnAddressLocationResolver) (uintptr_t return_addr_location)

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.

Parameters
return_addr_locationpoints to a location on stack where a machine return address resides.
Returns
either return_addr_location, or else a pointer to the profiler's copy of the original return address.
Note
the resolver function must not cause garbage collection.

Definition at line 5690 of file v8.h.

typedef uint32_t SnapshotObjectId

Definition at line 17 of file v8-profiler.h.

Definition at line 845 of file v8.h.

Enumeration Type Documentation

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.

TODO(dcarney): Remove PROHIBITS_OVERWRITING as it is now unused.

Enumerator
DEFAULT 
ALL_CAN_READ 
ALL_CAN_WRITE 
PROHIBITS_OVERWRITING 

Definition at line 2551 of file v8.h.

enum AccessType

Access type specification.

Enumerator
ACCESS_GET 
ACCESS_SET 
ACCESS_HAS 
ACCESS_DELETE 
ACCESS_KEYS 

Definition at line 3984 of file v8.h.

Enumerator
kAllocationActionAllocate 
kAllocationActionFree 
kAllocationActionAll 

Definition at line 4681 of file v8.h.

Enumerator
kInternalized 
kExternalized 

Definition at line 3228 of file v8.h.

enum DebugEvent
Enumerator
Break 
Exception 
NewFunction 
BeforeCompile 
AfterCompile 
CompileError 
PromiseEvent 
AsyncTaskEvent 

Definition at line 16 of file v8-debug.h.

Enumerator
kNoGCCallbackFlags 
kGCCallbackFlagCompacted 
kGCCallbackFlagConstructRetainedObjectInfos 
kGCCallbackFlagForced 

Definition at line 4756 of file v8.h.

enum GCType

Applications can register callback functions which will be called before and after a garbage collection. 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.

Enumerator
kGCTypeScavenge 
kGCTypeMarkSweepCompact 
kGCTypeAll 

Definition at line 4750 of file v8.h.

Option flags passed to the SetJitCodeEventHandler function.

Enumerator
kJitCodeEventDefault 
kJitCodeEventEnumExisting 

Definition at line 4902 of file v8.h.

enum NewStringType
strong
Enumerator
kNormal 
kInternalized 

Definition at line 2022 of file v8.h.

Enumerator
kObjectSpaceNewSpace 
kObjectSpaceOldSpace 
kObjectSpaceCodeSpace 
kObjectSpaceMapSpace 
kObjectSpaceLoSpace 
kObjectSpaceAll 

Definition at line 4670 of file v8.h.

Enumerator
kNotWeak 
kWeakWithParameter 
kWeakWithInternalFields 
kWeak 

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

Enumerator
kPromiseRejectWithNoHandler 
kPromiseHandlerAddedAfterReject 

Definition at line 4695 of file v8.h.

Enumerator
None 
ReadOnly 
DontEnum 
DontDelete 

Definition at line 2512 of file v8.h.

enum PropertyHandlerFlags
strong
Enumerator
kNone 
kAllCanRead 
kNonMasking 
kOnlyInterceptStrings 

Definition at line 4199 of file v8.h.

enum StateTag
Enumerator
JS 
GC 
COMPILER 
OTHER 
EXTERNAL 
IDLE 

Definition at line 1581 of file v8.h.

enum WeakCallbackType
strong
Enumerator
kParameter 
kInternalFields 

Definition at line 471 of file v8.h.

Function Documentation

Handle< Boolean > False ( Isolate isolate)

Definition at line 7799 of file v8.h.

References Internals::CheckInitialized(), Internals::GetRoot(), and Internals::kFalseValueRootIndex.

Referenced by Boolean::New().

Maybe<T> v8::Just ( const T &  t)
inline

Definition at line 6098 of file v8.h.

Maybe<T> v8::Nothing ( )
inline

Definition at line 6092 of file v8.h.

Handle< Primitive > Null ( Isolate isolate)
void V8_EXPORT v8::RegisterExtension ( Extension extension)
Handle< Boolean > True ( Isolate isolate)

Definition at line 7790 of file v8.h.

References Internals::CheckInitialized(), Internals::GetRoot(), and Internals::kTrueValueRootIndex.

Referenced by Boolean::New().

Handle< Primitive > Undefined ( Isolate isolate)