2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
4 \section[MkIface]{Print an interface for a module}
8 startIface, endIface, ifaceDecls
11 #include "HsVersions.h"
13 import IO ( Handle, hPutStr, openFile,
14 hClose, hPutStrLn, IOMode(..) )
17 import BasicTypes ( Fixity(..), FixityDirection(..), NewOrData(..) )
19 import RnEnv ( availName )
21 import TcInstUtil ( InstInfo(..) )
24 import Id ( Id, idType, idInfo, omitIfaceSigForId, isUserExportedId,
29 import DataCon ( StrictnessMark(..), dataConSig, dataConFieldLabels, dataConStrictMarks )
30 import IdInfo ( IdInfo, StrictnessInfo, ArityInfo, InlinePragInfo(..), inlinePragInfo,
31 arityInfo, ppArityInfo,
32 strictnessInfo, ppStrictnessInfo, isBottomingStrictness,
33 cafInfo, ppCafInfo, specInfo,
35 workerExists, workerInfo, ppWorkerInfo
37 import CoreSyn ( CoreExpr, CoreBind, Bind(..), rulesRules, rulesRhsFreeVars )
38 import CoreFVs ( exprSomeFreeVars, ruleSomeLhsFreeVars, ruleSomeFreeVars )
39 import CoreUnfold ( calcUnfoldingGuidance, okToUnfoldInHiFile, couldBeSmallEnoughToInline )
40 import Module ( moduleString, pprModule, pprModuleName )
41 import Name ( isLocallyDefined, isWiredInName, nameRdrName, nameModule,
44 import OccName ( OccName, pprOccName )
45 import TyCon ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon,
46 tyConTheta, tyConTyVars, tyConDataCons
48 import Class ( Class, classBigSig )
49 import FieldLabel ( fieldLabelName, fieldLabelType )
50 import Type ( mkSigmaTy, splitSigmaTy, mkDictTy, tidyTopType, deNoteType,
55 import PprCore ( pprIfaceUnfolding, pprCoreRule )
56 import Rules ( pprProtoCoreRule, ProtoCoreRule(..) )
58 import Bag ( bagToList, isEmptyBag )
59 import Maybes ( catMaybes, maybeToBool )
60 import FiniteMap ( emptyFM, addToFM, addToFM_C, fmToList, FiniteMap )
61 import UniqFM ( lookupUFM, listToUFM )
62 import UniqSet ( uniqSetToList )
63 import Util ( sortLt, mapAccumL )
68 We have a function @startIface@ to open the output file and put
69 (something like) ``interface Foo'' in it. It gives back a handle
70 for subsequent additions to the interface file.
72 We then have one-function-per-block-of-interface-stuff, e.g.,
73 @ifaceExportList@ produces the @__exports__@ section; it appends
74 to the handle provided by @startIface@.
77 startIface :: Module -> InterfaceDetails
78 -> IO (Maybe Handle) -- Nothing <=> don't do an interface
80 ifaceDecls :: Maybe Handle
83 -> [Id] -- Ids used at code-gen time; they have better pragma info!
84 -> [CoreBind] -- In dependency order, later depend on earlier
85 -> [ProtoCoreRule] -- Rules
88 endIface :: Maybe Handle -> IO ()
92 startIface mod (has_orphans, import_usages, ExportEnv avails fixities)
93 = case opt_ProduceHi of
94 Nothing -> return Nothing ; -- not producing any .hi file
97 if_hdl <- openFile fn WriteMode
98 hPutStr if_hdl ("__interface " ++ moduleString mod)
99 hPutStr if_hdl (' ' : show (opt_HiVersion :: Int) ++ orphan_indicator)
100 hPutStrLn if_hdl " where"
101 ifaceExports if_hdl avails
102 ifaceImports if_hdl import_usages
103 ifaceFixities if_hdl fixities
106 orphan_indicator | has_orphans = " !"
109 endIface Nothing = return ()
110 endIface (Just if_hdl) = hPutStr if_hdl "\n" >> hClose if_hdl
115 ifaceDecls Nothing tycons classes inst_info final_ids simplified rules = return ()
116 ifaceDecls (Just hdl)
120 orphan_rules -- Rules defined locally for an Id that is *not* defined locally
121 | null_decls = return ()
122 -- You could have a module with just (re-)exports/instances in it
124 = ifaceClasses hdl classes >>
125 ifaceInstances hdl inst_infos >>= \ inst_ids ->
126 ifaceTyCons hdl tycons >>
127 ifaceBinds hdl (inst_ids `unionVarSet` orphan_rule_ids)
128 final_ids binds >>= \ emitted_ids ->
129 ifaceRules hdl orphan_rules emitted_ids >>
132 orphan_rule_ids = unionVarSets [ ruleSomeFreeVars interestingId rule
133 | ProtoCoreRule _ _ rule <- orphan_rules]
135 null_decls = null binds &&
138 isEmptyBag inst_infos &&
143 ifaceImports if_hdl import_usages
144 = hPutCol if_hdl upp_uses (sortLt lt_imp_vers import_usages)
146 upp_uses (m, mv, has_orphans, whats_imported)
147 = hsep [ptext SLIT("import"), pprModuleName m,
149 upp_import_versions whats_imported
152 pp_orphan | has_orphans = ptext SLIT("!")
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 = dcolon <+> hsep [ hsep [ppr_unqual_name n, int v] | (n,v) <- sort_versions nvs ]
162 ifaceModuleDeps if_hdl [] = return ()
163 ifaceModuleDeps if_hdl mod_deps
165 lines = map ppr_mod_dep mod_deps
166 ppr_mod_dep (mod, contains_orphans)
167 | contains_orphans = pprModuleName mod <+> ptext SLIT("!")
168 | otherwise = pprModuleName mod
170 printForIface if_hdl (ptext SLIT("__depends") <+> vcat lines <> ptext SLIT(" ;")) >>
173 ifaceExports if_hdl [] = return ()
174 ifaceExports if_hdl avails
175 = hPutCol if_hdl do_one_module (fmToList export_fm)
177 -- Sort them into groups by module
178 export_fm :: FiniteMap Module [AvailInfo]
179 export_fm = foldr insert emptyFM avails
181 insert avail efm = addToFM_C (++) efm mod [avail]
183 mod = nameModule (availName avail)
185 -- Print one module's worth of stuff
186 do_one_module :: (Module, [AvailInfo]) -> SDoc
187 do_one_module (mod_name, avails@(avail1:_))
188 = ptext SLIT("__export ") <>
189 hsep [pprModule mod_name,
190 hsep (map upp_avail (sortLt lt_avail avails))
193 ifaceFixities if_hdl [] = return ()
194 ifaceFixities if_hdl fixities
195 = hPutCol if_hdl upp_fixity fixities
197 ifaceRules if_hdl rules emitted
198 | null orphan_rule_pretties && null local_id_pretties
201 = do printForIface if_hdl (vcat [
202 ptext SLIT("{-## __R"),
204 vcat orphan_rule_pretties,
206 vcat local_id_pretties,
213 orphan_rule_pretties = [ pprCoreRule (Just fn) rule <+> semi
214 | ProtoCoreRule _ fn rule <- rules
216 local_id_pretties = [ pprCoreRule (Just fn) rule <+> semi
217 | fn <- varSetElems emitted,
218 rule <- rulesRules (getIdSpecialisation fn),
219 all (`elemVarSet` emitted) (varSetElems (ruleSomeLhsFreeVars interestingId rule))
220 -- Spit out a rule only if all its lhs free vars are eemitted
224 %************************************************************************
226 \subsection{Instance declarations}
228 %************************************************************************
232 ifaceInstances :: Handle -> Bag InstInfo -> IO IdSet -- The IdSet is the needed dfuns
233 ifaceInstances if_hdl inst_infos
234 | null togo_insts = return emptyVarSet
235 | otherwise = hPutCol if_hdl pp_inst (sortLt lt_inst togo_insts) >>
238 togo_insts = filter is_togo_inst (bagToList inst_infos)
239 needed_ids = mkVarSet [dfun_id | InstInfo _ _ _ _ dfun_id _ _ _ <- togo_insts]
240 is_togo_inst (InstInfo _ _ _ _ dfun_id _ _ _) = isLocallyDefined dfun_id
243 lt_inst (InstInfo _ _ _ _ dfun_id1 _ _ _)
244 (InstInfo _ _ _ _ dfun_id2 _ _ _)
245 = getOccName dfun_id1 < getOccName dfun_id2
246 -- The dfuns are assigned names df1, df2, etc, in order of original textual
247 -- occurrence, and this makes as good a sort order as any
250 pp_inst (InstInfo clas tvs tys theta dfun_id _ _ _)
252 -- The deNoteType is very important. It removes all type
253 -- synonyms from the instance type in interface files.
254 -- That in turn makes sure that when reading in instance decls
255 -- from interface files that the 'gating' mechanism works properly.
256 -- Otherwise you could have
257 -- type Tibble = T Int
258 -- instance Foo Tibble where ...
259 -- and this instance decl wouldn't get imported into a module
260 -- that mentioned T but not Tibble.
261 forall_ty = mkSigmaTy tvs theta (deNoteType (mkDictTy clas tys))
262 renumbered_ty = tidyTopType forall_ty
264 hcat [ptext SLIT("instance "), pprType renumbered_ty,
265 ptext SLIT(" = "), ppr_unqual_name dfun_id, semi]
269 %************************************************************************
271 \subsection{Printing values}
273 %************************************************************************
276 ifaceId :: (Id -> IdInfo) -- This function "knows" the extra info added
277 -- by the STG passes. Sigh
279 -> IdSet -- Set of Ids that are needed by earlier interface
280 -- file emissions. If the Id isn't in this set, and isn't
281 -- exported, there's no need to emit anything
282 -> Bool -- True <=> recursive, so don't print unfolding
284 -> CoreExpr -- The Id's right hand side
285 -> Maybe (SDoc, IdSet) -- The emitted stuff, plus any *extra* needed Ids
287 ifaceId get_idinfo needed_ids is_rec id rhs
288 | not (id `elemVarSet` needed_ids || -- Needed [no id in needed_ids has omitIfaceSigForId]
289 (isUserExportedId id && not (omitIfaceSigForId id))) -- or exported and not to be omitted
290 = Nothing -- Well, that was easy!
292 ifaceId get_idinfo needed_ids is_rec id rhs
293 = Just (hsep [sig_pretty, prag_pretty, char ';'], new_needed_ids)
295 core_idinfo = idInfo id
296 stg_idinfo = get_idinfo id
298 ty_pretty = pprType (idType id)
299 sig_pretty = hsep [ppr (getOccName id), dcolon, ty_pretty]
302 | opt_OmitInterfacePragmas = empty
303 | otherwise = hsep [ptext SLIT("{-##"),
312 ------------ Arity --------------
313 arity_pretty = ppArityInfo (arityInfo stg_idinfo)
315 ------------ Caf Info --------------
316 caf_pretty = ppCafInfo (cafInfo stg_idinfo)
318 ------------ CPR Info --------------
319 cpr_pretty = ppCprInfo (cprInfo core_idinfo)
321 ------------ Strictness --------------
322 strict_info = strictnessInfo core_idinfo
323 bottoming_fn = isBottomingStrictness strict_info
324 strict_pretty = ppStrictnessInfo strict_info
326 ------------ Worker --------------
327 work_info = workerInfo core_idinfo
328 has_worker = workerExists work_info
329 wrkr_pretty = ppWorkerInfo work_info
330 Just work_id = work_info
333 ------------ Unfolding --------------
334 inline_pragma = inlinePragInfo core_idinfo
335 dont_inline = case inline_pragma of
336 IMustNotBeINLINEd -> True
337 IAmALoopBreaker -> True
340 unfold_pretty | show_unfold = ptext SLIT("__u") <+> pprIfaceUnfolding rhs
343 show_unfold = not has_worker && -- Not unnecessary
344 not bottoming_fn && -- Not necessary
346 rhs_is_small && -- Small enough
347 okToUnfoldInHiFile rhs -- No casms etc
349 rhs_is_small = couldBeSmallEnoughToInline (calcUnfoldingGuidance opt_UF_HiFileThreshold rhs)
351 ------------ Specialisations --------------
352 spec_info = specInfo core_idinfo
354 ------------ Extra free Ids --------------
355 new_needed_ids | opt_OmitInterfacePragmas = emptyVarSet
356 | otherwise = worker_ids `unionVarSet`
357 unfold_ids `unionVarSet`
360 worker_ids | has_worker && interestingId work_id = unitVarSet work_id
361 -- Conceivably, the worker might come from
363 | otherwise = emptyVarSet
365 spec_ids = filterVarSet interestingId (rulesRhsFreeVars spec_info)
367 unfold_ids | show_unfold = find_fvs rhs
368 | otherwise = emptyVarSet
370 find_fvs expr = exprSomeFreeVars interestingId expr
372 interestingId id = isId id && isLocallyDefined id &&
373 not (omitIfaceSigForId id)
378 -> IdSet -- These Ids are needed already
379 -> [Id] -- Ids used at code-gen time; they have better pragma info!
380 -> [CoreBind] -- In dependency order, later depend on earlier
381 -> IO IdSet -- Set of Ids actually spat out
383 ifaceBinds hdl needed_ids final_ids binds
384 = mapIO (printForIface hdl) (bagToList pretties) >>
388 final_id_map = listToUFM [(id,id) | id <- final_ids]
389 get_idinfo id = case lookupUFM final_id_map id of
390 Just id' -> idInfo id'
391 Nothing -> pprTrace "ifaceBinds not found:" (ppr id) $
394 (pretties, emitted) = go needed_ids (reverse binds) emptyBag emptyVarSet
395 -- Reverse so that later things will
396 -- provoke earlier ones to be emitted
397 go needed [] pretties emitted
398 | not (isEmptyVarSet needed) = pprTrace "ifaceBinds: free vars:"
399 (sep (map ppr (varSetElems needed)))
401 | otherwise = (pretties, emitted)
403 go needed (NonRec id rhs : binds) pretties emitted
404 = case ifaceId get_idinfo needed False id rhs of
405 Nothing -> go needed binds pretties emitted
406 Just (pretty, extras) -> let
407 needed' = (needed `unionVarSet` extras) `delVarSet` id
408 -- 'extras' can include the Id itself via a rule
409 emitted' = emitted `extendVarSet` id
411 go needed' binds (pretty `consBag` pretties) emitted'
413 -- Recursive groups are a bit more of a pain. We may only need one to
414 -- start with, but it may call out the next one, and so on. So we
415 -- have to look for a fixed point.
416 go needed (Rec pairs : binds) pretties emitted
417 = go needed' binds pretties' emitted'
419 (new_pretties, new_emitted, extras) = go_rec needed pairs
420 pretties' = new_pretties `unionBags` pretties
421 needed' = (needed `unionVarSet` extras) `minusVarSet` mkVarSet (map fst pairs)
422 emitted' = emitted `unionVarSet` new_emitted
424 go_rec :: IdSet -> [(Id,CoreExpr)] -> (Bag SDoc, IdSet, IdSet)
426 | null pretties = (emptyBag, emptyVarSet, emptyVarSet)
427 | otherwise = (more_pretties `unionBags` listToBag pretties,
428 more_emitted `unionVarSet` mkVarSet emitted,
429 more_extras `unionVarSet` extras)
431 maybes = map do_one pairs
432 emitted = [id | ((id,_), Just _) <- pairs `zip` maybes]
433 reduced_pairs = [pair | (pair, Nothing) <- pairs `zip` maybes]
434 (pretties, extras_s) = unzip (catMaybes maybes)
435 extras = unionVarSets extras_s
436 (more_pretties, more_emitted, more_extras) = go_rec extras reduced_pairs
438 do_one (id,rhs) = ifaceId get_idinfo needed True id rhs
442 %************************************************************************
444 \subsection{Random small things}
446 %************************************************************************
449 ifaceTyCons hdl tycons = hPutCol hdl upp_tycon (sortLt (<) (filter (for_iface_name . getName) tycons ))
450 ifaceClasses hdl classes = hPutCol hdl upp_class (sortLt (<) (filter (for_iface_name . getName) classes))
452 for_iface_name name = isLocallyDefined name &&
453 not (isWiredInName name)
455 upp_tycon tycon = ifaceTyCon tycon
456 upp_class clas = ifaceClass clas
461 ifaceTyCon :: TyCon -> SDoc
464 = hsep [ ptext SLIT("type"),
466 pprTyVarBndrs tyvars,
472 (tyvars, ty) = getSynTyConDefn tycon
476 = hsep [ ptext keyword,
477 ppr_decl_context (tyConTheta tycon),
479 pprTyVarBndrs (tyConTyVars tycon),
481 hsep (punctuate (ptext SLIT(" | ")) (map ppr_con (tyConDataCons tycon))),
485 keyword | isNewTyCon tycon = SLIT("newtype")
486 | otherwise = SLIT("data")
488 tyvars = tyConTyVars tycon
492 = ASSERT( tycon == tycon1 && tyvars == tyvars1 )
493 hsep [ ppr_ex ex_tyvars ex_theta,
495 hsep (map ppr_arg_ty (strict_marks `zip` arg_tys))
499 = hsep [ ppr_ex ex_tyvars ex_theta,
501 braces $ hsep $ punctuate comma (map ppr_field (strict_marks `zip` field_labels))
504 (tyvars1, theta1, ex_tyvars, ex_theta, arg_tys, tycon1) = dataConSig data_con
505 field_labels = dataConFieldLabels data_con
506 strict_marks = dataConStrictMarks data_con
507 name = getName data_con
509 ppr_ex [] ex_theta = ASSERT( null ex_theta ) empty
510 ppr_ex ex_tvs ex_theta = ptext SLIT("__forall") <+> brackets (pprTyVarBndrs ex_tvs)
511 <+> pprIfaceTheta ex_theta <+> ptext SLIT("=>")
513 ppr_arg_ty (strict_mark, ty) = ppr_strict_mark strict_mark <> pprParendType ty
515 ppr_strict_mark NotMarkedStrict = empty
516 ppr_strict_mark (MarkedUnboxed _ _) = ptext SLIT("! ! ")
517 ppr_strict_mark MarkedStrict = ptext SLIT("! ")
519 ppr_field (strict_mark, field_label)
520 = hsep [ ppr (fieldLabelName field_label),
522 ppr_strict_mark strict_mark <> pprParendType (fieldLabelType field_label)
526 = pprPanic "pprIfaceTyDecl" (ppr tycon)
529 = hsep [ptext SLIT("class"),
530 ppr_decl_context sc_theta,
531 ppr clas, -- Print the name
532 pprTyVarBndrs clas_tyvars,
537 (clas_tyvars, sc_theta, _, sel_ids, defms) = classBigSig clas
539 pp_ops | null sel_ids = empty
540 | otherwise = hsep [ptext SLIT("where"),
541 braces (hsep (punctuate semi (zipWith ppr_classop sel_ids defms)))
544 ppr_classop sel_id maybe_defm
545 = ASSERT( sel_tyvars == clas_tyvars)
546 hsep [ppr (getOccName sel_id),
547 if maybeToBool maybe_defm then equals else empty,
552 (sel_tyvars, _, op_ty) = splitSigmaTy (idType sel_id)
554 ppr_decl_context :: ThetaType -> SDoc
555 ppr_decl_context [] = empty
556 ppr_decl_context theta = pprIfaceTheta theta <+> ptext SLIT(" =>")
558 pprIfaceTheta :: ThetaType -> SDoc -- Use braces rather than parens in interface files
559 pprIfaceTheta [] = empty
560 pprIfaceTheta theta = braces (hsep (punctuate comma [pprConstraint c tys | (c,tys) <- theta]))
563 %************************************************************************
565 \subsection{Random small things}
567 %************************************************************************
569 When printing export lists, we print like this:
571 AvailTC C [C, x, y] C(x,y)
572 AvailTC C [x, y] C!(x,y) -- Exporting x, y but not C
575 upp_avail :: AvailInfo -> SDoc
576 upp_avail (Avail name) = pprOccName (getOccName name)
577 upp_avail (AvailTC name []) = empty
578 upp_avail (AvailTC name ns) = hcat [pprOccName (getOccName name), bang, upp_export ns']
580 bang | name `elem` ns = empty
581 | otherwise = char '|'
582 ns' = filter (/= name) ns
584 upp_export :: [Name] -> SDoc
585 upp_export [] = empty
586 upp_export names = braces (hsep (map (pprOccName . getOccName) names))
588 upp_fixity :: (Name, Fixity) -> SDoc
589 upp_fixity (name, fixity) = hsep [ptext SLIT("0"), ppr fixity, ppr name, semi]
590 -- Dummy version number!
592 ppr_unqual_name :: NamedThing a => a -> SDoc -- Just its occurrence name
593 ppr_unqual_name name = pprOccName (getOccName name)
597 %************************************************************************
599 \subsection{Comparisons}
601 %************************************************************************
604 The various sorts above simply prevent unnecessary "wobbling" when
605 things change that don't have to. We therefore compare lexically, not
609 lt_avail :: AvailInfo -> AvailInfo -> Bool
611 a1 `lt_avail` a2 = availName a1 `lt_name` availName a2
613 lt_name :: Name -> Name -> Bool
614 n1 `lt_name` n2 = nameRdrName n1 < nameRdrName n2
616 lt_lexical :: NamedThing a => a -> a -> Bool
617 lt_lexical a1 a2 = getName a1 `lt_name` getName a2
619 lt_imp_vers :: ImportVersion a -> ImportVersion a -> Bool
620 lt_imp_vers (m1,_,_,_) (m2,_,_,_) = m1 < m2
622 sort_versions vs = sortLt lt_vers vs
624 lt_vers :: LocalVersion Name -> LocalVersion Name -> Bool
625 lt_vers (n1,v1) (n2,v2) = n1 `lt_name` n2
634 hPutCol hdl fmt xs = mapIO (printForIface hdl . fmt) xs
636 mapIO :: (a -> IO b) -> [a] -> IO ()
637 mapIO f [] = return ()
638 mapIO f (x:xs) = f x >> mapIO f xs