Add diagnostics highlighting via +textprop. (#375)

* Add diagnostics highlighting via +textprop.

* Use textprop 'combine' option, added in 8.1.1276

* Add textprop docs.

* Enable textprop highlights by default.

Author: tsufeki

README.md

@@ -106,7 +106,20 @@ highlight link LspErrorText GruvboxRedSign " requires gruvbox
 highlight clear LspWarningLine
 ```
 
-### Virtual text
+#### Highlights
+
+Highlighting diagnostics requires either NeoVim 0.3+ or Vim with patch 8.1.0579.
+They are enabled by default when supported, but can be turned off respectively by
+
+```viml
+let g:lsp_highlights_enabled = 0
+let g:lsp_textprop_enabled = 0
+```
+
+Can be customized by setting or linking `LspErrorHighlight`, `LspWarningHighlight`,
+`LspInformationHighlight` and `LspHintHighlight` highlight groups.
+
+#### Virtual text
 
 In NeoVim 0.3 or newer you can use virtual text feature (enabled by default).
 You can disable it by adding

autoload/lsp.vim

@@ -52,6 +52,7 @@ function! lsp#enable() abort
         if g:lsp_signs_enabled | call lsp#ui#vim#signs#enable() | endif
         if g:lsp_virtual_text_enabled | call lsp#ui#vim#virtual#enable() | endif
         if g:lsp_highlights_enabled | call lsp#ui#vim#highlights#enable() | endif
+        if g:lsp_textprop_enabled | call lsp#ui#vim#diagnostics#textprop#enable() | endif
     endif
     call s:register_events()
 endfunction

autoload/lsp/ui/vim/diagnostics.vim

@@ -16,6 +16,7 @@ function! lsp#ui#vim#diagnostics#handle_text_document_publish_diagnostics(server
 
     call lsp#ui#vim#virtual#set(a:server_name, a:data)
     call lsp#ui#vim#highlights#set(a:server_name, a:data)
+    call lsp#ui#vim#diagnostics#textprop#set(a:server_name, a:data)
     call lsp#ui#vim#signs#set(a:server_name, a:data)
 endfunction
 

autoload/lsp/ui/vim/diagnostics/textprop.vim

@@ -0,0 +1,128 @@
+let s:supports_hl = exists('*prop_add')
+let s:enabled = 0
+let s:prop_type_prefix = 'vim_lsp_hl_'
+
+let s:severity_sign_names_mapping = {
+    \ 1: 'LspError',
+    \ 2: 'LspWarning',
+    \ 3: 'LspInformation',
+    \ 4: 'LspHint',
+    \ }
+
+if !hlexists('LspErrorHighlight')
+    highlight link LspErrorHighlight Error
+endif
+
+if !hlexists('LspWarningHighlight')
+    highlight link LspWarningHighlight Todo
+endif
+
+if !hlexists('LspInformationHighlight')
+    highlight link LspInformationHighlight Normal
+endif
+
+if !hlexists('LspHintHighlight')
+    highlight link LspHintHighlight Normal
+endif
+
+function! lsp#ui#vim#diagnostics#textprop#enable() abort
+    if !s:supports_hl
+        call lsp#log('vim-lsp highlighting requires vim with +textprop')
+        return
+    endif
+    if !s:enabled
+        let s:enabled = 1
+        call lsp#log('vim-lsp highlighting enabled (textprop)')
+    endif
+endfunction
+
+function! lsp#ui#vim#diagnostics#textprop#disable() abort
+    if s:enabled
+        call s:clear_all_highlights()
+        let s:enabled = 0
+        call lsp#log('vim-lsp highlighting disabled')
+    endif
+endfunction
+
+function! lsp#ui#vim#diagnostics#textprop#set(server_name, data) abort
+    if !s:enabled | return | endif
+
+    if lsp#client#is_error(a:data['response'])
+        return
+    endif
+
+    let l:uri = a:data['response']['params']['uri']
+    let l:diagnostics = a:data['response']['params']['diagnostics']
+    let l:path = lsp#utils#uri_to_path(l:uri)
+
+    call s:clear_highlights(a:server_name, l:path)
+    call s:place_highlights(a:server_name, l:path, l:diagnostics)
+endfunction
+
+function! s:get_prop_type(server_name, severity) abort
+    let l:severity = has_key(s:severity_sign_names_mapping, a:severity) ? a:severity : 0
+    let l:name = s:prop_type_prefix . l:severity . '_' . a:server_name
+    if empty(prop_type_get(l:name))
+        call prop_type_add(l:name, {
+            \ 'highlight': s:severity_sign_names_mapping[l:severity] . 'Highlight',
+            \ 'combine': v:true,
+            \ })
+    endif
+    return l:name
+endfunction
+
+function! s:clear_all_highlights() abort
+    for l:prop_type in prop_type_list()
+        if l:prop_type !~# '^' . s:prop_type_prefix
+            continue
+        endif
+
+        for l:bufnr in range(1, bufnr('$'))
+            if bufexists(l:bufnr)
+                call prop_remove({
+                    \ 'type': l:prop_type,
+                    \ 'bufnr': l:bufnr,
+                    \ 'all': v:true,
+                    \ })
+            endif
+        endfor
+
+        call prop_type_delete(l:prop_type)
+    endfor
+endfunction
+
+function! s:clear_highlights(server_name, path) abort
+    if !s:enabled | return | endif
+
+    let l:bufnr = bufnr(a:path)
+    for l:severity in keys(s:severity_sign_names_mapping)
+        let l:prop_type = s:get_prop_type(a:server_name, l:severity)
+        call prop_remove({
+            \ 'type': l:prop_type,
+            \ 'bufnr': l:bufnr,
+            \ 'all': v:true,
+            \ })
+    endfor
+endfunction
+
+function! s:place_highlights(server_name, path, diagnostics) abort
+    if !s:enabled | return | endif
+
+    let l:bufnr = bufnr(a:path)
+    if !empty(a:diagnostics) && l:bufnr >= 0
+        for l:item in a:diagnostics
+            let l:start_line = l:item['range']['start']['line'] + 1
+            let l:start_col = l:item['range']['start']['character'] + 1
+            let l:end_line = l:item['range']['end']['line'] + 1
+            let l:end_col = l:item['range']['end']['character'] + 1
+
+            let l:prop_type = s:get_prop_type(a:server_name, l:item['severity'])
+            call prop_add(l:start_line, l:start_col, {
+                \ 'end_lnum': l:end_line,
+                \ 'end_col': l:end_col,
+                \ 'bufnr': l:bufnr,
+                \ 'type': l:prop_type,
+                \ })
+        endfor
+    endif
+endfunction

doc/vim-lsp.txt

@@ -15,8 +15,11 @@ CONTENTS                                                  *vim-lsp-contents*
       g:lsp_preview_keep_focus              |g:lsp_preview_keep_focus|
       g:lsp_insert_text_enabled             |g:lsp_insert_text_enabled|
       g:lsp_text_edit_enabled               |g:lsp_text_edit_enabled|
-      g:lsp_signs_enabled                   |g:lsp_signs_enabled|
       g:lsp_diagnostics_echo_cursor         |g:lsp_diagnostics_echo_cursor|
+      g:lsp_signs_enabled                   |g:lsp_signs_enabled|
+      g:lsp_virtual_text_enabled            |g:lsp_virtual_text_enabled|
+      g:lsp_highlights_enabled              |g:lsp_highlights_enabled|
+      g:lsp_textprop_enabled                |g:lsp_textprop_enabled|
       g:lsp_use_event_queue                 |g:lsp_use_event_queue|
       g:lsp_highlight_references_enabled    |g:lsp_highlight_references_enabled|
     Functions                             |vim-lsp-functions|
@@ -203,6 +206,49 @@ g:lsp_virtual_text_enabled                            *g:lsp_virtual_text_enable
 	let g:lsp_virtual_text_enabled = 0
 <
 
+g:lsp_highlights_enabled                         *g:lsp_highlights_enabled*
+    Type: |Number|
+    Default: `1` for neovim 0.3+
+
+    Enables highlighting of diagnostics. Requires NeoVim with version 0.3 or
+    newer.
+
+    Example:
+>
+	let g:lsp_highlights_enabled = 1
+	let g:lsp_highlights_enabled = 0
+<
+
+    To change the style of the highlighting, you can set or link
+    `LspErrorHighlight`, `LspWarningHighlight`, `LspInformationHighlight` and
+    `LspHintHighlight` highlight groups.
+
+    Example:
+>
+	highlight link LspErrorHighlight Error
+<
+
+g:lsp_textprop_enabled                             *g:lsp_textprop_enabled*
+    Type: |Number|
+    Default: `1` for vim with +textprop
+
+    Enables highlighting of diagnostics. Requires vim with +textprop
+    (patch 8.1.0579).
+
+    Example:
+>
+	let g:lsp_textprop_enabled = 1
+	let g:lsp_textprop_enabled = 0
+<
+
+    To change the style of the highlighting, you can set or link
+    `LspErrorHighlight`, `LspWarningHighlight`, `LspInformationHighlight` and
+    `LspHintHighlight` highlight groups.
+
+    Example:
+>
+	highlight LspErrorHighlight term=underline cterm=underline gui=underline
+<
 
 g:lsp_use_event_queue                               *g:lsp_use_event_queue*
     Type: |Number|

plugin/lsp.vim

@@ -11,6 +11,7 @@ let g:lsp_debug_servers = get(g:, 'lsp_debug_servers', [])
 let g:lsp_signs_enabled = get(g:, 'lsp_signs_enabled', has('patch-8.1.0772') && exists('*sign_define'))
 let g:lsp_virtual_text_enabled = get(g:, 'lsp_virtual_text_enabled', exists('*nvim_buf_set_virtual_text'))
 let g:lsp_highlights_enabled = get(g:, 'lsp_highlights_enabled', exists('*nvim_buf_add_highlight'))
+let g:lsp_textprop_enabled = get(g:, 'lsp_textprop_enabled', exists('*prop_add') && !g:lsp_highlights_enabled)
 let g:lsp_signs_error = get(g:, 'lsp_signs_error', {})
 let g:lsp_signs_warning = get(g:, 'lsp_signs_warning', {})
 let g:lsp_signs_information = get(g:, 'lsp_signs_information', {})