Moduleghc-10.0.0.20260917GHC2024

GHC.Hs.Binds

14 types
28 values

Packageghc-10.0.0.20260917
Exports44
LanguageGHC2024
LicenceBSD-3-Clause
SourceBinds.hs

module Language.Haskell.Syntax.Binds

valueemptyLHsBinds :: LHsBindsLR (GhcPass idL) idR

valueemptyLocalBinds :: HsLocalBindsLR (GhcPass a) (GhcPass b)

valueemptyValBindsIn :: HsValBindsLR (GhcPass a) (GhcPass b)

valueemptyValBindsRn :: HsValBindsLR GhcRn GhcRn

valueeqEmptyLocalBinds :: HsLocalBindsLR a b -> Bool

valueextractSpecPragName :: SourceText -> String

Extracts the name for a SPECIALIZE instance pragma. In hsSigDoc, the src field of SpecInstSig signature contains the SourceText for a SPECIALIZE instance pragma of the form: "SourceText {-# SPECIALIZE"

Extraction ensures that all variants of the pragma name (with a Z or an S) are output exactly as used in the pragma.

valuehasSpecPrags :: TcSpecPrags -> Bool

valuehsSigDoc :: IsPass p => Sig (GhcPass p) -> SDoc

valuehsValBindGroupsBinds

:: IsPass p
=> [HsValBindGroup (GhcPass p)]
-> [LHsBind (GhcPass p)]

valueisDefaultMethod :: TcSpecPrags -> Bool

valueisEmptyIPBindsPR :: HsIPBinds (GhcPass p) -> Bool

valueisEmptyIPBindsTc :: HsIPBinds GhcTc -> Bool

valueisEmptyLHsBinds :: LHsBindsLR (GhcPass idL) idR -> Bool

valueisEmptyValBinds :: HsValBindsLR (GhcPass a) (GhcPass b) -> Bool

valuenoSpecPrags :: TcSpecPrags

valueplusHsValBinds

valuepprDeclList :: [SDoc] -> SDoc

valuepprLHsBinds

:: (OutputableBndrId idL, OutputableBndrId idR)
=> LHsBindsLR (GhcPass idL) (GhcPass idR)
-> SDoc

valuepprLHsBindsForUser

:: (OutputableBndrId idL, OutputableBndrId idR, OutputableBndrId id2)
=> LHsBindsLR (GhcPass idL) (GhcPass idR)
-> [LSig (GhcPass id2)]
-> [SDoc]

valuepprMinimalSig :: OutputableBndrId p => LBooleanFormula (GhcPass p) -> SDoc

valuepprSpec

:: (IsPass p, OutputableBndr id)
=> id
-> SDoc
-> InlinePragma (GhcPass p)
-> SDoc

valuepprTcSpecPrags :: TcSpecPrags -> SDoc

valuepprTicks :: SDoc -> SDoc -> SDoc

valuepprVarSig :: OutputableBndr id => [id] -> SDoc -> SDoc

valueppr_monobind

:: (OutputableBndrId idL, OutputableBndrId idR)
=> HsBindLR (GhcPass idL) (GhcPass idR)
-> SDoc

valueppr_sig :: (IsPass p, OutputableBndrId p) => Sig (GhcPass p) -> SDoc

valuepragBrackets :: SDoc -> SDoc

valuepragSrcBrackets :: SourceText -> String -> SDoc -> SDoc

Using SourceText in case the pragma was spelled differently or used mixed case

datadata ABExport

Abstraction Bindings Export

Constructors

ABE
- abe_poly :: Id
  Any INLINE pragma is attached to this Id
- abe_mono :: Id
- abe_wrap :: HsWrapper
  See Note [ABExport wrapper] Shape: (forall abs_tvs. abs_ev_vars => abe_mono) ~ abe_poly
- abe_prags :: TcSpecPrags
  SPECIALISE pragmas

Instances2Data, Outputable

Data ABExportDefined in ghc-10.0.0.20260917 · GHC.Hs.Instances · orphan
Outputable ABExportDefined in ghc-10.0.0.20260917 · GHC.Hs.Binds

datadata AbsBinds

Typechecked, generalised bindings, used in the output to the type checker. See Note [AbsBinds].

Constructors

AbsBinds
- abs_tvs :: [TyVar]
- abs_ev_vars :: [EvVar]
  Includes equality constraints
- abs_exports :: [ABExport]
  AbsBinds only gets used when idL = idR after renaming, but these need to be idL's for the collect... code in HsUtil to have the right type
