Certain tests (T3017, Roles3, T12763 etc.) expect part of the output generated by `-ddump-types` to be in PprUser style. However, generally we want all other debugging output to use PprDump style. We PprUser style if useUserStyle is True.

getNamePprCtx :: TcRn NamePprCtx Source #

printForUserTcRn :: SDoc -> TcRn () Source #

Like logInfoTcRn, but for user consumption

traceIf :: SDoc -> TcRnIf m n () Source #

traceOptIf :: DumpFlag -> SDoc -> TcRnIf m n () Source #

debugTc :: TcM () -> TcM () Source #

Typechecker global environment

getIsGHCi :: TcRn Bool Source #

getGHCiMonad :: TcRn Name Source #

getInteractivePrintName :: TcRn Name Source #

tcIsHsBootOrSig :: TcRn Bool Source #

tcIsHsig :: TcRn Bool Source #

tcSelfBootInfo :: TcRn SelfBootInfo Source #

getGlobalRdrEnv :: TcRn GlobalRdrEnv Source #

getRdrEnvs :: TcRn (GlobalRdrEnv, LocalRdrEnv) Source #

getImports :: TcRn ImportAvails Source #

getFixityEnv :: TcRn FixityEnv Source #

extendFixityEnv :: [(Name, FixItem)] -> RnM a -> RnM a Source #

getRecFieldEnv :: TcRn RecFieldEnv Source #

getDeclaredDefaultTys :: TcRn (Maybe [Type]) Source #

addDependentFiles :: [FilePath] -> TcRn () Source #

Error management

getSrcSpanM :: TcRn SrcSpan Source #

setSrcSpan :: SrcSpan -> TcRn a -> TcRn a Source #

setSrcSpanA :: SrcSpanAnn' ann -> TcRn a -> TcRn a Source #

addLocM :: (a -> TcM b) -> Located a -> TcM b Source #

addLocMA :: (a -> TcM b) -> GenLocated (SrcSpanAnn' ann) a -> TcM b Source #

inGeneratedCode :: TcRn Bool Source #

wrapLocM :: (a -> TcM b) -> Located a -> TcM (Located b) Source #

wrapLocAM :: (a -> TcM b) -> LocatedAn an a -> TcM (Located b) Source #

wrapLocFstM :: (a -> TcM (b, c)) -> Located a -> TcM (Located b, c) Source #

wrapLocFstMA :: (a -> TcM (b, c)) -> GenLocated (SrcSpanAnn' ann) a -> TcM (GenLocated (SrcSpanAnn' ann) b, c) Source #

wrapLocSndM :: (a -> TcM (b, c)) -> Located a -> TcM (b, Located c) Source #

wrapLocSndMA :: (a -> TcM (b, c)) -> GenLocated (SrcSpanAnn' ann) a -> TcM (b, GenLocated (SrcSpanAnn' ann) c) Source #

wrapLocM_ :: (a -> TcM ()) -> Located a -> TcM () Source #

wrapLocMA_ :: (a -> TcM ()) -> LocatedA a -> TcM () Source #

wrapLocMA :: (a -> TcM b) -> GenLocated (SrcSpanAnn' ann) a -> TcRn (GenLocated (SrcSpanAnn' ann) b) Source #

getErrsVar :: TcRn (TcRef (Messages TcRnMessage)) Source #

setErrsVar :: TcRef (Messages TcRnMessage) -> TcRn a -> TcRn a Source #

addErr :: TcRnMessage -> TcRn () Source #

failWith :: TcRnMessage -> TcRn a Source #

failAt :: SrcSpan -> TcRnMessage -> TcRn a Source #

addErrAt :: SrcSpan -> TcRnMessage -> TcRn () Source #

addErrs :: [(SrcSpan, TcRnMessage)] -> TcRn () Source #

checkErr :: Bool -> TcRnMessage -> TcRn () Source #

addMessages :: Messages TcRnMessage -> TcRn () Source #

discardWarnings :: TcRn a -> TcRn a Source #

mkDetailedMessage :: ErrInfo -> TcRnMessage -> TcRnMessageDetailed Source #

Usage environment

tcCollectingUsage :: TcM a -> TcM (UsageEnv, a) Source #

