[project @ 2000-11-03 17:10:57 by simonpj]
[ghc-hetmet.git] / ghc / compiler / basicTypes / RdrName.lhs
index 3e5f52e..dab3594 100644 (file)
@@ -1,4 +1,4 @@
-
+%
 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
 %
 
@@ -9,28 +9,36 @@ module RdrName (
        RdrName,
 
        -- Construction
-       mkRdrUnqual, mkRdrQual,
-       mkSrcUnqual, mkSrcQual, 
-       mkSysUnqual, mkSysQual,
-       mkPreludeQual, qualifyRdrName,
+       mkRdrUnqual, mkRdrQual, mkRdrOrig, mkRdrUnqual,
+       mkUnqual, mkQual, mkIfaceOrig, mkOrig,
+       qualifyRdrName, mkRdrNameWkr,
        dummyRdrVarName, dummyRdrTcName,
 
        -- Destruction
-       rdrNameModule, rdrNameOcc, 
-       isRdrDataCon, isRdrTyVar, isQual, isUnqual
+       rdrNameModule, rdrNameOcc, setRdrNameOcc,
+       isRdrDataCon, isRdrTyVar, isQual, isUnqual, isOrig,
+
+       -- Environment
+       RdrNameEnv, 
+       emptyRdrEnv, lookupRdrEnv, addListToRdrEnv, rdrEnvElts, 
+       extendRdrEnv, rdrEnvToList, elemRdrEnv, foldRdrEnv,
+
+       -- Printing;    instance Outputable RdrName
+       pprUnqualRdrName 
   ) where 
 
 #include "HsVersions.h"
 
 import OccName ( NameSpace, tcName,
-                 OccName,
+                 OccName, UserFS, EncodedFS,
                  mkSysOccFS,
-                 mkSrcOccFS, mkSrcVarOcc,
-                 isDataOcc, isTvOcc
+                 mkOccFS, mkVarOcc,
+                 isDataOcc, isTvOcc, mkWorkerOcc
                )
 import Module   ( ModuleName,
-                 mkSysModuleFS, mkSrcModuleFS
+                 mkSysModuleNameFS, mkModuleNameFS
                )
+import FiniteMap
 import Outputable
 import Util    ( thenCmp )
 \end{code}
@@ -46,7 +54,14 @@ import Util  ( thenCmp )
 data RdrName = RdrName Qual OccName
 
 data Qual = Unqual
-         | Qual ModuleName     -- The (encoded) module name
+
+         | Qual ModuleName     -- A qualified name written by the user in source code
+                               -- The module isn't necessarily the module where
+                               -- the thing is defined; just the one from which it
+                               -- is imported
+
+         | Orig ModuleName     -- This is an *original* name; the module is the place
+                               -- where the thing was defined
 \end{code}
 
 
@@ -59,9 +74,13 @@ data Qual = Unqual
 \begin{code}
 rdrNameModule :: RdrName -> ModuleName
 rdrNameModule (RdrName (Qual m) _) = m
+rdrNameModule (RdrName (Orig m) _) = m
 
 rdrNameOcc :: RdrName -> OccName
 rdrNameOcc (RdrName _ occ) = occ
+
+setRdrNameOcc :: RdrName -> OccName -> RdrName
+setRdrNameOcc (RdrName q _) occ = RdrName q occ
 \end{code}
 
 \begin{code}
@@ -72,28 +91,30 @@ mkRdrUnqual occ = RdrName Unqual occ
 mkRdrQual :: ModuleName -> OccName -> RdrName
 mkRdrQual mod occ = RdrName (Qual mod) occ
 
-       -- These two are used when parsing source files
-       -- They do encode the module and occurrence names
-mkSrcUnqual :: NameSpace -> FAST_STRING -> RdrName
-mkSrcUnqual sp n = RdrName Unqual (mkSrcOccFS sp n)
+mkRdrOrig :: ModuleName -> OccName -> RdrName
+mkRdrOrig mod occ = RdrName (Orig mod) occ
 
-mkSrcQual :: NameSpace -> FAST_STRING -> FAST_STRING -> RdrName
-mkSrcQual sp m n = RdrName (Qual (mkSrcModuleFS m)) (mkSrcOccFS sp n)
+mkIfaceOrig :: NameSpace -> (EncodedFS, EncodedFS) -> RdrName
+mkIfaceOrig ns (m,n) = RdrName (Orig (mkSysModuleNameFS m)) (mkSysOccFS ns n)
 
-       -- These two are used when parsing interface files
-       -- They do not encode the module and occurrence name
-mkSysUnqual :: NameSpace -> FAST_STRING -> RdrName
-mkSysUnqual sp n = RdrName Unqual (mkSysOccFS sp n)
 
-mkSysQual :: NameSpace -> (FAST_STRING, FAST_STRING) -> RdrName
-mkSysQual sp (m,n) = RdrName (Qual (mkSysModuleFS m)) (mkSysOccFS sp n)
+       -- These two are used when parsing source files
+       -- They do encode the module and occurrence names
+mkUnqual :: NameSpace -> FAST_STRING -> RdrName
+mkUnqual sp n = RdrName Unqual (mkOccFS sp n)
+
+mkQual :: NameSpace -> (UserFS, UserFS) -> RdrName
+mkQual sp (m, n) = RdrName (Qual (mkModuleNameFS m)) (mkOccFS sp n)
 
