feat: custom sorting (#4363)

Author: sxyazi

CHANGELOG.md

@@ -14,6 +14,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/):
 
 ### Added
 
+- Custom sorting ([#4363])
 - Dynamic virtual filesystem Lua API ([#4338])
 
 ### Changed
@@ -1882,3 +1883,4 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/):
 [#4346]: https://github.com/sxyazi/yazi/pull/4346
 [#4352]: https://github.com/sxyazi/yazi/pull/4352
 [#4359]: https://github.com/sxyazi/yazi/pull/4359
+[#4363]: https://github.com/sxyazi/yazi/pull/4363

CLAUDE.md

@@ -93,7 +93,7 @@ impl UpdateFiles {
 	}
 
 	fn update_current(cx: &mut Ctx, op: FilesOp) -> Result<Data> {
-		let calc = !matches!(op, FilesOp::Size(..) | FilesOp::Deleting(..));
+		let calc = !matches!(op, FilesOp::Size(..) | FilesOp::Rank(..) | FilesOp::Deleting(..));
 
 		let id = cx.tab().id;
 		if !cx.current_mut().update_pub(id, op) {

yazi-actor/src/mgr/update_files.rs

@@ -86,6 +86,7 @@ impl Folder {
 			FilesOp::Part(_, files, ticket) => self.entries.update_part(files, ticket),
 			FilesOp::Done(..) => {}
 			FilesOp::Size(_, sizes) => self.entries.update_size(sizes),
+			FilesOp::Rank(_, ranks) => self.entries.update_rank(ranks),
 			FilesOp::IOErr(..) => self.entries.update_ioerr(),
 
 			FilesOp::Creating(_, files) => self.entries.update_creating(files),
@@ -102,11 +103,13 @@ impl Folder {
 	}
 
 	pub fn update_pub(&mut self, tab: Id, op: FilesOp) -> bool {
-		if self.update(op) {
+		let load = !matches!(op, FilesOp::Rank(..));
+		if !self.update(op) {
+			return false;
+		} else if load {
 			log_if_err!(Pubsub::pub_after_load(tab, &self.url, &self.stage));
-			return true;
 		}
-		false
+		true
 	}
 
 	pub fn arrow(&mut self, step: impl Into<Step>) -> bool {

yazi-core/src/tab/folder.rs

@@ -15,6 +15,7 @@ pub struct Entries {
 	pub revision: u64,
 
 	pub sizes: HashMap<PathBufDyn, u64>,
+	pub ranks: HashMap<PathBufDyn, i64>,
 
 	sorter:      FilesSorter,
 	filter:      Option<Filter>,
@@ -84,6 +85,31 @@ impl Entries {
 		}
 	}
 
+	pub fn update_rank(&mut self, mut ranks: HashMap<PathBufDyn, i64>) {
+		let mut changed = false;
+
+		if self.ranks.is_empty() {
+			ranks.retain(|key, rank| *rank != 0 && !key.is_empty());
+			(changed, self.ranks) = (!ranks.is_empty(), mem::take(&mut ranks));
+		}
+
+		for (key, rank) in ranks {
+			if key.is_empty() {
+				continue;
+			}
+
+			changed |= if rank == 0 {
+				self.ranks.remove(&key).is_some()
+			} else {
+				self.ranks.insert(key, rank) != Some(rank)
+			};
+		}
+
+		if changed && self.sorter.by == SortBy::Custom {
+			self.revision += 1;
+		}
+	}
+
 	pub fn update_ioerr(&mut self) {
 		self.ticket = FILES_TICKET.next();
 		self.hidden.clear();
@@ -219,7 +245,7 @@ impl Entries {
 		}
 
 		self.version = self.revision;
-		self.sorter.sort(&mut self.items, &self.sizes);
+		self.sorter.sort(&mut self.items, &self.sizes, &self.ranks);
 		true
 	}
 
@@ -277,14 +303,14 @@ impl Entries {
 			self.hidden = hidden;
 			if !items.is_empty() {
 				self.items.extend(items);
-				self.sorter.sort(&mut self.items, &self.sizes);
+				self.sorter.sort(&mut self.items, &self.sizes, &self.ranks);
 			}
 			return true;
 		}
 
 		let it = mem::take(&mut self.items).into_iter().chain(mem::take(&mut self.hidden));
 		(self.hidden, self.items) = self.split_files(it);
-		self.sorter.sort(&mut self.items, &self.sizes);
+		self.sorter.sort(&mut self.items, &self.sizes, &self.ranks);
 		true
 	}
 

yazi-fs/src/entries.rs

@@ -16,6 +16,7 @@ pub enum FilesOp {
 	Part(UrlBuf, Vec<File>, Id),
 	Done(File, Id),
 	Size(UrlBuf, HashMap<PathBufDyn, u64>),
+	Rank(UrlBuf, HashMap<PathBufDyn, i64>),
 	IOErr(UrlBuf, yazi_shim::fs::Error),
 
 	Creating(UrlBuf, Vec<File>),
@@ -33,6 +34,7 @@ impl FilesOp {
 			Self::Part(u, ..) => u,
 			Self::Done(f, ..) => &f.url,
 			Self::Size(u, _) => u,
+			Self::Rank(u, _) => u,
 			Self::IOErr(u, _) => u,
 
 			Self::Creating(u, _) => u,
@@ -124,7 +126,8 @@ impl FilesOp {
 			Self::Full(file, files) => Self::Full(file.chdir(wd), files!(files)),
 			Self::Part(_, files, ticket) => Self::Part(w, files!(files), *ticket),
 			Self::Done(file, ticket) => Self::Done(file.chdir(wd), *ticket),
-			Self::Size(_, map) => Self::Size(w, map.iter().map(|(key, &s)| (key.clone(), s)).collect()),
+			Self::Size(_, map) => Self::Size(w, map.clone()),
+			Self::Rank(_, map) => Self::Rank(w, map.clone()),
 			Self::IOErr(_, err) => Self::IOErr(w, err.clone()),
 
 			Self::Creating(_, files) => Self::Creating(w, files!(files)),

yazi-fs/src/op.rs

@@ -17,7 +17,12 @@ pub struct FilesSorter {
 }
 
 impl FilesSorter {
-	pub(super) fn sort(&self, items: &mut [File], sizes: &HashMap<PathBufDyn, u64>) {
+	pub(super) fn sort(
+		&self,
+		items: &mut [File],
+		sizes: &HashMap<PathBufDyn, u64>,
+		ranks: &HashMap<PathBufDyn, i64>,
+	) {
 		if items.is_empty() {
 			return;
 		}
@@ -78,6 +83,12 @@ impl FilesSorter {
 					self.cmp(rng.next_u64(), rng.next_u64())
 				})
 			}
+			SortBy::Custom => items.sort_unstable_by(|a, b| {
+				promote!(a, b);
+				let aa = ranks.get(&a.key()).copied().unwrap_or_default();
+				let bb = ranks.get(&b.key()).copied().unwrap_or_default();
+				self.fallback(a, b, self.cmp(aa, bb))
+			}),
 		}
 	}
 

yazi-fs/src/sorter.rs

@@ -17,6 +17,7 @@ pub enum SortBy {
 	Natural,
 	Size,
 	Random,
+	Custom,
 }
 
 // --- fallback

yazi-fs/src/sorting.rs

@@ -9,6 +9,7 @@ pub enum FolderStage {
 	Loaded,
 	Failed(yazi_shim::fs::Error),
 }
+
 impl UserData for FolderStage {
 	fn add_methods<M: UserDataMethods<Self>>(methods: &mut M) {
 		methods.add_meta_method(MetaMethod::Call, |lua, me, ()| {

yazi-fs/src/stage.rs

@@ -146,6 +146,7 @@ fn op(lua: &Lua) -> mlua::Result<Function> {
 		b"part" => super::FilesOp::part(lua, t),
 		b"done" => super::FilesOp::done(lua, t),
 		b"size" => super::FilesOp::size(lua, t),
+		b"rank" => super::FilesOp::rank(lua, t),
 		b"upsert" => super::FilesOp::upsert(lua, t),
 		_ => Err("Unknown operation".into_lua_err())?,
 	})