2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
5 \section[RdrName]{@RdrName@}
12 mkRdrUnqual, mkRdrQual, mkRdrOrig, mkRdrUnqual,
13 mkUnqual, mkQual, mkIfaceOrig, mkOrig,
14 qualifyRdrName, mkRdrNameWkr,
15 dummyRdrVarName, dummyRdrTcName,
18 rdrNameModule, rdrNameOcc, setRdrNameOcc,
19 isRdrDataCon, isRdrTyVar, isQual, isUnqual, isOrig,
23 emptyRdrEnv, lookupRdrEnv, addListToRdrEnv, rdrEnvElts,
24 extendRdrEnv, rdrEnvToList, elemRdrEnv, foldRdrEnv,
26 -- Printing; instance Outputable RdrName
30 #include "HsVersions.h"
32 import OccName ( NameSpace, tcName,
33 OccName, UserFS, EncodedFS,
36 isDataOcc, isTvOcc, mkWorkerOcc
38 import Module ( ModuleName,
39 mkSysModuleNameFS, mkModuleNameFS
43 import Util ( thenCmp )
47 %************************************************************************
49 \subsection{The main data type}
51 %************************************************************************
54 data RdrName = RdrName Qual OccName
58 | Qual ModuleName -- A qualified name written by the user in source code
59 -- The module isn't necessarily the module where
60 -- the thing is defined; just the one from which it
63 | Orig ModuleName -- This is an *original* name; the module is the place
64 -- where the thing was defined
68 %************************************************************************
70 \subsection{Simple functions}
72 %************************************************************************
75 rdrNameModule :: RdrName -> ModuleName
76 rdrNameModule (RdrName (Qual m) _) = m
77 rdrNameModule (RdrName (Orig m) _) = m
79 rdrNameOcc :: RdrName -> OccName
80 rdrNameOcc (RdrName _ occ) = occ
82 setRdrNameOcc :: RdrName -> OccName -> RdrName
83 setRdrNameOcc (RdrName q _) occ = RdrName q occ
87 -- These two are the basic constructors
88 mkRdrUnqual :: OccName -> RdrName
89 mkRdrUnqual occ = RdrName Unqual occ
91 mkRdrQual :: ModuleName -> OccName -> RdrName
92 mkRdrQual mod occ = RdrName (Qual mod) occ
94 mkRdrOrig :: ModuleName -> OccName -> RdrName
95 mkRdrOrig mod occ = RdrName (Orig mod) occ
97 mkIfaceOrig :: NameSpace -> (EncodedFS, EncodedFS) -> RdrName
98 mkIfaceOrig ns (m,n) = RdrName (Orig (mkSysModuleNameFS m)) (mkSysOccFS ns n)
101 -- These two are used when parsing source files
102 -- They do encode the module and occurrence names
103 mkUnqual :: NameSpace -> FAST_STRING -> RdrName
104 mkUnqual sp n = RdrName Unqual (mkOccFS sp n)
106 mkQual :: NameSpace -> (UserFS, UserFS) -> RdrName
107 mkQual sp (m, n) = RdrName (Qual (mkModuleNameFS m)) (mkOccFS sp n)
109 mkOrig :: NameSpace -> ModuleName -> UserFS -> RdrName
110 mkOrig sp mod n = RdrName (Orig mod) (mkOccFS sp n)
112 qualifyRdrName :: ModuleName -> RdrName -> RdrName
113 -- Sets the module name of a RdrName, even if it has one already
114 qualifyRdrName mod (RdrName _ occ) = RdrName (Qual mod) occ
116 mkRdrNameWkr :: RdrName -> RdrName -- Worker-ify it
117 mkRdrNameWkr (RdrName qual occ) = RdrName qual (mkWorkerOcc occ)
121 -- This guy is used by the reader when HsSyn has a slot for
122 -- an implicit name that's going to be filled in by
123 -- the renamer. We can't just put "error..." because
124 -- we sometimes want to print out stuff after reading but
126 dummyRdrVarName = RdrName Unqual (mkVarOcc SLIT("V-DUMMY"))
127 dummyRdrTcName = RdrName Unqual (mkOccFS tcName SLIT("TC-DUMMY"))
132 isRdrDataCon (RdrName _ occ) = isDataOcc occ
133 isRdrTyVar (RdrName _ occ) = isTvOcc occ
135 isUnqual (RdrName Unqual _) = True
136 isUnqual other = False
138 isQual (RdrName (Qual _) _) = True
141 isOrig (RdrName (Orig _) _) = True
146 %************************************************************************
148 \subsection{Instances}
150 %************************************************************************
153 instance Outputable RdrName where
154 ppr (RdrName qual occ) = pp_qual qual <> ppr occ
156 pp_qual Unqual = empty
157 pp_qual (Qual mod) = ppr mod <> dot
158 pp_qual (Orig mod) = ppr mod <> dot
160 pprUnqualRdrName (RdrName qual occ) = ppr occ
162 instance Eq RdrName where
163 a == b = case (a `compare` b) of { EQ -> True; _ -> False }
164 a /= b = case (a `compare` b) of { EQ -> False; _ -> True }
166 instance Ord RdrName where
167 a <= b = case (a `compare` b) of { LT -> True; EQ -> True; GT -> False }
168 a < b = case (a `compare` b) of { LT -> True; EQ -> False; GT -> False }
169 a >= b = case (a `compare` b) of { LT -> False; EQ -> True; GT -> True }
170 a > b = case (a `compare` b) of { LT -> False; EQ -> False; GT -> True }
172 compare (RdrName q1 o1) (RdrName q2 o2)
173 = (o1 `compare` o2) `thenCmp`
176 cmpQual Unqual Unqual = EQ
177 cmpQual (Qual m1) (Qual m2) = m1 `compare` m2
178 cmpQual (Orig m1) (Orig m2) = m1 `compare` m2
179 cmpQual Unqual _ = LT
180 cmpQual (Qual _) (Orig _) = LT
186 %************************************************************************
188 \subsection{Environment}
190 %************************************************************************
193 type RdrNameEnv a = FiniteMap RdrName a
195 emptyRdrEnv :: RdrNameEnv a
196 lookupRdrEnv :: RdrNameEnv a -> RdrName -> Maybe a
197 addListToRdrEnv :: RdrNameEnv a -> [(RdrName,a)] -> RdrNameEnv a
198 extendRdrEnv :: RdrNameEnv a -> RdrName -> a -> RdrNameEnv a
199 rdrEnvToList :: RdrNameEnv a -> [(RdrName, a)]
200 rdrEnvElts :: RdrNameEnv a -> [a]
201 elemRdrEnv :: RdrName -> RdrNameEnv a -> Bool
202 foldRdrEnv :: (RdrName -> a -> b -> b) -> b -> RdrNameEnv a -> b
204 emptyRdrEnv = emptyFM
205 lookupRdrEnv = lookupFM
206 addListToRdrEnv = addListToFM
208 extendRdrEnv = addToFM
209 rdrEnvToList = fmToList