Added SignatureHelp support.

Author: ezolotko

src/Client/Clients/TextDocumentClient.SignatureHelp.cs

@@ -0,0 +1,66 @@
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using OmniSharp.Extensions.LanguageServer.Client.Utilities;
+using OmniSharp.Extensions.LanguageServer.Protocol;
+using OmniSharp.Extensions.LanguageServer.Protocol.Models;
+
+namespace OmniSharp.Extensions.LanguageServer.Client.Clients
+{
+    /// <summary>
+    ///     Client for the LSP Text Document API.
+    /// </summary>
+    public partial class TextDocumentClient
+    {
+        /// <summary>
+        ///     Request signature help at the specified document position.
+        /// </summary>
+        /// <param name="filePath">
+        ///     The full file-system path of the text document.
+        /// </param>
+        /// <param name="line">
+        ///     The target line (0-based).
+        /// </param>
+        /// <param name="column">
+        ///     The target column (0-based).
+        /// </param>
+        /// <param name="cancellationToken">
+        ///     An optional <see cref="CancellationToken"/> that can be used to cancel the request.
+        /// </param>
+        /// <returns>
+        ///     A <see cref="Task{TResult}"/> that resolves to the completions or <c>null</c> if no completions are available at the specified position.
+        /// </returns>
+        public Task<SignatureHelp> SignatureHelp(string filePath, int line, int column, CancellationToken cancellationToken = default(CancellationToken))
+        {
+            if (string.IsNullOrWhiteSpace(filePath))
+                throw new ArgumentException($"Argument cannot be null, empty, or entirely composed of whitespace: {nameof(filePath)}.", nameof(filePath));
+
+            var documentUri = DocumentUri.FromFileSystemPath(filePath);
+
+            return SignatureHelp(documentUri, line, column, cancellationToken);
+        }
+
+        /// <summary>
+        ///     Request signature help at the specified document position.
+        /// </summary>
+        /// <param name="documentUri">
+        ///     The document URI.
+        /// </param>
+        /// <param name="line">
+        ///     The target line (0-based).
+        /// </param>
+        /// <param name="column">
+        ///     The target column (0-based).
+        /// </param>
+        /// <param name="cancellationToken">
+        ///     An optional <see cref="CancellationToken"/> that can be used to cancel the request.
+        /// </param>
+        /// <returns>
+        ///     A <see cref="Task{TResult}"/> that resolves to the completions or <c>null</c> if no completions are available at the specified position.
+        /// </returns>
+        public Task<SignatureHelp> SignatureHelp(Uri documentUri, int line, int column, CancellationToken cancellationToken = default(CancellationToken))
+        {
+            return PositionalRequest<SignatureHelp>(DocumentNames.SignatureHelp, documentUri, line, column, cancellationToken);
+        }
+    }
+}

test/Client.Tests/ClientTests.cs

@@ -191,6 +191,73 @@ public async Task Completions_Success()
             });
         }
 
+        /// <summary>
+        ///     Ensure that the language client can successfully request SignatureHelp.
+        /// </summary>
+        [Fact(DisplayName = "Language client can successfully request signature help", Skip = "Periodic failures")]
+        public async Task SignatureHelp_Success()
+        {
+            await Connect();
+
+            const int line = 5;
+            const int column = 5;
+            var expectedDocumentPath = AbsoluteDocumentPath;
+            var expectedDocumentUri = DocumentUri.FromFileSystemPath(expectedDocumentPath);
+
+            var expectedSignatureHelp = new SignatureHelp {
+                ActiveParameter = 0,
+                ActiveSignature = 0,
+                Signatures = new[] {
+                    new SignatureInformation {
+                        Documentation = new StringOrMarkupContent("test documentation"),
+                        Label = "TestSignature",
+                        Parameters = new[] {
+                            new ParameterInformation {
+                                Documentation = "test parameter documentation",
+                                Label = "parameter label"
+                            }
+                        }
+                    }
+                }
+            };
+
+            ServerDispatcher.HandleRequest<TextDocumentPositionParams, SignatureHelp>(DocumentNames.SignatureHelp, (request, cancellationToken) => {
+                Assert.NotNull(request.TextDocument);
+
+                Assert.Equal(expectedDocumentUri, request.TextDocument.Uri);
+
+                Assert.Equal(line, request.Position.Line);
+                Assert.Equal(column, request.Position.Character);
+
+                return Task.FromResult(expectedSignatureHelp);
+            });
+
+            var actualSignatureHelp = await LanguageClient.TextDocument.SignatureHelp(AbsoluteDocumentPath, line, column);
+
+            Assert.Equal(expectedSignatureHelp.ActiveParameter, actualSignatureHelp.ActiveParameter);
+            Assert.Equal(expectedSignatureHelp.ActiveSignature, actualSignatureHelp.ActiveSignature);
+
+            var actualSignatures = actualSignatureHelp.Signatures.ToArray();
+            Assert.Collection(actualSignatures, actualSignature => {
+                var expectedSignature = expectedSignatureHelp.Signatures.ToArray()[0];
+
+                Assert.True(actualSignature.Documentation.HasString);
+                Assert.Equal(expectedSignature.Documentation.String, actualSignature.Documentation.String);
+
+                Assert.Equal(expectedSignature.Label, actualSignature.Label);
+
+                var expectedParameters = expectedSignature.Parameters.ToArray();
+                var actualParameters = actualSignature.Parameters.ToArray();
+
+                Assert.Collection(actualParameters, actualParameter => {
+                    var expectedParameter = expectedParameters[0];
+                    Assert.True(actualParameter.Documentation.HasString);
+                    Assert.Equal(expectedParameter.Documentation.String, actualParameter.Documentation.String);
+                    Assert.Equal(expectedParameter.Label, actualParameter.Label);
+                });
+            });
+        }
+
         /// <summary>
         ///     Ensure that the language client can successfully receive Diagnostics from the server.
         /// </summary>