[project @ 1997-06-20 00:33:36 by simonpj]
[ghc-hetmet.git] / ghc / compiler / basicTypes / Name.lhs
index c809a49..1750dc7 100644 (file)
 #include "HsVersions.h"
 
 module Name (
-       -- things for the Name NON-abstract type
-       Name(..),
+       -- Re-export the Module type
+       SYN_IE(Module),
+       pprModule, moduleString,
 
-       isTyConName, isClassName, isClassOpName,
-       isUnboundName, invisibleName,
+       -- The OccName type
+       OccName(..),
+       pprOccName, occNameString, occNameFlavour, 
+       isTvOcc, isTCOcc, isVarOcc, prefixOccName,
+       quoteInText, parenInCode,
 
-       getTagFromClassOpName, getSynNameArity,
+       -- The Name type
+       Name,                                   -- Abstract
+       mkLocalName, mkSysLocalName, 
 
-       getNameShortName, getNameFullName
+       mkCompoundName, mkGlobalName, mkInstDeclName,
 
+       mkWiredInIdName,   mkWiredInTyConName,
+       maybeWiredInIdName, maybeWiredInTyConName,
+       isWiredInName,
+
+       nameUnique, changeUnique, setNameProvenance, getNameProvenance,
+       setNameVisibility,
+       nameOccName, nameString, nameModule,
+
+       isExportedName, nameSrcLoc,
+       isLocallyDefinedName,
+
+       isLocalName, 
+
+        pprNameProvenance,
+
+       -- Sets of Names
+       SYN_IE(NameSet),
+       emptyNameSet, unitNameSet, mkNameSet, unionNameSets, unionManyNameSets,
+       minusNameSet, elemNameSet, nameSetToList, addOneToNameSet, addListToNameSet, isEmptyNameSet,
+
+       -- Misc
+       DefnInfo(..),
+       Provenance(..), pprProvenance,
+       ExportFlag(..),
+
+       -- Class NamedThing and overloaded friends
+       NamedThing(..),
+       modAndOcc, isExported, 
+       getSrcLoc, isLocallyDefined, getOccString
     ) where
 
