v8  6.1.534(node8.9.3)
V8 is Google's open source JavaScript engine
FunctionCallbackInfo< T > Class Template Reference

#include <v8.h>

Public Member Functions

V8_INLINE int Length () const
 
V8_INLINE Local< Valueoperator[] (int i) const
 
V8_INLINE V8_DEPRECATED ("Use Data() to explicitly pass Callee instead", Local< Function > Callee() const)
 
V8_INLINE Local< ObjectThis () const
 
V8_INLINE Local< ObjectHolder () const
 
V8_INLINE Local< ValueNewTarget () const
 
V8_INLINE bool IsConstructCall () const
 
V8_INLINE Local< ValueData () const
 
V8_INLINE IsolateGetIsolate () const
 
V8_INLINE ReturnValue< T > GetReturnValue () const
 

Static Public Attributes

static const int kArgsLength = 8
 

Protected Member Functions

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

Protected Attributes

internal::Object ** implicit_args_
 
internal::Object ** 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 kCalleeIndex = 5
 
static const int kContextSaveIndex = 6
 
static const int kNewTargetIndex = 7
 

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

Constructor & Destructor Documentation

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

Member Function Documentation

Local< Value > Data ( ) const

The data argument specified when creating the callback.

Definition at line 9422 of file v8.h.

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

Isolate * GetIsolate ( ) const
ReturnValue< T > GetReturnValue ( ) const
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 9410 of file v8.h.

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

bool IsConstructCall ( ) const

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

Definition at line 9440 of file v8.h.

References FunctionCallbackInfo< T >::NewTarget().

int Length ( ) const

The number of available arguments.

Definition at line 9446 of file v8.h.

References FunctionCallbackInfo< T >::length_.

Local< Value > NewTarget ( ) const

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

Definition at line 9416 of file v8.h.

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

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

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

Accessor for the available arguments.

Definition at line 9390 of file v8.h.

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

Local< Object > This ( ) const

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

Definition at line 9404 of file v8.h.

References FunctionCallbackInfo< T >::values_.

V8_INLINE V8_DEPRECATED ( "Use Data() to explicitly pass Callee instead"  ,
Local< Function > Callee()  const 
)

Friends And Related Function Documentation

friend class debug::ConsoleCallArguments
friend

Definition at line 3671 of file v8.h.

Definition at line 3670 of file v8.h.

friend class internal::FunctionCallbackArguments
friend

Definition at line 3669 of file v8.h.

Field Documentation

const int kArgsLength = 8
static

Definition at line 3666 of file v8.h.

const int kCalleeIndex = 5
staticprotected

Definition at line 3677 of file v8.h.

const int kContextSaveIndex = 6
staticprotected

Definition at line 3678 of file v8.h.

const int kDataIndex = 4
staticprotected

Definition at line 3676 of file v8.h.

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

const int kHolderIndex = 0
staticprotected

Definition at line 3672 of file v8.h.

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

const int kIsolateIndex = 1
staticprotected

Definition at line 3673 of file v8.h.

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

const int kNewTargetIndex = 7
staticprotected

Definition at line 3679 of file v8.h.

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

const int kReturnValueDefaultValueIndex = 2
staticprotected

Definition at line 3674 of file v8.h.

const int kReturnValueIndex = 3
staticprotected

Definition at line 3675 of file v8.h.

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

internal::Object** values_
protected

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