]> git.proxmox.com Git - mirror_xterm.js.git/blob - src/xterm.js
Merge remote-tracking branch 'upstream/master' into 361_circular_list_scrollback
[mirror_xterm.js.git] / src / xterm.js
1 /**
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
9 * other features.
10 * @license MIT
11 */
12
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 * as Browser from './utils/Browser';
19 import * as Keyboard from './utils/Keyboard';
20
21 /**
22 * Terminal Emulation References:
23 * http://vt100.net/
24 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.txt
25 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
26 * http://invisible-island.net/vttest/
27 * http://www.inwap.com/pdp10/ansicode.txt
28 * http://linux.die.net/man/4/console_codes
29 * http://linux.die.net/man/7/urxvt
30 */
31
32 // Let it work inside Node.js for automated testing purposes.
33 var document = (typeof window != 'undefined') ? window.document : null;
34
35 /**
36 * States
37 */
38 var normal = 0, escaped = 1, csi = 2, osc = 3, charset = 4, dcs = 5, ignore = 6;
39
40 /**
41 * Terminal
42 */
43
44 /**
45 * Creates a new `Terminal` object.
46 *
47 * @param {object} options An object containing a set of options, the available options are:
48 * - `cursorBlink` (boolean): Whether the terminal cursor blinks
49 * - `cols` (number): The number of columns of the terminal (horizontal size)
50 * - `rows` (number): The number of rows of the terminal (vertical size)
51 *
52 * @public
53 * @class Xterm Xterm
54 * @alias module:xterm/src/xterm
55 */
56 function Terminal(options) {
57 var self = this;
58
59 if (!(this instanceof Terminal)) {
60 return new Terminal(arguments[0], arguments[1], arguments[2]);
61 }
62
63 self.browser = Browser;
64 self.cancel = Terminal.cancel;
65
66 EventEmitter.call(this);
67
68 if (typeof options === 'number') {
69 options = {
70 cols: arguments[0],
71 rows: arguments[1],
72 handler: arguments[2]
73 };
74 }
75
76 options = options || {};
77
78
79 Object.keys(Terminal.defaults).forEach(function(key) {
80 if (options[key] == null) {
81 options[key] = Terminal.options[key];
82
83 if (Terminal[key] !== Terminal.defaults[key]) {
84 options[key] = Terminal[key];
85 }
86 }
87 self[key] = options[key];
88 });
89
90 if (options.colors.length === 8) {
91 options.colors = options.colors.concat(Terminal._colors.slice(8));
92 } else if (options.colors.length === 16) {
93 options.colors = options.colors.concat(Terminal._colors.slice(16));
94 } else if (options.colors.length === 10) {
95 options.colors = options.colors.slice(0, -2).concat(
96 Terminal._colors.slice(8, -2), options.colors.slice(-2));
97 } else if (options.colors.length === 18) {
98 options.colors = options.colors.concat(
99 Terminal._colors.slice(16, -2), options.colors.slice(-2));
100 }
101 this.colors = options.colors;
102
103 this.options = options;
104
105 // this.context = options.context || window;
106 // this.document = options.document || document;
107 this.parent = options.body || options.parent || (
108 document ? document.getElementsByTagName('body')[0] : null
109 );
110
111 this.cols = options.cols || options.geometry[0];
112 this.rows = options.rows || options.geometry[1];
113 this.geometry = [this.cols, this.rows];
114
115 if (options.handler) {
116 this.on('data', options.handler);
117 }
118
119 /**
120 * The scroll position of the y cursor, ie. ybase + y = the y position within the entire
121 * buffer
122 */
123 this.ybase = 0;
124
125 /**
126 * The scroll position of the viewport
127 */
128 this.ydisp = 0;
129
130 /**
131 * The cursor's x position after ybase
132 */
133 this.x = 0;
134
135 /**
136 * The cursor's y position after ybase
137 */
138 this.y = 0;
139
140 /**
141 * Used to debounce the refresh function
142 */
143 this.isRefreshing = false;
144
145 /**
146 * Whether there is a full terminal refresh queued
147 */
148
149 this.cursorState = 0;
150 this.cursorHidden = false;
151 this.convertEol;
152 this.state = 0;
153 this.queue = '';
154 this.scrollTop = 0;
155 this.scrollBottom = this.rows - 1;
156 this.customKeydownHandler = null;
157
158 // modes
159 this.applicationKeypad = false;
160 this.applicationCursor = false;
161 this.originMode = false;
162 this.insertMode = false;
163 this.wraparoundMode = true; // defaults: xterm - true, vt100 - false
164 this.normal = null;
165
166 // charset
167 this.charset = null;
168 this.gcharset = null;
169 this.glevel = 0;
170 this.charsets = [null];
171
172 // mouse properties
173 this.decLocator;
174 this.x10Mouse;
175 this.vt200Mouse;
176 this.vt300Mouse;
177 this.normalMouse;
178 this.mouseEvents;
179 this.sendFocus;
180 this.utfMouse;
181 this.sgrMouse;
182 this.urxvtMouse;
183
184 // misc
185 this.element;
186 this.children;
187 this.refreshStart;
188 this.refreshEnd;
189 this.savedX;
190 this.savedY;
191 this.savedCols;
192
193 // stream
194 this.readable = true;
195 this.writable = true;
196
197 this.defAttr = (0 << 18) | (257 << 9) | (256 << 0);
198 this.curAttr = this.defAttr;
199
200 this.params = [];
201 this.currentParam = 0;
202 this.prefix = '';
203 this.postfix = '';
204
205 // leftover surrogate high from previous write invocation
206 this.surrogate_high = '';
207
208 /**
209 * An array of all lines in the entire buffer, including the prompt. The lines are array of
210 * characters which are 2-length arrays where [0] is an attribute and [1] is the character.
211 */
212 this.lines = new CircularList(this.scrollback);
213 var i = this.rows;
214 while (i--) {
215 this.lines.push(this.blankLine());
216 }
217
218 this.tabs;
219 this.setupStops();
220
221 // Store if user went browsing history in scrollback
222 this.userScrolling = false;
223 }
224
225 inherits(Terminal, EventEmitter);
226
227 /**
228 * back_color_erase feature for xterm.
229 */
230 Terminal.prototype.eraseAttr = function() {
231 // if (this.is('screen')) return this.defAttr;
232 return (this.defAttr & ~0x1ff) | (this.curAttr & 0x1ff);
233 };
234
235 /**
236 * Colors
237 */
238
239 // Colors 0-15
240 Terminal.tangoColors = [
241 // dark:
242 '#2e3436',
243 '#cc0000',
244 '#4e9a06',
245 '#c4a000',
246 '#3465a4',
247 '#75507b',
248 '#06989a',
249 '#d3d7cf',
250 // bright:
251 '#555753',
252 '#ef2929',
253 '#8ae234',
254 '#fce94f',
255 '#729fcf',
256 '#ad7fa8',
257 '#34e2e2',
258 '#eeeeec'
259 ];
260
261 // Colors 0-15 + 16-255
262 // Much thanks to TooTallNate for writing this.
263 Terminal.colors = (function() {
264 var colors = Terminal.tangoColors.slice()
265 , r = [0x00, 0x5f, 0x87, 0xaf, 0xd7, 0xff]
266 , i;
267
268 // 16-231
269 i = 0;
270 for (; i < 216; i++) {
271 out(r[(i / 36) % 6 | 0], r[(i / 6) % 6 | 0], r[i % 6]);
272 }
273
274 // 232-255 (grey)
275 i = 0;
276 for (; i < 24; i++) {
277 r = 8 + i * 10;
278 out(r, r, r);
279 }
280
281 function out(r, g, b) {
282 colors.push('#' + hex(r) + hex(g) + hex(b));
283 }
284
285 function hex(c) {
286 c = c.toString(16);
287 return c.length < 2 ? '0' + c : c;
288 }
289
290 return colors;
291 })();
292
293 Terminal._colors = Terminal.colors.slice();
294
295 Terminal.vcolors = (function() {
296 var out = []
297 , colors = Terminal.colors
298 , i = 0
299 , color;
300
301 for (; i < 256; i++) {
302 color = parseInt(colors[i].substring(1), 16);
303 out.push([
304 (color >> 16) & 0xff,
305 (color >> 8) & 0xff,
306 color & 0xff
307 ]);
308 }
309
310 return out;
311 })();
312
313 /**
314 * Options
315 */
316
317 Terminal.defaults = {
318 colors: Terminal.colors,
319 theme: 'default',
320 convertEol: false,
321 termName: 'xterm',
322 geometry: [80, 24],
323 cursorBlink: false,
324 visualBell: false,
325 popOnBell: false,
326 scrollback: 1000,
327 screenKeys: false,
328 debug: false,
329 cancelEvents: false
330 // programFeatures: false,
331 // focusKeys: false,
332 };
333
334 Terminal.options = {};
335
336 Terminal.focus = null;
337
338 each(keys(Terminal.defaults), function(key) {
339 Terminal[key] = Terminal.defaults[key];
340 Terminal.options[key] = Terminal.defaults[key];
341 });
342
343 /**
344 * Focus the terminal. Delegates focus handling to the terminal's DOM element.
345 */
346 Terminal.prototype.focus = function() {
347 return this.textarea.focus();
348 };
349
350 /**
351 * Retrieves an option's value from the terminal.
352 * @param {string} key The option key.
353 */
354 Terminal.prototype.getOption = function(key, value) {
355 if (!(key in Terminal.defaults)) {
356 throw new Error('No option with key "' + key + '"');
357 }
358
359 if (typeof this.options[key] !== 'undefined') {
360 return this.options[key];
361 }
362
363 return this[key];
364 };
365
366 /**
367 * Sets an option on the terminal.
368 * @param {string} key The option key.
369 * @param {string} value The option value.
370 */
371 Terminal.prototype.setOption = function(key, value) {
372 if (!(key in Terminal.defaults)) {
373 throw new Error('No option with key "' + key + '"');
374 }
375 this[key] = value;
376 this.options[key] = value;
377 };
378
379 /**
380 * Binds the desired focus behavior on a given terminal object.
381 *
382 * @static
383 */
384 Terminal.bindFocus = function (term) {
385 on(term.textarea, 'focus', function (ev) {
386 if (term.sendFocus) {
387 term.send('\x1b[I');
388 }
389 term.element.classList.add('focus');
390 term.showCursor();
391 Terminal.focus = term;
392 term.emit('focus', {terminal: term});
393 });
394 };
395
396 /**
397 * Blur the terminal. Delegates blur handling to the terminal's DOM element.
398 */
399 Terminal.prototype.blur = function() {
400 return this.textarea.blur();
401 };
402
403 /**
404 * Binds the desired blur behavior on a given terminal object.
405 *
406 * @static
407 */
408 Terminal.bindBlur = function (term) {
409 on(term.textarea, 'blur', function (ev) {
410 term.refresh(term.y, term.y);
411 if (term.sendFocus) {
412 term.send('\x1b[O');
413 }
414 term.element.classList.remove('focus');
415 Terminal.focus = null;
416 term.emit('blur', {terminal: term});
417 });
418 };
419
420 /**
421 * Initialize default behavior
422 */
423 Terminal.prototype.initGlobal = function() {
424 var term = this;
425
426 Terminal.bindKeys(this);
427 Terminal.bindFocus(this);
428 Terminal.bindBlur(this);
429
430 // Bind clipboard functionality
431 on(this.element, 'copy', function (ev) {
432 copyHandler.call(this, ev, term);
433 });
434 on(this.textarea, 'paste', function (ev) {
435 pasteHandler.call(this, ev, term);
436 });
437
438 function rightClickHandlerWrapper (ev) {
439 rightClickHandler.call(this, ev, term);
440 }
441
442 if (term.browser.isFirefox) {
443 on(this.element, 'mousedown', function (ev) {
444 if (ev.button == 2) {
445 rightClickHandlerWrapper(ev);
446 }
447 });
448 } else {
449 on(this.element, 'contextmenu', rightClickHandlerWrapper);
450 }
451 };
452
453 /**
454 * Apply key handling to the terminal
455 */
456 Terminal.bindKeys = function(term) {
457 on(term.element, 'keydown', function(ev) {
458 if (document.activeElement != this) {
459 return;
460 }
461 term.keyDown(ev);
462 }, true);
463
464 on(term.element, 'keypress', function(ev) {
465 if (document.activeElement != this) {
466 return;
467 }
468 term.keyPress(ev);
469 }, true);
470
471 on(term.element, 'keyup', term.focus.bind(term));
472
473 on(term.textarea, 'keydown', function(ev) {
474 term.keyDown(ev);
475 }, true);
476
477 on(term.textarea, 'keypress', function(ev) {
478 term.keyPress(ev);
479 // Truncate the textarea's value, since it is not needed
480 this.value = '';
481 }, true);
482
483 on(term.textarea, 'compositionstart', term.compositionHelper.compositionstart.bind(term.compositionHelper));
484 on(term.textarea, 'compositionupdate', term.compositionHelper.compositionupdate.bind(term.compositionHelper));
485 on(term.textarea, 'compositionend', term.compositionHelper.compositionend.bind(term.compositionHelper));
486 term.on('refresh', term.compositionHelper.updateCompositionElements.bind(term.compositionHelper));
487 };
488
489
490 /**
491 * Insert the given row to the terminal or produce a new one
492 * if no row argument is passed. Return the inserted row.
493 * @param {HTMLElement} row (optional) The row to append to the terminal.
494 */
495 Terminal.prototype.insertRow = function (row) {
496 if (typeof row != 'object') {
497 row = document.createElement('div');
498 }
499
500 this.rowContainer.appendChild(row);
501 this.children.push(row);
502
503 return row;
504 };
505
506 /**
507 * Opens the terminal within an element.
508 *
509 * @param {HTMLElement} parent The element to create the terminal within.
510 */
511 Terminal.prototype.open = function(parent) {
512 var self=this, i=0, div;
513
514 this.parent = parent || this.parent;
515
516 if (!this.parent) {
517 throw new Error('Terminal requires a parent element.');
518 }
519
520 // Grab global elements
521 this.context = this.parent.ownerDocument.defaultView;
522 this.document = this.parent.ownerDocument;
523 this.body = this.document.getElementsByTagName('body')[0];
524
525 //Create main element container
526 this.element = this.document.createElement('div');
527 this.element.classList.add('terminal');
528 this.element.classList.add('xterm');
529 this.element.classList.add('xterm-theme-' + this.theme);
530
531 this.element.style.height
532 this.element.setAttribute('tabindex', 0);
533
534 this.viewportElement = document.createElement('div');
535 this.viewportElement.classList.add('xterm-viewport');
536 this.element.appendChild(this.viewportElement);
537 this.viewportScrollArea = document.createElement('div');
538 this.viewportScrollArea.classList.add('xterm-scroll-area');
539 this.viewportElement.appendChild(this.viewportScrollArea);
540
541 // Create the container that will hold the lines of the terminal and then
542 // produce the lines the lines.
543 this.rowContainer = document.createElement('div');
544 this.rowContainer.classList.add('xterm-rows');
545 this.element.appendChild(this.rowContainer);
546 this.children = [];
547
548 // Create the container that will hold helpers like the textarea for
549 // capturing DOM Events. Then produce the helpers.
550 this.helperContainer = document.createElement('div');
551 this.helperContainer.classList.add('xterm-helpers');
552 // TODO: This should probably be inserted once it's filled to prevent an additional layout
553 this.element.appendChild(this.helperContainer);
554 this.textarea = document.createElement('textarea');
555 this.textarea.classList.add('xterm-helper-textarea');
556 this.textarea.setAttribute('autocorrect', 'off');
557 this.textarea.setAttribute('autocapitalize', 'off');
558 this.textarea.setAttribute('spellcheck', 'false');
559 this.textarea.tabIndex = 0;
560 this.textarea.addEventListener('focus', function() {
561 self.emit('focus', {terminal: self});
562 });
563 this.textarea.addEventListener('blur', function() {
564 self.emit('blur', {terminal: self});
565 });
566 this.helperContainer.appendChild(this.textarea);
567
568 this.compositionView = document.createElement('div');
569 this.compositionView.classList.add('composition-view');
570 this.compositionHelper = new CompositionHelper(this.textarea, this.compositionView, this);
571 this.helperContainer.appendChild(this.compositionView);
572
573 this.charMeasureElement = document.createElement('div');
574 this.charMeasureElement.classList.add('xterm-char-measure-element');
575 this.charMeasureElement.innerHTML = 'W';
576 this.helperContainer.appendChild(this.charMeasureElement);
577
578 for (; i < this.rows; i++) {
579 this.insertRow();
580 }
581 this.parent.appendChild(this.element);
582
583 this.viewport = new Viewport(this, this.viewportElement, this.viewportScrollArea, this.charMeasureElement);
584
585 // Draw the screen.
586 this.refresh(0, this.rows - 1);
587
588 // Initialize global actions that
589 // need to be taken on the document.
590 this.initGlobal();
591
592 // Ensure there is a Terminal.focus.
593 this.focus();
594
595 on(this.element, 'click', function() {
596 var selection = document.getSelection(),
597 collapsed = selection.isCollapsed,
598 isRange = typeof collapsed == 'boolean' ? !collapsed : selection.type == 'Range';
599 if (!isRange) {
600 self.focus();
601 }
602 });
603
604 // Listen for mouse events and translate
605 // them into terminal mouse protocols.
606 this.bindMouse();
607
608 // Figure out whether boldness affects
609 // the character width of monospace fonts.
610 if (Terminal.brokenBold == null) {
611 Terminal.brokenBold = isBoldBroken(this.document);
612 }
613
614 /**
615 * This event is emitted when terminal has completed opening.
616 *
617 * @event open
618 */
619 this.emit('open');
620 };
621
622
623 /**
624 * Attempts to load an add-on using CommonJS or RequireJS (whichever is available).
625 * @param {string} addon The name of the addon to load
626 * @static
627 */
628 Terminal.loadAddon = function(addon, callback) {
629 if (typeof exports === 'object' && typeof module === 'object') {
630 // CommonJS
631 return require('./addons/' + addon + '/' + addon);
632 } else if (typeof define == 'function') {
633 // RequireJS
634 return require(['./addons/' + addon + '/' + addon], callback);
635 } else {
636 console.error('Cannot load a module without a CommonJS or RequireJS environment.');
637 return false;
638 }
639 };
640
641
642 /**
643 * XTerm mouse events
644 * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#Mouse%20Tracking
645 * To better understand these
646 * the xterm code is very helpful:
647 * Relevant files:
648 * button.c, charproc.c, misc.c
649 * Relevant functions in xterm/button.c:
650 * BtnCode, EmitButtonCode, EditorButton, SendMousePosition
651 */
652 Terminal.prototype.bindMouse = function() {
653 var el = this.element, self = this, pressed = 32;
654
655 // mouseup, mousedown, wheel
656 // left click: ^[[M 3<^[[M#3<
657 // wheel up: ^[[M`3>
658 function sendButton(ev) {
659 var button
660 , pos;
661
662 // get the xterm-style button
663 button = getButton(ev);
664
665 // get mouse coordinates
666 pos = getCoords(ev);
667 if (!pos) return;
668
669 sendEvent(button, pos);
670
671 switch (ev.overrideType || ev.type) {
672 case 'mousedown':
673 pressed = button;
674 break;
675 case 'mouseup':
676 // keep it at the left
677 // button, just in case.
678 pressed = 32;
679 break;
680 case 'wheel':
681 // nothing. don't
682 // interfere with
683 // `pressed`.
684 break;
685 }
686 }
687
688 // motion example of a left click:
689 // ^[[M 3<^[[M@4<^[[M@5<^[[M@6<^[[M@7<^[[M#7<
690 function sendMove(ev) {
691 var button = pressed
692 , pos;
693
694 pos = getCoords(ev);
695 if (!pos) return;
696
697 // buttons marked as motions
698 // are incremented by 32
699 button += 32;
700
701 sendEvent(button, pos);
702 }
703
704 // encode button and
705 // position to characters
706 function encode(data, ch) {
707 if (!self.utfMouse) {
708 if (ch === 255) return data.push(0);
709 if (ch > 127) ch = 127;
710 data.push(ch);
711 } else {
712 if (ch === 2047) return data.push(0);
713 if (ch < 127) {
714 data.push(ch);
715 } else {
716 if (ch > 2047) ch = 2047;
717 data.push(0xC0 | (ch >> 6));
718 data.push(0x80 | (ch & 0x3F));
719 }
720 }
721 }
722
723 // send a mouse event:
724 // regular/utf8: ^[[M Cb Cx Cy
725 // urxvt: ^[[ Cb ; Cx ; Cy M
726 // sgr: ^[[ Cb ; Cx ; Cy M/m
727 // vt300: ^[[ 24(1/3/5)~ [ Cx , Cy ] \r
728 // locator: CSI P e ; P b ; P r ; P c ; P p & w
729 function sendEvent(button, pos) {
730 // self.emit('mouse', {
731 // x: pos.x - 32,
732 // y: pos.x - 32,
733 // button: button
734 // });
735
736 if (self.vt300Mouse) {
737 // NOTE: Unstable.
738 // http://www.vt100.net/docs/vt3xx-gp/chapter15.html
739 button &= 3;
740 pos.x -= 32;
741 pos.y -= 32;
742 var data = '\x1b[24';
743 if (button === 0) data += '1';
744 else if (button === 1) data += '3';
745 else if (button === 2) data += '5';
746 else if (button === 3) return;
747 else data += '0';
748 data += '~[' + pos.x + ',' + pos.y + ']\r';
749 self.send(data);
750 return;
751 }
752
753 if (self.decLocator) {
754 // NOTE: Unstable.
755 button &= 3;
756 pos.x -= 32;
757 pos.y -= 32;
758 if (button === 0) button = 2;
759 else if (button === 1) button = 4;
760 else if (button === 2) button = 6;
761 else if (button === 3) button = 3;
762 self.send('\x1b['
763 + button
764 + ';'
765 + (button === 3 ? 4 : 0)
766 + ';'
767 + pos.y
768 + ';'
769 + pos.x
770 + ';'
771 + (pos.page || 0)
772 + '&w');
773 return;
774 }
775
776 if (self.urxvtMouse) {
777 pos.x -= 32;
778 pos.y -= 32;
779 pos.x++;
780 pos.y++;
781 self.send('\x1b[' + button + ';' + pos.x + ';' + pos.y + 'M');
782 return;
783 }
784
785 if (self.sgrMouse) {
786 pos.x -= 32;
787 pos.y -= 32;
788 self.send('\x1b[<'
789 + (((button & 3) === 3 ? button & ~3 : button) - 32)
790 + ';'
791 + pos.x
792 + ';'
793 + pos.y
794 + ((button & 3) === 3 ? 'm' : 'M'));
795 return;
796 }
797
798 var data = [];
799
800 encode(data, button);
801 encode(data, pos.x);
802 encode(data, pos.y);
803
804 self.send('\x1b[M' + String.fromCharCode.apply(String, data));
805 }
806
807 function getButton(ev) {
808 var button
809 , shift
810 , meta
811 , ctrl
812 , mod;
813
814 // two low bits:
815 // 0 = left
816 // 1 = middle
817 // 2 = right
818 // 3 = release
819 // wheel up/down:
820 // 1, and 2 - with 64 added
821 switch (ev.overrideType || ev.type) {
822 case 'mousedown':
823 button = ev.button != null
824 ? +ev.button
825 : ev.which != null
826 ? ev.which - 1
827 : null;
828
829 if (self.browser.isMSIE) {
830 button = button === 1 ? 0 : button === 4 ? 1 : button;
831 }
832 break;
833 case 'mouseup':
834 button = 3;
835 break;
836 case 'DOMMouseScroll':
837 button = ev.detail < 0
838 ? 64
839 : 65;
840 break;
841 case 'wheel':
842 button = ev.wheelDeltaY > 0
843 ? 64
844 : 65;
845 break;
846 }
847
848 // next three bits are the modifiers:
849 // 4 = shift, 8 = meta, 16 = control
850 shift = ev.shiftKey ? 4 : 0;
851 meta = ev.metaKey ? 8 : 0;
852 ctrl = ev.ctrlKey ? 16 : 0;
853 mod = shift | meta | ctrl;
854
855 // no mods
856 if (self.vt200Mouse) {
857 // ctrl only
858 mod &= ctrl;
859 } else if (!self.normalMouse) {
860 mod = 0;
861 }
862
863 // increment to SP
864 button = (32 + (mod << 2)) + button;
865
866 return button;
867 }
868
869 // mouse coordinates measured in cols/rows
870 function getCoords(ev) {
871 var x, y, w, h, el;
872
873 // ignore browsers without pageX for now
874 if (ev.pageX == null) return;
875
876 x = ev.pageX;
877 y = ev.pageY;
878 el = self.element;
879
880 // should probably check offsetParent
881 // but this is more portable
882 while (el && el !== self.document.documentElement) {
883 x -= el.offsetLeft;
884 y -= el.offsetTop;
885 el = 'offsetParent' in el
886 ? el.offsetParent
887 : el.parentNode;
888 }
889
890 // convert to cols/rows
891 w = self.element.clientWidth;
892 h = self.element.clientHeight;
893 x = Math.ceil((x / w) * self.cols);
894 y = Math.ceil((y / h) * self.rows);
895
896 // be sure to avoid sending
897 // bad positions to the program
898 if (x < 0) x = 0;
899 if (x > self.cols) x = self.cols;
900 if (y < 0) y = 0;
901 if (y > self.rows) y = self.rows;
902
903 // xterm sends raw bytes and
904 // starts at 32 (SP) for each.
905 x += 32;
906 y += 32;
907
908 return {
909 x: x,
910 y: y,
911 type: 'wheel'
912 };
913 }
914
915 on(el, 'mousedown', function(ev) {
916 if (!self.mouseEvents) return;
917
918 // send the button
919 sendButton(ev);
920
921 // ensure focus
922 self.focus();
923
924 // fix for odd bug
925 //if (self.vt200Mouse && !self.normalMouse) {
926 if (self.vt200Mouse) {
927 ev.overrideType = 'mouseup';
928 sendButton(ev);
929 return self.cancel(ev);
930 }
931
932 // bind events
933 if (self.normalMouse) on(self.document, 'mousemove', sendMove);
934
935 // x10 compatibility mode can't send button releases
936 if (!self.x10Mouse) {
937 on(self.document, 'mouseup', function up(ev) {
938 sendButton(ev);
939 if (self.normalMouse) off(self.document, 'mousemove', sendMove);
940 off(self.document, 'mouseup', up);
941 return self.cancel(ev);
942 });
943 }
944
945 return self.cancel(ev);
946 });
947
948 //if (self.normalMouse) {
949 // on(self.document, 'mousemove', sendMove);
950 //}
951
952 on(el, 'wheel', function(ev) {
953 if (!self.mouseEvents) return;
954 if (self.x10Mouse
955 || self.vt300Mouse
956 || self.decLocator) return;
957 sendButton(ev);
958 return self.cancel(ev);
959 });
960
961 // allow wheel scrolling in
962 // the shell for example
963 on(el, 'wheel', function(ev) {
964 if (self.mouseEvents) return;
965 self.viewport.onWheel(ev);
966 return self.cancel(ev);
967 });
968 };
969
970 /**
971 * Destroys the terminal.
972 */
973 Terminal.prototype.destroy = function() {
974 this.readable = false;
975 this.writable = false;
976 this._events = {};
977 this.handler = function() {};
978 this.write = function() {};
979 if (this.element.parentNode) {
980 this.element.parentNode.removeChild(this.element);
981 }
982 //this.emit('close');
983 };
984
985
986 /**
987 * Flags used to render terminal text properly
988 */
989 Terminal.flags = {
990 BOLD: 1,
991 UNDERLINE: 2,
992 BLINK: 4,
993 INVERSE: 8,
994 INVISIBLE: 16
995 }
996
997 /**
998 * Refreshes (re-renders) terminal content within two rows (inclusive)
999 *
1000 * Rendering Engine:
1001 *
1002 * In the screen buffer, each character is stored as a an array with a character
1003 * and a 32-bit integer:
1004 * - First value: a utf-16 character.
1005 * - Second value:
1006 * - Next 9 bits: background color (0-511).
1007 * - Next 9 bits: foreground color (0-511).
1008 * - Next 14 bits: a mask for misc. flags:
1009 * - 1=bold
1010 * - 2=underline
1011 * - 4=blink
1012 * - 8=inverse
1013 * - 16=invisible
1014 *
1015 * @param {number} start The row to start from (between 0 and terminal's height terminal - 1)
1016 * @param {number} end The row to end at (between fromRow and terminal's height terminal - 1)
1017 * @param {boolean} queue Whether the refresh should ran right now or be queued
1018 */
1019 Terminal.prototype.refresh = function(start, end, queue) {
1020 var self = this;
1021
1022 // queue defaults to true
1023 queue = (typeof queue == 'undefined') ? true : queue;
1024
1025 /**
1026 * The refresh queue allows refresh to execute only approximately 30 times a second. For
1027 * commands that pass a significant amount of output to the write function, this prevents the
1028 * terminal from maxing out the CPU and making the UI unresponsive. While commands can still
1029 * run beyond what they do on the terminal, it is far better with a debounce in place as
1030 * every single terminal manipulation does not need to be constructed in the DOM.
1031 *
1032 * A side-effect of this is that it makes ^C to interrupt a process seem more responsive.
1033 */
1034 if (queue) {
1035 // If refresh should be queued, order the refresh and return.
1036 if (this._refreshIsQueued) {
1037 // If a refresh has already been queued, just order a full refresh next
1038 this._fullRefreshNext = true;
1039 } else {
1040 setTimeout(function () {
1041 self.refresh(start, end, false);
1042 }, 34)
1043 this._refreshIsQueued = true;
1044 }
1045 return;
1046 }
1047
1048 // If refresh should be run right now (not be queued), release the lock
1049 this._refreshIsQueued = false;
1050
1051 // If multiple refreshes were requested, make a full refresh.
1052 if (this._fullRefreshNext) {
1053 start = 0;
1054 end = this.rows - 1;
1055 this._fullRefreshNext = false // reset lock
1056 }
1057
1058 var x, y, i, line, out, ch, ch_width, width, data, attr, bg, fg, flags, row, parent, focused = document.activeElement;
1059
1060 // If this is a big refresh, remove the terminal rows from the DOM for faster calculations
1061 if (end - start >= this.rows / 2) {
1062 parent = this.element.parentNode;
1063 if (parent) {
1064 this.element.removeChild(this.rowContainer);
1065 }
1066 }
1067
1068 width = this.cols;
1069 y = start;
1070
1071 if (end >= this.rows.length) {
1072 this.log('`end` is too large. Most likely a bad CSR.');
1073 end = this.rows.length - 1;
1074 }
1075
1076 for (; y <= end; y++) {
1077 row = y + this.ydisp;
1078
1079 line = this.lines.get(row);
1080 out = '';
1081
1082 if (this.y === y - (this.ybase - this.ydisp)
1083 && this.cursorState
1084 && !this.cursorHidden) {
1085 x = this.x;
1086 } else {
1087 x = -1;
1088 }
1089
1090 attr = this.defAttr;
1091 i = 0;
1092
1093 for (; i < width; i++) {
1094 data = line[i][0];
1095 ch = line[i][1];
1096 ch_width = line[i][2];
1097 if (!ch_width)
1098 continue;
1099
1100 if (i === x) data = -1;
1101
1102 if (data !== attr) {
1103 if (attr !== this.defAttr) {
1104 out += '</span>';
1105 }
1106 if (data !== this.defAttr) {
1107 if (data === -1) {
1108 out += '<span class="reverse-video terminal-cursor';
1109 if (this.cursorBlink) {
1110 out += ' blinking';
1111 }
1112 out += '">';
1113 } else {
1114 var classNames = [];
1115
1116 bg = data & 0x1ff;
1117 fg = (data >> 9) & 0x1ff;
1118 flags = data >> 18;
1119
1120 if (flags & Terminal.flags.BOLD) {
1121 if (!Terminal.brokenBold) {
1122 classNames.push('xterm-bold');
1123 }
1124 // See: XTerm*boldColors
1125 if (fg < 8) fg += 8;
1126 }
1127
1128 if (flags & Terminal.flags.UNDERLINE) {
1129 classNames.push('xterm-underline');
1130 }
1131
1132 if (flags & Terminal.flags.BLINK) {
1133 classNames.push('xterm-blink');
1134 }
1135
1136 // If inverse flag is on, then swap the foreground and background variables.
1137 if (flags & Terminal.flags.INVERSE) {
1138 /* One-line variable swap in JavaScript: http://stackoverflow.com/a/16201730 */
1139 bg = [fg, fg = bg][0];
1140 // Should inverse just be before the
1141 // above boldColors effect instead?
1142 if ((flags & 1) && fg < 8) fg += 8;
1143 }
1144
1145 if (flags & Terminal.flags.INVISIBLE) {
1146 classNames.push('xterm-hidden');
1147 }
1148
1149 /**
1150 * Weird situation: Invert flag used black foreground and white background results
1151 * in invalid background color, positioned at the 256 index of the 256 terminal
1152 * color map. Pin the colors manually in such a case.
1153 *
1154 * Source: https://github.com/sourcelair/xterm.js/issues/57
1155 */
1156 if (flags & Terminal.flags.INVERSE) {
1157 if (bg == 257) {
1158 bg = 15;
1159 }
1160 if (fg == 256) {
1161 fg = 0;
1162 }
1163 }
1164
1165 if (bg < 256) {
1166 classNames.push('xterm-bg-color-' + bg);
1167 }
1168
1169 if (fg < 256) {
1170 classNames.push('xterm-color-' + fg);
1171 }
1172
1173 out += '<span';
1174 if (classNames.length) {
1175 out += ' class="' + classNames.join(' ') + '"';
1176 }
1177 out += '>';
1178 }
1179 }
1180 }
1181
1182 switch (ch) {
1183 case '&':
1184 out += '&amp;';
1185 break;
1186 case '<':
1187 out += '&lt;';
1188 break;
1189 case '>':
1190 out += '&gt;';
1191 break;
1192 default:
1193 if (ch <= ' ') {
1194 out += '&nbsp;';
1195 } else {
1196 out += ch;
1197 }
1198 break;
1199 }
1200
1201 attr = data;
1202 }
1203
1204 if (attr !== this.defAttr) {
1205 out += '</span>';
1206 }
1207
1208 this.children[y].innerHTML = out;
1209 }
1210
1211 if (parent) {
1212 this.element.appendChild(this.rowContainer);
1213 }
1214
1215 this.emit('refresh', {element: this.element, start: start, end: end});
1216 };
1217
1218 /**
1219 * Display the cursor element
1220 */
1221 Terminal.prototype.showCursor = function() {
1222 if (!this.cursorState) {
1223 this.cursorState = 1;
1224 this.refresh(this.y, this.y);
1225 }
1226 };
1227
1228 /**
1229 * Scroll the terminal
1230 */
1231 Terminal.prototype.scroll = function() {
1232 var row;
1233
1234 if (++this.ybase === this.scrollback) {
1235 this.ybase = this.ybase / 2;
1236 // TODO: Rely on the circular list instead of cutting it in half
1237 this.lines.removeItemsFromStart(this.ybase + this.rows - 1);
1238 }
1239
1240 if (!this.userScrolling) {
1241 this.ydisp = this.ybase;
1242 }
1243
1244 // last line
1245 row = this.ybase + this.rows - 1;
1246
1247 // subtract the bottom scroll region
1248 row -= this.rows - 1 - this.scrollBottom;
1249
1250 if (row === this.lines.length) {
1251 // potential optimization:
1252 // pushing is faster than splicing
1253 // when they amount to the same
1254 // behavior.
1255 this.lines.push(this.blankLine());
1256 } else {
1257 // add our new line
1258 this.lines.splice(row, 0, this.blankLine());
1259 }
1260
1261 if (this.scrollTop !== 0) {
1262 if (this.ybase !== 0) {
1263 this.ybase--;
1264 if (!this.userScrolling) {
1265 this.ydisp = this.ybase;
1266 }
1267 }
1268 this.lines.splice(this.ybase + this.scrollTop, 1);
1269 }
1270
1271 // this.maxRange();
1272 this.updateRange(this.scrollTop);
1273 this.updateRange(this.scrollBottom);
1274
1275 /**
1276 * This event is emitted whenever the terminal is scrolled.
1277 * The one parameter passed is the new y display position.
1278 *
1279 * @event scroll
1280 */
1281 this.emit('scroll', this.ydisp);
1282 };
1283
1284 /**
1285 * Scroll the display of the terminal
1286 * @param {number} disp The number of lines to scroll down (negatives scroll up).
1287 * @param {boolean} suppressScrollEvent Don't emit the scroll event as scrollDisp. This is used
1288 * to avoid unwanted events being handled by the veiwport when the event was triggered from the
1289 * viewport originally.
1290 */
1291 Terminal.prototype.scrollDisp = function(disp, suppressScrollEvent) {
1292 if (disp < 0) {
1293 this.userScrolling = true;
1294 } else if (disp + this.ydisp >= this.ybase) {
1295 this.userScrolling = false;
1296 }
1297
1298 this.ydisp += disp;
1299
1300 if (this.ydisp > this.ybase) {
1301 this.ydisp = this.ybase;
1302 } else if (this.ydisp < 0) {
1303 this.ydisp = 0;
1304 }
1305
1306 if (!suppressScrollEvent) {
1307 this.emit('scroll', this.ydisp);
1308 }
1309
1310 this.refresh(0, this.rows - 1);
1311 };
1312
1313 /**
1314 * Scroll the display of the terminal by a number of pages.
1315 * @param {number} pageCount The number of pages to scroll (negative scrolls up).
1316 */
1317 Terminal.prototype.scrollPages = function(pageCount) {
1318 this.scrollDisp(pageCount * (this.rows - 1));
1319 }
1320
1321 /**
1322 * Scrolls the display of the terminal to the top.
1323 */
1324 Terminal.prototype.scrollToTop = function() {
1325 this.scrollDisp(-this.ydisp);
1326 }
1327
1328 /**
1329 * Scrolls the display of the terminal to the bottom.
1330 */
1331 Terminal.prototype.scrollToBottom = function() {
1332 this.scrollDisp(this.ybase - this.ydisp);
1333 }
1334
1335 /**
1336 * Writes text to the terminal.
1337 * @param {string} text The text to write to the terminal.
1338 */
1339 Terminal.prototype.write = function(data) {
1340 var l = data.length, i = 0, j, cs, ch, code, low, ch_width, row;
1341
1342 this.refreshStart = this.y;
1343 this.refreshEnd = this.y;
1344
1345 // apply leftover surrogate high from last write
1346 if (this.surrogate_high) {
1347 data = this.surrogate_high + data;
1348 this.surrogate_high = '';
1349 }
1350
1351 for (; i < l; i++) {
1352 ch = data[i];
1353
1354 // FIXME: higher chars than 0xa0 are not allowed in escape sequences
1355 // --> maybe move to default
1356 code = data.charCodeAt(i);
1357 if (0xD800 <= code && code <= 0xDBFF) {
1358 // we got a surrogate high
1359 // get surrogate low (next 2 bytes)
1360 low = data.charCodeAt(i+1);
1361 if (isNaN(low)) {
1362 // end of data stream, save surrogate high
1363 this.surrogate_high = ch;
1364 continue;
1365 }
1366 code = ((code - 0xD800) * 0x400) + (low - 0xDC00) + 0x10000;
1367 ch += data.charAt(i+1);
1368 }
1369 // surrogate low - already handled above
1370 if (0xDC00 <= code && code <= 0xDFFF)
1371 continue;
1372 switch (this.state) {
1373 case normal:
1374 switch (ch) {
1375 case '\x07':
1376 this.bell();
1377 break;
1378
1379 // '\n', '\v', '\f'
1380 case '\n':
1381 case '\x0b':
1382 case '\x0c':
1383 if (this.convertEol) {
1384 this.x = 0;
1385 }
1386 this.y++;
1387 if (this.y > this.scrollBottom) {
1388 this.y--;
1389 this.scroll();
1390 }
1391 break;
1392
1393 // '\r'
1394 case '\r':
1395 this.x = 0;
1396 break;
1397
1398 // '\b'
1399 case '\x08':
1400 if (this.x > 0) {
1401 this.x--;
1402 }
1403 break;
1404
1405 // '\t'
1406 case '\t':
1407 this.x = this.nextStop();
1408 break;
1409
1410 // shift out
1411 case '\x0e':
1412 this.setgLevel(1);
1413 break;
1414
1415 // shift in
1416 case '\x0f':
1417 this.setgLevel(0);
1418 break;
1419
1420 // '\e'
1421 case '\x1b':
1422 this.state = escaped;
1423 break;
1424
1425 default:
1426 // ' '
1427 // calculate print space
1428 // expensive call, therefore we save width in line buffer
1429 ch_width = wcwidth(code);
1430
1431 if (ch >= ' ') {
1432 if (this.charset && this.charset[ch]) {
1433 ch = this.charset[ch];
1434 }
1435
1436 row = this.y + this.ybase;
1437
1438 // insert combining char in last cell
1439 // FIXME: needs handling after cursor jumps
1440 if (!ch_width && this.x) {
1441 // dont overflow left
1442 if (this.lines.get(row)[this.x-1]) {
1443 if (!this.lines.get(row)[this.x-1][2]) {
1444
1445 // found empty cell after fullwidth, need to go 2 cells back
1446 if (this.lines.get(row)[this.x-2])
1447 this.lines.get(row)[this.x-2][1] += ch;
1448
1449 } else {
1450 this.lines.get(row)[this.x-1][1] += ch;
1451 }
1452 this.updateRange(this.y);
1453 }
1454 break;
1455 }
1456
1457 // goto next line if ch would overflow
1458 // TODO: needs a global min terminal width of 2
1459 if (this.x+ch_width-1 >= this.cols) {
1460 // autowrap - DECAWM
1461 if (this.wraparoundMode) {
1462 this.x = 0;
1463 this.y++;
1464 if (this.y > this.scrollBottom) {
1465 this.y--;
1466 this.scroll();
1467 }
1468 } else {
1469 this.x = this.cols-1;
1470 if(ch_width===2) // FIXME: check for xterm behavior
1471 continue;
1472 }
1473 }
1474 row = this.y + this.ybase;
1475
1476 // insert mode: move characters to right
1477 if (this.insertMode) {
1478 // do this twice for a fullwidth char
1479 for (var moves=0; moves<ch_width; ++moves) {
1480 // remove last cell, if it's width is 0
1481 // we have to adjust the second last cell as well
1482 var removed = this.lines.get(this.y + this.ybase).pop();
1483 if (removed[2]===0
1484 && this.lines.get(row)[this.cols-2]
1485 && this.lines.get(row)[this.cols-2][2]===2)
1486 this.lines.get(row)[this.cols-2] = [this.curAttr, ' ', 1];
1487
1488 // insert empty cell at cursor
1489 this.lines.get(row).splice(this.x, 0, [this.curAttr, ' ', 1]);
1490 }
1491 }
1492
1493 this.lines.get(row)[this.x] = [this.curAttr, ch, ch_width];
1494 this.x++;
1495 this.updateRange(this.y);
1496
1497 // fullwidth char - set next cell width to zero and advance cursor
1498 if (ch_width===2) {
1499 this.lines.get(row)[this.x] = [this.curAttr, '', 0];
1500 this.x++;
1501 }
1502 }
1503 break;
1504 }
1505 break;
1506 case escaped:
1507 switch (ch) {
1508 // ESC [ Control Sequence Introducer ( CSI is 0x9b).
1509 case '[':
1510 this.params = [];
1511 this.currentParam = 0;
1512 this.state = csi;
1513 break;
1514
1515 // ESC ] Operating System Command ( OSC is 0x9d).
1516 case ']':
1517 this.params = [];
1518 this.currentParam = 0;
1519 this.state = osc;
1520 break;
1521
1522 // ESC P Device Control String ( DCS is 0x90).
1523 case 'P':
1524 this.params = [];
1525 this.currentParam = 0;
1526 this.state = dcs;
1527 break;
1528
1529 // ESC _ Application Program Command ( APC is 0x9f).
1530 case '_':
1531 this.state = ignore;
1532 break;
1533
1534 // ESC ^ Privacy Message ( PM is 0x9e).
1535 case '^':
1536 this.state = ignore;
1537 break;
1538
1539 // ESC c Full Reset (RIS).
1540 case 'c':
1541 this.reset();
1542 break;
1543
1544 // ESC E Next Line ( NEL is 0x85).
1545 // ESC D Index ( IND is 0x84).
1546 case 'E':
1547 this.x = 0;
1548 ;
1549 case 'D':
1550 this.index();
1551 break;
1552
1553 // ESC M Reverse Index ( RI is 0x8d).
1554 case 'M':
1555 this.reverseIndex();
1556 break;
1557
1558 // ESC % Select default/utf-8 character set.
1559 // @ = default, G = utf-8
1560 case '%':
1561 //this.charset = null;
1562 this.setgLevel(0);
1563 this.setgCharset(0, Terminal.charsets.US);
1564 this.state = normal;
1565 i++;
1566 break;
1567
1568 // ESC (,),*,+,-,. Designate G0-G2 Character Set.
1569 case '(': // <-- this seems to get all the attention
1570 case ')':
1571 case '*':
1572 case '+':
1573 case '-':
1574 case '.':
1575 switch (ch) {
1576 case '(':
1577 this.gcharset = 0;
1578 break;
1579 case ')':
1580 this.gcharset = 1;
1581 break;
1582 case '*':
1583 this.gcharset = 2;
1584 break;
1585 case '+':
1586 this.gcharset = 3;
1587 break;
1588 case '-':
1589 this.gcharset = 1;
1590 break;
1591 case '.':
1592 this.gcharset = 2;
1593 break;
1594 }
1595 this.state = charset;
1596 break;
1597
1598 // Designate G3 Character Set (VT300).
1599 // A = ISO Latin-1 Supplemental.
1600 // Not implemented.
1601 case '/':
1602 this.gcharset = 3;
1603 this.state = charset;
1604 i--;
1605 break;
1606
1607 // ESC N
1608 // Single Shift Select of G2 Character Set
1609 // ( SS2 is 0x8e). This affects next character only.
1610 case 'N':
1611 break;
1612 // ESC O
1613 // Single Shift Select of G3 Character Set
1614 // ( SS3 is 0x8f). This affects next character only.
1615 case 'O':
1616 break;
1617 // ESC n
1618 // Invoke the G2 Character Set as GL (LS2).
1619 case 'n':
1620 this.setgLevel(2);
1621 break;
1622 // ESC o
1623 // Invoke the G3 Character Set as GL (LS3).
1624 case 'o':
1625 this.setgLevel(3);
1626 break;
1627 // ESC |
1628 // Invoke the G3 Character Set as GR (LS3R).
1629 case '|':
1630 this.setgLevel(3);
1631 break;
1632 // ESC }
1633 // Invoke the G2 Character Set as GR (LS2R).
1634 case '}':
1635 this.setgLevel(2);
1636 break;
1637 // ESC ~
1638 // Invoke the G1 Character Set as GR (LS1R).
1639 case '~':
1640 this.setgLevel(1);
1641 break;
1642
1643 // ESC 7 Save Cursor (DECSC).
1644 case '7':
1645 this.saveCursor();
1646 this.state = normal;
1647 break;
1648
1649 // ESC 8 Restore Cursor (DECRC).
1650 case '8':
1651 this.restoreCursor();
1652 this.state = normal;
1653 break;
1654
1655 // ESC # 3 DEC line height/width
1656 case '#':
1657 this.state = normal;
1658 i++;
1659 break;
1660
1661 // ESC H Tab Set (HTS is 0x88).
1662 case 'H':
1663 this.tabSet();
1664 break;
1665
1666 // ESC = Application Keypad (DECKPAM).
1667 case '=':
1668 this.log('Serial port requested application keypad.');
1669 this.applicationKeypad = true;
1670 this.viewport.syncScrollArea();
1671 this.state = normal;
1672 break;
1673
1674 // ESC > Normal Keypad (DECKPNM).
1675 case '>':
1676 this.log('Switching back to normal keypad.');
1677 this.applicationKeypad = false;
1678 this.viewport.syncScrollArea();
1679 this.state = normal;
1680 break;
1681
1682 default:
1683 this.state = normal;
1684 this.error('Unknown ESC control: %s.', ch);
1685 break;
1686 }
1687 break;
1688
1689 case charset:
1690 switch (ch) {
1691 case '0': // DEC Special Character and Line Drawing Set.
1692 cs = Terminal.charsets.SCLD;
1693 break;
1694 case 'A': // UK
1695 cs = Terminal.charsets.UK;
1696 break;
1697 case 'B': // United States (USASCII).
1698 cs = Terminal.charsets.US;
1699 break;
1700 case '4': // Dutch
1701 cs = Terminal.charsets.Dutch;
1702 break;
1703 case 'C': // Finnish
1704 case '5':
1705 cs = Terminal.charsets.Finnish;
1706 break;
1707 case 'R': // French
1708 cs = Terminal.charsets.French;
1709 break;
1710 case 'Q': // FrenchCanadian
1711 cs = Terminal.charsets.FrenchCanadian;
1712 break;
1713 case 'K': // German
1714 cs = Terminal.charsets.German;
1715 break;
1716 case 'Y': // Italian
1717 cs = Terminal.charsets.Italian;
1718 break;
1719 case 'E': // NorwegianDanish
1720 case '6':
1721 cs = Terminal.charsets.NorwegianDanish;
1722 break;
1723 case 'Z': // Spanish
1724 cs = Terminal.charsets.Spanish;
1725 break;
1726 case 'H': // Swedish
1727 case '7':
1728 cs = Terminal.charsets.Swedish;
1729 break;
1730 case '=': // Swiss
1731 cs = Terminal.charsets.Swiss;
1732 break;
1733 case '/': // ISOLatin (actually /A)
1734 cs = Terminal.charsets.ISOLatin;
1735 i++;
1736 break;
1737 default: // Default
1738 cs = Terminal.charsets.US;
1739 break;
1740 }
1741 this.setgCharset(this.gcharset, cs);
1742 this.gcharset = null;
1743 this.state = normal;
1744 break;
1745
1746 case osc:
1747 // OSC Ps ; Pt ST
1748 // OSC Ps ; Pt BEL
1749 // Set Text Parameters.
1750 if (ch === '\x1b' || ch === '\x07') {
1751 if (ch === '\x1b') i++;
1752
1753 this.params.push(this.currentParam);
1754
1755 switch (this.params[0]) {
1756 case 0:
1757 case 1:
1758 case 2:
1759 if (this.params[1]) {
1760 this.title = this.params[1];
1761 this.handleTitle(this.title);
1762 }
1763 break;
1764 case 3:
1765 // set X property
1766 break;
1767 case 4:
1768 case 5:
1769 // change dynamic colors
1770 break;
1771 case 10:
1772 case 11:
1773 case 12:
1774 case 13:
1775 case 14:
1776 case 15:
1777 case 16:
1778 case 17:
1779 case 18:
1780 case 19:
1781 // change dynamic ui colors
1782 break;
1783 case 46:
1784 // change log file
1785 break;
1786 case 50:
1787 // dynamic font
1788 break;
1789 case 51:
1790 // emacs shell
1791 break;
1792 case 52:
1793 // manipulate selection data
1794 break;
1795 case 104:
1796 case 105:
1797 case 110:
1798 case 111:
1799 case 112:
1800 case 113:
1801 case 114:
1802 case 115:
1803 case 116:
1804 case 117:
1805 case 118:
1806 // reset colors
1807 break;
1808 }
1809
1810 this.params = [];
1811 this.currentParam = 0;
1812 this.state = normal;
1813 } else {
1814 if (!this.params.length) {
1815 if (ch >= '0' && ch <= '9') {
1816 this.currentParam =
1817 this.currentParam * 10 + ch.charCodeAt(0) - 48;
1818 } else if (ch === ';') {
1819 this.params.push(this.currentParam);
1820 this.currentParam = '';
1821 }
1822 } else {
1823 this.currentParam += ch;
1824 }
1825 }
1826 break;
1827
1828 case csi:
1829 // '?', '>', '!'
1830 if (ch === '?' || ch === '>' || ch === '!') {
1831 this.prefix = ch;
1832 break;
1833 }
1834
1835 // 0 - 9
1836 if (ch >= '0' && ch <= '9') {
1837 this.currentParam = this.currentParam * 10 + ch.charCodeAt(0) - 48;
1838 break;
1839 }
1840
1841 // '$', '"', ' ', '\''
1842 if (ch === '$' || ch === '"' || ch === ' ' || ch === '\'') {
1843 this.postfix = ch;
1844 break;
1845 }
1846
1847 this.params.push(this.currentParam);
1848 this.currentParam = 0;
1849
1850 // ';'
1851 if (ch === ';') break;
1852
1853 this.state = normal;
1854
1855 switch (ch) {
1856 // CSI Ps A
1857 // Cursor Up Ps Times (default = 1) (CUU).
1858 case 'A':
1859 this.cursorUp(this.params);
1860 break;
1861
1862 // CSI Ps B
1863 // Cursor Down Ps Times (default = 1) (CUD).
1864 case 'B':
1865 this.cursorDown(this.params);
1866 break;
1867
1868 // CSI Ps C
1869 // Cursor Forward Ps Times (default = 1) (CUF).
1870 case 'C':
1871 this.cursorForward(this.params);
1872 break;
1873
1874 // CSI Ps D
1875 // Cursor Backward Ps Times (default = 1) (CUB).
1876 case 'D':
1877 this.cursorBackward(this.params);
1878 break;
1879
1880 // CSI Ps ; Ps H
1881 // Cursor Position [row;column] (default = [1,1]) (CUP).
1882 case 'H':
1883 this.cursorPos(this.params);
1884 break;
1885
1886 // CSI Ps J Erase in Display (ED).
1887 case 'J':
1888 this.eraseInDisplay(this.params);
1889 break;
1890
1891 // CSI Ps K Erase in Line (EL).
1892 case 'K':
1893 this.eraseInLine(this.params);
1894 break;
1895
1896 // CSI Pm m Character Attributes (SGR).
1897 case 'm':
1898 if (!this.prefix) {
1899 this.charAttributes(this.params);
1900 }
1901 break;
1902
1903 // CSI Ps n Device Status Report (DSR).
1904 case 'n':
1905 if (!this.prefix) {
1906 this.deviceStatus(this.params);
1907 }
1908 break;
1909
1910 /**
1911 * Additions
1912 */
1913
1914 // CSI Ps @
1915 // Insert Ps (Blank) Character(s) (default = 1) (ICH).
1916 case '@':
1917 this.insertChars(this.params);
1918 break;
1919
1920 // CSI Ps E
1921 // Cursor Next Line Ps Times (default = 1) (CNL).
1922 case 'E':
1923 this.cursorNextLine(this.params);
1924 break;
1925
1926 // CSI Ps F
1927 // Cursor Preceding Line Ps Times (default = 1) (CNL).
1928 case 'F':
1929 this.cursorPrecedingLine(this.params);
1930 break;
1931
1932 // CSI Ps G
1933 // Cursor Character Absolute [column] (default = [row,1]) (CHA).
1934 case 'G':
1935 this.cursorCharAbsolute(this.params);
1936 break;
1937
1938 // CSI Ps L
1939 // Insert Ps Line(s) (default = 1) (IL).
1940 case 'L':
1941 this.insertLines(this.params);
1942 break;
1943
1944 // CSI Ps M
1945 // Delete Ps Line(s) (default = 1) (DL).
1946 case 'M':
1947 this.deleteLines(this.params);
1948 break;
1949
1950 // CSI Ps P
1951 // Delete Ps Character(s) (default = 1) (DCH).
1952 case 'P':
1953 this.deleteChars(this.params);
1954 break;
1955
1956 // CSI Ps X
1957 // Erase Ps Character(s) (default = 1) (ECH).
1958 case 'X':
1959 this.eraseChars(this.params);
1960 break;
1961
1962 // CSI Pm ` Character Position Absolute
1963 // [column] (default = [row,1]) (HPA).
1964 case '`':
1965 this.charPosAbsolute(this.params);
1966 break;
1967
1968 // 141 61 a * HPR -
1969 // Horizontal Position Relative
1970 case 'a':
1971 this.HPositionRelative(this.params);
1972 break;
1973
1974 // CSI P s c
1975 // Send Device Attributes (Primary DA).
1976 // CSI > P s c
1977 // Send Device Attributes (Secondary DA)
1978 case 'c':
1979 this.sendDeviceAttributes(this.params);
1980 break;
1981
1982 // CSI Pm d
1983 // Line Position Absolute [row] (default = [1,column]) (VPA).
1984 case 'd':
1985 this.linePosAbsolute(this.params);
1986 break;
1987
1988 // 145 65 e * VPR - Vertical Position Relative
1989 case 'e':
1990 this.VPositionRelative(this.params);
1991 break;
1992
1993 // CSI Ps ; Ps f
1994 // Horizontal and Vertical Position [row;column] (default =
1995 // [1,1]) (HVP).
1996 case 'f':
1997 this.HVPosition(this.params);
1998 break;
1999
2000 // CSI Pm h Set Mode (SM).
2001 // CSI ? Pm h - mouse escape codes, cursor escape codes
2002 case 'h':
2003 this.setMode(this.params);
2004 break;
2005
2006 // CSI Pm l Reset Mode (RM).
2007 // CSI ? Pm l
2008 case 'l':
2009 this.resetMode(this.params);
2010 break;
2011
2012 // CSI Ps ; Ps r
2013 // Set Scrolling Region [top;bottom] (default = full size of win-
2014 // dow) (DECSTBM).
2015 // CSI ? Pm r
2016 case 'r':
2017 this.setScrollRegion(this.params);
2018 break;
2019
2020 // CSI s
2021 // Save cursor (ANSI.SYS).
2022 case 's':
2023 this.saveCursor(this.params);
2024 break;
2025
2026 // CSI u
2027 // Restore cursor (ANSI.SYS).
2028 case 'u':
2029 this.restoreCursor(this.params);
2030 break;
2031
2032 /**
2033 * Lesser Used
2034 */
2035
2036 // CSI Ps I
2037 // Cursor Forward Tabulation Ps tab stops (default = 1) (CHT).
2038 case 'I':
2039 this.cursorForwardTab(this.params);
2040 break;
2041
2042 // CSI Ps S Scroll up Ps lines (default = 1) (SU).
2043 case 'S':
2044 this.scrollUp(this.params);
2045 break;
2046
2047 // CSI Ps T Scroll down Ps lines (default = 1) (SD).
2048 // CSI Ps ; Ps ; Ps ; Ps ; Ps T
2049 // CSI > Ps; Ps T
2050 case 'T':
2051 // if (this.prefix === '>') {
2052 // this.resetTitleModes(this.params);
2053 // break;
2054 // }
2055 // if (this.params.length > 2) {
2056 // this.initMouseTracking(this.params);
2057 // break;
2058 // }
2059 if (this.params.length < 2 && !this.prefix) {
2060 this.scrollDown(this.params);
2061 }
2062 break;
2063
2064 // CSI Ps Z
2065 // Cursor Backward Tabulation Ps tab stops (default = 1) (CBT).
2066 case 'Z':
2067 this.cursorBackwardTab(this.params);
2068 break;
2069
2070 // CSI Ps b Repeat the preceding graphic character Ps times (REP).
2071 case 'b':
2072 this.repeatPrecedingCharacter(this.params);
2073 break;
2074
2075 // CSI Ps g Tab Clear (TBC).
2076 case 'g':
2077 this.tabClear(this.params);
2078 break;
2079
2080 // CSI Pm i Media Copy (MC).
2081 // CSI ? Pm i
2082 // case 'i':
2083 // this.mediaCopy(this.params);
2084 // break;
2085
2086 // CSI Pm m Character Attributes (SGR).
2087 // CSI > Ps; Ps m
2088 // case 'm': // duplicate
2089 // if (this.prefix === '>') {
2090 // this.setResources(this.params);
2091 // } else {
2092 // this.charAttributes(this.params);
2093 // }
2094 // break;
2095
2096 // CSI Ps n Device Status Report (DSR).
2097 // CSI > Ps n
2098 // case 'n': // duplicate
2099 // if (this.prefix === '>') {
2100 // this.disableModifiers(this.params);
2101 // } else {
2102 // this.deviceStatus(this.params);
2103 // }
2104 // break;
2105
2106 // CSI > Ps p Set pointer mode.
2107 // CSI ! p Soft terminal reset (DECSTR).
2108 // CSI Ps$ p
2109 // Request ANSI mode (DECRQM).
2110 // CSI ? Ps$ p
2111 // Request DEC private mode (DECRQM).
2112 // CSI Ps ; Ps " p
2113 case 'p':
2114 switch (this.prefix) {
2115 // case '>':
2116 // this.setPointerMode(this.params);
2117 // break;
2118 case '!':
2119 this.softReset(this.params);
2120 break;
2121 // case '?':
2122 // if (this.postfix === '$') {
2123 // this.requestPrivateMode(this.params);
2124 // }
2125 // break;
2126 // default:
2127 // if (this.postfix === '"') {
2128 // this.setConformanceLevel(this.params);
2129 // } else if (this.postfix === '$') {
2130 // this.requestAnsiMode(this.params);
2131 // }
2132 // break;
2133 }
2134 break;
2135
2136 // CSI Ps q Load LEDs (DECLL).
2137 // CSI Ps SP q
2138 // CSI Ps " q
2139 // case 'q':
2140 // if (this.postfix === ' ') {
2141 // this.setCursorStyle(this.params);
2142 // break;
2143 // }
2144 // if (this.postfix === '"') {
2145 // this.setCharProtectionAttr(this.params);
2146 // break;
2147 // }
2148 // this.loadLEDs(this.params);
2149 // break;
2150
2151 // CSI Ps ; Ps r
2152 // Set Scrolling Region [top;bottom] (default = full size of win-
2153 // dow) (DECSTBM).
2154 // CSI ? Pm r
2155 // CSI Pt; Pl; Pb; Pr; Ps$ r
2156 // case 'r': // duplicate
2157 // if (this.prefix === '?') {
2158 // this.restorePrivateValues(this.params);
2159 // } else if (this.postfix === '$') {
2160 // this.setAttrInRectangle(this.params);
2161 // } else {
2162 // this.setScrollRegion(this.params);
2163 // }
2164 // break;
2165
2166 // CSI s Save cursor (ANSI.SYS).
2167 // CSI ? Pm s
2168 // case 's': // duplicate
2169 // if (this.prefix === '?') {
2170 // this.savePrivateValues(this.params);
2171 // } else {
2172 // this.saveCursor(this.params);
2173 // }
2174 // break;
2175
2176 // CSI Ps ; Ps ; Ps t
2177 // CSI Pt; Pl; Pb; Pr; Ps$ t
2178 // CSI > Ps; Ps t
2179 // CSI Ps SP t
2180 // case 't':
2181 // if (this.postfix === '$') {
2182 // this.reverseAttrInRectangle(this.params);
2183 // } else if (this.postfix === ' ') {
2184 // this.setWarningBellVolume(this.params);
2185 // } else {
2186 // if (this.prefix === '>') {
2187 // this.setTitleModeFeature(this.params);
2188 // } else {
2189 // this.manipulateWindow(this.params);
2190 // }
2191 // }
2192 // break;
2193
2194 // CSI u Restore cursor (ANSI.SYS).
2195 // CSI Ps SP u
2196 // case 'u': // duplicate
2197 // if (this.postfix === ' ') {
2198 // this.setMarginBellVolume(this.params);
2199 // } else {
2200 // this.restoreCursor(this.params);
2201 // }
2202 // break;
2203
2204 // CSI Pt; Pl; Pb; Pr; Pp; Pt; Pl; Pp$ v
2205 // case 'v':
2206 // if (this.postfix === '$') {
2207 // this.copyRectagle(this.params);
2208 // }
2209 // break;
2210
2211 // CSI Pt ; Pl ; Pb ; Pr ' w
2212 // case 'w':
2213 // if (this.postfix === '\'') {
2214 // this.enableFilterRectangle(this.params);
2215 // }
2216 // break;
2217
2218 // CSI Ps x Request Terminal Parameters (DECREQTPARM).
2219 // CSI Ps x Select Attribute Change Extent (DECSACE).
2220 // CSI Pc; Pt; Pl; Pb; Pr$ x
2221 // case 'x':
2222 // if (this.postfix === '$') {
2223 // this.fillRectangle(this.params);
2224 // } else {
2225 // this.requestParameters(this.params);
2226 // //this.__(this.params);
2227 // }
2228 // break;
2229
2230 // CSI Ps ; Pu ' z
2231 // CSI Pt; Pl; Pb; Pr$ z
2232 // case 'z':
2233 // if (this.postfix === '\'') {
2234 // this.enableLocatorReporting(this.params);
2235 // } else if (this.postfix === '$') {
2236 // this.eraseRectangle(this.params);
2237 // }
2238 // break;
2239
2240 // CSI Pm ' {
2241 // CSI Pt; Pl; Pb; Pr$ {
2242 // case '{':
2243 // if (this.postfix === '\'') {
2244 // this.setLocatorEvents(this.params);
2245 // } else if (this.postfix === '$') {
2246 // this.selectiveEraseRectangle(this.params);
2247 // }
2248 // break;
2249
2250 // CSI Ps ' |
2251 // case '|':
2252 // if (this.postfix === '\'') {
2253 // this.requestLocatorPosition(this.params);
2254 // }
2255 // break;
2256
2257 // CSI P m SP }
2258 // Insert P s Column(s) (default = 1) (DECIC), VT420 and up.
2259 // case '}':
2260 // if (this.postfix === ' ') {
2261 // this.insertColumns(this.params);
2262 // }
2263 // break;
2264
2265 // CSI P m SP ~
2266 // Delete P s Column(s) (default = 1) (DECDC), VT420 and up
2267 // case '~':
2268 // if (this.postfix === ' ') {
2269 // this.deleteColumns(this.params);
2270 // }
2271 // break;
2272
2273 default:
2274 this.error('Unknown CSI code: %s.', ch);
2275 break;
2276 }
2277
2278 this.prefix = '';
2279 this.postfix = '';
2280 break;
2281
2282 case dcs:
2283 if (ch === '\x1b' || ch === '\x07') {
2284 if (ch === '\x1b') i++;
2285
2286 switch (this.prefix) {
2287 // User-Defined Keys (DECUDK).
2288 case '':
2289 break;
2290
2291 // Request Status String (DECRQSS).
2292 // test: echo -e '\eP$q"p\e\\'
2293 case '$q':
2294 var pt = this.currentParam
2295 , valid = false;
2296
2297 switch (pt) {
2298 // DECSCA
2299 case '"q':
2300 pt = '0"q';
2301 break;
2302
2303 // DECSCL
2304 case '"p':
2305 pt = '61"p';
2306 break;
2307
2308 // DECSTBM
2309 case 'r':
2310 pt = ''
2311 + (this.scrollTop + 1)
2312 + ';'
2313 + (this.scrollBottom + 1)
2314 + 'r';
2315 break;
2316
2317 // SGR
2318 case 'm':
2319 pt = '0m';
2320 break;
2321
2322 default:
2323 this.error('Unknown DCS Pt: %s.', pt);
2324 pt = '';
2325 break;
2326 }
2327
2328 this.send('\x1bP' + +valid + '$r' + pt + '\x1b\\');
2329 break;
2330
2331 // Set Termcap/Terminfo Data (xterm, experimental).
2332 case '+p':
2333 break;
2334
2335 // Request Termcap/Terminfo String (xterm, experimental)
2336 // Regular xterm does not even respond to this sequence.
2337 // This can cause a small glitch in vim.
2338 // test: echo -ne '\eP+q6b64\e\\'
2339 case '+q':
2340 var pt = this.currentParam
2341 , valid = false;
2342
2343 this.send('\x1bP' + +valid + '+r' + pt + '\x1b\\');
2344 break;
2345
2346 default:
2347 this.error('Unknown DCS prefix: %s.', this.prefix);
2348 break;
2349 }
2350
2351 this.currentParam = 0;
2352 this.prefix = '';
2353 this.state = normal;
2354 } else if (!this.currentParam) {
2355 if (!this.prefix && ch !== '$' && ch !== '+') {
2356 this.currentParam = ch;
2357 } else if (this.prefix.length === 2) {
2358 this.currentParam = ch;
2359 } else {
2360 this.prefix += ch;
2361 }
2362 } else {
2363 this.currentParam += ch;
2364 }
2365 break;
2366
2367 case ignore:
2368 // For PM and APC.
2369 if (ch === '\x1b' || ch === '\x07') {
2370 if (ch === '\x1b') i++;
2371 this.state = normal;
2372 }
2373 break;
2374 }
2375 }
2376
2377 this.updateRange(this.y);
2378 this.refresh(this.refreshStart, this.refreshEnd);
2379 };
2380
2381 /**
2382 * Writes text to the terminal, followed by a break line character (\n).
2383 * @param {string} text The text to write to the terminal.
2384 */
2385 Terminal.prototype.writeln = function(data) {
2386 this.write(data + '\r\n');
2387 };
2388
2389 /**
2390 * Attaches a custom keydown handler which is run before keys are processed, giving consumers of
2391 * xterm.js ultimate control as to what keys should be processed by the terminal and what keys
2392 * should not.
2393 * @param {function} customKeydownHandler The custom KeyboardEvent handler to attach. This is a
2394 * function that takes a KeyboardEvent, allowing consumers to stop propogation and/or prevent
2395 * the default action. The function returns whether the event should be processed by xterm.js.
2396 */
2397 Terminal.prototype.attachCustomKeydownHandler = function(customKeydownHandler) {
2398 this.customKeydownHandler = customKeydownHandler;
2399 }
2400
2401 /**
2402 * Handle a keydown event
2403 * Key Resources:
2404 * - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent
2405 * @param {KeyboardEvent} ev The keydown event to be handled.
2406 */
2407 Terminal.prototype.keyDown = function(ev) {
2408 if (this.customKeydownHandler && this.customKeydownHandler(ev) === false) {
2409 return false;
2410 }
2411
2412 if (!this.compositionHelper.keydown.bind(this.compositionHelper)(ev)) {
2413 if (this.ybase !== this.ydisp) {
2414 this.scrollToBottom();
2415 }
2416 return false;
2417 }
2418
2419 var self = this;
2420 var result = this.evaluateKeyEscapeSequence(ev);
2421
2422 if (result.scrollDisp) {
2423 this.scrollDisp(result.scrollDisp);
2424 return this.cancel(ev, true);
2425 }
2426
2427 if (isThirdLevelShift(this, ev)) {
2428 return true;
2429 }
2430
2431 if (result.cancel) {
2432 // The event is canceled at the end already, is this necessary?
2433 this.cancel(ev, true);
2434 }
2435
2436 if (!result.key) {
2437 return true;
2438 }
2439
2440 this.emit('keydown', ev);
2441 this.emit('key', result.key, ev);
2442 this.showCursor();
2443 this.handler(result.key);
2444
2445 return this.cancel(ev, true);
2446 };
2447
2448 /**
2449 * Returns an object that determines how a KeyboardEvent should be handled. The key of the
2450 * returned value is the new key code to pass to the PTY.
2451 *
2452 * Reference: http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
2453 * @param {KeyboardEvent} ev The keyboard event to be translated to key escape sequence.
2454 */
2455 Terminal.prototype.evaluateKeyEscapeSequence = function(ev) {
2456 var result = {
2457 // Whether to cancel event propogation (NOTE: this may not be needed since the event is
2458 // canceled at the end of keyDown
2459 cancel: false,
2460 // The new key even to emit
2461 key: undefined,
2462 // The number of characters to scroll, if this is defined it will cancel the event
2463 scrollDisp: undefined
2464 };
2465 var modifiers = ev.shiftKey << 0 | ev.altKey << 1 | ev.ctrlKey << 2 | ev.metaKey << 3;
2466 switch (ev.keyCode) {
2467 case 8:
2468 // backspace
2469 if (ev.shiftKey) {
2470 result.key = '\x08'; // ^H
2471 break;
2472 }
2473 result.key = '\x7f'; // ^?
2474 break;
2475 case 9:
2476 // tab
2477 if (ev.shiftKey) {
2478 result.key = '\x1b[Z';
2479 break;
2480 }
2481 result.key = '\t';
2482 result.cancel = true;
2483 break;
2484 case 13:
2485 // return/enter
2486 result.key = '\r';
2487 result.cancel = true;
2488 break;
2489 case 27:
2490 // escape
2491 result.key = '\x1b';
2492 result.cancel = true;
2493 break;
2494 case 37:
2495 // left-arrow
2496 if (modifiers) {
2497 result.key = '\x1b[1;' + (modifiers + 1) + 'D';
2498 // HACK: Make Alt + left-arrow behave like Ctrl + left-arrow: move one word backwards
2499 // http://unix.stackexchange.com/a/108106
2500 if (result.key == '\x1b[1;3D') {
2501 result.key = '\x1b[1;5D';
2502 }
2503 } else if (this.applicationCursor) {
2504 result.key = '\x1bOD';
2505 } else {
2506 result.key = '\x1b[D';
2507 }
2508 break;
2509 case 39:
2510 // right-arrow
2511 if (modifiers) {
2512 result.key = '\x1b[1;' + (modifiers + 1) + 'C';
2513 // HACK: Make Alt + right-arrow behave like Ctrl + right-arrow: move one word forward
2514 // http://unix.stackexchange.com/a/108106
2515 if (result.key == '\x1b[1;3C') {
2516 result.key = '\x1b[1;5C';
2517 }
2518 } else if (this.applicationCursor) {
2519 result.key = '\x1bOC';
2520 } else {
2521 result.key = '\x1b[C';
2522 }
2523 break;
2524 case 38:
2525 // up-arrow
2526 if (modifiers) {
2527 result.key = '\x1b[1;' + (modifiers + 1) + 'A';
2528 // HACK: Make Alt + up-arrow behave like Ctrl + up-arrow
2529 // http://unix.stackexchange.com/a/108106
2530 if (result.key == '\x1b[1;3A') {
2531 result.key = '\x1b[1;5A';
2532 }
2533 } else if (this.applicationCursor) {
2534 result.key = '\x1bOA';
2535 } else {
2536 result.key = '\x1b[A';
2537 }
2538 break;
2539 case 40:
2540 // down-arrow
2541 if (modifiers) {
2542 result.key = '\x1b[1;' + (modifiers + 1) + 'B';
2543 // HACK: Make Alt + down-arrow behave like Ctrl + down-arrow
2544 // http://unix.stackexchange.com/a/108106
2545 if (result.key == '\x1b[1;3B') {
2546 result.key = '\x1b[1;5B';
2547 }
2548 } else if (this.applicationCursor) {
2549 result.key = '\x1bOB';
2550 } else {
2551 result.key = '\x1b[B';
2552 }
2553 break;
2554 case 45:
2555 // insert
2556 if (!ev.shiftKey && !ev.ctrlKey) {
2557 // <Ctrl> or <Shift> + <Insert> are used to
2558 // copy-paste on some systems.
2559 result.key = '\x1b[2~';
2560 }
2561 break;
2562 case 46:
2563 // delete
2564 if (modifiers) {
2565 result.key = '\x1b[3;' + (modifiers + 1) + '~';
2566 } else {
2567 result.key = '\x1b[3~';
2568 }
2569 break;
2570 case 36:
2571 // home
2572 if (modifiers)
2573 result.key = '\x1b[1;' + (modifiers + 1) + 'H';
2574 else if (this.applicationCursor)
2575 result.key = '\x1bOH';
2576 else
2577 result.key = '\x1b[H';
2578 break;
2579 case 35:
2580 // end
2581 if (modifiers)
2582 result.key = '\x1b[1;' + (modifiers + 1) + 'F';
2583 else if (this.applicationCursor)
2584 result.key = '\x1bOF';
2585 else
2586 result.key = '\x1b[F';
2587 break;
2588 case 33:
2589 // page up
2590 if (ev.shiftKey) {
2591 result.scrollDisp = -(this.rows - 1);
2592 } else {
2593 result.key = '\x1b[5~';
2594 }
2595 break;
2596 case 34:
2597 // page down
2598 if (ev.shiftKey) {
2599 result.scrollDisp = this.rows - 1;
2600 } else {
2601 result.key = '\x1b[6~';
2602 }
2603 break;
2604 case 112:
2605 // F1-F12
2606 if (modifiers) {
2607 result.key = '\x1b[1;' + (modifiers + 1) + 'P';
2608 } else {
2609 result.key = '\x1bOP';
2610 }
2611 break;
2612 case 113:
2613 if (modifiers) {
2614 result.key = '\x1b[1;' + (modifiers + 1) + 'Q';
2615 } else {
2616 result.key = '\x1bOQ';
2617 }
2618 break;
2619 case 114:
2620 if (modifiers) {
2621 result.key = '\x1b[1;' + (modifiers + 1) + 'R';
2622 } else {
2623 result.key = '\x1bOR';
2624 }
2625 break;
2626 case 115:
2627 if (modifiers) {
2628 result.key = '\x1b[1;' + (modifiers + 1) + 'S';
2629 } else {
2630 result.key = '\x1bOS';
2631 }
2632 break;
2633 case 116:
2634 if (modifiers) {
2635 result.key = '\x1b[15;' + (modifiers + 1) + '~';
2636 } else {
2637 result.key = '\x1b[15~';
2638 }
2639 break;
2640 case 117:
2641 if (modifiers) {
2642 result.key = '\x1b[17;' + (modifiers + 1) + '~';
2643 } else {
2644 result.key = '\x1b[17~';
2645 }
2646 break;
2647 case 118:
2648 if (modifiers) {
2649 result.key = '\x1b[18;' + (modifiers + 1) + '~';
2650 } else {
2651 result.key = '\x1b[18~';
2652 }
2653 break;
2654 case 119:
2655 if (modifiers) {
2656 result.key = '\x1b[19;' + (modifiers + 1) + '~';
2657 } else {
2658 result.key = '\x1b[19~';
2659 }
2660 break;
2661 case 120:
2662 if (modifiers) {
2663 result.key = '\x1b[20;' + (modifiers + 1) + '~';
2664 } else {
2665 result.key = '\x1b[20~';
2666 }
2667 break;
2668 case 121:
2669 if (modifiers) {
2670 result.key = '\x1b[21;' + (modifiers + 1) + '~';
2671 } else {
2672 result.key = '\x1b[21~';
2673 }
2674 break;
2675 case 122:
2676 if (modifiers) {
2677 result.key = '\x1b[23;' + (modifiers + 1) + '~';
2678 } else {
2679 result.key = '\x1b[23~';
2680 }
2681 break;
2682 case 123:
2683 if (modifiers) {
2684 result.key = '\x1b[24;' + (modifiers + 1) + '~';
2685 } else {
2686 result.key = '\x1b[24~';
2687 }
2688 break;
2689 default:
2690 // a-z and space
2691 if (ev.ctrlKey && !ev.shiftKey && !ev.altKey && !ev.metaKey) {
2692 if (ev.keyCode >= 65 && ev.keyCode <= 90) {
2693 result.key = String.fromCharCode(ev.keyCode - 64);
2694 } else if (ev.keyCode === 32) {
2695 // NUL
2696 result.key = String.fromCharCode(0);
2697 } else if (ev.keyCode >= 51 && ev.keyCode <= 55) {
2698 // escape, file sep, group sep, record sep, unit sep
2699 result.key = String.fromCharCode(ev.keyCode - 51 + 27);
2700 } else if (ev.keyCode === 56) {
2701 // delete
2702 result.key = String.fromCharCode(127);
2703 } else if (ev.keyCode === 219) {
2704 // ^[ - Control Sequence Introducer (CSI)
2705 result.key = String.fromCharCode(27);
2706 } else if (ev.keyCode === 220) {
2707 // ^\ - String Terminator (ST)
2708 result.key = String.fromCharCode(28);
2709 } else if (ev.keyCode === 221) {
2710 // ^] - Operating System Command (OSC)
2711 result.key = String.fromCharCode(29);
2712 }
2713 } else if (!this.browser.isMac && ev.altKey && !ev.ctrlKey && !ev.metaKey) {
2714 // On Mac this is a third level shift. Use <Esc> instead.
2715 if (ev.keyCode >= 65 && ev.keyCode <= 90) {
2716 result.key = '\x1b' + String.fromCharCode(ev.keyCode + 32);
2717 } else if (ev.keyCode === 192) {
2718 result.key = '\x1b`';
2719 } else if (ev.keyCode >= 48 && ev.keyCode <= 57) {
2720 result.key = '\x1b' + (ev.keyCode - 48);
2721 }
2722 }
2723 break;
2724 }
2725 return result;
2726 };
2727
2728 /**
2729 * Set the G level of the terminal
2730 * @param g
2731 */
2732 Terminal.prototype.setgLevel = function(g) {
2733 this.glevel = g;
2734 this.charset = this.charsets[g];
2735 };
2736
2737 /**
2738 * Set the charset for the given G level of the terminal
2739 * @param g
2740 * @param charset
2741 */
2742 Terminal.prototype.setgCharset = function(g, charset) {
2743 this.charsets[g] = charset;
2744 if (this.glevel === g) {
2745 this.charset = charset;
2746 }
2747 };
2748
2749 /**
2750 * Handle a keypress event.
2751 * Key Resources:
2752 * - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent
2753 * @param {KeyboardEvent} ev The keypress event to be handled.
2754 */
2755 Terminal.prototype.keyPress = function(ev) {
2756 var key;
2757
2758 this.cancel(ev);
2759
2760 if (ev.charCode) {
2761 key = ev.charCode;
2762 } else if (ev.which == null) {
2763 key = ev.keyCode;
2764 } else if (ev.which !== 0 && ev.charCode !== 0) {
2765 key = ev.which;
2766 } else {
2767 return false;
2768 }
2769
2770 if (!key || (
2771 (ev.altKey || ev.ctrlKey || ev.metaKey) && !isThirdLevelShift(this, ev)
2772 )) {
2773 return false;
2774 }
2775
2776 key = String.fromCharCode(key);
2777
2778 this.emit('keypress', key, ev);
2779 this.emit('key', key, ev);
2780 this.showCursor();
2781 this.handler(key);
2782
2783 return false;
2784 };
2785
2786 /**
2787 * Send data for handling to the terminal
2788 * @param {string} data
2789 */
2790 Terminal.prototype.send = function(data) {
2791 var self = this;
2792
2793 if (!this.queue) {
2794 setTimeout(function() {
2795 self.handler(self.queue);
2796 self.queue = '';
2797 }, 1);
2798 }
2799
2800 this.queue += data;
2801 };
2802
2803 /**
2804 * Ring the bell.
2805 * Note: We could do sweet things with webaudio here
2806 */
2807 Terminal.prototype.bell = function() {
2808 if (!this.visualBell) return;
2809 var self = this;
2810 this.element.style.borderColor = 'white';
2811 setTimeout(function() {
2812 self.element.style.borderColor = '';
2813 }, 10);
2814 if (this.popOnBell) this.focus();
2815 };
2816
2817 /**
2818 * Log the current state to the console.
2819 */
2820 Terminal.prototype.log = function() {
2821 if (!this.debug) return;
2822 if (!this.context.console || !this.context.console.log) return;
2823 var args = Array.prototype.slice.call(arguments);
2824 this.context.console.log.apply(this.context.console, args);
2825 };
2826
2827 /**
2828 * Log the current state as error to the console.
2829 */
2830 Terminal.prototype.error = function() {
2831 if (!this.debug) return;
2832 if (!this.context.console || !this.context.console.error) return;
2833 var args = Array.prototype.slice.call(arguments);
2834 this.context.console.error.apply(this.context.console, args);
2835 };
2836
2837 /**
2838 * Resizes the terminal.
2839 *
2840 * @param {number} x The number of columns to resize to.
2841 * @param {number} y The number of rows to resize to.
2842 */
2843 Terminal.prototype.resize = function(x, y) {
2844 var line
2845 , el
2846 , i
2847 , j
2848 , ch
2849 , addToY;
2850
2851 if (x === this.cols && y === this.rows) {
2852 return;
2853 }
2854
2855 if (x < 1) x = 1;
2856 if (y < 1) y = 1;
2857
2858 // resize cols
2859 j = this.cols;
2860 if (j < x) {
2861 ch = [this.defAttr, ' ', 1]; // does xterm use the default attr?
2862 i = this.lines.length;
2863 while (i--) {
2864 while (this.lines.get(i).length < x) {
2865 this.lines.get(i).push(ch);
2866 }
2867 }
2868 } else { // (j > x)
2869 i = this.lines.length;
2870 while (i--) {
2871 while (this.lines.get(i).length > x) {
2872 this.lines.get(i).pop();
2873 }
2874 }
2875 }
2876 this.setupStops(j);
2877 this.cols = x;
2878
2879 // resize rows
2880 j = this.rows;
2881 addToY = 0;
2882 if (j < y) {
2883 el = this.element;
2884 while (j++ < y) {
2885 // y is rows, not this.y
2886 if (this.lines.length < y + this.ybase) {
2887 if (this.ybase > 0 && this.lines.length <= this.ybase + this.y + addToY + 1) {
2888 // There is room above the buffer and there are no empty elements below the line,
2889 // scroll up
2890 this.ybase--;
2891 addToY++
2892 if (this.ydisp > 0) {
2893 // Viewport is at the top of the buffer, must increase downwards
2894 this.ydisp--;
2895 }
2896 } else {
2897 // Add a blank line if there is no buffer left at the top to scroll to, or if there
2898 // are blank lines after the cursor
2899 this.lines.push(this.blankLine());
2900 }
2901 }
2902 if (this.children.length < y) {
2903 this.insertRow();
2904 }
2905 }
2906 } else { // (j > y)
2907 while (j-- > y) {
2908 if (this.lines.length > y + this.ybase) {
2909 if (this.lines.length > this.ybase + this.y + 1) {
2910 // The line is a blank line below the cursor, remove it
2911 this.lines.pop();
2912 } else {
2913 // The line is the cursor, scroll down
2914 this.ybase++;
2915 this.ydisp++;
2916 }
2917 }
2918 if (this.children.length > y) {
2919 el = this.children.shift();
2920 if (!el) continue;
2921 el.parentNode.removeChild(el);
2922 }
2923 }
2924 }
2925 this.rows = y;
2926
2927 // Make sure that the cursor stays on screen
2928 if (this.y >= y) {
2929 this.y = y - 1;
2930 }
2931 if (addToY) {
2932 this.y += addToY;
2933 }
2934
2935 if (this.x >= x) {
2936 this.x = x - 1;
2937 }
2938
2939 this.scrollTop = 0;
2940 this.scrollBottom = y - 1;
2941
2942 this.refresh(0, this.rows - 1);
2943
2944 this.normal = null;
2945
2946 this.geometry = [this.cols, this.rows];
2947 this.emit('resize', {terminal: this, cols: x, rows: y});
2948 };
2949
2950 /**
2951 * Updates the range of rows to refresh
2952 * @param {number} y The number of rows to refresh next.
2953 */
2954 Terminal.prototype.updateRange = function(y) {
2955 if (y < this.refreshStart) this.refreshStart = y;
2956 if (y > this.refreshEnd) this.refreshEnd = y;
2957 // if (y > this.refreshEnd) {
2958 // this.refreshEnd = y;
2959 // if (y > this.rows - 1) {
2960 // this.refreshEnd = this.rows - 1;
2961 // }
2962 // }
2963 };
2964
2965 /**
2966 * Set the range of refreshing to the maximum value
2967 */
2968 Terminal.prototype.maxRange = function() {
2969 this.refreshStart = 0;
2970 this.refreshEnd = this.rows - 1;
2971 };
2972
2973
2974
2975 /**
2976 * Setup the tab stops.
2977 * @param {number} i
2978 */
2979 Terminal.prototype.setupStops = function(i) {
2980 if (i != null) {
2981 if (!this.tabs[i]) {
2982 i = this.prevStop(i);
2983 }
2984 } else {
2985 this.tabs = {};
2986 i = 0;
2987 }
2988
2989 for (; i < this.cols; i += 8) {
2990 this.tabs[i] = true;
2991 }
2992 };
2993
2994
2995 /**
2996 * Move the cursor to the previous tab stop from the given position (default is current).
2997 * @param {number} x The position to move the cursor to the previous tab stop.
2998 */
2999 Terminal.prototype.prevStop = function(x) {
3000 if (x == null) x = this.x;
3001 while (!this.tabs[--x] && x > 0);
3002 return x >= this.cols
3003 ? this.cols - 1
3004 : x < 0 ? 0 : x;
3005 };
3006
3007
3008 /**
3009 * Move the cursor one tab stop forward from the given position (default is current).
3010 * @param {number} x The position to move the cursor one tab stop forward.
3011 */
3012 Terminal.prototype.nextStop = function(x) {
3013 if (x == null) x = this.x;
3014 while (!this.tabs[++x] && x < this.cols);
3015 return x >= this.cols
3016 ? this.cols - 1
3017 : x < 0 ? 0 : x;
3018 };
3019
3020
3021 /**
3022 * Erase in the identified line everything from "x" to the end of the line (right).
3023 * @param {number} x The column from which to start erasing to the end of the line.
3024 * @param {number} y The line in which to operate.
3025 */
3026 Terminal.prototype.eraseRight = function(x, y) {
3027 var line = this.lines.get(this.ybase + y)
3028 , ch = [this.eraseAttr(), ' ', 1]; // xterm
3029
3030
3031 for (; x < this.cols; x++) {
3032 line[x] = ch;
3033 }
3034
3035 this.updateRange(y);
3036 };
3037
3038
3039
3040 /**
3041 * Erase in the identified line everything from "x" to the start of the line (left).
3042 * @param {number} x The column from which to start erasing to the start of the line.
3043 * @param {number} y The line in which to operate.
3044 */
3045 Terminal.prototype.eraseLeft = function(x, y) {
3046 var line = this.lines.get(this.ybase + y)
3047 , ch = [this.eraseAttr(), ' ', 1]; // xterm
3048
3049 x++;
3050 while (x--) line[x] = ch;
3051
3052 this.updateRange(y);
3053 };
3054
3055 /**
3056 * Clears the entire buffer, making the prompt line the new first line.
3057 */
3058 Terminal.prototype.clear = function() {
3059 if (this.ybase === 0 && this.y === 0) {
3060 // Don't clear if it's already clear
3061 return;
3062 }
3063 this.lines.set(0, this.lines.get(this.ybase + this.y));
3064 this.lines.length = 1;
3065 this.ydisp = 0;
3066 this.ybase = 0;
3067 this.y = 0;
3068 for (var i = 1; i < this.rows; i++) {
3069 this.lines.push(this.blankLine());
3070 }
3071 this.refresh(0, this.rows - 1);
3072 this.emit('scroll', this.ydisp);
3073 };
3074
3075 /**
3076 * Erase all content in the given line
3077 * @param {number} y The line to erase all of its contents.
3078 */
3079 Terminal.prototype.eraseLine = function(y) {
3080 this.eraseRight(0, y);
3081 };
3082
3083
3084 /**
3085 * Return the data array of a blank line/
3086 * @param {number} cur First bunch of data for each "blank" character.
3087 */
3088 Terminal.prototype.blankLine = function(cur) {
3089 var attr = cur
3090 ? this.eraseAttr()
3091 : this.defAttr;
3092
3093 var ch = [attr, ' ', 1] // width defaults to 1 halfwidth character
3094 , line = []
3095 , i = 0;
3096
3097 for (; i < this.cols; i++) {
3098 line[i] = ch;
3099 }
3100
3101 return line;
3102 };
3103
3104
3105 /**
3106 * If cur return the back color xterm feature attribute. Else return defAttr.
3107 * @param {object} cur
3108 */
3109 Terminal.prototype.ch = function(cur) {
3110 return cur
3111 ? [this.eraseAttr(), ' ', 1]
3112 : [this.defAttr, ' ', 1];
3113 };
3114
3115
3116 /**
3117 * Evaluate if the current erminal is the given argument.
3118 * @param {object} term The terminal to evaluate
3119 */
3120 Terminal.prototype.is = function(term) {
3121 var name = this.termName;
3122 return (name + '').indexOf(term) === 0;
3123 };
3124
3125
3126 /**
3127 * Emit the 'data' event and populate the given data.
3128 * @param {string} data The data to populate in the event.
3129 */
3130 Terminal.prototype.handler = function(data) {
3131 // Input is being sent to the terminal, the terminal should focus the prompt.
3132 if (this.ybase !== this.ydisp) {
3133 this.scrollToBottom();
3134 }
3135 this.emit('data', data);
3136 };
3137
3138
3139 /**
3140 * Emit the 'title' event and populate the given title.
3141 * @param {string} title The title to populate in the event.
3142 */
3143 Terminal.prototype.handleTitle = function(title) {
3144 /**
3145 * This event is emitted when the title of the terminal is changed
3146 * from inside the terminal. The parameter is the new title.
3147 *
3148 * @event title
3149 */
3150 this.emit('title', title);
3151 };
3152
3153
3154 /**
3155 * ESC
3156 */
3157
3158 /**
3159 * ESC D Index (IND is 0x84).
3160 */
3161 Terminal.prototype.index = function() {
3162 this.y++;
3163 if (this.y > this.scrollBottom) {
3164 this.y--;
3165 this.scroll();
3166 }
3167 this.state = normal;
3168 };
3169
3170
3171 /**
3172 * ESC M Reverse Index (RI is 0x8d).
3173 */
3174 Terminal.prototype.reverseIndex = function() {
3175 var j;
3176 this.y--;
3177 if (this.y < this.scrollTop) {
3178 this.y++;
3179 // possibly move the code below to term.reverseScroll();
3180 // test: echo -ne '\e[1;1H\e[44m\eM\e[0m'
3181 // blankLine(true) is xterm/linux behavior
3182 this.lines.splice(this.y + this.ybase, 0, this.blankLine(true));
3183 j = this.rows - 1 - this.scrollBottom;
3184 this.lines.splice(this.rows - 1 + this.ybase - j + 1, 1);
3185 // this.maxRange();
3186 this.updateRange(this.scrollTop);
3187 this.updateRange(this.scrollBottom);
3188 }
3189 this.state = normal;
3190 };
3191
3192
3193 /**
3194 * ESC c Full Reset (RIS).
3195 */
3196 Terminal.prototype.reset = function() {
3197 this.options.rows = this.rows;
3198 this.options.cols = this.cols;
3199 var customKeydownHandler = this.customKeydownHandler;
3200 Terminal.call(this, this.options);
3201 this.customKeydownHandler = customKeydownHandler;
3202 this.refresh(0, this.rows - 1);
3203 this.viewport.syncScrollArea();
3204 };
3205
3206
3207 /**
3208 * ESC H Tab Set (HTS is 0x88).
3209 */
3210 Terminal.prototype.tabSet = function() {
3211 this.tabs[this.x] = true;
3212 this.state = normal;
3213 };
3214
3215
3216 /**
3217 * CSI
3218 */
3219
3220 /**
3221 * CSI Ps A
3222 * Cursor Up Ps Times (default = 1) (CUU).
3223 */
3224 Terminal.prototype.cursorUp = function(params) {
3225 var param = params[0];
3226 if (param < 1) param = 1;
3227 this.y -= param;
3228 if (this.y < 0) this.y = 0;
3229 };
3230
3231
3232 /**
3233 * CSI Ps B
3234 * Cursor Down Ps Times (default = 1) (CUD).
3235 */
3236 Terminal.prototype.cursorDown = function(params) {
3237 var param = params[0];
3238 if (param < 1) param = 1;
3239 this.y += param;
3240 if (this.y >= this.rows) {
3241 this.y = this.rows - 1;
3242 }
3243 };
3244
3245
3246 /**
3247 * CSI Ps C
3248 * Cursor Forward Ps Times (default = 1) (CUF).
3249 */
3250 Terminal.prototype.cursorForward = function(params) {
3251 var param = params[0];
3252 if (param < 1) param = 1;
3253 this.x += param;
3254 if (this.x >= this.cols) {
3255 this.x = this.cols - 1;
3256 }
3257 };
3258
3259
3260 /**
3261 * CSI Ps D
3262 * Cursor Backward Ps Times (default = 1) (CUB).
3263 */
3264 Terminal.prototype.cursorBackward = function(params) {
3265 var param = params[0];
3266 if (param < 1) param = 1;
3267 this.x -= param;
3268 if (this.x < 0) this.x = 0;
3269 };
3270
3271
3272 /**
3273 * CSI Ps ; Ps H
3274 * Cursor Position [row;column] (default = [1,1]) (CUP).
3275 */
3276 Terminal.prototype.cursorPos = function(params) {
3277 var row, col;
3278
3279 row = params[0] - 1;
3280
3281 if (params.length >= 2) {
3282 col = params[1] - 1;
3283 } else {
3284 col = 0;
3285 }
3286
3287 if (row < 0) {
3288 row = 0;
3289 } else if (row >= this.rows) {
3290 row = this.rows - 1;
3291 }
3292
3293 if (col < 0) {
3294 col = 0;
3295 } else if (col >= this.cols) {
3296 col = this.cols - 1;
3297 }
3298
3299 this.x = col;
3300 this.y = row;
3301 };
3302
3303
3304 /**
3305 * CSI Ps J Erase in Display (ED).
3306 * Ps = 0 -> Erase Below (default).
3307 * Ps = 1 -> Erase Above.
3308 * Ps = 2 -> Erase All.
3309 * Ps = 3 -> Erase Saved Lines (xterm).
3310 * CSI ? Ps J
3311 * Erase in Display (DECSED).
3312 * Ps = 0 -> Selective Erase Below (default).
3313 * Ps = 1 -> Selective Erase Above.
3314 * Ps = 2 -> Selective Erase All.
3315 */
3316 Terminal.prototype.eraseInDisplay = function(params) {
3317 var j;
3318 switch (params[0]) {
3319 case 0:
3320 this.eraseRight(this.x, this.y);
3321 j = this.y + 1;
3322 for (; j < this.rows; j++) {
3323 this.eraseLine(j);
3324 }
3325 break;
3326 case 1:
3327 this.eraseLeft(this.x, this.y);
3328 j = this.y;
3329 while (j--) {
3330 this.eraseLine(j);
3331 }
3332 break;
3333 case 2:
3334 j = this.rows;
3335 while (j--) this.eraseLine(j);
3336 break;
3337 case 3:
3338 ; // no saved lines
3339 break;
3340 }
3341 };
3342
3343
3344 /**
3345 * CSI Ps K Erase in Line (EL).
3346 * Ps = 0 -> Erase to Right (default).
3347 * Ps = 1 -> Erase to Left.
3348 * Ps = 2 -> Erase All.
3349 * CSI ? Ps K
3350 * Erase in Line (DECSEL).
3351 * Ps = 0 -> Selective Erase to Right (default).
3352 * Ps = 1 -> Selective Erase to Left.
3353 * Ps = 2 -> Selective Erase All.
3354 */
3355 Terminal.prototype.eraseInLine = function(params) {
3356 switch (params[0]) {
3357 case 0:
3358 this.eraseRight(this.x, this.y);
3359 break;
3360 case 1:
3361 this.eraseLeft(this.x, this.y);
3362 break;
3363 case 2:
3364 this.eraseLine(this.y);
3365 break;
3366 }
3367 };
3368
3369
3370 /**
3371 * CSI Pm m Character Attributes (SGR).
3372 * Ps = 0 -> Normal (default).
3373 * Ps = 1 -> Bold.
3374 * Ps = 4 -> Underlined.
3375 * Ps = 5 -> Blink (appears as Bold).
3376 * Ps = 7 -> Inverse.
3377 * Ps = 8 -> Invisible, i.e., hidden (VT300).
3378 * Ps = 2 2 -> Normal (neither bold nor faint).
3379 * Ps = 2 4 -> Not underlined.
3380 * Ps = 2 5 -> Steady (not blinking).
3381 * Ps = 2 7 -> Positive (not inverse).
3382 * Ps = 2 8 -> Visible, i.e., not hidden (VT300).
3383 * Ps = 3 0 -> Set foreground color to Black.
3384 * Ps = 3 1 -> Set foreground color to Red.
3385 * Ps = 3 2 -> Set foreground color to Green.
3386 * Ps = 3 3 -> Set foreground color to Yellow.
3387 * Ps = 3 4 -> Set foreground color to Blue.
3388 * Ps = 3 5 -> Set foreground color to Magenta.
3389 * Ps = 3 6 -> Set foreground color to Cyan.
3390 * Ps = 3 7 -> Set foreground color to White.
3391 * Ps = 3 9 -> Set foreground color to default (original).
3392 * Ps = 4 0 -> Set background color to Black.
3393 * Ps = 4 1 -> Set background color to Red.
3394 * Ps = 4 2 -> Set background color to Green.
3395 * Ps = 4 3 -> Set background color to Yellow.
3396 * Ps = 4 4 -> Set background color to Blue.
3397 * Ps = 4 5 -> Set background color to Magenta.
3398 * Ps = 4 6 -> Set background color to Cyan.
3399 * Ps = 4 7 -> Set background color to White.
3400 * Ps = 4 9 -> Set background color to default (original).
3401 *
3402 * If 16-color support is compiled, the following apply. Assume
3403 * that xterm's resources are set so that the ISO color codes are
3404 * the first 8 of a set of 16. Then the aixterm colors are the
3405 * bright versions of the ISO colors:
3406 * Ps = 9 0 -> Set foreground color to Black.
3407 * Ps = 9 1 -> Set foreground color to Red.
3408 * Ps = 9 2 -> Set foreground color to Green.
3409 * Ps = 9 3 -> Set foreground color to Yellow.
3410 * Ps = 9 4 -> Set foreground color to Blue.
3411 * Ps = 9 5 -> Set foreground color to Magenta.
3412 * Ps = 9 6 -> Set foreground color to Cyan.
3413 * Ps = 9 7 -> Set foreground color to White.
3414 * Ps = 1 0 0 -> Set background color to Black.
3415 * Ps = 1 0 1 -> Set background color to Red.
3416 * Ps = 1 0 2 -> Set background color to Green.
3417 * Ps = 1 0 3 -> Set background color to Yellow.
3418 * Ps = 1 0 4 -> Set background color to Blue.
3419 * Ps = 1 0 5 -> Set background color to Magenta.
3420 * Ps = 1 0 6 -> Set background color to Cyan.
3421 * Ps = 1 0 7 -> Set background color to White.
3422 *
3423 * If xterm is compiled with the 16-color support disabled, it
3424 * supports the following, from rxvt:
3425 * Ps = 1 0 0 -> Set foreground and background color to
3426 * default.
3427 *
3428 * If 88- or 256-color support is compiled, the following apply.
3429 * Ps = 3 8 ; 5 ; Ps -> Set foreground color to the second
3430 * Ps.
3431 * Ps = 4 8 ; 5 ; Ps -> Set background color to the second
3432 * Ps.
3433 */
3434 Terminal.prototype.charAttributes = function(params) {
3435 // Optimize a single SGR0.
3436 if (params.length === 1 && params[0] === 0) {
3437 this.curAttr = this.defAttr;
3438 return;
3439 }
3440
3441 var l = params.length
3442 , i = 0
3443 , flags = this.curAttr >> 18
3444 , fg = (this.curAttr >> 9) & 0x1ff
3445 , bg = this.curAttr & 0x1ff
3446 , p;
3447
3448 for (; i < l; i++) {
3449 p = params[i];
3450 if (p >= 30 && p <= 37) {
3451 // fg color 8
3452 fg = p - 30;
3453 } else if (p >= 40 && p <= 47) {
3454 // bg color 8
3455 bg = p - 40;
3456 } else if (p >= 90 && p <= 97) {
3457 // fg color 16
3458 p += 8;
3459 fg = p - 90;
3460 } else if (p >= 100 && p <= 107) {
3461 // bg color 16
3462 p += 8;
3463 bg = p - 100;
3464 } else if (p === 0) {
3465 // default
3466 flags = this.defAttr >> 18;
3467 fg = (this.defAttr >> 9) & 0x1ff;
3468 bg = this.defAttr & 0x1ff;
3469 // flags = 0;
3470 // fg = 0x1ff;
3471 // bg = 0x1ff;
3472 } else if (p === 1) {
3473 // bold text
3474 flags |= 1;
3475 } else if (p === 4) {
3476 // underlined text
3477 flags |= 2;
3478 } else if (p === 5) {
3479 // blink
3480 flags |= 4;
3481 } else if (p === 7) {
3482 // inverse and positive
3483 // test with: echo -e '\e[31m\e[42mhello\e[7mworld\e[27mhi\e[m'
3484 flags |= 8;
3485 } else if (p === 8) {
3486 // invisible
3487 flags |= 16;
3488 } else if (p === 22) {
3489 // not bold
3490 flags &= ~1;
3491 } else if (p === 24) {
3492 // not underlined
3493 flags &= ~2;
3494 } else if (p === 25) {
3495 // not blink
3496 flags &= ~4;
3497 } else if (p === 27) {
3498 // not inverse
3499 flags &= ~8;
3500 } else if (p === 28) {
3501 // not invisible
3502 flags &= ~16;
3503 } else if (p === 39) {
3504 // reset fg
3505 fg = (this.defAttr >> 9) & 0x1ff;
3506 } else if (p === 49) {
3507 // reset bg
3508 bg = this.defAttr & 0x1ff;
3509 } else if (p === 38) {
3510 // fg color 256
3511 if (params[i + 1] === 2) {
3512 i += 2;
3513 fg = matchColor(
3514 params[i] & 0xff,
3515 params[i + 1] & 0xff,
3516 params[i + 2] & 0xff);
3517 if (fg === -1) fg = 0x1ff;
3518 i += 2;
3519 } else if (params[i + 1] === 5) {
3520 i += 2;
3521 p = params[i] & 0xff;
3522 fg = p;
3523 }
3524 } else if (p === 48) {
3525 // bg color 256
3526 if (params[i + 1] === 2) {
3527 i += 2;
3528 bg = matchColor(
3529 params[i] & 0xff,
3530 params[i + 1] & 0xff,
3531 params[i + 2] & 0xff);
3532 if (bg === -1) bg = 0x1ff;
3533 i += 2;
3534 } else if (params[i + 1] === 5) {
3535 i += 2;
3536 p = params[i] & 0xff;
3537 bg = p;
3538 }
3539 } else if (p === 100) {
3540 // reset fg/bg
3541 fg = (this.defAttr >> 9) & 0x1ff;
3542 bg = this.defAttr & 0x1ff;
3543 } else {
3544 this.error('Unknown SGR attribute: %d.', p);
3545 }
3546 }
3547
3548 this.curAttr = (flags << 18) | (fg << 9) | bg;
3549 };
3550
3551
3552 /**
3553 * CSI Ps n Device Status Report (DSR).
3554 * Ps = 5 -> Status Report. Result (``OK'') is
3555 * CSI 0 n
3556 * Ps = 6 -> Report Cursor Position (CPR) [row;column].
3557 * Result is
3558 * CSI r ; c R
3559 * CSI ? Ps n
3560 * Device Status Report (DSR, DEC-specific).
3561 * Ps = 6 -> Report Cursor Position (CPR) [row;column] as CSI
3562 * ? r ; c R (assumes page is zero).
3563 * Ps = 1 5 -> Report Printer status as CSI ? 1 0 n (ready).
3564 * or CSI ? 1 1 n (not ready).
3565 * Ps = 2 5 -> Report UDK status as CSI ? 2 0 n (unlocked)
3566 * or CSI ? 2 1 n (locked).
3567 * Ps = 2 6 -> Report Keyboard status as
3568 * CSI ? 2 7 ; 1 ; 0 ; 0 n (North American).
3569 * The last two parameters apply to VT400 & up, and denote key-
3570 * board ready and LK01 respectively.
3571 * Ps = 5 3 -> Report Locator status as
3572 * CSI ? 5 3 n Locator available, if compiled-in, or
3573 * CSI ? 5 0 n No Locator, if not.
3574 */
3575 Terminal.prototype.deviceStatus = function(params) {
3576 if (!this.prefix) {
3577 switch (params[0]) {
3578 case 5:
3579 // status report
3580 this.send('\x1b[0n');
3581 break;
3582 case 6:
3583 // cursor position
3584 this.send('\x1b['
3585 + (this.y + 1)
3586 + ';'
3587 + (this.x + 1)
3588 + 'R');
3589 break;
3590 }
3591 } else if (this.prefix === '?') {
3592 // modern xterm doesnt seem to
3593 // respond to any of these except ?6, 6, and 5
3594 switch (params[0]) {
3595 case 6:
3596 // cursor position
3597 this.send('\x1b[?'
3598 + (this.y + 1)
3599 + ';'
3600 + (this.x + 1)
3601 + 'R');
3602 break;
3603 case 15:
3604 // no printer
3605 // this.send('\x1b[?11n');
3606 break;
3607 case 25:
3608 // dont support user defined keys
3609 // this.send('\x1b[?21n');
3610 break;
3611 case 26:
3612 // north american keyboard
3613 // this.send('\x1b[?27;1;0;0n');
3614 break;
3615 case 53:
3616 // no dec locator/mouse
3617 // this.send('\x1b[?50n');
3618 break;
3619 }
3620 }
3621 };
3622
3623
3624 /**
3625 * Additions
3626 */
3627
3628 /**
3629 * CSI Ps @
3630 * Insert Ps (Blank) Character(s) (default = 1) (ICH).
3631 */
3632 Terminal.prototype.insertChars = function(params) {
3633 var param, row, j, ch;
3634
3635 param = params[0];
3636 if (param < 1) param = 1;
3637
3638 row = this.y + this.ybase;
3639 j = this.x;
3640 ch = [this.eraseAttr(), ' ', 1]; // xterm
3641
3642 while (param-- && j < this.cols) {
3643 this.lines.get(row).splice(j++, 0, ch);
3644 this.lines.get(row).pop();
3645 }
3646 };
3647
3648 /**
3649 * CSI Ps E
3650 * Cursor Next Line Ps Times (default = 1) (CNL).
3651 * same as CSI Ps B ?
3652 */
3653 Terminal.prototype.cursorNextLine = function(params) {
3654 var param = params[0];
3655 if (param < 1) param = 1;
3656 this.y += param;
3657 if (this.y >= this.rows) {
3658 this.y = this.rows - 1;
3659 }
3660 this.x = 0;
3661 };
3662
3663
3664 /**
3665 * CSI Ps F
3666 * Cursor Preceding Line Ps Times (default = 1) (CNL).
3667 * reuse CSI Ps A ?
3668 */
3669 Terminal.prototype.cursorPrecedingLine = function(params) {
3670 var param = params[0];
3671 if (param < 1) param = 1;
3672 this.y -= param;
3673 if (this.y < 0) this.y = 0;
3674 this.x = 0;
3675 };
3676
3677
3678 /**
3679 * CSI Ps G
3680 * Cursor Character Absolute [column] (default = [row,1]) (CHA).
3681 */
3682 Terminal.prototype.cursorCharAbsolute = function(params) {
3683 var param = params[0];
3684 if (param < 1) param = 1;
3685 this.x = param - 1;
3686 };
3687
3688
3689 /**
3690 * CSI Ps L
3691 * Insert Ps Line(s) (default = 1) (IL).
3692 */
3693 Terminal.prototype.insertLines = function(params) {
3694 var param, row, j;
3695
3696 param = params[0];
3697 if (param < 1) param = 1;
3698 row = this.y + this.ybase;
3699
3700 j = this.rows - 1 - this.scrollBottom;
3701 j = this.rows - 1 + this.ybase - j + 1;
3702
3703 while (param--) {
3704 // test: echo -e '\e[44m\e[1L\e[0m'
3705 // blankLine(true) - xterm/linux behavior
3706 this.lines.splice(row, 0, this.blankLine(true));
3707 this.lines.splice(j, 1);
3708 }
3709
3710 // this.maxRange();
3711 this.updateRange(this.y);
3712 this.updateRange(this.scrollBottom);
3713 };
3714
3715
3716 /**
3717 * CSI Ps M
3718 * Delete Ps Line(s) (default = 1) (DL).
3719 */
3720 Terminal.prototype.deleteLines = function(params) {
3721 var param, row, j;
3722
3723 param = params[0];
3724 if (param < 1) param = 1;
3725 row = this.y + this.ybase;
3726
3727 j = this.rows - 1 - this.scrollBottom;
3728 j = this.rows - 1 + this.ybase - j;
3729
3730 while (param--) {
3731 // test: echo -e '\e[44m\e[1M\e[0m'
3732 // blankLine(true) - xterm/linux behavior
3733 this.lines.splice(j + 1, 0, this.blankLine(true));
3734 this.lines.splice(row, 1);
3735 }
3736
3737 // this.maxRange();
3738 this.updateRange(this.y);
3739 this.updateRange(this.scrollBottom);
3740 };
3741
3742
3743 /**
3744 * CSI Ps P
3745 * Delete Ps Character(s) (default = 1) (DCH).
3746 */
3747 Terminal.prototype.deleteChars = function(params) {
3748 var param, row, ch;
3749
3750 param = params[0];
3751 if (param < 1) param = 1;
3752
3753 row = this.y + this.ybase;
3754 ch = [this.eraseAttr(), ' ', 1]; // xterm
3755
3756 while (param--) {
3757 this.lines[row].splice(this.x, 1);
3758 this.lines[row].push(ch);
3759 }
3760 };
3761
3762 /**
3763 * CSI Ps X
3764 * Erase Ps Character(s) (default = 1) (ECH).
3765 */
3766 Terminal.prototype.eraseChars = function(params) {
3767 var param, row, j, ch;
3768
3769 param = params[0];
3770 if (param < 1) param = 1;
3771
3772 row = this.y + this.ybase;
3773 j = this.x;
3774 ch = [this.eraseAttr(), ' ', 1]; // xterm
3775
3776 while (param-- && j < this.cols) {
3777 this.lines.get(row)[j++] = ch;
3778 }
3779 };
3780
3781 /**
3782 * CSI Pm ` Character Position Absolute
3783 * [column] (default = [row,1]) (HPA).
3784 */
3785 Terminal.prototype.charPosAbsolute = function(params) {
3786 var param = params[0];
3787 if (param < 1) param = 1;
3788 this.x = param - 1;
3789 if (this.x >= this.cols) {
3790 this.x = this.cols - 1;
3791 }
3792 };
3793
3794
3795 /**
3796 * 141 61 a * HPR -
3797 * Horizontal Position Relative
3798 * reuse CSI Ps C ?
3799 */
3800 Terminal.prototype.HPositionRelative = function(params) {
3801 var param = params[0];
3802 if (param < 1) param = 1;
3803 this.x += param;
3804 if (this.x >= this.cols) {
3805 this.x = this.cols - 1;
3806 }
3807 };
3808
3809
3810 /**
3811 * CSI Ps c Send Device Attributes (Primary DA).
3812 * Ps = 0 or omitted -> request attributes from terminal. The
3813 * response depends on the decTerminalID resource setting.
3814 * -> CSI ? 1 ; 2 c (``VT100 with Advanced Video Option'')
3815 * -> CSI ? 1 ; 0 c (``VT101 with No Options'')
3816 * -> CSI ? 6 c (``VT102'')
3817 * -> CSI ? 6 0 ; 1 ; 2 ; 6 ; 8 ; 9 ; 1 5 ; c (``VT220'')
3818 * The VT100-style response parameters do not mean anything by
3819 * themselves. VT220 parameters do, telling the host what fea-
3820 * tures the terminal supports:
3821 * Ps = 1 -> 132-columns.
3822 * Ps = 2 -> Printer.
3823 * Ps = 6 -> Selective erase.
3824 * Ps = 8 -> User-defined keys.
3825 * Ps = 9 -> National replacement character sets.
3826 * Ps = 1 5 -> Technical characters.
3827 * Ps = 2 2 -> ANSI color, e.g., VT525.
3828 * Ps = 2 9 -> ANSI text locator (i.e., DEC Locator mode).
3829 * CSI > Ps c
3830 * Send Device Attributes (Secondary DA).
3831 * Ps = 0 or omitted -> request the terminal's identification
3832 * code. The response depends on the decTerminalID resource set-
3833 * ting. It should apply only to VT220 and up, but xterm extends
3834 * this to VT100.
3835 * -> CSI > Pp ; Pv ; Pc c
3836 * where Pp denotes the terminal type
3837 * Pp = 0 -> ``VT100''.
3838 * Pp = 1 -> ``VT220''.
3839 * and Pv is the firmware version (for xterm, this was originally
3840 * the XFree86 patch number, starting with 95). In a DEC termi-
3841 * nal, Pc indicates the ROM cartridge registration number and is
3842 * always zero.
3843 * More information:
3844 * xterm/charproc.c - line 2012, for more information.
3845 * vim responds with ^[[?0c or ^[[?1c after the terminal's response (?)
3846 */
3847 Terminal.prototype.sendDeviceAttributes = function(params) {
3848 if (params[0] > 0) return;
3849
3850 if (!this.prefix) {
3851 if (this.is('xterm')
3852 || this.is('rxvt-unicode')
3853 || this.is('screen')) {
3854 this.send('\x1b[?1;2c');
3855 } else if (this.is('linux')) {
3856 this.send('\x1b[?6c');
3857 }
3858 } else if (this.prefix === '>') {
3859 // xterm and urxvt
3860 // seem to spit this
3861 // out around ~370 times (?).
3862 if (this.is('xterm')) {
3863 this.send('\x1b[>0;276;0c');
3864 } else if (this.is('rxvt-unicode')) {
3865 this.send('\x1b[>85;95;0c');
3866 } else if (this.is('linux')) {
3867 // not supported by linux console.
3868 // linux console echoes parameters.
3869 this.send(params[0] + 'c');
3870 } else if (this.is('screen')) {
3871 this.send('\x1b[>83;40003;0c');
3872 }
3873 }
3874 };
3875
3876
3877 /**
3878 * CSI Pm d
3879 * Line Position Absolute [row] (default = [1,column]) (VPA).
3880 */
3881 Terminal.prototype.linePosAbsolute = function(params) {
3882 var param = params[0];
3883 if (param < 1) param = 1;
3884 this.y = param - 1;
3885 if (this.y >= this.rows) {
3886 this.y = this.rows - 1;
3887 }
3888 };
3889
3890
3891 /**
3892 * 145 65 e * VPR - Vertical Position Relative
3893 * reuse CSI Ps B ?
3894 */
3895 Terminal.prototype.VPositionRelative = function(params) {
3896 var param = params[0];
3897 if (param < 1) param = 1;
3898 this.y += param;
3899 if (this.y >= this.rows) {
3900 this.y = this.rows - 1;
3901 }
3902 };
3903
3904
3905 /**
3906 * CSI Ps ; Ps f
3907 * Horizontal and Vertical Position [row;column] (default =
3908 * [1,1]) (HVP).
3909 */
3910 Terminal.prototype.HVPosition = function(params) {
3911 if (params[0] < 1) params[0] = 1;
3912 if (params[1] < 1) params[1] = 1;
3913
3914 this.y = params[0] - 1;
3915 if (this.y >= this.rows) {
3916 this.y = this.rows - 1;
3917 }
3918
3919 this.x = params[1] - 1;
3920 if (this.x >= this.cols) {
3921 this.x = this.cols - 1;
3922 }
3923 };
3924
3925
3926 /**
3927 * CSI Pm h Set Mode (SM).
3928 * Ps = 2 -> Keyboard Action Mode (AM).
3929 * Ps = 4 -> Insert Mode (IRM).
3930 * Ps = 1 2 -> Send/receive (SRM).
3931 * Ps = 2 0 -> Automatic Newline (LNM).
3932 * CSI ? Pm h
3933 * DEC Private Mode Set (DECSET).
3934 * Ps = 1 -> Application Cursor Keys (DECCKM).
3935 * Ps = 2 -> Designate USASCII for character sets G0-G3
3936 * (DECANM), and set VT100 mode.
3937 * Ps = 3 -> 132 Column Mode (DECCOLM).
3938 * Ps = 4 -> Smooth (Slow) Scroll (DECSCLM).
3939 * Ps = 5 -> Reverse Video (DECSCNM).
3940 * Ps = 6 -> Origin Mode (DECOM).
3941 * Ps = 7 -> Wraparound Mode (DECAWM).
3942 * Ps = 8 -> Auto-repeat Keys (DECARM).
3943 * Ps = 9 -> Send Mouse X & Y on button press. See the sec-
3944 * tion Mouse Tracking.
3945 * Ps = 1 0 -> Show toolbar (rxvt).
3946 * Ps = 1 2 -> Start Blinking Cursor (att610).
3947 * Ps = 1 8 -> Print form feed (DECPFF).
3948 * Ps = 1 9 -> Set print extent to full screen (DECPEX).
3949 * Ps = 2 5 -> Show Cursor (DECTCEM).
3950 * Ps = 3 0 -> Show scrollbar (rxvt).
3951 * Ps = 3 5 -> Enable font-shifting functions (rxvt).
3952 * Ps = 3 8 -> Enter Tektronix Mode (DECTEK).
3953 * Ps = 4 0 -> Allow 80 -> 132 Mode.
3954 * Ps = 4 1 -> more(1) fix (see curses resource).
3955 * Ps = 4 2 -> Enable Nation Replacement Character sets (DECN-
3956 * RCM).
3957 * Ps = 4 4 -> Turn On Margin Bell.
3958 * Ps = 4 5 -> Reverse-wraparound Mode.
3959 * Ps = 4 6 -> Start Logging. This is normally disabled by a
3960 * compile-time option.
3961 * Ps = 4 7 -> Use Alternate Screen Buffer. (This may be dis-
3962 * abled by the titeInhibit resource).
3963 * Ps = 6 6 -> Application keypad (DECNKM).
3964 * Ps = 6 7 -> Backarrow key sends backspace (DECBKM).
3965 * Ps = 1 0 0 0 -> Send Mouse X & Y on button press and
3966 * release. See the section Mouse Tracking.
3967 * Ps = 1 0 0 1 -> Use Hilite Mouse Tracking.
3968 * Ps = 1 0 0 2 -> Use Cell Motion Mouse Tracking.
3969 * Ps = 1 0 0 3 -> Use All Motion Mouse Tracking.
3970 * Ps = 1 0 0 4 -> Send FocusIn/FocusOut events.
3971 * Ps = 1 0 0 5 -> Enable Extended Mouse Mode.
3972 * Ps = 1 0 1 0 -> Scroll to bottom on tty output (rxvt).
3973 * Ps = 1 0 1 1 -> Scroll to bottom on key press (rxvt).
3974 * Ps = 1 0 3 4 -> Interpret "meta" key, sets eighth bit.
3975 * (enables the eightBitInput resource).
3976 * Ps = 1 0 3 5 -> Enable special modifiers for Alt and Num-
3977 * Lock keys. (This enables the numLock resource).
3978 * Ps = 1 0 3 6 -> Send ESC when Meta modifies a key. (This
3979 * enables the metaSendsEscape resource).
3980 * Ps = 1 0 3 7 -> Send DEL from the editing-keypad Delete
3981 * key.
3982 * Ps = 1 0 3 9 -> Send ESC when Alt modifies a key. (This
3983 * enables the altSendsEscape resource).
3984 * Ps = 1 0 4 0 -> Keep selection even if not highlighted.
3985 * (This enables the keepSelection resource).
3986 * Ps = 1 0 4 1 -> Use the CLIPBOARD selection. (This enables
3987 * the selectToClipboard resource).
3988 * Ps = 1 0 4 2 -> Enable Urgency window manager hint when
3989 * Control-G is received. (This enables the bellIsUrgent
3990 * resource).
3991 * Ps = 1 0 4 3 -> Enable raising of the window when Control-G
3992 * is received. (enables the popOnBell resource).
3993 * Ps = 1 0 4 7 -> Use Alternate Screen Buffer. (This may be
3994 * disabled by the titeInhibit resource).
3995 * Ps = 1 0 4 8 -> Save cursor as in DECSC. (This may be dis-
3996 * abled by the titeInhibit resource).
3997 * Ps = 1 0 4 9 -> Save cursor as in DECSC and use Alternate
3998 * Screen Buffer, clearing it first. (This may be disabled by
3999 * the titeInhibit resource). This combines the effects of the 1
4000 * 0 4 7 and 1 0 4 8 modes. Use this with terminfo-based
4001 * applications rather than the 4 7 mode.
4002 * Ps = 1 0 5 0 -> Set terminfo/termcap function-key mode.
4003 * Ps = 1 0 5 1 -> Set Sun function-key mode.
4004 * Ps = 1 0 5 2 -> Set HP function-key mode.
4005 * Ps = 1 0 5 3 -> Set SCO function-key mode.
4006 * Ps = 1 0 6 0 -> Set legacy keyboard emulation (X11R6).
4007 * Ps = 1 0 6 1 -> Set VT220 keyboard emulation.
4008 * Ps = 2 0 0 4 -> Set bracketed paste mode.
4009 * Modes:
4010 * http: *vt100.net/docs/vt220-rm/chapter4.html
4011 */
4012 Terminal.prototype.setMode = function(params) {
4013 if (typeof params === 'object') {
4014 var l = params.length
4015 , i = 0;
4016
4017 for (; i < l; i++) {
4018 this.setMode(params[i]);
4019 }
4020
4021 return;
4022 }
4023
4024 if (!this.prefix) {
4025 switch (params) {
4026 case 4:
4027 this.insertMode = true;
4028 break;
4029 case 20:
4030 //this.convertEol = true;
4031 break;
4032 }
4033 } else if (this.prefix === '?') {
4034 switch (params) {
4035 case 1:
4036 this.applicationCursor = true;
4037 break;
4038 case 2:
4039 this.setgCharset(0, Terminal.charsets.US);
4040 this.setgCharset(1, Terminal.charsets.US);
4041 this.setgCharset(2, Terminal.charsets.US);
4042 this.setgCharset(3, Terminal.charsets.US);
4043 // set VT100 mode here
4044 break;
4045 case 3: // 132 col mode
4046 this.savedCols = this.cols;
4047 this.resize(132, this.rows);
4048 break;
4049 case 6:
4050 this.originMode = true;
4051 break;
4052 case 7:
4053 this.wraparoundMode = true;
4054 break;
4055 case 12:
4056 // this.cursorBlink = true;
4057 break;
4058 case 66:
4059 this.log('Serial port requested application keypad.');
4060 this.applicationKeypad = true;
4061 this.viewport.syncScrollArea();
4062 break;
4063 case 9: // X10 Mouse
4064 // no release, no motion, no wheel, no modifiers.
4065 case 1000: // vt200 mouse
4066 // no motion.
4067 // no modifiers, except control on the wheel.
4068 case 1002: // button event mouse
4069 case 1003: // any event mouse
4070 // any event - sends motion events,
4071 // even if there is no button held down.
4072 this.x10Mouse = params === 9;
4073 this.vt200Mouse = params === 1000;
4074 this.normalMouse = params > 1000;
4075 this.mouseEvents = true;
4076 this.element.style.cursor = 'default';
4077 this.log('Binding to mouse events.');
4078 break;
4079 case 1004: // send focusin/focusout events
4080 // focusin: ^[[I
4081 // focusout: ^[[O
4082 this.sendFocus = true;
4083 break;
4084 case 1005: // utf8 ext mode mouse
4085 this.utfMouse = true;
4086 // for wide terminals
4087 // simply encodes large values as utf8 characters
4088 break;
4089 case 1006: // sgr ext mode mouse
4090 this.sgrMouse = true;
4091 // for wide terminals
4092 // does not add 32 to fields
4093 // press: ^[[<b;x;yM
4094 // release: ^[[<b;x;ym
4095 break;
4096 case 1015: // urxvt ext mode mouse
4097 this.urxvtMouse = true;
4098 // for wide terminals
4099 // numbers for fields
4100 // press: ^[[b;x;yM
4101 // motion: ^[[b;x;yT
4102 break;
4103 case 25: // show cursor
4104 this.cursorHidden = false;
4105 break;
4106 case 1049: // alt screen buffer cursor
4107 //this.saveCursor();
4108 ; // FALL-THROUGH
4109 case 47: // alt screen buffer
4110 case 1047: // alt screen buffer
4111 if (!this.normal) {
4112 var normal = {
4113 lines: this.lines,
4114 ybase: this.ybase,
4115 ydisp: this.ydisp,
4116 x: this.x,
4117 y: this.y,
4118 scrollTop: this.scrollTop,
4119 scrollBottom: this.scrollBottom,
4120 tabs: this.tabs
4121 // XXX save charset(s) here?
4122 // charset: this.charset,
4123 // glevel: this.glevel,
4124 // charsets: this.charsets
4125 };
4126 this.reset();
4127 this.normal = normal;
4128 this.showCursor();
4129 }
4130 break;
4131 }
4132 }
4133 };
4134
4135 /**
4136 * CSI Pm l Reset Mode (RM).
4137 * Ps = 2 -> Keyboard Action Mode (AM).
4138 * Ps = 4 -> Replace Mode (IRM).
4139 * Ps = 1 2 -> Send/receive (SRM).
4140 * Ps = 2 0 -> Normal Linefeed (LNM).
4141 * CSI ? Pm l
4142 * DEC Private Mode Reset (DECRST).
4143 * Ps = 1 -> Normal Cursor Keys (DECCKM).
4144 * Ps = 2 -> Designate VT52 mode (DECANM).
4145 * Ps = 3 -> 80 Column Mode (DECCOLM).
4146 * Ps = 4 -> Jump (Fast) Scroll (DECSCLM).
4147 * Ps = 5 -> Normal Video (DECSCNM).
4148 * Ps = 6 -> Normal Cursor Mode (DECOM).
4149 * Ps = 7 -> No Wraparound Mode (DECAWM).
4150 * Ps = 8 -> No Auto-repeat Keys (DECARM).
4151 * Ps = 9 -> Don't send Mouse X & Y on button press.
4152 * Ps = 1 0 -> Hide toolbar (rxvt).
4153 * Ps = 1 2 -> Stop Blinking Cursor (att610).
4154 * Ps = 1 8 -> Don't print form feed (DECPFF).
4155 * Ps = 1 9 -> Limit print to scrolling region (DECPEX).
4156 * Ps = 2 5 -> Hide Cursor (DECTCEM).
4157 * Ps = 3 0 -> Don't show scrollbar (rxvt).
4158 * Ps = 3 5 -> Disable font-shifting functions (rxvt).
4159 * Ps = 4 0 -> Disallow 80 -> 132 Mode.
4160 * Ps = 4 1 -> No more(1) fix (see curses resource).
4161 * Ps = 4 2 -> Disable Nation Replacement Character sets (DEC-
4162 * NRCM).
4163 * Ps = 4 4 -> Turn Off Margin Bell.
4164 * Ps = 4 5 -> No Reverse-wraparound Mode.
4165 * Ps = 4 6 -> Stop Logging. (This is normally disabled by a
4166 * compile-time option).
4167 * Ps = 4 7 -> Use Normal Screen Buffer.
4168 * Ps = 6 6 -> Numeric keypad (DECNKM).
4169 * Ps = 6 7 -> Backarrow key sends delete (DECBKM).
4170 * Ps = 1 0 0 0 -> Don't send Mouse X & Y on button press and
4171 * release. See the section Mouse Tracking.
4172 * Ps = 1 0 0 1 -> Don't use Hilite Mouse Tracking.
4173 * Ps = 1 0 0 2 -> Don't use Cell Motion Mouse Tracking.
4174 * Ps = 1 0 0 3 -> Don't use All Motion Mouse Tracking.
4175 * Ps = 1 0 0 4 -> Don't send FocusIn/FocusOut events.
4176 * Ps = 1 0 0 5 -> Disable Extended Mouse Mode.
4177 * Ps = 1 0 1 0 -> Don't scroll to bottom on tty output
4178 * (rxvt).
4179 * Ps = 1 0 1 1 -> Don't scroll to bottom on key press (rxvt).
4180 * Ps = 1 0 3 4 -> Don't interpret "meta" key. (This disables
4181 * the eightBitInput resource).
4182 * Ps = 1 0 3 5 -> Disable special modifiers for Alt and Num-
4183 * Lock keys. (This disables the numLock resource).
4184 * Ps = 1 0 3 6 -> Don't send ESC when Meta modifies a key.
4185 * (This disables the metaSendsEscape resource).
4186 * Ps = 1 0 3 7 -> Send VT220 Remove from the editing-keypad
4187 * Delete key.
4188 * Ps = 1 0 3 9 -> Don't send ESC when Alt modifies a key.
4189 * (This disables the altSendsEscape resource).
4190 * Ps = 1 0 4 0 -> Do not keep selection when not highlighted.
4191 * (This disables the keepSelection resource).
4192 * Ps = 1 0 4 1 -> Use the PRIMARY selection. (This disables
4193 * the selectToClipboard resource).
4194 * Ps = 1 0 4 2 -> Disable Urgency window manager hint when
4195 * Control-G is received. (This disables the bellIsUrgent
4196 * resource).
4197 * Ps = 1 0 4 3 -> Disable raising of the window when Control-
4198 * G is received. (This disables the popOnBell resource).
4199 * Ps = 1 0 4 7 -> Use Normal Screen Buffer, clearing screen
4200 * first if in the Alternate Screen. (This may be disabled by
4201 * the titeInhibit resource).
4202 * Ps = 1 0 4 8 -> Restore cursor as in DECRC. (This may be
4203 * disabled by the titeInhibit resource).
4204 * Ps = 1 0 4 9 -> Use Normal Screen Buffer and restore cursor
4205 * as in DECRC. (This may be disabled by the titeInhibit
4206 * resource). This combines the effects of the 1 0 4 7 and 1 0
4207 * 4 8 modes. Use this with terminfo-based applications rather
4208 * than the 4 7 mode.
4209 * Ps = 1 0 5 0 -> Reset terminfo/termcap function-key mode.
4210 * Ps = 1 0 5 1 -> Reset Sun function-key mode.
4211 * Ps = 1 0 5 2 -> Reset HP function-key mode.
4212 * Ps = 1 0 5 3 -> Reset SCO function-key mode.
4213 * Ps = 1 0 6 0 -> Reset legacy keyboard emulation (X11R6).
4214 * Ps = 1 0 6 1 -> Reset keyboard emulation to Sun/PC style.
4215 * Ps = 2 0 0 4 -> Reset bracketed paste mode.
4216 */
4217 Terminal.prototype.resetMode = function(params) {
4218 if (typeof params === 'object') {
4219 var l = params.length
4220 , i = 0;
4221
4222 for (; i < l; i++) {
4223 this.resetMode(params[i]);
4224 }
4225
4226 return;
4227 }
4228
4229 if (!this.prefix) {
4230 switch (params) {
4231 case 4:
4232 this.insertMode = false;
4233 break;
4234 case 20:
4235 //this.convertEol = false;
4236 break;
4237 }
4238 } else if (this.prefix === '?') {
4239 switch (params) {
4240 case 1:
4241 this.applicationCursor = false;
4242 break;
4243 case 3:
4244 if (this.cols === 132 && this.savedCols) {
4245 this.resize(this.savedCols, this.rows);
4246 }
4247 delete this.savedCols;
4248 break;
4249 case 6:
4250 this.originMode = false;
4251 break;
4252 case 7:
4253 this.wraparoundMode = false;
4254 break;
4255 case 12:
4256 // this.cursorBlink = false;
4257 break;
4258 case 66:
4259 this.log('Switching back to normal keypad.');
4260 this.applicationKeypad = false;
4261 this.viewport.syncScrollArea();
4262 break;
4263 case 9: // X10 Mouse
4264 case 1000: // vt200 mouse
4265 case 1002: // button event mouse
4266 case 1003: // any event mouse
4267 this.x10Mouse = false;
4268 this.vt200Mouse = false;
4269 this.normalMouse = false;
4270 this.mouseEvents = false;
4271 this.element.style.cursor = '';
4272 break;
4273 case 1004: // send focusin/focusout events
4274 this.sendFocus = false;
4275 break;
4276 case 1005: // utf8 ext mode mouse
4277 this.utfMouse = false;
4278 break;
4279 case 1006: // sgr ext mode mouse
4280 this.sgrMouse = false;
4281 break;
4282 case 1015: // urxvt ext mode mouse
4283 this.urxvtMouse = false;
4284 break;
4285 case 25: // hide cursor
4286 this.cursorHidden = true;
4287 break;
4288 case 1049: // alt screen buffer cursor
4289 ; // FALL-THROUGH
4290 case 47: // normal screen buffer
4291 case 1047: // normal screen buffer - clearing it first
4292 if (this.normal) {
4293 this.lines = this.normal.lines;
4294 this.ybase = this.normal.ybase;
4295 this.ydisp = this.normal.ydisp;
4296 this.x = this.normal.x;
4297 this.y = this.normal.y;
4298 this.scrollTop = this.normal.scrollTop;
4299 this.scrollBottom = this.normal.scrollBottom;
4300 this.tabs = this.normal.tabs;
4301 this.normal = null;
4302 // if (params === 1049) {
4303 // this.x = this.savedX;
4304 // this.y = this.savedY;
4305 // }
4306 this.refresh(0, this.rows - 1);
4307 this.showCursor();
4308 }
4309 break;
4310 }
4311 }
4312 };
4313
4314
4315 /**
4316 * CSI Ps ; Ps r
4317 * Set Scrolling Region [top;bottom] (default = full size of win-
4318 * dow) (DECSTBM).
4319 * CSI ? Pm r
4320 */
4321 Terminal.prototype.setScrollRegion = function(params) {
4322 if (this.prefix) return;
4323 this.scrollTop = (params[0] || 1) - 1;
4324 this.scrollBottom = (params[1] || this.rows) - 1;
4325 this.x = 0;
4326 this.y = 0;
4327 };
4328
4329
4330 /**
4331 * CSI s
4332 * Save cursor (ANSI.SYS).
4333 */
4334 Terminal.prototype.saveCursor = function(params) {
4335 this.savedX = this.x;
4336 this.savedY = this.y;
4337 };
4338
4339
4340 /**
4341 * CSI u
4342 * Restore cursor (ANSI.SYS).
4343 */
4344 Terminal.prototype.restoreCursor = function(params) {
4345 this.x = this.savedX || 0;
4346 this.y = this.savedY || 0;
4347 };
4348
4349
4350 /**
4351 * Lesser Used
4352 */
4353
4354 /**
4355 * CSI Ps I
4356 * Cursor Forward Tabulation Ps tab stops (default = 1) (CHT).
4357 */
4358 Terminal.prototype.cursorForwardTab = function(params) {
4359 var param = params[0] || 1;
4360 while (param--) {
4361 this.x = this.nextStop();
4362 }
4363 };
4364
4365
4366 /**
4367 * CSI Ps S Scroll up Ps lines (default = 1) (SU).
4368 */
4369 Terminal.prototype.scrollUp = function(params) {
4370 var param = params[0] || 1;
4371 while (param--) {
4372 this.lines.splice(this.ybase + this.scrollTop, 1);
4373 this.lines.splice(this.ybase + this.scrollBottom, 0, this.blankLine());
4374 }
4375 // this.maxRange();
4376 this.updateRange(this.scrollTop);
4377 this.updateRange(this.scrollBottom);
4378 };
4379
4380
4381 /**
4382 * CSI Ps T Scroll down Ps lines (default = 1) (SD).
4383 */
4384 Terminal.prototype.scrollDown = function(params) {
4385 var param = params[0] || 1;
4386 while (param--) {
4387 this.lines.splice(this.ybase + this.scrollBottom, 1);
4388 this.lines.splice(this.ybase + this.scrollTop, 0, this.blankLine());
4389 }
4390 // this.maxRange();
4391 this.updateRange(this.scrollTop);
4392 this.updateRange(this.scrollBottom);
4393 };
4394
4395
4396 /**
4397 * CSI Ps ; Ps ; Ps ; Ps ; Ps T
4398 * Initiate highlight mouse tracking. Parameters are
4399 * [func;startx;starty;firstrow;lastrow]. See the section Mouse
4400 * Tracking.
4401 */
4402 Terminal.prototype.initMouseTracking = function(params) {
4403 // Relevant: DECSET 1001
4404 };
4405
4406
4407 /**
4408 * CSI > Ps; Ps T
4409 * Reset one or more features of the title modes to the default
4410 * value. Normally, "reset" disables the feature. It is possi-
4411 * ble to disable the ability to reset features by compiling a
4412 * different default for the title modes into xterm.
4413 * Ps = 0 -> Do not set window/icon labels using hexadecimal.
4414 * Ps = 1 -> Do not query window/icon labels using hexadeci-
4415 * mal.
4416 * Ps = 2 -> Do not set window/icon labels using UTF-8.
4417 * Ps = 3 -> Do not query window/icon labels using UTF-8.
4418 * (See discussion of "Title Modes").
4419 */
4420 Terminal.prototype.resetTitleModes = function(params) {
4421 ;
4422 };
4423
4424
4425 /**
4426 * CSI Ps Z Cursor Backward Tabulation Ps tab stops (default = 1) (CBT).
4427 */
4428 Terminal.prototype.cursorBackwardTab = function(params) {
4429 var param = params[0] || 1;
4430 while (param--) {
4431 this.x = this.prevStop();
4432 }
4433 };
4434
4435
4436 /**
4437 * CSI Ps b Repeat the preceding graphic character Ps times (REP).
4438 */
4439 Terminal.prototype.repeatPrecedingCharacter = function(params) {
4440 var param = params[0] || 1
4441 , line = this.lines.get(this.ybase + this.y)
4442 , ch = line[this.x - 1] || [this.defAttr, ' ', 1];
4443
4444 while (param--) line[this.x++] = ch;
4445 };
4446
4447
4448 /**
4449 * CSI Ps g Tab Clear (TBC).
4450 * Ps = 0 -> Clear Current Column (default).
4451 * Ps = 3 -> Clear All.
4452 * Potentially:
4453 * Ps = 2 -> Clear Stops on Line.
4454 * http://vt100.net/annarbor/aaa-ug/section6.html
4455 */
4456 Terminal.prototype.tabClear = function(params) {
4457 var param = params[0];
4458 if (param <= 0) {
4459 delete this.tabs[this.x];
4460 } else if (param === 3) {
4461 this.tabs = {};
4462 }
4463 };
4464
4465
4466 /**
4467 * CSI Pm i Media Copy (MC).
4468 * Ps = 0 -> Print screen (default).
4469 * Ps = 4 -> Turn off printer controller mode.
4470 * Ps = 5 -> Turn on printer controller mode.
4471 * CSI ? Pm i
4472 * Media Copy (MC, DEC-specific).
4473 * Ps = 1 -> Print line containing cursor.
4474 * Ps = 4 -> Turn off autoprint mode.
4475 * Ps = 5 -> Turn on autoprint mode.
4476 * Ps = 1 0 -> Print composed display, ignores DECPEX.
4477 * Ps = 1 1 -> Print all pages.
4478 */
4479 Terminal.prototype.mediaCopy = function(params) {
4480 ;
4481 };
4482
4483
4484 /**
4485 * CSI > Ps; Ps m
4486 * Set or reset resource-values used by xterm to decide whether
4487 * to construct escape sequences holding information about the
4488 * modifiers pressed with a given key. The first parameter iden-
4489 * tifies the resource to set/reset. The second parameter is the
4490 * value to assign to the resource. If the second parameter is
4491 * omitted, the resource is reset to its initial value.
4492 * Ps = 1 -> modifyCursorKeys.
4493 * Ps = 2 -> modifyFunctionKeys.
4494 * Ps = 4 -> modifyOtherKeys.
4495 * If no parameters are given, all resources are reset to their
4496 * initial values.
4497 */
4498 Terminal.prototype.setResources = function(params) {
4499 ;
4500 };
4501
4502
4503 /**
4504 * CSI > Ps n
4505 * Disable modifiers which may be enabled via the CSI > Ps; Ps m
4506 * sequence. This corresponds to a resource value of "-1", which
4507 * cannot be set with the other sequence. The parameter identi-
4508 * fies the resource to be disabled:
4509 * Ps = 1 -> modifyCursorKeys.
4510 * Ps = 2 -> modifyFunctionKeys.
4511 * Ps = 4 -> modifyOtherKeys.
4512 * If the parameter is omitted, modifyFunctionKeys is disabled.
4513 * When modifyFunctionKeys is disabled, xterm uses the modifier
4514 * keys to make an extended sequence of functions rather than
4515 * adding a parameter to each function key to denote the modi-
4516 * fiers.
4517 */
4518 Terminal.prototype.disableModifiers = function(params) {
4519 ;
4520 };
4521
4522
4523 /**
4524 * CSI > Ps p
4525 * Set resource value pointerMode. This is used by xterm to
4526 * decide whether to hide the pointer cursor as the user types.
4527 * Valid values for the parameter:
4528 * Ps = 0 -> never hide the pointer.
4529 * Ps = 1 -> hide if the mouse tracking mode is not enabled.
4530 * Ps = 2 -> always hide the pointer. If no parameter is
4531 * given, xterm uses the default, which is 1 .
4532 */
4533 Terminal.prototype.setPointerMode = function(params) {
4534 ;
4535 };
4536
4537
4538 /**
4539 * CSI ! p Soft terminal reset (DECSTR).
4540 * http://vt100.net/docs/vt220-rm/table4-10.html
4541 */
4542 Terminal.prototype.softReset = function(params) {
4543 this.cursorHidden = false;
4544 this.insertMode = false;
4545 this.originMode = false;
4546 this.wraparoundMode = false; // autowrap
4547 this.applicationKeypad = false; // ?
4548 this.viewport.syncScrollArea();
4549 this.applicationCursor = false;
4550 this.scrollTop = 0;
4551 this.scrollBottom = this.rows - 1;
4552 this.curAttr = this.defAttr;
4553 this.x = this.y = 0; // ?
4554 this.charset = null;
4555 this.glevel = 0; // ??
4556 this.charsets = [null]; // ??
4557 };
4558
4559
4560 /**
4561 * CSI Ps$ p
4562 * Request ANSI mode (DECRQM). For VT300 and up, reply is
4563 * CSI Ps; Pm$ y
4564 * where Ps is the mode number as in RM, and Pm is the mode
4565 * value:
4566 * 0 - not recognized
4567 * 1 - set
4568 * 2 - reset
4569 * 3 - permanently set
4570 * 4 - permanently reset
4571 */
4572 Terminal.prototype.requestAnsiMode = function(params) {
4573 ;
4574 };
4575
4576
4577 /**
4578 * CSI ? Ps$ p
4579 * Request DEC private mode (DECRQM). For VT300 and up, reply is
4580 * CSI ? Ps; Pm$ p
4581 * where Ps is the mode number as in DECSET, Pm is the mode value
4582 * as in the ANSI DECRQM.
4583 */
4584 Terminal.prototype.requestPrivateMode = function(params) {
4585 ;
4586 };
4587
4588
4589 /**
4590 * CSI Ps ; Ps " p
4591 * Set conformance level (DECSCL). Valid values for the first
4592 * parameter:
4593 * Ps = 6 1 -> VT100.
4594 * Ps = 6 2 -> VT200.
4595 * Ps = 6 3 -> VT300.
4596 * Valid values for the second parameter:
4597 * Ps = 0 -> 8-bit controls.
4598 * Ps = 1 -> 7-bit controls (always set for VT100).
4599 * Ps = 2 -> 8-bit controls.
4600 */
4601 Terminal.prototype.setConformanceLevel = function(params) {
4602 ;
4603 };
4604
4605
4606 /**
4607 * CSI Ps q Load LEDs (DECLL).
4608 * Ps = 0 -> Clear all LEDS (default).
4609 * Ps = 1 -> Light Num Lock.
4610 * Ps = 2 -> Light Caps Lock.
4611 * Ps = 3 -> Light Scroll Lock.
4612 * Ps = 2 1 -> Extinguish Num Lock.
4613 * Ps = 2 2 -> Extinguish Caps Lock.
4614 * Ps = 2 3 -> Extinguish Scroll Lock.
4615 */
4616 Terminal.prototype.loadLEDs = function(params) {
4617 ;
4618 };
4619
4620
4621 /**
4622 * CSI Ps SP q
4623 * Set cursor style (DECSCUSR, VT520).
4624 * Ps = 0 -> blinking block.
4625 * Ps = 1 -> blinking block (default).
4626 * Ps = 2 -> steady block.
4627 * Ps = 3 -> blinking underline.
4628 * Ps = 4 -> steady underline.
4629 */
4630 Terminal.prototype.setCursorStyle = function(params) {
4631 ;
4632 };
4633
4634
4635 /**
4636 * CSI Ps " q
4637 * Select character protection attribute (DECSCA). Valid values
4638 * for the parameter:
4639 * Ps = 0 -> DECSED and DECSEL can erase (default).
4640 * Ps = 1 -> DECSED and DECSEL cannot erase.
4641 * Ps = 2 -> DECSED and DECSEL can erase.
4642 */
4643 Terminal.prototype.setCharProtectionAttr = function(params) {
4644 ;
4645 };
4646
4647
4648 /**
4649 * CSI ? Pm r
4650 * Restore DEC Private Mode Values. The value of Ps previously
4651 * saved is restored. Ps values are the same as for DECSET.
4652 */
4653 Terminal.prototype.restorePrivateValues = function(params) {
4654 ;
4655 };
4656
4657
4658 /**
4659 * CSI Pt; Pl; Pb; Pr; Ps$ r
4660 * Change Attributes in Rectangular Area (DECCARA), VT400 and up.
4661 * Pt; Pl; Pb; Pr denotes the rectangle.
4662 * Ps denotes the SGR attributes to change: 0, 1, 4, 5, 7.
4663 * NOTE: xterm doesn't enable this code by default.
4664 */
4665 Terminal.prototype.setAttrInRectangle = function(params) {
4666 var t = params[0]
4667 , l = params[1]
4668 , b = params[2]
4669 , r = params[3]
4670 , attr = params[4];
4671
4672 var line
4673 , i;
4674
4675 for (; t < b + 1; t++) {
4676 line = this.lines.get(this.ybase + t);
4677 for (i = l; i < r; i++) {
4678 line[i] = [attr, line[i][1]];
4679 }
4680 }
4681
4682 // this.maxRange();
4683 this.updateRange(params[0]);
4684 this.updateRange(params[2]);
4685 };
4686
4687
4688 /**
4689 * CSI Pc; Pt; Pl; Pb; Pr$ x
4690 * Fill Rectangular Area (DECFRA), VT420 and up.
4691 * Pc is the character to use.
4692 * Pt; Pl; Pb; Pr denotes the rectangle.
4693 * NOTE: xterm doesn't enable this code by default.
4694 */
4695 Terminal.prototype.fillRectangle = function(params) {
4696 var ch = params[0]
4697 , t = params[1]
4698 , l = params[2]
4699 , b = params[3]
4700 , r = params[4];
4701
4702 var line
4703 , i;
4704
4705 for (; t < b + 1; t++) {
4706 line = this.lines.get(this.ybase + t);
4707 for (i = l; i < r; i++) {
4708 line[i] = [line[i][0], String.fromCharCode(ch)];
4709 }
4710 }
4711
4712 // this.maxRange();
4713 this.updateRange(params[1]);
4714 this.updateRange(params[3]);
4715 };
4716
4717
4718 /**
4719 * CSI Ps ; Pu ' z
4720 * Enable Locator Reporting (DECELR).
4721 * Valid values for the first parameter:
4722 * Ps = 0 -> Locator disabled (default).
4723 * Ps = 1 -> Locator enabled.
4724 * Ps = 2 -> Locator enabled for one report, then disabled.
4725 * The second parameter specifies the coordinate unit for locator
4726 * reports.
4727 * Valid values for the second parameter:
4728 * Pu = 0 <- or omitted -> default to character cells.
4729 * Pu = 1 <- device physical pixels.
4730 * Pu = 2 <- character cells.
4731 */
4732 Terminal.prototype.enableLocatorReporting = function(params) {
4733 var val = params[0] > 0;
4734 //this.mouseEvents = val;
4735 //this.decLocator = val;
4736 };
4737
4738
4739 /**
4740 * CSI Pt; Pl; Pb; Pr$ z
4741 * Erase Rectangular Area (DECERA), VT400 and up.
4742 * Pt; Pl; Pb; Pr denotes the rectangle.
4743 * NOTE: xterm doesn't enable this code by default.
4744 */
4745 Terminal.prototype.eraseRectangle = function(params) {
4746 var t = params[0]
4747 , l = params[1]
4748 , b = params[2]
4749 , r = params[3];
4750
4751 var line
4752 , i
4753 , ch;
4754
4755 ch = [this.eraseAttr(), ' ', 1]; // xterm?
4756
4757 for (; t < b + 1; t++) {
4758 line = this.lines.get(this.ybase + t);
4759 for (i = l; i < r; i++) {
4760 line[i] = ch;
4761 }
4762 }
4763
4764 // this.maxRange();
4765 this.updateRange(params[0]);
4766 this.updateRange(params[2]);
4767 };
4768
4769
4770 /**
4771 * CSI P m SP }
4772 * Insert P s Column(s) (default = 1) (DECIC), VT420 and up.
4773 * NOTE: xterm doesn't enable this code by default.
4774 */
4775 Terminal.prototype.insertColumns = function() {
4776 var param = params[0]
4777 , l = this.ybase + this.rows
4778 , ch = [this.eraseAttr(), ' ', 1] // xterm?
4779 , i;
4780
4781 while (param--) {
4782 for (i = this.ybase; i < l; i++) {
4783 this.lines[i].splice(this.x + 1, 0, ch);
4784 this.lines[i].pop();
4785 }
4786 }
4787
4788 this.maxRange();
4789 };
4790
4791
4792 /**
4793 * CSI P m SP ~
4794 * Delete P s Column(s) (default = 1) (DECDC), VT420 and up
4795 * NOTE: xterm doesn't enable this code by default.
4796 */
4797 Terminal.prototype.deleteColumns = function() {
4798 var param = params[0]
4799 , l = this.ybase + this.rows
4800 , ch = [this.eraseAttr(), ' ', 1] // xterm?
4801 , i;
4802
4803 while (param--) {
4804 for (i = this.ybase; i < l; i++) {
4805 this.lines[i].splice(this.x, 1);
4806 this.lines[i].push(ch);
4807 }
4808 }
4809
4810 this.maxRange();
4811 };
4812
4813 /**
4814 * Character Sets
4815 */
4816
4817 Terminal.charsets = {};
4818
4819 // DEC Special Character and Line Drawing Set.
4820 // http://vt100.net/docs/vt102-ug/table5-13.html
4821 // A lot of curses apps use this if they see TERM=xterm.
4822 // testing: echo -e '\e(0a\e(B'
4823 // The xterm output sometimes seems to conflict with the
4824 // reference above. xterm seems in line with the reference
4825 // when running vttest however.
4826 // The table below now uses xterm's output from vttest.
4827 Terminal.charsets.SCLD = { // (0
4828 '`': '\u25c6', // '◆'
4829 'a': '\u2592', // '▒'
4830 'b': '\u0009', // '\t'
4831 'c': '\u000c', // '\f'
4832 'd': '\u000d', // '\r'
4833 'e': '\u000a', // '\n'
4834 'f': '\u00b0', // '°'
4835 'g': '\u00b1', // '±'
4836 'h': '\u2424', // '\u2424' (NL)
4837 'i': '\u000b', // '\v'
4838 'j': '\u2518', // '┘'
4839 'k': '\u2510', // '┐'
4840 'l': '\u250c', // '┌'
4841 'm': '\u2514', // '└'
4842 'n': '\u253c', // '┼'
4843 'o': '\u23ba', // '⎺'
4844 'p': '\u23bb', // '⎻'
4845 'q': '\u2500', // '─'
4846 'r': '\u23bc', // '⎼'
4847 's': '\u23bd', // '⎽'
4848 't': '\u251c', // '├'
4849 'u': '\u2524', // '┤'
4850 'v': '\u2534', // '┴'
4851 'w': '\u252c', // '┬'
4852 'x': '\u2502', // '│'
4853 'y': '\u2264', // '≤'
4854 'z': '\u2265', // '≥'
4855 '{': '\u03c0', // 'π'
4856 '|': '\u2260', // '≠'
4857 '}': '\u00a3', // '£'
4858 '~': '\u00b7' // '·'
4859 };
4860
4861 Terminal.charsets.UK = null; // (A
4862 Terminal.charsets.US = null; // (B (USASCII)
4863 Terminal.charsets.Dutch = null; // (4
4864 Terminal.charsets.Finnish = null; // (C or (5
4865 Terminal.charsets.French = null; // (R
4866 Terminal.charsets.FrenchCanadian = null; // (Q
4867 Terminal.charsets.German = null; // (K
4868 Terminal.charsets.Italian = null; // (Y
4869 Terminal.charsets.NorwegianDanish = null; // (E or (6
4870 Terminal.charsets.Spanish = null; // (Z
4871 Terminal.charsets.Swedish = null; // (H or (7
4872 Terminal.charsets.Swiss = null; // (=
4873 Terminal.charsets.ISOLatin = null; // /A
4874
4875 /**
4876 * Helpers
4877 */
4878
4879 function on(el, type, handler, capture) {
4880 if (!Array.isArray(el)) {
4881 el = [el];
4882 }
4883 el.forEach(function (element) {
4884 element.addEventListener(type, handler, capture || false);
4885 });
4886 }
4887
4888 function off(el, type, handler, capture) {
4889 el.removeEventListener(type, handler, capture || false);
4890 }
4891
4892 function cancel(ev, force) {
4893 if (!this.cancelEvents && !force) {
4894 return;
4895 }
4896 ev.preventDefault();
4897 ev.stopPropagation();
4898 return false;
4899 }
4900
4901 function inherits(child, parent) {
4902 function f() {
4903 this.constructor = child;
4904 }
4905 f.prototype = parent.prototype;
4906 child.prototype = new f;
4907 }
4908
4909 // if bold is broken, we can't
4910 // use it in the terminal.
4911 function isBoldBroken(document) {
4912 var body = document.getElementsByTagName('body')[0];
4913 var el = document.createElement('span');
4914 el.innerHTML = 'hello world';
4915 body.appendChild(el);
4916 var w1 = el.scrollWidth;
4917 el.style.fontWeight = 'bold';
4918 var w2 = el.scrollWidth;
4919 body.removeChild(el);
4920 return w1 !== w2;
4921 }
4922
4923 function indexOf(obj, el) {
4924 var i = obj.length;
4925 while (i--) {
4926 if (obj[i] === el) return i;
4927 }
4928 return -1;
4929 }
4930
4931 function isThirdLevelShift(term, ev) {
4932 var thirdLevelKey =
4933 (term.browser.isMac && ev.altKey && !ev.ctrlKey && !ev.metaKey) ||
4934 (term.browser.isMSWindows && ev.altKey && ev.ctrlKey && !ev.metaKey);
4935
4936 if (ev.type == 'keypress') {
4937 return thirdLevelKey;
4938 }
4939
4940 // Don't invoke for arrows, pageDown, home, backspace, etc. (on non-keypress events)
4941 return thirdLevelKey && (!ev.keyCode || ev.keyCode > 47);
4942 }
4943
4944 function matchColor(r1, g1, b1) {
4945 var hash = (r1 << 16) | (g1 << 8) | b1;
4946
4947 if (matchColor._cache[hash] != null) {
4948 return matchColor._cache[hash];
4949 }
4950
4951 var ldiff = Infinity
4952 , li = -1
4953 , i = 0
4954 , c
4955 , r2
4956 , g2
4957 , b2
4958 , diff;
4959
4960 for (; i < Terminal.vcolors.length; i++) {
4961 c = Terminal.vcolors[i];
4962 r2 = c[0];
4963 g2 = c[1];
4964 b2 = c[2];
4965
4966 diff = matchColor.distance(r1, g1, b1, r2, g2, b2);
4967
4968 if (diff === 0) {
4969 li = i;
4970 break;
4971 }
4972
4973 if (diff < ldiff) {
4974 ldiff = diff;
4975 li = i;
4976 }
4977 }
4978
4979 return matchColor._cache[hash] = li;
4980 }
4981
4982 matchColor._cache = {};
4983
4984 // http://stackoverflow.com/questions/1633828
4985 matchColor.distance = function(r1, g1, b1, r2, g2, b2) {
4986 return Math.pow(30 * (r1 - r2), 2)
4987 + Math.pow(59 * (g1 - g2), 2)
4988 + Math.pow(11 * (b1 - b2), 2);
4989 };
4990
4991 function each(obj, iter, con) {
4992 if (obj.forEach) return obj.forEach(iter, con);
4993 for (var i = 0; i < obj.length; i++) {
4994 iter.call(con, obj[i], i, obj);
4995 }
4996 }
4997
4998 function keys(obj) {
4999 if (Object.keys) return Object.keys(obj);
5000 var key, keys = [];
5001 for (key in obj) {
5002 if (Object.prototype.hasOwnProperty.call(obj, key)) {
5003 keys.push(key);
5004 }
5005 }
5006 return keys;
5007 }
5008
5009 var wcwidth = (function(opts) {
5010 // extracted from https://www.cl.cam.ac.uk/%7Emgk25/ucs/wcwidth.c
5011 // combining characters
5012 var COMBINING = [
5013 [0x0300, 0x036F], [0x0483, 0x0486], [0x0488, 0x0489],
5014 [0x0591, 0x05BD], [0x05BF, 0x05BF], [0x05C1, 0x05C2],
5015 [0x05C4, 0x05C5], [0x05C7, 0x05C7], [0x0600, 0x0603],
5016 [0x0610, 0x0615], [0x064B, 0x065E], [0x0670, 0x0670],
5017 [0x06D6, 0x06E4], [0x06E7, 0x06E8], [0x06EA, 0x06ED],
5018 [0x070F, 0x070F], [0x0711, 0x0711], [0x0730, 0x074A],
5019 [0x07A6, 0x07B0], [0x07EB, 0x07F3], [0x0901, 0x0902],
5020 [0x093C, 0x093C], [0x0941, 0x0948], [0x094D, 0x094D],
5021 [0x0951, 0x0954], [0x0962, 0x0963], [0x0981, 0x0981],
5022 [0x09BC, 0x09BC], [0x09C1, 0x09C4], [0x09CD, 0x09CD],
5023 [0x09E2, 0x09E3], [0x0A01, 0x0A02], [0x0A3C, 0x0A3C],
5024 [0x0A41, 0x0A42], [0x0A47, 0x0A48], [0x0A4B, 0x0A4D],
5025 [0x0A70, 0x0A71], [0x0A81, 0x0A82], [0x0ABC, 0x0ABC],
5026 [0x0AC1, 0x0AC5], [0x0AC7, 0x0AC8], [0x0ACD, 0x0ACD],
5027 [0x0AE2, 0x0AE3], [0x0B01, 0x0B01], [0x0B3C, 0x0B3C],
5028 [0x0B3F, 0x0B3F], [0x0B41, 0x0B43], [0x0B4D, 0x0B4D],
5029 [0x0B56, 0x0B56], [0x0B82, 0x0B82], [0x0BC0, 0x0BC0],
5030 [0x0BCD, 0x0BCD], [0x0C3E, 0x0C40], [0x0C46, 0x0C48],
5031 [0x0C4A, 0x0C4D], [0x0C55, 0x0C56], [0x0CBC, 0x0CBC],
5032 [0x0CBF, 0x0CBF], [0x0CC6, 0x0CC6], [0x0CCC, 0x0CCD],
5033 [0x0CE2, 0x0CE3], [0x0D41, 0x0D43], [0x0D4D, 0x0D4D],
5034 [0x0DCA, 0x0DCA], [0x0DD2, 0x0DD4], [0x0DD6, 0x0DD6],
5035 [0x0E31, 0x0E31], [0x0E34, 0x0E3A], [0x0E47, 0x0E4E],
5036 [0x0EB1, 0x0EB1], [0x0EB4, 0x0EB9], [0x0EBB, 0x0EBC],
5037 [0x0EC8, 0x0ECD], [0x0F18, 0x0F19], [0x0F35, 0x0F35],
5038 [0x0F37, 0x0F37], [0x0F39, 0x0F39], [0x0F71, 0x0F7E],
5039 [0x0F80, 0x0F84], [0x0F86, 0x0F87], [0x0F90, 0x0F97],
5040 [0x0F99, 0x0FBC], [0x0FC6, 0x0FC6], [0x102D, 0x1030],
5041 [0x1032, 0x1032], [0x1036, 0x1037], [0x1039, 0x1039],
5042 [0x1058, 0x1059], [0x1160, 0x11FF], [0x135F, 0x135F],
5043 [0x1712, 0x1714], [0x1732, 0x1734], [0x1752, 0x1753],
5044 [0x1772, 0x1773], [0x17B4, 0x17B5], [0x17B7, 0x17BD],
5045 [0x17C6, 0x17C6], [0x17C9, 0x17D3], [0x17DD, 0x17DD],
5046 [0x180B, 0x180D], [0x18A9, 0x18A9], [0x1920, 0x1922],
5047 [0x1927, 0x1928], [0x1932, 0x1932], [0x1939, 0x193B],
5048 [0x1A17, 0x1A18], [0x1B00, 0x1B03], [0x1B34, 0x1B34],
5049 [0x1B36, 0x1B3A], [0x1B3C, 0x1B3C], [0x1B42, 0x1B42],
5050 [0x1B6B, 0x1B73], [0x1DC0, 0x1DCA], [0x1DFE, 0x1DFF],
5051 [0x200B, 0x200F], [0x202A, 0x202E], [0x2060, 0x2063],
5052 [0x206A, 0x206F], [0x20D0, 0x20EF], [0x302A, 0x302F],
5053 [0x3099, 0x309A], [0xA806, 0xA806], [0xA80B, 0xA80B],
5054 [0xA825, 0xA826], [0xFB1E, 0xFB1E], [0xFE00, 0xFE0F],
5055 [0xFE20, 0xFE23], [0xFEFF, 0xFEFF], [0xFFF9, 0xFFFB],
5056 [0x10A01, 0x10A03], [0x10A05, 0x10A06], [0x10A0C, 0x10A0F],
5057 [0x10A38, 0x10A3A], [0x10A3F, 0x10A3F], [0x1D167, 0x1D169],
5058 [0x1D173, 0x1D182], [0x1D185, 0x1D18B], [0x1D1AA, 0x1D1AD],
5059 [0x1D242, 0x1D244], [0xE0001, 0xE0001], [0xE0020, 0xE007F],
5060 [0xE0100, 0xE01EF]
5061 ];
5062 // binary search
5063 function bisearch(ucs) {
5064 var min = 0;
5065 var max = COMBINING.length - 1;
5066 var mid;
5067 if (ucs < COMBINING[0][0] || ucs > COMBINING[max][1])
5068 return false;
5069 while (max >= min) {
5070 mid = Math.floor((min + max) / 2);
5071 if (ucs > COMBINING[mid][1])
5072 min = mid + 1;
5073 else if (ucs < COMBINING[mid][0])
5074 max = mid - 1;
5075 else
5076 return true;
5077 }
5078 return false;
5079 }
5080 function wcwidth(ucs) {
5081 // test for 8-bit control characters
5082 if (ucs === 0)
5083 return opts.nul;
5084 if (ucs < 32 || (ucs >= 0x7f && ucs < 0xa0))
5085 return opts.control;
5086 // binary search in table of non-spacing characters
5087 if (bisearch(ucs))
5088 return 0;
5089 // if we arrive here, ucs is not a combining or C0/C1 control character
5090 return 1 +
5091 (
5092 ucs >= 0x1100 &&
5093 (
5094 ucs <= 0x115f || // Hangul Jamo init. consonants
5095 ucs == 0x2329 ||
5096 ucs == 0x232a ||
5097 (ucs >= 0x2e80 && ucs <= 0xa4cf && ucs != 0x303f) || // CJK..Yi
5098 (ucs >= 0xac00 && ucs <= 0xd7a3) || // Hangul Syllables
5099 (ucs >= 0xf900 && ucs <= 0xfaff) || // CJK Compat Ideographs
5100 (ucs >= 0xfe10 && ucs <= 0xfe19) || // Vertical forms
5101 (ucs >= 0xfe30 && ucs <= 0xfe6f) || // CJK Compat Forms
5102 (ucs >= 0xff00 && ucs <= 0xff60) || // Fullwidth Forms
5103 (ucs >= 0xffe0 && ucs <= 0xffe6) ||
5104 (ucs >= 0x20000 && ucs <= 0x2fffd) ||
5105 (ucs >= 0x30000 && ucs <= 0x3fffd)
5106 )
5107 );
5108 }
5109 return wcwidth;
5110 })({nul: 0, control: 0}); // configurable options
5111
5112 /**
5113 * Expose
5114 */
5115
5116 Terminal.EventEmitter = EventEmitter;
5117 Terminal.inherits = inherits;
5118
5119 /**
5120 * Adds an event listener to the terminal.
5121 *
5122 * @param {string} event The name of the event. TODO: Document all event types
5123 * @param {function} callback The function to call when the event is triggered.
5124 */
5125 Terminal.on = on;
5126 Terminal.off = off;
5127 Terminal.cancel = cancel;
5128
5129 module.exports = Terminal;