jon.recoil.org

Module Symbol

Symbols that identify statically-allocated code or data.

type t
val for_predef_ident : Ident.t -> Symbol.t
val for_local_ident : Ident.t -> Symbol.t

It is assumed that the provided Ident.t is in the current unit.

val unsafe_create : Compilation_unit.t -> Linkage_name.t -> Symbol.t

To be avoided if possible. Linkage names are intended to be generated by this module.

val for_name : Compilation_unit.t -> string -> Symbol.t
val for_compilation_unit : Compilation_unit.t -> Symbol.t
val for_current_unit : unit -> Symbol.t
val for_new_const_in_current_unit : unit -> Symbol.t
val compilation_unit : Symbol.t -> Compilation_unit.t
val linkage_name : Symbol.t -> Linkage_name.t
val linkage_name_for_ocamlobjinfo : Symbol.t -> string

Linkage names displayed in ocamlobjinfo are formatted differently.

include Identifiable.S with type t := Symbol.t
module T : Identifiable.Thing with type t = Symbol.t
include Identifiable.Thing with type t := Symbol.T.t
include Stdlib.Hashtbl.HashedType with type t := Symbol.T.t
val equal : Symbol.T.t -> Symbol.T.t -> bool

The equality predicate used to compare keys.

val hash : Symbol.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 Stdlib.Map.OrderedType with type t := Symbol.T.t
val compare : Symbol.T.t -> Symbol.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.

val output : Stdlib.out_channel -> Symbol.T.t -> unit
val print : Stdlib.Format.formatter -> Symbol.T.t -> unit
module Set : Identifiable.Set with module T := Symbol.T
module Map : Identifiable.Map with module T := Symbol.T
module Tbl : Identifiable.Tbl with module T := Symbol.T
val is_predef_exn : Symbol.t -> bool
val force_runtime4_symbols : unit -> unit
val this_is_ocamlc : unit -> unit