com.oracle.truffle.js.runtime.objects

Class JSDynamicObject

java.lang.Object

com.oracle.truffle.api.object.DynamicObject

com.oracle.truffle.js.runtime.objects.JSDynamicObject

All Implemented Interfaces:

com.oracle.truffle.api.interop.TruffleObject

Direct Known Subclasses:

JSObject, Nullish

public abstract class JSDynamicObject
extends com.oracle.truffle.api.object.DynamicObject
implements com.oracle.truffle.api.interop.TruffleObject

The common base class for all JavaScript objects as well as null and undefined.

Nested Class Summary

Nested classes/interfaces inherited from class com.oracle.truffle.api.object.DynamicObject

com.oracle.truffle.api.object.DynamicObject.DynamicField

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JSDynamicObject(com.oracle.truffle.api.object.Shape shape)

Method Summary

Modifier and Type	Method and Description
String	defaultToString() 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(Object key, PropertyDescriptor value, boolean doThrow) 9.1.6 [[DefineOwnProperty]] (P, Desc).
abstract boolean	delete(long propIdx, boolean isStrict)
abstract boolean	delete(Object key, boolean isStrict) 9.1.10 [[Delete]] (P).
String	getBuiltinToStringTag() Returns builtinTag from step 14 of ES6+ 19.1.3.6.
abstract String	getClassName() The [[Class]] internal property.
static Object	getDynamicType(com.oracle.truffle.api.object.DynamicObject obj)
abstract Object	getHelper(Object receiver, long index)
abstract Object	getHelper(Object receiver, Object key)
static int	getIntOrDefault(com.oracle.truffle.api.object.DynamicObject obj, Object key, int defaultValue)
JSClass	getJSClass()
static JSClass	getJSClass(com.oracle.truffle.api.object.DynamicObject obj)
JSContext	getJSContext()
static JSContext	getJSContext(com.oracle.truffle.api.object.DynamicObject obj)
static JSSharedData	getJSSharedData(com.oracle.truffle.api.object.DynamicObject obj)
static Object[]	getKeyArray(com.oracle.truffle.api.object.DynamicObject obj)
abstract Object	getMethodHelper(Object receiver, Object key)
static int	getObjectFlags(com.oracle.truffle.api.object.DynamicObject obj)
static Object	getOrDefault(com.oracle.truffle.api.object.DynamicObject obj, Object key, Object defaultValue)
static Object	getOrNull(com.oracle.truffle.api.object.DynamicObject obj, Object key)
abstract Object	getOwnHelper(Object receiver, long index)
abstract Object	getOwnHelper(Object receiver, Object key)
abstract PropertyDescriptor	getOwnProperty(Object propertyKey) 9.1.5 [[GetOwnProperty]] (P).
abstract List<Object>	getOwnPropertyKeys(boolean strings, boolean symbols) GetOwnPropertyKeys (O, type).
static com.oracle.truffle.api.object.Property	getProperty(com.oracle.truffle.api.object.DynamicObject obj, Object key)
static com.oracle.truffle.api.object.Property[]	getPropertyArray(com.oracle.truffle.api.object.DynamicObject obj)
static int	getPropertyFlags(com.oracle.truffle.api.object.DynamicObject obj, Object key)
abstract JSDynamicObject	getPrototypeOf() 9.1.1 [[GetPrototypeOf]] ().
Object	getValue(long index)
Object	getValue(Object key) 9.1.8 [[Get]] (P, Receiver).
abstract boolean	hasOnlyShapeProperties() If true, JSDynamicObject.ownPropertyKeys() and JSShape.getProperties(com.oracle.truffle.api.object.Shape) enumerate the same keys.
abstract boolean	hasOwnProperty(long index)
abstract boolean	hasOwnProperty(Object propName)
static boolean	hasProperty(com.oracle.truffle.api.object.DynamicObject obj, Object key)
abstract boolean	hasProperty(long index)
abstract boolean	hasProperty(Object key) 9.1.7 [[HasProperty]] (P).
abstract boolean	isExtensible() 9.1.3 [[IsExtensible]] ().
static boolean	isJSDynamicObject(Object object) Returns whether object is a DynamicObject of JavaScript.
List<Object>	ownPropertyKeys() 9.1.12 [[OwnPropertyKeys]]().
abstract boolean	preventExtensions(boolean doThrow) 9.1.4 [[PreventExtensions]] ().
static boolean	removeKey(com.oracle.truffle.api.object.DynamicObject obj, Object key)
abstract boolean	set(long index, Object value, Object receiver, boolean isStrict)
abstract boolean	set(Object key, Object value, Object receiver, boolean isStrict) 9.1.9 [[Set]] (P, V, Receiver).
boolean	setIntegrityLevel(boolean freeze, boolean doThrow) ES2015 7.3.14 SetIntegrityLevel(O, level).
static void	setJSClass(com.oracle.truffle.api.object.DynamicObject obj, JSClass jsclass)
static void	setObjectFlags(com.oracle.truffle.api.object.DynamicObject obj, int flags)
static void	setPropertyFlags(com.oracle.truffle.api.object.DynamicObject obj, Object key, int flags)
abstract boolean	setPrototypeOf(JSDynamicObject newPrototype) 9.1.2 [[SetPrototypeOf]] (V).
boolean	testIntegrityLevel(boolean frozen) ES2015 7.3.15 TestIntegrityLevel(O, level).
static boolean	testProperties(com.oracle.truffle.api.object.DynamicObject obj, Predicate<com.oracle.truffle.api.object.Property> predicate)
abstract String	toDisplayStringImpl(int depth, boolean allowSideEffects) A more informative toString variant, mainly used for error messages.
abstract String	toString()
static boolean	updatePropertyFlags(com.oracle.truffle.api.object.DynamicObject obj, Object key, IntUnaryOperator updateFunction) Update property flags, changing the object's shape if need be.

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

