X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2FbasicTypes%2FName.lhs;h=702b07ff158e337f9be61411ef511ae17998a7f8;hb=423d477bfecd490de1449c59325c8776f91d7aac;hp=2dcc009ff7c3f968858d57b98c2e05e436f85044;hpb=d364541154457a49e3c35d671d7a1b57c9c4cca3;p=ghc-hetmet.git diff --git a/ghc/compiler/basicTypes/Name.lhs b/ghc/compiler/basicTypes/Name.lhs index 2dcc009..702b07f 100644 --- a/ghc/compiler/basicTypes/Name.lhs +++ b/ghc/compiler/basicTypes/Name.lhs @@ -10,46 +10,39 @@ module Name ( -- The Name type Name, -- Abstract - mkLocalName, mkSysLocalName, mkCCallName, - mkIPName, - mkDerivedName, mkGlobalName, mkKnownKeyGlobal, mkWiredInName, + mkInternalName, mkSystemName, + mkSystemNameEncoded, mkSysTvName, + mkFCallName, mkIPName, + mkExternalName, mkWiredInName, nameUnique, setNameUnique, - nameOccName, nameModule, nameModule_maybe, - setNameOcc, nameRdrName, setNameModuleAndLoc, - toRdrName, hashName, - globaliseName, localiseName, + nameOccName, nameModule, nameModule_maybe, nameModuleName, + setNameOcc, + hashName, localiseName, - nameSrcLoc, nameIsLocallyDefined, isDllName, nameIsFrom, nameIsLocalOrFrom, + nameSrcLoc, nameParent, nameParent_maybe, - isSystemName, isLocalName, isGlobalName, isExternallyVisibleName, - isTyVarName, + isSystemName, isInternalName, isExternalName, + isTyVarName, isDllName, isWiredInName, + wiredInNameTyThing_maybe, + nameIsLocalOrFrom, isHomePackageName, - -- Environment - NameEnv, mkNameEnv, - emptyNameEnv, unitNameEnv, nameEnvElts, - extendNameEnv_C, extendNameEnv, foldNameEnv, filterNameEnv, - plusNameEnv, plusNameEnv_C, extendNameEnv, extendNameEnvList, - lookupNameEnv, lookupNameEnv_NF, delFromNameEnv, elemNameEnv, - - -- Class NamedThing and overloaded friends NamedThing(..), - getSrcLoc, getOccString, toRdrName, - isFrom, isLocalOrFrom + getSrcLoc, getOccString ) where #include "HsVersions.h" +import {-# SOURCE #-} TypeRep( TyThing ) + import OccName -- All of it -import Module ( Module, moduleName, mkVanillaModule, isHomeModule ) -import RdrName ( RdrName, mkRdrOrig, mkRdrUnqual, rdrNameOcc, rdrNameModule ) +import Module ( Module, ModuleName, moduleName, isHomeModule ) import CmdLineOpts ( opt_Static ) -import SrcLoc ( builtinSrcLoc, noSrcLoc, SrcLoc ) -import Unique ( Unique, Uniquable(..), u2i, pprUnique, pprUnique10 ) +import SrcLoc ( noSrcLoc, wiredInSrcLoc, SrcLoc ) +import Unique ( Unique, Uniquable(..), getKey, pprUnique ) +import Maybes ( orElse ) import FastTypes -import Maybes ( expectJust ) -import UniqFM import Outputable \end{code} @@ -62,18 +55,25 @@ import Outputable \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 } +-- 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. + data NameSort - = Global Module -- (a) TyCon, Class, their derived Ids, dfun Id - -- (b) Imported Id - -- (c) Top-level Id in the original source, even if - -- locally defined + = External Module (Maybe Name) + -- (Just parent) => this Name is a subordinate name of 'parent' + -- e.g. data constructor of a data type, method of a class + -- Nothing => not a subordinate + + | WiredIn Module (Maybe Name) TyThing + -- A variant of External, for wired-in things - | Local -- A user-defined 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 @@ -82,16 +82,16 @@ data NameSort Notes about the NameSorts: -1. Initially, top-level Ids (including locally-defined ones) get Global names, - and all other local Ids get Local names +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 Global that is not visible to an importer - is changed to Local, and a Local that is visible is changed to Global +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 4. A System Name differs in the following ways: a) has unique attached when printing dumps @@ -107,45 +107,65 @@ Notes about the NameSorts: nameUnique :: Name -> Unique nameOccName :: Name -> OccName nameModule :: Name -> Module +nameModuleName :: Name -> ModuleName nameSrcLoc :: Name -> SrcLoc 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 -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 {n_sort = WiredIn _ _ _}) = True +isWiredInName other = False + +wiredInNameTyThing_maybe :: Name -> Maybe TyThing +wiredInNameTyThing_maybe (Name {n_sort = WiredIn _ _ thing}) = Just thing +wiredInNameTyThing_maybe other = Nothing + +isExternalName (Name {n_sort = External _ _}) = True +isExternalName (Name {n_sort = WiredIn _ _ _}) = True +isExternalName other = False + +isInternalName name = not (isExternalName name) -isGlobalName (Name {n_sort = Global _}) = True -isGlobalName other = False +nameParent_maybe :: Name -> Maybe Name +nameParent_maybe (Name {n_sort = External _ p}) = p +nameParent_maybe (Name {n_sort = WiredIn _ p _}) = p +nameParent_maybe other = Nothing -isLocalName name = not (isGlobalName name) +nameParent :: Name -> Name +nameParent name = case nameParent_maybe name of + Just parent -> parent + Nothing -> name -nameIsLocallyDefined name = isLocalName name +nameModule name = nameModule_maybe name `orElse` pprPanic "nameModule" (ppr name) +nameModuleName name = moduleName (nameModule name) -nameIsLocalOrFrom from (Name {n_sort = Global mod}) = mod == from -nameIsLocalOrFrom from other = True +nameModule_maybe (Name { n_sort = External mod _}) = Just mod +nameModule_maybe (Name { n_sort = WiredIn mod _ _}) = Just mod +nameModule_maybe name = Nothing -nameIsFrom from (Name {n_sort = Global mod}) = mod == from -nameIsFrom from other = pprPanic "nameIsFrom" (ppr other) +nameIsLocalOrFrom from name + | isExternalName name = from == nameModule name + | otherwise = True --- 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 -isExternallyVisibleName name = isGlobalName name +isHomePackageName name + | isExternalName name = isHomeModule (nameModule name) + | otherwise = True -- Internal and system names + +isDllName :: Name -> Bool -- Does this name refer to something in a different DLL? +isDllName nm = not opt_Static && not (isHomePackageName nm) + +isTyVarName :: Name -> Bool +isTyVarName name = isTvOcc (nameOccName name) isSystemName (Name {n_sort = System}) = True isSystemName other = False @@ -159,8 +179,8 @@ isSystemName other = False %************************************************************************ \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 @@ -170,42 +190,44 @@ 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) -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 - = mkGlobalName uniq (mkVanillaModule (rdrNameModule rdr_name)) - (rdrNameOcc rdr_name) - builtinSrcLoc +mkExternalName :: Unique -> Module -> OccName -> Maybe Name -> SrcLoc -> Name +mkExternalName uniq mod occ mb_parent loc + = Name { n_uniq = uniq, n_sort = External mod mb_parent, + n_occ = occ, n_loc = loc } -mkWiredInName :: Module -> OccName -> Unique -> Name -mkWiredInName mod occ uniq = mkGlobalName uniq mod occ builtinSrcLoc - -mkSysLocalName :: Unique -> UserFS -> Name -mkSysLocalName uniq fs = Name { n_uniq = uniq, n_sort = System, - n_occ = mkVarOcc fs, n_loc = noSrcLoc } - -mkCCallName :: Unique -> EncodedString -> Name +mkWiredInName :: Module -> OccName -> Unique -> Maybe Name -> TyThing -> Name +mkWiredInName mod occ uniq mb_parent thing + = Name { n_uniq = uniq, + n_sort = WiredIn mod mb_parent thing, + n_occ = occ, n_loc = wiredInSrcLoc } + +mkSystemName :: Unique -> UserFS -> Name +mkSystemName uniq fs = Name { n_uniq = uniq, n_sort = System, + n_occ = mkVarOcc fs, n_loc = noSrcLoc } + +-- 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 } + +mkSysTvName :: Unique -> EncodedFS -> Name +mkSysTvName 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} @@ -217,16 +239,8 @@ setNameUnique name uniq = name {n_uniq = uniq} setNameOcc :: Name -> OccName -> Name 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 +localiseName n = n { n_sort = Internal } \end{code} @@ -238,25 +252,7 @@ setNameModuleAndLoc name mod loc = name {n_sort = set (n_sort name), n_loc = loc \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 }) = mkRdrOrig (moduleName mod) occ -nameRdrName (Name { n_occ = occ }) = mkRdrUnqual occ - -isDllName :: Name -> Bool - -- Does this name refer to something in a different DLL? -isDllName nm = not opt_Static && - 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) +hashName name = getKey (nameUnique name) \end{code} @@ -292,88 +288,47 @@ instance NamedThing Name where %************************************************************************ %* * -\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 -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 -extendNameEnv = addToUFM -plusNameEnv = plusUFM -plusNameEnv_C = plusUFM_C -extendNameEnvList= addListToUFM -delFromNameEnv = delFromUFM -elemNameEnv = elemUFM -mapNameEnv = mapUFM -unitNameEnv = unitUFM -filterNameEnv = filterUFM - -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 +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 name uniq mod occ - System -> pprSysLocal sty uniq occ - Local -> pprLocal sty uniq occ + External mod mb_p -> pprExternal sty name uniq mod occ mb_p False + WiredIn mod mb_p thing -> pprExternal sty name uniq mod occ mb_p True + System -> pprSystem sty uniq occ + Internal -> pprInternal sty uniq occ -pprGlobal sty name uniq mod occ +pprExternal sty name uniq mod occ mb_p is_wired | codeStyle sty = ppr (moduleName mod) <> char '_' <> pprOccName occ - - | debugStyle sty = ppr (moduleName mod) <> dot <> pprOccName occ <> - text "{-" <> pprUnique uniq <> text "-}" - + | debugStyle sty = sep [ppr (moduleName mod) <> dot <> pprOccName occ, + hsep [text "{-" + , if is_wired then ptext SLIT("(w)") else empty + , pprUnique uniq +-- (overkill) , case mb_p of +-- Nothing -> empty +-- Just n -> brackets (ppr n) + , text "-}"]] | unqualStyle sty name = pprOccName occ | otherwise = ppr (moduleName mod) <> dot <> pprOccName occ -pprLocal sty uniq occ +pprInternal sty uniq occ | codeStyle sty = pprUnique uniq - | debugStyle sty = pprOccName occ <> - text "{-" <> pprUnique10 uniq <> text "-}" - | otherwise = pprOccName occ -- User and Iface styles + | debugStyle sty = pprOccName occ <> text "{-" <> pprUnique uniq <> text "-}" + | otherwise = pprOccName occ -- User style --- Like Local, except that we only omit the unique in Iface style -pprSysLocal sty uniq occ +-- Like Internal, except that we only omit the unique in Iface style +pprSystem 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'), @@ -397,14 +352,8 @@ class NamedThing a where \begin{code} getSrcLoc :: NamedThing a => a -> SrcLoc 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 getOccString = occNameString . getOccName -toRdrName = nameRdrName . getName -isFrom mod x = nameIsFrom mod (getName x) -isLocalOrFrom mod x = nameIsLocalOrFrom mod ( getName x) \end{code}