Source file `pb_codegen_plugin.ml`

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
(** Plugin architecture.

    OCaml-protoc generates code based on a number of plugins, each of which can
    contribute code to the output files (.ml and .mli). *)

type codegen_f =
  ?and_:unit ->
  mode:Pb_codegen_mode.t ->
  Pb_codegen_ocaml_type.type_ ->
  Pb_codegen_formatting.scope ->
  bool
(** A code generation function *)

module type S = sig
  val gen_sig : codegen_f
  (** Generate a signature file (.mli) *)

  val gen_struct : codegen_f
  (** Generate the implementation (.ml) *)

  val ocamldoc_title : string
  (** OCamldoc title *)
end

type t = (module S)
(** A plugin is a code-generator respecting the signature {!S}. *)