Object Class Reference

#include <v8.h>

Inheritance diagram for Object:

Collaboration diagram for Object:

Public Member Functions
V8EXPORT bool	Set (Handle< Value > key, Handle< Value > value, PropertyAttribute attribs=None)
V8EXPORT bool	Set (uint32_t index, Handle< Value > value)
V8EXPORT bool	ForceSet (Handle< Value > key, Handle< Value > value, PropertyAttribute attribs=None)
V8EXPORT Local< Value >	Get (Handle< Value > key)
V8EXPORT Local< Value >	Get (uint32_t index)
V8EXPORT PropertyAttribute	GetPropertyAttributes (Handle< Value > key)
V8EXPORT bool	Has (Handle< String > key)
V8EXPORT bool	Delete (Handle< String > key)
V8EXPORT bool	ForceDelete (Handle< Value > key)
V8EXPORT bool	Has (uint32_t index)
V8EXPORT bool	Delete (uint32_t index)
V8EXPORT bool	SetAccessor (Handle< String > name, AccessorGetter getter, AccessorSetter setter=0, Handle< Value > data=Handle< Value >(), AccessControl settings=DEFAULT, PropertyAttribute attribute=None)
V8EXPORT Local< Array >	GetPropertyNames ()
V8EXPORT Local< Array >	GetOwnPropertyNames ()
V8EXPORT Local< Value >	GetPrototype ()
V8EXPORT bool	SetPrototype (Handle< Value > prototype)
V8EXPORT Local< Object >	FindInstanceInPrototypeChain (Handle< FunctionTemplate > tmpl)
V8EXPORT Local< String >	ObjectProtoToString ()
V8EXPORT Local< String >	GetConstructorName ()
V8EXPORT int	InternalFieldCount ()
Local< Value >	GetInternalField (int index)
V8EXPORT void	SetInternalField (int index, Handle< Value > value)
void *	GetPointerFromInternalField (int index)
V8EXPORT void	SetPointerInInternalField (int index, void *value)
V8EXPORT bool	HasOwnProperty (Handle< String > key)
V8EXPORT bool	HasRealNamedProperty (Handle< String > key)
V8EXPORT bool	HasRealIndexedProperty (uint32_t index)
V8EXPORT bool	HasRealNamedCallbackProperty (Handle< String > key)
V8EXPORT Local< Value >	GetRealNamedPropertyInPrototypeChain (Handle< String > key)
V8EXPORT Local< Value >	GetRealNamedProperty (Handle< String > key)
V8EXPORT bool	HasNamedLookupInterceptor ()
V8EXPORT bool	HasIndexedLookupInterceptor ()
V8EXPORT void	TurnOnAccessCheck ()
V8EXPORT int	GetIdentityHash ()
V8EXPORT bool	SetHiddenValue (Handle< String > key, Handle< Value > value)
V8EXPORT Local< Value >	GetHiddenValue (Handle< String > key)
V8EXPORT bool	DeleteHiddenValue (Handle< String > key)
V8EXPORT bool	IsDirty ()
V8EXPORT Local< Object >	Clone ()
V8EXPORT Local< Context >	CreationContext ()
V8EXPORT void	SetIndexedPropertiesToPixelData (uint8_t *data, int length)
V8EXPORT bool	HasIndexedPropertiesInPixelData ()
V8EXPORT uint8_t *	GetIndexedPropertiesPixelData ()
V8EXPORT int	GetIndexedPropertiesPixelDataLength ()
V8EXPORT void	SetIndexedPropertiesToExternalArrayData (void *data, ExternalArrayType array_type, int number_of_elements)
V8EXPORT bool	HasIndexedPropertiesInExternalArrayData ()
V8EXPORT void *	GetIndexedPropertiesExternalArrayData ()
V8EXPORT ExternalArrayType	GetIndexedPropertiesExternalArrayDataType ()
V8EXPORT int	GetIndexedPropertiesExternalArrayDataLength ()
V8EXPORT bool	IsCallable ()
V8EXPORT Local< Value >	CallAsFunction (Handle< Object > recv, int argc, Handle< Value > argv[])
V8EXPORT Local< Value >	CallAsConstructor (int argc, Handle< Value > argv[])
Public Member Functions inherited from Value
bool	IsUndefined () const
bool	IsNull () const
V8EXPORT bool	IsTrue () const
V8EXPORT bool	IsFalse () const
bool	IsString () const
V8EXPORT bool	IsFunction () const
V8EXPORT bool	IsArray () const
V8EXPORT bool	IsObject () const
V8EXPORT bool	IsBoolean () const
V8EXPORT bool	IsNumber () const
V8EXPORT bool	IsExternal () const
V8EXPORT bool	IsInt32 () const
V8EXPORT bool	IsUint32 () const
V8EXPORT bool	IsDate () const
V8EXPORT bool	IsBooleanObject () const
V8EXPORT bool	IsNumberObject () const
V8EXPORT bool	IsStringObject () const
V8EXPORT bool	IsNativeError () const
V8EXPORT bool	IsRegExp () const
V8EXPORT Local< Boolean >	ToBoolean () const
V8EXPORT Local< Number >	ToNumber () const
V8EXPORT Local< String >	ToString () const
V8EXPORT Local< String >	ToDetailString () const
V8EXPORT Local< Object >	ToObject () const
V8EXPORT Local< Integer >	ToInteger () const
V8EXPORT Local< Uint32 >	ToUint32 () const
V8EXPORT Local< Int32 >	ToInt32 () const
V8EXPORT Local< Uint32 >	ToArrayIndex () const
V8EXPORT bool	BooleanValue () const
V8EXPORT double	NumberValue () const
V8EXPORT int64_t	IntegerValue () const
V8EXPORT uint32_t	Uint32Value () const
V8EXPORT int32_t	Int32Value () const
V8EXPORT bool	Equals (Handle< Value > that) const
V8EXPORT bool	StrictEquals (Handle< Value > that) const

