Class Environment

constructor

• new Environment(
      parent: Environment,
      isBuiltInDefault?: true | undefined,
      frame?: Frame,
  ): Environment

  Parameters

  • parent: Environment
  • isBuiltInDefault: true | undefined = undefined
  • Optionalframe: Frame

  Returns Environment

OptionalbuiltInEnv

Optionalcache

OptionalglobalEnv

Readonlyid

Optionaln

Optionalnamespaces

parent

OptionalsuperMemory

Optionalt

OptionaltailCache

closure

• get closure(): NodeId | undefined

  Provides the closure linked to this environment.

  Returns NodeId | undefined

memory

• get memory(): MemoryView

  What this frame binds.

  Returns MemoryView

writableMemory

• get writableMemory(): Frame

  memory ready to be written to. Every write goes through here, since clone shares the frame.

  Returns Frame

writableParent

• get writableParent(): Environment

  The parent, unshared first when a write is about to go through it. A clone(true) hands out the original chain and lets it materialize one frame at a time here, since a removal usually reaches only a frame or two.

  Returns Environment

adoptMap

• adoptMap(map: MemoryView): void

  Takes map as the bindings, sharing it until something writes.

  Parameters

  • map: MemoryView

  Returns void

append

• append(other: Environment | undefined): Environment

  Adds all writes of other to this environment (other's operations might happen). Always recurses parents.

  Parameters

  • other: Environment | undefined

  Returns Environment

asGlobal

• asGlobal(): this

  Marks this as the global environment (.GlobalEnv); see globalEnv.

  Returns this

asLibrary

• asLibrary(name: string, type: EnvType): this

  Marks this as an attached-package layer (see EnvType) for package name.

  Parameters

  • name: string
  • type: EnvType

  Returns this

clone

• clone(recurseParents: boolean): Environment

  Clones this, sharing memory until either side writes; the cost is the same for a frame of any size.

  Parameters

  • recurseParents: boolean

  Returns Environment

define

• define(definition: IdentifierDefinition & { name: Identifier }): Environment

  Define a new identifier definition within this environment.

  Parameters

  • definition: IdentifierDefinition & { name: Identifier }

  Returns Environment

defineAll

• defineAll(
      definitions: Iterable<IdentifierDefinition & { name: Identifier }>,
  ): Environment

  Define several identifiers at once in a more performant fashion.

  Parameters

  • definitions: Iterable<IdentifierDefinition & { name: Identifier }>

  Returns Environment

defineSuper

• defineSuper(
      definition: IdentifierDefinition & { name: Identifier },
  ): Environment

  Parameters

  • definition: IdentifierDefinition & { name: Identifier }

  Returns Environment

lookup

• lookup(name: BrandedIdentifier): IdentifierDefinition[] | undefined

  What name holds here; the chain walks of name resolution take this rather than memory.

  Parameters

  • name: BrandedIdentifier

  Returns IdentifierDefinition[] | undefined

overwrite

• overwrite(
      other: Environment | undefined,
      applyCds?: readonly ControlDependency[],
  ): Environment

  Definitions within other replace those here by name; if all of other's are maybe, they are appended instead (turning existing ones maybe too). Always recurses parents.

  Parameters

  • other: Environment | undefined
  • OptionalapplyCds: readonly ControlDependency[]

  Returns Environment

remove

• remove(id: Identifier): Environment

  Parameters

  • id: Identifier

  Returns Environment

removeAll

• removeAll(names: readonly { name: Identifier }[]): Environment

  Parameters

  • names: readonly { name: Identifier }[]

  Returns Environment

sameMemoryAs

• sameMemoryAs(other: Environment): boolean

  Whether other holds the very bindings this does.

  Parameters

  • other: Environment

  Returns boolean

setClosureNodeId

• setClosureNodeId(nodeId: NodeId): void

  please only use if you know what you are doing

  Parameters

  • nodeId: NodeId

  Returns void

standsInFor

• standsInFor(memory: MemoryView): this

  Records the lexical frame this one stands in for; see superMemory.

  Parameters

  • memory: MemoryView

  Returns this

toJSON

• toJSON(): Jsonified

  Returns Jsonified