Moduleghc-lib-parser-9.14.1.20251220GHC2021

GHC.Core.Lint

6 types
9 values

Packageghc-lib-parser-9.14.1.20251220
Exports15
LanguageGHC2021
LicenceBSD-3-Clause
SourceLint.hs

datadata LintPassResultConfig

Constructors

LintPassResultConfig
- lpr_diagOpts :: !DiagOpts
- lpr_platform :: !Platform
- lpr_makeLintFlags :: !LintFlags
- lpr_showLintWarnings :: !Bool
- lpr_passPpr :: !SDoc
- lpr_localsInScope :: ![Var]

datadata LintFlags

Constructors

LF
- lf_check_global_ids :: Bool
- lf_check_inline_loop_breakers :: Bool
- lf_check_static_ptrs :: StaticPtrCheck
  See Note [Checking StaticPtrs]
- lf_report_unsat_syns :: Bool
  See Note [Linting type synonym applications]
- lf_check_linearity :: Bool
  See Note [Linting linearity]
- lf_check_fixed_rep :: Bool

datadata StaticPtrCheck

Constructors

AllowAnywhere
Allow makeStatic to occur anywhere.
AllowAtTopLevel
Allow makeStatic calls at the top-level only.
RejectEverywhere
Reject any makeStatic occurrence.

Instances1Eq

Eq StaticPtrCheckDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Core.Lint

datadata LintConfig

Constructors

LintConfig
- l_diagOpts :: !DiagOpts
  Diagnostics opts
- l_platform :: !Platform
  Target platform
- l_flags :: !LintFlags
  Linting the result of this pass
- l_vars :: ![Var]
  Ids that should be treated as being in scope

typetype WarnsAndErrs = (Bag SDoc, Bag SDoc)

valuelintCoreBindings' :: LintConfig -> CoreProgram -> WarnsAndErrs

Type-check a CoreProgram. See Note [Core Lint guarantee].

valuelintUnfolding

:: Bool
True = is a compulsory unfolding
-> LintConfig
-> SrcLoc
-> CoreExpr
-> Maybe (Bag SDoc)

valuelintPassResult :: Logger -> LintPassResultConfig -> CoreProgram -> IO ()

valuelintExpr :: LintConfig -> CoreExpr -> Maybe (Bag SDoc)

valuelintAnnots :: SDoc -> (ModGuts -> CoreM ModGuts) -> ModGuts -> CoreM ModGuts

This checks whether a pass correctly looks through debug annotations (SourceNote). This works a bit different from other consistency checks: We check this by running the given task twice, noting all differences between the results.

valuelintAxioms

:: Logger
-> LintConfig
-> SDoc
The source of the linted axioms
-> [CoAxiom Branched]
-> IO ()

Debug output

4 declarations

datadata EndPassConfig

Configuration for boilerplate operations at the end of a compilation pass producing Core.

Constructors

EndPassConfig
- ep_dumpCoreSizes :: !Bool
  Whether core bindings should be dumped with the size of what they are binding (i.e. the size of the RHS of the binding).
- ep_lintPassResult :: !Maybe LintPassResultConfig
  Whether we should lint the result of this pass.
- ep_namePprCtx :: !NamePprCtx
- ep_dumpFlag :: !Maybe DumpFlag
- ep_prettyPass :: !SDoc
- ep_passDetails :: !SDoc

valueendPassIO :: Logger -> EndPassConfig -> CoreProgram -> [CoreRule] -> IO ()

valuedisplayLintResults

:: Logger
-> Bool
If True, display linter warnings. If False, ignore linter warnings.
-> SDoc
The source of the linted program
-> SDoc
The linted program, pretty-printed
-> WarnsAndErrs
-> IO ()

valuedumpPassResult

:: Logger
-> Bool
-> NamePprCtx
-> Maybe DumpFlag
-> String
-> SDoc
-> CoreProgram
-> [CoreRule]
-> IO ()