X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Frename%2FRnNames.lhs;h=db749a4451528b6a37b5d70d231f7466f012f401;hb=438596897ebbe25a07e1c82085cfbc5bdb00f09e;hp=cd256b9feb7121b639553f07bbe29d4956a9ce30;hpb=ae45ff0e9831a0dc862a5d68d03e355d7e323c62;p=ghc-hetmet.git diff --git a/ghc/compiler/rename/RnNames.lhs b/ghc/compiler/rename/RnNames.lhs index cd256b9..db749a4 100644 --- a/ghc/compiler/rename/RnNames.lhs +++ b/ghc/compiler/rename/RnNames.lhs @@ -1,1034 +1,665 @@ % -% (c) The GRASP/AQUA Project, Glasgow University, 1992-1996 +% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998 % \section[RnNames]{Extracting imported and top-level names in scope} \begin{code} -#include "HsVersions.h" - module RnNames ( - getGlobalNames, - GlobalNameInfo(..) + getGlobalNames ) where -import PreludeGlaST ( MutableVar(..) ) - -IMP_Ubiq() - -import HsSyn -import RdrHsSyn -import RnHsSyn +#include "HsVersions.h" +import CmdLineOpts ( opt_NoImplicitPrelude, opt_WarnDuplicateExports, + opt_SourceUnchanged + ) + +import HsSyn ( HsModule(..), ImportDecl(..), HsDecl(..), + IE(..), ieName, + ForeignDecl(..), ExtName(..), ForKind(..), + FixityDecl(..), + collectTopBinders + ) +import RdrHsSyn ( RdrName(..), RdrNameIE, RdrNameImportDecl, + RdrNameHsModule, RdrNameFixityDecl, + rdrNameOcc, ieOcc + ) +import RnIfaces ( getInterfaceExports, getDeclBinders, recordSlurp, checkUpToDate ) +import BasicTypes ( IfaceFlavour(..) ) +import RnEnv import RnMonad -import RnIfaces ( IfaceCache(..), cachedIface, cachedDecl ) -import RnUtils ( RnEnv(..), emptyRnEnv, extendGlobalRnEnv, - lubExportFlag, qualNameErr, dupNamesErr - ) -import ParseUtils ( ParsedIface(..), RdrIfaceDecl(..), ExportsMap(..), RdrIfaceInst ) - - -import Bag ( emptyBag, unitBag, consBag, snocBag, unionBags, - unionManyBags, mapBag, filterBag, listToBag, bagToList ) -import CmdLineOpts ( opt_NoImplicitPrelude, opt_CompilingPrelude ) -import ErrUtils ( Error(..), Warning(..), addErrLoc, addShortErrLocLine, addShortWarnLocLine ) -import FiniteMap ( emptyFM, addToFM, addListToFM, lookupFM, fmToList, eltsFM, delListFromFM, keysFM{-ToDo:rm-} ) -import Id ( GenId ) -import Maybes ( maybeToBool, catMaybes, MaybeErr(..) ) -import Name ( RdrName(..), Name, isQual, mkTopLevName, mkWiredInName, origName, - nameOf, qualToOrigName, mkImportedName, - nameExportFlag, nameImportFlag, - getLocalName, getSrcLoc, getImpLocs, - moduleNamePair, pprNonSym, - isLexCon, ExportFlag(..), OrigName(..) - ) -import PrelInfo ( BuiltinNames(..), BuiltinKeys(..) ) -import PrelMods ( pRELUDE, gHC_BUILTINS, modulesWithBuiltins ) -import Pretty -import SrcLoc ( SrcLoc, mkBuiltinSrcLoc ) -import TyCon ( tyConDataCons ) -import UniqFM ( emptyUFM, addListToUFM_C, lookupUFM ) -import UniqSupply ( splitUniqSupply ) -import Util ( isIn, assoc, cmpPString, sortLt, removeDups, - equivClasses, panic, assertPanic, pprPanic{-ToDo:rm-}, pprTrace{-ToDo:rm-} - ) -import PprStyle --ToDo:rm -\end{code} - -\begin{code} -type GlobalNameInfo = (BuiltinNames, - BuiltinKeys, - Name -> ExportFlag, -- export flag - Name -> [RdrName]) -- occurrence names - -- NB: both of the functions are in a *knot* and - -- must be tugged on oh-so-gently... - -type RnM_Info s r = RnMonad GlobalNameInfo s r - -getGlobalNames :: - IfaceCache - -> GlobalNameInfo - -> UniqSupply - -> RdrNameHsModule - -> IO (RnEnv, - [Module], -- directly imported modules - Bag (Module,RnName), -- unqualified imports from module - Bag RenamedFixityDecl, -- imported fixity decls - Bag Error, - Bag Warning) - -getGlobalNames iface_cache info us - (HsModule mod _ _ imports _ ty_decls _ cls_decls _ _ _ binds _ _) - = let - (us1, us2) = splitUniqSupply us - in - case initRn True mod emptyRnEnv us1 - (setExtraRn info $ - getSourceNames ty_decls cls_decls binds) - of { ((src_vals, src_tcs), src_errs, src_warns) -> - - doImportDecls iface_cache info us2 imports >>= - \ (imp_vals, imp_tcs, imp_mods, unqual_imps, imp_fixes, imp_errs, imp_warns) -> - - let - unqual_vals = map (\rn -> (Unqual (getLocalName rn), rn)) (bagToList src_vals) - unqual_tcs = map (\rn -> (Unqual (getLocalName rn), rn)) (bagToList src_tcs) - - (src_env, src_dups) = extendGlobalRnEnv emptyRnEnv unqual_vals unqual_tcs - (all_env, imp_dups) = extendGlobalRnEnv src_env (bagToList imp_vals) (bagToList imp_tcs) - -- remove dups of the same imported thing - diff_imp_dups = filterBag diff_orig imp_dups - diff_orig (_,rn1,rn2) = origName "diff_orig" rn1 /= origName "diff_orig" rn2 +import FiniteMap +import PrelMods +import UniqFM ( lookupUFM ) +import Bag ( bagToList ) +import Maybes ( maybeToBool ) +import Name +import NameSet ( elemNameSet ) +import Outputable +import Util ( removeDups ) +\end{code} - all_dups = bagToList (src_dups `unionBags` diff_imp_dups) - dup_errs = map dup_err (equivClasses cmp_rdr all_dups) - cmp_rdr (rdr1,_,_) (rdr2,_,_) = cmp rdr1 rdr2 - dup_err ((rdr,rn1,rn2):rest) = globalDupNamesErr rdr (rn1:rn2: [rn|(_,_,rn)<-rest]) - all_errs = src_errs `unionBags` imp_errs `unionBags` listToBag dup_errs - all_warns = src_warns `unionBags` imp_warns - in - return (all_env, imp_mods, unqual_imps, imp_fixes, all_errs, all_warns) } -\end{code} -********************************************************* -* * -\subsection{Top-level source names} -* * -********************************************************* +%************************************************************************ +%* * +\subsection{Get global names} +%* * +%************************************************************************ \begin{code} -getSourceNames :: - [RdrNameTyDecl] - -> [RdrNameClassDecl] - -> RdrNameHsBinds - -> RnM_Info s (Bag RnName, -- values - Bag RnName) -- tycons/classes - -getSourceNames ty_decls cls_decls binds - = mapAndUnzip3Rn getTyDeclNames ty_decls `thenRn` \ (tycon_s, constrs_s, fields_s) -> - mapAndUnzipRn getClassNames cls_decls `thenRn` \ (cls_s, cls_ops_s) -> - getTopBindsNames binds `thenRn` \ bind_names -> - returnRn (unionManyBags constrs_s `unionBags` - unionManyBags fields_s `unionBags` - unionManyBags cls_ops_s `unionBags` bind_names, - listToBag tycon_s `unionBags` listToBag cls_s) - --------------- -getTyDeclNames :: RdrNameTyDecl - -> RnM_Info s (RnName, Bag RnName, Bag RnName) -- tycon, constrs and fields - -getTyDeclNames (TyData _ tycon _ condecls _ _ src_loc) - = --getExtraRn `thenRn` \ ((b_val_names,b_tc_names),b_keys,rec_exp_fn,rec_occ_fn) -> - --pprTrace "getTyDeclNames:" (ppr PprDebug tycon) $ - --pprTrace "getTDN1:" (ppAboves [ ppCat [ppPStr m, ppPStr n] | ((OrigName m n), _) <- fmToList b_tc_names]) $ - - newGlobalName src_loc Nothing False{-not val-} tycon `thenRn` \ tycon_name -> - getConFieldNames (Just (nameExportFlag tycon_name)) emptyBag emptyBag emptyFM - condecls `thenRn` \ (con_names, field_names) -> - let - rn_tycon = RnData tycon_name con_names field_names - rn_constrs = [ RnConstr name tycon_name | name <- con_names] - rn_fields = [ RnField name tycon_name | name <- field_names] - in - returnRn (rn_tycon, listToBag rn_constrs, listToBag rn_fields) - -getTyDeclNames (TyNew _ tycon _ [NewConDecl con _ con_loc] _ _ src_loc) - = newGlobalName src_loc Nothing False{-not val-} tycon `thenRn` \ tycon_name -> - newGlobalName con_loc (Just (nameExportFlag tycon_name)) True{-val-} con - `thenRn` \ con_name -> - returnRn (RnData tycon_name [con_name] [], - unitBag (RnConstr con_name tycon_name), - emptyBag) - -getTyDeclNames (TySynonym tycon _ _ src_loc) - = newGlobalName src_loc Nothing False{-not val-} tycon `thenRn` \ tycon_name -> - returnRn (RnSyn tycon_name, emptyBag, emptyBag) - ----------------- -getConFieldNames :: Maybe ExportFlag - -> Bag Name -> Bag Name - -> FiniteMap RdrName () - -> [RdrNameConDecl] - -> RnM_Info s ([Name], [Name]) - -getConFieldNames exp constrs fields have [] - = returnRn (bagToList constrs, bagToList fields) - -getConFieldNames exp constrs fields have (ConDecl con _ src_loc : rest) - = newGlobalName src_loc exp True{-val-} con `thenRn` \ con_name -> - getConFieldNames exp (constrs `snocBag` con_name) fields have rest - -getConFieldNames exp constrs fields have (ConOpDecl _ con _ src_loc : rest) - = newGlobalName src_loc exp True{-val-} con `thenRn` \ con_name -> - getConFieldNames exp (constrs `snocBag` con_name) fields have rest - -getConFieldNames exp constrs fields have (RecConDecl con fielddecls src_loc : rest) - = mapRn (addErrRn . dupFieldErr con src_loc) dups `thenRn_` - newGlobalName src_loc exp True{-val-} con `thenRn` \ con_name -> - mapRn (newGlobalName src_loc exp True{-val-}) new_fields `thenRn` \ field_names -> - let - all_constrs = constrs `snocBag` con_name - all_fields = fields `unionBags` listToBag field_names - in - getConFieldNames exp all_constrs all_fields new_have rest +getGlobalNames :: RdrNameHsModule + -> RnMG (Maybe (ExportEnv, + RnEnv, + FiniteMap Name HowInScope, -- Locally defined or explicitly imported + Name -> PrintUnqualified)) + -- Nothing => no need to recompile + +getGlobalNames m@(HsModule this_mod _ exports imports _ _ mod_loc) + = fixRn (\ ~(rec_exp_fn, _) -> + + -- PROCESS LOCAL DECLS + -- Do these *first* so that the correct provenance gets + -- into the global name cache. + importsFromLocalDecls rec_exp_fn m `thenRn` \ (local_rn_env, local_mod_avails, local_info) -> + + -- PROCESS IMPORT DECLS + mapAndUnzip3Rn importsFromImportDecl all_imports + `thenRn` \ (imp_rn_envs, imp_avails_s, explicit_imports_s) -> + + -- COMBINE RESULTS + -- We put the local env second, so that a local provenance + -- "wins", even if a module imports itself. + foldlRn plusRnEnv emptyRnEnv imp_rn_envs `thenRn` \ imp_rn_env -> + plusRnEnv imp_rn_env local_rn_env `thenRn` \ rn_env -> + + -- TRY FOR EARLY EXIT + -- We can't go for an early exit before this because we have to check + -- for name clashes. Consider: + -- + -- module A where module B where + -- import B h = True + -- f = h + -- + -- Suppose I've compiled everything up, and then I add a + -- new definition to module B, that defines "f". + -- + -- Then I must detect the name clash in A before going for an early + -- exit. The early-exit code checks what's actually needed from B + -- to compile A, and of course that doesn't include B.f. That's + -- why we wait till after the plusRnEnv stuff to do the early-exit. + checkEarlyExit this_mod `thenRn` \ up_to_date -> + if up_to_date then + returnRn (error "early exit", Nothing) + else + + + -- PROCESS EXPORT LISTS + let + export_avails :: ExportAvails + export_avails = foldr plusExportAvails local_mod_avails imp_avails_s + + explicit_info :: FiniteMap Name HowInScope -- Locally defined or explicitly imported + explicit_info = foldr plusFM local_info explicit_imports_s + in + exportsFromAvail this_mod exports export_avails rn_env + `thenRn` \ (export_fn, export_env) -> + + -- BUILD THE "IMPORT FN". It just tells whether a name is in + -- scope in an unqualified form. + let + print_unqual = mkImportFn imp_rn_env + in + + returnRn (export_fn, Just (export_env, rn_env, explicit_info, print_unqual)) + ) `thenRn` \ (_, result) -> + returnRn result where - (uniq_fields, dups) = removeDups cmp (concat (map fst fielddecls)) - new_fields = filter (not . maybeToBool . lookupFM have) uniq_fields - new_have = addListToFM have (zip new_fields (repeat ())) - -------------- -getClassNames :: RdrNameClassDecl - -> RnM_Info s (RnName, Bag RnName) -- class and class ops - -getClassNames (ClassDecl _ cname _ sigs _ _ src_loc) - = newGlobalName src_loc Nothing False{-notval-} 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 :: Maybe ExportFlag - -> [RdrNameSig] - -> RnM_Info s [Name] - -getClassOpNames exp [] = returnRn [] - -getClassOpNames exp (ClassOpSig op _ _ src_loc : sigs) - = newGlobalName src_loc exp True{-val-} op `thenRn` \ op_name -> - getClassOpNames exp sigs `thenRn` \ op_names -> - returnRn (op_name : op_names) -getClassOpNames exp (_ : sigs) - = getClassOpNames exp sigs + junk_exp_fn = error "RnNames:export_fn" + + all_imports = prel_imports ++ imports + + -- NB: opt_NoImplicitPrelude is slightly different to import Prelude (); + -- because the former doesn't even look at Prelude.hi for instance declarations, + -- whereas the latter does. + prel_imports | this_mod == pRELUDE || + explicit_prelude_import || + opt_NoImplicitPrelude + = [] + + | otherwise = [ImportDecl pRELUDE + False {- Not qualified -} + HiFile {- Not source imported -} + Nothing {- No "as" -} + Nothing {- No import list -} + mod_loc] + + explicit_prelude_import + = not (null [ () | (ImportDecl mod qual _ _ _ _) <- imports, mod == pRELUDE ]) \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 (_, pat, _) = doPat locn pat - -doName locn rdr - = newGlobalName locn Nothing True{-val-} rdr `thenRn` \ name -> - returnRn (unitBag (RnName name)) +checkEarlyExit mod + = checkErrsRn `thenRn` \ no_errs_so_far -> + if not no_errs_so_far then + -- Found errors already, so exit now + returnRn True + else + + traceRn (text "Considering whether compilation is required...") `thenRn_` + if not opt_SourceUnchanged then + -- Source code changed and no errors yet... carry on + traceRn (nest 4 (text "source file changed or recompilation check turned off")) `thenRn_` + returnRn False + else + + -- Unchanged source, and no errors yet; see if usage info + -- up to date, and exit if so + checkUpToDate mod `thenRn` \ up_to_date -> + putDocRn (text "Compilation" <+> + text (if up_to_date then "IS NOT" else "IS") <+> + text "required") `thenRn_` + returnRn up_to_date \end{code} - -********************************************************* -* * -\subsection{Creating a new global name} -* * -********************************************************* - + \begin{code} -newGlobalName :: SrcLoc - -> Maybe ExportFlag - -> Bool{-True<=>value name,False<=>tycon/class-} - -> RdrName - -> RnM_Info s Name - -newGlobalName locn maybe_exp is_val_name (Unqual name) - = getExtraRn `thenRn` \ ((b_val_names,b_tc_names),b_keys,rec_exp_fn,rec_occ_fn) -> - getModuleRn `thenRn` \ mod -> - rnGetUnique `thenRn` \ u -> - let - orig = OrigName mod name - - (uniq, is_toplev) - = case (lookupFM b_keys orig) of - Just (key,_) -> (key, True) - Nothing -> if not opt_CompilingPrelude then (u,True) else -- really here just to save gratuitous lookup - case (lookupFM (if is_val_name then b_val_names else b_tc_names) orig) of - Nothing -> (u, True) - Just xx -> (uniqueOf xx, False{-builtin!-}) - - exp = case maybe_exp of - Just flag -> flag - Nothing -> rec_exp_fn n - - n = if is_toplev - then mkTopLevName uniq orig locn exp (rec_occ_fn n) -- NB: two "n"s - else mkWiredInName uniq orig - in - returnRn n - -newGlobalName locn maybe_exp is_val_name rdr@(Qual mod name) - | opt_CompilingPrelude - -- we are actually defining something that compiler knows about (e.g., Bool) - - = getExtraRn `thenRn` \ ((b_val_names,b_tc_names),b_keys,rec_exp_fn,rec_occ_fn) -> +importsFromImportDecl :: RdrNameImportDecl + -> RnMG (RnEnv, + ExportAvails, + FiniteMap Name HowInScope) -- Records the explicitly-imported things + +importsFromImportDecl (ImportDecl mod qual_only as_source as_mod import_spec loc) + = pushSrcLocRn loc $ + getInterfaceExports mod as_source `thenRn` \ (avails, fixities) -> + filterImports mod import_spec avails `thenRn` \ (filtered_avails, hides, explicits) -> let - orig = OrigName mod name - - (uniq, is_toplev) - = case (lookupFM b_keys orig) of - Just (key,_) -> (key, True) - Nothing -> case (lookupFM (if is_val_name then b_val_names else b_tc_names) orig) of - Nothing -> (pprPanic "newGlobalName:Qual:uniq:" (ppr PprDebug rdr), True) - Just xx -> (uniqueOf xx, False{-builtin!-}) - - exp = case maybe_exp of - Just flag -> flag - Nothing -> rec_exp_fn n - - n = if is_toplev - then mkTopLevName uniq orig locn exp (rec_occ_fn n) -- NB: two "n"s - else mkWiredInName uniq orig + how_in_scope = FromImportDecl mod loc + explicit_info = listToFM [(name, how_in_scope) + | avail <- explicits, + name <- availNames avail + ] in - returnRn n - - | otherwise - = addErrRn (qualNameErr "name in definition" (rdr, locn)) `thenRn_` - returnRn (pprPanic "newGlobalName:Qual:" (ppr PprDebug rdr)) + qualifyImports mod + True -- Want qualified names + (not qual_only) -- Maybe want unqualified names + as_mod + hides + filtered_avails (\n -> how_in_scope) + [ (occ,(fixity,how_in_scope)) | (occ,fixity) <- fixities ] + `thenRn` \ (rn_env, mod_avails) -> + returnRn (rn_env, mod_avails, explicit_info) \end{code} -********************************************************* -* * -\subsection{Imported names} -* * -********************************************************* \begin{code} -type ImportNameInfo - = (GlobalNameInfo, - FiniteMap OrigName RnName, -- values imported so far - FiniteMap OrigName RnName, -- tycons/classes imported so far - Name -> (ExportFlag, [SrcLoc])) -- import flag and src locns; - -- NB: this last field is in a knot - -- and mustn't be tugged on! - -type RnM_IInfo s r = RnMonad ImportNameInfo s r - ------------------------------------------------------------------- -doImportDecls :: - IfaceCache - -> GlobalNameInfo -- builtin and knot name info - -> UniqSupply - -> [RdrNameImportDecl] -- import declarations - -> IO (Bag (RdrName,RnName), -- imported values in scope - Bag (RdrName,RnName), -- imported tycons/classes in scope - [Module], -- directly imported modules - Bag (Module,RnName), -- unqualified import from module - Bag RenamedFixityDecl, -- fixity info for imported names - Bag Error, - Bag Warning) - -doImportDecls iface_cache g_info us src_imps - = fixIO ( \ ~(_, _, _, _, _, _, rec_imp_stuff) -> - let - rec_imp_fm = addListToUFM_C add_stuff emptyUFM (bagToList rec_imp_stuff) - add_stuff (imp1,locns1) (imp2,locns2) = (lubExportFlag imp1 imp2, locns1 `unionBags` locns2) - - rec_imp_fn :: Name -> (ExportFlag, [SrcLoc]) - rec_imp_fn n = case lookupUFM rec_imp_fm n of - Nothing -> panic "RnNames:rec_imp_fn" - Just (flag, locns) -> (flag, bagToList locns) - - i_info = (g_info, emptyFM, emptyFM, rec_imp_fn) - in - -- cache the imported modules - -- this ensures that all directly imported modules - -- will have their original name iface in scope - -- pprTrace "doImportDecls:" (ppCat (map ppPStr imp_mods)) $ - accumulate (map (cachedIface False iface_cache) imp_mods) >> +importsFromLocalDecls rec_exp_fn (HsModule mod _ _ _ fix_decls decls _) + = foldlRn getLocalDeclBinders [] decls `thenRn` \ avails -> - -- process the imports - doImports iface_cache i_info us all_imps + -- Record that locally-defined things are available + mapRn (recordSlurp Nothing Compulsory) avails `thenRn_` - ) >>= \ (vals, tcs, unquals, fixes, errs, warns, _) -> + -- Fixities + mapRn fixityFromFixDecl fix_decls `thenRn` \ fixities -> - return (vals, tcs, imp_mods, unquals, fixes, - imp_errs `unionBags` errs, - imp_warns `unionBags` warns) + -- Record where the available stuff came from + let + explicit_info = listToFM [(name, FromLocalDefn (getSrcLoc name)) + | avail <- avails, + name <- availNames avail + ] + in + qualifyImports mod + False -- Don't want qualified names + True -- Want unqualified names + Nothing -- No "as M" part + [] -- Hide nothing + avails (\n -> FromLocalDefn (getSrcLoc n)) + fixities + `thenRn` \ (rn_env, mod_avails) -> + returnRn (rn_env, mod_avails, explicit_info) where - the_imps = implicit_prel ++ src_imps - all_imps = implicit_qprel ++ the_imps + newLocalName rdr_name loc + = newLocallyDefinedGlobalName mod (rdrNameOcc rdr_name) rec_exp_fn loc + + getLocalDeclBinders avails (ValD binds) + = mapRn do_one (bagToList (collectTopBinders binds)) `thenRn` \ val_avails -> + returnRn (val_avails ++ avails) + + -- foreign import declaration + getLocalDeclBinders avails (ForD (ForeignDecl nm (FoImport _) _ _ _ loc)) + = do_one (nm,loc) `thenRn` \ for_avail -> + returnRn (for_avail : avails) + + -- foreign import declaration + getLocalDeclBinders avails (ForD (ForeignDecl nm FoLabel _ _ _ loc)) + = do_one (nm,loc) `thenRn` \ for_avail -> + returnRn (for_avail : avails) + + -- foreign export dynamic declaration + getLocalDeclBinders avails (ForD (ForeignDecl nm FoExport _ Dynamic _ loc)) + = do_one (nm,loc) `thenRn` \ for_avail -> + returnRn (for_avail : avails) + + getLocalDeclBinders avails decl + = getDeclBinders newLocalName decl `thenRn` \ avail -> + case avail of + NotAvailable -> returnRn avails -- Instance decls and suchlike + other -> returnRn (avail : avails) + + do_one (rdr_name, loc) + = newLocalName rdr_name loc `thenRn` \ name -> + returnRn (Avail name) +\end{code} - implicit_qprel = ImportDecl gHC_BUILTINS True Nothing Nothing prel_loc - : (if opt_NoImplicitPrelude - then [{- no "import qualified Prelude" -}] - else [ImportDecl pRELUDE True Nothing Nothing prel_loc]) +%************************************************************************ +%* * +\subsection{Filtering imports} +%* * +%************************************************************************ - explicit_prelude_imp = not (null [ () | (ImportDecl mod qual _ _ _) <- src_imps, - mod == pRELUDE ]) +@filterImports@ takes the @ExportEnv@ telling what the imported module makes +available, and filters it through the import spec (if any). - implicit_prel = ImportDecl gHC_BUILTINS False Nothing Nothing prel_loc - : (if explicit_prelude_imp || opt_NoImplicitPrelude - then [{- no "import Prelude" -}] - else [ImportDecl pRELUDE False Nothing Nothing prel_loc]) +\begin{code} +filterImports :: Module + -> Maybe (Bool, [RdrNameIE]) -- Import spec; True => hidin + -> [AvailInfo] -- What's available + -> RnMG ([AvailInfo], -- What's actually imported + [AvailInfo], -- What's to be hidden (the unqualified version, that is) + [AvailInfo]) -- What was imported explicitly + + -- Complains if import spec mentions things that the module doesn't export + -- Warns/informs if import spec contains duplicates. +filterImports mod Nothing imports + = returnRn (imports, [], []) + +filterImports mod (Just (want_hiding, import_items)) avails + = mapRn check_item import_items `thenRn` \ item_avails -> + if want_hiding + then + returnRn (avails, item_avails, []) -- All imported; item_avails to be hidden + else + returnRn (item_avails, [], item_avails) -- Just item_avails imported; nothing to be hidden - prel_loc = mkBuiltinSrcLoc + where + import_fm :: FiniteMap OccName AvailInfo + import_fm = listToFM [ (nameOccName name, avail) + | avail <- avails, + name <- availEntityNames avail] + + check_item item@(IEModuleContents _) + = addErrRn (badImportItemErr mod item) `thenRn_` + returnRn NotAvailable + + check_item item + | not (maybeToBool maybe_in_import_avails) || + (case filtered_avail of { NotAvailable -> True; other -> False }) + = addErrRn (badImportItemErr mod item) `thenRn_` + returnRn NotAvailable + + | dodgy_import = addWarnRn (dodgyImportWarn mod item) `thenRn_` + returnRn filtered_avail + + | otherwise = returnRn filtered_avail + + where + maybe_in_import_avails = lookupFM import_fm (ieOcc item) + Just avail = maybe_in_import_avails + filtered_avail = filterAvail item avail + dodgy_import = case (item, avail) of + (IEThingAll _, AvailTC _ [n]) -> True + -- This occurs when you import T(..), but + -- only export T abstractly. The single [n] + -- in the AvailTC is the type or class itself + + other -> False + +\end{code} - (uniq_imps, imp_dups) = removeDups cmp_mod the_imps - cmp_mod (ImportDecl m1 _ _ _ _) (ImportDecl m2 _ _ _ _) = cmpPString m1 m2 - qprel_imps = [ imp | imp@(ImportDecl mod True Nothing _ _) <- src_imps, - mod == pRELUDE ] - qual_mods = [ (qual_name mod as_mod, imp) | imp@(ImportDecl mod True as_mod _ _) <- src_imps ] - qual_name mod (Just as_mod) = as_mod - qual_name mod Nothing = mod +%************************************************************************ +%* * +\subsection{Qualifiying imports} +%* * +%************************************************************************ - (_, qual_dups) = removeDups cmp_qual qual_mods - bad_qual_dups = filter (not . all_same_mod) qual_dups +@qualifyImports@ takes the @ExportEnv@ after filtering through the import spec +of an import decl, and deals with producing an @RnEnv@ with the +right qualified names. It also turns the @Names@ in the @ExportEnv@ into +fully fledged @Names@. - cmp_qual (q1,_) (q2,_) = cmpPString q1 q2 - all_same_mod ((q,ImportDecl mod _ _ _ _):rest) - = all has_same_mod rest - where - has_same_mod (_,ImportDecl mod2 _ _ _ _) = mod == mod2 - - imp_mods = [ mod | ImportDecl mod _ _ _ _ <- uniq_imps, mod /= gHC_BUILTINS ] - - imp_warns = listToBag (map dupImportWarn imp_dups) - `unionBags` - listToBag (map qualPreludeImportWarn qprel_imps) - - imp_errs = listToBag (map dupQualImportErr bad_qual_dups) - ------------------------ -doImports :: IfaceCache - -> ImportNameInfo - -> UniqSupply - -> [RdrNameImportDecl] -- import declarations - -> IO (Bag (RdrName,RnName), -- imported values in scope - Bag (RdrName,RnName), -- imported tycons/classes in scope - Bag (Module, RnName), -- unqualified import from module - Bag RenamedFixityDecl, -- fixity info for imported names - Bag Error, - Bag Warning, - Bag (RnName,(ExportFlag,Bag SrcLoc))) -- import flags and src locs - -doImports iface_cache i_info us [] - = return (emptyBag, emptyBag, emptyBag, emptyBag, emptyBag, emptyBag, emptyBag) - -doImports iface_cache i_info@(g_info,done_vals,done_tcs,rec_imp_fn) us (imp:imps) - = let - (us1, us2) = splitUniqSupply us - in - doImport iface_cache i_info us1 imp - >>= \ (vals1, tcs1, unquals1, fixes1, errs1, warns1, imps1) -> +\begin{code} +qualifyImports :: Module -- Imported module + -> Bool -- True <=> want qualified import + -> Bool -- True <=> want unqualified import + -> Maybe Module -- Optional "as M" part + -> [AvailInfo] -- What's to be hidden + -> Avails -> (Name -> HowInScope) -- Whats imported and how + -> [(OccName, (Fixity, HowInScope))] -- Ditto for fixities + -> RnMG (RnEnv, ExportAvails) + +qualifyImports this_mod qual_imp unqual_imp as_mod hides + avails name_to_his fixities + = + -- Make the name environment. Even though we're talking about a + -- single import module there might still be name clashes, + -- because it might be the module being compiled. + foldlRn add_avail emptyGlobalNameEnv avails `thenRn` \ name_env1 -> let - ext_vals = foldl add_new_one done_vals (bagToList vals1) - ext_tcs = foldl add_new_one done_tcs (bagToList tcs1) - in - doImports iface_cache (g_info,ext_vals,ext_tcs,rec_imp_fn) us2 imps - >>= \ (vals2, tcs2, unquals2, fixes2, errs2, warns2, imps2) -> - return (vals1 `unionBags` vals2, - tcs1 `unionBags` tcs2, - unquals1 `unionBags` unquals2, - fixes1 `unionBags` fixes2, - errs1 `unionBags` errs2, - warns1 `unionBags` warns2, - imps1 `unionBags` imps2) - where - add_new_one :: FiniteMap OrigName RnName -- ones done so far - -> (dont_care, RnName) - -> FiniteMap OrigName RnName -- extended + -- Delete things that are hidden + name_env2 = foldl del_avail name_env1 hides - add_new_one fm (_, rn) - = let - orig = origName "add_new_one" rn - in - case (lookupFM fm orig) of - Just _ -> fm -- already there: no change - Nothing -> addToFM fm orig rn - ----------------------- -doImport :: IfaceCache - -> ImportNameInfo - -> UniqSupply - -> RdrNameImportDecl - -> IO (Bag (RdrName,RnName), -- values - Bag (RdrName,RnName), -- tycons/classes - Bag (Module,RnName), -- unqual imports - Bag RenamedFixityDecl, - Bag Error, - Bag Warning, - Bag (RnName,(ExportFlag,Bag SrcLoc))) -- import flags and src locs - -doImport iface_cache info us (ImportDecl mod qual maybe_as maybe_spec src_loc) - = let - (b_vals, b_tcs, maybe_spec') = getBuiltins info mod maybe_spec + -- Create the fixity env + fixity_env = foldl (add_fixity name_env2) emptyFixityEnv fixities + + -- Create the export-availability info + export_avails = mkExportAvails qual_mod unqual_imp name_env2 avails in - (if mod == gHC_BUILTINS then - return (Succeeded (panic "doImport:GHC fake import!"), - \ iface -> ([], [], emptyBag)) - else - --pprTrace "doImport:" (ppPStr mod) $ - cachedIface False iface_cache mod >>= \ maybe_iface -> - return (maybe_iface, \ iface -> getOrigIEs iface maybe_spec') - ) >>= \ (maybe_iface, do_ies) -> - - case maybe_iface of - Failed err -> - return (emptyBag, emptyBag, emptyBag, emptyBag, - unitBag err, emptyBag, emptyBag) - Succeeded iface -> - let - (ies, chk_ies, get_errs) = do_ies iface - in - doOrigIEs iface_cache info mod src_loc us ies - >>= \ (ie_vals, ie_tcs, imp_flags, errs, warns) -> - accumulate (map (checkOrigIE iface_cache) chk_ies) - >>= \ chk_errs_warns -> - let - final_vals = mapBag fst_occ b_vals `unionBags` mapBag pair_occ ie_vals - final_tcs = mapBag fst_occ b_tcs `unionBags` mapBag pair_occ ie_tcs - final_vals_list = bagToList final_vals - in - (if mod == gHC_BUILTINS then - return [ (Nothing, emptyBag) | _ <- final_vals_list ] - else - accumulate (map (getFixityDecl iface_cache . snd) final_vals_list) - ) >>= \ fix_maybes_errs -> - let - (chk_errs, chk_warns) = unzip chk_errs_warns - (fix_maybes, fix_errs) = unzip fix_maybes_errs - - unquals = if qual{-ified import-} - then emptyBag - else mapBag pair_as (ie_vals `unionBags` ie_tcs) - - final_fixes = listToBag (catMaybes fix_maybes) - - final_errs = mapBag (\ err -> err mod src_loc) (unionManyBags (get_errs:chk_errs)) - `unionBags` errs `unionBags` unionManyBags fix_errs - final_warns = mapBag (\ warn -> warn mod src_loc) (unionManyBags chk_warns) - `unionBags` warns - imp_stuff = mapBag (\ (n,imp) -> (n,(imp,unitBag src_loc))) imp_flags - in - return (final_vals, final_tcs, unquals, final_fixes, - final_errs, final_warns, imp_stuff) - where - as_mod :: Module - as_mod = case maybe_as of {Nothing -> mod; Just as_this -> as_this} - - mk_occ :: FAST_STRING -> RdrName - mk_occ str = if qual then Qual as_mod str else Unqual str - - fst_occ :: (FAST_STRING, RnName) -> (RdrName, RnName) - fst_occ (str, rn) = (mk_occ str, rn) - - pair_occ :: RnName -> (RdrName, RnName) - pair_occ rn = (mk_occ (getLocalName rn), rn) - - pair_as :: RnName -> (Module, RnName) - pair_as rn = (as_mod, rn) - ------------------------------ -getBuiltins :: ImportNameInfo - -> Module - -> Maybe (Bool, [RdrNameIE]) - -> (Bag (FAST_STRING, RnName), - Bag (FAST_STRING, RnName), - Maybe (Bool, [RdrNameIE]) -- return IEs that had no effect - ) - -getBuiltins _ modname maybe_spec - | modname `notElem` modulesWithBuiltins - = (emptyBag, emptyBag, maybe_spec) - -getBuiltins (((b_val_names,b_tc_names),_,_,_),_,_,_) modname maybe_spec - = case maybe_spec of - Nothing -> (all_vals, all_tcs, Nothing) - - Just (True, ies) -> -- hiding does not work for builtin names - trace "NOTE: `import Prelude hiding ...' does not hide built-in names" $ - (all_vals, all_tcs, maybe_spec) - - Just (False, ies) -> let - (vals,tcs,ies_left) = do_builtin ies - in - (vals, tcs, Just (False, ies_left)) + returnRn (RnEnv name_env2 fixity_env, export_avails) where - all_vals = do_all_builtin (fmToList b_val_names) - all_tcs = do_all_builtin (fmToList b_tc_names) - - do_all_builtin [] = emptyBag - do_all_builtin (((OrigName mod str),rn):rest) - = --pprTrace "do_all_builtin:" (ppCat [ppPStr modname, ppPStr mod, ppPStr str]) $ - (if mod == modname then consBag (str, rn) else id) (do_all_builtin rest) - - do_builtin [] = (emptyBag,emptyBag,[]) - do_builtin (ie:ies) - = let - (str, orig) - = case (ie_name ie) of - Unqual s -> (s, OrigName modname s) - Qual m s -> pprTrace "do_builtin:surprising qual!" (ppCat [ppPStr m, ppPStr s]) $ - (s, OrigName modname s) - in - case (lookupFM b_tc_names orig) of -- NB: we favour the tycon/class FM... - Just rn -> case (ie,rn) of - (IEThingAbs _, WiredInTyCon tc) - -> (vals, (str, rn) `consBag` tcs, ies_left) - (IEThingAll _, WiredInTyCon tc) - -> (listToBag (map (\ id -> (getLocalName id, WiredInId id)) - (tyConDataCons tc)) - `unionBags` vals, - (str,rn) `consBag` tcs, ies_left) - (IEThingWith _ _, WiredInTyCon tc) -- No checking of With... - -> (listToBag (map (\ id -> (nameOf (origName "IEThingWith" id), WiredInId id)) - (tyConDataCons tc)) - `unionBags` vals, - (str,rn) `consBag` tcs, ies_left) - _ -> panic "importing builtin names (1)" - - Nothing -> - case (lookupFM b_val_names orig) of - Nothing -> (vals, tcs, ie:ies_left) - Just rn -> case (ie,rn) of - (IEVar _, WiredInId _) - -> ((str, rn) `consBag` vals, tcs, ies_left) - _ -> panic "importing builtin names (2)" - where - (vals, tcs, ies_left) = do_builtin ies + qual_mod = case as_mod of + Nothing -> this_mod + Just another_name -> another_name + + add_avail :: GlobalNameEnv -> AvailInfo -> RnMG GlobalNameEnv + add_avail env avail = foldlRn add_name env (availNames avail) + + add_name env name = add qual_imp env (Qual qual_mod occ err_hif) `thenRn` \ env1 -> + add unqual_imp env1 (Unqual occ) + where + add False env rdr_name = returnRn env + add True env rdr_name = addOneToGlobalNameEnv env rdr_name (name, name_to_his name) + occ = nameOccName name + + del_avail env avail = foldl delOneFromGlobalNameEnv env rdr_names + where + rdr_names = map (Unqual . nameOccName) (availNames avail) + + add_fixity name_env fix_env (occ_name, fixity) + = add qual $ add unqual $ fix_env + where + qual = Qual qual_mod occ_name err_hif + unqual = Unqual occ_name + + add rdr_name fix_env | maybeToBool (lookupFM name_env rdr_name) + = addOneToFixityEnv fix_env rdr_name fixity + | otherwise + = fix_env + +err_hif = error "qualifyImports: hif" -- Not needed in key to mapping +\end{code} -------------------------- -getOrigIEs :: ParsedIface - -> Maybe (Bool, [RdrNameIE]) -- "hiding" or not, blah, blah, blah - -> ([IE OrigName], - [(IE OrigName, ExportFlag)], - Bag (Module -> SrcLoc -> Error)) +unQualify adds an Unqual binding for every existing Qual binding. -getOrigIEs (ParsedIface _ _ _ _ _ _ exps _ _ _ _ _ _) Nothing -- import all - = (map mkAllIE (eltsFM exps), [], emptyBag) +\begin{code} +unQualify :: FiniteMap RdrName elt -> FiniteMap RdrName elt +unQualify fm = addListToFM fm [(Unqual occ, elt) | (Qual _ occ _, elt) <- fmToList fm] +\end{code} -getOrigIEs (ParsedIface _ _ _ _ _ _ exps _ _ _ _ _ _) (Just (True, ies)) -- import hiding - = (map mkAllIE (eltsFM exps_left), found_ies, errs) - where - (found_ies, errs) = lookupIEs exps ies - exps_left = delListFromFM exps (map (getLocalName.ie_name.fst) found_ies) +%************************************************************************ +%* * +\subsection{Local declarations} +%* * +%************************************************************************ -getOrigIEs (ParsedIface _ _ _ _ _ _ exps _ _ _ _ _ _) (Just (False, ies)) -- import these - = (map fst found_ies, found_ies, errs) - where - (found_ies, errs) = lookupIEs exps ies - ------------------------------------------------- -mkAllIE :: (OrigName, ExportFlag) -> IE OrigName - -mkAllIE (orig,ExportAbs) - = ASSERT(isLexCon (nameOf orig)) - IEThingAbs orig -mkAllIE (orig, ExportAll) - | isLexCon (nameOf orig) - = IEThingAll orig - | otherwise - = IEVar orig - ------------- -lookupIEs :: ExportsMap - -> [RdrNameIE] - -> ([(IE OrigName, ExportFlag)], -- IEs we found, orig-ified - Bag (Module -> SrcLoc -> Error)) - -lookupIEs exps ies - = foldr go ([], emptyBag) ies - where - go ie (already, errs) - = let - str = case (ie_name ie) of - Unqual s -> s - Qual m s -> s - in - case (lookupFM exps str) of - Nothing -> - (already, unknownImpSpecErr ie `consBag` errs) - Just (orig, flag) -> - ((orig_ie orig ie, flag) : already, - adderr_if (seen_ie orig already) (duplicateImpSpecErr ie) errs) - - orig_ie orig (IEVar n) = IEVar orig - orig_ie orig (IEThingAbs n) = IEThingAbs orig - orig_ie orig (IEThingAll n) = IEThingAll orig - orig_ie orig (IEThingWith n ns) = IEThingWith orig (map re_orig ns) - where - (OrigName mod _) = orig - re_orig (Unqual s) = OrigName mod s - seen_ie orig seen_ies = any (\ (ie,_) -> orig == ie_name ie) seen_ies +\begin{code} +fixityFromFixDecl :: RdrNameFixityDecl -> RnMG (OccName, (Fixity, HowInScope)) --------------------------------------------- -doOrigIEs iface_cache info mod src_loc us [] - = return (emptyBag,emptyBag,emptyBag,emptyBag,emptyBag) +fixityFromFixDecl (FixityDecl rdr_name fixity loc) + = returnRn (rdrNameOcc rdr_name, (fixity, FromLocalDefn loc)) +\end{code} -doOrigIEs iface_cache info mod src_loc us (ie:ies) - = let - (us1, us2) = splitUniqSupply us - in - doOrigIE iface_cache info mod src_loc us1 ie - >>= \ (vals1, tcs1, imps1, errs1, warns1) -> - doOrigIEs iface_cache info mod src_loc us2 ies - >>= \ (vals2, tcs2, imps2, errs2, warns2) -> - return (vals1 `unionBags` vals2, - tcs1 `unionBags` tcs2, - imps1 `unionBags` imps2, - errs1 `unionBags` errs2, - warns1 `unionBags` warns2) - ----------------------- -doOrigIE :: IfaceCache - -> ImportNameInfo - -> Module - -> SrcLoc - -> UniqSupply - -> IE OrigName - -> IO (Bag RnName, -- values - Bag RnName, -- tycons/classes - Bag (RnName,ExportFlag), -- import flags - Bag Error, - Bag Warning) - -doOrigIE iface_cache info mod src_loc us ie - = with_decl iface_cache (ie_name ie) - (\ err -> (emptyBag, emptyBag, emptyBag, unitBag err, emptyBag)) - (\ decl -> case initRn True mod emptyRnEnv us - (setExtraRn info $ - pushSrcLocRn src_loc $ - getIfaceDeclNames ie decl) - of - ((vals, tcs, imps), errs, warns) -> (vals, tcs, imps, errs, warns)) - -------------------------- -checkOrigIE :: IfaceCache - -> (IE OrigName, ExportFlag) - -> IO (Bag (Module -> SrcLoc -> Error), Bag (Module -> SrcLoc -> Warning)) - -checkOrigIE iface_cache (IEThingAll n, ExportAbs) - = with_decl iface_cache n - (\ err -> (unitBag (\ mod locn -> err), emptyBag)) - (\ decl -> case decl of - TypeSig _ _ _ -> (emptyBag, unitBag (allWhenSynImpSpecWarn n)) - other -> (unitBag (allWhenAbsImpSpecErr n), emptyBag)) - -checkOrigIE iface_cache (IEThingWith n ns, ExportAbs) - = return (unitBag (withWhenAbsImpSpecErr n), emptyBag) - -checkOrigIE iface_cache (IEThingWith n ns, ExportAll) - = with_decl iface_cache n - (\ err -> (unitBag (\ mod locn -> err), emptyBag)) - (\ decl -> case decl of - NewTypeSig _ con _ _ -> (check_with "constructors" [con] ns, emptyBag) - DataSig _ cons fields _ _ -> (check_with "constructors (and fields)" (cons++fields) ns, emptyBag) - ClassSig _ ops _ _ -> (check_with "class ops" ops ns, emptyBag)) + +%************************************************************************ +%* * +\subsection{Export list processing +%* * +%************************************************************************ + +The @AvailEnv@ type is just used internally in @exportsFromAvail@. +When exporting we need to combine the availabilities for a particular +exported thing, and we also need to check for name clashes -- that +is: two exported things must have different @OccNames@. + +\begin{code} +type AvailEnv = FiniteMap OccName (RdrNameIE, AvailInfo, Int{-no. of clashes-}) + -- The FM maps each OccName to the RdrNameIE that gave rise to it, + -- for error reporting, as well as to its AvailInfo + +emptyAvailEnv = emptyFM + +{- + Add new entry to environment. Checks for name clashes, i.e., + plain duplicates or exported entity pairs that have different OccNames. + (c.f. 5.1.1 of Haskell 1.4 report.) +-} +addAvailEnv :: Bool -> RdrNameIE -> AvailEnv -> AvailInfo -> RnM s d AvailEnv +addAvailEnv warn_dups ie env NotAvailable = returnRn env +addAvailEnv warn_dups ie env (AvailTC _ []) = returnRn env +addAvailEnv warn_dups ie env avail + | warn_dups = mapMaybeRn (addErrRn . availClashErr) () conflict `thenRn_` + returnRn (addToFM_C addAvail env key elt) + | otherwise = returnRn (addToFM_C addAvail env key elt) where - check_with str has origs - | sortLt (<) (map getLocalName has) == sortLt (<) (map nameOf origs) - = emptyBag - | otherwise - = unitBag (withImpSpecErr str n has origs) - -checkOrigIE iface_cache other - = return (emptyBag, emptyBag) - ------------------------ -with_decl :: IfaceCache - -> OrigName - -> (Error -> something) -- if an error... - -> (RdrIfaceDecl -> something) -- if OK... - -> IO something - -with_decl iface_cache n do_err do_decl - = cachedDecl iface_cache (isLexCon (nameOf n)) n >>= \ maybe_decl -> - case maybe_decl of - Failed err -> return (do_err err) - Succeeded decl -> return (do_decl decl) - -------------- -getFixityDecl :: IfaceCache - -> RnName - -> IO (Maybe RenamedFixityDecl, Bag Error) - -getFixityDecl iface_cache rn - = let - (OrigName mod str) = origName "getFixityDecl" rn - - succeeded infx i = return (Just (infx rn i), emptyBag) - in - cachedIface True iface_cache mod >>= \ maybe_iface -> - case maybe_iface of - Failed err -> - return (Nothing, unitBag err) - Succeeded (ParsedIface _ _ _ _ _ _ _ _ fixes _ _ _ _) -> - case lookupFM fixes str of - Nothing -> return (Nothing, emptyBag) - Just (InfixL _ i) -> succeeded InfixL i - Just (InfixR _ i) -> succeeded InfixR i - Just (InfixN _ i) -> succeeded InfixN i - -ie_name (IEVar n) = n -ie_name (IEThingAbs n) = n -ie_name (IEThingAll n) = n -ie_name (IEThingWith n _) = n - -adderr_if True err errs = err `consBag` errs -adderr_if False err errs = errs + occ_avail = nameOccName (availName avail) + occ_ie = ieOcc ie + key + | not warn_dups || occ_ie == occ_avail = occ_avail + | otherwise = occ_ie + -- export item is a class method, use export occ name instead. + -- (this is only needed to get more precise warnings about + -- duplicates.) + elt = (ie,avail,reports_on) + + reports_on + | maybeToBool dup = 1 + | otherwise = 0 + + conflict = conflictFM bad_avail env key elt + dup + | warn_dups = conflictFM dup_avail env key elt + | otherwise = Nothing + +addListToAvailEnv :: AvailEnv -> RdrNameIE -> [AvailInfo] -> RnM s d AvailEnv +addListToAvailEnv env ie items + = foldlRn (addAvailEnv False{-don't warn about dups-} ie) env items + +bad_avail (ie1,avail1,r1) (ie2,avail2,r2) + = availName avail1 /= availName avail2 -- Same OccName, different Name +dup_avail (ie1,avail1,r1) (ie2,avail2,r2) + = availName avail1 == availName avail2 -- Same OccName & avail. + +addAvail (ie1,a1,r1) (ie2,a2,r2) = (ie1, a1 `plusAvail` a2, r1 + r2) \end{code} -********************************************************* -* * -\subsection{Actually creating the imported names} -* * -********************************************************* +Processing the export list. + +You might think that we should record things that appear in the export list as +``occurrences'' (using addOccurrenceName), but you'd be wrong. We do check (here) +that they are in scope, but there is no need to slurp in their actual declaration +(which is what addOccurrenceName forces). Indeed, doing so would big trouble when +compiling PrelBase, because it re-exports GHC, which includes takeMVar#, whose type +includes ConcBase.StateAndSynchVar#, and so on... \begin{code} -getIfaceDeclNames :: IE OrigName -> RdrIfaceDecl - -> RnM_IInfo s (Bag RnName, -- values - Bag RnName, -- tycons/classes - Bag (RnName,ExportFlag)) -- import flags - -getIfaceDeclNames ie (ValSig val src_loc _) - = newImportedName False src_loc Nothing Nothing val `thenRn` \ val_name -> - returnRn (unitBag (RnName val_name), - emptyBag, - unitBag (RnName val_name, ExportAll)) - -getIfaceDeclNames ie (TypeSig tycon src_loc _) - = newImportedName True src_loc Nothing Nothing tycon `thenRn` \ tycon_name -> - returnRn (emptyBag, - unitBag (RnSyn tycon_name), - unitBag (RnSyn tycon_name, ExportAll)) - -getIfaceDeclNames ie (NewTypeSig tycon con src_loc _) - = newImportedName True src_loc Nothing Nothing tycon `thenRn` \ tycon_name -> - newImportedName False src_loc (Just (nameExportFlag tycon_name)) - (Just (nameImportFlag tycon_name)) - con `thenRn` \ con_name -> - returnRn (if imp_all (imp_flag ie) then - unitBag (RnConstr con_name tycon_name) - else - emptyBag, - unitBag (RnData tycon_name [con_name] []), - unitBag (RnData tycon_name [con_name] [], imp_flag ie)) - -getIfaceDeclNames ie (DataSig tycon cons fields src_loc _) - = newImportedName True src_loc Nothing Nothing tycon `thenRn` \ tycon_name -> +exportsFromAvail :: Module + -> Maybe [RdrNameIE] -- Export spec + -> ExportAvails + -> RnEnv + -> RnMG (Name -> ExportFlag, ExportEnv) + -- Complains if two distinct exports have same OccName + -- Warns about identical exports. + -- Complains about exports items not in scope +exportsFromAvail this_mod Nothing export_avails rn_env + = exportsFromAvail this_mod (Just [IEModuleContents this_mod]) export_avails rn_env + +exportsFromAvail this_mod (Just export_items) + (mod_avail_env, entity_avail_env) + (RnEnv global_name_env fixity_env) + = checkForModuleExportDups export_items `thenRn` \ export_items' -> + foldlRn exports_from_item emptyAvailEnv export_items' `thenRn` \ export_avail_env -> let - map_me = mapRn (newImportedName False src_loc - (Just (nameExportFlag tycon_name)) - (Just (nameImportFlag tycon_name))) + dup_entries = fmToList (filterFM (\ _ (_,_,clashes) -> clashes > 0) export_avail_env) in - map_me cons `thenRn` \ con_names -> - map_me fields `thenRn` \ field_names -> + mapRn (addWarnRn . dupExportWarn) dup_entries `thenRn_` let - rn_tycon = RnData tycon_name con_names field_names - rn_constrs = [ RnConstr name tycon_name | name <- con_names ] - rn_fields = [ RnField name tycon_name | name <- field_names ] + export_avails = map (\ (_,a,_) -> a) (eltsFM export_avail_env) + export_fixities = mk_exported_fixities (availsToNameSet export_avails) + export_fn = mk_export_fn export_avails in - returnRn (if imp_all (imp_flag ie) then - listToBag rn_constrs `unionBags` listToBag rn_fields - else - emptyBag, - unitBag rn_tycon, - unitBag (rn_tycon, imp_flag ie)) - -getIfaceDeclNames ie (ClassSig cls ops src_loc _) - = newImportedName True src_loc Nothing Nothing cls `thenRn` \ cls_name -> - mapRn (newImportedName False src_loc (Just (nameExportFlag cls_name)) - (Just (nameImportFlag cls_name))) - ops `thenRn` \ op_names -> - returnRn (if imp_all (imp_flag ie) then - listToBag (map (\ n -> RnClassOp n cls_name) op_names) - else - emptyBag, - unitBag (RnClass cls_name op_names), - unitBag (RnClass cls_name op_names, imp_flag ie)) - - -imp_all ExportAll = True -imp_all _ = False - -imp_flag (IEThingAbs _) = ExportAbs -imp_flag (IEThingAll _) = ExportAll -imp_flag (IEThingWith _ _) = ExportAll -\end{code} - -********************************************************* -* * -\subsection{Creating a new imported name} -* * -********************************************************* + returnRn (export_fn, ExportEnv export_avails export_fixities) -\begin{code} -newImportedName :: Bool -- True => tycon or class - -> SrcLoc - -> Maybe ExportFlag -- maybe export flag - -> Maybe ExportFlag -- maybe import flag - -> RdrName -- orig name - -> RnM_IInfo s Name - -newImportedName tycon_or_class locn maybe_exp maybe_imp rdr - = let - orig = qualToOrigName rdr - in - getExtraRn `thenRn` \ ((_,b_keys,rec_exp_fn,rec_occ_fn),done_vals,done_tcs,rec_imp_fn) -> - case ((if tycon_or_class - then lookupFM done_tcs - else lookupFM done_vals) orig) of - - Just rn -> returnRn (getName rn) - Nothing -> - rnGetUnique `thenRn` \ u -> - let - uniq = case lookupFM b_keys orig of - Nothing -> u - Just (key,_) -> key - - exp = case maybe_exp of - Just xx -> xx - Nothing -> rec_exp_fn n - - imp = case maybe_imp of - Just xx -> xx - Nothing -> imp_flag - - (imp_flag, imp_locs) = rec_imp_fn n - - n = mkImportedName uniq orig imp locn imp_locs exp (rec_occ_fn n) -- NB: two "n"s + where + exports_from_item :: AvailEnv -> RdrNameIE -> RnMG AvailEnv + exports_from_item export_avail_env ie@(IEModuleContents mod) + = case lookupFM mod_avail_env mod of + Nothing -> failWithRn export_avail_env (modExportErr mod) + Just avails -> addListToAvailEnv export_avail_env ie avails + + exports_from_item export_avail_env ie + | not (maybeToBool maybe_in_scope) + = failWithRn export_avail_env (unknownNameErr (ieName ie)) + +#ifdef DEBUG + -- I can't see why this should ever happen; if the thing is in scope + -- at all it ought to have some availability + | not (maybeToBool maybe_avail) + = pprTrace "exportsFromAvail: curious Nothing:" (ppr name) + returnRn export_avail_env +#endif + + | not enough_avail + = failWithRn export_avail_env (exportItemErr ie export_avail) + + | otherwise -- Phew! It's OK! + = addAvailEnv opt_WarnDuplicateExports ie export_avail_env export_avail + where + maybe_in_scope = lookupFM global_name_env (ieName ie) + Just (name,_) = maybe_in_scope + maybe_avail = lookupUFM entity_avail_env name + Just avail = maybe_avail + export_avail = filterAvail ie avail + enough_avail = case export_avail of {NotAvailable -> False; other -> True} + + -- We export a fixity iff we export a thing with the same (qualified) RdrName + mk_exported_fixities :: NameSet -> [(OccName, Fixity)] + mk_exported_fixities exports + = fmToList (foldr (perhaps_add_fixity exports) + emptyFM + (fmToList fixity_env)) + + perhaps_add_fixity :: NameSet -> (RdrName, (Fixity, HowInScope)) + -> FiniteMap OccName Fixity + -> FiniteMap OccName Fixity + perhaps_add_fixity exports (rdr_name, (fixity, how_in_scope)) fix_env + = let + do_nothing = fix_env -- The default is to pass on the env unchanged + in + -- Step 1: check whether the rdr_name is in scope; if so find its Name + case lookupFM global_name_env rdr_name of { + Nothing -> do_nothing; + Just (fixity_name,_) -> + + -- Step 2: check whether the fixity thing is exported + if not (fixity_name `elemNameSet` exports) then + do_nothing + else + + -- Step 3: check whether we already have a fixity for the + -- Name's OccName in the fix_env we are building up. This can easily + -- happen. the original fixity_env might contain bindings for + -- M.a and N.a, if a was imported via M and N. + -- If this does happen, we expect the fixity to be the same either way. + let + occ_name = rdrNameOcc rdr_name in - returnRn n -\end{code} - -\begin{code} -globalDupNamesErr rdr rns sty - = ppAboves (message : map pp_dup rns) + case lookupFM fix_env occ_name of { + Just fixity1 -> -- Got it already + ASSERT( fixity == fixity1 ) + do_nothing; + Nothing -> + + -- Step 3: add it to the outgoing fix_env + addToFM fix_env occ_name fixity + }} + +{- warn and weed out duplicate module entries from export list. -} +checkForModuleExportDups :: [RdrNameIE] -> RnMG [RdrNameIE] +checkForModuleExportDups ls + | opt_WarnDuplicateExports = check_modules ls + | otherwise = returnRn ls where - message = ppBesides [ppStr "multiple declarations of `", pprNonSym sty rdr, ppStr "'"] - - pp_dup rn = addShortErrLocLine (get_loc rn) (\ sty -> - ppCat [pp_descrip rn, pprNonSym sty rn]) sty - - get_loc rn = case getImpLocs rn of - [] -> getSrcLoc rn - locs -> head locs - - pp_descrip (RnName _) = ppStr "as a value:" - pp_descrip (RnSyn _) = ppStr "as a type synonym:" - pp_descrip (RnData _ _ _) = ppStr "as a data type:" - pp_descrip (RnConstr _ _) = ppStr "as a data constructor:" - pp_descrip (RnField _ _) = ppStr "as a record field:" - pp_descrip (RnClass _ _) = ppStr "as a class:" - pp_descrip (RnClassOp _ _) = ppStr "as a class method:" - pp_descrip _ = ppNil - -dupImportWarn (ImportDecl m1 _ _ _ locn1 : dup_imps) sty - = ppAboves (item1 : map dup_item dup_imps) + -- NOTE: reorders the export list by moving all module-contents + -- exports to the end (removing duplicates in the process.) + check_modules ls = + (case dups of + [] -> returnRn () + ls -> mapRn (\ ds@(IEModuleContents x:_) -> + addWarnRn (dupModuleExport x (length ds))) ls `thenRn_` + returnRn ()) `thenRn_` + returnRn (ls_no_modules ++ no_module_dups) + where + (ls_no_modules,modules) = foldr split_mods ([],[]) ls + + split_mods i@(IEModuleContents _) (no_ms,ms) = (no_ms,i:ms) + split_mods i (no_ms,ms) = (i:no_ms,ms) + + (no_module_dups, dups) = removeDups cmp_mods modules + + cmp_mods (IEModuleContents m1) (IEModuleContents m2) = m1 `compare` m2 + +mk_export_fn :: [AvailInfo] -> (Name -> ExportFlag) +mk_export_fn avails + = \name -> if name `elemNameSet` exported_names + then Exported + else NotExported where - item1 = addShortWarnLocLine locn1 (\ sty -> - ppCat [ppStr "multiple imports from module", ppPStr m1]) sty - - dup_item (ImportDecl m _ _ _ locn) - = addShortWarnLocLine locn (\ sty -> - ppCat [ppStr "here was another import from module", ppPStr m]) sty + exported_names :: NameSet + exported_names = availsToNameSet avails +\end{code} -qualPreludeImportWarn (ImportDecl m _ _ _ locn) - = addShortWarnLocLine locn (\ sty -> - ppCat [ppStr "qualified import of prelude module", ppPStr m]) +%************************************************************************ +%* * +\subsection{Errors} +%* * +%************************************************************************ -dupQualImportErr ((q1,ImportDecl _ _ _ _ locn1):dup_quals) sty - = ppAboves (item1 : map dup_item dup_quals) - where - item1 = addShortErrLocLine locn1 (\ sty -> - ppCat [ppStr "multiple imports (from different modules) with same qualified name", ppPStr q1]) sty - - dup_item (q,ImportDecl _ _ _ _ locn) - = addShortErrLocLine locn (\ sty -> - ppCat [ppStr "here was another import with qualified name", ppPStr q]) sty - -unknownImpSpecErr ie imp_mod locn - = addShortErrLocLine locn (\ sty -> - ppBesides [ppStr "module ", ppPStr imp_mod, ppStr " does not export `", ppr sty (ie_name ie), ppStr "'"]) - -duplicateImpSpecErr ie imp_mod locn - = addShortErrLocLine locn (\ sty -> - ppBesides [ppStr "`", ppr sty (ie_name ie), ppStr "' already seen in import list"]) - -allWhenSynImpSpecWarn n imp_mod locn - = addShortWarnLocLine locn (\ sty -> - ppBesides [ppStr "type synonym `", ppr sty n, ppStr "' should not be imported with (..)"]) - -allWhenAbsImpSpecErr n imp_mod locn - = addShortErrLocLine locn (\ sty -> - ppBesides [ppStr "module ", ppPStr imp_mod, ppStr " only exports `", ppr sty n, ppStr "' abstractly"]) - -withWhenAbsImpSpecErr n imp_mod locn - = addShortErrLocLine locn (\ sty -> - ppBesides [ppStr "module ", ppPStr imp_mod, ppStr " only exports `", ppr sty n, ppStr "' abstractly"]) - -withImpSpecErr str n has ns imp_mod locn - = addErrLoc locn "" (\ sty -> - ppAboves [ ppBesides [ppStr "inconsistent list of", ppStr str, ppStr "in import list for `", ppr sty n, ppStr "'"], - ppCat [ppStr " expected:", ppInterleave ppComma (map (ppr sty) has)], - ppCat [ppStr " found: ", ppInterleave ppComma (map (ppr sty) ns)] ]) - -dupFieldErr con locn (dup:rest) - = addShortErrLocLine locn (\ sty -> - ppBesides [ppStr "record field `", ppr sty dup, ppStr "declared multiple times in `", ppr sty con, ppStr "'"]) +\begin{code} +badImportItemErr mod ie + = sep [ptext SLIT("Module"), quotes (pprModule mod), + ptext SLIT("does not export"), quotes (ppr ie)] + +dodgyImportWarn mod (IEThingAll tc) + = sep [ptext SLIT("Module") <+> quotes (pprModule mod) <+> ptext SLIT("exports") <+> quotes (ppr tc), + ptext SLIT("with no constructors/class operations;"), + ptext SLIT("yet it is imported with a (..)")] + +modExportErr mod + = hsep [ ptext SLIT("Unknown module in export list: module"), quotes (pprModule mod)] + +exportItemErr export_item NotAvailable + = sep [ ptext SLIT("Export item not in scope:"), quotes (ppr export_item)] + +exportItemErr export_item avail + = hang (ptext SLIT("Export item not fully in scope:")) + 4 (vcat [hsep [ptext SLIT("Wanted: "), ppr export_item], + hsep [ptext SLIT("Available:"), ppr (ieOcc export_item), pprAvail avail]]) + +availClashErr (occ_name, ((ie1,avail1,_), (ie2,avail2,_))) + = hsep [ptext SLIT("The export items"), quotes (ppr ie1), ptext SLIT("and"), quotes (ppr ie2), + ptext SLIT("create conflicting exports for"), quotes (ppr occ_name)] + +dupExportWarn (occ_name, (_,_,times)) + = hsep [quotes (ppr occ_name), + ptext SLIT("mentioned"), speakNTimes (times+1), + ptext SLIT("in export list")] + +dupModuleExport mod times + = hsep [ptext SLIT("Module"), quotes (pprModule mod), + ptext SLIT("mentioned"), speakNTimes times, + ptext SLIT("in export list")] \end{code} +