* @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';
+import { translateBufferLineToString } from './utils/BufferLine';
/**
* The number of pixels the mouse needs to be above or below the viewport in
const DRAG_SCROLL_INTERVAL = 50;
/**
- * The amount of time before mousedown events are no longer stacked to create
- * double/triple click events.
- */
-const CLEAR_MOUSE_DOWN_TIME = 400;
-
-/**
- * The number of pixels in each direction that the mouse must move before
- * mousedown events are no longer stacked to create double/triple click events.
+ * A string containing all characters that are considered word separated by the
+ * double click to select work logic.
*/
-const CLEAR_MOUSE_DISTANCE = 10;
+const WORD_SEPARATORS = ' ()[]{}\'"';
// TODO: Move these constants elsewhere, they belong in a buffer or buffer
// data/line class.
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
private _dragScrollAmount: number;
/**
- * The last time the mousedown event fired, this is used to track double and
- * triple clicks.
- */
- private _lastMouseDownTime: number;
-
- /**
- * The last position the mouse was clicked [x, y].
- */
- private _lastMousePosition: [number, number];
-
- /**
- * The number of clicks of the mousedown event. This is used to keep track of
- * double and triple clicks.
- */
- 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
this.enable();
this._model = new SelectionModel(_terminal);
- this._lastMouseDownTime = 0;
- this._isLineSelectModeActive = false;
+ this._activeSelectionMode = SelectionMode.NORMAL;
}
/**
*/
public setBuffer(buffer: CircularList<any>): 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 {
- return !!this._model.finalSelectionStart && !!this._model.finalSelectionEnd;
+ 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 (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 (bufferLine.isWrapped) {
+ result[result.length - 1] += lineText;
+ } else {
+ result.push(lineText);
+ }
}
// 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('\n');
+ }).join(Browser.isMSWindows ? '\r\n' : '\n');
return formattedResult;
}
this.refresh();
}
- /**
- * Translates a buffer line to a string, with optional start and end columns.
- * Wide characters will count as two columns in the resulting string. This
- * function is useful for getting the actual text underneath the raw selection
- * position.
- * @param line The line being translated.
- * @param trimRight Whether to trim whitespace to the right.
- * @param startCol The column to start at.
- * @param endCol The column to end at.
- */
- 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--;
- }
- }
- }
-
- // 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 '';
- }
- }
-
- return lineString.substring(widthAdjustedStartCol, finalEndCol);
- }
-
/**
* 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(): void {
+ 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);
+ }
+ }
}
/**
* @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._setMouseClickCount(event);
-
if (event.shiftKey) {
this._onShiftClick(event);
} else {
- if (this._clickCount === 1) {
+ if (event.detail === 1) {
this._onSingleClick(event);
- } else if (this._clickCount === 2) {
+ } else if (event.detail === 2) {
this._onDoubleClick(event);
- } else if (this._clickCount === 3) {
+ } else if (event.detail === 3) {
this._onTripleClick(event);
}
}
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]);
}
}
- /**
- * Sets the number of clicks for the current mousedown event based on the time
- * and position of the last mousedown event.
- * @param event The mouse event.
- */
- private _setMouseClickCount(event: MouseEvent): void {
- let currentTime = (new Date()).getTime();
- if (currentTime - this._lastMouseDownTime > CLEAR_MOUSE_DOWN_TIME || this._distanceFromLastMousePosition(event) > CLEAR_MOUSE_DISTANCE) {
- this._clickCount = 0;
- }
- this._lastMouseDownTime = currentTime;
- this._lastMousePosition = [event.pageX, event.pageY];
- this._clickCount++;
- }
-
- /**
- * Gets the maximum number of pixels in each direction the mouse has moved.
- * @param event The mouse event.
- */
- private _distanceFromLastMousePosition(event: MouseEvent): number {
- const result = Math.max(
- Math.abs(this._lastMousePosition[0] - event.pageX),
- Math.abs(this._lastMousePosition[1] - event.pageY));
- return result;
- }
-
/**
* Handles the mousemove event when the mouse button is down, recording the
* end of the selection and refreshing the selection.
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);
}
}
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 {
+ private _getWordAt(coords: [number, number]): IWordPosition {
const bufferLine = this._buffer.get(coords[1]);
- const line = this._translateBufferLineToString(bufferLine, false);
+ 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 = 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