ghc/compiler/basicTypes/RdrName.lhs

   1
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4
   5 \section[RdrName]{@RdrName@}
   6
   7 \begin{code}
   8 module RdrName (
   9         RdrName,
  10
  11         -- Construction
  12         mkRdrUnqual, mkRdrQual,
  13         mkSrcUnqual, mkSrcQual,
  14         mkSysUnqual, mkSysQual,
  15         mkPreludeQual, qualifyRdrName,
  16         dummyRdrVarName, dummyRdrTcName,
  17
  18         -- Destruction
  19         rdrNameModule, rdrNameOcc, setRdrNameOcc,
  20         isRdrDataCon, isRdrTyVar, isQual, isUnqual
  21   ) where
  22
  23 #include "HsVersions.h"
  24
  25 import OccName  ( NameSpace, tcName,
  26                   OccName,
  27                   mkSysOccFS,
  28                   mkSrcOccFS, mkSrcVarOcc,
  29                   isDataOcc, isTvOcc
  30                 )
  31 import Module   ( ModuleName, pprModuleName,
  32                   mkSysModuleFS, mkSrcModuleFS
  33                 )
  34 import Outputable
  35 import Util     ( thenCmp )
  36 \end{code}
  37
  38
  39 %************************************************************************
  40 %*                                                                      *
  41 \subsection{The main data type}
  42 %*                                                                      *
  43 %************************************************************************
  44
  45 \begin{code}
  46 data RdrName = RdrName Qual OccName
  47
  48 data Qual = Unqual
  49           | Qual ModuleName     -- The (encoded) module name
  50 \end{code}
  51
  52
  53 %************************************************************************
  54 %*                                                                      *
  55 \subsection{Simple functions}
  56 %*                                                                      *
  57 %************************************************************************
  58
  59 \begin{code}
  60 rdrNameModule :: RdrName -> ModuleName
  61 rdrNameModule (RdrName (Qual m) _) = m
  62
  63 rdrNameOcc :: RdrName -> OccName
  64 rdrNameOcc (RdrName _ occ) = occ
  65
  66 setRdrNameOcc :: RdrName -> OccName -> RdrName
  67 setRdrNameOcc (RdrName q _) occ = RdrName q occ
  68 \end{code}
  69
  70 \begin{code}
  71         -- These two are the basic constructors
  72 mkRdrUnqual :: OccName -> RdrName
  73 mkRdrUnqual occ = RdrName Unqual occ
  74
  75 mkRdrQual :: ModuleName -> OccName -> RdrName
  76 mkRdrQual mod occ = RdrName (Qual mod) occ
  77
  78         -- These two are used when parsing source files
  79         -- They do encode the module and occurrence names
  80 mkSrcUnqual :: NameSpace -> FAST_STRING -> RdrName
  81 mkSrcUnqual sp n = RdrName Unqual (mkSrcOccFS sp n)
  82
  83 mkSrcQual :: NameSpace -> FAST_STRING -> FAST_STRING -> RdrName
  84 mkSrcQual sp m n = RdrName (Qual (mkSrcModuleFS m)) (mkSrcOccFS sp n)
  85
  86         -- These two are used when parsing interface files
  87         -- They do not encode the module and occurrence name
  88 mkSysUnqual :: NameSpace -> FAST_STRING -> RdrName
  89 mkSysUnqual sp n = RdrName Unqual (mkSysOccFS sp n)
  90
  91 mkSysQual :: NameSpace -> (FAST_STRING, FAST_STRING) -> RdrName
  92 mkSysQual sp (m,n) = RdrName (Qual (mkSysModuleFS m)) (mkSysOccFS sp n)
  93
  94 mkPreludeQual :: NameSpace -> ModuleName -> FAST_STRING -> RdrName
  95 mkPreludeQual sp mod n = RdrName (Qual mod) (mkSrcOccFS sp n)
  96
  97 qualifyRdrName :: ModuleName -> RdrName -> RdrName
  98         -- Sets the module name of a RdrName, even if it has one already
  99 qualifyRdrName mod (RdrName _ occ) = RdrName (Qual mod) occ
 100 \end{code}
 101
 102 \begin{code}
 103         -- This guy is used by the reader when HsSyn has a slot for
 104         -- an implicit name that's going to be filled in by
 105         -- the renamer.  We can't just put "error..." because
 106         -- we sometimes want to print out stuff after reading but
 107         -- before renaming
 108 dummyRdrVarName = RdrName Unqual (mkSrcVarOcc SLIT("V-DUMMY"))
 109 dummyRdrTcName  = RdrName Unqual (mkSrcOccFS tcName SLIT("TC-DUMMY"))
 110 \end{code}
 111
 112
 113 \begin{code}
 114 isRdrDataCon (RdrName _ occ) = isDataOcc occ
 115 isRdrTyVar   (RdrName _ occ) = isTvOcc occ
 116
 117 isUnqual (RdrName Unqual _) = True
 118 isUnqual other              = False
 119
 120 isQual rdr_name = not (isUnqual rdr_name)
 121 \end{code}
 122
 123
 124 %************************************************************************
 125 %*                                                                      *
 126 \subsection{Instances}
 127 %*                                                                      *
 128 %************************************************************************
 129
 130 \begin{code}
 131 instance Outputable RdrName where
 132     ppr (RdrName qual occ) = pp_qual qual <> ppr occ
 133                            where
 134                                 pp_qual Unqual = empty
 135                                 pp_qual (Qual mod) = pprModuleName mod <> dot
 136
 137 instance Eq RdrName where
 138     a == b = case (a `compare` b) of { EQ -> True;  _ -> False }
 139     a /= b = case (a `compare` b) of { EQ -> False; _ -> True }
 140
 141 instance Ord RdrName where
 142     a <= b = case (a `compare` b) of { LT -> True;  EQ -> True;  GT -> False }
 143     a <  b = case (a `compare` b) of { LT -> True;  EQ -> False; GT -> False }
 144     a >= b = case (a `compare` b) of { LT -> False; EQ -> True;  GT -> True  }
 145     a >  b = case (a `compare` b) of { LT -> False; EQ -> False; GT -> True  }
 146
 147     compare (RdrName q1 o1) (RdrName q2 o2)
 148         = (o1  `compare` o2) `thenCmp`
 149           (q1  `cmpQual` q2)
 150
 151 cmpQual Unqual    Unqual    = EQ
 152 cmpQual Unqual    (Qual _)  = LT
 153 cmpQual (Qual _)  Unqual    = GT
 154 cmpQual (Qual m1) (Qual m2) = m1 `compare` m2
 155 \end{code}
 156
 157
 158