sprawling-console-ffi 0.0.12

The Zig leaf that draws the console's frames, offered as one safe function.
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
117
118
119
120
121

// 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

#![allow(
    clippy::unwrap_used,
    clippy::indexing_slicing,
    clippy::arithmetic_side_effects,
    reason = "test code"
)]

//! The edges of a frame: what a record cannot make the terminal do, a
//! scene the leaf refuses, the cursor once no live region is drawn, and
//! what gives way first in a narrow or a short window.

use super::{drawn, live, screen, transcript};
use crate::scene::{Entry, Inline, Quiet, Scene};

#[test]
fn a_control_sequence_inside_a_reply_reaches_the_screen_as_a_mark() {
    let entries = vec![Entry::Reply {
        said: "clear\u{1b}[2Jthe screen".to_owned(),
    }];
    let scene = Scene::inline(&Inline {
        columns: 80,
        erase: 0,
        previous: None,
        entries: &entries,
        live: None,
    });
    let (bytes, _) = drawn(&scene);
    let written = String::from_utf8(bytes.clone()).unwrap();
    assert!(
        written.contains("clear\u{fffd}[2Jthe screen"),
        "{written:?}"
    );
    let (shown, _) = screen(80, 4, &[bytes]);
    assert!(shown.contains("the screen"), "{shown}");
}

#[test]
fn a_scene_cut_short_is_refused_rather_than_read_past() {
    let entries = transcript();
    let scene = Scene::inline(&Inline {
        columns: 80,
        erase: 0,
        previous: None,
        entries: &entries,
        live: None,
    });
    let bytes = scene.bytes();
    for cut in [1, 7, bytes.len() / 2, bytes.len() - 1] {
        let short = Scene::from_bytes_for_tests(&bytes[..cut]);
        let mut into = Vec::new();
        assert_eq!(
            crate::draw(&short, &mut into),
            Err(crate::Refused::Malformed)
        );
    }
}

/// A frame with no live region, as the console draws once the terminal
/// is handed back, leaves the cursor shown: every frame hides it while it
/// draws.
#[test]
fn a_frame_without_a_live_region_leaves_the_cursor_shown() {
    let entries = vec![Entry::Note {
        said: "the city exits without a handoff".to_owned(),
    }];
    let scene = Scene::inline(&Inline {
        columns: 80,
        erase: 0,
        previous: None,
        entries: &entries,
        live: None,
    });
    let (bytes, _) = drawn(&scene);
    let mut parser = vt100::Parser::new(4, 80, 0);
    parser.process(&bytes);
    assert!(!parser.screen().hide_cursor());
}

/// In a narrow window the resident's name stays and the time and the key
/// that stops the run give way first.
#[test]
fn a_narrow_working_row_keeps_who_is_working() {
    let mut narrow = live("", 0, None);
    narrow.waiting = None;
    narrow.calling = Vec::new();
    let scene = Scene::inline(&Inline {
        columns: 28,
        erase: 0,
        previous: None,
        entries: &[],
        live: Some(narrow),
    });
    let (bytes, _) = drawn(&scene);
    let (shown, _) = screen(28, 8, &[bytes]);
    assert_eq!(shown.lines().nth(1), Some("● mayor is working"), "{shown}");
}

/// A window too short for the transient keeps the address and the code,
/// and draws no transient over them.
#[test]
fn a_short_window_drops_the_transient_rather_than_cover_the_code() {
    let scene = Scene::quiet(&Quiet {
        columns: 60,
        rows: 2,
        url: "http://127.0.0.1:7341/",
        code: "K7M2QX9P",
        key: None,
        transient: Some("the city is closing"),
    });
    let (bytes, _) = drawn(&scene);
    let (shown, _) = screen(60, 2, &[bytes]);
    assert_eq!(
        shown,
        "                  http://127.0.0.1:7341/\n                  pairing code   K7M2QX9P"
    );
}