Brummel
bcd41810f4
Reader-facing prose and rustdoc carried opaque shorthand like
"Decision 10", "clause-5", "mq.1", "ct.1", "eob.1", "rpe.1",
"post-mq.3", and "Iter 22b.1:" with no in-repo definition the reader
could follow. This commit replaces every such occurrence in the
durable tier the reader is most likely to land on (design/ ledger +
source //! module headers + the central /// public-item rustdoc) with
an inline content phrase plus, where applicable, a Markdown link to
the file that defines the referenced concept.
design/ ledger — 16 files:
Definition-site headings demoted from "Decision N: <title>" to
"<title>": authoring-surface, tail-calls, memory-model section in
rc-uniqueness.md, dual-allocator section, typeclass design,
effects "pure core + algebraic effects".
Cross-reference sites: "Decision 1" -> canonical-schema principle
(data-model); "Decision 3/4" -> effects + scope-boundaries; "Decision
6" -> authoring-surface; "Decision 8" -> tail-calls; "Decision 9" ->
rc-uniqueness (dual-allocator); "Decision 10" -> memory-model;
"Decision 11" -> typeclasses (model). "clause-5" -> body-link
durability gate. "clause-3" (in language-constraints) ->
bug-class-reintroduction discriminator. "mq.1/2/3", "ct.1/4",
"eob.1", "rpe.1" -> the canonical-form rule / the type-driven
dispatch / the Str carve-out / etc. "post-mq.3" -> "type-driven".
design/contracts/feature-acceptance.md: file-local "clauses 1/2/3"
-> "criteria 1/2/3" (sprachliche Kohärenz mit der File-Überschrift
"Feature-acceptance criterion"); "the clause-3 mechanism" -> "the
bug-class-reintroduction discriminator".
Source //! module headers — 24 files:
Stripped "Iter X.Y:" prefixes and "(Decision N)" / "(mq.X)" tags
from spec_drift, uniqueness, reuse_shape, migrate_canonical_types,
typeclass_22b{2,3,c}, suppress_filter, lift, mono, linearity,
diagnostic, method_dispatch_pin, method_collision_pin,
no_per_type_print_ops, mq3_multi_class_e2e, print_mono_body_shape,
print_no_leak_pin, cli_diag_human_workspace_load_error,
ct1_check_cli, prose snapshot, unbound_in_instance_method_pin,
mono_xmod_ctor_pattern, desugar.
Central /// public-item rustdoc:
ast.rs (full sweep — every "Iter X" + "Decision N" prefix
reformulated; mode/Type::Fn rustdoc now points at memory-model.md;
Constraint / SuperclassRef / InstanceDef / ClassDef rustdoc points
at typeclasses contract).
diagnostic.rs (all "(Iter X)" / "(mq.X)" tags on diagnostic codes
removed).
lib.rs (FORM_A_SPEC rustdoc points at authoring-surface.md
instead of "Decision 6").
canonical.rs (type_hash + Float-literal rustdoc).
Still outstanding (for a follow-up commit): ~500 inline `//`
code-body comments with `Iter X.Y` markers across the workspace, and
a handful of `///` rustdoc items in hash_pin / workspace_pin / lift /
mono / suppress_filter test-pin and internal-function bodies. Code
identifiers (test filenames like `mq3_multi_class_e2e.rs`, function
names like `iter18e_drop_iterative_default_preserves_hashes`) stay
verbatim per the user's "code identifiers stay verbatim" rule.
Tests: design_index_pin 5/5 + docs_honesty_pin 5/5; workspace builds
clean; full `cargo test --workspace` previously green (every
`test result: ok` line, no FAILED line).
81 lines
4.3 KiB
Markdown
81 lines
4.3 KiB
Markdown
# Pipeline and CLI
|
|
|
|
## Pipeline
|
|
|
|
```
|
|
.ail.json ─┐
|
|
├─ load + validate schema
|
|
├─ resolve names + assign hashes
|
|
├─ desugar (AST → AST)
|
|
├─ typecheck (HM, effect rows; mode-strict per the memory model)
|
|
├─ lift_letrecs (post-typecheck AST → AST)
|
|
├─ lower to MIR (SSA-like, named SSA values)
|
|
├─ emit LLVM IR (.ll)
|
|
└─ clang -O2 *.ll -o binary
|
|
--alloc=rc → emits inc/dec (@ailang_rc_inc / _dec; canonical, default)
|
|
--alloc=gc → links libgc (@GC_malloc; parity oracle)
|
|
```
|
|
|
|
Two allocator backends share the same MIR. `--alloc=rc` is the
|
|
canonical backend committed to in the
|
|
[memory model](../contracts/memory-model.md) and the CLI default.
|
|
The typechecker enforces
|
|
`(own)` / `(borrow)` modes, codegen emits `ailang_rc_inc` / `_dec`
|
|
calls at the points dictated by linearity, and `Term::Clone` /
|
|
`Term::ReuseAs` materialise into actual rc-bumps and in-place
|
|
rewrites respectively. `--alloc=gc` selects the transitional Boehm
|
|
backend (see [RC + uniqueness](rc-uniqueness.md));
|
|
`--alloc=rc` is the canonical backend and the CLI default.
|
|
|
|
The **desugar** pass
|
|
([`ailang-core::desugar::desugar_module`](../../crates/ailang-core/src/desugar.rs))
|
|
runs before typecheck and codegen in every entry point of
|
|
`ailang-check` and `ailang-codegen`. It is a pure AST → AST rewriter — currently
|
|
only flattens nested constructor patterns, but is the chosen
|
|
home for any future surface-smoothing rewrites that should not bloat
|
|
the core AST or the backends. **Critical invariant:** `CheckedModule.symbols`
|
|
in the `check` entry point continues to hash from the *original*
|
|
on-disk module, not the desugared one, so `ail diff` and `ail manifest`
|
|
report identities that match the canonical JSON the user is editing.
|
|
|
|
The **lift_letrecs** pass (`ailang-check::lift_letrecs`)
|
|
runs **after** typecheck and **before** codegen, but only on the
|
|
`build` / `run` paths — the `check` subcommand stops at typecheck
|
|
and never sees a lifted module. It eliminates every `Term::LetRec`
|
|
that the desugar pass left in place (the case where at least one
|
|
capture is `Term::Let`-bound, so its type is only knowable after
|
|
inference). The output is a module with synthetic `<hint>$lr_N`
|
|
top-level fns appended, ready for codegen. Synthetic FnDefs added
|
|
by this pass do **not** appear in `CheckedModule.symbols` — same
|
|
invariant as the desugar-pass lifts.
|
|
|
|
## CLI
|
|
|
|
```
|
|
ail check <module.ail.json> — loads, validates, typechecks
|
|
ail manifest <module.ail.json> — table: name :: type !effects [hash]
|
|
ail describe <module> <name> — detail of a definition (form-A body)
|
|
ail render <module.ail.json> — JSON-AST → form-A text (exact inverse of `parse`)
|
|
ail parse <module.ail> — form-A text → canonical JSON-AST
|
|
ail prose <module.ail.json> — JSON-AST → form-B (lossy human prose, no parser)
|
|
ail merge-prose <m.ail.json> <m.prose.txt>
|
|
— compose the LLM-mediator prompt for the prose round-trip
|
|
ail deps <module.ail.json> — list cross-module references
|
|
ail diff <a.ail.json> <b.ail.json> — content-addressed def-level diff
|
|
ail workspace <entry.ail.json> — list all modules transitively reachable from entry
|
|
(`--json` for machine output;
|
|
`manifest --workspace` and `diff --workspace`
|
|
extend single-module subcommands to workspaces)
|
|
ail builtins — list built-in fns and effect ops
|
|
ail emit-ir <module> [--emit=staticlib] — writes .ll (staticlib: a main-free kernel's IR, no @main)
|
|
ail build <module> [--emit=staticlib] — full pipeline → binary (staticlib: lib<entry>.a + libailang_rt.a)
|
|
ail run <module> — build + execute (tempdir), passthrough exit code
|
|
```
|
|
|
|
The text projections the CLI moves between are documented in
|
|
[authoring surface](../contracts/authoring-surface.md) (Form-A,
|
|
round-trippable) and [prose projection](prose-projection.md)
|
|
(Form-B, lossy, no parser); `ail build --emit=staticlib` produces
|
|
the layout fixed in [embedding ABI](../contracts/embedding-abi.md)
|
|
plus [frozen value layout](../contracts/frozen-value-layout.md).
|