[project @ 2000-11-14 14:33:02 by simonmar]
[ghc-hetmet.git] / ghc / compiler / basicTypes / Name.lhs
index a11b797..1a0e155 100644 (file)
@@ -10,18 +10,17 @@ module Name (
 
        -- The Name type
        Name,                                   -- Abstract
-       mkLocalName, mkImportedLocalName, mkSysLocalName, mkCCallName,
+       mkLocalName, mkSysLocalName, mkCCallName,
        mkTopName, mkIPName,
        mkDerivedName, mkGlobalName, mkKnownKeyGlobal, mkWiredInName,
 
-       nameUnique, setNameUnique, setLocalNameSort,
+       nameUnique, setNameUnique,
        tidyTopName, 
        nameOccName, nameModule, nameModule_maybe,
        setNameOcc, nameRdrName, setNameModuleAndLoc, 
        toRdrName, hashName,
 
-       isUserExportedName,
-       nameSrcLoc, isLocallyDefinedName, isDllName,
+       nameSrcLoc, nameIsLocallyDefined, isDllName, nameIsFrom, nameIsLocalOrFrom,
 
        isSystemName, isLocalName, isGlobalName, isExternallyVisibleName,
        isTyVarName,
@@ -29,27 +28,27 @@ module Name (
        -- Environment
        NameEnv, mkNameEnv,
        emptyNameEnv, unitNameEnv, nameEnvElts, 
-       extendNameEnv_C, extendNameEnv, 
+       extendNameEnv_C, extendNameEnv, foldNameEnv,
        plusNameEnv, plusNameEnv_C, extendNameEnv, extendNameEnvList,
        lookupNameEnv, lookupNameEnv_NF, delFromNameEnv, elemNameEnv, 
 
 
        -- Class NamedThing and overloaded friends
        NamedThing(..),
-       getSrcLoc, isLocallyDefined, getOccString, toRdrName
+       getSrcLoc, getOccString, toRdrName,
+       isFrom, isLocalOrFrom
     ) where
 
 #include "HsVersions.h"
 
 import OccName         -- All of it
-import Module          ( Module, moduleName, mkVanillaModule, 
-                         printModulePrefix, isModuleInThisPackage )
-import RdrName         ( RdrName, mkRdrQual, mkRdrUnqual, rdrNameOcc, rdrNameModule )
+import Module          ( Module, moduleName, mkVanillaModule, isModuleInThisPackage )
+import RdrName         ( RdrName, mkRdrOrig, mkRdrUnqual, rdrNameOcc, rdrNameModule )
 import CmdLineOpts     ( opt_Static, opt_OmitInterfacePragmas, opt_EnsureSplittableC )
 import SrcLoc          ( builtinSrcLoc, noSrcLoc, SrcLoc )
 import Unique          ( Unique, Uniquable(..), u2i, pprUnique, pprUnique10 )
-import Maybes          ( expectJust )
 import FastTypes
+import Maybes          ( expectJust )
 import UniqFM
 import Outputable
 \end{code}
@@ -70,11 +69,11 @@ data Name = Name {
 
 data NameSort
   = Global Module      -- (a) TyCon, Class, their derived Ids, dfun Id
-                       -- (b) imported Id
-
-  | Exported           -- An exported Ids defined in the module being compiled
+                       -- (b) Imported Id
+                       -- (c) Top-level Id in the original source, even if
+                       --      locally defined
 
-  | Local              -- A user-defined, but non-exported Id or TyVar,
+  | Local              -- A user-defined Id or TyVar
                        -- defined in the module being compiled
 
   | System             -- A system-defined Id or TyVar.  Typically the
@@ -83,17 +82,18 @@ data NameSort
 
 Notes about the NameSorts:
 
-1.  An Exported Id is changed to Global right at the
-    end in the tidyCore pass, so that an importer sees a Global
-    Similarly, Local Ids that are visible to an importer (e.g. when 
-    optimisation is on) are changed to Globals.
+1.  Initially, top-level Ids (including locally-defined ones) get Global names, 
+    and all other local Ids get Local names
 
 2.  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.
 
-3.  A System Name differs in the following ways:
+3.  In the tidy-core phase, a Global that is not visible to an importer
+    is changed to Local, and a Local that is visible is changed to Global
+
+4.  A System Name differs in the following ways:
        a) has unique attached when printing dumps
        b) unifier eliminates sys tyvars in favour of user provs where possible
 
@@ -121,8 +121,9 @@ nameModule_maybe name                               = Nothing
 \end{code}
 
 \begin{code}
-isLocallyDefinedName   :: Name -> Bool
-isUserExportedName     :: Name -> Bool
+nameIsLocallyDefined   :: Name -> Bool
+nameIsFrom             :: Module -> Name -> Bool
+nameIsLocalOrFrom      :: Module -> Name -> Bool
 isLocalName            :: Name -> Bool         -- Not globals
 isGlobalName           :: Name -> Bool
 isSystemName           :: Name -> Bool
