Rules

ghc-8.6.5: The GHC API

Safe Haskell | None
Language | Haskell2010

Rules

Contents

- Constructing
- Checking rule applications
- Manipulating `RuleInfo` rules
- Misc. CoreRule helpers

Description

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

Synopsis

- emptyRuleBase :: RuleBase
- mkRuleBase :: [CoreRule] -> RuleBase
- extendRuleBaseList :: RuleBase -> [CoreRule] -> RuleBase
- unionRuleBase :: RuleBase -> RuleBase -> RuleBase
- pprRuleBase :: RuleBase -> SDoc
- ruleCheckProgram :: CompilerPhase -> String -> (Id -> [CoreRule]) -> CoreProgram -> SDoc
- mkRuleInfo :: [CoreRule] -> RuleInfo
- extendRuleInfo :: RuleInfo -> [CoreRule] -> RuleInfo
- addRuleInfo :: RuleInfo -> RuleInfo -> RuleInfo
- addIdSpecialisations :: Id -> [CoreRule] -> Id
- rulesOfBinds :: [CoreBind] -> [CoreRule]
- getRules :: RuleEnv -> Id -> [CoreRule]
- pprRulesForUser :: DynFlags -> [CoreRule] -> SDoc
- lookupRule :: DynFlags -> InScopeEnv -> (Activation -> Bool) -> Id -> [CoreExpr] -> [CoreRule] -> Maybe (CoreRule, CoreExpr)
- mkRule :: Module -> Bool -> Bool -> RuleName -> Activation -> Name -> [CoreBndr] -> [CoreExpr] -> CoreExpr -> CoreRule
- roughTopNames :: [CoreExpr] -> [Maybe Name]

## Constructing

emptyRuleBase :: RuleBase #

mkRuleBase :: [CoreRule] -> RuleBase #

extendRuleBaseList :: RuleBase -> [CoreRule] -> RuleBase #

unionRuleBase :: RuleBase -> RuleBase -> RuleBase #

pprRuleBase :: RuleBase -> SDoc #

## Checking rule applications

ruleCheckProgram #

Arguments

:: 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

mkRuleInfo :: [CoreRule] -> RuleInfo #

Make a `RuleInfo` containing a number of `CoreRule`s, suitable for putting into an `IdInfo`

extendRuleInfo :: RuleInfo -> [CoreRule] -> RuleInfo #

addRuleInfo :: RuleInfo -> RuleInfo -> RuleInfo #

addIdSpecialisations :: Id -> [CoreRule] -> Id #

# Misc. CoreRule helpers

rulesOfBinds :: [CoreBind] -> [CoreRule] #

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

getRules :: RuleEnv -> Id -> [CoreRule] #

pprRulesForUser :: DynFlags -> [CoreRule] -> SDoc #

lookupRule :: DynFlags -> 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.

mkRule :: 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`

roughTopNames :: [CoreExpr] -> [Maybe Name] #

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

1. The function finally being applied to in an application chain (if that name is a GlobalId: see Var), or
2. The `TyCon` if the expression is a `Expr`

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