GHC.Types.Var · ghc-lib-parser-9.14.1.20251220

The main data type and synonyms

17 declarations

datadata Var

#

Variable

Essentially a typed Name, that may also contain some additional information about the Var and its use sites.

Instances13Data, Ord, Uniquable, Outputable, NamedThing, HasOccName, …

Eq VarDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
Data VarDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
Ord VarDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
Uniquable VarDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
Outputable VarDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
NamedThing VarDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
OutputableBndr VarDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Core.Ppr · orphan
HasOccName VarDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
Eq (DeBruijn CoreAlt)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Core.Map.Expr · orphan
Eq (DeBruijn CoreExpr)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Core.Map.Expr · orphan
Eq (DeBruijn Var)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Core.Map.Type
OutputableBndr (Id, TagSig)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Stg.EnforceEpt.TagSig
type Anno Id = SrcSpanAnnNDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Hs.Extension · orphan

typetype CoVar = Id

#

Coercion Variable

typetype Id = Var

#

Identifier

typetype NcId = Id

#

typetype DictId = EvId

#

Dictionary Identifier

typetype DFunId = Id

#

Dictionary Function Identifier

typetype EvVar = EvId

#

Evidence Variable

typetype EqVar = EvId

#

Equality Variable

typetype EvId = Id

#

Evidence Identifier

typetype IpId = EvId

#

Implicit parameter Identifier

typetype JoinId = Id

#

typetype TyVar = Var

#

Type or kind Variable

typetype TcTyVar = Var

#

Type variable that might be a metavariable

typetype TypeVar = Var

#

Type Variable

typetype KindVar = Var

#

Kind Variable

typetype TKVar = Var

#

Type or Kind Variable

typetype TyCoVar = Id

#

Type or Coercion Variable

In and Out variants

10 declarations

typetype InVar = Var

#

typetype InCoVar = CoVar

#

typetype InId = Id

#

typetype InTyVar = TyVar

#

typetype InTyCoVar = TyCoVar

#

typetype OutVar = Var

#

typetype OutCoVar = CoVar

#

typetype OutId = Id

#

typetype OutTyVar = TyVar

#

typetype OutTyCoVar = TyCoVar

#

Taking Vars apart

valuevarName :: Var -> Name

#

valuevarUnique :: Var -> Unique

#

valuevarType :: Var -> Kind

#

The type or kind of the Var in question

valuevarMultMaybe :: Id -> Maybe Mult

#

valueidMult :: HasDebugCallStack => Id -> Mult

#

Modifying Vars

valuesetVarName :: Var -> Name -> Var

#

valuesetVarUnique :: Var -> Unique -> Var

#

valuesetVarType :: Var -> Type -> Var

#

valueupdateVarType :: (Type -> Type) -> Var -> Var

#

Update a Vars type. Does not update the multiplicity stored in an Id, if any. Because of the possibility for abuse, ASSERTs that there is no multiplicity to update.

valueupdateVarTypeM :: Monad m => (Type -> m Type) -> Var -> m Var

#

Update a Vars type monadically. Does not update the multiplicity stored in an Id, if any. Because of the possibility for abuse, ASSERTs that there is no multiplicity to update.

Constructing, taking apart, modifying Ids

valuemkGlobalVar :: IdDetails -> Name -> Type -> IdInfo -> Id

#

valuemkLocalVar :: IdDetails -> Name -> Mult -> Type -> IdInfo -> Id

#

valuemkExportedLocalVar :: IdDetails -> Name -> Type -> IdInfo -> Id

#

Exported Vars will not be removed as dead code

valuemkCoVar :: Name -> Type -> CoVar

#

valueidInfo :: HasDebugCallStack => Id -> IdInfo

#

valueidDetails :: HasCallStack => Id -> IdDetails

#

valuelazySetIdInfo :: Id -> IdInfo -> Var

#

valuesetIdDetails :: Id -> IdDetails -> Id

#

valueglobaliseId :: Id -> Id

#

If it's a local, make it global

valuesetIdExported :: Id -> Id

#

Exports the given local Id. Can also be called on global Ids, such as data constructors and class operations, which are born as global Ids and automatically exported

valuesetIdNotExported :: Id -> Id

#

We can only do this to LocalIds

valuesetIdMult :: Id -> Mult -> Id

#

valueupdateIdTypeButNotMult :: (Type -> Type) -> Id -> Id

#

valueupdateIdTypeAndMult :: (Type -> Type) -> Id -> Id

#

valueupdateIdTypeAndMultM :: Monad m => (Type -> m Type) -> Id -> m Id

#

Predicates

valueisId :: Var -> Bool

#

Is this a value-level (i.e., computationally relevant) Identifier? Satisfies isId = not . isTyVar.

valueisTyVar :: Var -> Bool

#

Is this a type-level (i.e., computationally irrelevant, thus erasable) variable? Satisfies isTyVar = not . isId.

valueisTcTyVar :: Var -> Bool

#

valueisLocalVar :: Var -> Bool

#

