ghc/compiler/rename/RnHsSyn.lhs

   1 %
   2 % (c) The AQUA Project, Glasgow University, 1996-1998
   3 %
   4 \section[RnHsSyn]{Specialisations of the @HsSyn@ syntax for the renamer}
   5
   6 \begin{code}
   7 module RnHsSyn where
   8
   9 #include "HsVersions.h"
  10
  11 import HsSyn
  12 import HsCore
  13 import Class            ( FunDep, DefMeth(..) )
  14 import TysWiredIn       ( tupleTyCon, listTyCon, charTyCon )
  15 import Name             ( Name, getName, isTyVarName )
  16 import NameSet
  17 import BasicTypes       ( Boxity )
  18 import Maybes           ( orElse )
  19 import Outputable
  20 \end{code}
  21
  22
  23 \begin{code}
  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
  50 \end{code}
  51
  52 %************************************************************************
  53 %*                                                                      *
  54 \subsection{Free variables}
  55 %*                                                                      *
  56 %************************************************************************
  57
  58 These free-variable finders returns tycons and classes too.
  59
  60 \begin{code}
  61 charTyCon_name, listTyCon_name :: Name
  62 charTyCon_name    = getName charTyCon
  63 listTyCon_name    = getName listTyCon
  64
  65 tupleTyCon_name :: Boxity -> Int -> Name
  66 tupleTyCon_name boxity n = getName (tupleTyCon boxity n)
  67
  68 extractHsTyVars :: RenamedHsType -> NameSet
  69 extractHsTyVars x = filterNameSet isTyVarName (extractHsTyNames x)
  70
  71 extractFunDepNames :: FunDep Name -> NameSet
  72 extractFunDepNames (ns1, ns2) = mkNameSet ns1 `unionNameSets` mkNameSet ns2
  73
  74 extractHsTyNames   :: RenamedHsType -> NameSet
  75 extractHsTyNames ty
  76   = get ty
  77   where
  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`
  84                                  unitNameSet tycon
  85     get (HsNumTy n)            = emptyNameSet
  86     get (HsTyVar tv)           = unitNameSet tv
  87     get (HsForAllTy (Just tvs)
  88                     ctxt ty)   = (extractHsCtxtTyNames ctxt `unionNameSets` get ty)
  89                                             `minusNameSet`
  90                                   mkNameSet (hsTyVarNames tvs)
  91     get ty@(HsForAllTy Nothing _ _) = pprPanic "extractHsTyNames" (ppr ty)
  92
  93 extractHsTyNames_s  :: [RenamedHsType] -> NameSet
  94 extractHsTyNames_s tys = foldr (unionNameSets . extractHsTyNames) emptyNameSet tys
  95
  96 extractHsCtxtTyNames :: RenamedContext -> NameSet
  97 extractHsCtxtTyNames ctxt = foldr (unionNameSets . extractHsPredTyNames) emptyNameSet ctxt
  98
  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
 105 \end{code}
 106
 107
 108 %************************************************************************
 109 %*                                                                      *
 110 \subsection{Free variables of declarations}
 111 %*                                                                      *
 112 %************************************************************************
 113
 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
 119
 120 \begin{code}
 121 tyClDeclFVs :: RenamedTyClDecl -> NameSet
 122 tyClDeclFVs (IfaceSig {tcdType = ty, tcdIdInfo = id_infos})
 123   = extractHsTyNames ty                 `plusFV`
 124     plusFVs (map hsIdInfoFVs id_infos)
 125
 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)   `plusFV`
 130     mkNameSet (derivings `orElse` [])
 131
 132 tyClDeclFVs (TySynonym {tcdTyVars = tyvars, tcdSynRhs = ty})
 133   = delFVs (map hsTyVarName tyvars) (extractHsTyNames ty)
 134
 135 tyClDeclFVs (ClassDecl {tcdCtxt = context, tcdTyVars = tyvars, tcdFDs = fds,
 136                         tcdSigs = sigs, tcdMeths = maybe_meths})
 137   = delFVs (map hsTyVarName tyvars) $
 138     extractHsCtxtTyNames context          `plusFV`
 139     plusFVs (map extractFunDepNames fds)  `plusFV`
 140     hsSigsFVs sigs                        `plusFV`
 141     dm_fvs
 142   where
 143     dm_fvs = case maybe_meths of
 144                 Nothing -> mkFVs [v | ClassOpSig _ (DefMeth v) _ _ <- sigs]
 145                   -- No method bindings, so this class decl comes from an interface file,
 146                   -- So we want to treat the default-method names as free (they should
 147                   -- be defined somewhere else).  [In source code this is not so; the class
 148                   -- decl will bind whatever default-methods are necessary.]
 149                 Just _ -> emptyFVs      -- Source code, so the default methods
 150                                         -- are *bound* not *free*
 151
 152 ----------------
 153 hsSigsFVs sigs = plusFVs (map hsSigFVs sigs)
 154
 155 hsSigFVs (Sig v ty _)       = extractHsTyNames ty
 156 hsSigFVs (SpecInstSig ty _) = extractHsTyNames ty
 157 hsSigFVs (SpecSig v ty _)   = extractHsTyNames ty
 158 hsSigFVs (ClassOpSig _ _ ty _) = extractHsTyNames ty
 159 hsSigFVs other              = emptyFVs
 160
 161 ----------------
 162 instDeclFVs (InstDecl inst_ty _ _ maybe_dfun _)
 163   = extractHsTyNames inst_ty    `plusFV`
 164     (case maybe_dfun of { Just n -> unitFV n; Nothing -> emptyFVs })
 165
 166 ----------------
 167 ruleDeclFVs (HsRule _ _ _ _ _ _) = emptyFVs
 168 ruleDeclFVs (IfaceRule _ vars _ args rhs _)
 169   = delFVs (map ufBinderName vars) $
 170     ufExprFVs rhs `plusFV` plusFVs (map ufExprFVs args)
 171
 172 ----------------
 173 conDeclFVs (ConDecl _ _ tyvars context details _)
 174   = delFVs (map hsTyVarName tyvars) $
 175     extractHsCtxtTyNames context          `plusFV`
 176     conDetailsFVs details
 177
 178 conDetailsFVs (VanillaCon btys)    = plusFVs (map bangTyFVs btys)
 179 conDetailsFVs (InfixCon bty1 bty2) = bangTyFVs bty1 `plusFV` bangTyFVs bty2
 180 conDetailsFVs (RecCon flds)        = plusFVs [bangTyFVs bty | (_, bty) <- flds]
 181
 182 bangTyFVs bty = extractHsTyNames (getBangType bty)
 183
 184 ----------------
 185 hsIdInfoFVs (HsUnfold _ unf) = ufExprFVs unf
 186 hsIdInfoFVs (HsWorker n)     = unitFV n
 187 hsIdInfoFVs other            = emptyFVs
 188
 189 ----------------
 190 ufExprFVs (UfVar n)       = unitFV n
 191 ufExprFVs (UfLit l)       = emptyFVs
 192 ufExprFVs (UfLitLit l ty) = extractHsTyNames ty
 193 ufExprFVs (UfCCall cc ty) = extractHsTyNames ty
 194 ufExprFVs (UfType ty)     = extractHsTyNames ty
 195 ufExprFVs (UfTuple tc es) = hsTupConFVs tc `plusFV` plusFVs (map ufExprFVs es)
 196 ufExprFVs (UfLam v e)     = ufBndrFVs v (ufExprFVs e)
 197 ufExprFVs (UfApp e1 e2)   = ufExprFVs e1 `plusFV` ufExprFVs e2
 198 ufExprFVs (UfCase e n as) = ufExprFVs e `plusFV` delFV n (plusFVs (map ufAltFVs as))
 199 ufExprFVs (UfNote n e)    = ufNoteFVs n `plusFV` ufExprFVs e
 200 ufExprFVs (UfLet (UfNonRec b r) e) = ufExprFVs r `plusFV` ufBndrFVs b (ufExprFVs e)
 201 ufExprFVs (UfLet (UfRec prs)    e) = foldr ufBndrFVs
 202                                            (foldr (plusFV . ufExprFVs . snd) (ufExprFVs e) prs)
 203                                            (map fst prs)
 204
 205 ufBndrFVs (UfValBinder n ty) fvs = extractHsTyNames ty `plusFV` delFV n fvs
 206 ufBndrFVs (UfTyBinder  n k)  fvs = delFV n fvs
 207
 208 ufAltFVs (con, vs, e) = ufConFVs con `plusFV` delFVs vs (ufExprFVs e)
 209
 210 ufConFVs (UfDataAlt n)      = unitFV n
 211 ufConFVs (UfTupleAlt t)     = hsTupConFVs t
 212 ufConFVs (UfLitLitAlt _ ty) = extractHsTyNames ty
 213 ufConFVs other              = emptyFVs
 214
 215 ufNoteFVs (UfCoerce ty) = extractHsTyNames ty
 216 ufNoteFVs note          = emptyFVs
 217
 218 hsTupConFVs (HsTupCon n _ _) = unitFV n
 219 \end{code}
 220
 221 %************************************************************************
 222 %*                                                                      *
 223 \subsection{A few functions on generic defintions
 224 %*                                                                      *
 225 %************************************************************************
 226
 227 These functions on generics are defined over RenamedMatches, which is
 228 why they are here and not in HsMatches.
 229
 230 \begin{code}
 231 maybeGenericMatch :: RenamedMatch -> Maybe (RenamedHsType, RenamedMatch)
 232   -- Tells whether a Match is for a generic definition
 233   -- and extract the type from a generic match and put it at the front
 234
 235 maybeGenericMatch (Match tvs (TypePatIn ty : pats) sig_ty grhss)
 236   = Just (ty, Match tvs pats sig_ty grhss)
 237
 238 maybeGenericMatch other_match = Nothing
 239 \end{code}