Typedtree (merlin-lib.merlin-lib.ocaml_typing.Ocaml

By comparison with Parsetree:

Every Longindent.t is accompanied by a resolved Path.t.

module Uid = Shape.Uid

type constant =

| Const_int of int
| Const_char of char
| Const_untagged_char of char
| Const_string of string * Ocaml_parsing.Location.t * string option
| Const_float of string
| Const_float32 of string
| Const_unboxed_float of string
| Const_unboxed_float32 of string
| Const_int8 of int
| Const_int16 of int
| Const_int32 of int32
| Const_int64 of int64
| Const_nativeint of nativeint
| Const_untagged_int of int
| Const_untagged_int8 of int
| Const_untagged_int16 of int
| Const_unboxed_int32 of int32
| Const_unboxed_int64 of int64
| Const_unboxed_nativeint of nativeint

type partial =

| Partial
| Total

Extension points

type attribute = Ocaml_parsing.Parsetree.attribute

type attributes = attribute list

Core language

type value =

| Value_pattern

type computation =

| Computation_pattern

type _ pattern_category =

| Value : value pattern_category
| Computation : computation pattern_category

module Unique_barrier : sig ... end

A unique barrier annotates field accesses (eg. Texp_field and patterns) with the uniqueness mode of the allocation that is projected out of. Projections out of unique allocations may not be pushed down in later stages of the compiler, because the unique allocation may be overwritten.

type unique_use = Mode.Uniqueness.r * Mode.Linearity.l

The uniqueness/linearity of a usage (such as Pexp_ident) inferred by the type checker. It is derived during type checking as follows: unique_use.uniqueness = expected_mode.uniqueness unique_use.linearity = actual_mode.linearity for example, let x = P in f x, (Pexp_ident x).unique_use will contain the expected uniqueness of f's parameter, and linearity of P. uniqueness_analysis.ml will _lexically_ infer the uniqueness/linearity of a usage and compare against unique_use. Following the example, if there are two f x, the uniqueness analysis will perform the following for unique_use of both Pexp_ident x: unique_use.uniqueness >= aliased unique_use.linearity <= many That is, the consumers of the values (that is f) must not require its parameter to be unique, and the value itself (that is P) must be many.

val print_unique_use : Format.formatter -> unique_use -> unit

type alloc_mode = Mode.Alloc.r

type texp_field_boxing =

| Boxing of alloc_mode * unique_use
(*
Projection requires boxing. unique_use describes the usage of the unboxed field as argument to boxing.
*)
| Non_boxing of unique_use
(*
Projection does not require boxing. unique_use describes the usage of the field as the result of direct projection.
*)

val aliased_many_use : unique_use

type pattern = value general_pattern

and 'k general_pattern = 'k pattern_desc pattern_data

and 'a pattern_data = {

pat_desc : 'a;
pat_loc : Ocaml_parsing.Location.t;
pat_extra : (pat_extra * Ocaml_parsing.Location.t * attributes) list;
pat_type : Types.type_expr;
pat_env : Env.t;
pat_attributes : attributes;
pat_unique_barrier : Unique_barrier.t;
(*
This tracks whether the scrutinee of the pattern is used uniquely within the body of the pattern match.
*)

}

and pat_extra =

| Tpat_constraint of core_type
(*
P : T pat_desc = P ; pat_extra = (Tpat_constraint T, _, _) :: ...
*)
| Tpat_type of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc
(*
#tconst pat_desc = disjunction ; pat_extra = (Tpat_type (P, "tconst"), _, _) :: ...
where disjunction is a Tpat_or _ representing the branches of tconst.
*)
| Tpat_open of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Env.t
| Tpat_unpack
(*
(module P) pat_desc = Tpat_var "P" ; pat_extra = (Tpat_unpack, _, _) :: ... (module _) pat_desc = Tpat_any ; pat_extra = (Tpat_unpack, _, _) :: ...
*)

and 'k pattern_desc =

