134b06b65e
Vim's QuickFix lists require 1-based columns, which is what is returned from ycmd's commands. As noted in the comments, the Vim documentation for setqflist is somewhat vague about this "byte offset", but it is confirmed to mean "1-based column number" both in testing and in :help getqflist.
148 lines
4.9 KiB
Python
148 lines
4.9 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# Copyright (C) 2013 Google Inc.
|
|
#
|
|
# This file is part of YouCompleteMe.
|
|
#
|
|
# YouCompleteMe is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# YouCompleteMe is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with YouCompleteMe. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
import vim
|
|
from ycm.client.base_request import BaseRequest, BuildRequestData, ServerError
|
|
from ycm import vimsupport
|
|
from ycmd.utils import ToUtf8IfNeeded
|
|
|
|
|
|
def _EnsureBackwardsCompatibility( arguments ):
|
|
if arguments and arguments[ 0 ] == 'GoToDefinitionElseDeclaration':
|
|
arguments[ 0 ] = 'GoTo'
|
|
return arguments
|
|
|
|
|
|
class CommandRequest( BaseRequest ):
|
|
def __init__( self, arguments, completer_target = None ):
|
|
super( CommandRequest, self ).__init__()
|
|
self._arguments = _EnsureBackwardsCompatibility( arguments )
|
|
self._completer_target = ( completer_target if completer_target
|
|
else 'filetype_default' )
|
|
self._is_goto_command = (
|
|
self._arguments and self._arguments[ 0 ].startswith( 'GoTo' ) )
|
|
self._is_fixit_command = (
|
|
self._arguments and self._arguments[ 0 ].startswith( 'FixIt' ) )
|
|
self._response = None
|
|
|
|
|
|
def Start( self ):
|
|
request_data = BuildRequestData()
|
|
request_data.update( {
|
|
'completer_target': self._completer_target,
|
|
'command_arguments': self._arguments
|
|
} )
|
|
try:
|
|
self._response = self.PostDataToHandler( request_data,
|
|
'run_completer_command' )
|
|
except ServerError as e:
|
|
vimsupport.PostMultiLineNotice( e )
|
|
|
|
|
|
def Response( self ):
|
|
return self._response
|
|
|
|
|
|
def RunPostCommandActionsIfNeeded( self ):
|
|
if not self.Done() or self._response is None:
|
|
return
|
|
|
|
if self._is_goto_command:
|
|
return self._HandleGotoResponse()
|
|
|
|
if self._is_fixit_command:
|
|
return self._HandleFixitResponse()
|
|
|
|
# If not a dictionary or a list, the response is necessarily a
|
|
# scalar: boolean, number, string, etc. In this case, we print
|
|
# it to the user.
|
|
if not isinstance( self._response, ( dict, list ) ):
|
|
return self._HandleBasicResponse()
|
|
|
|
if 'message' in self._response:
|
|
return self._HandleMessageResponse()
|
|
|
|
if 'detailed_info' in self._response:
|
|
return self._HandleDetailedInfoResponse()
|
|
|
|
|
|
def _HandleGotoResponse( self ):
|
|
if isinstance( self._response, list ):
|
|
defs = [ _BuildQfListItem( x ) for x in self._response ]
|
|
vim.eval( 'setqflist( %s )' % repr( defs ) )
|
|
vim.eval( 'youcompleteme#OpenGoToList()' )
|
|
else:
|
|
vimsupport.JumpToLocation( self._response[ 'filepath' ],
|
|
self._response[ 'line_num' ],
|
|
self._response[ 'column_num' ] )
|
|
|
|
|
|
def _HandleFixitResponse( self ):
|
|
if not len( self._response[ 'fixits' ] ):
|
|
vimsupport.EchoText( "No fixits found for current line" )
|
|
else:
|
|
chunks = self._response[ 'fixits' ][ 0 ][ 'chunks' ]
|
|
|
|
vimsupport.ReplaceChunksList( chunks )
|
|
|
|
vimsupport.EchoTextVimWidth( "FixIt applied "
|
|
+ str( len( chunks ) )
|
|
+ " changes" )
|
|
|
|
|
|
def _HandleBasicResponse( self ):
|
|
vimsupport.EchoText( self._response )
|
|
|
|
|
|
def _HandleMessageResponse( self ):
|
|
vimsupport.EchoText( self._response[ 'message' ] )
|
|
|
|
|
|
def _HandleDetailedInfoResponse( self ):
|
|
vimsupport.WriteToPreviewWindow( self._response[ 'detailed_info' ] )
|
|
|
|
|
|
def SendCommandRequest( arguments, completer ):
|
|
request = CommandRequest( arguments, completer )
|
|
# This is a blocking call.
|
|
request.Start()
|
|
request.RunPostCommandActionsIfNeeded()
|
|
return request.Response()
|
|
|
|
|
|
def _BuildQfListItem( goto_data_item ):
|
|
qf_item = {}
|
|
if 'filepath' in goto_data_item:
|
|
qf_item[ 'filename' ] = ToUtf8IfNeeded( goto_data_item[ 'filepath' ] )
|
|
if 'description' in goto_data_item:
|
|
qf_item[ 'text' ] = ToUtf8IfNeeded( goto_data_item[ 'description' ] )
|
|
if 'line_num' in goto_data_item:
|
|
qf_item[ 'lnum' ] = goto_data_item[ 'line_num' ]
|
|
if 'column_num' in goto_data_item:
|
|
# ycmd returns columns 1-based, and QuickFix lists require "byte offsets".
|
|
# See :help getqflist and equivalent comment in
|
|
# vimsupport.ConvertDiagnosticsToQfList.
|
|
#
|
|
# When the Vim help says "byte index", it really means "1-based column
|
|
# number" (which is somewhat confusing). :help getqflist states "first
|
|
# column is 1".
|
|
qf_item[ 'col' ] = goto_data_item[ 'column_num' ]
|
|
|
|
return qf_item
|