package containers

  1. Overview
  2. Docs
A modular, clean and powerful extension of the OCaml standard library

Install

Dune Dependency

Authors

Maintainers

Sources

containers-3.16.tbz
sha256=1e7992cb2e59c0d2290d1b6c3a31531b3f310be6170b8ef3dde17ccd876b5b79
sha512=bb124e69ad0690f88393e18eee499be07761e767593558867aab32f643466b43258ced503170b154ca3b56dbd68987abd6d9438cf473707ec9866511589a5b84

doc/containers.codegen/Containers_codegen/index.html

Module Containers_codegenSource

Code generators

The code generator library is designed to be used from a build system (for example, from dune) to generate efficient code for features that are harder to provide at runtime.

The idea is that the build system should invoke some OCaml script that depends on containers.codegen; the script uses the DSL below to describe what code to generate (e.g. a description of a bitfield type) and emits a .ml file (and possibly a .mli file).

For example, the build script might contain:

module CG = Containers_codegen
let () =
  let module B = CG.Bitfield in
  let b = B.make ~name:"t" () in
  B.field_bit b "x";
  B.field_bit b "y";
  B.field_bit b "z";
  B.field_int b ~width:5 "foo";

  CG.emit_file "foo.mli" [B.gen_mli b];
  CG.emit_file "foo.ml" [B.gen_ml b];
  ()

and this will produce foo.ml and foo.mli with a bitfield containing x, y, and z.

Sourcemodule Fmt = CCFormat
Sourcetype code
Sourcemodule Code : sig ... end
Sourcemodule Bitfield : sig ... end
Sourceval emit_file : string -> code list -> unit

emit_file file cs emits code fragments cs into the given file at path file

Sourceval emit_chan : out_channel -> code list -> unit
Sourceval emit_string : code list -> string
OCaml

Innovation. Community. Security.

On This Page
  1. Code generators