2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-1996
4 \section[MkIface]{Print an interface for a module}
13 #include "HsVersions.h"
15 import IO ( Handle, hPutStr, openFile,
16 hClose, hPutStrLn, IOMode(..) )
19 import RdrHsSyn ( RdrName(..) )
20 import RnHsSyn ( RenamedHsModule )
21 import BasicTypes ( Fixity(..), FixityDirection(..), NewOrData(..), IfaceFlavour(..),
25 import RnEnv ( availName, ifaceFlavour )
27 import TcInstUtil ( InstInfo(..) )
28 import WorkWrap ( getWorkerIdAndCons )
31 import Id ( idType, dataConRawArgTys, dataConFieldLabels,
32 idInfo, omitIfaceSigForId,
33 dataConStrictMarks, StrictnessMark(..),
34 IdSet, idSetToList, unionIdSets, unitIdSet, minusIdSet,
35 isEmptyIdSet, elementOfIdSet, emptyIdSet, mkIdSet,
36 pprId, getIdSpecialisation,
39 import IdInfo ( IdInfo, StrictnessInfo, ArityInfo, InlinePragInfo(..), inlinePragInfo,
40 arityInfo, ppArityInfo, strictnessInfo, ppStrictnessInfo,
41 bottomIsGuaranteed, workerExists,
43 import CoreSyn ( CoreExpr, CoreBinding, GenCoreExpr, GenCoreBinding(..) )
44 import CoreUnfold ( calcUnfoldingGuidance, UnfoldingGuidance(..), Unfolding )
45 import FreeVars ( addExprFVs )
46 import Name ( isLocallyDefined, isWiredInName, modAndOcc, nameModule, pprOccName,
47 OccName, occNameString, nameOccName, nameString, isExported,
48 Name {-instance NamedThing-}, Provenance, NamedThing(..)
50 import TyCon ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon,
51 tyConTheta, tyConTyVars, tyConDataCons
53 import Class ( Class, classBigSig )
54 import SpecEnv ( specEnvToList )
55 import FieldLabel ( fieldLabelName, fieldLabelType )
56 import Type ( mkSigmaTy, splitSigmaTy, mkDictTy,
57 mkTyVarTys, Type, ThetaType
60 import PprEnv -- not sure how much...
62 import PprCore ( pprIfaceUnfolding )
64 import Bag ( bagToList, isEmptyBag )
65 import Maybes ( catMaybes, maybeToBool )
66 import FiniteMap ( emptyFM, addToFM, addToFM_C, lookupFM, fmToList, eltsFM, FiniteMap )
67 import UniqFM ( UniqFM, lookupUFM, listToUFM )
68 import Util ( sortLt, zipWithEqual, zipWith3Equal, mapAccumL )
72 We have a function @startIface@ to open the output file and put
73 (something like) ``interface Foo'' in it. It gives back a handle
74 for subsequent additions to the interface file.
76 We then have one-function-per-block-of-interface-stuff, e.g.,
77 @ifaceExportList@ produces the @__exports__@ section; it appends
78 to the handle provided by @startIface@.
82 -> IO (Maybe Handle) -- Nothing <=> don't do an interface
84 ifaceMain :: Maybe Handle
89 ifaceDecls :: Maybe Handle
92 -> [Id] -- Ids used at code-gen time; they have better pragma info!
93 -> [CoreBinding] -- In dependency order, later depend on earlier
96 endIface :: Maybe Handle -> IO ()
101 = case opt_ProduceHi of
102 Nothing -> return Nothing -- not producing any .hi file
104 if_hdl <- openFile fn WriteMode
105 hPutStrLn if_hdl ("_interface_ "++ _UNPK_ mod ++ ' ':show (PROJECTVERSION :: Int))
108 endIface Nothing = return ()
109 endIface (Just if_hdl) = hPutStr if_hdl "\n" >> hClose if_hdl
114 ifaceMain Nothing iface_stuff = return ()
115 ifaceMain (Just if_hdl)
116 (import_usages, ExportEnv avails fixities, instance_modules)
118 ifaceInstanceModules if_hdl instance_modules >>
119 ifaceUsages if_hdl import_usages >>
120 ifaceExports if_hdl avails >>
121 ifaceFixities if_hdl fixities >>
124 ifaceDecls Nothing tycons classes inst_info final_ids simplified = return ()
125 ifaceDecls (Just hdl)
129 | null_decls = return ()
130 -- You could have a module with just (re-)exports/instances in it
132 = ifaceInstances hdl inst_infos >>= \ needed_ids ->
133 hPutStr hdl "_declarations_\n" >>
134 ifaceClasses hdl classes >>
135 ifaceTyCons hdl tycons >>
136 ifaceBinds hdl needed_ids final_ids binds >>
139 null_decls = null binds &&
142 isEmptyBag inst_infos
146 ifaceUsages if_hdl import_usages
147 = hPutStr if_hdl "_usages_\n" >>
148 hPutCol if_hdl upp_uses (sortLt lt_imp_vers import_usages)
150 upp_uses (m, hif, mv, whats_imported)
151 = hsep [pprModule m, pp_hif hif, int mv, ptext SLIT("::"),
152 upp_import_versions whats_imported
155 -- Importing the whole module is indicated by an empty list
156 upp_import_versions Everything = empty
158 -- For imported versions we do print the version number
159 upp_import_versions (Specifically nvs)
160 = hsep [ hsep [ppr_unqual_name n, int v] | (n,v) <- sort_versions nvs ]
162 ifaceInstanceModules if_hdl [] = return ()
163 ifaceInstanceModules if_hdl imods
164 = hPutStr if_hdl "_instance_modules_\n" >>
165 printForIface if_hdl (hsep (map ptext (sortLt (<) imods))) >>
168 ifaceExports if_hdl [] = return ()
169 ifaceExports if_hdl avails
170 = hPutStr if_hdl "_exports_\n" >>
171 hPutCol if_hdl do_one_module (fmToList export_fm)
173 -- Sort them into groups by module
174 export_fm :: FiniteMap Module [AvailInfo]
175 export_fm = foldr insert emptyFM avails
177 insert NotAvailable efm = efm
178 insert avail efm = addToFM_C (++) efm mod [avail]
180 mod = nameModule (availName avail)
182 -- Print one module's worth of stuff
183 do_one_module (mod_name, avails@(avail1:_))
184 = hsep [pp_hif (ifaceFlavour (availName avail1)),
186 hsep (map upp_avail (sortLt lt_avail avails))
189 -- The "!" indicates that the exported things came from a hi-boot interface
190 pp_hif HiFile = empty
191 pp_hif HiBootFile = char '!'
193 ifaceFixities if_hdl [] = return ()
194 ifaceFixities if_hdl fixities
195 = hPutStr if_hdl "_fixities_\n" >>
196 hPutCol if_hdl upp_fixity fixities
199 %************************************************************************
201 \subsection{Instance declarations}
203 %************************************************************************
207 ifaceInstances :: Handle -> Bag InstInfo -> IO IdSet -- The IdSet is the needed dfuns
208 ifaceInstances if_hdl inst_infos
209 | null togo_insts = return emptyIdSet
210 | otherwise = hPutStr if_hdl "_instances_\n" >>
211 hPutCol if_hdl pp_inst (sortLt lt_inst togo_insts) >>
214 togo_insts = filter is_togo_inst (bagToList inst_infos)
215 needed_ids = mkIdSet [dfun_id | InstInfo _ _ _ _ _ dfun_id _ _ _ <- togo_insts]
216 is_togo_inst (InstInfo _ _ _ _ _ dfun_id _ _ _) = isLocallyDefined dfun_id
219 lt_inst (InstInfo _ _ _ _ _ dfun_id1 _ _ _)
220 (InstInfo _ _ _ _ _ dfun_id2 _ _ _)
221 = getOccName dfun_id1 < getOccName dfun_id2
222 -- The dfuns are assigned names df1, df2, etc, in order of original textual
223 -- occurrence, and this makes as good a sort order as any
226 pp_inst (InstInfo clas tvs tys theta _ dfun_id _ _ _)
228 forall_ty = mkSigmaTy tvs theta (mkDictTy clas tys)
229 renumbered_ty = nmbrGlobalType forall_ty
231 hcat [ptext SLIT("instance "), pprType renumbered_ty,
232 ptext SLIT(" = "), ppr_unqual_name dfun_id, semi]
236 %************************************************************************
238 \subsection{Printing values}
240 %************************************************************************
243 ifaceId :: (Id -> IdInfo) -- This function "knows" the extra info added
244 -- by the STG passes. Sigh
246 -> IdSet -- Set of Ids that are needed by earlier interface
247 -- file emissions. If the Id isn't in this set, and isn't
248 -- exported, there's no need to emit anything
249 -> Bool -- True <=> recursive, so don't print unfolding
251 -> CoreExpr -- The Id's right hand side
252 -> Maybe (SDoc, IdSet) -- The emitted stuff, plus a possibly-augmented set of needed Ids
254 ifaceId get_idinfo needed_ids is_rec id rhs
255 | not (id `elementOfIdSet` needed_ids || -- Needed [no id in needed_ids has omitIfaceSigForId]
256 (isExported id && not (omitIfaceSigForId id))) -- or exported and not to be omitted
257 = Nothing -- Well, that was easy!
259 ifaceId get_idinfo needed_ids is_rec id rhs
260 = Just (hsep [sig_pretty, pp_double_semi, prag_pretty], new_needed_ids)
262 pp_double_semi = ptext SLIT(";;")
263 idinfo = get_idinfo id
264 inline_pragma = inlinePragInfo idinfo
266 ty_pretty = pprType (nmbrGlobalType (idType id))
267 sig_pretty = hcat [ppr (getOccName id), ptext SLIT(" _:_ "), ty_pretty]
270 | opt_OmitInterfacePragmas = empty
271 | otherwise = hsep [arity_pretty, strict_pretty, unfold_pretty, spec_pretty, pp_double_semi]
273 ------------ Arity --------------
274 arity_pretty = ppArityInfo (arityInfo idinfo)
276 ------------ Strictness --------------
277 strict_info = strictnessInfo idinfo
278 has_worker = workerExists strict_info
279 strict_pretty = ppStrictnessInfo strict_info <+> wrkr_pretty
281 wrkr_pretty | not has_worker = empty
282 | null con_list = pprId work_id
283 | otherwise = pprId work_id <+>
284 braces (hsep (map (pprId) con_list))
286 (work_id, wrapper_cons) = getWorkerIdAndCons id rhs
287 con_list = idSetToList wrapper_cons
289 ------------ Unfolding --------------
290 unfold_pretty | show_unfold = hsep [ptext unfold_herald, pprIfaceUnfolding rhs]
293 unfold_herald = case inline_pragma of
294 IMustBeINLINEd -> SLIT("_U_")
295 IWantToBeINLINEd -> SLIT("_U_")
298 show_unfold = not implicit_unfolding && -- Not unnecessary
299 unfolding_is_ok -- Not dangerous
301 implicit_unfolding = has_worker ||
302 bottomIsGuaranteed strict_info
305 = case inline_pragma of
306 IMustBeINLINEd -> True
307 IWantToBeINLINEd -> True
308 IMustNotBeINLINEd -> False
309 NoPragmaInfo -> case guidance of
310 UnfoldNever -> False -- Too big
313 guidance = calcUnfoldingGuidance opt_InterfaceUnfoldThreshold rhs
315 ------------ Specialisations --------------
316 spec_pretty = hsep (map pp_spec (specEnvToList (getIdSpecialisation id)))
317 pp_spec (tyvars, tys, rhs) = hsep [ptext SLIT("_P_"),
318 if null tyvars then ptext SLIT("[ ]")
319 else brackets (interpp'SP tyvars),
320 -- The lexer interprets "[]" as a CONID. Sigh.
321 hsep (map pprParendType tys),
323 pprIfaceUnfolding rhs
326 ------------ Extra free Ids --------------
327 new_needed_ids = (needed_ids `minusIdSet` unitIdSet id) `unionIdSets`
330 extra_ids | opt_OmitInterfacePragmas = emptyIdSet
331 | otherwise = worker_ids `unionIdSets`
334 worker_ids | has_worker = unitIdSet work_id
335 | otherwise = emptyIdSet
337 unfold_ids | show_unfold = free_vars
338 | otherwise = emptyIdSet
340 (_,free_vars) = addExprFVs interesting emptyIdSet rhs
341 interesting bound id = isLocallyDefined id &&
342 not (id `elementOfIdSet` bound) &&
343 not (omitIfaceSigForId id)
348 -> IdSet -- These Ids are needed already
349 -> [Id] -- Ids used at code-gen time; they have better pragma info!
350 -> [CoreBinding] -- In dependency order, later depend on earlier
353 ifaceBinds hdl needed_ids final_ids binds
354 = mapIO (printForIface hdl) pretties >>
357 final_id_map = listToUFM [(id,id) | id <- final_ids]
358 get_idinfo id = case lookupUFM final_id_map id of
359 Just id' -> idInfo id'
360 Nothing -> pprTrace "ifaceBinds not found:" (ppr id) $
363 pretties = go needed_ids (reverse binds) -- Reverse so that later things will
364 -- provoke earlier ones to be emitted
365 go needed [] = if not (isEmptyIdSet needed) then
366 pprTrace "ifaceBinds: free vars:"
367 (sep (map ppr (idSetToList needed))) $
372 go needed (NonRec id rhs : binds)
373 = case ifaceId get_idinfo needed False id rhs of
374 Nothing -> go needed binds
375 Just (pretty, needed') -> pretty : go needed' binds
377 -- Recursive groups are a bit more of a pain. We may only need one to
378 -- start with, but it may call out the next one, and so on. So we
379 -- have to look for a fixed point.
380 go needed (Rec pairs : binds)
381 = pretties ++ go needed'' binds
383 (needed', pretties) = go_rec needed pairs
384 needed'' = needed' `minusIdSet` mkIdSet (map fst pairs)
385 -- Later ones may spuriously cause earlier ones to be "needed" again
387 go_rec :: IdSet -> [(Id,CoreExpr)] -> (IdSet, [SDoc])
389 | null pretties = (needed, [])
390 | otherwise = (final_needed, more_pretties ++ pretties)
392 reduced_pairs = [pair | (pair,Nothing) <- pairs `zip` maybes]
393 pretties = catMaybes maybes
394 (needed', maybes) = mapAccumL do_one needed pairs
395 (final_needed, more_pretties) = go_rec needed' reduced_pairs
397 do_one needed (id,rhs) = case ifaceId get_idinfo needed True id rhs of
398 Nothing -> (needed, Nothing)
399 Just (pretty, needed') -> (needed', Just pretty)
403 %************************************************************************
405 \subsection{Random small things}
407 %************************************************************************
410 ifaceTyCons hdl tycons = hPutCol hdl upp_tycon (sortLt (<) (filter (for_iface_name . getName) tycons ))
411 ifaceClasses hdl classes = hPutCol hdl upp_class (sortLt (<) (filter (for_iface_name . getName) classes))
413 for_iface_name name = isLocallyDefined name &&
414 not (isWiredInName name)
416 upp_tycon tycon = ifaceTyCon tycon
417 upp_class clas = ifaceClass clas
422 ifaceTyCon :: TyCon -> SDoc
425 = hsep [ ptext SLIT("type"),
427 pprTyVarBndrs tyvars,
433 (tyvars, ty) = getSynTyConDefn tycon
437 = hsep [ ptext keyword,
438 ppr_decl_context (tyConTheta tycon),
440 pprTyVarBndrs (tyConTyVars tycon),
442 hsep (punctuate (ptext SLIT(" | ")) (map ppr_con (tyConDataCons tycon))),
446 keyword | isNewTyCon tycon = SLIT("newtype")
447 | otherwise = SLIT("data")
452 hsep (map ppr_arg_ty (strict_marks `zip` arg_tys))
457 braces $ hsep $ punctuate comma (map ppr_field (strict_marks `zip` field_labels))
460 field_labels = dataConFieldLabels data_con
461 arg_tys = dataConRawArgTys data_con
462 strict_marks = dataConStrictMarks data_con
463 name = getName data_con
465 ppr_arg_ty (strict_mark, ty) = ppr_strict_mark strict_mark <> pprParendType ty
467 ppr_strict_mark NotMarkedStrict = empty
468 ppr_strict_mark MarkedStrict = ptext SLIT("! ")
469 -- The extra space helps the lexical analyser that lexes
470 -- interface files; it doesn't make the rigid operator/identifier
471 -- distinction, so "!a" is a valid identifier so far as it is concerned
473 ppr_field (strict_mark, field_label)
474 = hsep [ ppr (fieldLabelName field_label),
476 ppr_strict_mark strict_mark <> pprParendType (fieldLabelType field_label)
480 = pprPanic "pprIfaceTyDecl" (ppr tycon)
483 = hsep [ptext SLIT("class"),
484 ppr_decl_context sc_theta,
485 ppr clas, -- Print the name
486 pprTyVarBndrs clas_tyvars,
491 (clas_tyvars, sc_theta, _, sel_ids, defms) = classBigSig clas
493 pp_ops | null sel_ids = empty
494 | otherwise = hsep [ptext SLIT("where"),
495 braces (hsep (punctuate semi (zipWith ppr_classop sel_ids defms)))
498 ppr_classop sel_id maybe_defm
499 = ASSERT( sel_tyvars == clas_tyvars)
500 hsep [ppr (getOccName sel_id),
501 if maybeToBool maybe_defm then equals else empty,
506 (sel_tyvars, _, op_ty) = splitSigmaTy (idType sel_id)
508 ppr_decl_context :: ThetaType -> SDoc
509 ppr_decl_context [] = empty
510 ppr_decl_context theta
511 = braces (hsep (punctuate comma (map (ppr_dict) theta)))
515 ppr_dict (clas,tys) = ppr clas <+> hsep (map pprParendType tys)
518 %************************************************************************
520 \subsection{Random small things}
522 %************************************************************************
524 When printing export lists, we print like this:
526 AvailTC C [C, x, y] C(x,y)
527 AvailTC C [x, y] C!(x,y) -- Exporting x, y but not C
530 upp_avail NotAvailable = empty
531 upp_avail (Avail name) = upp_occname (getOccName name)
532 upp_avail (AvailTC name []) = empty
533 upp_avail (AvailTC name ns) = hcat [upp_occname (getOccName name), bang, upp_export ns']
535 bang | name `elem` ns = empty
536 | otherwise = char '|'
537 ns' = filter (/= name) ns
539 upp_export [] = empty
540 upp_export names = parens (hsep (map (upp_occname . getOccName) names))
542 upp_fixity (occ, fixity) = hcat [ppr fixity, space, upp_occname occ, semi]
544 ppr_unqual_name :: NamedThing a => a -> SDoc -- Just its occurrence name
545 ppr_unqual_name name = upp_occname (getOccName name)
547 upp_occname :: OccName -> SDoc
548 upp_occname occ = ptext (occNameString occ)
552 %************************************************************************
554 \subsection{Comparisons
556 %************************************************************************
559 The various sorts above simply prevent unnecessary "wobbling" when
560 things change that don't have to. We therefore compare lexically, not
564 lt_avail :: AvailInfo -> AvailInfo -> Bool
566 a1 `lt_avail` a2 = availName a1 `lt_name` availName a2
568 lt_name :: Name -> Name -> Bool
569 n1 `lt_name` n2 = modAndOcc n1 < modAndOcc n2
571 lt_lexical :: NamedThing a => a -> a -> Bool
572 lt_lexical a1 a2 = getName a1 `lt_name` getName a2
574 lt_imp_vers :: ImportVersion a -> ImportVersion a -> Bool
575 lt_imp_vers (m1,_,_,_) (m2,_,_,_) = m1 < m2
577 sort_versions vs = sortLt lt_vers vs
579 lt_vers :: LocalVersion Name -> LocalVersion Name -> Bool
580 lt_vers (n1,v1) (n2,v2) = n1 `lt_name` n2
589 hPutCol hdl fmt xs = mapIO (printForIface hdl . fmt) xs
591 mapIO :: (a -> IO b) -> [a] -> IO ()
592 mapIO f [] = return ()
593 mapIO f (x:xs) = f x >> mapIO f xs