X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Fmain%2FMkIface.lhs;h=c5ad766e7ead835a696466d4b49698d8a09a12fe;hb=e77403886f512c90120fd2f82dcd3e2b0a1d0b04;hp=c837f4cbbbf14d95798828be962c3ad7bcf16e14;hpb=156d91339295539a2b3461efc1ac8c83f29d83f0;p=ghc-hetmet.git diff --git a/ghc/compiler/main/MkIface.lhs b/ghc/compiler/main/MkIface.lhs index c837f4c..c5ad766 100644 --- a/ghc/compiler/main/MkIface.lhs +++ b/ghc/compiler/main/MkIface.lhs @@ -1,12 +1,14 @@ % % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998 % + \section[MkIface]{Print an interface for a module} \begin{code} module MkIface ( - mkModDetails, mkModDetailsFromIface, completeIface, - writeIface, pprIface + showIface, mkIface, mkUsageInfo, + pprIface, pprUsage, pprUsages, pprExports, + ifaceTyThing, ) where #include "HsVersions.h" @@ -14,260 +16,359 @@ module MkIface ( import HsSyn import HsCore ( HsIdInfo(..), UfExpr(..), toUfExpr, toUfBndr ) import HsTypes ( toHsTyVars ) -import BasicTypes ( Fixity(..), NewOrData(..), - Version, initialVersion, bumpVersion, isLoopBreaker +import TysPrim ( alphaTyVars ) +import BasicTypes ( NewOrData(..), Activation(..), FixitySig(..), + Version, initialVersion, bumpVersion ) -import RnMonad +import NewDemand ( isTopSig ) +import TcRnMonad import RnHsSyn ( RenamedInstDecl, RenamedTyClDecl ) -import TcHsSyn ( TypecheckedRuleDecl ) -import HscTypes ( VersionInfo(..), IfaceDecls(..), ModIface(..), ModDetails(..), - TyThing(..), DFunId, TypeEnv, isTyClThing, Avails, - WhatsImported(..), GenAvailInfo(..), - ImportVersion, AvailInfo, Deprecations(..), - ModuleLocation(..) +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 ( Id, idType, idInfo, omitIfaceSigForId, isUserExportedId, hasNoBinding, - idSpecialisation, idName, setIdInfo - ) -import Var ( isId ) -import VarSet -import DataCon ( StrictnessMark(..), dataConSig, dataConFieldLabels, dataConStrictMarks ) +import Id ( idType, idInfo, isImplicitId, idCgInfo ) +import DataCon ( dataConSig, dataConFieldLabels, dataConStrictMarks ) import IdInfo -- Lots -import CoreSyn ( CoreExpr, CoreBind, Bind(..), CoreRule(..), IdCoreRule, - isBuiltinRule, rulesRules, rulesRhsFreeVars, emptyCoreRules, - bindersOfBinds - ) -import CoreFVs ( exprSomeFreeVars, ruleSomeLhsFreeVars, ruleSomeFreeVars ) -import CoreUnfold ( okToUnfoldInHiFile, mkTopUnfolding, neverUnfold, unfoldingTemplate, noUnfolding ) -import Name ( isLocallyDefined, getName, - Name, NamedThing(..), - plusNameEnv, lookupNameEnv, emptyNameEnv, mkNameEnv, - extendNameEnv, lookupNameEnv_NF, nameEnvElts - ) -import OccName ( pprOccName ) -import TyCon ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon, - tyConTheta, tyConTyVars, tyConDataCons, tyConFamilySize - ) -import Class ( classExtraBigSig, DefMeth(..) ) +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 ( DataConDetails(..), tyConTyVars, tyConDataCons, tyConTheta, + isFunTyCon, isPrimTyCon, isNewTyCon, isClassTyCon, + isSynTyCon, isAlgTyCon, isForeignTyCon, + getSynTyConDefn, tyConGenInfo, tyConDataConDetails, tyConArity ) +import Class ( classExtraBigSig, classTyCon, DefMeth(..) ) import FieldLabel ( fieldLabelType ) -import Type ( splitSigmaTy, tidyTopType, deNoteType ) +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 Outputable -import Module ( ModuleName, moduleName ) -import Finder ( findModule ) - -import List ( partition ) -import IO ( IOMode(..), openFile, hClose ) +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} %************************************************************************ %* * -\subsection{Write a new interface file} +\subsection{Print out the contents of a binary interface} %* * %************************************************************************ \begin{code} -mkModDetails :: TypeEnv -> [DFunId] -- From typechecker - -> [CoreBind] -> [Id] -- Final bindings, plus the top-level Ids from the - -- code generator; they have authoritative arity info - -> [IdCoreRule] -- Tidy orphan rules - -> ModDetails -mkModDetails type_env dfun_ids tidy_binds stg_ids orphan_rules - = ModDetails { md_types = new_type_env, - md_rules = rule_dcls, - md_insts = dfun_ids } - where - -- The competed type environment is gotten from - -- a) keeping the types and classes - -- b) removing all Ids, and Ids with correct IdInfo - -- gotten from the bindings - new_type_env = mkNameEnv [(getName tycl, tycl) | tycl <- orig_type_env, isTyClThing tycl] - `plusNameEnv` - mkNameEnv [(idName id, AnId id) | id <- final_ids] - - orig_type_env = nameEnvElts type_env - - final_ids = bindsToIds (mkVarSet dfun_ids `unionVarSet` orphan_rule_ids) - (mkVarSet stg_ids) - tidy_binds - - -- The complete rules are gotten by combining - -- a) the orphan rules - -- b) rules embedded in the top-level Ids - rule_dcls | opt_OmitInterfacePragmas = [] - | otherwise = getRules orphan_rules tidy_binds (mkVarSet final_ids) - - orphan_rule_ids = unionVarSets [ ruleSomeFreeVars interestingId rule - | (_, rule) <- orphan_rules] - - --- This version is used when we are re-linking a module --- so we've only run the type checker on its previous interface -mkModDetailsFromIface :: TypeEnv -> [DFunId] -- From typechecker - -> [TypecheckedRuleDecl] - -> ModDetails -mkModDetailsFromIface type_env dfun_ids rules - = ModDetails { md_types = type_env, - md_rules = rule_dcls, - md_insts = dfun_ids } - where - rule_dcls = [(id,rule) | IfaceRuleOut id rule <- rules] - -- All the rules from an interface are of the IfaceRuleOut form +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} +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 } -completeIface :: Maybe ModIface -- The old interface, if we have it - -> ModIface -- The new one, minus the decls and versions - -> ModDetails -- The ModDetails for this module - -> Maybe (ModIface, SDoc) -- The new one, complete with decls and versions - -- The SDoc is a debug document giving differences - -- Nothing => no change + 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} - -- NB: '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. - -- - -- The IO in the type is solely for debug output - -- In particular, dumping a record of what has changed -completeIface maybe_old_iface new_iface mod_details - = addVersionInfo maybe_old_iface (new_iface { mi_decls = new_decls }) +\begin{code} +isOrphanModule :: ModGuts -> Bool +isOrphanModule (ModGuts {mg_module = this_mod, mg_insts = insts, mg_rules = rules}) + = any orphan_inst insts || any orphan_rule rules where - new_decls = IfaceDecls { dcl_tycl = ty_cls_dcls, - dcl_insts = inst_dcls, - dcl_rules = rule_dcls } + -- 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) - inst_dcls = map ifaceInstance (md_insts mod_details) - ty_cls_dcls = map ifaceTyCls (nameEnvElts (md_types mod_details)) - rule_dcls = map ifaceRule (md_rules mod_details) + 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. -%************************************************************************ -%* * -\subsection{Types and classes} -%* * -%************************************************************************ +\begin{code} +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} -ifaceTyCls :: TyThing -> RenamedTyClDecl -ifaceTyCls (AClass clas) - = ClassDecl (toHsContext sc_theta) - (getName clas) - (toHsTyVars clas_tyvars) - (toHsFDs clas_fds) - (map toClassOpSig op_stuff) - EmptyMonoBinds - [] noSrcLoc +ifaceTyThing :: TyThing -> RenamedTyClDecl +ifaceTyThing (AClass clas) = cls_decl where - (clas_tyvars, clas_fds, sc_theta, _, op_stuff) = classExtraBigSig clas - - toClassOpSig (sel_id, def_meth) + 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) (Just def_meth') (toHsType op_ty) noSrcLoc + ClassOpSig (getName sel_id) def_meth' (toHsType op_ty) noSrcLoc where - (sel_tyvars, _, op_ty) = splitSigmaTy (idType sel_id) + (sel_tyvars, _, op_ty) = tcSplitSigmaTy (idType sel_id) def_meth' = case def_meth of NoDefMeth -> NoDefMeth GenDefMeth -> GenDefMeth DefMeth id -> DefMeth (getName id) -ifaceTyCls (ATyCon tycon) - | isSynTyCon tycon - = TySynonym (getName tycon)(toHsTyVars tyvars) (toHsType ty) noSrcLoc - where - (tyvars, ty) = getSynTyConDefn tycon - -ifaceTyCls (ATyCon tycon) - | isAlgTyCon tycon - = TyData new_or_data (toHsContext (tyConTheta tycon)) - (getName tycon) - (toHsTyVars tyvars) - (map ifaceConDecl (tyConDataCons tycon)) - (tyConFamilySize tycon) - Nothing noSrcLoc (panic "gen1") (panic "gen2") +ifaceTyThing (ATyCon tycon) = ty_decl where - tyvars = tyConTyVars tycon + 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) (error "ifaceConDecl") + = 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 = dataConStrictMarks 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 ) - VanillaCon (zipWith mk_bang_ty strict_marks arg_tys) + PrefixCon (zipWith BangType strict_marks (map toHsType arg_tys)) | otherwise = RecCon (zipWith mk_field strict_marks field_labels) - 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 - = ([getName field_label], mk_bang_ty strict_mark (fieldLabelType field_label)) - -ifaceTyCls (ATyCon tycon) = pprPanic "ifaceTyCls" (ppr tycon) + = (getName field_label, BangType strict_mark (toHsType (fieldLabelType field_label))) -ifaceTyCls (AnId id) - = IfaceSig (getName id) (toHsType id_type) hs_idinfo noSrcLoc +ifaceTyThing (AnId id) = iface_sig where + 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 = arity_hsinfo ++ caf_hsinfo ++ cpr_hsinfo ++ - strict_hsinfo ++ wrkr_hsinfo ++ unfold_hsinfo + hs_idinfo | opt_OmitInterfacePragmas + = [] + | otherwise + = catMaybes [arity_hsinfo, caf_hsinfo, + strict_hsinfo, wrkr_hsinfo, + unfold_hsinfo] ------------ Arity -------------- - arity_hsinfo = case arityInfo id_info of - a@(ArityExactly n) -> [HsArity a] - other -> [] + arity_hsinfo | arity_info == 0 = Nothing + | otherwise = Just (HsArity arity_info) ------------ Caf Info -------------- - caf_hsinfo = case cafInfo id_info of - NoCafRefs -> [HsNoCafRefs] - otherwise -> [] - - ------------ CPR Info -------------- - cpr_hsinfo = case cprInfo id_info of - ReturnsCPR -> [HsCprInfo] - NoCPRInfo -> [] + caf_hsinfo = case caf_info of + NoCafRefs -> Just HsNoCafRefs + _other -> Nothing ------------ Strictness -------------- - strict_hsinfo = case strictnessInfo id_info of - NoStrictnessInfo -> [] - info -> [HsStrictness info] - + -- No point in explicitly exporting TopSig + strict_hsinfo = case newStrictnessInfo id_info of + Just sig | not (isTopSig sig) -> Just (HsStrictness sig) + _other -> Nothing ------------ Worker -------------- - wrkr_hsinfo = case workerInfo id_info of - HasWorker work_id wrap_arity -> [HsWorker (getName work_id)] - NoWorker -> [] + 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 ------------ 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 = [] - | otherwise = [HsUnfold inline_prag (toUfExpr rhs)] + unfold_hsinfo | neverUnfold unfold_info + || has_worker = Nothing + | otherwise = Just (HsUnfold inline_prag (toUfExpr rhs)) \end{code} - -%************************************************************************ -%* * -\subsection{Instances and rules} -%* * -%************************************************************************ - \begin{code} ifaceInstance :: DFunId -> RenamedInstDecl ifaceInstance dfun_id @@ -284,227 +385,239 @@ ifaceInstance dfun_id -- and this instance decl wouldn't get imported into a module -- that mentioned T but not Tibble. -ifaceRule (id, BuiltinRule _) +ifaceRule :: IdCoreRule -> RuleDecl Name +ifaceRule (id, BuiltinRule _ _) = pprTrace "toHsRule: builtin" (ppr id) (bogusIfaceRule id) -ifaceRule (id, Rule name bndrs args rhs) - = IfaceRule name (map toUfBndr bndrs) (getName id) +ifaceRule (id, Rule name act bndrs args rhs) + = IfaceRule name act (map toUfBndr bndrs) (getName id) (map toUfExpr args) (toUfExpr rhs) noSrcLoc +bogusIfaceRule :: (NamedThing a) => a -> RuleDecl Name bogusIfaceRule id - = IfaceRule SLIT("bogus") [] (getName id) [] (UfVar (getName id)) noSrcLoc -\end{code} - - -%************************************************************************ -%* * -\subsection{Compute final Ids} -%* * -%************************************************************************ - -A "final Id" has exactly the IdInfo for going into an interface file, or -exporting to another module. - -\begin{code} -bindsToIds :: IdSet -- These Ids are needed already - -> IdSet -- Ids used at code-gen time; they have better pragma info! - -> [CoreBind] -- In dependency order, later depend on earlier - -> [Id] -- Set of Ids actually spat out, complete with exactly the IdInfo - -- they need for exporting to another module - -bindsToIds needed_ids codegen_ids binds - = go needed_ids (reverse binds) [] - -- Reverse so that later things will - -- provoke earlier ones to be emitted - where - -- The 'needed' set contains the 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 - need_id needed_set id = id `elemVarSet` needed_set || isUserExportedId id - - go needed [] emitted - | not (isEmptyVarSet needed) = pprTrace "ifaceBinds: free vars:" - (sep (map ppr (varSetElems needed))) - emitted - | otherwise = emitted - - go needed (NonRec id rhs : binds) emitted - | need_id needed id - = if omitIfaceSigForId id then - go (needed `delVarSet` id) binds (id:emitted) - else - go ((needed `unionVarSet` extras) `delVarSet` id) - binds - (new_id:emitted) - | otherwise - = go needed binds emitted - where - (new_id, extras) = mkFinalId codegen_ids False id rhs - - -- 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. We don't want necessarily them all, - -- because without -O we may only need the first one (if we don't emit - -- its unfolding) - go needed (Rec pairs : binds) emitted - = go needed' binds emitted' - where - (new_emitted, extras) = go_rec needed pairs - needed' = (needed `unionVarSet` extras) `minusVarSet` mkVarSet (map fst pairs) - emitted' = new_emitted ++ emitted - - go_rec :: IdSet -> [(Id,CoreExpr)] -> ([Id], IdSet) - go_rec needed pairs - | null needed_prs = ([], emptyVarSet) - | otherwise = (emitted ++ more_emitted, - extras `unionVarSet` more_extras) - where - (needed_prs,leftover_prs) = partition is_needed pairs - (emitted, extras_s) = unzip [ mkFinalId codegen_ids True id rhs - | (id,rhs) <- needed_prs, not (omitIfaceSigForId id)] - extras = unionVarSets extras_s - (more_emitted, more_extras) = go_rec extras leftover_prs - - is_needed (id,_) = need_id needed id + = IfaceRule FSLIT("bogus") NeverActive [] (getName id) [] (UfVar (getName id)) noSrcLoc \end{code} +%********************************************************* +%* * +\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} -mkFinalId :: IdSet -- The Ids with arity info from the code generator - -> Bool -- True <=> recursive, so don't include unfolding - -> Id - -> CoreExpr -- The Id's right hand side - -> (Id, IdSet) -- The emitted id, plus any *extra* needed Ids - -mkFinalId codegen_ids is_rec id rhs - = (id `setIdInfo` new_idinfo, new_needed_ids) - where - core_idinfo = idInfo id - stg_idinfo = case lookupVarSet codegen_ids id of - Just id' -> idInfo id' - Nothing -> pprTrace "ifaceBinds not found:" (ppr id) $ - idInfo id - - new_idinfo | opt_OmitInterfacePragmas - = vanillaIdInfo - | otherwise - = core_idinfo `setArityInfo` arity_info - `setCafInfo` cafInfo stg_idinfo - `setUnfoldingInfo` unfold_info - `setWorkerInfo` worker_info - `setSpecInfo` emptyCoreRules - -- We zap the specialisations because they are - -- passed on separately through the modules IdCoreRules - - ------------ Arity -------------- - arity_info = arityInfo stg_idinfo - stg_arity = arityLowerBound arity_info - - ------------ Worker -------------- - -- We only treat a function as having a worker if - -- the exported arity (which is now the number of visible lambdas) - -- is the same as the arity at the moment of the w/w split - -- If so, we can safely omit the unfolding inside the wrapper, and - -- instead re-generate it from the type/arity/strictness info - -- But if the arity has changed, we just take the simple path and - -- put the unfolding into the interface file, forgetting the fact - -- that it's a wrapper. +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 -- - -- How can this happen? Sometimes we get - -- f = coerce t (\x y -> $wf x y) - -- at the moment of w/w split; but the eta reducer turns it into - -- f = coerce t $wf - -- which is perfectly fine except that the exposed arity so far as - -- the code generator is concerned (zero) differs from the arity - -- when we did the split (2). + -- a) Specifically: Detailed version info for imports + -- from modules in this package Gotten from iVSlurp plus + -- import_all_mods -- - -- All this arises because we use 'arity' to mean "exactly how many - -- top level lambdas are there" in interface files; but during the - -- compilation of this module it means "how many things can I apply - -- this to". - worker_info = case workerInfo core_idinfo of - info@(HasWorker work_id wrap_arity) - | wrap_arity == stg_arity -> info - | otherwise -> pprTrace "ifaceId: arity change:" (ppr id) - NoWorker - NoWorker -> NoWorker - - has_worker = case worker_info of - HasWorker _ _ -> True - other -> False - - HasWorker work_id _ = worker_info - - ------------ Unfolding -------------- - inline_pragma = inlinePragInfo core_idinfo - dont_inline = isNeverInlinePrag inline_pragma - loop_breaker = isLoopBreaker (occInfo core_idinfo) - bottoming_fn = isBottomingStrictness (strictnessInfo core_idinfo) - - unfolding = mkTopUnfolding rhs - rhs_is_small = neverUnfold unfolding - - unfold_info | show_unfold = unfolding - | otherwise = noUnfolding - - 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 - - - ------------ Extra free Ids -------------- - new_needed_ids | opt_OmitInterfacePragmas = emptyVarSet - | otherwise = worker_ids `unionVarSet` - unfold_ids `unionVarSet` - spec_ids - - spec_ids = filterVarSet interestingId (rulesRhsFreeVars (specInfo core_idinfo)) - - worker_ids | has_worker && interestingId work_id = unitVarSet work_id - -- Conceivably, the worker might come from - -- another module - | otherwise = emptyVarSet - - unfold_ids | show_unfold = find_fvs rhs - | otherwise = emptyVarSet - - find_fvs expr = exprSomeFreeVars interestingId expr + -- 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)] -interestingId id = isId id && isLocallyDefined id && not (hasNoBinding id) + + 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} -getRules :: [IdCoreRule] -- Orphan rules - -> [CoreBind] -- Bindings, with rules in the top-level Ids - -> IdSet -- Ids that are exported, so we need their rules - -> [IdCoreRule] -getRules orphan_rules binds emitted - = orphan_rules ++ local_rules +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 - local_rules = [ (fn, rule) - | fn <- bindersOfBinds binds, - fn `elemVarSet` 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 - - -- Sept 00: I've disabled this test. It doesn't stop many, if any, rules - -- from coming out, and to make it work properly we need to add ???? - -- (put it back in for now) - 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 - ] + 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{Checking if the new interface is up to date @@ -514,7 +627,7 @@ getRules orphan_rules binds emitted \begin{code} addVersionInfo :: Maybe ModIface -- The old interface, read from M.hi -> ModIface -- The new interface decls - -> Maybe (ModIface, SDoc) -- Nothing => no change; no need to write new Iface + -> (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 @@ -524,119 +637,127 @@ addVersionInfo :: Maybe ModIface -- The old interface, read from M.hi addVersionInfo Nothing new_iface -- No old interface, so definitely write a new one! - = Just (new_iface, text "No old interface available") + = (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 })) - new_iface@(ModIface { mi_decls = new_decls, - mi_fixities = new_fixities }) +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 - = Nothing + = (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 - = Just (final_iface, pp_tc_diffs) + = --pprTrace "completeIface" (ppr (dcl_tycl old_decls)) + (final_iface, Just pp_diffs) where final_iface = new_iface { mi_version = new_version } - new_version = VersionInfo { vers_module = bumpVersion no_output_change (vers_module old_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_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. - old_vers_decls = vers_decls old_version - (no_tc_change, pp_tc_diffs, tc_vers) = diffDecls old_vers_decls old_fixities new_fixities + (no_tc_change, pp_tc_diffs, tc_vers) = diffDecls old_version old_fixities new_fixities (dcl_tycl old_decls) (dcl_tycl new_decls) - - - -diffDecls :: NameEnv Version -- Old version map - -> NameEnv Fixity -> NameEnv Fixity -- Old and new fixities + 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 + NameEnv Version) -- New version map -diffDecls old_vers old_fixities new_fixities old new +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 -- 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 = lookupNameEnv old_fixities n == lookupNameEnv new_fixities n + 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 old [] = (False, pp, new_vers) - diff ok_so_far pp new_vers [] (nd:nds) = diff False (pp $$ only_new nd) new_vers [] nds + 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' 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 od_name = tyClDeclName od nd_name = tyClDeclName nd - new_vers' = extendNameEnv new_vers nd_name - (bumpVersion True (lookupNameEnv_NF old_vers od_name)) + 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 d nd = ptext SLIT("Changed in iface: ") <+> ((ptext SLIT("Old:") <+> ppr d) $$ - (ptext SLIT("New:") <+> ppr nd)) + 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} -writeIface :: FilePath -> Maybe ModIface -> IO () -writeIface hi_path Nothing - = return () - -writeIface hi_path (Just mod_iface) - = do { if_hdl <- openFile hi_path WriteMode - ; printForIface if_hdl (pprIface mod_iface) - ; hClose if_hdl - } - pprIface :: ModIface -> SDoc pprIface iface = vcat [ ptext SLIT("__interface") - <+> doubleQuotes (ptext opt_InPackage) + <+> 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") - , vcat (map pprExport (mi_exports iface)) - , vcat (map pprUsage (mi_usages iface)) - - , pprIfaceDecls (vers_decls version_info) - (mi_fixities iface) - (mi_decls iface) + , pprExports nameOccName (mi_exports iface) + , pprUsages nameOccName (mi_usages iface) - , pprDeprecs (mi_deprecs 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 + rule_vers = vers_rules version_info pp_sub_vers | exp_vers == initialVersion && rule_vers == initialVersion = empty @@ -649,30 +770,34 @@ When printing export lists, we print like this: AvailTC C [x, y] C!(x,y) -- Exporting x, y but not C \begin{code} -pprExport :: (ModuleName, Avails) -> SDoc -pprExport (mod, items) +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 - ppr_name :: Name -> SDoc -- Print the occurrence name only - ppr_name n = ppr (nameOccName n) - - pp_avail :: AvailInfo -> SDoc - pp_avail (Avail name) = ppr_name name - pp_avail (AvailTC name []) = empty - pp_avail (AvailTC name ns) = hcat [ppr_name name, bang, pp_export ns'] - where - bang | name `elem` ns = empty - | otherwise = char '|' - ns' = filter (/= name) ns + --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_name names)) + pp_export names = braces (hsep (map (ppr.getOcc) names)) + +pprOcc :: Name -> SDoc -- Print the occurrence name only +pprOcc n = pprOccName (nameOccName n) \end{code} \begin{code} -pprUsage :: ImportVersion Name -> SDoc -pprUsage (m, has_orphans, is_boot, whats_imported) +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 @@ -686,48 +811,56 @@ pprUsage (m, has_orphans, is_boot, whats_imported) -- 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 n <+> int v | (n,v) <- nvs ] + 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 ] - -- HACK for the moment: print the export-list version even if - -- we don't use it, so that syntax of interface files doesn't change - pp_export_version Nothing = int 1 + pp_export_version Nothing = empty pp_export_version (Just v) = int v \end{code} \begin{code} -pprIfaceDecls version_map fixity_map decls +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)) - , pprRules (dcl_rules decls) ] where - ppr_decl d = (ppr_vers d <+> ppr d <> semi) $$ ppr_fixes d + ppr_decl d = ppr_vers d <+> ppr d <> semi -- Print the version for the decl ppr_vers d = case lookupNameEnv version_map (tyClDeclName d) of Nothing -> empty Just v -> int v - - -- Print fixities relevant to the decl - ppr_fixes d = vcat [ ppr fix <+> ppr n <> semi - | (n,_) <- tyClDeclNames d, - Just fix <- [lookupNameEnv fixity_map n] - ] \end{code} \begin{code} -pprRules [] = empty -pprRules rules = hsep [ptext SLIT("{-## __R"), vcat (map ppr rules), ptext SLIT("##-}")] - -pprDeprecs NoDeprecs = empty -pprDeprecs deprecs = ptext SLIT("{-## __D") <+> guts <+> ptext SLIT("##-}") - where - guts = case deprecs of - DeprecAll txt -> ptext txt - DeprecSome env -> pp_deprecs env - -pp_deprecs env = vcat (punctuate semi (map pp_deprec (nameEnvElts env))) - where - pp_deprec (name, txt) = pprOccName (nameOccName name) <+> ptext txt +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}