feat: allow DDS events to change command arguments (#3037)

Author: sxyazi

Cargo.lock

@@ -48,7 +48,7 @@ syntect             = { version = "5.2.0", default-features = false, features =
 tokio               = { version = "1.47.1", features = [ "full" ] }
 tokio-stream        = "0.1.17"
 tokio-util          = "0.7.16"
-toml                = { version = "0.9.4" }
+toml                = { version = "0.9.5" }
 tracing             = { version = "0.1.41", features = [ "max_level_debug", "release_max_level_debug" ] }
 twox-hash           = { version = "2.1.1", default-features = false, features = [ "std", "random", "xxhash3_128" ] }
 unicode-width       = { version = "0.2.0", default-features = false }

Cargo.toml

@@ -29,7 +29,7 @@ Yazi (means "duck") is a terminal file manager written in Rust, based on non-blo
 - 💫 Vim-like input/pick/confirm/which/notify component, auto-completion for cd paths
 - 🏷️ Multi-Tab Support, Cross-directory selection, Scrollable Preview (for videos, PDFs, archives, code, directories, etc.)
 - 🔄 Bulk Renaming, Archive Extraction, Visual Mode, File Chooser, [Git Integration](https://github.com/yazi-rs/plugins/tree/main/git.yazi), [Mount Manager](https://github.com/yazi-rs/plugins/tree/main/mount.yazi)
-- 🎨 Theme System, Mouse Support, Trash Bin, Custom Layouts, CSI u, OSC 52
+- 🎨 Theme System, Mouse Support, Trash Bin, Custom Layouts, Virtual Filesystem, CSI u, OSC 52
 - ... and more!
 
 https://github.com/sxyazi/yazi/assets/17523360/92ff23fa-0cd5-4f04-b387-894c12265cc7

README.md

@@ -1,4 +1,5 @@
 use anyhow::Result;
+use yazi_dds::spark::SparkKind;
 use yazi_shared::event::Data;
 
 use crate::Ctx;
@@ -10,5 +11,5 @@ pub trait Actor {
 
 	fn act(cx: &mut Ctx, opt: Self::Options) -> Result<Data>;
 
-	fn hook(_cx: &Ctx, _opt: &Self::Options) -> Option<&'static str> { None }
+	fn hook(_cx: &Ctx, _opt: &Self::Options) -> Option<SparkKind> { None }
 }

yazi-actor/src/actor.rs

@@ -1,48 +1,45 @@
 use std::marker::PhantomData;
 
 use anyhow::Result;
-use mlua::{IntoLua, Value};
-use tracing::error;
+use mlua::{ErrorContext, ExternalError, IntoLua, Value};
 use yazi_binding::runtime_mut;
-use yazi_dds::{LOCAL, body::Body};
-use yazi_macro::succ;
+use yazi_dds::{LOCAL, spark::{Spark, SparkKind}};
 use yazi_plugin::LUA;
-use yazi_shared::event::Data;
 
-use crate::{Actor, Ctx, lives::Lives};
+use crate::{Ctx, lives::Lives};
 
 pub struct Preflight<'a> {
 	_lifetime: PhantomData<&'a ()>,
 }
 
-impl<'a> Actor for Preflight<'a> {
-	type Options = (&'static str, Body<'a>);
-
-	const NAME: &'static str = "preflight";
-
-	fn act(cx: &mut Ctx, opt: Self::Options) -> Result<Data> {
+impl<'a> Preflight<'a> {
+	pub fn act(cx: &mut Ctx, opt: (SparkKind, Spark<'a>)) -> Result<Spark<'a>> {
 		let kind = opt.0;
-		let Some(handlers) = LOCAL.read().get(kind).filter(|&m| !m.is_empty()).cloned() else {
-			succ!(false)
+		let Some(handlers) = LOCAL.read().get(kind.as_ref()).filter(|&m| !m.is_empty()).cloned() else {
+			return Ok(opt.1);
 		};
 
-		succ!(Lives::scope(cx.core, || {
-			let body = opt.1.into_lua(&LUA)?;
+		Ok(Lives::scope(cx.core, || {
+			let mut body = opt.1.into_lua(&LUA)?;
 			for (id, cb) in handlers {
 				runtime_mut!(LUA)?.push(&id);
-				let result = cb.call::<Value>(body.clone());
+				let result = cb.call::<Value>(&body);
 				runtime_mut!(LUA)?.pop();
 
 				match result {
-					Ok(Value::Boolean(true)) => return Ok(true),
-					Ok(Value::Nil | Value::Boolean(false)) => {}
-					Ok(v) => {
-						error!("Unexpected return type from `{kind}` event handler in `{id}` plugin: {v:?}")
-					}
-					Err(e) => error!("Failed to run `{kind}` event handler in `{id}` plugin: {e}"),
-				}
+					Ok(Value::Nil) => Err(
+						format!("Cancelled by `{kind}` event handler in `{id}` plugin on preflight")
+							.into_lua_err(),
+					)?,
+					Ok(v) => body = v,
+					Err(e) => Err(
+						format!("Failed to run `{kind}` event handler in `{id}` plugin: {e}").into_lua_err(),
+					)?,
+				};
 			}
-			Ok(false)
+
+			Spark::from_lua(&LUA, kind, body)
+				.with_context(|e| format!("Unexpected return type from `{kind}` event handlers: {e}"))
 		})?)
 	}
 }

yazi-actor/src/core/preflight.rs

@@ -4,6 +4,7 @@ use anyhow::Result;
 use tokio::{select, time};
 use yazi_boot::ARGS;
 use yazi_config::popup::ConfirmCfg;
+use yazi_dds::spark::SparkKind;
 use yazi_macro::{emit, succ};
 use yazi_parser::mgr::{OpenOpt, QuitOpt};
 use yazi_proxy::ConfirmProxy;
@@ -60,8 +61,8 @@ impl Actor for Quit {
 		succ!();
 	}
 
-	fn hook(cx: &Ctx, _opt: &Self::Options) -> Option<&'static str> {
-		Some("key-quit").filter(|_| cx.source().is_key())
+	fn hook(cx: &Ctx, _opt: &Self::Options) -> Option<SparkKind> {
+		Some(SparkKind::KeyQuit).filter(|_| cx.source().is_key())
 	}
 }
 

yazi-actor/src/mgr/quit.rs

@@ -4,7 +4,7 @@ use yazi_shared::{IntoStringLossy, url::Url};
 use super::{Offset, Position};
 use crate::YAZI;
 
-#[derive(Default)]
+#[derive(Debug, Default)]
 pub struct InputCfg {
 	pub title:      String,
 	pub value:      String,
@@ -15,14 +15,14 @@ pub struct InputCfg {
 	pub completion: bool,
 }
 
-#[derive(Default)]
+#[derive(Debug, Default)]
 pub struct PickCfg {
 	pub title:    String,
 	pub items:    Vec<String>,
 	pub position: Position,
 }
 
-#[derive(Default)]
+#[derive(Debug, Default)]
 pub struct ConfirmCfg {
 	pub position: Position,
 	pub title:    Line<'static>,