bp3d_os/shell/os/
mod.rs

1// Copyright (c) 2025, BlockProject 3D
2//
3// All rights reserved.
4//
5// Redistribution and use in source and binary forms, with or without modification,
6// are permitted provided that the following conditions are met:
7//
8//     * Redistributions of source code must retain the above copyright notice,
9//       this list of conditions and the following disclaimer.
10//     * Redistributions in binary form must reproduce the above copyright notice,
11//       this list of conditions and the following disclaimer in the documentation
12//       and/or other materials provided with the distribution.
13//     * Neither the name of BlockProject 3D nor the names of its contributors
14//       may be used to endorse or promote products derived from this software
15//       without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29//! Low-level platform-specific tools to control the OS console/terminal.
30
31#[cfg(unix)]
32mod unix;
33
34#[cfg(windows)]
35mod windows;
36
37#[cfg(unix)]
38pub use unix::Terminal;
39
40#[cfg(unix)]
41pub use unix::write;
42
43#[cfg(unix)]
44pub use unix::get_window_size;
45
46#[cfg(unix)]
47pub use unix::get_window_height_amortized;
48
49#[cfg(windows)]
50pub use windows::Terminal;
51
52#[cfg(windows)]
53pub use windows::write;
54
55#[cfg(windows)]
56pub use windows::get_window_size;
57
58#[cfg(windows)]
59pub use windows::get_window_height_amortized;
60
61impl Default for Terminal {
62    fn default() -> Self {
63        Self::new()
64    }
65}
66
67/// Move the terminal cursor to the given x, y position in columns and rows respectively.
68pub fn move_cursor(x: i32, y: i32) {
69    write(&format!("\x1b[{};{}H", y, x + 1)) // yeah rust is broken: impossible to use octal set
70}
71
72/// Clear the rest of the current line starting at the current cursor position.
73pub fn clear_remaining() {
74    write("\x1b[K");
75}
76
77/// Simplified macro which does exactly the same as [println](std::println) but overwrites the current prompt
78/// rather than appending text after the prompt.
79#[macro_export]
80macro_rules! shell_println {
81    ($($data: tt)*) => {
82        $crate::shell::os::move_cursor(0, $crate::shell::os::get_window_height_amortized());
83        $crate::shell::os::clear_remaining();
84        println!($($data)*);
85    };
86}
bp3d_os/shell/os/mod.rs

bp3d_os/shell/os/
mod.rs
