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 \end{code}
  50
  51 %************************************************************************
  52 %*                                                                      *
  53 \subsection{Free variables}
  54 %*                                                                      *
  55 %************************************************************************
  56
  57 These free-variable finders returns tycons and classes too.
  58
  59 \begin{code}
  60 charTyCon_name, listTyCon_name :: Name
  61 charTyCon_name    = getName charTyCon
  62 listTyCon_name    = getName listTyCon
  63
  64 tupleTyCon_name :: Boxity -> Int -> Name
  65 tupleTyCon_name boxity n = getName (tupleTyCon boxity n)
  66
  67 extractHsTyVars :: RenamedHsType -> NameSet
  68 extractHsTyVars x = filterNameSet isTyVarName (extractHsTyNames x)
  69
  70 extractFunDepNames :: FunDep Name -> NameSet
  71 extractFunDepNames (ns1, ns2) = mkNameSet ns1 `unionNameSets` mkNameSet ns2
  72
  73 extractHsTyNames   :: RenamedHsType -> NameSet
  74 extractHsTyNames ty
  75   = get ty
  76   where
  77     get (HsAppTy ty1 ty2)      = get ty1 `unionNameSets` get ty2
  78     get (HsListTy ty)          = unitNameSet listTyCon_name `unionNameSets` get ty
  79     get (HsTupleTy con tys)    = hsTupConFVs con `unionNameSets` extractHsTyNames_s tys
  80     get (HsFunTy ty1 ty2)      = get ty1 `unionNameSets` get ty2
  81     get (HsPredTy p)           = extractHsPredTyNames p
  82     get (HsOpTy ty1 tycon ty2) = get ty1 `unionNameSets` get ty2 `unionNameSets`
  83                                  unitNameSet tycon
  84     get (HsNumTy n)            = emptyNameSet
  85     get (HsTyVar tv)           = unitNameSet tv
  86     get (HsForAllTy (Just tvs)
  87                     ctxt ty)   = (extractHsCtxtTyNames ctxt `unionNameSets` get ty)
  88                                             `minusNameSet`
  89                                   mkNameSet (hsTyVarNames tvs)
  90     get ty@(HsForAllTy Nothing _ _) = pprPanic "extractHsTyNames" (ppr ty)
  91
  92 extractHsTyNames_s  :: [RenamedHsType] -> NameSet
  93 extractHsTyNames_s tys = foldr (unionNameSets . extractHsTyNames) emptyNameSet tys
  94
  95 extractHsCtxtTyNames :: RenamedContext -> NameSet
  96 extractHsCtxtTyNames ctxt = foldr (unionNameSets . extractHsPredTyNames) emptyNameSet ctxt
  97
  98 -- You don't import or export implicit parameters,
  99 -- so don't mention the IP names
 100 extractHsPredTyNames (HsClassP cls tys)
 101   = unitNameSet cls `unionNameSets` extractHsTyNames_s tys
 102 extractHsPredTyNames (HsIParam n ty)
 103   = extractHsTyNames ty
 104 \end{code}
 105
 106
 107 %************************************************************************
 108 %*                                                                      *
 109 \subsection{Free variables of declarations}
 110 %*                                                                      *
 111 %************************************************************************
 112
 113 Return the Names that must be in scope if we are to use this declaration.
 114 In all cases this is set up for interface-file declarations:
 115         - for class decls we ignore the bindings
 116         - for instance decls likewise, plus the pragmas
 117         - for rule decls, we ignore HsRules
 118
 119         *** See "THE NAMING STORY" in HsDecls ****
 120
 121 \begin{code}
 122 tyClDeclFVs :: RenamedTyClDecl -> NameSet
 123 tyClDeclFVs (IfaceSig {tcdType = ty, tcdIdInfo = id_infos})
 124   = extractHsTyNames ty                 `plusFV`
 125     plusFVs (map hsIdInfoFVs id_infos)
 126
 127 tyClDeclFVs (TyData {tcdCtxt = context, tcdTyVars = tyvars, tcdCons = condecls, tcdDerivs = derivings})
 128   = delFVs (map hsTyVarName tyvars) $
 129     extractHsCtxtTyNames context        `plusFV`
 130     plusFVs (map conDeclFVs condecls)   `plusFV`
 131     mkNameSet (derivings `orElse` [])
 132
 133 tyClDeclFVs (TySynonym {tcdTyVars = tyvars, tcdSynRhs = ty})
 134   = delFVs (map hsTyVarName tyvars) (extractHsTyNames ty)
 135
 136 tyClDeclFVs (ClassDecl {tcdCtxt = context, tcdTyVars = tyvars, tcdFDs = fds,
 137                         tcdSigs = sigs, tcdMeths = maybe_meths})
 138   = delFVs (map hsTyVarName tyvars) $
 139     extractHsCtxtTyNames context          `plusFV`
 140     plusFVs (map extractFunDepNames fds)  `plusFV`
 141     hsSigsFVs sigs                        `plusFV`
 142     dm_fvs
 143   where
 144     dm_fvs = case maybe_meths of
 145                 Nothing -> mkFVs [v | ClassOpSig _ (DefMeth v) _ _ <- sigs]
 146                   -- No method bindings, so this class decl comes from an interface file,
 147                   -- So we want to treat the default-method names as free (they should
 148                   -- be defined somewhere else).  [In source code this is not so; the class
 149                   -- decl will bind whatever default-methods are necessary.]
 150                 Just _ -> emptyFVs      -- Source code, so the default methods
 151                                         -- are *bound* not *free*
 152
 153 ----------------
 154 hsSigsFVs sigs = plusFVs (map hsSigFVs sigs)
 155
 156 hsSigFVs (Sig v ty _)       = extractHsTyNames ty
 157 hsSigFVs (SpecInstSig ty _) = extractHsTyNames ty
 158 hsSigFVs (SpecSig v ty _)   = extractHsTyNames ty
 159 hsSigFVs (ClassOpSig _ _ ty _) = extractHsTyNames ty
 160 hsSigFVs other              = emptyFVs
 161
 162 ----------------
 163 instDeclFVs (InstDecl inst_ty _ _ maybe_dfun _)
 164   = extractHsTyNames inst_ty    `plusFV`
 165     (case maybe_dfun of { Just n -> unitFV n; Nothing -> emptyFVs })
 166
 167 ----------------
 168 ruleDeclFVs (HsRule _ _ _ _ _ _) = emptyFVs
 169 ruleDeclFVs (IfaceRule _ vars _ args rhs _)
 170   = delFVs (map ufBinderName vars) $
 171     ufExprFVs rhs `plusFV` plusFVs (map ufExprFVs args)
 172
 173 ----------------
 174 conDeclFVs (ConDecl _ _ tyvars context details _)
 175   = delFVs (map hsTyVarName tyvars) $
 176     extractHsCtxtTyNames context          `plusFV`
 177     conDetailsFVs details
 178
 179 conDetailsFVs (VanillaCon btys)    = plusFVs (map bangTyFVs btys)
 180 conDetailsFVs (InfixCon bty1 bty2) = bangTyFVs bty1 `plusFV` bangTyFVs bty2
 181 conDetailsFVs (RecCon flds)        = plusFVs [bangTyFVs bty | (_, bty) <- flds]
 182
 183 bangTyFVs bty = extractHsTyNames (getBangType bty)
 184
 185 ----------------
 186 hsIdInfoFVs (HsUnfold _ unf) = ufExprFVs unf
 187 hsIdInfoFVs (HsWorker n a)   = unitFV n
 188 hsIdInfoFVs other            = emptyFVs
 189
 190 ----------------
 191 ufExprFVs (UfVar n)       = unitFV n
 192 ufExprFVs (UfLit l)       = emptyFVs
 193 ufExprFVs (UfLitLit l ty) = extractHsTyNames ty
 194 ufExprFVs (UfCCall cc ty) = extractHsTyNames ty
 195 ufExprFVs (UfType ty)     = extractHsTyNames ty
 196 ufExprFVs (UfTuple tc es) = hsTupConFVs tc `plusFV` plusFVs (map ufExprFVs es)
 197 ufExprFVs (UfLam v e)     = ufBndrFVs v (ufExprFVs e)
 198 ufExprFVs (UfApp e1 e2)   = ufExprFVs e1 `plusFV` ufExprFVs e2
 199 ufExprFVs (UfCase e n as) = ufExprFVs e `plusFV` delFV n (plusFVs (map ufAltFVs as))
 200 ufExprFVs (UfNote n e)    = ufNoteFVs n `plusFV` ufExprFVs e
 201 ufExprFVs (UfLet (UfNonRec b r) e) = ufExprFVs r `plusFV` ufBndrFVs b (ufExprFVs e)
 202 ufExprFVs (UfLet (UfRec prs)    e) = foldr ufBndrFVs
 203                                            (foldr (plusFV . ufExprFVs . snd) (ufExprFVs e) prs)
 204                                            (map fst prs)
 205
 206 ufBndrFVs (UfValBinder n ty) fvs = extractHsTyNames ty `plusFV` delFV n fvs
 207 ufBndrFVs (UfTyBinder  n k)  fvs = delFV n fvs
 208
 209 ufAltFVs (con, vs, e) = ufConFVs con `plusFV` delFVs vs (ufExprFVs e)
 210
 211 ufConFVs (UfDataAlt n)      = unitFV n
 212 ufConFVs (UfTupleAlt t)     = hsTupConFVs t
 213 ufConFVs (UfLitLitAlt _ ty) = extractHsTyNames ty
 214 ufConFVs other              = emptyFVs
 215
 216 ufNoteFVs (UfCoerce ty) = extractHsTyNames ty
 217 ufNoteFVs note          = emptyFVs
 218
 219 hsTupConFVs (HsTupCon n _ _) = unitFV n
 220 \end{code}
 221
 222 %************************************************************************
 223 %*                                                                      *
 224 \subsection{A few functions on generic defintions
 225 %*                                                                      *
 226 %************************************************************************
 227
 228 These functions on generics are defined over RenamedMatches, which is
 229 why they are here and not in HsMatches.
 230
 231 \begin{code}
 232 maybeGenericMatch :: RenamedMatch -> Maybe (RenamedHsType, RenamedMatch)
 233   -- Tells whether a Match is for a generic definition
 234   -- and extract the type from a generic match and put it at the front
 235
 236 maybeGenericMatch (Match tvs (TypePatIn ty : pats) sig_ty grhss)
 237   = Just (ty, Match tvs pats sig_ty grhss)
 238
 239 maybeGenericMatch other_match = Nothing
 240 \end{code}