package mdx

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Printers
Accessors
Helpers

package mdx

mdx
- Library mdx
  - Mdx
    
    Lexer_mdx
    
    Output
    
    Cram
    
    Deprecated
    
    Document
    
    Toplevel
    
    Part
    
    Block
    
    Header
    
    Raw
    
    Mli_parser
    
    Compat
    
    Util
    
    Result
    
    Infix
    
    List
    
    File
    
    Option
    
    List
    
    String
    
    Sexp
    
    Csexp
    
    Array
    
    Process
    
    Int
    
    Seq
    
    Prelude
    
    Syntax
    
    Label
    
    Relation
    
    Dep
    
    Ocaml_env
    
    Set
    
    Stable_printer
    
    Location
- Library mdx.test
  - Mdx_test
    
    Package
    
    Predicate
- Library mdx.top
  - Mdx_top
- Sources
  - mdx
    
    block.ml
    
    compat.ml
    
    cram.ml
    
    dep.ml
    
    deprecated.ml
    
    document.ml
    
    label.ml
    
    lexer_cram.ml
    
    lexer_mdx.ml
    
    lexer_top.ml
    
    library.ml
    
    mdx.ml
    
    mdx__.ml
    
    misc.ml
    
    mli_parser.ml
    
    ocaml_env.ml
    
    output.ml
    
    part.ml
    
    pp.ml
    
    prelude.ml
    
    stable_printer.ml
    
    syntax.ml
    
    toplevel.ml
    
    util.ml
  - mdx.test
    
    mdx_test.ml
  - mdx.top
    
    compat_top.ml
    
    mdx_top.ml
    
    mdx_top__.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Mdx.Block`Source

Code blocks headers.

Sourcemodule Header : sig ... end

Code blocks.

Sourcetype cram_value = {

language : [ `Bash | `Sh ];
non_det : Label.non_det option;

}

Sourcetype ocaml_value = {

env : Ocaml_env.t;
(*
env is the name given to the environment where tests are run.
*)
non_det : Label.non_det option;
errors : Output.t list;
(*
header defines whether a header was specified for the block.
*)
header : Header.t option;

}

Sourcetype toplevel_value = {

env : Ocaml_env.t;
(*
env is the name given to the environment where tests are run.
*)
non_det : Label.non_det option;

}

Sourcetype include_ocaml_file = {

part_included : string option;
(*
part_included is the part of the file to synchronize with. If lines is not specified synchronize the whole file.
*)

}

Sourcetype include_other_file = {

header : Header.t option;

}

Sourcetype include_file_kind =

| Fk_ocaml of include_ocaml_file
| Fk_other of include_other_file

Sourcetype include_value = {

file_included : string;
(*
file_included is the name of the file to synchronize with.
*)
file_kind : include_file_kind;

}

Sourcetype raw_value = {

header : Header.t option;

}

Sourcetype value =

| Raw of raw_value
| OCaml of ocaml_value
| Cram of cram_value
| Toplevel of toplevel_value
| Include of include_value

The type for block values.

Sourcetype section = int * string

The type for sections.

Sourcemodule Raw : sig ... end

Sourcetype t = {

loc : Location.t;
section : section option;
dir : string option;
labels : Label.t list;
legacy_labels : bool;
contents : string list;
skip : bool;
version_enabled : bool;
(*
Whether the current OCaml version complies with the block's version.
*)
set_variables : (string * string) list;
unset_variables : string list;
value : value;

}

The type for supported code blocks.

Source

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

Source

val mk_include : 
  loc:Location.t ->
  section:section option ->
  labels:Label.t list ->
  (t, [ `Msg of string ]) result

mk_include builds an include block from a comment  that is not followed by a code block ``` ... ```.

Sourceval from_raw : Raw.t -> (t, [ `Msg of string ] list) Result.result

Printers

Sourceval dump : t Fmt.t

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

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

pp_header pretty-prints full block headers with the labels.

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

pp_contents pretty-prints block contents.

Sourceval pp_footer : ?syntax:Syntax.t -> t Fmt.t

pp_footer pretty-prints block footer.

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

pp pretty-prints blocks.

Accessors

Sourceval non_det : t -> Label.non_det option

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

Sourceval directory : t -> string option

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

Sourceval file : t -> string option

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

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

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

Sourceval unset_variables : t -> string list

unset_variable t is the list of environment variable to unset

Sourceval skip : t -> bool

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

Sourceval value : t -> value

value t is t's value.

Sourceval section : t -> section option

section t is t's section.

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

Helpers

Sourceval ends_by_semi_semi : string list -> bool

package mdx

Module Mdx.BlockSource

Printers

Accessors

Helpers

Module `Mdx.Block`Source