v8::ObjectTemplate Class Reference

An ObjectTemplate is used to create objects at runtime. More...

#include <v8.h>

Inheritance diagram for v8::ObjectTemplate:

Collaboration diagram for v8::ObjectTemplate:

Public Member Functions
Local< Object >	NewInstance ()
	Creates a new instance of this template. More...
void	SetAccessor (Handle< String > name, AccessorGetterCallback getter, AccessorSetterCallback setter=0, Handle< Value > data=Handle< Value >(), AccessControl settings=DEFAULT, PropertyAttribute attribute=None, Handle< AccessorSignature > signature=Handle< AccessorSignature >())
	Sets an accessor on the object template. More...
void	SetAccessor (Handle< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=0, Handle< Value > data=Handle< Value >(), AccessControl settings=DEFAULT, PropertyAttribute attribute=None, Handle< AccessorSignature > signature=Handle< AccessorSignature >())
void	SetNamedPropertyHandler (NamedPropertyGetterCallback getter, NamedPropertySetterCallback setter=0, NamedPropertyQueryCallback query=0, NamedPropertyDeleterCallback deleter=0, NamedPropertyEnumeratorCallback enumerator=0, Handle< Value > data=Handle< Value >())
	Sets a named property handler on the object template. More...
void	SetIndexedPropertyHandler (IndexedPropertyGetterCallback getter, IndexedPropertySetterCallback setter=0, IndexedPropertyQueryCallback query=0, IndexedPropertyDeleterCallback deleter=0, IndexedPropertyEnumeratorCallback enumerator=0, Handle< Value > data=Handle< Value >())
	Sets an indexed property handler on the object template. More...
void	SetCallAsFunctionHandler (FunctionCallback callback, Handle< Value > data=Handle< Value >())
	Sets the callback to be used when calling instances created from this template as a function. More...
void	MarkAsUndetectable ()
	Mark object instances of the template as undetectable. More...
void	SetAccessCheckCallbacks (NamedSecurityCallback named_handler, IndexedSecurityCallback indexed_handler, Handle< Value > data=Handle< Value >(), bool turned_on_by_default=true)
	Sets access check callbacks on the object template. More...
int	InternalFieldCount ()
	Gets the number of internal fields for objects generated from this template. More...
void	SetInternalFieldCount (int value)
	Sets the number of internal fields for objects generated from this template. More...
Public Member Functions inherited from v8::Template
void	Set (Handle< Name > name, Handle< Data > value, PropertyAttribute attributes=None)
	Adds a property to each instance created by this template. More...
void	Set (Isolate *isolate, const char *name, Handle< Data > value)
void	SetAccessorProperty (Local< Name > 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)
	Whenever the property with the given name is accessed on objects created from this Template the getter and setter callbacks are called instead of getting and setting the property directly on the JavaScript object. More...
void	SetNativeDataProperty (Local< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=0, Handle< Value > data=Handle< Value >(), PropertyAttribute attribute=None, Local< AccessorSignature > signature=Local< AccessorSignature >(), AccessControl settings=DEFAULT)
bool	SetDeclaredAccessor (Local< Name > name, Local< DeclaredAccessorDescriptor > descriptor, PropertyAttribute attribute=None, Local< AccessorSignature > signature=Local< AccessorSignature >(), AccessControl settings=DEFAULT)

Static Public Member Functions
static Local< ObjectTemplate >	New (Isolate *isolate)
	Creates an ObjectTemplate. More...
static Local< ObjectTemplate >	New ()

Private Member Functions
	ObjectTemplate ()

Static Private Member Functions
static Local< ObjectTemplate >	New (internal::Isolate *isolate, Handle< FunctionTemplate > constructor)

Friends
class	FunctionTemplate

Detailed Description

An ObjectTemplate is used to create objects at runtime.

Properties added to an ObjectTemplate are added to each object created from the ObjectTemplate.

Definition at line 3728 of file v8.h.

Constructor & Destructor Documentation

ObjectTemplate()

v8::ObjectTemplate::ObjectTemplate ( )

private

Member Function Documentation

InternalFieldCount()

int v8::ObjectTemplate::InternalFieldCount

(

)

Gets the number of internal fields for objects generated from this template.

Definition at line 1528 of file api.cc.

                                       {
  return i::Smi::cast(Utils::OpenHandle(this)->internal_field_count())->value();
}

