Module Sexplib.Sexp_grammar

include Sexp_grammar_intf.Sexp_grammar
module type S = Sexp_grammar_intf.S
include module type of struct include Sexplib0.Sexp_grammar end

This module defines a representation for s-expression grammars. Using ppx_sexp_conv and [@@deriving sexp_grammar] produces a grammar that is compatible with the derived of_sexp for a given type.

As with other derived definitions, polymorphic types derive a function that takes a grammar for each type argument and produces a grammar for the monomorphized type.

Monomorphic types derive a grammar directly. To avoid top-level side effects, [@@deriving sexp_grammar] wraps grammars in the Lazy constructor as needed.

This type may change over time as our needs for expressive grammars change. We will attempt to make changes backward-compatible, or at least provide a reasonable upgrade path.

type grammar = Sexplib0.Sexp_grammar.grammar =
  1. | Any of string
    (*

    accepts any sexp; string is a type name for human readability

    *)
  2. | Bool
    (*

    accepts the atoms "true" or "false", modulo capitalization

    *)
  3. | Char
    (*

    accepts any single-character atom

    *)
  4. | Integer
    (*

    accepts any atom matching ocaml integer syntax, regardless of bit width

    *)
  5. | Float
    (*

    accepts any atom matching ocaml float syntax

    *)
  6. | String
    (*

    accepts any atom

    *)
  7. | Option of grammar
    (*

    accepts an option, both None vs Some _ and () vs (_).

    *)
  8. | List of list_grammar
    (*

    accepts a list

    *)
  9. | Variant of variant
    (*

    accepts clauses keyed by a leading or sole atom

    *)
  10. | Union of grammar list
    (*

    accepts a sexp if any of the listed grammars accepts it

    *)
  11. | Tagged of grammar with_tag
    (*

    annotates a grammar with a client-specific key/value pair

    *)
  12. | Tyvar of string
    (*

    Name of a type variable, e.g. Tyvar "a" for 'a. Only meaningful when the body of the innermost enclosing defn defines a corresponding type variable.

    *)
  13. | Tycon of string * grammar list * defn list
    (*

    Type constructor applied to arguments, and its definition.

    For example, writing Tycon ("tree", [ Integer ], defns) represents int tree, for whatever tree is defined as in defns. The following defines tree as a binary tree with the parameter type stored at the leaves.

    let defns =
  [ { tycon = "tree"
    ; tyvars = ["a"]
    ; grammar =
        Variant
          { name_kind = Capitalized
          ; clauses =
              [ { name = "Node"
                ; args = Cons (Recursive ("node", [Tyvar "a"]), Empty)
                }
              ; { name = "Leaf"
                ; args = Cons (Recursive ("leaf", [Tyvar "a"]), Empty)
                }
              ]
          }
    }
  ; { tycon = "node"
    ; tyvars = ["a"]
    ; grammar = List (Many (Recursive "tree", [Tyvar "a"]))
    }
  ; { tycon = "leaf"
    ; tyvars = ["a"]
    ; grammar = [Tyvar "a"]
    }
  ]
;;

    To illustrate the meaning of Tycon with respect to defns, and to demonstrate one way to access them, it is equivalent to expand the definition of "tree" one level and move the defns to enclosed recursive references:

    Tycon ("tree", [ Integer ], defns)
-->
Variant
  { name_kind = Capitalized
  ; clauses =
      [ { name = "Node"
        ; args = Cons (Tycon ("node", [Tyvar "a"], defns), Empty)
        }
      ; { name = "Leaf"
        ; args = Cons (Tycon ("leaf", [Tyvar "a"], defns), Empty)
        }
      ]
  }

    This transformation exposes the structure of a grammar with recursive references, while preserving the meaning of recursively-defined elements.

    *)
  14. | Recursive of string * grammar list
    (*

    Type constructor applied to arguments. Used to denote recursive type references. Only meaningful when used inside the defns of a Tycon grammar, to refer to a type constructor in the nearest enclosing defn list.

    *)
  15. | Lazy of grammar lazy_t
    (*

    Lazily computed grammar. Use Lazy to avoid top-level side effects. To define recursive grammars, use Recursive instead.

    *)

Grammar of a sexp.

