forked from stdlib-js/stdlib
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmain.js
More file actions
1649 lines (1498 loc) · 48.5 KB
/
main.js
File metadata and controls
1649 lines (1498 loc) · 48.5 KB
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
/**
* @license Apache-2.0
*
* Copyright (c) 2019 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* eslint-disable no-restricted-syntax, no-invalid-this, no-underscore-dangle, max-lines, max-lines-per-function, max-statements */
'use strict';
// MODULES //
var EventEmitter = require( 'events' ).EventEmitter;
var readline = require( 'readline' );
var proc = require( 'process' );
var resolve = require( 'path' ).resolve;
var logger = require( 'debug' );
var inherit = require( '@stdlib/utils/inherit' );
var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
var isNumber = require( '@stdlib/assert/is-number' ).isPrimitive;
var isPlainObject = require( '@stdlib/assert/is-plain-object' );
var isFunction = require( '@stdlib/assert/is-function' );
var isConfigurableProperty = require( '@stdlib/assert/is-configurable-property' );
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var objectKeys = require( '@stdlib/utils/keys' );
var setNonEnumerable = require( '@stdlib/utils/define-nonenumerable-property' );
var setNonEnumerableReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
var properties = require( '@stdlib/utils/properties' );
var append = require( '@stdlib/utils/append' );
var format = require( '@stdlib/string/format' );
var Boolean = require( '@stdlib/boolean/ctor' );
var cwd = require( '@stdlib/process/cwd' );
var readFileSync = require( '@stdlib/fs/read-file' ).sync;
var RE_EOL = require( '@stdlib/regexp/eol' ).REGEXP;
var fifo = require( '@stdlib/dstructs/fifo' );
var nextTick = require( '@stdlib/utils/next-tick' );
var assign = require( '@stdlib/object/assign' );
var validate = require( './validate.js' );
var parseKey = require( './parse_key.js' );
var defaults = require( './defaults.js' );
var isSettingName = require( './is_setting_name.js' );
var setAliases = require( './set_aliases.js' );
var setAliasesGlobal = require( './set_aliases_global.js' );
var setCommands = require( './set_commands.js' );
var setCommandsGlobal = require( './set_commands_global.js' );
var propertyComparator = require( './property_comparator.js' );
var createEvalContext = require( './create_evaluation_context.js' );
var commands = require( './commands.js' );
var displayPrompt = require( './display_prompt.js' );
var inputPrompt = require( './input_prompt.js' );
var OutputStream = require( './output_stream.js' );
var completerFactory = require( './completer.js' );
var MultilineHandler = require( './multiline_handler.js' );
var Keybindings = require( './keybindings.js' );
var EditorActions = require( './editor_actions.js' );
var CompleterEngine = require( './completer_engine.js' );
var PreviewCompleter = require( './completer_preview.js' );
var AutoCloser = require( './auto_close_pairs.js' );
var SyntaxHighlighter = require( './syntax_highlighter.js' );
var EagerEvaluator = require( './eager_evaluator.js' );
var ALIAS_OVERRIDES = require( './alias_overrides.js' );
var SETTINGS = require( './settings.js' );
var SETTINGS_VALIDATORS = require( './settings_validators.js' );
// VARIABLES //
var debug = logger( 'repl' );
// MAIN //
/**
* REPL constructor.
*
* @constructor
* @param {Options} options - constructor options
* @param {string} [options.inputPrompt='In [%d]: '] - input prompt
* @param {string} [options.outputPrompt='Out[%d]: '] - output prompt
* @param {ReadableStream} [options.input=process.stdin] - input stream
* @param {WritableStream} [options.output=process.stdout] - output stream
* @param {boolean} [options.sandbox=true] - boolean indicating whether to run a REPL in a sandboxed context
* @param {PositiveInteger} [options.timeout=4294967295] - number of milliseconds to execute a command before terminating execution
* @param {boolean} [options.isTTY] - boolean indicating whether the input and output streams should be treated like a TTY (terminal) and whether the REPL should use ANSI/VT100 escape codes when writing to the output stream
* @param {string} [options.welcome] - welcome message
* @param {NonNegativeInteger} [options.padding=1] - number of empty lines between successive commands
* @param {Object} [options.themes] - table containing color themes for syntax highlighting
* @param {string} [options.load] - file path specifying a JavaScript file to load and evaluate line-by-line (e.g., a previous REPL history file)
* @param {string} [options.save] - file path specifying where to save REPL command history
* @param {string} [options.log] - file path specifying where to save REPL commands and printed output
* @param {string} [options.quiet=false] - boolean indicating whether log information, confirmation messages, and other possible REPL diagnostics should be silenced
* @param {Object} [options.keybindings] - REPL keybindings
* @param {Object} [options.settings] - REPL settings
* @param {boolean} [options.settings.autoClosePairs=true] - boolean indicating whether to automatically insert matching brackets, parentheses, and quotes
* @param {boolean} [options.settings.autoDeletePairs=true] - boolean indicating whether to automatically delete adjacent matching brackets, parentheses, and quotes
* @param {boolean} [options.settings.autoPage] - boolean indicating whether to automatically page return values requiring a display size exceeding the visible screen
* @param {boolean} [options.settings.bracketedPaste] - boolean indicating whether to enable bracketed-paste mode
* @param {boolean} [options.settings.completionPreviews] - boolean indicating whether to enable completion previews for auto-completion
* @param {boolean} [options.settings.autoDisableBracketedPasteOnExit] - boolean indicating whether to automatically disable bracketed-paste upon exiting the REPL
* @param {boolean} [options.settings.syntaxHighlighting] - boolean indicating whether to enable syntax highlighting
* @param {boolean} [options.settings.eagerEvaluation] - boolean indicating whether to enable eager evaluation
* @param {string} [options.settings.theme] - initial color theme for syntax highlighting
* @throws {Error} must provide valid options
* @returns {REPL} REPL instance
*
* @example
* var debug = require( '@stdlib/streams/node/debug-sink' );
*
* function onExit() {
* console.log( 'REPL closed.' );
* }
*
* // Create a new REPL:
* var repl = new REPL({
* 'output': debug()
* });
* repl.on( 'exit', onExit );
*
* // ...
*
* // Close the REPL:
* repl.close();
*/
function REPL( options ) {
var ostream;
var themes;
var opts;
var self;
var err;
var i;
if ( !( this instanceof REPL ) ) {
if ( arguments.length ) {
return new REPL( options );
}
return new REPL();
}
self = this;
opts = defaults();
if ( arguments.length ) {
err = validate( opts, options );
if ( err ) {
throw err;
}
}
opts.isTTY = ( opts.isTTY === void 0 ) ? opts.output.isTTY : opts.isTTY;
opts.settings.autoPage = ( opts.settings.autoPage === void 0 ) ? opts.isTTY : opts.settings.autoPage; // eslint-disable-line max-len
opts.settings.bracketedPaste = ( opts.settings.bracketedPaste === void 0 && opts.isTTY ) ? true : opts.settings.bracketedPaste; // eslint-disable-line max-len
opts.settings.completionPreviews = ( opts.settings.completionPreviews === void 0 ) ? opts.isTTY : opts.settings.completionPreviews; // eslint-disable-line max-len
opts.settings.autoDisableBracketedPasteOnExit = ( opts.settings.autoDisableBracketedPasteOnExit === void 0 ) ? opts.isTTY : opts.settings.autoDisableBracketedPasteOnExit; // eslint-disable-line max-len
opts.settings.syntaxHighlighting = ( opts.settings.syntaxHighlighting === void 0 ) ? opts.isTTY : opts.settings.syntaxHighlighting; // eslint-disable-line max-len
opts.settings.eagerEvaluation = ( opts.settings.eagerEvaluation === void 0 ) ? opts.isTTY : opts.settings.eagerEvaluation; // eslint-disable-line max-len
debug( 'Options: %s', JSON.stringify({
'input': '<readable_stream>',
'output': '<writable_stream>',
'sandbox': opts.sandbox,
'timeout': opts.timeout,
'isTTY': opts.isTTY,
'inputPrompt': opts.inputPrompt,
'outputPrompt': opts.outputPrompt,
'padding': opts.padding,
'welcome': opts.welcome,
'load': opts.load,
'save': opts.save,
'log': opts.log,
'quiet': opts.quiet,
'settings': opts.settings
}));
// Call the parent constructor:
EventEmitter.call( this );
// Create an internal output stream:
ostream = new OutputStream( this, opts.settings.autoPage );
// Setup the output stream pipeline:
ostream.pipe( opts.output );
// Cache references to the input and output streams:
setNonEnumerableReadOnly( this, '_istream', opts.input );
setNonEnumerableReadOnly( this, '_ostream', ostream );
setNonEnumerableReadOnly( this, '_wstream', opts.output );
// Cache options:
setNonEnumerableReadOnly( this, '_inputPrompt', opts.inputPrompt );
setNonEnumerableReadOnly( this, '_outputPrompt', opts.outputPrompt );
setNonEnumerableReadOnly( this, '_padding', opts.padding );
setNonEnumerableReadOnly( this, '_timeout', opts.timeout );
setNonEnumerableReadOnly( this, '_isTTY', opts.isTTY );
setNonEnumerableReadOnly( this, '_sandbox', opts.sandbox );
setNonEnumerableReadOnly( this, '_settings', opts.settings );
setNonEnumerable( this, '_quiet', opts.quiet ); // allow this to be internally toggled
// Initialize an internal data store:
setNonEnumerableReadOnly( this, '_internal', {} );
setNonEnumerableReadOnly( this._internal, 'presentation', {} );
setNonEnumerableReadOnly( this._internal.presentation, 'cache', {} );
setNonEnumerable( this._internal.presentation, 'counter', 0 );
// Initialize an internal command queue:
setNonEnumerableReadOnly( this, '_queue', fifo() );
// Initialize a strided internal buffer for storing the command history:
setNonEnumerableReadOnly( this, '_history', [] );
// Initialize an internal buffer for storing the current command:
setNonEnumerableReadOnly( this, '_cmd', [] );
// Initialize a executed command counter:
setNonEnumerable( this, '_count', -1 );
// Initialize an internal buffer for saving regular expression matches between command evaluations:
setNonEnumerableReadOnly( this, '_regexp', [ '', '', '', '', '', '', '', '', '', '' ] );
// Initialize a strided internal cache of context globals:
setNonEnumerableReadOnly( this, '_contextVars', [] );
// For non-sandboxed REPLs, initialize an internal buffer for storing a (unique) sorted list of "built-in" REPL global variables/properties which need to be deleted upon closing a REPL in order to allow garbage collection and prevent memory leaks:
setNonEnumerableReadOnly( this, '_globalVars', ( this._sandbox ) ? null : [] );
// Initialize a strided internal cache of resolved global variables/properties in order to allow, e.g., help text look-up based on object reference, not just alias name (note: members alternate between `'<string_alias>'` and `<resolved_value>`):
setNonEnumerableReadOnly( this, '_aliases', [] );
// Initialize a strided internal buffer for storing user-defined documentation:
setNonEnumerableReadOnly( this, '_userdocs', [] );
// Initialize an internal buffer for storing a (unique) sorted list of workspace global variables/properties which were *initially* introduced during a REPL session (note: this overlaps with `_globalVars`, but more accurately represents a snapshot of the `global` state *before* a user begins entering commands, which is useful when wanting determine what variables/identifiers a user has introduced during a REPL session):
setNonEnumerableReadOnly( this, '_workspace', [] );
// Initialize a strided internal buffer for caching "base" workspace variables:
setNonEnumerableReadOnly( this, '_workspaces', {} );
setReadOnly( this._workspaces, 'base', [] );
// Define the current workspace:
setNonEnumerable( this, '_currentWorkspace', 'base' );
// Initialize an internal flag indicating whether the REPL has been closed:
setNonEnumerable( this, '_closed', false );
// Initialize an internal flag indicating whether the REPL is currently busy with asynchronous processing:
setNonEnumerable( this, '_busy', false );
// Initialize an internal flag indicating whether we've received a `SIGINT` signal:
setNonEnumerable( this, '_SIGINT', false );
// Initialize an internal variable for caching the result of the last successfully evaluated command:
setNonEnumerable( this, '_ans', void 0 );
// Initialize an internal variable for setting a command callback:
setNonEnumerable( this, '_done', void 0 );
// Initialize internal variables for setting a keybinding:
setNonEnumerable( this, '_isCapturingKeybinding', false );
setNonEnumerable( this, '_targetAction', '' );
// Create a REPL execution context:
setNonEnumerable( this, '_context', this.createContext() );
// Create a new TAB completer:
setNonEnumerableReadOnly( this, '_completer', completerFactory( this ) );
// Create an internal readline interface:
debug( 'Creating readline interface...' );
setNonEnumerableReadOnly( this, '_rli', readline.createInterface({
'input': this._istream,
'output': this._ostream,
'terminal': opts.isTTY,
'prompt': opts.inputPrompt
}));
// Initialize a multi-line handler:
setNonEnumerableReadOnly( this, '_multilineHandler', new MultilineHandler( this, this._rli._ttyWrite ) );
// Initialize keybindings:
setNonEnumerableReadOnly( this, '_keybindings', new Keybindings( opts.keybindings ) );
// Initialize an editor actions instance:
setNonEnumerableReadOnly( this, '_editorActions', new EditorActions( this, this._rli._ttyWrite ) );
// Create a new TAB completer engine:
setNonEnumerableReadOnly( this, '_completerEngine', new CompleterEngine( this, this._completer, this._wstream, this._rli._ttyWrite ) );
// Create a new auto-closer:
setNonEnumerableReadOnly( this, '_autoCloser', new AutoCloser( this._rli, this._settings.autoClosePairs, this._settings.autoDeletePairs, this._multilineHandler ) );
// Initialize a preview completer:
setNonEnumerableReadOnly( this, '_previewCompleter', new PreviewCompleter( this._rli, this._completer, this._ostream, this._settings.completionPreviews ) );
// Initialize a syntax-highlighter:
setNonEnumerableReadOnly( this, '_syntaxHighlighter', new SyntaxHighlighter( this, this._ostream, this._settings.syntaxHighlighting ) );
// Initialize an eager evaluator:
setNonEnumerableReadOnly( this, '_eagerEvaluator', new EagerEvaluator( this, this._rli, this._settings.eagerEvaluation ) );
// Cache a reference to the private readline interface `ttyWrite` to allow calling the method when wanting default behavior:
setNonEnumerableReadOnly( this, '_ttyWrite', this._rli._ttyWrite );
// Overwrite the private `ttyWrite` method to allow processing input before a "keypress" event is triggered:
this._rli._ttyWrite = beforeKeypress; // WARNING: overwriting a private property
// Add event listeners:
this._rli.on( 'close', onClose );
this._rli.on( 'line', onLine );
this._rli.on( 'SIGINT', onSIGINT );
proc.on( 'SIGWINCH', onSIGWINCH ); // terminal resize
// Add listener for "command" events:
this.on( 'command', onCommand );
// Instruct the input stream to begin emitting "keypress" events:
readline.emitKeypressEvents( this._istream, this._rli );
// Add a listener for "keypress" events:
this._istream.on( 'keypress', onKeypress );
// Write a welcome message:
this._wstream.write( opts.welcome );
// TODO: check whether to synchronously initialize a REPL history file
// TODO: check whether to synchronously initialize a REPL log file
// Add any provided user-defined themes...
if ( opts.themes ) {
themes = objectKeys( opts.themes );
for ( i = 0; i < themes.length; i++ ) {
this.addTheme( themes[ i ], opts.themes[ themes[ i ] ] );
}
}
// Set the syntax highlighting theme...
this.settings( 'theme', opts.settings.theme );
// Initialize bracketed-paste:
if ( opts.settings.bracketedPaste !== void 0 ) {
this.settings( 'bracketedPaste', opts.settings.bracketedPaste );
}
// Check whether to load and execute a JavaScript file (e.g., prior REPL history) upon startup...
if ( opts.load ) {
this.load( opts.load );
} else {
displayPrompt( this, false );
this._count += 1;
}
return this;
/**
* Callback invoked prior to emitting a "keypress" event.
*
* @private
* @param {string} data - input data
* @param {(Object|void)} key - key object
*/
function beforeKeypress( data, key ) {
var completed;
var FLG; // flag denoting whether to bypass the default keypress behavior
if ( self._ostream.isPaging ) {
self._ostream.beforeKeypress( data, key );
return;
}
if ( self._isCapturingKeybinding ) {
self._captureKeybinding( key );
return;
}
self._autoCloser.beforeKeypress( data, key );
completed = self._previewCompleter.beforeKeypress( data, key );
FLG = self._editorActions.beforeKeypress( data, key );
self._eagerEvaluator.beforeKeypress( data, key );
// If ENTER keypress is encountered or if a preview was completed while navigating, gracefully close the completer...
if ( completed || ( key && key.name === 'return' ) ) {
self._completerEngine.closeCompleter();
} else if ( ( key && key.name === 'tab' ) || self._completerEngine.isNavigating() ) {
self._completerEngine.beforeKeypress( data, key );
return;
}
// If completion was auto-completed or an action was triggered, don't trigger multi-line keybindings to avoid double operations...
if ( !completed && !FLG ) {
self._multilineHandler.beforeKeypress( data, key );
return;
}
if ( !FLG ) {
self._ttyWrite.call( self._rli, data, key );
}
}
/**
* Callback invoked upon an input stream "keypress" event.
*
* @private
* @param {string} data - input data
* @param {(Object|void)} key - key object
* @returns {void}
*/
function onKeypress( data, key ) {
var autoClosed;
autoClosed = self._autoCloser.onKeypress( data, key );
// If auto-closing was performed, explicitly remove any currently displayed completion preview...
if ( autoClosed ) {
self._previewCompleter.clear();
}
self._completerEngine.onKeypress( data, key );
self._multilineHandler.onKeypress( data, key );
if ( !self._completerEngine.isNavigating() ) {
self._eagerEvaluator.onKeypress( data, key );
}
self._syntaxHighlighter.onKeypress();
self._previewCompleter.onKeypress( data, key );
}
/**
* Callback invoked upon a readline interface "line" event.
*
* @private
* @param {string} line - line data
*/
function onLine( line ) {
self._SIGINT = false; // reset flag
if ( self._closed === false ) {
self._multilineHandler.processLine( line );
}
}
/**
* Callback invoked upon a readline interface "close" event.
*
* @private
*/
function onClose() {
if ( self._settings.bracketedPaste && self._settings.autoDisableBracketedPasteOnExit ) { // eslint-disable-line max-len
self._multilineHandler.disableBracketedPaste();
}
ostream.end();
ostream.unpipe();
debug( 'Readline interface closed.' );
self._istream.removeListener( 'keypress', onKeypress );
proc.removeListener( 'SIGWINCH', onSIGWINCH );
debug( 'Exiting REPL...' );
self.emit( 'exit' );
}
/**
* Callback invoked upon receiving a "SIGWINCH" event (i.e., a terminal/console resize event).
*
* @private
* @returns {void}
*/
function onSIGWINCH() {
debug( 'Received a SIGWINCH event. Terminal was resized.' );
self._ostream.onResize();
self._completerEngine.onResize();
}
/**
* Callback invoked upon receiving a "SIGINT" event (e.g., Ctrl-C).
*
* @private
* @returns {void}
*/
function onSIGINT() {
var isEmpty;
debug( 'Received a SIGINT event.' );
// If the REPL is currently busy executing a command, stop waiting for it to finish:
if ( self._busy ) {
self._done( new Error( 'unexpected error. Command execution terminated.' ) );
return;
}
// Check whether the user has entered any characters:
isEmpty = ( self._rli.line.length === 0 );
// Close the completer engine:
self._completerEngine.closeCompleter();
// Clear the current line:
self.clearLine();
// In the absence of any entered partial and/or unevaluated commands, determine whether we should close the REPL...
if ( self._cmd.length === 0 && isEmpty ) {
if ( self._SIGINT ) {
self._SIGINT = false;
self.close();
return;
}
self._ostream.write( 'To exit, enter ^D or ^C again or enter quit().\n' );
self._SIGINT = true;
} else {
self._SIGINT = false;
}
// Reset the command queue:
self._queue.clear();
// Clear any command which has been buffered but not yet executed:
self.clearCommand();
// Display a new prompt:
displayPrompt( self, false );
}
/**
* Callback invoked upon executing a command.
*
* @private
* @param {string} cmd - command
* @param {boolean} success - boolean indicating whether the command successfully executed
*/
function onCommand( cmd, success ) {
self._count += 1;
debug( 'Command count: %d', self._count );
// Update the internal command history buffer: [..., <id>, <cmd>, <success>, ...]
self._history.push( self._count, cmd, success );
// TODO: if successful and if necessary, (asynchronously?) write the command to a history file (question: do we only want to write successful commands to the history file? maybe we need to option for limiting to successful commands?)
// TODO: if necessary, (asynchronously?) write the command and result to a log file (JSON serialization?)
}
}
/*
* Inherit from the `EventEmitter` prototype.
*/
inherit( REPL, EventEmitter );
/**
* Displays a command prompt.
*
* @private
* @name _displayPrompt
* @memberof REPL.prototype
* @type {Function}
* @param {boolean} [preserveCursor=false] - boolean indicating whether to preserve the cursor position
* @returns {REPL} REPL instance
*/
setNonEnumerableReadOnly( REPL.prototype, '_displayPrompt', function showPrompt( preserveCursor ) {
displayPrompt( this, Boolean( preserveCursor ) );
return this;
});
/**
* Returns the current command prompt.
*
* @private
* @name _prompt
* @memberof REPL.prototype
* @type {Function}
* @returns {string} command prompt
*/
setNonEnumerableReadOnly( REPL.prototype, '_prompt', function prompt() {
return inputPrompt( this._inputPrompt, this._count );
});
/**
* Captures the next "keypress" as a keybinding.
*
* @private
* @name _captureKeybinding
* @memberof REPL.prototype
* @type {Function}
* @param {(Object|void)} key - key object
* @returns {void}
*/
setNonEnumerableReadOnly( REPL.prototype, '_captureKeybinding', function captureKeybinding( key ) {
var parsedKeys;
if ( !key ) {
return;
}
parsedKeys = parseKey( key );
try {
this.setKeybinding( this._targetAction, parsedKeys );
this._ostream.write( format( '\n\nSuccessfully set the following keybindings for action `%s`.\n\n%s\n', this._targetAction, JSON.stringify( parsedKeys, null, 2 ) ) );
} catch ( err ) {
this._ostream.write( format( '\n\nError: %s\n', err.message ) );
}
this._isCapturingKeybinding = false;
this._targetAction = '';
displayPrompt( this, false );
});
/**
* Returns the current line's prompt length.
*
* @name promptLength
* @memberof REPL.prototype
* @type {Function}
* @returns {number} prompt length
*/
setNonEnumerableReadOnly( REPL.prototype, 'promptLength', function promptLength() {
if ( this._multilineHandler.lineIndex() === 0 ) {
return this._prompt().length;
}
return 0;
});
/**
* Returns the REPL viewport.
*
* @name viewport
* @memberof Repl.prototype
* @type {Function}
* @returns {(Array<integer>|null)} viewport dimensions (or null)
*
* @example
* var debug = require( '@stdlib/streams/node/debug-sink' );
*
* // Create a new REPL:
* var repl = new REPL({
* 'output': debug()
* });
*
* // Query the REPL viewport:
* var v = repl.viewport();
*
* // Close the REPL:
* repl.close();
*/
setNonEnumerableReadOnly( REPL.prototype, 'viewport', function viewport() {
if ( !this._isTTY ) {
return null;
}
if ( this._wstream.rows && this._wstream.columns ) {
return [ this._wstream.rows, this._wstream.columns ];
}
return null;
});
/**
* Returns the REPL viewport height.
*
* @name viewportHeight
* @memberof Repl.prototype
* @type {Function}
* @returns {integer} viewport height
*
* @example
* var debug = require( '@stdlib/streams/node/debug-sink' );
*
* // Create a new REPL:
* var repl = new REPL({
* 'output': debug()
* });
*
* // Query the REPL viewport height:
* var v = repl.viewportHeight();
*
* // Close the REPL:
* repl.close();
*/
setNonEnumerableReadOnly( REPL.prototype, 'viewportHeight', function viewportHeight() {
if ( !this._isTTY || !isNumber( this._wstream.rows ) ) {
return -1;
}
return this._wstream.rows;
});
/**
* Returns the REPL viewport width.
*
* @name viewportWidth
* @memberof Repl.prototype
* @type {Function}
* @returns {integer} viewport width
*
* @example
* var debug = require( '@stdlib/streams/node/debug-sink' );
*
* // Create a new REPL:
* var repl = new REPL({
* 'output': debug()
* });
*
* // Query the REPL viewport width:
* var v = repl.viewportWidth();
*
* // Close the REPL:
* repl.close();
*/
setNonEnumerableReadOnly( REPL.prototype, 'viewportWidth', function viewportWidth() {
if ( !this._isTTY || !isNumber( this._wstream.columns ) ) {
return -1;
}
return this._wstream.columns;
});
/**
* Creates a REPL context.
*
* @name createContext
* @memberof REPL.prototype
* @type {Function}
* @returns {Object} REPL context
*
* @example
* var debug = require( '@stdlib/streams/node/debug-sink' );
*
* // Create a new REPL:
* var repl = new REPL({
* 'output': debug()
* });
*
* // Return a new REPL context:
* var ctx = repl.createContext();
*
* // Close the REPL:
* repl.close();
*/
setNonEnumerableReadOnly( REPL.prototype, 'createContext', function createContext() {
var context;
var cmds;
debug( 'Creating REPL execution context...' );
// Create an evaluation context:
context = createEvalContext( this._contextVars, this._ostream, this._sandbox ); // eslint-disable-line max-len
// Add project APIs...
if ( this._sandbox ) {
setAliases( this._aliases, context, ALIAS_OVERRIDES );
} else {
setAliasesGlobal( this._globalVars, this._aliases, context, ALIAS_OVERRIDES ); // eslint-disable-line max-len
}
// Get the list of REPL-specific commands:
cmds = commands( this );
// Add commands requiring privileged access to internal instance variables...
if ( this._sandbox ) {
setCommands( context, cmds );
} else {
setCommandsGlobal( this._globalVars, context, cmds );
}
// NOTE: the context should not be augmented **after** this point, except as done by the user when declaring variables and functions!
// Sort the list of global variables:
if ( this._sandbox === false ) {
this._globalVars.sort( propertyComparator );
}
// Capture a snapshot of the current global workspace:
append( this._workspace, properties( context ).sort( propertyComparator ) );
return context;
});
/**
* Resets a REPL's context.
*
* @name resetContext
* @memberof REPL.prototype
* @type {Function}
* @returns {REPL} REPL instance
*
* @example
* var debug = require( '@stdlib/streams/node/debug-sink' );
*
* // Create a new REPL:
* var repl = new REPL({
* 'output': debug()
* });
*
* // ...
*
* // Reset the REPL context:
* repl.resetContext();
*
* // ...
*
* // Close the REPL:
* repl.close();
*/
setNonEnumerableReadOnly( REPL.prototype, 'resetContext', function resetContext() {
var tmp;
var key;
var o;
var i;
var j;
debug( 'Resetting REPL execution context...' );
// Before creating a new execution context in a non-sandboxed environment, remove current workspace variables in order to allow garbage collection and avoid memory leaks (e.g., variables/functions declared during a REPL session which might remain bound to the environment `global` after clearing a REPL):
if ( this._sandbox === false ) {
// WARNING: in a non-sandboxed environment, if a global variable is externally introduced during a REPL session (i.e., introduced via a mechanism outside of the REPL environment), we will delete that global variable, which means the following logic may introduce unintended side-effects for this particular edge case (e.g., application code may expect the presence of the subsequently deleted global variable). While not ideal, (a) user applications should not be introducing globals to begin with and (b) the probability of a user running a REPL session, a user clearing that REPL session, AND a global variable being introduced between starting a REPL and clearing the REPL should be negligible.
tmp = this._context.vars();
for ( i = 0; i < tmp.length; i++ ) {
if ( isConfigurableProperty( this._context, tmp[ i ] ) ) {
delete this._context[ tmp[ i ] ];
}
}
// Remove REPL globals:
for ( i = 0; i < this._globalVars.length; i++ ) {
o = this._context;
key = this._globalVars[ i ].split( '.' ); // Note: this addresses nested key paths (e.g., `a.b.c`)
for ( j = 0; j < key.length-1; j++ ) {
if ( !hasOwnProp( o, key[ j ] ) ) {
o = null;
break;
}
o = o[ key[ j ] ];
}
if ( o && isConfigurableProperty( o, key[ j ] ) ) {
delete o[ key[ j ] ];
}
}
}
// Reset internal buffers for storing context data:
if ( this._sandbox === false ) {
this._globalVars.length = 0;
}
this._aliases.length = 0;
this._workspace.length = 0;
this._contextVars.length = 0;
// Create a new execution context...
this._context = this.createContext();
this.emit( 'reset', this._context ); // note: emitting the context allows REPL wrappers to extend the newly created context
return this;
});
/**
* Clears a REPL's history.
*
* @name clearHistory
* @memberof REPL.prototype
* @type {Function}
* @returns {REPL} REPL instance
*
* @example
* var debug = require( '@stdlib/streams/node/debug-sink' );
*
* // Create a new REPL:
* var repl = new REPL({
* 'output': debug()
* });
*
* // ...
*
* // Clear the REPL history:
* repl.clearHistory();
*
* // ...
*
* // Close the REPL:
* repl.close();
*/
setNonEnumerableReadOnly( REPL.prototype, 'clearHistory', function clearHistory() {
debug( 'Resetting REPL history...' );
this._history.length = 0;
return this;
});
/**
* Clears user-defined documentation.
*
* @name clearUserDocs
* @memberof REPL.prototype
* @type {Function}
* @returns {REPL} REPL instance
*
* @example
* var debug = require( '@stdlib/streams/node/debug-sink' );
*
* // Create a new REPL:
* var repl = new REPL({
* 'output': debug()
* });
*
* // ...
*
* // Clear the user defined documentation:
* repl.clearUserDocs();
*
* // ...
*
* // Close the REPL:
* repl.close();
*/
setNonEnumerableReadOnly( REPL.prototype, 'clearUserDocs', function clearUserDocs() {
debug( 'Resetting REPL user-defined documentation...' );
this._userdocs.length = 0;
return this;
});
/**
* Returns a list of all available themes for syntax highlighting.
*
* @name themes
* @memberof REPL.prototype
* @type {Function}
* @returns {Array<string>} list of all theme names
*
* @example
* var debug = require( '@stdlib/streams/node/debug-sink' );
*
* // Create a new REPL:
* var repl = new REPL({
* 'output': debug()
* });
*
* // ...
*
* // Fetch all available themes:
* var theme = repl.themes();
*
* // ...
*
* // Close the REPL:
* repl.close();
*/
setNonEnumerableReadOnly( REPL.prototype, 'themes', function themes() {
return this._syntaxHighlighter.getThemes();
});
/**
* Returns a theme's color palette for syntax highlighting.
*
* @name getTheme
* @memberof REPL.prototype
* @type {Function}
* @param {string} theme - theme name
* @throws {TypeError} must provide a string
* @throws {Error} must provide an existing theme name
* @returns {Object} theme object
*
* @example
* var debug = require( '@stdlib/streams/node/debug-sink' );
*
* // Create a new REPL:
* var repl = new REPL({
* 'output': debug()
* });
*
* // ...
*
* // Add a user-defined theme:
* repl.addTheme( 'myTheme', {
* 'keyword': 'red'
* });
*
* // Get a theme's color palette:
* var o = repl.getTheme( 'myTheme' );
*
* // ...
*
* // Close the REPL:
* repl.close();
*/
setNonEnumerableReadOnly( REPL.prototype, 'getTheme', function getTheme( theme ) {
if ( !isString( theme ) ) {
throw new TypeError( format( 'invalid argument. First argument must be a string. Value: `%s`.', theme ) );
}
return this._syntaxHighlighter.getThemeConfig( theme );
});
/**
* Adds a syntax highlighting theme.
*
* @name addTheme
* @memberof REPL.prototype
* @type {Function}
* @param {string} name - theme name
* @param {Object} theme - theme object
* @throws {TypeError} first argument must be a string
* @throws {TypeError} second argument must be an object
* @returns {void}
*
* @example
* var debug = require( '@stdlib/streams/node/debug-sink' );
*
* // Create a new REPL:
* var repl = new REPL({
* 'output': debug()
* });
*
* // ...
*
* // Add a user-defined theme:
* repl.addTheme( 'myTheme', {