package merlin-lib

  1. Overview
  2. Docs
package merlin-lib
Legend:
Library
Module
Module type
Parameter
Class
Class type

Abstract syntax tree after typing

By comparison with Parsetree:

  • Every Longindent.t is accompanied by a resolved Path.t.
type partial =
  1. | Partial
  2. | Total

Extension points

type attributes = attribute list

Core language

type value =
  1. | Value_pattern
type computation =
  1. | Computation_pattern
type _ pattern_category =
  1. | Value : value pattern_category
  2. | Computation : computation pattern_category
type pattern = value general_pattern
and 'k general_pattern = 'k pattern_desc pattern_data
and 'a pattern_data = {
  1. pat_desc : 'a;
  2. pat_loc : Ocaml_parsing.Location.t;
  3. pat_extra : (pat_extra * Ocaml_parsing.Location.t * attributes) list;
  4. pat_type : Types.type_expr;
  5. pat_env : Env.t;
  6. pat_attributes : attributes;
}
and pat_extra =
  1. | Tpat_constraint of core_type
    (*

    P : T pat_desc = P ; pat_extra = (Tpat_constraint T, _, _) :: ...

    *)
  2. | 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.

    *)
  3. | Tpat_open of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Env.t
  4. | Tpat_unpack
    (*

    (module P) pat_desc = Tpat_var "P" ; pat_extra = (Tpat_unpack, _, _) :: ...

    *)
and 'k pattern_desc =
  1. | Tpat_any : value pattern_desc
    (*

    _

    *)
  2. | Tpat_var : Ident.t * string Ocaml_parsing.Asttypes.loc -> value pattern_desc
    (*

    x

    *)
  3. | Tpat_alias : value general_pattern * Ident.t * string Ocaml_parsing.Asttypes.loc -> value pattern_desc
    (*

    P as a

    *)
  4. | Tpat_constant : Ocaml_parsing.Asttypes.constant -> value pattern_desc
    (*

    1, 'a', "true", 1.0, 1l, 1L, 1n

    *)
  5. | Tpat_tuple : value general_pattern list -> value pattern_desc
    (*

    (P1, ..., Pn)

    Invariant: n >= 2

    *)
  6. | Tpat_construct : Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Types.constructor_description * value general_pattern list * (Ident.t Ocaml_parsing.Asttypes.loc 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, t))

    *)
  7. | 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.

    *)
  8. | 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

    *)
  9. | Tpat_array : value general_pattern list -> value pattern_desc
    (*

    | P1; ...; Pn |

    *)
  10. | Tpat_lazy : value general_pattern -> value pattern_desc
    (*

    lazy P

    *)
  11. | 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.

    *)
  12. | Tpat_exception : value general_pattern -> computation pattern_desc
    (*

    exception P

    *)
  13. | 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 = {
  1. exp_desc : expression_desc;
  2. exp_loc : Ocaml_parsing.Location.t;
  3. exp_extra : (exp_extra * Ocaml_parsing.Location.t * attributes) list;
  4. exp_type : Types.type_expr;
  5. exp_env : Env.t;
  6. exp_attributes : attributes;
}
and exp_extra =
  1. | Texp_constraint of core_type
    (*

    E : T

    *)
  2. | Texp_coerce of core_type option * core_type
    (*

    E :> T Texp_coerce (None, T) E : T0 :> T Texp_coerce (Some T0, T)

    *)
  3. | Texp_poly of core_type option
    (*

    Used for method bodies.

    *)
  4. | Texp_newtype of string
    (*

    fun (type t) ->

    *)
  5. | Texp_newtype' of Ident.t * Ocaml_parsing.Asttypes.label Ocaml_parsing.Asttypes.loc
    (*

    merlin-specific: keep enough information to correctly implement occurrences for local-types. Merlin typechecker uses Texp_newtype' constructor, while upstream OCaml still uses Texp_newtype. Those can appear when unmarshaling cmt files. By adding a new constructor, we can still safely uses these.

    *)
