X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Frename%2FRnIfaces.lhs;h=04252d9150e8acac12584d7f0e4807b4df24bf17;hb=f8d1d20eb4779a42e72b6a06c47d6e0f13075bf4;hp=6b0b75c4d615b7eb2cf5cc2363f72d66ca01cd30;hpb=e7498a3ee1d0484d02a9e86633cc179c76ebf36e;p=ghc-hetmet.git diff --git a/ghc/compiler/rename/RnIfaces.lhs b/ghc/compiler/rename/RnIfaces.lhs index 6b0b75c..04252d9 100644 --- a/ghc/compiler/rename/RnIfaces.lhs +++ b/ghc/compiler/rename/RnIfaces.lhs @@ -7,895 +7,948 @@ #include "HsVersions.h" module RnIfaces ( --- findHiFiles, - cachedIface, - cachedDecl, - readIface, - rnIfaces, - IfaceCache(..) + getInterfaceExports, + getImportedInstDecls, + getSpecialInstModules, getDeferredDataDecls, + importDecl, recordSlurp, + getImportVersions, getSlurpedNames, getRnStats, + + checkUpToDate, + + getDeclBinders, + mkSearchPath ) where IMP_Ubiq() +#if __GLASGOW_HASKELL__ >= 202 +import IO +#endif -import LibDirectory -import PreludeGlaST ( thenPrimIO, seqPrimIO, readVar, writeVar, MutableVar(..) ) -import HsSyn +import CmdLineOpts ( opt_TyConPruning ) +import HsSyn ( HsDecl(..), TyDecl(..), ClassDecl(..), HsTyVar, HsExpr, Sig(..), HsType(..), + HsBinds(..), MonoBinds, DefaultDecl, ConDecl(..), ConDetails(..), BangType, IfaceSig(..), + FixityDecl(..), Fixity, Fake, InPat, InstDecl(..), SYN_IE(Version), HsIdInfo, + IE(..), NewOrData(..), hsDeclName + ) import HsPragmas ( noGenPragmas ) -import RdrHsSyn -import RnHsSyn - +import RdrHsSyn ( SYN_IE(RdrNameHsDecl), SYN_IE(RdrNameInstDecl), SYN_IE(RdrNameTyDecl), + RdrName, rdrNameOcc + ) +import RnEnv ( newGlobalName, lookupRn, addImplicitOccsRn, + availName, availNames, addAvailToNameSet, pprAvail + ) +import RnSource ( rnHsSigType ) import RnMonad -import RnSource ( rnTyDecl, rnClassDecl, rnInstDecl, rnPolyType ) -import RnUtils ( RnEnv(..), emptyRnEnv, lookupRnEnv, lookupTcRnEnv, extendGlobalRnEnv ) +import RnHsSyn ( SYN_IE(RenamedHsDecl) ) import ParseIface ( parseIface ) -import ParseUtils ( ParsedIface(..), RdrIfaceDecl(..), RdrIfaceInst(..), - VersionsMap(..), UsagesMap(..) - ) -import Bag ( emptyBag, unitBag, consBag, snocBag, - unionBags, unionManyBags, isEmptyBag, bagToList ) -import ErrUtils ( Error(..), Warning(..) ) -import FiniteMap ( emptyFM, lookupFM, addToFM, addToFM_C, plusFM, eltsFM, - fmToList, delListFromFM, sizeFM, foldFM, unitFM, - plusFM_C, addListToFM, keysFM{-ToDo:rm-} +import ErrUtils ( SYN_IE(Error), SYN_IE(Warning) ) +import FiniteMap ( FiniteMap, sizeFM, emptyFM, unitFM, delFromFM, + lookupFM, addToFM, addToFM_C, addListToFM, + fmToList, eltsFM ) -import Maybes ( maybeToBool ) -import Name ( moduleNamePair, origName, isRdrLexCon, RdrName(..), Name{-instance NamedThing-} ) -import PprStyle -- ToDo:rm -import Outputable -- ToDo:rm -import PrelInfo ( builtinNameInfo ) -import PrelMods ( pRELUDE ) +import Name ( Name {-instance NamedThing-}, Provenance, OccName(..), + modAndOcc, occNameString, moduleString, pprModule, isLocallyDefined, + NameSet(..), emptyNameSet, unionNameSets, nameSetToList, + minusNameSet, mkNameSet, elemNameSet, nameUnique, + isWiredInName, maybeWiredInTyConName, maybeWiredInIdName, + NamedThing(..) + ) +import Id ( GenId, Id(..), idType, dataConTyCon, isDataCon ) +import TyCon ( TyCon, tyConDataCons, isSynTyCon, getSynTyConDefn ) +import Type ( namesOfType ) +import TyVar ( GenTyVar ) +import SrcLoc ( mkIfaceSrcLoc, SrcLoc ) +import PrelMods ( gHC__ ) +import PrelInfo ( cCallishTyKeys ) +import Bag +import Maybes ( MaybeErr(..), expectJust, maybeToBool ) +import ListSetOps ( unionLists ) import Pretty -import Maybes ( MaybeErr(..) ) -import UniqFM ( emptyUFM ) -import UniqSupply ( splitUniqSupply ) -import Util ( sortLt, removeDups, cmpPString, startsWith, - panic, pprPanic, assertPanic, pprTrace{-ToDo:rm-} ) +import PprStyle ( PprStyle(..) ) +import Unique ( Unique ) +import Util ( pprPanic, pprTrace, Ord3(..) ) +import StringBuffer ( StringBuffer, hGetStringBuffer, freeStringBuffer ) +import Outputable \end{code} + + +%********************************************************* +%* * +\subsection{Statistics} +%* * +%********************************************************* + +\begin{code} +getRnStats :: [RenamedHsDecl] -> RnMG Doc +getRnStats all_decls + = getIfacesRn `thenRn` \ ifaces -> + let + Ifaces this_mod mod_vers_map export_envs decls_fm all_names imp_names unslurped_insts deferred_data_decls inst_mods = ifaces + n_mods = sizeFM mod_vers_map + + decls_imported = filter is_imported_decl all_decls + decls_read = [decl | (name, (_, avail, decl)) <- fmToList decls_fm, + name == availName avail, + -- Data, newtype, and class decls are in the decls_fm + -- under multiple names; the tycon/class, and each + -- constructor/class op too. + not (isLocallyDefined name) + ] + + (cd_rd, dd_rd, add_rd, nd_rd, and_rd, sd_rd, vd_rd, _) = count_decls decls_read + (cd_sp, dd_sp, add_sp, nd_sp, and_sp, sd_sp, vd_sp, id_sp) = count_decls decls_imported + + inst_decls_unslurped = length (bagToList unslurped_insts) + inst_decls_read = id_sp + inst_decls_unslurped + + stats = vcat + [int n_mods <> text " interfaces read", + hsep [int cd_sp, text "class decls imported, out of", + int cd_rd, text "read"], + hsep [int dd_sp, text "data decls imported (of which", int add_sp, text "abstractly), out of", + int dd_rd, text "read"], + hsep [int nd_sp, text "newtype decls imported (of which", int and_sp, text "abstractly), out of", + int nd_rd, text "read"], + hsep [int sd_sp, text "type synonym decls imported, out of", + int sd_rd, text "read"], + hsep [int vd_sp, text "value signatures imported, out of", + int vd_rd, text "read"], + hsep [int id_sp, text "instance decls imported, out of", + int inst_decls_read, text "read"] + ] + in + returnRn (hcat [text "Renamer stats: ", stats]) + +is_imported_decl (DefD _) = False +is_imported_decl (ValD _) = False +is_imported_decl decl = not (isLocallyDefined (hsDeclName decl)) + +count_decls decls + = -- pprTrace "count_decls" (ppr PprDebug decls + -- + -- $$ + -- text "=========" + -- $$ + -- ppr PprDebug imported_decls + -- ) $ + (class_decls, + data_decls, abstract_data_decls, + newtype_decls, abstract_newtype_decls, + syn_decls, + val_decls, + inst_decls) + where + class_decls = length [() | ClD _ <- decls] + data_decls = length [() | TyD (TyData DataType _ _ _ _ _ _ _) <- decls] + newtype_decls = length [() | TyD (TyData NewType _ _ _ _ _ _ _) <- decls] + abstract_data_decls = length [() | TyD (TyData DataType _ _ _ [] _ _ _) <- decls] + abstract_newtype_decls = length [() | TyD (TyData NewType _ _ _ [] _ _ _) <- decls] + syn_decls = length [() | TyD (TySynonym _ _ _ _) <- decls] + val_decls = length [() | SigD _ <- decls] + inst_decls = length [() | InstD _ <- decls] + +\end{code} + +%********************************************************* +%* * +\subsection{Loading a new interface file} +%* * +%********************************************************* + \begin{code} -type ModuleToIfaceContents = FiniteMap Module ParsedIface -type ModuleToIfaceFilePath = FiniteMap Module FilePath - -type IfaceCache - = MutableVar _RealWorld - (ModuleToIfaceContents, -- interfaces for individual interface files - ModuleToIfaceContents, -- merged interfaces based on module name - -- used for extracting info about original names - ModuleToIfaceFilePath) +loadInterface :: Doc -> Module -> RnMG Ifaces +loadInterface doc_str load_mod + = getIfacesRn `thenRn` \ ifaces -> + let + Ifaces this_mod mod_vers_map export_envs decls all_names imp_names insts deferred_data_decls inst_mods = ifaces + in + -- CHECK WHETHER WE HAVE IT ALREADY + if maybeToBool (lookupFM export_envs load_mod) + then + returnRn ifaces -- Already in the cache; don't re-read it + else + + -- READ THE MODULE IN + findAndReadIface doc_str load_mod `thenRn` \ read_result -> + case read_result of { + -- Check for not found + Nothing -> -- Not found, so add an empty export env to the Ifaces map + -- so that we don't look again + let + new_export_envs = addToFM export_envs load_mod ([],[]) + new_ifaces = Ifaces this_mod mod_vers_map + new_export_envs + decls all_names imp_names insts deferred_data_decls inst_mods + in + setIfacesRn new_ifaces `thenRn_` + failWithRn new_ifaces (noIfaceErr load_mod) ; + + -- Found and parsed! + Just (ParsedIface _ mod_vers usages exports rd_inst_mods fixs rd_decls rd_insts) -> + + -- LOAD IT INTO Ifaces + mapRn loadExport exports `thenRn` \ avails_s -> + foldlRn (loadDecl load_mod) decls rd_decls `thenRn` \ new_decls -> + foldlRn (loadInstDecl load_mod) insts rd_insts `thenRn` \ new_insts -> + let + export_env = (concat avails_s, fixs) + + -- Exclude this module from the "special-inst" modules + new_inst_mods = inst_mods `unionLists` (filter (/= this_mod) rd_inst_mods) + + new_ifaces = Ifaces this_mod + (addToFM mod_vers_map load_mod mod_vers) + (addToFM export_envs load_mod export_env) + new_decls + all_names imp_names + new_insts + deferred_data_decls + new_inst_mods + in + setIfacesRn new_ifaces `thenRn_` + returnRn new_ifaces + } + +loadExport :: ExportItem -> RnMG [AvailInfo] +loadExport (mod, entities) + = mapRn load_entity entities + where + new_name occ = newGlobalName mod occ + +-- The communcation between this little code fragment and the "entity" rule +-- in ParseIface.y is a bit gruesome. The idea is that things which are +-- destined to be AvailTCs show up as (occ, [non-empty-list]), whereas +-- things destined to be Avails show up as (occ, []) + + load_entity (occ, occs) + = new_name occ `thenRn` \ name -> + if null occs then + returnRn (Avail name) + else + mapRn new_name occs `thenRn` \ names -> + returnRn (AvailTC name names) + +loadDecl :: Module -> DeclsMap + -> (Version, RdrNameHsDecl) + -> RnMG DeclsMap +loadDecl mod decls_map (version, decl) + = getDeclBinders new_implicit_name decl `thenRn` \ avail -> + returnRn (addListToFM decls_map + [(name,(version,avail,decl)) | name <- availNames avail] + ) + where + new_implicit_name rdr_name loc = newGlobalName mod (rdrNameOcc rdr_name) + +loadInstDecl :: Module + -> Bag IfaceInst + -> RdrNameInstDecl + -> RnMG (Bag IfaceInst) +loadInstDecl mod_name insts decl@(InstDecl inst_ty binds uprags dfun_name src_loc) + = + -- Find out what type constructors and classes are "gates" for the + -- instance declaration. If all these "gates" are slurped in then + -- we should slurp the instance decl too. + -- + -- We *don't* want to count names in the context part as gates, though. + -- For example: + -- instance Foo a => Baz (T a) where ... + -- + -- Here the gates are Baz and T, but *not* Foo. + let + munged_inst_ty = case inst_ty of + HsForAllTy tvs cxt ty -> HsForAllTy tvs [] ty + HsPreForAllTy cxt ty -> HsPreForAllTy [] ty + other -> inst_ty + in + -- We find the gates by renaming the instance type with in a + -- and returning the occurrence pool. + initRnMS emptyRnEnv mod_name InterfaceMode ( + findOccurrencesRn (rnHsSigType (\sty -> text "an instance decl") munged_inst_ty) + ) `thenRn` \ gate_names -> + returnRn (((mod_name, decl), gate_names) `consBag` insts) \end{code} -********************************************************* -* * -\subsection{Looking for interface files} -* * -********************************************************* -Return a mapping from module-name to -absolute-filename-for-that-interface. +%******************************************************** +%* * +\subsection{Loading usage information} +%* * +%******************************************************** + \begin{code} -{- OLD: -findHiFiles :: [FilePath] -> [FilePath] -> IO (FiniteMap Module FilePath) - -findHiFiles dirs sysdirs - = --hPutStr stderr " findHiFiles " >> - do_dirs emptyFM (dirs ++ sysdirs) >>= \ result -> - --hPutStr stderr " done\n" >> - return result +checkUpToDate :: Module -> RnMG Bool -- True <=> no need to recompile +checkUpToDate mod_name + = findAndReadIface doc_str mod_name `thenRn` \ read_result -> + case read_result of + Nothing -> -- Old interface file not found, so we'd better bail out + traceRn (sep [ptext SLIT("Didnt find old iface"), + pprModule PprDebug mod_name]) `thenRn_` + returnRn False + + Just (ParsedIface _ _ usages _ _ _ _ _) + -> -- Found it, so now check it + checkModUsage usages where - do_dirs env [] = return env - do_dirs env (dir:dirs) - = do_dir env dir >>= \ new_env -> - do_dirs new_env dirs - ------- - do_dir env dir - = --hPutStr stderr "D" >> - getDirectoryContents dir >>= \ entries -> - do_entries env entries - where - do_entries env [] = return env - do_entries env (e:es) - = do_entry env e >>= \ new_env -> - do_entries new_env es - ------- - do_entry env e - = case (acceptable_hi (reverse e)) of - Nothing -> --trace ("Deemed uncool:"++e) $ - --hPutStr stderr "." >> - return env - Just mod -> - let - pmod = _PK_ mod - in - case (lookupFM env pmod) of - Nothing -> --trace ("Adding "++mod++" -> "++e) $ - --hPutStr stderr "!" >> - return (addToFM env pmod (dir ++ '/':e)) - -- ToDo: use DIR_SEP, not / - - Just xx -> ( if de_dot xx /= e then trace ("Already mapped!! "++mod++" -> "++xx++"; ignoring:"++e) else id) $ - --hPutStr stderr "." >> - return env - ------- - acceptable_hi rev_e -- looking at pathname *backwards* - = case (startsWith (reverse opt_HiSuffix) rev_e) of - Nothing -> Nothing - Just xs -> plausible_modname xs{-reversed-} - - ------- - de_dot ('.' : '/' : xs) = xs - de_dot xs = xs - - ------- - plausible_modname rev_e - = let - cand = reverse (takeWhile is_modname_char rev_e) - in - if null cand || not (isUpper (head cand)) - then Nothing - else Just cand - where - is_modname_char c = isAlphanum c || c == '_' --} -\end{code} + -- Only look in current directory, with suffix .hi + doc_str = sep [ptext SLIT("Need usage info from"), pprModule PprDebug mod_name] + +checkModUsage [] = returnRn True -- Yes! Everything is up to date! + +checkModUsage ((mod, old_mod_vers, old_local_vers) : rest) + = loadInterface doc_str mod `thenRn` \ ifaces -> + let + Ifaces _ mod_vers _ decls _ _ _ _ _ = ifaces + maybe_new_mod_vers = lookupFM mod_vers mod + Just new_mod_vers = maybe_new_mod_vers + in + -- If we can't find a version number for the old module then + -- bail out saying things aren't up to date + if not (maybeToBool maybe_new_mod_vers) then + returnRn False + else + + -- If the module version hasn't changed, just move on + if new_mod_vers == old_mod_vers then + traceRn (sep [ptext SLIT("Module version unchanged:"), pprModule PprDebug mod]) `thenRn_` + checkModUsage rest + else + traceRn (sep [ptext SLIT("Module version has changed:"), pprModule PprDebug mod]) `thenRn_` + + -- New module version, so check entities inside + checkEntityUsage mod decls old_local_vers `thenRn` \ up_to_date -> + if up_to_date then + traceRn (ptext SLIT("...but the bits I use haven't.")) `thenRn_` + checkModUsage rest -- This one's ok, so check the rest + else + returnRn False -- This one failed, so just bail out now + where + doc_str = sep [ptext SLIT("need version info for"), pprModule PprDebug mod] + -********************************************************* -* * -\subsection{Reading interface files} -* * -********************************************************* +checkEntityUsage mod decls [] + = returnRn True -- Yes! All up to date! -Return cached info about a Module's interface; otherwise, -read the interface (using our @ModuleToIfaceFilePath@ map -to decide where to look). +checkEntityUsage mod decls ((occ_name,old_vers) : rest) + = newGlobalName mod occ_name `thenRn` \ name -> + case lookupFM decls name of -Note: we have two notions of interface - * the interface for a particular file name - * the (combined) interface for a particular module name + Nothing -> -- We used it before, but it ain't there now + traceRn (sep [ptext SLIT("...and this no longer exported:"), ppr PprDebug name]) `thenRn_` + returnRn False -The idea is that two source files may declare a module -with the same name with the declarations being merged. + Just (new_vers,_,_) -- It's there, but is it up to date? + | new_vers == old_vers + -- Up to date, so check the rest + -> checkEntityUsage mod decls rest -This allows us to have file PreludeList.hs producing -PreludeList.hi but defining part of module Prelude. -When PreludeList is imported its contents will be -added to Prelude. In this way all the original names -for a particular module will be available the imported -decls are renamed. + | otherwise + -- Out of date, so bale out + -> traceRn (sep [ptext SLIT("...and this is out of date:"), ppr PprDebug name]) `thenRn_` + returnRn False +\end{code} -ToDo: Check duplicate definitons are the same. -ToDo: Check/Merge duplicate pragmas. +%********************************************************* +%* * +\subsection{Getting in a declaration} +%* * +%********************************************************* \begin{code} -cachedIface :: Bool -- True => want merged interface for original name - -> IfaceCache -- False => want file interface only - -> Module - -> IO (MaybeErr ParsedIface Error) - -cachedIface want_orig_iface iface_cache mod - = readVar iface_cache `thenPrimIO` \ (iface_fm, orig_fm, file_fm) -> - - case (lookupFM iface_fm mod) of - Just iface -> return (want_iface iface orig_fm) - Nothing -> - case (lookupFM file_fm mod) of - Nothing -> return (Failed (noIfaceErr mod)) - Just file -> - readIface file mod >>= \ read_iface -> - case read_iface of - Failed err -> -- pprTrace "module-file map:\n" (ppAboves [ppCat [ppPStr m, ppStr f] | (m,f) <- fmToList file_fm]) $ - return (Failed err) - Succeeded iface -> - let - iface_fm' = addToFM iface_fm mod iface - orig_fm' = addToFM_C mergeIfaces orig_fm (iface_mod iface) iface - in - writeVar iface_cache (iface_fm', orig_fm', file_fm) `seqPrimIO` - return (want_iface iface orig_fm') - where - want_iface iface orig_fm - | want_orig_iface - = case lookupFM orig_fm mod of - Nothing -> Failed (noOrigIfaceErr mod) - Just orig_iface -> Succeeded orig_iface - | otherwise - = Succeeded iface - - iface_mod (ParsedIface mod _ _ _ _ _ _ _ _ _ _ _ _) = mod - ----------- -mergeIfaces (ParsedIface mod1 (_, files1) _ _ _ _ _ _ fixes1 tdefs1 vdefs1 idefs1 prags1) - (ParsedIface mod2 (_, files2) _ _ _ _ _ _ fixes2 tdefs2 vdefs2 idefs2 prags2) - = pprTrace "mergeIfaces:" (ppCat [ppStr "import", ppCat (map ppPStr (bagToList files2)), - ppStr "merged with", ppPStr mod1]) $ - ASSERT(mod1 == mod2) - ParsedIface mod1 - (True, unionBags files2 files1) - (panic "mergeIface: module version numbers") - (panic "mergeIface: source version numbers") -- Version numbers etc must be extracted from - (panic "mergeIface: usage version numbers") -- the merged file interfaces named above - (panic "mergeIface: decl version numbers") - (panic "mergeIface: exports") - (panic "mergeIface: instance modules") - (plusFM_C (dup_merge "fixity" (ppr PprDebug . fixDeclName)) fixes1 fixes2) - (plusFM_C (dup_merge "tycon/class" (ppr PprDebug . idecl_nm)) tdefs1 tdefs2) - (plusFM_C (dup_merge "value" (ppr PprDebug . idecl_nm)) vdefs1 vdefs2) - (unionBags idefs1 idefs2) - (plusFM_C (dup_merge "pragma" ppStr) prags1 prags2) - where - dup_merge str ppr_dup dup1 dup2 - = pprTrace "mergeIfaces:" - (ppCat [ppPStr mod1, ppPStr mod2, ppStr ": dup", ppStr str, ppStr "decl", - ppr_dup dup1, ppr_dup dup2]) $ - dup2 - - idecl_nm (TypeSig n _ _) = n - idecl_nm (NewTypeSig n _ _ _) = n - idecl_nm (DataSig n _ _ _ _) = n - idecl_nm (ClassSig n _ _ _) = n - idecl_nm (ValSig n _ _) = n - ----------- -cachedDecl :: IfaceCache - -> Bool -- True <=> tycon or class name - -> RdrName - -> IO (MaybeErr RdrIfaceDecl Error) - -cachedDecl iface_cache class_or_tycon orig - = -- pprTrace "cachedDecl:" (ppr PprDebug orig) $ - cachedIface True iface_cache mod >>= \ maybe_iface -> - case maybe_iface of - Failed err -> --pprTrace "cachedDecl:fail:" (ppr PprDebug orig) $ - return (Failed err) - Succeeded (ParsedIface _ _ _ _ _ _ exps _ _ tdefs vdefs _ _) -> - case (lookupFM (if class_or_tycon then tdefs else vdefs) str) of - Just decl -> return (Succeeded decl) - Nothing -> return (Failed (noDeclInIfaceErr mod str)) +importDecl :: Name -> Necessity -> RnMG (Maybe RdrNameHsDecl) + -- Returns Nothing for a wired-in or already-slurped decl + +importDecl name necessity + = checkSlurped name `thenRn` \ already_slurped -> + if already_slurped then + -- traceRn (sep [text "Already slurped:", ppr PprDebug name]) `thenRn_` + returnRn Nothing -- Already dealt with + else + if isWiredInName name then + getWiredInDecl name + else + getIfacesRn `thenRn` \ ifaces -> + let + Ifaces this_mod _ _ _ _ _ _ _ _ = ifaces + (mod,_) = modAndOcc name + in + if mod == this_mod then -- Don't bring in decls from + pprTrace "importDecl wierdness:" (ppr PprDebug name) $ + returnRn Nothing -- the renamed module's own interface file + -- + else + getNonWiredInDecl name necessity +\end{code} + +\begin{code} +getNonWiredInDecl :: Name -> Necessity -> RnMG (Maybe RdrNameHsDecl) +getNonWiredInDecl needed_name necessity + = traceRn doc_str `thenRn_` + loadInterface doc_str mod `thenRn` \ (Ifaces _ _ _ decls _ _ _ _ _) -> + case lookupFM decls needed_name of + + -- Special case for data/newtype type declarations + Just (version, avail, TyD ty_decl) | is_data_or_newtype ty_decl + -> getNonWiredDataDecl needed_name version avail ty_decl `thenRn` \ (avail', maybe_decl) -> + recordSlurp (Just version) avail' `thenRn_` + returnRn maybe_decl + + Just (version,avail,decl) + -> recordSlurp (Just version) avail `thenRn_` + returnRn (Just decl) + + Nothing -> -- Can happen legitimately for "Optional" occurrences + case necessity of { + Optional -> addWarnRn (getDeclWarn needed_name); + other -> addErrRn (getDeclErr needed_name) + } `thenRn_` + returnRn Nothing where - (mod, str) = moduleNamePair orig - ----------- -cachedDeclByType :: IfaceCache - -> RnName{-NB: diff type than cachedDecl -} - -> IO (MaybeErr RdrIfaceDecl Error) - -cachedDeclByType iface_cache rn - -- the idea is: check that, e.g., if we're given an - -- RnClass, then we really get back a ClassDecl from - -- the cache (not an RnData, or something silly) - = cachedDecl iface_cache (isRnTyConOrClass rn) (origName rn) >>= \ maybe_decl -> + doc_str = sep [ptext SLIT("Need decl for"), ppr PprDebug needed_name] + (mod,_) = modAndOcc needed_name + + is_data_or_newtype (TyData _ _ _ _ _ _ _ _) = True + is_data_or_newtype other = False +\end{code} + +@getWiredInDecl@ maps a wired-in @Name@ to what it makes available. +It behaves exactly as if the wired in decl were actually in an interface file. +Specifically, + + * if the wired-in name is a data type constructor or a data constructor, + it brings in the type constructor and all the data constructors; and + marks as "occurrences" any free vars of the data con. + + * similarly for synonum type constructor + + * if the wired-in name is another wired-in Id, it marks as "occurrences" + the free vars of the Id's type. + + * it loads the interface file for the wired-in thing for the + sole purpose of making sure that its instance declarations are available + +All this is necessary so that we know all types that are "in play", so +that we know just what instances to bring into scope. + +\begin{code} +getWiredInDecl name + = get_wired `thenRn` \ avail -> + recordSlurp Nothing avail `thenRn_` + + -- Force in the home module in case it has instance decls for + -- the thing we are interested in. + -- + -- Mini hack 1: no point for non-tycons/class; and if we + -- do this we find PrelNum trying to import PackedString, + -- because PrelBase's .hi file mentions PackedString.unpackString + -- But PackedString.hi isn't built by that point! + -- + -- Mini hack 2; GHC is guaranteed not to have + -- instance decls, so it's a waste of time to read it + -- + -- NB: We *must* look at the availName of the slurped avail, + -- not the name passed to getWiredInDecl! Why? Because if a data constructor + -- or class op is passed to getWiredInDecl we'll pull in the whole data/class + -- decl, and recordSlurp will record that fact. But since the data constructor + -- isn't a tycon/class we won't force in the home module. And even if the + -- type constructor/class comes along later, loadDecl will say that it's already + -- been slurped, so getWiredInDecl won't even be called. Pretty obscure bug, this was. let - return_maybe_decl = return maybe_decl - return_failed msg = return (Failed msg) + main_name = availName avail + main_is_tc = case avail of { AvailTC _ _ -> True; Avail _ -> False } + (mod,_) = modAndOcc main_name + doc_str = sep [ptext SLIT("Need home module for wired in thing"), ppr PprDebug name] in - case maybe_decl of - Failed io_msg -> return_failed (ifaceIoErr io_msg rn) - Succeeded if_decl -> - case rn of - WiredInId _ -> return_failed (ifaceLookupWiredErr "value" rn) - WiredInTyCon _ -> return_failed (ifaceLookupWiredErr "type constructor" rn) - RnUnbound _ -> pprPanic "cachedDeclByType:" (ppr PprDebug rn) - - RnSyn _ -> return_maybe_decl - RnData _ _ _ -> return_maybe_decl - RnImplicitTyCon _ -> if is_tycon_decl if_decl - then return_maybe_decl - else return_failed (badIfaceLookupErr "type constructor" rn if_decl) - - RnClass _ _ -> return_maybe_decl - RnImplicitClass _ -> if is_class_decl if_decl - then return_maybe_decl - else return_failed (badIfaceLookupErr "class" rn if_decl) - - RnName _ -> return_maybe_decl - RnConstr _ _ -> return_maybe_decl - RnField _ _ -> return_maybe_decl - RnClassOp _ _ -> return_maybe_decl - RnImplicit _ -> if is_val_decl if_decl - then return_maybe_decl - else return_failed (badIfaceLookupErr "value" rn if_decl) + (if not main_is_tc || mod == gHC__ then + returnRn () + else + loadInterface doc_str mod `thenRn_` + returnRn () + ) `thenRn_` + + returnRn Nothing -- No declaration to process further where - is_tycon_decl (TypeSig _ _ _) = True - is_tycon_decl (NewTypeSig _ _ _ _) = True - is_tycon_decl (DataSig _ _ _ _ _) = True - is_tycon_decl _ = False - - is_class_decl (ClassSig _ _ _ _) = True - is_class_decl _ = False - - is_val_decl (ValSig _ _ _) = True - is_val_decl (DataSig _ _ _ _ _) = True -- may be a constr or field - is_val_decl (NewTypeSig _ _ _ _) = True -- may be a constr - is_val_decl (ClassSig _ _ _ _) = True -- may be a method - is_val_decl _ = False -\end{code} -\begin{code} -readIface :: FilePath -> Module - -> IO (MaybeErr ParsedIface Error) + get_wired | is_tycon -- ... a type constructor + = get_wired_tycon the_tycon -readIface file mod - = hPutStr stderr (" reading "++file) >> - readFile file `thenPrimIO` \ read_result -> - case read_result of - Left err -> return (Failed (cannaeReadErr file err)) - Right contents -> hPutStr stderr ".." >> - let parsed = parseIface contents in - hPutStr stderr "..\n" >> - return ( - case parsed of - Failed _ -> parsed - Succeeded p -> Succeeded (init_merge mod p) - ) + | (isDataCon the_id) -- ... a wired-in data constructor + = get_wired_tycon (dataConTyCon the_id) + + | otherwise -- ... a wired-in non data-constructor + = get_wired_id the_id + + maybe_wired_in_tycon = maybeWiredInTyConName name + is_tycon = maybeToBool maybe_wired_in_tycon + maybe_wired_in_id = maybeWiredInIdName name + Just the_tycon = maybe_wired_in_tycon + Just the_id = maybe_wired_in_id + + +get_wired_id id + = addImplicitOccsRn (nameSetToList id_mentioned) `thenRn_` + returnRn (Avail (getName id)) + where + id_mentioned = namesOfType (idType id) + +get_wired_tycon tycon + | isSynTyCon tycon + = addImplicitOccsRn (nameSetToList mentioned) `thenRn_` + returnRn (AvailTC tc_name [tc_name]) + where + tc_name = getName tycon + (tyvars,ty) = getSynTyConDefn tycon + mentioned = namesOfType ty `minusNameSet` mkNameSet (map getName tyvars) + +get_wired_tycon tycon + | otherwise -- data or newtype + = addImplicitOccsRn (nameSetToList mentioned) `thenRn_` + returnRn (AvailTC tycon_name (tycon_name : map getName data_cons)) where - init_merge this (ParsedIface mod _ v sv us vs exps insts fixes tdefs vdefs idefs prags) - = ParsedIface mod (False, unitBag this) v sv us vs exps insts fixes tdefs vdefs idefs prags + tycon_name = getName tycon + data_cons = tyConDataCons tycon + mentioned = foldr (unionNameSets . namesOfType . idType) emptyNameSet data_cons \end{code} + +%********************************************************* +%* * +\subsection{Getting what a module exports} +%* * +%********************************************************* + \begin{code} -rnIfaces :: IfaceCache -- iface cache (mutvar) - -> [Module] -- directly imported modules - -> UniqSupply - -> RnEnv -- defined (in the source) name env - -> RnEnv -- mentioned (in the source) name env - -> RenamedHsModule -- module to extend with iface decls - -> [RnName] -- imported names required (really the - -- same info as in mentioned name env) - -- Also, all the things we may look up - -- later by key (Unique). - -> IO (RenamedHsModule, -- extended module - RnEnv, -- final env (for renaming derivings) - ImplicitEnv, -- implicit names used (for usage info) - (UsagesMap,VersionsMap,[Module]), -- usage info - (Bag Error, Bag Warning)) - -rnIfaces iface_cache imp_mods us - def_env@((dqual, dunqual, dtc_qual, dtc_unqual), dstack) - occ_env@((qual, unqual, tc_qual, tc_unqual), stack) - rn_module@(HsModule modname iface_version exports imports fixities - typedecls typesigs classdecls instdecls instsigs - defdecls binds sigs src_loc) - todo - = {- - pprTrace "rnIfaces:going after:" (ppCat (map (ppr PprDebug) todo)) $ - pprTrace "rnIfaces:qual:" (ppCat [ppBesides[ppPStr m,ppChar '.',ppPStr n] | (n,m) <- keysFM qual]) $ - pprTrace "rnIfaces:unqual:" (ppCat (map ppPStr (keysFM unqual))) $ - pprTrace "rnIfaces:tc_qual:" (ppCat [ppBesides[ppPStr m,ppChar '.',ppPStr n] | (n,m) <- keysFM tc_qual]) $ - pprTrace "rnIfaces:tc_unqual:" (ppCat (map ppPStr (keysFM tc_unqual))) $ - - pprTrace "rnIfaces:dqual:" (ppCat [ppBesides[ppPStr m,ppChar '.',ppPStr n] | (n,m) <- keysFM dqual]) $ - pprTrace "rnIfaces:dunqual:" (ppCat (map ppPStr (keysFM dunqual))) $ - pprTrace "rnIfaces:dtc_qual:" (ppCat [ppBesides[ppPStr m,ppChar '.',ppPStr n] | (n,m) <- keysFM dtc_qual]) $ - pprTrace "rnIfaces:dtc_unqual:"(ppCat (map ppPStr (keysFM dtc_unqual))) $ - -} - - -- do transitive closure to bring in all needed names/defns and insts: - - decls_and_insts todo def_env occ_env empty_return us - >>= \ (((if_typedecls, if_classdecls, if_instdecls, if_sigs), - if_implicits, - if_errs_warns), - if_final_env) -> - - -- finalize what we want to say we learned about the - -- things we used - finalIfaceInfo iface_cache modname if_final_env if_instdecls {-all_imports_used imp_mods-} >>= - \ usage_stuff@(usage_info, version_info, instance_mods) -> - - return (HsModule modname iface_version exports imports fixities - (typedecls ++ if_typedecls) - typesigs - (classdecls ++ if_classdecls) - (instdecls ++ if_instdecls) - instsigs defdecls binds - (sigs ++ if_sigs) - src_loc, - if_final_env, - if_implicits, - usage_stuff, - if_errs_warns) +getInterfaceExports :: Module -> RnMG (Avails, [(OccName,Fixity)]) +getInterfaceExports mod + = loadInterface doc_str mod `thenRn` \ (Ifaces _ _ export_envs _ _ _ _ _ _) -> + case lookupFM export_envs mod of + Nothing -> -- Not there; it must be that the interface file wasn't found; + -- the error will have been reported already. + -- (Actually loadInterface should put the empty export env in there + -- anyway, but this does no harm.) + returnRn ([],[]) + + Just stuff -> returnRn stuff where - decls_and_insts todo def_env occ_env to_return us - = do_decls todo -- initial batch of names to process - (def_env, occ_env, us1) -- init stuff down - to_return -- acc results - >>= \ (decls_return, - decls_def_env, - decls_occ_env) -> - - cacheInstModules iface_cache imp_mods >>= \ errs -> - - do_insts decls_def_env decls_occ_env emptyRnEnv emptyFM - (add_errs errs decls_return) us2 - where - (us1,us2) = splitUniqSupply us - - do_insts def_env occ_env prev_env done_insts to_return us - | size_tc_env occ_env == size_tc_env prev_env - = return (to_return, occ_env) - - | otherwise - = rnIfaceInstStuff iface_cache modname us1 occ_env done_insts to_return - >>= \ (insts_return, - new_insts, - insts_occ_env, - new_unknowns) -> - - do_decls new_unknowns -- new batch of names to process - (def_env, insts_occ_env, us2) -- init stuff down - insts_return -- acc results - >>= \ (decls_return, - decls_def_env, - decls_occ_env) -> - - do_insts decls_def_env decls_occ_env occ_env new_insts decls_return us3 - where - (us1,us') = splitUniqSupply us - (us2,us3) = splitUniqSupply us' - - size_tc_env ((_, _, qual, unqual), _) - = sizeFM qual + sizeFM unqual - - - do_decls :: [RnName] -- Names we're looking for; we keep adding/deleting - -- from this list; we're done when empty (nothing - -- more needs to be looked for) - -> Go_Down -- see defn below - -> To_Return -- accumulated result - -> IO (To_Return, - RnEnv, -- extended decl env - RnEnv) -- extended occ env - - do_decls to_find@[] down to_return - = return (to_return, defenv down, occenv down) - - do_decls to_find@(n:ns) down to_return - = case (lookup_defd down n) of - Just _ -> -- previous processing must've found the stuff for this name; - -- continue with the rest: - -- pprTrace "do_decls:done:" (ppr PprDebug n) $ - do_decls ns down to_return - - Nothing - | fst (moduleNamePair n) == modname -> - -- avoid looking in interface for the module being compiled - --pprTrace "do_decls:this module error:" (ppr PprDebug n) $ - do_decls ns down (add_warn (thisModImplicitWarn modname n) to_return) - - | otherwise -> - -- OK, see what the cache has for us... - - cachedDeclByType iface_cache n >>= \ maybe_ans -> - case maybe_ans of - Failed err -> -- add the error, but keep going: - --pprTrace "do_decls:cache error:" (ppr PprDebug n) $ - do_decls ns down (add_err err to_return) - - Succeeded iface_decl -> -- something needing renaming! - let - (us1, us2) = splitUniqSupply (uniqsupply down) - in - case (initRn False{-iface-} modname (occenv down) us1 ( - setExtraRn emptyUFM{-no fixities-} $ - rnIfaceDecl iface_decl)) of { - ((if_decl, if_defd, if_implicits), if_errs, if_warns) -> - let - new_unknowns = eltsFM (fst if_implicits) ++ eltsFM (snd if_implicits) - in - {- - pprTrace "do_decls:renamed:" (ppAboves [ppr PprDebug n - , ppCat [ppStr "new unknowns:", interpp'SP PprDebug new_unknowns] - , ppCat [ppStr "defd vals:", interpp'SP PprDebug [n | (_,n) <- fst if_defd] ] - , ppCat [ppStr "defd tcs:", interpp'SP PprDebug [n | (_,n) <- snd if_defd] ] - ]) $ - -} - do_decls (new_unknowns ++ ns) - (add_occs if_defd if_implicits $ - new_uniqsupply us2 down) - (add_decl if_decl $ - add_implicits if_implicits $ - add_errs if_errs $ - add_warns if_warns to_return) - } - ------------ -type Go_Down = (RnEnv, -- stuff we already have defns for; - -- to check quickly if we've already - -- found something for the name under consideration, - -- due to previous processing. - -- It starts off just w/ the defns for - -- the things in this module. - RnEnv, -- occurrence env; this gets added to as - -- we process new iface decls. It includes - -- entries for *all* occurrences, including those - -- for which we have definitions. - UniqSupply -- the obvious - ) - -lookup_defd (def_env, _, _) n - | isRnTyConOrClass n - = lookupTcRnEnv def_env (origName n) - | otherwise - = lookupRnEnv def_env (origName n) - -defenv (def_env, _, _) = def_env -occenv (_, occ_env, _) = occ_env -uniqsupply (_, _, us) = us - -new_uniqsupply us (def_env, occ_env, _) = (def_env, occ_env, us) - -add_occs (val_defds, tc_defds) (val_imps, tc_imps) (def_env, occ_env, us) - = case (extendGlobalRnEnv def_env val_defds tc_defds) of { (new_def_env, def_dups) -> - (if isEmptyBag def_dups then \x->x else pprTrace "add_occs:" (ppCat [ppr PprDebug n | (n,_,_) <- bagToList def_dups])) $ --- ASSERT(isEmptyBag def_dups) - let - val_occs = val_defds ++ fmToList val_imps - tc_occs = tc_defds ++ fmToList tc_imps - in - case (extendGlobalRnEnv occ_env val_occs tc_occs) of { (new_occ_env, occ_dups) -> + doc_str = sep [pprModule PprDebug mod, ptext SLIT("is directly imported")] +\end{code} --- ASSERT(isEmptyBag occ_dups) --- False because we may get a dup on the name we just shoved in - (new_def_env, new_occ_env, us) }} +%********************************************************* +%* * +\subsection{Data type declarations are handled specially} +%* * +%********************************************************* ----------------- -type To_Return = (([RenamedTyDecl], [RenamedClassDecl], [RenamedInstDecl], [RenamedSig]), - ImplicitEnv, -- new names used implicitly - (Bag Error, Bag Warning) - ) - -empty_return :: To_Return -empty_return = (([],[],[],[]), emptyImplicitEnv, (emptyBag,emptyBag)) - -add_decl decl ((tydecls, classdecls, instdecls, sigs), implicit, msgs) - = case decl of - AddedTy t -> ((t:tydecls, classdecls, instdecls, sigs), implicit, msgs) - AddedClass c -> ((tydecls, c:classdecls, instdecls, sigs), implicit, msgs) - AddedSig s -> ((tydecls, classdecls, instdecls, s:sigs), implicit, msgs) - -add_insts is ((tydecls, classdecls, instdecls, sigs), implicit, msgs) - = ((tydecls, classdecls, is ++ instdecls, sigs), implicit, msgs) - -add_implicits (val_imps, tc_imps) (decls, (val_fm, tc_fm), msgs) - = (decls, (val_fm `plusFM` val_imps, tc_fm `plusFM` tc_imps), msgs) - -add_err err (decls,implicit,(errs,warns)) = (decls,implicit,(errs `snocBag` err,warns)) -add_errs ers (decls,implicit,(errs,warns)) = (decls,implicit,(errs `unionBags` ers,warns)) -add_warn wrn (decls,implicit,(errs,warns)) = (decls,implicit,(errs, warns `snocBag` wrn)) -add_warns ws (decls,implicit,(errs,warns)) = (decls,implicit,(errs, warns `unionBags` ws)) -\end{code} +Data type declarations get special treatment. If we import a data type decl +with all its constructors, we end up importing all the types mentioned in +the constructors' signatures, and hence {\em their} data type decls, and so on. +In effect, we get the transitive closure of data type decls. Worse, this drags +in tons on instance decls, and their unfoldings, and so on. + +If only the type constructor is mentioned, then all this is a waste of time. +If any of the data constructors are mentioned then we really have to +drag in the whole declaration. + +So when we import the type constructor for a @data@ or @newtype@ decl, we +put it in the "deferred data/newtype decl" pile in Ifaces. Right at the end +we slurp these decls, if they havn't already been dragged in by an occurrence +of a constructor. \begin{code} -data AddedDecl -- purely local - = AddedTy RenamedTyDecl - | AddedClass RenamedClassDecl - | AddedSig RenamedSig - -rnIfaceDecl :: RdrIfaceDecl - -> RnM_Fixes _RealWorld - (AddedDecl, -- the resulting decl to add to the pot - ([(RdrName,RnName)], [(RdrName,RnName)]), - -- new val/tycon-class names that have - -- *been defined* while processing this decl - ImplicitEnv -- new implicit val/tycon-class names that we - -- stumbled into - ) - -rnIfaceDecl (TypeSig tc _ decl) - = rnTyDecl decl `thenRn` \ rn_decl -> - lookupTyCon tc `thenRn` \ rn_tc -> - getImplicitUpRn `thenRn` \ mentioned -> +getNonWiredDataDecl needed_name + version + avail@(AvailTC tycon_name _) + ty_decl@(TyData new_or_data context tycon tyvars condecls derivings pragmas src_loc) + | needed_name == tycon_name + && opt_TyConPruning + && not (nameUnique needed_name `elem` cCallishTyKeys) -- Hack! Don't prune these tycons whose constructors + -- the desugarer must be able to see when desugaring + -- a CCall. Ugh! + = -- Need the type constructor; so put it in the deferred set for now + getIfacesRn `thenRn` \ ifaces -> let - defds = ([], [(tc, rn_tc)]) - implicits = mentioned `sub` defds + Ifaces this_mod mod_vers_map export_envs decls_fm slurped_names imp_names unslurped_insts deferred_data_decls inst_mods = ifaces + new_ifaces = Ifaces this_mod mod_vers_map export_envs decls_fm slurped_names imp_names unslurped_insts new_deferred_data_decls inst_mods + + no_constr_ty_decl = TyData new_or_data [] tycon tyvars [] derivings pragmas src_loc + new_deferred_data_decls = addToFM deferred_data_decls tycon_name no_constr_ty_decl + -- Nota bene: we nuke both the constructors and the context in the deferred decl. + -- If we don't nuke the context then renaming the deferred data decls can give + -- new unresolved names (for the classes). This could be handled, but there's + -- no point. If the data type is completely abstract then we aren't interested + -- its context. in - returnRn (AddedTy rn_decl, defds, implicits) + setIfacesRn new_ifaces `thenRn_` + returnRn (AvailTC tycon_name [tycon_name], Nothing) -rnIfaceDecl (NewTypeSig tc dc _ decl) - = rnTyDecl decl `thenRn` \ rn_decl -> - lookupTyCon tc `thenRn` \ rn_tc -> - lookupValue dc `thenRn` \ rn_dc -> - getImplicitUpRn `thenRn` \ mentioned -> - let - defds = ([(dc, rn_dc)], [(tc, rn_tc)]) - implicits = mentioned `sub` defds - in - returnRn (AddedTy rn_decl, defds, implicits) - -rnIfaceDecl (DataSig tc dcs fcs _ decl) - = rnTyDecl decl `thenRn` \ rn_decl -> - lookupTyCon tc `thenRn` \ rn_tc -> - mapRn lookupValue dcs `thenRn` \ rn_dcs -> - mapRn lookupValue fcs `thenRn` \ rn_fcs -> - getImplicitUpRn `thenRn` \ mentioned -> + | otherwise + = -- Need a data constructor, so delete the data decl from the deferred set if it's there + getIfacesRn `thenRn` \ ifaces -> let - defds = (zip dcs rn_dcs ++ zip fcs rn_fcs , [(tc, rn_tc)]) - implicits = mentioned `sub` defds - in - returnRn (AddedTy rn_decl, defds, implicits) + Ifaces this_mod mod_vers_map export_envs decls_fm slurped_names imp_names unslurped_insts deferred_data_decls inst_mods = ifaces + new_ifaces = Ifaces this_mod mod_vers_map export_envs decls_fm slurped_names imp_names unslurped_insts new_deferred_data_decls inst_mods -rnIfaceDecl (ClassSig clas ops _ decl) - = rnClassDecl decl `thenRn` \ rn_decl -> - lookupClass clas `thenRn` \ rn_clas -> - mapRn (lookupClassOp rn_clas) ops `thenRn` \ rn_ops -> - getImplicitUpRn `thenRn` \ mentioned -> - let - defds = (ops `zip` rn_ops, [(clas, rn_clas)]) - implicits = mentioned `sub` defds + new_deferred_data_decls = delFromFM deferred_data_decls tycon_name in - returnRn (AddedClass rn_decl, defds, implicits) - -rnIfaceDecl (ValSig f src_loc ty) - -- should rename_sig in RnBinds be used here? ToDo - = lookupValue f `thenRn` \ rn_f -> - -- pprTrace "rnIfaceDecl:ValSig:" (ppr PprDebug ty) $ - rnPolyType nullTyVarNamesEnv ty `thenRn` \ rn_ty -> - getImplicitUpRn `thenRn` \ mentioned -> + setIfacesRn new_ifaces `thenRn_` + returnRn (avail, Just (TyD ty_decl)) +\end{code} + +\begin{code} +getDeferredDataDecls :: RnMG [(Name, RdrNameTyDecl)] +getDeferredDataDecls + = getIfacesRn `thenRn` \ (Ifaces _ _ _ _ _ _ _ deferred_data_decls _) -> let - defds = ([(f, rn_f)], []) - implicits = mentioned `sub` defds + deferred_list = fmToList deferred_data_decls + trace_msg = hang (text "Slurping abstract data/newtype decls for: ") + 4 (ppr PprDebug (map fst deferred_list)) in - returnRn (AddedSig (Sig rn_f rn_ty noGenPragmas src_loc), defds, implicits) - ----- -sub :: ImplicitEnv -> ([(RdrName,RnName)], [(RdrName,RnName)]) -> ImplicitEnv - -sub (val_ment, tc_ment) (val_defds, tc_defds) - = (delListFromFM val_ment (map fst val_defds), - delListFromFM tc_ment (map fst tc_defds)) + traceRn trace_msg `thenRn_` + returnRn deferred_list \end{code} -% ------------------------------ -@cacheInstModules@: cache instance modules specified in imports +%********************************************************* +%* * +\subsection{Instance declarations are handled specially} +%* * +%********************************************************* \begin{code} -cacheInstModules :: IfaceCache -> [Module] -> IO (Bag Error) -cacheInstModules iface_cache imp_mods - = readVar iface_cache `thenPrimIO` \ (iface_fm, _, _) -> +getImportedInstDecls :: RnMG [(Module,RdrNameInstDecl)] +getImportedInstDecls + = -- First load any special-instance modules that aren't aready loaded + getSpecialInstModules `thenRn` \ inst_mods -> + mapRn load_it inst_mods `thenRn_` + + -- Now we're ready to grab the instance declarations + -- Find the un-gated ones and return them, + -- removing them from the bag kept in Ifaces + getIfacesRn `thenRn` \ ifaces -> let - imp_ifaces = [ iface | Just iface <- map (lookupFM iface_fm) imp_mods ] - (imp_imods, _) = removeDups cmpPString (bagToList (unionManyBags (map get_ims imp_ifaces))) - get_ims (ParsedIface _ _ _ _ _ _ _ ims _ _ _ _ _) = ims + Ifaces this_mod mod_vers export_envs decls slurped_names imp_names insts deferred_data_decls inst_mods = ifaces + + -- An instance decl is ungated if all its gates have been slurped + select_ungated :: IfaceInst -- A gated inst decl + + -> ([(Module, RdrNameInstDecl)], [IfaceInst]) -- Accumulator + + -> ([(Module, RdrNameInstDecl)], -- The ungated ones + [IfaceInst]) -- Still gated, but with + -- depeleted gates + select_ungated (decl,gates) (ungated_decls, gated_decls) + | null remaining_gates + = (decl : ungated_decls, gated_decls) + | otherwise + = (ungated_decls, (decl, remaining_gates) : gated_decls) + where + remaining_gates = filter (not . (`elemNameSet` slurped_names)) gates + + (un_gated_insts, still_gated_insts) = foldrBag select_ungated ([], []) insts + + new_ifaces = Ifaces this_mod mod_vers export_envs decls slurped_names imp_names + (listToBag still_gated_insts) + deferred_data_decls + inst_mods in - --pprTrace "cacheInstModules:" (ppCat (map ppPStr imp_imods)) $ - accumulate (map (cachedIface False iface_cache) imp_imods) >>= \ err_or_ifaces -> + setIfacesRn new_ifaces `thenRn_` + returnRn un_gated_insts + where + load_it mod = loadInterface (doc_str mod) mod + doc_str mod = sep [pprModule PprDebug mod, ptext SLIT("is a special-instance module")] - -- Sanity Check: - -- Assert that instance modules given by direct imports contains - -- instance modules extracted from all visited modules - readVar iface_cache `thenPrimIO` \ (all_iface_fm, _, _) -> +getSpecialInstModules :: RnMG [Module] +getSpecialInstModules + = getIfacesRn `thenRn` \ ifaces -> let - all_ifaces = eltsFM all_iface_fm - (all_imods, _) = removeDups cmpPString (bagToList (unionManyBags (map get_ims (all_ifaces)))) + Ifaces _ _ _ _ _ _ _ _ inst_mods = ifaces in - ASSERT(sortLt (<) imp_imods == sortLt (<) all_imods) - - return (bag_errs err_or_ifaces) - where - bag_errs [] = emptyBag - bag_errs (Failed err :rest) = err `consBag` bag_errs rest - bag_errs (Succeeded _:rest) = bag_errs rest + returnRn inst_mods \end{code} -@rnIfaceInstStuff@: Deal with instance declarations from interface files. +%********************************************************* +%* * +\subsection{Keeping track of what we've slurped, and version numbers} +%* * +%********************************************************* + +getImportVersions figures out what the "usage information" for this moudule is; +that is, what it must record in its interface file as the things it uses. +It records: + - anything reachable from its body code + - any module exported with a "module Foo". + +Why the latter? Because if Foo changes then this module's export list +will change, so we must recompile this module at least as far as +making a new interface file --- but in practice that means complete +recompilation. + +What about this? + module A( f, g ) where module B( f ) where + import B( f ) f = h 3 + g = ... h = ... + +Should we record B.f in A's usages? In fact we don't. Certainly, if +anything about B.f changes than anyone who imports A should be recompiled; +they'll get an early exit if they don't use B.f. However, even if B.f +doesn't change at all, B.h may do so, and this change may not be reflected +in f's version number. So there are two things going on when compiling module A: + +1. Are A.o and A.hi correct? Then we can bale out early. +2. Should modules that import A be recompiled? + +For (1) it is slightly harmful to record B.f in A's usages, because a change in +B.f's version will provoke full recompilation of A, producing an identical A.o, +and A.hi differing only in its usage-version of B.f (which isn't used by any importer). + +For (2), because of the tricky B.h question above, we ensure that A.hi is touched +(even if identical to its previous version) if A's recompilation was triggered by +an imported .hi file date change. Given that, there's no need to record B.f in +A's usages. + +On the other hand, if A exports "module B" then we *do* count module B among +A's usages, because we must recompile A to ensure that A.hi changes appropriately. \begin{code} -type InstanceEnv = FiniteMap (RdrName, RdrName) Int - -rnIfaceInstStuff - :: IfaceCache -- all about ifaces we've read - -> Module - -> UniqSupply - -> RnEnv -- current occ env - -> InstanceEnv -- instances for these tycon/class pairs done - -> To_Return - -> IO (To_Return, - InstanceEnv, -- extended instance env - RnEnv, -- final occ env - [RnName]) -- new unknown names - -rnIfaceInstStuff iface_cache modname us occ_env done_inst_env to_return - = -- all the instance decls we might even want to consider - -- are in the ParsedIfaces that are in our cache - - readVar iface_cache `thenPrimIO` \ (_, orig_iface_fm, _) -> +getImportVersions :: Module -- Name of this module + -> Maybe [IE any] -- Export list for this module + -> RnMG (VersionInfo Name) -- Version info for these names + +getImportVersions this_mod exports + = getIfacesRn `thenRn` \ ifaces -> let - all_ifaces = eltsFM orig_iface_fm - all_insts = unionManyBags (map get_insts all_ifaces) - interesting_insts = filter want_inst (bagToList all_insts) + Ifaces _ mod_versions_map _ _ _ imp_names _ _ _ = ifaces + mod_version mod = expectJust "import_versions" (lookupFM mod_versions_map mod) - -- Sanity Check: - -- Assert that there are no more instances for the done instances + -- mv_map groups together all the things imported from a particular module. + mv_map, mv_map_mod :: FiniteMap Module [LocalVersion Name] - claim_done = filter is_done_inst (bagToList all_insts) - claim_done_env = foldr add_done_inst emptyFM claim_done - has_val fm (k,i) = case lookupFM fm k of { Nothing -> False; Just v -> i == v } + mv_map_mod = foldl add_mod emptyFM export_mods + -- mv_map_mod records all the modules that have a "module M" + -- in this module's export list + + mv_map = foldl add_mv mv_map_mod imp_names + -- mv_map adds the version numbers of things exported individually in - {- - pprTrace "all_insts:\n" (ppr_insts (bagToList all_insts)) $ - pprTrace "interesting_insts:\n" (ppr_insts interesting_insts) $ - -} - ASSERT(sizeFM done_inst_env == sizeFM claim_done_env) - ASSERT(all (has_val claim_done_env) (fmToList done_inst_env)) - - case (initRn False{-iface-} modname occ_env us ( - setExtraRn emptyUFM{-no fixities-} $ - mapRn rnIfaceInst interesting_insts `thenRn` \ insts -> - getImplicitUpRn `thenRn` \ implicits -> - returnRn (insts, implicits))) of { - ((if_insts, if_implicits), if_errs, if_warns) -> - - return (add_insts if_insts $ - add_implicits if_implicits $ - add_errs if_errs $ - add_warns if_warns to_return, - foldr add_done_inst done_inst_env interesting_insts, - add_imp_occs if_implicits occ_env, - eltsFM (fst if_implicits) ++ eltsFM (snd if_implicits)) - } + returnRn [ (mod, mod_version mod, local_versions) + | (mod, local_versions) <- fmToList mv_map + ] + where - get_insts (ParsedIface _ _ _ _ _ _ _ _ _ _ _ insts _) = insts - - add_done_inst (InstSig clas tycon _ _) inst_env - = addToFM_C (+) inst_env (tycon,clas) 1 - - is_done_inst (InstSig clas tycon _ _) - = maybeToBool (lookupFM done_inst_env (tycon,clas)) - - add_imp_occs (val_imps, tc_imps) occ_env - = case extendGlobalRnEnv occ_env (fmToList val_imps) (fmToList tc_imps) of - (ext_occ_env, occ_dups) -> ASSERT(isEmptyBag occ_dups) - ext_occ_env - - want_inst i@(InstSig clas tycon _ _) - = -- it's a "good instance" (one to hang onto) if we have a - -- chance of referring to *both* the class and tycon later on ... - --pprTrace "want_inst:" (ppCat [ppr PprDebug clas, ppr PprDebug tycon, ppr PprDebug (mentionable tycon), ppr PprDebug (mentionable clas), ppr PprDebug(is_done_inst i)]) $ - mentionable tycon && mentionable clas && not (is_done_inst i) - where - mentionable nm - = case lookupTcRnEnv occ_env nm of - Just _ -> True - Nothing -> -- maybe it's builtin - let str_mod = case nm of { Qual m n -> (n,m); Unqual n -> (n, pRELUDE) } - in case (lookupFM b_tc_names str_mod) of - Just _ -> True - Nothing -> maybeToBool (lookupFM b_keys str_mod) - - (b_tc_names, b_keys) -- pretty UGLY ... - = case builtinNameInfo of ((_,builtin_tcs),b_keys,_) -> (builtin_tcs,b_keys) - - ppr_insts insts - = ppAboves (map ppr_inst insts) - where - ppr_inst (InstSig c t _ inst_decl) - = ppCat [ppr PprDebug c, ppr PprDebug t, ppr PprDebug inst_decl] + export_mods = case exports of + Nothing -> [] + Just es -> [mod | IEModuleContents mod <- es, mod /= this_mod] + + add_mv mv_map v@(name, version) + = addToFM_C (\ ls _ -> (v:ls)) mv_map mod [v] + where + (mod,_) = modAndOcc name + + add_mod mv_map mod = addToFM mv_map mod [] \end{code} \begin{code} -rnIfaceInst :: RdrIfaceInst -> RnM_Fixes _RealWorld RenamedInstDecl +checkSlurped name + = getIfacesRn `thenRn` \ (Ifaces _ _ _ _ slurped_names _ _ _ _) -> + returnRn (name `elemNameSet` slurped_names) -rnIfaceInst (InstSig _ _ _ inst_decl) = rnInstDecl inst_decl +getSlurpedNames :: RnMG NameSet +getSlurpedNames + = getIfacesRn `thenRn` \ ifaces -> + let + Ifaces _ _ _ _ slurped_names _ _ _ _ = ifaces + in + returnRn slurped_names + +recordSlurp maybe_version avail + = -- traceRn (sep [text "Record slurp:", pprAvail PprDebug avail]) `thenRn_` + getIfacesRn `thenRn` \ ifaces -> + let + Ifaces this_mod mod_vers export_envs decls slurped_names imp_names insts deferred_data_decls inst_mods = ifaces + new_slurped_names = addAvailToNameSet slurped_names avail + + new_imp_names = case maybe_version of + Just version -> (availName avail, version) : imp_names + Nothing -> imp_names + + new_ifaces = Ifaces this_mod mod_vers export_envs decls + new_slurped_names + new_imp_names + insts + deferred_data_decls + inst_mods + in + setIfacesRn new_ifaces \end{code} + +%********************************************************* +%* * +\subsection{Getting binders out of a declaration} +%* * +%********************************************************* + +@getDeclBinders@ returns the names for a @RdrNameHsDecl@. +It's used for both source code (from @availsFromDecl@) and interface files +(from @loadDecl@). + +It doesn't deal with source-code specific things: ValD, DefD. They +are handled by the sourc-code specific stuff in RnNames. + \begin{code} -type BigMaps = (FiniteMap Module Version, -- module-version map - FiniteMap (FAST_STRING,Module) Version) -- ordinary version map - -finalIfaceInfo :: - IfaceCache -- iface cache - -> Module -- this module's name - -> RnEnv - -> [RenamedInstDecl] --- -> [RnName] -- all imported names required --- -> [Module] -- directly imported modules - -> IO (UsagesMap, - VersionsMap, -- info about version numbers - [Module]) -- special instance modules - -finalIfaceInfo iface_cache modname if_final_env@((qual, unqual, tc_qual, tc_unqual), stack) if_instdecls - = --- pprTrace "usageIf:qual:" (ppCat [ppBesides[ppPStr m,ppChar '.',ppPStr n] | (n,m) <- keysFM qual]) $ --- pprTrace "usageIf:unqual:" (ppCat (map ppPStr (keysFM unqual))) $ --- pprTrace "usageIf:tc_qual:" (ppCat [ppBesides[ppPStr m,ppChar '.',ppPStr n] | (n,m) <- keysFM tc_qual]) $ --- pprTrace "usageIf:tc_unqual:" (ppCat (map ppPStr (keysFM tc_unqual))) $ - readVar iface_cache `thenPrimIO` \ (_, orig_iface_fm, _) -> - let - all_ifaces = eltsFM orig_iface_fm - -- all the interfaces we have looked at +getDeclBinders :: (RdrName -> SrcLoc -> RnMG Name) -- New-name function + -> RdrNameHsDecl + -> RnMG AvailInfo - big_maps - -- combine all the version maps we have seen into maps to - -- (a) lookup a module-version number, lookup an entity's - -- individual version number - = foldr mk_map (emptyFM,emptyFM) all_ifaces +getDeclBinders new_name (TyD (TyData _ _ tycon _ condecls _ _ src_loc)) + = new_name tycon src_loc `thenRn` \ tycon_name -> + getConFieldNames new_name condecls `thenRn` \ sub_names -> + returnRn (AvailTC tycon_name (tycon_name : sub_names)) - val_stuff@(val_usages, val_versions) - = foldFM (process_item big_maps) (emptyFM, emptyFM){-init-} qual +getDeclBinders new_name (TyD (TySynonym tycon _ _ src_loc)) + = new_name tycon src_loc `thenRn` \ tycon_name -> + returnRn (AvailTC tycon_name [tycon_name]) - (all_usages, all_versions) - = foldFM (process_item big_maps) val_stuff{-keep going-} tc_qual - in - return (all_usages, all_versions, []) +getDeclBinders new_name (ClD (ClassDecl _ cname _ sigs _ _ src_loc)) + = new_name cname src_loc `thenRn` \ class_name -> + mapRn (getClassOpNames new_name) sigs `thenRn` \ sub_names -> + returnRn (AvailTC class_name (class_name : sub_names)) + +getDeclBinders new_name (SigD (IfaceSig var ty prags src_loc)) + = new_name var src_loc `thenRn` \ var_name -> + returnRn (Avail var_name) + +getDeclBinders new_name (DefD _) = returnRn NotAvailable +getDeclBinders new_name (InstD _) = returnRn NotAvailable + +---------------- +getConFieldNames new_name (ConDecl con _ (RecCon fielddecls) src_loc : rest) + = mapRn (\n -> new_name n src_loc) (con:fields) `thenRn` \ cfs -> + getConFieldNames new_name rest `thenRn` \ ns -> + returnRn (cfs ++ ns) where - mk_map (ParsedIface m _ mv _ _ vers _ _ _ _ _ _ _) (mv_map, ver_map) - = (addToFM mv_map m mv, -- add this module - addListToFM ver_map [ ((n,m), v) | (n,v) <- fmToList vers ]) - - ----------------------- - process_item :: BigMaps - -> (FAST_STRING,Module) -> RnName -- RnEnv (QualNames) components - -> (UsagesMap, VersionsMap) -- input - -> (UsagesMap, VersionsMap) -- output - - process_item (big_mv_map, big_version_map) key@(n,m) rn as_before@(usages, versions) - | irrelevant rn - = as_before - | m == modname -- this module => add to "versions" - = (usages, addToFM versions n 1{-stub-}) - | otherwise -- from another module => add to "usages" - = (add_to_usages usages key, versions) - where - add_to_usages usages key@(n,m) - = let - mod_v = case (lookupFM big_mv_map m) of - Nothing -> pprTrace "big_mv_map:miss? " (ppPStr m) $ - 1 - Just nv -> nv - key_v = case (lookupFM big_version_map key) of - Nothing -> pprTrace "big_version_map:miss? " (ppCat [ppPStr n, ppPStr m]) $ - 1 - Just nv -> nv - in - addToFM usages m ( - case (lookupFM usages m) of - Nothing -> -- nothing for this module yet... - (mod_v, unitFM n key_v) - - Just (mversion, mstuff) -> -- the "new" stuff will shadow the old - ASSERT(mversion == mod_v) - (mversion, addToFM mstuff n key_v) - ) - - irrelevant (RnConstr _ _) = True -- We don't report these in their - irrelevant (RnField _ _) = True -- own right in usages/etc. - irrelevant (RnClassOp _ _) = True - irrelevant (RnImplicit n) = isRdrLexCon (origName n) -- really a RnConstr - irrelevant _ = False + fields = concat (map fst fielddecls) + +getConFieldNames new_name (ConDecl con _ _ src_loc : rest) + = new_name con src_loc `thenRn` \ n -> + getConFieldNames new_name rest `thenRn` \ ns -> + returnRn (n:ns) +getConFieldNames new_name [] = returnRn [] + +getClassOpNames new_name (ClassOpSig op _ _ src_loc) = new_name op src_loc \end{code} +%********************************************************* +%* * +\subsection{Reading an interface file} +%* * +%********************************************************* + \begin{code} -thisModImplicitWarn mod n sty - = ppBesides [ppPStr SLIT("An interface has an implicit need of "), ppPStr mod, ppChar '.', ppr sty n, ppPStr SLIT("; assuming this module will provide it.")] +findAndReadIface :: Doc -> Module -> RnMG (Maybe ParsedIface) + -- Nothing <=> file not found, or unreadable, or illegible + -- Just x <=> successfully found and parsed +findAndReadIface doc_str filename + = traceRn trace_msg `thenRn_` + getSearchPathRn `thenRn` \ dirs -> + try dirs dirs + where + trace_msg = hang (hcat [ptext SLIT("Reading interface for "), + ptext filename, semi]) + 4 (hcat [ptext SLIT("reason: "), doc_str]) + + try all_dirs [] = traceRn (ptext SLIT("...failed")) `thenRn_` + returnRn Nothing + + try all_dirs ((dir,hisuf):dirs) + = readIface file_path `thenRn` \ read_result -> + case read_result of + Nothing -> try all_dirs dirs + Just iface -> traceRn (ptext SLIT("...done")) `thenRn_` + returnRn (Just iface) + where + file_path = dir ++ "/" ++ moduleString filename ++ hisuf +\end{code} -noIfaceErr mod sty - = ppCat [ppPStr SLIT("Could not find interface for:"), ppPStr mod] +@readIface@ trys just one file. -noOrigIfaceErr mod sty - = ppCat [ppPStr SLIT("Could not find original interface for:"), ppPStr mod] +\begin{code} +readIface :: String -> RnMG (Maybe ParsedIface) + -- Nothing <=> file not found, or unreadable, or illegible + -- Just x <=> successfully found and parsed +readIface file_path + = ioToRnMG (hGetStringBuffer file_path) `thenRn` \ read_result -> +--OLD: = ioToRnMG (readFile file_path) `thenRn` \ read_result -> + case read_result of + Right contents -> case parseIface contents of + Failed err -> --ioToRnMG (freeStringBuffer contents) `thenRn` \ _ -> + failWithRn Nothing err + Succeeded iface -> --ioToRnMG (freeStringBuffer contents) `thenRn` \ _ -> + returnRn (Just iface) + +#if __GLASGOW_HASKELL__ >= 202 + Left err -> + if isDoesNotExistError err then + returnRn Nothing + else + failWithRn Nothing (cannaeReadFile file_path err) +#else /* 2.01 and 0.2x */ + Left (NoSuchThing _) -> returnRn Nothing + + Left err -> failWithRn Nothing + (cannaeReadFile file_path err) +#endif + +\end{code} -noDeclInIfaceErr mod str sty - = ppBesides [ppPStr SLIT("Could not find interface declaration of: "), - ppPStr mod, ppStr ".", ppPStr str] +mkSearchPath takes a string consisting of a colon-separated list of directories and corresponding +suffixes, and turns it into a list of (directory, suffix) pairs. For example: -cannaeReadErr file err sty - = ppBesides [ppPStr SLIT("Failed in reading file: "), ppStr file, ppStr "; error=", ppStr (show err)] +\begin{verbatim} + mkSearchPath "foo%.hi:.%.p_hi:baz%.mc_hi" = [("foo",".hi"),( ".", ".p_hi"), ("baz",".mc_hi")] +\begin{verbatim} + +\begin{code} +mkSearchPath :: Maybe String -> SearchPath +mkSearchPath Nothing = [(".",".hi")] +mkSearchPath (Just s) + = go s + where + go "" = [] + go s = + case span (/= '%') s of + (dir,'%':rs) -> + case span (/= ':') rs of + (hisuf,_:rest) -> (dir,hisuf):go rest + (hisuf,[]) -> [(dir,hisuf)] +\end{code} + +%********************************************************* +%* * +\subsection{Errors} +%* * +%********************************************************* + +\begin{code} +noIfaceErr filename sty + = hcat [ptext SLIT("Could not find valid interface file "), quotes (pprModule sty filename)] +-- , text " in"]) 4 (vcat (map text dirs)) -ifaceLookupWiredErr msg n sty - = ppBesides [ppPStr SLIT("Why am I looking up a wired-in "), ppStr msg, ppChar ':', ppr sty n] +cannaeReadFile file err sty + = hcat [ptext SLIT("Failed in reading file: "), text file, ptext SLIT("; error="), text (show err)] -badIfaceLookupErr msg name decl sty - = ppBesides [ppPStr SLIT("Expected a "), ppStr msg, ppPStr SLIT(" declaration, but got this: ???")] +getDeclErr name sty + = sep [ptext SLIT("Failed to find interface decl for"), ppr sty name] -ifaceIoErr io_msg rn sty - = ppBesides [io_msg sty, ppStr "; looking for: ", ppr sty rn] +getDeclWarn name sty + = sep [ptext SLIT("Warning: failed to find (optional) interface decl for"), ppr sty name] \end{code}