Safe Haskell	None
Language	Haskell2010

TcPluginM

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 UnitId
- | FoundMultiple [(Module, ModuleOrigin)]
- | NotFound {
  - fr_paths :: [FilePath]
  - fr_pkg :: Maybe UnitId
  - fr_mods_hidden :: [UnitId]
  - fr_pkgs_hidden :: [UnitId]
  - 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 -> EvTerm -> TcPluginM CtEvidence
newCoercionHole :: PredType -> TcPluginM CoercionHole
newEvVar :: PredType -> TcPluginM EvVar
setEvBind :: EvBind -> TcPluginM ()
getEvBindsTcPluginM :: TcPluginM EvBindsVar

Basic TcPluginM functionality

data TcPluginM a Source #

Instances

Monad TcPluginM #
Instance details Methods (>>=) :: TcPluginM a -> (a -> TcPluginM b) -> TcPluginM b Source # (>>) :: TcPluginM a -> TcPluginM b -> TcPluginM b Source # return :: a -> TcPluginM a Source # fail :: String -> TcPluginM a Source #
Functor TcPluginM #
Instance details Methods fmap :: (a -> b) -> TcPluginM a -> TcPluginM b Source # (<$) :: a -> TcPluginM b -> TcPluginM a Source #
MonadFail TcPluginM #
Instance details Methods fail :: String -> TcPluginM a Source #
Applicative TcPluginM #
Instance details Methods pure :: a -> TcPluginM a Source # (<>) :: TcPluginM (a -> b) -> TcPluginM a -> TcPluginM b Source # liftA2 :: (a -> b -> c) -> TcPluginM a -> TcPluginM b -> TcPluginM c Source # (>) :: TcPluginM a -> TcPluginM b -> TcPluginM b Source # (<*) :: TcPluginM a -> TcPluginM b -> TcPluginM a Source #

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 Source #

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.

Finding Modules and Names

data FindResult Source #

The result of searching for an imported module.

NB: FindResult manages both user source-import lookups (which can result in Module) as well as direct imports for interfaces (which always result in InstalledModule).

Constructors

Found ModLocation Module	The module was found
NoPackage UnitId	The requested package was not found
FoundMultiple [(Module, ModuleOrigin)]	_Error_: both in multiple packages
NotFound	Not found
Fields fr_paths :: [FilePath] fr_pkg :: Maybe UnitId fr_mods_hidden :: [UnitId] fr_pkgs_hidden :: [UnitId] fr_suggestions :: [ModuleSuggestion]