2 * xterm.js: xterm, in the browser
3 * Originally forked from (with the author's permission):
4 * Fabrice Bellard's javascript vt100 for jslinux:
5 * http://bellard.org/jslinux/
6 * Copyright (c) 2011 Fabrice Bellard
7 * The original design remains. The terminal itself
8 * has been extended to include xterm CSI codes, among
13 import { CompositionHelper
} from './CompositionHelper';
14 import { EventEmitter
} from './EventEmitter';
15 import { Viewport
} from './Viewport';
16 import { rightClickHandler
, moveTextAreaUnderMouseCursor
, pasteHandler
, copyHandler
} from './handlers/Clipboard';
17 import { CircularList
} from './utils/CircularList';
18 import { C0
} from './EscapeSequences';
19 import { InputHandler
} from './InputHandler';
20 import { Parser
} from './Parser';
21 import { Renderer
} from './Renderer';
22 import { Linkifier
} from './Linkifier';
23 import { SelectionManager
} from './SelectionManager';
24 import { CharMeasure
} from './utils/CharMeasure';
25 import * as Browser
from './utils/Browser';
26 import * as Mouse
from './utils/Mouse';
27 import { CHARSETS
} from './Charsets';
28 import { getRawByteCoords
} from './utils/Mouse';
31 * Terminal Emulation References:
33 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.txt
34 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
35 * http://invisible-island.net/vttest/
36 * http://www.inwap.com/pdp10/ansicode.txt
37 * http://linux.die.net/man/4/console_codes
38 * http://linux.die.net/man/7/urxvt
41 // Let it work inside Node.js for automated testing purposes.
42 var document
= (typeof window
!= 'undefined') ? window
.document
: null;
45 * The amount of write requests to queue before sending an XOFF signal to the
46 * pty process. This number must be small in order for ^C and similar sequences
49 var WRITE_BUFFER_PAUSE_THRESHOLD
= 5;
52 * The number of writes to perform in a single batch before allowing the
53 * renderer to catch up with a 0ms setTimeout.
55 var WRITE_BATCH_SIZE
= 300;
58 * The time between cursor blinks. This is driven by JS rather than a CSS
59 * animation due to a bug in Chromium that causes it to use excessive CPU time.
60 * See https://github.com/Microsoft/vscode/issues/22900
62 var CURSOR_BLINK_INTERVAL
= 600;
69 * Creates a new `Terminal` object.
71 * @param {object} options An object containing a set of options, the available options are:
72 * - `cursorBlink` (boolean): Whether the terminal cursor blinks
73 * - `cols` (number): The number of columns of the terminal (horizontal size)
74 * - `rows` (number): The number of rows of the terminal (vertical size)
78 * @alias module:xterm/src/xterm
80 function Terminal(options
) {
83 if (!(this instanceof Terminal
)) {
84 return new Terminal(arguments
[0], arguments
[1], arguments
[2]);
87 self
.browser
= Browser
;
88 self
.cancel
= Terminal
.cancel
;
90 EventEmitter
.call(this);
92 if (typeof options
=== 'number') {
100 options
= options
|| {};
103 Object
.keys(Terminal
.defaults
).forEach(function(key
) {
104 if (options
[key
] == null) {
105 options
[key
] = Terminal
.options
[key
];
107 if (Terminal
[key
] !== Terminal
.defaults
[key
]) {
108 options
[key
] = Terminal
[key
];
111 self
[key
] = options
[key
];
114 if (options
.colors
.length
=== 8) {
115 options
.colors
= options
.colors
.concat(Terminal
._colors
.slice(8));
116 } else if (options
.colors
.length
=== 16) {
117 options
.colors
= options
.colors
.concat(Terminal
._colors
.slice(16));
118 } else if (options
.colors
.length
=== 10) {
119 options
.colors
= options
.colors
.slice(0, -2).concat(
120 Terminal
._colors
.slice(8, -2), options
.colors
.slice(-2));
121 } else if (options
.colors
.length
=== 18) {
122 options
.colors
= options
.colors
.concat(
123 Terminal
._colors
.slice(16, -2), options
.colors
.slice(-2));
125 this.colors
= options
.colors
;
127 this.options
= options
;
129 // this.context = options.context || window;
130 // this.document = options.document || document;
131 this.parent
= options
.body
|| options
.parent
|| (
132 document
? document
.getElementsByTagName('body')[0] : null
135 this.cols
= options
.cols
|| options
.geometry
[0];
136 this.rows
= options
.rows
|| options
.geometry
[1];
137 this.geometry
= [this.cols
, this.rows
];
139 if (options
.handler
) {
140 this.on('data', options
.handler
);
144 * The scroll position of the y cursor, ie. ybase + y = the y position within the entire
150 * The scroll position of the viewport
155 * The cursor's x position after ybase
160 * The cursor's y position after ybase
164 this.cursorState
= 0;
165 this.cursorHidden
= false;
169 this.scrollBottom
= this.rows
- 1;
170 this.customKeyEventHandler
= null;
171 this.cursorBlinkInterval
= null;
174 this.applicationKeypad
= false;
175 this.applicationCursor
= false;
176 this.originMode
= false;
177 this.insertMode
= false;
178 this.wraparoundMode
= true; // defaults: xterm - true, vt100 - false
183 this.gcharset
= null;
185 this.charsets
= [null];
209 this.readable
= true;
210 this.writable
= true;
212 this.defAttr
= (0 << 18) | (257 << 9) | (256 << 0);
213 this.curAttr
= this.defAttr
;
216 this.currentParam
= 0;
220 this.inputHandler
= new InputHandler(this);
221 this.parser
= new Parser(this.inputHandler
, this);
222 // Reuse renderer if the Terminal is being recreated via a Terminal.reset call.
223 this.renderer
= this.renderer
|| null;
224 this.selectionManager
= this.selectionManager
|| null;
225 this.linkifier
= this.linkifier
|| new Linkifier();
228 this.writeBuffer
= [];
229 this.writeInProgress
= false;
232 * Whether _xterm.js_ sent XOFF in order to catch up with the pty process.
233 * This is a distinct state from writeStopped so that if the user requested
234 * XOFF via ^S that it will not automatically resume when the writeBuffer goes
237 this.xoffSentToCatchUp
= false;
239 /** Whether writing has been stopped as a result of XOFF */
240 this.writeStopped
= false;
242 // leftover surrogate high from previous write invocation
243 this.surrogate_high
= '';
246 * An array of all lines in the entire buffer, including the prompt. The lines are array of
247 * characters which are 2-length arrays where [0] is an attribute and [1] is the character.
249 this.lines
= new CircularList(this.scrollback
);
252 this.lines
.push(this.blankLine());
254 // Ensure the selection manager has the correct buffer
255 if (this.selectionManager
) {
256 this.selectionManager
.setBuffer(this.lines
);
262 // Store if user went browsing history in scrollback
263 this.userScrolling
= false;
266 inherits(Terminal
, EventEmitter
);
269 * back_color_erase feature for xterm.
271 Terminal
.prototype.eraseAttr = function() {
272 // if (this.is('screen')) return this.defAttr;
273 return (this.defAttr
& ~0x1ff) | (this.curAttr
& 0x1ff);
281 Terminal
.tangoColors
= [
302 // Colors 0-15 + 16-255
303 // Much thanks to TooTallNate for writing this.
304 Terminal
.colors
= (function() {
305 var colors
= Terminal
.tangoColors
.slice()
306 , r
= [0x00, 0x5f, 0x87, 0xaf, 0xd7, 0xff]
311 for (; i
< 216; i
++) {
312 out(r
[(i
/ 36) % 6 | 0], r
[(i
/ 6) % 6 | 0], r
[i
% 6]);
317 for (; i
< 24; i
++) {
322 function out(r
, g
, b
) {
323 colors
.push('#' + hex(r
) + hex(g
) + hex(b
));
328 return c
.length
< 2 ? '0' + c
: c
;
334 Terminal
._colors
= Terminal
.colors
.slice();
336 Terminal
.vcolors
= (function() {
338 , colors
= Terminal
.colors
342 for (; i
< 256; i
++) {
343 color
= parseInt(colors
[i
].substring(1), 16);
345 (color
>> 16) & 0xff,
358 Terminal
.defaults
= {
359 colors
: Terminal
.colors
,
365 cursorStyle
: 'block',
373 useFlowControl
: false,
375 // programFeatures: false,
379 Terminal
.options
= {};
381 Terminal
.focus
= null;
383 each(keys(Terminal
.defaults
), function(key
) {
384 Terminal
[key
] = Terminal
.defaults
[key
];
385 Terminal
.options
[key
] = Terminal
.defaults
[key
];
389 * Focus the terminal. Delegates focus handling to the terminal's DOM element.
391 Terminal
.prototype.focus = function() {
392 return this.textarea
.focus();
396 * Retrieves an option's value from the terminal.
397 * @param {string} key The option key.
399 Terminal
.prototype.getOption = function(key
, value
) {
400 if (!(key
in Terminal
.defaults
)) {
401 throw new Error('No option with key "' + key
+ '"');
404 if (typeof this.options
[key
] !== 'undefined') {
405 return this.options
[key
];
412 * Sets an option on the terminal.
413 * @param {string} key The option key.
414 * @param {string} value The option value.
416 Terminal
.prototype.setOption = function(key
, value
) {
417 if (!(key
in Terminal
.defaults
)) {
418 throw new Error('No option with key "' + key
+ '"');
422 if (value
< this.rows
) {
423 let msg
= 'Setting the scrollback value less than the number of rows ';
425 msg
+= `(${this.rows}) is not allowed.`;
431 if (this.options
[key
] !== value
) {
432 if (this.lines
.length
> value
) {
433 const amountToTrim
= this.lines
.length
- value
;
434 const needsRefresh
= (this.ydisp
- amountToTrim
< 0);
435 this.lines
.trimStart(amountToTrim
);
436 this.ybase
= Math
.max(this.ybase
- amountToTrim
, 0);
437 this.ydisp
= Math
.max(this.ydisp
- amountToTrim
, 0);
439 this.refresh(0, this.rows
- 1);
442 this.lines
.maxLength
= value
;
443 this.viewport
.syncScrollArea();
448 this.options
[key
] = value
;
450 case 'cursorBlink': this.setCursorBlinking(value
); break;
452 // Style 'block' applies with no class
453 this.element
.classList
.toggle(`xterm-cursor-style-underline`, value
=== 'underline');
454 this.element
.classList
.toggle(`xterm-cursor-style-bar`, value
=== 'bar');
456 case 'tabStopWidth': this.setupStops(); break;
460 Terminal
.prototype.restartCursorBlinking = function () {
461 this.setCursorBlinking(this.options
.cursorBlink
);
464 Terminal
.prototype.setCursorBlinking = function (enabled
) {
465 this.element
.classList
.toggle('xterm-cursor-blink', enabled
);
466 this.clearCursorBlinkingInterval();
469 this.cursorBlinkInterval
= setInterval(function () {
470 self
.element
.classList
.toggle('xterm-cursor-blink-on');
471 }, CURSOR_BLINK_INTERVAL
);
475 Terminal
.prototype.clearCursorBlinkingInterval = function () {
476 this.element
.classList
.remove('xterm-cursor-blink-on');
477 if (this.cursorBlinkInterval
) {
478 clearInterval(this.cursorBlinkInterval
);
479 this.cursorBlinkInterval
= null;
484 * Binds the desired focus behavior on a given terminal object.
488 Terminal
.bindFocus = function (term
) {
489 on(term
.textarea
, 'focus', function (ev
) {
490 if (term
.sendFocus
) {
491 term
.send(C0
.ESC
+ '[I');
493 term
.element
.classList
.add('focus');
495 term
.restartCursorBlinking
.apply(term
);
496 Terminal
.focus
= term
;
497 term
.emit('focus', {terminal
: term
});
502 * Blur the terminal. Delegates blur handling to the terminal's DOM element.
504 Terminal
.prototype.blur = function() {
505 return this.textarea
.blur();
509 * Binds the desired blur behavior on a given terminal object.
513 Terminal
.bindBlur = function (term
) {
514 on(term
.textarea
, 'blur', function (ev
) {
515 term
.refresh(term
.y
, term
.y
);
516 if (term
.sendFocus
) {
517 term
.send(C0
.ESC
+ '[O');
519 term
.element
.classList
.remove('focus');
520 term
.clearCursorBlinkingInterval
.apply(term
);
521 Terminal
.focus
= null;
522 term
.emit('blur', {terminal
: term
});
527 * Initialize default behavior
529 Terminal
.prototype.initGlobal = function() {
532 Terminal
.bindKeys(this);
533 Terminal
.bindFocus(this);
534 Terminal
.bindBlur(this);
536 // Bind clipboard functionality
537 on(this.element
, 'copy', event
=> {
538 // If mouse events are active it means the selection manager is disabled and
539 // copy should be handled by the host program.
540 if (this.mouseEvents
) {
543 copyHandler(event
, term
, this.selectionManager
);
545 const pasteHandlerWrapper
= event
=> pasteHandler(event
, term
);
546 on(this.textarea
, 'paste', pasteHandlerWrapper
);
547 on(this.element
, 'paste', pasteHandlerWrapper
);
549 // Handle right click context menus
550 if (term
.browser
.isFirefox
) {
551 // Firefox doesn't appear to fire the contextmenu event on right click
552 on(this.element
, 'mousedown', event
=> {
553 if (event
.button
== 2) {
554 rightClickHandler(event
, this.textarea
, this.selectionManager
);
558 on(this.element
, 'contextmenu', event
=> {
559 rightClickHandler(event
, this.textarea
, this.selectionManager
);
563 // Move the textarea under the cursor when middle clicking on Linux to ensure
564 // middle click to paste selection works. This only appears to work in Chrome
565 // at the time is writing.
566 if (term
.browser
.isLinux
) {
567 // Use auxclick event over mousedown the latter doesn't seem to work. Note
568 // that the regular click event doesn't fire for the middle mouse button.
569 on(this.element
, 'auxclick', event
=> {
570 if (event
.button
=== 1) {
571 moveTextAreaUnderMouseCursor(event
, this.textarea
, this.selectionManager
);
578 * Apply key handling to the terminal
580 Terminal
.bindKeys = function(term
) {
581 on(term
.element
, 'keydown', function(ev
) {
582 if (document
.activeElement
!= this) {
588 on(term
.element
, 'keypress', function(ev
) {
589 if (document
.activeElement
!= this) {
595 on(term
.element
, 'keyup', function(ev
) {
596 if (!wasMondifierKeyOnlyEvent(ev
)) {
601 on(term
.textarea
, 'keydown', function(ev
) {
605 on(term
.textarea
, 'keypress', function(ev
) {
607 // Truncate the textarea's value, since it is not needed
611 on(term
.textarea
, 'compositionstart', term
.compositionHelper
.compositionstart
.bind(term
.compositionHelper
));
612 on(term
.textarea
, 'compositionupdate', term
.compositionHelper
.compositionupdate
.bind(term
.compositionHelper
));
613 on(term
.textarea
, 'compositionend', term
.compositionHelper
.compositionend
.bind(term
.compositionHelper
));
614 term
.on('refresh', term
.compositionHelper
.updateCompositionElements
.bind(term
.compositionHelper
));
615 term
.on('refresh', function (data
) {
616 term
.queueLinkification(data
.start
, data
.end
)
622 * Insert the given row to the terminal or produce a new one
623 * if no row argument is passed. Return the inserted row.
624 * @param {HTMLElement} row (optional) The row to append to the terminal.
626 Terminal
.prototype.insertRow = function (row
) {
627 if (typeof row
!= 'object') {
628 row
= document
.createElement('div');
631 this.rowContainer
.appendChild(row
);
632 this.children
.push(row
);
638 * Opens the terminal within an element.
640 * @param {HTMLElement} parent The element to create the terminal within.
641 * @param {boolean} focus Focus the terminal, after it gets instantiated in the DOM
643 Terminal
.prototype.open = function(parent
, focus
) {
644 var self
=this, i
=0, div
;
646 this.parent
= parent
|| this.parent
;
649 throw new Error('Terminal requires a parent element.');
652 // Grab global elements
653 this.context
= this.parent
.ownerDocument
.defaultView
;
654 this.document
= this.parent
.ownerDocument
;
655 this.body
= this.document
.getElementsByTagName('body')[0];
657 //Create main element container
658 this.element
= this.document
.createElement('div');
659 this.element
.classList
.add('terminal');
660 this.element
.classList
.add('xterm');
661 this.element
.classList
.add('xterm-theme-' + this.theme
);
662 this.setCursorBlinking(this.options
.cursorBlink
);
664 this.element
.setAttribute('tabindex', 0);
666 this.viewportElement
= document
.createElement('div');
667 this.viewportElement
.classList
.add('xterm-viewport');
668 this.element
.appendChild(this.viewportElement
);
669 this.viewportScrollArea
= document
.createElement('div');
670 this.viewportScrollArea
.classList
.add('xterm-scroll-area');
671 this.viewportElement
.appendChild(this.viewportScrollArea
);
673 // Create the selection container.
674 this.selectionContainer
= document
.createElement('div');
675 this.selectionContainer
.classList
.add('xterm-selection');
676 this.element
.appendChild(this.selectionContainer
);
678 // Create the container that will hold the lines of the terminal and then
679 // produce the lines the lines.
680 this.rowContainer
= document
.createElement('div');
681 this.rowContainer
.classList
.add('xterm-rows');
682 this.element
.appendChild(this.rowContainer
);
684 this.linkifier
.attachToDom(document
, this.children
);
686 // Create the container that will hold helpers like the textarea for
687 // capturing DOM Events. Then produce the helpers.
688 this.helperContainer
= document
.createElement('div');
689 this.helperContainer
.classList
.add('xterm-helpers');
690 // TODO: This should probably be inserted once it's filled to prevent an additional layout
691 this.element
.appendChild(this.helperContainer
);
692 this.textarea
= document
.createElement('textarea');
693 this.textarea
.classList
.add('xterm-helper-textarea');
694 this.textarea
.setAttribute('autocorrect', 'off');
695 this.textarea
.setAttribute('autocapitalize', 'off');
696 this.textarea
.setAttribute('spellcheck', 'false');
697 this.textarea
.tabIndex
= 0;
698 this.textarea
.addEventListener('focus', function() {
699 self
.emit('focus', {terminal
: self
});
701 this.textarea
.addEventListener('blur', function() {
702 self
.emit('blur', {terminal
: self
});
704 this.helperContainer
.appendChild(this.textarea
);
706 this.compositionView
= document
.createElement('div');
707 this.compositionView
.classList
.add('composition-view');
708 this.compositionHelper
= new CompositionHelper(this.textarea
, this.compositionView
, this);
709 this.helperContainer
.appendChild(this.compositionView
);
711 this.charSizeStyleElement
= document
.createElement('style');
712 this.helperContainer
.appendChild(this.charSizeStyleElement
);
714 for (; i
< this.rows
; i
++) {
717 this.parent
.appendChild(this.element
);
719 this.charMeasure
= new CharMeasure(document
, this.helperContainer
);
720 this.charMeasure
.on('charsizechanged', function () {
721 self
.updateCharSizeStyles();
723 this.charMeasure
.measure();
725 this.viewport
= new Viewport(this, this.viewportElement
, this.viewportScrollArea
, this.charMeasure
);
726 this.renderer
= new Renderer(this);
727 this.selectionManager
= new SelectionManager(this, this.lines
, this.rowContainer
, this.charMeasure
);
728 this.selectionManager
.on('refresh', data
=> {
729 this.renderer
.refreshSelection(data
.start
, data
.end
);
731 this.selectionManager
.on('newselection', text
=> {
732 // If there's a new selection, put it into the textarea, focus and select it
733 // in order to register it as a selection on the OS. This event is fired
734 // only on Linux to enable middle click to paste selection.
735 this.textarea
.value
= text
;
736 this.textarea
.focus();
737 this.textarea
.select();
739 this.on('scroll', () => this.selectionManager
.refresh());
740 this.viewportElement
.addEventListener('scroll', () => this.selectionManager
.refresh());
742 // Setup loop that draws to screen
743 this.refresh(0, this.rows
- 1);
745 // Initialize global actions that
746 // need to be taken on the document.
750 * Automatic focus functionality.
751 * TODO: Default to `false` starting with xterm.js 3.0.
753 if (typeof focus
== 'undefined') {
754 let message
= 'You did not pass the `focus` argument in `Terminal.prototype.open()`.\n';
756 message
+= 'The `focus` argument now defaults to `true` but starting with xterm.js 3.0 ';
757 message
+= 'it will default to `false`.';
759 console
.warn(message
);
767 on(this.element
, 'click', function() {
768 var selection
= document
.getSelection(),
769 collapsed
= selection
.isCollapsed
,
770 isRange
= typeof collapsed
== 'boolean' ? !collapsed
: selection
.type
== 'Range';
776 // Listen for mouse events and translate
777 // them into terminal mouse protocols.
781 * This event is emitted when terminal has completed opening.
790 * Attempts to load an add-on using CommonJS or RequireJS (whichever is available).
791 * @param {string} addon The name of the addon to load
794 Terminal
.loadAddon = function(addon
, callback
) {
795 if (typeof exports
=== 'object' && typeof module
=== 'object') {
797 return require('./addons/' + addon
+ '/' + addon
);
798 } else if (typeof define
== 'function') {
800 return require(['./addons/' + addon
+ '/' + addon
], callback
);
802 console
.error('Cannot load a module without a CommonJS or RequireJS environment.');
808 * Updates the helper CSS class with any changes necessary after the terminal's
809 * character width has been changed.
811 Terminal
.prototype.updateCharSizeStyles = function() {
812 this.charSizeStyleElement
.textContent
=
813 `.xterm-wide-char{width:${this.charMeasure.width * 2}px;}` +
814 `.xterm-normal-char{width:${this.charMeasure.width}px;}` +
815 `.xterm-rows > div{height:${this.charMeasure.height}px;}`;
820 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#Mouse%20Tracking
821 * To better understand these
822 * the xterm code is very helpful:
824 * button.c, charproc.c, misc.c
825 * Relevant functions in xterm/button.c:
826 * BtnCode, EmitButtonCode, EditorButton, SendMousePosition
828 Terminal
.prototype.bindMouse = function() {
829 var el
= this.element
, self
= this, pressed
= 32;
831 // mouseup, mousedown, wheel
832 // left click: ^[[M 3<^[[M#3<
834 function sendButton(ev
) {
838 // get the xterm-style button
839 button
= getButton(ev
);
841 // get mouse coordinates
842 pos
= getRawByteCoords(ev
, self
.rowContainer
, self
.charMeasure
, self
.cols
, self
.rows
);
845 sendEvent(button
, pos
);
847 switch (ev
.overrideType
|| ev
.type
) {
852 // keep it at the left
853 // button, just in case.
864 // motion example of a left click:
865 // ^[[M 3<^[[M@4<^[[M@5<^[[M@6<^[[M@7<^[[M#7<
866 function sendMove(ev
) {
870 pos
= getRawByteCoords(ev
, self
.rowContainer
, self
.charMeasure
, self
.cols
, self
.rows
);
873 // buttons marked as motions
874 // are incremented by 32
877 sendEvent(button
, pos
);
881 // position to characters
882 function encode(data
, ch
) {
883 if (!self
.utfMouse
) {
884 if (ch
=== 255) return data
.push(0);
885 if (ch
> 127) ch
= 127;
888 if (ch
=== 2047) return data
.push(0);
892 if (ch
> 2047) ch
= 2047;
893 data
.push(0xC0 | (ch
>> 6));
894 data
.push(0x80 | (ch
& 0x3F));
899 // send a mouse event:
900 // regular/utf8: ^[[M Cb Cx Cy
901 // urxvt: ^[[ Cb ; Cx ; Cy M
902 // sgr: ^[[ Cb ; Cx ; Cy M/m
903 // vt300: ^[[ 24(1/3/5)~ [ Cx , Cy ] \r
904 // locator: CSI P e ; P b ; P r ; P c ; P p & w
905 function sendEvent(button
, pos
) {
906 // self.emit('mouse', {
912 if (self
.vt300Mouse
) {
914 // http://www.vt100.net/docs/vt3xx-gp/chapter15.html
918 var data
= C0
.ESC
+ '[24';
919 if (button
=== 0) data
+= '1';
920 else if (button
=== 1) data
+= '3';
921 else if (button
=== 2) data
+= '5';
922 else if (button
=== 3) return;
924 data
+= '~[' + pos
.x
+ ',' + pos
.y
+ ']\r';
929 if (self
.decLocator
) {
934 if (button
=== 0) button
= 2;
935 else if (button
=== 1) button
= 4;
936 else if (button
=== 2) button
= 6;
937 else if (button
=== 3) button
= 3;
938 self
.send(C0
.ESC
+ '['
941 + (button
=== 3 ? 4 : 0)
952 if (self
.urxvtMouse
) {
957 self
.send(C0
.ESC
+ '[' + button
+ ';' + pos
.x
+ ';' + pos
.y
+ 'M');
964 self
.send(C0
.ESC
+ '[<'
965 + (((button
& 3) === 3 ? button
& ~3 : button
) - 32)
970 + ((button
& 3) === 3 ? 'm' : 'M'));
976 encode(data
, button
);
980 self
.send(C0
.ESC
+ '[M' + String
.fromCharCode
.apply(String
, data
));
983 function getButton(ev
) {
996 // 1, and 2 - with 64 added
997 switch (ev
.overrideType
|| ev
.type
) {
999 button
= ev
.button
!= null
1005 if (self
.browser
.isMSIE
) {
1006 button
= button
=== 1 ? 0 : button
=== 4 ? 1 : button
;
1012 case 'DOMMouseScroll':
1013 button
= ev
.detail
< 0
1018 button
= ev
.wheelDeltaY
> 0
1024 // next three bits are the modifiers:
1025 // 4 = shift, 8 = meta, 16 = control
1026 shift
= ev
.shiftKey
? 4 : 0;
1027 meta
= ev
.metaKey
? 8 : 0;
1028 ctrl
= ev
.ctrlKey
? 16 : 0;
1029 mod
= shift
| meta
| ctrl
;
1032 if (self
.vt200Mouse
) {
1035 } else if (!self
.normalMouse
) {
1040 button
= (32 + (mod
<< 2)) + button
;
1045 on(el
, 'mousedown', function(ev
) {
1046 if (!self
.mouseEvents
) return;
1055 //if (self.vt200Mouse && !self.normalMouse) {
1056 if (self
.vt200Mouse
) {
1057 ev
.overrideType
= 'mouseup';
1059 return self
.cancel(ev
);
1063 if (self
.normalMouse
) on(self
.document
, 'mousemove', sendMove
);
1065 // x10 compatibility mode can't send button releases
1066 if (!self
.x10Mouse
) {
1067 on(self
.document
, 'mouseup', function up(ev
) {
1069 if (self
.normalMouse
) off(self
.document
, 'mousemove', sendMove
);
1070 off(self
.document
, 'mouseup', up
);
1071 return self
.cancel(ev
);
1075 return self
.cancel(ev
);
1078 //if (self.normalMouse) {
1079 // on(self.document, 'mousemove', sendMove);
1082 on(el
, 'wheel', function(ev
) {
1083 if (!self
.mouseEvents
) return;
1086 || self
.decLocator
) return;
1088 return self
.cancel(ev
);
1091 // allow wheel scrolling in
1092 // the shell for example
1093 on(el
, 'wheel', function(ev
) {
1094 if (self
.mouseEvents
) return;
1095 self
.viewport
.onWheel(ev
);
1096 return self
.cancel(ev
);
1099 on(el
, 'touchstart', function(ev
) {
1100 if (self
.mouseEvents
) return;
1101 self
.viewport
.onTouchStart(ev
);
1102 return self
.cancel(ev
);
1105 on(el
, 'touchmove', function(ev
) {
1106 if (self
.mouseEvents
) return;
1107 self
.viewport
.onTouchMove(ev
);
1108 return self
.cancel(ev
);
1113 * Destroys the terminal.
1115 Terminal
.prototype.destroy = function() {
1116 this.readable
= false;
1117 this.writable
= false;
1119 this.handler = function() {};
1120 this.write = function() {};
1121 if (this.element
&& this.element
.parentNode
) {
1122 this.element
.parentNode
.removeChild(this.element
);
1124 //this.emit('close');
1128 * Tells the renderer to refresh terminal content between two rows (inclusive) at the next
1130 * @param {number} start The row to start from (between 0 and this.rows - 1).
1131 * @param {number} end The row to end at (between start and this.rows - 1).
1133 Terminal
.prototype.refresh = function(start
, end
) {
1134 if (this.renderer
) {
1135 this.renderer
.queueRefresh(start
, end
);
1140 * Queues linkification for the specified rows.
1141 * @param {number} start The row to start from (between 0 and this.rows - 1).
1142 * @param {number} end The row to end at (between start and this.rows - 1).
1144 Terminal
.prototype.queueLinkification = function(start
, end
) {
1145 if (this.linkifier
) {
1146 for (let i
= start
; i
<= end
; i
++) {
1147 this.linkifier
.linkifyRow(i
);
1153 * Display the cursor element
1155 Terminal
.prototype.showCursor = function() {
1156 if (!this.cursorState
) {
1157 this.cursorState
= 1;
1158 this.refresh(this.y
, this.y
);
1163 * Scroll the terminal down 1 row, creating a blank line.
1164 * @param {boolean} isWrapped Whether the new line is wrapped from the previous
1167 Terminal
.prototype.scroll = function(isWrapped
) {
1170 // Make room for the new row in lines
1171 if (this.lines
.length
=== this.lines
.maxLength
) {
1172 this.lines
.trimStart(1);
1174 if (this.ydisp
!== 0) {
1181 // TODO: Why is this done twice?
1182 if (!this.userScrolling
) {
1183 this.ydisp
= this.ybase
;
1187 row
= this.ybase
+ this.rows
- 1;
1189 // subtract the bottom scroll region
1190 row
-= this.rows
- 1 - this.scrollBottom
;
1192 if (row
=== this.lines
.length
) {
1193 // Optimization: pushing is faster than splicing when they amount to the same behavior
1194 this.lines
.push(this.blankLine(undefined, isWrapped
));
1197 this.lines
.splice(row
, 0, this.blankLine(undefined, isWrapped
));
1200 if (this.scrollTop
!== 0) {
1201 if (this.ybase
!== 0) {
1203 if (!this.userScrolling
) {
1204 this.ydisp
= this.ybase
;
1207 this.lines
.splice(this.ybase
+ this.scrollTop
, 1);
1211 this.updateRange(this.scrollTop
);
1212 this.updateRange(this.scrollBottom
);
1215 * This event is emitted whenever the terminal is scrolled.
1216 * The one parameter passed is the new y display position.
1220 this.emit('scroll', this.ydisp
);
1224 * Scroll the display of the terminal
1225 * @param {number} disp The number of lines to scroll down (negatives scroll up).
1226 * @param {boolean} suppressScrollEvent Don't emit the scroll event as scrollDisp. This is used
1227 * to avoid unwanted events being handled by the veiwport when the event was triggered from the
1228 * viewport originally.
1230 Terminal
.prototype.scrollDisp = function(disp
, suppressScrollEvent
) {
1232 if (this.ydisp
=== 0) {
1235 this.userScrolling
= true;
1236 } else if (disp
+ this.ydisp
>= this.ybase
) {
1237 this.userScrolling
= false;
1240 const oldYdisp
= this.ydisp
;
1241 this.ydisp
= Math
.max(Math
.min(this.ydisp
+ disp
, this.ybase
), 0);
1243 // No change occurred, don't trigger scroll/refresh
1244 if (oldYdisp
=== this.ydisp
) {
1248 if (!suppressScrollEvent
) {
1249 this.emit('scroll', this.ydisp
);
1252 this.refresh(0, this.rows
- 1);
1256 * Scroll the display of the terminal by a number of pages.
1257 * @param {number} pageCount The number of pages to scroll (negative scrolls up).
1259 Terminal
.prototype.scrollPages = function(pageCount
) {
1260 this.scrollDisp(pageCount
* (this.rows
- 1));
1264 * Scrolls the display of the terminal to the top.
1266 Terminal
.prototype.scrollToTop = function() {
1267 this.scrollDisp(-this.ydisp
);
1271 * Scrolls the display of the terminal to the bottom.
1273 Terminal
.prototype.scrollToBottom = function() {
1274 this.scrollDisp(this.ybase
- this.ydisp
);
1278 * Writes text to the terminal.
1279 * @param {string} data The text to write to the terminal.
1281 Terminal
.prototype.write = function(data
) {
1282 this.writeBuffer
.push(data
);
1284 // Send XOFF to pause the pty process if the write buffer becomes too large so
1285 // xterm.js can catch up before more data is sent. This is necessary in order
1286 // to keep signals such as ^C responsive.
1287 if (this.options
.useFlowControl
&& !this.xoffSentToCatchUp
&& this.writeBuffer
.length
>= WRITE_BUFFER_PAUSE_THRESHOLD
) {
1288 // XOFF - stop pty pipe
1289 // XON will be triggered by emulator before processing data chunk
1291 this.xoffSentToCatchUp
= true;
1294 if (!this.writeInProgress
&& this.writeBuffer
.length
> 0) {
1295 // Kick off a write which will write all data in sequence recursively
1296 this.writeInProgress
= true;
1297 // Kick off an async innerWrite so more writes can come in while processing data
1299 setTimeout(function () {
1305 Terminal
.prototype.innerWrite = function() {
1306 var writeBatch
= this.writeBuffer
.splice(0, WRITE_BATCH_SIZE
);
1307 while (writeBatch
.length
> 0) {
1308 var data
= writeBatch
.shift();
1309 var l
= data
.length
, i
= 0, j
, cs
, ch
, code
, low
, ch_width
, row
;
1311 // If XOFF was sent in order to catch up with the pty process, resume it if
1312 // the writeBuffer is empty to allow more data to come in.
1313 if (this.xoffSentToCatchUp
&& writeBatch
.length
=== 0 && this.writeBuffer
.length
=== 0) {
1315 this.xoffSentToCatchUp
= false;
1318 this.refreshStart
= this.y
;
1319 this.refreshEnd
= this.y
;
1321 // HACK: Set the parser state based on it's state at the time of return.
1322 // This works around the bug #662 which saw the parser state reset in the
1323 // middle of parsing escape sequence in two chunks. For some reason the
1324 // state of the parser resets to 0 after exiting parser.parse. This change
1325 // just sets the state back based on the correct return statement.
1326 var state
= this.parser
.parse(data
);
1327 this.parser
.setState(state
);
1329 this.updateRange(this.y
);
1330 this.refresh(this.refreshStart
, this.refreshEnd
);
1332 if (this.writeBuffer
.length
> 0) {
1333 // Allow renderer to catch up before processing the next batch
1335 setTimeout(function () {
1339 this.writeInProgress
= false;
1344 * Writes text to the terminal, followed by a break line character (\n).
1345 * @param {string} data The text to write to the terminal.
1347 Terminal
.prototype.writeln = function(data
) {
1348 this.write(data
+ '\r\n');
1352 * DEPRECATED: only for backward compatibility. Please use attachCustomKeyEventHandler() instead.
1353 * @param {function} customKeydownHandler The custom KeyboardEvent handler to attach. This is a
1354 * function that takes a KeyboardEvent, allowing consumers to stop propogation and/or prevent
1355 * the default action. The function returns whether the event should be processed by xterm.js.
1357 Terminal
.prototype.attachCustomKeydownHandler = function(customKeydownHandler
) {
1358 let message
= 'attachCustomKeydownHandler() is DEPRECATED and will be removed soon. Please use attachCustomKeyEventHandler() instead.';
1359 console
.warn(message
);
1360 this.attachCustomKeyEventHandler(customKeydownHandler
);
1364 * Attaches a custom key event handler which is run before keys are processed, giving consumers of
1365 * xterm.js ultimate control as to what keys should be processed by the terminal and what keys
1367 * @param {function} customKeyEventHandler The custom KeyboardEvent handler to attach. This is a
1368 * function that takes a KeyboardEvent, allowing consumers to stop propogation and/or prevent
1369 * the default action. The function returns whether the event should be processed by xterm.js.
1371 Terminal
.prototype.attachCustomKeyEventHandler = function(customKeyEventHandler
) {
1372 this.customKeyEventHandler
= customKeyEventHandler
;
1376 * Attaches a http(s) link handler, forcing web links to behave differently to
1377 * regular <a> tags. This will trigger a refresh as links potentially need to be
1378 * reconstructed. Calling this with null will remove the handler.
1379 * @param {LinkMatcherHandler} handler The handler callback function.
1381 Terminal
.prototype.setHypertextLinkHandler = function(handler
) {
1382 if (!this.linkifier
) {
1383 throw new Error('Cannot attach a hypertext link handler before Terminal.open is called');
1385 this.linkifier
.setHypertextLinkHandler(handler
);
1386 // Refresh to force links to refresh
1387 this.refresh(0, this.rows
- 1);
1391 * Attaches a validation callback for hypertext links. This is useful to use
1392 * validation logic or to do something with the link's element and url.
1393 * @param {LinkMatcherValidationCallback} callback The callback to use, this can
1394 * be cleared with null.
1396 Terminal
.prototype.setHypertextValidationCallback = function(callback
) {
1397 if (!this.linkifier
) {
1398 throw new Error('Cannot attach a hypertext validation callback before Terminal.open is called');
1400 this.linkifier
.setHypertextValidationCallback(callback
);
1401 // Refresh to force links to refresh
1402 this.refresh(0, this.rows
- 1);
1406 * Registers a link matcher, allowing custom link patterns to be matched and
1408 * @param {RegExp} regex The regular expression to search for, specifically
1409 * this searches the textContent of the rows. You will want to use \s to match
1410 * a space ' ' character for example.
1411 * @param {LinkMatcherHandler} handler The callback when the link is called.
1412 * @param {LinkMatcherOptions} [options] Options for the link matcher.
1413 * @return {number} The ID of the new matcher, this can be used to deregister.
1415 Terminal
.prototype.registerLinkMatcher = function(regex
, handler
, options
) {
1416 if (this.linkifier
) {
1417 var matcherId
= this.linkifier
.registerLinkMatcher(regex
, handler
, options
);
1418 this.refresh(0, this.rows
- 1);
1424 * Deregisters a link matcher if it has been registered.
1425 * @param {number} matcherId The link matcher's ID (returned after register)
1427 Terminal
.prototype.deregisterLinkMatcher = function(matcherId
) {
1428 if (this.linkifier
) {
1429 if (this.linkifier
.deregisterLinkMatcher(matcherId
)) {
1430 this.refresh(0, this.rows
- 1);
1436 * Gets whether the terminal has an active selection.
1438 Terminal
.prototype.hasSelection = function() {
1439 return this.selectionManager
.hasSelection
;
1443 * Gets the terminal's current selection, this is useful for implementing copy
1444 * behavior outside of xterm.js.
1446 Terminal
.prototype.getSelection = function() {
1447 return this.selectionManager
.selectionText
;
1451 * Clears the current terminal selection.
1453 Terminal
.prototype.clearSelection = function() {
1454 this.selectionManager
.clearSelection();
1458 * Selects all text within the terminal.
1460 Terminal
.prototype.selectAll = function() {
1461 this.selectionManager
.selectAll();
1465 * Handle a keydown event
1467 * - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent
1468 * @param {KeyboardEvent} ev The keydown event to be handled.
1470 Terminal
.prototype.keyDown = function(ev
) {
1471 if (this.customKeyEventHandler
&& this.customKeyEventHandler(ev
) === false) {
1475 this.restartCursorBlinking();
1477 if (!this.compositionHelper
.keydown
.bind(this.compositionHelper
)(ev
)) {
1478 if (this.ybase
!== this.ydisp
) {
1479 this.scrollToBottom();
1485 var result
= this.evaluateKeyEscapeSequence(ev
);
1487 if (result
.key
=== C0
.DC3
) { // XOFF
1488 this.writeStopped
= true;
1489 } else if (result
.key
=== C0
.DC1
) { // XON
1490 this.writeStopped
= false;
1493 if (result
.scrollDisp
) {
1494 this.scrollDisp(result
.scrollDisp
);
1495 return this.cancel(ev
, true);
1498 if (isThirdLevelShift(this, ev
)) {
1502 if (result
.cancel
) {
1503 // The event is canceled at the end already, is this necessary?
1504 this.cancel(ev
, true);
1511 this.emit('keydown', ev
);
1512 this.emit('key', result
.key
, ev
);
1514 this.handler(result
.key
);
1516 return this.cancel(ev
, true);
1520 * Returns an object that determines how a KeyboardEvent should be handled. The key of the
1521 * returned value is the new key code to pass to the PTY.
1523 * Reference: http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
1524 * @param {KeyboardEvent} ev The keyboard event to be translated to key escape sequence.
1526 Terminal
.prototype.evaluateKeyEscapeSequence = function(ev
) {
1528 // Whether to cancel event propogation (NOTE: this may not be needed since the event is
1529 // canceled at the end of keyDown
1531 // The new key even to emit
1533 // The number of characters to scroll, if this is defined it will cancel the event
1534 scrollDisp
: undefined
1536 var modifiers
= ev
.shiftKey
<< 0 | ev
.altKey
<< 1 | ev
.ctrlKey
<< 2 | ev
.metaKey
<< 3;
1537 switch (ev
.keyCode
) {
1541 result
.key
= C0
.BS
; // ^H
1544 result
.key
= C0
.DEL
; // ^?
1549 result
.key
= C0
.ESC
+ '[Z';
1553 result
.cancel
= true;
1558 result
.cancel
= true;
1562 result
.key
= C0
.ESC
;
1563 result
.cancel
= true;
1568 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'D';
1569 // HACK: Make Alt + left-arrow behave like Ctrl + left-arrow: move one word backwards
1570 // http://unix.stackexchange.com/a/108106
1571 // macOS uses different escape sequences than linux
1572 if (result
.key
== C0
.ESC
+ '[1;3D') {
1573 result
.key
= (this.browser
.isMac
) ? C0
.ESC
+ 'b' : C0
.ESC
+ '[1;5D';
1575 } else if (this.applicationCursor
) {
1576 result
.key
= C0
.ESC
+ 'OD';
1578 result
.key
= C0
.ESC
+ '[D';
1584 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'C';
1585 // HACK: Make Alt + right-arrow behave like Ctrl + right-arrow: move one word forward
1586 // http://unix.stackexchange.com/a/108106
1587 // macOS uses different escape sequences than linux
1588 if (result
.key
== C0
.ESC
+ '[1;3C') {
1589 result
.key
= (this.browser
.isMac
) ? C0
.ESC
+ 'f' : C0
.ESC
+ '[1;5C';
1591 } else if (this.applicationCursor
) {
1592 result
.key
= C0
.ESC
+ 'OC';
1594 result
.key
= C0
.ESC
+ '[C';
1600 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'A';
1601 // HACK: Make Alt + up-arrow behave like Ctrl + up-arrow
1602 // http://unix.stackexchange.com/a/108106
1603 if (result
.key
== C0
.ESC
+ '[1;3A') {
1604 result
.key
= C0
.ESC
+ '[1;5A';
1606 } else if (this.applicationCursor
) {
1607 result
.key
= C0
.ESC
+ 'OA';
1609 result
.key
= C0
.ESC
+ '[A';
1615 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'B';
1616 // HACK: Make Alt + down-arrow behave like Ctrl + down-arrow
1617 // http://unix.stackexchange.com/a/108106
1618 if (result
.key
== C0
.ESC
+ '[1;3B') {
1619 result
.key
= C0
.ESC
+ '[1;5B';
1621 } else if (this.applicationCursor
) {
1622 result
.key
= C0
.ESC
+ 'OB';
1624 result
.key
= C0
.ESC
+ '[B';
1629 if (!ev
.shiftKey
&& !ev
.ctrlKey
) {
1630 // <Ctrl> or <Shift> + <Insert> are used to
1631 // copy-paste on some systems.
1632 result
.key
= C0
.ESC
+ '[2~';
1638 result
.key
= C0
.ESC
+ '[3;' + (modifiers
+ 1) + '~';
1640 result
.key
= C0
.ESC
+ '[3~';
1646 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'H';
1647 else if (this.applicationCursor
)
1648 result
.key
= C0
.ESC
+ 'OH';
1650 result
.key
= C0
.ESC
+ '[H';
1655 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'F';
1656 else if (this.applicationCursor
)
1657 result
.key
= C0
.ESC
+ 'OF';
1659 result
.key
= C0
.ESC
+ '[F';
1664 result
.scrollDisp
= -(this.rows
- 1);
1666 result
.key
= C0
.ESC
+ '[5~';
1672 result
.scrollDisp
= this.rows
- 1;
1674 result
.key
= C0
.ESC
+ '[6~';
1680 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'P';
1682 result
.key
= C0
.ESC
+ 'OP';
1687 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'Q';
1689 result
.key
= C0
.ESC
+ 'OQ';
1694 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'R';
1696 result
.key
= C0
.ESC
+ 'OR';
1701 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'S';
1703 result
.key
= C0
.ESC
+ 'OS';
1708 result
.key
= C0
.ESC
+ '[15;' + (modifiers
+ 1) + '~';
1710 result
.key
= C0
.ESC
+ '[15~';
1715 result
.key
= C0
.ESC
+ '[17;' + (modifiers
+ 1) + '~';
1717 result
.key
= C0
.ESC
+ '[17~';
1722 result
.key
= C0
.ESC
+ '[18;' + (modifiers
+ 1) + '~';
1724 result
.key
= C0
.ESC
+ '[18~';
1729 result
.key
= C0
.ESC
+ '[19;' + (modifiers
+ 1) + '~';
1731 result
.key
= C0
.ESC
+ '[19~';
1736 result
.key
= C0
.ESC
+ '[20;' + (modifiers
+ 1) + '~';
1738 result
.key
= C0
.ESC
+ '[20~';
1743 result
.key
= C0
.ESC
+ '[21;' + (modifiers
+ 1) + '~';
1745 result
.key
= C0
.ESC
+ '[21~';
1750 result
.key
= C0
.ESC
+ '[23;' + (modifiers
+ 1) + '~';
1752 result
.key
= C0
.ESC
+ '[23~';
1757 result
.key
= C0
.ESC
+ '[24;' + (modifiers
+ 1) + '~';
1759 result
.key
= C0
.ESC
+ '[24~';
1764 if (ev
.ctrlKey
&& !ev
.shiftKey
&& !ev
.altKey
&& !ev
.metaKey
) {
1765 if (ev
.keyCode
>= 65 && ev
.keyCode
<= 90) {
1766 result
.key
= String
.fromCharCode(ev
.keyCode
- 64);
1767 } else if (ev
.keyCode
=== 32) {
1769 result
.key
= String
.fromCharCode(0);
1770 } else if (ev
.keyCode
>= 51 && ev
.keyCode
<= 55) {
1771 // escape, file sep, group sep, record sep, unit sep
1772 result
.key
= String
.fromCharCode(ev
.keyCode
- 51 + 27);
1773 } else if (ev
.keyCode
=== 56) {
1775 result
.key
= String
.fromCharCode(127);
1776 } else if (ev
.keyCode
=== 219) {
1777 // ^[ - Control Sequence Introducer (CSI)
1778 result
.key
= String
.fromCharCode(27);
1779 } else if (ev
.keyCode
=== 220) {
1780 // ^\ - String Terminator (ST)
1781 result
.key
= String
.fromCharCode(28);
1782 } else if (ev
.keyCode
=== 221) {
1783 // ^] - Operating System Command (OSC)
1784 result
.key
= String
.fromCharCode(29);
1786 } else if (!this.browser
.isMac
&& ev
.altKey
&& !ev
.ctrlKey
&& !ev
.metaKey
) {
1787 // On Mac this is a third level shift. Use <Esc> instead.
1788 if (ev
.keyCode
>= 65 && ev
.keyCode
<= 90) {
1789 result
.key
= C0
.ESC
+ String
.fromCharCode(ev
.keyCode
+ 32);
1790 } else if (ev
.keyCode
=== 192) {
1791 result
.key
= C0
.ESC
+ '`';
1792 } else if (ev
.keyCode
>= 48 && ev
.keyCode
<= 57) {
1793 result
.key
= C0
.ESC
+ (ev
.keyCode
- 48);
1795 } else if (this.browser
.isMac
&& !ev
.altKey
&& !ev
.ctrlKey
&& ev
.metaKey
) {
1796 if (ev
.keyCode
=== 65) { // cmd + a
1807 * Set the G level of the terminal
1810 Terminal
.prototype.setgLevel = function(g
) {
1812 this.charset
= this.charsets
[g
];
1816 * Set the charset for the given G level of the terminal
1820 Terminal
.prototype.setgCharset = function(g
, charset
) {
1821 this.charsets
[g
] = charset
;
1822 if (this.glevel
=== g
) {
1823 this.charset
= charset
;
1828 * Handle a keypress event.
1830 * - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent
1831 * @param {KeyboardEvent} ev The keypress event to be handled.
1833 Terminal
.prototype.keyPress = function(ev
) {
1836 if (this.customKeyEventHandler
&& this.customKeyEventHandler(ev
) === false) {
1844 } else if (ev
.which
== null) {
1846 } else if (ev
.which
!== 0 && ev
.charCode
!== 0) {
1853 (ev
.altKey
|| ev
.ctrlKey
|| ev
.metaKey
) && !isThirdLevelShift(this, ev
)
1858 key
= String
.fromCharCode(key
);
1860 this.emit('keypress', key
, ev
);
1861 this.emit('key', key
, ev
);
1869 * Send data for handling to the terminal
1870 * @param {string} data
1872 Terminal
.prototype.send = function(data
) {
1876 setTimeout(function() {
1877 self
.handler(self
.queue
);
1887 * Note: We could do sweet things with webaudio here
1889 Terminal
.prototype.bell = function() {
1890 if (!this.visualBell
) return;
1892 this.element
.style
.borderColor
= 'white';
1893 setTimeout(function() {
1894 self
.element
.style
.borderColor
= '';
1896 if (this.popOnBell
) this.focus();
1900 * Log the current state to the console.
1902 Terminal
.prototype.log = function() {
1903 if (!this.debug
) return;
1904 if (!this.context
.console
|| !this.context
.console
.log
) return;
1905 var args
= Array
.prototype.slice
.call(arguments
);
1906 this.context
.console
.log
.apply(this.context
.console
, args
);
1910 * Log the current state as error to the console.
1912 Terminal
.prototype.error = function() {
1913 if (!this.debug
) return;
1914 if (!this.context
.console
|| !this.context
.console
.error
) return;
1915 var args
= Array
.prototype.slice
.call(arguments
);
1916 this.context
.console
.error
.apply(this.context
.console
, args
);
1920 * Resizes the terminal.
1922 * @param {number} x The number of columns to resize to.
1923 * @param {number} y The number of rows to resize to.
1925 Terminal
.prototype.resize = function(x
, y
) {
1926 if (isNaN(x
) || isNaN(y
)) {
1930 if (y
> this.getOption('scrollback')) {
1931 this.setOption('scrollback', y
)
1941 if (x
=== this.cols
&& y
=== this.rows
) {
1942 // Check if we still need to measure the char size (fixes #785).
1943 if (!this.charMeasure
.width
|| !this.charMeasure
.height
) {
1944 this.charMeasure
.measure();
1955 ch
= [this.defAttr
, ' ', 1]; // does xterm use the default attr?
1956 i
= this.lines
.length
;
1958 while (this.lines
.get(i
).length
< x
) {
1959 this.lines
.get(i
).push(ch
);
1965 this.setupStops(this.cols
);
1973 // y is rows, not this.y
1974 if (this.lines
.length
< y
+ this.ybase
) {
1975 if (this.ybase
> 0 && this.lines
.length
<= this.ybase
+ this.y
+ addToY
+ 1) {
1976 // There is room above the buffer and there are no empty elements below the line,
1980 if (this.ydisp
> 0) {
1981 // Viewport is at the top of the buffer, must increase downwards
1985 // Add a blank line if there is no buffer left at the top to scroll to, or if there
1986 // are blank lines after the cursor
1987 this.lines
.push(this.blankLine());
1990 if (this.children
.length
< y
) {
1996 if (this.lines
.length
> y
+ this.ybase
) {
1997 if (this.lines
.length
> this.ybase
+ this.y
+ 1) {
1998 // The line is a blank line below the cursor, remove it
2001 // The line is the cursor, scroll down
2006 if (this.children
.length
> y
) {
2007 el
= this.children
.shift();
2009 el
.parentNode
.removeChild(el
);
2015 // Make sure that the cursor stays on screen
2028 this.scrollBottom
= y
- 1;
2030 this.charMeasure
.measure();
2032 this.refresh(0, this.rows
- 1);
2036 this.geometry
= [this.cols
, this.rows
];
2037 this.emit('resize', {terminal
: this, cols
: x
, rows
: y
});
2041 * Updates the range of rows to refresh
2042 * @param {number} y The number of rows to refresh next.
2044 Terminal
.prototype.updateRange = function(y
) {
2045 if (y
< this.refreshStart
) this.refreshStart
= y
;
2046 if (y
> this.refreshEnd
) this.refreshEnd
= y
;
2047 // if (y > this.refreshEnd) {
2048 // this.refreshEnd = y;
2049 // if (y > this.rows - 1) {
2050 // this.refreshEnd = this.rows - 1;
2056 * Set the range of refreshing to the maximum value
2058 Terminal
.prototype.maxRange = function() {
2059 this.refreshStart
= 0;
2060 this.refreshEnd
= this.rows
- 1;
2066 * Setup the tab stops.
2069 Terminal
.prototype.setupStops = function(i
) {
2071 if (!this.tabs
[i
]) {
2072 i
= this.prevStop(i
);
2079 for (; i
< this.cols
; i
+= this.getOption('tabStopWidth')) {
2080 this.tabs
[i
] = true;
2086 * Move the cursor to the previous tab stop from the given position (default is current).
2087 * @param {number} x The position to move the cursor to the previous tab stop.
2089 Terminal
.prototype.prevStop = function(x
) {
2090 if (x
== null) x
= this.x
;
2091 while (!this.tabs
[--x
] && x
> 0);
2092 return x
>= this.cols
2099 * Move the cursor one tab stop forward from the given position (default is current).
2100 * @param {number} x The position to move the cursor one tab stop forward.
2102 Terminal
.prototype.nextStop = function(x
) {
2103 if (x
== null) x
= this.x
;
2104 while (!this.tabs
[++x
] && x
< this.cols
);
2105 return x
>= this.cols
2112 * Erase in the identified line everything from "x" to the end of the line (right).
2113 * @param {number} x The column from which to start erasing to the end of the line.
2114 * @param {number} y The line in which to operate.
2116 Terminal
.prototype.eraseRight = function(x
, y
) {
2117 var line
= this.lines
.get(this.ybase
+ y
);
2121 var ch
= [this.eraseAttr(), ' ', 1]; // xterm
2122 for (; x
< this.cols
; x
++) {
2125 this.updateRange(y
);
2131 * Erase in the identified line everything from "x" to the start of the line (left).
2132 * @param {number} x The column from which to start erasing to the start of the line.
2133 * @param {number} y The line in which to operate.
2135 Terminal
.prototype.eraseLeft = function(x
, y
) {
2136 var line
= this.lines
.get(this.ybase
+ y
);
2140 var ch
= [this.eraseAttr(), ' ', 1]; // xterm
2145 this.updateRange(y
);
2149 * Clears the entire buffer, making the prompt line the new first line.
2151 Terminal
.prototype.clear = function() {
2152 if (this.ybase
=== 0 && this.y
=== 0) {
2153 // Don't clear if it's already clear
2156 this.lines
.set(0, this.lines
.get(this.ybase
+ this.y
));
2157 this.lines
.length
= 1;
2161 for (var i
= 1; i
< this.rows
; i
++) {
2162 this.lines
.push(this.blankLine());
2164 this.refresh(0, this.rows
- 1);
2165 this.emit('scroll', this.ydisp
);
2169 * Erase all content in the given line
2170 * @param {number} y The line to erase all of its contents.
2172 Terminal
.prototype.eraseLine = function(y
) {
2173 this.eraseRight(0, y
);
2178 * Return the data array of a blank line
2179 * @param {number} cur First bunch of data for each "blank" character.
2180 * @param {boolean} isWrapped Whether the new line is wrapped from the previous line.
2182 Terminal
.prototype.blankLine = function(cur
, isWrapped
) {
2187 var ch
= [attr
, ' ', 1] // width defaults to 1 halfwidth character
2191 // TODO: It is not ideal that this is a property on an array, a buffer line
2192 // class should be added that will hold this data and other useful functions.
2194 line
.isWrapped
= isWrapped
;
2197 for (; i
< this.cols
; i
++) {
2206 * If cur return the back color xterm feature attribute. Else return defAttr.
2207 * @param {object} cur
2209 Terminal
.prototype.ch = function(cur
) {
2211 ? [this.eraseAttr(), ' ', 1]
2212 : [this.defAttr
, ' ', 1];
2217 * Evaluate if the current erminal is the given argument.
2218 * @param {object} term The terminal to evaluate
2220 Terminal
.prototype.is = function(term
) {
2221 var name
= this.termName
;
2222 return (name
+ '').indexOf(term
) === 0;
2227 * Emit the 'data' event and populate the given data.
2228 * @param {string} data The data to populate in the event.
2230 Terminal
.prototype.handler = function(data
) {
2231 // Prevents all events to pty process if stdin is disabled
2232 if (this.options
.disableStdin
) {
2236 // Input is being sent to the terminal, the terminal should focus the prompt.
2237 if (this.ybase
!== this.ydisp
) {
2238 this.scrollToBottom();
2240 this.emit('data', data
);
2245 * Emit the 'title' event and populate the given title.
2246 * @param {string} title The title to populate in the event.
2248 Terminal
.prototype.handleTitle = function(title
) {
2250 * This event is emitted when the title of the terminal is changed
2251 * from inside the terminal. The parameter is the new title.
2255 this.emit('title', title
);
2264 * ESC D Index (IND is 0x84).
2266 Terminal
.prototype.index = function() {
2268 if (this.y
> this.scrollBottom
) {
2272 // If the end of the line is hit, prevent this action from wrapping around to the next line.
2273 if (this.x
>= this.cols
) {
2280 * ESC M Reverse Index (RI is 0x8d).
2282 * Move the cursor up one row, inserting a new blank line if necessary.
2284 Terminal
.prototype.reverseIndex = function() {
2286 if (this.y
=== this.scrollTop
) {
2287 // possibly move the code below to term.reverseScroll();
2288 // test: echo -ne '\e[1;1H\e[44m\eM\e[0m'
2289 // blankLine(true) is xterm/linux behavior
2290 this.lines
.shiftElements(this.y
+ this.ybase
, this.rows
- 1, 1);
2291 this.lines
.set(this.y
+ this.ybase
, this.blankLine(true));
2292 this.updateRange(this.scrollTop
);
2293 this.updateRange(this.scrollBottom
);
2301 * ESC c Full Reset (RIS).
2303 Terminal
.prototype.reset = function() {
2304 this.options
.rows
= this.rows
;
2305 this.options
.cols
= this.cols
;
2306 var customKeyEventHandler
= this.customKeyEventHandler
;
2307 var cursorBlinkInterval
= this.cursorBlinkInterval
;
2308 Terminal
.call(this, this.options
);
2309 this.customKeyEventHandler
= customKeyEventHandler
;
2310 this.cursorBlinkInterval
= cursorBlinkInterval
;
2311 this.refresh(0, this.rows
- 1);
2312 this.viewport
.syncScrollArea();
2317 * ESC H Tab Set (HTS is 0x88).
2319 Terminal
.prototype.tabSet = function() {
2320 this.tabs
[this.x
] = true;
2327 function on(el
, type
, handler
, capture
) {
2328 if (!Array
.isArray(el
)) {
2331 el
.forEach(function (element
) {
2332 element
.addEventListener(type
, handler
, capture
|| false);
2336 function off(el
, type
, handler
, capture
) {
2337 el
.removeEventListener(type
, handler
, capture
|| false);
2340 function cancel(ev
, force
) {
2341 if (!this.cancelEvents
&& !force
) {
2344 ev
.preventDefault();
2345 ev
.stopPropagation();
2349 function inherits(child
, parent
) {
2351 this.constructor = child
;
2353 f
.prototype = parent
.prototype;
2354 child
.prototype = new f
;
2357 function indexOf(obj
, el
) {
2360 if (obj
[i
] === el
) return i
;
2365 function isThirdLevelShift(term
, ev
) {
2367 (term
.browser
.isMac
&& ev
.altKey
&& !ev
.ctrlKey
&& !ev
.metaKey
) ||
2368 (term
.browser
.isMSWindows
&& ev
.altKey
&& ev
.ctrlKey
&& !ev
.metaKey
);
2370 if (ev
.type
== 'keypress') {
2371 return thirdLevelKey
;
2374 // Don't invoke for arrows, pageDown, home, backspace, etc. (on non-keypress events)
2375 return thirdLevelKey
&& (!ev
.keyCode
|| ev
.keyCode
> 47);
2378 // Expose to InputHandler (temporary)
2379 Terminal
.prototype.matchColor
= matchColor
;
2381 function matchColor(r1
, g1
, b1
) {
2382 var hash
= (r1
<< 16) | (g1
<< 8) | b1
;
2384 if (matchColor
._cache
[hash
] != null) {
2385 return matchColor
._cache
[hash
];
2388 var ldiff
= Infinity
2397 for (; i
< Terminal
.vcolors
.length
; i
++) {
2398 c
= Terminal
.vcolors
[i
];
2403 diff
= matchColor
.distance(r1
, g1
, b1
, r2
, g2
, b2
);
2416 return matchColor
._cache
[hash
] = li
;
2419 matchColor
._cache
= {};
2421 // http://stackoverflow.com/questions/1633828
2422 matchColor
.distance = function(r1
, g1
, b1
, r2
, g2
, b2
) {
2423 return Math
.pow(30 * (r1
- r2
), 2)
2424 + Math
.pow(59 * (g1
- g2
), 2)
2425 + Math
.pow(11 * (b1
- b2
), 2);
2428 function each(obj
, iter
, con
) {
2429 if (obj
.forEach
) return obj
.forEach(iter
, con
);
2430 for (var i
= 0; i
< obj
.length
; i
++) {
2431 iter
.call(con
, obj
[i
], i
, obj
);
2435 function wasMondifierKeyOnlyEvent(ev
) {
2436 return ev
.keyCode
=== 16 || // Shift
2437 ev
.keyCode
=== 17 || // Ctrl
2438 ev
.keyCode
=== 18; // Alt
2441 function keys(obj
) {
2442 if (Object
.keys
) return Object
.keys(obj
);
2445 if (Object
.prototype.hasOwnProperty
.call(obj
, key
)) {
2456 Terminal
.EventEmitter
= EventEmitter
;
2457 Terminal
.inherits
= inherits
;
2460 * Adds an event listener to the terminal.
2462 * @param {string} event The name of the event. TODO: Document all event types
2463 * @param {function} callback The function to call when the event is triggered.
2467 Terminal
.cancel
= cancel
;
2469 module
.exports
= Terminal
;