Preliminary type/call hierarchy support

Author: bstaletic

ycmd/__main__.py

@@ -194,6 +194,8 @@ def Main():
                                     args.stderr,
                                     args.keep_logfiles )
   atexit.register( handlers.ServerCleanup )
+  from bottle import TemplatePlugin
+  handlers.app.uninstall(TemplatePlugin)
   handlers.app.install( WatchdogPlugin( args.idle_suicide_seconds,
                                         args.check_interval_seconds ) )
   handlers.app.install( HmacPlugin( hmac_secret ) )

ycmd/completers/language_server/language_server_completer.py

@@ -1785,6 +1785,18 @@ def GetSubcommandsMap( self ):
         lambda self, request_data, args: self.GetType( request_data )
       )
 
+    if ( self._server_capabilities and
+         _IsCapabilityProvided( self._server_capabilities,
+                                'typeHierarchyProvider' ) ):
+      commands[ 'TypeHierarchy' ] = (
+        lambda self, request_data, args:
+            self.InitialHierarchy( request_data, [ 'type' ] )
+      )
+      commands[ 'ResolveTypeHierarchyItem' ] = (
+        lambda self, request_data, args:
+            self.Hierarchy( request_data, [ *args, 'type' ] )
+      )
+
     if ( self._server_capabilities and
          _IsCapabilityProvided( self._server_capabilities,
                                 'callHierarchyProvider' ) ):
@@ -1796,6 +1808,14 @@ def GetSubcommandsMap( self ):
         lambda self, request_data, args:
             self.CallHierarchy( request_data, [ 'incoming' ] )
       )
+      commands[ 'CallHierarchy' ] = (
+        lambda self, request_data, args:
+            self.InitialHierarchy( request_data, [ 'call' ] )
+      )
+      commands[ 'ResolveCallHierarchyItem' ] = (
+        lambda self, request_data, args:
+            self.Hierarchy( request_data, [ *args, 'call' ] )
+      )
 
     commands.update( self.GetCustomSubcommands() )
 
@@ -2643,14 +2663,90 @@ def GoToDocumentOutline( self, request_data ):
     return _SymbolInfoListToGoTo( request_data, result )
 
 
+  def InitialHierarchy( self, request_data, args ):
+    if not self.ServerIsReady():
+      raise RuntimeError( 'Server is initializing. Please wait.' )
+
+    kind = args[ 0 ]
+
+    self._UpdateServerWithFileContents( request_data )
+    request_id = self.GetConnection().NextRequestId()
+    message = lsp.PrepareHierarchy( request_id, request_data, kind.title() )
+    prepare_response = self.GetConnection().GetResponse(
+        request_id,
+        message,
+        REQUEST_TIMEOUT_COMMAND )
+    preparation_item = prepare_response.get( 'result' ) or []
+    if not preparation_item:
+      raise RuntimeError( f'No { kind } hierarchy found.' )
+
+    assert len( preparation_item ) == 1, (
+             'Not available: Multiple hierarchies were received, '
+             'this is not currently supported.' )
+
+    preparation_item[ 0 ][ 'locations' ] = [
+      responses.BuildGoToResponseFromLocation(
+        *_LspLocationToLocationAndDescription( request_data, location ) )
+      for location in preparation_item ]
+    preparation_item[ 0 ][ 'kind' ] = lsp.SYMBOL_KIND[ preparation_item[ 0 ][ 'kind' ] ]
+    return preparation_item
+
+
+  def Hierarchy( self, request_data, args ):
+    if not self.ServerIsReady():
+      raise RuntimeError( 'Server is initializing. Please wait.' )
+
+    preparation_item, direction, kind = args
+
+    # Remove ycmd things
+    if 'fromRanges' in preparation_item:
+      name_and_kind_key = 'to' if direction == 'outgoing' else 'from'
+      preparation_item = preparation_item[ name_and_kind_key ]
+    else:
+      del preparation_item[ 'locations' ]
+      preparation_item[ 'kind' ] = lsp.SYMBOL_KIND.index( preparation_item[ 'kind' ] )
+
+    if kind == 'call':
+      direction += 'Calls'
+    self._UpdateServerWithFileContents( request_data )
+    request_id = self.GetConnection().NextRequestId()
+    message = lsp.Hierarchy( request_id, kind, direction, preparation_item )
+    response = self.GetConnection().GetResponse( request_id,
+                                                 message,
+                                                 REQUEST_TIMEOUT_COMMAND )
+
+    result = response.get( 'result' )
+    if result:
+      for item in result:
+        if kind == 'call':
+          name_and_kind_key = 'to' if direction == 'outgoing' else 'from'
+          item[ 'kind' ] = lsp.SYMBOL_KIND[ item[ name_and_kind_key ][ 'kind' ] ]
+          item[ 'name' ] = item[ name_and_kind_key ][ 'name' ]
+          lsp_locations = [ {
+            'uri': item[ name_and_kind_key ][ 'uri' ],
+            'range': r }
+            for r in item[ 'fromRanges' ] ]
+          item[ 'locations' ] = [
+            responses.BuildGoToResponseFromLocation(
+              *_LspLocationToLocationAndDescription( request_data, location ) )
+            for location in lsp_locations ]
+        else:
+          item[ 'kind' ] = lsp.SYMBOL_KIND[ item[ 'kind' ] ]
+          item[ 'locations' ] = [
+            responses.BuildGoToResponseFromLocation(
+              *_LspLocationToLocationAndDescription( request_data, location ) )
+            for location in [ item ] ]
+      return result
+    raise RuntimeError( f'No { direction } { kind } found.' )
+
 
   def CallHierarchy( self, request_data, args ):
     if not self.ServerIsReady():
       raise RuntimeError( 'Server is initializing. Please wait.' )
 
     self._UpdateServerWithFileContents( request_data )
     request_id = self.GetConnection().NextRequestId()
-    message = lsp.PrepareCallHierarchy( request_id, request_data )
+    message = lsp.PrepareHierarchy( request_id, request_data, 'Call' )
     prepare_response = self.GetConnection().GetResponse(
         request_id,
         message,
@@ -2666,7 +2762,10 @@ def CallHierarchy( self, request_data, args ):
     preparation_item = preparation_item[ 0 ]
 
     request_id = self.GetConnection().NextRequestId()
-    message = lsp.CallHierarchy( request_id, args[ 0 ], preparation_item )
+    message = lsp.Hierarchy( request_id,
+                             'call',
+                             args[ 0 ] + 'Calls',
+                             preparation_item )
     response = self.GetConnection().GetResponse( request_id,
                                                  message,
                                                  REQUEST_TIMEOUT_COMMAND )

ycmd/completers/language_server/language_server_protocol.py

@@ -633,8 +633,8 @@ def Position( line_num, line_value, column_codepoint ):
   }
 
 
-def PrepareCallHierarchy( request_id, request_data ):
-  return BuildRequest( request_id, 'textDocument/prepareCallHierarchy', {
+def PrepareHierarchy( request_id, request_data, kind ):
+  return BuildRequest( request_id, f'textDocument/prepare{ kind }Hierarchy', {
     'textDocument': {
       'uri': FilePathToUri( request_data[ 'filepath' ] ),
     },
@@ -644,8 +644,8 @@ def PrepareCallHierarchy( request_id, request_data ):
   } )
 
 
-def CallHierarchy( request_id, direction, item ):
-  return BuildRequest( request_id, f'callHierarchy/{ direction }Calls', {
+def Hierarchy( request_id, kind, direction, item ):
+  return BuildRequest( request_id, f'{ kind }Hierarchy/{ direction }', {
     'item': item
   } )