ruscii 0.4.0

Terminal graphics engine
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

//! # App
//!
//! The `app` module provides functionality related to application itself, including its
//! framerate, the keyboard, and its execution.

use super::keyboard::Keyboard;
use super::terminal::Window;

use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;
use std::{panic, thread, time};

/// Contains the [`App`] configuration settings, currently including only the framerate.
pub struct Config {
    pub fps: u32,
}

impl Config {
    pub fn new() -> Config {
        Config { fps: 30 }
    }

    /// Consumes the receiver [`Config`] and returns a new one with the maximum framerate to the
    /// given `fps`.
    pub fn fps(mut self, fps: u32) -> Config {
        self.fps = fps;
        self
    }
}

impl Default for Config {
    /// Constructs a [`Config`] with a default maximum framerate of 30.
    fn default() -> Self {
        Self { fps: 30 }
    }
}

/// Contains the run state of the the [`App`] and the [`Keyboard`] through [`State::keyboard`] for
/// the key event interface.
#[derive(Default)]
pub struct State {
    running: Arc<AtomicBool>,
    keyboard: Keyboard,
    pub(self) dt: time::Duration,
    pub(self) step: usize,
}

impl State {
    pub fn run(&self) {
        self.running.store(true, Ordering::SeqCst);
    }

    pub fn stop(&self) {
        self.running.store(false, Ordering::SeqCst);
    }

    pub fn is_running(&self) -> bool {
        self.running.load(Ordering::SeqCst)
    }

    /// Returns the [`Keyboard`]. For more information on how to access keyboard input, see
    /// documentation for the [keyboard](crate::keyboard) module.
    pub fn keyboard(&self) -> &Keyboard {
        &self.keyboard
    }

    pub fn dt(&self) -> &time::Duration {
        &self.dt
    }

    pub fn step(&self) -> usize {
        self.step
    }
}

/// The essential parts of the application, containing its [`Config`], [`State`], and [`Window`].
///
/// [`App`] objects are created with a default maximum framerate of 30 using [`App::default`].
/// To change this, pass a [`Config`] object with the desired framerate using [`App::config`].
#[derive(Default)]
pub struct App {
    config: Config,
    state: State,
    window: Window,
}

impl App {
    /// Constructs an [`App`] with the given [`Config`].
    pub fn config(config: Config) -> App {
        App {
            config,
            state: State::default(),
            window: Window::default(),
        }
    }

    pub fn window(&self) -> &Window {
        &self.window
    }

    /// Begins running the terminal application.
    ///
    /// This function begins a loop where key events are first registered, the window is cleared,
    /// `frame_action` is called adding characters to the `Canvas`, and the window is redrawn.
    ///
    /// If the time it takes to execute all of these is less than the [`App`] expects according to
    /// the framerate set in the [`Config`], the current thread is put to sleep until the next
    /// frame, thereby limiting FPS.
    ///
    /// Catches all unwinding panics that occur within `frame_action`, allowing terminal recovery.
    pub fn run<F>(&mut self, mut frame_action: F)
    where
        F: FnMut(&mut State, &mut Window),
    {
        let expected_duration = time::Duration::from_nanos(1_000_000_000 / self.config.fps as u64);
        self.state.run();

        let result = panic::catch_unwind(panic::AssertUnwindSafe(|| {
            self.window.open();
            while self.state.is_running() {
                let now = time::Instant::now();
                self.window.clear();

                self.state.keyboard.consume_key_events();
                frame_action(&mut self.state, &mut self.window);

                self.window.draw();

                self.state.dt = now.elapsed();
                self.state.step += 1;
                if let Some(time) = expected_duration.checked_sub(self.state.dt) {
                    thread::sleep(time);
                }
            }
            self.window.close();
        }));

        if result.is_err() {
            self.window.close();
        }
    }
}