v8  7.4.288(node12.0.0)
V8 is Google's open source JavaScript engine
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends
FunctionCallbackInfo< T > Class Template Reference

#include <v8.h>

Public Member Functions

V8_INLINE int Length () const
 
V8_INLINE Local< Value > operator[] (int i) const
 
V8_INLINE Local< Object > This () const
 
V8_INLINE Local< Object > Holder () const
 
V8_INLINE Local< Value > NewTarget () const
 
V8_INLINE bool IsConstructCall () const
 
V8_INLINE Local< Value > Data () const
 
V8_INLINE Isolate * GetIsolate () const
 
V8_INLINE ReturnValue< T > GetReturnValue () const
 

Static Public Attributes

static const int kArgsLength = 6
 

Protected Member Functions

V8_INLINE FunctionCallbackInfo (internal::Address *implicit_args, internal::Address *values, int length)
 

Protected Attributes

internal::Address * implicit_args_
 
internal::Address * values_
 
int length_
 

Static Protected Attributes

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
 
static const int kNewTargetIndex = 5
 

Friends

class internal::FunctionCallbackArguments
 
class internal::CustomArguments< FunctionCallbackInfo >
 
class debug::ConsoleCallArguments
 

Detailed Description

template<typename T>
class v8::FunctionCallbackInfo< T >

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.

Definition at line 107 of file v8.h.

Constructor & Destructor Documentation

◆ FunctionCallbackInfo()

FunctionCallbackInfo ( internal::Address *  implicit_args,
internal::Address *  values,
int  length 
)
protected

Definition at line 10146 of file v8.h.

Member Function Documentation

◆ Data()

Local< Value > Data ( ) const

The data argument specified when creating the callback.

Definition at line 10177 of file v8.h.

◆ GetIsolate()

Isolate * GetIsolate ( ) const

The current Isolate.

Definition at line 10183 of file v8.h.

◆ GetReturnValue()

ReturnValue< T > GetReturnValue ( ) const

The ReturnValue for the call.

Definition at line 10189 of file v8.h.

◆ Holder()

Local< Object > Holder ( ) const

If the callback was created without a Signature, this is the same value as This(). If there is a signature, and the signature didn't match This() but one of its hidden prototypes, this will be the respective hidden prototype.

Note that this is not the prototype of This() on which the accessor referencing this callback was found (which in V8 internally is often referred to as holder [sic]).

Definition at line 10165 of file v8.h.

◆ IsConstructCall()

bool IsConstructCall ( ) const

Indicates whether this is a regular call or a construct call.

Definition at line 10195 of file v8.h.

◆ Length()

int Length ( ) const

The number of available arguments.

Definition at line 10201 of file v8.h.

◆ NewTarget()

Local< Value > NewTarget ( ) const

For construct calls, this returns the "new.target" value.

Definition at line 10171 of file v8.h.

◆ operator[]()

Local< Value > operator[] ( int  i) const

Accessor for the available arguments.

Definition at line 10152 of file v8.h.

References v8::Undefined().

◆ This()

Local< Object > This ( ) const

Returns the receiver. This corresponds to the "this" value.

Definition at line 10159 of file v8.h.

Friends And Related Function Documentation

◆ debug::ConsoleCallArguments

friend class debug::ConsoleCallArguments
friend

Definition at line 3982 of file v8.h.

◆ internal::CustomArguments< FunctionCallbackInfo >

friend class internal::CustomArguments< FunctionCallbackInfo >
friend

Definition at line 3981 of file v8.h.

◆ internal::FunctionCallbackArguments

friend class internal::FunctionCallbackArguments
friend

Definition at line 3980 of file v8.h.

Field Documentation

◆ implicit_args_

internal::Address* implicit_args_
protected

Definition at line 3992 of file v8.h.

◆ kArgsLength

const int kArgsLength = 6
static

Definition at line 3977 of file v8.h.

◆ kDataIndex

const int kDataIndex = 4
staticprotected

Definition at line 3987 of file v8.h.

◆ kHolderIndex

const int kHolderIndex = 0
staticprotected

Definition at line 3983 of file v8.h.

◆ kIsolateIndex

const int kIsolateIndex = 1
staticprotected

Definition at line 3984 of file v8.h.

◆ kNewTargetIndex

const int kNewTargetIndex = 5
staticprotected

Definition at line 3988 of file v8.h.

◆ kReturnValueDefaultValueIndex

const int kReturnValueDefaultValueIndex = 2
staticprotected

Definition at line 3985 of file v8.h.

◆ kReturnValueIndex

const int kReturnValueIndex = 3
staticprotected

Definition at line 3986 of file v8.h.

◆ length_

int length_
protected

Definition at line 3994 of file v8.h.

◆ values_

internal::Address* values_
protected

Definition at line 3993 of file v8.h.

The documentation for this class was generated from the following file: