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,
  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,
  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 \end{code}
  66
  67 \begin{code}
  68         -- These two are the basic constructors
  69 mkRdrUnqual :: OccName -> RdrName
  70 mkRdrUnqual occ = RdrName Unqual occ
  71
  72 mkRdrQual :: ModuleName -> OccName -> RdrName
  73 mkRdrQual mod occ = RdrName (Qual mod) occ
  74
  75         -- These two are used when parsing source files
  76         -- They do encode the module and occurrence names
  77 mkSrcUnqual :: NameSpace -> FAST_STRING -> RdrName
  78 mkSrcUnqual sp n = RdrName Unqual (mkSrcOccFS sp n)
  79
  80 mkSrcQual :: NameSpace -> FAST_STRING -> FAST_STRING -> RdrName
  81 mkSrcQual sp m n = RdrName (Qual (mkSrcModuleFS m)) (mkSrcOccFS sp n)
  82
  83         -- These two are used when parsing interface files
  84         -- They do not encode the module and occurrence name
  85 mkSysUnqual :: NameSpace -> FAST_STRING -> RdrName
  86 mkSysUnqual sp n = RdrName Unqual (mkSysOccFS sp n)
  87
  88 mkSysQual :: NameSpace -> (FAST_STRING, FAST_STRING) -> RdrName
  89 mkSysQual sp (m,n) = RdrName (Qual (mkSysModuleFS m)) (mkSysOccFS sp n)
  90
  91 mkPreludeQual :: NameSpace -> ModuleName -> FAST_STRING -> RdrName
  92 mkPreludeQual sp mod n = RdrName (Qual mod) (mkSrcOccFS sp n)
  93
  94 qualifyRdrName :: ModuleName -> RdrName -> RdrName
  95 qualifyRdrName mod (RdrName Unqual occ) = RdrName (Qual mod) occ
  96 qualifyRdrName mod rdr_name             = rdr_name
  97 \end{code}
  98
  99 \begin{code}
 100         -- This guy is used by the reader when HsSyn has a slot for
 101         -- an implicit name that's going to be filled in by
 102         -- the renamer.  We can't just put "error..." because
 103         -- we sometimes want to print out stuff after reading but
 104         -- before renaming
 105 dummyRdrVarName = RdrName Unqual (mkSrcVarOcc SLIT("V-DUMMY"))
 106 dummyRdrTcName  = RdrName Unqual (mkSrcOccFS tcName SLIT("TC-DUMMY"))
 107 \end{code}
 108
 109
 110 \begin{code}
 111 isRdrDataCon (RdrName _ occ) = isDataOcc occ
 112 isRdrTyVar   (RdrName _ occ) = isTvOcc occ
 113
 114 isUnqual (RdrName Unqual _) = True
 115 isUnqual other              = False
 116
 117 isQual rdr_name = not (isUnqual rdr_name)
 118 \end{code}
 119
 120
 121 %************************************************************************
 122 %*                                                                      *
 123 \subsection{Instances}
 124 %*                                                                      *
 125 %************************************************************************
 126
 127 \begin{code}
 128 instance Outputable RdrName where
 129     ppr (RdrName qual occ) = pp_qual qual <> ppr occ
 130                            where
 131                                 pp_qual Unqual = empty
 132                                 pp_qual (Qual mod) = ppr mod <> dot
 133
 134 instance Eq RdrName where
 135     a == b = case (a `compare` b) of { EQ -> True;  _ -> False }
 136     a /= b = case (a `compare` b) of { EQ -> False; _ -> True }
 137
 138 instance Ord RdrName where
 139     a <= b = case (a `compare` b) of { LT -> True;  EQ -> True;  GT -> False }
 140     a <  b = case (a `compare` b) of { LT -> True;  EQ -> False; GT -> False }
 141     a >= b = case (a `compare` b) of { LT -> False; EQ -> True;  GT -> True  }
 142     a >  b = case (a `compare` b) of { LT -> False; EQ -> False; GT -> True  }
 143
 144     compare (RdrName q1 o1) (RdrName q2 o2)
 145         = (o1  `compare` o2) `thenCmp`
 146           (q1  `cmpQual` q2)
 147
 148 cmpQual Unqual    Unqual    = EQ
 149 cmpQual Unqual    (Qual _)  = LT
 150 cmpQual (Qual _)  Unqual    = GT
 151 cmpQual (Qual m1) (Qual m2) = m1 `compare` m2
 152 \end{code}
 153
 154
 155