-- The Name type
Name, -- Abstract
- mkLocalName, mkImportedLocalName, mkSysLocalName, mkCCallName,
- mkTopName, mkIPName,
- mkDerivedName, mkGlobalName, mkKnownKeyGlobal, mkWiredInName,
+ mkLocalName, mkSysLocalName, mkCCallName,
+ mkIPName,
+ mkGlobalName, mkKnownKeyGlobal, mkWiredInName,
- nameUnique, setNameUnique, setLocalNameSort,
- tidyTopName,
- nameOccName, nameModule, setNameOcc, nameRdrName, setNameModuleAndLoc,
- toRdrName, hashName,
+ nameUnique, setNameUnique,
+ nameOccName, nameModule, nameModule_maybe,
+ setNameOcc, nameRdrName, setNameModuleAndLoc,
+ toRdrName, hashName,
+ globaliseName, localiseName,
- isUserExportedName,
- nameSrcLoc, isLocallyDefinedName, isDllName,
+ nameSrcLoc, nameIsLocallyDefined, isDllName, nameIsFrom, nameIsLocalOrFrom,
isSystemName, isLocalName, isGlobalName, isExternallyVisibleName,
isTyVarName,
-- Environment
NameEnv, mkNameEnv,
emptyNameEnv, unitNameEnv, nameEnvElts,
- extendNameEnv_C, extendNameEnv,
+ extendNameEnv_C, extendNameEnv, foldNameEnv, filterNameEnv,
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,
- isModuleInThisPackage )
-import RdrName ( RdrName, mkRdrQual, mkRdrUnqual, rdrNameOcc,
- rdrNameModule )
-import CmdLineOpts ( opt_Static, opt_PprStyle_NoPrags,
- opt_OmitInterfacePragmas, opt_EnsureSplittableC )
-
+import Module ( Module, moduleName, mkVanillaModule, isHomeModule )
+import RdrName ( RdrName, mkRdrOrig, mkRdrUnqual, rdrNameOcc, rdrNameModule )
+import CmdLineOpts ( opt_Static )
import SrcLoc ( builtinSrcLoc, noSrcLoc, SrcLoc )
-import Unique ( Unique, Uniquable(..), u2i, pprUnique )
-import Maybes ( expectJust )
+import Unique ( Unique, Uniquable(..), u2i, pprUnique, pprUnique10 )
import FastTypes
+import Maybes ( expectJust )
import UniqFM
import Outputable
\end{code}
data NameSort
= Global Module -- (a) TyCon, Class, their derived Ids, dfun Id
- -- (b) imported Id
+ -- (b) Imported Id
+ -- (c) Top-level Id in the original source, even if
+ -- locally defined
- | Exported -- An exported Ids defined in the module being compiled
-
- | 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
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
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}
-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
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}
-- * 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 }
-
mkKnownKeyGlobal :: RdrName -> Unique -> Name
mkKnownKeyGlobal rdr_name uniq
mkCCallName uniq str = Name { n_uniq = uniq, n_sort = Local,
n_occ = mkCCallOcc str, n_loc = noSrcLoc }
-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 = mk_top_sort mod,
- n_occ = mkVarOcc (_PK_ ((_UNPK_ fs) ++ show uniq)),
- n_loc = noSrcLoc }
-
mkIPName :: Unique -> OccName -> Name
mkIPName uniq occ
= Name { n_uniq = uniq,
n_sort = Local,
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}
+globaliseName :: Name -> Module -> Name
+globaliseName n mod = n { n_sort = Global mod }
+
+localiseName :: Name -> Name
+localiseName n = n { n_sort = Local }
+
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
- = (env', name')
- where
- (env', occ') = tidyOccName env (n_occ name)
-
- name' = Name { n_uniq = n_uniq name, n_sort = mk_top_sort mod,
- n_occ = occ', n_loc = n_loc name }
-
-mk_top_sort 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
-\end{code}
-
-
-
-%************************************************************************
-%* *
\subsection{Predicates and selectors}
%* *
%************************************************************************
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 (isModuleInThisPackage (nameModule nm)) -- nameModule won't work on local names
+ not (isLocalName nm) && -- isLocalName test needed 'cos
+ not (isHomeModule (nameModule nm)) -- nameModule won't work on local names
isTyVarName :: Name -> Bool
isTyVarName name = isTvOcc (nameOccName name)
-
\end{code}
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
+filterNameEnv :: (elt -> Bool) -> NameEnv elt -> NameEnv elt
emptyNameEnv = emptyUFM
+foldNameEnv = foldUFM
mkNameEnv = listToUFM
nameEnvElts = eltsUFM
extendNameEnv_C = addToUFM_C
elemNameEnv = elemUFM
mapNameEnv = mapUFM
unitNameEnv = unitUFM
+filterNameEnv = filterUFM
lookupNameEnv = lookupUFM
lookupNameEnv_NF env n = expectJust "lookupNameEnv_NF" (lookupUFM env n)
-- 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 ->
- let local | debugStyle sty
- = pprOccName occ <> text "{-" <> pprUnique uniq <> text "-}"
- | codeStyle sty
- = pprUnique uniq
- | otherwise
- = pprOccName occ
-
- global m | codeStyle sty
- = ppr (moduleName m) <> char '_' <> pprOccName occ
- | debugStyle sty || not (isModuleInThisPackage m)
- = ppr (moduleName m) <> dot <> pprOccName occ
- | otherwise
- = pprOccName occ
- in case sort of
- System -> local
- Local -> local
- Exported -> local
- Global mod -> global mod
+ case sort of
+ Global mod -> pprGlobal sty name uniq mod occ
+ System -> pprSysLocal sty uniq occ
+ Local -> pprLocal sty uniq occ
+
+pprGlobal sty name uniq mod occ
+ | codeStyle sty = ppr (moduleName mod) <> char '_' <> pprOccName occ
+
+ | debugStyle sty = ppr (moduleName mod) <> dot <> pprOccName occ <>
+ text "{-" <> pprUnique uniq <> text "-}"
+
+ | unqualStyle sty name = pprOccName occ
+ | otherwise = ppr (moduleName mod) <> dot <> pprOccName occ
+
+pprLocal sty uniq occ
+ | codeStyle sty = pprUnique uniq
+ | debugStyle sty = pprOccName occ <>
+ text "{-" <> pprUnique10 uniq <> text "-}"
+ | otherwise = pprOccName occ -- User and Iface styles
+
+-- Like Local, except that we only omit the unique in Iface style
+pprSysLocal sty uniq occ
+ | codeStyle sty = pprUnique uniq
+ | ifaceStyle sty = pprOccName occ -- The tidy phase has ensured that OccNames
+ -- are enough
+ | otherwise = pprOccName occ <> char '_' <> pprUnique uniq
+ -- If the tidy phase hasn't run, the OccName
+ -- is unlikely to be informative (like 's'),
+ -- so print the unique
\end{code}
-
%************************************************************************
%* *
\subsection{Overloaded functions related to Names}
\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}
projects / ghc-hetmet.git / blobdiff