@@ -133,16 +134,19 @@ isGlobalName other                        = False
 
 isLocalName name = not (isGlobalName name)
 
-isLocallyDefinedName name = isLocalName name
+nameIsLocallyDefined name = isLocalName name
+
+nameIsLocalOrFrom from (Name {n_sort = Global mod}) = mod == from
+nameIsLocalOrFrom from other                       = True
+
+nameIsFrom from (Name {n_sort = Global mod}) = mod == from
+nameIsFrom from other                       = pprPanic "nameIsFrom" (ppr other)
 
 -- Global names are by definition those that are visible
 -- outside the module, *as seen by the linker*.  Externally visible
--- does not mean visible at the source level (that's isExported).
+-- does not mean visible at the source level
 isExternallyVisibleName name = isGlobalName name
 
-isUserExportedName (Name { n_sort = Exported }) = True
-isUserExportedName other                       = False
-
 isSystemName (Name {n_sort = System}) = True
 isSystemName other                   = False
 \end{code}
@@ -166,18 +170,6 @@ mkLocalName uniq occ loc = Name { n_uniq = uniq, n_sort = Local, n_occ = occ, n_
        --      * for interface files we tidyCore first, which puts the uniques
        --        into the print name (see setNameVisibility below)
 
-mkImportedLocalName :: Unique -> OccName -> SrcLoc -> Name
-       -- Just the same as mkLocalName, except the provenance is different
-       -- Reason: this flags the name as one that came in from an interface 
-       -- file. This is useful when trying to decide which of two type
-       -- variables should 'win' when unifying them.
-       -- NB: this is only for non-top-level names, so we use ImplicitImport
-       --
-       -- Oct 00: now that Names lack Provenances, mkImportedLocalName doesn't make
-       --         sense any more, so it's just the same as mkLocalName
-mkImportedLocalName uniq occ loc = mkLocalName uniq occ loc
-
-
 mkGlobalName :: Unique -> Module -> OccName -> SrcLoc -> Name
 mkGlobalName uniq mod occ loc = Name { n_uniq = uniq, n_sort = Global mod,
                                       n_occ = occ, n_loc = loc }
@@ -233,11 +225,6 @@ setNameModuleAndLoc :: Name -> Module -> SrcLoc -> Name
 setNameModuleAndLoc name mod loc = name {n_sort = set (n_sort name), n_loc = loc}
                       where
                         set (Global _) = Global mod
-
-setLocalNameSort :: Name -> Bool -> Name
-  -- Set the name's sort to Local or Exported, depending on the boolean
-setLocalNameSort name is_exported = name { n_sort = if is_exported then Exported
-                                                                  else Local }
 \end{code}
 
 
@@ -282,23 +269,21 @@ are exported.  But also:
     top-level defns externally visible
 
 \begin{code}
-tidyTopName :: Module -> TidyOccEnv -> Name -> (TidyOccEnv, Name)
-tidyTopName mod env
+tidyTopName :: Module -> TidyOccEnv -> Bool -> Name -> (TidyOccEnv, Name)
+tidyTopName mod env is_exported
            name@(Name { n_occ = occ, n_sort = sort, n_uniq = uniq, n_loc = loc })
   = case sort of
-       System   -> localise            -- System local Ids
-       Local    -> localise            -- User non-exported Ids
-       Exported -> globalise           -- User-exported things
-       Global _ -> no_op               -- Constructors, class selectors etc
-
+       Global _ | is_exported -> (env, name)
+                | otherwise   -> (env, name { n_sort = new_sort })
+               -- Don't change the occurrnce names of globals, because many of them
+               -- are bound by either a class declaration or a data declaration
+               -- or an explicit user export.
+
+       other    | is_exported -> (env', name { n_sort = Global mod, n_occ = occ' })
+                | otherwise   -> (env', name { n_sort = new_sort,   n_occ = occ' })
   where
-    no_op     = (env, name)
-
-    globalise = (env, name { n_sort = Global mod })    -- Don't change occurrence name
-
-    localise     = (env', name')
     (env', occ') = tidyOccName env occ
-    name'        = name { n_occ = occ', n_sort = mkLocalTopSort mod }
+    new_sort     = mkLocalTopSort mod
 
 mkTopName :: Unique -> Module -> FAST_STRING -> Name
        -- Make a top-level name; make it Global if top-level
@@ -342,19 +327,13 @@ hashName name = iBox (u2i (nameUnique name))
 nameRdrName :: Name -> RdrName
 -- Makes a qualified name for top-level (Global) names, whether locally defined or not
 -- and an unqualified name just for Locals
