obsidian-remember-file-state: src/main.ts comparison

comparison src/main.ts @ 6:114d7e6d2633

Fix various issues around keeping references to editor objects - Don't keep references to view. Instead, generate unique view IDs and use that to find the correct uninstaller when needed. - Don't keep a reference to the plugin itself in registered callbacks on views because that could keep the plugin alive after it has been unloaded.

author	Ludovic Chabant <ludovic@chabant.com>
date	Mon, 14 Feb 2022 12:35:45 -0800
parents	f3297d90329d
children	b1cb0474bb18

comparison

equal deleted inserted replaced

-:e8300db708b6
+:114d7e6d2633
 export default class RememberFileStatePlugin extends Plugin {
 	settings: RememberFileStatePluginSettings;
 	data: RememberFileStatePluginData;
+	// Don't restore state on the next file being opened.
 	private _suppressNextFileOpen: boolean = false;
+	// Next unique ID to identify views without keeping references to them.
+	private _nextUniqueViewId: number = 0;
+	// Functions to unregister any monkey-patched view hooks on plugin unload.
 	private _viewUninstallers = {};
+	// Functions to unregister any global callbacks on plugin unload.
 	private _globalUninstallers = [];
 	async onload() {
 		console.log("Loading RememberFileState plugin");
 		this.addSettingTab(new RememberFileStatePluginSettingTab(this.app, this));
 	}
 	onunload() {
-		var uninstallers = Object.values(this._viewUninstallers);
+		// Run view uninstallers on all current views.
-		console.debug(`Unregistering ${uninstallers.length} view callbacks`);
+		var numViews: number = 0;
-		uninstallers.forEach((cb) => cb());
+		this.app.workspace.getLeavesOfType("markdown").forEach(
+			(leaf) => {
+				const filePath = leaf.view.file.path;
+				const viewId = this.getUniqueViewId(leaf.view);
+				if (viewId != undefined) {
+					var uninstaller = this._viewUninstallers[viewId];
+					if (uninstaller) {
+						console.debug(`Uninstalling hooks for view ${viewId}`, filePath);
+						uninstaller(leaf.view);
+						++numViews;
+					} else {
+						console.debug("Found markdown view without an uninstaller!", filePath);
+					}
+					// Clear the ID so we don't get confused if the plugin
+					// is re-enabled later.
+					this.clearUniqueViewId(leaf.view);
+				} else {
+					console.debug("Found markdown view without an ID!", filePath);
+				}
+			});
+		console.debug(`Unregistered ${numViews} view callbacks`);
 		this._viewUninstallers = {};
+		// Run global unhooks.
 		this._globalUninstallers.forEach((cb) => cb());
 	}
 	async loadSettings() {
 		this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
 	async saveSettings() {
 		await this.saveData(this.settings);
 	}
 	private readonly registerOnUnloadFile = function(view) {
-		if (view in this._viewUninstallers) {
+		var filePath = view.file.path;
+		var viewId = this.getUniqueViewId(view, true);
+		if (viewId in this._viewUninstallers) {
+			console.debug(`View ${viewId} is already registered`, filePath);
 			return;
 		}
-		console.debug("Registering view callback");
+		console.debug(`Registering callback on view ${viewId}`, filePath);
 		const _this = this;
 		var uninstall = around(view, {
 			onUnloadFile: function(next) {
 				return async function (unloaded: TFile) {
 					_this.rememberFileState(unloaded, view);
 					return await next.call(this, unloaded);
 				};
 			}
 		});
-		this._viewUninstallers[view] = uninstall;
+		this._viewUninstallers[viewId] = uninstall;
 		view.register(() => {
-			console.debug("Unregistering view callback");
+			// Don't hold a reference to this plugin here because this callback
-			delete this._viewUninstallers[view];
+			// will outlive it if it gets deactivated. So let's find it, and
-			uninstall();
+			// do nothing if we don't find it.
+			var plugin = app.plugins.getPlugin("remember-file-state");
+			if (plugin) {
+				console.debug(`Unregistering view ${viewId} callback`, filePath);
+				delete plugin._viewUninstallers[viewId];
+				uninstall();
+			} else {
+				console.debug(
+					"Plugin remember-file-state has been unloaded, ignoring unregister");
+			}
 		});
 	}
 	private readonly onFileOpen = async (
 		openedFile: TFile
 			this.forgetExcessFiles();
 		}
 		console.debug("Remember file state for:", file.path);
 	}
-	private restoreFileState(file: TFile, view: View) {
+	private readonly restoreFileState = function(file: TFile, view: View) {
 		const existingFile = this.data.rememberedFiles.find(
 			(curFile) => curFile.path === file.path
 		);
 		if (existingFile) {
 			console.debug("Restoring file state for:", file.path);
 				selection: EditorSelection.fromJSON(stateData.selection)})
 			view.editor.cm.dispatch(transaction);
 		}
 	}
-	private forgetExcessFiles() {
+	private readonly forgetExcessFiles = function() {
 		const keepMax = this.settings.rememberMaxFiles;
 		if (keepMax <= 0) {
 			return;
 		}
 		this.data.rememberedFiles.sort((a, b) => a.lastSavedTime < b.lastSavedTime);
 		if (this.data.rememberedFiles.length > keepMax) {
 			this.data.rememberedFiles.splice(keepMax);
 		}
+	}
+	private readonly getUniqueViewId = function(view: View, autocreateId: boolean = false) {
+		if (view.__uniqueId == undefined) {
+			if (!autocreateId) {
+				return -1;
+			}
+			view.__uniqueId = (this._nextUniqueViewId++);
+			return view.__uniqueId;
+		}
+		return view.__uniqueId;
+	}
+	private readonly clearUniqueViewId = function(view: View) {
+		delete view["__uniqueId"];
 	}
 	private readonly onFileRename = async (
 		file: TAbstractFile,
 		oldPath: string,

Mercurial > obsidian-remember-file-state

comparison src/main.ts @ 6:114d7e6d2633