package mdx

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Printers
Accessors
Evaluation
Parsers

package mdx

mdx
- Mdx
  - Block
  - Cram
  - Output
  - Toplevel
mdx.top
- Mdx_top

Legend:
Library
Module
Module type
Parameter
Class
Class type

Code blocks.

type value =

| Raw
| OCaml
| Error of string list
| Cram of {
1. pad : int;
2. tests : Cram.t list;
}
| Toplevel of Toplevel.t list

The type for block values.

type section = int * string

The type for sections.

type t = {

line : int;
file : string;
section : section option;
labels : (string * string option) list;
header : string option;
contents : string list;
value : value;

}

The type for supported code blocks.

Printers

val dump : t Fmt.t

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

val pp_header : t Fmt.t

pp_header pretty-prints block headers.

val pp_contents : t Fmt.t

pp_contents pretty-prints block contents.

val pp_footer : unit Fmt.t

pp_footer pretty-prints block footer.

val pp : 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 mode : t -> [ `Non_det of [ `Command | `Output ] | `Normal ]

mode t is t's mode.

val directory : t -> string option

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

val value : t -> value

value t is t's value.

val section : t -> section option

section t is t's section.

val header : t -> string option

header t is t's header.

val executable_contents : 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).

Evaluation

val eval : t -> t

eval t is the same as t but with it's value replaced by either Cram or Toplevel blocks, depending on t's header.

Parsers

val labels_of_string : string -> (string * string option) list

labels_of_string s cuts s into a list of labels.