Options
-
These options can be set in the Terminal constructor or by using the Terminal.setOption function.
+
These options can be set in the Terminal constructor or by using the Terminal.options property.
diff --git a/test/api/InputHandler.api.ts b/test/api/InputHandler.api.ts
index 4d3a15dd..6e0bf88b 100644
--- a/test/api/InputHandler.api.ts
+++ b/test/api/InputHandler.api.ts
@@ -362,7 +362,7 @@ describe('InputHandler Integration Tests', function(): void {
await pollFor(page, async () => await page.evaluate(`(() => _stack)()`), []);
});
it('14 - GetWinSizePixels', async function(): Promise
{
- await page.evaluate(`window.term.setOption('windowOptions', { getWinSizePixels: true }); `);
+ await page.evaluate(`window.term.options.windowOptions = { getWinSizePixels: true }; `);
await page.evaluate(`(() => {
window._stack = [];
const _h = window.term.onData(data => window._stack.push(data));
@@ -373,7 +373,7 @@ describe('InputHandler Integration Tests', function(): void {
await pollFor(page, async () => await page.evaluate(`(() => _stack)()`), [`\x1b[4;${d.height};${d.width}t`]);
});
it('16 - GetCellSizePixels', async function(): Promise {
- await page.evaluate(`window.term.setOption('windowOptions', { getCellSizePixels: true }); `);
+ await page.evaluate(`window.term.options.windowOptions = { getCellSizePixels: true }; `);
await page.evaluate(`(() => {
window._stack = [];
const _h = window.term.onData(data => window._stack.push(data));
diff --git a/test/api/MouseTracking.api.ts b/test/api/MouseTracking.api.ts
index ebeb680f..16a9b32c 100644
--- a/test/api/MouseTracking.api.ts
+++ b/test/api/MouseTracking.api.ts
@@ -229,7 +229,7 @@ describe('Mouse Tracking Tests', async () => {
window.calls = [];
window.term.onData(e => calls.push( Array.from(e).map(el => el.charCodeAt(0)) ));
window.term.onBinary(e => calls.push( Array.from(e).map(el => el.charCodeAt(0)) ));
- window.term.setOption('fontSize', ${fontSize});
+ window.term.options.fontSize = ${fontSize};
window.term.resize(${cols}, ${rows});
`);
});
diff --git a/test/api/Terminal.api.ts b/test/api/Terminal.api.ts
index ee6a0cfa..cc3b78be 100644
--- a/test/api/Terminal.api.ts
+++ b/test/api/Terminal.api.ts
@@ -154,13 +154,6 @@ describe('API Integration Tests', function(): void {
}
});
- it('getOption, setOption', async () => {
- await openTerminal(page);
- assert.equal(await page.evaluate(`window.term.getOption('rendererType')`), 'canvas');
- await page.evaluate(`window.term.setOption('rendererType', 'dom')`);
- assert.equal(await page.evaluate(`window.term.getOption('rendererType')`), 'dom');
- });
-
describe('options', () => {
it('getter', async () => {
await openTerminal(page);
From 78c2f06107030f6abfe165b385318c46c5784df5 Mon Sep 17 00:00:00 2001
From: Simon Lamon
Date: Wed, 2 Mar 2022 13:19:53 +0000
Subject: [PATCH 2/5] Fix triple select edge case
---
src/browser/services/SelectionService.test.ts | 6 ++++++
src/browser/services/SelectionService.ts | 10 +++++++---
2 files changed, 13 insertions(+), 3 deletions(-)
diff --git a/src/browser/services/SelectionService.test.ts b/src/browser/services/SelectionService.test.ts
index 514d5803..d829e394 100644
--- a/src/browser/services/SelectionService.test.ts
+++ b/src/browser/services/SelectionService.test.ts
@@ -340,6 +340,9 @@ describe('SelectionService', () => {
buffer.lines.set(0, stringToRow('foo bar'));
selectionService.selectLineAt(0);
assert.equal(selectionService.selectionText, 'foo bar', 'The selected text is correct');
+ assert.deepEqual(selectionService.model.selectionStart, [0, 0]);
+ assert.deepEqual(selectionService.model.selectionEnd, undefined);
+ assert.deepEqual(selectionService.model.selectionStartLength, 20);
assert.deepEqual(selectionService.model.finalSelectionStart, [0, 0]);
assert.deepEqual(selectionService.model.finalSelectionEnd, [bufferService.cols, 0], 'The actual selection spans the entire column');
});
@@ -350,6 +353,9 @@ describe('SelectionService', () => {
buffer.lines.set(1, line2);
selectionService.selectLineAt(0);
assert.equal(selectionService.selectionText, 'foobar', 'The selected text is correct');
+ assert.deepEqual(selectionService.model.selectionStart, [0, 0]);
+ assert.deepEqual(selectionService.model.selectionEnd, undefined);
+ assert.deepEqual(selectionService.model.selectionStartLength, 40);
assert.deepEqual(selectionService.model.finalSelectionStart, [0, 0]);
assert.deepEqual(selectionService.model.finalSelectionEnd, [bufferService.cols, 1], 'The actual selection spans the entire column');
});
diff --git a/src/browser/services/SelectionService.ts b/src/browser/services/SelectionService.ts
index 1ea2395d..53020b53 100644
--- a/src/browser/services/SelectionService.ts
+++ b/src/browser/services/SelectionService.ts
@@ -11,7 +11,7 @@ import { SelectionModel } from 'browser/selection/SelectionModel';
import { CellData } from 'common/buffer/CellData';
import { EventEmitter, IEvent } from 'common/EventEmitter';
import { IMouseService, ISelectionService, IRenderService } from 'browser/services/Services';
-import { ILinkifier2 } from 'browser/Types';
+import { IBufferRange, ILinkifier2 } from 'browser/Types';
import { IBufferService, IOptionsService, ICoreService } from 'common/services/Services';
import { getCoordsRelativeToElement } from 'browser/input/Mouse';
import { moveToCellSequence } from 'browser/input/MoveToCell';
@@ -1002,8 +1002,12 @@ export class SelectionService extends Disposable implements ISelectionService {
*/
protected _selectLineAt(line: number): void {
const wrappedRange = this._bufferService.buffer.getWrappedRangeForLine(line);
+ const range: IBufferRange = {
+ start: { x: 0, y: wrappedRange.first },
+ end: { x: this._bufferService.cols - 1, y: wrappedRange.last }
+ };
this._model.selectionStart = [0, wrappedRange.first];
- this._model.selectionEnd = [this._bufferService.cols, wrappedRange.last];
- this._model.selectionStartLength = 0;
+ this._model.selectionEnd = undefined;
+ this._model.selectionStartLength = getRangeLength(range, this._bufferService.cols);
}
}
From c10a451381ca0ae2fe8695a12f2c7de293d9d76f Mon Sep 17 00:00:00 2001
From: Daniel Imms <2193314+Tyriar@users.noreply.github.com>
Date: Wed, 2 Mar 2022 06:59:57 -0800
Subject: [PATCH 3/5] Bring back getOption/setOption api test
---
test/api/Terminal.api.ts | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/test/api/Terminal.api.ts b/test/api/Terminal.api.ts
index cc3b78be..ee6a0cfa 100644
--- a/test/api/Terminal.api.ts
+++ b/test/api/Terminal.api.ts
@@ -154,6 +154,13 @@ describe('API Integration Tests', function(): void {
}
});
+ it('getOption, setOption', async () => {
+ await openTerminal(page);
+ assert.equal(await page.evaluate(`window.term.getOption('rendererType')`), 'canvas');
+ await page.evaluate(`window.term.setOption('rendererType', 'dom')`);
+ assert.equal(await page.evaluate(`window.term.getOption('rendererType')`), 'dom');
+ });
+
describe('options', () => {
it('getter', async () => {
await openTerminal(page);
From 4799832a33521e2378ba4a56268679626e5e95fc Mon Sep 17 00:00:00 2001
From: Simon Lamon
Date: Wed, 2 Mar 2022 16:17:31 +0000
Subject: [PATCH 4/5] Keep the initial wrapped line upon dragging
---
src/browser/selection/SelectionModel.test.ts | 6 ++++++
src/browser/selection/SelectionModel.ts | 7 ++++++-
2 files changed, 12 insertions(+), 1 deletion(-)
diff --git a/src/browser/selection/SelectionModel.test.ts b/src/browser/selection/SelectionModel.test.ts
index 410902d7..5ce3e316 100644
--- a/src/browser/selection/SelectionModel.test.ts
+++ b/src/browser/selection/SelectionModel.test.ts
@@ -116,6 +116,12 @@ describe('SelectionModel', () => {
model.selectionStartLength = 4;
assert.deepEqual(model.finalSelectionEnd, [2, 3]);
});
+ it('should return the end on a different row when start + length overflows onto a following row with selectionEnd inbetween', () => {
+ model.selectionStart = [78, 2];
+ model.selectionEnd = [79, 2];
+ model.selectionStartLength = 4;
+ assert.deepEqual(model.finalSelectionEnd, [2, 3]);
+ });
it('should return selection end if selection end is after selection start + length', () => {
model.selectionStart = [2, 2];
model.selectionStartLength = 2;
diff --git a/src/browser/selection/SelectionModel.ts b/src/browser/selection/SelectionModel.ts
index 1d84446a..6c8abbfd 100644
--- a/src/browser/selection/SelectionModel.ts
+++ b/src/browser/selection/SelectionModel.ts
@@ -92,7 +92,12 @@ export class SelectionModel {
if (this.selectionStartLength) {
// Select the larger of the two when start and end are on the same line
if (this.selectionEnd[1] === this.selectionStart[1]) {
- return [Math.max(this.selectionStart[0] + this.selectionStartLength, this.selectionEnd[0]), this.selectionEnd[1]];
+ // Keep the whole wrapped word/line selected if the content wraps multiple lines
+ const startPlusLength = this.selectionStart[0] + this.selectionStartLength;
+ if (startPlusLength > this._bufferService.cols) {
+ return [startPlusLength % this._bufferService.cols, this.selectionStart[1] + Math.floor(startPlusLength / this._bufferService.cols)];
+ }
+ return [Math.max(startPlusLength, this.selectionEnd[0]), this.selectionEnd[1]];
}
}
return this.selectionEnd;
From 842f4c20888b308d18aa976b34904567d953ad36 Mon Sep 17 00:00:00 2001
From: Megan Rogge
Date: Wed, 30 Mar 2022 20:08:55 -0400
Subject: [PATCH 5/5] Add search result count to SearchAddon (#3716)
---
addons/xterm-addon-search/src/SearchAddon.ts | 98 ++++++++++++++-----
addons/xterm-addon-search/src/tsconfig.json | 12 ++-
.../typings/xterm-addon-search.d.ts | 9 +-
addons/xterm-addon-search/webpack.config.js | 7 ++
4 files changed, 97 insertions(+), 29 deletions(-)
diff --git a/addons/xterm-addon-search/src/SearchAddon.ts b/addons/xterm-addon-search/src/SearchAddon.ts
index c261ca6a..d2ee05b4 100644
--- a/addons/xterm-addon-search/src/SearchAddon.ts
+++ b/addons/xterm-addon-search/src/SearchAddon.ts
@@ -4,6 +4,7 @@
*/
import { Terminal, IDisposable, ITerminalAddon, ISelectionPosition, IDecoration } from 'xterm';
+import { EventEmitter } from 'common/EventEmitter';
export interface ISearchOptions {
regex?: boolean;
@@ -53,8 +54,8 @@ export class SearchAddon implements ITerminalAddon {
private _dataChanged: boolean = false;
private _cachedSearchTerm: string | undefined;
private _selectedDecoration: IDecoration | undefined;
- private _resultDecorations: Map = new Map();
- private _searchResults: Map = new Map();
+ private _resultDecorations: Map | undefined;
+ private _searchResults: Map | undefined;
private _onDataDisposable: IDisposable | undefined;
private _lastSearchOptions: ISearchOptions | undefined;
private _highlightTimeout: number | undefined;
@@ -68,6 +69,11 @@ export class SearchAddon implements ITerminalAddon {
private _cursorMoveListener: IDisposable | undefined;
private _resizeListener: IDisposable | undefined;
+ private _resultIndex: number | undefined;
+
+ private readonly _onDidChangeResults = new EventEmitter<{resultIndex: number, resultCount: number} | undefined>();
+ public readonly onDidChangeResults = this._onDidChangeResults.event;
+
public activate(terminal: Terminal): void {
this._terminal = terminal;
this._onDataDisposable = this._terminal.onData(() => {
@@ -75,11 +81,11 @@ export class SearchAddon implements ITerminalAddon {
if (this._highlightTimeout) {
window.clearTimeout(this._highlightTimeout);
}
- this._highlightTimeout = setTimeout(() => {
- if (this._lastSearchOptions?.decorations && this._cachedSearchTerm && this._resultDecorations.size > 0 && this._lastSearchOptions) {
- this._highlightAllMatches(this._cachedSearchTerm, this._lastSearchOptions);
- }
- }, 200);
+ if (this._cachedSearchTerm && this._lastSearchOptions?.decorations) {
+ this._highlightTimeout = setTimeout(() => {
+ this.findPrevious(this._cachedSearchTerm!, { ...this._lastSearchOptions, incremental: true });
+ }, 200);
+ }
});
}
@@ -90,20 +96,18 @@ export class SearchAddon implements ITerminalAddon {
public clearDecorations(): void {
this._selectedDecoration?.dispose();
- this._terminal?.clearSelection();
- this._searchResults.clear();
- this._disposeDecorations();
- this._cachedSearchTerm = undefined;
- this._dataChanged = true;
- }
-
- private _disposeDecorations(): void {
- this._resultDecorations.forEach(decorations => {
+ this._searchResults?.clear();
+ this._resultDecorations?.forEach(decorations => {
for (const d of decorations) {
d.dispose();
}
});
- this._resultDecorations.clear();
+ this._resultDecorations?.clear();
+ this._cachedSearchTerm = undefined;
+ this._searchResults = undefined;
+ this._resultDecorations = undefined;
+ this._dataChanged = true;
+ this._resultIndex = undefined;
}
/**
@@ -118,11 +122,18 @@ export class SearchAddon implements ITerminalAddon {
throw new Error('Cannot use addon until it has been loaded');
}
this._lastSearchOptions = searchOptions;
- const findNextResult = this._findNextAndSelect(term, searchOptions);
if (searchOptions?.decorations) {
this._highlightAllMatches(term, searchOptions);
}
- return findNextResult;
+ const next = this._findNextAndSelect(term, searchOptions);
+ if (searchOptions?.decorations) {
+ if (next && this._resultIndex !== undefined && this._searchResults?.size) {
+ this._onDidChangeResults.fire({ resultIndex: this._resultIndex, resultCount: this._searchResults.size });
+ } else {
+ this._onDidChangeResults.fire(undefined);
+ }
+ }
+ return next;
}
private _highlightAllMatches(term: string, searchOptions: ISearchOptions): void {
@@ -137,9 +148,12 @@ export class SearchAddon implements ITerminalAddon {
if (term === this._cachedSearchTerm && !this._dataChanged) {
return;
}
+
// new search, clear out the old decorations
- this._disposeDecorations();
- this._searchResults.clear();
+ this.clearDecorations();
+ this._searchResults = new Map();
+ this._resultDecorations = new Map();
+ const resultDecorations = this._resultDecorations;
let result = this._find(term, 0, 0, searchOptions);
while (result && !this._searchResults.get(`${result.row}-${result.col}`)) {
this._searchResults.set(`${result.row}-${result.col}`, result);
@@ -153,9 +167,9 @@ export class SearchAddon implements ITerminalAddon {
this._searchResults.forEach(result => {
const resultDecoration = this._createResultDecoration(result, searchOptions.decorations!);
if (resultDecoration) {
- const decorationsForLine = this._resultDecorations.get(resultDecoration.marker.line) || [];
+ const decorationsForLine = resultDecorations.get(resultDecoration.marker.line) || [];
decorationsForLine.push(resultDecoration);
- this._resultDecorations.set(resultDecoration.marker.line, decorationsForLine);
+ resultDecorations.set(resultDecoration.marker.line, decorationsForLine);
}
});
if (this._dataChanged) {
@@ -211,6 +225,7 @@ export class SearchAddon implements ITerminalAddon {
return false;
}
+
let startCol = 0;
let startRow = 0;
let currentSelection: ISelectionPosition | undefined;
@@ -265,6 +280,17 @@ export class SearchAddon implements ITerminalAddon {
result = this._findInLine(term, searchPosition, searchOptions);
}
+ if (this._searchResults) {
+ if (this._resultIndex === undefined) {
+ this._resultIndex = 0;
+ } else {
+ this._resultIndex++;
+ if (this._resultIndex >= this._searchResults.size) {
+ this._resultIndex = 0;
+ }
+ }
+ }
+
// Set selection and scroll if a result was found
return this._selectResult(result, searchOptions?.decorations);
}
@@ -280,14 +306,21 @@ export class SearchAddon implements ITerminalAddon {
throw new Error('Cannot use addon until it has been loaded');
}
this._lastSearchOptions = searchOptions;
- const findPreviousResult = this._findAndSelectPrevious(term, searchOptions);
if (searchOptions?.decorations) {
this._highlightAllMatches(term, searchOptions);
}
- return findPreviousResult;
+ const previous = this._findPreviousAndSelect(term, searchOptions);
+ if (searchOptions?.decorations) {
+ if (previous && this._resultIndex !== undefined && this._searchResults?.size) {
+ this._onDidChangeResults.fire({ resultIndex: this._resultIndex, resultCount: this._searchResults.size });
+ } else {
+ this._onDidChangeResults.fire(undefined);
+ }
+ }
+ return previous;
}
- private _findAndSelectPrevious(term: string, searchOptions?: ISearchOptions): boolean {
+ private _findPreviousAndSelect(term: string, searchOptions?: ISearchOptions): boolean {
if (!this._terminal) {
throw new Error('Cannot use addon until it has been loaded');
}
@@ -356,6 +389,17 @@ export class SearchAddon implements ITerminalAddon {
}
}
+ if (this._searchResults) {
+ if (this._resultIndex === undefined) {
+ this._resultIndex = this._searchResults?.size - 1;
+ } else {
+ this._resultIndex--;
+ if (this._resultIndex === -1) {
+ this._resultIndex = this._searchResults?.size - 1;
+ }
+ }
+ }
+
// If there is only one result, return true.
if (!result && currentSelection) return true;
@@ -669,7 +713,7 @@ export class SearchAddon implements ITerminalAddon {
marker,
x: result.col,
width: result.size,
- overviewRulerOptions: this._resultDecorations.get(marker.line) && !this._dataChanged ? undefined : {
+ overviewRulerOptions: this._resultDecorations?.get(marker.line) && !this._dataChanged ? undefined : {
color: decorations.matchOverviewRuler, position: 'center'
}
});
diff --git a/addons/xterm-addon-search/src/tsconfig.json b/addons/xterm-addon-search/src/tsconfig.json
index d264abe0..5a5e671f 100644
--- a/addons/xterm-addon-search/src/tsconfig.json
+++ b/addons/xterm-addon-search/src/tsconfig.json
@@ -13,10 +13,20 @@
"strict": true,
"types": [
"../../../node_modules/@types/mocha"
- ]
+ ],
+ "paths": {
+ "common/*": [
+ "../../../src/common/*"
+ ]
+ }
},
"include": [
"./**/*",
"../../../typings/xterm.d.ts"
+ ],
+ "references": [
+ {
+ "path": "../../../src/common"
+ }
]
}
diff --git a/addons/xterm-addon-search/typings/xterm-addon-search.d.ts b/addons/xterm-addon-search/typings/xterm-addon-search.d.ts
index aedb6af9..1cb9740e 100644
--- a/addons/xterm-addon-search/typings/xterm-addon-search.d.ts
+++ b/addons/xterm-addon-search/typings/xterm-addon-search.d.ts
@@ -3,7 +3,7 @@
* @license MIT
*/
-import { Terminal, ILinkMatcherOptions, IDisposable, ITerminalAddon } from 'xterm';
+import { Terminal, ITerminalAddon, IEvent } from 'xterm';
declare module 'xterm-addon-search' {
/**
@@ -110,5 +110,12 @@ declare module 'xterm-addon-search' {
* Clears the decorations and selection
*/
public clearDecorations(): void;
+
+ /**
+ * When decorations are enabled, fires when
+ * the search results or the selected result changes,
+ * returning undefined if there are no matches.
+ */
+ readonly onDidChangeResults: IEvent<{ resultIndex: number, resultCount: number } | undefined>;
}
}
diff --git a/addons/xterm-addon-search/webpack.config.js b/addons/xterm-addon-search/webpack.config.js
index 726dceb6..30526812 100644
--- a/addons/xterm-addon-search/webpack.config.js
+++ b/addons/xterm-addon-search/webpack.config.js
@@ -21,6 +21,13 @@ module.exports = {
}
]
},
+ resolve: {
+ modules: ['./node_modules'],
+ extensions: [ '.js' ],
+ alias: {
+ common: path.resolve('../../out/common')
+ }
+ },
output: {
filename: mainFile,
path: path.resolve('./lib'),