Module org.htmlunit.corejs

Package org.htmlunit.corejs.javascript

Class BaseFunction

java.lang.Object

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

org.htmlunit.corejs.javascript.ScriptableObject

org.htmlunit.corejs.javascript.BaseFunction

All Implemented Interfaces:

Serializable, Callable, ConstProperties<Scriptable>, Constructable, DebuggableObject, Function, PropHolder<Scriptable>, Scriptable, SymbolScriptable

Direct Known Subclasses:

BoundFunction, FunctionObject, IdFunctionObject, JSFunction, LambdaFunction, NativeFunction, NativeJavaConstructor, NativeJavaMethod, Require

public class BaseFunction
extends ScriptableObject
implements Function

The base class for Function objects. That is one of two purposes. It is also the prototype for every "function" defined except those that are used as GeneratorFunctions via the ES6 "function *" syntax.

See ECMA 15.3.

Author:

Norris Boyd

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

Modifier and Type	Field	Description
protected static final int	Id_arguments
protected static final int	Id_arity
protected static final int	Id_length
protected static final int	Id_name
protected static final int	Id_prototype
protected static final int	MAX_INSTANCE_ID

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
BaseFunction(VarScope scope)
BaseFunction(VarScope scope, Scriptable prototype)

Method Summary

Modifier and Type	Method	Description
Object	call(Context cx, Object nt, VarScope s, Object thisObj, Object[] args)
final Object	call(Context cx, VarScope scope, Object thisObj, Object[] args)	Should be overridden.
Scriptable	construct(Context cx, Object nt, VarScope scope, Object[] args)	Call the function as a constructor.
Scriptable	createObject(Context cx, VarScope scope)	Creates new script object.
Scriptable	createObject(Context cx, VarScope scope, Object nt)
protected void	createProperties()
protected void	createPrototypeProperty()
protected void	createPrototypeProperty(CompoundOperationMap<Scriptable> compoundOp)
protected final Object	defaultGet(String name)
protected final boolean	defaultHas(String name)
protected final void	defaultPut(String name, Object value)
int	getArity()
String	getClassName()	Return the name of the class.
Scriptable	getClassPrototype()
VarScope	getDeclarationScope()	Return the scope in which this function was declared or closed over.
String	getFunctionName()
Scriptable	getHomeObject()
int	getLength()
Object	getPrototypeProperty()
String	getTypeOf()	Gets the value returned by calling the typeof operator on this object.
protected boolean	hasDefaultParameters()
boolean	hasInstance(Scriptable instance)	Implements the instanceof operator for JavaScript Function objects.
protected boolean	hasPrototypeProperty()
boolean	isConstructor()	Return whether this function can be called as a constructor.
protected boolean	isGeneratorFunction()
protected static boolean	prototypeDescSetter(BaseFunction builtIn, BuiltInSlot<BaseFunction> current, Object id, ScriptableObject.DescriptorInfo info, boolean checkValid, Object key, int index)
void	setHomeObject(Scriptable homeObject)
void	setImmunePrototypeProperty(Object value)	Make value as DontEnum, DontDelete, ReadOnly prototype property of this Function object
protected void	setPrototypeProperty(Object prototype)
void	setPrototypePropertyAttributes(int attributes)
void	setStandardPropertyAttributes(int attributes)	Sets the attributes of the "name", "length", and "arity" properties, which differ for many native objects.
protected Object	setupDefaultPrototype(VarScope scope)

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, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureScriptableObjectButNotSymbol, ensureSymbolScriptable, ensureType, equivalentValues, get, get, getAllIds, getAncestor, getArrayPrototype, getClassPrototype, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getSuperProperty, getSuperProperty, getSuperProperty, getThis, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, has, hasProperty, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGenericDescriptor, isGetterOrSetter, isGetterOrSetter, isTrue, preventExtensions, put, put, 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, get, get, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getIds, has, has, isSealed, readMaps, setAttributes, 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.Constructable

construct

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

delete, delete, delete, get, get, get, getAncestor, getDefaultValue, getIds, getParentScope, getPrototype, has, has, has, put, put, put, setParentScope, setPrototype

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

get, has

Field Details

Id_length

protected static final int Id_length

See Also:

• Constant Field Values

Id_arity

protected static final int Id_arity

See Also:

• Constant Field Values

Id_name

protected static final int Id_name

See Also:

• Constant Field Values

Id_prototype

protected static final int Id_prototype

See Also:

• Constant Field Values

Id_arguments

protected static final int Id_arguments

See Also:

• Constant Field Values

MAX_INSTANCE_ID

protected static final int MAX_INSTANCE_ID

See Also:

• Constant Field Values

Constructor Details

BaseFunction

public BaseFunction(VarScope scope)

BaseFunction

public BaseFunction(VarScope scope,
 Scriptable prototype)

Method Details

createProperties

protected void createProperties()

createPrototypeProperty

protected void createPrototypeProperty()

createPrototypeProperty

protected void createPrototypeProperty(CompoundOperationMap<Scriptable> compoundOp)

prototypeDescSetter

protected static boolean prototypeDescSetter(BaseFunction builtIn,
 BuiltInSlot<BaseFunction> current,
 Object id,
 ScriptableObject.DescriptorInfo info,
 boolean checkValid,
 Object key,
 int index)

