2 * xterm.js: xterm, in the browser
3 * Originally forked from (with the author's permission):
4 * Fabrice Bellard's javascript vt100 for jslinux:
5 * http://bellard.org/jslinux/
6 * Copyright (c) 2011 Fabrice Bellard
7 * The original design remains. The terminal itself
8 * has been extended to include xterm CSI codes, among
13 import { CompositionHelper
} from './CompositionHelper';
14 import { EventEmitter
} from './EventEmitter';
15 import { Viewport
} from './Viewport';
16 import { rightClickHandler
, pasteHandler
, copyHandler
} from './handlers/Clipboard';
17 import { CircularList
} from './utils/CircularList';
18 import { C0
} from './EscapeSequences';
19 import { CharMeasure
} from './utils/CharMeasure';
20 import * as Browser
from './utils/Browser';
21 import * as Keyboard
from './utils/Keyboard';
24 * Terminal Emulation References:
26 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.txt
27 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
28 * http://invisible-island.net/vttest/
29 * http://www.inwap.com/pdp10/ansicode.txt
30 * http://linux.die.net/man/4/console_codes
31 * http://linux.die.net/man/7/urxvt
34 // Let it work inside Node.js for automated testing purposes.
35 var document
= (typeof window
!= 'undefined') ? window
.document
: null;
40 var normal
= 0, escaped
= 1, csi
= 2, osc
= 3, charset
= 4, dcs
= 5, ignore
= 6;
43 * The amount of write requests to queue before sending an XOFF signal to the
44 * pty process. This number must be small in order for ^C and similar sequences
47 var WRITE_BUFFER_PAUSE_THRESHOLD
= 5;
50 * The number of writes to perform in a single batch before allowing the
51 * renderer to catch up with a 0ms setTimeout.
53 var WRITE_BATCH_SIZE
= 300;
56 * The maximum number of refresh frames to skip when the write buffer is non-
57 * empty. Note that these frames may be intermingled with frames that are
58 * skipped via requestAnimationFrame's mechanism.
60 var MAX_REFRESH_FRAME_SKIP
= 5;
67 * Creates a new `Terminal` object.
69 * @param {object} options An object containing a set of options, the available options are:
70 * - `cursorBlink` (boolean): Whether the terminal cursor blinks
71 * - `cols` (number): The number of columns of the terminal (horizontal size)
72 * - `rows` (number): The number of rows of the terminal (vertical size)
76 * @alias module:xterm/src/xterm
78 function Terminal(options
) {
81 if (!(this instanceof Terminal
)) {
82 return new Terminal(arguments
[0], arguments
[1], arguments
[2]);
85 self
.browser
= Browser
;
86 self
.cancel
= Terminal
.cancel
;
88 EventEmitter
.call(this);
90 if (typeof options
=== 'number') {
98 options
= options
|| {};
101 Object
.keys(Terminal
.defaults
).forEach(function(key
) {
102 if (options
[key
] == null) {
103 options
[key
] = Terminal
.options
[key
];
105 if (Terminal
[key
] !== Terminal
.defaults
[key
]) {
106 options
[key
] = Terminal
[key
];
109 self
[key
] = options
[key
];
112 if (options
.colors
.length
=== 8) {
113 options
.colors
= options
.colors
.concat(Terminal
._colors
.slice(8));
114 } else if (options
.colors
.length
=== 16) {
115 options
.colors
= options
.colors
.concat(Terminal
._colors
.slice(16));
116 } else if (options
.colors
.length
=== 10) {
117 options
.colors
= options
.colors
.slice(0, -2).concat(
118 Terminal
._colors
.slice(8, -2), options
.colors
.slice(-2));
119 } else if (options
.colors
.length
=== 18) {
120 options
.colors
= options
.colors
.concat(
121 Terminal
._colors
.slice(16, -2), options
.colors
.slice(-2));
123 this.colors
= options
.colors
;
125 this.options
= options
;
127 // this.context = options.context || window;
128 // this.document = options.document || document;
129 this.parent
= options
.body
|| options
.parent
|| (
130 document
? document
.getElementsByTagName('body')[0] : null
133 this.cols
= options
.cols
|| options
.geometry
[0];
134 this.rows
= options
.rows
|| options
.geometry
[1];
135 this.geometry
= [this.cols
, this.rows
];
137 if (options
.handler
) {
138 this.on('data', options
.handler
);
142 * The scroll position of the y cursor, ie. ybase + y = the y position within the entire
148 * The scroll position of the viewport
153 * The cursor's x position after ybase
158 * The cursor's y position after ybase
162 /** A queue of the rows to be refreshed */
163 this.refreshRowsQueue
= [];
165 this.cursorState
= 0;
166 this.cursorHidden
= false;
171 this.scrollBottom
= this.rows
- 1;
172 this.customKeydownHandler
= null;
175 this.applicationKeypad
= false;
176 this.applicationCursor
= false;
177 this.originMode
= false;
178 this.insertMode
= false;
179 this.wraparoundMode
= true; // defaults: xterm - true, vt100 - false
184 this.gcharset
= null;
186 this.charsets
= [null];
210 this.readable
= true;
211 this.writable
= true;
213 this.defAttr
= (0 << 18) | (257 << 9) | (256 << 0);
214 this.curAttr
= this.defAttr
;
217 this.currentParam
= 0;
222 this.writeBuffer
= [];
223 this.writeInProgress
= false;
224 this.refreshFramesSkipped
= 0;
227 * Whether _xterm.js_ sent XOFF in order to catch up with the pty process.
228 * This is a distinct state from writeStopped so that if the user requested
229 * XOFF via ^S that it will not automatically resume when the writeBuffer goes
232 this.xoffSentToCatchUp
= false;
234 /** Whether writing has been stopped as a result of XOFF */
235 this.writeStopped
= false;
237 // leftover surrogate high from previous write invocation
238 this.surrogate_high
= '';
241 * An array of all lines in the entire buffer, including the prompt. The lines are array of
242 * characters which are 2-length arrays where [0] is an attribute and [1] is the character.
244 this.lines
= new CircularList(this.scrollback
);
247 this.lines
.push(this.blankLine());
253 // Store if user went browsing history in scrollback
254 this.userScrolling
= false;
257 inherits(Terminal
, EventEmitter
);
260 * back_color_erase feature for xterm.
262 Terminal
.prototype.eraseAttr = function() {
263 // if (this.is('screen')) return this.defAttr;
264 return (this.defAttr
& ~0x1ff) | (this.curAttr
& 0x1ff);
272 Terminal
.tangoColors
= [
293 // Colors 0-15 + 16-255
294 // Much thanks to TooTallNate for writing this.
295 Terminal
.colors
= (function() {
296 var colors
= Terminal
.tangoColors
.slice()
297 , r
= [0x00, 0x5f, 0x87, 0xaf, 0xd7, 0xff]
302 for (; i
< 216; i
++) {
303 out(r
[(i
/ 36) % 6 | 0], r
[(i
/ 6) % 6 | 0], r
[i
% 6]);
308 for (; i
< 24; i
++) {
313 function out(r
, g
, b
) {
314 colors
.push('#' + hex(r
) + hex(g
) + hex(b
));
319 return c
.length
< 2 ? '0' + c
: c
;
325 Terminal
._colors
= Terminal
.colors
.slice();
327 Terminal
.vcolors
= (function() {
329 , colors
= Terminal
.colors
333 for (; i
< 256; i
++) {
334 color
= parseInt(colors
[i
].substring(1), 16);
336 (color
>> 16) & 0xff,
349 Terminal
.defaults
= {
350 colors
: Terminal
.colors
,
363 // programFeatures: false,
367 Terminal
.options
= {};
369 Terminal
.focus
= null;
371 each(keys(Terminal
.defaults
), function(key
) {
372 Terminal
[key
] = Terminal
.defaults
[key
];
373 Terminal
.options
[key
] = Terminal
.defaults
[key
];
377 * Focus the terminal. Delegates focus handling to the terminal's DOM element.
379 Terminal
.prototype.focus = function() {
380 return this.textarea
.focus();
384 * Retrieves an option's value from the terminal.
385 * @param {string} key The option key.
387 Terminal
.prototype.getOption = function(key
, value
) {
388 if (!(key
in Terminal
.defaults
)) {
389 throw new Error('No option with key "' + key
+ '"');
392 if (typeof this.options
[key
] !== 'undefined') {
393 return this.options
[key
];
400 * Sets an option on the terminal.
401 * @param {string} key The option key.
402 * @param {string} value The option value.
404 Terminal
.prototype.setOption = function(key
, value
) {
405 if (!(key
in Terminal
.defaults
)) {
406 throw new Error('No option with key "' + key
+ '"');
410 if (this.options
[key
] !== value
) {
411 if (this.lines
.length
> value
) {
412 const amountToTrim
= this.lines
.length
- value
;
413 const needsRefresh
= (this.ydisp
- amountToTrim
< 0);
414 this.lines
.trimStart(amountToTrim
);
415 this.ybase
= Math
.max(this.ybase
- amountToTrim
, 0);
416 this.ydisp
= Math
.max(this.ydisp
- amountToTrim
, 0);
418 this.refresh(0, this.rows
- 1);
421 this.lines
.maxLength
= value
;
422 this.viewport
.syncScrollArea();
427 this.options
[key
] = value
;
431 * Binds the desired focus behavior on a given terminal object.
435 Terminal
.bindFocus = function (term
) {
436 on(term
.textarea
, 'focus', function (ev
) {
437 if (term
.sendFocus
) {
438 term
.send(C0
.ESC
+ '[I');
440 term
.element
.classList
.add('focus');
442 Terminal
.focus
= term
;
443 term
.emit('focus', {terminal
: term
});
448 * Blur the terminal. Delegates blur handling to the terminal's DOM element.
450 Terminal
.prototype.blur = function() {
451 return this.textarea
.blur();
455 * Binds the desired blur behavior on a given terminal object.
459 Terminal
.bindBlur = function (term
) {
460 on(term
.textarea
, 'blur', function (ev
) {
461 term
.queueRefresh(term
.y
, term
.y
);
462 if (term
.sendFocus
) {
463 term
.send(C0
.ESC
+ '[O');
465 term
.element
.classList
.remove('focus');
466 Terminal
.focus
= null;
467 term
.emit('blur', {terminal
: term
});
472 * Initialize default behavior
474 Terminal
.prototype.initGlobal = function() {
477 Terminal
.bindKeys(this);
478 Terminal
.bindFocus(this);
479 Terminal
.bindBlur(this);
481 // Bind clipboard functionality
482 on(this.element
, 'copy', function (ev
) {
483 copyHandler
.call(this, ev
, term
);
485 on(this.textarea
, 'paste', function (ev
) {
486 pasteHandler
.call(this, ev
, term
);
488 on(this.element
, 'paste', function (ev
) {
489 pasteHandler
.call(this, ev
, term
);
492 function rightClickHandlerWrapper (ev
) {
493 rightClickHandler
.call(this, ev
, term
);
496 if (term
.browser
.isFirefox
) {
497 on(this.element
, 'mousedown', function (ev
) {
498 if (ev
.button
== 2) {
499 rightClickHandlerWrapper(ev
);
503 on(this.element
, 'contextmenu', rightClickHandlerWrapper
);
508 * Apply key handling to the terminal
510 Terminal
.bindKeys = function(term
) {
511 on(term
.element
, 'keydown', function(ev
) {
512 if (document
.activeElement
!= this) {
518 on(term
.element
, 'keypress', function(ev
) {
519 if (document
.activeElement
!= this) {
525 on(term
.element
, 'keyup', term
.focus
.bind(term
));
527 on(term
.textarea
, 'keydown', function(ev
) {
531 on(term
.textarea
, 'keypress', function(ev
) {
533 // Truncate the textarea's value, since it is not needed
537 on(term
.textarea
, 'compositionstart', term
.compositionHelper
.compositionstart
.bind(term
.compositionHelper
));
538 on(term
.textarea
, 'compositionupdate', term
.compositionHelper
.compositionupdate
.bind(term
.compositionHelper
));
539 on(term
.textarea
, 'compositionend', term
.compositionHelper
.compositionend
.bind(term
.compositionHelper
));
540 term
.on('refresh', term
.compositionHelper
.updateCompositionElements
.bind(term
.compositionHelper
));
545 * Insert the given row to the terminal or produce a new one
546 * if no row argument is passed. Return the inserted row.
547 * @param {HTMLElement} row (optional) The row to append to the terminal.
549 Terminal
.prototype.insertRow = function (row
) {
550 if (typeof row
!= 'object') {
551 row
= document
.createElement('div');
554 this.rowContainer
.appendChild(row
);
555 this.children
.push(row
);
561 * Opens the terminal within an element.
563 * @param {HTMLElement} parent The element to create the terminal within.
565 Terminal
.prototype.open = function(parent
) {
566 var self
=this, i
=0, div
;
568 this.parent
= parent
|| this.parent
;
571 throw new Error('Terminal requires a parent element.');
574 // Grab global elements
575 this.context
= this.parent
.ownerDocument
.defaultView
;
576 this.document
= this.parent
.ownerDocument
;
577 this.body
= this.document
.getElementsByTagName('body')[0];
579 //Create main element container
580 this.element
= this.document
.createElement('div');
581 this.element
.classList
.add('terminal');
582 this.element
.classList
.add('xterm');
583 this.element
.classList
.add('xterm-theme-' + this.theme
);
585 this.element
.style
.height
586 this.element
.setAttribute('tabindex', 0);
588 this.viewportElement
= document
.createElement('div');
589 this.viewportElement
.classList
.add('xterm-viewport');
590 this.element
.appendChild(this.viewportElement
);
591 this.viewportScrollArea
= document
.createElement('div');
592 this.viewportScrollArea
.classList
.add('xterm-scroll-area');
593 this.viewportElement
.appendChild(this.viewportScrollArea
);
595 // Create the container that will hold the lines of the terminal and then
596 // produce the lines the lines.
597 this.rowContainer
= document
.createElement('div');
598 this.rowContainer
.classList
.add('xterm-rows');
599 this.element
.appendChild(this.rowContainer
);
602 // Create the container that will hold helpers like the textarea for
603 // capturing DOM Events. Then produce the helpers.
604 this.helperContainer
= document
.createElement('div');
605 this.helperContainer
.classList
.add('xterm-helpers');
606 // TODO: This should probably be inserted once it's filled to prevent an additional layout
607 this.element
.appendChild(this.helperContainer
);
608 this.textarea
= document
.createElement('textarea');
609 this.textarea
.classList
.add('xterm-helper-textarea');
610 this.textarea
.setAttribute('autocorrect', 'off');
611 this.textarea
.setAttribute('autocapitalize', 'off');
612 this.textarea
.setAttribute('spellcheck', 'false');
613 this.textarea
.tabIndex
= 0;
614 this.textarea
.addEventListener('focus', function() {
615 self
.emit('focus', {terminal
: self
});
617 this.textarea
.addEventListener('blur', function() {
618 self
.emit('blur', {terminal
: self
});
620 this.helperContainer
.appendChild(this.textarea
);
622 this.compositionView
= document
.createElement('div');
623 this.compositionView
.classList
.add('composition-view');
624 this.compositionHelper
= new CompositionHelper(this.textarea
, this.compositionView
, this);
625 this.helperContainer
.appendChild(this.compositionView
);
627 this.charSizeStyleElement
= document
.createElement('style');
628 this.helperContainer
.appendChild(this.charSizeStyleElement
);
630 for (; i
< this.rows
; i
++) {
633 this.parent
.appendChild(this.element
);
635 this.charMeasure
= new CharMeasure(this.helperContainer
);
636 this.charMeasure
.on('charsizechanged', function () {
637 self
.updateCharSizeCSS();
639 this.charMeasure
.measure();
641 this.viewport
= new Viewport(this, this.viewportElement
, this.viewportScrollArea
, this.charMeasure
);
643 // Setup loop that draws to screen
644 this.queueRefresh(0, this.rows
- 1);
647 // Initialize global actions that
648 // need to be taken on the document.
651 // Ensure there is a Terminal.focus.
654 on(this.element
, 'click', function() {
655 var selection
= document
.getSelection(),
656 collapsed
= selection
.isCollapsed
,
657 isRange
= typeof collapsed
== 'boolean' ? !collapsed
: selection
.type
== 'Range';
663 // Listen for mouse events and translate
664 // them into terminal mouse protocols.
667 // Figure out whether boldness affects
668 // the character width of monospace fonts.
669 if (Terminal
.brokenBold
== null) {
670 Terminal
.brokenBold
= isBoldBroken(this.document
);
674 * This event is emitted when terminal has completed opening.
683 * Attempts to load an add-on using CommonJS or RequireJS (whichever is available).
684 * @param {string} addon The name of the addon to load
687 Terminal
.loadAddon = function(addon
, callback
) {
688 if (typeof exports
=== 'object' && typeof module
=== 'object') {
690 return require('./addons/' + addon
+ '/' + addon
);
691 } else if (typeof define
== 'function') {
693 return require(['./addons/' + addon
+ '/' + addon
], callback
);
695 console
.error('Cannot load a module without a CommonJS or RequireJS environment.');
701 * Updates the helper CSS class with any changes necessary after the terminal's
702 * character width has been changed.
704 Terminal
.prototype.updateCharSizeCSS = function() {
705 this.charSizeStyleElement
.textContent
= '.xterm-wide-char{width:' + (this.charMeasure
.width
* 2) + 'px;}';
710 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#Mouse%20Tracking
711 * To better understand these
712 * the xterm code is very helpful:
714 * button.c, charproc.c, misc.c
715 * Relevant functions in xterm/button.c:
716 * BtnCode, EmitButtonCode, EditorButton, SendMousePosition
718 Terminal
.prototype.bindMouse = function() {
719 var el
= this.element
, self
= this, pressed
= 32;
721 // mouseup, mousedown, wheel
722 // left click: ^[[M 3<^[[M#3<
724 function sendButton(ev
) {
728 // get the xterm-style button
729 button
= getButton(ev
);
731 // get mouse coordinates
735 sendEvent(button
, pos
);
737 switch (ev
.overrideType
|| ev
.type
) {
742 // keep it at the left
743 // button, just in case.
754 // motion example of a left click:
755 // ^[[M 3<^[[M@4<^[[M@5<^[[M@6<^[[M@7<^[[M#7<
756 function sendMove(ev
) {
763 // buttons marked as motions
764 // are incremented by 32
767 sendEvent(button
, pos
);
771 // position to characters
772 function encode(data
, ch
) {
773 if (!self
.utfMouse
) {
774 if (ch
=== 255) return data
.push(0);
775 if (ch
> 127) ch
= 127;
778 if (ch
=== 2047) return data
.push(0);
782 if (ch
> 2047) ch
= 2047;
783 data
.push(0xC0 | (ch
>> 6));
784 data
.push(0x80 | (ch
& 0x3F));
789 // send a mouse event:
790 // regular/utf8: ^[[M Cb Cx Cy
791 // urxvt: ^[[ Cb ; Cx ; Cy M
792 // sgr: ^[[ Cb ; Cx ; Cy M/m
793 // vt300: ^[[ 24(1/3/5)~ [ Cx , Cy ] \r
794 // locator: CSI P e ; P b ; P r ; P c ; P p & w
795 function sendEvent(button
, pos
) {
796 // self.emit('mouse', {
802 if (self
.vt300Mouse
) {
804 // http://www.vt100.net/docs/vt3xx-gp/chapter15.html
808 var data
= C0
.ESC
+ '[24';
809 if (button
=== 0) data
+= '1';
810 else if (button
=== 1) data
+= '3';
811 else if (button
=== 2) data
+= '5';
812 else if (button
=== 3) return;
814 data
+= '~[' + pos
.x
+ ',' + pos
.y
+ ']\r';
819 if (self
.decLocator
) {
824 if (button
=== 0) button
= 2;
825 else if (button
=== 1) button
= 4;
826 else if (button
=== 2) button
= 6;
827 else if (button
=== 3) button
= 3;
828 self
.send(C0
.ESC
+ '['
831 + (button
=== 3 ? 4 : 0)
842 if (self
.urxvtMouse
) {
847 self
.send(C0
.ESC
+ '[' + button
+ ';' + pos
.x
+ ';' + pos
.y
+ 'M');
854 self
.send(C0
.ESC
+ '[<'
855 + (((button
& 3) === 3 ? button
& ~3 : button
) - 32)
860 + ((button
& 3) === 3 ? 'm' : 'M'));
866 encode(data
, button
);
870 self
.send(C0
.ESC
+ '[M' + String
.fromCharCode
.apply(String
, data
));
873 function getButton(ev
) {
886 // 1, and 2 - with 64 added
887 switch (ev
.overrideType
|| ev
.type
) {
889 button
= ev
.button
!= null
895 if (self
.browser
.isMSIE
) {
896 button
= button
=== 1 ? 0 : button
=== 4 ? 1 : button
;
902 case 'DOMMouseScroll':
903 button
= ev
.detail
< 0
908 button
= ev
.wheelDeltaY
> 0
914 // next three bits are the modifiers:
915 // 4 = shift, 8 = meta, 16 = control
916 shift
= ev
.shiftKey
? 4 : 0;
917 meta
= ev
.metaKey
? 8 : 0;
918 ctrl
= ev
.ctrlKey
? 16 : 0;
919 mod
= shift
| meta
| ctrl
;
922 if (self
.vt200Mouse
) {
925 } else if (!self
.normalMouse
) {
930 button
= (32 + (mod
<< 2)) + button
;
935 // mouse coordinates measured in cols/rows
936 function getCoords(ev
) {
939 // ignore browsers without pageX for now
940 if (ev
.pageX
== null) return;
946 // should probably check offsetParent
947 // but this is more portable
948 while (el
&& el
!== self
.document
.documentElement
) {
951 el
= 'offsetParent' in el
956 // convert to cols/rows
957 w
= self
.element
.clientWidth
;
958 h
= self
.element
.clientHeight
;
959 x
= Math
.ceil((x
/ w
) * self
.cols
);
960 y
= Math
.ceil((y
/ h
) * self
.rows
);
962 // be sure to avoid sending
963 // bad positions to the program
965 if (x
> self
.cols
) x
= self
.cols
;
967 if (y
> self
.rows
) y
= self
.rows
;
969 // xterm sends raw bytes and
970 // starts at 32 (SP) for each.
981 on(el
, 'mousedown', function(ev
) {
982 if (!self
.mouseEvents
) return;
991 //if (self.vt200Mouse && !self.normalMouse) {
992 if (self
.vt200Mouse
) {
993 ev
.overrideType
= 'mouseup';
995 return self
.cancel(ev
);
999 if (self
.normalMouse
) on(self
.document
, 'mousemove', sendMove
);
1001 // x10 compatibility mode can't send button releases
1002 if (!self
.x10Mouse
) {
1003 on(self
.document
, 'mouseup', function up(ev
) {
1005 if (self
.normalMouse
) off(self
.document
, 'mousemove', sendMove
);
1006 off(self
.document
, 'mouseup', up
);
1007 return self
.cancel(ev
);
1011 return self
.cancel(ev
);
1014 //if (self.normalMouse) {
1015 // on(self.document, 'mousemove', sendMove);
1018 on(el
, 'wheel', function(ev
) {
1019 if (!self
.mouseEvents
) return;
1022 || self
.decLocator
) return;
1024 return self
.cancel(ev
);
1027 // allow wheel scrolling in
1028 // the shell for example
1029 on(el
, 'wheel', function(ev
) {
1030 if (self
.mouseEvents
) return;
1031 self
.viewport
.onWheel(ev
);
1032 return self
.cancel(ev
);
1037 * Destroys the terminal.
1039 Terminal
.prototype.destroy = function() {
1040 this.readable
= false;
1041 this.writable
= false;
1043 this.handler = function() {};
1044 this.write = function() {};
1045 if (this.element
.parentNode
) {
1046 this.element
.parentNode
.removeChild(this.element
);
1048 //this.emit('close');
1053 * Flags used to render terminal text properly
1064 * Queues a refresh between two rows (inclusive), to be done on next animation
1066 * @param {number} start The start row.
1067 * @param {number} end The end row.
1069 Terminal
.prototype.queueRefresh = function(start
, end
) {
1070 this.refreshRowsQueue
.push({ start
: start
, end
: end
});
1074 * Performs the refresh loop callback, calling refresh only if a refresh is
1075 * necessary before queueing up the next one.
1077 Terminal
.prototype.refreshLoop = function() {
1078 // Don't refresh if there were no row changes
1079 if (this.refreshRowsQueue
.length
> 0) {
1080 // Skip MAX_REFRESH_FRAME_SKIP frames if the writeBuffer is non-empty as it
1081 // will need to be immediately refreshed anyway. This saves a lot of
1082 // rendering time as the viewport DOM does not need to be refreshed, no
1083 // scroll events, no layouts, etc.
1084 var skipFrame
= this.writeBuffer
.length
> 0 && this.refreshFramesSkipped
++ <= MAX_REFRESH_FRAME_SKIP
;
1087 this.refreshFramesSkipped
= 0;
1090 if (this.refreshRowsQueue
.length
> 4) {
1091 // Just do a full refresh when 5+ refreshes are queued
1093 end
= this.rows
- 1;
1095 // Get start and end rows that need refreshing
1096 start
= this.refreshRowsQueue
[0].start
;
1097 end
= this.refreshRowsQueue
[0].end
;
1098 for (var i
= 1; i
< this.refreshRowsQueue
.length
; i
++) {
1099 if (this.refreshRowsQueue
[i
].start
< start
) {
1100 start
= this.refreshRowsQueue
[i
].start
;
1102 if (this.refreshRowsQueue
[i
].end
> end
) {
1103 end
= this.refreshRowsQueue
[i
].end
;
1107 this.refreshRowsQueue
= [];
1108 this.refresh(start
, end
);
1111 window
.requestAnimationFrame(this.refreshLoop
.bind(this));
1115 * Refreshes (re-renders) terminal content within two rows (inclusive)
1119 * In the screen buffer, each character is stored as a an array with a character
1120 * and a 32-bit integer:
1121 * - First value: a utf-16 character.
1123 * - Next 9 bits: background color (0-511).
1124 * - Next 9 bits: foreground color (0-511).
1125 * - Next 14 bits: a mask for misc. flags:
1132 * @param {number} start The row to start from (between 0 and terminal's height terminal - 1)
1133 * @param {number} end The row to end at (between fromRow and terminal's height terminal - 1)
1135 Terminal
.prototype.refresh = function(start
, end
) {
1138 var x
, y
, i
, line
, out
, ch
, ch_width
, width
, data
, attr
, bg
, fg
, flags
, row
, parent
, focused
= document
.activeElement
;
1140 // If this is a big refresh, remove the terminal rows from the DOM for faster calculations
1141 if (end
- start
>= this.rows
/ 2) {
1142 parent
= this.element
.parentNode
;
1144 this.element
.removeChild(this.rowContainer
);
1151 if (end
>= this.rows
.length
) {
1152 this.log('`end` is too large. Most likely a bad CSR.');
1153 end
= this.rows
.length
- 1;
1156 for (; y
<= end
; y
++) {
1157 row
= y
+ this.ydisp
;
1159 line
= this.lines
.get(row
);
1160 if (!line
|| !this.children
[y
]) {
1161 // Continue if the line is not available, this means a resize is currently in progress
1166 if (this.y
=== y
- (this.ybase
- this.ydisp
)
1168 && !this.cursorHidden
) {
1174 attr
= this.defAttr
;
1177 for (; i
< width
; i
++) {
1179 // Continue if the character is not available, this means a resize is currently in progress
1184 ch_width
= line
[i
][2];
1188 if (i
=== x
) data
= -1;
1190 if (data
!== attr
) {
1191 if (attr
!== this.defAttr
) {
1194 if (data
!== this.defAttr
) {
1196 out
+= '<span class="reverse-video terminal-cursor';
1197 if (this.cursorBlink
) {
1202 var classNames
= [];
1205 fg
= (data
>> 9) & 0x1ff;
1208 if (flags
& Terminal
.flags
.BOLD
) {
1209 if (!Terminal
.brokenBold
) {
1210 classNames
.push('xterm-bold');
1212 // See: XTerm*boldColors
1213 if (fg
< 8) fg
+= 8;
1216 if (flags
& Terminal
.flags
.UNDERLINE
) {
1217 classNames
.push('xterm-underline');
1220 if (flags
& Terminal
.flags
.BLINK
) {
1221 classNames
.push('xterm-blink');
1224 // If inverse flag is on, then swap the foreground and background variables.
1225 if (flags
& Terminal
.flags
.INVERSE
) {
1226 /* One-line variable swap in JavaScript: http://stackoverflow.com/a/16201730 */
1227 bg = [fg, fg = bg][0];
1228 // Should inverse just be before the
1229 // above boldColors effect instead?
1230 if ((flags & 1) && fg < 8) fg += 8;
1233 if (flags & Terminal.flags.INVISIBLE) {
1234 classNames.push('xterm-hidden');
1238 * Weird situation: Invert flag used black foreground and white background results
1239 * in invalid background color, positioned at the 256 index of the 256 terminal
1240 * color map. Pin the colors manually in such a case.
1242 * Source: https://github.com/sourcelair/xterm.js/issues/57
1244 if (flags
& Terminal
.flags
.INVERSE
) {
1254 classNames
.push('xterm-bg-color-' + bg
);
1258 classNames
.push('xterm-color-' + fg
);
1262 if (classNames
.length
) {
1263 out
+= ' class="' + classNames
.join(' ') + '"';
1270 if (ch_width
=== 2) {
1271 out
+= '<span class="xterm-wide-char">';
1291 if (ch_width
=== 2) {
1298 if (attr
!== this.defAttr
) {
1302 this.children
[y
].innerHTML
= out
;
1306 this.element
.appendChild(this.rowContainer
);
1309 this.emit('refresh', {element
: this.element
, start
: start
, end
: end
});
1313 * Display the cursor element
1315 Terminal
.prototype.showCursor = function() {
1316 if (!this.cursorState
) {
1317 this.cursorState
= 1;
1318 this.queueRefresh(this.y
, this.y
);
1323 * Scroll the terminal down 1 row, creating a blank line.
1325 Terminal
.prototype.scroll = function() {
1328 // Make room for the new row in lines
1329 if (this.lines
.length
=== this.lines
.maxLength
) {
1330 this.lines
.trimStart(1);
1332 if (this.ydisp
!== 0) {
1339 // TODO: Why is this done twice?
1340 if (!this.userScrolling
) {
1341 this.ydisp
= this.ybase
;
1345 row
= this.ybase
+ this.rows
- 1;
1347 // subtract the bottom scroll region
1348 row
-= this.rows
- 1 - this.scrollBottom
;
1350 if (row
=== this.lines
.length
) {
1351 // Optimization: pushing is faster than splicing when they amount to the same behavior
1352 this.lines
.push(this.blankLine());
1355 this.lines
.splice(row
, 0, this.blankLine());
1358 if (this.scrollTop
!== 0) {
1359 if (this.ybase
!== 0) {
1361 if (!this.userScrolling
) {
1362 this.ydisp
= this.ybase
;
1365 this.lines
.splice(this.ybase
+ this.scrollTop
, 1);
1369 this.updateRange(this.scrollTop
);
1370 this.updateRange(this.scrollBottom
);
1373 * This event is emitted whenever the terminal is scrolled.
1374 * The one parameter passed is the new y display position.
1378 this.emit('scroll', this.ydisp
);
1382 * Scroll the display of the terminal
1383 * @param {number} disp The number of lines to scroll down (negatives scroll up).
1384 * @param {boolean} suppressScrollEvent Don't emit the scroll event as scrollDisp. This is used
1385 * to avoid unwanted events being handled by the veiwport when the event was triggered from the
1386 * viewport originally.
1388 Terminal
.prototype.scrollDisp = function(disp
, suppressScrollEvent
) {
1390 this.userScrolling
= true;
1391 } else if (disp
+ this.ydisp
>= this.ybase
) {
1392 this.userScrolling
= false;
1397 if (this.ydisp
> this.ybase
) {
1398 this.ydisp
= this.ybase
;
1399 } else if (this.ydisp
< 0) {
1403 if (!suppressScrollEvent
) {
1404 this.emit('scroll', this.ydisp
);
1407 this.queueRefresh(0, this.rows
- 1);
1411 * Scroll the display of the terminal by a number of pages.
1412 * @param {number} pageCount The number of pages to scroll (negative scrolls up).
1414 Terminal
.prototype.scrollPages = function(pageCount
) {
1415 this.scrollDisp(pageCount
* (this.rows
- 1));
1419 * Scrolls the display of the terminal to the top.
1421 Terminal
.prototype.scrollToTop = function() {
1422 this.scrollDisp(-this.ydisp
);
1426 * Scrolls the display of the terminal to the bottom.
1428 Terminal
.prototype.scrollToBottom = function() {
1429 this.scrollDisp(this.ybase
- this.ydisp
);
1433 * Writes text to the terminal.
1434 * @param {string} text The text to write to the terminal.
1436 Terminal
.prototype.write = function(data
) {
1437 this.writeBuffer
.push(data
);
1439 // Send XOFF to pause the pty process if the write buffer becomes too large so
1440 // xterm.js can catch up before more data is sent. This is necessary in order
1441 // to keep signals such as ^C responsive.
1442 if (!this.xoffSentToCatchUp
&& this.writeBuffer
.length
>= WRITE_BUFFER_PAUSE_THRESHOLD
) {
1443 // XOFF - stop pty pipe
1444 // XON will be triggered by emulator before processing data chunk
1446 this.xoffSentToCatchUp
= true;
1449 if (!this.writeInProgress
&& this.writeBuffer
.length
> 0) {
1450 // Kick off a write which will write all data in sequence recursively
1451 this.writeInProgress
= true;
1452 // Kick off an async innerWrite so more writes can come in while processing data
1454 setTimeout(function () {
1460 Terminal
.prototype.innerWrite = function() {
1461 var writeBatch
= this.writeBuffer
.splice(0, WRITE_BATCH_SIZE
);
1462 while (writeBatch
.length
> 0) {
1463 var data
= writeBatch
.shift();
1464 var l
= data
.length
, i
= 0, j
, cs
, ch
, code
, low
, ch_width
, row
;
1466 // If XOFF was sent in order to catch up with the pty process, resume it if
1467 // the writeBuffer is empty to allow more data to come in.
1468 if (this.xoffSentToCatchUp
&& writeBatch
.length
=== 0 && this.writeBuffer
.length
=== 0) {
1470 this.xoffSentToCatchUp
= false;
1473 this.refreshStart
= this.y
;
1474 this.refreshEnd
= this.y
;
1476 // apply leftover surrogate high from last write
1477 if (this.surrogate_high
) {
1478 data
= this.surrogate_high
+ data
;
1479 this.surrogate_high
= '';
1482 for (; i
< l
; i
++) {
1485 // FIXME: higher chars than 0xa0 are not allowed in escape sequences
1486 // --> maybe move to default
1487 code
= data
.charCodeAt(i
);
1488 if (0xD800 <= code
&& code
<= 0xDBFF) {
1489 // we got a surrogate high
1490 // get surrogate low (next 2 bytes)
1491 low
= data
.charCodeAt(i
+1);
1493 // end of data stream, save surrogate high
1494 this.surrogate_high
= ch
;
1497 code
= ((code
- 0xD800) * 0x400) + (low
- 0xDC00) + 0x10000;
1498 ch
+= data
.charAt(i
+1);
1501 // surrogate low - already handled above
1502 if (0xDC00 <= code
&& code
<= 0xDFFF)
1504 switch (this.state
) {
1515 if (this.convertEol
) {
1519 if (this.y
> this.scrollBottom
) {
1539 this.x
= this.nextStop();
1554 this.state
= escaped
;
1559 // calculate print space
1560 // expensive call, therefore we save width in line buffer
1561 ch_width
= wcwidth(code
);
1564 if (this.charset
&& this.charset
[ch
]) {
1565 ch
= this.charset
[ch
];
1568 row
= this.y
+ this.ybase
;
1570 // insert combining char in last cell
1571 // FIXME: needs handling after cursor jumps
1572 if (!ch_width
&& this.x
) {
1573 // dont overflow left
1574 if (this.lines
.get(row
)[this.x
-1]) {
1575 if (!this.lines
.get(row
)[this.x
-1][2]) {
1577 // found empty cell after fullwidth, need to go 2 cells back
1578 if (this.lines
.get(row
)[this.x
-2])
1579 this.lines
.get(row
)[this.x
-2][1] += ch
;
1582 this.lines
.get(row
)[this.x
-1][1] += ch
;
1584 this.updateRange(this.y
);
1589 // goto next line if ch would overflow
1590 // TODO: needs a global min terminal width of 2
1591 if (this.x
+ch_width
-1 >= this.cols
) {
1592 // autowrap - DECAWM
1593 if (this.wraparoundMode
) {
1596 if (this.y
> this.scrollBottom
) {
1601 this.x
= this.cols
-1;
1602 if(ch_width
===2) // FIXME: check for xterm behavior
1606 row
= this.y
+ this.ybase
;
1608 // insert mode: move characters to right
1609 if (this.insertMode
) {
1610 // do this twice for a fullwidth char
1611 for (var moves
=0; moves
<ch_width
; ++moves
) {
1612 // remove last cell, if it's width is 0
1613 // we have to adjust the second last cell as well
1614 var removed
= this.lines
.get(this.y
+ this.ybase
).pop();
1616 && this.lines
.get(row
)[this.cols
-2]
1617 && this.lines
.get(row
)[this.cols
-2][2]===2)
1618 this.lines
.get(row
)[this.cols
-2] = [this.curAttr
, ' ', 1];
1620 // insert empty cell at cursor
1621 this.lines
.get(row
).splice(this.x
, 0, [this.curAttr
, ' ', 1]);
1625 this.lines
.get(row
)[this.x
] = [this.curAttr
, ch
, ch_width
];
1627 this.updateRange(this.y
);
1629 // fullwidth char - set next cell width to zero and advance cursor
1631 this.lines
.get(row
)[this.x
] = [this.curAttr
, '', 0];
1640 // ESC [ Control Sequence Introducer ( CSI is 0x9b).
1643 this.currentParam
= 0;
1647 // ESC ] Operating System Command ( OSC is 0x9d).
1650 this.currentParam
= 0;
1654 // ESC P Device Control String ( DCS is 0x90).
1657 this.currentParam
= 0;
1661 // ESC _ Application Program Command ( APC is 0x9f).
1663 this.state
= ignore
;
1666 // ESC ^ Privacy Message ( PM is 0x9e).
1668 this.state
= ignore
;
1671 // ESC c Full Reset (RIS).
1676 // ESC E Next Line ( NEL is 0x85).
1677 // ESC D Index ( IND is 0x84).
1685 // ESC M Reverse Index ( RI is 0x8d).
1687 this.reverseIndex();
1690 // ESC % Select default/utf-8 character set.
1691 // @ = default, G = utf-8
1693 //this.charset = null;
1695 this.setgCharset(0, Terminal
.charsets
.US
);
1696 this.state
= normal
;
1700 // ESC (,),*,+,-,. Designate G0-G2 Character Set.
1701 case '(': // <-- this seems to get all the attention
1727 this.state
= charset
;
1730 // Designate G3 Character Set (VT300).
1731 // A = ISO Latin-1 Supplemental.
1735 this.state
= charset
;
1740 // Single Shift Select of G2 Character Set
1741 // ( SS2 is 0x8e). This affects next character only.
1745 // Single Shift Select of G3 Character Set
1746 // ( SS3 is 0x8f). This affects next character only.
1750 // Invoke the G2 Character Set as GL (LS2).
1755 // Invoke the G3 Character Set as GL (LS3).
1760 // Invoke the G3 Character Set as GR (LS3R).
1765 // Invoke the G2 Character Set as GR (LS2R).
1770 // Invoke the G1 Character Set as GR (LS1R).
1775 // ESC 7 Save Cursor (DECSC).
1778 this.state
= normal
;
1781 // ESC 8 Restore Cursor (DECRC).
1783 this.restoreCursor();
1784 this.state
= normal
;
1787 // ESC # 3 DEC line height/width
1789 this.state
= normal
;
1793 // ESC H Tab Set (HTS is 0x88).
1798 // ESC = Application Keypad (DECKPAM).
1800 this.log('Serial port requested application keypad.');
1801 this.applicationKeypad
= true;
1802 this.viewport
.syncScrollArea();
1803 this.state
= normal
;
1806 // ESC > Normal Keypad (DECKPNM).
1808 this.log('Switching back to normal keypad.');
1809 this.applicationKeypad
= false;
1810 this.viewport
.syncScrollArea();
1811 this.state
= normal
;
1815 this.state
= normal
;
1816 this.error('Unknown ESC control: %s.', ch
);
1823 case '0': // DEC Special Character and Line Drawing Set.
1824 cs
= Terminal
.charsets
.SCLD
;
1827 cs
= Terminal
.charsets
.UK
;
1829 case 'B': // United States (USASCII).
1830 cs
= Terminal
.charsets
.US
;
1833 cs
= Terminal
.charsets
.Dutch
;
1835 case 'C': // Finnish
1837 cs
= Terminal
.charsets
.Finnish
;
1840 cs
= Terminal
.charsets
.French
;
1842 case 'Q': // FrenchCanadian
1843 cs
= Terminal
.charsets
.FrenchCanadian
;
1846 cs
= Terminal
.charsets
.German
;
1848 case 'Y': // Italian
1849 cs
= Terminal
.charsets
.Italian
;
1851 case 'E': // NorwegianDanish
1853 cs
= Terminal
.charsets
.NorwegianDanish
;
1855 case 'Z': // Spanish
1856 cs
= Terminal
.charsets
.Spanish
;
1858 case 'H': // Swedish
1860 cs
= Terminal
.charsets
.Swedish
;
1863 cs
= Terminal
.charsets
.Swiss
;
1865 case '/': // ISOLatin (actually /A)
1866 cs
= Terminal
.charsets
.ISOLatin
;
1870 cs
= Terminal
.charsets
.US
;
1873 this.setgCharset(this.gcharset
, cs
);
1874 this.gcharset
= null;
1875 this.state
= normal
;
1881 // Set Text Parameters.
1882 if (ch
=== C0
.ESC
|| ch
=== C0
.BEL
) {
1883 if (ch
=== C0
.ESC
) i
++;
1885 this.params
.push(this.currentParam
);
1887 switch (this.params
[0]) {
1891 if (this.params
[1]) {
1892 this.title
= this.params
[1];
1893 this.handleTitle(this.title
);
1901 // change dynamic colors
1913 // change dynamic ui colors
1925 // manipulate selection data
1943 this.currentParam
= 0;
1944 this.state
= normal
;
1946 if (!this.params
.length
) {
1947 if (ch
>= '0' && ch
<= '9') {
1949 this.currentParam
* 10 + ch
.charCodeAt(0) - 48;
1950 } else if (ch
=== ';') {
1951 this.params
.push(this.currentParam
);
1952 this.currentParam
= '';
1955 this.currentParam
+= ch
;
1962 if (ch
=== '?' || ch
=== '>' || ch
=== '!') {
1968 if (ch
>= '0' && ch
<= '9') {
1969 this.currentParam
= this.currentParam
* 10 + ch
.charCodeAt(0) - 48;
1973 // '$', '"', ' ', '\''
1974 if (ch
=== '$' || ch
=== '"' || ch
=== ' ' || ch
=== '\'') {
1979 this.params
.push(this.currentParam
);
1980 this.currentParam
= 0;
1983 if (ch
=== ';') break;
1985 this.state
= normal
;
1989 // Cursor Up Ps Times (default = 1) (CUU).
1991 this.cursorUp(this.params
);
1995 // Cursor Down Ps Times (default = 1) (CUD).
1997 this.cursorDown(this.params
);
2001 // Cursor Forward Ps Times (default = 1) (CUF).
2003 this.cursorForward(this.params
);
2007 // Cursor Backward Ps Times (default = 1) (CUB).
2009 this.cursorBackward(this.params
);
2013 // Cursor Position [row;column] (default = [1,1]) (CUP).
2015 this.cursorPos(this.params
);
2018 // CSI Ps J Erase in Display (ED).
2020 this.eraseInDisplay(this.params
);
2023 // CSI Ps K Erase in Line (EL).
2025 this.eraseInLine(this.params
);
2028 // CSI Pm m Character Attributes (SGR).
2031 this.charAttributes(this.params
);
2035 // CSI Ps n Device Status Report (DSR).
2038 this.deviceStatus(this.params
);
2047 // Insert Ps (Blank) Character(s) (default = 1) (ICH).
2049 this.insertChars(this.params
);
2053 // Cursor Next Line Ps Times (default = 1) (CNL).
2055 this.cursorNextLine(this.params
);
2059 // Cursor Preceding Line Ps Times (default = 1) (CNL).
2061 this.cursorPrecedingLine(this.params
);
2065 // Cursor Character Absolute [column] (default = [row,1]) (CHA).
2067 this.cursorCharAbsolute(this.params
);
2071 // Insert Ps Line(s) (default = 1) (IL).
2073 this.insertLines(this.params
);
2077 // Delete Ps Line(s) (default = 1) (DL).
2079 this.deleteLines(this.params
);
2083 // Delete Ps Character(s) (default = 1) (DCH).
2085 this.deleteChars(this.params
);
2089 // Erase Ps Character(s) (default = 1) (ECH).
2091 this.eraseChars(this.params
);
2094 // CSI Pm ` Character Position Absolute
2095 // [column] (default = [row,1]) (HPA).
2097 this.charPosAbsolute(this.params
);
2101 // Horizontal Position Relative
2103 this.HPositionRelative(this.params
);
2107 // Send Device Attributes (Primary DA).
2109 // Send Device Attributes (Secondary DA)
2111 this.sendDeviceAttributes(this.params
);
2115 // Line Position Absolute [row] (default = [1,column]) (VPA).
2117 this.linePosAbsolute(this.params
);
2120 // 145 65 e * VPR - Vertical Position Relative
2122 this.VPositionRelative(this.params
);
2126 // Horizontal and Vertical Position [row;column] (default =
2129 this.HVPosition(this.params
);
2132 // CSI Pm h Set Mode (SM).
2133 // CSI ? Pm h - mouse escape codes, cursor escape codes
2135 this.setMode(this.params
);
2138 // CSI Pm l Reset Mode (RM).
2141 this.resetMode(this.params
);
2145 // Set Scrolling Region [top;bottom] (default = full size of win-
2149 this.setScrollRegion(this.params
);
2153 // Save cursor (ANSI.SYS).
2155 this.saveCursor(this.params
);
2159 // Restore cursor (ANSI.SYS).
2161 this.restoreCursor(this.params
);
2169 // Cursor Forward Tabulation Ps tab stops (default = 1) (CHT).
2171 this.cursorForwardTab(this.params
);
2174 // CSI Ps S Scroll up Ps lines (default = 1) (SU).
2176 this.scrollUp(this.params
);
2179 // CSI Ps T Scroll down Ps lines (default = 1) (SD).
2180 // CSI Ps ; Ps ; Ps ; Ps ; Ps T
2183 // if (this.prefix === '>') {
2184 // this.resetTitleModes(this.params);
2187 // if (this.params.length > 2) {
2188 // this.initMouseTracking(this.params);
2191 if (this.params
.length
< 2 && !this.prefix
) {
2192 this.scrollDown(this.params
);
2197 // Cursor Backward Tabulation Ps tab stops (default = 1) (CBT).
2199 this.cursorBackwardTab(this.params
);
2202 // CSI Ps b Repeat the preceding graphic character Ps times (REP).
2204 this.repeatPrecedingCharacter(this.params
);
2207 // CSI Ps g Tab Clear (TBC).
2209 this.tabClear(this.params
);
2212 // CSI Pm i Media Copy (MC).
2215 // this.mediaCopy(this.params);
2218 // CSI Pm m Character Attributes (SGR).
2220 // case 'm': // duplicate
2221 // if (this.prefix === '>') {
2222 // this.setResources(this.params);
2224 // this.charAttributes(this.params);
2228 // CSI Ps n Device Status Report (DSR).
2230 // case 'n': // duplicate
2231 // if (this.prefix === '>') {
2232 // this.disableModifiers(this.params);
2234 // this.deviceStatus(this.params);
2238 // CSI > Ps p Set pointer mode.
2239 // CSI ! p Soft terminal reset (DECSTR).
2241 // Request ANSI mode (DECRQM).
2243 // Request DEC private mode (DECRQM).
2246 switch (this.prefix
) {
2248 // this.setPointerMode(this.params);
2251 this.softReset(this.params
);
2254 // if (this.postfix === '$') {
2255 // this.requestPrivateMode(this.params);
2259 // if (this.postfix === '"') {
2260 // this.setConformanceLevel(this.params);
2261 // } else if (this.postfix === '$') {
2262 // this.requestAnsiMode(this.params);
2268 // CSI Ps q Load LEDs (DECLL).
2272 // if (this.postfix === ' ') {
2273 // this.setCursorStyle(this.params);
2276 // if (this.postfix === '"') {
2277 // this.setCharProtectionAttr(this.params);
2280 // this.loadLEDs(this.params);
2284 // Set Scrolling Region [top;bottom] (default = full size of win-
2287 // CSI Pt; Pl; Pb; Pr; Ps$ r
2288 // case 'r': // duplicate
2289 // if (this.prefix === '?') {
2290 // this.restorePrivateValues(this.params);
2291 // } else if (this.postfix === '$') {
2292 // this.setAttrInRectangle(this.params);
2294 // this.setScrollRegion(this.params);
2298 // CSI s Save cursor (ANSI.SYS).
2300 // case 's': // duplicate
2301 // if (this.prefix === '?') {
2302 // this.savePrivateValues(this.params);
2304 // this.saveCursor(this.params);
2308 // CSI Ps ; Ps ; Ps t
2309 // CSI Pt; Pl; Pb; Pr; Ps$ t
2313 // if (this.postfix === '$') {
2314 // this.reverseAttrInRectangle(this.params);
2315 // } else if (this.postfix === ' ') {
2316 // this.setWarningBellVolume(this.params);
2318 // if (this.prefix === '>') {
2319 // this.setTitleModeFeature(this.params);
2321 // this.manipulateWindow(this.params);
2326 // CSI u Restore cursor (ANSI.SYS).
2328 // case 'u': // duplicate
2329 // if (this.postfix === ' ') {
2330 // this.setMarginBellVolume(this.params);
2332 // this.restoreCursor(this.params);
2336 // CSI Pt; Pl; Pb; Pr; Pp; Pt; Pl; Pp$ v
2338 // if (this.postfix === '$') {
2339 // this.copyRectagle(this.params);
2343 // CSI Pt ; Pl ; Pb ; Pr ' w
2345 // if (this.postfix === '\'') {
2346 // this.enableFilterRectangle(this.params);
2350 // CSI Ps x Request Terminal Parameters (DECREQTPARM).
2351 // CSI Ps x Select Attribute Change Extent (DECSACE).
2352 // CSI Pc; Pt; Pl; Pb; Pr$ x
2354 // if (this.postfix === '$') {
2355 // this.fillRectangle(this.params);
2357 // this.requestParameters(this.params);
2358 // //this.__(this.params);
2363 // CSI Pt; Pl; Pb; Pr$ z
2365 // if (this.postfix === '\'') {
2366 // this.enableLocatorReporting(this.params);
2367 // } else if (this.postfix === '$') {
2368 // this.eraseRectangle(this.params);
2373 // CSI Pt; Pl; Pb; Pr$ {
2375 // if (this.postfix === '\'') {
2376 // this.setLocatorEvents(this.params);
2377 // } else if (this.postfix === '$') {
2378 // this.selectiveEraseRectangle(this.params);
2384 // if (this.postfix === '\'') {
2385 // this.requestLocatorPosition(this.params);
2390 // Insert P s Column(s) (default = 1) (DECIC), VT420 and up.
2392 // if (this.postfix === ' ') {
2393 // this.insertColumns(this.params);
2398 // Delete P s Column(s) (default = 1) (DECDC), VT420 and up
2400 // if (this.postfix === ' ') {
2401 // this.deleteColumns(this.params);
2406 this.error('Unknown CSI code: %s.', ch
);
2415 if (ch
=== C0
.ESC
|| ch
=== C0
.BEL
) {
2416 if (ch
=== C0
.ESC
) i
++;
2418 switch (this.prefix
) {
2419 // User-Defined Keys (DECUDK).
2423 // Request Status String (DECRQSS).
2424 // test: echo -e '\eP$q"p\e\\'
2426 var pt
= this.currentParam
2443 + (this.scrollTop
+ 1)
2445 + (this.scrollBottom
+ 1)
2455 this.error('Unknown DCS Pt: %s.', pt
);
2460 this.send(C0
.ESC
+ 'P' + +valid
+ '$r' + pt
+ C0
.ESC
+ '\\');
2463 // Set Termcap/Terminfo Data (xterm, experimental).
2467 // Request Termcap/Terminfo String (xterm, experimental)
2468 // Regular xterm does not even respond to this sequence.
2469 // This can cause a small glitch in vim.
2470 // test: echo -ne '\eP+q6b64\e\\'
2472 var pt
= this.currentParam
2475 this.send(C0
.ESC
+ 'P' + +valid
+ '+r' + pt
+ C0
.ESC
+ '\\');
2479 this.error('Unknown DCS prefix: %s.', this.prefix
);
2483 this.currentParam
= 0;
2485 this.state
= normal
;
2486 } else if (!this.currentParam
) {
2487 if (!this.prefix
&& ch
!== '$' && ch
!== '+') {
2488 this.currentParam
= ch
;
2489 } else if (this.prefix
.length
=== 2) {
2490 this.currentParam
= ch
;
2495 this.currentParam
+= ch
;
2501 if (ch
=== C0
.ESC
|| ch
=== C0
.BEL
) {
2502 if (ch
=== C0
.ESC
) i
++;
2503 this.state
= normal
;
2509 this.updateRange(this.y
);
2510 this.queueRefresh(this.refreshStart
, this.refreshEnd
);
2512 if (this.writeBuffer
.length
> 0) {
2513 // Allow renderer to catch up before processing the next batch
2515 setTimeout(function () {
2519 this.writeInProgress
= false;
2524 * Writes text to the terminal, followed by a break line character (\n).
2525 * @param {string} text The text to write to the terminal.
2527 Terminal
.prototype.writeln = function(data
) {
2528 this.write(data
+ '\r\n');
2532 * Attaches a custom keydown handler which is run before keys are processed, giving consumers of
2533 * xterm.js ultimate control as to what keys should be processed by the terminal and what keys
2535 * @param {function} customKeydownHandler The custom KeyboardEvent handler to attach. This is a
2536 * function that takes a KeyboardEvent, allowing consumers to stop propogation and/or prevent
2537 * the default action. The function returns whether the event should be processed by xterm.js.
2539 Terminal
.prototype.attachCustomKeydownHandler = function(customKeydownHandler
) {
2540 this.customKeydownHandler
= customKeydownHandler
;
2544 * Handle a keydown event
2546 * - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent
2547 * @param {KeyboardEvent} ev The keydown event to be handled.
2549 Terminal
.prototype.keyDown = function(ev
) {
2550 if (this.customKeydownHandler
&& this.customKeydownHandler(ev
) === false) {
2554 if (!this.compositionHelper
.keydown
.bind(this.compositionHelper
)(ev
)) {
2555 if (this.ybase
!== this.ydisp
) {
2556 this.scrollToBottom();
2562 var result
= this.evaluateKeyEscapeSequence(ev
);
2564 if (result
.key
=== C0
.DC3
) { // XOFF
2565 this.writeStopped
= true;
2566 } else if (result
.key
=== C0
.DC1
) { // XON
2567 this.writeStopped
= false;
2570 if (result
.scrollDisp
) {
2571 this.scrollDisp(result
.scrollDisp
);
2572 return this.cancel(ev
, true);
2575 if (isThirdLevelShift(this, ev
)) {
2579 if (result
.cancel
) {
2580 // The event is canceled at the end already, is this necessary?
2581 this.cancel(ev
, true);
2588 this.emit('keydown', ev
);
2589 this.emit('key', result
.key
, ev
);
2591 this.handler(result
.key
);
2593 return this.cancel(ev
, true);
2597 * Returns an object that determines how a KeyboardEvent should be handled. The key of the
2598 * returned value is the new key code to pass to the PTY.
2600 * Reference: http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
2601 * @param {KeyboardEvent} ev The keyboard event to be translated to key escape sequence.
2603 Terminal
.prototype.evaluateKeyEscapeSequence = function(ev
) {
2605 // Whether to cancel event propogation (NOTE: this may not be needed since the event is
2606 // canceled at the end of keyDown
2608 // The new key even to emit
2610 // The number of characters to scroll, if this is defined it will cancel the event
2611 scrollDisp
: undefined
2613 var modifiers
= ev
.shiftKey
<< 0 | ev
.altKey
<< 1 | ev
.ctrlKey
<< 2 | ev
.metaKey
<< 3;
2614 switch (ev
.keyCode
) {
2618 result
.key
= C0
.BS
; // ^H
2621 result
.key
= C0
.DEL
; // ^?
2626 result
.key
= C0
.ESC
+ '[Z';
2630 result
.cancel
= true;
2635 result
.cancel
= true;
2639 result
.key
= C0
.ESC
;
2640 result
.cancel
= true;
2645 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'D';
2646 // HACK: Make Alt + left-arrow behave like Ctrl + left-arrow: move one word backwards
2647 // http://unix.stackexchange.com/a/108106
2648 // macOS uses different escape sequences than linux
2649 if (result
.key
== C0
.ESC
+ '[1;3D') {
2650 result
.key
= (this.browser
.isMac
) ? C0
.ESC
+ 'b' : C0
.ESC
+ '[1;5D';
2652 } else if (this.applicationCursor
) {
2653 result
.key
= C0
.ESC
+ 'OD';
2655 result
.key
= C0
.ESC
+ '[D';
2661 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'C';
2662 // HACK: Make Alt + right-arrow behave like Ctrl + right-arrow: move one word forward
2663 // http://unix.stackexchange.com/a/108106
2664 // macOS uses different escape sequences than linux
2665 if (result
.key
== C0
.ESC
+ '[1;3C') {
2666 result
.key
= (this.browser
.isMac
) ? C0
.ESC
+ 'f' : C0
.ESC
+ '[1;5C';
2668 } else if (this.applicationCursor
) {
2669 result
.key
= C0
.ESC
+ 'OC';
2671 result
.key
= C0
.ESC
+ '[C';
2677 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'A';
2678 // HACK: Make Alt + up-arrow behave like Ctrl + up-arrow
2679 // http://unix.stackexchange.com/a/108106
2680 if (result
.key
== C0
.ESC
+ '[1;3A') {
2681 result
.key
= C0
.ESC
+ '[1;5A';
2683 } else if (this.applicationCursor
) {
2684 result
.key
= C0
.ESC
+ 'OA';
2686 result
.key
= C0
.ESC
+ '[A';
2692 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'B';
2693 // HACK: Make Alt + down-arrow behave like Ctrl + down-arrow
2694 // http://unix.stackexchange.com/a/108106
2695 if (result
.key
== C0
.ESC
+ '[1;3B') {
2696 result
.key
= C0
.ESC
+ '[1;5B';
2698 } else if (this.applicationCursor
) {
2699 result
.key
= C0
.ESC
+ 'OB';
2701 result
.key
= C0
.ESC
+ '[B';
2706 if (!ev
.shiftKey
&& !ev
.ctrlKey
) {
2707 // <Ctrl> or <Shift> + <Insert> are used to
2708 // copy-paste on some systems.
2709 result
.key
= C0
.ESC
+ '[2~';
2715 result
.key
= C0
.ESC
+ '[3;' + (modifiers
+ 1) + '~';
2717 result
.key
= C0
.ESC
+ '[3~';
2723 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'H';
2724 else if (this.applicationCursor
)
2725 result
.key
= C0
.ESC
+ 'OH';
2727 result
.key
= C0
.ESC
+ '[H';
2732 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'F';
2733 else if (this.applicationCursor
)
2734 result
.key
= C0
.ESC
+ 'OF';
2736 result
.key
= C0
.ESC
+ '[F';
2741 result
.scrollDisp
= -(this.rows
- 1);
2743 result
.key
= C0
.ESC
+ '[5~';
2749 result
.scrollDisp
= this.rows
- 1;
2751 result
.key
= C0
.ESC
+ '[6~';
2757 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'P';
2759 result
.key
= C0
.ESC
+ 'OP';
2764 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'Q';
2766 result
.key
= C0
.ESC
+ 'OQ';
2771 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'R';
2773 result
.key
= C0
.ESC
+ 'OR';
2778 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'S';
2780 result
.key
= C0
.ESC
+ 'OS';
2785 result
.key
= C0
.ESC
+ '[15;' + (modifiers
+ 1) + '~';
2787 result
.key
= C0
.ESC
+ '[15~';
2792 result
.key
= C0
.ESC
+ '[17;' + (modifiers
+ 1) + '~';
2794 result
.key
= C0
.ESC
+ '[17~';
2799 result
.key
= C0
.ESC
+ '[18;' + (modifiers
+ 1) + '~';
2801 result
.key
= C0
.ESC
+ '[18~';
2806 result
.key
= C0
.ESC
+ '[19;' + (modifiers
+ 1) + '~';
2808 result
.key
= C0
.ESC
+ '[19~';
2813 result
.key
= C0
.ESC
+ '[20;' + (modifiers
+ 1) + '~';
2815 result
.key
= C0
.ESC
+ '[20~';
2820 result
.key
= C0
.ESC
+ '[21;' + (modifiers
+ 1) + '~';
2822 result
.key
= C0
.ESC
+ '[21~';
2827 result
.key
= C0
.ESC
+ '[23;' + (modifiers
+ 1) + '~';
2829 result
.key
= C0
.ESC
+ '[23~';
2834 result
.key
= C0
.ESC
+ '[24;' + (modifiers
+ 1) + '~';
2836 result
.key
= C0
.ESC
+ '[24~';
2841 if (ev
.ctrlKey
&& !ev
.shiftKey
&& !ev
.altKey
&& !ev
.metaKey
) {
2842 if (ev
.keyCode
>= 65 && ev
.keyCode
<= 90) {
2843 result
.key
= String
.fromCharCode(ev
.keyCode
- 64);
2844 } else if (ev
.keyCode
=== 32) {
2846 result
.key
= String
.fromCharCode(0);
2847 } else if (ev
.keyCode
>= 51 && ev
.keyCode
<= 55) {
2848 // escape, file sep, group sep, record sep, unit sep
2849 result
.key
= String
.fromCharCode(ev
.keyCode
- 51 + 27);
2850 } else if (ev
.keyCode
=== 56) {
2852 result
.key
= String
.fromCharCode(127);
2853 } else if (ev
.keyCode
=== 219) {
2854 // ^[ - Control Sequence Introducer (CSI)
2855 result
.key
= String
.fromCharCode(27);
2856 } else if (ev
.keyCode
=== 220) {
2857 // ^\ - String Terminator (ST)
2858 result
.key
= String
.fromCharCode(28);
2859 } else if (ev
.keyCode
=== 221) {
2860 // ^] - Operating System Command (OSC)
2861 result
.key
= String
.fromCharCode(29);
2863 } else if (!this.browser
.isMac
&& ev
.altKey
&& !ev
.ctrlKey
&& !ev
.metaKey
) {
2864 // On Mac this is a third level shift. Use <Esc> instead.
2865 if (ev
.keyCode
>= 65 && ev
.keyCode
<= 90) {
2866 result
.key
= C0
.ESC
+ String
.fromCharCode(ev
.keyCode
+ 32);
2867 } else if (ev
.keyCode
=== 192) {
2868 result
.key
= C0
.ESC
+ '`';
2869 } else if (ev
.keyCode
>= 48 && ev
.keyCode
<= 57) {
2870 result
.key
= C0
.ESC
+ (ev
.keyCode
- 48);
2880 * Set the G level of the terminal
2883 Terminal
.prototype.setgLevel = function(g
) {
2885 this.charset
= this.charsets
[g
];
2889 * Set the charset for the given G level of the terminal
2893 Terminal
.prototype.setgCharset = function(g
, charset
) {
2894 this.charsets
[g
] = charset
;
2895 if (this.glevel
=== g
) {
2896 this.charset
= charset
;
2901 * Handle a keypress event.
2903 * - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent
2904 * @param {KeyboardEvent} ev The keypress event to be handled.
2906 Terminal
.prototype.keyPress = function(ev
) {
2913 } else if (ev
.which
== null) {
2915 } else if (ev
.which
!== 0 && ev
.charCode
!== 0) {
2922 (ev
.altKey
|| ev
.ctrlKey
|| ev
.metaKey
) && !isThirdLevelShift(this, ev
)
2927 key
= String
.fromCharCode(key
);
2929 this.emit('keypress', key
, ev
);
2930 this.emit('key', key
, ev
);
2938 * Send data for handling to the terminal
2939 * @param {string} data
2941 Terminal
.prototype.send = function(data
) {
2945 setTimeout(function() {
2946 self
.handler(self
.queue
);
2956 * Note: We could do sweet things with webaudio here
2958 Terminal
.prototype.bell = function() {
2959 if (!this.visualBell
) return;
2961 this.element
.style
.borderColor
= 'white';
2962 setTimeout(function() {
2963 self
.element
.style
.borderColor
= '';
2965 if (this.popOnBell
) this.focus();
2969 * Log the current state to the console.
2971 Terminal
.prototype.log = function() {
2972 if (!this.debug
) return;
2973 if (!this.context
.console
|| !this.context
.console
.log
) return;
2974 var args
= Array
.prototype.slice
.call(arguments
);
2975 this.context
.console
.log
.apply(this.context
.console
, args
);
2979 * Log the current state as error to the console.
2981 Terminal
.prototype.error = function() {
2982 if (!this.debug
) return;
2983 if (!this.context
.console
|| !this.context
.console
.error
) return;
2984 var args
= Array
.prototype.slice
.call(arguments
);
2985 this.context
.console
.error
.apply(this.context
.console
, args
);
2989 * Resizes the terminal.
2991 * @param {number} x The number of columns to resize to.
2992 * @param {number} y The number of rows to resize to.
2994 Terminal
.prototype.resize = function(x
, y
) {
3002 if (x
=== this.cols
&& y
=== this.rows
) {
3012 ch
= [this.defAttr
, ' ', 1]; // does xterm use the default attr?
3013 i
= this.lines
.length
;
3015 while (this.lines
.get(i
).length
< x
) {
3016 this.lines
.get(i
).push(ch
);
3020 i
= this.lines
.length
;
3022 while (this.lines
.get(i
).length
> x
) {
3023 this.lines
.get(i
).pop();
3036 // y is rows, not this.y
3037 if (this.lines
.length
< y
+ this.ybase
) {
3038 if (this.ybase
> 0 && this.lines
.length
<= this.ybase
+ this.y
+ addToY
+ 1) {
3039 // There is room above the buffer and there are no empty elements below the line,
3043 if (this.ydisp
> 0) {
3044 // Viewport is at the top of the buffer, must increase downwards
3048 // Add a blank line if there is no buffer left at the top to scroll to, or if there
3049 // are blank lines after the cursor
3050 this.lines
.push(this.blankLine());
3053 if (this.children
.length
< y
) {
3059 if (this.lines
.length
> y
+ this.ybase
) {
3060 if (this.lines
.length
> this.ybase
+ this.y
+ 1) {
3061 // The line is a blank line below the cursor, remove it
3064 // The line is the cursor, scroll down
3069 if (this.children
.length
> y
) {
3070 el
= this.children
.shift();
3072 el
.parentNode
.removeChild(el
);
3078 // Make sure that the cursor stays on screen
3091 this.scrollBottom
= y
- 1;
3093 this.charMeasure
.measure();
3095 this.queueRefresh(0, this.rows
- 1);
3099 this.geometry
= [this.cols
, this.rows
];
3100 this.emit('resize', {terminal
: this, cols
: x
, rows
: y
});
3104 * Updates the range of rows to refresh
3105 * @param {number} y The number of rows to refresh next.
3107 Terminal
.prototype.updateRange = function(y
) {
3108 if (y
< this.refreshStart
) this.refreshStart
= y
;
3109 if (y
> this.refreshEnd
) this.refreshEnd
= y
;
3110 // if (y > this.refreshEnd) {
3111 // this.refreshEnd = y;
3112 // if (y > this.rows - 1) {
3113 // this.refreshEnd = this.rows - 1;
3119 * Set the range of refreshing to the maximum value
3121 Terminal
.prototype.maxRange = function() {
3122 this.refreshStart
= 0;
3123 this.refreshEnd
= this.rows
- 1;
3129 * Setup the tab stops.
3132 Terminal
.prototype.setupStops = function(i
) {
3134 if (!this.tabs
[i
]) {
3135 i
= this.prevStop(i
);
3142 for (; i
< this.cols
; i
+= 8) {
3143 this.tabs
[i
] = true;
3149 * Move the cursor to the previous tab stop from the given position (default is current).
3150 * @param {number} x The position to move the cursor to the previous tab stop.
3152 Terminal
.prototype.prevStop = function(x
) {
3153 if (x
== null) x
= this.x
;
3154 while (!this.tabs
[--x
] && x
> 0);
3155 return x
>= this.cols
3162 * Move the cursor one tab stop forward from the given position (default is current).
3163 * @param {number} x The position to move the cursor one tab stop forward.
3165 Terminal
.prototype.nextStop = function(x
) {
3166 if (x
== null) x
= this.x
;
3167 while (!this.tabs
[++x
] && x
< this.cols
);
3168 return x
>= this.cols
3175 * Erase in the identified line everything from "x" to the end of the line (right).
3176 * @param {number} x The column from which to start erasing to the end of the line.
3177 * @param {number} y The line in which to operate.
3179 Terminal
.prototype.eraseRight = function(x
, y
) {
3180 var line
= this.lines
.get(this.ybase
+ y
)
3181 , ch
= [this.eraseAttr(), ' ', 1]; // xterm
3184 for (; x
< this.cols
; x
++) {
3188 this.updateRange(y
);
3194 * Erase in the identified line everything from "x" to the start of the line (left).
3195 * @param {number} x The column from which to start erasing to the start of the line.
3196 * @param {number} y The line in which to operate.
3198 Terminal
.prototype.eraseLeft = function(x
, y
) {
3199 var line
= this.lines
.get(this.ybase
+ y
)
3200 , ch
= [this.eraseAttr(), ' ', 1]; // xterm
3203 while (x
--) line
[x
] = ch
;
3205 this.updateRange(y
);
3209 * Clears the entire buffer, making the prompt line the new first line.
3211 Terminal
.prototype.clear = function() {
3212 if (this.ybase
=== 0 && this.y
=== 0) {
3213 // Don't clear if it's already clear
3216 this.lines
.set(0, this.lines
.get(this.ybase
+ this.y
));
3217 this.lines
.length
= 1;
3221 for (var i
= 1; i
< this.rows
; i
++) {
3222 this.lines
.push(this.blankLine());
3224 this.queueRefresh(0, this.rows
- 1);
3225 this.emit('scroll', this.ydisp
);
3229 * Erase all content in the given line
3230 * @param {number} y The line to erase all of its contents.
3232 Terminal
.prototype.eraseLine = function(y
) {
3233 this.eraseRight(0, y
);
3238 * Return the data array of a blank line
3239 * @param {number} cur First bunch of data for each "blank" character.
3241 Terminal
.prototype.blankLine = function(cur
) {
3246 var ch
= [attr
, ' ', 1] // width defaults to 1 halfwidth character
3250 for (; i
< this.cols
; i
++) {
3259 * If cur return the back color xterm feature attribute. Else return defAttr.
3260 * @param {object} cur
3262 Terminal
.prototype.ch = function(cur
) {
3264 ? [this.eraseAttr(), ' ', 1]
3265 : [this.defAttr
, ' ', 1];
3270 * Evaluate if the current erminal is the given argument.
3271 * @param {object} term The terminal to evaluate
3273 Terminal
.prototype.is = function(term
) {
3274 var name
= this.termName
;
3275 return (name
+ '').indexOf(term
) === 0;
3280 * Emit the 'data' event and populate the given data.
3281 * @param {string} data The data to populate in the event.
3283 Terminal
.prototype.handler = function(data
) {
3284 // Prevents all events to pty process if stdin is disabled
3285 if (this.options
.disableStdin
) {
3289 // Input is being sent to the terminal, the terminal should focus the prompt.
3290 if (this.ybase
!== this.ydisp
) {
3291 this.scrollToBottom();
3293 this.emit('data', data
);
3298 * Emit the 'title' event and populate the given title.
3299 * @param {string} title The title to populate in the event.
3301 Terminal
.prototype.handleTitle = function(title
) {
3303 * This event is emitted when the title of the terminal is changed
3304 * from inside the terminal. The parameter is the new title.
3308 this.emit('title', title
);
3317 * ESC D Index (IND is 0x84).
3319 Terminal
.prototype.index = function() {
3321 if (this.y
> this.scrollBottom
) {
3325 this.state
= normal
;
3330 * ESC M Reverse Index (RI is 0x8d).
3332 * Move the cursor up one row, inserting a new blank line if necessary.
3334 Terminal
.prototype.reverseIndex = function() {
3336 if (this.y
=== this.scrollTop
) {
3337 // possibly move the code below to term.reverseScroll();
3338 // test: echo -ne '\e[1;1H\e[44m\eM\e[0m'
3339 // blankLine(true) is xterm/linux behavior
3340 this.lines
.shiftElements(this.y
+ this.ybase
, this.rows
- 1, 1);
3341 this.lines
.set(this.y
+ this.ybase
, this.blankLine(true));
3342 this.updateRange(this.scrollTop
);
3343 this.updateRange(this.scrollBottom
);
3347 this.state
= normal
;
3352 * ESC c Full Reset (RIS).
3354 Terminal
.prototype.reset = function() {
3355 this.options
.rows
= this.rows
;
3356 this.options
.cols
= this.cols
;
3357 var customKeydownHandler
= this.customKeydownHandler
;
3358 Terminal
.call(this, this.options
);
3359 this.customKeydownHandler
= customKeydownHandler
;
3360 this.queueRefresh(0, this.rows
- 1);
3361 this.viewport
.syncScrollArea();
3366 * ESC H Tab Set (HTS is 0x88).
3368 Terminal
.prototype.tabSet = function() {
3369 this.tabs
[this.x
] = true;
3370 this.state
= normal
;
3380 * Cursor Up Ps Times (default = 1) (CUU).
3382 Terminal
.prototype.cursorUp = function(params
) {
3383 var param
= params
[0];
3384 if (param
< 1) param
= 1;
3386 if (this.y
< 0) this.y
= 0;
3392 * Cursor Down Ps Times (default = 1) (CUD).
3394 Terminal
.prototype.cursorDown = function(params
) {
3395 var param
= params
[0];
3396 if (param
< 1) param
= 1;
3398 if (this.y
>= this.rows
) {
3399 this.y
= this.rows
- 1;
3406 * Cursor Forward Ps Times (default = 1) (CUF).
3408 Terminal
.prototype.cursorForward = function(params
) {
3409 var param
= params
[0];
3410 if (param
< 1) param
= 1;
3412 if (this.x
>= this.cols
) {
3413 this.x
= this.cols
- 1;
3420 * Cursor Backward Ps Times (default = 1) (CUB).
3422 Terminal
.prototype.cursorBackward = function(params
) {
3423 var param
= params
[0];
3424 if (param
< 1) param
= 1;
3426 if (this.x
< 0) this.x
= 0;
3432 * Cursor Position [row;column] (default = [1,1]) (CUP).
3434 Terminal
.prototype.cursorPos = function(params
) {
3437 row
= params
[0] - 1;
3439 if (params
.length
>= 2) {
3440 col
= params
[1] - 1;
3447 } else if (row
>= this.rows
) {
3448 row
= this.rows
- 1;
3453 } else if (col
>= this.cols
) {
3454 col
= this.cols
- 1;
3463 * CSI Ps J Erase in Display (ED).
3464 * Ps = 0 -> Erase Below (default).
3465 * Ps = 1 -> Erase Above.
3466 * Ps = 2 -> Erase All.
3467 * Ps = 3 -> Erase Saved Lines (xterm).
3469 * Erase in Display (DECSED).
3470 * Ps = 0 -> Selective Erase Below (default).
3471 * Ps = 1 -> Selective Erase Above.
3472 * Ps = 2 -> Selective Erase All.
3474 Terminal
.prototype.eraseInDisplay = function(params
) {
3476 switch (params
[0]) {
3478 this.eraseRight(this.x
, this.y
);
3480 for (; j
< this.rows
; j
++) {
3485 this.eraseLeft(this.x
, this.y
);
3493 while (j
--) this.eraseLine(j
);
3503 * CSI Ps K Erase in Line (EL).
3504 * Ps = 0 -> Erase to Right (default).
3505 * Ps = 1 -> Erase to Left.
3506 * Ps = 2 -> Erase All.
3508 * Erase in Line (DECSEL).
3509 * Ps = 0 -> Selective Erase to Right (default).
3510 * Ps = 1 -> Selective Erase to Left.
3511 * Ps = 2 -> Selective Erase All.
3513 Terminal
.prototype.eraseInLine = function(params
) {
3514 switch (params
[0]) {
3516 this.eraseRight(this.x
, this.y
);
3519 this.eraseLeft(this.x
, this.y
);
3522 this.eraseLine(this.y
);
3529 * CSI Pm m Character Attributes (SGR).
3530 * Ps = 0 -> Normal (default).
3532 * Ps = 4 -> Underlined.
3533 * Ps = 5 -> Blink (appears as Bold).
3534 * Ps = 7 -> Inverse.
3535 * Ps = 8 -> Invisible, i.e., hidden (VT300).
3536 * Ps = 2 2 -> Normal (neither bold nor faint).
3537 * Ps = 2 4 -> Not underlined.
3538 * Ps = 2 5 -> Steady (not blinking).
3539 * Ps = 2 7 -> Positive (not inverse).
3540 * Ps = 2 8 -> Visible, i.e., not hidden (VT300).
3541 * Ps = 3 0 -> Set foreground color to Black.
3542 * Ps = 3 1 -> Set foreground color to Red.
3543 * Ps = 3 2 -> Set foreground color to Green.
3544 * Ps = 3 3 -> Set foreground color to Yellow.
3545 * Ps = 3 4 -> Set foreground color to Blue.
3546 * Ps = 3 5 -> Set foreground color to Magenta.
3547 * Ps = 3 6 -> Set foreground color to Cyan.
3548 * Ps = 3 7 -> Set foreground color to White.
3549 * Ps = 3 9 -> Set foreground color to default (original).
3550 * Ps = 4 0 -> Set background color to Black.
3551 * Ps = 4 1 -> Set background color to Red.
3552 * Ps = 4 2 -> Set background color to Green.
3553 * Ps = 4 3 -> Set background color to Yellow.
3554 * Ps = 4 4 -> Set background color to Blue.
3555 * Ps = 4 5 -> Set background color to Magenta.
3556 * Ps = 4 6 -> Set background color to Cyan.
3557 * Ps = 4 7 -> Set background color to White.
3558 * Ps = 4 9 -> Set background color to default (original).
3560 * If 16-color support is compiled, the following apply. Assume
3561 * that xterm's resources are set so that the ISO color codes are
3562 * the first 8 of a set of 16. Then the aixterm colors are the
3563 * bright versions of the ISO colors:
3564 * Ps = 9 0 -> Set foreground color to Black.
3565 * Ps = 9 1 -> Set foreground color to Red.
3566 * Ps = 9 2 -> Set foreground color to Green.
3567 * Ps = 9 3 -> Set foreground color to Yellow.
3568 * Ps = 9 4 -> Set foreground color to Blue.
3569 * Ps = 9 5 -> Set foreground color to Magenta.
3570 * Ps = 9 6 -> Set foreground color to Cyan.
3571 * Ps = 9 7 -> Set foreground color to White.
3572 * Ps = 1 0 0 -> Set background color to Black.
3573 * Ps = 1 0 1 -> Set background color to Red.
3574 * Ps = 1 0 2 -> Set background color to Green.
3575 * Ps = 1 0 3 -> Set background color to Yellow.
3576 * Ps = 1 0 4 -> Set background color to Blue.
3577 * Ps = 1 0 5 -> Set background color to Magenta.
3578 * Ps = 1 0 6 -> Set background color to Cyan.
3579 * Ps = 1 0 7 -> Set background color to White.
3581 * If xterm is compiled with the 16-color support disabled, it
3582 * supports the following, from rxvt:
3583 * Ps = 1 0 0 -> Set foreground and background color to
3586 * If 88- or 256-color support is compiled, the following apply.
3587 * Ps = 3 8 ; 5 ; Ps -> Set foreground color to the second
3589 * Ps = 4 8 ; 5 ; Ps -> Set background color to the second
3592 Terminal
.prototype.charAttributes = function(params
) {
3593 // Optimize a single SGR0.
3594 if (params
.length
=== 1 && params
[0] === 0) {
3595 this.curAttr
= this.defAttr
;
3599 var l
= params
.length
3601 , flags
= this.curAttr
>> 18
3602 , fg
= (this.curAttr
>> 9) & 0x1ff
3603 , bg
= this.curAttr
& 0x1ff
3606 for (; i
< l
; i
++) {
3608 if (p
>= 30 && p
<= 37) {
3611 } else if (p
>= 40 && p
<= 47) {
3614 } else if (p
>= 90 && p
<= 97) {
3618 } else if (p
>= 100 && p
<= 107) {
3622 } else if (p
=== 0) {
3624 flags
= this.defAttr
>> 18;
3625 fg
= (this.defAttr
>> 9) & 0x1ff;
3626 bg
= this.defAttr
& 0x1ff;
3630 } else if (p
=== 1) {
3633 } else if (p
=== 4) {
3636 } else if (p
=== 5) {
3639 } else if (p
=== 7) {
3640 // inverse and positive
3641 // test with: echo -e '\e[31m\e[42mhello\e[7mworld\e[27mhi\e[m'
3643 } else if (p
=== 8) {
3646 } else if (p
=== 22) {
3649 } else if (p
=== 24) {
3652 } else if (p
=== 25) {
3655 } else if (p
=== 27) {
3658 } else if (p
=== 28) {
3661 } else if (p
=== 39) {
3663 fg
= (this.defAttr
>> 9) & 0x1ff;
3664 } else if (p
=== 49) {
3666 bg
= this.defAttr
& 0x1ff;
3667 } else if (p
=== 38) {
3669 if (params
[i
+ 1] === 2) {
3673 params
[i
+ 1] & 0xff,
3674 params
[i
+ 2] & 0xff);
3675 if (fg
=== -1) fg
= 0x1ff;
3677 } else if (params
[i
+ 1] === 5) {
3679 p
= params
[i
] & 0xff;
3682 } else if (p
=== 48) {
3684 if (params
[i
+ 1] === 2) {
3688 params
[i
+ 1] & 0xff,
3689 params
[i
+ 2] & 0xff);
3690 if (bg
=== -1) bg
= 0x1ff;
3692 } else if (params
[i
+ 1] === 5) {
3694 p
= params
[i
] & 0xff;
3697 } else if (p
=== 100) {
3699 fg
= (this.defAttr
>> 9) & 0x1ff;
3700 bg
= this.defAttr
& 0x1ff;
3702 this.error('Unknown SGR attribute: %d.', p
);
3706 this.curAttr
= (flags
<< 18) | (fg
<< 9) | bg
;
3711 * CSI Ps n Device Status Report (DSR).
3712 * Ps = 5 -> Status Report. Result (``OK'') is
3714 * Ps = 6 -> Report Cursor Position (CPR) [row;column].
3718 * Device Status Report (DSR, DEC-specific).
3719 * Ps = 6 -> Report Cursor Position (CPR) [row;column] as CSI
3720 * ? r ; c R (assumes page is zero).
3721 * Ps = 1 5 -> Report Printer status as CSI ? 1 0 n (ready).
3722 * or CSI ? 1 1 n (not ready).
3723 * Ps = 2 5 -> Report UDK status as CSI ? 2 0 n (unlocked)
3724 * or CSI ? 2 1 n (locked).
3725 * Ps = 2 6 -> Report Keyboard status as
3726 * CSI ? 2 7 ; 1 ; 0 ; 0 n (North American).
3727 * The last two parameters apply to VT400 & up, and denote key-
3728 * board ready and LK01 respectively.
3729 * Ps = 5 3 -> Report Locator status as
3730 * CSI ? 5 3 n Locator available, if compiled-in, or
3731 * CSI ? 5 0 n No Locator, if not.
3733 Terminal
.prototype.deviceStatus = function(params
) {
3735 switch (params
[0]) {
3738 this.send(C0
.ESC
+ '[0n');
3742 this.send(C0
.ESC
+ '['
3749 } else if (this.prefix
=== '?') {
3750 // modern xterm doesnt seem to
3751 // respond to any of these except ?6, 6, and 5
3752 switch (params
[0]) {
3755 this.send(C0
.ESC
+ '[?'
3763 // this.send(C0.ESC + '[?11n');
3766 // dont support user defined keys
3767 // this.send(C0.ESC + '[?21n');
3770 // north american keyboard
3771 // this.send(C0.ESC + '[?27;1;0;0n');
3774 // no dec locator/mouse
3775 // this.send(C0.ESC + '[?50n');
3788 * Insert Ps (Blank) Character(s) (default = 1) (ICH).
3790 Terminal
.prototype.insertChars = function(params
) {
3791 var param
, row
, j
, ch
;
3794 if (param
< 1) param
= 1;
3796 row
= this.y
+ this.ybase
;
3798 ch
= [this.eraseAttr(), ' ', 1]; // xterm
3800 while (param
-- && j
< this.cols
) {
3801 this.lines
.get(row
).splice(j
++, 0, ch
);
3802 this.lines
.get(row
).pop();
3808 * Cursor Next Line Ps Times (default = 1) (CNL).
3809 * same as CSI Ps B ?
3811 Terminal
.prototype.cursorNextLine = function(params
) {
3812 var param
= params
[0];
3813 if (param
< 1) param
= 1;
3815 if (this.y
>= this.rows
) {
3816 this.y
= this.rows
- 1;
3824 * Cursor Preceding Line Ps Times (default = 1) (CNL).
3827 Terminal
.prototype.cursorPrecedingLine = function(params
) {
3828 var param
= params
[0];
3829 if (param
< 1) param
= 1;
3831 if (this.y
< 0) this.y
= 0;
3838 * Cursor Character Absolute [column] (default = [row,1]) (CHA).
3840 Terminal
.prototype.cursorCharAbsolute = function(params
) {
3841 var param
= params
[0];
3842 if (param
< 1) param
= 1;
3849 * Insert Ps Line(s) (default = 1) (IL).
3851 Terminal
.prototype.insertLines = function(params
) {
3855 if (param
< 1) param
= 1;
3856 row
= this.y
+ this.ybase
;
3858 j
= this.rows
- 1 - this.scrollBottom
;
3859 j
= this.rows
- 1 + this.ybase
- j
+ 1;
3862 if (this.lines
.length
=== this.lines
.maxLength
) {
3863 // Trim the start of lines to make room for the new line
3864 this.lines
.trimStart(1);
3870 // test: echo -e '\e[44m\e[1L\e[0m'
3871 // blankLine(true) - xterm/linux behavior
3872 this.lines
.splice(row
, 0, this.blankLine(true));
3873 this.lines
.splice(j
, 1);
3877 this.updateRange(this.y
);
3878 this.updateRange(this.scrollBottom
);
3884 * Delete Ps Line(s) (default = 1) (DL).
3886 Terminal
.prototype.deleteLines = function(params
) {
3890 if (param
< 1) param
= 1;
3891 row
= this.y
+ this.ybase
;
3893 j
= this.rows
- 1 - this.scrollBottom
;
3894 j
= this.rows
- 1 + this.ybase
- j
;
3897 if (this.lines
.length
=== this.lines
.maxLength
) {
3898 // Trim the start of lines to make room for the new line
3899 this.lines
.trimStart(1);
3903 // test: echo -e '\e[44m\e[1M\e[0m'
3904 // blankLine(true) - xterm/linux behavior
3905 this.lines
.splice(j
+ 1, 0, this.blankLine(true));
3906 this.lines
.splice(row
, 1);
3910 this.updateRange(this.y
);
3911 this.updateRange(this.scrollBottom
);
3917 * Delete Ps Character(s) (default = 1) (DCH).
3919 Terminal
.prototype.deleteChars = function(params
) {
3923 if (param
< 1) param
= 1;
3925 row
= this.y
+ this.ybase
;
3926 ch
= [this.eraseAttr(), ' ', 1]; // xterm
3929 this.lines
.get(row
).splice(this.x
, 1);
3930 this.lines
.get(row
).push(ch
);
3936 * Erase Ps Character(s) (default = 1) (ECH).
3938 Terminal
.prototype.eraseChars = function(params
) {
3939 var param
, row
, j
, ch
;
3942 if (param
< 1) param
= 1;
3944 row
= this.y
+ this.ybase
;
3946 ch
= [this.eraseAttr(), ' ', 1]; // xterm
3948 while (param
-- && j
< this.cols
) {
3949 this.lines
.get(row
)[j
++] = ch
;
3954 * CSI Pm ` Character Position Absolute
3955 * [column] (default = [row,1]) (HPA).
3957 Terminal
.prototype.charPosAbsolute = function(params
) {
3958 var param
= params
[0];
3959 if (param
< 1) param
= 1;
3961 if (this.x
>= this.cols
) {
3962 this.x
= this.cols
- 1;
3969 * Horizontal Position Relative
3972 Terminal
.prototype.HPositionRelative = function(params
) {
3973 var param
= params
[0];
3974 if (param
< 1) param
= 1;
3976 if (this.x
>= this.cols
) {
3977 this.x
= this.cols
- 1;
3983 * CSI Ps c Send Device Attributes (Primary DA).
3984 * Ps = 0 or omitted -> request attributes from terminal. The
3985 * response depends on the decTerminalID resource setting.
3986 * -> CSI ? 1 ; 2 c (``VT100 with Advanced Video Option'')
3987 * -> CSI ? 1 ; 0 c (``VT101 with No Options'')
3988 * -> CSI ? 6 c (``VT102'')
3989 * -> CSI ? 6 0 ; 1 ; 2 ; 6 ; 8 ; 9 ; 1 5 ; c (``VT220'')
3990 * The VT100-style response parameters do not mean anything by
3991 * themselves. VT220 parameters do, telling the host what fea-
3992 * tures the terminal supports:
3993 * Ps = 1 -> 132-columns.
3994 * Ps = 2 -> Printer.
3995 * Ps = 6 -> Selective erase.
3996 * Ps = 8 -> User-defined keys.
3997 * Ps = 9 -> National replacement character sets.
3998 * Ps = 1 5 -> Technical characters.
3999 * Ps = 2 2 -> ANSI color, e.g., VT525.
4000 * Ps = 2 9 -> ANSI text locator (i.e., DEC Locator mode).
4002 * Send Device Attributes (Secondary DA).
4003 * Ps = 0 or omitted -> request the terminal's identification
4004 * code. The response depends on the decTerminalID resource set-
4005 * ting. It should apply only to VT220 and up, but xterm extends
4007 * -> CSI > Pp ; Pv ; Pc c
4008 * where Pp denotes the terminal type
4009 * Pp = 0 -> ``VT100''.
4010 * Pp = 1 -> ``VT220''.
4011 * and Pv is the firmware version (for xterm, this was originally
4012 * the XFree86 patch number, starting with 95). In a DEC termi-
4013 * nal, Pc indicates the ROM cartridge registration number and is
4016 * xterm/charproc.c - line 2012, for more information.
4017 * vim responds with ^[[?0c or ^[[?1c after the terminal's response (?)
4019 Terminal
.prototype.sendDeviceAttributes = function(params
) {
4020 if (params
[0] > 0) return;
4023 if (this.is('xterm')
4024 || this.is('rxvt-unicode')
4025 || this.is('screen')) {
4026 this.send(C0
.ESC
+ '[?1;2c');
4027 } else if (this.is('linux')) {
4028 this.send(C0
.ESC
+ '[?6c');
4030 } else if (this.prefix
=== '>') {
4032 // seem to spit this
4033 // out around ~370 times (?).
4034 if (this.is('xterm')) {
4035 this.send(C0
.ESC
+ '[>0;276;0c');
4036 } else if (this.is('rxvt-unicode')) {
4037 this.send(C0
.ESC
+ '[>85;95;0c');
4038 } else if (this.is('linux')) {
4039 // not supported by linux console.
4040 // linux console echoes parameters.
4041 this.send(params
[0] + 'c');
4042 } else if (this.is('screen')) {
4043 this.send(C0
.ESC
+ '[>83;40003;0c');
4051 * Line Position Absolute [row] (default = [1,column]) (VPA).
4053 Terminal
.prototype.linePosAbsolute = function(params
) {
4054 var param
= params
[0];
4055 if (param
< 1) param
= 1;
4057 if (this.y
>= this.rows
) {
4058 this.y
= this.rows
- 1;
4064 * 145 65 e * VPR - Vertical Position Relative
4067 Terminal
.prototype.VPositionRelative = function(params
) {
4068 var param
= params
[0];
4069 if (param
< 1) param
= 1;
4071 if (this.y
>= this.rows
) {
4072 this.y
= this.rows
- 1;
4079 * Horizontal and Vertical Position [row;column] (default =
4082 Terminal
.prototype.HVPosition = function(params
) {
4083 if (params
[0] < 1) params
[0] = 1;
4084 if (params
[1] < 1) params
[1] = 1;
4086 this.y
= params
[0] - 1;
4087 if (this.y
>= this.rows
) {
4088 this.y
= this.rows
- 1;
4091 this.x
= params
[1] - 1;
4092 if (this.x
>= this.cols
) {
4093 this.x
= this.cols
- 1;
4099 * CSI Pm h Set Mode (SM).
4100 * Ps = 2 -> Keyboard Action Mode (AM).
4101 * Ps = 4 -> Insert Mode (IRM).
4102 * Ps = 1 2 -> Send/receive (SRM).
4103 * Ps = 2 0 -> Automatic Newline (LNM).
4105 * DEC Private Mode Set (DECSET).
4106 * Ps = 1 -> Application Cursor Keys (DECCKM).
4107 * Ps = 2 -> Designate USASCII for character sets G0-G3
4108 * (DECANM), and set VT100 mode.
4109 * Ps = 3 -> 132 Column Mode (DECCOLM).
4110 * Ps = 4 -> Smooth (Slow) Scroll (DECSCLM).
4111 * Ps = 5 -> Reverse Video (DECSCNM).
4112 * Ps = 6 -> Origin Mode (DECOM).
4113 * Ps = 7 -> Wraparound Mode (DECAWM).
4114 * Ps = 8 -> Auto-repeat Keys (DECARM).
4115 * Ps = 9 -> Send Mouse X & Y on button press. See the sec-
4116 * tion Mouse Tracking.
4117 * Ps = 1 0 -> Show toolbar (rxvt).
4118 * Ps = 1 2 -> Start Blinking Cursor (att610).
4119 * Ps = 1 8 -> Print form feed (DECPFF).
4120 * Ps = 1 9 -> Set print extent to full screen (DECPEX).
4121 * Ps = 2 5 -> Show Cursor (DECTCEM).
4122 * Ps = 3 0 -> Show scrollbar (rxvt).
4123 * Ps = 3 5 -> Enable font-shifting functions (rxvt).
4124 * Ps = 3 8 -> Enter Tektronix Mode (DECTEK).
4125 * Ps = 4 0 -> Allow 80 -> 132 Mode.
4126 * Ps = 4 1 -> more(1) fix (see curses resource).
4127 * Ps = 4 2 -> Enable Nation Replacement Character sets (DECN-
4129 * Ps = 4 4 -> Turn On Margin Bell.
4130 * Ps = 4 5 -> Reverse-wraparound Mode.
4131 * Ps = 4 6 -> Start Logging. This is normally disabled by a
4132 * compile-time option.
4133 * Ps = 4 7 -> Use Alternate Screen Buffer. (This may be dis-
4134 * abled by the titeInhibit resource).
4135 * Ps = 6 6 -> Application keypad (DECNKM).
4136 * Ps = 6 7 -> Backarrow key sends backspace (DECBKM).
4137 * Ps = 1 0 0 0 -> Send Mouse X & Y on button press and
4138 * release. See the section Mouse Tracking.
4139 * Ps = 1 0 0 1 -> Use Hilite Mouse Tracking.
4140 * Ps = 1 0 0 2 -> Use Cell Motion Mouse Tracking.
4141 * Ps = 1 0 0 3 -> Use All Motion Mouse Tracking.
4142 * Ps = 1 0 0 4 -> Send FocusIn/FocusOut events.
4143 * Ps = 1 0 0 5 -> Enable Extended Mouse Mode.
4144 * Ps = 1 0 1 0 -> Scroll to bottom on tty output (rxvt).
4145 * Ps = 1 0 1 1 -> Scroll to bottom on key press (rxvt).
4146 * Ps = 1 0 3 4 -> Interpret "meta" key, sets eighth bit.
4147 * (enables the eightBitInput resource).
4148 * Ps = 1 0 3 5 -> Enable special modifiers for Alt and Num-
4149 * Lock keys. (This enables the numLock resource).
4150 * Ps = 1 0 3 6 -> Send ESC when Meta modifies a key. (This
4151 * enables the metaSendsEscape resource).
4152 * Ps = 1 0 3 7 -> Send DEL from the editing-keypad Delete
4154 * Ps = 1 0 3 9 -> Send ESC when Alt modifies a key. (This
4155 * enables the altSendsEscape resource).
4156 * Ps = 1 0 4 0 -> Keep selection even if not highlighted.
4157 * (This enables the keepSelection resource).
4158 * Ps = 1 0 4 1 -> Use the CLIPBOARD selection. (This enables
4159 * the selectToClipboard resource).
4160 * Ps = 1 0 4 2 -> Enable Urgency window manager hint when
4161 * Control-G is received. (This enables the bellIsUrgent
4163 * Ps = 1 0 4 3 -> Enable raising of the window when Control-G
4164 * is received. (enables the popOnBell resource).
4165 * Ps = 1 0 4 7 -> Use Alternate Screen Buffer. (This may be
4166 * disabled by the titeInhibit resource).
4167 * Ps = 1 0 4 8 -> Save cursor as in DECSC. (This may be dis-
4168 * abled by the titeInhibit resource).
4169 * Ps = 1 0 4 9 -> Save cursor as in DECSC and use Alternate
4170 * Screen Buffer, clearing it first. (This may be disabled by
4171 * the titeInhibit resource). This combines the effects of the 1
4172 * 0 4 7 and 1 0 4 8 modes. Use this with terminfo-based
4173 * applications rather than the 4 7 mode.
4174 * Ps = 1 0 5 0 -> Set terminfo/termcap function-key mode.
4175 * Ps = 1 0 5 1 -> Set Sun function-key mode.
4176 * Ps = 1 0 5 2 -> Set HP function-key mode.
4177 * Ps = 1 0 5 3 -> Set SCO function-key mode.
4178 * Ps = 1 0 6 0 -> Set legacy keyboard emulation (X11R6).
4179 * Ps = 1 0 6 1 -> Set VT220 keyboard emulation.
4180 * Ps = 2 0 0 4 -> Set bracketed paste mode.
4182 * http: *vt100.net/docs/vt220-rm/chapter4.html
4184 Terminal
.prototype.setMode = function(params
) {
4185 if (typeof params
=== 'object') {
4186 var l
= params
.length
4189 for (; i
< l
; i
++) {
4190 this.setMode(params
[i
]);
4199 this.insertMode
= true;
4202 //this.convertEol = true;
4205 } else if (this.prefix
=== '?') {
4208 this.applicationCursor
= true;
4211 this.setgCharset(0, Terminal
.charsets
.US
);
4212 this.setgCharset(1, Terminal
.charsets
.US
);
4213 this.setgCharset(2, Terminal
.charsets
.US
);
4214 this.setgCharset(3, Terminal
.charsets
.US
);
4215 // set VT100 mode here
4217 case 3: // 132 col mode
4218 this.savedCols
= this.cols
;
4219 this.resize(132, this.rows
);
4222 this.originMode
= true;
4225 this.wraparoundMode
= true;
4228 // this.cursorBlink = true;
4231 this.log('Serial port requested application keypad.');
4232 this.applicationKeypad
= true;
4233 this.viewport
.syncScrollArea();
4235 case 9: // X10 Mouse
4236 // no release, no motion, no wheel, no modifiers.
4237 case 1000: // vt200 mouse
4239 // no modifiers, except control on the wheel.
4240 case 1002: // button event mouse
4241 case 1003: // any event mouse
4242 // any event - sends motion events,
4243 // even if there is no button held down.
4244 this.x10Mouse
= params
=== 9;
4245 this.vt200Mouse
= params
=== 1000;
4246 this.normalMouse
= params
> 1000;
4247 this.mouseEvents
= true;
4248 this.element
.style
.cursor
= 'default';
4249 this.log('Binding to mouse events.');
4251 case 1004: // send focusin/focusout events
4254 this.sendFocus
= true;
4256 case 1005: // utf8 ext mode mouse
4257 this.utfMouse
= true;
4258 // for wide terminals
4259 // simply encodes large values as utf8 characters
4261 case 1006: // sgr ext mode mouse
4262 this.sgrMouse
= true;
4263 // for wide terminals
4264 // does not add 32 to fields
4265 // press: ^[[<b;x;yM
4266 // release: ^[[<b;x;ym
4268 case 1015: // urxvt ext mode mouse
4269 this.urxvtMouse
= true;
4270 // for wide terminals
4271 // numbers for fields
4273 // motion: ^[[b;x;yT
4275 case 25: // show cursor
4276 this.cursorHidden
= false;
4278 case 1049: // alt screen buffer cursor
4279 //this.saveCursor();
4281 case 47: // alt screen buffer
4282 case 1047: // alt screen buffer
4290 scrollTop
: this.scrollTop
,
4291 scrollBottom
: this.scrollBottom
,
4293 // XXX save charset(s) here?
4294 // charset: this.charset,
4295 // glevel: this.glevel,
4296 // charsets: this.charsets
4299 this.viewport
.syncScrollArea();
4300 this.normal
= normal
;
4309 * CSI Pm l Reset Mode (RM).
4310 * Ps = 2 -> Keyboard Action Mode (AM).
4311 * Ps = 4 -> Replace Mode (IRM).
4312 * Ps = 1 2 -> Send/receive (SRM).
4313 * Ps = 2 0 -> Normal Linefeed (LNM).
4315 * DEC Private Mode Reset (DECRST).
4316 * Ps = 1 -> Normal Cursor Keys (DECCKM).
4317 * Ps = 2 -> Designate VT52 mode (DECANM).
4318 * Ps = 3 -> 80 Column Mode (DECCOLM).
4319 * Ps = 4 -> Jump (Fast) Scroll (DECSCLM).
4320 * Ps = 5 -> Normal Video (DECSCNM).
4321 * Ps = 6 -> Normal Cursor Mode (DECOM).
4322 * Ps = 7 -> No Wraparound Mode (DECAWM).
4323 * Ps = 8 -> No Auto-repeat Keys (DECARM).
4324 * Ps = 9 -> Don't send Mouse X & Y on button press.
4325 * Ps = 1 0 -> Hide toolbar (rxvt).
4326 * Ps = 1 2 -> Stop Blinking Cursor (att610).
4327 * Ps = 1 8 -> Don't print form feed (DECPFF).
4328 * Ps = 1 9 -> Limit print to scrolling region (DECPEX).
4329 * Ps = 2 5 -> Hide Cursor (DECTCEM).
4330 * Ps = 3 0 -> Don't show scrollbar (rxvt).
4331 * Ps = 3 5 -> Disable font-shifting functions (rxvt).
4332 * Ps = 4 0 -> Disallow 80 -> 132 Mode.
4333 * Ps = 4 1 -> No more(1) fix (see curses resource).
4334 * Ps = 4 2 -> Disable Nation Replacement Character sets (DEC-
4336 * Ps = 4 4 -> Turn Off Margin Bell.
4337 * Ps = 4 5 -> No Reverse-wraparound Mode.
4338 * Ps = 4 6 -> Stop Logging. (This is normally disabled by a
4339 * compile-time option).
4340 * Ps = 4 7 -> Use Normal Screen Buffer.
4341 * Ps = 6 6 -> Numeric keypad (DECNKM).
4342 * Ps = 6 7 -> Backarrow key sends delete (DECBKM).
4343 * Ps = 1 0 0 0 -> Don't send Mouse X & Y on button press and
4344 * release. See the section Mouse Tracking.
4345 * Ps = 1 0 0 1 -> Don't use Hilite Mouse Tracking.
4346 * Ps = 1 0 0 2 -> Don't use Cell Motion Mouse Tracking.
4347 * Ps = 1 0 0 3 -> Don't use All Motion Mouse Tracking.
4348 * Ps = 1 0 0 4 -> Don't send FocusIn/FocusOut events.
4349 * Ps = 1 0 0 5 -> Disable Extended Mouse Mode.
4350 * Ps = 1 0 1 0 -> Don't scroll to bottom on tty output
4352 * Ps = 1 0 1 1 -> Don't scroll to bottom on key press (rxvt).
4353 * Ps = 1 0 3 4 -> Don't interpret "meta" key. (This disables
4354 * the eightBitInput resource).
4355 * Ps = 1 0 3 5 -> Disable special modifiers for Alt and Num-
4356 * Lock keys. (This disables the numLock resource).
4357 * Ps = 1 0 3 6 -> Don't send ESC when Meta modifies a key.
4358 * (This disables the metaSendsEscape resource).
4359 * Ps = 1 0 3 7 -> Send VT220 Remove from the editing-keypad
4361 * Ps = 1 0 3 9 -> Don't send ESC when Alt modifies a key.
4362 * (This disables the altSendsEscape resource).
4363 * Ps = 1 0 4 0 -> Do not keep selection when not highlighted.
4364 * (This disables the keepSelection resource).
4365 * Ps = 1 0 4 1 -> Use the PRIMARY selection. (This disables
4366 * the selectToClipboard resource).
4367 * Ps = 1 0 4 2 -> Disable Urgency window manager hint when
4368 * Control-G is received. (This disables the bellIsUrgent
4370 * Ps = 1 0 4 3 -> Disable raising of the window when Control-
4371 * G is received. (This disables the popOnBell resource).
4372 * Ps = 1 0 4 7 -> Use Normal Screen Buffer, clearing screen
4373 * first if in the Alternate Screen. (This may be disabled by
4374 * the titeInhibit resource).
4375 * Ps = 1 0 4 8 -> Restore cursor as in DECRC. (This may be
4376 * disabled by the titeInhibit resource).
4377 * Ps = 1 0 4 9 -> Use Normal Screen Buffer and restore cursor
4378 * as in DECRC. (This may be disabled by the titeInhibit
4379 * resource). This combines the effects of the 1 0 4 7 and 1 0
4380 * 4 8 modes. Use this with terminfo-based applications rather
4381 * than the 4 7 mode.
4382 * Ps = 1 0 5 0 -> Reset terminfo/termcap function-key mode.
4383 * Ps = 1 0 5 1 -> Reset Sun function-key mode.
4384 * Ps = 1 0 5 2 -> Reset HP function-key mode.
4385 * Ps = 1 0 5 3 -> Reset SCO function-key mode.
4386 * Ps = 1 0 6 0 -> Reset legacy keyboard emulation (X11R6).
4387 * Ps = 1 0 6 1 -> Reset keyboard emulation to Sun/PC style.
4388 * Ps = 2 0 0 4 -> Reset bracketed paste mode.
4390 Terminal
.prototype.resetMode = function(params
) {
4391 if (typeof params
=== 'object') {
4392 var l
= params
.length
4395 for (; i
< l
; i
++) {
4396 this.resetMode(params
[i
]);
4405 this.insertMode
= false;
4408 //this.convertEol = false;
4411 } else if (this.prefix
=== '?') {
4414 this.applicationCursor
= false;
4417 if (this.cols
=== 132 && this.savedCols
) {
4418 this.resize(this.savedCols
, this.rows
);
4420 delete this.savedCols
;
4423 this.originMode
= false;
4426 this.wraparoundMode
= false;
4429 // this.cursorBlink = false;
4432 this.log('Switching back to normal keypad.');
4433 this.applicationKeypad
= false;
4434 this.viewport
.syncScrollArea();
4436 case 9: // X10 Mouse
4437 case 1000: // vt200 mouse
4438 case 1002: // button event mouse
4439 case 1003: // any event mouse
4440 this.x10Mouse
= false;
4441 this.vt200Mouse
= false;
4442 this.normalMouse
= false;
4443 this.mouseEvents
= false;
4444 this.element
.style
.cursor
= '';
4446 case 1004: // send focusin/focusout events
4447 this.sendFocus
= false;
4449 case 1005: // utf8 ext mode mouse
4450 this.utfMouse
= false;
4452 case 1006: // sgr ext mode mouse
4453 this.sgrMouse
= false;
4455 case 1015: // urxvt ext mode mouse
4456 this.urxvtMouse
= false;
4458 case 25: // hide cursor
4459 this.cursorHidden
= true;
4461 case 1049: // alt screen buffer cursor
4463 case 47: // normal screen buffer
4464 case 1047: // normal screen buffer - clearing it first
4466 this.lines
= this.normal
.lines
;
4467 this.ybase
= this.normal
.ybase
;
4468 this.ydisp
= this.normal
.ydisp
;
4469 this.x
= this.normal
.x
;
4470 this.y
= this.normal
.y
;
4471 this.scrollTop
= this.normal
.scrollTop
;
4472 this.scrollBottom
= this.normal
.scrollBottom
;
4473 this.tabs
= this.normal
.tabs
;
4475 // if (params === 1049) {
4476 // this.x = this.savedX;
4477 // this.y = this.savedY;
4479 this.queueRefresh(0, this.rows
- 1);
4480 this.viewport
.syncScrollArea();
4491 * Set Scrolling Region [top;bottom] (default = full size of win-
4495 Terminal
.prototype.setScrollRegion = function(params
) {
4496 if (this.prefix
) return;
4497 this.scrollTop
= (params
[0] || 1) - 1;
4498 this.scrollBottom
= (params
[1] || this.rows
) - 1;
4506 * Save cursor (ANSI.SYS).
4508 Terminal
.prototype.saveCursor = function(params
) {
4509 this.savedX
= this.x
;
4510 this.savedY
= this.y
;
4516 * Restore cursor (ANSI.SYS).
4518 Terminal
.prototype.restoreCursor = function(params
) {
4519 this.x
= this.savedX
|| 0;
4520 this.y
= this.savedY
|| 0;
4530 * Cursor Forward Tabulation Ps tab stops (default = 1) (CHT).
4532 Terminal
.prototype.cursorForwardTab = function(params
) {
4533 var param
= params
[0] || 1;
4535 this.x
= this.nextStop();
4541 * CSI Ps S Scroll up Ps lines (default = 1) (SU).
4543 Terminal
.prototype.scrollUp = function(params
) {
4544 var param
= params
[0] || 1;
4546 this.lines
.splice(this.ybase
+ this.scrollTop
, 1);
4547 this.lines
.splice(this.ybase
+ this.scrollBottom
, 0, this.blankLine());
4550 this.updateRange(this.scrollTop
);
4551 this.updateRange(this.scrollBottom
);
4556 * CSI Ps T Scroll down Ps lines (default = 1) (SD).
4558 Terminal
.prototype.scrollDown = function(params
) {
4559 var param
= params
[0] || 1;
4561 this.lines
.splice(this.ybase
+ this.scrollBottom
, 1);
4562 this.lines
.splice(this.ybase
+ this.scrollTop
, 0, this.blankLine());
4565 this.updateRange(this.scrollTop
);
4566 this.updateRange(this.scrollBottom
);
4571 * CSI Ps ; Ps ; Ps ; Ps ; Ps T
4572 * Initiate highlight mouse tracking. Parameters are
4573 * [func;startx;starty;firstrow;lastrow]. See the section Mouse
4576 Terminal
.prototype.initMouseTracking = function(params
) {
4577 // Relevant: DECSET 1001
4583 * Reset one or more features of the title modes to the default
4584 * value. Normally, "reset" disables the feature. It is possi-
4585 * ble to disable the ability to reset features by compiling a
4586 * different default for the title modes into xterm.
4587 * Ps = 0 -> Do not set window/icon labels using hexadecimal.
4588 * Ps = 1 -> Do not query window/icon labels using hexadeci-
4590 * Ps = 2 -> Do not set window/icon labels using UTF-8.
4591 * Ps = 3 -> Do not query window/icon labels using UTF-8.
4592 * (See discussion of "Title Modes").
4594 Terminal
.prototype.resetTitleModes = function(params
) {
4600 * CSI Ps Z Cursor Backward Tabulation Ps tab stops (default = 1) (CBT).
4602 Terminal
.prototype.cursorBackwardTab = function(params
) {
4603 var param
= params
[0] || 1;
4605 this.x
= this.prevStop();
4611 * CSI Ps b Repeat the preceding graphic character Ps times (REP).
4613 Terminal
.prototype.repeatPrecedingCharacter = function(params
) {
4614 var param
= params
[0] || 1
4615 , line
= this.lines
.get(this.ybase
+ this.y
)
4616 , ch
= line
[this.x
- 1] || [this.defAttr
, ' ', 1];
4618 while (param
--) line
[this.x
++] = ch
;
4623 * CSI Ps g Tab Clear (TBC).
4624 * Ps = 0 -> Clear Current Column (default).
4625 * Ps = 3 -> Clear All.
4627 * Ps = 2 -> Clear Stops on Line.
4628 * http://vt100.net/annarbor/aaa-ug/section6.html
4630 Terminal
.prototype.tabClear = function(params
) {
4631 var param
= params
[0];
4633 delete this.tabs
[this.x
];
4634 } else if (param
=== 3) {
4641 * CSI Pm i Media Copy (MC).
4642 * Ps = 0 -> Print screen (default).
4643 * Ps = 4 -> Turn off printer controller mode.
4644 * Ps = 5 -> Turn on printer controller mode.
4646 * Media Copy (MC, DEC-specific).
4647 * Ps = 1 -> Print line containing cursor.
4648 * Ps = 4 -> Turn off autoprint mode.
4649 * Ps = 5 -> Turn on autoprint mode.
4650 * Ps = 1 0 -> Print composed display, ignores DECPEX.
4651 * Ps = 1 1 -> Print all pages.
4653 Terminal
.prototype.mediaCopy = function(params
) {
4660 * Set or reset resource-values used by xterm to decide whether
4661 * to construct escape sequences holding information about the
4662 * modifiers pressed with a given key. The first parameter iden-
4663 * tifies the resource to set/reset. The second parameter is the
4664 * value to assign to the resource. If the second parameter is
4665 * omitted, the resource is reset to its initial value.
4666 * Ps = 1 -> modifyCursorKeys.
4667 * Ps = 2 -> modifyFunctionKeys.
4668 * Ps = 4 -> modifyOtherKeys.
4669 * If no parameters are given, all resources are reset to their
4672 Terminal
.prototype.setResources = function(params
) {
4679 * Disable modifiers which may be enabled via the CSI > Ps; Ps m
4680 * sequence. This corresponds to a resource value of "-1", which
4681 * cannot be set with the other sequence. The parameter identi-
4682 * fies the resource to be disabled:
4683 * Ps = 1 -> modifyCursorKeys.
4684 * Ps = 2 -> modifyFunctionKeys.
4685 * Ps = 4 -> modifyOtherKeys.
4686 * If the parameter is omitted, modifyFunctionKeys is disabled.
4687 * When modifyFunctionKeys is disabled, xterm uses the modifier
4688 * keys to make an extended sequence of functions rather than
4689 * adding a parameter to each function key to denote the modi-
4692 Terminal
.prototype.disableModifiers = function(params
) {
4699 * Set resource value pointerMode. This is used by xterm to
4700 * decide whether to hide the pointer cursor as the user types.
4701 * Valid values for the parameter:
4702 * Ps = 0 -> never hide the pointer.
4703 * Ps = 1 -> hide if the mouse tracking mode is not enabled.
4704 * Ps = 2 -> always hide the pointer. If no parameter is
4705 * given, xterm uses the default, which is 1 .
4707 Terminal
.prototype.setPointerMode = function(params
) {
4713 * CSI ! p Soft terminal reset (DECSTR).
4714 * http://vt100.net/docs/vt220-rm/table4-10.html
4716 Terminal
.prototype.softReset = function(params
) {
4717 this.cursorHidden
= false;
4718 this.insertMode
= false;
4719 this.originMode
= false;
4720 this.wraparoundMode
= false; // autowrap
4721 this.applicationKeypad
= false; // ?
4722 this.viewport
.syncScrollArea();
4723 this.applicationCursor
= false;
4725 this.scrollBottom
= this.rows
- 1;
4726 this.curAttr
= this.defAttr
;
4727 this.x
= this.y
= 0; // ?
4728 this.charset
= null;
4729 this.glevel
= 0; // ??
4730 this.charsets
= [null]; // ??
4736 * Request ANSI mode (DECRQM). For VT300 and up, reply is
4738 * where Ps is the mode number as in RM, and Pm is the mode
4740 * 0 - not recognized
4743 * 3 - permanently set
4744 * 4 - permanently reset
4746 Terminal
.prototype.requestAnsiMode = function(params
) {
4753 * Request DEC private mode (DECRQM). For VT300 and up, reply is
4755 * where Ps is the mode number as in DECSET, Pm is the mode value
4756 * as in the ANSI DECRQM.
4758 Terminal
.prototype.requestPrivateMode = function(params
) {
4765 * Set conformance level (DECSCL). Valid values for the first
4767 * Ps = 6 1 -> VT100.
4768 * Ps = 6 2 -> VT200.
4769 * Ps = 6 3 -> VT300.
4770 * Valid values for the second parameter:
4771 * Ps = 0 -> 8-bit controls.
4772 * Ps = 1 -> 7-bit controls (always set for VT100).
4773 * Ps = 2 -> 8-bit controls.
4775 Terminal
.prototype.setConformanceLevel = function(params
) {
4781 * CSI Ps q Load LEDs (DECLL).
4782 * Ps = 0 -> Clear all LEDS (default).
4783 * Ps = 1 -> Light Num Lock.
4784 * Ps = 2 -> Light Caps Lock.
4785 * Ps = 3 -> Light Scroll Lock.
4786 * Ps = 2 1 -> Extinguish Num Lock.
4787 * Ps = 2 2 -> Extinguish Caps Lock.
4788 * Ps = 2 3 -> Extinguish Scroll Lock.
4790 Terminal
.prototype.loadLEDs = function(params
) {
4797 * Set cursor style (DECSCUSR, VT520).
4798 * Ps = 0 -> blinking block.
4799 * Ps = 1 -> blinking block (default).
4800 * Ps = 2 -> steady block.
4801 * Ps = 3 -> blinking underline.
4802 * Ps = 4 -> steady underline.
4804 Terminal
.prototype.setCursorStyle = function(params
) {
4811 * Select character protection attribute (DECSCA). Valid values
4812 * for the parameter:
4813 * Ps = 0 -> DECSED and DECSEL can erase (default).
4814 * Ps = 1 -> DECSED and DECSEL cannot erase.
4815 * Ps = 2 -> DECSED and DECSEL can erase.
4817 Terminal
.prototype.setCharProtectionAttr = function(params
) {
4824 * Restore DEC Private Mode Values. The value of Ps previously
4825 * saved is restored. Ps values are the same as for DECSET.
4827 Terminal
.prototype.restorePrivateValues = function(params
) {
4833 * CSI Pt; Pl; Pb; Pr; Ps$ r
4834 * Change Attributes in Rectangular Area (DECCARA), VT400 and up.
4835 * Pt; Pl; Pb; Pr denotes the rectangle.
4836 * Ps denotes the SGR attributes to change: 0, 1, 4, 5, 7.
4837 * NOTE: xterm doesn't enable this code by default.
4839 Terminal
.prototype.setAttrInRectangle = function(params
) {
4849 for (; t
< b
+ 1; t
++) {
4850 line
= this.lines
.get(this.ybase
+ t
);
4851 for (i
= l
; i
< r
; i
++) {
4852 line
[i
] = [attr
, line
[i
][1]];
4857 this.updateRange(params
[0]);
4858 this.updateRange(params
[2]);
4863 * CSI Pc; Pt; Pl; Pb; Pr$ x
4864 * Fill Rectangular Area (DECFRA), VT420 and up.
4865 * Pc is the character to use.
4866 * Pt; Pl; Pb; Pr denotes the rectangle.
4867 * NOTE: xterm doesn't enable this code by default.
4869 Terminal
.prototype.fillRectangle = function(params
) {
4879 for (; t
< b
+ 1; t
++) {
4880 line
= this.lines
.get(this.ybase
+ t
);
4881 for (i
= l
; i
< r
; i
++) {
4882 line
[i
] = [line
[i
][0], String
.fromCharCode(ch
)];
4887 this.updateRange(params
[1]);
4888 this.updateRange(params
[3]);
4894 * Enable Locator Reporting (DECELR).
4895 * Valid values for the first parameter:
4896 * Ps = 0 -> Locator disabled (default).
4897 * Ps = 1 -> Locator enabled.
4898 * Ps = 2 -> Locator enabled for one report, then disabled.
4899 * The second parameter specifies the coordinate unit for locator
4901 * Valid values for the second parameter:
4902 * Pu = 0 <- or omitted -> default to character cells.
4903 * Pu = 1 <- device physical pixels.
4904 * Pu = 2 <- character cells.
4906 Terminal
.prototype.enableLocatorReporting = function(params
) {
4907 var val
= params
[0] > 0;
4908 //this.mouseEvents = val;
4909 //this.decLocator = val;
4914 * CSI Pt; Pl; Pb; Pr$ z
4915 * Erase Rectangular Area (DECERA), VT400 and up.
4916 * Pt; Pl; Pb; Pr denotes the rectangle.
4917 * NOTE: xterm doesn't enable this code by default.
4919 Terminal
.prototype.eraseRectangle = function(params
) {
4929 ch
= [this.eraseAttr(), ' ', 1]; // xterm?
4931 for (; t
< b
+ 1; t
++) {
4932 line
= this.lines
.get(this.ybase
+ t
);
4933 for (i
= l
; i
< r
; i
++) {
4939 this.updateRange(params
[0]);
4940 this.updateRange(params
[2]);
4946 * Insert P s Column(s) (default = 1) (DECIC), VT420 and up.
4947 * NOTE: xterm doesn't enable this code by default.
4949 Terminal
.prototype.insertColumns = function() {
4950 var param
= params
[0]
4951 , l
= this.ybase
+ this.rows
4952 , ch
= [this.eraseAttr(), ' ', 1] // xterm?
4956 for (i
= this.ybase
; i
< l
; i
++) {
4957 this.lines
.get(i
).splice(this.x
+ 1, 0, ch
);
4958 this.lines
.get(i
).pop();
4968 * Delete P s Column(s) (default = 1) (DECDC), VT420 and up
4969 * NOTE: xterm doesn't enable this code by default.
4971 Terminal
.prototype.deleteColumns = function() {
4972 var param
= params
[0]
4973 , l
= this.ybase
+ this.rows
4974 , ch
= [this.eraseAttr(), ' ', 1] // xterm?
4978 for (i
= this.ybase
; i
< l
; i
++) {
4979 this.lines
.get(i
).splice(this.x
, 1);
4980 this.lines
.get(i
).push(ch
);
4991 Terminal
.charsets
= {};
4993 // DEC Special Character and Line Drawing Set.
4994 // http://vt100.net/docs/vt102-ug/table5-13.html
4995 // A lot of curses apps use this if they see TERM=xterm.
4996 // testing: echo -e '\e(0a\e(B'
4997 // The xterm output sometimes seems to conflict with the
4998 // reference above. xterm seems in line with the reference
4999 // when running vttest however.
5000 // The table below now uses xterm's output from vttest.
5001 Terminal
.charsets
.SCLD
= { // (0
5002 '`': '\u25c6', // '◆'
5003 'a': '\u2592', // '▒'
5004 'b': '\u0009', // '\t'
5005 'c': '\u000c', // '\f'
5006 'd': '\u000d', // '\r'
5007 'e': '\u000a', // '\n'
5008 'f': '\u00b0', // '°'
5009 'g': '\u00b1', // '±'
5010 'h': '\u2424', // '\u2424' (NL)
5011 'i': '\u000b', // '\v'
5012 'j': '\u2518', // '┘'
5013 'k': '\u2510', // '┐'
5014 'l': '\u250c', // '┌'
5015 'm': '\u2514', // '└'
5016 'n': '\u253c', // '┼'
5017 'o': '\u23ba', // '⎺'
5018 'p': '\u23bb', // '⎻'
5019 'q': '\u2500', // '─'
5020 'r': '\u23bc', // '⎼'
5021 's': '\u23bd', // '⎽'
5022 't': '\u251c', // '├'
5023 'u': '\u2524', // '┤'
5024 'v': '\u2534', // '┴'
5025 'w': '\u252c', // '┬'
5026 'x': '\u2502', // '│'
5027 'y': '\u2264', // '≤'
5028 'z': '\u2265', // '≥'
5029 '{': '\u03c0', // 'π'
5030 '|': '\u2260', // '≠'
5031 '}': '\u00a3', // '£'
5032 '~': '\u00b7' // '·'
5035 Terminal
.charsets
.UK
= null; // (A
5036 Terminal
.charsets
.US
= null; // (B (USASCII)
5037 Terminal
.charsets
.Dutch
= null; // (4
5038 Terminal
.charsets
.Finnish
= null; // (C or (5
5039 Terminal
.charsets
.French
= null; // (R
5040 Terminal
.charsets
.FrenchCanadian
= null; // (Q
5041 Terminal
.charsets
.German
= null; // (K
5042 Terminal
.charsets
.Italian
= null; // (Y
5043 Terminal
.charsets
.NorwegianDanish
= null; // (E or (6
5044 Terminal
.charsets
.Spanish
= null; // (Z
5045 Terminal
.charsets
.Swedish
= null; // (H or (7
5046 Terminal
.charsets
.Swiss
= null; // (=
5047 Terminal
.charsets
.ISOLatin
= null; // /A
5053 function on(el
, type
, handler
, capture
) {
5054 if (!Array
.isArray(el
)) {
5057 el
.forEach(function (element
) {
5058 element
.addEventListener(type
, handler
, capture
|| false);
5062 function off(el
, type
, handler
, capture
) {
5063 el
.removeEventListener(type
, handler
, capture
|| false);
5066 function cancel(ev
, force
) {
5067 if (!this.cancelEvents
&& !force
) {
5070 ev
.preventDefault();
5071 ev
.stopPropagation();
5075 function inherits(child
, parent
) {
5077 this.constructor = child
;
5079 f
.prototype = parent
.prototype;
5080 child
.prototype = new f
;
5083 // if bold is broken, we can't
5084 // use it in the terminal.
5085 function isBoldBroken(document
) {
5086 var body
= document
.getElementsByTagName('body')[0];
5087 var el
= document
.createElement('span');
5088 el
.innerHTML
= 'hello world';
5089 body
.appendChild(el
);
5090 var w1
= el
.scrollWidth
;
5091 el
.style
.fontWeight
= 'bold';
5092 var w2
= el
.scrollWidth
;
5093 body
.removeChild(el
);
5097 function indexOf(obj
, el
) {
5100 if (obj
[i
] === el
) return i
;
5105 function isThirdLevelShift(term
, ev
) {
5107 (term
.browser
.isMac
&& ev
.altKey
&& !ev
.ctrlKey
&& !ev
.metaKey
) ||
5108 (term
.browser
.isMSWindows
&& ev
.altKey
&& ev
.ctrlKey
&& !ev
.metaKey
);
5110 if (ev
.type
== 'keypress') {
5111 return thirdLevelKey
;
5114 // Don't invoke for arrows, pageDown, home, backspace, etc. (on non-keypress events)
5115 return thirdLevelKey
&& (!ev
.keyCode
|| ev
.keyCode
> 47);
5118 function matchColor(r1
, g1
, b1
) {
5119 var hash
= (r1
<< 16) | (g1
<< 8) | b1
;
5121 if (matchColor
._cache
[hash
] != null) {
5122 return matchColor
._cache
[hash
];
5125 var ldiff
= Infinity
5134 for (; i
< Terminal
.vcolors
.length
; i
++) {
5135 c
= Terminal
.vcolors
[i
];
5140 diff
= matchColor
.distance(r1
, g1
, b1
, r2
, g2
, b2
);
5153 return matchColor
._cache
[hash
] = li
;
5156 matchColor
._cache
= {};
5158 // http://stackoverflow.com/questions/1633828
5159 matchColor
.distance = function(r1
, g1
, b1
, r2
, g2
, b2
) {
5160 return Math
.pow(30 * (r1
- r2
), 2)
5161 + Math
.pow(59 * (g1
- g2
), 2)
5162 + Math
.pow(11 * (b1
- b2
), 2);
5165 function each(obj
, iter
, con
) {
5166 if (obj
.forEach
) return obj
.forEach(iter
, con
);
5167 for (var i
= 0; i
< obj
.length
; i
++) {
5168 iter
.call(con
, obj
[i
], i
, obj
);
5172 function keys(obj
) {
5173 if (Object
.keys
) return Object
.keys(obj
);
5176 if (Object
.prototype.hasOwnProperty
.call(obj
, key
)) {
5183 var wcwidth
= (function(opts
) {
5184 // extracted from https://www.cl.cam.ac.uk/%7Emgk25/ucs/wcwidth.c
5185 // combining characters
5187 [0x0300, 0x036F], [0x0483, 0x0486], [0x0488, 0x0489],
5188 [0x0591, 0x05BD], [0x05BF, 0x05BF], [0x05C1, 0x05C2],
5189 [0x05C4, 0x05C5], [0x05C7, 0x05C7], [0x0600, 0x0603],
5190 [0x0610, 0x0615], [0x064B, 0x065E], [0x0670, 0x0670],
5191 [0x06D6, 0x06E4], [0x06E7, 0x06E8], [0x06EA, 0x06ED],
5192 [0x070F, 0x070F], [0x0711, 0x0711], [0x0730, 0x074A],
5193 [0x07A6, 0x07B0], [0x07EB, 0x07F3], [0x0901, 0x0902],
5194 [0x093C, 0x093C], [0x0941, 0x0948], [0x094D, 0x094D],
5195 [0x0951, 0x0954], [0x0962, 0x0963], [0x0981, 0x0981],
5196 [0x09BC, 0x09BC], [0x09C1, 0x09C4], [0x09CD, 0x09CD],
5197 [0x09E2, 0x09E3], [0x0A01, 0x0A02], [0x0A3C, 0x0A3C],
5198 [0x0A41, 0x0A42], [0x0A47, 0x0A48], [0x0A4B, 0x0A4D],
5199 [0x0A70, 0x0A71], [0x0A81, 0x0A82], [0x0ABC, 0x0ABC],
5200 [0x0AC1, 0x0AC5], [0x0AC7, 0x0AC8], [0x0ACD, 0x0ACD],
5201 [0x0AE2, 0x0AE3], [0x0B01, 0x0B01], [0x0B3C, 0x0B3C],
5202 [0x0B3F, 0x0B3F], [0x0B41, 0x0B43], [0x0B4D, 0x0B4D],
5203 [0x0B56, 0x0B56], [0x0B82, 0x0B82], [0x0BC0, 0x0BC0],
5204 [0x0BCD, 0x0BCD], [0x0C3E, 0x0C40], [0x0C46, 0x0C48],
5205 [0x0C4A, 0x0C4D], [0x0C55, 0x0C56], [0x0CBC, 0x0CBC],
5206 [0x0CBF, 0x0CBF], [0x0CC6, 0x0CC6], [0x0CCC, 0x0CCD],
5207 [0x0CE2, 0x0CE3], [0x0D41, 0x0D43], [0x0D4D, 0x0D4D],
5208 [0x0DCA, 0x0DCA], [0x0DD2, 0x0DD4], [0x0DD6, 0x0DD6],
5209 [0x0E31, 0x0E31], [0x0E34, 0x0E3A], [0x0E47, 0x0E4E],
5210 [0x0EB1, 0x0EB1], [0x0EB4, 0x0EB9], [0x0EBB, 0x0EBC],
5211 [0x0EC8, 0x0ECD], [0x0F18, 0x0F19], [0x0F35, 0x0F35],
5212 [0x0F37, 0x0F37], [0x0F39, 0x0F39], [0x0F71, 0x0F7E],
5213 [0x0F80, 0x0F84], [0x0F86, 0x0F87], [0x0F90, 0x0F97],
5214 [0x0F99, 0x0FBC], [0x0FC6, 0x0FC6], [0x102D, 0x1030],
5215 [0x1032, 0x1032], [0x1036, 0x1037], [0x1039, 0x1039],
5216 [0x1058, 0x1059], [0x1160, 0x11FF], [0x135F, 0x135F],
5217 [0x1712, 0x1714], [0x1732, 0x1734], [0x1752, 0x1753],
5218 [0x1772, 0x1773], [0x17B4, 0x17B5], [0x17B7, 0x17BD],
5219 [0x17C6, 0x17C6], [0x17C9, 0x17D3], [0x17DD, 0x17DD],
5220 [0x180B, 0x180D], [0x18A9, 0x18A9], [0x1920, 0x1922],
5221 [0x1927, 0x1928], [0x1932, 0x1932], [0x1939, 0x193B],
5222 [0x1A17, 0x1A18], [0x1B00, 0x1B03], [0x1B34, 0x1B34],
5223 [0x1B36, 0x1B3A], [0x1B3C, 0x1B3C], [0x1B42, 0x1B42],
5224 [0x1B6B, 0x1B73], [0x1DC0, 0x1DCA], [0x1DFE, 0x1DFF],
5225 [0x200B, 0x200F], [0x202A, 0x202E], [0x2060, 0x2063],
5226 [0x206A, 0x206F], [0x20D0, 0x20EF], [0x302A, 0x302F],
5227 [0x3099, 0x309A], [0xA806, 0xA806], [0xA80B, 0xA80B],
5228 [0xA825, 0xA826], [0xFB1E, 0xFB1E], [0xFE00, 0xFE0F],
5229 [0xFE20, 0xFE23], [0xFEFF, 0xFEFF], [0xFFF9, 0xFFFB],
5230 [0x10A01, 0x10A03], [0x10A05, 0x10A06], [0x10A0C, 0x10A0F],
5231 [0x10A38, 0x10A3A], [0x10A3F, 0x10A3F], [0x1D167, 0x1D169],
5232 [0x1D173, 0x1D182], [0x1D185, 0x1D18B], [0x1D1AA, 0x1D1AD],
5233 [0x1D242, 0x1D244], [0xE0001, 0xE0001], [0xE0020, 0xE007F],
5237 function bisearch(ucs
) {
5239 var max
= COMBINING
.length
- 1;
5241 if (ucs
< COMBINING
[0][0] || ucs
> COMBINING
[max
][1])
5243 while (max
>= min
) {
5244 mid
= Math
.floor((min
+ max
) / 2);
5245 if (ucs
> COMBINING
[mid
][1])
5247 else if (ucs
< COMBINING
[mid
][0])
5254 function wcwidth(ucs
) {
5255 // test for 8-bit control characters
5258 if (ucs
< 32 || (ucs
>= 0x7f && ucs
< 0xa0))
5259 return opts
.control
;
5260 // binary search in table of non-spacing characters
5263 // if we arrive here, ucs is not a combining or C0/C1 control character
5268 ucs
<= 0x115f || // Hangul Jamo init. consonants
5271 (ucs
>= 0x2e80 && ucs
<= 0xa4cf && ucs
!= 0x303f) || // CJK..Yi
5272 (ucs
>= 0xac00 && ucs
<= 0xd7a3) || // Hangul Syllables
5273 (ucs
>= 0xf900 && ucs
<= 0xfaff) || // CJK Compat Ideographs
5274 (ucs
>= 0xfe10 && ucs
<= 0xfe19) || // Vertical forms
5275 (ucs
>= 0xfe30 && ucs
<= 0xfe6f) || // CJK Compat Forms
5276 (ucs
>= 0xff00 && ucs
<= 0xff60) || // Fullwidth Forms
5277 (ucs
>= 0xffe0 && ucs
<= 0xffe6) ||
5278 (ucs
>= 0x20000 && ucs
<= 0x2fffd) ||
5279 (ucs
>= 0x30000 && ucs
<= 0x3fffd)
5284 })({nul
: 0, control
: 0}); // configurable options
5290 Terminal
.EventEmitter
= EventEmitter
;
5291 Terminal
.inherits
= inherits
;
5294 * Adds an event listener to the terminal.
5296 * @param {string} event The name of the event. TODO: Document all event types
5297 * @param {function} callback The function to call when the event is triggered.
5301 Terminal
.cancel
= cancel
;
5303 module
.exports
= Terminal
;