From 9d77c1373c59f9998b9991f1a58ffc6bf679d087 Mon Sep 17 00:00:00 2001 From: "Ethan P." Date: Sun, 11 Feb 2024 13:49:13 -0800 Subject: [PATCH 1/4] Fix off-by-one error in line number continuation --- CHANGELOG.md | 1 + src/decorations.rs | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b6e13469..c1d55dce 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ - Fix long file name wrapping in header, see #2835 (@FilipRazek) - Fix `NO_COLOR` support, see #2767 (@acuteenvy) - Fix handling of inputs with OSC ANSI escape sequences, see #2541 and #2544 (@eth-p) +- Fix panel width when line 10000 wraps, see #2854 (@eth-p) ## Other diff --git a/src/decorations.rs b/src/decorations.rs index d3ed9b34..85d8103a 100644 --- a/src/decorations.rs +++ b/src/decorations.rs @@ -46,7 +46,7 @@ impl Decoration for LineNumberDecoration { _printer: &InteractivePrinter, ) -> DecorationText { if continuation { - if line_number > self.cached_wrap_invalid_at { + if line_number >= self.cached_wrap_invalid_at { let new_width = self.cached_wrap.width + 1; return DecorationText { text: self.color.paint(" ".repeat(new_width)).to_string(), From 915dd9fbf8d6acf5e56828e9ce4352e255ee5ad5 Mon Sep 17 00:00:00 2001 From: "Ethan P." Date: Sun, 11 Feb 2024 19:27:04 -0800 Subject: [PATCH 2/4] Fix incorrect categorization of SGR sequences Specifically, prevent other attributes from leaking into the bold/dim/italic/underline attributes, and ensure that bright backgrounds are put into the background attribute instead of the foreground attribute. --- CHANGELOG.md | 1 + src/vscreen.rs | 10 +++++----- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b6e13469..f0d81642 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ - Fix long file name wrapping in header, see #2835 (@FilipRazek) - Fix `NO_COLOR` support, see #2767 (@acuteenvy) - Fix handling of inputs with OSC ANSI escape sequences, see #2541 and #2544 (@eth-p) +- Fix handling of inputs with combined ANSI color and attribute sequences, see #2185 and #2856 (@eth-p) ## Other diff --git a/src/vscreen.rs b/src/vscreen.rs index c902d42b..f883e655 100644 --- a/src/vscreen.rs +++ b/src/vscreen.rs @@ -169,10 +169,10 @@ impl Attributes { while let Some(p) = iter.next() { match p { 0 => self.sgr_reset(), - 1 => self.bold = format!("\x1B[{}m", parameters), - 2 => self.dim = format!("\x1B[{}m", parameters), - 3 => self.italic = format!("\x1B[{}m", parameters), - 4 => self.underline = format!("\x1B[{}m", parameters), + 1 => self.bold = "\x1B[1m".to_owned(), + 2 => self.dim = "\x1B[2m".to_owned(), + 3 => self.italic = "\x1B[3m".to_owned(), + 4 => self.underline = "\x1B[4m".to_owned(), 23 => self.italic.clear(), 24 => self.underline.clear(), 22 => { @@ -183,7 +183,7 @@ impl Attributes { 40..=49 => self.background = Self::parse_color(p, &mut iter), 58..=59 => self.underlined = Self::parse_color(p, &mut iter), 90..=97 => self.foreground = Self::parse_color(p, &mut iter), - 100..=107 => self.foreground = Self::parse_color(p, &mut iter), + 100..=107 => self.background = Self::parse_color(p, &mut iter), _ => { // Unsupported SGR sequence. // Be compatible and pretend one just wasn't was provided. From 84d80eebd0b224cd799282121e817fa5f0d57d5e Mon Sep 17 00:00:00 2001 From: "Ethan P." Date: Sun, 11 Feb 2024 19:29:09 -0800 Subject: [PATCH 3/4] Test for correct categorization of SGR sequences This adds a regression test for the fix in the previous commit. --- src/vscreen.rs | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/src/vscreen.rs b/src/vscreen.rs index f883e655..78f6ad4e 100644 --- a/src/vscreen.rs +++ b/src/vscreen.rs @@ -890,4 +890,37 @@ mod tests { ); assert_eq!(iter.next(), None); } + + #[test] + fn test_sgr_attributes_do_not_leak_into_wrong_field() { + let mut attrs = crate::vscreen::Attributes::new(); + + // Bold, Dim, Italic, Underline, Foreground, Background + attrs.update(EscapeSequence::CSI { + raw_sequence: "\x1B[1;2;3;4;31;41m", + parameters: "1;2;3;4;31;41", + intermediates: "", + final_byte: "m", + }); + + assert_eq!(attrs.bold, "\x1B[1m"); + assert_eq!(attrs.dim, "\x1B[2m"); + assert_eq!(attrs.italic, "\x1B[3m"); + assert_eq!(attrs.underline, "\x1B[4m"); + assert_eq!(attrs.foreground, "\x1B[31m"); + assert_eq!(attrs.background, "\x1B[41m"); + + // Bold, Bright Foreground, Bright Background + attrs.sgr_reset(); + attrs.update(EscapeSequence::CSI { + raw_sequence: "\x1B[1;94;103m", + parameters: "1;94;103", + intermediates: "", + final_byte: "m", + }); + + assert_eq!(attrs.bold, "\x1B[1m"); + assert_eq!(attrs.foreground, "\x1B[94m"); + assert_eq!(attrs.background, "\x1B[103m"); + } } From 6a6b02117b577df90c483aac406952a3814462da Mon Sep 17 00:00:00 2001 From: cyqsimon <28627918+cyqsimon@users.noreply.github.com> Date: Wed, 21 Feb 2024 02:39:22 +0800 Subject: [PATCH 4/4] Apply clippy fixes (#2864) * Apply clippy fixes * Write changelog --- CHANGELOG.md | 1 + src/vscreen.rs | 29 +++++++++++++++-------------- tests/tester/mod.rs | 2 +- 3 files changed, 17 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ec8348d5..a672edcb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -24,6 +24,7 @@ - Pull in fix for unsafe-libyaml security advisory, see #2812 (@dtolnay) - Update git-version dependency to use Syn v2, see #2816 (@dtolnay) - Update git2 dependency to v0.18.2, see #2852 (@eth-p) +- Apply clippy fixes #2864 (@cyqsimon) ## Syntaxes diff --git a/src/vscreen.rs b/src/vscreen.rs index 78f6ad4e..f7ba3f91 100644 --- a/src/vscreen.rs +++ b/src/vscreen.rs @@ -24,9 +24,9 @@ impl AnsiStyle { } } - pub fn to_reset_sequence(&mut self) -> String { - match &mut self.attributes { - Some(a) => a.to_reset_sequence(), + pub fn to_reset_sequence(&self) -> String { + match self.attributes { + Some(ref a) => a.to_reset_sequence(), None => String::new(), } } @@ -294,12 +294,14 @@ enum EscapeSequenceOffsets { start: usize, end: usize, }, + #[allow(clippy::upper_case_acronyms)] NF { // https://en.wikipedia.org/wiki/ANSI_escape_code#nF_Escape_sequences start_sequence: usize, start: usize, end: usize, }, + #[allow(clippy::upper_case_acronyms)] OSC { // https://en.wikipedia.org/wiki/ANSI_escape_code#OSC_(Operating_System_Command)_sequences start_sequence: usize, @@ -307,6 +309,7 @@ enum EscapeSequenceOffsets { start_terminator: usize, end: usize, }, + #[allow(clippy::upper_case_acronyms)] CSI { // https://en.wikipedia.org/wiki/ANSI_escape_code#CSI_(Control_Sequence_Introducer)_sequences start_sequence: usize, @@ -340,9 +343,7 @@ impl<'a> EscapeSequenceOffsetsIterator<'a> { /// Takes values from the iterator while the predicate returns true. /// If the predicate returns false, that value is left. fn chars_take_while(&mut self, pred: impl Fn(char) -> bool) -> Option<(usize, usize)> { - if self.chars.peek().is_none() { - return None; - } + self.chars.peek()?; let start = self.chars.peek().unwrap().0; let mut end: usize = start; @@ -359,10 +360,8 @@ impl<'a> EscapeSequenceOffsetsIterator<'a> { } fn next_text(&mut self) -> Option { - match self.chars_take_while(|c| c != '\x1B') { - None => None, - Some((start, end)) => Some(EscapeSequenceOffsets::Text { start, end }), - } + self.chars_take_while(|c| c != '\x1B') + .map(|(start, end)| EscapeSequenceOffsets::Text { start, end }) } fn next_sequence(&mut self) -> Option { @@ -444,7 +443,7 @@ impl<'a> EscapeSequenceOffsetsIterator<'a> { Some(EscapeSequenceOffsets::OSC { start_sequence, start_command: osc_open_index + osc_open_char.len_utf8(), - start_terminator: start_terminator, + start_terminator, end: end_sequence, }) } @@ -502,9 +501,8 @@ impl<'a> EscapeSequenceOffsetsIterator<'a> { } // Get the final byte. - match self.chars.next() { - Some((i, c)) => end = i + c.len_utf8(), - None => {} + if let Some((i, c)) = self.chars.next() { + end = i + c.len_utf8() } Some(EscapeSequenceOffsets::NF { @@ -593,15 +591,18 @@ impl<'a> Iterator for EscapeSequenceIterator<'a> { pub enum EscapeSequence<'a> { Text(&'a str), Unknown(&'a str), + #[allow(clippy::upper_case_acronyms)] NF { raw_sequence: &'a str, nf_sequence: &'a str, }, + #[allow(clippy::upper_case_acronyms)] OSC { raw_sequence: &'a str, command: &'a str, terminator: &'a str, }, + #[allow(clippy::upper_case_acronyms)] CSI { raw_sequence: &'a str, parameters: &'a str, diff --git a/tests/tester/mod.rs b/tests/tester/mod.rs index 8ddea11f..c4e916a6 100644 --- a/tests/tester/mod.rs +++ b/tests/tester/mod.rs @@ -22,7 +22,7 @@ impl BatTester { pub fn test_snapshot(&self, name: &str, style: &str) { let output = Command::new(&self.exe) .current_dir(self.temp_dir.path()) - .args(&[ + .args([ "sample.rs", "--no-config", "--paging=never",