blob: b802580a1858be8e4a59e591f88a40250040218b [file] [log] [blame]
rginda87b86462011-12-14 13:48:03 -08001// Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
rginda8ba33642011-12-14 12:31:31 -08002// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
rgindacbbd7482012-06-13 15:06:16 -07005'use strict';
6
Masaya Suzuki273aa982014-05-31 07:25:55 +09007lib.rtdep('lib.colors', 'lib.PreferenceManager', 'lib.resource', 'lib.wc',
Rob Spiesf4e90e82015-01-28 12:10:13 -08008 'lib.f', 'hterm.Keyboard', 'hterm.Options', 'hterm.PreferenceManager',
Ricky Liang48f05cb2013-12-31 23:35:29 +08009 'hterm.Screen', 'hterm.ScrollPort', 'hterm.Size',
10 'hterm.TextAttributes', 'hterm.VT');
rgindacbbd7482012-06-13 15:06:16 -070011
rginda8ba33642011-12-14 12:31:31 -080012/**
13 * Constructor for the Terminal class.
14 *
15 * A Terminal pulls together the hterm.ScrollPort, hterm.Screen and hterm.VT100
16 * classes to provide the complete terminal functionality.
17 *
18 * There are a number of lower-level Terminal methods that can be called
19 * directly to manipulate the cursor, text, scroll region, and other terminal
20 * attributes. However, the primary method is interpret(), which parses VT
21 * escape sequences and invokes the appropriate Terminal methods.
22 *
23 * This class was heavily influenced by Cory Maccarrone's Framebuffer class.
24 *
25 * TODO(rginda): Eventually we're going to need to support characters which are
26 * displayed twice as wide as standard latin characters. This is to support
27 * CJK (and possibly other character sets).
rginda9f5222b2012-03-05 11:53:28 -080028 *
Robert Ginda57f03b42012-09-13 11:02:48 -070029 * @param {string} opt_profileId Optional preference profile name. If not
rginda9f5222b2012-03-05 11:53:28 -080030 * provided, defaults to 'default'.
rginda8ba33642011-12-14 12:31:31 -080031 */
Robert Ginda57f03b42012-09-13 11:02:48 -070032hterm.Terminal = function(opt_profileId) {
33 this.profileId_ = null;
rginda9f5222b2012-03-05 11:53:28 -080034
rginda8ba33642011-12-14 12:31:31 -080035 // Two screen instances.
36 this.primaryScreen_ = new hterm.Screen();
37 this.alternateScreen_ = new hterm.Screen();
38
39 // The "current" screen.
40 this.screen_ = this.primaryScreen_;
41
rginda8ba33642011-12-14 12:31:31 -080042 // The local notion of the screen size. ScreenBuffers also have a size which
43 // indicates their present size. During size changes, the two may disagree.
44 // Also, the inactive screen's size is not altered until it is made the active
45 // screen.
46 this.screenSize = new hterm.Size(0, 0);
47
rginda8ba33642011-12-14 12:31:31 -080048 // The scroll port we'll be using to display the visible rows.
rginda35c456b2012-02-09 17:29:05 -080049 this.scrollPort_ = new hterm.ScrollPort(this);
rginda8ba33642011-12-14 12:31:31 -080050 this.scrollPort_.subscribe('resize', this.onResize_.bind(this));
51 this.scrollPort_.subscribe('scroll', this.onScroll_.bind(this));
rginda9846e2f2012-01-27 13:53:33 -080052 this.scrollPort_.subscribe('paste', this.onPaste_.bind(this));
rgindaa09e7332012-08-17 12:49:51 -070053 this.scrollPort_.onCopy = this.onCopy_.bind(this);
rginda8ba33642011-12-14 12:31:31 -080054
rginda87b86462011-12-14 13:48:03 -080055 // The div that contains this terminal.
56 this.div_ = null;
57
rgindac9bc5502012-01-18 11:48:44 -080058 // The document that contains the scrollPort. Defaulted to the global
59 // document here so that the terminal is functional even if it hasn't been
60 // inserted into a document yet, but re-set in decorate().
61 this.document_ = window.document;
rginda87b86462011-12-14 13:48:03 -080062
rginda8ba33642011-12-14 12:31:31 -080063 // The rows that have scrolled off screen and are no longer addressable.
64 this.scrollbackRows_ = [];
65
rgindac9bc5502012-01-18 11:48:44 -080066 // Saved tab stops.
67 this.tabStops_ = [];
68
David Benjamin66e954d2012-05-05 21:08:12 -040069 // Keep track of whether default tab stops have been erased; after a TBC
70 // clears all tab stops, defaults aren't restored on resize until a reset.
71 this.defaultTabStops = true;
72
rginda8ba33642011-12-14 12:31:31 -080073 // The VT's notion of the top and bottom rows. Used during some VT
74 // cursor positioning and scrolling commands.
75 this.vtScrollTop_ = null;
76 this.vtScrollBottom_ = null;
77
78 // The DIV element for the visible cursor.
79 this.cursorNode_ = null;
80
Robert Ginda830583c2013-08-07 13:20:46 -070081 // The current cursor shape of the terminal.
82 this.cursorShape_ = hterm.Terminal.cursorShape.BLOCK;
83
84 // The current color of the cursor.
85 this.cursorColor_ = null;
86
Robert Gindaea2183e2014-07-17 09:51:51 -070087 // Cursor blink on/off cycle in ms, overwritten by prefs once they're loaded.
88 this.cursorBlinkCycle_ = [100, 100];
89
90 // Pre-bound onCursorBlink_ handler, so we don't have to do this for each
91 // cursor on/off servicing.
92 this.myOnCursorBlink_ = this.onCursorBlink_.bind(this);
93
rginda9f5222b2012-03-05 11:53:28 -080094 // These prefs are cached so we don't have to read from local storage with
Robert Ginda57f03b42012-09-13 11:02:48 -070095 // each output and keystroke. They are initialized by the preference manager.
Robert Ginda8cb7d902013-06-20 14:37:18 -070096 this.backgroundColor_ = null;
97 this.foregroundColor_ = null;
Robert Ginda57f03b42012-09-13 11:02:48 -070098 this.scrollOnOutput_ = null;
99 this.scrollOnKeystroke_ = null;
Mike Frysinger3c9fa072017-07-13 10:21:13 -0400100 this.scrollWheelArrowKeys_ = null;
rginda9f5222b2012-03-05 11:53:28 -0800101
Robert Ginda6aec7eb2015-06-16 10:31:30 -0700102 // True if we should override mouse event reporting to allow local selection.
103 this.defeatMouseReports_ = false;
Robert Ginda928cf632014-03-05 15:07:41 -0800104
rgindaf0090c92012-02-10 14:58:52 -0800105 // Terminal bell sound.
106 this.bellAudio_ = this.document_.createElement('audio');
rgindaf0090c92012-02-10 14:58:52 -0800107 this.bellAudio_.setAttribute('preload', 'auto');
108
Michael Kelly485ecd12014-06-09 11:41:56 -0400109 // All terminal bell notifications that have been generated (not necessarily
110 // shown).
111 this.bellNotificationList_ = [];
112
113 // Whether we have permission to display notifications.
114 this.desktopNotificationBell_ = false;
Michael Kelly485ecd12014-06-09 11:41:56 -0400115
rginda6d397402012-01-17 10:58:29 -0800116 // Cursor position and attributes saved with DECSC.
117 this.savedOptions_ = {};
118
rginda8ba33642011-12-14 12:31:31 -0800119 // The current mode bits for the terminal.
120 this.options_ = new hterm.Options();
121
122 // Timeouts we might need to clear.
123 this.timeouts_ = {};
rginda87b86462011-12-14 13:48:03 -0800124
125 // The VT escape sequence interpreter.
rginda0f5c0292012-01-13 11:00:13 -0800126 this.vt = new hterm.VT(this);
rginda87b86462011-12-14 13:48:03 -0800127
Zhu Qunying30d40712017-03-14 16:27:00 -0700128 // The keyboard handler.
rgindafeaf3142012-01-31 15:14:20 -0800129 this.keyboard = new hterm.Keyboard(this);
130
rginda87b86462011-12-14 13:48:03 -0800131 // General IO interface that can be given to third parties without exposing
132 // the entire terminal object.
133 this.io = new hterm.Terminal.IO(this);
rgindac9bc5502012-01-18 11:48:44 -0800134
rgindad5613292012-06-19 15:40:37 -0700135 // True if mouse-click-drag should scroll the terminal.
136 this.enableMouseDragScroll = true;
137
Robert Ginda57f03b42012-09-13 11:02:48 -0700138 this.copyOnSelect = null;
Mike Frysinger847577f2017-05-23 23:25:57 -0400139 this.mouseRightClickPaste = null;
rginda4bba5e12012-06-20 16:15:30 -0700140 this.mousePasteButton = null;
rginda4bba5e12012-06-20 16:15:30 -0700141
Zhu Qunying30d40712017-03-14 16:27:00 -0700142 // Whether to use the default window copy behavior.
Rob Spies0bec09b2014-06-06 15:58:09 -0700143 this.useDefaultWindowCopy = false;
144
145 this.clearSelectionAfterCopy = true;
146
Dmitry Polukhinbb2ef712012-01-19 19:00:37 +0400147 this.realizeSize_(80, 24);
rgindac9bc5502012-01-18 11:48:44 -0800148 this.setDefaultTabStops();
Robert Ginda57f03b42012-09-13 11:02:48 -0700149
150 this.setProfile(opt_profileId || 'default',
Evan Jones5f9df812016-12-06 09:38:58 -0500151 function() { this.onTerminalReady(); }.bind(this));
rginda87b86462011-12-14 13:48:03 -0800152};
153
154/**
Robert Ginda830583c2013-08-07 13:20:46 -0700155 * Possible cursor shapes.
156 */
157hterm.Terminal.cursorShape = {
158 BLOCK: 'BLOCK',
159 BEAM: 'BEAM',
160 UNDERLINE: 'UNDERLINE'
161};
162
163/**
Robert Ginda57f03b42012-09-13 11:02:48 -0700164 * Clients should override this to be notified when the terminal is ready
165 * for use.
166 *
167 * The terminal initialization is asynchronous, and shouldn't be used before
168 * this method is called.
169 */
170hterm.Terminal.prototype.onTerminalReady = function() { };
171
172/**
rginda35c456b2012-02-09 17:29:05 -0800173 * Default tab with of 8 to match xterm.
174 */
175hterm.Terminal.prototype.tabWidth = 8;
176
177/**
rginda9f5222b2012-03-05 11:53:28 -0800178 * Select a preference profile.
179 *
180 * This will load the terminal preferences for the given profile name and
181 * associate subsequent preference changes with the new preference profile.
182 *
Evan Jones2600d4f2016-12-06 09:29:36 -0500183 * @param {string} profileId The name of the preference profile. Forward slash
rginda9f5222b2012-03-05 11:53:28 -0800184 * characters will be removed from the name.
Robert Ginda57f03b42012-09-13 11:02:48 -0700185 * @param {function} opt_callback Optional callback to invoke when the profile
186 * transition is complete.
rginda9f5222b2012-03-05 11:53:28 -0800187 */
Robert Ginda57f03b42012-09-13 11:02:48 -0700188hterm.Terminal.prototype.setProfile = function(profileId, opt_callback) {
189 this.profileId_ = profileId.replace(/\//g, '');
rginda9f5222b2012-03-05 11:53:28 -0800190
Robert Ginda57f03b42012-09-13 11:02:48 -0700191 var terminal = this;
rginda9f5222b2012-03-05 11:53:28 -0800192
Robert Ginda57f03b42012-09-13 11:02:48 -0700193 if (this.prefs_)
194 this.prefs_.deactivate();
rginda9f5222b2012-03-05 11:53:28 -0800195
Robert Ginda57f03b42012-09-13 11:02:48 -0700196 this.prefs_ = new hterm.PreferenceManager(this.profileId_);
197 this.prefs_.addObservers(null, {
Robert Ginda034ffa72015-02-26 14:02:37 -0800198 'alt-gr-mode': function(v) {
199 if (v == null) {
200 if (navigator.language.toLowerCase() == 'en-us') {
201 v = 'none';
202 } else {
203 v = 'right-alt';
204 }
205 } else if (typeof v == 'string') {
206 v = v.toLowerCase();
207 } else {
208 v = 'none';
209 }
210
211 if (!/^(none|ctrl-alt|left-alt|right-alt)$/.test(v))
212 v = 'none';
213
214 terminal.keyboard.altGrMode = v;
215 },
216
Andrew de los Reyes574e10e2013-04-04 09:31:57 -0700217 'alt-backspace-is-meta-backspace': function(v) {
218 terminal.keyboard.altBackspaceIsMetaBackspace = v;
219 },
220
Robert Ginda57f03b42012-09-13 11:02:48 -0700221 'alt-is-meta': function(v) {
222 terminal.keyboard.altIsMeta = v;
223 },
224
225 'alt-sends-what': function(v) {
226 if (!/^(escape|8-bit|browser-key)$/.test(v))
227 v = 'escape';
228
229 terminal.keyboard.altSendsWhat = v;
230 },
231
232 'audible-bell-sound': function(v) {
Robert Gindab4839c22013-02-28 16:52:10 -0800233 var ary = v.match(/^lib-resource:(\S+)/);
234 if (ary) {
235 terminal.bellAudio_.setAttribute('src',
236 lib.resource.getDataUrl(ary[1]));
237 } else {
238 terminal.bellAudio_.setAttribute('src', v);
239 }
Robert Ginda57f03b42012-09-13 11:02:48 -0700240 },
241
Michael Kelly485ecd12014-06-09 11:41:56 -0400242 'desktop-notification-bell': function(v) {
243 if (v && Notification) {
Robert Ginda348dc2b2014-06-24 14:42:23 -0700244 terminal.desktopNotificationBell_ =
Michael Kellyb8067862014-06-26 12:59:47 -0400245 Notification.permission === 'granted';
246 if (!terminal.desktopNotificationBell_) {
247 // Note: We don't call Notification.requestPermission here because
248 // Chrome requires the call be the result of a user action (such as an
249 // onclick handler), and pref listeners are run asynchronously.
250 //
251 // A way of working around this would be to display a dialog in the
252 // terminal with a "click-to-request-permission" button.
253 console.warn('desktop-notification-bell is true but we do not have ' +
254 'permission to display notifications.');
Michael Kelly485ecd12014-06-09 11:41:56 -0400255 }
256 } else {
257 terminal.desktopNotificationBell_ = false;
258 }
259 },
260
Robert Ginda57f03b42012-09-13 11:02:48 -0700261 'background-color': function(v) {
262 terminal.setBackgroundColor(v);
263 },
264
265 'background-image': function(v) {
266 terminal.scrollPort_.setBackgroundImage(v);
267 },
268
269 'background-size': function(v) {
270 terminal.scrollPort_.setBackgroundSize(v);
271 },
272
273 'background-position': function(v) {
274 terminal.scrollPort_.setBackgroundPosition(v);
275 },
276
277 'backspace-sends-backspace': function(v) {
278 terminal.keyboard.backspaceSendsBackspace = v;
279 },
280
Brad Town18654b62015-03-12 00:27:45 -0700281 'character-map-overrides': function(v) {
282 if (!(v == null || v instanceof Object)) {
283 console.warn('Preference character-map-modifications is not an ' +
284 'object: ' + v);
285 return;
286 }
287
Mike Frysinger095d4062017-06-14 00:29:48 -0700288 terminal.vt.characterMaps.reset();
289 terminal.vt.characterMaps.setOverrides(v);
Brad Town18654b62015-03-12 00:27:45 -0700290 },
291
Robert Ginda57f03b42012-09-13 11:02:48 -0700292 'cursor-blink': function(v) {
293 terminal.setCursorBlink(!!v);
294 },
295
Robert Gindaea2183e2014-07-17 09:51:51 -0700296 'cursor-blink-cycle': function(v) {
297 if (v instanceof Array &&
298 typeof v[0] == 'number' &&
299 typeof v[1] == 'number') {
300 terminal.cursorBlinkCycle_ = v;
301 } else if (typeof v == 'number') {
302 terminal.cursorBlinkCycle_ = [v, v];
303 } else {
304 // Fast blink indicates an error.
305 terminal.cursorBlinkCycle_ = [100, 100];
306 }
307 },
308
Robert Ginda57f03b42012-09-13 11:02:48 -0700309 'cursor-color': function(v) {
310 terminal.setCursorColor(v);
311 },
312
313 'color-palette-overrides': function(v) {
314 if (!(v == null || v instanceof Object || v instanceof Array)) {
315 console.warn('Preference color-palette-overrides is not an array or ' +
316 'object: ' + v);
317 return;
rginda9f5222b2012-03-05 11:53:28 -0800318 }
rginda9f5222b2012-03-05 11:53:28 -0800319
Robert Ginda57f03b42012-09-13 11:02:48 -0700320 lib.colors.colorPalette = lib.colors.stockColorPalette.concat();
rginda39bdf6f2012-04-10 16:50:55 -0700321
Robert Ginda57f03b42012-09-13 11:02:48 -0700322 if (v) {
323 for (var key in v) {
324 var i = parseInt(key);
325 if (isNaN(i) || i < 0 || i > 255) {
326 console.log('Invalid value in palette: ' + key + ': ' + v[key]);
327 continue;
328 }
329
330 if (v[i]) {
331 var rgb = lib.colors.normalizeCSS(v[i]);
332 if (rgb)
333 lib.colors.colorPalette[i] = rgb;
334 }
335 }
rginda30f20f62012-04-05 16:36:19 -0700336 }
rginda30f20f62012-04-05 16:36:19 -0700337
Evan Jones5f9df812016-12-06 09:38:58 -0500338 terminal.primaryScreen_.textAttributes.resetColorPalette();
Robert Ginda57f03b42012-09-13 11:02:48 -0700339 terminal.alternateScreen_.textAttributes.resetColorPalette();
340 },
rginda30f20f62012-04-05 16:36:19 -0700341
Robert Ginda57f03b42012-09-13 11:02:48 -0700342 'copy-on-select': function(v) {
343 terminal.copyOnSelect = !!v;
344 },
rginda9f5222b2012-03-05 11:53:28 -0800345
Rob Spies0bec09b2014-06-06 15:58:09 -0700346 'use-default-window-copy': function(v) {
347 terminal.useDefaultWindowCopy = !!v;
348 },
349
350 'clear-selection-after-copy': function(v) {
351 terminal.clearSelectionAfterCopy = !!v;
352 },
353
Robert Ginda7e5e9522014-03-14 12:23:58 -0700354 'ctrl-plus-minus-zero-zoom': function(v) {
355 terminal.keyboard.ctrlPlusMinusZeroZoom = v;
356 },
357
Robert Gindafb5a3f92014-05-13 14:12:00 -0700358 'ctrl-c-copy': function(v) {
359 terminal.keyboard.ctrlCCopy = v;
360 },
361
Leonardo Mesquita61e7c312014-01-04 12:53:12 +0100362 'ctrl-v-paste': function(v) {
363 terminal.keyboard.ctrlVPaste = v;
Rob Spiese52e1842014-07-10 15:32:51 -0700364 terminal.scrollPort_.setCtrlVPaste(v);
Leonardo Mesquita61e7c312014-01-04 12:53:12 +0100365 },
366
Masaya Suzuki273aa982014-05-31 07:25:55 +0900367 'east-asian-ambiguous-as-two-column': function(v) {
368 lib.wc.regardCjkAmbiguous = v;
369 },
370
Robert Ginda57f03b42012-09-13 11:02:48 -0700371 'enable-8-bit-control': function(v) {
372 terminal.vt.enable8BitControl = !!v;
373 },
rginda30f20f62012-04-05 16:36:19 -0700374
Robert Ginda57f03b42012-09-13 11:02:48 -0700375 'enable-bold': function(v) {
376 terminal.syncBoldSafeState();
377 },
Philip Douglass959b49d2012-05-30 13:29:29 -0400378
Robert Ginda3e278d72014-03-25 13:18:51 -0700379 'enable-bold-as-bright': function(v) {
380 terminal.primaryScreen_.textAttributes.enableBoldAsBright = !!v;
381 terminal.alternateScreen_.textAttributes.enableBoldAsBright = !!v;
382 },
383
Mike Frysinger93b75ba2017-04-05 19:43:18 -0400384 'enable-blink': function(v) {
385 terminal.syncBlinkState();
386 },
387
Robert Ginda57f03b42012-09-13 11:02:48 -0700388 'enable-clipboard-write': function(v) {
389 terminal.vt.enableClipboardWrite = !!v;
390 },
Philip Douglass959b49d2012-05-30 13:29:29 -0400391
Robert Ginda3755e752013-05-31 13:34:09 -0700392 'enable-dec12': function(v) {
393 terminal.vt.enableDec12 = !!v;
394 },
395
Robert Ginda57f03b42012-09-13 11:02:48 -0700396 'font-family': function(v) {
397 terminal.syncFontFamily();
398 },
rginda30f20f62012-04-05 16:36:19 -0700399
Robert Ginda57f03b42012-09-13 11:02:48 -0700400 'font-size': function(v) {
401 terminal.setFontSize(v);
402 },
rginda9875d902012-08-20 16:21:57 -0700403
Robert Ginda57f03b42012-09-13 11:02:48 -0700404 'font-smoothing': function(v) {
405 terminal.syncFontFamily();
406 },
rgindade84e382012-04-20 15:39:31 -0700407
Robert Ginda57f03b42012-09-13 11:02:48 -0700408 'foreground-color': function(v) {
409 terminal.setForegroundColor(v);
410 },
rginda30f20f62012-04-05 16:36:19 -0700411
Robert Ginda57f03b42012-09-13 11:02:48 -0700412 'home-keys-scroll': function(v) {
413 terminal.keyboard.homeKeysScroll = v;
414 },
rginda4bba5e12012-06-20 16:15:30 -0700415
Robert Gindaa8165692015-06-15 14:46:31 -0700416 'keybindings': function(v) {
417 terminal.keyboard.bindings.clear();
418
419 if (!v)
420 return;
421
422 if (!(v instanceof Object)) {
423 console.error('Error in keybindings preference: Expected object');
424 return;
425 }
426
427 try {
428 terminal.keyboard.bindings.addBindings(v);
429 } catch (ex) {
430 console.error('Error in keybindings preference: ' + ex);
431 }
432 },
433
Robert Ginda57f03b42012-09-13 11:02:48 -0700434 'max-string-sequence': function(v) {
435 terminal.vt.maxStringSequence = v;
436 },
rginda11057d52012-04-25 12:29:56 -0700437
Andrew de los Reyes6af23ae2013-04-04 14:17:50 -0700438 'media-keys-are-fkeys': function(v) {
439 terminal.keyboard.mediaKeysAreFKeys = v;
440 },
441
Robert Ginda57f03b42012-09-13 11:02:48 -0700442 'meta-sends-escape': function(v) {
443 terminal.keyboard.metaSendsEscape = v;
444 },
rginda30f20f62012-04-05 16:36:19 -0700445
Mike Frysinger847577f2017-05-23 23:25:57 -0400446 'mouse-right-click-paste': function(v) {
447 terminal.mouseRightClickPaste = v;
448 },
449
Robert Ginda57f03b42012-09-13 11:02:48 -0700450 'mouse-paste-button': function(v) {
451 terminal.syncMousePasteButton();
452 },
rgindaa8ba17d2012-08-15 14:41:10 -0700453
Robert Gindae76aa9f2014-03-14 12:29:12 -0700454 'page-keys-scroll': function(v) {
455 terminal.keyboard.pageKeysScroll = v;
456 },
457
Robert Ginda40932892012-12-10 17:26:40 -0800458 'pass-alt-number': function(v) {
459 if (v == null) {
460 var osx = window.navigator.userAgent.match(/Mac OS X/);
461
462 // Let Alt-1..9 pass to the browser (to control tab switching) on
463 // non-OS X systems, or if hterm is not opened in an app window.
464 v = (!osx && hterm.windowType != 'popup');
465 }
466
467 terminal.passAltNumber = v;
468 },
469
470 'pass-ctrl-number': function(v) {
471 if (v == null) {
472 var osx = window.navigator.userAgent.match(/Mac OS X/);
473
474 // Let Ctrl-1..9 pass to the browser (to control tab switching) on
475 // non-OS X systems, or if hterm is not opened in an app window.
476 v = (!osx && hterm.windowType != 'popup');
477 }
478
479 terminal.passCtrlNumber = v;
480 },
481
482 'pass-meta-number': function(v) {
483 if (v == null) {
484 var osx = window.navigator.userAgent.match(/Mac OS X/);
485
486 // Let Meta-1..9 pass to the browser (to control tab switching) on
487 // OS X systems, or if hterm is not opened in an app window.
488 v = (osx && hterm.windowType != 'popup');
489 }
490
491 terminal.passMetaNumber = v;
492 },
493
Marius Schilder77857b32014-05-14 16:21:26 -0700494 'pass-meta-v': function(v) {
Marius Schilder1a567812014-05-15 20:30:02 -0700495 terminal.keyboard.passMetaV = v;
Marius Schilder77857b32014-05-14 16:21:26 -0700496 },
497
Robert Ginda8cb7d902013-06-20 14:37:18 -0700498 'receive-encoding': function(v) {
499 if (!(/^(utf-8|raw)$/).test(v)) {
500 console.warn('Invalid value for "receive-encoding": ' + v);
501 v = 'utf-8';
502 }
503
504 terminal.vt.characterEncoding = v;
505 },
506
Robert Ginda57f03b42012-09-13 11:02:48 -0700507 'scroll-on-keystroke': function(v) {
508 terminal.scrollOnKeystroke_ = v;
509 },
rginda9f5222b2012-03-05 11:53:28 -0800510
Robert Ginda57f03b42012-09-13 11:02:48 -0700511 'scroll-on-output': function(v) {
512 terminal.scrollOnOutput_ = v;
513 },
rginda30f20f62012-04-05 16:36:19 -0700514
Robert Ginda57f03b42012-09-13 11:02:48 -0700515 'scrollbar-visible': function(v) {
516 terminal.setScrollbarVisible(v);
517 },
rginda9f5222b2012-03-05 11:53:28 -0800518
Mike Frysinger3c9fa072017-07-13 10:21:13 -0400519 'scroll-wheel-may-send-arrow-keys': function(v) {
520 terminal.scrollWheelArrowKeys_ = v;
521 },
522
Rob Spies49039e52014-12-17 13:40:04 -0800523 'scroll-wheel-move-multiplier': function(v) {
524 terminal.setScrollWheelMoveMultipler(v);
525 },
526
Robert Ginda8cb7d902013-06-20 14:37:18 -0700527 'send-encoding': function(v) {
528 if (!(/^(utf-8|raw)$/).test(v)) {
529 console.warn('Invalid value for "send-encoding": ' + v);
530 v = 'utf-8';
531 }
532
533 terminal.keyboard.characterEncoding = v;
534 },
535
Robert Ginda57f03b42012-09-13 11:02:48 -0700536 'shift-insert-paste': function(v) {
537 terminal.keyboard.shiftInsertPaste = v;
538 },
rginda9f5222b2012-03-05 11:53:28 -0800539
Mike Frysingera7768922017-07-28 15:00:12 -0400540 'terminal-encoding': function(v) {
541 switch (v) {
542 default:
543 console.warn('Invalid value for "terminal-encoding": ' + v);
544 // Fall through.
545 case 'iso-2022':
546 terminal.vt.codingSystemUtf8 = false;
547 terminal.vt.codingSystemLocked = false;
548 break;
549 case 'utf-8-locked':
550 terminal.vt.codingSystemUtf8 = true;
551 terminal.vt.codingSystemLocked = true;
552 break;
553 case 'utf-8':
554 terminal.vt.codingSystemUtf8 = true;
555 terminal.vt.codingSystemLocked = false;
556 break;
557 }
558 },
559
Robert Gindae76aa9f2014-03-14 12:29:12 -0700560 'user-css': function(v) {
Mike Frysinger08bad432017-04-24 00:50:54 -0400561 terminal.scrollPort_.setUserCssUrl(v);
562 },
563
564 'user-css-text': function(v) {
565 terminal.scrollPort_.setUserCssText(v);
566 },
Mike Frysinger664e9992017-05-19 01:24:24 -0400567
568 'word-break-match-left': function(v) {
569 terminal.primaryScreen_.wordBreakMatchLeft = v;
570 terminal.alternateScreen_.wordBreakMatchLeft = v;
571 },
572
573 'word-break-match-right': function(v) {
574 terminal.primaryScreen_.wordBreakMatchRight = v;
575 terminal.alternateScreen_.wordBreakMatchRight = v;
576 },
577
578 'word-break-match-middle': function(v) {
579 terminal.primaryScreen_.wordBreakMatchMiddle = v;
580 terminal.alternateScreen_.wordBreakMatchMiddle = v;
581 },
Robert Ginda57f03b42012-09-13 11:02:48 -0700582 });
rginda30f20f62012-04-05 16:36:19 -0700583
Robert Ginda57f03b42012-09-13 11:02:48 -0700584 this.prefs_.readStorage(function() {
rginda9f5222b2012-03-05 11:53:28 -0800585 this.prefs_.notifyAll();
Robert Ginda57f03b42012-09-13 11:02:48 -0700586
587 if (opt_callback)
588 opt_callback();
589 }.bind(this));
rginda9f5222b2012-03-05 11:53:28 -0800590};
591
Rob Spies56953412014-04-28 14:09:47 -0700592
593/**
594 * Returns the preferences manager used for configuring this terminal.
Evan Jones2600d4f2016-12-06 09:29:36 -0500595 *
596 * @return {hterm.PreferenceManager}
Rob Spies56953412014-04-28 14:09:47 -0700597 */
598hterm.Terminal.prototype.getPrefs = function() {
599 return this.prefs_;
600};
601
Robert Gindaa063b202014-07-21 11:08:25 -0700602/**
603 * Enable or disable bracketed paste mode.
Evan Jones2600d4f2016-12-06 09:29:36 -0500604 *
605 * @param {boolean} state The value to set.
Robert Gindaa063b202014-07-21 11:08:25 -0700606 */
607hterm.Terminal.prototype.setBracketedPaste = function(state) {
608 this.options_.bracketedPaste = state;
609};
Rob Spies56953412014-04-28 14:09:47 -0700610
rginda8e92a692012-05-20 19:37:20 -0700611/**
612 * Set the color for the cursor.
613 *
614 * If you want this setting to persist, set it through prefs_, rather than
615 * with this method.
Evan Jones2600d4f2016-12-06 09:29:36 -0500616 *
617 * @param {string} color The color to set.
rginda8e92a692012-05-20 19:37:20 -0700618 */
619hterm.Terminal.prototype.setCursorColor = function(color) {
Robert Ginda830583c2013-08-07 13:20:46 -0700620 this.cursorColor_ = color;
rginda8e92a692012-05-20 19:37:20 -0700621 this.cursorNode_.style.backgroundColor = color;
622 this.cursorNode_.style.borderColor = color;
623};
624
625/**
626 * Return the current cursor color as a string.
Evan Jones2600d4f2016-12-06 09:29:36 -0500627 * @return {string}
rginda8e92a692012-05-20 19:37:20 -0700628 */
629hterm.Terminal.prototype.getCursorColor = function() {
Robert Ginda830583c2013-08-07 13:20:46 -0700630 return this.cursorColor_;
rginda8e92a692012-05-20 19:37:20 -0700631};
632
633/**
rgindad5613292012-06-19 15:40:37 -0700634 * Enable or disable mouse based text selection in the terminal.
Evan Jones2600d4f2016-12-06 09:29:36 -0500635 *
636 * @param {boolean} state The value to set.
rgindad5613292012-06-19 15:40:37 -0700637 */
638hterm.Terminal.prototype.setSelectionEnabled = function(state) {
639 this.enableMouseDragScroll = state;
rgindad5613292012-06-19 15:40:37 -0700640};
641
642/**
rginda8e92a692012-05-20 19:37:20 -0700643 * Set the background color.
644 *
645 * If you want this setting to persist, set it through prefs_, rather than
646 * with this method.
Evan Jones2600d4f2016-12-06 09:29:36 -0500647 *
648 * @param {string} color The color to set.
rginda8e92a692012-05-20 19:37:20 -0700649 */
650hterm.Terminal.prototype.setBackgroundColor = function(color) {
rgindacbbd7482012-06-13 15:06:16 -0700651 this.backgroundColor_ = lib.colors.normalizeCSS(color);
Robert Ginda57f03b42012-09-13 11:02:48 -0700652 this.primaryScreen_.textAttributes.setDefaults(
653 this.foregroundColor_, this.backgroundColor_);
654 this.alternateScreen_.textAttributes.setDefaults(
655 this.foregroundColor_, this.backgroundColor_);
rginda8e92a692012-05-20 19:37:20 -0700656 this.scrollPort_.setBackgroundColor(color);
657};
658
rginda9f5222b2012-03-05 11:53:28 -0800659/**
660 * Return the current terminal background color.
661 *
662 * Intended for use by other classes, so we don't have to expose the entire
663 * prefs_ object.
Evan Jones2600d4f2016-12-06 09:29:36 -0500664 *
665 * @return {string}
rginda9f5222b2012-03-05 11:53:28 -0800666 */
667hterm.Terminal.prototype.getBackgroundColor = function() {
rginda8e92a692012-05-20 19:37:20 -0700668 return this.backgroundColor_;
669};
670
671/**
672 * Set the foreground color.
673 *
674 * If you want this setting to persist, set it through prefs_, rather than
675 * with this method.
Evan Jones2600d4f2016-12-06 09:29:36 -0500676 *
677 * @param {string} color The color to set.
rginda8e92a692012-05-20 19:37:20 -0700678 */
679hterm.Terminal.prototype.setForegroundColor = function(color) {
rgindacbbd7482012-06-13 15:06:16 -0700680 this.foregroundColor_ = lib.colors.normalizeCSS(color);
Robert Ginda57f03b42012-09-13 11:02:48 -0700681 this.primaryScreen_.textAttributes.setDefaults(
682 this.foregroundColor_, this.backgroundColor_);
683 this.alternateScreen_.textAttributes.setDefaults(
684 this.foregroundColor_, this.backgroundColor_);
rginda8e92a692012-05-20 19:37:20 -0700685 this.scrollPort_.setForegroundColor(color);
rginda9f5222b2012-03-05 11:53:28 -0800686};
687
688/**
689 * Return the current terminal foreground color.
690 *
691 * Intended for use by other classes, so we don't have to expose the entire
692 * prefs_ object.
Evan Jones2600d4f2016-12-06 09:29:36 -0500693 *
694 * @return {string}
rginda9f5222b2012-03-05 11:53:28 -0800695 */
696hterm.Terminal.prototype.getForegroundColor = function() {
rginda8e92a692012-05-20 19:37:20 -0700697 return this.foregroundColor_;
rginda9f5222b2012-03-05 11:53:28 -0800698};
699
700/**
rginda87b86462011-12-14 13:48:03 -0800701 * Create a new instance of a terminal command and run it with a given
702 * argument string.
703 *
704 * @param {function} commandClass The constructor for a terminal command.
705 * @param {string} argString The argument string to pass to the command.
706 */
707hterm.Terminal.prototype.runCommandClass = function(commandClass, argString) {
rgindaf522ce02012-04-17 17:49:17 -0700708 var environment = this.prefs_.get('environment');
709 if (typeof environment != 'object' || environment == null)
710 environment = {};
711
rginda87b86462011-12-14 13:48:03 -0800712 var self = this;
713 this.command = new commandClass(
714 { argString: argString || '',
715 io: this.io.push(),
rgindaf522ce02012-04-17 17:49:17 -0700716 environment: environment,
rginda87b86462011-12-14 13:48:03 -0800717 onExit: function(code) {
718 self.io.pop();
rgindafeaf3142012-01-31 15:14:20 -0800719 self.uninstallKeyboard();
rginda9875d902012-08-20 16:21:57 -0700720 if (self.prefs_.get('close-on-exit'))
721 window.close();
rginda87b86462011-12-14 13:48:03 -0800722 }
723 });
724
rgindafeaf3142012-01-31 15:14:20 -0800725 this.installKeyboard();
rginda87b86462011-12-14 13:48:03 -0800726 this.command.run();
727};
728
729/**
rgindafeaf3142012-01-31 15:14:20 -0800730 * Returns true if the current screen is the primary screen, false otherwise.
Evan Jones2600d4f2016-12-06 09:29:36 -0500731 *
732 * @return {boolean}
rgindafeaf3142012-01-31 15:14:20 -0800733 */
734hterm.Terminal.prototype.isPrimaryScreen = function() {
rgindaf522ce02012-04-17 17:49:17 -0700735 return this.screen_ == this.primaryScreen_;
rgindafeaf3142012-01-31 15:14:20 -0800736};
737
738/**
739 * Install the keyboard handler for this terminal.
740 *
741 * This will prevent the browser from seeing any keystrokes sent to the
742 * terminal.
743 */
744hterm.Terminal.prototype.installKeyboard = function() {
Rob Spies06533ba2014-04-24 11:20:37 -0700745 this.keyboard.installKeyboard(this.scrollPort_.getDocument().body);
rgindafeaf3142012-01-31 15:14:20 -0800746}
747
748/**
749 * Uninstall the keyboard handler for this terminal.
750 */
751hterm.Terminal.prototype.uninstallKeyboard = function() {
752 this.keyboard.installKeyboard(null);
753}
754
755/**
rginda35c456b2012-02-09 17:29:05 -0800756 * Set the font size for this terminal.
rginda9f5222b2012-03-05 11:53:28 -0800757 *
758 * Call setFontSize(0) to reset to the default font size.
759 *
760 * This function does not modify the font-size preference.
761 *
762 * @param {number} px The desired font size, in pixels.
rginda35c456b2012-02-09 17:29:05 -0800763 */
764hterm.Terminal.prototype.setFontSize = function(px) {
rginda9f5222b2012-03-05 11:53:28 -0800765 if (px === 0)
766 px = this.prefs_.get('font-size');
767
rginda35c456b2012-02-09 17:29:05 -0800768 this.scrollPort_.setFontSize(px);
Mike Frysinger66beb0b2017-05-30 19:44:51 -0400769 this.document_.documentElement.style.setProperty(
770 '--hterm-charsize-width', this.scrollPort_.characterSize.width + 'px');
771 this.document_.documentElement.style.setProperty(
772 '--hterm-charsize-height', this.scrollPort_.characterSize.height + 'px');
rginda35c456b2012-02-09 17:29:05 -0800773};
774
775/**
776 * Get the current font size.
Evan Jones2600d4f2016-12-06 09:29:36 -0500777 *
778 * @return {number}
rginda35c456b2012-02-09 17:29:05 -0800779 */
780hterm.Terminal.prototype.getFontSize = function() {
781 return this.scrollPort_.getFontSize();
782};
783
784/**
rginda8e92a692012-05-20 19:37:20 -0700785 * Get the current font family.
Evan Jones2600d4f2016-12-06 09:29:36 -0500786 *
787 * @return {string}
rginda8e92a692012-05-20 19:37:20 -0700788 */
789hterm.Terminal.prototype.getFontFamily = function() {
790 return this.scrollPort_.getFontFamily();
791};
792
793/**
rginda35c456b2012-02-09 17:29:05 -0800794 * Set the CSS "font-family" for this terminal.
795 */
rginda9f5222b2012-03-05 11:53:28 -0800796hterm.Terminal.prototype.syncFontFamily = function() {
797 this.scrollPort_.setFontFamily(this.prefs_.get('font-family'),
798 this.prefs_.get('font-smoothing'));
799 this.syncBoldSafeState();
800};
801
rginda4bba5e12012-06-20 16:15:30 -0700802/**
803 * Set this.mousePasteButton based on the mouse-paste-button pref,
804 * autodetecting if necessary.
805 */
806hterm.Terminal.prototype.syncMousePasteButton = function() {
807 var button = this.prefs_.get('mouse-paste-button');
808 if (typeof button == 'number') {
809 this.mousePasteButton = button;
810 return;
811 }
812
813 var ary = navigator.userAgent.match(/\(X11;\s+(\S+)/);
Mike Frysinger98dd15b2017-05-18 22:52:23 -0400814 if (!ary || ary[1] == 'CrOS') {
Mike Frysinger2edd3612017-05-24 00:54:39 -0400815 this.mousePasteButton = 1; // Middle mouse button.
rginda4bba5e12012-06-20 16:15:30 -0700816 } else {
Mike Frysinger2edd3612017-05-24 00:54:39 -0400817 this.mousePasteButton = 2; // Right mouse button.
rginda4bba5e12012-06-20 16:15:30 -0700818 }
819};
820
821/**
822 * Enable or disable bold based on the enable-bold pref, autodetecting if
823 * necessary.
824 */
rginda9f5222b2012-03-05 11:53:28 -0800825hterm.Terminal.prototype.syncBoldSafeState = function() {
826 var enableBold = this.prefs_.get('enable-bold');
827 if (enableBold !== null) {
Robert Gindaed016262012-10-26 16:27:09 -0700828 this.primaryScreen_.textAttributes.enableBold = enableBold;
829 this.alternateScreen_.textAttributes.enableBold = enableBold;
rginda9f5222b2012-03-05 11:53:28 -0800830 return;
831 }
832
rgindaf7521392012-02-28 17:20:34 -0800833 var normalSize = this.scrollPort_.measureCharacterSize();
834 var boldSize = this.scrollPort_.measureCharacterSize('bold');
835
836 var isBoldSafe = normalSize.equals(boldSize);
rgindaf7521392012-02-28 17:20:34 -0800837 if (!isBoldSafe) {
838 console.warn('Bold characters disabled: Size of bold weight differs ' +
rgindac9759de2012-03-19 13:21:41 -0700839 'from normal. Font family is: ' +
840 this.scrollPort_.getFontFamily());
rgindaf7521392012-02-28 17:20:34 -0800841 }
rginda9f5222b2012-03-05 11:53:28 -0800842
Robert Gindaed016262012-10-26 16:27:09 -0700843 this.primaryScreen_.textAttributes.enableBold = isBoldSafe;
844 this.alternateScreen_.textAttributes.enableBold = isBoldSafe;
rginda35c456b2012-02-09 17:29:05 -0800845};
846
847/**
Mike Frysinger93b75ba2017-04-05 19:43:18 -0400848 * Enable or disable blink based on the enable-blink pref.
849 */
850hterm.Terminal.prototype.syncBlinkState = function() {
851 this.document_.documentElement.style.setProperty(
852 '--hterm-blink-node-duration',
853 this.prefs_.get('enable-blink') ? '0.7s' : '0');
854};
855
856/**
Mike Frysinger6ab275c2017-05-28 12:48:44 -0400857 * Set the mouse cursor style based on the current terminal mode.
858 */
859hterm.Terminal.prototype.syncMouseStyle = function() {
860 this.document_.documentElement.style.setProperty(
861 '--hterm-mouse-cursor-style',
862 this.vt.mouseReport == this.vt.MOUSE_REPORT_DISABLED ?
863 'var(--hterm-mouse-cursor-text)' :
864 'var(--hterm-mouse-cursor-pointer)');
865};
866
867/**
rginda87b86462011-12-14 13:48:03 -0800868 * Return a copy of the current cursor position.
869 *
870 * @return {hterm.RowCol} The RowCol object representing the current position.
871 */
872hterm.Terminal.prototype.saveCursor = function() {
873 return this.screen_.cursorPosition.clone();
874};
875
Evan Jones2600d4f2016-12-06 09:29:36 -0500876/**
877 * Return the current text attributes.
878 *
879 * @return {string}
880 */
rgindaa19afe22012-01-25 15:40:22 -0800881hterm.Terminal.prototype.getTextAttributes = function() {
882 return this.screen_.textAttributes;
883};
884
Evan Jones2600d4f2016-12-06 09:29:36 -0500885/**
886 * Set the text attributes.
887 *
888 * @param {string} textAttributes The attributes to set.
889 */
rginda1a09aa02012-06-18 21:11:25 -0700890hterm.Terminal.prototype.setTextAttributes = function(textAttributes) {
891 this.screen_.textAttributes = textAttributes;
892};
893
rginda87b86462011-12-14 13:48:03 -0800894/**
rgindaf522ce02012-04-17 17:49:17 -0700895 * Return the current browser zoom factor applied to the terminal.
896 *
897 * @return {number} The current browser zoom factor.
898 */
899hterm.Terminal.prototype.getZoomFactor = function() {
900 return this.scrollPort_.characterSize.zoomFactor;
901};
902
903/**
rginda9846e2f2012-01-27 13:53:33 -0800904 * Change the title of this terminal's window.
Evan Jones2600d4f2016-12-06 09:29:36 -0500905 *
906 * @param {string} title The title to set.
rginda9846e2f2012-01-27 13:53:33 -0800907 */
908hterm.Terminal.prototype.setWindowTitle = function(title) {
rgindafeaf3142012-01-31 15:14:20 -0800909 window.document.title = title;
rginda9846e2f2012-01-27 13:53:33 -0800910};
911
912/**
rginda87b86462011-12-14 13:48:03 -0800913 * Restore a previously saved cursor position.
914 *
915 * @param {hterm.RowCol} cursor The position to restore.
916 */
917hterm.Terminal.prototype.restoreCursor = function(cursor) {
rgindacbbd7482012-06-13 15:06:16 -0700918 var row = lib.f.clamp(cursor.row, 0, this.screenSize.height - 1);
919 var column = lib.f.clamp(cursor.column, 0, this.screenSize.width - 1);
rginda35c456b2012-02-09 17:29:05 -0800920 this.screen_.setCursorPosition(row, column);
921 if (cursor.column > column ||
922 cursor.column == column && cursor.overflow) {
923 this.screen_.cursorPosition.overflow = true;
924 }
rginda87b86462011-12-14 13:48:03 -0800925};
926
927/**
David Benjamin54e8bf62012-06-01 22:31:40 -0400928 * Clear the cursor's overflow flag.
929 */
930hterm.Terminal.prototype.clearCursorOverflow = function() {
931 this.screen_.cursorPosition.overflow = false;
932};
933
934/**
Robert Ginda830583c2013-08-07 13:20:46 -0700935 * Sets the cursor shape
Evan Jones2600d4f2016-12-06 09:29:36 -0500936 *
937 * @param {string} shape The shape to set.
Robert Ginda830583c2013-08-07 13:20:46 -0700938 */
939hterm.Terminal.prototype.setCursorShape = function(shape) {
940 this.cursorShape_ = shape;
Robert Gindafb1be6a2013-12-11 11:56:22 -0800941 this.restyleCursor_();
Robert Ginda830583c2013-08-07 13:20:46 -0700942}
943
944/**
945 * Get the cursor shape
Evan Jones2600d4f2016-12-06 09:29:36 -0500946 *
947 * @return {string}
Robert Ginda830583c2013-08-07 13:20:46 -0700948 */
949hterm.Terminal.prototype.getCursorShape = function() {
950 return this.cursorShape_;
951}
952
953/**
rginda87b86462011-12-14 13:48:03 -0800954 * Set the width of the terminal, resizing the UI to match.
Evan Jones2600d4f2016-12-06 09:29:36 -0500955 *
956 * @param {number} columnCount
rginda87b86462011-12-14 13:48:03 -0800957 */
958hterm.Terminal.prototype.setWidth = function(columnCount) {
rgindaf0090c92012-02-10 14:58:52 -0800959 if (columnCount == null) {
960 this.div_.style.width = '100%';
961 return;
962 }
963
Robert Ginda26806d12014-07-24 13:44:07 -0700964 this.div_.style.width = Math.ceil(
965 this.scrollPort_.characterSize.width *
966 columnCount + this.scrollPort_.currentScrollbarWidthPx) + 'px';
Dmitry Polukhinbb2ef712012-01-19 19:00:37 +0400967 this.realizeSize_(columnCount, this.screenSize.height);
rgindac9bc5502012-01-18 11:48:44 -0800968 this.scheduleSyncCursorPosition_();
969};
rginda87b86462011-12-14 13:48:03 -0800970
rgindac9bc5502012-01-18 11:48:44 -0800971/**
rginda35c456b2012-02-09 17:29:05 -0800972 * Set the height of the terminal, resizing the UI to match.
Evan Jones2600d4f2016-12-06 09:29:36 -0500973 *
974 * @param {number} rowCount The height in rows.
rginda35c456b2012-02-09 17:29:05 -0800975 */
976hterm.Terminal.prototype.setHeight = function(rowCount) {
rgindaf0090c92012-02-10 14:58:52 -0800977 if (rowCount == null) {
978 this.div_.style.height = '100%';
979 return;
980 }
981
rginda35c456b2012-02-09 17:29:05 -0800982 this.div_.style.height =
rginda30f20f62012-04-05 16:36:19 -0700983 this.scrollPort_.characterSize.height * rowCount + 'px';
rginda35c456b2012-02-09 17:29:05 -0800984 this.realizeSize_(this.screenSize.width, rowCount);
985 this.scheduleSyncCursorPosition_();
986};
987
988/**
Dmitry Polukhinbb2ef712012-01-19 19:00:37 +0400989 * Deal with terminal size changes.
990 *
Evan Jones2600d4f2016-12-06 09:29:36 -0500991 * @param {number} columnCount The number of columns.
992 * @param {number} rowCount The number of rows.
Dmitry Polukhinbb2ef712012-01-19 19:00:37 +0400993 */
994hterm.Terminal.prototype.realizeSize_ = function(columnCount, rowCount) {
995 if (columnCount != this.screenSize.width)
996 this.realizeWidth_(columnCount);
997
998 if (rowCount != this.screenSize.height)
999 this.realizeHeight_(rowCount);
1000
1001 // Send new terminal size to plugin.
Robert Gindae81427f2013-05-24 10:34:46 -07001002 this.io.onTerminalResize_(columnCount, rowCount);
Dmitry Polukhinbb2ef712012-01-19 19:00:37 +04001003};
1004
1005/**
rgindac9bc5502012-01-18 11:48:44 -08001006 * Deal with terminal width changes.
1007 *
1008 * This function does what needs to be done when the terminal width changes
1009 * out from under us. It happens here rather than in onResize_() because this
1010 * code may need to run synchronously to handle programmatic changes of
1011 * terminal width.
1012 *
1013 * Relying on the browser to send us an async resize event means we may not be
1014 * in the correct state yet when the next escape sequence hits.
Evan Jones2600d4f2016-12-06 09:29:36 -05001015 *
1016 * @param {number} columnCount The number of columns.
rgindac9bc5502012-01-18 11:48:44 -08001017 */
1018hterm.Terminal.prototype.realizeWidth_ = function(columnCount) {
Robert Ginda4e83f3a2012-09-04 15:25:25 -07001019 if (columnCount <= 0)
1020 throw new Error('Attempt to realize bad width: ' + columnCount);
1021
rgindac9bc5502012-01-18 11:48:44 -08001022 var deltaColumns = columnCount - this.screen_.getWidth();
1023
rginda87b86462011-12-14 13:48:03 -08001024 this.screenSize.width = columnCount;
1025 this.screen_.setColumnCount(columnCount);
rgindac9bc5502012-01-18 11:48:44 -08001026
1027 if (deltaColumns > 0) {
David Benjamin66e954d2012-05-05 21:08:12 -04001028 if (this.defaultTabStops)
1029 this.setDefaultTabStops(this.screenSize.width - deltaColumns);
rgindac9bc5502012-01-18 11:48:44 -08001030 } else {
1031 for (var i = this.tabStops_.length - 1; i >= 0; i--) {
David Benjamin66e954d2012-05-05 21:08:12 -04001032 if (this.tabStops_[i] < columnCount)
rgindac9bc5502012-01-18 11:48:44 -08001033 break;
1034
1035 this.tabStops_.pop();
1036 }
1037 }
1038
1039 this.screen_.setColumnCount(this.screenSize.width);
1040};
1041
1042/**
1043 * Deal with terminal height changes.
1044 *
1045 * This function does what needs to be done when the terminal height changes
1046 * out from under us. It happens here rather than in onResize_() because this
1047 * code may need to run synchronously to handle programmatic changes of
1048 * terminal height.
1049 *
1050 * Relying on the browser to send us an async resize event means we may not be
1051 * in the correct state yet when the next escape sequence hits.
Evan Jones2600d4f2016-12-06 09:29:36 -05001052 *
1053 * @param {number} rowCount The number of rows.
rgindac9bc5502012-01-18 11:48:44 -08001054 */
1055hterm.Terminal.prototype.realizeHeight_ = function(rowCount) {
Robert Ginda4e83f3a2012-09-04 15:25:25 -07001056 if (rowCount <= 0)
1057 throw new Error('Attempt to realize bad height: ' + rowCount);
1058
rgindac9bc5502012-01-18 11:48:44 -08001059 var deltaRows = rowCount - this.screen_.getHeight();
1060
1061 this.screenSize.height = rowCount;
1062
1063 var cursor = this.saveCursor();
1064
1065 if (deltaRows < 0) {
1066 // Screen got smaller.
1067 deltaRows *= -1;
1068 while (deltaRows) {
1069 var lastRow = this.getRowCount() - 1;
1070 if (lastRow - this.scrollbackRows_.length == cursor.row)
1071 break;
1072
1073 if (this.getRowText(lastRow))
1074 break;
1075
1076 this.screen_.popRow();
1077 deltaRows--;
1078 }
1079
1080 var ary = this.screen_.shiftRows(deltaRows);
1081 this.scrollbackRows_.push.apply(this.scrollbackRows_, ary);
1082
1083 // We just removed rows from the top of the screen, we need to update
1084 // the cursor to match.
rginda35c456b2012-02-09 17:29:05 -08001085 cursor.row = Math.max(cursor.row - deltaRows, 0);
rgindac9bc5502012-01-18 11:48:44 -08001086 } else if (deltaRows > 0) {
1087 // Screen got larger.
1088
1089 if (deltaRows <= this.scrollbackRows_.length) {
1090 var scrollbackCount = Math.min(deltaRows, this.scrollbackRows_.length);
1091 var rows = this.scrollbackRows_.splice(
1092 this.scrollbackRows_.length - scrollbackCount, scrollbackCount);
1093 this.screen_.unshiftRows(rows);
1094 deltaRows -= scrollbackCount;
1095 cursor.row += scrollbackCount;
1096 }
1097
1098 if (deltaRows)
1099 this.appendRows_(deltaRows);
1100 }
1101
rginda35c456b2012-02-09 17:29:05 -08001102 this.setVTScrollRegion(null, null);
rgindac9bc5502012-01-18 11:48:44 -08001103 this.restoreCursor(cursor);
rginda87b86462011-12-14 13:48:03 -08001104};
1105
1106/**
1107 * Scroll the terminal to the top of the scrollback buffer.
1108 */
1109hterm.Terminal.prototype.scrollHome = function() {
1110 this.scrollPort_.scrollRowToTop(0);
1111};
1112
1113/**
1114 * Scroll the terminal to the end.
1115 */
1116hterm.Terminal.prototype.scrollEnd = function() {
1117 this.scrollPort_.scrollRowToBottom(this.getRowCount());
1118};
1119
1120/**
1121 * Scroll the terminal one page up (minus one line) relative to the current
1122 * position.
1123 */
1124hterm.Terminal.prototype.scrollPageUp = function() {
1125 var i = this.scrollPort_.getTopRowIndex();
1126 this.scrollPort_.scrollRowToTop(i - this.screenSize.height + 1);
1127};
1128
1129/**
1130 * Scroll the terminal one page down (minus one line) relative to the current
1131 * position.
1132 */
1133hterm.Terminal.prototype.scrollPageDown = function() {
1134 var i = this.scrollPort_.getTopRowIndex();
1135 this.scrollPort_.scrollRowToTop(i + this.screenSize.height - 1);
rginda8ba33642011-12-14 12:31:31 -08001136};
1137
rgindac9bc5502012-01-18 11:48:44 -08001138/**
Mike Frysingercd56a632017-05-10 14:45:28 -04001139 * Scroll the terminal one line up relative to the current position.
1140 */
1141hterm.Terminal.prototype.scrollLineUp = function() {
1142 var i = this.scrollPort_.getTopRowIndex();
1143 this.scrollPort_.scrollRowToTop(i - 1);
1144};
1145
1146/**
1147 * Scroll the terminal one line down relative to the current position.
1148 */
1149hterm.Terminal.prototype.scrollLineDown = function() {
1150 var i = this.scrollPort_.getTopRowIndex();
1151 this.scrollPort_.scrollRowToTop(i + 1);
1152};
1153
1154/**
Robert Ginda40932892012-12-10 17:26:40 -08001155 * Clear primary screen, secondary screen, and the scrollback buffer.
1156 */
1157hterm.Terminal.prototype.wipeContents = function() {
1158 this.scrollbackRows_.length = 0;
1159 this.scrollPort_.resetCache();
1160
1161 [this.primaryScreen_, this.alternateScreen_].forEach(function(screen) {
1162 var bottom = screen.getHeight();
1163 if (bottom > 0) {
1164 this.renumberRows_(0, bottom);
1165 this.clearHome(screen);
1166 }
1167 }.bind(this));
1168
1169 this.syncCursorPosition_();
Andrew de los Reyes68e07802013-04-04 15:38:55 -07001170 this.scrollPort_.invalidate();
Robert Ginda40932892012-12-10 17:26:40 -08001171};
1172
1173/**
rgindac9bc5502012-01-18 11:48:44 -08001174 * Full terminal reset.
1175 */
rginda87b86462011-12-14 13:48:03 -08001176hterm.Terminal.prototype.reset = function() {
rgindac9bc5502012-01-18 11:48:44 -08001177 this.clearAllTabStops();
1178 this.setDefaultTabStops();
rginda9ea433c2012-03-16 11:57:00 -07001179
1180 this.clearHome(this.primaryScreen_);
1181 this.primaryScreen_.textAttributes.reset();
1182
1183 this.clearHome(this.alternateScreen_);
1184 this.alternateScreen_.textAttributes.reset();
1185
rgindab8bc8932012-04-27 12:45:03 -07001186 this.setCursorBlink(!!this.prefs_.get('cursor-blink'));
1187
Robert Ginda92e18102013-03-14 13:56:37 -07001188 this.vt.reset();
1189
rgindac9bc5502012-01-18 11:48:44 -08001190 this.softReset();
rginda87b86462011-12-14 13:48:03 -08001191};
1192
rgindac9bc5502012-01-18 11:48:44 -08001193/**
1194 * Soft terminal reset.
rgindab8bc8932012-04-27 12:45:03 -07001195 *
1196 * Perform a soft reset to the default values listed in
1197 * http://www.vt100.net/docs/vt510-rm/DECSTR#T5-9
rgindac9bc5502012-01-18 11:48:44 -08001198 */
rginda0f5c0292012-01-13 11:00:13 -08001199hterm.Terminal.prototype.softReset = function() {
rgindab8bc8932012-04-27 12:45:03 -07001200 // Reset terminal options to their default values.
rgindac9bc5502012-01-18 11:48:44 -08001201 this.options_ = new hterm.Options();
rgindaf522ce02012-04-17 17:49:17 -07001202
Brad Townb62dfdc2015-03-16 19:07:15 -07001203 // We show the cursor on soft reset but do not alter the blink state.
1204 this.options_.cursorBlink = !!this.timeouts_.cursorBlink;
1205
rgindab8bc8932012-04-27 12:45:03 -07001206 // Xterm also resets the color palette on soft reset, even though it doesn't
1207 // seem to be documented anywhere.
rgindaf522ce02012-04-17 17:49:17 -07001208 this.primaryScreen_.textAttributes.resetColorPalette();
1209 this.alternateScreen_.textAttributes.resetColorPalette();
1210
rgindab8bc8932012-04-27 12:45:03 -07001211 // The xterm man page explicitly says this will happen on soft reset.
1212 this.setVTScrollRegion(null, null);
1213
1214 // Xterm also shows the cursor on soft reset, but does not alter the blink
1215 // state.
rgindaa19afe22012-01-25 15:40:22 -08001216 this.setCursorVisible(true);
rginda0f5c0292012-01-13 11:00:13 -08001217};
1218
rgindac9bc5502012-01-18 11:48:44 -08001219/**
1220 * Move the cursor forward to the next tab stop, or to the last column
1221 * if no more tab stops are set.
1222 */
1223hterm.Terminal.prototype.forwardTabStop = function() {
1224 var column = this.screen_.cursorPosition.column;
1225
1226 for (var i = 0; i < this.tabStops_.length; i++) {
1227 if (this.tabStops_[i] > column) {
1228 this.setCursorColumn(this.tabStops_[i]);
1229 return;
1230 }
1231 }
1232
David Benjamin66e954d2012-05-05 21:08:12 -04001233 // xterm does not clear the overflow flag on HT or CHT.
1234 var overflow = this.screen_.cursorPosition.overflow;
rgindac9bc5502012-01-18 11:48:44 -08001235 this.setCursorColumn(this.screenSize.width - 1);
David Benjamin66e954d2012-05-05 21:08:12 -04001236 this.screen_.cursorPosition.overflow = overflow;
rginda0f5c0292012-01-13 11:00:13 -08001237};
1238
rgindac9bc5502012-01-18 11:48:44 -08001239/**
1240 * Move the cursor backward to the previous tab stop, or to the first column
1241 * if no previous tab stops are set.
1242 */
1243hterm.Terminal.prototype.backwardTabStop = function() {
1244 var column = this.screen_.cursorPosition.column;
1245
1246 for (var i = this.tabStops_.length - 1; i >= 0; i--) {
1247 if (this.tabStops_[i] < column) {
1248 this.setCursorColumn(this.tabStops_[i]);
1249 return;
1250 }
1251 }
1252
1253 this.setCursorColumn(1);
rginda0f5c0292012-01-13 11:00:13 -08001254};
1255
rgindac9bc5502012-01-18 11:48:44 -08001256/**
1257 * Set a tab stop at the given column.
1258 *
Evan Jones2600d4f2016-12-06 09:29:36 -05001259 * @param {integer} column Zero based column.
rgindac9bc5502012-01-18 11:48:44 -08001260 */
1261hterm.Terminal.prototype.setTabStop = function(column) {
1262 for (var i = this.tabStops_.length - 1; i >= 0; i--) {
1263 if (this.tabStops_[i] == column)
1264 return;
1265
1266 if (this.tabStops_[i] < column) {
1267 this.tabStops_.splice(i + 1, 0, column);
1268 return;
1269 }
1270 }
1271
1272 this.tabStops_.splice(0, 0, column);
rginda87b86462011-12-14 13:48:03 -08001273};
1274
rgindac9bc5502012-01-18 11:48:44 -08001275/**
1276 * Clear the tab stop at the current cursor position.
1277 *
1278 * No effect if there is no tab stop at the current cursor position.
1279 */
1280hterm.Terminal.prototype.clearTabStopAtCursor = function() {
1281 var column = this.screen_.cursorPosition.column;
1282
1283 var i = this.tabStops_.indexOf(column);
1284 if (i == -1)
1285 return;
1286
1287 this.tabStops_.splice(i, 1);
1288};
1289
1290/**
1291 * Clear all tab stops.
1292 */
1293hterm.Terminal.prototype.clearAllTabStops = function() {
1294 this.tabStops_.length = 0;
David Benjamin66e954d2012-05-05 21:08:12 -04001295 this.defaultTabStops = false;
rgindac9bc5502012-01-18 11:48:44 -08001296};
1297
1298/**
1299 * Set up the default tab stops, starting from a given column.
1300 *
1301 * This sets a tabstop every (column % this.tabWidth) column, starting
David Benjamin66e954d2012-05-05 21:08:12 -04001302 * from the specified column, or 0 if no column is provided. It also flags
1303 * future resizes to set them up.
rgindac9bc5502012-01-18 11:48:44 -08001304 *
1305 * This does not clear the existing tab stops first, use clearAllTabStops
1306 * for that.
1307 *
Evan Jones2600d4f2016-12-06 09:29:36 -05001308 * @param {integer} opt_start Optional starting zero based starting column, useful
rgindac9bc5502012-01-18 11:48:44 -08001309 * for filling out missing tab stops when the terminal is resized.
1310 */
1311hterm.Terminal.prototype.setDefaultTabStops = function(opt_start) {
1312 var start = opt_start || 0;
1313 var w = this.tabWidth;
David Benjamin66e954d2012-05-05 21:08:12 -04001314 // Round start up to a default tab stop.
1315 start = start - 1 - ((start - 1) % w) + w;
1316 for (var i = start; i < this.screenSize.width; i += w) {
1317 this.setTabStop(i);
rgindac9bc5502012-01-18 11:48:44 -08001318 }
David Benjamin66e954d2012-05-05 21:08:12 -04001319
1320 this.defaultTabStops = true;
rginda87b86462011-12-14 13:48:03 -08001321};
1322
rginda6d397402012-01-17 10:58:29 -08001323/**
rginda8ba33642011-12-14 12:31:31 -08001324 * Interpret a sequence of characters.
1325 *
1326 * Incomplete escape sequences are buffered until the next call.
1327 *
1328 * @param {string} str Sequence of characters to interpret or pass through.
1329 */
1330hterm.Terminal.prototype.interpret = function(str) {
rginda0f5c0292012-01-13 11:00:13 -08001331 this.vt.interpret(str);
rginda8ba33642011-12-14 12:31:31 -08001332 this.scheduleSyncCursorPosition_();
1333};
1334
1335/**
1336 * Take over the given DIV for use as the terminal display.
1337 *
1338 * @param {HTMLDivElement} div The div to use as the terminal display.
1339 */
1340hterm.Terminal.prototype.decorate = function(div) {
rginda87b86462011-12-14 13:48:03 -08001341 this.div_ = div;
1342
rginda8ba33642011-12-14 12:31:31 -08001343 this.scrollPort_.decorate(div);
rginda30f20f62012-04-05 16:36:19 -07001344 this.scrollPort_.setBackgroundImage(this.prefs_.get('background-image'));
Philip Douglass959b49d2012-05-30 13:29:29 -04001345 this.scrollPort_.setBackgroundSize(this.prefs_.get('background-size'));
1346 this.scrollPort_.setBackgroundPosition(
1347 this.prefs_.get('background-position'));
Mike Frysinger08bad432017-04-24 00:50:54 -04001348 this.scrollPort_.setUserCssUrl(this.prefs_.get('user-css'));
1349 this.scrollPort_.setUserCssText(this.prefs_.get('user-css-text'));
rginda30f20f62012-04-05 16:36:19 -07001350
rginda0918b652012-04-04 11:26:24 -07001351 this.div_.focus = this.focus.bind(this);
rgindaf7521392012-02-28 17:20:34 -08001352
rginda9f5222b2012-03-05 11:53:28 -08001353 this.setFontSize(this.prefs_.get('font-size'));
1354 this.syncFontFamily();
rgindaa19afe22012-01-25 15:40:22 -08001355
David Reveman8f552492012-03-28 12:18:41 -04001356 this.setScrollbarVisible(this.prefs_.get('scrollbar-visible'));
Rob Spies49039e52014-12-17 13:40:04 -08001357 this.setScrollWheelMoveMultipler(
1358 this.prefs_.get('scroll-wheel-move-multiplier'));
David Reveman8f552492012-03-28 12:18:41 -04001359
rginda8ba33642011-12-14 12:31:31 -08001360 this.document_ = this.scrollPort_.getDocument();
1361
Evan Jones5f9df812016-12-06 09:38:58 -05001362 this.document_.body.oncontextmenu = function() { return false; };
rginda4bba5e12012-06-20 16:15:30 -07001363
1364 var onMouse = this.onMouse_.bind(this);
Toni Barzic0bfa8922013-11-22 11:18:35 -08001365 var screenNode = this.scrollPort_.getScreenNode();
1366 screenNode.addEventListener('mousedown', onMouse);
1367 screenNode.addEventListener('mouseup', onMouse);
1368 screenNode.addEventListener('mousemove', onMouse);
rginda4bba5e12012-06-20 16:15:30 -07001369 this.scrollPort_.onScrollWheel = onMouse;
1370
Toni Barzic0bfa8922013-11-22 11:18:35 -08001371 screenNode.addEventListener(
rginda8e92a692012-05-20 19:37:20 -07001372 'focus', this.onFocusChange_.bind(this, true));
Rob Spies06533ba2014-04-24 11:20:37 -07001373 // Listen for mousedown events on the screenNode as in FF the focus
1374 // events don't bubble.
1375 screenNode.addEventListener('mousedown', function() {
1376 setTimeout(this.onFocusChange_.bind(this, true));
1377 }.bind(this));
1378
Toni Barzic0bfa8922013-11-22 11:18:35 -08001379 screenNode.addEventListener(
rginda8e92a692012-05-20 19:37:20 -07001380 'blur', this.onFocusChange_.bind(this, false));
1381
1382 var style = this.document_.createElement('style');
1383 style.textContent =
1384 ('.cursor-node[focus="false"] {' +
1385 ' box-sizing: border-box;' +
1386 ' background-color: transparent !important;' +
1387 ' border-width: 2px;' +
1388 ' border-style: solid;' +
Ricky Liang48f05cb2013-12-31 23:35:29 +08001389 '}' +
1390 '.wc-node {' +
1391 ' display: inline-block;' +
1392 ' text-align: center;' +
Mike Frysinger66beb0b2017-05-30 19:44:51 -04001393 ' width: calc(var(--hterm-charsize-width) * 2);' +
Mike Frysinger4036f6e2017-05-31 14:02:55 -04001394 ' line-height: var(--hterm-charsize-height);' +
Mike Frysinger93b75ba2017-04-05 19:43:18 -04001395 '}' +
1396 ':root {' +
Mike Frysinger66beb0b2017-05-30 19:44:51 -04001397 ' --hterm-charsize-width: ' + this.scrollPort_.characterSize.width + 'px;' +
1398 ' --hterm-charsize-height: ' + this.scrollPort_.characterSize.height + 'px;' +
Mike Frysinger93b75ba2017-04-05 19:43:18 -04001399 ' --hterm-blink-node-duration: 0.7s;' +
Mike Frysinger6ab275c2017-05-28 12:48:44 -04001400 ' --hterm-mouse-cursor-text: text;' +
1401 ' --hterm-mouse-cursor-pointer: default;' +
1402 ' --hterm-mouse-cursor-style: var(--hterm-mouse-cursor-text);' +
Mike Frysinger93b75ba2017-04-05 19:43:18 -04001403 '}' +
1404 '@keyframes blink {' +
1405 ' from { opacity: 1.0; }' +
1406 ' to { opacity: 0.0; }' +
1407 '}' +
1408 '.blink-node {' +
1409 ' animation-name: blink;' +
1410 ' animation-duration: var(--hterm-blink-node-duration);' +
1411 ' animation-iteration-count: infinite;' +
1412 ' animation-timing-function: ease-in-out;' +
1413 ' animation-direction: alternate;' +
rginda8e92a692012-05-20 19:37:20 -07001414 '}');
1415 this.document_.head.appendChild(style);
1416
rginda8ba33642011-12-14 12:31:31 -08001417 this.cursorNode_ = this.document_.createElement('div');
rginda8e92a692012-05-20 19:37:20 -07001418 this.cursorNode_.className = 'cursor-node';
rginda8ba33642011-12-14 12:31:31 -08001419 this.cursorNode_.style.cssText =
1420 ('position: absolute;' +
rginda87b86462011-12-14 13:48:03 -08001421 'top: -99px;' +
1422 'display: block;' +
Mike Frysinger66beb0b2017-05-30 19:44:51 -04001423 'width: var(--hterm-charsize-width);' +
1424 'height: var(--hterm-charsize-height);' +
Rob Spies06533ba2014-04-24 11:20:37 -07001425 '-webkit-transition: opacity, background-color 100ms linear;' +
1426 '-moz-transition: opacity, background-color 100ms linear;');
Robert Gindafb1be6a2013-12-11 11:56:22 -08001427
rginda8e92a692012-05-20 19:37:20 -07001428 this.setCursorColor(this.prefs_.get('cursor-color'));
Robert Gindafb1be6a2013-12-11 11:56:22 -08001429 this.setCursorBlink(!!this.prefs_.get('cursor-blink'));
1430 this.restyleCursor_();
rgindad5613292012-06-19 15:40:37 -07001431
rginda8ba33642011-12-14 12:31:31 -08001432 this.document_.body.appendChild(this.cursorNode_);
1433
rgindad5613292012-06-19 15:40:37 -07001434 // When 'enableMouseDragScroll' is off we reposition this element directly
1435 // under the mouse cursor after a click. This makes Chrome associate
1436 // subsequent mousemove events with the scroll-blocker. Since the
1437 // scroll-blocker is a peer (not a child) of the scrollport, the mousemove
1438 // events do not cause the scrollport to scroll.
1439 //
1440 // It's a hack, but it's the cleanest way I could find.
1441 this.scrollBlockerNode_ = this.document_.createElement('div');
1442 this.scrollBlockerNode_.style.cssText =
1443 ('position: absolute;' +
1444 'top: -99px;' +
1445 'display: block;' +
1446 'width: 10px;' +
1447 'height: 10px;');
1448 this.document_.body.appendChild(this.scrollBlockerNode_);
1449
rgindad5613292012-06-19 15:40:37 -07001450 this.scrollPort_.onScrollWheel = onMouse;
1451 ['mousedown', 'mouseup', 'mousemove', 'click', 'dblclick',
1452 ].forEach(function(event) {
1453 this.scrollBlockerNode_.addEventListener(event, onMouse);
1454 this.cursorNode_.addEventListener(event, onMouse);
1455 this.document_.addEventListener(event, onMouse);
1456 }.bind(this));
1457
1458 this.cursorNode_.addEventListener('mousedown', function() {
1459 setTimeout(this.focus.bind(this));
1460 }.bind(this));
1461
rginda8ba33642011-12-14 12:31:31 -08001462 this.setReverseVideo(false);
rginda87b86462011-12-14 13:48:03 -08001463
rginda87b86462011-12-14 13:48:03 -08001464 this.scrollPort_.focus();
rginda6d397402012-01-17 10:58:29 -08001465 this.scrollPort_.scheduleRedraw();
rginda87b86462011-12-14 13:48:03 -08001466};
1467
rginda0918b652012-04-04 11:26:24 -07001468/**
1469 * Return the HTML document that contains the terminal DOM nodes.
Evan Jones2600d4f2016-12-06 09:29:36 -05001470 *
1471 * @return {HTMLDocument}
rginda0918b652012-04-04 11:26:24 -07001472 */
rginda87b86462011-12-14 13:48:03 -08001473hterm.Terminal.prototype.getDocument = function() {
1474 return this.document_;
rginda8ba33642011-12-14 12:31:31 -08001475};
1476
1477/**
rginda0918b652012-04-04 11:26:24 -07001478 * Focus the terminal.
1479 */
1480hterm.Terminal.prototype.focus = function() {
1481 this.scrollPort_.focus();
1482};
1483
1484/**
rginda8ba33642011-12-14 12:31:31 -08001485 * Return the HTML Element for a given row index.
1486 *
1487 * This is a method from the RowProvider interface. The ScrollPort uses
1488 * it to fetch rows on demand as they are scrolled into view.
1489 *
1490 * TODO(rginda): Consider saving scrollback rows as (HTML source, text content)
1491 * pairs to conserve memory.
1492 *
1493 * @param {integer} index The zero-based row index, measured relative to the
1494 * start of the scrollback buffer. On-screen rows will always have the
Zhu Qunying30d40712017-03-14 16:27:00 -07001495 * largest indices.
rginda8ba33642011-12-14 12:31:31 -08001496 * @return {HTMLElement} The 'x-row' element containing for the requested row.
1497 */
1498hterm.Terminal.prototype.getRowNode = function(index) {
1499 if (index < this.scrollbackRows_.length)
1500 return this.scrollbackRows_[index];
1501
1502 var screenIndex = index - this.scrollbackRows_.length;
1503 return this.screen_.rowsArray[screenIndex];
1504};
1505
1506/**
1507 * Return the text content for a given range of rows.
1508 *
1509 * This is a method from the RowProvider interface. The ScrollPort uses
1510 * it to fetch text content on demand when the user attempts to copy their
1511 * selection to the clipboard.
1512 *
1513 * @param {integer} start The zero-based row index to start from, measured
1514 * relative to the start of the scrollback buffer. On-screen rows will
Zhu Qunying30d40712017-03-14 16:27:00 -07001515 * always have the largest indices.
rginda8ba33642011-12-14 12:31:31 -08001516 * @param {integer} end The zero-based row index to end on, measured
1517 * relative to the start of the scrollback buffer.
1518 * @return {string} A single string containing the text value of the range of
1519 * rows. Lines will be newline delimited, with no trailing newline.
1520 */
1521hterm.Terminal.prototype.getRowsText = function(start, end) {
1522 var ary = [];
1523 for (var i = start; i < end; i++) {
1524 var node = this.getRowNode(i);
1525 ary.push(node.textContent);
rgindaa09e7332012-08-17 12:49:51 -07001526 if (i < end - 1 && !node.getAttribute('line-overflow'))
1527 ary.push('\n');
rginda8ba33642011-12-14 12:31:31 -08001528 }
1529
rgindaa09e7332012-08-17 12:49:51 -07001530 return ary.join('');
rginda8ba33642011-12-14 12:31:31 -08001531};
1532
1533/**
1534 * Return the text content for a given row.
1535 *
1536 * This is a method from the RowProvider interface. The ScrollPort uses
1537 * it to fetch text content on demand when the user attempts to copy their
1538 * selection to the clipboard.
1539 *
1540 * @param {integer} index The zero-based row index to return, measured
1541 * relative to the start of the scrollback buffer. On-screen rows will
Zhu Qunying30d40712017-03-14 16:27:00 -07001542 * always have the largest indices.
rginda8ba33642011-12-14 12:31:31 -08001543 * @return {string} A string containing the text value of the selected row.
1544 */
1545hterm.Terminal.prototype.getRowText = function(index) {
1546 var node = this.getRowNode(index);
rginda87b86462011-12-14 13:48:03 -08001547 return node.textContent;
rginda8ba33642011-12-14 12:31:31 -08001548};
1549
1550/**
1551 * Return the total number of rows in the addressable screen and in the
1552 * scrollback buffer of this terminal.
1553 *
1554 * This is a method from the RowProvider interface. The ScrollPort uses
1555 * it to compute the size of the scrollbar.
1556 *
1557 * @return {integer} The number of rows in this terminal.
1558 */
1559hterm.Terminal.prototype.getRowCount = function() {
1560 return this.scrollbackRows_.length + this.screen_.rowsArray.length;
1561};
1562
1563/**
1564 * Create DOM nodes for new rows and append them to the end of the terminal.
1565 *
1566 * This is the only correct way to add a new DOM node for a row. Notice that
1567 * the new row is appended to the bottom of the list of rows, and does not
1568 * require renumbering (of the rowIndex property) of previous rows.
1569 *
1570 * If you think you want a new blank row somewhere in the middle of the
1571 * terminal, look into moveRows_().
1572 *
1573 * This method does not pay attention to vtScrollTop/Bottom, since you should
1574 * be using moveRows() in cases where they would matter.
1575 *
1576 * The cursor will be positioned at column 0 of the first inserted line.
Evan Jones2600d4f2016-12-06 09:29:36 -05001577 *
1578 * @param {number} count The number of rows to created.
rginda8ba33642011-12-14 12:31:31 -08001579 */
1580hterm.Terminal.prototype.appendRows_ = function(count) {
1581 var cursorRow = this.screen_.rowsArray.length;
1582 var offset = this.scrollbackRows_.length + cursorRow;
1583 for (var i = 0; i < count; i++) {
1584 var row = this.document_.createElement('x-row');
1585 row.appendChild(this.document_.createTextNode(''));
1586 row.rowIndex = offset + i;
1587 this.screen_.pushRow(row);
1588 }
1589
1590 var extraRows = this.screen_.rowsArray.length - this.screenSize.height;
1591 if (extraRows > 0) {
1592 var ary = this.screen_.shiftRows(extraRows);
1593 Array.prototype.push.apply(this.scrollbackRows_, ary);
Robert Ginda36c5aa62012-10-15 11:17:47 -07001594 if (this.scrollPort_.isScrolledEnd)
1595 this.scheduleScrollDown_();
rginda8ba33642011-12-14 12:31:31 -08001596 }
1597
1598 if (cursorRow >= this.screen_.rowsArray.length)
1599 cursorRow = this.screen_.rowsArray.length - 1;
1600
rginda87b86462011-12-14 13:48:03 -08001601 this.setAbsoluteCursorPosition(cursorRow, 0);
rginda8ba33642011-12-14 12:31:31 -08001602};
1603
1604/**
1605 * Relocate rows from one part of the addressable screen to another.
1606 *
1607 * This is used to recycle rows during VT scrolls (those which are driven
1608 * by VT commands, rather than by the user manipulating the scrollbar.)
1609 *
1610 * In this case, the blank lines scrolled into the scroll region are made of
1611 * the nodes we scrolled off. These have their rowIndex properties carefully
1612 * renumbered so as not to confuse the ScrollPort.
Evan Jones2600d4f2016-12-06 09:29:36 -05001613 *
1614 * @param {number} fromIndex The start index.
1615 * @param {number} count The number of rows to move.
1616 * @param {number} toIndex The destination index.
rginda8ba33642011-12-14 12:31:31 -08001617 */
1618hterm.Terminal.prototype.moveRows_ = function(fromIndex, count, toIndex) {
1619 var ary = this.screen_.removeRows(fromIndex, count);
1620 this.screen_.insertRows(toIndex, ary);
1621
1622 var start, end;
1623 if (fromIndex < toIndex) {
1624 start = fromIndex;
rginda87b86462011-12-14 13:48:03 -08001625 end = toIndex + count;
rginda8ba33642011-12-14 12:31:31 -08001626 } else {
1627 start = toIndex;
rginda87b86462011-12-14 13:48:03 -08001628 end = fromIndex + count;
rginda8ba33642011-12-14 12:31:31 -08001629 }
1630
1631 this.renumberRows_(start, end);
rginda2312fff2012-01-05 16:20:52 -08001632 this.scrollPort_.scheduleInvalidate();
rginda8ba33642011-12-14 12:31:31 -08001633};
1634
1635/**
1636 * Renumber the rowIndex property of the given range of rows.
1637 *
Zhu Qunying30d40712017-03-14 16:27:00 -07001638 * The start and end indices are relative to the screen, not the scrollback.
rginda8ba33642011-12-14 12:31:31 -08001639 * Rows in the scrollback buffer cannot be renumbered. Since they are not
rginda2312fff2012-01-05 16:20:52 -08001640 * addressable (you can't delete them, scroll them, etc), you should have
rginda8ba33642011-12-14 12:31:31 -08001641 * no need to renumber scrollback rows.
Evan Jones2600d4f2016-12-06 09:29:36 -05001642 *
1643 * @param {number} start The start index.
1644 * @param {number} end The end index.
1645 * @param {hterm.Screen} opt_screen The screen to renumber.
rginda8ba33642011-12-14 12:31:31 -08001646 */
Robert Ginda40932892012-12-10 17:26:40 -08001647hterm.Terminal.prototype.renumberRows_ = function(start, end, opt_screen) {
1648 var screen = opt_screen || this.screen_;
1649
rginda8ba33642011-12-14 12:31:31 -08001650 var offset = this.scrollbackRows_.length;
1651 for (var i = start; i < end; i++) {
Robert Ginda40932892012-12-10 17:26:40 -08001652 screen.rowsArray[i].rowIndex = offset + i;
rginda8ba33642011-12-14 12:31:31 -08001653 }
1654};
1655
1656/**
1657 * Print a string to the terminal.
1658 *
1659 * This respects the current insert and wraparound modes. It will add new lines
1660 * to the end of the terminal, scrolling off the top into the scrollback buffer
1661 * if necessary.
1662 *
1663 * The string is *not* parsed for escape codes. Use the interpret() method if
1664 * that's what you're after.
1665 *
1666 * @param{string} str The string to print.
1667 */
1668hterm.Terminal.prototype.print = function(str) {
rgindaa9abdd82012-08-06 18:05:09 -07001669 var startOffset = 0;
rginda2312fff2012-01-05 16:20:52 -08001670
Ricky Liang48f05cb2013-12-31 23:35:29 +08001671 var strWidth = lib.wc.strWidth(str);
1672
1673 while (startOffset < strWidth) {
rgindaa09e7332012-08-17 12:49:51 -07001674 if (this.options_.wraparound && this.screen_.cursorPosition.overflow) {
1675 this.screen_.commitLineOverflow();
rginda35c456b2012-02-09 17:29:05 -08001676 this.newLine();
rgindaa09e7332012-08-17 12:49:51 -07001677 }
rgindaa19afe22012-01-25 15:40:22 -08001678
Ricky Liang48f05cb2013-12-31 23:35:29 +08001679 var count = strWidth - startOffset;
rgindaa9abdd82012-08-06 18:05:09 -07001680 var didOverflow = false;
1681 var substr;
rgindaa19afe22012-01-25 15:40:22 -08001682
rgindaa9abdd82012-08-06 18:05:09 -07001683 if (this.screen_.cursorPosition.column + count >= this.screenSize.width) {
1684 didOverflow = true;
1685 count = this.screenSize.width - this.screen_.cursorPosition.column;
1686 }
rgindaa19afe22012-01-25 15:40:22 -08001687
rgindaa9abdd82012-08-06 18:05:09 -07001688 if (didOverflow && !this.options_.wraparound) {
1689 // If the string overflowed the line but wraparound is off, then the
1690 // last printed character should be the last of the string.
1691 // TODO: This will add to our problems with multibyte UTF-16 characters.
Ricky Liang48f05cb2013-12-31 23:35:29 +08001692 substr = lib.wc.substr(str, startOffset, count - 1) +
1693 lib.wc.substr(str, strWidth - 1);
1694 count = strWidth;
rgindaa9abdd82012-08-06 18:05:09 -07001695 } else {
Ricky Liang48f05cb2013-12-31 23:35:29 +08001696 substr = lib.wc.substr(str, startOffset, count);
rgindaa9abdd82012-08-06 18:05:09 -07001697 }
rgindaa19afe22012-01-25 15:40:22 -08001698
Ricky Liang48f05cb2013-12-31 23:35:29 +08001699 var tokens = hterm.TextAttributes.splitWidecharString(substr);
1700 for (var i = 0; i < tokens.length; i++) {
1701 if (tokens[i].wcNode)
1702 this.screen_.textAttributes.wcNode = true;
1703
1704 if (this.options_.insertMode) {
1705 this.screen_.insertString(tokens[i].str);
1706 } else {
1707 this.screen_.overwriteString(tokens[i].str);
1708 }
1709 this.screen_.textAttributes.wcNode = false;
rgindaa9abdd82012-08-06 18:05:09 -07001710 }
1711
1712 this.screen_.maybeClipCurrentRow();
1713 startOffset += count;
rgindaa19afe22012-01-25 15:40:22 -08001714 }
rginda8ba33642011-12-14 12:31:31 -08001715
1716 this.scheduleSyncCursorPosition_();
rginda0f5c0292012-01-13 11:00:13 -08001717
rginda9f5222b2012-03-05 11:53:28 -08001718 if (this.scrollOnOutput_)
rginda0f5c0292012-01-13 11:00:13 -08001719 this.scrollPort_.scrollRowToBottom(this.getRowCount());
rginda8ba33642011-12-14 12:31:31 -08001720};
1721
1722/**
rginda87b86462011-12-14 13:48:03 -08001723 * Set the VT scroll region.
1724 *
rginda87b86462011-12-14 13:48:03 -08001725 * This also resets the cursor position to the absolute (0, 0) position, since
1726 * that's what xterm appears to do.
1727 *
Robert Ginda5b9fbe62013-10-30 14:05:53 -07001728 * Setting the scroll region to the full height of the terminal will clear
1729 * the scroll region. This is *NOT* what most terminals do. We're explicitly
1730 * going "off-spec" here because it makes `screen` and `tmux` overflow into the
1731 * local scrollback buffer, which means the scrollbars and shift-pgup/pgdn
1732 * continue to work as most users would expect.
1733 *
rginda87b86462011-12-14 13:48:03 -08001734 * @param {integer} scrollTop The zero-based top of the scroll region.
1735 * @param {integer} scrollBottom The zero-based bottom of the scroll region,
1736 * inclusive.
1737 */
1738hterm.Terminal.prototype.setVTScrollRegion = function(scrollTop, scrollBottom) {
Robert Ginda5b9fbe62013-10-30 14:05:53 -07001739 if (scrollTop == 0 && scrollBottom == this.screenSize.height - 1) {
Robert Ginda43684e22013-11-25 14:18:52 -08001740 this.vtScrollTop_ = null;
1741 this.vtScrollBottom_ = null;
Robert Ginda5b9fbe62013-10-30 14:05:53 -07001742 } else {
1743 this.vtScrollTop_ = scrollTop;
1744 this.vtScrollBottom_ = scrollBottom;
1745 }
rginda87b86462011-12-14 13:48:03 -08001746};
1747
1748/**
rginda8ba33642011-12-14 12:31:31 -08001749 * Return the top row index according to the VT.
1750 *
1751 * This will return 0 unless the terminal has been told to restrict scrolling
1752 * to some lower row. It is used for some VT cursor positioning and scrolling
1753 * commands.
1754 *
1755 * @return {integer} The topmost row in the terminal's scroll region.
1756 */
1757hterm.Terminal.prototype.getVTScrollTop = function() {
1758 if (this.vtScrollTop_ != null)
1759 return this.vtScrollTop_;
1760
1761 return 0;
rginda87b86462011-12-14 13:48:03 -08001762};
rginda8ba33642011-12-14 12:31:31 -08001763
1764/**
1765 * Return the bottom row index according to the VT.
1766 *
1767 * This will return the height of the terminal unless the it has been told to
1768 * restrict scrolling to some higher row. It is used for some VT cursor
1769 * positioning and scrolling commands.
1770 *
Zhu Qunying30d40712017-03-14 16:27:00 -07001771 * @return {integer} The bottom most row in the terminal's scroll region.
rginda8ba33642011-12-14 12:31:31 -08001772 */
1773hterm.Terminal.prototype.getVTScrollBottom = function() {
1774 if (this.vtScrollBottom_ != null)
1775 return this.vtScrollBottom_;
1776
rginda87b86462011-12-14 13:48:03 -08001777 return this.screenSize.height - 1;
rginda8ba33642011-12-14 12:31:31 -08001778}
1779
1780/**
1781 * Process a '\n' character.
1782 *
1783 * If the cursor is on the final row of the terminal this will append a new
1784 * blank row to the screen and scroll the topmost row into the scrollback
1785 * buffer.
1786 *
1787 * Otherwise, this moves the cursor to column zero of the next row.
1788 */
1789hterm.Terminal.prototype.newLine = function() {
Robert Ginda9937abc2013-07-25 16:09:23 -07001790 var cursorAtEndOfScreen = (this.screen_.cursorPosition.row ==
1791 this.screen_.rowsArray.length - 1);
1792
1793 if (this.vtScrollBottom_ != null) {
1794 // A VT Scroll region is active, we never append new rows.
1795 if (this.screen_.cursorPosition.row == this.vtScrollBottom_) {
1796 // We're at the end of the VT Scroll Region, perform a VT scroll.
1797 this.vtScrollUp(1);
1798 this.setAbsoluteCursorPosition(this.screen_.cursorPosition.row, 0);
1799 } else if (cursorAtEndOfScreen) {
1800 // We're at the end of the screen, the only thing to do is put the
1801 // cursor to column 0.
1802 this.setAbsoluteCursorPosition(this.screen_.cursorPosition.row, 0);
1803 } else {
1804 // Anywhere else, advance the cursor row, and reset the column.
1805 this.setAbsoluteCursorPosition(this.screen_.cursorPosition.row + 1, 0);
1806 }
1807 } else if (cursorAtEndOfScreen) {
Robert Ginda1b06b372013-07-19 15:22:51 -07001808 // We're at the end of the screen. Append a new row to the terminal,
1809 // shifting the top row into the scrollback.
1810 this.appendRows_(1);
rginda8ba33642011-12-14 12:31:31 -08001811 } else {
rginda87b86462011-12-14 13:48:03 -08001812 // Anywhere else in the screen just moves the cursor.
1813 this.setAbsoluteCursorPosition(this.screen_.cursorPosition.row + 1, 0);
rginda8ba33642011-12-14 12:31:31 -08001814 }
1815};
1816
1817/**
1818 * Like newLine(), except maintain the cursor column.
1819 */
1820hterm.Terminal.prototype.lineFeed = function() {
1821 var column = this.screen_.cursorPosition.column;
1822 this.newLine();
1823 this.setCursorColumn(column);
1824};
1825
1826/**
rginda87b86462011-12-14 13:48:03 -08001827 * If autoCarriageReturn is set then newLine(), else lineFeed().
1828 */
1829hterm.Terminal.prototype.formFeed = function() {
1830 if (this.options_.autoCarriageReturn) {
1831 this.newLine();
1832 } else {
1833 this.lineFeed();
1834 }
1835};
1836
1837/**
1838 * Move the cursor up one row, possibly inserting a blank line.
1839 *
1840 * The cursor column is not changed.
1841 */
1842hterm.Terminal.prototype.reverseLineFeed = function() {
1843 var scrollTop = this.getVTScrollTop();
1844 var currentRow = this.screen_.cursorPosition.row;
1845
1846 if (currentRow == scrollTop) {
1847 this.insertLines(1);
1848 } else {
1849 this.setAbsoluteCursorRow(currentRow - 1);
1850 }
1851};
1852
1853/**
rginda8ba33642011-12-14 12:31:31 -08001854 * Replace all characters to the left of the current cursor with the space
1855 * character.
1856 *
1857 * TODO(rginda): This should probably *remove* the characters (not just replace
1858 * with a space) if there are no characters at or beyond the current cursor
Robert Gindaf2547f12012-10-25 20:36:21 -07001859 * position.
rginda8ba33642011-12-14 12:31:31 -08001860 */
1861hterm.Terminal.prototype.eraseToLeft = function() {
rginda87b86462011-12-14 13:48:03 -08001862 var cursor = this.saveCursor();
rginda8ba33642011-12-14 12:31:31 -08001863 this.setCursorColumn(0);
rgindacbbd7482012-06-13 15:06:16 -07001864 this.screen_.overwriteString(lib.f.getWhitespace(cursor.column + 1));
rginda87b86462011-12-14 13:48:03 -08001865 this.restoreCursor(cursor);
rginda8ba33642011-12-14 12:31:31 -08001866};
1867
1868/**
David Benjamin684a9b72012-05-01 17:19:58 -04001869 * Erase a given number of characters to the right of the cursor.
rginda8ba33642011-12-14 12:31:31 -08001870 *
1871 * The cursor position is unchanged.
1872 *
Robert Gindaf2547f12012-10-25 20:36:21 -07001873 * If the current background color is not the default background color this
1874 * will insert spaces rather than delete. This is unfortunate because the
1875 * trailing space will affect text selection, but it's difficult to come up
1876 * with a way to style empty space that wouldn't trip up the hterm.Screen
1877 * code.
Robert Gindacd5637d2013-10-30 14:59:10 -07001878 *
1879 * eraseToRight is ignored in the presence of a cursor overflow. This deviates
1880 * from xterm, but agrees with gnome-terminal and konsole, xfce4-terminal. See
1881 * crbug.com/232390 for details.
Evan Jones2600d4f2016-12-06 09:29:36 -05001882 *
1883 * @param {number} opt_count The number of characters to erase.
rginda8ba33642011-12-14 12:31:31 -08001884 */
1885hterm.Terminal.prototype.eraseToRight = function(opt_count) {
Robert Gindacd5637d2013-10-30 14:59:10 -07001886 if (this.screen_.cursorPosition.overflow)
1887 return;
1888
Robert Ginda7fd57082012-09-25 14:41:47 -07001889 var maxCount = this.screenSize.width - this.screen_.cursorPosition.column;
1890 var count = opt_count ? Math.min(opt_count, maxCount) : maxCount;
Robert Gindaf2547f12012-10-25 20:36:21 -07001891
1892 if (this.screen_.textAttributes.background ===
1893 this.screen_.textAttributes.DEFAULT_COLOR) {
1894 var cursorRow = this.screen_.rowsArray[this.screen_.cursorPosition.row];
Ricky Liang48f05cb2013-12-31 23:35:29 +08001895 if (hterm.TextAttributes.nodeWidth(cursorRow) <=
Robert Gindaf2547f12012-10-25 20:36:21 -07001896 this.screen_.cursorPosition.column + count) {
1897 this.screen_.deleteChars(count);
1898 this.clearCursorOverflow();
1899 return;
1900 }
1901 }
1902
rginda87b86462011-12-14 13:48:03 -08001903 var cursor = this.saveCursor();
Robert Ginda7fd57082012-09-25 14:41:47 -07001904 this.screen_.overwriteString(lib.f.getWhitespace(count));
rginda87b86462011-12-14 13:48:03 -08001905 this.restoreCursor(cursor);
David Benjamin54e8bf62012-06-01 22:31:40 -04001906 this.clearCursorOverflow();
rginda8ba33642011-12-14 12:31:31 -08001907};
1908
1909/**
1910 * Erase the current line.
1911 *
1912 * The cursor position is unchanged.
rginda8ba33642011-12-14 12:31:31 -08001913 */
1914hterm.Terminal.prototype.eraseLine = function() {
rginda87b86462011-12-14 13:48:03 -08001915 var cursor = this.saveCursor();
rginda8ba33642011-12-14 12:31:31 -08001916 this.screen_.clearCursorRow();
rginda87b86462011-12-14 13:48:03 -08001917 this.restoreCursor(cursor);
David Benjamin54e8bf62012-06-01 22:31:40 -04001918 this.clearCursorOverflow();
rginda8ba33642011-12-14 12:31:31 -08001919};
1920
1921/**
David Benjamina08d78f2012-05-05 00:28:49 -04001922 * Erase all characters from the start of the screen to the current cursor
1923 * position, regardless of scroll region.
rginda8ba33642011-12-14 12:31:31 -08001924 *
1925 * The cursor position is unchanged.
rginda8ba33642011-12-14 12:31:31 -08001926 */
1927hterm.Terminal.prototype.eraseAbove = function() {
rginda87b86462011-12-14 13:48:03 -08001928 var cursor = this.saveCursor();
1929
1930 this.eraseToLeft();
rginda8ba33642011-12-14 12:31:31 -08001931
David Benjamina08d78f2012-05-05 00:28:49 -04001932 for (var i = 0; i < cursor.row; i++) {
rginda87b86462011-12-14 13:48:03 -08001933 this.setAbsoluteCursorPosition(i, 0);
rginda8ba33642011-12-14 12:31:31 -08001934 this.screen_.clearCursorRow();
1935 }
1936
rginda87b86462011-12-14 13:48:03 -08001937 this.restoreCursor(cursor);
David Benjamin54e8bf62012-06-01 22:31:40 -04001938 this.clearCursorOverflow();
rginda8ba33642011-12-14 12:31:31 -08001939};
1940
1941/**
1942 * Erase all characters from the current cursor position to the end of the
David Benjamina08d78f2012-05-05 00:28:49 -04001943 * screen, regardless of scroll region.
rginda8ba33642011-12-14 12:31:31 -08001944 *
1945 * The cursor position is unchanged.
rginda8ba33642011-12-14 12:31:31 -08001946 */
1947hterm.Terminal.prototype.eraseBelow = function() {
rginda87b86462011-12-14 13:48:03 -08001948 var cursor = this.saveCursor();
1949
1950 this.eraseToRight();
rginda8ba33642011-12-14 12:31:31 -08001951
David Benjamina08d78f2012-05-05 00:28:49 -04001952 var bottom = this.screenSize.height - 1;
rginda87b86462011-12-14 13:48:03 -08001953 for (var i = cursor.row + 1; i <= bottom; i++) {
1954 this.setAbsoluteCursorPosition(i, 0);
rginda8ba33642011-12-14 12:31:31 -08001955 this.screen_.clearCursorRow();
1956 }
1957
rginda87b86462011-12-14 13:48:03 -08001958 this.restoreCursor(cursor);
David Benjamin54e8bf62012-06-01 22:31:40 -04001959 this.clearCursorOverflow();
rginda87b86462011-12-14 13:48:03 -08001960};
1961
1962/**
1963 * Fill the terminal with a given character.
1964 *
1965 * This methods does not respect the VT scroll region.
1966 *
1967 * @param {string} ch The character to use for the fill.
1968 */
1969hterm.Terminal.prototype.fill = function(ch) {
1970 var cursor = this.saveCursor();
1971
1972 this.setAbsoluteCursorPosition(0, 0);
1973 for (var row = 0; row < this.screenSize.height; row++) {
1974 for (var col = 0; col < this.screenSize.width; col++) {
1975 this.setAbsoluteCursorPosition(row, col);
1976 this.screen_.overwriteString(ch);
1977 }
1978 }
1979
1980 this.restoreCursor(cursor);
rginda8ba33642011-12-14 12:31:31 -08001981};
1982
1983/**
rginda9ea433c2012-03-16 11:57:00 -07001984 * Erase the entire display and leave the cursor at (0, 0).
rginda8ba33642011-12-14 12:31:31 -08001985 *
rginda9ea433c2012-03-16 11:57:00 -07001986 * This does not respect the scroll region.
1987 *
1988 * @param {hterm.Screen} opt_screen Optional screen to operate on. Defaults
1989 * to the current screen.
rginda8ba33642011-12-14 12:31:31 -08001990 */
rginda9ea433c2012-03-16 11:57:00 -07001991hterm.Terminal.prototype.clearHome = function(opt_screen) {
1992 var screen = opt_screen || this.screen_;
1993 var bottom = screen.getHeight();
rginda8ba33642011-12-14 12:31:31 -08001994
rginda11057d52012-04-25 12:29:56 -07001995 if (bottom == 0) {
1996 // Empty screen, nothing to do.
1997 return;
1998 }
1999
rgindae4d29232012-01-19 10:47:13 -08002000 for (var i = 0; i < bottom; i++) {
rginda9ea433c2012-03-16 11:57:00 -07002001 screen.setCursorPosition(i, 0);
2002 screen.clearCursorRow();
rginda8ba33642011-12-14 12:31:31 -08002003 }
2004
rginda9ea433c2012-03-16 11:57:00 -07002005 screen.setCursorPosition(0, 0);
2006};
2007
2008/**
2009 * Erase the entire display without changing the cursor position.
2010 *
2011 * The cursor position is unchanged. This does not respect the scroll
2012 * region.
2013 *
2014 * @param {hterm.Screen} opt_screen Optional screen to operate on. Defaults
2015 * to the current screen.
rginda9ea433c2012-03-16 11:57:00 -07002016 */
2017hterm.Terminal.prototype.clear = function(opt_screen) {
2018 var screen = opt_screen || this.screen_;
2019 var cursor = screen.cursorPosition.clone();
2020 this.clearHome(screen);
2021 screen.setCursorPosition(cursor.row, cursor.column);
rginda8ba33642011-12-14 12:31:31 -08002022};
2023
2024/**
2025 * VT command to insert lines at the current cursor row.
2026 *
2027 * This respects the current scroll region. Rows pushed off the bottom are
2028 * lost (they won't show up in the scrollback buffer).
2029 *
rginda8ba33642011-12-14 12:31:31 -08002030 * @param {integer} count The number of lines to insert.
2031 */
2032hterm.Terminal.prototype.insertLines = function(count) {
Robert Ginda579186b2012-09-26 11:40:04 -07002033 var cursorRow = this.screen_.cursorPosition.row;
rginda8ba33642011-12-14 12:31:31 -08002034
2035 var bottom = this.getVTScrollBottom();
Robert Ginda579186b2012-09-26 11:40:04 -07002036 count = Math.min(count, bottom - cursorRow);
rginda8ba33642011-12-14 12:31:31 -08002037
Robert Ginda579186b2012-09-26 11:40:04 -07002038 // The moveCount is the number of rows we need to relocate to make room for
2039 // the new row(s). The count is the distance to move them.
2040 var moveCount = bottom - cursorRow - count + 1;
2041 if (moveCount)
2042 this.moveRows_(cursorRow, moveCount, cursorRow + count);
rginda8ba33642011-12-14 12:31:31 -08002043
Robert Ginda579186b2012-09-26 11:40:04 -07002044 for (var i = count - 1; i >= 0; i--) {
2045 this.setAbsoluteCursorPosition(cursorRow + i, 0);
rginda8ba33642011-12-14 12:31:31 -08002046 this.screen_.clearCursorRow();
2047 }
rginda8ba33642011-12-14 12:31:31 -08002048};
2049
2050/**
2051 * VT command to delete lines at the current cursor row.
2052 *
2053 * New rows are added to the bottom of scroll region to take their place. New
2054 * rows are strictly there to take up space and have no content or style.
Evan Jones2600d4f2016-12-06 09:29:36 -05002055 *
2056 * @param {number} count The number of lines to delete.
rginda8ba33642011-12-14 12:31:31 -08002057 */
2058hterm.Terminal.prototype.deleteLines = function(count) {
rginda87b86462011-12-14 13:48:03 -08002059 var cursor = this.saveCursor();
rginda8ba33642011-12-14 12:31:31 -08002060
rginda87b86462011-12-14 13:48:03 -08002061 var top = cursor.row;
rginda8ba33642011-12-14 12:31:31 -08002062 var bottom = this.getVTScrollBottom();
2063
rginda87b86462011-12-14 13:48:03 -08002064 var maxCount = bottom - top + 1;
rginda8ba33642011-12-14 12:31:31 -08002065 count = Math.min(count, maxCount);
2066
rginda87b86462011-12-14 13:48:03 -08002067 var moveStart = bottom - count + 1;
rginda8ba33642011-12-14 12:31:31 -08002068 if (count != maxCount)
2069 this.moveRows_(top, count, moveStart);
2070
2071 for (var i = 0; i < count; i++) {
rginda87b86462011-12-14 13:48:03 -08002072 this.setAbsoluteCursorPosition(moveStart + i, 0);
rginda8ba33642011-12-14 12:31:31 -08002073 this.screen_.clearCursorRow();
2074 }
2075
rginda87b86462011-12-14 13:48:03 -08002076 this.restoreCursor(cursor);
David Benjamin54e8bf62012-06-01 22:31:40 -04002077 this.clearCursorOverflow();
rginda8ba33642011-12-14 12:31:31 -08002078};
2079
2080/**
2081 * Inserts the given number of spaces at the current cursor position.
2082 *
rginda87b86462011-12-14 13:48:03 -08002083 * The cursor position is not changed.
Evan Jones2600d4f2016-12-06 09:29:36 -05002084 *
2085 * @param {number} count The number of spaces to insert.
rginda8ba33642011-12-14 12:31:31 -08002086 */
2087hterm.Terminal.prototype.insertSpace = function(count) {
rginda87b86462011-12-14 13:48:03 -08002088 var cursor = this.saveCursor();
2089
rgindacbbd7482012-06-13 15:06:16 -07002090 var ws = lib.f.getWhitespace(count || 1);
rginda8ba33642011-12-14 12:31:31 -08002091 this.screen_.insertString(ws);
rgindaa19afe22012-01-25 15:40:22 -08002092 this.screen_.maybeClipCurrentRow();
rginda87b86462011-12-14 13:48:03 -08002093
2094 this.restoreCursor(cursor);
David Benjamin54e8bf62012-06-01 22:31:40 -04002095 this.clearCursorOverflow();
rginda8ba33642011-12-14 12:31:31 -08002096};
2097
2098/**
2099 * Forward-delete the specified number of characters starting at the cursor
2100 * position.
2101 *
2102 * @param {integer} count The number of characters to delete.
2103 */
2104hterm.Terminal.prototype.deleteChars = function(count) {
Robert Ginda7fd57082012-09-25 14:41:47 -07002105 var deleted = this.screen_.deleteChars(count);
2106 if (deleted && !this.screen_.textAttributes.isDefault()) {
2107 var cursor = this.saveCursor();
2108 this.setCursorColumn(this.screenSize.width - deleted);
2109 this.screen_.insertString(lib.f.getWhitespace(deleted));
2110 this.restoreCursor(cursor);
2111 }
2112
David Benjamin54e8bf62012-06-01 22:31:40 -04002113 this.clearCursorOverflow();
rginda8ba33642011-12-14 12:31:31 -08002114};
2115
2116/**
2117 * Shift rows in the scroll region upwards by a given number of lines.
2118 *
2119 * New rows are inserted at the bottom of the scroll region to fill the
2120 * vacated rows. The new rows not filled out with the current text attributes.
2121 *
2122 * This function does not affect the scrollback rows at all. Rows shifted
2123 * off the top are lost.
2124 *
rginda87b86462011-12-14 13:48:03 -08002125 * The cursor position is not altered.
2126 *
rginda8ba33642011-12-14 12:31:31 -08002127 * @param {integer} count The number of rows to scroll.
2128 */
2129hterm.Terminal.prototype.vtScrollUp = function(count) {
rginda87b86462011-12-14 13:48:03 -08002130 var cursor = this.saveCursor();
rginda8ba33642011-12-14 12:31:31 -08002131
rginda87b86462011-12-14 13:48:03 -08002132 this.setAbsoluteCursorRow(this.getVTScrollTop());
rginda8ba33642011-12-14 12:31:31 -08002133 this.deleteLines(count);
2134
rginda87b86462011-12-14 13:48:03 -08002135 this.restoreCursor(cursor);
rginda8ba33642011-12-14 12:31:31 -08002136};
2137
2138/**
2139 * Shift rows below the cursor down by a given number of lines.
2140 *
2141 * This function respects the current scroll region.
2142 *
2143 * New rows are inserted at the top of the scroll region to fill the
2144 * vacated rows. The new rows not filled out with the current text attributes.
2145 *
2146 * This function does not affect the scrollback rows at all. Rows shifted
2147 * off the bottom are lost.
2148 *
2149 * @param {integer} count The number of rows to scroll.
2150 */
2151hterm.Terminal.prototype.vtScrollDown = function(opt_count) {
rginda87b86462011-12-14 13:48:03 -08002152 var cursor = this.saveCursor();
rginda8ba33642011-12-14 12:31:31 -08002153
rginda87b86462011-12-14 13:48:03 -08002154 this.setAbsoluteCursorPosition(this.getVTScrollTop(), 0);
rginda8ba33642011-12-14 12:31:31 -08002155 this.insertLines(opt_count);
2156
rginda87b86462011-12-14 13:48:03 -08002157 this.restoreCursor(cursor);
rginda8ba33642011-12-14 12:31:31 -08002158};
2159
rginda87b86462011-12-14 13:48:03 -08002160
rginda8ba33642011-12-14 12:31:31 -08002161/**
2162 * Set the cursor position.
2163 *
2164 * The cursor row is relative to the scroll region if the terminal has
2165 * 'origin mode' enabled, or relative to the addressable screen otherwise.
2166 *
2167 * @param {integer} row The new zero-based cursor row.
2168 * @param {integer} row The new zero-based cursor column.
2169 */
2170hterm.Terminal.prototype.setCursorPosition = function(row, column) {
2171 if (this.options_.originMode) {
rginda87b86462011-12-14 13:48:03 -08002172 this.setRelativeCursorPosition(row, column);
rginda8ba33642011-12-14 12:31:31 -08002173 } else {
rginda87b86462011-12-14 13:48:03 -08002174 this.setAbsoluteCursorPosition(row, column);
rginda8ba33642011-12-14 12:31:31 -08002175 }
rginda87b86462011-12-14 13:48:03 -08002176};
rginda8ba33642011-12-14 12:31:31 -08002177
Evan Jones2600d4f2016-12-06 09:29:36 -05002178/**
2179 * Move the cursor relative to its current position.
2180 *
2181 * @param {number} row
2182 * @param {number} column
2183 */
rginda87b86462011-12-14 13:48:03 -08002184hterm.Terminal.prototype.setRelativeCursorPosition = function(row, column) {
2185 var scrollTop = this.getVTScrollTop();
rgindacbbd7482012-06-13 15:06:16 -07002186 row = lib.f.clamp(row + scrollTop, scrollTop, this.getVTScrollBottom());
2187 column = lib.f.clamp(column, 0, this.screenSize.width - 1);
rginda87b86462011-12-14 13:48:03 -08002188 this.screen_.setCursorPosition(row, column);
2189};
2190
Evan Jones2600d4f2016-12-06 09:29:36 -05002191/**
2192 * Move the cursor to the specified position.
2193 *
2194 * @param {number} row
2195 * @param {number} column
2196 */
rginda87b86462011-12-14 13:48:03 -08002197hterm.Terminal.prototype.setAbsoluteCursorPosition = function(row, column) {
rgindacbbd7482012-06-13 15:06:16 -07002198 row = lib.f.clamp(row, 0, this.screenSize.height - 1);
2199 column = lib.f.clamp(column, 0, this.screenSize.width - 1);
rginda8ba33642011-12-14 12:31:31 -08002200 this.screen_.setCursorPosition(row, column);
2201};
2202
2203/**
2204 * Set the cursor column.
2205 *
2206 * @param {integer} column The new zero-based cursor column.
2207 */
2208hterm.Terminal.prototype.setCursorColumn = function(column) {
rginda87b86462011-12-14 13:48:03 -08002209 this.setAbsoluteCursorPosition(this.screen_.cursorPosition.row, column);
rginda8ba33642011-12-14 12:31:31 -08002210};
2211
2212/**
2213 * Return the cursor column.
2214 *
2215 * @return {integer} The zero-based cursor column.
2216 */
2217hterm.Terminal.prototype.getCursorColumn = function() {
2218 return this.screen_.cursorPosition.column;
2219};
2220
2221/**
2222 * Set the cursor row.
2223 *
2224 * The cursor row is relative to the scroll region if the terminal has
2225 * 'origin mode' enabled, or relative to the addressable screen otherwise.
2226 *
2227 * @param {integer} row The new cursor row.
2228 */
rginda87b86462011-12-14 13:48:03 -08002229hterm.Terminal.prototype.setAbsoluteCursorRow = function(row) {
2230 this.setAbsoluteCursorPosition(row, this.screen_.cursorPosition.column);
rginda8ba33642011-12-14 12:31:31 -08002231};
2232
2233/**
2234 * Return the cursor row.
2235 *
2236 * @return {integer} The zero-based cursor row.
2237 */
Mike Frysingercf3c7622017-04-21 11:37:33 -04002238hterm.Terminal.prototype.getCursorRow = function() {
rginda8ba33642011-12-14 12:31:31 -08002239 return this.screen_.cursorPosition.row;
2240};
2241
2242/**
2243 * Request that the ScrollPort redraw itself soon.
2244 *
2245 * The redraw will happen asynchronously, soon after the call stack winds down.
2246 * Multiple calls will be coalesced into a single redraw.
2247 */
2248hterm.Terminal.prototype.scheduleRedraw_ = function() {
rginda87b86462011-12-14 13:48:03 -08002249 if (this.timeouts_.redraw)
2250 return;
rginda8ba33642011-12-14 12:31:31 -08002251
2252 var self = this;
rginda87b86462011-12-14 13:48:03 -08002253 this.timeouts_.redraw = setTimeout(function() {
2254 delete self.timeouts_.redraw;
rginda8ba33642011-12-14 12:31:31 -08002255 self.scrollPort_.redraw_();
2256 }, 0);
2257};
2258
2259/**
2260 * Request that the ScrollPort be scrolled to the bottom.
2261 *
2262 * The scroll will happen asynchronously, soon after the call stack winds down.
2263 * Multiple calls will be coalesced into a single scroll.
2264 *
2265 * This affects the scrollbar position of the ScrollPort, and has nothing to
2266 * do with the VT scroll commands.
2267 */
2268hterm.Terminal.prototype.scheduleScrollDown_ = function() {
2269 if (this.timeouts_.scrollDown)
rginda87b86462011-12-14 13:48:03 -08002270 return;
rginda8ba33642011-12-14 12:31:31 -08002271
2272 var self = this;
2273 this.timeouts_.scrollDown = setTimeout(function() {
2274 delete self.timeouts_.scrollDown;
2275 self.scrollPort_.scrollRowToBottom(self.getRowCount());
2276 }, 10);
2277};
2278
2279/**
2280 * Move the cursor up a specified number of rows.
2281 *
2282 * @param {integer} count The number of rows to move the cursor.
2283 */
2284hterm.Terminal.prototype.cursorUp = function(count) {
rginda0f5c0292012-01-13 11:00:13 -08002285 return this.cursorDown(-(count || 1));
rginda8ba33642011-12-14 12:31:31 -08002286};
2287
2288/**
2289 * Move the cursor down a specified number of rows.
2290 *
2291 * @param {integer} count The number of rows to move the cursor.
2292 */
2293hterm.Terminal.prototype.cursorDown = function(count) {
rginda0f5c0292012-01-13 11:00:13 -08002294 count = count || 1;
rginda8ba33642011-12-14 12:31:31 -08002295 var minHeight = (this.options_.originMode ? this.getVTScrollTop() : 0);
2296 var maxHeight = (this.options_.originMode ? this.getVTScrollBottom() :
2297 this.screenSize.height - 1);
2298
rgindacbbd7482012-06-13 15:06:16 -07002299 var row = lib.f.clamp(this.screen_.cursorPosition.row + count,
rginda8ba33642011-12-14 12:31:31 -08002300 minHeight, maxHeight);
rginda87b86462011-12-14 13:48:03 -08002301 this.setAbsoluteCursorRow(row);
rginda8ba33642011-12-14 12:31:31 -08002302};
2303
2304/**
2305 * Move the cursor left a specified number of columns.
2306 *
Robert Gindaaaba6132014-07-16 16:33:07 -07002307 * If reverse wraparound mode is enabled and the previous row wrapped into
2308 * the current row then we back up through the wraparound as well.
2309 *
rginda8ba33642011-12-14 12:31:31 -08002310 * @param {integer} count The number of columns to move the cursor.
2311 */
2312hterm.Terminal.prototype.cursorLeft = function(count) {
Robert Gindaaaba6132014-07-16 16:33:07 -07002313 count = count || 1;
2314
2315 if (count < 1)
2316 return;
2317
2318 var currentColumn = this.screen_.cursorPosition.column;
Robert Gindabfb32622014-07-17 13:20:27 -07002319 if (this.options_.reverseWraparound) {
2320 if (this.screen_.cursorPosition.overflow) {
2321 // If this cursor is in the right margin, consume one count to get it
2322 // back to the last column. This only applies when we're in reverse
2323 // wraparound mode.
2324 count--;
2325 this.clearCursorOverflow();
2326
2327 if (!count)
Robert Gindaaaba6132014-07-16 16:33:07 -07002328 return;
Robert Gindaaaba6132014-07-16 16:33:07 -07002329 }
2330
Robert Gindabfb32622014-07-17 13:20:27 -07002331 var newRow = this.screen_.cursorPosition.row;
2332 var newColumn = currentColumn - count;
2333 if (newColumn < 0) {
2334 newRow = newRow - Math.floor(count / this.screenSize.width) - 1;
2335 if (newRow < 0) {
2336 // xterm also wraps from row 0 to the last row.
2337 newRow = this.screenSize.height + newRow % this.screenSize.height;
2338 }
2339 newColumn = this.screenSize.width + newColumn % this.screenSize.width;
2340 }
Robert Gindaaaba6132014-07-16 16:33:07 -07002341
Robert Gindabfb32622014-07-17 13:20:27 -07002342 this.setCursorPosition(Math.max(newRow, 0), newColumn);
2343
2344 } else {
2345 var newColumn = Math.max(currentColumn - count, 0);
2346 this.setCursorColumn(newColumn);
2347 }
rginda8ba33642011-12-14 12:31:31 -08002348};
2349
2350/**
2351 * Move the cursor right a specified number of columns.
2352 *
2353 * @param {integer} count The number of columns to move the cursor.
2354 */
2355hterm.Terminal.prototype.cursorRight = function(count) {
rginda0f5c0292012-01-13 11:00:13 -08002356 count = count || 1;
Robert Gindaaaba6132014-07-16 16:33:07 -07002357
2358 if (count < 1)
2359 return;
2360
rgindacbbd7482012-06-13 15:06:16 -07002361 var column = lib.f.clamp(this.screen_.cursorPosition.column + count,
rginda87b86462011-12-14 13:48:03 -08002362 0, this.screenSize.width - 1);
rginda8ba33642011-12-14 12:31:31 -08002363 this.setCursorColumn(column);
2364};
2365
2366/**
2367 * Reverse the foreground and background colors of the terminal.
2368 *
2369 * This only affects text that was drawn with no attributes.
2370 *
2371 * TODO(rginda): Test xterm to see if reverse is respected for text that has
2372 * been drawn with attributes that happen to coincide with the default
2373 * 'no-attribute' colors. My guess is probably not.
Evan Jones2600d4f2016-12-06 09:29:36 -05002374 *
2375 * @param {boolean} state The state to set.
rginda8ba33642011-12-14 12:31:31 -08002376 */
2377hterm.Terminal.prototype.setReverseVideo = function(state) {
rginda87b86462011-12-14 13:48:03 -08002378 this.options_.reverseVideo = state;
rginda8ba33642011-12-14 12:31:31 -08002379 if (state) {
rginda9f5222b2012-03-05 11:53:28 -08002380 this.scrollPort_.setForegroundColor(this.prefs_.get('background-color'));
2381 this.scrollPort_.setBackgroundColor(this.prefs_.get('foreground-color'));
rginda8ba33642011-12-14 12:31:31 -08002382 } else {
rginda9f5222b2012-03-05 11:53:28 -08002383 this.scrollPort_.setForegroundColor(this.prefs_.get('foreground-color'));
2384 this.scrollPort_.setBackgroundColor(this.prefs_.get('background-color'));
rginda8ba33642011-12-14 12:31:31 -08002385 }
2386};
2387
2388/**
rginda87b86462011-12-14 13:48:03 -08002389 * Ring the terminal bell.
Robert Ginda92e18102013-03-14 13:56:37 -07002390 *
2391 * This will not play the bell audio more than once per second.
rginda87b86462011-12-14 13:48:03 -08002392 */
2393hterm.Terminal.prototype.ringBell = function() {
rginda6d397402012-01-17 10:58:29 -08002394 this.cursorNode_.style.backgroundColor =
2395 this.scrollPort_.getForegroundColor();
rginda87b86462011-12-14 13:48:03 -08002396
2397 var self = this;
2398 setTimeout(function() {
rginda9f5222b2012-03-05 11:53:28 -08002399 self.cursorNode_.style.backgroundColor = self.prefs_.get('cursor-color');
rginda6d397402012-01-17 10:58:29 -08002400 }, 200);
Robert Ginda92e18102013-03-14 13:56:37 -07002401
Michael Kelly485ecd12014-06-09 11:41:56 -04002402 // bellSquelchTimeout_ affects both audio and notification bells.
2403 if (this.bellSquelchTimeout_)
2404 return;
2405
Robert Ginda92e18102013-03-14 13:56:37 -07002406 if (this.bellAudio_.getAttribute('src')) {
Robert Ginda92e18102013-03-14 13:56:37 -07002407 this.bellAudio_.play();
Robert Ginda92e18102013-03-14 13:56:37 -07002408 this.bellSequelchTimeout_ = setTimeout(function() {
2409 delete this.bellSquelchTimeout_;
Robert Gindaa6331372013-03-19 10:35:39 -07002410 }.bind(this), 500);
Robert Ginda92e18102013-03-14 13:56:37 -07002411 } else {
2412 delete this.bellSquelchTimeout_;
2413 }
Michael Kelly485ecd12014-06-09 11:41:56 -04002414
2415 if (this.desktopNotificationBell_ && !this.document_.hasFocus()) {
Mike Frysingera5fb83c2017-06-22 14:48:35 -07002416 var n = hterm.notify();
Michael Kelly485ecd12014-06-09 11:41:56 -04002417 this.bellNotificationList_.push(n);
2418 // TODO: Should we try to raise the window here?
2419 n.onclick = function() { self.closeBellNotifications_(); };
2420 }
rginda87b86462011-12-14 13:48:03 -08002421};
2422
2423/**
rginda8ba33642011-12-14 12:31:31 -08002424 * Set the origin mode bit.
2425 *
2426 * If origin mode is on, certain VT cursor and scrolling commands measure their
2427 * row parameter relative to the VT scroll region. Otherwise, row 0 corresponds
2428 * to the top of the addressable screen.
2429 *
2430 * Defaults to off.
2431 *
2432 * @param {boolean} state True to set origin mode, false to unset.
2433 */
2434hterm.Terminal.prototype.setOriginMode = function(state) {
2435 this.options_.originMode = state;
rgindae4d29232012-01-19 10:47:13 -08002436 this.setCursorPosition(0, 0);
rginda8ba33642011-12-14 12:31:31 -08002437};
2438
2439/**
2440 * Set the insert mode bit.
2441 *
2442 * If insert mode is on, existing text beyond the cursor position will be
2443 * shifted right to make room for new text. Otherwise, new text overwrites
2444 * any existing text.
2445 *
2446 * Defaults to off.
2447 *
2448 * @param {boolean} state True to set insert mode, false to unset.
2449 */
2450hterm.Terminal.prototype.setInsertMode = function(state) {
2451 this.options_.insertMode = state;
2452};
2453
2454/**
rginda87b86462011-12-14 13:48:03 -08002455 * Set the auto carriage return bit.
2456 *
2457 * If auto carriage return is on then a formfeed character is interpreted
2458 * as a newline, otherwise it's the same as a linefeed. The difference boils
2459 * down to whether or not the cursor column is reset.
Evan Jones2600d4f2016-12-06 09:29:36 -05002460 *
2461 * @param {boolean} state The state to set.
rginda87b86462011-12-14 13:48:03 -08002462 */
2463hterm.Terminal.prototype.setAutoCarriageReturn = function(state) {
2464 this.options_.autoCarriageReturn = state;
2465};
2466
2467/**
rginda8ba33642011-12-14 12:31:31 -08002468 * Set the wraparound mode bit.
2469 *
2470 * If wraparound mode is on, certain VT commands will allow the cursor to wrap
2471 * to the start of the following row. Otherwise, the cursor is clamped to the
2472 * end of the screen and attempts to write past it are ignored.
2473 *
2474 * Defaults to on.
2475 *
2476 * @param {boolean} state True to set wraparound mode, false to unset.
2477 */
2478hterm.Terminal.prototype.setWraparound = function(state) {
2479 this.options_.wraparound = state;
2480};
2481
2482/**
2483 * Set the reverse-wraparound mode bit.
2484 *
2485 * If wraparound mode is off, certain VT commands will allow the cursor to wrap
2486 * to the end of the previous row. Otherwise, the cursor is clamped to column
2487 * 0.
2488 *
2489 * Defaults to off.
2490 *
2491 * @param {boolean} state True to set reverse-wraparound mode, false to unset.
2492 */
2493hterm.Terminal.prototype.setReverseWraparound = function(state) {
2494 this.options_.reverseWraparound = state;
2495};
2496
2497/**
2498 * Selects between the primary and alternate screens.
2499 *
2500 * If alternate mode is on, the alternate screen is active. Otherwise the
2501 * primary screen is active.
2502 *
2503 * Swapping screens has no effect on the scrollback buffer.
2504 *
2505 * Each screen maintains its own cursor position.
2506 *
2507 * Defaults to off.
2508 *
2509 * @param {boolean} state True to set alternate mode, false to unset.
2510 */
2511hterm.Terminal.prototype.setAlternateMode = function(state) {
rginda6d397402012-01-17 10:58:29 -08002512 var cursor = this.saveCursor();
rginda8ba33642011-12-14 12:31:31 -08002513 this.screen_ = state ? this.alternateScreen_ : this.primaryScreen_;
2514
rginda35c456b2012-02-09 17:29:05 -08002515 if (this.screen_.rowsArray.length &&
2516 this.screen_.rowsArray[0].rowIndex != this.scrollbackRows_.length) {
2517 // If the screen changed sizes while we were away, our rowIndexes may
2518 // be incorrect.
2519 var offset = this.scrollbackRows_.length;
2520 var ary = this.screen_.rowsArray;
rgindacbbd7482012-06-13 15:06:16 -07002521 for (var i = 0; i < ary.length; i++) {
rginda35c456b2012-02-09 17:29:05 -08002522 ary[i].rowIndex = offset + i;
2523 }
2524 }
rginda8ba33642011-12-14 12:31:31 -08002525
rginda35c456b2012-02-09 17:29:05 -08002526 this.realizeWidth_(this.screenSize.width);
2527 this.realizeHeight_(this.screenSize.height);
2528 this.scrollPort_.syncScrollHeight();
2529 this.scrollPort_.invalidate();
rginda8ba33642011-12-14 12:31:31 -08002530
rginda6d397402012-01-17 10:58:29 -08002531 this.restoreCursor(cursor);
rginda35c456b2012-02-09 17:29:05 -08002532 this.scrollPort_.resize();
rginda8ba33642011-12-14 12:31:31 -08002533};
2534
2535/**
2536 * Set the cursor-blink mode bit.
2537 *
2538 * If cursor-blink is on, the cursor will blink when it is visible. Otherwise
2539 * a visible cursor does not blink.
2540 *
2541 * You should make sure to turn blinking off if you're going to dispose of a
2542 * terminal, otherwise you'll leak a timeout.
2543 *
2544 * Defaults to on.
2545 *
2546 * @param {boolean} state True to set cursor-blink mode, false to unset.
2547 */
2548hterm.Terminal.prototype.setCursorBlink = function(state) {
2549 this.options_.cursorBlink = state;
2550
2551 if (!state && this.timeouts_.cursorBlink) {
2552 clearTimeout(this.timeouts_.cursorBlink);
2553 delete this.timeouts_.cursorBlink;
2554 }
2555
2556 if (this.options_.cursorVisible)
2557 this.setCursorVisible(true);
2558};
2559
2560/**
2561 * Set the cursor-visible mode bit.
2562 *
2563 * If cursor-visible is on, the cursor will be visible. Otherwise it will not.
2564 *
2565 * Defaults to on.
2566 *
2567 * @param {boolean} state True to set cursor-visible mode, false to unset.
2568 */
2569hterm.Terminal.prototype.setCursorVisible = function(state) {
2570 this.options_.cursorVisible = state;
2571
2572 if (!state) {
Brad Town1c2afa82015-03-11 21:36:58 -07002573 if (this.timeouts_.cursorBlink) {
2574 clearTimeout(this.timeouts_.cursorBlink);
2575 delete this.timeouts_.cursorBlink;
2576 }
rginda87b86462011-12-14 13:48:03 -08002577 this.cursorNode_.style.opacity = '0';
rginda8ba33642011-12-14 12:31:31 -08002578 return;
2579 }
2580
rginda87b86462011-12-14 13:48:03 -08002581 this.syncCursorPosition_();
2582
2583 this.cursorNode_.style.opacity = '1';
rginda8ba33642011-12-14 12:31:31 -08002584
2585 if (this.options_.cursorBlink) {
2586 if (this.timeouts_.cursorBlink)
2587 return;
2588
Robert Gindaea2183e2014-07-17 09:51:51 -07002589 this.onCursorBlink_();
rginda8ba33642011-12-14 12:31:31 -08002590 } else {
2591 if (this.timeouts_.cursorBlink) {
2592 clearTimeout(this.timeouts_.cursorBlink);
2593 delete this.timeouts_.cursorBlink;
2594 }
2595 }
2596};
2597
2598/**
rginda87b86462011-12-14 13:48:03 -08002599 * Synchronizes the visible cursor and document selection with the current
2600 * cursor coordinates.
rginda8ba33642011-12-14 12:31:31 -08002601 */
2602hterm.Terminal.prototype.syncCursorPosition_ = function() {
2603 var topRowIndex = this.scrollPort_.getTopRowIndex();
2604 var bottomRowIndex = this.scrollPort_.getBottomRowIndex(topRowIndex);
2605 var cursorRowIndex = this.scrollbackRows_.length +
2606 this.screen_.cursorPosition.row;
2607
2608 if (cursorRowIndex > bottomRowIndex) {
2609 // Cursor is scrolled off screen, move it outside of the visible area.
rginda35c456b2012-02-09 17:29:05 -08002610 this.cursorNode_.style.top = -this.scrollPort_.characterSize.height + 'px';
rginda8ba33642011-12-14 12:31:31 -08002611 return;
2612 }
2613
Robert Gindab837c052014-08-11 11:17:51 -07002614 if (this.options_.cursorVisible &&
2615 this.cursorNode_.style.display == 'none') {
2616 // Re-display the terminal cursor if it was hidden by the mouse cursor.
2617 this.cursorNode_.style.display = '';
2618 }
2619
2620
rginda8ba33642011-12-14 12:31:31 -08002621 this.cursorNode_.style.top = this.scrollPort_.visibleRowTopMargin +
rginda35c456b2012-02-09 17:29:05 -08002622 this.scrollPort_.characterSize.height * (cursorRowIndex - topRowIndex) +
2623 'px';
2624 this.cursorNode_.style.left = this.scrollPort_.characterSize.width *
2625 this.screen_.cursorPosition.column + 'px';
rginda87b86462011-12-14 13:48:03 -08002626
2627 this.cursorNode_.setAttribute('title',
2628 '(' + this.screen_.cursorPosition.row +
2629 ', ' + this.screen_.cursorPosition.column +
2630 ')');
2631
2632 // Update the caret for a11y purposes.
2633 var selection = this.document_.getSelection();
2634 if (selection && selection.isCollapsed)
2635 this.screen_.syncSelectionCaret(selection);
rginda8ba33642011-12-14 12:31:31 -08002636};
2637
Robert Gindafb1be6a2013-12-11 11:56:22 -08002638/**
2639 * Adjusts the style of this.cursorNode_ according to the current cursor shape
2640 * and character cell dimensions.
2641 */
Robert Ginda830583c2013-08-07 13:20:46 -07002642hterm.Terminal.prototype.restyleCursor_ = function() {
2643 var shape = this.cursorShape_;
2644
2645 if (this.cursorNode_.getAttribute('focus') == 'false') {
2646 // Always show a block cursor when unfocused.
2647 shape = hterm.Terminal.cursorShape.BLOCK;
2648 }
2649
2650 var style = this.cursorNode_.style;
2651
2652 switch (shape) {
2653 case hterm.Terminal.cursorShape.BEAM:
Mike Frysinger66beb0b2017-05-30 19:44:51 -04002654 style.height = 'var(--hterm-charsize-height)';
Robert Ginda830583c2013-08-07 13:20:46 -07002655 style.backgroundColor = 'transparent';
2656 style.borderBottomStyle = null;
2657 style.borderLeftStyle = 'solid';
2658 break;
2659
2660 case hterm.Terminal.cursorShape.UNDERLINE:
2661 style.height = this.scrollPort_.characterSize.baseline + 'px';
2662 style.backgroundColor = 'transparent';
2663 style.borderBottomStyle = 'solid';
2664 // correct the size to put it exactly at the baseline
2665 style.borderLeftStyle = null;
2666 break;
2667
2668 default:
Mike Frysinger66beb0b2017-05-30 19:44:51 -04002669 style.height = 'var(--hterm-charsize-height)';
Robert Ginda830583c2013-08-07 13:20:46 -07002670 style.backgroundColor = this.cursorColor_;
2671 style.borderBottomStyle = null;
2672 style.borderLeftStyle = null;
2673 break;
2674 }
2675};
2676
rginda8ba33642011-12-14 12:31:31 -08002677/**
2678 * Synchronizes the visible cursor with the current cursor coordinates.
2679 *
2680 * The sync will happen asynchronously, soon after the call stack winds down.
2681 * Multiple calls will be coalesced into a single sync.
2682 */
2683hterm.Terminal.prototype.scheduleSyncCursorPosition_ = function() {
2684 if (this.timeouts_.syncCursor)
rginda87b86462011-12-14 13:48:03 -08002685 return;
rginda8ba33642011-12-14 12:31:31 -08002686
2687 var self = this;
2688 this.timeouts_.syncCursor = setTimeout(function() {
2689 self.syncCursorPosition_();
2690 delete self.timeouts_.syncCursor;
rginda87b86462011-12-14 13:48:03 -08002691 }, 0);
2692};
2693
rgindacc2996c2012-02-24 14:59:31 -08002694/**
rgindaf522ce02012-04-17 17:49:17 -07002695 * Show or hide the zoom warning.
2696 *
2697 * The zoom warning is a message warning the user that their browser zoom must
2698 * be set to 100% in order for hterm to function properly.
2699 *
2700 * @param {boolean} state True to show the message, false to hide it.
2701 */
2702hterm.Terminal.prototype.showZoomWarning_ = function(state) {
2703 if (!this.zoomWarningNode_) {
2704 if (!state)
2705 return;
2706
2707 this.zoomWarningNode_ = this.document_.createElement('div');
2708 this.zoomWarningNode_.style.cssText = (
2709 'color: black;' +
2710 'background-color: #ff2222;' +
2711 'font-size: large;' +
2712 'border-radius: 8px;' +
2713 'opacity: 0.75;' +
2714 'padding: 0.2em 0.5em 0.2em 0.5em;' +
2715 'top: 0.5em;' +
2716 'right: 1.2em;' +
2717 'position: absolute;' +
2718 '-webkit-text-size-adjust: none;' +
Rob Spies06533ba2014-04-24 11:20:37 -07002719 '-webkit-user-select: none;' +
2720 '-moz-text-size-adjust: none;' +
2721 '-moz-user-select: none;');
Mike Frysinger4c0c5e02016-03-12 23:11:25 -05002722
2723 this.zoomWarningNode_.addEventListener('click', function(e) {
2724 this.parentNode.removeChild(this);
2725 });
rgindaf522ce02012-04-17 17:49:17 -07002726 }
2727
Robert Gindab4839c22013-02-28 16:52:10 -08002728 this.zoomWarningNode_.textContent = lib.MessageManager.replaceReferences(
2729 hterm.zoomWarningMessage,
2730 [parseInt(this.scrollPort_.characterSize.zoomFactor * 100)]);
2731
rgindaf522ce02012-04-17 17:49:17 -07002732 this.zoomWarningNode_.style.fontFamily = this.prefs_.get('font-family');
2733
2734 if (state) {
2735 if (!this.zoomWarningNode_.parentNode)
2736 this.div_.parentNode.appendChild(this.zoomWarningNode_);
2737 } else if (this.zoomWarningNode_.parentNode) {
2738 this.zoomWarningNode_.parentNode.removeChild(this.zoomWarningNode_);
2739 }
2740};
2741
2742/**
rgindacc2996c2012-02-24 14:59:31 -08002743 * Show the terminal overlay for a given amount of time.
2744 *
2745 * The terminal overlay appears in inverse video in a large font, centered
2746 * over the terminal. You should probably keep the overlay message brief,
2747 * since it's in a large font and you probably aren't going to check the size
2748 * of the terminal first.
2749 *
2750 * @param {string} msg The text (not HTML) message to display in the overlay.
2751 * @param {number} opt_timeout The amount of time to wait before fading out
2752 * the overlay. Defaults to 1.5 seconds. Pass null to have the overlay
2753 * stay up forever (or until the next overlay).
2754 */
2755hterm.Terminal.prototype.showOverlay = function(msg, opt_timeout) {
rgindaf0090c92012-02-10 14:58:52 -08002756 if (!this.overlayNode_) {
2757 if (!this.div_)
2758 return;
2759
2760 this.overlayNode_ = this.document_.createElement('div');
2761 this.overlayNode_.style.cssText = (
rgindaf0090c92012-02-10 14:58:52 -08002762 'border-radius: 15px;' +
rgindaf0090c92012-02-10 14:58:52 -08002763 'font-size: xx-large;' +
2764 'opacity: 0.75;' +
2765 'padding: 0.2em 0.5em 0.2em 0.5em;' +
2766 'position: absolute;' +
2767 '-webkit-user-select: none;' +
Rob Spies06533ba2014-04-24 11:20:37 -07002768 '-webkit-transition: opacity 180ms ease-in;' +
2769 '-moz-user-select: none;' +
2770 '-moz-transition: opacity 180ms ease-in;');
Robert Ginda70926e42013-11-25 14:56:36 -08002771
2772 this.overlayNode_.addEventListener('mousedown', function(e) {
2773 e.preventDefault();
2774 e.stopPropagation();
2775 }, true);
rgindaf0090c92012-02-10 14:58:52 -08002776 }
2777
rginda9f5222b2012-03-05 11:53:28 -08002778 this.overlayNode_.style.color = this.prefs_.get('background-color');
2779 this.overlayNode_.style.backgroundColor = this.prefs_.get('foreground-color');
2780 this.overlayNode_.style.fontFamily = this.prefs_.get('font-family');
2781
rgindaf0090c92012-02-10 14:58:52 -08002782 this.overlayNode_.textContent = msg;
2783 this.overlayNode_.style.opacity = '0.75';
2784
2785 if (!this.overlayNode_.parentNode)
2786 this.div_.appendChild(this.overlayNode_);
2787
Robert Ginda97769282013-02-01 15:30:30 -08002788 var divSize = hterm.getClientSize(this.div_);
2789 var overlaySize = hterm.getClientSize(this.overlayNode_);
2790
Robert Ginda8a59f762014-07-23 11:29:55 -07002791 this.overlayNode_.style.top =
2792 (divSize.height - overlaySize.height) / 2 + 'px';
Robert Ginda97769282013-02-01 15:30:30 -08002793 this.overlayNode_.style.left = (divSize.width - overlaySize.width -
Robert Ginda8a59f762014-07-23 11:29:55 -07002794 this.scrollPort_.currentScrollbarWidthPx) / 2 + 'px';
rgindaf0090c92012-02-10 14:58:52 -08002795
2796 var self = this;
2797
2798 if (this.overlayTimeout_)
2799 clearTimeout(this.overlayTimeout_);
2800
rgindacc2996c2012-02-24 14:59:31 -08002801 if (opt_timeout === null)
2802 return;
2803
rgindaf0090c92012-02-10 14:58:52 -08002804 this.overlayTimeout_ = setTimeout(function() {
2805 self.overlayNode_.style.opacity = '0';
Robert Ginda70926e42013-11-25 14:56:36 -08002806 self.overlayTimeout_ = setTimeout(function() {
rginda259dcca2012-03-14 16:37:11 -07002807 if (self.overlayNode_.parentNode)
2808 self.overlayNode_.parentNode.removeChild(self.overlayNode_);
rgindaf0090c92012-02-10 14:58:52 -08002809 self.overlayTimeout_ = null;
2810 self.overlayNode_.style.opacity = '0.75';
2811 }, 200);
rgindacc2996c2012-02-24 14:59:31 -08002812 }, opt_timeout || 1500);
rgindaf0090c92012-02-10 14:58:52 -08002813};
2814
rginda4bba5e12012-06-20 16:15:30 -07002815/**
2816 * Paste from the system clipboard to the terminal.
2817 */
2818hterm.Terminal.prototype.paste = function() {
Mike Frysinger4628ad22017-07-20 02:44:20 -04002819 return hterm.pasteFromClipboard(this.document_);
rginda4bba5e12012-06-20 16:15:30 -07002820};
2821
2822/**
2823 * Copy a string to the system clipboard.
2824 *
2825 * Note: If there is a selected range in the terminal, it'll be cleared.
Evan Jones2600d4f2016-12-06 09:29:36 -05002826 *
2827 * @param {string} str The string to copy.
rginda4bba5e12012-06-20 16:15:30 -07002828 */
2829hterm.Terminal.prototype.copyStringToClipboard = function(str) {
Robert Ginda4e4d42c2014-03-04 14:07:23 -08002830 if (this.prefs_.get('enable-clipboard-notice'))
2831 setTimeout(this.showOverlay.bind(this, hterm.notifyCopyMessage, 500), 200);
2832
rgindaa09e7332012-08-17 12:49:51 -07002833 var copySource = this.document_.createElement('pre');
rginda4bba5e12012-06-20 16:15:30 -07002834 copySource.textContent = str;
2835 copySource.style.cssText = (
2836 '-webkit-user-select: text;' +
Rob Spies06533ba2014-04-24 11:20:37 -07002837 '-moz-user-select: text;' +
rginda4bba5e12012-06-20 16:15:30 -07002838 'position: absolute;' +
2839 'top: -99px');
2840
2841 this.document_.body.appendChild(copySource);
rgindafaa74742012-08-21 13:34:03 -07002842
rginda4bba5e12012-06-20 16:15:30 -07002843 var selection = this.document_.getSelection();
rgindafaa74742012-08-21 13:34:03 -07002844 var anchorNode = selection.anchorNode;
2845 var anchorOffset = selection.anchorOffset;
2846 var focusNode = selection.focusNode;
2847 var focusOffset = selection.focusOffset;
2848
rginda4bba5e12012-06-20 16:15:30 -07002849 selection.selectAllChildren(copySource);
2850
rgindaa09e7332012-08-17 12:49:51 -07002851 hterm.copySelectionToClipboard(this.document_);
rginda4bba5e12012-06-20 16:15:30 -07002852
Rob Spies56953412014-04-28 14:09:47 -07002853 // IE doesn't support selection.extend. This means that the selection
2854 // won't return on IE.
Robert Ginda6f4f0aa2014-07-28 10:21:39 -07002855 if (selection.extend) {
Rob Spies56953412014-04-28 14:09:47 -07002856 selection.collapse(anchorNode, anchorOffset);
2857 selection.extend(focusNode, focusOffset);
2858 }
rgindafaa74742012-08-21 13:34:03 -07002859
rginda4bba5e12012-06-20 16:15:30 -07002860 copySource.parentNode.removeChild(copySource);
2861};
2862
Evan Jones2600d4f2016-12-06 09:29:36 -05002863/**
2864 * Returns the selected text, or null if no text is selected.
2865 *
2866 * @return {string|null}
2867 */
rgindaa09e7332012-08-17 12:49:51 -07002868hterm.Terminal.prototype.getSelectionText = function() {
2869 var selection = this.scrollPort_.selection;
2870 selection.sync();
2871
2872 if (selection.isCollapsed)
2873 return null;
2874
2875
2876 // Start offset measures from the beginning of the line.
2877 var startOffset = selection.startOffset;
2878 var node = selection.startNode;
Robert Ginda0d190502012-10-02 10:59:00 -07002879
Robert Gindafdbb3f22012-09-06 20:23:06 -07002880 if (node.nodeName != 'X-ROW') {
2881 // If the selection doesn't start on an x-row node, then it must be
2882 // somewhere inside the x-row. Add any characters from previous siblings
2883 // into the start offset.
Robert Ginda0d190502012-10-02 10:59:00 -07002884
2885 if (node.nodeName == '#text' && node.parentNode.nodeName == 'SPAN') {
2886 // If node is the text node in a styled span, move up to the span node.
2887 node = node.parentNode;
2888 }
2889
Robert Gindafdbb3f22012-09-06 20:23:06 -07002890 while (node.previousSibling) {
2891 node = node.previousSibling;
Ricky Liang48f05cb2013-12-31 23:35:29 +08002892 startOffset += hterm.TextAttributes.nodeWidth(node);
Robert Gindafdbb3f22012-09-06 20:23:06 -07002893 }
rgindaa09e7332012-08-17 12:49:51 -07002894 }
2895
2896 // End offset measures from the end of the line.
Ricky Liang48f05cb2013-12-31 23:35:29 +08002897 var endOffset = (hterm.TextAttributes.nodeWidth(selection.endNode) -
2898 selection.endOffset);
Evan Jones5f9df812016-12-06 09:38:58 -05002899 node = selection.endNode;
Robert Ginda0d190502012-10-02 10:59:00 -07002900
Robert Gindafdbb3f22012-09-06 20:23:06 -07002901 if (node.nodeName != 'X-ROW') {
2902 // If the selection doesn't end on an x-row node, then it must be
2903 // somewhere inside the x-row. Add any characters from following siblings
2904 // into the end offset.
Robert Ginda0d190502012-10-02 10:59:00 -07002905
2906 if (node.nodeName == '#text' && node.parentNode.nodeName == 'SPAN') {
2907 // If node is the text node in a styled span, move up to the span node.
2908 node = node.parentNode;
2909 }
2910
Robert Gindafdbb3f22012-09-06 20:23:06 -07002911 while (node.nextSibling) {
2912 node = node.nextSibling;
Ricky Liang48f05cb2013-12-31 23:35:29 +08002913 endOffset += hterm.TextAttributes.nodeWidth(node);
Robert Gindafdbb3f22012-09-06 20:23:06 -07002914 }
rgindaa09e7332012-08-17 12:49:51 -07002915 }
2916
2917 var rv = this.getRowsText(selection.startRow.rowIndex,
2918 selection.endRow.rowIndex + 1);
Ricky Liang48f05cb2013-12-31 23:35:29 +08002919 return lib.wc.substring(rv, startOffset, lib.wc.strWidth(rv) - endOffset);
rgindaa09e7332012-08-17 12:49:51 -07002920};
2921
rginda4bba5e12012-06-20 16:15:30 -07002922/**
2923 * Copy the current selection to the system clipboard, then clear it after a
2924 * short delay.
2925 */
2926hterm.Terminal.prototype.copySelectionToClipboard = function() {
rgindaa09e7332012-08-17 12:49:51 -07002927 var text = this.getSelectionText();
2928 if (text != null)
2929 this.copyStringToClipboard(text);
rginda4bba5e12012-06-20 16:15:30 -07002930};
2931
rgindaf0090c92012-02-10 14:58:52 -08002932hterm.Terminal.prototype.overlaySize = function() {
2933 this.showOverlay(this.screenSize.width + 'x' + this.screenSize.height);
2934};
2935
rginda87b86462011-12-14 13:48:03 -08002936/**
2937 * Invoked by hterm.Terminal.Keyboard when a VT keystroke is detected.
2938 *
Robert Ginda8cb7d902013-06-20 14:37:18 -07002939 * @param {string} string The VT string representing the keystroke, in UTF-16.
rginda87b86462011-12-14 13:48:03 -08002940 */
2941hterm.Terminal.prototype.onVTKeystroke = function(string) {
rginda9f5222b2012-03-05 11:53:28 -08002942 if (this.scrollOnKeystroke_)
rginda87b86462011-12-14 13:48:03 -08002943 this.scrollPort_.scrollRowToBottom(this.getRowCount());
2944
Robert Ginda8cb7d902013-06-20 14:37:18 -07002945 this.io.onVTKeystroke(this.keyboard.encode(string));
rginda8ba33642011-12-14 12:31:31 -08002946};
2947
2948/**
Mike Frysinger70b94692017-01-26 18:57:50 -10002949 * Launches url in a new tab.
2950 *
2951 * @param {string} url URL to launch in a new tab.
2952 */
2953hterm.Terminal.prototype.openUrl = function(url) {
Mike Frysingerac437a12017-07-13 02:35:59 -04002954 if (window.chrome && window.chrome.browser) {
2955 // For Chrome v2 apps, we need to use this API to properly open windows.
2956 chrome.browser.openTab({'url': url});
2957 } else {
2958 var win = window.open(url, '_blank');
2959 win.focus();
2960 }
Mike Frysinger70b94692017-01-26 18:57:50 -10002961}
2962
2963/**
2964 * Open the selected url.
2965 */
2966hterm.Terminal.prototype.openSelectedUrl_ = function() {
2967 var str = this.getSelectionText();
2968
2969 // If there is no selection, try and expand wherever they clicked.
2970 if (str == null) {
2971 this.screen_.expandSelection(this.document_.getSelection());
2972 str = this.getSelectionText();
Mike Frysinger498192d2017-06-26 18:23:31 -04002973
2974 // If clicking in empty space, return.
2975 if (str == null)
2976 return;
Mike Frysinger70b94692017-01-26 18:57:50 -10002977 }
2978
2979 // Make sure URL is valid before opening.
2980 if (str.length > 2048 || str.search(/[\s\[\](){}<>"'\\^`]/) >= 0)
2981 return;
Mike Frysinger43472622017-06-26 18:11:07 -04002982
2983 // If the URI isn't anchored, it'll open relative to the extension.
Mike Frysinger70b94692017-01-26 18:57:50 -10002984 // We have no way of knowing the correct schema, so assume http.
Mike Frysinger43472622017-06-26 18:11:07 -04002985 if (str.search('^[a-zA-Z][a-zA-Z0-9+.-]*://') < 0) {
2986 // We have to whitelist a few protocols that lack authorities and thus
2987 // never use the //. Like mailto.
2988 switch (str.split(':', 1)[0]) {
2989 case 'mailto':
2990 break;
2991 default:
2992 str = 'http://' + str;
2993 break;
2994 }
2995 }
Mike Frysinger70b94692017-01-26 18:57:50 -10002996
2997 this.openUrl(str);
2998}
2999
3000
3001/**
rgindad5613292012-06-19 15:40:37 -07003002 * Add the terminalRow and terminalColumn properties to mouse events and
3003 * then forward on to onMouse().
3004 *
3005 * The terminalRow and terminalColumn properties contain the (row, column)
3006 * coordinates for the mouse event.
Evan Jones2600d4f2016-12-06 09:29:36 -05003007 *
3008 * @param {Event} e The mouse event to handle.
rgindad5613292012-06-19 15:40:37 -07003009 */
3010hterm.Terminal.prototype.onMouse_ = function(e) {
rgindafaa74742012-08-21 13:34:03 -07003011 if (e.processedByTerminalHandler_) {
3012 // We register our event handlers on the document, as well as the cursor
3013 // and the scroll blocker. Mouse events that occur on the cursor or
3014 // scroll blocker will also appear on the document, but we don't want to
3015 // process them twice.
3016 //
3017 // We can't just prevent bubbling because that has other side effects, so
3018 // we decorate the event object with this property instead.
3019 return;
3020 }
3021
Robert Ginda6aec7eb2015-06-16 10:31:30 -07003022 var reportMouseEvents = (!this.defeatMouseReports_ &&
3023 this.vt.mouseReport != this.vt.MOUSE_REPORT_DISABLED);
3024
rgindafaa74742012-08-21 13:34:03 -07003025 e.processedByTerminalHandler_ = true;
3026
Robert Gindaeda48db2014-07-17 09:25:30 -07003027 // One based row/column stored on the mouse event.
3028 e.terminalRow = parseInt((e.clientY - this.scrollPort_.visibleRowTopMargin) /
3029 this.scrollPort_.characterSize.height) + 1;
3030 e.terminalColumn = parseInt(e.clientX /
3031 this.scrollPort_.characterSize.width) + 1;
3032
Robert Ginda4e24f8f2014-01-08 14:45:06 -08003033 if (e.type == 'mousedown' && e.terminalColumn > this.screenSize.width) {
3034 // Mousedown in the scrollbar area.
rginda4bba5e12012-06-20 16:15:30 -07003035 return;
3036 }
3037
Robert Ginda6aec7eb2015-06-16 10:31:30 -07003038 if (this.options_.cursorVisible && !reportMouseEvents) {
Robert Gindab837c052014-08-11 11:17:51 -07003039 // If the cursor is visible and we're not sending mouse events to the
3040 // host app, then we want to hide the terminal cursor when the mouse
3041 // cursor is over top. This keeps the terminal cursor from interfering
3042 // with local text selection.
Robert Gindaeda48db2014-07-17 09:25:30 -07003043 if (e.terminalRow - 1 == this.screen_.cursorPosition.row &&
3044 e.terminalColumn - 1 == this.screen_.cursorPosition.column) {
3045 this.cursorNode_.style.display = 'none';
3046 } else if (this.cursorNode_.style.display == 'none') {
3047 this.cursorNode_.style.display = '';
3048 }
3049 }
rgindad5613292012-06-19 15:40:37 -07003050
Robert Ginda928cf632014-03-05 15:07:41 -08003051 if (e.type == 'mousedown') {
Robert Ginda6aec7eb2015-06-16 10:31:30 -07003052 if (e.altKey || !reportMouseEvents) {
Robert Ginda928cf632014-03-05 15:07:41 -08003053 // If VT mouse reporting is disabled, or has been defeated with
3054 // alt-mousedown, then the mouse will act on the local selection.
Robert Ginda6aec7eb2015-06-16 10:31:30 -07003055 this.defeatMouseReports_ = true;
Robert Ginda928cf632014-03-05 15:07:41 -08003056 this.setSelectionEnabled(true);
3057 } else {
3058 // Otherwise we defer ownership of the mouse to the VT.
Robert Ginda6aec7eb2015-06-16 10:31:30 -07003059 this.defeatMouseReports_ = false;
Robert Ginda3ae37822014-05-15 13:05:35 -07003060 this.document_.getSelection().collapseToEnd();
Robert Ginda928cf632014-03-05 15:07:41 -08003061 this.setSelectionEnabled(false);
3062 e.preventDefault();
3063 }
3064 }
3065
Robert Ginda6aec7eb2015-06-16 10:31:30 -07003066 if (!reportMouseEvents) {
Robert Ginda15ed4902016-07-12 10:43:22 -07003067 if (e.type == 'dblclick' && this.copyOnSelect) {
Robert Ginda4e24f8f2014-01-08 14:45:06 -08003068 this.screen_.expandSelection(this.document_.getSelection());
Robert Ginda15ed4902016-07-12 10:43:22 -07003069 this.copySelectionToClipboard(this.document_);
rgindad5613292012-06-19 15:40:37 -07003070 }
3071
Mihir Nimbalkar467fd8b2017-07-12 12:14:16 -07003072 if (e.type == 'click' && !e.shiftKey && (e.ctrlKey || e.metaKey)) {
Mike Frysinger70b94692017-01-26 18:57:50 -10003073 // Debounce this event with the dblclick event. If you try to doubleclick
3074 // a URL to open it, Chrome will fire click then dblclick, but we won't
3075 // have expanded the selection text at the first click event.
3076 clearTimeout(this.timeouts_.openUrl);
3077 this.timeouts_.openUrl = setTimeout(this.openSelectedUrl_.bind(this),
3078 500);
3079 return;
3080 }
3081
Mike Frysinger847577f2017-05-23 23:25:57 -04003082 if (e.type == 'mousedown') {
3083 if ((this.mouseRightClickPaste && e.button == 2 /* right button */) ||
Mike Frysinger2edd3612017-05-24 00:54:39 -04003084 e.button == this.mousePasteButton) {
Mike Frysinger4628ad22017-07-20 02:44:20 -04003085 if (!this.paste())
3086 console.warning('Could not paste manually due to web restrictions');;
Mike Frysinger847577f2017-05-23 23:25:57 -04003087 }
3088 }
Robert Ginda4e24f8f2014-01-08 14:45:06 -08003089
Mike Frysinger2edd3612017-05-24 00:54:39 -04003090 if (e.type == 'mouseup' && e.button == 0 && this.copyOnSelect &&
Robert Ginda4e24f8f2014-01-08 14:45:06 -08003091 !this.document_.getSelection().isCollapsed) {
Robert Ginda15ed4902016-07-12 10:43:22 -07003092 this.copySelectionToClipboard(this.document_);
Robert Ginda4e24f8f2014-01-08 14:45:06 -08003093 }
3094
3095 if ((e.type == 'mousemove' || e.type == 'mouseup') &&
3096 this.scrollBlockerNode_.engaged) {
3097 // Disengage the scroll-blocker after one of these events.
3098 this.scrollBlockerNode_.engaged = false;
3099 this.scrollBlockerNode_.style.top = '-99px';
3100 }
3101
Mike Frysinger3c9fa072017-07-13 10:21:13 -04003102 // Emulate arrow key presses via scroll wheel events.
3103 if (this.scrollWheelArrowKeys_ && !e.shiftKey &&
3104 this.keyboard.applicationCursor && !this.isPrimaryScreen()) {
Mike Frysingerc3030a82017-05-29 14:16:11 -04003105 if (e.type == 'wheel') {
3106 var delta = this.scrollPort_.scrollWheelDelta(e);
3107 var lines = lib.f.smartFloorDivide(
3108 Math.abs(delta), this.scrollPort_.characterSize.height);
3109
3110 var data = '\x1bO' + (delta < 0 ? 'B' : 'A');
3111 this.io.sendString(data.repeat(lines));
3112
3113 e.preventDefault();
3114 }
3115 }
Robert Ginda928cf632014-03-05 15:07:41 -08003116 } else /* if (this.reportMouseEvents) */ {
Robert Ginda4e24f8f2014-01-08 14:45:06 -08003117 if (!this.scrollBlockerNode_.engaged) {
3118 if (e.type == 'mousedown') {
3119 // Move the scroll-blocker into place if we want to keep the scrollport
3120 // from scrolling.
3121 this.scrollBlockerNode_.engaged = true;
3122 this.scrollBlockerNode_.style.top = (e.clientY - 5) + 'px';
3123 this.scrollBlockerNode_.style.left = (e.clientX - 5) + 'px';
3124 } else if (e.type == 'mousemove') {
3125 // Oh. This means that drag-scroll was disabled AFTER the mouse down,
3126 // in which case it's too late to engage the scroll-blocker.
Robert Ginda3ae37822014-05-15 13:05:35 -07003127 this.document_.getSelection().collapseToEnd();
Robert Ginda4e24f8f2014-01-08 14:45:06 -08003128 e.preventDefault();
3129 }
3130 }
Robert Ginda928cf632014-03-05 15:07:41 -08003131
3132 this.onMouse(e);
rgindad5613292012-06-19 15:40:37 -07003133 }
3134
Robert Ginda928cf632014-03-05 15:07:41 -08003135 if (e.type == 'mouseup' && this.document_.getSelection().isCollapsed) {
3136 // Restore this on mouseup in case it was temporarily defeated with a
3137 // alt-mousedown. Only do this when the selection is empty so that
3138 // we don't immediately kill the users selection.
Robert Ginda6aec7eb2015-06-16 10:31:30 -07003139 this.defeatMouseReports_ = false;
Robert Ginda928cf632014-03-05 15:07:41 -08003140 }
rgindad5613292012-06-19 15:40:37 -07003141};
3142
3143/**
3144 * Clients should override this if they care to know about mouse events.
3145 *
3146 * The event parameter will be a normal DOM mouse click event with additional
3147 * 'terminalRow' and 'terminalColumn' properties.
Evan Jones2600d4f2016-12-06 09:29:36 -05003148 *
3149 * @param {Event} e The mouse event to handle.
rgindad5613292012-06-19 15:40:37 -07003150 */
3151hterm.Terminal.prototype.onMouse = function(e) { };
3152
3153/**
rginda8e92a692012-05-20 19:37:20 -07003154 * React when focus changes.
Evan Jones2600d4f2016-12-06 09:29:36 -05003155 *
3156 * @param {boolean} focused True if focused, false otherwise.
rginda8e92a692012-05-20 19:37:20 -07003157 */
Rob Spies06533ba2014-04-24 11:20:37 -07003158hterm.Terminal.prototype.onFocusChange_ = function(focused) {
3159 this.cursorNode_.setAttribute('focus', focused);
Robert Ginda830583c2013-08-07 13:20:46 -07003160 this.restyleCursor_();
Michael Kelly485ecd12014-06-09 11:41:56 -04003161 if (focused === true)
3162 this.closeBellNotifications_();
rginda8e92a692012-05-20 19:37:20 -07003163};
3164
3165/**
rginda8ba33642011-12-14 12:31:31 -08003166 * React when the ScrollPort is scrolled.
3167 */
3168hterm.Terminal.prototype.onScroll_ = function() {
3169 this.scheduleSyncCursorPosition_();
3170};
3171
3172/**
rginda9846e2f2012-01-27 13:53:33 -08003173 * React when text is pasted into the scrollPort.
Evan Jones2600d4f2016-12-06 09:29:36 -05003174 *
3175 * @param {Event} e The DOM paste event to handle.
rginda9846e2f2012-01-27 13:53:33 -08003176 */
3177hterm.Terminal.prototype.onPaste_ = function(e) {
Robert Gindaa063b202014-07-21 11:08:25 -07003178 var data = e.text.replace(/\n/mg, '\r');
Connor Hegartyf525ceb2014-09-03 13:36:03 -07003179 data = this.keyboard.encode(data);
Robert Gindaa063b202014-07-21 11:08:25 -07003180 if (this.options_.bracketedPaste)
3181 data = '\x1b[200~' + data + '\x1b[201~';
3182
3183 this.io.sendString(data);
rginda9846e2f2012-01-27 13:53:33 -08003184};
3185
3186/**
rgindaa09e7332012-08-17 12:49:51 -07003187 * React when the user tries to copy from the scrollPort.
Evan Jones2600d4f2016-12-06 09:29:36 -05003188 *
3189 * @param {Event} e The DOM copy event.
rgindaa09e7332012-08-17 12:49:51 -07003190 */
3191hterm.Terminal.prototype.onCopy_ = function(e) {
Rob Spies0bec09b2014-06-06 15:58:09 -07003192 if (!this.useDefaultWindowCopy) {
3193 e.preventDefault();
3194 setTimeout(this.copySelectionToClipboard.bind(this), 0);
3195 }
rgindaa09e7332012-08-17 12:49:51 -07003196};
3197
3198/**
rginda8ba33642011-12-14 12:31:31 -08003199 * React when the ScrollPort is resized.
rgindac9bc5502012-01-18 11:48:44 -08003200 *
3201 * Note: This function should not directly contain code that alters the internal
3202 * state of the terminal. That kind of code belongs in realizeWidth or
3203 * realizeHeight, so that it can be executed synchronously in the case of a
3204 * programmatic width change.
rginda8ba33642011-12-14 12:31:31 -08003205 */
3206hterm.Terminal.prototype.onResize_ = function() {
Robert Ginda19f61292014-03-04 14:07:57 -08003207 var columnCount = Math.floor(this.scrollPort_.getScreenWidth() /
Rob Spies0be20252015-07-16 14:36:47 -07003208 this.scrollPort_.characterSize.width) || 0;
Rob Spiesf4e90e82015-01-28 12:10:13 -08003209 var rowCount = lib.f.smartFloorDivide(this.scrollPort_.getScreenHeight(),
Rob Spies0be20252015-07-16 14:36:47 -07003210 this.scrollPort_.characterSize.height) || 0;
rginda35c456b2012-02-09 17:29:05 -08003211
Robert Ginda4e83f3a2012-09-04 15:25:25 -07003212 if (columnCount <= 0 || rowCount <= 0) {
rginda35c456b2012-02-09 17:29:05 -08003213 // We avoid these situations since they happen sometimes when the terminal
Robert Ginda4e83f3a2012-09-04 15:25:25 -07003214 // gets removed from the document or during the initial load, and we can't
3215 // deal with that.
Rob Spies0be20252015-07-16 14:36:47 -07003216 // This can also happen if called before the scrollPort calculates the
3217 // character size, meaning we dived by 0 above and default to 0 values.
rginda35c456b2012-02-09 17:29:05 -08003218 return;
3219 }
3220
rgindaa8ba17d2012-08-15 14:41:10 -07003221 var isNewSize = (columnCount != this.screenSize.width ||
3222 rowCount != this.screenSize.height);
3223
3224 // We do this even if the size didn't change, just to be sure everything is
3225 // in sync.
Dmitry Polukhinbb2ef712012-01-19 19:00:37 +04003226 this.realizeSize_(columnCount, rowCount);
rgindaf522ce02012-04-17 17:49:17 -07003227 this.showZoomWarning_(this.scrollPort_.characterSize.zoomFactor != 1);
rgindaa8ba17d2012-08-15 14:41:10 -07003228
3229 if (isNewSize)
3230 this.overlaySize();
3231
Robert Gindafb1be6a2013-12-11 11:56:22 -08003232 this.restyleCursor_();
rgindaa8ba17d2012-08-15 14:41:10 -07003233 this.scheduleSyncCursorPosition_();
rginda8ba33642011-12-14 12:31:31 -08003234};
3235
3236/**
3237 * Service the cursor blink timeout.
3238 */
3239hterm.Terminal.prototype.onCursorBlink_ = function() {
Robert Gindaea2183e2014-07-17 09:51:51 -07003240 if (!this.options_.cursorBlink) {
3241 delete this.timeouts_.cursorBlink;
3242 return;
3243 }
3244
Robert Ginda830583c2013-08-07 13:20:46 -07003245 if (this.cursorNode_.getAttribute('focus') == 'false' ||
3246 this.cursorNode_.style.opacity == '0') {
rginda87b86462011-12-14 13:48:03 -08003247 this.cursorNode_.style.opacity = '1';
Robert Gindaea2183e2014-07-17 09:51:51 -07003248 this.timeouts_.cursorBlink = setTimeout(this.myOnCursorBlink_,
3249 this.cursorBlinkCycle_[0]);
rginda8ba33642011-12-14 12:31:31 -08003250 } else {
rginda87b86462011-12-14 13:48:03 -08003251 this.cursorNode_.style.opacity = '0';
Robert Gindaea2183e2014-07-17 09:51:51 -07003252 this.timeouts_.cursorBlink = setTimeout(this.myOnCursorBlink_,
3253 this.cursorBlinkCycle_[1]);
rginda8ba33642011-12-14 12:31:31 -08003254 }
3255};
David Reveman8f552492012-03-28 12:18:41 -04003256
3257/**
3258 * Set the scrollbar-visible mode bit.
3259 *
3260 * If scrollbar-visible is on, the vertical scrollbar will be visible.
3261 * Otherwise it will not.
3262 *
3263 * Defaults to on.
3264 *
3265 * @param {boolean} state True to set scrollbar-visible mode, false to unset.
3266 */
3267hterm.Terminal.prototype.setScrollbarVisible = function(state) {
3268 this.scrollPort_.setScrollbarVisible(state);
3269};
Michael Kelly485ecd12014-06-09 11:41:56 -04003270
3271/**
Rob Spies49039e52014-12-17 13:40:04 -08003272 * Set the scroll wheel move multiplier. This will affect how fast the page
Mike Frysinger9975de62017-04-28 00:01:14 -04003273 * scrolls on wheel events.
Rob Spies49039e52014-12-17 13:40:04 -08003274 *
3275 * Defaults to 1.
3276 *
Evan Jones2600d4f2016-12-06 09:29:36 -05003277 * @param {number} multiplier The multiplier to set.
Rob Spies49039e52014-12-17 13:40:04 -08003278 */
3279hterm.Terminal.prototype.setScrollWheelMoveMultipler = function(multiplier) {
3280 this.scrollPort_.setScrollWheelMoveMultipler(multiplier);
3281};
3282
3283/**
Michael Kelly485ecd12014-06-09 11:41:56 -04003284 * Close all web notifications created by terminal bells.
3285 */
3286hterm.Terminal.prototype.closeBellNotifications_ = function() {
3287 this.bellNotificationList_.forEach(function(n) {
3288 n.close();
3289 });
3290 this.bellNotificationList_.length = 0;
3291};