X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Frename%2FRnIfaces.lhs;h=deff6b7ea554155a30bc33d024e9ad9b4f989bb5;hb=904f158f9fe208b8154029dff655a6eab4b2828e;hp=f805e312e9b6cb720dec3bc3615a400db068992e;hpb=573ef10b2afd99d3c6a36370a9367609716c97d2;p=ghc-hetmet.git diff --git a/ghc/compiler/rename/RnIfaces.lhs b/ghc/compiler/rename/RnIfaces.lhs index f805e31..deff6b7 100644 --- a/ghc/compiler/rename/RnIfaces.lhs +++ b/ghc/compiler/rename/RnIfaces.lhs @@ -1,872 +1,931 @@ % -% (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 ( - cachedIface, - cachedDecl, CachingResult(..), - rnIfaces, - IfaceCache, initIfaceCache - ) where + getInterfaceExports, + getImportedInstDecls, getImportedRules, + lookupFixity, loadHomeInterface, + importDecl, recordSlurp, + getImportVersions, getSlurped, -IMP_Ubiq() + checkUpToDate, -import PreludeGlaST ( thenPrimIO, newVar, readVar, writeVar, SYN_IE(MutableVar) ) -#if __GLASGOW_HASKELL__ >= 200 -# define ST_THEN `stThen` -# define TRY_IO tryIO -IMPORT_1_3(GHCio(stThen,tryIO)) -#else -# define ST_THEN `thenPrimIO` -# define TRY_IO try -#endif + getDeclBinders + ) where -import HsSyn -import HsPragmas ( noGenPragmas ) -import RdrHsSyn -import RnHsSyn +#include "HsVersions.h" -import RnMonad -import RnSource ( rnTyDecl, rnClassDecl, rnInstDecl, rnPolyType ) -import RnUtils ( SYN_IE(RnEnv), emptyRnEnv, lookupRnEnv, lookupTcRnEnv, extendGlobalRnEnv ) -import ParseIface ( parseIface ) -import ParseUtils ( ParsedIface(..), RdrIfaceDecl(..), RdrIfaceInst(..), - VersionsMap(..), UsagesMap(..) +import CmdLineOpts ( opt_NoPruneDecls, opt_IgnoreIfacePragmas ) +import HsSyn ( HsDecl(..), TyClDecl(..), InstDecl(..), IfaceSig(..), + HsType(..), ConDecl(..), IE(..), ConDetails(..), Sig(..), + FixitySig(..), RuleDecl(..), + isClassOpSig + ) +import BasicTypes ( Version, NewOrData(..), defaultFixity ) +import RdrHsSyn ( RdrNameHsDecl, RdrNameInstDecl, RdrNameTyClDecl, RdrNameRuleDecl, + extractHsTyRdrNames ) +import RnEnv ( mkImportedGlobalName, newImportedBinder, mkImportedGlobalFromRdrName, + lookupOccRn, + pprAvail, + availName, availNames, addAvailToNameSet, + FreeVars, emptyFVs + ) +import RnMonad +import RnHsSyn ( RenamedHsDecl ) +import ParseIface ( parseIface, IfaceStuff(..) ) -import Bag ( emptyBag, unitBag, consBag, snocBag, - unionBags, unionManyBags, isEmptyBag, bagToList ) -import ErrUtils ( SYN_IE(Error), SYN_IE(Warning) ) -import FiniteMap ( emptyFM, lookupFM, addToFM, addToFM_C, plusFM, eltsFM, - fmToList, delListFromFM, sizeFM, foldFM, unitFM, - plusFM_C, addListToFM, keysFM{-ToDo:rm-}, FiniteMap +import FiniteMap ( FiniteMap, sizeFM, emptyFM, delFromFM, + lookupFM, addToFM, addToFM_C, addListToFM, + fmToList, elemFM, foldFM ) -import Maybes ( maybeToBool, MaybeErr(..) ) -import Name ( origName, moduleOf, nameOf, qualToOrigName, OrigName(..), - isLexCon, RdrName(..), Name{-instance NamedThing-} ) -import PprStyle -- ToDo:rm -import Outputable -- ToDo:rm -import PrelInfo ( builtinNameMaps, builtinKeysMap, builtinTcNamesMap, SYN_IE(BuiltinNames) ) -import Pretty -import UniqFM ( emptyUFM ) -import UniqSupply ( splitUniqSupply ) -import Util ( sortLt, removeDups, cmpPString, startsWith, - panic, pprPanic, assertPanic, pprTrace{-ToDo:rm-} ) +import Name ( Name {-instance NamedThing-}, + nameModule, isLocallyDefined, + isWiredInName, nameUnique, NamedThing(..) + ) +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(..), maybeToBool, orElse ) +import ListSetOps ( unionLists ) +import Outputable +import Unique ( Unique ) +import StringBuffer ( StringBuffer, hGetStringBuffer ) +import FastString ( mkFastString ) +import Lex +import Outputable + +import IO ( isDoesNotExistError ) +import List ( nub ) \end{code} -\begin{code} -type ModuleToIfaceContents = FiniteMap Module ParsedIface -type ModuleToIfaceFilePath = FiniteMap Module FilePath -#if __GLASGOW_HASKELL__ >= 200 -# define REAL_WORLD RealWorld -#else -# define REAL_WORLD _RealWorld -#endif +%********************************************************* +%* * +\subsection{Loading a new interface file} +%* * +%********************************************************* -data IfaceCache - = IfaceCache - Module -- the name of the module being compiled - BuiltinNames -- so we can avoid going after things - -- the compiler already knows about - (MutableVar REAL_WORLD - (ModuleToIfaceContents, -- interfaces for individual interface files - ModuleToIfaceContents, -- merged interfaces based on module name - -- used for extracting info about original names - ModuleToIfaceFilePath)) - -initIfaceCache mod hi_files - = newVar (emptyFM,emptyFM,hi_files) ST_THEN \ iface_var -> - return (IfaceCache mod builtinNameMaps iface_var) -\end{code} +\begin{code} +loadHomeInterface :: SDoc -> Name -> RnM d (Module, Ifaces) +loadHomeInterface doc_str name + = loadInterface doc_str (moduleName (nameModule name)) 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_` + + -- CHECK WHETHER WE HAVE IT ALREADY + 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 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 + 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 (mod, iface) -> + + -- LOAD IT INTO Ifaces + + -- 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 + 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 -> + 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 (mod, new_ifaces) + }} + +addModDeps :: Module -> ImportedModuleInfo + -> [ImportVersion a] -> ImportedModuleInfo +addModDeps mod mod_deps new_deps + = foldr add mod_deps new_deps + where + 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! + + | 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 -********************************************************* -* * -\subsection{Reading interface files} -* * -********************************************************* + -- Ignore the other sorts of decl +loadFixDecl mod_name fixity_env other_decl = returnRn fixity_env -Return cached info about a Module's interface; otherwise, -read the interface (using our @ModuleToIfaceFilePath@ map -to decide where to look). +loadDecl :: Module + -> DeclsMap + -> (Version, RdrNameHsDecl) + -> RnM d DeclsMap -Note: we have two notions of interface - * the interface for a particular file name - * the (combined) interface for a particular module name +loadDecl mod decls_map (version, decl) + = getDeclBinders new_name decl `thenRn` \ maybe_avail -> + case maybe_avail of { + Nothing -> returnRn decls_map; -- No bindings + Just avail -> -The idea is that two source files may declare a module -with the same name with the declarations being merged. + 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 + -- 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 -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. + {- + 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 GatedDecl + -> RdrNameInstDecl + -> 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 + -- 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 = removeContext inst_ty + free_names = extractHsTyRdrNames munged_inst_ty + in + 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} -ToDo: Check duplicate definitons are the same. -ToDo: Check/Merge duplicate pragmas. +%******************************************************** +%* * +\subsection{Loading usage information} +%* * +%******************************************************** \begin{code} -cachedIface :: IfaceCache - -> Bool -- True => want merged interface for original name - -- False => want file interface only - -> FAST_STRING -- item that prompted search (debugging only!) - -> Module - -> IO (MaybeErr ParsedIface Error) - -cachedIface (IfaceCache _ _ iface_var) want_orig_iface item modname - = readVar iface_var ST_THEN \ (iface_fm, orig_fm, file_fm) -> - - case (lookupFM iface_fm modname) of - Just iface -> return (want_iface iface orig_fm) - Nothing -> - case (lookupFM file_fm modname) of - Nothing -> return (Failed (noIfaceErr modname)) - Just file -> - readIface file modname item >>= \ 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 modname iface - orig_fm' = addToFM_C mergeIfaces orig_fm (iface_mod iface) iface - in - writeVar iface_var (iface_fm', orig_fm', file_fm) ST_THEN \ _ -> - return (want_iface iface orig_fm') - where - want_iface iface orig_fm - | want_orig_iface - = case lookupFM orig_fm modname of - Nothing -> Failed (noOrigIfaceErr modname) - 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) +checkUpToDate :: ModuleName -> RnMG Bool -- True <=> no need to recompile +checkUpToDate mod_name + = 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"), + pprModuleName mod_name]) `thenRn_` + returnRn False + + Just (_, iface) + -> -- Found it, so now check it + checkModUsage (pi_usages iface) 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 - ----------- -data CachingResult - = CachingFail Error -- tried to find a decl, something went wrong - | CachingHit RdrIfaceDecl -- got it - | CachingAvoided (Maybe (Either RnName RnName)) - -- didn't look in the interface - -- file(s); Nothing => the thing - -- *should* be in the source module; - -- Just (Left ...) => builtin val name; - -- Just (Right ..) => builtin tc name - -cachedDecl :: IfaceCache - -> Bool -- True <=> tycon or class name - -> OrigName - -> IO CachingResult - -cachedDecl iface_cache@(IfaceCache this_mod (b_val_names,b_tc_names) _) - class_or_tycon name@(OrigName mod str) - - = -- pprTrace "cachedDecl:" (ppr PprDebug name) $ - if mod == this_mod then -- some i/face has made a reference - return (CachingAvoided Nothing) -- to something from this module - else - let - b_env = if class_or_tycon then b_tc_names else b_val_names - in - case (lookupFM b_env name) of - Just rn -> -- in builtins! - return (CachingAvoided (Just ((if class_or_tycon then Right else Left) rn))) - - Nothing -> - cachedIface iface_cache True str mod >>= \ maybe_iface -> - case maybe_iface of - Failed err -> --pprTrace "cachedDecl:fail:" (ppr PprDebug orig) $ - return (CachingFail err) - Succeeded (ParsedIface _ _ _ _ _ _ exps _ _ tdefs vdefs _ _) -> - case (lookupFM (if class_or_tycon then tdefs else vdefs) str) of - Just decl -> return (CachingHit decl) - Nothing -> return (CachingFail (noDeclInIfaceErr mod str)) - ----------- -cachedDeclByType :: IfaceCache - -> RnName{-NB: diff type than cachedDecl -} - -> IO CachingResult - -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 "cachedDeclByType" rn) >>= \ maybe_decl -> + -- Only look in current directory, with suffix .hi + doc_str = sep [ptext SLIT("need usage info from"), pprModuleName mod_name] + +checkModUsage [] = returnRn True -- Yes! Everything is up to date! + +checkModUsage ((mod_name, old_mod_vers, _, whats_imported) : rest) + = loadInterface doc_str mod_name ImportBySystem `thenRn` \ (mod, ifaces) -> let - return_maybe_decl = return maybe_decl - return_failed msg = return (CachingFail msg) + maybe_mod_vers = case lookupFM (iImpModInfo ifaces) mod_name of + Just (version, _, Just (_, _, _)) -> Just version + other -> Nothing in - case maybe_decl of - CachingAvoided _ -> return_maybe_decl - CachingFail io_msg -> return_failed (ifaceIoErr io_msg rn) - CachingHit 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) - 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} + 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:"), pprModuleName mod_name]) `thenRn_` + checkModUsage rest + else + traceRn (sep [ptext SLIT("Module version has changed:"), pprModuleName mod_name]) `thenRn_` -\begin{code} -readIface :: FilePath -> Module -> FAST_STRING -> IO (MaybeErr ParsedIface Error) + -- Module version changed, so check entities inside -readIface file modname item - = --hPutStr stderr (" reading "++file++" ("++ _UNPK_ item ++")") >> - TRY_IO (readFile file) >>= \ 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 modname p) - ) + -- 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 - 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 + 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) + = mkImportedGlobalName mod occ_name `thenRn` \ name -> + case lookupNameEnv decls name of + + Nothing -> -- We used it before, but it ain't there now + putDocRn (sep [ptext SLIT("No longer exported:"), ppr name]) `thenRn_` + returnRn False + + 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 + -> putDocRn (sep [ptext SLIT("Out of date:"), ppr name]) `thenRn_` + returnRn False \end{code} +%********************************************************* +%* * +\subsection{Getting in a declaration} +%* * +%********************************************************* + \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))) $ - -} +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 + getModuleRn `thenRn` \ this_mod -> + let + mod = moduleName (nameModule name) + in + if mod == this_mod then -- Don't bring in decls from + -- the renamed module's own interface file + addWarnRn (importDeclWarn mod name) `thenRn_` + returnRn Nothing + else + getNonWiredInDecl name +\end{code} - -- 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) +\begin{code} +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 - decls_and_insts todo def_env occ_env to_return us - = let - (us1,us2) = splitUniqSupply us - in - 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) -> + doc_str = ptext SLIT("need decl for") <+> ppr needed_name +\end{code} - cacheInstModules iface_cache imp_mods >>= \ errs -> +@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, - do_insts decls_def_env decls_occ_env emptyRnEnv emptyFM - (add_errs errs decls_return) us2 + * 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. - -------- - 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) + * similarly for synonum type constructor - | 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 - | moduleOf (origName "do_decls" 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 - CachingAvoided _ -> - pprTrace "do_decls:caching avoided:" (ppr PprDebug n) $ - do_decls ns down to_return - - CachingFail err -> -- add the error, but keep going: - --pprTrace "do_decls:cache error:" (ppr PprDebug n) $ - do_decls ns down (add_err err to_return) - - CachingHit 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 - = (if isRnTyConOrClass n then lookupTcRnEnv else lookupRnEnv) def_env - (case (origName "lookup_defd" n) of { OrigName m s -> Qual m s }) - -- this is hack because we are reusing the RnEnv technology - -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 - de_orig imps = [ (Qual m n, v) | (OrigName m n, v) <- fmToList imps ] - -- again, this hackery because we are reusing the RnEnv technology + * if the wired-in name is another wired-in Id, it marks as "occurrences" + the free vars of the Id's type. - val_occs = val_defds ++ de_orig val_imps - tc_occs = tc_defds ++ de_orig tc_imps - in - case (extendGlobalRnEnv occ_env val_occs tc_occs) of { (new_occ_env, occ_dups) -> + * it loads the interface file for the wired-in thing for the + sole purpose of making sure that its instance declarations are available --- ASSERT(isEmptyBag occ_dups) --- False because we may get a dup on the name we just shoved in +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. + - (new_def_env, new_occ_env, us) }} ----------------- -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)) + +%********************************************************* +%* * +\subsection{Getting what a module exports} +%* * +%********************************************************* + +@getInterfaceExports@ is called only for directly-imported modules + +\begin{code} +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 [pprModuleName mod_name, ptext SLIT("is directly imported")] \end{code} + +%********************************************************* +%* * +\subsection{Instance declarations are handled specially} +%* * +%********************************************************* + \begin{code} -data AddedDecl -- purely local - = AddedTy RenamedTyDecl - | AddedClass RenamedClassDecl - | AddedSig RenamedSig - -rnIfaceDecl :: RdrIfaceDecl - -> RnM_Fixes REAL_WORLD - (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 -> +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 - defds = ([], [(tc, rn_tc)]) - implicits = mentioned `sub` defds + orphan_mods = [mod | (mod, (_, True, Nothing)) <- fmToList (iImpModInfo ifaces)] in - returnRn (AddedTy rn_decl, defds, implicits) + traceRn (text "Loading orphan modules" <+> fsep (map pprModuleName orphan_mods)) `thenRn_` + mapRn_ load_it orphan_mods `thenRn_` -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 -> + -- 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 - defds = (zip dcs rn_dcs ++ zip fcs rn_fcs , [(tc, rn_tc)]) - implicits = mentioned `sub` defds + (decls, new_insts) = selectGated gates (iInsts ifaces) in - returnRn (AddedTy rn_decl, defds, implicits) + setIfacesRn (ifaces { iInsts = new_insts }) `thenRn_` -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 - 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 -> + traceRn (sep [text "getImportedInstDecls:", + nest 4 (fsep (map ppr (nameSetToList gates))), + text "Slurped" <+> int (length decls) <+> text "instance declarations"]) `thenRn_` + returnRn decls + where + load_it mod = loadInterface (doc_str mod) mod ImportBySystem + doc_str mod = sep [pprModuleName mod, ptext SLIT("is a orphan-instance module")] + +getImportedRules :: RnMG [(Module,RdrNameHsDecl)] +getImportedRules + = getIfacesRn `thenRn` \ ifaces -> let - defds = ([(f, rn_f)], []) - implicits = mentioned `sub` defds + gates = iSlurp ifaces -- Anything at all that's been slurped + (decls, new_rules) = selectGated gates (iRules ifaces) in - returnRn (AddedSig (Sig rn_f rn_ty noGenPragmas src_loc), defds, implicits) + setIfacesRn (ifaces { iRules = new_rules }) `thenRn_` + traceRn (sep [text "getImportedRules:", + text "Slurped" <+> int (length decls) <+> text "rules"]) `thenRn_` + returnRn decls ----- -sub :: ImplicitEnv -> ([(RdrName,RnName)], [(RdrName,RnName)]) -> ImplicitEnv +selectGated gates decl_bag +#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 -sub (val_ment, tc_ment) (val_defds, tc_defds) - = (delListFromFM val_ment (map (qualToOrigName . fst) val_defds), - delListFromFM tc_ment (map (qualToOrigName . fst) tc_defds)) + | 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} -% ------------------------------ -@cacheInstModules@: cache instance modules specified in imports +%********************************************************* +%* * +\subsection{Keeping track of what we've slurped, and version numbers} +%* * +%********************************************************* -\begin{code} -cacheInstModules :: IfaceCache -> [Module] -> IO (Bag Error) +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". -cacheInstModules iface_cache@(IfaceCache _ _ iface_var) imp_mods - = readVar iface_var ST_THEN \ (iface_fm, _, _) -> - 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 - in - --pprTrace "cacheInstModules:" (ppCat (map ppPStr imp_imods)) $ - accumulate (map (cachedIface iface_cache False SLIT("instance_modules")) imp_imods) >>= \ err_or_ifaces -> +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. - -- Sanity Check: - -- Assert that instance modules given by direct imports contains - -- instance modules extracted from all visited modules +What about this? + module A( f, g ) where module B( f ) where + import B( f ) f = h 3 + g = ... h = ... - readVar iface_var ST_THEN \ (all_iface_fm, _, _) -> - let - all_ifaces = eltsFM all_iface_fm - (all_imods, _) = removeDups cmpPString (bagToList (unionManyBags (map get_ims (all_ifaces)))) - in - ASSERT(sortLt (<) imp_imods == sortLt (<) all_imods) +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: - 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 -\end{code} +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. -@rnIfaceInstStuff@: Deal with instance declarations from interface files. +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 (OrigName, OrigName) 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@(IfaceCache _ _ iface_var) 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_var ST_THEN \ (_, orig_iface_fm, _) -> +getImportVersions :: ModuleName -- 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 = concat (map get_insts all_ifaces) - interesting_insts = filter want_inst all_insts + mod_map = iImpModInfo ifaces + imp_names = iVSlurp ifaces + + -- mv_map groups together all the things imported from a particular module. + mv_map1, mv_map2 :: FiniteMap ModuleName (WhatsImported Name) + + -- mv_map1 records all the modules that have a "module M" + -- in this module's export list with an "Everything" + mv_map1 = foldr add_mod emptyFM export_mods + + -- mv_map2 adds the version numbers of things exported individually + mv_map2 = foldr add_mv mv_map1 imp_names + + -- Build the result list by adding info for each module, + -- *omitting* (a) library modules + -- (b) source-imported modules + mk_version_info mod_name (version, has_orphans, cts) so_far + | omit cts = so_far -- Don't record usage info for this module + | otherwise = (mod_name, version, has_orphans, whats_imported) : so_far + where + whats_imported = case lookupFM mv_map2 mod_name of + Just wi -> wi + Nothing -> Specifically [] + + omit (Just (mod, boot_import, _)) = isLibModule mod || boot_import + omit Nothing = False + in + returnRn (foldFM mk_version_info [] mod_map) + where + export_mods = case exports of + Nothing -> [] + Just es -> [mod | IEModuleContents mod <- es, mod /= this_mod] - -- Sanity Check: - -- Assert that there are no more instances for the done instances + add_mv v@(name, version) mv_map + = addToFM_C add_item mv_map mod (Specifically [v]) + where + mod = moduleName (nameModule name) - claim_done = filter is_done_inst all_insts - claim_done_env = foldr add_done_inst emptyFM claim_done + add_item Everything _ = Everything + add_item (Specifically xs) _ = Specifically (v:xs) - has_val fm (k,i) = case lookupFM fm k of { Nothing -> False; Just v -> i == v } - 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)) - } - where - get_insts (ParsedIface imod _ _ _ _ _ _ _ _ _ _ insts _) = [(imod, inst) | inst <- bagToList insts] - - tycon_class clas tycon = (qualToOrigName clas, qualToOrigName tycon) - - add_done_inst (_, InstSig clas tycon _ _) inst_env - = addToFM_C (+) inst_env (tycon_class clas tycon) 1 - - is_done_inst (_, InstSig clas tycon _ _) - = maybeToBool (lookupFM done_inst_env (tycon_class clas tycon)) - - add_imp_occs (val_imps, tc_imps) occ_env - = case (extendGlobalRnEnv occ_env (de_orig val_imps) (de_orig tc_imps)) of - (ext_occ_env, occ_dups) -> ASSERT(isEmptyBag occ_dups) - ext_occ_env - where - de_orig imps = [ (Qual m n, v) | (OrigName m n, v) <- fmToList imps ] - -- again, this hackery because we are reusing the RnEnv technology - - want_inst i@(imod, 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 orig = qualToOrigName nm in - case (lookupFM builtinTcNamesMap orig) of - Just _ -> True - Nothing -> maybeToBool (lookupFM builtinKeysMap orig) + add_mod mod mv_map = addToFM mv_map mod Everything \end{code} \begin{code} -rnIfaceInst :: (Module, RdrIfaceInst) -> RnM_Fixes REAL_WORLD RenamedInstDecl +getSlurped + = getIfacesRn `thenRn` \ ifaces -> + returnRn (iSlurp ifaces) + +recordSlurp maybe_version avail + = getIfacesRn `thenRn` \ ifaces@(Ifaces { iSlurp = slurped_names, + iVSlurp = imp_names }) -> + let + new_slurped_names = addAvailToNameSet slurped_names avail -rnIfaceInst (imod, InstSig _ _ _ inst_decl) = rnInstDecl (inst_decl imod) + new_imp_names = case maybe_version of + Just version -> (availName avail, version) : imp_names + Nothing -> imp_names + in + setIfacesRn (ifaces { iSlurp = new_slurped_names, + iVSlurp = new_imp_names }) \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@(IfaceCache _ _ iface_var) 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_var ST_THEN \ (_, orig_iface_fm, _) -> - let - all_ifaces = eltsFM orig_iface_fm - -- all the interfaces we have looked at +getDeclBinders :: (RdrName -> SrcLoc -> RnM d Name) -- New-name function + -> RdrNameHsDecl + -> RnM d (Maybe 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 (TyClD (TyData _ _ tycon _ condecls _ _ src_loc)) + = new_name tycon src_loc `thenRn` \ tycon_name -> + getConFieldNames new_name condecls `thenRn` \ 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 - val_stuff@(val_usages, val_versions) - = foldFM (process_item big_maps) (emptyFM, emptyFM){-init-} qual +getDeclBinders new_name (TyClD (TySynonym tycon _ _ src_loc)) + = new_name tycon src_loc `thenRn` \ tycon_name -> + returnRn (Just (AvailTC tycon_name [tycon_name])) - (all_usages, all_versions) - = foldFM (process_item big_maps) val_stuff{-keep going-} tc_qual +getDeclBinders new_name (TyClD (ClassDecl _ cname _ sigs _ _ _ _ _ src_loc)) + = new_name cname src_loc `thenRn` \ class_name -> + + -- Record the names for the class ops + let + -- just want class-op sigs + op_sigs = filter isClassOpSig sigs in - return (all_usages, all_versions, []) + 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 (Just (Avail var_name)) + +getDeclBinders new_name (FixD _) = returnRn Nothing +getDeclBinders new_name (ForD _) = returnRn Nothing +getDeclBinders new_name (DefD _) = returnRn Nothing +getDeclBinders new_name (InstD _) = returnRn Nothing +getDeclBinders new_name (RuleD _) = returnRn Nothing + +---------------- +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" - = case (add_to_usages usages key) of - Nothing -> as_before - Just new_usages -> (new_usages, versions) - where - add_to_usages usages key@(n,m) - = case (lookupFM big_mv_map m) of - Nothing -> Nothing - Just mv -> - case (lookupFM big_version_map key) of - Nothing -> Nothing - Just kv -> - Just $ addToFM usages m ( - case (lookupFM usages m) of - Nothing -> -- nothing for this module yet... - (mv, unitFM n kv) - - Just (mversion, mstuff) -> -- the "new" stuff will shadow the old - ASSERT(mversion == mv) - (mversion, addToFM mstuff n kv) - ) - - irrelevant (RnConstr _ _) = True -- We don't report these in their - irrelevant (RnField _ _) = True -- own right in usages/etc. - irrelevant (RnClassOp _ _) = True - irrelevant (RnImplicit n) = isLexCon (nameOf (origName "irrelevant" n)) -- really a RnConstr - irrelevant _ = False + fields = concat (map fst fielddecls) + +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 (nn ++ ns) +getConFieldNames new_name [] = returnRn [] + +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'te returned by getDeclBinders because they aren't in scope; +but they *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} -thisModImplicitWarn mod n sty - = ppBesides [ppPStr SLIT("An interface has an implicit need of "), ppr sty n, ppPStr SLIT("; assuming this module will provide it.")] +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} -noIfaceErr mod sty - = ppCat [ppPStr SLIT("Could not find interface for:"), ppPStr mod] +%********************************************************* +%* * +\subsection{Reading an interface file} +%* * +%********************************************************* -noOrigIfaceErr mod sty - = ppCat [ppPStr SLIT("Could not find original interface for:"), ppPStr mod] +\begin{code} +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 mod_name from hi_file + = traceRn trace_msg `thenRn_` + -- 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 + find_path ImportByUser (hi_map, _) = (False, lookupFM hi_map mod_name) + find_path ImportByUserSource (_, hiboot_map) = (True, lookupFM hiboot_map mod_name) -noDeclInIfaceErr mod str sty - = ppBesides [ppPStr SLIT("Could not find interface declaration of: "), - ppPStr mod, ppStr ".", ppPStr str] + 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) -cannaeReadErr file err sty - = ppBesides [ppPStr SLIT("Failed in reading file: "), ppStr file, ppStr "; error=", ppStr (show err)] + | 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} -ifaceLookupWiredErr msg n sty - = ppBesides [ppPStr SLIT("Why am I looking up a wired-in "), ppStr msg, ppChar ':', ppr sty n] +@readIface@ tries just the one file. -badIfaceLookupErr msg name decl sty - = ppBesides [ppPStr SLIT("Expected a "), ppStr msg, ppStr " declaration, but got this: ???"] +\begin{code} +readIface :: Module -> String -> RnM d (Maybe (Module, ParsedIface)) + -- Nothing <=> file not found, or unreadable, or illegible + -- Just x <=> successfully found and parsed +readIface the_mod file_path + = ioToRnM (hGetStringBuffer False file_path) `thenRn` \ read_result -> + case read_result of + 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) + (hsep [ ptext SLIT("Something is amiss; requested module name") + , pprModule the_mod + , ptext SLIT("differs from name found in the interface file ") + , pprModuleName mod_nm + ]) `thenRn_` + returnRn (Just (the_mod, iface)) + + Left err + | isDoesNotExistError err -> returnRn Nothing + | otherwise -> failWithRn Nothing (cannaeReadFile file_path err) +\end{code} -ifaceIoErr io_msg rn sty - = ppBesides [io_msg sty, ppStr "; looking for: ", ppr sty rn] +%********************************************************* +%* * +\subsection{Errors} +%* * +%********************************************************* + +\begin{code} +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 mod 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("Interface:"), quotes (pprModuleName mod), + comma, ptext SLIT("name:"), quotes (ppr name)] + +warnRedundantSourceImport mod_name + = ptext SLIT("Unnecessary {- SOURCE -} in the import of module") <+> quotes (pprModuleName mod_name) \end{code}