Merge pull request #896 from npezza93/alt-click
Alt+click will move the prompt cursor to that position
This commit is contained in:
+4
-1
@@ -213,7 +213,10 @@ export class Buffer implements IBuffer {
|
|||||||
// needed here because some chars are 0 characters long (eg. after wide
|
// needed here because some chars are 0 characters long (eg. after wide
|
||||||
// chars) and some chars are longer than 1 characters long (eg. emojis).
|
// chars) and some chars are longer than 1 characters long (eg. emojis).
|
||||||
let startIndex = startCol;
|
let startIndex = startCol;
|
||||||
endCol = endCol || line.length;
|
// Only set endCol to the line length when it is null. 0 is a valid column.
|
||||||
|
if (endCol === null) {
|
||||||
|
endCol = line.length;
|
||||||
|
}
|
||||||
let endIndex = endCol;
|
let endIndex = endCol;
|
||||||
|
|
||||||
for (let i = 0; i < line.length; i++) {
|
for (let i = 0; i < line.length; i++) {
|
||||||
|
|||||||
+16
-1
@@ -11,6 +11,7 @@ import { CircularList } from './utils/CircularList';
|
|||||||
import { EventEmitter } from './EventEmitter';
|
import { EventEmitter } from './EventEmitter';
|
||||||
import { SelectionModel } from './SelectionModel';
|
import { SelectionModel } from './SelectionModel';
|
||||||
import { CHAR_DATA_WIDTH_INDEX, CHAR_DATA_CHAR_INDEX } from './Buffer';
|
import { CHAR_DATA_WIDTH_INDEX, CHAR_DATA_CHAR_INDEX } from './Buffer';
|
||||||
|
import { AltClickHandler } from './handlers/AltClickHandler';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The number of pixels the mouse needs to be above or below the viewport in
|
* The number of pixels the mouse needs to be above or below the viewport in
|
||||||
@@ -28,6 +29,12 @@ const DRAG_SCROLL_MAX_SPEED = 15;
|
|||||||
*/
|
*/
|
||||||
const DRAG_SCROLL_INTERVAL = 50;
|
const DRAG_SCROLL_INTERVAL = 50;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The maximum amount of time that can have elapsed for an alt click to move the
|
||||||
|
* cursor.
|
||||||
|
*/
|
||||||
|
const ALT_CLICK_MOVE_CURSOR_TIME = 500;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A string containing all characters that are considered word separated by the
|
* A string containing all characters that are considered word separated by the
|
||||||
* double click to select work logic.
|
* double click to select work logic.
|
||||||
@@ -96,6 +103,8 @@ export class SelectionManager extends EventEmitter implements ISelectionManager
|
|||||||
private _mouseUpListener: EventListener;
|
private _mouseUpListener: EventListener;
|
||||||
private _trimListener: (...args: any[]) => void;
|
private _trimListener: (...args: any[]) => void;
|
||||||
|
|
||||||
|
private _mouseDownTimeStamp: number;
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
private _terminal: ITerminal,
|
private _terminal: ITerminal,
|
||||||
private _charMeasure: CharMeasure
|
private _charMeasure: CharMeasure
|
||||||
@@ -317,6 +326,7 @@ export class SelectionManager extends EventEmitter implements ISelectionManager
|
|||||||
* @param event The mousedown event.
|
* @param event The mousedown event.
|
||||||
*/
|
*/
|
||||||
public onMouseDown(event: MouseEvent): void {
|
public onMouseDown(event: MouseEvent): void {
|
||||||
|
this._mouseDownTimeStamp = event.timeStamp;
|
||||||
// If we have selection, we want the context menu on right click even if the
|
// If we have selection, we want the context menu on right click even if the
|
||||||
// terminal is in mouse mode.
|
// terminal is in mouse mode.
|
||||||
if (event.button === 2 && this.hasSelection) {
|
if (event.button === 2 && this.hasSelection) {
|
||||||
@@ -536,10 +546,15 @@ export class SelectionManager extends EventEmitter implements ISelectionManager
|
|||||||
* @param event The mouseup event.
|
* @param event The mouseup event.
|
||||||
*/
|
*/
|
||||||
private _onMouseUp(event: MouseEvent): void {
|
private _onMouseUp(event: MouseEvent): void {
|
||||||
|
let timeElapsed = event.timeStamp - this._mouseDownTimeStamp;
|
||||||
|
|
||||||
this._removeMouseDownListeners();
|
this._removeMouseDownListeners();
|
||||||
|
|
||||||
if (this.hasSelection)
|
if (this.selectionText.length <= 1 && timeElapsed < ALT_CLICK_MOVE_CURSOR_TIME) {
|
||||||
|
(new AltClickHandler(event, this._terminal)).move();
|
||||||
|
} else if (this.hasSelection) {
|
||||||
this._terminal.emit('selection');
|
this._terminal.emit('selection');
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private _onBufferActivate(e: {activeBuffer: IBuffer, inactiveBuffer: IBuffer}): void {
|
private _onBufferActivate(e: {activeBuffer: IBuffer, inactiveBuffer: IBuffer}): void {
|
||||||
|
|||||||
@@ -188,12 +188,14 @@ export interface ITerminal extends PublicTerminal, IElementAccessor, IBufferAcce
|
|||||||
isFocused: boolean;
|
isFocused: boolean;
|
||||||
mouseHelper: IMouseHelper;
|
mouseHelper: IMouseHelper;
|
||||||
bracketedPasteMode: boolean;
|
bracketedPasteMode: boolean;
|
||||||
|
applicationCursor: boolean;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Emit the 'data' event and populate the given data.
|
* Emit the 'data' event and populate the given data.
|
||||||
* @param data The data to populate in the event.
|
* @param data The data to populate in the event.
|
||||||
*/
|
*/
|
||||||
handler(data: string): void;
|
handler(data: string): void;
|
||||||
|
send(data: string): void;
|
||||||
scrollLines(disp: number, suppressScrollEvent?: boolean): void;
|
scrollLines(disp: number, suppressScrollEvent?: boolean): void;
|
||||||
cancel(ev: Event, force?: boolean): boolean | void;
|
cancel(ev: Event, force?: boolean): boolean | void;
|
||||||
log(text: string): void;
|
log(text: string): void;
|
||||||
|
|||||||
@@ -0,0 +1,261 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2018 The xterm.js authors. All rights reserved.
|
||||||
|
* @license MIT
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { ITerminal, ICircularList, LineData } from '../Types';
|
||||||
|
import { C0 } from '../EscapeSequences';
|
||||||
|
|
||||||
|
enum Direction {
|
||||||
|
Up = 'A',
|
||||||
|
Down = 'B',
|
||||||
|
Right = 'C',
|
||||||
|
Left = 'D'
|
||||||
|
}
|
||||||
|
|
||||||
|
export class AltClickHandler {
|
||||||
|
private _startRow: number;
|
||||||
|
private _startCol: number;
|
||||||
|
private _endRow: number;
|
||||||
|
private _endCol: number;
|
||||||
|
private _lines: ICircularList<LineData>;
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
private _mouseEvent: MouseEvent,
|
||||||
|
private _terminal: ITerminal
|
||||||
|
) {
|
||||||
|
this._lines = this._terminal.buffer.lines;
|
||||||
|
this._startCol = this._terminal.buffer.x;
|
||||||
|
this._startRow = this._terminal.buffer.y;
|
||||||
|
|
||||||
|
[this._endCol, this._endRow] = this._terminal.mouseHelper.getCoords(
|
||||||
|
this._mouseEvent,
|
||||||
|
this._terminal.element,
|
||||||
|
this._terminal.charMeasure,
|
||||||
|
this._terminal.options.lineHeight,
|
||||||
|
this._terminal.cols,
|
||||||
|
this._terminal.rows,
|
||||||
|
false
|
||||||
|
).map((coordinate: number) => {
|
||||||
|
return coordinate - 1;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Writes the escape sequences of arrows to the terminal
|
||||||
|
*/
|
||||||
|
public move(): void {
|
||||||
|
if (this._mouseEvent.altKey) {
|
||||||
|
this._terminal.send(this._arrowSequences());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Concatenates all the arrow sequences together.
|
||||||
|
* Resets the starting row to an unwrapped row, moves to the requested row,
|
||||||
|
* then moves to requested col.
|
||||||
|
*/
|
||||||
|
private _arrowSequences(): string {
|
||||||
|
return this._resetStartingRow() +
|
||||||
|
this._moveToRequestedRow() +
|
||||||
|
this._moveToRequestedCol();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If the initial position of the cursor is on a row that is wrapped, move the
|
||||||
|
* cursor up to the first row that is not wrapped to have accurate vertical
|
||||||
|
* positioning.
|
||||||
|
*/
|
||||||
|
private _resetStartingRow(): string {
|
||||||
|
let startRow = this._endRow - this._wrappedRowsForRow(this._endRow);
|
||||||
|
let endRow = this._endRow;
|
||||||
|
|
||||||
|
if (this._moveToRequestedRow().length === 0) {
|
||||||
|
return '';
|
||||||
|
} else {
|
||||||
|
return repeat(this._bufferLine(
|
||||||
|
this._startCol, this._startRow, this._startCol,
|
||||||
|
this._startRow - this._wrappedRowsForRow(this._startRow), false
|
||||||
|
).length, this._sequence(Direction.Left));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Using the reset starting and ending row, move to the requested row,
|
||||||
|
* ignoring wrapped rows
|
||||||
|
*/
|
||||||
|
private _moveToRequestedRow(): string {
|
||||||
|
let startRow = this._startRow - this._wrappedRowsForRow(this._startRow);
|
||||||
|
let endRow = this._endRow - this._wrappedRowsForRow(this._endRow);
|
||||||
|
|
||||||
|
let rowsToMove = Math.abs(startRow - endRow) - this._wrappedRowsCount();
|
||||||
|
|
||||||
|
return repeat(rowsToMove, this._sequence(this._verticalDirection()));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Move to the requested col on the ending row
|
||||||
|
*/
|
||||||
|
private _moveToRequestedCol(): string {
|
||||||
|
let startRow;
|
||||||
|
if (this._moveToRequestedRow().length > 0) {
|
||||||
|
startRow = this._endRow - this._wrappedRowsForRow(this._endRow);
|
||||||
|
} else {
|
||||||
|
startRow = this._startRow;
|
||||||
|
}
|
||||||
|
|
||||||
|
let endRow = this._endRow;
|
||||||
|
let direction = this._horizontalDirection();
|
||||||
|
|
||||||
|
return repeat(this._bufferLine(
|
||||||
|
this._startCol, startRow, this._endCol, endRow,
|
||||||
|
direction === Direction.Right
|
||||||
|
).length, this._sequence(direction));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Utility functions
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Calculates the number of wrapped rows between the unwrapped starting and
|
||||||
|
* ending rows. These rows need to ignored since the cursor skips over them.
|
||||||
|
*/
|
||||||
|
private _wrappedRowsCount(): number {
|
||||||
|
let wrappedRows = 0;
|
||||||
|
let startRow = this._startRow - this._wrappedRowsForRow(this._startRow);
|
||||||
|
let endRow = this._endRow - this._wrappedRowsForRow(this._endRow);
|
||||||
|
|
||||||
|
for (let i = 0; i < Math.abs(startRow - endRow); i++) {
|
||||||
|
let direction = this._verticalDirection() === Direction.Up ? -1 : 1;
|
||||||
|
|
||||||
|
if ((<any>this._lines.get(startRow + (direction * i))).isWrapped) {
|
||||||
|
wrappedRows++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return wrappedRows;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Calculates the number of wrapped rows that make up a given row.
|
||||||
|
* @param currentRow The row to determine how many wrapped rows make it up
|
||||||
|
*/
|
||||||
|
private _wrappedRowsForRow(currentRow: number): number {
|
||||||
|
let rowCount = 0;
|
||||||
|
let lineWraps = (<any>this._lines.get(currentRow)).isWrapped;
|
||||||
|
|
||||||
|
while (lineWraps && currentRow >= 0 && currentRow < this._terminal.rows) {
|
||||||
|
rowCount++;
|
||||||
|
currentRow--;
|
||||||
|
lineWraps = (<any>this._lines.get(currentRow)).isWrapped;
|
||||||
|
}
|
||||||
|
|
||||||
|
return rowCount;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Direction determiners
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Determines if the right or left arrow is needed
|
||||||
|
*/
|
||||||
|
private _horizontalDirection(): Direction {
|
||||||
|
let startRow;
|
||||||
|
if (this._moveToRequestedRow().length > 0) {
|
||||||
|
startRow = this._endRow - this._wrappedRowsForRow(this._endRow);
|
||||||
|
} else {
|
||||||
|
startRow = this._startRow;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ((this._startCol < this._endCol &&
|
||||||
|
startRow <= this._endRow) || // down/right or same y/right
|
||||||
|
(this._startCol >= this._endCol &&
|
||||||
|
startRow < this._endRow)) { // down/left or same y/left
|
||||||
|
return Direction.Right;
|
||||||
|
} else {
|
||||||
|
return Direction.Left;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Determines if the up or down arrow is needed
|
||||||
|
*/
|
||||||
|
private _verticalDirection(): Direction {
|
||||||
|
if (this._startRow > this._endRow) {
|
||||||
|
return Direction.Up;
|
||||||
|
} else {
|
||||||
|
return Direction.Down;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructs the string of chars in the buffer from a starting row and col
|
||||||
|
* to an ending row and col
|
||||||
|
* @param startCol The starting column position
|
||||||
|
* @param startRow The starting row position
|
||||||
|
* @param endCol The ending column position
|
||||||
|
* @param endRow The ending row position
|
||||||
|
* @param forward Direction to move
|
||||||
|
*/
|
||||||
|
private _bufferLine(
|
||||||
|
startCol: number,
|
||||||
|
startRow: number,
|
||||||
|
endCol: number,
|
||||||
|
endRow: number,
|
||||||
|
forward: boolean
|
||||||
|
): string {
|
||||||
|
let currentCol = startCol;
|
||||||
|
let currentRow = startRow;
|
||||||
|
let bufferStr = '';
|
||||||
|
|
||||||
|
while (currentCol !== endCol || currentRow !== endRow) {
|
||||||
|
currentCol += forward ? 1 : -1;
|
||||||
|
|
||||||
|
if (forward && currentCol > this._terminal.cols - 1) {
|
||||||
|
bufferStr += this._terminal.buffer.translateBufferLineToString(
|
||||||
|
currentRow, false, startCol, currentCol
|
||||||
|
);
|
||||||
|
currentCol = 0;
|
||||||
|
startCol = 0;
|
||||||
|
currentRow++;
|
||||||
|
} else if (!forward && currentCol < 0) {
|
||||||
|
bufferStr += this._terminal.buffer.translateBufferLineToString(
|
||||||
|
currentRow, false, 0, startCol + 1
|
||||||
|
);
|
||||||
|
currentCol = this._terminal.cols - 1;
|
||||||
|
startCol = currentCol;
|
||||||
|
currentRow--;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return bufferStr + this._terminal.buffer.translateBufferLineToString(
|
||||||
|
currentRow, false, startCol, currentCol
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructs the escape sequence for clicking an arrow
|
||||||
|
* @param direction The direction to move
|
||||||
|
*/
|
||||||
|
private _sequence(direction: Direction): string {
|
||||||
|
const mod = this._terminal.applicationCursor ? 'O' : '[';
|
||||||
|
return C0.ESC + mod + direction;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a string repeated a given number of times
|
||||||
|
* Polyfill from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/repeat
|
||||||
|
* @param count The number of times to repeat the string
|
||||||
|
* @param string The string that is to be repeated
|
||||||
|
*/
|
||||||
|
function repeat(count: number, str: string): string {
|
||||||
|
count = Math.floor(count);
|
||||||
|
let rpt = '';
|
||||||
|
for (let i = 0; i < count; i++) {
|
||||||
|
rpt += str;
|
||||||
|
}
|
||||||
|
return rpt;
|
||||||
|
}
|
||||||
@@ -70,6 +70,9 @@ export class MockTerminal implements ITerminal {
|
|||||||
write(data: string): void {
|
write(data: string): void {
|
||||||
throw new Error('Method not implemented.');
|
throw new Error('Method not implemented.');
|
||||||
}
|
}
|
||||||
|
send(data: string): void {
|
||||||
|
throw new Error('Method not implemented.');
|
||||||
|
}
|
||||||
bracketedPasteMode: boolean;
|
bracketedPasteMode: boolean;
|
||||||
mouseHelper: IMouseHelper;
|
mouseHelper: IMouseHelper;
|
||||||
renderer: IRenderer;
|
renderer: IRenderer;
|
||||||
@@ -93,6 +96,7 @@ export class MockTerminal implements ITerminal {
|
|||||||
scrollback: number;
|
scrollback: number;
|
||||||
buffers: IBufferSet;
|
buffers: IBufferSet;
|
||||||
buffer: IBuffer;
|
buffer: IBuffer;
|
||||||
|
applicationCursor: boolean;
|
||||||
handler(data: string): void {
|
handler(data: string): void {
|
||||||
throw new Error('Method not implemented.');
|
throw new Error('Method not implemented.');
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user