Safe Haskell	None
Language	Haskell2010

GHC.Tc.Plugin

Contents

Basic TcPluginM functionality
Finding Modules and Names
Looking up Names in the typechecking environment
Getting the TcM state
Type variables
Zonking
Creating constraints
Manipulating evidence bindings

Description

This module provides an interface for typechecker plugins to access select functions of the TcM, principally those to do with reading parts of the state.

Synopsis

data TcPluginM a
tcPluginIO :: IO a -> TcPluginM a
tcPluginTrace :: String -> SDoc -> TcPluginM ()
unsafeTcPluginTcM :: TcM a -> TcPluginM a
data FindResult
- = Found ModLocation Module
- | NoPackage Unit
- | FoundMultiple [(Module, ModuleOrigin)]
- | NotFound {
  - fr_paths :: [FilePath]
  - fr_pkg :: Maybe Unit
  - fr_mods_hidden :: [Unit]
  - fr_pkgs_hidden :: [Unit]
  - fr_unusables :: [(Unit, UnusableUnitReason)]
  - fr_suggestions :: [ModuleSuggestion]
  }
findImportedModule :: ModuleName -> Maybe FastString -> TcPluginM FindResult
lookupOrig :: Module -> OccName -> TcPluginM Name
tcLookupGlobal :: Name -> TcPluginM TyThing
tcLookupTyCon :: Name -> TcPluginM TyCon
tcLookupDataCon :: Name -> TcPluginM DataCon
tcLookupClass :: Name -> TcPluginM Class
tcLookup :: Name -> TcPluginM TcTyThing
tcLookupId :: Name -> TcPluginM Id
getTopEnv :: TcPluginM HscEnv
getEnvs :: TcPluginM (TcGblEnv, TcLclEnv)
getInstEnvs :: TcPluginM InstEnvs
getFamInstEnvs :: TcPluginM (FamInstEnv, FamInstEnv)
matchFam :: TyCon -> [Type] -> TcPluginM (Maybe (TcCoercion, TcType))
newUnique :: TcPluginM Unique
newFlexiTyVar :: Kind -> TcPluginM TcTyVar
isTouchableTcPluginM :: TcTyVar -> TcPluginM Bool
zonkTcType :: TcType -> TcPluginM TcType
zonkCt :: Ct -> TcPluginM Ct
newWanted :: CtLoc -> PredType -> TcPluginM CtEvidence
newDerived :: CtLoc -> PredType -> TcPluginM CtEvidence
newGiven :: CtLoc -> PredType -> EvExpr -> TcPluginM CtEvidence
newCoercionHole :: PredType -> TcPluginM CoercionHole
newEvVar :: PredType -> TcPluginM EvVar
setEvBind :: EvBind -> TcPluginM ()
getEvBindsTcPluginM :: TcPluginM EvBindsVar

Basic TcPluginM functionality

data TcPluginM a #

Instances

Instances details

Monad TcPluginM
Instance details Defined in GHC.Tc.Types Methods (>>=) :: TcPluginM a -> (a -> TcPluginM b) -> TcPluginM b # (>>) :: TcPluginM a -> TcPluginM b -> TcPluginM b # return :: a -> TcPluginM a #
Functor TcPluginM
Instance details Defined in GHC.Tc.Types Methods fmap :: (a -> b) -> TcPluginM a -> TcPluginM b # (<$) :: a -> TcPluginM b -> TcPluginM a #
MonadFail TcPluginM
Instance details Defined in GHC.Tc.Types Methods fail :: String -> TcPluginM a #
Applicative TcPluginM
Instance details 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 #

tcPluginIO :: IO a -> TcPluginM a Source #

Perform some IO, typically to interact with an external tool.

tcPluginTrace :: String -> SDoc -> TcPluginM () Source #

Output useful for debugging the compiler.

unsafeTcPluginTcM :: TcM a -> TcPluginM a #

Finding Modules and Names

data FindResult #

Constructors

Found ModLocation Module
NoPackage Unit
FoundMultiple [(Module, ModuleOrigin)]
NotFound
Fields fr_paths :: [FilePath] fr_pkg :: Maybe Unit fr_mods_hidden :: [Unit] fr_pkgs_hidden :: [Unit] fr_unusables :: [(Unit, UnusableUnitReason)] fr_suggestions :: [ModuleSuggestion]