Merge pull request #143 from edwintorok/master

Add ocamlbuild support to ocaml.vim

syntax_checkers/locaml.vim

@@ -1,26 +0,0 @@
-"============================================================================
-"File:        locaml.vim
-"Description: Syntax checking plugin for syntastic.vim
-"Maintainer:  Török Edwin <edwintorok at gmail dot com>
-"License:     This program is free software. It comes without any warranty,
-"             to the extent permitted by applicable law. You can redistribute
-"             it and/or modify it under the terms of the Do What The Fuck You
-"             Want To Public License, Version 2, as published by Sam Hocevar.
-"             See http://sam.zoy.org/wtfpl/COPYING for more details.
-"
-"============================================================================
-if exists("loaded_locaml_syntax_checker")
-    finish
-endif
-let loaded_locaml_syntax_checker = 1
-
-"bail if the user doesnt have camlp4o installed
-if !executable("camlp4o")
-    finish
-endif
-
-runtime syntax_checkers/ocaml.vim
-
-function! SyntaxCheckers_locaml_GetLocList()
-    return SyntaxCheckers_ocaml_GetLocList()
-endfunction

syntax_checkers/ocaml.vim

@@ -9,37 +9,81 @@
 "             See http://sam.zoy.org/wtfpl/COPYING for more details.
 "
 "============================================================================
+"
+" By default the camlp4o preprocessor is used to check the syntax of .ml, and .mli files,
+" ocamllex is used to check .mll files and menhir is used to check .mly files.
+" The output is all redirected to /dev/null, nothing is written to the disk.
+"
+" If your source code needs camlp4r then you can define this in your .vimrc:
+"
+"   let g:syntastic_ocaml_camlp4r = 1
+"
+" If you used some syntax extensions, or you want to also typecheck the source
+" code, then you can define this:
+"
+"   let g:syntastic_ocaml_use_ocamlbuild = 1
+"
+" This will run ocamlbuild <name>.inferred.mli, so it will write to your _build
+" directory (and possibly rebuild your myocamlbuild.ml plugin), only enable this
+" if you are ok with that.
+"
+" If you are using syntax extensions / external libraries and have a properly
+" set up _tags (and myocamlbuild.ml file) then it should just work
+" to enable this flag and get syntax / type checks through syntastic.
+"
+" For best results your current directory should be the project root
+" (same situation if you want useful output from :make).
+
 if exists("loaded_ocaml_syntax_checker")
     finish
 endif
 let loaded_ocaml_syntax_checker = 1
 
-"bail if the user doesnt have camlp4o installed
+if exists('g:syntastic_ocaml_camlp4r') &&
-if !executable("camlp4o")
+    \ g:syntastic_ocaml_camlp4r != 0
+    let s:ocamlpp="camlp4r"
+else
+    let s:ocamlpp="camlp4o"
+endif
+
+"bail if the user doesnt have the preprocessor
+if !executable(s:ocamlpp)
     finish
 endif
 
 function! SyntaxCheckers_ocaml_GetLocList()
-    let extension = expand('%:e')
+    if exists('g:syntastic_ocaml_use_ocamlbuild') &&
-    if match(extension, 'mly') >= 0
+                \ g:syntastic_ocaml_use_ocamlbuild != 0 &&
-        " ocamlyacc output can't be redirected, so use menhir
+                \ executable("ocamlbuild") &&
-        if !executable("menhir")
+                \ isdirectory('_build')
-            return []
+        let makeprg = "ocamlbuild -quiet -no-log -tag annot,". s:ocamlpp. " -no-links -no-hygiene -no-sanitize ".
-        endif
+                    \ shellescape(expand('%:r')).".cmi"
-        let makeprg = "menhir --only-preprocess ".shellescape(expand('%')) . " >/dev/null"
-    elseif match(extension,'mll') >= 0
-        if !executable("ocamllex")
-            return []
-        endif
-        let makeprg = "ocamllex -q -o /dev/null ".shellescape(expand('%'))
     else
-        let makeprg = "camlp4o -o /dev/null ".shellescape(expand('%'))
+        let extension = expand('%:e')
+        if match(extension, 'mly') >= 0
+            " ocamlyacc output can't be redirected, so use menhir
+            if !executable("menhir")
+                return []
+            endif
+            let makeprg = "menhir --only-preprocess ".shellescape(expand('%')) . " >/dev/null"
+        elseif match(extension,'mll') >= 0
+            if !executable("ocamllex")
+                return []
+            endif
+            let makeprg = "ocamllex -q -o /dev/null ".shellescape(expand('%'))
+        else
+            let makeprg = "camlp4o -o /dev/null ".shellescape(expand('%'))
+        endif
     endif
-    let errorformat = '%EFile "%f"\, line %l\, characters %c-%*\d:,'.
+    let errorformat = '%AFile "%f"\, line %l\, characters %c-%*\d:,'.
-                \ '%EFile "%f"\, line %l\, characters %c-%*\d (end at line %*\d\, character %*\d):,'.
+                \ '%AFile "%f"\, line %l\, characters %c-%*\d (end at line %*\d\, character %*\d):,'.
-                \ '%EFile "%f"\, line %l\, character %c:,'.
+                \ '%AFile "%f"\, line %l\, character %c:,'.
-                \ '%EFile "%f"\, line %l\, character %c:%m,'.
+                \ '%AFile "%f"\, line %l\, character %c:%m,'.
-                \ '%C%m'
+                \ '%-GPreprocessing error %.%#,'.
+                \ '%-GCommand exited %.%#,'.
+                \ '%C%tarning %n: %m,'.
+                \ '%C%m,'.
+                \ '%-G+%.%#'
 
     return SyntasticMake({ 'makeprg': makeprg, 'errorformat': errorformat })
 endfunction