Skip to content

Commit

Permalink
Fixes #199295
Browse files Browse the repository at this point in the history
  • Loading branch information
@hediet
hediet committed Jan 12, 2024
1 parent f0aff16 commit 8c3320b
Show file tree
Hide file tree
Showing 4 changed files with 123 additions and 37 deletions.
13 changes: 13 additions & 0 deletions src/vs/editor/browser/widget/multiDiffEditorWidget/multiDiffEditorViewModel.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { DiffEditorOptions } from 'vs/editor/browser/widget/diffEditor/diffEdito
import { DiffEditorViewModel } from 'vs/editor/browser/widget/diffEditor/diffEditorViewModel';
import { IDocumentDiffItem, IMultiDiffEditorModel, LazyPromise } from 'vs/editor/browser/widget/multiDiffEditorWidget/model';
import { IDiffEditorOptions } from 'vs/editor/common/config/editorOptions';
import { Selection } from 'vs/editor/common/core/selection';
import { IDiffEditorViewModel } from 'vs/editor/common/editorCommon';
import { ContextKeyValue } from 'vs/platform/contextkey/common/contextkey';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
Expand Down Expand Up @@ -60,6 +61,11 @@ export class DocumentDiffItemViewModel extends Disposable {
public readonly diffEditorViewModel: IDiffEditorViewModel;
public readonly collapsed = observableValue<boolean>(this, false);

public readonly lastTemplateData = observableValue<{ contentHeight: number; selections: Selection[] | undefined }>(
this,
{ contentHeight: 500, selections: undefined, }
);

constructor(
public readonly entry: LazyPromise<IDocumentDiffItem>,
private readonly _instantiationService: IInstantiationService,
Expand Down Expand Up @@ -87,4 +93,11 @@ export class DocumentDiffItemViewModel extends Disposable {
modified: entry.value!.modified!,
}, options));
}

