@glimmer/interfaces/lib/compile/operands.d.ts

Common interfaces shared among all @glimmer/\* projects

import type { CompilableTemplate } from '../template.js';
import type { SymbolTable } from '../tier1/symbol-table.js';
import type * as WireFormat from './wire-format/api.js';

export type LabelOperandType = 1;
export type IsStrictModeOperandType = 2;
export type DebugSymbolsOperandType = 3;
export type BlockOperandType = 4;
export type StdLibOperandType = 5;
export type NonSmallIntOperandType = 6;
export type SymbolTableOperandType = 7;
export type LayoutOperandType = 8;

export type OperandType =
  | LabelOperandType
  | IsStrictModeOperandType
  | DebugSymbolsOperandType
  | BlockOperandType
  | StdLibOperandType
  | NonSmallIntOperandType
  | SymbolTableOperandType
  | LayoutOperandType;

export interface LabelOperand {
  type: LabelOperandType;
  value: string;
}

export interface IsStrictModeOperand {
  type: IsStrictModeOperandType;
  value: undefined;
}

export interface DebugSymbolsOperand {
  type: DebugSymbolsOperandType;
  value: {
    locals: Record<string, number>;
    upvars: Record<string, number>;
    lexical: Record<string, number>;
  };
}

export interface BlockOperand {
  type: BlockOperandType;
  value: WireFormat.SerializedInlineBlock | WireFormat.SerializedBlock;
}

export interface StdLibOperand {
  type: StdLibOperandType;
  value:
    | 'main'
    | 'trusting-append'
    | 'cautious-append'
    | 'trusting-non-dynamic-append'
    | 'cautious-non-dynamic-append';
}

export interface NonSmallIntOperand {
  type: NonSmallIntOperandType;
  value: number;
}

export interface SymbolTableOperand {
  type: SymbolTableOperandType;
  value: SymbolTable;
}

export interface LayoutOperand {
  type: LayoutOperandType;
  value: CompilableTemplate;
}

export type HighLevelBuilderOperand =
  | LabelOperand
  | IsStrictModeOperand
  | DebugSymbolsOperand
  | StdLibOperand
  | BlockOperand
  | NonSmallIntOperand
  | SymbolTableOperand
  | LayoutOperand;

export type SingleBuilderOperand =
  | HighLevelBuilderOperand
  | number
  | string
  | boolean
  | undefined
  | null
  | number[]
  | string[];

export type Operand = number;

export type EncoderOperands = [] | [Operand] | [Operand, Operand] | [Operand, Operand, Operand];