Module NamesSource

This file defines a lot of different notions of names used pervasively in the kernel as well as in other places. The essential datatypes exported by this API are:

Identifiers
Sourcemodule Id : sig ... end

Representation and operations on identifiers.

Sourcemodule Name : sig ... end

Representation and operations on identifiers that are allowed to be anonymous (i.e. "_" in concrete syntax).

Type aliases
Sourcetype name = Name.t =
  1. | Anonymous
  2. | Name of Id.t
  • deprecated Use Name.t
Sourcetype variable = Id.t
Sourcetype module_ident = Id.t
module ModIdset : Util.Set.S with type elt = module_ident
module ModIdmap : Util.Map.ExtS with type key = module_ident and module Set := ModIdset
Directory paths = section names paths
Sourcemodule DirPath : sig ... end
module DPset : Util.Set.S with type elt = DirPath.t
module DPmap : Util.Map.ExtS with type key = DirPath.t and module Set := DPset
Names of structure elements
Sourcemodule Label : sig ... end
Unique names for bound modules
Sourcemodule MBId : sig ... end
module MBIset : Util.Set.S with type elt = MBId.t
module MBImap : Util.Map.ExtS with type key = MBId.t and module Set := MBIset
The module part of the kernel name
Sourcemodule ModPath : sig ... end
module MPset : Util.Set.S with type elt = ModPath.t
module MPmap : Util.Map.ExtS with type key = ModPath.t and module Set := MPset
The absolute names of objects seen by kernel
Sourcemodule KerName : sig ... end
module KNset : CSig.USetS with type elt = KerName.t
module KNpred : Predicate.S with type elt = KerName.t
Sourcemodule KNmap : Util.Map.UExtS with type key = KerName.t and module Set := KNset
Signature for quotiented names
Sourcemodule type EqType = sig ... end
Sourcemodule type QNameS = sig ... end
Constant Names
Sourcemodule Constant : sig ... end
module Cpred : Predicate.S with type elt = Constant.t

The *_env modules consider an order on user part of names the others consider an order on canonical part of names

module Cset : CSig.USetS with type elt = Constant.t
module Cset_env : CSig.USetS with type elt = Constant.t
Sourcemodule Cmap : Util.Map.UExtS with type key = Constant.t and module Set := Cset

A map whose keys are constants (values of the Constant.t type). Keys are ordered wrt. "canonical form" of the constant.

Sourcemodule Cmap_env : Util.Map.UExtS with type key = Constant.t and module Set := Cset_env

A map whose keys are constants (values of the Constant.t type). Keys are ordered wrt. "user form" of the constant.

Inductive names
Sourcemodule MutInd : sig ... end
module Mindset : CSig.USetS with type elt = MutInd.t
Sourcemodule Mindmap : Util.Map.UExtS with type key = MutInd.t and module Set := Mindset
module Mindmap_env : CMap.UExtS with type key = MutInd.t
Sourcemodule Ind : sig ... end
Sourcetype inductive = Ind.t
Sourcemodule Construct : sig ... end
Sourcetype constructor = Construct.t
module Indset : CSet.S with type elt = inductive
module Constrset : CSet.S with type elt = constructor
module Indset_env : CSet.S with type elt = inductive
module Constrset_env : CSet.S with type elt = constructor
module Indmap : CMap.ExtS with type key = inductive and module Set := Indset
module Constrmap : CMap.ExtS with type key = constructor and module Set := Constrset
module Indmap_env : CMap.ExtS with type key = inductive and module Set := Indset_env
module Constrmap_env : CMap.ExtS with type key = constructor and module Set := Constrset_env
Sourceval ith_mutual_inductive : inductive -> int -> inductive
Sourceval ith_constructor_of_inductive : inductive -> int -> constructor
Sourceval inductive_of_constructor : constructor -> inductive
Sourceval index_of_constructor : constructor -> int
Hash-consing
Sourceval hcons_con : Constant.t -> Constant.t
Sourceval hcons_mind : MutInd.t -> MutInd.t
Sourceval hcons_ind : inductive -> inductive
Sourceval hcons_construct : constructor -> constructor
Sourcetype 'a tableKey =
  1. | ConstKey of 'a
  2. | VarKey of Id.t
  3. | RelKey of Int.t
Sourcetype inv_rel_key = int

index in the rel_context part of environment starting by the end, inverse of de Bruijn indice

Sourceval eq_table_key : ('a -> 'a -> bool) -> 'a tableKey -> 'a tableKey -> bool
Sourceval hash_table_key : ('a -> int) -> 'a tableKey -> int
Sourceval eq_constant_key : Constant.t -> Constant.t -> bool

equalities on constant and inductive names (for the checker)

Sourceval eq_ind_chk : inductive -> inductive -> bool
Module paths
Sourcetype module_path = ModPath.t =
  1. | MPfile of DirPath.t
  2. | MPbound of MBId.t
  3. | MPdot of ModPath.t * Label.t
  • deprecated Alias type
Sourcemodule Projection : sig ... end
module PRset : CSig.USetS with type elt = Projection.Repr.t
Sourcemodule PRmap : Util.Map.UExtS with type key = Projection.Repr.t and module Set := PRset

Predicate on projection representation (ignoring unfolding state)

Global reference is a kernel side type for all references together
Sourcemodule GlobRef : sig ... end

Located identifiers and objects with syntax.

Sourcetype lident = Id.t CAst.t
Sourcetype lname = Name.t CAst.t
Sourcetype lstring = string CAst.t
Sourceval lident_eq : lident -> lident -> bool