Merge pull request #3068 from ajesipow/read-from-tail

Support relative negative line ranges

Author: keith-hall

Diff for: CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Features
 
 - Add paging to `--list-themes`, see PR #3239 (@einfachIrgendwer0815)
+- Support negative relative line ranges, e.g. `bat -r :-10` / `bat -r='-10:'`, see #3068 (@ajesipow)
 
 ## Bugfixes
 

Diff for: Cargo.lock

@@ -70,6 +70,7 @@ encoding_rs = "0.8.35"
 execute = { version = "0.2.13", optional = true }
 terminal-colorsaurus = "0.4"
 unicode-segmentation = "1.12.0"
+itertools = "0.13.0"
 
 [dependencies.git2]
 version = "0.20"

Diff for: Cargo.toml

@@ -119,17 +119,25 @@ pub fn get_pager_executable(config_pager: Option<&str>) -> Option<String> {
 
 #[test]
 fn default_config_should_include_all_lines() {
+    use crate::line_range::MaxBufferedLineNumber;
     use crate::line_range::RangeCheckResult;
 
-    assert_eq!(LineRanges::default().check(17), RangeCheckResult::InRange);
+    assert_eq!(
+        LineRanges::default().check(17, MaxBufferedLineNumber::Tentative(17)),
+        RangeCheckResult::InRange
+    );
 }
 
 #[test]
 fn default_config_should_highlight_no_lines() {
+    use crate::line_range::MaxBufferedLineNumber;
     use crate::line_range::RangeCheckResult;
 
     assert_ne!(
-        Config::default().highlighted_lines.0.check(17),
+        Config::default()
+            .highlighted_lines
+            .0
+            .check(17, MaxBufferedLineNumber::Tentative(17)),
         RangeCheckResult::InRange
     );
 }

Diff for: src/config.rs

@@ -1,5 +1,3 @@
-use std::io::{self, BufRead, Write};
-
 use crate::assets::HighlightingAssets;
 use crate::config::{Config, VisibleLines};
 #[cfg(feature = "git")]
@@ -10,11 +8,14 @@ use crate::input::{Input, InputReader, OpenedInput};
 use crate::lessopen::LessOpenPreprocessor;
 #[cfg(feature = "git")]
 use crate::line_range::LineRange;
-use crate::line_range::{LineRanges, RangeCheckResult};
+use crate::line_range::{LineRanges, MaxBufferedLineNumber, RangeCheckResult};
 use crate::output::{OutputHandle, OutputType};
 #[cfg(feature = "paging")]
 use crate::paging::PagingMode;
 use crate::printer::{InteractivePrinter, Printer, SimplePrinter};
+use std::collections::VecDeque;
+use std::io::{self, BufRead, Write};
+use std::mem;
 
 use clircle::{Clircle, Identifier};
 
@@ -238,20 +239,63 @@ impl Controller<'_> {
         reader: &mut InputReader,
         line_ranges: &LineRanges,
     ) -> Result<()> {
-        let mut line_buffer = Vec::new();
-        let mut line_number: usize = 1;
-
+        let mut current_line_buffer: Vec<u8> = Vec::new();
+        let mut current_line_number: usize = 1;
+        // Buffer needs to be 1 greater than the offset to have a look-ahead line for EOF
+        let buffer_size: usize = line_ranges.largest_offset_from_end() + 1;
+        // Buffers multiple line data and line number
+        let mut buffered_lines: VecDeque<(Vec<u8>, usize)> = VecDeque::with_capacity(buffer_size);
+
+        let mut reached_eof: bool = false;
         let mut first_range: bool = true;
         let mut mid_range: bool = false;
 
         let style_snip = self.config.style_components.snip();
 
-        while reader.read_line(&mut line_buffer)? {
-            match line_ranges.check(line_number) {
+        loop {
+            if reached_eof && buffered_lines.is_empty() {
+                // Done processing all lines
+                break;
+            }
+            if !reached_eof {
+                if reader.read_line(&mut current_line_buffer)? {
+                    // Fill the buffer
+                    buffered_lines
+                        .push_back((mem::take(&mut current_line_buffer), current_line_number));
+                    current_line_number += 1;
+                } else {
+                    // No more data to read
+                    reached_eof = true;
+                }
+            }
+
+            if buffered_lines.len() < buffer_size && !reached_eof {
+                // The buffer needs to be completely filled first
+                continue;
+            }
+
+            let Some((line, line_nr)) = buffered_lines.pop_front() else {
+                break;
+            };
+
+            // Determine if the last line number in the buffer is the last line of the file or
+            // just a line somewhere in the file
+            let max_buffered_line_number = buffered_lines
+                .back()
+                .map(|(_, max_line_number)| {
+                    if reached_eof {
+                        MaxBufferedLineNumber::Final(*max_line_number)
+                    } else {
+                        MaxBufferedLineNumber::Tentative(*max_line_number)
+                    }
+                })
+                .unwrap_or(MaxBufferedLineNumber::Final(line_nr));
+
+            match line_ranges.check(line_nr, max_buffered_line_number) {
                 RangeCheckResult::BeforeOrBetweenRanges => {
                     // Call the printer in case we need to call the syntax highlighter
                     // for this line. However, set `out_of_range` to `true`.
-                    printer.print_line(true, writer, line_number, &line_buffer)?;
+                    printer.print_line(true, writer, line_nr, &line, max_buffered_line_number)?;
                     mid_range = false;
                 }
 
@@ -266,15 +310,12 @@ impl Controller<'_> {
                         }
                     }
 
-                    printer.print_line(false, writer, line_number, &line_buffer)?;
+                    printer.print_line(false, writer, line_nr, &line, max_buffered_line_number)?;
                 }
                 RangeCheckResult::AfterLastRange => {
                     break;
                 }
             }
-
-            line_number += 1;
-            line_buffer.clear();
         }
         Ok(())
     }