Moduleghc-9.10.3GHC2021

GHC.Core.Rules

Functions for collecting together and applying rewrite rules to a module. The CoreRule datatype itself is declared elsewhere.

2 types
22 values

Packageghc-9.10.3
Exports24
LanguageGHC2021
LicenceBSD-3-Clause
SourceRules.hs

Looking up rules

valuelookupRule

:: RuleOpts
-> InScopeEnv
-> Activation -> Bool
-> Id
-> [CoreExpr]
-> [CoreRule]
-> Maybe (CoreRule, CoreExpr)

The main rule matching function. Attempts to apply all (active) supplied rules to this instance of an application in a given context, returning the rule applied and the resulting expression if successful.

valuematchExprs

:: InScopeEnv
-> [Var]
-> [CoreExpr]
-> [CoreExpr]
-> Maybe (BindWrapper, [CoreExpr])

RuleBase, RuleEnv

typetype RuleBase = NameEnv [CoreRule]

Gathers a collection of CoreRules. Maps (the name of) an Id to its rules

datadata RuleEnv

A full rule environment which we can apply rules from. Like a RuleBase, but it also includes the set of visible orphans we use to filter out orphan rules which are not visible (even though we can see them...) See Note [Orphans] in GHC.Core

Constructors

RuleEnv
- re_local_rules :: !RuleBase
- re_home_rules :: !RuleBase
- re_eps_rules :: !RuleBase
- re_visible_orphs :: !ModuleSet

valuemkRuleEnv :: ModGuts -> RuleBase -> RuleBase -> RuleEnv

valueemptyRuleEnv :: RuleEnv

valueupdExternalPackageRules :: RuleEnv -> RuleBase -> RuleEnv

valueaddLocalRules :: RuleEnv -> [CoreRule] -> RuleEnv

valueupdLocalRules :: RuleEnv -> [CoreRule] -> RuleEnv

valueemptyRuleBase :: RuleBase

valuemkRuleBase :: [CoreRule] -> RuleBase

valueextendRuleBaseList :: RuleBase -> [CoreRule] -> RuleBase

valuepprRuleBase :: RuleBase -> SDoc

Checking rule applications

valueruleCheckProgram

:: RuleOpts
Rule options
-> CompilerPhase
Rule activation test
-> String
Rule pattern
-> (Id -> [CoreRule])
Rules for an Id
-> CoreProgram
Bindings to check in
-> SDoc
Resulting check message

Report partial matches for rules beginning with the specified string for the purposes of error reporting

Manipulating RuleInfo rules

valueextendRuleInfo :: RuleInfo -> [CoreRule] -> RuleInfo

valueaddRuleInfo :: RuleInfo -> RuleInfo -> RuleInfo

valueaddIdSpecialisations :: Id -> [CoreRule] -> Id

valueaddRulesToId :: RuleBase -> Id -> Id

RuleBase and RuleEnv

Misc. CoreRule helpers

3 declarations

valuerulesOfBinds :: [CoreBind] -> [CoreRule]

Gather all the rules for locally bound identifiers from the supplied bindings

valuegetRules :: RuleEnv -> Id -> [CoreRule]

valuepprRulesForUser :: [CoreRule] -> SDoc

Making rules

3 declarations

valuemkRule

:: Module
-> Bool
-> Bool
-> RuleName
-> Activation
-> Name
-> [CoreBndr]
-> [CoreExpr]
-> CoreExpr
-> CoreRule

Used to make CoreRule for an Id defined in the module being compiled. See also CoreRule

valuemkSpecRule

:: DynFlags
-> Module
-> Bool
-> Activation
-> SDoc
-> Id
-> [CoreBndr]
-> [CoreExpr]
-> CoreExpr
-> CoreRule

valueroughTopNames :: [CoreExpr] -> [Maybe Name]

Find the "top" free names of several expressions. Such names are either:

The function finally being applied to in an application chain (if that name is a GlobalId: see GHC.Types.Var#globalvslocal), or
The TyCon if the expression is a Type

This is used for the fast-match-check for rules; if the top names don't match, the rest can't