Merge pull request #305 from yoichi/iterm2-support

Add iTerm2 image protocol support

Author: o2sh

src/onefetch/cli.rs

@@ -36,7 +36,7 @@ impl Cli {
     /// Build `Options` from command line arguments.
     pub fn new() -> Result<Self> {
         #[cfg(not(windows))]
-        let possible_backends = ["kitty", "sixel"];
+        let possible_backends = ["kitty", "iterm2", "sixel"];
         #[cfg(windows)]
         let possible_backends = [];
         let color_values = &[

src/onefetch/image_backends/iterm2.rs

@@ -0,0 +1,61 @@
+use {
+    image::{imageops::FilterType, DynamicImage, GenericImageView},
+    libc::{ioctl, winsize, STDOUT_FILENO, TIOCGWINSZ},
+    std::env,
+};
+
+pub struct ITerm2Backend {}
+
+impl ITerm2Backend {
+    pub fn new() -> Self {
+        Self {}
+    }
+
+    pub fn supported() -> bool {
+        let term_program = env::var("TERM_PROGRAM").unwrap_or("".to_string());
+        term_program == "iTerm.app"
+    }
+}
+
+impl super::ImageBackend for ITerm2Backend {
+    fn add_image(&self, lines: Vec<String>, image: &DynamicImage, _colors: usize) -> String {
+        let tty_size = unsafe {
+            let tty_size: winsize = std::mem::zeroed();
+            ioctl(STDOUT_FILENO, TIOCGWINSZ, &tty_size);
+            tty_size
+        };
+        let width_ratio = f64::from(tty_size.ws_col) / f64::from(tty_size.ws_xpixel);
+        let height_ratio = f64::from(tty_size.ws_row) / f64::from(tty_size.ws_ypixel);
+
+        // resize image to fit the text height with the Lanczos3 algorithm
+        let image = image.resize(
+            u32::max_value(),
+            (lines.len() as f64 / height_ratio) as u32,
+            FilterType::Lanczos3,
+        );
+        let _image_columns = width_ratio * f64::from(image.width());
+        let image_rows = height_ratio * f64::from(image.height());
+
+        let mut bytes: Vec<u8> = Vec::new();
+        image
+            .write_to(&mut bytes, image::ImageOutputFormat::Png)
+            .unwrap();
+        let encoded_image = base64::encode(bytes);
+        let mut image_data = Vec::<u8>::new();
+
+        image_data.extend(b"\x1B]1337;File=inline=1:");
+        image_data.extend(encoded_image.bytes());
+        image_data.extend(b"\x07");
+
+        image_data.extend(format!("\x1B[{}A", image_rows as u32 - 1).as_bytes()); // move cursor to start of image
+        let mut i = 0;
+        for line in &lines {
+            image_data.extend(format!("\x1B[s{}\x1B[u\x1B[1B", line).as_bytes());
+            i += 1;
+        }
+        image_data
+            .extend(format!("\n\x1B[{}B", lines.len().max(image_rows as usize) - i).as_bytes()); // move cursor to end of image
+
+        String::from_utf8(image_data).unwrap()
+    }
+}

src/onefetch/image_backends/mod.rs

@@ -1,6 +1,8 @@
 use crate::onefetch::error::*;
 use image::DynamicImage;
 
+#[cfg(not(windows))]
+pub mod iterm2;
 #[cfg(not(windows))]
 pub mod kitty;
 #[cfg(not(windows))]
@@ -14,6 +16,8 @@ pub trait ImageBackend {
 pub fn get_best_backend() -> Option<Box<dyn ImageBackend>> {
     if kitty::KittyBackend::supported() {
         Some(Box::new(kitty::KittyBackend::new()))
+    } else if iterm2::ITerm2Backend::supported() {
+        Some(Box::new(iterm2::ITerm2Backend::new()))
     } else if sixel::SixelBackend::supported() {
         Some(Box::new(sixel::SixelBackend::new()))
     } else {
@@ -32,6 +36,7 @@ pub fn check_if_supported(backend_name: &str) -> Result<()> {
                 return Err("Kitty image backend is not supported".into());
             }
         }
+        "iterm2" => {}
         "sixel" => {
             if !sixel::SixelBackend::supported() {
                 return Err("Sixel image backend is not supported".into());
@@ -47,6 +52,7 @@ pub fn get_image_backend(backend_name: &str) -> Option<Box<dyn ImageBackend>> {
     #[cfg(not(windows))]
     let backend = Some(match backend_name {
         "kitty" => Box::new(kitty::KittyBackend::new()) as Box<dyn ImageBackend>,
+        "iterm2" => Box::new(iterm2::ITerm2Backend::new()) as Box<dyn ImageBackend>,
         "sixel" => Box::new(sixel::SixelBackend::new()) as Box<dyn ImageBackend>,
         _ => unreachable!(),
     });