Merge branch 'main' into fix/macos-burn-issue

Author: ifd3f

.github/ISSUE_TEMPLATE/bug_report.md

@@ -24,6 +24,7 @@ A clear and concise description of what you expected to happen.
 Please upload log files to aid in debugging the issue.
 
 ## OS/Environment
+ - Terminal emulator: [e.g. konsole, GNOME terminal, alacritty, xterm]
  - OS: [e.g. Linux]
  - Version: [e.g. v0.4.3]
  - Distribution channel: [e.g. release binary, AUR, Nix, built from source]

.gitignore

@@ -8,6 +8,7 @@
 *.img
 *.iso
 *.xz
+*.lz4
 *.gz
 *.o
 *.a

Cargo.lock

@@ -8,25 +8,19 @@ version = "0.4.4"
 edition = "2021"
 license = "GPL-3.0"
 
-[features]
-default = ["gz", "xz", "bz2"]
-gz = ["dep:flate2"]
-xz = ["dep:xz2"]
-bz2 = ["dep:bzip2"]
-
 [dependencies]
 anyhow = "1.0.82"
 base16 = "0.2.1"
 base64 = "0.22.1"
 bincode = "1.3.3"
 byteorder = "1.5.0"
 bytesize = "1.3.0"
-bzip2 = { version = "0.4.4", optional = true, features = ["static"] }
+bzip2 = { version = "0.4.4", features = ["static"] }
 clap = { version = "4.5.4", features = ["derive", "cargo", "wrap_help"] }
 crossterm = { version = "0.27.0", features = ["event-stream"] }
 derive_more = "0.99.17"
 digest = "0.10.6"
-flate2 = { version = "1.0.25", optional = true }
+flate2 = "1.0.25"
 format-bytes = "0.3.0"
 futures = "0.3.30"
 futures-io = "0.3.26"
@@ -36,6 +30,7 @@ interprocess = { version = "2.0.0", features = ["tokio"] }
 is-terminal = "0.4.12"
 itertools = "0.12.1"
 libc = "0.2.154"
+lz4_flex = "0.11.3"
 md-5 = "0.10.5"
 process_path = "0.1.4"
 ratatui = "0.26.0"
@@ -56,7 +51,7 @@ tracing-subscriber = { version = "0.3.16", features = ["env-filter", "fmt"] }
 tracing-unwrap = "1.0.1"
 valuable = { version = "0.1.0", features = ["derive"] }
 which = "6.0.1"
-xz2 = { version = "0.1.7", optional = true, features = ["static"] }
+xz2 = { version = "0.1.7", features = ["static"] }
 
 [dev-dependencies]
 approx = "0.5.1"

Cargo.toml

