Module `B0_pack`

Build packs.

A build pack gathers a set of build units and attaches metadata to it.

Packs

type t: The type for build units.

val v : ?⁠doc:string -> ?⁠meta:B0_meta.t -> string -> locked:bool -> B0_unit.t list -> t: v n us is a build pack named n made of build units us and described by doc. locked defaults to false, see locked for the semantics.

val locked : t -> bool: locked is true if the pack when used in a build mandates a locked build.

val units : t -> B0_unit.t list: units p are the units of p.

B0 definition API

include B0_def.S with type t := t

type t: The type of defined values.

val define : ?⁠doc:string -> ?⁠meta:B0_meta.t -> string -> B0_def.def: define ~doc ~meta n defines name n in the current scope with documentation string doc (defaults to "undocumented")e and metadata meta (defaults to B0_meta.empty). Defining a duplicate value in a scope raises Duplicate.

val def_kind : string: def_kind is the kind of defined value.

val def : t -> B0_def.def: def v is the definition of value v.

val name : t -> string: name v is v's name.

val doc : t -> string: doc v is v's documentation string.

val equal : t -> t -> bool: equal v0 v1 is true iff v0 and v1 have the same name.

val compare : t -> t -> int: compare v0 v1 sorts v0 and v0 in lexicographical order.

Metadata

val meta : t -> B0_meta.t: meta v is v's metadata.

val has_meta : 'a B0_meta.key -> t -> bool: has_meta k u is B0_meta.mem k (B0_unit.meta u).

val find_meta : 'a B0_meta.key -> t -> 'a option: find_meta k u is B0_meta.find k (B0_unit.meta u).

val get_meta : 'a B0_meta.key -> t -> ('a, string) Stdlib.result: get_meta m k u is Ok v if find_meta k u is Some v and a final user friendly error message if None.

Add & Lookup

val add : t -> unit: add v adds the value v to the list of defined values.

val list : unit -> t list: list () is the list of units. FIXME scope that.

val find : string -> t option: find n is the value named n (if any).

val get : string -> t: get n looks up the value named n and errors the B0 file if there no such n.

val get_or_suggest : string -> (t, t list) Stdlib.result: get_or_suggest n is the value named n or a (possibly empty) list of suggested values whose name could match n.

val get_list : string list -> (t list, string) Stdlib.result: get_list ns are the value named ns or an error that indicates the names that could not be found with suggested names.

Formatters

val pp_name_str : string B00_std.Fmt.t: pp_name_str v pretty prints value names.

val pp_name : t B00_std.Fmt.t: pp_name v formats v's name.

val pp_doc : t B00_std.Fmt.t: pp_doc formats v's doc string.

val pp_synopsis : t B00_std.Fmt.t: pp_synopsis formats v's name and its doc string.

val pp : t B00_std.Fmt.t: pp formats v 's name, its doc string and its metadata dictionary.

Value set and maps

module Set : Stdlib.Set.S with type Set.elt = t: Value sets.

module Map : Stdlib.Map.S with type Map.key = t: Value maps.