feat!: custom preloader & previewer (#401)

README.md

@@ -1,15 +1,16 @@
 ## Yazi - ⚡️ Blazing Fast Terminal File Manager
 
-Yazi ("duck" in Chinese) is a terminal file manager written in Rust, based on non-blocking async I/O. It aims to provide an efficient, user-friendly, and customizable file management experience.
+Yazi (means "duck") is a terminal file manager written in Rust, based on non-blocking async I/O. It aims to provide an efficient, user-friendly, and customizable file management experience.
 
 💡 A new article explaining its internal workings: [Why is Yazi Fast?](https://yazi-rs.github.io/blog/why-is-yazi-fast)
 
 - 🚀 **Full Asynchronous Support**: All I/O operations are asynchronous, CPU tasks are spread across multiple threads, making the most of available resources.
 - 💪 **Powerful Async Task Scheduling and Management**: Provides real-time progress updates, task cancellation, and internal task priority assignment.
 - 🖼️ **Built-in Support for Multiple Image Protocols**: Also integrated with Überzug++, covering almost all terminals.
-- 🌟 **Built-in Code Highlighting and Image Encoding**: Combined with the pre-caching mechanism, greatly accelerates image and normal file loading.
+- 🌟 **Built-in Code Highlighting and Image Decoding**: Combined with the pre-loading mechanism, greatly accelerates image and normal file loading.
+- 🔌 **Concurrent Plugin System**: UI plugins (rewriting most of the UI), functional plugins (coming soon), custom previewer, and custom preloader; Just some pieces of Lua.
 - 🧰 Integration with fd, rg, fzf, zoxide
-- 💫 Vim-like Input component, and Select component
+- 💫 Vim-like input/select component, auto-completion for cd paths
 - 🏷️ Multi-Tab Support, Scrollable Preview (for videos, PDFs, archives, directories, code, etc.)
 - 🔄 Batch Renaming, Visual Mode, File Chooser
 - 🎨 Theme System, Custom Layouts, Trash Bin, CSI u

cspell.json

@@ -1 +1 @@
-{"language":"en","flagWords":[],"words":["Punct","KEYMAP","splitn","crossterm","YAZI","unar","peekable","ratatui","syntect","pbpaste","pbcopy","ffmpegthumbnailer","oneshot","Posix","Lsar","XADDOS","zoxide","cands","Deque","precache","imageops","IFBLK","IFCHR","IFDIR","IFIFO","IFLNK","IFMT","IFSOCK","IRGRP","IROTH","IRUSR","ISGID","ISUID","ISVTX","IWGRP","IWOTH","IWUSR","IXGRP","IXOTH","IXUSR","libc","winsize","TIOCGWINSZ","xpixel","ypixel","ioerr","appender","Catppuccin","macchiato","gitmodules","Dotfiles","bashprofile","vimrc","flac","webp","exiftool","mediainfo","ripgrep","nvim","indexmap","indexmap","unwatch","canonicalize","serde","fsevent","Ueberzug","iterm","wezterm","sixel","chafa","ueberzugpp","️ Überzug","️ Überzug","Konsole","Alacritty","Überzug","pkgs","paru","unarchiver","pdftoppm","poppler","prebuild","singlefile","jpegopt","EXIF","rustfmt","mktemp","nanos","xclip","xsel","natord","Mintty","nixos","nixpkgs","SIGTSTP","SIGCONT","SIGCONT","mlua","nonstatic","userdata","metatable","natsort","backstack","luajit","Succ","Succ","cand","fileencoding","foldmethod","lightgreen","darkgray","lightred","lightyellow","lightcyan","nushell","msvc","aarch","linemode","sxyazi","rsplit","ZELLIJ","bitflags","bitflags","USERPROFILE","Neovim","vergen","gitcl"],"version":"0.2"}
+{"language":"en","flagWords":[],"words":["Punct","KEYMAP","splitn","crossterm","YAZI","unar","peekable","ratatui","syntect","pbpaste","pbcopy","ffmpegthumbnailer","oneshot","Posix","Lsar","XADDOS","zoxide","cands","Deque","precache","imageops","IFBLK","IFCHR","IFDIR","IFIFO","IFLNK","IFMT","IFSOCK","IRGRP","IROTH","IRUSR","ISGID","ISUID","ISVTX","IWGRP","IWOTH","IWUSR","IXGRP","IXOTH","IXUSR","libc","winsize","TIOCGWINSZ","xpixel","ypixel","ioerr","appender","Catppuccin","macchiato","gitmodules","Dotfiles","bashprofile","vimrc","flac","webp","exiftool","mediainfo","ripgrep","nvim","indexmap","indexmap","unwatch","canonicalize","serde","fsevent","Ueberzug","iterm","wezterm","sixel","chafa","ueberzugpp","️ Überzug","️ Überzug","Konsole","Alacritty","Überzug","pkgs","paru","unarchiver","pdftoppm","poppler","prebuild","singlefile","jpegopt","EXIF","rustfmt","mktemp","nanos","xclip","xsel","natord","Mintty","nixos","nixpkgs","SIGTSTP","SIGCONT","SIGCONT","mlua","nonstatic","userdata","metatable","natsort","backstack","luajit","Succ","Succ","cand","fileencoding","foldmethod","lightgreen","darkgray","lightred","lightyellow","lightcyan","nushell","msvc","aarch","linemode","sxyazi","rsplit","ZELLIJ","bitflags","bitflags","USERPROFILE","Neovim","vergen","gitcl","Renderable","preloaders","prec","imagesize","Upserting"],"version":"0.2"}

yazi-adaptor/Cargo.toml

@@ -14,9 +14,11 @@ yazi-shared = { path = "../yazi-shared", version = "0.1.5" }
 
 # External dependencies
 anyhow      = "^1"
+arc-swap    = "^1"
 base64      = "^0"
 color_quant = "^1"
 image       = "^0"
+imagesize   = "^0"
 ratatui     = "^0"
 tokio       = { version = "^1", features = [ "parking_lot", "io-util", "process" ] }
 

yazi-adaptor/src/adaptor.rs

@@ -1,19 +1,12 @@
-use std::{env, path::{Path, PathBuf}, sync::atomic::{AtomicBool, Ordering}};
+use std::{env, path::Path, sync::{atomic::Ordering, Arc}};
 
 use anyhow::{anyhow, Result};
 use ratatui::prelude::Rect;
-use tokio::{fs, sync::mpsc::UnboundedSender};
 use tracing::warn;
-use yazi_config::PREVIEW;
-use yazi_shared::{env_exists, RoCell};
+use yazi_shared::{env_exists, term::Term};
 
 use super::{Iterm2, Kitty, KittyOld};
-use crate::{ueberzug::Ueberzug, Sixel, TMUX};
-
-static IMAGE_SHOWN: AtomicBool = AtomicBool::new(false);
-
-#[allow(clippy::type_complexity)]
-static UEBERZUG: RoCell<Option<UnboundedSender<Option<(PathBuf, Rect)>>>> = RoCell::new();
+use crate::{ueberzug::Ueberzug, Sixel, SHOWN, TMUX};
 
 #[derive(Clone, Copy, PartialEq, Eq, Debug)]
 pub enum Adaptor {
@@ -164,46 +157,46 @@ impl ToString for Adaptor {
 }
 
 impl Adaptor {
-	pub(super) fn start(self) {
-		UEBERZUG.init(if self.needs_ueberzug() { Ueberzug::start(self).ok() } else { None });
-	}
-
-	pub async fn image_show(self, mut path: &Path, rect: Rect) -> Result<()> {
-		let cache = PREVIEW.cache(path, 0);
-		if fs::symlink_metadata(&cache).await.is_ok() {
-			path = cache.as_path();
-		}
-
-		self.image_hide(rect).ok();
-		IMAGE_SHOWN.store(true, Ordering::Relaxed);
+	pub(super) fn start(self) { Ueberzug::start(self); }
 
+	pub async fn image_show(self, path: &Path, rect: Rect) -> Result<(u32, u32)> {
 		match self {
 			Self::Kitty => Kitty::image_show(path, rect).await,
 			Self::KittyOld => KittyOld::image_show(path, rect).await,
 			Self::Iterm2 => Iterm2::image_show(path, rect).await,
 			Self::Sixel => Sixel::image_show(path, rect).await,
-			_ => Ok(if let Some(tx) = &*UEBERZUG {
-				tx.send(Some((path.to_path_buf(), rect)))?;
-			}),
+			_ => Ueberzug::image_show(path, rect).await,
 		}
 	}
 
-	pub fn image_hide(self, rect: Rect) -> Result<()> {
-		if !IMAGE_SHOWN.swap(false, Ordering::Relaxed) {
-			return Ok(());
-		}
+	pub fn image_hide(self) -> Result<()> {
+		if let Some(rect) = SHOWN.swap(None) { self.image_erase(*rect) } else { Ok(()) }
+	}
 
+	pub fn image_erase(self, rect: Rect) -> Result<()> {
 		match self {
-			Self::Kitty => Kitty::image_hide(rect),
-			Self::Iterm2 => Iterm2::image_hide(rect),
-			Self::KittyOld => KittyOld::image_hide(),
-			Self::Sixel => Sixel::image_hide(rect),
-			_ => Ok(if let Some(tx) = &*UEBERZUG {
-				tx.send(None)?;
-			}),
+			Self::Kitty => Kitty::image_erase(rect),
+			Self::Iterm2 => Iterm2::image_erase(rect),
+			Self::KittyOld => KittyOld::image_erase(),
+			Self::Sixel => Sixel::image_erase(rect),
+			_ => Ueberzug::image_erase(rect),
 		}
 	}
 
+	#[inline]
+	pub(super) fn shown_store(rect: Rect, size: (u32, u32)) {
+		SHOWN.store(Some(Arc::new(
+			Term::ratio()
+				.map(|(r1, r2)| Rect {
+					x:      rect.x,
+					y:      rect.y,
+					width:  (size.0 as f64 / r1).ceil() as u16,
+					height: (size.1 as f64 / r2).ceil() as u16,
+				})
+				.unwrap_or(rect),
+		)));
+	}
+
 	#[inline]
 	pub(super) fn needs_ueberzug(self) -> bool {
 		!matches!(self, Self::Kitty | Self::KittyOld | Self::Iterm2 | Self::Sixel)