* @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 { SelectionModel } from './SelectionModel';
*/
const CLEAR_MOUSE_DISTANCE = 10;
+/**
+ * A string containing all characters that are considered word separated by the
+ * double click to select work logic.
+ */
+const WORD_SEPARATORS = ' ()[]{}\'"';
+
// 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 {
protected _model: SelectionModel;
private _clickCount: number;
/**
- * Whether line select mode is active, this occurs after a triple click.
+ * The current selection mode.
*/
- private _isLineSelectModeActive: boolean;
+ private _activeSelectionMode: SelectionMode;
/**
* A setInterval timer that is active while the mouse is down whose callback
*/
private _dragScrollIntervalTimer: NodeJS.Timer;
+ /**
+ * The animation frame ID used for refreshing the selection.
+ */
+ private _refreshAnimationFrame: number;
+
private _bufferTrimListener: any;
private _mouseMoveListener: EventListener;
private _mouseDownListener: EventListener;
this._model = new SelectionModel(_terminal);
this._lastMouseDownTime = 0;
- this._isLineSelectModeActive = false;
+ this._activeSelectionMode = SelectionMode.NORMAL;
}
/**
* are enabled.
*/
public disable() {
- this._model.selectionStart = null;
- this._model.selectionEnd = null;
- this.refresh();
+ this.clearSelection();
this._buffer.off('trim', this._bufferTrimListener);
this._rowContainer.removeEventListener('mousedown', this._mouseDownListener);
- this._removeMouseDownListeners();
}
/**
this._rowContainer.addEventListener('mousedown', this._mouseDownListener);
}
+ /**
+ * 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: CircularList<any>): void {
+ this._buffer = buffer;
+ this.clearSelection();
+ }
+
+ /**
+ * 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];
+ }
+
/**
* Gets the text currently selected.
*/
// 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 = this._translateBufferLineToString(bufferLine, true);
+ if (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 = this._translateBufferLineToString(bufferLine, true, 0, end[0]);
+ if (bufferLine.isWrapped) {
+ result[result.length - 1] += lineText;
+ } else {
+ result.push(lineText);
+ }
}
- 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;
+ }
+
+ /**
+ * Clears the current terminal selection.
+ */
+ public clearSelection(): void {
+ this._model.clearSelection();
+ this._removeMouseDownListeners();
+ this.refresh();
}
/**
}
/**
- * Redraws the selection.
+ * 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());
+ }
+
+ // 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);
+ }
+ }
+ }
+
+ /**
+ * Fires the refresh event, causing consumers to pick it up and redraw the
+ * selection state.
*/
- public refresh(): void {
+ private _refresh(): void {
+ this._refreshAnimationFrame = null;
this.emit('refresh', { start: this._model.finalSelectionStart, end: this._model.finalSelectionEnd });
}
* @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);
+ const coords = Mouse.getCoords(event, this._rowContainer, this._charMeasure, this._terminal.cols, this._terminal.rows, true);
// Convert to 0-based
coords[0]--;
coords[1]--;
return;
}
+ // Tell the browser not to start a regular selection
+ event.preventDefault();
+
// Reset drag scroll state
this._dragScrollAmount = 0;
}
this._addMouseDownListeners();
- this.refresh();
+ this.refresh(true);
}
/**
private _onSingleClick(event: MouseEvent): void {
this._model.selectionStartLength = 0;
this._model.isSelectAllActive = false;
- this._isLineSelectModeActive = false;
+ this._activeSelectionMode = SelectionMode.NORMAL;
this._model.selectionStart = this._getMouseBufferCoords(event);
if (this._model.selectionStart) {
this._model.selectionEnd = null;
private _onDoubleClick(event: MouseEvent): void {
const coords = this._getMouseBufferCoords(event);
if (coords) {
+ this._activeSelectionMode = SelectionMode.WORD;
this._selectWordAt(coords);
}
}
private _onTripleClick(event: MouseEvent): void {
const coords = this._getMouseBufferCoords(event);
if (coords) {
- this._isLineSelectModeActive = true;
+ this._activeSelectionMode = SelectionMode.LINE;
this._selectLineAt(coords[1]);
}
}
this._model.selectionEnd = this._getMouseBufferCoords(event);
// Select the entire line if line select mode is active.
- if (this._isLineSelectModeActive) {
+ 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.
if (!previousSelectionEnd ||
previousSelectionEnd[0] !== this._model.selectionEnd[0] ||
previousSelectionEnd[1] !== this._model.selectionEnd[1]) {
- this.refresh();
+ this.refresh(true);
}
}
}
/**
- * 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 {
+ private _getWordAt(coords: [number, number]): IWordPosition {
const bufferLine = this._buffer.get(coords[1]);
const line = this._translateBufferLineToString(bufferLine, false);
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 = Math.min(endIndex - startIndex + leftWideCharCount + rightWideCharCount + 1/*include endIndex char*/, this._terminal.cols);
+ const start = startIndex + charOffset - leftWideCharCount;
+ const length = Math.min(endIndex - startIndex + leftWideCharCount + rightWideCharCount + 1/*include endIndex char*/, this._terminal.cols);
+ return {start, length};
+ }
+
+ /**
+ * 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);
+ 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);
+ 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;
}
/**
projects / mirror_xterm.js.git / blobdiff