Add and use EntryListModel, much better than DirectoryList

Author: heliguy4599

src/gtk/entry_list.ts

@@ -5,6 +5,7 @@ import Gio from "gi://Gio?version=2.0"
 import { GObjectify } from "../utils/gobjectify.js"
 import { Entry } from "../utils/entry.js"
 import { EntryRow } from "./entry_row.js"
+import type { EntryListModel } from "../utils/entry_list_model.js"
 
 export namespace EntryList {
 	export interface ConstructorProps extends Partial<Adw.Bin.ConstructorProps> {
@@ -31,7 +32,7 @@ export class EntryList extends Adw.Bin {
 	public accessor loading!: boolean
 
 	@GObjectify.Property(Gio.ListModel, { flags: "CONSTRUCT_ONLY" })
-	public accessor entry_list_model!: Gio.ListModel<Entry>
+	public accessor entry_list_model!: EntryListModel
 
 	public constructor(params: EntryList.ConstructorProps) {
 		super(params)

src/pages/entries_page.blp

@@ -1,37 +1,25 @@
 using Gtk 4.0;
 using Adw 1;
 
-CustomFilter only_entries_filter {}
-
 CustomSorter entry_sorter {}
 
 SortListModel top_home_model {
 	sorter: entry_sorter;
 	items-changed => $_mark_overrides();
+	items-changed => $_start_loading();
 
-	model: FilterListModel {
-		filter: only_entries_filter;
-
-		model: MapListModel home_map_model {
-			model: DirectoryList {
-				file: bind template.home_autostart_dir;
-			};
-		};
+	model: $EntryListModel {
+		file: bind template.home_autostart_dir;
 	};
 }
 
 SortListModel top_root_model {
 	sorter: entry_sorter;
 	items-changed => $_mark_overrides();
+	items-changed => $_start_loading();
 
-	model: FilterListModel {
-		filter: only_entries_filter;
-
-		model: MapListModel root_map_model {
-			model: DirectoryList {
-				file: bind template.root_autostart_dir;
-			};
-		};
+	model: $EntryListModel {
+		file: bind template.root_autostart_dir;
 	};
 }
 
@@ -41,6 +29,7 @@ template $EntriesPage: Adw.NavigationPage {
 	child: $LoadingGroup {
 		title: _("Loading Entries");
 		description: _("This should only take a moment.");
+		loading: bind template.is_loading;
 
 		content: Adw.ToolbarView {
 			[top]

src/pages/entries_page.ts

@@ -2,27 +2,18 @@ import Adw from "gi://Adw?version=1"
 import Gio from "gi://Gio?version=2.0"
 import Gtk from "gi://Gtk?version=4.0"
 
+import { Entry } from "../utils/entry.js"
 import { GObjectify } from "../utils/gobjectify.js"
 import { SharedVars } from "../utils/shared_vars.js"
-import { Entry } from "../utils/entry.js"
-import { try_catch } from "../utils/safe.js"
-import { chunked_idler } from "../utils/async.js"
 import { make_iterable } from "../utils/list_model_utils.js"
+import { chunked_idler } from "../utils/async.js"
+import "../utils/entry_list_model.js"
 import "../gtk/loading_group.js"
 import "../gtk/search_group.js"
 import "../gtk/entry_list.js"
 
 @GObjectify.Class({ template: "/io/github/flattool/Ignition/pages/entries_page" })
 export class EntriesPage extends Adw.NavigationPage {
-	@GObjectify.Child
-	public accessor only_entries_filter!: Gtk.CustomFilter
-
-	@GObjectify.Child
-	public accessor home_map_model!: Gtk.MapListModel<Entry>
-
-	@GObjectify.Child
-	public accessor root_map_model!: Gtk.MapListModel<Entry>
-
 	@GObjectify.Child
 	public accessor top_home_model!: Gio.ListModel<Entry>
 
@@ -38,25 +29,19 @@ export class EntriesPage extends Adw.NavigationPage {
 	@GObjectify.Property(Gio.File)
 	public accessor root_autostart_dir: Gio.File
 
+	@GObjectify.Property("bool", { default: true })
+	public accessor is_loading!: boolean
+
 	public constructor(params: Partial<Adw.NavigationPage.ConstructorProps>) {
 		super(params)
 		this.home_autostart_dir = SharedVars.home_autostart_dir
 		this.root_autostart_dir = SharedVars.root_autostart_dir
 
-		this.only_entries_filter.set_filter_func((item) => item instanceof Entry)
-		const map_func = (item: Gio.FileInfo): Entry | null => try_catch(
-			() => new Entry({ file: (item as Gio.FileInfo).get_attribute_object("standard::file") }),
-			() => null,
-		)
-		this.home_map_model.set_map_func((item) => map_func(item as Gio.FileInfo) ?? item)
-		this.root_map_model.set_map_func((item) => map_func(item as Gio.FileInfo) ?? item)
 		this.entry_sorter.set_sort_func((one: Entry, two: Entry): number => {
 			const one_first = -1
 			const one_last = 1
 
-			if (one.enabled !== two.enabled) {
-				return one.enabled ? one_first : one_last
-			}
+			if (one.enabled !== two.enabled) return one.enabled ? one_first : one_last
 			if (one.override_state !== two.override_state) {
 				if (one.override_state === "overridden") return one_last
 				if (two.override_state === "overridden") return one_first
@@ -65,6 +50,9 @@ export class EntriesPage extends Adw.NavigationPage {
 		})
 	}
 
+	@GObjectify.Debounce(200, { trigger: "leading" })
+	protected async _start_loading(): Promise<void> { this.is_loading = true }
+
 	@GObjectify.Debounce(200)
 	protected async _mark_overrides(): Promise<void> {
 		let something_changed = false
@@ -92,5 +80,6 @@ export class EntriesPage extends Adw.NavigationPage {
 		}
 
 		if (something_changed) this.entry_sorter.changed(Gtk.SorterChange.DIFFERENT)
+		this.is_loading = false
 	}
 }

src/utils/entry_list_model.ts

@@ -0,0 +1,98 @@
+import GObject from "gi://GObject?version=2.0"
+import Gio from "gi://Gio?version=2.0"
+
+import { GObjectify } from "./gobjectify.js"
+import { Entry } from "./entry.js"
+import { chunked_idler } from "./async.js"
+
+@GObjectify.Class({ implements: [Gio.ListModel], manual_gtype_name: "EntryListModel" })
+class EntryListInternal extends GObject.Object {
+	@GObjectify.Property(Gio.File, { effect(file) { this.on_file_set(file) } })
+	public accessor file!: Gio.File | null
+
+	private monitor: Gio.FileMonitor | null = null
+	private change_connect_id: number | null = null
+	private list = new Array<Entry>()
+
+	// Satisfy Gio.ListModel interface
+	public vfunc_get_item(position: number): Entry | null {
+		return this.list[position] ?? null
+	}
+
+	public vfunc_get_item_type(): GObject.GType {
+		return Entry.$gtype
+	}
+
+	public vfunc_get_n_items(): number {
+		return this.list.length
+	}
+	//
+
+	public [Symbol.iterator](): ArrayIterator<Entry> {
+		return this.list[Symbol.iterator]()
+	}
+
+	private cleanup(): void {
+		if (this.change_connect_id !== null) {
+			this.disconnect(this.change_connect_id)
+			this.change_connect_id = null
+		}
+		this.monitor?.cancel()
+		this.monitor = null
+	}
+
+	private on_file_set(file: Gio.File | null): void {
+		if (!file) {
+			this.cleanup()
+			return
+		} else if (file.query_file_type(null, null) !== Gio.FileType.DIRECTORY) {
+			this.cleanup()
+			throw new Error("EntryListInternal, file: Cannot set a file that is not a directory")
+		}
+		this.monitor?.cancel()
+		this.monitor = file.monitor_directory(Gio.FileMonitorFlags.NONE, null)
+		this.change_connect_id = this.monitor.connect("changed", () => this.changed().catch(log))
+		this.changed()
+	}
+
+	@GObjectify.Debounce(200)
+	private async changed(): Promise<void> {
+		const old_length = this.list.length
+		const dir = this.file
+		if (!dir) {
+			this.list = []
+			if (old_length > 0) $(this).items_changed(0, old_length, 0)
+			return
+		}
+
+		const idler = chunked_idler(100)
+		const enumerator = dir.enumerate_children("standard::*", Gio.FileQueryInfoFlags.NONE, null)
+		const new_list = new Array<Entry>()
+
+		try {
+			let info: Gio.FileInfo | null
+			while ((info = enumerator.next_file(null)) !== null) {
+				await idler()
+				try {
+					new_list.push(new Entry({ file: dir.get_child(info.get_name()) }))
+				} catch {}
+			}
+		} finally {
+			enumerator.close(null)
+		}
+
+		const new_length = new_list.length
+		this.list = new_list
+		$(this).items_changed(0, old_length, new_length)
+	}
+}
+
+function $(item: EntryListInternal): Gio.ListModel<Entry> {
+	return item as unknown as Gio.ListModel<Entry>
+}
+
+export const EntryListModel = EntryListInternal as unknown as new(
+	...args: ConstructorParameters<typeof EntryListInternal>
+)=> EntryListInternal & Gio.ListModel<Entry>
+
+export type EntryListModel = EntryListInternal & Gio.ListModel<Entry>