Module Shape.UidSource

A Uid.t is associated to every declaration in signatures and implementations. They uniquely identify bindings in the program. When associated with these bindings' locations they are useful to external tools when trying to jump to an identifier's declaration or definition. They are stored to that effect in the uid_to_decl table of cmt files.

Sourcetype t = private
  1. | Compilation_unit of string
  2. | Item of {
    1. comp_unit : string;
    2. id : int;
    }
  3. | Internal
  4. | Predef of string
Sourceval reinit : unit -> unit
Sourceval get_current_stamp : unit -> int
Sourceval restore_stamp : int -> unit
Sourceval stamp_of_uid : t -> int option
Sourceval mk : current_unit:string -> t
Sourceval of_compilation_unit_id : Ident.t -> t
Sourceval of_predef_id : Ident.t -> t
Sourceval internal_not_actually_unique : t
Sourceval for_actual_declaration : t -> bool
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 compare : T.t -> T.t -> int

A total ordering function over the keys. This is a two-argument function f such that f e1 e2 is zero if the keys e1 and e2 are equal, f e1 e2 is strictly negative if e1 is smaller than e2, and f e1 e2 is strictly positive if e1 is greater than e2. Example: a suitable ordering function is the generic structural comparison function Stdlib.compare.

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