Add VHDL Support & Newer Verilog Linters (#2229)

* Added VHDL file support with ghdl compiler
* Update ghdl.vim
* Create vcom.vim
* Create xvhdl.vim
* Update xvlog.vim
* Added documentation for VHDL & Verilog linters
* Added tests to VHDL & Verilog linters

11 files changed, 224 insertions, 1 deletions

diff --git a/test/command_callback/test_ghdl_command_callbacks.vader b/test/command_callback/test_ghdl_command_callbacks.vader
new file mode 100644
index 00000000..f254e11f
--- /dev/null
+++ b/test/command_callback/test_ghdl_command_callbacks.vader
@@ -0,0 +1,19 @@
+Before:
+  call ale#assert#SetUpLinterTest('vhdl', 'ghdl')
+
+After:
+  unlet! b:command_tail
+
+  call ale#assert#TearDownLinterTest()
+
+Execute(The executable should be configurable):
+  AssertLinter 'ghdl', ale#Escape('ghdl') . ' -s  --std=08 %t'
+
+  let b:ale_vhdl_ghdl_executable = 'foobar'
+
+  AssertLinter 'foobar', ale#Escape('foobar') . ' -s  --std=08 %t'
+
+Execute(The options should be configurable):
+  let b:ale_vhdl_ghdl_options = '--something'
+
+  AssertLinter 'ghdl', ale#Escape('ghdl') . ' -s  --something %t'
diff --git a/test/command_callback/test_vcom_command_callbacks.vader b/test/command_callback/test_vcom_command_callbacks.vader
new file mode 100644
index 00000000..77218f74
--- /dev/null
+++ b/test/command_callback/test_vcom_command_callbacks.vader
@@ -0,0 +1,19 @@
+Before:
+  call ale#assert#SetUpLinterTest('vhdl', 'vcom')
+
+After:
+  unlet! b:command_tail
+
+  call ale#assert#TearDownLinterTest()
+
+Execute(The executable should be configurable):
+  AssertLinter 'vcom', ale#Escape('vcom') . '  -2008 -quiet -lint %t'
+
+  let b:ale_vhdl_vcom_executable = 'foobar'
+
+  AssertLinter 'foobar', ale#Escape('foobar') . '  -2008 -quiet -lint %t'
+
+Execute(The options should be configurable):
+  let b:ale_vhdl_vcom_options = '--something'
+
+  AssertLinter 'vcom', ale#Escape('vcom') . '  --something %t'
diff --git a/test/command_callback/test_vlog_command_callbacks.vader b/test/command_callback/test_vlog_command_callbacks.vader
new file mode 100644
index 00000000..a07944f7
--- /dev/null
+++ b/test/command_callback/test_vlog_command_callbacks.vader
@@ -0,0 +1,19 @@
+Before:
+  call ale#assert#SetUpLinterTest('verilog', 'vlog')
+
+After:
+  unlet! b:command_tail
+
+  call ale#assert#TearDownLinterTest()
+
+Execute(The executable should be configurable):
+  AssertLinter 'vlog', ale#Escape('vlog') . '  -quiet -lint %t'
+
+  let b:ale_verilog_vlog_executable = 'foobar'
+
+  AssertLinter 'foobar', ale#Escape('foobar') . '  -quiet -lint %t'
+
+Execute(The options should be configurable):
+  let b:ale_verilog_vlog_options = '--something'
+
+  AssertLinter 'vlog', ale#Escape('vlog') . '  --something %t'
diff --git a/test/command_callback/test_xvhdl_command_callbacks.vader b/test/command_callback/test_xvhdl_command_callbacks.vader
new file mode 100644
index 00000000..86f9a32d
--- /dev/null
+++ b/test/command_callback/test_xvhdl_command_callbacks.vader
@@ -0,0 +1,19 @@
+Before:
+  call ale#assert#SetUpLinterTest('vhdl', 'xvhdl')
+
+After:
+  unlet! b:command_tail
+
+  call ale#assert#TearDownLinterTest()
+
+Execute(The executable should be configurable):
+  AssertLinter 'xvhdl', ale#Escape('xvhdl') . '  --2008 %t'
+
+  let b:ale_vhdl_xvhdl_executable = 'foobar'
+
+  AssertLinter 'foobar', ale#Escape('foobar') . '  --2008 %t'
+
+Execute(The options should be configurable):
+  let b:ale_vhdl_xvhdl_options = '--something'
+
+  AssertLinter 'xvhdl', ale#Escape('xvhdl') . '  --something %t'
diff --git a/test/command_callback/test_xvlog_command_callbacks.vader b/test/command_callback/test_xvlog_command_callbacks.vader
new file mode 100644
index 00000000..564ac979
--- /dev/null
+++ b/test/command_callback/test_xvlog_command_callbacks.vader
@@ -0,0 +1,19 @@
+Before:
+  call ale#assert#SetUpLinterTest('verilog', 'xvlog')
+
+After:
+  unlet! b:command_tail
+
+  call ale#assert#TearDownLinterTest()
+
+Execute(The executable should be configurable):
+  AssertLinter 'xvlog', ale#Escape('xvlog') . '  %t'
+
+  let b:ale_verilog_xvlog_executable = 'foobar'
+
+  AssertLinter 'foobar', ale#Escape('foobar') . '  %t'
+
+Execute(The options should be configurable):
+  let b:ale_verilog_xvlog_options = '--something'
+
+  AssertLinter 'xvlog', ale#Escape('xvlog') . '  --something %t'
diff --git a/test/handler/test_ghdl_handler.vader b/test/handler/test_ghdl_handler.vader
new file mode 100644
index 00000000..a0f5edac
--- /dev/null
+++ b/test/handler/test_ghdl_handler.vader
@@ -0,0 +1,26 @@
+Before:
+  runtime ale_linters/vhdl/ghdl.vim
+
+After:
+  call ale#linter#Reset()
+
+Execute(The ghdl handler should parse lines correctly):
+  AssertEqual
+  \ [
+  \   {
+  \     'lnum': 41,
+  \     'col' : 5,
+  \     'type': 'E',
+  \     'text': "error: 'begin' is expected instead of 'if'"
+  \   },
+  \   {
+  \     'lnum': 12,
+  \     'col' : 8,
+  \     'type': 'E',
+  \     'text': ' no declaration for "i0"'
+  \   },
+  \ ],
+  \ ale_linters#vhdl#ghdl#Handle(bufnr(''), [
+  \   "dff_en.vhd:41:5:error: 'begin' is expected instead of 'if'",
+  \   '/path/to/file.vhdl:12:8: no declaration for "i0"',
+  \ ])
diff --git a/test/handler/test_vcom_handler.vader b/test/handler/test_vcom_handler.vader
new file mode 100644
index 00000000..943b525a
--- /dev/null
+++ b/test/handler/test_vcom_handler.vader
@@ -0,0 +1,36 @@
+Before:
+  runtime ale_linters/vhdl/vcom.vim
+
+After:
+  call ale#linter#Reset()
+
+Execute(The vcom handler should parse lines correctly):
+  AssertEqual
+  \ [
+  \   {
+  \     'lnum': 218,
+  \     'type': 'W',
+  \     'text': '(vcom-1236) Shared variables must be of a protected type.'
+  \   },
+  \   {
+  \     'lnum': 73,
+  \     'type': 'E',
+  \     'text': '(vcom-1136) Unknown identifier "aresetn".'
+  \   },
+  \   {
+  \     'lnum': 73,
+  \     'type': 'E',
+  \     'text': 'Bad resolution function (STD_LOGIC) for type (error).'
+  \   },
+  \   {
+  \     'lnum': 73,
+  \     'type': 'E',
+  \     'text': 'near ":": (vcom-1576) expecting ";" or ")".'
+  \   },
+  \ ],
+  \ ale_linters#vhdl#vcom#Handle(bufnr(''), [
+  \   '** Warning: ../path/to/file.vhd(218): (vcom-1236) Shared variables must be of a protected type.',
+  \   '** Error: tb_file.vhd(73): (vcom-1136) Unknown identifier "aresetn".',
+  \   '** Error: tb_file.vhd(73): Bad resolution function (STD_LOGIC) for type (error).',
+  \   '** Error: tb_file.vhd(73): near ":": (vcom-1576) expecting ";" or ")".',
+  \ ])
diff --git a/test/handler/test_vlog_handler.vader b/test/handler/test_vlog_handler.vader
new file mode 100644
index 00000000..a70665db
--- /dev/null
+++ b/test/handler/test_vlog_handler.vader
@@ -0,0 +1,24 @@
+Before:
+  runtime ale_linters/verilog/vlog.vim
+
+After:
+  call ale#linter#Reset()
+
+Execute(The vlog handler should parse lines correctly):
+  AssertEqual
+  \ [
+  \   {
+  \     'lnum': 7,
+  \     'type': 'W',
+  \     'text': '(vlog-2623) Undefined variable: C.'
+  \   },
+  \   {
+  \     'lnum': 1,
+  \     'type': 'E',
+  \     'text': '(vlog-13294) Identifier must be declared with a port mode: C.'
+  \   },
+  \ ],
+  \ ale_linters#verilog#vlog#Handle(bufnr(''), [
+  \   '** Warning: add.v(7): (vlog-2623) Undefined variable: C.',
+  \   '** Error: file.v(1): (vlog-13294) Identifier must be declared with a port mode: C.',
+  \ ])
diff --git a/test/handler/test_xvhdl_handler.vader b/test/handler/test_xvhdl_handler.vader
new file mode 100644
index 00000000..b90539b8
--- /dev/null
+++ b/test/handler/test_xvhdl_handler.vader
@@ -0,0 +1,24 @@
+Before:
+  runtime ale_linters/vhdl/xvhdl.vim
+
+After:
+  call ale#linter#Reset()
+
+Execute(The xvhdl handler should parse lines correctly):
+  AssertEqual
+  \ [
+  \   {
+  \     'lnum': 17,
+  \     'type': 'E',
+  \     'text': '[VRFC 10-91] aresetn is not declared '
+  \   },
+  \   {
+  \     'lnum': 128,
+  \     'type': 'E',
+  \     'text': '[VRFC 10-91] m_axis_tx_tdata is not declared '
+  \   },
+  \ ],
+  \ ale_linters#vhdl#xvhdl#Handle(bufnr(''), [
+  \   'ERROR: [VRFC 10-91] aresetn is not declared [/path/to/file.vhd:17]',
+  \   'ERROR: [VRFC 10-91] m_axis_tx_tdata is not declared [/home/user/tx_data.vhd:128]',
+  \ ])
diff --git a/test/handler/test_xvlog_handler.vader b/test/handler/test_xvlog_handler.vader
new file mode 100644
index 00000000..2e1f83fc
--- /dev/null
+++ b/test/handler/test_xvlog_handler.vader
@@ -0,0 +1,18 @@
+Before:
+  runtime ale_linters/verilog/xvlog.vim
+
+After:
+  call ale#linter#Reset()
+
+Execute(The xvlog handler should parse lines correctly):
+  AssertEqual
+  \ [
+  \   {
+  \     'lnum': 5,
+  \     'type': 'E',
+  \     'text': '[VRFC 10-1412] syntax error near output '
+  \   },
+  \ ],
+  \ ale_linters#verilog#xvlog#Handle(bufnr(''), [
+  \   'ERROR: [VRFC 10-1412] syntax error near output [/path/to/file.v:5]',
+  \ ])
diff --git a/test/test_filetype_linter_defaults.vader b/test/test_filetype_linter_defaults.vader
index 4f190226..af028041 100644
--- a/test/test_filetype_linter_defaults.vader
+++ b/test/test_filetype_linter_defaults.vader
@@ -61,7 +61,7 @@ Execute(The defaults for the zsh filetype should be correct):
 Execute(The defaults for the verilog filetype should be correct):
   " This filetype isn't configured with default, so we can test loading all
   " available linters with this.
-  AssertEqual ['iverilog', 'verilator'], GetLinterNames('verilog')
+  AssertEqual ['iverilog', 'verilator', 'vlog', 'xvlog'], GetLinterNames('verilog')
 
   let g:ale_linters_explicit = 1