TcPluginM is the monad in which type-checking plugins operate.
Moduleghc-10.0.0.20260917GHC2024
GHC.Tc.Plugin
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.
Contents
Synopsis
- newtype TcPluginM
- value tcPluginIO
- value tcPluginTrace
- value unsafeTcPluginTcM
- data FindResult
- value findImportedModule
- value lookupOrig
- value lookupTHName
- value tcLookupGlobal
- value tcLookupTyCon
- value tcLookupDataCon
- value tcLookupClass
- value tcLookup
- value tcLookupId
- value getTopEnv
- value getTargetPlatform
- value getEnvs
- value getInstEnvs
- value getFamInstEnvs
- value matchFam
- value newUnique
- value newFlexiTyVar
- value isTouchableTcPluginM
- value zonkTcType
- value zonkCt
- value newWanted
- value newGiven
- value newCoercionHole
- value newEvVar
- value setEvBind
- Packageghc-10.0.0.20260917
- Exports30
- LanguageGHC2024
- LicenceBSD-3-Clause
- SourcePlugin.hs
Basic TcPluginM functionality
Perform some IO, typically to interact with an external tool.
Output useful for debugging the compiler.
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
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 ModuleThe module was found
NoPackage UnitThe requested unit was not found
FoundMultiple [(Module, ModuleOrigin)]_Error_: both in multiple packages
NotFoundNot found
fr_paths :: [FilePath]Places where I looked
fr_pkg :: Maybe UnitJust p => module is in this unit's manifest, but couldn't find the .hi file
fr_unusables :: [UnusableUnit]Module is in these units, but it is unusable
fr_suggestions :: [ModuleSuggestion]Possible mis-spelled modules
Looking up Names in the typechecking environment
Getting the TcM state
Type variables
Zonking
Confused by zonking? See Note [What is zonking?] in GHC.Tc.Zonk.Type.
Creating constraints
Create a new Wanted constraint with the given CtLoc.
Create a new given constraint, with the supplied evidence.
This should only be invoked within tcPluginSolve.
Create a fresh coercion hole.
This should only be invoked within tcPluginSolve.
Manipulating evidence bindings
Create a fresh evidence variable.
This should only be invoked within tcPluginSolve.
Bind an evidence variable.
This should only be invoked within tcPluginSolve.