Module `Ocaml_typing.Subst`Source

Substitutions

Substitutions are used to translate a type from one context to another. This requires substituting paths for identifiers, and possibly also lowering the level of non-generic variables so that they are inferior to the maximum level of the new context.

Substitutions can also be used to create a "clean" copy of a type. Indeed, non-variable node of a type are duplicated, with their levels set to generic level. That way, the resulting type is well-formed (decreasing levels), even if the original one was not.

In the presence of local substitutions for module types, a substitution for a type expression may fail to produce a well-formed type. In order to confine this issue to local substitutions, the type of substitutions is split into a safe and unsafe variant. Only unsafe substitutions may expand a module type path into a generic module type.

Sourcetype +'k subst

Type familly for substitutions

Sourcetype safe = [

| `Safe

]

Sourcetype unsafe = [

| `Unsafe

]

Sourcetype t = safe subst

Standard substitution

Sourceval identity : 'a subst

Sourceval unsafe : t -> unsafe subst

Sourceval add_type : Ident.t -> Path.t -> 'k subst -> 'k subst

Sourceval add_module : Ident.t -> Path.t -> 'k subst -> 'k subst

Sourceval add_modtype : Ident.t -> Path.t -> 'k subst -> 'k subst

Sourceval for_saving : t -> t

Sourceval make_loc_ghost : t -> t

Sourceval reset_for_saving : unit -> unit

Sourceval change_locs : 'k subst -> Ocaml_parsing.Location.t -> 'k subst

Sourceval module_path : t -> Path.t -> Path.t

Sourceval type_path : t -> Path.t -> Path.t

Sourceval modtype_path : t -> Path.t -> Path.t

Sourceval type_expr : t -> Types.type_expr -> Types.type_expr

Sourceval class_type : t -> Types.class_type -> Types.class_type

Sourceval value_description : t -> Types.value_description -> Types.value_description

Sourceval type_declaration : t -> Types.type_declaration -> Types.type_declaration

Source

val extension_constructor : 
  t ->
  Types.extension_constructor ->
  Types.extension_constructor

Sourceval class_declaration : t -> Types.class_declaration -> Types.class_declaration

Source

val cltype_declaration : 
  t ->
  Types.class_type_declaration ->
  Types.class_type_declaration

When applied to a signature item, a substitution not only modifies the types present in its declaration, but also refreshes the identifier of the item. Effectively this creates new declarations, and so one should decide what the scope of this new declaration should be.

This is decided by the scoping argument passed to the following functions.

Sourcetype scoping =

| Keep
| Make_local
| Rescope of int

Sourceval modtype : scoping -> t -> Types.module_type -> Types.module_type

Sourceval signature : scoping -> t -> Types.signature -> Types.signature

Source

val signature_item : 
  scoping ->
  t ->
  Types.signature_item ->
  Types.signature_item

Source

val modtype_declaration : 
  scoping ->
  t ->
  Types.modtype_declaration ->
  Types.modtype_declaration

Source

val module_declaration : 
  scoping ->
  t ->
  Types.module_declaration ->
  Types.module_declaration

Sourceval compose : t -> t -> t

Composition of substitutions: apply (compose s1 s2) x = apply s2 (apply s1 x) *

Sourcemodule Unsafe : sig ... end

Sourcemodule Lazy : sig ... end

Install

Dune Dependency

Authors

Maintainers

Sources

doc/merlin-lib.ocaml_typing/Ocaml_typing/Subst/index.html

Module `Ocaml_typing.Subst`Source

package merlin-lib

Install

Dune Dependency

Authors

Maintainers

Sources

doc/merlin-lib.ocaml_typing/Ocaml_typing/Subst/index.html

Module Ocaml_typing.SubstSource

Module `Ocaml_typing.Subst`Source