Module org.htmlunit.corejs

Package org.htmlunit.corejs.javascript

Class IdScriptableObject

java.lang.Object

org.htmlunit.corejs.javascript.SlotMapOwner<Scriptable>

org.htmlunit.corejs.javascript.ScriptableObject

org.htmlunit.corejs.javascript.IdScriptableObject

All Implemented Interfaces:

Serializable, ConstProperties<Scriptable>, DebuggableObject, IdFunctionCall, PropHolder<Scriptable>, Scriptable, SymbolScriptable

public abstract class IdScriptableObject
extends ScriptableObject
implements IdFunctionCall

Base class for native object implementation that uses IdFunctionObject to export its methods to script via <class-name>.prototype object.

Any descendant should implement at least the following methods: findInstanceIdInfo getInstanceIdName execIdCall methodArity

To define non-function properties, the descendant should override getInstanceIdValue setInstanceIdValue to get/set property value and provide its default attributes.

To customize initialization of constructor and prototype objects, descendant may override scopeInit or fillConstructorProperties methods.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.htmlunit.corejs.javascript.ScriptableObject

ScriptableObject.DescriptorInfo, ScriptableObject.KeyComparator, ScriptableObject.LambdaGetterFunction, ScriptableObject.LambdaSetterFunction

Field Summary

Fields inherited from class org.htmlunit.corejs.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, LEGACY_CONST, PERMANENT, READONLY, STRICTLY_READONLY, UNINITIALIZED_CONST

Fields inherited from class org.htmlunit.corejs.javascript.SlotMapOwner

isSealed

Fields inherited from interface org.htmlunit.corejs.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor	Description
IdScriptableObject()
IdScriptableObject(VarScope scope, Scriptable prototype)

Method Summary

Modifier and Type	Method	Description
final void	activatePrototypeMap(int maxPrototypeId)
protected void	addIdFunctionProperty(Scriptable obj, Object tag, int id, String name, int arity)
protected final Object	defaultGet(String name)
protected final boolean	defaultHas(String name)
protected final void	defaultPut(String name, Object value)
protected boolean	defineOwnProperty(Context cx, Object key, ScriptableObject.DescriptorInfo desc, boolean checkValid)	Defines a property on an object.
void	delete(String name)	Removes a named property from the object.
void	delete(Symbol key)	Removes an object like the others, but using a Symbol as the key.
protected static <T> T	ensureType(Object obj, Class<T> clazz, IdFunctionObject f)	Utility method to check the type and do the cast or throw an incompatible call error.
Object	execIdCall(IdFunctionObject f, Context cx, VarScope scope, Scriptable thisObj, Object[] args)	'thisObj' will be null if invoked as constructor, in which case * instance of Scriptable should be returned.
final IdFunctionObject	exportAsJSClass(int maxPrototypeId, VarScope scope, boolean sealed)
protected void	fillConstructorProperties(IdFunctionObject ctor)
protected int	findInstanceIdInfo(String name)	Map name to id of instance property.
protected int	findInstanceIdInfo(Symbol key)	Map name to id of instance property.
protected int	findPrototypeId(String name)
protected int	findPrototypeId(Symbol key)
Object	get(String name, Scriptable start)	Returns the value of the named property or NOT_FOUND.
Object	get(Symbol key, Scriptable start)	Another version of Get that supports Symbol keyed properties.
int	getAttributes(String name)	Get the attributes of a named property.
int	getAttributes(Symbol key)
protected String	getInstanceIdName(int id)	Map id back to property name it defines.
protected Object	getInstanceIdValue(int id)	Get id value. * If id value is constant, descendant can call cacheIdValue to store * value in the permanent cache. * Default implementation creates IdFunctionObject instance for given id * and cache its value
protected int	getMaxInstanceId()	Get maximum id findInstanceIdInfo can generate.
protected ScriptableObject.DescriptorInfo	getOwnPropertyDescriptor(Context cx, Object id)
boolean	has(String name, Scriptable start)	Returns true if the named property is defined.
boolean	has(Symbol key, Scriptable start)	A version of "has" that supports symbols.
final boolean	hasPrototypeMap()
final void	initPrototypeConstructor(IdFunctionObject f)
protected void	initPrototypeId(int id)
final IdFunctionObject	initPrototypeMethod(Object tag, int id, String name, int arity)
final IdFunctionObject	initPrototypeMethod(Object tag, int id, String propertyName, String functionName, int arity)
final IdFunctionObject	initPrototypeMethod(Object tag, int id, Symbol key, String functionName, int arity)
final IdFunctionObject	initPrototypeMethod(Object tag, int id, Symbol key, String functionName, int arity, int attributes)
final void	initPrototypeValue(int id, String name, Object value, int attributes)
final void	initPrototypeValue(int id, Symbol key, Object value, int attributes)
protected static int	instanceIdInfo(int attributes, int id)
void	put(String name, Scriptable start, Object value)	Sets the value of the named property, creating it if need be.
void	put(Symbol key, Scriptable start, Object value)	Implementation of put required by SymbolScriptable objects.
void	setAttributes(String name, int attributes)	Set the attributes of a named property.
protected void	setInstanceIdAttributes(int id, int attr)	Update the attributes of the given instance property.
protected void	setInstanceIdValue(int id, Object value)	Set or delete id value.

