X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Frename%2FRnIfaces.lhs;h=149bf149d5248713e01e4f9ab8f4bd9db2cedb03;hb=39262efa1c066d97547ac72d8bd16a145ac3f359;hp=04252d9150e8acac12584d7f0e4807b4df24bf17;hpb=f8d1d20eb4779a42e72b6a06c47d6e0f13075bf4;p=ghc-hetmet.git diff --git a/ghc/compiler/rename/RnIfaces.lhs b/ghc/compiler/rename/RnIfaces.lhs index 04252d9..149bf14 100644 --- a/ghc/compiler/rename/RnIfaces.lhs +++ b/ghc/compiler/rename/RnIfaces.lhs @@ -1,252 +1,303 @@ % -% (c) The GRASP/AQUA Project, Glasgow University, 1992-1996 +% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998 % \section[RnIfaces]{Cacheing and Renaming of Interfaces} \begin{code} -#include "HsVersions.h" - module RnIfaces ( - getInterfaceExports, - getImportedInstDecls, - getSpecialInstModules, getDeferredDataDecls, + getInterfaceExports, + getImportedInstDecls, getImportedRules, + lookupFixity, loadHomeInterface, importDecl, recordSlurp, - getImportVersions, getSlurpedNames, getRnStats, + getImportVersions, getSlurped, checkUpToDate, - getDeclBinders, - mkSearchPath + getDeclBinders, getDeclSysBinders, + removeContext -- removeContext probably belongs somewhere else ) where -IMP_Ubiq() -#if __GLASGOW_HASKELL__ >= 202 -import IO -#endif - +#include "HsVersions.h" -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 CmdLineOpts ( opt_NoPruneDecls, opt_IgnoreIfacePragmas ) +import HsSyn ( HsDecl(..), TyClDecl(..), InstDecl(..), IfaceSig(..), + HsType(..), ConDecl(..), IE(..), ConDetails(..), Sig(..), + ForeignDecl(..), ForKind(..), isDynamic, + FixitySig(..), RuleDecl(..), + isClassOpSig ) -import HsPragmas ( noGenPragmas ) -import RdrHsSyn ( SYN_IE(RdrNameHsDecl), SYN_IE(RdrNameInstDecl), SYN_IE(RdrNameTyDecl), - RdrName, rdrNameOcc +import BasicTypes ( Version, NewOrData(..), defaultFixity ) +import RdrHsSyn ( RdrNameHsDecl, RdrNameInstDecl, RdrNameTyClDecl, RdrNameRuleDecl, + extractHsTyRdrNames ) -import RnEnv ( newGlobalName, lookupRn, addImplicitOccsRn, - availName, availNames, addAvailToNameSet, pprAvail +import RnEnv ( mkImportedGlobalName, newImportedBinder, mkImportedGlobalFromRdrName, + lookupOccRn, lookupImplicitOccRn, + pprAvail, + availName, availNames, addAvailToNameSet, + FreeVars, emptyFVs ) -import RnSource ( rnHsSigType ) import RnMonad -import RnHsSyn ( SYN_IE(RenamedHsDecl) ) -import ParseIface ( parseIface ) +import RnHsSyn ( RenamedHsDecl ) +import ParseIface ( parseIface, IfaceStuff(..) ) -import ErrUtils ( SYN_IE(Error), SYN_IE(Warning) ) -import FiniteMap ( FiniteMap, sizeFM, emptyFM, unitFM, delFromFM, +import FiniteMap ( FiniteMap, sizeFM, emptyFM, delFromFM, listToFM, lookupFM, addToFM, addToFM_C, addListToFM, - fmToList, eltsFM + fmToList, elemFM, foldFM ) -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 Name ( Name {-instance NamedThing-}, + nameModule, isLocallyDefined, + isWiredInName, nameUnique, 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 Module ( Module, moduleString, pprModule, + mkVanillaModule, pprModuleName, + moduleUserString, moduleName, isLibModule, + ModuleName, WhereFrom(..), + ) +import RdrName ( RdrName, rdrNameOcc ) +import NameSet +import Var ( Id ) +import SrcLoc ( mkSrcLoc, SrcLoc ) +import PrelMods ( pREL_GHC ) +import PrelInfo ( cCallishTyKeys, thinAirModules ) import Bag -import Maybes ( MaybeErr(..), expectJust, maybeToBool ) +import Maybes ( MaybeErr(..), maybeToBool, orElse ) import ListSetOps ( unionLists ) -import Pretty -import PprStyle ( PprStyle(..) ) +import Outputable import Unique ( Unique ) -import Util ( pprPanic, pprTrace, Ord3(..) ) -import StringBuffer ( StringBuffer, hGetStringBuffer, freeStringBuffer ) +import StringBuffer ( StringBuffer, hGetStringBuffer ) +import FastString ( mkFastString ) +import ErrUtils ( Message ) +import Lex import Outputable -\end{code} +import IO ( isDoesNotExistError ) +import List ( nub ) +\end{code} %********************************************************* %* * -\subsection{Statistics} +\subsection{Loading a new interface file} %* * %********************************************************* \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) +loadHomeInterface :: SDoc -> Name -> RnM d Ifaces +loadHomeInterface doc_str name + = loadInterface doc_str (moduleName (nameModule name)) ImportBySystem `thenRn` \ (_, ifaces) -> + returnRn ifaces + +loadOrphanModules :: [ModuleName] -> RnM d () +loadOrphanModules mods + | null mods = returnRn () + | otherwise = traceRn (text "Loading orphan modules:" <+> fsep (map pprModuleName mods)) `thenRn_` + mapRn_ load mods `thenRn_` + returnRn () 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} -%* * -%********************************************************* + load mod = loadInterface (pprModuleName mod <+> ptext SLIT("is a orphan-instance module")) mod ImportBySystem + +loadInterface :: SDoc -> ModuleName -> WhereFrom -> RnM d (Module, Ifaces) +loadInterface doc_str mod_name from + = getIfacesRn `thenRn` \ ifaces -> + let + mod_map = iImpModInfo ifaces + mod_info = lookupFM mod_map mod_name + in_map = maybeToBool mod_info + in + + -- Issue a warning for a redundant {- SOURCE -} import + -- It's redundant if the moduld is in the iImpModInfo at all, + -- because we arrange to read all the ordinary imports before + -- any of the {- SOURCE -} imports + warnCheckRn (not (in_map && case from of {ImportByUserSource -> True; other -> False})) + (warnRedundantSourceImport mod_name) `thenRn_` -\begin{code} -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 + case mod_info of { + Just (_, _, Just (load_mod, _, _)) + -> -- We're read it already so don't re-read it + returnRn (load_mod, ifaces) ; + + mod_map_result -> -- READ THE MODULE IN - findAndReadIface doc_str load_mod `thenRn` \ read_result -> - case read_result of { - -- Check for not found + findAndReadIface doc_str mod_name from in_map + `thenRn` \ (hi_boot_read, read_result) -> + case read_result of { 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) ; + let + mod = mkVanillaModule mod_name + new_mod_map = addToFM mod_map mod_name (0, False, Just (mod, False, [])) + new_ifaces = ifaces { iImpModInfo = new_mod_map } + in + setIfacesRn new_ifaces `thenRn_` + failWithRn (mod, new_ifaces) (noIfaceErr mod hi_boot_read) ; -- Found and parsed! - Just (ParsedIface _ mod_vers usages exports rd_inst_mods fixs rd_decls rd_insts) -> + Just (mod, iface) -> -- 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 -> + + -- NB: *first* we do loadDecl, so that the provenance of all the locally-defined + --- names is done correctly (notably, whether this is an .hi file or .hi-boot file). + -- If we do loadExport first the wrong info gets into the cache (unless we + -- explicitly tag each export which seems a bit of a bore) + + getModuleRn `thenRn` \ this_mod_nm -> 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 + rd_decls = pi_decls iface + in + foldlRn (loadDecl mod) (iDecls ifaces) rd_decls `thenRn` \ new_decls -> + foldlRn (loadInstDecl mod) (iInsts ifaces) (pi_insts iface) `thenRn` \ new_insts -> + (if (opt_IgnoreIfacePragmas) + then returnRn emptyBag + else foldlRn (loadRule mod) (iRules ifaces) (pi_rules iface)) `thenRn` \ new_rules -> + foldlRn (loadFixDecl mod_name) (iFixes ifaces) rd_decls `thenRn` \ new_fixities -> + mapRn (loadExport this_mod_nm) (pi_exports iface) `thenRn` \ avails_s -> + let + -- For an explicit user import, add to mod_map info about + -- the things the imported module depends on, extracted + -- from its usage info. + mod_map1 = case from of + ImportByUser -> addModDeps mod mod_map (pi_usages iface) + other -> mod_map + + -- Now add info about this module + mod_map2 = addToFM mod_map1 mod_name mod_details + mod_details = (pi_mod iface, pi_orphan iface, Just (mod, hi_boot_read, concat avails_s)) + + new_ifaces = ifaces { iImpModInfo = mod_map2, + iDecls = new_decls, + iFixes = new_fixities, + iRules = new_rules, + iInsts = new_insts } in setIfacesRn new_ifaces `thenRn_` - returnRn new_ifaces - } + returnRn (mod, new_ifaces) + }} -loadExport :: ExportItem -> RnMG [AvailInfo] -loadExport (mod, entities) - = mapRn load_entity entities +addModDeps :: Module -> ImportedModuleInfo + -> [ImportVersion a] -> ImportedModuleInfo +addModDeps mod mod_deps new_deps + = foldr add mod_deps new_deps where - new_name occ = newGlobalName mod occ + is_lib = isLibModule mod -- Don't record dependencies when importing a library module + add (imp_mod, version, has_orphans, _) deps + | is_lib && not has_orphans = deps + | otherwise = addToFM_C combine deps imp_mod (version, has_orphans, Nothing) + -- Record dependencies for modules that are + -- either are dependent via a non-library module + -- or contain orphan rules or instance decls + + -- Don't ditch a module that's already loaded!! + combine old@(_, _, Just _) new = old + combine old@(_, _, Nothing) new = new + +loadExport :: ModuleName -> ExportItem -> RnM d [AvailInfo] +loadExport this_mod (mod, entities) + | mod == this_mod = returnRn [] + -- If the module exports anything defined in this module, just ignore it. + -- Reason: otherwise it looks as if there are two local definition sites + -- for the thing, and an error gets reported. Easiest thing is just to + -- filter them out up front. This situation only arises if a module + -- imports itself, or another module that imported it. (Necessarily, + -- this invoves a loop.) Consequence: if you say + -- module A where + -- import B( AType ) + -- type AType = ... + -- + -- module B( AType ) where + -- import {-# SOURCE #-} A( AType ) + -- + -- then you'll get a 'B does not export AType' message. A bit bogus + -- but it's a bogus thing to do! --- 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, []) + | otherwise + = mapRn (load_entity mod) entities + where + new_name mod occ = mkImportedGlobalName mod occ + + load_entity mod (Avail occ) + = new_name mod occ `thenRn` \ name -> + returnRn (Avail name) + load_entity mod (AvailTC occ occs) + = new_name mod occ `thenRn` \ name -> + mapRn (new_name mod) occs `thenRn` \ names -> + returnRn (AvailTC name names) + + +loadFixDecl :: ModuleName -> FixityEnv + -> (Version, RdrNameHsDecl) + -> RnM d FixityEnv +loadFixDecl mod_name fixity_env (version, FixD sig@(FixitySig rdr_name fixity loc)) + = -- Ignore the version; when the fixity changes the version of + -- its 'host' entity changes, so we don't need a separate version + -- number for fixities + mkImportedGlobalName mod_name (rdrNameOcc rdr_name) `thenRn` \ name -> + let + new_fixity_env = addToNameEnv fixity_env name (FixitySig name fixity loc) + in + returnRn new_fixity_env - 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) + -- Ignore the other sorts of decl +loadFixDecl mod_name fixity_env other_decl = returnRn fixity_env -loadDecl :: Module -> DeclsMap +loadDecl :: Module + -> DeclsMap -> (Version, RdrNameHsDecl) - -> RnMG DeclsMap + -> RnM d 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] - ) + = getDeclBinders new_name decl `thenRn` \ maybe_avail -> + case maybe_avail of { + Nothing -> returnRn decls_map; -- No bindings + Just avail -> + + getDeclSysBinders new_name decl `thenRn` \ sys_bndrs -> + let + main_name = availName avail + new_decls_map = foldl add_decl decls_map + [ (name, (version, avail, name==main_name, (mod, decl'))) + | name <- sys_bndrs ++ availNames avail] + add_decl decls_map (name, stuff) + = WARN( name `elemNameEnv` decls_map, ppr name ) + addToNameEnv decls_map name stuff + in + returnRn new_decls_map + } where - new_implicit_name rdr_name loc = newGlobalName mod (rdrNameOcc rdr_name) + -- newImportedBinder puts into the cache the binder with the + -- module information set correctly. When the decl is later renamed, + -- the binding site will thereby get the correct module. + new_name rdr_name loc = newImportedBinder mod rdr_name + + {- + If a signature decl is being loaded, and optIgnoreIfacePragmas is on, + we toss away unfolding information. + + Also, if the signature is loaded from a module we're importing from source, + we do the same. This is to avoid situations when compiling a pair of mutually + recursive modules, peering at unfolding info in the interface file of the other, + e.g., you compile A, it looks at B's interface file and may as a result change + its interface file. Hence, B is recompiled, maybe changing its interface file, + which will the unfolding info used in A to become invalid. Simple way out is to + just ignore unfolding info. + + [Jan 99: I junked the second test above. If we're importing from an hi-boot + file there isn't going to *be* any pragma info. Maybe the above comment + dates from a time where we picked up a .hi file first if it existed?] + -} + decl' = case decl of + SigD (IfaceSig name tp ls loc) | opt_IgnoreIfacePragmas + -> SigD (IfaceSig name tp [] loc) + other -> decl loadInstDecl :: Module - -> Bag IfaceInst + -> Bag GatedDecl -> RdrNameInstDecl - -> RnMG (Bag IfaceInst) -loadInstDecl mod_name insts decl@(InstDecl inst_ty binds uprags dfun_name src_loc) + -> RnM d (Bag GatedDecl) +loadInstDecl mod 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 @@ -258,17 +309,33 @@ loadInstDecl mod_name insts decl@(InstDecl inst_ty binds uprags dfun_name src_lo -- -- 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 + munged_inst_ty = removeContext inst_ty + free_names = extractHsTyRdrNames munged_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) + setModuleRn (moduleName mod) $ + mapRn mkImportedGlobalFromRdrName free_names `thenRn` \ gate_names -> + returnRn ((mkNameSet gate_names, (mod, InstD decl)) `consBag` insts) + + +-- In interface files, the instance decls now look like +-- forall a. Foo a -> Baz (T a) +-- so we have to strip off function argument types as well +-- as the bit before the '=>' (which is always empty in interface files) +removeContext (HsForAllTy tvs cxt ty) = HsForAllTy tvs [] (removeFuns ty) +removeContext ty = removeFuns ty + +removeFuns (MonoFunTy _ ty) = removeFuns ty +removeFuns ty = ty + + +loadRule :: Module -> Bag GatedDecl + -> RdrNameRuleDecl -> RnM d (Bag GatedDecl) +-- "Gate" the rule simply by whether the rule variable is +-- needed. We can refine this later. +loadRule mod rules decl@(IfaceRuleDecl var body src_loc) + = setModuleRn (moduleName mod) $ + mkImportedGlobalFromRdrName var `thenRn` \ var_name -> + returnRn ((unitNameSet var_name, (mod, RuleD decl)) `consBag` rules) \end{code} @@ -279,74 +346,94 @@ loadInstDecl mod_name insts decl@(InstDecl inst_ty binds uprags dfun_name src_lo %******************************************************** \begin{code} -checkUpToDate :: Module -> RnMG Bool -- True <=> no need to recompile +checkUpToDate :: ModuleName -> RnMG Bool -- True <=> no need to recompile checkUpToDate mod_name - = findAndReadIface doc_str mod_name `thenRn` \ read_result -> + = getIfacesRn `thenRn` \ ifaces -> + findAndReadIface doc_str mod_name + ImportByUser + (error "checkUpToDate") `thenRn` \ (_, read_result) -> + + -- CHECK WHETHER WE HAVE IT ALREADY 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_` + pprModuleName mod_name]) `thenRn_` returnRn False - Just (ParsedIface _ _ usages _ _ _ _ _) + Just (_, iface) -> -- Found it, so now check it - checkModUsage usages + checkModUsage (pi_usages iface) where -- Only look in current directory, with suffix .hi - doc_str = sep [ptext SLIT("Need usage info from"), pprModule PprDebug mod_name] + doc_str = sep [ptext SLIT("need usage info from"), pprModuleName 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 -> +checkModUsage ((mod_name, old_mod_vers, _, whats_imported) : rest) + = loadInterface doc_str mod_name ImportBySystem `thenRn` \ (mod, ifaces) -> let - Ifaces _ mod_vers _ decls _ _ _ _ _ = ifaces - maybe_new_mod_vers = lookupFM mod_vers mod - Just new_mod_vers = maybe_new_mod_vers + maybe_mod_vers = case lookupFM (iImpModInfo ifaces) mod_name of + Just (version, _, Just (_, _, _)) -> Just version + other -> Nothing 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 + case maybe_mod_vers of { + Nothing -> -- If we can't find a version number for the old module then + -- bail out saying things aren't up to date + traceRn (sep [ptext SLIT("Can't find version number for module"), + pprModuleName mod_name]) + `thenRn_` returnRn False ; + + Just new_mod_vers -> -- 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 + traceRn (sep [ptext SLIT("Module version unchanged:"), pprModuleName mod_name]) + `thenRn_` checkModUsage rest else - traceRn (sep [ptext SLIT("Module version has changed:"), pprModule PprDebug mod]) `thenRn_` + traceRn (sep [ptext SLIT("Module version has changed:"), pprModuleName mod_name]) + `thenRn_` + -- Module version changed, so check entities inside - -- New module version, so check entities inside - checkEntityUsage mod decls old_local_vers `thenRn` \ up_to_date -> + -- If the usage info wants to say "I imported everything from this module" + -- it does so by making whats_imported equal to Everything + -- In that case, we must recompile + case whats_imported of { + Everything -> traceRn (ptext SLIT("...and I needed the whole module")) `thenRn_` + returnRn False; -- Bale out + + Specifically old_local_vers -> + + -- Non-empty usage list, so check item by item + checkEntityUsage mod_name (iDecls ifaces) 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] + doc_str = sep [ptext SLIT("need version info for"), pprModuleName mod_name] checkEntityUsage mod decls [] = returnRn True -- Yes! All up to date! checkEntityUsage mod decls ((occ_name,old_vers) : rest) - = newGlobalName mod occ_name `thenRn` \ name -> - case lookupFM decls name of + = mkImportedGlobalName mod occ_name `thenRn` \ name -> + case lookupNameEnv decls name of 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 + traceRn (sep [ptext SLIT("No longer exported:"), ppr name]) + `thenRn_` returnRn False - Just (new_vers,_,_) -- It's there, but is it up to date? + 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 | otherwise -- Out of date, so bale out - -> traceRn (sep [ptext SLIT("...and this is out of date:"), ppr PprDebug name]) `thenRn_` + -> traceRn (sep [ptext SLIT("Out of date:"), ppr name]) `thenRn_` returnRn False \end{code} @@ -358,160 +445,65 @@ checkEntityUsage mod decls ((occ_name,old_vers) : rest) %********************************************************* \begin{code} -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_` +importDecl :: Name -> RnMG (Maybe (Module, RdrNameHsDecl)) + -- Returns Nothing for + -- (a) wired in name + -- (b) local decl + -- (c) already slurped + +importDecl name + | isWiredInName name + = returnRn Nothing + | otherwise + = getSlurped `thenRn` \ already_slurped -> + if name `elemNameSet` already_slurped then 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 + if isLocallyDefined name then -- Don't bring in decls from + -- the renamed module's own interface file + addWarnRn (importDeclWarn name) `thenRn_` + returnRn Nothing + else + getNonWiredInDecl name \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 +getNonWiredInDecl :: Name -> RnMG (Maybe (Module, RdrNameHsDecl)) +getNonWiredInDecl needed_name + = traceRn doc_str `thenRn_` + loadHomeInterface doc_str needed_name `thenRn` \ ifaces -> + case lookupNameEnv (iDecls ifaces) needed_name of + + Just (version,avail,_,decl) + -> recordSlurp (Just version) avail `thenRn_` + returnRn (Just decl) + + Nothing -- Can happen legitimately for "Optional" occurrences + -> addErrRn (getDeclErr needed_name) `thenRn_` + returnRn Nothing where - 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 + doc_str = ptext SLIT("need decl for") <+> ppr needed_name \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, +\begin{itemize} +\item 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. + marks as ``occurrences'' any free vars of the data con. - * similarly for synonum type constructor +\item similarly for synonum type constructor - * if the wired-in name is another wired-in Id, it marks as "occurrences" +\item 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 +\item 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 +\end{itemize} +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 - 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 - (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 - - get_wired | is_tycon -- ... a type constructor - = get_wired_tycon the_tycon - - | (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 - tycon_name = getName tycon - data_cons = tyConDataCons tycon - mentioned = foldr (unionNameSets . namesOfType . idType) emptyNameSet data_cons -\end{code} @@ -521,155 +513,114 @@ get_wired_tycon tycon %* * %********************************************************* +@getInterfaceExports@ is called only for directly-imported modules. + \begin{code} -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 +getInterfaceExports :: ModuleName -> WhereFrom -> RnMG (Module, Avails) +getInterfaceExports mod_name from + = loadInterface doc_str mod_name from `thenRn` \ (mod, ifaces) -> + case lookupFM (iImpModInfo ifaces) mod_name 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 (mod, []) + + Just (_, _, Just (mod, _, avails)) -> returnRn (mod, avails) where - doc_str = sep [pprModule PprDebug mod, ptext SLIT("is directly imported")] + doc_str = sep [pprModuleName mod_name, ptext SLIT("is directly imported")] \end{code} %********************************************************* %* * -\subsection{Data type declarations are handled specially} +\subsection{Instance declarations are handled specially} %* * %********************************************************* -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} -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 - 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 - setIfacesRn new_ifaces `thenRn_` - returnRn (AvailTC tycon_name [tycon_name], Nothing) - - | otherwise - = -- Need a data constructor, so delete the data decl from the deferred set if it's there - getIfacesRn `thenRn` \ ifaces -> - let - 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 - - new_deferred_data_decls = delFromFM deferred_data_decls tycon_name - in - 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 _) -> +getImportedInstDecls :: NameSet -> RnMG [(Module,RdrNameHsDecl)] +getImportedInstDecls gates + = -- First, load any orphan-instance modules that aren't aready loaded + -- Orphan-instance modules are recorded in the module dependecnies + getIfacesRn `thenRn` \ ifaces -> let - deferred_list = fmToList deferred_data_decls - trace_msg = hang (text "Slurping abstract data/newtype decls for: ") - 4 (ppr PprDebug (map fst deferred_list)) + orphan_mods = + [mod | (mod, (_, True, Nothing)) <- fmToList (iImpModInfo ifaces)] in - traceRn trace_msg `thenRn_` - returnRn deferred_list -\end{code} - - -%********************************************************* -%* * -\subsection{Instance declarations are handled specially} -%* * -%********************************************************* - -\begin{code} -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_` + loadOrphanModules orphan_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 -> + getIfacesRn `thenRn` \ ifaces -> let - 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 + (decls, new_insts) = selectGated gates (iInsts ifaces) in - 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")] - + setIfacesRn (ifaces { iInsts = new_insts }) `thenRn_` -getSpecialInstModules :: RnMG [Module] -getSpecialInstModules - = getIfacesRn `thenRn` \ ifaces -> + traceRn (sep [text "getImportedInstDecls:", + nest 4 (fsep (map ppr gate_list)), + text "Slurped" <+> int (length decls) <+> text "instance declarations", + nest 4 (vcat (map ppr_brief_inst_decl decls))]) `thenRn_` + returnRn decls + where + gate_list = nameSetToList gates + + load_home gate | isLocallyDefined gate + = returnRn () + | otherwise + = loadHomeInterface (ppr gate <+> text "is an instance gate") gate `thenRn_` + returnRn () + +ppr_brief_inst_decl (mod, InstD (InstDecl inst_ty _ _ _ _)) + = case inst_ty of + HsForAllTy _ _ tau -> ppr tau + other -> ppr inst_ty + +getImportedRules :: RnMG [(Module,RdrNameHsDecl)] +getImportedRules + | opt_IgnoreIfacePragmas = returnRn [] + | otherwise + = getIfacesRn `thenRn` \ ifaces -> let - Ifaces _ _ _ _ _ _ _ _ inst_mods = ifaces + gates = iSlurp ifaces -- Anything at all that's been slurped + (decls, new_rules) = selectGated gates (iRules ifaces) in - returnRn inst_mods + setIfacesRn (ifaces { iRules = new_rules }) `thenRn_` + traceRn (sep [text "getImportedRules:", + text "Slurped" <+> int (length decls) <+> text "rules"]) `thenRn_` + returnRn decls + +selectGated gates decl_bag + -- Select only those decls whose gates are *all* in 'gates' +#ifdef DEBUG + | opt_NoPruneDecls -- Just to try the effect of not gating at all + = (foldrBag (\ (_,d) ds -> d:ds) [] decl_bag, emptyBag) -- Grab them all + + | otherwise +#endif + = foldrBag select ([], emptyBag) decl_bag + where + select (reqd, decl) (yes, no) + | isEmptyNameSet (reqd `minusNameSet` gates) = (decl:yes, no) + | otherwise = (yes, (reqd,decl) `consBag` no) + +lookupFixity :: Name -> RnMS Fixity +lookupFixity name + | isLocallyDefined name + = getFixityEnv `thenRn` \ local_fix_env -> + case lookupNameEnv local_fix_env name of + Just (FixitySig _ fix _) -> returnRn fix + Nothing -> returnRn defaultFixity + + | otherwise -- Imported + = loadHomeInterface doc name `thenRn` \ ifaces -> + case lookupNameEnv (iFixes ifaces) name of + Just (FixitySig _ fix _) -> returnRn fix + Nothing -> returnRn defaultFixity + where + doc = ptext SLIT("Checking fixity for") <+> ppr name \end{code} @@ -679,113 +630,160 @@ getSpecialInstModules %* * %********************************************************* -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". +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: -Why the latter? Because if Foo changes then this module's export list +\begin{itemize} +\item anything reachable from its body code +\item any module exported with a @module Foo@. +\end{itemize} +% +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{verbatim} + module A( f, g ) where | module B( f ) where + import B( f ) | f = h 3 + g = ... | h = ... +\end{verbatim} + +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@: + +\begin{enumerate} +\item Are @A.o@ and @A.hi@ correct? Then we can bale out early. +\item Should modules that import @A@ be recompiled? +\end{enumerate} + +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@ (and this usage-version info 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 {\em do} count +@module B@ among @A@'s usages, because we must recompile @A@ to ensure +that @A.hi@ changes appropriately. + +HOWEVER, we *do* record the usage + import B :: ; +in A.hi, to record the fact that A does import B. This is used to decide +to look to look for B.hi rather than B.hi-boot when compiling a module that +imports A. This line says that A imports B, but uses nothing in it. +So we'll get an early bale-out when compiling A if B's version changes. \begin{code} -getImportVersions :: Module -- Name of this module - -> Maybe [IE any] -- Export list for this module +getImportVersions :: ModuleName -- Name of this module + -> ExportEnv -- Info about exports -> RnMG (VersionInfo Name) -- Version info for these names -getImportVersions this_mod exports +getImportVersions this_mod (ExportEnv export_avails _ export_all_mods) = getIfacesRn `thenRn` \ ifaces -> let - Ifaces _ mod_versions_map _ _ _ imp_names _ _ _ = ifaces - mod_version mod = expectJust "import_versions" (lookupFM mod_versions_map mod) + mod_map = iImpModInfo ifaces + imp_names = iVSlurp ifaces - -- mv_map groups together all the things imported from a particular module. - mv_map, mv_map_mod :: FiniteMap Module [LocalVersion Name] + export_mods :: FiniteMap ModuleName () -- Set of home modules for + -- things in the export list + export_mods = listToFM [(moduleName (nameModule (availName a)), ()) | a <- export_avails] + + -- mv_map groups together all the things imported from a particular module. + mv_map :: FiniteMap ModuleName [(Name,Version)] + mv_map = foldr add_mv emptyFM imp_names - 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 + -- Build the result list by adding info for each module. + -- For (a) a library module, we don't record it at all unless it contains orphans + -- (We must never lose track of orphans.) + -- + -- (b) a source-imported module, don't record the dependency at all + -- + -- (b) may seem a bit strange. The idea is that the usages in a .hi file records + -- *all* the module's dependencies other than the loop-breakers. We use + -- this info in findAndReadInterface to decide whether to look for a .hi file or + -- a .hi-boot file. + -- + -- This means we won't track version changes, or orphans, from .hi-boot files. + -- The former is potentially rather bad news. It could be fixed by recording + -- whether something is a boot file along with the usage info for it, but + -- I can't be bothered just now. + + mk_version_info mod_name (version, has_orphans, Nothing) so_far + = ASSERT( not has_orphans ) -- If has_orphans is true we will have opened it + so_far -- We didn't even read this module's interface + -- so don't record dependency on it. + + mk_version_info mod_name (version, has_orphans, Just (mod, boot_import, _)) so_far + | boot_import -- Don't record any usage info for this module + || (is_lib_module && not has_orphans) + = so_far + + | is_lib_module -- Record the module but not + || mod_name `elem` export_all_mods -- detailed version information for the imports + = go_for_it Everything + + | otherwise + = case lookupFM mv_map mod_name of + Just whats_imported + -> go_for_it (Specifically whats_imported) + + Nothing -- This happens if you have + -- import Foo + -- but don't actually *use* anything from Foo + | has_orphans -- Check for (a) orphans (we must never forget them) + || mod_name `elemFM` export_mods -- or (b) something from the module is exported + -> -- ...in which case record an empty dependency list + go_for_it (Specifically []) + + | otherwise -> so_far -- No point in recording any dependency + where + is_lib_module = isLibModule mod + go_for_it exports = (mod_name, version, has_orphans, exports) : so_far - mv_map = foldl add_mv mv_map_mod imp_names - -- mv_map adds the version numbers of things exported individually in - returnRn [ (mod, mod_version mod, local_versions) - | (mod, local_versions) <- fmToList mv_map - ] + -- A module shouldn't load its own interface + -- This seems like a convenient place to check + WARN( maybeToBool (lookupFM mod_map this_mod), + ptext SLIT("Wierd:") <+> ppr this_mod <+> ptext SLIT("loads its own interface") ) + returnRn (foldFM mk_version_info [] mod_map) where - 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 [] + add_mv v@(name, version) mv_map + = addToFM_C add_item mv_map mod [v] + where + mod = moduleName (nameModule name) + add_item vs _ = (v:vs) \end{code} \begin{code} -checkSlurped name - = getIfacesRn `thenRn` \ (Ifaces _ _ _ _ slurped_names _ _ _ _) -> - returnRn (name `elemNameSet` slurped_names) - -getSlurpedNames :: RnMG NameSet -getSlurpedNames +getSlurped = getIfacesRn `thenRn` \ ifaces -> - let - Ifaces _ _ _ _ slurped_names _ _ _ _ = ifaces - in - returnRn slurped_names + returnRn (iSlurp ifaces) recordSlurp maybe_version avail - = -- traceRn (sep [text "Record slurp:", pprAvail PprDebug avail]) `thenRn_` - getIfacesRn `thenRn` \ ifaces -> + = getIfacesRn `thenRn` \ ifaces@(Ifaces { iSlurp = slurped_names, + iVSlurp = imp_names }) -> 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 + 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 + setIfacesRn (ifaces { iSlurp = new_slurped_names, + iVSlurp = new_imp_names }) \end{code} @@ -799,53 +797,103 @@ recordSlurp maybe_version avail 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. +It doesn't deal with source-code specific things: @ValD@, @DefD@. They +are handled by the sourc-code specific stuff in @RnNames@. \begin{code} -getDeclBinders :: (RdrName -> SrcLoc -> RnMG Name) -- New-name function +getDeclBinders :: (RdrName -> SrcLoc -> RnM d Name) -- New-name function -> RdrNameHsDecl - -> RnMG AvailInfo + -> RnM d (Maybe AvailInfo) -getDeclBinders new_name (TyD (TyData _ _ tycon _ condecls _ _ src_loc)) +getDeclBinders new_name (TyClD (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)) + returnRn (Just (AvailTC tycon_name (tycon_name : nub sub_names))) + -- The "nub" is because getConFieldNames can legitimately return duplicates, + -- when a record declaration has the same field in multiple constructors -getDeclBinders new_name (TyD (TySynonym tycon _ _ src_loc)) +getDeclBinders new_name (TyClD (TySynonym tycon _ _ src_loc)) = new_name tycon src_loc `thenRn` \ tycon_name -> - returnRn (AvailTC tycon_name [tycon_name]) + returnRn (Just (AvailTC tycon_name [tycon_name])) -getDeclBinders new_name (ClD (ClassDecl _ cname _ sigs _ _ src_loc)) +getDeclBinders new_name (TyClD (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)) + + -- Record the names for the class ops + let + -- just want class-op sigs + op_sigs = filter isClassOpSig sigs + in + mapRn (getClassOpNames new_name) op_sigs `thenRn` \ sub_names -> + + returnRn (Just (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) + returnRn (Just (Avail var_name)) + +getDeclBinders new_name (FixD _) = returnRn Nothing -getDeclBinders new_name (DefD _) = returnRn NotAvailable -getDeclBinders new_name (InstD _) = returnRn NotAvailable + -- foreign declarations +getDeclBinders new_name (ForD (ForeignDecl nm kind _ dyn _ loc)) + | binds_haskell_name kind dyn + = new_name nm loc `thenRn` \ name -> + returnRn (Just (Avail name)) + + | otherwise -- a foreign export + = lookupImplicitOccRn nm `thenRn_` + returnRn Nothing + +getDeclBinders new_name (DefD _) = returnRn Nothing +getDeclBinders new_name (InstD _) = returnRn Nothing +getDeclBinders new_name (RuleD _) = returnRn Nothing + +binds_haskell_name (FoImport _) _ = True +binds_haskell_name FoLabel _ = True +binds_haskell_name FoExport ext_nm = isDynamic ext_nm ---------------- -getConFieldNames new_name (ConDecl con _ (RecCon fielddecls) src_loc : rest) +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 fields = concat (map fst fielddecls) -getConFieldNames new_name (ConDecl con _ _ src_loc : rest) +getConFieldNames new_name (ConDecl con _ _ condecl src_loc : rest) = new_name con src_loc `thenRn` \ n -> + (case condecl of + NewCon _ (Just f) -> + new_name f src_loc `thenRn` \ new_f -> + returnRn [n,new_f] + _ -> returnRn [n]) `thenRn` \ nn -> getConFieldNames new_name rest `thenRn` \ ns -> - returnRn (n:ns) + returnRn (nn ++ ns) getConFieldNames new_name [] = returnRn [] -getClassOpNames new_name (ClassOpSig op _ _ src_loc) = new_name op src_loc +getClassOpNames new_name (ClassOpSig op _ _ _ src_loc) = new_name op src_loc \end{code} +@getDeclSysBinders@ gets the implicit binders introduced by a decl. +A the moment that's just the tycon and datacon that come with a class decl. +They aren't returned by @getDeclBinders@ because they aren't in scope; +but they {\em should} be put into the @DeclsMap@ of this module. + +Note that this excludes the default-method names of a class decl, +and the dict fun of an instance decl, because both of these have +bindings of their own elsewhere. + +\begin{code} +getDeclSysBinders new_name (TyClD (ClassDecl _ cname _ _ sigs _ _ tname dname snames src_loc)) + = new_name dname src_loc `thenRn` \ datacon_name -> + new_name tname src_loc `thenRn` \ tycon_name -> + sequenceRn [new_name n src_loc | n <- snames] `thenRn` \ scsel_names -> + returnRn (tycon_name : datacon_name : scsel_names) + +getDeclSysBinders new_name other_decl + = returnRn [] +\end{code} %********************************************************* %* * @@ -854,101 +902,127 @@ getClassOpNames new_name (ClassOpSig op _ _ src_loc) = new_name op src_loc %********************************************************* \begin{code} -findAndReadIface :: Doc -> Module -> RnMG (Maybe ParsedIface) +findAndReadIface :: SDoc -> ModuleName -> WhereFrom + -> Bool -- Only relevant for SystemImport + -- True <=> Look for a .hi file + -- False <=> Look for .hi-boot file unless there's + -- a library .hi file + -> RnM d (Bool, Maybe (Module, ParsedIface)) + -- Bool is True if the interface actually read was a .hi-boot one -- Nothing <=> file not found, or unreadable, or illegible -- Just x <=> successfully found and parsed -findAndReadIface doc_str filename + +findAndReadIface doc_str mod_name from hi_file = traceRn trace_msg `thenRn_` - getSearchPathRn `thenRn` \ dirs -> - try dirs dirs + -- we keep two maps for interface files, + -- one for 'normal' ones, the other for .hi-boot files, + -- hence the need to signal which kind we're interested. + + getHiMaps `thenRn` \ hi_maps -> + + case find_path from hi_maps of + -- Found the file + (hi_boot, Just (fpath, mod)) -> traceRn (ptext SLIT("...reading from") <+> text fpath) + `thenRn_` + readIface mod fpath `thenRn` \ result -> + returnRn (hi_boot, result) + (hi_boot, Nothing) -> traceRn (ptext SLIT("...not found")) `thenRn_` + returnRn (hi_boot, Nothing) 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 + find_path ImportByUser (hi_map, _) = (False, lookupFM hi_map mod_name) + find_path ImportByUserSource (_, hiboot_map) = (True, lookupFM hiboot_map mod_name) + + find_path ImportBySystem (hi_map, hiboot_map) + | hi_file + = -- If the module we seek is in our dependent set, + -- Look for a .hi file + (False, lookupFM hi_map mod_name) + + | otherwise + -- Check if there's a library module of that name + -- If not, look for an hi-boot file + = case lookupFM hi_map mod_name of + stuff@(Just (_, mod)) | isLibModule mod -> (False, stuff) + other -> (True, lookupFM hiboot_map mod_name) + + trace_msg = sep [hsep [ptext SLIT("Reading"), + ppr from, + ptext SLIT("interface for"), + pprModuleName mod_name <> semi], + nest 4 (ptext SLIT("reason:") <+> doc_str)] \end{code} -@readIface@ trys just one file. +@readIface@ tries just the one file. \begin{code} -readIface :: String -> RnMG (Maybe ParsedIface) +readIface :: Module -> String -> RnM d (Maybe (Module, 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 -> +readIface the_mod file_path + = ioToRnM (hGetStringBuffer False 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} - -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: - -\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)] + Right contents -> + case parseIface contents + PState{ bol = 0#, atbol = 1#, + context = [], + glasgow_exts = 1#, + loc = mkSrcLoc (mkFastString file_path) 1 } of + PFailed err -> failWithRn Nothing err + POk _ (PIface mod_nm iface) -> + warnCheckRn (mod_nm == moduleName the_mod) + (hiModuleNameMismatchWarn the_mod mod_nm) `thenRn_` + returnRn (Just (the_mod, iface)) + + Left err + | isDoesNotExistError err -> returnRn Nothing + | otherwise -> failWithRn Nothing (cannaeReadFile file_path err) \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)) - -cannaeReadFile file err sty - = hcat [ptext SLIT("Failed in reading file: "), text file, ptext SLIT("; error="), text (show err)] - -getDeclErr name sty - = sep [ptext SLIT("Failed to find interface decl for"), ppr sty name] +noIfaceErr filename boot_file + = hsep [ptext SLIT("Could not find valid"), boot, + ptext SLIT("interface file"), quotes (pprModule filename)] + where + boot | boot_file = ptext SLIT("[boot]") + | otherwise = empty + +cannaeReadFile file err + = hcat [ptext SLIT("Failed in reading file: "), + text file, + ptext SLIT("; error="), + text (show err)] + +getDeclErr name + = ptext SLIT("Failed to find interface decl for") <+> quotes (ppr name) + +getDeclWarn name loc + = sep [ptext SLIT("Failed to find (optional) interface decl for") <+> quotes (ppr name), + ptext SLIT("desired at") <+> ppr loc] + +importDeclWarn name + = sep [ptext SLIT( + "Compiler tried to import decl from interface file with same name as module."), + ptext SLIT( + "(possible cause: module name clashes with interface file already in scope.)") + ] $$ + hsep [ptext SLIT("name:"), quotes (ppr name)] + +warnRedundantSourceImport mod_name + = ptext SLIT("Unnecessary {- SOURCE -} in the import of module") + <+> quotes (pprModuleName mod_name) + +hiModuleNameMismatchWarn :: Module -> ModuleName -> Message +hiModuleNameMismatchWarn requested_mod mod_nm = + hsep [ ptext SLIT("Something is amiss; requested module name") + , pprModule requested_mod + , ptext SLIT("differs from name found in the interface file ") + , pprModuleName mod_nm + ] -getDeclWarn name sty - = sep [ptext SLIT("Warning: failed to find (optional) interface decl for"), ppr sty name] \end{code}