Module `Ocaml_typing.Includemod`Source

Sourcemodule Error : sig ... end

Sourcetype explanation = Env.t * Error.all

Sourcetype field_kind =

| Field_value
| Field_type
| Field_exception
| Field_typext
| Field_module
| Field_modtype
| Field_class
| Field_classtype
| Field_jkind

Sourcetype field_desc = {

name : string;
kind : field_kind;

}

Sourceval kind_of_field_desc : field_desc -> string

Sourceval field_desc : field_kind -> Ident.t -> field_desc

Sourcemodule FieldMap : Map.S with type key = field_desc

Map indexed by both field types and names. This avoids name clashes between different sorts of fields such as values and types.

Source

val item_ident_name : 
  Types.signature_item ->
  Ident.t * Ocaml_parsing.Location.t * field_desc

Sourceval is_runtime_component : Types.signature_item -> bool

Sourcetype modes = Includecore.mmodes

Sourceval modes_toplevel : modes

The modes used for top-level inclusion check, where top-level is similiar to a structure

Source

val modtypes : 
  loc:Ocaml_parsing.Location.t ->
  Env.t ->
  mark:bool ->
  modes:modes ->
  Types.module_type ->
  Types.module_type ->
  Typedtree.module_coercion

Source

val modtypes_constraint : 
  shape:Shape.t ->
  loc:Ocaml_parsing.Location.t ->
  Env.t ->
  mark:bool ->
  modes:modes ->
  Types.module_type ->
  Types.module_type ->
  Typedtree.module_coercion * Shape.t

modtypes_constraint ~shape ~loc env ~mark exp_modtype constraint_modtype checks that exp_modtype is a subtype of constraint_modtype, and returns the module coercion and the shape of the constrained module. It also marks as used paired items in positive position in exp_modtype, and also paired items in negative position in constraint_modtype. This marking in negative position allows to raise an unused item warning whenever an item in a functor parameter in constraint_modtype does not exist in exp_modtypes. This behaviour differs from the one in check_implementation and compunit which assumes that is not appropriate to raise warning about the interface file while typechecking the implementation file.

Source

val strengthened_module_decl : 
  loc:Ocaml_parsing.Location.t ->
  aliasable:bool ->
  Env.t ->
  mark:bool ->
  mmodes:modes ->
  Types.module_declaration ->
  Path.t ->
  Types.module_declaration ->
  Typedtree.module_coercion

Source

val check_functor_application : 
  loc:Ocaml_parsing.Location.t ->
  Env.t ->
  Types.module_type ->
  Path.t ->
  Types.module_type ->
  explanation option

check_functor_application ~loc env mty1 path1 mty2 checks that the functor application F(M) is well typed, where mty2 is the type of the argument of F and path1/mty1 is the path/unstrenghened type of M.

Source

val check_modtype_equiv : 
  loc:Ocaml_parsing.Location.t ->
  Env.t ->
  Ident.t ->
  Types.module_type ->
  Types.module_type ->
  unit

Source

val signatures : 
  Env.t ->
  mark:bool ->
  modes:modes ->
  Types.signature ->
  Types.signature ->
  Typedtree.module_coercion

Source

val include_functor_signatures : 
  Env.t ->
  mark:bool ->
  Types.signature ->
  Types.signature ->
  modes:modes ->
  (Ident.t * Typedtree.module_coercion) list

Source

val check_implementation : 
  Env.t ->
  modes:modes ->
  Types.signature ->
  Types.signature ->
  unit

Check an implementation against an interface

Source

val compunit : 
  Env.t ->
  mark:bool ->
  string ->
  modes:modes ->
  Types.signature ->
  string ->
  Types.signature ->
  Shape.t ->
  Typedtree.module_coercion * Shape.t

Source

val compunit_as_argument : 
  Env.t ->
  string ->
  modes:modes ->
  Types.signature ->
  string ->
  Types.signature ->
  Typedtree.module_coercion

Source

val type_declarations : 
  loc:Ocaml_parsing.Location.t ->
  Env.t ->
  mark:bool ->
  Ident.t ->
  Types.type_declaration ->
  Types.type_declaration ->
  unit

Source

val jkind_declarations : 
  loc:Ocaml_parsing.Location.t ->
  Env.t ->
  mark:bool ->
  Ident.t ->
  Types.jkind_declaration ->
  Types.jkind_declaration ->
  unit

Sourceval print_coercion : Format.formatter -> Typedtree.module_coercion -> unit

Sourcetype pos =

| Module of Ident.t
| Modtype of Ident.t
| Arg of Types.functor_parameter
| Body of Types.functor_parameter

Sourceexception Error of explanation

Sourcetype application_name =

| Anonymous_functor
(*
(functor (_:sig end) -> struct end)(Int)
*)
| Full_application_path of Ocaml_parsing.Longident.t
(*
F(G(X).P)(Y)
*)
| Named_leftmost_functor of Ocaml_parsing.Longident.t
(*
F(struct end)...(...)
*)

Sourceexception Apply_error of {

loc : Ocaml_parsing.Location.t;
env : Env.t;
app_name : application_name;
mty_f : Types.module_type;
args : (Error.functor_arg_descr * Types.module_type * Typedtree.mode_with_locks) list;

}

Source

val expand_module_alias : 
  strengthen:bool ->
  Env.t ->
  Path.t ->
  Types.module_type

Sourcemodule Functor_inclusion_diff : sig ... end

Sourcemodule Functor_app_diff : sig ... end

Module Ocaml_typing.IncludemodSource

Module `Ocaml_typing.Includemod`Source