jon.recoil.org

Module Compilation_unit.Prefix

type t

A pack name prefix, as specified to "-for-pack". Such a prefix may be empty.

Printing, comparison, sets, maps, etc.

include Identifiable.S with type t := Compilation_unit.Prefix.t
include Identifiable.Thing with type t := Compilation_unit.Prefix.T.t
include Stdlib.Hashtbl.HashedType with type t := Compilation_unit.Prefix.T.t

The equality predicate used to compare keys.

val hash : Compilation_unit.Prefix.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 := Compilation_unit.Prefix.T.t

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 parse_for_pack : string -> Compilation_unit.Prefix.t

parse_for_pack p returns the list of nested packed modules, as expressed in the syntax of the "-for-pack" argument.

val from_clflags : unit -> Compilation_unit.Prefix.t

Return the prefix specified to "-for-pack". Returns the empty prefix if no "-for-pack" was passed.

Return the list of names comprising the prefix, outermost first.

val to_string : Compilation_unit.Prefix.t -> string
val is_empty : Compilation_unit.Prefix.t -> bool