diff --git a/src/services/services.ts b/src/services/services.ts index 449fab183ca..a5e5e62b21a 100644 --- a/src/services/services.ts +++ b/src/services/services.ts @@ -661,6 +661,8 @@ module ts { getSignatureHelpItems(fileName: string, position: number): SignatureHelpItems; getSignatureHelpCurrentArgumentState(fileName: string, position: number, applicableSpanStart: number): SignatureHelpState; + getSignatureAtPosition(fileName: string, position: number): SignatureInfo; + getRenameInfo(fileName: string, position: number): RenameInfo; getDefinitionAtPosition(fileName: string, position: number): DefinitionInfo[]; getReferencesAtPosition(fileName: string, position: number): ReferenceEntry[]; @@ -686,6 +688,42 @@ module ts { dispose(): void; } + export interface SignatureInfo { + actual: ActualSignatureInfo; + formal: FormalSignatureItemInfo[]; // Formal signatures + activeFormal: number; // Index of the "best match" formal signature + } + + export interface FormalSignatureItemInfo { + signatureInfo: string; + typeParameters: FormalTypeParameterInfo[]; + parameters: FormalParameterInfo[]; // Array of parameters + docComment: string; // Help for the signature + } + + export interface FormalTypeParameterInfo { + name: string; // Type parameter name + docComment: string; // Comments that contain help for the parameter + minChar: number; // minChar for parameter info in the formal signature info string + limChar: number; // lim char for parameter info in the formal signature info string + } + + export interface FormalParameterInfo { + name: string; // Parameter name + isVariable: boolean; // true if parameter is var args + docComment: string; // Comments that contain help for the parameter + minChar: number; // minChar for parameter info in the formal signature info string + limChar: number; // lim char for parameter info in the formal signature info string + } + + export interface ActualSignatureInfo { + parameterMinChar: number; + parameterLimChar: number; + currentParameterIsTypeParameter: boolean; // current parameter is a type argument or a normal argument + currentParameter: number; // Index of active parameter in "parameters" or "typeParamters" array + } + + export class ClassificationTypeNames { public static comment = "comment"; public static identifier = "identifier"; @@ -3748,6 +3786,67 @@ module ts { return SignatureHelp.getSignatureHelpCurrentArgumentState(sourceFile, position, applicableSpanStart); } + function getSignatureAtPosition(filename: string, position: number): SignatureInfo { + var signatureHelpItems = getSignatureHelpItems(filename, position); + + if (!signatureHelpItems) { + return undefined; + } + + var currentArguemntState = getSignatureHelpCurrentArgumentState(filename, position, signatureHelpItems.applicableSpan.start()); + + var formalSignatures: FormalSignatureItemInfo[] = []; + forEach(signatureHelpItems.items, signature=> { + var signatureInfoString = signature.prefix; + + var paramters: FormalParameterInfo[] = []; + for (var i = 0, n = signature.parameters.length; i < n; i++) { + var paramter = signature.parameters[i]; + + // add the parameter to the string + if (i) { + signatureInfoString += signature.separator; + } + var start = signatureInfoString.length; + signatureInfoString += paramter.display; + var end = signatureInfoString.length - 1; + + // add the parameter to the list + paramters.push({ + name: paramter.name, + isVariable: i == n -1 && signature.isVariadic, + docComment: paramter.documentation, + minChar: start, + limChar: end + }); + + } + + signatureInfoString += signature.suffix; + + formalSignatures.push({ + signatureInfo: signatureInfoString, + docComment: signature.documentation, + parameters: paramters, + typeParameters: [], + docComments: signature.documentation + }); + }); + + var actualSignature: ActualSignatureInfo = { + parameterMinChar: 0, + parameterLimChar: 0, + currentParameterIsTypeParameter: false, + currentParameter: currentArguemntState.argumentIndex + }; + + return { + actual: actualSignature, + formal: formalSignatures, + activeFormal: 0 + }; + } + /// Syntactic features function getSyntaxTree(filename: string): TypeScript.SyntaxTree { filename = TypeScript.switchToForwardSlashes(filename); @@ -4364,6 +4463,7 @@ module ts { getFormattingEditsForDocument: getFormattingEditsForDocument, getFormattingEditsAfterKeystroke: getFormattingEditsAfterKeystroke, getEmitOutput: getEmitOutput, + getSignatureAtPosition: getSignatureAtPosition, }; } diff --git a/src/services/shims.ts b/src/services/shims.ts index 0418a6da6cc..23d46a18545 100644 --- a/src/services/shims.ts +++ b/src/services/shims.ts @@ -96,6 +96,8 @@ module ts { getSignatureHelpItems(fileName: string, position: number): string; getSignatureHelpCurrentArgumentState(fileName: string, position: number, applicableSpanStart: number): string; + getSignatureAtPosition(fileName: string, position: number): string; + // Returns a JSON encoded value of the type: // { canRename: boolean, localizedErrorMessage: string, displayName: string, fullDisplayName: string, kind: string, kindModifiers: string, triggerSpan: { start; length } } getRenameInfo(fileName: string, position: number): string; @@ -604,6 +606,13 @@ module ts { }); } + public getSignatureAtPosition(fileName: string, position: number): string { + return this.forwardJSONCall( + "getSignatureAtPosition('" + fileName + "', " + position + ")", + () => { + return this.languageService.getSignatureAtPosition(fileName, position); + }); + } /// GOTO DEFINITION /// Computes the definition location and file for the symbol