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
|
/*---------------------------------------------------------------------------------------------
* 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 { IEditorOptions } from 'vs/editor/common/config/editorOptions';
import { IWorkbenchEditorConfiguration, IEditorIdentifier, EditorResourceAccessor, SideBySideEditor } from 'vs/workbench/common/editor';
import { EditorInput } from 'vs/workbench/common/editor/editorInput';
import { IFilesConfiguration as PlatformIFilesConfiguration, FileChangeType, IFileService } from 'vs/platform/files/common/files';
import { ContextKeyExpr, RawContextKey } from 'vs/platform/contextkey/common/contextkey';
import { ITextModelContentProvider } from 'vs/editor/common/services/resolverService';
import { Disposable, MutableDisposable } from 'vs/base/common/lifecycle';
import { ITextModel } from 'vs/editor/common/model';
import { IModelService } from 'vs/editor/common/services/model';
import { ILanguageService, ILanguageSelection } from 'vs/editor/common/languages/language';
import { ITextFileService } from 'vs/workbench/services/textfile/common/textfiles';
import { InputFocusedContextKey } from 'vs/platform/contextkey/common/contextkeys';
import { IEditorGroup } from 'vs/workbench/services/editor/common/editorGroupsService';
import { once } from 'vs/base/common/functional';
import { ITextEditorOptions } from 'vs/platform/editor/common/editor';
import { IEditorService } from 'vs/workbench/services/editor/common/editorService';
import { localize } from 'vs/nls';
/**
* Explorer viewlet id.
*/
export const VIEWLET_ID = 'workbench.view.explorer';
/**
* Explorer file view id.
*/
export const VIEW_ID = 'workbench.explorer.fileView';
/**
* Context Keys to use with keybindings for the Explorer and Open Editors view
*/
export const ExplorerViewletVisibleContext = new RawContextKey<boolean>('explorerViewletVisible', true, { type: 'boolean', description: localize('explorerViewletVisible', "True when the EXPLORER viewlet is visible.") });
export const ExplorerFolderContext = new RawContextKey<boolean>('explorerResourceIsFolder', false, { type: 'boolean', description: localize('explorerResourceIsFolder', "True when the focused item in the EXPLORER is a folder.") });
export const ExplorerResourceReadonlyContext = new RawContextKey<boolean>('explorerResourceReadonly', false, { type: 'boolean', description: localize('explorerResourceReadonly', "True when the focused item in the EXPLORER is readonly.") });
export const ExplorerResourceNotReadonlyContext = ExplorerResourceReadonlyContext.toNegated();
/**
* Comma separated list of editor ids that can be used for the selected explorer resource.
*/
export const ExplorerResourceAvailableEditorIdsContext = new RawContextKey<string>('explorerResourceAvailableEditorIds', '');
export const ExplorerRootContext = new RawContextKey<boolean>('explorerResourceIsRoot', false, { type: 'boolean', description: localize('explorerResourceIsRoot', "True when the focused item in the EXPLORER is a root folder.") });
export const ExplorerResourceCut = new RawContextKey<boolean>('explorerResourceCut', false, { type: 'boolean', description: localize('explorerResourceCut', "True when an item in the EXPLORER has been cut for cut and paste.") });
export const ExplorerResourceMoveableToTrash = new RawContextKey<boolean>('explorerResourceMoveableToTrash', false, { type: 'boolean', description: localize('explorerResourceMoveableToTrash', "True when the focused item in the EXPLORER can be moved to trash.") });
export const FilesExplorerFocusedContext = new RawContextKey<boolean>('filesExplorerFocus', true, { type: 'boolean', description: localize('filesExplorerFocus', "True when the focus is inside the EXPLORER view.") });
export const OpenEditorsVisibleContext = new RawContextKey<boolean>('openEditorsVisible', false, { type: 'boolean', description: localize('openEditorsVisible', "True when the OPEN EDITORS view is visible.") });
export const OpenEditorsFocusedContext = new RawContextKey<boolean>('openEditorsFocus', true, { type: 'boolean', description: localize('openEditorsFocus', "True when the focus is inside the OPEN EDITORS view.") });
export const ExplorerFocusedContext = new RawContextKey<boolean>('explorerViewletFocus', true, { type: 'boolean', description: localize('explorerViewletFocus', "True when the focus is inside the EXPLORER viewlet.") });
// compressed nodes
export const ExplorerCompressedFocusContext = new RawContextKey<boolean>('explorerViewletCompressedFocus', true, { type: 'boolean', description: localize('explorerViewletCompressedFocus', "True when the focused item in the EXPLORER view is a compact item.") });
export const ExplorerCompressedFirstFocusContext = new RawContextKey<boolean>('explorerViewletCompressedFirstFocus', true, { type: 'boolean', description: localize('explorerViewletCompressedFirstFocus', "True when the focus is inside a compact item's first part in the EXPLORER view.") });
export const ExplorerCompressedLastFocusContext = new RawContextKey<boolean>('explorerViewletCompressedLastFocus', true, { type: 'boolean', description: localize('explorerViewletCompressedLastFocus', "True when the focus is inside a compact item's last part in the EXPLORER view.") });
export const FilesExplorerFocusCondition = ContextKeyExpr.and(ExplorerViewletVisibleContext, FilesExplorerFocusedContext, ContextKeyExpr.not(InputFocusedContextKey));
export const ExplorerFocusCondition = ContextKeyExpr.and(ExplorerViewletVisibleContext, ExplorerFocusedContext, ContextKeyExpr.not(InputFocusedContextKey));
/**
* Text file editor id.
*/
export const TEXT_FILE_EDITOR_ID = 'workbench.editors.files.textFileEditor';
/**
* File editor input id.
*/
export const FILE_EDITOR_INPUT_ID = 'workbench.editors.files.fileEditorInput';
/**
* Binary file editor id.
*/
export const BINARY_FILE_EDITOR_ID = 'workbench.editors.files.binaryFileEditor';
/**
* Language identifier for binary files opened as text.
*/
export const BINARY_TEXT_FILE_MODE = 'code-text-binary';
export interface IFilesConfiguration extends PlatformIFilesConfiguration, IWorkbenchEditorConfiguration {
explorer: {
openEditors: {
visible: number;
sortOrder: 'editorOrder' | 'alphabetical' | 'fullPath';
};
autoReveal: boolean | 'focusNoScroll';
enableDragAndDrop: boolean;
confirmDelete: boolean;
enableUndo: boolean;
confirmUndo: UndoConfirmLevel;
expandSingleFolderWorkspaces: boolean;
sortOrder: SortOrder;
sortOrderLexicographicOptions: LexicographicOptions;
decorations: {
colors: boolean;
badges: boolean;
};
incrementalNaming: 'simple' | 'smart';
experimental: {
fileNesting: {
enabled: boolean;
operateAsGroup: boolean;
expand: boolean;
patterns: { [parent: string]: string };
};
};
};
editor: IEditorOptions;
}
export interface IFileResource {
resource: URI;
isDirectory?: boolean;
}
export const enum SortOrder {
Default = 'default',
Mixed = 'mixed',
FilesFirst = 'filesFirst',
Type = 'type',
Modified = 'modified',
FoldersNestsFiles = 'foldersNestsFiles',
}
export const enum UndoConfirmLevel {
Verbose = 'verbose',
Default = 'default',
Light = 'light',
}
export const enum LexicographicOptions {
Default = 'default',
Upper = 'upper',
Lower = 'lower',
Unicode = 'unicode',
}
export interface ISortOrderConfiguration {
sortOrder: SortOrder;
lexicographicOptions: LexicographicOptions;
}
export class TextFileContentProvider extends Disposable implements ITextModelContentProvider {
private readonly fileWatcherDisposable = this._register(new MutableDisposable());
constructor(
@ITextFileService private readonly textFileService: ITextFileService,
@IFileService private readonly fileService: IFileService,
@ILanguageService private readonly languageService: ILanguageService,
@IModelService private readonly modelService: IModelService
) {
super();
}
static async open(resource: URI, scheme: string, label: string, editorService: IEditorService, options?: ITextEditorOptions): Promise<void> {
await editorService.openEditor({
original: { resource: TextFileContentProvider.resourceToTextFile(scheme, resource) },
modified: { resource },
label,
options
});
}
private static resourceToTextFile(scheme: string, resource: URI): URI {
return resource.with({ scheme, query: JSON.stringify({ scheme: resource.scheme, query: resource.query }) });
}
private static textFileToResource(resource: URI): URI {
const { scheme, query } = JSON.parse(resource.query);
return resource.with({ scheme, query });
}
async provideTextContent(resource: URI): Promise<ITextModel | null> {
if (!resource.query) {
// We require the URI to use the `query` to transport the original scheme and query
// as done by `resourceToTextFile`
return null;
}
const savedFileResource = TextFileContentProvider.textFileToResource(resource);
// Make sure our text file is resolved up to date
const codeEditorModel = await this.resolveEditorModel(resource);
// Make sure to keep contents up to date when it changes
if (!this.fileWatcherDisposable.value) {
this.fileWatcherDisposable.value = this.fileService.onDidFilesChange(changes => {
if (changes.contains(savedFileResource, FileChangeType.UPDATED)) {
this.resolveEditorModel(resource, false /* do not create if missing */); // update model when resource changes
}
});
if (codeEditorModel) {
once(codeEditorModel.onWillDispose)(() => this.fileWatcherDisposable.clear());
}
}
return codeEditorModel;
}
private resolveEditorModel(resource: URI, createAsNeeded?: true): Promise<ITextModel>;
private resolveEditorModel(resource: URI, createAsNeeded?: boolean): Promise<ITextModel | null>;
private async resolveEditorModel(resource: URI, createAsNeeded: boolean = true): Promise<ITextModel | null> {
const savedFileResource = TextFileContentProvider.textFileToResource(resource);
const content = await this.textFileService.readStream(savedFileResource);
let codeEditorModel = this.modelService.getModel(resource);
if (codeEditorModel) {
this.modelService.updateModel(codeEditorModel, content.value);
} else if (createAsNeeded) {
const textFileModel = this.modelService.getModel(savedFileResource);
let languageSelector: ILanguageSelection;
if (textFileModel) {
languageSelector = this.languageService.createById(textFileModel.getLanguageId());
} else {
languageSelector = this.languageService.createByFilepathOrFirstLine(savedFileResource);
}
codeEditorModel = this.modelService.createModel(content.value, languageSelector, resource);
}
return codeEditorModel;
}
}
export class OpenEditor implements IEditorIdentifier {
private id: number;
private static COUNTER = 0;
constructor(private _editor: EditorInput, private _group: IEditorGroup) {
this.id = OpenEditor.COUNTER++;
}
get editor() {
return this._editor;
}
get group() {
return this._group;
}
get groupId() {
return this._group.id;
}
getId(): string {
return `openeditor:${this.groupId}:${this.id}`;
}
isPreview(): boolean {
return !this._group.isPinned(this.editor);
}
isSticky(): boolean {
return this._group.isSticky(this.editor);
}
getResource(): URI | undefined {
return EditorResourceAccessor.getOriginalUri(this.editor, { supportSideBySide: SideBySideEditor.PRIMARY });
}
}
|