package merlin-lib

  1. Overview
  2. Docs
Merlin's libraries

Install 

dune-project
 Dependency

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

Authors

  1. T
    The Merlin team

Maintainers

  1. D
    defree@gmail.com

Sources

merlin-4.16-414.tbz
sha256=c5e91975f3df56849e1b306f356c31709a2b139d7d57634b8d21e473266fcf2d
sha512=1d2db379b496dc0b95874f312011cce1a48f6808e098f1aff768de0eef0caff222adc17ab61b85c7aac8d889bf9d829fb5d0211267c7a85572ce201c1cbcb990

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

Module Ocaml_typing.IdentSource

Sourcetype t
include Ocaml_utils.Identifiable.S with type t := t
include Ocaml_utils.Identifiable.Thing with type t := T.t
include Hashtbl.HashedType with type t := T.t
Sourceval equal : T.t -> T.t -> bool

The equality predicate used to compare keys.

Sourceval hash : T.t -> int

A hashing function on keys. It must be such that if two keys are equal according to equal, then they have identical hash values as computed by hash. Examples: suitable (equal, hash) pairs for arbitrary key types include

  • ((=), hash) for comparing objects by structure (provided objects do not contain floats)
  • ((fun x y -> compare x y = 0), hash) for comparing objects by structure and handling Stdlib.nan correctly
  • ((==), hash) for comparing objects by physical equality (e.g. for mutable or cyclic objects).
include Map.OrderedType with type t := T.t
Sourceval output : out_channel -> T.t -> unit
Sourceval print : Format.formatter -> T.t -> unit
Sourcemodule Set : sig ... end
Sourcemodule Map : sig ... end
Sourcemodule Tbl : sig ... end
Sourceval print_with_scope : Format.formatter -> t -> unit

Same as print except that it will also add a "n" suffix if the scope of the argument is n.

Sourceval create_scoped : scope:int -> string -> t
Sourceval create_local : string -> t
Sourceval create_persistent : string -> t
Sourceval create_predef : string -> t
Sourceval rename : t -> t

Creates an identifier with the same name as the input, a fresh stamp, and no scope.

  • raises [Fatal_error]

    if called on a persistent / predef ident.

Sourceval name : t -> string
Sourceval unique_name : t -> string
Sourceval unique_toplevel_name : t -> string
Sourceval persistent : t -> bool
Sourceval same : t -> t -> bool

Compare identifiers by binding location. Two identifiers are the same either if they are both non-persistent and have been created by the same call to create_*, or if they are both persistent and have the same name.

Sourceval compare : t -> t -> int
Sourceval global : t -> bool
Sourceval is_predef : t -> bool
Sourceval scope : t -> int
Sourceval stamp : t -> int
Sourceval lowest_scope : int
Sourceval highest_scope : int
Sourceval reinit : unit -> unit
Sourcetype 'a tbl
Sourceval empty : 'a tbl
Sourceval add : t -> 'a -> 'a tbl -> 'a tbl
Sourceval find_same : t -> 'a tbl -> 'a
Sourceval find_name : string -> 'a tbl -> t * 'a
Sourceval find_all : string -> 'a tbl -> (t * 'a) list
Sourceval fold_name : (t -> 'a -> 'b -> 'b) -> 'a tbl -> 'b -> 'b
Sourceval fold_all : (t -> 'a -> 'b -> 'b) -> 'a tbl -> 'b -> 'b
Sourceval iter : (t -> 'a -> unit) -> 'a tbl -> unit
Sourceval remove : t -> 'a tbl -> 'a tbl
Sourceval make_key_generator : unit -> t -> t
Sourceval rename_no_exn : t -> t

Like rename, but does not fail on persistent/predef idents.

Sourceval get_currentstamp : unit -> int

Get the value of the current stamp (the stamp of the last created identifier). Used to flush identifier-based caches when backtracking.