and expression_desc =
  1. | Texp_ident of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Types.value_description
    (*

    x M.x

    *)
  2. | Texp_constant of Ocaml_parsing.Asttypes.constant
    (*

    1, 'a', "true", 1.0, 1l, 1L, 1n

    *)
  3. | 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)

    *)
  4. | Texp_function of {
    1. arg_label : Ocaml_parsing.Asttypes.arg_label;
    2. param : Ident.t;
    3. cases : value case list;
    4. partial : partial;
    }
    (*

    Pexp_fun and Pexp_function both translate to Texp_function. See Parsetree for more details.

    param is the identifier that is to be used to name the parameter of the function.

    partial = Partial if the pattern match is partial Total otherwise.

    *)
  5. | Texp_apply of expression * (Ocaml_parsing.Asttypes.arg_label * expression option) list
    (*

    E0 ~l1:E1 ... ~ln:En

    The expression can be None 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, None); (Labelled "y", Some (Texp_constant Const_int 3)) )

    *)
  6. | Texp_match of expression * computation case list * partial
    (*

    match E0 with | P1 -> E1 | P2 | exception P3 -> E2 | exception P4 -> E3

    Texp_match (E0, [(P1, E1); (P2 | exception P3, E2); (exception P4, E3)], _)

    *)
  7. | Texp_try of expression * value case list
    (*

    try E with P1 -> E1 | ... | PN -> EN

    *)
  8. | Texp_tuple of expression list
    (*

    (E1, ..., EN)

    *)
  9. | Texp_construct of Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Types.constructor_description * expression list
    (*

    C C E E C (E1, ..., En) E1;...;En

    *)
  10. | Texp_variant of Ocaml_parsing.Asttypes.label * expression option
  11. | Texp_record of {
    1. fields : (Types.label_description * record_label_definition) array;
    2. representation : Types.record_representation;
    3. extended_expression : expression 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

    *)
  12. | Texp_field of expression * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Types.label_description
  13. | Texp_setfield of expression * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Types.label_description * expression
  14. | Texp_array of expression list
  15. | Texp_ifthenelse of expression * expression * expression option
  16. | Texp_sequence of expression * expression
  17. | Texp_while of expression * expression
  18. | Texp_for of Ident.t * Ocaml_parsing.Parsetree.pattern * expression * expression * Ocaml_parsing.Asttypes.direction_flag * expression
  19. | Texp_send of expression * meth
  20. | Texp_new of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Types.class_declaration
  21. | Texp_instvar of Path.t * Path.t * string Ocaml_parsing.Asttypes.loc
  22. | Texp_setinstvar of Path.t * Path.t * string Ocaml_parsing.Asttypes.loc * expression
  23. | Texp_override of Path.t * (Ident.t * string Ocaml_parsing.Asttypes.loc * expression) list
  24. | Texp_letmodule of Ident.t option * string option Ocaml_parsing.Asttypes.loc * Types.module_presence * module_expr * expression
  25. | Texp_letexception of extension_constructor * expression
  26. | Texp_assert of expression
  27. | Texp_lazy of expression
  28. | Texp_object of class_structure * string list
  29. | Texp_pack of module_expr
  30. | Texp_letop of {
    1. let_ : binding_op;
    2. ands : binding_op list;
    3. param : Ident.t;
    4. body : value case;
    5. partial : partial;
    }
  31. | Texp_unreachable
  32. | Texp_extension_constructor of Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * Path.t
  33. | Texp_open of open_declaration * expression
    (*

    let open! M in e

    *)
  34. | Texp_hole
and meth =
  1. | Tmeth_name of string
  2. | Tmeth_val of Ident.t
  3. | Tmeth_ancestor of Ident.t * Path.t
and 'k case = {
  1. c_lhs : 'k general_pattern;
  2. c_guard : expression option;
  3. c_rhs : expression;
}
and record_label_definition =
  1. | Kept of Types.type_expr
  2. | Overridden of Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * expression
