v8  9.4.146 (node 16.13.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 4578 of file v8.h.

Constructor & Destructor Documentation

◆ FunctionCallbackInfo()

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

Definition at line 11420 of file v8.h.

References FunctionCallbackInfo< T >::implicit_args_, FunctionCallbackInfo< T >::length_, and FunctionCallbackInfo< T >::values_.

Member Function Documentation

◆ Data()

Local< Value > Data

The data argument specified when creating the callback.

Definition at line 11453 of file v8.h.

References FunctionCallbackInfo< T >::implicit_args_, FunctionCallbackInfo< T >::kDataIndex, and Local< T >::Local.

◆ GetIsolate()

Isolate * GetIsolate

The current Isolate.

Definition at line 11459 of file v8.h.

References FunctionCallbackInfo< T >::implicit_args_, and FunctionCallbackInfo< T >::kIsolateIndex.

Referenced by FunctionCallbackInfo< T >::operator[]().

◆ GetReturnValue()

ReturnValue< T > GetReturnValue

The ReturnValue for the call.

Definition at line 11465 of file v8.h.

References FunctionCallbackInfo< T >::implicit_args_, FunctionCallbackInfo< T >::kReturnValueIndex, and Local< T >::ReturnValue.

◆ Holder()

Local< Object > Holder

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

References FunctionCallbackInfo< T >::implicit_args_, FunctionCallbackInfo< T >::kHolderIndex, and Local< T >::Local.

◆ IsConstructCall()

bool IsConstructCall

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

Definition at line 11471 of file v8.h.

References FunctionCallbackInfo< T >::NewTarget().

◆ Length()

int Length

The number of available arguments.

Definition at line 11477 of file v8.h.

References FunctionCallbackInfo< T >::length_.

◆ NewTarget()

Local< Value > NewTarget

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

Definition at line 11447 of file v8.h.

References FunctionCallbackInfo< T >::implicit_args_, FunctionCallbackInfo< T >::kNewTargetIndex, and Local< T >::Local.

Referenced by FunctionCallbackInfo< T >::IsConstructCall().

◆ operator[]()

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

Accessor for the available arguments. Returns undefined if the index is out of bounds.

Definition at line 11426 of file v8.h.

References FunctionCallbackInfo< T >::GetIsolate(), FunctionCallbackInfo< T >::length_, Local< T >::Local, and FunctionCallbackInfo< T >::values_.

◆ This()

Local< Object > This

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

Definition at line 11434 of file v8.h.

References Local< T >::Local, and FunctionCallbackInfo< T >::values_.

Friends And Related Function Documentation

◆ debug::ConsoleCallArguments

friend class debug::ConsoleCallArguments
friend

Definition at line 4616 of file v8.h.

◆ internal::CustomArguments< FunctionCallbackInfo >

friend class internal::CustomArguments< FunctionCallbackInfo >
friend

Definition at line 4614 of file v8.h.

◆ internal::FunctionCallbackArguments

friend class internal::FunctionCallbackArguments
friend

Definition at line 4614 of file v8.h.

Field Documentation

◆ implicit_args_

internal::Address* implicit_args_
protected

Definition at line 4626 of file v8.h.

Referenced by FunctionCallbackInfo< T >::Data(), FunctionCallbackInfo< T >::FunctionCallbackInfo(), FunctionCallbackInfo< T >::GetIsolate(), FunctionCallbackInfo< T >::GetReturnValue(), FunctionCallbackInfo< T >::Holder(), and FunctionCallbackInfo< T >::NewTarget().

◆ kArgsLength

const int kArgsLength = 6
static

Definition at line 4611 of file v8.h.

◆ kDataIndex

const int kDataIndex = 4
staticprotected

Definition at line 4621 of file v8.h.

Referenced by FunctionCallbackInfo< T >::Data().

◆ kHolderIndex

const int kHolderIndex = 0
staticprotected

Definition at line 4617 of file v8.h.

Referenced by FunctionCallbackInfo< T >::Holder().

◆ kIsolateIndex

const int kIsolateIndex = 1
staticprotected

Definition at line 4618 of file v8.h.

Referenced by FunctionCallbackInfo< T >::GetIsolate().

◆ kNewTargetIndex

const int kNewTargetIndex = 5
staticprotected

Definition at line 4622 of file v8.h.

Referenced by FunctionCallbackInfo< T >::NewTarget().

◆ kReturnValueDefaultValueIndex

const int kReturnValueDefaultValueIndex = 2
staticprotected

Definition at line 4619 of file v8.h.

◆ kReturnValueIndex

const int kReturnValueIndex = 3
staticprotected

Definition at line 4620 of file v8.h.

Referenced by FunctionCallbackInfo< T >::GetReturnValue().

◆ length_

int length_
protected

Definition at line 4628 of file v8.h.

Referenced by FunctionCallbackInfo< T >::FunctionCallbackInfo(), FunctionCallbackInfo< T >::Length(), and FunctionCallbackInfo< T >::operator[]().

◆ values_

internal::Address* values_
protected

Definition at line 4627 of file v8.h.

Referenced by FunctionCallbackInfo< T >::FunctionCallbackInfo(), FunctionCallbackInfo< T >::operator[](), and FunctionCallbackInfo< T >::This().

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