Skip to content

fsmc Documentation

Overview

simoneCavalleri/fsmc

Technical Reference Hub¶

Welcome to the fsmc Technical Reference Hub. This section provides complete, normative, and syntax-level documentation for all compiler interfaces, command-line utilities, runtime types, and formal metamodels.

Reference Chapters¶

Document	Scope & Contents	Target Audience
CLI Reference	Full syntax, options, and optimization flags for `fsmc` and `fsm-opt`.	Developers, Build Engineers
Runtime C++ API Reference	Formal reference for `fsm::fsm`, `fsm::spsc_fsm`, `fsm::thread_safe_fsm`, `fsm::config`, concepts, and traits.	Firmware, Embedded Engineers
CMake Integration Reference	Macro reference (`fsmc_target_sources`), targets, and toolchain variables.	DevOps, System Integrators
Canonical IR AST Specification	Formal schema and data structures of the canonical `FsmIr` AST representation.	Compiler Contributors
Master Test Suite Catalog	Exhaustive traceability catalog of all 55 automated unit and regression test suites.	QA, Safety Auditors

graph LR
    Ref["Technical Reference Hub"] --> CLI["CLI Driver (fsmc & fsm-opt)"]
    Ref --> Cpp["C++ Runtime API Reference"]
    Ref --> CMake["CMake Build Targets"]
    Ref --> IR["Canonical FsmIr AST"]
    Ref --> Catalog["Test Suite Catalog (55 Suites)"]