tcCollectingUsage thing_inside runs thing_inside and returns the usage information which was collected as part of the execution of thing_inside. Careful: tcCollectingUsage thing_inside itself does not report any usage information, it's up to the caller to incorporate the returned usage information into the larger context appropriately.

tcScalingUsage :: Mult -> TcM a -> TcM a Source #

tcScalingUsage mult thing_inside runs thing_inside and scales all the usage information by mult.

tcEmitBindingUsage :: UsageEnv -> TcM () Source #

Shared error message stuff: renamer and typechecker

recoverM :: TcRn r -> TcRn r -> TcRn r Source #

mapAndRecoverM :: (a -> TcRn b) -> [a] -> TcRn [b] Source #

Drop elements of the input that fail, so the result list can be shorter than the argument list

mapAndReportM :: (a -> TcRn b) -> [a] -> TcRn [b] Source #

Apply the function to all elements on the input list If all succeed, return the list of results Otherwise fail, propagating all errors

foldAndRecoverM :: (b -> a -> TcRn b) -> b -> [a] -> TcRn b Source #

The accumulator is not updated if the action fails

attemptM :: TcRn r -> TcRn (Maybe r) Source #

tryTc :: TcRn a -> TcRn (Maybe a, Messages TcRnMessage) Source #

askNoErrs :: TcRn a -> TcRn (a, Bool) Source #

discardErrs :: TcRn a -> TcRn a Source #

tryTcDiscardingErrs :: TcM r -> TcM r -> TcM r Source #

checkNoErrs :: TcM r -> TcM r Source #

whenNoErrs :: TcM () -> TcM () Source #

ifErrsM :: TcRn r -> TcRn r -> TcRn r Source #

failIfErrsM :: TcRn () Source #

Context management for the type checker

getErrCtxt :: TcM [ErrCtxt] Source #

setErrCtxt :: [ErrCtxt] -> TcM a -> TcM a Source #

addErrCtxt :: SDoc -> TcM a -> TcM a Source #

Add a fixed message to the error context. This message should not do any tidying.

addErrCtxtM :: (TidyEnv -> TcM (TidyEnv, SDoc)) -> TcM a -> TcM a Source #

Add a message to the error context. This message may do tidying.

addLandmarkErrCtxt :: SDoc -> TcM a -> TcM a Source #

Add a fixed landmark message to the error context. A landmark message is always sure to be reported, even if there is a lot of context. It also doesn't count toward the maximum number of contexts reported.

addLandmarkErrCtxtM :: (TidyEnv -> TcM (TidyEnv, SDoc)) -> TcM a -> TcM a Source #

Variant of addLandmarkErrCtxt that allows for monadic operations and tidying.

popErrCtxt :: TcM a -> TcM a Source #

getCtLocM :: CtOrigin -> Maybe TypeOrKind -> TcM CtLoc Source #

setCtLocM :: CtLoc -> TcM a -> TcM a Source #

Diagnostic message generation (type checker)

addErrTc :: TcRnMessage -> TcM () Source #

addErrTcM :: (TidyEnv, TcRnMessage) -> TcM () Source #

failWithTc :: TcRnMessage -> TcM a Source #

failWithTcM :: (TidyEnv, TcRnMessage) -> TcM a Source #

checkTc :: Bool -> TcRnMessage -> TcM () Source #

checkTcM :: Bool -> (TidyEnv, TcRnMessage) -> TcM () Source #

failIfTc :: Bool -> TcRnMessage -> TcM () Source #

failIfTcM :: Bool -> (TidyEnv, TcRnMessage) -> TcM () Source #

mkErrInfo :: TidyEnv -> [ErrCtxt] -> TcM SDoc Source #

addTcRnDiagnostic :: TcRnMessage -> TcM () Source #

addDetailedDiagnostic :: (ErrInfo -> TcRnMessage) -> TcM () Source #

A variation of addDiagnostic that takes a function to produce a TcRnDsMessage given some additional context about the diagnostic.

mkTcRnMessage :: SrcSpan -> TcRnMessage -> TcRn (MsgEnvelope TcRnMessage) Source #

