Add ignoreBracketedPasteMode option

Fixes #4588
This commit is contained in:
Daniel Imms
2023-08-01 13:58:52 -07:00
parent c3def09c38
commit 44ced27bee
6 changed files with 20 additions and 8 deletions
+5 -5
View File
@@ -4,7 +4,7 @@
*/ */
import { ISelectionService } from 'browser/services/Services'; import { ISelectionService } from 'browser/services/Services';
import { ICoreService } from 'common/services/Services'; import { ICoreService, IOptionsService } from 'common/services/Services';
/** /**
* Prepares text to be pasted into the terminal by normalizing the line endings * Prepares text to be pasted into the terminal by normalizing the line endings
@@ -40,17 +40,17 @@ export function copyHandler(ev: ClipboardEvent, selectionService: ISelectionServ
/** /**
* Redirect the clipboard's data to the terminal's input handler. * Redirect the clipboard's data to the terminal's input handler.
*/ */
export function handlePasteEvent(ev: ClipboardEvent, textarea: HTMLTextAreaElement, coreService: ICoreService): void { export function handlePasteEvent(ev: ClipboardEvent, textarea: HTMLTextAreaElement, coreService: ICoreService, optionsService: IOptionsService): void {
ev.stopPropagation(); ev.stopPropagation();
if (ev.clipboardData) { if (ev.clipboardData) {
const text = ev.clipboardData.getData('text/plain'); const text = ev.clipboardData.getData('text/plain');
paste(text, textarea, coreService); paste(text, textarea, coreService, optionsService);
} }
} }
export function paste(text: string, textarea: HTMLTextAreaElement, coreService: ICoreService): void { export function paste(text: string, textarea: HTMLTextAreaElement, coreService: ICoreService, optionsService: IOptionsService): void {
text = prepareTextForTerminal(text); text = prepareTextForTerminal(text);
text = bracketTextForPaste(text, coreService.decPrivateModes.bracketedPasteMode); text = bracketTextForPaste(text, coreService.decPrivateModes.bracketedPasteMode && optionsService.rawOptions.ignoreBracketedPasteMode !== true);
coreService.triggerDataEvent(text, true); coreService.triggerDataEvent(text, true);
textarea.value = ''; textarea.value = '';
} }
+2 -2
View File
@@ -352,7 +352,7 @@ export class Terminal extends CoreTerminal implements ITerminal {
} }
copyHandler(event, this._selectionService!); copyHandler(event, this._selectionService!);
})); }));
const pasteHandlerWrapper = (event: ClipboardEvent): void => handlePasteEvent(event, this.textarea!, this.coreService); const pasteHandlerWrapper = (event: ClipboardEvent): void => handlePasteEvent(event, this.textarea!, this.coreService, this.optionsService);
this.register(addDisposableDomListener(this.textarea!, 'paste', pasteHandlerWrapper)); this.register(addDisposableDomListener(this.textarea!, 'paste', pasteHandlerWrapper));
this.register(addDisposableDomListener(this.element!, 'paste', pasteHandlerWrapper)); this.register(addDisposableDomListener(this.element!, 'paste', pasteHandlerWrapper));
@@ -878,7 +878,7 @@ export class Terminal extends CoreTerminal implements ITerminal {
} }
public paste(data: string): void { public paste(data: string): void {
paste(data, this.textarea!, this.coreService); paste(data, this.textarea!, this.coreService, this.optionsService);
} }
/** /**
+1
View File
@@ -23,6 +23,7 @@ export const DEFAULT_OPTIONS: Readonly<Required<ITerminalOptions>> = {
fontSize: 15, fontSize: 15,
fontWeight: 'normal', fontWeight: 'normal',
fontWeightBold: 'bold', fontWeightBold: 'bold',
ignoreBracketedPasteMode: false,
lineHeight: 1.0, lineHeight: 1.0,
letterSpacing: 0, letterSpacing: 0,
linkHandler: null, linkHandler: null,
+1
View File
@@ -221,6 +221,7 @@ export interface ITerminalOptions {
fontFamily?: string; fontFamily?: string;
fontWeight?: FontWeight; fontWeight?: FontWeight;
fontWeightBold?: FontWeight; fontWeightBold?: FontWeight;
ignoreBracketedPasteMode?: boolean;
letterSpacing?: number; letterSpacing?: number;
lineHeight?: number; lineHeight?: number;
linkHandler?: ILinkHandler | null; linkHandler?: ILinkHandler | null;
+4 -1
View File
@@ -132,9 +132,12 @@ describe('API Integration Tests', function(): void {
window.term.paste('\\r\\nfoo\\nbar\\r'); window.term.paste('\\r\\nfoo\\nbar\\r');
window.term.write('\\x1b[?2004h', () => { window.term.write('\\x1b[?2004h', () => {
window.term.paste('foo'); window.term.paste('foo');
window.term.options.ignoreBracketedPasteMode = true;
window.term.paste('check_mode');
}); });
`); `);
await pollFor(page, `window.calls`, ['foo', '\rfoo\rbar\r', '\x1b[200~foo\x1b[201~']); await pollFor(page, `window.calls`, ['foo', '\rfoo\rbar\r', '\x1b[200~foo\x1b[201~', 'check_mode']);
}); });
it('clear', async () => { it('clear', async () => {
+7
View File
@@ -117,6 +117,13 @@ declare module 'xterm' {
*/ */
fontWeightBold?: FontWeight; fontWeightBold?: FontWeight;
/**
* Whether to ignore the bracketed paste mode. When true, this will always
* paste without the `\x1b[200~` and `\x1b[201~` sequences, even when the
* shell enables bracketed mode.
*/
ignoreBracketedPasteMode?: boolean;
/** /**
* The spacing in whole pixels between characters. * The spacing in whole pixels between characters.
*/ */