| Tpat_any : value pattern_desc
(*
_
*)
| Tpat_var : Ident.t * string Ocaml_parsing.Asttypes.loc * Uid.t * Jkind_types.Sort.t * Mode.Value.l -> value pattern_desc
(*
x
*)
| Tpat_alias : value general_pattern * Ident.t * string Ocaml_parsing.Asttypes.loc * Uid.t * Jkind_types.Sort.t * Mode.Value.l * Types.type_expr -> value pattern_desc
(*
P as a
*)
| Tpat_constant : constant -> value pattern_desc
(*
1, 'a', "true", 1.0, 1l, 1L, 1n
*)
| Tpat_tuple : (string option * value general_pattern) list -> value pattern_desc
(*
(P1, ..., Pn) (None,P1); ...; (None,Pn)) (L1:P1, ... Ln:Pn) (Some L1,P1); ...; (Some Ln,Pn)) Any mix, e.g. (L1:P1, P2) (Some L1,P1); ...; (None,P2))
Invariant: n >= 2
*)
| Tpat_unboxed_tuple : (string option * value general_pattern * Jkind.sort) list -> value pattern_desc
(*
#(P1, ..., Pn) (None,P1,s1); ...; (None,Pn,sn)) #(L1:P1, ... Ln:Pn) (Some L1,P1,s1); ...; (Some Ln,Pn,sn)) Any mix, e.g. #(L1:P1, P2) (Some L1,P1,s1); ...; (None,P2,s2))
Invariant: n >= 2
*)
| Tpat_construct : Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Types.constructor_description * value general_pattern list * ((Ident.t Ocaml_parsing.Asttypes.loc * Ocaml_parsing.Parsetree.jkind_annotation option) list * core_type) option -> value pattern_desc
(*
C (, None) C P (P, None) C (P1, ..., Pn) (P1; ...; Pn, None) C (P : t) (P, Some (, t)) C (P1, ..., Pn : t) (P1; ...; Pn, Some (, t)) C (type a) (P : t) (P, Some (a, t)) C (type a) (P1, ..., Pn : t) (P1; ...; Pn, Some (a, None, t)) C (type (a : k)) (P1, ..., Pn : t) (P1; ...; Pn, Some (a, Some k, t))
*)
| Tpat_variant : Ocaml_parsing.Asttypes.label * value general_pattern option * Types.row_desc ref -> value pattern_desc
(*
`A (None) `A P (Some P)
See Types.row_desc for an explanation of the last parameter.
*)
| Tpat_record : (Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Types.label_description * value general_pattern) list * Ocaml_parsing.Asttypes.closed_flag -> value pattern_desc
(*
l1=P1; ...; ln=Pn (flag = Closed) l1=P1; ...; ln=Pn; _ (flag = Open)
Invariant: n > 0
*)
| Tpat_record_unboxed_product : (Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Types.unboxed_label_description * value general_pattern) list * Ocaml_parsing.Asttypes.closed_flag -> value pattern_desc
(*
# l1=P1; ...; ln=Pn (flag = Closed) # l1=P1; ...; ln=Pn; _ (flag = Open)
Invariant: n > 0
*)
| Tpat_array : Types.mutability * Jkind.sort * value general_pattern list -> value pattern_desc
(*
| P1; ...; Pn | (flag = Mutable) : P1; ...; Pn : (flag = Immutable)
*)
| Tpat_lazy : value general_pattern -> value pattern_desc
(*
lazy P
*)
| Tpat_value : tpat_value_argument -> computation pattern_desc
(*
P
Invariant: Tpat_value pattern should not carry pat_attributes or pat_extra metadata coming from user syntax, which must be on the inner pattern node -- to facilitate searching for a certain value pattern constructor with a specific attributed.
To enforce this restriction, we made the argument of the Tpat_value constructor a private synonym of pattern, requiring you to use the as_computation_pattern function below instead of using the Tpat_value constructor directly.
*)
| Tpat_exception : value general_pattern -> computation pattern_desc
(*
exception P
*)
| Tpat_or : 'k general_pattern * 'k general_pattern * Types.row_desc option -> 'k pattern_desc
(*
P1 | P2
row_desc = Some _ when translating Ppat_type _, None otherwise.
*)

and tpat_value_argument = private value general_pattern

and expression = {

exp_desc : expression_desc;
exp_loc : Ocaml_parsing.Location.t;
exp_extra : (exp_extra * Ocaml_parsing.Location.t * attributes) list;
exp_type : Types.type_expr;
exp_env : Env.t;
exp_attributes : attributes;

}

and exp_extra =

| Texp_constraint of core_type
(*
E : T
*)
| Texp_coerce of core_type option * core_type
(*
E :> T Texp_coerce (None, T) E : T0 :> T Texp_coerce (Some T0, T)
*)
| Texp_poly of core_type option
(*
Used for method bodies.
*)
| Texp_newtype of Ident.t * string Ocaml_parsing.Asttypes.loc * Ocaml_parsing.Parsetree.jkind_annotation option * Uid.t
(*
fun (type t : immediate) ->
The Ident.t and Uid.t fields are unused by the compiler, but Merlin needs them. Merlin cannot be cleanly patched to include these fields because Merlin must be able to deserialize typedtrees produced by the compiler. Thus, we include them here, as the cost of tracking this additional information is minimal.
*)
| Texp_stack
(*
stack_ E
*)
| Texp_mode of Mode.Alloc.Const.Option.t
(*
E : _ @@ M
*)

and arg_label = Types.arg_label =

| Nolabel
| Labelled of string
| Optional of string
| Position of string

and expression_desc =