Static Public Member Functions
static V8EXPORT Local< Object >	New ()
static Object *	Cast (Value *obj)

Detailed Description

A JavaScript object (ECMA-262, 4.3.3)

Definition at line 1457 of file v8.h.

Member Function Documentation

CallAsConstructor()

V8EXPORT Local<Value> CallAsConstructor	(	int	argc,
		Handle< Value >	argv[]
	)

Call an Object as a constructor if a callback is set by the ObjectTemplate::SetCallAsFunctionHandler method. Note: This method behaves like the Function::NewInstance method.

CallAsFunction()

V8EXPORT Local<Value> CallAsFunction	(	Handle< Object >	recv,
		int	argc,
		Handle< Value >	argv[]
	)

Call an Object as a function if a callback is set by the ObjectTemplate::SetCallAsFunctionHandler method.

Cast()

Object * Cast ( v8::Value *  value )

inlinestatic

Definition at line 4386 of file v8.h.

Clone()

V8EXPORT Local<Object> Clone

(

)

Clone this object with a fast but shallow copy. Values will point to the same values as the original object.

CreationContext()

V8EXPORT Local<Context> CreationContext

(

)

Returns the context in which the object was created.

Delete() [1/2]

V8EXPORT bool Delete

(

Handle< String >

key

)

Delete() [2/2]

V8EXPORT bool Delete

(

uint32_t

index

)

DeleteHiddenValue()

V8EXPORT bool DeleteHiddenValue

(

Handle< String >

key

)

FindInstanceInPrototypeChain()

V8EXPORT Local<Object> FindInstanceInPrototypeChain

(

Handle< FunctionTemplate >

tmpl

)

Finds an instance of the given function template in the prototype chain.

ForceDelete()

V8EXPORT bool ForceDelete

(

Handle< Value >

key

)

ForceSet()

V8EXPORT bool ForceSet	(	Handle< Value >	key,
		Handle< Value >	value,
		PropertyAttribute	attribs = None
	)