References v8::internal::internal_field_count, and v8::Utils::OpenHandle().

Here is the call graph for this function:

MarkAsUndetectable()

void v8::ObjectTemplate::MarkAsUndetectable

(

)

Mark object instances of the template as undetectable.

In many ways, undetectable objects behave as though they are not there. They behave like 'undefined' in conditionals and when printed. However, properties can be accessed and called as on normal objects.

Definition at line 1430 of file api.cc.

                                        {
  i::Isolate* isolate = Utils::OpenHandle(this)->GetIsolate();
  ENTER_V8(isolate);
  i::HandleScope scope(isolate);
  EnsureConstructor(isolate, this);
  i::FunctionTemplateInfo* constructor =
      i::FunctionTemplateInfo::cast(Utils::OpenHandle(this)->constructor());
  i::Handle<i::FunctionTemplateInfo> cons(constructor);
  cons->set_undetectable(true);
}

References v8::EnsureConstructor(), ENTER_V8, and v8::Utils::OpenHandle().

Here is the call graph for this function:

New() [1/3]

Local< ObjectTemplate > v8::ObjectTemplate::New ( )

static

Definition at line 1244 of file api.cc.

                                          {
  return New(i::Isolate::Current(), Local<FunctionTemplate>());
}

Referenced by v8::CreateEnvironment(), v8::Shell::CreateGlobalTemplate(), v8::internal::anonymous_namespace{i18n.cc}::GetEternal(), v8::FunctionTemplate::InstanceTemplate(), New(), and v8::FunctionTemplate::PrototypeTemplate().

Here is the caller graph for this function:

New() [2/3]

Local< ObjectTemplate > v8::ObjectTemplate::New ( internal::Isolate *  isolate, v8::Handle< FunctionTemplate >  constructor  )

staticprivate

Definition at line 1249 of file api.cc.

                                            {
  LOG_API(isolate, "ObjectTemplate::New");
  ENTER_V8(isolate);
  i::Handle<i::Struct> struct_obj =
      isolate->factory()->NewStruct(i::OBJECT_TEMPLATE_INFO_TYPE);
  i::Handle<i::ObjectTemplateInfo> obj =
      i::Handle<i::ObjectTemplateInfo>::cast(struct_obj);
  InitializeTemplate(obj, Consts::OBJECT_TEMPLATE);
  if (!constructor.IsEmpty())
    obj->set_constructor(*Utils::OpenHandle(*constructor));
  obj->set_internal_field_count(i::Smi::FromInt(0));
  return Utils::ToLocal(obj);
}

References v8::internal::Handle< T >::cast(), ENTER_V8, v8::internal::Isolate::factory(), v8::internal::Smi::FromInt(), v8::InitializeTemplate(), v8::Handle< T >::IsEmpty(), LOG_API, v8::Consts::OBJECT_TEMPLATE, v8::internal::OBJECT_TEMPLATE_INFO_TYPE, v8::Utils::OpenHandle(), and v8::Utils::ToLocal().

Here is the call graph for this function:

New() [3/3]

Local< ObjectTemplate > v8::ObjectTemplate::New ( Isolate *  isolate )

static

Creates an ObjectTemplate.

Definition at line 1239 of file api.cc.

                                                          {
  return New(reinterpret_cast<i::Isolate*>(isolate), Local<FunctionTemplate>());
}

References New().

Here is the call graph for this function:

NewInstance()

Local< v8::Object > v8::ObjectTemplate::NewInstance

(

)

Creates a new instance of this template.

Definition at line 5312 of file api.cc.

                                            {
  i::Isolate* isolate = i::Isolate::Current();
  ON_BAILOUT(isolate, "v8::ObjectTemplate::NewInstance()",
             return Local<v8::Object>());
  LOG_API(isolate, "ObjectTemplate::NewInstance");
  ENTER_V8(isolate);
  EXCEPTION_PREAMBLE(isolate);
  i::Handle<i::Object> obj;
  has_pending_exception = !i::Execution::InstantiateObject(
      Utils::OpenHandle(this)).ToHandle(&obj);
  EXCEPTION_BAILOUT_CHECK(isolate, Local<v8::Object>());
  return Utils::ToLocal(i::Handle<i::JSObject>::cast(obj));
}

References ENTER_V8, EXCEPTION_BAILOUT_CHECK, EXCEPTION_PREAMBLE, LOG_API, ON_BAILOUT, v8::Utils::OpenHandle(), and v8::Utils::ToLocal().

