Interface PlantGenerationObserver

High-level optional lifecycle observer.

interface PlantGenerationObserver {
    onBranchEmitted?(segment: BranchSegment): void;
    onDerivationCompleted?(result: DerivationResult): void;
    onDerivationStarted?(word: readonly ModuleSymbol[]): void;
    onDiagnosticEmitted?(diagnostic: Diagnostic): void;
    onGenerationCancelled?(): void;
    onGenerationStep?(
        generation: number,
        symbolCount: number,
        workUnits: number,
    ): void;
    onOrganEmitted?(organ: GeneratedOrgan): void;
    onSymbolRewritten?(
        source: ModuleSymbol,
        successor: readonly ModuleSymbol[],
        productionId?: string,
    ): void;
    onTopologyEvent?(event: "interpreted" | "geometry-complete"): void;
}

Hierarchy (View Summary)

GenerationObserver
- PlantGenerationObserver

Index

Methods

onBranchEmitted? onDerivationCompleted? onDerivationStarted? onDiagnosticEmitted? onGenerationCancelled? onGenerationStep? onOrganEmitted? onSymbolRewritten? onTopologyEvent?

Methods

`Optional`onBranchEmitted

onBranchEmitted?(segment: BranchSegment): void
Called as each renderer-neutral branch segment is emitted.
Parameters
- segment: BranchSegment
Returns void
- Defined in runtime/generator.ts:62

`Optional`onDerivationCompleted

onDerivationCompleted?(result: DerivationResult): void
Called after synchronous derivation completes.
Parameters
- result: DerivationResult
Returns void
Inherited from GenerationObserver.onDerivationCompleted
- Defined in core/grammar.ts:88

`Optional`onDerivationStarted

onDerivationStarted?(word: readonly ModuleSymbol[]): void
Called once before the first parallel rewrite.
Parameters
- word: readonly ModuleSymbol[]
Returns void
Inherited from GenerationObserver.onDerivationStarted
- Defined in core/grammar.ts:82

`Optional`onDiagnosticEmitted

onDiagnosticEmitted?(diagnostic: Diagnostic): void
Called for every diagnostic included in the generation result.
Parameters
- diagnostic: Diagnostic
Returns void
- Defined in runtime/generator.ts:68

`Optional`onGenerationCancelled

onGenerationCancelled?(): void
Called when cooperative cancellation stops generation.

Returns void
Inherited from GenerationObserver.onGenerationCancelled
- Defined in core/grammar.ts:90

`Optional`onGenerationStep

onGenerationStep?(
    generation: number,
    symbolCount: number,
    workUnits: number,
): void
Called after a complete generation has been assembled.
Parameters
- generation: number
- symbolCount: number
- workUnits: number
Returns void
Inherited from GenerationObserver.onGenerationStep
- Defined in core/grammar.ts:86

`Optional`onOrganEmitted

onOrganEmitted?(organ: GeneratedOrgan): void
Called as each generated organ socket is emitted.
Parameters
- organ: GeneratedOrgan
Returns void
- Defined in runtime/generator.ts:64

`Optional`onSymbolRewritten

onSymbolRewritten?(
    source: ModuleSymbol,
    successor: readonly ModuleSymbol[],
    productionId?: string,
): void
Called for each source symbol after its successor is selected.
Parameters
- source: ModuleSymbol
- successor: readonly ModuleSymbol[]
- OptionalproductionId: string
Returns void
Inherited from GenerationObserver.onSymbolRewritten
- Defined in core/grammar.ts:84

`Optional`onTopologyEvent

onTopologyEvent?(event: "interpreted" | "geometry-complete"): void
Called at coarse topology and geometry phase boundaries.
Parameters
- event: "interpreted" | "geometry-complete"
Returns void
- Defined in runtime/generator.ts:66