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.js';
14 import { EventEmitter
} from './EventEmitter.js';
15 import { Viewport
} from './Viewport.js';
16 import { rightClickHandler
, pasteHandler
, copyHandler
} from './handlers/Clipboard.js';
17 import { CircularList
} from './utils/CircularList.js';
18 import { C0
} from './EscapeSequences';
19 import { CharMeasure
} from './utils/CharMeasure.js';
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
+ '"');
409 this.options
[key
] = value
;
413 * Binds the desired focus behavior on a given terminal object.
417 Terminal
.bindFocus = function (term
) {
418 on(term
.textarea
, 'focus', function (ev
) {
419 if (term
.sendFocus
) {
420 term
.send(C0
.ESC
+ '[I');
422 term
.element
.classList
.add('focus');
424 Terminal
.focus
= term
;
425 term
.emit('focus', {terminal
: term
});
430 * Blur the terminal. Delegates blur handling to the terminal's DOM element.
432 Terminal
.prototype.blur = function() {
433 return this.textarea
.blur();
437 * Binds the desired blur behavior on a given terminal object.
441 Terminal
.bindBlur = function (term
) {
442 on(term
.textarea
, 'blur', function (ev
) {
443 term
.queueRefresh(term
.y
, term
.y
);
444 if (term
.sendFocus
) {
445 term
.send(C0
.ESC
+ '[O');
447 term
.element
.classList
.remove('focus');
448 Terminal
.focus
= null;
449 term
.emit('blur', {terminal
: term
});
454 * Initialize default behavior
456 Terminal
.prototype.initGlobal = function() {
459 Terminal
.bindKeys(this);
460 Terminal
.bindFocus(this);
461 Terminal
.bindBlur(this);
463 // Bind clipboard functionality
464 on(this.element
, 'copy', function (ev
) {
465 copyHandler
.call(this, ev
, term
);
467 on(this.textarea
, 'paste', function (ev
) {
468 pasteHandler
.call(this, ev
, term
);
470 on(this.element
, 'paste', function (ev
) {
471 pasteHandler
.call(this, ev
, term
);
474 function rightClickHandlerWrapper (ev
) {
475 rightClickHandler
.call(this, ev
, term
);
478 if (term
.browser
.isFirefox
) {
479 on(this.element
, 'mousedown', function (ev
) {
480 if (ev
.button
== 2) {
481 rightClickHandlerWrapper(ev
);
485 on(this.element
, 'contextmenu', rightClickHandlerWrapper
);
490 * Apply key handling to the terminal
492 Terminal
.bindKeys = function(term
) {
493 on(term
.element
, 'keydown', function(ev
) {
494 if (document
.activeElement
!= this) {
500 on(term
.element
, 'keypress', function(ev
) {
501 if (document
.activeElement
!= this) {
507 on(term
.element
, 'keyup', term
.focus
.bind(term
));
509 on(term
.textarea
, 'keydown', function(ev
) {
513 on(term
.textarea
, 'keypress', function(ev
) {
515 // Truncate the textarea's value, since it is not needed
519 on(term
.textarea
, 'compositionstart', term
.compositionHelper
.compositionstart
.bind(term
.compositionHelper
));
520 on(term
.textarea
, 'compositionupdate', term
.compositionHelper
.compositionupdate
.bind(term
.compositionHelper
));
521 on(term
.textarea
, 'compositionend', term
.compositionHelper
.compositionend
.bind(term
.compositionHelper
));
522 term
.on('refresh', term
.compositionHelper
.updateCompositionElements
.bind(term
.compositionHelper
));
527 * Insert the given row to the terminal or produce a new one
528 * if no row argument is passed. Return the inserted row.
529 * @param {HTMLElement} row (optional) The row to append to the terminal.
531 Terminal
.prototype.insertRow = function (row
) {
532 if (typeof row
!= 'object') {
533 row
= document
.createElement('div');
536 this.rowContainer
.appendChild(row
);
537 this.children
.push(row
);
543 * Opens the terminal within an element.
545 * @param {HTMLElement} parent The element to create the terminal within.
547 Terminal
.prototype.open = function(parent
) {
548 var self
=this, i
=0, div
;
550 this.parent
= parent
|| this.parent
;
553 throw new Error('Terminal requires a parent element.');
556 // Grab global elements
557 this.context
= this.parent
.ownerDocument
.defaultView
;
558 this.document
= this.parent
.ownerDocument
;
559 this.body
= this.document
.getElementsByTagName('body')[0];
561 //Create main element container
562 this.element
= this.document
.createElement('div');
563 this.element
.classList
.add('terminal');
564 this.element
.classList
.add('xterm');
565 this.element
.classList
.add('xterm-theme-' + this.theme
);
567 this.element
.style
.height
568 this.element
.setAttribute('tabindex', 0);
570 this.viewportElement
= document
.createElement('div');
571 this.viewportElement
.classList
.add('xterm-viewport');
572 this.element
.appendChild(this.viewportElement
);
573 this.viewportScrollArea
= document
.createElement('div');
574 this.viewportScrollArea
.classList
.add('xterm-scroll-area');
575 this.viewportElement
.appendChild(this.viewportScrollArea
);
577 // Create the container that will hold the lines of the terminal and then
578 // produce the lines the lines.
579 this.rowContainer
= document
.createElement('div');
580 this.rowContainer
.classList
.add('xterm-rows');
581 this.element
.appendChild(this.rowContainer
);
584 // Create the container that will hold helpers like the textarea for
585 // capturing DOM Events. Then produce the helpers.
586 this.helperContainer
= document
.createElement('div');
587 this.helperContainer
.classList
.add('xterm-helpers');
588 // TODO: This should probably be inserted once it's filled to prevent an additional layout
589 this.element
.appendChild(this.helperContainer
);
590 this.textarea
= document
.createElement('textarea');
591 this.textarea
.classList
.add('xterm-helper-textarea');
592 this.textarea
.setAttribute('autocorrect', 'off');
593 this.textarea
.setAttribute('autocapitalize', 'off');
594 this.textarea
.setAttribute('spellcheck', 'false');
595 this.textarea
.tabIndex
= 0;
596 this.textarea
.addEventListener('focus', function() {
597 self
.emit('focus', {terminal
: self
});
599 this.textarea
.addEventListener('blur', function() {
600 self
.emit('blur', {terminal
: self
});
602 this.helperContainer
.appendChild(this.textarea
);
604 this.compositionView
= document
.createElement('div');
605 this.compositionView
.classList
.add('composition-view');
606 this.compositionHelper
= new CompositionHelper(this.textarea
, this.compositionView
, this);
607 this.helperContainer
.appendChild(this.compositionView
);
609 this.charSizeStyleElement
= document
.createElement('style');
610 this.helperContainer
.appendChild(this.charSizeStyleElement
);
612 for (; i
< this.rows
; i
++) {
615 this.parent
.appendChild(this.element
);
617 this.charMeasure
= new CharMeasure(this.rowContainer
);
618 this.charMeasure
.on('charsizechanged', function () {
619 self
.updateCharSizeCSS();
621 this.charMeasure
.measure();
623 this.viewport
= new Viewport(this, this.viewportElement
, this.viewportScrollArea
, this.charMeasure
);
625 // Setup loop that draws to screen
626 this.queueRefresh(0, this.rows
- 1);
629 // Initialize global actions that
630 // need to be taken on the document.
633 // Ensure there is a Terminal.focus.
636 on(this.element
, 'click', function() {
637 var selection
= document
.getSelection(),
638 collapsed
= selection
.isCollapsed
,
639 isRange
= typeof collapsed
== 'boolean' ? !collapsed
: selection
.type
== 'Range';
645 // Listen for mouse events and translate
646 // them into terminal mouse protocols.
649 // Figure out whether boldness affects
650 // the character width of monospace fonts.
651 if (Terminal
.brokenBold
== null) {
652 Terminal
.brokenBold
= isBoldBroken(this.document
);
656 * This event is emitted when terminal has completed opening.
665 * Attempts to load an add-on using CommonJS or RequireJS (whichever is available).
666 * @param {string} addon The name of the addon to load
669 Terminal
.loadAddon = function(addon
, callback
) {
670 if (typeof exports
=== 'object' && typeof module
=== 'object') {
672 return require('./addons/' + addon
+ '/' + addon
);
673 } else if (typeof define
== 'function') {
675 return require(['./addons/' + addon
+ '/' + addon
], callback
);
677 console
.error('Cannot load a module without a CommonJS or RequireJS environment.');
683 * Updates the helper CSS class with any changes necessary after the terminal's
684 * character width has been changed.
686 Terminal
.prototype.updateCharSizeCSS = function() {
687 this.charSizeStyleElement
.textContent
= '.xterm-wide-char{width:' + (this.charMeasure
.width
* 2) + 'px;}';
692 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#Mouse%20Tracking
693 * To better understand these
694 * the xterm code is very helpful:
696 * button.c, charproc.c, misc.c
697 * Relevant functions in xterm/button.c:
698 * BtnCode, EmitButtonCode, EditorButton, SendMousePosition
700 Terminal
.prototype.bindMouse = function() {
701 var el
= this.element
, self
= this, pressed
= 32;
703 // mouseup, mousedown, wheel
704 // left click: ^[[M 3<^[[M#3<
706 function sendButton(ev
) {
710 // get the xterm-style button
711 button
= getButton(ev
);
713 // get mouse coordinates
717 sendEvent(button
, pos
);
719 switch (ev
.overrideType
|| ev
.type
) {
724 // keep it at the left
725 // button, just in case.
736 // motion example of a left click:
737 // ^[[M 3<^[[M@4<^[[M@5<^[[M@6<^[[M@7<^[[M#7<
738 function sendMove(ev
) {
745 // buttons marked as motions
746 // are incremented by 32
749 sendEvent(button
, pos
);
753 // position to characters
754 function encode(data
, ch
) {
755 if (!self
.utfMouse
) {
756 if (ch
=== 255) return data
.push(0);
757 if (ch
> 127) ch
= 127;
760 if (ch
=== 2047) return data
.push(0);
764 if (ch
> 2047) ch
= 2047;
765 data
.push(0xC0 | (ch
>> 6));
766 data
.push(0x80 | (ch
& 0x3F));
771 // send a mouse event:
772 // regular/utf8: ^[[M Cb Cx Cy
773 // urxvt: ^[[ Cb ; Cx ; Cy M
774 // sgr: ^[[ Cb ; Cx ; Cy M/m
775 // vt300: ^[[ 24(1/3/5)~ [ Cx , Cy ] \r
776 // locator: CSI P e ; P b ; P r ; P c ; P p & w
777 function sendEvent(button
, pos
) {
778 // self.emit('mouse', {
784 if (self
.vt300Mouse
) {
786 // http://www.vt100.net/docs/vt3xx-gp/chapter15.html
790 var data
= C0
.ESC
+ '[24';
791 if (button
=== 0) data
+= '1';
792 else if (button
=== 1) data
+= '3';
793 else if (button
=== 2) data
+= '5';
794 else if (button
=== 3) return;
796 data
+= '~[' + pos
.x
+ ',' + pos
.y
+ ']\r';
801 if (self
.decLocator
) {
806 if (button
=== 0) button
= 2;
807 else if (button
=== 1) button
= 4;
808 else if (button
=== 2) button
= 6;
809 else if (button
=== 3) button
= 3;
810 self
.send(C0
.ESC
+ '['
813 + (button
=== 3 ? 4 : 0)
824 if (self
.urxvtMouse
) {
829 self
.send(C0
.ESC
+ '[' + button
+ ';' + pos
.x
+ ';' + pos
.y
+ 'M');
836 self
.send(C0
.ESC
+ '[<'
837 + (((button
& 3) === 3 ? button
& ~3 : button
) - 32)
842 + ((button
& 3) === 3 ? 'm' : 'M'));
848 encode(data
, button
);
852 self
.send(C0
.ESC
+ '[M' + String
.fromCharCode
.apply(String
, data
));
855 function getButton(ev
) {
868 // 1, and 2 - with 64 added
869 switch (ev
.overrideType
|| ev
.type
) {
871 button
= ev
.button
!= null
877 if (self
.browser
.isMSIE
) {
878 button
= button
=== 1 ? 0 : button
=== 4 ? 1 : button
;
884 case 'DOMMouseScroll':
885 button
= ev
.detail
< 0
890 button
= ev
.wheelDeltaY
> 0
896 // next three bits are the modifiers:
897 // 4 = shift, 8 = meta, 16 = control
898 shift
= ev
.shiftKey
? 4 : 0;
899 meta
= ev
.metaKey
? 8 : 0;
900 ctrl
= ev
.ctrlKey
? 16 : 0;
901 mod
= shift
| meta
| ctrl
;
904 if (self
.vt200Mouse
) {
907 } else if (!self
.normalMouse
) {
912 button
= (32 + (mod
<< 2)) + button
;
917 // mouse coordinates measured in cols/rows
918 function getCoords(ev
) {
921 // ignore browsers without pageX for now
922 if (ev
.pageX
== null) return;
928 // should probably check offsetParent
929 // but this is more portable
930 while (el
&& el
!== self
.document
.documentElement
) {
933 el
= 'offsetParent' in el
938 // convert to cols/rows
939 w
= self
.element
.clientWidth
;
940 h
= self
.element
.clientHeight
;
941 x
= Math
.ceil((x
/ w
) * self
.cols
);
942 y
= Math
.ceil((y
/ h
) * self
.rows
);
944 // be sure to avoid sending
945 // bad positions to the program
947 if (x
> self
.cols
) x
= self
.cols
;
949 if (y
> self
.rows
) y
= self
.rows
;
951 // xterm sends raw bytes and
952 // starts at 32 (SP) for each.
963 on(el
, 'mousedown', function(ev
) {
964 if (!self
.mouseEvents
) return;
973 //if (self.vt200Mouse && !self.normalMouse) {
974 if (self
.vt200Mouse
) {
975 ev
.overrideType
= 'mouseup';
977 return self
.cancel(ev
);
981 if (self
.normalMouse
) on(self
.document
, 'mousemove', sendMove
);
983 // x10 compatibility mode can't send button releases
984 if (!self
.x10Mouse
) {
985 on(self
.document
, 'mouseup', function up(ev
) {
987 if (self
.normalMouse
) off(self
.document
, 'mousemove', sendMove
);
988 off(self
.document
, 'mouseup', up
);
989 return self
.cancel(ev
);
993 return self
.cancel(ev
);
996 //if (self.normalMouse) {
997 // on(self.document, 'mousemove', sendMove);
1000 on(el
, 'wheel', function(ev
) {
1001 if (!self
.mouseEvents
) return;
1004 || self
.decLocator
) return;
1006 return self
.cancel(ev
);
1009 // allow wheel scrolling in
1010 // the shell for example
1011 on(el
, 'wheel', function(ev
) {
1012 if (self
.mouseEvents
) return;
1013 self
.viewport
.onWheel(ev
);
1014 return self
.cancel(ev
);
1019 * Destroys the terminal.
1021 Terminal
.prototype.destroy = function() {
1022 this.readable
= false;
1023 this.writable
= false;
1025 this.handler = function() {};
1026 this.write = function() {};
1027 if (this.element
.parentNode
) {
1028 this.element
.parentNode
.removeChild(this.element
);
1030 //this.emit('close');
1035 * Flags used to render terminal text properly
1046 * Queues a refresh between two rows (inclusive), to be done on next animation
1048 * @param {number} start The start row.
1049 * @param {number} end The end row.
1051 Terminal
.prototype.queueRefresh = function(start
, end
) {
1052 this.refreshRowsQueue
.push({ start
: start
, end
: end
});
1056 * Performs the refresh loop callback, calling refresh only if a refresh is
1057 * necessary before queueing up the next one.
1059 Terminal
.prototype.refreshLoop = function() {
1060 // Don't refresh if there were no row changes
1061 if (this.refreshRowsQueue
.length
> 0) {
1062 // Skip MAX_REFRESH_FRAME_SKIP frames if the writeBuffer is non-empty as it
1063 // will need to be immediately refreshed anyway. This saves a lot of
1064 // rendering time as the viewport DOM does not need to be refreshed, no
1065 // scroll events, no layouts, etc.
1066 var skipFrame
= this.writeBuffer
.length
> 0 && this.refreshFramesSkipped
++ <= MAX_REFRESH_FRAME_SKIP
;
1069 this.refreshFramesSkipped
= 0;
1072 if (this.refreshRowsQueue
.length
> 4) {
1073 // Just do a full refresh when 5+ refreshes are queued
1075 end
= this.rows
- 1;
1077 // Get start and end rows that need refreshing
1078 start
= this.refreshRowsQueue
[0].start
;
1079 end
= this.refreshRowsQueue
[0].end
;
1080 for (var i
= 1; i
< this.refreshRowsQueue
.length
; i
++) {
1081 if (this.refreshRowsQueue
[i
].start
< start
) {
1082 start
= this.refreshRowsQueue
[i
].start
;
1084 if (this.refreshRowsQueue
[i
].end
> end
) {
1085 end
= this.refreshRowsQueue
[i
].end
;
1089 this.refreshRowsQueue
= [];
1090 this.refresh(start
, end
);
1093 window
.requestAnimationFrame(this.refreshLoop
.bind(this));
1097 * Refreshes (re-renders) terminal content within two rows (inclusive)
1101 * In the screen buffer, each character is stored as a an array with a character
1102 * and a 32-bit integer:
1103 * - First value: a utf-16 character.
1105 * - Next 9 bits: background color (0-511).
1106 * - Next 9 bits: foreground color (0-511).
1107 * - Next 14 bits: a mask for misc. flags:
1114 * @param {number} start The row to start from (between 0 and terminal's height terminal - 1)
1115 * @param {number} end The row to end at (between fromRow and terminal's height terminal - 1)
1117 Terminal
.prototype.refresh = function(start
, end
) {
1120 var x
, y
, i
, line
, out
, ch
, ch_width
, width
, data
, attr
, bg
, fg
, flags
, row
, parent
, focused
= document
.activeElement
;
1122 // If this is a big refresh, remove the terminal rows from the DOM for faster calculations
1123 if (end
- start
>= this.rows
/ 2) {
1124 parent
= this.element
.parentNode
;
1126 this.element
.removeChild(this.rowContainer
);
1133 if (end
>= this.rows
.length
) {
1134 this.log('`end` is too large. Most likely a bad CSR.');
1135 end
= this.rows
.length
- 1;
1138 for (; y
<= end
; y
++) {
1139 row
= y
+ this.ydisp
;
1141 line
= this.lines
.get(row
);
1143 // Continue if the line is not available, this means a resize is currently in progress
1148 if (this.y
=== y
- (this.ybase
- this.ydisp
)
1150 && !this.cursorHidden
) {
1156 attr
= this.defAttr
;
1159 for (; i
< width
; i
++) {
1161 // Continue if the character is not available, this means a resize is currently in progress
1166 ch_width
= line
[i
][2];
1170 if (i
=== x
) data
= -1;
1172 if (data
!== attr
) {
1173 if (attr
!== this.defAttr
) {
1176 if (data
!== this.defAttr
) {
1178 out
+= '<span class="reverse-video terminal-cursor';
1179 if (this.cursorBlink
) {
1184 var classNames
= [];
1187 fg
= (data
>> 9) & 0x1ff;
1190 if (flags
& Terminal
.flags
.BOLD
) {
1191 if (!Terminal
.brokenBold
) {
1192 classNames
.push('xterm-bold');
1194 // See: XTerm*boldColors
1195 if (fg
< 8) fg
+= 8;
1198 if (flags
& Terminal
.flags
.UNDERLINE
) {
1199 classNames
.push('xterm-underline');
1202 if (flags
& Terminal
.flags
.BLINK
) {
1203 classNames
.push('xterm-blink');
1206 // If inverse flag is on, then swap the foreground and background variables.
1207 if (flags
& Terminal
.flags
.INVERSE
) {
1208 /* One-line variable swap in JavaScript: http://stackoverflow.com/a/16201730 */
1209 bg = [fg, fg = bg][0];
1210 // Should inverse just be before the
1211 // above boldColors effect instead?
1212 if ((flags & 1) && fg < 8) fg += 8;
1215 if (flags & Terminal.flags.INVISIBLE) {
1216 classNames.push('xterm-hidden');
1220 * Weird situation: Invert flag used black foreground and white background results
1221 * in invalid background color, positioned at the 256 index of the 256 terminal
1222 * color map. Pin the colors manually in such a case.
1224 * Source: https://github.com/sourcelair/xterm.js/issues/57
1226 if (flags
& Terminal
.flags
.INVERSE
) {
1236 classNames
.push('xterm-bg-color-' + bg
);
1240 classNames
.push('xterm-color-' + fg
);
1244 if (classNames
.length
) {
1245 out
+= ' class="' + classNames
.join(' ') + '"';
1252 if (ch_width
=== 2) {
1253 out
+= '<span class="xterm-wide-char">';
1273 if (ch_width
=== 2) {
1280 if (attr
!== this.defAttr
) {
1284 this.children
[y
].innerHTML
= out
;
1288 this.element
.appendChild(this.rowContainer
);
1291 this.emit('refresh', {element
: this.element
, start
: start
, end
: end
});
1295 * Display the cursor element
1297 Terminal
.prototype.showCursor = function() {
1298 if (!this.cursorState
) {
1299 this.cursorState
= 1;
1300 this.queueRefresh(this.y
, this.y
);
1305 * Scroll the terminal down 1 row, creating a blank line.
1307 Terminal
.prototype.scroll = function() {
1310 // Make room for the new row in lines
1311 if (this.lines
.length
=== this.lines
.maxLength
) {
1312 this.lines
.trimStart(1);
1314 if (this.ydisp
!== 0) {
1321 // TODO: Why is this done twice?
1322 if (!this.userScrolling
) {
1323 this.ydisp
= this.ybase
;
1327 row
= this.ybase
+ this.rows
- 1;
1329 // subtract the bottom scroll region
1330 row
-= this.rows
- 1 - this.scrollBottom
;
1332 if (row
=== this.lines
.length
) {
1333 // Optimization: pushing is faster than splicing when they amount to the same behavior
1334 this.lines
.push(this.blankLine());
1337 this.lines
.splice(row
, 0, this.blankLine());
1340 if (this.scrollTop
!== 0) {
1341 if (this.ybase
!== 0) {
1343 if (!this.userScrolling
) {
1344 this.ydisp
= this.ybase
;
1347 this.lines
.splice(this.ybase
+ this.scrollTop
, 1);
1351 this.updateRange(this.scrollTop
);
1352 this.updateRange(this.scrollBottom
);
1355 * This event is emitted whenever the terminal is scrolled.
1356 * The one parameter passed is the new y display position.
1360 this.emit('scroll', this.ydisp
);
1364 * Scroll the display of the terminal
1365 * @param {number} disp The number of lines to scroll down (negatives scroll up).
1366 * @param {boolean} suppressScrollEvent Don't emit the scroll event as scrollDisp. This is used
1367 * to avoid unwanted events being handled by the veiwport when the event was triggered from the
1368 * viewport originally.
1370 Terminal
.prototype.scrollDisp = function(disp
, suppressScrollEvent
) {
1372 this.userScrolling
= true;
1373 } else if (disp
+ this.ydisp
>= this.ybase
) {
1374 this.userScrolling
= false;
1379 if (this.ydisp
> this.ybase
) {
1380 this.ydisp
= this.ybase
;
1381 } else if (this.ydisp
< 0) {
1385 if (!suppressScrollEvent
) {
1386 this.emit('scroll', this.ydisp
);
1389 this.queueRefresh(0, this.rows
- 1);
1393 * Scroll the display of the terminal by a number of pages.
1394 * @param {number} pageCount The number of pages to scroll (negative scrolls up).
1396 Terminal
.prototype.scrollPages = function(pageCount
) {
1397 this.scrollDisp(pageCount
* (this.rows
- 1));
1401 * Scrolls the display of the terminal to the top.
1403 Terminal
.prototype.scrollToTop = function() {
1404 this.scrollDisp(-this.ydisp
);
1408 * Scrolls the display of the terminal to the bottom.
1410 Terminal
.prototype.scrollToBottom = function() {
1411 this.scrollDisp(this.ybase
- this.ydisp
);
1415 * Writes text to the terminal.
1416 * @param {string} text The text to write to the terminal.
1418 Terminal
.prototype.write = function(data
) {
1419 this.writeBuffer
.push(data
);
1421 // Send XOFF to pause the pty process if the write buffer becomes too large so
1422 // xterm.js can catch up before more data is sent. This is necessary in order
1423 // to keep signals such as ^C responsive.
1424 if (!this.xoffSentToCatchUp
&& this.writeBuffer
.length
>= WRITE_BUFFER_PAUSE_THRESHOLD
) {
1425 // XOFF - stop pty pipe
1426 // XON will be triggered by emulator before processing data chunk
1428 this.xoffSentToCatchUp
= true;
1431 if (!this.writeInProgress
&& this.writeBuffer
.length
> 0) {
1432 // Kick off a write which will write all data in sequence recursively
1433 this.writeInProgress
= true;
1434 // Kick off an async innerWrite so more writes can come in while processing data
1436 setTimeout(function () {
1442 Terminal
.prototype.innerWrite = function() {
1443 var writeBatch
= this.writeBuffer
.splice(0, WRITE_BATCH_SIZE
);
1444 while (writeBatch
.length
> 0) {
1445 var data
= writeBatch
.shift();
1446 var l
= data
.length
, i
= 0, j
, cs
, ch
, code
, low
, ch_width
, row
;
1448 // If XOFF was sent in order to catch up with the pty process, resume it if
1449 // the writeBuffer is empty to allow more data to come in.
1450 if (this.xoffSentToCatchUp
&& writeBatch
.length
=== 0 && this.writeBuffer
.length
=== 0) {
1452 this.xoffSentToCatchUp
= false;
1455 this.refreshStart
= this.y
;
1456 this.refreshEnd
= this.y
;
1458 // apply leftover surrogate high from last write
1459 if (this.surrogate_high
) {
1460 data
= this.surrogate_high
+ data
;
1461 this.surrogate_high
= '';
1464 for (; i
< l
; i
++) {
1467 // FIXME: higher chars than 0xa0 are not allowed in escape sequences
1468 // --> maybe move to default
1469 code
= data
.charCodeAt(i
);
1470 if (0xD800 <= code
&& code
<= 0xDBFF) {
1471 // we got a surrogate high
1472 // get surrogate low (next 2 bytes)
1473 low
= data
.charCodeAt(i
+1);
1475 // end of data stream, save surrogate high
1476 this.surrogate_high
= ch
;
1479 code
= ((code
- 0xD800) * 0x400) + (low
- 0xDC00) + 0x10000;
1480 ch
+= data
.charAt(i
+1);
1483 // surrogate low - already handled above
1484 if (0xDC00 <= code
&& code
<= 0xDFFF)
1486 switch (this.state
) {
1497 if (this.convertEol
) {
1501 if (this.y
> this.scrollBottom
) {
1521 this.x
= this.nextStop();
1536 this.state
= escaped
;
1541 // calculate print space
1542 // expensive call, therefore we save width in line buffer
1543 ch_width
= wcwidth(code
);
1546 if (this.charset
&& this.charset
[ch
]) {
1547 ch
= this.charset
[ch
];
1550 row
= this.y
+ this.ybase
;
1552 // insert combining char in last cell
1553 // FIXME: needs handling after cursor jumps
1554 if (!ch_width
&& this.x
) {
1555 // dont overflow left
1556 if (this.lines
.get(row
)[this.x
-1]) {
1557 if (!this.lines
.get(row
)[this.x
-1][2]) {
1559 // found empty cell after fullwidth, need to go 2 cells back
1560 if (this.lines
.get(row
)[this.x
-2])
1561 this.lines
.get(row
)[this.x
-2][1] += ch
;
1564 this.lines
.get(row
)[this.x
-1][1] += ch
;
1566 this.updateRange(this.y
);
1571 // goto next line if ch would overflow
1572 // TODO: needs a global min terminal width of 2
1573 if (this.x
+ch_width
-1 >= this.cols
) {
1574 // autowrap - DECAWM
1575 if (this.wraparoundMode
) {
1578 if (this.y
> this.scrollBottom
) {
1583 this.x
= this.cols
-1;
1584 if(ch_width
===2) // FIXME: check for xterm behavior
1588 row
= this.y
+ this.ybase
;
1590 // insert mode: move characters to right
1591 if (this.insertMode
) {
1592 // do this twice for a fullwidth char
1593 for (var moves
=0; moves
<ch_width
; ++moves
) {
1594 // remove last cell, if it's width is 0
1595 // we have to adjust the second last cell as well
1596 var removed
= this.lines
.get(this.y
+ this.ybase
).pop();
1598 && this.lines
.get(row
)[this.cols
-2]
1599 && this.lines
.get(row
)[this.cols
-2][2]===2)
1600 this.lines
.get(row
)[this.cols
-2] = [this.curAttr
, ' ', 1];
1602 // insert empty cell at cursor
1603 this.lines
.get(row
).splice(this.x
, 0, [this.curAttr
, ' ', 1]);
1607 this.lines
.get(row
)[this.x
] = [this.curAttr
, ch
, ch_width
];
1609 this.updateRange(this.y
);
1611 // fullwidth char - set next cell width to zero and advance cursor
1613 this.lines
.get(row
)[this.x
] = [this.curAttr
, '', 0];
1622 // ESC [ Control Sequence Introducer ( CSI is 0x9b).
1625 this.currentParam
= 0;
1629 // ESC ] Operating System Command ( OSC is 0x9d).
1632 this.currentParam
= 0;
1636 // ESC P Device Control String ( DCS is 0x90).
1639 this.currentParam
= 0;
1643 // ESC _ Application Program Command ( APC is 0x9f).
1645 this.state
= ignore
;
1648 // ESC ^ Privacy Message ( PM is 0x9e).
1650 this.state
= ignore
;
1653 // ESC c Full Reset (RIS).
1658 // ESC E Next Line ( NEL is 0x85).
1659 // ESC D Index ( IND is 0x84).
1667 // ESC M Reverse Index ( RI is 0x8d).
1669 this.reverseIndex();
1672 // ESC % Select default/utf-8 character set.
1673 // @ = default, G = utf-8
1675 //this.charset = null;
1677 this.setgCharset(0, Terminal
.charsets
.US
);
1678 this.state
= normal
;
1682 // ESC (,),*,+,-,. Designate G0-G2 Character Set.
1683 case '(': // <-- this seems to get all the attention
1709 this.state
= charset
;
1712 // Designate G3 Character Set (VT300).
1713 // A = ISO Latin-1 Supplemental.
1717 this.state
= charset
;
1722 // Single Shift Select of G2 Character Set
1723 // ( SS2 is 0x8e). This affects next character only.
1727 // Single Shift Select of G3 Character Set
1728 // ( SS3 is 0x8f). This affects next character only.
1732 // Invoke the G2 Character Set as GL (LS2).
1737 // Invoke the G3 Character Set as GL (LS3).
1742 // Invoke the G3 Character Set as GR (LS3R).
1747 // Invoke the G2 Character Set as GR (LS2R).
1752 // Invoke the G1 Character Set as GR (LS1R).
1757 // ESC 7 Save Cursor (DECSC).
1760 this.state
= normal
;
1763 // ESC 8 Restore Cursor (DECRC).
1765 this.restoreCursor();
1766 this.state
= normal
;
1769 // ESC # 3 DEC line height/width
1771 this.state
= normal
;
1775 // ESC H Tab Set (HTS is 0x88).
1780 // ESC = Application Keypad (DECKPAM).
1782 this.log('Serial port requested application keypad.');
1783 this.applicationKeypad
= true;
1784 this.viewport
.syncScrollArea();
1785 this.state
= normal
;
1788 // ESC > Normal Keypad (DECKPNM).
1790 this.log('Switching back to normal keypad.');
1791 this.applicationKeypad
= false;
1792 this.viewport
.syncScrollArea();
1793 this.state
= normal
;
1797 this.state
= normal
;
1798 this.error('Unknown ESC control: %s.', ch
);
1805 case '0': // DEC Special Character and Line Drawing Set.
1806 cs
= Terminal
.charsets
.SCLD
;
1809 cs
= Terminal
.charsets
.UK
;
1811 case 'B': // United States (USASCII).
1812 cs
= Terminal
.charsets
.US
;
1815 cs
= Terminal
.charsets
.Dutch
;
1817 case 'C': // Finnish
1819 cs
= Terminal
.charsets
.Finnish
;
1822 cs
= Terminal
.charsets
.French
;
1824 case 'Q': // FrenchCanadian
1825 cs
= Terminal
.charsets
.FrenchCanadian
;
1828 cs
= Terminal
.charsets
.German
;
1830 case 'Y': // Italian
1831 cs
= Terminal
.charsets
.Italian
;
1833 case 'E': // NorwegianDanish
1835 cs
= Terminal
.charsets
.NorwegianDanish
;
1837 case 'Z': // Spanish
1838 cs
= Terminal
.charsets
.Spanish
;
1840 case 'H': // Swedish
1842 cs
= Terminal
.charsets
.Swedish
;
1845 cs
= Terminal
.charsets
.Swiss
;
1847 case '/': // ISOLatin (actually /A)
1848 cs
= Terminal
.charsets
.ISOLatin
;
1852 cs
= Terminal
.charsets
.US
;
1855 this.setgCharset(this.gcharset
, cs
);
1856 this.gcharset
= null;
1857 this.state
= normal
;
1863 // Set Text Parameters.
1864 if (ch
=== C0
.ESC
|| ch
=== C0
.BEL
) {
1865 if (ch
=== C0
.ESC
) i
++;
1867 this.params
.push(this.currentParam
);
1869 switch (this.params
[0]) {
1873 if (this.params
[1]) {
1874 this.title
= this.params
[1];
1875 this.handleTitle(this.title
);
1883 // change dynamic colors
1895 // change dynamic ui colors
1907 // manipulate selection data
1925 this.currentParam
= 0;
1926 this.state
= normal
;
1928 if (!this.params
.length
) {
1929 if (ch
>= '0' && ch
<= '9') {
1931 this.currentParam
* 10 + ch
.charCodeAt(0) - 48;
1932 } else if (ch
=== ';') {
1933 this.params
.push(this.currentParam
);
1934 this.currentParam
= '';
1937 this.currentParam
+= ch
;
1944 if (ch
=== '?' || ch
=== '>' || ch
=== '!') {
1950 if (ch
>= '0' && ch
<= '9') {
1951 this.currentParam
= this.currentParam
* 10 + ch
.charCodeAt(0) - 48;
1955 // '$', '"', ' ', '\''
1956 if (ch
=== '$' || ch
=== '"' || ch
=== ' ' || ch
=== '\'') {
1961 this.params
.push(this.currentParam
);
1962 this.currentParam
= 0;
1965 if (ch
=== ';') break;
1967 this.state
= normal
;
1971 // Cursor Up Ps Times (default = 1) (CUU).
1973 this.cursorUp(this.params
);
1977 // Cursor Down Ps Times (default = 1) (CUD).
1979 this.cursorDown(this.params
);
1983 // Cursor Forward Ps Times (default = 1) (CUF).
1985 this.cursorForward(this.params
);
1989 // Cursor Backward Ps Times (default = 1) (CUB).
1991 this.cursorBackward(this.params
);
1995 // Cursor Position [row;column] (default = [1,1]) (CUP).
1997 this.cursorPos(this.params
);
2000 // CSI Ps J Erase in Display (ED).
2002 this.eraseInDisplay(this.params
);
2005 // CSI Ps K Erase in Line (EL).
2007 this.eraseInLine(this.params
);
2010 // CSI Pm m Character Attributes (SGR).
2013 this.charAttributes(this.params
);
2017 // CSI Ps n Device Status Report (DSR).
2020 this.deviceStatus(this.params
);
2029 // Insert Ps (Blank) Character(s) (default = 1) (ICH).
2031 this.insertChars(this.params
);
2035 // Cursor Next Line Ps Times (default = 1) (CNL).
2037 this.cursorNextLine(this.params
);
2041 // Cursor Preceding Line Ps Times (default = 1) (CNL).
2043 this.cursorPrecedingLine(this.params
);
2047 // Cursor Character Absolute [column] (default = [row,1]) (CHA).
2049 this.cursorCharAbsolute(this.params
);
2053 // Insert Ps Line(s) (default = 1) (IL).
2055 this.insertLines(this.params
);
2059 // Delete Ps Line(s) (default = 1) (DL).
2061 this.deleteLines(this.params
);
2065 // Delete Ps Character(s) (default = 1) (DCH).
2067 this.deleteChars(this.params
);
2071 // Erase Ps Character(s) (default = 1) (ECH).
2073 this.eraseChars(this.params
);
2076 // CSI Pm ` Character Position Absolute
2077 // [column] (default = [row,1]) (HPA).
2079 this.charPosAbsolute(this.params
);
2083 // Horizontal Position Relative
2085 this.HPositionRelative(this.params
);
2089 // Send Device Attributes (Primary DA).
2091 // Send Device Attributes (Secondary DA)
2093 this.sendDeviceAttributes(this.params
);
2097 // Line Position Absolute [row] (default = [1,column]) (VPA).
2099 this.linePosAbsolute(this.params
);
2102 // 145 65 e * VPR - Vertical Position Relative
2104 this.VPositionRelative(this.params
);
2108 // Horizontal and Vertical Position [row;column] (default =
2111 this.HVPosition(this.params
);
2114 // CSI Pm h Set Mode (SM).
2115 // CSI ? Pm h - mouse escape codes, cursor escape codes
2117 this.setMode(this.params
);
2120 // CSI Pm l Reset Mode (RM).
2123 this.resetMode(this.params
);
2127 // Set Scrolling Region [top;bottom] (default = full size of win-
2131 this.setScrollRegion(this.params
);
2135 // Save cursor (ANSI.SYS).
2137 this.saveCursor(this.params
);
2141 // Restore cursor (ANSI.SYS).
2143 this.restoreCursor(this.params
);
2151 // Cursor Forward Tabulation Ps tab stops (default = 1) (CHT).
2153 this.cursorForwardTab(this.params
);
2156 // CSI Ps S Scroll up Ps lines (default = 1) (SU).
2158 this.scrollUp(this.params
);
2161 // CSI Ps T Scroll down Ps lines (default = 1) (SD).
2162 // CSI Ps ; Ps ; Ps ; Ps ; Ps T
2165 // if (this.prefix === '>') {
2166 // this.resetTitleModes(this.params);
2169 // if (this.params.length > 2) {
2170 // this.initMouseTracking(this.params);
2173 if (this.params
.length
< 2 && !this.prefix
) {
2174 this.scrollDown(this.params
);
2179 // Cursor Backward Tabulation Ps tab stops (default = 1) (CBT).
2181 this.cursorBackwardTab(this.params
);
2184 // CSI Ps b Repeat the preceding graphic character Ps times (REP).
2186 this.repeatPrecedingCharacter(this.params
);
2189 // CSI Ps g Tab Clear (TBC).
2191 this.tabClear(this.params
);
2194 // CSI Pm i Media Copy (MC).
2197 // this.mediaCopy(this.params);
2200 // CSI Pm m Character Attributes (SGR).
2202 // case 'm': // duplicate
2203 // if (this.prefix === '>') {
2204 // this.setResources(this.params);
2206 // this.charAttributes(this.params);
2210 // CSI Ps n Device Status Report (DSR).
2212 // case 'n': // duplicate
2213 // if (this.prefix === '>') {
2214 // this.disableModifiers(this.params);
2216 // this.deviceStatus(this.params);
2220 // CSI > Ps p Set pointer mode.
2221 // CSI ! p Soft terminal reset (DECSTR).
2223 // Request ANSI mode (DECRQM).
2225 // Request DEC private mode (DECRQM).
2228 switch (this.prefix
) {
2230 // this.setPointerMode(this.params);
2233 this.softReset(this.params
);
2236 // if (this.postfix === '$') {
2237 // this.requestPrivateMode(this.params);
2241 // if (this.postfix === '"') {
2242 // this.setConformanceLevel(this.params);
2243 // } else if (this.postfix === '$') {
2244 // this.requestAnsiMode(this.params);
2250 // CSI Ps q Load LEDs (DECLL).
2254 // if (this.postfix === ' ') {
2255 // this.setCursorStyle(this.params);
2258 // if (this.postfix === '"') {
2259 // this.setCharProtectionAttr(this.params);
2262 // this.loadLEDs(this.params);
2266 // Set Scrolling Region [top;bottom] (default = full size of win-
2269 // CSI Pt; Pl; Pb; Pr; Ps$ r
2270 // case 'r': // duplicate
2271 // if (this.prefix === '?') {
2272 // this.restorePrivateValues(this.params);
2273 // } else if (this.postfix === '$') {
2274 // this.setAttrInRectangle(this.params);
2276 // this.setScrollRegion(this.params);
2280 // CSI s Save cursor (ANSI.SYS).
2282 // case 's': // duplicate
2283 // if (this.prefix === '?') {
2284 // this.savePrivateValues(this.params);
2286 // this.saveCursor(this.params);
2290 // CSI Ps ; Ps ; Ps t
2291 // CSI Pt; Pl; Pb; Pr; Ps$ t
2295 // if (this.postfix === '$') {
2296 // this.reverseAttrInRectangle(this.params);
2297 // } else if (this.postfix === ' ') {
2298 // this.setWarningBellVolume(this.params);
2300 // if (this.prefix === '>') {
2301 // this.setTitleModeFeature(this.params);
2303 // this.manipulateWindow(this.params);
2308 // CSI u Restore cursor (ANSI.SYS).
2310 // case 'u': // duplicate
2311 // if (this.postfix === ' ') {
2312 // this.setMarginBellVolume(this.params);
2314 // this.restoreCursor(this.params);
2318 // CSI Pt; Pl; Pb; Pr; Pp; Pt; Pl; Pp$ v
2320 // if (this.postfix === '$') {
2321 // this.copyRectagle(this.params);
2325 // CSI Pt ; Pl ; Pb ; Pr ' w
2327 // if (this.postfix === '\'') {
2328 // this.enableFilterRectangle(this.params);
2332 // CSI Ps x Request Terminal Parameters (DECREQTPARM).
2333 // CSI Ps x Select Attribute Change Extent (DECSACE).
2334 // CSI Pc; Pt; Pl; Pb; Pr$ x
2336 // if (this.postfix === '$') {
2337 // this.fillRectangle(this.params);
2339 // this.requestParameters(this.params);
2340 // //this.__(this.params);
2345 // CSI Pt; Pl; Pb; Pr$ z
2347 // if (this.postfix === '\'') {
2348 // this.enableLocatorReporting(this.params);
2349 // } else if (this.postfix === '$') {
2350 // this.eraseRectangle(this.params);
2355 // CSI Pt; Pl; Pb; Pr$ {
2357 // if (this.postfix === '\'') {
2358 // this.setLocatorEvents(this.params);
2359 // } else if (this.postfix === '$') {
2360 // this.selectiveEraseRectangle(this.params);
2366 // if (this.postfix === '\'') {
2367 // this.requestLocatorPosition(this.params);
2372 // Insert P s Column(s) (default = 1) (DECIC), VT420 and up.
2374 // if (this.postfix === ' ') {
2375 // this.insertColumns(this.params);
2380 // Delete P s Column(s) (default = 1) (DECDC), VT420 and up
2382 // if (this.postfix === ' ') {
2383 // this.deleteColumns(this.params);
2388 this.error('Unknown CSI code: %s.', ch
);
2397 if (ch
=== C0
.ESC
|| ch
=== C0
.BEL
) {
2398 if (ch
=== C0
.ESC
) i
++;
2400 switch (this.prefix
) {
2401 // User-Defined Keys (DECUDK).
2405 // Request Status String (DECRQSS).
2406 // test: echo -e '\eP$q"p\e\\'
2408 var pt
= this.currentParam
2425 + (this.scrollTop
+ 1)
2427 + (this.scrollBottom
+ 1)
2437 this.error('Unknown DCS Pt: %s.', pt
);
2442 this.send(C0
.ESC
+ 'P' + +valid
+ '$r' + pt
+ C0
.ESC
+ '\\');
2445 // Set Termcap/Terminfo Data (xterm, experimental).
2449 // Request Termcap/Terminfo String (xterm, experimental)
2450 // Regular xterm does not even respond to this sequence.
2451 // This can cause a small glitch in vim.
2452 // test: echo -ne '\eP+q6b64\e\\'
2454 var pt
= this.currentParam
2457 this.send(C0
.ESC
+ 'P' + +valid
+ '+r' + pt
+ C0
.ESC
+ '\\');
2461 this.error('Unknown DCS prefix: %s.', this.prefix
);
2465 this.currentParam
= 0;
2467 this.state
= normal
;
2468 } else if (!this.currentParam
) {
2469 if (!this.prefix
&& ch
!== '$' && ch
!== '+') {
2470 this.currentParam
= ch
;
2471 } else if (this.prefix
.length
=== 2) {
2472 this.currentParam
= ch
;
2477 this.currentParam
+= ch
;
2483 if (ch
=== C0
.ESC
|| ch
=== C0
.BEL
) {
2484 if (ch
=== C0
.ESC
) i
++;
2485 this.state
= normal
;
2491 this.updateRange(this.y
);
2492 this.queueRefresh(this.refreshStart
, this.refreshEnd
);
2494 if (this.writeBuffer
.length
> 0) {
2495 // Allow renderer to catch up before processing the next batch
2497 setTimeout(function () {
2501 this.writeInProgress
= false;
2506 * Writes text to the terminal, followed by a break line character (\n).
2507 * @param {string} text The text to write to the terminal.
2509 Terminal
.prototype.writeln = function(data
) {
2510 this.write(data
+ '\r\n');
2514 * Attaches a custom keydown handler which is run before keys are processed, giving consumers of
2515 * xterm.js ultimate control as to what keys should be processed by the terminal and what keys
2517 * @param {function} customKeydownHandler The custom KeyboardEvent handler to attach. This is a
2518 * function that takes a KeyboardEvent, allowing consumers to stop propogation and/or prevent
2519 * the default action. The function returns whether the event should be processed by xterm.js.
2521 Terminal
.prototype.attachCustomKeydownHandler = function(customKeydownHandler
) {
2522 this.customKeydownHandler
= customKeydownHandler
;
2526 * Handle a keydown event
2528 * - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent
2529 * @param {KeyboardEvent} ev The keydown event to be handled.
2531 Terminal
.prototype.keyDown = function(ev
) {
2532 if (this.customKeydownHandler
&& this.customKeydownHandler(ev
) === false) {
2536 if (!this.compositionHelper
.keydown
.bind(this.compositionHelper
)(ev
)) {
2537 if (this.ybase
!== this.ydisp
) {
2538 this.scrollToBottom();
2544 var result
= this.evaluateKeyEscapeSequence(ev
);
2546 if (result
.key
=== C0
.DC3
) { // XOFF
2547 this.writeStopped
= true;
2548 } else if (result
.key
=== C0
.DC1
) { // XON
2549 this.writeStopped
= false;
2552 if (result
.scrollDisp
) {
2553 this.scrollDisp(result
.scrollDisp
);
2554 return this.cancel(ev
, true);
2557 if (isThirdLevelShift(this, ev
)) {
2561 if (result
.cancel
) {
2562 // The event is canceled at the end already, is this necessary?
2563 this.cancel(ev
, true);
2570 this.emit('keydown', ev
);
2571 this.emit('key', result
.key
, ev
);
2573 this.handler(result
.key
);
2575 return this.cancel(ev
, true);
2579 * Returns an object that determines how a KeyboardEvent should be handled. The key of the
2580 * returned value is the new key code to pass to the PTY.
2582 * Reference: http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
2583 * @param {KeyboardEvent} ev The keyboard event to be translated to key escape sequence.
2585 Terminal
.prototype.evaluateKeyEscapeSequence = function(ev
) {
2587 // Whether to cancel event propogation (NOTE: this may not be needed since the event is
2588 // canceled at the end of keyDown
2590 // The new key even to emit
2592 // The number of characters to scroll, if this is defined it will cancel the event
2593 scrollDisp
: undefined
2595 var modifiers
= ev
.shiftKey
<< 0 | ev
.altKey
<< 1 | ev
.ctrlKey
<< 2 | ev
.metaKey
<< 3;
2596 switch (ev
.keyCode
) {
2600 result
.key
= C0
.BS
; // ^H
2603 result
.key
= C0
.DEL
; // ^?
2608 result
.key
= C0
.ESC
+ '[Z';
2612 result
.cancel
= true;
2617 result
.cancel
= true;
2621 result
.key
= C0
.ESC
;
2622 result
.cancel
= true;
2627 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'D';
2628 // HACK: Make Alt + left-arrow behave like Ctrl + left-arrow: move one word backwards
2629 // http://unix.stackexchange.com/a/108106
2630 // macOS uses different escape sequences than linux
2631 if (result
.key
== C0
.ESC
+ '[1;3D') {
2632 result
.key
= (this.browser
.isMac
) ? C0
.ESC
+ 'b' : C0
.ESC
+ '[1;5D';
2634 } else if (this.applicationCursor
) {
2635 result
.key
= C0
.ESC
+ 'OD';
2637 result
.key
= C0
.ESC
+ '[D';
2643 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'C';
2644 // HACK: Make Alt + right-arrow behave like Ctrl + right-arrow: move one word forward
2645 // http://unix.stackexchange.com/a/108106
2646 // macOS uses different escape sequences than linux
2647 if (result
.key
== C0
.ESC
+ '[1;3C') {
2648 result
.key
= (this.browser
.isMac
) ? C0
.ESC
+ 'f' : C0
.ESC
+ '[1;5C';
2650 } else if (this.applicationCursor
) {
2651 result
.key
= C0
.ESC
+ 'OC';
2653 result
.key
= C0
.ESC
+ '[C';
2659 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'A';
2660 // HACK: Make Alt + up-arrow behave like Ctrl + up-arrow
2661 // http://unix.stackexchange.com/a/108106
2662 if (result
.key
== C0
.ESC
+ '[1;3A') {
2663 result
.key
= C0
.ESC
+ '[1;5A';
2665 } else if (this.applicationCursor
) {
2666 result
.key
= C0
.ESC
+ 'OA';
2668 result
.key
= C0
.ESC
+ '[A';
2674 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'B';
2675 // HACK: Make Alt + down-arrow behave like Ctrl + down-arrow
2676 // http://unix.stackexchange.com/a/108106
2677 if (result
.key
== C0
.ESC
+ '[1;3B') {
2678 result
.key
= C0
.ESC
+ '[1;5B';
2680 } else if (this.applicationCursor
) {
2681 result
.key
= C0
.ESC
+ 'OB';
2683 result
.key
= C0
.ESC
+ '[B';
2688 if (!ev
.shiftKey
&& !ev
.ctrlKey
) {
2689 // <Ctrl> or <Shift> + <Insert> are used to
2690 // copy-paste on some systems.
2691 result
.key
= C0
.ESC
+ '[2~';
2697 result
.key
= C0
.ESC
+ '[3;' + (modifiers
+ 1) + '~';
2699 result
.key
= C0
.ESC
+ '[3~';
2705 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'H';
2706 else if (this.applicationCursor
)
2707 result
.key
= C0
.ESC
+ 'OH';
2709 result
.key
= C0
.ESC
+ '[H';
2714 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'F';
2715 else if (this.applicationCursor
)
2716 result
.key
= C0
.ESC
+ 'OF';
2718 result
.key
= C0
.ESC
+ '[F';
2723 result
.scrollDisp
= -(this.rows
- 1);
2725 result
.key
= C0
.ESC
+ '[5~';
2731 result
.scrollDisp
= this.rows
- 1;
2733 result
.key
= C0
.ESC
+ '[6~';
2739 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'P';
2741 result
.key
= C0
.ESC
+ 'OP';
2746 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'Q';
2748 result
.key
= C0
.ESC
+ 'OQ';
2753 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'R';
2755 result
.key
= C0
.ESC
+ 'OR';
2760 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'S';
2762 result
.key
= C0
.ESC
+ 'OS';
2767 result
.key
= C0
.ESC
+ '[15;' + (modifiers
+ 1) + '~';
2769 result
.key
= C0
.ESC
+ '[15~';
2774 result
.key
= C0
.ESC
+ '[17;' + (modifiers
+ 1) + '~';
2776 result
.key
= C0
.ESC
+ '[17~';
2781 result
.key
= C0
.ESC
+ '[18;' + (modifiers
+ 1) + '~';
2783 result
.key
= C0
.ESC
+ '[18~';
2788 result
.key
= C0
.ESC
+ '[19;' + (modifiers
+ 1) + '~';
2790 result
.key
= C0
.ESC
+ '[19~';
2795 result
.key
= C0
.ESC
+ '[20;' + (modifiers
+ 1) + '~';
2797 result
.key
= C0
.ESC
+ '[20~';
2802 result
.key
= C0
.ESC
+ '[21;' + (modifiers
+ 1) + '~';
2804 result
.key
= C0
.ESC
+ '[21~';
2809 result
.key
= C0
.ESC
+ '[23;' + (modifiers
+ 1) + '~';
2811 result
.key
= C0
.ESC
+ '[23~';
2816 result
.key
= C0
.ESC
+ '[24;' + (modifiers
+ 1) + '~';
2818 result
.key
= C0
.ESC
+ '[24~';
2823 if (ev
.ctrlKey
&& !ev
.shiftKey
&& !ev
.altKey
&& !ev
.metaKey
) {
2824 if (ev
.keyCode
>= 65 && ev
.keyCode
<= 90) {
2825 result
.key
= String
.fromCharCode(ev
.keyCode
- 64);
2826 } else if (ev
.keyCode
=== 32) {
2828 result
.key
= String
.fromCharCode(0);
2829 } else if (ev
.keyCode
>= 51 && ev
.keyCode
<= 55) {
2830 // escape, file sep, group sep, record sep, unit sep
2831 result
.key
= String
.fromCharCode(ev
.keyCode
- 51 + 27);
2832 } else if (ev
.keyCode
=== 56) {
2834 result
.key
= String
.fromCharCode(127);
2835 } else if (ev
.keyCode
=== 219) {
2836 // ^[ - Control Sequence Introducer (CSI)
2837 result
.key
= String
.fromCharCode(27);
2838 } else if (ev
.keyCode
=== 220) {
2839 // ^\ - String Terminator (ST)
2840 result
.key
= String
.fromCharCode(28);
2841 } else if (ev
.keyCode
=== 221) {
2842 // ^] - Operating System Command (OSC)
2843 result
.key
= String
.fromCharCode(29);
2845 } else if (!this.browser
.isMac
&& ev
.altKey
&& !ev
.ctrlKey
&& !ev
.metaKey
) {
2846 // On Mac this is a third level shift. Use <Esc> instead.
2847 if (ev
.keyCode
>= 65 && ev
.keyCode
<= 90) {
2848 result
.key
= C0
.ESC
+ String
.fromCharCode(ev
.keyCode
+ 32);
2849 } else if (ev
.keyCode
=== 192) {
2850 result
.key
= C0
.ESC
+ '`';
2851 } else if (ev
.keyCode
>= 48 && ev
.keyCode
<= 57) {
2852 result
.key
= C0
.ESC
+ (ev
.keyCode
- 48);
2862 * Set the G level of the terminal
2865 Terminal
.prototype.setgLevel = function(g
) {
2867 this.charset
= this.charsets
[g
];
2871 * Set the charset for the given G level of the terminal
2875 Terminal
.prototype.setgCharset = function(g
, charset
) {
2876 this.charsets
[g
] = charset
;
2877 if (this.glevel
=== g
) {
2878 this.charset
= charset
;
2883 * Handle a keypress event.
2885 * - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent
2886 * @param {KeyboardEvent} ev The keypress event to be handled.
2888 Terminal
.prototype.keyPress = function(ev
) {
2895 } else if (ev
.which
== null) {
2897 } else if (ev
.which
!== 0 && ev
.charCode
!== 0) {
2904 (ev
.altKey
|| ev
.ctrlKey
|| ev
.metaKey
) && !isThirdLevelShift(this, ev
)
2909 key
= String
.fromCharCode(key
);
2911 this.emit('keypress', key
, ev
);
2912 this.emit('key', key
, ev
);
2920 * Send data for handling to the terminal
2921 * @param {string} data
2923 Terminal
.prototype.send = function(data
) {
2927 setTimeout(function() {
2928 self
.handler(self
.queue
);
2938 * Note: We could do sweet things with webaudio here
2940 Terminal
.prototype.bell = function() {
2941 if (!this.visualBell
) return;
2943 this.element
.style
.borderColor
= 'white';
2944 setTimeout(function() {
2945 self
.element
.style
.borderColor
= '';
2947 if (this.popOnBell
) this.focus();
2951 * Log the current state to the console.
2953 Terminal
.prototype.log = function() {
2954 if (!this.debug
) return;
2955 if (!this.context
.console
|| !this.context
.console
.log
) return;
2956 var args
= Array
.prototype.slice
.call(arguments
);
2957 this.context
.console
.log
.apply(this.context
.console
, args
);
2961 * Log the current state as error to the console.
2963 Terminal
.prototype.error = function() {
2964 if (!this.debug
) return;
2965 if (!this.context
.console
|| !this.context
.console
.error
) return;
2966 var args
= Array
.prototype.slice
.call(arguments
);
2967 this.context
.console
.error
.apply(this.context
.console
, args
);
2971 * Resizes the terminal.
2973 * @param {number} x The number of columns to resize to.
2974 * @param {number} y The number of rows to resize to.
2976 Terminal
.prototype.resize = function(x
, y
) {
2984 if (x
=== this.cols
&& y
=== this.rows
) {
2994 ch
= [this.defAttr
, ' ', 1]; // does xterm use the default attr?
2995 i
= this.lines
.length
;
2997 while (this.lines
.get(i
).length
< x
) {
2998 this.lines
.get(i
).push(ch
);
3002 i
= this.lines
.length
;
3004 while (this.lines
.get(i
).length
> x
) {
3005 this.lines
.get(i
).pop();
3018 // y is rows, not this.y
3019 if (this.lines
.length
< y
+ this.ybase
) {
3020 if (this.ybase
> 0 && this.lines
.length
<= this.ybase
+ this.y
+ addToY
+ 1) {
3021 // There is room above the buffer and there are no empty elements below the line,
3025 if (this.ydisp
> 0) {
3026 // Viewport is at the top of the buffer, must increase downwards
3030 // Add a blank line if there is no buffer left at the top to scroll to, or if there
3031 // are blank lines after the cursor
3032 this.lines
.push(this.blankLine());
3035 if (this.children
.length
< y
) {
3041 if (this.lines
.length
> y
+ this.ybase
) {
3042 if (this.lines
.length
> this.ybase
+ this.y
+ 1) {
3043 // The line is a blank line below the cursor, remove it
3046 // The line is the cursor, scroll down
3051 if (this.children
.length
> y
) {
3052 el
= this.children
.shift();
3054 el
.parentNode
.removeChild(el
);
3060 // Make sure that the cursor stays on screen
3073 this.scrollBottom
= y
- 1;
3075 this.charMeasure
.measure();
3077 this.queueRefresh(0, this.rows
- 1);
3081 this.geometry
= [this.cols
, this.rows
];
3082 this.emit('resize', {terminal
: this, cols
: x
, rows
: y
});
3086 * Updates the range of rows to refresh
3087 * @param {number} y The number of rows to refresh next.
3089 Terminal
.prototype.updateRange = function(y
) {
3090 if (y
< this.refreshStart
) this.refreshStart
= y
;
3091 if (y
> this.refreshEnd
) this.refreshEnd
= y
;
3092 // if (y > this.refreshEnd) {
3093 // this.refreshEnd = y;
3094 // if (y > this.rows - 1) {
3095 // this.refreshEnd = this.rows - 1;
3101 * Set the range of refreshing to the maximum value
3103 Terminal
.prototype.maxRange = function() {
3104 this.refreshStart
= 0;
3105 this.refreshEnd
= this.rows
- 1;
3111 * Setup the tab stops.
3114 Terminal
.prototype.setupStops = function(i
) {
3116 if (!this.tabs
[i
]) {
3117 i
= this.prevStop(i
);
3124 for (; i
< this.cols
; i
+= 8) {
3125 this.tabs
[i
] = true;
3131 * Move the cursor to the previous tab stop from the given position (default is current).
3132 * @param {number} x The position to move the cursor to the previous tab stop.
3134 Terminal
.prototype.prevStop = function(x
) {
3135 if (x
== null) x
= this.x
;
3136 while (!this.tabs
[--x
] && x
> 0);
3137 return x
>= this.cols
3144 * Move the cursor one tab stop forward from the given position (default is current).
3145 * @param {number} x The position to move the cursor one tab stop forward.
3147 Terminal
.prototype.nextStop = function(x
) {
3148 if (x
== null) x
= this.x
;
3149 while (!this.tabs
[++x
] && x
< this.cols
);
3150 return x
>= this.cols
3157 * Erase in the identified line everything from "x" to the end of the line (right).
3158 * @param {number} x The column from which to start erasing to the end of the line.
3159 * @param {number} y The line in which to operate.
3161 Terminal
.prototype.eraseRight = function(x
, y
) {
3162 var line
= this.lines
.get(this.ybase
+ y
)
3163 , ch
= [this.eraseAttr(), ' ', 1]; // xterm
3166 for (; x
< this.cols
; x
++) {
3170 this.updateRange(y
);
3176 * Erase in the identified line everything from "x" to the start of the line (left).
3177 * @param {number} x The column from which to start erasing to the start of the line.
3178 * @param {number} y The line in which to operate.
3180 Terminal
.prototype.eraseLeft = function(x
, y
) {
3181 var line
= this.lines
.get(this.ybase
+ y
)
3182 , ch
= [this.eraseAttr(), ' ', 1]; // xterm
3185 while (x
--) line
[x
] = ch
;
3187 this.updateRange(y
);
3191 * Clears the entire buffer, making the prompt line the new first line.
3193 Terminal
.prototype.clear = function() {
3194 if (this.ybase
=== 0 && this.y
=== 0) {
3195 // Don't clear if it's already clear
3198 this.lines
.set(0, this.lines
.get(this.ybase
+ this.y
));
3199 this.lines
.length
= 1;
3203 for (var i
= 1; i
< this.rows
; i
++) {
3204 this.lines
.push(this.blankLine());
3206 this.queueRefresh(0, this.rows
- 1);
3207 this.emit('scroll', this.ydisp
);
3211 * Erase all content in the given line
3212 * @param {number} y The line to erase all of its contents.
3214 Terminal
.prototype.eraseLine = function(y
) {
3215 this.eraseRight(0, y
);
3220 * Return the data array of a blank line
3221 * @param {number} cur First bunch of data for each "blank" character.
3223 Terminal
.prototype.blankLine = function(cur
) {
3228 var ch
= [attr
, ' ', 1] // width defaults to 1 halfwidth character
3232 for (; i
< this.cols
; i
++) {
3241 * If cur return the back color xterm feature attribute. Else return defAttr.
3242 * @param {object} cur
3244 Terminal
.prototype.ch = function(cur
) {
3246 ? [this.eraseAttr(), ' ', 1]
3247 : [this.defAttr
, ' ', 1];
3252 * Evaluate if the current erminal is the given argument.
3253 * @param {object} term The terminal to evaluate
3255 Terminal
.prototype.is = function(term
) {
3256 var name
= this.termName
;
3257 return (name
+ '').indexOf(term
) === 0;
3262 * Emit the 'data' event and populate the given data.
3263 * @param {string} data The data to populate in the event.
3265 Terminal
.prototype.handler = function(data
) {
3266 // Prevents all events to pty process if stdin is disabled
3267 if (this.options
.disableStdin
) {
3271 // Input is being sent to the terminal, the terminal should focus the prompt.
3272 if (this.ybase
!== this.ydisp
) {
3273 this.scrollToBottom();
3275 this.emit('data', data
);
3280 * Emit the 'title' event and populate the given title.
3281 * @param {string} title The title to populate in the event.
3283 Terminal
.prototype.handleTitle = function(title
) {
3285 * This event is emitted when the title of the terminal is changed
3286 * from inside the terminal. The parameter is the new title.
3290 this.emit('title', title
);
3299 * ESC D Index (IND is 0x84).
3301 Terminal
.prototype.index = function() {
3303 if (this.y
> this.scrollBottom
) {
3307 this.state
= normal
;
3312 * ESC M Reverse Index (RI is 0x8d).
3314 * Move the cursor up one row, inserting a new blank line if necessary.
3316 Terminal
.prototype.reverseIndex = function() {
3318 if (this.y
=== this.scrollTop
) {
3319 // possibly move the code below to term.reverseScroll();
3320 // test: echo -ne '\e[1;1H\e[44m\eM\e[0m'
3321 // blankLine(true) is xterm/linux behavior
3322 this.lines
.shiftElements(this.y
+ this.ybase
, this.rows
- 1, 1);
3323 this.lines
.set(this.y
+ this.ybase
, this.blankLine(true));
3324 this.updateRange(this.scrollTop
);
3325 this.updateRange(this.scrollBottom
);
3329 this.state
= normal
;
3334 * ESC c Full Reset (RIS).
3336 Terminal
.prototype.reset = function() {
3337 this.options
.rows
= this.rows
;
3338 this.options
.cols
= this.cols
;
3339 var customKeydownHandler
= this.customKeydownHandler
;
3340 Terminal
.call(this, this.options
);
3341 this.customKeydownHandler
= customKeydownHandler
;
3342 this.queueRefresh(0, this.rows
- 1);
3343 this.viewport
.syncScrollArea();
3348 * ESC H Tab Set (HTS is 0x88).
3350 Terminal
.prototype.tabSet = function() {
3351 this.tabs
[this.x
] = true;
3352 this.state
= normal
;
3362 * Cursor Up Ps Times (default = 1) (CUU).
3364 Terminal
.prototype.cursorUp = function(params
) {
3365 var param
= params
[0];
3366 if (param
< 1) param
= 1;
3368 if (this.y
< 0) this.y
= 0;
3374 * Cursor Down Ps Times (default = 1) (CUD).
3376 Terminal
.prototype.cursorDown = function(params
) {
3377 var param
= params
[0];
3378 if (param
< 1) param
= 1;
3380 if (this.y
>= this.rows
) {
3381 this.y
= this.rows
- 1;
3388 * Cursor Forward Ps Times (default = 1) (CUF).
3390 Terminal
.prototype.cursorForward = function(params
) {
3391 var param
= params
[0];
3392 if (param
< 1) param
= 1;
3394 if (this.x
>= this.cols
) {
3395 this.x
= this.cols
- 1;
3402 * Cursor Backward Ps Times (default = 1) (CUB).
3404 Terminal
.prototype.cursorBackward = function(params
) {
3405 var param
= params
[0];
3406 if (param
< 1) param
= 1;
3408 if (this.x
< 0) this.x
= 0;
3414 * Cursor Position [row;column] (default = [1,1]) (CUP).
3416 Terminal
.prototype.cursorPos = function(params
) {
3419 row
= params
[0] - 1;
3421 if (params
.length
>= 2) {
3422 col
= params
[1] - 1;
3429 } else if (row
>= this.rows
) {
3430 row
= this.rows
- 1;
3435 } else if (col
>= this.cols
) {
3436 col
= this.cols
- 1;
3445 * CSI Ps J Erase in Display (ED).
3446 * Ps = 0 -> Erase Below (default).
3447 * Ps = 1 -> Erase Above.
3448 * Ps = 2 -> Erase All.
3449 * Ps = 3 -> Erase Saved Lines (xterm).
3451 * Erase in Display (DECSED).
3452 * Ps = 0 -> Selective Erase Below (default).
3453 * Ps = 1 -> Selective Erase Above.
3454 * Ps = 2 -> Selective Erase All.
3456 Terminal
.prototype.eraseInDisplay = function(params
) {
3458 switch (params
[0]) {
3460 this.eraseRight(this.x
, this.y
);
3462 for (; j
< this.rows
; j
++) {
3467 this.eraseLeft(this.x
, this.y
);
3475 while (j
--) this.eraseLine(j
);
3485 * CSI Ps K Erase in Line (EL).
3486 * Ps = 0 -> Erase to Right (default).
3487 * Ps = 1 -> Erase to Left.
3488 * Ps = 2 -> Erase All.
3490 * Erase in Line (DECSEL).
3491 * Ps = 0 -> Selective Erase to Right (default).
3492 * Ps = 1 -> Selective Erase to Left.
3493 * Ps = 2 -> Selective Erase All.
3495 Terminal
.prototype.eraseInLine = function(params
) {
3496 switch (params
[0]) {
3498 this.eraseRight(this.x
, this.y
);
3501 this.eraseLeft(this.x
, this.y
);
3504 this.eraseLine(this.y
);
3511 * CSI Pm m Character Attributes (SGR).
3512 * Ps = 0 -> Normal (default).
3514 * Ps = 4 -> Underlined.
3515 * Ps = 5 -> Blink (appears as Bold).
3516 * Ps = 7 -> Inverse.
3517 * Ps = 8 -> Invisible, i.e., hidden (VT300).
3518 * Ps = 2 2 -> Normal (neither bold nor faint).
3519 * Ps = 2 4 -> Not underlined.
3520 * Ps = 2 5 -> Steady (not blinking).
3521 * Ps = 2 7 -> Positive (not inverse).
3522 * Ps = 2 8 -> Visible, i.e., not hidden (VT300).
3523 * Ps = 3 0 -> Set foreground color to Black.
3524 * Ps = 3 1 -> Set foreground color to Red.
3525 * Ps = 3 2 -> Set foreground color to Green.
3526 * Ps = 3 3 -> Set foreground color to Yellow.
3527 * Ps = 3 4 -> Set foreground color to Blue.
3528 * Ps = 3 5 -> Set foreground color to Magenta.
3529 * Ps = 3 6 -> Set foreground color to Cyan.
3530 * Ps = 3 7 -> Set foreground color to White.
3531 * Ps = 3 9 -> Set foreground color to default (original).
3532 * Ps = 4 0 -> Set background color to Black.
3533 * Ps = 4 1 -> Set background color to Red.
3534 * Ps = 4 2 -> Set background color to Green.
3535 * Ps = 4 3 -> Set background color to Yellow.
3536 * Ps = 4 4 -> Set background color to Blue.
3537 * Ps = 4 5 -> Set background color to Magenta.
3538 * Ps = 4 6 -> Set background color to Cyan.
3539 * Ps = 4 7 -> Set background color to White.
3540 * Ps = 4 9 -> Set background color to default (original).
3542 * If 16-color support is compiled, the following apply. Assume
3543 * that xterm's resources are set so that the ISO color codes are
3544 * the first 8 of a set of 16. Then the aixterm colors are the
3545 * bright versions of the ISO colors:
3546 * Ps = 9 0 -> Set foreground color to Black.
3547 * Ps = 9 1 -> Set foreground color to Red.
3548 * Ps = 9 2 -> Set foreground color to Green.
3549 * Ps = 9 3 -> Set foreground color to Yellow.
3550 * Ps = 9 4 -> Set foreground color to Blue.
3551 * Ps = 9 5 -> Set foreground color to Magenta.
3552 * Ps = 9 6 -> Set foreground color to Cyan.
3553 * Ps = 9 7 -> Set foreground color to White.
3554 * Ps = 1 0 0 -> Set background color to Black.
3555 * Ps = 1 0 1 -> Set background color to Red.
3556 * Ps = 1 0 2 -> Set background color to Green.
3557 * Ps = 1 0 3 -> Set background color to Yellow.
3558 * Ps = 1 0 4 -> Set background color to Blue.
3559 * Ps = 1 0 5 -> Set background color to Magenta.
3560 * Ps = 1 0 6 -> Set background color to Cyan.
3561 * Ps = 1 0 7 -> Set background color to White.
3563 * If xterm is compiled with the 16-color support disabled, it
3564 * supports the following, from rxvt:
3565 * Ps = 1 0 0 -> Set foreground and background color to
3568 * If 88- or 256-color support is compiled, the following apply.
3569 * Ps = 3 8 ; 5 ; Ps -> Set foreground color to the second
3571 * Ps = 4 8 ; 5 ; Ps -> Set background color to the second
3574 Terminal
.prototype.charAttributes = function(params
) {
3575 // Optimize a single SGR0.
3576 if (params
.length
=== 1 && params
[0] === 0) {
3577 this.curAttr
= this.defAttr
;
3581 var l
= params
.length
3583 , flags
= this.curAttr
>> 18
3584 , fg
= (this.curAttr
>> 9) & 0x1ff
3585 , bg
= this.curAttr
& 0x1ff
3588 for (; i
< l
; i
++) {
3590 if (p
>= 30 && p
<= 37) {
3593 } else if (p
>= 40 && p
<= 47) {
3596 } else if (p
>= 90 && p
<= 97) {
3600 } else if (p
>= 100 && p
<= 107) {
3604 } else if (p
=== 0) {
3606 flags
= this.defAttr
>> 18;
3607 fg
= (this.defAttr
>> 9) & 0x1ff;
3608 bg
= this.defAttr
& 0x1ff;
3612 } else if (p
=== 1) {
3615 } else if (p
=== 4) {
3618 } else if (p
=== 5) {
3621 } else if (p
=== 7) {
3622 // inverse and positive
3623 // test with: echo -e '\e[31m\e[42mhello\e[7mworld\e[27mhi\e[m'
3625 } else if (p
=== 8) {
3628 } else if (p
=== 22) {
3631 } else if (p
=== 24) {
3634 } else if (p
=== 25) {
3637 } else if (p
=== 27) {
3640 } else if (p
=== 28) {
3643 } else if (p
=== 39) {
3645 fg
= (this.defAttr
>> 9) & 0x1ff;
3646 } else if (p
=== 49) {
3648 bg
= this.defAttr
& 0x1ff;
3649 } else if (p
=== 38) {
3651 if (params
[i
+ 1] === 2) {
3655 params
[i
+ 1] & 0xff,
3656 params
[i
+ 2] & 0xff);
3657 if (fg
=== -1) fg
= 0x1ff;
3659 } else if (params
[i
+ 1] === 5) {
3661 p
= params
[i
] & 0xff;
3664 } else if (p
=== 48) {
3666 if (params
[i
+ 1] === 2) {
3670 params
[i
+ 1] & 0xff,
3671 params
[i
+ 2] & 0xff);
3672 if (bg
=== -1) bg
= 0x1ff;
3674 } else if (params
[i
+ 1] === 5) {
3676 p
= params
[i
] & 0xff;
3679 } else if (p
=== 100) {
3681 fg
= (this.defAttr
>> 9) & 0x1ff;
3682 bg
= this.defAttr
& 0x1ff;
3684 this.error('Unknown SGR attribute: %d.', p
);
3688 this.curAttr
= (flags
<< 18) | (fg
<< 9) | bg
;
3693 * CSI Ps n Device Status Report (DSR).
3694 * Ps = 5 -> Status Report. Result (``OK'') is
3696 * Ps = 6 -> Report Cursor Position (CPR) [row;column].
3700 * Device Status Report (DSR, DEC-specific).
3701 * Ps = 6 -> Report Cursor Position (CPR) [row;column] as CSI
3702 * ? r ; c R (assumes page is zero).
3703 * Ps = 1 5 -> Report Printer status as CSI ? 1 0 n (ready).
3704 * or CSI ? 1 1 n (not ready).
3705 * Ps = 2 5 -> Report UDK status as CSI ? 2 0 n (unlocked)
3706 * or CSI ? 2 1 n (locked).
3707 * Ps = 2 6 -> Report Keyboard status as
3708 * CSI ? 2 7 ; 1 ; 0 ; 0 n (North American).
3709 * The last two parameters apply to VT400 & up, and denote key-
3710 * board ready and LK01 respectively.
3711 * Ps = 5 3 -> Report Locator status as
3712 * CSI ? 5 3 n Locator available, if compiled-in, or
3713 * CSI ? 5 0 n No Locator, if not.
3715 Terminal
.prototype.deviceStatus = function(params
) {
3717 switch (params
[0]) {
3720 this.send(C0
.ESC
+ '[0n');
3724 this.send(C0
.ESC
+ '['
3731 } else if (this.prefix
=== '?') {
3732 // modern xterm doesnt seem to
3733 // respond to any of these except ?6, 6, and 5
3734 switch (params
[0]) {
3737 this.send(C0
.ESC
+ '[?'
3745 // this.send(C0.ESC + '[?11n');
3748 // dont support user defined keys
3749 // this.send(C0.ESC + '[?21n');
3752 // north american keyboard
3753 // this.send(C0.ESC + '[?27;1;0;0n');
3756 // no dec locator/mouse
3757 // this.send(C0.ESC + '[?50n');
3770 * Insert Ps (Blank) Character(s) (default = 1) (ICH).
3772 Terminal
.prototype.insertChars = function(params
) {
3773 var param
, row
, j
, ch
;
3776 if (param
< 1) param
= 1;
3778 row
= this.y
+ this.ybase
;
3780 ch
= [this.eraseAttr(), ' ', 1]; // xterm
3782 while (param
-- && j
< this.cols
) {
3783 this.lines
.get(row
).splice(j
++, 0, ch
);
3784 this.lines
.get(row
).pop();
3790 * Cursor Next Line Ps Times (default = 1) (CNL).
3791 * same as CSI Ps B ?
3793 Terminal
.prototype.cursorNextLine = function(params
) {
3794 var param
= params
[0];
3795 if (param
< 1) param
= 1;
3797 if (this.y
>= this.rows
) {
3798 this.y
= this.rows
- 1;
3806 * Cursor Preceding Line Ps Times (default = 1) (CNL).
3809 Terminal
.prototype.cursorPrecedingLine = function(params
) {
3810 var param
= params
[0];
3811 if (param
< 1) param
= 1;
3813 if (this.y
< 0) this.y
= 0;
3820 * Cursor Character Absolute [column] (default = [row,1]) (CHA).
3822 Terminal
.prototype.cursorCharAbsolute = function(params
) {
3823 var param
= params
[0];
3824 if (param
< 1) param
= 1;
3831 * Insert Ps Line(s) (default = 1) (IL).
3833 Terminal
.prototype.insertLines = function(params
) {
3837 if (param
< 1) param
= 1;
3838 row
= this.y
+ this.ybase
;
3840 j
= this.rows
- 1 - this.scrollBottom
;
3841 j
= this.rows
- 1 + this.ybase
- j
+ 1;
3844 if (this.lines
.length
=== this.lines
.maxLength
) {
3845 // Trim the start of lines to make room for the new line
3846 this.lines
.trimStart(1);
3852 // test: echo -e '\e[44m\e[1L\e[0m'
3853 // blankLine(true) - xterm/linux behavior
3854 this.lines
.splice(row
, 0, this.blankLine(true));
3855 this.lines
.splice(j
, 1);
3859 this.updateRange(this.y
);
3860 this.updateRange(this.scrollBottom
);
3866 * Delete Ps Line(s) (default = 1) (DL).
3868 Terminal
.prototype.deleteLines = function(params
) {
3872 if (param
< 1) param
= 1;
3873 row
= this.y
+ this.ybase
;
3875 j
= this.rows
- 1 - this.scrollBottom
;
3876 j
= this.rows
- 1 + this.ybase
- j
;
3879 if (this.lines
.length
=== this.lines
.maxLength
) {
3880 // Trim the start of lines to make room for the new line
3881 this.lines
.trimStart(1);
3885 // test: echo -e '\e[44m\e[1M\e[0m'
3886 // blankLine(true) - xterm/linux behavior
3887 this.lines
.splice(j
+ 1, 0, this.blankLine(true));
3888 this.lines
.splice(row
, 1);
3892 this.updateRange(this.y
);
3893 this.updateRange(this.scrollBottom
);
3899 * Delete Ps Character(s) (default = 1) (DCH).
3901 Terminal
.prototype.deleteChars = function(params
) {
3905 if (param
< 1) param
= 1;
3907 row
= this.y
+ this.ybase
;
3908 ch
= [this.eraseAttr(), ' ', 1]; // xterm
3911 this.lines
.get(row
).splice(this.x
, 1);
3912 this.lines
.get(row
).push(ch
);
3918 * Erase Ps Character(s) (default = 1) (ECH).
3920 Terminal
.prototype.eraseChars = function(params
) {
3921 var param
, row
, j
, ch
;
3924 if (param
< 1) param
= 1;
3926 row
= this.y
+ this.ybase
;
3928 ch
= [this.eraseAttr(), ' ', 1]; // xterm
3930 while (param
-- && j
< this.cols
) {
3931 this.lines
.get(row
)[j
++] = ch
;
3936 * CSI Pm ` Character Position Absolute
3937 * [column] (default = [row,1]) (HPA).
3939 Terminal
.prototype.charPosAbsolute = function(params
) {
3940 var param
= params
[0];
3941 if (param
< 1) param
= 1;
3943 if (this.x
>= this.cols
) {
3944 this.x
= this.cols
- 1;
3951 * Horizontal Position Relative
3954 Terminal
.prototype.HPositionRelative = function(params
) {
3955 var param
= params
[0];
3956 if (param
< 1) param
= 1;
3958 if (this.x
>= this.cols
) {
3959 this.x
= this.cols
- 1;
3965 * CSI Ps c Send Device Attributes (Primary DA).
3966 * Ps = 0 or omitted -> request attributes from terminal. The
3967 * response depends on the decTerminalID resource setting.
3968 * -> CSI ? 1 ; 2 c (``VT100 with Advanced Video Option'')
3969 * -> CSI ? 1 ; 0 c (``VT101 with No Options'')
3970 * -> CSI ? 6 c (``VT102'')
3971 * -> CSI ? 6 0 ; 1 ; 2 ; 6 ; 8 ; 9 ; 1 5 ; c (``VT220'')
3972 * The VT100-style response parameters do not mean anything by
3973 * themselves. VT220 parameters do, telling the host what fea-
3974 * tures the terminal supports:
3975 * Ps = 1 -> 132-columns.
3976 * Ps = 2 -> Printer.
3977 * Ps = 6 -> Selective erase.
3978 * Ps = 8 -> User-defined keys.
3979 * Ps = 9 -> National replacement character sets.
3980 * Ps = 1 5 -> Technical characters.
3981 * Ps = 2 2 -> ANSI color, e.g., VT525.
3982 * Ps = 2 9 -> ANSI text locator (i.e., DEC Locator mode).
3984 * Send Device Attributes (Secondary DA).
3985 * Ps = 0 or omitted -> request the terminal's identification
3986 * code. The response depends on the decTerminalID resource set-
3987 * ting. It should apply only to VT220 and up, but xterm extends
3989 * -> CSI > Pp ; Pv ; Pc c
3990 * where Pp denotes the terminal type
3991 * Pp = 0 -> ``VT100''.
3992 * Pp = 1 -> ``VT220''.
3993 * and Pv is the firmware version (for xterm, this was originally
3994 * the XFree86 patch number, starting with 95). In a DEC termi-
3995 * nal, Pc indicates the ROM cartridge registration number and is
3998 * xterm/charproc.c - line 2012, for more information.
3999 * vim responds with ^[[?0c or ^[[?1c after the terminal's response (?)
4001 Terminal
.prototype.sendDeviceAttributes = function(params
) {
4002 if (params
[0] > 0) return;
4005 if (this.is('xterm')
4006 || this.is('rxvt-unicode')
4007 || this.is('screen')) {
4008 this.send(C0
.ESC
+ '[?1;2c');
4009 } else if (this.is('linux')) {
4010 this.send(C0
.ESC
+ '[?6c');
4012 } else if (this.prefix
=== '>') {
4014 // seem to spit this
4015 // out around ~370 times (?).
4016 if (this.is('xterm')) {
4017 this.send(C0
.ESC
+ '[>0;276;0c');
4018 } else if (this.is('rxvt-unicode')) {
4019 this.send(C0
.ESC
+ '[>85;95;0c');
4020 } else if (this.is('linux')) {
4021 // not supported by linux console.
4022 // linux console echoes parameters.
4023 this.send(params
[0] + 'c');
4024 } else if (this.is('screen')) {
4025 this.send(C0
.ESC
+ '[>83;40003;0c');
4033 * Line Position Absolute [row] (default = [1,column]) (VPA).
4035 Terminal
.prototype.linePosAbsolute = function(params
) {
4036 var param
= params
[0];
4037 if (param
< 1) param
= 1;
4039 if (this.y
>= this.rows
) {
4040 this.y
= this.rows
- 1;
4046 * 145 65 e * VPR - Vertical Position Relative
4049 Terminal
.prototype.VPositionRelative = function(params
) {
4050 var param
= params
[0];
4051 if (param
< 1) param
= 1;
4053 if (this.y
>= this.rows
) {
4054 this.y
= this.rows
- 1;
4061 * Horizontal and Vertical Position [row;column] (default =
4064 Terminal
.prototype.HVPosition = function(params
) {
4065 if (params
[0] < 1) params
[0] = 1;
4066 if (params
[1] < 1) params
[1] = 1;
4068 this.y
= params
[0] - 1;
4069 if (this.y
>= this.rows
) {
4070 this.y
= this.rows
- 1;
4073 this.x
= params
[1] - 1;
4074 if (this.x
>= this.cols
) {
4075 this.x
= this.cols
- 1;
4081 * CSI Pm h Set Mode (SM).
4082 * Ps = 2 -> Keyboard Action Mode (AM).
4083 * Ps = 4 -> Insert Mode (IRM).
4084 * Ps = 1 2 -> Send/receive (SRM).
4085 * Ps = 2 0 -> Automatic Newline (LNM).
4087 * DEC Private Mode Set (DECSET).
4088 * Ps = 1 -> Application Cursor Keys (DECCKM).
4089 * Ps = 2 -> Designate USASCII for character sets G0-G3
4090 * (DECANM), and set VT100 mode.
4091 * Ps = 3 -> 132 Column Mode (DECCOLM).
4092 * Ps = 4 -> Smooth (Slow) Scroll (DECSCLM).
4093 * Ps = 5 -> Reverse Video (DECSCNM).
4094 * Ps = 6 -> Origin Mode (DECOM).
4095 * Ps = 7 -> Wraparound Mode (DECAWM).
4096 * Ps = 8 -> Auto-repeat Keys (DECARM).
4097 * Ps = 9 -> Send Mouse X & Y on button press. See the sec-
4098 * tion Mouse Tracking.
4099 * Ps = 1 0 -> Show toolbar (rxvt).
4100 * Ps = 1 2 -> Start Blinking Cursor (att610).
4101 * Ps = 1 8 -> Print form feed (DECPFF).
4102 * Ps = 1 9 -> Set print extent to full screen (DECPEX).
4103 * Ps = 2 5 -> Show Cursor (DECTCEM).
4104 * Ps = 3 0 -> Show scrollbar (rxvt).
4105 * Ps = 3 5 -> Enable font-shifting functions (rxvt).
4106 * Ps = 3 8 -> Enter Tektronix Mode (DECTEK).
4107 * Ps = 4 0 -> Allow 80 -> 132 Mode.
4108 * Ps = 4 1 -> more(1) fix (see curses resource).
4109 * Ps = 4 2 -> Enable Nation Replacement Character sets (DECN-
4111 * Ps = 4 4 -> Turn On Margin Bell.
4112 * Ps = 4 5 -> Reverse-wraparound Mode.
4113 * Ps = 4 6 -> Start Logging. This is normally disabled by a
4114 * compile-time option.
4115 * Ps = 4 7 -> Use Alternate Screen Buffer. (This may be dis-
4116 * abled by the titeInhibit resource).
4117 * Ps = 6 6 -> Application keypad (DECNKM).
4118 * Ps = 6 7 -> Backarrow key sends backspace (DECBKM).
4119 * Ps = 1 0 0 0 -> Send Mouse X & Y on button press and
4120 * release. See the section Mouse Tracking.
4121 * Ps = 1 0 0 1 -> Use Hilite Mouse Tracking.
4122 * Ps = 1 0 0 2 -> Use Cell Motion Mouse Tracking.
4123 * Ps = 1 0 0 3 -> Use All Motion Mouse Tracking.
4124 * Ps = 1 0 0 4 -> Send FocusIn/FocusOut events.
4125 * Ps = 1 0 0 5 -> Enable Extended Mouse Mode.
4126 * Ps = 1 0 1 0 -> Scroll to bottom on tty output (rxvt).
4127 * Ps = 1 0 1 1 -> Scroll to bottom on key press (rxvt).
4128 * Ps = 1 0 3 4 -> Interpret "meta" key, sets eighth bit.
4129 * (enables the eightBitInput resource).
4130 * Ps = 1 0 3 5 -> Enable special modifiers for Alt and Num-
4131 * Lock keys. (This enables the numLock resource).
4132 * Ps = 1 0 3 6 -> Send ESC when Meta modifies a key. (This
4133 * enables the metaSendsEscape resource).
4134 * Ps = 1 0 3 7 -> Send DEL from the editing-keypad Delete
4136 * Ps = 1 0 3 9 -> Send ESC when Alt modifies a key. (This
4137 * enables the altSendsEscape resource).
4138 * Ps = 1 0 4 0 -> Keep selection even if not highlighted.
4139 * (This enables the keepSelection resource).
4140 * Ps = 1 0 4 1 -> Use the CLIPBOARD selection. (This enables
4141 * the selectToClipboard resource).
4142 * Ps = 1 0 4 2 -> Enable Urgency window manager hint when
4143 * Control-G is received. (This enables the bellIsUrgent
4145 * Ps = 1 0 4 3 -> Enable raising of the window when Control-G
4146 * is received. (enables the popOnBell resource).
4147 * Ps = 1 0 4 7 -> Use Alternate Screen Buffer. (This may be
4148 * disabled by the titeInhibit resource).
4149 * Ps = 1 0 4 8 -> Save cursor as in DECSC. (This may be dis-
4150 * abled by the titeInhibit resource).
4151 * Ps = 1 0 4 9 -> Save cursor as in DECSC and use Alternate
4152 * Screen Buffer, clearing it first. (This may be disabled by
4153 * the titeInhibit resource). This combines the effects of the 1
4154 * 0 4 7 and 1 0 4 8 modes. Use this with terminfo-based
4155 * applications rather than the 4 7 mode.
4156 * Ps = 1 0 5 0 -> Set terminfo/termcap function-key mode.
4157 * Ps = 1 0 5 1 -> Set Sun function-key mode.
4158 * Ps = 1 0 5 2 -> Set HP function-key mode.
4159 * Ps = 1 0 5 3 -> Set SCO function-key mode.
4160 * Ps = 1 0 6 0 -> Set legacy keyboard emulation (X11R6).
4161 * Ps = 1 0 6 1 -> Set VT220 keyboard emulation.
4162 * Ps = 2 0 0 4 -> Set bracketed paste mode.
4164 * http: *vt100.net/docs/vt220-rm/chapter4.html
4166 Terminal
.prototype.setMode = function(params
) {
4167 if (typeof params
=== 'object') {
4168 var l
= params
.length
4171 for (; i
< l
; i
++) {
4172 this.setMode(params
[i
]);
4181 this.insertMode
= true;
4184 //this.convertEol = true;
4187 } else if (this.prefix
=== '?') {
4190 this.applicationCursor
= true;
4193 this.setgCharset(0, Terminal
.charsets
.US
);
4194 this.setgCharset(1, Terminal
.charsets
.US
);
4195 this.setgCharset(2, Terminal
.charsets
.US
);
4196 this.setgCharset(3, Terminal
.charsets
.US
);
4197 // set VT100 mode here
4199 case 3: // 132 col mode
4200 this.savedCols
= this.cols
;
4201 this.resize(132, this.rows
);
4204 this.originMode
= true;
4207 this.wraparoundMode
= true;
4210 // this.cursorBlink = true;
4213 this.log('Serial port requested application keypad.');
4214 this.applicationKeypad
= true;
4215 this.viewport
.syncScrollArea();
4217 case 9: // X10 Mouse
4218 // no release, no motion, no wheel, no modifiers.
4219 case 1000: // vt200 mouse
4221 // no modifiers, except control on the wheel.
4222 case 1002: // button event mouse
4223 case 1003: // any event mouse
4224 // any event - sends motion events,
4225 // even if there is no button held down.
4226 this.x10Mouse
= params
=== 9;
4227 this.vt200Mouse
= params
=== 1000;
4228 this.normalMouse
= params
> 1000;
4229 this.mouseEvents
= true;
4230 this.element
.style
.cursor
= 'default';
4231 this.log('Binding to mouse events.');
4233 case 1004: // send focusin/focusout events
4236 this.sendFocus
= true;
4238 case 1005: // utf8 ext mode mouse
4239 this.utfMouse
= true;
4240 // for wide terminals
4241 // simply encodes large values as utf8 characters
4243 case 1006: // sgr ext mode mouse
4244 this.sgrMouse
= true;
4245 // for wide terminals
4246 // does not add 32 to fields
4247 // press: ^[[<b;x;yM
4248 // release: ^[[<b;x;ym
4250 case 1015: // urxvt ext mode mouse
4251 this.urxvtMouse
= true;
4252 // for wide terminals
4253 // numbers for fields
4255 // motion: ^[[b;x;yT
4257 case 25: // show cursor
4258 this.cursorHidden
= false;
4260 case 1049: // alt screen buffer cursor
4261 //this.saveCursor();
4263 case 47: // alt screen buffer
4264 case 1047: // alt screen buffer
4272 scrollTop
: this.scrollTop
,
4273 scrollBottom
: this.scrollBottom
,
4275 // XXX save charset(s) here?
4276 // charset: this.charset,
4277 // glevel: this.glevel,
4278 // charsets: this.charsets
4281 this.viewport
.syncScrollArea();
4282 this.normal
= normal
;
4291 * CSI Pm l Reset Mode (RM).
4292 * Ps = 2 -> Keyboard Action Mode (AM).
4293 * Ps = 4 -> Replace Mode (IRM).
4294 * Ps = 1 2 -> Send/receive (SRM).
4295 * Ps = 2 0 -> Normal Linefeed (LNM).
4297 * DEC Private Mode Reset (DECRST).
4298 * Ps = 1 -> Normal Cursor Keys (DECCKM).
4299 * Ps = 2 -> Designate VT52 mode (DECANM).
4300 * Ps = 3 -> 80 Column Mode (DECCOLM).
4301 * Ps = 4 -> Jump (Fast) Scroll (DECSCLM).
4302 * Ps = 5 -> Normal Video (DECSCNM).
4303 * Ps = 6 -> Normal Cursor Mode (DECOM).
4304 * Ps = 7 -> No Wraparound Mode (DECAWM).
4305 * Ps = 8 -> No Auto-repeat Keys (DECARM).
4306 * Ps = 9 -> Don't send Mouse X & Y on button press.
4307 * Ps = 1 0 -> Hide toolbar (rxvt).
4308 * Ps = 1 2 -> Stop Blinking Cursor (att610).
4309 * Ps = 1 8 -> Don't print form feed (DECPFF).
4310 * Ps = 1 9 -> Limit print to scrolling region (DECPEX).
4311 * Ps = 2 5 -> Hide Cursor (DECTCEM).
4312 * Ps = 3 0 -> Don't show scrollbar (rxvt).
4313 * Ps = 3 5 -> Disable font-shifting functions (rxvt).
4314 * Ps = 4 0 -> Disallow 80 -> 132 Mode.
4315 * Ps = 4 1 -> No more(1) fix (see curses resource).
4316 * Ps = 4 2 -> Disable Nation Replacement Character sets (DEC-
4318 * Ps = 4 4 -> Turn Off Margin Bell.
4319 * Ps = 4 5 -> No Reverse-wraparound Mode.
4320 * Ps = 4 6 -> Stop Logging. (This is normally disabled by a
4321 * compile-time option).
4322 * Ps = 4 7 -> Use Normal Screen Buffer.
4323 * Ps = 6 6 -> Numeric keypad (DECNKM).
4324 * Ps = 6 7 -> Backarrow key sends delete (DECBKM).
4325 * Ps = 1 0 0 0 -> Don't send Mouse X & Y on button press and
4326 * release. See the section Mouse Tracking.
4327 * Ps = 1 0 0 1 -> Don't use Hilite Mouse Tracking.
4328 * Ps = 1 0 0 2 -> Don't use Cell Motion Mouse Tracking.
4329 * Ps = 1 0 0 3 -> Don't use All Motion Mouse Tracking.
4330 * Ps = 1 0 0 4 -> Don't send FocusIn/FocusOut events.
4331 * Ps = 1 0 0 5 -> Disable Extended Mouse Mode.
4332 * Ps = 1 0 1 0 -> Don't scroll to bottom on tty output
4334 * Ps = 1 0 1 1 -> Don't scroll to bottom on key press (rxvt).
4335 * Ps = 1 0 3 4 -> Don't interpret "meta" key. (This disables
4336 * the eightBitInput resource).
4337 * Ps = 1 0 3 5 -> Disable special modifiers for Alt and Num-
4338 * Lock keys. (This disables the numLock resource).
4339 * Ps = 1 0 3 6 -> Don't send ESC when Meta modifies a key.
4340 * (This disables the metaSendsEscape resource).
4341 * Ps = 1 0 3 7 -> Send VT220 Remove from the editing-keypad
4343 * Ps = 1 0 3 9 -> Don't send ESC when Alt modifies a key.
4344 * (This disables the altSendsEscape resource).
4345 * Ps = 1 0 4 0 -> Do not keep selection when not highlighted.
4346 * (This disables the keepSelection resource).
4347 * Ps = 1 0 4 1 -> Use the PRIMARY selection. (This disables
4348 * the selectToClipboard resource).
4349 * Ps = 1 0 4 2 -> Disable Urgency window manager hint when
4350 * Control-G is received. (This disables the bellIsUrgent
4352 * Ps = 1 0 4 3 -> Disable raising of the window when Control-
4353 * G is received. (This disables the popOnBell resource).
4354 * Ps = 1 0 4 7 -> Use Normal Screen Buffer, clearing screen
4355 * first if in the Alternate Screen. (This may be disabled by
4356 * the titeInhibit resource).
4357 * Ps = 1 0 4 8 -> Restore cursor as in DECRC. (This may be
4358 * disabled by the titeInhibit resource).
4359 * Ps = 1 0 4 9 -> Use Normal Screen Buffer and restore cursor
4360 * as in DECRC. (This may be disabled by the titeInhibit
4361 * resource). This combines the effects of the 1 0 4 7 and 1 0
4362 * 4 8 modes. Use this with terminfo-based applications rather
4363 * than the 4 7 mode.
4364 * Ps = 1 0 5 0 -> Reset terminfo/termcap function-key mode.
4365 * Ps = 1 0 5 1 -> Reset Sun function-key mode.
4366 * Ps = 1 0 5 2 -> Reset HP function-key mode.
4367 * Ps = 1 0 5 3 -> Reset SCO function-key mode.
4368 * Ps = 1 0 6 0 -> Reset legacy keyboard emulation (X11R6).
4369 * Ps = 1 0 6 1 -> Reset keyboard emulation to Sun/PC style.
4370 * Ps = 2 0 0 4 -> Reset bracketed paste mode.
4372 Terminal
.prototype.resetMode = function(params
) {
4373 if (typeof params
=== 'object') {
4374 var l
= params
.length
4377 for (; i
< l
; i
++) {
4378 this.resetMode(params
[i
]);
4387 this.insertMode
= false;
4390 //this.convertEol = false;
4393 } else if (this.prefix
=== '?') {
4396 this.applicationCursor
= false;
4399 if (this.cols
=== 132 && this.savedCols
) {
4400 this.resize(this.savedCols
, this.rows
);
4402 delete this.savedCols
;
4405 this.originMode
= false;
4408 this.wraparoundMode
= false;
4411 // this.cursorBlink = false;
4414 this.log('Switching back to normal keypad.');
4415 this.applicationKeypad
= false;
4416 this.viewport
.syncScrollArea();
4418 case 9: // X10 Mouse
4419 case 1000: // vt200 mouse
4420 case 1002: // button event mouse
4421 case 1003: // any event mouse
4422 this.x10Mouse
= false;
4423 this.vt200Mouse
= false;
4424 this.normalMouse
= false;
4425 this.mouseEvents
= false;
4426 this.element
.style
.cursor
= '';
4428 case 1004: // send focusin/focusout events
4429 this.sendFocus
= false;
4431 case 1005: // utf8 ext mode mouse
4432 this.utfMouse
= false;
4434 case 1006: // sgr ext mode mouse
4435 this.sgrMouse
= false;
4437 case 1015: // urxvt ext mode mouse
4438 this.urxvtMouse
= false;
4440 case 25: // hide cursor
4441 this.cursorHidden
= true;
4443 case 1049: // alt screen buffer cursor
4445 case 47: // normal screen buffer
4446 case 1047: // normal screen buffer - clearing it first
4448 this.lines
= this.normal
.lines
;
4449 this.ybase
= this.normal
.ybase
;
4450 this.ydisp
= this.normal
.ydisp
;
4451 this.x
= this.normal
.x
;
4452 this.y
= this.normal
.y
;
4453 this.scrollTop
= this.normal
.scrollTop
;
4454 this.scrollBottom
= this.normal
.scrollBottom
;
4455 this.tabs
= this.normal
.tabs
;
4457 // if (params === 1049) {
4458 // this.x = this.savedX;
4459 // this.y = this.savedY;
4461 this.queueRefresh(0, this.rows
- 1);
4462 this.viewport
.syncScrollArea();
4473 * Set Scrolling Region [top;bottom] (default = full size of win-
4477 Terminal
.prototype.setScrollRegion = function(params
) {
4478 if (this.prefix
) return;
4479 this.scrollTop
= (params
[0] || 1) - 1;
4480 this.scrollBottom
= (params
[1] || this.rows
) - 1;
4488 * Save cursor (ANSI.SYS).
4490 Terminal
.prototype.saveCursor = function(params
) {
4491 this.savedX
= this.x
;
4492 this.savedY
= this.y
;
4498 * Restore cursor (ANSI.SYS).
4500 Terminal
.prototype.restoreCursor = function(params
) {
4501 this.x
= this.savedX
|| 0;
4502 this.y
= this.savedY
|| 0;
4512 * Cursor Forward Tabulation Ps tab stops (default = 1) (CHT).
4514 Terminal
.prototype.cursorForwardTab = function(params
) {
4515 var param
= params
[0] || 1;
4517 this.x
= this.nextStop();
4523 * CSI Ps S Scroll up Ps lines (default = 1) (SU).
4525 Terminal
.prototype.scrollUp = function(params
) {
4526 var param
= params
[0] || 1;
4528 this.lines
.splice(this.ybase
+ this.scrollTop
, 1);
4529 this.lines
.splice(this.ybase
+ this.scrollBottom
, 0, this.blankLine());
4532 this.updateRange(this.scrollTop
);
4533 this.updateRange(this.scrollBottom
);
4538 * CSI Ps T Scroll down Ps lines (default = 1) (SD).
4540 Terminal
.prototype.scrollDown = function(params
) {
4541 var param
= params
[0] || 1;
4543 this.lines
.splice(this.ybase
+ this.scrollBottom
, 1);
4544 this.lines
.splice(this.ybase
+ this.scrollTop
, 0, this.blankLine());
4547 this.updateRange(this.scrollTop
);
4548 this.updateRange(this.scrollBottom
);
4553 * CSI Ps ; Ps ; Ps ; Ps ; Ps T
4554 * Initiate highlight mouse tracking. Parameters are
4555 * [func;startx;starty;firstrow;lastrow]. See the section Mouse
4558 Terminal
.prototype.initMouseTracking = function(params
) {
4559 // Relevant: DECSET 1001
4565 * Reset one or more features of the title modes to the default
4566 * value. Normally, "reset" disables the feature. It is possi-
4567 * ble to disable the ability to reset features by compiling a
4568 * different default for the title modes into xterm.
4569 * Ps = 0 -> Do not set window/icon labels using hexadecimal.
4570 * Ps = 1 -> Do not query window/icon labels using hexadeci-
4572 * Ps = 2 -> Do not set window/icon labels using UTF-8.
4573 * Ps = 3 -> Do not query window/icon labels using UTF-8.
4574 * (See discussion of "Title Modes").
4576 Terminal
.prototype.resetTitleModes = function(params
) {
4582 * CSI Ps Z Cursor Backward Tabulation Ps tab stops (default = 1) (CBT).
4584 Terminal
.prototype.cursorBackwardTab = function(params
) {
4585 var param
= params
[0] || 1;
4587 this.x
= this.prevStop();
4593 * CSI Ps b Repeat the preceding graphic character Ps times (REP).
4595 Terminal
.prototype.repeatPrecedingCharacter = function(params
) {
4596 var param
= params
[0] || 1
4597 , line
= this.lines
.get(this.ybase
+ this.y
)
4598 , ch
= line
[this.x
- 1] || [this.defAttr
, ' ', 1];
4600 while (param
--) line
[this.x
++] = ch
;
4605 * CSI Ps g Tab Clear (TBC).
4606 * Ps = 0 -> Clear Current Column (default).
4607 * Ps = 3 -> Clear All.
4609 * Ps = 2 -> Clear Stops on Line.
4610 * http://vt100.net/annarbor/aaa-ug/section6.html
4612 Terminal
.prototype.tabClear = function(params
) {
4613 var param
= params
[0];
4615 delete this.tabs
[this.x
];
4616 } else if (param
=== 3) {
4623 * CSI Pm i Media Copy (MC).
4624 * Ps = 0 -> Print screen (default).
4625 * Ps = 4 -> Turn off printer controller mode.
4626 * Ps = 5 -> Turn on printer controller mode.
4628 * Media Copy (MC, DEC-specific).
4629 * Ps = 1 -> Print line containing cursor.
4630 * Ps = 4 -> Turn off autoprint mode.
4631 * Ps = 5 -> Turn on autoprint mode.
4632 * Ps = 1 0 -> Print composed display, ignores DECPEX.
4633 * Ps = 1 1 -> Print all pages.
4635 Terminal
.prototype.mediaCopy = function(params
) {
4642 * Set or reset resource-values used by xterm to decide whether
4643 * to construct escape sequences holding information about the
4644 * modifiers pressed with a given key. The first parameter iden-
4645 * tifies the resource to set/reset. The second parameter is the
4646 * value to assign to the resource. If the second parameter is
4647 * omitted, the resource is reset to its initial value.
4648 * Ps = 1 -> modifyCursorKeys.
4649 * Ps = 2 -> modifyFunctionKeys.
4650 * Ps = 4 -> modifyOtherKeys.
4651 * If no parameters are given, all resources are reset to their
4654 Terminal
.prototype.setResources = function(params
) {
4661 * Disable modifiers which may be enabled via the CSI > Ps; Ps m
4662 * sequence. This corresponds to a resource value of "-1", which
4663 * cannot be set with the other sequence. The parameter identi-
4664 * fies the resource to be disabled:
4665 * Ps = 1 -> modifyCursorKeys.
4666 * Ps = 2 -> modifyFunctionKeys.
4667 * Ps = 4 -> modifyOtherKeys.
4668 * If the parameter is omitted, modifyFunctionKeys is disabled.
4669 * When modifyFunctionKeys is disabled, xterm uses the modifier
4670 * keys to make an extended sequence of functions rather than
4671 * adding a parameter to each function key to denote the modi-
4674 Terminal
.prototype.disableModifiers = function(params
) {
4681 * Set resource value pointerMode. This is used by xterm to
4682 * decide whether to hide the pointer cursor as the user types.
4683 * Valid values for the parameter:
4684 * Ps = 0 -> never hide the pointer.
4685 * Ps = 1 -> hide if the mouse tracking mode is not enabled.
4686 * Ps = 2 -> always hide the pointer. If no parameter is
4687 * given, xterm uses the default, which is 1 .
4689 Terminal
.prototype.setPointerMode = function(params
) {
4695 * CSI ! p Soft terminal reset (DECSTR).
4696 * http://vt100.net/docs/vt220-rm/table4-10.html
4698 Terminal
.prototype.softReset = function(params
) {
4699 this.cursorHidden
= false;
4700 this.insertMode
= false;
4701 this.originMode
= false;
4702 this.wraparoundMode
= false; // autowrap
4703 this.applicationKeypad
= false; // ?
4704 this.viewport
.syncScrollArea();
4705 this.applicationCursor
= false;
4707 this.scrollBottom
= this.rows
- 1;
4708 this.curAttr
= this.defAttr
;
4709 this.x
= this.y
= 0; // ?
4710 this.charset
= null;
4711 this.glevel
= 0; // ??
4712 this.charsets
= [null]; // ??
4718 * Request ANSI mode (DECRQM). For VT300 and up, reply is
4720 * where Ps is the mode number as in RM, and Pm is the mode
4722 * 0 - not recognized
4725 * 3 - permanently set
4726 * 4 - permanently reset
4728 Terminal
.prototype.requestAnsiMode = function(params
) {
4735 * Request DEC private mode (DECRQM). For VT300 and up, reply is
4737 * where Ps is the mode number as in DECSET, Pm is the mode value
4738 * as in the ANSI DECRQM.
4740 Terminal
.prototype.requestPrivateMode = function(params
) {
4747 * Set conformance level (DECSCL). Valid values for the first
4749 * Ps = 6 1 -> VT100.
4750 * Ps = 6 2 -> VT200.
4751 * Ps = 6 3 -> VT300.
4752 * Valid values for the second parameter:
4753 * Ps = 0 -> 8-bit controls.
4754 * Ps = 1 -> 7-bit controls (always set for VT100).
4755 * Ps = 2 -> 8-bit controls.
4757 Terminal
.prototype.setConformanceLevel = function(params
) {
4763 * CSI Ps q Load LEDs (DECLL).
4764 * Ps = 0 -> Clear all LEDS (default).
4765 * Ps = 1 -> Light Num Lock.
4766 * Ps = 2 -> Light Caps Lock.
4767 * Ps = 3 -> Light Scroll Lock.
4768 * Ps = 2 1 -> Extinguish Num Lock.
4769 * Ps = 2 2 -> Extinguish Caps Lock.
4770 * Ps = 2 3 -> Extinguish Scroll Lock.
4772 Terminal
.prototype.loadLEDs = function(params
) {
4779 * Set cursor style (DECSCUSR, VT520).
4780 * Ps = 0 -> blinking block.
4781 * Ps = 1 -> blinking block (default).
4782 * Ps = 2 -> steady block.
4783 * Ps = 3 -> blinking underline.
4784 * Ps = 4 -> steady underline.
4786 Terminal
.prototype.setCursorStyle = function(params
) {
4793 * Select character protection attribute (DECSCA). Valid values
4794 * for the parameter:
4795 * Ps = 0 -> DECSED and DECSEL can erase (default).
4796 * Ps = 1 -> DECSED and DECSEL cannot erase.
4797 * Ps = 2 -> DECSED and DECSEL can erase.
4799 Terminal
.prototype.setCharProtectionAttr = function(params
) {
4806 * Restore DEC Private Mode Values. The value of Ps previously
4807 * saved is restored. Ps values are the same as for DECSET.
4809 Terminal
.prototype.restorePrivateValues = function(params
) {
4815 * CSI Pt; Pl; Pb; Pr; Ps$ r
4816 * Change Attributes in Rectangular Area (DECCARA), VT400 and up.
4817 * Pt; Pl; Pb; Pr denotes the rectangle.
4818 * Ps denotes the SGR attributes to change: 0, 1, 4, 5, 7.
4819 * NOTE: xterm doesn't enable this code by default.
4821 Terminal
.prototype.setAttrInRectangle = function(params
) {
4831 for (; t
< b
+ 1; t
++) {
4832 line
= this.lines
.get(this.ybase
+ t
);
4833 for (i
= l
; i
< r
; i
++) {
4834 line
[i
] = [attr
, line
[i
][1]];
4839 this.updateRange(params
[0]);
4840 this.updateRange(params
[2]);
4845 * CSI Pc; Pt; Pl; Pb; Pr$ x
4846 * Fill Rectangular Area (DECFRA), VT420 and up.
4847 * Pc is the character to use.
4848 * Pt; Pl; Pb; Pr denotes the rectangle.
4849 * NOTE: xterm doesn't enable this code by default.
4851 Terminal
.prototype.fillRectangle = function(params
) {
4861 for (; t
< b
+ 1; t
++) {
4862 line
= this.lines
.get(this.ybase
+ t
);
4863 for (i
= l
; i
< r
; i
++) {
4864 line
[i
] = [line
[i
][0], String
.fromCharCode(ch
)];
4869 this.updateRange(params
[1]);
4870 this.updateRange(params
[3]);
4876 * Enable Locator Reporting (DECELR).
4877 * Valid values for the first parameter:
4878 * Ps = 0 -> Locator disabled (default).
4879 * Ps = 1 -> Locator enabled.
4880 * Ps = 2 -> Locator enabled for one report, then disabled.
4881 * The second parameter specifies the coordinate unit for locator
4883 * Valid values for the second parameter:
4884 * Pu = 0 <- or omitted -> default to character cells.
4885 * Pu = 1 <- device physical pixels.
4886 * Pu = 2 <- character cells.
4888 Terminal
.prototype.enableLocatorReporting = function(params
) {
4889 var val
= params
[0] > 0;
4890 //this.mouseEvents = val;
4891 //this.decLocator = val;
4896 * CSI Pt; Pl; Pb; Pr$ z
4897 * Erase Rectangular Area (DECERA), VT400 and up.
4898 * Pt; Pl; Pb; Pr denotes the rectangle.
4899 * NOTE: xterm doesn't enable this code by default.
4901 Terminal
.prototype.eraseRectangle = function(params
) {
4911 ch
= [this.eraseAttr(), ' ', 1]; // xterm?
4913 for (; t
< b
+ 1; t
++) {
4914 line
= this.lines
.get(this.ybase
+ t
);
4915 for (i
= l
; i
< r
; i
++) {
4921 this.updateRange(params
[0]);
4922 this.updateRange(params
[2]);
4928 * Insert P s Column(s) (default = 1) (DECIC), VT420 and up.
4929 * NOTE: xterm doesn't enable this code by default.
4931 Terminal
.prototype.insertColumns = function() {
4932 var param
= params
[0]
4933 , l
= this.ybase
+ this.rows
4934 , ch
= [this.eraseAttr(), ' ', 1] // xterm?
4938 for (i
= this.ybase
; i
< l
; i
++) {
4939 this.lines
.get(i
).splice(this.x
+ 1, 0, ch
);
4940 this.lines
.get(i
).pop();
4950 * Delete P s Column(s) (default = 1) (DECDC), VT420 and up
4951 * NOTE: xterm doesn't enable this code by default.
4953 Terminal
.prototype.deleteColumns = function() {
4954 var param
= params
[0]
4955 , l
= this.ybase
+ this.rows
4956 , ch
= [this.eraseAttr(), ' ', 1] // xterm?
4960 for (i
= this.ybase
; i
< l
; i
++) {
4961 this.lines
.get(i
).splice(this.x
, 1);
4962 this.lines
.get(i
).push(ch
);
4973 Terminal
.charsets
= {};
4975 // DEC Special Character and Line Drawing Set.
4976 // http://vt100.net/docs/vt102-ug/table5-13.html
4977 // A lot of curses apps use this if they see TERM=xterm.
4978 // testing: echo -e '\e(0a\e(B'
4979 // The xterm output sometimes seems to conflict with the
4980 // reference above. xterm seems in line with the reference
4981 // when running vttest however.
4982 // The table below now uses xterm's output from vttest.
4983 Terminal
.charsets
.SCLD
= { // (0
4984 '`': '\u25c6', // '◆'
4985 'a': '\u2592', // '▒'
4986 'b': '\u0009', // '\t'
4987 'c': '\u000c', // '\f'
4988 'd': '\u000d', // '\r'
4989 'e': '\u000a', // '\n'
4990 'f': '\u00b0', // '°'
4991 'g': '\u00b1', // '±'
4992 'h': '\u2424', // '\u2424' (NL)
4993 'i': '\u000b', // '\v'
4994 'j': '\u2518', // '┘'
4995 'k': '\u2510', // '┐'
4996 'l': '\u250c', // '┌'
4997 'm': '\u2514', // '└'
4998 'n': '\u253c', // '┼'
4999 'o': '\u23ba', // '⎺'
5000 'p': '\u23bb', // '⎻'
5001 'q': '\u2500', // '─'
5002 'r': '\u23bc', // '⎼'
5003 's': '\u23bd', // '⎽'
5004 't': '\u251c', // '├'
5005 'u': '\u2524', // '┤'
5006 'v': '\u2534', // '┴'
5007 'w': '\u252c', // '┬'
5008 'x': '\u2502', // '│'
5009 'y': '\u2264', // '≤'
5010 'z': '\u2265', // '≥'
5011 '{': '\u03c0', // 'π'
5012 '|': '\u2260', // '≠'
5013 '}': '\u00a3', // '£'
5014 '~': '\u00b7' // '·'
5017 Terminal
.charsets
.UK
= null; // (A
5018 Terminal
.charsets
.US
= null; // (B (USASCII)
5019 Terminal
.charsets
.Dutch
= null; // (4
5020 Terminal
.charsets
.Finnish
= null; // (C or (5
5021 Terminal
.charsets
.French
= null; // (R
5022 Terminal
.charsets
.FrenchCanadian
= null; // (Q
5023 Terminal
.charsets
.German
= null; // (K
5024 Terminal
.charsets
.Italian
= null; // (Y
5025 Terminal
.charsets
.NorwegianDanish
= null; // (E or (6
5026 Terminal
.charsets
.Spanish
= null; // (Z
5027 Terminal
.charsets
.Swedish
= null; // (H or (7
5028 Terminal
.charsets
.Swiss
= null; // (=
5029 Terminal
.charsets
.ISOLatin
= null; // /A
5035 function on(el
, type
, handler
, capture
) {
5036 if (!Array
.isArray(el
)) {
5039 el
.forEach(function (element
) {
5040 element
.addEventListener(type
, handler
, capture
|| false);
5044 function off(el
, type
, handler
, capture
) {
5045 el
.removeEventListener(type
, handler
, capture
|| false);
5048 function cancel(ev
, force
) {
5049 if (!this.cancelEvents
&& !force
) {
5052 ev
.preventDefault();
5053 ev
.stopPropagation();
5057 function inherits(child
, parent
) {
5059 this.constructor = child
;
5061 f
.prototype = parent
.prototype;
5062 child
.prototype = new f
;
5065 // if bold is broken, we can't
5066 // use it in the terminal.
5067 function isBoldBroken(document
) {
5068 var body
= document
.getElementsByTagName('body')[0];
5069 var el
= document
.createElement('span');
5070 el
.innerHTML
= 'hello world';
5071 body
.appendChild(el
);
5072 var w1
= el
.scrollWidth
;
5073 el
.style
.fontWeight
= 'bold';
5074 var w2
= el
.scrollWidth
;
5075 body
.removeChild(el
);
5079 function indexOf(obj
, el
) {
5082 if (obj
[i
] === el
) return i
;
5087 function isThirdLevelShift(term
, ev
) {
5089 (term
.browser
.isMac
&& ev
.altKey
&& !ev
.ctrlKey
&& !ev
.metaKey
) ||
5090 (term
.browser
.isMSWindows
&& ev
.altKey
&& ev
.ctrlKey
&& !ev
.metaKey
);
5092 if (ev
.type
== 'keypress') {
5093 return thirdLevelKey
;
5096 // Don't invoke for arrows, pageDown, home, backspace, etc. (on non-keypress events)
5097 return thirdLevelKey
&& (!ev
.keyCode
|| ev
.keyCode
> 47);
5100 function matchColor(r1
, g1
, b1
) {
5101 var hash
= (r1
<< 16) | (g1
<< 8) | b1
;
5103 if (matchColor
._cache
[hash
] != null) {
5104 return matchColor
._cache
[hash
];
5107 var ldiff
= Infinity
5116 for (; i
< Terminal
.vcolors
.length
; i
++) {
5117 c
= Terminal
.vcolors
[i
];
5122 diff
= matchColor
.distance(r1
, g1
, b1
, r2
, g2
, b2
);
5135 return matchColor
._cache
[hash
] = li
;
5138 matchColor
._cache
= {};
5140 // http://stackoverflow.com/questions/1633828
5141 matchColor
.distance = function(r1
, g1
, b1
, r2
, g2
, b2
) {
5142 return Math
.pow(30 * (r1
- r2
), 2)
5143 + Math
.pow(59 * (g1
- g2
), 2)
5144 + Math
.pow(11 * (b1
- b2
), 2);
5147 function each(obj
, iter
, con
) {
5148 if (obj
.forEach
) return obj
.forEach(iter
, con
);
5149 for (var i
= 0; i
< obj
.length
; i
++) {
5150 iter
.call(con
, obj
[i
], i
, obj
);
5154 function keys(obj
) {
5155 if (Object
.keys
) return Object
.keys(obj
);
5158 if (Object
.prototype.hasOwnProperty
.call(obj
, key
)) {
5165 var wcwidth
= (function(opts
) {
5166 // extracted from https://www.cl.cam.ac.uk/%7Emgk25/ucs/wcwidth.c
5167 // combining characters
5169 [0x0300, 0x036F], [0x0483, 0x0486], [0x0488, 0x0489],
5170 [0x0591, 0x05BD], [0x05BF, 0x05BF], [0x05C1, 0x05C2],
5171 [0x05C4, 0x05C5], [0x05C7, 0x05C7], [0x0600, 0x0603],
5172 [0x0610, 0x0615], [0x064B, 0x065E], [0x0670, 0x0670],
5173 [0x06D6, 0x06E4], [0x06E7, 0x06E8], [0x06EA, 0x06ED],
5174 [0x070F, 0x070F], [0x0711, 0x0711], [0x0730, 0x074A],
5175 [0x07A6, 0x07B0], [0x07EB, 0x07F3], [0x0901, 0x0902],
5176 [0x093C, 0x093C], [0x0941, 0x0948], [0x094D, 0x094D],
5177 [0x0951, 0x0954], [0x0962, 0x0963], [0x0981, 0x0981],
5178 [0x09BC, 0x09BC], [0x09C1, 0x09C4], [0x09CD, 0x09CD],
5179 [0x09E2, 0x09E3], [0x0A01, 0x0A02], [0x0A3C, 0x0A3C],
5180 [0x0A41, 0x0A42], [0x0A47, 0x0A48], [0x0A4B, 0x0A4D],
5181 [0x0A70, 0x0A71], [0x0A81, 0x0A82], [0x0ABC, 0x0ABC],
5182 [0x0AC1, 0x0AC5], [0x0AC7, 0x0AC8], [0x0ACD, 0x0ACD],
5183 [0x0AE2, 0x0AE3], [0x0B01, 0x0B01], [0x0B3C, 0x0B3C],
5184 [0x0B3F, 0x0B3F], [0x0B41, 0x0B43], [0x0B4D, 0x0B4D],
5185 [0x0B56, 0x0B56], [0x0B82, 0x0B82], [0x0BC0, 0x0BC0],
5186 [0x0BCD, 0x0BCD], [0x0C3E, 0x0C40], [0x0C46, 0x0C48],
5187 [0x0C4A, 0x0C4D], [0x0C55, 0x0C56], [0x0CBC, 0x0CBC],
5188 [0x0CBF, 0x0CBF], [0x0CC6, 0x0CC6], [0x0CCC, 0x0CCD],
5189 [0x0CE2, 0x0CE3], [0x0D41, 0x0D43], [0x0D4D, 0x0D4D],
5190 [0x0DCA, 0x0DCA], [0x0DD2, 0x0DD4], [0x0DD6, 0x0DD6],
5191 [0x0E31, 0x0E31], [0x0E34, 0x0E3A], [0x0E47, 0x0E4E],
5192 [0x0EB1, 0x0EB1], [0x0EB4, 0x0EB9], [0x0EBB, 0x0EBC],
5193 [0x0EC8, 0x0ECD], [0x0F18, 0x0F19], [0x0F35, 0x0F35],
5194 [0x0F37, 0x0F37], [0x0F39, 0x0F39], [0x0F71, 0x0F7E],
5195 [0x0F80, 0x0F84], [0x0F86, 0x0F87], [0x0F90, 0x0F97],
5196 [0x0F99, 0x0FBC], [0x0FC6, 0x0FC6], [0x102D, 0x1030],
5197 [0x1032, 0x1032], [0x1036, 0x1037], [0x1039, 0x1039],
5198 [0x1058, 0x1059], [0x1160, 0x11FF], [0x135F, 0x135F],
5199 [0x1712, 0x1714], [0x1732, 0x1734], [0x1752, 0x1753],
5200 [0x1772, 0x1773], [0x17B4, 0x17B5], [0x17B7, 0x17BD],
5201 [0x17C6, 0x17C6], [0x17C9, 0x17D3], [0x17DD, 0x17DD],
5202 [0x180B, 0x180D], [0x18A9, 0x18A9], [0x1920, 0x1922],
5203 [0x1927, 0x1928], [0x1932, 0x1932], [0x1939, 0x193B],
5204 [0x1A17, 0x1A18], [0x1B00, 0x1B03], [0x1B34, 0x1B34],
5205 [0x1B36, 0x1B3A], [0x1B3C, 0x1B3C], [0x1B42, 0x1B42],
5206 [0x1B6B, 0x1B73], [0x1DC0, 0x1DCA], [0x1DFE, 0x1DFF],
5207 [0x200B, 0x200F], [0x202A, 0x202E], [0x2060, 0x2063],
5208 [0x206A, 0x206F], [0x20D0, 0x20EF], [0x302A, 0x302F],
5209 [0x3099, 0x309A], [0xA806, 0xA806], [0xA80B, 0xA80B],
5210 [0xA825, 0xA826], [0xFB1E, 0xFB1E], [0xFE00, 0xFE0F],
5211 [0xFE20, 0xFE23], [0xFEFF, 0xFEFF], [0xFFF9, 0xFFFB],
5212 [0x10A01, 0x10A03], [0x10A05, 0x10A06], [0x10A0C, 0x10A0F],
5213 [0x10A38, 0x10A3A], [0x10A3F, 0x10A3F], [0x1D167, 0x1D169],
5214 [0x1D173, 0x1D182], [0x1D185, 0x1D18B], [0x1D1AA, 0x1D1AD],
5215 [0x1D242, 0x1D244], [0xE0001, 0xE0001], [0xE0020, 0xE007F],
5219 function bisearch(ucs
) {
5221 var max
= COMBINING
.length
- 1;
5223 if (ucs
< COMBINING
[0][0] || ucs
> COMBINING
[max
][1])
5225 while (max
>= min
) {
5226 mid
= Math
.floor((min
+ max
) / 2);
5227 if (ucs
> COMBINING
[mid
][1])
5229 else if (ucs
< COMBINING
[mid
][0])
5236 function wcwidth(ucs
) {
5237 // test for 8-bit control characters
5240 if (ucs
< 32 || (ucs
>= 0x7f && ucs
< 0xa0))
5241 return opts
.control
;
5242 // binary search in table of non-spacing characters
5245 // if we arrive here, ucs is not a combining or C0/C1 control character
5250 ucs
<= 0x115f || // Hangul Jamo init. consonants
5253 (ucs
>= 0x2e80 && ucs
<= 0xa4cf && ucs
!= 0x303f) || // CJK..Yi
5254 (ucs
>= 0xac00 && ucs
<= 0xd7a3) || // Hangul Syllables
5255 (ucs
>= 0xf900 && ucs
<= 0xfaff) || // CJK Compat Ideographs
5256 (ucs
>= 0xfe10 && ucs
<= 0xfe19) || // Vertical forms
5257 (ucs
>= 0xfe30 && ucs
<= 0xfe6f) || // CJK Compat Forms
5258 (ucs
>= 0xff00 && ucs
<= 0xff60) || // Fullwidth Forms
5259 (ucs
>= 0xffe0 && ucs
<= 0xffe6) ||
5260 (ucs
>= 0x20000 && ucs
<= 0x2fffd) ||
5261 (ucs
>= 0x30000 && ucs
<= 0x3fffd)
5266 })({nul
: 0, control
: 0}); // configurable options
5272 Terminal
.EventEmitter
= EventEmitter
;
5273 Terminal
.inherits
= inherits
;
5276 * Adds an event listener to the terminal.
5278 * @param {string} event The name of the event. TODO: Document all event types
5279 * @param {function} callback The function to call when the event is triggered.
5283 Terminal
.cancel
= cancel
;
5285 module
.exports
= Terminal
;