Here is the call graph for this function:

SetAccessCheckCallbacks()

void v8::ObjectTemplate::SetAccessCheckCallbacks	(	NamedSecurityCallback	named_handler,
		IndexedSecurityCallback	indexed_handler,
		Handle< Value >	data = Handle<Value>(),
		bool	turned_on_by_default = true
	)

Sets access check callbacks on the object template.

When accessing properties on instances of this object template, the access check callback will be called to determine whether or not to allow cross-context access to the properties. The last parameter specifies whether access checks are turned on by default on instances. If access checks are off by default, they can be turned on on individual instances by calling Object::TurnOnAccessCheck().

Definition at line 1442 of file api.cc.

                               {
  i::Isolate* isolate = Utils::OpenHandle(this)->GetIsolate();
  ENTER_V8(isolate);
  i::HandleScope scope(isolate);
  EnsureConstructor(isolate, this);
 
  i::Handle<i::Struct> struct_info =
      isolate->factory()->NewStruct(i::ACCESS_CHECK_INFO_TYPE);
  i::Handle<i::AccessCheckInfo> info =
      i::Handle<i::AccessCheckInfo>::cast(struct_info);
 
  SET_FIELD_WRAPPED(info, set_named_callback, named_callback);
  SET_FIELD_WRAPPED(info, set_indexed_callback, indexed_callback);
 
  if (data.IsEmpty()) {
    data = v8::Undefined(reinterpret_cast<v8::Isolate*>(isolate));
  }
  info->set_data(*Utils::OpenHandle(*data));
 
  i::FunctionTemplateInfo* constructor =
      i::FunctionTemplateInfo::cast(Utils::OpenHandle(this)->constructor());
  i::Handle<i::FunctionTemplateInfo> cons(constructor);
  cons->set_access_check_info(*info);
  cons->set_needs_access_check(turned_on_by_default);
}

References v8::internal::ACCESS_CHECK_INFO_TYPE, v8::internal::Handle< T >::cast(), v8::EnsureConstructor(), ENTER_V8, v8::internal::Isolate::factory(), v8::Handle< T >::IsEmpty(), v8::Utils::OpenHandle(), SET_FIELD_WRAPPED, and v8::Undefined().

Here is the call graph for this function:

SetAccessor() [1/2]

void v8::ObjectTemplate::SetAccessor	(	v8::Handle< Name >	name,
		AccessorNameGetterCallback	getter,
		AccessorNameSetterCallback	setter = 0,
		v8::Handle< Value >	data = Handle<Value>(),
		AccessControl	settings = DEFAULT,
		PropertyAttribute	attribute = None,
		v8::Handle< AccessorSignature >	signature = Handle<AccessorSignature>()
	)

Definition at line 1385 of file api.cc.

                                                                        {
  TemplateSetAccessor(
      this, name, getter, setter, data, settings, attribute, signature);
}

References name, and v8::TemplateSetAccessor().

Here is the call graph for this function:

SetAccessor() [2/2]

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

Sets an accessor on the object template.

Whenever the property with the given name is accessed on objects created from this ObjectTemplate the getter and setter callbacks are called instead of getting and setting the property directly on the JavaScript object.

Parameters

name	The name of the property for which an accessor is added.
getter	The callback to invoke when getting the property.
setter	The callback to invoke when setting the property.
data	A piece of data that will be passed to the getter and setter callbacks whenever they are invoked.
settings	Access control settings for the accessor. This is a bit field consisting of one of more of DEFAULT = 0, ALL_CAN_READ = 1, or ALL_CAN_WRITE = 2. The default is to not allow cross-context access. ALL_CAN_READ means that all cross-context reads are allowed. ALL_CAN_WRITE means that all cross-context writes are allowed. The combination ALL_CAN_READ | ALL_CAN_WRITE can be used to allow all cross-context access.
attribute	The attributes of the property for which an accessor is added.
signature	The signature describes valid receivers for the accessor and is used to perform implicit instance checks against them. If the receiver is incompatible (i.e. is not an instance of the constructor as defined by FunctionTemplate::HasInstance()), an implicit TypeError is thrown and no callback is invoked.

Definition at line 1373 of file api.cc.

                                                                        {
  TemplateSetAccessor(
      this, name, getter, setter, data, settings, attribute, signature);
}

References name, and v8::TemplateSetAccessor().

