/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ import { Token } from 'markdown-it'; import * as vscode from 'vscode'; import { MarkdownEngine } from '../markdownEngine'; import { TableOfContentsProvider, TocEntry } from '../tableOfContentsProvider'; export default class MarkdownSmartSelect implements vscode.SelectionRangeProvider { constructor( private readonly engine: MarkdownEngine ) { } public async provideSelectionRanges(document: vscode.TextDocument, positions: vscode.Position[], _token: vscode.CancellationToken): Promise { let promises = await Promise.all(positions.map((position) => { return this.provideSelectionRange(document, position, _token); })); return promises.filter(item => item !== undefined) as vscode.SelectionRange[]; } private async provideSelectionRange(document: vscode.TextDocument, position: vscode.Position, _token: vscode.CancellationToken): Promise { const headerRange = await this.getHeaderSelectionRange(document, position); const blockRange = await this.getBlockSelectionRange(document, position, headerRange); return blockRange ? blockRange : headerRange ? headerRange : undefined; } private async getBlockSelectionRange(document: vscode.TextDocument, position: vscode.Position, headerRange?: vscode.SelectionRange): Promise { const tokens = await this.engine.parse(document); let blockTokens = getTokensForPosition(tokens, position); if (blockTokens.length === 0) { return undefined; } let parentRange = headerRange ? headerRange : createBlockRange(document, position.line, blockTokens.shift()); let currentRange: vscode.SelectionRange | undefined; for (const token of blockTokens) { currentRange = createBlockRange(document, position.line, token, parentRange); if (currentRange) { parentRange = currentRange; } } if (currentRange) { return currentRange; } else { return parentRange; } } private async getHeaderSelectionRange(document: vscode.TextDocument, position: vscode.Position): Promise { const tocProvider = new TableOfContentsProvider(this.engine, document); const toc = await tocProvider.getToc(); let headerInfo = getHeadersForPosition(toc, position); let headers = headerInfo.headers; let parentRange: vscode.SelectionRange | undefined; let currentRange: vscode.SelectionRange | undefined; for (let i = 0; i < headers.length; i++) { currentRange = createHeaderRange(i === headers.length - 1, headerInfo.headerOnThisLine, headers[i], parentRange, getFirstChildHeader(document, headers[i], toc)); if (currentRange && currentRange.parent) { parentRange = currentRange; } } return currentRange; } } function getFirstChildHeader(document: vscode.TextDocument, header?: TocEntry, toc?: TocEntry[]): vscode.Position | undefined { let childRange: vscode.Position | undefined; if (header && toc) { let children = toc.filter(t => header.location.range.contains(t.location.range) && t.location.range.start.line > header.location.range.start.line).sort((t1, t2) => t1.line - t2.line); if (children.length > 0) { childRange = children[0].location.range.start; let lineText = document.lineAt(childRange.line - 1).text; return childRange ? childRange.translate(-1, lineText.length) : undefined; } } return undefined; } function getTokensForPosition(tokens: Token[], position: vscode.Position): Token[] { let enclosingTokens = tokens.filter(token => token.map && (token.map[0] <= position.line && token.map[1] > position.line) && isBlockElement(token)); if (enclosingTokens.length === 0) { return []; } let sortedTokens = enclosingTokens.sort((token1, token2) => (token2.map[1] - token2.map[0]) - (token1.map[1] - token1.map[0])); return sortedTokens; } function getHeadersForPosition(toc: TocEntry[], position: vscode.Position): { headers: TocEntry[], headerOnThisLine: boolean } { let enclosingHeaders = toc.filter(header => header.location.range.start.line <= position.line && header.location.range.end.line >= position.line); let sortedHeaders = enclosingHeaders.sort((header1, header2) => (header1.line - position.line) - (header2.line - position.line)); let onThisLine = toc.find(header => header.line === position.line) !== undefined; return { headers: sortedHeaders, headerOnThisLine: onThisLine }; } function isBlockElement(token: Token): boolean { return !['list_item_close', 'paragraph_close', 'bullet_list_close', 'inline', 'heading_close', 'heading_open'].includes(token.type); } function createHeaderRange(isClosestHeaderToPosition: boolean, onHeaderLine: boolean, header?: TocEntry, parent?: vscode.SelectionRange, childStart?: vscode.Position): vscode.SelectionRange | undefined { if (header) { let contentRange = new vscode.Range(header.location.range.start.translate(1), header.location.range.end); let headerPlusContentRange = header.location.range; let partialContentRange = childStart && isClosestHeaderToPosition ? contentRange.with(undefined, childStart) : undefined; if (onHeaderLine && isClosestHeaderToPosition && childStart) { return new vscode.SelectionRange(header.location.range.with(undefined, childStart), new vscode.SelectionRange(header.location.range, parent)); } else if (onHeaderLine && isClosestHeaderToPosition) { return new vscode.SelectionRange(header.location.range, parent); } else if (parent && parent.range.contains(headerPlusContentRange)) { if (partialContentRange) { return new vscode.SelectionRange(partialContentRange, new vscode.SelectionRange(contentRange, (new vscode.SelectionRange(headerPlusContentRange, parent)))); } else { return new vscode.SelectionRange(contentRange, new vscode.SelectionRange(headerPlusContentRange, parent)); } } else if (partialContentRange) { return new vscode.SelectionRange(partialContentRange, new vscode.SelectionRange(contentRange, (new vscode.SelectionRange(headerPlusContentRange)))); } else { return new vscode.SelectionRange(contentRange, new vscode.SelectionRange(headerPlusContentRange)); } } else { return undefined; } } function createBlockRange(document: vscode.TextDocument, cursorLine: number, block?: Token, parent?: vscode.SelectionRange): vscode.SelectionRange | undefined { if (block) { if (block.type === 'fence') { return createFencedRange(block, cursorLine, document, parent); } else { let startLine = document.lineAt(block.map[0]).isEmptyOrWhitespace ? block.map[0] + 1 : block.map[0]; let endLine = startLine !== block.map[1] && isList(block.type) ? block.map[1] - 1 : block.map[1]; let startPos = new vscode.Position(startLine, 0); let endPos = new vscode.Position(endLine, getEndCharacter(document, startLine, endLine)); let range = new vscode.Range(startPos, endPos); if (parent && parent.range.contains(range) && !parent.range.isEqual(range)) { return new vscode.SelectionRange(range, parent); } else if (parent) { if (rangeLinesEqual(range, parent.range)) { return range.end.character > parent.range.end.character ? new vscode.SelectionRange(range) : parent; } else if (parent.range.end.line + 1 === range.end.line) { let adjustedRange = new vscode.Range(range.start, range.end.translate(-1, parent.range.end.character)); if (adjustedRange.isEqual(parent.range)) { return parent; } else { return new vscode.SelectionRange(adjustedRange, parent); } } else if (parent.range.end.line === range.end.line) { let adjustedRange = new vscode.Range(parent.range.start, range.end.translate(undefined, parent.range.end.character)); if (adjustedRange.isEqual(parent.range)) { return parent; } else { return new vscode.SelectionRange(adjustedRange, parent.parent); } } else { return parent; } } else { return new vscode.SelectionRange(range); } } } else { return undefined; } } function createFencedRange(token: Token, cursorLine: number, document: vscode.TextDocument, parent?: vscode.SelectionRange): vscode.SelectionRange { const startLine = token.map[0]; const endLine = token.map[1] - 1; let onFenceLine = cursorLine === startLine || cursorLine === endLine; let fenceRange = new vscode.Range(new vscode.Position(startLine, 0), new vscode.Position(endLine, document.lineAt(endLine).text.length)); let contentRange = endLine - startLine > 2 && !onFenceLine ? new vscode.Range(new vscode.Position(startLine + 1, 0), new vscode.Position(endLine - 1, getEndCharacter(document, startLine + 1, endLine))) : undefined; if (parent && contentRange) { if (parent.range.contains(fenceRange) && !parent.range.isEqual(fenceRange)) { return new vscode.SelectionRange(contentRange, new vscode.SelectionRange(fenceRange, parent)); } else if (parent.range.isEqual(fenceRange)) { return new vscode.SelectionRange(contentRange, parent); } else if (rangeLinesEqual(fenceRange, parent.range)) { let revisedRange = fenceRange.end.character > parent.range.end.character ? fenceRange : parent.range; return new vscode.SelectionRange(contentRange, new vscode.SelectionRange(revisedRange, getRealParent(parent, revisedRange))); } else if (parent.range.end.line === fenceRange.end.line) { parent.range.end.translate(undefined, fenceRange.end.character); return new vscode.SelectionRange(contentRange, new vscode.SelectionRange(fenceRange, parent)); } } else if (contentRange) { return new vscode.SelectionRange(contentRange, new vscode.SelectionRange(fenceRange)); } else if (parent) { if (parent.range.contains(fenceRange) && !parent.range.isEqual(fenceRange)) { return new vscode.SelectionRange(fenceRange, parent); } else if (parent.range.isEqual(fenceRange)) { return parent; } else if (rangeLinesEqual(fenceRange, parent.range)) { let revisedRange = fenceRange.end.character > parent.range.end.character ? fenceRange : parent.range; return new vscode.SelectionRange(revisedRange, parent.parent); } else if (parent.range.end.line === fenceRange.end.line) { parent.range.end.translate(undefined, fenceRange.end.character); return new vscode.SelectionRange(fenceRange, parent); } } return new vscode.SelectionRange(fenceRange, parent); } function isList(type: string): boolean { return type ? ['ordered_list_open', 'list_item_open', 'bullet_list_open'].includes(type) : false; } function getEndCharacter(document: vscode.TextDocument, startLine: number, endLine: number): number { let startLength = document.lineAt(startLine).text ? document.lineAt(startLine).text.length : 0; let endLength = document.lineAt(startLine).text ? document.lineAt(startLine).text.length : 0; let endChar = Math.max(startLength, endLength); return startLine !== endLine ? 0 : endChar; } function getRealParent(parent: vscode.SelectionRange, range: vscode.Range) { let currentParent: vscode.SelectionRange | undefined = parent; while (currentParent && !currentParent.range.contains(range)) { currentParent = currentParent.parent; } return currentParent; } function rangeLinesEqual(range: vscode.Range, parent: vscode.Range) { return range.start.line === parent.start.line && range.end.line === parent.end.line; }