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
use std::borrow::Cow;
use std::fmt::{self, Debug, Formatter};
use std::sync::Arc;
use crate::term::ClipboardType;
use crate::vte::ansi::Rgb;
/// Terminal event.
///
/// These events instruct the UI over changes that can't be handled by the terminal emulation layer
/// itself.
#[derive(Clone)]
pub enum Event {
/// Grid has changed possibly requiring a mouse cursor shape change.
MouseCursorDirty,
/// Window title change.
Title(String),
/// Reset to the default window title.
ResetTitle,
/// Request to store a text string in the clipboard.
ClipboardStore(ClipboardType, String),
/// Request to write the contents of the clipboard to the PTY.
///
/// The attached function is a formatter which will correctly transform the clipboard content
/// into the expected escape sequence format.
ClipboardLoad(ClipboardType, Arc<dyn Fn(&str) -> String + Sync + Send + 'static>),
/// Request to write the RGB value of a color to the PTY.
///
/// The attached function is a formatter which will correctly transform the RGB color into the
/// expected escape sequence format.
ColorRequest(usize, Arc<dyn Fn(Rgb) -> String + Sync + Send + 'static>),
/// Write some text to the PTY.
PtyWrite(String),
/// Request to write the text area size.
TextAreaSizeRequest(Arc<dyn Fn(WindowSize) -> String + Sync + Send + 'static>),
/// Cursor blinking state has changed.
CursorBlinkingChange,
/// New terminal content available.
Wakeup,
/// Terminal bell ring.
Bell,
/// Shutdown request.
Exit,
/// Child process exited with an error code.
ChildExit(i32),
}
impl Debug for Event {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
match self {
Event::ClipboardStore(ty, text) => write!(f, "ClipboardStore({ty:?}, {text})"),
Event::ClipboardLoad(ty, _) => write!(f, "ClipboardLoad({ty:?})"),
Event::TextAreaSizeRequest(_) => write!(f, "TextAreaSizeRequest"),
Event::ColorRequest(index, _) => write!(f, "ColorRequest({index})"),
Event::PtyWrite(text) => write!(f, "PtyWrite({text})"),
Event::Title(title) => write!(f, "Title({title})"),
Event::CursorBlinkingChange => write!(f, "CursorBlinkingChange"),
Event::MouseCursorDirty => write!(f, "MouseCursorDirty"),
Event::ResetTitle => write!(f, "ResetTitle"),
Event::Wakeup => write!(f, "Wakeup"),
Event::Bell => write!(f, "Bell"),
Event::Exit => write!(f, "Exit"),
Event::ChildExit(code) => write!(f, "ChildExit({code})"),
}
}
}
/// Byte sequences are sent to a `Notify` in response to some events.
pub trait Notify {
/// Notify that an escape sequence should be written to the PTY.
///
/// TODO this needs to be able to error somehow.
fn notify<B: Into<Cow<'static, [u8]>>>(&self, _: B);
}
#[derive(Copy, Clone, Debug)]
pub struct WindowSize {
pub num_lines: u16,
pub num_cols: u16,
pub cell_width: u16,
pub cell_height: u16,
}
/// Types that are interested in when the display is resized.
pub trait OnResize {
fn on_resize(&mut self, window_size: WindowSize);
}
/// Event Loop for notifying the renderer about terminal events.
pub trait EventListener {
fn send_event(&self, _event: Event) {}
}
/// Null sink for events.
pub struct VoidListener;
impl EventListener for VoidListener {}