isLocalVar returns True for type variables as well as local Ids These are the variables that we need to pay attention to when finding free variables, or doing dependency analysis.

valueisLocalId :: Var -> Bool

#

valueisLocalId_maybe :: Var -> Maybe ExportFlag

#

valueisCoVar :: Var -> Bool

#

Is this a coercion variable? Satisfies isId v ==> isCoVar v == not (isNonCoVarId v).

valueisNonCoVarId :: Var -> Bool

#

Is this a term variable (Id) that is not a coercion variable? Satisfies isId v ==> isCoVar v == not (isNonCoVarId v).

valueisTyCoVar :: Var -> Bool

#

valueisGlobalId :: Var -> Bool

#

valueisExportedId :: Var -> Bool

#

isExportedIdVar means "don't throw this away"

valuemustHaveLocalBinding :: Var -> Bool

#

mustHaveLocalBinding returns True of Ids and TyVars that must have a binding in this module. The converse is not quite right: there are some global Ids that must have bindings, such as record selectors. But that doesn't matter, because it's only used for assertions

ForAllTyFlags

9 declarations

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 Specified :: ForAllTyFlag

#

patternpattern Inferred :: ForAllTyFlag

#

datadata Specificity

#

Whether an Invisible argument may appear in source Haskell.

Constructors

InferredSpec
the argument may not appear in source Haskell, it is only inferred.
SpecifiedSpec
the argument may appear in source Haskell, but isn't required.

Instances7Eq, Data, Ord, NFData, Binary, OutputableBndrFlag, …

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

valueisVisibleForAllTyFlag :: ForAllTyFlag -> Bool

#

Does this ForAllTyFlag classify an argument that is written in Haskell?

valueisInvisibleForAllTyFlag :: ForAllTyFlag -> Bool

#

Does this ForAllTyFlag classify an argument that is not written in Haskell?

valueisInferredForAllTyFlag :: ForAllTyFlag -> Bool

#

valueisSpecifiedForAllTyFlag :: ForAllTyFlag -> Bool

#

valuecoreTyLamForAllTyFlag :: ForAllTyFlag

#

The ForAllTyFlag on a (Lam a e) term, where a is a type variable. If you want other ForAllTyFlag, use a cast. See Note [Required foralls in Core] in GHC.Core.TyCo.Rep

FunTyFlag

14 declarations

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

valueisVisibleFunArg :: FunTyFlag -> Bool

#

valueisInvisibleFunArg :: FunTyFlag -> Bool

#

valueisFUNArg :: FunTyFlag -> Bool

#

valuemkFunTyFlag :: TypeOrConstraint -> TypeOrConstraint -> FunTyFlag

#

valuevisArg :: TypeOrConstraint -> FunTyFlag

#

valueinvisArg :: TypeOrConstraint -> FunTyFlag

#

valuevisArgTypeLike :: FunTyFlag

#

valuevisArgConstraintLike :: FunTyFlag

#

valueinvisArgTypeLike :: FunTyFlag

#

valueinvisArgConstraintLike :: FunTyFlag

#

valuefunTyFlagArgTypeOrConstraint :: FunTyFlag -> TypeOrConstraint

#

valuefunTyFlagResultTypeOrConstraint :: FunTyFlag -> TypeOrConstraint

#

datadata TypeOrConstraint

#

TypeLike ConstraintLike

Instances5Eq, Data, Ord, NFData, Binary

Eq TypeOrConstraintDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Basic
Data TypeOrConstraintDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Basic
Ord TypeOrConstraintDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Basic
NFData TypeOrConstraintDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Basic
Binary TypeOrConstraintDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Basic

PiTyBinder

11 declarations

datadata PiTyBinder

#

A PiTyBinder represents an argument to a function. PiTyBinders can be dependent (Named) or nondependent (Anon). They may also be visible or not. See Note [PiTyBinders]

Constructors

Named ForAllTyBinder
Anon (Scaled Type) FunTyFlag

Instances2Data, Outputable

Data PiTyBinderDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
Outputable PiTyBinderDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var

typetype PiTyVarBinder = PiTyBinder

#

PiTyVarBinder is like PiTyBinder, but there can only be TyVar in the Named field.

valueisInvisiblePiTyBinder :: PiTyBinder -> Bool

#

Does this binder bind an invisible argument?

valueisInvisibleAnonPiTyBinder :: PiTyBinder -> Bool

#

valueisVisiblePiTyBinder :: PiTyBinder -> Bool

#

Does this binder bind a visible argument?

valueisTyBinder :: PiTyBinder -> Bool

#

If its a named binder, is the binder a tyvar? Returns True for nondependent binder. This check that we're really returning a *Ty*Binder (as opposed to a coercion binder). That way, if/when we allow coercion quantification in more places, we'll know we missed updating some function.

valueisNamedPiTyBinder :: PiTyBinder -> Bool

#

valueisAnonPiTyBinder :: PiTyBinder -> Bool

#

Does this binder bind a variable that is not erased? Returns True for anonymous binders.