Methods inherited from class org.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkNotSealed, checkPropertyChangeForSlot, checkPropertyChangeForSlot, checkPropertyDefinition, checkPropertyDefinition, checkSlotRemoval, defineBuiltinProperty, defineBuiltinProperty, defineBuiltInProperty, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, deleteProperty, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureScriptableObjectButNotSymbol, ensureSymbolScriptable, ensureType, equivalentValues, get, get, getAllIds, getAncestor, getArrayPrototype, getClassName, getClassPrototype, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getObjectPrototype, getParentScope, getProperty, getProperty, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getSuperProperty, getSuperProperty, getSuperProperty, getThis, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, hasInstance, hasProperty, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGenericDescriptor, isGetterOrSetter, isGetterOrSetter, isTrue, preventExtensions, put, putConst, putConstProperty, putConstProperty, putOwnProperty, putOwnProperty, putOwnProperty, putProperty, putProperty, putProperty, putProperty, putSuperProperty, putSuperProperty, putSuperProperty, querySlot, redefineProperty, redefineProperty, sameValue, sealObject, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class org.htmlunit.corejs.javascript.SlotMapOwner

associateValue, checkNotSealed, copyAssociatedValue, createSlotMap, createSlotMap, defineProperty, defineProperty, getAssociatedValue, getAttributes, getAttributes, getAttributes, getIds, isSealed, readMaps, setAttributes, setAttributes, setAttributes, setAttributes, writeMaps

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.htmlunit.corejs.javascript.Scriptable

getIds

Constructor Details

IdScriptableObject

public IdScriptableObject()

IdScriptableObject

public IdScriptableObject(VarScope scope,
 Scriptable prototype)

Method Details

defaultHas

protected final boolean defaultHas(String name)

defaultGet

protected final Object defaultGet(String name)

defaultPut

protected final void defaultPut(String name,
 Object value)

has

public boolean has(String name,
 Scriptable start)

Description copied from class: SlotMapOwner

Returns true if the named property is defined.

Specified by:

has in interface PropHolder<Scriptable>

Specified by:

has in interface Scriptable

Overrides:

has in class SlotMapOwner<Scriptable>

Parameters:

name - the name of the property

start - the object in which the lookup began

Returns:

true if and only if the property was found in the object

See Also:

• Scriptable.get(String, Scriptable)
• ScriptableObject.getProperty(Scriptable, String)

has

public boolean has(Symbol key,
 Scriptable start)

Description copied from class: SlotMapOwner

A version of "has" that supports symbols.

Specified by:

has in interface PropHolder<Scriptable>

Specified by:

has in interface Scriptable

Specified by:

has in interface SymbolScriptable

Overrides:

has in class SlotMapOwner<Scriptable>

get

public Object get(String name,
 Scriptable start)

Description copied from class: SlotMapOwner

Returns the value of the named property or NOT_FOUND.

If the property was created using defineProperty, the appropriate getter method is called.

Specified by:

get in interface PropHolder<Scriptable>

Specified by:

get in interface Scriptable

Overrides:

get in class SlotMapOwner<Scriptable>

Parameters:

name - the name of the property

