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

comparison src/main.ts @ 40:96e86650043b

Fix issues with files opened in multiple panes. The previous code was problematic since it opened files at the top for no obvious reason. Now we always restore any saved state if we have it, and if not we restore the current state from another pane if we find the same file is already open.

author	Ludovic Chabant <ludovic@chabant.com>
date	Wed, 20 Sep 2023 17:18:47 -0700
parents	8be02002ed66
children	aa9bc7754c5d

comparison

equal deleted inserted replaced

-:fdc14798c221
+:96e86650043b
 	private readonly onFileOpen = async (
 		openedFile: TFile
 	): Promise<void> => {
 		// If `openedFile` is null, it's because the last pane was closed
 		// and there is now an empty pane.
-		if (openedFile) {
+		if (!openedFile) {
-			var activeView: MarkdownView = this.app.workspace.getActiveViewOfType(MarkdownView);
+			return;
-			if (activeView) {
+		}
-				this.registerOnUnloadFile(activeView);
+		var shouldSuppressThis: bool = this._suppressNextFileOpen;
-				var isRealFileOpen = true;
+		this._suppressNextFileOpen = false;
-				const viewId = this.getUniqueViewId(activeView as unknown as ViewWithID);
+		if (shouldSuppressThis) {
-				if (viewId != undefined) {
+			console.debug("RememberFileState: not restoring file state because of explicit suppression");
-					const lastOpenFileInView = this._lastOpenFiles[viewId];
+			return;
-					isRealFileOpen = (lastOpenFileInView != openedFile.path);
+		}
-					this._lastOpenFiles[viewId] = openedFile.path;
-				}
+		// Check that the file is handled by a markdown editor, which is the
+		// only editor we support for now.
-				// Don't restore the file state if:
+		var activeView: MarkdownView = this.app.workspace.getActiveViewOfType(MarkdownView);
-				// - We are suppressing it explicitly (such as if the file was
+		if (!activeView) {
-				//     opened via clicking a hyperlink)
+			console.debug("RememberFileState: not restoring file state, it's not a markdown view");
-				// - The file is already currently open in another pane
+			return;
-				// - The file was already opened in this pane, and we're just
+		}
-				//     returning to it.
-				if (!this._suppressNextFileOpen &&
+		this.registerOnUnloadFile(activeView);
-					!this.isFileMultiplyOpen(openedFile) &&
-				    isRealFileOpen
+		// Check if this is a genuine file open, and not returning to pane that
-				   ) {
+		// already had this file opened in it.
-					try {
+		var isRealFileOpen = true;
-						this.restoreFileState(openedFile, activeView);
+		const viewId = this.getUniqueViewId(activeView as unknown as ViewWithID);
-					} catch (err) {
+		if (viewId != undefined) {
-						console.error("RememberedFileState: couldn't restore file state: ", err);
+			const lastOpenFileInView = this._lastOpenFiles[viewId];
-					}
+			isRealFileOpen = (lastOpenFileInView != openedFile.path);
-				}
+			this._lastOpenFiles[viewId] = openedFile.path;
-				else {
+		}
-					console.debug("RememberedFileState: not restoring file state because:");
+		if (!isRealFileOpen) {
-					if (this._suppressNextFileOpen) {
+			console.debug("RememberFileState: not restoring file state, that file was already open in this pane.");
-						console.debug("...we were told to not do it.");
+			return;
-					} else if (this.isFileMultiplyOpen(openedFile)) {
+		}
-						console.debug("...it's open in multiple panes.");
-					} else if (!isRealFileOpen) {
+		// Restore the state!
-						console.debug("...that file was already open in this pane.");
+		try {
-					} else {
+			const existingFile = this.data.rememberedFiles[openedFile.path];
-						console.debug("...unknown reason.");
+			if (existingFile) {
-					}
+				const savedStateData = existingFile.stateData;
+				console.debug("RememberFileState: restoring saved state for:", openedFile.path, savedStateData);
+				this.restoreState(savedStateData, activeView);
+			} else {
+				// If we don't have any saved state for this file, let's see if
+				// it's opened in another pane. If so, restore that.
+				const otherPaneState = this.findFileStateFromOtherPane(openedFile, activeView);
+				if (otherPaneState) {
+					console.debug("RememberFileState: restoring other pane state for:", openedFile.path, otherPaneState);
+					this.restoreState(otherPaneState, activeView);
 				}
 			}
-			// else: the file isn't handled by a markdown editor.
+		} catch (err) {
-			else {
+			console.error("RememberFileState: couldn't restore file state: ", err);
-				console.debug("RememberedFileState: not restoring anything, it's not a markdown view");
-			}
-			this._suppressNextFileOpen = false;
 		}
 	}
 	private readonly rememberFileState = async (file: TFile, view: MarkdownView): Promise<void> => {
-		// Save scrolling position (Obsidian API only gives vertical position).
+		const stateData = this.getState(view);
-		const scrollInfo = {top: view.currentMode.getScroll(), left: 0};
-		// Save current selection.
-		// If state selection is undefined, we have a legacy editor. Just ignore that part.
-		const cm6editor = view.editor as EditorWithCM6;
-		const stateSelection: EditorSelection = cm6editor.cm.state.selection;
-		const stateSelectionJSON = (stateSelection !== undefined) ? stateSelection.toJSON() : "";
-		const stateData = {'scrollInfo': scrollInfo, 'selection': stateSelectionJSON};
 		var existingFile = this.data.rememberedFiles[file.path];
 		if (existingFile) {
 			existingFile.lastSavedTime = Date.now();
 			existingFile.stateData = stateData;
 		} else {
 			this.forgetExcessFiles();
 		}
 		console.debug("RememberedFileState: remembered state for:", file.path, stateData);
 	}
-	private readonly restoreFileState = function(file: TFile, view: MarkdownView) {
+	private readonly getState = function(view: MarkdownView) {
-		const existingFile = this.data.rememberedFiles[file.path];
+		// Save scrolling position (Obsidian API only gives vertical position).
-		if (existingFile) {
+		const scrollInfo = {top: view.currentMode.getScroll(), left: 0};
-			console.debug("RememberedFileState: restoring state for:", file.path, existingFile.stateData);
-			const stateData = existingFile.stateData;
+		// Save current selection.
+		// If state selection is undefined, we have a legacy editor. Just ignore that part.
-			// Restore scrolling position (Obsidian API only allows setting vertical position).
+		const cm6editor = view.editor as EditorWithCM6;
-			view.currentMode.applyScroll(stateData.scrollInfo.top);
+		const stateSelection: EditorSelection = cm6editor.cm.state.selection;
+		const stateSelectionJSON = (stateSelection !== undefined) ? stateSelection.toJSON() : "";
-			// Restore last known selection, if any.
-			if (stateData.selection != "") {
+		const stateData = {'scrollInfo': scrollInfo, 'selection': stateSelectionJSON};
-				const cm6editor = view.editor as EditorWithCM6;
-				var transaction = cm6editor.cm.state.update({
+		return stateData;
-					selection: EditorSelection.fromJSON(stateData.selection)})
+	}
-				cm6editor.cm.dispatch(transaction);
+	private readonly restoreState = function(stateData: StateData, view: MarkdownView) {
-			}
+		// Restore scrolling position (Obsidian API only allows setting vertical position).
+		view.currentMode.applyScroll(stateData.scrollInfo.top);
+		// Restore last known selection, if any.
+		if (stateData.selection != "") {
+			const cm6editor = view.editor as EditorWithCM6;
+			var transaction = cm6editor.cm.state.update({
+				selection: EditorSelection.fromJSON(stateData.selection)})
+			cm6editor.cm.dispatch(transaction);
 		}
 	}
-	private readonly isFileMultiplyOpen = function(file: TFile) {
+	private readonly findFileStateFromOtherPane = function(file: TFile, activeView: MarkdownView) {
-		var numFound: number = 0;
+		var otherView = null;
-		this.app.workspace.getLeavesOfType("markdown").forEach(
+		this.app.workspace.getLeavesOfType("markdown").every(
 			(leaf: WorkspaceLeaf) => {
-				const filePath = (leaf.view as MarkdownView).file.path;
+				var curView = leaf.view as MarkdownView;
-				if (filePath == file.path) {
+				if (curView != activeView &&
-					++numFound;
+					curView.file.path == file.path &&
+					this.getUniqueViewId(curView) >= 0  // Skip views that have never been activated.
+				   ) {
+					console.debug(`FFFFOOOOOUNNNNDD!!!!! ${file.path}`, curView, activeView);
+					otherView = curView;
+					return false; // Stop iterating leaves.
 				}
-			});
+				return true;
-		return numFound >= 2;
+			},
+			this // thisArg
+		);
+		return otherView ? this.getState(otherView) : null;
 	}
 	private readonly forgetExcessFiles = function() {
 		const keepMax = this.settings.rememberMaxFiles;
 		if (keepMax <= 0) {

Mercurial > obsidian-remember-file-state

comparison src/main.ts @ 40:96e86650043b