Verilator current file search path (#3500)

* Simplify verilator linter using ale command format strings
* Verilator Linter: Restructure linter command tests
* Verilator Linter: adds to the handler test the returned filename
* Verilator Linter: add the current file path to the search path
* Verilator Linter: Add the search path to the tests

Co-authored-by: TG <tarik.graba@telecom-paris.fr>
This commit is contained in:
Tarik Graba 2021-02-11 20:35:25 +01:00 committed by GitHub
parent 1773a496ad
commit ea72d66b6d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 32 additions and 46 deletions

View File

@ -7,16 +7,11 @@ if !exists('g:ale_verilog_verilator_options')
endif
function! ale_linters#verilog#verilator#GetCommand(buffer) abort
let l:filename = ale#util#Tempname() . '_verilator_linted.v'
" Create a special filename, so we can detect it in the handler.
call ale#command#ManageFile(a:buffer, l:filename)
let l:lines = getbufline(a:buffer, 1, '$')
call ale#util#Writefile(a:buffer, l:lines, l:filename)
" the path to the current file is systematically added to the search path
return 'verilator --lint-only -Wall -Wno-DECLFILENAME '
\ . '-I%s:h '
\ . ale#Var(a:buffer, 'verilog_verilator_options') .' '
\ . ale#Escape(l:filename)
\ . '%t'
endfunction
function! ale_linters#verilog#verilator#Handle(buffer, lines) abort
@ -34,7 +29,7 @@ function! ale_linters#verilog#verilator#Handle(buffer, lines) abort
"
" to stay compatible with old versions of the tool, the column number is
" optional in the researched pattern
let l:pattern = '^%\(Warning\|Error\)[^:]*:\([^:]\+\):\(\d\+\):\(\d\+\)\?:\? \(.\+\)$'
let l:pattern = '^%\(Warning\|Error\)[^:]*:\s*\([^:]\+\):\(\d\+\):\(\d\+\)\?:\? \(.\+\)$'
let l:output = []
for l:match in ale#util#GetMatches(a:lines, l:pattern)
@ -42,17 +37,14 @@ function! ale_linters#verilog#verilator#Handle(buffer, lines) abort
\ 'lnum': str2nr(l:match[3]),
\ 'text': l:match[5],
\ 'type': l:match[1] is# 'Error' ? 'E' : 'W',
\ 'filename': l:match[2],
\}
if !empty(l:match[4])
let l:item.col = str2nr(l:match[4])
endif
let l:file = l:match[2]
if l:file =~# '_verilator_linted.v'
call add(l:output, l:item)
endif
endfor
return l:output

View File

@ -0,0 +1,14 @@
Before:
call ale#assert#SetUpLinterTest('verilog', 'verilator')
After:
call ale#assert#TearDownLinterTest()
Execute(The default verilator command should be correct):
AssertLinter 'verilator', 'verilator --lint-only -Wall -Wno-DECLFILENAME -I%s:h %t'
Execute(verilator options should be configurable):
" Additional args for the linter
let g:ale_verilog_verilator_options = '-sv --default-language "1800-2012"'
AssertLinter 'verilator', 'verilator --lint-only -Wall -Wno-DECLFILENAME -I%s:h -sv --default-language "1800-2012" %t'

View File

@ -11,17 +11,19 @@ Execute (The verilator handler should parse legacy messages with only line numbe
\ {
\ 'lnum': 3,
\ 'type': 'E',
\ 'text': 'syntax error, unexpected IDENTIFIER'
\ 'text': 'syntax error, unexpected IDENTIFIER',
\ 'filename': 'foo.v'
\ },
\ {
\ 'lnum': 10,
\ 'type': 'W',
\ 'text': 'Blocking assignments (=) in sequential (flop or latch) block; suggest delayed assignments (<=).'
\ 'text': 'Blocking assignments (=) in sequential (flop or latch) block; suggest delayed assignments (<=).',
\ 'filename': 'bar.v'
\ },
\ ],
\ ale_linters#verilog#verilator#Handle(bufnr(''), [
\ '%Error: foo_verilator_linted.v:3: syntax error, unexpected IDENTIFIER',
\ '%Warning-BLKSEQ: bar_verilator_linted.v:10: Blocking assignments (=) in sequential (flop or latch) block; suggest delayed assignments (<=).',
\ '%Error: foo.v:3: syntax error, unexpected IDENTIFIER',
\ '%Warning-BLKSEQ: bar.v:10: Blocking assignments (=) in sequential (flop or latch) block; suggest delayed assignments (<=).',
\ ])
@ -32,17 +34,19 @@ Execute (The verilator handler should parse new format messages with line and co
\ 'lnum': 3,
\ 'col' : 1,
\ 'type': 'E',
\ 'text': 'syntax error, unexpected endmodule, expecting ;'
\ 'text': 'syntax error, unexpected endmodule, expecting ;',
\ 'filename': 'bar.v'
\ },
\ {
\ 'lnum': 4,
\ 'col' : 6,
\ 'type': 'W',
\ 'text': 'Signal is not used: r'
\ 'text': 'Signal is not used: r',
\ 'filename': 'foo.v'
\ },
\ ],
\ ale_linters#verilog#verilator#Handle(bufnr(''), [
\ '%Error: bar_verilator_linted.v:3:1: syntax error, unexpected endmodule, expecting ;',
\ '%Warning-UNUSED: foo_verilator_linted.v:4:6: Signal is not used: r',
\ '%Error: bar.v:3:1: syntax error, unexpected endmodule, expecting ;',
\ '%Warning-UNUSED: foo.v:4:6: Signal is not used: r',
\ ])

View File

@ -1,24 +0,0 @@
Before:
Save g:ale_verilog_verilator_options
let g:ale_verilog_verilator_options = ''
After:
Restore
call ale#linter#Reset()
Execute(Set Verilog Verilator linter additional options to `-sv --default-language "1800-2012"`):
runtime! ale_linters/verilog/verilator.vim
" Additional args for the linter
let g:ale_verilog_verilator_options = '-sv --default-language "1800-2012"'
call ale#Queue(0)
let g:run_cmd = ale_linters#verilog#verilator#GetCommand(bufnr(''))
let g:matched = match(g:run_cmd, '\s' . g:ale_verilog_verilator_options . '\s')
" match returns -1 if not found
AssertNotEqual
\ g:matched ,
\ -1 ,
\ 'Additionnal arguments not found in the run command'