-- The Name type
Name, -- Abstract
- mkLocalName, mkImportedLocalName, mkSysLocalName, mkCCallName,
- mkTopName, mkIPName,
- mkDerivedName, mkGlobalName, mkKnownKeyGlobal, mkWiredInName,
+ mkInternalName, mkSystemName,
+ mkSystemNameEncoded, mkSystemTvNameEncoded, mkFCallName,
+ mkIPName,
+ mkExternalName, mkKnownKeyExternalName, mkWiredInName,
- nameUnique, setNameUnique, setLocalNameSort,
- tidyTopName,
+ nameUnique, setNameUnique,
nameOccName, nameModule, nameModule_maybe,
- setNameOcc, nameRdrName, setNameModuleAndLoc,
- toRdrName, hashName,
+ setNameOcc, setNameSrcLoc,
+ hashName, externaliseName, localiseName,
- isUserExportedName,
- nameSrcLoc, nameIsLocallyDefined, isDllName, nameIsFrom, nameIsLocalOrFrom,
+ nameSrcLoc, eqNameByOcc,
- isSystemName, isLocalName, isGlobalName, isExternallyVisibleName,
- isTyVarName,
+ isSystemName, isInternalName, isExternalName,
+ isTyVarName, isDllName, isWiredInName,
+ nameIsLocalOrFrom, isHomePackageName,
- -- Environment
- NameEnv, mkNameEnv,
- emptyNameEnv, unitNameEnv, nameEnvElts,
- extendNameEnv_C, extendNameEnv,
- plusNameEnv, plusNameEnv_C, extendNameEnv, extendNameEnvList,
- lookupNameEnv, lookupNameEnv_NF, delFromNameEnv, elemNameEnv,
-
-
-- Class NamedThing and overloaded friends
NamedThing(..),
- getSrcLoc, isLocallyDefined, getOccString, toRdrName,
- isFrom, isLocalOrFrom
+ getSrcLoc, getOccString
) where
#include "HsVersions.h"
import OccName -- All of it
-import Module ( Module, moduleName, mkVanillaModule,
- printModulePrefix, isModuleInThisPackage )
-import RdrName ( RdrName, mkRdrQual, 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 Module ( Module, moduleName, isHomeModule )
+import CmdLineOpts ( opt_Static )
+import SrcLoc ( noSrcLoc, isWiredInLoc, wiredInSrcLoc, SrcLoc )
+import Unique ( Unique, Uniquable(..), getKey, pprUnique )
import FastTypes
-import UniqFM
import Outputable
\end{code}
\begin{code}
data Name = Name {
n_sort :: NameSort, -- What sort of name it is
- n_occ :: OccName, -- Its occurrence name
+ n_occ :: !OccName, -- Its occurrence name
n_uniq :: Unique,
- n_loc :: SrcLoc -- Definition site
+ n_loc :: !SrcLoc -- Definition site
}
-data NameSort
- = Global Module -- (a) TyCon, Class, their derived Ids, dfun Id
- -- (b) imported Id
+-- NOTE: we make the n_loc field strict to eliminate some potential
+-- (and real!) space leaks, due to the fact that we don't look at
+-- the SrcLoc in a Name all that often.
- | Exported -- An exported Ids defined in the module being compiled
+data NameSort
+ = External Module -- (a) TyCon, Class, their derived Ids, dfun Id
+ -- (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,
+ | Internal -- A user-defined Id or TyVar
-- defined in the module being compiled
| System -- A system-defined Id or TyVar. Typically the
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 External names,
+ and all other local Ids get Internal names
-2. Things with a @Global@ name are given C static labels, so they finally
+2. Things with a External 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.
+ must be made @External@ first.
+
+3. In the tidy-core phase, a External that is not visible to an importer
+ is changed to Internal, and a Internal that is visible is changed to External
-3. A System Name differs in the following ways:
+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
nameUnique name = n_uniq name
nameOccName name = n_occ name
nameSrcLoc name = n_loc name
-
-nameModule (Name { n_sort = Global mod }) = mod
-nameModule name = pprPanic "nameModule" (ppr name)
-
-nameModule_maybe (Name { n_sort = Global mod }) = Just mod
-nameModule_maybe name = Nothing
\end{code}
\begin{code}
-nameIsLocallyDefined :: Name -> Bool
-nameIsFrom :: Module -> Name -> Bool
-nameIsLocalOrFrom :: Module -> Name -> Bool
-isUserExportedName :: Name -> Bool
-isLocalName :: Name -> Bool -- Not globals
-isGlobalName :: Name -> Bool
-isSystemName :: Name -> Bool
-isExternallyVisibleName :: Name -> Bool
+nameIsLocalOrFrom :: Module -> Name -> Bool
+isInternalName :: Name -> Bool
+isExternalName :: Name -> Bool
+isSystemName :: Name -> Bool
+isHomePackageName :: Name -> Bool
+isWiredInName :: Name -> Bool
+
+isWiredInName name = isWiredInLoc (n_loc name)
+
+isExternalName (Name {n_sort = External _}) = True
+isExternalName other = False
-isGlobalName (Name {n_sort = Global _}) = True
-isGlobalName other = False
+nameModule (Name { n_sort = External mod }) = mod
+nameModule name = pprPanic "nameModule" (ppr name)
-isLocalName name = not (isGlobalName name)
+nameModule_maybe (Name { n_sort = External mod }) = Just mod
+nameModule_maybe name = Nothing
-nameIsLocallyDefined name = isLocalName name
+isInternalName name = not (isExternalName name)
-nameIsLocalOrFrom from (Name {n_sort = Global mod}) = mod == from
-nameIsLocalOrFrom from other = True
+nameIsLocalOrFrom from (Name {n_sort = External mod}) = mod == from
+nameIsLocalOrFrom from other = True
-nameIsFrom from (Name {n_sort = Global mod}) = mod == from
-nameIsFrom from other = pprPanic "nameIsFrom" (ppr other)
+isHomePackageName (Name {n_sort = External mod}) = isHomeModule mod
+isHomePackageName other = True -- Internal and system names
--- 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 isUserExported).
-isExternallyVisibleName name = isGlobalName name
+isDllName :: Name -> Bool -- Does this name refer to something in a different DLL?
+isDllName nm = not opt_Static && not (isHomePackageName nm)
--- Constructors, selectors and suchlike Globals, and are all exported
--- Other Local things may or may not be exported
-isUserExportedName (Name { n_sort = Exported }) = True
-isUserExportedName (Name { n_sort = Global _ }) = True
-isUserExportedName other = False
+isTyVarName :: Name -> Bool
+isTyVarName name = isTvOcc (nameOccName name)
isSystemName (Name {n_sort = System}) = True
isSystemName other = False
+
+eqNameByOcc :: Name -> Name -> Bool
+-- Compare using the strings, not the unique
+-- See notes with HsCore.eq_ufVar
+eqNameByOcc (Name {n_sort = sort1, n_occ = occ1})
+ (Name {n_sort = sort2, n_occ = occ2})
+ = sort1 `eq_sort` sort2 && occ1 == occ2
+ where
+ eq_sort (External m1) (External m2) = moduleName m1 == moduleName m2
+ eq_sort (External _) _ = False
+ eq_sort _ (External _) = False
+ eq_sort _ _ = True
\end{code}
%************************************************************************
\begin{code}
-mkLocalName :: Unique -> OccName -> SrcLoc -> Name
-mkLocalName uniq occ loc = Name { n_uniq = uniq, n_sort = Local, n_occ = occ, n_loc = loc }
+mkInternalName :: Unique -> OccName -> SrcLoc -> Name
+mkInternalName uniq occ loc = Name { n_uniq = uniq, n_sort = Internal, n_occ = occ, n_loc = loc }
-- NB: You might worry that after lots of huffing and
-- puffing we might end up with two local names with distinct
-- uniques, but the same OccName. Indeed we can, but that's ok
-- * 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 }
-
+mkExternalName :: Unique -> Module -> OccName -> SrcLoc -> Name
+mkExternalName uniq mod occ loc = Name { n_uniq = uniq, n_sort = External mod,
+ n_occ = occ, n_loc = loc }
-mkKnownKeyGlobal :: RdrName -> Unique -> Name
-mkKnownKeyGlobal rdr_name uniq
- = mkGlobalName uniq (mkVanillaModule (rdrNameModule rdr_name))
- (rdrNameOcc rdr_name)
- builtinSrcLoc
+mkKnownKeyExternalName :: Module -> OccName -> Unique -> Name
+mkKnownKeyExternalName mod occ uniq
+ = mkExternalName uniq mod occ noSrcLoc
mkWiredInName :: Module -> OccName -> Unique -> Name
-mkWiredInName mod occ uniq = mkGlobalName uniq mod occ builtinSrcLoc
+mkWiredInName mod occ uniq = mkExternalName uniq mod occ wiredInSrcLoc
-mkSysLocalName :: Unique -> UserFS -> Name
-mkSysLocalName uniq fs = Name { n_uniq = uniq, n_sort = System,
- n_occ = mkVarOcc fs, n_loc = noSrcLoc }
+mkSystemName :: Unique -> UserFS -> Name
+mkSystemName uniq fs = Name { n_uniq = uniq, n_sort = System,
+ n_occ = mkVarOcc fs, n_loc = noSrcLoc }
-mkCCallName :: Unique -> EncodedString -> Name
+-- Use this version when the string is already encoded. Avoids duplicating
+-- the string each time a new name is created.
+mkSystemNameEncoded :: Unique -> EncodedFS -> Name
+mkSystemNameEncoded uniq fs = Name { n_uniq = uniq, n_sort = System,
+ n_occ = mkSysOccFS varName fs,
+ n_loc = noSrcLoc }
+
+mkSystemTvNameEncoded :: Unique -> EncodedFS -> Name
+mkSystemTvNameEncoded uniq fs = Name { n_uniq = uniq, n_sort = System,
+ n_occ = mkSysOccFS tvName fs,
+ n_loc = noSrcLoc }
+
+mkFCallName :: Unique -> EncodedString -> Name
-- The encoded string completely describes the ccall
-mkCCallName uniq str = Name { n_uniq = uniq, n_sort = Local,
- n_occ = mkCCallOcc str, n_loc = noSrcLoc }
+mkFCallName uniq str = Name { n_uniq = uniq, n_sort = Internal,
+ n_occ = mkFCallOcc str, n_loc = noSrcLoc }
mkIPName :: Unique -> OccName -> Name
mkIPName uniq occ
= Name { n_uniq = uniq,
- n_sort = Local,
+ n_sort = Internal,
n_occ = occ,
n_loc = noSrcLoc }
-
----------------------------------------------------------------------
-mkDerivedName :: (OccName -> OccName)
- -> Name -- Base name
- -> Unique -- New unique
- -> Name -- Result is always a value name
-
-mkDerivedName f name uniq = name {n_uniq = uniq, n_occ = f (n_occ name)}
\end{code}
\begin{code}
setNameUnique name uniq = name {n_uniq = uniq}
setNameOcc :: Name -> OccName -> Name
- -- Give the thing a new OccName, *and*
- -- record that it's no longer a sys-local
- -- This is used by the tidy-up pass
setNameOcc name occ = name {n_occ = occ}
-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}
-
-
-%************************************************************************
-%* *
-\subsection{Tidying a name}
-%* *
-%************************************************************************
-
-tidyTopName is applied to top-level names in the final program
-
-For top-level things,
- it globalises Local names
- (if all top-level things should be visible)
- and localises non-exported Global names
- (if only exported things should be visible)
-
-In all cases except an exported global, it gives it a new occurrence name.
-
-The "visibility" here concerns whether the .o file's symbol table
-mentions the thing; if so, it needs a module name in its symbol.
-The Global things are "visible" and the Local ones are not
-
-Why should things be "visible"? Certainly they must be if they
-are exported. But also:
-
-(a) In certain (prelude only) modules we split up the .hc file into
- lots of separate little files, which are separately compiled by the C
- compiler. That gives lots of little .o files. The idea is that if
- you happen to mention one of them you don't necessarily pull them all
- in. (Pulling in a piece you don't need can be v bad, because it may
- mention other pieces you don't need either, and so on.)
-
- Sadly, splitting up .hc files means that local names (like s234) are
- now globally visible, which can lead to clashes between two .hc
- files. So unlocaliseWhatnot goes through making all the local things
- into global things, essentially by giving them full names so when they
- are printed they'll have their module name too. Pretty revolting
- really.
-
-(b) When optimisation is on we want to make all the internal
- top-level defns externally visible
-
-\begin{code}
-tidyTopName :: Module -> TidyOccEnv -> Name -> (TidyOccEnv, Name)
-tidyTopName mod env
- 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
-
- 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 }
-
-mkTopName :: Unique -> Module -> FAST_STRING -> Name
- -- Make a top-level name; make it Global if top-level
- -- things should be externally visible; Local otherwise
- -- This chap is only used *after* the tidyCore phase
- -- Notably, it is used during STG lambda lifting
- --
- -- We have to make sure that the name is globally unique
- -- and we don't have tidyCore to help us. So we append
- -- the unique. Hack! Hack!
- -- (Used only by the STG lambda lifter.)
-mkTopName uniq mod fs
- = Name { n_uniq = uniq,
- n_sort = mkLocalTopSort mod,
- n_occ = mkVarOcc (_PK_ ((_UNPK_ fs) ++ show uniq)),
- n_loc = noSrcLoc }
-
-mkLocalTopSort :: Module -> NameSort
-mkLocalTopSort mod
- | all_toplev_ids_visible = Global mod
- | otherwise = Local
-
-all_toplev_ids_visible
- = not opt_OmitInterfacePragmas || -- Pragmas can make them visible
- opt_EnsureSplittableC -- Splitting requires visiblilty
+externaliseName :: Name -> Module -> Name
+externaliseName n mod = n { n_sort = External mod }
+
+localiseName :: Name -> Name
+localiseName n = n { n_sort = Internal }
+
+setNameSrcLoc :: Name -> SrcLoc -> Name
+setNameSrcLoc name loc = name {n_loc = loc}
\end{code}
-
%************************************************************************
%* *
\subsection{Predicates and selectors}
\begin{code}
hashName :: Name -> Int
-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 }) = 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 (nameIsLocallyDefined nm) && -- isLocallyDefinedName test needed 'cos
- not (isModuleInThisPackage (nameModule nm)) -- nameModule won't work on local names
-
-
-
-isTyVarName :: Name -> Bool
-isTyVarName name = isTvOcc (nameOccName name)
-
+hashName name = iBox (getKey (nameUnique name))
\end{code}
%************************************************************************
%* *
-\subsection{Name environment}
-%* *
-%************************************************************************
-
-\begin{code}
-type NameEnv a = UniqFM a -- Domain is Name
-
-emptyNameEnv :: NameEnv a
-mkNameEnv :: [(Name,a)] -> NameEnv a
-nameEnvElts :: NameEnv a -> [a]
-extendNameEnv_C :: (a->a->a) -> NameEnv a -> Name -> a -> NameEnv a
-extendNameEnv :: NameEnv a -> Name -> a -> NameEnv a
-plusNameEnv :: NameEnv a -> NameEnv a -> NameEnv a
-plusNameEnv_C :: (a->a->a) -> NameEnv a -> NameEnv a -> NameEnv a
-extendNameEnvList:: NameEnv a -> [(Name,a)] -> NameEnv a
-delFromNameEnv :: NameEnv a -> Name -> NameEnv a
-elemNameEnv :: Name -> NameEnv a -> Bool
-unitNameEnv :: Name -> a -> NameEnv a
-lookupNameEnv :: NameEnv a -> Name -> Maybe a
-lookupNameEnv_NF :: NameEnv a -> Name -> a
-mapNameEnv :: (a->b) -> NameEnv a -> NameEnv b
-
-emptyNameEnv = emptyUFM
-mkNameEnv = listToUFM
-nameEnvElts = eltsUFM
-extendNameEnv_C = addToUFM_C
-extendNameEnv = addToUFM
-plusNameEnv = plusUFM
-plusNameEnv_C = plusUFM_C
-extendNameEnvList= addListToUFM
-delFromNameEnv = delFromUFM
-elemNameEnv = elemUFM
-mapNameEnv = mapUFM
-unitNameEnv = unitUFM
-
-lookupNameEnv = lookupUFM
-lookupNameEnv_NF env n = expectJust "lookupNameEnv_NF" (lookupUFM env n)
-\end{code}
-
-
-%************************************************************************
-%* *
\subsection{Pretty printing}
%* *
%************************************************************************
\begin{code}
instance Outputable Name where
- -- When printing interfaces, all Locals have been given nice print-names
+ -- When printing interfaces, all Internals have been given nice print-names
ppr name = pprName name
-pprName (Name {n_sort = sort, n_uniq = uniq, n_occ = occ})
+instance OutputableBndr Name where
+ pprBndr _ name = pprName name
+
+pprName name@(Name {n_sort = sort, n_uniq = uniq, n_occ = occ})
= getPprStyle $ \ sty ->
case sort of
- Global mod -> pprGlobal sty uniq mod occ
- System -> pprSysLocal sty uniq occ
- Local -> pprLocal sty uniq occ empty
- Exported -> pprLocal sty uniq occ (char 'x')
+ External mod -> pprExternal sty name uniq mod occ
+ System -> pprSystem sty uniq occ
+ Internal -> pprInternal sty uniq occ
-pprLocal sty uniq occ pp_export
+pprExternal sty name uniq mod occ
+ | codeStyle sty = ppr (moduleName mod) <> char '_' <> pprOccName occ
+ | debugStyle sty = ppr (moduleName mod) <> dot <> ppr_debug_occ uniq occ
+ | unqualStyle sty name = pprOccName occ
+ | otherwise = ppr (moduleName mod) <> dot <> pprOccName occ
+
+pprInternal sty uniq occ
| codeStyle sty = pprUnique uniq
- | debugStyle sty = pprOccName occ <>
- text "{-" <> pp_export <+> 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 <>
- text "{-" <> pprUnique10 uniq <> text "-}"
- | printModulePrefix mod = ppr (moduleName mod) <> dot <> pprOccName occ
- | otherwise = pprOccName occ
-
-pprSysLocal sty uniq occ
+ | debugStyle sty = ppr_debug_occ uniq occ
+ | otherwise = pprOccName occ -- User style
+
+-- Like Internal, except that we only omit the unique in Iface style
+pprSystem sty uniq occ
| codeStyle sty = pprUnique uniq
| otherwise = pprOccName occ <> char '_' <> pprUnique uniq
-\end{code}
+ -- If the tidy phase hasn't run, the OccName
+ -- is unlikely to be informative (like 's'),
+ -- so print the unique
+ppr_debug_occ uniq occ = hsep [pprOccName occ, text "{-",
+ text (briefOccNameFlavour occ),
+ pprUnique uniq, text "-}"]
+\end{code}
%************************************************************************
%* *
\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 = nameIsLocallyDefined . getName
getOccString = occNameString . getOccName
-toRdrName = ifaceNameRdrName . 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}
projects / ghc-hetmet.git / blobdiff