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
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { Event, Emitter } from 'vs/base/common/event';
import { IEditorFactoryRegistry, GroupIdentifier, EditorsOrder, EditorExtensions, IUntypedEditorInput, SideBySideEditor, EditorCloseContext, IMatchEditorOptions, GroupModelChangeKind } from 'vs/workbench/common/editor';
import { EditorInput } from 'vs/workbench/common/editor/editorInput';
import { SideBySideEditorInput } from 'vs/workbench/common/editor/sideBySideEditorInput';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
import { dispose, Disposable, DisposableStore } from 'vs/base/common/lifecycle';
import { Registry } from 'vs/platform/registry/common/platform';
import { coalesce } from 'vs/base/common/arrays';
const EditorOpenPositioning = {
LEFT: 'left',
RIGHT: 'right',
FIRST: 'first',
LAST: 'last'
};
export interface IEditorOpenOptions {
readonly pinned?: boolean;
sticky?: boolean;
active?: boolean;
readonly index?: number;
readonly supportSideBySide?: SideBySideEditor.ANY | SideBySideEditor.BOTH;
}
export interface IEditorOpenResult {
readonly editor: EditorInput;
readonly isNew: boolean;
}
export interface ISerializedEditorInput {
readonly id: string;
readonly value: string;
}
export interface ISerializedEditorGroupModel {
readonly id: number;
readonly locked?: boolean;
readonly editors: ISerializedEditorInput[];
readonly mru: number[];
readonly preview?: number;
sticky?: number;
}
export function isSerializedEditorGroupModel(group?: unknown): group is ISerializedEditorGroupModel {
const candidate = group as ISerializedEditorGroupModel | undefined;
return !!(candidate && typeof candidate === 'object' && Array.isArray(candidate.editors) && Array.isArray(candidate.mru));
}
export interface IMatchOptions {
/**
* 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.
*/
readonly supportSideBySide?: SideBySideEditor.ANY | SideBySideEditor.BOTH;
/**
* Only consider an editor to match when the
* `candidate === editor` but not when
* `candidate.matches(editor)`.
*/
readonly strictEquals?: boolean;
}
export interface IGroupModelChangeEvent {
/**
* The kind of change that occurred in the group model.
*/
readonly kind: GroupModelChangeKind;
/**
* Only applies when editors change providing
* access to the editor the event is about.
*/
readonly editor?: EditorInput;
/**
* Only applies when editors change providing
* access to the index of the editor the event
* is about.
*/
readonly editorIndex?: number;
}
export interface IGroupEditorChangeEvent extends IGroupModelChangeEvent {
readonly editor: EditorInput;
readonly editorIndex: number;
}
export function isGroupEditorChangeEvent(e: IGroupModelChangeEvent): e is IGroupEditorChangeEvent {
const candidate = e as IGroupEditorOpenEvent;
return candidate.editor && candidate.editorIndex !== undefined;
}
export interface IGroupEditorOpenEvent extends IGroupEditorChangeEvent {
readonly kind: GroupModelChangeKind.EDITOR_OPEN;
}
export function isGroupEditorOpenEvent(e: IGroupModelChangeEvent): e is IGroupEditorOpenEvent {
const candidate = e as IGroupEditorOpenEvent;
return candidate.kind === GroupModelChangeKind.EDITOR_OPEN && candidate.editorIndex !== undefined;
}
export interface IGroupEditorMoveEvent extends IGroupEditorChangeEvent {
readonly kind: GroupModelChangeKind.EDITOR_MOVE;
/**
* Signifies the index the editor is moving from.
* `editorIndex` will contain the index the editor
* is moving to.
*/
readonly oldEditorIndex: number;
}
export function isGroupEditorMoveEvent(e: IGroupModelChangeEvent): e is IGroupEditorMoveEvent {
const candidate = e as IGroupEditorMoveEvent;
return candidate.kind === GroupModelChangeKind.EDITOR_MOVE && candidate.editorIndex !== undefined && candidate.oldEditorIndex !== undefined;
}
export interface IGroupEditorCloseEvent extends IGroupEditorChangeEvent {
readonly kind: GroupModelChangeKind.EDITOR_CLOSE;
/**
* Signifies the context in which the editor
* is being closed. This allows for understanding
* if a replace or reopen is occurring
*/
readonly context: EditorCloseContext;
/**
* Signifies whether or not the closed editor was
* sticky. This is necessary becasue state is lost
* after closing.
*/
readonly sticky: boolean;
}
export function isGroupEditorCloseEvent(e: IGroupModelChangeEvent): e is IGroupEditorCloseEvent {
const candidate = e as IGroupEditorCloseEvent;
return candidate.kind === GroupModelChangeKind.EDITOR_CLOSE && candidate.editorIndex !== undefined && candidate.context !== undefined && candidate.sticky !== undefined;
}
interface IEditorCloseResult {
readonly editor: EditorInput;
readonly context: EditorCloseContext;
readonly editorIndex: number;
readonly sticky: boolean;
}
export class EditorGroupModel extends Disposable {
private static IDS = 0;
//#region events
private readonly _onDidModelChange = this._register(new Emitter<IGroupModelChangeEvent>());
readonly onDidModelChange = this._onDidModelChange.event;
//#endregion
private _id: GroupIdentifier;
get id(): GroupIdentifier { return this._id; }
private editors: EditorInput[] = [];
private mru: EditorInput[] = [];
private locked = false;
private preview: EditorInput | null = null; // editor in preview state
private active: EditorInput | null = null; // editor in active state
private sticky = -1; // index of first editor in sticky state
private editorOpenPositioning: ('left' | 'right' | 'first' | 'last') | undefined;
private focusRecentEditorAfterClose: boolean | undefined;
constructor(
labelOrSerializedGroup: ISerializedEditorGroupModel | undefined,
@IInstantiationService private readonly instantiationService: IInstantiationService,
@IConfigurationService private readonly configurationService: IConfigurationService
) {
super();
if (isSerializedEditorGroupModel(labelOrSerializedGroup)) {
this._id = this.deserialize(labelOrSerializedGroup);
} else {
this._id = EditorGroupModel.IDS++;
}
this.onConfigurationUpdated();
this.registerListeners();
}
private registerListeners(): void {
this._register(this.configurationService.onDidChangeConfiguration(() => this.onConfigurationUpdated()));
}
private onConfigurationUpdated(): void {
this.editorOpenPositioning = this.configurationService.getValue('workbench.editor.openPositioning');
this.focusRecentEditorAfterClose = this.configurationService.getValue('workbench.editor.focusRecentEditorAfterClose');
}
get count(): number {
return this.editors.length;
}
get stickyCount(): number {
return this.sticky + 1;
}
getEditors(order: EditorsOrder, options?: { excludeSticky?: boolean }): EditorInput[] {
const editors = order === EditorsOrder.MOST_RECENTLY_ACTIVE ? this.mru.slice(0) : this.editors.slice(0);
if (options?.excludeSticky) {
// MRU: need to check for index on each
if (order === EditorsOrder.MOST_RECENTLY_ACTIVE) {
return editors.filter(editor => !this.isSticky(editor));
}
// Sequential: simply start after sticky index
return editors.slice(this.sticky + 1);
}
return editors;
}
getEditorByIndex(index: number): EditorInput | undefined {
return this.editors[index];
}
get activeEditor(): EditorInput | null {
return this.active;
}
isActive(editor: EditorInput | IUntypedEditorInput): boolean {
return this.matches(this.active, editor);
}
get previewEditor(): EditorInput | null {
return this.preview;
}
openEditor(candidate: EditorInput, options?: IEditorOpenOptions): IEditorOpenResult {
const makeSticky = options?.sticky || (typeof options?.index === 'number' && this.isSticky(options.index));
const makePinned = options?.pinned || options?.sticky;
const makeActive = options?.active || !this.activeEditor || (!makePinned && this.matches(this.preview, this.activeEditor));
const existingEditorAndIndex = this.findEditor(candidate, options);
// New editor
if (!existingEditorAndIndex) {
const newEditor = candidate;
const indexOfActive = this.indexOf(this.active);
// Insert into specific position
let targetIndex: number;
if (options && typeof options.index === 'number') {
targetIndex = options.index;
}
// Insert to the BEGINNING
else if (this.editorOpenPositioning === EditorOpenPositioning.FIRST) {
targetIndex = 0;
// Always make sure targetIndex is after sticky editors
// unless we are explicitly told to make the editor sticky
if (!makeSticky && this.isSticky(targetIndex)) {
targetIndex = this.sticky + 1;
}
}
// Insert to the END
else if (this.editorOpenPositioning === EditorOpenPositioning.LAST) {
targetIndex = this.editors.length;
}
// Insert to LEFT or RIGHT of active editor
else {
// Insert to the LEFT of active editor
if (this.editorOpenPositioning === EditorOpenPositioning.LEFT) {
if (indexOfActive === 0 || !this.editors.length) {
targetIndex = 0; // to the left becoming first editor in list
} else {
targetIndex = indexOfActive; // to the left of active editor
}
}
// Insert to the RIGHT of active editor
else {
targetIndex = indexOfActive + 1;
}
// Always make sure targetIndex is after sticky editors
// unless we are explicitly told to make the editor sticky
if (!makeSticky && this.isSticky(targetIndex)) {
targetIndex = this.sticky + 1;
}
}
// If the editor becomes sticky, increment the sticky index and adjust
// the targetIndex to be at the end of sticky editors unless already.
if (makeSticky) {
this.sticky++;
if (!this.isSticky(targetIndex)) {
targetIndex = this.sticky;
}
}
// Insert into our list of editors if pinned or we have no preview editor
if (makePinned || !this.preview) {
this.splice(targetIndex, false, newEditor);
}
// Handle preview
if (!makePinned) {
// Replace existing preview with this editor if we have a preview
if (this.preview) {
const indexOfPreview = this.indexOf(this.preview);
if (targetIndex > indexOfPreview) {
targetIndex--; // accomodate for the fact that the preview editor closes
}
this.replaceEditor(this.preview, newEditor, targetIndex, !makeActive);
}
this.preview = newEditor;
}
// Listeners
this.registerEditorListeners(newEditor);
// Event
const event: IGroupEditorOpenEvent = {
kind: GroupModelChangeKind.EDITOR_OPEN,
editor: newEditor,
editorIndex: targetIndex
};
this._onDidModelChange.fire(event);
// Handle active
if (makeActive) {
this.doSetActive(newEditor, targetIndex);
}
return {
editor: newEditor,
isNew: true
};
}
// Existing editor
else {
const [existingEditor, existingEditorIndex] = existingEditorAndIndex;
// Pin it
if (makePinned) {
this.doPin(existingEditor, existingEditorIndex);
}
// Activate it
if (makeActive) {
this.doSetActive(existingEditor, existingEditorIndex);
}
// Respect index
if (options && typeof options.index === 'number') {
this.moveEditor(existingEditor, options.index);
}
// Stick it (intentionally after the moveEditor call in case
// the editor was already moved into the sticky range)
if (makeSticky) {
this.doStick(existingEditor, this.indexOf(existingEditor));
}
return {
editor: existingEditor,
isNew: false
};
}
}
private registerEditorListeners(editor: EditorInput): void {
const listeners = new DisposableStore();
// Re-emit disposal of editor input as our own event
listeners.add(Event.once(editor.onWillDispose)(() => {
const editorIndex = this.editors.indexOf(editor);
if (editorIndex >= 0) {
const event: IGroupEditorChangeEvent = {
kind: GroupModelChangeKind.EDITOR_WILL_DISPOSE,
editor,
editorIndex
};
this._onDidModelChange.fire(event);
}
}));
// Re-Emit dirty state changes
listeners.add(editor.onDidChangeDirty(() => {
const event: IGroupEditorChangeEvent = {
kind: GroupModelChangeKind.EDITOR_DIRTY,
editor,
editorIndex: this.editors.indexOf(editor)
};
this._onDidModelChange.fire(event);
}));
// Re-Emit label changes
listeners.add(editor.onDidChangeLabel(() => {
const event: IGroupEditorChangeEvent = {
kind: GroupModelChangeKind.EDITOR_LABEL,
editor,
editorIndex: this.editors.indexOf(editor)
};
this._onDidModelChange.fire(event);
}));
// Re-Emit capability changes
listeners.add(editor.onDidChangeCapabilities(() => {
const event: IGroupEditorChangeEvent = {
kind: GroupModelChangeKind.EDITOR_CAPABILITIES,
editor,
editorIndex: this.editors.indexOf(editor)
};
this._onDidModelChange.fire(event);
}));
// Clean up dispose listeners once the editor gets closed
listeners.add(this.onDidModelChange(event => {
if (event.kind === GroupModelChangeKind.EDITOR_CLOSE && event.editor?.matches(editor)) {
dispose(listeners);
}
}));
}
private replaceEditor(toReplace: EditorInput, replaceWith: EditorInput, replaceIndex: number, openNext = true): void {
const closeResult = this.doCloseEditor(toReplace, EditorCloseContext.REPLACE, openNext); // optimization to prevent multiple setActive() in one call
// We want to first add the new editor into our model before emitting the close event because
// firing the close event can trigger a dispose on the same editor that is now being added.
// This can lead into opening a disposed editor which is not what we want.
this.splice(replaceIndex, false, replaceWith);
if (closeResult) {
const event: IGroupEditorCloseEvent = {
kind: GroupModelChangeKind.EDITOR_CLOSE,
...closeResult
};
this._onDidModelChange.fire(event);
}
}
closeEditor(candidate: EditorInput, context = EditorCloseContext.UNKNOWN, openNext = true): IEditorCloseResult | undefined {
const closeResult = this.doCloseEditor(candidate, context, openNext);
if (closeResult) {
const event: IGroupEditorCloseEvent = {
kind: GroupModelChangeKind.EDITOR_CLOSE,
...closeResult
};
this._onDidModelChange.fire(event);
return closeResult;
}
return undefined;
}
private doCloseEditor(candidate: EditorInput, context: EditorCloseContext, openNext: boolean): IEditorCloseResult | undefined {
const index = this.indexOf(candidate);
if (index === -1) {
return undefined; // not found
}
const editor = this.editors[index];
const sticky = this.isSticky(index);
// Active Editor closed
if (openNext && this.matches(this.active, editor)) {
// More than one editor
if (this.mru.length > 1) {
let newActive: EditorInput;
if (this.focusRecentEditorAfterClose) {
newActive = this.mru[1]; // active editor is always first in MRU, so pick second editor after as new active
} else {
if (index === this.editors.length - 1) {
newActive = this.editors[index - 1]; // last editor is closed, pick previous as new active
} else {
newActive = this.editors[index + 1]; // pick next editor as new active
}
}
this.doSetActive(newActive, this.editors.indexOf(newActive));
}
// One Editor
else {
this.active = null;
}
}
// Preview Editor closed
if (this.matches(this.preview, editor)) {
this.preview = null;
}
// Remove from arrays
this.splice(index, true);
// Event
return { editor, sticky, editorIndex: index, context };
}
moveEditor(candidate: EditorInput, toIndex: number): EditorInput | undefined {
// Ensure toIndex is in bounds of our model
if (toIndex >= this.editors.length) {
toIndex = this.editors.length - 1;
} else if (toIndex < 0) {
toIndex = 0;
}
const index = this.indexOf(candidate);
if (index < 0 || toIndex === index) {
return;
}
const editor = this.editors[index];
// Adjust sticky index: editor moved out of sticky state into unsticky state
if (this.isSticky(index) && toIndex > this.sticky) {
this.sticky--;
}
// ...or editor moved into sticky state from unsticky state
else if (!this.isSticky(index) && toIndex <= this.sticky) {
this.sticky++;
}
// Move
this.editors.splice(index, 1);
this.editors.splice(toIndex, 0, editor);
// Event
const event: IGroupEditorMoveEvent = {
kind: GroupModelChangeKind.EDITOR_MOVE,
editor,
oldEditorIndex: index,
editorIndex: toIndex
};
this._onDidModelChange.fire(event);
return editor;
}
setActive(candidate: EditorInput | undefined): EditorInput | undefined {
let result: EditorInput | undefined = undefined;
if (!candidate) {
this.setGroupActive();
} else {
result = this.setEditorActive(candidate);
}
return result;
}
private setGroupActive(): void {
// We do not really keep the `active` state in our model because
// it has no special meaning to us here. But for consistency
// we emit a `onDidModelChange` event so that components can
// react.
this._onDidModelChange.fire({ kind: GroupModelChangeKind.GROUP_ACTIVE });
}
private setEditorActive(candidate: EditorInput): EditorInput | undefined {
const res = this.findEditor(candidate);
if (!res) {
return; // not found
}
const [editor, editorIndex] = res;
this.doSetActive(editor, editorIndex);
return editor;
}
private doSetActive(editor: EditorInput, editorIndex: number): void {
if (this.matches(this.active, editor)) {
return; // already active
}
this.active = editor;
// Bring to front in MRU list
const mruIndex = this.indexOf(editor, this.mru);
this.mru.splice(mruIndex, 1);
this.mru.unshift(editor);
// Event
const event: IGroupEditorChangeEvent = {
kind: GroupModelChangeKind.EDITOR_ACTIVE,
editor,
editorIndex
};
this._onDidModelChange.fire(event);
}
setIndex(index: number) {
// We do not really keep the `index` in our model because
// it has no special meaning to us here. But for consistency
// we emit a `onDidModelChange` event so that components can
// react.
this._onDidModelChange.fire({ kind: GroupModelChangeKind.GROUP_INDEX });
}
pin(candidate: EditorInput): EditorInput | undefined {
const res = this.findEditor(candidate);
if (!res) {
return; // not found
}
const [editor, editorIndex] = res;
this.doPin(editor, editorIndex);
return editor;
}
private doPin(editor: EditorInput, editorIndex: number): void {
if (this.isPinned(editor)) {
return; // can only pin a preview editor
}
// Convert the preview editor to be a pinned editor
this.preview = null;
// Event
const event: IGroupEditorChangeEvent = {
kind: GroupModelChangeKind.EDITOR_PIN,
editor,
editorIndex
};
this._onDidModelChange.fire(event);
}
unpin(candidate: EditorInput): EditorInput | undefined {
const res = this.findEditor(candidate);
if (!res) {
return; // not found
}
const [editor, editorIndex] = res;
this.doUnpin(editor, editorIndex);
return editor;
}
private doUnpin(editor: EditorInput, editorIndex: number): void {
if (!this.isPinned(editor)) {
return; // can only unpin a pinned editor
}
// Set new
const oldPreview = this.preview;
this.preview = editor;
// Event
const event: IGroupEditorChangeEvent = {
kind: GroupModelChangeKind.EDITOR_PIN,
editor,
editorIndex
};
this._onDidModelChange.fire(event);
// Close old preview editor if any
if (oldPreview) {
this.closeEditor(oldPreview, EditorCloseContext.UNPIN);
}
}
isPinned(editorOrIndex: EditorInput | number): boolean {
let editor: EditorInput;
if (typeof editorOrIndex === 'number') {
editor = this.editors[editorOrIndex];
} else {
editor = editorOrIndex;
}
return !this.matches(this.preview, editor);
}
stick(candidate: EditorInput): EditorInput | undefined {
const res = this.findEditor(candidate);
if (!res) {
return; // not found
}
const [editor, editorIndex] = res;
this.doStick(editor, editorIndex);
return editor;
}
private doStick(editor: EditorInput, editorIndex: number): void {
if (this.isSticky(editorIndex)) {
return; // can only stick a non-sticky editor
}
// Pin editor
this.pin(editor);
// Move editor to be the last sticky editor
const newEditorIndex = this.sticky + 1;
this.moveEditor(editor, newEditorIndex);
// Adjust sticky index
this.sticky++;
// Event
const event: IGroupEditorChangeEvent = {
kind: GroupModelChangeKind.EDITOR_STICKY,
editor,
editorIndex: newEditorIndex
};
this._onDidModelChange.fire(event);
}
unstick(candidate: EditorInput): EditorInput | undefined {
const res = this.findEditor(candidate);
if (!res) {
return; // not found
}
const [editor, editorIndex] = res;
this.doUnstick(editor, editorIndex);
return editor;
}
private doUnstick(editor: EditorInput, editorIndex: number): void {
if (!this.isSticky(editorIndex)) {
return; // can only unstick a sticky editor
}
// Move editor to be the first non-sticky editor
const newEditorIndex = this.sticky;
this.moveEditor(editor, newEditorIndex);
// Adjust sticky index
this.sticky--;
// Event
const event: IGroupEditorChangeEvent = {
kind: GroupModelChangeKind.EDITOR_STICKY,
editor,
editorIndex: newEditorIndex
};
this._onDidModelChange.fire(event);
}
isSticky(candidateOrIndex: EditorInput | number): boolean {
if (this.sticky < 0) {
return false; // no sticky editor
}
let index: number;
if (typeof candidateOrIndex === 'number') {
index = candidateOrIndex;
} else {
index = this.indexOf(candidateOrIndex);
}
if (index < 0) {
return false;
}
return index <= this.sticky;
}
private splice(index: number, del: boolean, editor?: EditorInput): void {
const editorToDeleteOrReplace = this.editors[index];
// Perform on sticky index
if (del && this.isSticky(index)) {
this.sticky--;
}
// Perform on editors array
if (editor) {
this.editors.splice(index, del ? 1 : 0, editor);
} else {
this.editors.splice(index, del ? 1 : 0);
}
// Perform on MRU
{
// Add
if (!del && editor) {
if (this.mru.length === 0) {
// the list of most recent editors is empty
// so this editor can only be the most recent
this.mru.push(editor);
} else {
// we have most recent editors. as such we
// put this newly opened editor right after
// the current most recent one because it cannot
// be the most recently active one unless
// it becomes active. but it is still more
// active then any other editor in the list.
this.mru.splice(1, 0, editor);
}
}
// Remove / Replace
else {
const indexInMRU = this.indexOf(editorToDeleteOrReplace, this.mru);
// Remove
if (del && !editor) {
this.mru.splice(indexInMRU, 1); // remove from MRU
}
// Replace
else if (del && editor) {
this.mru.splice(indexInMRU, 1, editor); // replace MRU at location
}
}
}
}
indexOf(candidate: EditorInput | null, editors = this.editors, options?: IMatchEditorOptions): number {
let index = -1;
if (!candidate) {
return index;
}
for (let i = 0; i < editors.length; i++) {
const editor = editors[i];
if (this.matches(editor, candidate, options)) {
// If we are to support side by side matching, it is possible that
// a better direct match is found later. As such, we continue finding
// a matching editor and prefer that match over the side by side one.
if (options?.supportSideBySide && editor instanceof SideBySideEditorInput && !(candidate instanceof SideBySideEditorInput)) {
index = i;
} else {
index = i;
break;
}
}
}
return index;
}
private findEditor(candidate: EditorInput | null, options?: IMatchEditorOptions): [EditorInput, number /* index */] | undefined {
const index = this.indexOf(candidate, this.editors, options);
if (index === -1) {
return undefined;
}
return [this.editors[index], index];
}
isFirst(candidate: EditorInput | null): boolean {
return this.matches(this.editors[0], candidate);
}
isLast(candidate: EditorInput | null): boolean {
return this.matches(this.editors[this.editors.length - 1], candidate);
}
contains(candidate: EditorInput | IUntypedEditorInput, options?: IMatchEditorOptions): boolean {
for (const editor of this.editors) {
if (this.matches(editor, candidate, options)) {
return true;
}
}
return false;
}
private matches(editor: EditorInput | null, candidate: EditorInput | IUntypedEditorInput | null, options?: IMatchEditorOptions): boolean {
if (!editor || !candidate) {
return false;
}
if (options?.supportSideBySide && editor instanceof SideBySideEditorInput && !(candidate instanceof SideBySideEditorInput)) {
switch (options.supportSideBySide) {
case SideBySideEditor.ANY:
if (this.matches(editor.primary, candidate, options) || this.matches(editor.secondary, candidate, options)) {
return true;
}
break;
case SideBySideEditor.BOTH:
if (this.matches(editor.primary, candidate, options) && this.matches(editor.secondary, candidate, options)) {
return true;
}
break;
}
}
const strictEquals = editor === candidate;
if (options?.strictEquals) {
return strictEquals;
}
return strictEquals || editor.matches(candidate);
}
get isLocked(): boolean {
return this.locked;
}
lock(locked: boolean): void {
if (this.isLocked !== locked) {
this.locked = locked;
this._onDidModelChange.fire({ kind: GroupModelChangeKind.GROUP_LOCKED });
}
}
clone(): EditorGroupModel {
const clone = this.instantiationService.createInstance(EditorGroupModel, undefined);
// Copy over group properties
clone.editors = this.editors.slice(0);
clone.mru = this.mru.slice(0);
clone.preview = this.preview;
clone.active = this.active;
clone.sticky = this.sticky;
// Ensure to register listeners for each editor
for (const editor of clone.editors) {
clone.registerEditorListeners(editor);
}
return clone;
}
serialize(): ISerializedEditorGroupModel {
const registry = Registry.as<IEditorFactoryRegistry>(EditorExtensions.EditorFactory);
// Serialize all editor inputs so that we can store them.
// Editors that cannot be serialized need to be ignored
// from mru, active, preview and sticky if any.
let serializableEditors: EditorInput[] = [];
let serializedEditors: ISerializedEditorInput[] = [];
let serializablePreviewIndex: number | undefined;
let serializableSticky = this.sticky;
for (let i = 0; i < this.editors.length; i++) {
const editor = this.editors[i];
let canSerializeEditor = false;
const editorSerializer = registry.getEditorSerializer(editor);
if (editorSerializer) {
const value = editorSerializer.serialize(editor);
// Editor can be serialized
if (typeof value === 'string') {
canSerializeEditor = true;
serializedEditors.push({ id: editor.typeId, value });
serializableEditors.push(editor);
if (this.preview === editor) {
serializablePreviewIndex = serializableEditors.length - 1;
}
}
// Editor cannot be serialized
else {
canSerializeEditor = false;
}
}
// Adjust index of sticky editors if the editor cannot be serialized and is pinned
if (!canSerializeEditor && this.isSticky(i)) {
serializableSticky--;
}
}
const serializableMru = this.mru.map(editor => this.indexOf(editor, serializableEditors)).filter(i => i >= 0);
return {
id: this.id,
locked: this.locked ? true : undefined,
editors: serializedEditors,
mru: serializableMru,
preview: serializablePreviewIndex,
sticky: serializableSticky >= 0 ? serializableSticky : undefined
};
}
private deserialize(data: ISerializedEditorGroupModel): number {
const registry = Registry.as<IEditorFactoryRegistry>(EditorExtensions.EditorFactory);
if (typeof data.id === 'number') {
this._id = data.id;
EditorGroupModel.IDS = Math.max(data.id + 1, EditorGroupModel.IDS); // make sure our ID generator is always larger
} else {
this._id = EditorGroupModel.IDS++; // backwards compatibility
}
if (data.locked) {
this.locked = true;
}
this.editors = coalesce(data.editors.map((e, index) => {
let editor: EditorInput | undefined = undefined;
const editorSerializer = registry.getEditorSerializer(e.id);
if (editorSerializer) {
const deserializedEditor = editorSerializer.deserialize(this.instantiationService, e.value);
if (deserializedEditor instanceof EditorInput) {
editor = deserializedEditor;
this.registerEditorListeners(editor);
}
}
if (!editor && typeof data.sticky === 'number' && index <= data.sticky) {
data.sticky--; // if editor cannot be deserialized but was sticky, we need to decrease sticky index
}
return editor;
}));
this.mru = coalesce(data.mru.map(i => this.editors[i]));
this.active = this.mru[0];
if (typeof data.preview === 'number') {
this.preview = this.editors[data.preview];
}
if (typeof data.sticky === 'number') {
this.sticky = data.sticky;
}
return this._id;
}
}
|