%
-% (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}
-#include "HsVersions.h"
-
-module MkIface (
- startIface, endIface,
- ifaceMain,
- ifaceDecls
- ) where
+module MkIface (
+ showIface, mkIface, mkUsageInfo,
+ pprIface,
+ ifaceTyThing,
+ ) where
-IMP_Ubiq(){-uitous-}
-IMPORT_1_3(IO(Handle,hPutStr,openFile,hClose,IOMode(..)))
+#include "HsVersions.h"
import HsSyn
-import RdrHsSyn ( RdrName(..) )
-import RnHsSyn ( SYN_IE(RenamedHsModule) )
-import RnMonad
-
-import TcInstUtil ( InstInfo(..) )
-
-import CmdLineOpts
-import Id ( idType, dataConRawArgTys, dataConFieldLabels, isDataCon,
- getIdInfo, idWantsToBeINLINEd, omitIfaceSigForId,
- dataConStrictMarks, StrictnessMark(..),
- SYN_IE(IdSet), idSetToList, unionIdSets, unitIdSet, minusIdSet,
- isEmptyIdSet, elementOfIdSet, emptyIdSet, mkIdSet,
- GenId{-instance NamedThing/Outputable-}
- )
-import IdInfo ( StrictnessInfo, ArityInfo, Unfolding,
- arityInfo, ppArityInfo, strictnessInfo, ppStrictnessInfo,
- getWorkerId_maybe, bottomIsGuaranteed
+import HsCore ( HsIdInfo(..), UfExpr(..), toUfExpr, toUfBndr )
+import HsTypes ( toHsTyVars )
+import TysPrim ( alphaTyVars )
+import BasicTypes ( NewOrData(..), Activation(..), FixitySig(..),
+ Version, initialVersion, bumpVersion
)
-import CoreSyn ( SYN_IE(CoreExpr), SYN_IE(CoreBinding), GenCoreExpr, GenCoreBinding(..) )
-import CoreUnfold ( calcUnfoldingGuidance, UnfoldingGuidance(..) )
-import FreeVars ( addExprFVs )
-import Name ( isLocallyDefined, isWiredInName, modAndOcc, getName, pprOccName,
- OccName, occNameString, nameOccName, nameString, isExported, pprNonSym,
- Name {-instance NamedThing-}, Provenance
+import NewDemand ( isTopSig )
+import TcRnMonad
+import TcRnTypes ( ImportAvails(..) )
+import RnHsSyn ( RenamedInstDecl, RenamedTyClDecl )
+import HscTypes ( VersionInfo(..), ModIface(..),
+ ModGuts(..), ModGuts,
+ GhciMode(..), HscEnv(..), Dependencies(..),
+ FixityEnv, lookupFixity, collectFixities,
+ IfaceDecls, mkIfaceDecls, dcl_tycl, dcl_rules, dcl_insts,
+ TyThing(..), DFunId,
+ Avails, AvailInfo, GenAvailInfo(..), availName,
+ ExternalPackageState(..),
+ ParsedIface(..), Usage(..),
+ Deprecations(..), initialVersionInfo,
+ lookupVersion, lookupIfaceByModName
)
-import TyCon ( TyCon(..){-instance NamedThing-}, NewOrData(..) )
-import Class ( GenClass(..){-instance NamedThing-}, GenClassOp, classOpLocalType )
-import FieldLabel ( FieldLabel{-instance NamedThing-} )
-import Type ( mkSigmaTy, mkDictTy, getAppTyCon, splitForAllTy )
-import TyVar ( GenTyVar {- instance Eq -} )
-import Unique ( Unique {- instance Eq -} )
-
-import PprEnv -- not sure how much...
-import PprStyle ( PprStyle(..) )
-import PprType
-import PprCore ( pprIfaceUnfolding )
-import Pretty
-import Unpretty -- ditto
-
-
-import Bag ( bagToList )
-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,
- assertPanic, panic{-ToDo:rm-}, pprTrace )
+import CmdLineOpts
+import Id ( idType, idInfo, isImplicitId, idCgInfo )
+import DataCon ( dataConSig, dataConFieldLabels, dataConStrictMarks )
+import IdInfo -- Lots
+import CoreSyn ( CoreRule(..), IdCoreRule )
+import CoreFVs ( ruleLhsFreeNames )
+import CoreUnfold ( neverUnfold, unfoldingTemplate )
+import Name ( getName, nameModule, nameModule_maybe, nameOccName,
+ nameIsLocalOrFrom, Name, NamedThing(..) )
+import NameEnv
+import NameSet
+import OccName ( OccName, pprOccName )
+import TyCon ( DataConDetails(..), tyConTyVars, tyConDataCons, tyConTheta,
+ isFunTyCon, isPrimTyCon, isNewTyCon, isClassTyCon,
+ isSynTyCon, isAlgTyCon, isForeignTyCon,
+ getSynTyConDefn, tyConGenInfo, tyConDataConDetails, tyConArity )
+import Class ( classExtraBigSig, classTyCon, DefMeth(..) )
+import FieldLabel ( fieldLabelType )
+import TcType ( tcSplitForAllTys, tcFunResultTy, tidyTopType, deNoteType, tyClsNamesOfDFunHead )
+import SrcLoc ( noSrcLoc )
+import Module ( Module, ModuleName, moduleNameFS, moduleName, isHomeModule,
+ ModLocation(..), mkSysModuleNameFS,
+ ModuleEnv, emptyModuleEnv, lookupModuleEnv,
+ extendModuleEnv_C, moduleEnvElts
+ )
+import Outputable
+import Util ( sortLt, dropList, seqList )
+import Binary ( getBinFileWithDict )
+import BinIface ( writeBinIface )
+import ErrUtils ( dumpIfSet_dyn )
+import FiniteMap
+import FastString
+
+import Monad ( when )
+import Maybe ( catMaybes, isJust, isNothing )
+import Maybes ( orElse )
+import IO ( putStrLn )
\end{code}
-We have a function @startIface@ to open the output file and put
-(something like) ``interface Foo'' in it. It gives back a handle
-for subsequent additions to the interface file.
-We then have one-function-per-block-of-interface-stuff, e.g.,
-@ifaceExportList@ produces the @__exports__@ section; it appends
-to the handle provided by @startIface@.
+%************************************************************************
+%* *
+\subsection{Print out the contents of a binary interface}
+%* *
+%************************************************************************
\begin{code}
-startIface :: Module
- -> IO (Maybe Handle) -- Nothing <=> don't do an interface
-
-ifaceMain :: Maybe Handle
- -> InterfaceDetails
- -> IO ()
+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_deps=pi_deps,
+ pi_orphan=pi_orphan, pi_usages=pi_usages,
+ pi_exports=pi_exports, pi_decls=pi_decls,
+ pi_fixity=pi_fixity, pi_insts=pi_insts,
+ pi_rules=pi_rules, pi_deprecs=pi_deprecs } = parsed_iface
+ putStrLn (showSDoc (vcat [
+ text "__interface" <+> doubleQuotes (ppr pi_pkg)
+ <+> ppr pi_mod <+> ppr pi_vers
+ <+> (if pi_orphan then char '!' else empty)
+ <+> ptext SLIT("where"),
+ -- no instance Outputable (WhatsImported):
+ pprExports id (snd pi_exports),
+ pprDeps pi_deps,
+ pprUsages id pi_usages,
+ hsep (map ppr_fix pi_fixity) <> semi,
+ vcat (map ppr_inst pi_insts),
+ vcat (map ppr_decl pi_decls),
+ ppr pi_rules
+ -- no instance Outputable (Either):
+ -- ppr pi_deprecs
+ ]))
+ where
+ ppr_fix (FixitySig n f _) = ppr f <+> ppr n
+ ppr_inst i = ppr i <+> semi
+ ppr_decl (v,d) = int v <+> ppr d <> semi
+\end{code}
+%************************************************************************
+%* *
+\subsection{Completing an interface}
+%* *
+%************************************************************************
-ifaceDecls :: Maybe Handle
- -> RenamedHsModule
- -> Bag InstInfo
- -> [Id] -- Ids used at code-gen time; they have better pragma info!
- -> [CoreBinding] -- In dependency order, later depend on earlier
- -> IO ()
+\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_deps = deps,
+ mg_exports = exports,
+ mg_rdr_env = rdr_env,
+ mg_fix_env = fix_env,
+ mg_deprecs = deprecs,
+ mg_insts = insts,
+ mg_rules = rules,
+ mg_types = types }
+ = do { -- Sort the exports to make them easier to compare for versions
+ let { my_exports = groupAvails this_mod exports ;
+
+ iface_w_decls = ModIface { mi_module = this_mod,
+ mi_package = opt_InPackage,
+ mi_version = initialVersionInfo,
+ mi_deps = deps,
+ mi_usages = usages,
+ mi_exports = my_exports,
+ mi_decls = new_decls,
+ mi_orphan = orphan_mod,
+ mi_boot = False,
+ mi_fixities = fix_env,
+ mi_globals = Just rdr_env,
+ mi_deprecs = deprecs } }
+
+ -- Add version information
+ ; let (final_iface, maybe_diffs) = _scc_ "versioninfo" addVersionInfo maybe_old_iface iface_w_decls
+
+ -- Write the interface file, if necessary
+ ; when (must_write_hi_file maybe_diffs)
+ (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 }
-endIface :: Maybe Handle -> IO ()
+ where
+ dflags = hsc_dflags hsc_env
+ ghci_mode = hsc_mode hsc_env
+
+ must_write_hi_file Nothing = False
+ must_write_hi_file (Just _diffs) = ghci_mode /= Interactive
+ -- We must write a new .hi file if there are some changes
+ -- and we're not in interactive mode
+ -- maybe_diffs = 'Nothing' means that even the usages havn't changed,
+ -- so there's no need to write a new interface file. But even if
+ -- the usages have changed, the module version may not have.
+
+ hi_file_path = ml_hi_file location
+ new_decls = mkIfaceDecls ty_cls_dcls rule_dcls inst_dcls
+ inst_dcls = map ifaceInstance insts
+ ty_cls_dcls = foldNameEnv ifaceTyThing_acc [] types
+ rule_dcls = map ifaceRule rules
+ orphan_mod = isOrphanModule impl
+
+write_diffs :: DynFlags -> ModIface -> Maybe SDoc -> IO ()
+write_diffs dflags new_iface Nothing
+ = do when (dopt Opt_D_dump_hi_diffs dflags) (printDump (text "INTERFACE UNCHANGED"))
+ dumpIfSet_dyn dflags Opt_D_dump_hi "UNCHANGED FINAL INTERFACE" (pprIface new_iface)
+
+write_diffs dflags new_iface (Just sdoc_diffs)
+ = do dumpIfSet_dyn dflags Opt_D_dump_hi_diffs "INTERFACE HAS CHANGED" sdoc_diffs
+ dumpIfSet_dyn dflags Opt_D_dump_hi "NEW FINAL INTERFACE" (pprIface new_iface)
\end{code}
\begin{code}
-startIface mod
- = case opt_ProduceHi of
- Nothing -> return Nothing -- not producing any .hi file
- Just fn ->
- openFile fn WriteMode >>= \ if_hdl ->
- hPutStr if_hdl ("{-# GHC_PRAGMA INTERFACE VERSION 20 #-}\n_interface_ "++ _UNPK_ mod ++ "\n") >>
- return (Just if_hdl)
-
-endIface Nothing = return ()
-endIface (Just if_hdl) = hPutStr if_hdl "\n" >> hClose if_hdl
+isOrphanModule :: ModGuts -> Bool
+isOrphanModule (ModGuts {mg_module = this_mod, mg_insts = insts, mg_rules = rules})
+ = any orphan_inst insts || any orphan_rule rules
+ where
+ -- 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)
+
+ 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}
-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 rn_mod inst_info final_ids simplified = return ()
-ifaceDecls (Just hdl)
- (HsModule _ _ _ _ _ decls _)
- 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" >>
- ifaceTCDecls hdl decls >>
- ifaceBinds hdl needed_ids final_ids binds >>
- return ()
+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}
-ifaceUsages if_hdl import_usages
- = hPutStr if_hdl "_usages_\n" >>
- hPutCol if_hdl upp_uses (sortLt lt_imp_vers import_usages)
+ifaceTyThing :: TyThing -> RenamedTyClDecl
+ifaceTyThing (AClass clas) = cls_decl
where
- upp_uses (m, mv, versions)
- = uppBesides [upp_module m, uppSP, uppInt mv, uppPStr SLIT(" :: "),
- upp_import_versions (sort_versions versions), uppSemi]
-
- -- For imported versions we do print the version number
- upp_import_versions nvs
- = uppIntersperse uppSP [ uppCat [ppr_unqual_name n, uppInt v] | (n,v) <- nvs ]
-
-
-ifaceInstanceModules if_hdl [] = return ()
-ifaceInstanceModules if_hdl imods
- = hPutStr if_hdl "_instance_modules_\n" >>
- hPutStr if_hdl (uppShow 0 (uppCat (map uppPStr 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)
+ cls_decl = ClassDecl { tcdCtxt = toHsContext sc_theta,
+ tcdName = getName clas,
+ tcdTyVars = toHsTyVars clas_tyvars,
+ tcdFDs = toHsFDs clas_fds,
+ tcdSigs = map toClassOpSig op_stuff,
+ tcdMeths = Nothing,
+ tcdLoc = noSrcLoc }
+
+ (clas_tyvars, clas_fds, sc_theta, sc_sels, op_stuff) = classExtraBigSig clas
+ tycon = classTyCon clas
+ data_con = head (tyConDataCons tycon)
+
+ toClassOpSig (sel_id, def_meth)
+ = ASSERT(sel_tyvars == clas_tyvars)
+ ClassOpSig (getName sel_id) def_meth' (toHsType op_ty) noSrcLoc
+ where
+ -- Be careful when splitting the type, because of things
+ -- like class Foo a where
+ -- op :: (?x :: String) => a -> a
+ -- and class Baz a where
+ -- op :: (Ord a) => a -> a
+ (sel_tyvars, rho_ty) = tcSplitForAllTys (idType sel_id)
+ op_ty = tcFunResultTy rho_ty
+ def_meth' = case def_meth of
+ NoDefMeth -> NoDefMeth
+ GenDefMeth -> GenDefMeth
+ DefMeth id -> DefMeth (getName id)
+
+ifaceTyThing (ATyCon tycon) = ty_decl
where
- -- Sort them into groups by module
- export_fm :: FiniteMap Module [AvailInfo]
- export_fm = foldr insert emptyFM avails
- insert avail@(Avail name _) efm = addToFM_C (++) efm mod [avail]
- where
- (mod,_) = modAndOcc name
- insert NotAvailable efm = efm
-
- -- Print one module's worth of stuff
- do_one_module (mod_name, avails)
- = uppBesides [upp_module mod_name, uppSP,
- uppCat (map upp_avail (sortLt lt_avail avails)),
- uppSemi]
-
-ifaceFixities if_hdl [] = return ()
-ifaceFixities if_hdl fixities
- = hPutStr if_hdl "_fixities_\n" >>
- hPutCol if_hdl upp_fixity fixities
-
-ifaceTCDecls if_hdl decls
- = hPutCol if_hdl ppr_decl tc_decls_for_iface
+ ty_decl | isSynTyCon tycon
+ = TySynonym { tcdName = getName tycon,
+ tcdTyVars = toHsTyVars tyvars,
+ tcdSynRhs = toHsType syn_ty,
+ tcdLoc = noSrcLoc }
+
+ | isAlgTyCon tycon
+ = TyData { tcdND = new_or_data,
+ tcdCtxt = toHsContext (tyConTheta tycon),
+ tcdName = getName tycon,
+ tcdTyVars = toHsTyVars tyvars,
+ tcdCons = ifaceConDecls (tyConDataConDetails tycon),
+ tcdDerivs = Nothing,
+ tcdGeneric = Just (isJust (tyConGenInfo tycon)),
+ -- Just True <=> has generic stuff
+ tcdLoc = noSrcLoc }
+
+ | isForeignTyCon tycon
+ = ForeignType { tcdName = getName tycon,
+ tcdExtName = Nothing,
+ tcdFoType = DNType, -- The only case at present
+ tcdLoc = noSrcLoc }
+
+ | isPrimTyCon tycon || isFunTyCon tycon
+ -- needed in GHCi for ':info Int#', for example
+ = TyData { tcdND = DataType,
+ tcdCtxt = [],
+ tcdName = getName tycon,
+ tcdTyVars = toHsTyVars (take (tyConArity tycon) alphaTyVars),
+ tcdCons = Unknown,
+ tcdDerivs = Nothing,
+ tcdGeneric = Just False,
+ tcdLoc = noSrcLoc }
+
+ | otherwise = pprPanic "ifaceTyThing" (ppr tycon)
+
+ tyvars = tyConTyVars tycon
+ (_, syn_ty) = getSynTyConDefn tycon
+ new_or_data | isNewTyCon tycon = NewType
+ | otherwise = DataType
+
+ ifaceConDecls Unknown = Unknown
+ ifaceConDecls (HasCons n) = HasCons n
+ ifaceConDecls (DataCons cs) = DataCons (map ifaceConDecl cs)
+
+ ifaceConDecl data_con
+ = ConDecl (getName data_con)
+ (toHsTyVars ex_tyvars)
+ (toHsContext ex_theta)
+ details noSrcLoc
+ where
+ (tyvars1, _, ex_tyvars, ex_theta, arg_tys, tycon1) = dataConSig data_con
+ field_labels = dataConFieldLabels data_con
+ strict_marks = dropList ex_theta (dataConStrictMarks data_con)
+ -- The 'drop' is because dataConStrictMarks
+ -- includes the existential dictionaries
+ details | null field_labels
+ = ASSERT( tycon == tycon1 && tyvars == tyvars1 )
+ PrefixCon (zipWith BangType strict_marks (map toHsType arg_tys))
+
+ | otherwise
+ = RecCon (zipWith mk_field strict_marks field_labels)
+
+ mk_field strict_mark field_label
+ = (getName field_label, BangType strict_mark (toHsType (fieldLabelType field_label)))
+
+ifaceTyThing (AnId id) = iface_sig
where
- tc_decls_for_iface = sortLt lt_decl (filter for_iface decls)
- for_iface decl@(ClD _) = for_iface_name (hsDeclName decl)
- for_iface decl@(TyD _) = for_iface_name (hsDeclName decl)
- for_iface other_decl = False
+ iface_sig = IfaceSig { tcdName = getName id,
+ tcdType = toHsType id_type,
+ tcdIdInfo = hs_idinfo,
+ tcdLoc = noSrcLoc }
+
+ id_type = idType id
+ id_info = idInfo id
+ cg_info = idCgInfo id
+ arity_info = arityInfo id_info
+ caf_info = cgCafInfo cg_info
+
+ hs_idinfo | opt_OmitInterfacePragmas
+ = []
+ | otherwise
+ = catMaybes [arity_hsinfo, caf_hsinfo,
+ strict_hsinfo, wrkr_hsinfo,
+ unfold_hsinfo]
- for_iface_name name = isLocallyDefined name &&
- not (isWiredInName name)
+ ------------ Arity --------------
+ arity_hsinfo | arity_info == 0 = Nothing
+ | otherwise = Just (HsArity arity_info)
- lt_decl d1 d2 = hsDeclName d1 < hsDeclName d2
-\end{code}
-
-%************************************************************************
-%* *
-\subsection{Instance declarations}
-%* *
-%************************************************************************
+ ------------ Caf Info --------------
+ caf_hsinfo = case caf_info of
+ NoCafRefs -> Just HsNoCafRefs
+ _other -> Nothing
+ ------------ Strictness --------------
+ -- No point in explicitly exporting TopSig
+ strict_hsinfo = case newStrictnessInfo id_info of
+ Just sig | not (isTopSig sig) -> Just (HsStrictness sig)
+ _other -> Nothing
+
+ ------------ Worker --------------
+ work_info = workerInfo id_info
+ has_worker = case work_info of { HasWorker _ _ -> True; other -> False }
+ wrkr_hsinfo = case work_info of
+ HasWorker work_id wrap_arity ->
+ Just (HsWorker (getName work_id) wrap_arity)
+ NoWorker -> Nothing
-\begin{code}
-ifaceInstances :: Handle -> Bag InstInfo -> IO IdSet -- The IdSet is the needed dfuns
-ifaceInstances if_hdl inst_infos
- | null togo_insts = return 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 ty theta _ dfun_id _ _ _)
- = let
- forall_ty = mkSigmaTy tvs theta (mkDictTy clas ty)
- renumbered_ty = renumber_ty forall_ty
- in
- uppBesides [uppPStr SLIT("instance "), ppr_ty renumbered_ty,
- uppPStr SLIT(" = "), ppr_unqual_name dfun_id, uppSemi]
+ ------------ Unfolding --------------
+ -- The unfolding is redundant if there is a worker
+ unfold_info = unfoldingInfo id_info
+ inline_prag = inlinePragInfo id_info
+ rhs = unfoldingTemplate unfold_info
+ unfold_hsinfo | neverUnfold unfold_info
+ || has_worker = Nothing
+ | otherwise = Just (HsUnfold inline_prag (toUfExpr rhs))
\end{code}
-
-%************************************************************************
-%* *
-\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 (Pretty, 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 (ppCat [sig_pretty, prag_pretty, ppStr ";;"], new_needed_ids)
+ifaceInstance :: DFunId -> RenamedInstDecl
+ifaceInstance dfun_id
+ = InstDecl (toHsType tidy_ty) EmptyMonoBinds [] (Just (getName dfun_id)) noSrcLoc
where
- idinfo = get_idinfo id
- inline_pragma = idWantsToBeINLINEd id
-
- ty_pretty = pprType PprInterface (initNmbr (nmbrType (idType id)))
- sig_pretty = ppBesides [ppr PprInterface (getOccName id), ppPStr SLIT(" :: "), ty_pretty]
-
- prag_pretty | opt_OmitInterfacePragmas = ppNil
- | otherwise = ppCat [arity_pretty, strict_pretty, unfold_pretty]
-
- ------------ Arity --------------
- arity_pretty = ppArityInfo PprInterface (arityInfo idinfo)
-
- ------------ Strictness --------------
- strict_info = strictnessInfo idinfo
- maybe_worker = getWorkerId_maybe strict_info
- strict_pretty = ppStrictnessInfo PprInterface strict_info
-
- ------------ Unfolding --------------
- unfold_pretty | show_unfold = ppCat [ppStr "_U_", pprIfaceUnfolding rhs]
- | otherwise = ppNil
-
- show_unfold = not implicit_unfolding && -- Unnecessary
- (inline_pragma || not dodgy_unfolding) -- Dangerous
+ 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 :: IdCoreRule -> RuleDecl Name
+ifaceRule (id, BuiltinRule _ _)
+ = pprTrace "toHsRule: builtin" (ppr id) (bogusIfaceRule 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 FSLIT("bogus") NeverActive [] (getName id) [] (UfVar (getName id)) noSrcLoc
+\end{code}
- implicit_unfolding = maybeToBool maybe_worker ||
- bottomIsGuaranteed strict_info
- dodgy_unfolding = is_rec || -- No recursive unfoldings please!
- case guidance of -- Too big to show
- UnfoldNever -> True
- other -> False
+%*********************************************************
+%* *
+\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 <n> ;
+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.]
- guidance = calcUnfoldingGuidance inline_pragma
- opt_InterfaceUnfoldThreshold
- rhs
+\begin{code}
+mkUsageInfo :: HscEnv -> ExternalPackageState
+ -> ImportAvails -> EntityUsage
+ -> [Usage Name]
+
+mkUsageInfo hsc_env eps
+ (ImportAvails { imp_mods = dir_imp_mods,
+ imp_dep_mods = dep_mods })
+ used_names
+ = -- seq the list of Usages returned: occasionally these
+ -- don't get evaluated for a while and we can end up hanging on to
+ -- the entire collection of Ifaces.
+ usages `seqList` usages
+ where
+ usages = catMaybes [ mkUsage mod_name
+ | (mod_name,_) <- moduleEnvElts dep_mods]
+ hpt = hsc_HPT hsc_env
+ pit = eps_PIT eps
+
+ import_all mod = case lookupModuleEnv dir_imp_mods mod of
+ Just (_,imp_all) -> imp_all
+ Nothing -> False
+
+ -- ent_map groups together all the things imported and used
+ -- from a particular module in this package
+ ent_map :: ModuleEnv [Name]
+ ent_map = foldNameSet add_mv emptyModuleEnv used_names
+ add_mv name mv_map = extendModuleEnv_C add_item mv_map mod [name]
+ where
+ mod = nameModule name
+ add_item names _ = name:names
- ------------ 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
-
- worker_ids = case maybe_worker of
- Just wkr -> unitIdSet wkr
- Nothing -> emptyIdSet
-
- unfold_ids | show_unfold = free_vars
- | otherwise = emptyIdSet
- where
- (_,free_vars) = addExprFVs interesting emptyIdSet rhs
- interesting bound id = isLocallyDefined id &&
- not (id `elementOfIdSet` bound) &&
- not (omitIfaceSigForId id)
+ -- We want to create a Usage for a home module if
+ -- a) we used something from; has something in used_names
+ -- b) we imported all of it, even if we used nothing from it
+ -- (need to recompile if its export list changes: export_vers)
+ -- c) is a home-package orphan module (need to recompile if its
+ -- instance decls change: rules_vers)
+ mkUsage :: ModuleName -> Maybe (Usage Name)
+ mkUsage mod_name
+ | isNothing maybe_iface -- We can't depend on it if we didn't
+ || not (isHomeModule mod) -- even open the interface!
+ || (null used_names
+ && not all_imported
+ && not orphan_mod)
+ = Nothing -- Record no usage info
+
+ | otherwise
+ = Just (Usage { usg_name = moduleName mod,
+ usg_mod = mod_vers,
+ usg_exports = export_vers,
+ usg_entities = ent_vers,
+ usg_rules = rules_vers })
+ where
+ maybe_iface = lookupIfaceByModName hpt pit mod_name
+ -- In one-shot mode, the interfaces for home-package
+ -- modules accumulate in the PIT not HPT. Sigh.
+
+ Just iface = maybe_iface
+ mod = mi_module iface
+ version_info = mi_version iface
+ orphan_mod = mi_orphan iface
+ version_env = vers_decls version_info
+ mod_vers = vers_module version_info
+ rules_vers = vers_rules version_info
+ all_imported = import_all mod
+ export_vers | all_imported = Just (vers_exports version_info)
+ | otherwise = Nothing
+
+ -- The sort is to put them into canonical order
+ used_names = lookupModuleEnv ent_map mod `orElse` []
+ ent_vers = [(n, lookupVersion version_env n)
+ | n <- sortLt lt_occ used_names ]
+ lt_occ n1 n2 = nameOccName n1 < nameOccName n2
\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
- = hPutStr hdl (uppShow 0 (prettyToUn (ppAboves pretties))) >>
- hPutStr hdl "\n"
+groupAvails :: Module -> Avails -> [(ModuleName, Avails)]
+ -- Group by module and sort by occurrence
+ -- This keeps the list in canonical order
+groupAvails this_mod avails
+ = [ (mkSysModuleNameFS fs, sortLt lt avails)
+ | (fs,avails) <- fmToList groupFM
+ ]
where
- final_id_map = listToUFM [(id,id) | id <- final_ids]
- get_idinfo id = case lookupUFM final_id_map id of
- Just id' -> getIdInfo id'
- Nothing -> pprTrace "ifaceBinds not found:" (ppr PprDebug id) $
- getIdInfo 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:"
- (ppSep (map (ppr PprDebug) (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, [Pretty])
- 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)
+ groupFM :: FiniteMap FastString Avails
+ -- Deliberately use the FastString so we
+ -- get a canonical ordering
+ groupFM = foldl add emptyFM avails
+
+ add env avail = addToFM_C combine env mod_fs [avail']
+ where
+ mod_fs = moduleNameFS (moduleName avail_mod)
+ avail_mod = case nameModule_maybe (availName avail) of
+ Just m -> m
+ Nothing -> this_mod
+ combine old _ = avail':old
+ avail' = sortAvail avail
+
+ a1 `lt` a2 = occ1 < occ2
+ where
+ occ1 = nameOccName (availName a1)
+ occ2 = nameOccName (availName a2)
+
+sortAvail :: AvailInfo -> AvailInfo
+-- Sort the sub-names into canonical order.
+-- The canonical order has the "main name" at the beginning
+-- (if it's there at all)
+sortAvail (Avail n) = Avail n
+sortAvail (AvailTC n ns) | n `elem` ns = AvailTC n (n : sortLt lt (filter (/= n) ns))
+ | otherwise = AvailTC n ( sortLt lt ns)
+ where
+ n1 `lt` n2 = nameOccName n1 < nameOccName n2
\end{code}
-
%************************************************************************
%* *
-\subsection{Random small things}
+\subsection{Checking if the new interface is up to date
%* *
%************************************************************************
-
-\begin{code}
-upp_avail NotAvailable = uppNil
-upp_avail (Avail name ns) = uppBesides [upp_occname (getOccName name), upp_export ns]
-upp_export [] = uppNil
-upp_export names = uppBesides [uppStr "(",
- uppIntersperse uppSP (map (upp_occname . getOccName) names),
- uppStr ")"]
+\begin{code}
+addVersionInfo :: Maybe ModIface -- The old interface, read from M.hi
+ -> ModIface -- The new interface decls
+ -> (ModIface, Maybe SDoc) -- Nothing => no change; no need to write new Iface
+ -- Just mi => Here is the new interface to write
+ -- with correct version numbers
+
+-- NB: the fixities, declarations, rules are all assumed
+-- to be sorted by increasing order of hsDeclName, so that
+-- we can compare for equality
+
+addVersionInfo Nothing new_iface
+-- No old interface, so definitely write a new one!
+ = (new_iface, Just (text "No old interface available"))
+
+addVersionInfo (Just old_iface@(ModIface { mi_version = old_version,
+ mi_decls = old_decls,
+ mi_fixities = old_fixities,
+ mi_deprecs = old_deprecs }))
+ new_iface@(ModIface { mi_decls = new_decls,
+ mi_fixities = new_fixities,
+ mi_deprecs = new_deprecs })
+
+ | no_output_change && no_usage_change
+ = (new_iface, Nothing)
+ -- don't return the old iface because it may not have an
+ -- mi_globals field set to anything reasonable.
+
+ | otherwise -- Add updated version numbers
+ = --pprTrace "completeIface" (ppr (dcl_tycl old_decls))
+ (final_iface, Just pp_diffs)
+
+ where
+ final_iface = new_iface { mi_version = new_version }
+ old_mod_vers = vers_module old_version
+ new_version = VersionInfo { vers_module = bumpVersion no_output_change old_mod_vers,
+ vers_exports = bumpVersion no_export_change (vers_exports old_version),
+ vers_rules = bumpVersion no_rule_change (vers_rules old_version),
+ vers_decls = tc_vers }
+
+ no_output_change = no_tc_change && no_rule_change && no_export_change && no_deprec_change
+ no_usage_change = mi_usages old_iface == mi_usages new_iface
+
+ no_export_change = mi_exports old_iface == mi_exports new_iface -- Kept sorted
+ no_rule_change = dcl_rules old_decls == dcl_rules new_decls -- Ditto
+ && dcl_insts old_decls == dcl_insts new_decls
+ no_deprec_change = old_deprecs == new_deprecs
+
+ -- Fill in the version number on the new declarations by looking at the old declarations.
+ -- Set the flag if anything changes.
+ -- Assumes that the decls are sorted by hsDeclName.
+ (no_tc_change, pp_tc_diffs, tc_vers) = diffDecls old_version old_fixities new_fixities
+ (dcl_tycl old_decls) (dcl_tycl new_decls)
+ pp_diffs = vcat [pp_tc_diffs,
+ pp_change no_export_change "Export list",
+ pp_change no_rule_change "Rules",
+ pp_change no_deprec_change "Deprecations",
+ pp_change no_usage_change "Usages"]
+ pp_change True what = empty
+ pp_change False what = text what <+> ptext SLIT("changed")
+
+diffDecls :: VersionInfo -- Old version
+ -> FixityEnv -> FixityEnv -- Old and new fixities
+ -> [RenamedTyClDecl] -> [RenamedTyClDecl] -- Old and new decls
+ -> (Bool, -- True <=> no change
+ SDoc, -- Record of differences
+ NameEnv Version) -- New version map
+
+diffDecls (VersionInfo { vers_module = old_mod_vers, vers_decls = old_decls_vers })
+ old_fixities new_fixities old new
+ = diff True empty emptyNameEnv old new
+ where
+ -- When seeing if two decls are the same,
+ -- remember to check whether any relevant fixity has changed
+ eq_tc d1 d2 = d1 == d2 && all (same_fixity . fst) (tyClDeclNames d1)
+ same_fixity n = lookupFixity old_fixities n == lookupFixity new_fixities n
+
+ diff ok_so_far pp new_vers [] [] = (ok_so_far, pp, new_vers)
+ diff ok_so_far pp new_vers (od:ods) [] = diff False (pp $$ only_old od) new_vers ods []
+ diff ok_so_far pp new_vers [] (nd:nds) = diff False (pp $$ only_new nd) new_vers_with_new [] nds
+ where
+ new_vers_with_new = extendNameEnv new_vers (tyClDeclName nd) (bumpVersion False old_mod_vers)
+ -- When adding a new item, start from the old module version
+ -- This way, if you have version 4 of f, then delete f, then add f again,
+ -- you'll get version 6 of f, which will (correctly) force recompilation of
+ -- clients
+
+ diff ok_so_far pp new_vers (od:ods) (nd:nds)
+ = case od_name `compare` nd_name of
+ LT -> diff False (pp $$ only_old od) new_vers ods (nd:nds)
+ GT -> diff False (pp $$ only_new nd) new_vers (od:ods) nds
+ EQ | od `eq_tc` nd -> diff ok_so_far pp new_vers ods nds
+ | otherwise -> diff False (pp $$ changed od nd) new_vers_with_diff ods nds
+ where
+ 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}
-upp_fixity (occ, (Fixity prec dir, prov)) = uppBesides [upp_dir dir, uppSP,
- uppInt prec, uppSP,
- upp_occname occ, uppSemi]
-upp_dir InfixR = uppStr "infixr"
-upp_dir InfixL = uppStr "infixl"
-upp_dir InfixN = uppStr "infix"
-ppr_unqual_name :: NamedThing a => a -> Unpretty -- Just its occurrence name
-ppr_unqual_name name = upp_occname (getOccName name)
+b%************************************************************************
+%* *
+\subsection{Writing an interface file}
+%* *
+%************************************************************************
-ppr_name :: NamedThing a => a -> Unpretty -- Its full name
-ppr_name n = uppPStr (nameString (getName n))
+\begin{code}
+pprIface :: ModIface -> SDoc
+pprIface iface
+ = vcat [ ptext SLIT("__interface")
+ <+> doubleQuotes (ftext (mi_package iface))
+ <+> ppr (mi_module iface) <+> ppr (vers_module version_info)
+ <+> pp_sub_vers
+ <+> (if mi_orphan iface then char '!' else empty)
+ <+> int opt_HiVersion
+ <+> ptext SLIT("where")
+
+ , pprExports nameOccName (mi_exports iface)
+ , pprDeps (mi_deps iface)
+ , pprUsages nameOccName (mi_usages iface)
+
+ , pprFixities (mi_fixities iface) (dcl_tycl decls)
+ , pprIfaceDecls (vers_decls version_info) decls
+ , pprRulesAndDeprecs (dcl_rules decls) (mi_deprecs iface)
+ ]
+ where
+ version_info = mi_version iface
+ decls = mi_decls iface
+ exp_vers = vers_exports version_info
-upp_occname :: OccName -> Unpretty
-upp_occname occ = uppPStr (occNameString occ)
+ rule_vers = vers_rules version_info
-upp_module :: Module -> Unpretty
-upp_module mod = uppPStr mod
+ pp_sub_vers | exp_vers == initialVersion && rule_vers == initialVersion = empty
+ | otherwise = brackets (ppr exp_vers <+> ppr rule_vers)
+\end{code}
-uppSemid x = uppBeside (prettyToUn (ppr PprInterface x)) uppSemi -- micro util
+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
-ppr_ty ty = prettyToUn (pprType PprInterface ty)
-ppr_tyvar tv = prettyToUn (ppr PprInterface tv)
-ppr_tyvar_bndr tv = prettyToUn (pprTyVarBndr PprInterface tv)
+\begin{code}
+pprExports :: Eq a => (a -> OccName) -> [(ModuleName, [GenAvailInfo a])] -> SDoc
+pprExports getOcc exports = vcat (map (pprExport getOcc) exports)
-ppr_decl decl = prettyToUn (ppr PprInterface decl) `uppBeside` uppSemi
+pprExport :: Eq a => (a -> OccName) -> (ModuleName, [GenAvailInfo a]) -> SDoc
+pprExport getOcc (mod, items)
+ = hsep [ ptext SLIT("__export "), ppr mod, hsep (map pp_avail items) ] <> semi
+ where
+ --pp_avail :: GenAvailInfo a -> SDoc
+ pp_avail (Avail name) = ppr (getOcc name)
+ pp_avail (AvailTC _ []) = empty
+ pp_avail (AvailTC n (n':ns))
+ | n==n' = ppr (getOcc n) <> pp_export ns
+ | otherwise = ppr (getOcc n) <> char '|' <> pp_export (n':ns)
+
+ pp_export [] = empty
+ pp_export names = braces (hsep (map (ppr.getOcc) names))
-renumber_ty ty = initNmbr (nmbrType ty)
+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
-
-NotAvailable `lt_avail` (Avail _ _) = True
-(Avail n1 _) `lt_avail` (Avail n2 _) = n1 `lt_name` n2
-any `lt_avail` NotAvailable = False
+pprUsages :: (a -> OccName) -> [Usage a] -> SDoc
+pprUsages getOcc usages = vcat (map (pprUsage getOcc) usages)
+
+pprUsage :: (a -> OccName) -> Usage a -> SDoc
+pprUsage getOcc usage
+ = hsep [ptext SLIT("import"), ppr (usg_name usage),
+ int (usg_mod usage),
+ pp_export_version (usg_exports usage),
+ int (usg_rules usage),
+ pp_versions (usg_entities usage)
+ ] <> semi
+ where
+ pp_versions nvs = hsep [ ppr (getOcc n) <+> int v | (n,v) <- nvs ]
-lt_name :: Name -> Name -> Bool
-n1 `lt_name` n2 = modAndOcc n1 < modAndOcc n2
+ pp_export_version Nothing = empty
+ pp_export_version (Just v) = int v
-lt_lexical :: NamedThing a => a -> a -> Bool
-lt_lexical a1 a2 = getName a1 `lt_name` getName a2
-lt_imp_vers :: ImportVersion a -> ImportVersion a -> Bool
-lt_imp_vers (m1,_,_) (m2,_,_) = m1 < m2
+pprDeps :: Dependencies -> SDoc
+pprDeps (Deps { dep_mods = mods, dep_pkgs = pkgs, dep_orphs = orphs})
+ = vcat [ptext SLIT("module dependencies:") <+> fsep (map ppr_mod mods),
+ ptext SLIT("package dependencies:") <+> fsep (map ppr pkgs),
+ ptext SLIT("orphans:") <+> fsep (map ppr orphs)
+ ]
+ where
+ ppr_mod (mod_name, boot) = ppr mod_name <+> ppr_boot boot
+
+ ppr_boot True = text "[boot]"
+ ppr_boot False = empty
+\end{code}
-sort_versions vs = sortLt lt_vers vs
+\begin{code}
+pprIfaceDecls :: NameEnv Int -> IfaceDecls -> SDoc
+pprIfaceDecls version_map decls
+ = vcat [ vcat [ppr i <+> semi | i <- dcl_insts decls]
+ , vcat (map ppr_decl (dcl_tycl decls))
+ ]
+ where
+ ppr_decl d = ppr_vers d <+> ppr d <> semi
-lt_vers :: LocalVersion Name -> LocalVersion Name -> Bool
-lt_vers (n1,v1) (n2,v2) = n1 `lt_name` n2
+ -- Print the version for the decl
+ ppr_vers d = case lookupNameEnv version_map (tyClDeclName d) of
+ Nothing -> empty
+ Just v -> int v
\end{code}
-
\begin{code}
-hPutCol :: Handle
- -> (a -> Unpretty)
- -> [a]
- -> IO ()
-hPutCol hdl fmt xs = hPutStr hdl (uppShow 0 (uppAboves (map fmt xs))) >>
- hPutStr hdl "\n"
+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}