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
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { CancellationToken } from 'vs/base/common/cancellation';
import { Event } from 'vs/base/common/event';
import { IDisposable } from 'vs/base/common/lifecycle';
import { URI } from 'vs/base/common/uri';
import { IEditorContributionDescription } from 'vs/editor/browser/editorExtensions';
import * as editorCommon from 'vs/editor/common/editorCommon';
import { FontInfo } from 'vs/editor/common/config/fontInfo';
import { IPosition } from 'vs/editor/common/core/position';
import { IRange, Range } from 'vs/editor/common/core/range';
import { FindMatch, IModelDeltaDecoration, IReadonlyTextBuffer, ITextModel, TrackedRangeStickiness } from 'vs/editor/common/model';
import { MenuId } from 'vs/platform/actions/common/actions';
import { ITextEditorOptions, ITextResourceEditorInput } from 'vs/platform/editor/common/editor';
import { IConstructorSignature } from 'vs/platform/instantiation/common/instantiation';
import { IEditorPane } from 'vs/workbench/common/editor';
import { CellViewModelStateChangeEvent, NotebookCellStateChangedEvent, NotebookLayoutInfo } from 'vs/workbench/contrib/notebook/browser/notebookViewEvents';
import { NotebookCellTextModel } from 'vs/workbench/contrib/notebook/common/model/notebookCellTextModel';
import { NotebookTextModel } from 'vs/workbench/contrib/notebook/common/model/notebookTextModel';
import { CellKind, ICellOutput, INotebookCellStatusBarItem, INotebookRendererInfo, INotebookSearchOptions, IOrderedMimeType, NotebookCellInternalMetadata, NotebookCellMetadata, NOTEBOOK_EDITOR_ID } from 'vs/workbench/contrib/notebook/common/notebookCommon';
import { isCompositeNotebookEditorInput } from 'vs/workbench/contrib/notebook/common/notebookEditorInput';
import { INotebookKernel } from 'vs/workbench/contrib/notebook/common/notebookKernelService';
import { NotebookOptions } from 'vs/workbench/contrib/notebook/common/notebookOptions';
import { cellRangesToIndexes, ICellRange, reduceCellRanges } from 'vs/workbench/contrib/notebook/common/notebookRange';
import { IWebview } from 'vs/workbench/contrib/webview/browser/webview';
import { IEditorOptions } from 'vs/editor/common/config/editorOptions';
//#region Shared commands
export const EXPAND_CELL_INPUT_COMMAND_ID = 'notebook.cell.expandCellInput';
export const EXECUTE_CELL_COMMAND_ID = 'notebook.cell.execute';
export const DETECT_CELL_LANGUAGE = 'notebook.cell.detectLanguage';
export const CHANGE_CELL_LANGUAGE = 'notebook.cell.changeLanguage';
export const QUIT_EDIT_CELL_COMMAND_ID = 'notebook.cell.quitEdit';
export const EXPAND_CELL_OUTPUT_COMMAND_ID = 'notebook.cell.expandCellOutput';
//#endregion
//#region Notebook extensions
// Hardcoding viewType/extension ID for now. TODO these should be replaced once we can
// look them up in the marketplace dynamically.
export const IPYNB_VIEW_TYPE = 'jupyter-notebook';
export const JUPYTER_EXTENSION_ID = 'ms-toolsai.jupyter';
/** @deprecated use the notebookKernel<Type> "keyword" instead */
export const KERNEL_EXTENSIONS = new Map<string, string>([
[IPYNB_VIEW_TYPE, JUPYTER_EXTENSION_ID],
]);
// @TODO lramos15, place this in a similar spot to our normal recommendations.
export const KERNEL_RECOMMENDATIONS = new Map<string, Map<string, INotebookExtensionRecommendation>>();
KERNEL_RECOMMENDATIONS.set(IPYNB_VIEW_TYPE, new Map<string, INotebookExtensionRecommendation>());
KERNEL_RECOMMENDATIONS.get(IPYNB_VIEW_TYPE)?.set('python', {
extensionId: 'ms-python.python',
displayName: 'Python + Jupyter',
});
export interface INotebookExtensionRecommendation {
extensionId: string;
displayName?: string;
}
//#endregion
//#region Output related types
// !! IMPORTANT !! ----------------------------------------------------------------------------------
// NOTE that you MUST update vs/workbench/contrib/notebook/browser/view/renderers/webviewPreloads.ts#L1986
// whenever changing the values of this const enum. The webviewPreloads-files manually inlines these values
// because it cannot have dependencies.
// !! IMPORTANT !! ----------------------------------------------------------------------------------
export const enum RenderOutputType {
Html = 0,
Extension = 1
}
export interface IRenderPlainHtmlOutput {
type: RenderOutputType.Html;
source: IDisplayOutputViewModel;
htmlContent: string;
}
export interface IRenderOutputViaExtension {
type: RenderOutputType.Extension;
source: IDisplayOutputViewModel;
mimeType: string;
renderer: INotebookRendererInfo;
}
export type IInsetRenderOutput = IRenderPlainHtmlOutput | IRenderOutputViaExtension;
export interface ICellOutputViewModel extends IDisposable {
cellViewModel: IGenericCellViewModel;
/**
* When rendering an output, `model` should always be used as we convert legacy `text/error` output to `display_data` output under the hood.
*/
model: ICellOutput;
resolveMimeTypes(textModel: NotebookTextModel, kernelProvides: readonly string[] | undefined): [readonly IOrderedMimeType[], number];
pickedMimeType: IOrderedMimeType | undefined;
hasMultiMimeType(): boolean;
toRawJSON(): any;
}
export interface IDisplayOutputViewModel extends ICellOutputViewModel {
resolveMimeTypes(textModel: NotebookTextModel, kernelProvides: readonly string[] | undefined): [readonly IOrderedMimeType[], number];
}
//#endregion
//#region Shared types between the Notebook Editor and Notebook Diff Editor, they are mostly used for output rendering
export interface IGenericCellViewModel {
id: string;
handle: number;
uri: URI;
metadata: NotebookCellMetadata;
outputIsHovered: boolean;
outputIsFocused: boolean;
outputsViewModels: ICellOutputViewModel[];
getOutputOffset(index: number): number;
updateOutputHeight(index: number, height: number, source?: string): void;
}
export interface IDisplayOutputLayoutUpdateRequest {
readonly cell: IGenericCellViewModel;
output: IDisplayOutputViewModel;
cellTop: number;
outputOffset: number;
forceDisplay: boolean;
}
export interface ICommonCellInfo {
cellId: string;
cellHandle: number;
cellUri: URI;
}
export interface IFocusNotebookCellOptions {
readonly skipReveal?: boolean;
readonly focusEditorLine?: number;
}
//#endregion
export enum CellLayoutState {
Uninitialized,
Estimated,
FromCache,
Measured
}
export interface CodeCellLayoutInfo {
readonly fontInfo: FontInfo | null;
readonly editorHeight: number;
readonly editorWidth: number;
readonly statusBarHeight: number;
readonly commentHeight: number;
readonly totalHeight: number;
readonly outputContainerOffset: number;
readonly outputTotalHeight: number;
readonly outputShowMoreContainerHeight: number;
readonly outputShowMoreContainerOffset: number;
readonly bottomToolbarOffset: number;
readonly layoutState: CellLayoutState;
readonly codeIndicatorHeight: number;
readonly outputIndicatorHeight: number;
}
export interface CodeCellLayoutChangeEvent {
source?: string;
editorHeight?: boolean;
commentHeight?: boolean;
outputHeight?: boolean;
outputShowMoreContainerHeight?: number;
totalHeight?: boolean;
outerWidth?: number;
font?: FontInfo;
}
export interface MarkdownCellLayoutInfo {
readonly fontInfo: FontInfo | null;
readonly editorWidth: number;
readonly editorHeight: number;
readonly statusBarHeight: number;
readonly previewHeight: number;
readonly bottomToolbarOffset: number;
readonly totalHeight: number;
readonly layoutState: CellLayoutState;
readonly foldHintHeight: number;
}
export enum CellLayoutContext {
Fold
}
export interface MarkdownCellLayoutChangeEvent {
font?: FontInfo;
outerWidth?: number;
editorHeight?: number;
previewHeight?: number;
totalHeight?: number;
context?: CellLayoutContext;
}
export interface ICommonCellViewModelLayoutChangeInfo {
totalHeight?: boolean | number;
outerWidth?: number;
context?: CellLayoutContext;
}
export interface ICellViewModel extends IGenericCellViewModel {
readonly model: NotebookCellTextModel;
readonly id: string;
readonly textBuffer: IReadonlyTextBuffer;
readonly layoutInfo: { totalHeight: number; bottomToolbarOffset: number; editorWidth: number; editorHeight: number; statusBarHeight: number };
readonly onDidChangeLayout: Event<ICommonCellViewModelLayoutChangeInfo>;
readonly onDidChangeCellStatusBarItems: Event<void>;
readonly onCellDecorationsChanged: Event<{ added: INotebookCellDecorationOptions[]; removed: INotebookCellDecorationOptions[] }>;
readonly onDidChangeState: Event<CellViewModelStateChangeEvent>;
readonly editStateSource: string;
readonly editorAttached: boolean;
isInputCollapsed: boolean;
isOutputCollapsed: boolean;
dragging: boolean;
handle: number;
uri: URI;
language: string;
readonly mime: string;
cellKind: CellKind;
lineNumbers: 'on' | 'off' | 'inherit';
focusMode: CellFocusMode;
outputIsHovered: boolean;
getText(): string;
getTextLength(): number;
getHeight(lineHeight: number): number;
metadata: NotebookCellMetadata;
internalMetadata: NotebookCellInternalMetadata;
textModel: ITextModel | undefined;
hasModel(): this is IEditableCellViewModel;
resolveTextModel(): Promise<ITextModel>;
getSelectionsStartPosition(): IPosition[] | undefined;
getCellDecorations(): INotebookCellDecorationOptions[];
getCellStatusBarItems(): INotebookCellStatusBarItem[];
getEditState(): CellEditState;
updateEditState(state: CellEditState, source: string): void;
deltaModelDecorations(oldDecorations: string[], newDecorations: IModelDeltaDecoration[]): string[];
getCellDecorationRange(id: string): Range | null;
}
export interface IEditableCellViewModel extends ICellViewModel {
textModel: ITextModel;
}
export interface INotebookEditorMouseEvent {
readonly event: MouseEvent;
readonly target: ICellViewModel;
}
export interface INotebookEditorContribution {
/**
* Dispose this contribution.
*/
dispose(): void;
/**
* Store view state.
*/
saveViewState?(): unknown;
/**
* Restore view state.
*/
restoreViewState?(state: unknown): void;
}
export interface INotebookCellDecorationOptions {
className?: string;
gutterClassName?: string;
outputClassName?: string;
topClassName?: string;
overviewRuler?: {
color: string;
modelRanges: Range[];
includeOutput: boolean;
};
}
export interface INotebookDeltaDecoration {
handle: number;
options: INotebookCellDecorationOptions;
}
export interface INotebookDeltaCellStatusBarItems {
handle: number;
items: INotebookCellStatusBarItem[];
}
export enum CellRevealType {
NearTopIfOutsideViewport,
CenterIfOutsideViewport
}
export interface INotebookEditorOptions extends ITextEditorOptions {
readonly cellOptions?: ITextResourceEditorInput;
readonly cellRevealType?: CellRevealType;
readonly cellSelections?: ICellRange[];
readonly isReadOnly?: boolean;
readonly viewState?: INotebookEditorViewState;
readonly indexedCellOptions?: { index: number; selection?: IRange };
}
export type INotebookEditorContributionCtor = IConstructorSignature<INotebookEditorContribution, [INotebookEditor]>;
export interface INotebookEditorContributionDescription {
id: string;
ctor: INotebookEditorContributionCtor;
}
export interface INotebookEditorCreationOptions {
readonly isEmbedded?: boolean;
readonly isReadOnly?: boolean;
readonly contributions?: INotebookEditorContributionDescription[];
readonly cellEditorContributions?: IEditorContributionDescription[];
readonly menuIds: {
notebookToolbar: MenuId;
cellTitleToolbar: MenuId;
cellDeleteToolbar: MenuId;
cellInsertToolbar: MenuId;
cellTopInsertToolbar: MenuId;
cellExecuteToolbar: MenuId;
cellExecutePrimary?: MenuId;
};
readonly options?: NotebookOptions;
}
export interface INotebookWebviewMessage {
message: unknown;
}
//#region Notebook View Model
export interface INotebookEditorViewState {
editingCells: { [key: number]: boolean };
collapsedInputCells: { [key: number]: boolean };
collapsedOutputCells: { [key: number]: boolean };
editorViewStates: { [key: number]: editorCommon.ICodeEditorViewState | null };
hiddenFoldingRanges?: ICellRange[];
cellTotalHeights?: { [key: number]: number };
scrollPosition?: { left: number; top: number };
focus?: number;
editorFocused?: boolean;
contributionsState?: { [id: string]: unknown };
selectedKernelId?: string;
}
export interface ICellModelDecorations {
ownerId: number;
decorations: string[];
}
export interface ICellModelDeltaDecorations {
ownerId: number;
decorations: IModelDeltaDecoration[];
}
export interface IModelDecorationsChangeAccessor {
deltaDecorations(oldDecorations: ICellModelDecorations[], newDecorations: ICellModelDeltaDecorations[]): ICellModelDecorations[];
}
export type NotebookViewCellsSplice = [
number /* start */,
number /* delete count */,
ICellViewModel[]
];
export interface INotebookViewCellsUpdateEvent {
synchronous: boolean;
splices: NotebookViewCellsSplice[];
}
export interface INotebookViewModel {
notebookDocument: NotebookTextModel;
viewCells: ICellViewModel[];
layoutInfo: NotebookLayoutInfo | null;
onDidChangeViewCells: Event<INotebookViewCellsUpdateEvent>;
onDidChangeSelection: Event<string>;
getNearestVisibleCellIndexUpwards(index: number): number;
getTrackedRange(id: string): ICellRange | null;
setTrackedRange(id: string | null, newRange: ICellRange | null, newStickiness: TrackedRangeStickiness): string | null;
getSelections(): ICellRange[];
getCellIndex(cell: ICellViewModel): number;
deltaCellStatusBarItems(oldItems: string[], newItems: INotebookDeltaCellStatusBarItems[]): string[];
getFoldedLength(index: number): number;
replaceOne(cell: ICellViewModel, range: Range, text: string): Promise<void>;
replaceAll(matches: CellFindMatch[], texts: string[]): Promise<void>;
}
//#endregion
export interface INotebookEditor {
//#region Eventing
readonly onDidChangeCellState: Event<NotebookCellStateChangedEvent>;
readonly onDidChangeViewCells: Event<INotebookViewCellsUpdateEvent>;
readonly onDidChangeVisibleRanges: Event<void>;
readonly onDidChangeSelection: Event<void>;
/**
* An event emitted when the model of this editor has changed.
*/
readonly onDidChangeModel: Event<NotebookTextModel | undefined>;
readonly onDidFocusWidget: Event<void>;
readonly onDidBlurWidget: Event<void>;
readonly onDidScroll: Event<void>;
readonly onDidChangeActiveCell: Event<void>;
readonly onDidChangeActiveKernel: Event<void>;
readonly onMouseUp: Event<INotebookEditorMouseEvent>;
readonly onMouseDown: Event<INotebookEditorMouseEvent>;
//#endregion
//#region readonly properties
readonly visibleRanges: ICellRange[];
readonly textModel?: NotebookTextModel;
readonly isReadOnly: boolean;
readonly notebookOptions: NotebookOptions;
readonly isDisposed: boolean;
readonly activeKernel: INotebookKernel | undefined;
readonly scrollTop: number;
//#endregion
getLength(): number;
getSelections(): ICellRange[];
setSelections(selections: ICellRange[]): void;
getFocus(): ICellRange;
setFocus(focus: ICellRange): void;
getId(): string;
_getViewModel(): INotebookViewModel | undefined;
hasModel(): this is IActiveNotebookEditor;
dispose(): void;
getDomNode(): HTMLElement;
getInnerWebview(): IWebview | undefined;
getSelectionViewModels(): ICellViewModel[];
/**
* Focus the active cell in notebook cell list
*/
focus(): void;
/**
* Focus the notebook cell list container
*/
focusContainer(): void;
hasEditorFocus(): boolean;
hasWebviewFocus(): boolean;
hasOutputTextSelection(): boolean;
setOptions(options: INotebookEditorOptions | undefined): Promise<void>;
/**
* Select & focus cell
*/
focusElement(cell: ICellViewModel): void;
/**
* Layout info for the notebook editor
*/
getLayoutInfo(): NotebookLayoutInfo;
getVisibleRangesPlusViewportAboveAndBelow(): ICellRange[];
/**
* Focus the container of a cell (the monaco editor inside is not focused).
*/
focusNotebookCell(cell: ICellViewModel, focus: 'editor' | 'container' | 'output', options?: IFocusNotebookCellOptions): Promise<void>;
/**
* Execute the given notebook cells
*/
executeNotebookCells(cells?: Iterable<ICellViewModel>): Promise<void>;
/**
* Cancel the given notebook cells
*/
cancelNotebookCells(cells?: Iterable<ICellViewModel>): Promise<void>;
/**
* Get current active cell
*/
getActiveCell(): ICellViewModel | undefined;
/**
* Layout the cell with a new height
*/
layoutNotebookCell(cell: ICellViewModel, height: number): Promise<void>;
/**
* Render the output in webview layer
*/
createOutput(cell: ICellViewModel, output: IInsetRenderOutput, offset: number): Promise<void>;
/**
* Update the output in webview layer with latest content. It will delegate to `createOutput` is the output is not rendered yet
*/
updateOutput(cell: ICellViewModel, output: IInsetRenderOutput, offset: number): Promise<void>;
readonly onDidReceiveMessage: Event<INotebookWebviewMessage>;
/**
* Send message to the webview for outputs.
*/
postMessage(message: any): void;
/**
* Remove class name on the notebook editor root DOM node.
*/
addClassName(className: string): void;
/**
* Remove class name on the notebook editor root DOM node.
*/
removeClassName(className: string): void;
/**
* The range will be revealed with as little scrolling as possible.
*/
revealCellRangeInView(range: ICellRange): void;
/**
* Reveal cell into viewport.
*/
revealInView(cell: ICellViewModel): void;
/**
* Reveal cell into the top of viewport.
*/
revealInViewAtTop(cell: ICellViewModel): void;
/**
* Reveal cell into viewport center.
*/
revealInCenter(cell: ICellViewModel): void;
/**
* Reveal cell into viewport center if cell is currently out of the viewport.
*/
revealInCenterIfOutsideViewport(cell: ICellViewModel): void;
/**
* Reveal a line in notebook cell into viewport with minimal scrolling.
*/
revealLineInViewAsync(cell: ICellViewModel, line: number): Promise<void>;
/**
* Reveal a line in notebook cell into viewport center.
*/
revealLineInCenterAsync(cell: ICellViewModel, line: number): Promise<void>;
/**
* Reveal a line in notebook cell into viewport center.
*/
revealLineInCenterIfOutsideViewportAsync(cell: ICellViewModel, line: number): Promise<void>;
/**
* Reveal a range in notebook cell into viewport with minimal scrolling.
*/
revealRangeInViewAsync(cell: ICellViewModel, range: Range): Promise<void>;
/**
* Reveal a range in notebook cell into viewport center.
*/
revealRangeInCenterAsync(cell: ICellViewModel, range: Range): Promise<void>;
/**
* Reveal a range in notebook cell into viewport center.
*/
revealRangeInCenterIfOutsideViewportAsync(cell: ICellViewModel, range: Range): Promise<void>;
/**
* Reveal a position with `offset` in a cell into viewport center.
*/
revealCellOffsetInCenterAsync(cell: ICellViewModel, offset: number): Promise<void>;
/**
* Convert the view range to model range
* @param startIndex Inclusive
* @param endIndex Exclusive
*/
getCellRangeFromViewRange(startIndex: number, endIndex: number): ICellRange | undefined;
/**
* Set hidden areas on cell text models.
*/
setHiddenAreas(_ranges: ICellRange[]): boolean;
/**
* Set selectiosn on the text editor attached to the cell
*/
setCellEditorSelection(cell: ICellViewModel, selection: Range): void;
/**
*Change the decorations on the notebook cell list
*/
deltaCellDecorations(oldDecorations: string[], newDecorations: INotebookDeltaDecoration[]): string[];
/**
* Change the decorations on cell editors.
* The notebook is virtualized and this method should be called to create/delete editor decorations safely.
*/
changeModelDecorations<T>(callback: (changeAccessor: IModelDecorationsChangeAccessor) => T): T | null;
/**
* Get a contribution of this editor.
* @id Unique identifier of the contribution.
* @return The contribution or null if contribution not found.
*/
getContribution<T extends INotebookEditorContribution>(id: string): T;
/**
* Get the view index of a cell at model `index`
*/
getViewIndexByModelIndex(index: number): number;
getCellsInRange(range?: ICellRange): ReadonlyArray<ICellViewModel>;
cellAt(index: number): ICellViewModel | undefined;
getCellByHandle(handle: number): ICellViewModel | undefined;
getCellIndex(cell: ICellViewModel): number | undefined;
getNextVisibleCellIndex(index: number): number | undefined;
getPreviousVisibleCellIndex(index: number): number | undefined;
find(query: string, options: INotebookSearchOptions, token: CancellationToken): Promise<CellFindMatchWithIndex[]>;
highlightFind(cell: ICellViewModel, matchIndex: number): Promise<number>;
unHighlightFind(matchIndex: number): Promise<void>;
findStop(): void;
showProgress(): void;
hideProgress(): void;
getAbsoluteTopOfElement(cell: ICellViewModel): number;
}
export interface IActiveNotebookEditor extends INotebookEditor {
_getViewModel(): INotebookViewModel;
textModel: NotebookTextModel;
getFocus(): ICellRange;
cellAt(index: number): ICellViewModel;
getCellIndex(cell: ICellViewModel): number;
getNextVisibleCellIndex(index: number): number;
}
export interface IBaseCellEditorOptions extends IDisposable {
readonly value: IEditorOptions;
readonly onDidChange: Event<void>;
}
/**
* A mix of public interface and internal one (used by internal rendering code, e.g., cellRenderer)
*/
export interface INotebookEditorDelegate extends INotebookEditor {
hasModel(): this is IActiveNotebookEditorDelegate;
readonly creationOptions: INotebookEditorCreationOptions;
readonly onDidChangeOptions: Event<void>;
readonly onDidChangeDecorations: Event<void>;
getBaseCellEditorOptions(language: string): IBaseCellEditorOptions;
createMarkupPreview(cell: ICellViewModel): Promise<void>;
unhideMarkupPreviews(cells: readonly ICellViewModel[]): Promise<void>;
hideMarkupPreviews(cells: readonly ICellViewModel[]): Promise<void>;
/**
* Remove the output from the webview layer
*/
removeInset(output: IDisplayOutputViewModel): void;
/**
* Hide the inset in the webview layer without removing it
*/
hideInset(output: IDisplayOutputViewModel): void;
deltaCellOutputContainerClassNames(cellId: string, added: string[], removed: string[]): void;
}
export interface IActiveNotebookEditorDelegate extends INotebookEditorDelegate {
_getViewModel(): INotebookViewModel;
textModel: NotebookTextModel;
getFocus(): ICellRange;
cellAt(index: number): ICellViewModel;
getCellIndex(cell: ICellViewModel): number;
getNextVisibleCellIndex(index: number): number;
}
export interface OutputFindMatch {
readonly index: number;
}
export interface CellFindMatch {
cell: ICellViewModel;
matches: (FindMatch | OutputFindMatch)[];
modelMatchCount: number;
}
export interface CellFindMatchWithIndex {
cell: ICellViewModel;
index: number;
matches: (FindMatch | OutputFindMatch)[];
modelMatchCount: number;
}
export enum CellEditState {
/**
* Default state.
* For markup cells, this is the renderer version of the markup.
* For code cell, the browser focus should be on the container instead of the editor
*/
Preview,
/**
* Editing mode. Source for markup or code is rendered in editors and the state will be persistent.
*/
Editing
}
export enum CellFocusMode {
Container,
Editor,
Output
}
export enum CursorAtBoundary {
None,
Top,
Bottom,
Both
}
export function getNotebookEditorFromEditorPane(editorPane?: IEditorPane): INotebookEditor | undefined {
if (!editorPane) {
return;
}
if (editorPane.getId() === NOTEBOOK_EDITOR_ID) {
return editorPane.getControl() as INotebookEditor | undefined;
}
const input = editorPane.input;
if (input && isCompositeNotebookEditorInput(input)) {
return (editorPane.getControl() as { notebookEditor: INotebookEditor | undefined }).notebookEditor;
}
return undefined;
}
/**
* ranges: model selections
* this will convert model selections to view indexes first, and then include the hidden ranges in the list view
*/
export function expandCellRangesWithHiddenCells(editor: INotebookEditor, ranges: ICellRange[]) {
// assuming ranges are sorted and no overlap
const indexes = cellRangesToIndexes(ranges);
const modelRanges: ICellRange[] = [];
indexes.forEach(index => {
const viewCell = editor.cellAt(index);
if (!viewCell) {
return;
}
const viewIndex = editor.getViewIndexByModelIndex(index);
if (viewIndex < 0) {
return;
}
const nextViewIndex = viewIndex + 1;
const range = editor.getCellRangeFromViewRange(viewIndex, nextViewIndex);
if (range) {
modelRanges.push(range);
}
});
return reduceCellRanges(modelRanges);
}
export function cellRangeToViewCells(editor: IActiveNotebookEditor, ranges: ICellRange[]) {
const cells: ICellViewModel[] = [];
reduceCellRanges(ranges).forEach(range => {
cells.push(...editor.getCellsInRange(range));
});
return cells;
}
//#region Cell Folding
export const enum CellFoldingState {
None,
Expanded,
Collapsed
}
export interface EditorFoldingStateDelegate {
getCellIndex(cell: ICellViewModel): number;
getFoldingState(index: number): CellFoldingState;
}
//#endregion
|