Get() [1/2]

V8EXPORT Local<Value> Get

(

Handle< Value >

key

)

Get() [2/2]

V8EXPORT Local<Value> Get

(

uint32_t

index

)

GetConstructorName()

V8EXPORT Local<String> GetConstructorName

(

)

Returns the name of the function invoked as a constructor for this object.

GetHiddenValue()

V8EXPORT Local<Value> GetHiddenValue

(

Handle< String >

key

)

GetIdentityHash()

V8EXPORT int GetIdentityHash

(

)

Returns the identity hash for this object. The current implementation uses a hidden property on the object to store the identity hash.

The return value will never be 0. Also, it is not guaranteed to be unique.

GetIndexedPropertiesExternalArrayData()

V8EXPORT void* GetIndexedPropertiesExternalArrayData

(

)

GetIndexedPropertiesExternalArrayDataLength()

V8EXPORT int GetIndexedPropertiesExternalArrayDataLength

(

)

GetIndexedPropertiesExternalArrayDataType()

V8EXPORT ExternalArrayType GetIndexedPropertiesExternalArrayDataType

(

)

GetIndexedPropertiesPixelData()

V8EXPORT uint8_t* GetIndexedPropertiesPixelData

(

)

GetIndexedPropertiesPixelDataLength()

V8EXPORT int GetIndexedPropertiesPixelDataLength

(

)

GetInternalField()

Local< Value > GetInternalField ( int  index )

inline

Gets the value in an internal field.

Definition at line 4180 of file v8.h.

References Handle< T >::IsEmpty(), and V8::Local.

GetOwnPropertyNames()

V8EXPORT Local<Array> GetOwnPropertyNames

(

)

This function has the same functionality as GetPropertyNames but the returned array doesn't contain the names of properties from prototype objects.

GetPointerFromInternalField()

void * GetPointerFromInternalField ( int  index )

inline

Gets a native pointer from an internal field.

Definition at line 4223 of file v8.h.

References Internals::GetExternalPointer(), Internals::GetInstanceType(), v8::internal::kApiPointerSize, Internals::kJSObjectHeaderSize, Internals::kJSObjectType, and Internals::ReadField().

GetPropertyAttributes()

V8EXPORT PropertyAttribute GetPropertyAttributes

(

Handle< Value >

key

)

Gets the property attributes of a property which can be None or any combination of ReadOnly, DontEnum and DontDelete. Returns None when the property doesn't exist.

GetPropertyNames()

V8EXPORT Local<Array> GetPropertyNames

(

)

Returns an array containing the names of the enumerable properties of this object, including properties from prototype objects. The array returned by this method contains the same values as would be enumerated by a for-in statement over this object.

GetPrototype()

V8EXPORT Local<Value> GetPrototype

(

)

Get the prototype object. This does not skip objects marked to be skipped by proto and it does not consult the security handler.

GetRealNamedProperty()

V8EXPORT Local<Value> GetRealNamedProperty

(

Handle< String >

key

)

If result.IsEmpty() no real property was located on the object or in the prototype chain. This means interceptors in the prototype chain are not called.

GetRealNamedPropertyInPrototypeChain()

V8EXPORT Local<Value> GetRealNamedPropertyInPrototypeChain

(

Handle< String >

key

)

If result.IsEmpty() no real property was located in the prototype chain. This means interceptors in the prototype chain are not called.

Has() [1/2]

V8EXPORT bool Has

(

Handle< String >

key

)

Has() [2/2]

V8EXPORT bool Has

(

uint32_t

index

)

HasIndexedLookupInterceptor()

V8EXPORT bool HasIndexedLookupInterceptor

(

)

Tests for an index lookup interceptor.

HasIndexedPropertiesInExternalArrayData()

V8EXPORT bool HasIndexedPropertiesInExternalArrayData

(

)

HasIndexedPropertiesInPixelData()

V8EXPORT bool HasIndexedPropertiesInPixelData

(

)

