X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Fmain%2FMkIface.lhs;h=45828c7630a28cd6d0180550e484f8dd02ba67c7;hb=f4eba96b198baf4499ca6ccd7242d9daa41337ac;hp=cd818c1a77a598548237c3d69236213226a2f863;hpb=f36fb2ce821caf594c1db5669dd10ca082f66361;p=ghc-hetmet.git diff --git a/ghc/compiler/main/MkIface.lhs b/ghc/compiler/main/MkIface.lhs index cd818c1..45828c7 100644 --- a/ghc/compiler/main/MkIface.lhs +++ b/ghc/compiler/main/MkIface.lhs @@ -1,603 +1,595 @@ % -% (c) The GRASP/AQUA Project, Glasgow University, 1993-1996 +% (c) The GRASP/AQUA Project, Glasgow University, 1993-1998 % + \section[MkIface]{Print an interface for a module} \begin{code} -module MkIface ( - startIface, endIface, - ifaceMain, - ifaceDecls - ) where +module MkIface ( + mkFinalIface, + pprModDetails, pprIface, pprUsage + ) where #include "HsVersions.h" -import IO ( Handle, hPutStr, openFile, - hClose, hPutStrLn, IOMode(..) ) - import HsSyn -import RdrHsSyn ( RdrName(..) ) -import RnHsSyn ( RenamedHsModule ) -import BasicTypes ( Fixity(..), FixityDirection(..), NewOrData(..), IfaceFlavour(..), - pprModule +import HsCore ( HsIdInfo(..), UfExpr(..), toUfExpr, toUfBndr ) +import HsTypes ( toHsTyVars ) +import BasicTypes ( Fixity(..), NewOrData(..), + Version, initialVersion, bumpVersion, ) import RnMonad -import RnEnv ( availName, ifaceFlavour ) - -import TcInstUtil ( InstInfo(..) ) -import WorkWrap ( getWorkerIdAndCons ) +import RnHsSyn ( RenamedInstDecl, RenamedTyClDecl ) +import HscTypes ( VersionInfo(..), ModIface(..), ModDetails(..), + ModuleLocation(..), + IfaceDecls, mkIfaceDecls, dcl_tycl, dcl_rules, dcl_insts, + TyThing(..), DFunId, Avails, + WhatsImported(..), GenAvailInfo(..), + ImportVersion, AvailInfo, Deprecations(..), + lookupVersion, + ) +import CmStaticInfo ( GhciMode(..) ) import CmdLineOpts -import Id ( idType, dataConRawArgTys, dataConFieldLabels, - idInfo, omitIfaceSigForId, - dataConStrictMarks, StrictnessMark(..), - IdSet, idSetToList, unionIdSets, unitIdSet, minusIdSet, - isEmptyIdSet, elementOfIdSet, emptyIdSet, mkIdSet, - pprId, getIdSpecialisation, - Id - ) -import IdInfo ( IdInfo, StrictnessInfo, ArityInfo, InlinePragInfo(..), inlinePragInfo, - arityInfo, ppArityInfo, strictnessInfo, ppStrictnessInfo, - bottomIsGuaranteed, workerExists, - ) -import CoreSyn ( CoreExpr, CoreBinding, GenCoreExpr, GenCoreBinding(..) ) -import CoreUnfold ( calcUnfoldingGuidance, UnfoldingGuidance(..), Unfolding ) -import FreeVars ( exprFreeVars ) -import Name ( isLocallyDefined, isWiredInName, modAndOcc, nameModule, pprOccName, - OccName, occNameString, nameOccName, nameString, isExported, - Name {-instance NamedThing-}, Provenance, NamedThing(..) +import Id ( idType, idInfo, isImplicitId, idCgInfo, + isLocalId, idName, ) -import TyCon ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon, - tyConTheta, tyConTyVars, tyConDataCons +import DataCon ( StrictnessMark(..), dataConId, dataConSig, dataConFieldLabels, dataConStrictMarks ) +import IdInfo -- Lots +import CoreSyn ( CoreRule(..) ) +import CoreFVs ( ruleLhsFreeNames ) +import CoreUnfold ( neverUnfold, unfoldingTemplate ) +import PprCore ( pprIdCoreRule ) +import Name ( getName, nameModule, toRdrName, isGlobalName, + nameIsLocalOrFrom, Name, NamedThing(..) ) +import NameEnv +import NameSet +import OccName ( pprOccName ) +import TyCon ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon, tyConGenIds, + tyConTheta, tyConTyVars, tyConDataCons, tyConFamilySize, isClassTyCon ) -import Class ( Class, classBigSig ) -import SpecEnv ( specEnvToList ) -import FieldLabel ( fieldLabelName, fieldLabelType ) -import Type ( mkSigmaTy, splitSigmaTy, mkDictTy, - mkTyVarTys, Type, ThetaType - ) - -import PprEnv -- not sure how much... -import PprType -import PprCore ( pprIfaceUnfolding ) - -import Bag ( bagToList, isEmptyBag ) -import Maybes ( catMaybes, maybeToBool ) -import FiniteMap ( emptyFM, addToFM, addToFM_C, lookupFM, fmToList, eltsFM, FiniteMap ) -import UniqFM ( UniqFM, lookupUFM, listToUFM ) -import Util ( sortLt, zipWithEqual, zipWith3Equal, mapAccumL ) +import Class ( classExtraBigSig, classTyCon, DefMeth(..) ) +import FieldLabel ( fieldLabelType ) +import Type ( splitSigmaTy, tidyTopType, deNoteType, namesOfDFunHead ) +import SrcLoc ( noSrcLoc ) import Outputable +import Module ( ModuleName ) +import Util ( sortLt, unJust ) +import ErrUtils ( dumpIfSet_dyn ) + +import Monad ( when ) +import IO ( IOMode(..), openFile, hClose ) \end{code} -We have a function @startIface@ to open the output file and put -(something like) ``interface Foo'' in it. It gives back a handle -for subsequent additions to the interface file. -We then have one-function-per-block-of-interface-stuff, e.g., -@ifaceExportList@ produces the @__exports__@ section; it appends -to the handle provided by @startIface@. +%************************************************************************ +%* * +\subsection{Completing an interface} +%* * +%************************************************************************ \begin{code} -startIface :: Module - -> IO (Maybe Handle) -- Nothing <=> don't do an interface -ifaceMain :: Maybe Handle - -> InterfaceDetails - -> IO () -ifaceDecls :: Maybe Handle - -> [TyCon] -> [Class] - -> Bag InstInfo - -> [Id] -- Ids used at code-gen time; they have better pragma info! - -> [CoreBinding] -- In dependency order, later depend on earlier - -> IO () +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 -endIface :: Maybe Handle -> IO () -\end{code} +mkFinalIface ghci_mode dflags location + maybe_old_iface new_iface new_details + = do { + -- Add the new declarations, and the is-orphan flag + let iface_w_decls = new_iface { mi_decls = new_decls, + mi_orphan = orphan_mod } -\begin{code} -startIface mod - = case opt_ProduceHi of - Nothing -> return Nothing -- not producing any .hi file - Just fn -> do - if_hdl <- openFile fn WriteMode - hPutStrLn if_hdl ("_interface_ "++ _UNPK_ mod ++ ' ':show (PROJECTVERSION :: Int)) - return (Just if_hdl) - -endIface Nothing = return () -endIface (Just if_hdl) = hPutStr if_hdl "\n" >> hClose if_hdl -\end{code} + -- Add version information + ; let (final_iface, maybe_diffs) = addVersionInfo maybe_old_iface iface_w_decls + -- Write the interface file, if necessary + ; when (must_write_hi_file maybe_diffs) + (writeIface hi_file_path final_iface) + + -- Debug printing + ; write_diffs dflags final_iface maybe_diffs + + ; return final_iface } -\begin{code} -ifaceMain Nothing iface_stuff = return () -ifaceMain (Just if_hdl) - (import_usages, ExportEnv avails fixities, instance_modules) - = - ifaceInstanceModules if_hdl instance_modules >> - ifaceUsages if_hdl import_usages >> - ifaceExports if_hdl avails >> - ifaceFixities if_hdl fixities >> - return () - -ifaceDecls Nothing tycons classes inst_info final_ids simplified = return () -ifaceDecls (Just hdl) - tycons classes - inst_infos - final_ids binds - | null_decls = return () - -- You could have a module with just (re-)exports/instances in it - | otherwise - = ifaceInstances hdl inst_infos >>= \ needed_ids -> - hPutStr hdl "_declarations_\n" >> - ifaceClasses hdl classes >> - ifaceTyCons hdl tycons >> - ifaceBinds hdl needed_ids final_ids binds >> - return () where - null_decls = null binds && - null tycons && - null classes && - isEmptyBag inst_infos + 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 = unJust "mkFinalIface" (ml_hi_file location) + new_decls = mkIfaceDecls ty_cls_dcls rule_dcls inst_dcls + inst_dcls = map ifaceInstance (md_insts new_details) + ty_cls_dcls = foldNameEnv ifaceTyCls [] (md_types new_details) + rule_dcls = map ifaceRule (md_rules new_details) + orphan_mod = isOrphanModule (mi_module new_iface) new_details + +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} -ifaceUsages if_hdl import_usages - = hPutStr if_hdl "_usages_\n" >> - hPutCol if_hdl upp_uses (sortLt lt_imp_vers import_usages) +isOrphanModule this_mod (ModDetails {md_insts = insts, md_rules = rules}) + = any orphan_inst insts || any orphan_rule rules where - upp_uses (m, hif, mv, whats_imported) - = hsep [pprModule m, pp_hif hif, int mv, ptext SLIT("::"), - upp_import_versions whats_imported - ] <> semi - - -- Importing the whole module is indicated by an empty list - upp_import_versions Everything = empty - - -- For imported versions we do print the version number - upp_import_versions (Specifically nvs) - = hsep [ hsep [ppr_unqual_name n, int v] | (n,v) <- sort_versions nvs ] - -ifaceInstanceModules if_hdl [] = return () -ifaceInstanceModules if_hdl imods - = hPutStr if_hdl "_instance_modules_\n" >> - printForIface if_hdl (hsep (map ptext (sortLt (<) imods))) >> - hPutStr if_hdl "\n" - -ifaceExports if_hdl [] = return () -ifaceExports if_hdl avails - = hPutStr if_hdl "_exports_\n" >> - hPutCol if_hdl do_one_module (fmToList export_fm) - where - -- Sort them into groups by module - export_fm :: FiniteMap Module [AvailInfo] - export_fm = foldr insert emptyFM avails - - insert NotAvailable efm = efm - insert avail efm = addToFM_C (++) efm mod [avail] - where - mod = nameModule (availName avail) - - -- Print one module's worth of stuff - do_one_module (mod_name, avails@(avail1:_)) - = hsep [pp_hif (ifaceFlavour (availName avail1)), - pprModule mod_name, - hsep (map upp_avail (sortLt lt_avail avails)) - ] <> semi - --- The "!" indicates that the exported things came from a hi-boot interface -pp_hif HiFile = empty -pp_hif HiBootFile = char '!' - -ifaceFixities if_hdl [] = return () -ifaceFixities if_hdl fixities - = hPutStr if_hdl "_fixities_\n" >> - hPutCol if_hdl upp_fixity fixities -\end{code} - -%************************************************************************ -%* * -\subsection{Instance declarations} -%* * -%************************************************************************ - - -\begin{code} -ifaceInstances :: Handle -> Bag InstInfo -> IO IdSet -- The IdSet is the needed dfuns -ifaceInstances if_hdl inst_infos - | null togo_insts = return emptyIdSet - | otherwise = hPutStr if_hdl "_instances_\n" >> - hPutCol if_hdl pp_inst (sortLt lt_inst togo_insts) >> - return needed_ids - where - togo_insts = filter is_togo_inst (bagToList inst_infos) - needed_ids = mkIdSet [dfun_id | InstInfo _ _ _ _ _ dfun_id _ _ _ <- togo_insts] - is_togo_inst (InstInfo _ _ _ _ _ dfun_id _ _ _) = isLocallyDefined dfun_id - - ------- - lt_inst (InstInfo _ _ _ _ _ dfun_id1 _ _ _) - (InstInfo _ _ _ _ _ dfun_id2 _ _ _) - = getOccName dfun_id1 < getOccName dfun_id2 - -- The dfuns are assigned names df1, df2, etc, in order of original textual - -- occurrence, and this makes as good a sort order as any - - ------- - pp_inst (InstInfo clas tvs tys theta _ dfun_id _ _ _) - = let - forall_ty = mkSigmaTy tvs theta (mkDictTy clas tys) - renumbered_ty = nmbrGlobalType forall_ty - in - hcat [ptext SLIT("instance "), pprType renumbered_ty, - ptext SLIT(" = "), ppr_unqual_name dfun_id, semi] + orphan_inst dfun_id = no_locals (namesOfDFunHead (idType dfun_id)) + orphan_rule rule = no_locals (ruleLhsFreeNames rule) + no_locals names = isEmptyNameSet (filterNameSet (nameIsLocalOrFrom this_mod) names) \end{code} - -%************************************************************************ -%* * -\subsection{Printing values} -%* * -%************************************************************************ - \begin{code} -ifaceId :: (Id -> IdInfo) -- This function "knows" the extra info added - -- by the STG passes. Sigh - - -> IdSet -- Set of Ids that are needed by earlier interface - -- file emissions. If the Id isn't in this set, and isn't - -- exported, there's no need to emit anything - -> Bool -- True <=> recursive, so don't print unfolding - -> Id - -> CoreExpr -- The Id's right hand side - -> Maybe (SDoc, IdSet) -- The emitted stuff, plus a possibly-augmented set of needed Ids - -ifaceId get_idinfo needed_ids is_rec id rhs - | not (id `elementOfIdSet` needed_ids || -- Needed [no id in needed_ids has omitIfaceSigForId] - (isExported 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 - = Just (hsep [sig_pretty, pp_double_semi, prag_pretty], new_needed_ids) +ifaceTyCls :: TyThing -> [RenamedTyClDecl] -> [RenamedTyClDecl] +ifaceTyCls (AClass clas) so_far + = cls_decl : so_far + 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, + tcdSysNames = sys_names, + tcdLoc = noSrcLoc } + + (clas_tyvars, clas_fds, sc_theta, sc_sels, op_stuff) = classExtraBigSig clas + tycon = classTyCon clas + data_con = head (tyConDataCons tycon) + sys_names = mkClassDeclSysNames (getName tycon, getName data_con, + getName (dataConId 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) + 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 + 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 = map ifaceConDecl (tyConDataCons tycon), + tcdNCons = tyConFamilySize tycon, + tcdDerivs = Nothing, + tcdSysNames = map getName (tyConGenIds tycon), + tcdLoc = noSrcLoc } + + | otherwise = pprPanic "ifaceTyCls" (ppr tycon) + + tyvars = tyConTyVars tycon + (_, syn_ty) = getSynTyConDefn tycon + new_or_data | isNewTyCon tycon = NewType + | otherwise = DataType + + ifaceConDecl data_con + = ConDecl (getName data_con) (getName (dataConId 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 + details | null field_labels + = ASSERT( tycon == tycon1 && tyvars == tyvars1 ) + VanillaCon (zipWith mk_bang_ty strict_marks 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 (AnId id) so_far + | isImplicitId id = so_far + | otherwise = iface_sig : so_far where - pp_double_semi = ptext SLIT(";;") - idinfo = get_idinfo id - inline_pragma = inlinePragInfo idinfo + iface_sig = IfaceSig { tcdName = getName id, + tcdType = toHsType id_type, + tcdIdInfo = hs_idinfo, + tcdLoc = noSrcLoc } - ty_pretty = pprType (nmbrGlobalType (idType id)) - sig_pretty = hcat [ppr (getOccName id), ptext SLIT(" _:_ "), ty_pretty] + id_type = idType id + id_info = idInfo id + cg_info = idCgInfo id + arity_info = cgArity cg_info + caf_info = cgCafInfo cg_info - prag_pretty - | opt_OmitInterfacePragmas = empty - | otherwise = hsep [arity_pretty, strict_pretty, unfold_pretty, - spec_pretty, pp_double_semi] + hs_idinfo | opt_OmitInterfacePragmas = [] + | otherwise = arity_hsinfo ++ caf_hsinfo ++ cpr_hsinfo ++ + strict_hsinfo ++ wrkr_hsinfo ++ unfold_hsinfo ------------ Arity -------------- - arity_pretty = ppArityInfo (arityInfo idinfo) + arity_hsinfo | arity_info == 0 = [] + | otherwise = [HsArity arity_info] - ------------ Strictness -------------- - strict_info = strictnessInfo idinfo - has_worker = workerExists strict_info - strict_pretty = ppStrictnessInfo strict_info <+> wrkr_pretty + ------------ Caf Info -------------- + caf_hsinfo = case caf_info of + NoCafRefs -> [HsNoCafRefs] + otherwise -> [] - wrkr_pretty | not has_worker = empty - | null con_list = pprId work_id - | otherwise = pprId work_id <+> - braces (hsep (map (pprId) con_list)) + ------------ CPR Info -------------- + cpr_hsinfo = case cprInfo id_info of + ReturnsCPR -> [HsCprInfo] + NoCPRInfo -> [] - (work_id, wrapper_cons) = getWorkerIdAndCons id rhs - con_list = idSetToList wrapper_cons + ------------ Strictness -------------- + strict_hsinfo = case strictnessInfo id_info of + NoStrictnessInfo -> [] + info -> [HsStrictness info] + + ------------ 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) wrap_arity] + NoWorker -> [] ------------ Unfolding -------------- - unfold_pretty | show_unfold = hsep [ptext unfold_herald, pprIfaceUnfolding rhs] - | otherwise = empty - - unfold_herald = case inline_pragma of - IMustBeINLINEd -> SLIT("_U_") - IWantToBeINLINEd -> SLIT("_U_") - other -> SLIT("_u_") - - show_unfold = not implicit_unfolding && -- Not unnecessary - unfolding_is_ok -- Not dangerous - - implicit_unfolding = has_worker || - bottomIsGuaranteed strict_info - - unfolding_is_ok - = case inline_pragma of - IMustBeINLINEd -> True - IWantToBeINLINEd -> True - IDontWantToBeINLINEd -> False - IMustNotBeINLINEd -> False - NoPragmaInfo -> case guidance of - UnfoldNever -> False -- Too big - other -> True - - guidance = calcUnfoldingGuidance opt_InterfaceUnfoldThreshold rhs - - ------------ Specialisations -------------- - spec_list = specEnvToList (getIdSpecialisation id) - spec_pretty = hsep (map pp_spec spec_list) - pp_spec (tyvars, tys, rhs) = hsep [ptext SLIT("_P_"), - if null tyvars then ptext SLIT("[ ]") - else brackets (interppSP tyvars), - -- The lexer interprets "[]" as a CONID. Sigh. - hsep (map pprParendType tys), - ptext SLIT("="), - pprIfaceUnfolding rhs - ] - - ------------ Extra free Ids -------------- - new_needed_ids = (needed_ids `minusIdSet` unitIdSet id) `unionIdSets` - extra_ids - - extra_ids | opt_OmitInterfacePragmas = emptyIdSet - | otherwise = worker_ids `unionIdSets` - unfold_ids `unionIdSets` - spec_ids - - worker_ids | has_worker = unitIdSet work_id - | otherwise = emptyIdSet - - spec_ids = foldr add emptyIdSet spec_list - where - add (_, _, rhs) = unionIdSets (find_fvs rhs) - - unfold_ids | show_unfold = find_fvs rhs - | otherwise = emptyIdSet - - find_fvs expr = free_vars - where - free_vars = exprFreeVars interesting expr - interesting id = isLocallyDefined id && - not (omitIfaceSigForId id) + -- 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 = [] + | otherwise = [HsUnfold inline_prag (toUfExpr rhs)] \end{code} \begin{code} -ifaceBinds :: Handle - -> IdSet -- These Ids are needed already - -> [Id] -- Ids used at code-gen time; they have better pragma info! - -> [CoreBinding] -- In dependency order, later depend on earlier - -> IO () - -ifaceBinds hdl needed_ids final_ids binds - = mapIO (printForIface hdl) pretties >> - hPutStr hdl "\n" +ifaceInstance :: DFunId -> RenamedInstDecl +ifaceInstance dfun_id + = InstDecl (toHsType tidy_ty) EmptyMonoBinds [] (Just (getName dfun_id)) noSrcLoc where - final_id_map = listToUFM [(id,id) | id <- final_ids] - get_idinfo id = case lookupUFM final_id_map id of - Just id' -> idInfo id' - Nothing -> pprTrace "ifaceBinds not found:" (ppr id) $ - idInfo id - - pretties = go needed_ids (reverse binds) -- Reverse so that later things will - -- provoke earlier ones to be emitted - go needed [] = if not (isEmptyIdSet needed) then - pprTrace "ifaceBinds: free vars:" - (sep (map ppr (idSetToList needed))) $ - [] - else - [] - - go needed (NonRec id rhs : binds) - = case ifaceId get_idinfo needed False id rhs of - Nothing -> go needed binds - Just (pretty, needed') -> pretty : go needed' binds - - -- Recursive groups are a bit more of a pain. We may only need one to - -- start with, but it may call out the next one, and so on. So we - -- have to look for a fixed point. - go needed (Rec pairs : binds) - = pretties ++ go needed'' binds - where - (needed', pretties) = go_rec needed pairs - needed'' = needed' `minusIdSet` mkIdSet (map fst pairs) - -- Later ones may spuriously cause earlier ones to be "needed" again - - go_rec :: IdSet -> [(Id,CoreExpr)] -> (IdSet, [SDoc]) - go_rec needed pairs - | null pretties = (needed, []) - | otherwise = (final_needed, more_pretties ++ pretties) - where - reduced_pairs = [pair | (pair,Nothing) <- pairs `zip` maybes] - pretties = catMaybes maybes - (needed', maybes) = mapAccumL do_one needed pairs - (final_needed, more_pretties) = go_rec needed' reduced_pairs - - do_one needed (id,rhs) = case ifaceId get_idinfo needed True id rhs of - Nothing -> (needed, Nothing) - Just (pretty, needed') -> (needed', Just pretty) + 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 + -- from interface files that the 'gating' mechanism works properly. + -- Otherwise you could have + -- type Tibble = T Int + -- instance Foo Tibble where ... + -- and this instance decl wouldn't get imported into a module + -- that mentioned T but not Tibble. + +ifaceRule (id, BuiltinRule _) + = pprTrace "toHsRule: builtin" (ppr id) (bogusIfaceRule id) + +ifaceRule (id, Rule name bndrs args rhs) + = IfaceRule name (map toUfBndr bndrs) (getName id) + (map toUfExpr args) (toUfExpr rhs) noSrcLoc + +bogusIfaceRule id + = IfaceRule SLIT("bogus") [] (getName id) [] (UfVar (getName id)) noSrcLoc \end{code} %************************************************************************ %* * -\subsection{Random small things} +\subsection{Checking if the new interface is up to date %* * %************************************************************************ \begin{code} -ifaceTyCons hdl tycons = hPutCol hdl upp_tycon (sortLt (<) (filter (for_iface_name . getName) tycons )) -ifaceClasses hdl classes = hPutCol hdl upp_class (sortLt (<) (filter (for_iface_name . getName) classes)) +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 + 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 + -> NameEnv Fixity -> NameEnv Fixity -- 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 + -- 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 + + diff ok_so_far pp new_vers [] [] = (ok_so_far, pp, new_vers) + diff ok_so_far pp new_vers (od:ods) [] = diff False (pp $$ only_old od) new_vers ods [] + diff ok_so_far pp new_vers [] (nd:nds) = diff False (pp $$ only_new nd) new_vers_with_new [] nds + where + new_vers_with_new = extendNameEnv new_vers (tyClDeclName nd) (bumpVersion False old_mod_vers) + -- When adding a new item, start from the old module version + -- This way, if you have version 4 of f, then delete f, then add f again, + -- you'll get version 6 of f, which will (correctly) force recompilation of + -- clients + + diff ok_so_far pp new_vers (od:ods) (nd:nds) + = case od_name `compare` nd_name of + LT -> diff False (pp $$ only_old od) new_vers ods (nd:nds) + GT -> diff False (pp $$ only_new nd) new_vers (od:ods) nds + EQ | od `eq_tc` nd -> diff ok_so_far pp new_vers ods nds + | otherwise -> diff False (pp $$ changed od nd) new_vers_with_diff ods nds + where + 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} -for_iface_name name = isLocallyDefined name && - not (isWiredInName name) -upp_tycon tycon = ifaceTyCon tycon -upp_class clas = ifaceClass clas -\end{code} +%************************************************************************ +%* * +\subsection{Writing ModDetails} +%* * +%************************************************************************ \begin{code} -ifaceTyCon :: TyCon -> SDoc -ifaceTyCon tycon - | isSynTyCon tycon - = hsep [ ptext SLIT("type"), - ppr (getName tycon), - pprTyVarBndrs tyvars, - ptext SLIT("="), - ppr ty, - semi - ] +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 dfun_ids type_env + = text "TYPE SIGNATURES" $$ nest 4 (dump_sigs ids) where - (tyvars, ty) = getSynTyConDefn tycon - -ifaceTyCon tycon - | isAlgTyCon tycon - = hsep [ ptext keyword, - ppr_decl_context (tyConTheta tycon), - ppr (getName tycon), - pprTyVarBndrs (tyConTyVars tycon), - ptext SLIT("="), - hsep (punctuate (ptext SLIT(" | ")) (map ppr_con (tyConDataCons tycon))), - semi - ] + ids = [id | AnId id <- nameEnvElts type_env, want_sig id] + want_sig id | opt_PprStyle_Debug = True + | otherwise = isLocalId id && + isGlobalName (idName id) && + not (id `elem` dfun_ids) + -- isLocalId ignores data constructors, records selectors etc + -- The isGlobalName ignores local dictionary and method bindings + -- that the type checker has invented. User-defined things have + -- Global names. + +dump_insts [] = empty +dump_insts dfun_ids = text "INSTANCES" $$ nest 4 (dump_sigs dfun_ids) + +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 - keyword | isNewTyCon tycon = SLIT("newtype") - | otherwise = SLIT("data") - - ppr_con data_con - | null field_labels - = hsep [ ppr name, - hsep (map ppr_arg_ty (strict_marks `zip` arg_tys)) - ] - - | otherwise - = hsep [ ppr name, - braces $ hsep $ punctuate comma (map ppr_field (strict_marks `zip` field_labels)) - ] - where - field_labels = dataConFieldLabels data_con - arg_tys = dataConRawArgTys data_con - strict_marks = dataConStrictMarks data_con - name = getName data_con - - ppr_arg_ty (strict_mark, ty) = ppr_strict_mark strict_mark <> pprParendType ty - - ppr_strict_mark NotMarkedStrict = empty - ppr_strict_mark MarkedStrict = ptext SLIT("! ") - -- The extra space helps the lexical analyser that lexes - -- interface files; it doesn't make the rigid operator/identifier - -- distinction, so "!a" is a valid identifier so far as it is concerned - - ppr_field (strict_mark, field_label) - = hsep [ ppr (fieldLabelName field_label), - ptext SLIT("::"), - ppr_strict_mark strict_mark <> pprParendType (fieldLabelType field_label) - ] - -ifaceTyCon tycon - = pprPanic "pprIfaceTyDecl" (ppr tycon) - -ifaceClass clas - = hsep [ptext SLIT("class"), - ppr_decl_context sc_theta, - ppr clas, -- Print the name - pprTyVarBndrs clas_tyvars, - pp_ops, - semi - ] - where - (clas_tyvars, sc_theta, _, sel_ids, defms) = classBigSig clas - - pp_ops | null sel_ids = empty - | otherwise = hsep [ptext SLIT("where"), - braces (hsep (punctuate semi (zipWith ppr_classop sel_ids defms))) - ] - - ppr_classop sel_id maybe_defm - = ASSERT( sel_tyvars == clas_tyvars) - hsep [ppr (getOccName sel_id), - if maybeToBool maybe_defm then equals else empty, - ptext SLIT("::"), - ppr op_ty - ] - where - (sel_tyvars, _, op_ty) = splitSigmaTy (idType sel_id) + lt_sig (n1,_) (n2,_) = n1 < n2 + ppr_sig (n,t) = ppr n <+> dcolon <+> ppr t -ppr_decl_context :: ThetaType -> SDoc -ppr_decl_context [] = empty -ppr_decl_context theta - = braces (hsep (punctuate comma (map (ppr_dict) theta))) - <> - ptext SLIT(" =>") - where - ppr_dict (clas,tys) = ppr clas <+> hsep (map pprParendType tys) +dump_rules [] = empty +dump_rules rs = vcat [ptext SLIT("{-# RULES"), + nest 4 (vcat (map pprIdCoreRule rs)), + ptext SLIT("#-}")] \end{code} + %************************************************************************ %* * -\subsection{Random small things} +\subsection{Writing an interface file} %* * %************************************************************************ +\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 + } + where + -- Print names unqualified if they are from this module + from_this_mod n = nameModule n == this_mod + this_mod = mi_module mod_iface + +pprIface :: ModIface -> SDoc +pprIface iface + = vcat [ ptext SLIT("__interface") + <+> doubleQuotes (ptext opt_InPackage) + <+> 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)) + + , 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 + | otherwise = brackets (ppr exp_vers <+> ppr rule_vers) +\end{code} + When printing export lists, we print like this: Avail f f AvailTC C [C, x, y] C(x,y) AvailTC C [x, y] C!(x,y) -- Exporting x, y but not C \begin{code} -upp_avail NotAvailable = empty -upp_avail (Avail name) = upp_occname (getOccName name) -upp_avail (AvailTC name []) = empty -upp_avail (AvailTC name ns) = hcat [upp_occname (getOccName name), bang, upp_export ns'] - where - bang | name `elem` ns = empty - | otherwise = char '|' - ns' = filter (/= name) ns - -upp_export [] = empty -upp_export names = parens (hsep (map (upp_occname . getOccName) names)) - -upp_fixity (occ, fixity) = hcat [ppr fixity, space, upp_occname occ, semi] - -ppr_unqual_name :: NamedThing a => a -> SDoc -- Just its occurrence name -ppr_unqual_name name = upp_occname (getOccName name) +pprExport :: (ModuleName, Avails) -> SDoc +pprExport (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_export [] = empty + pp_export names = braces (hsep (map pprOcc names)) -upp_occname :: OccName -> SDoc -upp_occname occ = ptext (occNameString occ) +pprOcc :: Name -> SDoc -- Print the occurrence name only +pprOcc n = pprOccName (nameOccName n) \end{code} -%************************************************************************ -%* * -\subsection{Comparisons -%* * -%************************************************************************ - - -The various sorts above simply prevent unnecessary "wobbling" when -things change that don't have to. We therefore compare lexically, not -by unique - \begin{code} -lt_avail :: AvailInfo -> AvailInfo -> Bool - -a1 `lt_avail` a2 = availName a1 `lt_name` availName a2 - -lt_name :: Name -> Name -> Bool -n1 `lt_name` n2 = modAndOcc n1 < modAndOcc n2 +pprUsage :: ImportVersion Name -> SDoc +pprUsage (m, has_orphans, is_boot, whats_imported) + = hsep [ptext SLIT("import"), ppr m, + pp_orphan, pp_boot, + pp_versions whats_imported + ] <> semi + where + pp_orphan | has_orphans = char '!' + | otherwise = empty + pp_boot | is_boot = char '@' + | otherwise = empty -lt_lexical :: NamedThing a => a -> a -> Bool -lt_lexical a1 a2 = getName a1 `lt_name` getName a2 + -- 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 ] -lt_imp_vers :: ImportVersion a -> ImportVersion a -> Bool -lt_imp_vers (m1,_,_,_) (m2,_,_,_) = m1 < m2 + pp_export_version Nothing = empty + pp_export_version (Just v) = int v +\end{code} -sort_versions vs = sortLt lt_vers vs +\begin{code} +pprIfaceDecls version_map decls + = vcat [ vcat [ppr i <+> semi | i <- dcl_insts decls] + , vcat (map ppr_decl (dcl_tycl decls)) + ] + where + ppr_decl d = ppr_vers d <+> ppr d <> semi -lt_vers :: LocalVersion Name -> LocalVersion Name -> Bool -lt_vers (n1,v1) (n2,v2) = n1 `lt_name` n2 + -- Print the version for the decl + ppr_vers d = case lookupNameEnv version_map (tyClDeclName d) of + Nothing -> empty + Just v -> int v \end{code} - \begin{code} -hPutCol :: Handle - -> (a -> SDoc) - -> [a] - -> IO () -hPutCol hdl fmt xs = mapIO (printForIface hdl . fmt) xs - -mapIO :: (a -> IO b) -> [a] -> IO () -mapIO f [] = return () -mapIO f (x:xs) = f x >> mapIO f xs +pprFixities fixity_map decls + = hsep [ ppr fix <+> ppr n + | d <- decls, + (n,_) <- tyClDeclNames d, + Just fix <- [lookupNameEnv fixity_map n]] <> semi + +-- Disgusting to print these two together, but that's +-- the way the interface parser currently expects them. +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 (ptext txt) + DeprecSome env -> ppr_deprec_env env + +ppr_deprec_env env = vcat (punctuate semi (map pp_deprec (nameEnvElts env))) + where + pp_deprec (name, txt) = pprOcc name <+> doubleQuotes (ptext txt) \end{code}