GHC.Iface.Type · ghc-lib-parser-9.14.1.20251220

typetype IfExtName = Name

#

newtypenewtype IfLclName

#

A local name in iface syntax

Constructors

IfLclName
- getIfLclName :: LexicalFastString

Instances6Eq, Ord, Show, NFData, Outputable, Binary

Eq IfLclNameDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Ord IfLclNameDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Show IfLclNameDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
NFData IfLclNameDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Outputable IfLclNameDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Binary IfLclNameDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type

valuemkIfLclName :: FastString -> IfLclName

#

valueifLclNameFS :: IfLclName -> FastString

#

datadata IfaceType

#

A kind of universal type, used for types and kinds.

Any time a Type is pretty-printed, it is first converted to an IfaceType before being printed. See Note [Pretty printing via Iface syntax] in GHC.Types.TyThing.Ppr

Instances7Eq, Ord, Outputable, NFData, Binary, …

Eq IfaceTypeDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Ord IfaceTypeDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
NFData IfaceTypeDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Outputable IfaceTypeDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Binary IfaceTypeDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
NFData (DefMethSpec IfaceType)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Binary (DefMethSpec IfaceType)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type

typetype IfacePredType = IfaceType

#

typetype IfaceKind = IfaceType

#

datadata IfaceCoercion

#

Constructors

IfaceReflCo IfaceType
IfaceGReflCo Role IfaceType IfaceMCoercion
IfaceFunCo Role IfaceCoercion IfaceCoercion IfaceCoercion
IfaceTyConAppCo Role IfaceTyCon [IfaceCoercion]
IfaceAppCo IfaceCoercion IfaceCoercion
IfaceForAllCo IfaceBndr !ForAllTyFlag !ForAllTyFlag IfaceCoercion IfaceCoercion
IfaceCoVarCo IfLclName
IfaceAxiomCo IfaceAxiomRule [IfaceCoercion]
There are only a fixed number of CoAxiomRules, so it suffices to use an IfaceLclName to distinguish them. See Note [Adding built-in type families] in GHC.Builtin.Types.Literals
IfaceUnivCo UnivCoProvenance Role IfaceType IfaceType [IfaceCoercion]
IfaceSymCo IfaceCoercion
IfaceTransCo IfaceCoercion IfaceCoercion
IfaceSelCo CoSel IfaceCoercion
IfaceLRCo LeftOrRight IfaceCoercion
IfaceInstCo IfaceCoercion IfaceCoercion
IfaceKindCo IfaceCoercion
IfaceSubCo IfaceCoercion
IfaceFreeCoVar CoVar
See Note [Free TyVars and CoVars in IfaceType]
IfaceHoleCo CoVar
See Note [Holes in IfaceCoercion]

Instances5Eq, Ord, NFData, Outputable, Binary

Eq IfaceCoercionDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Ord IfaceCoercionDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
NFData IfaceCoercionDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Outputable IfaceCoercionDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Binary IfaceCoercionDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type

datadata IfaceAxiomRule

#

Constructors

IfaceAR_X IfLclName
IfaceAR_B IfExtName BranchIndex
IfaceAR_U IfExtName

Instances4Eq, Ord, NFData, Binary

Eq IfaceAxiomRuleDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Ord IfaceAxiomRuleDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
NFData IfaceAxiomRuleDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Binary IfaceAxiomRuleDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type

datadata IfaceMCoercion

#

Instances4Eq, Ord, NFData, Binary

Eq IfaceMCoercionDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Ord IfaceMCoercionDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
NFData IfaceMCoercionDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Binary IfaceMCoercionDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type

typetype IfaceMult = IfaceType

#

datadata IfaceTyCon

#

Constructors

IfaceTyCon
- ifaceTyConName :: IfExtName
- ifaceTyConInfo :: !IfaceTyConInfo
  We add a bang to this field as heap analysis showed that this constructor retains a thunk to a value that is usually shared.
  See !12200 for how this bang saved ~10% residency when loading mi_extra_decls on the agda code base.
  See Note [Sharing IfaceTyConInfo] for why sharing is so important for IfaceTyConInfo.

Instances5Eq, Ord, NFData, Outputable, Binary

Eq IfaceTyConDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Ord IfaceTyConDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
NFData IfaceTyConDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Outputable IfaceTyConDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Binary IfaceTyConDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type

datadata IfaceTyConInfo

#

Constructors

IfaceTyConInfo
- ifaceTyConIsPromoted :: PromotionFlag
- ifaceTyConSort :: IfaceTyConSort

Instances5Eq, Ord, NFData, Outputable, Binary

Eq IfaceTyConInfoDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Ord IfaceTyConInfoDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
NFData IfaceTyConInfoDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Outputable IfaceTyConInfoDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Binary IfaceTyConInfoDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type

valuemkIfaceTyConInfo :: PromotionFlag -> IfaceTyConSort -> IfaceTyConInfo

#

This smart constructor allows sharing of the two most common cases. See Note [Sharing IfaceTyConInfo]

datadata IfaceTyConSort

