com.oracle.truffle.js.runtime.builtins

Class JSClass

java.lang.Object

com.oracle.truffle.js.runtime.builtins.JSClass

Direct Known Subclasses:

AbstractJSClass, JSNonProxy

public abstract class JSClass
extends Object

Basic interface for all JavaScript (ordinary and exotic) object types. A JSClass defines the internal and access methods of a JSObject and allows for overriding their behavior for different types of objects. It can be obtained from an object via Shape.getDynamicType(). The interface is inspired by ECMAScript internal methods. Parameter order: JSDynamicObject receiver[, the rest...].

Property Summary

Type	Property and Description
abstract boolean	usesOrdinaryGetOwn

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JSClass()

Method Summary

Modifier and Type	Method and Description
com.oracle.truffle.api.strings.TruffleString	defaultToString(JSDynamicObject object) Follows 19.1.3.6 Object.prototype.toString(), basically: "[object " + [[Symbol.toStringTag]] + "]" or typically "[object Object]" (for non built-in types) if [[Symbol.toStringTag]] is not present.
abstract boolean	defineOwnProperty(JSDynamicObject thisObj, Object key, PropertyDescriptor value, boolean doThrow) 9.1.6 [[DefineOwnProperty]] (P, Desc).
abstract boolean	delete(JSDynamicObject thisObj, long index, boolean isStrict)
abstract boolean	delete(JSDynamicObject thisObj, Object key, boolean isStrict) 9.1.10 [[Delete]] (P).
static List<Object>	filterOwnPropertyKeys(List<Object> ownPropertyKeys, boolean strings, boolean symbols)
protected com.oracle.truffle.api.strings.TruffleString	formatToString(com.oracle.truffle.api.strings.TruffleString object) Formats JSClass.defaultToString(JSDynamicObject), by default returns "[object ...]".
Object	get(JSDynamicObject thisObj, long index)
Object	get(JSDynamicObject thisObj, Object key) 9.1.8 [[Get]] (P, Receiver).
com.oracle.truffle.api.strings.TruffleString	getBuiltinToStringTag(JSDynamicObject object) Returns builtinTag from step 14 of ES6+ 19.1.3.6.
abstract com.oracle.truffle.api.strings.TruffleString	getClassName(JSDynamicObject object) The [[Class]] internal property.
abstract Object	getHelper(JSDynamicObject store, Object thisObj, long index, com.oracle.truffle.api.nodes.Node encapsulatingNode)
abstract Object	getHelper(JSDynamicObject store, Object thisObj, Object key, com.oracle.truffle.api.nodes.Node encapsulatingNode)
JSDynamicObject	getIntrinsicDefaultProto(JSRealm realm) Allows invokevirtual of this method instead of invokeinterface.
abstract Object	getMethodHelper(JSDynamicObject store, Object thisObj, Object key, com.oracle.truffle.api.nodes.Node encapsulatingNode)
abstract Object	getOwnHelper(JSDynamicObject store, Object thisObj, long index, com.oracle.truffle.api.nodes.Node encapsulatingNode)
abstract Object	getOwnHelper(JSDynamicObject store, Object thisObj, Object key, com.oracle.truffle.api.nodes.Node encapsulatingNode)
abstract PropertyDescriptor	getOwnProperty(JSDynamicObject thisObj, Object key) 9.1.5 [[GetOwnProperty]] (P).
abstract List<Object>	getOwnPropertyKeys(JSDynamicObject obj, boolean strings, boolean symbols) GetOwnPropertyKeys (O, type).
abstract JSDynamicObject	getPrototypeOf(JSDynamicObject thisObj) 9.1.1 [[GetPrototypeOf]] ().
protected com.oracle.truffle.api.strings.TruffleString	getToStringTag(JSDynamicObject object)
abstract boolean	hasOnlyShapeProperties(JSDynamicObject obj) If true, JSClass.ownPropertyKeys(com.oracle.truffle.js.runtime.objects.JSDynamicObject) and JSShape.getProperties(com.oracle.truffle.api.object.Shape) enumerate the same keys.
abstract boolean	hasOwnProperty(JSDynamicObject thisObj, long index)
abstract boolean	hasOwnProperty(JSDynamicObject thisObj, Object key)
abstract boolean	hasProperty(JSDynamicObject thisObj, long index)
abstract boolean	hasProperty(JSDynamicObject thisObj, Object key) 9.1.7 [[HasProperty]] (P).
abstract boolean	isExtensible(JSDynamicObject thisObj) 9.1.3 [[IsExtensible]] ().
boolean	isInstance(JSDynamicObject object)
static boolean	isInstance(JSDynamicObject object, JSClass jsclass)
boolean	isInstance(Object object)
static boolean	isInstance(Object object, JSClass jsclass)
com.oracle.truffle.api.object.Shape	makeInitialShape(JSContext context, JSDynamicObject prototype)
List<Object>	ownPropertyKeys(JSDynamicObject obj) 9.1.12 [[OwnPropertyKeys]]().
abstract boolean	preventExtensions(JSDynamicObject thisObj, boolean doThrow) 9.1.4 [[PreventExtensions]] ().
abstract boolean	set(JSDynamicObject thisObj, long index, Object value, Object receiver, boolean isStrict, com.oracle.truffle.api.nodes.Node encapsulatingNode)
abstract boolean	set(JSDynamicObject thisObj, Object key, Object value, Object receiver, boolean isStrict, com.oracle.truffle.api.nodes.Node encapsulatingNode) 9.1.9 [[Set]] (P, V, Receiver).
boolean	setIntegrityLevel(JSDynamicObject obj, boolean freeze, boolean doThrow) ES2015 7.3.14 SetIntegrityLevel(O, level).
abstract boolean	setPrototypeOf(JSDynamicObject thisObj, JSDynamicObject newPrototype) 9.1.2 [[SetPrototypeOf]] (V).
boolean	testIntegrityLevel(JSDynamicObject obj, boolean frozen) ES2015 7.3.15 TestIntegrityLevel(O, level).
protected boolean	testIntegrityLevelDefault(JSDynamicObject obj, boolean frozen)
abstract com.oracle.truffle.api.strings.TruffleString	toDisplayStringImpl(JSDynamicObject object, boolean allowSideEffects, ToDisplayStringFormat format, int depth) A more informative toString variant, mainly used for error messages.
abstract String	toString()
abstract boolean	usesOrdinaryGetOwnProperty()
abstract boolean	usesOrdinaryIsExtensible()

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Detail

