X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Fmain%2FMkIface.lhs;h=f2b908e2c7edb444b02589d14364c7bfef7374b9;hb=2ac92d88dfb9a8864fb619225cb997bd23b1b8e1;hp=693316f05cb937a5913c1b0cfb4f0a5bba7f29ea;hpb=966ad019456f8a5f3aac409f75997a1c694a3a7b;p=ghc-hetmet.git diff --git a/ghc/compiler/main/MkIface.lhs b/ghc/compiler/main/MkIface.lhs index 693316f..f2b908e 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, mkFinalIface, + pprModDetails, pprIface, pprUsage, pprUsages, pprExports, + ifaceTyThing, ) where #include "HsVersions.h" @@ -14,229 +16,196 @@ 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(..), + Version, initialVersion, bumpVersion ) +import NewDemand ( isTopSig ) import RnMonad import RnHsSyn ( RenamedInstDecl, RenamedTyClDecl ) -import TcHsSyn ( TypecheckedRuleDecl ) import HscTypes ( VersionInfo(..), ModIface(..), ModDetails(..), + ModuleLocation(..), GhciMode(..), + FixityEnv, lookupFixity, collectFixities, IfaceDecls, mkIfaceDecls, dcl_tycl, dcl_rules, dcl_insts, - TyThing(..), DFunId, TypeEnv, Avails, + TyThing(..), DFunId, TypeEnv, + GenAvailInfo, WhatsImported(..), GenAvailInfo(..), - ImportVersion, AvailInfo, Deprecations(..), - extendTypeEnvList + ImportVersion, Deprecations(..), + lookupVersion, typeEnvIds ) import CmdLineOpts -import Id ( Id, idType, idInfo, omitIfaceSigForId, isDictFunId, - idSpecialisation, setIdInfo, isLocalId, idName, hasNoBinding +import Id ( idType, idInfo, isImplicitId, idCgInfo, + isLocalId, idName, ) -import Var ( isId ) -import VarSet -import DataCon ( StrictnessMark(..), dataConId, dataConSig, dataConFieldLabels, dataConStrictMarks ) +import DataCon ( dataConWorkId, dataConSig, dataConFieldLabels, dataConStrictMarks ) import IdInfo -- Lots -import CoreSyn ( CoreBind, CoreRule(..), IdCoreRule, - isBuiltinRule, rulesRules, - bindersOf, bindersOfBinds - ) -import CoreFVs ( ruleSomeLhsFreeVars ) +import Var ( Var ) +import CoreSyn ( CoreRule(..), IdCoreRule ) +import CoreFVs ( ruleLhsFreeNames ) import CoreUnfold ( neverUnfold, unfoldingTemplate ) -import Name ( getName, nameModule, Name, NamedThing(..) ) -import Name -- Env +import PprCore ( pprIdRules ) +import Name ( getName, toRdrName, isExternalName, + nameIsLocalOrFrom, Name, NamedThing(..) ) +import NameEnv +import NameSet import OccName ( pprOccName ) -import TyCon ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon, tyConGenIds, - tyConTheta, tyConTyVars, tyConDataCons, tyConFamilySize, isClassTyCon - ) +import TyCon import Class ( classExtraBigSig, classTyCon, DefMeth(..) ) import FieldLabel ( fieldLabelType ) -import Type ( splitSigmaTy, tidyTopType, deNoteType ) +import TcType ( tcSplitSigmaTy, tidyTopType, deNoteType, namesOfDFunHead ) import SrcLoc ( noSrcLoc ) import Outputable import Module ( ModuleName ) - -import IO ( IOMode(..), openFile, hClose ) +import Util ( sortLt, dropList ) +import Binary ( getBinFileWithDict ) +import BinIface ( writeBinIface ) +import ErrUtils ( dumpIfSet_dyn ) +import FastString + +import Monad ( when ) +import Maybe ( catMaybes ) +import IO ( putStrLn ) \end{code} %************************************************************************ %* * -\subsection{Write a new interface file} +\subsection{Print out the contents of a binary interface} %* * %************************************************************************ \begin{code} -mkModDetails :: TypeEnv -- From typechecker - -> [CoreBind] -- Final bindings - -> [Id] -- Top-level Ids from the code generator; - -- they have authoritative arity info - -> [IdCoreRule] -- Tidy orphan rules - -> ModDetails -mkModDetails type_env tidy_binds stg_ids orphan_rules - = ModDetails { md_types = new_type_env, - md_rules = rule_dcls, - md_insts = filter isDictFunId final_ids } - where - -- The competed type environment is gotten from - -- a) keeping the types and classes - -- b) removing all Ids, - -- c) adding Ids with correct IdInfo, including unfoldings, - -- gotten from the bindings - -- From (c) we keep only those Ids with Global names; - -- the CoreTidy pass makes sure these are all and only - -- the externally-accessible ones - -- This truncates the type environment to include only the - -- exported Ids and things needed from them, which saves space - -- - -- However, we do keep things like constructors, which should not appear - -- in interface files, because they are needed by importing modules when - -- using the compilation manager - new_type_env = extendTypeEnvList (filterNameEnv keep_it type_env) - (map AnId final_ids) - - -- We keep constructor workers, because they won't appear - -- in the bindings from which final_ids are derived! - keep_it (AnId id) = hasNoBinding id - keep_it other = True - - stg_id_set = mkVarSet stg_ids - final_ids = [addStgInfo stg_id_set id | bind <- tidy_binds - , id <- bindersOf bind - , isGlobalName (idName id)] - - -- 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) - --- 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 - -> [TypecheckedRuleDecl] - -> ModDetails -mkModDetailsFromIface type_env rules - = ModDetails { md_types = type_env, - md_rules = rule_dcls, - md_insts = dfun_ids } - where - dfun_ids = [dfun_id | AnId dfun_id <- nameEnvElts type_env, isDictFunId dfun_id] - 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 (n,f) = ppr f <+> ppr n + ppr_inst i = ppr i <+> semi + ppr_decl (v,d) = int v <+> ppr d <> semi \end{code} - -We have to add on the arity and CAF info computed by the code generator -This is also the moment at which we may forget that this function has -a worker: see the comments below +%************************************************************************ +%* * +\subsection{Completing an interface} +%* * +%************************************************************************ \begin{code} -addStgInfo :: IdSet -- Ids used at code-gen time; they have better pragma info! - -> Id -> Id -addStgInfo stg_ids id - = id `setIdInfo` final_idinfo - where - idinfo = idInfo id - idinfo' = idinfo `setArityInfo` stg_arity - `setCafInfo` cafInfo stg_idinfo - final_idinfo | worker_ok = idinfo' - | otherwise = idinfo' `setWorkerInfo` NoWorker - - stg_idinfo = case lookupVarSet stg_ids id of - Just id' -> idInfo id' - Nothing -> pprTrace "ifaceBinds not found:" (ppr id) $ - idInfo id - - stg_arity = arityInfo stg_idinfo - ------------ 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. - -- - -- 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). - -- - -- 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_ok = case workerInfo idinfo of - NoWorker -> True - HasWorker work_id wrap_arity -> wrap_arity == arityLowerBound stg_arity -\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 +mkFinalIface :: GhciMode + -> DynFlags + -> ModuleLocation + -> Maybe ModIface -- The old interface, if we have it + -> ModIface -- The new one, minus the decls and versions + -> ModDetails -- The ModDetails for this 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 + +mkFinalIface ghci_mode dflags location maybe_old_iface + new_iface@ModIface{ mi_module=mod } + new_details@ModDetails{ md_insts=insts, + md_rules=rules, + md_types=types } + = do { + -- Add the new declarations, and the is-orphan flag + let iface_w_decls = new_iface { mi_decls = new_decls, + mi_orphan = orphan_mod } + + -- Add version information + ; let (final_iface, maybe_diffs) = _scc_ "versioninfo" addVersionInfo maybe_old_iface iface_w_decls + + -- Write the interface file, if necessary + ; when (must_write_hi_file maybe_diffs) + (writeBinIface hi_file_path final_iface) +-- (writeIface hi_file_path final_iface) + + -- Debug printing + ; write_diffs dflags final_iface maybe_diffs + + ; orphan_mod `seq` + return final_iface } + where - 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 - ] - -interestingId id = isId id && isLocalId id + 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 mod new_details + +write_diffs :: DynFlags -> ModIface -> Maybe SDoc -> IO () +write_diffs dflags new_iface Nothing + = do when (dopt Opt_D_dump_hi_diffs dflags) (printDump (text "INTERFACE UNCHANGED")) + dumpIfSet_dyn dflags Opt_D_dump_hi "UNCHANGED FINAL INTERFACE" (pprIface new_iface) + +write_diffs dflags new_iface (Just sdoc_diffs) + = do dumpIfSet_dyn dflags Opt_D_dump_hi_diffs "INTERFACE HAS CHANGED" sdoc_diffs + dumpIfSet_dyn dflags Opt_D_dump_hi "NEW FINAL INTERFACE" (pprIface new_iface) \end{code} +\begin{code} +isOrphanModule :: Module -> ModDetails -> Bool +isOrphanModule this_mod (ModDetails {md_insts = insts, md_rules = rules}) + = any orphan_inst insts || any orphan_rule rules + where + -- A rule is an orphan if the LHS mentions nothing defined locally + orphan_inst dfun_id = no_locals (namesOfDFunHead (idType dfun_id)) + -- A instance is an orphan if its head mentions nothing defined locally + orphan_rule rule = no_locals (ruleLhsFreeNames rule) -%************************************************************************ -%* * -\subsection{Completing an interface} -%* * -%************************************************************************ + 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} -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 - -> (ModIface, Maybe SDoc) -- The new one, complete with decls and versions - -- The SDoc is a debug document giving differences - -- Nothing => no change - - -- 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. -completeIface maybe_old_iface new_iface mod_details - = addVersionInfo maybe_old_iface (new_iface { mi_decls = new_decls }) - where - new_decls = mkIfaceDecls ty_cls_dcls rule_dcls inst_dcls - inst_dcls = map ifaceInstance (md_insts mod_details) - ty_cls_dcls = foldNameEnv ifaceTyCls [] (md_types mod_details) - rule_dcls = map ifaceRule (md_rules mod_details) +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] -> [RenamedTyClDecl] -ifaceTyCls (AClass clas) so_far - = cls_decl : so_far +ifaceTyThing :: TyThing -> RenamedTyClDecl +ifaceTyThing (AClass clas) = cls_decl where cls_decl = ClassDecl { tcdCtxt = toHsContext sc_theta, tcdName = getName clas, @@ -251,21 +220,19 @@ ifaceTyCls (AClass clas) so_far tycon = classTyCon clas data_con = head (tyConDataCons tycon) sys_names = mkClassDeclSysNames (getName tycon, getName data_con, - getName (dataConId data_con), map getName sc_sels) + getName (dataConWorkId data_con), map getName sc_sels) toClassOpSig (sel_id, def_meth) = ASSERT(sel_tyvars == clas_tyvars) ClassOpSig (getName sel_id) def_meth' (toHsType op_ty) noSrcLoc where - (sel_tyvars, _, op_ty) = 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) so_far - | isClassTyCon tycon = so_far - | otherwise = ty_decl : so_far +ifaceTyThing (ATyCon tycon) = ty_decl where ty_decl | isSynTyCon tycon = TySynonym { tcdName = getName tycon, @@ -278,45 +245,61 @@ ifaceTyCls (ATyCon tycon) so_far tcdCtxt = toHsContext (tyConTheta tycon), tcdName = getName tycon, tcdTyVars = toHsTyVars tyvars, - tcdCons = map ifaceConDecl (tyConDataCons tycon), - tcdNCons = tyConFamilySize tycon, + tcdCons = ifaceConDecls (tyConDataConDetails tycon), tcdDerivs = Nothing, tcdSysNames = map getName (tyConGenIds tycon), tcdLoc = noSrcLoc } - | otherwise = pprPanic "ifaceTyCls" (ppr tycon) + | 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, + tcdSysNames = [], + 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) (getName (dataConId data_con)) + = ConDecl (getName data_con) (getName (dataConWorkId 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) + VanillaCon (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)) + = ([getName field_label], BangType strict_mark (toHsType (fieldLabelType field_label))) -ifaceTyCls (AnId id) so_far - | omitIfaceSigForId id = so_far - | otherwise = iface_sig : so_far +ifaceTyThing (AnId id) = iface_sig where iface_sig = IfaceSig { tcdName = getName id, tcdType = toHsType id_type, @@ -325,38 +308,39 @@ ifaceTyCls (AnId id) so_far 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 -------------- 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 -> [HsWorker (getName work_id)] - NoWorker -> [] + HasWorker work_id wrap_arity -> + Just (HsWorker (getName work_id) wrap_arity) + NoWorker -> Nothing ------------ Unfolding -------------- -- The unfolding is redundant if there is a worker @@ -364,8 +348,8 @@ ifaceTyCls (AnId id) so_far inline_prag = inlinePragInfo id_info rhs = unfoldingTemplate unfold_info unfold_hsinfo | neverUnfold unfold_info - || has_worker = [] - | otherwise = [HsUnfold inline_prag (toUfExpr rhs)] + || has_worker = Nothing + | otherwise = Just (HsUnfold inline_prag (toUfExpr rhs)) \end{code} \begin{code} @@ -384,15 +368,17 @@ 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 pat +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 pat bogusIfaceRule id - = IfaceRule SLIT("bogus") [] (getName id) [] (UfVar (getName id)) noSrcLoc + = IfaceRule FSLIT("bogus") NeverActive [] (getName id) [] (UfVar (getName id)) noSrcLoc \end{code} @@ -417,11 +403,13 @@ 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 })) - 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 = (new_iface, Nothing) @@ -434,59 +422,69 @@ addVersionInfo (Just old_iface@(ModIface { mi_version = old_version, 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) 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 :: NameEnv Version -- Old version map - -> NameEnv Fixity -> NameEnv Fixity -- Old and new fixities +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 (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 [] 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 False (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 @@ -498,43 +496,84 @@ diffDecls old_vers old_fixities new_fixities old new %************************************************************************ %* * -\subsection{Writing an interface file} +\subsection{Writing ModDetails} %* * %************************************************************************ \begin{code} -writeIface :: FilePath -> ModIface -> IO () -writeIface hi_path mod_iface - = do { if_hdl <- openFile hi_path WriteMode - ; printForIface if_hdl from_this_mod (pprIface mod_iface) - ; hClose if_hdl - } +pprModDetails :: ModDetails -> SDoc +pprModDetails (ModDetails { md_types = type_env, md_insts = dfun_ids, md_rules = rules }) + = vcat [ dump_types dfun_ids type_env + , dump_insts dfun_ids + , dump_rules rules] + +dump_types :: [Var] -> TypeEnv -> SDoc +dump_types dfun_ids type_env + = text "TYPE SIGNATURES" $$ nest 4 (dump_sigs ids) + where + ids = [id | id <- typeEnvIds type_env, want_sig id] + want_sig id | opt_PprStyle_Debug = True + | otherwise = isLocalId id && + isExternalName (idName id) && + not (id `elem` dfun_ids) + -- isLocalId ignores data constructors, records selectors etc + -- The isExternalName ignores local dictionary and method bindings + -- that the type checker has invented. User-defined things have + -- Global names. + +dump_insts :: [Var] -> SDoc +dump_insts [] = empty +dump_insts dfun_ids = text "INSTANCES" $$ nest 4 (dump_sigs dfun_ids) + +dump_sigs :: [Var] -> SDoc +dump_sigs ids + -- Print type signatures + -- Convert to HsType so that we get source-language style printing + -- And sort by RdrName + = vcat $ map ppr_sig $ sortLt lt_sig $ + [ (toRdrName id, toHsType (idType id)) + | id <- ids ] where - -- Print names unqualified if they are from this module - from_this_mod n = nameModule n == this_mod - this_mod = mi_module mod_iface - + lt_sig (n1,_) (n2,_) = n1 < n2 + ppr_sig (n,t) = ppr n <+> dcolon <+> ppr t + +dump_rules :: [IdCoreRule] -> SDoc +dump_rules [] = empty +dump_rules rs = vcat [ptext SLIT("{-# RULES"), + nest 4 (pprIdRules rs), + ptext SLIT("#-}")] +\end{code} + + +%************************************************************************ +%* * +\subsection{Writing an interface file} +%* * +%************************************************************************ + +\begin{code} 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)) + , pprExports nameOccName (mi_exports iface) + , pprUsages nameOccName (mi_usages iface) , pprFixities (mi_fixities iface) (dcl_tycl decls) , pprIfaceDecls (vers_decls version_info) decls - , pprDeprecs (mi_deprecs iface) + , 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 @@ -547,18 +586,22 @@ 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 - pp_avail :: AvailInfo -> SDoc - pp_avail (Avail name) = pprOcc name - pp_avail (AvailTC n []) = empty - pp_avail (AvailTC n (n':ns)) | n==n' = pprOcc n <> pp_export ns - | otherwise = pprOcc n <> char '|' <> pp_export (n':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 pprOcc names)) + pp_export names = braces (hsep (map (ppr.getOcc) names)) pprOcc :: Name -> SDoc -- Print the occurrence name only pprOcc n = pprOccName (nameOccName n) @@ -566,8 +609,11 @@ pprOcc n = pprOccName (nameOccName n) \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 @@ -581,18 +627,19 @@ 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 [ pprOcc 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 ] pp_export_version Nothing = empty pp_export_version (Just v) = int v \end{code} \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)) - , pprRules (dcl_rules decls) ] where ppr_decl d = ppr_vers d <+> ppr d <> semi @@ -604,23 +651,32 @@ pprIfaceDecls version_map decls \end{code} \begin{code} +pprFixities :: NameEnv Fixity + -> [TyClDecl Name pat] + -> SDoc pprFixities fixity_map decls = hsep [ ppr fix <+> ppr n - | d <- decls, - (n,_) <- tyClDeclNames d, - Just fix <- [lookupNameEnv fixity_map n]] <> semi - -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 -> doubleQuotes (ptext txt) - DeprecSome env -> pp_deprecs env - -pp_deprecs env = vcat (punctuate semi (map pp_deprec (nameEnvElts env))) - where - pp_deprec (name, txt) = pprOcc name <+> doubleQuotes (ptext txt) + | (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}