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 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
use std::{
io::{self, Stdout, Write},
panic::{set_hook, take_hook},
time::Duration,
};
use crossterm::{
cursor::{self, Hide, Show},
event::{self, *},
execute, queue,
style::Print,
terminal::{self, *},
tty::IsTty,
};
use crate::prelude::*;
/// Struct that helps report what the terminal supports for you without you having to work with it yourself.
pub struct Supports {
keyboard: bool,
}
impl Supports {
pub fn keyboard(&self) -> bool {
self.keyboard
}
}
impl Default for Supports {
fn default() -> Self {
Self {
keyboard: terminal::supports_keyboard_enhancement().expect("Terminal should be fine"),
}
}
}
#[derive(Default)]
pub struct Inline {
active: bool,
start: u16,
}
impl AsMut<Buffer> for Window {
fn as_mut(&mut self) -> &mut Buffer {
self.buffer_mut()
}
}
/// The main window behind the application.
/// Represents the terminal window, allowing it to be used similar to a buffer,
/// but has extra event handling.
/**
```rust, no_run
use ascii_forge::prelude::*;
let mut window = Window::init()?;
render!(
window,
[
(10, 10) => "Element Here!"
]
)
```
*/
pub struct Window {
io: io::Stdout,
buffers: [Buffer; 2],
active_buffer: usize,
event: Option<Event>,
// Input Helpers,
mouse_pos: Vec2,
// Inlining
inline: Option<Inline>,
// Input Support
support: Supports,
}
impl Default for Window {
fn default() -> Self {
Self::init().expect("Init should have succeeded")
}
}
impl Window {
/// Creates a new window from the given stdout.
/// Please prefer to use init as it will do all of the terminal init stuff.
pub fn new(io: io::Stdout) -> io::Result<Self> {
Ok(Self {
io,
buffers: [Buffer::new(size()?), Buffer::new(size()?)],
active_buffer: 0,
event: None,
mouse_pos: vec2(0, 0),
inline: None,
support: Supports::default(),
})
}
/// Creates a new window built for inline using the given Stdout and height.
pub fn new_inline(io: io::Stdout, height: u16) -> io::Result<Self> {
let size = vec2(size()?.0, height);
Ok(Self {
io,
buffers: [Buffer::new(size), Buffer::new(size)],
active_buffer: 0,
event: None,
mouse_pos: vec2(0, 0),
inline: Some(Inline::default()),
support: Supports::default(),
})
}
/// Initializes a window that is prepared for inline rendering.
/// Height is the number of columns that your terminal will need.
pub fn init_inline(height: u16) -> io::Result<Self> {
let stdout = io::stdout();
assert!(stdout.is_tty());
Window::new_inline(stdout, height)
}
/// Initializes the window, and returns a new Window for your use.
pub fn init() -> io::Result<Self> {
enable_raw_mode()?;
let mut stdout = io::stdout();
assert!(stdout.is_tty());
execute!(
stdout,
EnterAlternateScreen,
EnableMouseCapture,
EnableFocusChange,
Hide,
DisableLineWrap,
)?;
// Enable keyboard enhancement if the terminal supports it.
if Supports::default().keyboard() {
queue!(
stdout,
PushKeyboardEnhancementFlags(
KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES
| KeyboardEnhancementFlags::REPORT_ALL_KEYS_AS_ESCAPE_CODES
| KeyboardEnhancementFlags::REPORT_ALTERNATE_KEYS
| KeyboardEnhancementFlags::REPORT_EVENT_TYPES
),
)?;
}
Window::new(stdout)
}
/// Returns the active Buffer, as a reference.
pub fn buffer(&self) -> &Buffer {
&self.buffers[self.active_buffer]
}
/// Returns the active Buffer, as a mutable reference.
pub fn buffer_mut(&mut self) -> &mut Buffer {
&mut self.buffers[self.active_buffer]
}
/// Swaps the buffers, clearing the old buffer. Used automatically by the window's update method.
pub fn swap_buffers(&mut self) {
self.active_buffer = 1 - self.active_buffer;
self.buffers[self.active_buffer].clear();
}
/// Returns the current known size of the buffer's window.
pub fn size(&self) -> Vec2 {
self.buffer().size()
}
/// Restores the window to it's previous state from before the window's init method.
/// If the window is inline, restore the inline render
pub fn restore(&mut self) -> io::Result<()> {
if self.supports().keyboard() {
queue!(self.io, PopKeyboardEnhancementFlags)?;
}
if self.inline.is_some() {
execute!(
self.io,
DisableMouseCapture,
DisableFocusChange,
PopKeyboardEnhancementFlags,
)?;
println!();
disable_raw_mode()?;
Ok(())
} else {
execute!(
self.io,
PopKeyboardEnhancementFlags,
LeaveAlternateScreen,
DisableMouseCapture,
DisableFocusChange,
Show,
EnableLineWrap,
)?;
disable_raw_mode()
}
}
/// Renders the window to the screen. should really only be used by the update method, but if you need a custom system, you can use this.
pub fn render(&mut self) -> io::Result<()> {
if self.inline.is_some() {
if !self.inline.as_ref().expect("Inline should be some").active {
// Make room for the inline render
print!("{}", "\n".repeat(self.buffer().size().y as usize));
enable_raw_mode()?;
execute!(
self.io,
EnableMouseCapture,
EnableFocusChange,
DisableLineWrap
)?;
if self.supports().keyboard() {
execute!(
self.io,
PushKeyboardEnhancementFlags(
KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES
| KeyboardEnhancementFlags::REPORT_ALL_KEYS_AS_ESCAPE_CODES
| KeyboardEnhancementFlags::REPORT_ALTERNATE_KEYS
| KeyboardEnhancementFlags::REPORT_EVENT_TYPES
)
)?;
}
self.inline.as_mut().expect("Inline should be some").active = true;
self.inline.as_mut().expect("Inline should be some").start = cursor::position()?.1;
}
for (loc, cell) in
self.buffers[1 - self.active_buffer].diff(&self.buffers[self.active_buffer])
{
queue!(
self.io,
cursor::MoveTo(
loc.x,
self.inline.as_ref().expect("Inline should be some").start
- self.buffers[self.active_buffer].size().y
+ loc.y
),
Print(cell),
)?;
}
} else {
for (loc, cell) in
self.buffers[1 - self.active_buffer].diff(&self.buffers[self.active_buffer])
{
queue!(self.io, cursor::MoveTo(loc.x, loc.y), Print(cell))?;
}
}
Ok(())
}
/// Handles events, and renders the screen.
pub fn update(&mut self, poll: Duration) -> io::Result<()> {
let cursor_pos = cursor::position()?;
// Render Window
self.render()?;
self.swap_buffers();
queue!(self.io, cursor::MoveTo(cursor_pos.0, cursor_pos.1))?;
// Flush Render To Stdout
self.io.flush()?;
// Poll For Events
self.handle_event(poll)?;
Ok(())
}
/// Handles events. Used automatically by the update method, so no need to use it unless update is being used.
pub fn handle_event(&mut self, poll: Duration) -> io::Result<()> {
self.event = None;
if event::poll(poll)? {
self.event = Some(event::read()?);
match self.event {
Some(Event::Resize(width, height)) => {
if self.inline.is_none() {
self.buffers = [Buffer::new((width, height)), Buffer::new((width, height))];
}
}
Some(Event::Mouse(MouseEvent { column, row, .. })) => {
self.mouse_pos = vec2(column, row)
}
_ => {}
}
}
Ok(())
}
pub fn mouse_pos(&self) -> Vec2 {
self.mouse_pos
}
/// Returns the current event for the frame, as a reference.
pub fn event(&self) -> &Option<Event> {
&self.event
}
/// Returns true if the window had an event with the given mouse input
pub fn mouse(&self, event: MouseEventKind) -> io::Result<bool> {
if let Some(Event::Mouse(MouseEvent { kind, .. })) = self.event() {
if *kind == event {
Ok(true)
} else {
Ok(false)
}
} else {
Ok(false)
}
}
/// Returns true if the mouse cursor is hovering the given rect.
pub fn hover<I: Into<Vec2>>(&self, loc: I, size: I) -> io::Result<bool> {
let loc = loc.into();
let size = size.into();
let pos: Vec2 = self.mouse_pos();
Ok(pos.x <= loc.x + size.x && pos.x >= loc.x && pos.y <= loc.y + size.y && pos.y >= loc.y)
}
/// Returns true if the given key event is pressed.
pub fn key(&self, key: KeyEvent) -> bool {
*self.event() == Some(Event::Key(key))
}
/// Returns true if the given key code is pressed.
pub fn code(&self, code: KeyCode) -> bool {
self.key(KeyEvent::new(code, KeyModifiers::NONE))
}
pub fn io(&mut self) -> &mut Stdout {
&mut self.io
}
pub fn supports(&self) -> &Supports {
&self.support
}
}
/// Enables a panic hook to help you terminal still look pretty.
pub fn handle_panics() {
let original_hook = take_hook();
set_hook(Box::new(move |e| {
Window::new(io::stdout())
.expect("Window should have created for panic")
.restore()
.expect("Window should have exited for panic");
original_hook(e);
}))
}
impl Drop for Window {
fn drop(&mut self) {
self.restore().expect("Restoration should have succeded");
}
}