clone, getShape

Methods inherited from class java.lang.Object

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

Constructor Detail

JSDynamicObject

protected JSDynamicObject(com.oracle.truffle.api.object.Shape shape)

Method Detail

getJSContext

public final JSContext getJSContext()

getJSClass

public JSClass getJSClass()

getPrototypeOf

public abstract JSDynamicObject getPrototypeOf()

9.1.1 [[GetPrototypeOf]] ().

setPrototypeOf

public abstract boolean setPrototypeOf(JSDynamicObject newPrototype)

9.1.2 [[SetPrototypeOf]] (V).

isExtensible

public abstract boolean isExtensible()

9.1.3 [[IsExtensible]] ().

preventExtensions

public abstract boolean preventExtensions(boolean doThrow)

9.1.4 [[PreventExtensions]] ().

getOwnProperty

public abstract PropertyDescriptor getOwnProperty(Object propertyKey)

9.1.5 [[GetOwnProperty]] (P).

defineOwnProperty

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

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

hasProperty

public abstract boolean hasProperty(Object key)

9.1.7 [[HasProperty]] (P).

hasProperty

public abstract boolean hasProperty(long index)

hasOwnProperty

public abstract boolean hasOwnProperty(Object propName)

hasOwnProperty

public abstract boolean hasOwnProperty(long index)

getValue

public Object getValue(Object key)

9.1.8 [[Get]] (P, Receiver). TODO: rename to get once DynamicObject.get(Object) is removed.

getValue

public Object getValue(long index)

getHelper

public abstract Object getHelper(Object receiver,
                                 Object key)

getHelper

public abstract Object getHelper(Object receiver,
                                 long index)

getOwnHelper

public abstract Object getOwnHelper(Object receiver,
                                    Object key)

getOwnHelper

public abstract Object getOwnHelper(Object receiver,
                                    long index)

getMethodHelper

public abstract Object getMethodHelper(Object receiver,
                                       Object key)

set

public abstract boolean set(Object key,
                            Object value,
                            Object receiver,
                            boolean isStrict)

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

set

public abstract boolean set(long index,
                            Object value,
                            Object receiver,
                            boolean isStrict)

delete

public abstract boolean delete(Object key,
                               boolean isStrict)

9.1.10 [[Delete]] (P).

delete

public abstract boolean delete(long propIdx,
                               boolean isStrict)

ownPropertyKeys