start - the object in which the lookup began

Returns:

the value of the property (may be null), or NOT_FOUND

See Also:

• Context.getUndefinedValue()

get

public Object get(Symbol key,
 Scriptable start)

Description copied from class: SlotMapOwner

Another version of Get that supports Symbol keyed properties.

Specified by:

get in interface PropHolder<Scriptable>

Specified by:

get in interface Scriptable

Specified by:

get in interface SymbolScriptable

Overrides:

get in class SlotMapOwner<Scriptable>

put

public void put(String name,
 Scriptable start,
 Object value)

Description copied from class: ScriptableObject

Sets the value of the named property, creating it if need be.

If the property was created using defineProperty, the appropriate setter method is called.

If the property's attributes include READONLY, no action is taken. This method will actually set the property in the start object.

Specified by:

put in interface PropHolder<Scriptable>

Specified by:

put in interface Scriptable

Overrides:

put in class ScriptableObject

Parameters:

name - the name of the property

start - the object whose property is being set

value - value to set the property to

See Also:

• Scriptable.has(String, Scriptable)
• Scriptable.get(String, Scriptable)
• ScriptableObject.putProperty(Scriptable, String, Object)
• Context.toObject(Object, VarScope)

put

public void put(Symbol key,
 Scriptable start,
 Object value)

Description copied from class: ScriptableObject

Implementation of put required by SymbolScriptable objects.

Specified by:

put in interface PropHolder<Scriptable>

Specified by:

put in interface Scriptable

Specified by:

put in interface SymbolScriptable

Overrides:

put in class ScriptableObject

delete

public void delete(String name)

Description copied from class: ScriptableObject

Removes a named property from the object.

If the property is not found, or it has the PERMANENT attribute, no action is taken.

Specified by:

delete in interface PropHolder<Scriptable>

Specified by:

delete in interface Scriptable

Overrides:

delete in class ScriptableObject

Parameters:

name - the name of the property

See Also:

• Scriptable.get(String, Scriptable)
• ScriptableObject.deleteProperty(Scriptable, String)

delete

public void delete(Symbol key)

Description copied from class: ScriptableObject

Removes an object like the others, but using a Symbol as the key.

Specified by:

delete in interface PropHolder<Scriptable>

Specified by:

delete in interface Scriptable

Specified by:

delete in interface SymbolScriptable

Overrides:

delete in class ScriptableObject

getAttributes

public int getAttributes(String name)

Description copied from class: SlotMapOwner

Get the attributes of a named property.

The property is specified by name as defined for has.

Overrides:

getAttributes in class SlotMapOwner<Scriptable>

Parameters:

name - the identifier for the property

Returns:

the bitset of attributes

See Also:

• Scriptable.has(String, Scriptable)
• ScriptableObject.READONLY
• ScriptableObject.DONTENUM
• ScriptableObject.PERMANENT
• ScriptableObject.EMPTY

getAttributes

public int getAttributes(Symbol key)

Overrides:

getAttributes in class SlotMapOwner<Scriptable>

setAttributes

public void setAttributes(String name,
 int attributes)

Description copied from class: SlotMapOwner

Set the attributes of a named property.

The property is specified by name as defined for has.

The possible attributes are READONLY, DONTENUM, and PERMANENT. Combinations of attributes are expressed by the bitwise OR of attributes. EMPTY is the state of no attributes set. Any unused bits are reserved for future use.

Overrides:

setAttributes in class SlotMapOwner<Scriptable>

Parameters:

name - the name of the property

attributes - the bitset of attributes

See Also:

• Scriptable.has(String, Scriptable)
• ScriptableObject.READONLY
• ScriptableObject.DONTENUM
• ScriptableObject.PERMANENT
• ScriptableObject.EMPTY

getMaxInstanceId

protected int getMaxInstanceId()

Get maximum id findInstanceIdInfo can generate.

instanceIdInfo

protected static int instanceIdInfo(int attributes,
 int id)

findInstanceIdInfo

protected int findInstanceIdInfo(String name)

Map name to id of instance property. Should return 0 if not found or the result of instanceIdInfo(int, int).

findInstanceIdInfo

protected int findInstanceIdInfo(Symbol key)

