Module `Typemod`

Type-checking of the module language and typed ast hooks

Warning: this module is unstable and part of compiler-libs.

module Signature_names : sig ... end

val type_module : 
  Env.t ->
  ?expected_mode:Mode.Value.r ->
  Parsetree.module_expr ->
  Typedtree.module_expr * Shape.t

val type_structure : 
  Env.t ->
  ?expected_mode:Mode.Value.r ->
  Parsetree.structure ->
  Typedtree.structure
  * Types.signature
  * Mode.Value.lr
  * Typemod.Signature_names.t
  * Shape.t
  * Env.t

val type_toplevel_phrase : 
  Env.t ->
  Types.signature ->
  Parsetree.structure ->
  Typedtree.structure
  * Types.signature
  * Typemod.Signature_names.t
  * Shape.t
  * Env.t

val type_implementation : 
  Unit_info.t ->
  Compilation_unit.t ->
  Env.t ->
  Parsetree.structure ->
  Typedtree.implementation

val type_interface : 
  sourcefile:string ->
  Compilation_unit.t ->
  Env.t ->
  Parsetree.signature ->
  Typedtree.signature

val check_nongen_signature : Env.t -> Types.signature -> unit

val modtype_of_package : 
  Env.t ->
  Location.t ->
  Path.t ->
  (Longident.t * Types.type_expr) list ->
  Types.module_type

val path_of_module : Typedtree.module_expr -> Path.t option

val save_signature : 
  Unit_info.t ->
  Compilation_unit.t ->
  Typedtree.signature ->
  Env.t ->
  Cmi_format.cmi_infos_lazy ->
  unit

val package_units : 
  Env.t ->
  string list ->
  Unit_info.Artifact.t ->
  Compilation_unit.t ->
  Typedtree.module_coercion

val initial_env : 
  loc:Location.t ->
  initially_opened_module:string option ->
  open_implicit_modules:string list ->
  Env.t

module Sig_component_kind : sig ... end

type hiding_error =

| Illegal_shadowing of {
1. shadowed_item_id : Ident.t;
2. shadowed_item_kind : Typemod.Sig_component_kind.t;
3. shadowed_item_loc : Location.t;
4. shadower_id : Ident.t;
5. user_id : Ident.t;
6. user_kind : Typemod.Sig_component_kind.t;
7. user_loc : Location.t;
}
| Appears_in_signature of {
1. opened_item_id : Ident.t;
2. opened_item_kind : Typemod.Sig_component_kind.t;
3. user_id : Ident.t;
4. user_kind : Typemod.Sig_component_kind.t;
5. user_loc : Location.t;
}

type functor_dependency_error =

| Functor_applied
| Functor_included

type legacy_module =

| Compilation_unit
| Toplevel
| Functor_body

Modules that are required to be legacy mode

type unsupported_modal_module =

| Functor_param
| Functor_res

Places where modes annotations are not supported

type error =

| Cannot_apply of Types.module_type
| Not_included of Includemod.explanation
| Not_included_functor of Includemod.explanation
| Cannot_eliminate_dependency of Typemod.functor_dependency_error * Types.module_type
| Signature_expected
| Structure_expected of Types.module_type
| Functor_expected of Types.module_type
| Signature_parameter_expected of Types.module_type
| Signature_result_expected of Types.module_type
| Recursive_include_functor
| With_no_component of Longident.t
| With_mismatch of Longident.t * Includemod.explanation
| With_makes_applicative_functor_ill_typed of Longident.t * Path.t * Includemod.explanation
| With_changes_module_alias of Longident.t * Ident.t * Path.t
| With_cannot_remove_constrained_type
| With_package_manifest of Longident.t * Types.type_expr
| Repeated_name of Typemod.Sig_component_kind.t * string
| Non_generalizable of {
1. vars : Types.type_expr list;
2. expression : Types.type_expr;
}
| Non_generalizable_module of {
1. vars : Types.type_expr list;
2. item : Types.value_description;
3. mty : Types.module_type;
}
| Implementation_is_required of string
| Interface_not_compiled of string
| Not_allowed_in_functor_body
| Not_includable_in_functor_body
| Not_a_packed_module of Types.type_expr
| Incomplete_packed_module of Types.type_expr
| Scoping_pack of Longident.t * Types.type_expr
| Recursive_module_require_explicit_type
| Apply_generative
| Cannot_scrape_alias of Path.t
| Cannot_scrape_package_type of Path.t
| Badly_formed_signature of string * Typedecl.error
| Cannot_hide_id of Typemod.hiding_error
| Invalid_type_subst_rhs
| Non_packable_local_modtype_subst of Path.t
| With_cannot_remove_packed_modtype of Path.t * Types.module_type
| Strengthening_mismatch of Longident.t * Includemod.explanation
| Cannot_pack_parameter
| Compiling_as_parameterised_parameter
| Cannot_compile_implementation_as_parameter
| Cannot_implement_parameter of Compilation_unit.Name.t * Misc.filepath
| Argument_for_non_parameter of Global_module.Name.t * Misc.filepath
| Cannot_find_argument_type of Global_module.Parameter_name.t
| Inconsistent_argument_types of {
1. new_arg_type : Global_module.Parameter_name.t option;
2. old_arg_type : Global_module.Parameter_name.t option;
3. old_source_file : Misc.filepath;
}
| Duplicate_parameter_name of Global_module.Parameter_name.t
| Submode_failed of Mode.Value.error
| Item_weaker_than_structure of Mode.Value.error
| Unsupported_modal_module of Typemod.unsupported_modal_module
| Legacy_module of Typemod.legacy_module * Mode.Value.error

exception Error of Location.t * Env.t * Typemod.error

exception Error_forward of Location.error

val report_error : Env.t -> loc:Location.t -> Typemod.error -> Location.error

val reset : preserve_persistent_env:bool -> unit

Clear several bits of global state that may retain large amounts of memory after typechecking is finished.

Module Typemod

Module `Typemod`