#include <v8.h>

Inheritance diagram for FunctionTemplate:

Collaboration diagram for FunctionTemplate:

Public Member Functions
Local< Function >	GetFunction ()

void	SetCallHandler (FunctionCallback callback, Handle< Value > data=Handle< Value >())

void	SetLength (int length)

Local< ObjectTemplate >	InstanceTemplate ()

void	Inherit (Handle< FunctionTemplate > parent)

Local< ObjectTemplate >	PrototypeTemplate ()

void	SetClassName (Handle< String > name)

void	SetHiddenPrototype (bool value)

void	ReadOnlyPrototype ()

void	RemovePrototype ()

bool	HasInstance (Handle< Value > object)

Public Member Functions inherited from Template
void	Set (Handle< String > name, Handle< Data > value, PropertyAttribute attributes=None)

V8_INLINE void	Set (Isolate isolate, const char name, Handle< Data > value)

void	SetAccessorProperty (Local< String > name, Local< FunctionTemplate > getter=Local< FunctionTemplate >(), Local< FunctionTemplate > setter=Local< FunctionTemplate >(), PropertyAttribute attribute=None, AccessControl settings=DEFAULT)

void	SetNativeDataProperty (Local< String > name, AccessorGetterCallback getter, AccessorSetterCallback setter=0, Handle< Value > data=Handle< Value >(), PropertyAttribute attribute=None, Local< AccessorSignature > signature=Local< AccessorSignature >(), AccessControl settings=DEFAULT)

bool	SetDeclaredAccessor (Local< String > name, Local< DeclaredAccessorDescriptor > descriptor, PropertyAttribute attribute=None, Local< AccessorSignature > signature=Local< AccessorSignature >(), AccessControl settings=DEFAULT)

Static Public Member Functions
static Local< FunctionTemplate >	New (Isolate *isolate, FunctionCallback callback=0, Handle< Value > data=Handle< Value >(), Handle< Signature > signature=Handle< Signature >(), int length=0)

Friends
class	Context

class	ObjectTemplate

Detailed Description

A FunctionTemplate is used to create functions at runtime. There can only be one function created from a FunctionTemplate in a context. The lifetime of the created function is equal to the lifetime of the context. So in case the embedder needs to create temporary functions that can be collected using Scripts is preferred.

A FunctionTemplate can have properties, these properties are added to the function object when it is created.

A FunctionTemplate has a corresponding instance template which is used to create object instances when the function is used as a constructor. Properties added to the instance template are added to each object instance.

A FunctionTemplate can have a prototype template. The prototype template is used to create the prototype object of the function.

The following example shows how to use a FunctionTemplate:

v8::Local<v8::FunctionTemplate> t = v8::FunctionTemplate::New();
t->Set("func_property", v8::Number::New(1));
 
v8::Local<v8::Template> proto_t = t->PrototypeTemplate();
proto_t->Set("proto_method", v8::FunctionTemplate::New(InvokeCallback));
proto_t->Set("proto_const", v8::Number::New(2));
 
v8::Local<v8::ObjectTemplate> instance_t = t->InstanceTemplate();
instance_t->SetAccessor("instance_accessor", InstanceAccessorCallback);
instance_t->SetNamedPropertyHandler(PropertyHandlerCallback, ...);
instance_t->Set("instance_property", Number::New(3));
 
v8::Local<v8::Function> function = t->GetFunction();
v8::Local<v8::Object> instance = function->NewInstance();

Let's use "function" as the JS variable name of the function object and "instance" for the instance object created above. The function and the instance will have the following properties:

func_property in function == true;
function.func_property == 1;
 
function.prototype.proto_method() invokes 'InvokeCallback'
function.prototype.proto_const == 2;
 
instance instanceof function == true;
instance.instance_accessor calls 'InstanceAccessorCallback'
instance.instance_property == 3;

A FunctionTemplate can inherit from another one by calling the FunctionTemplate::Inherit method. The following graph illustrates the semantics of inheritance:

FunctionTemplate Parent  -> Parent() . prototype -> { }
  ^                                                  ^
  | Inherit(Parent)                                  | .__proto__
  |                                                  |
FunctionTemplate Child   -> Child()  . prototype -> { }

A FunctionTemplate 'Child' inherits from 'Parent', the prototype object of the Child() function has proto pointing to the Parent() function's prototype object. An instance of the Child function has all properties on Parent's instance templates.

Let Parent be the FunctionTemplate initialized in the previous section and create a Child FunctionTemplate by:

Local<FunctionTemplate> parent = t;
Local<FunctionTemplate> child = FunctionTemplate::New();
child->Inherit(parent);
 
Local<Function> child_function = child->GetFunction();
Local<Object> child_instance = child_function->NewInstance();

The Child function and Child instance will have the following properties:

child_func.prototype.__proto__ == function.prototype;
child_instance.instance_accessor calls 'InstanceAccessorCallback'
child_instance.instance_property == 3;

Definition at line 3452 of file v8.h.

Member Function Documentation

◆ GetFunction()

Local<Function> GetFunction ( )

Returns the unique function instance in the current execution context.

◆ HasInstance()

bool HasInstance ( Handle< Value > object )

Returns true if the given object is an instance of this function template.

◆ Inherit()

void Inherit ( Handle< FunctionTemplate > parent )

Causes the function template to inherit from a parent function template.

◆ InstanceTemplate()

Local<ObjectTemplate> InstanceTemplate ( )

Get the InstanceTemplate.

◆ New()

static Local<FunctionTemplate> New	(	Isolate *	isolate,
		FunctionCallback	callback = `0`,
		Handle< Value >	data = `Handle< Value >()`,
		Handle< Signature >	signature = `Handle< Signature >()`,
		int	length = `0`
	)

static

Creates a function template.

◆ PrototypeTemplate()

Local<ObjectTemplate> PrototypeTemplate ( )

A PrototypeTemplate is the template used to create the prototype object of the function created by this template.

◆ ReadOnlyPrototype()

void ReadOnlyPrototype ( )

Sets the ReadOnly flag in the attributes of the 'prototype' property of functions created from this FunctionTemplate to true.

◆ RemovePrototype()

void RemovePrototype ( )

Removes the prototype property from functions created from this FunctionTemplate.

◆ SetCallHandler()

void SetCallHandler	(	FunctionCallback	callback,
		Handle< Value >	data = `Handle< Value >()`
	)

Set the call-handler callback for a FunctionTemplate. This callback is called whenever the function created from this FunctionTemplate is called.

◆ SetClassName()

void SetClassName ( Handle< String > name )

Set the class name of the FunctionTemplate. This is used for printing objects created with the function created from the FunctionTemplate as its constructor.

◆ SetHiddenPrototype()

void SetHiddenPrototype ( bool value )

Determines whether the proto accessor ignores instances of the function template. If instances of the function template are ignored, proto skips all instances and instead returns the next object in the prototype chain.

Call with a value of true to make the proto accessor ignore instances of the function template. Call with a value of false to make the proto accessor not ignore instances of the function template. By default, instances of a function template are not ignored.

◆ SetLength()

void SetLength ( int length )

Set the predefined length property for the FunctionTemplate.

Friends And Related Function Documentation

◆ Context

friend class Context

friend

Definition at line 3529 of file v8.h.

◆ ObjectTemplate

friend class ObjectTemplate