Skip to content

Feature/add ctrl key input #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
broccolingual merged 2 commits into from
Aug 22, 2025
Merged

Feature/add ctrl key input #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
557d431
change: add handling for unknown input events and improve input parsi…
broccolingual Aug 22, 2025
56de5df
fix: correct escape sequence for F1 key in input event tests
broccolingual Aug 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions examples/inputs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
format!("Mouse Move: at ({},{})", x, y)
}
},
Some(InputEvent::Unknown) => "Unknown input".to_string(),
None => "No input yet".to_string(),
};

Expand Down
1 change: 0 additions & 1 deletion src/attr.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,4 +89,3 @@ mod tests {
assert_eq!(attr.to_ansi(), "\x1B[0;1;2;3;4;5;6;7;8;9;10m");
}
}

3 changes: 2 additions & 1 deletion src/framebuffer.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ use std::io::{self, Write};

use crate::{Attr, Color};

const CHUNK_SIZE: usize = 1024;

/// Represents a single cell in the framebuffer.
#[derive(Clone, PartialEq, Debug)]
struct Cell {
Expand Down Expand Up @@ -311,7 +313,6 @@ impl Framebuffer {
}
}

const CHUNK_SIZE: usize = 4096;
let mut chunk = String::with_capacity(CHUNK_SIZE);