valuenamedPiTyBinder_maybe :: PiTyBinder -> Maybe TyCoVar

#

valueanonPiTyBinderType_maybe :: PiTyBinder -> Maybe Type

#

Extract a relevant type, if there is one.

valuepiTyBinderType :: PiTyBinder -> Type

#

TyVar's

25 declarations

datadata VarBndr var argf

#

Constructors

Bndr var argf

Instances9Eq, Data, Ord, NFData, Outputable, Binary, …

(Eq var, Eq argf) => Eq (VarBndr var argf)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
(Data var, Data argf) => Data (VarBndr var argf)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
(Ord var, Ord argf) => Ord (VarBndr var argf)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
(NFData tv, NFData vis) => NFData (VarBndr tv vis)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
Outputable tv => Outputable (VarBndr tv ForAllTyFlag)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
Outputable tv => Outputable (VarBndr tv Specificity)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
OutputableBndr tv => Outputable (VarBndr tv TyConBndrVis)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Core.TyCon
(Binary tv, Binary vis) => Binary (VarBndr tv vis)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var
NamedThing tv => NamedThing (VarBndr tv flag)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Var

typetype ForAllTyBinder = VarBndr TyCoVar ForAllTyFlag

#

Variable Binder

A ForAllTyBinder is the binder of a ForAllTy It's convenient to define this synonym here rather its natural home in GHC.Core.TyCo.Rep, because it's used in GHC.Core.DataCon.hs-boot See Note [VarBndrs, ForAllTyBinders, TyConBinders, and visibility]

A TyVarBinder is a binder with only TyVar

typetype TyVarBinder = VarBndr TyVar ForAllTyFlag

#

typetype InvisTyBinder = VarBndr TyCoVar Specificity

#

typetype InvisTVBinder = VarBndr TyVar Specificity

#

typetype ReqTyBinder = VarBndr TyCoVar ()

#

typetype ReqTVBinder = VarBndr TyVar ()

#

valuebinderVar :: VarBndr tv argf -> tv

#

valuebinderVars :: [VarBndr tv argf] -> [tv]

#

valuebinderFlag :: VarBndr tv argf -> argf

#

valuebinderFlags :: [VarBndr tv argf] -> [argf]

#

valuebinderType :: VarBndr TyCoVar argf -> Type

#

valuemkForAllTyBinder :: vis -> TyCoVar -> VarBndr TyCoVar vis

#

Make a named binder

valuemkForAllTyBinders :: vis -> [TyCoVar] -> [VarBndr TyCoVar vis]

#

Make many named binders

valuemkTyVarBinder :: vis -> TyVar -> VarBndr TyVar vis

#

Make a named binder var should be a type variable

valuemkTyVarBinders :: vis -> [TyVar] -> [VarBndr TyVar vis]

#

Make many named binders Input vars should be type variables

valueisVisibleForAllTyBinder :: ForAllTyBinder -> Bool

#

valueisInvisibleForAllTyBinder :: ForAllTyBinder -> Bool

#

valueisTyVarBinder :: VarBndr TyCoVar vis -> Bool

#

valuetyVarSpecToBinder :: VarBndr a Specificity -> VarBndr a ForAllTyFlag

#

valuetyVarSpecToBinders :: [VarBndr a Specificity] -> [VarBndr a ForAllTyFlag]

#

valuetyVarReqToBinder :: VarBndr a () -> VarBndr a ForAllTyFlag

#

valuetyVarReqToBinders :: [VarBndr a ()] -> [VarBndr a ForAllTyFlag]

#

valuemapVarBndr :: (var -> var') -> VarBndr var flag -> VarBndr var' flag

#

valuemapVarBndrs :: (var -> var') -> [VarBndr var flag] -> [VarBndr var' flag]

#

ExportFlag

datadata ExportFlag

#

Constructors

NotExported
Not exported: may be discarded as dead code.
Exported
Exported: kept alive

Constructing TyVar's

valuemkTyVar :: Name -> Kind -> TyVar

#

valuemkTcTyVar :: Name -> Kind -> TcTyVarDetails -> TyVar

#

Taking TyVars apart

valuetyVarName :: TyVar -> Name

#

valuetyVarKind :: TyVar -> Kind

#

valuetcTyVarDetails :: TyVar -> TcTyVarDetails

#

valuesetTcTyVarDetails :: TyVar -> TcTyVarDetails -> TyVar

#

Modifying TyVars

valuesetTyVarName :: TyVar -> Name -> TyVar

#

valuesetTyVarUnique :: TyVar -> Unique -> TyVar

#

valuesetTyVarKind :: TyVar -> Kind -> TyVar

#

valueupdateTyVarKind :: (Kind -> Kind) -> TyVar -> TyVar

#

valueupdateTyVarKindM :: Monad m => (Kind -> m Kind) -> TyVar -> m TyVar

#

valuenonDetCmpVar :: Var -> Var -> Ordering

#

Compare Vars by their Uniques. This is what Ord Var does, provided here to make it explicit at the call-site that it can introduce non-determinism. See Note [Unique Determinism]