958d8f1eb5
We display the detailed info text in the preview window. Vim's preview window is designed to display actual files, not scratch data. Our approach is to open a temporary file, even though that file is never written. This way, all of Vim's existing settings for the preview window (and people's configured mappings) just work. This is also consistent with showing the documentation in the preview window during completion. Other plugins have more complicated functions for this (such as eclim), or Scratch.vim, but this approach is simple and doesn't require external dependencies or additional settings. Tests: This required fixing a sort-of-bug in which the mock'd Vim module was always only set once, and could not be changed outside of the module which created it. This meant that it wasn't easy to have arbitrary tests, because it was dependent on the order in which the tests execute as to whether the return from MockVimModule() was actually the one in use. The solution was to make the mock'd vim module a singleton, and use mock's patch decorator to assign new MagicMock() instances to those methods in the vim module which a particular test is interested in.
98 lines
3.1 KiB
Python
98 lines
3.1 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/>.
|
|
|
|
from ycmd.utils import ToUtf8IfNeeded
|
|
from ycm.client.base_request import ( BaseRequest, JsonFromFuture,
|
|
HandleServerException,
|
|
MakeServerException )
|
|
|
|
TIMEOUT_SECONDS = 0.5
|
|
|
|
|
|
class CompletionRequest( BaseRequest ):
|
|
def __init__( self, request_data ):
|
|
super( CompletionRequest, self ).__init__()
|
|
self.request_data = request_data
|
|
|
|
|
|
def Start( self ):
|
|
self._response_future = self.PostDataToHandlerAsync( self.request_data,
|
|
'completions',
|
|
TIMEOUT_SECONDS )
|
|
|
|
|
|
def Done( self ):
|
|
return self._response_future.done()
|
|
|
|
|
|
def RawResponse( self ):
|
|
if not self._response_future:
|
|
return []
|
|
try:
|
|
response = JsonFromFuture( self._response_future )
|
|
|
|
errors = response['errors'] if 'errors' in response else []
|
|
for e in errors:
|
|
HandleServerException( MakeServerException( e ) )
|
|
|
|
return JsonFromFuture( self._response_future )[ 'completions' ]
|
|
except Exception as e:
|
|
HandleServerException( e )
|
|
return []
|
|
|
|
|
|
def Response( self ):
|
|
return _ConvertCompletionDatasToVimDatas( self.RawResponse() )
|
|
|
|
|
|
def ConvertCompletionDataToVimData( completion_data ):
|
|
# see :h complete-items for a description of the dictionary fields
|
|
vim_data = {
|
|
'word' : ToUtf8IfNeeded( completion_data[ 'insertion_text' ] ),
|
|
'dup' : 1,
|
|
}
|
|
|
|
if ( 'extra_data' in completion_data and
|
|
'doc_string' in completion_data[ 'extra_data' ] ):
|
|
doc_string = ToUtf8IfNeeded(
|
|
completion_data[ 'extra_data' ][ 'doc_string' ] )
|
|
else:
|
|
doc_string = ""
|
|
|
|
if 'menu_text' in completion_data:
|
|
vim_data[ 'abbr' ] = ToUtf8IfNeeded( completion_data[ 'menu_text' ] )
|
|
if 'extra_menu_info' in completion_data:
|
|
vim_data[ 'menu' ] = ToUtf8IfNeeded( completion_data[ 'extra_menu_info' ] )
|
|
if 'kind' in completion_data:
|
|
vim_data[ 'kind' ] = ToUtf8IfNeeded(
|
|
completion_data[ 'kind' ] )[ 0 ].lower()
|
|
if 'detailed_info' in completion_data:
|
|
vim_data[ 'info' ] = ToUtf8IfNeeded( completion_data[ 'detailed_info' ] )
|
|
if doc_string:
|
|
vim_data[ 'info' ] += '\n' + doc_string
|
|
elif doc_string:
|
|
vim_data[ 'info' ] = doc_string
|
|
|
|
return vim_data
|
|
|
|
|
|
def _ConvertCompletionDatasToVimDatas( response_data ):
|
|
return [ ConvertCompletionDataToVimData( x )
|
|
for x in response_data ]
|