jon.recoil.org

Module Compilation_unit.Name

type t

The name of a compilation unit without any "-for-pack" prefix.

Printing, comparison, sets, maps, etc.

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

The equality predicate used to compare keys.

val 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
val 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.

val output : out_channel -> T.t -> unit
module Set : Identifiable.Set with module T := T
module Map : Identifiable.Map with module T := T
module Tbl : Identifiable.Tbl with module T := T
val dummy : t

dummy is a placeholder for units that does not have a valid name, as in the, or during initialisation of the compiler. It is not a valid identifier and thus cannot be generated through of_string.

val of_string : string -> t

of_string s checks the given module name is a valid compilation unit name and generates its representation.

val to_string : t -> string
val of_head_of_global_name : Global_module.Name.t -> t
val of_parameter_name : Global_module.Parameter_name.t -> t
val to_global_name : t -> Global_module.Name.t
val predef_exn : t

The name of the distinguished compilation unit for predefined exceptions.

val print_as_inline_code : Format_doc.formatter -> t -> unit

Print the name for use in error messages. Uses Format_doc.formatter and applies inline code styling.

val print : Format_doc.formatter -> t -> unit