HasNamedLookupInterceptor()

V8EXPORT bool HasNamedLookupInterceptor

(

)

Tests for a named lookup interceptor.

HasOwnProperty()

V8EXPORT bool HasOwnProperty

(

Handle< String >

key

)

HasRealIndexedProperty()

V8EXPORT bool HasRealIndexedProperty

(

uint32_t

index

)

HasRealNamedCallbackProperty()

V8EXPORT bool HasRealNamedCallbackProperty

(

Handle< String >

key

)

HasRealNamedProperty()

V8EXPORT bool HasRealNamedProperty

(

Handle< String >

key

)

InternalFieldCount()

V8EXPORT int InternalFieldCount

(

)

Gets the number of internal fields for this Object.

IsCallable()

V8EXPORT bool IsCallable

(

)

Checks whether a callback is set by the ObjectTemplate::SetCallAsFunctionHandler method. When an Object is callable this method returns true.

IsDirty()

V8EXPORT bool IsDirty

(

)

Returns true if this is an instance of an api function (one created from a function created from a function template) and has been modified since it was created. Note that this method is conservative and may return true for objects that haven't actually been modified.

New()

static V8EXPORT Local<Object> New ( )

static

ObjectProtoToString()

V8EXPORT Local<String> ObjectProtoToString

(

)

Call builtin Object.prototype.toString on this object. This is different from Value::ToString() that may call user-defined toString function. This one does not.

Set() [1/2]

V8EXPORT bool Set	(	Handle< Value >	key,
		Handle< Value >	value,
		PropertyAttribute	attribs = None
	)

Set() [2/2]

V8EXPORT bool Set	(	uint32_t	index,
		Handle< Value >	value
	)

SetAccessor()

V8EXPORT bool SetAccessor	(	Handle< String >	name,
		AccessorGetter	getter,
		AccessorSetter	setter = 0,
		Handle< Value >	data = Handle< Value >(),
		AccessControl	settings = DEFAULT,
		PropertyAttribute	attribute = None
	)

SetHiddenValue()

V8EXPORT bool SetHiddenValue	(	Handle< String >	key,
		Handle< Value >	value
	)

Access hidden properties on JavaScript objects. These properties are hidden from the executing JavaScript and only accessible through the V8 C++ API. Hidden properties introduced by V8 internally (for example the identity hash) are prefixed with "v8::".

SetIndexedPropertiesToExternalArrayData()

V8EXPORT void SetIndexedPropertiesToExternalArrayData	(	void *	data,
		ExternalArrayType	array_type,
		int	number_of_elements
	)

Set the backing store of the indexed properties to be managed by the embedding layer. Access to the indexed properties will follow the rules spelled out for the CanvasArray subtypes in the WebGL specification. Note: The embedding program still owns the data and needs to ensure that the backing store is preserved while V8 has a reference.

SetIndexedPropertiesToPixelData()

V8EXPORT void SetIndexedPropertiesToPixelData	(	uint8_t *	data,
		int	length
	)

Set the backing store of the indexed properties to be managed by the embedding layer. Access to the indexed properties will follow the rules spelled out in CanvasPixelArray. Note: The embedding program still owns the data and needs to ensure that the backing store is preserved while V8 has a reference.

SetInternalField()

V8EXPORT void SetInternalField	(	int	index,
		Handle< Value >	value
	)

Sets the value in an internal field.

SetPointerInInternalField()

V8EXPORT void SetPointerInInternalField	(	int	index,
		void *	value
	)

Sets a native pointer in an internal field.

SetPrototype()

V8EXPORT bool SetPrototype

(

Handle< Value >

prototype

)

Set the prototype object. This does not skip objects marked to be skipped by proto and it does not consult the security handler.

TurnOnAccessCheck()

V8EXPORT void TurnOnAccessCheck

(

)

Turns on access check on the object if the object is an instance of a template that has access check callbacks. If an object has no access check info, the object cannot be accessed by anyone.

---

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

• include/v8.h