[project @ 2005-10-14 11:22:41 by simonpj]
[ghc-hetmet.git] / ghc / compiler / rename / RnHsSyn.lhs
index 7f4b74b..6ce0379 100644 (file)
 %
-% (c) The AQUA Project, Glasgow University, 1996
+% (c) The AQUA Project, Glasgow University, 1996-1998
 %
 \section[RnHsSyn]{Specialisations of the @HsSyn@ syntax for the renamer}
 
 \begin{code}
-#include "HsVersions.h"
-
-module RnHsSyn where
+module RnHsSyn( 
+       -- Names
+       charTyCon_name, listTyCon_name, parrTyCon_name, tupleTyCon_name,
+       extractHsTyVars, extractHsTyNames, extractHsTyNames_s, 
+       extractFunDepNames, extractHsCtxtTyNames, extractHsPredTyNames,
+
+       -- Free variables
+       hsSigsFVs, hsSigFVs, conDeclFVs, bangTyFVs,
+       
+       maybeGenericMatch
+  ) where
 
-import Ubiq
+#include "HsVersions.h"
 
 import HsSyn
-
-import Id              ( GenId, Id(..) )
-import Name            ( isLocalName, nameUnique, Name, RdrName )
-import Outputable      ( Outputable(..){-instance * []-} )
-import PprStyle                ( PprStyle(..) )
-import PprType         ( GenType, GenTyVar, TyCon )
-import Pretty
-import TyCon           ( TyCon )
-import TyVar           ( GenTyVar )
-import Unique          ( Unique )
-import Util            ( panic, pprPanic )
+import Class           ( FunDep )
+import TysWiredIn      ( tupleTyCon, listTyCon, parrTyCon, charTyCon )
+import Name            ( Name, getName, isTyVarName )
+import NameSet
+import BasicTypes      ( Boxity )
+import SrcLoc          ( Located(..), unLoc )
 \end{code}
 
+%************************************************************************
+%*                                                                     *
+\subsection{Free variables}
+%*                                                                     *
+%************************************************************************
+
+These free-variable finders returns tycons and classes too.
+
 \begin{code}
