jon.recoil.org

Module Merlin_kernel.MtyperSource

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.

Sourcetype result
Sourcetype typedtree = [
  1. | `Interface of Ocaml_typing.Typedtree.signature
  2. | `Implementation of Ocaml_typing.Typedtree.structure
]
Sourcetype typer_cache_stats =
  1. | Miss
  2. | Hit of {
    1. reused : int;
    2. typed : int;
    }
Sourceval set_index_items : (index -> Mconfig.t -> [ `Impl of Ocaml_typing.Typedtree.structure_item list | `Intf of Ocaml_typing.Typedtree.signature_item list ] -> index) -> unit
Sourceval get_typedtree : result -> typedtree
Sourceval get_index : result -> index
Sourceval get_stamp : result -> int
Sourceval get_errors : result -> exn list
Sourceval initial_env : result -> Ocaml_typing.Env.t
Sourceval get_cache_stat : result -> typer_cache_stats
Sourceval node_at : ?skip_recovered:bool -> ?let_pun_behavior:Mbrowse.Let_pun_behavior.t -> ?record_pattern_pun_behavior:Mbrowse.Record_pattern_pun_behavior.t -> result -> Lexing.position -> 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.