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
;
411 case 'cursorBlink': this.element
.classList
.toggle('xterm-cursor-blink', value
); break;
416 * Binds the desired focus behavior on a given terminal object.
420 Terminal
.bindFocus = function (term
) {
421 on(term
.textarea
, 'focus', function (ev
) {
422 if (term
.sendFocus
) {
423 term
.send(C0
.ESC
+ '[I');
425 term
.element
.classList
.add('focus');
427 Terminal
.focus
= term
;
428 term
.emit('focus', {terminal
: term
});
433 * Blur the terminal. Delegates blur handling to the terminal's DOM element.
435 Terminal
.prototype.blur = function() {
436 return this.textarea
.blur();
440 * Binds the desired blur behavior on a given terminal object.
444 Terminal
.bindBlur = function (term
) {
445 on(term
.textarea
, 'blur', function (ev
) {
446 term
.queueRefresh(term
.y
, term
.y
);
447 if (term
.sendFocus
) {
448 term
.send(C0
.ESC
+ '[O');
450 term
.element
.classList
.remove('focus');
451 Terminal
.focus
= null;
452 term
.emit('blur', {terminal
: term
});
457 * Initialize default behavior
459 Terminal
.prototype.initGlobal = function() {
462 Terminal
.bindKeys(this);
463 Terminal
.bindFocus(this);
464 Terminal
.bindBlur(this);
466 // Bind clipboard functionality
467 on(this.element
, 'copy', function (ev
) {
468 copyHandler
.call(this, ev
, term
);
470 on(this.textarea
, 'paste', function (ev
) {
471 pasteHandler
.call(this, ev
, term
);
473 on(this.element
, 'paste', function (ev
) {
474 pasteHandler
.call(this, ev
, term
);
477 function rightClickHandlerWrapper (ev
) {
478 rightClickHandler
.call(this, ev
, term
);
481 if (term
.browser
.isFirefox
) {
482 on(this.element
, 'mousedown', function (ev
) {
483 if (ev
.button
== 2) {
484 rightClickHandlerWrapper(ev
);
488 on(this.element
, 'contextmenu', rightClickHandlerWrapper
);
493 * Apply key handling to the terminal
495 Terminal
.bindKeys = function(term
) {
496 on(term
.element
, 'keydown', function(ev
) {
497 if (document
.activeElement
!= this) {
503 on(term
.element
, 'keypress', function(ev
) {
504 if (document
.activeElement
!= this) {
510 on(term
.element
, 'keyup', term
.focus
.bind(term
));
512 on(term
.textarea
, 'keydown', function(ev
) {
516 on(term
.textarea
, 'keypress', function(ev
) {
518 // Truncate the textarea's value, since it is not needed
522 on(term
.textarea
, 'compositionstart', term
.compositionHelper
.compositionstart
.bind(term
.compositionHelper
));
523 on(term
.textarea
, 'compositionupdate', term
.compositionHelper
.compositionupdate
.bind(term
.compositionHelper
));
524 on(term
.textarea
, 'compositionend', term
.compositionHelper
.compositionend
.bind(term
.compositionHelper
));
525 term
.on('refresh', term
.compositionHelper
.updateCompositionElements
.bind(term
.compositionHelper
));
530 * Insert the given row to the terminal or produce a new one
531 * if no row argument is passed. Return the inserted row.
532 * @param {HTMLElement} row (optional) The row to append to the terminal.
534 Terminal
.prototype.insertRow = function (row
) {
535 if (typeof row
!= 'object') {
536 row
= document
.createElement('div');
539 this.rowContainer
.appendChild(row
);
540 this.children
.push(row
);
546 * Opens the terminal within an element.
548 * @param {HTMLElement} parent The element to create the terminal within.
550 Terminal
.prototype.open = function(parent
) {
551 var self
=this, i
=0, div
;
553 this.parent
= parent
|| this.parent
;
556 throw new Error('Terminal requires a parent element.');
559 // Grab global elements
560 this.context
= this.parent
.ownerDocument
.defaultView
;
561 this.document
= this.parent
.ownerDocument
;
562 this.body
= this.document
.getElementsByTagName('body')[0];
564 //Create main element container
565 this.element
= this.document
.createElement('div');
566 this.element
.classList
.add('terminal');
567 this.element
.classList
.add('xterm');
568 this.element
.classList
.add('xterm-theme-' + this.theme
);
569 this.element
.classList
.toggle('xterm-cursor-blink', this.options
.cursorBlink
);
571 this.element
.style
.height
572 this.element
.setAttribute('tabindex', 0);
574 this.viewportElement
= document
.createElement('div');
575 this.viewportElement
.classList
.add('xterm-viewport');
576 this.element
.appendChild(this.viewportElement
);
577 this.viewportScrollArea
= document
.createElement('div');
578 this.viewportScrollArea
.classList
.add('xterm-scroll-area');
579 this.viewportElement
.appendChild(this.viewportScrollArea
);
581 // Create the container that will hold the lines of the terminal and then
582 // produce the lines the lines.
583 this.rowContainer
= document
.createElement('div');
584 this.rowContainer
.classList
.add('xterm-rows');
585 this.element
.appendChild(this.rowContainer
);
588 // Create the container that will hold helpers like the textarea for
589 // capturing DOM Events. Then produce the helpers.
590 this.helperContainer
= document
.createElement('div');
591 this.helperContainer
.classList
.add('xterm-helpers');
592 // TODO: This should probably be inserted once it's filled to prevent an additional layout
593 this.element
.appendChild(this.helperContainer
);
594 this.textarea
= document
.createElement('textarea');
595 this.textarea
.classList
.add('xterm-helper-textarea');
596 this.textarea
.setAttribute('autocorrect', 'off');
597 this.textarea
.setAttribute('autocapitalize', 'off');
598 this.textarea
.setAttribute('spellcheck', 'false');
599 this.textarea
.tabIndex
= 0;
600 this.textarea
.addEventListener('focus', function() {
601 self
.emit('focus', {terminal
: self
});
603 this.textarea
.addEventListener('blur', function() {
604 self
.emit('blur', {terminal
: self
});
606 this.helperContainer
.appendChild(this.textarea
);
608 this.compositionView
= document
.createElement('div');
609 this.compositionView
.classList
.add('composition-view');
610 this.compositionHelper
= new CompositionHelper(this.textarea
, this.compositionView
, this);
611 this.helperContainer
.appendChild(this.compositionView
);
613 this.charSizeStyleElement
= document
.createElement('style');
614 this.helperContainer
.appendChild(this.charSizeStyleElement
);
616 for (; i
< this.rows
; i
++) {
619 this.parent
.appendChild(this.element
);
621 this.charMeasure
= new CharMeasure(this.rowContainer
);
622 this.charMeasure
.on('charsizechanged', function () {
623 self
.updateCharSizeCSS();
625 this.charMeasure
.measure();
627 this.viewport
= new Viewport(this, this.viewportElement
, this.viewportScrollArea
, this.charMeasure
);
629 // Setup loop that draws to screen
630 this.queueRefresh(0, this.rows
- 1);
633 // Initialize global actions that
634 // need to be taken on the document.
637 // Ensure there is a Terminal.focus.
640 on(this.element
, 'click', function() {
641 var selection
= document
.getSelection(),
642 collapsed
= selection
.isCollapsed
,
643 isRange
= typeof collapsed
== 'boolean' ? !collapsed
: selection
.type
== 'Range';
649 // Listen for mouse events and translate
650 // them into terminal mouse protocols.
653 // Figure out whether boldness affects
654 // the character width of monospace fonts.
655 if (Terminal
.brokenBold
== null) {
656 Terminal
.brokenBold
= isBoldBroken(this.document
);
660 * This event is emitted when terminal has completed opening.
669 * Attempts to load an add-on using CommonJS or RequireJS (whichever is available).
670 * @param {string} addon The name of the addon to load
673 Terminal
.loadAddon = function(addon
, callback
) {
674 if (typeof exports
=== 'object' && typeof module
=== 'object') {
676 return require('./addons/' + addon
+ '/' + addon
);
677 } else if (typeof define
== 'function') {
679 return require(['./addons/' + addon
+ '/' + addon
], callback
);
681 console
.error('Cannot load a module without a CommonJS or RequireJS environment.');
687 * Updates the helper CSS class with any changes necessary after the terminal's
688 * character width has been changed.
690 Terminal
.prototype.updateCharSizeCSS = function() {
691 this.charSizeStyleElement
.textContent
= '.xterm-wide-char{width:' + (this.charMeasure
.width
* 2) + 'px;}';
696 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#Mouse%20Tracking
697 * To better understand these
698 * the xterm code is very helpful:
700 * button.c, charproc.c, misc.c
701 * Relevant functions in xterm/button.c:
702 * BtnCode, EmitButtonCode, EditorButton, SendMousePosition
704 Terminal
.prototype.bindMouse = function() {
705 var el
= this.element
, self
= this, pressed
= 32;
707 // mouseup, mousedown, wheel
708 // left click: ^[[M 3<^[[M#3<
710 function sendButton(ev
) {
714 // get the xterm-style button
715 button
= getButton(ev
);
717 // get mouse coordinates
721 sendEvent(button
, pos
);
723 switch (ev
.overrideType
|| ev
.type
) {
728 // keep it at the left
729 // button, just in case.
740 // motion example of a left click:
741 // ^[[M 3<^[[M@4<^[[M@5<^[[M@6<^[[M@7<^[[M#7<
742 function sendMove(ev
) {
749 // buttons marked as motions
750 // are incremented by 32
753 sendEvent(button
, pos
);
757 // position to characters
758 function encode(data
, ch
) {
759 if (!self
.utfMouse
) {
760 if (ch
=== 255) return data
.push(0);
761 if (ch
> 127) ch
= 127;
764 if (ch
=== 2047) return data
.push(0);
768 if (ch
> 2047) ch
= 2047;
769 data
.push(0xC0 | (ch
>> 6));
770 data
.push(0x80 | (ch
& 0x3F));
775 // send a mouse event:
776 // regular/utf8: ^[[M Cb Cx Cy
777 // urxvt: ^[[ Cb ; Cx ; Cy M
778 // sgr: ^[[ Cb ; Cx ; Cy M/m
779 // vt300: ^[[ 24(1/3/5)~ [ Cx , Cy ] \r
780 // locator: CSI P e ; P b ; P r ; P c ; P p & w
781 function sendEvent(button
, pos
) {
782 // self.emit('mouse', {
788 if (self
.vt300Mouse
) {
790 // http://www.vt100.net/docs/vt3xx-gp/chapter15.html
794 var data
= C0
.ESC
+ '[24';
795 if (button
=== 0) data
+= '1';
796 else if (button
=== 1) data
+= '3';
797 else if (button
=== 2) data
+= '5';
798 else if (button
=== 3) return;
800 data
+= '~[' + pos
.x
+ ',' + pos
.y
+ ']\r';
805 if (self
.decLocator
) {
810 if (button
=== 0) button
= 2;
811 else if (button
=== 1) button
= 4;
812 else if (button
=== 2) button
= 6;
813 else if (button
=== 3) button
= 3;
814 self
.send(C0
.ESC
+ '['
817 + (button
=== 3 ? 4 : 0)
828 if (self
.urxvtMouse
) {
833 self
.send(C0
.ESC
+ '[' + button
+ ';' + pos
.x
+ ';' + pos
.y
+ 'M');
840 self
.send(C0
.ESC
+ '[<'
841 + (((button
& 3) === 3 ? button
& ~3 : button
) - 32)
846 + ((button
& 3) === 3 ? 'm' : 'M'));
852 encode(data
, button
);
856 self
.send(C0
.ESC
+ '[M' + String
.fromCharCode
.apply(String
, data
));
859 function getButton(ev
) {
872 // 1, and 2 - with 64 added
873 switch (ev
.overrideType
|| ev
.type
) {
875 button
= ev
.button
!= null
881 if (self
.browser
.isMSIE
) {
882 button
= button
=== 1 ? 0 : button
=== 4 ? 1 : button
;
888 case 'DOMMouseScroll':
889 button
= ev
.detail
< 0
894 button
= ev
.wheelDeltaY
> 0
900 // next three bits are the modifiers:
901 // 4 = shift, 8 = meta, 16 = control
902 shift
= ev
.shiftKey
? 4 : 0;
903 meta
= ev
.metaKey
? 8 : 0;
904 ctrl
= ev
.ctrlKey
? 16 : 0;
905 mod
= shift
| meta
| ctrl
;
908 if (self
.vt200Mouse
) {
911 } else if (!self
.normalMouse
) {
916 button
= (32 + (mod
<< 2)) + button
;
921 // mouse coordinates measured in cols/rows
922 function getCoords(ev
) {
925 // ignore browsers without pageX for now
926 if (ev
.pageX
== null) return;
932 // should probably check offsetParent
933 // but this is more portable
934 while (el
&& el
!== self
.document
.documentElement
) {
937 el
= 'offsetParent' in el
942 // convert to cols/rows
943 w
= self
.element
.clientWidth
;
944 h
= self
.element
.clientHeight
;
945 x
= Math
.ceil((x
/ w
) * self
.cols
);
946 y
= Math
.ceil((y
/ h
) * self
.rows
);
948 // be sure to avoid sending
949 // bad positions to the program
951 if (x
> self
.cols
) x
= self
.cols
;
953 if (y
> self
.rows
) y
= self
.rows
;
955 // xterm sends raw bytes and
956 // starts at 32 (SP) for each.
967 on(el
, 'mousedown', function(ev
) {
968 if (!self
.mouseEvents
) return;
977 //if (self.vt200Mouse && !self.normalMouse) {
978 if (self
.vt200Mouse
) {
979 ev
.overrideType
= 'mouseup';
981 return self
.cancel(ev
);
985 if (self
.normalMouse
) on(self
.document
, 'mousemove', sendMove
);
987 // x10 compatibility mode can't send button releases
988 if (!self
.x10Mouse
) {
989 on(self
.document
, 'mouseup', function up(ev
) {
991 if (self
.normalMouse
) off(self
.document
, 'mousemove', sendMove
);
992 off(self
.document
, 'mouseup', up
);
993 return self
.cancel(ev
);
997 return self
.cancel(ev
);
1000 //if (self.normalMouse) {
1001 // on(self.document, 'mousemove', sendMove);
1004 on(el
, 'wheel', function(ev
) {
1005 if (!self
.mouseEvents
) return;
1008 || self
.decLocator
) return;
1010 return self
.cancel(ev
);
1013 // allow wheel scrolling in
1014 // the shell for example
1015 on(el
, 'wheel', function(ev
) {
1016 if (self
.mouseEvents
) return;
1017 self
.viewport
.onWheel(ev
);
1018 return self
.cancel(ev
);
1023 * Destroys the terminal.
1025 Terminal
.prototype.destroy = function() {
1026 this.readable
= false;
1027 this.writable
= false;
1029 this.handler = function() {};
1030 this.write = function() {};
1031 if (this.element
.parentNode
) {
1032 this.element
.parentNode
.removeChild(this.element
);
1034 //this.emit('close');
1039 * Flags used to render terminal text properly
1050 * Queues a refresh between two rows (inclusive), to be done on next animation
1052 * @param {number} start The start row.
1053 * @param {number} end The end row.
1055 Terminal
.prototype.queueRefresh = function(start
, end
) {
1056 this.refreshRowsQueue
.push({ start
: start
, end
: end
});
1060 * Performs the refresh loop callback, calling refresh only if a refresh is
1061 * necessary before queueing up the next one.
1063 Terminal
.prototype.refreshLoop = function() {
1064 // Don't refresh if there were no row changes
1065 if (this.refreshRowsQueue
.length
> 0) {
1066 // Skip MAX_REFRESH_FRAME_SKIP frames if the writeBuffer is non-empty as it
1067 // will need to be immediately refreshed anyway. This saves a lot of
1068 // rendering time as the viewport DOM does not need to be refreshed, no
1069 // scroll events, no layouts, etc.
1070 var skipFrame
= this.writeBuffer
.length
> 0 && this.refreshFramesSkipped
++ <= MAX_REFRESH_FRAME_SKIP
;
1073 this.refreshFramesSkipped
= 0;
1076 if (this.refreshRowsQueue
.length
> 4) {
1077 // Just do a full refresh when 5+ refreshes are queued
1079 end
= this.rows
- 1;
1081 // Get start and end rows that need refreshing
1082 start
= this.refreshRowsQueue
[0].start
;
1083 end
= this.refreshRowsQueue
[0].end
;
1084 for (var i
= 1; i
< this.refreshRowsQueue
.length
; i
++) {
1085 if (this.refreshRowsQueue
[i
].start
< start
) {
1086 start
= this.refreshRowsQueue
[i
].start
;
1088 if (this.refreshRowsQueue
[i
].end
> end
) {
1089 end
= this.refreshRowsQueue
[i
].end
;
1093 this.refreshRowsQueue
= [];
1094 this.refresh(start
, end
);
1097 window
.requestAnimationFrame(this.refreshLoop
.bind(this));
1101 * Refreshes (re-renders) terminal content within two rows (inclusive)
1105 * In the screen buffer, each character is stored as a an array with a character
1106 * and a 32-bit integer:
1107 * - First value: a utf-16 character.
1109 * - Next 9 bits: background color (0-511).
1110 * - Next 9 bits: foreground color (0-511).
1111 * - Next 14 bits: a mask for misc. flags:
1118 * @param {number} start The row to start from (between 0 and terminal's height terminal - 1)
1119 * @param {number} end The row to end at (between fromRow and terminal's height terminal - 1)
1121 Terminal
.prototype.refresh = function(start
, end
) {
1124 var x
, y
, i
, line
, out
, ch
, ch_width
, width
, data
, attr
, bg
, fg
, flags
, row
, parent
, focused
= document
.activeElement
;
1126 // If this is a big refresh, remove the terminal rows from the DOM for faster calculations
1127 if (end
- start
>= this.rows
/ 2) {
1128 parent
= this.element
.parentNode
;
1130 this.element
.removeChild(this.rowContainer
);
1137 if (end
>= this.rows
.length
) {
1138 this.log('`end` is too large. Most likely a bad CSR.');
1139 end
= this.rows
.length
- 1;
1142 for (; y
<= end
; y
++) {
1143 row
= y
+ this.ydisp
;
1145 line
= this.lines
.get(row
);
1148 if (this.y
=== y
- (this.ybase
- this.ydisp
)
1150 && !this.cursorHidden
) {
1156 attr
= this.defAttr
;
1159 for (; i
< width
; i
++) {
1162 ch_width
= line
[i
][2];
1166 if (i
=== x
) data
= -1;
1168 if (data
!== attr
) {
1169 if (attr
!== this.defAttr
) {
1172 if (data
!== this.defAttr
) {
1174 out
+= '<span class="reverse-video terminal-cursor">';
1176 var classNames
= [];
1179 fg
= (data
>> 9) & 0x1ff;
1182 if (flags
& Terminal
.flags
.BOLD
) {
1183 if (!Terminal
.brokenBold
) {
1184 classNames
.push('xterm-bold');
1186 // See: XTerm*boldColors
1187 if (fg
< 8) fg
+= 8;
1190 if (flags
& Terminal
.flags
.UNDERLINE
) {
1191 classNames
.push('xterm-underline');
1194 if (flags
& Terminal
.flags
.BLINK
) {
1195 classNames
.push('xterm-blink');
1198 // If inverse flag is on, then swap the foreground and background variables.
1199 if (flags
& Terminal
.flags
.INVERSE
) {
1200 /* One-line variable swap in JavaScript: http://stackoverflow.com/a/16201730 */
1201 bg = [fg, fg = bg][0];
1202 // Should inverse just be before the
1203 // above boldColors effect instead?
1204 if ((flags & 1) && fg < 8) fg += 8;
1207 if (flags & Terminal.flags.INVISIBLE) {
1208 classNames.push('xterm-hidden');
1212 * Weird situation: Invert flag used black foreground and white background results
1213 * in invalid background color, positioned at the 256 index of the 256 terminal
1214 * color map. Pin the colors manually in such a case.
1216 * Source: https://github.com/sourcelair/xterm.js/issues/57
1218 if (flags
& Terminal
.flags
.INVERSE
) {
1228 classNames
.push('xterm-bg-color-' + bg
);
1232 classNames
.push('xterm-color-' + fg
);
1236 if (classNames
.length
) {
1237 out
+= ' class="' + classNames
.join(' ') + '"';
1244 if (ch_width
=== 2) {
1245 out
+= '<span class="xterm-wide-char">';
1265 if (ch_width
=== 2) {
1272 if (attr
!== this.defAttr
) {
1276 this.children
[y
].innerHTML
= out
;
1280 this.element
.appendChild(this.rowContainer
);
1283 this.emit('refresh', {element
: this.element
, start
: start
, end
: end
});
1287 * Display the cursor element
1289 Terminal
.prototype.showCursor = function() {
1290 if (!this.cursorState
) {
1291 this.cursorState
= 1;
1292 this.queueRefresh(this.y
, this.y
);
1297 * Scroll the terminal down 1 row, creating a blank line.
1299 Terminal
.prototype.scroll = function() {
1302 // Make room for the new row in lines
1303 if (this.lines
.length
=== this.lines
.maxLength
) {
1304 this.lines
.trimStart(1);
1306 if (this.ydisp
!== 0) {
1313 // TODO: Why is this done twice?
1314 if (!this.userScrolling
) {
1315 this.ydisp
= this.ybase
;
1319 row
= this.ybase
+ this.rows
- 1;
1321 // subtract the bottom scroll region
1322 row
-= this.rows
- 1 - this.scrollBottom
;
1324 if (row
=== this.lines
.length
) {
1325 // Optimization: pushing is faster than splicing when they amount to the same behavior
1326 this.lines
.push(this.blankLine());
1329 this.lines
.splice(row
, 0, this.blankLine());
1332 if (this.scrollTop
!== 0) {
1333 if (this.ybase
!== 0) {
1335 if (!this.userScrolling
) {
1336 this.ydisp
= this.ybase
;
1339 this.lines
.splice(this.ybase
+ this.scrollTop
, 1);
1343 this.updateRange(this.scrollTop
);
1344 this.updateRange(this.scrollBottom
);
1347 * This event is emitted whenever the terminal is scrolled.
1348 * The one parameter passed is the new y display position.
1352 this.emit('scroll', this.ydisp
);
1356 * Scroll the display of the terminal
1357 * @param {number} disp The number of lines to scroll down (negatives scroll up).
1358 * @param {boolean} suppressScrollEvent Don't emit the scroll event as scrollDisp. This is used
1359 * to avoid unwanted events being handled by the veiwport when the event was triggered from the
1360 * viewport originally.
1362 Terminal
.prototype.scrollDisp = function(disp
, suppressScrollEvent
) {
1364 this.userScrolling
= true;
1365 } else if (disp
+ this.ydisp
>= this.ybase
) {
1366 this.userScrolling
= false;
1371 if (this.ydisp
> this.ybase
) {
1372 this.ydisp
= this.ybase
;
1373 } else if (this.ydisp
< 0) {
1377 if (!suppressScrollEvent
) {
1378 this.emit('scroll', this.ydisp
);
1381 this.queueRefresh(0, this.rows
- 1);
1385 * Scroll the display of the terminal by a number of pages.
1386 * @param {number} pageCount The number of pages to scroll (negative scrolls up).
1388 Terminal
.prototype.scrollPages = function(pageCount
) {
1389 this.scrollDisp(pageCount
* (this.rows
- 1));
1393 * Scrolls the display of the terminal to the top.
1395 Terminal
.prototype.scrollToTop = function() {
1396 this.scrollDisp(-this.ydisp
);
1400 * Scrolls the display of the terminal to the bottom.
1402 Terminal
.prototype.scrollToBottom = function() {
1403 this.scrollDisp(this.ybase
- this.ydisp
);
1407 * Writes text to the terminal.
1408 * @param {string} text The text to write to the terminal.
1410 Terminal
.prototype.write = function(data
) {
1411 this.writeBuffer
.push(data
);
1413 // Send XOFF to pause the pty process if the write buffer becomes too large so
1414 // xterm.js can catch up before more data is sent. This is necessary in order
1415 // to keep signals such as ^C responsive.
1416 if (!this.xoffSentToCatchUp
&& this.writeBuffer
.length
>= WRITE_BUFFER_PAUSE_THRESHOLD
) {
1417 // XOFF - stop pty pipe
1418 // XON will be triggered by emulator before processing data chunk
1420 this.xoffSentToCatchUp
= true;
1423 if (!this.writeInProgress
&& this.writeBuffer
.length
> 0) {
1424 // Kick off a write which will write all data in sequence recursively
1425 this.writeInProgress
= true;
1426 // Kick off an async innerWrite so more writes can come in while processing data
1428 setTimeout(function () {
1434 Terminal
.prototype.innerWrite = function() {
1435 var writeBatch
= this.writeBuffer
.splice(0, WRITE_BATCH_SIZE
);
1436 while (writeBatch
.length
> 0) {
1437 var data
= writeBatch
.shift();
1438 var l
= data
.length
, i
= 0, j
, cs
, ch
, code
, low
, ch_width
, row
;
1440 // If XOFF was sent in order to catch up with the pty process, resume it if
1441 // the writeBuffer is empty to allow more data to come in.
1442 if (this.xoffSentToCatchUp
&& writeBatch
.length
=== 0 && this.writeBuffer
.length
=== 0) {
1444 this.xoffSentToCatchUp
= false;
1447 this.refreshStart
= this.y
;
1448 this.refreshEnd
= this.y
;
1450 // apply leftover surrogate high from last write
1451 if (this.surrogate_high
) {
1452 data
= this.surrogate_high
+ data
;
1453 this.surrogate_high
= '';
1456 for (; i
< l
; i
++) {
1459 // FIXME: higher chars than 0xa0 are not allowed in escape sequences
1460 // --> maybe move to default
1461 code
= data
.charCodeAt(i
);
1462 if (0xD800 <= code
&& code
<= 0xDBFF) {
1463 // we got a surrogate high
1464 // get surrogate low (next 2 bytes)
1465 low
= data
.charCodeAt(i
+1);
1467 // end of data stream, save surrogate high
1468 this.surrogate_high
= ch
;
1471 code
= ((code
- 0xD800) * 0x400) + (low
- 0xDC00) + 0x10000;
1472 ch
+= data
.charAt(i
+1);
1475 // surrogate low - already handled above
1476 if (0xDC00 <= code
&& code
<= 0xDFFF)
1478 switch (this.state
) {
1489 if (this.convertEol
) {
1493 if (this.y
> this.scrollBottom
) {
1513 this.x
= this.nextStop();
1528 this.state
= escaped
;
1533 // calculate print space
1534 // expensive call, therefore we save width in line buffer
1535 ch_width
= wcwidth(code
);
1538 if (this.charset
&& this.charset
[ch
]) {
1539 ch
= this.charset
[ch
];
1542 row
= this.y
+ this.ybase
;
1544 // insert combining char in last cell
1545 // FIXME: needs handling after cursor jumps
1546 if (!ch_width
&& this.x
) {
1547 // dont overflow left
1548 if (this.lines
.get(row
)[this.x
-1]) {
1549 if (!this.lines
.get(row
)[this.x
-1][2]) {
1551 // found empty cell after fullwidth, need to go 2 cells back
1552 if (this.lines
.get(row
)[this.x
-2])
1553 this.lines
.get(row
)[this.x
-2][1] += ch
;
1556 this.lines
.get(row
)[this.x
-1][1] += ch
;
1558 this.updateRange(this.y
);
1563 // goto next line if ch would overflow
1564 // TODO: needs a global min terminal width of 2
1565 if (this.x
+ch_width
-1 >= this.cols
) {
1566 // autowrap - DECAWM
1567 if (this.wraparoundMode
) {
1570 if (this.y
> this.scrollBottom
) {
1575 this.x
= this.cols
-1;
1576 if(ch_width
===2) // FIXME: check for xterm behavior
1580 row
= this.y
+ this.ybase
;
1582 // insert mode: move characters to right
1583 if (this.insertMode
) {
1584 // do this twice for a fullwidth char
1585 for (var moves
=0; moves
<ch_width
; ++moves
) {
1586 // remove last cell, if it's width is 0
1587 // we have to adjust the second last cell as well
1588 var removed
= this.lines
.get(this.y
+ this.ybase
).pop();
1590 && this.lines
.get(row
)[this.cols
-2]
1591 && this.lines
.get(row
)[this.cols
-2][2]===2)
1592 this.lines
.get(row
)[this.cols
-2] = [this.curAttr
, ' ', 1];
1594 // insert empty cell at cursor
1595 this.lines
.get(row
).splice(this.x
, 0, [this.curAttr
, ' ', 1]);
1599 this.lines
.get(row
)[this.x
] = [this.curAttr
, ch
, ch_width
];
1601 this.updateRange(this.y
);
1603 // fullwidth char - set next cell width to zero and advance cursor
1605 this.lines
.get(row
)[this.x
] = [this.curAttr
, '', 0];
1614 // ESC [ Control Sequence Introducer ( CSI is 0x9b).
1617 this.currentParam
= 0;
1621 // ESC ] Operating System Command ( OSC is 0x9d).
1624 this.currentParam
= 0;
1628 // ESC P Device Control String ( DCS is 0x90).
1631 this.currentParam
= 0;
1635 // ESC _ Application Program Command ( APC is 0x9f).
1637 this.state
= ignore
;
1640 // ESC ^ Privacy Message ( PM is 0x9e).
1642 this.state
= ignore
;
1645 // ESC c Full Reset (RIS).
1650 // ESC E Next Line ( NEL is 0x85).
1651 // ESC D Index ( IND is 0x84).
1659 // ESC M Reverse Index ( RI is 0x8d).
1661 this.reverseIndex();
1664 // ESC % Select default/utf-8 character set.
1665 // @ = default, G = utf-8
1667 //this.charset = null;
1669 this.setgCharset(0, Terminal
.charsets
.US
);
1670 this.state
= normal
;
1674 // ESC (,),*,+,-,. Designate G0-G2 Character Set.
1675 case '(': // <-- this seems to get all the attention
1701 this.state
= charset
;
1704 // Designate G3 Character Set (VT300).
1705 // A = ISO Latin-1 Supplemental.
1709 this.state
= charset
;
1714 // Single Shift Select of G2 Character Set
1715 // ( SS2 is 0x8e). This affects next character only.
1719 // Single Shift Select of G3 Character Set
1720 // ( SS3 is 0x8f). This affects next character only.
1724 // Invoke the G2 Character Set as GL (LS2).
1729 // Invoke the G3 Character Set as GL (LS3).
1734 // Invoke the G3 Character Set as GR (LS3R).
1739 // Invoke the G2 Character Set as GR (LS2R).
1744 // Invoke the G1 Character Set as GR (LS1R).
1749 // ESC 7 Save Cursor (DECSC).
1752 this.state
= normal
;
1755 // ESC 8 Restore Cursor (DECRC).
1757 this.restoreCursor();
1758 this.state
= normal
;
1761 // ESC # 3 DEC line height/width
1763 this.state
= normal
;
1767 // ESC H Tab Set (HTS is 0x88).
1772 // ESC = Application Keypad (DECKPAM).
1774 this.log('Serial port requested application keypad.');
1775 this.applicationKeypad
= true;
1776 this.viewport
.syncScrollArea();
1777 this.state
= normal
;
1780 // ESC > Normal Keypad (DECKPNM).
1782 this.log('Switching back to normal keypad.');
1783 this.applicationKeypad
= false;
1784 this.viewport
.syncScrollArea();
1785 this.state
= normal
;
1789 this.state
= normal
;
1790 this.error('Unknown ESC control: %s.', ch
);
1797 case '0': // DEC Special Character and Line Drawing Set.
1798 cs
= Terminal
.charsets
.SCLD
;
1801 cs
= Terminal
.charsets
.UK
;
1803 case 'B': // United States (USASCII).
1804 cs
= Terminal
.charsets
.US
;
1807 cs
= Terminal
.charsets
.Dutch
;
1809 case 'C': // Finnish
1811 cs
= Terminal
.charsets
.Finnish
;
1814 cs
= Terminal
.charsets
.French
;
1816 case 'Q': // FrenchCanadian
1817 cs
= Terminal
.charsets
.FrenchCanadian
;
1820 cs
= Terminal
.charsets
.German
;
1822 case 'Y': // Italian
1823 cs
= Terminal
.charsets
.Italian
;
1825 case 'E': // NorwegianDanish
1827 cs
= Terminal
.charsets
.NorwegianDanish
;
1829 case 'Z': // Spanish
1830 cs
= Terminal
.charsets
.Spanish
;
1832 case 'H': // Swedish
1834 cs
= Terminal
.charsets
.Swedish
;
1837 cs
= Terminal
.charsets
.Swiss
;
1839 case '/': // ISOLatin (actually /A)
1840 cs
= Terminal
.charsets
.ISOLatin
;
1844 cs
= Terminal
.charsets
.US
;
1847 this.setgCharset(this.gcharset
, cs
);
1848 this.gcharset
= null;
1849 this.state
= normal
;
1855 // Set Text Parameters.
1856 if (ch
=== C0
.ESC
|| ch
=== C0
.BEL
) {
1857 if (ch
=== C0
.ESC
) i
++;
1859 this.params
.push(this.currentParam
);
1861 switch (this.params
[0]) {
1865 if (this.params
[1]) {
1866 this.title
= this.params
[1];
1867 this.handleTitle(this.title
);
1875 // change dynamic colors
1887 // change dynamic ui colors
1899 // manipulate selection data
1917 this.currentParam
= 0;
1918 this.state
= normal
;
1920 if (!this.params
.length
) {
1921 if (ch
>= '0' && ch
<= '9') {
1923 this.currentParam
* 10 + ch
.charCodeAt(0) - 48;
1924 } else if (ch
=== ';') {
1925 this.params
.push(this.currentParam
);
1926 this.currentParam
= '';
1929 this.currentParam
+= ch
;
1936 if (ch
=== '?' || ch
=== '>' || ch
=== '!') {
1942 if (ch
>= '0' && ch
<= '9') {
1943 this.currentParam
= this.currentParam
* 10 + ch
.charCodeAt(0) - 48;
1947 // '$', '"', ' ', '\''
1948 if (ch
=== '$' || ch
=== '"' || ch
=== ' ' || ch
=== '\'') {
1953 this.params
.push(this.currentParam
);
1954 this.currentParam
= 0;
1957 if (ch
=== ';') break;
1959 this.state
= normal
;
1963 // Cursor Up Ps Times (default = 1) (CUU).
1965 this.cursorUp(this.params
);
1969 // Cursor Down Ps Times (default = 1) (CUD).
1971 this.cursorDown(this.params
);
1975 // Cursor Forward Ps Times (default = 1) (CUF).
1977 this.cursorForward(this.params
);
1981 // Cursor Backward Ps Times (default = 1) (CUB).
1983 this.cursorBackward(this.params
);
1987 // Cursor Position [row;column] (default = [1,1]) (CUP).
1989 this.cursorPos(this.params
);
1992 // CSI Ps J Erase in Display (ED).
1994 this.eraseInDisplay(this.params
);
1997 // CSI Ps K Erase in Line (EL).
1999 this.eraseInLine(this.params
);
2002 // CSI Pm m Character Attributes (SGR).
2005 this.charAttributes(this.params
);
2009 // CSI Ps n Device Status Report (DSR).
2012 this.deviceStatus(this.params
);
2021 // Insert Ps (Blank) Character(s) (default = 1) (ICH).
2023 this.insertChars(this.params
);
2027 // Cursor Next Line Ps Times (default = 1) (CNL).
2029 this.cursorNextLine(this.params
);
2033 // Cursor Preceding Line Ps Times (default = 1) (CNL).
2035 this.cursorPrecedingLine(this.params
);
2039 // Cursor Character Absolute [column] (default = [row,1]) (CHA).
2041 this.cursorCharAbsolute(this.params
);
2045 // Insert Ps Line(s) (default = 1) (IL).
2047 this.insertLines(this.params
);
2051 // Delete Ps Line(s) (default = 1) (DL).
2053 this.deleteLines(this.params
);
2057 // Delete Ps Character(s) (default = 1) (DCH).
2059 this.deleteChars(this.params
);
2063 // Erase Ps Character(s) (default = 1) (ECH).
2065 this.eraseChars(this.params
);
2068 // CSI Pm ` Character Position Absolute
2069 // [column] (default = [row,1]) (HPA).
2071 this.charPosAbsolute(this.params
);
2075 // Horizontal Position Relative
2077 this.HPositionRelative(this.params
);
2081 // Send Device Attributes (Primary DA).
2083 // Send Device Attributes (Secondary DA)
2085 this.sendDeviceAttributes(this.params
);
2089 // Line Position Absolute [row] (default = [1,column]) (VPA).
2091 this.linePosAbsolute(this.params
);
2094 // 145 65 e * VPR - Vertical Position Relative
2096 this.VPositionRelative(this.params
);
2100 // Horizontal and Vertical Position [row;column] (default =
2103 this.HVPosition(this.params
);
2106 // CSI Pm h Set Mode (SM).
2107 // CSI ? Pm h - mouse escape codes, cursor escape codes
2109 this.setMode(this.params
);
2112 // CSI Pm l Reset Mode (RM).
2115 this.resetMode(this.params
);
2119 // Set Scrolling Region [top;bottom] (default = full size of win-
2123 this.setScrollRegion(this.params
);
2127 // Save cursor (ANSI.SYS).
2129 this.saveCursor(this.params
);
2133 // Restore cursor (ANSI.SYS).
2135 this.restoreCursor(this.params
);
2143 // Cursor Forward Tabulation Ps tab stops (default = 1) (CHT).
2145 this.cursorForwardTab(this.params
);
2148 // CSI Ps S Scroll up Ps lines (default = 1) (SU).
2150 this.scrollUp(this.params
);
2153 // CSI Ps T Scroll down Ps lines (default = 1) (SD).
2154 // CSI Ps ; Ps ; Ps ; Ps ; Ps T
2157 // if (this.prefix === '>') {
2158 // this.resetTitleModes(this.params);
2161 // if (this.params.length > 2) {
2162 // this.initMouseTracking(this.params);
2165 if (this.params
.length
< 2 && !this.prefix
) {
2166 this.scrollDown(this.params
);
2171 // Cursor Backward Tabulation Ps tab stops (default = 1) (CBT).
2173 this.cursorBackwardTab(this.params
);
2176 // CSI Ps b Repeat the preceding graphic character Ps times (REP).
2178 this.repeatPrecedingCharacter(this.params
);
2181 // CSI Ps g Tab Clear (TBC).
2183 this.tabClear(this.params
);
2186 // CSI Pm i Media Copy (MC).
2189 // this.mediaCopy(this.params);
2192 // CSI Pm m Character Attributes (SGR).
2194 // case 'm': // duplicate
2195 // if (this.prefix === '>') {
2196 // this.setResources(this.params);
2198 // this.charAttributes(this.params);
2202 // CSI Ps n Device Status Report (DSR).
2204 // case 'n': // duplicate
2205 // if (this.prefix === '>') {
2206 // this.disableModifiers(this.params);
2208 // this.deviceStatus(this.params);
2212 // CSI > Ps p Set pointer mode.
2213 // CSI ! p Soft terminal reset (DECSTR).
2215 // Request ANSI mode (DECRQM).
2217 // Request DEC private mode (DECRQM).
2220 switch (this.prefix
) {
2222 // this.setPointerMode(this.params);
2225 this.softReset(this.params
);
2228 // if (this.postfix === '$') {
2229 // this.requestPrivateMode(this.params);
2233 // if (this.postfix === '"') {
2234 // this.setConformanceLevel(this.params);
2235 // } else if (this.postfix === '$') {
2236 // this.requestAnsiMode(this.params);
2242 // CSI Ps q Load LEDs (DECLL).
2246 // if (this.postfix === ' ') {
2247 // this.setCursorStyle(this.params);
2250 // if (this.postfix === '"') {
2251 // this.setCharProtectionAttr(this.params);
2254 // this.loadLEDs(this.params);
2258 // Set Scrolling Region [top;bottom] (default = full size of win-
2261 // CSI Pt; Pl; Pb; Pr; Ps$ r
2262 // case 'r': // duplicate
2263 // if (this.prefix === '?') {
2264 // this.restorePrivateValues(this.params);
2265 // } else if (this.postfix === '$') {
2266 // this.setAttrInRectangle(this.params);
2268 // this.setScrollRegion(this.params);
2272 // CSI s Save cursor (ANSI.SYS).
2274 // case 's': // duplicate
2275 // if (this.prefix === '?') {
2276 // this.savePrivateValues(this.params);
2278 // this.saveCursor(this.params);
2282 // CSI Ps ; Ps ; Ps t
2283 // CSI Pt; Pl; Pb; Pr; Ps$ t
2287 // if (this.postfix === '$') {
2288 // this.reverseAttrInRectangle(this.params);
2289 // } else if (this.postfix === ' ') {
2290 // this.setWarningBellVolume(this.params);
2292 // if (this.prefix === '>') {
2293 // this.setTitleModeFeature(this.params);
2295 // this.manipulateWindow(this.params);
2300 // CSI u Restore cursor (ANSI.SYS).
2302 // case 'u': // duplicate
2303 // if (this.postfix === ' ') {
2304 // this.setMarginBellVolume(this.params);
2306 // this.restoreCursor(this.params);
2310 // CSI Pt; Pl; Pb; Pr; Pp; Pt; Pl; Pp$ v
2312 // if (this.postfix === '$') {
2313 // this.copyRectagle(this.params);
2317 // CSI Pt ; Pl ; Pb ; Pr ' w
2319 // if (this.postfix === '\'') {
2320 // this.enableFilterRectangle(this.params);
2324 // CSI Ps x Request Terminal Parameters (DECREQTPARM).
2325 // CSI Ps x Select Attribute Change Extent (DECSACE).
2326 // CSI Pc; Pt; Pl; Pb; Pr$ x
2328 // if (this.postfix === '$') {
2329 // this.fillRectangle(this.params);
2331 // this.requestParameters(this.params);
2332 // //this.__(this.params);
2337 // CSI Pt; Pl; Pb; Pr$ z
2339 // if (this.postfix === '\'') {
2340 // this.enableLocatorReporting(this.params);
2341 // } else if (this.postfix === '$') {
2342 // this.eraseRectangle(this.params);
2347 // CSI Pt; Pl; Pb; Pr$ {
2349 // if (this.postfix === '\'') {
2350 // this.setLocatorEvents(this.params);
2351 // } else if (this.postfix === '$') {
2352 // this.selectiveEraseRectangle(this.params);
2358 // if (this.postfix === '\'') {
2359 // this.requestLocatorPosition(this.params);
2364 // Insert P s Column(s) (default = 1) (DECIC), VT420 and up.
2366 // if (this.postfix === ' ') {
2367 // this.insertColumns(this.params);
2372 // Delete P s Column(s) (default = 1) (DECDC), VT420 and up
2374 // if (this.postfix === ' ') {
2375 // this.deleteColumns(this.params);
2380 this.error('Unknown CSI code: %s.', ch
);
2389 if (ch
=== C0
.ESC
|| ch
=== C0
.BEL
) {
2390 if (ch
=== C0
.ESC
) i
++;
2392 switch (this.prefix
) {
2393 // User-Defined Keys (DECUDK).
2397 // Request Status String (DECRQSS).
2398 // test: echo -e '\eP$q"p\e\\'
2400 var pt
= this.currentParam
2417 + (this.scrollTop
+ 1)
2419 + (this.scrollBottom
+ 1)
2429 this.error('Unknown DCS Pt: %s.', pt
);
2434 this.send(C0
.ESC
+ 'P' + +valid
+ '$r' + pt
+ C0
.ESC
+ '\\');
2437 // Set Termcap/Terminfo Data (xterm, experimental).
2441 // Request Termcap/Terminfo String (xterm, experimental)
2442 // Regular xterm does not even respond to this sequence.
2443 // This can cause a small glitch in vim.
2444 // test: echo -ne '\eP+q6b64\e\\'
2446 var pt
= this.currentParam
2449 this.send(C0
.ESC
+ 'P' + +valid
+ '+r' + pt
+ C0
.ESC
+ '\\');
2453 this.error('Unknown DCS prefix: %s.', this.prefix
);
2457 this.currentParam
= 0;
2459 this.state
= normal
;
2460 } else if (!this.currentParam
) {
2461 if (!this.prefix
&& ch
!== '$' && ch
!== '+') {
2462 this.currentParam
= ch
;
2463 } else if (this.prefix
.length
=== 2) {
2464 this.currentParam
= ch
;
2469 this.currentParam
+= ch
;
2475 if (ch
=== C0
.ESC
|| ch
=== C0
.BEL
) {
2476 if (ch
=== C0
.ESC
) i
++;
2477 this.state
= normal
;
2483 this.updateRange(this.y
);
2484 this.queueRefresh(this.refreshStart
, this.refreshEnd
);
2486 if (this.writeBuffer
.length
> 0) {
2487 // Allow renderer to catch up before processing the next batch
2489 setTimeout(function () {
2493 this.writeInProgress
= false;
2498 * Writes text to the terminal, followed by a break line character (\n).
2499 * @param {string} text The text to write to the terminal.
2501 Terminal
.prototype.writeln = function(data
) {
2502 this.write(data
+ '\r\n');
2506 * Attaches a custom keydown handler which is run before keys are processed, giving consumers of
2507 * xterm.js ultimate control as to what keys should be processed by the terminal and what keys
2509 * @param {function} customKeydownHandler The custom KeyboardEvent handler to attach. This is a
2510 * function that takes a KeyboardEvent, allowing consumers to stop propogation and/or prevent
2511 * the default action. The function returns whether the event should be processed by xterm.js.
2513 Terminal
.prototype.attachCustomKeydownHandler = function(customKeydownHandler
) {
2514 this.customKeydownHandler
= customKeydownHandler
;
2518 * Handle a keydown event
2520 * - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent
2521 * @param {KeyboardEvent} ev The keydown event to be handled.
2523 Terminal
.prototype.keyDown = function(ev
) {
2524 if (this.customKeydownHandler
&& this.customKeydownHandler(ev
) === false) {
2528 if (!this.compositionHelper
.keydown
.bind(this.compositionHelper
)(ev
)) {
2529 if (this.ybase
!== this.ydisp
) {
2530 this.scrollToBottom();
2536 var result
= this.evaluateKeyEscapeSequence(ev
);
2538 if (result
.key
=== C0
.DC3
) { // XOFF
2539 this.writeStopped
= true;
2540 } else if (result
.key
=== C0
.DC1
) { // XON
2541 this.writeStopped
= false;
2544 if (result
.scrollDisp
) {
2545 this.scrollDisp(result
.scrollDisp
);
2546 return this.cancel(ev
, true);
2549 if (isThirdLevelShift(this, ev
)) {
2553 if (result
.cancel
) {
2554 // The event is canceled at the end already, is this necessary?
2555 this.cancel(ev
, true);
2562 this.emit('keydown', ev
);
2563 this.emit('key', result
.key
, ev
);
2565 this.handler(result
.key
);
2567 return this.cancel(ev
, true);
2571 * Returns an object that determines how a KeyboardEvent should be handled. The key of the
2572 * returned value is the new key code to pass to the PTY.
2574 * Reference: http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
2575 * @param {KeyboardEvent} ev The keyboard event to be translated to key escape sequence.
2577 Terminal
.prototype.evaluateKeyEscapeSequence = function(ev
) {
2579 // Whether to cancel event propogation (NOTE: this may not be needed since the event is
2580 // canceled at the end of keyDown
2582 // The new key even to emit
2584 // The number of characters to scroll, if this is defined it will cancel the event
2585 scrollDisp
: undefined
2587 var modifiers
= ev
.shiftKey
<< 0 | ev
.altKey
<< 1 | ev
.ctrlKey
<< 2 | ev
.metaKey
<< 3;
2588 switch (ev
.keyCode
) {
2592 result
.key
= C0
.BS
; // ^H
2595 result
.key
= C0
.DEL
; // ^?
2600 result
.key
= C0
.ESC
+ '[Z';
2604 result
.cancel
= true;
2609 result
.cancel
= true;
2613 result
.key
= C0
.ESC
;
2614 result
.cancel
= true;
2619 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'D';
2620 // HACK: Make Alt + left-arrow behave like Ctrl + left-arrow: move one word backwards
2621 // http://unix.stackexchange.com/a/108106
2622 // macOS uses different escape sequences than linux
2623 if (result
.key
== C0
.ESC
+ '[1;3D') {
2624 result
.key
= (this.browser
.isMac
) ? C0
.ESC
+ 'b' : C0
.ESC
+ '[1;5D';
2626 } else if (this.applicationCursor
) {
2627 result
.key
= C0
.ESC
+ 'OD';
2629 result
.key
= C0
.ESC
+ '[D';
2635 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'C';
2636 // HACK: Make Alt + right-arrow behave like Ctrl + right-arrow: move one word forward
2637 // http://unix.stackexchange.com/a/108106
2638 // macOS uses different escape sequences than linux
2639 if (result
.key
== C0
.ESC
+ '[1;3C') {
2640 result
.key
= (this.browser
.isMac
) ? C0
.ESC
+ 'f' : C0
.ESC
+ '[1;5C';
2642 } else if (this.applicationCursor
) {
2643 result
.key
= C0
.ESC
+ 'OC';
2645 result
.key
= C0
.ESC
+ '[C';
2651 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'A';
2652 // HACK: Make Alt + up-arrow behave like Ctrl + up-arrow
2653 // http://unix.stackexchange.com/a/108106
2654 if (result
.key
== C0
.ESC
+ '[1;3A') {
2655 result
.key
= C0
.ESC
+ '[1;5A';
2657 } else if (this.applicationCursor
) {
2658 result
.key
= C0
.ESC
+ 'OA';
2660 result
.key
= C0
.ESC
+ '[A';
2666 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'B';
2667 // HACK: Make Alt + down-arrow behave like Ctrl + down-arrow
2668 // http://unix.stackexchange.com/a/108106
2669 if (result
.key
== C0
.ESC
+ '[1;3B') {
2670 result
.key
= C0
.ESC
+ '[1;5B';
2672 } else if (this.applicationCursor
) {
2673 result
.key
= C0
.ESC
+ 'OB';
2675 result
.key
= C0
.ESC
+ '[B';
2680 if (!ev
.shiftKey
&& !ev
.ctrlKey
) {
2681 // <Ctrl> or <Shift> + <Insert> are used to
2682 // copy-paste on some systems.
2683 result
.key
= C0
.ESC
+ '[2~';
2689 result
.key
= C0
.ESC
+ '[3;' + (modifiers
+ 1) + '~';
2691 result
.key
= C0
.ESC
+ '[3~';
2697 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'H';
2698 else if (this.applicationCursor
)
2699 result
.key
= C0
.ESC
+ 'OH';
2701 result
.key
= C0
.ESC
+ '[H';
2706 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'F';
2707 else if (this.applicationCursor
)
2708 result
.key
= C0
.ESC
+ 'OF';
2710 result
.key
= C0
.ESC
+ '[F';
2715 result
.scrollDisp
= -(this.rows
- 1);
2717 result
.key
= C0
.ESC
+ '[5~';
2723 result
.scrollDisp
= this.rows
- 1;
2725 result
.key
= C0
.ESC
+ '[6~';
2731 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'P';
2733 result
.key
= C0
.ESC
+ 'OP';
2738 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'Q';
2740 result
.key
= C0
.ESC
+ 'OQ';
2745 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'R';
2747 result
.key
= C0
.ESC
+ 'OR';
2752 result
.key
= C0
.ESC
+ '[1;' + (modifiers
+ 1) + 'S';
2754 result
.key
= C0
.ESC
+ 'OS';
2759 result
.key
= C0
.ESC
+ '[15;' + (modifiers
+ 1) + '~';
2761 result
.key
= C0
.ESC
+ '[15~';
2766 result
.key
= C0
.ESC
+ '[17;' + (modifiers
+ 1) + '~';
2768 result
.key
= C0
.ESC
+ '[17~';
2773 result
.key
= C0
.ESC
+ '[18;' + (modifiers
+ 1) + '~';
2775 result
.key
= C0
.ESC
+ '[18~';
2780 result
.key
= C0
.ESC
+ '[19;' + (modifiers
+ 1) + '~';
2782 result
.key
= C0
.ESC
+ '[19~';
2787 result
.key
= C0
.ESC
+ '[20;' + (modifiers
+ 1) + '~';
2789 result
.key
= C0
.ESC
+ '[20~';
2794 result
.key
= C0
.ESC
+ '[21;' + (modifiers
+ 1) + '~';
2796 result
.key
= C0
.ESC
+ '[21~';
2801 result
.key
= C0
.ESC
+ '[23;' + (modifiers
+ 1) + '~';
2803 result
.key
= C0
.ESC
+ '[23~';
2808 result
.key
= C0
.ESC
+ '[24;' + (modifiers
+ 1) + '~';
2810 result
.key
= C0
.ESC
+ '[24~';
2815 if (ev
.ctrlKey
&& !ev
.shiftKey
&& !ev
.altKey
&& !ev
.metaKey
) {
2816 if (ev
.keyCode
>= 65 && ev
.keyCode
<= 90) {
2817 result
.key
= String
.fromCharCode(ev
.keyCode
- 64);
2818 } else if (ev
.keyCode
=== 32) {
2820 result
.key
= String
.fromCharCode(0);
2821 } else if (ev
.keyCode
>= 51 && ev
.keyCode
<= 55) {
2822 // escape, file sep, group sep, record sep, unit sep
2823 result
.key
= String
.fromCharCode(ev
.keyCode
- 51 + 27);
2824 } else if (ev
.keyCode
=== 56) {
2826 result
.key
= String
.fromCharCode(127);
2827 } else if (ev
.keyCode
=== 219) {
2828 // ^[ - Control Sequence Introducer (CSI)
2829 result
.key
= String
.fromCharCode(27);
2830 } else if (ev
.keyCode
=== 220) {
2831 // ^\ - String Terminator (ST)
2832 result
.key
= String
.fromCharCode(28);
2833 } else if (ev
.keyCode
=== 221) {
2834 // ^] - Operating System Command (OSC)
2835 result
.key
= String
.fromCharCode(29);
2837 } else if (!this.browser
.isMac
&& ev
.altKey
&& !ev
.ctrlKey
&& !ev
.metaKey
) {
2838 // On Mac this is a third level shift. Use <Esc> instead.
2839 if (ev
.keyCode
>= 65 && ev
.keyCode
<= 90) {
2840 result
.key
= C0
.ESC
+ String
.fromCharCode(ev
.keyCode
+ 32);
2841 } else if (ev
.keyCode
=== 192) {
2842 result
.key
= C0
.ESC
+ '`';
2843 } else if (ev
.keyCode
>= 48 && ev
.keyCode
<= 57) {
2844 result
.key
= C0
.ESC
+ (ev
.keyCode
- 48);
2854 * Set the G level of the terminal
2857 Terminal
.prototype.setgLevel = function(g
) {
2859 this.charset
= this.charsets
[g
];
2863 * Set the charset for the given G level of the terminal
2867 Terminal
.prototype.setgCharset = function(g
, charset
) {
2868 this.charsets
[g
] = charset
;
2869 if (this.glevel
=== g
) {
2870 this.charset
= charset
;
2875 * Handle a keypress event.
2877 * - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent
2878 * @param {KeyboardEvent} ev The keypress event to be handled.
2880 Terminal
.prototype.keyPress = function(ev
) {
2887 } else if (ev
.which
== null) {
2889 } else if (ev
.which
!== 0 && ev
.charCode
!== 0) {
2896 (ev
.altKey
|| ev
.ctrlKey
|| ev
.metaKey
) && !isThirdLevelShift(this, ev
)
2901 key
= String
.fromCharCode(key
);
2903 this.emit('keypress', key
, ev
);
2904 this.emit('key', key
, ev
);
2912 * Send data for handling to the terminal
2913 * @param {string} data
2915 Terminal
.prototype.send = function(data
) {
2919 setTimeout(function() {
2920 self
.handler(self
.queue
);
2930 * Note: We could do sweet things with webaudio here
2932 Terminal
.prototype.bell = function() {
2933 if (!this.visualBell
) return;
2935 this.element
.style
.borderColor
= 'white';
2936 setTimeout(function() {
2937 self
.element
.style
.borderColor
= '';
2939 if (this.popOnBell
) this.focus();
2943 * Log the current state to the console.
2945 Terminal
.prototype.log = function() {
2946 if (!this.debug
) return;
2947 if (!this.context
.console
|| !this.context
.console
.log
) return;
2948 var args
= Array
.prototype.slice
.call(arguments
);
2949 this.context
.console
.log
.apply(this.context
.console
, args
);
2953 * Log the current state as error to the console.
2955 Terminal
.prototype.error = function() {
2956 if (!this.debug
) return;
2957 if (!this.context
.console
|| !this.context
.console
.error
) return;
2958 var args
= Array
.prototype.slice
.call(arguments
);
2959 this.context
.console
.error
.apply(this.context
.console
, args
);
2963 * Resizes the terminal.
2965 * @param {number} x The number of columns to resize to.
2966 * @param {number} y The number of rows to resize to.
2968 Terminal
.prototype.resize = function(x
, y
) {
2976 if (x
=== this.cols
&& y
=== this.rows
) {
2986 ch
= [this.defAttr
, ' ', 1]; // does xterm use the default attr?
2987 i
= this.lines
.length
;
2989 while (this.lines
.get(i
).length
< x
) {
2990 this.lines
.get(i
).push(ch
);
2994 i
= this.lines
.length
;
2996 while (this.lines
.get(i
).length
> x
) {
2997 this.lines
.get(i
).pop();
3010 // y is rows, not this.y
3011 if (this.lines
.length
< y
+ this.ybase
) {
3012 if (this.ybase
> 0 && this.lines
.length
<= this.ybase
+ this.y
+ addToY
+ 1) {
3013 // There is room above the buffer and there are no empty elements below the line,
3017 if (this.ydisp
> 0) {
3018 // Viewport is at the top of the buffer, must increase downwards
3022 // Add a blank line if there is no buffer left at the top to scroll to, or if there
3023 // are blank lines after the cursor
3024 this.lines
.push(this.blankLine());
3027 if (this.children
.length
< y
) {
3033 if (this.lines
.length
> y
+ this.ybase
) {
3034 if (this.lines
.length
> this.ybase
+ this.y
+ 1) {
3035 // The line is a blank line below the cursor, remove it
3038 // The line is the cursor, scroll down
3043 if (this.children
.length
> y
) {
3044 el
= this.children
.shift();
3046 el
.parentNode
.removeChild(el
);
3052 // Make sure that the cursor stays on screen
3065 this.scrollBottom
= y
- 1;
3067 this.charMeasure
.measure();
3069 this.queueRefresh(0, this.rows
- 1);
3073 this.geometry
= [this.cols
, this.rows
];
3074 this.emit('resize', {terminal
: this, cols
: x
, rows
: y
});
3078 * Updates the range of rows to refresh
3079 * @param {number} y The number of rows to refresh next.
3081 Terminal
.prototype.updateRange = function(y
) {
3082 if (y
< this.refreshStart
) this.refreshStart
= y
;
3083 if (y
> this.refreshEnd
) this.refreshEnd
= y
;
3084 // if (y > this.refreshEnd) {
3085 // this.refreshEnd = y;
3086 // if (y > this.rows - 1) {
3087 // this.refreshEnd = this.rows - 1;
3093 * Set the range of refreshing to the maximum value
3095 Terminal
.prototype.maxRange = function() {
3096 this.refreshStart
= 0;
3097 this.refreshEnd
= this.rows
- 1;
3103 * Setup the tab stops.
3106 Terminal
.prototype.setupStops = function(i
) {
3108 if (!this.tabs
[i
]) {
3109 i
= this.prevStop(i
);
3116 for (; i
< this.cols
; i
+= 8) {
3117 this.tabs
[i
] = true;
3123 * Move the cursor to the previous tab stop from the given position (default is current).
3124 * @param {number} x The position to move the cursor to the previous tab stop.
3126 Terminal
.prototype.prevStop = function(x
) {
3127 if (x
== null) x
= this.x
;
3128 while (!this.tabs
[--x
] && x
> 0);
3129 return x
>= this.cols
3136 * Move the cursor one tab stop forward from the given position (default is current).
3137 * @param {number} x The position to move the cursor one tab stop forward.
3139 Terminal
.prototype.nextStop = function(x
) {
3140 if (x
== null) x
= this.x
;
3141 while (!this.tabs
[++x
] && x
< this.cols
);
3142 return x
>= this.cols
3149 * Erase in the identified line everything from "x" to the end of the line (right).
3150 * @param {number} x The column from which to start erasing to the end of the line.
3151 * @param {number} y The line in which to operate.
3153 Terminal
.prototype.eraseRight = function(x
, y
) {
3154 var line
= this.lines
.get(this.ybase
+ y
)
3155 , ch
= [this.eraseAttr(), ' ', 1]; // xterm
3158 for (; x
< this.cols
; x
++) {
3162 this.updateRange(y
);
3168 * Erase in the identified line everything from "x" to the start of the line (left).
3169 * @param {number} x The column from which to start erasing to the start of the line.
3170 * @param {number} y The line in which to operate.
3172 Terminal
.prototype.eraseLeft = function(x
, y
) {
3173 var line
= this.lines
.get(this.ybase
+ y
)
3174 , ch
= [this.eraseAttr(), ' ', 1]; // xterm
3177 while (x
--) line
[x
] = ch
;
3179 this.updateRange(y
);
3183 * Clears the entire buffer, making the prompt line the new first line.
3185 Terminal
.prototype.clear = function() {
3186 if (this.ybase
=== 0 && this.y
=== 0) {
3187 // Don't clear if it's already clear
3190 this.lines
.set(0, this.lines
.get(this.ybase
+ this.y
));
3191 this.lines
.length
= 1;
3195 for (var i
= 1; i
< this.rows
; i
++) {
3196 this.lines
.push(this.blankLine());
3198 this.queueRefresh(0, this.rows
- 1);
3199 this.emit('scroll', this.ydisp
);
3203 * Erase all content in the given line
3204 * @param {number} y The line to erase all of its contents.
3206 Terminal
.prototype.eraseLine = function(y
) {
3207 this.eraseRight(0, y
);
3212 * Return the data array of a blank line
3213 * @param {number} cur First bunch of data for each "blank" character.
3215 Terminal
.prototype.blankLine = function(cur
) {
3220 var ch
= [attr
, ' ', 1] // width defaults to 1 halfwidth character
3224 for (; i
< this.cols
; i
++) {
3233 * If cur return the back color xterm feature attribute. Else return defAttr.
3234 * @param {object} cur
3236 Terminal
.prototype.ch = function(cur
) {
3238 ? [this.eraseAttr(), ' ', 1]
3239 : [this.defAttr
, ' ', 1];
3244 * Evaluate if the current erminal is the given argument.
3245 * @param {object} term The terminal to evaluate
3247 Terminal
.prototype.is = function(term
) {
3248 var name
= this.termName
;
3249 return (name
+ '').indexOf(term
) === 0;
3254 * Emit the 'data' event and populate the given data.
3255 * @param {string} data The data to populate in the event.
3257 Terminal
.prototype.handler = function(data
) {
3258 // Prevents all events to pty process if stdin is disabled
3259 if (this.options
.disableStdin
) {
3263 // Input is being sent to the terminal, the terminal should focus the prompt.
3264 if (this.ybase
!== this.ydisp
) {
3265 this.scrollToBottom();
3267 this.emit('data', data
);
3272 * Emit the 'title' event and populate the given title.
3273 * @param {string} title The title to populate in the event.
3275 Terminal
.prototype.handleTitle = function(title
) {
3277 * This event is emitted when the title of the terminal is changed
3278 * from inside the terminal. The parameter is the new title.
3282 this.emit('title', title
);
3291 * ESC D Index (IND is 0x84).
3293 Terminal
.prototype.index = function() {
3295 if (this.y
> this.scrollBottom
) {
3299 this.state
= normal
;
3304 * ESC M Reverse Index (RI is 0x8d).
3306 * Move the cursor up one row, inserting a new blank line if necessary.
3308 Terminal
.prototype.reverseIndex = function() {
3310 if (this.y
=== this.scrollTop
) {
3311 // possibly move the code below to term.reverseScroll();
3312 // test: echo -ne '\e[1;1H\e[44m\eM\e[0m'
3313 // blankLine(true) is xterm/linux behavior
3314 this.lines
.shiftElements(this.y
+ this.ybase
, this.rows
- 1, 1);
3315 this.lines
.set(this.y
+ this.ybase
, this.blankLine(true));
3316 this.updateRange(this.scrollTop
);
3317 this.updateRange(this.scrollBottom
);
3321 this.state
= normal
;
3326 * ESC c Full Reset (RIS).
3328 Terminal
.prototype.reset = function() {
3329 this.options
.rows
= this.rows
;
3330 this.options
.cols
= this.cols
;
3331 var customKeydownHandler
= this.customKeydownHandler
;
3332 Terminal
.call(this, this.options
);
3333 this.customKeydownHandler
= customKeydownHandler
;
3334 this.queueRefresh(0, this.rows
- 1);
3335 this.viewport
.syncScrollArea();
3340 * ESC H Tab Set (HTS is 0x88).
3342 Terminal
.prototype.tabSet = function() {
3343 this.tabs
[this.x
] = true;
3344 this.state
= normal
;
3354 * Cursor Up Ps Times (default = 1) (CUU).
3356 Terminal
.prototype.cursorUp = function(params
) {
3357 var param
= params
[0];
3358 if (param
< 1) param
= 1;
3360 if (this.y
< 0) this.y
= 0;
3366 * Cursor Down Ps Times (default = 1) (CUD).
3368 Terminal
.prototype.cursorDown = function(params
) {
3369 var param
= params
[0];
3370 if (param
< 1) param
= 1;
3372 if (this.y
>= this.rows
) {
3373 this.y
= this.rows
- 1;
3380 * Cursor Forward Ps Times (default = 1) (CUF).
3382 Terminal
.prototype.cursorForward = function(params
) {
3383 var param
= params
[0];
3384 if (param
< 1) param
= 1;
3386 if (this.x
>= this.cols
) {
3387 this.x
= this.cols
- 1;
3394 * Cursor Backward Ps Times (default = 1) (CUB).
3396 Terminal
.prototype.cursorBackward = function(params
) {
3397 var param
= params
[0];
3398 if (param
< 1) param
= 1;
3400 if (this.x
< 0) this.x
= 0;
3406 * Cursor Position [row;column] (default = [1,1]) (CUP).
3408 Terminal
.prototype.cursorPos = function(params
) {
3411 row
= params
[0] - 1;
3413 if (params
.length
>= 2) {
3414 col
= params
[1] - 1;
3421 } else if (row
>= this.rows
) {
3422 row
= this.rows
- 1;
3427 } else if (col
>= this.cols
) {
3428 col
= this.cols
- 1;
3437 * CSI Ps J Erase in Display (ED).
3438 * Ps = 0 -> Erase Below (default).
3439 * Ps = 1 -> Erase Above.
3440 * Ps = 2 -> Erase All.
3441 * Ps = 3 -> Erase Saved Lines (xterm).
3443 * Erase in Display (DECSED).
3444 * Ps = 0 -> Selective Erase Below (default).
3445 * Ps = 1 -> Selective Erase Above.
3446 * Ps = 2 -> Selective Erase All.
3448 Terminal
.prototype.eraseInDisplay = function(params
) {
3450 switch (params
[0]) {
3452 this.eraseRight(this.x
, this.y
);
3454 for (; j
< this.rows
; j
++) {
3459 this.eraseLeft(this.x
, this.y
);
3467 while (j
--) this.eraseLine(j
);
3477 * CSI Ps K Erase in Line (EL).
3478 * Ps = 0 -> Erase to Right (default).
3479 * Ps = 1 -> Erase to Left.
3480 * Ps = 2 -> Erase All.
3482 * Erase in Line (DECSEL).
3483 * Ps = 0 -> Selective Erase to Right (default).
3484 * Ps = 1 -> Selective Erase to Left.
3485 * Ps = 2 -> Selective Erase All.
3487 Terminal
.prototype.eraseInLine = function(params
) {
3488 switch (params
[0]) {
3490 this.eraseRight(this.x
, this.y
);
3493 this.eraseLeft(this.x
, this.y
);
3496 this.eraseLine(this.y
);
3503 * CSI Pm m Character Attributes (SGR).
3504 * Ps = 0 -> Normal (default).
3506 * Ps = 4 -> Underlined.
3507 * Ps = 5 -> Blink (appears as Bold).
3508 * Ps = 7 -> Inverse.
3509 * Ps = 8 -> Invisible, i.e., hidden (VT300).
3510 * Ps = 2 2 -> Normal (neither bold nor faint).
3511 * Ps = 2 4 -> Not underlined.
3512 * Ps = 2 5 -> Steady (not blinking).
3513 * Ps = 2 7 -> Positive (not inverse).
3514 * Ps = 2 8 -> Visible, i.e., not hidden (VT300).
3515 * Ps = 3 0 -> Set foreground color to Black.
3516 * Ps = 3 1 -> Set foreground color to Red.
3517 * Ps = 3 2 -> Set foreground color to Green.
3518 * Ps = 3 3 -> Set foreground color to Yellow.
3519 * Ps = 3 4 -> Set foreground color to Blue.
3520 * Ps = 3 5 -> Set foreground color to Magenta.
3521 * Ps = 3 6 -> Set foreground color to Cyan.
3522 * Ps = 3 7 -> Set foreground color to White.
3523 * Ps = 3 9 -> Set foreground color to default (original).
3524 * Ps = 4 0 -> Set background color to Black.
3525 * Ps = 4 1 -> Set background color to Red.
3526 * Ps = 4 2 -> Set background color to Green.
3527 * Ps = 4 3 -> Set background color to Yellow.
3528 * Ps = 4 4 -> Set background color to Blue.
3529 * Ps = 4 5 -> Set background color to Magenta.
3530 * Ps = 4 6 -> Set background color to Cyan.
3531 * Ps = 4 7 -> Set background color to White.
3532 * Ps = 4 9 -> Set background color to default (original).
3534 * If 16-color support is compiled, the following apply. Assume
3535 * that xterm's resources are set so that the ISO color codes are
3536 * the first 8 of a set of 16. Then the aixterm colors are the
3537 * bright versions of the ISO colors:
3538 * Ps = 9 0 -> Set foreground color to Black.
3539 * Ps = 9 1 -> Set foreground color to Red.
3540 * Ps = 9 2 -> Set foreground color to Green.
3541 * Ps = 9 3 -> Set foreground color to Yellow.
3542 * Ps = 9 4 -> Set foreground color to Blue.
3543 * Ps = 9 5 -> Set foreground color to Magenta.
3544 * Ps = 9 6 -> Set foreground color to Cyan.
3545 * Ps = 9 7 -> Set foreground color to White.
3546 * Ps = 1 0 0 -> Set background color to Black.
3547 * Ps = 1 0 1 -> Set background color to Red.
3548 * Ps = 1 0 2 -> Set background color to Green.
3549 * Ps = 1 0 3 -> Set background color to Yellow.
3550 * Ps = 1 0 4 -> Set background color to Blue.
3551 * Ps = 1 0 5 -> Set background color to Magenta.
3552 * Ps = 1 0 6 -> Set background color to Cyan.
3553 * Ps = 1 0 7 -> Set background color to White.
3555 * If xterm is compiled with the 16-color support disabled, it
3556 * supports the following, from rxvt:
3557 * Ps = 1 0 0 -> Set foreground and background color to
3560 * If 88- or 256-color support is compiled, the following apply.
3561 * Ps = 3 8 ; 5 ; Ps -> Set foreground color to the second
3563 * Ps = 4 8 ; 5 ; Ps -> Set background color to the second
3566 Terminal
.prototype.charAttributes = function(params
) {
3567 // Optimize a single SGR0.
3568 if (params
.length
=== 1 && params
[0] === 0) {
3569 this.curAttr
= this.defAttr
;
3573 var l
= params
.length
3575 , flags
= this.curAttr
>> 18
3576 , fg
= (this.curAttr
>> 9) & 0x1ff
3577 , bg
= this.curAttr
& 0x1ff
3580 for (; i
< l
; i
++) {
3582 if (p
>= 30 && p
<= 37) {
3585 } else if (p
>= 40 && p
<= 47) {
3588 } else if (p
>= 90 && p
<= 97) {
3592 } else if (p
>= 100 && p
<= 107) {
3596 } else if (p
=== 0) {
3598 flags
= this.defAttr
>> 18;
3599 fg
= (this.defAttr
>> 9) & 0x1ff;
3600 bg
= this.defAttr
& 0x1ff;
3604 } else if (p
=== 1) {
3607 } else if (p
=== 4) {
3610 } else if (p
=== 5) {
3613 } else if (p
=== 7) {
3614 // inverse and positive
3615 // test with: echo -e '\e[31m\e[42mhello\e[7mworld\e[27mhi\e[m'
3617 } else if (p
=== 8) {
3620 } else if (p
=== 22) {
3623 } else if (p
=== 24) {
3626 } else if (p
=== 25) {
3629 } else if (p
=== 27) {
3632 } else if (p
=== 28) {
3635 } else if (p
=== 39) {
3637 fg
= (this.defAttr
>> 9) & 0x1ff;
3638 } else if (p
=== 49) {
3640 bg
= this.defAttr
& 0x1ff;
3641 } else if (p
=== 38) {
3643 if (params
[i
+ 1] === 2) {
3647 params
[i
+ 1] & 0xff,
3648 params
[i
+ 2] & 0xff);
3649 if (fg
=== -1) fg
= 0x1ff;
3651 } else if (params
[i
+ 1] === 5) {
3653 p
= params
[i
] & 0xff;
3656 } else if (p
=== 48) {
3658 if (params
[i
+ 1] === 2) {
3662 params
[i
+ 1] & 0xff,
3663 params
[i
+ 2] & 0xff);
3664 if (bg
=== -1) bg
= 0x1ff;
3666 } else if (params
[i
+ 1] === 5) {
3668 p
= params
[i
] & 0xff;
3671 } else if (p
=== 100) {
3673 fg
= (this.defAttr
>> 9) & 0x1ff;
3674 bg
= this.defAttr
& 0x1ff;
3676 this.error('Unknown SGR attribute: %d.', p
);
3680 this.curAttr
= (flags
<< 18) | (fg
<< 9) | bg
;
3685 * CSI Ps n Device Status Report (DSR).
3686 * Ps = 5 -> Status Report. Result (``OK'') is
3688 * Ps = 6 -> Report Cursor Position (CPR) [row;column].
3692 * Device Status Report (DSR, DEC-specific).
3693 * Ps = 6 -> Report Cursor Position (CPR) [row;column] as CSI
3694 * ? r ; c R (assumes page is zero).
3695 * Ps = 1 5 -> Report Printer status as CSI ? 1 0 n (ready).
3696 * or CSI ? 1 1 n (not ready).
3697 * Ps = 2 5 -> Report UDK status as CSI ? 2 0 n (unlocked)
3698 * or CSI ? 2 1 n (locked).
3699 * Ps = 2 6 -> Report Keyboard status as
3700 * CSI ? 2 7 ; 1 ; 0 ; 0 n (North American).
3701 * The last two parameters apply to VT400 & up, and denote key-
3702 * board ready and LK01 respectively.
3703 * Ps = 5 3 -> Report Locator status as
3704 * CSI ? 5 3 n Locator available, if compiled-in, or
3705 * CSI ? 5 0 n No Locator, if not.
3707 Terminal
.prototype.deviceStatus = function(params
) {
3709 switch (params
[0]) {
3712 this.send(C0
.ESC
+ '[0n');
3716 this.send(C0
.ESC
+ '['
3723 } else if (this.prefix
=== '?') {
3724 // modern xterm doesnt seem to
3725 // respond to any of these except ?6, 6, and 5
3726 switch (params
[0]) {
3729 this.send(C0
.ESC
+ '[?'
3737 // this.send(C0.ESC + '[?11n');
3740 // dont support user defined keys
3741 // this.send(C0.ESC + '[?21n');
3744 // north american keyboard
3745 // this.send(C0.ESC + '[?27;1;0;0n');
3748 // no dec locator/mouse
3749 // this.send(C0.ESC + '[?50n');
3762 * Insert Ps (Blank) Character(s) (default = 1) (ICH).
3764 Terminal
.prototype.insertChars = function(params
) {
3765 var param
, row
, j
, ch
;
3768 if (param
< 1) param
= 1;
3770 row
= this.y
+ this.ybase
;
3772 ch
= [this.eraseAttr(), ' ', 1]; // xterm
3774 while (param
-- && j
< this.cols
) {
3775 this.lines
.get(row
).splice(j
++, 0, ch
);
3776 this.lines
.get(row
).pop();
3782 * Cursor Next Line Ps Times (default = 1) (CNL).
3783 * same as CSI Ps B ?
3785 Terminal
.prototype.cursorNextLine = function(params
) {
3786 var param
= params
[0];
3787 if (param
< 1) param
= 1;
3789 if (this.y
>= this.rows
) {
3790 this.y
= this.rows
- 1;
3798 * Cursor Preceding Line Ps Times (default = 1) (CNL).
3801 Terminal
.prototype.cursorPrecedingLine = function(params
) {
3802 var param
= params
[0];
3803 if (param
< 1) param
= 1;
3805 if (this.y
< 0) this.y
= 0;
3812 * Cursor Character Absolute [column] (default = [row,1]) (CHA).
3814 Terminal
.prototype.cursorCharAbsolute = function(params
) {
3815 var param
= params
[0];
3816 if (param
< 1) param
= 1;
3823 * Insert Ps Line(s) (default = 1) (IL).
3825 Terminal
.prototype.insertLines = function(params
) {
3829 if (param
< 1) param
= 1;
3830 row
= this.y
+ this.ybase
;
3832 j
= this.rows
- 1 - this.scrollBottom
;
3833 j
= this.rows
- 1 + this.ybase
- j
+ 1;
3836 if (this.lines
.length
=== this.lines
.maxLength
) {
3837 // Trim the start of lines to make room for the new line
3838 this.lines
.trimStart(1);
3844 // test: echo -e '\e[44m\e[1L\e[0m'
3845 // blankLine(true) - xterm/linux behavior
3846 this.lines
.splice(row
, 0, this.blankLine(true));
3847 this.lines
.splice(j
, 1);
3851 this.updateRange(this.y
);
3852 this.updateRange(this.scrollBottom
);
3858 * Delete Ps Line(s) (default = 1) (DL).
3860 Terminal
.prototype.deleteLines = function(params
) {
3864 if (param
< 1) param
= 1;
3865 row
= this.y
+ this.ybase
;
3867 j
= this.rows
- 1 - this.scrollBottom
;
3868 j
= this.rows
- 1 + this.ybase
- j
;
3871 if (this.lines
.length
=== this.lines
.maxLength
) {
3872 // Trim the start of lines to make room for the new line
3873 this.lines
.trimStart(1);
3877 // test: echo -e '\e[44m\e[1M\e[0m'
3878 // blankLine(true) - xterm/linux behavior
3879 this.lines
.splice(j
+ 1, 0, this.blankLine(true));
3880 this.lines
.splice(row
, 1);
3884 this.updateRange(this.y
);
3885 this.updateRange(this.scrollBottom
);
3891 * Delete Ps Character(s) (default = 1) (DCH).
3893 Terminal
.prototype.deleteChars = function(params
) {
3897 if (param
< 1) param
= 1;
3899 row
= this.y
+ this.ybase
;
3900 ch
= [this.eraseAttr(), ' ', 1]; // xterm
3903 this.lines
.get(row
).splice(this.x
, 1);
3904 this.lines
.get(row
).push(ch
);
3910 * Erase Ps Character(s) (default = 1) (ECH).
3912 Terminal
.prototype.eraseChars = function(params
) {
3913 var param
, row
, j
, ch
;
3916 if (param
< 1) param
= 1;
3918 row
= this.y
+ this.ybase
;
3920 ch
= [this.eraseAttr(), ' ', 1]; // xterm
3922 while (param
-- && j
< this.cols
) {
3923 this.lines
.get(row
)[j
++] = ch
;
3928 * CSI Pm ` Character Position Absolute
3929 * [column] (default = [row,1]) (HPA).
3931 Terminal
.prototype.charPosAbsolute = function(params
) {
3932 var param
= params
[0];
3933 if (param
< 1) param
= 1;
3935 if (this.x
>= this.cols
) {
3936 this.x
= this.cols
- 1;
3943 * Horizontal Position Relative
3946 Terminal
.prototype.HPositionRelative = function(params
) {
3947 var param
= params
[0];
3948 if (param
< 1) param
= 1;
3950 if (this.x
>= this.cols
) {
3951 this.x
= this.cols
- 1;
3957 * CSI Ps c Send Device Attributes (Primary DA).
3958 * Ps = 0 or omitted -> request attributes from terminal. The
3959 * response depends on the decTerminalID resource setting.
3960 * -> CSI ? 1 ; 2 c (``VT100 with Advanced Video Option'')
3961 * -> CSI ? 1 ; 0 c (``VT101 with No Options'')
3962 * -> CSI ? 6 c (``VT102'')
3963 * -> CSI ? 6 0 ; 1 ; 2 ; 6 ; 8 ; 9 ; 1 5 ; c (``VT220'')
3964 * The VT100-style response parameters do not mean anything by
3965 * themselves. VT220 parameters do, telling the host what fea-
3966 * tures the terminal supports:
3967 * Ps = 1 -> 132-columns.
3968 * Ps = 2 -> Printer.
3969 * Ps = 6 -> Selective erase.
3970 * Ps = 8 -> User-defined keys.
3971 * Ps = 9 -> National replacement character sets.
3972 * Ps = 1 5 -> Technical characters.
3973 * Ps = 2 2 -> ANSI color, e.g., VT525.
3974 * Ps = 2 9 -> ANSI text locator (i.e., DEC Locator mode).
3976 * Send Device Attributes (Secondary DA).
3977 * Ps = 0 or omitted -> request the terminal's identification
3978 * code. The response depends on the decTerminalID resource set-
3979 * ting. It should apply only to VT220 and up, but xterm extends
3981 * -> CSI > Pp ; Pv ; Pc c
3982 * where Pp denotes the terminal type
3983 * Pp = 0 -> ``VT100''.
3984 * Pp = 1 -> ``VT220''.
3985 * and Pv is the firmware version (for xterm, this was originally
3986 * the XFree86 patch number, starting with 95). In a DEC termi-
3987 * nal, Pc indicates the ROM cartridge registration number and is
3990 * xterm/charproc.c - line 2012, for more information.
3991 * vim responds with ^[[?0c or ^[[?1c after the terminal's response (?)
3993 Terminal
.prototype.sendDeviceAttributes = function(params
) {
3994 if (params
[0] > 0) return;
3997 if (this.is('xterm')
3998 || this.is('rxvt-unicode')
3999 || this.is('screen')) {
4000 this.send(C0
.ESC
+ '[?1;2c');
4001 } else if (this.is('linux')) {
4002 this.send(C0
.ESC
+ '[?6c');
4004 } else if (this.prefix
=== '>') {
4006 // seem to spit this
4007 // out around ~370 times (?).
4008 if (this.is('xterm')) {
4009 this.send(C0
.ESC
+ '[>0;276;0c');
4010 } else if (this.is('rxvt-unicode')) {
4011 this.send(C0
.ESC
+ '[>85;95;0c');
4012 } else if (this.is('linux')) {
4013 // not supported by linux console.
4014 // linux console echoes parameters.
4015 this.send(params
[0] + 'c');
4016 } else if (this.is('screen')) {
4017 this.send(C0
.ESC
+ '[>83;40003;0c');
4025 * Line Position Absolute [row] (default = [1,column]) (VPA).
4027 Terminal
.prototype.linePosAbsolute = function(params
) {
4028 var param
= params
[0];
4029 if (param
< 1) param
= 1;
4031 if (this.y
>= this.rows
) {
4032 this.y
= this.rows
- 1;
4038 * 145 65 e * VPR - Vertical Position Relative
4041 Terminal
.prototype.VPositionRelative = function(params
) {
4042 var param
= params
[0];
4043 if (param
< 1) param
= 1;
4045 if (this.y
>= this.rows
) {
4046 this.y
= this.rows
- 1;
4053 * Horizontal and Vertical Position [row;column] (default =
4056 Terminal
.prototype.HVPosition = function(params
) {
4057 if (params
[0] < 1) params
[0] = 1;
4058 if (params
[1] < 1) params
[1] = 1;
4060 this.y
= params
[0] - 1;
4061 if (this.y
>= this.rows
) {
4062 this.y
= this.rows
- 1;
4065 this.x
= params
[1] - 1;
4066 if (this.x
>= this.cols
) {
4067 this.x
= this.cols
- 1;
4073 * CSI Pm h Set Mode (SM).
4074 * Ps = 2 -> Keyboard Action Mode (AM).
4075 * Ps = 4 -> Insert Mode (IRM).
4076 * Ps = 1 2 -> Send/receive (SRM).
4077 * Ps = 2 0 -> Automatic Newline (LNM).
4079 * DEC Private Mode Set (DECSET).
4080 * Ps = 1 -> Application Cursor Keys (DECCKM).
4081 * Ps = 2 -> Designate USASCII for character sets G0-G3
4082 * (DECANM), and set VT100 mode.
4083 * Ps = 3 -> 132 Column Mode (DECCOLM).
4084 * Ps = 4 -> Smooth (Slow) Scroll (DECSCLM).
4085 * Ps = 5 -> Reverse Video (DECSCNM).
4086 * Ps = 6 -> Origin Mode (DECOM).
4087 * Ps = 7 -> Wraparound Mode (DECAWM).
4088 * Ps = 8 -> Auto-repeat Keys (DECARM).
4089 * Ps = 9 -> Send Mouse X & Y on button press. See the sec-
4090 * tion Mouse Tracking.
4091 * Ps = 1 0 -> Show toolbar (rxvt).
4092 * Ps = 1 2 -> Start Blinking Cursor (att610).
4093 * Ps = 1 8 -> Print form feed (DECPFF).
4094 * Ps = 1 9 -> Set print extent to full screen (DECPEX).
4095 * Ps = 2 5 -> Show Cursor (DECTCEM).
4096 * Ps = 3 0 -> Show scrollbar (rxvt).
4097 * Ps = 3 5 -> Enable font-shifting functions (rxvt).
4098 * Ps = 3 8 -> Enter Tektronix Mode (DECTEK).
4099 * Ps = 4 0 -> Allow 80 -> 132 Mode.
4100 * Ps = 4 1 -> more(1) fix (see curses resource).
4101 * Ps = 4 2 -> Enable Nation Replacement Character sets (DECN-
4103 * Ps = 4 4 -> Turn On Margin Bell.
4104 * Ps = 4 5 -> Reverse-wraparound Mode.
4105 * Ps = 4 6 -> Start Logging. This is normally disabled by a
4106 * compile-time option.
4107 * Ps = 4 7 -> Use Alternate Screen Buffer. (This may be dis-
4108 * abled by the titeInhibit resource).
4109 * Ps = 6 6 -> Application keypad (DECNKM).
4110 * Ps = 6 7 -> Backarrow key sends backspace (DECBKM).
4111 * Ps = 1 0 0 0 -> Send Mouse X & Y on button press and
4112 * release. See the section Mouse Tracking.
4113 * Ps = 1 0 0 1 -> Use Hilite Mouse Tracking.
4114 * Ps = 1 0 0 2 -> Use Cell Motion Mouse Tracking.
4115 * Ps = 1 0 0 3 -> Use All Motion Mouse Tracking.
4116 * Ps = 1 0 0 4 -> Send FocusIn/FocusOut events.
4117 * Ps = 1 0 0 5 -> Enable Extended Mouse Mode.
4118 * Ps = 1 0 1 0 -> Scroll to bottom on tty output (rxvt).
4119 * Ps = 1 0 1 1 -> Scroll to bottom on key press (rxvt).
4120 * Ps = 1 0 3 4 -> Interpret "meta" key, sets eighth bit.
4121 * (enables the eightBitInput resource).
4122 * Ps = 1 0 3 5 -> Enable special modifiers for Alt and Num-
4123 * Lock keys. (This enables the numLock resource).
4124 * Ps = 1 0 3 6 -> Send ESC when Meta modifies a key. (This
4125 * enables the metaSendsEscape resource).
4126 * Ps = 1 0 3 7 -> Send DEL from the editing-keypad Delete
4128 * Ps = 1 0 3 9 -> Send ESC when Alt modifies a key. (This
4129 * enables the altSendsEscape resource).
4130 * Ps = 1 0 4 0 -> Keep selection even if not highlighted.
4131 * (This enables the keepSelection resource).
4132 * Ps = 1 0 4 1 -> Use the CLIPBOARD selection. (This enables
4133 * the selectToClipboard resource).
4134 * Ps = 1 0 4 2 -> Enable Urgency window manager hint when
4135 * Control-G is received. (This enables the bellIsUrgent
4137 * Ps = 1 0 4 3 -> Enable raising of the window when Control-G
4138 * is received. (enables the popOnBell resource).
4139 * Ps = 1 0 4 7 -> Use Alternate Screen Buffer. (This may be
4140 * disabled by the titeInhibit resource).
4141 * Ps = 1 0 4 8 -> Save cursor as in DECSC. (This may be dis-
4142 * abled by the titeInhibit resource).
4143 * Ps = 1 0 4 9 -> Save cursor as in DECSC and use Alternate
4144 * Screen Buffer, clearing it first. (This may be disabled by
4145 * the titeInhibit resource). This combines the effects of the 1
4146 * 0 4 7 and 1 0 4 8 modes. Use this with terminfo-based
4147 * applications rather than the 4 7 mode.
4148 * Ps = 1 0 5 0 -> Set terminfo/termcap function-key mode.
4149 * Ps = 1 0 5 1 -> Set Sun function-key mode.
4150 * Ps = 1 0 5 2 -> Set HP function-key mode.
4151 * Ps = 1 0 5 3 -> Set SCO function-key mode.
4152 * Ps = 1 0 6 0 -> Set legacy keyboard emulation (X11R6).
4153 * Ps = 1 0 6 1 -> Set VT220 keyboard emulation.
4154 * Ps = 2 0 0 4 -> Set bracketed paste mode.
4156 * http: *vt100.net/docs/vt220-rm/chapter4.html
4158 Terminal
.prototype.setMode = function(params
) {
4159 if (typeof params
=== 'object') {
4160 var l
= params
.length
4163 for (; i
< l
; i
++) {
4164 this.setMode(params
[i
]);
4173 this.insertMode
= true;
4176 //this.convertEol = true;
4179 } else if (this.prefix
=== '?') {
4182 this.applicationCursor
= true;
4185 this.setgCharset(0, Terminal
.charsets
.US
);
4186 this.setgCharset(1, Terminal
.charsets
.US
);
4187 this.setgCharset(2, Terminal
.charsets
.US
);
4188 this.setgCharset(3, Terminal
.charsets
.US
);
4189 // set VT100 mode here
4191 case 3: // 132 col mode
4192 this.savedCols
= this.cols
;
4193 this.resize(132, this.rows
);
4196 this.originMode
= true;
4199 this.wraparoundMode
= true;
4202 // this.cursorBlink = true;
4205 this.log('Serial port requested application keypad.');
4206 this.applicationKeypad
= true;
4207 this.viewport
.syncScrollArea();
4209 case 9: // X10 Mouse
4210 // no release, no motion, no wheel, no modifiers.
4211 case 1000: // vt200 mouse
4213 // no modifiers, except control on the wheel.
4214 case 1002: // button event mouse
4215 case 1003: // any event mouse
4216 // any event - sends motion events,
4217 // even if there is no button held down.
4218 this.x10Mouse
= params
=== 9;
4219 this.vt200Mouse
= params
=== 1000;
4220 this.normalMouse
= params
> 1000;
4221 this.mouseEvents
= true;
4222 this.element
.style
.cursor
= 'default';
4223 this.log('Binding to mouse events.');
4225 case 1004: // send focusin/focusout events
4228 this.sendFocus
= true;
4230 case 1005: // utf8 ext mode mouse
4231 this.utfMouse
= true;
4232 // for wide terminals
4233 // simply encodes large values as utf8 characters
4235 case 1006: // sgr ext mode mouse
4236 this.sgrMouse
= true;
4237 // for wide terminals
4238 // does not add 32 to fields
4239 // press: ^[[<b;x;yM
4240 // release: ^[[<b;x;ym
4242 case 1015: // urxvt ext mode mouse
4243 this.urxvtMouse
= true;
4244 // for wide terminals
4245 // numbers for fields
4247 // motion: ^[[b;x;yT
4249 case 25: // show cursor
4250 this.cursorHidden
= false;
4252 case 1049: // alt screen buffer cursor
4253 //this.saveCursor();
4255 case 47: // alt screen buffer
4256 case 1047: // alt screen buffer
4264 scrollTop
: this.scrollTop
,
4265 scrollBottom
: this.scrollBottom
,
4267 // XXX save charset(s) here?
4268 // charset: this.charset,
4269 // glevel: this.glevel,
4270 // charsets: this.charsets
4273 this.viewport
.syncScrollArea();
4274 this.normal
= normal
;
4283 * CSI Pm l Reset Mode (RM).
4284 * Ps = 2 -> Keyboard Action Mode (AM).
4285 * Ps = 4 -> Replace Mode (IRM).
4286 * Ps = 1 2 -> Send/receive (SRM).
4287 * Ps = 2 0 -> Normal Linefeed (LNM).
4289 * DEC Private Mode Reset (DECRST).
4290 * Ps = 1 -> Normal Cursor Keys (DECCKM).
4291 * Ps = 2 -> Designate VT52 mode (DECANM).
4292 * Ps = 3 -> 80 Column Mode (DECCOLM).
4293 * Ps = 4 -> Jump (Fast) Scroll (DECSCLM).
4294 * Ps = 5 -> Normal Video (DECSCNM).
4295 * Ps = 6 -> Normal Cursor Mode (DECOM).
4296 * Ps = 7 -> No Wraparound Mode (DECAWM).
4297 * Ps = 8 -> No Auto-repeat Keys (DECARM).
4298 * Ps = 9 -> Don't send Mouse X & Y on button press.
4299 * Ps = 1 0 -> Hide toolbar (rxvt).
4300 * Ps = 1 2 -> Stop Blinking Cursor (att610).
4301 * Ps = 1 8 -> Don't print form feed (DECPFF).
4302 * Ps = 1 9 -> Limit print to scrolling region (DECPEX).
4303 * Ps = 2 5 -> Hide Cursor (DECTCEM).
4304 * Ps = 3 0 -> Don't show scrollbar (rxvt).
4305 * Ps = 3 5 -> Disable font-shifting functions (rxvt).
4306 * Ps = 4 0 -> Disallow 80 -> 132 Mode.
4307 * Ps = 4 1 -> No more(1) fix (see curses resource).
4308 * Ps = 4 2 -> Disable Nation Replacement Character sets (DEC-
4310 * Ps = 4 4 -> Turn Off Margin Bell.
4311 * Ps = 4 5 -> No Reverse-wraparound Mode.
4312 * Ps = 4 6 -> Stop Logging. (This is normally disabled by a
4313 * compile-time option).
4314 * Ps = 4 7 -> Use Normal Screen Buffer.
4315 * Ps = 6 6 -> Numeric keypad (DECNKM).
4316 * Ps = 6 7 -> Backarrow key sends delete (DECBKM).
4317 * Ps = 1 0 0 0 -> Don't send Mouse X & Y on button press and
4318 * release. See the section Mouse Tracking.
4319 * Ps = 1 0 0 1 -> Don't use Hilite Mouse Tracking.
4320 * Ps = 1 0 0 2 -> Don't use Cell Motion Mouse Tracking.
4321 * Ps = 1 0 0 3 -> Don't use All Motion Mouse Tracking.
4322 * Ps = 1 0 0 4 -> Don't send FocusIn/FocusOut events.
4323 * Ps = 1 0 0 5 -> Disable Extended Mouse Mode.
4324 * Ps = 1 0 1 0 -> Don't scroll to bottom on tty output
4326 * Ps = 1 0 1 1 -> Don't scroll to bottom on key press (rxvt).
4327 * Ps = 1 0 3 4 -> Don't interpret "meta" key. (This disables
4328 * the eightBitInput resource).
4329 * Ps = 1 0 3 5 -> Disable special modifiers for Alt and Num-
4330 * Lock keys. (This disables the numLock resource).
4331 * Ps = 1 0 3 6 -> Don't send ESC when Meta modifies a key.
4332 * (This disables the metaSendsEscape resource).
4333 * Ps = 1 0 3 7 -> Send VT220 Remove from the editing-keypad
4335 * Ps = 1 0 3 9 -> Don't send ESC when Alt modifies a key.
4336 * (This disables the altSendsEscape resource).
4337 * Ps = 1 0 4 0 -> Do not keep selection when not highlighted.
4338 * (This disables the keepSelection resource).
4339 * Ps = 1 0 4 1 -> Use the PRIMARY selection. (This disables
4340 * the selectToClipboard resource).
4341 * Ps = 1 0 4 2 -> Disable Urgency window manager hint when
4342 * Control-G is received. (This disables the bellIsUrgent
4344 * Ps = 1 0 4 3 -> Disable raising of the window when Control-
4345 * G is received. (This disables the popOnBell resource).
4346 * Ps = 1 0 4 7 -> Use Normal Screen Buffer, clearing screen
4347 * first if in the Alternate Screen. (This may be disabled by
4348 * the titeInhibit resource).
4349 * Ps = 1 0 4 8 -> Restore cursor as in DECRC. (This may be
4350 * disabled by the titeInhibit resource).
4351 * Ps = 1 0 4 9 -> Use Normal Screen Buffer and restore cursor
4352 * as in DECRC. (This may be disabled by the titeInhibit
4353 * resource). This combines the effects of the 1 0 4 7 and 1 0
4354 * 4 8 modes. Use this with terminfo-based applications rather
4355 * than the 4 7 mode.
4356 * Ps = 1 0 5 0 -> Reset terminfo/termcap function-key mode.
4357 * Ps = 1 0 5 1 -> Reset Sun function-key mode.
4358 * Ps = 1 0 5 2 -> Reset HP function-key mode.
4359 * Ps = 1 0 5 3 -> Reset SCO function-key mode.
4360 * Ps = 1 0 6 0 -> Reset legacy keyboard emulation (X11R6).
4361 * Ps = 1 0 6 1 -> Reset keyboard emulation to Sun/PC style.
4362 * Ps = 2 0 0 4 -> Reset bracketed paste mode.
4364 Terminal
.prototype.resetMode = function(params
) {
4365 if (typeof params
=== 'object') {
4366 var l
= params
.length
4369 for (; i
< l
; i
++) {
4370 this.resetMode(params
[i
]);
4379 this.insertMode
= false;
4382 //this.convertEol = false;
4385 } else if (this.prefix
=== '?') {
4388 this.applicationCursor
= false;
4391 if (this.cols
=== 132 && this.savedCols
) {
4392 this.resize(this.savedCols
, this.rows
);
4394 delete this.savedCols
;
4397 this.originMode
= false;
4400 this.wraparoundMode
= false;
4403 // this.cursorBlink = false;
4406 this.log('Switching back to normal keypad.');
4407 this.applicationKeypad
= false;
4408 this.viewport
.syncScrollArea();
4410 case 9: // X10 Mouse
4411 case 1000: // vt200 mouse
4412 case 1002: // button event mouse
4413 case 1003: // any event mouse
4414 this.x10Mouse
= false;
4415 this.vt200Mouse
= false;
4416 this.normalMouse
= false;
4417 this.mouseEvents
= false;
4418 this.element
.style
.cursor
= '';
4420 case 1004: // send focusin/focusout events
4421 this.sendFocus
= false;
4423 case 1005: // utf8 ext mode mouse
4424 this.utfMouse
= false;
4426 case 1006: // sgr ext mode mouse
4427 this.sgrMouse
= false;
4429 case 1015: // urxvt ext mode mouse
4430 this.urxvtMouse
= false;
4432 case 25: // hide cursor
4433 this.cursorHidden
= true;
4435 case 1049: // alt screen buffer cursor
4437 case 47: // normal screen buffer
4438 case 1047: // normal screen buffer - clearing it first
4440 this.lines
= this.normal
.lines
;
4441 this.ybase
= this.normal
.ybase
;
4442 this.ydisp
= this.normal
.ydisp
;
4443 this.x
= this.normal
.x
;
4444 this.y
= this.normal
.y
;
4445 this.scrollTop
= this.normal
.scrollTop
;
4446 this.scrollBottom
= this.normal
.scrollBottom
;
4447 this.tabs
= this.normal
.tabs
;
4449 // if (params === 1049) {
4450 // this.x = this.savedX;
4451 // this.y = this.savedY;
4453 this.queueRefresh(0, this.rows
- 1);
4454 this.viewport
.syncScrollArea();
4465 * Set Scrolling Region [top;bottom] (default = full size of win-
4469 Terminal
.prototype.setScrollRegion = function(params
) {
4470 if (this.prefix
) return;
4471 this.scrollTop
= (params
[0] || 1) - 1;
4472 this.scrollBottom
= (params
[1] || this.rows
) - 1;
4480 * Save cursor (ANSI.SYS).
4482 Terminal
.prototype.saveCursor = function(params
) {
4483 this.savedX
= this.x
;
4484 this.savedY
= this.y
;
4490 * Restore cursor (ANSI.SYS).
4492 Terminal
.prototype.restoreCursor = function(params
) {
4493 this.x
= this.savedX
|| 0;
4494 this.y
= this.savedY
|| 0;
4504 * Cursor Forward Tabulation Ps tab stops (default = 1) (CHT).
4506 Terminal
.prototype.cursorForwardTab = function(params
) {
4507 var param
= params
[0] || 1;
4509 this.x
= this.nextStop();
4515 * CSI Ps S Scroll up Ps lines (default = 1) (SU).
4517 Terminal
.prototype.scrollUp = function(params
) {
4518 var param
= params
[0] || 1;
4520 this.lines
.splice(this.ybase
+ this.scrollTop
, 1);
4521 this.lines
.splice(this.ybase
+ this.scrollBottom
, 0, this.blankLine());
4524 this.updateRange(this.scrollTop
);
4525 this.updateRange(this.scrollBottom
);
4530 * CSI Ps T Scroll down Ps lines (default = 1) (SD).
4532 Terminal
.prototype.scrollDown = function(params
) {
4533 var param
= params
[0] || 1;
4535 this.lines
.splice(this.ybase
+ this.scrollBottom
, 1);
4536 this.lines
.splice(this.ybase
+ this.scrollTop
, 0, this.blankLine());
4539 this.updateRange(this.scrollTop
);
4540 this.updateRange(this.scrollBottom
);
4545 * CSI Ps ; Ps ; Ps ; Ps ; Ps T
4546 * Initiate highlight mouse tracking. Parameters are
4547 * [func;startx;starty;firstrow;lastrow]. See the section Mouse
4550 Terminal
.prototype.initMouseTracking = function(params
) {
4551 // Relevant: DECSET 1001
4557 * Reset one or more features of the title modes to the default
4558 * value. Normally, "reset" disables the feature. It is possi-
4559 * ble to disable the ability to reset features by compiling a
4560 * different default for the title modes into xterm.
4561 * Ps = 0 -> Do not set window/icon labels using hexadecimal.
4562 * Ps = 1 -> Do not query window/icon labels using hexadeci-
4564 * Ps = 2 -> Do not set window/icon labels using UTF-8.
4565 * Ps = 3 -> Do not query window/icon labels using UTF-8.
4566 * (See discussion of "Title Modes").
4568 Terminal
.prototype.resetTitleModes = function(params
) {
4574 * CSI Ps Z Cursor Backward Tabulation Ps tab stops (default = 1) (CBT).
4576 Terminal
.prototype.cursorBackwardTab = function(params
) {
4577 var param
= params
[0] || 1;
4579 this.x
= this.prevStop();
4585 * CSI Ps b Repeat the preceding graphic character Ps times (REP).
4587 Terminal
.prototype.repeatPrecedingCharacter = function(params
) {
4588 var param
= params
[0] || 1
4589 , line
= this.lines
.get(this.ybase
+ this.y
)
4590 , ch
= line
[this.x
- 1] || [this.defAttr
, ' ', 1];
4592 while (param
--) line
[this.x
++] = ch
;
4597 * CSI Ps g Tab Clear (TBC).
4598 * Ps = 0 -> Clear Current Column (default).
4599 * Ps = 3 -> Clear All.
4601 * Ps = 2 -> Clear Stops on Line.
4602 * http://vt100.net/annarbor/aaa-ug/section6.html
4604 Terminal
.prototype.tabClear = function(params
) {
4605 var param
= params
[0];
4607 delete this.tabs
[this.x
];
4608 } else if (param
=== 3) {
4615 * CSI Pm i Media Copy (MC).
4616 * Ps = 0 -> Print screen (default).
4617 * Ps = 4 -> Turn off printer controller mode.
4618 * Ps = 5 -> Turn on printer controller mode.
4620 * Media Copy (MC, DEC-specific).
4621 * Ps = 1 -> Print line containing cursor.
4622 * Ps = 4 -> Turn off autoprint mode.
4623 * Ps = 5 -> Turn on autoprint mode.
4624 * Ps = 1 0 -> Print composed display, ignores DECPEX.
4625 * Ps = 1 1 -> Print all pages.
4627 Terminal
.prototype.mediaCopy = function(params
) {
4634 * Set or reset resource-values used by xterm to decide whether
4635 * to construct escape sequences holding information about the
4636 * modifiers pressed with a given key. The first parameter iden-
4637 * tifies the resource to set/reset. The second parameter is the
4638 * value to assign to the resource. If the second parameter is
4639 * omitted, the resource is reset to its initial value.
4640 * Ps = 1 -> modifyCursorKeys.
4641 * Ps = 2 -> modifyFunctionKeys.
4642 * Ps = 4 -> modifyOtherKeys.
4643 * If no parameters are given, all resources are reset to their
4646 Terminal
.prototype.setResources = function(params
) {
4653 * Disable modifiers which may be enabled via the CSI > Ps; Ps m
4654 * sequence. This corresponds to a resource value of "-1", which
4655 * cannot be set with the other sequence. The parameter identi-
4656 * fies the resource to be disabled:
4657 * Ps = 1 -> modifyCursorKeys.
4658 * Ps = 2 -> modifyFunctionKeys.
4659 * Ps = 4 -> modifyOtherKeys.
4660 * If the parameter is omitted, modifyFunctionKeys is disabled.
4661 * When modifyFunctionKeys is disabled, xterm uses the modifier
4662 * keys to make an extended sequence of functions rather than
4663 * adding a parameter to each function key to denote the modi-
4666 Terminal
.prototype.disableModifiers = function(params
) {
4673 * Set resource value pointerMode. This is used by xterm to
4674 * decide whether to hide the pointer cursor as the user types.
4675 * Valid values for the parameter:
4676 * Ps = 0 -> never hide the pointer.
4677 * Ps = 1 -> hide if the mouse tracking mode is not enabled.
4678 * Ps = 2 -> always hide the pointer. If no parameter is
4679 * given, xterm uses the default, which is 1 .
4681 Terminal
.prototype.setPointerMode = function(params
) {
4687 * CSI ! p Soft terminal reset (DECSTR).
4688 * http://vt100.net/docs/vt220-rm/table4-10.html
4690 Terminal
.prototype.softReset = function(params
) {
4691 this.cursorHidden
= false;
4692 this.insertMode
= false;
4693 this.originMode
= false;
4694 this.wraparoundMode
= false; // autowrap
4695 this.applicationKeypad
= false; // ?
4696 this.viewport
.syncScrollArea();
4697 this.applicationCursor
= false;
4699 this.scrollBottom
= this.rows
- 1;
4700 this.curAttr
= this.defAttr
;
4701 this.x
= this.y
= 0; // ?
4702 this.charset
= null;
4703 this.glevel
= 0; // ??
4704 this.charsets
= [null]; // ??
4710 * Request ANSI mode (DECRQM). For VT300 and up, reply is
4712 * where Ps is the mode number as in RM, and Pm is the mode
4714 * 0 - not recognized
4717 * 3 - permanently set
4718 * 4 - permanently reset
4720 Terminal
.prototype.requestAnsiMode = function(params
) {
4727 * Request DEC private mode (DECRQM). For VT300 and up, reply is
4729 * where Ps is the mode number as in DECSET, Pm is the mode value
4730 * as in the ANSI DECRQM.
4732 Terminal
.prototype.requestPrivateMode = function(params
) {
4739 * Set conformance level (DECSCL). Valid values for the first
4741 * Ps = 6 1 -> VT100.
4742 * Ps = 6 2 -> VT200.
4743 * Ps = 6 3 -> VT300.
4744 * Valid values for the second parameter:
4745 * Ps = 0 -> 8-bit controls.
4746 * Ps = 1 -> 7-bit controls (always set for VT100).
4747 * Ps = 2 -> 8-bit controls.
4749 Terminal
.prototype.setConformanceLevel = function(params
) {
4755 * CSI Ps q Load LEDs (DECLL).
4756 * Ps = 0 -> Clear all LEDS (default).
4757 * Ps = 1 -> Light Num Lock.
4758 * Ps = 2 -> Light Caps Lock.
4759 * Ps = 3 -> Light Scroll Lock.
4760 * Ps = 2 1 -> Extinguish Num Lock.
4761 * Ps = 2 2 -> Extinguish Caps Lock.
4762 * Ps = 2 3 -> Extinguish Scroll Lock.
4764 Terminal
.prototype.loadLEDs = function(params
) {
4771 * Set cursor style (DECSCUSR, VT520).
4772 * Ps = 0 -> blinking block.
4773 * Ps = 1 -> blinking block (default).
4774 * Ps = 2 -> steady block.
4775 * Ps = 3 -> blinking underline.
4776 * Ps = 4 -> steady underline.
4778 Terminal
.prototype.setCursorStyle = function(params
) {
4785 * Select character protection attribute (DECSCA). Valid values
4786 * for the parameter:
4787 * Ps = 0 -> DECSED and DECSEL can erase (default).
4788 * Ps = 1 -> DECSED and DECSEL cannot erase.
4789 * Ps = 2 -> DECSED and DECSEL can erase.
4791 Terminal
.prototype.setCharProtectionAttr = function(params
) {
4798 * Restore DEC Private Mode Values. The value of Ps previously
4799 * saved is restored. Ps values are the same as for DECSET.
4801 Terminal
.prototype.restorePrivateValues = function(params
) {
4807 * CSI Pt; Pl; Pb; Pr; Ps$ r
4808 * Change Attributes in Rectangular Area (DECCARA), VT400 and up.
4809 * Pt; Pl; Pb; Pr denotes the rectangle.
4810 * Ps denotes the SGR attributes to change: 0, 1, 4, 5, 7.
4811 * NOTE: xterm doesn't enable this code by default.
4813 Terminal
.prototype.setAttrInRectangle = function(params
) {
4823 for (; t
< b
+ 1; t
++) {
4824 line
= this.lines
.get(this.ybase
+ t
);
4825 for (i
= l
; i
< r
; i
++) {
4826 line
[i
] = [attr
, line
[i
][1]];
4831 this.updateRange(params
[0]);
4832 this.updateRange(params
[2]);
4837 * CSI Pc; Pt; Pl; Pb; Pr$ x
4838 * Fill Rectangular Area (DECFRA), VT420 and up.
4839 * Pc is the character to use.
4840 * Pt; Pl; Pb; Pr denotes the rectangle.
4841 * NOTE: xterm doesn't enable this code by default.
4843 Terminal
.prototype.fillRectangle = function(params
) {
4853 for (; t
< b
+ 1; t
++) {
4854 line
= this.lines
.get(this.ybase
+ t
);
4855 for (i
= l
; i
< r
; i
++) {
4856 line
[i
] = [line
[i
][0], String
.fromCharCode(ch
)];
4861 this.updateRange(params
[1]);
4862 this.updateRange(params
[3]);
4868 * Enable Locator Reporting (DECELR).
4869 * Valid values for the first parameter:
4870 * Ps = 0 -> Locator disabled (default).
4871 * Ps = 1 -> Locator enabled.
4872 * Ps = 2 -> Locator enabled for one report, then disabled.
4873 * The second parameter specifies the coordinate unit for locator
4875 * Valid values for the second parameter:
4876 * Pu = 0 <- or omitted -> default to character cells.
4877 * Pu = 1 <- device physical pixels.
4878 * Pu = 2 <- character cells.
4880 Terminal
.prototype.enableLocatorReporting = function(params
) {
4881 var val
= params
[0] > 0;
4882 //this.mouseEvents = val;
4883 //this.decLocator = val;
4888 * CSI Pt; Pl; Pb; Pr$ z
4889 * Erase Rectangular Area (DECERA), VT400 and up.
4890 * Pt; Pl; Pb; Pr denotes the rectangle.
4891 * NOTE: xterm doesn't enable this code by default.
4893 Terminal
.prototype.eraseRectangle = function(params
) {
4903 ch
= [this.eraseAttr(), ' ', 1]; // xterm?
4905 for (; t
< b
+ 1; t
++) {
4906 line
= this.lines
.get(this.ybase
+ t
);
4907 for (i
= l
; i
< r
; i
++) {
4913 this.updateRange(params
[0]);
4914 this.updateRange(params
[2]);
4920 * Insert P s Column(s) (default = 1) (DECIC), VT420 and up.
4921 * NOTE: xterm doesn't enable this code by default.
4923 Terminal
.prototype.insertColumns = function() {
4924 var param
= params
[0]
4925 , l
= this.ybase
+ this.rows
4926 , ch
= [this.eraseAttr(), ' ', 1] // xterm?
4930 for (i
= this.ybase
; i
< l
; i
++) {
4931 this.lines
.get(i
).splice(this.x
+ 1, 0, ch
);
4932 this.lines
.get(i
).pop();
4942 * Delete P s Column(s) (default = 1) (DECDC), VT420 and up
4943 * NOTE: xterm doesn't enable this code by default.
4945 Terminal
.prototype.deleteColumns = function() {
4946 var param
= params
[0]
4947 , l
= this.ybase
+ this.rows
4948 , ch
= [this.eraseAttr(), ' ', 1] // xterm?
4952 for (i
= this.ybase
; i
< l
; i
++) {
4953 this.lines
.get(i
).splice(this.x
, 1);
4954 this.lines
.get(i
).push(ch
);
4965 Terminal
.charsets
= {};
4967 // DEC Special Character and Line Drawing Set.
4968 // http://vt100.net/docs/vt102-ug/table5-13.html
4969 // A lot of curses apps use this if they see TERM=xterm.
4970 // testing: echo -e '\e(0a\e(B'
4971 // The xterm output sometimes seems to conflict with the
4972 // reference above. xterm seems in line with the reference
4973 // when running vttest however.
4974 // The table below now uses xterm's output from vttest.
4975 Terminal
.charsets
.SCLD
= { // (0
4976 '`': '\u25c6', // '◆'
4977 'a': '\u2592', // '▒'
4978 'b': '\u0009', // '\t'
4979 'c': '\u000c', // '\f'
4980 'd': '\u000d', // '\r'
4981 'e': '\u000a', // '\n'
4982 'f': '\u00b0', // '°'
4983 'g': '\u00b1', // '±'
4984 'h': '\u2424', // '\u2424' (NL)
4985 'i': '\u000b', // '\v'
4986 'j': '\u2518', // '┘'
4987 'k': '\u2510', // '┐'
4988 'l': '\u250c', // '┌'
4989 'm': '\u2514', // '└'
4990 'n': '\u253c', // '┼'
4991 'o': '\u23ba', // '⎺'
4992 'p': '\u23bb', // '⎻'
4993 'q': '\u2500', // '─'
4994 'r': '\u23bc', // '⎼'
4995 's': '\u23bd', // '⎽'
4996 't': '\u251c', // '├'
4997 'u': '\u2524', // '┤'
4998 'v': '\u2534', // '┴'
4999 'w': '\u252c', // '┬'
5000 'x': '\u2502', // '│'
5001 'y': '\u2264', // '≤'
5002 'z': '\u2265', // '≥'
5003 '{': '\u03c0', // 'π'
5004 '|': '\u2260', // '≠'
5005 '}': '\u00a3', // '£'
5006 '~': '\u00b7' // '·'
5009 Terminal
.charsets
.UK
= null; // (A
5010 Terminal
.charsets
.US
= null; // (B (USASCII)
5011 Terminal
.charsets
.Dutch
= null; // (4
5012 Terminal
.charsets
.Finnish
= null; // (C or (5
5013 Terminal
.charsets
.French
= null; // (R
5014 Terminal
.charsets
.FrenchCanadian
= null; // (Q
5015 Terminal
.charsets
.German
= null; // (K
5016 Terminal
.charsets
.Italian
= null; // (Y
5017 Terminal
.charsets
.NorwegianDanish
= null; // (E or (6
5018 Terminal
.charsets
.Spanish
= null; // (Z
5019 Terminal
.charsets
.Swedish
= null; // (H or (7
5020 Terminal
.charsets
.Swiss
= null; // (=
5021 Terminal
.charsets
.ISOLatin
= null; // /A
5027 function on(el
, type
, handler
, capture
) {
5028 if (!Array
.isArray(el
)) {
5031 el
.forEach(function (element
) {
5032 element
.addEventListener(type
, handler
, capture
|| false);
5036 function off(el
, type
, handler
, capture
) {
5037 el
.removeEventListener(type
, handler
, capture
|| false);
5040 function cancel(ev
, force
) {
5041 if (!this.cancelEvents
&& !force
) {
5044 ev
.preventDefault();
5045 ev
.stopPropagation();
5049 function inherits(child
, parent
) {
5051 this.constructor = child
;
5053 f
.prototype = parent
.prototype;
5054 child
.prototype = new f
;
5057 // if bold is broken, we can't
5058 // use it in the terminal.
5059 function isBoldBroken(document
) {
5060 var body
= document
.getElementsByTagName('body')[0];
5061 var el
= document
.createElement('span');
5062 el
.innerHTML
= 'hello world';
5063 body
.appendChild(el
);
5064 var w1
= el
.scrollWidth
;
5065 el
.style
.fontWeight
= 'bold';
5066 var w2
= el
.scrollWidth
;
5067 body
.removeChild(el
);
5071 function indexOf(obj
, el
) {
5074 if (obj
[i
] === el
) return i
;
5079 function isThirdLevelShift(term
, ev
) {
5081 (term
.browser
.isMac
&& ev
.altKey
&& !ev
.ctrlKey
&& !ev
.metaKey
) ||
5082 (term
.browser
.isMSWindows
&& ev
.altKey
&& ev
.ctrlKey
&& !ev
.metaKey
);
5084 if (ev
.type
== 'keypress') {
5085 return thirdLevelKey
;
5088 // Don't invoke for arrows, pageDown, home, backspace, etc. (on non-keypress events)
5089 return thirdLevelKey
&& (!ev
.keyCode
|| ev
.keyCode
> 47);
5092 function matchColor(r1
, g1
, b1
) {
5093 var hash
= (r1
<< 16) | (g1
<< 8) | b1
;
5095 if (matchColor
._cache
[hash
] != null) {
5096 return matchColor
._cache
[hash
];
5099 var ldiff
= Infinity
5108 for (; i
< Terminal
.vcolors
.length
; i
++) {
5109 c
= Terminal
.vcolors
[i
];
5114 diff
= matchColor
.distance(r1
, g1
, b1
, r2
, g2
, b2
);
5127 return matchColor
._cache
[hash
] = li
;
5130 matchColor
._cache
= {};
5132 // http://stackoverflow.com/questions/1633828
5133 matchColor
.distance = function(r1
, g1
, b1
, r2
, g2
, b2
) {
5134 return Math
.pow(30 * (r1
- r2
), 2)
5135 + Math
.pow(59 * (g1
- g2
), 2)
5136 + Math
.pow(11 * (b1
- b2
), 2);
5139 function each(obj
, iter
, con
) {
5140 if (obj
.forEach
) return obj
.forEach(iter
, con
);
5141 for (var i
= 0; i
< obj
.length
; i
++) {
5142 iter
.call(con
, obj
[i
], i
, obj
);
5146 function keys(obj
) {
5147 if (Object
.keys
) return Object
.keys(obj
);
5150 if (Object
.prototype.hasOwnProperty
.call(obj
, key
)) {
5157 var wcwidth
= (function(opts
) {
5158 // extracted from https://www.cl.cam.ac.uk/%7Emgk25/ucs/wcwidth.c
5159 // combining characters
5161 [0x0300, 0x036F], [0x0483, 0x0486], [0x0488, 0x0489],
5162 [0x0591, 0x05BD], [0x05BF, 0x05BF], [0x05C1, 0x05C2],
5163 [0x05C4, 0x05C5], [0x05C7, 0x05C7], [0x0600, 0x0603],
5164 [0x0610, 0x0615], [0x064B, 0x065E], [0x0670, 0x0670],
5165 [0x06D6, 0x06E4], [0x06E7, 0x06E8], [0x06EA, 0x06ED],
5166 [0x070F, 0x070F], [0x0711, 0x0711], [0x0730, 0x074A],
5167 [0x07A6, 0x07B0], [0x07EB, 0x07F3], [0x0901, 0x0902],
5168 [0x093C, 0x093C], [0x0941, 0x0948], [0x094D, 0x094D],
5169 [0x0951, 0x0954], [0x0962, 0x0963], [0x0981, 0x0981],
5170 [0x09BC, 0x09BC], [0x09C1, 0x09C4], [0x09CD, 0x09CD],
5171 [0x09E2, 0x09E3], [0x0A01, 0x0A02], [0x0A3C, 0x0A3C],
5172 [0x0A41, 0x0A42], [0x0A47, 0x0A48], [0x0A4B, 0x0A4D],
5173 [0x0A70, 0x0A71], [0x0A81, 0x0A82], [0x0ABC, 0x0ABC],
5174 [0x0AC1, 0x0AC5], [0x0AC7, 0x0AC8], [0x0ACD, 0x0ACD],
5175 [0x0AE2, 0x0AE3], [0x0B01, 0x0B01], [0x0B3C, 0x0B3C],
5176 [0x0B3F, 0x0B3F], [0x0B41, 0x0B43], [0x0B4D, 0x0B4D],
5177 [0x0B56, 0x0B56], [0x0B82, 0x0B82], [0x0BC0, 0x0BC0],
5178 [0x0BCD, 0x0BCD], [0x0C3E, 0x0C40], [0x0C46, 0x0C48],
5179 [0x0C4A, 0x0C4D], [0x0C55, 0x0C56], [0x0CBC, 0x0CBC],
5180 [0x0CBF, 0x0CBF], [0x0CC6, 0x0CC6], [0x0CCC, 0x0CCD],
5181 [0x0CE2, 0x0CE3], [0x0D41, 0x0D43], [0x0D4D, 0x0D4D],
5182 [0x0DCA, 0x0DCA], [0x0DD2, 0x0DD4], [0x0DD6, 0x0DD6],
5183 [0x0E31, 0x0E31], [0x0E34, 0x0E3A], [0x0E47, 0x0E4E],
5184 [0x0EB1, 0x0EB1], [0x0EB4, 0x0EB9], [0x0EBB, 0x0EBC],
5185 [0x0EC8, 0x0ECD], [0x0F18, 0x0F19], [0x0F35, 0x0F35],
5186 [0x0F37, 0x0F37], [0x0F39, 0x0F39], [0x0F71, 0x0F7E],
5187 [0x0F80, 0x0F84], [0x0F86, 0x0F87], [0x0F90, 0x0F97],
5188 [0x0F99, 0x0FBC], [0x0FC6, 0x0FC6], [0x102D, 0x1030],
5189 [0x1032, 0x1032], [0x1036, 0x1037], [0x1039, 0x1039],
5190 [0x1058, 0x1059], [0x1160, 0x11FF], [0x135F, 0x135F],
5191 [0x1712, 0x1714], [0x1732, 0x1734], [0x1752, 0x1753],
5192 [0x1772, 0x1773], [0x17B4, 0x17B5], [0x17B7, 0x17BD],
5193 [0x17C6, 0x17C6], [0x17C9, 0x17D3], [0x17DD, 0x17DD],
5194 [0x180B, 0x180D], [0x18A9, 0x18A9], [0x1920, 0x1922],
5195 [0x1927, 0x1928], [0x1932, 0x1932], [0x1939, 0x193B],
5196 [0x1A17, 0x1A18], [0x1B00, 0x1B03], [0x1B34, 0x1B34],
5197 [0x1B36, 0x1B3A], [0x1B3C, 0x1B3C], [0x1B42, 0x1B42],
5198 [0x1B6B, 0x1B73], [0x1DC0, 0x1DCA], [0x1DFE, 0x1DFF],
5199 [0x200B, 0x200F], [0x202A, 0x202E], [0x2060, 0x2063],
5200 [0x206A, 0x206F], [0x20D0, 0x20EF], [0x302A, 0x302F],
5201 [0x3099, 0x309A], [0xA806, 0xA806], [0xA80B, 0xA80B],
5202 [0xA825, 0xA826], [0xFB1E, 0xFB1E], [0xFE00, 0xFE0F],
5203 [0xFE20, 0xFE23], [0xFEFF, 0xFEFF], [0xFFF9, 0xFFFB],
5204 [0x10A01, 0x10A03], [0x10A05, 0x10A06], [0x10A0C, 0x10A0F],
5205 [0x10A38, 0x10A3A], [0x10A3F, 0x10A3F], [0x1D167, 0x1D169],
5206 [0x1D173, 0x1D182], [0x1D185, 0x1D18B], [0x1D1AA, 0x1D1AD],
5207 [0x1D242, 0x1D244], [0xE0001, 0xE0001], [0xE0020, 0xE007F],
5211 function bisearch(ucs
) {
5213 var max
= COMBINING
.length
- 1;
5215 if (ucs
< COMBINING
[0][0] || ucs
> COMBINING
[max
][1])
5217 while (max
>= min
) {
5218 mid
= Math
.floor((min
+ max
) / 2);
5219 if (ucs
> COMBINING
[mid
][1])
5221 else if (ucs
< COMBINING
[mid
][0])
5228 function wcwidth(ucs
) {
5229 // test for 8-bit control characters
5232 if (ucs
< 32 || (ucs
>= 0x7f && ucs
< 0xa0))
5233 return opts
.control
;
5234 // binary search in table of non-spacing characters
5237 // if we arrive here, ucs is not a combining or C0/C1 control character
5242 ucs
<= 0x115f || // Hangul Jamo init. consonants
5245 (ucs
>= 0x2e80 && ucs
<= 0xa4cf && ucs
!= 0x303f) || // CJK..Yi
5246 (ucs
>= 0xac00 && ucs
<= 0xd7a3) || // Hangul Syllables
5247 (ucs
>= 0xf900 && ucs
<= 0xfaff) || // CJK Compat Ideographs
5248 (ucs
>= 0xfe10 && ucs
<= 0xfe19) || // Vertical forms
5249 (ucs
>= 0xfe30 && ucs
<= 0xfe6f) || // CJK Compat Forms
5250 (ucs
>= 0xff00 && ucs
<= 0xff60) || // Fullwidth Forms
5251 (ucs
>= 0xffe0 && ucs
<= 0xffe6) ||
5252 (ucs
>= 0x20000 && ucs
<= 0x2fffd) ||
5253 (ucs
>= 0x30000 && ucs
<= 0x3fffd)
5258 })({nul
: 0, control
: 0}); // configurable options
5264 Terminal
.EventEmitter
= EventEmitter
;
5265 Terminal
.inherits
= inherits
;
5268 * Adds an event listener to the terminal.
5270 * @param {string} event The name of the event. TODO: Document all event types
5271 * @param {function} callback The function to call when the event is triggered.
5275 Terminal
.cancel
= cancel
;
5277 module
.exports
= Terminal
;