-data RnName
-  = WiredInId       Id
-  | WiredInTyCon    TyCon
-  | RnName          Name        -- funtions/binders/tyvars
-  | RnSyn           Name        -- type synonym
-  | RnData          Name [Name] -- data type   (with constrs)
-  | RnConstr        Name  Name  -- constructor (with data type)
-  | RnClass         Name [Name] -- class       (with class ops)
-  | RnClassOp       Name  Name  -- class op    (with class)
-  | RnImplicit      Name       -- implicitly imported
-  | RnImplicitTyCon Name       -- implicitly imported
-  | RnImplicitClass Name       -- implicitly imported
-  | RnUnbound      RdrName     -- place holder
-
-mkRnName          = RnName
-mkRnImplicit      = RnImplicit
-mkRnImplicitTyCon = RnImplicitTyCon
-mkRnImplicitClass = RnImplicitClass
-mkRnUnbound       = RnUnbound
-
-isRnWired (WiredInId _)    = True
-isRnWired (WiredInTyCon _) = True
-isRnWired _               = False
-
-isRnLocal (RnName n) = isLocalName n
-isRnLocal _         = False
-
-
-isRnTyCon (WiredInTyCon _)    = True
-isRnTyCon (RnSyn _)                  = True
-isRnTyCon (RnData _ _)               = True
-isRnTyCon (RnImplicitTyCon _) = True
-isRnTyCon _                          = False
-
-isRnClass (RnClass _ _)       = True
-isRnClass (RnImplicitClass _) = True
-isRnClass _                   = False
-
-isRnClassOp cls (RnClassOp _ op_cls) = eqUniqsNamed cls op_cls
-isRnClassOp cls (RnImplicit _)      = True     -- ho hummm ...
-isRnClassOp cls _                   = False
-
-isRnImplicit (RnImplicit _)      = True
-isRnImplicit (RnImplicitTyCon _) = True
-isRnImplicit (RnImplicitClass _) = True
-isRnImplicit _                  = False
-
-isRnUnbound (RnUnbound _) = True
-isRnUnbound _            = False
-
--- Very general NamedThing comparison, used when comparing
--- Uniquable things with different types
-
-eqUniqsNamed  n1 n2 = uniqueOf n1  ==   uniqueOf n2
-cmpUniqsNamed n1 n2 = uniqueOf n1 `cmp` uniqueOf n2
-
-instance Eq RnName where
-    a == b = eqUniqsNamed a b
-
-instance Ord3 RnName where
-    a `cmp` b = cmpUniqsNamed a b
-
-instance Uniquable RnName where
-    uniqueOf = nameUnique . getName
-
-instance NamedThing RnName where
-    getName (WiredInId id)    = getName id
-    getName (WiredInTyCon tc) = getName tc
-    getName (RnName n)       = n
-    getName (RnSyn n)        = n
-    getName (RnData n _)      = n
-    getName (RnConstr n _)    = n
-    getName (RnClass n _)     = n
-    getName (RnClassOp n _)   = n
-    getName (RnImplicit n)    = n
-    getName (RnUnbound occ)   = pprPanic "getRnName:RnUnbound" (ppr PprDebug occ)
-
-instance Outputable RnName where
-#ifdef DEBUG
-    ppr sty@PprShowAll (RnData n cs)   = ppBesides [ppr sty n, ppStr "{-", ppr sty cs, ppStr "-}"]
-    ppr sty@PprShowAll (RnConstr n d)  = ppBesides [ppr sty n, ppStr "{-", ppr sty d, ppStr "-}"]
-    ppr sty@PprShowAll (RnClass n ops) = ppBesides [ppr sty n, ppStr "{-", ppr sty ops, ppStr "-}"]
-    ppr sty@PprShowAll (RnClassOp n c) = ppBesides [ppr sty n, ppStr "{-", ppr sty c, ppStr "-}"]
-#endif
-    ppr sty (WiredInId id)      = ppr sty id
-    ppr sty (WiredInTyCon tycon)= ppr sty tycon
-    ppr sty (RnUnbound occ)    = ppBeside (ppr sty occ) (ppPStr SLIT("{-UNBOUND-}"))
-    ppr sty rn_name            = ppr sty (getName rn_name)
+charTyCon_name, listTyCon_name, parrTyCon_name :: Name
+charTyCon_name    = getName charTyCon
+listTyCon_name    = getName listTyCon
+parrTyCon_name    = getName parrTyCon
+
+tupleTyCon_name :: Boxity -> Int -> Name
+tupleTyCon_name boxity n = getName (tupleTyCon boxity n)
+
+extractHsTyVars :: LHsType Name -> NameSet
+extractHsTyVars x = filterNameSet isTyVarName (extractHsTyNames x)
+
+extractFunDepNames :: FunDep Name -> NameSet
+extractFunDepNames (ns1, ns2) = mkNameSet ns1 `unionNameSets` mkNameSet ns2
+
+extractHsTyNames   :: LHsType Name -> NameSet
+extractHsTyNames ty
+  = getl ty
+  where
+    getl (L _ ty) = get ty
+
+    get (HsAppTy ty1 ty2)      = getl ty1 `unionNameSets` getl ty2
+    get (HsListTy ty)          = unitNameSet listTyCon_name `unionNameSets` getl ty
+    get (HsPArrTy ty)          = unitNameSet parrTyCon_name `unionNameSets` getl ty
+    get (HsTupleTy con tys)    = extractHsTyNames_s tys
+    get (HsFunTy ty1 ty2)      = getl ty1 `unionNameSets` getl ty2
+    get (HsPredTy p)          = extractHsPredTyNames p
+    get (HsOpTy ty1 op ty2)    = getl ty1 `unionNameSets` getl ty2 `unionNameSets` unitNameSet (unLoc op)
+    get (HsParTy ty)           = getl ty
+    get (HsBangTy _ ty)        = getl ty
+    get (HsNumTy n)            = emptyNameSet
+    get (HsTyVar tv)          = unitNameSet tv
+    get (HsSpliceTy _)         = emptyNameSet  -- Type splices mention no type variables
+    get (HsKindSig ty k)       = getl ty
+    get (HsForAllTy _ tvs 
+                   ctxt ty)   = (extractHsCtxtTyNames ctxt
+                                        `unionNameSets` getl ty)
+                                           `minusNameSet`
+                                 mkNameSet (hsLTyVarNames tvs)
+
+extractHsTyNames_s  :: [LHsType Name] -> NameSet
+extractHsTyNames_s tys = foldr (unionNameSets . extractHsTyNames) emptyNameSet tys
+
+extractHsCtxtTyNames :: LHsContext Name -> NameSet
+extractHsCtxtTyNames (L _ ctxt)
+  = foldr (unionNameSets . extractHsPredTyNames . unLoc) emptyNameSet ctxt
+
+-- You don't import or export implicit parameters,
+-- so don't mention the IP names
+extractHsPredTyNames (HsClassP cls tys)
+  = unitNameSet cls `unionNameSets` extractHsTyNames_s tys
+extractHsPredTyNames (HsIParam n ty)
+  = extractHsTyNames ty
 \end{code}
 
+
+%************************************************************************
+%*                                                                     *
+\subsection{Free variables of declarations}
+%*                                                                     *
+%************************************************************************
+
+Return the Names that must be in scope if we are to use this declaration.
+In all cases this is set up for interface-file declarations:
+       - for class decls we ignore the bindings
+       - for instance decls likewise, plus the pragmas
+       - for rule decls, we ignore HsRules
+        - for data decls, we ignore derivings
+
+       *** See "THE NAMING STORY" in HsDecls ****
+
 \begin{code}
