Moduleghc-10.0.0.20260917GHC2024

GHC.Core.Rules

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

Contents

Looking up rules
RuleBase, RuleEnv
Checking rule applications
Manipulating RuleInfo rules
RuleBase and RuleEnv
Misc. CoreRule helpers
Making rules

Synopsis

value lookupRule
value matchExprs
value ruleLhsIsMoreSpecific
type RuleBase
data RuleEnv
value mkRuleEnv
value emptyRuleEnv
value updExternalPackageRules
value addLocalRules
value updLocalRules
value emptyRuleBase
value mkRuleBase
value extendRuleBaseList
value pprRuleBase
value ruleCheckProgram
value extendRuleInfo
value addRuleInfo
value addIdSpecialisations
value addRulesToId
value rulesOfBinds
value getRules
value pprRulesForUser
value mkRule
value mkSpecRule
value roughTopNames
value ruleIsOrphan

Packageghc-10.0.0.20260917
Exports26
LanguageGHC2024
LicenceBSD-3-Clause
SourceRules.hs

Looking up rules

valuelookupRule

Source#

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

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

valueruleLhsIsMoreSpecific

:: InScopeSet
-> [Var]
-> [CoreExpr]
-> CoreRule
-> Bool

RuleBase, RuleEnv

typetype RuleBase = NameEnv [CoreRule]

Source#

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

datadata RuleEnv

Source#

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

Source#

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

valuerulesOfBinds :: [CoreBind] -> [CoreRule]

Source#

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

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

valuepprRulesForUser :: [CoreRule] -> SDoc

Making rules

valuemkRule

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

Source#

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

valuemkSpecRule

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

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

Source#

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

valueruleIsOrphan :: CoreRule -> Bool