X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Fmain%2FMkIface.lhs;h=49d428f00291284cab4f097628fa7fadb8d65c89;hb=6677029a5084f59b4cd35d76ce3f19b154f2ac87;hp=fbca8ce0b1cd6af24e1edab36331ff2ec0b324e5;hpb=01379cdcb8eee51d5ad20732589c6d26eb6bdb3b;p=ghc-hetmet.git diff --git a/ghc/compiler/main/MkIface.lhs b/ghc/compiler/main/MkIface.lhs index fbca8ce..49d428f 100644 --- a/ghc/compiler/main/MkIface.lhs +++ b/ghc/compiler/main/MkIface.lhs @@ -1,388 +1,412 @@ % % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998 % + \section[MkIface]{Print an interface for a module} \begin{code} -module MkIface ( writeIface ) where +module MkIface ( + showIface, mkIface, mkUsageInfo, + pprIface, + ifaceTyThing, + ) where #include "HsVersions.h" -import IO ( Handle, hPutStr, openFile, - hClose, hPutStrLn, IOMode(..) ) - import HsSyn -import HsCore ( HsIdInfo(..), toUfExpr ) -import RdrHsSyn ( RdrNameRuleDecl ) -import HsPragmas ( DataPragmas(..), ClassPragmas(..) ) +import HsCore ( HsIdInfo(..), UfExpr(..), toUfExpr, toUfBndr ) import HsTypes ( toHsTyVars ) -import BasicTypes ( Fixity(..), FixityDirection(..), NewOrData(..), - Version, bumpVersion, initialVersion, isLoopBreaker +import TysPrim ( alphaTyVars ) +import BasicTypes ( NewOrData(..), Activation(..), FixitySig(..), + Version, initialVersion, bumpVersion + ) +import NewDemand ( isTopSig ) +import TcRnMonad +import TcRnTypes ( ImportAvails(..) ) +import RnHsSyn ( RenamedInstDecl, RenamedTyClDecl ) +import HscTypes ( VersionInfo(..), ModIface(..), + ModGuts(..), ModGuts, + GhciMode(..), HscEnv(..), Dependencies(..), + FixityEnv, lookupFixity, collectFixities, + IfaceDecls, mkIfaceDecls, dcl_tycl, dcl_rules, dcl_insts, + TyThing(..), DFunId, + Avails, AvailInfo, GenAvailInfo(..), availName, + ExternalPackageState(..), + ParsedIface(..), Usage(..), + Deprecations(..), initialVersionInfo, + lookupVersion, lookupIfaceByModName ) -import RnMonad - -import TcInstUtil ( InstInfo(..) ) import CmdLineOpts -import Id ( Id, idType, idInfo, omitIfaceSigForId, isUserExportedId, - idSpecialisation - ) -import Var ( isId ) -import VarSet -import DataCon ( StrictnessMark(..), dataConSig, dataConFieldLabels, dataConStrictMarks ) -import IdInfo ( IdInfo, StrictnessInfo(..), ArityInfo(..), InlinePragInfo(..), - CprInfo(..), CafInfo(..), - inlinePragInfo, arityInfo, arityLowerBound, - strictnessInfo, isBottomingStrictness, - cafInfo, specInfo, cprInfo, - occInfo, isNeverInlinePrag, - workerExists, workerInfo, WorkerInfo(..) - ) -import CoreSyn ( CoreExpr, CoreBind, Bind(..), isBuiltinRule, rulesRules, rulesRhsFreeVars ) -import CoreFVs ( exprSomeFreeVars, ruleSomeLhsFreeVars, ruleSomeFreeVars ) -import CoreUnfold ( okToUnfoldInHiFile, couldBeSmallEnoughToInline ) -import Module ( moduleString, pprModule, pprModuleName, moduleUserString ) -import Name ( isLocallyDefined, isWiredInName, toRdrName, nameModule, - Name, NamedThing(..) - ) +import Id ( idType, idInfo, isImplicitId, idCafInfo ) +import DataCon ( dataConName, 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, tyConFamilySize - ) -import Class ( Class, classExtraBigSig ) -import FieldLabel ( fieldLabelName, fieldLabelType ) -import Type ( mkSigmaTy, splitSigmaTy, mkDictTy, tidyTopType, - deNoteType, classesToPreds, - Type, ThetaType, PredType(..), ClassContext - ) - -import PprType -import Rules ( pprProtoCoreRule, ProtoCoreRule(..) ) - -import Bag ( bagToList, isEmptyBag ) -import Maybes ( catMaybes, maybeToBool ) -import UniqFM ( lookupUFM, listToUFM ) -import Util ( sortLt, mapAccumL ) +import TyCon ( DataConDetails(..), tyConTyVars, tyConDataCons, tyConTheta, + isFunTyCon, isPrimTyCon, isNewTyCon, isClassTyCon, + isSynTyCon, isAlgTyCon, isForeignTyCon, + getSynTyConDefn, tyConGenInfo, tyConDataConDetails, tyConArity ) +import Class ( classExtraBigSig, classTyCon ) +import FieldLabel ( fieldLabelType ) +import TcType ( tcSplitForAllTys, tcFunResultTy, tidyTopType, deNoteType, tyClsNamesOfDFunHead, + mkSigmaTy, mkFunTys, mkTyConApp, mkTyVarTys ) import SrcLoc ( noSrcLoc ) -import Bag +import Module ( Module, ModuleName, moduleNameFS, moduleName, isHomeModule, + ModLocation(..), mkSysModuleNameFS, + ModuleEnv, emptyModuleEnv, lookupModuleEnv, + extendModuleEnv_C, moduleEnvElts + ) import Outputable - -import Maybe ( isNothing ) +import DriverUtil ( createDirectoryHierarchy, directoryOf ) +import Util ( sortLt, dropList, seqList ) +import Binary ( getBinFileWithDict ) +import BinIface ( writeBinIface, v_IgnoreHiVersion ) +import ErrUtils ( dumpIfSet_dyn ) +import FiniteMap +import FastString + +import DATA_IOREF ( writeIORef ) +import Monad ( when ) +import Maybe ( catMaybes, isJust, isNothing ) +import Maybes ( orElse ) +import IO ( putStrLn ) \end{code} %************************************************************************ %* * -\subsection{Write a new interface file} +\subsection{Print out the contents of a binary interface} %* * %************************************************************************ \begin{code} -writeIface this_mod old_iface new_iface - local_tycons local_classes inst_info - final_ids tidy_binds tidy_orphan_rules - = - if isNothing opt_HiDir && isNothing opt_HiFile - then return () -- not producing any .hi file - else - - let - hi_suf = case opt_HiSuf of { Nothing -> "hi"; Just suf -> suf } - filename = case opt_HiFile of { - Just f -> f; - Nothing -> - case opt_HiDir of { - Just dir -> dir ++ '/':moduleUserString this_mod - ++ '.':hi_suf; - Nothing -> panic "writeIface" - }} - in - - case checkIface old_iface full_new_iface of { - Nothing -> do { putStrLn "Interface file unchanged" ; - return () } ; -- No need to update .hi file - - Just final_iface -> - - do let mod_vers_unchanged = case old_iface of - Just iface -> pi_vers iface == pi_vers final_iface - Nothing -> False - if mod_vers_unchanged - then putStrLn "Module version unchanged, but usages differ; hence need new hi file" - else return () - - if_hdl <- openFile filename WriteMode - printForIface if_hdl (pprIface final_iface) - hClose if_hdl - } - where - full_new_iface = completeIface new_iface local_tycons local_classes - inst_info final_ids tidy_binds - tidy_orphan_rules +showIface :: FilePath -> IO () +showIface filename = do + -- skip the version check; we don't want to worry about profiled vs. + -- non-profiled interfaces, for example. + writeIORef v_IgnoreHiVersion True + parsed_iface <- Binary.getBinFileWithDict filename + let ParsedIface{ + pi_mod=pi_mod, pi_pkg=pi_pkg, pi_vers=pi_vers, + pi_deps=pi_deps, + 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), + pprDeps pi_deps, + 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{Checking if the new interface is up to date +\subsection{Completing an interface} %* * %************************************************************************ \begin{code} -checkIface :: Maybe ParsedIface -- The old interface, read from M.hi - -> ParsedIface -- The new interface; but with all version numbers = 1 - -> Maybe ParsedIface -- Nothing => no change; no need to write new Iface - -- Just pi => 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 - -checkIface Nothing new_iface --- No old interface, so definitely write a new one! - = Just new_iface - -checkIface (Just iface) new_iface - | no_output_change && no_usage_change - = Nothing +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_deps = deps, + 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_deps = deps, + 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) $ do + createDirectoryHierarchy (directoryOf hi_file_path) + writeBinIface hi_file_path final_iface + + -- Debug printing + ; write_diffs dflags final_iface maybe_diffs + + ; orphan_mod `seq` + return final_iface } - | otherwise -- Add updated version numbers - = -{- pprTrace "checkIface" ( - vcat [ppr no_decl_changed <+> ppr no_export_change <+> ppr no_usage_change, - text "--------", - vcat (map ppr (pi_decls iface)), - text "--------", - vcat (map ppr (pi_decls new_iface)) - ]) $ --} - Just (new_iface { pi_vers = new_mod_vers, - pi_fixity = (new_fixity_vers, new_fixities), - pi_rules = (new_rules_vers, new_rules), - pi_decls = final_decls - }) - where - no_usage_change = pi_usages iface == pi_usages new_iface - - no_output_change = no_decl_changed && - new_fixity_vers == fixity_vers && - new_rules_vers == rules_vers && - no_export_change - - no_export_change = pi_exports iface == pi_exports new_iface - - new_mod_vers | no_output_change = mod_vers - | otherwise = bumpVersion mod_vers - - mod_vers = pi_vers iface - - (fixity_vers, fixities) = pi_fixity iface - (_, new_fixities) = pi_fixity new_iface - new_fixity_vers | fixities == new_fixities = fixity_vers - | otherwise = bumpVersion fixity_vers - - (rules_vers, rules) = pi_rules iface - (_, new_rules) = pi_rules new_iface - new_rules_vers | rules == new_rules = rules_vers - | otherwise = bumpVersion rules_vers - - (no_decl_changed, final_decls) = merge_decls True [] (pi_decls iface) (pi_decls new_iface) - - -- 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 - merge_decls ok_so_far acc [] [] = (ok_so_far, reverse acc) - merge_decls ok_so_far acc old [] = (False, reverse acc) - merge_decls ok_so_far acc [] (nvd:nvds) = merge_decls False (nvd:acc) [] nvds - merge_decls ok_so_far acc (vd@(v,d):vds) (nvd@(_,nd):nvds) - = case d_name `compare` nd_name of - LT -> merge_decls False acc vds (nvd:nvds) - GT -> merge_decls False (nvd:acc) (vd:vds) nvds - EQ | d == nd -> merge_decls ok_so_far (vd:acc) vds nvds - | otherwise -> merge_decls False ((bumpVersion v, nd):acc) vds nvds - where - d_name = hsDeclName d - nd_name = hsDeclName nd + 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} - - -%************************************************************************ -%* * -\subsection{Printing the interface} -%* * -%************************************************************************ - \begin{code} -pprIface (ParsedIface { pi_mod = mod, pi_vers = mod_vers, pi_orphan = orphan, - pi_usages = usages, pi_exports = exports, - pi_fixity = (fix_vers, fixities), - pi_insts = insts, pi_decls = decls, - pi_rules = (rule_vers, rules), pi_deprecs = deprecs }) - = vcat [ ptext SLIT("__interface") - <+> doubleQuotes (ptext opt_InPackage) - <+> ppr mod <+> ppr mod_vers <+> pp_sub_vers - <+> (if orphan then char '!' else empty) - <+> int opt_HiVersion - <+> ptext SLIT("where") - , vcat (map pprExport exports) - , vcat (map pprUsage usages) - , pprFixities fixities - , vcat [ppr i <+> semi | i <- insts] - , vcat [ppr_vers v <+> ppr d <> semi | (v,d) <- decls] - , pprRules rules - , pprDeprecs deprecs - ] +isOrphanModule :: ModGuts -> Bool +isOrphanModule (ModGuts {mg_module = this_mod, mg_insts = insts, mg_rules = rules}) + = any orphan_inst insts || any orphan_rule rules where - ppr_vers v | v == initialVersion = empty - | otherwise = int v - pp_sub_vers - | fix_vers == initialVersion && rule_vers == initialVersion = empty - | otherwise = brackets (ppr fix_vers <+> ppr rule_vers) -\end{code} + -- 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) -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} -pprExport :: ExportItem -> SDoc -pprExport (mod, items) - = hsep [ ptext SLIT("__export "), ppr mod, hsep (map upp_avail items) ] <> semi - where - upp_avail :: RdrAvailInfo -> SDoc - upp_avail (Avail name) = pprOccName name - upp_avail (AvailTC name []) = empty - upp_avail (AvailTC name ns) = hcat [pprOccName name, bang, upp_export ns'] - where - bang | name `elem` ns = empty - | otherwise = char '|' - ns' = filter (/= name) ns - - upp_export [] = empty - upp_export names = braces (hsep (map pprOccName names)) + 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} -pprUsage :: ImportVersion OccName -> SDoc -pprUsage (m, has_orphans, is_boot, whats_imported) - = hsep [ptext SLIT("import"), pprModuleName m, - pp_orphan, pp_boot, - upp_import_versions whats_imported - ] <> semi - where - pp_orphan | has_orphans = char '!' - | otherwise = empty - pp_boot | is_boot = char '@' - | otherwise = empty - - -- Importing the whole module is indicated by an empty list - upp_import_versions NothingAtAll = empty - upp_import_versions (Everything v) = dcolon <+> int v - upp_import_versions (Specifically vm vf vr nvs) - = dcolon <+> int vm <+> int vf <+> int vr <+> hsep [ ppr n <+> int v | (n,v) <- nvs ] +ifaceTyThing_acc :: TyThing -> [RenamedTyClDecl] -> [RenamedTyClDecl] +-- Don't put implicit things into the result +ifaceTyThing_acc (ADataCon dc) so_far = so_far +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} -pprFixities [] = empty -pprFixities fixes = hsep (map ppr fixes) <> semi +ifaceTyThing :: TyThing -> RenamedTyClDecl +ifaceTyThing (AClass clas) = cls_decl + where + 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 + -- Be careful when splitting the type, because of things + -- like class Foo a where + -- op :: (?x :: String) => a -> a + -- and class Baz a where + -- op :: (Ord a) => a -> a + (sel_tyvars, rho_ty) = tcSplitForAllTys (idType sel_id) + op_ty = tcFunResultTy rho_ty + +ifaceTyThing (ATyCon tycon) = ty_decl + where + 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 -pprRules [] = empty -pprRules rules = hsep [ptext SLIT("{-## __R"), hsep (map ppr rules), ptext SLIT("##-}")] + ifaceConDecls Unknown = Unknown + ifaceConDecls (HasCons n) = HasCons n + ifaceConDecls (DataCons cs) = DataCons (map ifaceConDecl cs) -pprDeprecs [] = empty -pprDeprecs deps = hsep [ ptext SLIT("{-## __D"), guts, ptext SLIT("##-}")] - where - guts = hsep [ ppr ie <+> doubleQuotes (ppr txt) <> semi - | Deprecation ie txt _ <- deps ] -\end{code} + ifaceConDecl data_con + = ConDecl (dataConName 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) -%************************************************************************ -%* * -\subsection{Completing the new interface} -%* * -%************************************************************************ + mk_field strict_mark field_label + = (getName field_label, BangType strict_mark (toHsType (fieldLabelType field_label))) -\begin{code} -completeIface new_iface local_tycons local_classes - inst_info final_ids tidy_binds - tidy_orphan_rules - = new_iface { pi_decls = [(initialVersion,d) | d <- sortLt lt_decl all_decls], - pi_insts = sortLt lt_inst_decl inst_dcls, - pi_rules = (initialVersion, rule_dcls) - } +ifaceTyThing (AnId id) = iface_sig where - all_decls = cls_dcls ++ ty_dcls ++ bagToList val_dcls - (inst_dcls, inst_ids) = ifaceInstances inst_info - cls_dcls = map ifaceClass local_classes - ty_dcls = map ifaceTyCon (filter (not . isWiredInName . getName) local_tycons) + iface_sig = IfaceSig { tcdName = getName id, + tcdType = toHsType id_type, + tcdIdInfo = hs_idinfo, + tcdLoc = noSrcLoc } + + id_type = idType id + id_info = idInfo id + arity_info = arityInfo id_info + caf_info = idCafInfo id + + hs_idinfo | opt_OmitInterfacePragmas + = [] + | otherwise + = catMaybes [arity_hsinfo, caf_hsinfo, + strict_hsinfo, wrkr_hsinfo, + unfold_hsinfo] - (val_dcls, emitted_ids) = ifaceBinds (inst_ids `unionVarSet` orphan_rule_ids) - final_ids tidy_binds + ------------ Arity -------------- + arity_hsinfo | arity_info == 0 = Nothing + | otherwise = Just (HsArity arity_info) - rule_dcls | opt_OmitInterfacePragmas = [] - | otherwise = ifaceRules tidy_orphan_rules emitted_ids + ------------ Caf Info -------------- + caf_hsinfo = case caf_info of + NoCafRefs -> Just HsNoCafRefs + _other -> Nothing - orphan_rule_ids = unionVarSets [ ruleSomeFreeVars interestingId rule - | ProtoCoreRule _ _ rule <- tidy_orphan_rules] + ------------ Strictness -------------- + -- No point in explicitly exporting TopSig + strict_hsinfo = case newStrictnessInfo id_info of + Just sig | not (isTopSig sig) -> Just (HsStrictness sig) + _other -> Nothing -lt_inst_decl (InstDecl _ _ _ dfun_id1 _) (InstDecl _ _ _ dfun_id2 _) - = dfun_id1 < 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 + ------------ 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 -lt_decl d1 d2 = hsDeclName d1 < hsDeclName d2 + ------------ 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)) + + +ifaceTyThing (ADataCon dc) + -- This case only happens in the call to ifaceThing in InteractiveUI + -- Otherwise DataCons are filtered out in ifaceThing_acc + = IfaceSig { tcdName = getName dc, + tcdType = toHsType full_ty, + tcdIdInfo = [], + tcdLoc = noSrcLoc } + where + (tvs, stupid_theta, ex_tvs, ex_theta, arg_tys, tycon) = dataConSig dc + + -- The "stupid context" isn't part of the wrapper-Id type + -- (for better or worse -- see note in DataCon.lhs), so we + -- have to make it up here + full_ty = mkSigmaTy (tvs ++ ex_tvs) (stupid_theta ++ ex_theta) + (mkFunTys arg_tys (mkTyConApp tycon (mkTyVarTys tvs))) \end{code} - -%************************************************************************ -%* * -\subsection{Completion stuff} -%* * -%************************************************************************ - \begin{code} -ifaceRules :: [ProtoCoreRule] -> IdSet -> [RdrNameRuleDecl] -ifaceRules rules emitted - = orphan_rules ++ local_rules +ifaceInstance :: DFunId -> RenamedInstDecl +ifaceInstance dfun_id + = InstDecl (toHsType tidy_ty) EmptyMonoBinds [] (Just (getName dfun_id)) noSrcLoc where - orphan_rules = [ toHsRule fn rule | ProtoCoreRule _ fn rule <- rules ] - local_rules = [ toHsRule fn rule - | fn <- varSetElems emitted, - rule <- rulesRules (idSpecialisation fn), - not (isBuiltinRule rule), - -- We can't print builtin rules in interface files - -- Since they are built in, an importing module - -- will have access to them anyway - all (`elemVarSet` emitted) (varSetElems (ruleSomeLhsFreeVars interestingId rule)) - -- Spit out a rule only if all its lhs free vars are emitted - -- This is a good reason not to do it when we emit the Id itself - ] -\end{code} - -\begin{code} -ifaceInstances :: Bag InstInfo -> ([RdrNameInstDecl], IdSet) - -- The IdSet is the needed dfuns - -ifaceInstances inst_infos - = (decls, needed_ids) - where - decls = map to_decl togo_insts - 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 - - ------- - to_decl (InstInfo clas tvs tys theta dfun_id _ _ _) - = let + 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 @@ -392,263 +416,453 @@ ifaceInstances 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)) - tidy_ty = tidyTopType forall_ty - in - InstDecl (toHsType tidy_ty) EmptyMonoBinds [] (toRdrName dfun_id) noSrcLoc -\end{code} -\begin{code} -ifaceTyCon :: TyCon -> RdrNameHsDecl -ifaceTyCon tycon - | isSynTyCon tycon - = TyClD (TySynonym (toRdrName tycon) - (toHsTyVars tyvars) (toHsType ty) - noSrcLoc) - where - (tyvars, ty) = getSynTyConDefn tycon - -ifaceTyCon tycon - | isAlgTyCon tycon - = TyClD (TyData new_or_data (toHsContext (tyConTheta tycon)) - (toRdrName tycon) - (toHsTyVars tyvars) - (map ifaceConDecl (tyConDataCons tycon)) - (tyConFamilySize tycon) - Nothing NoDataPragmas noSrcLoc) - where - tyvars = tyConTyVars tycon - new_or_data | isNewTyCon tycon = NewType - | otherwise = DataType +ifaceRule :: IdCoreRule -> RuleDecl Name +ifaceRule (id, BuiltinRule _ _) + = pprTrace "toHsRule: builtin" (ppr id) (bogusIfaceRule id) - ifaceConDecl data_con - = ConDecl (toRdrName data_con) (error "ifaceConDecl") - (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 = dataConStrictMarks data_con - details - | null field_labels - = ASSERT( tycon == tycon1 && tyvars == tyvars1 ) - VanillaCon (zipWith mk_bang_ty strict_marks arg_tys) +ifaceRule (id, Rule name act bndrs args rhs) + = IfaceRule name act (map toUfBndr bndrs) (getName id) + (map toUfExpr args) (toUfExpr rhs) noSrcLoc - | otherwise - = RecCon (zipWith mk_field strict_marks field_labels) +bogusIfaceRule :: (NamedThing a) => a -> RuleDecl Name +bogusIfaceRule id + = IfaceRule FSLIT("bogus") NeverActive [] (getName id) [] (UfVar (getName id)) noSrcLoc +\end{code} - mk_bang_ty NotMarkedStrict ty = Unbanged (toHsType ty) - mk_bang_ty (MarkedUnboxed _ _) ty = Unpacked (toHsType ty) - mk_bang_ty MarkedStrict ty = Banged (toHsType ty) - mk_field strict_mark field_label - = ([toRdrName field_label], mk_bang_ty strict_mark (fieldLabelType field_label)) - -ifaceTyCon tycon - = pprPanic "pprIfaceTyDecl" (ppr tycon) - -ifaceClass clas - = TyClD (ClassDecl (toHsContext sc_theta) - (toRdrName clas) - (toHsTyVars clas_tyvars) - (toHsFDs clas_fds) - (map toClassOpSig op_stuff) - EmptyMonoBinds NoClassPragmas - bogus bogus bogus [] noSrcLoc - ) +%********************************************************* +%* * +\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.] + +\begin{code} +mkUsageInfo :: HscEnv -> ExternalPackageState + -> ImportAvails -> EntityUsage + -> [Usage Name] + +mkUsageInfo hsc_env eps + (ImportAvails { imp_mods = dir_imp_mods, + imp_dep_mods = dep_mods }) + used_names + = -- seq the list of Usages returned: occasionally these + -- don't get evaluated for a while and we can end up hanging on to + -- the entire collection of Ifaces. + usages `seqList` usages where - bogus = error "ifaceClass" - (clas_tyvars, clas_fds, sc_theta, _, op_stuff) = classExtraBigSig clas + usages = catMaybes [ mkUsage mod_name + | (mod_name,_) <- moduleEnvElts dep_mods] + -- ToDo: do we need to sort into canonical order? - toClassOpSig (sel_id, dm_id, explicit_dm) - = ASSERT( sel_tyvars == clas_tyvars) - ClassOpSig (toRdrName sel_id) bogus explicit_dm (toHsType op_ty) noSrcLoc - where - (sel_tyvars, _, op_ty) = splitSigmaTy (idType sel_id) + hpt = hsc_HPT hsc_env + pit = eps_PIT eps + + import_all mod = case lookupModuleEnv dir_imp_mods mod of + Just (_,imp_all) -> imp_all + Nothing -> False + + -- ent_map groups together all the things imported and used + -- from a particular module in this package + ent_map :: ModuleEnv [Name] + ent_map = foldNameSet add_mv emptyModuleEnv used_names + add_mv name mv_map = extendModuleEnv_C add_item mv_map mod [name] + where + mod = nameModule name + add_item names _ = name:names + + -- We want to create a Usage for a home module if + -- a) we used something from; has something in used_names + -- b) we imported all of it, even if we used nothing from it + -- (need to recompile if its export list changes: export_vers) + -- c) is a home-package orphan module (need to recompile if its + -- instance decls change: rules_vers) + mkUsage :: ModuleName -> Maybe (Usage Name) + mkUsage mod_name + | isNothing maybe_iface -- We can't depend on it if we didn't + || not (isHomeModule mod) -- even open the interface! + || (null used_names + && not all_imported + && not orphan_mod) + = Nothing -- Record no usage info + + | otherwise + = Just (Usage { usg_name = moduleName mod, + usg_mod = mod_vers, + usg_exports = export_vers, + usg_entities = ent_vers, + usg_rules = rules_vers }) + where + maybe_iface = lookupIfaceByModName hpt pit mod_name + -- In one-shot mode, the interfaces for home-package + -- modules accumulate in the PIT not HPT. Sigh. + + Just iface = maybe_iface + mod = mi_module iface + version_info = mi_version iface + orphan_mod = mi_orphan iface + version_env = vers_decls version_info + mod_vers = vers_module version_info + rules_vers = vers_rules version_info + all_imported = import_all mod + export_vers | all_imported = Just (vers_exports version_info) + | otherwise = Nothing + + -- The sort is to put them into canonical order + used_names = lookupModuleEnv ent_map mod `orElse` [] + ent_vers = [(n, lookupVersion version_env n) + | n <- sortLt lt_occ used_names ] + lt_occ n1 n2 = nameOccName n1 < nameOccName n2 + -- ToDo: is '<' on OccNames the right thing; may differ between runs? \end{code} +\begin{code} +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 + 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{Value bindings} +\subsection{Checking if the new interface is up to date %* * %************************************************************************ \begin{code} -ifaceBinds :: 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 - -> (Bag RdrNameHsDecl, IdSet) -- Set of Ids actually spat out - -ifaceBinds needed_ids final_ids binds - = go needed_ids (reverse binds) emptyBag emptyVarSet - -- Reverse so that later things will - -- provoke earlier ones to be emitted +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 + 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 + && dcl_insts old_decls == dcl_insts new_decls + 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 - 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 - - go needed [] decls emitted - | not (isEmptyVarSet needed) = pprTrace "ifaceBinds: free vars:" - (sep (map ppr (varSetElems needed))) - (decls, emitted) - | otherwise = (decls, emitted) - - go needed (NonRec id rhs : binds) decls emitted - = case ifaceId get_idinfo needed False id rhs of - Nothing -> go needed binds decls emitted - Just (decl, 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 (decl `consBag` decls) 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) decls emitted - = go needed' binds decls' emitted' + -- 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_decls, new_emitted, extras) = go_rec needed pairs - decls' = new_decls `unionBags` decls - needed' = (needed `unionVarSet` extras) `minusVarSet` mkVarSet (map fst pairs) - emitted' = emitted `unionVarSet` new_emitted - - go_rec :: IdSet -> [(Id,CoreExpr)] -> (Bag RdrNameHsDecl, IdSet, IdSet) - go_rec needed pairs - | null decls = (emptyBag, emptyVarSet, emptyVarSet) - | otherwise = (more_decls `unionBags` listToBag decls, - more_emitted `unionVarSet` mkVarSet emitted, - more_extras `unionVarSet` extras) + 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 - maybes = map do_one pairs - emitted = [id | ((id,_), Just _) <- pairs `zip` maybes] - reduced_pairs = [pair | (pair, Nothing) <- pairs `zip` maybes] - (decls, extras_s) = unzip (catMaybes maybes) - extras = unionVarSets extras_s - (more_decls, more_emitted, more_extras) = go_rec extras reduced_pairs - - do_one (id,rhs) = ifaceId get_idinfo needed True id rhs + 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} +b%************************************************************************ +%* * +\subsection{Writing an interface file} +%* * +%************************************************************************ + \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 (RdrNameHsDecl, 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 (SigD (IfaceSig (toRdrName id) (toHsType id_type) hs_idinfo noSrcLoc), - new_needed_ids) +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) + , pprDeps (mi_deps 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 - id_type = idType id - core_idinfo = idInfo id - stg_idinfo = get_idinfo id + version_info = mi_version iface + decls = mi_decls iface + exp_vers = vers_exports version_info - hs_idinfo | opt_OmitInterfacePragmas = [] - | otherwise = arity_hsinfo ++ caf_hsinfo ++ cpr_hsinfo ++ - strict_hsinfo ++ wrkr_hsinfo ++ unfold_hsinfo + rule_vers = vers_rules version_info - ------------ Arity -------------- - arity_info = arityInfo stg_idinfo - arity_hsinfo = case arityInfo stg_idinfo of - a@(ArityExactly n) -> [HsArity a] - other -> [] + pp_sub_vers | exp_vers == initialVersion && rule_vers == initialVersion = empty + | otherwise = brackets (ppr exp_vers <+> ppr rule_vers) +\end{code} - ------------ Caf Info -------------- - caf_hsinfo = case cafInfo stg_idinfo of - NoCafRefs -> [HsNoCafRefs] - otherwise -> [] +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 - ------------ CPR Info -------------- - cpr_hsinfo = case cprInfo core_idinfo of - ReturnsCPR -> [HsCprInfo] - NoCPRInfo -> [] +\begin{code} +pprExports :: Eq a => (a -> OccName) -> [(ModuleName, [GenAvailInfo a])] -> SDoc +pprExports getOcc exports = vcat (map (pprExport getOcc) exports) - ------------ Strictness -------------- - strict_info = strictnessInfo core_idinfo - bottoming_fn = isBottomingStrictness strict_info - strict_hsinfo = case strict_info of - NoStrictnessInfo -> [] - info -> [HsStrictness info] +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)) +pprOcc :: Name -> SDoc -- Print the occurrence name only +pprOcc n = pprOccName (nameOccName n) +\end{code} - ------------ Worker -------------- - work_info = workerInfo core_idinfo - has_worker = workerExists work_info - wrkr_hsinfo = case work_info of - HasWorker work_id _ -> [HsWorker (toRdrName work_id)] - other -> [] - ------------ Unfolding -------------- - inline_pragma = inlinePragInfo core_idinfo - dont_inline = isNeverInlinePrag inline_pragma +\begin{code} +pprUsages :: (a -> OccName) -> [Usage a] -> SDoc +pprUsages getOcc usages = vcat (map (pprUsage getOcc) usages) + +pprUsage :: (a -> OccName) -> Usage a -> SDoc +pprUsage getOcc usage + = hsep [ptext SLIT("import"), ppr (usg_name usage), + int (usg_mod usage), + pp_export_version (usg_exports usage), + int (usg_rules usage), + pp_versions (usg_entities usage) + ] <> semi + where + pp_versions nvs = hsep [ ppr (getOcc n) <+> int v | (n,v) <- nvs ] + + pp_export_version Nothing = empty + pp_export_version (Just v) = int v - unfold_hsinfo | show_unfold = [HsUnfold inline_pragma (toUfExpr rhs)] - | otherwise = [] - 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 +pprDeps :: Dependencies -> SDoc +pprDeps (Deps { dep_mods = mods, dep_pkgs = pkgs, dep_orphs = orphs}) + = vcat [ptext SLIT("module dependencies:") <+> fsep (map ppr_mod mods), + ptext SLIT("package dependencies:") <+> fsep (map ppr pkgs), + ptext SLIT("orphans:") <+> fsep (map ppr orphs) + ] + where + ppr_mod (mod_name, boot) = ppr mod_name <+> ppr_boot boot + + ppr_boot True = text "[boot]" + ppr_boot False = empty +\end{code} - rhs_is_small = couldBeSmallEnoughToInline opt_UF_HiFileThreshold rhs +\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 - ------------ Specialisations -------------- - spec_info = specInfo core_idinfo - - ------------ Occ info -------------- - loop_breaker = isLoopBreaker (occInfo core_idinfo) - - ------------ Extra free Ids -------------- - new_needed_ids | opt_OmitInterfacePragmas = emptyVarSet - | otherwise = worker_ids `unionVarSet` - unfold_ids `unionVarSet` - spec_ids - - worker_ids = case work_info of - HasWorker work_id _ | interestingId work_id -> unitVarSet work_id - -- Conceivably, the worker might come from - -- another module - other -> 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. - arity_matches_strictness - = case work_info of - HasWorker _ wrap_arity -> wrap_arity == arityLowerBound arity_info - other -> True - -interestingId id = isId id && isLocallyDefined id && - not (omitIfaceSigForId id) + -- 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} +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}