Add support for GetDoc in C#

LSP OmniSharp-Roslyn uses a different request than we previously have for
this purposes.

This results in some questionable formatting, but there's no way we can
fix that without breaking other stuff.

Author: bstaletic

ycmd/completers/cs/cs_completer.py

@@ -99,9 +99,28 @@ def SupportedFiletypes( self ):
 
 
   def GetType( self, request_data ):
-    raw_hover = self.GetHoverResponse( request_data )
-    value = raw_hover[ 'value' ]
-    if not value:
+    hover_value = self.GetHoverResponse( request_data )[ 'value' ]
+    if not hover_value:
       raise RuntimeError( 'No type found.' )
-    value = value.split( '\n' )[ 1 ]
-    return responses.BuildDetailedInfoResponse( value )
+    value = hover_value.split( '\n', maxsplit = 2 )[ 1 ]
+    return responses.BuildDisplayMessageResponse( value )
+
+
+  def GetDoc( self, request_data ):
+    hover_value = self.GetHoverResponse( request_data )[ 'value' ]
+    if not hover_value:
+      raise RuntimeError( 'No documentation available.' )
+    # The response looks like this:
+    #
+    # ```csharp
+    # type info
+    # ```
+    #
+    # docstring
+    #
+    # The idea is to get rid of silly markdown backticks.
+    lines = hover_value.splitlines()
+    del lines[ 2 ]
+    del lines[ 0 ]
+    result = '\n'.join( lines )
+    return responses.BuildDetailedInfoResponse( result )

ycmd/tests/cs/subcommands_test.py

@@ -499,7 +499,7 @@ def test_Subcommands_GetType_VariableDeclaration( self, app ):
                                  filepath = filepath )
 
     response = app.post_json( '/run_completer_command', gettype_data ).json
-    assert_that( response, has_entry( 'detailed_info',
+    assert_that( response, has_entry( 'message',
                                       '(local variable) string str' ) )
 
 
@@ -517,7 +517,7 @@ def test_Subcommands_GetType_VariableUsage( self, app ):
                                  filepath = filepath )
 
     response = app.post_json( '/run_completer_command', gettype_data ).json
-    assert_that( response, has_entry( 'detailed_info',
+    assert_that( response, has_entry( 'message',
                                       '(local variable) string str' ) )
 
 
@@ -536,7 +536,68 @@ def test_Subcommands_GetType_DocsIgnored( self, app ):
 
     response = app.post_json( '/run_completer_command', gettype_data ).json
     assert_that( response, has_entry(
-      'detailed_info', '(field) int GetTypeTestCase.an_int_with_docs' ) )
+      'message', '(field) int GetTypeTestCase.an_int_with_docs' ) )
+
+
+  @SharedYcmd
+  def test_Subcommands_GetDoc_Invalid( self, app ):
+    filepath = PathToTestFile( 'testy', 'GetDocTestCase.cs' )
+    contents = ReadFile( filepath )
+
+    getdoc_data = BuildRequest( completer_target = 'filetype_default',
+                                command_arguments = [ 'GetDoc' ],
+                                line_num = 1,
+                                column_num = 1,
+                                contents = contents,
+                                filetype = 'cs',
+                                filepath = filepath )
+
+    response = app.post_json( '/run_completer_command',
+                              getdoc_data,
+                              expect_errors = True ).json
+    assert_that( response, ErrorMatcher( RuntimeError,
+                                         'No documentation available.' ) )
+
+
+  @SharedYcmd
+  def test_Subcommands_GetDoc_Variable( self, app ):
+    filepath = PathToTestFile( 'testy', 'GetDocTestCase.cs' )
+    contents = ReadFile( filepath )
+
+    getdoc_data = BuildRequest( completer_target = 'filetype_default',
+                                command_arguments = [ 'GetDoc' ],
+                                line_num = 13,
+                                column_num = 28,
+                                contents = contents,
+                                filetype = 'cs',
+                                filepath = filepath )
+
+    response = app.post_json( '/run_completer_command', getdoc_data ).json
+    assert_that( response,
+                 has_entry( 'detailed_info',
+                            '(field) int GetDocTestCase.an_int\n\n'
+                            'an integer, or something' ) )
+
+
+  @SharedYcmd
+  def test_Subcommands_GetDoc_Function( self, app ):
+    filepath = PathToTestFile( 'testy', 'GetDocTestCase.cs' )
+    contents = ReadFile( filepath )
+
+    getdoc_data = BuildRequest( completer_target = 'filetype_default',
+                                command_arguments = [ 'GetDoc' ],
+                                line_num = 37,
+                                column_num = 27,
+                                contents = contents,
+                                filetype = 'cs',
+                                filepath = filepath )
+
+    response = app.post_json( '/run_completer_command', getdoc_data ).json
+    # And here LSP OmniSharp-Roslyn messes up the formatting.
+    assert_that( response, has_entry( 'detailed_info',
+      'int GetDocTestCase.DoATest()\n\n'
+      'Very important method\\. With multiple lines of '
+      'commentary And Format\\- \\-ting' ) )
 
 
   @IsolatedYcmd()

ycmd/tests/cs/testdata/testy/GetDocTestCase.cs

@@ -1,33 +1,37 @@
-/**
- * testy is a namespace for testing
- */
+/// <summary>
+/// testy is a namespace for testing
+/// </summary>
 namespace testy {
-        /**
-         * Tests the GetDoc subcommands
-         */
+	/// <summary>
+        /// Tests the GetDoc subcommands
+	/// </summary>
 	public class GetDocTestCase {
-                /**
-                 * Constructor
-                 */
+		/// <summary>
+                /// Constructor
+		/// </summary>
 		public GetDocTestCase() {
                     this.an_int = 1;
 		}
 
-                /**
-                 * Very important method.
-                 *
-                 * With multiple lines of commentary
-                 *     And Format-
-                 * -ting
-                 */
+		/// <summary>
+                /// Very important method.
+                ///
+                /// With multiple lines of commentary
+                ///     And Format-
+                /// -ting
+		/// </summary>
                 public int DoATest() {
                     return an_int;
                 }
 
+		/// <summary>
                 /// an integer, or something
+		/// </summary>
                 private int an_int;
 
+		/// <summary>
                 /// Use this for testing
+		/// </summary>
                 private static void DoTesting() {
                     GetDocTestCase tc;
                     tc.DoATest();