Fix #557 - Detect C project roots and include root directories with headers, or include directories

ale_linters/c/clang.vim

@@ -10,11 +10,14 @@ if !exists('g:ale_c_clang_options')
 endif
 
 function! ale_linters#c#clang#GetCommand(buffer) abort
+    let l:paths = ale#handlers#c#FindLocalHeaderPaths(a:buffer)
+
     " -iquote with the directory the file is in makes #include work for
     "  headers in the same directory.
     return 'clang -S -x c -fsyntax-only '
-    \   . '-iquote ' . ale#Escape(fnamemodify(bufname(a:buffer), ':p:h'))
-    \   . ' ' . ale#Var(a:buffer, 'c_clang_options') . ' -'
+    \   . '-iquote ' . ale#Escape(fnamemodify(bufname(a:buffer), ':p:h')) . ' '
+    \   . ale#handlers#c#IncludeOptions(l:paths)
+    \   . ale#Var(a:buffer, 'c_clang_options') . ' -'
 endfunction
 
 call ale#linter#Define('c', {

ale_linters/c/gcc.vim

@@ -10,11 +10,14 @@ if !exists('g:ale_c_gcc_options')
 endif
 
 function! ale_linters#c#gcc#GetCommand(buffer) abort
+    let l:paths = ale#handlers#c#FindLocalHeaderPaths(a:buffer)
+
     " -iquote with the directory the file is in makes #include work for
     "  headers in the same directory.
     return 'gcc -S -x c -fsyntax-only '
-    \   . '-iquote ' . ale#Escape(fnamemodify(bufname(a:buffer), ':p:h'))
-    \   . ' ' . ale#Var(a:buffer, 'c_gcc_options') . ' -'
+    \   . '-iquote ' . ale#Escape(fnamemodify(bufname(a:buffer), ':p:h')) . ' '
+    \   . ale#handlers#c#IncludeOptions(l:paths)
+    \   . ale#Var(a:buffer, 'c_gcc_options') . ' -'
 endfunction
 
 call ale#linter#Define('c', {

ale_linters/cpp/clang.vim

@@ -7,11 +7,14 @@ if !exists('g:ale_cpp_clang_options')
 endif
 
 function! ale_linters#cpp#clang#GetCommand(buffer) abort
+    let l:paths = ale#handlers#c#FindLocalHeaderPaths(a:buffer)
+
     " -iquote with the directory the file is in makes #include work for
     "  headers in the same directory.
     return 'clang++ -S -x c++ -fsyntax-only '
-    \   . '-iquote ' . ale#Escape(fnamemodify(bufname(a:buffer), ':p:h'))
-    \   . ' ' . ale#Var(a:buffer, 'cpp_clang_options') . ' -'
+    \   . '-iquote ' . ale#Escape(fnamemodify(bufname(a:buffer), ':p:h')) . ' '
+    \   . ale#handlers#c#IncludeOptions(l:paths)
+    \   . ale#Var(a:buffer, 'cpp_clang_options') . ' -'
 endfunction
 
 call ale#linter#Define('cpp', {

ale_linters/cpp/gcc.vim

@@ -17,11 +17,14 @@ if !exists('g:ale_cpp_gcc_options')
 endif
 
 function! ale_linters#cpp#gcc#GetCommand(buffer) abort
+    let l:paths = ale#handlers#c#FindLocalHeaderPaths(a:buffer)
+
     " -iquote with the directory the file is in makes #include work for
     "  headers in the same directory.
     return 'gcc -S -x c++ -fsyntax-only '
-    \   . '-iquote ' . ale#Escape(fnamemodify(bufname(a:buffer), ':p:h'))
-    \   . ' ' . ale#Var(a:buffer, 'cpp_gcc_options') . ' -'
+    \   . '-iquote ' . ale#Escape(fnamemodify(bufname(a:buffer), ':p:h')) . ' '
+    \   . ale#handlers#c#IncludeOptions(l:paths)
+    \   . ale#Var(a:buffer, 'cpp_gcc_options') . ' -'
 endfunction
 
 call ale#linter#Define('cpp', {

