From e58cf555dab1fda3e2d74c2f9f4054b69d20cc08 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: Wed, 16 Oct 2024 20:17:56 +0800
Subject: [PATCH] feat: add a compatibility layer for `ui.Paragraph` to help
 users transition more smoothly to the new `ui.Text` (#1794)

---
 yazi-plugin/src/elements/elements.rs  |  1 +
 yazi-plugin/src/elements/mod.rs       |  2 +-
 yazi-plugin/src/elements/paragraph.rs | 65 +++++++++++++++++++++++++++
 yazi-plugin/src/isolate/isolate.rs    |  1 +
 4 files changed, 68 insertions(+), 1 deletion(-)
 create mode 100644 yazi-plugin/src/elements/paragraph.rs

diff --git a/yazi-plugin/src/elements/elements.rs b/yazi-plugin/src/elements/elements.rs
index aa8c6be7..537cfed9 100644
--- a/yazi-plugin/src/elements/elements.rs
+++ b/yazi-plugin/src/elements/elements.rs
@@ -16,6 +16,7 @@ pub fn pour(lua: &Lua) -> mlua::Result<()> {
 	super::Line::install(lua, &ui)?;
 	super::List::install(lua, &ui)?;
 	super::Padding::install(lua, &ui)?;
+	super::Paragraph::install(lua, &ui)?;
 	super::Position::install(lua, &ui)?;
 	super::Rect::install(lua, &ui)?;
 	super::Span::install(lua, &ui)?;
diff --git a/yazi-plugin/src/elements/mod.rs b/yazi-plugin/src/elements/mod.rs
index 57ccc3bc..59439aa7 100644
--- a/yazi-plugin/src/elements/mod.rs
+++ b/yazi-plugin/src/elements/mod.rs
@@ -1,3 +1,3 @@
 #![allow(clippy::module_inception)]
 
-yazi_macro::mod_flat!(bar border clear constraint elements gauge layout line list padding position rect span style table text);
+yazi_macro::mod_flat!(bar border clear constraint elements gauge layout line list padding paragraph position rect span style table text);
diff --git a/yazi-plugin/src/elements/paragraph.rs b/yazi-plugin/src/elements/paragraph.rs
new file mode 100644
index 00000000..df5b6f7c
--- /dev/null
+++ b/yazi-plugin/src/elements/paragraph.rs
@@ -0,0 +1,65 @@
+use std::time::Duration;
+
+use mlua::{FromLua, Lua, MultiValue, Table, Value};
+
+use super::Rect;
+use crate::RtRef;
+
+static WARNED: std::sync::atomic::AtomicBool = std::sync::atomic::AtomicBool::new(false);
+
+#[inline]
+fn warn_deprecated(id: Option<&str>) {
+	if !WARNED.swap(true, std::sync::atomic::Ordering::Relaxed) {
+		let id = match id {
+			Some(id) => format!("`{id}.yazi` plugin"),
+			None => "`init.lua` config".to_owned(),
+		};
+		let s = "The `ui.Paragraph` and `ui.ListItem` elements have been deprecated in Yazi v0.4.
+
+Please use the new `ui.Text` instead, in your {id}. See https://github.com/sxyazi/yazi/pull/1776 for details.";
+		yazi_proxy::AppProxy::notify(yazi_proxy::options::NotifyOpt {
+			title:   "Deprecated API".to_owned(),
+			content: s.replace("{id}", &id),
+			level:   yazi_proxy::options::NotifyLevel::Warn,
+			timeout: Duration::from_secs(20),
+		});
+	}
+}
+
+// TODO: remove this after v0.4 release
+#[derive(Clone, Default, FromLua)]
+pub struct Paragraph;
+
+impl Paragraph {
+	pub fn install(lua: &Lua, ui: &Table) -> mlua::Result<()> {
+		let mt = lua.create_table_from([
+			(
+				"__call",
+				lua.create_function(|lua, (_, area, lines): (Table, Rect, Value)| {
+					warn_deprecated(lua.named_registry_value::<RtRef>("rt")?.current());
+					lua
+						.load(mlua::chunk! {
+							return ui.Text($lines):area($area)
+						})
+						.call::<_, MultiValue>(())
+				})?,
+			),
+			(
+				"__index",
+				lua.create_function(|lua, (_, key): (Table, mlua::String)| {
+					warn_deprecated(lua.named_registry_value::<RtRef>("rt")?.current());
+					lua
+						.load(mlua::chunk! {
+							return ui.Text[$key]
+						})
+						.call::<_, MultiValue>(())
+				})?,
+			),
+		])?;
+
+		let paragraph = lua.create_table()?;
+		paragraph.set_metatable(Some(mt));
+
+		ui.raw_set("Paragraph", paragraph)
+	}
+}
diff --git a/yazi-plugin/src/isolate/isolate.rs b/yazi-plugin/src/isolate/isolate.rs
index 7152de27..9bb9d24b 100644
--- a/yazi-plugin/src/isolate/isolate.rs
+++ b/yazi-plugin/src/isolate/isolate.rs
@@ -23,6 +23,7 @@ pub fn slim_lua(name: &str) -> mlua::Result<Lua> {
 	// Elements
 	let ui = lua.create_table()?;
 	elements::Line::install(&lua, &ui)?;
+	elements::Paragraph::install(&lua, &ui)?;
 	elements::Rect::install(&lua, &ui)?;
 	elements::Span::install(&lua, &ui)?;
 	elements::Text::install(&lua, &ui)?;