Module Mdx.Block

Code blocks headers.

module Header : sig ... end

Code blocks.

type cram_value = {
  1. language : [ `Bash | `Sh ];
  2. non_det : Label.non_det option;
}
type ocaml_value = {
  1. env : Ocaml_env.t;
    (*

    env is the name given to the environment where tests are run.

    *)
  2. non_det : Label.non_det option;
  3. errors : Output.t list;
}
type toplevel_value = {
  1. env : Ocaml_env.t;
    (*

    env is the name given to the environment where tests are run.

    *)
  2. non_det : Label.non_det option;
}
type include_ocaml_file = {
  1. part_included : string option;
    (*

    part_included is the part of the file to synchronize with. If lines is not specified synchronize the whole file.

    *)
}
type include_other_file = {
  1. header : Header.t option;
}
type include_file_kind =
  1. | Fk_ocaml of include_ocaml_file
  2. | Fk_other of include_other_file
type include_value = {
  1. file_included : string;
    (*

    file_included is the name of the file to synchronize with.

    *)
  2. file_kind : include_file_kind;
}
type raw_value = {
  1. header : Header.t option;
}
type value =
  1. | Raw of raw_value
  2. | OCaml of ocaml_value
  3. | Cram of cram_value
  4. | Toplevel of toplevel_value
  5. | Include of include_value

The type for block values.

type section = int * string

The type for sections.

type t = {
  1. loc : Location.t;
  2. section : section option;
  3. dir : string option;
  4. source_trees : string list;
  5. required_packages : string list;
  6. labels : Label.t list;
  7. legacy_labels : bool;
  8. contents : string list;
  9. skip : bool;
  10. version_enabled : bool;
    (*

    Whether the current OCaml version complies with the block's version.

    *)
  11. set_variables : (string * string) list;
  12. unset_variables : string list;
  13. value : value;
}

The type for supported code blocks.

val mk : loc:Location.t -> section:section option -> labels:Label.t list -> legacy_labels:bool -> header:Header.t option -> contents:string list -> errors:Output.t list -> (t, [ `Msg of string ]) Result.result
val mk_include : loc:Location.t -> section:section option -> labels:Label.t list -> (t, [ `Msg of string ]) Result.result

mk_include builds an include block from a comment <!-- $MDX ... --> that is not followed by a code block ``` ... ```.

Printers

val dump : t Fmt.t

dump is the printer for dumping code blocks. Useful for debugging.

val pp_header : ?syntax:Syntax.t -> t Fmt.t

pp_header pretty-prints full block headers with the labels.

val pp_contents : ?syntax:Syntax.t -> t Fmt.t

pp_contents pretty-prints block contents.

pp_footer pretty-prints block footer.

val pp : ?syntax:Syntax.t -> t Fmt.t

pp pretty-prints blocks.

val pp_line_directive : (string * int) Fmt.t

pp_line_directive pretty-prints a line directive given as a filename and line number.

Accessors

val non_det : t -> Label.non_det option

Whether a block's command or output is non-deterministic.

val directory : t -> string option

directory t is the directory where t tests should be run.

val source_trees : t -> string list

source_trees t is the list of extra source-trees to add as dependency of the code-block.

val file : t -> string option

file t is the name of the file to synchronize t with.

val set_variables : t -> (string * string) list

set_variable t is the list of environment variable to set and their values

val unset_variables : t -> string list

unset_variable t is the list of environment variable to unset

val explicit_required_packages : t -> string list

explicit_required_packages t returns the list of packages explicitly required by the user through require-package labels in the block t.

val required_libraries : t -> (Library.Set.t, string) Result.result

required_libraries t returns the set of libaries that are loaded through #require statements in the block t. Always returns an empty set if t isn't a toplevel block.

val skip : t -> bool

skip t is true iff skip is in the labels of t.

val value : t -> value

value t is t's value.

val section : t -> section option

section t is t's section.

val executable_contents : syntax:Syntax.t -> t -> string list

executable_contents t is either t's contents if t is a raw or a cram block, or t's commands if t is a toplevel fragments (e.g. the phrase result is discarded).

val is_active : ?section:string -> t -> bool

Parsers

val require_from_line : string -> (Library.Set.t, string) Result.result

require_from_line line returns the set of libraries imported by the #require statement on line or an empty set if line is not a require statement.

val require_from_lines : string list -> (Library.Set.t, string) Result.result

Same as require_from_line but aggregated over several lines