public List<Object> ownPropertyKeys()

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(boolean strings,
                                                boolean symbols)

GetOwnPropertyKeys (O, type).

Returns:

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

hasOnlyShapeProperties

public abstract boolean hasOnlyShapeProperties()

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

getClassName

public abstract String getClassName()

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

toString

public abstract String toString()

Overrides:

toString in class Object

defaultToString

public String defaultToString()

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:

JSDynamicObject.getBuiltinToStringTag()

getBuiltinToStringTag

public String getBuiltinToStringTag()

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

Returns:

"Object" by default

See Also:

JSDynamicObject.defaultToString()

toDisplayStringImpl

public abstract String toDisplayStringImpl(int depth,
                                           boolean allowSideEffects)

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

Parameters:

depth - allowed nesting depth

testIntegrityLevel

public boolean testIntegrityLevel(boolean frozen)

ES2015 7.3.15 TestIntegrityLevel(O, level).

setIntegrityLevel

public boolean setIntegrityLevel(boolean freeze,
                                 boolean doThrow)

ES2015 7.3.14 SetIntegrityLevel(O, level).

isJSDynamicObject

public static boolean isJSDynamicObject(Object object)

Returns whether object is a DynamicObject of JavaScript.

getJSContext

public static JSContext getJSContext(com.oracle.truffle.api.object.DynamicObject obj)

getJSClass

public static JSClass getJSClass(com.oracle.truffle.api.object.DynamicObject obj)

setJSClass

public static void setJSClass(com.oracle.truffle.api.object.DynamicObject obj,
                              JSClass jsclass)

getDynamicType

public static Object getDynamicType(com.oracle.truffle.api.object.DynamicObject obj)

hasProperty

public static boolean hasProperty(com.oracle.truffle.api.object.DynamicObject obj,
                                  Object key)

getProperty

public static com.oracle.truffle.api.object.Property getProperty(com.oracle.truffle.api.object.DynamicObject obj,
                                                                 Object key)

getKeyArray

public static Object[] getKeyArray(com.oracle.truffle.api.object.DynamicObject obj)

getPropertyArray

public static com.oracle.truffle.api.object.Property[] getPropertyArray(com.oracle.truffle.api.object.DynamicObject obj)

getOrNull

public static Object getOrNull(com.oracle.truffle.api.object.DynamicObject obj,
                               Object key)

getOrDefault

public static Object getOrDefault(com.oracle.truffle.api.object.DynamicObject obj,
                                  Object key,
                                  Object defaultValue)

getIntOrDefault

public static int getIntOrDefault(com.oracle.truffle.api.object.DynamicObject obj,
                                  Object key,
                                  int defaultValue)

getObjectFlags

public static int getObjectFlags(com.oracle.truffle.api.object.DynamicObject obj)

setObjectFlags

public static void setObjectFlags(com.oracle.truffle.api.object.DynamicObject obj,
                                  int flags)

setPropertyFlags

public static void setPropertyFlags(com.oracle.truffle.api.object.DynamicObject obj,
                                    Object key,
                                    int flags)

getPropertyFlags

public static int getPropertyFlags(com.oracle.truffle.api.object.DynamicObject obj,
                                   Object key)

updatePropertyFlags

public static boolean updatePropertyFlags(com.oracle.truffle.api.object.DynamicObject obj,
                                          Object key,
                                          IntUnaryOperator updateFunction)

Update property flags, changing the object's shape if need be.

Parameters:

updateFunction - An idempotent function that returns the updated property flags based on the previous flags.

Returns:

true if successful, false if there was no such property or no change was made.

See Also:

JSDynamicObject.setPropertyFlags(DynamicObject, Object, int), JSDynamicObject.getPropertyFlags(DynamicObject, Object)

testProperties

public static boolean testProperties(com.oracle.truffle.api.object.DynamicObject obj,
                                     Predicate<com.oracle.truffle.api.object.Property> predicate)

removeKey

public static boolean removeKey(com.oracle.truffle.api.object.DynamicObject obj,
                                Object key)

getJSSharedData

public static JSSharedData getJSSharedData(com.oracle.truffle.api.object.DynamicObject obj)