kei-lisp - v3.0.1
    Preparing search index...

    Class LispInterpreter

    Class for the interpreter.

    Keisuke Ikeda

    Hierarchy

    • Object
      • LispInterpreter
    Index
    constructor: Function

    The initial value of Object.prototype.constructor is the standard built-in Object constructor.

    plugins: KeiLispPlugin[]

    Registered plugins consulted by the evaluator on every call. See use.

    root: Table

    The root (top-level) environment table, pre-populated with built-in symbols.

    streamManager: StreamManager

    The stream manager that owns the interpreter's output / spy streams.

    • Evaluates the given expression and returns the result. Throws ParseError, EvalError, or ExitError on failure; library users are expected to catch these (see the KeiLispError base class for the parse/eval family).

      Parameters

      • aCons: LispValue

        the expression to evaluate

      Returns LispValue

      the evaluation result

    • Parses the source string, evaluates every expression it contains, and returns the results as an array.

      Parameters

      • source: string

        the Lisp source string

      Returns LispValue[]

      the array of evaluation results, one per top-level expression

    • Parses and evaluates the source string and returns the value of the last expression.

      Parameters

      • source: string

        the Lisp source string

      Returns LispValue

      the value of the last expression, or Cons.nil for empty input

    • Determines whether an object has a property with the specified name.

      Parameters

      • v: PropertyKey

        A property name.

      Returns boolean

    • Builds the root environment table by pre-registering every built-in symbol and the small set of bootstrap lambdas (append / butlast / nthcdr / reverse).

      Returns Table

      the freshly initialized root environment

    • Determines whether an object exists in another object's prototype chain.

      Parameters

      • v: Object

        Another object whose prototype chain is to be checked.

      Returns boolean

    • Parses the given string into a list of top-level expressions and returns it. The result is always a Cons (possibly Cons.nil for empty input) because the source is wrapped in an outer list before parsing. Throws ParseError if the source cannot be parsed.

      Parameters

      • aString: string

        the Lisp source string

      Returns Cons

      a Cons containing the parsed top-level expressions

    • Determines whether a specified property is enumerable.

      Parameters

      • v: PropertyKey

        A property name.

      Returns boolean

    • Returns a date converted to a string using the current locale.

      Returns string

    • Returns a string representation of an object.

      Returns string

    • Registers a plugin. Subsequent eval calls will consult the plugin chain (in registration order, first match wins) when no special form matches a symbol, before falling through to the Applier built-ins.

      Parameters

      Returns this

      this interpreter, for chaining

    • Returns the primitive value of the specified object.

      Returns Object

    • Copy the values of all of the enumerable own properties from one or more source objects to a target object. Returns the target object.

      Type Parameters

      • T extends {}
      • U

      Parameters

      • target: T

        The target object to copy to.

      • source: U

        The source object from which to copy properties.

      Returns T & U

    • Copy the values of all of the enumerable own properties from one or more source objects to a target object. Returns the target object.

      Type Parameters

      • T extends {}
      • U
      • V

      Parameters

      • target: T

        The target object to copy to.

      • source1: U

        The first source object from which to copy properties.

      • source2: V

        The second source object from which to copy properties.

      Returns T & U & V

    • Copy the values of all of the enumerable own properties from one or more source objects to a target object. Returns the target object.

      Type Parameters

      • T extends {}
      • U
      • V
      • W

      Parameters

      • target: T

        The target object to copy to.

      • source1: U

        The first source object from which to copy properties.

      • source2: V

        The second source object from which to copy properties.

      • source3: W

        The third source object from which to copy properties.

      Returns T & U & V & W

    • Copy the values of all of the enumerable own properties from one or more source objects to a target object. Returns the target object.

      Parameters

      • target: object

        The target object to copy to.

      • ...sources: any[]

        One or more source objects from which to copy properties

      Returns any

    • Creates an object that has the specified prototype or that has null prototype.

      Parameters

      • o: object | null

        Object to use as a prototype. May be null.

      Returns any

    • Creates an object that has the specified prototype, and that optionally contains specified properties.

      Parameters

      • o: object | null

        Object to use as a prototype. May be null

      • properties: PropertyDescriptorMap & ThisType<any>

        JavaScript object that contains one or more property descriptors.

      Returns any

    • Adds one or more properties to an object, and/or modifies attributes of existing properties.

      Type Parameters

      • T

      Parameters

      • o: T

        Object on which to add or modify the properties. This can be a native JavaScript object or a DOM object.

      • properties: PropertyDescriptorMap & ThisType<any>

        JavaScript object that contains one or more descriptor objects. Each descriptor object describes a data property or an accessor property.

      Returns T

    • Adds a property to an object, or modifies attributes of an existing property.

      Type Parameters

      • T

      Parameters

      • o: T

        Object on which to add or modify the property. This can be a native JavaScript object (that is, a user-defined object or a built in object) or a DOM object.

      • p: PropertyKey

        The property name.

      • attributes: PropertyDescriptor & ThisType<any>

        Descriptor for the property. It can be for a data property or an accessor property.

      Returns T

    • Returns an array of key/values of the enumerable own properties of an object

      Type Parameters

      • T

      Parameters

      • o: { [s: string]: T } | ArrayLike<T>

        Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

      Returns [string, T][]

    • Returns an array of key/values of the enumerable own properties of an object

      Parameters

      • o: {}

        Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

      Returns [string, any][]

    • Prevents the modification of existing property attributes and values, and prevents the addition of new properties.

      Type Parameters

      • T extends Function

      Parameters

      • f: T

        Object on which to lock the attributes.

      Returns T

    • Prevents the modification of existing property attributes and values, and prevents the addition of new properties.

      Type Parameters

      • T extends { [idx: string]: object | U | null | undefined }
      • U extends string | number | bigint | boolean | symbol

      Parameters

      • o: T

        Object on which to lock the attributes.

      Returns Readonly<T>

    • Prevents the modification of existing property attributes and values, and prevents the addition of new properties.

      Type Parameters

      • T

      Parameters

      • o: T

        Object on which to lock the attributes.

      Returns Readonly<T>

    • Returns an object created by key-value entries for properties and methods

      Type Parameters

      • T = any

      Parameters

      • entries: Iterable<readonly [PropertyKey, T]>

        An iterable object that contains key-value entries for properties and methods.

      Returns { [k: string]: T }

    • Returns an object created by key-value entries for properties and methods

      Parameters

      • entries: Iterable<readonly any[]>

        An iterable object that contains key-value entries for properties and methods.

      Returns any

    • Gets the own property descriptor of the specified object. An own property descriptor is one that is defined directly on the object and is not inherited from the object's prototype.

      Parameters

      • o: any

        Object that contains the property.

      • p: PropertyKey

        Name of the property.

      Returns PropertyDescriptor | undefined

    • Returns an object containing all own property descriptors of an object

      Type Parameters

      • T

      Parameters

      • o: T

        Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

      Returns { [P in string | number | symbol]: TypedPropertyDescriptor<T[P]> } & {
          [x: string]: PropertyDescriptor;
      }

    • Returns the names of the own properties of an object. The own properties of an object are those that are defined directly on that object, and are not inherited from the object's prototype. The properties of an object include both fields (objects) and functions.

      Parameters

      • o: any

        Object that contains the own properties.

      Returns string[]

    • Returns an array of all symbol properties found directly on object o.

      Parameters

      • o: any

        Object to retrieve the symbols from.

      Returns symbol[]

    • Returns the prototype of an object.

      Parameters

      • o: any

        The object that references the prototype.

      Returns any

    • Determines whether an object has a property with the specified name.

      Parameters

      • o: object

        An object.

      • v: PropertyKey

        A property name.

      Returns boolean

    • Returns true if the values are the same value, false otherwise.

      Parameters

      • value1: any

        The first value.

      • value2: any

        The second value.

      Returns boolean

    • Returns a value that indicates whether new properties can be added to an object.

      Parameters

      • o: any

        Object to test.

      Returns boolean

    • Returns true if existing property attributes and values cannot be modified in an object, and new properties cannot be added to the object.

      Parameters

      • o: any

        Object to test.

      Returns boolean

    • Returns true if existing property attributes cannot be modified in an object and new properties cannot be added to the object.

      Parameters

      • o: any

        Object to test.

      Returns boolean

    • Returns the names of the enumerable string properties and methods of an object.

      Parameters

      • o: object

        Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

      Returns string[]

    • Returns the names of the enumerable string properties and methods of an object.

      Parameters

      • o: {}

        Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

      Returns string[]

    • Prevents the addition of new properties to an object.

      Type Parameters

      • T

      Parameters

      • o: T

        Object to make non-extensible.

      Returns T

    • Prevents the modification of attributes of existing properties, and prevents the addition of new properties.

      Type Parameters

      • T

      Parameters

      • o: T

        Object on which to lock the attributes.

      Returns T

    • Sets the prototype of a specified object o to object proto or null. Returns the object o.

      Parameters

      • o: any

        The object to change its prototype.

      • proto: object | null

        The value of the new prototype or null.

      Returns any

    • Returns an array of values of the enumerable own properties of an object

      Type Parameters

      • T

      Parameters

      • o: { [s: string]: T } | ArrayLike<T>

        Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

      Returns T[]

    • Returns an array of values of the enumerable own properties of an object

      Parameters

      • o: {}

        Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

      Returns any[]