-type RenamedArithSeqInfo       = ArithSeqInfo          Fake Fake RnName RenamedPat
-type RenamedBind               = Bind                  Fake Fake RnName RenamedPat
-type RenamedClassDecl          = ClassDecl             Fake Fake RnName RenamedPat
-type RenamedClassOpSig         = Sig                   RnName
-type RenamedConDecl            = ConDecl               RnName
-type RenamedContext            = Context               RnName
-type RenamedSpecDataSig                = SpecDataSig           RnName
-type RenamedDefaultDecl                = DefaultDecl           RnName
-type RenamedFixityDecl         = FixityDecl            RnName
-type RenamedGRHS               = GRHS                  Fake Fake RnName RenamedPat
-type RenamedGRHSsAndBinds      = GRHSsAndBinds         Fake Fake RnName RenamedPat
-type RenamedHsBinds            = HsBinds               Fake Fake RnName RenamedPat
-type RenamedHsExpr             = HsExpr                Fake Fake RnName RenamedPat
-type RenamedHsModule           = HsModule              Fake Fake RnName RenamedPat
-type RenamedInstDecl           = InstDecl              Fake Fake RnName RenamedPat
-type RenamedMatch              = Match                 Fake Fake RnName RenamedPat
-type RenamedMonoBinds          = MonoBinds             Fake Fake RnName RenamedPat
-type RenamedMonoType           = MonoType              RnName
-type RenamedPat                        = InPat                 RnName
-type RenamedPolyType           = PolyType              RnName
-type RenamedRecordBinds                = HsRecordBinds         Fake Fake RnName RenamedPat
-type RenamedQual               = Qual                  Fake Fake RnName RenamedPat
-type RenamedSig                        = Sig                   RnName
-type RenamedSpecInstSig                = SpecInstSig           RnName
-type RenamedStmt               = Stmt                  Fake Fake RnName RenamedPat
-type RenamedTyDecl             = TyDecl                RnName
-
-type RenamedClassOpPragmas     = ClassOpPragmas        RnName
-type RenamedClassPragmas       = ClassPragmas          RnName
-type RenamedDataPragmas                = DataPragmas           RnName
-type RenamedGenPragmas         = GenPragmas            RnName
-type RenamedInstancePragmas    = InstancePragmas       RnName
+----------------
+hsSigsFVs :: [LSig Name] -> FreeVars
+hsSigsFVs sigs = plusFVs (map (hsSigFVs.unLoc) sigs)
+
+hsSigFVs (Sig v ty)        = extractHsTyNames ty
+hsSigFVs (SpecInstSig ty)   = extractHsTyNames ty
+hsSigFVs (SpecSig v ty)     = extractHsTyNames ty
+hsSigFVs other             = emptyFVs
+
+----------------
+-- XXX - autrijus - handle return type for GADT
+conDeclFVs (L _ (ConDecl _ _ tyvars context details _))
+  = delFVs (map hsLTyVarName tyvars) $
+    extractHsCtxtTyNames context         `plusFV`
+    conDetailsFVs details
+
+{-
+-- gaw 2004
+conDeclFVs (L _ (GadtDecl _ ty)) 
+  = extractHsTyNames ty
+-}
+
+conDetailsFVs (PrefixCon btys)     = plusFVs (map bangTyFVs btys)
+conDetailsFVs (InfixCon bty1 bty2) = bangTyFVs bty1 `plusFV` bangTyFVs bty2
+conDetailsFVs (RecCon flds)       = plusFVs [bangTyFVs bty | (_, bty) <- flds]
+
+bangTyFVs bty = extractHsTyNames (getBangType bty)
 \end{code}
 
+
+%************************************************************************
+%*                                                                     *
+\subsection{A few functions on generic defintions
+%*                                                                     *
+%************************************************************************
+
+These functions on generics are defined over Matches Name, which is
+why they are here and not in HsMatches.
+
 \begin{code}
-collectQualBinders :: [RenamedQual] -> [RnName]
+maybeGenericMatch :: LMatch Name -> Maybe (HsType Name, LMatch Name)
+  -- Tells whether a Match is for a generic definition
+  -- and extract the type from a generic match and put it at the front
 
-collectQualBinders quals
-  = concat (map collect quals)
-  where
-    collect (GeneratorQual pat _) = collectPatBinders pat
-    collect (FilterQual expr)    = []
-    collect (LetQual    binds)   = collectTopLevelBinders binds
-\end{code}
+maybeGenericMatch (L loc (Match (L _ (TypePat (L _ ty)) : pats) sig_ty grhss))
+  = Just (ty, L loc (Match pats sig_ty grhss))
 
+maybeGenericMatch other_match = Nothing
+\end{code}