and binding_op = {
  1. bop_op_path : Path.t;
  2. bop_op_name : string Ocaml_parsing.Asttypes.loc;
  3. bop_op_val : Types.value_description;
  4. bop_op_type : Types.type_expr;
  5. bop_exp : expression;
  6. bop_loc : Ocaml_parsing.Location.t;
}
and class_expr = {
  1. cl_desc : class_expr_desc;
  2. cl_loc : Ocaml_parsing.Location.t;
  3. cl_type : Types.class_type;
  4. cl_env : Env.t;
  5. cl_attributes : attributes;
}
and class_expr_desc =
  1. | Tcl_ident of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * core_type list
  2. | Tcl_structure of class_structure
  3. | Tcl_fun of Ocaml_parsing.Asttypes.arg_label * pattern * (Ident.t * expression) list * class_expr * partial
  4. | Tcl_apply of class_expr * (Ocaml_parsing.Asttypes.arg_label * expression option) list
  5. | Tcl_let of Ocaml_parsing.Asttypes.rec_flag * value_binding list * (Ident.t * expression) list * class_expr
  6. | Tcl_constraint of class_expr * class_type option * string list * string list * Types.MethSet.t
  7. | Tcl_open of open_description * class_expr
and class_structure = {
  1. cstr_self : pattern;
  2. cstr_fields : class_field list;
  3. cstr_type : Types.class_signature;
  4. cstr_meths : Ident.t Types.Meths.t;
}
and class_field = {
  1. cf_desc : class_field_desc;
  2. cf_loc : Ocaml_parsing.Location.t;
  3. cf_attributes : attributes;
}
and class_field_kind =
  1. | Tcfk_virtual of core_type
  2. | Tcfk_concrete of Ocaml_parsing.Asttypes.override_flag * expression
and class_field_desc =
  1. | Tcf_inherit of Ocaml_parsing.Asttypes.override_flag * class_expr * string option * (string * Ident.t) list * (string * Ident.t) list
  2. | Tcf_val of string Ocaml_parsing.Asttypes.loc * Ocaml_parsing.Asttypes.mutable_flag * Ident.t * class_field_kind * bool
  3. | Tcf_method of string Ocaml_parsing.Asttypes.loc * Ocaml_parsing.Asttypes.private_flag * class_field_kind
  4. | Tcf_constraint of core_type * core_type
  5. | Tcf_initializer of expression
  6. | Tcf_attribute of attribute
and module_expr = {
  1. mod_desc : module_expr_desc;
  2. mod_loc : Ocaml_parsing.Location.t;
  3. mod_type : Types.module_type;
  4. mod_env : Env.t;
  5. mod_attributes : attributes;
}
and module_type_constraint =
  1. | Tmodtype_implicit
    (*

    The module type constraint has been synthesized during typechecking.

    *)
  2. | Tmodtype_explicit of module_type
    (*

    The module type was in the source file.

    *)

Annotations for Tmod_constraint.

and functor_parameter =
  1. | Unit
  2. | Named of Ident.t option * string option Ocaml_parsing.Asttypes.loc * module_type
and module_expr_desc =
  1. | Tmod_ident of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc
  2. | Tmod_structure of structure
  3. | Tmod_functor of functor_parameter * module_expr
  4. | Tmod_apply of module_expr * module_expr * module_coercion
  5. | Tmod_constraint of module_expr * Types.module_type * module_type_constraint * module_coercion
    (*

    ME (constraint = Tmodtype_implicit) (ME : MT) (constraint = Tmodtype_explicit MT)

    *)
  6. | Tmod_unpack of expression * Types.module_type
  7. | Tmod_hole
and structure = {
  1. str_items : structure_item list;
  2. str_type : Types.signature;
  3. str_final_env : Env.t;
}
and structure_item = {
  1. str_desc : structure_item_desc;
  2. str_loc : Ocaml_parsing.Location.t;
  3. str_env : Env.t;
}
and structure_item_desc =
  1. | Tstr_eval of expression * attributes
  2. | Tstr_value of Ocaml_parsing.Asttypes.rec_flag * value_binding list
  3. | Tstr_primitive of value_description
  4. | Tstr_type of Ocaml_parsing.Asttypes.rec_flag * type_declaration list
  5. | Tstr_typext of type_extension
  6. | Tstr_exception of type_exception
  7. | Tstr_module of module_binding
  8. | Tstr_recmodule of module_binding list
  9. | Tstr_modtype of module_type_declaration
  10. | Tstr_open of open_declaration
  11. | Tstr_class of (class_declaration * string list) list
  12. | Tstr_class_type of (Ident.t * string Ocaml_parsing.Asttypes.loc * class_type_declaration) list
  13. | Tstr_include of include_declaration
  14. | Tstr_attribute of attribute
