-%
-% (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
-%
-\section[RnNames]{Extracting imported and top-level names in scope}
-
-\begin{code}
-#include "HsVersions.h"
-
-module RnNames (
- getGlobalNames,
- GlobalNameInfo(..)
- ) where
-
-import PreludeGlaST ( returnPrimIO, thenPrimIO, MutableVar(..) )
-
-import Ubiq
-
-import HsSyn
-import RdrHsSyn
-import RnHsSyn
-
-import RnMonad
-import RnIfaces ( IfaceCache(..), cacheInterface, ParsedIface )
-import RnUtils ( RnEnv(..), emptyRnEnv, extendGlobalRnEnv, qualNameErr, dupNamesErr )
-
-import Bag ( emptyBag, unitBag, unionBags, unionManyBags, mapBag, listToBag, bagToList )
-import ErrUtils ( Error(..), Warning(..), addShortErrLocLine )
-import FiniteMap ( fmToList )
-import Name ( RdrName(..), isQual, mkTopLevName, mkImportedName, nameExportFlag, Name )
-import Outputable ( getLocalName, getSrcLoc, pprNonOp )
-import PrelInfo ( BuiltinNames(..), BuiltinKeys(..) )
-import PrelMods ( fromPrelude )
-import Pretty
-import SrcLoc ( SrcLoc )
-import UniqSupply ( splitUniqSupply )
-import Util ( equivClasses, panic )
-\end{code}
-
-
-\begin{code}
-type GlobalNameInfo = (BuiltinNames,
- BuiltinKeys,
- Name -> ExportFlag,
- Name -> [RdrName])
-
-type RnM_Info s r = RnMonad GlobalNameInfo s r
-
-getGlobalNames ::
- IfaceCache
- -> GlobalNameInfo
- -> UniqSupply
- -> RdrNameHsModule
- -> PrimIO (RnEnv,
- [Module],
- Bag RenamedFixityDecl,
- Bag Error,
- Bag Warning)
-
-getGlobalNames iface_var info us
- (HsModule mod _ _ imports _ ty_decls _ cls_decls _ _ _ binds _ _)
- = case initRn True mod emptyRnEnv us1
- (setExtraRn info $
- getSourceNames ty_decls cls_decls binds)
- of { ((src_vals, src_tcs), src_errs, src_warns) ->
-
- getImportedNames iface_var info us2 imports `thenPrimIO`
- \ (imp_vals, imp_tcs, imp_mods, imp_fixes, imp_errs, imp_warns) ->
-
- let
- unqual_vals = mapBag (\rn -> (Unqual (getLocalName rn), rn)) src_vals
- unqual_tcs = mapBag (\rn -> (Unqual (getLocalName rn), rn)) src_tcs
-
- all_vals = bagToList (unqual_vals `unionBags` imp_vals)
- all_tcs = bagToList (unqual_tcs `unionBags` imp_tcs)
-
- (all_env, dups) = extendGlobalRnEnv emptyRnEnv all_vals all_tcs
-
- dup_errs = map dup_err (equivClasses cmp_rdr (bagToList dups))
- cmp_rdr (rdr1,_,_) (rdr2,_,_) = cmp rdr1 rdr2
- dup_err ((rdr,rn,rn'):rest) = globalDupNamesErr rdr (rn:rn': [rn|(_,_,rn)<-rest])
-
- all_errs = src_errs `unionBags` imp_errs `unionBags` listToBag dup_errs
- all_warns = src_warns `unionBags` imp_warns
- in
- returnPrimIO (all_env, bagToList imp_mods, imp_fixes, all_errs, all_warns)
- }
- where
- (us1, us2) = splitUniqSupply us
-\end{code}
-
-*********************************************************
-* *
-\subsection{Top-level source names}
-* *
-*********************************************************
-
-\begin{code}
-getSourceNames ::
- [RdrNameTyDecl]
- -> [RdrNameClassDecl]
- -> RdrNameHsBinds
- -> RnM_Info s (Bag RnName, -- values
- Bag RnName) -- tycons/classes
-
-getSourceNames ty_decls cls_decls binds
- = mapAndUnzipRn getTyDeclNames ty_decls `thenRn` \ (tycon_s, constrs_s) ->
- mapAndUnzipRn getClassNames cls_decls `thenRn` \ (cls_s, cls_ops_s) ->
- getTopBindsNames binds `thenRn` \ bind_names ->
- returnRn (unionManyBags constrs_s `unionBags`
- unionManyBags cls_ops_s `unionBags` bind_names,
- listToBag tycon_s `unionBags` listToBag cls_s)
-
-
-getTyDeclNames :: RdrNameTyDecl
- -> RnM_Info s (RnName, Bag RnName) -- tycon and constrs
-
-getTyDeclNames (TyData _ tycon _ condecls _ _ src_loc)
- = newGlobalName src_loc Nothing tycon `thenRn` \ tycon_name ->
- mapRn (getConDeclName (Just (nameExportFlag tycon_name)))
- condecls `thenRn` \ con_names ->
- returnRn (RnData tycon_name con_names,
- listToBag (map (\ n -> RnConstr n tycon_name) con_names))
-
-getTyDeclNames (TyNew _ tycon _ condecls _ _ src_loc)
- = newGlobalName src_loc Nothing tycon `thenRn` \ tycon_name ->
- mapRn (getConDeclName (Just (nameExportFlag tycon_name)))
- condecls `thenRn` \ con_names ->
- returnRn (RnData tycon_name con_names,
- listToBag (map (\ n -> RnConstr n tycon_name) con_names))
-
-getTyDeclNames (TySynonym tycon _ _ src_loc)
- = newGlobalName src_loc Nothing tycon `thenRn` \ tycon_name ->
- returnRn (RnSyn tycon_name, emptyBag)
-
-getConDeclName exp (ConDecl con _ src_loc)
- = newGlobalName src_loc exp con
-getConDeclName exp (ConOpDecl _ op _ src_loc)
- = newGlobalName src_loc exp op
-getConDeclName exp (NewConDecl con _ src_loc)
- = newGlobalName src_loc exp con
-getConDeclName exp (RecConDecl con fields src_loc)
- = panic "getConDeclName:RecConDecl"
- newGlobalName src_loc exp con
-
-
-getClassNames :: RdrNameClassDecl
- -> RnM_Info s (RnName, Bag RnName) -- class and class ops
-
-getClassNames (ClassDecl _ cname _ sigs _ _ src_loc)
- = newGlobalName src_loc Nothing cname `thenRn` \ class_name ->
- getClassOpNames (Just (nameExportFlag class_name))
- sigs `thenRn` \ op_names ->
- returnRn (RnClass class_name op_names,
- listToBag (map (\ n -> RnClassOp n class_name) op_names))
-
-getClassOpNames exp []
- = returnRn []
-getClassOpNames exp (ClassOpSig op _ _ src_loc : sigs)
- = newGlobalName src_loc exp op `thenRn` \ op_name ->
- getClassOpNames exp sigs `thenRn` \ op_names ->
- returnRn (op_name : op_names)
-getClassOpNames exp (_ : sigs)
- = getClassOpNames exp sigs
-\end{code}
-
-*********************************************************
-* *
-\subsection{Bindings}
-* *
-*********************************************************
-
-\begin{code}
-getTopBindsNames :: RdrNameHsBinds
- -> RnM_Info s (Bag RnName)
-
-getTopBindsNames binds = doBinds binds
-
-doBinds EmptyBinds = returnRn emptyBag
-doBinds (SingleBind bind) = doBind bind
-doBinds (BindWith bind sigs) = doBind bind
-doBinds (ThenBinds binds1 binds2)
- = andRn unionBags (doBinds binds1) (doBinds binds2)
-
-doBind EmptyBind = returnRn emptyBag
-doBind (NonRecBind mbind) = doMBinds mbind
-doBind (RecBind mbind) = doMBinds mbind
-
-doMBinds EmptyMonoBinds = returnRn emptyBag
-doMBinds (PatMonoBind pat grhss_and_binds locn) = doPat locn pat
-doMBinds (FunMonoBind p_name _ locn) = doName locn p_name
-doMBinds (AndMonoBinds mbinds1 mbinds2)
- = andRn unionBags (doMBinds mbinds1) (doMBinds mbinds2)
-
-doPats locn pats
- = mapRn (doPat locn) pats `thenRn` \ pats_s ->
- returnRn (unionManyBags pats_s)
-
-doPat locn WildPatIn = returnRn emptyBag
-doPat locn (LitPatIn _) = returnRn emptyBag
-doPat locn (LazyPatIn pat) = doPat locn pat
-doPat locn (VarPatIn var) = doName locn var
-doPat locn (NegPatIn pat) = doPat locn pat
-doPat locn (ParPatIn pat) = doPat locn pat
-doPat locn (ListPatIn pats) = doPats locn pats
-doPat locn (TuplePatIn pats) = doPats locn pats
-doPat locn (ConPatIn name pats) = doPats locn pats
-doPat locn (ConOpPatIn p1 op p2)
- = andRn unionBags (doPat locn p1) (doPat locn p2)
-doPat locn (AsPatIn as_name pat)
- = andRn unionBags (doName locn as_name) (doPat locn pat)
-doPat locn (RecPatIn name fields)
- = mapRn (doField locn) fields `thenRn` \ fields_s ->
- returnRn (unionManyBags fields_s)
-
-doField locn (field, _, True{-pun-}) = doName locn field
-doField locn (field, pat, _) = doPat locn pat
-
-doName locn rdr
- = newGlobalName locn Nothing rdr `thenRn` \ name ->
- returnRn (unitBag (RnName name))
-\end{code}
-
-*********************************************************
-* *
-\subsection{Creating a new global name}
-* *
-*********************************************************
-
-\begin{code}
-newGlobalName :: SrcLoc -> Maybe ExportFlag
- -> RdrName -> RnM_Info s Name
-
-newGlobalName locn maybe_exp rdr
- = getExtraRn `thenRn` \ (_,_,exp_fn,occ_fn) ->
- getModuleRn `thenRn` \ mod ->
- getSourceRn `thenRn` \ source ->
- rnGetUnique `thenRn` \ u ->
- let
- src_unqual = getLocalName rdr
-
- src_orig = if fromPrelude mod
- then (Unqual src_unqual)
- else (Qual mod src_unqual)
-
- exp = case maybe_exp of
- Just exp -> exp
- Nothing -> exp_fn n
-
- n = if source then
- mkTopLevName u src_orig locn exp (occ_fn n)
- else
- mkImportedName u rdr locn exp (occ_fn n)
- in
- addErrIfRn (source && isQual rdr)
- (qualNameErr "name in definition" (rdr, locn)) `thenRn_`
- returnRn n
-\end{code}
-
-*********************************************************
-* *
-\subsection{Imported names}
-* *
-*********************************************************
-
-\begin{code}
-getImportedNames ::
- IfaceCache
- -> GlobalNameInfo -- builtin and knot name info
- -> UniqSupply
- -> [RdrNameImportDecl] -- import declarations
- -> PrimIO (Bag (RdrName,RnName), -- imported values in scope
- Bag (RdrName,RnName), -- imported tycons/classes in scope
- Bag Module, -- directly imported modules
- Bag RenamedFixityDecl, -- fixity info for imported names
- Bag Error,
- Bag Warning)
-
-getImportedNames iface_var info us imports
- = returnPrimIO (builtin_vals, builtin_tcs, emptyBag, emptyBag, emptyBag, emptyBag)
- where
- -- For now jsut add the builtin names ...
- (b_names,_,_,_) = info
- builtin_vals = listToBag [(Unqual s, rn) | (s,rn) <- fmToList b_names, not (isRnTyCon rn)]
- builtin_tcs = listToBag [(Unqual s, rn) | (s,rn) <- fmToList b_names, isRnTyCon rn]
-\end{code}
-
-
-\begin{code}
-globalDupNamesErr rdr rns sty
- = ppHang (ppBesides [pprNonOp sty rdr, ppStr " multiply defined:"])
- 4 (ppAboves (map pp_def rns))
- where
- pp_def rn = addShortErrLocLine (getSrcLoc rn) (\ sty -> ppr sty rn) sty
-
- -- ToDo: print import src locs for imported names
-\end{code}
+%\r
+% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998\r
+%\r
+\section[RnNames]{Extracting imported and top-level names in scope}\r
+\r
+\begin{code}\r
+module RnNames (\r
+ getGlobalNames\r
+ ) where\r
+\r
+#include "HsVersions.h"\r
+\r
+import CmdLineOpts ( opt_NoImplicitPrelude, opt_WarnDuplicateExports, \r
+ opt_SourceUnchanged, opt_WarnUnusedBinds\r
+ )\r
+\r
+import HsSyn ( HsModule(..), HsDecl(..), TyClDecl(..),\r
+ IE(..), ieName, \r
+ ForeignDecl(..), ForKind(..), isDynamic,\r
+ FixitySig(..), Sig(..), ImportDecl(..),\r
+ collectTopBinders\r
+ )\r
+import RdrHsSyn ( RdrNameIE, RdrNameImportDecl,\r
+ RdrNameHsModule, RdrNameHsDecl\r
+ )\r
+import RnIfaces ( getInterfaceExports, getDeclBinders,\r
+ recordSlurp, checkUpToDate\r
+ )\r
+import RnEnv\r
+import RnMonad\r
+\r
+import FiniteMap\r
+import PrelMods\r
+import PrelInfo ( main_RDR )\r
+import UniqFM ( lookupUFM )\r
+import Bag ( bagToList )\r
+import Maybes ( maybeToBool )\r
+import Module ( ModuleName, mkThisModule, pprModuleName, WhereFrom(..) )\r
+import NameSet\r
+import Name ( Name, ExportFlag(..), ImportReason(..), Provenance(..),\r
+ isLocallyDefined, setNameProvenance,\r
+ nameOccName, getSrcLoc, pprProvenance, getNameProvenance\r
+ )\r
+import RdrName ( RdrName, rdrNameOcc, mkRdrQual, mkRdrUnqual, isQual )\r
+import SrcLoc ( SrcLoc )\r
+import NameSet ( elemNameSet, emptyNameSet )\r
+import Outputable\r
+import Unique ( getUnique )\r
+import Util ( removeDups, equivClassesByUniq, sortLt )\r
+import List ( partition )\r
+\end{code}\r
+\r
+\r
+\r
+%************************************************************************\r
+%* *\r
+\subsection{Get global names}\r
+%* *\r
+%************************************************************************\r
+\r
+\begin{code}\r
+getGlobalNames :: RdrNameHsModule\r
+ -> RnMG (Maybe (ExportEnv, \r
+ GlobalRdrEnv,\r
+ FixityEnv, -- Fixities for local decls only\r
+ NameEnv AvailInfo -- Maps a name to its parent AvailInfo\r
+ -- Just for in-scope things only\r
+ ))\r
+ -- Nothing => no need to recompile\r
+\r
+getGlobalNames (HsModule this_mod _ exports imports decls mod_loc)\r
+ = -- These two fix-loops are to get the right\r
+ -- provenance information into a Name\r
+ fixRn (\ ~(rec_gbl_env, rec_exported_avails, _) ->\r
+\r
+ let\r
+ rec_unqual_fn :: Name -> Bool -- Is this chap in scope unqualified?\r
+ rec_unqual_fn = unQualInScope rec_gbl_env\r
+\r
+ rec_exp_fn :: Name -> ExportFlag\r
+ rec_exp_fn = mk_export_fn (availsToNameSet rec_exported_avails)\r
+ in\r
+ setModuleRn this_mod $\r
+\r
+ -- PROCESS LOCAL DECLS\r
+ -- Do these *first* so that the correct provenance gets\r
+ -- into the global name cache.\r
+ importsFromLocalDecls this_mod rec_exp_fn decls `thenRn` \ (local_gbl_env, local_mod_avails) ->\r
+\r
+ -- PROCESS IMPORT DECLS\r
+ -- Do the non {- SOURCE -} ones first, so that we get a helpful\r
+ -- warning for {- SOURCE -} ones that are unnecessary\r
+ let\r
+ (source, ordinary) = partition is_source_import all_imports\r
+ is_source_import (ImportDecl _ ImportByUserSource _ _ _ _) = True\r
+ is_source_import other = False\r
+ in\r
+ mapAndUnzipRn (importsFromImportDecl rec_unqual_fn) ordinary `thenRn` \ (imp_gbl_envs1, imp_avails_s1) ->\r
+ mapAndUnzipRn (importsFromImportDecl rec_unqual_fn) source `thenRn` \ (imp_gbl_envs2, imp_avails_s2) ->\r
+\r
+ -- COMBINE RESULTS\r
+ -- We put the local env second, so that a local provenance\r
+ -- "wins", even if a module imports itself.\r
+ let\r
+ gbl_env :: GlobalRdrEnv\r
+ imp_gbl_env = foldr plusGlobalRdrEnv emptyRdrEnv (imp_gbl_envs2 ++ imp_gbl_envs1)\r
+ gbl_env = imp_gbl_env `plusGlobalRdrEnv` local_gbl_env\r
+\r
+ all_avails :: ExportAvails\r
+ all_avails = foldr plusExportAvails local_mod_avails (imp_avails_s2 ++ imp_avails_s1)\r
+ in\r
+\r
+ -- TRY FOR EARLY EXIT\r
+ -- We can't go for an early exit before this because we have to check\r
+ -- for name clashes. Consider:\r
+ --\r
+ -- module A where module B where\r
+ -- import B h = True\r
+ -- f = h\r
+ --\r
+ -- Suppose I've compiled everything up, and then I add a\r
+ -- new definition to module B, that defines "f".\r
+ --\r
+ -- Then I must detect the name clash in A before going for an early\r
+ -- exit. The early-exit code checks what's actually needed from B\r
+ -- to compile A, and of course that doesn't include B.f. That's\r
+ -- why we wait till after the plusEnv stuff to do the early-exit.\r
+ checkEarlyExit this_mod `thenRn` \ up_to_date ->\r
+ if up_to_date then\r
+ returnRn (gbl_env, junk_exp_fn, Nothing)\r
+ else\r
+ \r
+ -- RECORD BETTER PROVENANCES IN THE CACHE\r
+ -- The names in the envirnoment have better provenances (e.g. imported on line x)\r
+ -- than the names in the name cache. We update the latter now, so that we\r
+ -- we start renaming declarations we'll get the good names\r
+ -- The isQual is because the qualified name is always in scope\r
+ updateProvenances (concat [names | (rdr_name, names) <- rdrEnvToList imp_gbl_env, \r
+ isQual rdr_name]) `thenRn_`\r
+\r
+ -- PROCESS EXPORT LISTS\r
+ exportsFromAvail this_mod exports all_avails gbl_env `thenRn` \ exported_avails ->\r
+\r
+ -- DONE\r
+ returnRn (gbl_env, exported_avails, Just all_avails)\r
+ ) `thenRn` \ (gbl_env, exported_avails, maybe_stuff) ->\r
+\r
+ case maybe_stuff of {\r
+ Nothing -> returnRn Nothing ;\r
+ Just all_avails ->\r
+\r
+ traceRn (text "updateProv" <+> fsep (map ppr (rdrEnvElts gbl_env))) `thenRn_`\r
+ \r
+ -- DEAL WITH FIXITIES\r
+ fixitiesFromLocalDecls gbl_env decls `thenRn` \ local_fixity_env ->\r
+ let\r
+ -- Export only those fixities that are for names that are\r
+ -- (a) defined in this module\r
+ -- (b) exported\r
+ exported_fixities :: [(Name,Fixity)]\r
+ exported_fixities = [(name,fixity) | FixitySig name fixity _ <- nameEnvElts local_fixity_env,\r
+ isLocallyDefined name\r
+ ]\r
+ in\r
+ traceRn (text "fixity env" <+> vcat (map ppr (nameEnvElts local_fixity_env))) `thenRn_`\r
+\r
+ --- TIDY UP \r
+ let\r
+ export_env = ExportEnv exported_avails exported_fixities\r
+ (_, global_avail_env) = all_avails\r
+ in\r
+ returnRn (Just (export_env, gbl_env, local_fixity_env, global_avail_env))\r
+ }\r
+ where\r
+ junk_exp_fn = error "RnNames:export_fn"\r
+\r
+ all_imports = prel_imports ++ imports\r
+\r
+ -- NB: opt_NoImplicitPrelude is slightly different to import Prelude ();\r
+ -- because the former doesn't even look at Prelude.hi for instance declarations,\r
+ -- whereas the latter does.\r
+ prel_imports | this_mod == pRELUDE_Name ||\r
+ explicit_prelude_import ||\r
+ opt_NoImplicitPrelude\r
+ = []\r
+\r
+ | otherwise = [ImportDecl pRELUDE_Name\r
+ ImportByUser\r
+ False {- Not qualified -}\r
+ Nothing {- No "as" -}\r
+ Nothing {- No import list -}\r
+ mod_loc]\r
+ \r
+ explicit_prelude_import\r
+ = not (null [ () | (ImportDecl mod _ _ _ _ _) <- imports, mod == pRELUDE_Name ])\r
+\end{code}\r
+ \r
+\begin{code}\r
+checkEarlyExit mod\r
+ = checkErrsRn `thenRn` \ no_errs_so_far ->\r
+ if not no_errs_so_far then\r
+ -- Found errors already, so exit now\r
+ returnRn True\r
+ else\r
+\r
+ traceRn (text "Considering whether compilation is required...") `thenRn_`\r
+ if not opt_SourceUnchanged then\r
+ -- Source code changed and no errors yet... carry on \r
+ traceRn (nest 4 (text "source file changed or recompilation check turned off")) `thenRn_` \r
+ returnRn False\r
+ else\r
+\r
+ -- Unchanged source, and no errors yet; see if usage info\r
+ -- up to date, and exit if so\r
+ checkUpToDate mod `thenRn` \ up_to_date ->\r
+ putDocRn (text "Compilation" <+> \r
+ text (if up_to_date then "IS NOT" else "IS") <+>\r
+ text "required") `thenRn_`\r
+ returnRn up_to_date\r
+\end{code}\r
+ \r
+\begin{code}\r
+importsFromImportDecl :: (Name -> Bool) -- OK to omit qualifier\r
+ -> RdrNameImportDecl\r
+ -> RnMG (GlobalRdrEnv, \r
+ ExportAvails) \r
+\r
+importsFromImportDecl is_unqual (ImportDecl imp_mod_name from qual_only as_mod import_spec iloc)\r
+ = pushSrcLocRn iloc $\r
+ getInterfaceExports imp_mod_name from `thenRn` \ (imp_mod, avails) ->\r
+\r
+ if null avails then\r
+ -- If there's an error in getInterfaceExports, (e.g. interface\r
+ -- file not found) we get lots of spurious errors from 'filterImports'\r
+ returnRn (emptyRdrEnv, mkEmptyExportAvails imp_mod_name)\r
+ else\r
+\r
+ filterImports imp_mod_name import_spec avails `thenRn` \ (filtered_avails, hides, explicits) ->\r
+\r
+ -- We 'improve' the provenance by setting\r
+ -- (a) the import-reason field, so that the Name says how it came into scope\r
+ -- including whether it's explicitly imported\r
+ -- (b) the print-unqualified field\r
+ -- But don't fiddle with wired-in things or we get in a twist\r
+ let\r
+ improve_prov name = setNameProvenance name (NonLocalDef (UserImport imp_mod iloc (is_explicit name)) \r
+ (is_unqual name))\r
+ is_explicit name = name `elemNameSet` explicits\r
+ in\r
+ qualifyImports imp_mod_name\r
+ (not qual_only) -- Maybe want unqualified names\r
+ as_mod hides\r
+ filtered_avails improve_prov `thenRn` \ (rdr_name_env, mod_avails) ->\r
+\r
+ returnRn (rdr_name_env, mod_avails)\r
+\end{code}\r
+\r
+\r
+\begin{code}\r
+importsFromLocalDecls mod_name rec_exp_fn decls\r
+ = mapRn (getLocalDeclBinders newLocalName) decls `thenRn` \ avails_s ->\r
+\r
+ let\r
+ avails = concat avails_s\r
+\r
+ all_names :: [Name] -- All the defns; no dups eliminated\r
+ all_names = [name | avail <- avails, name <- availNames avail]\r
+\r
+ dups :: [[Name]]\r
+ dups = filter non_singleton (equivClassesByUniq getUnique all_names)\r
+ where\r
+ non_singleton (x1:x2:xs) = True\r
+ non_singleton other = False\r
+ in\r
+ -- Check for duplicate definitions\r
+ mapRn_ (addErrRn . dupDeclErr) dups `thenRn_` \r
+\r
+ -- Record that locally-defined things are available\r
+ mapRn_ (recordSlurp Nothing) avails `thenRn_`\r
+\r
+ -- Build the environment\r
+ qualifyImports mod_name \r
+ True -- Want unqualified names\r
+ Nothing -- no 'as M'\r
+ [] -- Hide nothing\r
+ avails\r
+ (\n -> n)\r
+\r
+ where\r
+ newLocalName rdr_name loc = newLocalTopBinder mod (rdrNameOcc rdr_name)\r
+ rec_exp_fn loc\r
+ mod = mkThisModule mod_name\r
+\r
+getLocalDeclBinders :: (RdrName -> SrcLoc -> RnMG Name) -- New-name function\r
+ -> RdrNameHsDecl\r
+ -> RnMG Avails\r
+getLocalDeclBinders new_name (ValD binds)\r
+ = mapRn do_one (bagToList (collectTopBinders binds))\r
+ where\r
+ do_one (rdr_name, loc) = new_name rdr_name loc `thenRn` \ name ->\r
+ returnRn (Avail name)\r
+\r
+ -- foreign declarations\r
+getLocalDeclBinders new_name (ForD (ForeignDecl nm kind _ dyn _ loc))\r
+ | binds_haskell_name kind dyn\r
+ = new_name nm loc `thenRn` \ name ->\r
+ returnRn [Avail name]\r
+\r
+ | otherwise\r
+ = returnRn []\r
+\r
+getLocalDeclBinders new_name decl\r
+ = getDeclBinders new_name decl `thenRn` \ maybe_avail ->\r
+ case maybe_avail of\r
+ Nothing -> returnRn [] -- Instance decls and suchlike\r
+ Just avail -> returnRn [avail]\r
+\r
+binds_haskell_name (FoImport _) _ = True\r
+binds_haskell_name FoLabel _ = True\r
+binds_haskell_name FoExport ext_nm = isDynamic ext_nm\r
+\r
+fixitiesFromLocalDecls :: GlobalRdrEnv -> [RdrNameHsDecl] -> RnMG FixityEnv\r
+fixitiesFromLocalDecls gbl_env decls\r
+ = foldlRn getFixities emptyNameEnv decls\r
+ where\r
+ getFixities :: FixityEnv -> RdrNameHsDecl -> RnMG FixityEnv\r
+ getFixities acc (FixD fix)\r
+ = fix_decl acc fix\r
+\r
+ getFixities acc (TyClD (ClassDecl _ _ _ sigs _ _ _ _ _ _))\r
+ = foldlRn fix_decl acc [sig | FixSig sig <- sigs]\r
+ -- Get fixities from class decl sigs too.\r
+ getFixities acc other_decl\r
+ = returnRn acc\r
+\r
+ fix_decl acc sig@(FixitySig rdr_name fixity loc)\r
+ = -- Check for fixity decl for something not declared\r
+ case lookupRdrEnv gbl_env rdr_name of {\r
+ Nothing | opt_WarnUnusedBinds \r
+ -> pushSrcLocRn loc (addWarnRn (unusedFixityDecl rdr_name fixity)) `thenRn_`\r
+ returnRn acc \r
+ | otherwise -> returnRn acc ;\r
+ \r
+ Just (name:_) ->\r
+\r
+ -- Check for duplicate fixity decl\r
+ case lookupNameEnv acc name of {\r
+ Just (FixitySig _ _ loc') -> addErrRn (dupFixityDecl rdr_name loc loc') `thenRn_`\r
+ returnRn acc ;\r
+\r
+ Nothing -> returnRn (addToNameEnv acc name (FixitySig name fixity loc))\r
+ }}\r
+\end{code}\r
+\r
+%************************************************************************\r
+%* *\r
+\subsection{Filtering imports}\r
+%* *\r
+%************************************************************************\r
+\r
+@filterImports@ takes the @ExportEnv@ telling what the imported module makes\r
+available, and filters it through the import spec (if any).\r
+\r
+\begin{code}\r
+filterImports :: ModuleName -- The module being imported\r
+ -> Maybe (Bool, [RdrNameIE]) -- Import spec; True => hiding\r
+ -> [AvailInfo] -- What's available\r
+ -> RnMG ([AvailInfo], -- What's actually imported\r
+ [AvailInfo], -- What's to be hidden (the unqualified version, that is)\r
+ NameSet) -- What was imported explicitly\r
+\r
+ -- Complains if import spec mentions things that the module doesn't export\r
+ -- Warns/informs if import spec contains duplicates.\r
+filterImports mod Nothing imports\r
+ = returnRn (imports, [], emptyNameSet)\r
+\r
+filterImports mod (Just (want_hiding, import_items)) avails\r
+ = mapMaybeRn check_item import_items `thenRn` \ avails_w_explicits ->\r
+ let\r
+ (item_avails, explicits_s) = unzip avails_w_explicits\r
+ explicits = foldl addListToNameSet emptyNameSet explicits_s\r
+ in\r
+ if want_hiding \r
+ then \r
+ -- All imported; item_avails to be hidden\r
+ returnRn (avails, item_avails, emptyNameSet)\r
+ else\r
+ -- Just item_avails imported; nothing to be hidden\r
+ returnRn (item_avails, [], explicits)\r
+ where\r
+ import_fm :: FiniteMap OccName AvailInfo\r
+ import_fm = listToFM [ (nameOccName name, avail) \r
+ | avail <- avails,\r
+ name <- availNames avail]\r
+ -- Even though availNames returns data constructors too,\r
+ -- they won't make any difference because naked entities like T\r
+ -- in an import list map to TcOccs, not VarOccs.\r
+\r
+ check_item item@(IEModuleContents _)\r
+ = addErrRn (badImportItemErr mod item) `thenRn_`\r
+ returnRn Nothing\r
+\r
+ check_item item\r
+ | not (maybeToBool maybe_in_import_avails) ||\r
+ not (maybeToBool maybe_filtered_avail)\r
+ = addErrRn (badImportItemErr mod item) `thenRn_`\r
+ returnRn Nothing\r
+\r
+ | dodgy_import = addWarnRn (dodgyImportWarn mod item) `thenRn_`\r
+ returnRn (Just (filtered_avail, explicits))\r
+\r
+ | otherwise = returnRn (Just (filtered_avail, explicits))\r
+ \r
+ where\r
+ wanted_occ = rdrNameOcc (ieName item)\r
+ maybe_in_import_avails = lookupFM import_fm wanted_occ\r
+\r
+ Just avail = maybe_in_import_avails\r
+ maybe_filtered_avail = filterAvail item avail\r
+ Just filtered_avail = maybe_filtered_avail\r
+ explicits | dot_dot = [availName filtered_avail]\r
+ | otherwise = availNames filtered_avail\r
+\r
+ dot_dot = case item of \r
+ IEThingAll _ -> True\r
+ other -> False\r
+\r
+ dodgy_import = case (item, avail) of\r
+ (IEThingAll _, AvailTC _ [n]) -> True\r
+ -- This occurs when you import T(..), but\r
+ -- only export T abstractly. The single [n]\r
+ -- in the AvailTC is the type or class itself\r
+ \r
+ other -> False\r
+\end{code}\r
+\r
+\r
+\r
+%************************************************************************\r
+%* *\r
+\subsection{Qualifiying imports}\r
+%* *\r
+%************************************************************************\r
+\r
+@qualifyImports@ takes the @ExportEnv@ after filtering through the import spec\r
+of an import decl, and deals with producing an @RnEnv@ with the \r
+right qualified names. It also turns the @Names@ in the @ExportEnv@ into\r
+fully fledged @Names@.\r
+\r
+\begin{code}\r
+qualifyImports :: ModuleName -- Imported module\r
+ -> Bool -- True <=> want unqualified import\r
+ -> Maybe ModuleName -- Optional "as M" part \r
+ -> [AvailInfo] -- What's to be hidden\r
+ -> Avails -- Whats imported and how\r
+ -> (Name -> Name) -- Improves the provenance on imported things\r
+ -> RnMG (GlobalRdrEnv, ExportAvails)\r
+ -- NB: the Names in ExportAvails don't have the improve-provenance\r
+ -- function applied to them\r
+ -- We could fix that, but I don't think it matters\r
+\r
+qualifyImports this_mod unqual_imp as_mod hides\r
+ avails improve_prov\r
+ = \r
+ -- Make the name environment. We're talking about a \r
+ -- single module here, so there must be no name clashes.\r
+ -- In practice there only ever will be if it's the module\r
+ -- being compiled.\r
+ let\r
+ -- Add the things that are available\r
+ name_env1 = foldl add_avail emptyRdrEnv avails\r
+\r
+ -- Delete things that are hidden\r
+ name_env2 = foldl del_avail name_env1 hides\r
+\r
+ -- Create the export-availability info\r
+ export_avails = mkExportAvails qual_mod unqual_imp name_env2 avails\r
+ in\r
+ returnRn (name_env2, export_avails)\r
+\r
+ where\r
+ qual_mod = case as_mod of\r
+ Nothing -> this_mod\r
+ Just another_name -> another_name\r
+\r
+ add_avail :: GlobalRdrEnv -> AvailInfo -> GlobalRdrEnv\r
+ add_avail env avail = foldl add_name env (availNames avail)\r
+\r
+ add_name env name\r
+ | unqual_imp = env2\r
+ | otherwise = env1\r
+ where\r
+ env1 = addOneToGlobalRdrEnv env (mkRdrQual qual_mod occ) better_name\r
+ env2 = addOneToGlobalRdrEnv env1 (mkRdrUnqual occ) better_name\r
+ occ = nameOccName name\r
+ better_name = improve_prov name\r
+\r
+ del_avail env avail = foldl delOneFromGlobalRdrEnv env rdr_names\r
+ where\r
+ rdr_names = map (mkRdrUnqual . nameOccName) (availNames avail)\r
+\end{code}\r
+\r
+\r
+%************************************************************************\r
+%* *\r
+\subsection{Export list processing\r
+%* *\r
+%************************************************************************\r
+\r
+Processing the export list.\r
+\r
+You might think that we should record things that appear in the export list as\r
+``occurrences'' (using addOccurrenceName), but you'd be wrong. We do check (here)\r
+that they are in scope, but there is no need to slurp in their actual declaration\r
+(which is what addOccurrenceName forces). Indeed, doing so would big trouble when\r
+compiling PrelBase, because it re-exports GHC, which includes takeMVar#, whose type\r
+includes ConcBase.StateAndSynchVar#, and so on...\r
+\r
+\begin{code}\r
+type ExportAccum -- The type of the accumulating parameter of\r
+ -- the main worker function in exportsFromAvail\r
+ = ([ModuleName], -- 'module M's seen so far\r
+ ExportOccMap, -- Tracks exported occurrence names\r
+ NameEnv AvailInfo) -- The accumulated exported stuff, kept in an env\r
+ -- so we can common-up related AvailInfos\r
+\r
+type ExportOccMap = FiniteMap OccName (Name, RdrNameIE)\r
+ -- Tracks what a particular exported OccName\r
+ -- in an export list refers to, and which item\r
+ -- it came from. It's illegal to export two distinct things\r
+ -- that have the same occurrence name\r
+\r
+\r
+exportsFromAvail :: ModuleName\r
+ -> Maybe [RdrNameIE] -- Export spec\r
+ -> ExportAvails\r
+ -> GlobalRdrEnv \r
+ -> RnMG Avails\r
+ -- Complains if two distinct exports have same OccName\r
+ -- Warns about identical exports.\r
+ -- Complains about exports items not in scope\r
+exportsFromAvail this_mod Nothing export_avails global_name_env\r
+ = exportsFromAvail this_mod true_exports export_avails global_name_env\r
+ where\r
+ true_exports = Just $ if this_mod == mAIN_Name\r
+ then [IEVar main_RDR]\r
+ -- export Main.main *only* unless otherwise specified,\r
+ else [IEModuleContents this_mod]\r
+ -- but for all other modules export everything.\r
+\r
+exportsFromAvail this_mod (Just export_items) \r
+ (mod_avail_env, entity_avail_env)\r
+ global_name_env\r
+ = foldlRn exports_from_item\r
+ ([], emptyFM, emptyNameEnv) export_items `thenRn` \ (_, _, export_avail_map) ->\r
+ let\r
+ export_avails :: [AvailInfo]\r
+ export_avails = nameEnvElts export_avail_map\r
+ in\r
+ returnRn export_avails\r
+\r
+ where\r
+ exports_from_item :: ExportAccum -> RdrNameIE -> RnMG ExportAccum\r
+\r
+ exports_from_item acc@(mods, occs, avails) ie@(IEModuleContents mod)\r
+ | mod `elem` mods -- Duplicate export of M\r
+ = warnCheckRn opt_WarnDuplicateExports\r
+ (dupModuleExport mod) `thenRn_`\r
+ returnRn acc\r
+\r
+ | otherwise\r
+ = case lookupFM mod_avail_env mod of\r
+ Nothing -> failWithRn acc (modExportErr mod)\r
+ Just mod_avails -> foldlRn (check_occs ie) occs mod_avails `thenRn` \ occs' ->\r
+ let\r
+ avails' = foldl add_avail avails mod_avails\r
+ in\r
+ returnRn (mod:mods, occs', avails')\r
+\r
+ exports_from_item acc@(mods, occs, avails) ie\r
+ | not (maybeToBool maybe_in_scope) \r
+ = failWithRn acc (unknownNameErr (ieName ie))\r
+\r
+ | not (null dup_names)\r
+ = addNameClashErrRn rdr_name (name:dup_names) `thenRn_`\r
+ returnRn acc\r
+\r
+#ifdef DEBUG\r
+ -- I can't see why this should ever happen; if the thing is in scope\r
+ -- at all it ought to have some availability\r
+ | not (maybeToBool maybe_avail)\r
+ = pprTrace "exportsFromAvail: curious Nothing:" (ppr name)\r
+ returnRn acc\r
+#endif\r
+\r
+ | not enough_avail\r
+ = failWithRn acc (exportItemErr ie)\r
+\r
+ | otherwise -- Phew! It's OK! Now to check the occurrence stuff!\r
+ = check_occs ie occs export_avail `thenRn` \ occs' ->\r
+ returnRn (mods, occs', add_avail avails export_avail)\r
+\r
+ where\r
+ rdr_name = ieName ie\r
+ maybe_in_scope = lookupFM global_name_env rdr_name\r
+ Just (name:dup_names) = maybe_in_scope\r
+ maybe_avail = lookupUFM entity_avail_env name\r
+ Just avail = maybe_avail\r
+ maybe_export_avail = filterAvail ie avail\r
+ enough_avail = maybeToBool maybe_export_avail\r
+ Just export_avail = maybe_export_avail\r
+\r
+add_avail avails avail = addToNameEnv_C plusAvail avails (availName avail) avail\r
+\r
+check_occs :: RdrNameIE -> ExportOccMap -> AvailInfo -> RnMG ExportOccMap\r
+check_occs ie occs avail \r
+ = foldlRn check occs (availNames avail)\r
+ where\r
+ check occs name\r
+ = case lookupFM occs name_occ of\r
+ Nothing -> returnRn (addToFM occs name_occ (name, ie))\r
+ Just (name', ie') \r
+ | name == name' -> -- Duplicate export\r
+ warnCheckRn opt_WarnDuplicateExports\r
+ (dupExportWarn name_occ ie ie') `thenRn_`\r
+ returnRn occs\r
+\r
+ | otherwise -> -- Same occ name but different names: an error\r
+ failWithRn occs (exportClashErr name_occ ie ie')\r
+ where\r
+ name_occ = nameOccName name\r
+ \r
+mk_export_fn :: NameSet -> (Name -> ExportFlag)\r
+mk_export_fn exported_names\r
+ = \name -> if name `elemNameSet` exported_names\r
+ then Exported\r
+ else NotExported\r
+\end{code}\r
+\r
+%************************************************************************\r
+%* *\r
+\subsection{Errors}\r
+%* *\r
+%************************************************************************\r
+\r
+\begin{code}\r
+badImportItemErr mod ie\r
+ = sep [ptext SLIT("Module"), quotes (pprModuleName mod), \r
+ ptext SLIT("does not export"), quotes (ppr ie)]\r
+\r
+dodgyImportWarn mod (IEThingAll tc)\r
+ = sep [ptext SLIT("Module") <+> quotes (pprModuleName mod) <+> ptext SLIT("exports") <+> quotes (ppr tc), \r
+ ptext SLIT("with no constructors/class operations;"),\r
+ ptext SLIT("yet it is imported with a (..)")]\r
+\r
+modExportErr mod\r
+ = hsep [ ptext SLIT("Unknown module in export list: module"), quotes (pprModuleName mod)]\r
+\r
+exportItemErr export_item\r
+ = sep [ ptext SLIT("Bad export item"), quotes (ppr export_item)]\r
+\r
+exportClashErr occ_name ie1 ie2\r
+ = hsep [ptext SLIT("The export items"), quotes (ppr ie1), ptext SLIT("and"), quotes (ppr ie2),\r
+ ptext SLIT("create conflicting exports for"), quotes (ppr occ_name)]\r
+\r
+dupDeclErr (n:ns)\r
+ = vcat [ptext SLIT("Multiple declarations of") <+> quotes (ppr n),\r
+ nest 4 (vcat (map pp sorted_ns))]\r
+ where\r
+ sorted_ns = sortLt occ'ed_before (n:ns)\r
+\r
+ occ'ed_before a b = LT == compare (getSrcLoc a) (getSrcLoc b)\r
+\r
+ pp n = pprProvenance (getNameProvenance n)\r
+\r
+dupExportWarn occ_name ie1 ie2\r
+ = hsep [quotes (ppr occ_name), \r
+ ptext SLIT("is exported by"), quotes (ppr ie1),\r
+ ptext SLIT("and"), quotes (ppr ie2)]\r
+\r
+dupModuleExport mod\r
+ = hsep [ptext SLIT("Duplicate"),\r
+ quotes (ptext SLIT("Module") <+> pprModuleName mod), \r
+ ptext SLIT("in export list")]\r
+\r
+unusedFixityDecl rdr_name fixity\r
+ = hsep [ptext SLIT("Unused fixity declaration for"), quotes (ppr rdr_name)]\r
+\r
+dupFixityDecl rdr_name loc1 loc2\r
+ = vcat [ptext SLIT("Multiple fixity declarations for") <+> quotes (ppr rdr_name),\r
+ ptext SLIT("at ") <+> ppr loc1,\r
+ ptext SLIT("and") <+> ppr loc2]\r
+\r
+\end{code}\r
projects / ghc-hetmet.git / blobdiff