diagnostic_interface.py 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. #!/usr/bin/env python
  2. #
  3. # Copyright (C) 2013 Strahinja Val Markovic <val@markovic.io>
  4. #
  5. # This file is part of YouCompleteMe.
  6. #
  7. # YouCompleteMe is free software: you can redistribute it and/or modify
  8. # it under the terms of the GNU General Public License as published by
  9. # the Free Software Foundation, either version 3 of the License, or
  10. # (at your option) any later version.
  11. #
  12. # YouCompleteMe is distributed in the hope that it will be useful,
  13. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. # GNU General Public License for more details.
  16. #
  17. # You should have received a copy of the GNU General Public License
  18. # along with YouCompleteMe. If not, see <http://www.gnu.org/licenses/>.
  19. from collections import defaultdict
  20. from ycm import vimsupport
  21. import vim
  22. class DiagnosticInterface( object ):
  23. def __init__( self ):
  24. # Line and column numbers are 1-based
  25. self._buffer_number_to_line_to_diags = defaultdict(
  26. lambda: defaultdict( list ) )
  27. self._next_sign_id = 1
  28. self._previous_line_number = -1
  29. def OnCursorMoved( self ):
  30. line, _ = vimsupport.CurrentLineAndColumn()
  31. line += 1 # Convert to 1-based
  32. if line != self._previous_line_number:
  33. self._previous_line_number = line
  34. self._EchoDiagnosticForLine( line )
  35. def UpdateWithNewDiagnostics( self, diags ):
  36. self._buffer_number_to_line_to_diags = _ConvertDiagListToDict( diags )
  37. self._next_sign_id = _UpdateSigns( self._buffer_number_to_line_to_diags,
  38. self._next_sign_id )
  39. _UpdateSquiggles( self._buffer_number_to_line_to_diags )
  40. def _EchoDiagnosticForLine( self, line_num ):
  41. buffer_num = vim.current.buffer.number
  42. diags = self._buffer_number_to_line_to_diags[ buffer_num ][ line_num ]
  43. if not diags:
  44. # Clear any previous diag echo
  45. vimsupport.EchoText( '', False )
  46. return
  47. vimsupport.EchoTextVimWidth( diags[ 0 ][ 'text' ] )
  48. def _UpdateSquiggles( buffer_number_to_line_to_diags ):
  49. vimsupport.ClearYcmSyntaxMatches()
  50. line_to_diags = buffer_number_to_line_to_diags[ vim.current.buffer.number ]
  51. for diags in line_to_diags.itervalues():
  52. for diag in diags:
  53. location = diag[ 'location' ]
  54. is_error = _DiagnosticIsError( diag )
  55. vimsupport.AddDiagnosticSyntaxMatch(
  56. location[ 'line_num' ] + 1,
  57. location[ 'column_num' ] + 1,
  58. is_error = is_error )
  59. for diag_range in diag[ 'ranges' ]:
  60. vimsupport.AddDiagnosticSyntaxMatch(
  61. diag_range[ 'start' ][ 'line_num' ] + 1,
  62. diag_range[ 'start' ][ 'column_num' ] + 1,
  63. diag_range[ 'end' ][ 'line_num' ] + 1,
  64. diag_range[ 'end' ][ 'column_num' ] + 1,
  65. is_error = is_error )
  66. def _UpdateSigns( buffer_number_to_line_to_diags, next_sign_id ):
  67. vimsupport.UnplaceAllSignsInBuffer( vim.current.buffer.number )
  68. for buffer_number, line_to_diags in buffer_number_to_line_to_diags.iteritems():
  69. if not vimsupport.BufferIsVisible( buffer_number ):
  70. continue
  71. vimsupport.UnplaceAllSignsInBuffer( buffer_number )
  72. for line, diags in line_to_diags.iteritems():
  73. for diag in diags:
  74. vimsupport.PlaceSign( next_sign_id,
  75. line,
  76. buffer_number,
  77. _DiagnosticIsError( diag ) )
  78. next_sign_id += 1
  79. return next_sign_id
  80. def _ConvertDiagListToDict( diag_list ):
  81. buffer_to_line_to_diags = defaultdict( lambda: defaultdict( list ) )
  82. for diag in diag_list:
  83. location = diag[ 'location' ]
  84. buffer_number = vimsupport.GetBufferNumberForFilename(
  85. location[ 'filepath' ] )
  86. line_number = location[ 'line_num' ] + 1
  87. buffer_to_line_to_diags[ buffer_number ][ line_number ].append( diag )
  88. for line_to_diags in buffer_to_line_to_diags.itervalues():
  89. for diags in line_to_diags.itervalues():
  90. # We also want errors to be listed before warnings so that errors aren't
  91. # hidden by the warnings; Vim won't place a sign oven an existing one.
  92. diags.sort( key = lambda diag: ( diag[ 'location' ][ 'column_num' ],
  93. diag[ 'kind' ] ) )
  94. return buffer_to_line_to_diags
  95. def _DiagnosticIsError( diag ):
  96. return diag[ 'kind' ] == 'E'