cismonx
/
vscode-texinfo
1
0
Fork 0
Code Issues Pull Requests Projects Releases 6 Wiki Activity

Implement folding range container

This commit is contained in:
CismonX 2020-10-15 06:08:10 +08:00
parent d66287c8e5
commit f46c16f9ce
Signed by: cismonx
GPG Key ID: 3094873E29A482FB
3 changed files with 119 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
package-lock.json generated
View File

@ -61,11 +61,6 @@
"strip-json-comments": "^3.1.1"
}
},
"@flatten-js/interval-tree": {
"version": "1.0.12",
"resolved": "https://registry.npmjs.org/@flatten-js/interval-tree/-/interval-tree-1.0.12.tgz",
"integrity": "sha512-j2o14WdFPII5cI57j0XNSWQm80gM4G6RT5+NLaH8q7KmQKejR/qZiGiViMjRgMtPiiwaX6hv3hlXeyRL3yzi7g=="
},
"@types/eslint-visitor-keys": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/@types/eslint-visitor-keys/-/eslint-visitor-keys-1.0.0.tgz",

1
package.json
View File

@ -25,7 +25,6 @@
"typescript": "^4.0.3"
},
"dependencies": {
"@flatten-js/interval-tree": "^1.0.12",
"node-html-parser": "^1.3.1"
},
"scripts": {

148
src/folding.ts
View File

@ -5,7 +5,6 @@
* @license MIT
*/
import IntervalTree from '@flatten-js/interval-tree';
import * as vscode from 'vscode';
/**
@ -14,46 +13,73 @@ import * as vscode from 'vscode';
export class FoldingRangeProvider implements vscode.FoldingRangeProvider {
provideFoldingRanges(document: vscode.TextDocument) {
return FoldingRangeContext.get(document).foldingRanges;
return FoldingRangeContext.get(document)?.foldingRanges;
}
}
/**
* Stores information about folding ranges for a document.
*/
export class FoldingRangeContext {
private static readonly map = new Map<vscode.TextDocument, FoldingRangeContext>();
/**
* Initialize folding range context for a document.
*
* @param document
*/
static open(document: vscode.TextDocument) {
if (document.languageId === 'texinfo') {
new FoldingRangeContext(document);
}
}
/**
* Get existing folding range context of a document.
*
* @param document
*/
static get(document: vscode.TextDocument) {
return FoldingRangeContext.map.get(document) ?? new FoldingRangeContext(document);
return FoldingRangeContext.map.get(document);
}
/**
* Update the folding range context of a document based on its change event.
*
* @param event Change event of a document.
*/
static update(event: vscode.TextDocumentChangeEvent) {
if (event.document.languageId !== 'texinfo') {
return;
}
FoldingRangeContext.get(event.document).update(event.contentChanges);
FoldingRangeContext.get(event.document)?.update(event.contentChanges);
}
/**
* Destroy the folding range context of a document.
*
* @param document
*/
static close(document: vscode.TextDocument) {
FoldingRangeContext.map.delete(document);
}
/**
* Destroy all existing folding range contexts.
*/
static clear() {
FoldingRangeContext.map.clear();
}
get foldingRanges(): vscode.FoldingRange[] {
return this.tempFoldingRanges ?? (this.tempFoldingRanges = this.intervalTree.values);
/**
* Get VSCode folding ranges from the context.
*/
get foldingRanges() {
return this.ranges.values;
}
private intervalTree = new IntervalTree();
private tempFoldingRanges?: vscode.FoldingRange[];
private readonly ranges = new FoldingRangeContainer();
private commentRange?: [number, number];
@ -64,12 +90,18 @@ export class FoldingRangeContext {
private constructor(private readonly document: vscode.TextDocument) {
FoldingRangeContext.map.set(document, this);
console.log(Date.now());
this.calculateFoldingRanges();
this.updateFoldingRanges(0, this.document.lineCount - 1);
console.log(Date.now());
}
private calculateFoldingRanges() {
for (let idx = this.document.lineCount - 1; idx >= 0; --idx) {
/**
* Calculate and update folding ranges for the document.
*
* @param start Starting line number.
* @param end Ending line number.
*/
private updateFoldingRanges(start: number, end: number) {
for (let idx = end; idx >= start; --idx) {
const line = this.document.lineAt(idx);
const lineText = line.text;
const lineNum = line.lineNumber;
@ -83,7 +115,7 @@ export class FoldingRangeContext {
}
if (this.commentRange !== undefined) {
if (this.commentRange[1] - this.commentRange[0] > 1) {
this.insertRange(this.commentRange);
this.ranges.insert(this.commentRange[0], this.commentRange[1]);
}
}
}
@ -98,16 +130,17 @@ export class FoldingRangeContext {
if (this.headerStart === undefined) {
this.headerStart = lineNum;
} else {
this.insertRange([lineNum, this.headerStart]);
this.ranges.insert(lineNum, this.headerStart);
this.headerStart = undefined;
}
return true;
}
if (this.commentRange === undefined) {
this.commentRange = [lineNum, lineNum];
} else if (this.commentRange[0] - 1 === lineNum) {
this.commentRange[0] = lineNum;
} else {
this.insertRange(this.commentRange, vscode.FoldingRangeKind.Comment);
this.ranges.insert(this.commentRange[0], this.commentRange[1], vscode.FoldingRangeKind.Comment);
this.commentRange = [lineNum, lineNum];
}
return true;
@ -124,29 +157,16 @@ export class FoldingRangeContext {
return;
}
if (lineText.substring(1, closingBlock.name.length + 2).trim() === closingBlock.name) {
this.insertRange([lineNum, closingBlock.line]);
this.ranges.insert(lineNum, closingBlock.line);
} else {
this.closingBlocks.push(closingBlock);
}
}
}
private insertRange(range: [start: number, end: number], kind?: vscode.FoldingRangeKind) {
const foldingRange = new vscode.FoldingRange(range[0], range[1], kind);
this.intervalTree.insert(range, foldingRange);
}
private update(events: readonly vscode.TextDocumentContentChangeEvent[]) {
console.log(events);
}
private clear() {
this.intervalTree = new IntervalTree();
this.tempFoldingRanges = undefined;
this.commentRange = undefined;
this.headerStart = undefined;
this.closingBlocks = [];
}
}
/**
@ -164,3 +184,73 @@ interface ClosingBlock {
*/
line: number;
}
/**
* Container which stores multiple ranges.
*
* Used for incremental calculation of VSCode folding ranges to prevent full rescan on edit,
* which could be catastrophic when dealing with large documents.
*/
class FoldingRangeContainer {
private nodes = <FoldingRangeNode[]>[];
private bufferedValues?: vscode.FoldingRange[];
/**
* Insert a new range to the container.
*
* The new range **SHOULD NOT** overlap with existing ranges.
*
* @param start Start of range.
* @param end End of range
* @param kind Type of VSCode folding range.
*/
insert(start: number, end: number, kind?: vscode.FoldingRangeKind) {
if (this.nodes.length < end) {
this.nodes.push(...Array.from({ length: end - this.nodes.length + 1 }, () => new FoldingRangeNode()));
}
this.bufferedValues = undefined;
this.nodes[start].end = end;
this.nodes[start].kind = kind;
this.nodes[end].start = start;
this.nodes[end].kind = kind;
}
/**
* Get VSCode folding ranges from the container.
*/
get values() {
if (this.bufferedValues !== undefined) {
return this.bufferedValues;
}
const values = <vscode.FoldingRange[]>[];
this.nodes.forEach((node, idx) => {
if (node.end !== undefined) {
values.push(new vscode.FoldingRange(idx, node.end, node.kind));
}
});
return (this.bufferedValues = values);
}
}
/**
* Node of a folding range which represents a line in the document.
*/
class FoldingRangeNode {
/**
* Corresponding start node index.
*/
start?: number;
/**
* Corresponding end node index.
*/
end?: number;
/**
* Type of VSCode folding range.
*/
kind?: vscode.FoldingRangeKind;
}