com.oracle.truffle.js.runtime.builtins

Class JSClass

java.lang.Object

com.oracle.truffle.api.object.ObjectType

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

Direct Known Subclasses:

AbstractJSClass, JSNonProxy

public abstract class JSClass
extends com.oracle.truffle.api.object.ObjectType

Basic interface for all JavaScript "classes". A JSClass defines the internal and access methods of a JSObject and allows for overriding their behavior for different types of objects. See also ECMA 8.6.2 "Object Internal Properties and Methods" for a list of internal properties and methods.

 Implementation notes:
 - keep parameter order consistent: JSObject receiver[, the rest...].
 - keep interface clean, avoid redundant methods, maximize consistency with JSObject and ECMAScript
 

Property Summary

Type	Property and Description
abstract boolean	usesOrdinaryGetOwn

Field Summary

Fields

Modifier and Type	Field and Description
protected static String[]	EMPTY_STRING_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JSClass()

Method Summary

Modifier and Type	Method and Description
String	defaultToString(com.oracle.truffle.api.object.DynamicObject 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(com.oracle.truffle.api.object.DynamicObject thisObj, Object key, PropertyDescriptor value, boolean doThrow) 9.1.6 [[DefineOwnProperty]] (P, Desc).
abstract boolean	delete(com.oracle.truffle.api.object.DynamicObject thisObj, long index, boolean isStrict)
abstract boolean	delete(com.oracle.truffle.api.object.DynamicObject thisObj, Object key, boolean isStrict) 9.1.10 [[Delete]] (P).
static List<Object>	filterOwnPropertyKeys(List<Object> ownPropertyKeys, boolean strings, boolean symbols)
protected String	formatToString(String object) Formats JSClass.defaultToString(DynamicObject), by default returns "[object ...]".
Object	get(com.oracle.truffle.api.object.DynamicObject thisObj, long index)
Object	get(com.oracle.truffle.api.object.DynamicObject thisObj, Object key) 9.1.8 [[Get]] (P, Receiver).
String	getBuiltinToStringTag(com.oracle.truffle.api.object.DynamicObject object) Returns builtinTag from step 14 of ES6+ 19.1.3.6.
abstract String	getClassName(com.oracle.truffle.api.object.DynamicObject object) The [[Class]] internal property.
abstract Object	getHelper(com.oracle.truffle.api.object.DynamicObject store, Object thisObj, long index, com.oracle.truffle.api.nodes.Node encapsulatingNode)
abstract Object	getHelper(com.oracle.truffle.api.object.DynamicObject store, Object thisObj, Object key, com.oracle.truffle.api.nodes.Node encapsulatingNode)
abstract Object	getMethodHelper(com.oracle.truffle.api.object.DynamicObject store, Object thisObj, Object key, com.oracle.truffle.api.nodes.Node encapsulatingNode)
abstract Object	getOwnHelper(com.oracle.truffle.api.object.DynamicObject store, Object thisObj, long index, com.oracle.truffle.api.nodes.Node encapsulatingNode)
abstract Object	getOwnHelper(com.oracle.truffle.api.object.DynamicObject store, Object thisObj, Object key, com.oracle.truffle.api.nodes.Node encapsulatingNode)
abstract PropertyDescriptor	getOwnProperty(com.oracle.truffle.api.object.DynamicObject thisObj, Object key) 9.1.5 [[GetOwnProperty]] (P).
abstract List<Object>	getOwnPropertyKeys(com.oracle.truffle.api.object.DynamicObject obj, boolean strings, boolean symbols) GetOwnPropertyKeys (O, type).
abstract com.oracle.truffle.api.object.DynamicObject	getPrototypeOf(com.oracle.truffle.api.object.DynamicObject thisObj) 9.1.1 [[GetPrototypeOf]] ().
protected String	getToStringTag(com.oracle.truffle.api.object.DynamicObject object)
abstract boolean	hasOnlyShapeProperties(com.oracle.truffle.api.object.DynamicObject obj) If true, JSClass.ownPropertyKeys(com.oracle.truffle.api.object.DynamicObject) and JSShape.getProperties(com.oracle.truffle.api.object.Shape) enumerate the same keys.
abstract boolean	hasOwnProperty(com.oracle.truffle.api.object.DynamicObject thisObj, long index)
abstract boolean	hasOwnProperty(com.oracle.truffle.api.object.DynamicObject thisObj, Object key)
abstract boolean	hasProperty(com.oracle.truffle.api.object.DynamicObject thisObj, long index)
abstract boolean	hasProperty(com.oracle.truffle.api.object.DynamicObject thisObj, Object key) 9.1.7 [[HasProperty]] (P).
abstract boolean	isExtensible(com.oracle.truffle.api.object.DynamicObject thisObj) 9.1.3 [[IsExtensible]] ().
boolean	isInstance(com.oracle.truffle.api.object.DynamicObject object)
static boolean	isInstance(com.oracle.truffle.api.object.DynamicObject object, JSClass jsclass)
boolean	isInstance(Object object)
static boolean	isInstance(Object object, JSClass jsclass)
com.oracle.truffle.api.object.Shape	makeInitialShape(JSContext context, com.oracle.truffle.api.object.DynamicObject prototype)
List<Object>	ownPropertyKeys(com.oracle.truffle.api.object.DynamicObject obj) 9.1.12 [[OwnPropertyKeys]]().
abstract boolean	preventExtensions(com.oracle.truffle.api.object.DynamicObject thisObj, boolean doThrow) 9.1.4 [[PreventExtensions]] ().
abstract boolean	set(com.oracle.truffle.api.object.DynamicObject thisObj, long index, Object value, Object receiver, boolean isStrict, com.oracle.truffle.api.nodes.Node encapsulatingNode)
abstract boolean	set(com.oracle.truffle.api.object.DynamicObject 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(com.oracle.truffle.api.object.DynamicObject obj, boolean freeze, boolean doThrow) ES2015 7.3.14 SetIntegrityLevel(O, level).
abstract boolean	setPrototypeOf(com.oracle.truffle.api.object.DynamicObject thisObj, com.oracle.truffle.api.object.DynamicObject newPrototype) 9.1.2 [[SetPrototypeOf]] (V).
boolean	testIntegrityLevel(com.oracle.truffle.api.object.DynamicObject obj, boolean frozen) ES2015 7.3.15 TestIntegrityLevel(O, level).
protected boolean	testIntegrityLevelDefault(com.oracle.truffle.api.object.DynamicObject obj, boolean frozen)
abstract String	toDisplayStringImpl(com.oracle.truffle.api.object.DynamicObject object, int depth, boolean allowSideEffects, JSContext context) A more informative toString variant, mainly used for error messages.
abstract String	toString()
abstract boolean	usesOrdinaryGetOwnProperty()
abstract boolean	usesOrdinaryIsExtensible()

Methods inherited from class com.oracle.truffle.api.object.ObjectType

dispatch, equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Property Detail

usesOrdinaryGetOwn

public abstract boolean usesOrdinaryGetOwnProperty

Field Detail

EMPTY_STRING_ARRAY

protected static final String[] EMPTY_STRING_ARRAY

Constructor Detail

JSClass

protected JSClass()

Method Detail

getPrototypeOf

public abstract com.oracle.truffle.api.object.DynamicObject getPrototypeOf(com.oracle.truffle.api.object.DynamicObject thisObj)

9.1.1 [[GetPrototypeOf]] ().

setPrototypeOf

public abstract boolean setPrototypeOf(com.oracle.truffle.api.object.DynamicObject thisObj,
                                       com.oracle.truffle.api.object.DynamicObject newPrototype)

9.1.2 [[SetPrototypeOf]] (V).

isExtensible

public abstract boolean isExtensible(com.oracle.truffle.api.object.DynamicObject thisObj)

9.1.3 [[IsExtensible]] ().

preventExtensions

public abstract boolean preventExtensions(com.oracle.truffle.api.object.DynamicObject thisObj,
                                          boolean doThrow)

9.1.4 [[PreventExtensions]] ().

getOwnProperty

public abstract PropertyDescriptor getOwnProperty(com.oracle.truffle.api.object.DynamicObject thisObj,
                                                  Object key)

9.1.5 [[GetOwnProperty]] (P).

defineOwnProperty

public abstract boolean defineOwnProperty(com.oracle.truffle.api.object.DynamicObject thisObj,
                                          Object key,
                                          PropertyDescriptor value,
                                          boolean doThrow)

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

hasProperty

public abstract boolean hasProperty(com.oracle.truffle.api.object.DynamicObject thisObj,
                                    Object key)

9.1.7 [[HasProperty]] (P).

hasProperty

public abstract boolean hasProperty(com.oracle.truffle.api.object.DynamicObject thisObj,
                                    long index)

hasOwnProperty

public abstract boolean hasOwnProperty(com.oracle.truffle.api.object.DynamicObject thisObj,
                                       Object key)

hasOwnProperty

public abstract boolean hasOwnProperty(com.oracle.truffle.api.object.DynamicObject thisObj,
                                       long index)

get

public final Object get(com.oracle.truffle.api.object.DynamicObject thisObj,
                        Object key)

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

get

public Object get(com.oracle.truffle.api.object.DynamicObject thisObj,
                  long index)

getHelper

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

getHelper

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

getOwnHelper

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

getOwnHelper

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

getMethodHelper

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

set

public abstract boolean set(com.oracle.truffle.api.object.DynamicObject 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(com.oracle.truffle.api.object.DynamicObject thisObj,
                            long index,
                            Object value,
                            Object receiver,
                            boolean isStrict,
                            com.oracle.truffle.api.nodes.Node encapsulatingNode)

delete

public abstract boolean delete(com.oracle.truffle.api.object.DynamicObject thisObj,
                               Object key,
                               boolean isStrict)

9.1.10 [[Delete]] (P).

delete

public abstract boolean delete(com.oracle.truffle.api.object.DynamicObject thisObj,
                               long index,
                               boolean isStrict)

ownPropertyKeys

public final List<Object> ownPropertyKeys(com.oracle.truffle.api.object.DynamicObject 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(com.oracle.truffle.api.object.DynamicObject 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(com.oracle.truffle.api.object.DynamicObject obj)

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

getClassName

public abstract String getClassName(com.oracle.truffle.api.object.DynamicObject 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 String defaultToString(com.oracle.truffle.api.object.DynamicObject 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(DynamicObject)

getToStringTag

protected String getToStringTag(com.oracle.truffle.api.object.DynamicObject object)

getBuiltinToStringTag

public String getBuiltinToStringTag(com.oracle.truffle.api.object.DynamicObject 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(DynamicObject)

formatToString

protected String formatToString(String object)

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

Parameters:

object - object to be used

Returns:

"[object ...]" by default

toDisplayStringImpl

public abstract String toDisplayStringImpl(com.oracle.truffle.api.object.DynamicObject object,
                                           int depth,
                                           boolean allowSideEffects,
                                           JSContext context)

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

Parameters:

depth - allowed nesting depth

context - the current language context

isInstance

public final boolean isInstance(com.oracle.truffle.api.object.DynamicObject object)

isInstance

public final boolean isInstance(Object object)

isInstance

public static boolean isInstance(Object object,
                                 JSClass jsclass)

isInstance

public static boolean isInstance(com.oracle.truffle.api.object.DynamicObject object,
                                 JSClass jsclass)

testIntegrityLevel

public boolean testIntegrityLevel(com.oracle.truffle.api.object.DynamicObject obj,
                                  boolean frozen)

ES2015 7.3.15 TestIntegrityLevel(O, level).

testIntegrityLevelDefault

protected final boolean testIntegrityLevelDefault(com.oracle.truffle.api.object.DynamicObject obj,
                                                  boolean frozen)

setIntegrityLevel

public boolean setIntegrityLevel(com.oracle.truffle.api.object.DynamicObject obj,
                                 boolean freeze,
                                 boolean doThrow)

ES2015 7.3.14 SetIntegrityLevel(O, level).

makeInitialShape

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

usesOrdinaryGetOwnProperty

public abstract boolean usesOrdinaryGetOwnProperty()

usesOrdinaryIsExtensible

public abstract boolean usesOrdinaryIsExtensible()