v8  3.14.5 (node 0.10.48)
V8 is Google's open source JavaScript engine
v8 Namespace Reference

Namespaces

 internal
 

Data Structures

class  Debug
 
class  PreParserData
 
class  UnicodeInputStream
 
class  CpuProfileNode
 
class  CpuProfile
 
class  CpuProfiler
 
class  HeapGraphEdge
 
class  HeapGraphNode
 
class  HeapSnapshot
 
class  HeapProfiler
 
class  RetainedObjectInfo
 
struct  HeapStatsUpdate
 
class  Testing
 
class  Handle
 
class  Local
 
class  Persistent
 
class  HandleScope
 
class  Data
 
class  ScriptData
 
class  ScriptOrigin
 
class  Script
 
class  Message
 
class  StackTrace
 
class  StackFrame
 
class  Value
 
class  Primitive
 
class  Boolean
 
class  String
 
class  Number
 
class  Integer
 
class  Int32
 
class  Uint32
 
class  Object
 
class  Array
 
class  Function
 
class  Date
 
class  NumberObject
 
class  BooleanObject
 
class  StringObject
 
class  RegExp
 
class  External
 
class  Template
 
class  Arguments
 
class  AccessorInfo
 
class  FunctionTemplate
 
class  ObjectTemplate
 
class  Signature
 
class  AccessorSignature
 
class  TypeSwitch
 
class  ExternalAsciiStringResourceImpl
 
class  Extension
 
class  DeclareExtension
 
class  ResourceConstraints
 
class  Exception
 
class  HeapStatistics
 
class  Isolate
 
class  StartupData
 
class  StartupDataDecompressor
 
struct  JitCodeEvent
 
class  ExternalResourceVisitor
 
class  PersistentHandleVisitor
 
class  V8
 
class  TryCatch
 
class  ExtensionConfiguration
 
class  Context
 
class  Unlocker
 
class  Locker
 
class  OutputStream
 
class  ActivityControl
 

Typedefs

typedef uint32_t SnapshotObjectId
 
typedef void(* WeakReferenceCallback) (Persistent< Value > object, void *parameter)
 
typedef Handle< Value >(* AccessorGetter) (Local< String > property, const AccessorInfo &info)
 
typedef void(* AccessorSetter) (Local< String > property, Local< Value > value, const AccessorInfo &info)
 
typedef Handle< Value >(* InvocationCallback) (const Arguments &args)
 
typedef Handle< Value >(* NamedPropertyGetter) (Local< String > property, const AccessorInfo &info)
 
typedef Handle< Value >(* NamedPropertySetter) (Local< String > property, Local< Value > value, const AccessorInfo &info)
 
typedef Handle< Integer >(* NamedPropertyQuery) (Local< String > property, const AccessorInfo &info)
 
typedef Handle< Boolean >(* NamedPropertyDeleter) (Local< String > property, const AccessorInfo &info)
 
typedef Handle< Array >(* NamedPropertyEnumerator) (const AccessorInfo &info)
 
typedef Handle< Value >(* IndexedPropertyGetter) (uint32_t index, const AccessorInfo &info)
 
typedef Handle< Value >(* IndexedPropertySetter) (uint32_t index, Local< Value > value, const AccessorInfo &info)
 
typedef Handle< Integer >(* IndexedPropertyQuery) (uint32_t index, const AccessorInfo &info)
 
typedef Handle< Boolean >(* IndexedPropertyDeleter) (uint32_t index, const AccessorInfo &info)
 
