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
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { URI } from 'vs/base/common/uri';
import { DEFAULT_EDITOR_ASSOCIATION, findViewStateForEditor, GroupIdentifier, IUntitledTextResourceEditorInput, IUntypedEditorInput, Verbosity } from 'vs/workbench/common/editor';
import { EditorInput } from 'vs/workbench/common/editor/editorInput';
import { AbstractTextResourceEditorInput } from 'vs/workbench/common/editor/textResourceEditorInput';
import { IUntitledTextEditorModel } from 'vs/workbench/services/untitled/common/untitledTextEditorModel';
import { EncodingMode, IEncodingSupport, ILanguageSupport, ITextFileService } from 'vs/workbench/services/textfile/common/textfiles';
import { ILabelService } from 'vs/platform/label/common/label';
import { IEditorService } from 'vs/workbench/services/editor/common/editorService';
import { IFileService } from 'vs/platform/files/common/files';
import { isEqual, toLocalResource } from 'vs/base/common/resources';
import { IWorkbenchEnvironmentService } from 'vs/workbench/services/environment/common/environmentService';
import { IPathService } from 'vs/workbench/services/path/common/pathService';
import { ITextEditorOptions } from 'vs/platform/editor/common/editor';
/**
* An editor input to be used for untitled text buffers.
*/
export class UntitledTextEditorInput extends AbstractTextResourceEditorInput implements IEncodingSupport, ILanguageSupport {
static readonly ID: string = 'workbench.editors.untitledEditorInput';
override get typeId(): string {
return UntitledTextEditorInput.ID;
}
override get editorId(): string | undefined {
return DEFAULT_EDITOR_ASSOCIATION.id;
}
private modelResolve: Promise<void> | undefined = undefined;
constructor(
readonly model: IUntitledTextEditorModel,
@ITextFileService textFileService: ITextFileService,
@ILabelService labelService: ILabelService,
@IEditorService editorService: IEditorService,
@IFileService fileService: IFileService,
@IWorkbenchEnvironmentService private readonly environmentService: IWorkbenchEnvironmentService,
@IPathService private readonly pathService: IPathService
) {
super(model.resource, undefined, editorService, textFileService, labelService, fileService);
this.registerModelListeners(model);
}
private registerModelListeners(model: IUntitledTextEditorModel): void {
// re-emit some events from the model
this._register(model.onDidChangeDirty(() => this._onDidChangeDirty.fire()));
this._register(model.onDidChangeName(() => this._onDidChangeLabel.fire()));
// a reverted untitled text editor model renders this input disposed
this._register(model.onDidRevert(() => this.dispose()));
}
override getName(): string {
return this.model.name;
}
override getDescription(verbosity = Verbosity.MEDIUM): string | undefined {
// Without associated path: only use if name and description differ
if (!this.model.hasAssociatedFilePath) {
const descriptionCandidate = this.resource.path;
if (descriptionCandidate !== this.getName()) {
return descriptionCandidate;
}
return undefined;
}
// With associated path: delegate to parent
return super.getDescription(verbosity);
}
override getTitle(verbosity: Verbosity): string {
// Without associated path: check if name and description differ to decide
// if description should appear besides the name to distinguish better
if (!this.model.hasAssociatedFilePath) {
const name = this.getName();
const description = this.getDescription();
if (description && description !== name) {
return `${name} • ${description}`;
}
return name;
}
// With associated path: delegate to parent
return super.getTitle(verbosity);
}
override isDirty(): boolean {
return this.model.isDirty();
}
getEncoding(): string | undefined {
return this.model.getEncoding();
}
setEncoding(encoding: string, mode: EncodingMode /* ignored, we only have Encode */): Promise<void> {
return this.model.setEncoding(encoding);
}
setLanguageId(languageId: string): void {
this.model.setLanguageId(languageId);
}
getLanguageId(): string | undefined {
return this.model.getLanguageId();
}
override async resolve(): Promise<IUntitledTextEditorModel> {
if (!this.modelResolve) {
this.modelResolve = this.model.resolve();
}
await this.modelResolve;
return this.model;
}
override toUntyped(options?: { preserveViewState: GroupIdentifier }): IUntitledTextResourceEditorInput {
const untypedInput: IUntitledTextResourceEditorInput & { resource: URI | undefined; options: ITextEditorOptions } = {
resource: this.model.hasAssociatedFilePath ? toLocalResource(this.model.resource, this.environmentService.remoteAuthority, this.pathService.defaultUriScheme) : this.resource,
forceUntitled: true,
options: {
override: this.editorId
}
};
if (typeof options?.preserveViewState === 'number') {
untypedInput.encoding = this.getEncoding();
untypedInput.languageId = this.getLanguageId();
untypedInput.contents = this.model.isDirty() ? this.model.textEditorModel?.getValue() : undefined;
untypedInput.options.viewState = findViewStateForEditor(this, options.preserveViewState, this.editorService);
if (typeof untypedInput.contents === 'string' && !this.model.hasAssociatedFilePath) {
// Given how generic untitled resources in the system are, we
// need to be careful not to set our resource into the untyped
// editor if we want to transport contents too, because of
// issue https://github.com/microsoft/vscode/issues/140898
// The workaround is to simply remove the resource association
// if we have contents and no associated resource.
// In that case we can ensure that a new untitled resource is
// being created and the contents can be restored properly.
untypedInput.resource = undefined;
}
}
return untypedInput;
}
override matches(otherInput: EditorInput | IUntypedEditorInput): boolean {
if (super.matches(otherInput)) {
return true;
}
if (otherInput instanceof UntitledTextEditorInput) {
return isEqual(otherInput.resource, this.resource);
}
return false;
}
override dispose(): void {
this.modelResolve = undefined;
super.dispose();
}
}
|
