ppx_expect v0.15.1 · OCaml Package

Concrete syntax tree of expectations and actual outputs

These types represent the contents of an %expect node or of the actual output. We keep information about the original layout so that we can give an corrected expectation that follows the original formatting.

In the following names, blank means ' ' or '\t', while space means blank or newline.

module Line : sig ... end

type 'a single_line = {

leading_blanks : Base.string;
(*
regexp: " \t*"
*)
trailing_spaces : Base.string;
(*
regexp: " \t\n*"
*)
orig : Base.string;
(*
regexp: "^ \t\n(^\n*^ \t\n)?"
*)
data : 'a;

}

Single line represent %expect nodes with data on the first line but not on the subsequent ones.

For instance:

[%expect "  blah "];
[%expect {|  blah
         |}]

val sexp_of_single_line : 
  ('a -> Sexplib0.Sexp.t) ->
  'a single_line ->
  Sexplib0.Sexp.t

val compare_single_line : 
  ('a -> 'a -> Base.int) ->
  'a single_line ->
  'a single_line ->
  Base.int

val equal_single_line : 
  ('a -> 'a -> Base.bool) ->
  'a single_line ->
  'a single_line ->
  Base.bool

type 'a multi_lines = {

leading_spaces : Base.string;
(*
regexp: "\( \t*\n\)*"
*)
trailing_spaces : Base.string;
(*
regexp: " \t*" or "\(\n \t*\)*"
*)
indentation : Base.string;
(*
regexp: " \t*"
*)
lines : 'a Line.t Base.list;
(*
regexp: not_blank (.* not_blank)?
*)

}

Any %expect node with one or more newlines and at least one non-blank line.

This also include the case with exactly one non-blank line such as:

[%expect {|
  blah
|}]

This is to preserve this formatting in case the correction is multi-line.

leading_spaces contains everything until the first non-blank line, while trailing_spaces is either:

trailing blanks on the last line if of the form:

[%expect {|
           abc
           def |}]

all trailing spaces from the newline character (inclusive) on the last non-blank line to the end if of the form:

[%expect {|
           abc
           def
|}]

val sexp_of_multi_lines : 
  ('a -> Sexplib0.Sexp.t) ->
  'a multi_lines ->
  Sexplib0.Sexp.t

val compare_multi_lines : 
  ('a -> 'a -> Base.int) ->
  'a multi_lines ->
  'a multi_lines ->
  Base.int

val equal_multi_lines : 
  ('a -> 'a -> Base.bool) ->
  'a multi_lines ->
  'a multi_lines ->
  Base.bool

type 'a t =

| Empty of Base.string
(*
regexp: " \t\n*"
*)
| Single_line of 'a single_line
| Multi_lines of 'a multi_lines

val sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t

include Base.Exported_for_specific_uses.Ppx_compare_lib.Comparable.S1
  with type 'a t := 'a t

val compare : 
  'a Base__Ppx_compare_lib.compare ->
  'a t Base__Ppx_compare_lib.compare

include Base.Exported_for_specific_uses.Ppx_compare_lib.Equal.S1
  with type 'a t := 'a t

val equal : 'a Base__Ppx_compare_lib.equal -> 'a t Base__Ppx_compare_lib.equal

val invariant : ('a -> Base.unit) -> 'a t -> Base.unit

val empty : 'a t

val map : 'a t -> f:(Base.string -> 'a -> 'b) -> 'b t

val data : 
  'a t ->
  blank:'a ->
  conflict_marker:(Base.string -> 'a) ->
  'a Base.list

val strip : 'a t -> 'a t

val to_string : _ t -> Base.string

val to_lines : 'a t -> 'a Line.t Base.list

For single line expectation, leading blanks and trailing spaces are dropped.

val trim_lines : 'a Line.t Base.list -> 'a Line.t Base.list

Remove blank lines at the beginning and end of the list.

val reconcile : 
  'a t ->
  lines:'a Line.t Base.list ->
  default_indentation:Base.int ->
  pad_single_line:Base.bool ->
  'a t

Given a contents t and a list of lines, try to produce a new contents containing lines but with the same formatting as t.

default_indentation is the indentation to use in case we ignore t's indentation (for instance if t is Single_line or Empty).

val extract_indentation : 
  'a Line.t Base.list ->
  Base.string * 'a Line.t Base.list

Compute the longest indentation of a list of lines and trim it from every line. It returns the found indentation and the list of trimmed lines.

val stripped_original_lines : _ t -> Base.string Base.list

All the .orig fields of Line.t or single_line values, using "" for blank lines.

package ppx_expect