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 IMP_Ubiq()
  12
  13 import HsSyn
  14
  15 import Id               ( isDataCon, 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] [Name]  -- data type   (with constrs and fields)
  36   | RnConstr        Name  Name          -- constructor (with data type)
  37   | RnField         Name  Name          -- field       (with data type)
  38   | RnClass         Name [Name]         -- class       (with class ops)
  39   | RnClassOp       Name  Name          -- class op    (with class)
  40   | RnImplicit      Name                -- implicitly imported
  41   | RnImplicitTyCon Name                -- implicitly imported
  42   | RnImplicitClass Name                -- implicitly imported
  43   | RnUnbound       RdrName             -- place holder
  44
  45 mkRnName          = RnName
  46 mkRnImplicit      = RnImplicit
  47 mkRnImplicitTyCon = RnImplicitTyCon
  48 mkRnImplicitClass = RnImplicitClass
  49 mkRnUnbound       = RnUnbound
  50
  51 isRnWired (WiredInId _)    = True
  52 isRnWired (WiredInTyCon _) = True
  53 isRnWired _                = False
  54
  55 isRnLocal (RnName n) = isLocalName n
  56 isRnLocal _          = False
  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 isRnConstr (RnConstr _ _) = True
  78 isRnConstr (WiredInId id) = isDataCon id
  79 isRnConstr  _             = False
  80
  81 isRnField  (RnField _ _)  = True
  82 isRnField  _              = False
  83
  84 isRnClassOp cls (RnClassOp _ op_cls) = eqUniqsNamed cls op_cls
  85 isRnClassOp cls n                    = pprTrace "isRnClassOp:" (ppr PprShowAll n) $ True -- let it past anyway
  86
  87 isRnImplicit (RnImplicit _)      = True
  88 isRnImplicit (RnImplicitTyCon _) = True
  89 isRnImplicit (RnImplicitClass _) = True
  90 isRnImplicit _                   = False
  91
  92 isRnUnbound (RnUnbound _) = True
  93 isRnUnbound _             = False
  94
  95 -- Very general NamedThing comparison, used when comparing
  96 -- Uniquable things with different types
  97
  98 eqUniqsNamed  n1 n2 = uniqueOf n1  ==   uniqueOf n2
  99 cmpUniqsNamed n1 n2 = uniqueOf n1 `cmp` uniqueOf n2
 100
 101 instance Eq RnName where
 102     a == b = eqUniqsNamed a b
 103
 104 instance Ord3 RnName where
 105     a `cmp` b = cmpUniqsNamed a b
 106
 107 instance Uniquable RnName where
 108     uniqueOf = nameUnique . getName
 109
 110 instance NamedThing RnName where
 111     getName (WiredInId id)      = getName id
 112     getName (WiredInTyCon tc)   = getName tc
 113     getName (RnName n)          = n
 114     getName (RnSyn n)           = n
 115     getName (RnData n _ _)      = n
 116     getName (RnConstr n _)      = n
 117     getName (RnField n _)       = n
 118     getName (RnClass n _)       = n
 119     getName (RnClassOp n _)     = n
 120     getName (RnImplicit n)      = n
 121     getName (RnImplicitTyCon n) = n
 122     getName (RnImplicitClass n) = n
 123     getName (RnUnbound occ)     = pprTrace "getRnName:RnUnbound: " (ppr PprDebug occ)
 124                                   (case occ of
 125                                      Unqual n -> mkLocalName bottom n False bottom2
 126                                      Qual m n -> mkLocalName bottom n False bottom2)
 127                                 where bottom = mkAlphaTyVarUnique 0 -- anything; just something that will print
 128                                       bottom2 = panic "getRnName: srcloc"
 129
 130 instance Outputable RnName where
 131 #ifdef DEBUG
 132     ppr sty@PprShowAll (RnData n cs fs)  = ppBesides [ppr sty n, ppStr "{-", ppr sty cs, ppr sty fs, ppStr "-}"]
 133     ppr sty@PprShowAll (RnConstr n d)    = ppBesides [ppr sty n, ppStr "{-", ppr sty d, ppStr "-}"]
 134     ppr sty@PprShowAll (RnField  n d)    = ppBesides [ppr sty n, ppStr "{-", ppr sty d, ppStr "-}"]
 135     ppr sty@PprShowAll (RnClass n ops)   = ppBesides [ppr sty n, ppStr "{-", ppr sty ops, ppStr "-}"]
 136     ppr sty@PprShowAll (RnClassOp n c)   = ppBesides [ppr sty n, ppStr "{-", ppr sty c, ppStr "-}"]
 137 #endif
 138     ppr sty (WiredInId id)      = ppr sty id
 139     ppr sty (WiredInTyCon tycon)= ppr sty tycon
 140     ppr sty (RnUnbound occ)     = ppBeside (ppr sty occ) (ppPStr SLIT("{-UNBOUND-}"))
 141     ppr sty rn_name             = ppr sty (getName rn_name)
 142 \end{code}
 143
 144 \begin{code}
 145 type RenamedArithSeqInfo        = ArithSeqInfo          Fake Fake RnName RenamedPat
 146 type RenamedBind                = Bind                  Fake Fake RnName RenamedPat
 147 type RenamedClassDecl           = ClassDecl             Fake Fake RnName RenamedPat
 148 type RenamedClassOpSig          = Sig                   RnName
 149 type RenamedConDecl             = ConDecl               RnName
 150 type RenamedContext             = Context               RnName
 151 type RenamedSpecDataSig         = SpecDataSig           RnName
 152 type RenamedDefaultDecl         = DefaultDecl           RnName
 153 type RenamedFixityDecl          = FixityDecl            RnName
 154 type RenamedGRHS                = GRHS                  Fake Fake RnName RenamedPat
 155 type RenamedGRHSsAndBinds       = GRHSsAndBinds         Fake Fake RnName RenamedPat
 156 type RenamedHsBinds             = HsBinds               Fake Fake RnName RenamedPat
 157 type RenamedHsExpr              = HsExpr                Fake Fake RnName RenamedPat
 158 type RenamedHsModule            = HsModule              Fake Fake RnName RenamedPat
 159 type RenamedInstDecl            = InstDecl              Fake Fake RnName RenamedPat
 160 type RenamedMatch               = Match                 Fake Fake RnName RenamedPat
 161 type RenamedMonoBinds           = MonoBinds             Fake Fake RnName RenamedPat
 162 type RenamedMonoType            = MonoType              RnName
 163 type RenamedPat                 = InPat                 RnName
 164 type RenamedPolyType            = PolyType              RnName
 165 type RenamedRecordBinds         = HsRecordBinds         Fake Fake RnName RenamedPat
 166 type RenamedQual                = Qualifier             Fake Fake RnName RenamedPat
 167 type RenamedSig                 = Sig                   RnName
 168 type RenamedSpecInstSig         = SpecInstSig           RnName
 169 type RenamedStmt                = Stmt                  Fake Fake RnName RenamedPat
 170 type RenamedTyDecl              = TyDecl                RnName
 171
 172 type RenamedClassOpPragmas      = ClassOpPragmas        RnName
 173 type RenamedClassPragmas        = ClassPragmas          RnName
 174 type RenamedDataPragmas         = DataPragmas           RnName
 175 type RenamedGenPragmas          = GenPragmas            RnName
 176 type RenamedInstancePragmas     = InstancePragmas       RnName
 177 \end{code}
 178
 179 \begin{code}
 180 collectQualBinders :: [RenamedQual] -> [RnName]
 181
 182 collectQualBinders quals
 183   = concat (map collect quals)
 184   where
 185     collect (GeneratorQual pat _) = collectPatBinders pat
 186     collect (FilterQual expr)     = []
 187     collect (LetQual    binds)    = collectTopLevelBinders binds
 188
 189 fixDeclName :: FixityDecl name -> name
 190 fixDeclName (InfixL name i) = name
 191 fixDeclName (InfixR name i) = name
 192 fixDeclName (InfixN name i) = name
 193 \end{code}
 194