-import Ubiq{-uitous-}
+IMP_Ubiq()
+#if defined(__GLASGOW_HASKELL__) && __GLASGOW_HASKELL__ <= 201
+IMPORT_DELOOPER(TyLoop)        ( GenId, Id(..), TyCon )                        -- Used inside Names
+#else
+import {-# SOURCE #-} Id    ( Id )
+import {-# SOURCE #-} TyCon ( TyCon )
+#endif
 
-import NameLoop                -- break Name/Id loop, Name/PprType/Id loop
+import CStrings                ( identToC, modnameToC, cSEP )
+import CmdLineOpts     ( opt_OmitInterfacePragmas, opt_EnsureSplittableC )
+import BasicTypes      ( SYN_IE(Module), moduleString, pprModule )
 
-import NameTypes
-import Outputable      ( ExportFlag(..) )
+import Outputable      ( Outputable(..), PprStyle(..), codeStyle, ifaceStyle )
+import PrelMods                ( gHC__ )
 import Pretty
-import PprStyle                ( PprStyle(..) )
-import SrcLoc          ( mkBuiltinSrcLoc, mkUnknownSrcLoc )
-import TyCon           ( TyCon, synTyConArity )
-import TyVar           ( GenTyVar )
-import Unique          ( pprUnique, Unique )
-import Util            ( panic, panic#, pprPanic )
+import Lex             ( isLexSym, isLexConId )
+import SrcLoc          ( noSrcLoc, SrcLoc )
+import Usage            ( SYN_IE(UVar), SYN_IE(Usage) )
+import Unique          ( pprUnique, showUnique, Unique, Uniquable(..) )
+import UniqSet         ( UniqSet(..), emptyUniqSet, unitUniqSet, unionUniqSets, uniqSetToList, isEmptyUniqSet,
+                         unionManyUniqSets, minusUniqSet, mkUniqSet, elementOfUniqSet, addListToUniqSet, addOneToUniqSet )
+import UniqFM          ( UniqFM )
+import Util            --( cmpPString, panic, assertPanic {-, pprTrace ToDo:rm-} )
+
 \end{code}
 
+
 %************************************************************************
 %*                                                                     *
-\subsection[Name-datatype]{The @Name@ datatype}
+\subsection[Name-pieces-datatypes]{The @OccName@ datatypes}
 %*                                                                     *
 %************************************************************************
 
 \begin{code}
-data Name
-  = Short          Unique      -- Local ids and type variables
-                   ShortName
-
-       -- Nano-prelude things; truly wired in.
-       -- Includes all type constructors and their associated data constructors
-  | WiredInTyCon    TyCon
-  | WiredInVal     Id
-
-  | TyConName      Unique      -- TyCons other than Prelude ones; need to
-                   FullName    -- separate these because we want to pin on
-                   Arity       -- their arity.
-                   Bool        -- False <=> `type',
-                               -- True <=> `data' or `newtype'
-                   [Name]      -- List of user-visible data constructors;
-                               -- NB: for `data' types only.
-                               -- Used in checking import/export lists.
-
-  | ClassName      Unique
-                   FullName
-                   [Name]      -- List of class methods; used for checking
-                               -- import/export lists.
-
-  | ValName        Unique      -- Top level id
-                   FullName
-
-  | ClassOpName            Unique
-                   Name        -- Name associated w/ the defined class
-                               -- (can get unique and export info, etc., from this)
-                   FAST_STRING -- The class operation
-                   Int         -- Unique tag within the class
-
-       -- Miscellaneous
-  | Unbound        FAST_STRING -- Placeholder for a name which isn't in scope
-                               -- Used only so that the renamer can carry on after
-                               -- finding an unbound identifier.
-                               -- The string is grabbed from the unbound name, for
-                               -- debugging information only.
+data OccName  = VarOcc  FAST_STRING    -- Variables and data constructors
+             | TvOcc   FAST_STRING     -- Type variables
+             | TCOcc   FAST_STRING     -- Type constructors and classes
+
+pprOccName :: PprStyle -> OccName -> Doc
+pprOccName sty      n = if codeStyle sty 
+                       then identToC (occNameString n)
+                       else ptext (occNameString n)
+
+occNameString :: OccName -> FAST_STRING
+occNameString (VarOcc s)  = s
+occNameString (TvOcc s)   = s
+occNameString (TCOcc s)   = s
+
+prefixOccName :: FAST_STRING -> OccName -> OccName
+prefixOccName prefix (VarOcc s) = VarOcc (prefix _APPEND_ s)
+prefixOccName prefix (TvOcc s)  = TvOcc (prefix _APPEND_ s)
+prefixOccName prefix (TCOcc s) = TCOcc (prefix _APPEND_ s)
+
+-- occNameFlavour is used only to generate good error messages, so it doesn't matter
+-- that the VarOcc case isn't mega-efficient.  We could have different Occ constructors for
+-- data constructors and values, but that makes everything else a bit more complicated.
+occNameFlavour :: OccName -> String
+occNameFlavour (VarOcc s) | isLexConId s = "Data constructor"
+                         | otherwise    = "Value"
+occNameFlavour (TvOcc s)  = "Type variable"
+occNameFlavour (TCOcc s)  = "Type constructor or class"
+
+isVarOcc, isTCOcc, isTvOcc :: OccName -> Bool
+isVarOcc (VarOcc s) = True
+isVarOcc other     = False
+
+isTvOcc (TvOcc s) = True
+isTvOcc other     = False
+
+isTCOcc (TCOcc s) = True
+isTCOcc other     = False
+
+
+instance Eq OccName where
+    a == b = case (a `cmp` b) of { EQ_ -> True;  _ -> False }
+    a /= b = case (a `cmp` b) of { EQ_ -> False; _ -> True }
+
+instance Ord OccName where
+    a <= b = case (a `cmp` b) of { LT_ -> True;         EQ_ -> True;  GT__ -> False }
+    a <         b = case (a `cmp` b) of { LT_ -> True;  EQ_ -> False; GT__ -> False }
+    a >= b = case (a `cmp` b) of { LT_ -> False; EQ_ -> True;  GT__ -> True  }
+    a >         b = case (a `cmp` b) of { LT_ -> False; EQ_ -> False; GT__ -> True  }
+
+instance Ord3 OccName where
+    cmp = cmpOcc
+
+(VarOcc s1) `cmpOcc` (VarOcc s2) = s1 `_CMP_STRING_` s2
+(VarOcc s1) `cmpOcc` other2      = LT_
+
+(TvOcc s1)  `cmpOcc` (VarOcc s2) = GT_
+(TvOcc s1)  `cmpOcc` (TvOcc s2)  = s1 `_CMP_STRING_` s2
+(TvOcc s1)  `cmpOcc` other      = LT_
+
+(TCOcc s1) `cmpOcc` (TCOcc s2) = s1 `_CMP_STRING_` s2
+(TCOcc s1) `cmpOcc` other      = GT_
+
+instance Outputable OccName where
+  ppr = pprOccName
 \end{code}
 
-These @is..@ functions are used in the renamer to check that (eg) a tycon
-is seen in a context which demands one.
 
 \begin{code}
-isTyConName, isClassName, isUnboundName :: Name -> Bool
-
-isTyConName (TyConName _ _ _ _ _) = True
-isTyConName (WiredInTyCon _)     = True
-isTyConName other                = False
+parenInCode, quoteInText :: OccName -> Bool
+parenInCode occ = isLexSym (occNameString occ)
 
-isClassName (ClassName _ _ _) = True
-isClassName other            = False
+quoteInText occ = not (isLexSym (occNameString occ))
+\end{code}
 
-isUnboundName (Unbound _) = True
-isUnboundName other      = False
+%************************************************************************
+%*                                                                     *
+\subsection[Name-datatype]{The @Name@ datatype, and name construction}
+%*                                                                     *
+%************************************************************************
+\begin{code}
+data Name
+  = Local    Unique
+             OccName
+             SrcLoc
+
+  | Global   Unique
+            Module             -- The defining module
+            OccName            -- Its name in that module
+            DefnInfo           -- How it is defined
+             Provenance                -- How it was brought into scope
 \end{code}
 
-@isClassOpName@ is a little cleverer: it checks to see whether the
-class op comes from the correct class.
+Things with a @Global@ name are given C static labels, so they finally
+appear in the .o file's symbol table.  They appear in the symbol table
+in the form M.n.  If originally-local things have this property they
+must be made @Global@ first.
 
 \begin{code}
-isClassOpName :: Name  -- The name of the class expected for this op
-             -> Name   -- The name of the thing which should be a class op
-             -> Bool
+data DefnInfo =        VanillaDefn     
+             | WiredInTyCon TyCon      -- There's a wired-in version
+             | WiredInId    Id         -- ...ditto...
+
+data Provenance
+  = LocalDef ExportFlag SrcLoc -- Locally defined
+  | Imported Module SrcLoc     -- Directly imported from M; gives locn of import statement
+  | Implicit                   -- Implicitly imported
+\end{code}
+
+Something is "Exported" if it may be mentioned by another module without
+warning.  The crucial thing about Exported things is that they must
+never be dropped as dead code, even if they aren't used in this module.
+Furthermore, being Exported means that we can't see all call sites of the thing.
+
+Exported things include:
+       - explicitly exported Ids, including data constructors, class method selectors
+       - dfuns from instance decls
 
-isClassOpName (ClassName uniq1 _ _) (ClassOpName _ (ClassName uniq2 _ _) _ _)
-  = uniq1 == uniq2
-isClassOpName other_class other_op = False
+Being Exported is *not* the same as finally appearing in the .o file's 
+symbol table.  For example, a local Id may be mentioned in an Exported
+Id's unfolding in the interface file, in which case the local Id goes
+out too.
+
+\begin{code}
+data ExportFlag = Exported  | NotExported
 \end{code}
 
-A Name is ``invisible'' if the user has no business seeing it; e.g., a
-data-constructor for an abstract data type (but whose constructors are
-known because of a pragma).
 \begin{code}
-invisibleName :: Name -> Bool
+mkLocalName    :: Unique -> OccName -> SrcLoc -> Name
+mkLocalName = Local
+
+mkGlobalName :: Unique -> Module -> OccName -> DefnInfo -> Provenance -> Name
+mkGlobalName = Global
+
+mkSysLocalName :: Unique -> FAST_STRING -> SrcLoc -> Name
+mkSysLocalName uniq str loc = Local uniq (VarOcc str) loc
+
+mkWiredInIdName :: Unique -> Module -> FAST_STRING -> Id -> Name
+mkWiredInIdName uniq mod occ id 
+  = Global uniq mod (VarOcc occ) (WiredInId id) Implicit
+
+mkWiredInTyConName :: Unique -> Module -> FAST_STRING -> TyCon -> Name
+mkWiredInTyConName uniq mod occ tycon
+  = Global uniq mod (TCOcc occ) (WiredInTyCon tycon) Implicit
+
+
+mkCompoundName :: (FAST_STRING -> FAST_STRING) -- Occurrence-name modifier
+              -> Unique                        -- New unique
+              -> Name                          -- Base name (must be a Global)
+              -> Name          -- Result is always a value name
+
+mkCompoundName str_fn uniq (Global _ mod occ defn prov)
+  = Global uniq mod new_occ defn prov
+  where    
+    new_occ = VarOcc (str_fn (occNameString occ))              -- Always a VarOcc
+
+mkCompoundName str_fn uniq (Local _ occ loc)
+  = Local uniq (VarOcc (str_fn (occNameString occ))) loc
+
+       -- Rather a wierd one that's used for names generated for instance decls
+mkInstDeclName :: Unique -> Module -> OccName -> SrcLoc -> Bool -> Name
+mkInstDeclName uniq mod occ loc from_here
+  = Global uniq mod occ VanillaDefn prov
+  where
+    prov | from_here = LocalDef Exported loc
+         | otherwise = Implicit
+
+
+setNameProvenance :: Name -> Provenance -> Name        
+       -- setNameProvenance used to only change the provenance of Implicit-provenance things,
+       -- but that gives bad error messages for names defined twice in the same
+       -- module, so I changed it to set the proveance of *any* global (SLPJ Jun 97)
+setNameProvenance (Global uniq mod occ def _) prov = Global uniq mod occ def prov
+setNameProvenance other_name                 prov = other_name
+
+getNameProvenance :: Name -> Provenance
+getNameProvenance (Global uniq mod occ def prov) = prov
+getNameProvenance (Local uniq occ locn)         = LocalDef NotExported locn
+
+-- When we renumber/rename things, we need to be
+-- able to change a Name's Unique to match the cached
+-- one in the thing it's the name of.  If you know what I mean.
+changeUnique (Local      _ n l)  u = Local u n l
+changeUnique (Global   _ mod occ def prov) u = Global u mod occ def prov
+
+setNameVisibility :: Module -> Name -> Name
+-- setNameVisibility is applied to top-level names in the final program
+-- The "visibility" here concerns whether the .o file's symbol table
+-- mentions the thing; if so, it needs a module name in its symbol,
+-- otherwise we just use its unique.  The Global things are "visible"
+-- and the local ones are not
+
+setNameVisibility _ (Global uniq mod occ def (LocalDef NotExported loc))
+  | not all_toplev_ids_visible
+  = Local uniq occ loc
+
+setNameVisibility mod (Local uniq occ loc)
+  | all_toplev_ids_visible
+  = Global uniq mod 
+          (VarOcc (showUnique uniq))   -- It's local name must be unique!
+          VanillaDefn (LocalDef NotExported loc)
+
+setNameVisibility mod name = name
+
+all_toplev_ids_visible = not opt_OmitInterfacePragmas ||  -- Pragmas can make them visible
+                        opt_EnsureSplittableC            -- Splitting requires visiblilty
 
-invisibleName (TyConName _ n _ _ _) = invisibleFullName n
-invisibleName (ClassName _ n _)     = invisibleFullName n
-invisibleName (ValName   _ n)      = invisibleFullName n
-invisibleName _                            = False
 \end{code}
 
+%************************************************************************
+%*                                                                     *
+\subsection{Predicates and selectors}
+%*                                                                     *
+%************************************************************************
+
 \begin{code}
-getTagFromClassOpName :: Name -> Int
-getTagFromClassOpName (ClassOpName _ _ _ tag)  = tag
+nameUnique             :: Name -> Unique
+nameModAndOcc          :: Name -> (Module, OccName)    -- Globals only
+nameOccName            :: Name -> OccName 
+nameModule             :: Name -> Module
+nameString             :: Name -> FAST_STRING          -- A.b form
+nameSrcLoc             :: Name -> SrcLoc
+isLocallyDefinedName   :: Name -> Bool
+isExportedName         :: Name -> Bool
+isWiredInName          :: Name -> Bool
+isLocalName            :: Name -> Bool
+
+
+
+nameUnique (Local  u _ _)   = u
+nameUnique (Global u _ _ _ _) = u
+
+nameOccName (Local _ occ _)      = occ
+nameOccName (Global _ _ occ _ _) = occ
+
+nameModule (Global _ mod occ _ _) = mod
+
+nameModAndOcc (Global _ mod occ _ _) = (mod,occ)
 
-getSynNameArity :: Name -> Maybe Arity
-getSynNameArity (TyConName _ _ arity False{-syn-} _) = Just arity
-getSynNameArity (WiredInTyCon tycon)                = synTyConArity tycon
-getSynNameArity other_name                          = Nothing
+nameString (Local _ occ _)        = occNameString occ
+nameString (Global _ mod occ _ _) = mod _APPEND_ SLIT(".") _APPEND_ occNameString occ
 
-getNameShortName :: Name -> ShortName
-getNameShortName (Short _ sn) = sn
+isExportedName (Global _ _ _ _ (LocalDef Exported _)) = True
+isExportedName other                                 = False
 
-getNameFullName :: Name -> FullName
-getNameFullName n = get_nm "getNameFullName" n
+nameSrcLoc (Local _ _ loc)     = loc
+nameSrcLoc (Global _ _ _ _ (LocalDef _ loc)) = loc
+nameSrcLoc (Global _ _ _ _ (Imported _ loc)) = loc
+nameSrcLoc other                            = noSrcLoc
+  
+isLocallyDefinedName (Local  _ _ _)                 = True
+isLocallyDefinedName (Global _ _ _ _ (LocalDef _ _)) = True
+isLocallyDefinedName other                          = False
+
+-- Things the compiler "knows about" are in some sense
+-- "imported".  When we are compiling the module where
+-- the entities are defined, we need to be able to pick
+-- them out, often in combination with isLocallyDefined.
+isWiredInName (Global _ _ _ (WiredInTyCon _) _) = True
+isWiredInName (Global _ _ _ (WiredInId    _) _) = True
+isWiredInName _                                          = False
+
+maybeWiredInIdName :: Name -> Maybe Id
+maybeWiredInIdName (Global _ _ _ (WiredInId id) _) = Just id
+maybeWiredInIdName other                          = Nothing
+
+maybeWiredInTyConName :: Name -> Maybe TyCon
+maybeWiredInTyConName (Global _ _ _ (WiredInTyCon tc) _) = Just tc
+maybeWiredInTyConName other                             = Nothing
+
+
+isLocalName (Local _ _ _) = True
+isLocalName _            = False
 \end{code}
 
 
@@ -149,32 +373,10 @@ getNameFullName n = get_nm "getNameFullName" n
 \begin{code}
 cmpName n1 n2 = c n1 n2
   where
-    c (Short u1 _)          (Short u2 _)               = cmp u1 u2
-                             
-    c (WiredInTyCon tc1)     (WiredInTyCon tc2)                = cmp tc1 tc2
-    c (WiredInVal   id1)     (WiredInVal   id2)                = cmp id1 id2
-                             
-    c (TyConName u1 _ _ _ _) (TyConName u2 _ _ _ _)    = cmp u1 u2
-    c (ClassName u1 _ _)     (ClassName u2 _ _)                = cmp u1 u2
-    c (ValName   u1 _)      (ValName   u2 _)           = cmp u1 u2
-                             
-    c (ClassOpName u1 _ _ _) (ClassOpName u2 _ _ _)    = cmp u1 u2
-    c (Unbound a)           (Unbound b)                = panic# "Eq.Name.Unbound"
-
-    c other_1 other_2          -- the tags *must* be different
-      = let tag1 = tag_Name n1
-           tag2 = tag_Name n2
-       in
-       if tag1 _LT_ tag2 then LT_ else GT_
-
-    tag_Name (Short _ _)               = (ILIT(1) :: FAST_INT)
-    tag_Name (WiredInTyCon _)          = ILIT(2)
-    tag_Name (WiredInVal _)            = ILIT(3)
-    tag_Name (TyConName _ _ _ _ _)     = ILIT(7)
-    tag_Name (ClassName _ _ _)         = ILIT(8)
-    tag_Name (ValName _ _)             = ILIT(9)
-    tag_Name (ClassOpName _ _ _ _)     = ILIT(10)
-    tag_Name (Unbound _)               = ILIT(11)
+    c (Local  u1 _ _)   (Local  u2 _ _)       = cmp u1 u2
+    c (Local   _ _ _)    _                   = LT_
+    c (Global u1 _ _ _ _) (Global u2 _ _ _ _) = cmp u1 u2
+    c (Global  _ _ _ _ _)   _                = GT_
 \end{code}
 
 \begin{code}
@@ -190,106 +392,137 @@ instance Ord Name where
 
 instance Ord3 Name where
     cmp = cmpName
+
+instance Uniquable Name where
+    uniqueOf = nameUnique
+
+instance NamedThing Name where
+    getName n = n
+\end{code}
+
+
+
+%************************************************************************
+%*                                                                     *
+\subsection{Pretty printing}
+%*                                                                     *
+%************************************************************************
+
+\begin{code}
+instance Outputable Name where
+    ppr PprQuote name@(Local _ _ _) = quotes (ppr (PprForUser 1) name)
+    ppr (PprForUser _) (Local _ n _)    = ptext (occNameString n)
+
+    ppr sty (Local u n _) | codeStyle sty ||
+                           ifaceStyle sty = pprUnique u
+
+    ppr sty  (Local u n _) = hcat [ptext (occNameString n), ptext SLIT("_"), pprUnique u]
+
+    ppr PprQuote name@(Global _ _ _ _ _) = quotes (ppr (PprForUser 1) name)
+
+    ppr sty name@(Global u m n _ _)
+       | codeStyle sty
+       = identToC (m _APPEND_ SLIT(".") _APPEND_ occNameString n)
+
+    ppr sty name@(Global u m n _ prov)
+       = hcat [pp_mod, ptext (occNameString n), pp_debug sty name]
+       where
+         pp_mod = case prov of                         --- Omit home module qualifier
+                       LocalDef _ _ -> empty
+                       other        -> pprModule (PprForUser 1) m <> char '.'
+
+
+pp_debug PprDebug (Global uniq m n _ prov) = hcat [text "{-", pprUnique uniq, char ',', 
+                                                       pp_prov prov, text "-}"]
+                                       where
+                                               pp_prov (LocalDef Exported _)    = char 'x'
+                                               pp_prov (LocalDef NotExported _) = char 'l'
+                                               pp_prov (Imported _ _) = char 'i'
+                                               pp_prov Implicit       = char 'p'
+pp_debug other    name                         = empty
+
+-- pprNameProvenance is used in error messages to say where a name came from
+pprNameProvenance :: PprStyle -> Name -> Doc
+pprNameProvenance sty (Local _ _ loc)       = pprProvenance sty (LocalDef NotExported loc)
+pprNameProvenance sty (Global _ _ _ _ prov) = pprProvenance sty prov
+
+pprProvenance :: PprStyle -> Provenance -> Doc
+pprProvenance sty (Imported mod loc)
+  = sep [ptext SLIT("Imported from"), pprModule sty mod, ptext SLIT("at"), ppr sty loc]
+pprProvenance sty (LocalDef _ loc) 
+  = sep [ptext SLIT("Defined at"), ppr sty loc]
+pprProvenance sty Implicit
+  = panic "pprNameProvenance: Implicit"
 \end{code}
 
+
+%************************************************************************
+%*                                                                     *
+\subsection[Sets of names}
+%*                                                                     *
+%************************************************************************
+
 \begin{code}
-instance NamedThing Name where
-    getExportFlag (Short _ _)          = NotExported
-    getExportFlag (WiredInTyCon _)     = NotExported -- compiler always know about these
-    getExportFlag (WiredInVal _)       = NotExported
-    getExportFlag (ClassOpName _ c _ _) = getExportFlag c
-    getExportFlag other                        = getExportFlag (get_nm "getExportFlag" other)
-
-    isLocallyDefined (Short _ _)          = True
-    isLocallyDefined (WiredInTyCon _)     = False
-    isLocallyDefined (WiredInVal _)       = False
-    isLocallyDefined (ClassOpName _ c _ _) = isLocallyDefined c
-    isLocallyDefined other                = isLocallyDefined (get_nm "isLocallyDefined" other)
-
-    getOrigName (Short _ sn)           = getOrigName sn
-    getOrigName (WiredInTyCon tc)      = getOrigName tc
-    getOrigName (WiredInVal id)                = getOrigName id
-    getOrigName (ClassOpName _ c op _) = (fst (getOrigName c), op)
-    getOrigName other                  = getOrigName (get_nm "getOrigName" other)
-
-    getOccurrenceName (Short _ sn)        = getOccurrenceName sn
-    getOccurrenceName (WiredInTyCon tc)    = getOccurrenceName tc
-    getOccurrenceName (WiredInVal id)     = getOccurrenceName id
-    getOccurrenceName (ClassOpName _ _ op _) = op
-    getOccurrenceName (Unbound s)         =  s _APPEND_ SLIT("<unbound>")
-    getOccurrenceName other               = getOccurrenceName (get_nm "getOccurrenceName" other)
-
-    getInformingModules thing = panic "getInformingModule:Name"
-
-    getSrcLoc (Short _ sn)        = getSrcLoc sn
-    getSrcLoc (WiredInTyCon tc)    = mkBuiltinSrcLoc
-    getSrcLoc (WiredInVal id)     = mkBuiltinSrcLoc
-    getSrcLoc (ClassOpName _ c _ _)  = getSrcLoc c
-    getSrcLoc (Unbound _)         = mkUnknownSrcLoc
-    getSrcLoc other               = getSrcLoc (get_nm "getSrcLoc" other)
-
-    getItsUnique (Short                u _)       = u
-    getItsUnique (WiredInTyCon t)         = getItsUnique t
-    getItsUnique (WiredInVal   i)         = getItsUnique i
-    getItsUnique (TyConName    u _ _ _ _) = u
-    getItsUnique (ClassName    u _ _)     = u
-    getItsUnique (ValName      u _)       = u
-    getItsUnique (ClassOpName  u _ _ _)   = u
-
-    fromPreludeCore (WiredInTyCon _)      = True
-    fromPreludeCore (WiredInVal _)        = True
-    fromPreludeCore (ClassOpName _ c _ _)  = fromPreludeCore c
-    fromPreludeCore other                 = False
+type NameSet = UniqSet Name
+emptyNameSet     :: NameSet
+unitNameSet      :: Name -> NameSet
+addListToNameSet  :: NameSet -> [Name] -> NameSet
+addOneToNameSet   :: NameSet -> Name -> NameSet
+mkNameSet         :: [Name] -> NameSet
+unionNameSets    :: NameSet -> NameSet -> NameSet
+unionManyNameSets :: [NameSet] -> NameSet
+minusNameSet     :: NameSet -> NameSet -> NameSet
+elemNameSet      :: Name -> NameSet -> Bool
+nameSetToList    :: NameSet -> [Name]
+isEmptyNameSet   :: NameSet -> Bool
+
+isEmptyNameSet    = isEmptyUniqSet
+emptyNameSet     = emptyUniqSet
+unitNameSet      = unitUniqSet
+mkNameSet         = mkUniqSet
+addListToNameSet  = addListToUniqSet
+addOneToNameSet          = addOneToUniqSet
+unionNameSets     = unionUniqSets
+unionManyNameSets = unionManyUniqSets
+minusNameSet     = minusUniqSet
+elemNameSet       = elementOfUniqSet
+nameSetToList     = uniqSetToList
 \end{code}
 
-A useful utility; most emphatically not for export! (but see
-@getNameFullName@...):
+
+
+%************************************************************************
+%*                                                                     *
+\subsection{Overloaded functions related to Names}
+%*                                                                     *
+%************************************************************************
+
 \begin{code}
-get_nm :: String -> Name -> FullName
-
-get_nm msg (TyConName _ n _ _ _) = n
-get_nm msg (ClassName _ n _)    = n
-get_nm msg (ValName   _ n)      = n
-#ifdef DEBUG
-get_nm msg other = pprPanic ("get_nm:"++msg) (ppr PprShowAll other)
--- If match failure, probably on a ClassOpName or Unbound :-(
-#endif
+class NamedThing a where
+    getOccName :: a -> OccName         -- Even RdrNames can do this!
+    getName    :: a -> Name
+
+    getOccName n = nameOccName (getName n)     -- Default method
 \end{code}
 
 \begin{code}
-instance Outputable Name where
-#ifdef DEBUG
-    ppr PprDebug (Short u s)       = pp_debug u s
+modAndOcc          :: NamedThing a => a -> (Module, OccName)
+getModule          :: NamedThing a => a -> Module
+getSrcLoc          :: NamedThing a => a -> SrcLoc
+isLocallyDefined    :: NamedThing a => a -> Bool
+isExported         :: NamedThing a => a -> Bool
+getOccString       :: NamedThing a => a -> String
+
+modAndOcc          = nameModAndOcc        . getName
+getModule          = nameModule           . getName
+isExported         = isExportedName       . getName
+getSrcLoc          = nameSrcLoc           . getName
+isLocallyDefined    = isLocallyDefinedName . getName
+getOccString x     = _UNPK_ (occNameString (getOccName x))
+\end{code}
 
-    ppr PprDebug (TyConName u n _ _ _) = pp_debug u n
-    ppr PprDebug (ClassName u n _)     = pp_debug u n
-    ppr PprDebug (ValName u n)         = pp_debug u n
-#endif
-    ppr sty (Short u s)                  = ppr sty s
-
-    ppr sty (WiredInTyCon tc)    = ppr sty tc
-    ppr sty (WiredInVal   id)    = ppr sty id
-
-    ppr sty (TyConName u n a b c) = ppr sty n
-    ppr sty (ClassName u n c)    = ppr sty n
-    ppr sty (ValName   u n)      = ppr sty n
-
-    ppr sty (ClassOpName u c s i)
-      = let
-           ps = ppPStr s
-       in
-       case sty of
-         PprForUser   -> ps
-         PprInterface -> ps
-         PprDebug     -> ps
-         other        -> ppBesides [ps, ppChar '{',
-                                      ppSep [pprUnique u,
-                                             ppStr "op", ppInt i,
-                                             ppStr "cls", ppr sty c],
-                                      ppChar '}']
-
-    ppr sty (Unbound s) = ppStr ("*UNBOUND*"++ _UNPK_ s)
-
-pp_debug uniq thing
-  = ppBesides [ppr PprDebug thing, ppStr "{-", pprUnique uniq, ppStr "-}" ]
+\begin{code}
+{-# SPECIALIZE isLocallyDefined
+       :: Name     -> Bool
+  #-}
 \end{code}