@@ -12,7 +12,7 @@ macro_rules! generate {
     {
         $readervar:ident: $r:ident {
             $(
-                [feature=$feature:expr] $extpat:pat =>
+                $extpat:pat =>
                     $enumarm:ident($display:expr, $inner:ty)
                     $dcrinner:expr,
             )*
@@ -74,15 +74,6 @@ macro_rules! generate {
                     _ => false,
                 }
             }
-
-            pub fn is_available(self) -> bool {
-                match self {
-                    Self::Identity => true,
-                    $(
-                        Self::$enumarm => cfg!(feature = $feature),
-                    )*
-                }
-            }
         }
 
         impl Display for CompressionFormat {
@@ -96,10 +87,9 @@ macro_rules! generate {
             }
         }
 
-        pub enum DecompressRead<$r> {
+        pub enum DecompressRead<$r: BufRead> {
             Identity($r),
             $(
-                #[cfg(feature = $feature)]
                 $enumarm($inner),
             )*
         }
@@ -112,7 +102,6 @@ macro_rules! generate {
                 match self {
                     Self::Identity(r) => r,
                     $(
-                        #[cfg(feature = $feature)]
                         Self::$enumarm(r) => r.get_mut(),
                     )*
                 }
@@ -127,30 +116,22 @@ macro_rules! generate {
                 match self {
                     Self::Identity(r) => r.read(buf),
                     $(
-                        #[cfg(feature = $feature)]
                         Self::$enumarm(r) => r.read(buf),
                     )*
                 }
             }
         }
 
-        pub fn decompress<R>(cf: CompressionFormat, $readervar: R) -> Result<DecompressRead<R>, DecompressError>
+        /// Open a decompressor for the given reader.
+        pub fn decompress<R>(cf: CompressionFormat, $readervar: R) -> anyhow::Result<DecompressRead<R>>
         where
             R : BufRead
         {
             match cf {
                 CompressionFormat::Identity => Ok(DecompressRead::Identity($readervar)),
                 $(
                     CompressionFormat::$enumarm => {
-                        #[cfg(feature = $feature)]
-                        let result = Ok(DecompressRead::$enumarm($dcrinner));
-
-                        #[cfg(not(feature = $feature))]
-                        let result = Err(DecompressError::UnsupportedFormat(
-                            CompressionFormat::$enumarm
-                        ));
-
-                        result
+                        Ok(DecompressRead::$enumarm($dcrinner))
                     }
                 )*
             }
@@ -160,25 +141,21 @@ macro_rules! generate {
 
 generate! {
     r: R {
-        [feature = "gz"] "gz" => Gz("gzip", flate2::bufread::GzDecoder<R>) {
+        "gz" => Gz("gzip", flate2::bufread::GzDecoder<R>) {
             flate2::bufread::GzDecoder::new(r)
         },
-        [feature = "bz2"] "bz2" => Bz2("bzip2", bzip2::bufread::BzDecoder<R>) {
+        "bz2" => Bz2("bzip2", bzip2::bufread::BzDecoder<R>) {
             bzip2::bufread::BzDecoder::new(r)
         },
-        [feature = "xz"] "xz" => Xz("xz/LZMA", xz2::bufread::XzDecoder<R>) {
+        "xz" => Xz("xz/LZMA", xz2::bufread::XzDecoder<R>) {
             xz2::bufread::XzDecoder::new(r)
         },
+        "lz4" => Lz4("lz4", lz4_flex::frame::FrameDecoder<R>) {
+            lz4_flex::frame::FrameDecoder::new(r)
+        },
     }
 }
 
-#[derive(Debug, thiserror::Error)]
-pub enum DecompressError {
-    #[allow(unused)]
-    #[error("Unsupported compression format {0}!")]
-    UnsupportedFormat(CompressionFormat),
-}
-
 impl CompressionFormat {
     pub fn detect_from_path(path: impl AsRef<Path>) -> Option<CompressionFormat> {
         if let Some(ext) = path.as_ref().extension() {

src/compression.rs

@@ -113,29 +113,54 @@ struct ComputedLayout {
     progress: Rect,
     graph: Rect,
     args_display: Rect,
+    quit_modal: Rect,
 }
 
 impl From<Rect> for ComputedLayout {
-    fn from(value: Rect) -> Self {
+    fn from(area: Rect) -> Self {
         let root = Layout::default()
             .direction(Direction::Vertical)
             .constraints([
                 Constraint::Length(1),
                 Constraint::Min(10),
                 Constraint::Length(10),
             ])
-            .split(value);
+            .split(area);
 
         let info_pane = root[2];
 
+        let quit_modal = centered_rect(area, 40, 4);
+
         Self {
             graph: root[1],
             progress: root[0],
             args_display: info_pane,
+            quit_modal,
         }
     }
 }
 
+/// Given an outer rect and desired inner rect dimensions, returns the inner rect.
+fn centered_rect(r: Rect, w: u16, h: u16) -> Rect {
+    let popup_layout = Layout::default()
+        .direction(Direction::Vertical)
+        .constraints([
+            Constraint::Fill(1),
+            Constraint::Length(h),
+            Constraint::Fill(1),
+        ])
+        .split(r);
+
+    Layout::default()
+        .direction(Direction::Horizontal)
+        .constraints([
+            Constraint::Fill(1),
+            Constraint::Length(w),
+            Constraint::Fill(1),
+        ])
+        .split(popup_layout[1])[1]
+}
+
 pub fn draw(
     state: &mut State,
     terminal: &mut Terminal<impl ratatui::backend::Backend>,
@@ -184,6 +209,10 @@ pub fn draw(
         } else {
             f.render_widget(info_table, layout.args_display);
         }
+
+        if let Some(qm) = state.quit_modal {
+            f.render_widget(qm, layout.quit_modal)
+        }
     })?;
     Ok(())
 }

src/ui/fancy_ui/display.rs

@@ -8,7 +8,7 @@ use crate::{
     writer_process::ipc::StatusMessage,
 };
 
-use super::widgets::SpeedChartState;
+use super::widgets::{QuitModal, QuitModalResult, SpeedChartState};
 
 #[derive(Debug, PartialEq, Clone)]
 pub enum UIEvent {
@@ -23,6 +23,7 @@ pub struct State {
     pub target_filename: String,
     pub child: WriterState,
     pub graph_state: SpeedChartState,
+    pub quit_modal: Option<QuitModal>,
 }
 
 impl State {
@@ -32,6 +33,7 @@ impl State {
             target_filename: params.target.devnode.to_string_lossy().to_string(),
             child: WriterState::initial(now, !params.compression.is_identity(), input_file_bytes),
             graph_state: SpeedChartState::default(),
+            quit_modal: None,
         }
     }
 
@@ -51,13 +53,34 @@ impl State {
     fn on_term_event(self, ev: Event) -> anyhow::Result<Self> {
         match ev {
             Event::Key(KeyEvent {
-                code: KeyCode::Char('c'),
-                modifiers: KeyModifiers::CONTROL,
                 kind: KeyEventKind::Press,
+                code,
+                modifiers,
                 ..
-            }) => {
-                info!("Got CTRL-C, quitting");
-                Err(Quit)?
+            }) => self.handle_key_down((code, modifiers)),
+            _ => Ok(self),
+        }
+    }
+
+    fn handle_key_down(mut self, (kc, km): (KeyCode, KeyModifiers)) -> anyhow::Result<Self> {
+        if let Some(qm) = &self.quit_modal {
+            return match qm.handle_key_down(kc) {
+                Some(QuitModalResult::Quit) => Err(Quit.into()),
+                Some(QuitModalResult::Stay) => Ok(Self {
+                    quit_modal: None,
+                    ..self
+                }),
+                None => Ok(self),
+            };
+        }
+
+        match (kc, km) {
+            (KeyCode::Char('c'), KeyModifiers::CONTROL)
+            | (KeyCode::Esc, _)
+            | (KeyCode::Char('q'), _) => {
+                info!("Got request to quit, spawning prompt");
+                self.quit_modal = Some(QuitModal::new());
+                Ok(self)
             }
             _ => Ok(self),
         }