Merge pull request microsoft#186148 from microsoft/hediet/b/zoophagous-raven

Preserves collapsed range states

Author: hediet

src/vs/editor/browser/widget/diffEditorWidget.ts

@@ -1031,7 +1031,7 @@ export class DiffEditorWidget extends Disposable implements editorBrowser.IDiffE
 		const modifiedViewState = this._modifiedEditor.saveViewState();
 		return {
 			original: originalViewState,
-			modified: modifiedViewState
+			modified: modifiedViewState,
 		};
 	}
 

src/vs/editor/browser/widget/diffEditorWidget2/diffEditorDecorations.ts

@@ -6,8 +6,8 @@
 import { Disposable } from 'vs/base/common/lifecycle';
 import { IObservable, derived } from 'vs/base/common/observable';
 import { isDefined } from 'vs/base/common/types';
-import { CodeEditorWidget } from 'vs/editor/browser/widget/codeEditorWidget';
 import { arrowRevertChange, diffAddDecoration, diffAddDecorationEmpty, diffDeleteDecoration, diffDeleteDecorationEmpty, diffLineAddDecorationBackground, diffLineAddDecorationBackgroundWithIndicator, diffLineDeleteDecorationBackground, diffLineDeleteDecorationBackgroundWithIndicator } from 'vs/editor/browser/widget/diffEditorWidget2/decorations';
+import { DiffEditorEditors } from 'vs/editor/browser/widget/diffEditorWidget2/diffEditorEditors';
 import { DiffEditorOptions } from 'vs/editor/browser/widget/diffEditorWidget2/diffEditorOptions';
 import { DiffEditorViewModel } from 'vs/editor/browser/widget/diffEditorWidget2/diffEditorViewModel';
 import { MovedBlocksLinesPart } from 'vs/editor/browser/widget/diffEditorWidget2/movedBlocksLines';
