如何通过 OCamlbuild 使用 Menhir 错误消息生成？

Question

我正在使用 menhir 的 --compile-errors 功能，我对此非常满意。我还使用 ocamlbuild 来管理我的项目的编译。由于该项目非常基础，构建基础设施到目前为止仍然微不足道。

我在项目的根目录下有一个 _tags 文件和一个简单的 Makefile。我还没有 myocamlbuild.ml 文件。 _tags 文件只包含一行：

<src/*>: package(ppx_deriving.std)

Makefile 的相关部分是

all: src/ParsingErrors.ml
    ocamlbuild $(OPTIONS) src/Main.native

src/ParsingErrors.ml: src/Handcrafted.messages src/Parser.mly
    menhir --compile-errors src/Handcrafted.messages src/Parser.mly > src/ParsingErrors.ml

OPTIONS = -j 4 -use-menhir -use-ocamlfind -yaccflag --table -pkgs menhirLib,str,unix

OCamlbuild 和 Menhir 通常集成得很好，但 --compile-errors 似乎是一个相当新的功能。我的设置并不理想，因为我不喜欢在我的源目录而不是构建目录中有一个自动生成的文件 src/ParsingErrors.ml。向 OCamlbuild 解释我希望 Menhir 构建此错误消息文件的最佳方式是什么？更改我的文件的命名约定（例如，更改为 src/Parser.messages 和 src/Parser.ml）如果它简化了事情，我不会打扰。

注意：虽然我在其他项目中有 myocamlbuild.ml 个文件，但我是从网上复制的。我发现它们很难破译，我也不太明白怎么写这些东西。

Answer 1

当前的 ocamlbuild 版本确实不支持该功能。要将它添加到您的 myocamlbuild.ml 插件中，您必须定义一个新的构建规则。如果您对 myocamlbuild.ml 里面的东西感到害怕，您可能会对新的 ocamlbuild manual, in particular its section on plugins.

感兴趣

我刚刚在 ocamlbuild 存储库上打开了一个 issue report #121 来跟踪这个缺失的功能。您是否有兴趣充分了解 ocamlbuild 以为此编写适当的规则并将其贡献给下一个 ocamlbuild 版本？如果是，请随时提出 github 问题并开始询问有关如何实施它的问题，我很乐意提供帮助。如果没有，有时间我会尝试自己实现。

与此同时，请注意，为特定文件定义一次性规则比通用规则要容易得多。如果您准备好对您使用的源文件进行硬编码，您可能会得到一些看起来与 Makefile 规则非常相似的东西。我今天没有时间写和检查这个规则，但如果其他人没有在这期间完成，我明天会尝试回来。

Answer 2

寻找此问题答案的最佳地点是 Menhir 的发行版，因为 Menhir 在其自己的编译过程中使用 "menhir --compile-errors" 和 ocamlbuild。

要查找的文件是source tarball中的src/myocamlbuild.ml。

以下是相关摘录：

(* This rule generates an .ml file [target] from an .mly file [grammar] and a
   .messages file [messages]. *)

(* If the name of a witness file is passed, it is made an additional
   dependency. This triggers a separate rule (see below) which performs a
   completeness check, that is, which checks that the .messages file lists
   every possible syntax error. *)

let compile_errors grammar messages (witness : string list) target =
  rule
    "menhir/compile_errors"
    ~prod:target
    ~deps:([ grammar; messages ] @ witness)
    (fun env _ ->
      let grammar = env grammar in
      let tags = tags_of_pathname grammar ++ "ocaml" ++ "menhir" in
      Cmd(S[
        !Options.ocamlyacc; (* menhir *)
        T tags;
        P grammar;
        A "--compile-errors"; P (env messages);
        Sh ">"; Px (env target);
      ]))

(* A generic version of the above rule, with uniform naming. *)

let generic_compile_errors (check_completeness : bool) =
  compile_errors
    (* sources: *)
    "%.mly" "%Messages.messages"
    (* if present, this dependency forces a completeness check: *)
    (if check_completeness then [ "%Messages.witness" ] else [])
    (* target: *)
    "%Messages.ml"

我很乐意与 ocamlbuild 维护者讨论是否可以将 Menhir 的 myocamlbuild.ml 的某些部分移至 ocamlbuild 的标准规则集中。（嗨加布里埃尔！）

如何通过 OCamlbuild 使用 Menhir 错误消息生成？

How to use Menhir error messages generation via OCamlbuild?

ocaml

makefile

ocamlbuild

menhir