Skip to content

Commit

Permalink
Strip OSC sequences before printing
Browse files Browse the repository at this point in the history
This commit strips OSC (Operating System Command) sequences before
printing lines. Eventually when time permits, I want to add back
support for printing OSC sequences (and improve it to treat hyperlinks
like an attribute).

Until then, this should help prevent garbled output :)
  • Loading branch information
eth-p committed Apr 17, 2023
1 parent 2e1ea1e commit 5c90eca
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 4 deletions.
8 changes: 5 additions & 3 deletions src/printer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ use crate::line_range::RangeCheckResult;
use crate::preprocessor::{expand_tabs, replace_nonprintable};
use crate::style::StyleComponent;
use crate::terminal::{as_terminal_escaped, to_ansi_color};
use crate::vscreen::AnsiStyle;
use crate::vscreen::{AnsiStyle, strip_problematic_sequences};
use crate::wrapping::WrappingMode;

pub(crate) trait Printer {
Expand Down Expand Up @@ -520,7 +520,8 @@ impl<'a> Printer for InteractivePrinter<'a> {
let italics = self.config.use_italic_text;

for &(style, region) in &regions {
let ansi_iterator = AnsiCodeIterator::new(region);
let text = strip_problematic_sequences(region);
let ansi_iterator = AnsiCodeIterator::new(&text);
for chunk in ansi_iterator {
match chunk {
// ANSI escape passthrough.
Expand Down Expand Up @@ -573,7 +574,8 @@ impl<'a> Printer for InteractivePrinter<'a> {
}
} else {
for &(style, region) in &regions {
let ansi_iterator = AnsiCodeIterator::new(region);
let text = strip_problematic_sequences(region);
let ansi_iterator = AnsiCodeIterator::new(&text);
for chunk in ansi_iterator {
match chunk {
// ANSI escape passthrough.
Expand Down
55 changes: 54 additions & 1 deletion src/vscreen.rs
Original file line number Diff line number Diff line change
Expand Up @@ -452,9 +452,54 @@ impl<'a> Iterator for EscapeSequenceOffsetsIterator<'a> {
}
}

/// Strips problematic ANSI escape sequences from a string.
///
/// Ideally, this will be replaced with something that uses [[Attributes]] to create a table of char offsets
/// -> absolute styles and style deltas. Something like that would let us simplify the printer (and support
/// re-printing OSC hyperlink commands).
pub fn strip_problematic_sequences(text: &str) -> String {
use EscapeSequenceOffsets::*;

let mut buffer = String::with_capacity(text.len());
for seq in EscapeSequenceOffsetsIterator::new(text) {
match seq {
Text { start, end } => buffer.push_str(&text[start..end]),
Unknown { start, end } => buffer.push_str(&text[start..end]),

NF {
start_sequence: start,
start: _,
end,
} => buffer.push_str(&text[start..end]),

CSI {
start_sequence: start,
start_parameters: _,
start_intermediates: _,
start_final_byte: _,
end,
} => buffer.push_str(&text[start..end]),

OSC {
start_sequence: _,
start_command: _,
start_terminator: _,
end: _,
} => {
// TODO(eth-p): Support re-printing hyperlinks.
// In the meantime, strip these.
}
}
}

buffer
}

#[cfg(test)]
mod tests {
use crate::vscreen::{EscapeSequenceOffsets, EscapeSequenceOffsetsIterator};
use crate::vscreen::{
strip_problematic_sequences, EscapeSequenceOffsets, EscapeSequenceOffsetsIterator,
};

#[test]
fn test_escape_sequence_offsets_iterator_parses_text() {
Expand Down Expand Up @@ -677,4 +722,12 @@ mod tests {
);
assert_eq!(iter.next(), None);
}

#[test]
fn test_strip_problematic_sequences() {
assert_eq!(
strip_problematic_sequences("text\x1B[33m\x1B]OSC\x1B\\\x1B(0"),
"text\x1B[33m\x1B(0"
);
}
}

0 comments on commit 5c90eca

Please sign in to comment.