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 { BufferSet
} from './BufferSet';
14 import { CompositionHelper
} from './CompositionHelper';
15 import { EventEmitter
} from './EventEmitter';
16 import { Viewport
} from './Viewport';
17 import { rightClickHandler
, moveTextAreaUnderMouseCursor
, pasteHandler
, copyHandler
} from './handlers/Clipboard';
18 import { CircularList
} from './utils/CircularList';
19 import { C0
} from './EscapeSequences';
20 import { InputHandler
} from './InputHandler';
21 import { Parser
} from './Parser';
22 import { Renderer
} from './Renderer';
23 import { Linkifier
} from './Linkifier';
24 import { SelectionManager
} from './SelectionManager';
25 import { CharMeasure
} from './utils/CharMeasure';
26 import * as Browser
from './utils/Browser';
27 import * as Mouse
from './utils/Mouse';
28 import { CHARSETS
} from './Charsets';
29 import { getRawByteCoords
} from './utils/Mouse';
30 import { translateBufferLineToString
} from './utils/BufferLine';
33 * Terminal Emulation References:
35 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.txt
36 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
37 * http://invisible-island.net/vttest/
38 * http://www.inwap.com/pdp10/ansicode.txt
39 * http://linux.die.net/man/4/console_codes
40 * http://linux.die.net/man/7/urxvt
43 // Let it work inside Node.js for automated testing purposes.
44 var document
= (typeof window
!= 'undefined') ? window
.document
: null;
47 * The amount of write requests to queue before sending an XOFF signal to the
48 * pty process. This number must be small in order for ^C and similar sequences
51 var WRITE_BUFFER_PAUSE_THRESHOLD
= 5;
54 * The number of writes to perform in a single batch before allowing the
55 * renderer to catch up with a 0ms setTimeout.
57 var WRITE_BATCH_SIZE
= 300;
60 * The time between cursor blinks. This is driven by JS rather than a CSS
61 * animation due to a bug in Chromium that causes it to use excessive CPU time.
62 * See https://github.com/Microsoft/vscode/issues/22900
64 var CURSOR_BLINK_INTERVAL
= 600;
71 * Creates a new `Terminal` object.
73 * @param {object} options An object containing a set of options, the available options are:
74 * - `cursorBlink` (boolean): Whether the terminal cursor blinks
75 * - `cols` (number): The number of columns of the terminal (horizontal size)
76 * - `rows` (number): The number of rows of the terminal (vertical size)
80 * @alias module:xterm/src/xterm
82 function Terminal(options
) {
85 if (!(this instanceof Terminal
)) {
86 return new Terminal(arguments
[0], arguments
[1], arguments
[2]);
89 self
.browser
= Browser
;
90 self
.cancel
= Terminal
.cancel
;
92 EventEmitter
.call(this);
94 if (typeof options
=== 'number') {
102 options
= options
|| {};
105 Object
.keys(Terminal
.defaults
).forEach(function(key
) {
106 if (options
[key
] == null) {
107 options
[key
] = Terminal
.options
[key
];
109 if (Terminal
[key
] !== Terminal
.defaults
[key
]) {
110 options
[key
] = Terminal
[key
];
113 self
[key
] = options
[key
];
116 if (options
.colors
.length
=== 8) {
117 options
.colors
= options
.colors
.concat(Terminal
._colors
.slice(8));
118 } else if (options
.colors
.length
=== 16) {
119 options
.colors
= options
.colors
.concat(Terminal
._colors
.slice(16));
120 } else if (options
.colors
.length
=== 10) {
121 options
.colors
= options
.colors
.slice(0, -2).concat(
122 Terminal
._colors
.slice(8, -2), options
.colors
.slice(-2));
123 } else if (options
.colors
.length
=== 18) {
124 options
.colors
= options
.colors
.concat(
125 Terminal
._colors
.slice(16, -2), options
.colors
.slice(-2));
127 this.colors
= options
.colors
;
129 this.options
= options
;
131 // this.context = options.context || window;
132 // this.document = options.document || document;
133 this.parent
= options
.body
|| options
.parent
|| (
134 document
? document
.getElementsByTagName('body')[0] : null
137 this.cols
= options
.cols
|| options
.geometry
[0];
138 this.rows
= options
.rows
|| options
.geometry
[1];
139 this.geometry
= [this.cols
, this.rows
];
141 if (options
.handler
) {
142 this.on('data', options
.handler
);
145 this.cursorState
= 0;
146 this.cursorHidden
= false;
149 this.customKeyEventHandler
= null;
150 this.cursorBlinkInterval
= null;
153 this.applicationKeypad
= false;
154 this.applicationCursor
= false;
155 this.originMode
= false;
156 this.insertMode
= false;
157 this.wraparoundMode
= true; // defaults: xterm - true, vt100 - false
161 this.gcharset
= null;
163 this.charsets
= [null];
187 this.readable
= true;
188 this.writable
= true;
190 this.defAttr
= (0 << 18) | (257 << 9) | (256 << 0);
191 this.curAttr
= this.defAttr
;
194 this.currentParam
= 0;
198 this.inputHandler
= new InputHandler(this);
199 this.parser
= new Parser(this.inputHandler
, this);
200 // Reuse renderer if the Terminal is being recreated via a Terminal.reset call.
201 this.renderer
= this.renderer
|| null;
202 this.selectionManager
= this.selectionManager
|| null;
203 this.linkifier
= this.linkifier
|| new Linkifier();
206 this.writeBuffer
= [];
207 this.writeInProgress
= false;
210 * Whether _xterm.js_ sent XOFF in order to catch up with the pty process.
211 * This is a distinct state from writeStopped so that if the user requested
212 * XOFF via ^S that it will not automatically resume when the writeBuffer goes
215 this.xoffSentToCatchUp
= false;
217 /** Whether writing has been stopped as a result of XOFF */
218 this.writeStopped
= false;
220 // leftover surrogate high from previous write invocation
221 this.surrogate_high
= '';
223 // Create the terminal's buffers and set the current buffer
224 this.buffers
= new BufferSet(this);
225 this.buffer
= this.buffers
.active
; // Convenience shortcut;
226 this.buffers
.on('activate', function (buffer
) {
227 this._terminal
.buffer
= buffer
;
233 this.buffer
.lines
.push(this.blankLine());
235 // Ensure the selection manager has the correct buffer
236 if (this.selectionManager
) {
237 this.selectionManager
.setBuffer(this.buffer
.lines
);
242 // Store if user went browsing history in scrollback
243 this.userScrolling
= false;
246 inherits(Terminal
, EventEmitter
);
249 * back_color_erase feature for xterm.
251 Terminal
.prototype.eraseAttr = function() {
252 // if (this.is('screen')) return this.defAttr;
253 return (this.defAttr
& ~0x1ff) | (this.curAttr
& 0x1ff);
261 Terminal
.tangoColors
= [
282 // Colors 0-15 + 16-255
283 // Much thanks to TooTallNate for writing this.
284 Terminal
.colors
= (function() {
285 var colors
= Terminal
.tangoColors
.slice()
286 , r
= [0x00, 0x5f, 0x87, 0xaf, 0xd7, 0xff]
291 for (; i
< 216; i
++) {
292 out(r
[(i
/ 36) % 6 | 0], r
[(i
/ 6) % 6 | 0], r
[i
% 6]);
297 for (; i
< 24; i
++) {
302 function out(r
, g
, b
) {
303 colors
.push('#' + hex(r
) + hex(g
) + hex(b
));
308 return c
.length
< 2 ? '0' + c
: c
;
314 Terminal
._colors
= Terminal
.colors
.slice();
316 Terminal
.vcolors
= (function() {
318 , colors
= Terminal
.colors
322 for (; i
< 256; i
++) {
323 color
= parseInt(colors
[i
].substring(1), 16);
325 (color
>> 16) & 0xff,
338 Terminal
.defaults
= {
339 colors
: Terminal
.colors
,
345 cursorStyle
: 'block',
353 useFlowControl
: false,
355 // programFeatures: false,
359 Terminal
.options
= {};
361 Terminal
.focus
= null;
363 each(keys(Terminal
.defaults
), function(key
) {
364 Terminal
[key
] = Terminal
.defaults
[key
];
365 Terminal
.options
[key
] = Terminal
.defaults
[key
];
369 * Focus the terminal. Delegates focus handling to the terminal's DOM element.
371 Terminal
.prototype.focus = function() {
372 return this.textarea
.focus();
376 * Retrieves an option's value from the terminal.
377 * @param {string} key The option key.
379 Terminal
.prototype.getOption = function(key
) {
380 if (!(key
in Terminal
.defaults
)) {
381 throw new Error('No option with key "' + key
+ '"');
384 if (typeof this.options
[key
] !== 'undefined') {
385 return this.options
[key
];
392 * Sets an option on the terminal.
393 * @param {string} key The option key.
394 * @param {string} value The option value.
396 Terminal
.prototype.setOption = function(key
, value
) {
397 if (!(key
in Terminal
.defaults
)) {
398 throw new Error('No option with key "' + key
+ '"');
402 if (value
< this.rows
) {
403 let msg
= 'Setting the scrollback value less than the number of rows ';
405 msg
+= `(${this.rows}) is not allowed.`;
411 if (this.options
[key
] !== value
) {
412 if (this.buffer
.lines
.length
> value
) {
413 const amountToTrim
= this.buffer
.lines
.length
- value
;
414 const needsRefresh
= (this.buffer
.ydisp
- amountToTrim
< 0);
415 this.buffer
.lines
.trimStart(amountToTrim
);
416 this.buffer
.ybase
= Math
.max(this.buffer
.ybase
- amountToTrim
, 0);
417 this.buffer
.ydisp
= Math
.max(this.buffer
.ydisp
- amountToTrim
, 0);
419 this.refresh(0, this.rows
- 1);
422 this.buffer
.lines
.maxLength
= value
;
423 this.viewport
.syncScrollArea();
428 this.options
[key
] = value
;
430 case 'cursorBlink': this.setCursorBlinking(value
); break;
432 // Style 'block' applies with no class
433 this.element
.classList
.toggle(`xterm-cursor-style-underline`, value
=== 'underline');
434 this.element
.classList
.toggle(`xterm-cursor-style-bar`, value
=== 'bar');
436 case 'tabStopWidth': this.setupStops(); break;
440 Terminal
.prototype.restartCursorBlinking = function () {
441 this.setCursorBlinking(this.options
.cursorBlink
);
444 Terminal
.prototype.setCursorBlinking = function (enabled
) {
445 this.element
.classList
.toggle('xterm-cursor-blink', enabled
);
446 this.clearCursorBlinkingInterval();
449 this.cursorBlinkInterval
= setInterval(function () {
450 self
.element
.classList
.toggle('xterm-cursor-blink-on');
451 }, CURSOR_BLINK_INTERVAL
);
455 Terminal
.prototype.clearCursorBlinkingInterval = function () {
456 this.element
.classList
.remove('xterm-cursor-blink-on');
457 if (this.cursorBlinkInterval
) {
458 clearInterval(this.cursorBlinkInterval
);
459 this.cursorBlinkInterval
= null;
464 * Binds the desired focus behavior on a given terminal object.
468 Terminal
.bindFocus = function (term
) {
469 on(term
.textarea
, 'focus', function (ev
) {
470 if (term
.sendFocus
) {
471 term
.send(C0
.ESC
+ '[I');
473 term
.element
.classList
.add('focus');
475 term
.restartCursorBlinking
.apply(term
);
476 Terminal
.focus
= term
;
477 term
.emit('focus', {terminal
: term
});
482 * Blur the terminal. Delegates blur handling to the terminal's DOM element.
484 Terminal
.prototype.blur = function() {
485 return this.textarea
.blur();
489 * Binds the desired blur behavior on a given terminal object.
493 Terminal
.bindBlur = function (term
) {
494 on(term
.textarea
, 'blur', function (ev
) {
495 term
.refresh(term
.buffer
.y
, term
.buffer
.y
);
496 if (term
.sendFocus
) {
497 term
.send(C0
.ESC
+ '[O');
499 term
.element
.classList
.remove('focus');
500 term
.clearCursorBlinkingInterval
.apply(term
);
501 Terminal
.focus
= null;
502 term
.emit('blur', {terminal
: term
});
507 * Initialize default behavior
509 Terminal
.prototype.initGlobal = function() {
512 Terminal
.bindKeys(this);
513 Terminal
.bindFocus(this);
514 Terminal
.bindBlur(this);
516 // Bind clipboard functionality
517 on(this.element
, 'copy', event
=> {
518 // If mouse events are active it means the selection manager is disabled and
519 // copy should be handled by the host program.
520 if (!term
.hasSelection()) {
523 copyHandler(event
, term
, this.selectionManager
);
525 const pasteHandlerWrapper
= event
=> pasteHandler(event
, term
);
526 on(this.textarea
, 'paste', pasteHandlerWrapper
);
527 on(this.element
, 'paste', pasteHandlerWrapper
);
529 // Handle right click context menus
530 if (term
.browser
.isFirefox
) {
531 // Firefox doesn't appear to fire the contextmenu event on right click
532 on(this.element
, 'mousedown', event
=> {
533 if (event
.button
== 2) {
534 rightClickHandler(event
, this.textarea
, this.selectionManager
);
538 on(this.element
, 'contextmenu', event
=> {
539 rightClickHandler(event
, this.textarea
, this.selectionManager
);
543 // Move the textarea under the cursor when middle clicking on Linux to ensure
544 // middle click to paste selection works. This only appears to work in Chrome
545 // at the time is writing.
546 if (term
.browser
.isLinux
) {
547 // Use auxclick event over mousedown the latter doesn't seem to work. Note
548 // that the regular click event doesn't fire for the middle mouse button.
549 on(this.element
, 'auxclick', event
=> {
550 if (event
.button
=== 1) {
551 moveTextAreaUnderMouseCursor(event
, this.textarea
, this.selectionManager
);
558 * Apply key handling to the terminal
560 Terminal
.bindKeys = function(term
) {
561 on(term
.element
, 'keydown', function(ev
) {
562 if (document
.activeElement
!= this) {
568 on(term
.element
, 'keypress', function(ev
) {
569 if (document
.activeElement
!= this) {
575 on(term
.element
, 'keyup', function(ev
) {
576 if (!wasMondifierKeyOnlyEvent(ev
)) {
581 on(term
.textarea
, 'keydown', function(ev
) {
585 on(term
.textarea
, 'keypress', function(ev
) {
587 // Truncate the textarea's value, since it is not needed
591 on(term
.textarea
, 'compositionstart', term
.compositionHelper
.compositionstart
.bind(term
.compositionHelper
));
592 on(term
.textarea
, 'compositionupdate', term
.compositionHelper
.compositionupdate
.bind(term
.compositionHelper
));
593 on(term
.textarea
, 'compositionend', term
.compositionHelper
.compositionend
.bind(term
.compositionHelper
));
594 term
.on('refresh', term
.compositionHelper
.updateCompositionElements
.bind(term
.compositionHelper
));
595 term
.on('refresh', function (data
) {
596 term
.queueLinkification(data
.start
, data
.end
)
602 * Insert the given row to the terminal or produce a new one
603 * if no row argument is passed. Return the inserted row.
604 * @param {HTMLElement} row (optional) The row to append to the terminal.
606 Terminal
.prototype.insertRow = function (row
) {
607 if (typeof row
!= 'object') {
608 row
= document
.createElement('div');
611 this.rowContainer
.appendChild(row
);
612 this.children
.push(row
);
618 * Opens the terminal within an element.
620 * @param {HTMLElement} parent The element to create the terminal within.
621 * @param {boolean} focus Focus the terminal, after it gets instantiated in the DOM
623 Terminal
.prototype.open = function(parent
, focus
) {
624 var self
=this, i
=0, div
;
626 this.parent
= parent
|| this.parent
;
629 throw new Error('Terminal requires a parent element.');
632 // Grab global elements
633 this.context
= this.parent
.ownerDocument
.defaultView
;
634 this.document
= this.parent
.ownerDocument
;
635 this.body
= this.document
.getElementsByTagName('body')[0];
637 //Create main element container
638 this.element
= this.document
.createElement('div');
639 this.element
.classList
.add('terminal');
640 this.element
.classList
.add('xterm');
641 this.element
.classList
.add('xterm-theme-' + this.theme
);
642 this.setCursorBlinking(this.options
.cursorBlink
);
644 this.element
.setAttribute('tabindex', 0);
646 this.viewportElement
= document
.createElement('div');
647 this.viewportElement
.classList
.add('xterm-viewport');
648 this.element
.appendChild(this.viewportElement
);
649 this.viewportScrollArea
= document
.createElement('div');
650 this.viewportScrollArea
.classList
.add('xterm-scroll-area');
651 this.viewportElement
.appendChild(this.viewportScrollArea
);
653 // Create the selection container.
654 this.selectionContainer
= document
.createElement('div');
655 this.selectionContainer
.classList
.add('xterm-selection');
656 this.element
.appendChild(this.selectionContainer
);
658 // Create the container that will hold the lines of the terminal and then
659 // produce the lines the lines.
660 this.rowContainer
= document
.createElement('div');
661 this.rowContainer
.classList
.add('xterm-rows');
662 this.element
.appendChild(this.rowContainer
);
664 this.linkifier
.attachToDom(document
, this.children
);
666 // Create the container that will hold helpers like the textarea for
667 // capturing DOM Events. Then produce the helpers.
668 this.helperContainer
= document
.createElement('div');
669 this.helperContainer
.classList
.add('xterm-helpers');
670 // TODO: This should probably be inserted once it's filled to prevent an additional layout
671 this.element
.appendChild(this.helperContainer
);
672 this.textarea
= document
.createElement('textarea');
673 this.textarea
.classList
.add('xterm-helper-textarea');
674 this.textarea
.setAttribute('autocorrect', 'off');
675 this.textarea
.setAttribute('autocapitalize', 'off');
676 this.textarea
.setAttribute('spellcheck', 'false');
677 this.textarea
.tabIndex
= 0;
678 this.textarea
.addEventListener('focus', function() {
679 self
.emit('focus', {terminal
: self
});
681 this.textarea
.addEventListener('blur', function() {
682 self
.emit('blur', {terminal
: self
});
684 this.helperContainer
.appendChild(this.textarea
);
686 this.compositionView
= document
.createElement('div');
687 this.compositionView
.classList
.add('composition-view');
688 this.compositionHelper
= new CompositionHelper(this.textarea
, this.compositionView
, this);
689 this.helperContainer
.appendChild(this.compositionView
);
691 this.charSizeStyleElement
= document
.createElement('style');
692 this.helperContainer
.appendChild(this.charSizeStyleElement
);
694 for (; i
< this.rows
; i
++) {
697 this.parent
.appendChild(this.element
);
699 this.charMeasure
= new CharMeasure(document
, this.helperContainer
);
700 this.charMeasure
.on('charsizechanged', function () {
701 self
.updateCharSizeStyles();
703 this.charMeasure
.measure();
705 this.viewport
= new Viewport(this, this.viewportElement
, this.viewportScrollArea
, this.charMeasure
);
706 this.renderer
= new Renderer(this);
707 this.selectionManager
= new SelectionManager(
708 this, this.buffer
.lines
, this.rowContainer
, this.charMeasure
710 this.selectionManager
.on('refresh', data
=> {
711 this.renderer
.refreshSelection(data
.start
, data
.end
);
713 this.selectionManager
.on('newselection', text
=> {
714 // If there's a new selection, put it into the textarea, focus and select it
715 // in order to register it as a selection on the OS. This event is fired
716 // only on Linux to enable middle click to paste selection.
717 this.textarea
.value
= text
;
718 this.textarea
.focus();
719 this.textarea
.select();
721 this.on('scroll', () => this.selectionManager
.refresh());
722 this.viewportElement
.addEventListener('scroll', () => this.selectionManager
.refresh());
724 // Setup loop that draws to screen
725 this.refresh(0, this.rows
- 1);
727 // Initialize global actions that
728 // need to be taken on the document.
732 * Automatic focus functionality.
733 * TODO: Default to `false` starting with xterm.js 3.0.
735 if (typeof focus
== 'undefined') {
736 let message
= 'You did not pass the `focus` argument in `Terminal.prototype.open()`.\n';
738 message
+= 'The `focus` argument now defaults to `true` but starting with xterm.js 3.0 ';
739 message
+= 'it will default to `false`.';
741 console
.warn(message
);
749 // Listen for mouse events and translate
750 // them into terminal mouse protocols.
754 * This event is emitted when terminal has completed opening.
763 * Attempts to load an add-on using CommonJS or RequireJS (whichever is available).
764 * @param {string} addon The name of the addon to load
767 Terminal
.loadAddon = function(addon
, callback
) {
768 if (typeof exports
=== 'object' && typeof module
=== 'object') {
770 return require('./addons/' + addon
+ '/' + addon
);
771 } else if (typeof define
== 'function') {
773 return require(['./addons/' + addon
+ '/' + addon
], callback
);
775 console
.error('Cannot load a module without a CommonJS or RequireJS environment.');
781 * Updates the helper CSS class with any changes necessary after the terminal's
782 * character width has been changed.
784 Terminal
.prototype.updateCharSizeStyles = function() {
785 this.charSizeStyleElement
.textContent
=
786 `.xterm-wide-char{width:${this.charMeasure.width * 2}px;}` +
787 `.xterm-normal-char{width:${this.charMeasure.width}px;}` +
788 `.xterm-rows > div{height:${this.charMeasure.height}px;}`;
793 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#Mouse%20Tracking
794 * To better understand these
795 * the xterm code is very helpful:
797 * button.c, charproc.c, misc.c
798 * Relevant functions in xterm/button.c:
799 * BtnCode, EmitButtonCode, EditorButton, SendMousePosition
801 Terminal
.prototype.bindMouse = function() {
802 var el
= this.element
, self
= this, pressed
= 32;
804 // mouseup, mousedown, wheel
805 // left click: ^[[M 3<^[[M#3<
807 function sendButton(ev
) {
811 // get the xterm-style button
812 button
= getButton(ev
);
814 // get mouse coordinates
815 pos
= getRawByteCoords(ev
, self
.rowContainer
, self
.charMeasure
, self
.cols
, self
.rows
);
818 sendEvent(button
, pos
);
820 switch (ev
.overrideType
|| ev
.type
) {
825 // keep it at the left
826 // button, just in case.
837 // motion example of a left click:
838 // ^[[M 3<^[[M@4<^[[M@5<^[[M@6<^[[M@7<^[[M#7<
839 function sendMove(ev
) {
843 pos
= getRawByteCoords(ev
, self
.rowContainer
, self
.charMeasure
, self
.cols
, self
.rows
);
846 // buttons marked as motions
847 // are incremented by 32
850 sendEvent(button
, pos
);
854 // position to characters
855 function encode(data
, ch
) {
856 if (!self
.utfMouse
) {
857 if (ch
=== 255) return data
.push(0);
858 if (ch
> 127) ch
= 127;
861 if (ch
=== 2047) return data
.push(0);
865 if (ch
> 2047) ch
= 2047;
866 data
.push(0xC0 | (ch
>> 6));
867 data
.push(0x80 | (ch
& 0x3F));
872 // send a mouse event:
873 // regular/utf8: ^[[M Cb Cx Cy
874 // urxvt: ^[[ Cb ; Cx ; Cy M
875 // sgr: ^[[ Cb ; Cx ; Cy M/m
876 // vt300: ^[[ 24(1/3/5)~ [ Cx , Cy ] \r
877 // locator: CSI P e ; P b ; P r ; P c ; P p & w
878 function sendEvent(button
, pos
) {
879 // self.emit('mouse', {
885 if (self
.vt300Mouse
) {
887 // http://www.vt100.net/docs/vt3xx-gp/chapter15.html
891 var data
= C0
.ESC
+ '[24';
892 if (button
=== 0) data
+= '1';
893 else if (button
=== 1) data
+= '3';
894 else if (button
=== 2) data
+= '5';
895 else if (button
=== 3) return;
897 data
+= '~[' + pos
.x
+ ',' + pos
.y
+ ']\r';
902 if (self
.decLocator
) {
907 if (button
=== 0) button
= 2;
908 else if (button
=== 1) button
= 4;
909 else if (button
=== 2) button
= 6;
910 else if (button
=== 3) button
= 3;
911 self
.send(C0
.ESC
+ '['
914 + (button
=== 3 ? 4 : 0)
925 if (self
.urxvtMouse
) {
930 self
.send(C0
.ESC
+ '[' + button
+ ';' + pos
.x
+ ';' + pos
.y
+ 'M');
937 self
.send(C0
.ESC
+ '[<'
938 + (((button
& 3) === 3 ? button
& ~3 : button
) - 32)
943 + ((button
& 3) === 3 ? 'm' : 'M'));
949 encode(data
, button
);
953 self
.send(C0
.ESC
+ '[M' + String
.fromCharCode
.apply(String
, data
));
956 function getButton(ev
) {
969 // 1, and 2 - with 64 added
970 switch (ev
.overrideType
|| ev
.type
) {
972 button
= ev
.button
!= null
978 if (self
.browser
.isMSIE
) {
979 button
= button
=== 1 ? 0 : button
=== 4 ? 1 : button
;
985 case 'DOMMouseScroll':
986 button
= ev
.detail
< 0
991 button
= ev
.wheelDeltaY
> 0
997 // next three bits are the modifiers:
998 // 4 = shift, 8 = meta, 16 = control
999 shift
= ev
.shiftKey
? 4 : 0;
1000 meta
= ev
.metaKey
? 8 : 0;
1001 ctrl
= ev
.ctrlKey
? 16 : 0;
1002 mod
= shift
| meta
| ctrl
;
1005 if (self
.vt200Mouse
) {
1008 } else if (!self
.normalMouse
) {
1013 button
= (32 + (mod
<< 2)) + button
;
1018 on(el
, 'mousedown', function(ev
) {
1022 if (!self
.mouseEvents
) return;
1028 //if (self.vt200Mouse && !self.normalMouse) {
1029 if (self
.vt200Mouse
) {
1030 ev
.overrideType
= 'mouseup';
1032 return self
.cancel(ev
);
1036 if (self
.normalMouse
) on(self
.document
, 'mousemove', sendMove
);
1038 // x10 compatibility mode can't send button releases
1039 if (!self
.x10Mouse
) {
1040 on(self
.document
, 'mouseup', function up(ev
) {
1042 if (self
.normalMouse
) off(self
.document
, 'mousemove', sendMove
);
1043 off(self
.document
, 'mouseup', up
);
1044 return self
.cancel(ev
);
1048 return self
.cancel(ev
);
1051 //if (self.normalMouse) {
1052 // on(self.document, 'mousemove', sendMove);
1055 on(el
, 'wheel', function(ev
) {
1056 if (!self
.mouseEvents
) return;
1059 || self
.decLocator
) return;
1061 return self
.cancel(ev
);
1064 // allow wheel scrolling in
1065 // the shell for example
1066 on(el
, 'wheel', function(ev
) {
1067 if (self
.mouseEvents
) return;
1068 self
.viewport
.onWheel(ev
);
1069 return self
.cancel(ev
);
1072 on(el
, 'touchstart', function(ev
) {
1073 if (self
.mouseEvents
) return;
1074 self
.viewport
.onTouchStart(ev
);
1075 return self
.cancel(ev
);
1078 on(el
, 'touchmove', function(ev
) {
1079 if (self
.mouseEvents
) return;
1080 self
.viewport
.onTouchMove(ev
);
1081 return self
.cancel(ev
);
1086 * Destroys the terminal.
1088 Terminal
.prototype.destroy = function() {
1089 this.readable
= false;
1090 this.writable
= false;
1092 this.handler = function() {};
1093 this.write = function() {};
1094 if (this.element
&& this.element
.parentNode
) {
1095 this.element
.parentNode
.removeChild(this.element
);
1097 //this.emit('close');
1101 * Tells the renderer to refresh terminal content between two rows (inclusive) at the next
1103 * @param {number} start The row to start from (between 0 and this.rows - 1).
1104 * @param {number} end The row to end at (between start and this.rows - 1).
1106 Terminal
.prototype.refresh = function(start
, end
) {
1107 if (this.renderer
) {
1108 this.renderer
.queueRefresh(start
, end
);
1113 * Queues linkification for the specified rows.
1114 * @param {number} start The row to start from (between 0 and this.rows - 1).
1115 * @param {number} end The row to end at (between start and this.rows - 1).
1117 Terminal
.prototype.queueLinkification = function(start
, end
) {
1118 if (this.linkifier
) {
1119 for (let i
= start
; i
<= end
; i
++) {
1120 this.linkifier
.linkifyRow(i
);
1126 * Display the cursor element
1128 Terminal
.prototype.showCursor = function() {
1129 if (!this.cursorState
) {
1130 this.cursorState
= 1;
1131 this.refresh(this.buffer
.y
, this.buffer
.y
);
1136 * Scroll the terminal down 1 row, creating a blank line.
1137 * @param {boolean} isWrapped Whether the new line is wrapped from the previous
1140 Terminal
.prototype.scroll = function(isWrapped
) {
1143 // Make room for the new row in lines
1144 if (this.buffer
.lines
.length
=== this.buffer
.lines
.maxLength
) {
1145 this.buffer
.lines
.trimStart(1);
1146 this.buffer
.ybase
--;
1147 if (this.buffer
.ydisp
!== 0) {
1148 this.buffer
.ydisp
--;
1152 this.buffer
.ybase
++;
1154 // TODO: Why is this done twice?
1155 if (!this.userScrolling
) {
1156 this.buffer
.ydisp
= this.buffer
.ybase
;
1160 row
= this.buffer
.ybase
+ this.rows
- 1;
1162 // subtract the bottom scroll region
1163 row
-= this.rows
- 1 - this.buffer
.scrollBottom
;
1165 if (row
=== this.buffer
.lines
.length
) {
1166 // Optimization: pushing is faster than splicing when they amount to the same behavior
1167 this.buffer
.lines
.push(this.blankLine(undefined, isWrapped
));
1170 this.buffer
.lines
.splice(row
, 0, this.blankLine(undefined, isWrapped
));
1173 if (this.buffer
.scrollTop
!== 0) {
1174 if (this.buffer
.ybase
!== 0) {
1175 this.buffer
.ybase
--;
1176 if (!this.userScrolling
) {
1177 this.buffer
.ydisp
= this.buffer
.ybase
;
1180 this.buffer
.lines
.splice(this.buffer
.ybase
+ this.buffer
.scrollTop
, 1);
1184 this.updateRange(this.buffer
.scrollTop
);
1185 this.updateRange(this.buffer
.scrollBottom
);
1188 * This event is emitted whenever the terminal is scrolled.
1189 * The one parameter passed is the new y display position.
1193 this.emit('scroll', this.buffer
.ydisp
);
1197 * Scroll the display of the terminal
1198 * @param {number} disp The number of lines to scroll down (negatives scroll up).
1199 * @param {boolean} suppressScrollEvent Don't emit the scroll event as scrollDisp. This is used
1200 * to avoid unwanted events being handled by the veiwport when the event was triggered from the
1201 * viewport originally.
1203 Terminal
.prototype.scrollDisp = function(disp
, suppressScrollEvent
) {
1205 if (this.buffer
.ydisp
=== 0) {
1208 this.userScrolling
= true;
1209 } else if (disp
+ this.buffer
.ydisp
>= this.buffer
.ybase
) {
1210 this.userScrolling
= false;
1213 const oldYdisp
= this.buffer
.ydisp
;
1214 this.buffer
.ydisp
= Math
.max(Math
.min(this.buffer
.ydisp
+ disp
, this.buffer
.ybase
), 0);
1216 // No change occurred, don't trigger scroll/refresh
1217 if (oldYdisp
=== this.buffer
.ydisp
) {
1221 if (!suppressScrollEvent
) {
1222 this.emit('scroll', this.buffer
.ydisp
);
1225 this.refresh(0, this.rows
- 1);
1229 * Scroll the display of the terminal by a number of pages.
1230 * @param {number} pageCount The number of pages to scroll (negative scrolls up).
1232 Terminal
.prototype.scrollPages = function(pageCount
) {
1233 this.scrollDisp(pageCount
* (this.rows
- 1));
1237 * Scrolls the display of the terminal to the top.
1239 Terminal
.prototype.scrollToTop = function() {
1240 this.scrollDisp(-this.buffer
.ydisp
);
1244 * Scrolls the display of the terminal to the bottom.
1246 Terminal
.prototype.scrollToBottom = function() {
1247 this.scrollDisp(this.buffer
.ybase
- this.buffer
.ydisp
);
1251 * Writes text to the terminal.
1252 * @param {string} data The text to write to the terminal.
1254 Terminal
.prototype.write = function(data
) {
1255 this.writeBuffer
.push(data
);
1257 // Send XOFF to pause the pty process if the write buffer becomes too large so
1258 // xterm.js can catch up before more data is sent. This is necessary in order
1259 // to keep signals such as ^C responsive.
1260 if (this.options
.useFlowControl
&& !this.xoffSentToCatchUp
&& this.writeBuffer
.length
>= WRITE_BUFFER_PAUSE_THRESHOLD
) {
1261 // XOFF - stop pty pipe
1262 // XON will be triggered by emulator before processing data chunk
1264 this.xoffSentToCatchUp
= true;
1267 if (!this.writeInProgress
&& this.writeBuffer
.length
> 0) {
1268 // Kick off a write which will write all data in sequence recursively
1269 this.writeInProgress
= true;
1270 // Kick off an async innerWrite so more writes can come in while processing data
1272 setTimeout(function () {
1278 Terminal
.prototype.innerWrite = function() {
1279 var writeBatch
= this.writeBuffer
.splice(0, WRITE_BATCH_SIZE
);
1280 while (writeBatch
.length
> 0) {
1281 var data
= writeBatch
.shift();
1282 var l
= data
.length
, i
= 0, j
, cs
, ch
, code
, low
, ch_width
, row
;
1284 // If XOFF was sent in order to catch up with the pty process, resume it if
1285 // the writeBuffer is empty to allow more data to come in.
1286 if (this.xoffSentToCatchUp
&& writeBatch
.length
=== 0 && this.writeBuffer
.length
=== 0) {
1288 this.xoffSentToCatchUp
= false;
1291 this.refreshStart
= this.buffer
.y
;
1292 this.refreshEnd
= this.buffer
.y
;
1294 // HACK: Set the parser state based on it's state at the time of return.
1295 // This works around the bug #662 which saw the parser state reset in the
1296 // middle of parsing escape sequence in two chunks. For some reason the
1297 // state of the parser resets to 0 after exiting parser.parse. This change
1298 // just sets the state back based on the correct return statement.
1299 var state
= this.parser
.parse(data
);
1300 this.parser
.setState(state
);
1302 this.updateRange(this.buffer
.y
);
1303 this.refresh(this.refreshStart
, this.refreshEnd
);
1305 if (this.writeBuffer
.length
> 0) {
1306 // Allow renderer to catch up before processing the next batch
1308 setTimeout(function () {
1312 this.writeInProgress
= false;
1317 * Writes text to the terminal, followed by a break line character (\n).
1318 * @param {string} data The text to write to the terminal.
1320 Terminal
.prototype.writeln = function(data
) {
1321 this.write(data
+ '\r\n');
1325 * DEPRECATED: only for backward compatibility. Please use attachCustomKeyEventHandler() instead.
1326 * @param {function} customKeydownHandler The custom KeyboardEvent handler to attach. This is a
1327 * function that takes a KeyboardEvent, allowing consumers to stop propogation and/or prevent
1328 * the default action. The function returns whether the event should be processed by xterm.js.
1330 Terminal
.prototype.attachCustomKeydownHandler = function(customKeydownHandler
) {
1331 let message
= 'attachCustomKeydownHandler() is DEPRECATED and will be removed soon. Please use attachCustomKeyEventHandler() instead.';
1332 console
.warn(message
);
1333 this.attachCustomKeyEventHandler(customKeydownHandler
);
1337 * Attaches a custom key event handler which is run before keys are processed, giving consumers of
1338 * xterm.js ultimate control as to what keys should be processed by the terminal and what keys
1340 * @param {function} customKeyEventHandler The custom KeyboardEvent handler to attach. This is a
1341 * function that takes a KeyboardEvent, allowing consumers to stop propogation and/or prevent
1342 * the default action. The function returns whether the event should be processed by xterm.js.
1344 Terminal
.prototype.attachCustomKeyEventHandler = function(customKeyEventHandler
) {
1345 this.customKeyEventHandler
= customKeyEventHandler
;
1349 * Attaches a http(s) link handler, forcing web links to behave differently to
1350 * regular <a> tags. This will trigger a refresh as links potentially need to be
1351 * reconstructed. Calling this with null will remove the handler.
1352 * @param {LinkMatcherHandler} handler The handler callback function.
1354 Terminal
.prototype.setHypertextLinkHandler = function(handler
) {
1355 if (!this.linkifier
) {
1356 throw new Error('Cannot attach a hypertext link handler before Terminal.open is called');
1358 this.linkifier
.setHypertextLinkHandler(handler
);
1359 // Refresh to force links to refresh
1360 this.refresh(0, this.rows
- 1);
1364 * Attaches a validation callback for hypertext links. This is useful to use
1365 * validation logic or to do something with the link's element and url.
1366 * @param {LinkMatcherValidationCallback} callback The callback to use, this can
1367 * be cleared with null.
1369 Terminal
.prototype.setHypertextValidationCallback = function(callback
) {
1370 if (!this.linkifier
) {
1371 throw new Error('Cannot attach a hypertext validation callback before Terminal.open is called');
1373 this.linkifier
.setHypertextValidationCallback(callback
);
1374 // Refresh to force links to refresh
1375 this.refresh(0, this.rows
- 1);
1379 * Registers a link matcher, allowing custom link patterns to be matched and
1381 * @param {RegExp} regex The regular expression to search for, specifically
1382 * this searches the textContent of the rows. You will want to use \s to match
1383 * a space ' ' character for example.
1384 * @param {LinkMatcherHandler} handler The callback when the link is called.
1385 * @param {LinkMatcherOptions} [options] Options for the link matcher.
1386 * @return {number} The ID of the new matcher, this can be used to deregister.
1388 Terminal
.prototype.registerLinkMatcher = function(regex
, handler
, options
) {
1389 if (this.linkifier
) {
1390 var matcherId
= this.linkifier
.registerLinkMatcher(regex
, handler
, options
);
1391 this.refresh(0, this.rows
- 1);
1397 * Deregisters a link matcher if it has been registered.
1398 * @param {number} matcherId The link matcher's ID (returned after register)
1400 Terminal
.prototype.deregisterLinkMatcher = function(matcherId
) {
1401 if (this.linkifier
) {
1402 if (this.linkifier
.deregisterLinkMatcher(matcherId
)) {
1403 this.refresh(0, this.rows
- 1);
1409 * Gets whether the terminal has an active selection.
1411 Terminal
.prototype.hasSelection = function() {
1412 return this.selectionManager
? this.selectionManager
.hasSelection
: false;
1416 * Gets the terminal's current selection, this is useful for implementing copy
1417 * behavior outside of xterm.js.
1419 Terminal
.prototype.getSelection = function() {
1420 return this.selectionManager
? this.selectionManager
.selectionText
: '';
1424 * Clears the current terminal selection.
1426 Terminal
.prototype.clearSelection = function() {
1427 if (this.selectionManager
) {
1428 this.selectionManager
.clearSelection();
1433 * Selects all text within the terminal.
1435 Terminal
.prototype.selectAll = function() {
1436 if (this.selectionManager
) {
1437 this.selectionManager
.selectAll();
1442 * Handle a keydown event
1444 * - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent
1445 * @param {KeyboardEvent} ev The keydown event to be handled.
1447 Terminal
.prototype.keyDown = function(ev
) {
1448 if (this.customKeyEventHandler
&& this.customKeyEventHandler(ev
) === false) {
1452 this.restartCursorBlinking();
1454 if (!this.compositionHelper
.keydown
.bind(this.compositionHelper
)(ev
)) {
1455 if (this.buffer
.ybase
!== this.buffer
.ydisp
) {
1456 this.scrollToBottom();
1462 var result
= this.evaluateKeyEscapeSequence(ev
);
1464 if (result
.key
=== C0
.DC3
) { // XOFF
1465 this.writeStopped
= true;
1466 } else if (result
.key
=== C0
.DC1
) { // XON
1467 this.writeStopped
= false;
1470 if (result
.scrollDisp
) {
1471 this.scrollDisp(result
.scrollDisp
);
1472 return this.cancel(ev
, true);
1475 if (isThirdLevelShift(this, ev
)) {
1479 if (result
.cancel
) {
1480 // The event is canceled at the end already, is this necessary?
1481 this.cancel(ev
, true);
1488 this.emit('keydown', ev
);
1489 this.emit('key', result
.key
, ev
);
1491 this.handler(result
.key
);
1493 return this.cancel(ev
, true);
1497 * Returns an object that determines how a KeyboardEvent should be handled. The key of the
1498 * returned value is the new key code to pass to the PTY.
1500 * Reference: http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
1501 * @param {KeyboardEvent} ev The keyboard event to be translated to key escape sequence.
1503 Terminal
.prototype.evaluateKeyEscapeSequence = function(ev
) {
1505 // Whether to cancel event propogation (NOTE: this may not be needed since the event is
1506 // canceled at the end of keyDown
1508 // The new key even to emit
1510 // The number of characters to scroll, if this is defined it will cancel the event
1511 scrollDisp
: undefined
1513 var modifiers
= ev
.shiftKey
<< 0 | ev
.altKey
<< 1 | ev
.ctrlKey
<< 2 | ev
.metaKey
<< 3;
1514 switch (ev
.keyCode
) {
1518 result
.key
= C0
.BS
; // ^H
1521 result
.key
= C0
.DEL
; // ^?
1526 result
.key
= C0
.ESC
+ '[Z';
1530 result
.cancel
= true;
1535 result
.cancel
= true;
1539 result
.key
= C0
.ESC
;
1540 result
.cancel
= true;
1545 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'D';
1546 // HACK: Make Alt + left-arrow behave like Ctrl + left-arrow: move one word backwards
1547 // http://unix.stackexchange.com/a/108106
1548 // macOS uses different escape sequences than linux
1549 if (result
.key
== C0
.ESC
+ '[1;3D') {
1550 result
.key
= (this.browser
.isMac
) ? C0
.ESC
+ 'b' : C0
.ESC
+ '[1;5D';
1552 } else if (this.applicationCursor
) {
1553 result
.key
= C0
.ESC
+ 'OD';
1555 result
.key
= C0
.ESC
+ '[D';
1561 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'C';
1562 // HACK: Make Alt + right-arrow behave like Ctrl + right-arrow: move one word forward
1563 // http://unix.stackexchange.com/a/108106
1564 // macOS uses different escape sequences than linux
1565 if (result
.key
== C0
.ESC
+ '[1;3C') {
1566 result
.key
= (this.browser
.isMac
) ? C0
.ESC
+ 'f' : C0
.ESC
+ '[1;5C';
1568 } else if (this.applicationCursor
) {
1569 result
.key
= C0
.ESC
+ 'OC';
1571 result
.key
= C0
.ESC
+ '[C';
1577 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'A';
1578 // HACK: Make Alt + up-arrow behave like Ctrl + up-arrow
1579 // http://unix.stackexchange.com/a/108106
1580 if (result
.key
== C0
.ESC
+ '[1;3A') {
1581 result
.key
= C0
.ESC
+ '[1;5A';
1583 } else if (this.applicationCursor
) {
1584 result
.key
= C0
.ESC
+ 'OA';
1586 result
.key
= C0
.ESC
+ '[A';
1592 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'B';
1593 // HACK: Make Alt + down-arrow behave like Ctrl + down-arrow
1594 // http://unix.stackexchange.com/a/108106
1595 if (result
.key
== C0
.ESC
+ '[1;3B') {
1596 result
.key
= C0
.ESC
+ '[1;5B';
1598 } else if (this.applicationCursor
) {
1599 result
.key
= C0
.ESC
+ 'OB';
1601 result
.key
= C0
.ESC
+ '[B';
1606 if (!ev
.shiftKey
&& !ev
.ctrlKey
) {
1607 // <Ctrl> or <Shift> + <Insert> are used to
1608 // copy-paste on some systems.
1609 result
.key
= C0
.ESC
+ '[2~';
1615 result
.key
= C0
.ESC
+ '[3;' + (modifiers
+ 1) + '~';
1617 result
.key
= C0
.ESC
+ '[3~';
1623 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'H';
1624 else if (this.applicationCursor
)
1625 result
.key
= C0
.ESC
+ 'OH';
1627 result
.key
= C0
.ESC
+ '[H';
1632 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'F';
1633 else if (this.applicationCursor
)
1634 result
.key
= C0
.ESC
+ 'OF';
1636 result
.key
= C0
.ESC
+ '[F';
1641 result
.scrollDisp
= -(this.rows
- 1);
1643 result
.key
= C0
.ESC
+ '[5~';
1649 result
.scrollDisp
= this.rows
- 1;
1651 result
.key
= C0
.ESC
+ '[6~';
1657 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'P';
1659 result
.key
= C0
.ESC
+ 'OP';
1664 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'Q';
1666 result
.key
= C0
.ESC
+ 'OQ';
1671 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'R';
1673 result
.key
= C0
.ESC
+ 'OR';
1678 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'S';
1680 result
.key
= C0
.ESC
+ 'OS';
1685 result
.key
= C0
.ESC
+ '[15;' + (modifiers
+ 1) + '~';
1687 result
.key
= C0
.ESC
+ '[15~';
1692 result
.key
= C0
.ESC
+ '[17;' + (modifiers
+ 1) + '~';
1694 result
.key
= C0
.ESC
+ '[17~';
1699 result
.key
= C0
.ESC
+ '[18;' + (modifiers
+ 1) + '~';
1701 result
.key
= C0
.ESC
+ '[18~';
1706 result
.key
= C0
.ESC
+ '[19;' + (modifiers
+ 1) + '~';
1708 result
.key
= C0
.ESC
+ '[19~';
1713 result
.key
= C0
.ESC
+ '[20;' + (modifiers
+ 1) + '~';
1715 result
.key
= C0
.ESC
+ '[20~';
1720 result
.key
= C0
.ESC
+ '[21;' + (modifiers
+ 1) + '~';
1722 result
.key
= C0
.ESC
+ '[21~';
1727 result
.key
= C0
.ESC
+ '[23;' + (modifiers
+ 1) + '~';
1729 result
.key
= C0
.ESC
+ '[23~';
1734 result
.key
= C0
.ESC
+ '[24;' + (modifiers
+ 1) + '~';
1736 result
.key
= C0
.ESC
+ '[24~';
1741 if (ev
.ctrlKey
&& !ev
.shiftKey
&& !ev
.altKey
&& !ev
.metaKey
) {
1742 if (ev
.keyCode
>= 65 && ev
.keyCode
<= 90) {
1743 result
.key
= String
.fromCharCode(ev
.keyCode
- 64);
1744 } else if (ev
.keyCode
=== 32) {
1746 result
.key
= String
.fromCharCode(0);
1747 } else if (ev
.keyCode
>= 51 && ev
.keyCode
<= 55) {
1748 // escape, file sep, group sep, record sep, unit sep
1749 result
.key
= String
.fromCharCode(ev
.keyCode
- 51 + 27);
1750 } else if (ev
.keyCode
=== 56) {
1752 result
.key
= String
.fromCharCode(127);
1753 } else if (ev
.keyCode
=== 219) {
1754 // ^[ - Control Sequence Introducer (CSI)
1755 result
.key
= String
.fromCharCode(27);
1756 } else if (ev
.keyCode
=== 220) {
1757 // ^\ - String Terminator (ST)
1758 result
.key
= String
.fromCharCode(28);
1759 } else if (ev
.keyCode
=== 221) {
1760 // ^] - Operating System Command (OSC)
1761 result
.key
= String
.fromCharCode(29);
1763 } else if (!this.browser
.isMac
&& ev
.altKey
&& !ev
.ctrlKey
&& !ev
.metaKey
) {
1764 // On Mac this is a third level shift. Use <Esc> instead.
1765 if (ev
.keyCode
>= 65 && ev
.keyCode
<= 90) {
1766 result
.key
= C0
.ESC
+ String
.fromCharCode(ev
.keyCode
+ 32);
1767 } else if (ev
.keyCode
=== 192) {
1768 result
.key
= C0
.ESC
+ '`';
1769 } else if (ev
.keyCode
>= 48 && ev
.keyCode
<= 57) {
1770 result
.key
= C0
.ESC
+ (ev
.keyCode
- 48);
1772 } else if (this.browser
.isMac
&& !ev
.altKey
&& !ev
.ctrlKey
&& ev
.metaKey
) {
1773 if (ev
.keyCode
=== 65) { // cmd + a
1784 * Set the G level of the terminal
1787 Terminal
.prototype.setgLevel = function(g
) {
1789 this.charset
= this.charsets
[g
];
1793 * Set the charset for the given G level of the terminal
1797 Terminal
.prototype.setgCharset = function(g
, charset
) {
1798 this.charsets
[g
] = charset
;
1799 if (this.glevel
=== g
) {
1800 this.charset
= charset
;
1805 * Handle a keypress event.
1807 * - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent
1808 * @param {KeyboardEvent} ev The keypress event to be handled.
1810 Terminal
.prototype.keyPress = function(ev
) {
1813 if (this.customKeyEventHandler
&& this.customKeyEventHandler(ev
) === false) {
1821 } else if (ev
.which
== null) {
1823 } else if (ev
.which
!== 0 && ev
.charCode
!== 0) {
1830 (ev
.altKey
|| ev
.ctrlKey
|| ev
.metaKey
) && !isThirdLevelShift(this, ev
)
1835 key
= String
.fromCharCode(key
);
1837 this.emit('keypress', key
, ev
);
1838 this.emit('key', key
, ev
);
1846 * Send data for handling to the terminal
1847 * @param {string} data
1849 Terminal
.prototype.send = function(data
) {
1853 setTimeout(function() {
1854 self
.handler(self
.queue
);
1864 * Note: We could do sweet things with webaudio here
1866 Terminal
.prototype.bell = function() {
1867 if (!this.visualBell
) return;
1869 this.element
.style
.borderColor
= 'white';
1870 setTimeout(function() {
1871 self
.element
.style
.borderColor
= '';
1873 if (this.popOnBell
) this.focus();
1877 * Log the current state to the console.
1879 Terminal
.prototype.log = function() {
1880 if (!this.debug
) return;
1881 if (!this.context
.console
|| !this.context
.console
.log
) return;
1882 var args
= Array
.prototype.slice
.call(arguments
);
1883 this.context
.console
.log
.apply(this.context
.console
, args
);
1887 * Log the current state as error to the console.
1889 Terminal
.prototype.error = function() {
1890 if (!this.debug
) return;
1891 if (!this.context
.console
|| !this.context
.console
.error
) return;
1892 var args
= Array
.prototype.slice
.call(arguments
);
1893 this.context
.console
.error
.apply(this.context
.console
, args
);
1897 * Resizes the terminal.
1899 * @param {number} x The number of columns to resize to.
1900 * @param {number} y The number of rows to resize to.
1902 Terminal
.prototype.resize = function(x
, y
) {
1903 if (isNaN(x
) || isNaN(y
)) {
1907 if (y
> this.getOption('scrollback')) {
1908 this.setOption('scrollback', y
)
1918 if (x
=== this.cols
&& y
=== this.rows
) {
1919 // Check if we still need to measure the char size (fixes #785).
1920 if (!this.charMeasure
.width
|| !this.charMeasure
.height
) {
1921 this.charMeasure
.measure();
1932 ch
= [this.defAttr
, ' ', 1]; // does xterm use the default attr?
1933 i
= this.buffer
.lines
.length
;
1935 if (this.buffer
.lines
.get(i
) === undefined) {
1936 this.buffer
.lines
.set(i
, this.blankLine());
1938 while (this.buffer
.lines
.get(i
).length
< x
) {
1939 this.buffer
.lines
.get(i
).push(ch
);
1945 this.setupStops(this.cols
);
1953 // y is rows, not this.buffer.y
1954 if (this.buffer
.lines
.length
< y
+ this.buffer
.ybase
) {
1955 if (this.buffer
.ybase
> 0 && this.buffer
.lines
.length
<= this.buffer
.ybase
+ this.buffer
.y
+ addToY
+ 1) {
1956 // There is room above the buffer and there are no empty elements below the line,
1958 this.buffer
.ybase
--;
1960 if (this.buffer
.ydisp
> 0) {
1961 // Viewport is at the top of the buffer, must increase downwards
1962 this.buffer
.ydisp
--;
1965 // Add a blank line if there is no buffer left at the top to scroll to, or if there
1966 // are blank lines after the cursor
1967 this.buffer
.lines
.push(this.blankLine());
1970 if (this.children
.length
< y
) {
1976 if (this.buffer
.lines
.length
> y
+ this.buffer
.ybase
) {
1977 if (this.buffer
.lines
.length
> this.buffer
.ybase
+ this.buffer
.y
+ 1) {
1978 // The line is a blank line below the cursor, remove it
1979 this.buffer
.lines
.pop();
1981 // The line is the cursor, scroll down
1982 this.buffer
.ybase
++;
1983 this.buffer
.ydisp
++;
1986 if (this.children
.length
> y
) {
1987 el
= this.children
.shift();
1989 el
.parentNode
.removeChild(el
);
1995 // Make sure that the cursor stays on screen
1996 if (this.buffer
.y
>= y
) {
1997 this.buffer
.y
= y
- 1;
2000 this.buffer
.y
+= addToY
;
2003 if (this.buffer
.x
>= x
) {
2004 this.buffer
.x
= x
- 1;
2007 this.buffer
.scrollTop
= 0;
2008 this.buffer
.scrollBottom
= y
- 1;
2010 this.charMeasure
.measure();
2012 this.refresh(0, this.rows
- 1);
2014 this.geometry
= [this.cols
, this.rows
];
2015 this.emit('resize', {terminal
: this, cols
: x
, rows
: y
});
2019 * Updates the range of rows to refresh
2020 * @param {number} y The number of rows to refresh next.
2022 Terminal
.prototype.updateRange = function(y
) {
2023 if (y
< this.refreshStart
) this.refreshStart
= y
;
2024 if (y
> this.refreshEnd
) this.refreshEnd
= y
;
2025 // if (y > this.refreshEnd) {
2026 // this.refreshEnd = y;
2027 // if (y > this.rows - 1) {
2028 // this.refreshEnd = this.rows - 1;
2034 * Set the range of refreshing to the maximum value
2036 Terminal
.prototype.maxRange = function() {
2037 this.refreshStart
= 0;
2038 this.refreshEnd
= this.rows
- 1;
2044 * Setup the tab stops.
2047 Terminal
.prototype.setupStops = function(i
) {
2049 if (!this.buffer
.tabs
[i
]) {
2050 i
= this.prevStop(i
);
2053 this.buffer
.tabs
= {};
2057 for (; i
< this.cols
; i
+= this.getOption('tabStopWidth')) {
2058 this.buffer
.tabs
[i
] = true;
2064 * Move the cursor to the previous tab stop from the given position (default is current).
2065 * @param {number} x The position to move the cursor to the previous tab stop.
2067 Terminal
.prototype.prevStop = function(x
) {
2068 if (x
== null) x
= this.buffer
.x
;
2069 while (!this.buffer
.tabs
[--x
] && x
> 0);
2070 return x
>= this.cols
2077 * Move the cursor one tab stop forward from the given position (default is current).
2078 * @param {number} x The position to move the cursor one tab stop forward.
2080 Terminal
.prototype.nextStop = function(x
) {
2081 if (x
== null) x
= this.buffer
.x
;
2082 while (!this.buffer
.tabs
[++x
] && x
< this.cols
);
2083 return x
>= this.cols
2090 * Erase in the identified line everything from "x" to the end of the line (right).
2091 * @param {number} x The column from which to start erasing to the end of the line.
2092 * @param {number} y The line in which to operate.
2094 Terminal
.prototype.eraseRight = function(x
, y
) {
2095 var line
= this.buffer
.lines
.get(this.buffer
.ybase
+ y
);
2099 var ch
= [this.eraseAttr(), ' ', 1]; // xterm
2100 for (; x
< this.cols
; x
++) {
2103 this.updateRange(y
);
2109 * Erase in the identified line everything from "x" to the start of the line (left).
2110 * @param {number} x The column from which to start erasing to the start of the line.
2111 * @param {number} y The line in which to operate.
2113 Terminal
.prototype.eraseLeft = function(x
, y
) {
2114 var line
= this.buffer
.lines
.get(this.buffer
.ybase
+ y
);
2118 var ch
= [this.eraseAttr(), ' ', 1]; // xterm
2123 this.updateRange(y
);
2127 * Clears the entire buffer, making the prompt line the new first line.
2129 Terminal
.prototype.clear = function() {
2130 if (this.buffer
.ybase
=== 0 && this.buffer
.y
=== 0) {
2131 // Don't clear if it's already clear
2134 this.buffer
.lines
.set(0, this.buffer
.lines
.get(this.buffer
.ybase
+ this.buffer
.y
));
2135 this.buffer
.lines
.length
= 1;
2136 this.buffer
.ydisp
= 0;
2137 this.buffer
.ybase
= 0;
2139 for (var i
= 1; i
< this.rows
; i
++) {
2140 this.buffer
.lines
.push(this.blankLine());
2142 this.refresh(0, this.rows
- 1);
2143 this.emit('scroll', this.buffer
.ydisp
);
2147 * Erase all content in the given line
2148 * @param {number} y The line to erase all of its contents.
2150 Terminal
.prototype.eraseLine = function(y
) {
2151 this.eraseRight(0, y
);
2156 * Return the data array of a blank line
2157 * @param {number} cur First bunch of data for each "blank" character.
2158 * @param {boolean} isWrapped Whether the new line is wrapped from the previous line.
2160 Terminal
.prototype.blankLine = function(cur
, isWrapped
) {
2165 var ch
= [attr
, ' ', 1] // width defaults to 1 halfwidth character
2169 // TODO: It is not ideal that this is a property on an array, a buffer line
2170 // class should be added that will hold this data and other useful functions.
2172 line
.isWrapped
= isWrapped
;
2175 for (; i
< this.cols
; i
++) {
2184 * If cur return the back color xterm feature attribute. Else return defAttr.
2185 * @param {object} cur
2187 Terminal
.prototype.ch = function(cur
) {
2189 ? [this.eraseAttr(), ' ', 1]
2190 : [this.defAttr
, ' ', 1];
2195 * Evaluate if the current terminal is the given argument.
2196 * @param {object} term The terminal to evaluate
2198 Terminal
.prototype.is = function(term
) {
2199 var name
= this.termName
;
2200 return (name
+ '').indexOf(term
) === 0;
2205 * Emit the 'data' event and populate the given data.
2206 * @param {string} data The data to populate in the event.
2208 Terminal
.prototype.handler = function(data
) {
2209 // Prevents all events to pty process if stdin is disabled
2210 if (this.options
.disableStdin
) {
2214 // Clear the selection if the selection manager is available and has an active selection
2215 if (this.selectionManager
&& this.selectionManager
.hasSelection
) {
2216 this.selectionManager
.clearSelection();
2219 // Input is being sent to the terminal, the terminal should focus the prompt.
2220 if (this.buffer
.ybase
!== this.buffer
.ydisp
) {
2221 this.scrollToBottom();
2223 this.emit('data', data
);
2228 * Emit the 'title' event and populate the given title.
2229 * @param {string} title The title to populate in the event.
2231 Terminal
.prototype.handleTitle = function(title
) {
2233 * This event is emitted when the title of the terminal is changed
2234 * from inside the terminal. The parameter is the new title.
2238 this.emit('title', title
);
2247 * ESC D Index (IND is 0x84).
2249 Terminal
.prototype.index = function() {
2251 if (this.buffer
.y
> this.buffer
.scrollBottom
) {
2255 // If the end of the line is hit, prevent this action from wrapping around to the next line.
2256 if (this.buffer
.x
>= this.cols
) {
2263 * ESC M Reverse Index (RI is 0x8d).
2265 * Move the cursor up one row, inserting a new blank line if necessary.
2267 Terminal
.prototype.reverseIndex = function() {
2269 if (this.buffer
.y
=== this.buffer
.scrollTop
) {
2270 // possibly move the code below to term.reverseScroll();
2271 // test: echo -ne '\e[1;1H\e[44m\eM\e[0m'
2272 // blankLine(true) is xterm/linux behavior
2273 this.buffer
.lines
.shiftElements(this.buffer
.y
+ this.buffer
.ybase
, this.rows
- 1, 1);
2274 this.buffer
.lines
.set(this.buffer
.y
+ this.buffer
.ybase
, this.blankLine(true));
2275 this.updateRange(this.buffer
.scrollTop
);
2276 this.updateRange(this.buffer
.scrollBottom
);
2284 * ESC c Full Reset (RIS).
2286 Terminal
.prototype.reset = function() {
2287 this.options
.rows
= this.rows
;
2288 this.options
.cols
= this.cols
;
2289 var customKeyEventHandler
= this.customKeyEventHandler
;
2290 var cursorBlinkInterval
= this.cursorBlinkInterval
;
2291 var inputHandler
= this.inputHandler
;
2292 var buffers
= this.buffers
;
2293 Terminal
.call(this, this.options
);
2294 this.customKeyEventHandler
= customKeyEventHandler
;
2295 this.cursorBlinkInterval
= cursorBlinkInterval
;
2296 this.inputHandler
= inputHandler
;
2297 this.buffers
= buffers
;
2298 this.refresh(0, this.rows
- 1);
2299 this.viewport
.syncScrollArea();
2304 * ESC H Tab Set (HTS is 0x88).
2306 Terminal
.prototype.tabSet = function() {
2307 this.buffer
.tabs
[this.buffer
.x
] = true;
2314 function on(el
, type
, handler
, capture
) {
2315 if (!Array
.isArray(el
)) {
2318 el
.forEach(function (element
) {
2319 element
.addEventListener(type
, handler
, capture
|| false);
2323 function off(el
, type
, handler
, capture
) {
2324 el
.removeEventListener(type
, handler
, capture
|| false);
2327 function cancel(ev
, force
) {
2328 if (!this.cancelEvents
&& !force
) {
2331 ev
.preventDefault();
2332 ev
.stopPropagation();
2336 function inherits(child
, parent
) {
2338 this.constructor = child
;
2340 f
.prototype = parent
.prototype;
2341 child
.prototype = new f
;
2344 function indexOf(obj
, el
) {
2347 if (obj
[i
] === el
) return i
;
2352 function isThirdLevelShift(term
, ev
) {
2354 (term
.browser
.isMac
&& ev
.altKey
&& !ev
.ctrlKey
&& !ev
.metaKey
) ||
2355 (term
.browser
.isMSWindows
&& ev
.altKey
&& ev
.ctrlKey
&& !ev
.metaKey
);
2357 if (ev
.type
== 'keypress') {
2358 return thirdLevelKey
;
2361 // Don't invoke for arrows, pageDown, home, backspace, etc. (on non-keypress events)
2362 return thirdLevelKey
&& (!ev
.keyCode
|| ev
.keyCode
> 47);
2365 // Expose to InputHandler (temporary)
2366 Terminal
.prototype.matchColor
= matchColor
;
2368 function matchColor(r1
, g1
, b1
) {
2369 var hash
= (r1
<< 16) | (g1
<< 8) | b1
;
2371 if (matchColor
._cache
[hash
] != null) {
2372 return matchColor
._cache
[hash
];
2375 var ldiff
= Infinity
2384 for (; i
< Terminal
.vcolors
.length
; i
++) {
2385 c
= Terminal
.vcolors
[i
];
2390 diff
= matchColor
.distance(r1
, g1
, b1
, r2
, g2
, b2
);
2403 return matchColor
._cache
[hash
] = li
;
2406 matchColor
._cache
= {};
2408 // http://stackoverflow.com/questions/1633828
2409 matchColor
.distance = function(r1
, g1
, b1
, r2
, g2
, b2
) {
2410 return Math
.pow(30 * (r1
- r2
), 2)
2411 + Math
.pow(59 * (g1
- g2
), 2)
2412 + Math
.pow(11 * (b1
- b2
), 2);
2415 function each(obj
, iter
, con
) {
2416 if (obj
.forEach
) return obj
.forEach(iter
, con
);
2417 for (var i
= 0; i
< obj
.length
; i
++) {
2418 iter
.call(con
, obj
[i
], i
, obj
);
2422 function wasMondifierKeyOnlyEvent(ev
) {
2423 return ev
.keyCode
=== 16 || // Shift
2424 ev
.keyCode
=== 17 || // Ctrl
2425 ev
.keyCode
=== 18; // Alt
2428 function keys(obj
) {
2429 if (Object
.keys
) return Object
.keys(obj
);
2432 if (Object
.prototype.hasOwnProperty
.call(obj
, key
)) {
2443 Terminal
.translateBufferLineToString
= translateBufferLineToString
;
2444 Terminal
.EventEmitter
= EventEmitter
;
2445 Terminal
.inherits
= inherits
;
2448 * Adds an event listener to the terminal.
2450 * @param {string} event The name of the event. TODO: Document all event types
2451 * @param {function} callback The function to call when the event is triggered.
2455 Terminal
.cancel
= cancel
;
2457 module
.exports
= Terminal
;