| Texp_ident of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Types.value_description * ident_kind * unique_use
(*
x M.x
*)
| Texp_constant of constant
(*
1, 'a', "true", 1.0, 1l, 1L, 1n
*)
| Texp_let of Ocaml_parsing.Asttypes.rec_flag * value_binding list * expression
(*
let P1 = E1 and ... and Pn = EN in E (flag = Nonrecursive) let rec P1 = E1 and ... and Pn = EN in E (flag = Recursive)
*)
| Texp_letmutable of value_binding * expression
(*
let mutable P = E in E'
*)
| Texp_function of {
1. params : function_param list;
2. body : function_body;
3. ret_mode : Mode.Alloc.l;
4. ret_sort : Jkind.sort;
5. alloc_mode : alloc_mode;
6. zero_alloc : Zero_alloc.t;
}
(*
fun P0 P1 -> function p1 -> e1 | p2 -> e2 (body = Tfunction_cases _) fun P0 P1 -> E (body = Tfunction_body _) This construct has the same arity as the originating Pexp_function. Arity determines when side-effects for effectful parameters are run (e.g. optional argument defaults, matching against lazy patterns). Parameters' effects are run left-to-right when an n-ary function is saturated with n arguments.
*)
| Texp_apply of expression * (arg_label * apply_arg) list * apply_position * Mode.Locality.l * Zero_alloc.assume option
(*
E0 ~l1:E1 ... ~ln:En
The expression can be Omitted if the expression is abstracted over this argument. It currently appears when a label is applied.
For example: let f x ~y = x + y in f ~y:3
The resulting typedtree for the application is: Texp_apply (Texp_ident "f/1037", (Nolabel, Omitted _); (Labelled "y", Some (Texp_constant Const_int 3)) )
The Zero_alloc.assume option records the optional @zero_alloc assume attribute that may appear on applications.
*)
| Texp_match of expression * Jkind.sort * computation case list * partial
(*
match E0 with | P1 -> E1 | P2 | exception P3 -> E2 | exception P4 -> E3
Texp_match (E0, sort_of_E0, [(P1, E1); (P2 | exception P3, E2); (exception P4, E3)], _)
*)
| Texp_try of expression * value case list
(*
try E with P1 -> E1 | ... | PN -> EN
*)
| Texp_tuple of (string option * expression) list * alloc_mode
(*
Texp_tuple(el) represents
- (E1, ..., En) when el is (None, E1);...;(None, En),
- (L1:E1, ..., Ln:En) when el is (Some L1, E1);...;(Some Ln, En),
- Any mix, e.g. (L1: E1, E2) when el is (Some L1, E1); (None, E2)
*)
| Texp_unboxed_tuple of (string option * expression * Jkind.sort) list
(*
Texp_unboxed_tuple(el) represents
- #(E1, ..., En) when el is (None, E1, s1);...;(None, En, sn),
- #(L1:E1, ..., Ln:En) when el is (Some L1, E1, s1);...;(Some Ln, En, sn),
- Any mix, e.g. #(L1: E1, E2) when el is (Some L1, E1, s1); (None, E2, s2)
*)
| Texp_construct of Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Types.constructor_description * expression list * alloc_mode option
(*
C C E E C (E1, ..., En) E1;...;En
alloc_mode is the allocation mode of the construct, or None if the constructor is Cstr_unboxed or Cstr_constant, in which case it does not need allocation.
*)
| Texp_variant of Ocaml_parsing.Asttypes.label * (expression * alloc_mode) option
(*
alloc_mode is the allocation mode of the variant, or None if the variant has no argument, in which case it does not need allocation.
*)
| Texp_record of {
1. fields : (Types.label_description * record_label_definition) array;
2. representation : Types.record_representation;
3. extended_expression : (expression * Jkind.sort * Unique_barrier.t) option;
4. alloc_mode : alloc_mode option;
}
(*
l1=P1; ...; ln=Pn (extended_expression = None) E0 with l1=P1; ...; ln=Pn (extended_expression = Some E0)
Invariant: n > 0
If the type is l1: t1; l2: t2 , the expression E0 with t2=P2 is represented as Texp_record fields = [| l1, Kept t1; l2 Override P2 |]; representation; extended_expression = Some E0 alloc_mode is the allocation mode of the record, or None if it is Record_unboxed, in which case it does not need allocation.
*)
| Texp_record_unboxed_product of {
1. fields : (Types.unboxed_label_description * record_label_definition) array;
2. representation : Types.record_unboxed_product_representation;
3. extended_expression : (expression * Jkind.sort) option;
}
(*
# l1=P1; ...; ln=Pn (extended_expression = None) # E0 with l1=P1; ...; ln=Pn (extended_expression = Some E0)
Invariant: n > 0
If the type is # l1: t1; l2: t2 , the expression # E0 with t2=P2 is represented as Texp_record_unboxed_product fields = [| l1, Kept t1; l2 Override P2 |]; representation; extended_expression = Some E0
*)
| Texp_atomic_loc of expression * Jkind.sort * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Types.label_description * alloc_mode
| Texp_field of expression * Jkind.sort * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Types.label_description * texp_field_boxing * Unique_barrier.t
(*
- The sort is the sort of the whole record (which may be non-value if the record is @
  @unboxed
  ).
- texp_field_boxing provides extra information depending on if the projection requires boxing.
*)
| Texp_unboxed_field of expression * Jkind.sort * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Types.unboxed_label_description * unique_use
| Texp_setfield of expression * Mode.Locality.l * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Types.label_description * expression
(*
alloc_mode translates to the modify_mode of the record
*)
| Texp_array of Types.mutability * Jkind.Sort.t * expression list * alloc_mode
| Texp_idx of block_access * unboxed_access list
| Texp_list_comprehension of comprehension
| Texp_array_comprehension of Types.mutability * Jkind.sort * comprehension
| Texp_ifthenelse of expression * expression * expression option
| Texp_sequence of expression * Jkind.sort * expression
| Texp_while of {
1. wh_cond : expression;
2. wh_body : expression;
3. wh_body_sort : Jkind.sort;
}
| Texp_for of {
1. for_id : Ident.t;
2. for_debug_uid : Shape.Uid.t;
3. for_pat : Ocaml_parsing.Parsetree.pattern;
4. for_from : expression;
5. for_to : expression;
6. for_dir : Ocaml_parsing.Asttypes.direction_flag;
7. for_body : expression;
8. for_body_sort : Jkind.sort;
}
| Texp_send of expression * meth * apply_position
| Texp_new of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Types.class_declaration * apply_position
| Texp_instvar of Path.t * Path.t * string Ocaml_parsing.Asttypes.loc
| Texp_mutvar of Ident.t Ocaml_parsing.Asttypes.loc
| Texp_setinstvar of Path.t * Path.t * string Ocaml_parsing.Asttypes.loc * expression
| Texp_setmutvar of Ident.t Ocaml_parsing.Asttypes.loc * Jkind.sort * expression
| Texp_override of Path.t * (Ident.t * string Ocaml_parsing.Asttypes.loc * expression) list
| Texp_letmodule of Ident.t option * string option Ocaml_parsing.Asttypes.loc * Types.module_presence * module_expr * expression
| Texp_letexception of extension_constructor * expression
| Texp_assert of expression * Ocaml_parsing.Location.t
| Texp_lazy of expression
| Texp_object of class_structure * string list
| Texp_pack of module_expr
| Texp_letop of {
1. let_ : binding_op;
2. ands : binding_op list;
3. param : Ident.t;
4. param_debug_uid : Shape.Uid.t;
5. param_sort : Jkind.sort;
6. body : value case;
7. body_sort : Jkind.sort;
8. partial : partial;
}
| Texp_unreachable
| Texp_extension_constructor of Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Path.t
| Texp_open of open_declaration * expression
(*
let open! M in e
*)
| Texp_probe of {
1. name : string;
2. handler : expression;
3. enabled_at_init : bool;
}
| Texp_probe_is_enabled of {
1. name : string;
}
| Texp_exclave of expression
| Texp_src_pos
| Texp_overwrite of expression * expression
(*
overwrite_ exp with exp
*)
| Texp_hole of unique_use
(*
_
*)
| Texp_quotation of expression
| Texp_antiquotation of expression
| Texp_eval of core_type * Jkind.sort
| Texp_typed_hole