and list_grammar = Sexplib0.Sexp_grammar.list_grammar =
  1. | Empty
    (*

    accepts an empty list of sexps

    *)
  2. | Cons of grammar * list_grammar
    (*

    accepts a non-empty list with head and tail matching the given grammars

    *)
  3. | Many of grammar
    (*

    accepts zero or more sexps, each matching the given grammar

    *)
  4. | Fields of record
    (*

    accepts sexps representing fields of a record

    *)

Grammar of a list of sexps.

and case_sensitivity = Sexplib0.Sexp_grammar.case_sensitivity =
  1. | Case_insensitive
    (*

    Comparison is case insensitive. Used for custom parsers.

    *)
  2. | Case_sensitive
    (*

    Comparison is case sensitive. Used for polymorphic variants.

    *)
  3. | Case_sensitive_except_first_character
    (*

    Comparison is case insensitive for the first character and case sensitive afterward. Used for regular variants.

    *)

Case sensitivity options for names of variant constructors.

and variant = Sexplib0.Sexp_grammar.variant = {
  1. case_sensitivity : case_sensitivity;
  2. clauses : clause with_tag_list list;
}

Grammar of variants. Accepts any sexp matching one of the clauses.

and clause = Sexplib0.Sexp_grammar.clause = {
  1. name : string;
  2. clause_kind : clause_kind;
}

Grammar of a single variant clause. Accepts sexps based on the clause_kind.

and clause_kind = Sexplib0.Sexp_grammar.clause_kind =
  1. | Atom_clause
  2. | List_clause of {
    1. args : list_grammar;
    }

Grammar of a single variant clause's contents. Atom_clause accepts an atom matching the clause's name. List_clause accepts a list whose head is an atom matching the clause's name and whose tail matches args. The clause's name is matched modulo the variant's name_kind.

and record = Sexplib0.Sexp_grammar.record = {
  1. allow_extra_fields : bool;
  2. fields : field with_tag_list list;
}

Grammar of a record. Accepts any list of sexps specifying each of the fields, regardless of order. If allow_extra_fields is specified, ignores sexps with names not found in fields.

and field = Sexplib0.Sexp_grammar.field = {
  1. name : string;
  2. required : bool;
  3. args : list_grammar;
}

Grammar of a record field. A field must show up exactly once in a record if required, or at most once otherwise. Accepts a list headed by name as an atom, followed by sexps matching args.

and 'a with_tag = 'a Sexplib0.Sexp_grammar.with_tag = {
  1. key : string;
  2. value : Sexplib0.Sexp.t;
  3. grammar : 'a;
}

Grammar tagged with client-specific key/value pair.

and 'a with_tag_list = 'a Sexplib0.Sexp_grammar.with_tag_list =
  1. | Tag of 'a with_tag_list with_tag
  2. | No_tag of 'a
and defn = Sexplib0.Sexp_grammar.defn = {
  1. tycon : string;
  2. tyvars : string list;
  3. grammar : grammar;
}

Grammar of a recursive type definition. Names the tycon being defined, and the tyvars it takes as parameters. Specifies the grammar of the tycon. The grammar may refer to any of the tyvars, and to any of the tycons from the same set of Recursive definitions.

type _ t = _ Sexplib0.Sexp_grammar.t = {
  1. untyped : grammar;
}

Top-level grammar type. Has a phantom type parameter to associate each grammar with the type its sexps represent. This makes it harder to apply grammars to the wrong type, while grammars can still be easily coerced to a new type if needed.

val coerce : 'a t -> 'b t
val tag : 'a t -> key:string -> value:Sexplib0.Sexp.t -> 'a0 t
val doc_comment_tag : string

This reserved key is used for all tags generated from doc comments.

val type_name_tag : string

This reserved key can be used to associate a type name with a grammar.

val assoc_tag : string

This reserved key indicates that a sexp represents a key/value association. The tag's value is ignored.

val assoc_key_tag : string

This reserved key indicates that a sexp is a key in a key/value association. The tag's value is ignored.

val assoc_value_tag : string

This reserved key indicates that a sexp is a value in a key/value association. The tag's value is ignored.

val completion_suggested : string

When the key is set to Atom "false" for a variant clause, that clause should not be suggested in auto-completion based on the sexp grammar.

val remember_to_update_these_together : t_of_sexp:(Sexp.t -> 'a) -> t_sexp_grammar:'a t -> (Sexp.t -> 'a) * 'a t

Idiomatic usage looks like this: 

let t_of_sexp, t_sexp_grammar =
  remember_to_update_these_together ~t_of_sexp ~t_sexp_grammar