retroglyph-core 0.6.0

A 2D pseudographic terminal library -- core types, no backend
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

//! Minimal `Headless` backend demo.
//!
//! Shows the smallest possible use of [`Headless`](retroglyph_core::backend::Headless): build a
//! `Terminal`, draw a frame, inject a synthetic key event, tick, and print the grid
//! before/after via [`Headless::format_view`](retroglyph_core::backend::Headless::format_view): the same technique used in
//! this crate's own unit and integration tests. No terminal or window is
//! required; this only depends on `retroglyph-core` itself, so it's the
//! right starting point if you haven't picked a backend crate yet.
//!
//! Run with: `cargo run -p retroglyph-core --example headless`

use retroglyph_core::backend::Headless;
use retroglyph_core::color::Style;
use retroglyph_core::event::{Event, KeyCode, KeyEvent, KeyModifiers};
use retroglyph_core::terminal::Terminal;

fn main() {
    let backend = Headless::new(10, 3);
    let mut term = Terminal::new(backend);

    // Frame 1: draw a lone `@` and present it.
    term.draw(|s| s.put((1, 1), '@', Style::default())).unwrap();
    println!("--- Frame 1 ---");
    println!("{}", term.backend().format_view());

    // Inject a synthetic "move right" key event, same as a real backend
    // would push from its own input source.
    term.backend_mut().push_event(Event::Key(KeyEvent::new(
        KeyCode::Right,
        KeyModifiers::NONE,
    )));

    // A real app's event loop would call `drain_events`/`poll_event` here to
    // read the injected event back and move `@` in response; this demo just
    // shows the injection landing in the queue, then redraws one cell over
    // to keep the example self-contained.
    let _ = term.drain_events();
    term.draw(|s| {
        s.put((1, 1), ' ', Style::default());
        s.put((2, 1), '@', Style::default());
    })
    .unwrap();
    println!("--- Frame 2 (after injecting a move-right event) ---");
    println!("{}", term.backend().format_view());
}