perlnavigator-server/src/signatures.ts

Perl language server

import { TextDocumentPositionParams, SignatureHelp, SignatureInformation, ParameterInformation } from "vscode-languageserver/node";
import { TextDocument, Position } from "vscode-languageserver-textdocument";
import { ElemSource, ParseType, PerlDocument, PerlElem, PerlSymbolKind } from "./types";
import { lookupSymbol } from "./utils";
import { parseFromUri } from "./parser";
import { refineElementIfSub } from "./refinement";

export async function getSignature(
    params: TextDocumentPositionParams,
    perlDoc: PerlDocument,
    txtDoc: TextDocument,
    modMap: Map<string, string>
): Promise<SignatureHelp | undefined> {
    let position = params.position;
    const [symbol, currentSig] = getFunction(position, txtDoc);
    if (!symbol) return;
    const elems = lookupSymbol(perlDoc, modMap, symbol, position.line);
    // Nothing or too many things.
    if (elems.length != 1) return;
    let elem = elems[0];
    const refined = await refineElementIfSub(elem, params, perlDoc);
    if (!refined) return;
    // const elem_count = perlDoc.elems.size; // Currently unused.
    return buildSignature(refined, currentSig, symbol);
}

function getFunction(position: Position, txtDoc: TextDocument): string[] {
    const start = { line: position.line, character: 0 };
    const end = { line: position.line + 1, character: 0 };
    const text = txtDoc.getText({ start, end });
    const index = txtDoc.offsetAt(position) - txtDoc.offsetAt(start);
    let r = index; // right
    // Find signature.
    for (; r > 1 && text[r] != "("; --r) {
        if (r > 0 && text[r - 1] == ")") return []; // Sig closes
    }
    if (r <= 1) return [];
    let l = r - 1; // left
    const canShift = (c: string) => /[\w\:\>\-]/.exec(c);
    for (; l >= 0 && canShift(text[l]); --l)
        // Allow for ->, but not => or > (e.g. $foo->bar, but not $foo=>bar or $foo>bar).
        if (text[l] == ">") if (l - 1 >= 0 && text[l - 1] != "-") break;
        
    if (l < 0 || text[l] != "$" && text[l] != "@" && text[l] != "%") ++l;

    let symbol = text.substring(l, r);
    const currSig = text.substring(r, index);

    const prefix = text.substring(0, l);

    if (symbol.match(/^->\w+$/)) { 
        // If you have Foo::Bar->new(...)->func, the extracted symbol will be ->func
        // We can special case this to Foo::Bar->func. The regex allows arguments to new(), including params with matched ()
        let match = prefix.match(/(\w(?:\w|::\w)*)->new\((?:\([^()]*\)|[^()])*\)$/);

        if (match) symbol = match[1] + symbol;
    }

    return [symbol, currSig];
}

function buildSignature(elem: PerlElem, currentSig: string, symbol: string): SignatureHelp | undefined {
    let params = elem.signature;
    if (!params) return;
    params = [...params]; // Clone to ensure we don't modify the original
    let activeParameter = (currentSig.match(/,/g) || []).length;
    if (symbol.indexOf("->") != -1 && elem.type != PerlSymbolKind.LocalMethod) {
        // Subroutine vs method is not relevant, only matters if you called it as a method (except Corinna, for which $self is implicit)
        params.shift();
        // function_name = function_name.replace(/::(\w+)$/, '->$1');
    }
    if (params.length == 0) return;
    let paramLabels: ParameterInformation[] = [];
    for (const param of params) paramLabels.push({ label: param });
    let mainSig: SignatureInformation = {
        parameters: paramLabels,
        label: "(" + params.join(", ") + ")",
    };
    let sig: SignatureHelp = {
        signatures: [mainSig],
        activeSignature: 0,
        activeParameter: activeParameter,
    };
    return sig;
}