1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { localize } from 'vs/nls';
import { deepClone } from 'vs/base/common/objects';
import { isObject, isArray, assertIsDefined, withUndefinedAsNull, withNullAsUndefined } from 'vs/base/common/types';
import { ICodeEditor, IDiffEditor } from 'vs/editor/browser/editorBrowser';
import { IDiffEditorOptions, IEditorOptions as ICodeEditorOptions } from 'vs/editor/common/config/editorOptions';
import { AbstractTextEditor, IEditorConfiguration } from 'vs/workbench/browser/parts/editor/textEditor';
import { TEXT_DIFF_EDITOR_ID, IEditorFactoryRegistry, EditorExtensions, ITextDiffEditorPane, IEditorOpenContext, EditorInputCapabilities, isEditorInput, isTextEditorViewState } from 'vs/workbench/common/editor';
import { EditorInput } from 'vs/workbench/common/editor/editorInput';
import { applyTextEditorOptions } from 'vs/workbench/common/editor/editorOptions';
import { DiffEditorInput } from 'vs/workbench/common/editor/diffEditorInput';
import { DiffNavigator } from 'vs/editor/browser/widget/diffNavigator';
import { DiffEditorWidget } from 'vs/editor/browser/widget/diffEditorWidget';
import { TextDiffEditorModel } from 'vs/workbench/common/editor/textDiffEditorModel';
import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
import { IStorageService } from 'vs/platform/storage/common/storage';
import { ITextResourceConfigurationService } from 'vs/editor/common/services/textResourceConfiguration';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { IThemeService } from 'vs/platform/theme/common/themeService';
import { TextFileOperationError, TextFileOperationResult } from 'vs/workbench/services/textfile/common/textfiles';
import { ScrollType, IDiffEditorViewState, IDiffEditorModel } from 'vs/editor/common/editorCommon';
import { DisposableStore } from 'vs/base/common/lifecycle';
import { Registry } from 'vs/platform/registry/common/platform';
import { URI } from 'vs/base/common/uri';
import { IEditorGroup, IEditorGroupsService } from 'vs/workbench/services/editor/common/editorGroupsService';
import { IEditorService } from 'vs/workbench/services/editor/common/editorService';
import { CancellationToken } from 'vs/base/common/cancellation';
import { EditorActivation, ITextEditorOptions } from 'vs/platform/editor/common/editor';
import { IContextKeyService } from 'vs/platform/contextkey/common/contextkey';
import { isEqual } from 'vs/base/common/resources';
import { Dimension, multibyteAwareBtoa } from 'vs/base/browser/dom';
import { IFileService } from 'vs/platform/files/common/files';
/**
* The text editor that leverages the diff text editor for the editing experience.
*/
export class TextDiffEditor extends AbstractTextEditor<IDiffEditorViewState> implements ITextDiffEditorPane {
static readonly ID = TEXT_DIFF_EDITOR_ID;
private diffEditorControl: IDiffEditor | undefined = undefined;
private diffNavigator: DiffNavigator | undefined;
private readonly diffNavigatorDisposables = this._register(new DisposableStore());
override get scopedContextKeyService(): IContextKeyService | undefined {
if (!this.diffEditorControl) {
return undefined;
}
const originalEditor = this.diffEditorControl.getOriginalEditor();
const modifiedEditor = this.diffEditorControl.getModifiedEditor();
return (originalEditor.hasTextFocus() ? originalEditor : modifiedEditor).invokeWithinContext(accessor => accessor.get(IContextKeyService));
}
constructor(
@ITelemetryService telemetryService: ITelemetryService,
@IInstantiationService instantiationService: IInstantiationService,
@IStorageService storageService: IStorageService,
@ITextResourceConfigurationService configurationService: ITextResourceConfigurationService,
@IEditorService editorService: IEditorService,
@IThemeService themeService: IThemeService,
@IEditorGroupsService editorGroupService: IEditorGroupsService,
@IFileService fileService: IFileService
) {
super(TextDiffEditor.ID, telemetryService, instantiationService, storageService, configurationService, themeService, editorService, editorGroupService, fileService);
}
override getTitle(): string {
if (this.input) {
return this.input.getName();
}
return localize('textDiffEditor', "Text Diff Editor");
}
override createEditorControl(parent: HTMLElement, configuration: ICodeEditorOptions): void {
this.diffEditorControl = this._register(this.instantiationService.createInstance(DiffEditorWidget, parent, configuration, {}));
}
protected updateEditorControlOptions(options: ICodeEditorOptions): void {
this.diffEditorControl?.updateOptions(options);
}
protected getMainControl(): ICodeEditor | undefined {
return this.diffEditorControl?.getModifiedEditor();
}
override async setInput(input: DiffEditorInput, options: ITextEditorOptions | undefined, context: IEditorOpenContext, token: CancellationToken): Promise<void> {
// Dispose previous diff navigator
this.diffNavigatorDisposables.clear();
// Set input and resolve
await super.setInput(input, options, context, token);
try {
const resolvedModel = await input.resolve();
// Check for cancellation
if (token.isCancellationRequested) {
return undefined;
}
// Fallback to open as binary if not text
if (!(resolvedModel instanceof TextDiffEditorModel)) {
this.openAsBinary(input, options);
return undefined;
}
// Set Editor Model
const control = assertIsDefined(this.diffEditorControl);
const resolvedDiffEditorModel = resolvedModel as TextDiffEditorModel;
control.setModel(withUndefinedAsNull(resolvedDiffEditorModel.textDiffEditorModel));
// Restore view state (unless provided by options)
let hasPreviousViewState = false;
if (!isTextEditorViewState(options?.viewState)) {
hasPreviousViewState = this.restoreTextDiffEditorViewState(input, options, context, control);
}
// Apply options to editor if any
let optionsGotApplied = false;
if (options) {
optionsGotApplied = applyTextEditorOptions(options, control, ScrollType.Immediate);
}
// Diff navigator
this.diffNavigator = new DiffNavigator(control, {
alwaysRevealFirst: !optionsGotApplied && !hasPreviousViewState // only reveal first change if we had no options or viewstate
});
this.diffNavigatorDisposables.add(this.diffNavigator);
// Since the resolved model provides information about being readonly
// or not, we apply it here to the editor even though the editor input
// was already asked for being readonly or not. The rationale is that
// a resolved model might have more specific information about being
// readonly or not that the input did not have.
control.updateOptions({
readOnly: resolvedDiffEditorModel.modifiedModel?.isReadonly(),
originalEditable: !resolvedDiffEditorModel.originalModel?.isReadonly()
});
} catch (error) {
// In case we tried to open a file and the response indicates that this is not a text file, fallback to binary diff.
if (this.isFileBinaryError(error)) {
this.openAsBinary(input, options);
return;
}
throw error;
}
}
private restoreTextDiffEditorViewState(editor: DiffEditorInput, options: ITextEditorOptions | undefined, context: IEditorOpenContext, control: IDiffEditor): boolean {
const editorViewState = this.loadEditorViewState(editor, context);
if (editorViewState) {
if (options?.selection && editorViewState.modified) {
editorViewState.modified.cursorState = []; // prevent duplicate selections via options
}
control.restoreViewState(editorViewState);
return true;
}
return false;
}
private openAsBinary(input: DiffEditorInput, options: ITextEditorOptions | undefined): void {
const original = input.original;
const modified = input.modified;
const binaryDiffInput = this.instantiationService.createInstance(DiffEditorInput, input.getName(), input.getDescription(), original, modified, true);
// Forward binary flag to input if supported
const fileEditorFactory = Registry.as<IEditorFactoryRegistry>(EditorExtensions.EditorFactory).getFileEditorFactory();
if (fileEditorFactory.isFileEditor(original)) {
original.setForceOpenAsBinary();
}
if (fileEditorFactory.isFileEditor(modified)) {
modified.setForceOpenAsBinary();
}
// Replace this editor with the binary one
(this.group ?? this.editorGroupService.activeGroup).replaceEditors([{
editor: input,
replacement: binaryDiffInput,
options: {
...options,
// Make sure to not steal away the currently active group
// because we are triggering another openEditor() call
// and do not control the initial intent that resulted
// in us now opening as binary.
activation: EditorActivation.PRESERVE,
pinned: this.group?.isPinned(input),
sticky: this.group?.isSticky(input)
}
}]);
}
override setOptions(options: ITextEditorOptions | undefined): void {
super.setOptions(options);
if (options) {
applyTextEditorOptions(options, assertIsDefined(this.diffEditorControl), ScrollType.Smooth);
}
}
protected override computeConfiguration(configuration: IEditorConfiguration): ICodeEditorOptions {
const editorConfiguration = super.computeConfiguration(configuration);
// Handle diff editor specially by merging in diffEditor configuration
if (isObject(configuration.diffEditor)) {
const diffEditorConfiguration: IDiffEditorOptions = deepClone(configuration.diffEditor);
// User settings defines `diffEditor.codeLens`, but here we rename that to `diffEditor.diffCodeLens` to avoid collisions with `editor.codeLens`.
diffEditorConfiguration.diffCodeLens = diffEditorConfiguration.codeLens;
delete diffEditorConfiguration.codeLens;
// User settings defines `diffEditor.wordWrap`, but here we rename that to `diffEditor.diffWordWrap` to avoid collisions with `editor.wordWrap`.
diffEditorConfiguration.diffWordWrap = <'off' | 'on' | 'inherit' | undefined>diffEditorConfiguration.wordWrap;
delete diffEditorConfiguration.wordWrap;
Object.assign(editorConfiguration, diffEditorConfiguration);
}
return editorConfiguration;
}
protected override getConfigurationOverrides(): IDiffEditorOptions {
const readOnly = this.input instanceof DiffEditorInput && this.input.modified.hasCapability(EditorInputCapabilities.Readonly);
return {
...super.getConfigurationOverrides(),
readOnly,
dropIntoEditor: { enabled: !readOnly },
originalEditable: this.input instanceof DiffEditorInput && !this.input.original.hasCapability(EditorInputCapabilities.Readonly),
lineDecorationsWidth: '2ch'
};
}
protected override updateReadonly(input: EditorInput): void {
if (input instanceof DiffEditorInput) {
this.diffEditorControl?.updateOptions({
readOnly: input.hasCapability(EditorInputCapabilities.Readonly),
originalEditable: !input.original.hasCapability(EditorInputCapabilities.Readonly),
dropIntoEditor: { enabled: !input.hasCapability(EditorInputCapabilities.Readonly) }
});
} else {
super.updateReadonly(input);
}
}
private isFileBinaryError(error: Error[]): boolean;
private isFileBinaryError(error: Error): boolean;
private isFileBinaryError(error: Error | Error[]): boolean {
if (isArray(error)) {
const errors = <Error[]>error;
return errors.some(error => this.isFileBinaryError(error));
}
return (<TextFileOperationError>error).textFileOperationResult === TextFileOperationResult.FILE_IS_BINARY;
}
override clearInput(): void {
super.clearInput();
// Dispose previous diff navigator
this.diffNavigatorDisposables.clear();
// Clear Model
this.diffEditorControl?.setModel(null);
}
getDiffNavigator(): DiffNavigator | undefined {
return this.diffNavigator;
}
override getControl(): IDiffEditor | undefined {
return this.diffEditorControl;
}
override focus(): void {
this.diffEditorControl?.focus();
}
override hasFocus(): boolean {
return this.diffEditorControl?.hasTextFocus() || super.hasFocus();
}
protected override setEditorVisible(visible: boolean, group: IEditorGroup | undefined): void {
super.setEditorVisible(visible, group);
if (visible) {
this.diffEditorControl?.onVisible();
} else {
this.diffEditorControl?.onHide();
}
}
override layout(dimension: Dimension): void {
this.diffEditorControl?.layout(dimension);
}
protected override tracksEditorViewState(input: EditorInput): boolean {
return input instanceof DiffEditorInput;
}
protected override computeEditorViewState(resource: URI): IDiffEditorViewState | undefined {
if (!this.diffEditorControl) {
return undefined;
}
const model = this.diffEditorControl.getModel();
if (!model || !model.modified || !model.original) {
return undefined; // view state always needs a model
}
const modelUri = this.toEditorViewStateResource(model);
if (!modelUri) {
return undefined; // model URI is needed to make sure we save the view state correctly
}
if (!isEqual(modelUri, resource)) {
return undefined; // prevent saving view state for a model that is not the expected one
}
return withNullAsUndefined(this.diffEditorControl.saveViewState());
}
protected override toEditorViewStateResource(modelOrInput: IDiffEditorModel | EditorInput): URI | undefined {
let original: URI | undefined;
let modified: URI | undefined;
if (modelOrInput instanceof DiffEditorInput) {
original = modelOrInput.original.resource;
modified = modelOrInput.modified.resource;
} else if (!isEditorInput(modelOrInput)) {
original = modelOrInput.original.uri;
modified = modelOrInput.modified.uri;
}
if (!original || !modified) {
return undefined;
}
// create a URI that is the Base64 concatenation of original + modified resource
return URI.from({ scheme: 'diff', path: `${multibyteAwareBtoa(original.toString())}${multibyteAwareBtoa(modified.toString())}` });
}
}
|