X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Fmain%2FMkIface.lhs;h=c5ad766e7ead835a696466d4b49698d8a09a12fe;hb=61de6a58cf88fec88d20e8ee7250a4a519ef6bd9;hp=b6dba207f2b2a22ecc0414d6e5deb733a02c3577;hpb=31e66845603e9bb1229d72e5fbf6222c3a0d46c6;p=ghc-hetmet.git diff --git a/ghc/compiler/main/MkIface.lhs b/ghc/compiler/main/MkIface.lhs index b6dba20..c5ad766 100644 --- a/ghc/compiler/main/MkIface.lhs +++ b/ghc/compiler/main/MkIface.lhs @@ -1,281 +1,380 @@ % % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998 % + \section[MkIface]{Print an interface for a module} \begin{code} -module MkIface ( - startIface, endIface, ifaceDecls - ) where +module MkIface ( + showIface, mkIface, mkUsageInfo, + pprIface, pprUsage, pprUsages, pprExports, + ifaceTyThing, + ) where #include "HsVersions.h" -import IO ( Handle, hPutStr, openFile, - hClose, hPutStrLn, IOMode(..) ) - import HsSyn -import BasicTypes ( Fixity(..), FixityDirection(..), NewOrData(..) ) -import RnMonad -import RnEnv ( availName ) - -import TcInstUtil ( InstInfo(..) ) - -import CmdLineOpts -import Id ( Id, idType, idInfo, omitIfaceSigForId, isUserExportedId, - getIdSpecialisation - ) -import Var ( isId ) -import VarSet -import DataCon ( StrictnessMark(..), dataConSig, dataConFieldLabels, dataConStrictMarks ) -import IdInfo ( IdInfo, StrictnessInfo(..), ArityInfo, InlinePragInfo(..), inlinePragInfo, - arityInfo, ppArityInfo, arityLowerBound, - strictnessInfo, ppStrictnessInfo, isBottomingStrictness, - cafInfo, ppCafInfo, specInfo, - cprInfo, ppCprInfo, pprInlinePragInfo, - occInfo, OccInfo(..), - workerExists, workerInfo, ppWorkerInfo +import HsCore ( HsIdInfo(..), UfExpr(..), toUfExpr, toUfBndr ) +import HsTypes ( toHsTyVars ) +import TysPrim ( alphaTyVars ) +import BasicTypes ( NewOrData(..), Activation(..), FixitySig(..), + Version, initialVersion, bumpVersion ) -import CoreSyn ( CoreExpr, CoreBind, Bind(..), rulesRules, rulesRhsFreeVars ) -import CoreFVs ( exprSomeFreeVars, ruleSomeLhsFreeVars, ruleSomeFreeVars ) -import CoreUnfold ( calcUnfoldingGuidance, okToUnfoldInHiFile, couldBeSmallEnoughToInline ) -import Module ( moduleString, pprModule, pprModuleName ) -import Name ( isLocallyDefined, isWiredInName, nameRdrName, nameModule, - Name, NamedThing(..) +import NewDemand ( isTopSig ) +import TcRnMonad +import RnHsSyn ( RenamedInstDecl, RenamedTyClDecl ) +import HscTypes ( VersionInfo(..), ModIface(..), HomeModInfo(..), + ModGuts(..), ModGuts, + GhciMode(..), HscEnv(..), + FixityEnv, lookupFixity, collectFixities, + IfaceDecls, mkIfaceDecls, dcl_tycl, dcl_rules, dcl_insts, + TyThing(..), DFunId, + Avails, AvailInfo, GenAvailInfo(..), availName, + ExternalPackageState(..), + WhatsImported(..), ParsedIface(..), + ImportVersion, Deprecations(..), initialVersionInfo, + lookupVersion ) + +import CmdLineOpts +import Id ( idType, idInfo, isImplicitId, idCgInfo ) +import DataCon ( dataConSig, dataConFieldLabels, dataConStrictMarks ) +import IdInfo -- Lots +import CoreSyn ( CoreRule(..), IdCoreRule ) +import CoreFVs ( ruleLhsFreeNames ) +import CoreUnfold ( neverUnfold, unfoldingTemplate ) +import Name ( getName, nameModule, nameModule_maybe, nameOccName, + nameIsLocalOrFrom, Name, NamedThing(..) ) +import NameEnv +import NameSet import OccName ( OccName, pprOccName ) -import TyCon ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon, - tyConTheta, tyConTyVars, tyConDataCons +import TyCon ( DataConDetails(..), tyConTyVars, tyConDataCons, tyConTheta, + isFunTyCon, isPrimTyCon, isNewTyCon, isClassTyCon, + isSynTyCon, isAlgTyCon, isForeignTyCon, + getSynTyConDefn, tyConGenInfo, tyConDataConDetails, tyConArity ) +import Class ( classExtraBigSig, classTyCon, DefMeth(..) ) +import FieldLabel ( fieldLabelType ) +import TcType ( tcSplitSigmaTy, tidyTopType, deNoteType, tyClsNamesOfDFunHead ) +import SrcLoc ( noSrcLoc ) +import Module ( Module, ModuleName, moduleNameFS, moduleName, isHomeModule, + ModLocation(..), mkSysModuleNameFS, + ModuleEnv, emptyModuleEnv, foldModuleEnv, lookupModuleEnv, + extendModuleEnv_C, elemModuleSet, moduleEnvElts ) -import Class ( Class, classExtraBigSig ) -import FieldLabel ( fieldLabelName, fieldLabelType ) -import Type ( mkSigmaTy, splitSigmaTy, mkDictTy, tidyTopType, - deNoteType, classesToPreds, - Type, ThetaType, PredType(..), ClassContext - ) - -import PprType -import PprCore ( pprIfaceUnfolding, pprCoreRule ) -import FunDeps ( pprFundeps ) -import Rules ( pprProtoCoreRule, ProtoCoreRule(..) ) - -import Bag ( bagToList, isEmptyBag ) -import Maybes ( catMaybes, maybeToBool ) -import FiniteMap ( emptyFM, addToFM, addToFM_C, fmToList, FiniteMap ) -import UniqFM ( lookupUFM, listToUFM ) -import UniqSet ( uniqSetToList ) -import Util ( sortLt, mapAccumL ) -import Bag import Outputable +import Util ( sortLt, dropList, seqList ) +import Binary ( getBinFileWithDict ) +import BinIface ( writeBinIface ) +import ErrUtils ( dumpIfSet_dyn ) +import FiniteMap +import FastString + +import Monad ( when ) +import Maybe ( catMaybes, isJust ) +import IO ( putStrLn ) \end{code} -We have a function @startIface@ to open the output file and put -(something like) ``interface Foo'' in it. It gives back a handle -for subsequent additions to the interface file. -We then have one-function-per-block-of-interface-stuff, e.g., -@ifaceExportList@ produces the @__exports__@ section; it appends -to the handle provided by @startIface@. +%************************************************************************ +%* * +\subsection{Print out the contents of a binary interface} +%* * +%************************************************************************ -NOTE: ALWAYS remember that ghc-iface.lprl rewrites the interface file, -so you have to keep it in synch with the code below. Otherwise you'll -lose the happiest years of your life, believe me... -- SUP +\begin{code} +showIface :: FilePath -> IO () +showIface filename = do + parsed_iface <- Binary.getBinFileWithDict filename + let ParsedIface{ + pi_mod=pi_mod, pi_pkg=pi_pkg, pi_vers=pi_vers, + pi_orphan=pi_orphan, pi_usages=pi_usages, + pi_exports=pi_exports, pi_decls=pi_decls, + pi_fixity=pi_fixity, pi_insts=pi_insts, + pi_rules=pi_rules, pi_deprecs=pi_deprecs } = parsed_iface + putStrLn (showSDoc (vcat [ + text "__interface" <+> doubleQuotes (ppr pi_pkg) + <+> ppr pi_mod <+> ppr pi_vers + <+> (if pi_orphan then char '!' else empty) + <+> ptext SLIT("where"), + -- no instance Outputable (WhatsImported): + pprExports id (snd pi_exports), + pprUsages id pi_usages, + hsep (map ppr_fix pi_fixity) <> semi, + vcat (map ppr_inst pi_insts), + vcat (map ppr_decl pi_decls), + ppr pi_rules + -- no instance Outputable (Either): + -- ppr pi_deprecs + ])) + where + ppr_fix (FixitySig n f _) = ppr f <+> ppr n + ppr_inst i = ppr i <+> semi + ppr_decl (v,d) = int v <+> ppr d <> semi +\end{code} + +%************************************************************************ +%* * +\subsection{Completing an interface} +%* * +%************************************************************************ \begin{code} -startIface :: Module -> InterfaceDetails - -> IO (Maybe Handle) -- Nothing <=> don't do an interface - -ifaceDecls :: Maybe Handle - -> [TyCon] -> [Class] - -> Bag InstInfo - -> [Id] -- Ids used at code-gen time; they have better pragma info! - -> [CoreBind] -- In dependency order, later depend on earlier - -> [ProtoCoreRule] -- Rules - -> [Deprecation Name] - -> IO () - -endIface :: Maybe Handle -> IO () +mkIface :: HscEnv + -> ModLocation + -> Maybe ModIface -- The old interface, if we have it + -> ModGuts -- The compiled, tidied module + -> IO ModIface -- The new one, complete with decls and versions +-- mkFinalIface +-- a) completes the interface +-- b) writes it out to a file if necessary + +mkIface hsc_env location maybe_old_iface + impl@ModGuts{ mg_module = this_mod, + mg_usages = usages, + mg_exports = exports, + mg_rdr_env = rdr_env, + mg_fix_env = fix_env, + mg_deprecs = deprecs, + mg_insts = insts, + mg_rules = rules, + mg_types = types } + = do { -- Sort the exports to make them easier to compare for versions + let { my_exports = groupAvails this_mod exports ; + + iface_w_decls = ModIface { mi_module = this_mod, + mi_package = opt_InPackage, + mi_version = initialVersionInfo, + mi_usages = usages, + mi_exports = my_exports, + mi_decls = new_decls, + mi_orphan = orphan_mod, + mi_boot = False, + mi_fixities = fix_env, + mi_globals = Just rdr_env, + mi_deprecs = deprecs } } + + -- Add version information + ; let (final_iface, maybe_diffs) = _scc_ "versioninfo" addVersionInfo maybe_old_iface iface_w_decls + + -- Write the interface file, if necessary + ; when (must_write_hi_file maybe_diffs) + (writeBinIface hi_file_path final_iface) +-- (writeIface hi_file_path final_iface) + + -- Debug printing + ; write_diffs dflags final_iface maybe_diffs + + ; orphan_mod `seq` + return final_iface } + + where + dflags = hsc_dflags hsc_env + ghci_mode = hsc_mode hsc_env + + must_write_hi_file Nothing = False + must_write_hi_file (Just _diffs) = ghci_mode /= Interactive + -- We must write a new .hi file if there are some changes + -- and we're not in interactive mode + -- maybe_diffs = 'Nothing' means that even the usages havn't changed, + -- so there's no need to write a new interface file. But even if + -- the usages have changed, the module version may not have. + + hi_file_path = ml_hi_file location + new_decls = mkIfaceDecls ty_cls_dcls rule_dcls inst_dcls + inst_dcls = map ifaceInstance insts + ty_cls_dcls = foldNameEnv ifaceTyThing_acc [] types + rule_dcls = map ifaceRule rules + orphan_mod = isOrphanModule impl + +write_diffs :: DynFlags -> ModIface -> Maybe SDoc -> IO () +write_diffs dflags new_iface Nothing + = do when (dopt Opt_D_dump_hi_diffs dflags) (printDump (text "INTERFACE UNCHANGED")) + dumpIfSet_dyn dflags Opt_D_dump_hi "UNCHANGED FINAL INTERFACE" (pprIface new_iface) + +write_diffs dflags new_iface (Just sdoc_diffs) + = do dumpIfSet_dyn dflags Opt_D_dump_hi_diffs "INTERFACE HAS CHANGED" sdoc_diffs + dumpIfSet_dyn dflags Opt_D_dump_hi "NEW FINAL INTERFACE" (pprIface new_iface) \end{code} \begin{code} -startIface mod (InterfaceDetails has_orphans import_usages (ExportEnv avails fixities _) _) - = case opt_ProduceHi of - Nothing -> return Nothing ; -- not producing any .hi file - - Just fn -> do - if_hdl <- openFile fn WriteMode - hPutStr if_hdl ("__interface " ++ moduleString mod) - hPutStr if_hdl (' ' : show (opt_HiVersion :: Int) ++ orphan_indicator) - hPutStrLn if_hdl " where" - ifaceExports if_hdl avails - ifaceImports if_hdl import_usages - ifaceFixities if_hdl fixities - return (Just if_hdl) +isOrphanModule :: ModGuts -> Bool +isOrphanModule (ModGuts {mg_module = this_mod, mg_insts = insts, mg_rules = rules}) + = any orphan_inst insts || any orphan_rule rules where - orphan_indicator | has_orphans = " !" - | otherwise = "" + -- A rule is an orphan if the LHS mentions nothing defined locally + orphan_inst dfun_id = no_locals (tyClsNamesOfDFunHead (idType dfun_id)) + -- A instance is an orphan if its head mentions nothing defined locally + orphan_rule rule = no_locals (ruleLhsFreeNames rule) -endIface Nothing = return () -endIface (Just if_hdl) = hPutStr if_hdl "\n" >> hClose if_hdl + no_locals names = isEmptyNameSet (filterNameSet (nameIsLocalOrFrom this_mod) names) \end{code} +Implicit Ids and class tycons aren't included in interface files, so +we miss them out of the accumulating parameter here. \begin{code} -ifaceDecls Nothing tycons classes inst_info final_ids simplified rules _ = return () -ifaceDecls (Just hdl) - tycons classes - inst_infos - final_ids - binds - orphan_rules -- Rules defined locally for an Id that is *not* defined locally - deprecations - | null_decls = return () - -- You could have a module with just (re-)exports/instances in it - | otherwise - = ifaceClasses hdl classes >> - ifaceInstances hdl inst_infos >>= \ inst_ids -> - ifaceTyCons hdl tycons >> - ifaceBinds hdl (inst_ids `unionVarSet` orphan_rule_ids) - final_ids binds >>= \ emitted_ids -> - ifaceRules hdl orphan_rules emitted_ids >> - ifaceDeprecations hdl deprecations - where - orphan_rule_ids = unionVarSets [ ruleSomeFreeVars interestingId rule - | ProtoCoreRule _ _ rule <- orphan_rules] - - null_decls = null binds && - null tycons && - null classes && - isEmptyBag inst_infos && - null orphan_rules && - null deprecations +ifaceTyThing_acc :: TyThing -> [RenamedTyClDecl] -> [RenamedTyClDecl] +ifaceTyThing_acc (AnId id) so_far | isImplicitId id = so_far +ifaceTyThing_acc (ATyCon id) so_far | isClassTyCon id = so_far +ifaceTyThing_acc other so_far = ifaceTyThing other : so_far \end{code} +Convert *any* TyThing into a RenamedTyClDecl. Used both for +generating interface files and for the ':info' command in GHCi. + \begin{code} -ifaceImports :: Handle -> VersionInfo Name -> IO () -ifaceImports if_hdl import_usages - = hPutCol if_hdl upp_uses (sortLt lt_imp_vers import_usages) +ifaceTyThing :: TyThing -> RenamedTyClDecl +ifaceTyThing (AClass clas) = cls_decl where - upp_uses (m, mv, has_orphans, whats_imported) - = hsep [ptext SLIT("import"), pprModuleName m, - int mv, pp_orphan, - upp_import_versions whats_imported - ] <> semi - where - pp_orphan | has_orphans = ptext SLIT("!") - | otherwise = empty + cls_decl = ClassDecl { tcdCtxt = toHsContext sc_theta, + tcdName = getName clas, + tcdTyVars = toHsTyVars clas_tyvars, + tcdFDs = toHsFDs clas_fds, + tcdSigs = map toClassOpSig op_stuff, + tcdMeths = Nothing, + tcdLoc = noSrcLoc } + + (clas_tyvars, clas_fds, sc_theta, sc_sels, op_stuff) = classExtraBigSig clas + tycon = classTyCon clas + data_con = head (tyConDataCons tycon) + + toClassOpSig (sel_id, def_meth) + = ASSERT(sel_tyvars == clas_tyvars) + ClassOpSig (getName sel_id) def_meth' (toHsType op_ty) noSrcLoc + where + (sel_tyvars, _, op_ty) = tcSplitSigmaTy (idType sel_id) + def_meth' = case def_meth of + NoDefMeth -> NoDefMeth + GenDefMeth -> GenDefMeth + DefMeth id -> DefMeth (getName id) - -- Importing the whole module is indicated by an empty list - upp_import_versions Everything = empty - - -- For imported versions we do print the version number - upp_import_versions (Specifically nvs) - = dcolon <+> hsep [ hsep [ppr_unqual_name n, int v] | (n,v) <- sort_versions nvs ] - -{- SUP: What's this?? -ifaceModuleDeps if_hdl [] = return () -ifaceModuleDeps if_hdl mod_deps - = let - lines = map ppr_mod_dep mod_deps - ppr_mod_dep (mod, contains_orphans) - | contains_orphans = pprModuleName mod <+> ptext SLIT("!") - | otherwise = pprModuleName mod - in - printForIface if_hdl (ptext SLIT("__depends") <+> vcat lines <> ptext SLIT(" ;")) >> - hPutStr if_hdl "\n" --} - -ifaceExports :: Handle -> Avails -> IO () -ifaceExports if_hdl [] = return () -ifaceExports if_hdl avails - = hPutCol if_hdl do_one_module (fmToList export_fm) +ifaceTyThing (ATyCon tycon) = ty_decl where - -- Sort them into groups by module - export_fm :: FiniteMap Module [AvailInfo] - export_fm = foldr insert emptyFM avails - - insert avail efm = addToFM_C (++) efm mod [avail] - where - mod = nameModule (availName avail) - - -- Print one module's worth of stuff - do_one_module :: (Module, [AvailInfo]) -> SDoc - do_one_module (mod_name, avails@(avail1:_)) - = ptext SLIT("__export ") <> - hsep [pprModule mod_name, - hsep (map upp_avail (sortLt lt_avail avails)) - ] <> semi - -ifaceFixities :: Handle -> Fixities -> IO () -ifaceFixities if_hdl [] = return () -ifaceFixities if_hdl fixities - = hPutCol if_hdl upp_fixity fixities - -ifaceRules :: Handle -> [ProtoCoreRule] -> IdSet -> IO () -ifaceRules if_hdl rules emitted - | null orphan_rule_pretties && null local_id_pretties - = return () - | otherwise - = printForIface if_hdl (vcat [ - ptext SLIT("{-## __R"), - vcat orphan_rule_pretties, - vcat local_id_pretties, - ptext SLIT("##-}") - ]) - where - orphan_rule_pretties = [ pprCoreRule (Just fn) rule - | ProtoCoreRule _ fn rule <- rules - ] - local_id_pretties = [ pprCoreRule (Just fn) rule - | fn <- varSetElems emitted, - rule <- rulesRules (getIdSpecialisation fn), - all (`elemVarSet` emitted) (varSetElems (ruleSomeLhsFreeVars interestingId rule)) - -- Spit out a rule only if all its lhs free vars are emitted - ] - -ifaceDeprecations :: Handle -> [Deprecation Name] -> IO () -ifaceDeprecations if_hdl [] = return () -ifaceDeprecations if_hdl deprecations - = printForIface if_hdl (vcat [ - ptext SLIT("{-## __D"), - vcat [ pprIE ie <+> doubleQuotes (ppr txt) <> semi | Deprecation ie txt <- deprecations ], - ptext SLIT("##-}") - ]) + ty_decl | isSynTyCon tycon + = TySynonym { tcdName = getName tycon, + tcdTyVars = toHsTyVars tyvars, + tcdSynRhs = toHsType syn_ty, + tcdLoc = noSrcLoc } + + | isAlgTyCon tycon + = TyData { tcdND = new_or_data, + tcdCtxt = toHsContext (tyConTheta tycon), + tcdName = getName tycon, + tcdTyVars = toHsTyVars tyvars, + tcdCons = ifaceConDecls (tyConDataConDetails tycon), + tcdDerivs = Nothing, + tcdGeneric = Just (isJust (tyConGenInfo tycon)), + -- Just True <=> has generic stuff + tcdLoc = noSrcLoc } + + | isForeignTyCon tycon + = ForeignType { tcdName = getName tycon, + tcdExtName = Nothing, + tcdFoType = DNType, -- The only case at present + tcdLoc = noSrcLoc } + + | isPrimTyCon tycon || isFunTyCon tycon + -- needed in GHCi for ':info Int#', for example + = TyData { tcdND = DataType, + tcdCtxt = [], + tcdName = getName tycon, + tcdTyVars = toHsTyVars (take (tyConArity tycon) alphaTyVars), + tcdCons = Unknown, + tcdDerivs = Nothing, + tcdGeneric = Just False, + tcdLoc = noSrcLoc } + + | otherwise = pprPanic "ifaceTyThing" (ppr tycon) + + tyvars = tyConTyVars tycon + (_, syn_ty) = getSynTyConDefn tycon + new_or_data | isNewTyCon tycon = NewType + | otherwise = DataType + + ifaceConDecls Unknown = Unknown + ifaceConDecls (HasCons n) = HasCons n + ifaceConDecls (DataCons cs) = DataCons (map ifaceConDecl cs) + + ifaceConDecl data_con + = ConDecl (getName data_con) + (toHsTyVars ex_tyvars) + (toHsContext ex_theta) + details noSrcLoc + where + (tyvars1, _, ex_tyvars, ex_theta, arg_tys, tycon1) = dataConSig data_con + field_labels = dataConFieldLabels data_con + strict_marks = dropList ex_theta (dataConStrictMarks data_con) + -- The 'drop' is because dataConStrictMarks + -- includes the existential dictionaries + details | null field_labels + = ASSERT( tycon == tycon1 && tyvars == tyvars1 ) + PrefixCon (zipWith BangType strict_marks (map toHsType arg_tys)) + + | otherwise + = RecCon (zipWith mk_field strict_marks field_labels) + + mk_field strict_mark field_label + = (getName field_label, BangType strict_mark (toHsType (fieldLabelType field_label))) + +ifaceTyThing (AnId id) = iface_sig where - pprIE (IEVar n ) = ppr n - pprIE (IEThingAbs n ) = ppr n - pprIE (IEThingAll n ) = hcat [ppr n, text "(..)"] - pprIE (IEThingWith n ns) = ppr n <> parens (hcat (punctuate comma (map ppr ns))) - pprIE (IEModuleContents _ ) = empty -\end{code} + iface_sig = IfaceSig { tcdName = getName id, + tcdType = toHsType id_type, + tcdIdInfo = hs_idinfo, + tcdLoc = noSrcLoc } + + id_type = idType id + id_info = idInfo id + cg_info = idCgInfo id + arity_info = arityInfo id_info + caf_info = cgCafInfo cg_info + + hs_idinfo | opt_OmitInterfacePragmas + = [] + | otherwise + = catMaybes [arity_hsinfo, caf_hsinfo, + strict_hsinfo, wrkr_hsinfo, + unfold_hsinfo] -%************************************************************************ -%* * -\subsection{Instance declarations} -%* * -%************************************************************************ + ------------ Arity -------------- + arity_hsinfo | arity_info == 0 = Nothing + | otherwise = Just (HsArity arity_info) + + ------------ Caf Info -------------- + caf_hsinfo = case caf_info of + NoCafRefs -> Just HsNoCafRefs + _other -> Nothing + ------------ Strictness -------------- + -- No point in explicitly exporting TopSig + strict_hsinfo = case newStrictnessInfo id_info of + Just sig | not (isTopSig sig) -> Just (HsStrictness sig) + _other -> Nothing + + ------------ Worker -------------- + work_info = workerInfo id_info + has_worker = case work_info of { HasWorker _ _ -> True; other -> False } + wrkr_hsinfo = case work_info of + HasWorker work_id wrap_arity -> + Just (HsWorker (getName work_id) wrap_arity) + NoWorker -> Nothing -\begin{code} -ifaceInstances :: Handle -> Bag InstInfo -> IO IdSet -- The IdSet is the needed dfuns -ifaceInstances if_hdl inst_infos - | null togo_insts = return emptyVarSet - | otherwise = hPutCol if_hdl pp_inst (sortLt lt_inst togo_insts) >> - return needed_ids - where - togo_insts = filter is_togo_inst (bagToList inst_infos) - needed_ids = mkVarSet [dfun_id | InstInfo _ _ _ _ dfun_id _ _ _ <- togo_insts] - is_togo_inst (InstInfo _ _ _ _ dfun_id _ _ _) = isLocallyDefined dfun_id - - ------- - lt_inst (InstInfo _ _ _ _ dfun_id1 _ _ _) - (InstInfo _ _ _ _ dfun_id2 _ _ _) - = getOccName dfun_id1 < getOccName dfun_id2 - -- The dfuns are assigned names df1, df2, etc, in order of original textual - -- occurrence, and this makes as good a sort order as any - - ------- - pp_inst (InstInfo clas tvs tys theta dfun_id _ _ _) - = let + ------------ Unfolding -------------- + -- The unfolding is redundant if there is a worker + unfold_info = unfoldingInfo id_info + inline_prag = inlinePragInfo id_info + rhs = unfoldingTemplate unfold_info + unfold_hsinfo | neverUnfold unfold_info + || has_worker = Nothing + | otherwise = Just (HsUnfold inline_prag (toUfExpr rhs)) +\end{code} + +\begin{code} +ifaceInstance :: DFunId -> RenamedInstDecl +ifaceInstance dfun_id + = InstDecl (toHsType tidy_ty) EmptyMonoBinds [] (Just (getName dfun_id)) noSrcLoc + where + tidy_ty = tidyTopType (deNoteType (idType dfun_id)) -- The deNoteType is very important. It removes all type -- synonyms from the instance type in interface files. -- That in turn makes sure that when reading in instance decls @@ -285,416 +384,483 @@ ifaceInstances if_hdl inst_infos -- instance Foo Tibble where ... -- and this instance decl wouldn't get imported into a module -- that mentioned T but not Tibble. - forall_ty = mkSigmaTy tvs (classesToPreds theta) - (deNoteType (mkDictTy clas tys)) - renumbered_ty = tidyTopType forall_ty - in - hcat [ptext SLIT("instance "), pprType renumbered_ty, - ptext SLIT(" = "), ppr_unqual_name dfun_id, semi] -\end{code} - - -%************************************************************************ -%* * -\subsection{Printing values} -%* * -%************************************************************************ - -\begin{code} -ifaceId :: (Id -> IdInfo) -- This function "knows" the extra info added - -- by the STG passes. Sigh - - -> IdSet -- Set of Ids that are needed by earlier interface - -- file emissions. If the Id isn't in this set, and isn't - -- exported, there's no need to emit anything - -> Bool -- True <=> recursive, so don't print unfolding - -> Id - -> CoreExpr -- The Id's right hand side - -> Maybe (SDoc, IdSet) -- The emitted stuff, plus any *extra* needed Ids - -ifaceId get_idinfo needed_ids is_rec id rhs - | not (id `elemVarSet` needed_ids || -- Needed [no id in needed_ids has omitIfaceSigForId] - (isUserExportedId id && not (omitIfaceSigForId id))) -- or exported and not to be omitted - = Nothing -- Well, that was easy! - -ifaceId get_idinfo needed_ids is_rec id rhs - = ASSERT2( arity_matches_strictness, ppr id ) - Just (hsep [sig_pretty, prag_pretty, char ';'], new_needed_ids) - where - core_idinfo = idInfo id - stg_idinfo = get_idinfo id - - ty_pretty = pprType (idType id) - sig_pretty = hsep [ppr (getOccName id), dcolon, ty_pretty] - - prag_pretty - | opt_OmitInterfacePragmas = empty - | otherwise = hsep [ptext SLIT("{-##"), - arity_pretty, - caf_pretty, - cpr_pretty, - strict_pretty, - wrkr_pretty, - unfold_pretty, - ptext SLIT("##-}")] - ------------ Arity -------------- - arity_info = arityInfo stg_idinfo - arity_pretty = ppArityInfo arity_info - - ------------ Caf Info -------------- - caf_pretty = ppCafInfo (cafInfo stg_idinfo) +ifaceRule :: IdCoreRule -> RuleDecl Name +ifaceRule (id, BuiltinRule _ _) + = pprTrace "toHsRule: builtin" (ppr id) (bogusIfaceRule id) - ------------ CPR Info -------------- - cpr_pretty = ppCprInfo (cprInfo core_idinfo) +ifaceRule (id, Rule name act bndrs args rhs) + = IfaceRule name act (map toUfBndr bndrs) (getName id) + (map toUfExpr args) (toUfExpr rhs) noSrcLoc - ------------ Strictness -------------- - strict_info = strictnessInfo core_idinfo - bottoming_fn = isBottomingStrictness strict_info - strict_pretty = ppStrictnessInfo strict_info - - ------------ Worker -------------- - work_info = workerInfo core_idinfo - has_worker = workerExists work_info - wrkr_pretty = ppWorkerInfo work_info - Just work_id = work_info - - - ------------ Occ info -------------- - loop_breaker = case occInfo core_idinfo of - IAmALoopBreaker -> True - other -> False - - ------------ Unfolding -------------- - inline_pragma = inlinePragInfo core_idinfo - dont_inline = case inline_pragma of - IMustNotBeINLINEd False Nothing -> True -- Unconditional NOINLINE - other -> False - - - unfold_pretty | show_unfold = ptext SLIT("__U") <> pprInlinePragInfo inline_pragma <+> pprIfaceUnfolding rhs - | otherwise = empty +bogusIfaceRule :: (NamedThing a) => a -> RuleDecl Name +bogusIfaceRule id + = IfaceRule FSLIT("bogus") NeverActive [] (getName id) [] (UfVar (getName id)) noSrcLoc +\end{code} - show_unfold = not has_worker && -- Not unnecessary - not bottoming_fn && -- Not necessary - not dont_inline && - not loop_breaker && - rhs_is_small && -- Small enough - okToUnfoldInHiFile rhs -- No casms etc - rhs_is_small = couldBeSmallEnoughToInline (calcUnfoldingGuidance opt_UF_HiFileThreshold rhs) +%********************************************************* +%* * +\subsection{Keeping track of what we've slurped, and version numbers} +%* * +%********************************************************* + +mkUsageInfo 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. + +We produce a line for every module B below the module, A, currently being +compiled: + import B ; +to record the fact that A does import B indirectly. 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. + +The usage information 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 (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. + +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. + + *** Conclusion: if A mentions B.f in its export list, + behave just as if A mentioned B.f in its source code, + and slurp in B.f and all its transitive closure *** + +[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.] - ------------ Specialisations -------------- - spec_info = specInfo core_idinfo - - ------------ Extra free Ids -------------- - new_needed_ids | opt_OmitInterfacePragmas = emptyVarSet - | otherwise = worker_ids `unionVarSet` - unfold_ids `unionVarSet` - spec_ids - - worker_ids | has_worker && interestingId work_id = unitVarSet work_id - -- Conceivably, the worker might come from - -- another module - | otherwise = emptyVarSet - - spec_ids = filterVarSet interestingId (rulesRhsFreeVars spec_info) - - unfold_ids | show_unfold = find_fvs rhs - | otherwise = emptyVarSet - - find_fvs expr = exprSomeFreeVars interestingId expr - - ------------ Sanity checking -------------- - -- The arity of a wrapper function should match its strictness, - -- or else an importing module will get very confused indeed. - -- [later: actually all that is necessary is for strictness to exceed arity] - arity_matches_strictness - = not has_worker || - case strict_info of - StrictnessInfo ds _ -> length ds >= arityLowerBound arity_info - other -> True - -interestingId id = isId id && isLocallyDefined id && - not (omitIfaceSigForId id) +\begin{code} +mkUsageInfo :: HscEnv -> ExternalPackageState + -> ImportAvails -> Usages + -> [ImportVersion Name] + +mkUsageInfo hsc_env eps + (ImportAvails { imp_mods = dir_imp_mods }) + (Usages { usg_ext = pkg_mods, + usg_home = home_names }) + = let + hpt = hsc_HPT hsc_env + pit = eps_PIT eps + + import_all_mods = [moduleName m | (m,True) <- moduleEnvElts dir_imp_mods] + + -- mv_map groups together all the things imported and used + -- from a particular module in this package + -- We use a finite map because we want the domain + mv_map :: ModuleEnv [Name] + mv_map = foldNameSet add_mv emptyModuleEnv home_names + add_mv name mv_map = extendModuleEnv_C add_item mv_map mod [name] + where + mod = nameModule name + add_item names _ = name:names + + -- In our usage list we record + -- + -- a) Specifically: Detailed version info for imports + -- from modules in this package Gotten from iVSlurp plus + -- import_all_mods + -- + -- b) Everything: Just the module version for imports + -- from modules in other packages Gotten from iVSlurp plus + -- import_all_mods + -- + -- c) NothingAtAll: The name only of modules, Baz, in + -- this package that are 'below' us, but which we didn't need + -- at all (this is needed only to decide whether to open Baz.hi + -- or Baz.hi-boot higher up the tree). 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 + -- info. These modules are in a combination of HIT/PIT and + -- iImpModInfo + -- + -- d) NothingAtAll: The name only of all orphan modules + -- we know of (this is needed so that anyone who imports us can + -- find the orphan modules) These modules are in a combination + -- of HIT/PIT and iImpModInfo + + import_info0 = foldModuleEnv mk_imp_info [] pit + import_info1 = foldModuleEnv (mk_imp_info . hm_iface) import_info0 hpt + import_info = not_even_opened_imports ++ import_info1 + + -- Recall that iImpModInfo describes modules that have + -- been mentioned in the import lists of interfaces we + -- have seen mentioned, but which we have not even opened when + -- compiling this module + not_even_opened_imports = + [ (mod_name, orphans, is_boot, NothingAtAll) + | (mod_name, (orphans, is_boot)) <- fmToList (eps_imp_mods eps)] + + + mk_imp_info :: ModIface -> [ImportVersion Name] -> [ImportVersion Name] + mk_imp_info iface so_far + + | Just ns <- lookupModuleEnv mv_map mod -- Case (a) + = go_for_it (Specifically mod_vers maybe_export_vers + (mk_import_items ns) rules_vers) + + | mod `elemModuleSet` pkg_mods -- Case (b) + = go_for_it (Everything mod_vers) + + | import_all_mod -- Case (a) and (b); the import-all part + = if is_home_pkg_mod then + go_for_it (Specifically mod_vers (Just export_vers) [] rules_vers) + -- Since the module isn't in the mv_map, presumably we + -- didn't actually import anything at all from it + else + go_for_it (Everything mod_vers) + + | is_home_pkg_mod || has_orphans -- Case (c) or (d) + = go_for_it NothingAtAll + + | otherwise = so_far + where + go_for_it exports = (mod_name, has_orphans, mi_boot iface, exports) : so_far + + mod = mi_module iface + mod_name = moduleName mod + is_home_pkg_mod = isHomeModule mod + version_info = mi_version iface + version_env = vers_decls version_info + mod_vers = vers_module version_info + rules_vers = vers_rules version_info + export_vers = vers_exports version_info + import_all_mod = mod_name `elem` import_all_mods + has_orphans = mi_orphan iface + + -- The sort is to put them into canonical order + mk_import_items ns = [(n,v) | n <- sortLt lt_occ ns, + let v = lookupVersion version_env n + ] + where + lt_occ n1 n2 = nameOccName n1 < nameOccName n2 + + maybe_export_vers | import_all_mod = Just (vers_exports version_info) + | otherwise = Nothing + in + + -- seq the list of ImportVersions returned: occasionally these + -- don't get evaluated for a while and we can end up hanging on to + -- the entire collection of Ifaces. + import_info `seqList` import_info \end{code} \begin{code} -ifaceBinds :: Handle - -> IdSet -- These Ids are needed already - -> [Id] -- Ids used at code-gen time; they have better pragma info! - -> [CoreBind] -- In dependency order, later depend on earlier - -> IO IdSet -- Set of Ids actually spat out - -ifaceBinds hdl needed_ids final_ids binds - = mapIO (printForIface hdl) (bagToList pretties) >> - hPutStr hdl "\n" >> - return emitted +groupAvails :: Module -> Avails -> [(ModuleName, Avails)] + -- Group by module and sort by occurrence + -- This keeps the list in canonical order +groupAvails this_mod avails + = [ (mkSysModuleNameFS fs, sortLt lt avails) + | (fs,avails) <- fmToList groupFM + ] where - final_id_map = listToUFM [(id,id) | id <- final_ids] - get_idinfo id = case lookupUFM final_id_map id of - Just id' -> idInfo id' - Nothing -> pprTrace "ifaceBinds not found:" (ppr id) $ - idInfo id - - (pretties, emitted) = go needed_ids (reverse binds) emptyBag emptyVarSet - -- Reverse so that later things will - -- provoke earlier ones to be emitted - go needed [] pretties emitted - | not (isEmptyVarSet needed) = pprTrace "ifaceBinds: free vars:" - (sep (map ppr (varSetElems needed))) - (pretties, emitted) - | otherwise = (pretties, emitted) - - go needed (NonRec id rhs : binds) pretties emitted - = case ifaceId get_idinfo needed False id rhs of - Nothing -> go needed binds pretties emitted - Just (pretty, extras) -> let - needed' = (needed `unionVarSet` extras) `delVarSet` id - -- 'extras' can include the Id itself via a rule - emitted' = emitted `extendVarSet` id - in - go needed' binds (pretty `consBag` pretties) emitted' - - -- Recursive groups are a bit more of a pain. We may only need one to - -- start with, but it may call out the next one, and so on. So we - -- have to look for a fixed point. - go needed (Rec pairs : binds) pretties emitted - = go needed' binds pretties' emitted' - where - (new_pretties, new_emitted, extras) = go_rec needed pairs - pretties' = new_pretties `unionBags` pretties - needed' = (needed `unionVarSet` extras) `minusVarSet` mkVarSet (map fst pairs) - emitted' = emitted `unionVarSet` new_emitted - - go_rec :: IdSet -> [(Id,CoreExpr)] -> (Bag SDoc, IdSet, IdSet) - go_rec needed pairs - | null pretties = (emptyBag, emptyVarSet, emptyVarSet) - | otherwise = (more_pretties `unionBags` listToBag pretties, - more_emitted `unionVarSet` mkVarSet emitted, - more_extras `unionVarSet` extras) - where - maybes = map do_one pairs - emitted = [id | ((id,_), Just _) <- pairs `zip` maybes] - reduced_pairs = [pair | (pair, Nothing) <- pairs `zip` maybes] - (pretties, extras_s) = unzip (catMaybes maybes) - extras = unionVarSets extras_s - (more_pretties, more_emitted, more_extras) = go_rec extras reduced_pairs - - do_one (id,rhs) = ifaceId get_idinfo needed True id rhs + groupFM :: FiniteMap FastString Avails + -- Deliberately use the FastString so we + -- get a canonical ordering + groupFM = foldl add emptyFM avails + + add env avail = addToFM_C combine env mod_fs [avail'] + where + mod_fs = moduleNameFS (moduleName avail_mod) + avail_mod = case nameModule_maybe (availName avail) of + Just m -> m + Nothing -> this_mod + combine old _ = avail':old + avail' = sortAvail avail + + a1 `lt` a2 = occ1 < occ2 + where + occ1 = nameOccName (availName a1) + occ2 = nameOccName (availName a2) + +sortAvail :: AvailInfo -> AvailInfo +-- Sort the sub-names into canonical order. +-- The canonical order has the "main name" at the beginning +-- (if it's there at all) +sortAvail (Avail n) = Avail n +sortAvail (AvailTC n ns) | n `elem` ns = AvailTC n (n : sortLt lt (filter (/= n) ns)) + | otherwise = AvailTC n ( sortLt lt ns) + where + n1 `lt` n2 = nameOccName n1 < nameOccName n2 \end{code} - %************************************************************************ %* * -\subsection{Random small things} +\subsection{Checking if the new interface is up to date %* * %************************************************************************ \begin{code} -ifaceTyCons hdl tycons = hPutCol hdl upp_tycon (sortLt (<) (filter (for_iface_name . getName) tycons)) -ifaceClasses hdl classes = hPutCol hdl upp_class (sortLt (<) (filter (for_iface_name . getName) classes)) - -for_iface_name name = isLocallyDefined name && - not (isWiredInName name) - -upp_tycon tycon = ifaceTyCon tycon -upp_class clas = ifaceClass clas -\end{code} - - -\begin{code} -ifaceTyCon :: TyCon -> SDoc -ifaceTyCon tycon - | isSynTyCon tycon - = hsep [ ptext SLIT("type"), - ppr (getName tycon), - pprTyVarBndrs tyvars, - ptext SLIT("="), - ppr ty, - semi - ] +addVersionInfo :: Maybe ModIface -- The old interface, read from M.hi + -> ModIface -- The new interface decls + -> (ModIface, Maybe SDoc) -- Nothing => no change; no need to write new Iface + -- Just mi => Here is the new interface to write + -- with correct version numbers + +-- NB: the fixities, declarations, rules are all assumed +-- to be sorted by increasing order of hsDeclName, so that +-- we can compare for equality + +addVersionInfo Nothing new_iface +-- No old interface, so definitely write a new one! + = (new_iface, Just (text "No old interface available")) + +addVersionInfo (Just old_iface@(ModIface { mi_version = old_version, + mi_decls = old_decls, + mi_fixities = old_fixities, + mi_deprecs = old_deprecs })) + new_iface@(ModIface { mi_decls = new_decls, + mi_fixities = new_fixities, + mi_deprecs = new_deprecs }) + + | no_output_change && no_usage_change + = (new_iface, Nothing) + -- don't return the old iface because it may not have an + -- mi_globals field set to anything reasonable. + + | otherwise -- Add updated version numbers + = --pprTrace "completeIface" (ppr (dcl_tycl old_decls)) + (final_iface, Just pp_diffs) + where - (tyvars, ty) = getSynTyConDefn tycon - -ifaceTyCon tycon - | isAlgTyCon tycon - = hsep [ ptext keyword, - ppr_decl_class_context (tyConTheta tycon), - ppr (getName tycon), - pprTyVarBndrs (tyConTyVars tycon), - ptext SLIT("="), - hsep (punctuate (ptext SLIT(" | ")) (map ppr_con (tyConDataCons tycon))), - semi - ] + final_iface = new_iface { mi_version = new_version } + old_mod_vers = vers_module old_version + new_version = VersionInfo { vers_module = bumpVersion no_output_change old_mod_vers, + vers_exports = bumpVersion no_export_change (vers_exports old_version), + vers_rules = bumpVersion no_rule_change (vers_rules old_version), + vers_decls = tc_vers } + + no_output_change = no_tc_change && no_rule_change && no_export_change && no_deprec_change + no_usage_change = mi_usages old_iface == mi_usages new_iface + + no_export_change = mi_exports old_iface == mi_exports new_iface -- Kept sorted + no_rule_change = dcl_rules old_decls == dcl_rules new_decls -- Ditto + no_deprec_change = old_deprecs == new_deprecs + + -- Fill in the version number on the new declarations by looking at the old declarations. + -- Set the flag if anything changes. + -- Assumes that the decls are sorted by hsDeclName. + (no_tc_change, pp_tc_diffs, tc_vers) = diffDecls old_version old_fixities new_fixities + (dcl_tycl old_decls) (dcl_tycl new_decls) + pp_diffs = vcat [pp_tc_diffs, + pp_change no_export_change "Export list", + pp_change no_rule_change "Rules", + pp_change no_deprec_change "Deprecations", + pp_change no_usage_change "Usages"] + pp_change True what = empty + pp_change False what = text what <+> ptext SLIT("changed") + +diffDecls :: VersionInfo -- Old version + -> FixityEnv -> FixityEnv -- Old and new fixities + -> [RenamedTyClDecl] -> [RenamedTyClDecl] -- Old and new decls + -> (Bool, -- True <=> no change + SDoc, -- Record of differences + NameEnv Version) -- New version map + +diffDecls (VersionInfo { vers_module = old_mod_vers, vers_decls = old_decls_vers }) + old_fixities new_fixities old new + = diff True empty emptyNameEnv old new where - keyword | isNewTyCon tycon = SLIT("newtype") - | otherwise = SLIT("data") - - tyvars = tyConTyVars tycon - - ppr_con data_con - | null field_labels - = ASSERT( tycon == tycon1 && tyvars == tyvars1 ) - hsep [ ppr_ex ex_tyvars ex_theta, - ppr name, - hsep (map ppr_arg_ty (strict_marks `zip` arg_tys)) - ] - - | otherwise - = hsep [ ppr_ex ex_tyvars ex_theta, - ppr name, - braces $ hsep $ punctuate comma (map ppr_field (strict_marks `zip` field_labels)) - ] - where - (tyvars1, theta1, ex_tyvars, ex_theta, arg_tys, tycon1) = dataConSig data_con - field_labels = dataConFieldLabels data_con - strict_marks = dataConStrictMarks data_con - name = getName data_con - - ppr_ex [] ex_theta = ASSERT( null ex_theta ) empty - ppr_ex ex_tvs ex_theta = ptext SLIT("__forall") <+> brackets (pprTyVarBndrs ex_tvs) - <+> pprIfaceClasses ex_theta <+> ptext SLIT("=>") - - ppr_arg_ty (strict_mark, ty) = ppr_strict_mark strict_mark <> pprParendType ty - - ppr_strict_mark NotMarkedStrict = empty - ppr_strict_mark (MarkedUnboxed _ _) = ptext SLIT("! ! ") - ppr_strict_mark MarkedStrict = ptext SLIT("! ") - - ppr_field (strict_mark, field_label) - = hsep [ ppr (fieldLabelName field_label), - dcolon, - ppr_strict_mark strict_mark <> pprParendType (fieldLabelType field_label) - ] - -ifaceTyCon tycon - = pprPanic "pprIfaceTyDecl" (ppr tycon) - -ifaceClass clas - = hsep [ptext SLIT("class"), - ppr_decl_class_context sc_theta, - ppr clas, -- Print the name - pprTyVarBndrs clas_tyvars, - pprFundeps clas_fds, - pp_ops, - semi - ] - where - (clas_tyvars, clas_fds, sc_theta, _, op_stuff) = classExtraBigSig clas - - pp_ops | null op_stuff = empty - | otherwise = hsep [ptext SLIT("where"), - braces (hsep (punctuate semi (map ppr_classop op_stuff))) - ] - - ppr_classop (sel_id, dm_id, explicit_dm) - = ASSERT( sel_tyvars == clas_tyvars) - hsep [ppr (getOccName sel_id), - if explicit_dm then equals else empty, - dcolon, - ppr op_ty - ] + -- When seeing if two decls are the same, + -- remember to check whether any relevant fixity has changed + eq_tc d1 d2 = d1 == d2 && all (same_fixity . fst) (tyClDeclNames d1) + same_fixity n = lookupFixity old_fixities n == lookupFixity new_fixities n + + diff ok_so_far pp new_vers [] [] = (ok_so_far, pp, new_vers) + diff ok_so_far pp new_vers (od:ods) [] = diff False (pp $$ only_old od) new_vers ods [] + diff ok_so_far pp new_vers [] (nd:nds) = diff False (pp $$ only_new nd) new_vers_with_new [] nds + where + new_vers_with_new = extendNameEnv new_vers (tyClDeclName nd) (bumpVersion False old_mod_vers) + -- When adding a new item, start from the old module version + -- This way, if you have version 4 of f, then delete f, then add f again, + -- you'll get version 6 of f, which will (correctly) force recompilation of + -- clients + + diff ok_so_far pp new_vers (od:ods) (nd:nds) + = case od_name `compare` nd_name of + LT -> diff False (pp $$ only_old od) new_vers ods (nd:nds) + GT -> diff False (pp $$ only_new nd) new_vers (od:ods) nds + EQ | od `eq_tc` nd -> diff ok_so_far pp new_vers ods nds + | otherwise -> diff False (pp $$ changed od nd) new_vers_with_diff ods nds where - (sel_tyvars, _, op_ty) = splitSigmaTy (idType sel_id) + od_name = tyClDeclName od + nd_name = tyClDeclName nd + new_vers_with_diff = extendNameEnv new_vers nd_name (bumpVersion False old_version) + old_version = lookupVersion old_decls_vers od_name + + only_old d = ptext SLIT("Only in old iface:") <+> ppr d + only_new d = ptext SLIT("Only in new iface:") <+> ppr d + changed od nd = ptext SLIT("Changed in iface: ") <+> ((ptext SLIT("Old:") <+> ppr od) $$ + (ptext SLIT("New:") <+> ppr nd)) +\end{code} -ppr_decl_context :: ThetaType -> SDoc -ppr_decl_context [] = empty -ppr_decl_context theta = pprIfaceTheta theta <+> ptext SLIT(" =>") -ppr_decl_class_context :: ClassContext -> SDoc -ppr_decl_class_context [] = empty -ppr_decl_class_context ctxt = pprIfaceClasses ctxt <+> ptext SLIT(" =>") +b%************************************************************************ +%* * +\subsection{Writing an interface file} +%* * +%************************************************************************ -pprIfaceTheta :: ThetaType -> SDoc -- Use braces rather than parens in interface files -pprIfaceTheta [] = empty -pprIfaceTheta theta = braces (hsep (punctuate comma [pprIfacePred p | p <- theta])) +\begin{code} +pprIface :: ModIface -> SDoc +pprIface iface + = vcat [ ptext SLIT("__interface") + <+> doubleQuotes (ftext (mi_package iface)) + <+> ppr (mi_module iface) <+> ppr (vers_module version_info) + <+> pp_sub_vers + <+> (if mi_orphan iface then char '!' else empty) + <+> int opt_HiVersion + <+> ptext SLIT("where") + + , pprExports nameOccName (mi_exports iface) + , pprUsages nameOccName (mi_usages iface) + + , pprFixities (mi_fixities iface) (dcl_tycl decls) + , pprIfaceDecls (vers_decls version_info) decls + , pprRulesAndDeprecs (dcl_rules decls) (mi_deprecs iface) + ] + where + version_info = mi_version iface + decls = mi_decls iface + exp_vers = vers_exports version_info --- ZZ - not sure who uses this - i.e. whether IParams really show up or not --- (it's not used to print normal value signatures) -pprIfacePred :: PredType -> SDoc -pprIfacePred (Class clas tys) = pprConstraint clas tys -pprIfacePred (IParam n ty) = char '?' <> ppr n <+> ptext SLIT("::") <+> ppr ty + rule_vers = vers_rules version_info -pprIfaceClasses :: ClassContext -> SDoc -pprIfaceClasses [] = empty -pprIfaceClasses theta = braces (hsep (punctuate comma [pprConstraint c tys | (c,tys) <- theta])) + pp_sub_vers | exp_vers == initialVersion && rule_vers == initialVersion = empty + | otherwise = brackets (ppr exp_vers <+> ppr rule_vers) \end{code} -%************************************************************************ -%* * -\subsection{Random small things} -%* * -%************************************************************************ - When printing export lists, we print like this: Avail f f AvailTC C [C, x, y] C(x,y) AvailTC C [x, y] C!(x,y) -- Exporting x, y but not C \begin{code} -upp_avail :: AvailInfo -> SDoc -upp_avail (Avail name) = pprOccName (getOccName name) -upp_avail (AvailTC name []) = empty -upp_avail (AvailTC name ns) = hcat [pprOccName (getOccName name), bang, upp_export ns'] - where - bang | name `elem` ns = empty - | otherwise = char '|' - ns' = filter (/= name) ns - -upp_export :: [Name] -> SDoc -upp_export [] = empty -upp_export names = braces (hsep (map (pprOccName . getOccName) names)) - -upp_fixity :: (Name, Fixity) -> SDoc -upp_fixity (name, fixity) = hsep [ptext SLIT("0"), ppr fixity, ppr name, semi] - -- Dummy version number! - -ppr_unqual_name :: NamedThing a => a -> SDoc -- Just its occurrence name -ppr_unqual_name name = pprOccName (getOccName name) -\end{code} +pprExports :: Eq a => (a -> OccName) -> [(ModuleName, [GenAvailInfo a])] -> SDoc +pprExports getOcc exports = vcat (map (pprExport getOcc) exports) +pprExport :: Eq a => (a -> OccName) -> (ModuleName, [GenAvailInfo a]) -> SDoc +pprExport getOcc (mod, items) + = hsep [ ptext SLIT("__export "), ppr mod, hsep (map pp_avail items) ] <> semi + where + --pp_avail :: GenAvailInfo a -> SDoc + pp_avail (Avail name) = ppr (getOcc name) + pp_avail (AvailTC _ []) = empty + pp_avail (AvailTC n (n':ns)) + | n==n' = ppr (getOcc n) <> pp_export ns + | otherwise = ppr (getOcc n) <> char '|' <> pp_export (n':ns) + + pp_export [] = empty + pp_export names = braces (hsep (map (ppr.getOcc) names)) -%************************************************************************ -%* * -\subsection{Comparisons} -%* * -%************************************************************************ - +pprOcc :: Name -> SDoc -- Print the occurrence name only +pprOcc n = pprOccName (nameOccName n) +\end{code} -The various sorts above simply prevent unnecessary "wobbling" when -things change that don't have to. We therefore compare lexically, not -by unique \begin{code} -lt_avail :: AvailInfo -> AvailInfo -> Bool - -a1 `lt_avail` a2 = availName a1 `lt_name` availName a2 - -lt_name :: Name -> Name -> Bool -n1 `lt_name` n2 = nameRdrName n1 < nameRdrName n2 - -lt_lexical :: NamedThing a => a -> a -> Bool -lt_lexical a1 a2 = getName a1 `lt_name` getName a2 +pprUsages :: (a -> OccName) -> [ImportVersion a] -> SDoc +pprUsages getOcc usages = vcat (map (pprUsage getOcc) usages) + +pprUsage :: (a -> OccName) -> ImportVersion a -> SDoc +pprUsage getOcc (m, has_orphans, is_boot, whats_imported) + = hsep [ptext SLIT("import"), ppr m, + pp_orphan, pp_boot, + pp_versions whats_imported + ] <> semi + where + pp_orphan | has_orphans = char '!' + | otherwise = empty + pp_boot | is_boot = char '@' + | otherwise = empty -lt_imp_vers :: ImportVersion a -> ImportVersion a -> Bool -lt_imp_vers (m1,_,_,_) (m2,_,_,_) = m1 < m2 + -- Importing the whole module is indicated by an empty list + pp_versions NothingAtAll = empty + pp_versions (Everything v) = dcolon <+> int v + pp_versions (Specifically vm ve nvs vr) = + dcolon <+> int vm <+> pp_export_version ve <+> int vr + <+> hsep [ ppr (getOcc n) <+> int v | (n,v) <- nvs ] + + pp_export_version Nothing = empty + pp_export_version (Just v) = int v +\end{code} -sort_versions vs = sortLt lt_vers vs +\begin{code} +pprIfaceDecls :: NameEnv Int -> IfaceDecls -> SDoc +pprIfaceDecls version_map decls + = vcat [ vcat [ppr i <+> semi | i <- dcl_insts decls] + , vcat (map ppr_decl (dcl_tycl decls)) + ] + where + ppr_decl d = ppr_vers d <+> ppr d <> semi -lt_vers :: LocalVersion Name -> LocalVersion Name -> Bool -lt_vers (n1,v1) (n2,v2) = n1 `lt_name` n2 + -- Print the version for the decl + ppr_vers d = case lookupNameEnv version_map (tyClDeclName d) of + Nothing -> empty + Just v -> int v \end{code} - \begin{code} -hPutCol :: Handle - -> (a -> SDoc) - -> [a] - -> IO () -hPutCol hdl fmt xs = mapIO (printForIface hdl . fmt) xs - -mapIO :: (a -> IO b) -> [a] -> IO () -mapIO f [] = return () -mapIO f (x:xs) = f x >> mapIO f xs +pprFixities :: FixityEnv + -> [TyClDecl Name] + -> SDoc +pprFixities fixity_map decls + = hsep [ ppr fix <+> ppr n + | FixitySig n fix _ <- collectFixities fixity_map decls ] <> semi + +-- Disgusting to print these two together, but that's +-- the way the interface parser currently expects them. +pprRulesAndDeprecs :: (Outputable a) => [a] -> Deprecations -> SDoc +pprRulesAndDeprecs [] NoDeprecs = empty +pprRulesAndDeprecs rules deprecs + = ptext SLIT("{-##") <+> (pp_rules rules $$ pp_deprecs deprecs) <+> ptext SLIT("##-}") + where + pp_rules [] = empty + pp_rules rules = ptext SLIT("__R") <+> vcat (map ppr rules) + + pp_deprecs NoDeprecs = empty + pp_deprecs deprecs = ptext SLIT("__D") <+> guts + where + guts = case deprecs of + DeprecAll txt -> doubleQuotes (ftext txt) + DeprecSome env -> ppr_deprec_env env + +ppr_deprec_env :: NameEnv (Name, FastString) -> SDoc +ppr_deprec_env env = vcat (punctuate semi (map pp_deprec (nameEnvElts env))) + where + pp_deprec (name, txt) = pprOcc name <+> doubleQuotes (ftext txt) \end{code}