kitejs/io.github.yuroyami.kitejs/LambdaConstructor

LambdaConstructor

open class LambdaConstructor : LambdaFunction

A function that can be used as a constructor, with the construction handed off to a lambda. LambdaFunction adds the prototype methods the same way.

This is how the built-in classes are written. Upstream measured it at roughly 15% faster than IdScriptableObject and 25% faster than the reflection-based defineClass, and the resulting code reads much closer to the JavaScript it implements.

Constructors

LambdaConstructor

constructor(scope: Scriptable, name: String, length: Int, target: SerializableConstructable)

Callable both with and without new, and either way it returns a wired-up new object.

constructor(scope: Scriptable, name: String, length: Int, flags: Int, target: SerializableConstructable)

flags says which of new and a direct call are allowed. Whichever is allowed behaves the same way; the other throws a TypeError.

constructor(scope: Scriptable, name: String, length: Int, target: SerializableCallable?, targetConstructor: SerializableConstructable?)

Behaves differently with and without new: new returns a wired-up object, a direct call does whatever target says. Date is the standard example.

constructor(scope: Scriptable, name: String, length: Int, prototype: Any?, target: SerializableCallable?, targetConstructor: SerializableConstructable?)

Types

Companion

object Companion

Properties

allIds

open val allIds: Array<Any?>

Every property, enumerable or not.

arity

open override val arity: Int

What the arity property answers.

className

open override val className: String

The class name, as Object.prototype.toString reports it.

declarationScope

open val declarationScope: Scriptable?

The scope this function was declared in.

externalArrayData

val externalArrayData: ExternalArrayData?

externalArrayLength

val externalArrayLength: Any

functionName

override val functionName: String

What the name property answers. Empty for an anonymous function.

homeObject

open var homeObject: Scriptable?

The object a method was defined on, which super resolves against. Null for a plain function.

isExtensible

open val isExtensible: Boolean

isSealed

var isSealed: Boolean

length

override val length: Int

What the length property answers: how many arguments the function declares.

parentScope

open override var parentScope: Scriptable?

prototype

open override var prototype: Scriptable?

prototypeProperty

open val prototypeProperty: Any?

The prototype property: undefined when unset, null when explicitly set to null.

typeOf

open override val typeOf: String

"function", or "undefined" when avoidObjectDetection says so.

Functions

associateValue

fun associateValue(key: Any, value: Any): Any

Parks value under key, or returns what is already there.

avoidObjectDetection

open fun avoidObjectDetection(): Boolean

True for an object that has to pretend it is undefined, which only NativeWith does.

call

open override fun call(cx: Context, scope: Scriptable, thisObj: Scriptable?, args: Array<Any?>): Any?

Subclasses override this. The base does nothing.

construct

open override fun construct(cx: Context, scope: Scriptable, args: Array<Any?>): Scriptable

createObject

open fun createObject(cx: Context, scope: Scriptable): Scriptable?

Builds the object that construct passes to call as this. Returning null says that call will make the object itself, and construct then fixes up its scope and prototype.

defineBuiltinProperty

fun defineBuiltinProperty(scope: Scriptable, name: String, length: Int, target: SerializableCallable, attributes: Int = DONTENUM, propertyAttributes: Int = DONTENUM or READONLY)

Same as above for a built-in method, which does not get a prototype property.

defineConst

open override fun defineConst(name: String, start: Scriptable)

defineConstructorMethod

fun defineConstructorMethod(scope: Scriptable, key: Symbol, name: String, length: Int, target: SerializableCallable)

Upstream ignores key here and defines the method under name, which this copies.

fun defineConstructorMethod(scope: Scriptable, name: String, length: Int, target: SerializableCallable, attributes: Int = DONTENUM, propertyAttributes: Int = DONTENUM or READONLY)

fun defineConstructorMethod(scope: Scriptable, name: String, length: Int, prototype: Any?, target: SerializableCallable, attributes: Int, propertyAttributes: Int)

defineKnownBuiltInPrototypeMethod

fun defineKnownBuiltInPrototypeMethod(tag: Any, scope: Scriptable, name: String, length: Int, prototype: Any?, target: SerializableCallable, attributes: Int, propertyAttributes: Int)

Same as definePrototypeMethod, but the engine can recognise the result by its tag.

defineOwnProperties

fun defineOwnProperties(cx: Context, props: ScriptableObject)

defineOwnProperty

fun defineOwnProperty(cx: Context, id: Any?, desc: ScriptableObject): Boolean

open fun defineOwnProperty(cx: Context, id: Any?, desc: ScriptableObject.DescriptorInfo): Boolean

defineProperty

fun defineProperty(key: Symbol, value: Any?, attributes: Int)

fun defineProperty(propertyName: String, value: Any?, attributes: Int)

fun defineProperty(cx: Context, name: String, getter: ScriptableObject.LambdaGetterFunction, attributes: Int)

fun defineProperty(cx: Context, key: Symbol, getter: ScriptableObject.LambdaGetterFunction?, setter: ScriptableObject.LambdaSetterFunction?, attributes: Int)

fun defineProperty(cx: Context, name: String, getter: ScriptableObject.LambdaGetterFunction?, setter: ScriptableObject.LambdaSetterFunction?, attributes: Int)

fun defineProperty(name: String, getter: () -> Any??, setter: (Any?) -> Unit?, attributes: Int)

Defines a property whose value comes from a lambda that needs nothing but itself.

fun defineProperty(scope: Scriptable, name: String, length: Int, target: SerializableCallable, attributes: Int = DONTENUM, propertyAttributes: Int = DONTENUM or READONLY)