typedef Handle< Array >(* IndexedPropertyEnumerator) (const AccessorInfo &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 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(* 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(* GCCallback) ()
 
typedef bool(* EntropySource) (unsigned char *buffer, size_t length)
 
typedef uintptr_t(* ReturnAddressLocationResolver) (uintptr_t return_addr_location)
 
typedef void(* FunctionEntryHook) (uintptr_t function, uintptr_t return_addr_location)
 
typedef void(* JitCodeEventHandler) (const JitCodeEvent *event)
 

Enumerations

enum  DebugEvent {
  Break = 1 , Exception = 2 , NewFunction = 3 , BeforeCompile = 4 ,
  AfterCompile = 5 , ScriptCollected = 6 , BreakForCommand = 7
}
 
enum  PropertyAttribute { None = 0 , ReadOnly = 1 << 0 , DontEnum = 1 << 1 , DontDelete = 1 << 2 }
 
enum  ExternalArrayType {
  kExternalByteArray = 1 , kExternalUnsignedByteArray , kExternalShortArray , kExternalUnsignedShortArray ,
  kExternalIntArray , kExternalUnsignedIntArray , kExternalFloatArray , kExternalDoubleArray ,
  kExternalPixelArray
}
 
enum  AccessControl { DEFAULT = 0 , ALL_CAN_READ = 1 , ALL_CAN_WRITE = 1 << 1 , PROHIBITS_OVERWRITING = 1 << 2 }
 
enum  AccessType {
  ACCESS_GET , ACCESS_SET , ACCESS_HAS , ACCESS_DELETE ,
  ACCESS_KEYS
}
 
enum  ObjectSpace {
  kObjectSpaceNewSpace = 1 << 0 , kObjectSpaceOldPointerSpace = 1 << 1 , kObjectSpaceOldDataSpace = 1 << 2 , kObjectSpaceCodeSpace = 1 << 3 ,
  kObjectSpaceMapSpace = 1 << 4 , kObjectSpaceLoSpace = 1 << 5 , kObjectSpaceAll
}
 
enum  AllocationAction { kAllocationActionAllocate = 1 << 0 , kAllocationActionFree = 1 << 1 , kAllocationActionAll = kAllocationActionAllocate | kAllocationActionFree }
 
enum  GCType { kGCTypeScavenge = 1 << 0 , kGCTypeMarkSweepCompact = 1 << 1 , kGCTypeAll = kGCTypeScavenge | kGCTypeMarkSweepCompact }
 
enum  GCCallbackFlags { kNoGCCallbackFlags = 0 , kGCCallbackFlagCompacted = 1 << 0 }
 
enum  JitCodeEventOptions { kJitCodeEventDefault = 0 , kJitCodeEventEnumExisting = 1 }
 

Functions

PreParserData V8EXPORT Preparse (UnicodeInputStream *input, size_t max_stack_size)
 
void V8EXPORT RegisterExtension (Extension *extension)
 
Handle< Primitive > V8EXPORT Undefined ()
 
Handle< Primitive > V8EXPORT Null ()
 
Handle< Boolean > V8EXPORT True ()
 
Handle< Boolean > V8EXPORT False ()
 
Handle< PrimitiveUndefined (Isolate *isolate)
 
Handle< PrimitiveNull (Isolate *isolate)
 
Handle< BooleanTrue (Isolate *isolate)
 
Handle< BooleanFalse (Isolate *isolate)
 
bool V8EXPORT SetResourceConstraints (ResourceConstraints *constraints)
 
Handle< Value > V8EXPORT ThrowException (Handle< Value > exception)
 

Detailed Description

Debugger support for the V8 JavaScript engine.

Profiler support for the V8 JavaScript engine.

Testing support for the V8 JavaScript engine.

The v8 JavaScript engine.

Typedef Documentation

◆ AccessorGetter

typedef Handle<Value>(* AccessorGetter) (Local< String > property, const AccessorInfo &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 1448 of file v8.h.

◆ AccessorSetter

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

Definition at line 1452 of file v8.h.

◆ AddHistogramSampleCallback

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

Definition at line 2697 of file v8.h.

◆ AllowCodeGenerationFromStringsCallback

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

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

Definition at line 2737 of file v8.h.

◆ CallCompletedCallback

typedef void(* CallCompletedCallback) ()

Definition at line 2724 of file v8.h.

◆ CounterLookupCallback

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

Definition at line 2690 of file v8.h.

◆ CreateHistogramCallback

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

Definition at line 2692 of file v8.h.

◆ EntropySource

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 2934 of file v8.h.

◆ FailedAccessCheckCallback

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

Definition at line 2727 of file v8.h.

◆ FatalErrorCallback

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

Definition at line 2660 of file v8.h.

◆ FunctionEntryHook

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 2965 of file v8.h.

◆ GCCallback

typedef void(* GCCallback) ()

Definition at line 2762 of file v8.h.

◆ GCEpilogueCallback

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

Definition at line 2760 of file v8.h.

◆ GCPrologueCallback

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

Definition at line 2759 of file v8.h.

◆ IndexedPropertyDeleter

typedef Handle<Boolean>(* IndexedPropertyDeleter) (uint32_t index, const AccessorInfo &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 2118 of file v8.h.

◆ IndexedPropertyEnumerator

typedef Handle<Array>(* IndexedPropertyEnumerator) (const AccessorInfo &info)

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

Definition at line 2125 of file v8.h.

◆ IndexedPropertyGetter

typedef Handle<Value>(* IndexedPropertyGetter) (uint32_t index, const AccessorInfo &info)

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

Definition at line 2093 of file v8.h.

◆ IndexedPropertyQuery

typedef Handle<Integer>(* IndexedPropertyQuery) (uint32_t index, const AccessorInfo &info)

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

Definition at line 2110 of file v8.h.

◆ IndexedPropertySetter

typedef Handle<Value>(* IndexedPropertySetter) (uint32_t index, Local< Value > value, const AccessorInfo &info)

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

Definition at line 2101 of file v8.h.

◆ IndexedSecurityCallback

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 2154 of file v8.h.

◆ InvocationCallback

typedef Handle<Value>(* InvocationCallback) (const Arguments &args)

Definition at line 2047 of file v8.h.

◆ JitCodeEventHandler

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

Callback function passed to SetJitCodeEventHandler.

Parameters
eventcode add, move or removal event.

Definition at line 3017 of file v8.h.

◆ MemoryAllocationCallback

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

Definition at line 2719 of file v8.h.

◆ MessageCallback

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

Definition at line 2663 of file v8.h.

◆ NamedPropertyDeleter

typedef Handle<Boolean>(* NamedPropertyDeleter) (Local< String > property, const AccessorInfo &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 2079 of file v8.h.

◆ NamedPropertyEnumerator

typedef Handle<Array>(* NamedPropertyEnumerator) (const AccessorInfo &info)

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

Definition at line 2086 of file v8.h.

◆ NamedPropertyGetter

typedef Handle<Value>(* NamedPropertyGetter) (Local< String > property, const AccessorInfo &info)

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

Definition at line 2053 of file v8.h.

◆ NamedPropertyQuery

typedef Handle<Integer>(* NamedPropertyQuery) (Local< String > property, const AccessorInfo &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 2070 of file v8.h.

◆ NamedPropertySetter

typedef Handle<Value>(* NamedPropertySetter) (Local< String > property, Local< Value > value, const AccessorInfo &info)

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

Definition at line 2061 of file v8.h.

◆ NamedSecurityCallback

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 2144 of file v8.h.

◆ ReturnAddressLocationResolver

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 2950 of file v8.h.

◆ SnapshotObjectId

typedef uint32_t SnapshotObjectId

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

◆ WeakReferenceCallback

typedef void(* WeakReferenceCallback) (Persistent< Value > object, void *parameter)

A weak reference callback function.

This callback should either explicitly invoke Dispose on |object| if V8 wrapper is not needed anymore, or 'revive' it by invocation of MakeWeak.

Parameters
objectthe weak global object to be reclaimed by the garbage collector
parameterthe value passed in when making the weak global object

Definition at line 138 of file v8.h.

Enumeration Type Documentation

◆ AccessControl

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.

Additionally, for security, accessors can prohibit overwriting by accessors defined in JavaScript. For objects that have such accessors either locally or in their prototype chain it is not possible to overwrite the accessor by using defineGetter or defineSetter from JavaScript code.

Enumerator
DEFAULT 
ALL_CAN_READ 
ALL_CAN_WRITE 
PROHIBITS_OVERWRITING 

Definition at line 1470 of file v8.h.

◆ AccessType

enum AccessType

Access type specification.

Enumerator
ACCESS_GET 
ACCESS_SET 
ACCESS_HAS 
ACCESS_DELETE 
ACCESS_KEYS 

Definition at line 2131 of file v8.h.

◆ AllocationAction

Enumerator
kAllocationActionAllocate 
kAllocationActionFree 
kAllocationActionAll 

Definition at line 2713 of file v8.h.

◆ DebugEvent

enum DebugEvent
Enumerator
Break 
Exception 
NewFunction 
BeforeCompile 
AfterCompile 
ScriptCollected 
BreakForCommand 

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

◆ ExternalArrayType

Enumerator
kExternalByteArray 
kExternalUnsignedByteArray 
kExternalShortArray 
kExternalUnsignedShortArray 
kExternalIntArray 
kExternalUnsignedIntArray 
kExternalFloatArray 
kExternalDoubleArray 
kExternalPixelArray 

Definition at line 1431 of file v8.h.

◆ GCCallbackFlags

Enumerator
kNoGCCallbackFlags 
kGCCallbackFlagCompacted 

Definition at line 2754 of file v8.h.

◆ GCType

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 2748 of file v8.h.

◆ JitCodeEventOptions

Option flags passed to the SetJitCodeEventHandler function.

Enumerator
kJitCodeEventDefault 
kJitCodeEventEnumExisting 

Definition at line 3005 of file v8.h.

◆ ObjectSpace

Enumerator
kObjectSpaceNewSpace 
kObjectSpaceOldPointerSpace 
kObjectSpaceOldDataSpace 
kObjectSpaceCodeSpace 
kObjectSpaceMapSpace 
kObjectSpaceLoSpace 
kObjectSpaceAll 

Definition at line 2700 of file v8.h.

◆ PropertyAttribute

Enumerator
None 
ReadOnly 
DontEnum 
DontDelete 

Definition at line 1424 of file v8.h.

Function Documentation

◆ False() [1/2]

Handle<Boolean> V8EXPORT v8::False ( )

Referenced by False(), and Boolean::New().

◆ False() [2/2]

◆ Null() [1/2]

Handle<Primitive> V8EXPORT v8::Null ( )

Referenced by Null().

◆ Null() [2/2]

◆ Preparse()

PreParserData V8EXPORT v8::Preparse ( UnicodeInputStream input,
size_t  max_stack_size 
)

◆ RegisterExtension()

void V8EXPORT v8::RegisterExtension ( Extension extension)

◆ SetResourceConstraints()

bool V8EXPORT v8::SetResourceConstraints ( ResourceConstraints constraints)

◆ ThrowException()

Handle<Value> V8EXPORT v8::ThrowException ( Handle< Value exception)

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.

◆ True() [1/2]

Handle<Boolean> V8EXPORT v8::True ( )

Referenced by Boolean::New(), and True().

◆ True() [2/2]

◆ Undefined() [1/2]

Handle<Primitive> V8EXPORT v8::Undefined ( )

Referenced by Arguments::operator[](), and Undefined().

◆ Undefined() [2/2]