Map name to id of instance property. Should return 0 if not found or the result of instanceIdInfo(int, int).

getInstanceIdName

protected String getInstanceIdName(int id)

Map id back to property name it defines.

getInstanceIdValue

protected Object getInstanceIdValue(int id)

Get id value. * If id value is constant, descendant can call cacheIdValue to store * value in the permanent cache. * Default implementation creates IdFunctionObject instance for given id * and cache its value

setInstanceIdValue

protected void setInstanceIdValue(int id,
 Object value)

Set or delete id value. If value == NOT_FOUND, the implementation should make sure that the following getInstanceIdValue return NOT_FOUND.

setInstanceIdAttributes

protected void setInstanceIdAttributes(int id,
 int attr)

Update the attributes of the given instance property. Classes which want to support changing property attributes via Object.defineProperty must override this method. The default implementation throws InternalError.

Parameters:

id - the instance property id

attr - the new attribute bitset

execIdCall

public Object execIdCall(IdFunctionObject f,
 Context cx,
 VarScope scope,
 Scriptable thisObj,
 Object[] args)

'thisObj' will be null if invoked as constructor, in which case * instance of Scriptable should be returned.

Specified by:

execIdCall in interface IdFunctionCall

exportAsJSClass

public final IdFunctionObject exportAsJSClass(int maxPrototypeId,
 VarScope scope,
 boolean sealed)

hasPrototypeMap

public final boolean hasPrototypeMap()

activatePrototypeMap

public final void activatePrototypeMap(int maxPrototypeId)

initPrototypeMethod

public final IdFunctionObject initPrototypeMethod(Object tag,
 int id,
 String name,
 int arity)

initPrototypeMethod

public final IdFunctionObject initPrototypeMethod(Object tag,
 int id,
 String propertyName,
 String functionName,
 int arity)

initPrototypeMethod

public final IdFunctionObject initPrototypeMethod(Object tag,
 int id,
 Symbol key,
 String functionName,
 int arity)

initPrototypeMethod

public final IdFunctionObject initPrototypeMethod(Object tag,
 int id,
 Symbol key,
 String functionName,
 int arity,
 int attributes)

initPrototypeConstructor

public final void initPrototypeConstructor(IdFunctionObject f)

initPrototypeValue

public final void initPrototypeValue(int id,
 String name,
 Object value,
 int attributes)

initPrototypeValue

public final void initPrototypeValue(int id,
 Symbol key,
 Object value,
 int attributes)

initPrototypeId

protected void initPrototypeId(int id)

findPrototypeId

protected int findPrototypeId(String name)

findPrototypeId

protected int findPrototypeId(Symbol key)

fillConstructorProperties

protected void fillConstructorProperties(IdFunctionObject ctor)

addIdFunctionProperty

protected void addIdFunctionProperty(Scriptable obj,
 Object tag,
 int id,
 String name,
 int arity)

ensureType

protected static <T> T ensureType(Object obj,
 Class<T> clazz,
 IdFunctionObject f)

Utility method to check the type and do the cast or throw an incompatible call error. Possible usage would be to have a private function like realThis:

  private static NativeSomething realThis(Scriptable thisObj, IdFunctionObject f)
  {
      return ensureType(thisObj, NativeSomething.class, f);
 }
 

Parameters:

obj - the object to check/cast

clazz - the target type

f - function that is attempting to convert 'this' object.

Returns:

obj cast to the target type

Throws:

EcmaError - if the cast failed.

defineOwnProperty

protected boolean defineOwnProperty(Context cx,
 Object key,
 ScriptableObject.DescriptorInfo desc,
 boolean checkValid)

Description copied from class: ScriptableObject

Defines a property on an object.

Based on [[DefineOwnProperty]] from 8.12.10 of the spec. see [[DefineOwnProperty]]

Overrides:

defineOwnProperty in class ScriptableObject

Parameters:

cx - the current Context

key - the name/index of the property

desc - the new property descriptor, as described in 8.6.1

checkValid - whether to perform validity checks

Returns:

always true at the moment

getOwnPropertyDescriptor

protected ScriptableObject.DescriptorInfo getOwnPropertyDescriptor(Context cx,
 Object id)

Overrides:

getOwnPropertyDescriptor in class ScriptableObject