reportDiagnostic :: MsgEnvelope TcRnMessage -> TcRn () Source #

reportDiagnostics :: [MsgEnvelope TcRnMessage] -> TcM () Source #

warnIf :: Bool -> TcRnMessage -> TcRn () Source #

Display a warning if a condition is met.

diagnosticTc :: Bool -> TcRnMessage -> TcM () Source #

Display a warning if a condition is met.

diagnosticTcM :: Bool -> (TidyEnv, TcRnMessage) -> TcM () Source #

Display a diagnostic if a condition is met.

addDiagnosticTc :: TcRnMessage -> TcM () Source #

Display a diagnostic in the current context.

addDiagnosticTcM :: (TidyEnv, TcRnMessage) -> TcM () Source #

Display a diagnostic in a given context.

addDiagnostic :: TcRnMessage -> TcRn () Source #

Display a diagnostic for the current source location, taken from the TcRn monad.

addDiagnosticAt :: SrcSpan -> TcRnMessage -> TcRn () Source #

Display a diagnostic for a given source location.

Type constraints

newTcEvBinds :: TcM EvBindsVar Source #

newNoTcEvBinds :: TcM EvBindsVar Source #

Creates an EvBindsVar incapable of holding any bindings. It still tracks covar usages (see comments on ebv_tcvs in GHC.Tc.Types.Evidence), thus must be made monadically

cloneEvBindsVar :: EvBindsVar -> TcM EvBindsVar Source #

addTcEvBind :: EvBindsVar -> EvBind -> TcM () Source #

addTopEvBinds :: Bag EvBind -> TcM a -> TcM a Source #

getTcEvTyCoVars :: EvBindsVar -> TcM TyCoVarSet Source #

getTcEvBindsMap :: EvBindsVar -> TcM EvBindMap Source #

setTcEvBindsMap :: EvBindsVar -> EvBindMap -> TcM () Source #

chooseUniqueOccTc :: (OccSet -> OccName) -> TcM OccName Source #

getConstraintVar :: TcM (TcRef WantedConstraints) Source #

setConstraintVar :: TcRef WantedConstraints -> TcM a -> TcM a Source #

emitConstraints :: WantedConstraints -> TcM () Source #

emitStaticConstraints :: WantedConstraints -> TcM () Source #

emitSimple :: Ct -> TcM () Source #

emitSimples :: Cts -> TcM () Source #

emitImplication :: Implication -> TcM () Source #

emitImplications :: Bag Implication -> TcM () Source #

emitInsoluble :: Ct -> TcM () Source #

emitDelayedErrors :: Bag DelayedError -> TcM () Source #

emitHole :: Hole -> TcM () Source #

emitHoles :: Bag Hole -> TcM () Source #

emitNotConcreteError :: NotConcreteError -> TcM () Source #

discardConstraints :: TcM a -> TcM a Source #

Throw out any constraints emitted by the thing_inside

captureConstraints :: TcM a -> TcM (a, WantedConstraints) Source #

tryCaptureConstraints :: TcM a -> TcM (Maybe a, WantedConstraints) Source #

pushLevelAndCaptureConstraints :: TcM a -> TcM (TcLevel, WantedConstraints, a) Source #

The name says it all. The returned TcLevel is the *inner* TcLevel.

pushTcLevelM_ :: TcM a -> TcM a Source #

pushTcLevelM :: TcM a -> TcM (TcLevel, a) Source #

getTcLevel :: TcM TcLevel Source #

setTcLevel :: TcLevel -> TcM a -> TcM a Source #

isTouchableTcM :: TcTyVar -> TcM Bool Source #

getLclTypeEnv :: TcM TcTypeEnv Source #

setLclTypeEnv :: TcLclEnv -> TcM a -> TcM a Source #

traceTcConstraints :: String -> TcM () Source #

emitNamedTypeHole :: (Name, TcTyVar) -> TcM () Source #

data IsExtraConstraint Source #

Constructors

YesExtraConstraint
NoExtraConstraint

Instances

Instances details

Outputable IsExtraConstraint Source #
Instance details Defined in GHC.Tc.Utils.Monad Methods ppr :: IsExtraConstraint -> SDoc Source #

