From 9cf85c09d2f0c2a9267ac7e50e7e4c8a02b5cd7a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E4=B8=89=E5=92=B2=E9=9B=85=20=C2=B7=20Misaki=20Masa?=
 <sxyazi@gmail.com>
Date: Sun, 25 Aug 2024 02:56:38 +0800
Subject: [PATCH] feat: make the builtin `code` previewer handle invalid
 carriage return chars and binary streams better (#1550)

---
 yazi-plugin/preset/components/entity.lua |  2 +-
 yazi-plugin/preset/plugins/code.lua      |  6 ++-
 yazi-plugin/preset/plugins/empty.lua     |  2 +-
 yazi-plugin/preset/plugins/json.lua      |  6 ++-
 yazi-plugin/src/elements/line.rs         |  2 +
 yazi-plugin/src/elements/paragraph.rs    | 17 ++++----
 yazi-plugin/src/elements/span.rs         | 50 +---------------------
 yazi-plugin/src/elements/style.rs        | 50 +---------------------
 yazi-plugin/src/external/highlighter.rs  |  8 ++++
 yazi-plugin/src/lib.rs                   |  1 +
 yazi-plugin/src/macros.rs                | 53 ++++++++++++++++++++++++
 yazi-plugin/src/utils/preview.rs         |  8 ++--
 yazi-shared/src/errors/peek.rs           |  4 +-
 13 files changed, 94 insertions(+), 115 deletions(-)
 create mode 100644 yazi-plugin/src/macros.rs

diff --git a/yazi-plugin/preset/components/entity.lua b/yazi-plugin/preset/components/entity.lua
index 2faada58..a0a6dfc6 100644
--- a/yazi-plugin/preset/components/entity.lua
+++ b/yazi-plugin/preset/components/entity.lua
@@ -70,7 +70,7 @@ function Entity:symlink()
 	end
 
 	local to = self._file.link_to
-	return ui.Line(to and { ui.Span(" -> " .. tostring(to)):italic() } or {})
+	return to and ui.Line(" -> " .. tostring(to)):italic() or ui.Line {}
 end
 
 function Entity:render()
diff --git a/yazi-plugin/preset/plugins/code.lua b/yazi-plugin/preset/plugins/code.lua
index f8c8e930..05e0b212 100644
--- a/yazi-plugin/preset/plugins/code.lua
+++ b/yazi-plugin/preset/plugins/code.lua
@@ -1,9 +1,13 @@
 local M = {}
 
 function M:peek()
-	local _, bound = ya.preview_code(self)
+	local err, bound = ya.preview_code(self)
 	if bound then
 		ya.manager_emit("peek", { bound, only_if = self.file.url, upper_bound = true })
+	elseif err then
+		ya.preview_widgets(self, {
+			ui.Paragraph(self.area, { ui.Line(err):reverse() }),
+		})
 	end
 end
 
diff --git a/yazi-plugin/preset/plugins/empty.lua b/yazi-plugin/preset/plugins/empty.lua
index 5d2e9b46..8b8946a4 100644
--- a/yazi-plugin/preset/plugins/empty.lua
+++ b/yazi-plugin/preset/plugins/empty.lua
@@ -2,7 +2,7 @@ local M = {}
 
 function M:msg(s)
 	local p = ui.Paragraph(self.area, {
-		ui.Line { ui.Span(s):reverse() },
+		ui.Line(s):reverse(),
 	})
 	ya.preview_widgets(self, { p:wrap(ui.Paragraph.WRAP) })
 end
diff --git a/yazi-plugin/preset/plugins/json.lua b/yazi-plugin/preset/plugins/json.lua
index bca3ebb5..32314c4d 100644
--- a/yazi-plugin/preset/plugins/json.lua
+++ b/yazi-plugin/preset/plugins/json.lua
@@ -53,9 +53,13 @@ function M:seek(units)
 end
 
 function M:fallback_to_builtin()
-	local _, bound = ya.preview_code(self)
+	local err, bound = ya.preview_code(self)
 	if bound then
 		ya.manager_emit("peek", { bound, only_if = self.file.url, upper_bound = true })
+	elseif err then
+		ya.preview_widgets(self, {
+			ui.Paragraph(self.area, { ui.Line(err):reverse() }),
+		})
 	end
 end
 
diff --git a/yazi-plugin/src/elements/line.rs b/yazi-plugin/src/elements/line.rs
index fcf74b24..16a76562 100644
--- a/yazi-plugin/src/elements/line.rs
+++ b/yazi-plugin/src/elements/line.rs
@@ -82,6 +82,8 @@ impl Line {
 
 impl UserData for Line {
 	fn add_methods<'lua, M: UserDataMethods<'lua, Self>>(methods: &mut M) {
+		crate::impl_style_shorthands!(methods, 0.style);
+
 		methods.add_function("width", |_, ud: AnyUserData| Ok(ud.borrow_mut::<Self>()?.0.width()));
 		methods.add_function("style", |_, (ud, value): (AnyUserData, Value)| {
 			{
diff --git a/yazi-plugin/src/elements/paragraph.rs b/yazi-plugin/src/elements/paragraph.rs
index 38070e2a..fc44d589 100644
--- a/yazi-plugin/src/elements/paragraph.rs
+++ b/yazi-plugin/src/elements/paragraph.rs
@@ -19,7 +19,7 @@ pub struct Paragraph {
 	pub area: ratatui::layout::Rect,
 
 	pub text:      ratatui::text::Text<'static>,
-	pub style:     Option<ratatui::style::Style>,
+	pub style:     ratatui::style::Style,
 	pub alignment: ratatui::layout::Alignment,
 	pub wrap:      u8,
 }
@@ -29,7 +29,7 @@ impl Paragraph {
 		let new = lua.create_function(|_, (_, area, lines): (Table, RectRef, Vec<Line>)| {
 			Ok(Paragraph {
 				area: *area,
-				text: lines.into_iter().map(|s| s.0).collect::<Vec<_>>().into(),
+				text: lines.into_iter().map(|s| s.0).collect(),
 				..Default::default()
 			})
 		})?;
@@ -58,13 +58,15 @@ impl Paragraph {
 
 impl UserData for Paragraph {
 	fn add_methods<'lua, M: mlua::UserDataMethods<'lua, Self>>(methods: &mut M) {
+		crate::impl_style_shorthands!(methods, style);
+
 		methods.add_function("style", |_, (ud, value): (AnyUserData, Value)| {
 			{
 				let mut me = ud.borrow_mut::<Self>()?;
 				match value {
-					Value::Nil => me.style = None,
-					Value::Table(tb) => me.style = Some(Style::try_from(tb)?.0),
-					Value::UserData(ud) => me.style = Some(ud.borrow::<Style>()?.0),
+					Value::Nil => me.style = ratatui::style::Style::default(),
+					Value::Table(tb) => me.style = Style::try_from(tb)?.0,
+					Value::UserData(ud) => me.style = ud.borrow::<Style>()?.0,
 					_ => return Err("expected a Style or Table or nil".into_lua_err()),
 				}
 			}
@@ -92,10 +94,7 @@ impl Renderable for Paragraph {
 	fn area(&self) -> ratatui::layout::Rect { self.area }
 
 	fn render(self: Box<Self>, buf: &mut ratatui::buffer::Buffer) {
-		let mut p = ratatui::widgets::Paragraph::new(self.text);
-		if let Some(style) = self.style {
-			p = p.style(style);
-		}
+		let mut p = ratatui::widgets::Paragraph::new(self.text).style(self.style);
 
 		if self.wrap != WRAP_NO {
 			p = p.wrap(ratatui::widgets::Wrap { trim: self.wrap == WRAP_TRIM });
diff --git a/yazi-plugin/src/elements/span.rs b/yazi-plugin/src/elements/span.rs
index 1fa7a8ff..9464d0ba 100644
--- a/yazi-plugin/src/elements/span.rs
+++ b/yazi-plugin/src/elements/span.rs
@@ -1,5 +1,4 @@
 use mlua::{AnyUserData, ExternalError, FromLua, Lua, Table, UserData, UserDataMethods, Value};
-use yazi_shared::theme::Color;
 
 use super::Style;
 
@@ -19,54 +18,7 @@ impl Span {
 
 impl UserData for Span {
 	fn add_methods<'lua, M: UserDataMethods<'lua, Self>>(methods: &mut M) {
-		methods.add_function("fg", |_, (ud, color): (AnyUserData, String)| {
-			ud.borrow_mut::<Self>()?.0.style.fg = Color::try_from(color).ok().map(Into::into);
-			Ok(ud)
-		});
-		methods.add_function("bg", |_, (ud, color): (AnyUserData, String)| {
-			ud.borrow_mut::<Self>()?.0.style.bg = Color::try_from(color).ok().map(Into::into);
-			Ok(ud)
-		});
-		methods.add_function("bold", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.style.add_modifier |= ratatui::style::Modifier::BOLD;
-			Ok(ud)
-		});
-		methods.add_function("dim", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.style.add_modifier |= ratatui::style::Modifier::DIM;
-			Ok(ud)
-		});
-		methods.add_function("italic", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.style.add_modifier |= ratatui::style::Modifier::ITALIC;
-			Ok(ud)
-		});
-		methods.add_function("underline", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.style.add_modifier |= ratatui::style::Modifier::UNDERLINED;
-			Ok(ud)
-		});
-		methods.add_function("blink", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.style.add_modifier |= ratatui::style::Modifier::SLOW_BLINK;
-			Ok(ud)
-		});
-		methods.add_function("blink_rapid", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.style.add_modifier |= ratatui::style::Modifier::RAPID_BLINK;
-			Ok(ud)
-		});
-		methods.add_function("reverse", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.style.add_modifier |= ratatui::style::Modifier::REVERSED;
-			Ok(ud)
-		});
-		methods.add_function("hidden", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.style.add_modifier |= ratatui::style::Modifier::HIDDEN;
-			Ok(ud)
-		});
-		methods.add_function("crossed", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.style.add_modifier |= ratatui::style::Modifier::CROSSED_OUT;
-			Ok(ud)
-		});
-		methods.add_function("reset", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.style.add_modifier = ratatui::style::Modifier::empty();
-			Ok(ud)
-		});
+		crate::impl_style_shorthands!(methods, 0.style);
 
 		methods.add_function("style", |_, (ud, value): (AnyUserData, Value)| {
 			ud.borrow_mut::<Self>()?.0.style = match value {
diff --git a/yazi-plugin/src/elements/style.rs b/yazi-plugin/src/elements/style.rs
index d58fef18..76370986 100644
--- a/yazi-plugin/src/elements/style.rs
+++ b/yazi-plugin/src/elements/style.rs
@@ -40,54 +40,8 @@ impl<'a> TryFrom<Table<'a>> for Style {
 
 impl UserData for Style {
 	fn add_methods<'lua, M: UserDataMethods<'lua, Self>>(methods: &mut M) {
-		methods.add_function("fg", |_, (ud, color): (AnyUserData, String)| {
-			ud.borrow_mut::<Self>()?.0.fg = Color::try_from(color).ok().map(Into::into);
-			Ok(ud)
-		});
-		methods.add_function("bg", |_, (ud, color): (AnyUserData, String)| {
-			ud.borrow_mut::<Self>()?.0.bg = Color::try_from(color).ok().map(Into::into);
-			Ok(ud)
-		});
-		methods.add_function("bold", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.add_modifier |= ratatui::style::Modifier::BOLD;
-			Ok(ud)
-		});
-		methods.add_function("dim", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.add_modifier |= ratatui::style::Modifier::DIM;
-			Ok(ud)
-		});
-		methods.add_function("italic", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.add_modifier |= ratatui::style::Modifier::ITALIC;
-			Ok(ud)
-		});
-		methods.add_function("underline", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.add_modifier |= ratatui::style::Modifier::UNDERLINED;
-			Ok(ud)
-		});
-		methods.add_function("blink", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.add_modifier |= ratatui::style::Modifier::SLOW_BLINK;
-			Ok(ud)
-		});
-		methods.add_function("blink_rapid", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.add_modifier |= ratatui::style::Modifier::RAPID_BLINK;
-			Ok(ud)
-		});
-		methods.add_function("reverse", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.add_modifier |= ratatui::style::Modifier::REVERSED;
-			Ok(ud)
-		});
-		methods.add_function("hidden", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.add_modifier |= ratatui::style::Modifier::HIDDEN;
-			Ok(ud)
-		});
-		methods.add_function("crossed", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.add_modifier |= ratatui::style::Modifier::CROSSED_OUT;
-			Ok(ud)
-		});
-		methods.add_function("reset", |_, ud: AnyUserData| {
-			ud.borrow_mut::<Self>()?.0.add_modifier = ratatui::style::Modifier::empty();
-			Ok(ud)
-		});
+		crate::impl_style_shorthands!(methods, 0);
+
 		methods.add_function("patch", |_, (ud, value): (AnyUserData, Value)| {
 			{
 				let mut me = ud.borrow_mut::<Self>()?;
diff --git a/yazi-plugin/src/external/highlighter.rs b/yazi-plugin/src/external/highlighter.rs
index f688b299..a00f1fd4 100644
--- a/yazi-plugin/src/external/highlighter.rs
+++ b/yazi-plugin/src/external/highlighter.rs
@@ -84,6 +84,14 @@ impl Highlighter {
 				buf.push(b'\n');
 			}
 
+			for b in &mut buf {
+				match *b {
+					b'\0' => return Err("Binary file".into()),
+					b'\r' => *b = b'\n', // '\r' occurs in the middle of a line
+					_ => {}
+				}
+			}
+
 			if i > skip {
 				after.push(String::from_utf8_lossy(&buf).into_owned());
 			} else if !plain {
diff --git a/yazi-plugin/src/lib.rs b/yazi-plugin/src/lib.rs
index ea2c42db..a0a722c7 100644
--- a/yazi-plugin/src/lib.rs
+++ b/yazi-plugin/src/lib.rs
@@ -12,6 +12,7 @@ pub mod fs;
 pub mod isolate;
 pub mod loader;
 mod lua;
+mod macros;
 mod opt;
 pub mod process;
 pub mod pubsub;
diff --git a/yazi-plugin/src/macros.rs b/yazi-plugin/src/macros.rs
new file mode 100644
index 00000000..94a751b7
--- /dev/null
+++ b/yazi-plugin/src/macros.rs
@@ -0,0 +1,53 @@
+#[macro_export]
+macro_rules! impl_style_shorthands {
+	($methods:ident, $($field:tt).+) => {
+		$methods.add_function("fg", |_, (ud, color): (AnyUserData, String)| {
+			ud.borrow_mut::<Self>()?.$($field).+.fg = yazi_shared::theme::Color::try_from(color).ok().map(Into::into);
+			Ok(ud)
+		});
+		$methods.add_function("bg", |_, (ud, color): (AnyUserData, String)| {
+			ud.borrow_mut::<Self>()?.$($field).+.bg = yazi_shared::theme::Color::try_from(color).ok().map(Into::into);
+			Ok(ud)
+		});
+		$methods.add_function("bold", |_, ud: AnyUserData| {
+			ud.borrow_mut::<Self>()?.$($field).+.add_modifier |= ratatui::style::Modifier::BOLD;
+			Ok(ud)
+		});
+		$methods.add_function("dim", |_, ud: AnyUserData| {
+			ud.borrow_mut::<Self>()?.$($field).+.add_modifier |= ratatui::style::Modifier::DIM;
+			Ok(ud)
+		});
+		$methods.add_function("italic", |_, ud: AnyUserData| {
+			ud.borrow_mut::<Self>()?.$($field).+.add_modifier |= ratatui::style::Modifier::ITALIC;
+			Ok(ud)
+		});
+		$methods.add_function("underline", |_, ud: AnyUserData| {
+			ud.borrow_mut::<Self>()?.$($field).+.add_modifier |= ratatui::style::Modifier::UNDERLINED;
+			Ok(ud)
+		});
+		$methods.add_function("blink", |_, ud: AnyUserData| {
+			ud.borrow_mut::<Self>()?.$($field).+.add_modifier |= ratatui::style::Modifier::SLOW_BLINK;
+			Ok(ud)
+		});
+		$methods.add_function("blink_rapid", |_, ud: AnyUserData| {
+			ud.borrow_mut::<Self>()?.$($field).+.add_modifier |= ratatui::style::Modifier::RAPID_BLINK;
+			Ok(ud)
+		});
+		$methods.add_function("reverse", |_, ud: AnyUserData| {
+			ud.borrow_mut::<Self>()?.$($field).+.add_modifier |= ratatui::style::Modifier::REVERSED;
+			Ok(ud)
+		});
+		$methods.add_function("hidden", |_, ud: AnyUserData| {
+			ud.borrow_mut::<Self>()?.$($field).+.add_modifier |= ratatui::style::Modifier::HIDDEN;
+			Ok(ud)
+		});
+		$methods.add_function("crossed", |_, ud: AnyUserData| {
+			ud.borrow_mut::<Self>()?.$($field).+.add_modifier |= ratatui::style::Modifier::CROSSED_OUT;
+			Ok(ud)
+		});
+		$methods.add_function("reset", |_, ud: AnyUserData| {
+			ud.borrow_mut::<Self>()?.$($field).+.add_modifier = ratatui::style::Modifier::empty();
+			Ok(ud)
+		});
+	};
+}
diff --git a/yazi-plugin/src/utils/preview.rs b/yazi-plugin/src/utils/preview.rs
index 7143e2aa..f81c8049 100644
--- a/yazi-plugin/src/utils/preview.rs
+++ b/yazi-plugin/src/utils/preview.rs
@@ -39,13 +39,15 @@ impl Utils {
 				let text =
 					match Highlighter::new(&lock.url).highlight(lock.skip, area.height as usize).await {
 						Ok(text) => text,
-						Err(PeekError::Exceed(max)) => return (false, max).into_lua_multi(lua),
-						Err(_) => return (false, Value::Nil).into_lua_multi(lua),
+						Err(e @ PeekError::Exceed(max)) => return (e.to_string(), max).into_lua_multi(lua),
+						Err(e @ PeekError::Unexpected(_)) => {
+							return (e.to_string(), Value::Nil).into_lua_multi(lua);
+						}
 					};
 				lock.data = vec![Box::new(Paragraph { area: *area, text, ..Default::default() })];
 
 				emit!(Call(Cmd::new("preview").with_any("lock", lock), Layer::Manager));
-				(true, Value::Nil).into_lua_multi(lua)
+				(Value::Nil, Value::Nil).into_lua_multi(lua)
 			})?,
 		)?;
 
diff --git a/yazi-shared/src/errors/peek.rs b/yazi-shared/src/errors/peek.rs
index 96f8c805..264f5954 100644
--- a/yazi-shared/src/errors/peek.rs
+++ b/yazi-shared/src/errors/peek.rs
@@ -9,8 +9,8 @@ pub enum PeekError {
 impl Display for PeekError {
 	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 		match self {
-			Self::Exceed(lines) => write!(f, "Exceed: {lines}"),
-			Self::Unexpected(msg) => write!(f, "Unexpected error: {msg}"),
+			Self::Exceed(lines) => write!(f, "Exceed maximum lines {lines}"),
+			Self::Unexpected(msg) => write!(f, "{msg}"),
 		}
 	}
 }