usesOrdinaryGetOwn

public abstract boolean usesOrdinaryGetOwnProperty

Constructor Detail

JSClass

protected JSClass()

Method Detail

getPrototypeOf

public abstract JSDynamicObject getPrototypeOf(JSDynamicObject thisObj)

9.1.1 [[GetPrototypeOf]] ().

setPrototypeOf

public abstract boolean setPrototypeOf(JSDynamicObject thisObj,
                                       JSDynamicObject newPrototype)

9.1.2 [[SetPrototypeOf]] (V).

isExtensible

public abstract boolean isExtensible(JSDynamicObject thisObj)

9.1.3 [[IsExtensible]] ().

preventExtensions

public abstract boolean preventExtensions(JSDynamicObject thisObj,
                                          boolean doThrow)

9.1.4 [[PreventExtensions]] ().

getOwnProperty

public abstract PropertyDescriptor getOwnProperty(JSDynamicObject thisObj,
                                                  Object key)

9.1.5 [[GetOwnProperty]] (P).

defineOwnProperty

public abstract boolean defineOwnProperty(JSDynamicObject thisObj,
                                          Object key,
                                          PropertyDescriptor value,
                                          boolean doThrow)

9.1.6 [[DefineOwnProperty]] (P, Desc).

hasProperty

public abstract boolean hasProperty(JSDynamicObject thisObj,
                                    Object key)

9.1.7 [[HasProperty]] (P).

hasProperty

public abstract boolean hasProperty(JSDynamicObject thisObj,
                                    long index)

hasOwnProperty

public abstract boolean hasOwnProperty(JSDynamicObject thisObj,
                                       Object key)

hasOwnProperty

public abstract boolean hasOwnProperty(JSDynamicObject thisObj,
                                       long index)

get

public final Object get(JSDynamicObject thisObj,
                        Object key)

9.1.8 [[Get]] (P, Receiver).

get

public Object get(JSDynamicObject thisObj,
                  long index)

getHelper

public abstract Object getHelper(JSDynamicObject store,
                                 Object thisObj,
                                 Object key,
                                 com.oracle.truffle.api.nodes.Node encapsulatingNode)

getHelper

public abstract Object getHelper(JSDynamicObject store,
                                 Object thisObj,
                                 long index,
                                 com.oracle.truffle.api.nodes.Node encapsulatingNode)

getOwnHelper

public abstract Object getOwnHelper(JSDynamicObject store,
                                    Object thisObj,
                                    Object key,
                                    com.oracle.truffle.api.nodes.Node encapsulatingNode)

getOwnHelper

public abstract Object getOwnHelper(JSDynamicObject store,
                                    Object thisObj,
                                    long index,
                                    com.oracle.truffle.api.nodes.Node encapsulatingNode)

getMethodHelper

public abstract Object getMethodHelper(JSDynamicObject store,
                                       Object thisObj,
                                       Object key,
                                       com.oracle.truffle.api.nodes.Node encapsulatingNode)

set

public abstract boolean set(JSDynamicObject thisObj,
                            Object key,
                            Object value,
                            Object receiver,
                            boolean isStrict,
                            com.oracle.truffle.api.nodes.Node encapsulatingNode)

9.1.9 [[Set]] (P, V, Receiver).

set

public abstract boolean set(JSDynamicObject thisObj,
                            long index,
                            Object value,
                            Object receiver,
                            boolean isStrict,
                            com.oracle.truffle.api.nodes.Node encapsulatingNode)

