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 )
23 type RenamedArithSeqInfo = ArithSeqInfo Name RenamedPat
24 type RenamedClassOpSig = Sig Name
25 type RenamedConDecl = ConDecl Name
26 type RenamedContext = HsContext Name
27 type RenamedHsDecl = HsDecl Name RenamedPat
28 type RenamedRuleDecl = RuleDecl Name RenamedPat
29 type RenamedTyClDecl = TyClDecl Name RenamedPat
30 type RenamedDefaultDecl = DefaultDecl Name
31 type RenamedForeignDecl = ForeignDecl Name
32 type RenamedGRHS = GRHS Name RenamedPat
33 type RenamedGRHSs = GRHSs Name RenamedPat
34 type RenamedHsBinds = HsBinds Name RenamedPat
35 type RenamedHsExpr = HsExpr Name RenamedPat
36 type RenamedHsModule = HsModule Name RenamedPat
37 type RenamedInstDecl = InstDecl Name RenamedPat
38 type RenamedMatch = Match Name RenamedPat
39 type RenamedMonoBinds = MonoBinds Name RenamedPat
40 type RenamedPat = InPat Name
41 type RenamedHsType = HsType Name
42 type RenamedHsPred = HsPred Name
43 type RenamedRecordBinds = HsRecordBinds Name RenamedPat
44 type RenamedSig = Sig Name
45 type RenamedStmt = Stmt Name RenamedPat
46 type RenamedFixitySig = FixitySig Name
47 type RenamedDeprecation = DeprecDecl Name
50 %************************************************************************
52 \subsection{Free variables}
54 %************************************************************************
56 These free-variable finders returns tycons and classes too.
59 charTyCon_name, listTyCon_name :: Name
60 charTyCon_name = getName charTyCon
61 listTyCon_name = getName listTyCon
63 tupleTyCon_name :: Boxity -> Int -> Name
64 tupleTyCon_name boxity n = getName (tupleTyCon boxity n)
66 extractHsTyVars :: RenamedHsType -> NameSet
67 extractHsTyVars x = filterNameSet isTyVarName (extractHsTyNames x)
69 extractFunDepNames :: FunDep Name -> NameSet
70 extractFunDepNames (ns1, ns2) = mkNameSet ns1 `unionNameSets` mkNameSet ns2
72 extractHsTyNames :: RenamedHsType -> NameSet
76 get (HsAppTy ty1 ty2) = get ty1 `unionNameSets` get ty2
77 get (HsListTy ty) = unitNameSet listTyCon_name `unionNameSets` get ty
78 get (HsTupleTy con tys) = hsTupConFVs con `unionNameSets` extractHsTyNames_s tys
79 get (HsFunTy ty1 ty2) = get ty1 `unionNameSets` get ty2
80 get (HsPredTy p) = extractHsPredTyNames p
81 get (HsOpTy ty1 tycon ty2) = get ty1 `unionNameSets` get ty2 `unionNameSets`
83 get (HsNumTy n) = emptyNameSet
84 get (HsTyVar tv) = unitNameSet tv
85 get (HsForAllTy (Just tvs)
86 ctxt ty) = (extractHsCtxtTyNames ctxt `unionNameSets` get ty)
88 mkNameSet (hsTyVarNames tvs)
89 get ty@(HsForAllTy Nothing _ _) = pprPanic "extractHsTyNames" (ppr ty)
91 extractHsTyNames_s :: [RenamedHsType] -> NameSet
92 extractHsTyNames_s tys = foldr (unionNameSets . extractHsTyNames) emptyNameSet tys
94 extractHsCtxtTyNames :: RenamedContext -> NameSet
95 extractHsCtxtTyNames ctxt = foldr (unionNameSets . extractHsPredTyNames) emptyNameSet ctxt
97 -- You don't import or export implicit parameters,
98 -- so don't mention the IP names
99 extractHsPredTyNames (HsClassP cls tys)
100 = unitNameSet cls `unionNameSets` extractHsTyNames_s tys
101 extractHsPredTyNames (HsIParam n ty)
102 = extractHsTyNames ty
106 %************************************************************************
108 \subsection{Free variables of declarations}
110 %************************************************************************
112 Return the Names that must be in scope if we are to use this declaration.
113 In all cases this is set up for interface-file declarations:
114 - for class decls we ignore the bindings
115 - for instance decls likewise, plus the pragmas
116 - for rule decls, we ignore HsRules
118 *** See "THE NAMING STORY" in HsDecls ****
121 tyClDeclFVs :: RenamedTyClDecl -> NameSet
122 tyClDeclFVs (IfaceSig {tcdType = ty, tcdIdInfo = id_infos})
123 = extractHsTyNames ty `plusFV`
124 plusFVs (map hsIdInfoFVs id_infos)
126 tyClDeclFVs (TyData {tcdCtxt = context, tcdTyVars = tyvars, tcdCons = condecls, tcdDerivs = derivings})
127 = delFVs (map hsTyVarName tyvars) $
128 extractHsCtxtTyNames context `plusFV`
129 plusFVs (map conDeclFVs condecls)
131 tyClDeclFVs (TySynonym {tcdTyVars = tyvars, tcdSynRhs = ty})
132 = delFVs (map hsTyVarName tyvars) (extractHsTyNames ty)
134 tyClDeclFVs (ClassDecl {tcdCtxt = context, tcdTyVars = tyvars, tcdFDs = fds,
135 tcdSigs = sigs, tcdMeths = maybe_meths})
136 = delFVs (map hsTyVarName tyvars) $
137 extractHsCtxtTyNames context `plusFV`
138 plusFVs (map extractFunDepNames fds) `plusFV`
139 hsSigsFVs sigs `plusFV`
142 dm_fvs = case maybe_meths of
143 Nothing -> mkFVs [v | ClassOpSig _ (DefMeth v) _ _ <- sigs]
144 -- No method bindings, so this class decl comes from an interface file,
145 -- So we want to treat the default-method names as free (they should
146 -- be defined somewhere else). [In source code this is not so; the class
147 -- decl will bind whatever default-methods are necessary.]
148 Just _ -> emptyFVs -- Source code, so the default methods
149 -- are *bound* not *free*
152 hsSigsFVs sigs = plusFVs (map hsSigFVs sigs)
154 hsSigFVs (Sig v ty _) = extractHsTyNames ty
155 hsSigFVs (SpecInstSig ty _) = extractHsTyNames ty
156 hsSigFVs (SpecSig v ty _) = extractHsTyNames ty
157 hsSigFVs (ClassOpSig _ _ ty _) = extractHsTyNames ty
158 hsSigFVs other = emptyFVs
161 instDeclFVs (InstDecl inst_ty _ _ maybe_dfun _)
162 = extractHsTyNames inst_ty `plusFV`
163 (case maybe_dfun of { Just n -> unitFV n; Nothing -> emptyFVs })
166 ruleDeclFVs (HsRule _ _ _ _ _ _) = emptyFVs
167 ruleDeclFVs (IfaceRule _ vars _ args rhs _)
168 = delFVs (map ufBinderName vars) $
169 ufExprFVs rhs `plusFV` plusFVs (map ufExprFVs args)
172 conDeclFVs (ConDecl _ _ tyvars context details _)
173 = delFVs (map hsTyVarName tyvars) $
174 extractHsCtxtTyNames context `plusFV`
175 conDetailsFVs details
177 conDetailsFVs (VanillaCon btys) = plusFVs (map bangTyFVs btys)
178 conDetailsFVs (InfixCon bty1 bty2) = bangTyFVs bty1 `plusFV` bangTyFVs bty2
179 conDetailsFVs (RecCon flds) = plusFVs [bangTyFVs bty | (_, bty) <- flds]
181 bangTyFVs bty = extractHsTyNames (getBangType bty)
184 hsIdInfoFVs (HsUnfold _ unf) = ufExprFVs unf
185 hsIdInfoFVs (HsWorker n a) = unitFV n
186 hsIdInfoFVs other = emptyFVs
189 ufExprFVs (UfVar n) = unitFV n
190 ufExprFVs (UfLit l) = emptyFVs
191 ufExprFVs (UfLitLit l ty) = extractHsTyNames ty
192 ufExprFVs (UfFCall cc ty) = extractHsTyNames ty
193 ufExprFVs (UfType ty) = extractHsTyNames ty
194 ufExprFVs (UfTuple tc es) = hsTupConFVs tc `plusFV` plusFVs (map ufExprFVs es)
195 ufExprFVs (UfLam v e) = ufBndrFVs v (ufExprFVs e)
196 ufExprFVs (UfApp e1 e2) = ufExprFVs e1 `plusFV` ufExprFVs e2
197 ufExprFVs (UfCase e n as) = ufExprFVs e `plusFV` delFV n (plusFVs (map ufAltFVs as))
198 ufExprFVs (UfNote n e) = ufNoteFVs n `plusFV` ufExprFVs e
199 ufExprFVs (UfLet (UfNonRec b r) e) = ufExprFVs r `plusFV` ufBndrFVs b (ufExprFVs e)
200 ufExprFVs (UfLet (UfRec prs) e) = foldr ufBndrFVs
201 (foldr (plusFV . ufExprFVs . snd) (ufExprFVs e) prs)
204 ufBndrFVs (UfValBinder n ty) fvs = extractHsTyNames ty `plusFV` delFV n fvs
205 ufBndrFVs (UfTyBinder n k) fvs = delFV n fvs
207 ufAltFVs (con, vs, e) = ufConFVs con `plusFV` delFVs vs (ufExprFVs e)
209 ufConFVs (UfDataAlt n) = unitFV n
210 ufConFVs (UfTupleAlt t) = hsTupConFVs t
211 ufConFVs (UfLitLitAlt _ ty) = extractHsTyNames ty
212 ufConFVs other = emptyFVs
214 ufNoteFVs (UfCoerce ty) = extractHsTyNames ty
215 ufNoteFVs note = emptyFVs
217 hsTupConFVs (HsTupCon n _ _) = unitFV n
220 %************************************************************************
222 \subsection{A few functions on generic defintions
224 %************************************************************************
226 These functions on generics are defined over RenamedMatches, which is
227 why they are here and not in HsMatches.
230 maybeGenericMatch :: RenamedMatch -> Maybe (RenamedHsType, RenamedMatch)
231 -- Tells whether a Match is for a generic definition
232 -- and extract the type from a generic match and put it at the front
234 maybeGenericMatch (Match tvs (TypePatIn ty : pats) sig_ty grhss)
235 = Just (ty, Match tvs pats sig_ty grhss)
237 maybeGenericMatch other_match = Nothing