forked from jupyterlab/jupyterlab
-
Notifications
You must be signed in to change notification settings - Fork 0
/
editor.ts
1219 lines (1091 loc) · 32.5 KB
/
editor.ts
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
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
import * as CodeMirror
from 'codemirror';
import {
JSONExt
} from '@phosphor/coreutils';
import {
ArrayExt
} from '@phosphor/algorithm';
import {
IDisposable, DisposableDelegate
} from '@phosphor/disposable';
import {
Signal
} from '@phosphor/signaling';
import {
showDialog
} from '@jupyterlab/apputils';
import {
CodeEditor
} from '@jupyterlab/codeeditor';
import {
uuid
} from '@jupyterlab/coreutils';
import {
IObservableMap, IObservableString, ICollaborator
} from '@jupyterlab/observables';
import {
Mode
} from './mode';
import 'codemirror/addon/comment/comment.js';
import 'codemirror/addon/edit/matchbrackets.js';
import 'codemirror/addon/edit/closebrackets.js';
import 'codemirror/addon/scroll/scrollpastend.js';
import 'codemirror/addon/search/searchcursor';
import 'codemirror/addon/search/search';
import 'codemirror/keymap/emacs.js';
import 'codemirror/keymap/sublime.js';
import 'codemirror/keymap/vim.js';
/**
* The class name added to CodeMirrorWidget instances.
*/
const EDITOR_CLASS = 'jp-CodeMirrorEditor';
/**
* The class name added to read only cell editor widgets.
*/
const READ_ONLY_CLASS = 'jp-mod-readOnly';
/**
* The class name for the hover box for collaborator cursors.
*/
const COLLABORATOR_CURSOR_CLASS = 'jp-CollaboratorCursor';
/**
* The class name for the hover box for collaborator cursors.
*/
const COLLABORATOR_HOVER_CLASS = 'jp-CollaboratorCursor-hover';
/**
* The key code for the up arrow key.
*/
const UP_ARROW = 38;
/**
* The key code for the down arrow key.
*/
const DOWN_ARROW = 40;
/**
* The time that a collaborator name hover persists.
*/
const HOVER_TIMEOUT = 1000;
/**
* CodeMirror editor.
*/
export
class CodeMirrorEditor implements CodeEditor.IEditor {
/**
* Construct a CodeMirror editor.
*/
constructor(options: CodeMirrorEditor.IOptions) {
let host = this.host = options.host;
host.classList.add(EDITOR_CLASS);
host.classList.add('jp-Editor');
host.addEventListener('focus', this, true);
host.addEventListener('blur', this, true);
host.addEventListener('scroll', this, true);
this._uuid = options.uuid || uuid();
// Handle selection style.
let style = options.selectionStyle || {};
this._selectionStyle = {
...CodeEditor.defaultSelectionStyle,
...style as CodeEditor.ISelectionStyle
};
let model = this._model = options.model;
let editor = this._editor = CodeMirror(host, {});
Private.handleConfig(editor, options.config || {});
let doc = editor.getDoc();
// Handle initial values for text, mimetype, and selections.
doc.setValue(model.value.text);
this._onMimeTypeChanged();
this._onCursorActivity();
this._timer = window.setInterval(() => { this._checkSync(); }, 3000);
// Connect to changes.
model.value.changed.connect(this._onValueChanged, this);
model.mimeTypeChanged.connect(this._onMimeTypeChanged, this);
model.selections.changed.connect(this._onSelectionsChanged, this);
CodeMirror.on(editor, 'keydown', (editor, event) => {
let index = ArrayExt.findFirstIndex(this._keydownHandlers, handler => {
if (handler(this, event) === true) {
event.preventDefault();
return true;
}
return false;
});
if (index === -1) {
this.onKeydown(event);
}
});
CodeMirror.on(editor, 'cursorActivity', () => this._onCursorActivity());
CodeMirror.on(editor.getDoc(), 'beforeChange', (instance, change) => {
this._beforeDocChanged(instance, change);
});
CodeMirror.on(editor.getDoc(), 'change', (instance, change) => {
// Manually refresh after setValue to make sure editor is properly sized.
if (change.origin === 'setValue' && this.hasFocus()) {
this.refresh();
}
this._lastChange = change;
});
// Manually refresh on paste to make sure editor is properly sized.
editor.getWrapperElement().addEventListener('paste', () => {
if (this.hasFocus()) {
this.refresh();
}
});
}
/**
* A signal emitted when either the top or bottom edge is requested.
*/
readonly edgeRequested = new Signal<this, CodeEditor.EdgeLocation>(this);
/**
* The DOM node that hosts the editor.
*/
readonly host: HTMLElement;
/**
* The uuid of this editor;
*/
get uuid(): string {
return this._uuid;
}
set uuid(value: string) {
this._uuid = value;
}
/**
* The selection style of this editor.
*/
get selectionStyle(): CodeEditor.ISelectionStyle {
return this._selectionStyle;
}
set selectionStyle(value: CodeEditor.ISelectionStyle) {
this._selectionStyle = value;
}
/**
* Get the codemirror editor wrapped by the editor.
*/
get editor(): CodeMirror.Editor {
return this._editor;
}
/**
* Get the codemirror doc wrapped by the widget.
*/
get doc(): CodeMirror.Doc {
return this._editor.getDoc();
}
/**
* Get the number of lines in the editor.
*/
get lineCount(): number {
return this.doc.lineCount();
}
/**
* Returns a model for this editor.
*/
get model(): CodeEditor.IModel {
return this._model;
}
/**
* The height of a line in the editor in pixels.
*/
get lineHeight(): number {
return this._editor.defaultTextHeight();
}
/**
* The widget of a character in the editor in pixels.
*/
get charWidth(): number {
return this._editor.defaultCharWidth();
}
/**
* Tests whether the editor is disposed.
*/
get isDisposed(): boolean {
return this._isDisposed;
}
/**
* Dispose of the resources held by the widget.
*/
dispose(): void {
if (this.isDisposed) {
return;
}
this._isDisposed = true;
this.host.removeEventListener('focus', this, true);
this.host.removeEventListener('blur', this, true);
this.host.removeEventListener('scroll', this, true);
this._keydownHandlers.length = 0;
window.clearInterval(this._timer);
Signal.clearData(this);
}
/**
* Get a config option for the editor.
*/
getOption<K extends keyof CodeMirrorEditor.IConfig>(option: K): CodeMirrorEditor.IConfig[K] {
return Private.getOption(this.editor, option);
}
/**
* Set a config option for the editor.
*/
setOption<K extends keyof CodeMirrorEditor.IConfig>(option: K, value: CodeMirrorEditor.IConfig[K]): void {
Private.setOption(this.editor, option, value);
}
/**
* Returns the content for the given line number.
*/
getLine(line: number): string | undefined {
return this.doc.getLine(line);
}
/**
* Find an offset for the given position.
*/
getOffsetAt(position: CodeEditor.IPosition): number {
return this.doc.indexFromPos({
ch: position.column,
line: position.line
});
}
/**
* Find a position fot the given offset.
*/
getPositionAt(offset: number): CodeEditor.IPosition {
const { ch, line } = this.doc.posFromIndex(offset);
return { line, column: ch };
}
/**
* Undo one edit (if any undo events are stored).
*/
undo(): void {
this.doc.undo();
}
/**
* Redo one undone edit.
*/
redo(): void {
this.doc.redo();
}
/**
* Clear the undo history.
*/
clearHistory(): void {
this.doc.clearHistory();
}
/**
* Brings browser focus to this editor text.
*/
focus(): void {
this._editor.focus();
}
/**
* Test whether the editor has keyboard focus.
*/
hasFocus(): boolean {
return this._editor.getWrapperElement().contains(document.activeElement);
}
/**
* Explicitly blur the editor.
*/
blur(): void {
this._editor.getInputField().blur();
}
/**
* Repaint editor.
*/
refresh(): void {
this._editor.refresh();
this._needsRefresh = false;
}
/**
* Refresh the editor if it is focused;
* otherwise postpone refreshing till focusing.
*/
resizeToFit(): void {
if (this.hasFocus()) {
this.refresh();
} else {
this._needsRefresh = true;
}
this._clearHover();
}
/**
* Add a keydown handler to the editor.
*
* @param handler - A keydown handler.
*
* @returns A disposable that can be used to remove the handler.
*/
addKeydownHandler(handler: CodeEditor.KeydownHandler): IDisposable {
this._keydownHandlers.push(handler);
return new DisposableDelegate(() => {
ArrayExt.removeAllWhere(this._keydownHandlers, val => val === handler);
});
}
/**
* Set the size of the editor in pixels.
*/
setSize(dimension: CodeEditor.IDimension | null): void {
if (dimension) {
this._editor.setSize(dimension.width, dimension.height);
} else {
this._editor.setSize(null, null);
}
this._needsRefresh = false;
}
/**
* Reveal the given position in the editor.
*/
revealPosition(position: CodeEditor.IPosition): void {
const cmPosition = this._toCodeMirrorPosition(position);
this._editor.scrollIntoView(cmPosition);
}
/**
* Reveal the given selection in the editor.
*/
revealSelection(selection: CodeEditor.IRange): void {
const range = this._toCodeMirrorRange(selection);
this._editor.scrollIntoView(range);
}
/**
* Get the window coordinates given a cursor position.
*/
getCoordinateForPosition(position: CodeEditor.IPosition): CodeEditor.ICoordinate {
const pos = this._toCodeMirrorPosition(position);
const rect = this.editor.charCoords(pos, 'page');
return rect as CodeEditor.ICoordinate;
}
/**
* Get the cursor position given window coordinates.
*
* @param coordinate - The desired coordinate.
*
* @returns The position of the coordinates, or null if not
* contained in the editor.
*/
getPositionForCoordinate(coordinate: CodeEditor.ICoordinate): CodeEditor.IPosition | null {
return this._toPosition(this.editor.coordsChar(coordinate)) || null;
}
/**
* Returns the primary position of the cursor, never `null`.
*/
getCursorPosition(): CodeEditor.IPosition {
const cursor = this.doc.getCursor();
return this._toPosition(cursor);
}
/**
* Set the primary position of the cursor.
*
* #### Notes
* This will remove any secondary cursors.
*/
setCursorPosition(position: CodeEditor.IPosition): void {
const cursor = this._toCodeMirrorPosition(position);
this.doc.setCursor(cursor);
// If the editor does not have focus, this cursor change
// will get screened out in _onCursorsChanged(). Make an
// exception for this method.
if (!this.editor.hasFocus()) {
this.model.selections.set(this.uuid, this.getSelections());
}
}
/**
* Returns the primary selection, never `null`.
*/
getSelection(): CodeEditor.ITextSelection {
return this.getSelections()[0];
}
/**
* Set the primary selection. This will remove any secondary cursors.
*/
setSelection(selection: CodeEditor.IRange): void {
this.setSelections([selection]);
}
/**
* Gets the selections for all the cursors, never `null` or empty.
*/
getSelections(): CodeEditor.ITextSelection[] {
const selections = this.doc.listSelections();
if (selections.length > 0) {
return selections.map(selection => this._toSelection(selection));
}
const cursor = this.doc.getCursor();
const selection = this._toSelection({ anchor: cursor, head: cursor });
return [selection];
}
/**
* Sets the selections for all the cursors, should not be empty.
* Cursors will be removed or added, as necessary.
* Passing an empty array resets a cursor position to the start of a document.
*/
setSelections(selections: CodeEditor.IRange[]): void {
const cmSelections = this._toCodeMirrorSelections(selections);
this.doc.setSelections(cmSelections, 0);
}
/**
* Execute a codemirror command on the editor.
*
* @param command - The name of the command to execute.
*/
execCommand(command: string): void {
this._editor.execCommand(command);
}
/**
* Handle keydown events from the editor.
*/
protected onKeydown(event: KeyboardEvent): boolean {
let position = this.getCursorPosition();
let { line, column } = position;
if (line === 0 && column === 0 && event.keyCode === UP_ARROW) {
if (!event.shiftKey) {
this.edgeRequested.emit('top');
}
return false;
}
let lastLine = this.lineCount - 1;
let lastCh = this.getLine(lastLine)!.length;
if (line === lastLine && column === lastCh
&& event.keyCode === DOWN_ARROW) {
if (!event.shiftKey) {
this.edgeRequested.emit('bottom');
}
return false;
}
return false;
}
/**
* Converts selections to code mirror selections.
*/
private _toCodeMirrorSelections(selections: CodeEditor.IRange[]): CodeMirror.Selection[] {
if (selections.length > 0) {
return selections.map(selection => this._toCodeMirrorSelection(selection));
}
const position = { line: 0, ch: 0 };
return [{ anchor: position, head: position }];
}
/**
* Handles a mime type change.
*/
private _onMimeTypeChanged(): void {
const mime = this._model.mimeType;
let editor = this._editor;
Mode.ensure(mime).then(spec => {
editor.setOption('mode', spec.mime);
});
let extraKeys = editor.getOption('extraKeys') || {};
const isCode = (mime !== 'text/plain') && (mime !== 'text/x-ipythongfm');
if (isCode) {
extraKeys['Backspace'] = 'delSpaceToPrevTabStop';
} else {
delete extraKeys['Backspace'];
}
editor.setOption('extraKeys', extraKeys);
}
/**
* Handles a selections change.
*/
private _onSelectionsChanged(selections: IObservableMap<CodeEditor.ITextSelection[]>, args: IObservableMap.IChangedArgs<CodeEditor.ITextSelection[]>): void {
const uuid = args.key;
if (uuid !== this.uuid) {
this._cleanSelections(uuid);
if (args.type !== 'remove' && args.newValue) {
this._markSelections(uuid, args.newValue);
}
}
}
/**
* Clean selections for the given uuid.
*/
private _cleanSelections(uuid: string) {
const markers = this.selectionMarkers[uuid];
if (markers) {
markers.forEach(marker => { marker.clear(); });
}
delete this.selectionMarkers[uuid];
}
/**
* Marks selections.
*/
private _markSelections(uuid: string, selections: CodeEditor.ITextSelection[]) {
const markers: CodeMirror.TextMarker[] = [];
// If we are marking selections corresponding to an active hover,
// remove it.
if (uuid === this._hoverId) {
this._clearHover();
}
// If we can id the selection to a specific collaborator,
// use that information.
let collaborator: ICollaborator | undefined;
if (this._model.modelDB.collaborators) {
collaborator = this._model.modelDB.collaborators.get(uuid);
}
// Style each selection for the uuid.
selections.forEach(selection => {
// Only render selections if the start is not equal to the end.
// In that case, we don't need to render the cursor.
if (!JSONExt.deepEqual(selection.start, selection.end)) {
const { anchor, head } = this._toCodeMirrorSelection(selection);
let markerOptions: CodeMirror.TextMarkerOptions;
if (collaborator) {
markerOptions = this._toTextMarkerOptions({
...selection.style,
color: collaborator.color
});
} else {
markerOptions = this._toTextMarkerOptions(selection.style);
}
markers.push(this.doc.markText(anchor, head, markerOptions));
} else if (collaborator) {
let caret = this._getCaret(collaborator);
markers.push(this.doc.setBookmark(
this._toCodeMirrorPosition(selection.end), {widget: caret}));
}
});
this.selectionMarkers[uuid] = markers;
}
/**
* Handles a cursor activity event.
*/
private _onCursorActivity(): void {
// Only add selections if the editor has focus. This avoids unwanted
// triggering of cursor activity due to collaborator actions.
if (this._editor.hasFocus()) {
const selections = this.getSelections();
this.model.selections.set(this.uuid, selections);
}
}
/**
* Converts a code mirror selection to an editor selection.
*/
private _toSelection(selection: CodeMirror.Selection): CodeEditor.ITextSelection {
return {
uuid: this.uuid,
start: this._toPosition(selection.anchor),
end: this._toPosition(selection.head),
style: this.selectionStyle
};
}
/**
* Converts the selection style to a text marker options.
*/
private _toTextMarkerOptions(style: CodeEditor.ISelectionStyle): CodeMirror.TextMarkerOptions {
let r = parseInt(style.color.slice(1, 3), 16);
let g = parseInt(style.color.slice(3, 5), 16);
let b = parseInt(style.color.slice(5, 7), 16);
let css = `background-color: rgba( ${r}, ${g}, ${b}, 0.15)`;
return {
className: style.className,
title: style.displayName,
css
};
}
/**
* Converts an editor selection to a code mirror selection.
*/
private _toCodeMirrorSelection(selection: CodeEditor.IRange): CodeMirror.Selection {
// Selections only appear to render correctly if the anchor
// is before the head in the document. That is, reverse selections
// do not appear as intended.
let forward: boolean = (selection.start.line < selection.end.line) ||
(selection.start.line === selection.end.line &&
selection.start.column <= selection.end.column);
let anchor = forward ? selection.start : selection.end;
let head = forward ? selection.end : selection.start;
return {
anchor: this._toCodeMirrorPosition(anchor),
head: this._toCodeMirrorPosition(head)
};
}
/**
* Converts an editor selection to a code mirror selection.
*/
private _toCodeMirrorRange(range: CodeEditor.IRange): CodeMirror.Range {
return {
from: this._toCodeMirrorPosition(range.start),
to: this._toCodeMirrorPosition(range.end)
};
}
/**
* Convert a code mirror position to an editor position.
*/
private _toPosition(position: CodeMirror.Position) {
return {
line: position.line,
column: position.ch
};
}
/**
* Convert an editor position to a code mirror position.
*/
private _toCodeMirrorPosition(position: CodeEditor.IPosition) {
return {
line: position.line,
ch: position.column
};
}
/**
* Handle model value changes.
*/
private _onValueChanged(value: IObservableString, args: IObservableString.IChangedArgs): void {
if (this._changeGuard) {
return;
}
this._changeGuard = true;
let doc = this.doc;
switch (args.type) {
case 'insert':
let pos = doc.posFromIndex(args.start);
doc.replaceRange(args.value, pos, pos);
break;
case 'remove':
let from = doc.posFromIndex(args.start);
let to = doc.posFromIndex(args.end);
doc.replaceRange('', from, to);
break;
case 'set':
doc.setValue(args.value);
break;
default:
break;
}
this._changeGuard = false;
}
/**
* Handles document changes.
*/
private _beforeDocChanged(doc: CodeMirror.Doc, change: CodeMirror.EditorChange) {
if (this._changeGuard) {
return;
}
this._changeGuard = true;
let value = this._model.value;
let start = doc.indexFromPos(change.from);
let end = doc.indexFromPos(change.to);
let inserted = change.text.join('\n');
if (end !== start) {
value.remove(start, end);
}
if (inserted) {
value.insert(start, inserted);
}
this._changeGuard = false;
}
/**
* Handle the DOM events for the editor.
*
* @param event - The DOM event sent to the editor.
*
* #### Notes
* This method implements the DOM `EventListener` interface and is
* called in response to events on the editor's DOM node. It should
* not be called directly by user code.
*/
handleEvent(event: Event): void {
switch (event.type) {
case 'focus':
this._evtFocus(event as FocusEvent);
break;
case 'blur':
this._evtBlur(event as FocusEvent);
break;
case 'scroll':
this._evtScroll();
break;
default:
break;
}
}
/**
* Handle `focus` events for the editor.
*/
private _evtFocus(event: FocusEvent): void {
if (this._needsRefresh) {
this.refresh();
}
this.host.classList.add('jp-mod-focused');
}
/**
* Handle `blur` events for the editor.
*/
private _evtBlur(event: FocusEvent): void {
this.host.classList.remove('jp-mod-focused');
}
/**
* Handle `scroll` events for the editor.
*/
private _evtScroll(): void {
// Remove any active hover.
this._clearHover();
}
/**
* Clear the hover for a caret, due to things like
* scrolling, resizing, deactivation, etc, where
* the position is no longer valid.
*/
private _clearHover(): void {
if (this._caretHover) {
window.clearTimeout(this._hoverTimeout);
document.body.removeChild(this._caretHover);
this._caretHover = null;
}
}
/**
* Construct a caret element representing the position
* of a collaborator's cursor.
*/
private _getCaret(collaborator: ICollaborator): HTMLElement {
let name = collaborator ? collaborator.displayName : 'Anonymous';
let color = collaborator ? collaborator.color : this._selectionStyle.color;
let caret: HTMLElement = document.createElement('span');
caret.className = COLLABORATOR_CURSOR_CLASS;
caret.style.borderBottomColor = color;
caret.onmouseenter = () => {
this._clearHover();
this._hoverId = collaborator.sessionId;
let rect = caret.getBoundingClientRect();
// Construct and place the hover box.
let hover = document.createElement('div');
hover.className = COLLABORATOR_HOVER_CLASS;
hover.style.left = String(rect.left) + 'px';
hover.style.top = String(rect.bottom) + 'px';
hover.textContent = name;
hover.style.backgroundColor = color;
// If the user mouses over the hover, take over the timer.
hover.onmouseenter = () => {
window.clearTimeout(this._hoverTimeout);
};
hover.onmouseleave = () => {
this._hoverTimeout = window.setTimeout(() => {
this._clearHover();
}, HOVER_TIMEOUT);
};
this._caretHover = hover;
document.body.appendChild(hover);
};
caret.onmouseleave = () => {
this._hoverTimeout = window.setTimeout(() => {
this._clearHover();
}, HOVER_TIMEOUT);
};
return caret;
}
/**
* Check for an out of sync editor.
*/
private _checkSync(): void {
let change = this._lastChange;
if (!change) {
return;
}
this._lastChange = null;
let editor = this._editor;
let doc = editor.getDoc();
if (doc.getValue() === this._model.value.text) {
return;
}
showDialog({
title: 'Code Editor out of Sync',
body: 'Please open your browser JavaScript console for bug report instructions'
});
console.log('Please paste the following to https://github.com/jupyterlab/jupyterlab/issues/2951');
console.log(JSON.stringify({
model: this._model.value.text,
view: doc.getValue(),
selections: this.getSelections(),
cursor: this.getCursorPosition(),
lineSep: editor.getOption('lineSeparator'),
mode: editor.getOption('mode'),
change
}));
}
private _model: CodeEditor.IModel;
private _editor: CodeMirror.Editor;
protected selectionMarkers: { [key: string]: CodeMirror.TextMarker[] | undefined } = {};
private _caretHover: HTMLElement | null;
private _hoverTimeout: number;
private _hoverId: string;
private _keydownHandlers = new Array<CodeEditor.KeydownHandler>();
private _changeGuard = false;
private _selectionStyle: CodeEditor.ISelectionStyle;
private _uuid = '';
private _needsRefresh = false;
private _isDisposed = false;
private _lastChange: CodeMirror.EditorChange | null = null;
private _timer = -1;
}
/**
* The namespace for `CodeMirrorEditor` statics.
*/
export
namespace CodeMirrorEditor {
/**
* The options used to initialize a code mirror editor.
*/
export
interface IOptions extends CodeEditor.IOptions {
/**
* The configuration options for the editor.
*/
config?: Partial<IConfig>;
}
/**
* The configuration options for a codemirror editor.
*/
export
interface IConfig extends CodeEditor.IConfig {
/**
* The mode to use.
*/
mode?: string | Mode.ISpec;
/**
* The theme to style the editor with.
* You must make sure the CSS file defining the corresponding
* .cm-s-[name] styles is loaded.
*/
theme?: string;
/**
* Whether to use the context-sensitive indentation that the mode provides
* (or just indent the same as the line before).
*/
smartIndent?: boolean;
/**
* Configures whether the editor should re-indent the current line when a
* character is typed that might change its proper indentation
* (only works if the mode supports indentation).
*/
electricChars?: boolean;
/**
* Configures the keymap to use. The default is "default", which is the
* only keymap defined in codemirror.js itself.
* Extra keymaps are found in the CodeMirror keymap directory.
*/
keyMap?: string;
/**
* Can be used to specify extra keybindings for the editor, alongside the
* ones defined by keyMap. Should be either null, or a valid keymap value.
*/
extraKeys?: any;
/**
* Can be used to add extra gutters (beyond or instead of the line number
* gutter).
* Should be an array of CSS class names, each of which defines a width
* (and optionally a background),
* and which will be used to draw the background of the gutters.
* May include the CodeMirror-linenumbers class, in order to explicitly
* set the position of the line number gutter
* (it will default to be to the right of all other gutters).
* These class names are the keys passed to setGutterMarker.
*/
gutters?: ReadonlyArray<string>;
/**
* Determines whether the gutter scrolls along with the content
* horizontally (false)
* or whether it stays fixed during horizontal scrolling (true,
* the default).
*/
fixedGutter?: boolean;
/**
* Whether the cursor should be drawn when a selection is active.
*/
showCursorWhenSelecting?: boolean;
/**
* When fixedGutter is on, and there is a horizontal scrollbar, by default
* the gutter will be visible to the left of this scrollbar. If this
* option is set to true, it will be covered by an element with class
* CodeMirror-gutter-filler.
*/
coverGutterNextToScrollbar?: boolean;