Here is the call graph for this function:

SetCallAsFunctionHandler()

void v8::ObjectTemplate::SetCallAsFunctionHandler	(	FunctionCallback	callback,
		Handle< Value >	data = Handle<Value>()
	)

Sets the callback to be used when calling instances created from this template as a function.

If no callback is set, instances behave like normal JavaScript objects that cannot be called as a function.

Definition at line 1506 of file api.cc.

                                                                  {
  i::Isolate* isolate = Utils::OpenHandle(this)->GetIsolate();
  ENTER_V8(isolate);
  i::HandleScope scope(isolate);
  EnsureConstructor(isolate, this);
  i::FunctionTemplateInfo* constructor = i::FunctionTemplateInfo::cast(
      Utils::OpenHandle(this)->constructor());
  i::Handle<i::FunctionTemplateInfo> cons(constructor);
  i::Handle<i::Struct> struct_obj =
      isolate->factory()->NewStruct(i::CALL_HANDLER_INFO_TYPE);
  i::Handle<i::CallHandlerInfo> obj =
      i::Handle<i::CallHandlerInfo>::cast(struct_obj);
  SET_FIELD_WRAPPED(obj, set_callback, callback);
  if (data.IsEmpty()) {
    data = v8::Undefined(reinterpret_cast<v8::Isolate*>(isolate));
  }
  obj->set_data(*Utils::OpenHandle(*data));
  cons->set_instance_call_handler(*obj);
}

References v8::internal::CALL_HANDLER_INFO_TYPE, v8::internal::Handle< T >::cast(), v8::EnsureConstructor(), ENTER_V8, v8::internal::Isolate::factory(), v8::Handle< T >::IsEmpty(), v8::Utils::OpenHandle(), SET_FIELD_WRAPPED, and v8::Undefined().

Here is the call graph for this function:

SetIndexedPropertyHandler()

void v8::ObjectTemplate::SetIndexedPropertyHandler	(	IndexedPropertyGetterCallback	getter,
		IndexedPropertySetterCallback	setter = 0,
		IndexedPropertyQueryCallback	query = 0,
		IndexedPropertyDeleterCallback	deleter = 0,
		IndexedPropertyEnumeratorCallback	enumerator = 0,
		Handle< Value >	data = Handle<Value>()
	)

Sets an indexed property handler on the object template.

Whenever an indexed property is accessed on objects created from this object template, the provided callback is invoked instead of accessing the property directly on the JavaScript object.

Parameters

getter	The callback to invoke when getting a property.
setter	The callback to invoke when setting a property.
query	The callback to invoke to check if an object has a property.
deleter	The callback to invoke when deleting a property.
enumerator	The callback to invoke to enumerate all the indexed properties of an object.
data	A piece of data that will be passed to the callbacks whenever they are invoked.

Definition at line 1473 of file api.cc.

                        {
  i::Isolate* isolate = Utils::OpenHandle(this)->GetIsolate();
  ENTER_V8(isolate);
  i::HandleScope scope(isolate);
  EnsureConstructor(isolate, this);
  i::FunctionTemplateInfo* constructor = i::FunctionTemplateInfo::cast(
      Utils::OpenHandle(this)->constructor());
  i::Handle<i::FunctionTemplateInfo> cons(constructor);
  i::Handle<i::Struct> struct_obj =
      isolate->factory()->NewStruct(i::INTERCEPTOR_INFO_TYPE);
  i::Handle<i::InterceptorInfo> obj =
      i::Handle<i::InterceptorInfo>::cast(struct_obj);
 
  if (getter != 0) SET_FIELD_WRAPPED(obj, set_getter, getter);
  if (setter != 0) SET_FIELD_WRAPPED(obj, set_setter, setter);
  if (query != 0) SET_FIELD_WRAPPED(obj, set_query, query);
  if (remover != 0) SET_FIELD_WRAPPED(obj, set_deleter, remover);
  if (enumerator != 0) SET_FIELD_WRAPPED(obj, set_enumerator, enumerator);
 
  if (data.IsEmpty()) {
    data = v8::Undefined(reinterpret_cast<v8::Isolate*>(isolate));
  }
  obj->set_data(*Utils::OpenHandle(*data));
  cons->set_indexed_property_handler(*obj);
}

