2014-01-13 14:08:43 -05:00
|
|
|
# Copyright (C) 2013 Google Inc.
|
2013-09-20 20:24:34 -04:00
|
|
|
#
|
|
|
|
# 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/>.
|
|
|
|
|
2013-09-27 16:52:04 -04:00
|
|
|
import vim
|
|
|
|
from ycm.client.base_request import BaseRequest, BuildRequestData, ServerError
|
|
|
|
from ycm import vimsupport
|
2014-05-13 16:09:19 -04:00
|
|
|
from ycmd.utils import ToUtf8IfNeeded
|
2013-09-20 20:24:34 -04:00
|
|
|
|
2015-09-12 10:30:21 -04:00
|
|
|
|
2014-03-21 14:34:00 -04:00
|
|
|
def _EnsureBackwardsCompatibility( arguments ):
|
|
|
|
if arguments and arguments[ 0 ] == 'GoToDefinitionElseDeclaration':
|
|
|
|
arguments[ 0 ] = 'GoTo'
|
|
|
|
return arguments
|
|
|
|
|
2013-09-20 20:24:34 -04:00
|
|
|
|
|
|
|
class CommandRequest( BaseRequest ):
|
|
|
|
def __init__( self, arguments, completer_target = None ):
|
|
|
|
super( CommandRequest, self ).__init__()
|
2014-03-21 14:34:00 -04:00
|
|
|
self._arguments = _EnsureBackwardsCompatibility( arguments )
|
2013-09-20 20:24:34 -04:00
|
|
|
self._completer_target = ( completer_target if completer_target
|
|
|
|
else 'filetype_default' )
|
2013-09-27 16:52:04 -04:00
|
|
|
self._response = None
|
|
|
|
|
2013-09-20 20:24:34 -04:00
|
|
|
|
|
|
|
def Start( self ):
|
|
|
|
request_data = BuildRequestData()
|
|
|
|
request_data.update( {
|
|
|
|
'completer_target': self._completer_target,
|
|
|
|
'command_arguments': self._arguments
|
|
|
|
} )
|
2013-09-27 16:52:04 -04:00
|
|
|
try:
|
|
|
|
self._response = self.PostDataToHandler( request_data,
|
2015-09-12 10:30:21 -04:00
|
|
|
'run_completer_command' )
|
2013-09-27 16:52:04 -04:00
|
|
|
except ServerError as e:
|
2015-06-30 17:24:05 -04:00
|
|
|
vimsupport.PostMultiLineNotice( e )
|
2013-09-20 20:24:34 -04:00
|
|
|
|
|
|
|
|
|
|
|
def Response( self ):
|
2013-09-27 16:52:04 -04:00
|
|
|
return self._response
|
|
|
|
|
2015-09-12 10:30:21 -04:00
|
|
|
|
2013-09-27 16:52:04 -04:00
|
|
|
def RunPostCommandActionsIfNeeded( self ):
|
2015-11-28 10:20:51 -05:00
|
|
|
if not self.Done() or self._response is None:
|
2013-09-27 16:52:04 -04:00
|
|
|
return
|
|
|
|
|
2015-11-28 16:18:54 -05:00
|
|
|
# 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()
|
|
|
|
|
2016-01-11 18:33:15 -05:00
|
|
|
if 'fixits' in self._response:
|
|
|
|
return self._HandleFixitResponse()
|
|
|
|
|
2015-11-28 10:20:51 -05:00
|
|
|
if 'message' in self._response:
|
|
|
|
return self._HandleMessageResponse()
|
|
|
|
|
|
|
|
if 'detailed_info' in self._response:
|
|
|
|
return self._HandleDetailedInfoResponse()
|
2015-08-05 17:09:07 -04:00
|
|
|
|
2016-01-11 18:33:15 -05:00
|
|
|
# The only other type of response we understand is GoTo, and that is the
|
|
|
|
# only one that we can't detect just by inspecting the response (it should
|
|
|
|
# either be a single location or a list)
|
|
|
|
return self._HandleGotoResponse()
|
|
|
|
|
2015-09-12 10:30:21 -04:00
|
|
|
|
2015-08-05 17:09:07 -04:00
|
|
|
def _HandleGotoResponse( self ):
|
|
|
|
if isinstance( self._response, list ):
|
Support FixIt commands across buffers
We simply apply the changes to each file in turn. The existing replacement
logic is unchanged, except that it now no longer implicitly assumes we are
talking about the current buffer.
If a buffer is not visible for the requested file name, we open it in
a horizontal split, make the edits, then hide the window. Because this
can cause UI flickering, and leave hidden, modified buffers around, we
issue a warning to the user stating the number of files for which we are
going to do this. We pop up the quickfix list at the end of applying
the edits to allow the user to see what we changed.
If the user opts to abort due to, say, the file being open in another
window, we simply raise an error and give up, as undoing the changes
is too complex to do programatically, but trivial to do manually in such
a rare case.
2016-01-11 17:19:33 -05:00
|
|
|
vimsupport.SetQuickFixList(
|
|
|
|
[ _BuildQfListItem( x ) for x in self._response ] )
|
2015-08-05 17:09:07 -04:00
|
|
|
vim.eval( 'youcompleteme#OpenGoToList()' )
|
|
|
|
else:
|
|
|
|
vimsupport.JumpToLocation( self._response[ 'filepath' ],
|
2015-09-12 10:30:21 -04:00
|
|
|
self._response[ 'line_num' ],
|
|
|
|
self._response[ 'column_num' ] )
|
|
|
|
|
2015-08-05 17:09:07 -04:00
|
|
|
|
|
|
|
def _HandleFixitResponse( self ):
|
|
|
|
if not len( self._response[ 'fixits' ] ):
|
|
|
|
vimsupport.EchoText( "No fixits found for current line" )
|
|
|
|
else:
|
2015-09-12 10:30:21 -04:00
|
|
|
chunks = self._response[ 'fixits' ][ 0 ][ 'chunks' ]
|
Support FixIt commands across buffers
We simply apply the changes to each file in turn. The existing replacement
logic is unchanged, except that it now no longer implicitly assumes we are
talking about the current buffer.
If a buffer is not visible for the requested file name, we open it in
a horizontal split, make the edits, then hide the window. Because this
can cause UI flickering, and leave hidden, modified buffers around, we
issue a warning to the user stating the number of files for which we are
going to do this. We pop up the quickfix list at the end of applying
the edits to allow the user to see what we changed.
If the user opts to abort due to, say, the file being open in another
window, we simply raise an error and give up, as undoing the changes
is too complex to do programatically, but trivial to do manually in such
a rare case.
2016-01-11 17:19:33 -05:00
|
|
|
try:
|
|
|
|
vimsupport.ReplaceChunks( chunks )
|
|
|
|
except RuntimeError as e:
|
|
|
|
vimsupport.PostMultiLineNotice( e.message )
|
2015-09-12 10:30:21 -04:00
|
|
|
|
2013-09-27 16:52:04 -04:00
|
|
|
|
2015-11-28 16:18:54 -05:00
|
|
|
def _HandleBasicResponse( self ):
|
|
|
|
vimsupport.EchoText( self._response )
|
2015-11-28 10:20:51 -05:00
|
|
|
|
|
|
|
|
2015-08-05 17:09:07 -04:00
|
|
|
def _HandleMessageResponse( self ):
|
|
|
|
vimsupport.EchoText( self._response[ 'message' ] )
|
2013-09-27 16:52:04 -04:00
|
|
|
|
2015-09-12 10:30:21 -04:00
|
|
|
|
2015-09-06 15:07:42 -04:00
|
|
|
def _HandleDetailedInfoResponse( self ):
|
|
|
|
vimsupport.WriteToPreviewWindow( self._response[ 'detailed_info' ] )
|
|
|
|
|
|
|
|
|
2013-09-27 16:52:04 -04:00
|
|
|
def SendCommandRequest( arguments, completer ):
|
|
|
|
request = CommandRequest( arguments, completer )
|
2013-10-01 19:21:17 -04:00
|
|
|
# This is a blocking call.
|
2013-09-24 13:17:38 -04:00
|
|
|
request.Start()
|
2013-09-27 16:52:04 -04:00
|
|
|
request.RunPostCommandActionsIfNeeded()
|
2013-09-24 13:17:38 -04:00
|
|
|
return request.Response()
|
|
|
|
|
2013-09-27 16:52:04 -04:00
|
|
|
|
|
|
|
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:
|
2014-05-09 18:57:04 -04:00
|
|
|
qf_item[ 'lnum' ] = goto_data_item[ 'line_num' ]
|
2013-09-27 16:52:04 -04:00
|
|
|
if 'column_num' in goto_data_item:
|
2016-01-03 13:55:27 -05:00
|
|
|
# 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' ]
|
|
|
|
|
2013-09-27 16:52:04 -04:00
|
|
|
return qf_item
|