Add lsp#formatexpr() (#528)

* Add <plug>(lsp-document-range-format)

This binding defines an operator and can be used with a motion. Because
s:document_format_range() did only format based on the visual selection
markers, a new type parameter was added to pass the selection type
according to 'opfunc'.

* Denote mapmode for plug mappings and add missing

Author: clktmr

autoload/lsp/ui/vim.vim

@@ -224,22 +224,34 @@ function! lsp#ui#vim#document_format() abort
     return s:document_format(0)
 endfunction
 
-function! s:get_visual_selection_pos() abort
-    " https://groups.google.com/d/msg/vim_dev/oCUQzO3y8XE/vfIMJiHCHtEJ
-    " https://stackoverflow.com/a/6271254
-    " getpos("'>'") doesn't give the right column so need to do extra processing
-    let [line_start, column_start] = getpos("'<")[1:2]
-    let [line_end, column_end] = getpos("'>")[1:2]
-    let lines = getline(line_start, line_end)
-    if len(lines) == 0
-        return [0, 0, 0, 0]
-    endif
-    let lines[-1] = lines[-1][: column_end - (&selection ==# 'inclusive' ? 1 : 2)]
-    let lines[0] = lines[0][column_start - 1:]
-    return [line_start, column_start, line_end, len(lines[-1])]
+function! s:get_selection_pos(type) abort
+    if a:type ==? 'v'
+        let l:start_pos = getpos("'<")[1:2]
+        let l:end_pos = getpos("'>")[1:2]
+        " fix end_pos column (see :h getpos() and :h 'selection')
+        let l:end_line = getline(l:end_pos[0])
+        let l:offset = (&selection ==# 'inclusive' ? 1 : 2)
+        let l:end_pos[1] = len(l:end_line[:l:end_pos[1]-l:offset])
+        " edge case: single character selected with selection=exclusive
+        if l:start_pos[0] == l:end_pos[0] && l:start_pos[1] > l:end_pos[1]
+            let l:end_pos[1] = l:start_pos[1]
+        endif
+    elseif a:type ==? 'line'
+        let l:start_pos = [line("'["), 1]
+        let l:end_lnum = line("']")
+        let l:end_pos = [line("']"), len(getline(l:end_lnum))]
+    elseif a:type ==? 'char'
+        let l:start_pos = getpos("'[")[1:2]
+        let l:end_pos = getpos("']")[1:2]
+    else
+        let l:start_pos = [0, 0]
+        let l:end_pos = [0, 0]
+    endif
+
+    return l:start_pos + l:end_pos
 endfunction
 
-function! s:document_format_range(sync) abort
+function! s:document_format_range(sync, type) abort
     let l:servers = filter(lsp#get_whitelisted_servers(), 'lsp#capabilities#has_document_range_formatting_provider(v:val)')
     let s:last_req_id = s:last_req_id + 1
 
@@ -251,7 +263,7 @@ function! s:document_format_range(sync) abort
     " TODO: ask user to select server for formatting
     let l:server = l:servers[0]
 
-    let [l:start_lnum, l:start_col, l:end_lnum, l:end_col] = s:get_visual_selection_pos()
+    let [l:start_lnum, l:start_col, l:end_lnum, l:end_col] = s:get_selection_pos(a:type)
     let l:start_char = lsp#utils#to_char('%', l:start_lnum, l:start_col)
     let l:end_char = lsp#utils#to_char('%', l:end_lnum, l:end_col)
     redraw | echo 'Formatting document range ...'
@@ -274,11 +286,15 @@ function! s:document_format_range(sync) abort
 endfunction
 
 function! lsp#ui#vim#document_range_format_sync() abort
-    return s:document_format_range(1)
+    return s:document_format_range(1, visualmode())
 endfunction
 
 function! lsp#ui#vim#document_range_format() abort
-    return s:document_format_range(0)
+    return s:document_format_range(0, visualmode())
+endfunction
+
+function! lsp#ui#vim#document_range_format_opfunc(type) abort
+    return s:document_format_range(1, a:type)
 endfunction
 
 function! lsp#ui#vim#workspace_symbol() abort

doc/vim-lsp.txt

@@ -931,30 +931,33 @@ To map keys to the feature of vim-lsp, use <plug> mappings:
 <
 Available plug mappings are following:
 
-  (lsp-code-action)
-  (lsp-declaration)
-  (lsp-peek-declaration)
-  (lsp-definition)
-  (lsp-peek-definition)
-  (lsp-document-symbol)
-  (lsp-document-diagnostics)
-  (lsp-hover)
-  (lsp-next-error)
-  (lsp-next-reference)
-  (lsp-preview-close)
-  (lsp-preview-focus)
-  (lsp-previous-error)
-  (lsp-previous-reference)
-  (lsp-references)
-  (lsp-rename)
-  (lsp-workspace-symbol)
-  (lsp-document-format)
-  (lsp-document-format)
-  (lsp-implementation)
-  (lsp-peek-implementation)
-  (lsp-type-definition)
-  (lsp-peek-type-definition)
-  (lsp-status)
+  nnoremap <plug>(lsp-code-action)
+  nnoremap <plug>(lsp-declaration)
+  nnoremap <plug>(lsp-peek-declaration)
+  nnoremap <plug>(lsp-definition)
+  nnoremap <plug>(lsp-peek-definition)
+  nnoremap <plug>(lsp-document-symbol)
+  nnoremap <plug>(lsp-document-diagnostics)
+  nnoremap <plug>(lsp-hover)
+  nnoremap <plug>(lsp-next-error)
+  nnoremap <plug>(lsp-next-reference)
+  nnoremap <plug>(lsp-preview-close)
+  nnoremap <plug>(lsp-preview-focus)
+  nnoremap <plug>(lsp-previous-error)
+  nnoremap <plug>(lsp-previous-reference)
+  nnoremap <plug>(lsp-references)
+  nnoremap <plug>(lsp-rename)
+  nnoremap <plug>(lsp-workspace-symbol)
+  nnoremap <plug>(lsp-document-format)
+  vnoremap <plug>(lsp-document-format)
+  nnoremap <plug>(lsp-document-range-format)
+  xnoremap <plug>(lsp-document-range-format)
+  nnoremap <plug>(lsp-implementation)
+  nnoremap <plug>(lsp-peek-implementation)
+  nnoremap <plug>(lsp-type-definition)
+  nnoremap <plug>(lsp-peek-type-definition)
+  nnoremap <plug>(lsp-status)
+  nnoremap <plug>(lsp-signature-help)
 
 See also |vim-lsp-commands|
 

plugin/lsp.vim

@@ -96,6 +96,8 @@ nnoremap <plug>(lsp-peek-type-definition) :<c-u>call lsp#ui#vim#type_definition(
 nnoremap <plug>(lsp-workspace-symbol) :<c-u>call lsp#ui#vim#workspace_symbol()<cr>
 nnoremap <plug>(lsp-document-format) :<c-u>call lsp#ui#vim#document_format()<cr>
 vnoremap <plug>(lsp-document-format) :<Home>silent <End>call lsp#ui#vim#document_range_format()<cr>
+nnoremap <plug>(lsp-document-range-format) :<c-u>set opfunc=lsp#ui#vim#document_range_format_opfunc<cr>g@
+xnoremap <plug>(lsp-document-range-format) :<Home>silent <End>call lsp#ui#vim#document_range_format()<cr>
 nnoremap <plug>(lsp-implementation) :<c-u>call lsp#ui#vim#implementation(0)<cr>
 nnoremap <plug>(lsp-peek-implementation) :<c-u>call lsp#ui#vim#implementation(1)<cr>
 nnoremap <plug>(lsp-status) :<c-u>echo lsp#get_server_status()<cr>