X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Fmain%2FMkIface.lhs;h=1d709efb64c9a42e5f693eb51862c2ff21ebe46b;hb=1211c4e59dd9c4f5e7b027649a1e3c6eb459f5e1;hp=43d1ebb867304374cc084edf28cf197ef70cbe73;hpb=573ef10b2afd99d3c6a36370a9367609716c97d2;p=ghc-hetmet.git diff --git a/ghc/compiler/main/MkIface.lhs b/ghc/compiler/main/MkIface.lhs index 43d1ebb..1d709ef 100644 --- a/ghc/compiler/main/MkIface.lhs +++ b/ghc/compiler/main/MkIface.lhs @@ -1,484 +1,673 @@ % -% (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 ( writeIface ) where + #include "HsVersions.h" -module MkIface ( - startIface, endIface, - ifaceUsages, - ifaceVersions, - ifaceExportList, - ifaceFixities, - ifaceInstanceModules, - ifaceDecls, - ifaceInstances, - ifacePragmas - ) where - -IMP_Ubiq(){-uitous-} -IMPORT_1_3(IO(Handle,hPutStr,openFile,hClose,IOMode(..))) +import IO ( openFile, hClose, IOMode(..) ) -import Bag ( bagToList ) -import Class ( GenClass(..){-instance NamedThing-}, GenClassOp(..) ) -import CmdLineOpts ( opt_ProduceHi ) -import FieldLabel ( FieldLabel{-instance NamedThing-} ) -import FiniteMap ( emptyFM, addToFM, lookupFM, fmToList, eltsFM, FiniteMap ) import HsSyn -import Id ( idType, dataConRawArgTys, dataConFieldLabels, isDataCon, - dataConStrictMarks, StrictnessMark(..), - GenId{-instance NamedThing/Outputable-} - ) -import Maybes ( maybeToBool ) -import Name ( origName, nameOf, moduleOf, - exportFlagOn, nameExportFlag, ExportFlag(..), - isLexSym, isLexCon, isLocallyDefined, isWiredInName, - RdrName(..){-instance Outputable-}, - OrigName(..){-instance Ord-}, - Name{-instance NamedThing-} +import HsCore ( HsIdInfo(..), toUfExpr ) +import RdrHsSyn ( RdrNameRuleDecl, mkTyData ) +import HsPragmas ( DataPragmas(..), ClassPragmas(..) ) +import HsTypes ( toHsTyVars ) +import BasicTypes ( Fixity(..), NewOrData(..), + Version, bumpVersion, initialVersion, isLoopBreaker ) -import ParseUtils ( UsagesMap(..), VersionsMap(..) ) -import PprEnv -- not sure how much... -import PprStyle ( PprStyle(..) ) -import PprType -- most of it (??) ---import PrelMods ( modulesWithBuiltins ) -import PrelInfo ( builtinValNamesMap, builtinTcNamesMap ) -import Pretty ( prettyToUn ) -import Unpretty -- ditto -import RnHsSyn ( isRnConstr, SYN_IE(RenamedHsModule), RnName(..) ) -import RnUtils ( SYN_IE(RnEnv), pprRnEnv{-ToDo:rm-} ) -import TcModule ( SYN_IE(TcIfaceInfo) ) +import RnMonad + import TcInstUtil ( InstInfo(..) ) -import TyCon ( TyCon(..){-instance NamedThing-}, NewOrData(..) ) -import Type ( mkSigmaTy, mkDictTy, getAppTyCon, splitForAllTy ) -import Util ( sortLt, removeDups, zipWithEqual, zipWith3Equal, assertPanic, panic{-ToDo:rm-}, pprTrace{-ToDo:rm-} ) - -uppSemid x = uppBeside (prettyToUn (ppr PprInterface x)) uppSemi -- micro util -ppr_ty ty = prettyToUn (pprType PprInterface ty) -ppr_tyvar tv = prettyToUn (ppr PprInterface tv) -ppr_name n - = case (origName "ppr_name" n) of { OrigName m s -> - uppBesides [uppPStr m, uppChar '.', uppPStr s] } -\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. +import CmdLineOpts +import Id ( Id, idType, idInfo, omitIfaceSigForId, isUserExportedId, hasNoBinding, + idSpecialisation + ) +import Var ( isId, varName ) +import VarSet +import DataCon ( StrictnessMark(..), dataConSig, dataConFieldLabels, dataConStrictMarks ) +import IdInfo ( IdInfo, StrictnessInfo(..), ArityInfo(..), + CprInfo(..), CafInfo(..), + inlinePragInfo, arityInfo, arityLowerBound, + strictnessInfo, isBottomingStrictness, + cafInfo, specInfo, cprInfo, + occInfo, isNeverInlinePrag, + workerInfo, WorkerInfo(..) + ) +import CoreSyn ( CoreExpr, CoreBind, Bind(..), isBuiltinRule, rulesRules, rulesRhsFreeVars ) +import CoreFVs ( exprSomeFreeVars, ruleSomeLhsFreeVars, ruleSomeFreeVars ) +import CoreUnfold ( okToUnfoldInHiFile, couldBeSmallEnoughToInline ) +import Module ( pprModuleName, moduleUserString ) +import Name ( isLocallyDefined, isWiredInName, toRdrName, nameModule, + Name, NamedThing(..) + ) +import OccName ( OccName, pprOccName ) +import TyCon ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon, + tyConTheta, tyConTyVars, tyConDataCons, tyConFamilySize + ) +import Class ( classExtraBigSig, DefMeth(..) ) +import FieldLabel ( fieldLabelType ) +import Type ( mkSigmaTy, splitSigmaTy, mkDictTy, tidyTopType, + deNoteType, classesToPreds + ) -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@. +import Rules ( ProtoCoreRule(..) ) -\begin{code} -startIface :: Module - -> IO (Maybe Handle) -- Nothing <=> don't do an interface -endIface :: Maybe Handle -> IO () -ifaceUsages - :: Maybe Handle - -> UsagesMap - -> IO () -ifaceVersions - :: Maybe Handle - -> VersionsMap - -> IO () -ifaceExportList - :: Maybe Handle - -> (Name -> ExportFlag, ([(Name,ExportFlag)], [(Name,ExportFlag)])) - -> RnEnv - -> IO () -ifaceFixities - :: Maybe Handle - -> RenamedHsModule - -> IO () -ifaceInstanceModules - :: Maybe Handle - -> [Module] - -> IO () -ifaceDecls :: Maybe Handle - -> TcIfaceInfo -- info produced by typechecker, for interfaces - -> IO () -ifaceInstances - :: Maybe Handle - -> TcIfaceInfo -- as above - -> IO () -ifacePragmas - :: Maybe Handle - -> IO () -ifacePragmas = panic "ifacePragmas" -- stub +import Bag ( bagToList ) +import UniqFM ( lookupUFM, listToUFM ) +import Util ( sortLt ) +import SrcLoc ( noSrcLoc ) +import Bag +import Outputable +import ErrUtils ( dumpIfSet ) + +import Maybe ( isNothing ) +import List ( partition ) +import Monad ( when ) \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 ("interface "++ _UNPK_ mod) >> - return (Just if_hdl) - -endIface Nothing = return () -endIface (Just if_hdl) = hPutStr if_hdl "\n" >> hClose if_hdl -\end{code} + +%************************************************************************ +%* * +\subsection{Write a new interface file} +%* * +%************************************************************************ \begin{code} -ifaceUsages Nothing{-no iface handle-} _ = return () - -ifaceUsages (Just if_hdl) usages - | null usages_list - = return () - | otherwise - = hPutStr if_hdl "\n__usages__\n" >> - hPutStr if_hdl (uppShow 0 (uppAboves (map upp_uses usages_list))) - where - usages_list = fmToList usages -- NO: filter has_no_builtins (...) +writeIface this_mod old_iface new_iface + local_tycons local_classes inst_info + final_ids tidy_binds tidy_orphan_rules + = + if isNothing opt_HiDir && isNothing opt_HiFile + then return () -- not producing any .hi file + else + + let + hi_suf = case opt_HiSuf of { Nothing -> "hi"; Just suf -> suf } + filename = case opt_HiFile of { + Just f -> f; + Nothing -> + case opt_HiDir of { + Just dir -> dir ++ '/':moduleUserString this_mod + ++ '.':hi_suf; + Nothing -> panic "writeIface" + }} + in --- has_no_builtins (m, _) --- = m `notElem` modulesWithBuiltins --- -- Don't *have* to do this; save gratuitous spillage in --- -- every interface. Could be flag-controlled... + do maybe_final_iface <- checkIface old_iface full_new_iface + case maybe_final_iface of { + Nothing -> when opt_D_dump_rn_trace $ + putStrLn "Interface file unchanged" ; -- No need to update .hi file - upp_uses (m, (mv, versions)) - = uppBesides [uppPStr m, uppSP, uppInt mv, uppPStr SLIT(" :: "), - upp_versions (fmToList versions), uppSemi] + Just final_iface -> - upp_versions nvs - = uppIntersperse uppSP [ uppCat [uppPStr n, uppInt v] | (n,v) <- nvs ] -\end{code} + do let mod_vers_unchanged = case old_iface of + Just iface -> pi_vers iface == pi_vers final_iface + Nothing -> False + when (mod_vers_unchanged && opt_D_dump_rn_trace) $ + putStrLn "Module version unchanged, but usages differ; hence need new hi file" -\begin{code} -ifaceVersions Nothing{-no iface handle-} _ = return () - -ifaceVersions (Just if_hdl) version_info - | null version_list - = return () - | otherwise - = hPutStr if_hdl "\n__versions__\n" >> - hPutStr if_hdl (uppShow 0 (upp_versions version_list)) - -- NB: when compiling Prelude.hs, this will spew out - -- stuff for [], (), (,), etc. [i.e., builtins], which - -- we'd rather it didn't. The version-mangling in - -- the driver will ignore them. + if_hdl <- openFile filename WriteMode + printForIface if_hdl (pprIface final_iface) + hClose if_hdl + } where - version_list = fmToList version_info - - upp_versions nvs - = uppAboves [ uppPStr n | (n,v) <- nvs ] + full_new_iface = completeIface new_iface local_tycons local_classes + inst_info final_ids tidy_binds + tidy_orphan_rules \end{code} -\begin{code} -ifaceInstanceModules Nothing{-no iface handle-} _ = return () -ifaceInstanceModules (Just _) [] = return () -ifaceInstanceModules (Just if_hdl) imods - = hPutStr if_hdl "\n__instance_modules__\n" >> - hPutStr if_hdl (uppShow 0 (uppCat (map uppPStr imods))) -\end{code} +%************************************************************************ +%* * +\subsection{Checking if the new interface is up to date +%* * +%************************************************************************ -Export list: grab the Names of things that are marked Exported, sort -(so the interface file doesn't ``wobble'' from one compilation to the -next...), and print. We work from the renamer's final ``RnEnv'', -which has all the names we might possibly be interested in. -(Note that the ``module X'' export items can cause a lot of grief.) \begin{code} -ifaceExportList Nothing{-no iface handle-} _ _ = return () - -ifaceExportList (Just if_hdl) - (export_fn, (dotdot_vals, dotdot_tcs)) - rn_env@((qual, unqual, tc_qual, tc_unqual), _) - = let - name_flag_pairs :: FiniteMap OrigName ExportFlag - name_flag_pairs - = foldr (from_wired True{-val-ish-}) - (foldr (from_wired False{-tycon-ish-}) - (foldr (from_dotdot True{-val-ish-}) - (foldr (from_dotdot False{-tycon-ish-}) - (foldr from_val - (foldr from_val - (foldr from_tc - (foldr from_tc emptyFM{-init accum-} - (eltsFM tc_unqual)) - (eltsFM tc_qual)) - (eltsFM unqual)) - (eltsFM qual)) - dotdot_tcs) - dotdot_vals) - (eltsFM builtinTcNamesMap)) - (eltsFM builtinValNamesMap) - - sorted_pairs = sortLt lexical_lt (fmToList name_flag_pairs) - - in - --pprTrace "Exporting:" (pprRnEnv PprDebug rn_env) $ - hPutStr if_hdl "\n__exports__\n" >> - hPutStr if_hdl (uppShow 0 (uppAboves (map upp_pair sorted_pairs))) +checkIface :: Maybe ParsedIface -- The old interface, read from M.hi + -> ParsedIface -- The new interface; but with all version numbers = 1 + -> IO (Maybe ParsedIface) -- Nothing => no change; no need to write new Iface + -- Just pi => Here is the new interface to write + -- with correct version numbers + -- The I/O part is just so it can print differences + +-- NB: the fixities, declarations, rules are all assumed +-- to be sorted by increasing order of hsDeclName, so that +-- we can compare for equality + +checkIface Nothing new_iface +-- No old interface, so definitely write a new one! + = return (Just new_iface) + +checkIface (Just iface) new_iface + | no_output_change && no_usage_change + = return Nothing + + | otherwise -- Add updated version numbers + = do { dumpIfSet opt_D_dump_hi_diffs "Interface file changes" pp_diffs ; + return (Just final_iface )} + where - from_val rn acc - | fun_looking rn && exportFlagOn ef = addToFM acc on ef - | otherwise = acc - where - ef = export_fn n -- NB: using the export fn! - n = getName rn - on = origName "from_val" n - - -- fun_looking: must avoid class ops and data constructors - -- and record fieldnames - fun_looking (RnName _) = True - fun_looking (WiredInId i) = not (isDataCon i) - fun_looking _ = False - - from_tc rn acc - | exportFlagOn ef = addToFM acc on ef - | otherwise = acc - where - ef = export_fn n -- NB: using the export fn! - n = getName rn - on = origName "from_tc" n - - from_dotdot is_valish (n,ef) acc - | is_valish && isLexCon str = acc - | exportFlagOn ef = addToFM acc on ef - | otherwise = acc - where - on = origName "from_dotdot" n - (OrigName _ str) = on - - from_wired is_val_ish rn acc - | is_val_ish && not (fun_looking rn) - = acc -- these things don't cause export-ery - | exportFlagOn ef = addToFM acc on ef - | otherwise = acc - where - n = getName rn - ef = export_fn n - on = origName "from_wired" n - - -------------- - lexical_lt (n1,_) (n2,_) = n1 < n2 - - -------------- - upp_pair (OrigName m n, ef) - = uppBesides [uppPStr m, uppSP, uppPStr n, uppSP, upp_export ef] - where - upp_export ExportAll = uppPStr SLIT("(..)") - upp_export ExportAbs = uppNil + final_iface = new_iface { pi_vers = new_mod_vers, + pi_fixity = (new_fixity_vers, new_fixities), + pi_rules = (new_rules_vers, new_rules), + pi_decls = final_decls } + + no_usage_change = pi_usages iface == pi_usages new_iface + + no_output_change = no_decl_changed && + new_fixity_vers == fixity_vers && + new_rules_vers == rules_vers && + no_export_change + + no_export_change = pi_exports iface == pi_exports new_iface + + new_mod_vers | no_output_change = mod_vers + | otherwise = bumpVersion mod_vers + + mod_vers = pi_vers iface + + (fixity_vers, fixities) = pi_fixity iface + (_, new_fixities) = pi_fixity new_iface + new_fixity_vers | fixities == new_fixities = fixity_vers + | otherwise = bumpVersion fixity_vers + + (rules_vers, rules) = pi_rules iface + (_, new_rules) = pi_rules new_iface + new_rules_vers | rules == new_rules = rules_vers + | otherwise = bumpVersion rules_vers + + (no_decl_changed, pp_diffs, final_decls) = merge_decls True empty [] (pi_decls iface) (pi_decls new_iface) + + -- Fill in the version number on the new declarations + -- by looking at the old declarations. + -- Set the flag if anything changes. + -- Assumes that the decls are sorted by hsDeclName + merge_decls ok_so_far pp acc [] [] = (ok_so_far, pp, reverse acc) + merge_decls ok_so_far pp acc old [] = (False, pp, reverse acc) + merge_decls ok_so_far pp acc [] (nvd:nvds) = merge_decls False (pp $$ only_new nvd) (nvd:acc) [] nvds + merge_decls ok_so_far pp acc (vd@(v,d):vds) (nvd@(_,nd):nvds) + = case d_name `compare` nd_name of + LT -> merge_decls False (pp $$ only_old vd) acc vds (nvd:nvds) + GT -> merge_decls False (pp $$ only_new nvd) (nvd:acc) (vd:vds) nvds + EQ | d == nd -> merge_decls ok_so_far pp (vd:acc) vds nvds + | otherwise -> merge_decls False (pp $$ changed d nd) ((bumpVersion v, nd):acc) vds nvds + where + d_name = hsDeclName d + nd_name = hsDeclName nd + + only_old (_,d) = ptext SLIT("Only in old iface:") <+> ppr d + only_new (_,d) = ptext SLIT("Only in new iface:") <+> ppr d + changed d nd = ptext SLIT("Changed in iface: ") <+> ((ptext SLIT("Old:") <+> ppr d) $$ + (ptext SLIT("New:") <+> ppr nd)) \end{code} -\begin{code} -ifaceFixities Nothing{-no iface handle-} _ = return () -ifaceFixities (Just if_hdl) (HsModule _ _ _ _ fixities _ _ _ _ _ _ _ _ _) - = let - pp_fixities = foldr go [] fixities - in - if null pp_fixities then - return () - else - hPutStr if_hdl "\n__fixities__\n" >> - hPutStr if_hdl (uppShow 0 (uppAboves pp_fixities)) - where - go (InfixL v i) acc = (if isLocallyDefined v then (:) (print_fix "l" i v) else id) acc - go (InfixR v i) acc = (if isLocallyDefined v then (:) (print_fix "r" i v) else id) acc - go (InfixN v i) acc = (if isLocallyDefined v then (:) (print_fix "" i v) else id) acc - print_fix suff prec var - = uppBesides [uppPStr SLIT("infix"), uppStr suff, uppSP, uppInt prec, uppSP, ppr_name var, uppSemi] -\end{code} +%************************************************************************ +%* * +\subsection{Printing the interface} +%* * +%************************************************************************ \begin{code} -non_wired x = not (isWiredInName (getName x)) --ToDo:move? +pprIface (ParsedIface { pi_mod = mod, pi_vers = mod_vers, pi_orphan = orphan, + pi_usages = usages, pi_exports = exports, + pi_fixity = (fix_vers, fixities), + pi_insts = insts, pi_decls = decls, + pi_rules = (rule_vers, rules), pi_deprecs = deprecs }) + = vcat [ ptext SLIT("__interface") + <+> doubleQuotes (ptext opt_InPackage) + <+> ppr mod <+> ppr mod_vers <+> pp_sub_vers + <+> (if orphan then char '!' else empty) + <+> int opt_HiVersion + <+> ptext SLIT("where") + , vcat (map pprExport exports) + , vcat (map pprUsage usages) + , pprFixities fixities + , vcat [ppr i <+> semi | i <- insts] + , vcat [ppr_vers v <+> ppr d <> semi | (v,d) <- decls] + , pprRules rules + , pprDeprecs deprecs + ] + where + ppr_vers v | v == initialVersion = empty + | otherwise = int v + pp_sub_vers + | fix_vers == initialVersion && rule_vers == initialVersion = empty + | otherwise = brackets (ppr fix_vers <+> ppr rule_vers) +\end{code} -ifaceDecls Nothing{-no iface handle-} _ = return () +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 -ifaceDecls (Just if_hdl) (vals, tycons, classes, _) - = ASSERT(all isLocallyDefined vals) - ASSERT(all isLocallyDefined tycons) - ASSERT(all isLocallyDefined classes) - let - nonwired_classes = filter non_wired classes - nonwired_tycons = filter non_wired tycons - nonwired_vals = filter non_wired vals +\begin{code} +pprExport :: ExportItem -> SDoc +pprExport (mod, items) + = hsep [ ptext SLIT("__export "), ppr mod, hsep (map upp_avail items) ] <> semi + where + upp_avail :: RdrAvailInfo -> SDoc + upp_avail (Avail name) = pprOccName name + upp_avail (AvailTC name []) = empty + upp_avail (AvailTC name ns) = hcat [pprOccName name, bang, upp_export ns'] + where + bang | name `elem` ns = empty + | otherwise = char '|' + ns' = filter (/= name) ns + + upp_export [] = empty + upp_export names = braces (hsep (map pprOccName names)) +\end{code} - lt_lexical a b = origName "lt_lexical" a < origName "lt_lexical" b - sorted_classes = sortLt lt_lexical nonwired_classes - sorted_tycons = sortLt lt_lexical nonwired_tycons - sorted_vals = sortLt lt_lexical nonwired_vals - in - if (null sorted_classes && null sorted_tycons && null sorted_vals) then - -- You could have a module with just (re-)exports/instances in it - return () - else - hPutStr if_hdl "\n__declarations__\n" >> - hPutStr if_hdl (uppShow 0 (uppAboves [ - uppAboves (map ppr_class sorted_classes), - uppAboves (map ppr_tycon sorted_tycons), - uppAboves [ppr_val v (idType v) | v <- sorted_vals]])) +\begin{code} +pprUsage :: ImportVersion OccName -> SDoc +pprUsage (m, has_orphans, is_boot, whats_imported) + = hsep [ptext SLIT("import"), pprModuleName m, + pp_orphan, pp_boot, + upp_import_versions whats_imported + ] <> semi + where + pp_orphan | has_orphans = char '!' + | otherwise = empty + pp_boot | is_boot = char '@' + | otherwise = empty + + -- Importing the whole module is indicated by an empty list + upp_import_versions NothingAtAll = empty + upp_import_versions (Everything v) = dcolon <+> int v + upp_import_versions (Specifically vm vf vr nvs) + = dcolon <+> int vm <+> int vf <+> int vr <+> hsep [ ppr n <+> int v | (n,v) <- nvs ] \end{code} + \begin{code} -ifaceInstances Nothing{-no iface handle-} _ = return () +pprFixities [] = empty +pprFixities fixes = hsep (map ppr fixes) <> semi -ifaceInstances (Just if_hdl) (_, _, _, insts) - = let - togo_insts = filter is_togo_inst (bagToList insts) +pprRules [] = empty +pprRules rules = hsep [ptext SLIT("{-## __R"), hsep (map ppr rules), ptext SLIT("##-}")] - sorted_insts = sortLt lt_inst togo_insts - in - if null togo_insts then - return () - else - hPutStr if_hdl "\n__instances__\n" >> - hPutStr if_hdl (uppShow 0 (uppAboves (map pp_inst sorted_insts))) - where - is_togo_inst (InstInfo clas _ ty _ _ _ _ _ from_here _ _ _) - = from_here -- && ... - - ------- - lt_inst (InstInfo clas1 _ ty1 _ _ _ _ _ _ _ _ _) - (InstInfo clas2 _ ty2 _ _ _ _ _ _ _ _ _) - = let - tycon1 = fst (getAppTyCon ty1) - tycon2 = fst (getAppTyCon ty2) - in - case (origName "lt_inst" clas1 `cmp` origName "lt_inst" clas2) of - LT_ -> True - GT_ -> False - EQ_ -> origName "lt_inst2" tycon1 < origName "lt_inst2" tycon2 - - ------- - pp_inst (InstInfo clas tvs ty theta _ _ _ _ _ _ _ _) - = let - forall_ty = mkSigmaTy tvs theta (mkDictTy clas ty) - renumbered_ty = initNmbr (nmbrType forall_ty) - in - case (splitForAllTy renumbered_ty) of { (rtvs, rrho_ty) -> - uppBesides [uppPStr SLIT("instance "), ppr_forall rtvs, ppr_ty rrho_ty, uppSemi] } +pprDeprecs [] = empty +pprDeprecs deps = hsep [ ptext SLIT("{-## __D"), guts, ptext SLIT("##-}")] + where + guts = hsep [ ppr ie <+> doubleQuotes (ppr txt) <> semi + | Deprecation ie txt _ <- deps ] \end{code} + %************************************************************************ -%* * -\subsection{Printing tycons, classes, ...} -%* * +%* * +\subsection{Completing the new interface} +%* * %************************************************************************ \begin{code} -ppr_class :: Class -> Unpretty - -ppr_class c - = --pprTrace "ppr_class:" (ppr PprDebug c) $ - case (initNmbr (nmbrClass c)) of { -- renumber it! - Class _ n tyvar super_classes sdsels ops sels defms insts links -> - - uppCat [uppPStr SLIT("class"), ppr_context tyvar super_classes, - ppr_name n, ppr_tyvar tyvar, - if null ops - then uppSemi - else uppCat [uppStr "where {", uppCat (map ppr_op ops), uppStr "};"]] +completeIface new_iface local_tycons local_classes + inst_info final_ids tidy_binds + tidy_orphan_rules + = new_iface { pi_decls = [(initialVersion,d) | d <- sortLt lt_decl all_decls], + pi_insts = sortLt lt_inst_decl inst_dcls, + pi_rules = (initialVersion, rule_dcls) } where - ppr_context :: TyVar -> [Class] -> Unpretty + all_decls = cls_dcls ++ ty_dcls ++ bagToList val_dcls + (inst_dcls, inst_ids) = ifaceInstances inst_info + cls_dcls = map ifaceClass local_classes + + ty_dcls = map ifaceTyCon (filter (not . isWiredInName . getName) local_tycons) - ppr_context tv [] = uppNil --- ppr_context tv [sc] = uppBeside (ppr_assert tv sc) (uppPStr SLIT(" =>")) - ppr_context tv super_classes - = uppBesides [uppStr "{{", - uppIntersperse upp'SP{-'-} (map (ppr_assert tv) super_classes), - uppStr "}} =>"] + (val_dcls, emitted_ids) = ifaceBinds (inst_ids `unionVarSet` orphan_rule_ids) + final_ids tidy_binds - ppr_assert tv (Class _ n _ _ _ _ _ _ _ _) = uppCat [ppr_name n, ppr_tyvar tv] + rule_dcls | opt_OmitInterfacePragmas = [] + | otherwise = ifaceRules tidy_orphan_rules emitted_ids - clas_mod = moduleOf (origName "ppr_class" c) + orphan_rule_ids = unionVarSets [ ruleSomeFreeVars interestingId rule + | ProtoCoreRule _ _ rule <- tidy_orphan_rules] - ppr_op (ClassOp o _ ty) = pp_sig (Qual clas_mod o) ty +lt_decl d1 d2 = hsDeclName d1 < hsDeclName d2 +lt_inst_decl d1 d2 = instDeclName d1 < instDeclName d2 + -- Even instance decls have names, namely the dfun name \end{code} -\begin{code} -ppr_val v ty -- renumber the type first! - = --pprTrace "ppr_val:" (ppr PprDebug v) $ - pp_sig v (initNmbr (nmbrType ty)) -pp_sig op ty - = case (splitForAllTy ty) of { (tvs, rho_ty) -> - uppBesides [ppr_name op, uppPStr SLIT(" :: "), ppr_forall tvs, ppr_ty rho_ty, uppSemi] } +%************************************************************************ +%* * +\subsection{Completion stuff} +%* * +%************************************************************************ + +\begin{code} +ifaceRules :: [ProtoCoreRule] -> IdSet -> [RdrNameRuleDecl] +ifaceRules rules emitted + = orphan_rules ++ local_rules + where + orphan_rules = [ toHsRule fn rule | ProtoCoreRule _ fn rule <- rules ] + local_rules = [ toHsRule fn rule + | fn <- varSetElems emitted, + rule <- rulesRules (idSpecialisation fn), + not (isBuiltinRule rule), + -- We can't print builtin rules in interface files + -- Since they are built in, an importing module + -- will have access to them anyway + + -- 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 + all (`elemVarSet` emitted) (varSetElems (ruleSomeLhsFreeVars interestingId rule)) + -- Spit out a rule only if all its lhs free vars are emitted + -- This is a good reason not to do it when we emit the Id itself + ] +\end{code} -ppr_forall [] = uppNil -ppr_forall tvs = uppBesides [ uppStr "__forall__ [", uppInterleave uppComma (map ppr_tyvar tvs), uppStr "] " ] +\begin{code} +ifaceInstances :: Bag InstInfo -> ([RdrNameInstDecl], IdSet) + -- The IdSet is the needed dfuns + +ifaceInstances inst_infos + = (decls, needed_ids) + where + decls = map to_decl togo_insts + togo_insts = filter is_togo_inst (bagToList inst_infos) + needed_ids = mkVarSet [dfun_id | InstInfo _ _ _ _ dfun_id _ _ _ <- togo_insts] + is_togo_inst (InstInfo _ _ _ _ dfun_id _ _ _) = isLocallyDefined dfun_id + + ------- + to_decl (InstInfo clas tvs tys theta dfun_id _ _ _) + = let + -- 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. + forall_ty = mkSigmaTy tvs theta (deNoteType (mkDictTy clas tys)) + tidy_ty = tidyTopType forall_ty + in + InstDecl (toHsType tidy_ty) EmptyMonoBinds [] (Just (toRdrName dfun_id)) noSrcLoc \end{code} \begin{code} -ppr_tycon tycon - = --pprTrace "ppr_tycon:" (ppr PprDebug tycon) $ - ppr_tc (initNmbr (nmbrTyCon tycon)) +ifaceTyCon :: TyCon -> RdrNameHsDecl +ifaceTyCon tycon + | isSynTyCon tycon + = TyClD (TySynonym (toRdrName tycon) + (toHsTyVars tyvars) (toHsType ty) + noSrcLoc) + where + (tyvars, ty) = getSynTyConDefn tycon + +ifaceTyCon tycon + | isAlgTyCon tycon + = TyClD (mkTyData new_or_data (toHsContext (tyConTheta tycon)) + (toRdrName tycon) + (toHsTyVars tyvars) + (map ifaceConDecl (tyConDataCons tycon)) + (tyConFamilySize tycon) + Nothing NoDataPragmas noSrcLoc) + where + tyvars = tyConTyVars tycon + new_or_data | isNewTyCon tycon = NewType + | otherwise = DataType + + ifaceConDecl data_con + = ConDecl (toRdrName data_con) (error "ifaceConDecl") + (toHsTyVars ex_tyvars) + (toHsContext ex_theta) + details noSrcLoc + where + (tyvars1, _, ex_tyvars, ex_theta, arg_tys, tycon1) = dataConSig data_con + field_labels = dataConFieldLabels data_con + strict_marks = dataConStrictMarks data_con + details + | null field_labels + = ASSERT( tycon == tycon1 && tyvars == tyvars1 ) + VanillaCon (zipWith mk_bang_ty strict_marks arg_tys) + + | 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 + = ([toRdrName field_label], mk_bang_ty strict_mark (fieldLabelType field_label)) + +ifaceTyCon tycon + = pprPanic "pprIfaceTyDecl" (ppr tycon) + +ifaceClass clas + = TyClD (ClassDecl (toHsContext sc_theta) + (toRdrName clas) + (toHsTyVars clas_tyvars) + (toHsFDs clas_fds) + (map toClassOpSig op_stuff) + EmptyMonoBinds NoClassPragmas + [] noSrcLoc + ) + where + bogus = error "ifaceClass" + (clas_tyvars, clas_fds, sc_theta, _, op_stuff) = classExtraBigSig clas + + toClassOpSig (sel_id, def_meth) = + ASSERT(sel_tyvars == clas_tyvars) + ClassOpSig (toRdrName sel_id) (Just 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 (toRdrName id) +\end{code} + ------------------------- -ppr_tc (PrimTyCon _ n _ _) - = uppCat [ uppStr "{- data", ppr_name n, uppStr " *built-in* -}" ] +%************************************************************************ +%* * +\subsection{Value bindings} +%* * +%************************************************************************ -ppr_tc FunTyCon - = uppCat [ uppStr "{- data", ppr_name FunTyCon, uppStr " *built-in* -}" ] +\begin{code} +ifaceBinds :: IdSet -- These Ids are needed already + -> [Id] -- Ids used at code-gen time; they have better pragma info! + -> [CoreBind] -- In dependency order, later depend on earlier + -> (Bag RdrNameHsDecl, IdSet) -- Set of Ids actually spat out + +ifaceBinds needed_ids final_ids binds + = go needed_ids (reverse binds) emptyBag emptyVarSet + -- Reverse so that later things will + -- provoke earlier ones to be emitted + 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 + + -- The 'needed' set contains the Ids that are needed by earlier + -- interface file emissions. If the Id isn't in this set, and isn't + -- exported, there's no need to emit anything + need_id needed_set id = id `elemVarSet` needed_set || isUserExportedId id + + go needed [] decls emitted + | not (isEmptyVarSet needed) = pprTrace "ifaceBinds: free vars:" + (sep (map ppr (varSetElems needed))) + (decls, emitted) + | otherwise = (decls, emitted) + + go needed (NonRec id rhs : binds) decls emitted + | need_id needed id + = if omitIfaceSigForId id then + go (needed `delVarSet` id) binds decls (emitted `extendVarSet` id) + else + go ((needed `unionVarSet` extras) `delVarSet` id) + binds + (decl `consBag` decls) + (emitted `extendVarSet` id) + | otherwise + = go needed binds decls emitted + where + (decl, extras) = ifaceId get_idinfo False id rhs + + -- Recursive groups are a bit more of a pain. We may only need one to + -- start with, but it may call out the next one, and so on. So we + -- have to look for a fixed point. We don't want necessarily them all, + -- because without -O we may only need the first one (if we don't emit + -- its unfolding) + go needed (Rec pairs : binds) decls emitted + = go needed' binds decls' emitted' + where + (new_decls, new_emitted, extras) = go_rec needed pairs + decls' = new_decls `unionBags` decls + needed' = (needed `unionVarSet` extras) `minusVarSet` mkVarSet (map fst pairs) + emitted' = emitted `unionVarSet` new_emitted + + go_rec :: IdSet -> [(Id,CoreExpr)] -> (Bag RdrNameHsDecl, IdSet, IdSet) + go_rec needed pairs + | null decls = (emptyBag, emptyVarSet, emptyVarSet) + | otherwise = (more_decls `unionBags` listToBag decls, + more_emitted `unionVarSet` mkVarSet (map fst needed_prs), + more_extras `unionVarSet` extras) + where + (needed_prs,leftover_prs) = partition is_needed pairs + (decls, extras_s) = unzip [ifaceId get_idinfo True id rhs + | (id,rhs) <- needed_prs, not (omitIfaceSigForId id)] + extras = unionVarSets extras_s + (more_decls, more_emitted, more_extras) = go_rec extras leftover_prs + is_needed (id,_) = need_id needed id +\end{code} -ppr_tc (TupleTyCon _ n _) - = uppCat [ uppStr "{- ", ppr_name n, uppStr "-}" ] -ppr_tc (SynTyCon _ n _ _ tvs expand) - = let - pp_tyvars = map ppr_tyvar tvs - in - uppBesides [uppPStr SLIT("type "), ppr_name n, uppSP, uppIntersperse uppSP pp_tyvars, - uppPStr SLIT(" = "), ppr_ty expand, uppSemi] - -ppr_tc this_tycon@(DataTyCon u n k tvs ctxt cons derivings data_or_new) - = uppCat [pp_data_or_new, - ppr_context ctxt, - ppr_name n, - uppIntersperse uppSP (map ppr_tyvar tvs), - uppEquals, pp_condecls, - uppSemi] - -- NB: we do not print deriving info in interfaces +\begin{code} +ifaceId :: (Id -> IdInfo) -- This function "knows" the extra info added + -- by the STG passes. Sigh + -> Bool -- True <=> recursive, so don't print unfolding + -> Id + -> CoreExpr -- The Id's right hand side + -> (RdrNameHsDecl, IdSet) -- The emitted stuff, plus any *extra* needed Ids + +ifaceId get_idinfo is_rec id rhs + = (SigD (IfaceSig (toRdrName id) (toHsType id_type) hs_idinfo noSrcLoc), new_needed_ids) where - pp_data_or_new = case data_or_new of - DataType -> uppPStr SLIT("data") - NewType -> uppPStr SLIT("newtype") - - ppr_context [] = uppNil --- ppr_context [(c,t)] = uppCat [ppr_name c, ppr_ty t, uppPStr SLIT("=>")] - ppr_context cs - = uppBesides[uppStr "{{", - uppInterleave uppComma [uppCat [ppr_name c, ppr_ty t] | (c,t) <- cs], - uppStr "}}", uppPStr SLIT(" =>")] - - pp_condecls - = let - (c:cs) = cons - in - uppCat ((ppr_con c) : (map ppr_next_con cs)) - - ppr_next_con con = uppCat [uppChar '|', ppr_con con] - - ppr_con con - = let - con_arg_tys = dataConRawArgTys con - labels = dataConFieldLabels con -- none if not a record - strict_marks = dataConStrictMarks con - in - uppCat [ppr_name con, ppr_fields labels strict_marks con_arg_tys] - - ppr_fields labels strict_marks con_arg_tys - = if null labels then -- not a record thingy - uppIntersperse uppSP (zipWithEqual "ppr_fields" ppr_bang_ty strict_marks con_arg_tys) - else - uppCat [ uppChar '{', - uppInterleave uppComma (zipWith3Equal "ppr_field" ppr_field labels strict_marks con_arg_tys), - uppChar '}' ] - - ppr_bang_ty b t - = uppBeside (case b of { MarkedStrict -> uppChar '!'; _ -> uppNil }) - (prettyToUn (pprParendType PprInterface t)) - - ppr_field l b t - = uppBesides [ppr_name l, uppPStr SLIT(" :: "), - case b of { MarkedStrict -> uppChar '!'; _ -> uppNil }, - ppr_ty t] + id_type = idType id + core_idinfo = idInfo id + stg_idinfo = get_idinfo id + + hs_idinfo | opt_OmitInterfacePragmas = [] + | otherwise = arity_hsinfo ++ caf_hsinfo ++ cpr_hsinfo ++ + strict_hsinfo ++ wrkr_hsinfo ++ unfold_hsinfo + + ------------ Arity -------------- + arity_info = arityInfo stg_idinfo + stg_arity = arityLowerBound arity_info + arity_hsinfo = case arityInfo stg_idinfo of + a@(ArityExactly n) -> [HsArity a] + other -> [] + + ------------ Caf Info -------------- + caf_hsinfo = case cafInfo stg_idinfo of + NoCafRefs -> [HsNoCafRefs] + otherwise -> [] + + ------------ CPR Info -------------- + cpr_hsinfo = case cprInfo core_idinfo of + ReturnsCPR -> [HsCprInfo] + NoCPRInfo -> [] + + ------------ Strictness -------------- + strict_info = strictnessInfo core_idinfo + bottoming_fn = isBottomingStrictness strict_info + strict_hsinfo = case strict_info of + NoStrictnessInfo -> [] + info -> [HsStrictness info] + + + ------------ Worker -------------- + -- We only treat a function as having a worker if + -- the exported arity (which is now the number of visible lambdas) + -- is the same as the arity at the moment of the w/w split + -- If so, we can safely omit the unfolding inside the wrapper, and + -- instead re-generate it from the type/arity/strictness info + -- But if the arity has changed, we just take the simple path and + -- put the unfolding into the interface file, forgetting the fact + -- that it's a wrapper. + -- + -- 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". + work_info = workerInfo core_idinfo + HasWorker work_id _ = work_info + + has_worker = case work_info of + HasWorker work_id wrap_arity + | wrap_arity == stg_arity -> True + | otherwise -> pprTrace "ifaceId: arity change:" (ppr id) + False + + other -> False + + wrkr_hsinfo | has_worker = [HsWorker (toRdrName work_id)] + | otherwise = [] + + ------------ Unfolding -------------- + inline_pragma = inlinePragInfo core_idinfo + dont_inline = isNeverInlinePrag inline_pragma + + unfold_hsinfo | show_unfold = [HsUnfold inline_pragma (toUfExpr rhs)] + | otherwise = [] + + show_unfold = not has_worker && -- Not unnecessary + not bottoming_fn && -- Not necessary + not dont_inline && + not loop_breaker && + rhs_is_small && -- Small enough + okToUnfoldInHiFile rhs -- No casms etc + + rhs_is_small = couldBeSmallEnoughToInline opt_UF_HiFileThreshold rhs + + ------------ Specialisations -------------- + spec_info = specInfo core_idinfo + + ------------ Occ info -------------- + loop_breaker = isLoopBreaker (occInfo core_idinfo) + + ------------ Extra free Ids -------------- + new_needed_ids | opt_OmitInterfacePragmas = emptyVarSet + | otherwise = worker_ids `unionVarSet` + unfold_ids `unionVarSet` + spec_ids + + worker_ids | has_worker && interestingId work_id = unitVarSet work_id + -- Conceivably, the worker might come from + -- another module + | otherwise = emptyVarSet + + spec_ids = filterVarSet interestingId (rulesRhsFreeVars spec_info) + + unfold_ids | show_unfold = find_fvs rhs + | otherwise = emptyVarSet + + find_fvs expr = exprSomeFreeVars interestingId expr + +interestingId id = isId id && isLocallyDefined id && not (hasNoBinding id) \end{code} +