ghc/compiler/rename/RnHsSyn.lhs

   1 %
   2 % (c) The AQUA Project, Glasgow University, 1996
   3 %
   4 \section[RnHsSyn]{Specialisations of the @HsSyn@ syntax for the renamer}
   5
   6 \begin{code}
   7 #include "HsVersions.h"
   8
   9 module RnHsSyn where
  10
  11 import Ubiq
  12
  13 import HsSyn
  14
  15 import Id               ( GenId, Id(..) )
  16 import Name             ( isLocalName, nameUnique, Name, RdrName(..){-ToDo: rm ..-},
  17                           mkLocalName{-ToDo:rm-}
  18                         )
  19 import Outputable       ( Outputable(..){-instance * []-} )
  20 import PprStyle         ( PprStyle(..) )
  21 import PprType          ( GenType, GenTyVar, TyCon )
  22 import Pretty
  23 import TyCon            ( TyCon )
  24 import TyVar            ( GenTyVar )
  25 import Unique           ( mkAlphaTyVarUnique, Unique )
  26 import Util             ( panic, pprPanic, pprTrace{-ToDo:rm-} )
  27 \end{code}
  28
  29 \begin{code}
  30 data RnName
  31   = WiredInId       Id
  32   | WiredInTyCon    TyCon
  33   | RnName          Name        -- functions/binders/tyvars
  34   | RnSyn           Name        -- type synonym
  35   | RnData          Name [Name] -- data type   (with constrs)
  36   | RnConstr        Name  Name  -- constructor (with data type)
  37   | RnClass         Name [Name] -- class       (with class ops)
  38   | RnClassOp       Name  Name  -- class op    (with class)
  39   | RnImplicit      Name        -- implicitly imported
  40   | RnImplicitTyCon Name        -- implicitly imported
  41   | RnImplicitClass Name        -- implicitly imported
  42   | RnUnbound       RdrName     -- place holder
  43
  44 mkRnName          = RnName
  45 mkRnImplicit      = RnImplicit
  46 mkRnImplicitTyCon = RnImplicitTyCon
  47 mkRnImplicitClass = RnImplicitClass
  48 mkRnUnbound       = RnUnbound
  49
  50 isRnWired (WiredInId _)    = True
  51 isRnWired (WiredInTyCon _) = True
  52 isRnWired _                = False
  53
  54 isRnLocal (RnName n) = isLocalName n
  55 isRnLocal _          = False
  56
  57
  58 isRnTyCon (WiredInTyCon _)    = True
  59 isRnTyCon (RnSyn _)           = True
  60 isRnTyCon (RnData _ _)        = True
  61 isRnTyCon (RnImplicitTyCon _) = True
  62 isRnTyCon _                   = False
  63
  64 isRnClass (RnClass _ _)       = True
  65 isRnClass (RnImplicitClass _) = True
  66 isRnClass _                   = False
  67
  68 -- a common need: isRnTyCon || isRnClass:
  69 isRnTyConOrClass (WiredInTyCon _)    = True
  70 isRnTyConOrClass (RnSyn _)           = True
  71 isRnTyConOrClass (RnData _ _)        = True
  72 isRnTyConOrClass (RnImplicitTyCon _) = True
  73 isRnTyConOrClass (RnClass _ _)       = True
  74 isRnTyConOrClass (RnImplicitClass _) = True
  75 isRnTyConOrClass _                   = False
  76
  77 isRnClassOp cls (RnClassOp _ op_cls) = eqUniqsNamed cls op_cls
  78 isRnClassOp cls (RnImplicit _)       = True     -- ho hummm ...
  79 isRnClassOp cls _                    = False
  80
  81 isRnImplicit (RnImplicit _)      = True
  82 isRnImplicit (RnImplicitTyCon _) = True
  83 isRnImplicit (RnImplicitClass _) = True
  84 isRnImplicit _                   = False
  85
  86 isRnUnbound (RnUnbound _) = True
  87 isRnUnbound _             = False
  88
  89 -- Very general NamedThing comparison, used when comparing
  90 -- Uniquable things with different types
  91
  92 eqUniqsNamed  n1 n2 = uniqueOf n1  ==   uniqueOf n2
  93 cmpUniqsNamed n1 n2 = uniqueOf n1 `cmp` uniqueOf n2
  94
  95 instance Eq RnName where
  96     a == b = eqUniqsNamed a b
  97
  98 instance Ord3 RnName where
  99     a `cmp` b = cmpUniqsNamed a b
 100
 101 instance Uniquable RnName where
 102     uniqueOf = nameUnique . getName
 103
 104 instance NamedThing RnName where
 105     getName (WiredInId id)      = getName id
 106     getName (WiredInTyCon tc)   = getName tc
 107     getName (RnName n)          = n
 108     getName (RnSyn n)           = n
 109     getName (RnData n _)        = n
 110     getName (RnConstr n _)      = n
 111     getName (RnClass n _)       = n
 112     getName (RnClassOp n _)     = n
 113     getName (RnImplicit n)      = n
 114     getName (RnImplicitTyCon n) = n
 115     getName (RnImplicitClass n) = n
 116     getName (RnUnbound occ)     = pprTrace "getRnName:RnUnbound: " (ppr PprDebug occ)
 117                                   (case occ of
 118                                      Unqual n -> mkLocalName bottom n bottom2
 119                                      Qual m n -> mkLocalName bottom n bottom2)
 120                                 where bottom = mkAlphaTyVarUnique 0 -- anything; just something that will print
 121                                       bottom2 = panic "getRnName: srcloc"
 122
 123 instance Outputable RnName where
 124 #ifdef DEBUG
 125     ppr sty@PprShowAll (RnData n cs)   = ppBesides [ppr sty n, ppStr "{-", ppr sty cs, ppStr "-}"]
 126     ppr sty@PprShowAll (RnConstr n d)  = ppBesides [ppr sty n, ppStr "{-", ppr sty d, ppStr "-}"]
 127     ppr sty@PprShowAll (RnClass n ops) = ppBesides [ppr sty n, ppStr "{-", ppr sty ops, ppStr "-}"]
 128     ppr sty@PprShowAll (RnClassOp n c) = ppBesides [ppr sty n, ppStr "{-", ppr sty c, ppStr "-}"]
 129 #endif
 130     ppr sty (WiredInId id)      = ppr sty id
 131     ppr sty (WiredInTyCon tycon)= ppr sty tycon
 132     ppr sty (RnUnbound occ)     = ppBeside (ppr sty occ) (ppPStr SLIT("{-UNBOUND-}"))
 133     ppr sty rn_name             = ppr sty (getName rn_name)
 134 \end{code}
 135
 136 \begin{code}
 137 type RenamedArithSeqInfo        = ArithSeqInfo          Fake Fake RnName RenamedPat
 138 type RenamedBind                = Bind                  Fake Fake RnName RenamedPat
 139 type RenamedClassDecl           = ClassDecl             Fake Fake RnName RenamedPat
 140 type RenamedClassOpSig          = Sig                   RnName
 141 type RenamedConDecl             = ConDecl               RnName
 142 type RenamedContext             = Context               RnName
 143 type RenamedSpecDataSig         = SpecDataSig           RnName
 144 type RenamedDefaultDecl         = DefaultDecl           RnName
 145 type RenamedFixityDecl          = FixityDecl            RnName
 146 type RenamedGRHS                = GRHS                  Fake Fake RnName RenamedPat
 147 type RenamedGRHSsAndBinds       = GRHSsAndBinds         Fake Fake RnName RenamedPat
 148 type RenamedHsBinds             = HsBinds               Fake Fake RnName RenamedPat
 149 type RenamedHsExpr              = HsExpr                Fake Fake RnName RenamedPat
 150 type RenamedHsModule            = HsModule              Fake Fake RnName RenamedPat
 151 type RenamedInstDecl            = InstDecl              Fake Fake RnName RenamedPat
 152 type RenamedMatch               = Match                 Fake Fake RnName RenamedPat
 153 type RenamedMonoBinds           = MonoBinds             Fake Fake RnName RenamedPat
 154 type RenamedMonoType            = MonoType              RnName
 155 type RenamedPat                 = InPat                 RnName
 156 type RenamedPolyType            = PolyType              RnName
 157 type RenamedRecordBinds         = HsRecordBinds         Fake Fake RnName RenamedPat
 158 type RenamedQual                = Qual                  Fake Fake RnName RenamedPat
 159 type RenamedSig                 = Sig                   RnName
 160 type RenamedSpecInstSig         = SpecInstSig           RnName
 161 type RenamedStmt                = Stmt                  Fake Fake RnName RenamedPat
 162 type RenamedTyDecl              = TyDecl                RnName
 163
 164 type RenamedClassOpPragmas      = ClassOpPragmas        RnName
 165 type RenamedClassPragmas        = ClassPragmas          RnName
 166 type RenamedDataPragmas         = DataPragmas           RnName
 167 type RenamedGenPragmas          = GenPragmas            RnName
 168 type RenamedInstancePragmas     = InstancePragmas       RnName
 169 \end{code}
 170
 171 \begin{code}
 172 collectQualBinders :: [RenamedQual] -> [RnName]
 173
 174 collectQualBinders quals
 175   = concat (map collect quals)
 176   where
 177     collect (GeneratorQual pat _) = collectPatBinders pat
 178     collect (FilterQual expr)     = []
 179     collect (LetQual    binds)    = collectTopLevelBinders binds
 180 \end{code}
 181