@glimmer/interfaces/lib/runtime/scope.d.ts

Common interfaces shared among all @glimmer/\* projects

import type { Nullable } from '../core.js';
import type { Reference } from '../references.js';
import type { CompilableBlock } from '../template.js';
import type { BlockSymbolTable } from '../tier1/symbol-table.js';
import type { Owner } from './owner.js';

export type Block = CompilableBlock | number;

export type ScopeBlock = [CompilableBlock, Scope, BlockSymbolTable];
export type BlockValue = ScopeBlock[0 | 1 | 2];
export type ScopeSlot = Reference | ScopeBlock | null;

export interface Scope {
  /**
   * A single program can mix and match multiple owners. This can happen component is curried from a
   * template with one owner and then rendered in a second owner.
   *
   * Note: Owners can change when new root scopes are created (including when rendering a
   * component), but not in child scopes.
   */
  readonly owner: Owner;
  // for debug only
  snapshot(): ScopeSlot[];

  getSelf(): Reference;
  getSymbol(symbol: number): Reference;
  getBlock(symbol: number): Nullable<ScopeBlock>;
  bind(symbol: number, value: ScopeSlot): void;
  bindSelf(self: Reference): void;
  bindSymbol(symbol: number, value: Reference): void;
  bindBlock(symbol: number, value: Nullable<ScopeBlock>): void;
  child(): Scope;
}

export interface DynamicScope {
  get(key: string): Reference;
  set(key: string, reference: Reference): Reference;
  child(): DynamicScope;
}