emitAnonTypeHole :: IsExtraConstraint -> TcTyVar -> TcM () Source #

Template Haskell context

recordThUse :: TcM () Source #

recordThSpliceUse :: TcM () Source #

recordThNeededRuntimeDeps :: [Linkable] -> PkgsLoaded -> TcM () Source #

keepAlive :: Name -> TcRn () Source #

getStage :: TcM ThStage Source #

getStageAndBindLevel :: Name -> TcRn (Maybe (TopLevelFlag, ThLevel, ThStage)) Source #

setStage :: ThStage -> TcM a -> TcRn a Source #

addModFinalizersWithLclEnv :: ThModFinalizers -> TcM () Source #

Adds the given modFinalizers to the global environment and set them to use the current local environment.

Safe Haskell context

recordUnsafeInfer :: Messages TcRnMessage -> TcM () Source #

Mark that safe inference has failed See Note [Safe Haskell Overlapping Instances Implementation] although this is used for more than just that failure case.

finalSafeMode :: DynFlags -> TcGblEnv -> IO SafeHaskellMode Source #

Figure out the final correct safe haskell mode

fixSafeInstances :: SafeHaskellMode -> [ClsInst] -> [ClsInst] Source #

Switch instances to safe instances if we're in Safe mode.

Stuff for the renamer's local env

getLocalRdrEnv :: RnM LocalRdrEnv Source #

setLocalRdrEnv :: LocalRdrEnv -> RnM a -> RnM a Source #

Stuff for interface decls

mkIfLclEnv :: Module -> SDoc -> IsBootInterface -> IfLclEnv Source #

initIfaceTcRn :: IfG a -> TcRn a Source #

Run an IfG (top-level interface monad) computation inside an existing TcRn (typecheck-renaming monad) computation by initializing an IfGblEnv based on TcGblEnv.

initIfaceCheck :: SDoc -> HscEnv -> IfG a -> IO a Source #

initIfaceLcl :: Module -> SDoc -> IsBootInterface -> IfL a -> IfM lcl a Source #

initIfaceLclWithSubst :: Module -> SDoc -> IsBootInterface -> NameShape -> IfL a -> IfM lcl a Source #

Initialize interface typechecking, but with a NameShape to apply when typechecking top-level OccNames (see lookupIfaceTop)

initIfaceLoad :: HscEnv -> IfG a -> IO a Source #

initIfaceLoad can be used when there's no chance that the action will call typecheckIface when inside a module loop and hence tcIfaceGlobal.

initIfaceLoadModule :: HscEnv -> Module -> IfG a -> IO a Source #

This is used when we are doing to call typecheckModule on an ModIface, if it's part of a loop with some other modules then we need to use their IORef TypeEnv vars when typechecking but crucially not our own.

getIfModule :: IfL Module Source #

failIfM :: SDoc -> IfL a Source #

forkM :: SDoc -> IfL a -> IfL a Source #

Run thing_inside in an interleaved thread. It shares everything with the parent thread, so this is DANGEROUS.

It throws an error if the computation fails

It's used for lazily type-checking interface signatures, which is pretty benign.

See Note [Masking exceptions in forkM]

setImplicitEnvM :: TypeEnv -> IfL a -> IfL a Source #

withException :: MonadIO m => SDocContext -> m (MaybeErr SDoc a) -> m a Source #

A convenient wrapper for taking a MaybeErr SDoc a and throwing an exception if it is an error.

Stuff for cost centres.

getCCIndexM :: (gbl -> TcRef CostCentreState) -> FastString -> TcRnIf gbl lcl CostCentreIndex Source #

Get the next cost centre index associated with a given name.

getCCIndexTcM :: FastString -> TcM CostCentreIndex Source #

See getCCIndexM.

Types etc.

module GHC.Tc.Types

module GHC.Data.IOEnv

Orphan instances

MonadUnique (IOEnv (Env gbl lcl)) Source #
Instance details Methods getUniqueSupplyM :: IOEnv (Env gbl lcl) UniqSupply Source # getUniqueM :: IOEnv (Env gbl lcl) Unique Source # getUniquesM :: IOEnv (Env gbl lcl) [Unique] Source #