Strip ANSI escape codes to compute cursor position #136
Conversation
inquire/src/ansi.rs
Outdated
| pub chars: Chars<'a>, | ||
| } | ||
|
|
||
| /// Constructs an iterator over the chars of the input string, stripping away ANSI escape codes. |
There was a problem hiding this comment.
Let's make a Trait with this method into_ansi_strip_iter() and implement it for &str
There was a problem hiding this comment.
Good idea! I've implemented this in the last commit, but renamed it to ansi_stripped_chars() to more closely match input.chars() though, as this iterator is just a wrapper around Chars.
inquire/src/ansi.rs
Outdated
|
|
||
| /// Match/consume the next ANSI escape code if it exists. | ||
| /// The format is based on [this description](https://handwiki.org/wiki/ANSI_escape_code#CSI_(Control_Sequence_Introducer)_sequences) | ||
| fn match_escape_code(chars: Chars<'_>) -> MatchResult<'_> { |
There was a problem hiding this comment.
Is this cross-platform? Should we use different rules depending on the platform? From a quick search looks like Windows ANSI and Standard ANSI differ
There was a problem hiding this comment.
I think it is, but I'll need to research more before being sure.
Also renamed `strip_iter` to `ansi_stripped_chars`
|
I've also confirmed this fixes #135 :) |
|
Cross-platform compatibility doesn't seem like a concern, from what I've seen. Terminal emulators like Alacritty and Wezterm apparently use the same code to parse ANSI escape sequences, no matter the OS. Cross-terminal compatibility, however, is impossible to achieve, so I'm not sure which standard to implement... Both Wezterm and Alacritty point to this state machine for parsing escape and control sequences, but they're somehow inconsistent?? (this might be a bug in the "vte" crate) I did overlook one thing in my implementation though: only CSI (the sequences that begin with |
|
Should be mergeable now 👀 |
* Strip ANSI escape codes to compute cursor position (#136) * Allow releases from non-main * chore: Release inquire version 0.6.2 --------- Co-authored-by: Leonardo Riether <leonardoalves8217@gmail.com>
An attempt to fix #135
I added a module
crate::ansithat parses ANSI escape codes according to this description, which is then used to skip them when calculating the cursor position onframe_finish();Note that there are some rendering inconsistencies for ANSI codes between terminals, so it's impossible to make this work for every escape sequence in every terminal, but for non-pathological escape codes I think this implementation should be fine.
Pictured: inconsistencies between Kitty, Wezterm and Alacritty.
