2 % (c) The AQUA Project, Glasgow University, 1996-1998
4 \section[RnHsSyn]{Specialisations of the @HsSyn@ syntax for the renamer}
9 #include "HsVersions.h"
13 import Class ( FunDep, DefMeth(..) )
14 import TysWiredIn ( tupleTyCon, listTyCon, charTyCon )
15 import Name ( Name, getName, isTyVarName )
17 import BasicTypes ( Boxity )
18 import Maybes ( orElse )
24 type RenamedArithSeqInfo = ArithSeqInfo Name RenamedPat
25 type RenamedClassOpSig = Sig Name
26 type RenamedConDecl = ConDecl Name
27 type RenamedContext = HsContext Name
28 type RenamedHsDecl = HsDecl Name RenamedPat
29 type RenamedRuleDecl = RuleDecl Name RenamedPat
30 type RenamedTyClDecl = TyClDecl Name RenamedPat
31 type RenamedDefaultDecl = DefaultDecl Name
32 type RenamedForeignDecl = ForeignDecl Name
33 type RenamedGRHS = GRHS Name RenamedPat
34 type RenamedGRHSs = GRHSs Name RenamedPat
35 type RenamedHsBinds = HsBinds Name RenamedPat
36 type RenamedHsExpr = HsExpr Name RenamedPat
37 type RenamedHsModule = HsModule Name RenamedPat
38 type RenamedInstDecl = InstDecl Name RenamedPat
39 type RenamedMatch = Match Name RenamedPat
40 type RenamedMonoBinds = MonoBinds Name RenamedPat
41 type RenamedPat = InPat Name
42 type RenamedHsType = HsType Name
43 type RenamedHsPred = HsPred Name
44 type RenamedRecordBinds = HsRecordBinds Name RenamedPat
45 type RenamedSig = Sig Name
46 type RenamedStmt = Stmt Name RenamedPat
47 type RenamedFixitySig = FixitySig Name
48 type RenamedDeprecation = DeprecDecl Name
49 type RenamedHsOverLit = HsOverLit Name
52 %************************************************************************
54 \subsection{Free variables}
56 %************************************************************************
58 These free-variable finders returns tycons and classes too.
61 charTyCon_name, listTyCon_name :: Name
62 charTyCon_name = getName charTyCon
63 listTyCon_name = getName listTyCon
65 tupleTyCon_name :: Boxity -> Int -> Name
66 tupleTyCon_name boxity n = getName (tupleTyCon boxity n)
68 extractHsTyVars :: RenamedHsType -> NameSet
69 extractHsTyVars x = filterNameSet isTyVarName (extractHsTyNames x)
71 extractFunDepNames :: FunDep Name -> NameSet
72 extractFunDepNames (ns1, ns2) = mkNameSet ns1 `unionNameSets` mkNameSet ns2
74 extractHsTyNames :: RenamedHsType -> NameSet
78 get (HsAppTy ty1 ty2) = get ty1 `unionNameSets` get ty2
79 get (HsListTy ty) = unitNameSet listTyCon_name `unionNameSets` get ty
80 get (HsTupleTy con tys) = hsTupConFVs con `unionNameSets` extractHsTyNames_s tys
81 get (HsFunTy ty1 ty2) = get ty1 `unionNameSets` get ty2
82 get (HsPredTy p) = extractHsPredTyNames p
83 get (HsOpTy ty1 tycon ty2) = get ty1 `unionNameSets` get ty2 `unionNameSets`
85 get (HsNumTy n) = emptyNameSet
86 get (HsTyVar tv) = unitNameSet tv
87 get (HsForAllTy (Just tvs)
88 ctxt ty) = (extractHsCtxtTyNames ctxt `unionNameSets` get ty)
90 mkNameSet (hsTyVarNames tvs)
91 get ty@(HsForAllTy Nothing _ _) = pprPanic "extractHsTyNames" (ppr ty)
93 extractHsTyNames_s :: [RenamedHsType] -> NameSet
94 extractHsTyNames_s tys = foldr (unionNameSets . extractHsTyNames) emptyNameSet tys
96 extractHsCtxtTyNames :: RenamedContext -> NameSet
97 extractHsCtxtTyNames ctxt = foldr (unionNameSets . extractHsPredTyNames) emptyNameSet ctxt
99 -- You don't import or export implicit parameters,
100 -- so don't mention the IP names
101 extractHsPredTyNames (HsPClass cls tys)
102 = unitNameSet cls `unionNameSets` extractHsTyNames_s tys
103 extractHsPredTyNames (HsPIParam n ty)
104 = extractHsTyNames ty
108 %************************************************************************
110 \subsection{Free variables of declarations}
112 %************************************************************************
114 Return the Names that must be in scope if we are to use this declaration.
115 In all cases this is set up for interface-file declarations:
116 - for class decls we ignore the bindings
117 - for instance decls likewise, plus the pragmas
118 - for rule decls, we ignore HsRules
120 *** See "THE NAMING STORY" in HsDecls ****
123 tyClDeclFVs :: RenamedTyClDecl -> NameSet
124 tyClDeclFVs (IfaceSig {tcdType = ty, tcdIdInfo = id_infos})
125 = extractHsTyNames ty `plusFV`
126 plusFVs (map hsIdInfoFVs id_infos)
128 tyClDeclFVs (TyData {tcdCtxt = context, tcdTyVars = tyvars, tcdCons = condecls, tcdDerivs = derivings})
129 = delFVs (map hsTyVarName tyvars) $
130 extractHsCtxtTyNames context `plusFV`
131 plusFVs (map conDeclFVs condecls) `plusFV`
132 mkNameSet (derivings `orElse` [])
134 tyClDeclFVs (TySynonym {tcdTyVars = tyvars, tcdSynRhs = ty})
135 = delFVs (map hsTyVarName tyvars) (extractHsTyNames ty)
137 tyClDeclFVs (ClassDecl {tcdCtxt = context, tcdTyVars = tyvars, tcdFDs = fds,
138 tcdSigs = sigs, tcdMeths = maybe_meths})
139 = delFVs (map hsTyVarName tyvars) $
140 extractHsCtxtTyNames context `plusFV`
141 plusFVs (map extractFunDepNames fds) `plusFV`
142 hsSigsFVs sigs `plusFV`
145 dm_fvs = case maybe_meths of
146 Nothing -> mkFVs [v | ClassOpSig _ (DefMeth v) _ _ <- sigs]
147 -- No method bindings, so this class decl comes from an interface file,
148 -- So we want to treat the default-method names as free (they should
149 -- be defined somewhere else). [In source code this is not so; the class
150 -- decl will bind whatever default-methods are necessary.]
151 Just _ -> emptyFVs -- Source code, so the default methods
152 -- are *bound* not *free*
155 hsSigsFVs sigs = plusFVs (map hsSigFVs sigs)
157 hsSigFVs (Sig v ty _) = extractHsTyNames ty
158 hsSigFVs (SpecInstSig ty _) = extractHsTyNames ty
159 hsSigFVs (SpecSig v ty _) = extractHsTyNames ty
160 hsSigFVs (ClassOpSig _ _ ty _) = extractHsTyNames ty
161 hsSigFVs other = emptyFVs
164 instDeclFVs (InstDecl inst_ty _ _ maybe_dfun _)
165 = extractHsTyNames inst_ty `plusFV`
166 (case maybe_dfun of { Just n -> unitFV n; Nothing -> emptyFVs })
169 ruleDeclFVs (HsRule _ _ _ _ _ _) = emptyFVs
170 ruleDeclFVs (IfaceRule _ vars _ args rhs _)
171 = delFVs (map ufBinderName vars) $
172 ufExprFVs rhs `plusFV` plusFVs (map ufExprFVs args)
175 conDeclFVs (ConDecl _ _ tyvars context details _)
176 = delFVs (map hsTyVarName tyvars) $
177 extractHsCtxtTyNames context `plusFV`
178 conDetailsFVs details
180 conDetailsFVs (VanillaCon btys) = plusFVs (map bangTyFVs btys)
181 conDetailsFVs (InfixCon bty1 bty2) = bangTyFVs bty1 `plusFV` bangTyFVs bty2
182 conDetailsFVs (RecCon flds) = plusFVs [bangTyFVs bty | (_, bty) <- flds]
184 bangTyFVs bty = extractHsTyNames (getBangType bty)
187 hsIdInfoFVs (HsUnfold _ unf) = ufExprFVs unf
188 hsIdInfoFVs (HsWorker n) = unitFV n
189 hsIdInfoFVs other = emptyFVs
192 ufExprFVs (UfVar n) = unitFV n
193 ufExprFVs (UfLit l) = emptyFVs
194 ufExprFVs (UfLitLit l ty) = extractHsTyNames ty
195 ufExprFVs (UfCCall cc ty) = extractHsTyNames ty
196 ufExprFVs (UfType ty) = extractHsTyNames ty
197 ufExprFVs (UfTuple tc es) = hsTupConFVs tc `plusFV` plusFVs (map ufExprFVs es)
198 ufExprFVs (UfLam v e) = ufBndrFVs v (ufExprFVs e)
199 ufExprFVs (UfApp e1 e2) = ufExprFVs e1 `plusFV` ufExprFVs e2
200 ufExprFVs (UfCase e n as) = ufExprFVs e `plusFV` delFV n (plusFVs (map ufAltFVs as))
201 ufExprFVs (UfNote n e) = ufNoteFVs n `plusFV` ufExprFVs e
202 ufExprFVs (UfLet (UfNonRec b r) e) = ufExprFVs r `plusFV` ufBndrFVs b (ufExprFVs e)
203 ufExprFVs (UfLet (UfRec prs) e) = foldr ufBndrFVs
204 (foldr (plusFV . ufExprFVs . snd) (ufExprFVs e) prs)
207 ufBndrFVs (UfValBinder n ty) fvs = extractHsTyNames ty `plusFV` delFV n fvs
208 ufBndrFVs (UfTyBinder n k) fvs = delFV n fvs
210 ufAltFVs (con, vs, e) = ufConFVs con `plusFV` delFVs vs (ufExprFVs e)
212 ufConFVs (UfDataAlt n) = unitFV n
213 ufConFVs (UfTupleAlt t) = hsTupConFVs t
214 ufConFVs (UfLitLitAlt _ ty) = extractHsTyNames ty
215 ufConFVs other = emptyFVs
217 ufNoteFVs (UfCoerce ty) = extractHsTyNames ty
218 ufNoteFVs note = emptyFVs
220 hsTupConFVs (HsTupCon n _ _) = unitFV n
223 %************************************************************************
225 \subsection{A few functions on generic defintions
227 %************************************************************************
229 These functions on generics are defined over RenamedMatches, which is
230 why they are here and not in HsMatches.
233 maybeGenericMatch :: RenamedMatch -> Maybe (RenamedHsType, RenamedMatch)
234 -- Tells whether a Match is for a generic definition
235 -- and extract the type from a generic match and put it at the front
237 maybeGenericMatch (Match tvs (TypePatIn ty : pats) sig_ty grhss)
238 = Just (ty, Match tvs pats sig_ty grhss)
240 maybeGenericMatch other_match = Nothing