vscode-texinfo/src/folding.ts

/**
 * folding.ts
 * 
 * @author CismonX <admin@cismon.net>
 * @license MIT
 */

import * as vscode from 'vscode';
import Document from './document';

/**
 * Provide folding range info for Texinfo documents.
 */
export class FoldingRangeProvider implements vscode.FoldingRangeProvider {

    provideFoldingRanges(document: vscode.TextDocument) {
        return Document.of(document).foldingRange.values;
    }
}

/**
 * Stores information about folding ranges for a document.
 */
export class FoldingRangeContext {

    /**
     * Get VSCode folding ranges from the context.
     */
    get values() {
        return this.foldingRanges ?? (this.foldingRanges = this.calculateFoldingRanges());
    }

    private foldingRanges?: FoldingRange[];

    private commentRange?: { start: number, end: number };

    private headerStart?: number;

    /**
     * Update folding range context based on document change event.
     * 
     * @param events Events describing the changes in the document.
     */
    update(events: readonly vscode.TextDocumentContentChangeEvent[]) {
        if (this.foldingRanges === undefined) return false;
        for (const event of events) {
            const updatedLines = event.text.split(this.document.eol === vscode.EndOfLine.LF ? '\n' : '\r\n').length;
            // Clear cached folding range when line count changes.
            if (updatedLines !== 1 || event.range.start.line !== event.range.end.line) {
                this.foldingRanges = undefined;
                return true;
            }
        }
        return false;
    }

    /**
     * Calculate and update folding ranges for the document.
     * 
     * @param start Starting line number.
     * @param end Ending line number.
     */
    private calculateFoldingRanges() {
        this.foldingRanges = [];
        this.headerStart = undefined;
        const closingBlocks = <{ name: string, line: number }[]>[];
        let verbatim = false;
        for (let idx = this.document.lineCount - 1; idx >= 0; --idx) {
            const line = this.document.lineAt(idx).text;
            if (!line.startsWith('@')) continue;
            if (!verbatim) {
                if (line === '@bye') {
                    // Abort anything after `@bye`.
                    this.foldingRanges = [];
                    this.commentRange = undefined;
                    this.headerStart = undefined;
                    continue;
                }
                if (this.processComment(line, idx)) continue;
            }
            // Process block.
            if (line.startsWith('@end ')) {
                if (verbatim) continue;
                const name = line.substring(5);
                name === 'verbatim' && (verbatim = true);
                closingBlocks.push({ name: name, line: idx });
            } else {
                const closingBlock = closingBlocks.pop();
                if (closingBlock === undefined) continue;
                if (line.substring(1, closingBlock.name.length + 2).trim() === closingBlock.name) {
                    this.addRange(idx, closingBlock.line, { name: closingBlock.name });
                    // If `verbatim == true` goes here, this line must be the `@verbatim` line.
                    verbatim = false;
                } else {
                    closingBlocks.push(closingBlock);
                }
            }
        }
        return this.foldingRanges;
    }

    private processComment(lineText: string, lineNum: number) {
        if (lineText.startsWith('@c')) {
            if (!lineText.startsWith(' ', 2) && !lineText.startsWith('omment ', 2)) return false;
            // Check for opening/closing header.
            if (lineText.startsWith('%**', lineText[2] === ' ' ? 3 : 9)) {
                if (this.headerStart === undefined) {
                    this.headerStart = lineNum;
                } else {
                    this.addRange(lineNum, this.headerStart, { kind: vscode.FoldingRangeKind.Region });
                    this.headerStart = undefined;
                }
                return true;
            }
            if (this.commentRange === undefined) {
                this.commentRange = { start: lineNum, end: lineNum };
            } else if (this.commentRange.start - 1 === lineNum) {
                this.commentRange.start = lineNum;
            }
            return true;
        } else if (this.commentRange !== undefined) {
            this.addRange(this.commentRange.start, this.commentRange.end, { kind: vscode.FoldingRangeKind.Comment });
            this.commentRange = undefined;
        }
        return false;
    }

    private addRange(start: number, end: number, extraArgs: { name?: string, kind?: vscode.FoldingRangeKind }) {
        (this.foldingRanges ??= []).push(new FoldingRange(extraArgs.name ?? '', start, end, extraArgs.kind));
    }

    constructor(private readonly document: vscode.TextDocument) {}
}

/**
 * VSCode folding range with name.
 */
export class FoldingRange extends vscode.FoldingRange {

    constructor(readonly name: string, start: number, end: number, kind?: vscode.FoldingRangeKind) {
        super(start, end, kind);
    }
}