Moduleghc-9.10.3GHC2021

GHC.Types.Unique

1 type
1 class
20 values

Packageghc-9.10.3
Exports22
LanguageGHC2021
LicenceBSD-3-Clause
SourceUnique.hs

Main data types

3 declarations

newtypenewtype Unique

Unique identifier.

The type of unique identifiers that are used in many places in GHC for fast ordering and equality tests. You should generate these with the functions from the UniqSupply module

These are sometimes also referred to as "keys" in comments in GHC.

Instances4Eq, Show, Outputable, Uniquable

Eq UniqueDefined in ghc-9.10.3 · GHC.Types.Unique
Show UniqueDefined in ghc-9.10.3 · GHC.Types.Unique
Outputable UniqueDefined in ghc-9.10.3 · GHC.Types.Unique
Uniquable UniqueDefined in ghc-9.10.3 · GHC.Types.Unique

classclass Uniquable a where

Class of things that we can obtain a Unique from

Methods

getUnique :: a -> Unique

Instances36Uniquable, …

Uniquable LabelDefined in ghc-9.10.3 · GHC.Cmm.Dataflow.Label
Uniquable LocalRegDefined in ghc-9.10.3 · GHC.Cmm.Reg
Uniquable RegDefined in ghc-9.10.3 · GHC.CmmToAsm.Reg.Graph.Base
so we can put regs in UniqSets
Uniquable StoreDefined in ghc-9.10.3 · GHC.CmmToAsm.Reg.Graph.SpillClean
Uniquable SymNameDefined in ghc-9.10.3 · GHC.CmmToAsm.Wasm.Types
Uniquable ClassDefined in ghc-9.10.3 · GHC.Core.Class
Uniquable CoAxiomRuleDefined in ghc-9.10.3 · GHC.Core.Coercion.Axiom
Uniquable ConLikeDefined in ghc-9.10.3 · GHC.Core.ConLike
Uniquable DataConDefined in ghc-9.10.3 · GHC.Core.DataCon
Uniquable PatSynDefined in ghc-9.10.3 · GHC.Core.PatSyn
Uniquable CoercionHoleDefined in ghc-9.10.3 · GHC.Core.TyCo.Rep
Uniquable TyConDefined in ghc-9.10.3 · GHC.Core.TyCon
Uniquable FastStringDefined in ghc-9.10.3 · GHC.Types.Unique
Uniquable IdentDefined in ghc-9.10.3 · GHC.JS.Ident
Uniquable RealRegDefined in ghc-9.10.3 · GHC.Platform.Reg
Uniquable RegDefined in ghc-9.10.3 · GHC.Platform.Reg
Uniquable VirtualRegDefined in ghc-9.10.3 · GHC.Platform.Reg
Uniquable RegClassDefined in ghc-9.10.3 · GHC.Platform.Reg.Class
Uniquable EvBindsVarDefined in ghc-9.10.3 · GHC.Tc.Types.Evidence
Uniquable SkolemInfoDefined in ghc-9.10.3 · GHC.Tc.Types.Origin
Uniquable ConLikeNameDefined in ghc-9.10.3 · GHC.Types.GREInfo
Uniquable NameDefined in ghc-9.10.3 · GHC.Types.Name
Uniquable NameSpaceDefined in ghc-9.10.3 · GHC.Types.Name.Occurrence
Uniquable UniqueDefined in ghc-9.10.3 · GHC.Types.Unique
Uniquable VarDefined in ghc-9.10.3 · GHC.Types.Var
Uniquable PackageIdDefined in ghc-9.10.3 · GHC.Unit.Info
Uniquable PackageNameDefined in ghc-9.10.3 · GHC.Unit.Info
Uniquable WarningCategoryDefined in ghc-9.10.3 · GHC.Unit.Module.Warnings
Uniquable ModuleDefined in ghc-9.10.3 · GHC.Unit.Types
Uniquable UnitIdDefined in ghc-9.10.3 · GHC.Unit.Types
Uniquable FieldLabelStringDefined in ghc-9.10.3 · GHC.Types.FieldLabel · orphan
Uniquable ModuleNameDefined in ghc-9.10.3 · GHC.Types.Unique
Uniquable IntDefined in ghc-9.10.3 · GHC.Types.Unique
Uniquable (CoAxiom br)Defined in ghc-9.10.3 · GHC.Core.Coercion.Axiom
Uniquable unit => Uniquable (Definite unit)Defined in ghc-9.10.3 · GHC.Unit.Types
IsUnitId u => Uniquable (GenUnit u)Defined in ghc-9.10.3 · GHC.Unit.Types

valueuNIQUE_BITS :: Int

Constructors, destructors and operations on Uniques

valuehasKey :: Uniquable a => a -> Unique -> Bool

valuepprUniqueAlways :: IsLine doc => Unique -> doc

valuemkTag :: Char -> Word64

Put the character in the highest bits of the Word64. This may truncate the character to 8. This function is used in mkSplitUniqSupply so that it can precompute and share the tag part of the uniques it generates.

valuemkUniqueGrimily :: Word64 -> Unique

valuemkUniqueIntGrimily :: Int -> Unique

valuegetKey :: Unique -> Word64

valuemkUnique :: Char -> Word64 -> Unique

valueunpkUnique :: Unique -> (Char, Word64)

valuemkUniqueInt :: Char -> Int -> Unique

valueeqUnique :: Unique -> Unique -> Bool

valueltUnique :: Unique -> Unique -> Bool

valueincrUnique :: Unique -> Unique

valuestepUnique :: Unique -> Word64 -> Unique

valuenewTagUnique :: Unique -> Char -> Unique

valuenonDetCmpUnique :: Unique -> Unique -> Ordering

valueisValidKnownKeyUnique :: Unique -> Bool

The interface file symbol-table encoding assumes that known-key uniques fit in 30-bits; verify this.

See Note [Symbol table representation of names] in GHC.Iface.Binary for details.

Local uniques

These are exposed exclusively for use by uniqAway, which has rather peculiar needs. See Note [Local uniques].

valuemkLocalUnique :: Word64 -> Unique

valueminLocalUnique :: Unique

valuemaxLocalUnique :: Unique