autoload/ale/handlers/c.vim

@@ -2,7 +2,7 @@
 " Desciption: Functions for integrating with C and C++ compilers.
 
 function! ale#handlers#c#FindProjectRoot(buffer) abort
-    for l:project_filename in ['Makefile', 'CMakeLists.txt']
+    for l:project_filename in ['configure', 'Makefile', 'CMakeLists.txt']
         let l:full_path = ale#path#FindNearestFile(a:buffer, l:project_filename)
 
         if !empty(l:full_path)
@@ -55,5 +55,9 @@ function! ale#handlers#c#IncludeOptions(include_paths) abort
         call add(l:option_list, '-I' . ale#Escape(l:path))
     endfor
 
-    return join(l:option_list)
+    if empty(l:option_list)
+        return ''
+    endif
+
+    return ' ' . join(l:option_list) . ' '
 endfunction

test/test_c_import_paths.vader

@@ -0,0 +1,228 @@
+Before:
+  Save g:ale_c_gcc_options
+  Save g:ale_c_clang_options
+  Save g:ale_cpp_gcc_options
+  Save g:ale_cpp_clang_options
+
+  silent! cd /testplugin/test
+  let g:dir = getcwd()
+
+  let g:ale_c_gcc_options = ''
+  let g:ale_c_clang_options = ''
+  let g:ale_cpp_gcc_options = ''
+  let g:ale_cpp_clang_options = ''
+
+After:
+  Restore
+
+  silent execute 'cd ' . fnameescape(g:dir)
+  unlet! g:dir
+  call ale#linter#Reset()
+
+Execute(The C GCC handler should include 'include' directories for projects with a Makefile):
+  runtime! ale_linters/c/gcc.vim
+
+  cd test_c_projects/makefile_project/subdir
+  silent noautocmd file file.c
+
+  AssertEqual
+  \   'gcc -S -x c -fsyntax-only '
+  \   . '-iquote ' . ale#Escape(g:dir .  '/test_c_projects/makefile_project/subdir') . ' '
+  \   . ' -I' . ale#Escape(g:dir .  '/test_c_projects/makefile_project/include') . ' '
+  \   . ' -'
+  \ , ale_linters#c#gcc#GetCommand(bufnr(''))
+
+Execute(The C GCC handler should include 'include' directories for projects with a configure file):
+  runtime! ale_linters/c/gcc.vim
+
+  cd test_c_projects/configure_project/subdir
+  silent noautocmd file file.c
+
+  AssertEqual
+  \   'gcc -S -x c -fsyntax-only '
+  \   . '-iquote ' . ale#Escape(g:dir .  '/test_c_projects/configure_project/subdir') . ' '
+  \   . ' -I' . ale#Escape(g:dir .  '/test_c_projects/configure_project/include') . ' '
+  \   . ' -'
+  \ , ale_linters#c#gcc#GetCommand(bufnr(''))
+
+Execute(The C GCC handler should include root directories for projects with .h files in them):
+  runtime! ale_linters/c/gcc.vim
+
+  cd test_c_projects/h_file_project/subdir
+  silent noautocmd file file.c
+
+  AssertEqual
+  \   'gcc -S -x c -fsyntax-only '
+  \   . '-iquote ' . ale#Escape(g:dir .  '/test_c_projects/h_file_project/subdir') . ' '
+  \   . ' -I' . ale#Escape(g:dir .  '/test_c_projects/h_file_project') . ' '
+  \   . ' -'
+  \ , ale_linters#c#gcc#GetCommand(bufnr(''))
+
+Execute(The C GCC handler should include root directories for projects with .hpp files in them):
+  runtime! ale_linters/c/gcc.vim
+
+  cd test_c_projects/hpp_file_project/subdir
+  silent noautocmd file file.c
+
+  AssertEqual
+  \   'gcc -S -x c -fsyntax-only '
+  \   . '-iquote ' . ale#Escape(g:dir .  '/test_c_projects/hpp_file_project/subdir') . ' '
+  \   . ' -I' . ale#Escape(g:dir .  '/test_c_projects/hpp_file_project') . ' '
+  \   . ' -'
+  \ , ale_linters#c#gcc#GetCommand(bufnr(''))
+
+Execute(The C Clang handler should include 'include' directories for projects with a Makefile):
+  runtime! ale_linters/c/clang.vim
+
+  cd test_c_projects/makefile_project/subdir
+  silent noautocmd file file.c
+
+  AssertEqual
+  \   'clang -S -x c -fsyntax-only '
+  \   . '-iquote ' . ale#Escape(g:dir .  '/test_c_projects/makefile_project/subdir') . ' '
+  \   . ' -I' . ale#Escape(g:dir .  '/test_c_projects/makefile_project/include') . ' '
+  \   . ' -'
+  \ , ale_linters#c#clang#GetCommand(bufnr(''))
+
+Execute(The C Clang handler should include 'include' directories for projects with a configure file):
+  runtime! ale_linters/c/clang.vim
+
+  cd test_c_projects/h_file_project/subdir
+  silent noautocmd file file.c
+
+  AssertEqual
+  \   'clang -S -x c -fsyntax-only '
+  \   . '-iquote ' . ale#Escape(g:dir .  '/test_c_projects/h_file_project/subdir') . ' '
+  \   . ' -I' . ale#Escape(g:dir .  '/test_c_projects/h_file_project') . ' '
+  \   . ' -'
+  \ , ale_linters#c#clang#GetCommand(bufnr(''))
+
+Execute(The C Clang handler should include root directories for projects with .h files in them):
+  runtime! ale_linters/c/clang.vim
+
+  cd test_c_projects/h_file_project/subdir
+  silent noautocmd file file.c
+
+  AssertEqual
+  \   'clang -S -x c -fsyntax-only '
+  \   . '-iquote ' . ale#Escape(g:dir .  '/test_c_projects/h_file_project/subdir') . ' '
+  \   . ' -I' . ale#Escape(g:dir .  '/test_c_projects/h_file_project') . ' '
+  \   . ' -'
+  \ , ale_linters#c#clang#GetCommand(bufnr(''))
+
+Execute(The C Clang handler should include root directories for projects with .hpp files in them):
+  runtime! ale_linters/c/clang.vim
+
+  cd test_c_projects/hpp_file_project/subdir
+  silent noautocmd file file.c
+
+  AssertEqual
+  \   'clang -S -x c -fsyntax-only '
+  \   . '-iquote ' . ale#Escape(g:dir .  '/test_c_projects/hpp_file_project/subdir') . ' '
+  \   . ' -I' . ale#Escape(g:dir .  '/test_c_projects/hpp_file_project') . ' '
+  \   . ' -'
+  \ , ale_linters#c#clang#GetCommand(bufnr(''))
+
+Execute(The C++ GCC handler should include 'include' directories for projects with a Makefile):
+  runtime! ale_linters/cpp/gcc.vim
+
+  cd test_c_projects/makefile_project/subdir
+  silent noautocmd file file.cpp
+
+  AssertEqual
+  \   'gcc -S -x c++ -fsyntax-only '
+  \   . '-iquote ' . ale#Escape(g:dir .  '/test_c_projects/makefile_project/subdir') . ' '
+  \   . ' -I' . ale#Escape(g:dir .  '/test_c_projects/makefile_project/include') . ' '
+  \   . ' -'
+  \ , ale_linters#cpp#gcc#GetCommand(bufnr(''))
+
+Execute(The C++ GCC handler should include 'include' directories for projects with a configure file):
+  runtime! ale_linters/cpp/gcc.vim
+
+  cd test_c_projects/configure_project/subdir
+  silent noautocmd file file.cpp
+
+  AssertEqual
+  \   'gcc -S -x c++ -fsyntax-only '
+  \   . '-iquote ' . ale#Escape(g:dir .  '/test_c_projects/configure_project/subdir') . ' '
+  \   . ' -I' . ale#Escape(g:dir .  '/test_c_projects/configure_project/include') . ' '
+  \   . ' -'
+  \ , ale_linters#cpp#gcc#GetCommand(bufnr(''))
+
+Execute(The C++ GCC handler should include root directories for projects with .h files in them):
+  runtime! ale_linters/cpp/gcc.vim
+
+  cd test_c_projects/h_file_project/subdir
+  silent noautocmd file file.cpp
+
+  AssertEqual
+  \   'gcc -S -x c++ -fsyntax-only '
+  \   . '-iquote ' . ale#Escape(g:dir .  '/test_c_projects/h_file_project/subdir') . ' '
+  \   . ' -I' . ale#Escape(g:dir .  '/test_c_projects/h_file_project') . ' '
+  \   . ' -'
+  \ , ale_linters#cpp#gcc#GetCommand(bufnr(''))
+
+Execute(The C++ GCC handler should include root directories for projects with .hpp files in them):
+  runtime! ale_linters/cpp/gcc.vim
+
+  cd test_c_projects/hpp_file_project/subdir
+  silent noautocmd file file.cpp
+
+  AssertEqual
+  \   'gcc -S -x c++ -fsyntax-only '
+  \   . '-iquote ' . ale#Escape(g:dir .  '/test_c_projects/hpp_file_project/subdir') . ' '
+  \   . ' -I' . ale#Escape(g:dir .  '/test_c_projects/hpp_file_project') . ' '
+  \   . ' -'
+  \ , ale_linters#cpp#gcc#GetCommand(bufnr(''))
+
+Execute(The C++ Clang handler should include 'include' directories for projects with a Makefile):
+  runtime! ale_linters/cpp/clang.vim
+
+  cd test_c_projects/makefile_project/subdir
+  silent noautocmd file file.cpp
+
+  AssertEqual
+  \   'clang++ -S -x c++ -fsyntax-only '
+  \   . '-iquote ' . ale#Escape(g:dir .  '/test_c_projects/makefile_project/subdir') . ' '
+  \   . ' -I' . ale#Escape(g:dir .  '/test_c_projects/makefile_project/include') . ' '
+  \   . ' -'
+  \ , ale_linters#cpp#clang#GetCommand(bufnr(''))
+
+Execute(The C++ Clang handler should include 'include' directories for projects with a configure file):
+  runtime! ale_linters/cpp/clang.vim
+
+  cd test_c_projects/configure_project/subdir
+  silent noautocmd file file.cpp
+
+  AssertEqual
+  \   'clang++ -S -x c++ -fsyntax-only '
+  \   . '-iquote ' . ale#Escape(g:dir .  '/test_c_projects/configure_project/subdir') . ' '
+  \   . ' -I' . ale#Escape(g:dir .  '/test_c_projects/configure_project/include') . ' '
+  \   . ' -'
+  \ , ale_linters#cpp#clang#GetCommand(bufnr(''))
+
+Execute(The C++ Clang handler should include root directories for projects with .h files in them):
+  runtime! ale_linters/cpp/clang.vim
+
+  cd test_c_projects/h_file_project/subdir
+  silent noautocmd file file.cpp
+
+  AssertEqual
+  \   'clang++ -S -x c++ -fsyntax-only '
+  \   . '-iquote ' . ale#Escape(g:dir .  '/test_c_projects/h_file_project/subdir') . ' '
+  \   . ' -I' . ale#Escape(g:dir .  '/test_c_projects/h_file_project') . ' '
+  \   . ' -'
+  \ , ale_linters#cpp#clang#GetCommand(bufnr(''))
+
+Execute(The C++ Clang handler should include root directories for projects with .hpp files in them):
+  runtime! ale_linters/cpp/clang.vim
+
+  cd test_c_projects/hpp_file_project/subdir
+  silent noautocmd file file.cpp
+
+  AssertEqual
+  \   'clang++ -S -x c++ -fsyntax-only '
+  \   . '-iquote ' . ale#Escape(g:dir .  '/test_c_projects/hpp_file_project/subdir') . ' '
+  \   . ' -I' . ale#Escape(g:dir .  '/test_c_projects/hpp_file_project') . ' '
+  \   . ' -'
+  \ , ale_linters#cpp#clang#GetCommand(bufnr(''))