and module_binding = {
  1. mb_id : Ident.t option;
  2. mb_name : string option Ocaml_parsing.Asttypes.loc;
  3. mb_presence : Types.module_presence;
  4. mb_expr : module_expr;
  5. mb_attributes : attributes;
  6. mb_loc : Ocaml_parsing.Location.t;
}
and value_binding = {
  1. vb_pat : pattern;
  2. vb_expr : expression;
  3. vb_attributes : attributes;
  4. vb_loc : Ocaml_parsing.Location.t;
}
and module_coercion =
  1. | Tcoerce_none
  2. | Tcoerce_structure of (int * module_coercion) list * (Ident.t * int * module_coercion) list
  3. | Tcoerce_functor of module_coercion * module_coercion
  4. | Tcoerce_primitive of primitive_coercion
  5. | Tcoerce_alias of Env.t * Path.t * module_coercion
and module_type = {
  1. mty_desc : module_type_desc;
  2. mty_type : Types.module_type;
  3. mty_env : Env.t;
  4. mty_loc : Ocaml_parsing.Location.t;
  5. mty_attributes : attributes;
}
and primitive_coercion = {
  1. pc_desc : Primitive.description;
  2. pc_type : Types.type_expr;
  3. pc_env : Env.t;
  4. pc_loc : Ocaml_parsing.Location.t;
}
and signature = {
  1. sig_items : signature_item list;
  2. sig_type : Types.signature;
  3. sig_final_env : Env.t;
}
and signature_item = {
  1. sig_desc : signature_item_desc;
  2. sig_env : Env.t;
  3. sig_loc : Ocaml_parsing.Location.t;
}
and signature_item_desc =
  1. | Tsig_value of value_description
  2. | Tsig_type of Ocaml_parsing.Asttypes.rec_flag * type_declaration list
  3. | Tsig_typesubst of type_declaration list
  4. | Tsig_typext of type_extension
  5. | Tsig_exception of type_exception
  6. | Tsig_module of module_declaration
  7. | Tsig_modsubst of module_substitution
  8. | Tsig_recmodule of module_declaration list
  9. | Tsig_modtype of module_type_declaration
  10. | Tsig_modtypesubst of module_type_declaration
  11. | Tsig_open of open_description
  12. | Tsig_include of include_description
  13. | Tsig_class of class_description list
  14. | Tsig_class_type of class_type_declaration list
  15. | Tsig_attribute of attribute
and module_declaration = {
  1. md_id : Ident.t option;
  2. md_name : string option Ocaml_parsing.Asttypes.loc;
  3. md_presence : Types.module_presence;
  4. md_type : module_type;
  5. md_attributes : attributes;
  6. md_loc : Ocaml_parsing.Location.t;
}
and module_substitution = {
  1. ms_id : Ident.t;
  2. ms_name : string Ocaml_parsing.Asttypes.loc;
  3. ms_manifest : Path.t;
  4. ms_txt : Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc;
  5. ms_attributes : attributes;
  6. ms_loc : Ocaml_parsing.Location.t;
}
and module_type_declaration = {
  1. mtd_id : Ident.t;
  2. mtd_name : string Ocaml_parsing.Asttypes.loc;
  3. mtd_type : module_type option;
  4. mtd_attributes : attributes;
  5. mtd_loc : Ocaml_parsing.Location.t;
}
and 'a open_infos = {
  1. open_expr : 'a;
  2. open_bound_items : Types.signature;
  3. open_override : Ocaml_parsing.Asttypes.override_flag;
  4. open_env : Env.t;
  5. open_loc : Ocaml_parsing.Location.t;
  6. open_attributes : attribute list;
}
and open_declaration = module_expr open_infos
and 'a include_infos = {
  1. incl_mod : 'a;
  2. incl_type : Types.signature;
  3. incl_loc : Ocaml_parsing.Location.t;
  4. incl_attributes : attribute list;
}
and include_description = module_type include_infos
and include_declaration = module_expr include_infos
and with_constraint =
  1. | Twith_type of type_declaration
  2. | Twith_module of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc
  3. | Twith_modtype of module_type
  4. | Twith_typesubst of type_declaration
  5. | Twith_modsubst of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc
  6. | Twith_modtypesubst of module_type