-nameRdrName (Name { n_occ = occ, n_sort = Global mod }) = mkRdrQual (moduleName mod) occ
+nameRdrName (Name { n_occ = occ, n_sort = Global mod }) = mkRdrOrig (moduleName mod) occ
 nameRdrName (Name { n_occ = occ })                     = mkRdrUnqual occ
 
-ifaceNameRdrName :: Name -> RdrName
--- Makes a qualified naem for imported things, 
--- and an unqualified one for local things
-ifaceNameRdrName n | isLocallyDefined n = mkRdrUnqual (nameOccName n)
-                  | otherwise          = mkRdrQual   (moduleName (nameModule n)) (nameOccName n) 
-
 isDllName :: Name -> Bool
        -- Does this name refer to something in a different DLL?
 isDllName nm = not opt_Static &&
-              not (isLocallyDefinedName nm) &&         -- isLocallyDefinedName test needed 'cos
+              not (isLocalName nm) &&                          -- isLocalName test needed 'cos
               not (isModuleInThisPackage (nameModule nm))      -- nameModule won't work on local names
 
 
@@ -418,8 +397,10 @@ unitNameEnv         :: Name -> a -> NameEnv a
 lookupNameEnv           :: NameEnv a -> Name -> Maybe a
 lookupNameEnv_NF :: NameEnv a -> Name -> a
 mapNameEnv      :: (a->b) -> NameEnv a -> NameEnv b
+foldNameEnv     :: (a -> b -> b) -> b -> NameEnv a -> b
 
 emptyNameEnv            = emptyUFM
+foldNameEnv     = foldUFM
 mkNameEnv       = listToUFM
 nameEnvElts             = eltsUFM
 extendNameEnv_C  = addToUFM_C
@@ -448,26 +429,27 @@ instance Outputable Name where
        -- When printing interfaces, all Locals have been given nice print-names
     ppr name = pprName name
 
-pprName (Name {n_sort = sort, n_uniq = uniq, n_occ = occ})
+pprName name@(Name {n_sort = sort, n_uniq = uniq, n_occ = occ})
   = getPprStyle $ \ sty ->
     case sort of
-      Global mod -> pprGlobal sty uniq mod occ
+      Global mod -> pprGlobal sty name uniq mod occ
       System     -> pprSysLocal sty uniq occ
-      Local      -> pprLocal sty uniq occ empty
-      Exported   -> pprLocal sty uniq occ (char 'x')
+      Local      -> pprLocal sty uniq occ
 
-pprLocal sty uniq occ pp_export
+pprLocal sty uniq occ
   | codeStyle sty  = pprUnique uniq
   | debugStyle sty = pprOccName occ <> 
-                    text "{-" <> pp_export <+> pprUnique10 uniq <> text "-}"
+                    text "{-" <> pprUnique10 uniq <> text "-}"
   | otherwise      = pprOccName occ
 
-pprGlobal sty uniq mod occ
-  | codeStyle sty         = ppr (moduleName mod) <> char '_' <> pprOccName occ
-  | debugStyle sty        = ppr (moduleName mod) <> dot <> pprOccName occ <> 
+pprGlobal sty name uniq mod occ
+  | codeStyle sty        = ppr (moduleName mod) <> char '_' <> pprOccName occ
+
+  | debugStyle sty       = ppr (moduleName mod) <> dot <> pprOccName occ <> 
                            text "{-" <> pprUnique10 uniq <> text "-}"
-  | printModulePrefix mod = ppr (moduleName mod) <> dot <> pprOccName occ
-  | otherwise             = pprOccName occ
+
+  | unqualStyle sty name = pprOccName occ
+  | otherwise           = ppr (moduleName mod) <> dot <> pprOccName occ
 
 pprSysLocal sty uniq occ
   | codeStyle sty  = pprUnique uniq
@@ -491,16 +473,15 @@ class NamedThing a where
 
 \begin{code}
 getSrcLoc          :: NamedThing a => a -> SrcLoc
-isLocallyDefined    :: NamedThing a => a -> Bool
 getOccString       :: NamedThing a => a -> String
 toRdrName          :: NamedThing a => a -> RdrName
+isFrom             :: NamedThing a => Module -> a -> Bool
+isLocalOrFrom      :: NamedThing a => Module -> a -> Bool
 
 getSrcLoc          = nameSrcLoc           . getName
-isLocallyDefined    = isLocallyDefinedName . getName
 getOccString       = occNameString        . getOccName
-toRdrName          = ifaceNameRdrName     . getName
+toRdrName          = nameRdrName          . getName
+isFrom mod x       = nameIsFrom mod (getName x)
+isLocalOrFrom mod x = nameIsLocalOrFrom mod ( getName x)
 \end{code}
 
-\begin{code}
-{-# SPECIALIZE isLocallyDefined :: Name -> Bool #-}
-\end{code}