-mkPreludeQual :: NameSpace -> ModuleName -> FAST_STRING -> RdrName
-mkPreludeQual sp mod n = RdrName (Qual mod) (mkSrcOccFS sp n)
+mkOrig :: NameSpace -> ModuleName -> UserFS -> RdrName
+mkOrig sp mod n = RdrName (Orig mod) (mkOccFS sp n)
 
 qualifyRdrName :: ModuleName -> RdrName -> RdrName
-qualifyRdrName mod (RdrName Unqual occ) = RdrName (Qual mod) occ
-qualifyRdrName mod rdr_name            = rdr_name 
+       -- Sets the module name of a RdrName, even if it has one already
+qualifyRdrName mod (RdrName _ occ) = RdrName (Qual mod) occ
+
+mkRdrNameWkr :: RdrName -> RdrName     -- Worker-ify it
+mkRdrNameWkr (RdrName qual occ) = RdrName qual (mkWorkerOcc occ)
 \end{code}
 
 \begin{code}
@@ -102,8 +123,8 @@ qualifyRdrName mod rdr_name         = rdr_name
        -- the renamer.  We can't just put "error..." because
        -- we sometimes want to print out stuff after reading but
        -- before renaming
-dummyRdrVarName = RdrName Unqual (mkSrcVarOcc SLIT("V-DUMMY"))
-dummyRdrTcName  = RdrName Unqual (mkSrcOccFS tcName SLIT("TC-DUMMY"))
+dummyRdrVarName = RdrName Unqual (mkVarOcc SLIT("V-DUMMY"))
+dummyRdrTcName  = RdrName Unqual (mkOccFS tcName SLIT("TC-DUMMY"))
 \end{code}
 
 
@@ -114,7 +135,11 @@ isRdrTyVar   (RdrName _ occ) = isTvOcc occ
 isUnqual (RdrName Unqual _) = True
 isUnqual other             = False
 
-isQual rdr_name = not (isUnqual rdr_name)
+isQual (RdrName (Qual _) _) = True
+isQual _                   = False
+
+isOrig (RdrName (Orig _)    _) = True
+isOrig other                  = False
 \end{code}
 
 
@@ -128,8 +153,11 @@ isQual rdr_name = not (isUnqual rdr_name)
 instance Outputable RdrName where
     ppr (RdrName qual occ) = pp_qual qual <> ppr occ
                           where
-                               pp_qual Unqual = empty
-                               pp_qual (Qual mod) = ppr mod <> dot
+                            pp_qual Unqual      = empty
+                            pp_qual (Qual mod)  = ppr mod <> dot
+                            pp_qual (Orig mod)  = ppr mod <> dot
+
+pprUnqualRdrName (RdrName qual occ) = ppr occ
 
 instance Eq RdrName where
     a == b = case (a `compare` b) of { EQ -> True;  _ -> False }
@@ -145,11 +173,40 @@ instance Ord RdrName where
        = (o1  `compare` o2) `thenCmp` 
          (q1  `cmpQual` q2) 
 
-cmpQual Unqual   Unqual    = EQ
-cmpQual Unqual    (Qual _)  = LT
-cmpQual (Qual _)  Unqual    = GT
-cmpQual (Qual m1) (Qual m2) = m1 `compare` m2
+cmpQual Unqual     Unqual      = EQ
+cmpQual (Qual m1)   (Qual m2)   = m1 `compare` m2
+cmpQual (Orig m1)   (Orig m2)   = m1 `compare` m2
+cmpQual Unqual      _          = LT
+cmpQual (Qual _)    (Orig _)    = LT
+cmpQual _          _           = GT
 \end{code}
 
 
 
+%************************************************************************
+%*                                                                     *
+\subsection{Environment}
+%*                                                                     *
+%************************************************************************
+
+\begin{code}
+type RdrNameEnv a = FiniteMap RdrName a
+
+emptyRdrEnv    :: RdrNameEnv a
+lookupRdrEnv   :: RdrNameEnv a -> RdrName -> Maybe a
+addListToRdrEnv :: RdrNameEnv a -> [(RdrName,a)] -> RdrNameEnv a
+extendRdrEnv   :: RdrNameEnv a -> RdrName -> a -> RdrNameEnv a
+rdrEnvToList    :: RdrNameEnv a -> [(RdrName, a)]
+rdrEnvElts     :: RdrNameEnv a -> [a]
+elemRdrEnv     :: RdrName -> RdrNameEnv a -> Bool
+foldRdrEnv     :: (RdrName -> a -> b -> b) -> b -> RdrNameEnv a -> b
+
+emptyRdrEnv  = emptyFM
+lookupRdrEnv = lookupFM
+addListToRdrEnv = addListToFM
+rdrEnvElts     = eltsFM
+extendRdrEnv    = addToFM
+rdrEnvToList    = fmToList
+elemRdrEnv      = elemFM
+foldRdrEnv     = foldFM
+\end{code}