// Draw the output for each changed cell
Expand Down
119 changes: 76 additions & 43 deletions src/input.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ pub enum Key {
PageDown,
Char(char),
Escape,
Ctrl(char),
Enter, // Ctrl + M
F0,
F1,
F2,
Expand Down Expand Up @@ -65,6 +67,7 @@ pub enum MouseEvent {
pub enum InputEvent {
Key(Key),
Mouse(MouseEvent),
Unknown,
}

impl Key {
Expand Down Expand Up @@ -179,48 +182,70 @@ fn parse_escape_sequence(buf: &[u8], n: usize) -> InputEvent {
return InputEvent::Key(Key::Escape);
}

// Check for mouse event (SGR format)
if n >= 6 && buf[2] == b'<' {
if let Some(mouse_event) = parse_mouse_event(buf, n) {
return InputEvent::Mouse(mouse_event);
// We can check this using `showkey -a` command
let e = match &buf[1] {
// Check SS3 sequence
b'O' => {
let key = match buf[2] {
b'P' => Key::F1,
b'Q' => Key::F2,
b'R' => Key::F3,
b'S' => Key::F4,
_ => Key::Unknown,
};
InputEvent::Key(key)
}
}

let key = match &buf[1..] {
[b'[', b'A', ..] => Key::ArrowUp,
[b'[', b'B', ..] => Key::ArrowDown,
[b'[', b'C', ..] => Key::ArrowRight,
[b'[', b'D', ..] => Key::ArrowLeft,
[b'[', b'1', b'~', ..] | [b'[', b'H', ..] => Key::Home,
[b'[', b'2', b'~', ..] => Key::Insert,
[b'[', b'3', b'~', ..] => Key::Delete,
[b'[', b'5', b'~', ..] => Key::PageUp,
[b'[', b'6', b'~', ..] => Key::PageDown,
[b'[', b'4', b'~', ..] | [b'[', b'7', b'~', ..] | [b'[', b'F', ..] => Key::End,
[b'[', b'1', b'0', b'~', ..] => Key::F0,
[b'[', b'1', b'1', b'~', ..] | [b'[', b'1', b'P', ..] => Key::F1,
[b'[', b'1', b'2', b'~', ..] | [b'[', b'1', b'Q', ..] => Key::F2,
[b'[', b'1', b'3', b'~', ..] | [b'[', b'1', b'R', ..] => Key::F3,
[b'[', b'1', b'4', b'~', ..] | [b'[', b'1', b'S', ..] => Key::F4,
[b'[', b'1', b'5', b'~', ..] => Key::F5,
[b'[', b'1', b'7', b'~', ..] => Key::F6,
[b'[', b'1', b'8', b'~', ..] => Key::F7,
[b'[', b'1', b'9', b'~', ..] => Key::F8,
[b'[', b'2', b'0', b'~', ..] => Key::F9,
[b'[', b'2', b'1', b'~', ..] => Key::F10,
[b'[', b'2', b'3', b'~', ..] => Key::F11,
[b'[', b'2', b'4', b'~', ..] => Key::F12,
[b'[', b'2', b'5', b'~', ..] => Key::F13,
[b'[', b'2', b'6', b'~', ..] => Key::F14,
[b'[', b'2', b'8', b'~', ..] => Key::F15,
[b'[', b'2', b'9', b'~', ..] => Key::F16,
[b'[', b'3', b'1', b'~', ..] => Key::F17,
[b'[', b'3', b'2', b'~', ..] => Key::F18,
[b'[', b'3', b'3', b'~', ..] => Key::F19,
[b'[', b'3', b'4', b'~', ..] => Key::F20,
_ => Key::Unknown,
// Check CSI sequence
b'[' => {
if buf[2] == b'<' {
// Check for mouse event (SGR format)
if let Some(mouse_event) = parse_mouse_event(buf, n) {
InputEvent::Mouse(mouse_event)
} else {
InputEvent::Unknown
}
} else {
// Check special keys
let key = match &buf[2..] {
[b'A', ..] => Key::ArrowUp,
[b'B', ..] => Key::ArrowDown,
[b'C', ..] => Key::ArrowRight,
[b'D', ..] => Key::ArrowLeft,
[b'1', b'~', ..] | [b'H', ..] => Key::Home,
[b'2', b'~', ..] => Key::Insert,
[b'3', b'~', ..] => Key::Delete,
[b'5', b'~', ..] => Key::PageUp,
[b'6', b'~', ..] => Key::PageDown,
[b'4', b'~', ..] | [b'7', b'~', ..] | [b'F', ..] => Key::End,
[b'1', b'0', b'~', ..] => Key::F0,
[b'1', b'1', b'~', ..] => Key::F1,
[b'1', b'2', b'~', ..] => Key::F2,
[b'1', b'3', b'~', ..] => Key::F3,
[b'1', b'4', b'~', ..] => Key::F4,
[b'1', b'5', b'~', ..] => Key::F5,
[b'1', b'7', b'~', ..] => Key::F6,
[b'1', b'8', b'~', ..] => Key::F7,
[b'1', b'9', b'~', ..] => Key::F8,
[b'2', b'0', b'~', ..] => Key::F9,
[b'2', b'1', b'~', ..] => Key::F10,
[b'2', b'3', b'~', ..] => Key::F11,
[b'2', b'4', b'~', ..] => Key::F12,
[b'2', b'5', b'~', ..] => Key::F13,
[b'2', b'6', b'~', ..] => Key::F14,
[b'2', b'8', b'~', ..] => Key::F15,
[b'2', b'9', b'~', ..] => Key::F16,
[b'3', b'1', b'~', ..] => Key::F17,
[b'3', b'2', b'~', ..] => Key::F18,
[b'3', b'3', b'~', ..] => Key::F19,
[b'3', b'4', b'~', ..] => Key::F20,
_ => Key::Unknown,
};
InputEvent::Key(key)
}
}
_ => InputEvent::Unknown,
};
InputEvent::Key(key)
e
}

/// Read input (key or mouse) from standard input.
Expand All @@ -234,8 +259,16 @@ fn read_key(stdin: &mut StdinLock, buf: &mut [u8]) -> io::Result<Option<InputEve
Ok(0) => Ok(None),
Ok(n) => {
let event = match buf[0] {
0x01..=0x1A => {
let c = ((buf[0] - 0x01) + b'a') as char;
if c == 'm' {
InputEvent::Key(Key::Enter) // Ctrl + M
} else {
InputEvent::Key(Key::Ctrl(c))
}
}
0x1B => parse_escape_sequence(buf, n),
c if c.is_ascii() => InputEvent::Key(Key::Char(c as char)),
0x20..=0x7e => InputEvent::Key(Key::Char(buf[0] as char)),
_ => InputEvent::Key(Key::Unknown),
};
Ok(Some(event))
Expand Down Expand Up @@ -268,7 +301,7 @@ impl InputListener {

let handle = thread::spawn(move || {
let mut stdin = io::stdin().lock();
let mut buf = [0u8; 128];
let mut buf = [0u8; 64];

loop {
if stop_rx.try_recv().is_ok() {
Expand Down Expand Up @@ -492,7 +525,7 @@ mod tests {
InputEvent::Key(Key::F1)
);
assert_eq!(
parse_escape_sequence(b"\x1B[1P", 4),
parse_escape_sequence(b"\x1BOP", 4),
InputEvent::Key(Key::F1)
);
}
Expand Down
28 changes: 25 additions & 3 deletions src/term.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use crate::csi;
use nix::libc;
use nix::sys::termios::{self, LocalFlags, SetArg, Termios};
use nix::sys::termios::{self, ControlFlags, InputFlags, LocalFlags, OutputFlags, SetArg, Termios};
use std::os::unix::io::{BorrowedFd, RawFd};
use std::{
io::{self, Write},
Expand Down Expand Up @@ -57,8 +57,30 @@ impl Terminal {
let original = termios::tcgetattr(borrowed_fd)?;
let mut raw = original.clone();

raw.local_flags
.remove(LocalFlags::ICANON | LocalFlags::ECHO);
raw.input_flags.remove(
InputFlags::BRKINT
| InputFlags::ICRNL
| InputFlags::INPCK
| InputFlags::ISTRIP
| InputFlags::IXON,
);

raw.output_flags.remove(OutputFlags::OPOST); // disable output processing

raw.control_flags
.remove(ControlFlags::CSIZE | ControlFlags::PARENB);
raw.control_flags.insert(ControlFlags::CS8);

raw.local_flags.remove(
LocalFlags::ICANON
| LocalFlags::ECHONL
| LocalFlags::ECHO
| LocalFlags::ISIG
| LocalFlags::IEXTEN,
);
raw.control_chars[libc::VMIN as usize] = 1; // Minimum number of characters to read
raw.control_chars[libc::VTIME as usize] = 0; // No timeout

termios::tcsetattr(borrowed_fd, SetArg::TCSANOW, &raw)?;

self.original = Some(original);
Expand Down