sprawling-runtime 0.0.10

One run of a sprawling resident, from dispatch to freeze: turns, tools, replay and the sandbox that executes code.
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

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
// Copyright (c) 2026 2youg1 and the sprawling contributors

//! The dormant index: one line per admitted capability a session does
//! not carry as a tool, packed greedily under
//! [`DORMANT_INDEX_CEILING`](super::DORMANT_INDEX_CEILING)
//! (`crates/runtime/spec/Catalog.lean` `pack`, `index_within_ceiling`).
//!
//! Each entry is tried with its hint, then with its name alone, and the
//! first entry that fits neither way ends the list with `+N more`. The
//! budget reserves that last line at the largest count before any entry
//! is placed, so it always fits; the header says once that hints are cut,
//! because a marker on every cut hint would cost more than the hint.

use super::DORMANT_INDEX_CEILING;
use crate::elision::Boundary;

/// How long one entry's hint may be, in bytes, before it is cut on a
/// character boundary.
pub(crate) const HINT_MAX_BYTES: usize = 64;

const HEADER: &str = "Dormant, admitted here and not loaded (hints cut): `describe` a name \
                      or a few words for the whole guide, run a tool with `call`, open a skill \
                      with `read`.\n";

/// One capability as the index lists it: the label it is called by and
/// the text its hint is cut from.
pub(super) struct Entry<'a> {
    pub(super) label: String,
    pub(super) about: &'a str,
}

/// The index for `entries`, in their order; empty when there are none.
pub(super) fn index(entries: &[Entry<'_>]) -> String {
    if entries.is_empty() {
        return String::new();
    }
    let mut room = DORMANT_INDEX_CEILING
        .saturating_sub(HEADER.len())
        .saturating_sub(more(entries.len()).len());
    let mut out = String::from(HEADER);
    for (placed, entry) in entries.iter().enumerate() {
        let hinted = format!("- {}: {}\n", entry.label, hint(entry.about));
        let bare = format!("- {}\n", entry.label);
        let Some(line) = [hinted, bare].into_iter().find(|line| line.len() <= room) else {
            out.push_str(&more(entries.len().saturating_sub(placed)));
            return out;
        };
        room = room.saturating_sub(line.len());
        out.push_str(&line);
    }
    out
}

/// The line that counts the entries left out.
fn more(left: usize) -> String {
    format!("+{left} more\n")
}

/// The first sentence of `about`, on its first line, cut to
/// [`HINT_MAX_BYTES`] on a character boundary. The search behind
/// `describe` reads the whole text, so what is cut here is still found.
pub(super) fn hint(about: &str) -> &str {
    let line = about.split_once('\n').map_or(about, |(first, _)| first);
    let sentence = line
        .split_once(". ")
        .map_or(line, |(first, _)| first)
        .trim_end_matches('.')
        .trim();
    Boundary::before(sentence, HINT_MAX_BYTES).head()
}