and core_type = {
  1. mutable ctyp_desc : core_type_desc;
    (*

    mutable because of Typeclass.declare_method

    *)
  2. mutable ctyp_type : Types.type_expr;
    (*

    mutable because of Typeclass.declare_method

    *)
  3. ctyp_env : Env.t;
  4. ctyp_loc : Ocaml_parsing.Location.t;
  5. ctyp_attributes : attributes;
}
and core_type_desc =
  1. | Ttyp_any
  2. | Ttyp_var of string
  3. | Ttyp_arrow of Ocaml_parsing.Asttypes.arg_label * core_type * core_type
  4. | Ttyp_tuple of core_type list
  5. | Ttyp_constr of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * core_type list
  6. | Ttyp_object of object_field list * Ocaml_parsing.Asttypes.closed_flag
  7. | Ttyp_class of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * core_type list
  8. | Ttyp_alias of core_type * string
  9. | Ttyp_variant of row_field list * Ocaml_parsing.Asttypes.closed_flag * Ocaml_parsing.Asttypes.label list option
  10. | Ttyp_poly of string list * core_type
  11. | Ttyp_package of package_type
and row_field = {
  1. rf_desc : row_field_desc;
  2. rf_loc : Ocaml_parsing.Location.t;
  3. rf_attributes : attributes;
}
and row_field_desc =
  1. | Ttag of string Ocaml_parsing.Asttypes.loc * bool * core_type list
  2. | Tinherit of core_type
and object_field = {
  1. of_desc : object_field_desc;
  2. of_loc : Ocaml_parsing.Location.t;
  3. of_attributes : attributes;
}
and object_field_desc =
  1. | OTtag of string Ocaml_parsing.Asttypes.loc * core_type
  2. | OTinherit of core_type
and value_description = {
  1. val_id : Ident.t;
  2. val_name : string Ocaml_parsing.Asttypes.loc;
  3. val_desc : core_type;
  4. val_val : Types.value_description;
  5. val_prim : string list;
  6. val_loc : Ocaml_parsing.Location.t;
  7. val_attributes : attributes;
}
and type_declaration = {
  1. typ_id : Ident.t;
  2. typ_name : string Ocaml_parsing.Asttypes.loc;
  3. typ_params : (core_type * (Ocaml_parsing.Asttypes.variance * Ocaml_parsing.Asttypes.injectivity)) list;
  4. typ_type : Types.type_declaration;
  5. typ_cstrs : (core_type * core_type * Ocaml_parsing.Location.t) list;
  6. typ_kind : type_kind;
  7. typ_private : Ocaml_parsing.Asttypes.private_flag;
  8. typ_manifest : core_type option;
  9. typ_loc : Ocaml_parsing.Location.t;
  10. typ_attributes : attributes;
}
and type_kind =
  1. | Ttype_abstract
  2. | Ttype_variant of constructor_declaration list
  3. | Ttype_record of label_declaration list
  4. | Ttype_open
and label_declaration = {
  1. ld_id : Ident.t;
  2. ld_name : string Ocaml_parsing.Asttypes.loc;
  3. ld_mutable : Ocaml_parsing.Asttypes.mutable_flag;
  4. ld_type : core_type;
  5. ld_loc : Ocaml_parsing.Location.t;
  6. ld_attributes : attributes;
}
and constructor_declaration = {
  1. cd_id : Ident.t;
  2. cd_name : string Ocaml_parsing.Asttypes.loc;
  3. cd_vars : string Ocaml_parsing.Asttypes.loc list;
  4. cd_args : constructor_arguments;
  5. cd_res : core_type option;
  6. cd_loc : Ocaml_parsing.Location.t;
  7. cd_attributes : attributes;
}
and constructor_arguments =
  1. | Cstr_tuple of core_type list
  2. | Cstr_record of label_declaration list