#

The various types of TyCons which have special, built-in syntax.

Constructors

IfaceNormalTyCon
a regular tycon
IfaceTupleTyCon !Arity !TupleSort
a tuple, e.g. (a, b, c) or (#a, b, c#). The arity is the tuple width, not the tycon arity (which is twice the width in the case of unboxed tuples).
IfaceSumTyCon !Arity
an unboxed sum, e.g. (# a | b | c #)
IfaceEqualityTyCon
A heterogeneous equality TyCon (i.e. eqPrimTyCon, eqReprPrimTyCon, heqTyCon) that is actually being applied to two types of the same kind. This affects pretty-printing only: see Note [Equality predicates in IfaceType]

Instances5Eq, Ord, NFData, Outputable, Binary

Eq IfaceTyConSortDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Ord IfaceTyConSortDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
NFData IfaceTyConSortDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Outputable IfaceTyConSortDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Binary IfaceTyConSortDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type

datadata IfaceTyLit

#

Constructors

Instances5Eq, Ord, NFData, Outputable, Binary

Eq IfaceTyLitDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Ord IfaceTyLitDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
NFData IfaceTyLitDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Outputable IfaceTyLitDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Binary IfaceTyLitDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type

datadata IfaceAppArgs

#

Stores the arguments in a type application as a list. See Note [Suppressing invisible arguments].

Constructors

IA_Nil
IA_Arg IfaceType ForAllTyFlag IfaceAppArgs

Instances7Eq, Ord, Semigroup, Monoid, NFData, Outputable, …

Eq IfaceAppArgsDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Ord IfaceAppArgsDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Semigroup IfaceAppArgsDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Monoid IfaceAppArgsDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
NFData IfaceAppArgsDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Outputable IfaceAppArgsDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Binary IfaceAppArgsDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type

typetype IfaceContext = [IfacePredType]

#

datadata IfaceBndr

#

Constructors

IfaceIdBndr !IfaceIdBndr
IfaceTvBndr !IfaceTvBndr

Instances5Eq, Ord, NFData, Outputable, Binary

Eq IfaceBndrDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Ord IfaceBndrDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
NFData IfaceBndrDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Outputable IfaceBndrDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Binary IfaceBndrDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type

datadata IfaceOneShot

#

IfaceNoOneShot IfaceOneShot

Instances3NFData, Outputable, Binary

NFData IfaceOneShotDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Outputable IfaceOneShotDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type
Binary IfaceOneShotDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type

typetype IfaceLamBndr = (IfaceBndr, IfaceOneShot)

#

typetype IfaceTvBndr = (IfLclName, IfaceKind)

#

typetype IfaceIdBndr = (IfaceType, IfLclName, IfaceType)

#

typetype IfaceTyConBinder = VarBndr IfaceBndr TyConBndrVis

#

typetype IfaceForAllSpecBndr = VarBndr IfaceBndr Specificity

#

typetype IfaceForAllBndr = VarBndr IfaceBndr ForAllTyFlag

#

datadata ForAllTyFlag

#

ForAllTyFlag

Is something required to appear in source Haskell (Required), permitted by request (Specified) (visible type application), or prohibited entirely from appearing in source Haskell (Inferred)? See Note [VarBndrs, ForAllTyBinders, TyConBinders, and visibility] in GHC.Core.TyCo.Rep

Constructors

Invisible !Specificity
Required

Instances8Eq, Data, Ord, NFData, Binary, OutputableBndrFlag, …

Eq ForAllTyFlagDefined in ghc-lib-parser-9.14.1.20251220 · Language.Haskell.Syntax.Specificity
Data ForAllTyFlagDefined in ghc-lib-parser-9.14.1.20251220 · Language.Haskell.Syntax.Specificity
Ord ForAllTyFlagDefined in ghc-lib-parser-9.14.1.20251220 · Language.Haskell.Syntax.Specificity
NFData ForAllTyFlagDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Hs.Specificity · orphan
Outputable ForAllTyFlagDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Hs.Specificity · orphan
Binary ForAllTyFlagDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Hs.Specificity · orphan
OutputableBndrFlag ForAllTyFlag pDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Hs.Type
Outputable tv => Outputable (VarBndr tv ForAllTyFlag)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var

patternpattern Inferred :: ForAllTyFlag

#

patternpattern Specified :: ForAllTyFlag

#

datadata FunTyFlag

#

The non-dependent version of ForAllTyFlag. See Note [FunTyFlag] Appears here partly so that it's together with its friends ForAllTyFlag and ForallVisFlag, but also because it is used in IfaceType, rather early in the compilation chain

FTF_T_T FTF_T_C FTF_C_T FTF_C_C

Instances6Eq, Data, Ord, NFData, Outputable, Binary

Eq FunTyFlagDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
Data FunTyFlagDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
Ord FunTyFlagDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
NFData FunTyFlagDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
Outputable FunTyFlagDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
Binary FunTyFlagDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var

datadata ShowForAllFlag

#

Show forall flag

Unconditionally show the forall quantifier with (ShowForAllMust) or when (ShowForAllWhen) the names used are free in the binder or when compiling with -fprint-explicit-foralls.

ShowForAllMust ShowForAllWhen

datadata ShowSub

#

Constructors

ShowSub
- ss_how_much :: ShowHowMuch
- ss_forall :: ShowForAllFlag

datadata ShowHowMuch

#

Constructors

ShowHeader AltPpr
Header information only, not rhs
ShowSome (Maybe (OccName -> Bool)) AltPpr
Show the declaration and its RHS. The Maybe predicate allows filtering of the sub-components which should be printing; any sub-components filtered out will be elided with ....
ShowIface
Everything including GHC-internal information (used in --show-iface)

Instances1Outputable

Outputable ShowHowMuchDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Iface.Type

newtypenewtype AltPpr

#

Constructors

AltPpr (Maybe (OccName -> SDoc))

valuemkIfaceForAllTvBndr :: ForAllTyFlag -> IfaceTvBndr -> IfaceForAllBndr

#

Make an IfaceForAllBndr from an IfaceTvBndr.

valuemkIfaceTyConKind :: [IfaceTyConBinder] -> IfaceKind -> IfaceKind

#

Build the tyConKind from the binders and the result kind. Keep in sync with mkTyConKind in GHC.Core.TyCon.

valueifaceForAllSpecToBndrs :: [IfaceForAllSpecBndr] -> [IfaceForAllBndr]

#

valueifaceForAllSpecToBndr :: IfaceForAllSpecBndr -> IfaceForAllBndr

#

valueifForAllBndrVar :: IfaceForAllBndr -> IfaceBndr

#

Extract an IfaceBndr from an IfaceForAllBndr.

valueifForAllBndrName :: IfaceForAllBndr -> IfLclName

#

Extract the variable name from an IfaceForAllBndr.

valueifaceBndrName :: IfaceBndr -> IfLclName

#

valueifTyConBinderVar :: IfaceTyConBinder -> IfaceBndr

#

Extract an IfaceBndr from an IfaceTyConBinder.

valueifTyConBinderName :: IfaceTyConBinder -> IfLclName

#

Extract the variable name from an IfaceTyConBinder.

valueputIfaceType :: WriteBinHandle -> IfaceType -> IO ()

#

Serialises an IfaceType to the given WriteBinHandle.

Serialising inner IfaceType's uses the Binary.put of IfaceType which may be using a deduplication table. See Note [Deduplication during iface binary serialisation].

valuegetIfaceType :: HasCallStack => ReadBinHandle -> IO IfaceType

#

Deserialises an IfaceType from the given ReadBinHandle.

Reading inner IfaceType's uses the Binary.get of IfaceType which may be using a deduplication table. See Note [Deduplication during iface binary serialisation].

valueifaceTypeSharedByte :: Word8

#

This is the byte tag we expect to read when the next value is not an IfaceType value, but an offset into a lookup table. See Note [Deduplication during iface binary serialisation].

Must not overlap with any byte tag in getIfaceType.

valueisIfaceLiftedTypeKind :: IfaceKind -> Bool

#

Returns true for Type or (TYPE LiftedRep)

valueappArgsIfaceTypes :: IfaceAppArgs -> [IfaceType]

#

valueappArgsIfaceTypesForAllTyFlags

:: IfaceAppArgs
-> [(IfaceType, ForAllTyFlag)]

#

newtypenewtype SuppressBndrSig

#

Do we want to suppress kind annotations on binders? See Note [Suppressing binder signatures]

Constructors

SuppressBndrSig Bool

newtypenewtype UseBndrParens

#

Constructors

UseBndrParens Bool

newtypenewtype PrintExplicitKinds

#

Constructors

PrintExplicitKinds Bool

newtypenewtype PrintArityInvisibles

#

Constructors

MkPrintArityInvisibles Bool

valuepprIfaceType :: IfaceType -> SDoc

#

valuepprParendIfaceType :: IfaceType -> SDoc

#

valuepprPrecIfaceType :: PprPrec -> IfaceType -> SDoc

#

valuepprIfaceContext :: PprPrec -> [IfacePredType] -> SDoc

#

Prints a context or () if empty You give it the context precedence

valuepprIfaceContextArr :: [IfacePredType] -> SDoc

#

Prints "(C a, D b) =>", including the arrow. Used when we want to print a context in a type, so we use funPrec to decide whether to parenthesise a singleton predicate; e.g. Num a => a -> a

valuepprIfaceIdBndr :: IfaceIdBndr -> SDoc

#

valuepprIfaceLamBndr :: IfaceLamBndr -> SDoc

#

valuepprIfaceTvBndr :: IfaceTvBndr -> SuppressBndrSig -> UseBndrParens -> SDoc

#

valuepprIfaceTyConBinders :: SuppressBndrSig -> [IfaceTyConBinder] -> SDoc

#

valuepprIfaceBndrs :: [IfaceBndr] -> SDoc

#

valuepprIfaceAppArgs :: IfaceAppArgs -> SDoc

#