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    // The interpreter is built BEFORE the check stage, because it is the check
183    // stage's name oracle: every builtin, macro and special form a program may
184    // name is read off the interpreter that will run it, never off a list.
185    // Building it is not a stage; nothing is evaluated until `eval_prepared`.
186    let mut interp = crate::interpreter_hostless();
187    crate::inputs::install_input_primitives(&mut interp, inputs);
188    let prepared = prepare(entry, loader, surface, &builtin_names(&interp))?;
189    let value = eval_prepared(&mut interp, &prepared, &mut ())?;
190    Ok(Run {
191        value,
192        visited: prepared.visited,
193        typed_decls: prepared.typed_decls,
194        seams: prepared.seams,
195    })
196}
197
198/// A run watched by a call observer, and the definitions the observer was
199/// built over.
200pub struct Observed {
201    pub definitions: std::sync::Arc<crate::observe::Definitions>,
202    /// The run itself: its value, or the error it stopped on.
203    pub outcome: Result<Run, RunError>,
204}
205
206/// [`run_in_surface`] with a call observer installed for the evaluation.
207/// `watch` builds the observer from the program's definitions once every stage
208/// before evaluation has passed; the profiler, the tracer and coverage are
209/// all built this way (`crate::observe::Recorder`).
210///
211/// # Errors
212///
213/// A parse, import or check error, which leaves nothing to run. A runtime
214/// error is the [`Observed::outcome`], so what ran before it is still read.
215pub fn run_observed(
216    entry: Entry<'_>,
217    inputs: Inputs,
218    loader: &dyn crate::uses::Loader,
219    surface: Option<&blue_lang_syntax::yakugo::Yakugo>,
220    watch: impl FnOnce(
221        &std::sync::Arc<crate::observe::Definitions>,
222    ) -> std::sync::Arc<dyn crate::observe::CallObserver>,
223) -> Result<Observed, RunError> {
224    let mut interp = crate::interpreter_hostless();
225    crate::inputs::install_input_primitives(&mut interp, inputs);
226    let prepared = prepare(entry, loader, surface, &builtin_names(&interp))?;
227    let definitions = std::sync::Arc::new(crate::observe::Definitions::of(
228        &prepared.program,
229        &prepared.erased,
230    ));
231    interp.set_call_observer(Some(watch(&definitions)));
232    let outcome = eval_prepared(&mut interp, &prepared, &mut ()).map(|value| Run {
233        value,
234        visited: prepared.visited,
235        typed_decls: prepared.typed_decls,
236        seams: prepared.seams,
237    });
238    interp.set_call_observer(None);
239    Ok(Observed {
240        definitions,
241        outcome,
242    })
243}
244
245/// A program past every stage before evaluation: parsed, its imports
246/// resolved, type-checked and erased. What [`run_in_surface`] and
247/// [`crate::hosted::load_hosted`] both evaluate, so the stage order this
248/// module exists to own is written once for both.
249pub(crate) struct Prepared {
250    program: crate::uses::ResolvedProgram,
251    erased: Vec<tatara_lisp::Spanned>,
252    visited: usize,
253    typed_decls: usize,
254    seams: usize,
255}
256
257impl Prepared {
258    /// The forms the evaluator will run: every file's, resolved and erased.
259    pub(crate) fn erased(&self) -> &[tatara_lisp::Spanned] {
260        &self.erased
261    }
262
263    /// The entry file's namespace.
264    pub(crate) fn entry_namespace(&self) -> Namespace {
265        let first = (0..self.program.forms().len())
266            .find(|i| self.program.owner_of(*i) == Some(crate::uses::ResolvedProgram::ENTRY));
267        match first {
268            Some(i) => namespace_of(&self.program, i),
269            None => match self
270                .program
271                .file(crate::uses::ResolvedProgram::ENTRY)
272                .and_then(|f| f.package.clone())
273            {
274                Some(p) => Namespace::Bidama(p),
275                None => Namespace::File(String::new()),
276            },
277        }
278    }
279}
280
281/// Parse, resolve, check and erase, in that order.
282///
283/// `builtins` is the name table of the interpreter that will evaluate the
284/// result ([`builtin_names`]); the check stage resolves the program's names
285/// against it.
286pub(crate) fn prepare(
287    entry: Entry<'_>,
288    loader: &dyn crate::uses::Loader,
289    surface: Option<&blue_lang_syntax::yakugo::Yakugo>,
290    builtins: &NameTable,
291) -> Result<Prepared, RunError> {
292    let mut program = parse_and_resolve(entry, loader, surface)?;
293
294    // `test` blocks are declarations for the harness, not code to run.
295    //
296    // Dropped here rather than in `resolve_uses`, because `blue test` calls
297    // the resolver and then NEEDS the entry file's blocks — so the two
298    // callers want different things and the split has to live at this level.
299    //
300    // Without this, `blue run` on a file containing its own tests fails with
301    // `unbound symbol: deftest`: every package in the bidama distribution
302    // carries tests, so every one of them was unrunnable.
303    //
304    // Through `retain`, which drops each form's owner with it. A plain filter
305    // over the forms alone would slide every later form onto the wrong file.
306    program.retain(|f| !crate::uses::is_test_form(f));
307
308    // CHECK, on the annotated tree — the only tree that has annotations.
309    //
310    // **On the REAL spanned tree, including every imported package's.** This
311    // was the one caller that checked a spanless lift, because `resolve_uses`
312    // flattened the entry file and its imports into one list and `Span` is a
313    // byte range with no file identity — so a real span here would have
314    // reported an imported package's error at that offset in the ENTRY file, a
315    // precise-looking answer pointing at unrelated code.
316    //
317    // The fix is not a wider `Span` (that type is upstream, and its own docs
318    // put file identity on the caller: spans "are meaningful only relative to
319    // the string that produced them, which the caller is responsible for
320    // holding onto"). blue holds onto it BESIDE the span, per top-level form —
321    // see `uses::ResolvedProgram`.
322    let (outcome, names) = check_stage(&program, builtins, false);
323    if !outcome.ok() {
324        return Err(RunError::Types(
325            outcome
326                .errors()
327                // `file:line:col: error[CODE]: message`, resolved against the
328                // file the form actually came from, then its help line.
329                .map(|d| render(&program, d))
330                .collect(),
331        ));
332    }
333
334    // ERASE, so the interpreter never sees a type — **on the spanned tree,
335    // and back out as one.**
336    //
337    // This used to be `erase_types(&program.sexps())` followed by a
338    // `lower_to_spanned` that stamped `Span::synthetic()` over every node, and
339    // the comment here said carrying real positions through was "a larger
340    // piece and is NOT built". It was not larger: erasure only ever DELETES
341    // nodes — the single node it invents is the `define` replacing
342    // `define-typed` — so there was never anything for a synthetic span to
343    // stand in for. See `crate::erase`.
344    //
345    // No lowering step follows. The tree the evaluator receives IS the tree the
346    // parser built, minus annotations, with the author's byte offsets intact.
347    let erased = erase_types(&lower(&program, &names));
348
349    Ok(Prepared {
350        program,
351        erased,
352        visited: outcome.stats.visited,
353        typed_decls: outcome.stats.typed_decls,
354        seams: outcome.seams.len(),
355    })
356}
357
358/// Parse the entry (in `surface`, if one is given) and splice in its imports.
359pub(crate) fn parse_and_resolve(
360    entry: Entry<'_>,
361    loader: &dyn crate::uses::Loader,
362    surface: Option<&blue_lang_syntax::yakugo::Yakugo>,
363) -> Result<crate::uses::ResolvedProgram, RunError> {
364    let forms = match surface {
365        Some(pack) => blue_lang_syntax::parse_program_tree_in(entry.text, pack)
366            .map_err(|e| RunError::Parse(e.to_string()))?,
367        None => loader
368            .parse(entry.text)
369            .map_err(|e| RunError::Parse(e.to_string()))?,
370    };
371
372    // RESOLVE imports first, so everything below sees ONE program.
373    //
374    // Before the check on purpose: imported code is type-checked at the point
375    // its consumer imports it, rather than at whatever later moment its code
376    // first runs. A package that does not typecheck should break its importer's
377    // build, not their production run.
378    //
379    // One program, but not one FILE: the result records which file each
380    // top-level form came from, which is what lets a diagnostic below name a
381    // place instead of only a problem.
382    crate::uses::resolve_uses(forms, entry, loader).map_err(RunError::Import)
383}
384
385/// **The check stage**: every rule in `blue_lang_check::RULES`, over a
386/// resolved program, with waivers applied.
387///
388/// One function, called by every door — `run`, the hosted loader, `blue test`
389/// and `blue check` — so a rule added to the registry is enforced by all of
390/// them at once. That is what makes an architecture rule a pipeline error
391/// rather than an optional report: there is no door that skips it.
392///
393/// Warnings (unused bindings, unused waivers) are reported for the ENTRY
394/// file only; an imported package's warnings belong to its author. Errors
395/// are reported for every file, because an imported package with one is
396/// broken for its importer.
397pub(crate) fn check_stage(
398    program: &crate::uses::ResolvedProgram,
399    builtins: &NameTable,
400    with_tests: bool,
401) -> (blue_lang_check::Outcome, NameTable) {
402    use crate::uses::ResolvedProgram;
403    let forms = program.forms();
404    let is_entry = |i: usize| program.owner_of(i) == Some(ResolvedProgram::ENTRY);
405
406    // Rules B0003–B0005: the typing ladder.
407    let mut outcome = blue_lang_check::check_program(forms);
408
409    // Rules B0001–B0002: names. The program's own scopes come first (the
410    // entry file, then each bidama in import order), then the interpreter's.
411    let table = program_names(program, builtins);
412    let whole = |i: usize| with_tests && is_entry(i);
413    let (names, resolved) = blue_lang_check::names::check_names_whole(
414        forms,
415        &table,
416        &|i| namespace_of(program, i),
417        &is_entry,
418        &whole,
419    );
420    outcome.diagnostics.extend(names);
421    outcome.stats.names_resolved = resolved;
422
423    // Waivers, per file: B0007 for a malformed one, B0008 for one that
424    // suppresses nothing.
425    let mut waivers = Vec::new();
426    for file in program.files() {
427        let spans: Vec<(usize, tatara_lisp::Span)> = forms
428            .iter()
429            .enumerate()
430            .filter(|(i, _)| program.owner_of(*i) == Some(file.id))
431            .map(|(i, f)| (i, f.span))
432            .collect();
433        let (found, malformed) = blue_lang_check::waiver::collect(&file.text, &spans);
434        waivers.extend(found);
435        outcome.diagnostics.extend(malformed);
436    }
437    outcome.waived = blue_lang_check::waiver::apply(&mut outcome.diagnostics, waivers, &is_entry);
438    // A rule whose census has not reached zero is computed, and counted, but
439    // not enforced: its findings move to `census` (see `RULES`' `ratchet`).
440    let (enforced, census): (Vec<_>, Vec<_>) = std::mem::take(&mut outcome.diagnostics)
441        .into_iter()
442        .partition(|d| d.code.rule().active());
443    outcome.diagnostics = enforced;
444    outcome.census = census;
445    outcome
446        .diagnostics
447        .sort_by_key(|d| (d.top_level, d.span.start, d.code));
448    (outcome, table)
449}
450
451/// The whole name table the check stage resolves against: the program's
452/// own scopes (each file and bidama, by namespace) followed by `builtins`.
453///
454/// **A top-level call to a builtin macro can define names**: `defflow(slug,
455/// trim, downcase)` expands to `(define slug …)`, and nothing in the source
456/// spells `define`. Such a call is expanded here, on a hostless fork, and what
457/// its expansion defines is bound in the calling file's namespace. Only
458/// BUILTIN macros are expanded: their bodies are the runtime's own
459/// templates. A program's own `defmacro` is not run at check time — checking a
460/// file (and an editor checking on every keystroke) must not execute the code
461/// it checks — so names a program macro generates are not seen; none of the
462/// corpus's macros generates one (measured 2026-09-29).
463#[must_use]
464pub fn program_names(program: &crate::uses::ResolvedProgram, builtins: &NameTable) -> NameTable {
465    use blue_lang_check::Binding;
466    let mut table = NameTable::new();
467    table.add_program(program.forms(), |i| namespace_of(program, i));
468    let builtin_macro = |head: &str| {
469        builtins
470            .scopes()
471            .iter()
472            .any(|s| s.namespace == Namespace::Macro && s.get(head).is_some())
473    };
474    let mut expander: Option<tatara_lisp_eval::Interpreter<()>> = None;
475    for (i, form) in program.forms().iter().enumerate() {
476        let Some(head) = form
477            .as_list()
478            .and_then(|items| items.first())
479            .and_then(tatara_lisp::Spanned::as_symbol)
480        else {
481            continue;
482        };
483        if !builtin_macro(head) {
484            continue;
485        }
486        let interp = expander.get_or_insert_with(crate::interpreter_hostless);
487        // A failed expansion defines nothing here; the evaluator will report
488        // it, with its position, when the form runs.
489        let Ok(expanded) = interp.fully_expand(form, &mut ()) else {
490            continue;
491        };
492        for (name, span, kind) in blue_lang_check::names::definitions_of(&expanded) {
493            table.define(
494                namespace_of(program, i),
495                Binding {
496                    name,
497                    kind,
498                    span: Some(span),
499                    top_level: Some(i),
500                },
501            );
502        }
503    }
504    for scope in builtins.scopes() {
505        table.push(scope.clone());
506    }
507    let form_file: Vec<usize> = (0..program.forms().len())
508        .map(|i| program.owner_of(i).map_or(usize::MAX, |f| f.index()))
509        .collect();
510    let mut imports: std::collections::BTreeMap<usize, blue_lang_check::names::FileImports> =
511        std::collections::BTreeMap::new();
512    for (file, import) in program.imports() {
513        let entry = imports.entry(file.index()).or_default();
514        entry.add(&import.package, import.names.iter().map(|(n, _)| n.clone()));
515        let at = import.span.start;
516        entry.use_at = Some(entry.use_at.map_or(at, |a| a.min(at)));
517    }
518    // A FACADE — a bidama that defines nothing and `use`s others (zenbu) —
519    // exists so a consumer can depend on "everything": `use("zenbu")` makes
520    // every member's QUALIFIER reachable (`toukei::median`), never a bare
521    // name. Followed to a fixpoint, so a facade of facades works too.
522    let facade_uses =
523        |pkg: &str,
524         imports: &std::collections::BTreeMap<usize, blue_lang_check::names::FileImports>| {
525            let defines = table.bidama(pkg).is_some_and(|s| !s.is_empty());
526            if defines {
527                return std::collections::BTreeSet::new();
528            }
529            program
530                .files()
531                .iter()
532                .filter(|f| f.package.as_deref() == Some(pkg))
533                .filter_map(|f| imports.get(&f.id.index()))
534                .flat_map(|i| i.uses.iter().cloned())
535                .collect::<std::collections::BTreeSet<String>>()
536        };
537    loop {
538        let mut grew = false;
539        let files: Vec<usize> = imports.keys().copied().collect();
540        for f in files {
541            let used: Vec<String> = imports[&f].uses.iter().cloned().collect();
542            for p in used {
543                for member in facade_uses(&p, &imports) {
544                    if let Some(i) = imports.get_mut(&f) {
545                        if i.uses.insert(member.clone()) {
546                            i.via.insert(member, p.clone());
547                            grew = true;
548                        }
549                    }
550                }
551            }
552        }
553        if !grew {
554            break;
555        }
556    }
557    let mut pkg_uses: std::collections::BTreeMap<String, std::collections::BTreeSet<String>> =
558        std::collections::BTreeMap::new();
559    for (file, import) in program.imports() {
560        if let Some(p) = program.file(*file).and_then(|f| f.package.clone()) {
561            pkg_uses
562                .entry(p)
563                .or_default()
564                .insert(import.package.clone());
565        }
566    }
567    table.attach_files(form_file, imports);
568    table.attach_package_uses(pkg_uses);
569    table.attach_needs(program.needs().clone());
570    // Where each file lives and which distribution each bidama ships in: a
571    // bridge reference (B0021) is an error inside the bidama's own
572    // distribution and a warning outside it.
573    let canonical = |p: &std::path::Path| {
574        std::fs::canonicalize(p)
575            .unwrap_or_else(|_| p.to_path_buf())
576            .display()
577            .to_string()
578    };
579    let mut file_paths = std::collections::BTreeMap::new();
580    let mut pkg_roots = std::collections::BTreeMap::new();
581    for f in program.files() {
582        if let Some(path) = &f.path {
583            file_paths.insert(f.id.index(), canonical(path));
584            if let (Some(pkg), Some(root)) =
585                (&f.package, path.parent().and_then(std::path::Path::parent))
586            {
587                pkg_roots
588                    .entry(pkg.clone())
589                    .or_insert_with(|| canonical(root));
590            }
591        }
592    }
593    table.attach_paths(file_paths, pkg_roots);
594    let versions = program.versions().clone();
595    table.apply_legacy(program.forms(), &|i| namespace_of(program, i), &|p| {
596        versions.get(p).cloned()
597    });
598    table
599}
600
601/// The forms the evaluator runs, from a checked program: every `use`
602/// declaration inert (`nil`, so each index still names its top-level form)
603/// and every name at the key it runs under — the RESOLVED tree under
604/// per-bidama namespaces (`blue_lang_check::names::Resolved::resolved_tree`).
605///
606/// A definition runs as `retsu/first` (a script's as `%root/f`), a
607/// reference to it as the same key, and a builtin as its bare name. Keys
608/// cannot collide across namespaces, so a bidama's `first` no longer
609/// replaces the builtin for anyone who did not import it, and an importer's
610/// `helper` no longer replaces a bidama's own: the runtime binds exactly what
611/// the check stage resolved.
612#[must_use]
613pub fn lower(
614    program: &crate::uses::ResolvedProgram,
615    names: &NameTable,
616) -> Vec<tatara_lisp::Spanned> {
617    let resolved = blue_lang_check::names::resolve_program(program.forms(), names, &|i| {
618        namespace_of(program, i)
619    });
620    resolved
621        .resolved_tree(program.forms(), blue_lang_check::names::Rule::Namespaced)
622        .into_iter()
623        .zip(program.forms())
624        .map(|(resolved, written)| {
625            if crate::uses::use_target(written).is_some()
626                || blue_lang_syntax::scope::legacy_target(written).is_some()
627            {
628                tatara_lisp::Spanned::new(written.span, tatara_lisp::SpannedForm::Nil)
629            } else {
630                resolved
631            }
632        })
633        .collect()
634}
635
636/// The namespace top-level form `i` of `program` defines into.
637#[must_use]
638pub fn namespace_of(program: &crate::uses::ResolvedProgram, i: usize) -> Namespace {
639    let file = program.owner_of(i).and_then(|id| program.file(id));
640    match file {
641        Some(f) => match &f.package {
642            Some(p) => Namespace::Bidama(p.clone()),
643            None => Namespace::File(
644                f.path
645                    .as_ref()
646                    .map_or_else(|| "<anonymous>".to_string(), |p| p.display().to_string()),
647            ),
648        },
649        None => Namespace::File("<unknown file>".to_string()),
650    }
651}
652
653/// Names only the test harness binds.
654///
655/// In scope for EVERY check, not only for test blocks. A bidama may carry a
656/// test helper — a plain `def` that asserts, called only from its `test`
657/// blocks (`heni`'s `hn_end_to_end` is one) — and every program importing that
658/// bidama would otherwise be refused for a function it never calls. The
659/// refusal would be scoped to the importer's whole program, not to the fault.
660/// The cost, stated: an `assert` outside any test that `blue run` actually
661/// reaches is caught at runtime (`blue-assert` is unbound there), not here.
662///
663/// `blue-lang-test` registers these on its own interpreter, and this crate
664/// cannot depend on it (it depends on this one), so the list lives beside the
665/// only name in it: the lowered `assert`, which `blue-lang-syntax` owns.
666pub const HARNESS_NAMES: &[&str] = &[blue_lang_syntax::LOWERED_ASSERT];
667
668/// The check stage's builtin scopes, read off the interpreter that will run
669/// the program: the test harness's names ([`HARNESS_NAMES`]), then its special
670/// forms, its macros, and every value it binds — the last three in the order
671/// the evaluator consults for a head.
672///
673/// Read from a live interpreter rather than a list, for the reason
674/// `Interpreter::resolve_head` gives: a list is a second copy of the truth and
675/// goes stale on the next installer that lands. An embedder's own
676/// primitives are in scope here because the embedder installs them first.
677#[must_use]
678pub fn builtin_names<H: 'static>(interp: &tatara_lisp_eval::Interpreter<H>) -> NameTable {
679    use blue_lang_check::{Binding, Scope, ScopeKind};
680    use tatara_lisp_eval::HeadBinding;
681    let mut special = Scope::new(Namespace::SpecialForm);
682    let mut macros = Scope::new(Namespace::Macro);
683    let mut values = Scope::new(Namespace::Builtin);
684    // `reserved_head_names` reads the ROOT frame only, so a name installed on
685    // a fork (the input primitives, on every `run`) is invisible to it; those
686    // are asked about by name instead, which `resolve_head` answers through
687    // every frame.
688    let mut names: Vec<std::sync::Arc<str>> = interp.reserved_head_names().into_iter().collect();
689    names.extend(
690        crate::inputs::INPUT_PRIMITIVES
691            .iter()
692            .filter(|n| interp.resolve_head(n).is_some())
693            .map(|n| std::sync::Arc::from(*n)),
694    );
695    for name in names {
696        let (scope, kind) = match interp.resolve_head(&name) {
697            Some(HeadBinding::SpecialForm) => (&mut special, ScopeKind::SpecialForm),
698            Some(HeadBinding::Macro) => (&mut macros, ScopeKind::Macro),
699            _ => (&mut values, ScopeKind::Value),
700        };
701        scope.bind(Binding {
702            name: name.to_string(),
703            kind,
704            span: None,
705            top_level: None,
706        });
707    }
708    let mut table = NameTable::new();
709    let mut harness = Scope::new(Namespace::Harness);
710    for n in HARNESS_NAMES {
711        harness.bind(Binding {
712            name: (*n).to_string(),
713            kind: ScopeKind::Value,
714            span: None,
715            top_level: None,
716        });
717    }
718    table.push(harness);
719    table.push(special);
720    table.push(macros);
721    table.push(values);
722    table
723}
724
725/// A diagnostic as a person reads it: `file:line:col: error[B0001]: message`,
726/// then an indented `help:` line when it has one.
727#[must_use]
728pub fn render(program: &crate::uses::ResolvedProgram, d: &blue_lang_check::Diagnostic) -> String {
729    let head = d.to_string();
730    let mut out = program.locate(d.top_level, d.span, &head).to_string();
731    if let Some(help) = &d.help {
732        out.push_str("\n  help: ");
733        out.push_str(help);
734    }
735    out
736}
737
738/// What [`check_entry`] checks.
739#[derive(Clone, Copy, Debug, PartialEq, Eq)]
740pub enum Checking {
741    /// The program `blue run` would evaluate: test blocks dropped.
742    Program,
743    /// The program plus the entry file's test blocks, as `blue test` and
744    /// `blue check` see it.
745    WithTests,
746}
747
748/// A program through the check stage, with everything the stage found.
749pub struct Checked {
750    pub program: crate::uses::ResolvedProgram,
751    pub outcome: blue_lang_check::Outcome,
752    /// The name table the stage resolved against: every program scope, then
753    /// the builtins. What an editor completes from.
754    pub names: NameTable,
755}
756
757impl Checked {
758    /// The forms an evaluator runs: [`lower`]ed, then erased — the tree
759    /// `run` evaluates, for a door that brings its own evaluator (the VM).
760    #[must_use]
761    pub fn erased(&self) -> Vec<tatara_lisp::Spanned> {
762        erase_types(&lower(&self.program, &self.names))
763    }
764
765    /// What `blue test` hands the harness: the program [`lower`]ed, spans
766    /// projected away.
767    #[must_use]
768    pub fn evaluable(&self) -> Vec<tatara_lisp::Sexp> {
769        lower(&self.program, &self.names)
770            .iter()
771            .map(tatara_lisp::Spanned::to_sexp)
772            .collect()
773    }
774
775    /// Every non-local reference, resolved under both rules — today's flat
776    /// one and per-bidama namespaces — and the resolved trees built from them
777    /// (`blue ast --resolved`).
778    #[must_use]
779    pub fn resolve(&self) -> blue_lang_check::names::Resolved {
780        blue_lang_check::names::resolve_program(self.program.forms(), &self.names, &|i| {
781            namespace_of(&self.program, i)
782        })
783    }
784}
785
786/// Parse, resolve and CHECK, without running: the door for `blue check`,
787/// `blue test` and the language server.
788///
789/// Returns every diagnostic, errors and warnings alike, rather than failing on
790/// the first error: a reader fixing a file wants the whole list, and an agent
791/// repairing one wants it in one pass. Whether errors stop anything is the
792/// caller's decision — `blue test` refuses to run tests over a program with
793/// one, exactly as `run` refuses to evaluate it.
794///
795/// The name oracle is the interpreter `blue run` would build: hostless plus
796/// input primitives.
797///
798/// # Errors
799///
800/// A parse or import error, which leaves no program to check.
801pub fn check_entry(
802    entry: Entry<'_>,
803    loader: &dyn crate::uses::Loader,
804    surface: Option<&blue_lang_syntax::yakugo::Yakugo>,
805    checking: Checking,
806) -> Result<Checked, RunError> {
807    let mut program = parse_and_resolve(entry, loader, surface)?;
808    if checking == Checking::Program {
809        program.retain(|f| !crate::uses::is_test_form(f));
810    }
811    let mut interp = crate::interpreter_hostless();
812    crate::inputs::install_input_primitives(&mut interp, Inputs::new());
813    let builtins = builtin_names(&interp);
814    let (outcome, names) = check_stage(&program, &builtins, checking == Checking::WithTests);
815    Ok(Checked {
816        program,
817        outcome,
818        names,
819    })
820}
821
822/// A syntax error in `text` as a [`B0006`](blue_lang_check::Code::B0006)
823/// diagnostic, so a tool reading `--format json` gets a parse failure in the
824/// same shape as every other finding. `None` when `text` parses.
825#[must_use]
826pub fn syntax_diagnostic(text: &str) -> Option<blue_lang_check::Diagnostic> {
827    let e = blue_lang_syntax::parse_program_tree(text).err()?;
828    Some(
829        blue_lang_check::Diagnostic::new(blue_lang_check::Code::B0006, e.message, e.span)
830            .at_top_level(0),
831    )
832}
833
834/// A runtime message as the author wrote the names in it: a definition runs
835/// under its key (`retsu/first`, `%root/f`), and a message naming one in
836/// backticks names it `retsu::first`, or `f` for the author's own script.
837#[must_use]
838pub fn display_keys(message: &str) -> String {
839    let mut out = String::with_capacity(message.len());
840    let mut parts = message.split('`');
841    if let Some(first) = parts.next() {
842        out.push_str(first);
843    }
844    for (i, part) in parts.enumerate() {
845        out.push('`');
846        // Odd pieces (0-based here) are inside backticks.
847        if i % 2 == 0 {
848            out.push_str(&crate::observe::display_key(part));
849        } else {
850            out.push_str(part);
851        }
852    }
853    out
854}
855
856/// Evaluate a prepared program's top-level forms into `interp`, with `host`.
857pub(crate) fn eval_prepared<H: 'static>(
858    interp: &mut tatara_lisp_eval::Interpreter<H>,
859    prepared: &Prepared,
860    host: &mut H,
861) -> Result<Value, RunError> {
862    let Prepared {
863        program, erased, ..
864    } = prepared;
865
866    // RUN, one top-level form at a time, **counting them**.
867    //
868    // This is literally the loop `Interpreter::eval_program` runs internally
869    // (tatara-lisp-eval `eval.rs`) — unrolled here for exactly one reason: the
870    // INDEX. `resolve_uses` flattens N files into one form list and a `Span` is
871    // a byte range with no file identity, so an offset alone is ambiguous
872    // across files — 66 means something in every one of them. The index is the
873    // join key back to `ResolvedProgram`'s file table, and `eval_program`
874    // consumes it internally and hands back only the error.
875    //
876    // The same key, the same renderer and the same file table the type errors
877    // above already use. A runtime error was the one diagnostic in this
878    // function still reporting a bare message.
879    let mut value = Value::Nil;
880    for (top_level, form) in erased.iter().enumerate() {
881        value = interp.eval_top_form(form, host).map_err(|e| {
882            // The message, its position and the blue call stack, read off the
883            // frames the error unwound through (`observe::Fault`). The message
884            // is `short_message` rather than upstream's `Display`, whose
885            // trailing ` at {span}` is a bare byte range with no file, through
886            // `messages::describe`, which names the function a wrong argument
887            // count was called on.
888            RunError::Eval(Box::new(crate::observe::Fault::of(
889                program,
890                erased,
891                top_level,
892                &e,
893                &interp.take_trace(),
894            )))
895        })?;
896    }
897    Ok(value)
898}
899
900/// **A runtime error names a place.** The gates for the last stage that
901/// reported a bare message.
902///
903/// Each fixture is sized so that resolving the failing span against ANY file
904/// but the right one lands somewhere else — a different path and a different
905/// line — so a green run here is evidence about the join and not about the
906/// renderer being called at all.
907///
908/// **Each raise is an unbound name, WAIVED.** Since the check stage resolves
909/// names (B0001), an unbound call no longer reaches the evaluator; these
910/// fixtures need exactly that runtime raise, so each carries
911/// `# waive B0001: …` above the definition holding it — the one escape hatch,
912/// used for what it is for. The waiver adds a line above each failing call,
913/// which is why the positions below are one line later than their red runs
914/// (recorded against the unwaived fixtures) show.
915#[cfg(test)]
916mod position_tests {
917    use super::*;
918    use crate::uses::{Entry, Loader};
919    use std::collections::BTreeMap;
920    use std::path::Path;
921
922    struct MemLoader(BTreeMap<&'static str, &'static str>);
923
924    impl Loader for MemLoader {
925        fn load(&self, name: &str) -> Result<Vec<(String, String)>, String> {
926            self.0
927                .get(name)
928                .map(|s| vec![(format!("{name}.b"), (*s).to_owned())])
929                .ok_or_else(|| format!("no bidama named \"{name}\""))
930        }
931    }
932
933    /// A package whose OWN top-level code raises, deep inside a file that is
934    /// deliberately taller than either of the other two.
935    ///
936    /// Byte 66 — where `kore_wa_sonzai_shinai` starts — is past the end of the
937    /// entry file (30 bytes) and past the end of `kotae.b` (21 bytes). So the
938    /// only file this span can honestly resolve against is this one, and the
939    /// other two now refuse to answer rather than walking off their ends.
940    const BAKUHATSU: &str = "\
941def tsukawanai_a()
942  1
943end
944
945def tsukawanai_b()
946  2
947end
948
949# waive B0001: the fixture needs a raise at runtime
950def bakuhatsu()
951  kore_wa_sonzai_shinai()
952end
953
954bakuhatsu()";
955
956    const KOTAE: &str = "def kotae()\n  42\nend";
957
958    /// The same failing call, but only ever reached by a CALLER in another
959    /// file — the shape the call stack resolved (the last position test).
960    const BAKUHATSU2: &str =
961        "# waive B0001: a raise at runtime\ndef yobu()\n  kore_wa_sonzai_shinai()\nend";
962
963    fn loader() -> MemLoader {
964        MemLoader(BTreeMap::from([
965            ("kotae", KOTAE),
966            ("bakuhatsu", BAKUHATSU),
967            ("bakuhatsu2", BAKUHATSU2),
968        ]))
969    }
970
971    fn run_named(path: &str, src: &str) -> RunError {
972        run_in_surface(
973            Entry {
974                path: Some(Path::new(path)),
975                text: src,
976            },
977            Inputs::new(),
978            &loader(),
979            None,
980        )
981        .expect_err("the fixture must raise")
982    }
983
984    /// **The load-bearing gate: a raise inside an IMPORTED package reports the
985    /// IMPORTED file's path and line.**
986    ///
987    /// Hand-computed. In `bakuhatsu.b` the failing call sits on line 11 at
988    /// column 3, and the whole point of the fixture's height is that no other
989    /// file in the program can produce that pair: the entry file has 2 lines
990    /// and `kotae.b` has 3, so *any* mis-attribution is visible as a different
991    /// path AND a different position, never as a coincidence.
992    ///
993    /// **Three red runs, one per edit this change makes** — each isolates a
994    /// different half of the mechanism, which is what stops the gate being a
995    /// tautology over "some renderer ran".
996    ///
997    /// 1. `eval_program` + `.map_err(|e| RunError::Eval(e.to_string()))`
998    ///    restored (the pre-change code):
999    ///    ```text
1000    ///    left:  "runtime error: unbound symbol: kore_wa_sonzai_shinai at 74..95"
1001    ///    right: "runtime error: bakuhatsu.b:10:3: unbound symbol `kore_wa_sonzai_shinai`"
1002    ///    ```
1003    ///    No place at all — the state this change is fixing — and the trailing
1004    ///    `at 74..95` is upstream's `Display`, an offset with no file, which is
1005    ///    why the loop renders `short_message` instead.
1006    ///
1007    /// 2. The loop kept, but `0` passed to `locate` in place of `top_level`:
1008    ///    ```text
1009    ///    left:  "runtime error: kotae.b: unbound symbol `kore_wa_sonzai_shinai`"
1010    ///    right: "runtime error: bakuhatsu.b:10:3: unbound symbol `kore_wa_sonzai_shinai`"
1011    ///    ```
1012    ///    **This is the one that proves the INDEX is load-bearing** rather than
1013    ///    the renderer: form 0 belongs to `kotae.b`, so the wrong file is named
1014    ///    — and named without a position, because the guard in `locate` sees
1015    ///    that byte 74 is not a range in a 21-byte file and declines to invent
1016    ///    one. A fixture with one imported package could not tell these apart.
1017    ///
1018    /// 3. `crate::lower_to_spanned(&crate::to_sexps(&erased))` reinstated
1019    ///    between erasure and the loop:
1020    ///    ```text
1021    ///    left:  "runtime error: bakuhatsu.b: unbound symbol `kore_wa_sonzai_shinai`"
1022    ///    right: "runtime error: bakuhatsu.b:10:3: unbound symbol `kore_wa_sonzai_shinai`"
1023    ///    ```
1024    ///    The right FILE with no position — which is exactly the shape of the
1025    ///    bug: the index survived the lift and every span did not.
1026    /// kotae loads first so bakuhatsu's forms do not start at index 0: the
1027    /// order is the fixture, and the waiver says so (B0015 wants them sorted).
1028    const TWO_IMPORTS: &str =
1029        "use(\"kotae\")\n# waive B0015: kotae loads first on purpose\nuse(\"bakuhatsu\")\n";
1030
1031    #[test]
1032    fn a_raise_inside_an_imported_package_names_that_package() {
1033        let err = run_named("entry.b", TWO_IMPORTS);
1034        assert_eq!(
1035            err.to_string(),
1036            "runtime error: bakuhatsu.b:11:3: unbound symbol `kore_wa_sonzai_shinai`\n  \
1037             at bakuhatsu::bakuhatsu (bakuhatsu.b:11:3)\n  \
1038             at <top level> (bakuhatsu.b:14:1)"
1039        );
1040    }
1041
1042    /// Anti-vacuity for the fixture itself: the position asserted above is a
1043    /// FACT ABOUT `bakuhatsu.b`, checked against the source text rather than
1044    /// against the thing that produced it.
1045    ///
1046    /// Without this, `11:3` is just a number that happened to come out of the
1047    /// code under test, and a change that moved every reported line by one
1048    /// would move this assertion with it.
1049    #[test]
1050    fn line_11_column_3_of_the_fixture_is_the_failing_call() {
1051        let line = BAKUHATSU.lines().nth(10).expect("line 11 exists");
1052        assert_eq!(line, "  kore_wa_sonzai_shinai()");
1053        assert_eq!(
1054            &line[2..],
1055            "kore_wa_sonzai_shinai()",
1056            "column 3 (1-indexed) is where the call starts"
1057        );
1058        // And the other two files cannot reach that far, which is what makes a
1059        // mis-attribution loud instead of plausible.
1060        let offset = BAKUHATSU.find("kore_wa_sonzai_shinai").expect("in fixture");
1061        assert!(
1062            offset > KOTAE.len(),
1063            "kotae.b could answer for byte {offset}"
1064        );
1065        assert!(
1066            offset > TWO_IMPORTS.len(),
1067            "the entry file could answer for byte {offset}"
1068        );
1069    }
1070
1071    /// **The `FileId(0)` path: a raise in the ENTRY file reports the entry
1072    /// file.** The single-file case, which is every program that imports
1073    /// nothing — and the one where the index and the span cannot disagree.
1074    ///
1075    /// **Red run** (2026-08-12), `eval_program` +
1076    /// `.map_err(|e| RunError::Eval(e.to_string()))` restored:
1077    /// ```text
1078    /// left:  "runtime error: unbound symbol: nani_mo_nai at 17..28"
1079    /// right: "runtime error: honmono.b:5:1: unbound symbol `nani_mo_nai`"
1080    /// ```
1081    ///
1082    /// **Second red run**, `lower_to_spanned` reinstated after erasure — the
1083    /// one that isolates the SPAN half from the index half, since a
1084    /// single-file program cannot get its file wrong:
1085    /// ```text
1086    /// left:  "runtime error: honmono.b: unbound symbol `nani_mo_nai`"
1087    /// right: "runtime error: honmono.b:5:1: unbound symbol `nani_mo_nai`"
1088    /// ```
1089    #[test]
1090    fn a_raise_in_the_entry_file_names_the_entry_file() {
1091        let err = run_named(
1092            "honmono.b",
1093            "def f()\n  1\nend\n\n# waive B0001: a raise at runtime\nnani_mo_nai()\n",
1094        );
1095        assert_eq!(
1096            err.to_string(),
1097            "runtime error: honmono.b:6:1: unbound symbol `nani_mo_nai`"
1098        );
1099    }
1100
1101    /// A raise from a form that came through the SURFACE-level erasure still
1102    /// reports a real position — the annotated path, where erasure rewrites
1103    /// the node rather than passing it through.
1104    ///
1105    /// Separate from the two above because the erasure rewrite is the only
1106    /// place a node is built rather than kept, and a synthetic span there
1107    /// would be invisible to a fixture whose failing form is untouched.
1108    ///
1109    /// **Red run** (2026-08-12), `lower_to_spanned` reinstated after erasure:
1110    /// ```text
1111    /// left:  "runtime error: chuu.b: unbound symbol `mada_nai`"
1112    /// right: "runtime error: chuu.b:2:3: unbound symbol `mada_nai`"
1113    /// ```
1114    #[test]
1115    fn a_raise_inside_an_annotated_def_still_names_its_line() {
1116        let err = run_named(
1117            "chuu.b",
1118            "# waive B0001: a raise at runtime\ndef f(a: Int) -> Int\n  mada_nai(a)\nend\n\nf(1)\n",
1119        );
1120        assert_eq!(
1121            err.to_string(),
1122            "runtime error: chuu.b:3:3: unbound symbol `mada_nai`\n  \
1123             at f (chuu.b:3:3)\n  \
1124             at <top level> (chuu.b:6:1)"
1125        );
1126    }
1127
1128    /// **The limit this module used to state, closed by the call stack.**
1129    ///
1130    /// A top-level form in the entry file calls a function defined in an
1131    /// imported one, and the raise happens inside the callee. The executing
1132    /// form is the entry's and the span is the callee's bytes, so until the
1133    /// evaluator reported the frames an error unwound through, the best blue
1134    /// could do was name the caller's file with no position (the guard in
1135    /// `uses::ResolvedProgram::locate` refusing an offset it could not
1136    /// justify). The innermost frame's definition now names the file the
1137    /// offsets belong to, and the stack shows the call that led there.
1138    ///
1139    /// **Red run** (2026-10-10): `Fault::of` locating against the executing
1140    /// top-level form instead of the innermost frame's definition:
1141    /// ```text
1142    /// 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)"
1143    /// ```
1144    /// The old answer, kept by the guard: the caller's file and no position.
1145    #[test]
1146    fn a_raise_in_a_callee_from_another_file_names_the_callees_file() {
1147        // The comment is padding, and load-bearing: `bakuhatsu2.b`'s failing
1148        // call starts at byte 47 (after its waiver line) and ends at 70, and
1149        // this file is 57 bytes, so the start is in range here and the end is
1150        // not — a mis-attribution would still be refused rather than placed.
1151        let err = run_named(
1152            "yobidashi.b",
1153            "use(\"bakuhatsu2\")\n# pad: 47 in range\nbakuhatsu2::yobu()\n",
1154        );
1155        assert_eq!(
1156            err.to_string(),
1157            "runtime error: bakuhatsu2.b:3:3: unbound symbol `kore_wa_sonzai_shinai`\n  \
1158             at bakuhatsu2::yobu (bakuhatsu2.b:3:3)\n  \
1159             at <top level> (yobidashi.b:3:1)"
1160        );
1161    }
1162}
1163
1164#[cfg(test)]
1165mod tests {
1166    use super::*;
1167
1168    fn int(src: &str) -> i64 {
1169        match run(src).unwrap_or_else(|e| panic!("{src:?}: {e}")).value {
1170            Value::Int(v) => v,
1171            other => panic!("{src:?} produced {other:?}"),
1172        }
1173    }
1174
1175    /// **The sliding scale, as one assertion.** Annotating changes the
1176    /// analysis and nothing else.
1177    #[test]
1178    fn annotating_buys_analysis_and_changes_nothing_else() {
1179        let plain = run("def add(a, b)\n  a + b\nend\nadd(2, 3)").expect("plain");
1180        let typed = run("def add(a: Int, b: Int) -> Int\n  a + b\nend\nadd(2, 3)").expect("typed");
1181
1182        assert!(matches!(plain.value, Value::Int(5)));
1183        assert!(
1184            matches!(typed.value, Value::Int(5)),
1185            "the annotated program must compute the same answer"
1186        );
1187        assert_eq!(plain.visited, 0, "no annotations means no analysis");
1188        assert!(
1189            typed.visited > 0,
1190            "an annotation must actually buy analysis, not just decorate"
1191        );
1192        assert_eq!(plain.typed_decls, 0);
1193        assert_eq!(typed.typed_decls, 1);
1194    }
1195
1196    /// **Checking happens before erasure.** This is the test that catches the
1197    /// reordering: a program with a declared-type violation must be rejected,
1198    /// and it can only be rejected while the annotations still exist.
1199    #[test]
1200    fn a_type_error_is_reported_and_the_program_does_not_run() {
1201        let err = run("def add(a: Int, b: Int) -> Str\n  a + b\nend\nadd(1, 2)")
1202            .expect_err("a declared Str return from an Int body must be rejected");
1203        assert!(
1204            matches!(err, RunError::Types(ref d) if !d.is_empty()),
1205            "expected type diagnostics, got {err}"
1206        );
1207    }
1208
1209    /// And the untyped version of the same program runs, so the rejection
1210    /// above is the annotation's doing rather than a parse failure.
1211    #[test]
1212    fn the_same_program_without_annotations_runs() {
1213        assert_eq!(int("def add(a, b)\n  a + b\nend\nadd(1, 2)"), 3);
1214    }
1215
1216    #[test]
1217    fn a_parse_error_is_reported_as_one() {
1218        assert!(matches!(run("def (").unwrap_err(), RunError::Parse(_)));
1219    }
1220
1221    /// Every stage reports in its own vocabulary, so a failure names which
1222    /// stage failed rather than surfacing as a generic error.
1223    #[test]
1224    fn a_runtime_error_is_reported_as_one() {
1225        let err = run("throw(error(\"boom\"))").expect_err("a raise");
1226        assert!(matches!(err, RunError::Eval(_)), "got {err}");
1227    }
1228
1229    /// Stdlib and primitives are both reachable through the pipeline — the
1230    /// gap that made `6 % 3` fail.
1231    #[test]
1232    fn the_pipeline_reaches_both_runtime_layers() {
1233        assert_eq!(int("6 % 3"), 0);
1234        assert_eq!(int("7 % 3"), 1);
1235        assert_eq!(int("2 + 3 * 4"), 14);
1236    }
1237
1238    /// **The deleted hop was a no-op on everything blue emits — so removing it
1239    /// is a swap, not a behaviour change.**
1240    ///
1241    /// The old lowering printed the erased tree and read it back through
1242    /// `tatara_lisp::read_spanned`. This walks a corpus and asserts the two
1243    /// paths land on the same tree, which is the equivalence the swap rests on.
1244    /// It is stated as a *measurement over this corpus*, not as a theorem:
1245    /// the round trip is not identity in general (that is precisely why it had
1246    /// to go), it merely happened to be identity for the bytes blue emits.
1247    #[test]
1248    fn the_deleted_round_trip_agreed_with_the_direct_lowering() {
1249        let corpus = [
1250            "def add(a, b)\n  a + b\nend\nadd(2, 3)",
1251            "def fact(n)\n  if n < 2\n    1\n  else\n    n * fact(n - 1)\n  end\nend\nfact(5)",
1252            "def f(a, b)\n  c = a + b\n  c * 2\nend\nf(1, 2)",
1253            "defmacro sq(e)\n  quote\n    unquote(e) * unquote(e)\n  end\nend\nsq(2 + 3)",
1254            "\"a string with spaces, a ( and a )\"",
1255            "def g(a: Int) -> Int\n  a + 1\nend\ng(1)",
1256            "6 % 3",
1257            "1.5 + 2.25",
1258        ];
1259        for src in corpus {
1260            // Projected to `Sexp` because that is what the deleted hop
1261            // operated on. Erasure itself no longer goes near it.
1262            let erased = crate::to_sexps(&erase_types(&parse_tree(src).expect("parse")));
1263
1264            let direct: Vec<Sexp> = crate::lower_to_spanned(&erased)
1265                .iter()
1266                .map(tatara_lisp::Spanned::to_sexp)
1267                .collect();
1268            assert_eq!(direct, erased, "the direct lowering must be the identity");
1269
1270            let text = erased
1271                .iter()
1272                .map(ToString::to_string)
1273                .collect::<Vec<_>>()
1274                .join("\n");
1275            let round_tripped: Vec<Sexp> = tatara_lisp::read_spanned(&text)
1276                .unwrap_or_else(|e| panic!("{src:?}: the old path could not read back: {e:?}"))
1277                .iter()
1278                .map(tatara_lisp::Spanned::to_sexp)
1279                .collect();
1280            assert_eq!(
1281                round_tripped, erased,
1282                "{src:?}: the old print-and-reparse path changed the tree"
1283            );
1284        }
1285    }
1286
1287    /// Anti-vacuity for the test above: the round trip really is *not* the
1288    /// identity in general, so agreeing on the corpus was a property of what
1289    /// blue happens to emit rather than a property of the reader.
1290    ///
1291    /// **`Atom::Symbol`'s `Display` writes the name raw, with no escaping.**
1292    /// `Atom::Str` escapes and its docs explain at length why; the symbol arm
1293    /// is `f.write_str(s)`. So print-then-read is not inverse over the symbol
1294    /// domain, and the failure is *silent*: a symbol containing a space prints
1295    /// as two tokens, reads back as two symbols, and the result is a perfectly
1296    /// well-formed tree with a different meaning. No error, nothing to catch.
1297    ///
1298    /// Measured 2026-08-02 across the separators: `a b` and `x'y` come back
1299    /// `Ok` with a different tree; `x)y`, `x"y` and `x;y` come back `Err`;
1300    /// `x{y` and `x[y` DO round-trip at this level — those two are one symbol
1301    /// in and one symbol out, so the brace-fusion reported in tatara *source*
1302    /// is not what bites a printed tree. The silent pair is what makes this a
1303    /// miscompile class rather than a noisy one.
1304    #[test]
1305    fn the_round_trip_is_not_the_identity_in_general() {
1306        let tree = Sexp::List(vec![
1307            Sexp::Atom(tatara_lisp::Atom::Symbol("f".into())),
1308            Sexp::Atom(tatara_lisp::Atom::Symbol("a b".into())),
1309        ]);
1310        let text = tree.to_string();
1311        let back: Vec<Sexp> = tatara_lisp::read_spanned(&text)
1312            .expect("it reads back cleanly — that IS the problem")
1313            .iter()
1314            .map(tatara_lisp::Spanned::to_sexp)
1315            .collect();
1316        assert_ne!(
1317            back,
1318            vec![tree.clone()],
1319            "if print-then-read became inverse over symbols, the class would be \
1320             closed upstream and this test should be deleted rather than relaxed"
1321        );
1322        // …and the direct lowering is unaffected by any of it.
1323        let direct: Vec<Sexp> = crate::lower_to_spanned(std::slice::from_ref(&tree))
1324            .iter()
1325            .map(tatara_lisp::Spanned::to_sexp)
1326            .collect();
1327        assert_eq!(direct, vec![tree]);
1328    }
1329}
1330
1331#[cfg(test)]
1332mod macro_tests {
1333    use super::*;
1334
1335    fn int(src: &str) -> i64 {
1336        match run(src).unwrap_or_else(|e| panic!("{src:?}: {e}")).value {
1337            Value::Int(v) => v,
1338            other => panic!("{src:?} produced {other:?}"),
1339        }
1340    }
1341
1342    /// **A blue macro expands and runs.** Tenet 2's surface, end to end.
1343    #[test]
1344    fn a_macro_expands_and_runs() {
1345        assert_eq!(
1346            int("defmacro double(x)\n  quote\n    unquote(x) + unquote(x)\n  end\nend\ndouble(21)"),
1347            42
1348        );
1349    }
1350
1351    /// A macro receives *source forms*, not values — so it can duplicate its
1352    /// argument, which a function cannot do without re-evaluating it.
1353    #[test]
1354    fn a_macro_operates_on_syntax_not_values() {
1355        assert_eq!(
1356            int("defmacro sq(e)\n  quote\n    unquote(e) * unquote(e)\n  end\nend\nsq(2 + 3)"),
1357            25,
1358            "the argument form `2 + 3` must be substituted twice"
1359        );
1360    }
1361
1362    /// **A runaway macro is a typed error, not a dead compiler.** This is the
1363    /// property that makes the metaprogramming surface safe to hand to a user.
1364    ///
1365    /// The assertion was `contains("expansion limit")` and now reads
1366    /// `contains("expansion")`, because the pipeline renders `short_message`
1367    /// rather than `Display`: upstream words the same fact as "exceeded 256
1368    /// expansion steps" instead of "exceeded the expansion limit of 256
1369    /// rewrites". The PROPERTY is unchanged and still asserted — the macro is
1370    /// named, and the failure is attributed to expansion rather than to
1371    /// evaluation. **This reword was the whole measured blast radius of that
1372    /// switch**, one test in the workspace.
1373    ///
1374    /// The number is deliberately NOT pinned. It is upstream's constant, this
1375    /// test owns none of it, and matching it would turn an upstream bump into
1376    /// a red run here that proves nothing about blue.
1377    ///
1378    /// The third clause is new capability rather than repair: the message now
1379    /// carries `<anonymous>:6:1`, so a runaway macro says WHERE it ran away.
1380    #[test]
1381    fn a_runaway_macro_fails_the_compilation_rather_than_the_process() {
1382        let err =
1383            run("defmacro forever(x)\n  quote\n    forever(unquote(x))\n  end\nend\nforever(1)")
1384                .expect_err("a self-referential macro must be rejected");
1385        let msg = err.to_string();
1386        assert!(
1387            msg.contains("forever") && msg.contains("expansion"),
1388            "the error must name the macro and the limit it hit: {msg}"
1389        );
1390        assert!(
1391            msg.contains("<anonymous>:6:1"),
1392            "and must place the call that ran away — line 6 is `forever(1)`: {msg}"
1393        );
1394    }
1395}
1396
1397#[cfg(test)]
1398mod input_tests {
1399    use super::*;
1400    use crate::inputs::{Declaration, Inputs};
1401
1402    /// A schema a macro will generate code from.
1403    const SCHEMA: &[u8] = b"3";
1404
1405    fn with_schema(src: &str) -> Result<Run, RunError> {
1406        let hash = Inputs::hash_of(SCHEMA);
1407        let mut inputs = Inputs::new();
1408        inputs
1409            .bind(
1410                &Declaration {
1411                    name: "schema".to_string(),
1412                    hash,
1413                },
1414                SCHEMA.to_vec(),
1415            )
1416            .expect("bind");
1417        run_with_inputs(src, inputs)
1418    }
1419
1420    fn decl_line() -> String {
1421        let mut s = String::from("definput(\"schema\", \"");
1422        s.push_str(&Inputs::hash_of(SCHEMA));
1423        s.push_str("\")\n");
1424        s
1425    }
1426
1427    /// **A macro reads a declared build input.** This is §VI OPEN #6 closed —
1428    /// the spec names it as gating blue's whole "stronger than Ruby's
1429    /// metaprogramming" claim, because a macro that cannot read a schema cannot
1430    /// generate code from one.
1431    #[test]
1432    fn a_macro_can_read_a_declared_build_input() {
1433        let src = decl_line() + "input(\"schema\")";
1434        let out = with_schema(&src).expect("run");
1435        assert!(
1436            matches!(out.value, Value::Str(ref s) if &**s == "3"),
1437            "got {:?}",
1438            out.value
1439        );
1440    }
1441
1442    /// **An undeclared input is an error, not a file read and not nil.**
1443    /// Returning nil is how a macro generates an empty table and nobody notices
1444    /// until runtime.
1445    #[test]
1446    fn an_undeclared_input_is_an_error() {
1447        let err = with_schema("input(\"not_declared\")").expect_err("must fail");
1448        let msg = err.to_string();
1449        assert!(msg.contains("not_declared"), "must name it: {msg}");
1450        assert!(msg.contains("definput"), "and say how to declare it: {msg}");
1451    }
1452
1453    /// **There is no path-based read at all.** The capability is the absence of
1454    /// the primitive, not a check inside one — so this is an unbound symbol.
1455    ///
1456    /// Holds for the DEFAULT surface — the one every embedder gets. The `sys`
1457    /// cargo feature (CLI only) is the one declared exception: it is the
1458    /// operator's own trusted host surface, and is asserted in
1459    /// `sys_read_file_is_the_trusted_cli_only_exception` below.
1460    #[cfg(not(feature = "sys"))]
1461    #[test]
1462    fn there_is_no_ambient_file_read() {
1463        for attempt in [
1464            "read_file(\"/etc/passwd\")",
1465            "File(\"/etc/passwd\")",
1466            "slurp(\"/etc/passwd\")",
1467            "open(\"/etc/passwd\")",
1468        ] {
1469            let err = with_schema(attempt).expect_err("must not resolve");
1470            assert!(
1471                err.to_string().contains("unbound"),
1472                "{attempt} must be UNBOUND — a capability removed by absence, \
1473                 not guarded by a check: {err}"
1474            );
1475        }
1476    }
1477
1478    /// With the `sys` feature compiled in, `read_file` IS bound — that is the
1479    /// point of the feature. The doctrine does not move: this is the operator's
1480    /// own machine (the CLI), not an embedder's sandbox. Pin the boundary so a
1481    /// future default-build change is heard, and assert that `input()` still
1482    /// works beside it.
1483    #[cfg(feature = "sys")]
1484    #[test]
1485    fn sys_read_file_is_the_trusted_cli_only_exception() {
1486        let err = with_schema("definitely_not_a_primitive(\"x\")").expect_err("must not resolve");
1487        assert!(err.to_string().contains("unbound"), "{err}");
1488        assert!(
1489            with_schema("read_file(\"/etc/passwd\")").is_ok(),
1490            "with `sys` on, read_file is the trusted CLI surface"
1491        );
1492        let out = with_schema("input(\"schema\")").expect("run");
1493        assert!(
1494            matches!(out.value, Value::Str(ref s) if &**s == "3"),
1495            "input() still binds beside the sys surface: {:?}",
1496            out.value
1497        );
1498    }
1499
1500    /// Anti-vacuity: with no inputs supplied at all, even a declared name fails
1501    /// — so the success above is the binding's doing.
1502    #[test]
1503    fn a_declared_input_with_no_bytes_supplied_fails() {
1504        let src = decl_line() + "input(\"schema\")";
1505        assert!(run(&src).is_err(), "no bytes were supplied");
1506    }
1507}
1508
1509#[cfg(test)]
1510mod tier2_tests {
1511    use super::*;
1512    use crate::inputs::{Declaration, Inputs};
1513
1514    /// **The Tier-2 conversion §V.6.3 said was gated: a macro that emits real
1515    /// declarations FROM A SCHEMA.**
1516    ///
1517    /// `theory/BLUE.md` §VI OPEN #6 states the blocker plainly — "tenet 2
1518    /// installs a `NoLoader`, so a macro cannot read a schema — which gates
1519    /// every Tier-2 conversion in §V.6 and therefore blue's whole 'stronger than
1520    /// Ruby's metaprogramming' claim."
1521    ///
1522    /// Here the schema supplies a *value the generated code depends on*, read at
1523    /// expansion time. Ruby and Elixir can both do this — with the whole
1524    /// filesystem open. blue does it through a name bound to a content hash.
1525    #[test]
1526    fn a_macro_generates_code_from_a_schema() {
1527        let schema = b"7";
1528        let mut inputs = Inputs::new();
1529        inputs
1530            .bind(
1531                &Declaration {
1532                    name: "arity".to_string(),
1533                    hash: Inputs::hash_of(schema),
1534                },
1535                schema.to_vec(),
1536            )
1537            .expect("bind");
1538
1539        // The macro reads the input at EXPANSION time and splices the value it
1540        // found into the code it emits.
1541        let mut src = String::from("definput(\"arity\", \"");
1542        src.push_str(&Inputs::hash_of(schema));
1543        src.push_str("\")\n");
1544        src.push_str(
1545            "defmacro from_schema()\n  quote\n    unquote(to_int(input(\"arity\")))\n  end\nend\n\
1546             from_schema() * 6",
1547        );
1548
1549        let out = run_with_inputs(&src, inputs).expect("run");
1550        assert!(
1551            matches!(out.value, Value::Int(42)),
1552            "the schema's 7 must reach the generated code: got {:?}",
1553            out.value
1554        );
1555    }
1556}