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 (HsTupCon n _) tys) = unitNameSet n
81 `unionNameSets` extractHsTyNames_s tys
82 get (HsFunTy ty1 ty2) = get ty1 `unionNameSets` get ty2
83 get (HsPredTy p) = extractHsPredTyNames p
84 get (HsUsgForAllTy uv ty) = get ty
85 get (HsUsgTy u ty) = get ty
86 get (HsOpTy ty1 tycon ty2) = get ty1 `unionNameSets` get ty2 `unionNameSets`
88 get (HsNumTy n) = emptyNameSet
89 get (HsTyVar tv) = unitNameSet tv
90 get (HsForAllTy (Just tvs)
91 ctxt ty) = (extractHsCtxtTyNames ctxt `unionNameSets` get ty)
93 mkNameSet (hsTyVarNames tvs)
94 get ty@(HsForAllTy Nothing _ _) = pprPanic "extractHsTyNames" (ppr ty)
96 extractHsTyNames_s :: [RenamedHsType] -> NameSet
97 extractHsTyNames_s tys = foldr (unionNameSets . extractHsTyNames) emptyNameSet tys
99 extractHsCtxtTyNames :: RenamedContext -> NameSet
100 extractHsCtxtTyNames ctxt = foldr (unionNameSets . extractHsPredTyNames) emptyNameSet ctxt
102 -- You don't import or export implicit parameters,
103 -- so don't mention the IP names
104 extractHsPredTyNames (HsPClass cls tys)
105 = unitNameSet cls `unionNameSets` extractHsTyNames_s tys
106 extractHsPredTyNames (HsPIParam n ty)
107 = extractHsTyNames ty
111 %************************************************************************
113 \subsection{Free variables of declarations}
115 %************************************************************************
117 Return the Names that must be in scope if we are to use this declaration.
118 In all cases this is set up for interface-file declarations:
119 - for class decls we ignroe the bindings
120 - for instance decls likewise, plus the pragmas
121 - for rule decls, we ignore HsRules
124 tyClDeclFVs :: RenamedTyClDecl -> NameSet
125 tyClDeclFVs (IfaceSig name ty id_infos loc)
126 = extractHsTyNames ty `plusFV`
127 plusFVs (map hsIdInfoFVs id_infos)
129 tyClDeclFVs (TyData _ context _ tyvars condecls _ derivings _ _ _)
130 = delFVs (map hsTyVarName tyvars) $
131 extractHsCtxtTyNames context `plusFV`
132 plusFVs (map conDeclFVs condecls) `plusFV`
133 mkNameSet (derivings `orElse` [])
135 tyClDeclFVs (TySynonym _ tyvars ty _)
136 = delFVs (map hsTyVarName tyvars) (extractHsTyNames ty)
138 tyClDeclFVs (ClassDecl context _ tyvars fds sigs _ _ src_loc)
139 = delFVs (map hsTyVarName tyvars) $
140 extractHsCtxtTyNames context `plusFV`
141 plusFVs (map extractFunDepNames fds) `plusFV`
145 hsSigsFVs sigs = plusFVs (map hsSigFVs sigs)
147 hsSigFVs (Sig v ty _) = extractHsTyNames ty `addOneFV` v
148 hsSigFVs (SpecInstSig ty _) = extractHsTyNames ty
149 hsSigFVs (SpecSig v ty _) = extractHsTyNames ty `addOneFV` v
150 hsSigFVs (FixSig (FixitySig v _ _)) = unitFV v
151 hsSigFVs (InlineSig v p _) = unitFV v
152 hsSigFVs (NoInlineSig v p _) = unitFV v
153 hsSigFVs (ClassOpSig v dm ty _) = dmFVs dm `plusFV` extractHsTyNames ty `addOneFV` v
155 dmFVs (Just (DefMeth v)) = unitFV v
156 dmFVs other = emptyFVs
159 instDeclFVs (InstDecl inst_ty _ _ maybe_dfun _)
160 = extractHsTyNames inst_ty `plusFV`
161 (case maybe_dfun of { Just n -> unitFV n; Nothing -> emptyFVs })
164 ruleDeclFVs (HsRule _ _ _ _ _ _) = emptyFVs
165 ruleDeclFVs (IfaceRule _ vars _ args rhs _)
166 = delFVs (map ufBinderName vars) $
167 ufExprFVs rhs `plusFV` plusFVs (map ufExprFVs args)
170 conDeclFVs (ConDecl _ _ tyvars context details _)
171 = delFVs (map hsTyVarName tyvars) $
172 extractHsCtxtTyNames context `plusFV`
173 conDetailsFVs details
175 conDetailsFVs (VanillaCon btys) = plusFVs (map bangTyFVs btys)
176 conDetailsFVs (InfixCon bty1 bty2) = bangTyFVs bty1 `plusFV` bangTyFVs bty2
177 conDetailsFVs (RecCon flds) = plusFVs [bangTyFVs bty | (_, bty) <- flds]
179 bangTyFVs bty = extractHsTyNames (getBangType bty)
182 hsIdInfoFVs (HsUnfold _ unf) = ufExprFVs unf
183 hsIdInfoFVs (HsWorker n) = unitFV n
184 hsIdInfoFVs other = emptyFVs
187 ufExprFVs (UfVar n) = unitFV n
188 ufExprFVs (UfLit l) = emptyFVs
189 ufExprFVs (UfLitLit l ty) = extractHsTyNames ty
190 ufExprFVs (UfCCall cc ty) = extractHsTyNames ty
191 ufExprFVs (UfType ty) = extractHsTyNames ty
192 ufExprFVs (UfTuple tc es) = hsTupConFVs tc `plusFV` plusFVs (map ufExprFVs es)
193 ufExprFVs (UfLam v e) = ufBndrFVs v (ufExprFVs e)
194 ufExprFVs (UfApp e1 e2) = ufExprFVs e1 `plusFV` ufExprFVs e2
195 ufExprFVs (UfCase e n as) = ufExprFVs e `plusFV` delFV n (plusFVs (map ufAltFVs as))
196 ufExprFVs (UfNote n e) = ufNoteFVs n `plusFV` ufExprFVs e
197 ufExprFVs (UfLet (UfNonRec b r) e) = ufExprFVs r `plusFV` ufBndrFVs b (ufExprFVs e)
198 ufExprFVs (UfLet (UfRec prs) e) = foldr ufBndrFVs
199 (foldr (plusFV . ufExprFVs . snd) (ufExprFVs e) prs)
202 ufBndrFVs (UfValBinder n ty) fvs = extractHsTyNames ty `plusFV` delFV n fvs
203 ufBndrFVs (UfTyBinder n k) fvs = delFV n fvs
205 ufAltFVs (con, vs, e) = ufConFVs con `plusFV` delFVs vs (ufExprFVs e)
207 ufConFVs (UfDataAlt n) = unitFV n
208 ufConFVs (UfTupleAlt t) = hsTupConFVs t
209 ufConFVs (UfLitLitAlt _ ty) = extractHsTyNames ty
210 ufConFVs other = emptyFVs
212 ufNoteFVs (UfCoerce ty) = extractHsTyNames ty
213 ufNoteFVs note = emptyFVs
215 hsTupConFVs (HsTupCon n _) = unitFV n
218 %************************************************************************
220 \subsection{A few functions on generic defintions
222 %************************************************************************
224 These functions on generics are defined over RenamedMatches, which is
225 why they are here and not in HsMatches.
228 maybeGenericMatch :: RenamedMatch -> Maybe (RenamedHsType, RenamedMatch)
229 -- Tells whether a Match is for a generic definition
230 -- and extract the type from a generic match and put it at the front
232 maybeGenericMatch (Match tvs (TypePatIn ty : pats) sig_ty grhss)
233 = Just (ty, Match tvs pats sig_ty grhss)
235 maybeGenericMatch other_match = Nothing