153d37c550488116542ee9e89b2a5c093abf180f
[ghc-hetmet.git] / ghc / compiler / typecheck / TcRules.lhs
1 %
2 % (c) The AQUA Project, Glasgow University, 1993-1998
3 %
4 \section[TcRules]{Typechecking transformation rules}
5
6 \begin{code}
7 module TcRules ( tcIfaceRules, tcSourceRules ) where
8
9 #include "HsVersions.h"
10
11 import HsSyn            ( RuleDecl(..), RuleBndr(..) )
12 import CoreSyn          ( CoreRule(..) )
13 import RnHsSyn          ( RenamedRuleDecl )
14 import HscTypes         ( PackageRuleBase )
15 import TcHsSyn          ( TypecheckedRuleDecl, mkHsLet )
16 import TcMonad
17 import TcSimplify       ( tcSimplifyToDicts, tcSimplifyInferCheck )
18 import TcType           ( zonkTcTyVarToTyVar, newTyVarTy )
19 import TcIfaceSig       ( tcCoreExpr, tcCoreLamBndrs, tcVar )
20 import TcMonoType       ( kcHsSigType, tcHsSigType, tcTyVars, checkSigTyVars )
21 import TcExpr           ( tcExpr )
22 import TcEnv            ( tcExtendLocalValEnv, tcExtendTyVarEnv, isLocalThing )
23 import Rules            ( extendRuleBase )
24 import Inst             ( LIE, plusLIEs, instToId )
25 import Id               ( idName, idType, mkVanillaId )
26 import Module           ( Module )
27 import VarSet
28 import Type             ( tyVarsOfTypes, openTypeKind )
29 import List             ( partition )
30 import Outputable
31 \end{code}
32
33 \begin{code}
34 tcIfaceRules :: PackageRuleBase -> Module -> [RenamedRuleDecl] 
35              -> TcM (PackageRuleBase, [TypecheckedRuleDecl])
36 tcIfaceRules pkg_rule_base mod decls 
37   = mapTc tcIfaceRule decls             `thenTc` \ new_rules ->
38     let
39         (local_rules, imported_rules) = partition is_local new_rules
40         new_rule_base = foldl add pkg_rule_base imported_rules
41     in
42     returnTc (new_rule_base, local_rules)
43   where
44     add rule_base (IfaceRuleOut id rule) = extendRuleBase rule_base (id, rule)
45
46         -- When relinking this module from its interface-file decls
47         -- we'll have IfaceRules that are in fact local to this module
48     is_local (IfaceRuleOut n _) = isLocalThing mod n
49     is_local other              = True
50
51 tcIfaceRule :: RenamedRuleDecl -> TcM TypecheckedRuleDecl
52   -- No zonking necessary!
53 tcIfaceRule rule@(IfaceRule name vars fun args rhs src_loc)
54   = tcAddSrcLoc src_loc                 $
55     tcAddErrCtxt (ruleCtxt name)        $
56     tcVar fun                           `thenTc` \ fun' ->
57     tcCoreLamBndrs vars                 $ \ vars' ->
58     mapTc tcCoreExpr args               `thenTc` \ args' ->
59     tcCoreExpr rhs                      `thenTc` \ rhs' ->
60     let
61         new_rule :: TypecheckedRuleDecl
62         new_rule = IfaceRuleOut fun' (Rule name vars' args' rhs')
63     in
64     returnTc new_rule
65
66 tcSourceRules :: [RenamedRuleDecl] -> TcM (LIE, [TypecheckedRuleDecl])
67 tcSourceRules decls
68   = mapAndUnzipTc tcSourceRule decls    `thenTc` \ (lies, decls') ->
69     returnTc (plusLIEs lies, decls')
70
71 tcSourceRule (HsRule name sig_tvs vars lhs rhs src_loc)
72   = tcAddSrcLoc src_loc                                 $
73     tcAddErrCtxt (ruleCtxt name)                        $
74     newTyVarTy openTypeKind                             `thenNF_Tc` \ rule_ty ->
75
76         -- Deal with the tyvars mentioned in signatures
77     tcTyVars sig_tvs (mapTc_ kcHsSigType sig_tys)       `thenTc` \ sig_tyvars ->
78     tcExtendTyVarEnv sig_tyvars (
79
80                 -- Ditto forall'd variables
81         mapNF_Tc new_id vars                                    `thenNF_Tc` \ ids ->
82         tcExtendLocalValEnv [(idName id, id) | id <- ids]       $
83         
84                 -- Now LHS and RHS
85         tcExpr lhs rule_ty                                      `thenTc` \ (lhs', lhs_lie) ->
86         tcExpr rhs rule_ty                                      `thenTc` \ (rhs', rhs_lie) ->
87         
88         returnTc (sig_tyvars, ids, lhs', rhs', lhs_lie, rhs_lie)
89     )                                           `thenTc` \ (sig_tyvars, ids, lhs', rhs', lhs_lie, rhs_lie) ->
90
91                 -- Check that LHS has no overloading at all
92     tcSimplifyToDicts lhs_lie                   `thenTc` \ (lhs_dicts, lhs_binds) ->
93     checkSigTyVars sig_tyvars emptyVarSet       `thenTc_`
94
95         -- Gather the template variables and tyvars
96     let
97         tpl_ids = map instToId lhs_dicts ++ ids
98
99         -- IMPORTANT!  We *quantify* over any dicts that appear in the LHS
100         -- Reason: 
101         --      a) The particular dictionary isn't important, because its value
102         --         depends only on the type
103         --              e.g     gcd Int $fIntegralInt
104         --         Here we'd like to match against (gcd Int any_d) for any 'any_d'
105         --
106         --      b) We'd like to make available the dictionaries bound 
107         --         on the LHS in the RHS, so quantifying over them is good
108         --         See the 'lhs_dicts' in tcSimplifyAndCheck for the RHS
109
110         -- We initially quantify over any tyvars free in *either* the rule
111         -- *or* the bound variables.  The latter is important.  Consider
112         --      ss (x,(y,z)) = (x,z)
113         --      RULE:  forall v. fst (ss v) = fst v
114         -- The type of the rhs of the rule is just a, but v::(a,(b,c))
115         --
116         -- It's still conceivable that there may be type variables mentioned
117         -- in the LHS, but not in the type of the lhs, nor in the binders.
118         -- They'll get zapped to (), but that's over-constraining really.
119         -- Let's see if we get a problem.
120         forall_tvs = varSetElems (tyVarsOfTypes (rule_ty : map idType tpl_ids))
121     in
122
123         -- RHS can be a bit more lenient.  In particular,
124         -- we let constant dictionaries etc float outwards
125         --
126         -- 
127     tcSimplifyInferCheck (text "tcRule")
128                          forall_tvs
129                          lhs_dicts rhs_lie      `thenTc` \ (forall_tvs1, lie', rhs_binds) ->
130
131     returnTc (lie', HsRule      name forall_tvs1
132                                 (map RuleBndr tpl_ids)  -- yuk
133                                 (mkHsLet lhs_binds lhs')
134                                 (mkHsLet rhs_binds rhs')
135                                 src_loc)
136   where
137     sig_tys = [t | RuleBndrSig _ t <- vars]
138
139     new_id (RuleBndr var)          = newTyVarTy openTypeKind    `thenNF_Tc` \ ty ->
140                                      returnNF_Tc (mkVanillaId var ty)
141     new_id (RuleBndrSig var rn_ty) = tcHsSigType rn_ty  `thenTc` \ ty ->
142                                      returnNF_Tc (mkVanillaId var ty)
143
144 ruleCtxt name = ptext SLIT("When checking the transformation rule") <+> 
145                 doubleQuotes (ptext name)
146 \end{code}
147
148
149
150