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 this.element
.classList
.toggle(`xterm-cursor-style-block`, value
=== 'block');
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.element
.classList
.add(`xterm-cursor-style-${this.options.cursorStyle}`);
643 this.setCursorBlinking(this.options
.cursorBlink
);
645 this.element
.setAttribute('tabindex', 0);
647 this.viewportElement
= document
.createElement('div');
648 this.viewportElement
.classList
.add('xterm-viewport');
649 this.element
.appendChild(this.viewportElement
);
650 this.viewportScrollArea
= document
.createElement('div');
651 this.viewportScrollArea
.classList
.add('xterm-scroll-area');
652 this.viewportElement
.appendChild(this.viewportScrollArea
);
654 // Create the selection container.
655 this.selectionContainer
= document
.createElement('div');
656 this.selectionContainer
.classList
.add('xterm-selection');
657 this.element
.appendChild(this.selectionContainer
);
659 // Create the container that will hold the lines of the terminal and then
660 // produce the lines the lines.
661 this.rowContainer
= document
.createElement('div');
662 this.rowContainer
.classList
.add('xterm-rows');
663 this.element
.appendChild(this.rowContainer
);
665 this.linkifier
.attachToDom(document
, this.children
);
667 // Create the container that will hold helpers like the textarea for
668 // capturing DOM Events. Then produce the helpers.
669 this.helperContainer
= document
.createElement('div');
670 this.helperContainer
.classList
.add('xterm-helpers');
671 // TODO: This should probably be inserted once it's filled to prevent an additional layout
672 this.element
.appendChild(this.helperContainer
);
673 this.textarea
= document
.createElement('textarea');
674 this.textarea
.classList
.add('xterm-helper-textarea');
675 this.textarea
.setAttribute('autocorrect', 'off');
676 this.textarea
.setAttribute('autocapitalize', 'off');
677 this.textarea
.setAttribute('spellcheck', 'false');
678 this.textarea
.tabIndex
= 0;
679 this.textarea
.addEventListener('focus', function() {
680 self
.emit('focus', {terminal
: self
});
682 this.textarea
.addEventListener('blur', function() {
683 self
.emit('blur', {terminal
: self
});
685 this.helperContainer
.appendChild(this.textarea
);
687 this.compositionView
= document
.createElement('div');
688 this.compositionView
.classList
.add('composition-view');
689 this.compositionHelper
= new CompositionHelper(this.textarea
, this.compositionView
, this);
690 this.helperContainer
.appendChild(this.compositionView
);
692 this.charSizeStyleElement
= document
.createElement('style');
693 this.helperContainer
.appendChild(this.charSizeStyleElement
);
695 for (; i
< this.rows
; i
++) {
698 this.parent
.appendChild(this.element
);
700 this.charMeasure
= new CharMeasure(document
, this.helperContainer
);
701 this.charMeasure
.on('charsizechanged', function () {
702 self
.updateCharSizeStyles();
704 this.charMeasure
.measure();
706 this.viewport
= new Viewport(this, this.viewportElement
, this.viewportScrollArea
, this.charMeasure
);
707 this.renderer
= new Renderer(this);
708 this.selectionManager
= new SelectionManager(
709 this, this.buffer
.lines
, this.rowContainer
, this.charMeasure
711 this.selectionManager
.on('refresh', data
=> {
712 this.renderer
.refreshSelection(data
.start
, data
.end
);
714 this.selectionManager
.on('newselection', text
=> {
715 // If there's a new selection, put it into the textarea, focus and select it
716 // in order to register it as a selection on the OS. This event is fired
717 // only on Linux to enable middle click to paste selection.
718 this.textarea
.value
= text
;
719 this.textarea
.focus();
720 this.textarea
.select();
722 this.on('scroll', () => this.selectionManager
.refresh());
723 this.viewportElement
.addEventListener('scroll', () => this.selectionManager
.refresh());
725 // Setup loop that draws to screen
726 this.refresh(0, this.rows
- 1);
728 // Initialize global actions that
729 // need to be taken on the document.
733 * Automatic focus functionality.
734 * TODO: Default to `false` starting with xterm.js 3.0.
736 if (typeof focus
== 'undefined') {
737 let message
= 'You did not pass the `focus` argument in `Terminal.prototype.open()`.\n';
739 message
+= 'The `focus` argument now defaults to `true` but starting with xterm.js 3.0 ';
740 message
+= 'it will default to `false`.';
742 console
.warn(message
);
750 // Listen for mouse events and translate
751 // them into terminal mouse protocols.
755 * This event is emitted when terminal has completed opening.
764 * Attempts to load an add-on using CommonJS or RequireJS (whichever is available).
765 * @param {string} addon The name of the addon to load
768 Terminal
.loadAddon = function(addon
, callback
) {
769 if (typeof exports
=== 'object' && typeof module
=== 'object') {
771 return require('./addons/' + addon
+ '/' + addon
);
772 } else if (typeof define
== 'function') {
774 return require(['./addons/' + addon
+ '/' + addon
], callback
);
776 console
.error('Cannot load a module without a CommonJS or RequireJS environment.');
782 * Updates the helper CSS class with any changes necessary after the terminal's
783 * character width has been changed.
785 Terminal
.prototype.updateCharSizeStyles = function() {
786 this.charSizeStyleElement
.textContent
=
787 `.xterm-wide-char{width:${this.charMeasure.width * 2}px;}` +
788 `.xterm-normal-char{width:${this.charMeasure.width}px;}` +
789 `.xterm-rows > div{height:${this.charMeasure.height}px;}`;
794 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#Mouse%20Tracking
795 * To better understand these
796 * the xterm code is very helpful:
798 * button.c, charproc.c, misc.c
799 * Relevant functions in xterm/button.c:
800 * BtnCode, EmitButtonCode, EditorButton, SendMousePosition
802 Terminal
.prototype.bindMouse = function() {
803 var el
= this.element
, self
= this, pressed
= 32;
805 // mouseup, mousedown, wheel
806 // left click: ^[[M 3<^[[M#3<
808 function sendButton(ev
) {
812 // get the xterm-style button
813 button
= getButton(ev
);
815 // get mouse coordinates
816 pos
= getRawByteCoords(ev
, self
.rowContainer
, self
.charMeasure
, self
.cols
, self
.rows
);
819 sendEvent(button
, pos
);
821 switch (ev
.overrideType
|| ev
.type
) {
826 // keep it at the left
827 // button, just in case.
838 // motion example of a left click:
839 // ^[[M 3<^[[M@4<^[[M@5<^[[M@6<^[[M@7<^[[M#7<
840 function sendMove(ev
) {
844 pos
= getRawByteCoords(ev
, self
.rowContainer
, self
.charMeasure
, self
.cols
, self
.rows
);
847 // buttons marked as motions
848 // are incremented by 32
851 sendEvent(button
, pos
);
855 // position to characters
856 function encode(data
, ch
) {
857 if (!self
.utfMouse
) {
858 if (ch
=== 255) return data
.push(0);
859 if (ch
> 127) ch
= 127;
862 if (ch
=== 2047) return data
.push(0);
866 if (ch
> 2047) ch
= 2047;
867 data
.push(0xC0 | (ch
>> 6));
868 data
.push(0x80 | (ch
& 0x3F));
873 // send a mouse event:
874 // regular/utf8: ^[[M Cb Cx Cy
875 // urxvt: ^[[ Cb ; Cx ; Cy M
876 // sgr: ^[[ Cb ; Cx ; Cy M/m
877 // vt300: ^[[ 24(1/3/5)~ [ Cx , Cy ] \r
878 // locator: CSI P e ; P b ; P r ; P c ; P p & w
879 function sendEvent(button
, pos
) {
880 // self.emit('mouse', {
886 if (self
.vt300Mouse
) {
888 // http://www.vt100.net/docs/vt3xx-gp/chapter15.html
892 var data
= C0
.ESC
+ '[24';
893 if (button
=== 0) data
+= '1';
894 else if (button
=== 1) data
+= '3';
895 else if (button
=== 2) data
+= '5';
896 else if (button
=== 3) return;
898 data
+= '~[' + pos
.x
+ ',' + pos
.y
+ ']\r';
903 if (self
.decLocator
) {
908 if (button
=== 0) button
= 2;
909 else if (button
=== 1) button
= 4;
910 else if (button
=== 2) button
= 6;
911 else if (button
=== 3) button
= 3;
912 self
.send(C0
.ESC
+ '['
915 + (button
=== 3 ? 4 : 0)
926 if (self
.urxvtMouse
) {
931 self
.send(C0
.ESC
+ '[' + button
+ ';' + pos
.x
+ ';' + pos
.y
+ 'M');
938 self
.send(C0
.ESC
+ '[<'
939 + (((button
& 3) === 3 ? button
& ~3 : button
) - 32)
944 + ((button
& 3) === 3 ? 'm' : 'M'));
950 encode(data
, button
);
954 self
.send(C0
.ESC
+ '[M' + String
.fromCharCode
.apply(String
, data
));
957 function getButton(ev
) {
970 // 1, and 2 - with 64 added
971 switch (ev
.overrideType
|| ev
.type
) {
973 button
= ev
.button
!= null
979 if (self
.browser
.isMSIE
) {
980 button
= button
=== 1 ? 0 : button
=== 4 ? 1 : button
;
986 case 'DOMMouseScroll':
987 button
= ev
.detail
< 0
992 button
= ev
.wheelDeltaY
> 0
998 // next three bits are the modifiers:
999 // 4 = shift, 8 = meta, 16 = control
1000 shift
= ev
.shiftKey
? 4 : 0;
1001 meta
= ev
.metaKey
? 8 : 0;
1002 ctrl
= ev
.ctrlKey
? 16 : 0;
1003 mod
= shift
| meta
| ctrl
;
1006 if (self
.vt200Mouse
) {
1009 } else if (!self
.normalMouse
) {
1014 button
= (32 + (mod
<< 2)) + button
;
1019 on(el
, 'mousedown', function(ev
) {
1021 // Prevent the focus on the textarea from getting lost
1022 // and make sure we get focused on mousedown
1023 ev
.preventDefault();
1026 if (!self
.mouseEvents
) return;
1032 //if (self.vt200Mouse && !self.normalMouse) {
1033 if (self
.vt200Mouse
) {
1034 ev
.overrideType
= 'mouseup';
1036 return self
.cancel(ev
);
1040 if (self
.normalMouse
) on(self
.document
, 'mousemove', sendMove
);
1042 // x10 compatibility mode can't send button releases
1043 if (!self
.x10Mouse
) {
1044 on(self
.document
, 'mouseup', function up(ev
) {
1046 if (self
.normalMouse
) off(self
.document
, 'mousemove', sendMove
);
1047 off(self
.document
, 'mouseup', up
);
1048 return self
.cancel(ev
);
1052 return self
.cancel(ev
);
1055 //if (self.normalMouse) {
1056 // on(self.document, 'mousemove', sendMove);
1059 on(el
, 'wheel', function(ev
) {
1060 if (!self
.mouseEvents
) return;
1063 || self
.decLocator
) return;
1065 return self
.cancel(ev
);
1068 // allow wheel scrolling in
1069 // the shell for example
1070 on(el
, 'wheel', function(ev
) {
1071 if (self
.mouseEvents
) return;
1072 self
.viewport
.onWheel(ev
);
1073 return self
.cancel(ev
);
1076 on(el
, 'touchstart', function(ev
) {
1077 if (self
.mouseEvents
) return;
1078 self
.viewport
.onTouchStart(ev
);
1079 return self
.cancel(ev
);
1082 on(el
, 'touchmove', function(ev
) {
1083 if (self
.mouseEvents
) return;
1084 self
.viewport
.onTouchMove(ev
);
1085 return self
.cancel(ev
);
1090 * Destroys the terminal.
1092 Terminal
.prototype.destroy = function() {
1093 this.readable
= false;
1094 this.writable
= false;
1096 this.handler = function() {};
1097 this.write = function() {};
1098 if (this.element
&& this.element
.parentNode
) {
1099 this.element
.parentNode
.removeChild(this.element
);
1101 //this.emit('close');
1105 * Tells the renderer to refresh terminal content between two rows (inclusive) at the next
1107 * @param {number} start The row to start from (between 0 and this.rows - 1).
1108 * @param {number} end The row to end at (between start and this.rows - 1).
1110 Terminal
.prototype.refresh = function(start
, end
) {
1111 if (this.renderer
) {
1112 this.renderer
.queueRefresh(start
, end
);
1117 * Queues linkification for the specified rows.
1118 * @param {number} start The row to start from (between 0 and this.rows - 1).
1119 * @param {number} end The row to end at (between start and this.rows - 1).
1121 Terminal
.prototype.queueLinkification = function(start
, end
) {
1122 if (this.linkifier
) {
1123 for (let i
= start
; i
<= end
; i
++) {
1124 this.linkifier
.linkifyRow(i
);
1130 * Display the cursor element
1132 Terminal
.prototype.showCursor = function() {
1133 if (!this.cursorState
) {
1134 this.cursorState
= 1;
1135 this.refresh(this.buffer
.y
, this.buffer
.y
);
1140 * Scroll the terminal down 1 row, creating a blank line.
1141 * @param {boolean} isWrapped Whether the new line is wrapped from the previous
1144 Terminal
.prototype.scroll = function(isWrapped
) {
1147 // Make room for the new row in lines
1148 if (this.buffer
.lines
.length
=== this.buffer
.lines
.maxLength
) {
1149 this.buffer
.lines
.trimStart(1);
1150 this.buffer
.ybase
--;
1151 if (this.buffer
.ydisp
!== 0) {
1152 this.buffer
.ydisp
--;
1156 this.buffer
.ybase
++;
1158 // TODO: Why is this done twice?
1159 if (!this.userScrolling
) {
1160 this.buffer
.ydisp
= this.buffer
.ybase
;
1164 row
= this.buffer
.ybase
+ this.rows
- 1;
1166 // subtract the bottom scroll region
1167 row
-= this.rows
- 1 - this.buffer
.scrollBottom
;
1169 if (row
=== this.buffer
.lines
.length
) {
1170 // Optimization: pushing is faster than splicing when they amount to the same behavior
1171 this.buffer
.lines
.push(this.blankLine(undefined, isWrapped
));
1174 this.buffer
.lines
.splice(row
, 0, this.blankLine(undefined, isWrapped
));
1177 if (this.buffer
.scrollTop
!== 0) {
1178 if (this.buffer
.ybase
!== 0) {
1179 this.buffer
.ybase
--;
1180 if (!this.userScrolling
) {
1181 this.buffer
.ydisp
= this.buffer
.ybase
;
1184 this.buffer
.lines
.splice(this.buffer
.ybase
+ this.buffer
.scrollTop
, 1);
1188 this.updateRange(this.buffer
.scrollTop
);
1189 this.updateRange(this.buffer
.scrollBottom
);
1192 * This event is emitted whenever the terminal is scrolled.
1193 * The one parameter passed is the new y display position.
1197 this.emit('scroll', this.buffer
.ydisp
);
1201 * Scroll the display of the terminal
1202 * @param {number} disp The number of lines to scroll down (negatives scroll up).
1203 * @param {boolean} suppressScrollEvent Don't emit the scroll event as scrollDisp. This is used
1204 * to avoid unwanted events being handled by the veiwport when the event was triggered from the
1205 * viewport originally.
1207 Terminal
.prototype.scrollDisp = function(disp
, suppressScrollEvent
) {
1209 if (this.buffer
.ydisp
=== 0) {
1212 this.userScrolling
= true;
1213 } else if (disp
+ this.buffer
.ydisp
>= this.buffer
.ybase
) {
1214 this.userScrolling
= false;
1217 const oldYdisp
= this.buffer
.ydisp
;
1218 this.buffer
.ydisp
= Math
.max(Math
.min(this.buffer
.ydisp
+ disp
, this.buffer
.ybase
), 0);
1220 // No change occurred, don't trigger scroll/refresh
1221 if (oldYdisp
=== this.buffer
.ydisp
) {
1225 if (!suppressScrollEvent
) {
1226 this.emit('scroll', this.buffer
.ydisp
);
1229 this.refresh(0, this.rows
- 1);
1233 * Scroll the display of the terminal by a number of pages.
1234 * @param {number} pageCount The number of pages to scroll (negative scrolls up).
1236 Terminal
.prototype.scrollPages = function(pageCount
) {
1237 this.scrollDisp(pageCount
* (this.rows
- 1));
1241 * Scrolls the display of the terminal to the top.
1243 Terminal
.prototype.scrollToTop = function() {
1244 this.scrollDisp(-this.buffer
.ydisp
);
1248 * Scrolls the display of the terminal to the bottom.
1250 Terminal
.prototype.scrollToBottom = function() {
1251 this.scrollDisp(this.buffer
.ybase
- this.buffer
.ydisp
);
1255 * Writes text to the terminal.
1256 * @param {string} data The text to write to the terminal.
1258 Terminal
.prototype.write = function(data
) {
1259 this.writeBuffer
.push(data
);
1261 // Send XOFF to pause the pty process if the write buffer becomes too large so
1262 // xterm.js can catch up before more data is sent. This is necessary in order
1263 // to keep signals such as ^C responsive.
1264 if (this.options
.useFlowControl
&& !this.xoffSentToCatchUp
&& this.writeBuffer
.length
>= WRITE_BUFFER_PAUSE_THRESHOLD
) {
1265 // XOFF - stop pty pipe
1266 // XON will be triggered by emulator before processing data chunk
1268 this.xoffSentToCatchUp
= true;
1271 if (!this.writeInProgress
&& this.writeBuffer
.length
> 0) {
1272 // Kick off a write which will write all data in sequence recursively
1273 this.writeInProgress
= true;
1274 // Kick off an async innerWrite so more writes can come in while processing data
1276 setTimeout(function () {
1282 Terminal
.prototype.innerWrite = function() {
1283 var writeBatch
= this.writeBuffer
.splice(0, WRITE_BATCH_SIZE
);
1284 while (writeBatch
.length
> 0) {
1285 var data
= writeBatch
.shift();
1286 var l
= data
.length
, i
= 0, j
, cs
, ch
, code
, low
, ch_width
, row
;
1288 // If XOFF was sent in order to catch up with the pty process, resume it if
1289 // the writeBuffer is empty to allow more data to come in.
1290 if (this.xoffSentToCatchUp
&& writeBatch
.length
=== 0 && this.writeBuffer
.length
=== 0) {
1292 this.xoffSentToCatchUp
= false;
1295 this.refreshStart
= this.buffer
.y
;
1296 this.refreshEnd
= this.buffer
.y
;
1298 // HACK: Set the parser state based on it's state at the time of return.
1299 // This works around the bug #662 which saw the parser state reset in the
1300 // middle of parsing escape sequence in two chunks. For some reason the
1301 // state of the parser resets to 0 after exiting parser.parse. This change
1302 // just sets the state back based on the correct return statement.
1303 var state
= this.parser
.parse(data
);
1304 this.parser
.setState(state
);
1306 this.updateRange(this.buffer
.y
);
1307 this.refresh(this.refreshStart
, this.refreshEnd
);
1309 if (this.writeBuffer
.length
> 0) {
1310 // Allow renderer to catch up before processing the next batch
1312 setTimeout(function () {
1316 this.writeInProgress
= false;
1321 * Writes text to the terminal, followed by a break line character (\n).
1322 * @param {string} data The text to write to the terminal.
1324 Terminal
.prototype.writeln = function(data
) {
1325 this.write(data
+ '\r\n');
1329 * DEPRECATED: only for backward compatibility. Please use attachCustomKeyEventHandler() instead.
1330 * @param {function} customKeydownHandler The custom KeyboardEvent handler to attach. This is a
1331 * function that takes a KeyboardEvent, allowing consumers to stop propogation and/or prevent
1332 * the default action. The function returns whether the event should be processed by xterm.js.
1334 Terminal
.prototype.attachCustomKeydownHandler = function(customKeydownHandler
) {
1335 let message
= 'attachCustomKeydownHandler() is DEPRECATED and will be removed soon. Please use attachCustomKeyEventHandler() instead.';
1336 console
.warn(message
);
1337 this.attachCustomKeyEventHandler(customKeydownHandler
);
1341 * Attaches a custom key event handler which is run before keys are processed, giving consumers of
1342 * xterm.js ultimate control as to what keys should be processed by the terminal and what keys
1344 * @param {function} customKeyEventHandler The custom KeyboardEvent handler to attach. This is a
1345 * function that takes a KeyboardEvent, allowing consumers to stop propogation and/or prevent
1346 * the default action. The function returns whether the event should be processed by xterm.js.
1348 Terminal
.prototype.attachCustomKeyEventHandler = function(customKeyEventHandler
) {
1349 this.customKeyEventHandler
= customKeyEventHandler
;
1353 * Attaches a http(s) link handler, forcing web links to behave differently to
1354 * regular <a> tags. This will trigger a refresh as links potentially need to be
1355 * reconstructed. Calling this with null will remove the handler.
1356 * @param {LinkMatcherHandler} handler The handler callback function.
1358 Terminal
.prototype.setHypertextLinkHandler = function(handler
) {
1359 if (!this.linkifier
) {
1360 throw new Error('Cannot attach a hypertext link handler before Terminal.open is called');
1362 this.linkifier
.setHypertextLinkHandler(handler
);
1363 // Refresh to force links to refresh
1364 this.refresh(0, this.rows
- 1);
1368 * Attaches a validation callback for hypertext links. This is useful to use
1369 * validation logic or to do something with the link's element and url.
1370 * @param {LinkMatcherValidationCallback} callback The callback to use, this can
1371 * be cleared with null.
1373 Terminal
.prototype.setHypertextValidationCallback = function(callback
) {
1374 if (!this.linkifier
) {
1375 throw new Error('Cannot attach a hypertext validation callback before Terminal.open is called');
1377 this.linkifier
.setHypertextValidationCallback(callback
);
1378 // Refresh to force links to refresh
1379 this.refresh(0, this.rows
- 1);
1383 * Registers a link matcher, allowing custom link patterns to be matched and
1385 * @param {RegExp} regex The regular expression to search for, specifically
1386 * this searches the textContent of the rows. You will want to use \s to match
1387 * a space ' ' character for example.
1388 * @param {LinkMatcherHandler} handler The callback when the link is called.
1389 * @param {LinkMatcherOptions} [options] Options for the link matcher.
1390 * @return {number} The ID of the new matcher, this can be used to deregister.
1392 Terminal
.prototype.registerLinkMatcher = function(regex
, handler
, options
) {
1393 if (this.linkifier
) {
1394 var matcherId
= this.linkifier
.registerLinkMatcher(regex
, handler
, options
);
1395 this.refresh(0, this.rows
- 1);
1401 * Deregisters a link matcher if it has been registered.
1402 * @param {number} matcherId The link matcher's ID (returned after register)
1404 Terminal
.prototype.deregisterLinkMatcher = function(matcherId
) {
1405 if (this.linkifier
) {
1406 if (this.linkifier
.deregisterLinkMatcher(matcherId
)) {
1407 this.refresh(0, this.rows
- 1);
1413 * Gets whether the terminal has an active selection.
1415 Terminal
.prototype.hasSelection = function() {
1416 return this.selectionManager
? this.selectionManager
.hasSelection
: false;
1420 * Gets the terminal's current selection, this is useful for implementing copy
1421 * behavior outside of xterm.js.
1423 Terminal
.prototype.getSelection = function() {
1424 return this.selectionManager
? this.selectionManager
.selectionText
: '';
1428 * Clears the current terminal selection.
1430 Terminal
.prototype.clearSelection = function() {
1431 if (this.selectionManager
) {
1432 this.selectionManager
.clearSelection();
1437 * Selects all text within the terminal.
1439 Terminal
.prototype.selectAll = function() {
1440 if (this.selectionManager
) {
1441 this.selectionManager
.selectAll();
1446 * Handle a keydown event
1448 * - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent
1449 * @param {KeyboardEvent} ev The keydown event to be handled.
1451 Terminal
.prototype.keyDown = function(ev
) {
1452 if (this.customKeyEventHandler
&& this.customKeyEventHandler(ev
) === false) {
1456 this.restartCursorBlinking();
1458 if (!this.compositionHelper
.keydown
.bind(this.compositionHelper
)(ev
)) {
1459 if (this.buffer
.ybase
!== this.buffer
.ydisp
) {
1460 this.scrollToBottom();
1466 var result
= this.evaluateKeyEscapeSequence(ev
);
1468 if (result
.key
=== C0
.DC3
) { // XOFF
1469 this.writeStopped
= true;
1470 } else if (result
.key
=== C0
.DC1
) { // XON
1471 this.writeStopped
= false;
1474 if (result
.scrollDisp
) {
1475 this.scrollDisp(result
.scrollDisp
);
1476 return this.cancel(ev
, true);
1479 if (isThirdLevelShift(this, ev
)) {
1483 if (result
.cancel
) {
1484 // The event is canceled at the end already, is this necessary?
1485 this.cancel(ev
, true);
1492 this.emit('keydown', ev
);
1493 this.emit('key', result
.key
, ev
);
1495 this.handler(result
.key
);
1497 return this.cancel(ev
, true);
1501 * Returns an object that determines how a KeyboardEvent should be handled. The key of the
1502 * returned value is the new key code to pass to the PTY.
1504 * Reference: http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
1505 * @param {KeyboardEvent} ev The keyboard event to be translated to key escape sequence.
1507 Terminal
.prototype.evaluateKeyEscapeSequence = function(ev
) {
1509 // Whether to cancel event propogation (NOTE: this may not be needed since the event is
1510 // canceled at the end of keyDown
1512 // The new key even to emit
1514 // The number of characters to scroll, if this is defined it will cancel the event
1515 scrollDisp
: undefined
1517 var modifiers
= ev
.shiftKey
<< 0 | ev
.altKey
<< 1 | ev
.ctrlKey
<< 2 | ev
.metaKey
<< 3;
1518 switch (ev
.keyCode
) {
1522 result
.key
= C0
.BS
; // ^H
1525 result
.key
= C0
.DEL
; // ^?
1530 result
.key
= C0
.ESC
+ '[Z';
1534 result
.cancel
= true;
1539 result
.cancel
= true;
1543 result
.key
= C0
.ESC
;
1544 result
.cancel
= true;
1549 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'D';
1550 // HACK: Make Alt + left-arrow behave like Ctrl + left-arrow: move one word backwards
1551 // http://unix.stackexchange.com/a/108106
1552 // macOS uses different escape sequences than linux
1553 if (result
.key
== C0
.ESC
+ '[1;3D') {
1554 result
.key
= (this.browser
.isMac
) ? C0
.ESC
+ 'b' : C0
.ESC
+ '[1;5D';
1556 } else if (this.applicationCursor
) {
1557 result
.key
= C0
.ESC
+ 'OD';
1559 result
.key
= C0
.ESC
+ '[D';
1565 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'C';
1566 // HACK: Make Alt + right-arrow behave like Ctrl + right-arrow: move one word forward
1567 // http://unix.stackexchange.com/a/108106
1568 // macOS uses different escape sequences than linux
1569 if (result
.key
== C0
.ESC
+ '[1;3C') {
1570 result
.key
= (this.browser
.isMac
) ? C0
.ESC
+ 'f' : C0
.ESC
+ '[1;5C';
1572 } else if (this.applicationCursor
) {
1573 result
.key
= C0
.ESC
+ 'OC';
1575 result
.key
= C0
.ESC
+ '[C';
1581 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'A';
1582 // HACK: Make Alt + up-arrow behave like Ctrl + up-arrow
1583 // http://unix.stackexchange.com/a/108106
1584 if (result
.key
== C0
.ESC
+ '[1;3A') {
1585 result
.key
= C0
.ESC
+ '[1;5A';
1587 } else if (this.applicationCursor
) {
1588 result
.key
= C0
.ESC
+ 'OA';
1590 result
.key
= C0
.ESC
+ '[A';
1596 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'B';
1597 // HACK: Make Alt + down-arrow behave like Ctrl + down-arrow
1598 // http://unix.stackexchange.com/a/108106
1599 if (result
.key
== C0
.ESC
+ '[1;3B') {
1600 result
.key
= C0
.ESC
+ '[1;5B';
1602 } else if (this.applicationCursor
) {
1603 result
.key
= C0
.ESC
+ 'OB';
1605 result
.key
= C0
.ESC
+ '[B';
1610 if (!ev
.shiftKey
&& !ev
.ctrlKey
) {
1611 // <Ctrl> or <Shift> + <Insert> are used to
1612 // copy-paste on some systems.
1613 result
.key
= C0
.ESC
+ '[2~';
1619 result
.key
= C0
.ESC
+ '[3;' + (modifiers
+ 1) + '~';
1621 result
.key
= C0
.ESC
+ '[3~';
1627 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'H';
1628 else if (this.applicationCursor
)
1629 result
.key
= C0
.ESC
+ 'OH';
1631 result
.key
= C0
.ESC
+ '[H';
1636 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'F';
1637 else if (this.applicationCursor
)
1638 result
.key
= C0
.ESC
+ 'OF';
1640 result
.key
= C0
.ESC
+ '[F';
1645 result
.scrollDisp
= -(this.rows
- 1);
1647 result
.key
= C0
.ESC
+ '[5~';
1653 result
.scrollDisp
= this.rows
- 1;
1655 result
.key
= C0
.ESC
+ '[6~';
1661 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'P';
1663 result
.key
= C0
.ESC
+ 'OP';
1668 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'Q';
1670 result
.key
= C0
.ESC
+ 'OQ';
1675 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'R';
1677 result
.key
= C0
.ESC
+ 'OR';
1682 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'S';
1684 result
.key
= C0
.ESC
+ 'OS';
1689 result
.key
= C0
.ESC
+ '[15;' + (modifiers
+ 1) + '~';
1691 result
.key
= C0
.ESC
+ '[15~';
1696 result
.key
= C0
.ESC
+ '[17;' + (modifiers
+ 1) + '~';
1698 result
.key
= C0
.ESC
+ '[17~';
1703 result
.key
= C0
.ESC
+ '[18;' + (modifiers
+ 1) + '~';
1705 result
.key
= C0
.ESC
+ '[18~';
1710 result
.key
= C0
.ESC
+ '[19;' + (modifiers
+ 1) + '~';
1712 result
.key
= C0
.ESC
+ '[19~';
1717 result
.key
= C0
.ESC
+ '[20;' + (modifiers
+ 1) + '~';
1719 result
.key
= C0
.ESC
+ '[20~';
1724 result
.key
= C0
.ESC
+ '[21;' + (modifiers
+ 1) + '~';
1726 result
.key
= C0
.ESC
+ '[21~';
1731 result
.key
= C0
.ESC
+ '[23;' + (modifiers
+ 1) + '~';
1733 result
.key
= C0
.ESC
+ '[23~';
1738 result
.key
= C0
.ESC
+ '[24;' + (modifiers
+ 1) + '~';
1740 result
.key
= C0
.ESC
+ '[24~';
1745 if (ev
.ctrlKey
&& !ev
.shiftKey
&& !ev
.altKey
&& !ev
.metaKey
) {
1746 if (ev
.keyCode
>= 65 && ev
.keyCode
<= 90) {
1747 result
.key
= String
.fromCharCode(ev
.keyCode
- 64);
1748 } else if (ev
.keyCode
=== 32) {
1750 result
.key
= String
.fromCharCode(0);
1751 } else if (ev
.keyCode
>= 51 && ev
.keyCode
<= 55) {
1752 // escape, file sep, group sep, record sep, unit sep
1753 result
.key
= String
.fromCharCode(ev
.keyCode
- 51 + 27);
1754 } else if (ev
.keyCode
=== 56) {
1756 result
.key
= String
.fromCharCode(127);
1757 } else if (ev
.keyCode
=== 219) {
1758 // ^[ - Control Sequence Introducer (CSI)
1759 result
.key
= String
.fromCharCode(27);
1760 } else if (ev
.keyCode
=== 220) {
1761 // ^\ - String Terminator (ST)
1762 result
.key
= String
.fromCharCode(28);
1763 } else if (ev
.keyCode
=== 221) {
1764 // ^] - Operating System Command (OSC)
1765 result
.key
= String
.fromCharCode(29);
1767 } else if (!this.browser
.isMac
&& ev
.altKey
&& !ev
.ctrlKey
&& !ev
.metaKey
) {
1768 // On Mac this is a third level shift. Use <Esc> instead.
1769 if (ev
.keyCode
>= 65 && ev
.keyCode
<= 90) {
1770 result
.key
= C0
.ESC
+ String
.fromCharCode(ev
.keyCode
+ 32);
1771 } else if (ev
.keyCode
=== 192) {
1772 result
.key
= C0
.ESC
+ '`';
1773 } else if (ev
.keyCode
>= 48 && ev
.keyCode
<= 57) {
1774 result
.key
= C0
.ESC
+ (ev
.keyCode
- 48);
1776 } else if (this.browser
.isMac
&& !ev
.altKey
&& !ev
.ctrlKey
&& ev
.metaKey
) {
1777 if (ev
.keyCode
=== 65) { // cmd + a
1788 * Set the G level of the terminal
1791 Terminal
.prototype.setgLevel = function(g
) {
1793 this.charset
= this.charsets
[g
];
1797 * Set the charset for the given G level of the terminal
1801 Terminal
.prototype.setgCharset = function(g
, charset
) {
1802 this.charsets
[g
] = charset
;
1803 if (this.glevel
=== g
) {
1804 this.charset
= charset
;
1809 * Handle a keypress event.
1811 * - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent
1812 * @param {KeyboardEvent} ev The keypress event to be handled.
1814 Terminal
.prototype.keyPress = function(ev
) {
1817 if (this.customKeyEventHandler
&& this.customKeyEventHandler(ev
) === false) {
1825 } else if (ev
.which
== null) {
1827 } else if (ev
.which
!== 0 && ev
.charCode
!== 0) {
1834 (ev
.altKey
|| ev
.ctrlKey
|| ev
.metaKey
) && !isThirdLevelShift(this, ev
)
1839 key
= String
.fromCharCode(key
);
1841 this.emit('keypress', key
, ev
);
1842 this.emit('key', key
, ev
);
1850 * Send data for handling to the terminal
1851 * @param {string} data
1853 Terminal
.prototype.send = function(data
) {
1857 setTimeout(function() {
1858 self
.handler(self
.queue
);
1868 * Note: We could do sweet things with webaudio here
1870 Terminal
.prototype.bell = function() {
1871 if (!this.visualBell
) return;
1873 this.element
.style
.borderColor
= 'white';
1874 setTimeout(function() {
1875 self
.element
.style
.borderColor
= '';
1877 if (this.popOnBell
) this.focus();
1881 * Log the current state to the console.
1883 Terminal
.prototype.log = function() {
1884 if (!this.debug
) return;
1885 if (!this.context
.console
|| !this.context
.console
.log
) return;
1886 var args
= Array
.prototype.slice
.call(arguments
);
1887 this.context
.console
.log
.apply(this.context
.console
, args
);
1891 * Log the current state as error to the console.
1893 Terminal
.prototype.error = function() {
1894 if (!this.debug
) return;
1895 if (!this.context
.console
|| !this.context
.console
.error
) return;
1896 var args
= Array
.prototype.slice
.call(arguments
);
1897 this.context
.console
.error
.apply(this.context
.console
, args
);
1901 * Resizes the terminal.
1903 * @param {number} x The number of columns to resize to.
1904 * @param {number} y The number of rows to resize to.
1906 Terminal
.prototype.resize = function(x
, y
) {
1907 if (isNaN(x
) || isNaN(y
)) {
1911 if (y
> this.getOption('scrollback')) {
1912 this.setOption('scrollback', y
)
1922 if (x
=== this.cols
&& y
=== this.rows
) {
1923 // Check if we still need to measure the char size (fixes #785).
1924 if (!this.charMeasure
.width
|| !this.charMeasure
.height
) {
1925 this.charMeasure
.measure();
1936 ch
= [this.defAttr
, ' ', 1]; // does xterm use the default attr?
1937 i
= this.buffer
.lines
.length
;
1939 if (this.buffer
.lines
.get(i
) === undefined) {
1940 this.buffer
.lines
.set(i
, this.blankLine());
1942 while (this.buffer
.lines
.get(i
).length
< x
) {
1943 this.buffer
.lines
.get(i
).push(ch
);
1949 this.setupStops(this.cols
);
1957 // y is rows, not this.buffer.y
1958 if (this.buffer
.lines
.length
< y
+ this.buffer
.ybase
) {
1959 if (this.buffer
.ybase
> 0 && this.buffer
.lines
.length
<= this.buffer
.ybase
+ this.buffer
.y
+ addToY
+ 1) {
1960 // There is room above the buffer and there are no empty elements below the line,
1962 this.buffer
.ybase
--;
1964 if (this.buffer
.ydisp
> 0) {
1965 // Viewport is at the top of the buffer, must increase downwards
1966 this.buffer
.ydisp
--;
1969 // Add a blank line if there is no buffer left at the top to scroll to, or if there
1970 // are blank lines after the cursor
1971 this.buffer
.lines
.push(this.blankLine());
1974 if (this.children
.length
< y
) {
1980 if (this.buffer
.lines
.length
> y
+ this.buffer
.ybase
) {
1981 if (this.buffer
.lines
.length
> this.buffer
.ybase
+ this.buffer
.y
+ 1) {
1982 // The line is a blank line below the cursor, remove it
1983 this.buffer
.lines
.pop();
1985 // The line is the cursor, scroll down
1986 this.buffer
.ybase
++;
1987 this.buffer
.ydisp
++;
1990 if (this.children
.length
> y
) {
1991 el
= this.children
.shift();
1993 el
.parentNode
.removeChild(el
);
1999 // Make sure that the cursor stays on screen
2000 if (this.buffer
.y
>= y
) {
2001 this.buffer
.y
= y
- 1;
2004 this.buffer
.y
+= addToY
;
2007 if (this.buffer
.x
>= x
) {
2008 this.buffer
.x
= x
- 1;
2011 this.buffer
.scrollTop
= 0;
2012 this.buffer
.scrollBottom
= y
- 1;
2014 this.charMeasure
.measure();
2016 this.refresh(0, this.rows
- 1);
2018 this.geometry
= [this.cols
, this.rows
];
2019 this.emit('resize', {terminal
: this, cols
: x
, rows
: y
});
2023 * Updates the range of rows to refresh
2024 * @param {number} y The number of rows to refresh next.
2026 Terminal
.prototype.updateRange = function(y
) {
2027 if (y
< this.refreshStart
) this.refreshStart
= y
;
2028 if (y
> this.refreshEnd
) this.refreshEnd
= y
;
2029 // if (y > this.refreshEnd) {
2030 // this.refreshEnd = y;
2031 // if (y > this.rows - 1) {
2032 // this.refreshEnd = this.rows - 1;
2038 * Set the range of refreshing to the maximum value
2040 Terminal
.prototype.maxRange = function() {
2041 this.refreshStart
= 0;
2042 this.refreshEnd
= this.rows
- 1;
2048 * Setup the tab stops.
2051 Terminal
.prototype.setupStops = function(i
) {
2053 if (!this.buffer
.tabs
[i
]) {
2054 i
= this.prevStop(i
);
2057 this.buffer
.tabs
= {};
2061 for (; i
< this.cols
; i
+= this.getOption('tabStopWidth')) {
2062 this.buffer
.tabs
[i
] = true;
2068 * Move the cursor to the previous tab stop from the given position (default is current).
2069 * @param {number} x The position to move the cursor to the previous tab stop.
2071 Terminal
.prototype.prevStop = function(x
) {
2072 if (x
== null) x
= this.buffer
.x
;
2073 while (!this.buffer
.tabs
[--x
] && x
> 0);
2074 return x
>= this.cols
2081 * Move the cursor one tab stop forward from the given position (default is current).
2082 * @param {number} x The position to move the cursor one tab stop forward.
2084 Terminal
.prototype.nextStop = function(x
) {
2085 if (x
== null) x
= this.buffer
.x
;
2086 while (!this.buffer
.tabs
[++x
] && x
< this.cols
);
2087 return x
>= this.cols
2094 * Erase in the identified line everything from "x" to the end of the line (right).
2095 * @param {number} x The column from which to start erasing to the end of the line.
2096 * @param {number} y The line in which to operate.
2098 Terminal
.prototype.eraseRight = function(x
, y
) {
2099 var line
= this.buffer
.lines
.get(this.buffer
.ybase
+ y
);
2103 var ch
= [this.eraseAttr(), ' ', 1]; // xterm
2104 for (; x
< this.cols
; x
++) {
2107 this.updateRange(y
);
2113 * Erase in the identified line everything from "x" to the start of the line (left).
2114 * @param {number} x The column from which to start erasing to the start of the line.
2115 * @param {number} y The line in which to operate.
2117 Terminal
.prototype.eraseLeft = function(x
, y
) {
2118 var line
= this.buffer
.lines
.get(this.buffer
.ybase
+ y
);
2122 var ch
= [this.eraseAttr(), ' ', 1]; // xterm
2127 this.updateRange(y
);
2131 * Clears the entire buffer, making the prompt line the new first line.
2133 Terminal
.prototype.clear = function() {
2134 if (this.buffer
.ybase
=== 0 && this.buffer
.y
=== 0) {
2135 // Don't clear if it's already clear
2138 this.buffer
.lines
.set(0, this.buffer
.lines
.get(this.buffer
.ybase
+ this.buffer
.y
));
2139 this.buffer
.lines
.length
= 1;
2140 this.buffer
.ydisp
= 0;
2141 this.buffer
.ybase
= 0;
2143 for (var i
= 1; i
< this.rows
; i
++) {
2144 this.buffer
.lines
.push(this.blankLine());
2146 this.refresh(0, this.rows
- 1);
2147 this.emit('scroll', this.buffer
.ydisp
);
2151 * Erase all content in the given line
2152 * @param {number} y The line to erase all of its contents.
2154 Terminal
.prototype.eraseLine = function(y
) {
2155 this.eraseRight(0, y
);
2160 * Return the data array of a blank line
2161 * @param {number} cur First bunch of data for each "blank" character.
2162 * @param {boolean} isWrapped Whether the new line is wrapped from the previous line.
2164 Terminal
.prototype.blankLine = function(cur
, isWrapped
) {
2169 var ch
= [attr
, ' ', 1] // width defaults to 1 halfwidth character
2173 // TODO: It is not ideal that this is a property on an array, a buffer line
2174 // class should be added that will hold this data and other useful functions.
2176 line
.isWrapped
= isWrapped
;
2179 for (; i
< this.cols
; i
++) {
2188 * If cur return the back color xterm feature attribute. Else return defAttr.
2189 * @param {object} cur
2191 Terminal
.prototype.ch = function(cur
) {
2193 ? [this.eraseAttr(), ' ', 1]
2194 : [this.defAttr
, ' ', 1];
2199 * Evaluate if the current terminal is the given argument.
2200 * @param {object} term The terminal to evaluate
2202 Terminal
.prototype.is = function(term
) {
2203 var name
= this.termName
;
2204 return (name
+ '').indexOf(term
) === 0;
2209 * Emit the 'data' event and populate the given data.
2210 * @param {string} data The data to populate in the event.
2212 Terminal
.prototype.handler = function(data
) {
2213 // Prevents all events to pty process if stdin is disabled
2214 if (this.options
.disableStdin
) {
2218 // Clear the selection if the selection manager is available and has an active selection
2219 if (this.selectionManager
&& this.selectionManager
.hasSelection
) {
2220 this.selectionManager
.clearSelection();
2223 // Input is being sent to the terminal, the terminal should focus the prompt.
2224 if (this.buffer
.ybase
!== this.buffer
.ydisp
) {
2225 this.scrollToBottom();
2227 this.emit('data', data
);
2232 * Emit the 'title' event and populate the given title.
2233 * @param {string} title The title to populate in the event.
2235 Terminal
.prototype.handleTitle = function(title
) {
2237 * This event is emitted when the title of the terminal is changed
2238 * from inside the terminal. The parameter is the new title.
2242 this.emit('title', title
);
2251 * ESC D Index (IND is 0x84).
2253 Terminal
.prototype.index = function() {
2255 if (this.buffer
.y
> this.buffer
.scrollBottom
) {
2259 // If the end of the line is hit, prevent this action from wrapping around to the next line.
2260 if (this.buffer
.x
>= this.cols
) {
2267 * ESC M Reverse Index (RI is 0x8d).
2269 * Move the cursor up one row, inserting a new blank line if necessary.
2271 Terminal
.prototype.reverseIndex = function() {
2273 if (this.buffer
.y
=== this.buffer
.scrollTop
) {
2274 // possibly move the code below to term.reverseScroll();
2275 // test: echo -ne '\e[1;1H\e[44m\eM\e[0m'
2276 // blankLine(true) is xterm/linux behavior
2277 this.buffer
.lines
.shiftElements(this.buffer
.y
+ this.buffer
.ybase
, this.rows
- 1, 1);
2278 this.buffer
.lines
.set(this.buffer
.y
+ this.buffer
.ybase
, this.blankLine(true));
2279 this.updateRange(this.buffer
.scrollTop
);
2280 this.updateRange(this.buffer
.scrollBottom
);
2288 * ESC c Full Reset (RIS).
2290 Terminal
.prototype.reset = function() {
2291 this.options
.rows
= this.rows
;
2292 this.options
.cols
= this.cols
;
2293 var customKeyEventHandler
= this.customKeyEventHandler
;
2294 var cursorBlinkInterval
= this.cursorBlinkInterval
;
2295 var inputHandler
= this.inputHandler
;
2296 var buffers
= this.buffers
;
2297 Terminal
.call(this, this.options
);
2298 this.customKeyEventHandler
= customKeyEventHandler
;
2299 this.cursorBlinkInterval
= cursorBlinkInterval
;
2300 this.inputHandler
= inputHandler
;
2301 this.buffers
= buffers
;
2302 this.refresh(0, this.rows
- 1);
2303 this.viewport
.syncScrollArea();
2308 * ESC H Tab Set (HTS is 0x88).
2310 Terminal
.prototype.tabSet = function() {
2311 this.buffer
.tabs
[this.buffer
.x
] = true;
2318 function on(el
, type
, handler
, capture
) {
2319 if (!Array
.isArray(el
)) {
2322 el
.forEach(function (element
) {
2323 element
.addEventListener(type
, handler
, capture
|| false);
2327 function off(el
, type
, handler
, capture
) {
2328 el
.removeEventListener(type
, handler
, capture
|| false);
2331 function cancel(ev
, force
) {
2332 if (!this.cancelEvents
&& !force
) {
2335 ev
.preventDefault();
2336 ev
.stopPropagation();
2340 function inherits(child
, parent
) {
2342 this.constructor = child
;
2344 f
.prototype = parent
.prototype;
2345 child
.prototype = new f
;
2348 function indexOf(obj
, el
) {
2351 if (obj
[i
] === el
) return i
;
2356 function isThirdLevelShift(term
, ev
) {
2358 (term
.browser
.isMac
&& ev
.altKey
&& !ev
.ctrlKey
&& !ev
.metaKey
) ||
2359 (term
.browser
.isMSWindows
&& ev
.altKey
&& ev
.ctrlKey
&& !ev
.metaKey
);
2361 if (ev
.type
== 'keypress') {
2362 return thirdLevelKey
;
2365 // Don't invoke for arrows, pageDown, home, backspace, etc. (on non-keypress events)
2366 return thirdLevelKey
&& (!ev
.keyCode
|| ev
.keyCode
> 47);
2369 // Expose to InputHandler (temporary)
2370 Terminal
.prototype.matchColor
= matchColor
;
2372 function matchColor(r1
, g1
, b1
) {
2373 var hash
= (r1
<< 16) | (g1
<< 8) | b1
;
2375 if (matchColor
._cache
[hash
] != null) {
2376 return matchColor
._cache
[hash
];
2379 var ldiff
= Infinity
2388 for (; i
< Terminal
.vcolors
.length
; i
++) {
2389 c
= Terminal
.vcolors
[i
];
2394 diff
= matchColor
.distance(r1
, g1
, b1
, r2
, g2
, b2
);
2407 return matchColor
._cache
[hash
] = li
;
2410 matchColor
._cache
= {};
2412 // http://stackoverflow.com/questions/1633828
2413 matchColor
.distance = function(r1
, g1
, b1
, r2
, g2
, b2
) {
2414 return Math
.pow(30 * (r1
- r2
), 2)
2415 + Math
.pow(59 * (g1
- g2
), 2)
2416 + Math
.pow(11 * (b1
- b2
), 2);
2419 function each(obj
, iter
, con
) {
2420 if (obj
.forEach
) return obj
.forEach(iter
, con
);
2421 for (var i
= 0; i
< obj
.length
; i
++) {
2422 iter
.call(con
, obj
[i
], i
, obj
);
2426 function wasMondifierKeyOnlyEvent(ev
) {
2427 return ev
.keyCode
=== 16 || // Shift
2428 ev
.keyCode
=== 17 || // Ctrl
2429 ev
.keyCode
=== 18; // Alt
2432 function keys(obj
) {
2433 if (Object
.keys
) return Object
.keys(obj
);
2436 if (Object
.prototype.hasOwnProperty
.call(obj
, key
)) {
2447 Terminal
.translateBufferLineToString
= translateBufferLineToString
;
2448 Terminal
.EventEmitter
= EventEmitter
;
2449 Terminal
.inherits
= inherits
;
2452 * Adds an event listener to the terminal.
2454 * @param {string} event The name of the event. TODO: Document all event types
2455 * @param {function} callback The function to call when the event is triggered.
2459 Terminal
.cancel
= cancel
;
2461 module
.exports
= Terminal
;