Jkinds in the typed tree: Compilation of the typed tree to lambda sometimes requires jkind information. Our approach is to propagate jkind information inward during compilation. This requires us to annotate places in the typed tree where the jkind of a type of a subexpression is not determined by the jkind of the type of the expression containing it. For example, to the left of a semicolon, or in value_bindings.

CR layouts v1.5: Some of these were mainly needed for void (e.g., left of a semicolon). If we redo how void is compiled, perhaps we can drop those. On the other hand, there are some places we're not annotating now (e.g., function arguments) that will need annotations in the future because we'll allow other jkinds there. Just do a rationalization pass on this.

and function_curry =

| More_args of {
1. partial_mode : Mode.Alloc.l;
}
| Final_arg

and function_param = {

fp_arg_label : arg_label;
fp_param : Ident.t;
(*
fp_param is the identifier that is to be used to name the parameter of the function.
*)
fp_param_debug_uid : Shape.Uid.t;
fp_partial : partial;
(*
fp_partial = Partial if the pattern match is partial Total otherwise.
*)
fp_kind : function_param_kind;
fp_sort : Jkind.sort;
fp_mode : Mode.Alloc.l;
fp_curry : function_curry;
fp_newtypes : (Ident.t * string Ocaml_parsing.Asttypes.loc * Ocaml_parsing.Parsetree.jkind_annotation option * Uid.t) list;
(*
fp_newtypes are the new type declarations that come *after* that parameter. The newtypes that come before the first parameter are placed as exp_extras on the Texp_function node. This is just used in Untypeast.
The Ident.t and Uid.t fields are unused by the compiler, but Merlin needs them. Merlin cannot be cleanly patched to include these fields because Merlin must be able to deserialize typedtrees produced by the compiler. Thus, we include them here, as the cost of tracking this additional information is minimal.
*)
fp_loc : Ocaml_parsing.Location.t;
(*
fp_loc is the location of the entire value parameter, not including the fp_newtypes.
*)

}

and function_param_kind =

| Tparam_pat of pattern
(*
Tparam_pat p is a non-optional argument with pattern p.
*)
| Tparam_optional_default of pattern * expression * Jkind.sort
(*
Tparam_optional_default (p, e, sort) is an optional argument p with default value e, i.e. ?x:(p = e). If the parameter is of type a option, the pattern and expression are of type a. sort is the sort of e.
*)

and function_body =

| Tfunction_body of expression
| Tfunction_cases of function_cases
(*
The function body binds a final argument in Tfunction_cases, and this argument is pattern-matched against the cases.
*)

and function_cases = {

fc_cases : value case list;
fc_env : Env.t;
(*
fc_env contains entries from all parameters except for the last one being matched by the cases.
*)
fc_arg_mode : Mode.Alloc.l;
fc_arg_sort : Jkind.sort;
fc_ret_type : Types.type_expr;
fc_partial : partial;
fc_param : Ident.t;
fc_param_debug_uid : Shape.Uid.t;
fc_loc : Ocaml_parsing.Location.t;
fc_exp_extra : exp_extra option;
fc_attributes : attributes;
(*
fc_attributes is just used in untypeast.
*)

}

and ident_kind =

| Id_value
| Id_prim of Mode.Locality.l option * Jkind.Sort.t option

and meth =

| Tmeth_name of string
| Tmeth_val of Ident.t
| Tmeth_ancestor of Ident.t * Path.t

and block_access =

| Baccess_field of Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Types.label_description
| Baccess_array of {
1. mut : Ocaml_parsing.Asttypes.mutable_flag;
2. index_kind : Ocaml_parsing.Asttypes.index_kind;
3. index : expression;
4. base_ty : Types.type_expr;
5. elt_ty : Types.type_expr;
6. elt_sort : Jkind.Sort.t;
}
| Baccess_block of Ocaml_parsing.Asttypes.mutable_flag * expression

and unboxed_access =

| Uaccess_unboxed_field of Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Types.unboxed_label_description

and comprehension = {

comp_body : expression;
comp_clauses : comprehension_clause list;

}

and comprehension_clause =

| Texp_comp_for of comprehension_clause_binding list
| Texp_comp_when of expression

and comprehension_clause_binding = {

comp_cb_iterator : comprehension_iterator;
comp_cb_attributes : attribute list;
(*
No built-in attributes are meaningful here; this would correspond to [body for[@attr] x in xs], and there are no built-in attributes that would be efficacious there. (The only ones that might make sense would be inlining, but you can't do that with list/array items that are being iterated over.)
*)

}

We move the pattern into the comprehension_iterator, compared to the untyped syntax tree, so that range-based iterators can have just an identifier instead of a full pattern

and comprehension_iterator =

| Texp_comp_range of {
1. ident : Ident.t;
2. ident_debug_uid : Shape.Uid.t;
3. pattern : Ocaml_parsing.Parsetree.pattern;
  (*
  Redundant with ident
  *)
4. start : expression;
5. stop : expression;
6. direction : Ocaml_parsing.Asttypes.direction_flag;
}
| Texp_comp_in of {
1. pattern : pattern;
2. sequence : expression;
}

and 'k case = {

c_lhs : 'k general_pattern;
c_guard : expression option;
c_rhs : expression;

}