- abs_ev_binds :: [TcEvBinds]
  Evidence bindings Why a list? See GHC.Tc.TyCl.Instance Note [Typechecking plan for instance declarations]
- abs_binds :: LHsBinds GhcTc
  Typechecked user bindings
- abs_sig :: Bool

Instances1Data

Data AbsBindsDefined in ghc-10.0.0.20260917 · GHC.Hs.Instances · orphan

datadata ActivationAnn

Constructors

ActivationAnn
- aa_openc :: EpToken "["
- aa_phase :: SourceText
- aa_closec :: EpToken "]"
- aa_tilde :: Maybe (EpToken "~")
- aa_val :: Maybe EpaLocation

Instances3Eq, Data, NoAnn

Eq ActivationAnnDefined in ghc-10.0.0.20260917 · GHC.Hs.Binds
Data ActivationAnnDefined in ghc-10.0.0.20260917 · GHC.Hs.Binds
NoAnn ActivationAnnDefined in ghc-10.0.0.20260917 · GHC.Hs.Binds

datadata AnnPSB

Constructors

AnnPSB
- ap_pattern :: EpToken "pattern"
- ap_openc :: Maybe (EpToken "{")
- ap_closec :: Maybe (EpToken "}")
- ap_larrow :: Maybe (EpUniToken "<-" "\8592")
- ap_equal :: Maybe (EpToken "=")

Instances2Data, NoAnn

Data AnnPSBDefined in ghc-10.0.0.20260917 · GHC.Hs.Binds
NoAnn AnnPSBDefined in ghc-10.0.0.20260917 · GHC.Hs.Binds

datadata AnnSig

Constructors

AnnSig
- asDcolon :: EpUniToken "::" "\8759"
- asPattern :: Maybe (EpToken "pattern")
- asDefault :: Maybe (EpToken "default")

Instances2Data, NoAnn

Data AnnSigDefined in ghc-10.0.0.20260917 · GHC.Hs.Binds
NoAnn AnnSigDefined in ghc-10.0.0.20260917 · GHC.Hs.Binds

datadata AnnSpecSig

Constructors

AnnSpecSig
- ass_open :: EpaLocation
- ass_close :: EpToken "#-}"
- ass_dcolon :: Maybe TokDcolon
- ass_act :: ActivationAnn

Instances2Data, NoAnn

Data AnnSpecSigDefined in ghc-10.0.0.20260917 · GHC.Hs.Binds
NoAnn AnnSpecSigDefined in ghc-10.0.0.20260917 · GHC.Hs.Binds

datadata HsRuleBndrsAnn

Constructors

HsRuleBndrsAnn
- rb_tyanns :: Maybe (TokForall, EpToken ".")
  The locations of forall and . for forall'd type vars Using AddEpAnn to capture possible unicode variants
- rb_tmanns :: Maybe (TokForall, EpToken ".")
  The locations of forall and . for forall'd term vars Using AddEpAnn to capture possible unicode variants

Instances3Eq, Data, NoAnn

Eq HsRuleBndrsAnnDefined in ghc-10.0.0.20260917 · GHC.Hs.Binds
Data HsRuleBndrsAnnDefined in ghc-10.0.0.20260917 · GHC.Hs.Binds
NoAnn HsRuleBndrsAnnDefined in ghc-10.0.0.20260917 · GHC.Hs.Binds

familytype family HsValBindGroup p

Instances3HsValBindGroup

type HsValBindGroup GhcPs = ()Defined in ghc-10.0.0.20260917 · GHC.Hs.Binds
type HsValBindGroup GhcRn = (RecFlag, LHsBinds GhcRn)Defined in ghc-10.0.0.20260917 · GHC.Hs.Binds
type HsValBindGroup GhcTc = (RecFlag, LHsBinds GhcTc)Defined in ghc-10.0.0.20260917 · GHC.Hs.Binds

datadata HsValBindGroups (p :: Pass)

Constructors

HsVBG [HsValBindGroup (GhcPass p)] [LSig GhcRn]

Instances4Data, ToHie