and type_extension = {
  1. tyext_path : Path.t;
  2. tyext_txt : Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc;
  3. tyext_params : (core_type * (Ocaml_parsing.Asttypes.variance * Ocaml_parsing.Asttypes.injectivity)) list;
  4. tyext_constructors : extension_constructor list;
  5. tyext_private : Ocaml_parsing.Asttypes.private_flag;
  6. tyext_loc : Ocaml_parsing.Location.t;
  7. tyext_attributes : attributes;
}
and type_exception = {
  1. tyexn_constructor : extension_constructor;
  2. tyexn_loc : Ocaml_parsing.Location.t;
  3. tyexn_attributes : attribute list;
}
and extension_constructor = {
  1. ext_id : Ident.t;
  2. ext_name : string Ocaml_parsing.Asttypes.loc;
  3. ext_type : Types.extension_constructor;
  4. ext_kind : extension_constructor_kind;
  5. ext_loc : Ocaml_parsing.Location.t;
  6. ext_attributes : attributes;
}
and extension_constructor_kind =
  1. | Text_decl of string Ocaml_parsing.Asttypes.loc list * constructor_arguments * core_type option
  2. | Text_rebind of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc
and class_type = {
  1. cltyp_desc : class_type_desc;
  2. cltyp_type : Types.class_type;
  3. cltyp_env : Env.t;
  4. cltyp_loc : Ocaml_parsing.Location.t;
  5. cltyp_attributes : attributes;
}
and class_type_desc =
  1. | Tcty_constr of Path.t * Ocaml_parsing.Longident.t Ocaml_parsing.Asttypes.loc * core_type list
  2. | Tcty_signature of class_signature
  3. | Tcty_arrow of Ocaml_parsing.Asttypes.arg_label * core_type * class_type
  4. | Tcty_open of open_description * class_type
and class_signature = {
  1. csig_self : core_type;
  2. csig_fields : class_type_field list;
  3. csig_type : Types.class_signature;
}
and class_type_field = {
  1. ctf_desc : class_type_field_desc;
  2. ctf_loc : Ocaml_parsing.Location.t;
  3. ctf_attributes : attributes;
}
and class_type_field_desc =
  1. | Tctf_inherit of class_type
  2. | Tctf_val of string * Ocaml_parsing.Asttypes.mutable_flag * Ocaml_parsing.Asttypes.virtual_flag * core_type
  3. | Tctf_method of string * Ocaml_parsing.Asttypes.private_flag * Ocaml_parsing.Asttypes.virtual_flag * core_type
  4. | Tctf_constraint of core_type * core_type
  5. | 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 = {
  1. ci_virt : Ocaml_parsing.Asttypes.virtual_flag;
  2. ci_params : (core_type * (Ocaml_parsing.Asttypes.variance * Ocaml_parsing.Asttypes.injectivity)) list;
  3. ci_id_name : string Ocaml_parsing.Asttypes.loc;
  4. ci_id_class : Ident.t;
  5. ci_id_class_type : Ident.t;
  6. ci_id_object : Ident.t;
  7. ci_id_typehash : Ident.t;
  8. ci_expr : 'a;
  9. ci_decl : Types.class_declaration;
  10. ci_type_decl : Types.class_type_declaration;
  11. ci_loc : Ocaml_parsing.Location.t;
  12. ci_attributes : attributes;
}
type implementation = {
  1. structure : structure;
  2. coercion : module_coercion;
  3. signature : Types.signature;
  4. 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.

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 = {
  1. f : 'k. 'k general_pattern -> unit;
}
val shallow_iter_pattern_desc : pattern_action -> 'k pattern_desc -> unit
type pattern_transformation = {
  1. 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 = {
  1. 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_full : value_binding list -> (Ident.t * string Ocaml_parsing.Asttypes.loc * Types.type_expr) 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 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) list
val split_pattern : computation general_pattern -> pattern option * pattern option

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

val unpack_functor_me : module_expr -> functor_parameter * module_expr
val unpack_functor_mty : module_type -> functor_parameter * module_type
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct