X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Frename%2FRnIfaces.lhs;h=1d4711f51524d321f29d24ba78caff5a4a9dbe4d;hb=9bedea20f62a1da832c69833c39dd1d15e6ee9a3;hp=dfd74faf4453ae37ebf666fbf861f74eaaac26dd;hpb=1b919f1d34d4b740d16fbd1bf25b2189133b7147;p=ghc-hetmet.git diff --git a/ghc/compiler/rename/RnIfaces.lhs b/ghc/compiler/rename/RnIfaces.lhs index dfd74fa..1d4711f 100644 --- a/ghc/compiler/rename/RnIfaces.lhs +++ b/ghc/compiler/rename/RnIfaces.lhs @@ -4,158 +4,97 @@ \section[RnIfaces]{Cacheing and Renaming of Interfaces} \begin{code} -module RnIfaces ( - getInterfaceExports, - getImportedInstDecls, - getSpecialInstModules, getDeferredDataDecls, - importDecl, recordSlurp, - getImportVersions, getSlurpedNames, getRnStats, getImportedFixities, +module RnIfaces +#if 0 + ( + findAndReadIface, - checkUpToDate, + getInterfaceExports, getDeferredDecls, + getImportedInstDecls, getImportedRules, + lookupFixityRn, loadHomeInterface, + importDecl, ImportDeclResult(..), recordLocalSlurps, loadBuiltinRules, + mkImportExportInfo, getSlurped, - getDeclBinders, - mkSearchPath - ) where + checkModUsage, outOfDate, upToDate, + + getDeclBinders, getDeclSysBinders, + removeContext -- removeContext probably belongs somewhere else + ) +#endif +where #include "HsVersions.h" -import CmdLineOpts ( opt_PruneTyDecls, opt_PruneInstDecls, - opt_D_show_rn_imports, opt_IgnoreIfacePragmas - ) +import CmdLineOpts ( opt_NoPruneDecls, opt_NoPruneTyDecls, opt_IgnoreIfacePragmas ) import HsSyn ( HsDecl(..), TyClDecl(..), InstDecl(..), IfaceSig(..), HsType(..), ConDecl(..), IE(..), ConDetails(..), Sig(..), - FixitySig(..), - hsDeclName, countTyClDecls, isDataDecl, nonFixitySigs + ForeignDecl(..), ForKind(..), isDynamicExtName, + FixitySig(..), RuleDecl(..), + isClassOpSig, DeprecDecl(..) ) +import HsImpExp ( ieNames ) +import CoreSyn ( CoreRule ) import BasicTypes ( Version, NewOrData(..) ) -import RdrHsSyn ( RdrNameHsDecl, RdrNameInstDecl, RdrNameTyClDecl, - ) -import RnEnv ( newImportedGlobalName, newImportedGlobalFromRdrName, - addImplicitOccsRn, pprAvail, - availName, availNames, addAvailToNameSet +import RdrHsSyn ( RdrNameHsDecl, RdrNameInstDecl, RdrNameRuleDecl, + RdrNameDeprecation, RdrNameIE, + extractHsTyRdrNames ) -import RnSource ( rnHsSigType ) +import RnEnv import RnMonad -import RnHsSyn ( RenamedHsDecl ) import ParseIface ( parseIface, IfaceStuff(..) ) -import FiniteMap ( FiniteMap, sizeFM, emptyFM, delFromFM, - lookupFM, addToFM, addToFM_C, addListToFM, - fmToList - ) -import Name ( Name {-instance NamedThing-}, - nameModule, isLocallyDefined, - isWiredInName, maybeWiredInTyConName, - maybeWiredInIdName, nameUnique, NamedThing(..), - pprEncodedFS +import Name ( Name {-instance NamedThing-}, nameOccName, + nameModule, isLocallyDefined, + {-isWiredInName, -} NamedThing(..), + elemNameEnv, extendNameEnv ) -import Module ( Module, mkBootModule, moduleString, pprModule, - mkDynamicModule, moduleIfaceFlavour, bootFlavour, hiFile, - moduleUserString, moduleFS, setModuleFlavour +import Module ( Module, mkVanillaModule, + moduleName, isModuleInThisPackage, + ModuleName, WhereFrom(..), ) import RdrName ( RdrName, rdrNameOcc ) import NameSet -import Id ( idType, isDataConId_maybe ) -import DataCon ( dataConTyCon, dataConType ) -import TyCon ( TyCon, tyConDataCons, isSynTyCon, getSynTyConDefn ) -import Type ( namesOfType ) -import Var ( Id ) import SrcLoc ( mkSrcLoc, SrcLoc ) -import PrelMods ( pREL_GHC ) -import PrelInfo ( cCallishTyKeys, thinAirModules ) -import Bag -import Maybes ( MaybeErr(..), maybeToBool ) -import ListSetOps ( unionLists ) -import Outputable -import Unique ( Unique ) -import StringBuffer ( StringBuffer, hGetStringBuffer ) +import PrelInfo ( cCallishTyKeys ) +import Maybes ( maybeToBool ) +import Unique ( Uniquable(..) ) +import StringBuffer ( hGetStringBuffer ) import FastString ( mkFastString ) +import ErrUtils ( Message ) +import Util ( sortLt ) +import Lex +import FiniteMap import Outputable +import Bag +import HscTypes -import IO ( isDoesNotExistError ) import List ( nub ) -\end{code} - - - -%********************************************************* -%* * -\subsection{Statistics} -%* * -%********************************************************* - -\begin{code} -getRnStats :: [RenamedHsDecl] -> RnMG SDoc -getRnStats all_decls - = getIfacesRn `thenRn` \ ifaces -> - let - n_mods = sizeFM (iModMap ifaces) - - decls_imported = filter is_imported_decl all_decls - - decls_read = [decl | (_, avail, decl, True) <- nameEnvElts (iDecls ifaces), - -- Data, newtype, and class decls are in the decls_fm - -- under multiple names; the tycon/class, and each - -- constructor/class op too. - -- The 'True' selects just the 'main' decl - not (isLocallyDefined (availName avail)) - ] - - (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 - - (unslurped_insts, _) = iDefInsts ifaces - 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 decls - -- - -- $$ - -- text "=========" - -- $$ - -- ppr imported_decls - -- ) $ - (class_decls, - data_decls, abstract_data_decls, - newtype_decls, abstract_newtype_decls, - syn_decls, - val_decls, - inst_decls) - where - tycl_decls = [d | TyClD d <- decls] - (class_decls, data_decls, newtype_decls, syn_decls) = countTyClDecls tycl_decls - abstract_data_decls = length [() | TyData DataType _ _ _ [] _ _ _ <- tycl_decls] - abstract_newtype_decls = length [() | TyData NewType _ _ _ [] _ _ _ <- tycl_decls] - val_decls = length [() | SigD _ <- decls] - inst_decls = length [() | InstD _ <- decls] +#if 1 +import Panic ( panic ) +lookupFixityRn = panic "lookupFixityRn" +findAndReadIface = panic "findAndReadIface" +getInterfaceExports = panic "getInterfaceExports" +getDeclBinders = panic "getDeclBinders" +recordLocalSlurps = panic "recordLocalSlurps" +checkModUsage = panic "checkModUsage" +outOfDate = panic "outOfDate" +getSlurped = panic "getSlurped" +removeContext = panic "removeContext" +loadBuiltinRules = panic "loadBuiltinRules" +getDeferredDecls = panic "getDeferredDecls" +data ImportDeclResult + = AlreadySlurped + | WiredIn + | Deferred + | HereItIs (Module, RdrNameHsDecl) +getImportedInstDecls = panic "getImportedInstDecls" +importDecl = panic "importDecl" +mkImportExportInfo = panic "mkImportExportInfo" +getImportedRules = panic "getImportedRules" +#else +\end{code} -\end{code} %********************************************************* %* * @@ -164,96 +103,182 @@ count_decls decls %********************************************************* \begin{code} -loadHomeInterface :: SDoc -> Name -> RnMG (Module, Ifaces) +loadHomeInterface :: SDoc -> Name -> RnM d Ifaces loadHomeInterface doc_str name - = loadInterface doc_str (nameModule name) - -loadInterface :: SDoc -> Module -> RnMG (Module, Ifaces) -loadInterface doc_str load_mod - = getIfacesRn `thenRn` \ ifaces -> + = loadInterface doc_str (moduleName (nameModule name)) ImportBySystem + +loadOrphanModules :: [ModuleName] -> RnM d () +loadOrphanModules mods + | null mods = returnRn () + | otherwise = traceRn (text "Loading orphan modules:" <+> + fsep (map mods)) `thenRn_` + mapRn_ load mods `thenRn_` + returnRn () + where + load mod = loadInterface (mk_doc mod) mod ImportBySystem + mk_doc mod = ppr mod <+> ptext SLIT("is a orphan-instance module") + + +loadInterface :: SDoc -> ModuleName -> WhereFrom -> RnM d Ifaces +loadInterface doc mod from + = tryLoadInterface doc mod from `thenRn` \ (ifaces, maybe_err) -> + case maybe_err of + Nothing -> returnRn ifaces + Just err -> failWithRn ifaces err + +tryLoadInterface :: SDoc -> ModuleName -> WhereFrom -> RnM d (Ifaces, Maybe Message) + -- Returns (Just err) if an error happened + -- Guarantees to return with iImpModInfo m --> (... Just cts) + -- (If the load fails, we plug in a vanilla placeholder +tryLoadInterface doc_str mod_name from + = getIfacesRn `thenRn` \ ifaces -> let - hi_boot_wanted = bootFlavour (moduleIfaceFlavour load_mod) - mod_map = iModMap ifaces - (insts, tycls_names) = iDefInsts ifaces - + mod_map = iImpModInfo ifaces + mod_info = lookupFM mod_map mod_name + + hi_boot_file + = case (from, mod_info) of + (ImportByUser, _) -> False -- Not hi-boot + (ImportByUserSource, _) -> True -- hi-boot + (ImportBySystem, Just (_, is_boot, _)) -> is_boot -- + (ImportBySystem, Nothing) -> False + -- We're importing a module we know absolutely + -- nothing about, so we assume it's from + -- another package, where we aren't doing + -- dependency tracking. So it won't be a hi-boot file. + + redundant_source_import + = case (from, mod_info) of + (ImportByUserSource, Just (_,False,_)) -> True + other -> False in -- CHECK WHETHER WE HAVE IT ALREADY - case lookupFM mod_map load_mod of { - Just (existing_hif, _, _) - | hi_boot_wanted || not (bootFlavour existing_hif) - -> -- Already in the cache, and new version is no better than old, - -- so don't re-read it - returnRn (setModuleFlavour existing_hif load_mod, ifaces) ; - other -> + case mod_info of { + Just (_, _, True) + -> -- We're read it already so don't re-read it + returnRn (ifaces, Nothing) ; + + _ -> + + -- Issue a warning for a redundant {- SOURCE -} import + -- NB that we arrange to read all the ordinary imports before + -- any of the {- SOURCE -} imports + warnCheckRn (not redundant_source_import) + (warnRedundantSourceImport mod_name) `thenRn_` -- READ THE MODULE IN - findAndReadIface doc_str load_mod `thenRn` \ read_result -> + findAndReadIface doc_str mod_name hi_boot_file `thenRn` \ read_resultb -> case read_result of { - Nothing | not hi_boot_wanted && load_mod `elem` thinAirModules - -> -- Hack alert! When compiling PrelBase we have to load the - -- decls for packCString# and friends; they are 'thin-air' Ids - -- (see PrelInfo.lhs). So if we don't find the HiFile we quietly - -- look for a .hi-boot file instead, and use that - -- - -- NB this causes multiple "failed" attempts to read PrelPack, - -- which makes curious reading with -dshow-rn-trace, but - -- there's no harm done - loadInterface doc_str (mkBootModule load_mod) - - - | otherwise - -> -- Not found, so add an empty export env to the Ifaces map + Left err -> -- Not found, so add an empty export env to the Ifaces map -- so that we don't look again - let - new_mod_map = addToFM mod_map load_mod (hiFile, 0, []) - new_ifaces = ifaces { iModMap = new_mod_map } - in - setIfacesRn new_ifaces `thenRn_` - failWithRn (load_mod, new_ifaces) (noIfaceErr load_mod) ; + let + new_mod_map = addToFM mod_map mod_name (False, False, True) + new_ifaces = ifaces { iImpModInfo = new_mod_map } + in + setIfacesRn new_ifaces `thenRn_` + returnRn (new_ifaces, Just err) ; -- Found and parsed! - Just (the_mod, ParsedIface mod_vers usages exports rd_inst_mods rd_decls rd_insts) -> - + Right (mod, iface) -> -- LOAD IT INTO Ifaces - -- First set the module -- 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 -> - setModuleRn the_mod $ -- First set the module name of the module being loaded, - -- so that unqualified occurrences in the interface file - -- get the right qualifer - foldlRn loadDecl (iDecls ifaces) rd_decls `thenRn` \ new_decls -> - foldlRn loadFixDecl (iFixes ifaces) rd_decls `thenRn` \ new_fixities -> - foldlRn loadInstDecl insts rd_insts `thenRn` \ new_insts -> - mapRn (loadExport this_mod) exports `thenRn` \ avails_s -> + -- Sanity check. If we're system-importing a module we know nothing at all + -- about, it should be from a different package to this one + WARN( not (maybeToBool mod_info) && + case from of { ImportBySystem -> True; other -> False } && + isModuleInThisPackage mod, + ppr mod ) + + loadDecls mod (iDecls ifaces) (pi_decls iface) `thenRn` \ (decls_vers, new_decls) -> + loadRules mod (iRules ifaces) (pi_rules iface) `thenRn` \ (rule_vers, new_rules) -> + loadFixDecls mod_name (pi_fixity iface) `thenRn` \ (fix_vers, fix_env) -> + foldlRn (loadDeprec mod) emptyDeprecEnv (pi_deprecs iface) `thenRn` \ deprec_env -> + foldlRn (loadInstDecl mod) (iInsts ifaces) (pi_insts iface) `thenRn` \ new_insts -> + loadExports (pi_exports iface) `thenRn` \ avails -> let - -- Notice: the 'flavour' of the loaded Module does not have to - -- be the same as the requested Module. - the_mod_hif = moduleIfaceFlavour the_mod - mod_details = (the_mod_hif, mod_vers, concat avails_s) - - -- Exclude this module from the "special-inst" modules - new_inst_mods = iInstMods ifaces `unionLists` (filter (/= this_mod) rd_inst_mods) - - new_ifaces = ifaces { iModMap = addToFM mod_map the_mod mod_details, - iDecls = new_decls, - iFixes = new_fixities, - iDefInsts = (new_insts, tycls_names), - iInstMods = new_inst_mods } + version = VersionInfo { modVers = pi_vers iface, + fixVers = fix_vers, + ruleVers = rule_vers, + declVers = decl_vers } + + -- 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 (pi_usages iface) mod_map + other -> mod_map + mod_map2 = addToFM mod_map1 mod_name (pi_orphan iface, hi_boot_file, True) + + -- Now add info about this module to the PST + new_pst = extendModuleEnv pst mod mod_detils + mod_details = ModDetails { mdModule = mod, mvVersion = version, + mdExports = avails, + mdFixEnv = fix_env, mdDeprecEnv = deprec_env } + + new_ifaces = ifaces { iPST = new_pst, + iDecls = new_decls, + iInsts = new_insts, + iRules = new_rules, + iImpModInfo = mod_map2 } in setIfacesRn new_ifaces `thenRn_` - returnRn (the_mod, new_ifaces) + returnRn (new_ifaces, Nothing) }} -loadExport :: Module -> ExportItem -> RnMG [AvailInfo] +----------------------------------------------------- +-- Adding module dependencies from the +-- import decls in the interface file +----------------------------------------------------- + +addModDeps :: Module -> PackageSymbolTable -> [ImportVersion a] + -> ImportedModuleInfo -> ImportedModuleInfo +-- (addModDeps M ivs deps) +-- We are importing module M, and M.hi contains 'import' decls given by ivs +addModDeps mod new_deps mod_deps + = foldr add mod_deps filtered_new_deps + where + -- Don't record dependencies when importing a module from another package + -- Except for its descendents which contain orphans, + -- and in that case, forget about the boot indicator + filtered_new_deps :: (ModuleName, (WhetherHasOrphans, IsBootInterface)) + filtered_new_deps + | isModuleInThisPackage mod + = [ (imp_mod, (has_orphans, is_boot, False)) + | (imp_mod, has_orphans, is_boot, _) <- new_deps + ] + | otherwise = [ (imp_mod, (True, False, False)) + | (imp_mod, has_orphans, _, _) <- new_deps, + has_orphans + ] + add (imp_mod, dep) deps = addToFM_C combine deps imp_mod dep + + combine old@(_, old_is_boot, old_is_loaded) new + | old_is_loaded || not old_is_boot = old -- Keep the old info if it's already loaded + -- or if it's a non-boot pending load + | otherwise = new -- Otherwise pick new info + + +----------------------------------------------------- +-- Loading the export list +----------------------------------------------------- + +loadExports :: [ExportItem] -> RnM d Avails +loadExports items + = getModuleRn `thenRn` \ this_mod -> + mapRn (loadExport this_mod) items `thenRn` \ avails_s -> + returnRn (concat avails_s) + + +loadExport :: Module -> ExportItem -> RnM d [AvailInfo] loadExport this_mod (mod, entities) - | mod == this_mod = returnRn [] + | mod == moduleName 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 @@ -271,10 +296,9 @@ loadExport this_mod (mod, entities) -- but it's a bogus thing to do! | otherwise - = setModuleFlavourRn mod `thenRn` \ mod' -> - mapRn (load_entity mod') entities + = mapRn (load_entity mod) entities where - new_name mod occ = newImportedGlobalName mod occ + new_name mod occ = newGlobalName mod occ load_entity mod (Avail occ) = new_name mod occ `thenRn` \ name -> @@ -285,46 +309,55 @@ loadExport this_mod (mod, entities) returnRn (AvailTC name names) -loadFixDecl :: FixityEnv - -> (Version, RdrNameHsDecl) - -> RnMG FixityEnv -loadFixDecl fixity_env (version, FixD (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 - newImportedGlobalFromRdrName rdr_name `thenRn` \ name -> - let - new_fixity_env = addToNameEnv fixity_env name (FixitySig name fixity loc) - in - returnRn new_fixity_env +----------------------------------------------------- +-- Loading type/class/value decls +----------------------------------------------------- - -- Ignore the other sorts of decl -loadFixDecl fixity_env other_decl = returnRn fixity_env +loadDecls :: Module + -> DeclsMap + -> [(Version, RdrNameHsDecl)] + -> RnM d (NameEnv Version, DeclsMap) +loadDecls mod decls_map decls + = foldlRn (loadDecl mod) (emptyNameEnv, decls_map) decls -loadDecl :: DeclsMap +loadDecl :: Module + -> (NameEnv Version, DeclsMap) -> (Version, RdrNameHsDecl) - -> RnMG DeclsMap - -loadDecl decls_map (version, decl) + -> RnM d (NameEnv Version, DeclsMap) +loadDecl mod (version_map, decls_map) (version, decl) = getDeclBinders new_name decl `thenRn` \ maybe_avail -> case maybe_avail of { - Nothing -> returnRn decls_map; -- No bindings - Just avail -> + Nothing -> returnRn (version_map, decls_map); -- No bindings + Just avail -> getDeclSysBinders new_name decl `thenRn` \ sys_bndrs -> let + full_avail = addSysAvails avail sys_bndrs + -- Add the sys-binders to avail. When we import the decl, + -- it's full_avail that will get added to the 'already-slurped' set (iSlurp) + -- If we miss out sys-binders, we'll read the decl multiple times! + main_name = availName avail new_decls_map = foldl add_decl decls_map - [ (name, (version,avail,decl',name==main_name)) - | name <- sys_bndrs ++ availNames avail] + [ (name, (full_avail, name==main_name, (mod, decl'))) + | name <- availNames full_avail] add_decl decls_map (name, stuff) = WARN( name `elemNameEnv` decls_map, ppr name ) - addToNameEnv decls_map name stuff + extendNameEnv decls_map name stuff + + new_version_map = extendNameEnv version_map main_name version in - returnRn new_decls_map + returnRn (new_version_map, new_decls_map) } where - new_name rdr_name loc = newImportedGlobalFromRdrName rdr_name + -- newTopBinder 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. + -- There maybe occurrences that don't have the correct Module, but + -- by the typechecker will propagate the binding definition to all + -- the occurrences, so that doesn't matter + new_name rdr_name loc = newTopBinder mod rdr_name loc + {- If a signature decl is being loaded, and optIgnoreIfacePragmas is on, we toss away unfolding information. @@ -341,16 +374,36 @@ loadDecl decls_map (version, decl) 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) - _ -> decl + decl' = case decl of + SigD (IfaceSig name tp ls loc) | opt_IgnoreIfacePragmas + -> SigD (IfaceSig name tp [] loc) + other -> decl -loadInstDecl :: Bag IfaceInst +----------------------------------------------------- +-- Loading fixity decls +----------------------------------------------------- + +loadFixDecls mod_name (version, decls) + | null decls = returnRn (version, emptyNameEnv) + + | otherwise + = mapRn (loadFixDecl mod_name) decls `thenRn` \ to_add -> + returnRn (version, mkNameEnv to_add) + +loadFixDecl mod_name sig@(FixitySig rdr_name fixity loc) + = newGlobalName mod_name (rdrNameOcc rdr_name) `thenRn` \ name -> + returnRn (name, FixitySig name fixity loc) + + +----------------------------------------------------- +-- Loading instance decls +----------------------------------------------------- + +loadInstDecl :: Module + -> IfaceInsts -> RdrNameInstDecl - -> RnMG (Bag IfaceInst) -loadInstDecl insts decl@(InstDecl inst_ty binds uprags dfun_name src_loc) + -> RnM d IfaceInsts +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 @@ -362,102 +415,167 @@ loadInstDecl insts decl@(InstDecl inst_ty binds uprags dfun_name src_loc) -- -- 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 - 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 free variables of the type - initRnMS emptyRnEnv vanillaInterfaceMode ( - discardOccurrencesRn (rnHsSigType (text "an instance decl") munged_inst_ty) - ) `thenRn` \ (_, gate_names) -> - getModuleRn `thenRn` \ mod_name -> - returnRn (((mod_name, decl), gate_names) `consBag` insts) - -vanillaInterfaceMode = InterfaceMode Compulsory + setModuleRn mod $ + mapRn lookupOrigName 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 (HsFunTy _ ty) = removeFuns ty +removeFuns ty = ty + + +----------------------------------------------------- +-- Loading Rules +----------------------------------------------------- + +loadRules :: Module -> IfaceRules + -> (Version, [RdrNameRuleDecl]) + -> RnM d (Version, IfaceRules) +loadRules mod rule_bag (version, rules) + | null rules || opt_IgnoreIfacePragmas + = returnRn (version, rule_bag) + | otherwise + = setModuleRn mod $ + mapRn (loadRule mod) rules `thenRn` \ new_rules -> + returnRn (version, rule_bag `unionBags` listToBag new_rules) + +loadRule :: Module -> RdrNameRuleDecl -> RnM d GatedDecl +-- "Gate" the rule simply by whether the rule variable is +-- needed. We can refine this later. +loadRule mod decl@(IfaceRule _ _ var _ _ src_loc) + = lookupOrigName var `thenRn` \ var_name -> + returnRn (unitNameSet var_name, (mod, RuleD decl)) + +loadBuiltinRules :: [(RdrName, CoreRule)] -> RnMG () +loadBuiltinRules builtin_rules + = getIfacesRn `thenRn` \ ifaces -> + mapRn loadBuiltinRule builtin_rules `thenRn` \ rule_decls -> + setIfacesRn (ifaces { iRules = iRules ifaces `unionBags` listToBag rule_decls }) + +loadBuiltinRule (var, rule) + = lookupOrigName var `thenRn` \ var_name -> + returnRn (unitNameSet var_name, (nameModule var_name, RuleD (IfaceRuleOut var rule))) + + +----------------------------------------------------- +-- Loading Deprecations +----------------------------------------------------- + +loadDeprec :: Module -> DeprecationEnv -> RdrNameDeprecation -> RnM d DeprecationEnv +loadDeprec mod deprec_env (Deprecation (IEModuleContents _) txt _) + = traceRn (text "module deprecation not yet implemented:" <+> ppr mod <> colon <+> ppr txt) `thenRn_` + -- SUP: TEMPORARY HACK, ignoring module deprecations for now + returnRn deprec_env + +loadDeprec mod deprec_env (Deprecation ie txt _) + = setModuleRn mod $ + mapRn lookupOrigName (ieNames ie) `thenRn` \ names -> + traceRn (text "loaded deprecation(s) for" <+> hcat (punctuate comma (map ppr names)) <> colon <+> ppr txt) `thenRn_` + returnRn (extendNameEnvList deprec_env (zip names (repeat txt))) \end{code} %******************************************************** %* * -\subsection{Loading usage information} +\subsection{Checking usage information} %* * %******************************************************** \begin{code} -checkUpToDate :: Module -> RnMG Bool -- True <=> no need to recompile -checkUpToDate mod_name - = findAndReadIface doc_str mod_name `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 mod_name]) `thenRn_` - returnRn False - - Just (_, ParsedIface _ usages _ _ _ _) - -> -- Found it, so now check it - checkModUsage usages - where - -- Only look in current directory, with suffix .hi - doc_str = sep [ptext SLIT("need usage info from"), pprModule mod_name] - -checkModUsage [] = returnRn True -- Yes! Everything is up to date! - -checkModUsage ((mod, old_mod_vers, whats_imported) : rest) - = loadInterface doc_str mod `thenRn` \ (mod, ifaces) -> +upToDate = True +outOfDate = False + +checkModUsage :: [ImportVersion OccName] -> RnMG Bool +-- Given the usage information extracted from the old +-- M.hi file for the module being compiled, figure out +-- whether M needs to be recompiled. + +checkModUsage [] = returnRn upToDate -- Yes! Everything is up to date! + +checkModUsage ((mod_name, _, _, NothingAtAll) : rest) + -- If CurrentModule.hi contains + -- import Foo :: ; + -- then that simply records that Foo lies below CurrentModule in the + -- hierarchy, but CurrentModule doesn't depend in any way on Foo. + -- In this case we don't even want to open Foo's interface. + = traceRn (ptext SLIT("Nothing used from:") <+> ppr mod_name) `thenRn_` + checkModUsage rest -- This one's ok, so check the rest + +checkModUsage ((mod_name, _, _, whats_imported) : rest) + = tryLoadInterface doc_str mod_name ImportBySystem `thenRn` \ (ifaces, maybe_err) -> + case maybe_err of { + Just err -> out_of_date (sep [ptext SLIT("Can't find version number for module"), + ppr mod_name]) ; + -- Couldn't find or parse a module mentioned in the + -- old interface file. Don't complain -- it might just be that + -- the current module doesn't need that import and it's been deleted + + Nothing -> let - maybe_new_mod_vers = lookupFM (iModMap ifaces) mod - Just (_, new_mod_vers, _) = maybe_new_mod_vers + (_, new_mod_vers, new_fix_vers, new_rule_vers, _, _) + = case lookupFM (iImpModInfo ifaces) mod_name of + Just (_, _, Just stuff) -> stuff + + old_mod_vers = case whats_imported of + Everything v -> v + Specifically v _ _ _ -> v + -- NothingAtAll case dealt with by previous eqn for checkModUsage 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 - traceRn (sep [ptext SLIT("Can't find version number for module"), pprModule mod]) `thenRn_` - returnRn False - else - -- If the module version hasn't changed, just move on if new_mod_vers == old_mod_vers then - traceRn (sep [ptext SLIT("Module version unchanged:"), pprModule mod]) `thenRn_` - checkModUsage rest + traceRn (sep [ptext SLIT("Module version unchanged:"), ppr mod_name]) + `thenRn_` checkModUsage rest else - traceRn (sep [ptext SLIT("Module version has changed:"), pprModule mod]) `thenRn_` - + traceRn (sep [ptext SLIT("Module version has changed:"), ppr mod_name]) + `thenRn_` -- Module version changed, so check entities inside -- 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 + case whats_imported of { -- NothingAtAll dealt with earlier + + Everything _ + -> out_of_date (ptext SLIT("...and I needed the whole module")) ; - Specifically old_local_vers -> + Specifically _ old_fix_vers old_rule_vers old_local_vers -> + if old_fix_vers /= new_fix_vers then + out_of_date (ptext SLIT("Fixities changed")) + else if old_rule_vers /= new_rule_vers then + out_of_date (ptext SLIT("Rules changed")) + else -- Non-empty usage list, so check item by item - checkEntityUsage mod (iDecls ifaces) old_local_vers `thenRn` \ up_to_date -> + 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 - } + returnRn outOfDate -- This one failed, so just bail out now + }} where - doc_str = sep [ptext SLIT("need version info for"), pprModule mod] + doc_str = sep [ptext SLIT("need version info for"), ppr mod_name] checkEntityUsage mod decls [] - = returnRn True -- Yes! All up to date! + = returnRn upToDate -- Yes! All up to date! checkEntityUsage mod decls ((occ_name,old_vers) : rest) - = newImportedGlobalName mod occ_name `thenRn` \ name -> + = newGlobalName 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 + out_of_date (sep [ptext SLIT("No longer exported:"), ppr name]) Just (new_vers,_,_,_) -- It's there, but is it up to date? | new_vers == old_vers @@ -466,8 +584,9 @@ checkEntityUsage mod decls ((occ_name,old_vers) : rest) | otherwise -- Out of date, so bale out - -> putDocRn (sep [ptext SLIT("Out of date:"), ppr name]) `thenRn_` - returnRn False + -> out_of_date (sep [ptext SLIT("Out of date:"), ppr name]) + +out_of_date msg = traceRn msg `thenRn_` returnRn outOfDate \end{code} @@ -478,167 +597,121 @@ checkEntityUsage mod decls ((occ_name,old_vers) : rest) %********************************************************* \begin{code} -importDecl :: Occurrence -> RnMode -> RnMG (Maybe RdrNameHsDecl) - -- Returns Nothing for a wired-in or already-slurped decl - -importDecl (name, loc) mode - = checkSlurped name `thenRn` \ already_slurped -> - if already_slurped then --- traceRn (sep [text "Already slurped:", ppr name]) `thenRn_` - returnRn Nothing -- Already dealt with - else - if isWiredInName name then - getWiredInDecl name mode - else - getIfacesRn `thenRn` \ ifaces -> - let - mod = nameModule name - in - if mod == iMod ifaces then -- Don't bring in decls from - addWarnRn (importDeclWarn mod name loc) `thenRn_` --- pprTrace "importDecl wierdness:" (ppr name) $ - returnRn Nothing -- the renamed module's own interface file - -- - else - getNonWiredInDecl name loc mode -\end{code} +importDecl :: Name -> RnMG ImportDeclResult + +data ImportDeclResult + = AlreadySlurped + | WiredIn + | Deferred + | HereItIs (Module, RdrNameHsDecl) + +importDecl name + = getIfacesRn `thenRn` \ ifaces -> + getHomeSymbolTableRn `thenRn` \ hst -> + if name `elemNameSet` iSlurp ifaces + || inTypeEnv (iPST ifaces) name + || inTypeEnv hst name + then -- Already dealt with + returnRn AlreadySlurped + + else if isLocallyDefined name then -- Don't bring in decls from + -- the renamed module's own interface file + addWarnRn (importDeclWarn name) `thenRn_` + returnRn AlreadySlurped + + else if isWiredInName name then + -- When we find a wired-in name we must load its + -- home module so that we find any instance decls therein + loadHomeInterface doc name `thenRn_` + returnRn WiredIn + + else getNonWiredInDecl name + where + doc = ptext SLIT("need home module for wired in thing") <+> ppr name -\begin{code} -getNonWiredInDecl :: Name -> SrcLoc -> RnMode -> RnMG (Maybe RdrNameHsDecl) -getNonWiredInDecl needed_name loc mode +getNonWiredInDecl :: Name -> RnMG ImportDeclResult +getNonWiredInDecl needed_name = traceRn doc_str `thenRn_` - loadHomeInterface doc_str needed_name `thenRn` \ (_, ifaces) -> + loadHomeInterface doc_str needed_name `thenRn` \ ifaces -> case lookupNameEnv (iDecls ifaces) needed_name of - -- Special case for data/newtype type declarations - Just (version, avail, TyClD tycl_decl, _) | isDataDecl tycl_decl - -> getNonWiredDataDecl needed_name version avail tycl_decl `thenRn` \ (avail', maybe_decl) -> - recordSlurp (Just version) necessity avail' `thenRn_` - returnRn maybe_decl - - Just (version,avail,decl,_) - -> recordSlurp (Just version) necessity avail `thenRn_` - returnRn (Just decl) - - Nothing -> -- Can happen legitimately for "Optional" occurrences - case necessity of { - Optional -> addWarnRn (getDeclWarn needed_name loc); - other -> addErrRn (getDeclErr needed_name loc) - } `thenRn_` - returnRn Nothing + Just (version, avail, is_tycon_name, decl@(_, TyClD (TyData DataType _ _ _ _ ncons _ _ _ _ _))) + -- This case deals with deferred import of algebraic data types + + | not opt_NoPruneTyDecls + + && (opt_IgnoreIfacePragmas || ncons > 1) + -- We only defer if imported interface pragmas are ingored + -- or if it's not a product type. + -- Sole reason: The wrapper for a strict function may need to look + -- inside its arg, and hence need to see its arg type's constructors. + + && not (getUnique tycon_name `elem` cCallishTyKeys) + -- Never defer ccall types; we have to unbox them, + -- and importing them does no harm + + -> -- OK, so we're importing a deferrable data type + if needed_name == tycon_name then + -- The needed_name is the TyCon of a data type decl + -- Record that it's slurped, put it in the deferred set + -- and don't return a declaration at all + setIfacesRn (recordSlurp (ifaces {iDeferred = iDeferred ifaces + `addOneToNameSet` tycon_name}) + version (AvailTC needed_name [needed_name])) `thenRn_` + returnRn Deferred + else + -- The needed name is a constructor of a data type decl, + -- getting a constructor, so remove the TyCon from the deferred set + -- (if it's there) and return the full declaration + setIfacesRn (recordSlurp (ifaces {iDeferred = iDeferred ifaces + `delFromNameSet` tycon_name}) + version avail) `thenRn_` + returnRn (HereItIs decl) + where + tycon_name = availName avail + + Just (version,avail,_,decl) + -> setIfacesRn (recordSlurp ifaces version avail) `thenRn_` + returnRn (HereItIs decl) + + Nothing + -> addErrRn (getDeclErr needed_name) `thenRn_` + returnRn AlreadySlurped where - necessity = modeToNecessity mode - doc_str = sep [ptext SLIT("need decl for"), ppr needed_name, ptext SLIT("needed at"), ppr loc] + doc_str = ptext SLIT("need decl for") <+> ppr needed_name + +getDeferredDecls :: RnMG [(Module, RdrNameHsDecl)] +getDeferredDecls + = getIfacesRn `thenRn` \ ifaces -> + let + decls_map = iDecls ifaces + deferred_names = nameSetToList (iDeferred ifaces) + get_abstract_decl n = case lookupNameEnv decls_map n of + Just (_, _, _, decl) -> decl + in + traceRn (sep [text "getDeferredDecls", nest 4 (fsep (map ppr deferred_names))]) `thenRn_` + returnRn (map get_abstract_decl deferred_names) \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 mode - = setModuleRn mod_name ( - initRnMS emptyRnEnv new_mode get_wired - ) `thenRn` \ avail -> - recordSlurp Nothing necessity 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 = nameModule main_name - doc_str = sep [ptext SLIT("need home module for wired in thing"), ppr name] - in - (if not main_is_tc || mod == pREL_GHC then - returnRn () - else - loadHomeInterface doc_str main_name `thenRn_` - returnRn () - ) `thenRn_` - - returnRn Nothing -- No declaration to process further - where - necessity = modeToNecessity mode - new_mode = case mode of - InterfaceMode _ -> mode - SourceMode -> vanillaInterfaceMode - - get_wired | is_tycon -- ... a type constructor - = get_wired_tycon the_tycon - - | maybeToBool maybe_data_con -- ... a wired-in data constructor - = get_wired_tycon (dataConTyCon data_con) - - | otherwise -- ... a wired-in non data-constructor - = get_wired_id the_id - - mod_name = nameModule name - 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 - maybe_data_con = isDataConId_maybe the_id - Just data_con = maybe_data_con - - -get_wired_id id - = addImplicitOccsRn id_mentions `thenRn_` - returnRn (Avail (getName id)) - where - id_mentions = nameSetToList (namesOfType ty) - ty = 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 . dataConType) emptyNameSet data_cons -\end{code} @@ -648,109 +721,26 @@ get_wired_tycon tycon %* * %********************************************************* -\begin{code} -getInterfaceExports :: Module -> RnMG (Module, Avails) -getInterfaceExports mod - = loadInterface doc_str mod `thenRn` \ (mod, ifaces) -> - case lookupFM (iModMap ifaces) 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 (mod, []) - - Just (_, _, avails) -> returnRn (mod, avails) - where - doc_str = sep [pprModule mod, ptext SLIT("is directly imported")] -\end{code} - - -%********************************************************* -%* * -\subsection{Data type 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. +@getInterfaceExports@ is called only for directly-imported modules. \begin{code} -getNonWiredDataDecl needed_name - version - avail@(AvailTC tycon_name _) - ty_decl@(TyData new_or_data context tycon tyvars condecls derivings pragmas src_loc) - | null condecls || - -- HACK ALERT! If the data type is abstract then it must from a - -- hand-written hi-boot file. We put it in the deferred pile unconditionally, - -- because we don't want to read it in, and then later find a decl for a constructor - -- from that type, read the real interface file, and read in the full data type - -- decl again!!! - - (needed_name == tycon_name - && opt_PruneTyDecls - -- don't prune newtypes, as the code generator may - -- want to peer inside a newtype type constructor - -- (ClosureInfo.fun_result_ty is the culprit.) - && not (new_or_data == NewType) - && 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 - deferred_data_decls = iDefData ifaces - new_ifaces = ifaces {iDefData = new_deferred_data_decls} - - no_constr_ty_decl = TyData new_or_data [] tycon tyvars [] derivings pragmas src_loc - new_deferred_data_decls = addToNameEnv deferred_data_decls tycon_name - (nameModule 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 - deferred_data_decls = iDefData ifaces - new_ifaces = ifaces {iDefData = new_deferred_data_decls} +getInterfaceExports :: ModuleName -> WhereFrom -> RnMG (Module, Avails) +getInterfaceExports mod_name from + = getHomeSymbolTableRn `thenRn` \ hst -> + case lookupModuleEnvByName hst mod_name of { + Just mds -> returnRn (mdModule mds, mdExports mds) ; + Nothing -> pprPanic "getInterfaceExports" (ppr mod_name) + +-- I think this is what it _used_ to say. JRS, 001017 +-- loadInterface doc_str mod_name from `thenRn` \ ifaces -> +-- case lookupModuleEnv (iPST ifaces) mod_name of +-- Just mds -> returnRn (mdModule mod, mdExports mds) +-- -- loadInterface always puts something in the map +-- -- even if it's a fake - new_deferred_data_decls = delFromNameEnv deferred_data_decls tycon_name - in - setIfacesRn new_ifaces `thenRn_` - returnRn (avail, Just (TyClD ty_decl)) -\end{code} - -\begin{code} -getDeferredDataDecls :: RnMG [(Module, RdrNameTyClDecl)] -getDeferredDataDecls - = getIfacesRn `thenRn` \ ifaces -> - let - deferred_list = nameEnvElts (iDefData ifaces) - trace_msg = hang (text "Slurping abstract data/newtype decls for: ") - 4 (ppr (map fst deferred_list)) - in - traceRn trace_msg `thenRn_` - returnRn deferred_list + } + where + doc_str = sep [ppr mod_name, ptext SLIT("is directly imported")] \end{code} @@ -761,74 +751,95 @@ getDeferredDataDecls %********************************************************* \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_` +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 + orphan_mods = + [mod | (mod, (True, _, Nothing)) <- fmToList (iImpModInfo ifaces)] + in + 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 - (insts, tycls_names) = iDefInsts 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) - | isEmptyNameSet remaining_gates - = (decl : ungated_decls, gated_decls) - | otherwise - = (ungated_decls, (decl, remaining_gates) : gated_decls) - where - remaining_gates = gates `minusNameSet` tycls_names - - (un_gated_insts, still_gated_insts) = foldrBag select_ungated ([], []) insts - - new_ifaces = ifaces {iDefInsts = (listToBag still_gated_insts, tycls_names)} - -- NB: don't throw away tycls_names; - -- we may comre across more instance decls + (decls, new_insts) = selectGated gates (iInsts ifaces) in - traceRn (sep [text "getInstDecls:", fsep (map ppr (nameSetToList tycls_names))]) `thenRn_` - setIfacesRn new_ifaces `thenRn_` - returnRn un_gated_insts - where - load_it mod = loadInterface (doc_str mod) mod - doc_str mod = sep [pprModule mod, ptext SLIT("is a special-instance module")] + setIfacesRn (ifaces { iInsts = new_insts }) `thenRn_` + 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 -getSpecialInstModules :: RnMG [Module] -getSpecialInstModules - = getIfacesRn `thenRn` \ ifaces -> - returnRn (iInstMods ifaces) +ppr_brief_inst_decl (mod, InstD (InstDecl inst_ty _ _ _ _)) + = case inst_ty of + HsForAllTy _ _ tau -> ppr tau + other -> ppr inst_ty -getImportedFixities :: GlobalRdrEnv -> RnMG FixityEnv - -- Get all imported fixities - -- We first make sure that all the home modules - -- of all in-scope variables are loaded. -getImportedFixities gbl_env - = let - home_modules = [ nameModule name | names <- rdrEnvElts gbl_env, - name <- names, - not (isLocallyDefined name) - ] +getImportedRules :: RnMG [(Module,RdrNameHsDecl)] +getImportedRules + | opt_IgnoreIfacePragmas = returnRn [] + | otherwise + = getIfacesRn `thenRn` \ ifaces -> + let + gates = iSlurp ifaces -- Anything at all that's been slurped + rules = iRules ifaces + (decls, new_rules) = selectGated gates rules in - mapRn load (nub home_modules) `thenRn_` + if null decls then + returnRn [] + else + setIfacesRn (ifaces { iRules = new_rules }) `thenRn_` + traceRn (sep [text "getImportedRules:", + text "Slurped" <+> int (length decls) <+> text "rules"]) `thenRn_` + returnRn decls - -- Now we can snaffle the fixity env - getIfacesRn `thenRn` \ ifaces -> - returnRn (iFixes ifaces) +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 - load mod = loadInterface doc_str mod - where - doc_str = ptext SLIT("Need fixities from") <+> ppr mod + select (reqd, decl) (yes, no) + | isEmptyNameSet (reqd `minusNameSet` gates) = (decl:yes, no) + | otherwise = (yes, (reqd,decl) `consBag` no) + +lookupFixityRn :: Name -> RnMS Fixity +lookupFixityRn name + | isLocallyDefined name + = getFixityEnv `thenRn` \ local_fix_env -> + returnRn (lookupLocalFixity local_fix_env name) + + | otherwise -- Imported + -- For imported names, we have to get their fixities by doing a loadHomeInterface, + -- and consulting the Ifaces that comes back from that, because the interface + -- file for the Name might not have been loaded yet. Why not? Suppose you import module A, + -- which exports a function 'f', which is defined in module B. Then B isn't loaded + -- right away (after all, it's possible that nothing from B will be used). + -- When we come across a use of 'f', we need to know its fixity, and it's then, + -- and only then, that we load B.hi. That is what's happening here. + = getHomeSymbolTableRn `thenRn` \ hst -> + case lookupFixityEnv hst name of { + Just fixity -> returnRn fixity ; + Nothing -> + + loadHomeInterface doc name `thenRn` \ ifaces -> + returnRn (lookupFixityEnv (iPST ifaces) name `orElse` defaultFixity) + } + where + doc = ptext SLIT("Checking fixity for") <+> ppr name \end{code} @@ -838,127 +849,197 @@ getImportedFixities gbl_env %* * %********************************************************* -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: + +\begin{itemize} +\item (a) anything reachable from its body code +\item (b) any module exported with a @module Foo@ +\item (c) anything reachable from an exported item +\end{itemize} -Why the latter? Because if Foo changes then this module's export list +Why (b)? 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. +Why (c)? Consider this: +\begin{verbatim} + module A( f, g ) where | module B( f ) where + import B( f ) | f = h 3 + g = ... | h = ... +\end{verbatim} + +Here, @B.f@ isn't used in A. Should we nevertheless record @B.f@ in +@A@'s usages? Our idea is that we aren't going to touch A.hi if it is +*identical* to what it was before. If anything about @B.f@ changes +than anyone who imports @A@ should be recompiled in case they use +@B.f@ (they'll get an early exit if they don't). So, if anything +about @B.f@ changes we'd better make sure that something in A.hi +changes, and the convenient way to do that is to record the version +number @B.f@ in A.hi in the usage list. If B.f changes that'll force a +complete recompiation of A, which is overkill but it's the only way to +write a new, slightly different, A.hi. + +But the example is tricker. 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. But with -O, a module that imports A must be recompiled if +@B.h@ changes! So A must record a dependency on @B.h@. So we treat +the occurrence of @B.f@ in the export list *just as if* it were in the +code of A, and thereby haul in all the stuff reachable from it. + +[NB: If B was compiled with -O, but A isn't, we should really *still* +haul in all the unfoldings for B, in case the module that imports A *is* +compiled with -O. I think this is the case.] + +Even if B is used at all we get a usage line for B + 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 - -> RnMG (VersionInfo Name) -- Version info for these names - -getImportVersions this_mod exports +mkImportExportInfo :: ModuleName -- Name of this module + -> Avails -- Info about exports + -> Maybe [RdrNameIE] -- The export header + -> RnMG ([ExportItem], -- Export info for iface file; sorted + [ImportVersion OccName]) -- Import info for iface file; sorted + -- Both results are sorted into canonical order to + -- reduce needless wobbling of interface files + +mkImportExportInfo this_mod export_avails exports = getIfacesRn `thenRn` \ ifaces -> let - mod_map = iModMap ifaces - imp_names = iVSlurp ifaces + export_all_mods = case exports of + Nothing -> [] + Just es -> [mod | IEModuleContents mod <- es, + mod /= this_mod] - -- mv_map groups together all the things imported from a particular module. - mv_map, mv_map_mod :: FiniteMap Module (WhatsImported Name) + mod_map = iImpModInfo ifaces + imp_names = iVSlurp ifaces - 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 with an "Everything" + -- mv_map groups together all the things imported from a particular module. + mv_map :: FiniteMap ModuleName [(OccName,Version)] + mv_map = foldr add_mv emptyFM imp_names - mv_map = foldl add_mv mv_map_mod imp_names - -- mv_map adds the version numbers of things exported individually + add_mv (name, version) mv_map = addItem mv_map (moduleName (nameModule name)) + (nameOccName name, version) - mk_version_info (mod, local_versions) - = case lookupFM mod_map mod of - Just (hif, version, _) -> (mod, version, local_versions) + -- 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_imp_info mod_name (has_orphans, is_boot, contents) so_far + | mod_name == this_mod -- Check if M appears in the set of modules 'below' M + -- This seems like a convenient place to check + = WARN( not is_boot, ptext SLIT("Wierd:") <+> ppr this_mod <+> + ptext SLIT("imports itself (perhaps indirectly)") ) + so_far + + | otherwise + = let + go_for_it exports = (mod_name, has_orphans, is_boot, exports) + : so_far + in + case contents of + Nothing -> -- We didn't even open the interface + -- This happens when a module, Foo, that we explicitly imported has + -- 'import Baz' in its interface file, recording that Baz is below + -- Foo in the module dependency hierarchy. We want to propagate this + -- information. The Nothing says that we didn't even open the interface + -- file but we must still propagate the dependeny info. + -- The module in question must be a local module (in the same package) + go_for_it NothingAtAll + + Just (mod, mod_vers, fix_vers, rule_vers, how_imported, _) + | is_sys_import && is_lib_module && not has_orphans + -> so_far + + | is_lib_module -- Record the module but not detailed + || mod_name `elem` export_all_mods -- version information for the imports + -> go_for_it (Everything mod_vers) + + | otherwise + -> case lookupFM mv_map mod_name of + Just whats_imported -> go_for_it (Specifically mod_vers fix_vers rule_vers + (sortImport whats_imported)) + Nothing -> go_for_it NothingAtAll + -- This happens if you have + -- import Foo + -- but don't actually *use* anything from Foo + -- In which case record an empty dependency list + where + is_lib_module = not (isModuleInThisPackage mod) + is_sys_import = case how_imported of + ImportBySystem -> True + other -> False + + + import_info = foldFM mk_imp_info [] mod_map + + -- Sort exports into groups by module + export_fm :: FiniteMap ModuleName [RdrAvailInfo] + export_fm = foldr insert emptyFM export_avails + + insert avail efm = addItem efm (moduleName (nameModule (availName avail))) + (rdrAvailInfo avail) + + export_info = [(m, sortExport as) | (m,as) <- fmToList export_fm] in - returnRn (map mk_version_info (fmToList mv_map)) - where - export_mods = case exports of - Nothing -> [] - Just es -> [mod | IEModuleContents mod <- es, mod /= this_mod] + traceRn (text "Modules in Ifaces: " <+> fsep (map ppr (keysFM mod_map))) `thenRn_` + returnRn (export_info, import_info) - add_mv mv_map v@(name, version) - = addToFM_C add_item mv_map mod (Specifically [v]) - where - mod = nameModule name - add_item Everything _ = Everything - add_item (Specifically xs) _ = Specifically (v:xs) +addItem :: FiniteMap ModuleName [a] -> ModuleName -> a -> FiniteMap ModuleName [a] +addItem fm mod x = addToFM_C add_item fm mod [x] + where + add_item xs _ = x:xs + +sortImport :: [(OccName,Version)] -> [(OccName,Version)] + -- Make the usage lists appear in canonical order +sortImport vs = sortLt lt vs + where + lt (n1,v1) (n2,v2) = n1 < n2 - add_mod mv_map mod = addToFM mv_map mod Everything +sortExport :: [RdrAvailInfo] -> [RdrAvailInfo] +sortExport as = sortLt lt as + where + lt a1 a2 = availName a1 < availName a2 \end{code} \begin{code} -checkSlurped name - = getIfacesRn `thenRn` \ ifaces -> - returnRn (name `elemNameSet` iSlurp ifaces) - -getSlurpedNames :: RnMG NameSet -getSlurpedNames +getSlurped = getIfacesRn `thenRn` \ ifaces -> returnRn (iSlurp ifaces) -recordSlurp maybe_version necessity avail - = {- traceRn (hsep [text "Record slurp:", pprAvail avail, - -- NB PprForDebug prints export flag, which is too - -- strict; it's a knot-tied thing in RnNames - case necessity of {Compulsory -> text "comp"; Optional -> text "opt" } ]) `thenRn_` - -} - getIfacesRn `thenRn` \ ifaces -> - let - Ifaces { iSlurp = slurped_names, - iVSlurp = imp_names, - iDefInsts = (insts, tycls_names) } = ifaces - +recordSlurp ifaces@(Ifaces { iSlurp = slurped_names, iVSlurp = imp_names }) + version avail + = let new_slurped_names = addAvailToNameSet slurped_names avail + new_imp_names = (availName avail, version) : imp_names + in + ifaces { iSlurp = new_slurped_names, iVSlurp = new_imp_names } - new_imp_names = case maybe_version of - Just version -> (availName avail, version) : imp_names - Nothing -> imp_names - - -- Add to the names that will let in instance declarations; - -- but only (a) if it's a type/class - -- (b) if it's compulsory (unless the test flag opt_PruneInstDecls is off) - new_tycls_names = case avail of - AvailTC tc _ | not opt_PruneInstDecls || - case necessity of {Optional -> False; Compulsory -> True } - -> tycls_names `addOneToNameSet` tc - otherwise -> tycls_names - - new_ifaces = ifaces { iSlurp = new_slurped_names, - iVSlurp = new_imp_names, - iDefInsts = (insts, new_tycls_names) } +recordLocalSlurps local_avails + = getIfacesRn `thenRn` \ ifaces -> + let + new_slurped_names = foldl addAvailToNameSet (iSlurp ifaces) local_avails in - setIfacesRn new_ifaces + setIfacesRn (ifaces { iSlurp = new_slurped_names }) \end{code} @@ -972,15 +1053,15 @@ recordSlurp maybe_version necessity 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 (Maybe AvailInfo) + -> RnM d (Maybe AvailInfo) -getDeclBinders new_name (TyClD (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 (Just (AvailTC tycon_name (tycon_name : nub sub_names))) @@ -991,15 +1072,15 @@ getDeclBinders new_name (TyClD (TySynonym tycon _ _ src_loc)) = new_name tycon src_loc `thenRn` \ tycon_name -> returnRn (Just (AvailTC tycon_name [tycon_name])) -getDeclBinders new_name (TyClD (ClassDecl _ cname _ sigs _ _ tname dname src_loc)) +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 - -- ignoring fixity declarations - nonfix_sigs = nonFixitySigs sigs + -- just want class-op sigs + op_sigs = filter isClassOpSig sigs in - mapRn (getClassOpNames new_name) nonfix_sigs `thenRn` \ sub_names -> + mapRn (getClassOpNames new_name) op_sigs `thenRn` \ sub_names -> returnRn (Just (AvailTC class_name (class_name : sub_names))) @@ -1007,28 +1088,39 @@ 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 (FixD _) = returnRn Nothing +getDeclBinders new_name (DeprecD _) = returnRn Nothing + + -- 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 + = lookupOrigName 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 = isDynamicExtName 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 _ _ condecl 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 (nn ++ ns) + returnRn (n : ns) getConFieldNames new_name [] = returnRn [] @@ -1037,14 +1129,20 @@ getClassOpNames new_name (ClassOpSig op _ _ src_loc) = new_name op src_loc @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. +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 src_loc)) - = new_name dname src_loc `thenRn` \ datacon_name -> - new_name tname src_loc `thenRn` \ tycon_name -> - returnRn [tycon_name, datacon_name] +getDeclSysBinders new_name (TyClD (ClassDecl _ cname _ _ sigs _ _ names + src_loc)) + = sequenceRn [new_name n src_loc | n <- names] + +getDeclSysBinders new_name (TyClD (TyData _ _ _ _ cons _ _ _ _ _ _)) + = sequenceRn [new_name wkr_name src_loc | ConDecl _ wkr_name _ _ _ src_loc <- cons] getDeclSysBinders new_name other_decl = returnRn [] @@ -1057,100 +1155,73 @@ getDeclSysBinders new_name other_decl %********************************************************* \begin{code} -findAndReadIface :: SDoc -> Module -> RnMG (Maybe (Module, ParsedIface)) +findAndReadIface :: SDoc -> ModuleName + -> IsBootInterface -- True <=> Look for a .hi-boot file + -- False <=> Look for .hi file + -> RnM d (Either Message (Module, ParsedIface)) -- Nothing <=> file not found, or unreadable, or illegible -- Just x <=> successfully found and parsed -findAndReadIface doc_str mod_name +findAndReadIface doc_str mod_name hi_boot_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. - getModuleHiMap from_hi_boot `thenRn` \ himap -> - case (lookupFM himap (moduleUserString mod_name)) of - -- Found the file - Just fpath -> readIface mod_name fpath - Nothing -> traceRn (ptext SLIT("...failed")) `thenRn_` - returnRn Nothing - where - hif = moduleIfaceFlavour mod_name - from_hi_boot = bootFlavour hif + getFinderRn `thenRn` \ finder -> + ioToRn (findModule finder mod_name) `thenRn` \ maybe_module -> + + case maybe_module of + Just mod | hi_boot_file, Just fpath <- moduleHiBootFile mod + -> readIface mod fpath + | not hi_boot_file, Just fpath <- moduleHiFile mod + -> readIface mod fpath + + -- Can't find it + other -> traceRn (ptext SLIT("...not found")) `thenRn_` + returnRn (Left (noIfaceErr finder mod_name hi_boot_file)) + + where trace_msg = sep [hsep [ptext SLIT("Reading"), - if from_hi_boot then ptext SLIT("[boot]") else empty, + if hi_boot_file then ptext SLIT("[boot]") else empty, ptext SLIT("interface for"), - pprModule mod_name <> semi], + ppr mod_name <> semi], nest 4 (ptext SLIT("reason:") <+> doc_str)] \end{code} @readIface@ tries just the one file. \begin{code} -readIface :: Module -> (String, Bool) -> RnMG (Maybe (Module, ParsedIface)) +readIface :: Module -> String -> RnM d (Either Message (Module, ParsedIface)) -- Nothing <=> file not found, or unreadable, or illegible -- Just x <=> successfully found and parsed -readIface requested_mod (file_path, is_dll) - = ioToRnMG (hGetStringBuffer file_path) `thenRn` \ read_result -> +readIface wanted_mod file_path + = traceRn (ptext SLIT("...reading from") <+> text file_path) `thenRn_` + ioToRnM (hGetStringBuffer False file_path) `thenRn` \ read_result -> case read_result of Right contents -> - case parseIface contents (mkSrcLoc (mkFastString file_path) 1) of - Failed err -> failWithRn Nothing err - Succeeded (PIface mod_nm iface) -> - (if mod_nm /= moduleFS requested_mod then - addWarnRn (hsep [ ptext SLIT("Something is amiss; requested module name") - , pprModule requested_mod - , ptext SLIT("differs from name found in the interface file ") - , pprEncodedFS mod_nm - ]) - else - returnRn ()) `thenRn_` - let - the_mod - | is_dll = mkDynamicModule requested_mod - | otherwise = requested_mod - in - if opt_D_show_rn_imports then - putDocRn (hcat[ptext SLIT("Read module "), pprEncodedFS mod_nm, - ptext SLIT(" from "), text file_path]) `thenRn_` - returnRn (Just (the_mod, iface)) - else - returnRn (Just (the_mod, iface)) - - Left err - | isDoesNotExistError err -> returnRn Nothing - | otherwise -> failWithRn Nothing (cannaeReadFile file_path err) - -\end{code} - -%********************************************************* -%* * -\subsection{Utils} -%* * -%********************************************************* - -@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")] -- ToDo: default should be to look in - -- the directory the module we're compiling - -- lives. -mkSearchPath (Just s) = go s + case parseIface contents + PState{ bol = 0#, atbol = 1#, + context = [], + glasgow_exts = 1#, + loc = mkSrcLoc (mkFastString file_path) 1 } of + POk _ (PIface iface) -> + warnCheckRn (moduleName wanted_mod == read_mod) + (hiModuleNameMismatchWarn wanted_mod read_mod) `thenRn_` + returnRn (Right (mod, iface)) + where + read_mod = moduleName (pi_mod iface) + + PFailed err -> bale_out err + parse_result -> bale_out empty + -- This last case can happen if the interface file is (say) empty + -- in which case the parser thinks it looks like an IdInfo or + -- something like that. Just an artefact of the fact that the + -- parser is used for several purposes at once. + + Left io_err -> bale_out (text (show io_err)) where - go "" = [] - go s = - case span (/= '%') s of - (dir,'%':rs) -> - case span (/= ':') rs of - (hisuf,_:rest) -> (dir,hisuf):go rest - (hisuf,[]) -> [(dir,hisuf)] + bale_out err = returnRn (Left (badIfaceFile file_path err)) \end{code} %********************************************************* @@ -1160,30 +1231,46 @@ mkSearchPath (Just s) = go s %********************************************************* \begin{code} -noIfaceErr filename - = hcat [ptext SLIT("Could not find valid interface file "), - quotes (pprModule filename)] - -cannaeReadFile file err - = hcat [ptext SLIT("Failed in reading file: "), - text file, - ptext SLIT("; error="), - text (show err)] - -getDeclErr name loc - = sep [ptext SLIT("Failed to find interface decl for") <+> quotes (ppr name), - ptext SLIT("needed at") <+> ppr loc] - -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 loc - = 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.)") +noIfaceErr mod_name boot_file search_path + = vcat [ptext SLIT("Could not find interface file for") <+> quotes (ppr mod_name), + ptext SLIT("in the directories") <+> + -- \& to avoid cpp interpreting this string as a + -- comment starter with a pre-4.06 mkdependHS --SDM + vcat [ text dir <> text "/\&*" <> pp_suffix suffix + | (dir,suffix) <- search_path] + ] + where + pp_suffix suffix | boot_file = ptext SLIT(".hi-boot") + | otherwise = text suffix + +badIfaceFile file err + = vcat [ptext SLIT("Bad interface file:") <+> text file, + nest 4 err] + +getDeclErr name + = vcat [ptext SLIT("Failed to find interface decl for") <+> quotes (ppr name), + ptext SLIT("from module") <+> quotes (ppr (nameModule name)) + ] + +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("Interface:"), quotes (pprModule mod), comma, ptext SLIT("name:"), quotes (ppr name), - comma, ptext SLIT("desired at:"), ppr loc - ] + hsep [ptext SLIT("name:"), quotes (ppr name)] + +warnRedundantSourceImport mod_name + = ptext SLIT("Unnecessary {- SOURCE -} in the import of module") + <+> quotes (ppr mod_name) + +hiModuleNameMismatchWarn :: Module -> ModuleName -> Message +hiModuleNameMismatchWarn requested_mod read_mod = + hsep [ ptext SLIT("Something is amiss; requested module name") + , ppr (moduleName requested_mod) + , ptext SLIT("differs from name found in the interface file") + , ppr read_mod + ] \end{code} +#endif /* TEMP DEBUG HACK! */ \ No newline at end of file