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).
88 lines
3.4 KiB
Rust
88 lines
3.4 KiB
Rust
//! IR-shape pin for milestone 24.3's `print` polymorphic free fn.
|
|
//!
|
|
//! Property protected: the post-mono `print__Int` `Def::Fn.body` is
|
|
//! structurally `Term::Let { name: "s", value: App(show__Int, [x]),
|
|
//! body: Term::Do { op: "io/print_str", args: [s] } }`. The explicit
|
|
//! let-binder around `show__Int x` is load-bearing for the heap-Str RC
|
|
//! discipline (the heap-Str Str carve-out at
|
|
//! `drop_symbol_for_binder` requires
|
|
//! a let-binder to attach the rc-dec to). If a future codegen / mono
|
|
//! refactor inlines the let-binder away, this pin fires and surfaces
|
|
//! the regression BEFORE the E2E runtime stats produce a confusing
|
|
//! "memory leak" diagnostic.
|
|
//!
|
|
//! Note: `FnDef.body: Term` is the *inner* function body — top-level
|
|
//! fns carry their parameter list separately on `FnDef.params`, so no
|
|
//! outer `Term::Lam` wraps the body. This contrasts with instance
|
|
//! method bodies (which carry a `Term::Lam` because they are anonymous
|
|
//! function values inside `InstanceMethod.body`).
|
|
|
|
use ailang_core::ast::{Def, Term};
|
|
use ailang_surface::load_workspace;
|
|
use std::path::PathBuf;
|
|
|
|
fn fixture_path() -> PathBuf {
|
|
let mut d = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
|
|
d.pop();
|
|
d.pop();
|
|
d.join("examples").join("show_print_smoke.ail")
|
|
}
|
|
|
|
#[test]
|
|
fn print_int_body_preserves_explicit_let_binder() {
|
|
let ws = load_workspace(&fixture_path()).expect("workspace loads");
|
|
let diags = ailang_check::check_workspace(&ws);
|
|
assert!(diags.is_empty(), "typecheck diagnostics: {diags:?}");
|
|
let post_mono = ailang_check::monomorphise_workspace(&ws).expect("mono green");
|
|
|
|
let prelude_mod = post_mono
|
|
.modules
|
|
.get("prelude")
|
|
.expect("prelude module present");
|
|
|
|
let print_int = prelude_mod
|
|
.defs
|
|
.iter()
|
|
.find_map(|d| match d {
|
|
Def::Fn(f) if f.name == "print__Int" => Some(f),
|
|
_ => None,
|
|
})
|
|
.expect("print__Int mono symbol not found in prelude module");
|
|
|
|
// Body shape: Term::Let { name: "s",
|
|
// value: Term::App(show__Int, [x]),
|
|
// body: Term::Do { op: "io/print_str", args: [s] } }
|
|
let (let_value, let_body) = match &print_int.body {
|
|
Term::Let { name, value, body } => {
|
|
assert_eq!(name, "s", "let-binder name expected 's', got {name:?}");
|
|
(value.as_ref(), body.as_ref())
|
|
}
|
|
other => panic!(
|
|
"print__Int.body is not Term::Let — let-binder was optimised away or never inserted. Got: {other:?}"
|
|
),
|
|
};
|
|
|
|
// Inner App should reference show__Int (post-mono symbol).
|
|
let app_fn = match let_value {
|
|
Term::App { callee, .. } => callee.as_ref(),
|
|
other => panic!("print__Int let-value is not Term::App, got: {other:?}"),
|
|
};
|
|
let app_fn_name = match app_fn {
|
|
Term::Var { name } => name,
|
|
other => panic!("let-value's fn position is not Term::Var, got: {other:?}"),
|
|
};
|
|
assert_eq!(
|
|
app_fn_name, "show__Int",
|
|
"post-mono let-value should call show__Int, got: {app_fn_name}"
|
|
);
|
|
|
|
// Inner body should be a Do invoking io/print_str.
|
|
match let_body {
|
|
Term::Do { op, args, .. } => {
|
|
assert_eq!(op, "io/print_str", "let-body Do op expected 'io/print_str', got {op:?}");
|
|
assert_eq!(args.len(), 1, "io/print_str expects 1 arg, got {}", args.len());
|
|
}
|
|
other => panic!("print__Int let-body is not Term::Do, got: {other:?}"),
|
|
}
|
|
}
|