| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958 |
- /*---------------------------------------------------------------------------------------------
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
- import { onUnexpectedError } from '../../../base/common/errors.js';
- import * as strings from '../../../base/common/strings.js';
- import { ReplaceCommand, ReplaceCommandWithOffsetCursorState, ReplaceCommandWithoutChangingPosition, ReplaceCommandThatPreservesSelection } from '../commands/replaceCommand.js';
- import { ShiftCommand } from '../commands/shiftCommand.js';
- import { CompositionSurroundSelectionCommand, SurroundSelectionCommand } from '../commands/surroundSelectionCommand.js';
- import { EditOperationResult, isQuote } from '../cursorCommon.js';
- import { getMapForWordSeparators } from '../core/wordCharacterClassifier.js';
- import { Range } from '../core/range.js';
- import { Position } from '../core/position.js';
- import { IndentAction } from '../languages/languageConfiguration.js';
- import { getIndentationAtPosition } from '../languages/languageConfigurationRegistry.js';
- import { createScopedLineTokens } from '../languages/supports.js';
- import { getIndentActionForType, getIndentForEnter, getInheritIndentForLine } from '../languages/autoIndent.js';
- import { getEnterAction } from '../languages/enterAction.js';
- export class TypeOperations {
- static indent(config, model, selections) {
- if (model === null || selections === null) {
- return [];
- }
- const commands = [];
- for (let i = 0, len = selections.length; i < len; i++) {
- commands[i] = new ShiftCommand(selections[i], {
- isUnshift: false,
- tabSize: config.tabSize,
- indentSize: config.indentSize,
- insertSpaces: config.insertSpaces,
- useTabStops: config.useTabStops,
- autoIndent: config.autoIndent
- }, config.languageConfigurationService);
- }
- return commands;
- }
- static outdent(config, model, selections) {
- const commands = [];
- for (let i = 0, len = selections.length; i < len; i++) {
- commands[i] = new ShiftCommand(selections[i], {
- isUnshift: true,
- tabSize: config.tabSize,
- indentSize: config.indentSize,
- insertSpaces: config.insertSpaces,
- useTabStops: config.useTabStops,
- autoIndent: config.autoIndent
- }, config.languageConfigurationService);
- }
- return commands;
- }
- static shiftIndent(config, indentation, count) {
- count = count || 1;
- return ShiftCommand.shiftIndent(indentation, indentation.length + count, config.tabSize, config.indentSize, config.insertSpaces);
- }
- static unshiftIndent(config, indentation, count) {
- count = count || 1;
- return ShiftCommand.unshiftIndent(indentation, indentation.length + count, config.tabSize, config.indentSize, config.insertSpaces);
- }
- static _distributedPaste(config, model, selections, text) {
- const commands = [];
- for (let i = 0, len = selections.length; i < len; i++) {
- commands[i] = new ReplaceCommand(selections[i], text[i]);
- }
- return new EditOperationResult(0 /* EditOperationType.Other */, commands, {
- shouldPushStackElementBefore: true,
- shouldPushStackElementAfter: true
- });
- }
- static _simplePaste(config, model, selections, text, pasteOnNewLine) {
- const commands = [];
- for (let i = 0, len = selections.length; i < len; i++) {
- const selection = selections[i];
- const position = selection.getPosition();
- if (pasteOnNewLine && !selection.isEmpty()) {
- pasteOnNewLine = false;
- }
- if (pasteOnNewLine && text.indexOf('\n') !== text.length - 1) {
- pasteOnNewLine = false;
- }
- if (pasteOnNewLine) {
- // Paste entire line at the beginning of line
- const typeSelection = new Range(position.lineNumber, 1, position.lineNumber, 1);
- commands[i] = new ReplaceCommandThatPreservesSelection(typeSelection, text, selection, true);
- }
- else {
- commands[i] = new ReplaceCommand(selection, text);
- }
- }
- return new EditOperationResult(0 /* EditOperationType.Other */, commands, {
- shouldPushStackElementBefore: true,
- shouldPushStackElementAfter: true
- });
- }
- static _distributePasteToCursors(config, selections, text, pasteOnNewLine, multicursorText) {
- if (pasteOnNewLine) {
- return null;
- }
- if (selections.length === 1) {
- return null;
- }
- if (multicursorText && multicursorText.length === selections.length) {
- return multicursorText;
- }
- if (config.multiCursorPaste === 'spread') {
- // Try to spread the pasted text in case the line count matches the cursor count
- // Remove trailing \n if present
- if (text.charCodeAt(text.length - 1) === 10 /* CharCode.LineFeed */) {
- text = text.substr(0, text.length - 1);
- }
- // Remove trailing \r if present
- if (text.charCodeAt(text.length - 1) === 13 /* CharCode.CarriageReturn */) {
- text = text.substr(0, text.length - 1);
- }
- const lines = strings.splitLines(text);
- if (lines.length === selections.length) {
- return lines;
- }
- }
- return null;
- }
- static paste(config, model, selections, text, pasteOnNewLine, multicursorText) {
- const distributedPaste = this._distributePasteToCursors(config, selections, text, pasteOnNewLine, multicursorText);
- if (distributedPaste) {
- selections = selections.sort(Range.compareRangesUsingStarts);
- return this._distributedPaste(config, model, selections, distributedPaste);
- }
- else {
- return this._simplePaste(config, model, selections, text, pasteOnNewLine);
- }
- }
- static _goodIndentForLine(config, model, lineNumber) {
- let action = null;
- let indentation = '';
- const expectedIndentAction = getInheritIndentForLine(config.autoIndent, model, lineNumber, false, config.languageConfigurationService);
- if (expectedIndentAction) {
- action = expectedIndentAction.action;
- indentation = expectedIndentAction.indentation;
- }
- else if (lineNumber > 1) {
- let lastLineNumber;
- for (lastLineNumber = lineNumber - 1; lastLineNumber >= 1; lastLineNumber--) {
- const lineText = model.getLineContent(lastLineNumber);
- const nonWhitespaceIdx = strings.lastNonWhitespaceIndex(lineText);
- if (nonWhitespaceIdx >= 0) {
- break;
- }
- }
- if (lastLineNumber < 1) {
- // No previous line with content found
- return null;
- }
- const maxColumn = model.getLineMaxColumn(lastLineNumber);
- const expectedEnterAction = getEnterAction(config.autoIndent, model, new Range(lastLineNumber, maxColumn, lastLineNumber, maxColumn), config.languageConfigurationService);
- if (expectedEnterAction) {
- indentation = expectedEnterAction.indentation + expectedEnterAction.appendText;
- }
- }
- if (action) {
- if (action === IndentAction.Indent) {
- indentation = TypeOperations.shiftIndent(config, indentation);
- }
- if (action === IndentAction.Outdent) {
- indentation = TypeOperations.unshiftIndent(config, indentation);
- }
- indentation = config.normalizeIndentation(indentation);
- }
- if (!indentation) {
- return null;
- }
- return indentation;
- }
- static _replaceJumpToNextIndent(config, model, selection, insertsAutoWhitespace) {
- let typeText = '';
- const position = selection.getStartPosition();
- if (config.insertSpaces) {
- const visibleColumnFromColumn = config.visibleColumnFromColumn(model, position);
- const indentSize = config.indentSize;
- const spacesCnt = indentSize - (visibleColumnFromColumn % indentSize);
- for (let i = 0; i < spacesCnt; i++) {
- typeText += ' ';
- }
- }
- else {
- typeText = '\t';
- }
- return new ReplaceCommand(selection, typeText, insertsAutoWhitespace);
- }
- static tab(config, model, selections) {
- const commands = [];
- for (let i = 0, len = selections.length; i < len; i++) {
- const selection = selections[i];
- if (selection.isEmpty()) {
- const lineText = model.getLineContent(selection.startLineNumber);
- if (/^\s*$/.test(lineText) && model.tokenization.isCheapToTokenize(selection.startLineNumber)) {
- let goodIndent = this._goodIndentForLine(config, model, selection.startLineNumber);
- goodIndent = goodIndent || '\t';
- const possibleTypeText = config.normalizeIndentation(goodIndent);
- if (!lineText.startsWith(possibleTypeText)) {
- commands[i] = new ReplaceCommand(new Range(selection.startLineNumber, 1, selection.startLineNumber, lineText.length + 1), possibleTypeText, true);
- continue;
- }
- }
- commands[i] = this._replaceJumpToNextIndent(config, model, selection, true);
- }
- else {
- if (selection.startLineNumber === selection.endLineNumber) {
- const lineMaxColumn = model.getLineMaxColumn(selection.startLineNumber);
- if (selection.startColumn !== 1 || selection.endColumn !== lineMaxColumn) {
- // This is a single line selection that is not the entire line
- commands[i] = this._replaceJumpToNextIndent(config, model, selection, false);
- continue;
- }
- }
- commands[i] = new ShiftCommand(selection, {
- isUnshift: false,
- tabSize: config.tabSize,
- indentSize: config.indentSize,
- insertSpaces: config.insertSpaces,
- useTabStops: config.useTabStops,
- autoIndent: config.autoIndent
- }, config.languageConfigurationService);
- }
- }
- return commands;
- }
- static compositionType(prevEditOperationType, config, model, selections, text, replacePrevCharCnt, replaceNextCharCnt, positionDelta) {
- const commands = selections.map(selection => this._compositionType(model, selection, text, replacePrevCharCnt, replaceNextCharCnt, positionDelta));
- return new EditOperationResult(4 /* EditOperationType.TypingOther */, commands, {
- shouldPushStackElementBefore: shouldPushStackElementBetween(prevEditOperationType, 4 /* EditOperationType.TypingOther */),
- shouldPushStackElementAfter: false
- });
- }
- static _compositionType(model, selection, text, replacePrevCharCnt, replaceNextCharCnt, positionDelta) {
- if (!selection.isEmpty()) {
- // looks like https://github.com/microsoft/vscode/issues/2773
- // where a cursor operation occurred before a canceled composition
- // => ignore composition
- return null;
- }
- const pos = selection.getPosition();
- const startColumn = Math.max(1, pos.column - replacePrevCharCnt);
- const endColumn = Math.min(model.getLineMaxColumn(pos.lineNumber), pos.column + replaceNextCharCnt);
- const range = new Range(pos.lineNumber, startColumn, pos.lineNumber, endColumn);
- const oldText = model.getValueInRange(range);
- if (oldText === text && positionDelta === 0) {
- // => ignore composition that doesn't do anything
- return null;
- }
- return new ReplaceCommandWithOffsetCursorState(range, text, 0, positionDelta);
- }
- static _typeCommand(range, text, keepPosition) {
- if (keepPosition) {
- return new ReplaceCommandWithoutChangingPosition(range, text, true);
- }
- else {
- return new ReplaceCommand(range, text, true);
- }
- }
- static _enter(config, model, keepPosition, range) {
- if (config.autoIndent === 0 /* EditorAutoIndentStrategy.None */) {
- return TypeOperations._typeCommand(range, '\n', keepPosition);
- }
- if (!model.tokenization.isCheapToTokenize(range.getStartPosition().lineNumber) || config.autoIndent === 1 /* EditorAutoIndentStrategy.Keep */) {
- const lineText = model.getLineContent(range.startLineNumber);
- const indentation = strings.getLeadingWhitespace(lineText).substring(0, range.startColumn - 1);
- return TypeOperations._typeCommand(range, '\n' + config.normalizeIndentation(indentation), keepPosition);
- }
- const r = getEnterAction(config.autoIndent, model, range, config.languageConfigurationService);
- if (r) {
- if (r.indentAction === IndentAction.None) {
- // Nothing special
- return TypeOperations._typeCommand(range, '\n' + config.normalizeIndentation(r.indentation + r.appendText), keepPosition);
- }
- else if (r.indentAction === IndentAction.Indent) {
- // Indent once
- return TypeOperations._typeCommand(range, '\n' + config.normalizeIndentation(r.indentation + r.appendText), keepPosition);
- }
- else if (r.indentAction === IndentAction.IndentOutdent) {
- // Ultra special
- const normalIndent = config.normalizeIndentation(r.indentation);
- const increasedIndent = config.normalizeIndentation(r.indentation + r.appendText);
- const typeText = '\n' + increasedIndent + '\n' + normalIndent;
- if (keepPosition) {
- return new ReplaceCommandWithoutChangingPosition(range, typeText, true);
- }
- else {
- return new ReplaceCommandWithOffsetCursorState(range, typeText, -1, increasedIndent.length - normalIndent.length, true);
- }
- }
- else if (r.indentAction === IndentAction.Outdent) {
- const actualIndentation = TypeOperations.unshiftIndent(config, r.indentation);
- return TypeOperations._typeCommand(range, '\n' + config.normalizeIndentation(actualIndentation + r.appendText), keepPosition);
- }
- }
- const lineText = model.getLineContent(range.startLineNumber);
- const indentation = strings.getLeadingWhitespace(lineText).substring(0, range.startColumn - 1);
- if (config.autoIndent >= 4 /* EditorAutoIndentStrategy.Full */) {
- const ir = getIndentForEnter(config.autoIndent, model, range, {
- unshiftIndent: (indent) => {
- return TypeOperations.unshiftIndent(config, indent);
- },
- shiftIndent: (indent) => {
- return TypeOperations.shiftIndent(config, indent);
- },
- normalizeIndentation: (indent) => {
- return config.normalizeIndentation(indent);
- }
- }, config.languageConfigurationService);
- if (ir) {
- let oldEndViewColumn = config.visibleColumnFromColumn(model, range.getEndPosition());
- const oldEndColumn = range.endColumn;
- const newLineContent = model.getLineContent(range.endLineNumber);
- const firstNonWhitespace = strings.firstNonWhitespaceIndex(newLineContent);
- if (firstNonWhitespace >= 0) {
- range = range.setEndPosition(range.endLineNumber, Math.max(range.endColumn, firstNonWhitespace + 1));
- }
- else {
- range = range.setEndPosition(range.endLineNumber, model.getLineMaxColumn(range.endLineNumber));
- }
- if (keepPosition) {
- return new ReplaceCommandWithoutChangingPosition(range, '\n' + config.normalizeIndentation(ir.afterEnter), true);
- }
- else {
- let offset = 0;
- if (oldEndColumn <= firstNonWhitespace + 1) {
- if (!config.insertSpaces) {
- oldEndViewColumn = Math.ceil(oldEndViewColumn / config.indentSize);
- }
- offset = Math.min(oldEndViewColumn + 1 - config.normalizeIndentation(ir.afterEnter).length - 1, 0);
- }
- return new ReplaceCommandWithOffsetCursorState(range, '\n' + config.normalizeIndentation(ir.afterEnter), 0, offset, true);
- }
- }
- }
- return TypeOperations._typeCommand(range, '\n' + config.normalizeIndentation(indentation), keepPosition);
- }
- static _isAutoIndentType(config, model, selections) {
- if (config.autoIndent < 4 /* EditorAutoIndentStrategy.Full */) {
- return false;
- }
- for (let i = 0, len = selections.length; i < len; i++) {
- if (!model.tokenization.isCheapToTokenize(selections[i].getEndPosition().lineNumber)) {
- return false;
- }
- }
- return true;
- }
- static _runAutoIndentType(config, model, range, ch) {
- const currentIndentation = getIndentationAtPosition(model, range.startLineNumber, range.startColumn);
- const actualIndentation = getIndentActionForType(config.autoIndent, model, range, ch, {
- shiftIndent: (indentation) => {
- return TypeOperations.shiftIndent(config, indentation);
- },
- unshiftIndent: (indentation) => {
- return TypeOperations.unshiftIndent(config, indentation);
- },
- }, config.languageConfigurationService);
- if (actualIndentation === null) {
- return null;
- }
- if (actualIndentation !== config.normalizeIndentation(currentIndentation)) {
- const firstNonWhitespace = model.getLineFirstNonWhitespaceColumn(range.startLineNumber);
- if (firstNonWhitespace === 0) {
- return TypeOperations._typeCommand(new Range(range.startLineNumber, 1, range.endLineNumber, range.endColumn), config.normalizeIndentation(actualIndentation) + ch, false);
- }
- else {
- return TypeOperations._typeCommand(new Range(range.startLineNumber, 1, range.endLineNumber, range.endColumn), config.normalizeIndentation(actualIndentation) +
- model.getLineContent(range.startLineNumber).substring(firstNonWhitespace - 1, range.startColumn - 1) + ch, false);
- }
- }
- return null;
- }
- static _isAutoClosingOvertype(config, model, selections, autoClosedCharacters, ch) {
- if (config.autoClosingOvertype === 'never') {
- return false;
- }
- if (!config.autoClosingPairs.autoClosingPairsCloseSingleChar.has(ch)) {
- return false;
- }
- for (let i = 0, len = selections.length; i < len; i++) {
- const selection = selections[i];
- if (!selection.isEmpty()) {
- return false;
- }
- const position = selection.getPosition();
- const lineText = model.getLineContent(position.lineNumber);
- const afterCharacter = lineText.charAt(position.column - 1);
- if (afterCharacter !== ch) {
- return false;
- }
- // Do not over-type quotes after a backslash
- const chIsQuote = isQuote(ch);
- const beforeCharacter = position.column > 2 ? lineText.charCodeAt(position.column - 2) : 0 /* CharCode.Null */;
- if (beforeCharacter === 92 /* CharCode.Backslash */ && chIsQuote) {
- return false;
- }
- // Must over-type a closing character typed by the editor
- if (config.autoClosingOvertype === 'auto') {
- let found = false;
- for (let j = 0, lenJ = autoClosedCharacters.length; j < lenJ; j++) {
- const autoClosedCharacter = autoClosedCharacters[j];
- if (position.lineNumber === autoClosedCharacter.startLineNumber && position.column === autoClosedCharacter.startColumn) {
- found = true;
- break;
- }
- }
- if (!found) {
- return false;
- }
- }
- }
- return true;
- }
- static _runAutoClosingOvertype(prevEditOperationType, config, model, selections, ch) {
- const commands = [];
- for (let i = 0, len = selections.length; i < len; i++) {
- const selection = selections[i];
- const position = selection.getPosition();
- const typeSelection = new Range(position.lineNumber, position.column, position.lineNumber, position.column + 1);
- commands[i] = new ReplaceCommand(typeSelection, ch);
- }
- return new EditOperationResult(4 /* EditOperationType.TypingOther */, commands, {
- shouldPushStackElementBefore: shouldPushStackElementBetween(prevEditOperationType, 4 /* EditOperationType.TypingOther */),
- shouldPushStackElementAfter: false
- });
- }
- static _isBeforeClosingBrace(config, lineAfter) {
- // If the start of lineAfter can be interpretted as both a starting or ending brace, default to returning false
- const nextChar = lineAfter.charAt(0);
- const potentialStartingBraces = config.autoClosingPairs.autoClosingPairsOpenByStart.get(nextChar) || [];
- const potentialClosingBraces = config.autoClosingPairs.autoClosingPairsCloseByStart.get(nextChar) || [];
- const isBeforeStartingBrace = potentialStartingBraces.some(x => lineAfter.startsWith(x.open));
- const isBeforeClosingBrace = potentialClosingBraces.some(x => lineAfter.startsWith(x.close));
- return !isBeforeStartingBrace && isBeforeClosingBrace;
- }
- /**
- * Determine if typing `ch` at all `positions` in the `model` results in an
- * auto closing open sequence being typed.
- *
- * Auto closing open sequences can consist of multiple characters, which
- * can lead to ambiguities. In such a case, the longest auto-closing open
- * sequence is returned.
- */
- static _findAutoClosingPairOpen(config, model, positions, ch) {
- const candidates = config.autoClosingPairs.autoClosingPairsOpenByEnd.get(ch);
- if (!candidates) {
- return null;
- }
- // Determine which auto-closing pair it is
- let result = null;
- for (const candidate of candidates) {
- if (result === null || candidate.open.length > result.open.length) {
- let candidateIsMatch = true;
- for (const position of positions) {
- const relevantText = model.getValueInRange(new Range(position.lineNumber, position.column - candidate.open.length + 1, position.lineNumber, position.column));
- if (relevantText + ch !== candidate.open) {
- candidateIsMatch = false;
- break;
- }
- }
- if (candidateIsMatch) {
- result = candidate;
- }
- }
- }
- return result;
- }
- /**
- * Find another auto-closing pair that is contained by the one passed in.
- *
- * e.g. when having [(,)] and [(*,*)] as auto-closing pairs
- * this method will find [(,)] as a containment pair for [(*,*)]
- */
- static _findContainedAutoClosingPair(config, pair) {
- if (pair.open.length <= 1) {
- return null;
- }
- const lastChar = pair.close.charAt(pair.close.length - 1);
- // get candidates with the same last character as close
- const candidates = config.autoClosingPairs.autoClosingPairsCloseByEnd.get(lastChar) || [];
- let result = null;
- for (const candidate of candidates) {
- if (candidate.open !== pair.open && pair.open.includes(candidate.open) && pair.close.endsWith(candidate.close)) {
- if (!result || candidate.open.length > result.open.length) {
- result = candidate;
- }
- }
- }
- return result;
- }
- static _getAutoClosingPairClose(config, model, selections, ch, chIsAlreadyTyped) {
- const chIsQuote = isQuote(ch);
- const autoCloseConfig = (chIsQuote ? config.autoClosingQuotes : config.autoClosingBrackets);
- const shouldAutoCloseBefore = (chIsQuote ? config.shouldAutoCloseBefore.quote : config.shouldAutoCloseBefore.bracket);
- if (autoCloseConfig === 'never') {
- return null;
- }
- for (const selection of selections) {
- if (!selection.isEmpty()) {
- return null;
- }
- }
- // This method is called both when typing (regularly) and when composition ends
- // This means that we need to work with a text buffer where sometimes `ch` is not
- // there (it is being typed right now) or with a text buffer where `ch` has already been typed
- //
- // In order to avoid adding checks for `chIsAlreadyTyped` in all places, we will work
- // with two conceptual positions, the position before `ch` and the position after `ch`
- //
- const positions = selections.map((s) => {
- const position = s.getPosition();
- if (chIsAlreadyTyped) {
- return { lineNumber: position.lineNumber, beforeColumn: position.column - ch.length, afterColumn: position.column };
- }
- else {
- return { lineNumber: position.lineNumber, beforeColumn: position.column, afterColumn: position.column };
- }
- });
- // Find the longest auto-closing open pair in case of multiple ending in `ch`
- // e.g. when having [f","] and [","], it picks [f","] if the character before is f
- const pair = this._findAutoClosingPairOpen(config, model, positions.map(p => new Position(p.lineNumber, p.beforeColumn)), ch);
- if (!pair) {
- return null;
- }
- // Sometimes, it is possible to have two auto-closing pairs that have a containment relationship
- // e.g. when having [(,)] and [(*,*)]
- // - when typing (, the resulting state is (|)
- // - when typing *, the desired resulting state is (*|*), not (*|*))
- const containedPair = this._findContainedAutoClosingPair(config, pair);
- const containedPairClose = containedPair ? containedPair.close : '';
- let isContainedPairPresent = true;
- for (const position of positions) {
- const { lineNumber, beforeColumn, afterColumn } = position;
- const lineText = model.getLineContent(lineNumber);
- const lineBefore = lineText.substring(0, beforeColumn - 1);
- const lineAfter = lineText.substring(afterColumn - 1);
- if (!lineAfter.startsWith(containedPairClose)) {
- isContainedPairPresent = false;
- }
- // Only consider auto closing the pair if an allowed character follows or if another autoclosed pair closing brace follows
- if (lineAfter.length > 0) {
- const characterAfter = lineAfter.charAt(0);
- const isBeforeCloseBrace = TypeOperations._isBeforeClosingBrace(config, lineAfter);
- if (!isBeforeCloseBrace && !shouldAutoCloseBefore(characterAfter)) {
- return null;
- }
- }
- // Do not auto-close ' or " after a word character
- if (pair.open.length === 1 && (ch === '\'' || ch === '"') && autoCloseConfig !== 'always') {
- const wordSeparators = getMapForWordSeparators(config.wordSeparators);
- if (lineBefore.length > 0) {
- const characterBefore = lineBefore.charCodeAt(lineBefore.length - 1);
- if (wordSeparators.get(characterBefore) === 0 /* WordCharacterClass.Regular */) {
- return null;
- }
- }
- }
- if (!model.tokenization.isCheapToTokenize(lineNumber)) {
- // Do not force tokenization
- return null;
- }
- model.tokenization.forceTokenization(lineNumber);
- const lineTokens = model.tokenization.getLineTokens(lineNumber);
- const scopedLineTokens = createScopedLineTokens(lineTokens, beforeColumn - 1);
- if (!pair.shouldAutoClose(scopedLineTokens, beforeColumn - scopedLineTokens.firstCharOffset)) {
- return null;
- }
- // Typing for example a quote could either start a new string, in which case auto-closing is desirable
- // or it could end a previously started string, in which case auto-closing is not desirable
- //
- // In certain cases, it is really not possible to look at the previous token to determine
- // what would happen. That's why we do something really unusual, we pretend to type a different
- // character and ask the tokenizer what the outcome of doing that is: after typing a neutral
- // character, are we in a string (i.e. the quote would most likely end a string) or not?
- //
- const neutralCharacter = pair.findNeutralCharacter();
- if (neutralCharacter) {
- const tokenType = model.tokenization.getTokenTypeIfInsertingCharacter(lineNumber, beforeColumn, neutralCharacter);
- if (!pair.isOK(tokenType)) {
- return null;
- }
- }
- }
- if (isContainedPairPresent) {
- return pair.close.substring(0, pair.close.length - containedPairClose.length);
- }
- else {
- return pair.close;
- }
- }
- static _runAutoClosingOpenCharType(prevEditOperationType, config, model, selections, ch, chIsAlreadyTyped, autoClosingPairClose) {
- const commands = [];
- for (let i = 0, len = selections.length; i < len; i++) {
- const selection = selections[i];
- commands[i] = new TypeWithAutoClosingCommand(selection, ch, !chIsAlreadyTyped, autoClosingPairClose);
- }
- return new EditOperationResult(4 /* EditOperationType.TypingOther */, commands, {
- shouldPushStackElementBefore: true,
- shouldPushStackElementAfter: false
- });
- }
- static _shouldSurroundChar(config, ch) {
- if (isQuote(ch)) {
- return (config.autoSurround === 'quotes' || config.autoSurround === 'languageDefined');
- }
- else {
- // Character is a bracket
- return (config.autoSurround === 'brackets' || config.autoSurround === 'languageDefined');
- }
- }
- static _isSurroundSelectionType(config, model, selections, ch) {
- if (!TypeOperations._shouldSurroundChar(config, ch) || !config.surroundingPairs.hasOwnProperty(ch)) {
- return false;
- }
- const isTypingAQuoteCharacter = isQuote(ch);
- for (const selection of selections) {
- if (selection.isEmpty()) {
- return false;
- }
- let selectionContainsOnlyWhitespace = true;
- for (let lineNumber = selection.startLineNumber; lineNumber <= selection.endLineNumber; lineNumber++) {
- const lineText = model.getLineContent(lineNumber);
- const startIndex = (lineNumber === selection.startLineNumber ? selection.startColumn - 1 : 0);
- const endIndex = (lineNumber === selection.endLineNumber ? selection.endColumn - 1 : lineText.length);
- const selectedText = lineText.substring(startIndex, endIndex);
- if (/[^ \t]/.test(selectedText)) {
- // this selected text contains something other than whitespace
- selectionContainsOnlyWhitespace = false;
- break;
- }
- }
- if (selectionContainsOnlyWhitespace) {
- return false;
- }
- if (isTypingAQuoteCharacter && selection.startLineNumber === selection.endLineNumber && selection.startColumn + 1 === selection.endColumn) {
- const selectionText = model.getValueInRange(selection);
- if (isQuote(selectionText)) {
- // Typing a quote character on top of another quote character
- // => disable surround selection type
- return false;
- }
- }
- }
- return true;
- }
- static _runSurroundSelectionType(prevEditOperationType, config, model, selections, ch) {
- const commands = [];
- for (let i = 0, len = selections.length; i < len; i++) {
- const selection = selections[i];
- const closeCharacter = config.surroundingPairs[ch];
- commands[i] = new SurroundSelectionCommand(selection, ch, closeCharacter);
- }
- return new EditOperationResult(0 /* EditOperationType.Other */, commands, {
- shouldPushStackElementBefore: true,
- shouldPushStackElementAfter: true
- });
- }
- static _isTypeInterceptorElectricChar(config, model, selections) {
- if (selections.length === 1 && model.tokenization.isCheapToTokenize(selections[0].getEndPosition().lineNumber)) {
- return true;
- }
- return false;
- }
- static _typeInterceptorElectricChar(prevEditOperationType, config, model, selection, ch) {
- if (!config.electricChars.hasOwnProperty(ch) || !selection.isEmpty()) {
- return null;
- }
- const position = selection.getPosition();
- model.tokenization.forceTokenization(position.lineNumber);
- const lineTokens = model.tokenization.getLineTokens(position.lineNumber);
- let electricAction;
- try {
- electricAction = config.onElectricCharacter(ch, lineTokens, position.column);
- }
- catch (e) {
- onUnexpectedError(e);
- return null;
- }
- if (!electricAction) {
- return null;
- }
- if (electricAction.matchOpenBracket) {
- const endColumn = (lineTokens.getLineContent() + ch).lastIndexOf(electricAction.matchOpenBracket) + 1;
- const match = model.bracketPairs.findMatchingBracketUp(electricAction.matchOpenBracket, {
- lineNumber: position.lineNumber,
- column: endColumn
- }, 500 /* give at most 500ms to compute */);
- if (match) {
- if (match.startLineNumber === position.lineNumber) {
- // matched something on the same line => no change in indentation
- return null;
- }
- const matchLine = model.getLineContent(match.startLineNumber);
- const matchLineIndentation = strings.getLeadingWhitespace(matchLine);
- const newIndentation = config.normalizeIndentation(matchLineIndentation);
- const lineText = model.getLineContent(position.lineNumber);
- const lineFirstNonBlankColumn = model.getLineFirstNonWhitespaceColumn(position.lineNumber) || position.column;
- const prefix = lineText.substring(lineFirstNonBlankColumn - 1, position.column - 1);
- const typeText = newIndentation + prefix + ch;
- const typeSelection = new Range(position.lineNumber, 1, position.lineNumber, position.column);
- const command = new ReplaceCommand(typeSelection, typeText);
- return new EditOperationResult(getTypingOperation(typeText, prevEditOperationType), [command], {
- shouldPushStackElementBefore: false,
- shouldPushStackElementAfter: true
- });
- }
- }
- return null;
- }
- /**
- * This is very similar with typing, but the character is already in the text buffer!
- */
- static compositionEndWithInterceptors(prevEditOperationType, config, model, compositions, selections, autoClosedCharacters) {
- if (!compositions) {
- // could not deduce what the composition did
- return null;
- }
- let insertedText = null;
- for (const composition of compositions) {
- if (insertedText === null) {
- insertedText = composition.insertedText;
- }
- else if (insertedText !== composition.insertedText) {
- // not all selections agree on what was typed
- return null;
- }
- }
- if (!insertedText || insertedText.length !== 1) {
- // we're only interested in the case where a single character was inserted
- return null;
- }
- const ch = insertedText;
- let hasDeletion = false;
- for (const composition of compositions) {
- if (composition.deletedText.length !== 0) {
- hasDeletion = true;
- break;
- }
- }
- if (hasDeletion) {
- // Check if this could have been a surround selection
- if (!TypeOperations._shouldSurroundChar(config, ch) || !config.surroundingPairs.hasOwnProperty(ch)) {
- return null;
- }
- const isTypingAQuoteCharacter = isQuote(ch);
- for (const composition of compositions) {
- if (composition.deletedSelectionStart !== 0 || composition.deletedSelectionEnd !== composition.deletedText.length) {
- // more text was deleted than was selected, so this could not have been a surround selection
- return null;
- }
- if (/^[ \t]+$/.test(composition.deletedText)) {
- // deleted text was only whitespace
- return null;
- }
- if (isTypingAQuoteCharacter && isQuote(composition.deletedText)) {
- // deleted text was a quote
- return null;
- }
- }
- const positions = [];
- for (const selection of selections) {
- if (!selection.isEmpty()) {
- return null;
- }
- positions.push(selection.getPosition());
- }
- if (positions.length !== compositions.length) {
- return null;
- }
- const commands = [];
- for (let i = 0, len = positions.length; i < len; i++) {
- commands.push(new CompositionSurroundSelectionCommand(positions[i], compositions[i].deletedText, ch));
- }
- return new EditOperationResult(4 /* EditOperationType.TypingOther */, commands, {
- shouldPushStackElementBefore: true,
- shouldPushStackElementAfter: false
- });
- }
- if (this._isAutoClosingOvertype(config, model, selections, autoClosedCharacters, ch)) {
- // Unfortunately, the close character is at this point "doubled", so we need to delete it...
- const commands = selections.map(s => new ReplaceCommand(new Range(s.positionLineNumber, s.positionColumn, s.positionLineNumber, s.positionColumn + 1), '', false));
- return new EditOperationResult(4 /* EditOperationType.TypingOther */, commands, {
- shouldPushStackElementBefore: true,
- shouldPushStackElementAfter: false
- });
- }
- const autoClosingPairClose = this._getAutoClosingPairClose(config, model, selections, ch, true);
- if (autoClosingPairClose !== null) {
- return this._runAutoClosingOpenCharType(prevEditOperationType, config, model, selections, ch, true, autoClosingPairClose);
- }
- return null;
- }
- static typeWithInterceptors(isDoingComposition, prevEditOperationType, config, model, selections, autoClosedCharacters, ch) {
- if (!isDoingComposition && ch === '\n') {
- const commands = [];
- for (let i = 0, len = selections.length; i < len; i++) {
- commands[i] = TypeOperations._enter(config, model, false, selections[i]);
- }
- return new EditOperationResult(4 /* EditOperationType.TypingOther */, commands, {
- shouldPushStackElementBefore: true,
- shouldPushStackElementAfter: false,
- });
- }
- if (!isDoingComposition && this._isAutoIndentType(config, model, selections)) {
- const commands = [];
- let autoIndentFails = false;
- for (let i = 0, len = selections.length; i < len; i++) {
- commands[i] = this._runAutoIndentType(config, model, selections[i], ch);
- if (!commands[i]) {
- autoIndentFails = true;
- break;
- }
- }
- if (!autoIndentFails) {
- return new EditOperationResult(4 /* EditOperationType.TypingOther */, commands, {
- shouldPushStackElementBefore: true,
- shouldPushStackElementAfter: false,
- });
- }
- }
- if (this._isAutoClosingOvertype(config, model, selections, autoClosedCharacters, ch)) {
- return this._runAutoClosingOvertype(prevEditOperationType, config, model, selections, ch);
- }
- if (!isDoingComposition) {
- const autoClosingPairClose = this._getAutoClosingPairClose(config, model, selections, ch, false);
- if (autoClosingPairClose) {
- return this._runAutoClosingOpenCharType(prevEditOperationType, config, model, selections, ch, false, autoClosingPairClose);
- }
- }
- if (!isDoingComposition && this._isSurroundSelectionType(config, model, selections, ch)) {
- return this._runSurroundSelectionType(prevEditOperationType, config, model, selections, ch);
- }
- // Electric characters make sense only when dealing with a single cursor,
- // as multiple cursors typing brackets for example would interfer with bracket matching
- if (!isDoingComposition && this._isTypeInterceptorElectricChar(config, model, selections)) {
- const r = this._typeInterceptorElectricChar(prevEditOperationType, config, model, selections[0], ch);
- if (r) {
- return r;
- }
- }
- // A simple character type
- const commands = [];
- for (let i = 0, len = selections.length; i < len; i++) {
- commands[i] = new ReplaceCommand(selections[i], ch);
- }
- const opType = getTypingOperation(ch, prevEditOperationType);
- return new EditOperationResult(opType, commands, {
- shouldPushStackElementBefore: shouldPushStackElementBetween(prevEditOperationType, opType),
- shouldPushStackElementAfter: false
- });
- }
- static typeWithoutInterceptors(prevEditOperationType, config, model, selections, str) {
- const commands = [];
- for (let i = 0, len = selections.length; i < len; i++) {
- commands[i] = new ReplaceCommand(selections[i], str);
- }
- const opType = getTypingOperation(str, prevEditOperationType);
- return new EditOperationResult(opType, commands, {
- shouldPushStackElementBefore: shouldPushStackElementBetween(prevEditOperationType, opType),
- shouldPushStackElementAfter: false
- });
- }
- static lineInsertBefore(config, model, selections) {
- if (model === null || selections === null) {
- return [];
- }
- const commands = [];
- for (let i = 0, len = selections.length; i < len; i++) {
- let lineNumber = selections[i].positionLineNumber;
- if (lineNumber === 1) {
- commands[i] = new ReplaceCommandWithoutChangingPosition(new Range(1, 1, 1, 1), '\n');
- }
- else {
- lineNumber--;
- const column = model.getLineMaxColumn(lineNumber);
- commands[i] = this._enter(config, model, false, new Range(lineNumber, column, lineNumber, column));
- }
- }
- return commands;
- }
- static lineInsertAfter(config, model, selections) {
- if (model === null || selections === null) {
- return [];
- }
- const commands = [];
- for (let i = 0, len = selections.length; i < len; i++) {
- const lineNumber = selections[i].positionLineNumber;
- const column = model.getLineMaxColumn(lineNumber);
- commands[i] = this._enter(config, model, false, new Range(lineNumber, column, lineNumber, column));
- }
- return commands;
- }
- static lineBreakInsert(config, model, selections) {
- const commands = [];
- for (let i = 0, len = selections.length; i < len; i++) {
- commands[i] = this._enter(config, model, true, selections[i]);
- }
- return commands;
- }
- }
- export class TypeWithAutoClosingCommand extends ReplaceCommandWithOffsetCursorState {
- constructor(selection, openCharacter, insertOpenCharacter, closeCharacter) {
- super(selection, (insertOpenCharacter ? openCharacter : '') + closeCharacter, 0, -closeCharacter.length);
- this._openCharacter = openCharacter;
- this._closeCharacter = closeCharacter;
- this.closeCharacterRange = null;
- this.enclosingRange = null;
- }
- computeCursorState(model, helper) {
- const inverseEditOperations = helper.getInverseEditOperations();
- const range = inverseEditOperations[0].range;
- this.closeCharacterRange = new Range(range.startLineNumber, range.endColumn - this._closeCharacter.length, range.endLineNumber, range.endColumn);
- this.enclosingRange = new Range(range.startLineNumber, range.endColumn - this._openCharacter.length - this._closeCharacter.length, range.endLineNumber, range.endColumn);
- return super.computeCursorState(model, helper);
- }
- }
- export class CompositionOutcome {
- constructor(deletedText, deletedSelectionStart, deletedSelectionEnd, insertedText, insertedSelectionStart, insertedSelectionEnd) {
- this.deletedText = deletedText;
- this.deletedSelectionStart = deletedSelectionStart;
- this.deletedSelectionEnd = deletedSelectionEnd;
- this.insertedText = insertedText;
- this.insertedSelectionStart = insertedSelectionStart;
- this.insertedSelectionEnd = insertedSelectionEnd;
- }
- }
- function getTypingOperation(typedText, previousTypingOperation) {
- if (typedText === ' ') {
- return previousTypingOperation === 5 /* EditOperationType.TypingFirstSpace */
- || previousTypingOperation === 6 /* EditOperationType.TypingConsecutiveSpace */
- ? 6 /* EditOperationType.TypingConsecutiveSpace */
- : 5 /* EditOperationType.TypingFirstSpace */;
- }
- return 4 /* EditOperationType.TypingOther */;
- }
- function shouldPushStackElementBetween(previousTypingOperation, typingOperation) {
- if (isTypingOperation(previousTypingOperation) && !isTypingOperation(typingOperation)) {
- // Always set an undo stop before non-type operations
- return true;
- }
- if (previousTypingOperation === 5 /* EditOperationType.TypingFirstSpace */) {
- // `abc |d`: No undo stop
- // `abc |d`: Undo stop
- return false;
- }
- // Insert undo stop between different operation types
- return normalizeOperationType(previousTypingOperation) !== normalizeOperationType(typingOperation);
- }
- function normalizeOperationType(type) {
- return (type === 6 /* EditOperationType.TypingConsecutiveSpace */ || type === 5 /* EditOperationType.TypingFirstSpace */)
- ? 'space'
- : type;
- }
- function isTypingOperation(type) {
- return type === 4 /* EditOperationType.TypingOther */
- || type === 5 /* EditOperationType.TypingFirstSpace */
- || type === 6 /* EditOperationType.TypingConsecutiveSpace */;
- }
|