and record_label_definition =

| Kept of Types.type_expr * Types.mutability * unique_use
| Overridden of Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * expression

and binding_op = {

bop_op_path : Path.t;
bop_op_name : string Ocaml_parsing.Asttypes.loc;
bop_op_val : Types.value_description;
bop_op_type : Types.type_expr;
bop_op_return_sort : Jkind.sort;
bop_exp : expression;
bop_exp_sort : Jkind.sort;
bop_loc : Ocaml_parsing.Location.t;

}

and ('a, 'b) arg_or_omitted =

| Arg of 'a
| Omitted of 'b

and omitted_parameter = {

mode_closure : Mode.Alloc.r;
mode_arg : Mode.Alloc.l;
mode_ret : Mode.Alloc.l;
sort_arg : Jkind.sort;
sort_ret : Jkind.sort;

}

and apply_arg = (expression * Jkind.sort, omitted_parameter) arg_or_omitted

and apply_position =

| Tail
| Nontail
| Default

and class_expr = {

cl_desc : class_expr_desc;
cl_loc : Ocaml_parsing.Location.t;
cl_type : Types.class_type;
cl_env : Env.t;
cl_attributes : attributes;

}

and class_expr_desc =

| Tcl_ident of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * core_type list
| Tcl_structure of class_structure
| Tcl_fun of arg_label * pattern * (Ident.t * expression) list * class_expr * partial
| Tcl_apply of class_expr * (arg_label * apply_arg) list
| Tcl_let of Ocaml_parsing.Asttypes.rec_flag * value_binding list * (Ident.t * expression) list * class_expr
| Tcl_constraint of class_expr * class_type option * string list * string list * Types.MethSet.t
| Tcl_open of open_description * class_expr

and class_structure = {

cstr_self : pattern;
cstr_fields : class_field list;
cstr_type : Types.class_signature;
cstr_meths : Ident.t Types.Meths.t;

}

and class_field = {

cf_desc : class_field_desc;
cf_loc : Ocaml_parsing.Location.t;
cf_attributes : attributes;

}

and class_field_kind =

| Tcfk_virtual of core_type
| Tcfk_concrete of Ocaml_parsing.Asttypes.override_flag * expression

and class_field_desc =

| Tcf_inherit of Ocaml_parsing.Asttypes.override_flag * class_expr * string option * (string * Ident.t) list * (string * Ident.t) list
| Tcf_val of string Ocaml_parsing.Asttypes.loc * Ocaml_parsing.Asttypes.mutable_flag * Ident.t * class_field_kind * bool
| Tcf_method of string Ocaml_parsing.Asttypes.loc * Ocaml_parsing.Asttypes.private_flag * class_field_kind
| Tcf_constraint of core_type * core_type
| Tcf_initializer of expression
| Tcf_attribute of attribute

and held_locks =
  Env.locks * Ocaml_parsing.Longident.t * Ocaml_parsing.Location.t

and mode_with_locks = Mode.Value.l * held_locks option

and module_expr = {

mod_desc : module_expr_desc;
mod_loc : Ocaml_parsing.Location.t;
mod_type : Types.module_type;
mod_mode : mode_with_locks;
(*
The mode of the module. The second component is Some if hold_locks is requested and the module is an identifier.
*)
mod_env : Env.t;
mod_attributes : attributes;

}

and module_type_constraint =

| Tmodtype_implicit
(*
The module type constraint has been synthesized during typechecking.
*)
| Tmodtype_explicit of module_type
(*
The module type was in the source file.
*)

Annotations for Tmod_constraint.

and functor_parameter =

| Unit
| Named of Ident.t option * string option Ocaml_parsing.Asttypes.loc * module_type

and module_expr_desc =

| Tmod_ident of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc
| Tmod_structure of structure
| Tmod_functor of functor_parameter * module_expr
| Tmod_apply of module_expr * module_expr * module_coercion
| Tmod_apply_unit of module_expr
| Tmod_constraint of module_expr * Types.module_type * module_type_constraint * module_coercion
(*
ME (constraint = Tmodtype_implicit) (ME : MT) (constraint = Tmodtype_explicit MT)
*)
| Tmod_unpack of expression * Types.module_type
| Tmod_typed_hole

and structure = {

str_items : structure_item list;
str_type : Types.signature;
str_final_env : Env.t;

}

and structure_item = {

str_desc : structure_item_desc;
str_loc : Ocaml_parsing.Location.t;
str_env : Env.t;

}

and structure_item_desc =

| Tstr_eval of expression * Jkind.sort * attributes
| Tstr_value of Ocaml_parsing.Asttypes.rec_flag * value_binding list
| Tstr_primitive of value_description
| Tstr_type of Ocaml_parsing.Asttypes.rec_flag * type_declaration list
| Tstr_typext of type_extension
| Tstr_exception of type_exception
| Tstr_module of module_binding
| Tstr_recmodule of module_binding list
| Tstr_modtype of module_type_declaration
| Tstr_open of open_declaration
| Tstr_class of (class_declaration * string list) list
| Tstr_class_type of (Ident.t * string Ocaml_parsing.Asttypes.loc * class_type_declaration) list
| Tstr_include of include_declaration
| Tstr_attribute of attribute

and module_binding = {

mb_id : Ident.t option;
(*
None for module _ = struct ... end
*)
mb_name : string option Ocaml_parsing.Asttypes.loc;
mb_uid : Uid.t;
mb_presence : Types.module_presence;
mb_expr : module_expr;
mb_attributes : attributes;
mb_loc : Ocaml_parsing.Location.t;

}