References v8::internal::Handle< T >::cast(), v8::EnsureConstructor(), ENTER_V8, v8::internal::Isolate::factory(), v8::internal::INTERCEPTOR_INFO_TYPE, v8::Handle< T >::IsEmpty(), v8::Utils::OpenHandle(), SET_FIELD_WRAPPED, and v8::Undefined().

Here is the call graph for this function:

SetInternalFieldCount()

void v8::ObjectTemplate::SetInternalFieldCount

(

int

value

)

Sets the number of internal fields for objects generated from this template.

Definition at line 1533 of file api.cc.

                                                    {
  i::Isolate* isolate = Utils::OpenHandle(this)->GetIsolate();
  if (!Utils::ApiCheck(i::Smi::IsValid(value),
                       "v8::ObjectTemplate::SetInternalFieldCount()",
                       "Invalid internal field count")) {
    return;
  }
  ENTER_V8(isolate);
  if (value > 0) {
    // The internal field count is set by the constructor function's
    // construct code, so we ensure that there is a constructor
    // function to do the setting.
    EnsureConstructor(isolate, this);
  }
  Utils::OpenHandle(this)->set_internal_field_count(i::Smi::FromInt(value));
}

References v8::Utils::ApiCheck(), v8::EnsureConstructor(), ENTER_V8, v8::internal::Smi::FromInt(), v8::internal::Smi::IsValid(), and v8::Utils::OpenHandle().

Here is the call graph for this function:

SetNamedPropertyHandler()

void v8::ObjectTemplate::SetNamedPropertyHandler	(	NamedPropertyGetterCallback	getter,
		NamedPropertySetterCallback	setter = 0,
		NamedPropertyQueryCallback	query = 0,
		NamedPropertyDeleterCallback	deleter = 0,
		NamedPropertyEnumeratorCallback	enumerator = 0,
		Handle< Value >	data = Handle<Value>()
	)

Sets a named property handler on the object template.

Whenever a property whose name is a string is accessed on objects created from this object template, the provided callback is invoked instead of accessing the property directly on the JavaScript object.

Parameters

getter	The callback to invoke when getting a property.
setter	The callback to invoke when setting a property.
query	The callback to invoke to check if a property is present, and if present, get its attributes.
deleter	The callback to invoke when deleting a property.
enumerator	The callback to invoke to enumerate all the named properties of an object.
data	A piece of data that will be passed to the callbacks whenever they are invoked.

Definition at line 1397 of file api.cc.

                        {
  i::Isolate* isolate = Utils::OpenHandle(this)->GetIsolate();
  ENTER_V8(isolate);
  i::HandleScope scope(isolate);
  EnsureConstructor(isolate, this);
  i::FunctionTemplateInfo* constructor = i::FunctionTemplateInfo::cast(
      Utils::OpenHandle(this)->constructor());
  i::Handle<i::FunctionTemplateInfo> cons(constructor);
  i::Handle<i::Struct> struct_obj =
      isolate->factory()->NewStruct(i::INTERCEPTOR_INFO_TYPE);
  i::Handle<i::InterceptorInfo> obj =
      i::Handle<i::InterceptorInfo>::cast(struct_obj);
 
  if (getter != 0) SET_FIELD_WRAPPED(obj, set_getter, getter);
  if (setter != 0) SET_FIELD_WRAPPED(obj, set_setter, setter);
  if (query != 0) SET_FIELD_WRAPPED(obj, set_query, query);
  if (remover != 0) SET_FIELD_WRAPPED(obj, set_deleter, remover);
  if (enumerator != 0) SET_FIELD_WRAPPED(obj, set_enumerator, enumerator);
 
  if (data.IsEmpty()) {
    data = v8::Undefined(reinterpret_cast<v8::Isolate*>(isolate));
  }
  obj->set_data(*Utils::OpenHandle(*data));
  cons->set_named_property_handler(*obj);
}

References v8::internal::Handle< T >::cast(), v8::EnsureConstructor(), ENTER_V8, v8::internal::Isolate::factory(), v8::internal::INTERCEPTOR_INFO_TYPE, v8::Handle< T >::IsEmpty(), v8::Utils::OpenHandle(), SET_FIELD_WRAPPED, and v8::Undefined().

Here is the call graph for this function:

Friends And Related Function Documentation

FunctionTemplate

friend class FunctionTemplate

friend

Definition at line 3884 of file v8.h.

---

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

• /mnt/V8SourceCode/include/v8.h
• /mnt/V8SourceCode/src/api.cc