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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
|
/*---------------------------------------------------------------------------------------------
* 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 { Event } from 'vs/base/common/event';
import { assertIsDefined } from 'vs/base/common/types';
import { URI } from 'vs/base/common/uri';
import { Disposable, IDisposable, toDisposable } from 'vs/base/common/lifecycle';
import { ICodeEditorViewState, IDiffEditor, IDiffEditorViewState, IEditorViewState } from 'vs/editor/common/editorCommon';
import { IEditorOptions, IResourceEditorInput, ITextResourceEditorInput, IBaseTextResourceEditorInput, IBaseUntypedEditorInput } from 'vs/platform/editor/common/editor';
import type { EditorInput } from 'vs/workbench/common/editor/editorInput';
import { IInstantiationService, IConstructorSignature, ServicesAccessor, BrandedService } from 'vs/platform/instantiation/common/instantiation';
import { IContextKeyService } from 'vs/platform/contextkey/common/contextkey';
import { Registry } from 'vs/platform/registry/common/platform';
import { IEncodingSupport, ILanguageSupport } from 'vs/workbench/services/textfile/common/textfiles';
import { IEditorGroup } from 'vs/workbench/services/editor/common/editorGroupsService';
import { ICompositeControl, IComposite } from 'vs/workbench/common/composite';
import { FileType, IFileService } from 'vs/platform/files/common/files';
import { IPathData } from 'vs/platform/window/common/window';
import { coalesce } from 'vs/base/common/arrays';
import { IExtUri } from 'vs/base/common/resources';
import { Schemas } from 'vs/base/common/network';
import { IEditorService } from 'vs/workbench/services/editor/common/editorService';
// Static values for editor contributions
export const EditorExtensions = {
EditorPane: 'workbench.contributions.editors',
EditorFactory: 'workbench.contributions.editor.inputFactories'
};
// Static information regarding the text editor
export const DEFAULT_EDITOR_ASSOCIATION = {
id: 'default',
displayName: localize('promptOpenWith.defaultEditor.displayName', "Text Editor"),
providerDisplayName: localize('builtinProviderDisplayName', "Built-in")
};
/**
* Side by side editor id.
*/
export const SIDE_BY_SIDE_EDITOR_ID = 'workbench.editor.sidebysideEditor';
/**
* Text diff editor id.
*/
export const TEXT_DIFF_EDITOR_ID = 'workbench.editors.textDiffEditor';
/**
* Binary diff editor id.
*/
export const BINARY_DIFF_EDITOR_ID = 'workbench.editors.binaryResourceDiffEditor';
export interface IEditorDescriptor<T extends IEditorPane> {
/**
* The unique type identifier of the editor. All instances
* of the same `IEditorPane` should have the same type
* identifier.
*/
readonly typeId: string;
/**
* The display name of the editor.
*/
readonly name: string;
/**
* Instantiates the editor pane using the provided services.
*/
instantiate(instantiationService: IInstantiationService): T;
/**
* Whether the descriptor is for the provided editor pane.
*/
describes(editorPane: T): boolean;
}
/**
* The editor pane is the container for workbench editors.
*/
export interface IEditorPane extends IComposite {
/**
* An event to notify when the `IEditorControl` in this
* editor pane changes.
*
* This can be used for editor panes that are a compound
* of multiple editor controls to signal that the active
* editor control has changed when the user clicks around.
*/
readonly onDidChangeControl: Event<void>;
/**
* An optional event to notify when the selection inside the editor
* pane changed in case the editor has a selection concept.
*
* For example, in a text editor pane, the selection changes whenever
* the cursor is set to a new location.
*/
readonly onDidChangeSelection?: Event<IEditorPaneSelectionChangeEvent>;
/**
* The assigned input of this editor.
*/
readonly input: EditorInput | undefined;
/**
* The assigned options of the editor.
*/
readonly options: IEditorOptions | undefined;
/**
* The assigned group this editor is showing in.
*/
readonly group: IEditorGroup | undefined;
/**
* The minimum width of this editor.
*/
readonly minimumWidth: number;
/**
* The maximum width of this editor.
*/
readonly maximumWidth: number;
/**
* The minimum height of this editor.
*/
readonly minimumHeight: number;
/**
* The maximum height of this editor.
*/
readonly maximumHeight: number;
/**
* An event to notify whenever minimum/maximum width/height changes.
*/
readonly onDidChangeSizeConstraints: Event<{ width: number; height: number } | undefined>;
/**
* The context key service for this editor. Should be overridden by
* editors that have their own ScopedContextKeyService
*/
readonly scopedContextKeyService: IContextKeyService | undefined;
/**
* Returns the underlying control of this editor. Callers need to cast
* the control to a specific instance as needed, e.g. by using the
* `isCodeEditor` helper method to access the text code editor.
*
* Use the `onDidChangeControl` event to track whenever the control
* changes.
*/
getControl(): IEditorControl | undefined;
/**
* Returns the current view state of the editor if any.
*
* This method is optional to override for the editor pane
* and should only be overridden when the pane can deal with
* `IEditorOptions.viewState` to be applied when opening.
*/
getViewState(): object | undefined;
/**
* An optional method to return the current selection in
* the editor pane in case the editor pane has a selection
* concept.
*
* Clients of this method will typically react to the
* `onDidChangeSelection` event to receive the current
* selection as needed.
*/
getSelection?(): IEditorPaneSelection | undefined;
/**
* Finds out if this editor is visible or not.
*/
isVisible(): boolean;
}
export interface IEditorPaneSelectionChangeEvent {
/**
* More details for how the selection was made.
*/
reason: EditorPaneSelectionChangeReason;
}
export const enum EditorPaneSelectionChangeReason {
/**
* The selection was changed as a result of a programmatic
* method invocation.
*
* For a text editor pane, this for example can be a selection
* being restored from previous view state automatically.
*/
PROGRAMMATIC = 1,
/**
* The selection was changed by the user.
*
* This typically means the user changed the selection
* with mouse or keyboard.
*/
USER,
/**
* The selection was changed as a result of editing in
* the editor pane.
*
* For a text editor pane, this for example can be typing
* in the text of the editor pane.
*/
EDIT,
/**
* The selection was changed as a result of a navigation
* action.
*
* For a text editor pane, this for example can be a result
* of selecting an entry from a text outline view.
*/
NAVIGATION,
/**
* The selection was changed as a result of a jump action
* from within the editor pane.
*
* For a text editor pane, this for example can be a result
* of invoking "Go to definition" from a symbol.
*/
JUMP
}
export interface IEditorPaneSelection {
/**
* Asks to compare this selection to another selection.
*/
compare(otherSelection: IEditorPaneSelection): EditorPaneSelectionCompareResult;
/**
* Asks to massage the provided `options` in a way
* that the selection can be restored when the editor
* is opened again.
*
* For a text editor this means to apply the selected
* line and column as text editor options.
*/
restore(options: IEditorOptions): IEditorOptions;
/**
* Only used for logging to print more info about the selection.
*/
log?(): string;
}
export const enum EditorPaneSelectionCompareResult {
/**
* The selections are identical.
*/
IDENTICAL = 1,
/**
* The selections are similar.
*
* For a text editor this can mean that the one
* selection is in close proximity to the other
* selection.
*
* Upstream clients may decide in this case to
* not treat the selection different from the
* previous one because it is not distinct enough.
*/
SIMILAR = 2,
/**
* The selections are entirely different.
*/
DIFFERENT = 3
}
export interface IEditorPaneWithSelection extends IEditorPane {
readonly onDidChangeSelection: Event<IEditorPaneSelectionChangeEvent>;
getSelection(): IEditorPaneSelection | undefined;
}
export function isEditorPaneWithSelection(editorPane: IEditorPane | undefined): editorPane is IEditorPaneWithSelection {
const candidate = editorPane as IEditorPaneWithSelection | undefined;
return !!candidate && typeof candidate.getSelection === 'function' && !!candidate.onDidChangeSelection;
}
/**
* Try to retrieve the view state for the editor pane that
* has the provided editor input opened, if at all.
*
* This method will return `undefined` if the editor input
* is not visible in any of the opened editor panes.
*/
export function findViewStateForEditor(input: EditorInput, group: GroupIdentifier, editorService: IEditorService): object | undefined {
for (const editorPane of editorService.visibleEditorPanes) {
if (editorPane.group.id === group && input.matches(editorPane.input)) {
return editorPane.getViewState();
}
}
return undefined;
}
/**
* Overrides `IEditorPane` where `input` and `group` are known to be set.
*/
export interface IVisibleEditorPane extends IEditorPane {
readonly input: EditorInput;
readonly group: IEditorGroup;
}
/**
* The text editor pane is the container for workbench text diff editors.
*/
export interface ITextDiffEditorPane extends IEditorPane {
/**
* Returns the underlying text editor widget of this editor.
*/
getControl(): IDiffEditor | undefined;
}
/**
* Marker interface for the control inside an editor pane. Callers
* have to cast the control to work with it, e.g. via methods
* such as `isCodeEditor(control)`.
*/
export interface IEditorControl extends ICompositeControl { }
export interface IFileEditorFactory {
/**
* The type identifier of the file editor.
*/
typeId: string;
/**
* Creates new new editor capable of showing files.
*/
createFileEditor(resource: URI, preferredResource: URI | undefined, preferredName: string | undefined, preferredDescription: string | undefined, preferredEncoding: string | undefined, preferredLanguageId: string | undefined, preferredContents: string | undefined, instantiationService: IInstantiationService): IFileEditorInput;
/**
* Check if the provided object is a file editor.
*/
isFileEditor(obj: unknown): obj is IFileEditorInput;
}
export interface IEditorFactoryRegistry {
/**
* Registers the file editor factory to use for file editors.
*/
registerFileEditorFactory(factory: IFileEditorFactory): void;
/**
* Returns the file editor factory to use for file editors.
*/
getFileEditorFactory(): IFileEditorFactory;
/**
* Registers a editor serializer for the given editor to the registry.
* An editor serializer is capable of serializing and deserializing editor
* from string data.
*
* @param editorTypeId the type identifier of the editor
* @param serializer the editor serializer for serialization/deserialization
*/
registerEditorSerializer<Services extends BrandedService[]>(editorTypeId: string, ctor: { new(...Services: Services): IEditorSerializer }): IDisposable;
/**
* Returns the editor serializer for the given editor.
*/
getEditorSerializer(editor: EditorInput): IEditorSerializer | undefined;
getEditorSerializer(editorTypeId: string): IEditorSerializer | undefined;
/**
* Starts the registry by providing the required services.
*/
start(accessor: ServicesAccessor): void;
}
export interface IEditorSerializer {
/**
* Determines whether the given editor can be serialized by the serializer.
*/
canSerialize(editor: EditorInput): boolean;
/**
* Returns a string representation of the provided editor that contains enough information
* to deserialize back to the original editor from the deserialize() method.
*/
serialize(editor: EditorInput): string | undefined;
/**
* Returns an editor from the provided serialized form of the editor. This form matches
* the value returned from the serialize() method.
*/
deserialize(instantiationService: IInstantiationService, serializedEditor: string): EditorInput | undefined;
}
export interface IUntitledTextResourceEditorInput extends IBaseTextResourceEditorInput {
/**
* Optional resource for the untitled editor. Depending on the value, the editor:
* - should get a unique name if `undefined` (for example `Untitled-1`)
* - should use the resource directly if the scheme is `untitled:`
* - should change the scheme to `untitled:` otherwise and assume an associated path
*
* Untitled editors with associated path behave slightly different from other untitled
* editors:
* - they are dirty right when opening
* - they will not ask for a file path when saving but use the associated path
*/
readonly resource: URI | undefined;
}
/**
* A resource side by side editor input shows 2 editors side by side but
* without highlighting any differences.
*
* Note: both sides will be resolved as editor individually. As such, it is
* possible to show 2 different editors side by side.
*
* @see {@link IResourceDiffEditorInput} for a variant that compares 2 editors.
*/
export interface IResourceSideBySideEditorInput extends IBaseUntypedEditorInput {
/**
* The right hand side editor to open inside a side-by-side editor.
*/
readonly primary: IResourceEditorInput | ITextResourceEditorInput | IUntitledTextResourceEditorInput;
/**
* The left hand side editor to open inside a side-by-side editor.
*/
readonly secondary: IResourceEditorInput | ITextResourceEditorInput | IUntitledTextResourceEditorInput;
}
/**
* A resource diff editor input compares 2 editors side by side
* highlighting the differences.
*
* Note: both sides must be resolvable to the same editor, or
* a text based presentation will be used as fallback.
*/
export interface IResourceDiffEditorInput extends IBaseUntypedEditorInput {
/**
* The left hand side editor to open inside a diff editor.
*/
readonly original: IResourceEditorInput | ITextResourceEditorInput | IUntitledTextResourceEditorInput;
/**
* The right hand side editor to open inside a diff editor.
*/
readonly modified: IResourceEditorInput | ITextResourceEditorInput | IUntitledTextResourceEditorInput;
}
export function isResourceEditorInput(editor: unknown): editor is IResourceEditorInput {
if (isEditorInput(editor)) {
return false; // make sure to not accidentally match on typed editor inputs
}
const candidate = editor as IResourceEditorInput | undefined;
return URI.isUri(candidate?.resource);
}
export function isResourceDiffEditorInput(editor: unknown): editor is IResourceDiffEditorInput {
if (isEditorInput(editor)) {
return false; // make sure to not accidentally match on typed editor inputs
}
const candidate = editor as IResourceDiffEditorInput | undefined;
return candidate?.original !== undefined && candidate.modified !== undefined;
}
export function isResourceSideBySideEditorInput(editor: unknown): editor is IResourceSideBySideEditorInput {
if (isEditorInput(editor)) {
return false; // make sure to not accidentally match on typed editor inputs
}
if (isResourceDiffEditorInput(editor)) {
return false; // make sure to not accidentally match on diff editors
}
const candidate = editor as IResourceSideBySideEditorInput | undefined;
return candidate?.primary !== undefined && candidate.secondary !== undefined;
}
export function isUntitledResourceEditorInput(editor: unknown): editor is IUntitledTextResourceEditorInput {
if (isEditorInput(editor)) {
return false; // make sure to not accidentally match on typed editor inputs
}
const candidate = editor as IUntitledTextResourceEditorInput | undefined;
if (!candidate) {
return false;
}
return candidate.resource === undefined || candidate.resource.scheme === Schemas.untitled || candidate.forceUntitled === true;
}
export const enum Verbosity {
SHORT,
MEDIUM,
LONG
}
export const enum SaveReason {
/**
* Explicit user gesture.
*/
EXPLICIT = 1,
/**
* Auto save after a timeout.
*/
AUTO = 2,
/**
* Auto save after editor focus change.
*/
FOCUS_CHANGE = 3,
/**
* Auto save after window change.
*/
WINDOW_CHANGE = 4
}
export type SaveSource = string;
interface ISaveSourceDescriptor {
source: SaveSource;
label: string;
}
class SaveSourceFactory {
private readonly mapIdToSaveSource = new Map<SaveSource, ISaveSourceDescriptor>();
/**
* Registers a `SaveSource` with an identifier and label
* to the registry so that it can be used in save operations.
*/
registerSource(id: string, label: string): SaveSource {
let sourceDescriptor = this.mapIdToSaveSource.get(id);
if (!sourceDescriptor) {
sourceDescriptor = { source: id, label };
this.mapIdToSaveSource.set(id, sourceDescriptor);
}
return sourceDescriptor.source;
}
getSourceLabel(source: SaveSource): string {
return this.mapIdToSaveSource.get(source)?.label ?? source;
}
}
export const SaveSourceRegistry = new SaveSourceFactory();
export interface ISaveOptions {
/**
* An indicator how the save operation was triggered.
*/
reason?: SaveReason;
/**
* An indicator about the source of the save operation.
*
* Must use `SaveSourceRegistry.registerSource()` to obtain.
*/
readonly source?: SaveSource;
/**
* Forces to save the contents of the working copy
* again even if the working copy is not dirty.
*/
readonly force?: boolean;
/**
* Instructs the save operation to skip any save participants.
*/
readonly skipSaveParticipants?: boolean;
/**
* A hint as to which file systems should be available for saving.
*/
readonly availableFileSystems?: string[];
}
export interface IRevertOptions {
/**
* Forces to load the contents of the working copy
* again even if the working copy is not dirty.
*/
readonly force?: boolean;
/**
* A soft revert will clear dirty state of a working copy
* but will not attempt to load it from its persisted state.
*
* This option may be used in scenarios where an editor is
* closed and where we do not require to load the contents.
*/
readonly soft?: boolean;
}
export interface IMoveResult {
editor: EditorInput | IUntypedEditorInput;
options?: IEditorOptions;
}
export const enum EditorInputCapabilities {
/**
* Signals no specific capability for the input.
*/
None = 0,
/**
* Signals that the input is readonly.
*/
Readonly = 1 << 1,
/**
* Signals that the input is untitled.
*/
Untitled = 1 << 2,
/**
* Signals that the input can only be shown in one group
* and not be split into multiple groups.
*/
Singleton = 1 << 3,
/**
* Signals that the input requires workspace trust.
*/
RequiresTrust = 1 << 4,
/**
* Signals that the editor can split into 2 in the same
* editor group.
*/
CanSplitInGroup = 1 << 5,
/**
* Signals that the editor wants it's description to be
* visible when presented to the user. By default, a UI
* component may decide to hide the description portion
* for brevity.
*/
ForceDescription = 1 << 6,
/**
* Signals that the editor supports dropping into the
* editor by holding shift.
*/
CanDropIntoEditor = 1 << 7,
}
export type IUntypedEditorInput = IResourceEditorInput | ITextResourceEditorInput | IUntitledTextResourceEditorInput | IResourceDiffEditorInput | IResourceSideBySideEditorInput;
export abstract class AbstractEditorInput extends Disposable {
// Marker class for implementing `isEditorInput`
}
export function isEditorInput(editor: unknown): editor is EditorInput {
return editor instanceof AbstractEditorInput;
}
export interface EditorInputWithPreferredResource {
/**
* An editor may provide an additional preferred resource alongside
* the `resource` property. While the `resource` property serves as
* unique identifier of the editor that should be used whenever we
* compare to other editors, the `preferredResource` should be used
* in places where e.g. the resource is shown to the user.
*
* For example: on Windows and macOS, the same URI with different
* casing may point to the same file. The editor may chose to
* "normalize" the URIs so that only one editor opens for different
* URIs. But when displaying the editor label to the user, the
* preferred URI should be used.
*
* Not all editors have a `preferredResouce`. The `EditorResourceAccessor`
* utility can be used to always get the right resource without having
* to do instanceof checks.
*/
readonly preferredResource: URI;
}
function isEditorInputWithPreferredResource(editor: unknown): editor is EditorInputWithPreferredResource {
const candidate = editor as EditorInputWithPreferredResource | undefined;
return URI.isUri(candidate?.preferredResource);
}
export interface ISideBySideEditorInput extends EditorInput {
/**
* The primary editor input is shown on the right hand side.
*/
primary: EditorInput;
/**
* The secondary editor input is shown on the left hand side.
*/
secondary: EditorInput;
}
export function isSideBySideEditorInput(editor: unknown): editor is ISideBySideEditorInput {
const candidate = editor as ISideBySideEditorInput | undefined;
return isEditorInput(candidate?.primary) && isEditorInput(candidate?.secondary);
}
export interface IDiffEditorInput extends EditorInput {
/**
* The modified (primary) editor input is shown on the right hand side.
*/
modified: EditorInput;
/**
* The original (secondary) editor input is shown on the left hand side.
*/
original: EditorInput;
}
export function isDiffEditorInput(editor: unknown): editor is IDiffEditorInput {
const candidate = editor as IDiffEditorInput | undefined;
return isEditorInput(candidate?.modified) && isEditorInput(candidate?.original);
}
export interface IUntypedFileEditorInput extends ITextResourceEditorInput {
/**
* A marker to create a `IFileEditorInput` from this untyped input.
*/
forceFile: true;
}
/**
* This is a tagging interface to declare an editor input being capable of dealing with files. It is only used in the editor registry
* to register this kind of input to the platform.
*/
export interface IFileEditorInput extends EditorInput, IEncodingSupport, ILanguageSupport, EditorInputWithPreferredResource {
/**
* Gets the resource this file input is about. This will always be the
* canonical form of the resource, so it may differ from the original
* resource that was provided to create the input. Use `preferredResource`
* for the form as it was created.
*/
readonly resource: URI;
/**
* Sets the preferred resource to use for this file input.
*/
setPreferredResource(preferredResource: URI): void;
/**
* Sets the preferred name to use for this file input.
*
* Note: for certain file schemes the input may decide to ignore this
* name and use our standard naming. Specifically for schemes we own,
* we do not let others override the name.
*/
setPreferredName(name: string): void;
/**
* Sets the preferred description to use for this file input.
*
* Note: for certain file schemes the input may decide to ignore this
* description and use our standard naming. Specifically for schemes we own,
* we do not let others override the description.
*/
setPreferredDescription(description: string): void;
/**
* Sets the preferred encoding to use for this file input.
*/
setPreferredEncoding(encoding: string): void;
/**
* Sets the preferred language id to use for this file input.
*/
setPreferredLanguageId(languageId: string): void;
/**
* Sets the preferred contents to use for this file input.
*/
setPreferredContents(contents: string): void;
/**
* Forces this file input to open as binary instead of text.
*/
setForceOpenAsBinary(): void;
/**
* Figure out if the file input has been resolved or not.
*/
isResolved(): boolean;
}
export interface EditorInputWithOptions {
editor: EditorInput;
options?: IEditorOptions;
}
export interface EditorInputWithOptionsAndGroup extends EditorInputWithOptions {
group: IEditorGroup;
}
export function isEditorInputWithOptions(editor: unknown): editor is EditorInputWithOptions {
const candidate = editor as EditorInputWithOptions | undefined;
return isEditorInput(candidate?.editor);
}
export function isEditorInputWithOptionsAndGroup(editor: unknown): editor is EditorInputWithOptionsAndGroup {
const candidate = editor as EditorInputWithOptionsAndGroup | undefined;
return isEditorInputWithOptions(editor) && candidate?.group !== undefined;
}
/**
* Context passed into `EditorPane#setInput` to give additional
* context information around why the editor was opened.
*/
export interface IEditorOpenContext {
/**
* An indicator if the editor input is new for the group the editor is in.
* An editor is new for a group if it was not part of the group before and
* otherwise was already opened in the group and just became the active editor.
*
* This hint can e.g. be used to decide whether to restore view state or not.
*/
newInGroup?: boolean;
}
export interface IEditorIdentifier {
groupId: GroupIdentifier;
editor: EditorInput;
}
export function isEditorIdentifier(identifier: unknown): identifier is IEditorIdentifier {
const candidate = identifier as IEditorIdentifier | undefined;
return typeof candidate?.groupId === 'number' && isEditorInput(candidate.editor);
}
/**
* The editor commands context is used for editor commands (e.g. in the editor title)
* and we must ensure that the context is serializable because it potentially travels
* to the extension host!
*/
export interface IEditorCommandsContext {
groupId: GroupIdentifier;
editorIndex?: number;
preserveFocus?: boolean;
}
/**
* More information around why an editor was closed in the model.
*/
export enum EditorCloseContext {
/**
* No specific context for closing (e.g. explicit user gesture).
*/
UNKNOWN,
/**
* The editor closed because it was replaced with another editor.
* This can either happen via explicit replace call or when an
* editor is in preview mode and another editor opens.
*/
REPLACE,
/**
* The editor closed as a result of moving it to another group.
*/
MOVE,
/**
* The editor closed because another editor turned into preview
* and this used to be the preview editor before.
*/
UNPIN
}
export interface IEditorCloseEvent extends IEditorIdentifier {
/**
* More information around why the editor was closed.
*/
readonly context: EditorCloseContext;
/**
* The index of the editor before closing.
*/
readonly index: number;
/**
* Whether the editor was sticky or not.
*/
readonly sticky: boolean;
}
export interface IActiveEditorChangeEvent {
/**
* The new active editor or `undefined` if the group is empty.
*/
editor: EditorInput | undefined;
}
export interface IEditorWillMoveEvent extends IEditorIdentifier {
/**
* The target group of the move operation.
*/
readonly target: GroupIdentifier;
}
export interface IEditorWillOpenEvent extends IEditorIdentifier { }
export type GroupIdentifier = number;
export const enum GroupModelChangeKind {
/* Group Changes */
GROUP_ACTIVE,
GROUP_INDEX,
GROUP_LOCKED,
/* Editor Changes */
EDITOR_OPEN,
EDITOR_CLOSE,
EDITOR_MOVE,
EDITOR_ACTIVE,
EDITOR_LABEL,
EDITOR_CAPABILITIES,
EDITOR_PIN,
EDITOR_STICKY,
EDITOR_DIRTY,
EDITOR_WILL_DISPOSE
}
export interface IWorkbenchEditorConfiguration {
workbench?: {
editor?: IEditorPartConfiguration;
iconTheme?: string;
};
}
interface IEditorPartConfiguration {
showTabs?: boolean;
wrapTabs?: boolean;
scrollToSwitchTabs?: boolean;
highlightModifiedTabs?: boolean;
tabCloseButton?: 'left' | 'right' | 'off';
tabSizing?: 'fit' | 'shrink';
pinnedTabSizing?: 'normal' | 'compact' | 'shrink';
titleScrollbarSizing?: 'default' | 'large';
focusRecentEditorAfterClose?: boolean;
showIcons?: boolean;
enablePreview?: boolean;
enablePreviewFromQuickOpen?: boolean;
enablePreviewFromCodeNavigation?: boolean;
closeOnFileDelete?: boolean;
openPositioning?: 'left' | 'right' | 'first' | 'last';
openSideBySideDirection?: 'right' | 'down';
closeEmptyGroups?: boolean;
autoLockGroups?: Set<string>;
revealIfOpen?: boolean;
mouseBackForwardToNavigate?: boolean;
labelFormat?: 'default' | 'short' | 'medium' | 'long';
restoreViewState?: boolean;
splitInGroupLayout?: 'vertical' | 'horizontal';
splitSizing?: 'split' | 'distribute';
splitOnDragAndDrop?: boolean;
limit?: {
enabled?: boolean;
excludeDirty?: boolean;
value?: number;
perEditorGroup?: boolean;
};
decorations?: {
badges?: boolean;
colors?: boolean;
};
}
export interface IEditorPartOptions extends IEditorPartConfiguration {
hasIcons?: boolean;
}
export interface IEditorPartOptionsChangeEvent {
oldPartOptions: IEditorPartOptions;
newPartOptions: IEditorPartOptions;
}
export enum SideBySideEditor {
PRIMARY = 1,
SECONDARY = 2,
BOTH = 3,
ANY = 4
}
export interface IFindEditorOptions {
/**
* Whether to consider any or both side by side editor as matching.
* By default, side by side editors will not be considered
* as matching, even if the editor is opened in one of the sides.
*/
supportSideBySide?: SideBySideEditor.PRIMARY | SideBySideEditor.SECONDARY | SideBySideEditor.ANY;
}
export interface IMatchEditorOptions {
/**
* Whether to consider a side by side editor as matching.
* By default, side by side editors will not be considered
* as matching, even if the editor is opened in one of the sides.
*/
supportSideBySide?: SideBySideEditor.ANY | SideBySideEditor.BOTH;
/**
* Only consider an editor to match when the
* `candidate === editor` but not when
* `candidate.matches(editor)`.
*/
strictEquals?: boolean;
}
export interface IEditorResourceAccessorOptions {
/**
* Allows to access the `resource(s)` of side by side editors. If not
* specified, a `resource` for a side by side editor will always be
* `undefined`.
*/
supportSideBySide?: SideBySideEditor;
/**
* Allows to filter the scheme to consider. A resource scheme that does
* not match a filter will not be considered.
*/
filterByScheme?: string | string[];
}
class EditorResourceAccessorImpl {
/**
* The original URI of an editor is the URI that was used originally to open
* the editor and should be used whenever the URI is presented to the user,
* e.g. as a label together with utility methods such as `ResourceLabel` or
* `ILabelService` that can turn this original URI into the best form for
* presenting.
*
* In contrast, the canonical URI (#getCanonicalUri) may be different and should
* be used whenever the URI is used to e.g. compare with other editors or when
* caching certain data based on the URI.
*
* For example: on Windows and macOS, the same file URI with different casing may
* point to the same file. The editor may chose to "normalize" the URI into a canonical
* form so that only one editor opens for same file URIs with different casing. As
* such, the original URI and the canonical URI can be different.
*/
getOriginalUri(editor: EditorInput | IUntypedEditorInput | undefined | null): URI | undefined;
getOriginalUri(editor: EditorInput | IUntypedEditorInput | undefined | null, options: IEditorResourceAccessorOptions & { supportSideBySide?: SideBySideEditor.PRIMARY | SideBySideEditor.SECONDARY | SideBySideEditor.ANY }): URI | undefined;
getOriginalUri(editor: EditorInput | IUntypedEditorInput | undefined | null, options: IEditorResourceAccessorOptions & { supportSideBySide: SideBySideEditor.BOTH }): URI | { primary?: URI; secondary?: URI } | undefined;
getOriginalUri(editor: EditorInput | IUntypedEditorInput | undefined | null, options?: IEditorResourceAccessorOptions): URI | { primary?: URI; secondary?: URI } | undefined {
if (!editor) {
return undefined;
}
// Optionally support side-by-side editors
if (options?.supportSideBySide) {
const { primary, secondary } = this.getSideEditors(editor);
if (primary && secondary) {
if (options?.supportSideBySide === SideBySideEditor.BOTH) {
return {
primary: this.getOriginalUri(primary, { filterByScheme: options.filterByScheme }),
secondary: this.getOriginalUri(secondary, { filterByScheme: options.filterByScheme })
};
} else if (options?.supportSideBySide === SideBySideEditor.ANY) {
return this.getOriginalUri(primary, { filterByScheme: options.filterByScheme }) ?? this.getOriginalUri(secondary, { filterByScheme: options.filterByScheme });
}
editor = options.supportSideBySide === SideBySideEditor.PRIMARY ? primary : secondary;
}
}
if (isResourceDiffEditorInput(editor) || isResourceSideBySideEditorInput(editor)) {
return;
}
// Original URI is the `preferredResource` of an editor if any
const originalResource = isEditorInputWithPreferredResource(editor) ? editor.preferredResource : editor.resource;
if (!originalResource || !options || !options.filterByScheme) {
return originalResource;
}
return this.filterUri(originalResource, options.filterByScheme);
}
private getSideEditors(editor: EditorInput | IUntypedEditorInput): { primary: EditorInput | IUntypedEditorInput | undefined; secondary: EditorInput | IUntypedEditorInput | undefined } {
if (isSideBySideEditorInput(editor) || isResourceSideBySideEditorInput(editor)) {
return { primary: editor.primary, secondary: editor.secondary };
}
if (isDiffEditorInput(editor) || isResourceDiffEditorInput(editor)) {
return { primary: editor.modified, secondary: editor.original };
}
return { primary: undefined, secondary: undefined };
}
/**
* The canonical URI of an editor is the true unique identifier of the editor
* and should be used whenever the URI is used e.g. to compare with other
* editors or when caching certain data based on the URI.
*
* In contrast, the original URI (#getOriginalUri) may be different and should
* be used whenever the URI is presented to the user, e.g. as a label.
*
* For example: on Windows and macOS, the same file URI with different casing may
* point to the same file. The editor may chose to "normalize" the URI into a canonical
* form so that only one editor opens for same file URIs with different casing. As
* such, the original URI and the canonical URI can be different.
*/
getCanonicalUri(editor: EditorInput | IUntypedEditorInput | undefined | null): URI | undefined;
getCanonicalUri(editor: EditorInput | IUntypedEditorInput | undefined | null, options: IEditorResourceAccessorOptions & { supportSideBySide?: SideBySideEditor.PRIMARY | SideBySideEditor.SECONDARY | SideBySideEditor.ANY }): URI | undefined;
getCanonicalUri(editor: EditorInput | IUntypedEditorInput | undefined | null, options: IEditorResourceAccessorOptions & { supportSideBySide: SideBySideEditor.BOTH }): URI | { primary?: URI; secondary?: URI } | undefined;
getCanonicalUri(editor: EditorInput | IUntypedEditorInput | undefined | null, options?: IEditorResourceAccessorOptions): URI | { primary?: URI; secondary?: URI } | undefined {
if (!editor) {
return undefined;
}
// Optionally support side-by-side editors
if (options?.supportSideBySide) {
const { primary, secondary } = this.getSideEditors(editor);
if (primary && secondary) {
if (options?.supportSideBySide === SideBySideEditor.BOTH) {
return {
primary: this.getCanonicalUri(primary, { filterByScheme: options.filterByScheme }),
secondary: this.getCanonicalUri(secondary, { filterByScheme: options.filterByScheme })
};
} else if (options?.supportSideBySide === SideBySideEditor.ANY) {
return this.getCanonicalUri(primary, { filterByScheme: options.filterByScheme }) ?? this.getCanonicalUri(secondary, { filterByScheme: options.filterByScheme });
}
editor = options.supportSideBySide === SideBySideEditor.PRIMARY ? primary : secondary;
}
}
if (isResourceDiffEditorInput(editor) || isResourceSideBySideEditorInput(editor)) {
return;
}
// Canonical URI is the `resource` of an editor
const canonicalResource = editor.resource;
if (!canonicalResource || !options || !options.filterByScheme) {
return canonicalResource;
}
return this.filterUri(canonicalResource, options.filterByScheme);
}
private filterUri(resource: URI, filter: string | string[]): URI | undefined {
// Multiple scheme filter
if (Array.isArray(filter)) {
if (filter.some(scheme => resource.scheme === scheme)) {
return resource;
}
}
// Single scheme filter
else {
if (filter === resource.scheme) {
return resource;
}
}
return undefined;
}
}
export const EditorResourceAccessor = new EditorResourceAccessorImpl();
export const enum CloseDirection {
LEFT,
RIGHT
}
export interface IEditorMemento<T> {
saveEditorState(group: IEditorGroup, resource: URI, state: T): void;
saveEditorState(group: IEditorGroup, editor: EditorInput, state: T): void;
loadEditorState(group: IEditorGroup, resource: URI): T | undefined;
loadEditorState(group: IEditorGroup, editor: EditorInput): T | undefined;
clearEditorState(resource: URI, group?: IEditorGroup): void;
clearEditorState(editor: EditorInput, group?: IEditorGroup): void;
clearEditorStateOnDispose(resource: URI, editor: EditorInput): void;
moveEditorState(source: URI, target: URI, comparer: IExtUri): void;
}
class EditorFactoryRegistry implements IEditorFactoryRegistry {
private instantiationService: IInstantiationService | undefined;
private fileEditorFactory: IFileEditorFactory | undefined;
private readonly editorSerializerConstructors = new Map<string /* Type ID */, IConstructorSignature<IEditorSerializer>>();
private readonly editorSerializerInstances = new Map<string /* Type ID */, IEditorSerializer>();
start(accessor: ServicesAccessor): void {
const instantiationService = this.instantiationService = accessor.get(IInstantiationService);
for (const [key, ctor] of this.editorSerializerConstructors) {
this.createEditorSerializer(key, ctor, instantiationService);
}
this.editorSerializerConstructors.clear();
}
private createEditorSerializer(editorTypeId: string, ctor: IConstructorSignature<IEditorSerializer>, instantiationService: IInstantiationService): void {
const instance = instantiationService.createInstance(ctor);
this.editorSerializerInstances.set(editorTypeId, instance);
}
registerFileEditorFactory(factory: IFileEditorFactory): void {
if (this.fileEditorFactory) {
throw new Error('Can only register one file editor factory.');
}
this.fileEditorFactory = factory;
}
getFileEditorFactory(): IFileEditorFactory {
return assertIsDefined(this.fileEditorFactory);
}
registerEditorSerializer(editorTypeId: string, ctor: IConstructorSignature<IEditorSerializer>): IDisposable {
if (this.editorSerializerConstructors.has(editorTypeId) || this.editorSerializerInstances.has(editorTypeId)) {
throw new Error(`A editor serializer with type ID '${editorTypeId}' was already registered.`);
}
if (!this.instantiationService) {
this.editorSerializerConstructors.set(editorTypeId, ctor);
} else {
this.createEditorSerializer(editorTypeId, ctor, this.instantiationService);
}
return toDisposable(() => {
this.editorSerializerConstructors.delete(editorTypeId);
this.editorSerializerInstances.delete(editorTypeId);
});
}
getEditorSerializer(editor: EditorInput): IEditorSerializer | undefined;
getEditorSerializer(editorTypeId: string): IEditorSerializer | undefined;
getEditorSerializer(arg1: string | EditorInput): IEditorSerializer | undefined {
return this.editorSerializerInstances.get(typeof arg1 === 'string' ? arg1 : arg1.typeId);
}
}
Registry.add(EditorExtensions.EditorFactory, new EditorFactoryRegistry());
export async function pathsToEditors(paths: IPathData[] | undefined, fileService: IFileService): Promise<(IResourceEditorInput | IUntitledTextResourceEditorInput)[]> {
if (!paths || !paths.length) {
return [];
}
const editors = await Promise.all(paths.map(async path => {
const resource = URI.revive(path.fileUri);
if (!resource) {
return;
}
const canHandleResource = await fileService.canHandleResource(resource);
if (!canHandleResource) {
return;
}
let exists = path.exists;
let type = path.type;
if (typeof exists !== 'boolean' || typeof type !== 'number') {
try {
type = (await fileService.stat(resource)).isDirectory ? FileType.Directory : FileType.Unknown;
exists = true;
} catch {
exists = false;
}
}
if (!exists && path.openOnlyIfExists) {
return;
}
if (type === FileType.Directory) {
return;
}
const options: IEditorOptions = {
...path.options,
pinned: true
};
let input: IResourceEditorInput | IUntitledTextResourceEditorInput;
if (!exists) {
input = { resource, options, forceUntitled: true };
} else {
input = { resource, options };
}
return input;
}));
return coalesce(editors);
}
export const enum EditorsOrder {
/**
* Editors sorted by most recent activity (most recent active first)
*/
MOST_RECENTLY_ACTIVE,
/**
* Editors sorted by sequential order
*/
SEQUENTIAL
}
export function isTextEditorViewState(candidate: unknown): candidate is IEditorViewState {
const viewState = candidate as IEditorViewState | undefined;
if (!viewState) {
return false;
}
const diffEditorViewState = viewState as IDiffEditorViewState;
if (diffEditorViewState.modified) {
return isTextEditorViewState(diffEditorViewState.modified);
}
const codeEditorViewState = viewState as ICodeEditorViewState;
return !!(codeEditorViewState.contributionsState && codeEditorViewState.viewState && Array.isArray(codeEditorViewState.cursorState));
}
|