Moduleghc-lib-parser-9.14.1.20251220GHC2021

GHC.Tc.Errors.Hole.Plugin

4 types

Packageghc-lib-parser-9.14.1.20251220
Exports4
LanguageGHC2021
LicenceBSD-3-Clause
SourcePlugin.hs

typetype CandPlugin = TypedHole -> [HoleFitCandidate] -> TcM [HoleFitCandidate]

A plugin for modifying the candidate hole fits *before* they're checked.

typetype FitPlugin = TypedHole -> [HoleFit] -> TcM [HoleFit]

A plugin for modifying hole fits *after* they've been found.

datadata HoleFitPlugin

A HoleFitPlugin is a pair of candidate and fit plugins.

Constructors

HoleFitPlugin
- candPlugin :: CandPlugin
- fitPlugin :: FitPlugin

datadata HoleFitPluginR

HoleFitPluginR adds a TcRef to hole fit plugins so that plugins can track internal state. Note the existential quantification, ensuring that the state cannot be modified from outside the plugin.

Constructors

forall s. HoleFitPluginR
- hfPluginInit :: TcM (TcRef s)
  Initializes the TcRef to be passed to the plugin
- hfPluginRun :: TcRef s -> HoleFitPlugin
  The function defining the plugin itself
- hfPluginStop :: TcRef s -> TcM ()
  Cleanup of state, guaranteed to be called even on error