Skip to main content

blue_lang_runtime/
pipeline.rs

1//! The blue pipeline: **parse → check → erase → run**, in that order, once.
2//!
3//! The order is the whole reason this module exists. Each stage is available
4//! separately for tools that want one, but the *default* path is a single
5//! function, because two of the four orderings are silently wrong:
6//!
7//! - **Erase before check** discards every annotation, so a program with type
8//!   errors passes. The checker sees `(define …)` and has nothing to check.
9//! - **Run before check** reports a type error after the side effects.
10//!
11//! Neither fails loudly. Both produce a green run on a program that should
12//! have been rejected. Leaving the order to each caller means every caller
13//! is one reordering away from turning the type checker off — so the order
14//! lives here, and callers ask for a *result*, not a sequence of steps.
15
16use tatara_lisp::Sexp;
17use tatara_lisp_eval::Value;
18
19use blue_lang_check::{NameTable, Namespace};
20
21use crate::erase::erase_types;
22use crate::inputs::Inputs;
23use crate::uses::Entry;
24
25/// Why a run stopped short.
26#[derive(Debug, thiserror::Error)]
27pub enum RunError {
28    #[error("parse error: {0}")]
29    Parse(String),
30    /// The check stage rejected the program — a type error, an unbound name,
31    /// or any other error-severity rule in `blue_lang_check::RULES`. Carries
32    /// every error, not just the first: a caller fixing one wants to see the
33    /// rest. (The variant keeps its first name because it is public API on a
34    /// released crate.)
35    ///
36    /// Each one is already rendered `file:line:col: message` against the file
37    /// the offending form came from — which, in a program with imports, is
38    /// frequently not the file the user named. The rendering happens here
39    /// rather than at the consumer because here is where the file table exists;
40    /// see `uses::ResolvedProgram::locate`.
41    #[error("{} error(s) in the check stage:\n{}", .0.len(), .0.join("\n"))]
42    Types(Vec<String>),
43    /// **No longer reachable, and that is the point.** This reported "blue
44    /// emitted a tree the reader could not read back" — a failure only a
45    /// print-then-reparse hop could have. [`crate::lower_to_spanned`] deleted
46    /// the hop, so there is nothing left to fail: the tree the evaluator gets
47    /// IS the tree erasure produced, not a re-reading of its text.
48    ///
49    /// Kept rather than removed because it is public API on a released crate
50    /// and a consumer may still match on it, per ★★ MODULARIZE, DON'T DELETE.
51    /// It is retired, not orphaned — if a future stage ever serialises again
52    /// it has a typed home. **Nothing constructs it today**; do not read its
53    /// presence as evidence the pipeline can still fail this way.
54    #[error("the emitted tatara-lisp could not be read back: {0}")]
55    Lower(String),
56    /// The program ran and raised.
57    ///
58    /// Rendered `file:line:col: message`, then the blue call stack the error
59    /// unwound through, innermost first (`crate::observe::Fault`). The
60    /// position is resolved against the file of the innermost frame's
61    /// definition, so a raise inside a callee from another file names the
62    /// callee's file and line; before the stack existed that case could only
63    /// name the caller's file, with no position.
64    #[error("runtime error: {0}")]
65    Eval(Box<crate::observe::Fault>),
66    /// A `use("name")` could not be resolved.
67    ///
68    /// Its own variant rather than folded into `Parse`, because the reader's
69    /// next action is different: a parse error is in the source in front of
70    /// them, an import error is in their packaging — a missing bidama, a
71    /// BLUE_PATH that does not contain it, or no loader at all.
72    #[error("import error: {0}")]
73    Import(String),
74}
75
76/// What a run produced, plus what the checker did on the way.
77#[derive(Debug)]
78pub struct Run {
79    pub value: Value,
80    /// Nodes the type walk visited. Zero for a fully untyped program — this
81    /// is what makes "no annotations, no analysis" a *measurement* rather
82    /// than a claim.
83    pub visited: usize,
84    /// Declarations that carried an annotation.
85    pub typed_decls: usize,
86    /// Boundaries where typed code meets untyped code.
87    pub seams: usize,
88}
89
90/// Parse blue source to tatara-lisp forms.
91pub fn parse(src: &str) -> Result<Vec<Sexp>, RunError> {
92    parse_with_depth(src, blue_lang_syntax::MAX_EXPR_DEPTH)
93}
94
95/// [`parse`] with the parser's nesting bound supplied by the caller.
96///
97/// The bound exists so a stack overflow — which `catch_unwind` cannot catch —
98/// arrives as a typed `Err` instead. It is a *limit*, not a dialect: raising
99/// it changes no program's meaning, which is exactly why it is safe to expose
100/// as configuration (`blue-lang-cli`'s `config` module holds the rule).
101pub fn parse_with_depth(src: &str, max_depth: usize) -> Result<Vec<Sexp>, RunError> {
102    blue_lang_syntax::parse_program_with_depth(src, max_depth)
103        .map_err(|e| RunError::Parse(e.to_string()))
104}
105
106/// [`parse_with_depth`] keeping **every node's** source span.
107///
108/// The door for anything that will report a position to a human. It exists here,
109/// beside the spanless one, so a caller that wants spans still parses under the
110/// CONFIGURED nesting bound — a separate `blue_lang_syntax` call would be the
111/// second door `parse_with_depth`'s own docs exist to prevent, with
112/// `max_expr_depth` true of some subcommands and not others.
113pub fn parse_tree_with_depth(
114    src: &str,
115    max_depth: usize,
116) -> Result<Vec<blue_lang_syntax::Spanned>, RunError> {
117    blue_lang_syntax::parse_program_tree_with_depth(src, max_depth)
118        .map_err(|e| RunError::Parse(e.to_string()))
119}
120
121/// [`parse`] keeping **every node's** source span.
122///
123/// The spanned twin of [`parse`], at the same default bound — the door for
124/// anything downstream of a parse that will report a position, which since
125/// `use` learned to carry file identity is every path through
126/// [`run_in_surface`].
127pub fn parse_tree(src: &str) -> Result<Vec<blue_lang_syntax::Spanned>, RunError> {
128    parse_tree_with_depth(src, blue_lang_syntax::MAX_EXPR_DEPTH)
129}
130
131/// Run blue source with no build inputs.
132pub fn run(src: &str) -> Result<Run, RunError> {
133    run_with_inputs(src, Inputs::new())
134}
135
136/// Run blue source, giving the macro phase access to verified build inputs.
137///
138/// `inputs` is already verified — [`Inputs`] cannot hold bytes that do not match
139/// their declared hash — so nothing here re-checks. The capability a macro gains
140/// is exactly "these hashed bytes", never a path.
141pub fn run_with_inputs(src: &str, inputs: Inputs) -> Result<Run, RunError> {
142    run_with_loader(src, inputs, &crate::uses::NoLoader)
143}
144
145/// Run blue source with a loader, so `use("name")` can resolve.
146///
147/// Split from [`run_with_inputs`] rather than folded into it because loading a
148/// package reads a filesystem, and this crate has a `wasm32-unknown-unknown`
149/// consumer with zero host imports. The capability is injected by callers that
150/// have it — `blue_lang_pkg::LoadPath` is the real one — and absent by default,
151/// where a `use` is a typed error naming the package.
152pub fn run_with_loader(
153    src: &str,
154    inputs: Inputs,
155    loader: &dyn crate::uses::Loader,
156) -> Result<Run, RunError> {
157    run_in_surface(Entry::anonymous(src), inputs, loader, None)
158}
159
160/// Run blue source written in a `yakugo` surface.
161///
162/// The pack applies at PARSE time and nowhere else — by the time the checker
163/// sees the program it is canonical, so every stage below is identical whatever
164/// surface the author wrote in. That is what makes a surface a surface: it
165/// changes how a program is spelled and nothing about how it runs.
166///
167/// `entry` carries the source AND the file it was read from, because a type
168/// error has to be reported somewhere: a caller with a path should pass it, and
169/// one without ([`Entry::anonymous`]) gets diagnostics that say so rather than
170/// diagnostics that guess. Imported packages name themselves through the
171/// loader either way.
172///
173/// # Errors
174///
175/// As [`run_with_loader`].
176pub fn run_in_surface(
177    entry: Entry<'_>,
178    inputs: Inputs,
179    loader: &dyn crate::uses::Loader,
180    surface: Option<&blue_lang_syntax::yakugo::Yakugo>,
181) -> Result<Run, RunError> {
182    run_framed(entry, inputs, loader, surface, None)
183}
184
185/// [`run_in_surface`] held to `frame` when one is given: a host name the
186/// frame does not grant, written in the entry file, refuses the program
187/// before it runs, and one reached through a bidama or a spawned process is
188/// refused where it is called. `None` runs with every capability.
189///
190/// # Errors
191///
192/// As [`run_with_loader`], and [`RunError::Types`] naming each host name the
193/// entry file writes that `frame` does not grant.
194pub fn run_framed(
195    entry: Entry<'_>,
196    inputs: Inputs,
197    loader: &dyn crate::uses::Loader,
198    surface: Option<&blue_lang_syntax::yakugo::Yakugo>,
199    frame: Option<&blue_lang_waku::Waku>,
200) -> Result<Run, RunError> {
201    // The interpreter is built BEFORE the check stage, because it is the check
202    // stage's name oracle: every builtin, macro and special form a program may
203    // name is read off the interpreter that will run it, never off a list.
204    // Building it is not a stage; nothing is evaluated until `eval_prepared`.
205    let mut interp =
206        crate::timings::stage(crate::timings::Stage::Runtime, crate::interpreter_hostless);
207    crate::inputs::install_input_primitives(&mut interp, inputs);
208    let builtins = crate::timings::stage(crate::timings::Stage::Names, || builtin_names(&interp));
209    let prepared = prepare(entry, loader, surface, &builtins)?;
210    if let Some(frame) = frame {
211        let refused = crate::ungranted_host_names(frame);
212        let escapes = entry_escapes(&prepared.program, &refused);
213        if !escapes.is_empty() {
214            return Err(RunError::Types(escapes));
215        }
216        crate::refuse_host_names(&mut interp, &refused, "this run's --allow");
217        crate::attach_node_in_frame(&mut interp, frame);
218    }
219    let mut value = crate::timings::stage(crate::timings::Stage::Eval, || {
220        eval_prepared(&mut interp, &prepared, &mut ())
221    })?;
222    if let Some(v) = crate::timings::stage(crate::timings::Stage::Main, || {
223        call_main(&mut interp, &prepared, &mut ())
224    })? {
225        value = v;
226    }
227    Ok(Run {
228        value,
229        visited: prepared.visited,
230        typed_decls: prepared.typed_decls,
231        seams: prepared.seams,
232    })
233}
234
235fn entry_escapes(
236    program: &crate::uses::ResolvedProgram,
237    refused: &[(&'static str, &'static str)],
238) -> Vec<String> {
239    use crate::uses::ResolvedProgram;
240    let forms: Vec<tatara_lisp::Spanned> = program
241        .forms()
242        .iter()
243        .enumerate()
244        .filter(|(i, _)| program.owner_of(*i) == Some(ResolvedProgram::ENTRY))
245        .map(|(_, f)| f.clone())
246        .collect();
247    let label = |name: &str| refused.iter().find(|(n, _)| *n == name).map(|(_, l)| *l);
248    blue_lang_waku::free_names(&forms, &|name| label(name).is_none())
249        .into_iter()
250        .filter_map(|name| {
251            let cap = label(&name)?;
252            let at = program
253                .file(ResolvedProgram::ENTRY)
254                .and_then(|f| f.path.clone())
255                .map_or_else(|| "<entry>".to_string(), |p| p.display().to_string());
256            Some(format!(
257                "{at}: refused: `{name}` reaches the host ({cap}), which this run does not allow; pass --allow {cap} to grant it"
258            ))
259        })
260        .collect()
261}
262
263/// A run watched by a call observer, and the definitions the observer was
264/// built over.
265pub struct Observed {
266    pub definitions: std::sync::Arc<crate::observe::Definitions>,
267    /// The run itself: its value, or the error it stopped on.
268    pub outcome: Result<Run, RunError>,
269}
270
271/// [`run_in_surface`] with a call observer installed for the evaluation.
272/// `watch` builds the observer from the program's definitions once every stage
273/// before evaluation has passed; the profiler, the tracer and coverage are
274/// all built this way (`crate::observe::Recorder`).
275///
276/// # Errors
277///
278/// A parse, import or check error, which leaves nothing to run. A runtime
279/// error is the [`Observed::outcome`], so what ran before it is still read.
280pub fn run_observed(
281    entry: Entry<'_>,
282    inputs: Inputs,
283    loader: &dyn crate::uses::Loader,
284    surface: Option<&blue_lang_syntax::yakugo::Yakugo>,
285    watch: impl FnOnce(
286        &std::sync::Arc<crate::observe::Definitions>,
287    ) -> std::sync::Arc<dyn crate::observe::CallObserver>,
288) -> Result<Observed, RunError> {
289    let mut interp = crate::interpreter_hostless();
290    crate::inputs::install_input_primitives(&mut interp, inputs);
291    let prepared = prepare(entry, loader, surface, &builtin_names(&interp))?;
292    let definitions = std::sync::Arc::new(crate::observe::Definitions::of(
293        &prepared.program,
294        &prepared.erased,
295    ));
296    interp.set_call_observer(Some(watch(&definitions)));
297    let outcome = eval_prepared(&mut interp, &prepared, &mut ())
298        .and_then(|value| Ok(call_main(&mut interp, &prepared, &mut ())?.unwrap_or(value)))
299        .map(|value| Run {
300            value,
301            visited: prepared.visited,
302            typed_decls: prepared.typed_decls,
303            seams: prepared.seams,
304        });
305    interp.set_call_observer(None);
306    Ok(Observed {
307        definitions,
308        outcome,
309    })
310}
311
312/// A program past every stage before evaluation: parsed, its imports
313/// resolved, type-checked and erased. What [`run_in_surface`] and
314/// [`crate::hosted::load_hosted`] both evaluate, so the stage order this
315/// module exists to own is written once for both.
316pub(crate) struct Prepared {
317    program: crate::uses::ResolvedProgram,
318    erased: Vec<tatara_lisp::Spanned>,
319    visited: usize,
320    typed_decls: usize,
321    seams: usize,
322}
323
324impl Prepared {
325    /// The forms the evaluator will run: every file's, resolved and erased.
326    pub(crate) fn erased(&self) -> &[tatara_lisp::Spanned] {
327        &self.erased
328    }
329
330    /// The entry file's namespace.
331    pub(crate) fn entry_namespace(&self) -> Namespace {
332        let first = (0..self.program.forms().len())
333            .find(|i| self.program.owner_of(*i) == Some(crate::uses::ResolvedProgram::ENTRY));
334        match first {
335            Some(i) => namespace_of(&self.program, i),
336            None => match self
337                .program
338                .file(crate::uses::ResolvedProgram::ENTRY)
339                .and_then(|f| f.package.clone())
340            {
341                Some(p) => Namespace::Bidama(p),
342                None => Namespace::File(String::new()),
343            },
344        }
345    }
346}
347
348/// Parse, resolve, check and erase, in that order.
349///
350/// `builtins` is the name table of the interpreter that will evaluate the
351/// result ([`builtin_names`]); the check stage resolves the program's names
352/// against it.
353pub(crate) fn prepare(
354    entry: Entry<'_>,
355    loader: &dyn crate::uses::Loader,
356    surface: Option<&blue_lang_syntax::yakugo::Yakugo>,
357    builtins: &NameTable,
358) -> Result<Prepared, RunError> {
359    let mut program = parse_and_resolve(entry, loader, surface)?;
360
361    // `test` blocks are declarations for the harness, not code to run.
362    //
363    // Dropped here rather than in `resolve_uses`, because `blue test` calls
364    // the resolver and then NEEDS the entry file's blocks — so the two
365    // callers want different things and the split has to live at this level.
366    //
367    // Without this, `blue run` on a file containing its own tests fails with
368    // `unbound symbol: deftest`: every package in the bidama distribution
369    // carries tests, so every one of them was unrunnable.
370    //
371    // Through `retain`, which drops each form's owner with it. A plain filter
372    // over the forms alone would slide every later form onto the wrong file.
373    program.retain(|f| !crate::uses::is_test_form(f));
374
375    // CHECK, on the annotated tree — the only tree that has annotations.
376    //
377    // **On the REAL spanned tree, including every imported package's.** This
378    // was the one caller that checked a spanless lift, because `resolve_uses`
379    // flattened the entry file and its imports into one list and `Span` is a
380    // byte range with no file identity — so a real span here would have
381    // reported an imported package's error at that offset in the ENTRY file, a
382    // precise-looking answer pointing at unrelated code.
383    //
384    // The fix is not a wider `Span` (that type is upstream, and its own docs
385    // put file identity on the caller: spans "are meaningful only relative to
386    // the string that produced them, which the caller is responsible for
387    // holding onto"). blue holds onto it BESIDE the span, per top-level form —
388    // see `uses::ResolvedProgram`.
389    let (outcome, names) = crate::timings::stage(crate::timings::Stage::Check, || {
390        check_stage(&program, builtins, false)
391    });
392    if !outcome.ok() {
393        return Err(RunError::Types(
394            outcome
395                .errors()
396                // `file:line:col: error[CODE]: message`, resolved against the
397                // file the form actually came from, then its help line.
398                .map(|d| render(&program, d))
399                .collect(),
400        ));
401    }
402
403    // ERASE, so the interpreter never sees a type — **on the spanned tree,
404    // and back out as one.**
405    //
406    // This used to be `erase_types(&program.sexps())` followed by a
407    // `lower_to_spanned` that stamped `Span::synthetic()` over every node, and
408    // the comment here said carrying real positions through was "a larger
409    // piece and is NOT built". It was not larger: erasure only ever DELETES
410    // nodes — the single node it invents is the `define` replacing
411    // `define-typed` — so there was never anything for a synthetic span to
412    // stand in for. See `crate::erase`.
413    //
414    // No lowering step follows. The tree the evaluator receives IS the tree the
415    // parser built, minus annotations, with the author's byte offsets intact.
416    let erased = crate::timings::stage(crate::timings::Stage::Erase, || {
417        erase_types(&lower(&program, &names))
418    });
419
420    Ok(Prepared {
421        program,
422        erased,
423        visited: outcome.stats.visited,
424        typed_decls: outcome.stats.typed_decls,
425        seams: outcome.seams.len(),
426    })
427}
428
429/// Parse the entry (in `surface`, if one is given) and splice in its imports.
430pub(crate) fn parse_and_resolve(
431    entry: Entry<'_>,
432    loader: &dyn crate::uses::Loader,
433    surface: Option<&blue_lang_syntax::yakugo::Yakugo>,
434) -> Result<crate::uses::ResolvedProgram, RunError> {
435    let forms = crate::timings::stage(crate::timings::Stage::Parse, || {
436        let mut forms = match surface {
437            Some(pack) => blue_lang_syntax::parse_program_tree_in(entry.text, pack)
438                .map_err(|e| RunError::Parse(e.to_string()))?,
439            None => loader
440                .parse(entry.text)
441                .map_err(|e| RunError::Parse(e.to_string()))?,
442        };
443        // Every `@doc` example is a `test` block of the entry file: checked with
444        // the file's names, run by `blue test`, dropped by `run` with the others.
445        if surface.is_none() {
446            forms.extend(
447                blue_lang_syntax::doc::doctests(entry.text)
448                    .map_err(|e| RunError::Parse(e.to_string()))?,
449            );
450        }
451        Ok::<_, RunError>(forms)
452    })?;
453
454    // RESOLVE imports first, so everything below sees ONE program.
455    //
456    // Before the check on purpose: imported code is type-checked at the point
457    // its consumer imports it, rather than at whatever later moment its code
458    // first runs. A package that does not typecheck should break its importer's
459    // build, not their production run.
460    //
461    // One program, but not one FILE: the result records which file each
462    // top-level form came from, which is what lets a diagnostic below name a
463    // place instead of only a problem.
464    crate::timings::stage(crate::timings::Stage::Resolve, || {
465        crate::uses::resolve_uses(forms, entry, loader).map_err(RunError::Import)
466    })
467}
468
469/// **The check stage**: every rule in `blue_lang_check::RULES`, over a
470/// resolved program, with waivers applied.
471///
472/// One function, called by every door — `run`, the hosted loader, `blue test`
473/// and `blue check` — so a rule added to the registry is enforced by all of
474/// them at once. That is what makes an architecture rule a pipeline error
475/// rather than an optional report: there is no door that skips it.
476///
477/// Warnings (unused bindings, unused waivers) are reported for the ENTRY
478/// file only; an imported package's warnings belong to its author. Errors
479/// are reported for every file, because an imported package with one is
480/// broken for its importer.
481pub(crate) fn check_stage(
482    program: &crate::uses::ResolvedProgram,
483    builtins: &NameTable,
484    with_tests: bool,
485) -> (blue_lang_check::Outcome, NameTable) {
486    use crate::uses::ResolvedProgram;
487    let forms = program.forms();
488    let is_entry = |i: usize| program.owner_of(i) == Some(ResolvedProgram::ENTRY);
489
490    // Rules B0003–B0005: the typing ladder.
491    let mut outcome = blue_lang_check::check_program_in(forms, &|a, b| {
492        program.owner_of(a) == program.owner_of(b)
493    });
494    outcome
495        .diagnostics
496        .extend(data_law_diagnostics(program, &is_entry));
497
498    // Rules B0001–B0002: names. The program's own scopes come first (the
499    // entry file, then each bidama in import order), then the interpreter's.
500    let table = program_names(program, builtins);
501    let whole = |i: usize| with_tests && is_entry(i);
502    let (names, resolved) = blue_lang_check::names::check_names_whole(
503        forms,
504        &table,
505        &|i| namespace_of(program, i),
506        &is_entry,
507        &whole,
508    );
509    let stored = program
510        .file(ResolvedProgram::ENTRY)
511        .is_some_and(|f| f.path.is_some());
512    outcome.diagnostics.extend(names);
513    outcome.stats.names_resolved = resolved;
514    if stored {
515        let script = program
516            .file(ResolvedProgram::ENTRY)
517            .is_some_and(|f| f.package.is_none());
518        let found = blue_lang_check::form_rules::check(forms, &is_entry, script);
519        let silenced: Vec<tatara_lisp::Span> = found
520            .iter()
521            .filter(|d| d.code == blue_lang_check::Code::B0038)
522            .map(|d| d.span)
523            .collect();
524        outcome
525            .diagnostics
526            .retain(|d| !(d.code == blue_lang_check::Code::B0002 && silenced.contains(&d.span)));
527        outcome.diagnostics.extend(found);
528    }
529    outcome
530        .diagnostics
531        .extend(blue_lang_check::contracts::check(
532            forms,
533            &table,
534            &|i| namespace_of(program, i),
535            &is_entry,
536            &|i| {
537                program
538                    .owner_of(i)
539                    .and_then(|f| program.file(f))
540                    .map(|f| f.text.as_str())
541            },
542            crate::docs::signatures(),
543        ));
544
545    outcome.diagnostics.extend(doc_diagnostics(program));
546
547    // Waivers, per file: B0007 for a malformed one, B0008 for one that
548    // suppresses nothing.
549    let mut waivers = Vec::new();
550    for file in program.files() {
551        let spans: Vec<(usize, tatara_lisp::Span)> = forms
552            .iter()
553            .enumerate()
554            .filter(|(i, _)| program.owner_of(*i) == Some(file.id))
555            .map(|(i, f)| (i, f.span))
556            .collect();
557        let (found, malformed) = blue_lang_check::waiver::collect(&file.text, &spans);
558        waivers.extend(found);
559        outcome.diagnostics.extend(malformed);
560    }
561    outcome.waived = blue_lang_check::waiver::apply(&mut outcome.diagnostics, waivers, &is_entry);
562    if !stored {
563        outcome.diagnostics.retain(|d| {
564            !matches!(
565                d.code,
566                blue_lang_check::Code::B0023
567                    | blue_lang_check::Code::B0036
568                    | blue_lang_check::Code::B0037
569                    | blue_lang_check::Code::B0061
570                    | blue_lang_check::Code::B0062
571                    | blue_lang_check::Code::B0063
572            )
573        });
574    }
575    let judge = blue_lang_check::evolution::FormJudge::from_env().unwrap_or_default();
576    outcome
577        .diagnostics
578        .retain(|d| judge.reports(d.code, is_entry(d.top_level)));
579    // A rule whose census has not reached zero is computed, and counted, but
580    // not enforced: its findings move to `census` (see `RULES`' `ratchet`).
581    let (enforced, census): (Vec<_>, Vec<_>) = std::mem::take(&mut outcome.diagnostics)
582        .into_iter()
583        .partition(|d| d.code.rule().active());
584    outcome.diagnostics = enforced;
585    outcome.census = census;
586    outcome
587        .diagnostics
588        .sort_by_key(|d| (d.top_level, d.span.start, d.code));
589    (outcome, table)
590}
591
592/// The documentation rules (B0056–B0060) over the entry file, when it is a
593/// bidama's: a bidama is judged at its own check, as its form is; an importer
594/// is not answerable for a dependency's documentation.
595fn doc_diagnostics(program: &crate::uses::ResolvedProgram) -> Vec<blue_lang_check::Diagnostic> {
596    use crate::uses::ResolvedProgram;
597    let Some(file) = program.file(ResolvedProgram::ENTRY) else {
598        return Vec::new();
599    };
600    let Some(package) = file.package.as_deref() else {
601        return Vec::new();
602    };
603    let forms: Vec<(usize, &tatara_lisp::Spanned)> = program
604        .forms()
605        .iter()
606        .enumerate()
607        .filter(|(i, f)| {
608            program.owner_of(*i) == Some(ResolvedProgram::ENTRY)
609                && !blue_lang_syntax::doc::is_doctest(f)
610        })
611        .collect();
612    let graph = file.path.as_deref().map(crate::doc_sources::graph_meanings);
613    let meaning = |name: &str| {
614        graph
615            .as_ref()
616            .and_then(|g| g.get(&(package.to_string(), name.to_string())).cloned())
617    };
618    let names_line = |name: &str| crate::docs::doc_of(name).map(|d| d.doc.to_string());
619    blue_lang_check::doc_rules::check_file(
620        &file.text,
621        &forms,
622        package,
623        &blue_lang_check::doc_rules::Sources {
624            meaning: &meaning,
625            names_line: &names_line,
626        },
627    )
628}
629
630fn data_law_diagnostics(
631    program: &crate::uses::ResolvedProgram,
632    is_entry: &dyn Fn(usize) -> bool,
633) -> Vec<blue_lang_check::Diagnostic> {
634    use blue_lang_check::data_laws;
635    let forms = program.forms();
636    let fragments = data_laws::Fragments::collect(forms);
637    let frontend = program.frontend();
638    let mut out = Vec::new();
639    let schema = match frontend.and_then(|f| f.table.as_ref()) {
640        Some((label, text)) => match data_laws::Schema::read(text) {
641            Ok(s) => Some(s),
642            Err(why) => {
643                if let Some((i, first)) = forms.iter().enumerate().find(|(i, _)| is_entry(*i)) {
644                    out.push(
645                        blue_lang_check::Diagnostic::new(
646                            blue_lang_check::Code::B0050,
647                            format!("the generated schema table {label} does not read: {why}"),
648                            first.span,
649                        )
650                        .at_top_level(i)
651                        .with_help("regenerate it: `nix run .#regen`"),
652                    );
653                }
654                None
655            }
656        },
657        None => None,
658    };
659    if fragments.is_empty() && schema.is_none() && !frontend.is_some_and(|f| f.view) {
660        return out;
661    }
662    out.extend(data_laws::check(
663        forms,
664        &data_laws::Context {
665            fragments: &fragments,
666            schema: schema.as_ref(),
667            is_entry,
668            view: frontend.is_some_and(|f| f.view),
669        },
670    ));
671    out
672}
673
674/// The whole name table the check stage resolves against: the program's
675/// own scopes (each file and bidama, by namespace) followed by `builtins`.
676///
677/// **A top-level call to a builtin macro can define names**: `defflow(slug,
678/// trim, downcase)` expands to `(define slug …)`, and nothing in the source
679/// spells `define`. Such a call is expanded here, on a hostless fork, and what
680/// its expansion defines is bound in the calling file's namespace. Only
681/// BUILTIN macros are expanded: their bodies are the runtime's own
682/// templates. A program's own `defmacro` is not run at check time — checking a
683/// file (and an editor checking on every keystroke) must not execute the code
684/// it checks — so names a program macro generates are not seen; none of the
685/// corpus's macros generates one (measured 2026-09-29).
686#[must_use]
687pub fn program_names(program: &crate::uses::ResolvedProgram, builtins: &NameTable) -> NameTable {
688    use blue_lang_check::Binding;
689    let mut table = NameTable::new();
690    table.add_program(program.forms(), |i| namespace_of(program, i));
691    let builtin_macro = |head: &str| {
692        builtins
693            .scopes()
694            .iter()
695            .any(|s| s.namespace == Namespace::Macro && s.get(head).is_some())
696    };
697    let mut expander: Option<tatara_lisp_eval::Interpreter<()>> = None;
698    for (i, form) in program.forms().iter().enumerate() {
699        let Some(head) = form
700            .as_list()
701            .and_then(|items| items.first())
702            .and_then(tatara_lisp::Spanned::as_symbol)
703        else {
704            continue;
705        };
706        if !builtin_macro(head) {
707            continue;
708        }
709        let interp = expander.get_or_insert_with(crate::interpreter_hostless);
710        // A failed expansion defines nothing here; the evaluator will report
711        // it, with its position, when the form runs.
712        let Ok(expanded) = interp.fully_expand(form, &mut ()) else {
713            continue;
714        };
715        let nullary = blue_lang_syntax::scope::nullary_definition(&expanded);
716        for (name, span, kind) in blue_lang_check::names::definitions_of(&expanded) {
717            table.define(
718                namespace_of(program, i),
719                Binding {
720                    nullary: nullary == Some(name.as_str()),
721                    name,
722                    kind,
723                    span: Some(span),
724                    top_level: Some(i),
725                },
726            );
727        }
728    }
729    for scope in builtins.scopes() {
730        table.push(scope.clone());
731    }
732    table.spell_bare_like(builtins);
733    let form_file: Vec<usize> = (0..program.forms().len())
734        .map(|i| program.owner_of(i).map_or(usize::MAX, |f| f.index()))
735        .collect();
736    let mut imports: std::collections::BTreeMap<usize, blue_lang_check::names::FileImports> =
737        std::collections::BTreeMap::new();
738    for (file, import) in program.imports() {
739        let entry = imports.entry(file.index()).or_default();
740        entry.add(&import.package, import.names.iter().map(|(n, _)| n.clone()));
741        let at = import.span.start;
742        entry.use_at = Some(entry.use_at.map_or(at, |a| a.min(at)));
743    }
744    // A FACADE — a bidama that defines nothing and `use`s others (zenbu) —
745    // exists so a consumer can depend on "everything": `use("zenbu")` makes
746    // every member's QUALIFIER reachable (`toukei::median`), never a bare
747    // name. Followed to a fixpoint, so a facade of facades works too.
748    let facade_uses =
749        |pkg: &str,
750         imports: &std::collections::BTreeMap<usize, blue_lang_check::names::FileImports>| {
751            let defines = table.bidama(pkg).is_some_and(|s| !s.is_empty());
752            if defines {
753                return std::collections::BTreeSet::new();
754            }
755            program
756                .files()
757                .iter()
758                .filter(|f| f.package.as_deref() == Some(pkg))
759                .filter_map(|f| imports.get(&f.id.index()))
760                .flat_map(|i| i.uses.iter().cloned())
761                .collect::<std::collections::BTreeSet<String>>()
762        };
763    loop {
764        let mut grew = false;
765        let files: Vec<usize> = imports.keys().copied().collect();
766        for f in files {
767            let used: Vec<String> = imports[&f].uses.iter().cloned().collect();
768            for p in used {
769                for member in facade_uses(&p, &imports) {
770                    if let Some(i) = imports.get_mut(&f) {
771                        if i.uses.insert(member.clone()) {
772                            i.via.insert(member, p.clone());
773                            grew = true;
774                        }
775                    }
776                }
777            }
778        }
779        if !grew {
780            break;
781        }
782    }
783    let mut pkg_uses: std::collections::BTreeMap<String, std::collections::BTreeSet<String>> =
784        std::collections::BTreeMap::new();
785    for (file, import) in program.imports() {
786        if let Some(p) = program.file(*file).and_then(|f| f.package.clone()) {
787            pkg_uses
788                .entry(p)
789                .or_default()
790                .insert(import.package.clone());
791        }
792    }
793    table.attach_files(form_file, imports);
794    table.attach_package_uses(pkg_uses);
795    table.attach_needs(program.needs().clone());
796    // Where each file lives and which distribution each bidama ships in: a
797    // bridge reference (B0021) is an error inside the bidama's own
798    // distribution and a warning outside it.
799    let canonical = |p: &std::path::Path| {
800        std::fs::canonicalize(p)
801            .unwrap_or_else(|_| p.to_path_buf())
802            .display()
803            .to_string()
804    };
805    let mut file_paths = std::collections::BTreeMap::new();
806    let mut pkg_roots = std::collections::BTreeMap::new();
807    for f in program.files() {
808        if let Some(path) = &f.path {
809            file_paths.insert(f.id.index(), canonical(path));
810            if let (Some(pkg), Some(root)) =
811                (&f.package, path.parent().and_then(std::path::Path::parent))
812            {
813                pkg_roots
814                    .entry(pkg.clone())
815                    .or_insert_with(|| canonical(root));
816            }
817        }
818    }
819    table.attach_paths(file_paths, pkg_roots);
820    let versions = program.versions().clone();
821    table.apply_legacy(program.forms(), &|i| namespace_of(program, i), &|p| {
822        versions.get(p).cloned()
823    });
824    table
825}
826
827/// The forms the evaluator runs, from a checked program: every `use`
828/// declaration inert (`nil`, so each index still names its top-level form)
829/// and every name at the key it runs under — the RESOLVED tree under
830/// per-bidama namespaces (`blue_lang_check::names::Resolved::resolved_tree`).
831///
832/// A definition runs as `retsu/first` (a script's as `%root/f`), a
833/// reference to it as the same key, and a builtin as its bare name. Keys
834/// cannot collide across namespaces, so a bidama's `first` no longer
835/// replaces the builtin for anyone who did not import it, and an importer's
836/// `helper` no longer replaces a bidama's own: the runtime binds exactly what
837/// the check stage resolved.
838#[must_use]
839pub fn lower(
840    program: &crate::uses::ResolvedProgram,
841    names: &NameTable,
842) -> Vec<tatara_lisp::Spanned> {
843    lower_with(program, names, true)
844}
845
846#[must_use]
847pub fn lower_with(
848    program: &crate::uses::ResolvedProgram,
849    names: &NameTable,
850    simplify_chains: bool,
851) -> Vec<tatara_lisp::Spanned> {
852    let mut resolved = blue_lang_check::names::resolve_program(program.forms(), names, &|i| {
853        namespace_of(program, i)
854    });
855    let simplified = if simplify_chains {
856        chain_simplified(program.forms(), &resolved)
857    } else {
858        None
859    };
860    let forms: &[tatara_lisp::Spanned] = simplified.as_deref().unwrap_or(program.forms());
861    if simplified.is_some() {
862        resolved =
863            blue_lang_check::names::resolve_program(forms, names, &|i| namespace_of(program, i));
864    }
865    resolved
866        .resolved_tree(forms, blue_lang_check::names::Rule::Namespaced)
867        .into_iter()
868        .zip(forms)
869        .enumerate()
870        .map(|(i, (resolved, written))| {
871            if crate::uses::use_target(written).is_some()
872                || blue_lang_syntax::scope::legacy_target(written).is_some()
873            {
874                tatara_lisp::Spanned::new(written.span, tatara_lisp::SpannedForm::Nil)
875            } else {
876                let file = program.owner_of(i).and_then(|id| program.file(id));
877                match file {
878                    Some(f) => locate_raises(&resolved, &raise_site(f)),
879                    None => resolved,
880                }
881            }
882        })
883        .collect()
884}
885
886fn chain_simplified(
887    forms: &[tatara_lisp::Spanned],
888    resolved: &blue_lang_check::names::Resolved,
889) -> Option<Vec<tatara_lisp::Spanned>> {
890    let respell: std::collections::HashMap<usize, blue_lang_check::respell::Respelling> = resolved
891        .respellings
892        .iter()
893        .filter(|(_, r)| matches!(r.respell, blue_lang_check::respell::Respell::Chain(_)))
894        .cloned()
895        .collect();
896    if respell.is_empty() {
897        return None;
898    }
899    let bare = std::collections::HashSet::new();
900    let canon = Canon {
901        bare: &bare,
902        respell: &respell,
903    };
904    Some(forms.iter().map(|f| canon.form(f)).collect())
905}
906
907fn raise_site(file: &crate::uses::SourceFile) -> impl Fn(tatara_lisp::Span) -> String + '_ {
908    move |span| {
909        let (line, _) =
910            blue_lang_syntax::Span::line_col(&file.text, span.start.min(file.text.len()));
911        let shown = file
912            .path
913            .as_ref()
914            .map_or_else(|| "<source>".to_string(), |p| p.display().to_string());
915        format!("{shown}:{line}")
916    }
917}
918
919fn locate_raises(
920    form: &tatara_lisp::Spanned,
921    site: &dyn Fn(tatara_lisp::Span) -> String,
922) -> tatara_lisp::Spanned {
923    use tatara_lisp::{Atom, Spanned, SpannedForm};
924    let inner = match &form.form {
925        SpannedForm::List(items) => {
926            let mut out: Vec<Spanned> = items.iter().map(|i| locate_raises(i, site)).collect();
927            let raising = items.first().and_then(Spanned::as_symbol) == Some("raise")
928                && (3..=4).contains(&items.len());
929            if raising {
930                out[0] = Spanned::new(
931                    items[0].span,
932                    SpannedForm::Atom(Atom::Symbol(crate::errors::RAISE_AT.to_string())),
933                );
934                out.insert(
935                    1,
936                    Spanned::new(items[0].span, SpannedForm::Atom(Atom::Str(site(form.span)))),
937                );
938            }
939            SpannedForm::List(out)
940        }
941        SpannedForm::Quote(_) | SpannedForm::Quasiquote(_) => return form.clone(),
942        other => other.clone(),
943    };
944    Spanned::new(form.span, inner)
945}
946
947/// The namespace top-level form `i` of `program` defines into.
948#[must_use]
949pub fn namespace_of(program: &crate::uses::ResolvedProgram, i: usize) -> Namespace {
950    let file = program.owner_of(i).and_then(|id| program.file(id));
951    match file {
952        Some(f) => match &f.package {
953            Some(p) => Namespace::Bidama(p.clone()),
954            None => Namespace::File(
955                f.path
956                    .as_ref()
957                    .map_or_else(|| "<anonymous>".to_string(), |p| p.display().to_string()),
958            ),
959        },
960        None => Namespace::File("<unknown file>".to_string()),
961    }
962}
963
964/// Names only the test harness binds.
965///
966/// In scope for EVERY check, not only for test blocks. A bidama may carry a
967/// test helper — a plain `def` that asserts, called only from its `test`
968/// blocks (`heni`'s `hn_end_to_end` is one) — and every program importing that
969/// bidama would otherwise be refused for a function it never calls. The
970/// refusal would be scoped to the importer's whole program, not to the fault.
971/// The cost, stated: an `assert` outside any test that `blue run` actually
972/// reaches is caught at runtime (`blue-assert` is unbound there), not here.
973///
974/// `blue-lang-test` registers these on its own interpreter, and this crate
975/// cannot depend on it (it depends on this one), so the list lives beside the
976/// only name in it: the lowered `assert`, which `blue-lang-syntax` owns.
977pub const HARNESS_NAMES: &[&str] = &[blue_lang_syntax::LOWERED_ASSERT];
978
979/// The check stage's builtin scopes, read off the interpreter that will run
980/// the program: the test harness's names ([`HARNESS_NAMES`]), then its special
981/// forms, its macros, and every value it binds — the last three in the order
982/// the evaluator consults for a head.
983///
984/// Read from a live interpreter rather than a list, for the reason
985/// `Interpreter::resolve_head` gives: a list is a second copy of the truth and
986/// goes stale on the next installer that lands. An embedder's own
987/// primitives are in scope here because the embedder installs them first.
988#[must_use]
989pub fn builtin_names<H: 'static>(interp: &tatara_lisp_eval::Interpreter<H>) -> NameTable {
990    builtin_names_with(interp, &[])
991}
992
993#[must_use]
994pub fn builtin_names_with<H: 'static>(
995    interp: &tatara_lisp_eval::Interpreter<H>,
996    host: &[crate::host_surface::HostName],
997) -> NameTable {
998    use blue_lang_check::{Binding, Scope, ScopeKind};
999    use tatara_lisp_eval::HeadBinding;
1000    let mut special = Scope::new(Namespace::SpecialForm);
1001    let mut macros = Scope::new(Namespace::Macro);
1002    let mut values = Scope::new(Namespace::Builtin);
1003    // `reserved_head_names` reads the ROOT frame only, so a name installed on
1004    // a fork (the input primitives, on every `run`) is invisible to it; those
1005    // are asked about by name instead, which `resolve_head` answers through
1006    // every frame.
1007    let mut names: Vec<std::sync::Arc<str>> = interp.reserved_head_names().into_iter().collect();
1008    names.extend(
1009        crate::inputs::INPUT_PRIMITIVES
1010            .iter()
1011            .filter(|n| interp.resolve_head(n).is_some())
1012            .map(|n| std::sync::Arc::from(*n)),
1013    );
1014    for name in names {
1015        let (scope, kind) = match interp.resolve_head(&name) {
1016            Some(HeadBinding::SpecialForm) => (&mut special, ScopeKind::SpecialForm),
1017            Some(HeadBinding::Macro) => (&mut macros, ScopeKind::Macro),
1018            _ => (&mut values, ScopeKind::Value),
1019        };
1020        let nullary = kind == ScopeKind::Value
1021            && interp.lookup_global(&name).is_some_and(|v| {
1022                nullary_value(&v)
1023                    || (crate::docs::doc_of(&name).is_some_and(|d| d.signature == &*name)
1024                        && matches!(
1025                            v,
1026                            tatara_lisp_eval::Value::NativeFn(_)
1027                                | tatara_lisp_eval::Value::Closure(_)
1028                        ))
1029            });
1030        scope.bind(Binding {
1031            name: name.to_string(),
1032            kind,
1033            span: None,
1034            top_level: None,
1035            nullary,
1036        });
1037    }
1038    for h in host {
1039        values.bind(Binding {
1040            name: h.name.clone(),
1041            kind: ScopeKind::Value,
1042            span: None,
1043            top_level: None,
1044            nullary: h.nullary(),
1045        });
1046    }
1047    let mut table = NameTable::new();
1048    let mut harness = Scope::new(Namespace::Harness);
1049    for n in HARNESS_NAMES {
1050        harness.bind(Binding {
1051            name: (*n).to_string(),
1052            kind: ScopeKind::Value,
1053            span: None,
1054            top_level: None,
1055            nullary: false,
1056        });
1057    }
1058    table.push(harness);
1059    table.push(special);
1060    table.push(macros);
1061    table.push(values);
1062    table.spell_bare_only(
1063        crate::docs::NAMES
1064            .iter()
1065            .filter(|d| d.signature == d.name)
1066            .map(|d| d.name.to_string())
1067            .chain(host.iter().filter(|h| h.nullary()).map(|h| h.name.clone()))
1068            .collect(),
1069    );
1070    table
1071}
1072
1073#[must_use]
1074pub fn nullary_value(value: &tatara_lisp_eval::Value) -> bool {
1075    match value {
1076        tatara_lisp_eval::Value::NativeFn(f) => {
1077            matches!(f.arity, tatara_lisp_eval::ffi::Arity::Exact(0))
1078        }
1079        tatara_lisp_eval::Value::Closure(c) => c.params.is_empty() && c.rest.is_none(),
1080        _ => false,
1081    }
1082}
1083
1084/// A diagnostic as a person reads it: `file:line:col: error[B0001]: message`,
1085/// then an indented `help:` line when it has one, and a `fix:` line naming
1086/// the one command that applies blue's fixer for it.
1087#[must_use]
1088pub fn render(program: &crate::uses::ResolvedProgram, d: &blue_lang_check::Diagnostic) -> String {
1089    let head = d.to_string();
1090    let mut out = program.locate(d.top_level, d.span, &head).to_string();
1091    if let Some(help) = &d.help {
1092        out.push_str("\n  help: ");
1093        out.push_str(help);
1094    }
1095    let file = program
1096        .owner_of(d.top_level)
1097        .and_then(|id| program.file(id))
1098        .and_then(|f| f.path.as_ref());
1099    if let Some(cmd) =
1100        file.and_then(|p| blue_lang_check::evolution::fix_command(d, &p.display().to_string()))
1101    {
1102        out.push_str("\n  fix: ");
1103        out.push_str(&cmd);
1104    }
1105    out
1106}
1107
1108/// What [`check_entry`] checks.
1109#[derive(Clone, Copy, Debug, PartialEq, Eq)]
1110pub enum Checking {
1111    /// The program `blue run` would evaluate: test blocks dropped.
1112    Program,
1113    /// The program plus the entry file's test blocks, as `blue test` and
1114    /// `blue check` see it.
1115    WithTests,
1116}
1117
1118/// A program through the check stage, with everything the stage found.
1119pub struct Checked {
1120    pub program: crate::uses::ResolvedProgram,
1121    pub outcome: blue_lang_check::Outcome,
1122    /// The name table the stage resolved against: every program scope, then
1123    /// the builtins. What an editor completes from.
1124    pub names: NameTable,
1125}
1126
1127impl Checked {
1128    /// The forms an evaluator runs: [`lower`]ed, then erased — the tree
1129    /// `run` evaluates, for a door that brings its own evaluator (the VM).
1130    #[must_use]
1131    pub fn erased(&self) -> Vec<tatara_lisp::Spanned> {
1132        erase_types(&lower(&self.program, &self.names))
1133    }
1134
1135    /// What `blue test` hands the harness: the program [`lower`]ed, spans
1136    /// projected away.
1137    #[must_use]
1138    pub fn evaluable(&self) -> Vec<tatara_lisp::Sexp> {
1139        lower(&self.program, &self.names)
1140            .iter()
1141            .map(tatara_lisp::Spanned::to_sexp)
1142            .collect()
1143    }
1144
1145    /// Every non-local reference, resolved under both rules — today's flat
1146    /// one and per-bidama namespaces — and the resolved trees built from them
1147    /// (`blue ast --resolved`).
1148    #[must_use]
1149    pub fn resolve(&self) -> blue_lang_check::names::Resolved {
1150        blue_lang_check::names::resolve_program(self.program.forms(), &self.names, &|i| {
1151            namespace_of(&self.program, i)
1152        })
1153    }
1154}
1155
1156impl Checked {
1157    #[must_use]
1158    pub fn call_explicit_forms(&self) -> Vec<tatara_lisp::Spanned> {
1159        self.resolve().call_explicit_tree(self.program.forms())
1160    }
1161
1162    #[must_use]
1163    pub fn canonical_entry(&self, src: &str) -> Option<Vec<tatara_lisp::Spanned>> {
1164        use crate::uses::ResolvedProgram;
1165        let program = &self.program;
1166        let entry: Vec<&tatara_lisp::Spanned> = program
1167            .forms()
1168            .iter()
1169            .enumerate()
1170            .filter(|(i, _)| program.owner_of(*i) == Some(ResolvedProgram::ENTRY))
1171            .map(|(_, f)| f)
1172            .filter(|f| !blue_lang_syntax::doc::is_doctest(f))
1173            .collect();
1174        let written = blue_lang_syntax::parse_program_tree(src).ok()?;
1175        let same = written.len() == entry.len()
1176            && written
1177                .iter()
1178                .zip(&entry)
1179                .all(|(w, e)| w.to_sexp() == e.to_sexp() && w.span == e.span);
1180        if !same {
1181            return None;
1182        }
1183        let resolved = self.resolve();
1184        let bare: std::collections::HashSet<usize> = resolved
1185            .parenthesized_nullary_calls()
1186            .into_iter()
1187            .filter(|r| program.owner_of(r.top_level) == Some(ResolvedProgram::ENTRY))
1188            .map(blue_lang_check::names::Reference::node_address)
1189            .collect();
1190        let waived: Vec<tatara_lisp::Span> = self
1191            .outcome
1192            .waived
1193            .iter()
1194            .map(|w| w.diagnostic.span)
1195            .collect();
1196        let respell: std::collections::HashMap<usize, blue_lang_check::respell::Respelling> =
1197            resolved
1198                .respellings
1199                .iter()
1200                .filter(|(_, r)| !waived.contains(&r.span))
1201                .cloned()
1202                .collect();
1203        let canon = Canon {
1204            bare: &bare,
1205            respell: &respell,
1206        };
1207        let forms: Vec<tatara_lisp::Spanned> = entry.into_iter().map(|f| canon.form(f)).collect();
1208        let script = program
1209            .file(ResolvedProgram::ENTRY)
1210            .is_some_and(|f| f.package.is_none());
1211        let forms = if script {
1212            blue_lang_check::form_rules::without_prefix(&forms).unwrap_or(forms)
1213        } else {
1214            forms
1215        };
1216        let forms = blue_lang_check::form_rules::without_main_guard(&forms).unwrap_or(forms);
1217        Some(blue_lang_check::form_rules::eta_reduced(&forms).unwrap_or(forms))
1218    }
1219}
1220
1221struct Canon<'a> {
1222    bare: &'a std::collections::HashSet<usize>,
1223    respell: &'a std::collections::HashMap<usize, blue_lang_check::respell::Respelling>,
1224}
1225
1226impl Canon<'_> {
1227    fn form(&self, form: &tatara_lisp::Spanned) -> tatara_lisp::Spanned {
1228        use tatara_lisp::{Spanned, SpannedForm};
1229        let inner = match &form.form {
1230            SpannedForm::List(items) => match items.as_slice() {
1231                [head] if self.bare.contains(&(std::ptr::from_ref(head) as usize)) => {
1232                    return Spanned::new(form.span, head.form.clone());
1233                }
1234                [head, ..]
1235                    if self
1236                        .respell
1237                        .contains_key(&(std::ptr::from_ref(head) as usize)) =>
1238                {
1239                    let r = &self.respell[&(std::ptr::from_ref(head) as usize)];
1240                    let walked: Vec<Spanned> = items.iter().map(|i| self.form(i)).collect();
1241                    return blue_lang_check::respell::apply(form, &walked, r);
1242                }
1243                _ => SpannedForm::List(items.iter().map(|i| self.form(i)).collect()),
1244            },
1245            SpannedForm::Quote(i) => SpannedForm::Quote(Box::new(self.form(i))),
1246            SpannedForm::Quasiquote(i) => SpannedForm::Quasiquote(Box::new(self.form(i))),
1247            SpannedForm::Unquote(i) => SpannedForm::Unquote(Box::new(self.form(i))),
1248            SpannedForm::UnquoteSplice(i) => SpannedForm::UnquoteSplice(Box::new(self.form(i))),
1249            other => other.clone(),
1250        };
1251        Spanned::new(form.span, inner)
1252    }
1253}
1254
1255/// Parse, resolve and CHECK, without running: the door for `blue check`,
1256/// `blue test` and the language server.
1257///
1258/// Returns every diagnostic, errors and warnings alike, rather than failing on
1259/// the first error: a reader fixing a file wants the whole list, and an agent
1260/// repairing one wants it in one pass. Whether errors stop anything is the
1261/// caller's decision — `blue test` refuses to run tests over a program with
1262/// one, exactly as `run` refuses to evaluate it.
1263///
1264/// The name oracle is the interpreter `blue run` would build: hostless plus
1265/// input primitives.
1266///
1267/// # Errors
1268///
1269/// A parse or import error, which leaves no program to check.
1270pub fn check_entry(
1271    entry: Entry<'_>,
1272    loader: &dyn crate::uses::Loader,
1273    surface: Option<&blue_lang_syntax::yakugo::Yakugo>,
1274    checking: Checking,
1275) -> Result<Checked, RunError> {
1276    let mut program = parse_and_resolve(entry, loader, surface)?;
1277    if checking == Checking::Program {
1278        program.retain(|f| !crate::uses::is_test_form(f));
1279    }
1280    let host = match entry.path {
1281        Some(path) => crate::host_surface::near(path)
1282            .map_err(|e| RunError::Import(e.to_string()))?
1283            .map(|s| s.functions)
1284            .unwrap_or_default(),
1285        None => Vec::new(),
1286    };
1287    let mut interp =
1288        crate::timings::stage(crate::timings::Stage::Runtime, crate::interpreter_hostless);
1289    crate::inputs::install_input_primitives(&mut interp, Inputs::new());
1290    let builtins = crate::timings::stage(crate::timings::Stage::Names, || {
1291        builtin_names_with(&interp, &host)
1292    });
1293    let (outcome, names) = crate::timings::stage(crate::timings::Stage::Check, || {
1294        check_stage(&program, &builtins, checking == Checking::WithTests)
1295    });
1296    Ok(Checked {
1297        program,
1298        outcome,
1299        names,
1300    })
1301}
1302
1303#[must_use]
1304pub fn spelling_code(spelling: blue_lang_syntax::Spelling) -> blue_lang_check::Code {
1305    use blue_lang_check::Code;
1306    use blue_lang_syntax::Spelling;
1307    match spelling {
1308        Spelling::LogicalSymbol => Code::B0025,
1309        Spelling::Unless => Code::B0026,
1310        Spelling::ElseIf => Code::B0027,
1311        Spelling::CallForm => Code::B0028,
1312        Spelling::KeywordRocket => Code::B0029,
1313        Spelling::ParameterList => Code::B0030,
1314        Spelling::OperatorSpelling => Code::B0031,
1315        Spelling::TrailingComma => Code::B0032,
1316        Spelling::NegatedComparison => Code::B0034,
1317        Spelling::ElseNil => Code::B0035,
1318        Spelling::TryCatch => Code::B0037,
1319        Spelling::Apply => Code::B0042,
1320        Spelling::MapPun => Code::B0046,
1321        Spelling::NilTest => Code::B0047,
1322    }
1323}
1324
1325#[must_use]
1326pub fn form_diagnostics(text: &str) -> Vec<blue_lang_check::Diagnostic> {
1327    match blue_lang_fmt::format_source_lossless(text) {
1328        Ok(formatted) => form_diagnostics_against(text, &formatted),
1329        Err(_) => Vec::new(),
1330    }
1331}
1332
1333#[must_use]
1334pub fn form_diagnostics_against(text: &str, formatted: &str) -> Vec<blue_lang_check::Diagnostic> {
1335    use blue_lang_check::{Code, Diagnostic};
1336    if formatted.trim_end() == text.trim_end() {
1337        return Vec::new();
1338    }
1339    let help = "`blue fmt --write FILE` writes it; no compile door writes a file (`BLUE_LAYOUT=rewrite` restores formatting in place)";
1340    let mut out: Vec<Diagnostic> = blue_lang_syntax::spelling_notes(text)
1341        .unwrap_or_default()
1342        .into_iter()
1343        .map(|n| {
1344            let message = if n.canonical.is_empty() {
1345                format!("`{}` is not written", n.written)
1346            } else {
1347                format!("`{}` is written `{}`", n.written, n.canonical)
1348            };
1349            Diagnostic::new(spelling_code(n.spelling), message, n.span)
1350                .at_top_level(0)
1351                .with_help(help)
1352        })
1353        .collect();
1354    out.extend(
1355        literal_diagnostics(text)
1356            .into_iter()
1357            .map(|d| d.with_help(help)),
1358    );
1359    if out.is_empty() {
1360        let at = text
1361            .lines()
1362            .zip(formatted.lines())
1363            .position(|(a, b)| a != b)
1364            .unwrap_or_else(|| text.lines().count().min(formatted.lines().count()));
1365        let start: usize = text.lines().take(at).map(|l| l.len() + 1).sum();
1366        let start = start.min(text.len());
1367        let end = text[start..].find('\n').map_or(text.len(), |e| start + e);
1368        out.push(
1369            Diagnostic::new(
1370                Code::B0024,
1371                format!("line {} is not laid out as blue writes it", at + 1),
1372                tatara_lisp::Span::new(start, end),
1373            )
1374            .at_top_level(0)
1375            .with_help(help),
1376        );
1377    }
1378    out.sort_by_key(|d| (d.span.start, d.code));
1379    out
1380}
1381
1382fn literal_diagnostics(text: &str) -> Vec<blue_lang_check::Diagnostic> {
1383    use blue_lang_syntax::{Atom, TokenKind};
1384    let Ok(toks) = blue_lang_syntax::lex(text) else {
1385        return Vec::new();
1386    };
1387    toks.iter()
1388        .filter_map(|t| {
1389            let atom = match &t.kind {
1390                TokenKind::Int(v) => Atom::Int(*v),
1391                TokenKind::Float(v) => Atom::Float(*v),
1392                TokenKind::Str(v) => Atom::Str(v.clone()),
1393                _ => return None,
1394            };
1395            let written = text.get(t.span.start..t.span.end)?;
1396            let canonical = blue_lang_fmt::render_literal(&atom);
1397            (written != canonical).then(|| {
1398                blue_lang_check::Diagnostic::new(
1399                    blue_lang_check::Code::B0033,
1400                    format!("`{written}` is written `{canonical}`"),
1401                    t.span,
1402                )
1403                .at_top_level(0)
1404            })
1405        })
1406        .collect()
1407}
1408
1409/// A syntax error in `text` as a [`B0006`](blue_lang_check::Code::B0006)
1410/// diagnostic, so a tool reading `--format json` gets a parse failure in the
1411/// same shape as every other finding. `None` when `text` parses.
1412#[must_use]
1413pub fn syntax_diagnostic(text: &str) -> Option<blue_lang_check::Diagnostic> {
1414    let e = blue_lang_syntax::parse_program_tree(text).err()?;
1415    Some(
1416        blue_lang_check::Diagnostic::new(blue_lang_check::Code::B0006, e.message, e.span)
1417            .at_top_level(0),
1418    )
1419}
1420
1421/// A runtime message as the author wrote the names in it: a definition runs
1422/// under its key (`retsu/first`, `%root/f`), and a message naming one in
1423/// backticks names it `retsu::first`, or `f` for the author's own script.
1424#[must_use]
1425pub fn display_keys(message: &str) -> String {
1426    let mut out = String::with_capacity(message.len());
1427    let mut parts = message.split('`');
1428    if let Some(first) = parts.next() {
1429        out.push_str(first);
1430    }
1431    for (i, part) in parts.enumerate() {
1432        out.push('`');
1433        // Odd pieces (0-based here) are inside backticks.
1434        if i % 2 == 0 {
1435            out.push_str(&crate::observe::display_key(part));
1436        } else {
1437            out.push_str(part);
1438        }
1439    }
1440    out
1441}
1442
1443/// Evaluate a prepared program's top-level forms into `interp`, with `host`.
1444pub(crate) fn eval_prepared<H: 'static>(
1445    interp: &mut tatara_lisp_eval::Interpreter<H>,
1446    prepared: &Prepared,
1447    host: &mut H,
1448) -> Result<Value, RunError> {
1449    let Prepared {
1450        program, erased, ..
1451    } = prepared;
1452
1453    // RUN, one top-level form at a time, **counting them**.
1454    //
1455    // This is literally the loop `Interpreter::eval_program` runs internally
1456    // (tatara-lisp-eval `eval.rs`) — unrolled here for exactly one reason: the
1457    // INDEX. `resolve_uses` flattens N files into one form list and a `Span` is
1458    // a byte range with no file identity, so an offset alone is ambiguous
1459    // across files — 66 means something in every one of them. The index is the
1460    // join key back to `ResolvedProgram`'s file table, and `eval_program`
1461    // consumes it internally and hands back only the error.
1462    //
1463    // The same key, the same renderer and the same file table the type errors
1464    // above already use. A runtime error was the one diagnostic in this
1465    // function still reporting a bare message.
1466    let mut value = Value::Nil;
1467    for (top_level, form) in erased.iter().enumerate() {
1468        value = interp.eval_top_form(form, host).map_err(|e| {
1469            // The message, its position and the blue call stack, read off the
1470            // frames the error unwound through (`observe::Fault`). The message
1471            // is `short_message` rather than upstream's `Display`, whose
1472            // trailing ` at {span}` is a bare byte range with no file, through
1473            // `messages::describe`, which names the function a wrong argument
1474            // count was called on.
1475            RunError::Eval(Box::new(crate::observe::Fault::of(
1476                program,
1477                erased,
1478                top_level,
1479                &e,
1480                &interp.take_trace(),
1481            )))
1482        })?;
1483    }
1484    Ok(value)
1485}
1486
1487pub const MAIN: &str = "main";
1488
1489#[must_use]
1490pub fn entry_main(program: &crate::uses::ResolvedProgram) -> Option<(usize, tatara_lisp::Span)> {
1491    use crate::uses::ResolvedProgram;
1492    let stored = program
1493        .file(ResolvedProgram::ENTRY)
1494        .is_some_and(|f| f.path.is_some());
1495    if !stored {
1496        return None;
1497    }
1498    program.forms().iter().enumerate().find_map(|(i, f)| {
1499        if program.owner_of(i) != Some(ResolvedProgram::ENTRY) {
1500            return None;
1501        }
1502        let items = f.as_list()?;
1503        let sig = items.get(1)?.as_list()?;
1504        let named_main = matches!(
1505            items.first().and_then(tatara_lisp::Spanned::as_symbol),
1506            Some("define" | "define-typed")
1507        ) && sig.len() == 1
1508            && sig[0].as_symbol() == Some(MAIN);
1509        named_main.then_some((i, sig[0].span))
1510    })
1511}
1512
1513pub(crate) fn call_main<H: 'static>(
1514    interp: &mut tatara_lisp_eval::Interpreter<H>,
1515    prepared: &Prepared,
1516    host: &mut H,
1517) -> Result<Option<Value>, RunError> {
1518    let Some((top_level, span)) = entry_main(&prepared.program) else {
1519        return Ok(None);
1520    };
1521    let ns = namespace_of(&prepared.program, top_level);
1522    let call = tatara_lisp::Spanned::new(
1523        span,
1524        tatara_lisp::SpannedForm::List(vec![tatara_lisp::Spanned::new(
1525            span,
1526            tatara_lisp::SpannedForm::Atom(tatara_lisp::Atom::Symbol(blue_lang_check::names::key(
1527                &ns, MAIN,
1528            ))),
1529        )]),
1530    );
1531    interp.eval_top_form(&call, host).map(Some).map_err(|e| {
1532        RunError::Eval(Box::new(crate::observe::Fault::of(
1533            &prepared.program,
1534            &prepared.erased,
1535            top_level,
1536            &e,
1537            &interp.take_trace(),
1538        )))
1539    })
1540}
1541
1542/// **A runtime error names a place.** The gates for the last stage that
1543/// reported a bare message.
1544///
1545/// Each fixture is sized so that resolving the failing span against ANY file
1546/// but the right one lands somewhere else — a different path and a different
1547/// line — so a green run here is evidence about the join and not about the
1548/// renderer being called at all.
1549///
1550/// **Each raise is an unbound name, WAIVED.** Since the check stage resolves
1551/// names (B0001), an unbound call no longer reaches the evaluator; these
1552/// fixtures need exactly that runtime raise, so each carries
1553/// `# waive B0001: …` above the definition holding it — the one escape hatch,
1554/// used for what it is for. The waiver adds a line above each failing call,
1555/// which is why the positions below are one line later than their red runs
1556/// (recorded against the unwaived fixtures) show.
1557#[cfg(test)]
1558mod position_tests {
1559    use super::*;
1560    use crate::uses::{Entry, Loader};
1561    use std::collections::BTreeMap;
1562    use std::path::Path;
1563
1564    struct MemLoader(BTreeMap<&'static str, &'static str>);
1565
1566    impl Loader for MemLoader {
1567        fn load(&self, name: &str) -> Result<Vec<(String, String)>, String> {
1568            self.0
1569                .get(name)
1570                .map(|s| vec![(format!("{name}.b"), (*s).to_owned())])
1571                .ok_or_else(|| format!("no bidama named \"{name}\""))
1572        }
1573    }
1574
1575    /// A package whose OWN top-level code raises, deep inside a file that is
1576    /// deliberately taller than either of the other two.
1577    ///
1578    /// Byte 66 — where `kore_wa_sonzai_shinai` starts — is past the end of the
1579    /// entry file (30 bytes) and past the end of `kotae.b` (21 bytes). So the
1580    /// only file this span can honestly resolve against is this one, and the
1581    /// other two now refuse to answer rather than walking off their ends.
1582    const BAKUHATSU: &str = "\
1583def tsukawanai_a()
1584  1
1585end
1586
1587def tsukawanai_b()
1588  2
1589end
1590
1591# waive B0001: the fixture needs a raise at runtime
1592def bakuhatsu()
1593  kore_wa_sonzai_shinai()
1594end
1595
1596bakuhatsu";
1597
1598    const KOTAE: &str = "def kotae()\n  42\nend";
1599
1600    /// The same failing call, but only ever reached by a CALLER in another
1601    /// file — the shape the call stack resolved (the last position test).
1602    const BAKUHATSU2: &str =
1603        "# waive B0001: a raise at runtime\ndef yobu()\n  kore_wa_sonzai_shinai()\nend";
1604
1605    fn loader() -> MemLoader {
1606        MemLoader(BTreeMap::from([
1607            ("kotae", KOTAE),
1608            ("bakuhatsu", BAKUHATSU),
1609            ("bakuhatsu2", BAKUHATSU2),
1610        ]))
1611    }
1612
1613    fn run_named(path: &str, src: &str) -> RunError {
1614        run_in_surface(
1615            Entry {
1616                path: Some(Path::new(path)),
1617                text: src,
1618            },
1619            Inputs::new(),
1620            &loader(),
1621            None,
1622        )
1623        .expect_err("the fixture must raise")
1624    }
1625
1626    /// **The load-bearing gate: a raise inside an IMPORTED package reports the
1627    /// IMPORTED file's path and line.**
1628    ///
1629    /// Hand-computed. In `bakuhatsu.b` the failing call sits on line 11 at
1630    /// column 3, and the whole point of the fixture's height is that no other
1631    /// file in the program can produce that pair: the entry file has 2 lines
1632    /// and `kotae.b` has 3, so *any* mis-attribution is visible as a different
1633    /// path AND a different position, never as a coincidence.
1634    ///
1635    /// **Three red runs, one per edit this change makes** — each isolates a
1636    /// different half of the mechanism, which is what stops the gate being a
1637    /// tautology over "some renderer ran".
1638    ///
1639    /// 1. `eval_program` + `.map_err(|e| RunError::Eval(e.to_string()))`
1640    ///    restored (the pre-change code):
1641    ///    ```text
1642    ///    left:  "runtime error: unbound symbol: kore_wa_sonzai_shinai at 74..95"
1643    ///    right: "runtime error: bakuhatsu.b:10:3: unbound symbol `kore_wa_sonzai_shinai`"
1644    ///    ```
1645    ///    No place at all — the state this change is fixing — and the trailing
1646    ///    `at 74..95` is upstream's `Display`, an offset with no file, which is
1647    ///    why the loop renders `short_message` instead.
1648    ///
1649    /// 2. The loop kept, but `0` passed to `locate` in place of `top_level`:
1650    ///    ```text
1651    ///    left:  "runtime error: kotae.b: unbound symbol `kore_wa_sonzai_shinai`"
1652    ///    right: "runtime error: bakuhatsu.b:10:3: unbound symbol `kore_wa_sonzai_shinai`"
1653    ///    ```
1654    ///    **This is the one that proves the INDEX is load-bearing** rather than
1655    ///    the renderer: form 0 belongs to `kotae.b`, so the wrong file is named
1656    ///    — and named without a position, because the guard in `locate` sees
1657    ///    that byte 74 is not a range in a 21-byte file and declines to invent
1658    ///    one. A fixture with one imported package could not tell these apart.
1659    ///
1660    /// 3. `crate::lower_to_spanned(&crate::to_sexps(&erased))` reinstated
1661    ///    between erasure and the loop:
1662    ///    ```text
1663    ///    left:  "runtime error: bakuhatsu.b: unbound symbol `kore_wa_sonzai_shinai`"
1664    ///    right: "runtime error: bakuhatsu.b:10:3: unbound symbol `kore_wa_sonzai_shinai`"
1665    ///    ```
1666    ///    The right FILE with no position — which is exactly the shape of the
1667    ///    bug: the index survived the lift and every span did not.
1668    /// kotae loads first so bakuhatsu's forms do not start at index 0: the
1669    /// order is the fixture, and the waiver says so (B0015 wants them sorted).
1670    const TWO_IMPORTS: &str =
1671        "use(\"kotae\")\n# waive B0015: kotae loads first on purpose\nuse(\"bakuhatsu\")\n";
1672
1673    #[test]
1674    fn a_raise_inside_an_imported_package_names_that_package() {
1675        let err = run_named("entry.b", TWO_IMPORTS);
1676        assert_eq!(
1677            err.to_string(),
1678            "runtime error: bakuhatsu.b:11:3: unbound symbol `kore_wa_sonzai_shinai`\n  \
1679             at bakuhatsu::bakuhatsu (bakuhatsu.b:11:3)\n  \
1680             at <top level> (bakuhatsu.b:14:1)"
1681        );
1682    }
1683
1684    /// Anti-vacuity for the fixture itself: the position asserted above is a
1685    /// FACT ABOUT `bakuhatsu.b`, checked against the source text rather than
1686    /// against the thing that produced it.
1687    ///
1688    /// Without this, `11:3` is just a number that happened to come out of the
1689    /// code under test, and a change that moved every reported line by one
1690    /// would move this assertion with it.
1691    #[test]
1692    fn line_11_column_3_of_the_fixture_is_the_failing_call() {
1693        let line = BAKUHATSU.lines().nth(10).expect("line 11 exists");
1694        assert_eq!(line, "  kore_wa_sonzai_shinai()");
1695        assert_eq!(
1696            &line[2..],
1697            "kore_wa_sonzai_shinai()",
1698            "column 3 (1-indexed) is where the call starts"
1699        );
1700        // And the other two files cannot reach that far, which is what makes a
1701        // mis-attribution loud instead of plausible.
1702        let offset = BAKUHATSU.find("kore_wa_sonzai_shinai").expect("in fixture");
1703        assert!(
1704            offset > KOTAE.len(),
1705            "kotae.b could answer for byte {offset}"
1706        );
1707        assert!(
1708            offset > TWO_IMPORTS.len(),
1709            "the entry file could answer for byte {offset}"
1710        );
1711    }
1712
1713    /// **The `FileId(0)` path: a raise in the ENTRY file reports the entry
1714    /// file.** The single-file case, which is every program that imports
1715    /// nothing — and the one where the index and the span cannot disagree.
1716    ///
1717    /// **Red run** (2026-08-12), `eval_program` +
1718    /// `.map_err(|e| RunError::Eval(e.to_string()))` restored:
1719    /// ```text
1720    /// left:  "runtime error: unbound symbol: nani_mo_nai at 17..28"
1721    /// right: "runtime error: honmono.b:5:1: unbound symbol `nani_mo_nai`"
1722    /// ```
1723    ///
1724    /// **Second red run**, `lower_to_spanned` reinstated after erasure — the
1725    /// one that isolates the SPAN half from the index half, since a
1726    /// single-file program cannot get its file wrong:
1727    /// ```text
1728    /// left:  "runtime error: honmono.b: unbound symbol `nani_mo_nai`"
1729    /// right: "runtime error: honmono.b:5:1: unbound symbol `nani_mo_nai`"
1730    /// ```
1731    #[test]
1732    fn a_raise_in_the_entry_file_names_the_entry_file() {
1733        let err = run_named(
1734            "honmono.b",
1735            "def f()\n  1\nend\n\n# waive B0001: a raise at runtime\nnani_mo_nai()\n",
1736        );
1737        assert_eq!(
1738            err.to_string(),
1739            "runtime error: honmono.b:6:1: unbound symbol `nani_mo_nai`"
1740        );
1741    }
1742
1743    /// A raise from a form that came through the SURFACE-level erasure still
1744    /// reports a real position — the annotated path, where erasure rewrites
1745    /// the node rather than passing it through.
1746    ///
1747    /// Separate from the two above because the erasure rewrite is the only
1748    /// place a node is built rather than kept, and a synthetic span there
1749    /// would be invisible to a fixture whose failing form is untouched.
1750    ///
1751    /// **Red run** (2026-08-12), `lower_to_spanned` reinstated after erasure:
1752    /// ```text
1753    /// left:  "runtime error: chuu.b: unbound symbol `mada_nai`"
1754    /// right: "runtime error: chuu.b:2:3: unbound symbol `mada_nai`"
1755    /// ```
1756    #[test]
1757    fn a_raise_inside_an_annotated_def_still_names_its_line() {
1758        let err = run_named(
1759            "chuu.b",
1760            "# waive B0001: a raise at runtime\ndef f(a: Int) -> Int\n  mada_nai(a)\nend\n\nf(1)\n",
1761        );
1762        assert_eq!(
1763            err.to_string(),
1764            "runtime error: chuu.b:3:3: unbound symbol `mada_nai`\n  \
1765             at f (chuu.b:3:3)\n  \
1766             at <top level> (chuu.b:6:1)"
1767        );
1768    }
1769
1770    /// **The limit this module used to state, closed by the call stack.**
1771    ///
1772    /// A top-level form in the entry file calls a function defined in an
1773    /// imported one, and the raise happens inside the callee. The executing
1774    /// form is the entry's and the span is the callee's bytes, so until the
1775    /// evaluator reported the frames an error unwound through, the best blue
1776    /// could do was name the caller's file with no position (the guard in
1777    /// `uses::ResolvedProgram::locate` refusing an offset it could not
1778    /// justify). The innermost frame's definition now names the file the
1779    /// offsets belong to, and the stack shows the call that led there.
1780    ///
1781    /// **Red run** (2026-10-10): `Fault::of` locating against the executing
1782    /// top-level form instead of the innermost frame's definition:
1783    /// ```text
1784    /// left:  "runtime error: yobidashi.b: unbound symbol `kore_wa_sonzai_shinai`\n  at bakuhatsu2::yobu (bakuhatsu2.b:3:3)\n  at <top level> (yobidashi.b:3:1)"
1785    /// ```
1786    /// The old answer, kept by the guard: the caller's file and no position.
1787    #[test]
1788    fn a_raise_in_a_callee_from_another_file_names_the_callees_file() {
1789        // The comment is padding, and load-bearing: `bakuhatsu2.b`'s failing
1790        // call starts at byte 47 (after its waiver line) and ends at 70, and
1791        // this file is 57 bytes, so the start is in range here and the end is
1792        // not — a mis-attribution would still be refused rather than placed.
1793        let err = run_named(
1794            "yobidashi.b",
1795            "use(\"bakuhatsu2\")\n# pad: 47's in range\nbakuhatsu2::yobu\n",
1796        );
1797        assert_eq!(
1798            err.to_string(),
1799            "runtime error: bakuhatsu2.b:3:3: unbound symbol `kore_wa_sonzai_shinai`\n  \
1800             at bakuhatsu2::yobu (bakuhatsu2.b:3:3)\n  \
1801             at <top level> (yobidashi.b:3:1)"
1802        );
1803    }
1804}
1805
1806#[cfg(test)]
1807mod tests {
1808    use super::*;
1809
1810    fn int(src: &str) -> i64 {
1811        match run(src).unwrap_or_else(|e| panic!("{src:?}: {e}")).value {
1812            Value::Int(v) => v,
1813            other => panic!("{src:?} produced {other:?}"),
1814        }
1815    }
1816
1817    /// **The sliding scale, as one assertion.** Annotating changes the
1818    /// analysis and nothing else.
1819    #[test]
1820    fn annotating_buys_analysis_and_changes_nothing_else() {
1821        let plain = run("def add(a, b)\n  a + b\nend\nadd(2, 3)").expect("plain");
1822        let typed = run("def add(a: Int, b: Int) -> Int\n  a + b\nend\nadd(2, 3)").expect("typed");
1823
1824        assert!(matches!(plain.value, Value::Int(5)));
1825        assert!(
1826            matches!(typed.value, Value::Int(5)),
1827            "the annotated program must compute the same answer"
1828        );
1829        assert_eq!(plain.visited, 0, "no annotations means no analysis");
1830        assert!(
1831            typed.visited > 0,
1832            "an annotation must actually buy analysis, not just decorate"
1833        );
1834        assert_eq!(plain.typed_decls, 0);
1835        assert_eq!(typed.typed_decls, 1);
1836    }
1837
1838    /// **Checking happens before erasure.** This is the test that catches the
1839    /// reordering: a program with a declared-type violation must be rejected,
1840    /// and it can only be rejected while the annotations still exist.
1841    #[test]
1842    fn a_type_error_is_reported_and_the_program_does_not_run() {
1843        let err = run("def add(a: Int, b: Int) -> Str\n  a + b\nend\nadd(1, 2)")
1844            .expect_err("a declared Str return from an Int body must be rejected");
1845        assert!(
1846            matches!(err, RunError::Types(ref d) if !d.is_empty()),
1847            "expected type diagnostics, got {err}"
1848        );
1849    }
1850
1851    /// And the untyped version of the same program runs, so the rejection
1852    /// above is the annotation's doing rather than a parse failure.
1853    #[test]
1854    fn the_same_program_without_annotations_runs() {
1855        assert_eq!(int("def add(a, b)\n  a + b\nend\nadd(1, 2)"), 3);
1856    }
1857
1858    #[test]
1859    fn a_parse_error_is_reported_as_one() {
1860        assert!(matches!(run("def (").unwrap_err(), RunError::Parse(_)));
1861    }
1862
1863    /// Every stage reports in its own vocabulary, so a failure names which
1864    /// stage failed rather than surfacing as a generic error.
1865    #[test]
1866    fn a_runtime_error_is_reported_as_one() {
1867        let err = run("throw(error(\"boom\"))").expect_err("a raise");
1868        assert!(matches!(err, RunError::Eval(_)), "got {err}");
1869    }
1870
1871    /// Stdlib and primitives are both reachable through the pipeline — the
1872    /// gap that made `6 % 3` fail.
1873    #[test]
1874    fn the_pipeline_reaches_both_runtime_layers() {
1875        assert_eq!(int("6 % 3"), 0);
1876        assert_eq!(int("7 % 3"), 1);
1877        assert_eq!(int("2 + 3 * 4"), 14);
1878    }
1879
1880    /// **The deleted hop was a no-op on everything blue emits — so removing it
1881    /// is a swap, not a behaviour change.**
1882    ///
1883    /// The old lowering printed the erased tree and read it back through
1884    /// `tatara_lisp::read_spanned`. This walks a corpus and asserts the two
1885    /// paths land on the same tree, which is the equivalence the swap rests on.
1886    /// It is stated as a *measurement over this corpus*, not as a theorem:
1887    /// the round trip is not identity in general (that is precisely why it had
1888    /// to go), it merely happened to be identity for the bytes blue emits.
1889    #[test]
1890    fn the_deleted_round_trip_agreed_with_the_direct_lowering() {
1891        let corpus = [
1892            "def add(a, b)\n  a + b\nend\nadd(2, 3)",
1893            "def fact(n)\n  if n < 2\n    1\n  else\n    n * fact(n - 1)\n  end\nend\nfact(5)",
1894            "def f(a, b)\n  c = a + b\n  c * 2\nend\nf(1, 2)",
1895            "defmacro sq(e)\n  quote\n    unquote(e) * unquote(e)\n  end\nend\nsq(2 + 3)",
1896            "\"a string with spaces, a ( and a )\"",
1897            "def g(a: Int) -> Int\n  a + 1\nend\ng(1)",
1898            "6 % 3",
1899            "1.5 + 2.25",
1900        ];
1901        for src in corpus {
1902            // Projected to `Sexp` because that is what the deleted hop
1903            // operated on. Erasure itself no longer goes near it.
1904            let erased = crate::to_sexps(&erase_types(&parse_tree(src).expect("parse")));
1905
1906            let direct: Vec<Sexp> = crate::lower_to_spanned(&erased)
1907                .iter()
1908                .map(tatara_lisp::Spanned::to_sexp)
1909                .collect();
1910            assert_eq!(direct, erased, "the direct lowering must be the identity");
1911
1912            let text = erased
1913                .iter()
1914                .map(ToString::to_string)
1915                .collect::<Vec<_>>()
1916                .join("\n");
1917            let round_tripped: Vec<Sexp> = tatara_lisp::read_spanned(&text)
1918                .unwrap_or_else(|e| panic!("{src:?}: the old path could not read back: {e:?}"))
1919                .iter()
1920                .map(tatara_lisp::Spanned::to_sexp)
1921                .collect();
1922            assert_eq!(
1923                round_tripped, erased,
1924                "{src:?}: the old print-and-reparse path changed the tree"
1925            );
1926        }
1927    }
1928
1929    /// Anti-vacuity for the test above: the round trip really is *not* the
1930    /// identity in general, so agreeing on the corpus was a property of what
1931    /// blue happens to emit rather than a property of the reader.
1932    ///
1933    /// **`Atom::Symbol`'s `Display` writes the name raw, with no escaping.**
1934    /// `Atom::Str` escapes and its docs explain at length why; the symbol arm
1935    /// is `f.write_str(s)`. So print-then-read is not inverse over the symbol
1936    /// domain, and the failure is *silent*: a symbol containing a space prints
1937    /// as two tokens, reads back as two symbols, and the result is a perfectly
1938    /// well-formed tree with a different meaning. No error, nothing to catch.
1939    ///
1940    /// Measured 2026-08-02 across the separators: `a b` and `x'y` come back
1941    /// `Ok` with a different tree; `x)y`, `x"y` and `x;y` come back `Err`;
1942    /// `x{y` and `x[y` DO round-trip at this level — those two are one symbol
1943    /// in and one symbol out, so the brace-fusion reported in tatara *source*
1944    /// is not what bites a printed tree. The silent pair is what makes this a
1945    /// miscompile class rather than a noisy one.
1946    #[test]
1947    fn the_round_trip_is_not_the_identity_in_general() {
1948        let tree = Sexp::List(vec![
1949            Sexp::Atom(tatara_lisp::Atom::Symbol("f".into())),
1950            Sexp::Atom(tatara_lisp::Atom::Symbol("a b".into())),
1951        ]);
1952        let text = tree.to_string();
1953        let back: Vec<Sexp> = tatara_lisp::read_spanned(&text)
1954            .expect("it reads back cleanly — that IS the problem")
1955            .iter()
1956            .map(tatara_lisp::Spanned::to_sexp)
1957            .collect();
1958        assert_ne!(
1959            back,
1960            vec![tree.clone()],
1961            "if print-then-read became inverse over symbols, the class would be \
1962             closed upstream and this test should be deleted rather than relaxed"
1963        );
1964        // …and the direct lowering is unaffected by any of it.
1965        let direct: Vec<Sexp> = crate::lower_to_spanned(std::slice::from_ref(&tree))
1966            .iter()
1967            .map(tatara_lisp::Spanned::to_sexp)
1968            .collect();
1969        assert_eq!(direct, vec![tree]);
1970    }
1971}
1972
1973#[cfg(test)]
1974mod macro_tests {
1975    use super::*;
1976
1977    fn int(src: &str) -> i64 {
1978        match run(src).unwrap_or_else(|e| panic!("{src:?}: {e}")).value {
1979            Value::Int(v) => v,
1980            other => panic!("{src:?} produced {other:?}"),
1981        }
1982    }
1983
1984    /// **A blue macro expands and runs.** Tenet 2's surface, end to end.
1985    #[test]
1986    fn a_macro_expands_and_runs() {
1987        assert_eq!(
1988            int("defmacro double(x)\n  quote\n    unquote(x) + unquote(x)\n  end\nend\ndouble(21)"),
1989            42
1990        );
1991    }
1992
1993    /// A macro receives *source forms*, not values — so it can duplicate its
1994    /// argument, which a function cannot do without re-evaluating it.
1995    #[test]
1996    fn a_macro_operates_on_syntax_not_values() {
1997        assert_eq!(
1998            int("defmacro sq(e)\n  quote\n    unquote(e) * unquote(e)\n  end\nend\nsq(2 + 3)"),
1999            25,
2000            "the argument form `2 + 3` must be substituted twice"
2001        );
2002    }
2003
2004    /// **A runaway macro is a typed error, not a dead compiler.** This is the
2005    /// property that makes the metaprogramming surface safe to hand to a user.
2006    ///
2007    /// The assertion was `contains("expansion limit")` and now reads
2008    /// `contains("expansion")`, because the pipeline renders `short_message`
2009    /// rather than `Display`: upstream words the same fact as "exceeded 256
2010    /// expansion steps" instead of "exceeded the expansion limit of 256
2011    /// rewrites". The PROPERTY is unchanged and still asserted — the macro is
2012    /// named, and the failure is attributed to expansion rather than to
2013    /// evaluation. **This reword was the whole measured blast radius of that
2014    /// switch**, one test in the workspace.
2015    ///
2016    /// The number is deliberately NOT pinned. It is upstream's constant, this
2017    /// test owns none of it, and matching it would turn an upstream bump into
2018    /// a red run here that proves nothing about blue.
2019    ///
2020    /// The third clause is new capability rather than repair: the message now
2021    /// carries `<anonymous>:6:1`, so a runaway macro says WHERE it ran away.
2022    #[test]
2023    fn a_runaway_macro_fails_the_compilation_rather_than_the_process() {
2024        let err =
2025            run("defmacro forever(x)\n  quote\n    forever(unquote(x))\n  end\nend\nforever(1)")
2026                .expect_err("a self-referential macro must be rejected");
2027        let msg = err.to_string();
2028        assert!(
2029            msg.contains("forever") && msg.contains("expansion"),
2030            "the error must name the macro and the limit it hit: {msg}"
2031        );
2032        assert!(
2033            msg.contains("<anonymous>:6:1"),
2034            "and must place the call that ran away — line 6 is `forever(1)`: {msg}"
2035        );
2036    }
2037}
2038
2039#[cfg(test)]
2040mod input_tests {
2041    use super::*;
2042    use crate::inputs::{Declaration, Inputs};
2043
2044    /// A schema a macro will generate code from.
2045    const SCHEMA: &[u8] = b"3";
2046
2047    fn with_schema(src: &str) -> Result<Run, RunError> {
2048        let hash = Inputs::hash_of(SCHEMA);
2049        let mut inputs = Inputs::new();
2050        inputs
2051            .bind(
2052                &Declaration {
2053                    name: "schema".to_string(),
2054                    hash,
2055                },
2056                SCHEMA.to_vec(),
2057            )
2058            .expect("bind");
2059        run_with_inputs(src, inputs)
2060    }
2061
2062    fn decl_line() -> String {
2063        let mut s = String::from("definput(\"schema\", \"");
2064        s.push_str(&Inputs::hash_of(SCHEMA));
2065        s.push_str("\")\n");
2066        s
2067    }
2068
2069    /// **A macro reads a declared build input.** This is §VI OPEN #6 closed —
2070    /// the spec names it as gating blue's whole "stronger than Ruby's
2071    /// metaprogramming" claim, because a macro that cannot read a schema cannot
2072    /// generate code from one.
2073    #[test]
2074    fn a_macro_can_read_a_declared_build_input() {
2075        let src = decl_line() + "input(\"schema\")";
2076        let out = with_schema(&src).expect("run");
2077        assert!(
2078            matches!(out.value, Value::Str(ref s) if &**s == "3"),
2079            "got {:?}",
2080            out.value
2081        );
2082    }
2083
2084    /// **An undeclared input is an error, not a file read and not nil.**
2085    /// Returning nil is how a macro generates an empty table and nobody notices
2086    /// until runtime.
2087    #[test]
2088    fn an_undeclared_input_is_an_error() {
2089        let err = with_schema("input(\"not_declared\")").expect_err("must fail");
2090        let msg = err.to_string();
2091        assert!(msg.contains("not_declared"), "must name it: {msg}");
2092        assert!(msg.contains("definput"), "and say how to declare it: {msg}");
2093    }
2094
2095    /// **There is no path-based read at all.** The capability is the absence of
2096    /// the primitive, not a check inside one — so this is an unbound symbol.
2097    ///
2098    /// Holds for the DEFAULT surface — the one every embedder gets. The `sys`
2099    /// cargo feature (CLI only) is the one declared exception: it is the
2100    /// operator's own trusted host surface, and is asserted in
2101    /// `sys_read_file_is_the_trusted_cli_only_exception` below.
2102    #[cfg(not(feature = "sys"))]
2103    #[test]
2104    fn there_is_no_ambient_file_read() {
2105        for attempt in [
2106            "read_file(\"/etc/passwd\")",
2107            "File(\"/etc/passwd\")",
2108            "slurp(\"/etc/passwd\")",
2109            "open(\"/etc/passwd\")",
2110        ] {
2111            let err = with_schema(attempt).expect_err("must not resolve");
2112            assert!(
2113                err.to_string().contains("unbound"),
2114                "{attempt} must be UNBOUND — a capability removed by absence, \
2115                 not guarded by a check: {err}"
2116            );
2117        }
2118    }
2119
2120    /// With the `sys` feature compiled in, `read_file` IS bound — that is the
2121    /// point of the feature. The doctrine does not move: this is the operator's
2122    /// own machine (the CLI), not an embedder's sandbox. Pin the boundary so a
2123    /// future default-build change is heard, and assert that `input()` still
2124    /// works beside it.
2125    #[cfg(feature = "sys")]
2126    #[test]
2127    fn sys_read_file_is_the_trusted_cli_only_exception() {
2128        let err = with_schema("definitely_not_a_primitive(\"x\")").expect_err("must not resolve");
2129        assert!(err.to_string().contains("unbound"), "{err}");
2130        assert!(
2131            with_schema("read_file(\"/etc/passwd\")").is_ok(),
2132            "with `sys` on, read_file is the trusted CLI surface"
2133        );
2134        let out = with_schema("input(\"schema\")").expect("run");
2135        assert!(
2136            matches!(out.value, Value::Str(ref s) if &**s == "3"),
2137            "input() still binds beside the sys surface: {:?}",
2138            out.value
2139        );
2140    }
2141
2142    /// Anti-vacuity: with no inputs supplied at all, even a declared name fails
2143    /// — so the success above is the binding's doing.
2144    #[test]
2145    fn a_declared_input_with_no_bytes_supplied_fails() {
2146        let src = decl_line() + "input(\"schema\")";
2147        assert!(run(&src).is_err(), "no bytes were supplied");
2148    }
2149}
2150
2151#[cfg(test)]
2152mod tier2_tests {
2153    use super::*;
2154    use crate::inputs::{Declaration, Inputs};
2155
2156    /// **The Tier-2 conversion §V.6.3 said was gated: a macro that emits real
2157    /// declarations FROM A SCHEMA.**
2158    ///
2159    /// `theory/BLUE.md` §VI OPEN #6 states the blocker plainly — "tenet 2
2160    /// installs a `NoLoader`, so a macro cannot read a schema — which gates
2161    /// every Tier-2 conversion in §V.6 and therefore blue's whole 'stronger than
2162    /// Ruby's metaprogramming' claim."
2163    ///
2164    /// Here the schema supplies a *value the generated code depends on*, read at
2165    /// expansion time. Ruby and Elixir can both do this — with the whole
2166    /// filesystem open. blue does it through a name bound to a content hash.
2167    #[test]
2168    fn a_macro_generates_code_from_a_schema() {
2169        let schema = b"7";
2170        let mut inputs = Inputs::new();
2171        inputs
2172            .bind(
2173                &Declaration {
2174                    name: "arity".to_string(),
2175                    hash: Inputs::hash_of(schema),
2176                },
2177                schema.to_vec(),
2178            )
2179            .expect("bind");
2180
2181        // The macro reads the input at EXPANSION time and splices the value it
2182        // found into the code it emits.
2183        let mut src = String::from("definput(\"arity\", \"");
2184        src.push_str(&Inputs::hash_of(schema));
2185        src.push_str("\")\n");
2186        src.push_str(
2187            "defmacro from_schema()\n  quote\n    unquote(to_int(input(\"arity\")))\n  end\nend\n\
2188             from_schema() * 6",
2189        );
2190
2191        let out = run_with_inputs(&src, inputs).expect("run");
2192        assert!(
2193            matches!(out.value, Value::Int(42)),
2194            "the schema's 7 must reach the generated code: got {:?}",
2195            out.value
2196        );
2197    }
2198}