Module `Merlin_kernel.Mtyper`

Result of typechecker

Mtyper essentially produces a typedtree, but to make sense of it the OCaml typechecker need to be in a specific state.

The result type wraps a snapshot of this state with the typedtree to ensure correct accesses.

type result

type typedtree = [

| `Interface of Ocaml_typing.Typedtree.signature
| `Implementation of Ocaml_typing.Typedtree.structure

]

type typer_cache_stats =

| Miss
| Hit of {
1. reused : int;
2. typed : int;
}

type index =
  Ocaml_parsing.Longident.t Ocaml_parsing.Location.loc list
    Ocaml_typing.Shape.Uid.Map.t

val set_index_items : 
  (Merlin_kernel.Mtyper.index ->
    Merlin_kernel.Mconfig.t ->
    [ `Impl of Ocaml_typing.Typedtree.structure_item list
    | `Intf of Ocaml_typing.Typedtree.signature_item list ] ->
    Merlin_kernel.Mtyper.index) ->
  unit

val run : 
  Merlin_kernel.Mconfig.t ->
  Merlin_kernel.Mreader.parsetree ->
  Merlin_kernel.Mtyper.result

val get_env : 
  ?pos:Merlin_kernel.Msource.position ->
  Merlin_kernel.Mtyper.result ->
  Ocaml_typing.Env.t

val get_typedtree : 
  Merlin_kernel.Mtyper.result ->
  Merlin_kernel.Mtyper.typedtree

val get_index : Merlin_kernel.Mtyper.result -> Merlin_kernel.Mtyper.index

val get_stamp : Merlin_kernel.Mtyper.result -> int

val get_errors : Merlin_kernel.Mtyper.result -> exn list

val initial_env : Merlin_kernel.Mtyper.result -> Ocaml_typing.Env.t

val get_cache_stat : 
  Merlin_kernel.Mtyper.result ->
  Merlin_kernel.Mtyper.typer_cache_stats

val node_at : 
  ?skip_recovered:bool ->
  ?let_pun_behavior:Merlin_kernel.Mbrowse.Let_pun_behavior.t ->
  Merlin_kernel.Mtyper.result ->
  Stdlib.Lexing.position ->
  Merlin_kernel.Mbrowse.t

Heuristic to find suitable environment to complete / type at given position. * 1. Try to find environment near given cursor. * 2. Check if there is an invalid construct between found env and cursor : * Case a. * > let x = valid_expr || * The env found is the right most env from valid_expr, it's a correct * answer. * Case b. * > let x = valid_expr * > let y = invalid_construction|| * In this case, the env found is the same as in case a, however it is * preferable to use env from enclosing module rather than an env from * inside x definition.

Module Merlin_kernel.Mtyper

Result of typechecker

Module `Merlin_kernel.Mtyper`