Comments only
[ghc-hetmet.git] / compiler / specialise / Rules.lhs
index 35a0bdd..35b44ab 100644 (file)
@@ -33,7 +33,7 @@ import Id             ( Id, idUnfolding, isLocalId, isGlobalId, idName,
 import IdInfo          ( SpecInfo( SpecInfo ) )
 import Var             ( Var )
 import VarEnv          ( IdEnv, InScopeSet, emptyTidyEnv,
-                         emptyInScopeSet, mkInScopeSet, extendInScopeSetList, 
+                         emptyInScopeSet, mkInScopeSet, 
                          emptyVarEnv, lookupVarEnv, extendVarEnv, 
                          nukeRnEnvL, mkRnEnv2, rnOccR, rnOccL, inRnEnvR,
                          rnBndrR, rnBndr2, rnBndrL, rnBndrs2,
@@ -45,11 +45,11 @@ import Unify                ( ruleMatchTyX, MatchEnv(..) )
 import BasicTypes      ( Activation, CompilerPhase, isActive )
 import Outputable
 import FastString
-import Maybes          ( isJust, orElse )
+import Maybes
 import OrdList
 import Bag
-import Util            ( singleton, mapAccumL )
-import List            ( isPrefixOf )
+import Util
+import List hiding( mapAccumL )        -- Also defined in Util
 \end{code}
 
 
@@ -203,7 +203,7 @@ pprRuleBase rules = vcat [ pprRules (tidyRules emptyTidyEnv rs)
 \begin{code}
 lookupRule :: (Activation -> Bool) -> InScopeSet
           -> RuleBase  -- Imported rules
-          -> Id -> [CoreExpr] -> Maybe (RuleName, CoreExpr)
+          -> Id -> [CoreExpr] -> Maybe (CoreRule, CoreExpr)
 lookupRule is_active in_scope rule_base fn args
   = matchRules is_active in_scope fn args rules
   where
@@ -217,13 +217,13 @@ lookupRule is_active in_scope rule_base fn args
 
 matchRules :: (Activation -> Bool) -> InScopeSet
           -> Id -> [CoreExpr]
-          -> [CoreRule] -> Maybe (RuleName, CoreExpr)
+          -> [CoreRule] -> Maybe (CoreRule, CoreExpr)
 -- See comments on matchRule
 matchRules is_active in_scope fn args rules
-  = case go [] rules of
+  = -- pprTrace "matchRules" (ppr fn <+> ppr rules) $
+    case go [] rules of
        []     -> Nothing
-       (m:ms) -> Just (case findBest (fn,args) m ms of
-                         (rule, ans) -> (ru_name rule, ans))
+       (m:ms) -> Just (findBest (fn,args) m ms)
   where
     rough_args = map roughTopName args
 
@@ -231,7 +231,9 @@ matchRules is_active in_scope fn args rules
     go ms []          = ms
     go ms (r:rs) = case (matchRule is_active in_scope args rough_args r) of
                        Just e  -> go ((r,e):ms) rs
-                       Nothing -> go ms         rs
+                       Nothing -> -- pprTrace "match failed" (ppr r $$ ppr args $$ 
+                                  --   ppr [(arg_id, unfoldingTemplate unf) | Var arg_id <- args, let unf = idUnfolding arg_id, isCheapUnfolding unf] )
+                                  go ms         rs
 
 findBest :: (Id, [CoreExpr])
         -> (CoreRule,CoreExpr) -> [(CoreRule,CoreExpr)] -> (CoreRule,CoreExpr)
@@ -309,11 +311,9 @@ matchRule is_active in_scope args rough_args
   | ruleCantMatch tpl_tops rough_args = Nothing
   | otherwise
   = case matchN in_scope tpl_vars tpl_args args of
-       Nothing                    -> Nothing
-       Just (binds, tpl_vals, leftovers) -> Just (mkLets binds $
-                                                  rule_fn
-                                                   `mkApps` tpl_vals
-                                                   `mkApps` leftovers)
+       Nothing                -> Nothing
+       Just (binds, tpl_vals) -> Just (mkLets binds $
+                                       rule_fn `mkApps` tpl_vals)
   where
     rule_fn = occurAnalyseExpr (mkLams tpl_vars rhs)
        -- We could do this when putting things into the rulebase, I guess
@@ -325,36 +325,47 @@ matchN    :: InScopeSet
        -> [CoreExpr]           -- Template
        -> [CoreExpr]           -- Target; can have more elts than template
        -> Maybe ([CoreBind],   -- Bindings to wrap around the entire result
-                 [CoreExpr],   -- What is substituted for each template var
-                 [CoreExpr])   -- Leftover target exprs
+                 [CoreExpr])   -- What is substituted for each template var
 
 matchN in_scope tmpl_vars tmpl_es target_es
-  = do { ((tv_subst, id_subst, binds), leftover_es)
+  = do { (tv_subst, id_subst, binds)
                <- go init_menv emptySubstEnv tmpl_es target_es
        ; return (fromOL binds, 
-                 map (lookup_tmpl tv_subst id_subst) tmpl_vars, 
-                 leftover_es) }
+                 map (lookup_tmpl tv_subst id_subst) tmpl_vars') }
   where
-    init_menv = ME { me_tmpls = mkVarSet tmpl_vars, me_env = init_rn_env }
-    init_rn_env = mkRnEnv2 (extendInScopeSetList in_scope tmpl_vars)
+    (init_rn_env, tmpl_vars') = mapAccumL rnBndrL (mkRnEnv2 in_scope) tmpl_vars
+       -- See Note [Template binders]
+
+    init_menv = ME { me_tmpls = mkVarSet tmpl_vars', me_env = init_rn_env }
                
-    go menv subst []     es    = Just (subst, es)
+    go menv subst []     es    = Just subst
     go menv subst ts     []    = Nothing       -- Fail if too few actual args
     go menv subst (t:ts) (e:es) = do { subst1 <- match menv subst t e 
                                     ; go menv subst1 ts es }
 
     lookup_tmpl :: TvSubstEnv -> IdSubstEnv -> Var -> CoreExpr
-    lookup_tmpl tv_subst id_subst tmpl_var
-       | isTyVar tmpl_var = case lookupVarEnv tv_subst tmpl_var of
+    lookup_tmpl tv_subst id_subst tmpl_var'
+       | isTyVar tmpl_var' = case lookupVarEnv tv_subst tmpl_var' of
                                Just ty         -> Type ty
-                               Nothing         -> unbound tmpl_var
-       | otherwise        = case lookupVarEnv id_subst tmpl_var of
+                               Nothing         -> unbound tmpl_var'
+       | otherwise         = case lookupVarEnv id_subst tmpl_var' of
                                Just e -> e
-                               other  -> unbound tmpl_var
+                               other  -> unbound tmpl_var'
  
     unbound var = pprPanic "Template variable unbound in rewrite rule" (ppr var)
 \end{code}
 
+Note [Template binders]
+~~~~~~~~~~~~~~~~~~~~~~~
+Consider the following match:
+       Template:  forall x.  f x 
+       Taret:     f (x+1)
+This should succeed, because the template variable 'x' has nothing to do with
+the 'x' in the target.
+
+To achive this, we use rnBndrL to rename the template variables if necessary;
+the renamed ones are the tmpl_vars'
+
 
        ---------------------------------------------
                The inner workings of matching
@@ -417,18 +428,46 @@ match menv subst (Var v1) e2
 -- (Its occurrence information is not necessarily up to date,
 --  so we don't use it.)
 match menv subst e1 (Var v2)
-  | not (inRnEnvR rn_env v2),
-       -- If v2 is in the RnEnvR, then it's locally bound and can't
-       -- have an unfolding. We must make this check because if it
-       -- is locally bound we must not look it up in the in-scope set
-       -- E.g.         (\x->x) where x is already in scope
-    isCheapUnfolding unfolding
+  | isCheapUnfolding unfolding
   = match menv subst e1 (unfoldingTemplate unfolding)
   where
     rn_env    = me_env menv
-    unfolding = idUnfolding (lookupRnInScope rn_env v2)
+    unfolding = idUnfolding (lookupRnInScope rn_env (rnOccR rn_env v2))
        -- Notice that we look up v2 in the in-scope set
        -- See Note [Lookup in-scope]
+       -- Remember to apply any renaming first (hence rnOccR)
+
+-- Matching a let-expression.  Consider
+--     RULE forall x.  f (g x) = <rhs>
+-- and target expression
+--     f (let { w=R } in g E))
+-- Then we'd like the rule to match, to generate
+--     let { w=R } in (\x. <rhs>) E
+-- In effect, we want to float the let-binding outward, to enable
+-- the match to happen.  This is the WHOLE REASON for accumulating
+-- bindings in the SubstEnv
+--
+-- We can only do this if
+--     (a) Widening the scope of w does not capture any variables
+--         We use a conservative test: w is not already in scope
+--     (b) The free variables of R are not bound by the part of the
+--         target expression outside the let binding; e.g.
+--             f (\v. let w = v+1 in g E)
+--         Here we obviously cannot float the let-binding for w.
+
+match menv subst@(tv_subst, id_subst, binds) e1 (Let bind e2)
+  | all freshly_bound bndrs,
+    not (any locally_bound bind_fvs)
+  = match (menv { me_env = rn_env' }) 
+         (tv_subst, id_subst, binds `snocOL` bind)
+         e1 e2
+  where
+    rn_env   = me_env menv
+    bndrs    = bindersOf bind
+    bind_fvs = varSetElems (bindFreeVars bind)
+    freshly_bound x = not (x `rnInScope` rn_env)
+    locally_bound x = inRnEnvR rn_env x
+    rn_env' = extendRnInScopeList rn_env bndrs
 
 match menv subst (Lit lit1) (Lit lit2)
   | lit1 == lit2
@@ -445,6 +484,9 @@ match menv subst (Lam x1 e1) (Lam x2 e2)
 
 -- This rule does eta expansion
 --             (\x.M)  ~  N    iff     M  ~  N x
+-- It's important that this is *after* the let rule,
+-- so that     (\x.M)  ~  (let y = e in \y.N)
+-- does the let thing, and then gets the lam/lam rule above
 match menv subst (Lam x1 e1) e2
   = match menv' subst e1 (App e2 (varToCoreExpr new_x))
   where
@@ -476,38 +518,9 @@ match menv subst (Cast e1 co1) (Cast e2 co2)
        ; subst2 <- match_ty menv subst1 from1 from2
        ; match menv subst2 e1 e2 }
 
--- Matching a let-expression.  Consider
---     RULE forall x.  f (g x) = <rhs>
--- and target expression
---     f (let { w=R } in g E))
--- Then we'd like the rule to match, to generate
---     let { w=R } in (\x. <rhs>) E
--- In effect, we want to float the let-binding outward, to enable
--- the match to happen.  This is the WHOLE REASON for accumulating
--- bindings in the SubstEnv
---
--- We can only do this if
---     (a) Widening the scope of w does not capture any variables
---         We use a conservative test: w is not already in scope
---     (b) The free variables of R are not bound by the part of the
---         target expression outside the let binding; e.g.
---             f (\v. let w = v+1 in g E)
---         Here we obviously cannot float the let-binding for w.
-
-match menv subst@(tv_subst, id_subst, binds) e1 (Let bind e2)
-  | all freshly_bound bndrs,
-    not (any locally_bound bind_fvs)
-  = match (menv { me_env = rn_env' }) 
-         (tv_subst, id_subst, binds `snocOL` bind)
-         e1 e2
-  where
-    rn_env   = me_env menv
-    bndrs    = bindersOf bind
-    bind_fvs = varSetElems (bindFreeVars bind)
-    freshly_bound x = not (x `rnInScope` rn_env)
-    locally_bound x = inRnEnvR rn_env x
-    rn_env' = extendRnInScopeList rn_env bndrs
-
+{-     REMOVING OLD CODE: I think that the above handling for let is 
+                          better than the stuff here, which looks 
+                          pretty suspicious to me.  SLPJ Sept 06
 -- This is an interesting rule: we simply ignore lets in the 
 -- term being matched against!  The unfolding inside it is (by assumption)
 -- already inside any occurrences of the bound variables, so we'll expand
@@ -529,10 +542,11 @@ match menv subst e1 (Let bind e2)
        -- We must not get success with x->y!  So we record that y is
        -- locally bound (with rnBndrR), and proceed.  The Var case
        -- will fail when trying to bind x->y
-       --
+-}
 
 -- Everything else fails
-match menv subst e1 e2 = Nothing
+match menv subst e1 e2 = -- pprTrace "Failing at" ((text "e1:" <+> ppr e1) $$ (text "e2:" <+> ppr e2)) $ 
+                        Nothing
 
 ------------------------------------------
 match_var :: MatchEnv
@@ -548,7 +562,7 @@ match_var menv subst@(tv_subst, id_subst, binds) v1 e2
                -- e.g. match forall a. (\x-> a x) against (\y. y y)
 
                | otherwise     -- No renaming to do on e2
-               -> Just (tv_subst, extendVarEnv id_subst v1 e2, binds)
+               -> Just (tv_subst, extendVarEnv id_subst v1' e2, binds)
 
        Just e2' | tcEqExprX (nukeRnEnvL rn_env) e2' e2 
                 -> Just subst
@@ -687,6 +701,7 @@ ruleCheck env (Lit l)           = emptyBag
 ruleCheck env (Type ty)     = emptyBag
 ruleCheck env (App f a)     = ruleCheckApp env (App f a) []
 ruleCheck env (Note n e)    = ruleCheck env e
+ruleCheck env (Cast e co)   = ruleCheck env e
 ruleCheck env (Let bd e)    = ruleCheckBind env bd `unionBags` ruleCheck env e
 ruleCheck env (Lam b e)     = ruleCheck env e
 ruleCheck env (Case e _ _ as) = ruleCheck env e `unionBags`