import { CharMeasure } from './utils/CharMeasure';
import { CircularList } from './utils/CircularList';
import { EventEmitter } from './EventEmitter';
-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
*/
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.
- */
-const CLEAR_MOUSE_DISTANCE = 10;
-
/**
* A string containing all characters that are considered word separated by the
* double click to select work logic.
*/
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;
-
/**
* The current selection mode.
*/
*/
private _refreshAnimationFrame: number;
- private _bufferTrimListener: any;
+ /**
+ * Whether selection is enabled.
+ */
+ private _enabled = true;
+
private _mouseMoveListener: EventListener;
- private _mouseDownListener: EventListener;
private _mouseUpListener: EventListener;
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));
}
/**
*/
public disable() {
this.clearSelection();
- this._buffer.off('trim', this._bufferTrimListener);
- this._rowContainer.removeEventListener('mousedown', this._mouseDownListener);
+ this._enabled = false;
}
/**
* Enable the selection manager.
*/
public enable() {
- // 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', this._bufferTrimListener);
- this._rowContainer.addEventListener('mousedown', this._mouseDownListener);
+ this._enabled = true;
}
/**
* switched in or out.
* @param buffer The active buffer.
*/
- public setBuffer(buffer: CircularList<any>): void {
+ 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.
*/
// 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++) {
const bufferLine = this._buffer.get(i);
- const lineText = this._translateBufferLineToString(bufferLine, true);
- if (bufferLine.isWrapped) {
+ 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]) {
const bufferLine = this._buffer.get(end[1]);
- const lineText = this._translateBufferLineToString(bufferLine, true, 0, end[0]);
- if (bufferLine.isWrapped) {
+ const lineText = translateBufferLineToString(bufferLine, true, 0, end[0]);
+ if ((<any>bufferLine).isWrapped) {
result[result.length - 1] += lineText;
} else {
result.push(lineText);
// 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
*/
private _getMouseBufferCoords(event: MouseEvent): [number, number] {
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;
}
* @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;
}
+ // 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();
// Reset drag scroll state
this._dragScrollAmount = 0;
- this._setMouseClickCount(event);
-
- if (event.shiftKey) {
- this._onShiftClick(event);
+ 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);
}
}
}
/**
- * Performs a shift click, setting the selection end position to the mouse
+ * Performs an incremental click, setting the selection end position to the mouse
* position.
* @param event The mouse event.
*/
- private _onShiftClick(event: MouseEvent): void {
+ private _onIncrementalClick(event: MouseEvent): void {
if (this._model.selectionStart) {
this._model.selectionEnd = this._getMouseBufferCoords(event);
}
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]++;
}
}
}
}
- /**
- * 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.
// Set the initial selection end based on the mouse coordinates
this._model.selectionEnd = this._getMouseBufferCoords(event);
+ if (!this._model.selectionEnd) {
+ this.refresh(true);
+ return;
+ }
// Select the entire line if line select mode is active.
if (this._activeSelectionMode === SelectionMode.LINE) {
// Only draw here if the selection changes.
if (!previousSelectionEnd ||
- previousSelectionEnd[0] !== this._model.selectionEnd[0] ||
- previousSelectionEnd[1] !== this._model.selectionEnd[1]) {
+ previousSelectionEnd[0] !== this._model.selectionEnd[0] ||
+ previousSelectionEnd[1] !== this._model.selectionEnd[1]) {
this.refresh(true);
}
}
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();
}
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();
+ }
+
/**
* Gets positional information for the word at the coordinated specified.
* @param coords The coordinates to get the word at.
*/
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);
const start = startIndex + charOffset - leftWideCharCount;
const length = Math.min(endIndex - startIndex + leftWideCharCount + rightWideCharCount + 1/*include endIndex char*/, this._terminal.cols);
- return {start, length};
+ return { start, length };
}
/**
*/
protected _selectWordAt(coords: [number, number]): void {
const wordPosition = this._getWordAt(coords);
- this._model.selectionStart = [wordPosition.start, coords[1]];
- this._model.selectionStartLength = wordPosition.length;
+ if (wordPosition) {
+ this._model.selectionStart = [wordPosition.start, coords[1]];
+ this._model.selectionStartLength = wordPosition.length;
+ }
}
/**
*/
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]];
+ if (wordPosition) {
+ this._model.selectionEnd = [this._model.areSelectionValuesReversed() ? wordPosition.start : (wordPosition.start + wordPosition.length), coords[1]];
+ }
}
/**
projects / mirror_xterm.js.git / blobdiff