Merge pull request #1623 from mokchira/switch-source-header

Switch source header

Author: mergify[bot]

docs/bundle.js.map

@@ -5476,6 +5476,20 @@ <h3 class="panel-title"><a name="/definitions/SubcommandResponse"></a>Subcommand
 
                                                     </div>
                                                 </dd>
+                                                <dt data-property-name="file_only">
+                                                    <span class="json-property-name">file_only:</span>
+                                                    
+                                                    <span class="json-property-type">boolean</span>
+                                                    <span class="json-property-range" title="Value limits"></span>
+                                                    
+                                                </dt>
+                                                <dd>
+                                                    <p>If present, the line_num and column_num can be ignored.</p>
+                                    
+                                                    <div class="json-inner-schema">
+                                                        
+                                                    </div>
+                                                </dd>
                                                 <dt data-property-name="extra_data">
                                                     <span class="json-property-name">extra_data:</span>
 

docs/index.html

@@ -372,6 +372,10 @@ definitions:
         $ref: "#/definitions/LineNumber"
       column_num:
         $ref: "#/definitions/ColumnNumber"
+      file_only:
+        type: boolean
+        description: |-
+          If present, the line_num and column_num can be ignored.
       extra_data:
         type: object
         description: |-

docs/main.css.map

@@ -301,6 +301,9 @@ def GetCustomSubcommands( self ):
       'GetDocImprecise': (
         lambda self, request_data, args: self.GetDoc( request_data )
       ),
+      'GoToAlternateFile': (
+        lambda self, request_data, args: self.GoToAlternateFile( request_data )
+      ),
       # To handle the commands below we need extensions to LSP. One way to
       # provide those could be to use workspace/executeCommand requset.
       # 'GetParent': (
@@ -309,6 +312,27 @@ def GetCustomSubcommands( self ):
     }
 
 
+  def GoToAlternateFile( self, request_data ):
+    request_id = self.GetConnection().NextRequestId()
+    uri = lsp.FilePathToUri( request_data[ 'filepath' ] )
+    request  = lsp.BuildRequest( request_id,
+                                 "textDocument/switchSourceHeader",
+                                 { "uri": uri } )
+    response = self.GetConnection().GetResponse(
+            request_id,
+            request,
+            language_server_completer.REQUEST_TIMEOUT_COMMAND )
+    filepath = lsp.UriToFilePath( response[ 'result' ] )
+    # We don't have a specific location in the file we need to go to so
+    # we just arbitrarily choose line 1, column 1. The client can choose
+    # to ignore them.
+    return responses.BuildGoToResponse( filepath,
+                                        1,
+                                        1,
+                                        description = filepath,
+                                        file_only = True )
+
+
   def ShouldCompleteIncludeStatement( self, request_data ):
     column_codepoint = request_data[ 'column_codepoint' ] - 1
     current_line = request_data[ 'line_value' ]

docs/openapi.yml

@@ -67,19 +67,26 @@ def __init__( self ):
 
 
 # column_num is a byte offset
-def BuildGoToResponse( filepath, line_num, column_num, description = None ):
+def BuildGoToResponse( filepath,
+                       line_num,
+                       column_num,
+                       description = None,
+                       file_only = False ):
   return BuildGoToResponseFromLocation(
     Location( line = line_num,
               column = column_num,
               filename = filepath ),
-    description )
+    description, file_only )
 
 
-def BuildGoToResponseFromLocation( location, description = None ):
+def BuildGoToResponseFromLocation( location,
+                                   description = None,
+                                   file_only = False ):
   """Build a GoTo response from a responses.Location object."""
   response = BuildLocationData( location )
   if description:
     response[ 'description' ] = description
+  response[ 'file_only' ] = file_only
   return response
 
 

ycmd/completers/cpp/clangd_completer.py

@@ -56,6 +56,7 @@ def RunGoToTest_all( app, filename, command, test ):
   }
   common_response = {
     'filepath': os.path.abspath( PathToTestFile( filename ) ),
+    'file_only': False,
   }
 
   if 'extra_conf' in test:
@@ -103,6 +104,7 @@ def RunGoToIncludeTest( app, command, test ):
     'filepath'   : PathToTestFile( 'test-include', test[ 'response' ] ),
     'line_num'   : 1,
     'column_num' : 1,
+    'file_only'  : False,
   }
 
   actual_response = app.post_json( '/run_completer_command', goto_data ).json

ycmd/responses.py

@@ -594,7 +594,8 @@ def test_Subcommands_DefinedSubcommands( self, app ):
                                                'GoToSymbol',
                                                'GoToType',
                                                'RefactorRename',
-                                               'RestartServer' ] ) )
+                                               'RestartServer',
+                                               'GoToAlternateFile' ] ) )
         },
         'route': '/defined_subcommands',
     } )
@@ -757,6 +758,16 @@ def test_Subcommands_GoToInclude( self, app ):
       with self.subTest( test = test, cmd = cmd ):
         RunGoToTest_all( app, 'test-include', cmd, test )
 
+  @SharedYcmd
+  def test_Subcommands_GoToAlternateFile( self, app ):
+    for test in [
+            { 'req': ( 'go-to-alternate-file/a.cpp', 1, 1 ),
+              'res': ( 'go-to-alternate-file/a.h', 1, 1 ) },
+            { 'req': ( 'go-to-alternate-file/a.h', 1, 1 ),
+              'res': ( 'go-to-alternate-file/a.cpp', 1, 1 ) },
+    ]:
+      with self.subTest( test = test ):
+        RunGoToTest_all( app, '', 'GoToAlternateFile', test )
 
   @SharedYcmd
   def test_Subcommands_GoToReferences( self, app ):

ycmd/tests/clang/subcommands_test.py

@@ -0,0 +1,5 @@
+#include "a.h"
+
+void foo()
+{
+}

ycmd/tests/clangd/subcommands_test.py

@@ -0,0 +1 @@
+void foo();