org.htmlunit.corejs.javascript

Class JSFunction

java.lang.Object

org.htmlunit.corejs.javascript.SlotMapOwner

org.htmlunit.corejs.javascript.ScriptableObject

org.htmlunit.corejs.javascript.BaseFunction

org.htmlunit.corejs.javascript.JSFunction

All Implemented Interfaces:

Serializable, Callable, ConstProperties, Constructable, DebuggableObject, Function, Scriptable, ScriptOrFn<JSFunction>, SymbolScriptable

public class JSFunction
extends BaseFunction
implements ScriptOrFn<JSFunction>

Represents a JavaScript function built upon a a JSDescriptor. All the immutable metadata associated with the function is stored on the descriptor, with only the lexically bound this, the home object required for super calls, and mutable properties held on the function object itself.

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.BaseFunction

Id_arguments, Id_arity, Id_length, Id_name, Id_prototype, MAX_INSTANCE_ID

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

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

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

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
JSFunction(Context cx, Scriptable scope, JSDescriptor<JSFunction> descriptor, Scriptable lexicalThis, Scriptable homeObject)

Method Summary

Modifier and Type	Method and Description
Object	call(Context cx, Scriptable scope, Scriptable thisObj, Object[] args) Should be overridden.
Scriptable	construct(Context cx, Scriptable scope, Object[] args) Call the function as a constructor.
static JSFunction	createFunction(Context cx, Scriptable scope, JSDescriptor<JSFunction> desc, Scriptable homeObject, Object staticSecurityDomain) Create function compiled from Function(...) constructor.
protected void	createPrototypeProperty()
static JSScript	createScript(JSDescriptor<JSScript> desc, Scriptable homeObject, Object staticSecurityDomain) Create script from compiled bytecode.
Object	get(String name, Scriptable start) Returns the value of the named property or NOT_FOUND.
int	getArity()
DebuggableScript	getDebuggableView()
Scriptable	getDeclarationScope() Return the scope in which this function was declared or closed over.
JSDescriptor<JSFunction>	getDescriptor()
String	getFunctionName()
Scriptable	getFunctionThis(Scriptable functionThis)
Scriptable	getHomeObject()
protected int	getLanguageVersion()
int	getLength()
protected int	getParamAndVarCount()
protected int	getParamCount()
protected boolean	getParamOrVarConst(int index)
protected String	getParamOrVarName(int index)
String	getRawSource()
protected boolean	hasDefaultParameters()
boolean	hasFunctionNamed(String name)
protected boolean	hasPrototypeProperty()
protected boolean	isGeneratorFunction()
boolean	isScript()
boolean	isShorthand()
boolean	isStrict()
Object	resumeGenerator(Context cx, Scriptable scope, int operation, Object state, Object value)
void	setHomeObject(Scriptable homeObject)

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

createObject, createProperties, createPrototypeProperty, defaultGet, defaultHas, defaultPut, getClassName, getClassPrototype, getPrototypeProperty, getTypeOf, hasInstance, includeNonStandardProps, prototypeDescSetter, setImmunePrototypeProperty, setPrototypeProperty, setPrototypePropertyAttributes, setStandardPropertyAttributes, setupDefaultPrototype

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

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

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

createSlotMap

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

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

Constructor Detail

JSFunction

public JSFunction(Context cx,
                  Scriptable scope,
                  JSDescriptor<JSFunction> descriptor,
                  Scriptable lexicalThis,
                  Scriptable homeObject)

Method Detail

getDeclarationScope

public Scriptable 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

Specified by:

getDeclarationScope in interface ScriptOrFn<JSFunction>

getDescriptor

public JSDescriptor<JSFunction> getDescriptor()

Specified by:

getDescriptor in interface ScriptOrFn<JSFunction>

isShorthand

public boolean isShorthand()

isStrict

public boolean isStrict()

getArity

public int getArity()

Overrides:

getArity in class BaseFunction

getDebuggableView

public DebuggableScript getDebuggableView()

getLanguageVersion

protected int getLanguageVersion()

hasPrototypeProperty

protected boolean hasPrototypeProperty()

Overrides:

hasPrototypeProperty in class BaseFunction

isGeneratorFunction

protected boolean isGeneratorFunction()

Overrides:

isGeneratorFunction in class BaseFunction

getLength

public int getLength()

Overrides:

getLength in class BaseFunction

getParamAndVarCount

protected int getParamAndVarCount()

getParamCount

protected int getParamCount()

getParamOrVarConst

protected boolean getParamOrVarConst(int index)

getParamOrVarName

protected String getParamOrVarName(int index)

getRawSource

public String getRawSource()

createPrototypeProperty

protected void createPrototypeProperty()

Overrides:

createPrototypeProperty in class BaseFunction

call

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

Description copied from class: BaseFunction

Should be overridden.

Specified by:

call in interface Callable

Specified by:

call in interface Function

Overrides:

call in class BaseFunction

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

construct

public Scriptable construct(Context cx,
                            Scriptable 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.

Specified by:

construct in interface Constructable

Specified by:

construct in interface Function

Overrides:

construct in class BaseFunction

Parameters:

cx - the current Context for this thread

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

isScript

public boolean isScript()

hasDefaultParameters

protected boolean hasDefaultParameters()

Overrides:

hasDefaultParameters in class BaseFunction

hasFunctionNamed

public boolean hasFunctionNamed(String name)

getFunctionName

public String getFunctionName()

Overrides:

getFunctionName in class BaseFunction

resumeGenerator

public Object resumeGenerator(Context cx,
                              Scriptable scope,
                              int operation,
                              Object state,
                              Object value)

getHomeObject

public Scriptable getHomeObject()

Specified by:

getHomeObject in interface ScriptOrFn<JSFunction>

Overrides:

getHomeObject in class BaseFunction

setHomeObject

public void setHomeObject(Scriptable homeObject)

Overrides:

setHomeObject in class BaseFunction

getFunctionThis

public Scriptable getFunctionThis(Scriptable functionThis)

createScript

public static JSScript createScript(JSDescriptor<JSScript> desc,
                                    Scriptable homeObject,
                                    Object staticSecurityDomain)

Create script from compiled bytecode.

createFunction

public static JSFunction createFunction(Context cx,
                                        Scriptable scope,
                                        JSDescriptor<JSFunction> desc,
                                        Scriptable homeObject,
                                        Object staticSecurityDomain)

Create function compiled from Function(...) constructor.

get

public Object get(String name,
                  Scriptable start)

Description copied from class: ScriptableObject

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 Scriptable

Overrides:

get in class ScriptableObject

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()