public getKey(): string {
return JSON.stringify([
this.diffEditorViewModel.model.original.uri.toString(),
this.diffEditorViewModel.model.modified.uri.toString()
]);
}
}
20 changes: 5 additions & 15 deletions src/vs/editor/browser/widget/multiDiffEditorWidget/multiDiffEditorWidget.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { Disposable } from 'vs/base/common/lifecycle';
import { derived, derivedWithStore, observableValue, recomputeInitiallyAndOnChange } from 'vs/base/common/observable';
import { readHotReloadableExport } from 'vs/editor/browser/widget/diffEditor/utils';
import { IMultiDiffEditorModel } from 'vs/editor/browser/widget/multiDiffEditorWidget/model';
import { MultiDiffEditorWidgetImpl } from 'vs/editor/browser/widget/multiDiffEditorWidget/multiDiffEditorWidgetImpl';
import { IMultiDiffEditorViewState, MultiDiffEditorWidgetImpl } from 'vs/editor/browser/widget/multiDiffEditorWidget/multiDiffEditorWidgetImpl';
import { MultiDiffEditorViewModel } from './multiDiffEditorViewModel';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import './colors';
Expand Down Expand Up @@ -61,21 +61,11 @@ export class MultiDiffEditorWidget extends Disposable {

public readonly onDidChangeActiveControl = Event.fromObservableLight(this._activeControl);

private readonly _scrollState = derived(this, (reader) => {
const w = this._widgetImpl.read(reader);
const top = w.scrollTop.read(reader);
const left = w.scrollLeft.read(reader);
return { top, left };
});

public getScrollState(): { top: number; left: number } {
return this._scrollState.get();
public getViewState(): IMultiDiffEditorViewState {
return this._widgetImpl.get().getViewState();
}

public setScrollState(scrollState: { top?: number; left?: number }): void {
const w = this._widgetImpl.get();
w.setScrollState(scrollState);
public setViewState(viewState: IMultiDiffEditorViewState): void {
this._widgetImpl.get().setViewState(viewState);
}

public readonly onDidChangeScrollState = Event.fromObservableLight(this._scrollState);
}
116 changes: 102 additions & 14 deletions src/vs/editor/browser/widget/multiDiffEditorWidget/multiDiffEditorWidgetImpl.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { SmoothScrollableElement } from 'vs/base/browser/ui/scrollbar/scrollable
import { findFirstMaxBy } from 'vs/base/common/arraysFind';
import { Disposable, IReference, toDisposable } from 'vs/base/common/lifecycle';
import { IObservable, IReader, autorun, autorunWithStore, derived, derivedObservableWithCache, derivedWithStore, observableFromEvent, observableValue } from 'vs/base/common/observable';
import { disposableObservableValue, globalTransaction, transaction } from 'vs/base/common/observableInternal/base';
import { ITransaction, disposableObservableValue, globalTransaction, transaction } from 'vs/base/common/observableInternal/base';
import { Scrollable, ScrollbarVisibility } from 'vs/base/common/scrollable';
import 'vs/css!./style';
import { ObservableElementSizeObserver } from 'vs/editor/browser/widget/diffEditor/utils';
Expand All @@ -21,6 +21,7 @@ import { ObjectPool } from './objectPool';
import { ContextKeyValue, IContextKeyService } from 'vs/platform/contextkey/common/contextkey';
import { ServiceCollection } from 'vs/platform/instantiation/common/serviceCollection';
import { EditorContextKeys } from 'vs/editor/common/editorContextKeys';
import { ISelection, Selection } from 'vs/editor/common/core/selection';

export class MultiDiffEditorWidgetImpl extends Disposable {
private readonly _elements = h('div.monaco-component.multiDiffEditor', [
Expand Down Expand Up @@ -68,7 +69,16 @@ export class MultiDiffEditorWidgetImpl extends Disposable {
return [];
}
const items = vm.items.read(reader);
return items.map(d => store.add(new VirtualizedViewItem(d, this._objectPool, this.scrollLeft)));
return items.map(d => {
const item = store.add(new VirtualizedViewItem(d, this._objectPool, this.scrollLeft));
const data = this._lastDocStates?.[item.getKey()];
if (data) {
transaction(tx => {
item.setViewState(data, tx);
});
}
return item;
});
}
);

Expand Down Expand Up @@ -171,6 +181,37 @@ export class MultiDiffEditorWidgetImpl extends Disposable {
this._scrollableElement.setScrollPosition({ scrollLeft: scrollState.left, scrollTop: scrollState.top });
}

public getViewState(): IMultiDiffEditorViewState {
return {
scrollState: {
top: this.scrollTop.get(),
left: this.scrollLeft.get(),
},
docStates: Object.fromEntries(this._viewItems.get().map(i => [i.getKey(), i.getViewState()])),
};
}

/** This accounts for documents that are not loaded yet. */
private _lastDocStates: IMultiDiffEditorViewState['docStates'] = {};

public setViewState(viewState: IMultiDiffEditorViewState): void {
this.setScrollState(viewState.scrollState);

this._lastDocStates = viewState.docStates;

transaction(tx => {
/** setViewState */
if (viewState.docStates) {
for (const i of this._viewItems.get()) {
const state = viewState.docStates[i.getKey()];
if (state) {
i.setViewState(state, tx);
}
}
}
});
}

private render(reader: IReader | undefined) {
const scrollTop = this.scrollTop.read(reader);
let contentScrollOffsetToScrollOffset = 0;
Expand Down Expand Up @@ -209,19 +250,24 @@ export class MultiDiffEditorWidgetImpl extends Disposable {
}
}

export interface IMultiDiffEditorViewState {
scrollState: { top: number; left: number };
docStates?: Record<string, IMultiDiffDocState>;
}

interface IMultiDiffDocState {
collapsed: boolean;
selections?: ISelection[];
}

class VirtualizedViewItem extends Disposable {
// TODO this should be in the view model
private readonly _lastTemplateData = observableValue<{ contentHeight: number; maxScroll: { maxScroll: number; width: number } }>(
this,
{ contentHeight: 500, maxScroll: { maxScroll: 0, width: 0 }, }
);
private readonly _templateRef = this._register(disposableObservableValue<IReference<DiffEditorItemTemplate> | undefined>(this, undefined));

public readonly contentHeight = derived(this, reader =>
this._templateRef.read(reader)?.object.contentHeight?.read(reader) ?? this._lastTemplateData.read(reader).contentHeight
this._templateRef.read(reader)?.object.contentHeight?.read(reader) ?? this.viewModel.lastTemplateData.read(reader).contentHeight
);

public readonly maxScroll = derived(this, reader => this._templateRef.read(reader)?.object.maxScroll.read(reader) ?? this._lastTemplateData.read(reader).maxScroll);
public readonly maxScroll = derived(this, reader => this._templateRef.read(reader)?.object.maxScroll.read(reader) ?? { maxScroll: 0, scrollWidth: 0 });

public readonly template = derived(this, reader => this._templateRef.read(reader)?.object);
private _isHidden = observableValue(this, false);
Expand Down Expand Up @@ -260,16 +306,53 @@ class VirtualizedViewItem extends Disposable {
return `VirtualViewItem(${this.viewModel.entry.value!.modified?.uri.toString()})`;
}

public getKey(): string {
return this.viewModel.getKey();
}

public getViewState(): IMultiDiffDocState {
transaction(tx => {
this._updateTemplateData(tx);
});
return {
collapsed: this.viewModel.collapsed.get(),
selections: this.viewModel.lastTemplateData.get().selections,
};
}

public setViewState(viewState: IMultiDiffDocState, tx: ITransaction): void {
this.viewModel.collapsed.set(viewState.collapsed, tx);

this._updateTemplateData(tx);
const data = this.viewModel.lastTemplateData.get();
const selections = viewState.selections?.map(Selection.liftSelection);
this.viewModel.lastTemplateData.set({
...data,
selections,
}, tx);
const ref = this._templateRef.get();
if (ref) {
if (selections) {
ref.object.editor.setSelections(selections);
}
}
}

private _updateTemplateData(tx: ITransaction): void {
const ref = this._templateRef.get();
if (!ref) { return; }
this.viewModel.lastTemplateData.set({
contentHeight: ref.object.contentHeight.get(),
selections: ref.object.editor.getSelections() ?? undefined,
}, tx);
}

private _clear(): void {
const ref = this._templateRef.get();
if (!ref) { return; }
transaction(tx => {
this._lastTemplateData.set({
contentHeight: ref.object.contentHeight.get(),
maxScroll: { maxScroll: 0, width: 0, } // Reset max scroll
}, tx);
this._updateTemplateData(tx);
ref.object.hide();

this._templateRef.set(undefined, tx);
});
}
Expand All @@ -285,6 +368,11 @@ class VirtualizedViewItem extends Disposable {
if (!ref) {
ref = this._objectPool.getUnusedObj(new TemplateData(this.viewModel));
this._templateRef.set(ref, undefined);

const selections = this.viewModel.lastTemplateData.get().selections;
if (selections) {
ref.object.editor.setSelections(selections);
}
}
ref.object.render(verticalSpace, width, offset, viewPort);
}
Expand Down
11 changes: 3 additions & 8 deletions src/vs/workbench/contrib/multiDiffEditor/browser/multiDiffEditor.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import { IEditorGroupsService } from 'vs/workbench/services/editor/common/editor
import { IEditorService } from 'vs/workbench/services/editor/common/editorService';
import { URI } from 'vs/base/common/uri';
import { MultiDiffEditorViewModel } from 'vs/editor/browser/widget/multiDiffEditorWidget/multiDiffEditorViewModel';
import { IMultiDiffEditorViewState } from 'vs/editor/browser/widget/multiDiffEditorWidget/multiDiffEditorWidgetImpl';

export class MultiDiffEditor extends AbstractEditorWithViewState<IMultiDiffEditorViewState> {
static readonly ID = 'multiDiffEditor';
Expand All @@ -35,7 +36,6 @@ export class MultiDiffEditor extends AbstractEditorWithViewState<IMultiDiffEdito
return this._viewModel;
}


constructor(
@IInstantiationService instantiationService: InstantiationService,
@ITelemetryService telemetryService: ITelemetryService,
Expand Down Expand Up @@ -77,7 +77,7 @@ export class MultiDiffEditor extends AbstractEditorWithViewState<IMultiDiffEdito

const viewState = this.loadEditorViewState(input, context);
if (viewState) {
this._multiDiffEditorWidget!.setScrollState(viewState.scrollState);
this._multiDiffEditorWidget!.setViewState(viewState);
}
}

Expand All @@ -95,9 +95,7 @@ export class MultiDiffEditor extends AbstractEditorWithViewState<IMultiDiffEdito
}

protected override computeEditorViewState(resource: URI): IMultiDiffEditorViewState | undefined {
return {
scrollState: this._multiDiffEditorWidget!.getScrollState()
};
return this._multiDiffEditorWidget!.getViewState();
}

protected override tracksEditorViewState(input: EditorInput): boolean {
Expand All @@ -109,9 +107,6 @@ export class MultiDiffEditor extends AbstractEditorWithViewState<IMultiDiffEdito
}
}

interface IMultiDiffEditorViewState {
scrollState: { top: number; left: number };
}

class WorkbenchUIElementFactory implements IWorkbenchUIElementFactory {
constructor(
Expand Down

0 comments on commit 8c3320b

Please sign in to comment.