package merlin-lib

  1. Overview
  2. Docs
Merlin's libraries

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (18)

Authors

  1. T
    The Merlin team

Maintainers

  1. D
    defree@gmail.com

Sources

merlin-5.8-505.tbz
sha256=5642cde8486a84aad98fa5c590b70e8dcc6074d7fbdb3b9b8c46b2c5b42f653b
sha512=1d7a7751157e393d3ae248ef5ae24a6b4e81430666c61cc51a3d0ec35804523317036f3d7a3c7f18a7554337f4e5f5989fb677865b261ece3fd2b317903570ba

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

Module Ocaml_typing.ErrortraceSource

Sourcetype position =
  1. | First
  2. | Second
Sourcetype order =
  1. | Less
  2. | Equal
  3. | More
Sourceval swap_position : position -> position
Sourceval swap_order : order -> order
Sourcetype expanded_type = {
  1. ty : Types.type_expr;
  2. expanded : Types.type_expr;
}
Sourceval trivial_expansion : Types.type_expr -> expanded_type

trivial_expansion ty creates an expanded_type whose expansion is also ty. Usually, you want Ctype.expand_type instead, since the expansion carries useful information; however, in certain circumstances, the error is about the expansion of the type, meaning that actually performing the expansion produces more confusing or inaccurate output.

Sourcetype 'a diff = {
  1. got : 'a;
  2. expected : 'a;
}
Sourceval map_diff : ('a -> 'b) -> 'a diff -> 'b diff

map_diff f {expected;got} is {expected=f expected; got=f got}

Sourcetype 'a escape_kind =
  1. | Constructor of Path.t
  2. | Univ of Types.type_expr
  3. | Self
  4. | Module_type of Path.t
  5. | Module of Ident.t
  6. | Equation of 'a
  7. | Constraint

Scope escape related errors

Sourcetype 'a escape = {
  1. kind : 'a escape_kind;
  2. context : Types.type_expr option;
}
Sourceval map_escape : ('a -> 'b) -> 'a escape -> 'b escape
Sourceval explain : 'a list -> (prev:'a option -> 'a -> 'b option) -> 'b option
Sourcetype unification = private
  1. | Unification

Type indices

Sourcetype comparison = private
  1. | Comparison
Sourcetype fixed_row_case =
  1. | Cannot_be_closed
  2. | Cannot_add_tags of string list
Sourcetype 'variety variant =
  1. | Incompatible_types_for : string -> _ variant
  2. | No_tags : position * (Ocaml_parsing.Asttypes.label * Types.row_field) list -> _ variant
  3. | No_intersection : unification variant
  4. | Fixed_row : position * fixed_row_case * Types.fixed_explanation -> unification variant
  5. | Presence_not_guaranteed_for : position * string -> comparison variant
  6. | Openness : position -> comparison variant
Sourcetype 'variety obj =
  1. | Missing_field : position * string -> _ obj
  2. | Abstract_row : position -> _ obj
  3. | Self_cannot_be_closed : unification obj
Sourcetype first_class_module =
  1. | Package_cannot_scrape of Path.t
  2. | Package_inclusion of Ocaml_utils.Format_doc.doc
  3. | Package_coercion of Ocaml_utils.Format_doc.doc
Sourcetype univar =
  1. | Var_mismatch of {
    1. order : order;
    2. diff : Types.type_expr diff;
    }
  2. | Quantification_mismatch of Types.type_expr list
Sourcetype ('a, 'variety) elt =
  1. | Diff : 'a diff -> ('a, _) elt
  2. | Variant : 'variety variant -> ('a, 'variety) elt
  3. | Obj : 'variety obj -> ('a, 'variety) elt
  4. | Escape : 'a escape -> ('a, _) elt
  5. | Function_label_mismatch of Ocaml_parsing.Asttypes.arg_label diff
  6. | Tuple_label_mismatch of string option diff
  7. | Incompatible_fields : {
    1. name : string;
    2. diff : Types.type_expr diff;
    } -> ('a, _) elt
  8. | First_class_module : first_class_module -> ('a, _) elt
  9. | Univar of univar
  10. | Rec_occur : Types.type_expr * Types.type_expr -> ('a, _) elt
Sourcetype ('a, 'variety) t = ('a, 'variety) elt list
Sourcetype 'variety trace = (Types.type_expr, 'variety) t
Sourcetype 'variety error = (expanded_type, 'variety) t
Sourceval map_types : (Types.type_expr -> Types.type_expr) -> (expanded_type, 'variety) t -> (expanded_type, 'variety) t

merlin specific

Sourceval map : ('a -> 'b) -> ('a, 'variety) t -> ('b, 'variety) t
Sourceval incompatible_fields : name:string -> got:Types.type_expr -> expected:Types.type_expr -> (Types.type_expr, _) elt
Sourceval swap_trace : ('a, 'variety) t -> ('a, 'variety) t

The traces ('variety t) are the core error types. However, we bundle them up into three "top-level" error types, which are used elsewhere: unification_error, equality_error, and moregen_error. In the case of equality_error, this has to bundle in extra information; in general, it distinguishes the three types of errors and allows us to distinguish traces that are being built (or processed) from those that are complete and have become the final error. These error types have the invariants that their traces are nonempty; we ensure that through three smart constructors with matching names.

Sourcetype unification_error = private {
  1. trace : unification error;
}
Sourcetype equality_error = private {
  1. trace : comparison error;
  2. subst : (Types.type_expr * Types.type_expr) list;
}
Sourcetype moregen_error = private {
  1. trace : comparison error;
}
Sourceval unification_error : trace:unification error -> unification_error
Sourceval equality_error : trace:comparison error -> subst:(Types.type_expr * Types.type_expr) list -> equality_error
Sourceval moregen_error : trace:comparison error -> moregen_error
Sourcetype comparison_error =
  1. | Equality_error of equality_error
  2. | Moregen_error of moregen_error

Wraps up the two different kinds of comparison errors in one type

Sourceval swap_unification_error : unification_error -> unification_error

Lift swap_trace to unification_error

Sourcemodule Subtype : sig ... end