5 import { CharMeasure } from './utils/CharMeasure';
6 import { CircularList } from './utils/CircularList';
7 import { EventEmitter } from './EventEmitter';
8 import * as Mouse from './utils/Mouse';
9 import { ITerminal } from './Interfaces';
10 import { SelectionModel } from './SelectionModel';
13 * The number of pixels the mouse needs to be above or below the viewport in
14 * order to scroll at the maximum speed.
16 const DRAG_SCROLL_MAX_THRESHOLD = 100;
19 * The maximum scrolling speed
21 const DRAG_SCROLL_MAX_SPEED = 5;
24 * The number of milliseconds between drag scroll updates.
26 const DRAG_SCROLL_INTERVAL = 100;
29 * The amount of time before mousedown events are no longer stacked to create
30 * double/triple click events.
32 const CLEAR_MOUSE_DOWN_TIME = 400;
35 * The number of pixels in each direction that the mouse must move before
36 * mousedown events are no longer stacked to create double/triple click events.
38 const CLEAR_MOUSE_DISTANCE = 10;
40 // TODO: Move these constants elsewhere, they belong in a buffer or buffer
42 const LINE_DATA_CHAR_INDEX = 1;
43 const LINE_DATA_WIDTH_INDEX = 2;
45 export class SelectionManager extends EventEmitter {
46 protected _model: SelectionModel;
49 * The amount to scroll every drag scroll update (depends on how far the mouse
50 * drag is above or below the terminal).
52 private _dragScrollAmount: number;
55 * The last time the mousedown event fired, this is used to track double and
58 private _lastMouseDownTime: number;
61 * The last position the mouse was clicked [x, y].
63 private _lastMousePosition: [number, number];
66 * The number of clicks of the mousedown event. This is used to keep track of
67 * double and triple clicks.
69 private _clickCount: number;
72 * Whether line select mode is active, this occurs after a triple click.
74 private _isLineSelectModeActive: boolean;
77 * A setInterval timer that is active while the mouse is down whose callback
78 * scrolls the viewport when necessary.
80 private _dragScrollIntervalTimer: NodeJS.Timer;
82 private _bufferTrimListener: any;
83 private _mouseMoveListener: EventListener;
84 private _mouseDownListener: EventListener;
85 private _mouseUpListener: EventListener;
88 private _terminal: ITerminal,
89 private _buffer: CircularList<any>,
90 private _rowContainer: HTMLElement,
91 private _charMeasure: CharMeasure
94 this._initListeners();
97 this._model = new SelectionModel(_terminal);
98 this._lastMouseDownTime = 0;
99 this._isLineSelectModeActive = false;
103 * Initializes listener variables.
105 private _initListeners() {
106 this._bufferTrimListener = (amount: number) => this._onTrim(amount);
107 this._mouseMoveListener = event => this._onMouseMove(<MouseEvent>event);
108 this._mouseDownListener = event => this._onMouseDown(<MouseEvent>event);
109 this._mouseUpListener = event => this._onMouseUp(<MouseEvent>event);
113 * Disables the selection manager. This is useful for when terminal mouse
117 this._model.selectionStart = null;
118 this._model.selectionEnd = null;
120 this._buffer.off('trim', this._bufferTrimListener);
121 this._rowContainer.removeEventListener('mousedown', this._mouseDownListener);
122 this._rowContainer.ownerDocument.removeEventListener('mousemove', this._mouseMoveListener);
123 this._rowContainer.ownerDocument.removeEventListener('mouseup', this._mouseUpListener);
124 clearInterval(this._dragScrollIntervalTimer);
128 * Enable the selection manager.
131 // Only adjust the selection on trim, shiftElements is rarely used (only in
132 // reverseIndex) and delete in a splice is only ever used when the same
133 // number of elements was just added. Given this is could actually be
134 // beneficial to leave the selection as is for these cases.
135 this._buffer.on('trim', this._bufferTrimListener);
136 this._rowContainer.addEventListener('mousedown', this._mouseDownListener);
140 * Gets the text currently selected.
142 public get selectionText(): string {
143 const start = this._model.finalSelectionStart;
144 const end = this._model.finalSelectionEnd;
145 if (!start || !end) {
150 const startRowEndCol = start[1] === end[1] ? end[0] : null;
151 let result: string[] = [];
152 result.push(this._translateBufferLineToString(this._buffer.get(start[1]), true, start[0], startRowEndCol));
155 for (let i = start[1] + 1; i <= end[1] - 1; i++) {
156 result.push(this._translateBufferLineToString(this._buffer.get(i), true));
160 if (start[1] !== end[1]) {
161 result.push(this._translateBufferLineToString(this._buffer.get(end[1]), true, 0, end[0]));
163 console.log('selectionText result: "' + result + '"');
164 return result.join('\n');
168 * Translates a buffer line to a string, with optional start and end columns.
169 * Wide characters will count as two columns in the resulting string. This
170 * function is useful for getting the actual text underneath the raw selection
172 * @param line The line being translated.
173 * @param trimRight Whether to trim whitespace to the right.
174 * @param startCol The column to start at.
175 * @param endCol The column to end at.
177 private _translateBufferLineToString(line: any, trimRight: boolean, startCol: number = 0, endCol: number = null): string {
178 // TODO: This function should live in a buffer or buffer line class
182 let widthAdjustedStartCol = startCol;
183 let widthAdjustedEndCol = endCol;
184 for (let i = 0; i < line.length; i++) {
185 const char = line[i];
186 lineString += char[LINE_DATA_CHAR_INDEX];
187 // Adjust start and end cols for wide characters if they affect their
189 if (char[LINE_DATA_WIDTH_INDEX] === 0) {
191 widthAdjustedStartCol--;
194 widthAdjustedEndCol--;
199 // Calculate the final end col by trimming whitespace on the right of the
201 let finalEndCol = widthAdjustedEndCol || line.length;
203 const rightWhitespaceIndex = lineString.search(/\s+$/);
204 if (rightWhitespaceIndex !== -1) {
205 finalEndCol = Math.min(finalEndCol, rightWhitespaceIndex);
207 // Return the empty string if only trimmed whitespace is selected
208 if (finalEndCol <= widthAdjustedStartCol) {
213 return lineString.substring(widthAdjustedStartCol, finalEndCol);
217 * Redraws the selection.
219 public refresh(): void {
220 this.emit('refresh', { start: this._model.finalSelectionStart, end: this._model.finalSelectionEnd });
224 * Selects all text within the terminal.
226 public selectAll(): void {
227 this._model.isSelectAllActive = true;
232 * Handle the buffer being trimmed, adjust the selection position.
233 * @param amount The amount the buffer is being trimmed.
235 private _onTrim(amount: number) {
236 const needsRefresh = this._model.onTrim(amount);
243 * Gets the 0-based [x, y] buffer coordinates of the current mouse event.
244 * @param event The mouse event.
246 private _getMouseBufferCoords(event: MouseEvent): [number, number] {
247 const coords = Mouse.getCoords(event, this._rowContainer, this._charMeasure, this._terminal.cols, this._terminal.rows);
249 // Convert to 0-based
252 // Convert viewport coords to buffer coords
253 coords[1] += this._terminal.ydisp;
258 * Gets the amount the viewport should be scrolled based on how far out of the
259 * terminal the mouse is.
260 * @param event The mouse event.
262 private _getMouseEventScrollAmount(event: MouseEvent): number {
263 let offset = Mouse.getCoordsRelativeToElement(event, this._rowContainer)[1];
264 const terminalHeight = this._terminal.rows * this._charMeasure.height;
265 if (offset >= 0 && offset <= terminalHeight) {
268 if (offset > terminalHeight) {
269 offset -= terminalHeight;
272 offset = Math.min(Math.max(offset, -DRAG_SCROLL_MAX_THRESHOLD), DRAG_SCROLL_MAX_THRESHOLD);
273 offset /= DRAG_SCROLL_MAX_THRESHOLD;
274 return (offset / Math.abs(offset)) + Math.round(offset * (DRAG_SCROLL_MAX_SPEED - 1));
278 * Handles te mousedown event, setting up for a new selection.
279 * @param event The mousedown event.
281 private _onMouseDown(event: MouseEvent) {
282 // Only action the primary button
283 if (event.button !== 0) {
287 this._setMouseClickCount(event);
288 console.log(this._clickCount);
290 if (event.shiftKey) {
291 this._onShiftClick(event);
293 if (this._clickCount === 1) {
294 this._onSingleClick(event);
295 } else if (this._clickCount === 2) {
296 this._onDoubleClick(event);
297 } else if (this._clickCount === 3) {
298 this._onTripleClick(event);
302 // Listen on the document so that dragging outside of viewport works
303 this._rowContainer.ownerDocument.addEventListener('mousemove', this._mouseMoveListener);
304 this._rowContainer.ownerDocument.addEventListener('mouseup', this._mouseUpListener);
305 this._dragScrollIntervalTimer = setInterval(() => this._dragScroll(), DRAG_SCROLL_INTERVAL);
310 * Performs a shift click, setting the selection end position to the mouse
312 * @param event The mouse event.
314 private _onShiftClick(event: MouseEvent): void {
315 if (this._model.selectionStart) {
316 this._model.selectionEnd = this._getMouseBufferCoords(event);
321 * Performs a single click, resetting relevant state and setting the selection
323 * @param event The mouse event.
325 private _onSingleClick(event: MouseEvent): void {
326 this._model.selectionStartLength = 0;
327 this._model.isSelectAllActive = false;
328 this._isLineSelectModeActive = false;
329 this._model.selectionStart = this._getMouseBufferCoords(event);
330 if (this._model.selectionStart) {
331 this._model.selectionEnd = null;
332 // If the mouse is over the second half of a wide character, adjust the
333 // selection to cover the whole character
334 const char = this._buffer.get(this._model.selectionStart[1])[this._model.selectionStart[0]];
335 if (char[LINE_DATA_WIDTH_INDEX] === 0) {
336 this._model.selectionStart[0]++;
342 * Performs a double click, selecting the current work.
343 * @param event The mouse event.
345 private _onDoubleClick(event: MouseEvent): void {
346 const coords = this._getMouseBufferCoords(event);
348 this._selectWordAt(coords);
353 * Performs a triple click, selecting the current line and activating line
355 * @param event The mouse event.
357 private _onTripleClick(event: MouseEvent): void {
358 const coords = this._getMouseBufferCoords(event);
360 this._isLineSelectModeActive = true;
361 this._selectLineAt(coords[1]);
366 * Sets the number of clicks for the current mousedown event based on the time
367 * and position of the last mousedown event.
368 * @param event The mouse event.
370 private _setMouseClickCount(event: MouseEvent): void {
371 let currentTime = (new Date()).getTime();
372 if (currentTime - this._lastMouseDownTime > CLEAR_MOUSE_DOWN_TIME || this._distanceFromLastMousePosition(event) > CLEAR_MOUSE_DISTANCE) {
373 this._clickCount = 0;
375 this._lastMouseDownTime = currentTime;
376 this._lastMousePosition = [event.pageX, event.pageY];
381 * Gets the maximum number of pixels in each direction the mouse has moved.
382 * @param event The mouse event.
384 private _distanceFromLastMousePosition(event: MouseEvent): number {
385 const result = Math.max(
386 Math.abs(this._lastMousePosition[0] - event.pageX),
387 Math.abs(this._lastMousePosition[1] - event.pageY));
392 * Handles the mousemove event when the mouse button is down, recording the
393 * end of the selection and refreshing the selection.
394 * @param event The mousemove event.
396 private _onMouseMove(event: MouseEvent) {
397 // Record the previous position so we know whether to redraw the selection
399 const previousSelectionEnd = this._model.selectionEnd ? [this._model.selectionEnd[0], this._model.selectionEnd[1]] : null;
401 // Set the initial selection end based on the mouse coordinates
402 this._model.selectionEnd = this._getMouseBufferCoords(event);
404 // Select the entire line if line select mode is active.
405 if (this._isLineSelectModeActive) {
406 if (this._model.selectionEnd[1] < this._model.selectionStart[1]) {
407 this._model.selectionEnd[0] = 0;
409 this._model.selectionEnd[0] = this._terminal.cols;
413 // Determine the amount of scrolling that will happen.
414 this._dragScrollAmount = this._getMouseEventScrollAmount(event);
416 // If the cursor was above or below the viewport, make sure it's at the
417 // start or end of the viewport respectively.
418 if (this._dragScrollAmount > 0) {
419 this._model.selectionEnd[0] = this._terminal.cols - 1;
420 } else if (this._dragScrollAmount < 0) {
421 this._model.selectionEnd[0] = 0;
424 // If the character is a wide character include the cell to the right in the
425 // selection. Note that selections at the very end of the line will never
427 const char = this._buffer.get(this._model.selectionEnd[1])[this._model.selectionEnd[0]];
428 if (char && char[2] === 0) {
429 this._model.selectionEnd[0]++;
432 // Only draw here if the selection changes.
433 if (!previousSelectionEnd ||
434 previousSelectionEnd[0] !== this._model.selectionEnd[0] ||
435 previousSelectionEnd[1] !== this._model.selectionEnd[1]) {
441 * The callback that occurs every DRAG_SCROLL_INTERVAL ms that does the
442 * scrolling of the viewport.
444 private _dragScroll() {
445 if (this._dragScrollAmount) {
446 this._terminal.scrollDisp(this._dragScrollAmount, false);
447 // Re-evaluate selection
448 if (this._dragScrollAmount > 0) {
449 this._model.selectionEnd = [this._terminal.cols - 1, this._terminal.ydisp + this._terminal.rows];
451 this._model.selectionEnd = [0, this._terminal.ydisp];
458 * Handles the mouseup event, removing the mousemove listener when
460 * @param event The mouseup event.
462 private _onMouseUp(event: MouseEvent) {
463 this._dragScrollAmount = 0;
464 if (!this._model.selectionStart) {
467 this._rowContainer.ownerDocument.removeEventListener('mousemove', this._mouseMoveListener);
468 this._rowContainer.ownerDocument.removeEventListener('mouseup', this._mouseUpListener);
472 * Converts a viewport column to the character index on the buffer line, the
473 * latter takes into account wide characters.
474 * @param coords The coordinates to find the 2 index for.
476 private _convertViewportColToCharacterIndex(bufferLine: any, coords: [number, number]): number {
477 let charIndex = coords[0];
478 for (let i = 0; coords[0] >= i; i++) {
479 const char = bufferLine[i];
480 if (char[LINE_DATA_WIDTH_INDEX] === 0) {
488 * Selects the word at the coordinates specified. Words are defined as all
489 * non-whitespace characters.
490 * @param coords The coordinates to get the word at.
492 protected _selectWordAt(coords: [number, number]): void {
493 const bufferLine = this._buffer.get(coords[1]);
494 const line = this._translateBufferLineToString(bufferLine, false);
496 // Get actual index, taking into consideration wide characters
497 let endIndex = this._convertViewportColToCharacterIndex(bufferLine, coords);
498 let startIndex = endIndex;
500 // Record offset to be used later
501 const charOffset = coords[0] - startIndex;
502 let leftWideCharCount = 0;
503 let rightWideCharCount = 0;
505 if (line.charAt(startIndex) === ' ') {
506 // Expand until non-whitespace is hit
507 while (startIndex > 0 && line.charAt(startIndex - 1) === ' ') {
510 while (endIndex < line.length && line.charAt(endIndex + 1) === ' ') {
514 // Expand until whitespace is hit. This algorithm works by scanning left
515 // and right from the starting position, keeping both the index format
516 // (line) and the column format (bufferLine) in sync. When a wide
517 // character is hit, it is recorded and the column index is adjusted.
518 let startCol = coords[0];
519 let endCol = coords[0];
520 // Consider the initial position, skip it and increment the wide char
522 if (bufferLine[startCol][LINE_DATA_WIDTH_INDEX] === 0) {
526 if (bufferLine[endCol][LINE_DATA_WIDTH_INDEX] === 2) {
527 rightWideCharCount++;
530 // Expand the string in both directions until a space is hit
531 while (startIndex > 0 && line.charAt(startIndex - 1) !== ' ') {
532 if (bufferLine[startCol - 1][LINE_DATA_WIDTH_INDEX] === 0) {
533 // If the next character is a wide char, record it and skip the column
540 while (endIndex + 1 < line.length && line.charAt(endIndex + 1) !== ' ') {
541 if (bufferLine[endCol + 1][LINE_DATA_WIDTH_INDEX] === 2) {
542 // If the next character is a wide char, record it and skip the column
543 rightWideCharCount++;
551 // Record the resulting selection
552 this._model.selectionStart = [startIndex + charOffset - leftWideCharCount, coords[1]];
553 this._model.selectionStartLength = Math.min(endIndex - startIndex + leftWideCharCount + rightWideCharCount + 1/*include endIndex char*/, this._terminal.cols);
557 * Selects the line specified.
558 * @param line The line index.
560 protected _selectLineAt(line: number): void {
561 this._model.selectionStart = [0, line];
562 this._model.selectionStartLength = this._terminal.cols;