Data (HsValBindGroups 'Parsed)Defined in ghc-10.0.0.20260917 · GHC.Hs.Instances · orphan
Data (HsValBindGroups 'Renamed)Defined in ghc-10.0.0.20260917 · GHC.Hs.Instances · orphan
Data (HsValBindGroups 'Typechecked)Defined in ghc-10.0.0.20260917 · GHC.Hs.Instances · orphan
HiePass p => ToHie (RScoped (HsValBindGroups p))Defined in ghc-10.0.0.20260917 · GHC.Iface.Ext.Ast

newtypenewtype IdSig

A type signature in generated code, notably the code generated for record selectors. We simply record the desired Id itself, replete with its name, type and IdDetails. Otherwise it's just like a type signature: there should be an accompanying binding

Constructors

IdSig
- unIdSig :: Id

Instances1Data

Data IdSigDefined in ghc-10.0.0.20260917 · GHC.Hs.Binds

typetype LTcSpecPrag = Located TcSpecPrag

Located Type checker Specialisation Pragmas

datadata TcSpecPrag

Type checker Specialisation Pragma

This data type is used to communicate between the typechecker and the desugarer.

Constructors

SpecPrag Id HsWrapper (InlinePragma GhcTc)
Old-form specialise pragma
SpecPragE
- spe_fn_nm :: Name
  Name of the Id being specialised
- spe_fn_id :: Id
  Id being specialised
  Note that spe_fn_nm may differ from idName spe_fn_id in the case of instance methods, where the Name is the class-op selector but the spe_fn_id is that for the local method
- spe_inl :: InlinePragma GhcTc
  (optional) INLINE annotation and activation phase annotation
- spe_bndrs :: [Var]
  TyVars, EvVars, and Ids
- spe_call :: LHsExpr GhcTc
  The type-checked specialise expression

Instances2Data, Outputable

Data TcSpecPragDefined in ghc-10.0.0.20260917 · GHC.Hs.Instances · orphan
Outputable TcSpecPragDefined in ghc-10.0.0.20260917 · GHC.Hs.Binds

datadata TcSpecPrags

Type checker Specialisation Pragmas

TcSpecPrags conveys SPECIALISE pragmas from the type checker to the desugarer

Constructors

IsDefaultMethod
Super-specialised: a default method should be macro-expanded at every call site
SpecPrags [LTcSpecPrag]

Instances1Data

Data TcSpecPragsDefined in ghc-10.0.0.20260917 · GHC.Hs.Instances · orphan

datadata XPatBindTc

Constructors

XPatBindTc
- patBindGRHSType :: Type
  Type of the GRHSs
- patBindRHSTicks :: [CoreTickish]
  Ticks to put on the rhs
- patBindVarsTicks :: [[CoreTickish]]
  Ticks to put on the bound variables
- patBindMult :: Mult
  Multiplicity, given by a modifier or inferred

Instances1Data

Data XPatBindTcDefined in ghc-10.0.0.20260917 · GHC.Hs.Instances · orphan

familytype family XVarBindGhc (pL :: Pass) (pR :: Pass) where

Equations

XVarBindGhc 'Typechecked 'Typechecked = NoExtField
XVarBindGhc _1 _2 = DataConCantHappen

datadata HsRuleBndrsAnn

Constructors

HsRuleBndrsAnn
- rb_tyanns :: Maybe (TokForall, EpToken ".")
  The locations of forall and . for forall'd type vars Using AddEpAnn to capture possible unicode variants
- rb_tmanns :: Maybe (TokForall, EpToken ".")
  The locations of forall and . for forall'd term vars Using AddEpAnn to capture possible unicode variants

Instances3Eq, Data, NoAnn

Eq HsRuleBndrsAnnDefined in ghc-10.0.0.20260917 · GHC.Hs.Binds
Data HsRuleBndrsAnnDefined in ghc-10.0.0.20260917 · GHC.Hs.Binds
NoAnn HsRuleBndrsAnnDefined in ghc-10.0.0.20260917 · GHC.Hs.Binds

Orphan instances

11 instances

OutputableBndrId p => Outputable (FixitySig (GhcPass p))
OutputableBndrId p => Outputable (HsIPBinds (GhcPass p))
OutputableBndrId p => Outputable (IPBind (GhcPass p))
OutputableBndrId p => Outputable (RuleBndr (GhcPass p))
OutputableBndrId p => Outputable (RuleBndrs (GhcPass p))
OutputableBndrId p => Outputable (Sig (GhcPass p))
Outputable (XRecGhc (IdGhcP p)) => Outputable (RecordPatSynField (GhcPass p))
(OutputableBndrId l, OutputableBndrId r) => Outputable (PatSynBind (GhcPass l) (GhcPass r))
(OutputableBndrId pl, OutputableBndrId pr) => Outputable (HsBindLR (GhcPass pl) (GhcPass pr))
(OutputableBndrId pl, OutputableBndrId pr) => Outputable (HsLocalBindsLR (GhcPass pl) (GhcPass pr))
(OutputableBndrId pl, OutputableBndrId pr) => Outputable (HsValBindsLR (GhcPass pl) (GhcPass pr))