Fix #605 - Support vcol: 1 for multi-byte character positions

This commit is contained in:
w0rp 2018-04-08 17:17:30 +01:00
parent 121e806423
commit 91d7e81ebc
No known key found for this signature in database
GPG Key ID: 0FC1ECAA8C81CD83
4 changed files with 63 additions and 2 deletions

View File

@ -393,7 +393,7 @@ function! ale#engine#FixLocList(buffer, linter_name, loclist) abort
\ 'text': l:old_item.text, \ 'text': l:old_item.text,
\ 'lnum': str2nr(l:old_item.lnum), \ 'lnum': str2nr(l:old_item.lnum),
\ 'col': str2nr(get(l:old_item, 'col', 0)), \ 'col': str2nr(get(l:old_item, 'col', 0)),
\ 'vcol': get(l:old_item, 'vcol', 0), \ 'vcol': 0,
\ 'type': get(l:old_item, 'type', 'E'), \ 'type': get(l:old_item, 'type', 'E'),
\ 'nr': get(l:old_item, 'nr', -1), \ 'nr': get(l:old_item, 'nr', -1),
\ 'linter_name': a:linter_name, \ 'linter_name': a:linter_name,
@ -453,6 +453,20 @@ function! ale#engine#FixLocList(buffer, linter_name, loclist) abort
" When errors go beyond the end of the file, put them at the end. " When errors go beyond the end of the file, put them at the end.
" This is only done for the current buffer. " This is only done for the current buffer.
let l:item.lnum = l:last_line_number let l:item.lnum = l:last_line_number
elseif get(l:old_item, 'vcol', 0)
" Convert virtual column positions to byte positions.
" The positions will be off if the buffer has changed recently.
let l:line = getbufline(a:buffer, l:item.lnum)[0]
let l:item.col = ale#util#Col(l:line, l:item.col)
if has_key(l:item, 'end_col')
let l:end_line = get(l:item, 'end_lnum', l:line) != l:line
\ ? getbufline(a:buffer, l:item.end_lnum)[0]
\ : l:line
let l:item.end_col = ale#util#Col(l:end_line, l:item.end_col)
endif
endif endif
call add(l:new_loclist, l:item) call add(l:new_loclist, l:item)

View File

@ -311,3 +311,13 @@ function! ale#util#StopPartialTimer(timer_id) abort
call remove(s:partial_timers, a:timer_id) call remove(s:partial_timers, a:timer_id)
endif endif
endfunction endfunction
" Given a possibly multi-byte string and a 1-based character position on a
" line, return the 1-based byte position on that line.
function! ale#util#Col(str, chr) abort
if a:chr < 2
return a:chr
endif
return strlen(join(split(a:str, '\zs')[0:a:chr - 2], '')) + 1
endfunction

View File

@ -2072,6 +2072,13 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
key is also set with a valid number for some other key is also set with a valid number for some other
buffer. buffer.
`vcol` - Defaults to `0`. `vcol` - Defaults to `0`.
If set to `1`, ALE will convert virtual column
positions for `col` and `end_col` to byte column
positions. If the buffer is changed in-between
checking it and displaying the results, the
calculated byte column positions will probably be
wrong.
`type` - Defaults to `'E'`. `type` - Defaults to `'E'`.
`nr` - Defaults to `-1`. `nr` - Defaults to `-1`.

View File

@ -52,7 +52,7 @@ Execute(FixLocList should use the values we supply):
\ 'lnum': 3, \ 'lnum': 3,
\ 'col': 4, \ 'col': 4,
\ 'bufnr': 10000, \ 'bufnr': 10000,
\ 'vcol': 1, \ 'vcol': 0,
\ 'type': 'W', \ 'type': 'W',
\ 'nr': 42, \ 'nr': 42,
\ 'linter_name': 'foobar', \ 'linter_name': 'foobar',
@ -348,3 +348,33 @@ Execute(The error code should be passed on):
\ 'foobar', \ 'foobar',
\ [{'text': 'a', 'lnum': 11, 'code': 'some-code'}], \ [{'text': 'a', 'lnum': 11, 'code': 'some-code'}],
\ ) \ )
Given(A file with Japanese multi-byte text):
はじめまして!
-私はワープです。
Execute(character positions should be converted to byte positions):
AssertEqual
\ [
\ {'lnum': 1, 'bufnr': bufnr(''), 'col': 0, 'linter_name': 'foobar', 'nr': -1, 'type': 'E', 'vcol': 0, 'text': 'a'},
\ {'lnum': 1, 'bufnr': bufnr(''), 'col': 1, 'linter_name': 'foobar', 'nr': -1, 'type': 'E', 'vcol': 0, 'text': 'a'},
\ {'lnum': 1, 'bufnr': bufnr(''), 'col': 4, 'linter_name': 'foobar', 'nr': -1, 'type': 'E', 'vcol': 0, 'text': 'a'},
\ {'lnum': 1, 'bufnr': bufnr(''), 'col': 7, 'linter_name': 'foobar', 'nr': -1, 'type': 'E', 'vcol': 0, 'text': 'a'},
\ {'lnum': 1, 'bufnr': bufnr(''), 'col': 7, 'end_col': 13, 'linter_name': 'foobar', 'nr': -1, 'type': 'E', 'vcol': 0, 'text': 'a'},
\ {'lnum': 1, 'bufnr': bufnr(''), 'col': 7, 'end_col': 13, 'end_lnum': 1, 'linter_name': 'foobar', 'nr': -1, 'type': 'E', 'vcol': 0, 'text': 'a'},
\ {'lnum': 1, 'bufnr': bufnr(''), 'col': 7, 'end_col': 17, 'end_lnum': 2, 'linter_name': 'foobar', 'nr': -1, 'type': 'E', 'vcol': 0, 'text': 'a'},
\ {'lnum': 2, 'bufnr': bufnr(''), 'col': 17, 'linter_name': 'foobar', 'nr': -1, 'type': 'E', 'vcol': 0, 'text': 'a'},
\],
\ ale#engine#FixLocList(
\ bufnr('%'),
\ 'foobar',
\ [
\ {'text': 'a', 'lnum': 1, 'col': 0, 'vcol': 1},
\ {'text': 'a', 'lnum': 1, 'col': 1, 'vcol': 1},
\ {'text': 'a', 'lnum': 1, 'col': 2, 'vcol': 1},
\ {'text': 'a', 'lnum': 1, 'col': 3, 'vcol': 1},
\ {'text': 'a', 'lnum': 1, 'col': 3, 'end_col': 5, 'vcol': 1},
\ {'text': 'a', 'lnum': 1, 'col': 3, 'end_col': 5, 'end_lnum': 1, 'vcol': 1},
\ {'text': 'a', 'lnum': 1, 'col': 3, 'end_col': 7, 'end_lnum': 2, 'vcol': 1},
\ {'text': 'a', 'lnum': 2, 'col': 7, 'vcol': 1},
\ ],
\ )