delete

public abstract boolean delete(JSDynamicObject thisObj,
                               Object key,
                               boolean isStrict)

9.1.10 [[Delete]] (P).

delete

public abstract boolean delete(JSDynamicObject thisObj,
                               long index,
                               boolean isStrict)

ownPropertyKeys

public final List<Object> ownPropertyKeys(JSDynamicObject obj)

9.1.12 [[OwnPropertyKeys]](). Provides all own properties of this object with a String or Symbol key. Represents the [[OwnPropertyKeys]] internal method.

Returns:

a List of the keys of all own properties of that object

getOwnPropertyKeys

public abstract List<Object> getOwnPropertyKeys(JSDynamicObject obj,
                                                boolean strings,
                                                boolean symbols)

GetOwnPropertyKeys (O, type).

Returns:

a List of the keys of all own properties of that object with the specified types

filterOwnPropertyKeys

public static List<Object> filterOwnPropertyKeys(List<Object> ownPropertyKeys,
                                                 boolean strings,
                                                 boolean symbols)

hasOnlyShapeProperties

public abstract boolean hasOnlyShapeProperties(JSDynamicObject obj)

If true, JSClass.ownPropertyKeys(com.oracle.truffle.js.runtime.objects.JSDynamicObject) and JSShape.getProperties(com.oracle.truffle.api.object.Shape) enumerate the same keys.

getClassName

public abstract com.oracle.truffle.api.strings.TruffleString getClassName(JSDynamicObject object)

The [[Class]] internal property. For ES5, this is the second part of what Object.prototype.toString.call(myObj) returns, e.g. "[object Array]".

Parameters:

object - object to be used

toString

public abstract String toString()

Overrides:

toString in class Object

defaultToString

public com.oracle.truffle.api.strings.TruffleString defaultToString(JSDynamicObject object)

Follows 19.1.3.6 Object.prototype.toString(), basically: "[object " + [[Symbol.toStringTag]] + "]" or typically "[object Object]" (for non built-in types) if [[Symbol.toStringTag]] is not present.

For ES5, if follows 15.2.4.2 Object.prototype.toString(), basically: "[object " + [[Class]] + "]".

See Also:

JSClass.getBuiltinToStringTag(JSDynamicObject)

getToStringTag

protected com.oracle.truffle.api.strings.TruffleString getToStringTag(JSDynamicObject object)

getBuiltinToStringTag

public com.oracle.truffle.api.strings.TruffleString getBuiltinToStringTag(JSDynamicObject object)

Returns builtinTag from step 14 of ES6+ 19.1.3.6. By default returns "Object".

Parameters:

object - object to be used

Returns:

"Object" by default

See Also:

JSClass.defaultToString(JSDynamicObject)

formatToString

protected com.oracle.truffle.api.strings.TruffleString formatToString(com.oracle.truffle.api.strings.TruffleString object)

Formats JSClass.defaultToString(JSDynamicObject), by default returns "[object ...]".

Parameters:

object - object to be used

Returns:

"[object ...]" by default

toDisplayStringImpl

public abstract com.oracle.truffle.api.strings.TruffleString toDisplayStringImpl(JSDynamicObject object,
                                                                                 boolean allowSideEffects,
                                                                                 ToDisplayStringFormat format,
                                                                                 int depth)

A more informative toString variant, mainly used for error messages.

Parameters:

format - formatting parameters

depth - current nesting depth

isInstance

public final boolean isInstance(JSDynamicObject object)

isInstance

public final boolean isInstance(Object object)

isInstance

public static boolean isInstance(Object object,
                                 JSClass jsclass)

isInstance

public static boolean isInstance(JSDynamicObject object,
                                 JSClass jsclass)

testIntegrityLevel

public boolean testIntegrityLevel(JSDynamicObject obj,
                                  boolean frozen)

ES2015 7.3.15 TestIntegrityLevel(O, level).

testIntegrityLevelDefault

protected final boolean testIntegrityLevelDefault(JSDynamicObject obj,
                                                  boolean frozen)

setIntegrityLevel

public boolean setIntegrityLevel(JSDynamicObject obj,
                                 boolean freeze,
                                 boolean doThrow)

ES2015 7.3.14 SetIntegrityLevel(O, level).

makeInitialShape

public com.oracle.truffle.api.object.Shape makeInitialShape(JSContext context,
                                                            JSDynamicObject prototype)

getIntrinsicDefaultProto

public JSDynamicObject getIntrinsicDefaultProto(JSRealm realm)

Allows invokevirtual of this method instead of invokeinterface. Classes overriding this method should implement PrototypeSupplier.

See Also:

PrototypeSupplier.getIntrinsicDefaultProto(com.oracle.truffle.js.runtime.JSRealm)

usesOrdinaryGetOwnProperty

public abstract boolean usesOrdinaryGetOwnProperty()

usesOrdinaryIsExtensible

public abstract boolean usesOrdinaryIsExtensible()