and value_binding = {

vb_pat : pattern;
vb_expr : expression;
vb_rec_kind : Value_rec_types.recursive_binding_kind;
vb_sort : Jkind.sort;
vb_attributes : attributes;
vb_loc : Ocaml_parsing.Location.t;

}

and module_coercion =

| Tcoerce_none
| Tcoerce_structure of {
1. input_repr : Types.module_representation;
2. output_repr : Types.module_representation;
3. pos_cc_list : (int * module_coercion) list;
4. id_pos_list : (Ident.t * int * module_coercion) list;
}
| Tcoerce_functor of module_coercion * module_coercion
| Tcoerce_primitive of primitive_coercion
(*
External declaration coerced to a regular value.
```
  module M : sig val ext : a -> b end =
  struct external ext : a -> b = "my_c_function" end
```
Only occurs inside a Tcoerce_structure coercion.
*)
| Tcoerce_alias of Env.t * Path.t * module_coercion
(*
Module alias coerced to a regular module.
```
  module M : sig module Sub : T end =
  struct module Sub = Some_alias end
```
Only occurs inside a Tcoerce_structure coercion.
*)

and module_type = {

mty_desc : module_type_desc;
mty_type : Types.module_type;
mty_env : Env.t;
mty_loc : Ocaml_parsing.Location.t;
mty_attributes : attributes;

}

and module_type_desc =

| Tmty_ident of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc
| Tmty_signature of signature
| Tmty_functor of functor_parameter * module_type
| Tmty_with of module_type * (Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * with_constraint) list
| Tmty_typeof of module_expr
| Tmty_alias of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc
| Tmty_strengthen of module_type * Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc

and primitive_coercion = {

pc_desc : Primitive.description;
pc_type : Types.type_expr;
pc_poly_mode : Mode.Locality.l option;
pc_poly_sort : Jkind.Sort.t option;
pc_env : Env.t;
pc_loc : Ocaml_parsing.Location.t;

}

and signature = {

sig_items : signature_item list;
sig_modalities : Mode.Modality.Const.t;
sig_type : Types.signature;
sig_final_env : Env.t;
sig_sloc : Ocaml_parsing.Location.t;

}

and signature_item = {

sig_desc : signature_item_desc;
sig_env : Env.t;
sig_loc : Ocaml_parsing.Location.t;

}

and signature_item_desc =

| Tsig_value of value_description
| Tsig_type of Ocaml_parsing.Asttypes.rec_flag * type_declaration list
| Tsig_typesubst of type_declaration list
| Tsig_typext of type_extension
| Tsig_exception of type_exception
| Tsig_module of module_declaration
| Tsig_modsubst of module_substitution
| Tsig_recmodule of module_declaration list
| Tsig_modtype of module_type_declaration
| Tsig_modtypesubst of module_type_declaration
| Tsig_open of open_description
| Tsig_include of include_description * Mode.Modality.Const.t
| Tsig_class of class_description list
| Tsig_class_type of class_type_declaration list
| Tsig_attribute of attribute

and module_declaration = {

md_id : Ident.t option;
md_name : string option Ocaml_parsing.Asttypes.loc;
md_uid : Uid.t;
md_presence : Types.module_presence;
md_type : module_type;
md_modalities : Mode.Modality.t;
md_attributes : attributes;
md_loc : Ocaml_parsing.Location.t;

}

and module_substitution = {

ms_id : Ident.t;
ms_name : string Ocaml_parsing.Asttypes.loc;
ms_uid : Uid.t;
ms_manifest : Path.t;
ms_txt : Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc;
ms_attributes : attributes;
ms_loc : Ocaml_parsing.Location.t;

}

and module_type_declaration = {

mtd_id : Ident.t;
mtd_name : string Ocaml_parsing.Asttypes.loc;
mtd_uid : Uid.t;
mtd_type : module_type option;
mtd_attributes : attributes;
mtd_loc : Ocaml_parsing.Location.t;

}

and 'a open_infos = {

open_expr : 'a;
open_bound_items : Types.signature;
open_items_repr : Types.module_representation;
open_override : Ocaml_parsing.Asttypes.override_flag;
open_env : Env.t;
open_loc : Ocaml_parsing.Location.t;
open_attributes : attribute list;

}

and open_description =
  (Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc) open_infos

and open_declaration = module_expr open_infos

and include_kind =

| Tincl_structure
| Tincl_functor of {
1. input_coercion : (Ident.t * module_coercion) list;
2. input_repr : Types.module_representation;
}
| Tincl_gen_functor of {
1. input_coercion : (Ident.t * module_coercion) list;
2. input_repr : Types.module_representation;
}

and 'a include_infos = {

incl_mod : 'a;
incl_type : Types.signature;
incl_repr : Types.module_representation;
incl_loc : Ocaml_parsing.Location.t;
incl_kind : include_kind;
incl_attributes : attribute list;

}

and include_description = module_type include_infos

and include_declaration = module_expr include_infos

and with_constraint =

| Twith_type of type_declaration
| Twith_module of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc
| Twith_modtype of module_type
| Twith_typesubst of type_declaration
| Twith_modsubst of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc
| Twith_modtypesubst of module_type

and core_type = {

mutable ctyp_desc : core_type_desc;
(*
mutable because of Typeclass.declare_method
*)
mutable ctyp_type : Types.type_expr;
(*
mutable because of Typeclass.declare_method
*)
ctyp_env : Env.t;
ctyp_loc : Ocaml_parsing.Location.t;
ctyp_attributes : attributes;

}

and core_type_desc =