defaultHas

protected final boolean defaultHas(String name)

defaultGet

protected final Object defaultGet(String name)

defaultPut

protected final void defaultPut(String name,
 Object value)

getClassName

public String getClassName()

Description copied from class: ScriptableObject

Return the name of the class.

This is typically the same name as the constructor. Classes extending ScriptableObject must implement this abstract method.

Specified by:

getClassName in interface Scriptable

Specified by:

getClassName in class ScriptableObject

isGeneratorFunction

protected boolean isGeneratorFunction()

hasDefaultParameters

protected boolean hasDefaultParameters()

getTypeOf

public String getTypeOf()

Gets the value returned by calling the typeof operator on this object.

Overrides:

getTypeOf in class ScriptableObject

Returns:

"function" or "undefined" if ScriptableObject.avoidObjectDetection() returns true

See Also:

• ScriptableObject.getTypeOf()

hasInstance

public boolean hasInstance(Scriptable instance)

Implements the instanceof operator for JavaScript Function objects.

foo = new Foo();
foo instanceof Foo; // true


Specified by:

hasInstance in interface Scriptable

Overrides:

hasInstance in class ScriptableObject

Parameters:

instance - The value that appeared on the LHS of the instanceof operator

Returns:

true if the "prototype" property of "this" appears in value's prototype chain

setImmunePrototypeProperty

public void setImmunePrototypeProperty(Object value)

Make value as DontEnum, DontDelete, ReadOnly prototype property of this Function object

getClassPrototype

public Scriptable getClassPrototype()

call

public final Object call(Context cx,
 VarScope scope,
 Object thisObj,
 Object[] args)

Should be overridden.

Specified by:

call in interface Callable

Specified by:

call in interface Function

Parameters:

cx - the current Context for this thread

scope - the scope to execute the function relative to. This is set to the value returned by getParentScope() except when the function is called from a closure.

thisObj - the JavaScript this object

args - the array of arguments

Returns:

the result of the call

call

public Object call(Context cx,
 Object nt,
 VarScope s,
 Object thisObj,
 Object[] args)

construct

public Scriptable construct(Context cx,
 Object nt,
 VarScope scope,
 Object[] args)

Description copied from interface: Function

Call the function as a constructor.

This method is invoked by the runtime in order to satisfy a use of the JavaScript new operator. This method is expected to create a new object and return it.

If nt is equal to this then this call is equivalent `new f(...arguments), but reflection and super constructor calls may pass in different values.

Specified by:

construct in interface Constructable

Specified by:

construct in interface Function

Parameters:

cx - the current Context for this thread

nt - the new.target for this call,

scope - an enclosing scope of the caller except when the function is called from a closure.

args - the array of arguments

Returns:

the allocated object

createObject

public Scriptable createObject(Context cx,
 VarScope scope)

Creates new script object. The default implementation of construct(org.htmlunit.corejs.javascript.Context, java.lang.Object, org.htmlunit.corejs.javascript.VarScope, java.lang.Object[]) uses this method to to get the value for thisObj argument when invoking call(org.htmlunit.corejs.javascript.Context, org.htmlunit.corejs.javascript.VarScope, java.lang.Object, java.lang.Object[]). The method is allowed to return null to indicate that call(org.htmlunit.corejs.javascript.Context, org.htmlunit.corejs.javascript.VarScope, java.lang.Object, java.lang.Object[]) will create a new object itself. In this case construct(org.htmlunit.corejs.javascript.Context, java.lang.Object, org.htmlunit.corejs.javascript.VarScope, java.lang.Object[]) will set scope and prototype on the result call(org.htmlunit.corejs.javascript.Context, org.htmlunit.corejs.javascript.VarScope, java.lang.Object, java.lang.Object[]) unless they are already set.

createObject

public Scriptable createObject(Context cx,
 VarScope scope,
 Object nt)

getArity

public int getArity()

getLength

public int getLength()

getFunctionName

public String getFunctionName()

setStandardPropertyAttributes

public void setStandardPropertyAttributes(int attributes)

Sets the attributes of the "name", "length", and "arity" properties, which differ for many native objects.

setPrototypePropertyAttributes

public void setPrototypePropertyAttributes(int attributes)

hasPrototypeProperty

protected boolean hasPrototypeProperty()

getPrototypeProperty

public Object getPrototypeProperty()

setPrototypeProperty

protected void setPrototypeProperty(Object prototype)

setupDefaultPrototype

protected Object setupDefaultPrototype(VarScope scope)

setHomeObject

public void setHomeObject(Scriptable homeObject)

getHomeObject

public Scriptable getHomeObject()

isConstructor

public boolean isConstructor()

Description copied from interface: Function

Return whether this function can be called as a constructor.

Specified by:

isConstructor in interface Function

getDeclarationScope

public VarScope getDeclarationScope()

Description copied from interface: Function

Return the scope in which this function was declared or closed over. This is the "[[Environment]]" defined in https://tc39.es/ecma262/#sec-ecmascript-function-objects. Although this is currently precisely equal to the parent scope (or "__parent__") of an object it is useful to distinguish the two concepts as parent scopes are no longer supported by the spec in general and present a significant barrier to future optimisations.

Specified by:

getDeclarationScope in interface Function