-(c) The University of Glasgow 2002
+(c) The University of Glasgow 2002-2006
\begin{code}
module IfaceEnv (
newGlobalBinder, newIPName, newImplicitBinder,
- lookupIfaceTop, lookupIfaceExt,
- lookupOrig, lookupIfaceTc,
+ lookupIfaceTop,
+ lookupOrig, lookupOrigNameCache, extendNameCache,
newIfaceName, newIfaceNames,
extendIfaceIdEnv, extendIfaceTyVarEnv,
- tcIfaceLclId, tcIfaceTyVar,
+ tcIfaceLclId, tcIfaceTyVar, lookupIfaceTyVar,
+ tcIfaceTick,
- lookupAvail, ifaceExportNames,
+ ifaceExportNames,
-- Name-cache stuff
allocateGlobalBinder, initNameCache,
+ getNameCache, mkNameCacheUpdater, NameCacheUpdater
) where
#include "HsVersions.h"
import TcRnMonad
-import IfaceType ( IfaceExtName(..), IfaceTyCon(..), ifaceTyConName )
-import TysWiredIn ( tupleTyCon, tupleCon )
-import HscTypes ( NameCache(..), HscEnv(..), GenAvailInfo(..),
- IfaceExport, OrigNameCache )
-import Type ( mkOpenTvSubst, substTy )
-import TyCon ( TyCon, tyConName )
-import DataCon ( dataConWorkId, dataConName )
-import Var ( TyVar, Id, varName, setIdType, idType )
-import Name ( Name, nameUnique, nameModule,
- nameOccName, nameSrcLoc,
- getOccName, nameParent_maybe,
- isWiredInName, mkIPName,
- mkExternalName, mkInternalName )
-import NameSet ( NameSet, emptyNameSet, addListToNameSet )
-import OccName ( OccName, isTupleOcc_maybe, tcName, dataName, mapOccEnv, occNameFS,
- lookupOccEnv, unitOccEnv, extendOccEnv, extendOccEnvList )
-import PrelNames ( gHC_PRIM, dATA_TUP )
-import Module ( Module, emptyModuleEnv, ModuleName, modulePackageId,
- lookupModuleEnv, extendModuleEnv_C, mkModule )
-import UniqFM ( lookupUFM, addListToUFM )
-import FastString ( FastString )
-import UniqSupply ( UniqSupply, splitUniqSupply, uniqFromSupply, uniqsFromSupply )
-import FiniteMap ( emptyFM, lookupFM, addToFM )
-import BasicTypes ( IPName(..), mapIPName )
-import SrcLoc ( SrcLoc, noSrcLoc )
+import TysWiredIn
+import HscTypes
+import TyCon
+import DataCon
+import Var
+import Name
+import PrelNames
+import Module
+import UniqFM
+import FastString
+import UniqSupply
+import BasicTypes
+import SrcLoc
+import MkId
import Outputable
+import Exception ( evaluate )
+
+import Data.IORef ( atomicModifyIORef, readIORef )
+import qualified Data.Map as Map
\end{code}
%*********************************************************
\begin{code}
-newGlobalBinder :: Module -> OccName -> Maybe Name -> SrcLoc -> TcRnIf a b Name
+newGlobalBinder :: Module -> OccName -> SrcSpan -> TcRnIf a b Name
-- Used for source code and interface files, to make the
-- Name for a thing, given its Module and OccName
--
-- because we may have seen an occurrence before, but now is the
-- moment when we know its Module and SrcLoc in their full glory
-newGlobalBinder mod occ mb_parent loc
- = do { mod `seq` occ `seq` return () -- See notes with lookupOrig_help
- -- ; traceIf (text "newGlobalBinder" <+> ppr mod <+> ppr occ <+> ppr loc)
- ; name_supply <- getNameCache
- ; let (name_supply', name) = allocateGlobalBinder
- name_supply mod occ
- mb_parent loc
- ; setNameCache name_supply'
- ; return name }
+newGlobalBinder mod occ loc
+ = do mod `seq` occ `seq` return () -- See notes with lookupOrig
+-- traceIf (text "newGlobalBinder" <+> ppr mod <+> ppr occ <+> ppr loc)
+ updNameCache $ \name_cache ->
+ allocateGlobalBinder name_cache mod occ loc
allocateGlobalBinder
:: NameCache
- -> Module -> OccName -> Maybe Name -> SrcLoc
+ -> Module -> OccName -> SrcSpan
-> (NameCache, Name)
-allocateGlobalBinder name_supply mod occ mb_parent loc
+allocateGlobalBinder name_supply mod occ loc
= case lookupOrigNameCache (nsNames name_supply) mod occ of
-- A hit in the cache! We are at the binding site of the name.
- -- This is the moment when we know the defining parent and SrcLoc
- -- of the Name, so we set these fields in the Name we return.
+ -- This is the moment when we know the SrcLoc
+ -- of the Name, so we set this field in the Name we return.
--
-- Then (bogus) multiple bindings of the same Name
-- get different SrcLocs can can be reported as such.
| otherwise -> (new_name_supply, name')
where
uniq = nameUnique name
- name' = mkExternalName uniq mod occ mb_parent loc
- new_cache = extend_name_cache (nsNames name_supply) mod occ name'
+ name' = mkExternalName uniq mod occ loc
+ new_cache = extendNameCache (nsNames name_supply) mod occ name'
new_name_supply = name_supply {nsNames = new_cache}
-- Miss in the cache!
-- Build a completely new Name, and put it in the cache
Nothing -> (new_name_supply, name)
where
- (us', us1) = splitUniqSupply (nsUniqs name_supply)
- uniq = uniqFromSupply us1
- name = mkExternalName uniq mod occ mb_parent loc
- new_cache = extend_name_cache (nsNames name_supply) mod occ name
+ (uniq, us') = takeUniqFromSupply (nsUniqs name_supply)
+ name = mkExternalName uniq mod occ loc
+ new_cache = extendNameCache (nsNames name_supply) mod occ name
new_name_supply = name_supply {nsUniqs = us', nsNames = new_cache}
-- Called in BuildTyCl to allocate the implicit binders of type/class decls
-- For source type/class decls, this is the first occurrence
-- For iface ones, the LoadIface has alrady allocated a suitable name in the cache
---
--- An *implicit* name has the base-name as parent
newImplicitBinder base_name mk_sys_occ
- = newGlobalBinder (nameModule base_name)
- (mk_sys_occ (nameOccName base_name))
- (Just parent_name)
- (nameSrcLoc base_name)
- where
- parent_name = case nameParent_maybe base_name of
- Just parent_name -> parent_name
- Nothing -> base_name
-
-ifaceExportNames :: [IfaceExport] -> TcRnIf gbl lcl NameSet
-ifaceExportNames exports
- = foldlM do_one emptyNameSet exports
+ | Just mod <- nameModule_maybe base_name
+ = newGlobalBinder mod occ loc
+ | otherwise -- When typechecking a [d| decl bracket |],
+ -- TH generates types, classes etc with Internal names,
+ -- so we follow suit for the implicit binders
+ = do { uniq <- newUnique
+ ; return (mkInternalName uniq occ loc) }
where
- do_one acc (mod, exports) = foldlM (do_avail mod) acc exports
- do_avail mod acc avail = do { ns <- lookupAvail mod avail
- ; return (addListToNameSet acc ns) }
-
-lookupAvail :: Module -> GenAvailInfo OccName -> TcRnIf a b [Name]
--- Find all the names arising from an import
--- Make sure the parent info is correct, even though we may not
--- yet have read the interface for this module
-lookupAvail mod (Avail n) = do { n' <- lookupOrig mod n;
- ; return [n'] }
-lookupAvail mod (AvailTC p_occ occs)
- = do { p_name <- lookupOrig mod p_occ
- ; let lookup_sub occ | occ == p_occ = return p_name
- | otherwise = lookup_orig mod occ (Just p_name)
- ; mappM lookup_sub occs }
+ occ = mk_sys_occ (nameOccName base_name)
+ loc = nameSrcSpan base_name
+
+ifaceExportNames :: [IfaceExport] -> TcRnIf gbl lcl [AvailInfo]
+ifaceExportNames exports = do
+ mod_avails <- mapM (\(mod,avails) -> mapM (lookupAvail mod) avails) exports
+ return (concat mod_avails)
+
+-- Convert OccNames in GenAvailInfo to Names.
+lookupAvail :: Module -> GenAvailInfo OccName -> TcRnIf a b AvailInfo
+lookupAvail mod (Avail n) = do
+ n' <- lookupOrig mod n
+ return (Avail n')
+lookupAvail mod (AvailTC p_occ occs) = do
+ p_name <- lookupOrig mod p_occ
+ let lookup_sub occ | occ == p_occ = return p_name
+ | otherwise = lookupOrig mod occ
+ subs <- mapM lookup_sub occs
+ return (AvailTC p_name subs)
-- Remember that 'occs' is all the exported things, including
-- the parent. It's possible to export just class ops without
- -- the class, via C( op ). If the class was exported too we'd
- -- have C( C, op )
-
- -- The use of lookupOrigSub here (rather than lookupOrig)
- -- ensures that the subordinate names record their parent;
- -- and that in turn ensures that the GlobalRdrEnv
- -- has the correct parent for all the names in its range.
- -- For imported things, we may only suck in the interface later, if ever.
- -- Reason for all this:
- -- Suppose module M exports type A.T, and constructor A.MkT
- -- Then, we know that A.MkT is a subordinate name of A.T,
- -- even though we aren't at the binding site of A.T
- -- And it's important, because we may simply re-export A.T
- -- without ever sucking in the declaration itself.
-
-
-lookupOrig :: Module -> OccName -> TcRnIf a b Name
--- Even if we get a miss in the original-name cache, we
--- make a new External Name.
--- We fake up
--- SrcLoc to noSrcLoc
--- Parent no Nothing
--- They'll be overwritten, in due course, by LoadIface.loadDecl.
-lookupOrig mod occ = lookup_orig mod occ Nothing
-
-lookup_orig :: Module -> OccName -> Maybe Name -> TcRnIf a b Name
--- Used when we know the parent of the thing we are looking up
-lookup_orig mod occ mb_parent
+ -- the class, which shows up as C( op ) here. If the class was
+ -- exported too we'd have C( C, op )
+
+lookupOrig :: Module -> OccName -> TcRnIf a b Name
+lookupOrig mod occ
= do { -- First ensure that mod and occ are evaluated
-- If not, chaos can ensue:
-- we read the name-cache
-- which does some stuff that modifies the name cache
-- This did happen, with tycon_mod in TcIface.tcIfaceAlt (DataAlt..)
mod `seq` occ `seq` return ()
-
- ; name_supply <- getNameCache
- ; case lookupOrigNameCache (nsNames name_supply) mod occ of {
- Just name -> returnM name ;
- Nothing -> do
-
- { let { (us', us1) = splitUniqSupply (nsUniqs name_supply)
- ; uniq = uniqFromSupply us1
- ; name = mkExternalName uniq mod occ mb_parent noSrcLoc
- ; new_cache = extend_name_cache (nsNames name_supply) mod occ name
- ; new_name_supply = name_supply {nsUniqs = us', nsNames = new_cache}
- }
- ; setNameCache new_name_supply
- ; return name }
- }}
+-- ; traceIf (text "lookup_orig" <+> ppr mod <+> ppr occ)
+
+ ; updNameCache $ \name_cache ->
+ case lookupOrigNameCache (nsNames name_cache) mod occ of {
+ Just name -> (name_cache, name);
+ Nothing ->
+ case takeUniqFromSupply (nsUniqs name_cache) of {
+ (uniq, us) ->
+ let
+ name = mkExternalName uniq mod occ noSrcSpan
+ new_cache = extendNameCache (nsNames name_cache) mod occ name
+ in (name_cache{ nsUniqs = us, nsNames = new_cache }, name)
+ }}}
newIPName :: IPName OccName -> TcRnIf m n (IPName Name)
-newIPName occ_name_ip
- = getNameCache `thenM` \ name_supply ->
+newIPName occ_name_ip =
+ updNameCache $ \name_cache ->
let
- ipcache = nsIPs name_supply
+ ipcache = nsIPs name_cache
+ key = occ_name_ip -- Ensures that ?x and %x get distinct Names
in
- case lookupFM ipcache key of
- Just name_ip -> returnM name_ip
- Nothing -> setNameCache new_ns `thenM_`
- returnM name_ip
- where
- (us', us1) = splitUniqSupply (nsUniqs name_supply)
- uniq = uniqFromSupply us1
- name_ip = mapIPName (mkIPName uniq) occ_name_ip
- new_ipcache = addToFM ipcache key name_ip
- new_ns = name_supply {nsUniqs = us', nsIPs = new_ipcache}
- where
- key = occ_name_ip -- Ensures that ?x and %x get distinct Names
+ case Map.lookup key ipcache of
+ Just name_ip -> (name_cache, name_ip)
+ Nothing -> (new_ns, name_ip)
+ where
+ (uniq, us') = takeUniqFromSupply (nsUniqs name_cache)
+ name_ip = mapIPName (mkIPName uniq) occ_name_ip
+ new_ipcache = Map.insert key name_ip ipcache
+ new_ns = name_cache {nsUniqs = us', nsIPs = new_ipcache}
\end{code}
- Local helper functions (not exported)
+%************************************************************************
+%* *
+ Name cache access
+%* *
+%************************************************************************
\begin{code}
lookupOrigNameCache :: OrigNameCache -> Module -> OccName -> Maybe Name
-lookupOrigNameCache nc mod occ
- | mod == dATA_TUP || mod == gHC_PRIM, -- Boxed tuples from one,
+lookupOrigNameCache _ mod occ
+ -- XXX Why is gHC_UNIT not mentioned here?
+ | mod == gHC_TUPLE || mod == gHC_PRIM, -- Boxed tuples from one,
Just tup_info <- isTupleOcc_maybe occ -- unboxed from the other
= -- Special case for tuples; there are too many
-- of them to pre-populate the original-name cache
mk_tup_name (ns, boxity, arity)
| ns == tcName = tyConName (tupleTyCon boxity arity)
| ns == dataName = dataConName (tupleCon boxity arity)
- | otherwise = varName (dataConWorkId (tupleCon boxity arity))
+ | otherwise = Var.varName (dataConWorkId (tupleCon boxity arity))
lookupOrigNameCache nc mod occ -- The normal case
= case lookupModuleEnv nc mod of
extendOrigNameCache :: OrigNameCache -> Name -> OrigNameCache
extendOrigNameCache nc name
- = extend_name_cache nc (nameModule name) (nameOccName name) name
+ = ASSERT2( isExternalName name, ppr name )
+ extendNameCache nc (nameModule name) (nameOccName name) name
-extend_name_cache :: OrigNameCache -> Module -> OccName -> Name -> OrigNameCache
-extend_name_cache nc mod occ name
- = extendModuleEnv_C combine nc mod (unitOccEnv occ name)
+extendNameCache :: OrigNameCache -> Module -> OccName -> Name -> OrigNameCache
+extendNameCache nc mod occ name
+ = extendModuleEnvWith combine nc mod (unitOccEnv occ name)
where
- combine occ_env _ = extendOccEnv occ_env occ name
+ combine _ occ_env = extendOccEnv occ_env occ name
getNameCache :: TcRnIf a b NameCache
getNameCache = do { HscEnv { hsc_NC = nc_var } <- getTopEnv;
readMutVar nc_var }
-setNameCache :: NameCache -> TcRnIf a b ()
-setNameCache nc = do { HscEnv { hsc_NC = nc_var } <- getTopEnv;
- writeMutVar nc_var nc }
+updNameCache :: (NameCache -> (NameCache, c)) -> TcRnIf a b c
+updNameCache upd_fn = do
+ HscEnv { hsc_NC = nc_var } <- getTopEnv
+ atomicUpdMutVar' nc_var upd_fn
+
+-- | A function that atomically updates the name cache given a modifier
+-- function. The second result of the modifier function will be the result
+-- of the IO action.
+type NameCacheUpdater c = (NameCache -> (NameCache, c)) -> IO c
+
+-- | Return a function to atomically update the name cache.
+mkNameCacheUpdater :: TcRnIf a b (NameCacheUpdater c)
+mkNameCacheUpdater = do
+ nc_var <- hsc_NC `fmap` getTopEnv
+ let update_nc f = do r <- atomicModifyIORef nc_var f
+ _ <- evaluate =<< readIORef nc_var
+ return r
+ return update_nc
\end{code}
initNameCache us names
= NameCache { nsUniqs = us,
nsNames = initOrigNames names,
- nsIPs = emptyFM }
+ nsIPs = Map.empty }
initOrigNames :: [Name] -> OrigNameCache
initOrigNames names = foldl extendOrigNameCache emptyModuleEnv names
Nothing -> failIfM (text "Iface type variable out of scope: " <+> ppr occ)
}
+lookupIfaceTyVar :: FastString -> IfL (Maybe TyVar)
+lookupIfaceTyVar occ
+ = do { lcl <- getLclEnv
+ ; return (lookupUFM (if_tv_env lcl) occ) }
+
extendIfaceTyVarEnv :: [TyVar] -> IfL a -> IfL a
extendIfaceTyVarEnv tyvars thing_inside
= do { env <- getLclEnv
%************************************************************************
\begin{code}
-lookupIfaceTc :: IfaceTyCon -> IfL Name
-lookupIfaceTc (IfaceTc ext) = lookupIfaceExt ext
-lookupIfaceTc other_tc = return (ifaceTyConName other_tc)
-
-lookupIfaceExt :: IfaceExtName -> IfL Name
-lookupIfaceExt (ExtPkg mod occ) = lookupOrig mod occ
-lookupIfaceExt (HomePkg mod occ _) = lookupHomePackage mod occ
-lookupIfaceExt (LocalTop occ) = lookupIfaceTop occ
-lookupIfaceExt (LocalTopSub occ _) = lookupIfaceTop occ
-
lookupIfaceTop :: OccName -> IfL Name
-- Look up a top-level name from the current Iface module
lookupIfaceTop occ
= do { env <- getLclEnv; lookupOrig (if_mod env) occ }
-lookupHomePackage :: ModuleName -> OccName -> IfL Name
-lookupHomePackage mod_name occ
- = do { env <- getLclEnv;
- ; let this_pkg = modulePackageId (if_mod env)
- ; lookupOrig (mkModule this_pkg mod_name) occ }
-
newIfaceName :: OccName -> IfL Name
newIfaceName occ
= do { uniq <- newUnique
- ; return $! mkInternalName uniq occ noSrcLoc }
+ ; return $! mkInternalName uniq occ noSrcSpan }
newIfaceNames :: [OccName] -> IfL [Name]
newIfaceNames occs
= do { uniqs <- newUniqueSupply
- ; return [ mkInternalName uniq occ noSrcLoc
+ ; return [ mkInternalName uniq occ noSrcSpan
| (occ,uniq) <- occs `zip` uniqsFromSupply uniqs] }
\end{code}
+
+%************************************************************************
+%* *
+ (Re)creating tick boxes
+%* *
+%************************************************************************
+
+\begin{code}
+tcIfaceTick :: Module -> Int -> IfL Id
+tcIfaceTick modName tickNo
+ = do { uniq <- newUnique
+ ; return $ mkTickBoxOpId uniq modName tickNo
+ }
+\end{code}
+
+