com.oracle.truffle.js.runtime.array

Class ScriptArray

java.lang.Object

com.oracle.truffle.js.runtime.array.ScriptArray

Direct Known Subclasses:

DynamicArray, TypedArray

public abstract class ScriptArray
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ScriptArray.DefaultIterator
protected static interface	ScriptArray.ProfileAccess
static interface	ScriptArray.ProfileHolder
protected static interface	ScriptArray.SetLengthProfileAccess

Field Summary

Fields

Modifier and Type	Field and Description
static Object[]	EMPTY_OBJECT_ARRAY
protected static ScriptArray.SetLengthProfileAccess	SET_LENGTH_PROFILE

Constructor Summary

Constructors

Constructor and Description
ScriptArray()

Method Summary

Modifier and Type	Method and Description
ScriptArray	addRange(com.oracle.truffle.api.object.DynamicObject object, long offset, int size)
abstract ScriptArray	addRangeImpl(com.oracle.truffle.api.object.DynamicObject object, long offset, int size) This method grows the array by adding more elements of a given size.
Iterable<Object>	asIterable(com.oracle.truffle.api.object.DynamicObject object)
boolean	canDeleteElement(com.oracle.truffle.api.object.DynamicObject object, long index, boolean strict)
ScriptArray	cast(ScriptArray other)
static AbstractConstantArray	createConstantArray(Object[] elements)
static AbstractConstantArray	createConstantEmptyArray()
static ScriptArray.ProfileHolder	createSetLengthProfile()
ScriptArray	deleteElement(com.oracle.truffle.api.object.DynamicObject object, long index, boolean strict)
abstract ScriptArray	deleteElementImpl(com.oracle.truffle.api.object.DynamicObject object, long index, boolean strict)
abstract long	firstElementIndex(com.oracle.truffle.api.object.DynamicObject object) First element index (inclusive).
abstract ScriptArray	freeze()
abstract Object	getElement(com.oracle.truffle.api.object.DynamicObject object, long index)
abstract Object	getElementInBounds(com.oracle.truffle.api.object.DynamicObject object, long index)
abstract boolean	hasElement(com.oracle.truffle.api.object.DynamicObject object, long index)
abstract boolean	hasHoles(com.oracle.truffle.api.object.DynamicObject object)
boolean	isExtensible()
boolean	isFrozen()
boolean	isHolesType() Returns true when the this array could have hole values in it.
boolean	isInBoundsFast(com.oracle.truffle.api.object.DynamicObject object, long index) Range check only, might be a hole depending on array type.
boolean	isInstance(ScriptArray other)
boolean	isLengthNotWritable()
boolean	isSealed()
abstract long	lastElementIndex(com.oracle.truffle.api.object.DynamicObject object) Last element index (inclusive).
abstract long	length(com.oracle.truffle.api.object.DynamicObject object)
abstract int	lengthInt(com.oracle.truffle.api.object.DynamicObject object)
protected static List<Object>	makeMultiRangeList(int total, long[] ranges)
static List<Object>	makeRangeList(long rangeStart, long rangeEnd)
abstract long	nextElementIndex(com.oracle.truffle.api.object.DynamicObject object, long index) Returns the next index.
protected static int	nextPower(int length)
List<Object>	ownPropertyKeys(com.oracle.truffle.api.object.DynamicObject object)
protected List<Object>	ownPropertyKeysContiguous(com.oracle.truffle.api.object.DynamicObject object)
protected List<Object>	ownPropertyKeysHoles(com.oracle.truffle.api.object.DynamicObject object)
abstract ScriptArray	preventExtensions()
abstract long	previousElementIndex(com.oracle.truffle.api.object.DynamicObject object, long index) Returns the previous index.
ScriptArray	removeRange(com.oracle.truffle.api.object.DynamicObject object, long start, long end)
ScriptArray	removeRange(com.oracle.truffle.api.object.DynamicObject object, long start, long end, com.oracle.truffle.api.profiles.BranchProfile errorBranch)
abstract ScriptArray	removeRangeImpl(com.oracle.truffle.api.object.DynamicObject object, long start, long end) This function deletes all elements in the range from [start..end[.
abstract ScriptArray	seal()
ScriptArray	setElement(com.oracle.truffle.api.object.DynamicObject object, long index, Object value, boolean strict)
abstract ScriptArray	setElementImpl(com.oracle.truffle.api.object.DynamicObject object, long index, Object value, boolean strict)
ScriptArray	setLength(com.oracle.truffle.api.object.DynamicObject object, long len, boolean strict)
ScriptArray	setLength(com.oracle.truffle.api.object.DynamicObject object, long len, boolean strict, ScriptArray.ProfileHolder profile)
abstract ScriptArray	setLengthImpl(com.oracle.truffle.api.object.DynamicObject object, long len, ScriptArray.ProfileHolder profile)
abstract ScriptArray	setLengthNotWritable()
ScriptArray	shiftRange(com.oracle.truffle.api.object.DynamicObject object, long from, com.oracle.truffle.api.profiles.BranchProfile errorBranch)
ScriptArray	shiftRangeImpl(com.oracle.truffle.api.object.DynamicObject object, long limit) This function shifts all elements in the range from [0..limit[.
Object[]	toArray(com.oracle.truffle.api.object.DynamicObject thisObj) Creates an Object[] from this array, of size array.length.
String	toString(com.oracle.truffle.api.object.DynamicObject object)
protected static void	traceArrayTransition(ScriptArray oldArray, ScriptArray newArray, long index, Object value)
protected static void	traceWrite(String access, long index, Object value)
static boolean	valueIsByte(int value)

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_OBJECT_ARRAY

public static final Object[] EMPTY_OBJECT_ARRAY

SET_LENGTH_PROFILE

protected static final ScriptArray.SetLengthProfileAccess SET_LENGTH_PROFILE

Constructor Detail

ScriptArray

public ScriptArray()

Method Detail

getElement

public abstract Object getElement(com.oracle.truffle.api.object.DynamicObject object,
                                  long index)

getElementInBounds

public abstract Object getElementInBounds(com.oracle.truffle.api.object.DynamicObject object,
                                          long index)

setElementImpl

public abstract ScriptArray setElementImpl(com.oracle.truffle.api.object.DynamicObject object,
                                           long index,
                                           Object value,
                                           boolean strict)

setElement

public final ScriptArray setElement(com.oracle.truffle.api.object.DynamicObject object,
                                    long index,
                                    Object value,
                                    boolean strict)

deleteElementImpl

public abstract ScriptArray deleteElementImpl(com.oracle.truffle.api.object.DynamicObject object,
                                              long index,
                                              boolean strict)

deleteElement

public final ScriptArray deleteElement(com.oracle.truffle.api.object.DynamicObject object,
                                       long index,
                                       boolean strict)

canDeleteElement

public final boolean canDeleteElement(com.oracle.truffle.api.object.DynamicObject object,
                                      long index,
                                      boolean strict)

hasElement

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

Returns:

true if array has an element (not a hole) at this index.

length

public abstract long length(com.oracle.truffle.api.object.DynamicObject object)

lengthInt

public abstract int lengthInt(com.oracle.truffle.api.object.DynamicObject object)

createSetLengthProfile

public static ScriptArray.ProfileHolder createSetLengthProfile()

setLengthImpl

public abstract ScriptArray setLengthImpl(com.oracle.truffle.api.object.DynamicObject object,
                                          long len,
                                          ScriptArray.ProfileHolder profile)

setLength

public final ScriptArray setLength(com.oracle.truffle.api.object.DynamicObject object,
                                   long len,
                                   boolean strict,
                                   ScriptArray.ProfileHolder profile)

setLength

public final ScriptArray setLength(com.oracle.truffle.api.object.DynamicObject object,
                                   long len,
                                   boolean strict)

firstElementIndex

public abstract long firstElementIndex(com.oracle.truffle.api.object.DynamicObject object)

First element index (inclusive).

lastElementIndex

public abstract long lastElementIndex(com.oracle.truffle.api.object.DynamicObject object)

Last element index (inclusive).

nextElementIndex

public abstract long nextElementIndex(com.oracle.truffle.api.object.DynamicObject object,
                                      long index)

Returns the next index. The index is guaranteed either to exist, or be MAX_SAFE_INTEGER. Reason for MAX_SAFE_INTEGER is: this array could be the prototype of another one; returning the length() of this array would be wrong, if the inheriting array is longer, but has a hole at length().

previousElementIndex

public abstract long previousElementIndex(com.oracle.truffle.api.object.DynamicObject object,
                                          long index)

Returns the previous index. The index is guaranteed either to exist, or be smaller than firstElementIndex().

isInBoundsFast

public boolean isInBoundsFast(com.oracle.truffle.api.object.DynamicObject object,
                              long index)

Range check only, might be a hole depending on array type.

asIterable

public Iterable<Object> asIterable(com.oracle.truffle.api.object.DynamicObject object)

toArray

public final Object[] toArray(com.oracle.truffle.api.object.DynamicObject thisObj)

Creates an Object[] from this array, of size array.length. Does not check the prototype chain, i.e. result can be wrong. Use JSToObjectArrayNode for more correct results. This is mostly used in tests, but also in a few places in Node.js.

createConstantEmptyArray

public static AbstractConstantArray createConstantEmptyArray()

createConstantArray

public static AbstractConstantArray createConstantArray(Object[] elements)

valueIsByte

public static boolean valueIsByte(int value)

toString

public String toString(com.oracle.truffle.api.object.DynamicObject object)

traceArrayTransition

protected static final void traceArrayTransition(ScriptArray oldArray,
                                                 ScriptArray newArray,
                                                 long index,
                                                 Object value)

traceWrite

protected static final void traceWrite(String access,
                                       long index,
                                       Object value)

isHolesType

public boolean isHolesType()

Returns true when the this array could have hole values in it. Doesn't tell whether it actually HAS holes.

hasHoles

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

removeRangeImpl

public abstract ScriptArray removeRangeImpl(com.oracle.truffle.api.object.DynamicObject object,
                                            long start,
                                            long end)

This function deletes all elements in the range from [start..end[. This is equivalent to shifting the whole array, starting with element index end, by end-start positions to the left. Can be used by e.g. Array.prototype.splice;

removeRange

public final ScriptArray removeRange(com.oracle.truffle.api.object.DynamicObject object,
                                     long start,
                                     long end)

removeRange

public final ScriptArray removeRange(com.oracle.truffle.api.object.DynamicObject object,
                                     long start,
                                     long end,
                                     com.oracle.truffle.api.profiles.BranchProfile errorBranch)

shiftRangeImpl

public ScriptArray shiftRangeImpl(com.oracle.truffle.api.object.DynamicObject object,
                                  long limit)

This function shifts all elements in the range from [0..limit[. Depending on the underlying implementation, the shift operation might be zero-copy. Can be used by e.g. Array.prototype.shift;

shiftRange

public final ScriptArray shiftRange(com.oracle.truffle.api.object.DynamicObject object,
                                    long from,
                                    com.oracle.truffle.api.profiles.BranchProfile errorBranch)

addRangeImpl

public abstract ScriptArray addRangeImpl(com.oracle.truffle.api.object.DynamicObject object,
                                         long offset,
                                         int size)

This method grows the array by adding more elements of a given size. An offset parameter can be used to specify where the new elements have to be added (starting from zero). The operation is equivalent to shifting (right) the whole array or its part as defined by the offset parameter.

Parameters:

offset - starting offset position

size - size of the inserted empty array

Returns:

a ScriptArray instance with the new size

addRange

public final ScriptArray addRange(com.oracle.truffle.api.object.DynamicObject object,
                                  long offset,
                                  int size)

ownPropertyKeys

public List<Object> ownPropertyKeys(com.oracle.truffle.api.object.DynamicObject object)

ownPropertyKeysContiguous

protected final List<Object> ownPropertyKeysContiguous(com.oracle.truffle.api.object.DynamicObject object)

ownPropertyKeysHoles

protected final List<Object> ownPropertyKeysHoles(com.oracle.truffle.api.object.DynamicObject object)

makeRangeList

public static List<Object> makeRangeList(long rangeStart,
                                         long rangeEnd)

makeMultiRangeList

protected static List<Object> makeMultiRangeList(int total,
                                                 long[] ranges)

nextPower

protected static int nextPower(int length)

isSealed

public boolean isSealed()

isFrozen

public boolean isFrozen()

isLengthNotWritable

public boolean isLengthNotWritable()

isExtensible

public boolean isExtensible()

seal

public abstract ScriptArray seal()

freeze

public abstract ScriptArray freeze()

setLengthNotWritable

public abstract ScriptArray setLengthNotWritable()

preventExtensions

public abstract ScriptArray preventExtensions()

isInstance

public final boolean isInstance(ScriptArray other)

cast

public final ScriptArray cast(ScriptArray other)