Module Ocaml_typing.Includemod

module Error : sig ... end
type explanation = Env.t * Error.all
type field_kind =
  1. | Field_value
  2. | Field_type
  3. | Field_exception
  4. | Field_typext
  5. | Field_module
  6. | Field_modtype
  7. | Field_class
  8. | Field_classtype
type field_desc = {
  1. name : string;
  2. kind : field_kind;
}
val kind_of_field_desc : field_desc -> string
val field_desc : field_kind -> Ident.t -> field_desc
module 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.

val is_runtime_component : Types.signature_item -> bool
type modes = Includecore.mmodes
val modes_unit : modes

The modes used for compilation unit inclusion check

val modes_toplevel : modes

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

val modes_functor_param : Typedtree.mode_with_locks -> modes

Takes the mode of functor argument, returns the modes suitable for modal inclusion check against the parameter.

val modes_functor_res : modes

The modes used for functor result inclusion check

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.

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

val check_modtype_equiv : loc:Ocaml_parsing.Location.t -> Env.t -> Ident.t -> Types.module_type -> Types.module_type -> unit
val signatures : Env.t -> mark:bool -> modes:modes -> Types.signature -> Types.signature -> Typedtree.module_coercion
val include_functor_signatures : Env.t -> mark:bool -> Types.signature -> Types.signature -> (Ident.t * Typedtree.module_coercion) list
val check_implementation : Env.t -> modes:modes -> Types.signature -> Types.signature -> unit

Check an implementation against an interface

val compunit : Env.t -> mark:bool -> string -> Types.signature -> string -> Types.signature -> Shape.t -> Typedtree.module_coercion * Shape.t
val compunit_as_argument : Env.t -> string -> Types.signature -> string -> Types.signature -> Typedtree.module_coercion
val type_declarations : loc:Ocaml_parsing.Location.t -> Env.t -> mark:bool -> Ident.t -> Types.type_declaration -> Types.type_declaration -> unit
val print_coercion : Format.formatter -> Typedtree.module_coercion -> unit
type pos =
  1. | Module of Ident.t
  2. | Modtype of Ident.t
  3. | Arg of Types.functor_parameter
  4. | Body of Types.functor_parameter
exception Error of explanation
type application_name =
  1. | Anonymous_functor
    (*

    (functor (_:sig end) -> struct end)(Int)

    *)
  2. | Full_application_path of Ocaml_parsing.Longident.t
    (*

    F(G(X).P)(Y)

    *)
  3. | Named_leftmost_functor of Ocaml_parsing.Longident.t
    (*

    F(struct end)...(...)

    *)
val expand_module_alias : strengthen:bool -> Env.t -> Path.t -> Types.module_type
module Functor_inclusion_diff : sig ... end
module Functor_app_diff : sig ... end