* - cursorBlink (boolean): Whether the terminal cursor blinks
*
* @public
+ * @class Xterm Xterm
+ * @alias module:xterm/src/xterm
*/
function Terminal(options) {
var self = this;
/**
* The scroll position of the y cursor, ie. ybase + y = the y position within the entire
+ * buffer
*/
this.ybase = 0;
/**
* Whether there is a full terminal refresh queued
*/
- this.queuedRefresh = false;
this.cursorState = 0;
this.cursorHidden = false;
this.queue = '';
this.scrollTop = 0;
this.scrollBottom = this.rows - 1;
+ this.customKeydownHandler = null;
// modes
this.applicationKeypad = false;
this.applicationCursor = false;
this.originMode = false;
this.insertMode = false;
- this.wraparoundMode = false;
+ this.wraparoundMode = true; // defaults: xterm - true, vt100 - false
this.normal = null;
// charset
this.prefix = '';
this.postfix = '';
+ // leftover surrogate high from previous write invocation
+ this.surrogate_high = '';
+
/**
* An array of all lines in the entire buffer, including the prompt. The lines are array of
* characters which are 2-length arrays where [0] is an attribute and [1] is the character.
this.tabs;
this.setupStops();
- this.debounceRefresh();
}
inherits(Terminal, EventEmitter);
- // back_color_erase feature for xterm.
+ /**
+ * back_color_erase feature for xterm.
+ */
Terminal.prototype.eraseAttr = function() {
// if (this.is('screen')) return this.defAttr;
return (this.defAttr & ~0x1ff) | (this.curAttr & 0x1ff);
};
- /**
- * Allow refresh to execute only approximately 30 times a second. For commands that pass a
- * significant amount of output to the write function, this prevents the terminal from maxing
- * out the CPU and making the UI unresponsive. While commands can still run beyond what they do
- * on the terminal, it is far better with a debounce in place as every single terminal
- * manipulation does not need to be constructed in the DOM.
- *
- * A side-effect of this is that it makes ^C to interrupt a process seem more responsive.
- */
- Terminal.prototype.debounceRefresh = function () {
- var self = this;
- window.setInterval(function () {
- self.isRefreshing = false;
- if (self.queuedRefresh) {
- self.queuedRefresh = false;
- // Do a full refresh in case multiple refreshes were requested.
- self.refresh(0, self.rows - 1);
- }
- }, 34);
- };
-
/**
* Colors
*/
});
/**
- * Focus the terminal.
- *
- * @public
+ * Focus the terminal. Delegates focus handling to the terminal's DOM element.
*/
Terminal.prototype.focus = function() {
- if (document.activeElement === this.element) {
- return;
- }
+ return this.element.focus();
+ };
- if (this.sendFocus) {
- this.send('\x1b[I');
- }
+ /**
+ * Binds the desired focus behavior on a given terminal object.
+ *
+ * @static
+ */
+ Terminal.bindFocus = function (term) {
+ on(term.element, 'focus', function (ev) {
+ if (term.sendFocus) {
+ term.send('\x1b[I');
+ }
- this.showCursor();
- this.element.focus();
+ term.showCursor();
+ Terminal.focus = term;
+ term.emit('focus', {terminal: term});
+ });
};
+ /**
+ * Blur the terminal. Delegates blur handling to the terminal's DOM element.
+ */
Terminal.prototype.blur = function() {
- if (Terminal.focus !== this) {
- return;
- }
-
- this.cursorState = 0;
- this.refresh(this.y, this.y);
- this.element.blur();
+ return this.element.blur();
+ };
- if (this.sendFocus) {
- this.send('\x1b[O');
- }
- Terminal.focus = null;
+ /**
+ * Binds the desired blur behavior on a given terminal object.
+ *
+ * @static
+ */
+ Terminal.bindBlur = function (term) {
+ on(term.element, 'blur', function (ev) {
+ if (term.sendFocus) {
+ term.send('\x1b[O');
+ }
+ Terminal.focus = null;
+ term.emit('blur', {terminal: term});
+ });
};
/**
Terminal.bindCopy(this);
Terminal.bindCut(this);
Terminal.bindDrop(this);
+ Terminal.bindFocus(this);
+ Terminal.bindBlur(this);
};
- /**
- * Clears all selected text, inside the terminal.
- */
+ /**
+ * Clears all selected text, inside the terminal.
+ */
Terminal.prototype.clearSelection = function() {
var selectionBaseNode = window.getSelection().baseNode;
}
};
- /**
- * This function temporarily enables (leases) the contentEditable value of the terminal, which
- * should be set back to false within 5 seconds at most.
- */
- Terminal.prototype.leaseContentEditable = function (ms, callback) {
+ /**
+ * This function temporarily enables (leases) the contentEditable value of the terminal, which
+ * should be set back to false within 5 seconds at most.
+ */
+ Terminal.prototype.leaseContentEditable = function (ms, callback) {
var term = this;
term.element.contentEditable = true;
+
+ /**
+ * Blur and re-focus instantly. This is due to a weird focus state on Chrome, when setting
+ * contentEditable to true on a focused element.
+ */
+ term.blur();
+ term.focus();
+
setTimeout(function () {
term.element.contentEditable = false;
if (typeof callback == 'function') {
/**
* Hack pasting with keyboard, in order to make it work without contentEditable.
- * When a user types Ctrl + Shift + V or Cmd + V on a Mac, lease the contentEditable value
- * as true.
+ * When a user types Ctrl + Shift + V or Shift + Insert on a non Mac or Cmd + V on a Mac,
+ * lease the contentEditable value as true.
*/
on(term.element, 'keydown', function (ev) {
+ var isEditable = term.element.contentEditable === "true";
+
/**
* If on a Mac, lease the contentEditable value temporarily, when the user presses
- * the Cmd button, in order to cope with some sync issues on Safari.
+ * the Cmd button, in a keydown event order to paste frictionlessly.
*/
- if (term.isMac && ev.keyCode == 91) {
- term.leaseContentEditable(1000);
+ if (term.isMac && ev.metaKey && !isEditable) {
+ term.leaseContentEditable(5000);
}
- if (ev.keyCode == 86) { // keyCode 96 corresponds to "v"
- if (term.isMac && ev.metaKey) {
+ if (!term.isMac && !isEditable) {
+ if ((ev.keyCode == 45 && ev.shiftKey && !ev.ctrlKey) || // Shift + Insert
+ (ev.keyCode == 86 && ev.shiftKey && ev.ctrlKey)) { // Ctrl + Shict + V
term.leaseContentEditable();
}
}
-
- if (!term.isMac && ev.keyCode == 45 && ev.shiftKey && !ev.ctrlKey) {
- // Shift + Insert pastes on windows and many linuxes
- term.leaseContentEditable();
- }
});
/**
};
- /*
+ /**
* Apply key handling to the terminal
+ *
+ * @param {Xterm} term The terminal on which to bind key handling
+ * @static
*/
Terminal.bindKeys = function(term) {
on(term.element, 'keydown', function(ev) {
* @returns {string}
* @static
*/
- Terminal.prepareCopiedTextForClipboard = function (text) {
+ Terminal.prepareCopiedTextForClipboard = function (text) {
var space = String.fromCharCode(32),
nonBreakingSpace = String.fromCharCode(160),
allNonBreakingSpaces = new RegExp(nonBreakingSpace, 'g'),
});
};
- /**
- * Cancel the cut event completely
- */
- Terminal.bindCut = function(term) {
+ /**
+ * Cancel the cut event completely.
+ * @param {Xterm} term The terminal on which to bind the cut event handling functionality.
+ * @static
+ */
+ Terminal.bindCut = function(term) {
on(term.element, 'cut', function (ev) {
ev.preventDefault();
});
};
+ /**
+ * Do not perform the "drop" event. Altering the contents of the
+ * terminal with drag n drop is unwanted behavior.
+ * @param {Xterm} term The terminal on which to bind the drop event handling functionality.
+ * @static
+ */
Terminal.bindDrop = function (term) {
- /*
- * Do not perform the "drop" event. Altering the contents of the
- * terminal with drag n drop is unwanted behavior.
- */
on(term.element, 'drop', function (ev) {
term.cancel(ev, true);
});
};
-
+ /**
+ * Cancel click handling on the given terminal
+ * @param {Xterm} term The terminal on which to bind the click event handling functionality.
+ * @static
+ */
Terminal.click = function (term) {
- /*
- * Do not perform the "drop" event. Altering the contents of the
- * terminal with drag n drop is unwanted behavior.
- */
on(term.element, 'click', function (ev) {
term.cancel(ev, true);
});
};
- /*
+ /**
* Insert the given row to the terminal or produce a new one
* if no row argument is passed. Return the inserted row.
+ * @param {HTMLElement} row (optional) The row to append to the terminal.
*/
Terminal.prototype.insertRow = function (row) {
if (typeof row != 'object') {
* Opens the terminal within an element.
*
* @param {HTMLElement} parent The element to create the terminal within.
- *
- * @public
*/
Terminal.prototype.open = function(parent) {
var self=this, i=0, div;
this.element.classList.add('xterm');
this.element.classList.add('xterm-theme-' + this.theme);
this.element.setAttribute('tabindex', 0);
- this.element.spellcheck = 'false';
- this.element.onfocus = function() {
- self.emit('focus', {terminal: this});
- };
- this.element.onblur = function() {
- self.emit('blur', {terminal: this});
- };
+ this.element.spellcheck = false;
/*
* Create the container that will hold the lines of the terminal and then
};
- // XTerm mouse events
- // http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#Mouse%20Tracking
- // To better understand these
- // the xterm code is very helpful:
- // Relevant files:
- // button.c, charproc.c, misc.c
- // Relevant functions in xterm/button.c:
- // BtnCode, EmitButtonCode, EditorButton, SendMousePosition
+ /**
+ * XTerm mouse events
+ * http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#Mouse%20Tracking
+ * To better understand these
+ * the xterm code is very helpful:
+ * Relevant files:
+ * button.c, charproc.c, misc.c
+ * Relevant functions in xterm/button.c:
+ * BtnCode, EmitButtonCode, EditorButton, SendMousePosition
+ */
Terminal.prototype.bindMouse = function() {
- var el = this.element
- , self = this
- , pressed = 32;
-
- var wheelEvent = 'onmousewheel' in this.context
- ? 'mousewheel'
- : 'DOMMouseScroll';
+ var el = this.element, self = this, pressed = 32;
+ var wheelEvent = ('onmousewheel' in this.context) ? 'mousewheel' : 'DOMMouseScroll';
// mouseup, mousedown, mousewheel
// left click: ^[[M 3<^[[M#3<
sendEvent(button, pos);
- switch (ev.type) {
+ switch (ev.overrideType || ev.type) {
case 'mousedown':
pressed = button;
break;
// 3 = release
// wheel up/down:
// 1, and 2 - with 64 added
- switch (ev.type) {
+ switch (ev.overrideType || ev.type) {
case 'mousedown':
button = ev.button != null
? +ev.button
return {
x: x,
y: y,
- type: ev.type === wheelEvent
+ type: (ev.overrideType || ev.type) === wheelEvent
? 'mousewheel'
- : ev.type
+ : (ev.overrideType || ev.type)
};
}
// fix for odd bug
//if (self.vt200Mouse && !self.normalMouse) {
if (self.vt200Mouse) {
- sendButton({ __proto__: ev, type: 'mouseup' });
+ ev.overrideType = 'mouseup';
+ sendButton(ev);
return self.cancel(ev);
}
/**
* Destroys the terminal.
- *
- * @public
*/
Terminal.prototype.destroy = function() {
this.readable = false;
INVISIBLE: 16
}
- /*
- * Rendering Engine
- *
- * In the screen buffer, each character
- * is stored as a an array with a character
- * and a 32-bit integer.
- * First value: a utf-16 character.
- * Second value:
- * Next 9 bits: background color (0-511).
- * Next 9 bits: foreground color (0-511).
- * Next 14 bits: a mask for misc. flags:
- * 1=bold, 2=underline, 4=blink, 8=inverse, 16=invisible
- */
-
/**
- * Refreshes terminal content within two rows (inclusive).
+ * Refreshes (re-renders) terminal content within two rows (inclusive)
+ *
+ * Rendering Engine:
+ *
+ * In the screen buffer, each character is stored as a an array with a character
+ * and a 32-bit integer:
+ * - First value: a utf-16 character.
+ * - Second value:
+ * - Next 9 bits: background color (0-511).
+ * - Next 9 bits: foreground color (0-511).
+ * - Next 14 bits: a mask for misc. flags:
+ * - 1=bold
+ * - 2=underline
+ * - 4=blink
+ * - 8=inverse
+ * - 16=invisible
*
* @param {number} start The row to start from (between 0 and terminal's height terminal - 1)
* @param {number} end The row to end at (between fromRow and terminal's height terminal - 1)
- *
- * @public
+ * @param {boolean} queue Whether the refresh should ran right now or be queued
*/
- Terminal.prototype.refresh = function(start, end) {
- var x, y, i, line, out, ch, width, data, attr, bg, fg, flags, row, parent, focused = document.activeElement;
+ Terminal.prototype.refresh = function(start, end, queue) {
+ var self = this;
+
+ // queue defaults to true
+ queue = (typeof queue == 'undefined') ? true : queue;
- if (this.isRefreshing) {
- this.queuedRefresh = true;
+ /**
+ * The refresh queue allows refresh to execute only approximately 30 times a second. For
+ * commands that pass a significant amount of output to the write function, this prevents the
+ * terminal from maxing out the CPU and making the UI unresponsive. While commands can still
+ * run beyond what they do on the terminal, it is far better with a debounce in place as
+ * every single terminal manipulation does not need to be constructed in the DOM.
+ *
+ * A side-effect of this is that it makes ^C to interrupt a process seem more responsive.
+ */
+ if (queue) {
+ // If refresh should be queued, order the refresh and return.
+ if (this._refreshIsQueued) {
+ // If a refresh has already been queued, just order a full refresh next
+ this._fullRefreshNext = true;
+ } else {
+ setTimeout(function () {
+ self.refresh(start, end, false);
+ }, 34)
+ this._refreshIsQueued = true;
+ }
return;
}
- this.isRefreshing = true;
+ // If refresh should be run right now (not be queued), release the lock
+ this._refreshIsQueued = false;
+
+ // If multiple refreshes were requested, make a full refresh.
+ if (this._fullRefreshNext) {
+ start = 0;
+ end = this.rows - 1;
+ this._fullRefreshNext = false // reset lock
+ }
+
+ var x, y, i, line, out, ch, ch_width, width, data, attr, bg, fg, flags, row, parent, focused = document.activeElement;
+
+ // If this is a big refresh, remove the terminal rows from the DOM for faster calculations
if (end - start >= this.rows / 2) {
parent = this.element.parentNode;
- if (parent) parent.removeChild(this.element);
+ if (parent) {
+ this.element.removeChild(this.rowContainer);
+ }
}
width = this.cols;
for (; i < width; i++) {
data = line[i][0];
ch = line[i][1];
+ ch_width = line[i][2];
+ if (!ch_width)
+ continue;
if (i === x) data = -1;
if (ch <= ' ') {
out += ' ';
} else {
- if (isWide(ch)) i++;
out += ch;
}
break;
}
if (parent) {
- parent.appendChild(this.element);
+ this.element.appendChild(this.rowContainer);
}
- /*
- * Return focus to previously focused element
- */
- focused.focus();
this.emit('refresh', {element: this.element, start: start, end: end});
};
+ /**
+ * Display the cursor element
+ */
Terminal.prototype.showCursor = function() {
if (!this.cursorState) {
this.cursorState = 1;
}
};
+ /**
+ * Scroll the terminal
+ */
Terminal.prototype.scroll = function() {
var row;
this.updateRange(this.scrollBottom);
};
+ /**
+ * Scroll the display of the terminal
+ * @param {number} disp The number of lines to scroll down (negatives scroll up).
+ */
Terminal.prototype.scrollDisp = function(disp) {
this.ydisp += disp;
/**
* Writes text to the terminal.
- *
* @param {string} text The text to write to the terminal.
- *
- * @public
*/
Terminal.prototype.write = function(data) {
- var l = data.length, i = 0, j, cs, ch;
+ var l = data.length, i = 0, j, cs, ch, code, low, ch_width, row;
this.refreshStart = this.y;
this.refreshEnd = this.y;
this.maxRange();
}
+ // apply leftover surrogate high from last write
+ if (this.surrogate_high) {
+ data = this.surrogate_high + data;
+ this.surrogate_high = '';
+ }
+
for (; i < l; i++) {
ch = data[i];
+
+ // FIXME: higher chars than 0xa0 are not allowed in escape sequences
+ // --> maybe move to default
+ code = data.charCodeAt(i);
+ if (0xD800 <= code && code <= 0xDBFF) {
+ // we got a surrogate high
+ // get surrogate low (next 2 bytes)
+ low = data.charCodeAt(i+1);
+ if (isNaN(low)) {
+ // end of data stream, save surrogate high
+ this.surrogate_high = ch;
+ continue;
+ }
+ code = ((code - 0xD800) * 0x400) + (low - 0xDC00) + 0x10000;
+ ch += data.charAt(i+1);
+ }
+ // surrogate low - already handled above
+ if (0xDC00 <= code && code <= 0xDFFF)
+ continue;
+
switch (this.state) {
case normal:
switch (ch) {
default:
// ' '
+ // calculate print space
+ // expensive call, therefore we save width in line buffer
+ ch_width = wcwidth(code);
+
if (ch >= ' ') {
if (this.charset && this.charset[ch]) {
ch = this.charset[ch];
}
- if (this.x >= this.cols) {
- this.x = 0;
- this.y++;
- if (this.y > this.scrollBottom) {
- this.y--;
- this.scroll();
+ row = this.y + this.ybase;
+
+ // insert combining char in last cell
+ // FIXME: needs handling after cursor jumps
+ if (!ch_width && this.x) {
+
+ // dont overflow left
+ if (this.lines[row][this.x-1]) {
+ if (!this.lines[row][this.x-1][2]) {
+
+ // found empty cell after fullwidth, need to go 2 cells back
+ if (this.lines[row][this.x-2])
+ this.lines[row][this.x-2][1] += ch;
+
+ } else {
+ this.lines[row][this.x-1][1] += ch;
+ }
+ this.updateRange(this.y);
}
+ break;
}
- this.lines[this.y + this.ybase][this.x] = [this.curAttr, ch];
+ // goto next line if ch would overflow
+ // TODO: needs a global min terminal width of 2
+ if (this.x+ch_width-1 >= this.cols) {
+ // autowrap - DECAWM
+ if (this.wraparoundMode) {
+ this.x = 0;
+ this.y++;
+ if (this.y > this.scrollBottom) {
+ this.y--;
+ this.scroll();
+ }
+ } else {
+ this.x = this.cols-1;
+ if(ch_width===2) // FIXME: check for xterm behavior
+ continue;
+ }
+ }
+ row = this.y + this.ybase;
+
+ // insert mode: move characters to right
+ if (this.insertMode) {
+ // do this twice for a fullwidth char
+ for (var moves=0; moves<ch_width; ++moves) {
+ // remove last cell, if it's width is 0
+ // we have to adjust the second last cell as well
+ var removed = this.lines[this.y + this.ybase].pop();
+ if (removed[2]===0
+ && this.lines[row][this.cols-2]
+ && this.lines[row][this.cols-2][2]===2)
+ this.lines[row][this.cols-2] = [this.curAttr, ' ', 1];
+
+ // insert empty cell at cursor
+ this.lines[row].splice(this.x, 0, [this.curAttr, ' ', 1]);
+ }
+ }
+
+ this.lines[row][this.x] = [this.curAttr, ch, ch_width];
this.x++;
this.updateRange(this.y);
- if (isWide(ch)) {
- j = this.y + this.ybase;
- if (this.cols < 2 || this.x >= this.cols) {
- this.lines[j][this.x - 1] = [this.curAttr, ' '];
- break;
- }
- this.lines[j][this.x] = [this.curAttr, ' '];
+ // fullwidth char - set next cell width to zero and advance cursor
+ if (ch_width===2) {
+ this.lines[row][this.x] = [this.curAttr, '', 0];
this.x++;
}
}
this.refresh(this.refreshStart, this.refreshEnd);
};
+ /**
+ * Writes text to the terminal, followed by a break line character (\n).
+ * @param {string} text The text to write to the terminal.
+ */
Terminal.prototype.writeln = function(data) {
this.write(data + '\r\n');
};
- // Key Resources:
- // https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent
+ /**
+ * Attaches a custom keydown handler which is run before keys are processed, giving consumers of
+ * xterm.js ultimate control as to what keys should be processed by the terminal and what keys
+ * should not.
+ * @param {function} customKeydownHandler The custom KeyboardEvent handler to attach. This is a
+ * function that takes a KeyboardEvent, allowing consumers to stop propogation and/or prevent
+ * the default action. The function returns whether the event should be processed by xterm.js.
+ */
+ Terminal.prototype.attachCustomKeydownHandler = function(customKeydownHandler) {
+ this.customKeydownHandler = customKeydownHandler;
+ }
+
+ /**
+ * Handle a keydown event
+ * Key Resources:
+ * - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent
+ * @param {KeyboardEvent} ev The keydown event to be handled.
+ */
Terminal.prototype.keyDown = function(ev) {
+ if (this.customKeydownHandler && !this.customKeydownHandler(ev)) {
+ return;
+ }
var self = this;
var result = this.evaluateKeyEscapeSequence(ev);
* returned value is the new key code to pass to the PTY.
*
* Reference: http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
+ * @param {KeyboardEvent} ev The keyboard event to be translated to key escape sequence.
*/
Terminal.prototype.evaluateKeyEscapeSequence = function(ev) {
var result = {
return result;
};
+ /**
+ * Set the G level of the terminal
+ * @param g
+ */
Terminal.prototype.setgLevel = function(g) {
this.glevel = g;
this.charset = this.charsets[g];
};
+ /**
+ * Set the charset for the given G level of the terminal
+ * @param g
+ * @param charset
+ */
Terminal.prototype.setgCharset = function(g, charset) {
this.charsets[g] = charset;
if (this.glevel === g) {
}
};
+ /**
+ * Handle a keypress event.
+ * Key Resources:
+ * - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent
+ * @param {KeyboardEvent} ev The keypress event to be handled.
+ */
Terminal.prototype.keyPress = function(ev) {
var key;
return false;
};
+ /**
+ * Send data for handling to the terminal
+ * @param {string} data
+ */
Terminal.prototype.send = function(data) {
var self = this;
this.queue += data;
};
+ /**
+ * Ring the bell.
+ * Note: We could do sweet things with webaudio here
+ */
Terminal.prototype.bell = function() {
if (!this.visualBell) return;
var self = this;
if (this.popOnBell) this.focus();
};
+ /**
+ * Log the current state to the console.
+ */
Terminal.prototype.log = function() {
if (!this.debug) return;
if (!this.context.console || !this.context.console.log) return;
this.context.console.log.apply(this.context.console, args);
};
+ /**
+ * Log the current state as error to the console.
+ */
Terminal.prototype.error = function() {
if (!this.debug) return;
if (!this.context.console || !this.context.console.error) return;
*
* @param {number} x The number of columns to resize to.
* @param {number} y The number of rows to resize to.
- *
- * @public
*/
Terminal.prototype.resize = function(x, y) {
var line
// resize cols
j = this.cols;
if (j < x) {
- ch = [this.defAttr, ' ']; // does xterm use the default attr?
+ ch = [this.defAttr, ' ', 1]; // does xterm use the default attr?
i = this.lines.length;
while (i--) {
while (this.lines[i].length < x) {
// There is room above the buffer and there are no empty elements below the line,
// scroll up
this.ybase--;
- this.ydisp--;
addToY++
+ if (this.ydisp > 0) {
+ // Viewport is at the top of the buffer, must increase downwards
+ this.ydisp--;
+ }
} else {
// Add a blank line if there is no buffer left at the top to scroll to, or if there
// are blank lines after the cursor
this.emit('resize', {terminal: this, cols: x, rows: y});
};
+ /**
+ * Updates the range of rows to refresh
+ * @param {number} y The number of rows to refresh next.
+ */
Terminal.prototype.updateRange = function(y) {
if (y < this.refreshStart) this.refreshStart = y;
if (y > this.refreshEnd) this.refreshEnd = y;
// }
};
+ /**
+ * Set the range of refreshing to the maximyum value
+ */
Terminal.prototype.maxRange = function() {
this.refreshStart = 0;
this.refreshEnd = this.rows - 1;
};
+
+
+ /**
+ * Setup the tab stops.
+ * @param {number} i
+ */
Terminal.prototype.setupStops = function(i) {
if (i != null) {
if (!this.tabs[i]) {
}
};
+
+ /**
+ * Move the cursor to the previous tab stop from the given position (default is current).
+ * @param {number} x The position to move the cursor to the previous tab stop.
+ */
Terminal.prototype.prevStop = function(x) {
if (x == null) x = this.x;
while (!this.tabs[--x] && x > 0);
: x < 0 ? 0 : x;
};
+
+ /**
+ * Move the cursor one tab stop forward from the given position (default is current).
+ * @param {number} x The position to move the cursor one tab stop forward.
+ */
Terminal.prototype.nextStop = function(x) {
if (x == null) x = this.x;
while (!this.tabs[++x] && x < this.cols);
: x < 0 ? 0 : x;
};
+
+ /**
+ * Erase in the identified line everything from "x" to the end of the line (right).
+ * @param {number} x The column from which to start erasing to the end of the line.
+ * @param {number} y The line in which to operate.
+ */
Terminal.prototype.eraseRight = function(x, y) {
var line = this.lines[this.ybase + y]
- , ch = [this.eraseAttr(), ' ']; // xterm
+ , ch = [this.eraseAttr(), ' ', 1]; // xterm
for (; x < this.cols; x++) {
this.updateRange(y);
};
+
+
+ /**
+ * Erase in the identified line everything from "x" to the start of the line (left).
+ * @param {number} x The column from which to start erasing to the start of the line.
+ * @param {number} y The line in which to operate.
+ */
Terminal.prototype.eraseLeft = function(x, y) {
var line = this.lines[this.ybase + y]
- , ch = [this.eraseAttr(), ' ']; // xterm
+ , ch = [this.eraseAttr(), ' ', 1]; // xterm
x++;
while (x--) line[x] = ch;
this.updateRange(y);
};
+
+ /**
+ * Erase all content in the given line
+ * @param {number} y The line to erase all of its contents.
+ */
Terminal.prototype.eraseLine = function(y) {
this.eraseRight(0, y);
};
+
+ /**
+ * Return the data array of a blank line/
+ * @param {number} cur First bunch of data for each "blank" character.
+ */
Terminal.prototype.blankLine = function(cur) {
var attr = cur
? this.eraseAttr()
: this.defAttr;
- var ch = [attr, ' ']
+ var ch = [attr, ' ', 1] // width defaults to 1 halfwidth character
, line = []
, i = 0;
return line;
};
+
+ /**
+ * If cur return the back color xterm feature attribute. Else return defAttr.
+ * @param {object} cur
+ */
Terminal.prototype.ch = function(cur) {
return cur
- ? [this.eraseAttr(), ' ']
- : [this.defAttr, ' '];
+ ? [this.eraseAttr(), ' ', 1]
+ : [this.defAttr, ' ', 1];
};
+
+ /**
+ * Evaluate if the current erminal is the given argument.
+ * @param {object} term The terminal to evaluate
+ */
Terminal.prototype.is = function(term) {
var name = this.termName;
return (name + '').indexOf(term) === 0;
};
+
+ /**
+ * Emit the 'data' event and populate the given data.
+ * @param {string} data The data to populate in the event.
+ */
Terminal.prototype.handler = function(data) {
this.emit('data', data);
};
+
+ /**
+ * Emit the 'title' event and populate the given title.
+ * @param {string} title The title to populate in the event.
+ */
Terminal.prototype.handleTitle = function(title) {
this.emit('title', title);
};
+
/**
* ESC
*/
- // ESC D Index (IND is 0x84).
+ /**
+ * ESC D Index (IND is 0x84).
+ */
Terminal.prototype.index = function() {
this.y++;
if (this.y > this.scrollBottom) {
this.state = normal;
};
- // ESC M Reverse Index (RI is 0x8d).
+
+ /**
+ * ESC M Reverse Index (RI is 0x8d).
+ */
Terminal.prototype.reverseIndex = function() {
var j;
this.y--;
this.state = normal;
};
- // ESC c Full Reset (RIS).
+
+ /**
+ * ESC c Full Reset (RIS).
+ */
Terminal.prototype.reset = function() {
this.options.rows = this.rows;
this.options.cols = this.cols;
this.refresh(0, this.rows - 1);
};
- // ESC H Tab Set (HTS is 0x88).
+
+ /**
+ * ESC H Tab Set (HTS is 0x88).
+ */
Terminal.prototype.tabSet = function() {
this.tabs[this.x] = true;
this.state = normal;
};
+
/**
* CSI
*/
- // CSI Ps A
- // Cursor Up Ps Times (default = 1) (CUU).
+ /**
+ * CSI Ps A
+ * Cursor Up Ps Times (default = 1) (CUU).
+ */
Terminal.prototype.cursorUp = function(params) {
var param = params[0];
if (param < 1) param = 1;
if (this.y < 0) this.y = 0;
};
- // CSI Ps B
- // Cursor Down Ps Times (default = 1) (CUD).
+
+ /**
+ * CSI Ps B
+ * Cursor Down Ps Times (default = 1) (CUD).
+ */
Terminal.prototype.cursorDown = function(params) {
var param = params[0];
if (param < 1) param = 1;
}
};
- // CSI Ps C
- // Cursor Forward Ps Times (default = 1) (CUF).
+
+ /**
+ * CSI Ps C
+ * Cursor Forward Ps Times (default = 1) (CUF).
+ */
Terminal.prototype.cursorForward = function(params) {
var param = params[0];
if (param < 1) param = 1;
}
};
- // CSI Ps D
- // Cursor Backward Ps Times (default = 1) (CUB).
+
+ /**
+ * CSI Ps D
+ * Cursor Backward Ps Times (default = 1) (CUB).
+ */
Terminal.prototype.cursorBackward = function(params) {
var param = params[0];
if (param < 1) param = 1;
if (this.x < 0) this.x = 0;
};
- // CSI Ps ; Ps H
- // Cursor Position [row;column] (default = [1,1]) (CUP).
+
+ /**
+ * CSI Ps ; Ps H
+ * Cursor Position [row;column] (default = [1,1]) (CUP).
+ */
Terminal.prototype.cursorPos = function(params) {
var row, col;
this.y = row;
};
- // CSI Ps J Erase in Display (ED).
- // Ps = 0 -> Erase Below (default).
- // Ps = 1 -> Erase Above.
- // Ps = 2 -> Erase All.
- // Ps = 3 -> Erase Saved Lines (xterm).
- // CSI ? Ps J
- // Erase in Display (DECSED).
- // Ps = 0 -> Selective Erase Below (default).
- // Ps = 1 -> Selective Erase Above.
- // Ps = 2 -> Selective Erase All.
+
+ /**
+ * CSI Ps J Erase in Display (ED).
+ * Ps = 0 -> Erase Below (default).
+ * Ps = 1 -> Erase Above.
+ * Ps = 2 -> Erase All.
+ * Ps = 3 -> Erase Saved Lines (xterm).
+ * CSI ? Ps J
+ * Erase in Display (DECSED).
+ * Ps = 0 -> Selective Erase Below (default).
+ * Ps = 1 -> Selective Erase Above.
+ * Ps = 2 -> Selective Erase All.
+ */
Terminal.prototype.eraseInDisplay = function(params) {
var j;
switch (params[0]) {
}
};
- // CSI Ps K Erase in Line (EL).
- // Ps = 0 -> Erase to Right (default).
- // Ps = 1 -> Erase to Left.
- // Ps = 2 -> Erase All.
- // CSI ? Ps K
- // Erase in Line (DECSEL).
- // Ps = 0 -> Selective Erase to Right (default).
- // Ps = 1 -> Selective Erase to Left.
- // Ps = 2 -> Selective Erase All.
+
+ /**
+ * CSI Ps K Erase in Line (EL).
+ * Ps = 0 -> Erase to Right (default).
+ * Ps = 1 -> Erase to Left.
+ * Ps = 2 -> Erase All.
+ * CSI ? Ps K
+ * Erase in Line (DECSEL).
+ * Ps = 0 -> Selective Erase to Right (default).
+ * Ps = 1 -> Selective Erase to Left.
+ * Ps = 2 -> Selective Erase All.
+ */
Terminal.prototype.eraseInLine = function(params) {
switch (params[0]) {
case 0:
}
};
- // CSI Pm m Character Attributes (SGR).
- // Ps = 0 -> Normal (default).
- // Ps = 1 -> Bold.
- // Ps = 4 -> Underlined.
- // Ps = 5 -> Blink (appears as Bold).
- // Ps = 7 -> Inverse.
- // Ps = 8 -> Invisible, i.e., hidden (VT300).
- // Ps = 2 2 -> Normal (neither bold nor faint).
- // Ps = 2 4 -> Not underlined.
- // Ps = 2 5 -> Steady (not blinking).
- // Ps = 2 7 -> Positive (not inverse).
- // Ps = 2 8 -> Visible, i.e., not hidden (VT300).
- // Ps = 3 0 -> Set foreground color to Black.
- // Ps = 3 1 -> Set foreground color to Red.
- // Ps = 3 2 -> Set foreground color to Green.
- // Ps = 3 3 -> Set foreground color to Yellow.
- // Ps = 3 4 -> Set foreground color to Blue.
- // Ps = 3 5 -> Set foreground color to Magenta.
- // Ps = 3 6 -> Set foreground color to Cyan.
- // Ps = 3 7 -> Set foreground color to White.
- // Ps = 3 9 -> Set foreground color to default (original).
- // Ps = 4 0 -> Set background color to Black.
- // Ps = 4 1 -> Set background color to Red.
- // Ps = 4 2 -> Set background color to Green.
- // Ps = 4 3 -> Set background color to Yellow.
- // Ps = 4 4 -> Set background color to Blue.
- // Ps = 4 5 -> Set background color to Magenta.
- // Ps = 4 6 -> Set background color to Cyan.
- // Ps = 4 7 -> Set background color to White.
- // Ps = 4 9 -> Set background color to default (original).
-
- // If 16-color support is compiled, the following apply. Assume
- // that xterm's resources are set so that the ISO color codes are
- // the first 8 of a set of 16. Then the aixterm colors are the
- // bright versions of the ISO colors:
- // Ps = 9 0 -> Set foreground color to Black.
- // Ps = 9 1 -> Set foreground color to Red.
- // Ps = 9 2 -> Set foreground color to Green.
- // Ps = 9 3 -> Set foreground color to Yellow.
- // Ps = 9 4 -> Set foreground color to Blue.
- // Ps = 9 5 -> Set foreground color to Magenta.
- // Ps = 9 6 -> Set foreground color to Cyan.
- // Ps = 9 7 -> Set foreground color to White.
- // Ps = 1 0 0 -> Set background color to Black.
- // Ps = 1 0 1 -> Set background color to Red.
- // Ps = 1 0 2 -> Set background color to Green.
- // Ps = 1 0 3 -> Set background color to Yellow.
- // Ps = 1 0 4 -> Set background color to Blue.
- // Ps = 1 0 5 -> Set background color to Magenta.
- // Ps = 1 0 6 -> Set background color to Cyan.
- // Ps = 1 0 7 -> Set background color to White.
-
- // If xterm is compiled with the 16-color support disabled, it
- // supports the following, from rxvt:
- // Ps = 1 0 0 -> Set foreground and background color to
- // default.
-
- // If 88- or 256-color support is compiled, the following apply.
- // Ps = 3 8 ; 5 ; Ps -> Set foreground color to the second
- // Ps.
- // Ps = 4 8 ; 5 ; Ps -> Set background color to the second
- // Ps.
+
+ /**
+ * CSI Pm m Character Attributes (SGR).
+ * Ps = 0 -> Normal (default).
+ * Ps = 1 -> Bold.
+ * Ps = 4 -> Underlined.
+ * Ps = 5 -> Blink (appears as Bold).
+ * Ps = 7 -> Inverse.
+ * Ps = 8 -> Invisible, i.e., hidden (VT300).
+ * Ps = 2 2 -> Normal (neither bold nor faint).
+ * Ps = 2 4 -> Not underlined.
+ * Ps = 2 5 -> Steady (not blinking).
+ * Ps = 2 7 -> Positive (not inverse).
+ * Ps = 2 8 -> Visible, i.e., not hidden (VT300).
+ * Ps = 3 0 -> Set foreground color to Black.
+ * Ps = 3 1 -> Set foreground color to Red.
+ * Ps = 3 2 -> Set foreground color to Green.
+ * Ps = 3 3 -> Set foreground color to Yellow.
+ * Ps = 3 4 -> Set foreground color to Blue.
+ * Ps = 3 5 -> Set foreground color to Magenta.
+ * Ps = 3 6 -> Set foreground color to Cyan.
+ * Ps = 3 7 -> Set foreground color to White.
+ * Ps = 3 9 -> Set foreground color to default (original).
+ * Ps = 4 0 -> Set background color to Black.
+ * Ps = 4 1 -> Set background color to Red.
+ * Ps = 4 2 -> Set background color to Green.
+ * Ps = 4 3 -> Set background color to Yellow.
+ * Ps = 4 4 -> Set background color to Blue.
+ * Ps = 4 5 -> Set background color to Magenta.
+ * Ps = 4 6 -> Set background color to Cyan.
+ * Ps = 4 7 -> Set background color to White.
+ * Ps = 4 9 -> Set background color to default (original).
+ *
+ * If 16-color support is compiled, the following apply. Assume
+ * that xterm's resources are set so that the ISO color codes are
+ * the first 8 of a set of 16. Then the aixterm colors are the
+ * bright versions of the ISO colors:
+ * Ps = 9 0 -> Set foreground color to Black.
+ * Ps = 9 1 -> Set foreground color to Red.
+ * Ps = 9 2 -> Set foreground color to Green.
+ * Ps = 9 3 -> Set foreground color to Yellow.
+ * Ps = 9 4 -> Set foreground color to Blue.
+ * Ps = 9 5 -> Set foreground color to Magenta.
+ * Ps = 9 6 -> Set foreground color to Cyan.
+ * Ps = 9 7 -> Set foreground color to White.
+ * Ps = 1 0 0 -> Set background color to Black.
+ * Ps = 1 0 1 -> Set background color to Red.
+ * Ps = 1 0 2 -> Set background color to Green.
+ * Ps = 1 0 3 -> Set background color to Yellow.
+ * Ps = 1 0 4 -> Set background color to Blue.
+ * Ps = 1 0 5 -> Set background color to Magenta.
+ * Ps = 1 0 6 -> Set background color to Cyan.
+ * Ps = 1 0 7 -> Set background color to White.
+ *
+ * If xterm is compiled with the 16-color support disabled, it
+ * supports the following, from rxvt:
+ * Ps = 1 0 0 -> Set foreground and background color to
+ * default.
+ *
+ * If 88- or 256-color support is compiled, the following apply.
+ * Ps = 3 8 ; 5 ; Ps -> Set foreground color to the second
+ * Ps.
+ * Ps = 4 8 ; 5 ; Ps -> Set background color to the second
+ * Ps.
+ */
Terminal.prototype.charAttributes = function(params) {
// Optimize a single SGR0.
if (params.length === 1 && params[0] === 0) {
this.curAttr = (flags << 18) | (fg << 9) | bg;
};
- // CSI Ps n Device Status Report (DSR).
- // Ps = 5 -> Status Report. Result (``OK'') is
- // CSI 0 n
- // Ps = 6 -> Report Cursor Position (CPR) [row;column].
- // Result is
- // CSI r ; c R
- // CSI ? Ps n
- // Device Status Report (DSR, DEC-specific).
- // Ps = 6 -> Report Cursor Position (CPR) [row;column] as CSI
- // ? r ; c R (assumes page is zero).
- // Ps = 1 5 -> Report Printer status as CSI ? 1 0 n (ready).
- // or CSI ? 1 1 n (not ready).
- // Ps = 2 5 -> Report UDK status as CSI ? 2 0 n (unlocked)
- // or CSI ? 2 1 n (locked).
- // Ps = 2 6 -> Report Keyboard status as
- // CSI ? 2 7 ; 1 ; 0 ; 0 n (North American).
- // The last two parameters apply to VT400 & up, and denote key-
- // board ready and LK01 respectively.
- // Ps = 5 3 -> Report Locator status as
- // CSI ? 5 3 n Locator available, if compiled-in, or
- // CSI ? 5 0 n No Locator, if not.
+
+ /**
+ * CSI Ps n Device Status Report (DSR).
+ * Ps = 5 -> Status Report. Result (``OK'') is
+ * CSI 0 n
+ * Ps = 6 -> Report Cursor Position (CPR) [row;column].
+ * Result is
+ * CSI r ; c R
+ * CSI ? Ps n
+ * Device Status Report (DSR, DEC-specific).
+ * Ps = 6 -> Report Cursor Position (CPR) [row;column] as CSI
+ * ? r ; c R (assumes page is zero).
+ * Ps = 1 5 -> Report Printer status as CSI ? 1 0 n (ready).
+ * or CSI ? 1 1 n (not ready).
+ * Ps = 2 5 -> Report UDK status as CSI ? 2 0 n (unlocked)
+ * or CSI ? 2 1 n (locked).
+ * Ps = 2 6 -> Report Keyboard status as
+ * CSI ? 2 7 ; 1 ; 0 ; 0 n (North American).
+ * The last two parameters apply to VT400 & up, and denote key-
+ * board ready and LK01 respectively.
+ * Ps = 5 3 -> Report Locator status as
+ * CSI ? 5 3 n Locator available, if compiled-in, or
+ * CSI ? 5 0 n No Locator, if not.
+ */
Terminal.prototype.deviceStatus = function(params) {
if (!this.prefix) {
switch (params[0]) {
}
};
+
/**
* Additions
*/
- // CSI Ps @
- // Insert Ps (Blank) Character(s) (default = 1) (ICH).
+ /**
+ * CSI Ps @
+ * Insert Ps (Blank) Character(s) (default = 1) (ICH).
+ */
Terminal.prototype.insertChars = function(params) {
var param, row, j, ch;
row = this.y + this.ybase;
j = this.x;
- ch = [this.eraseAttr(), ' ']; // xterm
+ ch = [this.eraseAttr(), ' ', 1]; // xterm
while (param-- && j < this.cols) {
this.lines[row].splice(j++, 0, ch);
}
};
- // CSI Ps E
- // Cursor Next Line Ps Times (default = 1) (CNL).
- // same as CSI Ps B ?
+ /**
+ * CSI Ps E
+ * Cursor Next Line Ps Times (default = 1) (CNL).
+ * same as CSI Ps B ?
+ */
Terminal.prototype.cursorNextLine = function(params) {
var param = params[0];
if (param < 1) param = 1;
this.x = 0;
};
- // CSI Ps F
- // Cursor Preceding Line Ps Times (default = 1) (CNL).
- // reuse CSI Ps A ?
+
+ /**
+ * CSI Ps F
+ * Cursor Preceding Line Ps Times (default = 1) (CNL).
+ * reuse CSI Ps A ?
+ */
Terminal.prototype.cursorPrecedingLine = function(params) {
var param = params[0];
if (param < 1) param = 1;
this.x = 0;
};
- // CSI Ps G
- // Cursor Character Absolute [column] (default = [row,1]) (CHA).
+
+ /**
+ * CSI Ps G
+ * Cursor Character Absolute [column] (default = [row,1]) (CHA).
+ */
Terminal.prototype.cursorCharAbsolute = function(params) {
var param = params[0];
if (param < 1) param = 1;
this.x = param - 1;
};
- // CSI Ps L
- // Insert Ps Line(s) (default = 1) (IL).
+
+ /**
+ * CSI Ps L
+ * Insert Ps Line(s) (default = 1) (IL).
+ */
Terminal.prototype.insertLines = function(params) {
var param, row, j;
this.updateRange(this.scrollBottom);
};
- // CSI Ps M
- // Delete Ps Line(s) (default = 1) (DL).
+
+ /**
+ * CSI Ps M
+ * Delete Ps Line(s) (default = 1) (DL).
+ */
Terminal.prototype.deleteLines = function(params) {
var param, row, j;
this.updateRange(this.scrollBottom);
};
- // CSI Ps P
- // Delete Ps Character(s) (default = 1) (DCH).
+
+ /**
+ * CSI Ps P
+ * Delete Ps Character(s) (default = 1) (DCH).
+ */
Terminal.prototype.deleteChars = function(params) {
var param, row, ch;
if (param < 1) param = 1;
row = this.y + this.ybase;
- ch = [this.eraseAttr(), ' ']; // xterm
+ ch = [this.eraseAttr(), ' ', 1]; // xterm
while (param--) {
this.lines[row].splice(this.x, 1);
}
};
- // CSI Ps X
- // Erase Ps Character(s) (default = 1) (ECH).
+ /**
+ * CSI Ps X
+ * Erase Ps Character(s) (default = 1) (ECH).
+ */
Terminal.prototype.eraseChars = function(params) {
var param, row, j, ch;
row = this.y + this.ybase;
j = this.x;
- ch = [this.eraseAttr(), ' ']; // xterm
+ ch = [this.eraseAttr(), ' ', 1]; // xterm
while (param-- && j < this.cols) {
this.lines[row][j++] = ch;
}
};
- // CSI Pm ` Character Position Absolute
- // [column] (default = [row,1]) (HPA).
+ /**
+ * CSI Pm ` Character Position Absolute
+ * [column] (default = [row,1]) (HPA).
+ */
Terminal.prototype.charPosAbsolute = function(params) {
var param = params[0];
if (param < 1) param = 1;
}
};
- // 141 61 a * HPR -
- // Horizontal Position Relative
- // reuse CSI Ps C ?
+
+ /**
+ * 141 61 a * HPR -
+ * Horizontal Position Relative
+ * reuse CSI Ps C ?
+ */
Terminal.prototype.HPositionRelative = function(params) {
var param = params[0];
if (param < 1) param = 1;
}
};
- // CSI Ps c Send Device Attributes (Primary DA).
- // Ps = 0 or omitted -> request attributes from terminal. The
- // response depends on the decTerminalID resource setting.
- // -> CSI ? 1 ; 2 c (``VT100 with Advanced Video Option'')
- // -> CSI ? 1 ; 0 c (``VT101 with No Options'')
- // -> CSI ? 6 c (``VT102'')
- // -> CSI ? 6 0 ; 1 ; 2 ; 6 ; 8 ; 9 ; 1 5 ; c (``VT220'')
- // The VT100-style response parameters do not mean anything by
- // themselves. VT220 parameters do, telling the host what fea-
- // tures the terminal supports:
- // Ps = 1 -> 132-columns.
- // Ps = 2 -> Printer.
- // Ps = 6 -> Selective erase.
- // Ps = 8 -> User-defined keys.
- // Ps = 9 -> National replacement character sets.
- // Ps = 1 5 -> Technical characters.
- // Ps = 2 2 -> ANSI color, e.g., VT525.
- // Ps = 2 9 -> ANSI text locator (i.e., DEC Locator mode).
- // CSI > Ps c
- // Send Device Attributes (Secondary DA).
- // Ps = 0 or omitted -> request the terminal's identification
- // code. The response depends on the decTerminalID resource set-
- // ting. It should apply only to VT220 and up, but xterm extends
- // this to VT100.
- // -> CSI > Pp ; Pv ; Pc c
- // where Pp denotes the terminal type
- // Pp = 0 -> ``VT100''.
- // Pp = 1 -> ``VT220''.
- // and Pv is the firmware version (for xterm, this was originally
- // the XFree86 patch number, starting with 95). In a DEC termi-
- // nal, Pc indicates the ROM cartridge registration number and is
- // always zero.
- // More information:
- // xterm/charproc.c - line 2012, for more information.
- // vim responds with ^[[?0c or ^[[?1c after the terminal's response (?)
+
+ /**
+ * CSI Ps c Send Device Attributes (Primary DA).
+ * Ps = 0 or omitted -> request attributes from terminal. The
+ * response depends on the decTerminalID resource setting.
+ * -> CSI ? 1 ; 2 c (``VT100 with Advanced Video Option'')
+ * -> CSI ? 1 ; 0 c (``VT101 with No Options'')
+ * -> CSI ? 6 c (``VT102'')
+ * -> CSI ? 6 0 ; 1 ; 2 ; 6 ; 8 ; 9 ; 1 5 ; c (``VT220'')
+ * The VT100-style response parameters do not mean anything by
+ * themselves. VT220 parameters do, telling the host what fea-
+ * tures the terminal supports:
+ * Ps = 1 -> 132-columns.
+ * Ps = 2 -> Printer.
+ * Ps = 6 -> Selective erase.
+ * Ps = 8 -> User-defined keys.
+ * Ps = 9 -> National replacement character sets.
+ * Ps = 1 5 -> Technical characters.
+ * Ps = 2 2 -> ANSI color, e.g., VT525.
+ * Ps = 2 9 -> ANSI text locator (i.e., DEC Locator mode).
+ * CSI > Ps c
+ * Send Device Attributes (Secondary DA).
+ * Ps = 0 or omitted -> request the terminal's identification
+ * code. The response depends on the decTerminalID resource set-
+ * ting. It should apply only to VT220 and up, but xterm extends
+ * this to VT100.
+ * -> CSI > Pp ; Pv ; Pc c
+ * where Pp denotes the terminal type
+ * Pp = 0 -> ``VT100''.
+ * Pp = 1 -> ``VT220''.
+ * and Pv is the firmware version (for xterm, this was originally
+ * the XFree86 patch number, starting with 95). In a DEC termi-
+ * nal, Pc indicates the ROM cartridge registration number and is
+ * always zero.
+ * More information:
+ * xterm/charproc.c - line 2012, for more information.
+ * vim responds with ^[[?0c or ^[[?1c after the terminal's response (?)
+ */
Terminal.prototype.sendDeviceAttributes = function(params) {
if (params[0] > 0) return;
}
};
- // CSI Pm d
- // Line Position Absolute [row] (default = [1,column]) (VPA).
+
+ /**
+ * CSI Pm d
+ * Line Position Absolute [row] (default = [1,column]) (VPA).
+ */
Terminal.prototype.linePosAbsolute = function(params) {
var param = params[0];
if (param < 1) param = 1;
}
};
- // 145 65 e * VPR - Vertical Position Relative
- // reuse CSI Ps B ?
+
+ /**
+ * 145 65 e * VPR - Vertical Position Relative
+ * reuse CSI Ps B ?
+ */
Terminal.prototype.VPositionRelative = function(params) {
var param = params[0];
if (param < 1) param = 1;
}
};
- // CSI Ps ; Ps f
- // Horizontal and Vertical Position [row;column] (default =
- // [1,1]) (HVP).
+
+ /**
+ * CSI Ps ; Ps f
+ * Horizontal and Vertical Position [row;column] (default =
+ * [1,1]) (HVP).
+ */
Terminal.prototype.HVPosition = function(params) {
if (params[0] < 1) params[0] = 1;
if (params[1] < 1) params[1] = 1;
}
};
- // CSI Pm h Set Mode (SM).
- // Ps = 2 -> Keyboard Action Mode (AM).
- // Ps = 4 -> Insert Mode (IRM).
- // Ps = 1 2 -> Send/receive (SRM).
- // Ps = 2 0 -> Automatic Newline (LNM).
- // CSI ? Pm h
- // DEC Private Mode Set (DECSET).
- // Ps = 1 -> Application Cursor Keys (DECCKM).
- // Ps = 2 -> Designate USASCII for character sets G0-G3
- // (DECANM), and set VT100 mode.
- // Ps = 3 -> 132 Column Mode (DECCOLM).
- // Ps = 4 -> Smooth (Slow) Scroll (DECSCLM).
- // Ps = 5 -> Reverse Video (DECSCNM).
- // Ps = 6 -> Origin Mode (DECOM).
- // Ps = 7 -> Wraparound Mode (DECAWM).
- // Ps = 8 -> Auto-repeat Keys (DECARM).
- // Ps = 9 -> Send Mouse X & Y on button press. See the sec-
- // tion Mouse Tracking.
- // Ps = 1 0 -> Show toolbar (rxvt).
- // Ps = 1 2 -> Start Blinking Cursor (att610).
- // Ps = 1 8 -> Print form feed (DECPFF).
- // Ps = 1 9 -> Set print extent to full screen (DECPEX).
- // Ps = 2 5 -> Show Cursor (DECTCEM).
- // Ps = 3 0 -> Show scrollbar (rxvt).
- // Ps = 3 5 -> Enable font-shifting functions (rxvt).
- // Ps = 3 8 -> Enter Tektronix Mode (DECTEK).
- // Ps = 4 0 -> Allow 80 -> 132 Mode.
- // Ps = 4 1 -> more(1) fix (see curses resource).
- // Ps = 4 2 -> Enable Nation Replacement Character sets (DECN-
- // RCM).
- // Ps = 4 4 -> Turn On Margin Bell.
- // Ps = 4 5 -> Reverse-wraparound Mode.
- // Ps = 4 6 -> Start Logging. This is normally disabled by a
- // compile-time option.
- // Ps = 4 7 -> Use Alternate Screen Buffer. (This may be dis-
- // abled by the titeInhibit resource).
- // Ps = 6 6 -> Application keypad (DECNKM).
- // Ps = 6 7 -> Backarrow key sends backspace (DECBKM).
- // Ps = 1 0 0 0 -> Send Mouse X & Y on button press and
- // release. See the section Mouse Tracking.
- // Ps = 1 0 0 1 -> Use Hilite Mouse Tracking.
- // Ps = 1 0 0 2 -> Use Cell Motion Mouse Tracking.
- // Ps = 1 0 0 3 -> Use All Motion Mouse Tracking.
- // Ps = 1 0 0 4 -> Send FocusIn/FocusOut events.
- // Ps = 1 0 0 5 -> Enable Extended Mouse Mode.
- // Ps = 1 0 1 0 -> Scroll to bottom on tty output (rxvt).
- // Ps = 1 0 1 1 -> Scroll to bottom on key press (rxvt).
- // Ps = 1 0 3 4 -> Interpret "meta" key, sets eighth bit.
- // (enables the eightBitInput resource).
- // Ps = 1 0 3 5 -> Enable special modifiers for Alt and Num-
- // Lock keys. (This enables the numLock resource).
- // Ps = 1 0 3 6 -> Send ESC when Meta modifies a key. (This
- // enables the metaSendsEscape resource).
- // Ps = 1 0 3 7 -> Send DEL from the editing-keypad Delete
- // key.
- // Ps = 1 0 3 9 -> Send ESC when Alt modifies a key. (This
- // enables the altSendsEscape resource).
- // Ps = 1 0 4 0 -> Keep selection even if not highlighted.
- // (This enables the keepSelection resource).
- // Ps = 1 0 4 1 -> Use the CLIPBOARD selection. (This enables
- // the selectToClipboard resource).
- // Ps = 1 0 4 2 -> Enable Urgency window manager hint when
- // Control-G is received. (This enables the bellIsUrgent
- // resource).
- // Ps = 1 0 4 3 -> Enable raising of the window when Control-G
- // is received. (enables the popOnBell resource).
- // Ps = 1 0 4 7 -> Use Alternate Screen Buffer. (This may be
- // disabled by the titeInhibit resource).
- // Ps = 1 0 4 8 -> Save cursor as in DECSC. (This may be dis-
- // abled by the titeInhibit resource).
- // Ps = 1 0 4 9 -> Save cursor as in DECSC and use Alternate
- // Screen Buffer, clearing it first. (This may be disabled by
- // the titeInhibit resource). This combines the effects of the 1
- // 0 4 7 and 1 0 4 8 modes. Use this with terminfo-based
- // applications rather than the 4 7 mode.
- // Ps = 1 0 5 0 -> Set terminfo/termcap function-key mode.
- // Ps = 1 0 5 1 -> Set Sun function-key mode.
- // Ps = 1 0 5 2 -> Set HP function-key mode.
- // Ps = 1 0 5 3 -> Set SCO function-key mode.
- // Ps = 1 0 6 0 -> Set legacy keyboard emulation (X11R6).
- // Ps = 1 0 6 1 -> Set VT220 keyboard emulation.
- // Ps = 2 0 0 4 -> Set bracketed paste mode.
- // Modes:
- // http://vt100.net/docs/vt220-rm/chapter4.html
+
+ /**
+ * CSI Pm h Set Mode (SM).
+ * Ps = 2 -> Keyboard Action Mode (AM).
+ * Ps = 4 -> Insert Mode (IRM).
+ * Ps = 1 2 -> Send/receive (SRM).
+ * Ps = 2 0 -> Automatic Newline (LNM).
+ * CSI ? Pm h
+ * DEC Private Mode Set (DECSET).
+ * Ps = 1 -> Application Cursor Keys (DECCKM).
+ * Ps = 2 -> Designate USASCII for character sets G0-G3
+ * (DECANM), and set VT100 mode.
+ * Ps = 3 -> 132 Column Mode (DECCOLM).
+ * Ps = 4 -> Smooth (Slow) Scroll (DECSCLM).
+ * Ps = 5 -> Reverse Video (DECSCNM).
+ * Ps = 6 -> Origin Mode (DECOM).
+ * Ps = 7 -> Wraparound Mode (DECAWM).
+ * Ps = 8 -> Auto-repeat Keys (DECARM).
+ * Ps = 9 -> Send Mouse X & Y on button press. See the sec-
+ * tion Mouse Tracking.
+ * Ps = 1 0 -> Show toolbar (rxvt).
+ * Ps = 1 2 -> Start Blinking Cursor (att610).
+ * Ps = 1 8 -> Print form feed (DECPFF).
+ * Ps = 1 9 -> Set print extent to full screen (DECPEX).
+ * Ps = 2 5 -> Show Cursor (DECTCEM).
+ * Ps = 3 0 -> Show scrollbar (rxvt).
+ * Ps = 3 5 -> Enable font-shifting functions (rxvt).
+ * Ps = 3 8 -> Enter Tektronix Mode (DECTEK).
+ * Ps = 4 0 -> Allow 80 -> 132 Mode.
+ * Ps = 4 1 -> more(1) fix (see curses resource).
+ * Ps = 4 2 -> Enable Nation Replacement Character sets (DECN-
+ * RCM).
+ * Ps = 4 4 -> Turn On Margin Bell.
+ * Ps = 4 5 -> Reverse-wraparound Mode.
+ * Ps = 4 6 -> Start Logging. This is normally disabled by a
+ * compile-time option.
+ * Ps = 4 7 -> Use Alternate Screen Buffer. (This may be dis-
+ * abled by the titeInhibit resource).
+ * Ps = 6 6 -> Application keypad (DECNKM).
+ * Ps = 6 7 -> Backarrow key sends backspace (DECBKM).
+ * Ps = 1 0 0 0 -> Send Mouse X & Y on button press and
+ * release. See the section Mouse Tracking.
+ * Ps = 1 0 0 1 -> Use Hilite Mouse Tracking.
+ * Ps = 1 0 0 2 -> Use Cell Motion Mouse Tracking.
+ * Ps = 1 0 0 3 -> Use All Motion Mouse Tracking.
+ * Ps = 1 0 0 4 -> Send FocusIn/FocusOut events.
+ * Ps = 1 0 0 5 -> Enable Extended Mouse Mode.
+ * Ps = 1 0 1 0 -> Scroll to bottom on tty output (rxvt).
+ * Ps = 1 0 1 1 -> Scroll to bottom on key press (rxvt).
+ * Ps = 1 0 3 4 -> Interpret "meta" key, sets eighth bit.
+ * (enables the eightBitInput resource).
+ * Ps = 1 0 3 5 -> Enable special modifiers for Alt and Num-
+ * Lock keys. (This enables the numLock resource).
+ * Ps = 1 0 3 6 -> Send ESC when Meta modifies a key. (This
+ * enables the metaSendsEscape resource).
+ * Ps = 1 0 3 7 -> Send DEL from the editing-keypad Delete
+ * key.
+ * Ps = 1 0 3 9 -> Send ESC when Alt modifies a key. (This
+ * enables the altSendsEscape resource).
+ * Ps = 1 0 4 0 -> Keep selection even if not highlighted.
+ * (This enables the keepSelection resource).
+ * Ps = 1 0 4 1 -> Use the CLIPBOARD selection. (This enables
+ * the selectToClipboard resource).
+ * Ps = 1 0 4 2 -> Enable Urgency window manager hint when
+ * Control-G is received. (This enables the bellIsUrgent
+ * resource).
+ * Ps = 1 0 4 3 -> Enable raising of the window when Control-G
+ * is received. (enables the popOnBell resource).
+ * Ps = 1 0 4 7 -> Use Alternate Screen Buffer. (This may be
+ * disabled by the titeInhibit resource).
+ * Ps = 1 0 4 8 -> Save cursor as in DECSC. (This may be dis-
+ * abled by the titeInhibit resource).
+ * Ps = 1 0 4 9 -> Save cursor as in DECSC and use Alternate
+ * Screen Buffer, clearing it first. (This may be disabled by
+ * the titeInhibit resource). This combines the effects of the 1
+ * 0 4 7 and 1 0 4 8 modes. Use this with terminfo-based
+ * applications rather than the 4 7 mode.
+ * Ps = 1 0 5 0 -> Set terminfo/termcap function-key mode.
+ * Ps = 1 0 5 1 -> Set Sun function-key mode.
+ * Ps = 1 0 5 2 -> Set HP function-key mode.
+ * Ps = 1 0 5 3 -> Set SCO function-key mode.
+ * Ps = 1 0 6 0 -> Set legacy keyboard emulation (X11R6).
+ * Ps = 1 0 6 1 -> Set VT220 keyboard emulation.
+ * Ps = 2 0 0 4 -> Set bracketed paste mode.
+ * Modes:
+ * http: *vt100.net/docs/vt220-rm/chapter4.html
+ */
Terminal.prototype.setMode = function(params) {
if (typeof params === 'object') {
var l = params.length
}
};
- // CSI Pm l Reset Mode (RM).
- // Ps = 2 -> Keyboard Action Mode (AM).
- // Ps = 4 -> Replace Mode (IRM).
- // Ps = 1 2 -> Send/receive (SRM).
- // Ps = 2 0 -> Normal Linefeed (LNM).
- // CSI ? Pm l
- // DEC Private Mode Reset (DECRST).
- // Ps = 1 -> Normal Cursor Keys (DECCKM).
- // Ps = 2 -> Designate VT52 mode (DECANM).
- // Ps = 3 -> 80 Column Mode (DECCOLM).
- // Ps = 4 -> Jump (Fast) Scroll (DECSCLM).
- // Ps = 5 -> Normal Video (DECSCNM).
- // Ps = 6 -> Normal Cursor Mode (DECOM).
- // Ps = 7 -> No Wraparound Mode (DECAWM).
- // Ps = 8 -> No Auto-repeat Keys (DECARM).
- // Ps = 9 -> Don't send Mouse X & Y on button press.
- // Ps = 1 0 -> Hide toolbar (rxvt).
- // Ps = 1 2 -> Stop Blinking Cursor (att610).
- // Ps = 1 8 -> Don't print form feed (DECPFF).
- // Ps = 1 9 -> Limit print to scrolling region (DECPEX).
- // Ps = 2 5 -> Hide Cursor (DECTCEM).
- // Ps = 3 0 -> Don't show scrollbar (rxvt).
- // Ps = 3 5 -> Disable font-shifting functions (rxvt).
- // Ps = 4 0 -> Disallow 80 -> 132 Mode.
- // Ps = 4 1 -> No more(1) fix (see curses resource).
- // Ps = 4 2 -> Disable Nation Replacement Character sets (DEC-
- // NRCM).
- // Ps = 4 4 -> Turn Off Margin Bell.
- // Ps = 4 5 -> No Reverse-wraparound Mode.
- // Ps = 4 6 -> Stop Logging. (This is normally disabled by a
- // compile-time option).
- // Ps = 4 7 -> Use Normal Screen Buffer.
- // Ps = 6 6 -> Numeric keypad (DECNKM).
- // Ps = 6 7 -> Backarrow key sends delete (DECBKM).
- // Ps = 1 0 0 0 -> Don't send Mouse X & Y on button press and
- // release. See the section Mouse Tracking.
- // Ps = 1 0 0 1 -> Don't use Hilite Mouse Tracking.
- // Ps = 1 0 0 2 -> Don't use Cell Motion Mouse Tracking.
- // Ps = 1 0 0 3 -> Don't use All Motion Mouse Tracking.
- // Ps = 1 0 0 4 -> Don't send FocusIn/FocusOut events.
- // Ps = 1 0 0 5 -> Disable Extended Mouse Mode.
- // Ps = 1 0 1 0 -> Don't scroll to bottom on tty output
- // (rxvt).
- // Ps = 1 0 1 1 -> Don't scroll to bottom on key press (rxvt).
- // Ps = 1 0 3 4 -> Don't interpret "meta" key. (This disables
- // the eightBitInput resource).
- // Ps = 1 0 3 5 -> Disable special modifiers for Alt and Num-
- // Lock keys. (This disables the numLock resource).
- // Ps = 1 0 3 6 -> Don't send ESC when Meta modifies a key.
- // (This disables the metaSendsEscape resource).
- // Ps = 1 0 3 7 -> Send VT220 Remove from the editing-keypad
- // Delete key.
- // Ps = 1 0 3 9 -> Don't send ESC when Alt modifies a key.
- // (This disables the altSendsEscape resource).
- // Ps = 1 0 4 0 -> Do not keep selection when not highlighted.
- // (This disables the keepSelection resource).
- // Ps = 1 0 4 1 -> Use the PRIMARY selection. (This disables
- // the selectToClipboard resource).
- // Ps = 1 0 4 2 -> Disable Urgency window manager hint when
- // Control-G is received. (This disables the bellIsUrgent
- // resource).
- // Ps = 1 0 4 3 -> Disable raising of the window when Control-
- // G is received. (This disables the popOnBell resource).
- // Ps = 1 0 4 7 -> Use Normal Screen Buffer, clearing screen
- // first if in the Alternate Screen. (This may be disabled by
- // the titeInhibit resource).
- // Ps = 1 0 4 8 -> Restore cursor as in DECRC. (This may be
- // disabled by the titeInhibit resource).
- // Ps = 1 0 4 9 -> Use Normal Screen Buffer and restore cursor
- // as in DECRC. (This may be disabled by the titeInhibit
- // resource). This combines the effects of the 1 0 4 7 and 1 0
- // 4 8 modes. Use this with terminfo-based applications rather
- // than the 4 7 mode.
- // Ps = 1 0 5 0 -> Reset terminfo/termcap function-key mode.
- // Ps = 1 0 5 1 -> Reset Sun function-key mode.
- // Ps = 1 0 5 2 -> Reset HP function-key mode.
- // Ps = 1 0 5 3 -> Reset SCO function-key mode.
- // Ps = 1 0 6 0 -> Reset legacy keyboard emulation (X11R6).
- // Ps = 1 0 6 1 -> Reset keyboard emulation to Sun/PC style.
- // Ps = 2 0 0 4 -> Reset bracketed paste mode.
+ /**
+ * CSI Pm l Reset Mode (RM).
+ * Ps = 2 -> Keyboard Action Mode (AM).
+ * Ps = 4 -> Replace Mode (IRM).
+ * Ps = 1 2 -> Send/receive (SRM).
+ * Ps = 2 0 -> Normal Linefeed (LNM).
+ * CSI ? Pm l
+ * DEC Private Mode Reset (DECRST).
+ * Ps = 1 -> Normal Cursor Keys (DECCKM).
+ * Ps = 2 -> Designate VT52 mode (DECANM).
+ * Ps = 3 -> 80 Column Mode (DECCOLM).
+ * Ps = 4 -> Jump (Fast) Scroll (DECSCLM).
+ * Ps = 5 -> Normal Video (DECSCNM).
+ * Ps = 6 -> Normal Cursor Mode (DECOM).
+ * Ps = 7 -> No Wraparound Mode (DECAWM).
+ * Ps = 8 -> No Auto-repeat Keys (DECARM).
+ * Ps = 9 -> Don't send Mouse X & Y on button press.
+ * Ps = 1 0 -> Hide toolbar (rxvt).
+ * Ps = 1 2 -> Stop Blinking Cursor (att610).
+ * Ps = 1 8 -> Don't print form feed (DECPFF).
+ * Ps = 1 9 -> Limit print to scrolling region (DECPEX).
+ * Ps = 2 5 -> Hide Cursor (DECTCEM).
+ * Ps = 3 0 -> Don't show scrollbar (rxvt).
+ * Ps = 3 5 -> Disable font-shifting functions (rxvt).
+ * Ps = 4 0 -> Disallow 80 -> 132 Mode.
+ * Ps = 4 1 -> No more(1) fix (see curses resource).
+ * Ps = 4 2 -> Disable Nation Replacement Character sets (DEC-
+ * NRCM).
+ * Ps = 4 4 -> Turn Off Margin Bell.
+ * Ps = 4 5 -> No Reverse-wraparound Mode.
+ * Ps = 4 6 -> Stop Logging. (This is normally disabled by a
+ * compile-time option).
+ * Ps = 4 7 -> Use Normal Screen Buffer.
+ * Ps = 6 6 -> Numeric keypad (DECNKM).
+ * Ps = 6 7 -> Backarrow key sends delete (DECBKM).
+ * Ps = 1 0 0 0 -> Don't send Mouse X & Y on button press and
+ * release. See the section Mouse Tracking.
+ * Ps = 1 0 0 1 -> Don't use Hilite Mouse Tracking.
+ * Ps = 1 0 0 2 -> Don't use Cell Motion Mouse Tracking.
+ * Ps = 1 0 0 3 -> Don't use All Motion Mouse Tracking.
+ * Ps = 1 0 0 4 -> Don't send FocusIn/FocusOut events.
+ * Ps = 1 0 0 5 -> Disable Extended Mouse Mode.
+ * Ps = 1 0 1 0 -> Don't scroll to bottom on tty output
+ * (rxvt).
+ * Ps = 1 0 1 1 -> Don't scroll to bottom on key press (rxvt).
+ * Ps = 1 0 3 4 -> Don't interpret "meta" key. (This disables
+ * the eightBitInput resource).
+ * Ps = 1 0 3 5 -> Disable special modifiers for Alt and Num-
+ * Lock keys. (This disables the numLock resource).
+ * Ps = 1 0 3 6 -> Don't send ESC when Meta modifies a key.
+ * (This disables the metaSendsEscape resource).
+ * Ps = 1 0 3 7 -> Send VT220 Remove from the editing-keypad
+ * Delete key.
+ * Ps = 1 0 3 9 -> Don't send ESC when Alt modifies a key.
+ * (This disables the altSendsEscape resource).
+ * Ps = 1 0 4 0 -> Do not keep selection when not highlighted.
+ * (This disables the keepSelection resource).
+ * Ps = 1 0 4 1 -> Use the PRIMARY selection. (This disables
+ * the selectToClipboard resource).
+ * Ps = 1 0 4 2 -> Disable Urgency window manager hint when
+ * Control-G is received. (This disables the bellIsUrgent
+ * resource).
+ * Ps = 1 0 4 3 -> Disable raising of the window when Control-
+ * G is received. (This disables the popOnBell resource).
+ * Ps = 1 0 4 7 -> Use Normal Screen Buffer, clearing screen
+ * first if in the Alternate Screen. (This may be disabled by
+ * the titeInhibit resource).
+ * Ps = 1 0 4 8 -> Restore cursor as in DECRC. (This may be
+ * disabled by the titeInhibit resource).
+ * Ps = 1 0 4 9 -> Use Normal Screen Buffer and restore cursor
+ * as in DECRC. (This may be disabled by the titeInhibit
+ * resource). This combines the effects of the 1 0 4 7 and 1 0
+ * 4 8 modes. Use this with terminfo-based applications rather
+ * than the 4 7 mode.
+ * Ps = 1 0 5 0 -> Reset terminfo/termcap function-key mode.
+ * Ps = 1 0 5 1 -> Reset Sun function-key mode.
+ * Ps = 1 0 5 2 -> Reset HP function-key mode.
+ * Ps = 1 0 5 3 -> Reset SCO function-key mode.
+ * Ps = 1 0 6 0 -> Reset legacy keyboard emulation (X11R6).
+ * Ps = 1 0 6 1 -> Reset keyboard emulation to Sun/PC style.
+ * Ps = 2 0 0 4 -> Reset bracketed paste mode.
+ */
Terminal.prototype.resetMode = function(params) {
if (typeof params === 'object') {
var l = params.length
}
};
- // CSI Ps ; Ps r
- // Set Scrolling Region [top;bottom] (default = full size of win-
- // dow) (DECSTBM).
- // CSI ? Pm r
+
+ /**
+ * CSI Ps ; Ps r
+ * Set Scrolling Region [top;bottom] (default = full size of win-
+ * dow) (DECSTBM).
+ * CSI ? Pm r
+ */
Terminal.prototype.setScrollRegion = function(params) {
if (this.prefix) return;
this.scrollTop = (params[0] || 1) - 1;
this.y = 0;
};
- // CSI s
- // Save cursor (ANSI.SYS).
+
+ /**
+ * CSI s
+ * Save cursor (ANSI.SYS).
+ */
Terminal.prototype.saveCursor = function(params) {
this.savedX = this.x;
this.savedY = this.y;
};
- // CSI u
- // Restore cursor (ANSI.SYS).
+
+ /**
+ * CSI u
+ * Restore cursor (ANSI.SYS).
+ */
Terminal.prototype.restoreCursor = function(params) {
this.x = this.savedX || 0;
this.y = this.savedY || 0;
};
+
/**
* Lesser Used
*/
- // CSI Ps I
- // Cursor Forward Tabulation Ps tab stops (default = 1) (CHT).
+ /**
+ * CSI Ps I
+ * Cursor Forward Tabulation Ps tab stops (default = 1) (CHT).
+ */
Terminal.prototype.cursorForwardTab = function(params) {
var param = params[0] || 1;
while (param--) {
}
};
- // CSI Ps S Scroll up Ps lines (default = 1) (SU).
+
+ /**
+ * CSI Ps S Scroll up Ps lines (default = 1) (SU).
+ */
Terminal.prototype.scrollUp = function(params) {
var param = params[0] || 1;
while (param--) {
this.updateRange(this.scrollBottom);
};
- // CSI Ps T Scroll down Ps lines (default = 1) (SD).
+
+ /**
+ * CSI Ps T Scroll down Ps lines (default = 1) (SD).
+ */
Terminal.prototype.scrollDown = function(params) {
var param = params[0] || 1;
while (param--) {
this.updateRange(this.scrollBottom);
};
- // CSI Ps ; Ps ; Ps ; Ps ; Ps T
- // Initiate highlight mouse tracking. Parameters are
- // [func;startx;starty;firstrow;lastrow]. See the section Mouse
- // Tracking.
+
+ /**
+ * CSI Ps ; Ps ; Ps ; Ps ; Ps T
+ * Initiate highlight mouse tracking. Parameters are
+ * [func;startx;starty;firstrow;lastrow]. See the section Mouse
+ * Tracking.
+ */
Terminal.prototype.initMouseTracking = function(params) {
// Relevant: DECSET 1001
};
- // CSI > Ps; Ps T
- // Reset one or more features of the title modes to the default
- // value. Normally, "reset" disables the feature. It is possi-
- // ble to disable the ability to reset features by compiling a
- // different default for the title modes into xterm.
- // Ps = 0 -> Do not set window/icon labels using hexadecimal.
- // Ps = 1 -> Do not query window/icon labels using hexadeci-
- // mal.
- // Ps = 2 -> Do not set window/icon labels using UTF-8.
- // Ps = 3 -> Do not query window/icon labels using UTF-8.
- // (See discussion of "Title Modes").
+
+ /**
+ * CSI > Ps; Ps T
+ * Reset one or more features of the title modes to the default
+ * value. Normally, "reset" disables the feature. It is possi-
+ * ble to disable the ability to reset features by compiling a
+ * different default for the title modes into xterm.
+ * Ps = 0 -> Do not set window/icon labels using hexadecimal.
+ * Ps = 1 -> Do not query window/icon labels using hexadeci-
+ * mal.
+ * Ps = 2 -> Do not set window/icon labels using UTF-8.
+ * Ps = 3 -> Do not query window/icon labels using UTF-8.
+ * (See discussion of "Title Modes").
+ */
Terminal.prototype.resetTitleModes = function(params) {
;
};
- // CSI Ps Z Cursor Backward Tabulation Ps tab stops (default = 1) (CBT).
+
+ /**
+ * CSI Ps Z Cursor Backward Tabulation Ps tab stops (default = 1) (CBT).
+ */
Terminal.prototype.cursorBackwardTab = function(params) {
var param = params[0] || 1;
while (param--) {
}
};
- // CSI Ps b Repeat the preceding graphic character Ps times (REP).
+
+ /**
+ * CSI Ps b Repeat the preceding graphic character Ps times (REP).
+ */
Terminal.prototype.repeatPrecedingCharacter = function(params) {
var param = params[0] || 1
, line = this.lines[this.ybase + this.y]
- , ch = line[this.x - 1] || [this.defAttr, ' '];
+ , ch = line[this.x - 1] || [this.defAttr, ' ', 1];
while (param--) line[this.x++] = ch;
};
- // CSI Ps g Tab Clear (TBC).
- // Ps = 0 -> Clear Current Column (default).
- // Ps = 3 -> Clear All.
- // Potentially:
- // Ps = 2 -> Clear Stops on Line.
- // http://vt100.net/annarbor/aaa-ug/section6.html
+
+ /**
+ * CSI Ps g Tab Clear (TBC).
+ * Ps = 0 -> Clear Current Column (default).
+ * Ps = 3 -> Clear All.
+ * Potentially:
+ * Ps = 2 -> Clear Stops on Line.
+ * http://vt100.net/annarbor/aaa-ug/section6.html
+ */
Terminal.prototype.tabClear = function(params) {
var param = params[0];
if (param <= 0) {
}
};
- // CSI Pm i Media Copy (MC).
- // Ps = 0 -> Print screen (default).
- // Ps = 4 -> Turn off printer controller mode.
- // Ps = 5 -> Turn on printer controller mode.
- // CSI ? Pm i
- // Media Copy (MC, DEC-specific).
- // Ps = 1 -> Print line containing cursor.
- // Ps = 4 -> Turn off autoprint mode.
- // Ps = 5 -> Turn on autoprint mode.
- // Ps = 1 0 -> Print composed display, ignores DECPEX.
- // Ps = 1 1 -> Print all pages.
+
+ /**
+ * CSI Pm i Media Copy (MC).
+ * Ps = 0 -> Print screen (default).
+ * Ps = 4 -> Turn off printer controller mode.
+ * Ps = 5 -> Turn on printer controller mode.
+ * CSI ? Pm i
+ * Media Copy (MC, DEC-specific).
+ * Ps = 1 -> Print line containing cursor.
+ * Ps = 4 -> Turn off autoprint mode.
+ * Ps = 5 -> Turn on autoprint mode.
+ * Ps = 1 0 -> Print composed display, ignores DECPEX.
+ * Ps = 1 1 -> Print all pages.
+ */
Terminal.prototype.mediaCopy = function(params) {
;
};
- // CSI > Ps; Ps m
- // Set or reset resource-values used by xterm to decide whether
- // to construct escape sequences holding information about the
- // modifiers pressed with a given key. The first parameter iden-
- // tifies the resource to set/reset. The second parameter is the
- // value to assign to the resource. If the second parameter is
- // omitted, the resource is reset to its initial value.
- // Ps = 1 -> modifyCursorKeys.
- // Ps = 2 -> modifyFunctionKeys.
- // Ps = 4 -> modifyOtherKeys.
- // If no parameters are given, all resources are reset to their
- // initial values.
+
+ /**
+ * CSI > Ps; Ps m
+ * Set or reset resource-values used by xterm to decide whether
+ * to construct escape sequences holding information about the
+ * modifiers pressed with a given key. The first parameter iden-
+ * tifies the resource to set/reset. The second parameter is the
+ * value to assign to the resource. If the second parameter is
+ * omitted, the resource is reset to its initial value.
+ * Ps = 1 -> modifyCursorKeys.
+ * Ps = 2 -> modifyFunctionKeys.
+ * Ps = 4 -> modifyOtherKeys.
+ * If no parameters are given, all resources are reset to their
+ * initial values.
+ */
Terminal.prototype.setResources = function(params) {
;
};
- // CSI > Ps n
- // Disable modifiers which may be enabled via the CSI > Ps; Ps m
- // sequence. This corresponds to a resource value of "-1", which
- // cannot be set with the other sequence. The parameter identi-
- // fies the resource to be disabled:
- // Ps = 1 -> modifyCursorKeys.
- // Ps = 2 -> modifyFunctionKeys.
- // Ps = 4 -> modifyOtherKeys.
- // If the parameter is omitted, modifyFunctionKeys is disabled.
- // When modifyFunctionKeys is disabled, xterm uses the modifier
- // keys to make an extended sequence of functions rather than
- // adding a parameter to each function key to denote the modi-
- // fiers.
+
+ /**
+ * CSI > Ps n
+ * Disable modifiers which may be enabled via the CSI > Ps; Ps m
+ * sequence. This corresponds to a resource value of "-1", which
+ * cannot be set with the other sequence. The parameter identi-
+ * fies the resource to be disabled:
+ * Ps = 1 -> modifyCursorKeys.
+ * Ps = 2 -> modifyFunctionKeys.
+ * Ps = 4 -> modifyOtherKeys.
+ * If the parameter is omitted, modifyFunctionKeys is disabled.
+ * When modifyFunctionKeys is disabled, xterm uses the modifier
+ * keys to make an extended sequence of functions rather than
+ * adding a parameter to each function key to denote the modi-
+ * fiers.
+ */
Terminal.prototype.disableModifiers = function(params) {
;
};
- // CSI > Ps p
- // Set resource value pointerMode. This is used by xterm to
- // decide whether to hide the pointer cursor as the user types.
- // Valid values for the parameter:
- // Ps = 0 -> never hide the pointer.
- // Ps = 1 -> hide if the mouse tracking mode is not enabled.
- // Ps = 2 -> always hide the pointer. If no parameter is
- // given, xterm uses the default, which is 1 .
+
+ /**
+ * CSI > Ps p
+ * Set resource value pointerMode. This is used by xterm to
+ * decide whether to hide the pointer cursor as the user types.
+ * Valid values for the parameter:
+ * Ps = 0 -> never hide the pointer.
+ * Ps = 1 -> hide if the mouse tracking mode is not enabled.
+ * Ps = 2 -> always hide the pointer. If no parameter is
+ * given, xterm uses the default, which is 1 .
+ */
Terminal.prototype.setPointerMode = function(params) {
;
};
- // CSI ! p Soft terminal reset (DECSTR).
- // http://vt100.net/docs/vt220-rm/table4-10.html
+
+ /**
+ * CSI ! p Soft terminal reset (DECSTR).
+ * http://vt100.net/docs/vt220-rm/table4-10.html
+ */
Terminal.prototype.softReset = function(params) {
this.cursorHidden = false;
this.insertMode = false;
this.charsets = [null]; // ??
};
- // CSI Ps$ p
- // Request ANSI mode (DECRQM). For VT300 and up, reply is
- // CSI Ps; Pm$ y
- // where Ps is the mode number as in RM, and Pm is the mode
- // value:
- // 0 - not recognized
- // 1 - set
- // 2 - reset
- // 3 - permanently set
- // 4 - permanently reset
+
+ /**
+ * CSI Ps$ p
+ * Request ANSI mode (DECRQM). For VT300 and up, reply is
+ * CSI Ps; Pm$ y
+ * where Ps is the mode number as in RM, and Pm is the mode
+ * value:
+ * 0 - not recognized
+ * 1 - set
+ * 2 - reset
+ * 3 - permanently set
+ * 4 - permanently reset
+ */
Terminal.prototype.requestAnsiMode = function(params) {
;
};
- // CSI ? Ps$ p
- // Request DEC private mode (DECRQM). For VT300 and up, reply is
- // CSI ? Ps; Pm$ p
- // where Ps is the mode number as in DECSET, Pm is the mode value
- // as in the ANSI DECRQM.
+
+ /**
+ * CSI ? Ps$ p
+ * Request DEC private mode (DECRQM). For VT300 and up, reply is
+ * CSI ? Ps; Pm$ p
+ * where Ps is the mode number as in DECSET, Pm is the mode value
+ * as in the ANSI DECRQM.
+ */
Terminal.prototype.requestPrivateMode = function(params) {
;
};
- // CSI Ps ; Ps " p
- // Set conformance level (DECSCL). Valid values for the first
- // parameter:
- // Ps = 6 1 -> VT100.
- // Ps = 6 2 -> VT200.
- // Ps = 6 3 -> VT300.
- // Valid values for the second parameter:
- // Ps = 0 -> 8-bit controls.
- // Ps = 1 -> 7-bit controls (always set for VT100).
- // Ps = 2 -> 8-bit controls.
+
+ /**
+ * CSI Ps ; Ps " p
+ * Set conformance level (DECSCL). Valid values for the first
+ * parameter:
+ * Ps = 6 1 -> VT100.
+ * Ps = 6 2 -> VT200.
+ * Ps = 6 3 -> VT300.
+ * Valid values for the second parameter:
+ * Ps = 0 -> 8-bit controls.
+ * Ps = 1 -> 7-bit controls (always set for VT100).
+ * Ps = 2 -> 8-bit controls.
+ */
Terminal.prototype.setConformanceLevel = function(params) {
;
};
- // CSI Ps q Load LEDs (DECLL).
- // Ps = 0 -> Clear all LEDS (default).
- // Ps = 1 -> Light Num Lock.
- // Ps = 2 -> Light Caps Lock.
- // Ps = 3 -> Light Scroll Lock.
- // Ps = 2 1 -> Extinguish Num Lock.
- // Ps = 2 2 -> Extinguish Caps Lock.
- // Ps = 2 3 -> Extinguish Scroll Lock.
+
+ /**
+ * CSI Ps q Load LEDs (DECLL).
+ * Ps = 0 -> Clear all LEDS (default).
+ * Ps = 1 -> Light Num Lock.
+ * Ps = 2 -> Light Caps Lock.
+ * Ps = 3 -> Light Scroll Lock.
+ * Ps = 2 1 -> Extinguish Num Lock.
+ * Ps = 2 2 -> Extinguish Caps Lock.
+ * Ps = 2 3 -> Extinguish Scroll Lock.
+ */
Terminal.prototype.loadLEDs = function(params) {
;
};
- // CSI Ps SP q
- // Set cursor style (DECSCUSR, VT520).
- // Ps = 0 -> blinking block.
- // Ps = 1 -> blinking block (default).
- // Ps = 2 -> steady block.
- // Ps = 3 -> blinking underline.
- // Ps = 4 -> steady underline.
+
+ /**
+ * CSI Ps SP q
+ * Set cursor style (DECSCUSR, VT520).
+ * Ps = 0 -> blinking block.
+ * Ps = 1 -> blinking block (default).
+ * Ps = 2 -> steady block.
+ * Ps = 3 -> blinking underline.
+ * Ps = 4 -> steady underline.
+ */
Terminal.prototype.setCursorStyle = function(params) {
;
};
- // CSI Ps " q
- // Select character protection attribute (DECSCA). Valid values
- // for the parameter:
- // Ps = 0 -> DECSED and DECSEL can erase (default).
- // Ps = 1 -> DECSED and DECSEL cannot erase.
- // Ps = 2 -> DECSED and DECSEL can erase.
+
+ /**
+ * CSI Ps " q
+ * Select character protection attribute (DECSCA). Valid values
+ * for the parameter:
+ * Ps = 0 -> DECSED and DECSEL can erase (default).
+ * Ps = 1 -> DECSED and DECSEL cannot erase.
+ * Ps = 2 -> DECSED and DECSEL can erase.
+ */
Terminal.prototype.setCharProtectionAttr = function(params) {
;
};
- // CSI ? Pm r
- // Restore DEC Private Mode Values. The value of Ps previously
- // saved is restored. Ps values are the same as for DECSET.
+
+ /**
+ * CSI ? Pm r
+ * Restore DEC Private Mode Values. The value of Ps previously
+ * saved is restored. Ps values are the same as for DECSET.
+ */
Terminal.prototype.restorePrivateValues = function(params) {
;
};
- // CSI Pt; Pl; Pb; Pr; Ps$ r
- // Change Attributes in Rectangular Area (DECCARA), VT400 and up.
- // Pt; Pl; Pb; Pr denotes the rectangle.
- // Ps denotes the SGR attributes to change: 0, 1, 4, 5, 7.
- // NOTE: xterm doesn't enable this code by default.
+
+ /**
+ * CSI Pt; Pl; Pb; Pr; Ps$ r
+ * Change Attributes in Rectangular Area (DECCARA), VT400 and up.
+ * Pt; Pl; Pb; Pr denotes the rectangle.
+ * Ps denotes the SGR attributes to change: 0, 1, 4, 5, 7.
+ * NOTE: xterm doesn't enable this code by default.
+ */
Terminal.prototype.setAttrInRectangle = function(params) {
var t = params[0]
, l = params[1]
};
- // CSI Pc; Pt; Pl; Pb; Pr$ x
- // Fill Rectangular Area (DECFRA), VT420 and up.
- // Pc is the character to use.
- // Pt; Pl; Pb; Pr denotes the rectangle.
- // NOTE: xterm doesn't enable this code by default.
+ /**
+ * CSI Pc; Pt; Pl; Pb; Pr$ x
+ * Fill Rectangular Area (DECFRA), VT420 and up.
+ * Pc is the character to use.
+ * Pt; Pl; Pb; Pr denotes the rectangle.
+ * NOTE: xterm doesn't enable this code by default.
+ */
Terminal.prototype.fillRectangle = function(params) {
var ch = params[0]
, t = params[1]
this.updateRange(params[3]);
};
- // CSI Ps ; Pu ' z
- // Enable Locator Reporting (DECELR).
- // Valid values for the first parameter:
- // Ps = 0 -> Locator disabled (default).
- // Ps = 1 -> Locator enabled.
- // Ps = 2 -> Locator enabled for one report, then disabled.
- // The second parameter specifies the coordinate unit for locator
- // reports.
- // Valid values for the second parameter:
- // Pu = 0 <- or omitted -> default to character cells.
- // Pu = 1 <- device physical pixels.
- // Pu = 2 <- character cells.
+
+ /**
+ * CSI Ps ; Pu ' z
+ * Enable Locator Reporting (DECELR).
+ * Valid values for the first parameter:
+ * Ps = 0 -> Locator disabled (default).
+ * Ps = 1 -> Locator enabled.
+ * Ps = 2 -> Locator enabled for one report, then disabled.
+ * The second parameter specifies the coordinate unit for locator
+ * reports.
+ * Valid values for the second parameter:
+ * Pu = 0 <- or omitted -> default to character cells.
+ * Pu = 1 <- device physical pixels.
+ * Pu = 2 <- character cells.
+ */
Terminal.prototype.enableLocatorReporting = function(params) {
var val = params[0] > 0;
//this.mouseEvents = val;
//this.decLocator = val;
};
- // CSI Pt; Pl; Pb; Pr$ z
- // Erase Rectangular Area (DECERA), VT400 and up.
- // Pt; Pl; Pb; Pr denotes the rectangle.
- // NOTE: xterm doesn't enable this code by default.
+
+ /**
+ * CSI Pt; Pl; Pb; Pr$ z
+ * Erase Rectangular Area (DECERA), VT400 and up.
+ * Pt; Pl; Pb; Pr denotes the rectangle.
+ * NOTE: xterm doesn't enable this code by default.
+ */
Terminal.prototype.eraseRectangle = function(params) {
var t = params[0]
, l = params[1]
, i
, ch;
- ch = [this.eraseAttr(), ' ']; // xterm?
+ ch = [this.eraseAttr(), ' ', 1]; // xterm?
for (; t < b + 1; t++) {
line = this.lines[this.ybase + t];
};
- // CSI P m SP }
- // Insert P s Column(s) (default = 1) (DECIC), VT420 and up.
- // NOTE: xterm doesn't enable this code by default.
+ /**
+ * CSI P m SP }
+ * Insert P s Column(s) (default = 1) (DECIC), VT420 and up.
+ * NOTE: xterm doesn't enable this code by default.
+ */
Terminal.prototype.insertColumns = function() {
var param = params[0]
, l = this.ybase + this.rows
- , ch = [this.eraseAttr(), ' '] // xterm?
+ , ch = [this.eraseAttr(), ' ', 1] // xterm?
, i;
while (param--) {
};
- // CSI P m SP ~
- // Delete P s Column(s) (default = 1) (DECDC), VT420 and up
- // NOTE: xterm doesn't enable this code by default.
+ /**
+ * CSI P m SP ~
+ * Delete P s Column(s) (default = 1) (DECDC), VT420 and up
+ * NOTE: xterm doesn't enable this code by default.
+ */
Terminal.prototype.deleteColumns = function() {
var param = params[0]
, l = this.ybase + this.rows
- , ch = [this.eraseAttr(), ' '] // xterm?
+ , ch = [this.eraseAttr(), ' ', 1] // xterm?
, i;
while (param--) {
(term.isMac && ev.altKey && !ev.ctrlKey && !ev.metaKey) ||
(term.isMSWindows && ev.altKey && ev.ctrlKey && !ev.metaKey);
- // Don't invoke for arrows, pageDown, home, backspace, etc.
- return thirdLevelKey && (!ev.keyCode || ev.keyCode > 47);
- }
+ if (ev.type == 'keypress') {
+ return thirdLevelKey;
+ }
- function isWide(ch) {
- if (ch <= '\uff00') return false;
- return (ch >= '\uff01' && ch <= '\uffbe')
- || (ch >= '\uffc2' && ch <= '\uffc7')
- || (ch >= '\uffca' && ch <= '\uffcf')
- || (ch >= '\uffd2' && ch <= '\uffd7')
- || (ch >= '\uffda' && ch <= '\uffdc')
- || (ch >= '\uffe0' && ch <= '\uffe6')
- || (ch >= '\uffe8' && ch <= '\uffee');
+ // Don't invoke for arrows, pageDown, home, backspace, etc. (on non-keypress events)
+ return thirdLevelKey && (!ev.keyCode || ev.keyCode > 47);
}
function matchColor(r1, g1, b1) {
return keys;
}
+ var wcwidth = (function(opts) {
+ // extracted from https://www.cl.cam.ac.uk/%7Emgk25/ucs/wcwidth.c
+ // combining characters
+ var COMBINING = [
+ [0x0300, 0x036F], [0x0483, 0x0486], [0x0488, 0x0489],
+ [0x0591, 0x05BD], [0x05BF, 0x05BF], [0x05C1, 0x05C2],
+ [0x05C4, 0x05C5], [0x05C7, 0x05C7], [0x0600, 0x0603],
+ [0x0610, 0x0615], [0x064B, 0x065E], [0x0670, 0x0670],
+ [0x06D6, 0x06E4], [0x06E7, 0x06E8], [0x06EA, 0x06ED],
+ [0x070F, 0x070F], [0x0711, 0x0711], [0x0730, 0x074A],
+ [0x07A6, 0x07B0], [0x07EB, 0x07F3], [0x0901, 0x0902],
+ [0x093C, 0x093C], [0x0941, 0x0948], [0x094D, 0x094D],
+ [0x0951, 0x0954], [0x0962, 0x0963], [0x0981, 0x0981],
+ [0x09BC, 0x09BC], [0x09C1, 0x09C4], [0x09CD, 0x09CD],
+ [0x09E2, 0x09E3], [0x0A01, 0x0A02], [0x0A3C, 0x0A3C],
+ [0x0A41, 0x0A42], [0x0A47, 0x0A48], [0x0A4B, 0x0A4D],
+ [0x0A70, 0x0A71], [0x0A81, 0x0A82], [0x0ABC, 0x0ABC],
+ [0x0AC1, 0x0AC5], [0x0AC7, 0x0AC8], [0x0ACD, 0x0ACD],
+ [0x0AE2, 0x0AE3], [0x0B01, 0x0B01], [0x0B3C, 0x0B3C],
+ [0x0B3F, 0x0B3F], [0x0B41, 0x0B43], [0x0B4D, 0x0B4D],
+ [0x0B56, 0x0B56], [0x0B82, 0x0B82], [0x0BC0, 0x0BC0],
+ [0x0BCD, 0x0BCD], [0x0C3E, 0x0C40], [0x0C46, 0x0C48],
+ [0x0C4A, 0x0C4D], [0x0C55, 0x0C56], [0x0CBC, 0x0CBC],
+ [0x0CBF, 0x0CBF], [0x0CC6, 0x0CC6], [0x0CCC, 0x0CCD],
+ [0x0CE2, 0x0CE3], [0x0D41, 0x0D43], [0x0D4D, 0x0D4D],
+ [0x0DCA, 0x0DCA], [0x0DD2, 0x0DD4], [0x0DD6, 0x0DD6],
+ [0x0E31, 0x0E31], [0x0E34, 0x0E3A], [0x0E47, 0x0E4E],
+ [0x0EB1, 0x0EB1], [0x0EB4, 0x0EB9], [0x0EBB, 0x0EBC],
+ [0x0EC8, 0x0ECD], [0x0F18, 0x0F19], [0x0F35, 0x0F35],
+ [0x0F37, 0x0F37], [0x0F39, 0x0F39], [0x0F71, 0x0F7E],
+ [0x0F80, 0x0F84], [0x0F86, 0x0F87], [0x0F90, 0x0F97],
+ [0x0F99, 0x0FBC], [0x0FC6, 0x0FC6], [0x102D, 0x1030],
+ [0x1032, 0x1032], [0x1036, 0x1037], [0x1039, 0x1039],
+ [0x1058, 0x1059], [0x1160, 0x11FF], [0x135F, 0x135F],
+ [0x1712, 0x1714], [0x1732, 0x1734], [0x1752, 0x1753],
+ [0x1772, 0x1773], [0x17B4, 0x17B5], [0x17B7, 0x17BD],
+ [0x17C6, 0x17C6], [0x17C9, 0x17D3], [0x17DD, 0x17DD],
+ [0x180B, 0x180D], [0x18A9, 0x18A9], [0x1920, 0x1922],
+ [0x1927, 0x1928], [0x1932, 0x1932], [0x1939, 0x193B],
+ [0x1A17, 0x1A18], [0x1B00, 0x1B03], [0x1B34, 0x1B34],
+ [0x1B36, 0x1B3A], [0x1B3C, 0x1B3C], [0x1B42, 0x1B42],
+ [0x1B6B, 0x1B73], [0x1DC0, 0x1DCA], [0x1DFE, 0x1DFF],
+ [0x200B, 0x200F], [0x202A, 0x202E], [0x2060, 0x2063],
+ [0x206A, 0x206F], [0x20D0, 0x20EF], [0x302A, 0x302F],
+ [0x3099, 0x309A], [0xA806, 0xA806], [0xA80B, 0xA80B],
+ [0xA825, 0xA826], [0xFB1E, 0xFB1E], [0xFE00, 0xFE0F],
+ [0xFE20, 0xFE23], [0xFEFF, 0xFEFF], [0xFFF9, 0xFFFB],
+ [0x10A01, 0x10A03], [0x10A05, 0x10A06], [0x10A0C, 0x10A0F],
+ [0x10A38, 0x10A3A], [0x10A3F, 0x10A3F], [0x1D167, 0x1D169],
+ [0x1D173, 0x1D182], [0x1D185, 0x1D18B], [0x1D1AA, 0x1D1AD],
+ [0x1D242, 0x1D244], [0xE0001, 0xE0001], [0xE0020, 0xE007F],
+ [0xE0100, 0xE01EF]
+ ];
+ // binary search
+ function bisearch(ucs) {
+ var min = 0;
+ var max = COMBINING.length - 1;
+ var mid;
+ if (ucs < COMBINING[0][0] || ucs > COMBINING[max][1])
+ return false;
+ while (max >= min) {
+ mid = Math.floor((min + max) / 2);
+ if (ucs > COMBINING[mid][1])
+ min = mid + 1;
+ else if (ucs < COMBINING[mid][0])
+ max = mid - 1;
+ else
+ return true;
+ }
+ return false;
+ }
+ function wcwidth(ucs) {
+ // test for 8-bit control characters
+ if (ucs === 0)
+ return opts.nul;
+ if (ucs < 32 || (ucs >= 0x7f && ucs < 0xa0))
+ return opts.control;
+ // binary search in table of non-spacing characters
+ if (bisearch(ucs))
+ return 0;
+ // if we arrive here, ucs is not a combining or C0/C1 control character
+ return 1 +
+ (
+ ucs >= 0x1100 &&
+ (
+ ucs <= 0x115f || // Hangul Jamo init. consonants
+ ucs == 0x2329 ||
+ ucs == 0x232a ||
+ (ucs >= 0x2e80 && ucs <= 0xa4cf && ucs != 0x303f) || // CJK..Yi
+ (ucs >= 0xac00 && ucs <= 0xd7a3) || // Hangul Syllables
+ (ucs >= 0xf900 && ucs <= 0xfaff) || // CJK Compat Ideographs
+ (ucs >= 0xfe10 && ucs <= 0xfe19) || // Vertical forms
+ (ucs >= 0xfe30 && ucs <= 0xfe6f) || // CJK Compat Forms
+ (ucs >= 0xff00 && ucs <= 0xff60) || // Fullwidth Forms
+ (ucs >= 0xffe0 && ucs <= 0xffe6) ||
+ (ucs >= 0x20000 && ucs <= 0x2fffd) ||
+ (ucs >= 0x30000 && ucs <= 0x3fffd)
+ )
+ );
+ }
+ return wcwidth;
+ })({nul: 0, control: 0}); // configurable options
+
/**
* Expose
*/
*
* @param {string} event The name of the event. TODO: Document all event types
* @param {function} callback The function to call when the event is triggered.
- *
- * @public
*/
Terminal.on = on;
Terminal.off = off;
Terminal.cancel = cancel;
+
return Terminal;
});