From c36f3e78e47ae3b83eba6b2ad7139ed4d8f7ed9b Mon Sep 17 00:00:00 2001 From: Reed Riley Date: Fri, 19 Apr 2019 17:09:51 -0400 Subject: [PATCH 1/2] Add support for Vim's tagstack to ALEGoToDefinition fixes 1236 --- autoload/ale/definition.vim | 17 +++++++++++++++++ doc/ale.txt | 11 +++++++++++ test/test_go_to_definition.vader | 9 +++++++++ 3 files changed, 37 insertions(+) diff --git a/autoload/ale/definition.vim b/autoload/ale/definition.vim index 521f0b45..6b5dbfe0 100644 --- a/autoload/ale/definition.vim +++ b/autoload/ale/definition.vim @@ -3,6 +3,9 @@ let s:go_to_definition_map = {} +" Enable automatic updates of the tagstack +let g:ale_update_tagstack = get(g:, 'ale_update_tagstack', 1) + " Used to get the definition map in tests. function! ale#definition#GetMap() abort return deepcopy(s:go_to_definition_map) @@ -17,6 +20,18 @@ function! ale#definition#ClearLSPData() abort let s:go_to_definition_map = {} endfunction +function! ale#definition#UpdateTagStack() abort + let l:should_update_tagstack = exists('*gettagstack') && exists('*settagstack') && g:ale_update_tagstack + + if l:should_update_tagstack + let l:from = [bufnr('%'), line('.'), col('.'), 0] + let l:tagname = expand('') + let l:winid = win_getid() + call settagstack(l:winid, {'items': [{'from': l:from, 'tagname': l:tagname}]}, 'a') + call settagstack(l:winid, {'curidx': len(gettagstack(l:winid)['items']) + 1}) + endif +endfunction + function! ale#definition#HandleTSServerResponse(conn_id, response) abort if get(a:response, 'command', '') is# 'definition' \&& has_key(s:go_to_definition_map, a:response.request_seq) @@ -27,6 +42,7 @@ function! ale#definition#HandleTSServerResponse(conn_id, response) abort let l:line = a:response.body[0].start.line let l:column = a:response.body[0].start.offset + call ale#definition#UpdateTagStack() call ale#util#Open(l:filename, l:line, l:column, l:options) endif endif @@ -51,6 +67,7 @@ function! ale#definition#HandleLSPResponse(conn_id, response) abort let l:line = l:item.range.start.line + 1 let l:column = l:item.range.start.character + 1 + call ale#definition#UpdateTagStack() call ale#util#Open(l:filename, l:line, l:column, l:options) break endfor diff --git a/doc/ale.txt b/doc/ale.txt index 3b194cb0..e2fe387c 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -371,6 +371,9 @@ information returned by LSP servers. The following commands are supported: |ALEGoToDefinitionInSplit| - The same, but in a new split. |ALEGoToDefinitionInVSplit| - The same, but in a new vertical split. +ALE will update Vim's |tagstack| automatically unless |g:ale_update_tagstack| is +set to `0`. + ------------------------------------------------------------------------------- 5.3 Go To Type Definition *ale-go-to-type-definition* @@ -1494,6 +1497,14 @@ g:ale_sign_warning *g:ale_sign_warning* The sign for warnings in the sign gutter. +g:ale_update_tagstack *g:ale_update_tagstack* + *b:ale_update_tagstack* + Type: |Number| + Default: `1` + + This option can be set to disable updating Vim's |tagstack| automatically. + + g:ale_type_map *g:ale_type_map* *b:ale_type_map* Type: |Dictionary| diff --git a/test/test_go_to_definition.vader b/test/test_go_to_definition.vader index 452b7692..3479d7b5 100644 --- a/test/test_go_to_definition.vader +++ b/test/test_go_to_definition.vader @@ -78,6 +78,15 @@ After: Execute(Other messages for the tsserver handler should be ignored): call ale#definition#HandleTSServerResponse(1, {'command': 'foo'}) +Execute(Tagstack should be incremented if supported): + if exists('*gettagstack') && exists('*settagstack') + let original_stack_depth = gettagstack().length + endif + call ale#definition#UpdateTagStack() + if exists('*gettagstack') && exists('*settagstack') + AssertEqual original_stack_depth + 1, gettagstack().length + endif + Execute(Failed definition responses should be handled correctly): call ale#definition#SetMap({3: {'open_in': 'current-buffer'}}) call ale#definition#HandleTSServerResponse( From 46c743a247a8e967ebbbfdb907774dd7ae5fa4f2 Mon Sep 17 00:00:00 2001 From: Reed Riley Date: Wed, 24 Apr 2019 09:54:42 -0400 Subject: [PATCH 2/2] Updated Vim version in Dockerfile and made UpdateTagStack clearer The `settagstack` and `gettagstack` functions don't exist prior to Vim 8.1.0519. And the function definition was unclear whether it intended to grab the *old* or the *new* file/line/col. --- Dockerfile | 2 +- autoload/ale/definition.vim | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/Dockerfile b/Dockerfile index 6111f9ba..58ab0771 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,7 +1,7 @@ FROM tweekmonster/vim-testbed:latest RUN install_vim -tag v8.0.0027 -build \ - -tag v8.1.0204 -build \ + -tag v8.1.0519 -build \ -tag neovim:v0.2.0 -build \ -tag neovim:v0.3.0 -build diff --git a/autoload/ale/definition.vim b/autoload/ale/definition.vim index 6b5dbfe0..3915cac1 100644 --- a/autoload/ale/definition.vim +++ b/autoload/ale/definition.vim @@ -24,10 +24,12 @@ function! ale#definition#UpdateTagStack() abort let l:should_update_tagstack = exists('*gettagstack') && exists('*settagstack') && g:ale_update_tagstack if l:should_update_tagstack - let l:from = [bufnr('%'), line('.'), col('.'), 0] + " Grab the old location (to jump back to) and the word under the + " cursor (as a label for the tagstack) + let l:old_location = [bufnr('%'), line('.'), col('.'), 0] let l:tagname = expand('') let l:winid = win_getid() - call settagstack(l:winid, {'items': [{'from': l:from, 'tagname': l:tagname}]}, 'a') + call settagstack(l:winid, {'items': [{'from': l:old_location, 'tagname': l:tagname}]}, 'a') call settagstack(l:winid, {'curidx': len(gettagstack(l:winid)['items']) + 1}) endif endfunction