abbreviationActions.ts 24.8 KB
Newer Older
1 2 3 4 5 6
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

import * as vscode from 'vscode';
7
import { Node, HtmlNode, Rule, Property, Stylesheet } from 'EmmetNode';
8
import { getEmmetHelper, getNode, getInnerRange, getMappingForIncludedLanguages, parseDocument, validate, getEmmetConfiguration, isStyleSheet, getEmmetMode, parsePartialStylesheet, isStyleAttribute, getEmbeddedCssNodeIfAny } from './util';
9

10
const trimRegex = /[\u00a0]*[\d|#|\-|\*|\u2022]+\.?/;
11
const hexColorRegex = /^#\d+$/;
12
const allowedMimeTypesInScriptTag = ['text/html', 'text/plain', 'text/x-template', 'text/template'];
13 14 15 16 17 18
const inlineElements = ['a', 'abbr', 'acronym', 'applet', 'b', 'basefont', 'bdo',
	'big', 'br', 'button', 'cite', 'code', 'del', 'dfn', 'em', 'font', 'i',
	'iframe', 'img', 'input', 'ins', 'kbd', 'label', 'map', 'object', 'q',
	's', 'samp', 'select', 'small', 'span', 'strike', 'strong', 'sub', 'sup',
	'textarea', 'tt', 'u', 'var'];

R
Ramya Achutha Rao 已提交
19
interface ExpandAbbreviationInput {
20
	syntax: string;
R
Ramya Achutha Rao 已提交
21 22
	abbreviation: string;
	rangeToReplace: vscode.Range;
23
	textToWrap?: string[];
24
	filter?: string;
R
Ramya Achutha Rao 已提交
25 26
}

27 28 29 30 31 32 33
interface PreviewRangesWithContent {
	previewRange: vscode.Range;
	originalRange: vscode.Range;
	originalContent: string;
	textToWrapInPreview: string[];
}

34
export function wrapWithAbbreviation(args: any) {
35 36 37 38 39 40 41 42
	return doWrapping(false, args);
}

export function wrapIndividualLinesWithAbbreviation(args: any) {
	return doWrapping(true, args);
}

function doWrapping(individualLines: boolean, args: any) {
43
	if (!validate(false) || !vscode.window.activeTextEditor) {
44 45
		return;
	}
46 47

	const editor = vscode.window.activeTextEditor;
48 49 50 51 52 53 54 55 56 57 58 59
	const rootNode = parseDocument(editor.document, false);
	if (individualLines) {
		if (editor.selections.length === 1 && editor.selection.isEmpty) {
			vscode.window.showInformationMessage('Select more than 1 line and try again.');
			return;
		}
		if (editor.selections.find(x => x.isEmpty)) {
			vscode.window.showInformationMessage('Select more than 1 line in each selection and try again.');
			return;
		}
	}
	const syntax = getSyntaxFromArgs({ language: editor.document.languageId });
60 61 62 63
	if (!syntax) {
		return;
	}

64 65 66 67 68 69 70 71 72 73 74 75
	const selections = editor.selections.sort((a: vscode.Selection, b: vscode.Selection) => { return a.start.compareTo(b.start); });
	let disableLivePreview = false;
	for (let i = 1; i < selections.length; i++) {
		if (selections[i].start.line === selections[i - 1].start.line
			|| selections[i].end.line === selections[i - 1].start.line
			|| selections[i].start.line === selections[i - 1].end.line
			|| selections[i].end.line === selections[i - 1].end.line) {
			disableLivePreview = true; // Disable Live Preview due to https://github.com/Microsoft/vscode/issues/49138
			break;
		}
	}

76
	let inPreview = false;
77 78
	let currentValue = '';
	const helper = getEmmetHelper();
79 80

	// Fetch general information for the succesive expansions. i.e. the ranges to replace and its contents
81
	let rangesToReplace: PreviewRangesWithContent[] = selections.map(selection => {
82
		let rangeToReplace: vscode.Range = selection.isReversed ? new vscode.Range(selection.active, selection.anchor) : selection;
83
		if (!rangeToReplace.isSingleLine && rangeToReplace.end.character === 0) {
84 85
			const previousLine = rangeToReplace.end.line - 1;
			const lastChar = editor.document.lineAt(previousLine).text.length;
86 87
			rangeToReplace = new vscode.Range(rangeToReplace.start, new vscode.Position(previousLine, lastChar));
		} else if (rangeToReplace.isEmpty) {
88 89
			const { active } = selection;
			const currentNode = getNode(rootNode, active, true);
90 91 92 93 94 95 96
			if (currentNode && (currentNode.start.line === active.line || currentNode.end.line === active.line)) {
				rangeToReplace = new vscode.Range(currentNode.start, currentNode.end);
			} else {
				rangeToReplace = new vscode.Range(rangeToReplace.start.line, 0, rangeToReplace.start.line, editor.document.lineAt(rangeToReplace.start.line).text.length);
			}
		}

97 98 99 100
		const firstLineOfSelection = editor.document.lineAt(rangeToReplace.start).text.substr(rangeToReplace.start.character);
		const matches = firstLineOfSelection.match(/^(\s*)/);
		const extraWhiteSpaceSelected = matches ? matches[1].length : 0;
		rangeToReplace = new vscode.Range(rangeToReplace.start.line, rangeToReplace.start.character + extraWhiteSpaceSelected, rangeToReplace.end.line, rangeToReplace.end.character);
101

102
		let textToWrapInPreview: string[];
103
		let textToReplace = editor.document.getText(rangeToReplace);
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
		if (individualLines) {
			textToWrapInPreview = textToReplace.split('\n').map(x => x.trim());
		} else {
			const wholeFirstLine = editor.document.lineAt(rangeToReplace.start).text;
			const otherMatches = wholeFirstLine.match(/^(\s*)/);
			const preceedingWhiteSpace = otherMatches ? otherMatches[1] : '';
			textToWrapInPreview = rangeToReplace.isSingleLine ? [textToReplace] : ['\n\t' + textToReplace.split('\n' + preceedingWhiteSpace).join('\n\t') + '\n'];
		}

		return {
			previewRange: rangeToReplace,
			originalRange: rangeToReplace,
			originalContent: textToReplace,
			textToWrapInPreview
		};
119 120
	});

121 122 123 124 125 126 127 128
	function revertPreview(): Thenable<any> {
		return editor.edit(builder => {
			for (let i = 0; i < rangesToReplace.length; i++) {
				builder.replace(rangesToReplace[i].previewRange, rangesToReplace[i].originalContent);
				rangesToReplace[i].previewRange = rangesToReplace[i].originalRange;
			}
		}, { undoStopBefore: false, undoStopAfter: false });
	}
129

130 131 132 133 134 135 136 137 138
	function applyPreview(expandAbbrList: ExpandAbbreviationInput[]): Thenable<boolean> {
		let totalLinesInserted = 0;

		return editor.edit(builder => {
			for (let i = 0; i < rangesToReplace.length; i++) {
				const expandedText = expandAbbr(expandAbbrList[i]) || '';
				if (!expandedText) {
					// Failed to expand text. We already showed an error inside expandAbbr.
					break;
139 140
				}

141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
				const oldPreviewRange = rangesToReplace[i].previewRange;
				const preceedingText = editor.document.getText(new vscode.Range(oldPreviewRange.start.line, 0, oldPreviewRange.start.line, oldPreviewRange.start.character));
				const indentPrefix = (preceedingText.match(/^(\s*)/) || ['', ''])[1];

				let newText = expandedText.replace(/\n/g, '\n' + indentPrefix); // Adding indentation on each line of expanded text
				newText = newText.replace(/\$\{[\d]*\}/g, '|'); // Removing Tabstops
				newText = newText.replace(/\$\{[\d]*(:[^}]*)?\}/g, (match) => {		// Replacing Placeholders
					return match.replace(/^\$\{[\d]*:/, '').replace('}', '');
				});
				builder.replace(oldPreviewRange, newText);

				const expandedTextLines = newText.split('\n');
				const oldPreviewLines = oldPreviewRange.end.line - oldPreviewRange.start.line + 1;
				const newLinesInserted = expandedTextLines.length - oldPreviewLines;

				let lastLineEnd = expandedTextLines[expandedTextLines.length - 1].length;
				if (expandedTextLines.length === 1) {
					// If the expandedText is single line, add the length of preceeding whitespace as it will not be included in line length.
					lastLineEnd += oldPreviewRange.start.character;
				}

				rangesToReplace[i].previewRange = new vscode.Range(oldPreviewRange.start.line + totalLinesInserted, oldPreviewRange.start.character, oldPreviewRange.end.line + totalLinesInserted + newLinesInserted, lastLineEnd);
				totalLinesInserted += newLinesInserted;
			}
		}, { undoStopBefore: false, undoStopAfter: false });
	}
167

168
	function makeChanges(inputAbbreviation: string | undefined, definitive: boolean): Thenable<boolean> {
169
		if (!inputAbbreviation || !inputAbbreviation.trim() || !helper.isAbbreviationValid(syntax, inputAbbreviation)) {
170
			return inPreview ? revertPreview().then(() => { return false; }) : Promise.resolve(inPreview);
171
		}
172 173 174

		let extractedResults = helper.extractAbbreviationFromText(inputAbbreviation);
		if (!extractedResults) {
175 176 177
			return Promise.resolve(inPreview);
		} else if (extractedResults.abbreviation !== inputAbbreviation) {
			// Not clear what should we do in this case. Warn the user? How?
178
		}
179

180 181
		let { abbreviation, filter } = extractedResults;
		if (definitive) {
182
			const revertPromise = inPreview ? revertPreview() : Promise.resolve();
183 184 185
			return revertPromise.then(() => {
				const expandAbbrList: ExpandAbbreviationInput[] = rangesToReplace.map(rangesAndContent => {
					let rangeToReplace = rangesAndContent.originalRange;
186 187 188 189 190 191 192
					let textToWrap: string[];
					if (individualLines) {
						textToWrap = rangesAndContent.textToWrapInPreview;
					} else {
						textToWrap = rangeToReplace.isSingleLine ? ['$TM_SELECTED_TEXT'] : ['\n\t$TM_SELECTED_TEXT\n'];
					}
					return { syntax: syntax || '', abbreviation, rangeToReplace, textToWrap, filter };
193
				});
194
				return expandAbbreviationInRange(editor, expandAbbrList, !individualLines).then(() => { return true; });
195 196
			});
		}
197

198
		const expandAbbrList: ExpandAbbreviationInput[] = rangesToReplace.map(rangesAndContent => {
199
			return { syntax: syntax || '', abbreviation, rangeToReplace: rangesAndContent.originalRange, textToWrap: rangesAndContent.textToWrapInPreview, filter };
200
		});
201

202
		return applyPreview(expandAbbrList);
203 204
	}

205
	function inputChanged(value: string): string {
206 207 208
		if (disableLivePreview) {
			return '';
		}
209 210 211 212 213 214
		if (value !== currentValue) {
			currentValue = value;
			makeChanges(value, false).then((out) => {
				if (typeof out === 'boolean') {
					inPreview = out;
				}
215 216
			});
		}
217
		return '';
218
	}
219
	const abbreviationPromise = (args && args['abbreviation']) ? Promise.resolve(args['abbreviation']) : vscode.window.showInputBox({ prompt: 'Enter Abbreviation', validateInput: inputChanged });
220
	return abbreviationPromise.then(inputAbbreviation => {
221
		return makeChanges(inputAbbreviation, true);
222
	});
223 224
}

225 226 227 228 229 230 231 232
export function expandEmmetAbbreviation(args: any): Thenable<boolean | undefined> {
	if (!validate() || !vscode.window.activeTextEditor) {
		return fallbackTab();
	}

	args = args || {};
	if (!args['language']) {
		args['language'] = vscode.window.activeTextEditor.document.languageId;
233 234 235 236 237
	} else {
		const excludedLanguages = vscode.workspace.getConfiguration('emmet')['excludeLanguages'] ? vscode.workspace.getConfiguration('emmet')['excludeLanguages'] : [];
		if (excludedLanguages.indexOf(vscode.window.activeTextEditor.document.languageId) > -1) {
			return fallbackTab();
		}
238
	}
239
	const syntax = getSyntaxFromArgs(args);
240
	if (!syntax) {
241
		return fallbackTab();
242
	}
243 244

	const editor = vscode.window.activeTextEditor;
245
	let rootNode: Node | undefined;
246 247
	let usePartialParsing = vscode.workspace.getConfiguration('emmet')['optimizeStylesheetParsing'] === true;
	if (editor.selections.length === 1 && isStyleSheet(editor.document.languageId) && usePartialParsing && editor.document.lineCount > 1000) {
248 249 250 251
		rootNode = parsePartialStylesheet(editor.document, editor.selection.isReversed ? editor.selection.anchor : editor.selection.active);
	} else {
		rootNode = parseDocument(editor.document, false);
	}
252

253 254 255 256 257
	// When tabbed on a non empty selection, do not treat it as an emmet abbreviation, and fallback to tab instead
	if (vscode.workspace.getConfiguration('emmet')['triggerExpansionOnTab'] === true && editor.selections.find(x => !x.isEmpty)) {
		return fallbackTab();
	}

R
Ramya Achutha Rao 已提交
258
	let abbreviationList: ExpandAbbreviationInput[] = [];
259 260
	let firstAbbreviation: string;
	let allAbbreviationsSame: boolean = true;
261
	const helper = getEmmetHelper();
262

263
	let getAbbreviation = (document: vscode.TextDocument, selection: vscode.Selection, position: vscode.Position, syntax: string): [vscode.Range | null, string, string] => {
R
Ramya Achutha Rao 已提交
264
		let rangeToReplace: vscode.Range = selection;
265
		let abbr = document.getText(rangeToReplace);
266
		if (!rangeToReplace.isEmpty) {
267
			let extractedResults = helper.extractAbbreviationFromText(abbr);
268
			if (extractedResults) {
269
				return [rangeToReplace, extractedResults.abbreviation, extractedResults.filter];
270
			}
271
			return [null, '', ''];
272 273
		}

274 275 276
		const currentLine = editor.document.lineAt(position.line).text;
		const textTillPosition = currentLine.substr(0, position.character);

277 278
		// Expand cases like <div to <div></div> explicitly
		// else we will end up with <<div></div>
279
		if (syntax === 'html') {
280 281
			let matches = textTillPosition.match(/<(\w+)$/);
			if (matches) {
282 283
				abbr = matches[1];
				rangeToReplace = new vscode.Range(position.translate(0, -(abbr.length + 1)), position);
284
				return [rangeToReplace, abbr, ''];
285
			}
286
		}
287
		let extractedResults = helper.extractAbbreviation(editor.document, position, false);
288
		if (!extractedResults) {
289
			return [null, '', ''];
290 291
		}

292 293
		let { abbreviationRange, abbreviation, filter } = extractedResults;
		return [new vscode.Range(abbreviationRange.start.line, abbreviationRange.start.character, abbreviationRange.end.line, abbreviationRange.end.character), abbreviation, filter];
294 295
	};

J
jmdowns2 已提交
296 297 298 299 300 301 302 303
	let selectionsInReverseOrder = editor.selections.slice(0);
	selectionsInReverseOrder.sort((a, b) => {
		var posA = a.isReversed ? a.anchor : a.active;
		var posB = b.isReversed ? b.anchor : b.active;
		return posA.compareTo(posB) * -1;
	});

	selectionsInReverseOrder.forEach(selection => {
304
		let position = selection.isReversed ? selection.anchor : selection.active;
305
		let [rangeToReplace, abbreviation, filter] = getAbbreviation(editor.document, selection, position, syntax);
306 307 308
		if (!rangeToReplace) {
			return;
		}
309
		if (!helper.isAbbreviationValid(syntax, abbreviation)) {
310 311
			return;
		}
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
		let currentNode = getNode(rootNode, position, true);
		let validateLocation = true;
		let syntaxToUse = syntax;

		if (editor.document.languageId === 'html') {
			if (isStyleAttribute(currentNode, position)) {
				syntaxToUse = 'css';
				validateLocation = false;
			} else {
				const embeddedCssNode = getEmbeddedCssNodeIfAny(editor.document, currentNode, position);
				if (embeddedCssNode) {
					currentNode = getNode(embeddedCssNode, position, true);
					syntaxToUse = 'css';
				}
			}
		}
328

329
		if (validateLocation && !isValidLocationForEmmetAbbreviation(editor.document, rootNode, currentNode, syntaxToUse, position, rangeToReplace)) {
330 331 332
			return;
		}

333 334 335 336
		if (!firstAbbreviation) {
			firstAbbreviation = abbreviation;
		} else if (allAbbreviationsSame && firstAbbreviation !== abbreviation) {
			allAbbreviationsSame = false;
337
		}
338

339
		abbreviationList.push({ syntax: syntaxToUse, abbreviation, rangeToReplace, filter });
340 341
	});

342 343 344 345 346
	return expandAbbreviationInRange(editor, abbreviationList, allAbbreviationsSame).then(success => {
		if (!success) {
			return fallbackTab();
		}
	});
347 348
}

349
function fallbackTab(): Thenable<boolean | undefined> {
350 351 352
	if (vscode.workspace.getConfiguration('emmet')['triggerExpansionOnTab'] === true) {
		return vscode.commands.executeCommand('tab');
	}
353
	return Promise.resolve(true);
354
}
355
/**
356 357
 * Checks if given position is a valid location to expand emmet abbreviation.
 * Works only on html and css/less/scss syntax
358
 * @param document current Text Document
359
 * @param rootNode parsed document
360
 * @param currentNode current node in the parsed document
361 362
 * @param syntax syntax of the abbreviation
 * @param position position to validate
363
 * @param abbreviationRange The range of the abbreviation for which given position is being validated
364
 */
365
export function isValidLocationForEmmetAbbreviation(document: vscode.TextDocument, rootNode: Node | undefined, currentNode: Node | null, syntax: string, position: vscode.Position, abbreviationRange: vscode.Range): boolean {
366
	if (isStyleSheet(syntax)) {
367 368 369 370
		const stylesheet = <Stylesheet>rootNode;
		if (stylesheet && (stylesheet.comments || []).some(x => position.isAfterOrEqual(x.start) && position.isBeforeOrEqual(x.end))) {
			return false;
		}
371 372 373 374 375
		// Continue validation only if the file was parse-able and the currentNode has been found
		if (!currentNode) {
			return true;
		}

376 377 378
		// Fix for https://github.com/Microsoft/vscode/issues/34162
		// Other than sass, stylus, we can make use of the terminator tokens to validate position
		if (syntax !== 'sass' && syntax !== 'stylus' && currentNode.type === 'property') {
379 380 381 382 383 384 385 386

			// Fix for upstream issue https://github.com/emmetio/css-parser/issues/3
			if (currentNode.parent
				&& currentNode.parent.type !== 'rule'
				&& currentNode.parent.type !== 'at-rule') {
				return false;
			}

387
			const abbreviation = document.getText(new vscode.Range(abbreviationRange.start.line, abbreviationRange.start.character, abbreviationRange.end.line, abbreviationRange.end.character));
388 389 390 391
			const propertyNode = <Property>currentNode;
			if (propertyNode.terminatorToken
				&& propertyNode.separator
				&& position.isAfterOrEqual(propertyNode.separatorToken.end)
392 393
				&& position.isBeforeOrEqual(propertyNode.terminatorToken.start)
				&& abbreviation.indexOf(':') === -1) {
394
				return hexColorRegex.test(abbreviation);
395 396 397
			}
			if (!propertyNode.terminatorToken
				&& propertyNode.separator
398 399
				&& position.isAfterOrEqual(propertyNode.separatorToken.end)
				&& abbreviation.indexOf(':') === -1) {
400
				return hexColorRegex.test(abbreviation);
401 402 403
			}
		}

404 405 406
		// If current node is a rule or at-rule, then perform additional checks to ensure
		// emmet suggestions are not provided in the rule selector
		if (currentNode.type !== 'rule' && currentNode.type !== 'at-rule') {
R
Ramya Achutha Rao 已提交
407 408
			return true;
		}
409

R
Ramya Achutha Rao 已提交
410
		const currentCssNode = <Rule>currentNode;
411

412 413 414 415 416
		// Position is valid if it occurs after the `{` that marks beginning of rule contents
		if (position.isAfter(currentCssNode.contentStartToken.end)) {
			return true;
		}

417
		// Workaround for https://github.com/Microsoft/vscode/30188
418 419
		// The line above the rule selector is considered as part of the selector by the css-parser
		// But we should assume it is a valid location for css properties under the parent rule
420
		if (currentCssNode.parent
421
			&& (currentCssNode.parent.type === 'rule' || currentCssNode.parent.type === 'at-rule')
422
			&& currentCssNode.selectorToken
423 424 425 426
			&& position.line !== currentCssNode.selectorToken.end.line
			&& currentCssNode.selectorToken.start.character === abbreviationRange.start.character
			&& currentCssNode.selectorToken.start.line === abbreviationRange.start.line
		) {
427 428 429
			return true;
		}

430
		return false;
431 432
	}

433 434 435
	const startAngle = '<';
	const endAngle = '>';
	const escape = '\\';
436
	const question = '?';
R
Ramya Achutha Rao 已提交
437
	const currentHtmlNode = <HtmlNode>currentNode;
438
	let start = new vscode.Position(0, 0);
439

440
	if (currentHtmlNode) {
441 442 443 444 445 446
		if (currentHtmlNode.name === 'script') {
			return (currentHtmlNode.attributes
				&& currentHtmlNode.attributes.some(x => x.name.toString() === 'type'
					&& allowedMimeTypesInScriptTag.indexOf(x.value.toString()) > -1));
		}

447
		const innerRange = getInnerRange(currentHtmlNode);
448

449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
		// Fix for https://github.com/Microsoft/vscode/issues/28829
		if (!innerRange || !innerRange.contains(position)) {
			return false;
		}

		// Fix for https://github.com/Microsoft/vscode/issues/35128
		// Find the position up till where we will backtrack looking for unescaped < or >
		// to decide if current position is valid for emmet expansion
		start = innerRange.start;
		let lastChildBeforePosition = currentHtmlNode.firstChild;
		while (lastChildBeforePosition) {
			if (lastChildBeforePosition.end.isAfter(position)) {
				break;
			}
			start = lastChildBeforePosition.end;
			lastChildBeforePosition = lastChildBeforePosition.nextSibling;
465 466
		}
	}
467
	let textToBackTrack = document.getText(new vscode.Range(start.line, start.character, abbreviationRange.start.line, abbreviationRange.start.character));
468 469 470 471 472 473 474

	// Worse case scenario is when cursor is inside a big chunk of text which needs to backtracked
	// Backtrack only 500 offsets to ensure we dont waste time doing this
	if (textToBackTrack.length > 500) {
		textToBackTrack = textToBackTrack.substr(textToBackTrack.length - 500);
	}

475 476 477 478
	if (!textToBackTrack.trim()) {
		return true;
	}

479 480 481
	let valid = true;
	let foundSpace = false; // If < is found before finding whitespace, then its valid abbreviation. Eg: <div|
	let i = textToBackTrack.length - 1;
R
Ramya Achutha Rao 已提交
482 483 484 485
	if (textToBackTrack[i] === startAngle) {
		return false;
	}

486 487 488 489 490 491 492
	while (i >= 0) {
		const char = textToBackTrack[i];
		i--;
		if (!foundSpace && /\s/.test(char)) {
			foundSpace = true;
			continue;
		}
493 494 495 496
		if (char === question && textToBackTrack[i] === startAngle) {
			i--;
			continue;
		}
497 498 499 500 501 502 503 504 505 506 507 508 509 510
		if (char !== startAngle && char !== endAngle) {
			continue;
		}
		if (i >= 0 && textToBackTrack[i] === escape) {
			i--;
			continue;
		}
		if (char === endAngle) {
			break;
		}
		if (char === startAngle) {
			valid = !foundSpace;
			break;
		}
511 512
	}

513
	return valid;
R
Ramya Achutha Rao 已提交
514 515
}

516 517
/**
 * Expands abbreviations as detailed in expandAbbrList in the editor
518 519 520
 * @param editor
 * @param expandAbbrList
 * @param insertSameSnippet
521
 * @returns false if no snippet can be inserted.
522
 */
523
function expandAbbreviationInRange(editor: vscode.TextEditor, expandAbbrList: ExpandAbbreviationInput[], insertSameSnippet: boolean): Thenable<boolean> {
R
Ramya Achutha Rao 已提交
524
	if (!expandAbbrList || expandAbbrList.length === 0) {
525
		return Promise.resolve(false);
R
Ramya Achutha Rao 已提交
526 527 528 529 530
	}

	// Snippet to replace at multiple cursors are not the same
	// `editor.insertSnippet` will have to be called for each instance separately
	// We will not be able to maintain multiple cursors after snippet insertion
531
	let insertPromises: Thenable<boolean>[] = [];
R
Ramya Achutha Rao 已提交
532
	if (!insertSameSnippet) {
533
		expandAbbrList.sort((a: ExpandAbbreviationInput, b: ExpandAbbreviationInput) => { return b.rangeToReplace.start.compareTo(a.rangeToReplace.start); }).forEach((expandAbbrInput: ExpandAbbreviationInput) => {
534
			let expandedText = expandAbbr(expandAbbrInput);
R
Ramya Achutha Rao 已提交
535
			if (expandedText) {
536
				insertPromises.push(editor.insertSnippet(new vscode.SnippetString(expandedText), expandAbbrInput.rangeToReplace, { undoStopBefore: false, undoStopAfter: false }));
R
Ramya Achutha Rao 已提交
537 538
			}
		});
539 540 541
		if (insertPromises.length === 0) {
			return Promise.resolve(false);
		}
542
		return Promise.all(insertPromises).then(() => Promise.resolve(true));
R
Ramya Achutha Rao 已提交
543 544 545
	}

	// Snippet to replace at all cursors are the same
546
	// We can pass all ranges to `editor.insertSnippet` in a single call so that
R
Ramya Achutha Rao 已提交
547 548
	// all cursors are maintained after snippet insertion
	const anyExpandAbbrInput = expandAbbrList[0];
549
	let expandedText = expandAbbr(anyExpandAbbrInput);
R
Ramya Achutha Rao 已提交
550
	let allRanges = expandAbbrList.map(value => {
551
		return new vscode.Range(value.rangeToReplace.start.line, value.rangeToReplace.start.character, value.rangeToReplace.end.line, value.rangeToReplace.end.character);
R
Ramya Achutha Rao 已提交
552 553
	});
	if (expandedText) {
554
		return editor.insertSnippet(new vscode.SnippetString(expandedText), allRanges);
R
Ramya Achutha Rao 已提交
555
	}
556
	return Promise.resolve(false);
557 558
}

559
/**
560
 * Expands abbreviation as detailed in given input.
561
 */
562
function expandAbbr(input: ExpandAbbreviationInput): string | undefined {
563 564
	const helper = getEmmetHelper();
	const expandOptions = helper.getExpandOptions(input.syntax, getEmmetConfiguration(input.syntax), input.filter);
565

566
	if (input.textToWrap) {
567
		if (input.filter && input.filter.indexOf('t') > -1) {
568 569 570 571
			input.textToWrap = input.textToWrap.map(line => {
				return line.replace(trimRegex, '').trim();
			});
		}
572 573 574 575 576 577 578 579
		expandOptions['text'] = input.textToWrap;

		// Below fixes https://github.com/Microsoft/vscode/issues/29898
		// With this, Emmet formats inline elements as block elements
		// ensuring the wrapped multi line text does not get merged to a single line
		if (!input.rangeToReplace.isSingleLine) {
			expandOptions.profile['inlineBreak'] = 1;
		}
580 581
	}

582
	try {
583
		// Expand the abbreviation
584
		let expandedText;
585

586
		if (input.textToWrap) {
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
			let parsedAbbr = helper.parseAbbreviation(input.abbreviation, expandOptions);
			if (input.rangeToReplace.isSingleLine && input.textToWrap.length === 1) {

				// Fetch rightmost element in the parsed abbreviation (i.e the element that will contain the wrapped text).
				let wrappingNode = parsedAbbr;
				while (wrappingNode && wrappingNode.children && wrappingNode.children.length > 0) {
					wrappingNode = wrappingNode.children[wrappingNode.children.length - 1];
				}

				// If wrapping with a block element, insert newline in the text to wrap.
				if (wrappingNode && inlineElements.indexOf(wrappingNode.name) === -1) {
					wrappingNode.value = '\n\t' + wrappingNode.value + '\n';
				}
			}
			expandedText = helper.expandAbbreviation(parsedAbbr, expandOptions);
602 603 604
			// All $anyword would have been escaped by the emmet helper.
			// Remove the escaping backslash from $TM_SELECTED_TEXT so that VS Code Snippet controller can treat it as a variable
			expandedText = expandedText.replace('\\$TM_SELECTED_TEXT', '$TM_SELECTED_TEXT');
605 606
		} else {
			expandedText = helper.expandAbbreviation(input.abbreviation, expandOptions);
607
		}
608

609 610
		return expandedText;

611 612
	} catch (e) {
		vscode.window.showErrorMessage('Failed to expand abbreviation');
613 614 615
	}


616 617
}

618
function getSyntaxFromArgs(args: Object): string | undefined {
619
	const mappedModes = getMappingForIncludedLanguages();
620 621 622 623 624 625 626
	const language: string = args['language'];
	const parentMode: string = args['parentMode'];
	const excludedLanguages = vscode.workspace.getConfiguration('emmet')['excludeLanguages'] ? vscode.workspace.getConfiguration('emmet')['excludeLanguages'] : [];
	if (excludedLanguages.indexOf(language) > -1) {
		return;
	}

627
	let syntax = getEmmetMode((mappedModes[language] ? mappedModes[language] : language), excludedLanguages);
628 629
	if (!syntax) {
		syntax = getEmmetMode((mappedModes[parentMode] ? mappedModes[parentMode] : parentMode), excludedLanguages);
630 631
	}

632
	return syntax;
633
}