jon.recoil.org

Module Ocaml_typing.Mode_hint

type lock_item =
  1. | Value
  2. | Module
  3. | Class
  4. | Constructor

A description of what type of item is being closed over

type ident = {
  1. category : Ocaml_typing.Mode_hint.lock_item;
  2. lid : Ocaml_parsing.Longident.t;
    (*

    Sometimes we want the ident to represent M.x but the loc can only point to M. This field would store M.x.

    *)
}
type pinpoint_desc =
  1. | Unknown
  2. | Ident of Ocaml_typing.Mode_hint.ident
    (*

    An identifier

    *)
  3. | Function
    (*

    A function definition

    *)
  4. | Functor
    (*

    A functor definition

    *)
  5. | Lazy
    (*

    A lazy expression

    *)
  6. | Allocation
    (*

    An allocation

    *)
  7. | Expression
    (*

    An arbitrary expression

    *)
  8. | Class
    (*

    An class declaration

    *)
  9. | Object
    (*

    An object declaration

    *)
  10. | Loop
    (*

    a loop

    *)
  11. | Letop
    (*

    let op

    *)
  12. | Cases_result
    (*

    the result of cases

    *)

Description of pinpoints to accompany the location. The constructors are not mutually exclusive - some might be more precise than others

A pinpoint is a location in the source code, accompanied by additional description

type mutable_part =
  1. | Record_field of string
  2. | Array_elements
type always_dynamic =
  1. | Application
  2. | Try_with
