From 58717e05a3af56e8937dc5e794523e3184d5d530 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 16 Jul 2017 22:11:43 +0100 Subject: [PATCH] #711 - Make the cppcheck executables configurable --- ale_linters/c/cppcheck.vim | 13 +++-- ale_linters/cpp/cppcheck.vim | 13 +++-- doc/ale-c.txt | 8 +++ doc/ale-cpp.txt | 8 +++ .../test_c_cppcheck_command_callbacks.vader | 49 +++++++++++++++++++ .../test_cpp_cppcheck_command_callbacks.vader | 49 +++++++++++++++++++ .../test_cppcheck_command_callbacks.vader | 47 ------------------ 7 files changed, 132 insertions(+), 55 deletions(-) create mode 100644 test/command_callback/test_c_cppcheck_command_callbacks.vader create mode 100644 test/command_callback/test_cpp_cppcheck_command_callbacks.vader delete mode 100644 test/command_callback/test_cppcheck_command_callbacks.vader diff --git a/ale_linters/c/cppcheck.vim b/ale_linters/c/cppcheck.vim index 9080591..4db93f7 100644 --- a/ale_linters/c/cppcheck.vim +++ b/ale_linters/c/cppcheck.vim @@ -1,8 +1,12 @@ " Author: Bart Libert " Description: cppcheck linter for c files -" Set this option to change the cppcheck options -let g:ale_c_cppcheck_options = get(g:, 'ale_c_cppcheck_options', '--enable=style') +call ale#Set('c_cppcheck_executable', 'cppcheck') +call ale#Set('c_cppcheck_options', '--enable=style') + +function! ale_linters#c#cppcheck#GetExecutable(buffer) abort + return ale#Var(a:buffer, 'c_cppcheck_executable') +endfunction function! ale_linters#c#cppcheck#GetCommand(buffer) abort " Search upwards from the file for compile_commands.json. @@ -19,7 +23,8 @@ function! ale_linters#c#cppcheck#GetCommand(buffer) abort \ : '' return l:cd_command - \ . 'cppcheck -q --language=c ' + \ . ale#Escape(ale_linters#c#cppcheck#GetExecutable(a:buffer)) + \ . ' -q --language=c ' \ . l:compile_commands_option \ . ale#Var(a:buffer, 'c_cppcheck_options') \ . ' %t' @@ -28,7 +33,7 @@ endfunction call ale#linter#Define('c', { \ 'name': 'cppcheck', \ 'output_stream': 'both', -\ 'executable': 'cppcheck', +\ 'executable_callback': 'ale_linters#c#cppcheck#GetExecutable', \ 'command_callback': 'ale_linters#c#cppcheck#GetCommand', \ 'callback': 'ale#handlers#cppcheck#HandleCppCheckFormat', \}) diff --git a/ale_linters/cpp/cppcheck.vim b/ale_linters/cpp/cppcheck.vim index 2255f63..8b2aa80 100644 --- a/ale_linters/cpp/cppcheck.vim +++ b/ale_linters/cpp/cppcheck.vim @@ -1,8 +1,12 @@ " Author: Bart Libert " Description: cppcheck linter for cpp files -" Set this option to change the cppcheck options -let g:ale_cpp_cppcheck_options = get(g:, 'ale_cpp_cppcheck_options', '--enable=style') +call ale#Set('cpp_cppcheck_executable', 'cppcheck') +call ale#Set('cpp_cppcheck_options', '--enable=style') + +function! ale_linters#cpp#cppcheck#GetExecutable(buffer) abort + return ale#Var(a:buffer, 'cpp_cppcheck_executable') +endfunction function! ale_linters#cpp#cppcheck#GetCommand(buffer) abort " Search upwards from the file for compile_commands.json. @@ -19,7 +23,8 @@ function! ale_linters#cpp#cppcheck#GetCommand(buffer) abort \ : '' return l:cd_command - \ . 'cppcheck -q --language=c++ ' + \ . ale#Escape(ale_linters#cpp#cppcheck#GetExecutable(a:buffer)) + \ . ' -q --language=c++ ' \ . l:compile_commands_option \ . ale#Var(a:buffer, 'cpp_cppcheck_options') \ . ' %t' @@ -28,7 +33,7 @@ endfunction call ale#linter#Define('cpp', { \ 'name': 'cppcheck', \ 'output_stream': 'both', -\ 'executable': 'cppcheck', +\ 'executable_callback': 'ale_linters#cpp#cppcheck#GetExecutable', \ 'command_callback': 'ale_linters#cpp#cppcheck#GetCommand', \ 'callback': 'ale#handlers#cppcheck#HandleCppCheckFormat', \}) diff --git a/doc/ale-c.txt b/doc/ale-c.txt index 57d544d..41c33c9 100644 --- a/doc/ale-c.txt +++ b/doc/ale-c.txt @@ -24,6 +24,14 @@ g:ale_c_clang_options *g:ale_c_clang_options* =============================================================================== cppcheck *ale-c-cppcheck* +g:ale_c_cppcheck_executable *g:ale_c_cppcheck_executable* + *b:ale_c_cppcheck_executable* + Type: |String| + Default: `'cppcheck'` + + This variable can be changed to use a different executable for cppcheck. + + g:ale_c_cppcheck_options *g:ale_c_cppcheck_options* *b:ale_c_cppcheck_options* Type: |String| diff --git a/doc/ale-cpp.txt b/doc/ale-cpp.txt index 3e8ce9e..f5e7863 100644 --- a/doc/ale-cpp.txt +++ b/doc/ale-cpp.txt @@ -118,6 +118,14 @@ g:ale_cpp_clangtidy_options *g:ale_cpp_clangtidy_options* =============================================================================== cppcheck *ale-cpp-cppcheck* +g:ale_cpp_cppcheck_executable *g:ale_cpp_cppcheck_executable* + *b:ale_cpp_cppcheck_executable* + Type: |String| + Default: `'cppcheck'` + + This variable can be changed to use a different executable for cppcheck. + + g:ale_cpp_cppcheck_options *g:ale_cpp_cppcheck_options* *b:ale_cpp_cppcheck_options* Type: |String| diff --git a/test/command_callback/test_c_cppcheck_command_callbacks.vader b/test/command_callback/test_c_cppcheck_command_callbacks.vader new file mode 100644 index 0000000..daf61fb --- /dev/null +++ b/test/command_callback/test_c_cppcheck_command_callbacks.vader @@ -0,0 +1,49 @@ +Before: + Save g:ale_c_cppcheck_executable + Save g:ale_c_cppcheck_options + + unlet! g:ale_c_cppcheck_executable + unlet! b:ale_c_cppcheck_executable + unlet! g:ale_c_cppcheck_options + unlet! b:ale_c_cppcheck_options + + runtime ale_linters/c/cppcheck.vim + + let b:command_tail = ' -q --language=c --enable=style %t' + + call ale#test#SetDirectory('/testplugin/test/command_callback') + +After: + Restore + unlet! b:command_tail + unlet! b:ale_c_cppcheck_executable + unlet! b:ale_c_cppcheck_options + call ale#linter#Reset() + call ale#test#RestoreDirectory() + +Execute(The executable should be configurable): + AssertEqual 'cppcheck', ale_linters#c#cppcheck#GetExecutable(bufnr('')) + + let b:ale_c_cppcheck_executable = 'foobar' + + AssertEqual 'foobar', ale_linters#c#cppcheck#GetExecutable(bufnr('')) + +Execute(The executable should be used in the command): + AssertEqual + \ ale#Escape('cppcheck') . b:command_tail, + \ ale_linters#c#cppcheck#GetCommand(bufnr('')) + + let b:ale_c_cppcheck_executable = 'foobar' + + AssertEqual + \ ale#Escape('foobar') . b:command_tail, + \ ale_linters#c#cppcheck#GetCommand(bufnr('')) + +Execute(cppcheck for C++ should detect compile_commands.json files): + call ale#test#SetFilename('cppcheck_paths/one/foo.cpp') + + AssertEqual + \ 'cd ' . ale#Escape(g:dir . '/cppcheck_paths/one') . ' && ' + \ . ale#Escape('cppcheck') + \ . ' -q --language=c --project=compile_commands.json --enable=style %t', + \ ale_linters#c#cppcheck#GetCommand(bufnr('')) diff --git a/test/command_callback/test_cpp_cppcheck_command_callbacks.vader b/test/command_callback/test_cpp_cppcheck_command_callbacks.vader new file mode 100644 index 0000000..1839118 --- /dev/null +++ b/test/command_callback/test_cpp_cppcheck_command_callbacks.vader @@ -0,0 +1,49 @@ +Before: + Save g:ale_cpp_cppcheck_executable + Save g:ale_cpp_cppcheck_options + + unlet! g:ale_cpp_cppcheck_executable + unlet! b:ale_cpp_cppcheck_executable + unlet! g:ale_cpp_cppcheck_options + unlet! b:ale_cpp_cppcheck_options + + runtime ale_linters/cpp/cppcheck.vim + + let b:command_tail = ' -q --language=c++ --enable=style %t' + + call ale#test#SetDirectory('/testplugin/test/command_callback') + +After: + Restore + unlet! b:command_tail + unlet! b:ale_cpp_cppcheck_executable + unlet! b:ale_cpp_cppcheck_options + call ale#linter#Reset() + call ale#test#RestoreDirectory() + +Execute(The executable should be configurable): + AssertEqual 'cppcheck', ale_linters#cpp#cppcheck#GetExecutable(bufnr('')) + + let b:ale_cpp_cppcheck_executable = 'foobar' + + AssertEqual 'foobar', ale_linters#cpp#cppcheck#GetExecutable(bufnr('')) + +Execute(The executable should be used in the command): + AssertEqual + \ ale#Escape('cppcheck') . b:command_tail, + \ ale_linters#cpp#cppcheck#GetCommand(bufnr('')) + + let b:ale_cpp_cppcheck_executable = 'foobar' + + AssertEqual + \ ale#Escape('foobar') . b:command_tail, + \ ale_linters#cpp#cppcheck#GetCommand(bufnr('')) + +Execute(cppcheck for C++ should detect compile_commands.json files): + call ale#test#SetFilename('cppcheck_paths/one/foo.cpp') + + AssertEqual + \ 'cd ' . ale#Escape(g:dir . '/cppcheck_paths/one') . ' && ' + \ . ale#Escape('cppcheck') + \ . ' -q --language=c++ --project=compile_commands.json --enable=style %t', + \ ale_linters#cpp#cppcheck#GetCommand(bufnr('')) diff --git a/test/command_callback/test_cppcheck_command_callbacks.vader b/test/command_callback/test_cppcheck_command_callbacks.vader deleted file mode 100644 index 69bb214..0000000 --- a/test/command_callback/test_cppcheck_command_callbacks.vader +++ /dev/null @@ -1,47 +0,0 @@ -Before: - silent! cd /testplugin/test/command_callback - let b:dir = getcwd() - -After: - silent execute 'cd ' . fnameescape(b:dir) - unlet! b:dir - - call ale#linter#Reset() - -Execute(The default C cppcheck command should be correct): - runtime ale_linters/c/cppcheck.vim - - call ale#test#SetFilename('cppcheck_paths/two/foo.cpp') - - AssertEqual - \ 'cppcheck -q --language=c --enable=style %t', - \ ale_linters#c#cppcheck#GetCommand(bufnr('')) - -Execute(cppcheck for C should detect compile_commands.json files): - runtime ale_linters/c/cppcheck.vim - - call ale#test#SetFilename('cppcheck_paths/one/foo.cpp') - - AssertEqual - \ 'cd ' . ale#Escape(b:dir . '/cppcheck_paths/one') . ' && ' - \ . 'cppcheck -q --language=c --project=compile_commands.json --enable=style %t', - \ ale_linters#c#cppcheck#GetCommand(bufnr('')) - -Execute(The default C++ cppcheck command should be correct): - runtime ale_linters/cpp/cppcheck.vim - - call ale#test#SetFilename('cppcheck_paths/two/foo.cpp') - - AssertEqual - \ 'cppcheck -q --language=c++ --enable=style %t', - \ ale_linters#cpp#cppcheck#GetCommand(bufnr('')) - -Execute(cppcheck for C++ should detect compile_commands.json files): - runtime ale_linters/cpp/cppcheck.vim - - call ale#test#SetFilename('cppcheck_paths/one/foo.cpp') - - AssertEqual - \ 'cd ' . ale#Escape(b:dir . '/cppcheck_paths/one') . ' && ' - \ . 'cppcheck -q --language=c++ --project=compile_commands.json --enable=style %t', - \ ale_linters#cpp#cppcheck#GetCommand(bufnr(''))