v8 10.2.154 (node 18.16.0)
V8 is Google's open source JavaScript engine
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends
FunctionCallbackInfo< T > Class Template Reference

#include <v8-function-callback.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 87 of file v8-function-callback.h.

Constructor & Destructor Documentation

◆ FunctionCallbackInfo()

template<typename T >
FunctionCallbackInfo ( internal::Address *  implicit_args,
internal::Address *  values,
int  length 
)
protected

Definition at line 382 of file v8-function-callback.h.

Member Function Documentation

◆ Data()

template<typename T >
Local< Value > Data

The data argument specified when creating the callback.

Definition at line 413 of file v8-function-callback.h.

◆ GetIsolate()

template<typename T >
Isolate * GetIsolate

The current Isolate.

Definition at line 418 of file v8-function-callback.h.

◆ GetReturnValue()

template<typename T >
ReturnValue< T > GetReturnValue

The ReturnValue for the call.

Definition at line 423 of file v8-function-callback.h.

◆ Holder()

template<typename T >
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 401 of file v8-function-callback.h.

◆ IsConstructCall()

template<typename T >
bool IsConstructCall

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

Definition at line 428 of file v8-function-callback.h.

◆ Length()

template<typename T >
int Length

The number of available arguments.

Definition at line 433 of file v8-function-callback.h.

◆ NewTarget()

template<typename T >
Local< Value > NewTarget

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

Definition at line 407 of file v8-function-callback.h.

◆ operator[]()

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

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

Definition at line 388 of file v8-function-callback.h.

References v8::Undefined().

◆ This()

template<typename T >
Local< Object > This

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

Definition at line 395 of file v8-function-callback.h.

Friends And Related Symbol Documentation

◆ debug::ConsoleCallArguments

template<typename T >
friend class debug::ConsoleCallArguments
friend

Definition at line 125 of file v8-function-callback.h.

◆ internal::CustomArguments< FunctionCallbackInfo >

template<typename T >
friend class internal::CustomArguments< FunctionCallbackInfo >
friend

Definition at line 123 of file v8-function-callback.h.

◆ internal::FunctionCallbackArguments

template<typename T >
friend class internal::FunctionCallbackArguments
friend

Definition at line 123 of file v8-function-callback.h.

Field Documentation

◆ implicit_args_

template<typename T >
internal::Address* implicit_args_
protected

Definition at line 135 of file v8-function-callback.h.

◆ kArgsLength

template<typename T >
const int kArgsLength = 6
static

Definition at line 120 of file v8-function-callback.h.

◆ kDataIndex

template<typename T >
const int kDataIndex = 4
staticprotected

Definition at line 130 of file v8-function-callback.h.

◆ kHolderIndex

template<typename T >
const int kHolderIndex = 0
staticprotected

Definition at line 126 of file v8-function-callback.h.

◆ kIsolateIndex

template<typename T >
const int kIsolateIndex = 1
staticprotected

Definition at line 127 of file v8-function-callback.h.

◆ kNewTargetIndex

template<typename T >
const int kNewTargetIndex = 5
staticprotected

Definition at line 131 of file v8-function-callback.h.

◆ kReturnValueDefaultValueIndex

template<typename T >
const int kReturnValueDefaultValueIndex = 2
staticprotected

Definition at line 128 of file v8-function-callback.h.

◆ kReturnValueIndex

template<typename T >
const int kReturnValueIndex = 3
staticprotected

Definition at line 129 of file v8-function-callback.h.

◆ length_

template<typename T >
int length_
protected

Definition at line 137 of file v8-function-callback.h.

◆ values_

template<typename T >
internal::Address* values_
protected

Definition at line 136 of file v8-function-callback.h.

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