| Ttyp_var of string option * Ocaml_parsing.Parsetree.jkind_annotation option
| Ttyp_arrow of arg_label * core_type * core_type
| Ttyp_tuple of (string option * core_type) list
| Ttyp_unboxed_tuple of (string option * core_type) list
| Ttyp_constr of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * core_type list
| Ttyp_object of object_field list * Ocaml_parsing.Asttypes.closed_flag
| Ttyp_class of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * core_type list
| Ttyp_alias of core_type * string Ocaml_parsing.Asttypes.loc option * Ocaml_parsing.Parsetree.jkind_annotation option
| Ttyp_variant of row_field list * Ocaml_parsing.Asttypes.closed_flag * Ocaml_parsing.Asttypes.label list option
| Ttyp_poly of (string * Ocaml_parsing.Parsetree.jkind_annotation option) list * core_type
| Ttyp_package of package_type
| Ttyp_open of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * core_type
| Ttyp_quote of core_type
| Ttyp_splice of core_type
| Ttyp_of_kind of Ocaml_parsing.Parsetree.jkind_annotation
| Ttyp_call_pos
(*
Ttyp_call_pos represents the type of the value of a Position argument (lbl:[%call_pos] -> ...).
*)

and package_type = {

pack_path : Path.t;
pack_fields : (Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * core_type) list;
pack_type : Types.module_type;
pack_txt : Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc;

}

and row_field = {

rf_desc : row_field_desc;
rf_loc : Ocaml_parsing.Location.t;
rf_attributes : attributes;

}

and row_field_desc =

| Ttag of string Ocaml_parsing.Asttypes.loc * bool * core_type list
| Tinherit of core_type

and object_field = {

of_desc : object_field_desc;
of_loc : Ocaml_parsing.Location.t;
of_attributes : attributes;

}

and object_field_desc =

| OTtag of string Ocaml_parsing.Asttypes.loc * core_type
| OTinherit of core_type

and value_description = {

val_id : Ident.t;
val_name : string Ocaml_parsing.Asttypes.loc;
val_desc : core_type;
val_val : Types.value_description;
val_prim : string list;
val_loc : Ocaml_parsing.Location.t;
val_attributes : attributes;

}

and type_declaration = {

typ_id : Ident.t;
typ_name : string Ocaml_parsing.Asttypes.loc;
typ_params : (core_type * (Ocaml_parsing.Asttypes.variance * Ocaml_parsing.Asttypes.injectivity)) list;
typ_type : Types.type_declaration;
typ_cstrs : (core_type * core_type * Ocaml_parsing.Location.t) list;
typ_kind : type_kind;
typ_private : Ocaml_parsing.Asttypes.private_flag;
typ_manifest : core_type option;
typ_loc : Ocaml_parsing.Location.t;
typ_attributes : attributes;
typ_jkind_annotation : Ocaml_parsing.Parsetree.jkind_annotation option;

}

and type_kind =

| Ttype_abstract
| Ttype_variant of constructor_declaration list
| Ttype_record of label_declaration list
| Ttype_record_unboxed_product of label_declaration list
| Ttype_open

and label_declaration = {

ld_id : Ident.t;
ld_name : string Ocaml_parsing.Asttypes.loc;
ld_uid : Uid.t;
ld_mutable : Types.mutability;
ld_modalities : Mode.Modality.Const.t;
ld_type : core_type;
ld_loc : Ocaml_parsing.Location.t;
ld_attributes : attributes;

}

and constructor_declaration = {

cd_id : Ident.t;
cd_name : string Ocaml_parsing.Asttypes.loc;
cd_uid : Uid.t;
cd_vars : (string * Ocaml_parsing.Parsetree.jkind_annotation option) list;
cd_args : constructor_arguments;
cd_res : core_type option;
cd_loc : Ocaml_parsing.Location.t;
cd_attributes : attributes;

}

and constructor_argument = {

ca_modalities : Mode.Modality.Const.t;
ca_type : core_type;
ca_loc : Ocaml_parsing.Location.t;

}

and constructor_arguments =

| Cstr_tuple of constructor_argument list
| Cstr_record of label_declaration list

and type_extension = {

tyext_path : Path.t;
tyext_txt : Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc;
tyext_params : (core_type * (Ocaml_parsing.Asttypes.variance * Ocaml_parsing.Asttypes.injectivity)) list;
tyext_constructors : extension_constructor list;
tyext_private : Ocaml_parsing.Asttypes.private_flag;
tyext_loc : Ocaml_parsing.Location.t;
tyext_attributes : attributes;

}

and type_exception = {

tyexn_constructor : extension_constructor;
tyexn_loc : Ocaml_parsing.Location.t;
tyexn_attributes : attribute list;

}

and extension_constructor = {

ext_id : Ident.t;
ext_name : string Ocaml_parsing.Asttypes.loc;
ext_type : Types.extension_constructor;
ext_kind : extension_constructor_kind;
ext_loc : Ocaml_parsing.Location.t;
ext_attributes : attributes;

}

and extension_constructor_kind =

| Text_decl of (string * Ocaml_parsing.Parsetree.jkind_annotation option) list * constructor_arguments * core_type option
| Text_rebind of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc

and class_type = {

cltyp_desc : class_type_desc;
cltyp_type : Types.class_type;
cltyp_env : Env.t;
cltyp_loc : Ocaml_parsing.Location.t;
cltyp_attributes : attributes;

}

and class_type_desc =

| Tcty_constr of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * core_type list
| Tcty_signature of class_signature
| Tcty_arrow of arg_label * core_type * class_type
| Tcty_open of open_description * class_type

and class_signature = {

csig_self : core_type;
csig_fields : class_type_field list;
csig_type : Types.class_signature;

}

and class_type_field = {

ctf_desc : class_type_field_desc;
ctf_loc : Ocaml_parsing.Location.t;
ctf_attributes : attributes;

}

and class_type_field_desc =

