/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ import * as browser from '../../../base/browser/browser.js'; import * as dom from '../../../base/browser/dom.js'; import { StandardKeyboardEvent } from '../../../base/browser/keyboardEvent.js'; import { RunOnceScheduler } from '../../../base/common/async.js'; import { Emitter } from '../../../base/common/event.js'; import { Disposable } from '../../../base/common/lifecycle.js'; import { Mimes } from '../../../base/common/mime.js'; import * as strings from '../../../base/common/strings.js'; import { TextAreaState, _debugComposition } from './textAreaState.js'; import { Selection } from '../../common/core/selection.js'; export var TextAreaSyntethicEvents; (function (TextAreaSyntethicEvents) { TextAreaSyntethicEvents.Tap = '-monaco-textarea-synthetic-tap'; })(TextAreaSyntethicEvents || (TextAreaSyntethicEvents = {})); export const CopyOptions = { forceCopyWithSyntaxHighlighting: false }; /** * Every time we write to the clipboard, we record a bit of extra metadata here. * Every time we read from the cipboard, if the text matches our last written text, * we can fetch the previous metadata. */ export class InMemoryClipboardMetadataManager { constructor() { this._lastState = null; } set(lastCopiedValue, data) { this._lastState = { lastCopiedValue, data }; } get(pastedText) { if (this._lastState && this._lastState.lastCopiedValue === pastedText) { // match! return this._lastState.data; } this._lastState = null; return null; } } InMemoryClipboardMetadataManager.INSTANCE = new InMemoryClipboardMetadataManager(); class CompositionContext { constructor() { this._lastTypeTextLength = 0; } handleCompositionUpdate(text) { text = text || ''; const typeInput = { text: text, replacePrevCharCnt: this._lastTypeTextLength, replaceNextCharCnt: 0, positionDelta: 0 }; this._lastTypeTextLength = text.length; return typeInput; } } /** * Writes screen reader content to the textarea and is able to analyze its input events to generate: * - onCut * - onPaste * - onType * * Composition events are generated for presentation purposes (composition input is reflected in onType). */ export class TextAreaInput extends Disposable { constructor(_host, _textArea, _OS, _browser) { super(); this._host = _host; this._textArea = _textArea; this._OS = _OS; this._browser = _browser; this._onFocus = this._register(new Emitter()); this.onFocus = this._onFocus.event; this._onBlur = this._register(new Emitter()); this.onBlur = this._onBlur.event; this._onKeyDown = this._register(new Emitter()); this.onKeyDown = this._onKeyDown.event; this._onKeyUp = this._register(new Emitter()); this.onKeyUp = this._onKeyUp.event; this._onCut = this._register(new Emitter()); this.onCut = this._onCut.event; this._onPaste = this._register(new Emitter()); this.onPaste = this._onPaste.event; this._onType = this._register(new Emitter()); this.onType = this._onType.event; this._onCompositionStart = this._register(new Emitter()); this.onCompositionStart = this._onCompositionStart.event; this._onCompositionUpdate = this._register(new Emitter()); this.onCompositionUpdate = this._onCompositionUpdate.event; this._onCompositionEnd = this._register(new Emitter()); this.onCompositionEnd = this._onCompositionEnd.event; this._onSelectionChangeRequest = this._register(new Emitter()); this.onSelectionChangeRequest = this._onSelectionChangeRequest.event; this._asyncTriggerCut = this._register(new RunOnceScheduler(() => this._onCut.fire(), 0)); this._asyncFocusGainWriteScreenReaderContent = this._register(new RunOnceScheduler(() => this.writeScreenReaderContent('asyncFocusGain'), 0)); this._textAreaState = TextAreaState.EMPTY; this._selectionChangeListener = null; this.writeScreenReaderContent('ctor'); this._hasFocus = false; this._currentComposition = null; this._nextCommand = 0 /* Type */; let lastKeyDown = null; this._register(this._textArea.onKeyDown((_e) => { const e = new StandardKeyboardEvent(_e); if (e.keyCode === 109 /* KEY_IN_COMPOSITION */ || (this._currentComposition && e.keyCode === 1 /* Backspace */)) { // Stop propagation for keyDown events if the IME is processing key input e.stopPropagation(); } if (e.equals(9 /* Escape */)) { // Prevent default always for `Esc`, otherwise it will generate a keypress // See https://msdn.microsoft.com/en-us/library/ie/ms536939(v=vs.85).aspx e.preventDefault(); } lastKeyDown = e; this._onKeyDown.fire(e); })); this._register(this._textArea.onKeyUp((_e) => { const e = new StandardKeyboardEvent(_e); this._onKeyUp.fire(e); })); this._register(this._textArea.onCompositionStart((e) => { if (_debugComposition) { console.log(`[compositionstart]`, e); } const currentComposition = new CompositionContext(); if (this._currentComposition) { // simply reset the composition context this._currentComposition = currentComposition; return; } this._currentComposition = currentComposition; if (this._OS === 2 /* Macintosh */ && this._textAreaState.selectionStart === this._textAreaState.selectionEnd && this._textAreaState.selectionStart > 0 && this._textAreaState.value.substr(this._textAreaState.selectionStart - 1, 1) === e.data) { const isArrowKey = (lastKeyDown && lastKeyDown.equals(109 /* KEY_IN_COMPOSITION */) && (lastKeyDown.code === 'ArrowRight' || lastKeyDown.code === 'ArrowLeft')); if (isArrowKey || this._browser.isFirefox) { // Handling long press case on Chromium/Safari macOS + arrow key => pretend the character was selected // or long press case on Firefox on macOS if (_debugComposition) { console.log(`[compositionstart] Handling long press case on macOS + arrow key or Firefox`, e); } // Pretend the previous character was composed (in order to get it removed by subsequent compositionupdate events) currentComposition.handleCompositionUpdate('x'); this._onCompositionStart.fire({ revealDeltaColumns: -1 }); return; } } if (this._browser.isAndroid) { // when tapping on the editor, Android enters composition mode to edit the current word // so we cannot clear the textarea on Android and we must pretend the current word was selected this._onCompositionStart.fire({ revealDeltaColumns: -this._textAreaState.selectionStart }); return; } this._onCompositionStart.fire({ revealDeltaColumns: 0 }); })); this._register(this._textArea.onCompositionUpdate((e) => { if (_debugComposition) { console.log(`[compositionupdate]`, e); } const currentComposition = this._currentComposition; if (!currentComposition) { // should not be possible to receive a 'compositionupdate' without a 'compositionstart' return; } if (this._browser.isAndroid) { // On Android, the data sent with the composition update event is unusable. // For example, if the cursor is in the middle of a word like Mic|osoft // and Microsoft is chosen from the keyboard's suggestions, the e.data will contain "Microsoft". // This is not really usable because it doesn't tell us where the edit began and where it ended. const newState = TextAreaState.readFromTextArea(this._textArea); const typeInput = TextAreaState.deduceAndroidCompositionInput(this._textAreaState, newState); this._textAreaState = newState; this._onType.fire(typeInput); this._onCompositionUpdate.fire(e); return; } const typeInput = currentComposition.handleCompositionUpdate(e.data); this._textAreaState = TextAreaState.readFromTextArea(this._textArea); this._onType.fire(typeInput); this._onCompositionUpdate.fire(e); })); this._register(this._textArea.onCompositionEnd((e) => { if (_debugComposition) { console.log(`[compositionend]`, e); } const currentComposition = this._currentComposition; if (!currentComposition) { // https://github.com/microsoft/monaco-editor/issues/1663 // On iOS 13.2, Chinese system IME randomly trigger an additional compositionend event with empty data return; } this._currentComposition = null; if (this._browser.isAndroid) { // On Android, the data sent with the composition update event is unusable. // For example, if the cursor is in the middle of a word like Mic|osoft // and Microsoft is chosen from the keyboard's suggestions, the e.data will contain "Microsoft". // This is not really usable because it doesn't tell us where the edit began and where it ended. const newState = TextAreaState.readFromTextArea(this._textArea); const typeInput = TextAreaState.deduceAndroidCompositionInput(this._textAreaState, newState); this._textAreaState = newState; this._onType.fire(typeInput); this._onCompositionEnd.fire(); return; } const typeInput = currentComposition.handleCompositionUpdate(e.data); this._textAreaState = TextAreaState.readFromTextArea(this._textArea); this._onType.fire(typeInput); this._onCompositionEnd.fire(); })); this._register(this._textArea.onInput((e) => { if (_debugComposition) { console.log(`[input]`, e); } // Pretend here we touched the text area, as the `input` event will most likely // result in a `selectionchange` event which we want to ignore this._textArea.setIgnoreSelectionChangeTime('received input event'); if (this._currentComposition) { return; } const newState = TextAreaState.readFromTextArea(this._textArea); const typeInput = TextAreaState.deduceInput(this._textAreaState, newState, /*couldBeEmojiInput*/ this._OS === 2 /* Macintosh */); if (typeInput.replacePrevCharCnt === 0 && typeInput.text.length === 1 && strings.isHighSurrogate(typeInput.text.charCodeAt(0))) { // Ignore invalid input but keep it around for next time return; } this._textAreaState = newState; const typeInputIsNoOp = (typeInput.text === '' && typeInput.replacePrevCharCnt === 0 && typeInput.replaceNextCharCnt === 0 && typeInput.positionDelta === 0); if (this._nextCommand === 0 /* Type */) { if (!typeInputIsNoOp) { this._onType.fire(typeInput); } } else { if (!typeInputIsNoOp) { this._firePaste(typeInput.text, null); } this._nextCommand = 0 /* Type */; } })); // --- Clipboard operations this._register(this._textArea.onCut((e) => { // Pretend here we touched the text area, as the `cut` event will most likely // result in a `selectionchange` event which we want to ignore this._textArea.setIgnoreSelectionChangeTime('received cut event'); this._ensureClipboardGetsEditorSelection(e); this._asyncTriggerCut.schedule(); })); this._register(this._textArea.onCopy((e) => { this._ensureClipboardGetsEditorSelection(e); })); this._register(this._textArea.onPaste((e) => { // Pretend here we touched the text area, as the `paste` event will most likely // result in a `selectionchange` event which we want to ignore this._textArea.setIgnoreSelectionChangeTime('received paste event'); if (ClipboardEventUtils.canUseTextData(e)) { const [pastePlainText, metadata] = ClipboardEventUtils.getTextData(e); if (pastePlainText !== '') { this._firePaste(pastePlainText, metadata); } } else { if (this._textArea.getSelectionStart() !== this._textArea.getSelectionEnd()) { // Clean up the textarea, to get a clean paste this._setAndWriteTextAreaState('paste', TextAreaState.EMPTY); } this._nextCommand = 1 /* Paste */; } })); this._register(this._textArea.onFocus(() => { const hadFocus = this._hasFocus; this._setHasFocus(true); if (this._browser.isSafari && !hadFocus && this._hasFocus) { // When "tabbing into" the textarea, immediately after dispatching the 'focus' event, // Safari will always move the selection at offset 0 in the textarea this._asyncFocusGainWriteScreenReaderContent.schedule(); } })); this._register(this._textArea.onBlur(() => { if (this._currentComposition) { // See https://github.com/microsoft/vscode/issues/112621 // where compositionend is not triggered when the editor // is taken off-dom during a composition // Clear the flag to be able to write to the textarea this._currentComposition = null; // Clear the textarea to avoid an unwanted cursor type this.writeScreenReaderContent('blurWithoutCompositionEnd'); // Fire artificial composition end this._onCompositionEnd.fire(); } this._setHasFocus(false); })); this._register(this._textArea.onSyntheticTap(() => { if (this._browser.isAndroid && this._currentComposition) { // on Android, tapping does not cancel the current composition, so the // textarea is stuck showing the old composition // Clear the flag to be able to write to the textarea this._currentComposition = null; // Clear the textarea to avoid an unwanted cursor type this.writeScreenReaderContent('tapWithoutCompositionEnd'); // Fire artificial composition end this._onCompositionEnd.fire(); } })); } _installSelectionChangeListener() { // See https://github.com/microsoft/vscode/issues/27216 and https://github.com/microsoft/vscode/issues/98256 // When using a Braille display, it is possible for users to reposition the // system caret. This is reflected in Chrome as a `selectionchange` event. // // The `selectionchange` event appears to be emitted under numerous other circumstances, // so it is quite a challenge to distinguish a `selectionchange` coming in from a user // using a Braille display from all the other cases. // // The problems with the `selectionchange` event are: // * the event is emitted when the textarea is focused programmatically -- textarea.focus() // * the event is emitted when the selection is changed in the textarea programmatically -- textarea.setSelectionRange(...) // * the event is emitted when the value of the textarea is changed programmatically -- textarea.value = '...' // * the event is emitted when tabbing into the textarea // * the event is emitted asynchronously (sometimes with a delay as high as a few tens of ms) // * the event sometimes comes in bursts for a single logical textarea operation // `selectionchange` events often come multiple times for a single logical change // so throttle multiple `selectionchange` events that burst in a short period of time. let previousSelectionChangeEventTime = 0; return dom.addDisposableListener(document, 'selectionchange', (e) => { if (!this._hasFocus) { return; } if (this._currentComposition) { return; } if (!this._browser.isChrome) { // Support only for Chrome until testing happens on other browsers return; } const now = Date.now(); const delta1 = now - previousSelectionChangeEventTime; previousSelectionChangeEventTime = now; if (delta1 < 5) { // received another `selectionchange` event within 5ms of the previous `selectionchange` event // => ignore it return; } const delta2 = now - this._textArea.getIgnoreSelectionChangeTime(); this._textArea.resetSelectionChangeTime(); if (delta2 < 100) { // received a `selectionchange` event within 100ms since we touched the textarea // => ignore it, since we caused it return; } if (!this._textAreaState.selectionStartPosition || !this._textAreaState.selectionEndPosition) { // Cannot correlate a position in the textarea with a position in the editor... return; } const newValue = this._textArea.getValue(); if (this._textAreaState.value !== newValue) { // Cannot correlate a position in the textarea with a position in the editor... return; } const newSelectionStart = this._textArea.getSelectionStart(); const newSelectionEnd = this._textArea.getSelectionEnd(); if (this._textAreaState.selectionStart === newSelectionStart && this._textAreaState.selectionEnd === newSelectionEnd) { // Nothing to do... return; } const _newSelectionStartPosition = this._textAreaState.deduceEditorPosition(newSelectionStart); const newSelectionStartPosition = this._host.deduceModelPosition(_newSelectionStartPosition[0], _newSelectionStartPosition[1], _newSelectionStartPosition[2]); const _newSelectionEndPosition = this._textAreaState.deduceEditorPosition(newSelectionEnd); const newSelectionEndPosition = this._host.deduceModelPosition(_newSelectionEndPosition[0], _newSelectionEndPosition[1], _newSelectionEndPosition[2]); const newSelection = new Selection(newSelectionStartPosition.lineNumber, newSelectionStartPosition.column, newSelectionEndPosition.lineNumber, newSelectionEndPosition.column); this._onSelectionChangeRequest.fire(newSelection); }); } dispose() { super.dispose(); if (this._selectionChangeListener) { this._selectionChangeListener.dispose(); this._selectionChangeListener = null; } } focusTextArea() { // Setting this._hasFocus and writing the screen reader content // will result in a focus() and setSelectionRange() in the textarea this._setHasFocus(true); // If the editor is off DOM, focus cannot be really set, so let's double check that we have managed to set the focus this.refreshFocusState(); } isFocused() { return this._hasFocus; } refreshFocusState() { this._setHasFocus(this._textArea.hasFocus()); } _setHasFocus(newHasFocus) { if (this._hasFocus === newHasFocus) { // no change return; } this._hasFocus = newHasFocus; if (this._selectionChangeListener) { this._selectionChangeListener.dispose(); this._selectionChangeListener = null; } if (this._hasFocus) { this._selectionChangeListener = this._installSelectionChangeListener(); } if (this._hasFocus) { this.writeScreenReaderContent('focusgain'); } if (this._hasFocus) { this._onFocus.fire(); } else { this._onBlur.fire(); } } _setAndWriteTextAreaState(reason, textAreaState) { if (!this._hasFocus) { textAreaState = textAreaState.collapseSelection(); } textAreaState.writeToTextArea(reason, this._textArea, this._hasFocus); this._textAreaState = textAreaState; } writeScreenReaderContent(reason) { if (this._currentComposition) { // Do not write to the text area when doing composition return; } this._setAndWriteTextAreaState(reason, this._host.getScreenReaderContent(this._textAreaState)); } _ensureClipboardGetsEditorSelection(e) { const dataToCopy = this._host.getDataToCopy(ClipboardEventUtils.canUseTextData(e)); const storedMetadata = { version: 1, isFromEmptySelection: dataToCopy.isFromEmptySelection, multicursorText: dataToCopy.multicursorText, mode: dataToCopy.mode }; InMemoryClipboardMetadataManager.INSTANCE.set( // When writing "LINE\r\n" to the clipboard and then pasting, // Firefox pastes "LINE\n", so let's work around this quirk (this._browser.isFirefox ? dataToCopy.text.replace(/\r\n/g, '\n') : dataToCopy.text), storedMetadata); if (!ClipboardEventUtils.canUseTextData(e)) { // Looks like an old browser. The strategy is to place the text // we'd like to be copied to the clipboard in the textarea and select it. this._setAndWriteTextAreaState('copy or cut', TextAreaState.selectedText(dataToCopy.text)); return; } ClipboardEventUtils.setTextData(e, dataToCopy.text, dataToCopy.html, storedMetadata); } _firePaste(text, metadata) { if (!metadata) { // try the in-memory store metadata = InMemoryClipboardMetadataManager.INSTANCE.get(text); } this._onPaste.fire({ text: text, metadata: metadata }); } } class ClipboardEventUtils { static canUseTextData(e) { if (e.clipboardData) { return true; } return false; } static getTextData(e) { if (e.clipboardData) { e.preventDefault(); const text = e.clipboardData.getData(Mimes.text); let metadata = null; const rawmetadata = e.clipboardData.getData('vscode-editor-data'); if (typeof rawmetadata === 'string') { try { metadata = JSON.parse(rawmetadata); if (metadata.version !== 1) { metadata = null; } } catch (err) { // no problem! } } return [text, metadata]; } throw new Error('ClipboardEventUtils.getTextData: Cannot use text data!'); } static setTextData(e, text, html, metadata) { if (e.clipboardData) { e.clipboardData.setData(Mimes.text, text); if (typeof html === 'string') { e.clipboardData.setData('text/html', html); } e.clipboardData.setData('vscode-editor-data', JSON.stringify(metadata)); e.preventDefault(); return; } throw new Error('ClipboardEventUtils.setTextData: Cannot use text data!'); } } export class TextAreaWrapper extends Disposable { constructor(_actual) { super(); this._actual = _actual; this.onKeyDown = this._register(dom.createEventEmitter(this._actual, 'keydown')).event; this.onKeyUp = this._register(dom.createEventEmitter(this._actual, 'keyup')).event; this.onCompositionStart = this._register(dom.createEventEmitter(this._actual, 'compositionstart')).event; this.onCompositionUpdate = this._register(dom.createEventEmitter(this._actual, 'compositionupdate')).event; this.onCompositionEnd = this._register(dom.createEventEmitter(this._actual, 'compositionend')).event; this.onInput = this._register(dom.createEventEmitter(this._actual, 'input')).event; this.onCut = this._register(dom.createEventEmitter(this._actual, 'cut')).event; this.onCopy = this._register(dom.createEventEmitter(this._actual, 'copy')).event; this.onPaste = this._register(dom.createEventEmitter(this._actual, 'paste')).event; this.onFocus = this._register(dom.createEventEmitter(this._actual, 'focus')).event; this.onBlur = this._register(dom.createEventEmitter(this._actual, 'blur')).event; this._onSyntheticTap = this._register(new Emitter()); this.onSyntheticTap = this._onSyntheticTap.event; this._ignoreSelectionChangeTime = 0; this._register(dom.addDisposableListener(this._actual, TextAreaSyntethicEvents.Tap, () => this._onSyntheticTap.fire())); } hasFocus() { const shadowRoot = dom.getShadowRoot(this._actual); if (shadowRoot) { return shadowRoot.activeElement === this._actual; } else if (dom.isInDOM(this._actual)) { return document.activeElement === this._actual; } else { return false; } } setIgnoreSelectionChangeTime(reason) { this._ignoreSelectionChangeTime = Date.now(); } getIgnoreSelectionChangeTime() { return this._ignoreSelectionChangeTime; } resetSelectionChangeTime() { this._ignoreSelectionChangeTime = 0; } getValue() { // console.log('current value: ' + this._textArea.value); return this._actual.value; } setValue(reason, value) { const textArea = this._actual; if (textArea.value === value) { // No change return; } // console.log('reason: ' + reason + ', current value: ' + textArea.value + ' => new value: ' + value); this.setIgnoreSelectionChangeTime('setValue'); textArea.value = value; } getSelectionStart() { return this._actual.selectionDirection === 'backward' ? this._actual.selectionEnd : this._actual.selectionStart; } getSelectionEnd() { return this._actual.selectionDirection === 'backward' ? this._actual.selectionStart : this._actual.selectionEnd; } setSelectionRange(reason, selectionStart, selectionEnd) { const textArea = this._actual; let activeElement = null; const shadowRoot = dom.getShadowRoot(textArea); if (shadowRoot) { activeElement = shadowRoot.activeElement; } else { activeElement = document.activeElement; } const currentIsFocused = (activeElement === textArea); const currentSelectionStart = textArea.selectionStart; const currentSelectionEnd = textArea.selectionEnd; if (currentIsFocused && currentSelectionStart === selectionStart && currentSelectionEnd === selectionEnd) { // No change // Firefox iframe bug https://github.com/microsoft/monaco-editor/issues/643#issuecomment-367871377 if (browser.isFirefox && window.parent !== window) { textArea.focus(); } return; } // console.log('reason: ' + reason + ', setSelectionRange: ' + selectionStart + ' -> ' + selectionEnd); if (currentIsFocused) { // No need to focus, only need to change the selection range this.setIgnoreSelectionChangeTime('setSelectionRange'); textArea.setSelectionRange(selectionStart, selectionEnd); if (browser.isFirefox && window.parent !== window) { textArea.focus(); } return; } // If the focus is outside the textarea, browsers will try really hard to reveal the textarea. // Here, we try to undo the browser's desperate reveal. try { const scrollState = dom.saveParentsScrollTop(textArea); this.setIgnoreSelectionChangeTime('setSelectionRange'); textArea.focus(); textArea.setSelectionRange(selectionStart, selectionEnd); dom.restoreParentsScrollTop(textArea, scrollState); } catch (e) { // Sometimes IE throws when setting selection (e.g. textarea is off-DOM) } } }