GHC.Tc.Types

Various types used during typechecking.

Please see GHC.Tc.Utils.Monad as well for operations on these types. You probably want to import it, instead of this module.

All the monads exported here are built on top of the same IOEnv monad. The monad functions like a Reader monad in the way it passes the environment around. This is done to allow the environment to be manipulated in a stack like fashion when entering expressions... etc.

For state that is global and should be returned at the end (e.g not part of the stack mechanism), you should use a TcRef (= IORef) to store them.

Documentation

type TcRnIf a b = IOEnv (Env a b)

type TcRn = TcRnIf TcGblEnv TcLclEnv

type TcM = TcRn

Historical "type-checking monad" (now it's just TcRn).

type RnM = TcRn

Historical "renaming monad" (now it's just TcRn).

type IfM lcl = TcRnIf IfGblEnv lcl

type IfL = IfM IfLclEnv

type IfG = IfM ()

type TcRef a = IORef a

Type alias for IORef; the convention is we'll use this for mutable bits of data in TcGblEnv which are updated during typechecking and returned at the end.

data Env gbl lcl

Constructors

Env

Fields

• env_top :: !HscEnv
• env_um :: !Char
• env_gbl :: gbl
• env_lcl :: lcl

Instances

Quasi TcM

Defined in GHC.Tc.Gen.Splice

Methods

qNewName :: String -> TcM Name

qReport :: Bool -> String -> TcM ()

qRecover :: TcM a -> TcM a -> TcM a

qLookupName :: Bool -> String -> TcM (Maybe Name)

qReify :: Name -> TcM Info

qReifyFixity :: Name -> TcM (Maybe Fixity)

qReifyType :: Name -> TcM Type

qReifyInstances :: Name -> [Type] -> TcM [Dec]

qReifyRoles :: Name -> TcM [Role]

qReifyAnnotations :: Data a => AnnLookup -> TcM [a]

qReifyModule :: Module -> TcM ModuleInfo

qReifyConStrictness :: Name -> TcM [DecidedStrictness]

qLocation :: TcM Loc

qRunIO :: IO a -> TcM a

qAddDependentFile :: FilePath -> TcM ()

qAddTempFile :: String -> TcM FilePath

qAddTopDecls :: [Dec] -> TcM ()

qAddForeignFilePath :: ForeignSrcLang -> String -> TcM ()

qAddModFinalizer :: Q () -> TcM ()

qAddCorePlugin :: String -> TcM ()

qGetQ :: Typeable a => TcM (Maybe a)

qPutQ :: Typeable a => a -> TcM ()

qIsExtEnabled :: Extension -> TcM Bool

qExtsEnabled :: TcM [Extension]

MonadThings (IOEnv (Env DsGblEnv DsLclEnv))

Defined in GHC.HsToCore.Monad

Methods

lookupThing :: Name -> IOEnv (Env DsGblEnv DsLclEnv) TyThing

lookupId :: Name -> IOEnv (Env DsGblEnv DsLclEnv) Id

lookupDataCon :: Name -> IOEnv (Env DsGblEnv DsLclEnv) DataCon

lookupTyCon :: Name -> IOEnv (Env DsGblEnv DsLclEnv) TyCon

MonadThings (IOEnv (Env TcGblEnv TcLclEnv))

Defined in GHC.Tc.Utils.Env

Methods

lookupThing :: Name -> IOEnv (Env TcGblEnv TcLclEnv) TyThing

lookupId :: Name -> IOEnv (Env TcGblEnv TcLclEnv) Id

lookupDataCon :: Name -> IOEnv (Env TcGblEnv TcLclEnv) DataCon

lookupTyCon :: Name -> IOEnv (Env TcGblEnv TcLclEnv) TyCon

MonadUnique (IOEnv (Env gbl lcl))

Defined in GHC.Tc.Utils.Monad

Methods

getUniqueSupplyM :: IOEnv (Env gbl lcl) UniqSupply

getUniqueM :: IOEnv (Env gbl lcl) Unique

getUniquesM :: IOEnv (Env gbl lcl) [Unique]

ContainsDynFlags (Env gbl lcl)

Defined in GHC.Tc.Types

Methods

extractDynFlags :: Env gbl lcl -> DynFlags

ContainsModule gbl => ContainsModule (Env gbl lcl)

Defined in GHC.Tc.Types

Methods

extractModule :: Env gbl lcl -> Module

data TcGblEnv

TcGblEnv describes the top-level of the module at the point at which the typechecker is finished work. It is this structure that is handed on to the desugarer For state that needs to be updated during the typechecking phase and returned at end, use a TcRef (= IORef).

Constructors

TcGblEnv

Fields

• tcg_mod :: Module

  Module being compiled

• tcg_semantic_mod :: Module

  If a signature, the backing module See also Note [Identity versus semantic module]

• tcg_src :: HscSource

  What kind of module (regular Haskell, hs-boot, hsig)

• tcg_rdr_env :: GlobalRdrEnv

  Top level envt; used during renaming

• tcg_default :: Maybe [Type]

  Types used for defaulting. Nothing => no default decl

• tcg_fix_env :: FixityEnv

  Just for things in this module

• tcg_field_env :: RecFieldEnv

  Just for things in this module See Note [The interactive package] in GHC.Driver.Types

• tcg_type_env :: TypeEnv

  Global type env for the module we are compiling now. All TyCons and Classes (for this module) end up in here right away, along with their derived constructors, selectors.

  (Ids defined in this module start in the local envt, though they move to the global envt during zonking)

  NB: for what "things in this module" means, see Note [The interactive package] in GHC.Driver.Types

• tcg_type_env_var :: TcRef TypeEnv
• tcg_inst_env :: !InstEnv

  Instance envt for all home-package modules; Includes the dfuns in tcg_insts NB. BangPattern is to fix a leak, see #15111

• tcg_fam_inst_env :: !FamInstEnv

  Ditto for family instances NB. BangPattern is to fix a leak, see #15111

• tcg_ann_env :: AnnEnv

  And for annotations

• tcg_exports :: [AvailInfo]

  What is exported

• tcg_imports :: ImportAvails

  Information about what was imported from where, including things bound in this module. Also store Safe Haskell info here about transitive trusted package requirements.

  There are not many uses of this field, so you can grep for all them.

  The ImportAvails records information about the following things:

  1. All of the modules you directly imported (tcRnImports)
  2. The orphans (only!) of all imported modules in a GHCi session (runTcInteractive)
  3. The module that instantiated a signature
  4. Each of the signatures that merged in

  It is used in the following ways: - imp_orphs is used to determine what orphan modules should be visible in the context (tcVisibleOrphanMods) - imp_finsts is used to determine what family instances should be visible (tcExtendLocalFamInstEnv) - To resolve the meaning of the export list of a module (tcRnExports) - imp_mods is used to compute usage info (mkIfaceTc, deSugar) - imp_trust_own_pkg is used for Safe Haskell in interfaces (mkIfaceTc, as well as in GHC.Driver.Main) - To create the Dependencies field in interface (mkDependencies)

• tcg_dus :: DefUses
• tcg_used_gres :: TcRef [GlobalRdrElt]
• tcg_keep :: TcRef NameSet
• tcg_th_used :: TcRef Bool

  True <=> Template Haskell syntax used.

  We need this so that we can generate a dependency on the Template Haskell package, because the desugarer is going to emit loads of references to TH symbols. The reference is implicit rather than explicit, so we have to zap a mutable variable.

• tcg_th_splice_used :: TcRef Bool

  True <=> A Template Haskell splice was used.

  Splices disable recompilation avoidance (see #481)

• tcg_dfun_n :: TcRef OccSet

  Allows us to choose unique DFun names.

• tcg_merged :: [(Module, Fingerprint)]

  The requirements we merged with; we always have to recompile if any of these changed.

• tcg_rn_exports :: Maybe [(Located (IE GhcRn), Avails)]
• tcg_rn_imports :: [LImportDecl GhcRn]
• tcg_rn_decls :: Maybe (HsGroup GhcRn)

  Renamed decls, maybe. Nothing <=> Don't retain renamed decls.

• tcg_dependent_files :: TcRef [FilePath]

  dependencies from addDependentFile

• tcg_th_topdecls :: TcRef [LHsDecl GhcPs]

  Top-level declarations from addTopDecls

• tcg_th_foreign_files :: TcRef [(ForeignSrcLang, FilePath)]

  Foreign files emitted from TH.

• tcg_th_topnames :: TcRef NameSet

  Exact names bound in top-level declarations in tcg_th_topdecls

• tcg_th_modfinalizers :: TcRef [(TcLclEnv, ThModFinalizers)]

  Template Haskell module finalizers.

  They can use particular local environments.

• tcg_th_coreplugins :: TcRef [String]

  Core plugins added by Template Haskell code.

• tcg_th_state :: TcRef (Map TypeRep Dynamic)
• tcg_th_remote_state :: TcRef (Maybe (ForeignRef (IORef QState)))

  Template Haskell state

• tcg_ev_binds :: Bag EvBind
• tcg_tr_module :: Maybe Id
• tcg_binds :: LHsBinds GhcTc
• tcg_sigs :: NameSet
• tcg_imp_specs :: [LTcSpecPrag]
• tcg_warns :: Warnings
• tcg_anns :: [Annotation]
• tcg_tcs :: [TyCon]
• tcg_insts :: [ClsInst]
• tcg_fam_insts :: [FamInst]
• tcg_rules :: [LRuleDecl GhcTc]
• tcg_fords :: [LForeignDecl GhcTc]
• tcg_patsyns :: [PatSyn]
• tcg_doc_hdr :: Maybe LHsDocString

  Maybe Haddock header docs

• tcg_hpc :: !AnyHpcUsage

  True if any part of the prog uses hpc instrumentation. NB. BangPattern is to fix a leak, see #15111

• tcg_self_boot :: SelfBootInfo

  Whether this module has a corresponding hi-boot file

• tcg_main :: Maybe Name

  The Name of the main function, if this module is the main module.

• tcg_safeInfer :: TcRef (Bool, WarningMessages)

  Has the typechecker inferred this module as -XSafe (Safe Haskell) See Note [Safe Haskell Overlapping Instances Implementation], although this is used for more than just that failure case.

• tcg_tc_plugins :: [TcPluginSolver]

  A list of user-defined plugins for the constraint solver.

• tcg_hf_plugins :: [HoleFitPlugin]

  A list of user-defined plugins for hole fit suggestions.

• tcg_top_loc :: RealSrcSpan

  The RealSrcSpan this module came from

• tcg_static_wc :: TcRef WantedConstraints

  Wanted constraints of static forms. See Note [Constraints in static forms].

• tcg_complete_matches :: [CompleteMatch]

  Tracking indices for cost centre annotations

• tcg_cc_st :: TcRef CostCentreState

Instances

ContainsCostCentreState TcGblEnv

Defined in GHC.Tc.Utils.Monad

Methods

extractCostCentreState :: TcGblEnv -> TcRef CostCentreState

ContainsModule TcGblEnv

Defined in GHC.Tc.Types

Methods

extractModule :: TcGblEnv -> Module

Quasi TcM

Defined in GHC.Tc.Gen.Splice

Methods

qNewName :: String -> TcM Name

qReport :: Bool -> String -> TcM ()

qRecover :: TcM a -> TcM a -> TcM a

qLookupName :: Bool -> String -> TcM (Maybe Name)

qReify :: Name -> TcM Info

qReifyFixity :: Name -> TcM (Maybe Fixity)

qReifyType :: Name -> TcM Type

qReifyInstances :: Name -> [Type] -> TcM [Dec]

qReifyRoles :: Name -> TcM [Role]

qReifyAnnotations :: Data a => AnnLookup -> TcM [a]

qReifyModule :: Module -> TcM ModuleInfo

qReifyConStrictness :: Name -> TcM [DecidedStrictness]

qLocation :: TcM Loc

qRunIO :: IO a -> TcM a

qAddDependentFile :: FilePath -> TcM ()

qAddTempFile :: String -> TcM FilePath

qAddTopDecls :: [Dec] -> TcM ()

qAddForeignFilePath :: ForeignSrcLang -> String -> TcM ()

qAddModFinalizer :: Q () -> TcM ()

qAddCorePlugin :: String -> TcM ()

qGetQ :: Typeable a => TcM (Maybe a)

qPutQ :: Typeable a => a -> TcM ()

qIsExtEnabled :: Extension -> TcM Bool

qExtsEnabled :: TcM [Extension]

MonadThings (IOEnv (Env TcGblEnv TcLclEnv))

Defined in GHC.Tc.Utils.Env

Methods

lookupThing :: Name -> IOEnv (Env TcGblEnv TcLclEnv) TyThing

lookupId :: Name -> IOEnv (Env TcGblEnv TcLclEnv) Id

lookupDataCon :: Name -> IOEnv (Env TcGblEnv TcLclEnv) DataCon

lookupTyCon :: Name -> IOEnv (Env TcGblEnv TcLclEnv) TyCon

data TcLclEnv

Constructors

TcLclEnv

Fields

• tcl_loc :: RealSrcSpan
• tcl_ctxt :: [ErrCtxt]
• tcl_in_gen_code :: Bool
• tcl_tclvl :: TcLevel
• tcl_th_ctxt :: ThStage
• tcl_th_bndrs :: ThBindEnv
• tcl_arrow_ctxt :: ArrowCtxt
• tcl_rdr :: LocalRdrEnv
• tcl_env :: TcTypeEnv
• tcl_usage :: TcRef UsageEnv
• tcl_bndrs :: TcBinderStack
• tcl_lie :: TcRef WantedConstraints
• tcl_errs :: TcRef Messages

Instances

Quasi TcM

Defined in GHC.Tc.Gen.Splice

Methods

qNewName :: String -> TcM Name

qReport :: Bool -> String -> TcM ()

qRecover :: TcM a -> TcM a -> TcM a

qLookupName :: Bool -> String -> TcM (Maybe Name)

qReify :: Name -> TcM Info

qReifyFixity :: Name -> TcM (Maybe Fixity)

qReifyType :: Name -> TcM Type

qReifyInstances :: Name -> [Type] -> TcM [Dec]

qReifyRoles :: Name -> TcM [Role]

qReifyAnnotations :: Data a => AnnLookup -> TcM [a]

qReifyModule :: Module -> TcM ModuleInfo

qReifyConStrictness :: Name -> TcM [DecidedStrictness]

qLocation :: TcM Loc

qRunIO :: IO a -> TcM a

qAddDependentFile :: FilePath -> TcM ()

qAddTempFile :: String -> TcM FilePath

qAddTopDecls :: [Dec] -> TcM ()

qAddForeignFilePath :: ForeignSrcLang -> String -> TcM ()

qAddModFinalizer :: Q () -> TcM ()

qAddCorePlugin :: String -> TcM ()

qGetQ :: Typeable a => TcM (Maybe a)

qPutQ :: Typeable a => a -> TcM ()

qIsExtEnabled :: Extension -> TcM Bool

qExtsEnabled :: TcM [Extension]

MonadThings (IOEnv (Env TcGblEnv TcLclEnv))

Defined in GHC.Tc.Utils.Env

Methods

lookupThing :: Name -> IOEnv (Env TcGblEnv TcLclEnv) TyThing

lookupId :: Name -> IOEnv (Env TcGblEnv TcLclEnv) Id

lookupDataCon :: Name -> IOEnv (Env TcGblEnv TcLclEnv) DataCon

lookupTyCon :: Name -> IOEnv (Env TcGblEnv TcLclEnv) TyCon

setLclEnvTcLevel :: TcLclEnv -> TcLevel -> TcLclEnv

getLclEnvTcLevel :: TcLclEnv -> TcLevel

setLclEnvLoc :: TcLclEnv -> RealSrcSpan -> TcLclEnv

getLclEnvLoc :: TcLclEnv -> RealSrcSpan

data IfGblEnv

Constructors

IfGblEnv

Fields

• if_doc :: SDoc
• if_rec_types :: Maybe (Module, IfG TypeEnv)

data IfLclEnv

Constructors

IfLclEnv

Fields

• if_mod :: Module
• if_boot :: IsBootInterface
• if_loc :: SDoc
• if_nsubst :: Maybe NameShape
• if_implicits_env :: Maybe TypeEnv
• if_tv_env :: FastStringEnv TyVar
• if_id_env :: FastStringEnv Id

tcVisibleOrphanMods :: TcGblEnv -> ModuleSet

data FrontendResult

FrontendResult describes the result of running the frontend of a Haskell module. Currently one always gets a FrontendTypecheck, since running the frontend involves typechecking a program. hs-sig merges are not handled here.

This data type really should be in GHC.Driver.Types, but it needs to have a TcGblEnv which is only defined here.

Constructors

FrontendTypecheck TcGblEnv

type ErrCtxt = (Bool, TidyEnv -> TcM (TidyEnv, MsgDoc))

type RecFieldEnv = NameEnv [FieldLabel]

pushErrCtxt :: CtOrigin -> ErrCtxt -> CtLoc -> CtLoc

pushErrCtxtSameOrigin :: ErrCtxt -> CtLoc -> CtLoc

data ImportAvails

ImportAvails summarises what was imported from where, irrespective of whether the imported things are actually used or not. It is used:

• when processing the export list,
• when constructing usage info for the interface file,
• to identify the list of directly imported modules for initialisation purposes and for optimised overlap checking of family instances,
• when figuring out what things are really unused

Constructors

ImportAvails

Fields

• imp_mods :: ImportedMods

  Domain is all directly-imported modules

  See the documentation on ImportedModsVal in GHC.Driver.Types for the meaning of the fields.

  We need a full ModuleEnv rather than a ModuleNameEnv here, because we might be importing modules of the same name from different packages. (currently not the case, but might be in the future).

• imp_dep_mods :: ModuleNameEnv ModuleNameWithIsBoot

  Home-package modules needed by the module being compiled

  It doesn't matter whether any of these dependencies are actually used when compiling the module; they are listed if they are below it at all. For example, suppose M imports A which imports X. Then compiling M might not need to consult X.hi, but X is still listed in M's dependencies.

• imp_dep_pkgs :: Set UnitId

  Packages needed by the module being compiled, whether directly, or via other modules in this package, or via modules imported from other packages.

• imp_trust_pkgs :: Set UnitId

  This is strictly a subset of imp_dep_pkgs and records the packages the current module needs to trust for Safe Haskell compilation to succeed. A package is required to be trusted if we are dependent on a trustworthy module in that package. While perhaps making imp_dep_pkgs a tuple of (UnitId, Bool) where True for the bool indicates the package is required to be trusted is the more logical design, doing so complicates a lot of code not concerned with Safe Haskell. See Note [Tracking Trust Transitively] in GHC.Rename.Names

• imp_trust_own_pkg :: Bool

  Do we require that our own package is trusted? This is to handle efficiently the case where a Safe module imports a Trustworthy module that resides in the same package as it. See Note [Trust Own Package] in GHC.Rename.Names

• imp_orphs :: [Module]

  Orphan modules below us in the import tree (and maybe including us for imported modules)

• imp_finsts :: [Module]

  Family instance modules below us in the import tree (and maybe including us for imported modules)

emptyImportAvails :: ImportAvails

plusImportAvails :: ImportAvails -> ImportAvails -> ImportAvails

Union two ImportAvails

This function is a key part of Import handling, basically for each import we create a separate ImportAvails structure and then union them all together with this function.

data WhereFrom

Constructors

ImportByUser IsBootInterface

ImportBySystem

ImportByPlugin

Instances

Outputable WhereFrom

Defined in GHC.Tc.Types

Methods

ppr :: WhereFrom -> SDoc

pprPrec :: Rational -> WhereFrom -> SDoc

mkModDeps :: [ModuleNameWithIsBoot] -> ModuleNameEnv ModuleNameWithIsBoot

modDepsElts :: ModuleNameEnv ModuleNameWithIsBoot -> [ModuleNameWithIsBoot]

type TcTypeEnv = NameEnv TcTyThing

type TcBinderStack = [TcBinder]

data TcBinder

Constructors

TcIdBndr TcId TopLevelFlag

TcIdBndr_ExpType Name ExpType TopLevelFlag

TcTvBndr Name TyVar

Instances

HasOccName TcBinder

Defined in GHC.Tc.Types

Methods

occName :: TcBinder -> OccName

Outputable TcBinder

Defined in GHC.Tc.Types

Methods

ppr :: TcBinder -> SDoc

pprPrec :: Rational -> TcBinder -> SDoc

data TcTyThing

A typecheckable thing available in a local context. Could be AGlobal TyThing, but also lexically scoped variables, etc. See GHC.Tc.Utils.Env for how to retrieve a TyThing given a Name.

Constructors

AGlobal TyThing

ATcId

Fields

• tct_id :: TcId
• tct_info :: IdBindingInfo

ATyVar Name TcTyVar

ATcTyCon TyCon

APromotionErr PromotionErr

Instances

Outputable TcTyThing

Defined in GHC.Tc.Types

Methods

ppr :: TcTyThing -> SDoc

pprPrec :: Rational -> TcTyThing -> SDoc

data PromotionErr

Constructors

TyConPE

ClassPE

FamDataConPE

ConstrainedDataConPE PredType

PatSynPE

RecDataConPE

NoDataKindsTC

NoDataKindsDC

Instances

Outputable PromotionErr

Defined in GHC.Tc.Types

Methods

ppr :: PromotionErr -> SDoc

pprPrec :: Rational -> PromotionErr -> SDoc

data IdBindingInfo

IdBindingInfo describes how an Id is bound.

It is used for the following purposes: a) for static forms in checkClosedInStaticForm and b) to figure out when a nested binding can be generalised, in decideGeneralisationPlan.

Constructors

NotLetBound

ClosedLet

NonClosedLet RhsNames ClosedTypeId

Instances

Outputable IdBindingInfo

Defined in GHC.Tc.Types

Methods

ppr :: IdBindingInfo -> SDoc

pprPrec :: Rational -> IdBindingInfo -> SDoc

type ClosedTypeId = Bool

type RhsNames = NameSet

data IsGroupClosed

IsGroupClosed describes a group of mutually-recursive bindings

Constructors

IsGroupClosed (NameEnv RhsNames) ClosedTypeId

data SelfBootInfo

Constructors

NoSelfBoot

SelfBoot

Fields

• sb_mds :: ModDetails
• sb_tcs :: NameSet

tcTyThingCategory :: TcTyThing -> String

pprTcTyThingCategory :: TcTyThing -> SDoc

peCategory :: PromotionErr -> String

pprPECategory :: PromotionErr -> SDoc

data CompleteMatch

A list of conlikes which represents a complete pattern match. These arise from COMPLETE signatures.

Constructors

CompleteMatch

Fields

• completeMatchConLikes :: [Name]

  The ConLikes that form a covering family (e.g. Nothing, Just)

• completeMatchTyCon :: Name

  The TyCon that they cover (e.g. Maybe)

Instances

Outputable CompleteMatch

Defined in GHC.Driver.Types

Methods

ppr :: CompleteMatch -> SDoc

pprPrec :: Rational -> CompleteMatch -> SDoc

type DsM = TcRnIf DsGblEnv DsLclEnv

data DsLclEnv

Constructors

DsLclEnv

Fields

• dsl_meta :: DsMetaEnv
• dsl_loc :: RealSrcSpan
• dsl_deltas :: Deltas

Instances

MonadThings (IOEnv (Env DsGblEnv DsLclEnv))

Defined in GHC.HsToCore.Monad

Methods

lookupThing :: Name -> IOEnv (Env DsGblEnv DsLclEnv) TyThing

lookupId :: Name -> IOEnv (Env DsGblEnv DsLclEnv) Id

lookupDataCon :: Name -> IOEnv (Env DsGblEnv DsLclEnv) DataCon

lookupTyCon :: Name -> IOEnv (Env DsGblEnv DsLclEnv) TyCon

data DsGblEnv

Constructors

DsGblEnv

Fields

• ds_mod :: Module
• ds_fam_inst_env :: FamInstEnv
• ds_unqual :: PrintUnqualified
• ds_msgs :: IORef Messages
• ds_if_env :: (IfGblEnv, IfLclEnv)
• ds_complete_matches :: CompleteMatchMap
• ds_cc_st :: IORef CostCentreState

Instances

ContainsCostCentreState DsGblEnv

Defined in GHC.Tc.Utils.Monad

Methods

extractCostCentreState :: DsGblEnv -> TcRef CostCentreState

ContainsModule DsGblEnv

Defined in GHC.Tc.Types

Methods

extractModule :: DsGblEnv -> Module

MonadThings (IOEnv (Env DsGblEnv DsLclEnv))

Defined in GHC.HsToCore.Monad

Methods

lookupThing :: Name -> IOEnv (Env DsGblEnv DsLclEnv) TyThing

lookupId :: Name -> IOEnv (Env DsGblEnv DsLclEnv) Id

lookupDataCon :: Name -> IOEnv (Env DsGblEnv DsLclEnv) DataCon

lookupTyCon :: Name -> IOEnv (Env DsGblEnv DsLclEnv) TyCon

type DsMetaEnv = NameEnv DsMetaVal

data DsMetaVal

Constructors

DsBound Id

DsSplice (HsExpr GhcTc)

type CompleteMatchMap = UniqFM Name [CompleteMatch]

A map keyed by the completeMatchTyCon which has type Name.

mkCompleteMatchMap :: [CompleteMatch] -> CompleteMatchMap

extendCompleteMatchMap :: CompleteMatchMap -> [CompleteMatch] -> CompleteMatchMap

data ThStage

Constructors

Splice SpliceType

RunSplice (TcRef [ForeignRef (Q ())])

Comp

Brack ThStage PendingStuff

Instances

Outputable ThStage

Defined in GHC.Tc.Types

Methods

ppr :: ThStage -> SDoc

pprPrec :: Rational -> ThStage -> SDoc

data SpliceType

Constructors

Typed

Untyped

data PendingStuff

Constructors

RnPendingUntyped (TcRef [PendingRnSplice])

RnPendingTyped

TcPending (TcRef [PendingTcSplice]) (TcRef WantedConstraints) QuoteWrapper

topStage :: ThStage

topAnnStage :: ThStage

topSpliceStage :: ThStage

type ThLevel = Int

impLevel :: ThLevel

outerLevel :: ThLevel

thLevel :: ThStage -> ThLevel

data ForeignSrcLang

Foreign formats supported by GHC via TH

Constructors

LangC

C

LangCxx

C++

LangObjc

Objective C

LangObjcxx

Objective C++

LangAsm

Assembly language (.s)

RawObject

Object (.o)

Instances

Generic ForeignSrcLang

Defined in GHC.ForeignSrcLang.Type

Associated Types

type Rep ForeignSrcLang :: Type -> Type

Methods

from :: ForeignSrcLang -> Rep ForeignSrcLang x

to :: Rep ForeignSrcLang x -> ForeignSrcLang

Show ForeignSrcLang

Defined in GHC.ForeignSrcLang.Type

Methods

showsPrec :: Int -> ForeignSrcLang -> ShowS

show :: ForeignSrcLang -> String

showList :: [ForeignSrcLang] -> ShowS

Eq ForeignSrcLang

Defined in GHC.ForeignSrcLang.Type

Methods

(==) :: ForeignSrcLang -> ForeignSrcLang -> Bool

(/=) :: ForeignSrcLang -> ForeignSrcLang -> Bool

type Rep ForeignSrcLang

Defined in GHC.ForeignSrcLang.Type

type Rep ForeignSrcLang = D1 ('MetaData "ForeignSrcLang" "GHC.ForeignSrcLang.Type" "ghc-boot-th-9.0.2" 'False) ((C1 ('MetaCons "LangC" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "LangCxx" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LangObjc" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "LangObjcxx" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "LangAsm" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RawObject" 'PrefixI 'False) (U1 :: Type -> Type))))

data ArrowCtxt

Constructors

NoArrowCtxt

ArrowCtxt LocalRdrEnv (TcRef WantedConstraints)

type TcSigFun = Name -> Maybe TcSigInfo

data TcSigInfo

Constructors

TcIdSig TcIdSigInfo

TcPatSynSig TcPatSynInfo

Instances

Outputable TcSigInfo

Defined in GHC.Tc.Types

Methods

ppr :: TcSigInfo -> SDoc

pprPrec :: Rational -> TcSigInfo -> SDoc

data TcIdSigInfo

Constructors

CompleteSig

Fields

• sig_bndr :: TcId
• sig_ctxt :: UserTypeCtxt
• sig_loc :: SrcSpan

PartialSig

Fields

• psig_name :: Name
• psig_hs_ty :: LHsSigWcType GhcRn
• sig_ctxt :: UserTypeCtxt
• sig_loc :: SrcSpan

Instances

Outputable TcIdSigInfo

Defined in GHC.Tc.Types

Methods

ppr :: TcIdSigInfo -> SDoc

pprPrec :: Rational -> TcIdSigInfo -> SDoc

data TcIdSigInst

Constructors

TISI

Fields

• sig_inst_sig :: TcIdSigInfo
• sig_inst_skols :: [(Name, InvisTVBinder)]
• sig_inst_theta :: TcThetaType
• sig_inst_tau :: TcSigmaType
• sig_inst_wcs :: [(Name, TcTyVar)]
• sig_inst_wcx :: Maybe TcType

Instances

Outputable TcIdSigInst

Defined in GHC.Tc.Types

Methods

ppr :: TcIdSigInst -> SDoc

pprPrec :: Rational -> TcIdSigInst -> SDoc

data TcPatSynInfo

Constructors

TPSI

Fields

• patsig_name :: Name
• patsig_implicit_bndrs :: [InvisTVBinder]
• patsig_univ_bndrs :: [InvisTVBinder]
• patsig_req :: TcThetaType
• patsig_ex_bndrs :: [InvisTVBinder]
• patsig_prov :: TcThetaType
• patsig_body_ty :: TcSigmaType

Instances

Outputable TcPatSynInfo

Defined in GHC.Tc.Types

Methods

ppr :: TcPatSynInfo -> SDoc

pprPrec :: Rational -> TcPatSynInfo -> SDoc

isPartialSig :: TcIdSigInst -> Bool

hasCompleteSig :: TcSigFun -> Name -> Bool

No signature or a partial signature

type TcId = Id

type TcIdSet = IdSet

data NameShape

A NameShape is a substitution on Names that can be used to refine the identities of a hole while we are renaming interfaces (see GHC.Iface.Rename). Specifically, a NameShape for ns_module_name A, defines a mapping from {A.T} (for some OccName T) to some arbitrary other Name.

The most intruiging thing about a NameShape, however, is how it's constructed. A NameShape is *implied* by the exported AvailInfos of the implementor of an interface: if an implementor of signature <H> exports M.T, you implicitly define a substitution from {H.T} to M.T. So a NameShape is computed from the list of AvailInfos that are exported by the implementation of a module, or successively merged together by the export lists of signatures which are joining together.

It's not the most obvious way to go about doing this, but it does seem to work!

NB: Can't boot this and put it in NameShape because then we start pulling in too many DynFlags things.

Constructors

NameShape

Fields

• ns_mod_name :: ModuleName
• ns_exports :: [AvailInfo]
• ns_map :: OccEnv Name

removeBindingShadowing :: HasOccName a => [a] -> [a]

getPlatform :: TcM Platform

Get target platform

data TcPlugin

Constructors

forall s. TcPlugin

Fields

• tcPluginInit :: TcPluginM s

  Initialize plugin, when entering type-checker.

• tcPluginSolve :: s -> TcPluginSolver

  Solve some constraints. TODO: WRITE MORE DETAILS ON HOW THIS WORKS.

• tcPluginStop :: s -> TcPluginM ()

  Clean up after the plugin, when exiting the type-checker.

data TcPluginResult

Constructors

TcPluginContradiction [Ct]

The plugin found a contradiction. The returned constraints are removed from the inert set, and recorded as insoluble.

TcPluginOk [(EvTerm, Ct)] [Ct]

The first field is for constraints that were solved. These are removed from the inert set, and the evidence for them is recorded. The second field contains new work, that should be processed by the constraint solver.

type TcPluginSolver = [Ct] -> [Ct] -> [Ct] -> TcPluginM TcPluginResult

data TcPluginM a

Instances

MonadFail TcPluginM

Defined in GHC.Tc.Types

Methods

fail :: String -> TcPluginM a

Applicative TcPluginM

Defined in GHC.Tc.Types

Methods

pure :: a -> TcPluginM a

(<*>) :: TcPluginM (a -> b) -> TcPluginM a -> TcPluginM b

liftA2 :: (a -> b -> c) -> TcPluginM a -> TcPluginM b -> TcPluginM c

(*>) :: TcPluginM a -> TcPluginM b -> TcPluginM b

(<*) :: TcPluginM a -> TcPluginM b -> TcPluginM a

Functor TcPluginM

Defined in GHC.Tc.Types

Methods

fmap :: (a -> b) -> TcPluginM a -> TcPluginM b

(<$) :: a -> TcPluginM b -> TcPluginM a

Monad TcPluginM

Defined in GHC.Tc.Types

Methods

(>>=) :: TcPluginM a -> (a -> TcPluginM b) -> TcPluginM b

(>>) :: TcPluginM a -> TcPluginM b -> TcPluginM b

return :: a -> TcPluginM a

runTcPluginM :: TcPluginM a -> EvBindsVar -> TcM a

unsafeTcPluginTcM :: TcM a -> TcPluginM a

This function provides an escape for direct access to the TcM monad. It should not be used lightly, and the provided TcPluginM API should be favoured instead.

getEvBindsTcPluginM :: TcPluginM EvBindsVar

Access the EvBindsVar carried by the TcPluginM during constraint solving. Returns Nothing if invoked during tcPluginInit or tcPluginStop.

type RoleAnnotEnv = NameEnv (LRoleAnnotDecl GhcRn)

emptyRoleAnnotEnv :: RoleAnnotEnv

mkRoleAnnotEnv :: [LRoleAnnotDecl GhcRn] -> RoleAnnotEnv

lookupRoleAnnot :: RoleAnnotEnv -> Name -> Maybe (LRoleAnnotDecl GhcRn)

getRoleAnnots :: [Name] -> RoleAnnotEnv -> [LRoleAnnotDecl GhcRn]

lintGblEnv :: DynFlags -> TcGblEnv -> (Bag SDoc, Bag SDoc)

Check the TcGblEnv for consistency. Currently, only checks axioms, but should check other aspects, too.