292de25c72
This implements an asynchronous message system using a long-poll request to the server. The server provides an endpoint /receive_messages which blocks until either a timeout occurs or we receive a batch of asynchronous messages. We send this request asynchronously and poll it 4 times a second to see if we have received any messages. The messages may either be simply for display (such as startup progress) or diagnostics, which override the diagnostics returned by OnFileReqdyToParse. In the former case, we simply display the message, accepting that this might be overwritten by any other message (indeed, requiring this), and for the latter we fan out diagnostics to any open buffer for the file in question. Unfortunately, Vim has bugs related to timers when there is something displayed (such as a "confirm" prompt or other), so we suspend background timers when doing subcommands to avoid vim bugs. NOTE: This requires a new version of Vim (detected by the presence of the particular functions used).
131 lines
4.0 KiB
Python
131 lines
4.0 KiB
Python
# Copyright (C) 2016, Davit Samvelyan
|
|
#
|
|
# 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 __future__ import unicode_literals
|
|
from __future__ import print_function
|
|
from __future__ import division
|
|
from __future__ import absolute_import
|
|
# Not installing aliases from python-future; it's unreliable and slow.
|
|
from builtins import * # noqa
|
|
|
|
from ycm import vimsupport
|
|
from ycm.client.event_notification import EventNotification
|
|
from ycm.diagnostic_interface import DiagnosticInterface
|
|
|
|
|
|
DIAGNOSTIC_UI_FILETYPES = set( [ 'cpp', 'cs', 'c', 'objc', 'objcpp',
|
|
'typescript' ] )
|
|
DIAGNOSTIC_UI_ASYNC_FILETYPES = set( [ 'java' ] )
|
|
|
|
|
|
# Emulates Vim buffer
|
|
# Used to store buffer related information like diagnostics, latest parse
|
|
# request. Stores buffer change tick at the parse request moment, allowing
|
|
# to effectively determine whether reparse is needed for the buffer.
|
|
class Buffer( object ):
|
|
|
|
def __init__( self, bufnr, user_options, async_diags ):
|
|
self.number = bufnr
|
|
self._parse_tick = 0
|
|
self._handled_tick = 0
|
|
self._parse_request = None
|
|
self._async_diags = async_diags
|
|
self._diag_interface = DiagnosticInterface( bufnr, user_options )
|
|
|
|
|
|
def FileParseRequestReady( self, block = False ):
|
|
return bool( self._parse_request and
|
|
( block or self._parse_request.Done() ) )
|
|
|
|
|
|
def SendParseRequest( self, extra_data ):
|
|
self._parse_request = EventNotification( 'FileReadyToParse',
|
|
extra_data = extra_data )
|
|
self._parse_request.Start()
|
|
# Decrement handled tick to ensure correct handling when we are forcing
|
|
# reparse on buffer visit and changed tick remains the same.
|
|
self._handled_tick -= 1
|
|
self._parse_tick = self._ChangedTick()
|
|
|
|
|
|
def NeedsReparse( self ):
|
|
return self._parse_tick != self._ChangedTick()
|
|
|
|
|
|
def UpdateDiagnostics( self, force=False ):
|
|
if force or not self._async_diags:
|
|
self.UpdateWithNewDiagnostics( self._parse_request.Response() )
|
|
else:
|
|
# We need to call the response method, because it might throw an exception
|
|
# or require extra config confirmation, even if we don't actually use the
|
|
# diagnostics.
|
|
self._parse_request.Response()
|
|
|
|
|
|
def UpdateWithNewDiagnostics( self, diagnostics ):
|
|
self._diag_interface.UpdateWithNewDiagnostics( diagnostics )
|
|
|
|
|
|
def PopulateLocationList( self ):
|
|
return self._diag_interface.PopulateLocationList()
|
|
|
|
|
|
def GetResponse( self ):
|
|
return self._parse_request.Response()
|
|
|
|
|
|
def IsResponseHandled( self ):
|
|
return self._handled_tick == self._parse_tick
|
|
|
|
|
|
def MarkResponseHandled( self ):
|
|
self._handled_tick = self._parse_tick
|
|
|
|
|
|
def OnCursorMoved( self ):
|
|
self._diag_interface.OnCursorMoved()
|
|
|
|
|
|
def GetErrorCount( self ):
|
|
return self._diag_interface.GetErrorCount()
|
|
|
|
|
|
def GetWarningCount( self ):
|
|
return self._diag_interface.GetWarningCount()
|
|
|
|
|
|
def _ChangedTick( self ):
|
|
return vimsupport.GetBufferChangedTick( self.number )
|
|
|
|
|
|
class BufferDict( dict ):
|
|
|
|
def __init__( self, user_options ):
|
|
self._user_options = user_options
|
|
|
|
|
|
def __missing__( self, key ):
|
|
# Python does not allow to return assignment operation result directly
|
|
new_value = self[ key ] = Buffer(
|
|
key,
|
|
self._user_options,
|
|
any( [ x in DIAGNOSTIC_UI_ASYNC_FILETYPES
|
|
for x in
|
|
vimsupport.GetBufferFiletypes( key ) ] ) )
|
|
|
|
return new_value
|