Merge pull request #19 from fasfsfgs/refactoring-special-forms

Add support for previous unsupported special forms

Author: avli

src/clojureSignature.ts

@@ -8,9 +8,15 @@ import * as cljParser from './cljParser';
 const PARAMETER_OPEN = `[`;
 const PARAMETER_CLOSE = `]`;
 const PARAMETER_REST = `&`;
-const UNSUPPORTED_SIGNATURE_NAMES = ['.', 'new', 'fn', 'set!']; // they have forms that do not follow the same rules as other special forms
 const SPECIAL_FORM_PARAMETER_REST = `*`;
 
+const SPECIAL_FORM_CUSTOM_ARGLISTS: Map<string, string> = new Map<string, string>([
+    [`fn`, `([name? params exprs*] [name? & [params & expr]])`],
+    [`set!`, `([var-symbol expr] [[. instance-expr instanceFieldName-symbol] expr] [[. Classname-symbol staticFieldName-symbol] expr])`],
+    [`.`, `([instance instanceMember args*] [Classname instanceMember args*] [instance -instanceField] [Classname staticMethod args*] [. Classname staticField])`],
+    [`new`, `([Classname args*])`],
+]);
+
 export class ClojureSignatureProvider extends ClojureProvider implements vscode.SignatureHelpProvider {
 
     provideSignatureHelp(document: vscode.TextDocument, position: vscode.Position, token: vscode.CancellationToken): Thenable<vscode.SignatureHelp> {
@@ -37,39 +43,38 @@ export class ClojureSignatureProvider extends ClojureProvider implements vscode.
 }
 
 function getSpecialFormSignatureHelp(info: any, parameterPosition: number): vscode.SignatureHelp {
-    if (UNSUPPORTED_SIGNATURE_NAMES.indexOf(info.name) > -1) {
-        const signatureHelp = new vscode.SignatureHelp();
-        signatureHelp.signatures = [new vscode.SignatureInformation(`${info.name} *special form* ${info['forms-str']}`, info.doc)];
-        signatureHelp.activeSignature = 0;
+    const signatureLabel = `*special form* ${info.name}`;
 
-        return signatureHelp;
+    let arglists = SPECIAL_FORM_CUSTOM_ARGLISTS.get(info.name);
+    if (!arglists) {
+        const forms: string = info['forms-str'];
+        const [functionName, ...parameters] = forms.substring(3, forms.length - 1).split(' ');
+        arglists = `([${parameters.join(' ')}])`;
     }
 
-    const forms: string = info['forms-str'];
-    const [functionName, ...parameters] = forms.substring(3, forms.length - 1).split(' ');
-    const parameterInfos = parameters.map(parameter => new vscode.ParameterInformation(parameter));
-
-    const sigInfo = new vscode.SignatureInformation(`${info.name} *special form* [${parameterInfos.map(pi => pi.label).join(`\n`)}]`, info.doc);
-    sigInfo.parameters = parameterInfos;
-
-    if (parameterPosition + 1 > sigInfo.parameters.length && sigInfo.parameters[sigInfo.parameters.length - 1].label.endsWith(SPECIAL_FORM_PARAMETER_REST))
-        parameterPosition = sigInfo.parameters.length - 1;
+    return getSignatureHelp(signatureLabel, info.doc, arglists, parameterPosition);
+}
 
-    const signatureHelp = new vscode.SignatureHelp();
-    signatureHelp.signatures = [sigInfo];
-    signatureHelp.activeParameter = parameterPosition;
-    signatureHelp.activeSignature = 0;
+function getFunctionSignatureHelp(info: any, parameterPosition: number): vscode.SignatureHelp {
+    const arglists = info['arglists-str'];
+    if (!arglists)
+        return;
 
-    return signatureHelp;
+    const signatureLabel = `${info.ns}/${info.name}`;
+    return getSignatureHelp(signatureLabel, info.doc, arglists, parameterPosition);
 }
 
-function getFunctionSignatureHelp(info: any, parameterPosition: number): vscode.SignatureHelp {
-    const signatures = getFunctionSignatureInfos(info);
+function getSignatureHelp(signatureLabel: string, signatureDoc: string, arglists: string, parameterPosition: number): vscode.SignatureHelp {
+    const signatures = getSignatureInfos(signatureLabel, signatureDoc, arglists);
     signatures.sort((sig1, sig2) => sig1.parameters.length - sig2.parameters.length);
 
     let activeSignature = signatures.findIndex(signature => signature.parameters.length >= parameterPosition + 1);
     if (activeSignature === -1) {
         activeSignature = signatures.findIndex(signature => signature.parameters.some(param => param.label.startsWith(PARAMETER_REST)));
+
+        if (activeSignature === -1)
+            activeSignature = signatures.findIndex(signature => signature.parameters.slice(-1)[0].label.endsWith(SPECIAL_FORM_PARAMETER_REST));
+
         if (activeSignature !== -1)
             parameterPosition = signatures[activeSignature].parameters.length - 1;
     }
@@ -84,9 +89,7 @@ function getFunctionSignatureHelp(info: any, parameterPosition: number): vscode.
     return signatureHelp;
 }
 
-function getFunctionSignatureInfos(info: any): vscode.SignatureInformation[] {
-    const arglists: string = info['arglists-str'];
-
+function getSignatureInfos(signatureLabel: string, signatureDoc: string, arglists: string): vscode.SignatureInformation[] {
     const sigParamStarts: number[] = [];
     const sigParamStops: number[] = [];
     let nestingLevel = 0;
@@ -106,15 +109,15 @@ function getFunctionSignatureInfos(info: any): vscode.SignatureInformation[] {
     return sigParamStarts
         .map((sigParamStart, index) => arglists.substring(sigParamStart, sigParamStops[index] + 1))
         .map(signatureParameter => {
-            const parameterInfos = getFunctionParameterInfos(signatureParameter);
-            const sigInfo = new vscode.SignatureInformation(`${info.ns}/${info.name} [${parameterInfos.map(pi => pi.label).join(`\n`)}]`);
-            sigInfo.documentation = info.doc;
+            const parameterInfos = getParameterInfos(signatureParameter);
+            const sigInfo = new vscode.SignatureInformation(`${signatureLabel} [${parameterInfos.map(pi => pi.label).join(`\n`)}]`);
+            sigInfo.documentation = signatureDoc;
             sigInfo.parameters = parameterInfos;
             return sigInfo;
         });
 }
 
-function getFunctionParameterInfos(signatureParameter: string): vscode.ParameterInformation[] {
+function getParameterInfos(signatureParameter: string): vscode.ParameterInformation[] {
     signatureParameter = signatureParameter.substring(1, signatureParameter.length - 1); // removing external brackets
     const paramStarts: number[] = [];
     const paramStops: number[] = [];