type 'd const =
  1. | Unknown : ('l * 'r) Ocaml_typing.Mode_hint.const
    (*

    The constant bound is not explained.

    *)
  2. | Lazy_allocated_on_heap : (Ocaml_typing.Allowance.disallowed * 'r) Ocaml_typing.Allowance.pos Ocaml_typing.Mode_hint.const
  3. | Class_legacy_monadic : ('l * Ocaml_typing.Allowance.disallowed) Ocaml_typing.Allowance.neg Ocaml_typing.Mode_hint.const
  4. | Class_legacy_comonadic : ('l * Ocaml_typing.Allowance.disallowed) Ocaml_typing.Allowance.pos Ocaml_typing.Mode_hint.const
  5. | Tailcall_function : (Ocaml_typing.Allowance.disallowed * 'r) Ocaml_typing.Allowance.pos Ocaml_typing.Mode_hint.const
  6. | Tailcall_argument : (Ocaml_typing.Allowance.disallowed * 'r) Ocaml_typing.Allowance.pos Ocaml_typing.Mode_hint.const
  7. | Mutable_read : Ocaml_typing.Mode_hint.mutable_part -> (Ocaml_typing.Allowance.disallowed * 'r) Ocaml_typing.Allowance.neg Ocaml_typing.Mode_hint.const
  8. | Mutable_write : Ocaml_typing.Mode_hint.mutable_part -> (Ocaml_typing.Allowance.disallowed * 'r) Ocaml_typing.Allowance.neg Ocaml_typing.Mode_hint.const
  9. | Lazy_forced : (Ocaml_typing.Allowance.disallowed * 'r) Ocaml_typing.Allowance.neg Ocaml_typing.Mode_hint.const
  10. | Function_return : (Ocaml_typing.Allowance.disallowed * 'r) Ocaml_typing.Allowance.pos Ocaml_typing.Mode_hint.const
  11. | Stack_expression : ('l * Ocaml_typing.Allowance.disallowed) Ocaml_typing.Allowance.pos Ocaml_typing.Mode_hint.const
  12. | Module_allocated_on_heap : (Ocaml_typing.Allowance.disallowed * 'r) Ocaml_typing.Allowance.pos Ocaml_typing.Mode_hint.const
  13. | Always_dynamic : Ocaml_typing.Mode_hint.always_dynamic -> ('l * Ocaml_typing.Allowance.disallowed) Ocaml_typing.Allowance.neg Ocaml_typing.Mode_hint.const
  14. | Branching : ('l * Ocaml_typing.Allowance.disallowed) Ocaml_typing.Allowance.neg Ocaml_typing.Mode_hint.const
  15. | Is_used_in : Ocaml_typing.Mode_hint.pinpoint -> (Ocaml_typing.Allowance.disallowed * 'r) Ocaml_typing.Mode_hint.const
    (*

    A variant of Is_closed_by where the closure mode is constant. INVARIANT: The pinpoint cannot be Unknown.

    *)
constraint 'd = _ * _

Hint for a constant bound. See Mode.Report.print_const for what each non-trivial constructor means.

type ('d0, 'd1) polarity =
  1. | Monadic : ('l * 'r, 'r * 'l) Ocaml_typing.Mode_hint.polarity
  2. | Comonadic : ('l * 'r, 'l * 'r) Ocaml_typing.Mode_hint.polarity
constraint 'd0 = _ * _ constraint 'd1 = _ * _
type closure_details = {
  1. closure : Ocaml_typing.Mode_hint.pinpoint;
  2. closed : Ocaml_typing.Mode_hint.pinpoint;
}
type containing =
  1. | Tuple
  2. | Record of string
  3. | Array
  4. | Constructor of string
type contains = {
  1. containing : Ocaml_typing.Mode_hint.containing;
  2. contained : Ocaml_typing.Mode_hint.pinpoint;
}
type is_contained_by = {
  1. containing : Ocaml_typing.Mode_hint.containing;
  2. container : Ocaml_parsing.Location.t;
}
type allocation_desc =
  1. | Unknown
  2. | Optional_argument
  3. | Function_coercion
  4. | Float_projection
type 'd morph =
  1. | Unknown : ('l * 'r) Ocaml_typing.Mode_hint.morph
    (*

    The morphism is not explained.

    *)
  2. | Unknown_non_rigid : ('l * 'r) Ocaml_typing.Mode_hint.morph
    (*

    Similiar to Unknown, but in the special case where the morph doesn't change the bound, it can be skipped.

    *)
  3. | Skip : ('l * 'r) Ocaml_typing.Mode_hint.morph
    (*

    The morphism doesn't change the bound and should be skipped in printing.

    *)
  4. | Close_over : ('d, 'l * Ocaml_typing.Allowance.disallowed) Ocaml_typing.Mode_hint.polarity * Ocaml_typing.Mode_hint.closure_details -> ('l * Ocaml_typing.Allowance.disallowed) Ocaml_typing.Mode_hint.morph
  5. | Is_closed_by : ('d, Ocaml_typing.Allowance.disallowed * 'r) Ocaml_typing.Mode_hint.polarity * Ocaml_typing.Mode_hint.closure_details -> (Ocaml_typing.Allowance.disallowed * 'r) Ocaml_typing.Mode_hint.morph
  6. | Captured_by_partial_application : (Ocaml_typing.Allowance.disallowed * 'r) Ocaml_typing.Mode_hint.morph
  7. | Adj_captured_by_partial_application : ('l * Ocaml_typing.Allowance.disallowed) Ocaml_typing.Mode_hint.morph
  8. | Crossing : ('l * 'r) Ocaml_typing.Mode_hint.morph
  9. | Allocation_r : Ocaml_typing.Mode_hint.allocation -> (Ocaml_typing.Allowance.disallowed * 'r) Ocaml_typing.Mode_hint.morph
  10. | Allocation_l : Ocaml_typing.Mode_hint.allocation -> ('l * Ocaml_typing.Allowance.disallowed) Ocaml_typing.Mode_hint.morph
  11. | Contains_l : ('l * Ocaml_typing.Allowance.disallowed, 'd) Ocaml_typing.Mode_hint.polarity * Ocaml_typing.Mode_hint.contains -> 'd Ocaml_typing.Mode_hint.morph
  12. | Is_contained_by : ('l * 'r, 'd) Ocaml_typing.Mode_hint.polarity * Ocaml_typing.Mode_hint.is_contained_by -> 'd Ocaml_typing.Mode_hint.morph
  13. | Contains_r : (Ocaml_typing.Allowance.disallowed * 'r, 'd) Ocaml_typing.Mode_hint.polarity * Ocaml_typing.Mode_hint.contains -> 'd Ocaml_typing.Mode_hint.morph
constraint 'd = _ * _

Hint for morphisms. When acompanied by a destination pinpoint, morph gives a source pinpoint and explains the relation between them. See Mode.Report.print_morph for what each non-trivial constructor means.