%
-% (c) The GRASP/AQUA Project, Glasgow University, 1993-1995
+% (c) The GRASP/AQUA Project, Glasgow University, 1993-1996
%
\section[MkIface]{Print an interface for a module}
\begin{code}
#include "HsVersions.h"
-module MkIface ( mkInterface ) where
-
-import PrelInfo ( mkLiftTy, pRELUDE_CORE, pRELUDE_BUILTIN )
-import HsSyn ( FixityDecl(..), RenamedFixityDecl(..), MonoBinds,
- RenamedMonoBinds(..), Name, RenamedPat(..), Sig
+module MkIface (
+ startIface, endIface,
+ ifaceMain,
+ ifaceDecls
+ ) where
+
+IMP_Ubiq(){-uitous-}
+IMPORT_1_3(IO(Handle,hPutStr,openFile,hClose,IOMode(..)))
+
+import HsSyn
+import RdrHsSyn ( RdrName(..) )
+import RnHsSyn ( SYN_IE(RenamedHsModule) )
+import RnMonad
+import RnEnv ( availName )
+
+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 Type
-import Bag
-import FiniteMap
-import Id
-import IdInfo -- plenty from here
-import Maybes ( catMaybes, Maybe(..) )
-import Outputable
+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 TyCon ( TyCon{-instance NamedThing-} )
+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 StgSyn
-import TcInstDcls ( InstInfo(..) )
-import Util
-\end{code}
+import Unpretty -- ditto
-%************************************************************************
-%* *
-\subsection[main-MkIface]{Main routine for making interfaces}
-%* *
-%************************************************************************
-Misc points:
-\begin{enumerate}
-\item
-We get the general what-to-export information from the ``environments''
-produced by the typechecker (the \tr{[RenamedFixityDecl]} through
-\tr{Bag InstInfo} arguments).
-
-\item
-{\em However:} Whereas (for example) an \tr{InstInfo} will have
-\tr{Ids} in it that identify the constant methods for that instance,
-those particular \tr{Ids} {\em do not have} the best @IdInfos@!!!
-Those @IdInfos@ were figured out long after the \tr{InstInfo} was
-created.
-
-That's why we actually look at the final \tr{StgBindings} that go
-into the code-generator: they have the best @IdInfos@ on them.
-Whenever, we are about to print info about an @Id@, we look in the
-Ids-from-STG-bindings list to see if we have an ``equivalent'' @Id@
-with presumably-better @IdInfo@.
-
-\item
-We play this same game whether for values, classes (for their
-method-selectors and default-methods), or instances (for their
-@DictFunIds@ or constant-methods).
-
-Of course, for imported things, what we got from the typechecker is
-all we're gonna get.
-
-\item
-We {\em sort} things in the interface into some ``canonical'' order;
-otherwise, with heavily-recursive modules, you can have (unchanged)
-information ``move around'' in the interface file---deeply unfriendly
-to \tr{make}.
-\end{enumerate}
+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 )
-\begin{code}
-mkInterface :: FAST_STRING
- -> (FAST_STRING -> Bool, -- is something in export list, explicitly?
- FAST_STRING -> Bool) -- is a module among the "dotdot" exported modules?
- -> IdEnv UnfoldingDetails
- -> FiniteMap TyCon [(Bool, [Maybe Type])]
- -> ([RenamedFixityDecl], -- interface info from the typecheck
- [Id],
- CE,
- TCE,
- Bag InstInfo)
- -> [StgBinding]
- -> Pretty
-
-mkInterface modname export_list_fns inline_env tycon_specs
- (fixity_decls, global_ids, ce, tce, inst_infos)
- stg_binds
- = let
- -- first, gather up the things we want to export:
-
- exported_tycons = [ tc | tc <- rngTCE tce,
- isExported tc,
- is_exportable_tycon_or_class export_list_fns tc ]
- exported_classes = [ c | c <- rngCE ce,
- isExported c,
- is_exportable_tycon_or_class export_list_fns c ]
- exported_inst_infos = [ i | i <- bagToList inst_infos,
- is_exported_inst_info export_list_fns i ]
- exported_vals
- = [ v | v <- global_ids,
- isExported v && not (isDataCon v) && not (isClassOpId v) ]
-
- -- We also have to worry about TyCons/Classes that are
- -- *mentioned* in exported things (e.g., values' types or
- -- instances), so that we can be sure to do an import decl for
- -- them, for original-naming purposes:
-
- (mentioned_tycons, mentioned_classes)
- = foldr ( \ (tcs1, cls1) (tcs2, cls2)
- -> (tcs1 `unionBags` tcs2, cls1 `unionBags` cls2) )
- (emptyBag, emptyBag)
- (map getMentionedTyConsAndClassesFromClass exported_classes ++
- map getMentionedTyConsAndClassesFromTyCon exported_tycons ++
- map getMentionedTyConsAndClassesFromId exported_vals ++
- map getMentionedTyConsAndClassesFromInstInfo exported_inst_infos)
-
- mentionable_classes
- = filter is_mentionable (bagToList mentioned_classes)
- mentionable_tycons
- = [ tc | tc <- bagToList mentioned_tycons,
- is_mentionable tc,
- not (isPrimTyCon tc) ]
-
- nondup_mentioned_tycons = fst (removeDups cmp mentionable_tycons)
- nondup_mentioned_classes = fst (removeDups cmp mentionable_classes)
-
- -- Next: as discussed in the notes, we want the top-level
- -- Ids straight from the final STG code, so we can use
- -- their IdInfos to print pragmas; we slurp them out here,
- -- then pass them to the printing functions, which may
- -- use them.
-
- better_ids = collectExportedStgBinders stg_binds
-
- -- Make a lookup function for convenient access:
-
- better_id_fn i
- = if not (isLocallyDefined i)
- then i -- can't be among our "better_ids"
- else
- let
- eq_fn = if isTopLevId i -- can't trust uniqs
- then (\ x y -> getOrigName x == getOrigName y)
- else eqId
- in
- case [ x | x <- better_ids, x `eq_fn` i ] of
- [] -> pprPanic "better_id_fn:" (ppr PprShowAll i)
- i
- [x] -> x
- _ -> panic "better_id_fn"
-
- -- Finally, we sort everything lexically, so that we always
- -- get the same interface from the same information:
-
- sorted_mentioned_tycons = sortLt ltLexical nondup_mentioned_tycons
- sorted_mentioned_classes = sortLt ltLexical nondup_mentioned_classes
-
- sorted_tycons = sortLt ltLexical exported_tycons
- sorted_classes = sortLt ltLexical exported_classes
- sorted_vals = sortLt ltLexical exported_vals
- sorted_inst_infos = sortLt lt_lexical_inst_info exported_inst_infos
- in
- if (any_purely_local sorted_tycons sorted_classes sorted_vals) then
- -- this will be less of a HACK when we teach
- -- mkInterface to do I/O (WDP 94/10)
- error "Can't produce interface file because of errors!\n"
- else
- ppAboves
- [ppPStr SLIT("{-# GHC_PRAGMA INTERFACE VERSION 7 #-}"),
- ppCat [ppPStr SLIT("interface"), ppPStr modname, ppPStr SLIT("where")],
-
- do_import_decls modname
- sorted_vals sorted_mentioned_classes sorted_mentioned_tycons,
- -- Mustn't give the data constructors to do_import_decls,
- -- because they aren't explicitly imported; their tycon is.
-
- ppAboves (map do_fixity fixity_decls),
- ppAboves (map (pprIfaceClass better_id_fn inline_env) sorted_classes),
- ppAboves (map (do_tycon tycon_specs) sorted_tycons),
- ppAboves (map (do_value better_id_fn inline_env) sorted_vals),
- ppAboves (map (do_instance better_id_fn inline_env) sorted_inst_infos),
-
- ppChar '\n'
- ]
- where
- any_purely_local tycons classes vals
- = any bad_tc tycons || any bad_cl classes || any bad_id vals
- where
- bad_cl cl
- = case (maybePurelyLocalClass cl) of
- Nothing -> False
- Just xs -> naughty_trace cl xs
-
- bad_id id
- = case (maybePurelyLocalType (idType id)) of
- Nothing -> False
- Just xs -> naughty_trace id xs
-
- bad_tc tc
- = case (maybePurelyLocalTyCon tc) of
- Nothing -> False
- Just xs -> if exported_abs then False else naughty_trace tc xs
- where
- exported_abs = case (getExportFlag tc) of { ExportAbs -> True; _ -> False }
-
- naughty_trace x things
- = pprTrace "Can't export -- `"
- (ppBesides [ppr PprForUser x, ppStr "' mentions purely local things: ",
- ppInterleave pp'SP things])
- True
\end{code}
-%************************************************************************
-%* *
-\subsection[imports-MkIface]{Generating `import' declarations in an interface}
-%* *
-%************************************************************************
-
-We gather up lots of (module, name) pairs for which we might print an
-import declaration. We sort them, for the usual canonicalisation
-reasons. NB: We {\em assume} the lists passed in don't have duplicates in
-them! expect).
+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.
-All rather horribly turgid (WDP).
+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@.
\begin{code}
-do_import_decls
- :: FAST_STRING
- -> [Id] -> [Class] -> [TyCon]
- -> Pretty
+startIface :: Module
+ -> IO (Maybe Handle) -- Nothing <=> don't do an interface
-do_import_decls mod_name vals classes tycons
- = let
- -- Conjure up (module, name) pairs for all
- -- the potentially import-decls things:
+ifaceMain :: Maybe Handle
+ -> InterfaceDetails
+ -> IO ()
- vals_names, classes_names, tycons_names :: [(FAST_STRING, FAST_STRING, [Maybe FAST_STRING])]
- vals_names = map get_val_pair vals
- classes_names = map get_class_pair classes
- tycons_names = map get_tycon_pair tycons
- -- sort the (module, name) pairs and chop
- -- them into per-module groups:
+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 ()
- ie_list = sortLt lt (tycons_names ++ classes_names ++ vals_names)
-
- per_module_groups = runs same_module ie_list
- in
- ppAboves (map print_a_decl per_module_groups)
- where
- lt, same_module :: (FAST_STRING, FAST_STRING)
- -> (FAST_STRING, FAST_STRING) -> Bool
-
- lt (m1, ie1, ie2)
- = case (_CMP_STRING_ m1 m2) of { LT_ -> True; EQ_ -> ie1 < ie2; GT__ -> False }
-
- same_module (m1, _, _) (m2, _, _) = m1 == m2
-
- compiling_the_prelude = opt_CompilingPrelude
-
- print_a_decl :: [(FAST_STRING, FAST_STRING, [Maybe FAST_STRING])] -> Pretty
- {-
- Obviously, if the module in question is this one,
- don't print an import declaration.
-
- If it's a Prelude* module, we don't print the TyCons/
- Classes, because the compiler supposedly knows about
- them already (and they are PreludeCore things anyway).
-
- But if we are compiling a Prelude module, then we
- try to do it as "normally" as possible.
- -}
- print_a_decl (ielist@((m,_,_) : _))
- | m == mod_name
- || (not compiling_the_prelude &&
- (m == pRELUDE_CORE || m == pRELUDE_BUILTIN))
- = ppNil
-
- | otherwise
- = ppBesides [ppPStr SLIT("import "), ppPStr m, ppLparen,
- ppIntersperse pp'SP{-'-} (map pp_str [n | (_,n,_) <- ielist]),
- ppRparen
- ]
- where
- isnt_tycon_ish :: FAST_STRING -> Bool
- isnt_tycon_ish str = not (isConop str)
-
- grab_non_Nothings :: [[Maybe FAST_STRING]] -> [FAST_STRING]
-
- grab_non_Nothings rns = catMaybes (concat rns)
-
- pp_str :: FAST_STRING -> Pretty
- pp_str pstr
- = if isAvarop pstr then ppStr ("("++str++")") else ppPStr pstr
- where
- str = _UNPK_ pstr
+endIface :: Maybe Handle -> IO ()
\end{code}
\begin{code}
-get_val_pair :: Id -> (FAST_STRING, FAST_STRING)
-get_class_pair :: Class -> (FAST_STRING, FAST_STRING)
-get_tycon_pair :: TyCon -> (FAST_STRING, FAST_STRING)
-
-get_val_pair id
- = generic_pair id
-
-get_class_pair clas
- = case (generic_pair clas) of { (orig_mod, orig_nm) ->
- let
- nm_to_print = case (getExportFlag clas) of
- ExportAll -> orig_nm _APPEND_ SLIT("(..)") -- nothing like a good HACK!
- ExportAbs -> orig_nm
- NotExported -> orig_nm
- in
- (orig_mod, nm_to_print) }
-
-get_tycon_pair tycon
- = case (generic_pair tycon) of { (orig_mod, orig_nm) ->
- let
- nm_to_print = case (getExportFlag tycon) of
- ExportAll -> orig_nm _APPEND_ SLIT("(..)") -- nothing like a good HACK!
- ExportAbs -> orig_nm
- NotExported -> orig_nm
-
- cons = tyConDataCons tycon
- in
- (orig_mod, nm_to_print) }
-
-generic_pair thing
- = case (getOrigName thing) of { (orig_mod, orig_nm) ->
- case (getOccName thing) of { occur_name ->
- (orig_mod, orig_nm) }}
+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
\end{code}
-%************************************************************************
-%* *
-\subsection[fixities-MkIface]{Generating fixity declarations in an interface}
-%* *
-%************************************************************************
+\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 ()
+\end{code}
\begin{code}
-do_fixity :: -> RenamedFixityDecl -> Pretty
+ifaceUsages if_hdl import_usages
+ = hPutStr if_hdl "_usages_\n" >>
+ hPutCol if_hdl upp_uses (sortLt lt_imp_vers import_usages)
+ 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"
-do_fixity fixity_decl
- = case (getExportFlag (get_name fixity_decl)) of
- ExportAll -> ppr PprInterface fixity_decl
- _ -> ppNil
+ifaceExports if_hdl [] = return ()
+ifaceExports if_hdl avails
+ = hPutStr if_hdl "_exports_\n" >>
+ hPutCol if_hdl do_one_module (fmToList export_fm)
where
- get_name (InfixL n _) = n
- get_name (InfixR n _) = n
- get_name (InfixN n _) = n
-\end{code}
+ -- 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,_) = modAndOcc (availName avail)
+
+ -- 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
+ 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
+
+ for_iface_name name = isLocallyDefined name &&
+ not (isWiredInName name)
+
+ lt_decl d1 d2 = hsDeclName d1 < hsDeclName d2
+\end{code}
%************************************************************************
-%* *
-\subsection[tycons-MkIface]{Generating tycon declarations in an interface}
-%* *
+%* *
+\subsection{Instance declarations}
+%* *
%************************************************************************
-\begin{code}
-do_tycon :: FiniteMap TyCon [(Bool, [Maybe Type])] -> TyCon -> Pretty
-do_tycon tycon_specs_map tycon
- = pprTyCon PprInterface tycon tycon_specs
- where
- tycon_specs = map snd (lookupWithDefaultFM tycon_specs_map [] tycon)
+\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]
\end{code}
+
%************************************************************************
-%* *
-\subsection[values-MkIface]{Generating a value's signature in an interface}
-%* *
+%* *
+\subsection{Printing values}
+%* *
%************************************************************************
\begin{code}
-do_value :: (Id -> Id)
- -> IdEnv UnfoldingDetails
- -> Id
- -> Pretty
-
-do_value better_id_fn inline_env val
- = let
- sty = PprInterface
- better_val = better_id_fn val
- name_str = getOccName better_val -- NB: not orig name!
-
- id_info = getIdInfo better_val
-
- val_ty = let
- orig_ty = idType val
- final_ty = idType better_val
- in
--- ASSERT (orig_ty == final_ty || mkLiftTy orig_ty == final_ty)
- ASSERT (if (orig_ty == final_ty || mkLiftTy orig_ty == final_ty) then True else pprTrace "do_value:" (ppCat [ppr PprDebug val, ppr PprDebug better_val]) False)
- orig_ty
-
- -- Note: We export the type of the original val
- -- The type of an unboxed val will have been *lifted* by the desugarer
- -- In this case we export an unlifted type, but id_info which assumes
- -- a lifted Id i.e. extracted from better_val (above)
- -- The importing module must lift the Id before using the imported id_info
-
- pp_id_info
- = if opt_OmitInterfacePragmas
- || boringIdInfo id_info
- then ppNil
- else ppCat [ppPStr SLIT("\t{-# GHC_PRAGMA"),
- ppIdInfo sty better_val True{-yes specs-}
- better_id_fn inline_env id_info,
- ppPStr SLIT("#-}")]
- in
- ppAbove (ppCat [ppr_non_op name_str,
- ppPStr SLIT("::"), pprGenType sty val_ty])
- pp_id_info
-
--- sadly duplicates Outputable.pprNonOp (ToDo)
-
-ppr_non_op str
- = if isAvarop str -- NOT NEEDED: || isAconop
- then ppBesides [ppLparen, ppPStr str, ppRparen]
- else ppPStr str
+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, pp_double_semi, prag_pretty], new_needed_ids)
+ where
+ pp_double_semi = ppPStr SLIT(";;")
+ 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, pp_double_semi]
+
+ ------------ 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 [ppPStr SLIT("_U_"), pprIfaceUnfolding rhs]
+ | otherwise = ppNil
+
+ show_unfold = not implicit_unfolding && -- Unnecessary
+ (inline_pragma || not dodgy_unfolding) -- Dangerous
+
+ 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
+
+ guidance = calcUnfoldingGuidance inline_pragma
+ opt_InterfaceUnfoldThreshold
+ 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
+
+ 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)
\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"
+ 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)
+\end{code}
+
+
%************************************************************************
-%* *
-\subsection[instances-MkIface]{Generating instance declarations in an interface}
-%* *
+%* *
+\subsection{Random small things}
+%* *
%************************************************************************
-The types of ``dictionary functions'' (dfuns) have just the required
-info for instance declarations in interfaces. However, the dfuns that
-GHC really uses have {\em extra} dictionaries passed to them (for
-efficiency). When we print interfaces, we want to omit that
-dictionary information. (It can be reconsituted on the other end,
-from instance and class decls).
+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}
-do_instance :: (Id -> Id)
- -> IdEnv UnfoldingDetails
- -> InstInfo
- -> Pretty
-
-do_instance better_id_fn inline_env
- (InstInfo clas tv_tmpls ty inst_decl_theta dfun_theta dfun_id constm_ids _ from_here modname _ _)
- = let
- sty = PprInterface
-
- better_dfun = better_id_fn dfun_id
- better_dfun_info = getIdInfo better_dfun
- better_constms = map better_id_fn constm_ids
-
- class_op_strs = map getClassOpString (getClassOps clas)
-
- pragma_begin
- = ppCat [ppPStr SLIT("\t{-# GHC_PRAGMA"), pp_modname, ppPStr SLIT("{-dfun-}"),
- ppIdInfo sty better_dfun False{-NO specs-}
- better_id_fn inline_env better_dfun_info]
-
- pragma_end = ppPStr SLIT("#-}")
-
- pp_modname = if _NULL_ modname
- then ppNil
- else ppCat [ppStr "_M_", ppPStr modname]
-
- name_pragma_pairs
- = pp_the_list [ ppCat [ppChar '\t', ppr_non_op op, ppEquals,
- ppChar '{' ,
- ppIdInfo sty constm True{-YES, specs-}
- better_id_fn inline_env
- (getIdInfo constm),
- ppChar '}' ]
- | (op, constm) <- class_op_strs `zip` better_constms ]
-
-#ifdef DEBUG
- pp_the_list [] = panic "MkIface: no class_ops or better_constms?"
-#endif
- pp_the_list [p] = p
- pp_the_list (p:ps) = ppAbove (ppBeside p ppComma) (pp_the_list ps)
-
- real_stuff
- = ppCat [ppPStr SLIT("instance"),
- ppr sty (mkSigmaTy tv_tmpls inst_decl_theta (mkDictTy clas ty))]
- in
- if opt_OmitInterfacePragmas
- || boringIdInfo better_dfun_info
- then real_stuff
- else ppAbove real_stuff
- ({-ppNest 8 -} -- ppNest does nothing
- if null better_constms
- then ppCat [pragma_begin, pragma_end]
- else ppAbove pragma_begin (ppCat [name_pragma_pairs, pragma_end])
- )
+upp_avail NotAvailable = uppNil
+upp_avail (Avail name) = upp_occname (getOccName name)
+upp_avail (AvailTC name []) = uppNil
+upp_avail (AvailTC name ns) = uppBesides [upp_occname (getOccName name), bang, upp_export ns']
+ where
+ bang | name `elem` ns = uppNil
+ | otherwise = uppChar '!'
+ ns' = filter (/= name) ns
+
+upp_export [] = uppNil
+upp_export names = uppBesides [uppChar '(',
+ uppIntersperse uppSP (map (upp_occname . getOccName) names),
+ uppChar ')']
+
+upp_fixity (occ, (Fixity prec dir, prov)) = uppBesides [upp_dir dir, uppSP,
+ uppInt prec, uppSP,
+ upp_occname occ, uppSemi]
+upp_dir InfixR = uppPStr SLIT("infixr")
+upp_dir InfixL = uppPStr SLIT("infixl")
+upp_dir InfixN = uppPStr SLIT("infix")
+
+ppr_unqual_name :: NamedThing a => a -> Unpretty -- Just its occurrence name
+ppr_unqual_name name = upp_occname (getOccName name)
+
+ppr_name :: NamedThing a => a -> Unpretty -- Its full name
+ppr_name n = uppPStr (nameString (getName n))
+
+upp_occname :: OccName -> Unpretty
+upp_occname occ = uppPStr (occNameString occ)
+
+upp_module :: Module -> Unpretty
+upp_module mod = uppPStr mod
+
+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_tyvar_bndr tv = prettyToUn (pprTyVarBndr PprInterface tv)
+
+ppr_decl decl = prettyToUn (ppr PprInterface decl) `uppBeside` uppSemi
+
+renumber_ty ty = initNmbr (nmbrType ty)
\end{code}
+
%************************************************************************
-%* *
-\subsection[utils-InstInfos]{Utility functions for @InstInfos@}
-%* *
+%* *
+\subsection{Comparisons
+%* *
%************************************************************************
+
-ToDo: perhaps move.
+The various sorts above simply prevent unnecessary "wobbling" when
+things change that don't have to. We therefore compare lexically, not
+by unique
-Classes/TyCons are ``known,'' more-or-less. Prelude TyCons are
-``completely'' known---they don't need to be mentioned in interfaces.
-Classes usually don't need to be mentioned in interfaces, but if we're
-compiling the prelude, then we treat them without special favours.
\begin{code}
-is_exportable_tycon_or_class export_list_fns tc
- = if not (fromPreludeCore tc) then
- True
- else
- in_export_list_or_among_dotdot_modules
- opt_CompilingPrelude -- ignore M.. stuff if compiling prelude
- export_list_fns tc
-
-in_export_list_or_among_dotdot_modules ignore_Mdotdots (in_export_list, among_dotdot_modules) tc
- = if in_export_list (getOccName tc) then
- True
- else
--- pprTrace "in_export:" (ppAbove (ppr PprDebug ignore_Mdotdots) (ppPStr (getOccName tc))) (
- if ignore_Mdotdots then
- False
- else
- any among_dotdot_modules (getInformingModules tc)
--- )
-
-is_mentionable tc
- = not (from_PreludeCore_or_Builtin tc) || opt_CompilingPrelude
- where
- from_PreludeCore_or_Builtin thing
- = let
- mod_name = fst (getOrigName thing)
- in
- mod_name == pRELUDE_CORE || mod_name == pRELUDE_BUILTIN
-
-is_exported_inst_info export_list_fns
- (InstInfo clas _ ty _ _ _ _ _ from_here _ _ _)
- = let
- seems_exported = instanceIsExported clas ty from_here
- (tycon, _, _) = getAppTyCon ty
- in
- if (opt_OmitReexportedInstances && not from_here) then
- False -- Flag says to violate Haskell rules, blatantly
-
- else if not opt_CompilingPrelude
- || not (isFunTyCon tycon || fromPreludeCore tycon)
- || not (fromPreludeCore clas) then
- seems_exported -- take what we got
-
- else -- compiling Prelude & tycon/class are Prelude things...
- from_here
- || in_export_list_or_among_dotdot_modules True{-ignore M..s-} export_list_fns clas
- || in_export_list_or_among_dotdot_modules True{-ignore M..s-} export_list_fns tycon
-\end{code}
+lt_avail :: AvailInfo -> AvailInfo -> Bool
-\begin{code}
-lt_lexical_inst_info (InstInfo _ _ _ _ _ dfun1 _ _ _ _ _ _) (InstInfo _ _ _ _ _ dfun2 _ _ _ _ _ _)
- = ltLexical dfun1 dfun2
+a1 `lt_avail` a2 = availName a1 `lt_name` availName a2
+
+lt_name :: Name -> Name -> Bool
+n1 `lt_name` n2 = modAndOcc n1 < modAndOcc n2
+
+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
+
+sort_versions vs = sortLt lt_vers vs
+
+lt_vers :: LocalVersion Name -> LocalVersion Name -> Bool
+lt_vers (n1,v1) (n2,v2) = n1 `lt_name` n2
\end{code}
+
\begin{code}
-getMentionedTyConsAndClassesFromInstInfo (InstInfo clas _ ty _ dfun_theta _ _ _ _ _ _ _)
- = case (getMentionedTyConsAndClassesFromType ty) of { (ts, cs) ->
- case [ c | (c, _) <- dfun_theta ] of { theta_classes ->
- (ts, (cs `unionBags` listToBag theta_classes) `snocBag` clas)
- }}
+hPutCol :: Handle
+ -> (a -> Unpretty)
+ -> [a]
+ -> IO ()
+hPutCol hdl fmt xs = hPutStr hdl (uppShow 0 (uppAboves (map fmt xs))) >>
+ hPutStr hdl "\n"
\end{code}
projects / ghc-hetmet.git / blobdiff