@@ -19,15 +19,14 @@ import { IModelDeltaDecoration } from 'vs/editor/common/model';
 
 export class DiffEditorDecorations extends Disposable {
 	constructor(
-		private readonly _originalEditor: CodeEditorWidget,
-		private readonly _modifiedEditor: CodeEditorWidget,
+		private readonly _editors: DiffEditorEditors,
 		private readonly _diffModel: IObservable<DiffEditorViewModel | undefined>,
 		private readonly _options: DiffEditorOptions,
 	) {
 		super();
 
-		this._register(applyObservableDecorations(this._originalEditor, this._decorations.map(d => d?.originalDecorations || [])));
-		this._register(applyObservableDecorations(this._modifiedEditor, this._decorations.map(d => d?.modifiedDecorations || [])));
+		this._register(applyObservableDecorations(this._editors.original, this._decorations.map(d => d?.originalDecorations || [])));
+		this._register(applyObservableDecorations(this._editors.modified, this._decorations.map(d => d?.modifiedDecorations || [])));
 	}
 
 	private readonly _decorations = derived('decorations', (reader) => {

src/vs/editor/browser/widget/diffEditorWidget2/diffEditorViewModel.ts

@@ -8,7 +8,7 @@ import { Disposable } from 'vs/base/common/lifecycle';
 import { IObservable, IReader, ISettableObservable, ITransaction, derived, observableSignal, observableSignalFromEvent, observableValue, transaction, waitForState } from 'vs/base/common/observable';
 import { autorunWithStore2 } from 'vs/base/common/observableImpl/autorun';
 import { isDefined } from 'vs/base/common/types';
-import { LineRange } from 'vs/editor/common/core/lineRange';
+import { ISerializedLineRange, LineRange } from 'vs/editor/common/core/lineRange';
 import { Range } from 'vs/editor/common/core/range';
 import { IDocumentDiff, IDocumentDiffProvider } from 'vs/editor/common/diff/documentDiffProvider';
 import { LineRangeMapping, MovedText, RangeMapping, SimpleLineRangeMapping } from 'vs/editor/common/diff/linesDiffComputer';
@@ -137,20 +137,6 @@ export class DiffEditorViewModel extends Disposable implements IDiffEditorViewMo
 				.filter(r => !!r)
 				.map(r => LineRange.fromRange(r!));
 
-			for (const r of newUnchangedRegions) {
-				for (let i = 0; i < lastUnchangedRegions.regions.length; i++) {
-					if (r.originalRange.intersectsStrict(lastUnchangedRegionsOrigRanges[i])
-						&& r.modifiedRange.intersectsStrict(lastUnchangedRegionsModRanges[i])) {
-						r.setState(
-							lastUnchangedRegions.regions[i].visibleLineCountTop.get(),
-							lastUnchangedRegions.regions[i].visibleLineCountBottom.get(),
-							undefined,
-						);
-						break;
-					}
-				}
-			}
-
 			const originalDecorationIds = model.original.deltaDecorations(
 				lastUnchangedRegions.originalDecorationIds,
 				newUnchangedRegions.map(r => ({ range: r.originalRange.toInclusiveRange()!, options: { description: 'unchanged' } }))
@@ -161,6 +147,16 @@ export class DiffEditorViewModel extends Disposable implements IDiffEditorViewMo
 			);
 
 			transaction(tx => {
+				for (const r of newUnchangedRegions) {
+					for (let i = 0; i < lastUnchangedRegions.regions.length; i++) {
+						if (r.originalRange.intersectsStrict(lastUnchangedRegionsOrigRanges[i])
+							&& r.modifiedRange.intersectsStrict(lastUnchangedRegionsModRanges[i])) {
+							r.setHiddenModifiedRange(lastUnchangedRegions.regions[i].getHiddenModifiedRange(undefined), tx);
+							break;
+						}
+					}
+				}
+
 				this._lastDiff = result;
 				this._diff.set(DiffState.fromDiffResult(result), tx);
 				this._isDiffUpToDate.set(true, tx);
@@ -208,6 +204,32 @@ export class DiffEditorViewModel extends Disposable implements IDiffEditorViewMo
 	public async waitForDiff(): Promise<void> {
 		await waitForState(this.isDiffUpToDate, s => s);
 	}
+
+	public serializeState(): SerializedState {
+		const regions = this._unchangedRegions.get();
+		return {
+			collapsedRegions: regions.regions.map(r => ({ range: r.getHiddenModifiedRange(undefined).serialize() }))
+		};
+	}
+
+	public restoreSerializedState(state: SerializedState): void {
+		const ranges = state.collapsedRegions.map(r => LineRange.deserialize(r.range));
+		const regions = this._unchangedRegions.get();
+		transaction(tx => {
+			for (const r of regions.regions) {
+				for (const range of ranges) {
+					if (r.modifiedRange.intersect(range)) {
+						r.setHiddenModifiedRange(range, tx);
+						break;
+					}
+				}
+			}
+		});
+	}
+}
+
+interface SerializedState {
+	collapsedRegions: { range: ISerializedLineRange }[];
 }
 
 export class DiffState {
@@ -334,6 +356,12 @@ export class UnchangedRegion {
 		);
 	}
 
+	public setHiddenModifiedRange(range: LineRange, tx: ITransaction) {
+		const visibleLineCountTop = range.startLineNumber - this.modifiedLineNumber;
+		const visibleLineCountBottom = (this.modifiedLineNumber + this.lineCount) - range.endLineNumberExclusive;
+		this.setState(visibleLineCountTop, visibleLineCountBottom, tx);
+	}
+
 	public getMaxVisibleLineCountTop() {
 		return this.lineCount - this._visibleLineCountBottom.get();
 	}
@@ -357,8 +385,8 @@ export class UnchangedRegion {
 	}
 
 	public setState(visibleLineCountTop: number, visibleLineCountBottom: number, tx: ITransaction | undefined): void {
-		visibleLineCountTop = Math.min(visibleLineCountTop, this.lineCount);
-		visibleLineCountBottom = Math.min(visibleLineCountBottom, this.lineCount - visibleLineCountTop);
+		visibleLineCountTop = Math.max(Math.min(visibleLineCountTop, this.lineCount), 0);
+		visibleLineCountBottom = Math.max(Math.min(visibleLineCountBottom, this.lineCount - visibleLineCountTop), 0);
 
 		this._visibleLineCountTop.set(visibleLineCountTop, tx);
 		this._visibleLineCountBottom.set(visibleLineCountBottom, tx);

src/vs/editor/browser/widget/diffEditorWidget2/diffEditorWidget2.ts

@@ -104,56 +104,10 @@ export class DiffEditorWidget2 extends DelegatingEditor implements IDiffEditor {
 			(i, c, o, o2) => this._createInnerEditor(i, c, o, o2),
 		));
 
-
-		this._register(this._editors.original.onDidChangeCursorPosition(e => {
-			const m = this._diffModel.get();
-			if (!m) { return; }
-
-			const movedText = m.diff.get()!.movedTexts.find(m => m.lineRangeMapping.originalRange.contains(e.position.lineNumber));
-			m.syncedMovedTexts.set(movedText, undefined);
-		}));
-		this._register(this._editors.modified.onDidChangeCursorPosition(e => {
-			const m = this._diffModel.get();
-			if (!m) { return; }
-
-			const movedText = m.diff.get()!.movedTexts.find(m => m.lineRangeMapping.modifiedRange.contains(e.position.lineNumber));
-			m.syncedMovedTexts.set(movedText, undefined);
-		}));
-		// Revert change when an arrow is clicked.
-		this._register(this._editors.modified.onMouseDown(event => {
-			if (!event.event.rightButton && event.target.position && event.target.element?.className.includes('arrow-revert-change')) {
-				const lineNumber = event.target.position.lineNumber;
-				const viewZone = event.target as IMouseTargetViewZone | undefined;
-
-				const model = this._diffModel.get();
-				if (!model) {
-					return;
-				}
-				const diffs = model.diff.get()?.mappings;
-				if (!diffs) {
-					return;
-				}
-				const diff = diffs.find(d =>
-					viewZone?.detail.afterLineNumber === d.lineRangeMapping.modifiedRange.startLineNumber - 1 ||
-					d.lineRangeMapping.modifiedRange.startLineNumber === lineNumber
-				);
-				if (!diff) {
-					return;
-				}
-				this.revert(diff.lineRangeMapping);
-
-				event.event.stopPropagation();
-				return;
-			}
-		}));
-
-
 		this._sash = derivedWithStore('sash', (reader, store) => {
 			const showSash = this._options.renderSideBySide.read(reader);
 			this.elements.root.classList.toggle('side-by-side', showSash);
-			if (!showSash) {
-				return undefined;
-			}
+			if (!showSash) { return undefined; }
 			const result = store.add(new DiffEditorSash(
 				this._options,
 				this.elements.root,
@@ -173,36 +127,25 @@ export class DiffEditorWidget2 extends DelegatingEditor implements IDiffEditor {
 		this._register(keepAlive(this._sash, true));
 
 		this._register(autorunWithStore2('unchangedRangesFeature', (reader, store) => {
-			this.unchangedRangesFeature = store.add(new (readHotReloadableExport(UnchangedRangesFeature, reader))(
-				this._editors.original,
-				this._editors.modified,
-				this._diffModel,
-				this._options.renderSideBySide,
-			));
+			this.unchangedRangesFeature = store.add(new (readHotReloadableExport(UnchangedRangesFeature, reader))(this._editors, this._diffModel, this._options));
 		}));
 
 		this._register(autorunWithStore2('decorations', (reader, store) => {
-			store.add(new (readHotReloadableExport(DiffEditorDecorations, reader))(
-				this._editors.original,
-				this._editors.modified,
-				this._diffModel,
-				this._options,
-			));
+			store.add(new (readHotReloadableExport(DiffEditorDecorations, reader))(this._editors, this._diffModel, this._options));
 		}));
 
 		this._register(this._instantiationService.createInstance(
 			ViewZoneManager,
-			this._editors.original,
-			this._editors.modified,
+			this._editors,
 			this._diffModel,
 			this._options,
 			this,
 			() => this.unchangedRangesFeature.isUpdatingViewZones,
 		));
 
-		this._register(this._instantiationService.createInstance(OverviewRulerPart,
-			this._editors.original,
-			this._editors.modified,
+		this._register(this._instantiationService.createInstance(
+			OverviewRulerPart,
+			this._editors,
 			this.elements.root,
 			this._diffModel,
 			this._rootSizeObserver.width,
@@ -227,8 +170,7 @@ export class DiffEditorWidget2 extends DelegatingEditor implements IDiffEditor {
 			this._diffModel,
 			this._layoutInfo.map(i => i.originalEditor),
 			this._layoutInfo.map(i => i.modifiedEditor),
-			this._editors.original,
-			this._editors.modified,
+			this._editors,
 		));
 
 		this._register(applyStyle(this.elements.overlay, {
@@ -238,6 +180,40 @@ export class DiffEditorWidget2 extends DelegatingEditor implements IDiffEditor {
 					? 'visible' : 'hidden'
 			),
 		}));
+
+		this._register(this._editors.original.onDidChangeCursorPosition(e => {
+			const m = this._diffModel.get();
+			if (!m) { return; }
+			const movedText = m.diff.get()!.movedTexts.find(m => m.lineRangeMapping.originalRange.contains(e.position.lineNumber));
+			m.syncedMovedTexts.set(movedText, undefined);
+		}));
+		this._register(this._editors.modified.onDidChangeCursorPosition(e => {
+			const m = this._diffModel.get();
+			if (!m) { return; }
+			const movedText = m.diff.get()!.movedTexts.find(m => m.lineRangeMapping.modifiedRange.contains(e.position.lineNumber));
+			m.syncedMovedTexts.set(movedText, undefined);
+		}));
+
+		// Revert change when an arrow is clicked.
+		this._register(this._editors.modified.onMouseDown(event => {
+			if (!event.event.rightButton && event.target.position && event.target.element?.className.includes('arrow-revert-change')) {
+				const lineNumber = event.target.position.lineNumber;
+				const viewZone = event.target as IMouseTargetViewZone | undefined;
+
+				const model = this._diffModel.get();
+				if (!model) { return; }
+				const diffs = model.diff.get()?.mappings;
+				if (!diffs) { return; }
+				const diff = diffs.find(d =>
+					viewZone?.detail.afterLineNumber === d.lineRangeMapping.modifiedRange.startLineNumber - 1 ||
+					d.lineRangeMapping.modifiedRange.startLineNumber === lineNumber
+				);
+				if (!diff) { return; }
+				this.revert(diff.lineRangeMapping);
+
+				event.event.stopPropagation();
+			}
+		}));
 	}
 
 	protected _createInnerEditor(instantiationService: IInstantiationService, container: HTMLElement, options: Readonly<IEditorConstructionOptions>, editorWidgetOptions: ICodeEditorWidgetOptions): CodeEditorWidget {
@@ -307,7 +283,8 @@ export class DiffEditorWidget2 extends DelegatingEditor implements IDiffEditor {
 		const modifiedViewState = this._editors.modified.saveViewState();
 		return {
 			original: originalViewState,
-			modified: modifiedViewState
+			modified: modifiedViewState,
+			modelState: this._diffModel.get()?.serializeState(),
 		};
 	}
 
@@ -316,6 +293,9 @@ export class DiffEditorWidget2 extends DelegatingEditor implements IDiffEditor {
 			const diffEditorState = s as IDiffEditorViewState;
 			this._editors.original.restoreViewState(diffEditorState.original);
 			this._editors.modified.restoreViewState(diffEditorState.modified);
+			if (diffEditorState.modelState) {
+				this._diffModel.get()?.restoreSerializedState(diffEditorState.modelState as any);
+			}
 		}
 	}