e424d75c42
Previously we'd show a Python traceback if the user asked for a detailed diagnostic in a file that wasn't supported by Clang (something written in Python perhaps). Now we show an nice, far less scary message informing the user of this. Fixes #748.
125 lines
3.5 KiB
Python
125 lines
3.5 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# Copyright (C) 2013 Strahinja Val Markovic <val@markovic.io>
|
|
#
|
|
# 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 os
|
|
|
|
YCM_EXTRA_CONF_FILENAME = '.ycm_extra_conf.py'
|
|
|
|
CONFIRM_CONF_FILE_MESSAGE = ('Found {0}. Load? \n\n(Question can be turned '
|
|
'off with options, see YCM docs)')
|
|
|
|
NO_EXTRA_CONF_FILENAME_MESSAGE = ( 'No {0} file detected, so no compile flags '
|
|
'are available. Thus no semantic support for C/C++/ObjC/ObjC++. Go READ THE '
|
|
'DOCS *NOW*, DON\'T file a bug report.' ).format( YCM_EXTRA_CONF_FILENAME )
|
|
|
|
NO_DIAGNOSTIC_SUPPORT_MESSAGE = ( 'YCM has no diagnostics support for this '
|
|
'filetype; refer to Syntastic docs if using Syntastic.')
|
|
|
|
|
|
class ServerError( Exception ):
|
|
def __init__( self, message ):
|
|
super( ServerError, self ).__init__( message )
|
|
|
|
|
|
class UnknownExtraConf( ServerError ):
|
|
def __init__( self, extra_conf_file ):
|
|
message = CONFIRM_CONF_FILE_MESSAGE.format( extra_conf_file )
|
|
super( UnknownExtraConf, self ).__init__( message )
|
|
self.extra_conf_file = extra_conf_file
|
|
|
|
|
|
class NoExtraConfDetected( ServerError ):
|
|
def __init__( self ):
|
|
super( NoExtraConfDetected, self ).__init__(
|
|
NO_EXTRA_CONF_FILENAME_MESSAGE )
|
|
|
|
|
|
class NoDiagnosticSupport( ServerError ):
|
|
def __init__( self ):
|
|
super( NoDiagnosticSupport, self ).__init__( NO_DIAGNOSTIC_SUPPORT_MESSAGE )
|
|
|
|
|
|
def BuildGoToResponse( filepath, line_num, column_num, description = None ):
|
|
response = {
|
|
'filepath': os.path.realpath( filepath ),
|
|
'line_num': line_num,
|
|
'column_num': column_num
|
|
}
|
|
|
|
if description:
|
|
response[ 'description' ] = description
|
|
return response
|
|
|
|
|
|
def BuildDescriptionOnlyGoToResponse( text ):
|
|
return {
|
|
'description': text,
|
|
}
|
|
|
|
|
|
# TODO: Look at all the callers and ensure they are not using this instead of an
|
|
# exception.
|
|
def BuildDisplayMessageResponse( text ):
|
|
return {
|
|
'message': text
|
|
}
|
|
|
|
|
|
def BuildCompletionData( insertion_text,
|
|
extra_menu_info = None,
|
|
detailed_info = None,
|
|
menu_text = None,
|
|
kind = None ):
|
|
completion_data = {
|
|
'insertion_text': insertion_text
|
|
}
|
|
|
|
if extra_menu_info:
|
|
completion_data[ 'extra_menu_info' ] = extra_menu_info
|
|
if menu_text:
|
|
completion_data[ 'menu_text' ] = menu_text
|
|
if detailed_info:
|
|
completion_data[ 'detailed_info' ] = detailed_info
|
|
if kind:
|
|
completion_data[ 'kind' ] = kind
|
|
return completion_data
|
|
|
|
|
|
def BuildDiagnosticData( filepath,
|
|
line_num,
|
|
column_num,
|
|
text,
|
|
kind ):
|
|
return {
|
|
'filepath': filepath,
|
|
'line_num': line_num,
|
|
'column_num': column_num,
|
|
'text': text,
|
|
'kind': kind
|
|
}
|
|
|
|
|
|
def BuildExceptionResponse( exception, traceback ):
|
|
return {
|
|
'exception': exception,
|
|
'message': str( exception ),
|
|
'traceback': traceback
|
|
}
|
|
|