sim-lib-cookbook 0.1.11

Runtime cookbook: operations for SIM.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

//! Seed recipe registration for the crate-shipped cookbook books.

use sim_cookbook::{EmbeddedDir, RecipeStore, recipes_from_embedded};
use sim_kernel::{Cx, Error, Result};

/// Seed books embedded by crates that currently ship first-pass recipes.
pub const SEEDED_RECIPE_BOOKS: &[(&str, EmbeddedDir)] = &[
    ("core", sim_lib_core::RECIPES),
    ("codec/lisp", sim_codec_lisp::RECIPES),
    ("codec/json", sim_codec_json::RECIPES),
    // COOK8.05 language codecs: each parses+evals its own surface on demand.
    ("codec/algol", sim_codec_algol::RECIPES),
    ("numbers/f64", sim_lib_numbers_f64::RECIPES),
    ("numbers/complex", sim_lib_numbers_complex::RECIPES),
    ("numbers/func", sim_lib_numbers_func::RECIPES),
    ("numbers/cas", sim_lib_numbers_cas::RECIPES),
    ("numbers/rational", sim_lib_numbers_rational::RECIPES),
    ("numbers/i64", sim_lib_numbers_i64::RECIPES),
    ("numbers/arith", sim_lib_numbers_arith::RECIPES),
    ("numbers/bigint", sim_lib_numbers_bigint::RECIPES),
    ("numbers/bool", sim_lib_numbers_bool::RECIPES),
    ("numbers/tensor", sim_lib_numbers_tensor::RECIPES),
    (
        "numbers/tensor-cmplxf",
        sim_lib_numbers_tensor_cmplxf::RECIPES,
    ),
    (
        "numbers/tensor-rat64",
        sim_lib_numbers_tensor_rat64::RECIPES,
    ),
    // The newer codec embeds stay unseeded until their crates.io releases expose
    // RECIPES; codec/compare is a non-publishable developer harness. codec/bitwise
    // and codec/doc also require their own codec lib loaded to run.
    // COOK8.03 organs: each of these books' 01-basics recipe is a runnable compute
    // (`let`/`seq/map`/`match`), loaded on demand via its `requires`.
    ("organ/binding", sim_lib_binding::RECIPES),
    ("organ/sequence", sim_lib_sequence::RECIPES),
    ("organ/pattern", sim_lib_pattern::RECIPES),
    ("organ/dispatch", sim_lib_dispatch::RECIPES),
    ("stream-core-shapes", sim_lib_stream_core::RECIPES),
    ("agent-runner-core", sim_lib_agent_runner_core::RECIPES),
];

/// Build a store populated from the embedded seed recipe books.
pub fn seeded_recipe_store() -> Result<RecipeStore> {
    let mut store = RecipeStore::new();
    for (book, recipes) in SEEDED_RECIPE_BOOKS {
        store
            .register_book(recipes)
            .map_err(|err| Error::Eval(format!("seed recipe book {book}: {err}")))?;
    }
    // discrete: seed every recipe EXCEPT matrix-runtime -- it reads a `#(discrete/Matrix)`
    // citizen class no runtime lib registers, so it cannot run in the cookbook sandbox and
    // must stay a source-only descriptor (COOKBOOK_7).
    register_book_except(
        &mut store,
        "discrete",
        sim_lib_discrete::RECIPES,
        &["matrix-runtime"],
    )?;
    // control: seed the runnable `if` recipe but skip the rich 30-agents descriptor
    // (`a30-021-physical-sensing`), which carries the extended agents schema and is
    // not runnable under the execute-everything verifier (kept source-only until
    // descriptors are first-class, COOK8.08).
    register_book_except(
        &mut store,
        "control",
        sim_lib_control::RECIPES,
        &["a30-021-physical-sensing"],
    )?;
    // scheme: seed the runnable `(+ 1 2)` compute; keep the R7RS profile/matrix
    // conformance descriptors source-only (matrix-row requires `standard`, absent
    // from the sandbox catalog) until descriptors are first-class (COOK8.08).
    register_book_except(
        &mut store,
        "lang/scheme",
        sim_lib_lang_scheme::RECIPES,
        &["profile-descriptor", "matrix-row"],
    )?;
    // midi: seed the runnable Category C chord-digest; keep the note-event
    // descriptor source-only until descriptors are first-class (COOK8.08).
    register_book_except(
        &mut store,
        "midi-io",
        sim_lib_midi_core::RECIPES,
        &["note-event"],
    )?;
    Ok(store)
}

/// Register every recipe in `dir` under `book`, skipping any whose id ends with an entry in
/// `skip` (a non-runnable descriptor kept source-only). `register_book` is all-or-nothing, so
/// a per-recipe skip goes through `recipes_from_embedded` + `insert_card`.
fn register_book_except(
    store: &mut RecipeStore,
    book: &str,
    dir: EmbeddedDir,
    skip: &[&str],
) -> Result<()> {
    let cards = recipes_from_embedded(dir)
        .map_err(|err| Error::Eval(format!("seed recipe book {book}: {err}")))?;
    for card in cards {
        if skip.iter().any(|s| card.id.ends_with(s)) {
            continue;
        }
        store
            .insert_card(card)
            .map_err(|err| Error::Eval(format!("seed recipe {book}: {err}")))?;
    }
    Ok(())
}

/// Install the cookbook runtime over the embedded seed recipe store.
pub fn install_seeded_cookbook_lib(cx: &mut Cx) -> Result<()> {
    crate::runtime::install_cookbook_lib(cx, seeded_recipe_store()?)
}