]>
Commit | Line | Data |
---|---|---|
8bc844c0 | 1 | /** |
5af18f8e | 2 | * xterm.js: xterm, in the browser |
8bc844c0 CJ |
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. | |
1d300911 | 10 | * @license MIT |
8bc844c0 CJ |
11 | */ |
12 | ||
081fe3f3 PK |
13 | import { CompositionHelper } from './CompositionHelper'; |
14 | import { EventEmitter } from './EventEmitter'; | |
15 | import { Viewport } from './Viewport'; | |
16 | import { rightClickHandler, pasteHandler, copyHandler } from './handlers/Clipboard'; | |
17 | import { CircularList } from './utils/CircularList'; | |
3de3c0c6 | 18 | import { C0 } from './EscapeSequences'; |
04b1ebf1 | 19 | import { InputHandler } from './InputHandler'; |
1848fff4 | 20 | import { Parser } from './Parser'; |
92068f36 | 21 | import { Renderer } from './Renderer'; |
2207d356 | 22 | import { Linkifier } from './Linkifier'; |
081fe3f3 | 23 | import { CharMeasure } from './utils/CharMeasure'; |
bc70b3b3 | 24 | import * as Browser from './utils/Browser'; |
9937d544 | 25 | import * as Keyboard from './utils/Keyboard'; |
1848fff4 | 26 | import { CHARSETS } from './Charsets'; |
ed1a31d1 | 27 | |
db76868c PK |
28 | /** |
29 | * Terminal Emulation References: | |
30 | * http://vt100.net/ | |
31 | * http://invisible-island.net/xterm/ctlseqs/ctlseqs.txt | |
32 | * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html | |
33 | * http://invisible-island.net/vttest/ | |
34 | * http://www.inwap.com/pdp10/ansicode.txt | |
35 | * http://linux.die.net/man/4/console_codes | |
36 | * http://linux.die.net/man/7/urxvt | |
37 | */ | |
8bc844c0 | 38 | |
db76868c PK |
39 | // Let it work inside Node.js for automated testing purposes. |
40 | var document = (typeof window != 'undefined') ? window.document : null; | |
8bc844c0 | 41 | |
e66b1c57 DI |
42 | /** |
43 | * The amount of write requests to queue before sending an XOFF signal to the | |
44 | * pty process. This number must be small in order for ^C and similar sequences | |
45 | * to be responsive. | |
46 | */ | |
2b8820fd DI |
47 | var WRITE_BUFFER_PAUSE_THRESHOLD = 5; |
48 | ||
49 | /** | |
50 | * The number of writes to perform in a single batch before allowing the | |
51 | * renderer to catch up with a 0ms setTimeout. | |
52 | */ | |
53 | var WRITE_BATCH_SIZE = 300; | |
e66b1c57 | 54 | |
db76868c PK |
55 | /** |
56 | * Terminal | |
57 | */ | |
8bc844c0 | 58 | |
db76868c PK |
59 | /** |
60 | * Creates a new `Terminal` object. | |
61 | * | |
62 | * @param {object} options An object containing a set of options, the available options are: | |
a9417c68 PK |
63 | * - `cursorBlink` (boolean): Whether the terminal cursor blinks |
64 | * - `cols` (number): The number of columns of the terminal (horizontal size) | |
65 | * - `rows` (number): The number of rows of the terminal (vertical size) | |
db76868c PK |
66 | * |
67 | * @public | |
68 | * @class Xterm Xterm | |
69 | * @alias module:xterm/src/xterm | |
70 | */ | |
71 | function Terminal(options) { | |
72 | var self = this; | |
8bc844c0 | 73 | |
db76868c PK |
74 | if (!(this instanceof Terminal)) { |
75 | return new Terminal(arguments[0], arguments[1], arguments[2]); | |
76 | } | |
8bc844c0 | 77 | |
bc70b3b3 | 78 | self.browser = Browser; |
db76868c | 79 | self.cancel = Terminal.cancel; |
8bc844c0 | 80 | |
db76868c | 81 | EventEmitter.call(this); |
5fd1948b | 82 | |
db76868c PK |
83 | if (typeof options === 'number') { |
84 | options = { | |
85 | cols: arguments[0], | |
86 | rows: arguments[1], | |
87 | handler: arguments[2] | |
88 | }; | |
89 | } | |
8bc844c0 | 90 | |
db76868c | 91 | options = options || {}; |
8bc844c0 | 92 | |
86dad1b0 | 93 | |
db76868c PK |
94 | Object.keys(Terminal.defaults).forEach(function(key) { |
95 | if (options[key] == null) { | |
96 | options[key] = Terminal.options[key]; | |
91273161 | 97 | |
db76868c PK |
98 | if (Terminal[key] !== Terminal.defaults[key]) { |
99 | options[key] = Terminal[key]; | |
3f455f90 | 100 | } |
db76868c PK |
101 | } |
102 | self[key] = options[key]; | |
103 | }); | |
104 | ||
105 | if (options.colors.length === 8) { | |
106 | options.colors = options.colors.concat(Terminal._colors.slice(8)); | |
107 | } else if (options.colors.length === 16) { | |
108 | options.colors = options.colors.concat(Terminal._colors.slice(16)); | |
109 | } else if (options.colors.length === 10) { | |
110 | options.colors = options.colors.slice(0, -2).concat( | |
111 | Terminal._colors.slice(8, -2), options.colors.slice(-2)); | |
112 | } else if (options.colors.length === 18) { | |
113 | options.colors = options.colors.concat( | |
114 | Terminal._colors.slice(16, -2), options.colors.slice(-2)); | |
115 | } | |
116 | this.colors = options.colors; | |
117 | ||
118 | this.options = options; | |
119 | ||
120 | // this.context = options.context || window; | |
121 | // this.document = options.document || document; | |
122 | this.parent = options.body || options.parent || ( | |
123 | document ? document.getElementsByTagName('body')[0] : null | |
124 | ); | |
125 | ||
126 | this.cols = options.cols || options.geometry[0]; | |
127 | this.rows = options.rows || options.geometry[1]; | |
a9417c68 | 128 | this.geometry = [this.cols, this.rows]; |
db76868c PK |
129 | |
130 | if (options.handler) { | |
131 | this.on('data', options.handler); | |
132 | } | |
133 | ||
134 | /** | |
135 | * The scroll position of the y cursor, ie. ybase + y = the y position within the entire | |
136 | * buffer | |
137 | */ | |
138 | this.ybase = 0; | |
139 | ||
140 | /** | |
141 | * The scroll position of the viewport | |
142 | */ | |
143 | this.ydisp = 0; | |
144 | ||
145 | /** | |
146 | * The cursor's x position after ybase | |
147 | */ | |
148 | this.x = 0; | |
149 | ||
150 | /** | |
151 | * The cursor's y position after ybase | |
152 | */ | |
153 | this.y = 0; | |
154 | ||
db76868c PK |
155 | this.cursorState = 0; |
156 | this.cursorHidden = false; | |
157 | this.convertEol; | |
db76868c PK |
158 | this.queue = ''; |
159 | this.scrollTop = 0; | |
160 | this.scrollBottom = this.rows - 1; | |
161 | this.customKeydownHandler = null; | |
162 | ||
163 | // modes | |
164 | this.applicationKeypad = false; | |
165 | this.applicationCursor = false; | |
166 | this.originMode = false; | |
167 | this.insertMode = false; | |
168 | this.wraparoundMode = true; // defaults: xterm - true, vt100 - false | |
169 | this.normal = null; | |
170 | ||
171 | // charset | |
172 | this.charset = null; | |
173 | this.gcharset = null; | |
174 | this.glevel = 0; | |
175 | this.charsets = [null]; | |
176 | ||
177 | // mouse properties | |
178 | this.decLocator; | |
179 | this.x10Mouse; | |
180 | this.vt200Mouse; | |
181 | this.vt300Mouse; | |
182 | this.normalMouse; | |
183 | this.mouseEvents; | |
184 | this.sendFocus; | |
185 | this.utfMouse; | |
186 | this.sgrMouse; | |
187 | this.urxvtMouse; | |
188 | ||
189 | // misc | |
190 | this.element; | |
191 | this.children; | |
192 | this.refreshStart; | |
193 | this.refreshEnd; | |
194 | this.savedX; | |
195 | this.savedY; | |
196 | this.savedCols; | |
197 | ||
198 | // stream | |
199 | this.readable = true; | |
200 | this.writable = true; | |
201 | ||
202 | this.defAttr = (0 << 18) | (257 << 9) | (256 << 0); | |
203 | this.curAttr = this.defAttr; | |
204 | ||
205 | this.params = []; | |
206 | this.currentParam = 0; | |
207 | this.prefix = ''; | |
208 | this.postfix = ''; | |
209 | ||
04b1ebf1 | 210 | this.inputHandler = new InputHandler(this); |
a31921ae | 211 | this.parser = new Parser(this.inputHandler, this); |
cc78fdd6 DI |
212 | // Reuse renderer if the Terminal is being recreated via a Terminal.reset call. |
213 | this.renderer = this.renderer || null; | |
2207d356 | 214 | this.linkifier = this.linkifier || null;; |
04b1ebf1 | 215 | |
b9d374af DI |
216 | // user input states |
217 | this.writeBuffer = []; | |
218 | this.writeInProgress = false; | |
e66b1c57 DI |
219 | |
220 | /** | |
221 | * Whether _xterm.js_ sent XOFF in order to catch up with the pty process. | |
222 | * This is a distinct state from writeStopped so that if the user requested | |
223 | * XOFF via ^S that it will not automatically resume when the writeBuffer goes | |
224 | * below threshold. | |
225 | */ | |
226 | this.xoffSentToCatchUp = false; | |
227 | ||
228 | /** Whether writing has been stopped as a result of XOFF */ | |
229 | this.writeStopped = false; | |
b9d374af | 230 | |
db76868c PK |
231 | // leftover surrogate high from previous write invocation |
232 | this.surrogate_high = ''; | |
233 | ||
234 | /** | |
235 | * An array of all lines in the entire buffer, including the prompt. The lines are array of | |
236 | * characters which are 2-length arrays where [0] is an attribute and [1] is the character. | |
237 | */ | |
607c8191 | 238 | this.lines = new CircularList(this.scrollback); |
db76868c PK |
239 | var i = this.rows; |
240 | while (i--) { | |
241 | this.lines.push(this.blankLine()); | |
242 | } | |
243 | ||
244 | this.tabs; | |
245 | this.setupStops(); | |
5e68acfc MK |
246 | |
247 | // Store if user went browsing history in scrollback | |
248 | this.userScrolling = false; | |
db76868c PK |
249 | } |
250 | ||
251 | inherits(Terminal, EventEmitter); | |
252 | ||
253 | /** | |
254 | * back_color_erase feature for xterm. | |
255 | */ | |
256 | Terminal.prototype.eraseAttr = function() { | |
257 | // if (this.is('screen')) return this.defAttr; | |
258 | return (this.defAttr & ~0x1ff) | (this.curAttr & 0x1ff); | |
259 | }; | |
8bc844c0 | 260 | |
db76868c PK |
261 | /** |
262 | * Colors | |
263 | */ | |
91273161 | 264 | |
db76868c PK |
265 | // Colors 0-15 |
266 | Terminal.tangoColors = [ | |
267 | // dark: | |
268 | '#2e3436', | |
269 | '#cc0000', | |
270 | '#4e9a06', | |
271 | '#c4a000', | |
272 | '#3465a4', | |
273 | '#75507b', | |
274 | '#06989a', | |
275 | '#d3d7cf', | |
276 | // bright: | |
277 | '#555753', | |
278 | '#ef2929', | |
279 | '#8ae234', | |
280 | '#fce94f', | |
281 | '#729fcf', | |
282 | '#ad7fa8', | |
283 | '#34e2e2', | |
284 | '#eeeeec' | |
285 | ]; | |
286 | ||
287 | // Colors 0-15 + 16-255 | |
288 | // Much thanks to TooTallNate for writing this. | |
289 | Terminal.colors = (function() { | |
290 | var colors = Terminal.tangoColors.slice() | |
291 | , r = [0x00, 0x5f, 0x87, 0xaf, 0xd7, 0xff] | |
292 | , i; | |
293 | ||
294 | // 16-231 | |
295 | i = 0; | |
296 | for (; i < 216; i++) { | |
297 | out(r[(i / 36) % 6 | 0], r[(i / 6) % 6 | 0], r[i % 6]); | |
298 | } | |
299 | ||
300 | // 232-255 (grey) | |
301 | i = 0; | |
302 | for (; i < 24; i++) { | |
303 | r = 8 + i * 10; | |
304 | out(r, r, r); | |
305 | } | |
306 | ||
307 | function out(r, g, b) { | |
308 | colors.push('#' + hex(r) + hex(g) + hex(b)); | |
309 | } | |
310 | ||
311 | function hex(c) { | |
312 | c = c.toString(16); | |
313 | return c.length < 2 ? '0' + c : c; | |
314 | } | |
315 | ||
316 | return colors; | |
317 | })(); | |
318 | ||
319 | Terminal._colors = Terminal.colors.slice(); | |
320 | ||
321 | Terminal.vcolors = (function() { | |
322 | var out = [] | |
323 | , colors = Terminal.colors | |
324 | , i = 0 | |
325 | , color; | |
326 | ||
327 | for (; i < 256; i++) { | |
328 | color = parseInt(colors[i].substring(1), 16); | |
329 | out.push([ | |
330 | (color >> 16) & 0xff, | |
331 | (color >> 8) & 0xff, | |
332 | color & 0xff | |
333 | ]); | |
334 | } | |
335 | ||
336 | return out; | |
337 | })(); | |
5fd1948b | 338 | |
db76868c PK |
339 | /** |
340 | * Options | |
341 | */ | |
3f455f90 | 342 | |
db76868c PK |
343 | Terminal.defaults = { |
344 | colors: Terminal.colors, | |
345 | theme: 'default', | |
346 | convertEol: false, | |
347 | termName: 'xterm', | |
348 | geometry: [80, 24], | |
349 | cursorBlink: false, | |
0bd469f5 | 350 | cursorStyle: 'block', |
db76868c PK |
351 | visualBell: false, |
352 | popOnBell: false, | |
353 | scrollback: 1000, | |
354 | screenKeys: false, | |
355 | debug: false, | |
d9d60063 | 356 | cancelEvents: false, |
f4293a6d | 357 | disableStdin: false, |
c2a69721 | 358 | useFlowControl: false, |
f4293a6d | 359 | tabStopWidth: 8 |
db76868c PK |
360 | // programFeatures: false, |
361 | // focusKeys: false, | |
362 | }; | |
363 | ||
364 | Terminal.options = {}; | |
365 | ||
366 | Terminal.focus = null; | |
367 | ||
368 | each(keys(Terminal.defaults), function(key) { | |
369 | Terminal[key] = Terminal.defaults[key]; | |
370 | Terminal.options[key] = Terminal.defaults[key]; | |
371 | }); | |
3f455f90 | 372 | |
db76868c PK |
373 | /** |
374 | * Focus the terminal. Delegates focus handling to the terminal's DOM element. | |
375 | */ | |
376 | Terminal.prototype.focus = function() { | |
377 | return this.textarea.focus(); | |
378 | }; | |
3f455f90 | 379 | |
4b459fe0 PK |
380 | /** |
381 | * Retrieves an option's value from the terminal. | |
382 | * @param {string} key The option key. | |
383 | */ | |
384 | Terminal.prototype.getOption = function(key, value) { | |
385 | if (!(key in Terminal.defaults)) { | |
386 | throw new Error('No option with key "' + key + '"'); | |
387 | } | |
388 | ||
53e8ac9b | 389 | if (typeof this.options[key] !== 'undefined') { |
4b459fe0 PK |
390 | return this.options[key]; |
391 | } | |
392 | ||
393 | return this[key]; | |
394 | }; | |
395 | ||
ab5cc0ad DI |
396 | /** |
397 | * Sets an option on the terminal. | |
15e56bd8 DI |
398 | * @param {string} key The option key. |
399 | * @param {string} value The option value. | |
ab5cc0ad DI |
400 | */ |
401 | Terminal.prototype.setOption = function(key, value) { | |
402 | if (!(key in Terminal.defaults)) { | |
403 | throw new Error('No option with key "' + key + '"'); | |
404 | } | |
5a932b2a DI |
405 | switch (key) { |
406 | case 'scrollback': | |
407 | if (this.options[key] !== value) { | |
408 | if (this.lines.length > value) { | |
409 | const amountToTrim = this.lines.length - value; | |
410 | const needsRefresh = (this.ydisp - amountToTrim < 0); | |
411 | this.lines.trimStart(amountToTrim); | |
412 | this.ybase = Math.max(this.ybase - amountToTrim, 0); | |
413 | this.ydisp = Math.max(this.ydisp - amountToTrim, 0); | |
414 | if (needsRefresh) { | |
415 | this.refresh(0, this.rows - 1); | |
416 | } | |
417 | } | |
418 | this.lines.maxLength = value; | |
419 | this.viewport.syncScrollArea(); | |
420 | } | |
421 | break; | |
422 | } | |
ab5cc0ad DI |
423 | this[key] = value; |
424 | this.options[key] = value; | |
7679475b | 425 | switch (key) { |
d1dac57f | 426 | case 'cursorBlink': this.element.classList.toggle('xterm-cursor-blink', value); break; |
0bd469f5 DI |
427 | case 'cursorStyle': |
428 | // Style 'block' applies with no class | |
429 | this.element.classList.toggle(`xterm-cursor-style-underline`, value === 'underline'); | |
430 | this.element.classList.toggle(`xterm-cursor-style-bar`, value === 'bar'); | |
431 | break; | |
8cb46f27 | 432 | case 'tabStopWidth': this.setupStops(); break; |
7679475b | 433 | } |
ab5cc0ad DI |
434 | }; |
435 | ||
db76868c PK |
436 | /** |
437 | * Binds the desired focus behavior on a given terminal object. | |
438 | * | |
439 | * @static | |
440 | */ | |
441 | Terminal.bindFocus = function (term) { | |
442 | on(term.textarea, 'focus', function (ev) { | |
443 | if (term.sendFocus) { | |
3de3c0c6 | 444 | term.send(C0.ESC + '[I'); |
86dad1b0 | 445 | } |
db76868c PK |
446 | term.element.classList.add('focus'); |
447 | term.showCursor(); | |
448 | Terminal.focus = term; | |
449 | term.emit('focus', {terminal: term}); | |
450 | }); | |
451 | }; | |
8bc844c0 | 452 | |
db76868c PK |
453 | /** |
454 | * Blur the terminal. Delegates blur handling to the terminal's DOM element. | |
455 | */ | |
456 | Terminal.prototype.blur = function() { | |
457 | return this.textarea.blur(); | |
458 | }; | |
8bc844c0 | 459 | |
db76868c PK |
460 | /** |
461 | * Binds the desired blur behavior on a given terminal object. | |
462 | * | |
463 | * @static | |
464 | */ | |
465 | Terminal.bindBlur = function (term) { | |
466 | on(term.textarea, 'blur', function (ev) { | |
3c635f3c | 467 | term.refresh(term.y, term.y); |
db76868c | 468 | if (term.sendFocus) { |
3de3c0c6 | 469 | term.send(C0.ESC + '[O'); |
db76868c PK |
470 | } |
471 | term.element.classList.remove('focus'); | |
472 | Terminal.focus = null; | |
473 | term.emit('blur', {terminal: term}); | |
474 | }); | |
475 | }; | |
a68c8336 | 476 | |
db76868c PK |
477 | /** |
478 | * Initialize default behavior | |
479 | */ | |
480 | Terminal.prototype.initGlobal = function() { | |
42a1e4ef PK |
481 | var term = this; |
482 | ||
db76868c | 483 | Terminal.bindKeys(this); |
db76868c PK |
484 | Terminal.bindFocus(this); |
485 | Terminal.bindBlur(this); | |
3f455f90 | 486 | |
42a1e4ef | 487 | // Bind clipboard functionality |
5808de64 | 488 | on(this.element, 'copy', function (ev) { |
489 | copyHandler.call(this, ev, term); | |
490 | }); | |
42a1e4ef PK |
491 | on(this.textarea, 'paste', function (ev) { |
492 | pasteHandler.call(this, ev, term); | |
493 | }); | |
ab87dece PK |
494 | on(this.element, 'paste', function (ev) { |
495 | pasteHandler.call(this, ev, term); | |
496 | }); | |
35637797 | 497 | |
35637797 | 498 | function rightClickHandlerWrapper (ev) { |
42a1e4ef | 499 | rightClickHandler.call(this, ev, term); |
35637797 PK |
500 | } |
501 | ||
547db926 | 502 | if (term.browser.isFirefox) { |
35637797 PK |
503 | on(this.element, 'mousedown', function (ev) { |
504 | if (ev.button == 2) { | |
505 | rightClickHandlerWrapper(ev); | |
506 | } | |
507 | }); | |
508 | } else { | |
509 | on(this.element, 'contextmenu', rightClickHandlerWrapper); | |
510 | } | |
db76868c | 511 | }; |
8bc844c0 | 512 | |
db76868c PK |
513 | /** |
514 | * Apply key handling to the terminal | |
515 | */ | |
516 | Terminal.bindKeys = function(term) { | |
517 | on(term.element, 'keydown', function(ev) { | |
518 | if (document.activeElement != this) { | |
519 | return; | |
520 | } | |
521 | term.keyDown(ev); | |
522 | }, true); | |
8bc844c0 | 523 | |
db76868c PK |
524 | on(term.element, 'keypress', function(ev) { |
525 | if (document.activeElement != this) { | |
526 | return; | |
527 | } | |
528 | term.keyPress(ev); | |
529 | }, true); | |
8bc844c0 | 530 | |
a05bb502 DI |
531 | on(term.element, 'keyup', function(ev) { |
532 | if (!wasMondifierKeyOnlyEvent(ev)) { | |
533 | term.focus(term); | |
534 | } | |
535 | }, true); | |
3b322929 | 536 | |
db76868c PK |
537 | on(term.textarea, 'keydown', function(ev) { |
538 | term.keyDown(ev); | |
539 | }, true); | |
31161ffe | 540 | |
db76868c PK |
541 | on(term.textarea, 'keypress', function(ev) { |
542 | term.keyPress(ev); | |
543 | // Truncate the textarea's value, since it is not needed | |
544 | this.value = ''; | |
545 | }, true); | |
8bc844c0 | 546 | |
db76868c PK |
547 | on(term.textarea, 'compositionstart', term.compositionHelper.compositionstart.bind(term.compositionHelper)); |
548 | on(term.textarea, 'compositionupdate', term.compositionHelper.compositionupdate.bind(term.compositionHelper)); | |
549 | on(term.textarea, 'compositionend', term.compositionHelper.compositionend.bind(term.compositionHelper)); | |
550 | term.on('refresh', term.compositionHelper.updateCompositionElements.bind(term.compositionHelper)); | |
a1d71c91 DI |
551 | term.on('refresh', function (data) { |
552 | term.queueLinkification(data.start, data.end) | |
553 | }); | |
db76868c | 554 | }; |
5fd1948b | 555 | |
3f455f90 | 556 | |
db76868c PK |
557 | /** |
558 | * Insert the given row to the terminal or produce a new one | |
559 | * if no row argument is passed. Return the inserted row. | |
560 | * @param {HTMLElement} row (optional) The row to append to the terminal. | |
561 | */ | |
562 | Terminal.prototype.insertRow = function (row) { | |
563 | if (typeof row != 'object') { | |
564 | row = document.createElement('div'); | |
565 | } | |
cc7f4d0d | 566 | |
db76868c PK |
567 | this.rowContainer.appendChild(row); |
568 | this.children.push(row); | |
cd956bca | 569 | |
db76868c PK |
570 | return row; |
571 | }; | |
7988f634 | 572 | |
db76868c PK |
573 | /** |
574 | * Opens the terminal within an element. | |
575 | * | |
576 | * @param {HTMLElement} parent The element to create the terminal within. | |
577 | */ | |
578 | Terminal.prototype.open = function(parent) { | |
579 | var self=this, i=0, div; | |
580 | ||
581 | this.parent = parent || this.parent; | |
582 | ||
583 | if (!this.parent) { | |
584 | throw new Error('Terminal requires a parent element.'); | |
585 | } | |
586 | ||
587 | // Grab global elements | |
588 | this.context = this.parent.ownerDocument.defaultView; | |
589 | this.document = this.parent.ownerDocument; | |
590 | this.body = this.document.getElementsByTagName('body')[0]; | |
591 | ||
db76868c PK |
592 | //Create main element container |
593 | this.element = this.document.createElement('div'); | |
594 | this.element.classList.add('terminal'); | |
595 | this.element.classList.add('xterm'); | |
596 | this.element.classList.add('xterm-theme-' + this.theme); | |
d1dac57f | 597 | this.element.classList.toggle('xterm-cursor-blink', this.options.cursorBlink); |
db76868c PK |
598 | |
599 | this.element.style.height | |
600 | this.element.setAttribute('tabindex', 0); | |
601 | ||
602 | this.viewportElement = document.createElement('div'); | |
603 | this.viewportElement.classList.add('xterm-viewport'); | |
604 | this.element.appendChild(this.viewportElement); | |
605 | this.viewportScrollArea = document.createElement('div'); | |
606 | this.viewportScrollArea.classList.add('xterm-scroll-area'); | |
607 | this.viewportElement.appendChild(this.viewportScrollArea); | |
608 | ||
609 | // Create the container that will hold the lines of the terminal and then | |
610 | // produce the lines the lines. | |
611 | this.rowContainer = document.createElement('div'); | |
612 | this.rowContainer.classList.add('xterm-rows'); | |
613 | this.element.appendChild(this.rowContainer); | |
614 | this.children = []; | |
26ebc3d9 | 615 | this.linkifier = new Linkifier(document, this.children); |
db76868c PK |
616 | |
617 | // Create the container that will hold helpers like the textarea for | |
618 | // capturing DOM Events. Then produce the helpers. | |
619 | this.helperContainer = document.createElement('div'); | |
620 | this.helperContainer.classList.add('xterm-helpers'); | |
621 | // TODO: This should probably be inserted once it's filled to prevent an additional layout | |
622 | this.element.appendChild(this.helperContainer); | |
623 | this.textarea = document.createElement('textarea'); | |
624 | this.textarea.classList.add('xterm-helper-textarea'); | |
625 | this.textarea.setAttribute('autocorrect', 'off'); | |
626 | this.textarea.setAttribute('autocapitalize', 'off'); | |
627 | this.textarea.setAttribute('spellcheck', 'false'); | |
628 | this.textarea.tabIndex = 0; | |
629 | this.textarea.addEventListener('focus', function() { | |
630 | self.emit('focus', {terminal: self}); | |
631 | }); | |
632 | this.textarea.addEventListener('blur', function() { | |
633 | self.emit('blur', {terminal: self}); | |
634 | }); | |
635 | this.helperContainer.appendChild(this.textarea); | |
636 | ||
637 | this.compositionView = document.createElement('div'); | |
638 | this.compositionView.classList.add('composition-view'); | |
639 | this.compositionHelper = new CompositionHelper(this.textarea, this.compositionView, this); | |
640 | this.helperContainer.appendChild(this.compositionView); | |
641 | ||
74483fb2 DI |
642 | this.charSizeStyleElement = document.createElement('style'); |
643 | this.helperContainer.appendChild(this.charSizeStyleElement); | |
db76868c PK |
644 | |
645 | for (; i < this.rows; i++) { | |
646 | this.insertRow(); | |
647 | } | |
648 | this.parent.appendChild(this.element); | |
649 | ||
202b54af | 650 | this.charMeasure = new CharMeasure(document, this.helperContainer); |
74483fb2 DI |
651 | this.charMeasure.on('charsizechanged', function () { |
652 | self.updateCharSizeCSS(); | |
653 | }); | |
4f18d842 DI |
654 | this.charMeasure.measure(); |
655 | ||
74483fb2 | 656 | this.viewport = new Viewport(this, this.viewportElement, this.viewportScrollArea, this.charMeasure); |
92068f36 | 657 | this.renderer = new Renderer(this); |
db76868c | 658 | |
97feb332 | 659 | // Setup loop that draws to screen |
3c635f3c | 660 | this.refresh(0, this.rows - 1); |
db76868c PK |
661 | |
662 | // Initialize global actions that | |
663 | // need to be taken on the document. | |
664 | this.initGlobal(); | |
665 | ||
666 | // Ensure there is a Terminal.focus. | |
667 | this.focus(); | |
668 | ||
4e1bbee6 | 669 | on(this.element, 'click', function() { |
db76868c PK |
670 | var selection = document.getSelection(), |
671 | collapsed = selection.isCollapsed, | |
672 | isRange = typeof collapsed == 'boolean' ? !collapsed : selection.type == 'Range'; | |
673 | if (!isRange) { | |
674 | self.focus(); | |
675 | } | |
676 | }); | |
3f455f90 | 677 | |
db76868c PK |
678 | // Listen for mouse events and translate |
679 | // them into terminal mouse protocols. | |
680 | this.bindMouse(); | |
8bc844c0 | 681 | |
5712365c Y |
682 | /** |
683 | * This event is emitted when terminal has completed opening. | |
684 | * | |
685 | * @event open | |
686 | */ | |
db76868c PK |
687 | this.emit('open'); |
688 | }; | |
8bc844c0 | 689 | |
8bc844c0 | 690 | |
db76868c PK |
691 | /** |
692 | * Attempts to load an add-on using CommonJS or RequireJS (whichever is available). | |
693 | * @param {string} addon The name of the addon to load | |
694 | * @static | |
695 | */ | |
696 | Terminal.loadAddon = function(addon, callback) { | |
697 | if (typeof exports === 'object' && typeof module === 'object') { | |
698 | // CommonJS | |
56ecc77d | 699 | return require('./addons/' + addon + '/' + addon); |
db76868c PK |
700 | } else if (typeof define == 'function') { |
701 | // RequireJS | |
56ecc77d | 702 | return require(['./addons/' + addon + '/' + addon], callback); |
db76868c PK |
703 | } else { |
704 | console.error('Cannot load a module without a CommonJS or RequireJS environment.'); | |
705 | return false; | |
706 | } | |
707 | }; | |
8bc844c0 | 708 | |
74483fb2 DI |
709 | /** |
710 | * Updates the helper CSS class with any changes necessary after the terminal's | |
711 | * character width has been changed. | |
712 | */ | |
713 | Terminal.prototype.updateCharSizeCSS = function() { | |
714 | this.charSizeStyleElement.textContent = '.xterm-wide-char{width:' + (this.charMeasure.width * 2) + 'px;}'; | |
715 | } | |
8bc844c0 | 716 | |
db76868c PK |
717 | /** |
718 | * XTerm mouse events | |
719 | * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#Mouse%20Tracking | |
720 | * To better understand these | |
721 | * the xterm code is very helpful: | |
722 | * Relevant files: | |
723 | * button.c, charproc.c, misc.c | |
724 | * Relevant functions in xterm/button.c: | |
725 | * BtnCode, EmitButtonCode, EditorButton, SendMousePosition | |
726 | */ | |
727 | Terminal.prototype.bindMouse = function() { | |
728 | var el = this.element, self = this, pressed = 32; | |
729 | ||
730 | // mouseup, mousedown, wheel | |
731 | // left click: ^[[M 3<^[[M#3< | |
732 | // wheel up: ^[[M`3> | |
733 | function sendButton(ev) { | |
734 | var button | |
735 | , pos; | |
736 | ||
737 | // get the xterm-style button | |
738 | button = getButton(ev); | |
739 | ||
740 | // get mouse coordinates | |
741 | pos = getCoords(ev); | |
742 | if (!pos) return; | |
743 | ||
744 | sendEvent(button, pos); | |
745 | ||
746 | switch (ev.overrideType || ev.type) { | |
747 | case 'mousedown': | |
748 | pressed = button; | |
749 | break; | |
750 | case 'mouseup': | |
751 | // keep it at the left | |
752 | // button, just in case. | |
753 | pressed = 32; | |
754 | break; | |
755 | case 'wheel': | |
756 | // nothing. don't | |
757 | // interfere with | |
758 | // `pressed`. | |
759 | break; | |
760 | } | |
761 | } | |
762 | ||
763 | // motion example of a left click: | |
764 | // ^[[M 3<^[[M@4<^[[M@5<^[[M@6<^[[M@7<^[[M#7< | |
765 | function sendMove(ev) { | |
766 | var button = pressed | |
767 | , pos; | |
768 | ||
769 | pos = getCoords(ev); | |
770 | if (!pos) return; | |
771 | ||
772 | // buttons marked as motions | |
773 | // are incremented by 32 | |
774 | button += 32; | |
775 | ||
776 | sendEvent(button, pos); | |
777 | } | |
778 | ||
779 | // encode button and | |
780 | // position to characters | |
781 | function encode(data, ch) { | |
782 | if (!self.utfMouse) { | |
783 | if (ch === 255) return data.push(0); | |
784 | if (ch > 127) ch = 127; | |
785 | data.push(ch); | |
786 | } else { | |
787 | if (ch === 2047) return data.push(0); | |
788 | if (ch < 127) { | |
789 | data.push(ch); | |
790 | } else { | |
791 | if (ch > 2047) ch = 2047; | |
792 | data.push(0xC0 | (ch >> 6)); | |
793 | data.push(0x80 | (ch & 0x3F)); | |
794 | } | |
795 | } | |
796 | } | |
797 | ||
798 | // send a mouse event: | |
799 | // regular/utf8: ^[[M Cb Cx Cy | |
800 | // urxvt: ^[[ Cb ; Cx ; Cy M | |
801 | // sgr: ^[[ Cb ; Cx ; Cy M/m | |
802 | // vt300: ^[[ 24(1/3/5)~ [ Cx , Cy ] \r | |
803 | // locator: CSI P e ; P b ; P r ; P c ; P p & w | |
804 | function sendEvent(button, pos) { | |
805 | // self.emit('mouse', { | |
806 | // x: pos.x - 32, | |
807 | // y: pos.x - 32, | |
808 | // button: button | |
809 | // }); | |
810 | ||
811 | if (self.vt300Mouse) { | |
812 | // NOTE: Unstable. | |
813 | // http://www.vt100.net/docs/vt3xx-gp/chapter15.html | |
814 | button &= 3; | |
815 | pos.x -= 32; | |
816 | pos.y -= 32; | |
3de3c0c6 | 817 | var data = C0.ESC + '[24'; |
db76868c PK |
818 | if (button === 0) data += '1'; |
819 | else if (button === 1) data += '3'; | |
820 | else if (button === 2) data += '5'; | |
821 | else if (button === 3) return; | |
822 | else data += '0'; | |
823 | data += '~[' + pos.x + ',' + pos.y + ']\r'; | |
824 | self.send(data); | |
825 | return; | |
826 | } | |
00f4232e | 827 | |
db76868c PK |
828 | if (self.decLocator) { |
829 | // NOTE: Unstable. | |
830 | button &= 3; | |
831 | pos.x -= 32; | |
832 | pos.y -= 32; | |
833 | if (button === 0) button = 2; | |
834 | else if (button === 1) button = 4; | |
835 | else if (button === 2) button = 6; | |
836 | else if (button === 3) button = 3; | |
3de3c0c6 | 837 | self.send(C0.ESC + '[' |
db76868c PK |
838 | + button |
839 | + ';' | |
840 | + (button === 3 ? 4 : 0) | |
841 | + ';' | |
842 | + pos.y | |
843 | + ';' | |
844 | + pos.x | |
845 | + ';' | |
846 | + (pos.page || 0) | |
847 | + '&w'); | |
848 | return; | |
849 | } | |
00f4232e | 850 | |
db76868c PK |
851 | if (self.urxvtMouse) { |
852 | pos.x -= 32; | |
853 | pos.y -= 32; | |
854 | pos.x++; | |
855 | pos.y++; | |
3de3c0c6 | 856 | self.send(C0.ESC + '[' + button + ';' + pos.x + ';' + pos.y + 'M'); |
db76868c PK |
857 | return; |
858 | } | |
8bc844c0 | 859 | |
db76868c PK |
860 | if (self.sgrMouse) { |
861 | pos.x -= 32; | |
862 | pos.y -= 32; | |
3de3c0c6 | 863 | self.send(C0.ESC + '[<' |
a75bafc4 | 864 | + (((button & 3) === 3 ? button & ~3 : button) - 32) |
db76868c PK |
865 | + ';' |
866 | + pos.x | |
867 | + ';' | |
868 | + pos.y | |
869 | + ((button & 3) === 3 ? 'm' : 'M')); | |
870 | return; | |
871 | } | |
8bc844c0 | 872 | |
db76868c PK |
873 | var data = []; |
874 | ||
875 | encode(data, button); | |
876 | encode(data, pos.x); | |
877 | encode(data, pos.y); | |
878 | ||
3de3c0c6 | 879 | self.send(C0.ESC + '[M' + String.fromCharCode.apply(String, data)); |
db76868c PK |
880 | } |
881 | ||
882 | function getButton(ev) { | |
883 | var button | |
884 | , shift | |
885 | , meta | |
886 | , ctrl | |
887 | , mod; | |
888 | ||
889 | // two low bits: | |
890 | // 0 = left | |
891 | // 1 = middle | |
892 | // 2 = right | |
893 | // 3 = release | |
894 | // wheel up/down: | |
895 | // 1, and 2 - with 64 added | |
896 | switch (ev.overrideType || ev.type) { | |
897 | case 'mousedown': | |
898 | button = ev.button != null | |
899 | ? +ev.button | |
900 | : ev.which != null | |
901 | ? ev.which - 1 | |
902 | : null; | |
903 | ||
bc70b3b3 | 904 | if (self.browser.isMSIE) { |
db76868c PK |
905 | button = button === 1 ? 0 : button === 4 ? 1 : button; |
906 | } | |
907 | break; | |
908 | case 'mouseup': | |
909 | button = 3; | |
910 | break; | |
911 | case 'DOMMouseScroll': | |
912 | button = ev.detail < 0 | |
913 | ? 64 | |
914 | : 65; | |
915 | break; | |
916 | case 'wheel': | |
917 | button = ev.wheelDeltaY > 0 | |
918 | ? 64 | |
919 | : 65; | |
920 | break; | |
921 | } | |
8bc844c0 | 922 | |
db76868c PK |
923 | // next three bits are the modifiers: |
924 | // 4 = shift, 8 = meta, 16 = control | |
925 | shift = ev.shiftKey ? 4 : 0; | |
926 | meta = ev.metaKey ? 8 : 0; | |
927 | ctrl = ev.ctrlKey ? 16 : 0; | |
928 | mod = shift | meta | ctrl; | |
929 | ||
930 | // no mods | |
931 | if (self.vt200Mouse) { | |
932 | // ctrl only | |
933 | mod &= ctrl; | |
934 | } else if (!self.normalMouse) { | |
935 | mod = 0; | |
936 | } | |
8bc844c0 | 937 | |
db76868c PK |
938 | // increment to SP |
939 | button = (32 + (mod << 2)) + button; | |
a52b7e7a | 940 | |
db76868c PK |
941 | return button; |
942 | } | |
8bc844c0 | 943 | |
db76868c PK |
944 | // mouse coordinates measured in cols/rows |
945 | function getCoords(ev) { | |
946 | var x, y, w, h, el; | |
8bc844c0 | 947 | |
db76868c PK |
948 | // ignore browsers without pageX for now |
949 | if (ev.pageX == null) return; | |
8bc844c0 | 950 | |
db76868c PK |
951 | x = ev.pageX; |
952 | y = ev.pageY; | |
953 | el = self.element; | |
8bc844c0 | 954 | |
db76868c PK |
955 | // should probably check offsetParent |
956 | // but this is more portable | |
957 | while (el && el !== self.document.documentElement) { | |
958 | x -= el.offsetLeft; | |
959 | y -= el.offsetTop; | |
960 | el = 'offsetParent' in el | |
961 | ? el.offsetParent | |
962 | : el.parentNode; | |
963 | } | |
3f455f90 | 964 | |
db76868c | 965 | // convert to cols/rows |
5452986c DI |
966 | x = Math.ceil(x / self.charMeasure.width); |
967 | y = Math.ceil(y / self.charMeasure.height); | |
db76868c PK |
968 | |
969 | // be sure to avoid sending | |
970 | // bad positions to the program | |
971 | if (x < 0) x = 0; | |
972 | if (x > self.cols) x = self.cols; | |
973 | if (y < 0) y = 0; | |
974 | if (y > self.rows) y = self.rows; | |
975 | ||
976 | // xterm sends raw bytes and | |
977 | // starts at 32 (SP) for each. | |
978 | x += 32; | |
979 | y += 32; | |
980 | ||
981 | return { | |
982 | x: x, | |
983 | y: y, | |
984 | type: 'wheel' | |
f3bd6145 | 985 | }; |
db76868c | 986 | } |
8bc844c0 | 987 | |
db76868c PK |
988 | on(el, 'mousedown', function(ev) { |
989 | if (!self.mouseEvents) return; | |
8bc844c0 | 990 | |
db76868c PK |
991 | // send the button |
992 | sendButton(ev); | |
8bc844c0 | 993 | |
db76868c PK |
994 | // ensure focus |
995 | self.focus(); | |
8bc844c0 | 996 | |
db76868c PK |
997 | // fix for odd bug |
998 | //if (self.vt200Mouse && !self.normalMouse) { | |
999 | if (self.vt200Mouse) { | |
1000 | ev.overrideType = 'mouseup'; | |
1001 | sendButton(ev); | |
1002 | return self.cancel(ev); | |
1003 | } | |
8bc844c0 | 1004 | |
db76868c PK |
1005 | // bind events |
1006 | if (self.normalMouse) on(self.document, 'mousemove', sendMove); | |
b01165c1 | 1007 | |
db76868c PK |
1008 | // x10 compatibility mode can't send button releases |
1009 | if (!self.x10Mouse) { | |
1010 | on(self.document, 'mouseup', function up(ev) { | |
1011 | sendButton(ev); | |
1012 | if (self.normalMouse) off(self.document, 'mousemove', sendMove); | |
1013 | off(self.document, 'mouseup', up); | |
1014 | return self.cancel(ev); | |
4595a181 | 1015 | }); |
db76868c | 1016 | } |
29000fb7 | 1017 | |
db76868c PK |
1018 | return self.cancel(ev); |
1019 | }); | |
1020 | ||
1021 | //if (self.normalMouse) { | |
1022 | // on(self.document, 'mousemove', sendMove); | |
1023 | //} | |
1024 | ||
1025 | on(el, 'wheel', function(ev) { | |
1026 | if (!self.mouseEvents) return; | |
1027 | if (self.x10Mouse | |
1028 | || self.vt300Mouse | |
1029 | || self.decLocator) return; | |
1030 | sendButton(ev); | |
1031 | return self.cancel(ev); | |
1032 | }); | |
1033 | ||
1034 | // allow wheel scrolling in | |
1035 | // the shell for example | |
1036 | on(el, 'wheel', function(ev) { | |
1037 | if (self.mouseEvents) return; | |
db76868c PK |
1038 | self.viewport.onWheel(ev); |
1039 | return self.cancel(ev); | |
1040 | }); | |
1041 | }; | |
fc7b22dc | 1042 | |
db76868c PK |
1043 | /** |
1044 | * Destroys the terminal. | |
1045 | */ | |
1046 | Terminal.prototype.destroy = function() { | |
1047 | this.readable = false; | |
1048 | this.writable = false; | |
1049 | this._events = {}; | |
1050 | this.handler = function() {}; | |
1051 | this.write = function() {}; | |
833eb521 | 1052 | if (this.element && this.element.parentNode) { |
db76868c PK |
1053 | this.element.parentNode.removeChild(this.element); |
1054 | } | |
1055 | //this.emit('close'); | |
1056 | }; | |
670b0d58 | 1057 | |
db76868c | 1058 | /** |
92068f36 DI |
1059 | * Tells the renderer to refresh terminal content between two rows (inclusive) at the next |
1060 | * opportunity. | |
a1d71c91 DI |
1061 | * @param {number} start The row to start from (between 0 and this.rows - 1). |
1062 | * @param {number} end The row to end at (between start and this.rows - 1). | |
7234bfb6 | 1063 | */ |
92068f36 | 1064 | Terminal.prototype.refresh = function(start, end) { |
92068f36 DI |
1065 | if (this.renderer) { |
1066 | this.renderer.queueRefresh(start, end); | |
a1d71c91 DI |
1067 | } |
1068 | }; | |
2207d356 | 1069 | |
a1d71c91 DI |
1070 | /** |
1071 | * Queues linkification for the specified rows. | |
1072 | * @param {number} start The row to start from (between 0 and this.rows - 1). | |
1073 | * @param {number} end The row to end at (between start and this.rows - 1). | |
1074 | */ | |
1075 | Terminal.prototype.queueLinkification = function(start, end) { | |
1076 | if (this.linkifier) { | |
2207d356 DI |
1077 | for (let i = start; i <= end; i++) { |
1078 | this.linkifier.linkifyRow(i); | |
1079 | } | |
db76868c | 1080 | } |
a1d71c91 | 1081 | } |
8bc844c0 | 1082 | |
db76868c PK |
1083 | /** |
1084 | * Display the cursor element | |
1085 | */ | |
1086 | Terminal.prototype.showCursor = function() { | |
1087 | if (!this.cursorState) { | |
1088 | this.cursorState = 1; | |
3c635f3c | 1089 | this.refresh(this.y, this.y); |
db76868c PK |
1090 | } |
1091 | }; | |
8bc844c0 | 1092 | |
db76868c | 1093 | /** |
be56c72b | 1094 | * Scroll the terminal down 1 row, creating a blank line. |
db76868c PK |
1095 | */ |
1096 | Terminal.prototype.scroll = function() { | |
1097 | var row; | |
1098 | ||
c3f46e4a DI |
1099 | // Make room for the new row in lines |
1100 | if (this.lines.length === this.lines.maxLength) { | |
1101 | this.lines.trimStart(1); | |
1102 | this.ybase--; | |
1103 | if (this.ydisp !== 0) { | |
1104 | this.ydisp--; | |
1105 | } | |
1106 | } | |
1107 | ||
30a1f1cc | 1108 | this.ybase++; |
db76868c | 1109 | |
3b35d12e | 1110 | // TODO: Why is this done twice? |
5e68acfc MK |
1111 | if (!this.userScrolling) { |
1112 | this.ydisp = this.ybase; | |
1113 | } | |
db76868c PK |
1114 | |
1115 | // last line | |
1116 | row = this.ybase + this.rows - 1; | |
1117 | ||
1118 | // subtract the bottom scroll region | |
1119 | row -= this.rows - 1 - this.scrollBottom; | |
1120 | ||
6f7cb990 DI |
1121 | if (row === this.lines.length) { |
1122 | // Optimization: pushing is faster than splicing when they amount to the same behavior | |
1123 | this.lines.push(this.blankLine()); | |
1124 | } else { | |
1125 | // add our new line | |
1126 | this.lines.splice(row, 0, this.blankLine()); | |
1127 | } | |
db76868c PK |
1128 | |
1129 | if (this.scrollTop !== 0) { | |
1130 | if (this.ybase !== 0) { | |
1131 | this.ybase--; | |
5e68acfc MK |
1132 | if (!this.userScrolling) { |
1133 | this.ydisp = this.ybase; | |
1134 | } | |
db76868c PK |
1135 | } |
1136 | this.lines.splice(this.ybase + this.scrollTop, 1); | |
1137 | } | |
8bc844c0 | 1138 | |
db76868c PK |
1139 | // this.maxRange(); |
1140 | this.updateRange(this.scrollTop); | |
1141 | this.updateRange(this.scrollBottom); | |
8bc844c0 | 1142 | |
6dcf7267 Y |
1143 | /** |
1144 | * This event is emitted whenever the terminal is scrolled. | |
1145 | * The one parameter passed is the new y display position. | |
1146 | * | |
1147 | * @event scroll | |
1148 | */ | |
db76868c PK |
1149 | this.emit('scroll', this.ydisp); |
1150 | }; | |
1151 | ||
1152 | /** | |
1153 | * Scroll the display of the terminal | |
1154 | * @param {number} disp The number of lines to scroll down (negatives scroll up). | |
1155 | * @param {boolean} suppressScrollEvent Don't emit the scroll event as scrollDisp. This is used | |
1156 | * to avoid unwanted events being handled by the veiwport when the event was triggered from the | |
1157 | * viewport originally. | |
1158 | */ | |
1159 | Terminal.prototype.scrollDisp = function(disp, suppressScrollEvent) { | |
5e68acfc MK |
1160 | if (disp < 0) { |
1161 | this.userScrolling = true; | |
1162 | } else if (disp + this.ydisp >= this.ybase) { | |
1163 | this.userScrolling = false; | |
1164 | } | |
1165 | ||
db76868c | 1166 | this.ydisp += disp; |
8bc844c0 | 1167 | |
db76868c PK |
1168 | if (this.ydisp > this.ybase) { |
1169 | this.ydisp = this.ybase; | |
1170 | } else if (this.ydisp < 0) { | |
1171 | this.ydisp = 0; | |
1172 | } | |
8bc844c0 | 1173 | |
db76868c PK |
1174 | if (!suppressScrollEvent) { |
1175 | this.emit('scroll', this.ydisp); | |
1176 | } | |
8bc844c0 | 1177 | |
3c635f3c | 1178 | this.refresh(0, this.rows - 1); |
db76868c | 1179 | }; |
8bc844c0 | 1180 | |
fe0d878b DI |
1181 | /** |
1182 | * Scroll the display of the terminal by a number of pages. | |
0ad02a4a | 1183 | * @param {number} pageCount The number of pages to scroll (negative scrolls up). |
fe0d878b DI |
1184 | */ |
1185 | Terminal.prototype.scrollPages = function(pageCount) { | |
1186 | this.scrollDisp(pageCount * (this.rows - 1)); | |
1187 | } | |
1188 | ||
0bf7bf56 DI |
1189 | /** |
1190 | * Scrolls the display of the terminal to the top. | |
1191 | */ | |
e5d130b6 DI |
1192 | Terminal.prototype.scrollToTop = function() { |
1193 | this.scrollDisp(-this.ydisp); | |
1194 | } | |
1195 | ||
0bf7bf56 DI |
1196 | /** |
1197 | * Scrolls the display of the terminal to the bottom. | |
1198 | */ | |
e5d130b6 DI |
1199 | Terminal.prototype.scrollToBottom = function() { |
1200 | this.scrollDisp(this.ybase - this.ydisp); | |
1201 | } | |
1202 | ||
db76868c PK |
1203 | /** |
1204 | * Writes text to the terminal. | |
1205 | * @param {string} text The text to write to the terminal. | |
1206 | */ | |
1207 | Terminal.prototype.write = function(data) { | |
b9d374af | 1208 | this.writeBuffer.push(data); |
6b8c43ed | 1209 | |
e66b1c57 DI |
1210 | // Send XOFF to pause the pty process if the write buffer becomes too large so |
1211 | // xterm.js can catch up before more data is sent. This is necessary in order | |
1212 | // to keep signals such as ^C responsive. | |
c2a69721 | 1213 | if (this.options.useFlowControl && !this.xoffSentToCatchUp && this.writeBuffer.length >= WRITE_BUFFER_PAUSE_THRESHOLD) { |
6b8c43ed DI |
1214 | // XOFF - stop pty pipe |
1215 | // XON will be triggered by emulator before processing data chunk | |
0ec12555 | 1216 | this.send(C0.DC3); |
e66b1c57 | 1217 | this.xoffSentToCatchUp = true; |
6b8c43ed DI |
1218 | } |
1219 | ||
1220 | if (!this.writeInProgress && this.writeBuffer.length > 0) { | |
b9d374af DI |
1221 | // Kick off a write which will write all data in sequence recursively |
1222 | this.writeInProgress = true; | |
1223 | // Kick off an async innerWrite so more writes can come in while processing data | |
6b8c43ed DI |
1224 | var self = this; |
1225 | setTimeout(function () { | |
dc5efa88 | 1226 | self.innerWrite(); |
6b8c43ed | 1227 | }); |
b9d374af DI |
1228 | } |
1229 | } | |
1230 | ||
dc5efa88 | 1231 | Terminal.prototype.innerWrite = function() { |
2b8820fd DI |
1232 | var writeBatch = this.writeBuffer.splice(0, WRITE_BATCH_SIZE); |
1233 | while (writeBatch.length > 0) { | |
1234 | var data = writeBatch.shift(); | |
dc5efa88 | 1235 | var l = data.length, i = 0, j, cs, ch, code, low, ch_width, row; |
e66b1c57 | 1236 | |
dc5efa88 DI |
1237 | // If XOFF was sent in order to catch up with the pty process, resume it if |
1238 | // the writeBuffer is empty to allow more data to come in. | |
2b8820fd | 1239 | if (this.xoffSentToCatchUp && writeBatch.length === 0 && this.writeBuffer.length === 0) { |
0ec12555 | 1240 | this.send(C0.DC1); |
dc5efa88 DI |
1241 | this.xoffSentToCatchUp = false; |
1242 | } | |
db76868c | 1243 | |
dc5efa88 DI |
1244 | this.refreshStart = this.y; |
1245 | this.refreshEnd = this.y; | |
db76868c | 1246 | |
342e862d | 1247 | this.parser.parse(data); |
3f455f90 | 1248 | |
dc5efa88 | 1249 | this.updateRange(this.y); |
3c635f3c | 1250 | this.refresh(this.refreshStart, this.refreshEnd); |
b9d374af | 1251 | } |
2b8820fd DI |
1252 | if (this.writeBuffer.length > 0) { |
1253 | // Allow renderer to catch up before processing the next batch | |
1254 | var self = this; | |
1255 | setTimeout(function () { | |
1256 | self.innerWrite(); | |
1257 | }, 0); | |
1258 | } else { | |
1259 | this.writeInProgress = false; | |
1260 | } | |
db76868c | 1261 | }; |
3f455f90 | 1262 | |
db76868c PK |
1263 | /** |
1264 | * Writes text to the terminal, followed by a break line character (\n). | |
1265 | * @param {string} text The text to write to the terminal. | |
1266 | */ | |
1267 | Terminal.prototype.writeln = function(data) { | |
1268 | this.write(data + '\r\n'); | |
1269 | }; | |
3f455f90 | 1270 | |
db76868c PK |
1271 | /** |
1272 | * Attaches a custom keydown handler which is run before keys are processed, giving consumers of | |
1273 | * xterm.js ultimate control as to what keys should be processed by the terminal and what keys | |
1274 | * should not. | |
1275 | * @param {function} customKeydownHandler The custom KeyboardEvent handler to attach. This is a | |
1276 | * function that takes a KeyboardEvent, allowing consumers to stop propogation and/or prevent | |
1277 | * the default action. The function returns whether the event should be processed by xterm.js. | |
1278 | */ | |
1279 | Terminal.prototype.attachCustomKeydownHandler = function(customKeydownHandler) { | |
1280 | this.customKeydownHandler = customKeydownHandler; | |
1281 | } | |
3f455f90 | 1282 | |
a1d71c91 DI |
1283 | /** |
1284 | * Attaches a http(s) link handler, forcing web links to behave differently to | |
1285 | * regular <a> tags. This will trigger a refresh as links potentially need to be | |
1286 | * reconstructed. Calling this with null will remove the handler. | |
1287 | * @param {LinkHandler} handler The handler callback function. | |
1288 | */ | |
11f62bab | 1289 | Terminal.prototype.setHypertextLinkHandler = function(handler) { |
0f3ee21d DI |
1290 | if (!this.linkifier) { |
1291 | throw new Error('Cannot attach a hypertext link handler before Terminal.open is called'); | |
1292 | } | |
1293 | this.linkifier.attachHypertextLinkHandler(handler); | |
1294 | // Refresh to force links to refresh | |
1295 | this.refresh(0, this.rows - 1); | |
1296 | } | |
1297 | ||
11f62bab DI |
1298 | /** |
1299 | * Attaches a validation callback for hypertext links. This is useful to use | |
1300 | * validation logic or to do something with the link's element and url. | |
1301 | * @param {LinkMatcherValidationCallback} callback The callback to use, this can | |
1302 | * be cleared with null. | |
1303 | */ | |
1304 | Terminal.prototype.setHypertextValidationCallback = function(handler) { | |
1305 | if (!this.linkifier) { | |
1306 | throw new Error('Cannot attach a hypertext validation callback before Terminal.open is called'); | |
1307 | } | |
1308 | this.linkifier.setHypertextValidationCallback(handler); | |
1309 | // Refresh to force links to refresh | |
1310 | this.refresh(0, this.rows - 1); | |
1311 | } | |
1312 | ||
c8bb3216 | 1313 | /** |
3b62aa44 DI |
1314 | * Registers a link matcher, allowing custom link patterns to be matched and |
1315 | * handled. | |
1316 | * @param {RegExp} regex The regular expression to search for, specifically | |
1317 | * this searches the textContent of the rows. You will want to use \s to match | |
1318 | * a space ' ' character for example. | |
1319 | * @param {LinkHandler} handler The callback when the link is called. | |
6198556e | 1320 | * @param {LinkMatcherOptions} [options] Options for the link matcher. |
3b62aa44 | 1321 | * @return {number} The ID of the new matcher, this can be used to deregister. |
c8bb3216 | 1322 | */ |
6198556e | 1323 | Terminal.prototype.registerLinkMatcher = function(regex, handler, options) { |
c8bb3216 | 1324 | if (this.linkifier) { |
6198556e | 1325 | var matcherId = this.linkifier.registerLinkMatcher(regex, handler, options); |
1c030f57 DI |
1326 | this.refresh(0, this.rows - 1); |
1327 | return matcherId; | |
c8bb3216 DI |
1328 | } |
1329 | } | |
1330 | ||
1331 | /** | |
1332 | * Deregisters a link matcher if it has been registered. | |
1333 | * @param {number} matcherId The link matcher's ID (returned after register) | |
1334 | */ | |
1335 | Terminal.prototype.deregisterLinkMatcher = function(matcherId) { | |
1336 | if (this.linkifier) { | |
1c030f57 DI |
1337 | if (this.linkifier.deregisterLinkMatcher(matcherId)) { |
1338 | this.refresh(0, this.rows - 1); | |
1339 | } | |
c8bb3216 DI |
1340 | } |
1341 | } | |
1342 | ||
db76868c PK |
1343 | /** |
1344 | * Handle a keydown event | |
1345 | * Key Resources: | |
1346 | * - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent | |
1347 | * @param {KeyboardEvent} ev The keydown event to be handled. | |
1348 | */ | |
1349 | Terminal.prototype.keyDown = function(ev) { | |
c15fed38 DI |
1350 | if (this.customKeydownHandler && this.customKeydownHandler(ev) === false) { |
1351 | return false; | |
1352 | } | |
1353 | ||
db76868c | 1354 | if (!this.compositionHelper.keydown.bind(this.compositionHelper)(ev)) { |
3b2e89d8 DI |
1355 | if (this.ybase !== this.ydisp) { |
1356 | this.scrollToBottom(); | |
1357 | } | |
db76868c PK |
1358 | return false; |
1359 | } | |
3f455f90 | 1360 | |
db76868c PK |
1361 | var self = this; |
1362 | var result = this.evaluateKeyEscapeSequence(ev); | |
3f455f90 | 1363 | |
0ec12555 | 1364 | if (result.key === C0.DC3) { // XOFF |
e66b1c57 | 1365 | this.writeStopped = true; |
0ec12555 | 1366 | } else if (result.key === C0.DC1) { // XON |
e66b1c57 | 1367 | this.writeStopped = false; |
b9d374af DI |
1368 | } |
1369 | ||
db76868c PK |
1370 | if (result.scrollDisp) { |
1371 | this.scrollDisp(result.scrollDisp); | |
446c3958 | 1372 | return this.cancel(ev, true); |
db76868c | 1373 | } |
3f455f90 | 1374 | |
db76868c PK |
1375 | if (isThirdLevelShift(this, ev)) { |
1376 | return true; | |
1377 | } | |
3f455f90 | 1378 | |
446c3958 | 1379 | if (result.cancel) { |
db76868c PK |
1380 | // The event is canceled at the end already, is this necessary? |
1381 | this.cancel(ev, true); | |
1382 | } | |
3f455f90 | 1383 | |
db76868c PK |
1384 | if (!result.key) { |
1385 | return true; | |
1386 | } | |
3f455f90 | 1387 | |
db76868c PK |
1388 | this.emit('keydown', ev); |
1389 | this.emit('key', result.key, ev); | |
1390 | this.showCursor(); | |
1391 | this.handler(result.key); | |
3f455f90 | 1392 | |
db76868c PK |
1393 | return this.cancel(ev, true); |
1394 | }; | |
3f455f90 | 1395 | |
db76868c PK |
1396 | /** |
1397 | * Returns an object that determines how a KeyboardEvent should be handled. The key of the | |
1398 | * returned value is the new key code to pass to the PTY. | |
1399 | * | |
1400 | * Reference: http://invisible-island.net/xterm/ctlseqs/ctlseqs.html | |
1401 | * @param {KeyboardEvent} ev The keyboard event to be translated to key escape sequence. | |
1402 | */ | |
1403 | Terminal.prototype.evaluateKeyEscapeSequence = function(ev) { | |
1404 | var result = { | |
1405 | // Whether to cancel event propogation (NOTE: this may not be needed since the event is | |
1406 | // canceled at the end of keyDown | |
1407 | cancel: false, | |
1408 | // The new key even to emit | |
1409 | key: undefined, | |
1410 | // The number of characters to scroll, if this is defined it will cancel the event | |
1411 | scrollDisp: undefined | |
1412 | }; | |
1413 | var modifiers = ev.shiftKey << 0 | ev.altKey << 1 | ev.ctrlKey << 2 | ev.metaKey << 3; | |
1414 | switch (ev.keyCode) { | |
db76868c | 1415 | case 8: |
fca673d6 | 1416 | // backspace |
db76868c | 1417 | if (ev.shiftKey) { |
3de3c0c6 | 1418 | result.key = C0.BS; // ^H |
db76868c PK |
1419 | break; |
1420 | } | |
3de3c0c6 | 1421 | result.key = C0.DEL; // ^? |
db76868c | 1422 | break; |
db76868c | 1423 | case 9: |
fca673d6 | 1424 | // tab |
db76868c | 1425 | if (ev.shiftKey) { |
3de3c0c6 | 1426 | result.key = C0.ESC + '[Z'; |
db76868c PK |
1427 | break; |
1428 | } | |
3de3c0c6 | 1429 | result.key = C0.HT; |
db76868c PK |
1430 | result.cancel = true; |
1431 | break; | |
db76868c | 1432 | case 13: |
fca673d6 | 1433 | // return/enter |
3de3c0c6 | 1434 | result.key = C0.CR; |
db76868c PK |
1435 | result.cancel = true; |
1436 | break; | |
db76868c | 1437 | case 27: |
fca673d6 | 1438 | // escape |
3de3c0c6 | 1439 | result.key = C0.ESC; |
db76868c PK |
1440 | result.cancel = true; |
1441 | break; | |
db76868c | 1442 | case 37: |
fca673d6 | 1443 | // left-arrow |
db76868c | 1444 | if (modifiers) { |
3de3c0c6 | 1445 | result.key = C0.ESC + '[1;' + (modifiers + 1) + 'D'; |
db76868c PK |
1446 | // HACK: Make Alt + left-arrow behave like Ctrl + left-arrow: move one word backwards |
1447 | // http://unix.stackexchange.com/a/108106 | |
2824da37 | 1448 | // macOS uses different escape sequences than linux |
3de3c0c6 DI |
1449 | if (result.key == C0.ESC + '[1;3D') { |
1450 | result.key = (this.browser.isMac) ? C0.ESC + 'b' : C0.ESC + '[1;5D'; | |
3f455f90 | 1451 | } |
db76868c | 1452 | } else if (this.applicationCursor) { |
3de3c0c6 | 1453 | result.key = C0.ESC + 'OD'; |
db76868c | 1454 | } else { |
3de3c0c6 | 1455 | result.key = C0.ESC + '[D'; |
3f455f90 | 1456 | } |
db76868c | 1457 | break; |
db76868c | 1458 | case 39: |
fca673d6 | 1459 | // right-arrow |
db76868c | 1460 | if (modifiers) { |
3de3c0c6 | 1461 | result.key = C0.ESC + '[1;' + (modifiers + 1) + 'C'; |
db76868c PK |
1462 | // HACK: Make Alt + right-arrow behave like Ctrl + right-arrow: move one word forward |
1463 | // http://unix.stackexchange.com/a/108106 | |
2824da37 | 1464 | // macOS uses different escape sequences than linux |
3de3c0c6 DI |
1465 | if (result.key == C0.ESC + '[1;3C') { |
1466 | result.key = (this.browser.isMac) ? C0.ESC + 'f' : C0.ESC + '[1;5C'; | |
db76868c PK |
1467 | } |
1468 | } else if (this.applicationCursor) { | |
3de3c0c6 | 1469 | result.key = C0.ESC + 'OC'; |
db76868c | 1470 | } else { |
3de3c0c6 | 1471 | result.key = C0.ESC + '[C'; |
d4e9d34d | 1472 | } |
db76868c | 1473 | break; |
db76868c | 1474 | case 38: |
fca673d6 | 1475 | // up-arrow |
db76868c | 1476 | if (modifiers) { |
3de3c0c6 | 1477 | result.key = C0.ESC + '[1;' + (modifiers + 1) + 'A'; |
db76868c PK |
1478 | // HACK: Make Alt + up-arrow behave like Ctrl + up-arrow |
1479 | // http://unix.stackexchange.com/a/108106 | |
3de3c0c6 DI |
1480 | if (result.key == C0.ESC + '[1;3A') { |
1481 | result.key = C0.ESC + '[1;5A'; | |
db76868c PK |
1482 | } |
1483 | } else if (this.applicationCursor) { | |
3de3c0c6 | 1484 | result.key = C0.ESC + 'OA'; |
db76868c | 1485 | } else { |
3de3c0c6 | 1486 | result.key = C0.ESC + '[A'; |
8faea59e | 1487 | } |
db76868c | 1488 | break; |
db76868c | 1489 | case 40: |
fca673d6 | 1490 | // down-arrow |
db76868c | 1491 | if (modifiers) { |
3de3c0c6 | 1492 | result.key = C0.ESC + '[1;' + (modifiers + 1) + 'B'; |
db76868c PK |
1493 | // HACK: Make Alt + down-arrow behave like Ctrl + down-arrow |
1494 | // http://unix.stackexchange.com/a/108106 | |
3de3c0c6 DI |
1495 | if (result.key == C0.ESC + '[1;3B') { |
1496 | result.key = C0.ESC + '[1;5B'; | |
db76868c PK |
1497 | } |
1498 | } else if (this.applicationCursor) { | |
3de3c0c6 | 1499 | result.key = C0.ESC + 'OB'; |
db76868c | 1500 | } else { |
3de3c0c6 | 1501 | result.key = C0.ESC + '[B'; |
3a866cf2 | 1502 | } |
db76868c | 1503 | break; |
db76868c | 1504 | case 45: |
fca673d6 | 1505 | // insert |
db76868c PK |
1506 | if (!ev.shiftKey && !ev.ctrlKey) { |
1507 | // <Ctrl> or <Shift> + <Insert> are used to | |
1508 | // copy-paste on some systems. | |
3de3c0c6 | 1509 | result.key = C0.ESC + '[2~'; |
b01165c1 | 1510 | } |
db76868c | 1511 | break; |
db76868c | 1512 | case 46: |
fca673d6 | 1513 | // delete |
db76868c | 1514 | if (modifiers) { |
3de3c0c6 | 1515 | result.key = C0.ESC + '[3;' + (modifiers + 1) + '~'; |
db76868c | 1516 | } else { |
3de3c0c6 | 1517 | result.key = C0.ESC + '[3~'; |
3a866cf2 | 1518 | } |
db76868c | 1519 | break; |
db76868c | 1520 | case 36: |
fca673d6 | 1521 | // home |
db76868c | 1522 | if (modifiers) |
3de3c0c6 | 1523 | result.key = C0.ESC + '[1;' + (modifiers + 1) + 'H'; |
db76868c | 1524 | else if (this.applicationCursor) |
3de3c0c6 | 1525 | result.key = C0.ESC + 'OH'; |
db76868c | 1526 | else |
3de3c0c6 | 1527 | result.key = C0.ESC + '[H'; |
db76868c | 1528 | break; |
db76868c | 1529 | case 35: |
fca673d6 | 1530 | // end |
db76868c | 1531 | if (modifiers) |
3de3c0c6 | 1532 | result.key = C0.ESC + '[1;' + (modifiers + 1) + 'F'; |
db76868c | 1533 | else if (this.applicationCursor) |
3de3c0c6 | 1534 | result.key = C0.ESC + 'OF'; |
db76868c | 1535 | else |
3de3c0c6 | 1536 | result.key = C0.ESC + '[F'; |
db76868c | 1537 | break; |
db76868c | 1538 | case 33: |
fca673d6 | 1539 | // page up |
db76868c PK |
1540 | if (ev.shiftKey) { |
1541 | result.scrollDisp = -(this.rows - 1); | |
1542 | } else { | |
3de3c0c6 | 1543 | result.key = C0.ESC + '[5~'; |
3a866cf2 | 1544 | } |
db76868c | 1545 | break; |
db76868c | 1546 | case 34: |
fca673d6 | 1547 | // page down |
db76868c PK |
1548 | if (ev.shiftKey) { |
1549 | result.scrollDisp = this.rows - 1; | |
1550 | } else { | |
3de3c0c6 | 1551 | result.key = C0.ESC + '[6~'; |
3f455f90 | 1552 | } |
db76868c | 1553 | break; |
db76868c | 1554 | case 112: |
fca673d6 | 1555 | // F1-F12 |
db76868c | 1556 | if (modifiers) { |
3de3c0c6 | 1557 | result.key = C0.ESC + '[1;' + (modifiers + 1) + 'P'; |
db76868c | 1558 | } else { |
3de3c0c6 | 1559 | result.key = C0.ESC + 'OP'; |
3f455f90 | 1560 | } |
db76868c PK |
1561 | break; |
1562 | case 113: | |
1563 | if (modifiers) { | |
3de3c0c6 | 1564 | result.key = C0.ESC + '[1;' + (modifiers + 1) + 'Q'; |
3f455f90 | 1565 | } else { |
3de3c0c6 | 1566 | result.key = C0.ESC + 'OQ'; |
3f455f90 | 1567 | } |
db76868c PK |
1568 | break; |
1569 | case 114: | |
1570 | if (modifiers) { | |
3de3c0c6 | 1571 | result.key = C0.ESC + '[1;' + (modifiers + 1) + 'R'; |
db76868c | 1572 | } else { |
3de3c0c6 | 1573 | result.key = C0.ESC + 'OR'; |
3f455f90 | 1574 | } |
db76868c PK |
1575 | break; |
1576 | case 115: | |
1577 | if (modifiers) { | |
3de3c0c6 | 1578 | result.key = C0.ESC + '[1;' + (modifiers + 1) + 'S'; |
db76868c | 1579 | } else { |
3de3c0c6 | 1580 | result.key = C0.ESC + 'OS'; |
3f455f90 | 1581 | } |
db76868c PK |
1582 | break; |
1583 | case 116: | |
1584 | if (modifiers) { | |
3de3c0c6 | 1585 | result.key = C0.ESC + '[15;' + (modifiers + 1) + '~'; |
db76868c | 1586 | } else { |
3de3c0c6 | 1587 | result.key = C0.ESC + '[15~'; |
e721bdc9 | 1588 | } |
db76868c PK |
1589 | break; |
1590 | case 117: | |
1591 | if (modifiers) { | |
3de3c0c6 | 1592 | result.key = C0.ESC + '[17;' + (modifiers + 1) + '~'; |
db76868c | 1593 | } else { |
3de3c0c6 | 1594 | result.key = C0.ESC + '[17~'; |
3f455f90 | 1595 | } |
db76868c PK |
1596 | break; |
1597 | case 118: | |
1598 | if (modifiers) { | |
3de3c0c6 | 1599 | result.key = C0.ESC + '[18;' + (modifiers + 1) + '~'; |
db76868c | 1600 | } else { |
3de3c0c6 | 1601 | result.key = C0.ESC + '[18~'; |
3f455f90 | 1602 | } |
db76868c PK |
1603 | break; |
1604 | case 119: | |
1605 | if (modifiers) { | |
3de3c0c6 | 1606 | result.key = C0.ESC + '[19;' + (modifiers + 1) + '~'; |
db76868c | 1607 | } else { |
3de3c0c6 | 1608 | result.key = C0.ESC + '[19~'; |
3f455f90 | 1609 | } |
db76868c PK |
1610 | break; |
1611 | case 120: | |
1612 | if (modifiers) { | |
3de3c0c6 | 1613 | result.key = C0.ESC + '[20;' + (modifiers + 1) + '~'; |
db76868c | 1614 | } else { |
3de3c0c6 | 1615 | result.key = C0.ESC + '[20~'; |
eee99f62 | 1616 | } |
db76868c PK |
1617 | break; |
1618 | case 121: | |
1619 | if (modifiers) { | |
3de3c0c6 | 1620 | result.key = C0.ESC + '[21;' + (modifiers + 1) + '~'; |
db76868c | 1621 | } else { |
3de3c0c6 | 1622 | result.key = C0.ESC + '[21~'; |
3f455f90 | 1623 | } |
db76868c PK |
1624 | break; |
1625 | case 122: | |
1626 | if (modifiers) { | |
3de3c0c6 | 1627 | result.key = C0.ESC + '[23;' + (modifiers + 1) + '~'; |
3f455f90 | 1628 | } else { |
3de3c0c6 | 1629 | result.key = C0.ESC + '[23~'; |
3f455f90 | 1630 | } |
db76868c PK |
1631 | break; |
1632 | case 123: | |
1633 | if (modifiers) { | |
3de3c0c6 | 1634 | result.key = C0.ESC + '[24;' + (modifiers + 1) + '~'; |
db76868c | 1635 | } else { |
3de3c0c6 | 1636 | result.key = C0.ESC + '[24~'; |
3f455f90 | 1637 | } |
db76868c PK |
1638 | break; |
1639 | default: | |
1640 | // a-z and space | |
1641 | if (ev.ctrlKey && !ev.shiftKey && !ev.altKey && !ev.metaKey) { | |
1642 | if (ev.keyCode >= 65 && ev.keyCode <= 90) { | |
1643 | result.key = String.fromCharCode(ev.keyCode - 64); | |
1644 | } else if (ev.keyCode === 32) { | |
1645 | // NUL | |
1646 | result.key = String.fromCharCode(0); | |
1647 | } else if (ev.keyCode >= 51 && ev.keyCode <= 55) { | |
1648 | // escape, file sep, group sep, record sep, unit sep | |
1649 | result.key = String.fromCharCode(ev.keyCode - 51 + 27); | |
1650 | } else if (ev.keyCode === 56) { | |
1651 | // delete | |
1652 | result.key = String.fromCharCode(127); | |
1653 | } else if (ev.keyCode === 219) { | |
15a94240 | 1654 | // ^[ - Control Sequence Introducer (CSI) |
db76868c | 1655 | result.key = String.fromCharCode(27); |
15a94240 DI |
1656 | } else if (ev.keyCode === 220) { |
1657 | // ^\ - String Terminator (ST) | |
1658 | result.key = String.fromCharCode(28); | |
db76868c | 1659 | } else if (ev.keyCode === 221) { |
15a94240 | 1660 | // ^] - Operating System Command (OSC) |
db76868c PK |
1661 | result.key = String.fromCharCode(29); |
1662 | } | |
bc70b3b3 | 1663 | } else if (!this.browser.isMac && ev.altKey && !ev.ctrlKey && !ev.metaKey) { |
db76868c PK |
1664 | // On Mac this is a third level shift. Use <Esc> instead. |
1665 | if (ev.keyCode >= 65 && ev.keyCode <= 90) { | |
3de3c0c6 | 1666 | result.key = C0.ESC + String.fromCharCode(ev.keyCode + 32); |
db76868c | 1667 | } else if (ev.keyCode === 192) { |
3de3c0c6 | 1668 | result.key = C0.ESC + '`'; |
db76868c | 1669 | } else if (ev.keyCode >= 48 && ev.keyCode <= 57) { |
3de3c0c6 | 1670 | result.key = C0.ESC + (ev.keyCode - 48); |
db76868c | 1671 | } |
3f455f90 | 1672 | } |
db76868c PK |
1673 | break; |
1674 | } | |
b9d374af | 1675 | |
db76868c PK |
1676 | return result; |
1677 | }; | |
3f455f90 | 1678 | |
db76868c PK |
1679 | /** |
1680 | * Set the G level of the terminal | |
1681 | * @param g | |
1682 | */ | |
1683 | Terminal.prototype.setgLevel = function(g) { | |
1684 | this.glevel = g; | |
1685 | this.charset = this.charsets[g]; | |
1686 | }; | |
12a150a4 | 1687 | |
db76868c PK |
1688 | /** |
1689 | * Set the charset for the given G level of the terminal | |
1690 | * @param g | |
1691 | * @param charset | |
1692 | */ | |
1693 | Terminal.prototype.setgCharset = function(g, charset) { | |
1694 | this.charsets[g] = charset; | |
1695 | if (this.glevel === g) { | |
1696 | this.charset = charset; | |
1697 | } | |
1698 | }; | |
12a150a4 | 1699 | |
db76868c PK |
1700 | /** |
1701 | * Handle a keypress event. | |
1702 | * Key Resources: | |
1703 | * - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent | |
1704 | * @param {KeyboardEvent} ev The keypress event to be handled. | |
1705 | */ | |
1706 | Terminal.prototype.keyPress = function(ev) { | |
1707 | var key; | |
3f455f90 | 1708 | |
db76868c | 1709 | this.cancel(ev); |
3f455f90 | 1710 | |
db76868c PK |
1711 | if (ev.charCode) { |
1712 | key = ev.charCode; | |
1713 | } else if (ev.which == null) { | |
1714 | key = ev.keyCode; | |
1715 | } else if (ev.which !== 0 && ev.charCode !== 0) { | |
1716 | key = ev.which; | |
1717 | } else { | |
1718 | return false; | |
1719 | } | |
3f455f90 | 1720 | |
db76868c PK |
1721 | if (!key || ( |
1722 | (ev.altKey || ev.ctrlKey || ev.metaKey) && !isThirdLevelShift(this, ev) | |
1723 | )) { | |
1724 | return false; | |
1725 | } | |
12a150a4 | 1726 | |
db76868c | 1727 | key = String.fromCharCode(key); |
3f455f90 | 1728 | |
db76868c PK |
1729 | this.emit('keypress', key, ev); |
1730 | this.emit('key', key, ev); | |
1731 | this.showCursor(); | |
1732 | this.handler(key); | |
12a150a4 | 1733 | |
db76868c PK |
1734 | return false; |
1735 | }; | |
3f455f90 | 1736 | |
db76868c PK |
1737 | /** |
1738 | * Send data for handling to the terminal | |
1739 | * @param {string} data | |
1740 | */ | |
1741 | Terminal.prototype.send = function(data) { | |
1742 | var self = this; | |
3f455f90 | 1743 | |
db76868c PK |
1744 | if (!this.queue) { |
1745 | setTimeout(function() { | |
1746 | self.handler(self.queue); | |
1747 | self.queue = ''; | |
1748 | }, 1); | |
1749 | } | |
3f455f90 | 1750 | |
db76868c PK |
1751 | this.queue += data; |
1752 | }; | |
3f455f90 | 1753 | |
db76868c PK |
1754 | /** |
1755 | * Ring the bell. | |
1756 | * Note: We could do sweet things with webaudio here | |
1757 | */ | |
1758 | Terminal.prototype.bell = function() { | |
1759 | if (!this.visualBell) return; | |
1760 | var self = this; | |
1761 | this.element.style.borderColor = 'white'; | |
1762 | setTimeout(function() { | |
1763 | self.element.style.borderColor = ''; | |
1764 | }, 10); | |
1765 | if (this.popOnBell) this.focus(); | |
1766 | }; | |
c3cf6a22 | 1767 | |
db76868c PK |
1768 | /** |
1769 | * Log the current state to the console. | |
1770 | */ | |
1771 | Terminal.prototype.log = function() { | |
1772 | if (!this.debug) return; | |
1773 | if (!this.context.console || !this.context.console.log) return; | |
1774 | var args = Array.prototype.slice.call(arguments); | |
1775 | this.context.console.log.apply(this.context.console, args); | |
1776 | }; | |
3f455f90 | 1777 | |
db76868c PK |
1778 | /** |
1779 | * Log the current state as error to the console. | |
1780 | */ | |
1781 | Terminal.prototype.error = function() { | |
1782 | if (!this.debug) return; | |
1783 | if (!this.context.console || !this.context.console.error) return; | |
1784 | var args = Array.prototype.slice.call(arguments); | |
1785 | this.context.console.error.apply(this.context.console, args); | |
1786 | }; | |
c3cf6a22 | 1787 | |
db76868c PK |
1788 | /** |
1789 | * Resizes the terminal. | |
1790 | * | |
1791 | * @param {number} x The number of columns to resize to. | |
1792 | * @param {number} y The number of rows to resize to. | |
1793 | */ | |
1794 | Terminal.prototype.resize = function(x, y) { | |
c3256556 | 1795 | if (isNaN(x) || isNaN(y)) { |
ee0d6b45 LB |
1796 | return; |
1797 | } | |
1798 | ||
db76868c PK |
1799 | var line |
1800 | , el | |
1801 | , i | |
1802 | , j | |
1803 | , ch | |
1804 | , addToY; | |
1805 | ||
1806 | if (x === this.cols && y === this.rows) { | |
1807 | return; | |
1808 | } | |
1809 | ||
1810 | if (x < 1) x = 1; | |
1811 | if (y < 1) y = 1; | |
1812 | ||
1813 | // resize cols | |
1814 | j = this.cols; | |
1815 | if (j < x) { | |
1816 | ch = [this.defAttr, ' ', 1]; // does xterm use the default attr? | |
1817 | i = this.lines.length; | |
1818 | while (i--) { | |
607c8191 DI |
1819 | while (this.lines.get(i).length < x) { |
1820 | this.lines.get(i).push(ch); | |
db76868c PK |
1821 | } |
1822 | } | |
1823 | } else { // (j > x) | |
1824 | i = this.lines.length; | |
1825 | while (i--) { | |
607c8191 DI |
1826 | while (this.lines.get(i).length > x) { |
1827 | this.lines.get(i).pop(); | |
db76868c PK |
1828 | } |
1829 | } | |
1830 | } | |
db76868c | 1831 | this.cols = x; |
9a86e4e1 | 1832 | this.setupStops(this.cols); |
db76868c PK |
1833 | |
1834 | // resize rows | |
1835 | j = this.rows; | |
1836 | addToY = 0; | |
1837 | if (j < y) { | |
1838 | el = this.element; | |
1839 | while (j++ < y) { | |
1840 | // y is rows, not this.y | |
1841 | if (this.lines.length < y + this.ybase) { | |
1842 | if (this.ybase > 0 && this.lines.length <= this.ybase + this.y + addToY + 1) { | |
1843 | // There is room above the buffer and there are no empty elements below the line, | |
1844 | // scroll up | |
1845 | this.ybase--; | |
1846 | addToY++ | |
1847 | if (this.ydisp > 0) { | |
1848 | // Viewport is at the top of the buffer, must increase downwards | |
1849 | this.ydisp--; | |
1850 | } | |
1851 | } else { | |
1852 | // Add a blank line if there is no buffer left at the top to scroll to, or if there | |
1853 | // are blank lines after the cursor | |
1854 | this.lines.push(this.blankLine()); | |
1855 | } | |
1856 | } | |
1857 | if (this.children.length < y) { | |
1858 | this.insertRow(); | |
1859 | } | |
1860 | } | |
1861 | } else { // (j > y) | |
1862 | while (j-- > y) { | |
1863 | if (this.lines.length > y + this.ybase) { | |
1864 | if (this.lines.length > this.ybase + this.y + 1) { | |
1865 | // The line is a blank line below the cursor, remove it | |
1866 | this.lines.pop(); | |
1867 | } else { | |
1868 | // The line is the cursor, scroll down | |
1869 | this.ybase++; | |
1870 | this.ydisp++; | |
1871 | } | |
1872 | } | |
1873 | if (this.children.length > y) { | |
1874 | el = this.children.shift(); | |
1875 | if (!el) continue; | |
1876 | el.parentNode.removeChild(el); | |
1877 | } | |
1878 | } | |
1879 | } | |
1880 | this.rows = y; | |
3f455f90 | 1881 | |
db76868c PK |
1882 | // Make sure that the cursor stays on screen |
1883 | if (this.y >= y) { | |
1884 | this.y = y - 1; | |
1885 | } | |
1886 | if (addToY) { | |
1887 | this.y += addToY; | |
1888 | } | |
12a150a4 | 1889 | |
db76868c PK |
1890 | if (this.x >= x) { |
1891 | this.x = x - 1; | |
1892 | } | |
3f455f90 | 1893 | |
db76868c PK |
1894 | this.scrollTop = 0; |
1895 | this.scrollBottom = y - 1; | |
12a150a4 | 1896 | |
4f18d842 DI |
1897 | this.charMeasure.measure(); |
1898 | ||
3c635f3c | 1899 | this.refresh(0, this.rows - 1); |
3f455f90 | 1900 | |
db76868c | 1901 | this.normal = null; |
12a150a4 | 1902 | |
a9417c68 | 1903 | this.geometry = [this.cols, this.rows]; |
db76868c PK |
1904 | this.emit('resize', {terminal: this, cols: x, rows: y}); |
1905 | }; | |
3f455f90 | 1906 | |
db76868c PK |
1907 | /** |
1908 | * Updates the range of rows to refresh | |
1909 | * @param {number} y The number of rows to refresh next. | |
1910 | */ | |
1911 | Terminal.prototype.updateRange = function(y) { | |
1912 | if (y < this.refreshStart) this.refreshStart = y; | |
1913 | if (y > this.refreshEnd) this.refreshEnd = y; | |
1914 | // if (y > this.refreshEnd) { | |
1915 | // this.refreshEnd = y; | |
1916 | // if (y > this.rows - 1) { | |
1917 | // this.refreshEnd = this.rows - 1; | |
1918 | // } | |
1919 | // } | |
1920 | }; | |
3f455f90 | 1921 | |
db76868c | 1922 | /** |
0de3d839 | 1923 | * Set the range of refreshing to the maximum value |
db76868c PK |
1924 | */ |
1925 | Terminal.prototype.maxRange = function() { | |
1926 | this.refreshStart = 0; | |
1927 | this.refreshEnd = this.rows - 1; | |
1928 | }; | |
12a150a4 | 1929 | |
3f455f90 | 1930 | |
12a150a4 | 1931 | |
db76868c PK |
1932 | /** |
1933 | * Setup the tab stops. | |
1934 | * @param {number} i | |
1935 | */ | |
1936 | Terminal.prototype.setupStops = function(i) { | |
1937 | if (i != null) { | |
1938 | if (!this.tabs[i]) { | |
1939 | i = this.prevStop(i); | |
1940 | } | |
1941 | } else { | |
1942 | this.tabs = {}; | |
1943 | i = 0; | |
1944 | } | |
3f455f90 | 1945 | |
f4293a6d | 1946 | for (; i < this.cols; i += this.getOption('tabStopWidth')) { |
db76868c PK |
1947 | this.tabs[i] = true; |
1948 | } | |
1949 | }; | |
12a150a4 | 1950 | |
3f455f90 | 1951 | |
db76868c PK |
1952 | /** |
1953 | * Move the cursor to the previous tab stop from the given position (default is current). | |
1954 | * @param {number} x The position to move the cursor to the previous tab stop. | |
1955 | */ | |
1956 | Terminal.prototype.prevStop = function(x) { | |
1957 | if (x == null) x = this.x; | |
1958 | while (!this.tabs[--x] && x > 0); | |
1959 | return x >= this.cols | |
1960 | ? this.cols - 1 | |
1961 | : x < 0 ? 0 : x; | |
1962 | }; | |
12a150a4 | 1963 | |
3f455f90 | 1964 | |
db76868c PK |
1965 | /** |
1966 | * Move the cursor one tab stop forward from the given position (default is current). | |
1967 | * @param {number} x The position to move the cursor one tab stop forward. | |
1968 | */ | |
1969 | Terminal.prototype.nextStop = function(x) { | |
1970 | if (x == null) x = this.x; | |
1971 | while (!this.tabs[++x] && x < this.cols); | |
1972 | return x >= this.cols | |
1973 | ? this.cols - 1 | |
1974 | : x < 0 ? 0 : x; | |
1975 | }; | |
3f455f90 | 1976 | |
12a150a4 | 1977 | |
db76868c PK |
1978 | /** |
1979 | * Erase in the identified line everything from "x" to the end of the line (right). | |
1980 | * @param {number} x The column from which to start erasing to the end of the line. | |
1981 | * @param {number} y The line in which to operate. | |
1982 | */ | |
1983 | Terminal.prototype.eraseRight = function(x, y) { | |
6cd5c2b8 DI |
1984 | var line = this.lines.get(this.ybase + y); |
1985 | if (!line) { | |
1986 | return; | |
1987 | } | |
1988 | var ch = [this.eraseAttr(), ' ', 1]; // xterm | |
db76868c PK |
1989 | for (; x < this.cols; x++) { |
1990 | line[x] = ch; | |
1991 | } | |
db76868c PK |
1992 | this.updateRange(y); |
1993 | }; | |
12a150a4 | 1994 | |
3f455f90 | 1995 | |
12a150a4 | 1996 | |
db76868c PK |
1997 | /** |
1998 | * Erase in the identified line everything from "x" to the start of the line (left). | |
1999 | * @param {number} x The column from which to start erasing to the start of the line. | |
2000 | * @param {number} y The line in which to operate. | |
2001 | */ | |
2002 | Terminal.prototype.eraseLeft = function(x, y) { | |
6cd5c2b8 DI |
2003 | var line = this.lines.get(this.ybase + y); |
2004 | if (!line) { | |
2005 | return; | |
2006 | } | |
2007 | var ch = [this.eraseAttr(), ' ', 1]; // xterm | |
db76868c | 2008 | x++; |
6cd5c2b8 DI |
2009 | while (x--) { |
2010 | line[x] = ch; | |
2011 | } | |
db76868c PK |
2012 | this.updateRange(y); |
2013 | }; | |
3f455f90 | 2014 | |
76719413 DI |
2015 | /** |
2016 | * Clears the entire buffer, making the prompt line the new first line. | |
2017 | */ | |
2018 | Terminal.prototype.clear = function() { | |
852dac4d DI |
2019 | if (this.ybase === 0 && this.y === 0) { |
2020 | // Don't clear if it's already clear | |
2021 | return; | |
2022 | } | |
607c8191 DI |
2023 | this.lines.set(0, this.lines.get(this.ybase + this.y)); |
2024 | this.lines.length = 1; | |
76719413 DI |
2025 | this.ydisp = 0; |
2026 | this.ybase = 0; | |
2027 | this.y = 0; | |
76719413 DI |
2028 | for (var i = 1; i < this.rows; i++) { |
2029 | this.lines.push(this.blankLine()); | |
2030 | } | |
3c635f3c | 2031 | this.refresh(0, this.rows - 1); |
76719413 DI |
2032 | this.emit('scroll', this.ydisp); |
2033 | }; | |
3f455f90 | 2034 | |
db76868c PK |
2035 | /** |
2036 | * Erase all content in the given line | |
2037 | * @param {number} y The line to erase all of its contents. | |
2038 | */ | |
2039 | Terminal.prototype.eraseLine = function(y) { | |
2040 | this.eraseRight(0, y); | |
2041 | }; | |
3f455f90 | 2042 | |
3f455f90 | 2043 | |
db76868c | 2044 | /** |
cc5ae819 | 2045 | * Return the data array of a blank line |
db76868c PK |
2046 | * @param {number} cur First bunch of data for each "blank" character. |
2047 | */ | |
2048 | Terminal.prototype.blankLine = function(cur) { | |
2049 | var attr = cur | |
2050 | ? this.eraseAttr() | |
2051 | : this.defAttr; | |
12a150a4 | 2052 | |
db76868c PK |
2053 | var ch = [attr, ' ', 1] // width defaults to 1 halfwidth character |
2054 | , line = [] | |
2055 | , i = 0; | |
3f455f90 | 2056 | |
db76868c PK |
2057 | for (; i < this.cols; i++) { |
2058 | line[i] = ch; | |
2059 | } | |
12a150a4 | 2060 | |
db76868c PK |
2061 | return line; |
2062 | }; | |
3f455f90 | 2063 | |
12a150a4 | 2064 | |
db76868c PK |
2065 | /** |
2066 | * If cur return the back color xterm feature attribute. Else return defAttr. | |
2067 | * @param {object} cur | |
2068 | */ | |
2069 | Terminal.prototype.ch = function(cur) { | |
2070 | return cur | |
2071 | ? [this.eraseAttr(), ' ', 1] | |
2072 | : [this.defAttr, ' ', 1]; | |
2073 | }; | |
3f455f90 | 2074 | |
3f455f90 | 2075 | |
db76868c PK |
2076 | /** |
2077 | * Evaluate if the current erminal is the given argument. | |
2078 | * @param {object} term The terminal to evaluate | |
2079 | */ | |
2080 | Terminal.prototype.is = function(term) { | |
2081 | var name = this.termName; | |
2082 | return (name + '').indexOf(term) === 0; | |
2083 | }; | |
3f455f90 | 2084 | |
12a150a4 | 2085 | |
db76868c | 2086 | /** |
32e878db DI |
2087 | * Emit the 'data' event and populate the given data. |
2088 | * @param {string} data The data to populate in the event. | |
2089 | */ | |
db76868c | 2090 | Terminal.prototype.handler = function(data) { |
d9d60063 DI |
2091 | // Prevents all events to pty process if stdin is disabled |
2092 | if (this.options.disableStdin) { | |
2093 | return; | |
2094 | } | |
2095 | ||
2bc8adee DI |
2096 | // Input is being sent to the terminal, the terminal should focus the prompt. |
2097 | if (this.ybase !== this.ydisp) { | |
2098 | this.scrollToBottom(); | |
2099 | } | |
db76868c PK |
2100 | this.emit('data', data); |
2101 | }; | |
3f455f90 | 2102 | |
12a150a4 | 2103 | |
db76868c PK |
2104 | /** |
2105 | * Emit the 'title' event and populate the given title. | |
2106 | * @param {string} title The title to populate in the event. | |
2107 | */ | |
2108 | Terminal.prototype.handleTitle = function(title) { | |
1fc5a9aa Y |
2109 | /** |
2110 | * This event is emitted when the title of the terminal is changed | |
2111 | * from inside the terminal. The parameter is the new title. | |
2112 | * | |
2113 | * @event title | |
2114 | */ | |
db76868c PK |
2115 | this.emit('title', title); |
2116 | }; | |
3f455f90 | 2117 | |
3f455f90 | 2118 | |
db76868c PK |
2119 | /** |
2120 | * ESC | |
2121 | */ | |
3f455f90 | 2122 | |
db76868c PK |
2123 | /** |
2124 | * ESC D Index (IND is 0x84). | |
2125 | */ | |
2126 | Terminal.prototype.index = function() { | |
2127 | this.y++; | |
2128 | if (this.y > this.scrollBottom) { | |
2129 | this.y--; | |
2130 | this.scroll(); | |
2131 | } | |
5850cbcd | 2132 | // If the end of the line is hit, prevent this action from wrapping around to the next line. |
72063329 DI |
2133 | if (this.x >= this.cols) { |
2134 | this.x--; | |
2135 | } | |
db76868c | 2136 | }; |
3f455f90 | 2137 | |
3f455f90 | 2138 | |
db76868c PK |
2139 | /** |
2140 | * ESC M Reverse Index (RI is 0x8d). | |
3b35d12e DI |
2141 | * |
2142 | * Move the cursor up one row, inserting a new blank line if necessary. | |
db76868c PK |
2143 | */ |
2144 | Terminal.prototype.reverseIndex = function() { | |
2145 | var j; | |
3b35d12e | 2146 | if (this.y === this.scrollTop) { |
db76868c PK |
2147 | // possibly move the code below to term.reverseScroll(); |
2148 | // test: echo -ne '\e[1;1H\e[44m\eM\e[0m' | |
2149 | // blankLine(true) is xterm/linux behavior | |
bf16fdc0 DI |
2150 | this.lines.shiftElements(this.y + this.ybase, this.rows - 1, 1); |
2151 | this.lines.set(this.y + this.ybase, this.blankLine(true)); | |
db76868c PK |
2152 | this.updateRange(this.scrollTop); |
2153 | this.updateRange(this.scrollBottom); | |
3b35d12e DI |
2154 | } else { |
2155 | this.y--; | |
db76868c | 2156 | } |
db76868c | 2157 | }; |
3f455f90 | 2158 | |
12a150a4 | 2159 | |
db76868c PK |
2160 | /** |
2161 | * ESC c Full Reset (RIS). | |
2162 | */ | |
2163 | Terminal.prototype.reset = function() { | |
2164 | this.options.rows = this.rows; | |
2165 | this.options.cols = this.cols; | |
2166 | var customKeydownHandler = this.customKeydownHandler; | |
2167 | Terminal.call(this, this.options); | |
2168 | this.customKeydownHandler = customKeydownHandler; | |
3c635f3c | 2169 | this.refresh(0, this.rows - 1); |
c8b19493 | 2170 | this.viewport.syncScrollArea(); |
db76868c | 2171 | }; |
3f455f90 | 2172 | |
12a150a4 | 2173 | |
db76868c PK |
2174 | /** |
2175 | * ESC H Tab Set (HTS is 0x88). | |
2176 | */ | |
2177 | Terminal.prototype.tabSet = function() { | |
2178 | this.tabs[this.x] = true; | |
db76868c | 2179 | }; |
3f455f90 | 2180 | |
db76868c PK |
2181 | /** |
2182 | * Helpers | |
2183 | */ | |
2184 | ||
db76868c PK |
2185 | function on(el, type, handler, capture) { |
2186 | if (!Array.isArray(el)) { | |
2187 | el = [el]; | |
2188 | } | |
2189 | el.forEach(function (element) { | |
2190 | element.addEventListener(type, handler, capture || false); | |
2191 | }); | |
2192 | } | |
2193 | ||
2194 | function off(el, type, handler, capture) { | |
2195 | el.removeEventListener(type, handler, capture || false); | |
2196 | } | |
2197 | ||
2198 | function cancel(ev, force) { | |
2199 | if (!this.cancelEvents && !force) { | |
2200 | return; | |
2201 | } | |
2202 | ev.preventDefault(); | |
2203 | ev.stopPropagation(); | |
2204 | return false; | |
2205 | } | |
2206 | ||
2207 | function inherits(child, parent) { | |
2208 | function f() { | |
2209 | this.constructor = child; | |
2210 | } | |
2211 | f.prototype = parent.prototype; | |
2212 | child.prototype = new f; | |
2213 | } | |
2214 | ||
db76868c PK |
2215 | function indexOf(obj, el) { |
2216 | var i = obj.length; | |
2217 | while (i--) { | |
2218 | if (obj[i] === el) return i; | |
2219 | } | |
2220 | return -1; | |
2221 | } | |
2222 | ||
2223 | function isThirdLevelShift(term, ev) { | |
2224 | var thirdLevelKey = | |
bc70b3b3 PK |
2225 | (term.browser.isMac && ev.altKey && !ev.ctrlKey && !ev.metaKey) || |
2226 | (term.browser.isMSWindows && ev.altKey && ev.ctrlKey && !ev.metaKey); | |
db76868c PK |
2227 | |
2228 | if (ev.type == 'keypress') { | |
2229 | return thirdLevelKey; | |
2230 | } | |
2231 | ||
2232 | // Don't invoke for arrows, pageDown, home, backspace, etc. (on non-keypress events) | |
2233 | return thirdLevelKey && (!ev.keyCode || ev.keyCode > 47); | |
2234 | } | |
2235 | ||
db81c28b DI |
2236 | // Expose to InputHandler (temporary) |
2237 | Terminal.prototype.matchColor = matchColor; | |
2238 | ||
db76868c PK |
2239 | function matchColor(r1, g1, b1) { |
2240 | var hash = (r1 << 16) | (g1 << 8) | b1; | |
2241 | ||
2242 | if (matchColor._cache[hash] != null) { | |
2243 | return matchColor._cache[hash]; | |
2244 | } | |
2245 | ||
2246 | var ldiff = Infinity | |
2247 | , li = -1 | |
2248 | , i = 0 | |
2249 | , c | |
2250 | , r2 | |
2251 | , g2 | |
2252 | , b2 | |
2253 | , diff; | |
2254 | ||
2255 | for (; i < Terminal.vcolors.length; i++) { | |
2256 | c = Terminal.vcolors[i]; | |
2257 | r2 = c[0]; | |
2258 | g2 = c[1]; | |
2259 | b2 = c[2]; | |
2260 | ||
2261 | diff = matchColor.distance(r1, g1, b1, r2, g2, b2); | |
2262 | ||
2263 | if (diff === 0) { | |
2264 | li = i; | |
2265 | break; | |
2266 | } | |
2267 | ||
2268 | if (diff < ldiff) { | |
2269 | ldiff = diff; | |
2270 | li = i; | |
2271 | } | |
2272 | } | |
2273 | ||
2274 | return matchColor._cache[hash] = li; | |
2275 | } | |
2276 | ||
2277 | matchColor._cache = {}; | |
2278 | ||
2279 | // http://stackoverflow.com/questions/1633828 | |
2280 | matchColor.distance = function(r1, g1, b1, r2, g2, b2) { | |
2281 | return Math.pow(30 * (r1 - r2), 2) | |
2282 | + Math.pow(59 * (g1 - g2), 2) | |
2283 | + Math.pow(11 * (b1 - b2), 2); | |
2284 | }; | |
2285 | ||
2286 | function each(obj, iter, con) { | |
2287 | if (obj.forEach) return obj.forEach(iter, con); | |
2288 | for (var i = 0; i < obj.length; i++) { | |
2289 | iter.call(con, obj[i], i, obj); | |
2290 | } | |
2291 | } | |
2292 | ||
5e1ccb35 DI |
2293 | function wasMondifierKeyOnlyEvent(ev) { |
2294 | return ev.keyCode === 16 || // Shift | |
2295 | ev.keyCode === 17 || // Ctrl | |
2296 | ev.keyCode === 18; // Alt | |
2297 | } | |
db76868c | 2298 | |
db76868c PK |
2299 | function keys(obj) { |
2300 | if (Object.keys) return Object.keys(obj); | |
2301 | var key, keys = []; | |
2302 | for (key in obj) { | |
2303 | if (Object.prototype.hasOwnProperty.call(obj, key)) { | |
2304 | keys.push(key); | |
2305 | } | |
2306 | } | |
2307 | return keys; | |
2308 | } | |
2309 | ||
db76868c PK |
2310 | /** |
2311 | * Expose | |
2312 | */ | |
2313 | ||
2314 | Terminal.EventEmitter = EventEmitter; | |
db76868c PK |
2315 | Terminal.inherits = inherits; |
2316 | ||
2317 | /** | |
2318 | * Adds an event listener to the terminal. | |
2319 | * | |
2320 | * @param {string} event The name of the event. TODO: Document all event types | |
2321 | * @param {function} callback The function to call when the event is triggered. | |
2322 | */ | |
2323 | Terminal.on = on; | |
2324 | Terminal.off = off; | |
2325 | Terminal.cancel = cancel; | |
8bc844c0 | 2326 | |
ed1a31d1 | 2327 | module.exports = Terminal; |