| Tctf_inherit of class_type
| Tctf_val of string * Ocaml_parsing.Asttypes.mutable_flag * Ocaml_parsing.Asttypes.virtual_flag * core_type
| Tctf_method of string * Ocaml_parsing.Asttypes.private_flag * Ocaml_parsing.Asttypes.virtual_flag * core_type
| Tctf_constraint of core_type * core_type
| Tctf_attribute of attribute

and class_declaration = class_expr class_infos

and class_description = class_type class_infos

and class_type_declaration = class_type class_infos

and 'a class_infos = {

ci_virt : Ocaml_parsing.Asttypes.virtual_flag;
ci_params : (core_type * (Ocaml_parsing.Asttypes.variance * Ocaml_parsing.Asttypes.injectivity)) list;
ci_id_name : string Ocaml_parsing.Asttypes.loc;
ci_id_class : Ident.t;
ci_id_class_type : Ident.t;
ci_id_object : Ident.t;
ci_expr : 'a;
ci_decl : Types.class_declaration;
ci_type_decl : Types.class_type_declaration;
ci_loc : Ocaml_parsing.Location.t;
ci_attributes : attributes;

}

type argument_interface = {

ai_signature : Types.signature;
ai_coercion_from_primary : module_coercion;

}

For a module M compiled with -as-argument-for P for some parameter module P, the signature of P along with the coercion from M's exported signature (the _primary interface_) to P's signature (the _argument interface_).

type implementation = {

structure : structure;
coercion : module_coercion;
signature : Types.signature;
argument_interface : argument_interface option;
shape : Shape.t;

}

A typechecked implementation including its module structure, its exported signature, and a coercion of the module against that signature.

If an .mli file is present, the signature will come from that file and be the exported signature of the module.

If there isn't one, the signature will be inferred from the module structure.

If the module is compiled with -as-argument-for and is thus typechecked against the .mli for a parameter in addition to its own .mli, it has an additional signature stored in argument_interface.

type item_declaration =

| Value of value_description
| Value_binding of value_binding
| Type of type_declaration
| Constructor of constructor_declaration
| Extension_constructor of extension_constructor
| Label of label_declaration
| Module of module_declaration
| Module_substitution of module_substitution
| Module_binding of module_binding
| Module_type of module_type_declaration
| Class of class_declaration
| Class_type of class_type_declaration
(*
item_declaration groups together items that correspond to the syntactic category of "declarations" which include types, values, modules, etc. declarations in signatures and their definitions in implementations.
*)

val as_computation_pattern : pattern -> computation general_pattern

as_computation_pattern p is a computation pattern with description Tpat_value p, which enforces a correct placement of pat_attributes and pat_extra metadata (on the inner value pattern, rather than on the computation pattern).

val classify_pattern_desc : 'k pattern_desc -> 'k pattern_category

val classify_pattern : 'k general_pattern -> 'k pattern_category

type pattern_action = {

f : 'k. 'k general_pattern -> unit;

}

val shallow_iter_pattern_desc : pattern_action -> 'k pattern_desc -> unit

type pattern_transformation = {

f : 'k. 'k general_pattern -> 'k general_pattern;

}

val shallow_map_pattern_desc : 
  pattern_transformation ->
  'k pattern_desc ->
  'k pattern_desc

val iter_general_pattern : pattern_action -> 'k general_pattern -> unit

val iter_pattern : (pattern -> unit) -> pattern -> unit

type pattern_predicate = {

f : 'k. 'k general_pattern -> bool;

}

val exists_general_pattern : pattern_predicate -> 'k general_pattern -> bool

val exists_pattern : (pattern -> bool) -> pattern -> bool

val let_bound_idents : value_binding list -> Ident.t list

val let_bound_idents_with_sorts : 
  value_binding list ->
  (Ident.t * Jkind.Sort.t) list

val let_bound_idents_full : 
  value_binding list ->
  (Ident.t
   * string Ocaml_parsing.Asttypes.loc
   * Types.type_expr
   * Jkind.Sort.t
   * Uid.t)
    list

val let_bound_idents_with_modes_sorts_and_checks : 
  value_binding list ->
  (Ident.t
   * (Ocaml_parsing.Location.t * Mode.Value.l * Jkind.sort) list
   * Zero_alloc.t)
    list

val alpha_pat : 
  (Ident.t * Ident.t) list ->
  'k general_pattern ->
  'k general_pattern

Alpha conversion of patterns

val mknoloc : 'a -> 'a Ocaml_parsing.Asttypes.loc

val mkloc : 'a -> Ocaml_parsing.Location.t -> 'a Ocaml_parsing.Asttypes.loc

val pat_bound_idents : 'k general_pattern -> Ident.t list

val pat_bound_idents_full : 
  'k general_pattern ->
  (Ident.t
   * string Ocaml_parsing.Asttypes.loc
   * Types.type_expr
   * Ocaml_typing.Types.Uid.t
   * Jkind.Sort.Const.t)
    list

val split_pattern : 
  computation general_pattern ->
  pattern option * pattern option

Splits an or pattern into its value (left) and exception (right) parts.

val exp_is_nominal : expression -> bool

Whether an expression looks nice as the subject of a sentence in a error message.

val function_arity : function_param list -> function_body -> int

Calculates the syntactic arity of a function based on its parameters and body.

val loc_of_decl : 
  uid:Shape.Uid.t ->
  item_declaration ->
  string Ocaml_parsing.Location.loc

Given a declaration, return the location of the bound identifier

val min_mode_with_locks : mode_with_locks

When type checking F(M).t, which does not involve modes, we say F(M) is of the strongest mode, to avoid modes in error messages.

val mode_without_locks_exn : mode_with_locks -> Mode.Value.l

Get the mode, asserting no held locks.

val fold_antiquote_exp : ('a -> expression -> 'a) -> 'a -> expression -> 'a

Fold over the antiquotations in an expression. This function defines the evaluation order of antiquotations.