* @license MIT
*/
+import * as Mouse from './utils/Mouse';
+import * as Browser from './utils/Browser';
import { CharMeasure } from './utils/CharMeasure';
import { CircularList } from './utils/CircularList';
import { EventEmitter } from './EventEmitter';
-import * as Mouse from './utils/Mouse';
-import { ITerminal } from './Interfaces';
+import { ITerminal, ICircularList } from './Interfaces';
import { SelectionModel } from './SelectionModel';
+import { translateBufferLineToString } from './utils/BufferLine';
/**
* The number of pixels the mouse needs to be above or below the viewport in
* order to scroll at the maximum speed.
*/
-const DRAG_SCROLL_MAX_THRESHOLD = 100;
+const DRAG_SCROLL_MAX_THRESHOLD = 50;
/**
* The maximum scrolling speed
*/
-const DRAG_SCROLL_MAX_SPEED = 5;
+const DRAG_SCROLL_MAX_SPEED = 15;
/**
* The number of milliseconds between drag scroll updates.
*/
-const DRAG_SCROLL_INTERVAL = 100;
+const DRAG_SCROLL_INTERVAL = 50;
/**
- * The amount of time before mousedown events are no stacked to create double
- * click events.
+ * A string containing all characters that are considered word separated by the
+ * double click to select work logic.
*/
-const CLEAR_MOUSE_DOWN_TIME = 400;
+const WORD_SEPARATORS = ' ()[]{}\'"';
-// TODO: Move these constants elsewhere
+// TODO: Move these constants elsewhere, they belong in a buffer or buffer
+// data/line class.
const LINE_DATA_CHAR_INDEX = 1;
const LINE_DATA_WIDTH_INDEX = 2;
+const NON_BREAKING_SPACE_CHAR = String.fromCharCode(160);
+const ALL_NON_BREAKING_SPACE_REGEX = new RegExp(NON_BREAKING_SPACE_CHAR, 'g');
+
+/**
+ * Represents a position of a word on a line.
+ */
+interface IWordPosition {
+ start: number;
+ length: number;
+}
+
+/**
+ * A selection mode, this drives how the selection behaves on mouse move.
+ */
+enum SelectionMode {
+ NORMAL,
+ WORD,
+ LINE
+}
+
+/**
+ * A class that manages the selection of the terminal. With help from
+ * SelectionModel, SelectionManager handles with all logic associated with
+ * dealing with the selection, including handling mouse interaction, wide
+ * characters and fetching the actual text within the selection. Rendering is
+ * not handled by the SelectionManager but a 'refresh' event is fired when the
+ * selection is ready to be redrawn.
+ */
export class SelectionManager extends EventEmitter {
- private _model: SelectionModel;
+ protected _model: SelectionModel;
/**
* The amount to scroll every drag scroll update (depends on how far the mouse
private _dragScrollAmount: number;
/**
- * The last time the mousedown event fired, this is used to track double and
- * triple clicks.
+ * The current selection mode.
+ */
+ private _activeSelectionMode: SelectionMode;
+
+ /**
+ * A setInterval timer that is active while the mouse is down whose callback
+ * scrolls the viewport when necessary.
*/
- private _lastMouseDownTime: number;
+ private _dragScrollIntervalTimer: NodeJS.Timer;
- private _clickCount: number;
+ /**
+ * The animation frame ID used for refreshing the selection.
+ */
+ private _refreshAnimationFrame: number;
+
+ /**
+ * Whether selection is enabled.
+ */
+ private _enabled = true;
- private _bufferTrimListener: any;
private _mouseMoveListener: EventListener;
- private _mouseDownListener: EventListener;
private _mouseUpListener: EventListener;
- private _dragScrollTimeout: NodeJS.Timer;
-
constructor(
private _terminal: ITerminal,
- private _buffer: CircularList<any>,
+ private _buffer: ICircularList<[number, string, number][]>,
private _rowContainer: HTMLElement,
private _charMeasure: CharMeasure
) {
this.enable();
this._model = new SelectionModel(_terminal);
- this._lastMouseDownTime = 0;
+ this._activeSelectionMode = SelectionMode.NORMAL;
}
+ /**
+ * Initializes listener variables.
+ */
private _initListeners() {
- this._bufferTrimListener = (amount: number) => this._onTrim(amount);
this._mouseMoveListener = event => this._onMouseMove(<MouseEvent>event);
- this._mouseDownListener = event => this._onMouseDown(<MouseEvent>event);
this._mouseUpListener = event => this._onMouseUp(<MouseEvent>event);
+
+ this._rowContainer.addEventListener('mousedown', event => this._onMouseDown(<MouseEvent>event));
+
+ // Only adjust the selection on trim, shiftElements is rarely used (only in
+ // reverseIndex) and delete in a splice is only ever used when the same
+ // number of elements was just added. Given this is could actually be
+ // beneficial to leave the selection as is for these cases.
+ this._buffer.on('trim', (amount: number) => this._onTrim(amount));
}
/**
* are enabled.
*/
public disable() {
- this._model.selectionStart = null;
- this._model.selectionEnd = null;
- this.refresh();
- this._buffer.off('trim', this._bufferTrimListener);
- this._rowContainer.removeEventListener('mousedown', this._mouseDownListener);
- this._rowContainer.ownerDocument.removeEventListener('mousemove', this._mouseMoveListener);
- this._rowContainer.ownerDocument.removeEventListener('mouseup', this._mouseUpListener);
- clearInterval(this._dragScrollTimeout);
+ this.clearSelection();
+ this._enabled = false;
}
/**
* Enable the selection manager.
*/
public enable() {
- this._buffer.on('trim', this._bufferTrimListener);
- this._rowContainer.addEventListener('mousedown', this._mouseDownListener);
+ this._enabled = true;
+ }
+
+ /**
+ * Sets the active buffer, this should be called when the alt buffer is
+ * switched in or out.
+ * @param buffer The active buffer.
+ */
+ public setBuffer(buffer: ICircularList<[number, string, number][]>): void {
+ this._buffer = buffer;
+ this.clearSelection();
+ }
+
+ public get selectionStart(): [number, number] { return this._model.finalSelectionStart; }
+ public get selectionEnd(): [number, number] { return this._model.finalSelectionEnd; }
+
+ /**
+ * Gets whether there is an active text selection.
+ */
+ public get hasSelection(): boolean {
+ const start = this._model.finalSelectionStart;
+ const end = this._model.finalSelectionEnd;
+ if (!start || !end) {
+ return false;
+ }
+ return start[0] !== end[0] || start[1] !== end[1];
}
/**
// Get first row
const startRowEndCol = start[1] === end[1] ? end[0] : null;
let result: string[] = [];
- result.push(this._translateBufferLineToString(this._buffer.get(start[1]), true, start[0], startRowEndCol));
+ result.push(translateBufferLineToString(this._buffer.get(start[1]), true, start[0], startRowEndCol));
// Get middle rows
for (let i = start[1] + 1; i <= end[1] - 1; i++) {
- result.push(this._translateBufferLineToString(this._buffer.get(i), true));
+ const bufferLine = this._buffer.get(i);
+ const lineText = translateBufferLineToString(bufferLine, true);
+ if ((<any>bufferLine).isWrapped) {
+ result[result.length - 1] += lineText;
+ } else {
+ result.push(lineText);
+ }
}
// Get final row
if (start[1] !== end[1]) {
- result.push(this._translateBufferLineToString(this._buffer.get(end[1]), true, 0, end[0]));
+ const bufferLine = this._buffer.get(end[1]);
+ const lineText = translateBufferLineToString(bufferLine, true, 0, end[0]);
+ if ((<any>bufferLine).isWrapped) {
+ result[result.length - 1] += lineText;
+ } else {
+ result.push(lineText);
+ }
}
- console.log('selectionText result: "' + result + '"');
- return result.join('\n');
+
+ // Format string by replacing non-breaking space chars with regular spaces
+ // and joining the array into a multi-line string.
+ const formattedResult = result.map(line => {
+ return line.replace(ALL_NON_BREAKING_SPACE_REGEX, ' ');
+ }).join(Browser.isMSWindows ? '\r\n' : '\n');
+
+ return formattedResult;
}
- private _translateBufferLineToString(line: any, trimRight: boolean, startCol: number = 0, endCol: number = null): string {
- // TODO: This function should live in a buffer or buffer line class
-
- // Get full line
- let lineString = '';
- let widthAdjustedStartCol = startCol;
- let widthAdjustedEndCol = endCol;
- for (let i = 0; i < line.length; i++) {
- const char = line[i];
- lineString += char[LINE_DATA_CHAR_INDEX];
- // Adjust start and end cols for wide characters if they affect their
- // column indexes
- if (char[LINE_DATA_WIDTH_INDEX] === 0) {
- if (startCol >= i) {
- widthAdjustedStartCol--;
- }
- if (endCol >= i) {
- widthAdjustedEndCol--;
- }
- }
+ /**
+ * Clears the current terminal selection.
+ */
+ public clearSelection(): void {
+ this._model.clearSelection();
+ this._removeMouseDownListeners();
+ this.refresh();
+ }
+
+ /**
+ * Queues a refresh, redrawing the selection on the next opportunity.
+ * @param isNewSelection Whether the selection should be registered as a new
+ * selection on Linux.
+ */
+ public refresh(isNewSelection?: boolean): void {
+ // Queue the refresh for the renderer
+ if (!this._refreshAnimationFrame) {
+ this._refreshAnimationFrame = window.requestAnimationFrame(() => this._refresh());
}
- // Calculate the final end col by trimming whitespace on the right of the
- // line if needed.
- let finalEndCol = widthAdjustedEndCol || line.length;
- if (trimRight) {
- const rightWhitespaceIndex = lineString.search(/\s+$/);
- if (rightWhitespaceIndex !== -1) {
- finalEndCol = Math.min(finalEndCol, rightWhitespaceIndex);
- }
- // Return the empty string if only trimmed whitespace is selected
- if (finalEndCol <= widthAdjustedStartCol) {
- return '';
+ // If the platform is Linux and the refresh call comes from a mouse event,
+ // we need to update the selection for middle click to paste selection.
+ if (Browser.isLinux && isNewSelection) {
+ const selectionText = this.selectionText;
+ if (selectionText.length) {
+ this.emit('newselection', this.selectionText);
}
}
-
- return lineString.substring(widthAdjustedStartCol, finalEndCol);
}
/**
- * Redraws the selection.
+ * Fires the refresh event, causing consumers to pick it up and redraw the
+ * selection state.
*/
- public refresh(): void {
- // TODO: Figure out when to refresh the selection vs when to refresh the viewport
+ private _refresh(): void {
+ this._refreshAnimationFrame = null;
this.emit('refresh', { start: this._model.finalSelectionStart, end: this._model.finalSelectionEnd });
}
}
}
- // TODO: Handle splice/shiftElements in the buffer (just clear the selection?)
-
+ /**
+ * Gets the 0-based [x, y] buffer coordinates of the current mouse event.
+ * @param event The mouse event.
+ */
private _getMouseBufferCoords(event: MouseEvent): [number, number] {
- const coords = Mouse.getCoords(event, this._rowContainer, this._charMeasure, this._terminal.cols, this._terminal.rows);
- console.log(coords);
+ const coords = Mouse.getCoords(event, this._rowContainer, this._charMeasure, this._terminal.cols, this._terminal.rows, true);
+ if (!coords) {
+ return null;
+ }
+
// Convert to 0-based
coords[0]--;
coords[1]--;
// Convert viewport coords to buffer coords
- coords[1] += this._terminal.ydisp;
+ coords[1] += this._terminal.buffer.ydisp;
return coords;
}
+ /**
+ * Gets the amount the viewport should be scrolled based on how far out of the
+ * terminal the mouse is.
+ * @param event The mouse event.
+ */
private _getMouseEventScrollAmount(event: MouseEvent): number {
let offset = Mouse.getCoordsRelativeToElement(event, this._rowContainer)[1];
const terminalHeight = this._terminal.rows * this._charMeasure.height;
* @param event The mousedown event.
*/
private _onMouseDown(event: MouseEvent) {
+ // If we have selection, we want the context menu on right click even if the
+ // terminal is in mouse mode.
+ if (event.button === 2 && this.hasSelection) {
+ event.stopPropagation();
+ return;
+ }
+
// Only action the primary button
if (event.button !== 0) {
return;
}
- this._setMouseClickCount();
- console.log(this._clickCount);
+ // Allow selection when using a specific modifier key, even when disabled
+ if (!this._enabled) {
+ const shouldForceSelection = Browser.isMac && event.altKey;
+
+ if (!shouldForceSelection) {
+ return;
+ }
+
+ // Don't send the mouse down event to the current process, we want to select
+ event.stopPropagation();
+ }
+
+ // Tell the browser not to start a regular selection
+ event.preventDefault();
- if (event.shiftKey) {
- this._onShiftClick(event);
+ // Reset drag scroll state
+ this._dragScrollAmount = 0;
+
+ if (this._enabled && event.shiftKey) {
+ this._onIncrementalClick(event);
} else {
- if (this._clickCount === 1) {
- this._onSingleClick(event);
- } else if (this._clickCount === 2) {
- this._onDoubleClick(event);
- } else if (this._clickCount === 3) {
- this._onTripleClick(event);
+ if (event.detail === 1) {
+ this._onSingleClick(event);
+ } else if (event.detail === 2) {
+ this._onDoubleClick(event);
+ } else if (event.detail === 3) {
+ this._onTripleClick(event);
}
}
+ this._addMouseDownListeners();
+ this.refresh(true);
+ }
+
+ /**
+ * Adds listeners when mousedown is triggered.
+ */
+ private _addMouseDownListeners(): void {
// Listen on the document so that dragging outside of viewport works
this._rowContainer.ownerDocument.addEventListener('mousemove', this._mouseMoveListener);
this._rowContainer.ownerDocument.addEventListener('mouseup', this._mouseUpListener);
- this._dragScrollTimeout = setInterval(() => this._dragScroll(), DRAG_SCROLL_INTERVAL);
- this.refresh();
+ this._dragScrollIntervalTimer = setInterval(() => this._dragScroll(), DRAG_SCROLL_INTERVAL);
+ }
+
+ /**
+ * Removes the listeners that are registered when mousedown is triggered.
+ */
+ private _removeMouseDownListeners(): void {
+ this._rowContainer.ownerDocument.removeEventListener('mousemove', this._mouseMoveListener);
+ this._rowContainer.ownerDocument.removeEventListener('mouseup', this._mouseUpListener);
+ clearInterval(this._dragScrollIntervalTimer);
+ this._dragScrollIntervalTimer = null;
}
- private _onShiftClick(event: MouseEvent): void {
+ /**
+ * Performs an incremental click, setting the selection end position to the mouse
+ * position.
+ * @param event The mouse event.
+ */
+ private _onIncrementalClick(event: MouseEvent): void {
if (this._model.selectionStart) {
this._model.selectionEnd = this._getMouseBufferCoords(event);
}
}
+ /**
+ * Performs a single click, resetting relevant state and setting the selection
+ * start position.
+ * @param event The mouse event.
+ */
private _onSingleClick(event: MouseEvent): void {
this._model.selectionStartLength = 0;
this._model.isSelectAllActive = false;
+ this._activeSelectionMode = SelectionMode.NORMAL;
+
+ // Initialize the new selection
this._model.selectionStart = this._getMouseBufferCoords(event);
- if (this._model.selectionStart) {
- this._model.selectionEnd = null;
- // If the mouse is over the second half of a wide character, adjust the
- // selection to cover the whole character
- const char = this._buffer.get(this._model.selectionStart[1])[this._model.selectionStart[0]];
- if (char[LINE_DATA_WIDTH_INDEX] === 0) {
- this._model.selectionStart[0]++;
- }
+ if (!this._model.selectionStart) {
+ return;
+ }
+ this._model.selectionEnd = null;
+
+ // Ensure the line exists
+ const line = this._buffer.get(this._model.selectionStart[1]);
+ if (!line) {
+ return;
+ }
+
+ // If the mouse is over the second half of a wide character, adjust the
+ // selection to cover the whole character
+ const char = line[this._model.selectionStart[0]];
+ if (char[LINE_DATA_WIDTH_INDEX] === 0) {
+ this._model.selectionStart[0]++;
}
}
+ /**
+ * Performs a double click, selecting the current work.
+ * @param event The mouse event.
+ */
private _onDoubleClick(event: MouseEvent): void {
const coords = this._getMouseBufferCoords(event);
if (coords) {
+ this._activeSelectionMode = SelectionMode.WORD;
this._selectWordAt(coords);
}
}
+ /**
+ * Performs a triple click, selecting the current line and activating line
+ * select mode.
+ * @param event The mouse event.
+ */
private _onTripleClick(event: MouseEvent): void {
const coords = this._getMouseBufferCoords(event);
if (coords) {
+ this._activeSelectionMode = SelectionMode.LINE;
this._selectLineAt(coords[1]);
}
}
- private _setMouseClickCount(): void {
- let currentTime = (new Date()).getTime();
- if (currentTime - this._lastMouseDownTime > CLEAR_MOUSE_DOWN_TIME) {
- this._clickCount = 0;
- }
- this._lastMouseDownTime = currentTime;
- this._clickCount++;
-
- // TODO: Invalidate click count if the position is different
- }
-
/**
* Handles the mousemove event when the mouse button is down, recording the
* end of the selection and refreshing the selection.
* @param event The mousemove event.
*/
private _onMouseMove(event: MouseEvent) {
+ // Record the previous position so we know whether to redraw the selection
+ // at the end.
+ const previousSelectionEnd = this._model.selectionEnd ? [this._model.selectionEnd[0], this._model.selectionEnd[1]] : null;
+
+ // Set the initial selection end based on the mouse coordinates
this._model.selectionEnd = this._getMouseBufferCoords(event);
- // TODO: Perhaps the actual selection setting could be merged into _dragScroll?
+ if (!this._model.selectionEnd) {
+ this.refresh(true);
+ return;
+ }
+
+ // Select the entire line if line select mode is active.
+ if (this._activeSelectionMode === SelectionMode.LINE) {
+ if (this._model.selectionEnd[1] < this._model.selectionStart[1]) {
+ this._model.selectionEnd[0] = 0;
+ } else {
+ this._model.selectionEnd[0] = this._terminal.cols;
+ }
+ } else if (this._activeSelectionMode === SelectionMode.WORD) {
+ this._selectToWordAt(this._model.selectionEnd);
+ }
+
+ // Determine the amount of scrolling that will happen.
this._dragScrollAmount = this._getMouseEventScrollAmount(event);
+
// If the cursor was above or below the viewport, make sure it's at the
- // start or end of the viewport respectively
+ // start or end of the viewport respectively.
if (this._dragScrollAmount > 0) {
this._model.selectionEnd[0] = this._terminal.cols - 1;
} else if (this._dragScrollAmount < 0) {
}
// If the character is a wide character include the cell to the right in the
- // selection.
- const char = this._buffer.get(this._model.selectionEnd[1])[this._model.selectionEnd[0]];
- if (char[2] === 0) {
- this._model.selectionEnd[0]++;
+ // selection. Note that selections at the very end of the line will never
+ // have a character.
+ if (this._model.selectionEnd[1] < this._buffer.length) {
+ const char = this._buffer.get(this._model.selectionEnd[1])[this._model.selectionEnd[0]];
+ if (char && char[2] === 0) {
+ this._model.selectionEnd[0]++;
+ }
}
- // TODO: Only draw here if the selection changes
- this.refresh();
+ // Only draw here if the selection changes.
+ if (!previousSelectionEnd ||
+ previousSelectionEnd[0] !== this._model.selectionEnd[0] ||
+ previousSelectionEnd[1] !== this._model.selectionEnd[1]) {
+ this.refresh(true);
+ }
}
+ /**
+ * The callback that occurs every DRAG_SCROLL_INTERVAL ms that does the
+ * scrolling of the viewport.
+ */
private _dragScroll() {
if (this._dragScrollAmount) {
this._terminal.scrollDisp(this._dragScrollAmount, false);
// Re-evaluate selection
if (this._dragScrollAmount > 0) {
- this._model.selectionEnd = [this._terminal.cols - 1, this._terminal.ydisp + this._terminal.rows];
+ this._model.selectionEnd = [this._terminal.cols - 1, this._terminal.buffer.ydisp + this._terminal.rows];
} else {
- this._model.selectionEnd = [0, this._terminal.ydisp];
+ this._model.selectionEnd = [0, this._terminal.buffer.ydisp];
}
this.refresh();
}
}
/**
- * Handles the mouseup event, removing the mousemove listener when
- * appropriate.
+ * Handles the mouseup event, removing the mousedown listeners.
* @param event The mouseup event.
*/
private _onMouseUp(event: MouseEvent) {
- this._dragScrollAmount = 0;
- if (!this._model.selectionStart) {
- return;
- }
- this._rowContainer.ownerDocument.removeEventListener('mousemove', this._mouseMoveListener);
- this._rowContainer.ownerDocument.removeEventListener('mouseup', this._mouseUpListener);
+ this._removeMouseDownListeners();
}
/**
return charIndex;
}
+ public setSelection(col: number, row: number, length: number): void {
+ this._model.clearSelection();
+ this._removeMouseDownListeners();
+ this._model.selectionStart = [col, row];
+ this._model.selectionStartLength = length;
+ this.refresh();
+ }
+
/**
- * Selects the word at the coordinates specified. Words are defined as all
- * non-whitespace characters.
+ * Gets positional information for the word at the coordinated specified.
* @param coords The coordinates to get the word at.
*/
- protected _selectWordAt(coords: [number, number]): void {
- // TODO: Only fetch buffer line once for translate and convert functions
+ private _getWordAt(coords: [number, number]): IWordPosition {
const bufferLine = this._buffer.get(coords[1]);
- const line = this._translateBufferLineToString(bufferLine, false);
+ if (!bufferLine) {
+ return null;
+ }
+
+ const line = translateBufferLineToString(bufferLine, false);
// Get actual index, taking into consideration wide characters
let endIndex = this._convertViewportColToCharacterIndex(bufferLine, coords);
endCol++;
}
// Expand the string in both directions until a space is hit
- while (startIndex > 0 && line.charAt(startIndex - 1) !== ' ') {
+ while (startIndex > 0 && !this._isCharWordSeparator(line.charAt(startIndex - 1))) {
if (bufferLine[startCol - 1][LINE_DATA_WIDTH_INDEX] === 0) {
// If the next character is a wide char, record it and skip the column
leftWideCharCount++;
startIndex--;
startCol--;
}
- while (endIndex + 1 < line.length && line.charAt(endIndex + 1) !== ' ') {
+ while (endIndex + 1 < line.length && !this._isCharWordSeparator(line.charAt(endIndex + 1))) {
if (bufferLine[endCol + 1][LINE_DATA_WIDTH_INDEX] === 2) {
// If the next character is a wide char, record it and skip the column
rightWideCharCount++;
}
}
- // Record the resulting selection
- this._model.selectionStart = [startIndex + charOffset - leftWideCharCount, coords[1]];
- this._model.selectionStartLength = endIndex - startIndex + leftWideCharCount + rightWideCharCount + 1/*include endIndex char*/;
+ const start = startIndex + charOffset - leftWideCharCount;
+ const length = Math.min(endIndex - startIndex + leftWideCharCount + rightWideCharCount + 1/*include endIndex char*/, this._terminal.cols);
+ return { start, length };
}
- private _selectLineAt(line: number): void {
+ /**
+ * Selects the word at the coordinates specified.
+ * @param coords The coordinates to get the word at.
+ */
+ protected _selectWordAt(coords: [number, number]): void {
+ const wordPosition = this._getWordAt(coords);
+ if (wordPosition) {
+ this._model.selectionStart = [wordPosition.start, coords[1]];
+ this._model.selectionStartLength = wordPosition.length;
+ }
+ }
+
+ /**
+ * Sets the selection end to the word at the coordinated specified.
+ * @param coords The coordinates to get the word at.
+ */
+ private _selectToWordAt(coords: [number, number]): void {
+ const wordPosition = this._getWordAt(coords);
+ if (wordPosition) {
+ this._model.selectionEnd = [this._model.areSelectionValuesReversed() ? wordPosition.start : (wordPosition.start + wordPosition.length), coords[1]];
+ }
+ }
+
+ /**
+ * Gets whether the character is considered a word separator by the select
+ * word logic.
+ * @param char The character to check.
+ */
+ private _isCharWordSeparator(char: string): boolean {
+ return WORD_SEPARATORS.indexOf(char) >= 0;
+ }
+
+ /**
+ * Selects the line specified.
+ * @param line The line index.
+ */
+ protected _selectLineAt(line: number): void {
this._model.selectionStart = [0, line];
this._model.selectionStartLength = this._terminal.cols;
}
projects / mirror_xterm.js.git / blobdiff