Defines a method backed by a Kotlin lambda.

definePrototypeAlias

fun definePrototypeAlias(name: String, alias: SymbolKey, attributes: Int)

Gives alias the same value as the property already named name.

fun definePrototypeAlias(name: String, alias: String, attributes: Int)

definePrototypeMethod

fun definePrototypeMethod(scope: Scriptable, name: SymbolKey, length: Int, target: SerializableCallable, attributes: Int = DONTENUM, propertyAttributes: Int = DONTENUM or READONLY)

fun definePrototypeMethod(scope: Scriptable, name: String, length: Int, target: SerializableCallable, attributes: Int = DONTENUM, propertyAttributes: Int = DONTENUM or READONLY)

fun definePrototypeMethod(scope: Scriptable, name: SymbolKey, length: Int, prototype: Any?, target: SerializableCallable, attributes: Int, propertyAttributes: Int)

fun definePrototypeMethod(scope: Scriptable, name: String, length: Int, prototype: Any?, target: SerializableCallable, attributes: Int, propertyAttributes: Int)

definePrototypeProperty

fun definePrototypeProperty(cx: Context, key: Symbol, descriptor: ScriptableObject)

fun definePrototypeProperty(cx: Context, name: String, descriptor: ScriptableObject)

fun definePrototypeProperty(key: Symbol, value: Any?, attributes: Int)

fun definePrototypeProperty(name: String, value: Any?, attributes: Int)

fun definePrototypeProperty(cx: Context, key: Symbol, getter: ScriptableObject.LambdaGetterFunction, attributes: Int)

fun definePrototypeProperty(cx: Context, key: Symbol, getter: ScriptableObject.LambdaGetterFunction?, setter: ScriptableObject.LambdaSetterFunction?, attributes: Int = DONTENUM)

fun definePrototypeProperty(cx: Context, name: String, getter: ScriptableObject.LambdaGetterFunction, attributes: Int = DONTENUM or READONLY)

Defines a prototype property through a getter. The result looks exactly like a property defined with Object.defineProperty and an accessor descriptor.

fun definePrototypeProperty(cx: Context, name: String, getter: ScriptableObject.LambdaGetterFunction?, setter: ScriptableObject.LambdaSetterFunction?, attributes: Int = DONTENUM)

The getter and setter pair version of definePrototypeProperty.

delete

open override fun delete(key: Symbol)

open override fun delete(index: Int)

open override fun delete(name: String)

get

operator fun get(key: Any?): Any?

open override fun get(key: Symbol, start: Scriptable): Any?

open override fun get(index: Int, start: Scriptable): Any?

Gets an indexed property, or NOT_FOUND when there is none.

open override fun get(name: String, start: Scriptable): Any?

Gets a named property, or NOT_FOUND when there is none.

getAssociatedValue

fun getAssociatedValue(key: Any): Any?

A value another part of the engine parked on this object under key.

getAttributes

open fun getAttributes(sym: Symbol): Int

open fun getAttributes(index: Int): Int

open fun getAttributes(name: String): Int

getDefaultValue

open override fun getDefaultValue(hint: KClass<*>?): Any?

Converts this object to a primitive, guided by hint.

getGetterOrSetter

fun getGetterOrSetter(name: String?, index: Int, scope: Scriptable, isSetter: Boolean): Any?

getIds

open override fun getIds(): Array<Any?>

Every property name of this object alone, ignoring the prototype chain.

has

open override fun has(key: Symbol, start: Scriptable): Boolean

open override fun has(index: Int, start: Scriptable): Boolean

open override fun has(name: String, start: Scriptable): Boolean

hasInstance

open override fun hasInstance(instance: Scriptable): Boolean

The instanceof operator for function objects: true when this function's prototype property is somewhere in instance's prototype chain.

isConst

open override fun isConst(name: String): Boolean

isEmpty

open fun isEmpty(): Boolean

preventExtensions

open fun preventExtensions(): Boolean

put

open override fun put(key: Symbol, start: Scriptable, value: Any?)

open override fun put(index: Int, start: Scriptable, value: Any?)

open override fun put(name: String, start: Scriptable, value: Any?)

putConst

open override fun putConst(name: String, start: Scriptable, value: Any?)

sealObject

fun sealObject()

Seals the object, so no property can be added, removed or changed.

setAttributes

fun setAttributes(key: Symbol, attributes: Int)

fun setAttributes(index: Int, attributes: Int)

open fun setAttributes(name: String, attributes: Int)

setExternalArrayData

fun setExternalArrayData(array: ExternalArrayData?)

Attaches data that lives outside the engine, or detaches it with null.

setGetterOrSetter

fun setGetterOrSetter(name: Any?, index: Int, getterOrSetter: Callable?, isSetter: Boolean)

setImmunePrototypeProperty

fun setImmunePrototypeProperty(value: Any?)

Makes value a non-enumerable, non-deletable, read-only prototype on this function.

setPrototypePropertyAttributes

fun setPrototypePropertyAttributes(attributes: Int)

setPrototypeScriptable

fun setPrototypeScriptable(proto: ScriptableObject)

Swaps the plain Object prototype for one of a particular kind. Only a few built-ins need this, Boolean among them, because their prototype has to carry an internal slot.

setStandardPropertyAttributes

fun setStandardPropertyAttributes(attributes: Int)

Sets the attributes of name, length and arity, which differ across the natives.

size

open fun size(): Int

Part of what java.util.Map needs. NativeObject finishes the job.