2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-1996
4 \section[MkIface]{Print an interface for a module}
7 #include "HsVersions.h"
16 IMPORT_1_3(IO(Handle,hPutStr,openFile,hClose,IOMode(..)))
19 import RdrHsSyn ( RdrName(..) )
20 import RnHsSyn ( SYN_IE(RenamedHsModule) )
21 import BasicTypes ( Fixity(..), FixityDirection(..), NewOrData(..) )
23 import RnEnv ( availName )
25 import TcInstUtil ( InstInfo(..) )
28 import Id ( idType, dataConRawArgTys, dataConFieldLabels,
29 getIdInfo, getInlinePragma, omitIfaceSigForId,
30 dataConStrictMarks, StrictnessMark(..),
31 SYN_IE(IdSet), idSetToList, unionIdSets, unitIdSet, minusIdSet,
32 isEmptyIdSet, elementOfIdSet, emptyIdSet, mkIdSet,
33 GenId{-instance NamedThing/Outputable-}, SYN_IE(Id)
36 import IdInfo ( StrictnessInfo, ArityInfo,
37 arityInfo, ppArityInfo, strictnessInfo, ppStrictnessInfo,
38 getWorkerId_maybe, bottomIsGuaranteed, IdInfo
40 import CoreSyn ( SYN_IE(CoreExpr), SYN_IE(CoreBinding), GenCoreExpr, GenCoreBinding(..) )
41 import CoreUnfold ( calcUnfoldingGuidance, UnfoldingGuidance(..), Unfolding )
42 import FreeVars ( addExprFVs )
43 import Name ( isLocallyDefined, isWiredInName, modAndOcc, getName, nameModule, pprOccName,
44 OccName, occNameString, nameOccName, nameString, isExported,
45 Name {-instance NamedThing-}, Provenance, NamedThing(..)
47 import TyCon ( TyCon(..) {-instance NamedThing-} )
48 import Class ( GenClass(..){-instance NamedThing-}, SYN_IE(Class), GenClassOp,
49 classOpLocalType, classSig )
50 import FieldLabel ( FieldLabel{-instance NamedThing-},
51 fieldLabelName, fieldLabelType )
52 import Type ( mkSigmaTy, mkDictTy, getAppTyCon,
53 mkTyVarTy, SYN_IE(Type)
55 import TyVar ( GenTyVar {- instance Eq -} )
56 import Unique ( Unique {- instance Eq -} )
58 import PprEnv -- not sure how much...
59 import Outputable ( PprStyle(..), Outputable(..) )
61 import PprCore ( pprIfaceUnfolding )
63 import Outputable ( printDoc )
66 import Bag ( bagToList, isEmptyBag )
67 import Maybes ( catMaybes, maybeToBool )
68 import FiniteMap ( emptyFM, addToFM, addToFM_C, lookupFM, fmToList, eltsFM, FiniteMap )
69 import UniqFM ( UniqFM, lookupUFM, listToUFM )
70 import Util ( sortLt, zipWithEqual, zipWith3Equal, mapAccumL,
71 assertPanic, panic{-ToDo:rm-}, pprTrace,
76 We have a function @startIface@ to open the output file and put
77 (something like) ``interface Foo'' in it. It gives back a handle
78 for subsequent additions to the interface file.
80 We then have one-function-per-block-of-interface-stuff, e.g.,
81 @ifaceExportList@ produces the @__exports__@ section; it appends
82 to the handle provided by @startIface@.
86 -> IO (Maybe Handle) -- Nothing <=> don't do an interface
88 ifaceMain :: Maybe Handle
93 ifaceDecls :: Maybe Handle
96 -> [Id] -- Ids used at code-gen time; they have better pragma info!
97 -> [CoreBinding] -- In dependency order, later depend on earlier
100 endIface :: Maybe Handle -> IO ()
105 = case opt_ProduceHi of
106 Nothing -> return Nothing -- not producing any .hi file
108 openFile fn WriteMode >>= \ if_hdl ->
109 hPutStr if_hdl ("{-# GHC_PRAGMA INTERFACE VERSION 20 #-}\n_interface_ "++ _UNPK_ mod ++ "\n") >>
112 endIface Nothing = return ()
113 endIface (Just if_hdl) = hPutStr if_hdl "\n" >> hClose if_hdl
118 ifaceMain Nothing iface_stuff = return ()
119 ifaceMain (Just if_hdl)
120 (import_usages, ExportEnv avails fixities, instance_modules)
122 ifaceInstanceModules if_hdl instance_modules >>
123 ifaceUsages if_hdl import_usages >>
124 ifaceExports if_hdl avails >>
125 ifaceFixities if_hdl fixities >>
128 ifaceDecls Nothing tycons classes inst_info final_ids simplified = return ()
129 ifaceDecls (Just hdl)
133 | null_decls = return ()
134 -- You could have a module with just (re-)exports/instances in it
136 = ifaceInstances hdl inst_infos >>= \ needed_ids ->
137 hPutStr hdl "_declarations_\n" >>
138 ifaceClasses hdl classes >>
139 ifaceTyCons hdl tycons >>
140 ifaceBinds hdl needed_ids final_ids binds >>
143 null_decls = null binds &&
146 isEmptyBag inst_infos
150 ifaceUsages if_hdl import_usages
151 = hPutStr if_hdl "_usages_\n" >>
152 hPutCol if_hdl upp_uses (sortLt lt_imp_vers import_usages)
154 upp_uses (m, mv, versions)
155 = hcat [upp_module m, space, int mv, ptext SLIT(" :: "),
156 upp_import_versions (sort_versions versions), semi]
158 -- For imported versions we do print the version number
159 upp_import_versions nvs
160 = hsep [ hsep [ppr_unqual_name n, int v] | (n,v) <- nvs ]
163 ifaceInstanceModules if_hdl [] = return ()
164 ifaceInstanceModules if_hdl imods
165 = hPutStr if_hdl "_instance_modules_\n" >>
166 printDoc OneLineMode if_hdl (hsep (map ptext (sortLt (<) imods))) >>
169 ifaceExports if_hdl [] = return ()
170 ifaceExports if_hdl avails
171 = hPutStr if_hdl "_exports_\n" >>
172 hPutCol if_hdl do_one_module (fmToList export_fm)
174 -- Sort them into groups by module
175 export_fm :: FiniteMap Module [AvailInfo]
176 export_fm = foldr insert emptyFM avails
178 insert NotAvailable efm = efm
179 insert avail efm = addToFM_C (++) efm mod [avail]
181 mod = nameModule (availName avail)
183 -- Print one module's worth of stuff
184 do_one_module (mod_name, avails)
185 = hcat [upp_module mod_name, space,
186 hsep (map upp_avail (sortLt lt_avail avails)),
189 ifaceFixities if_hdl [] = return ()
190 ifaceFixities if_hdl fixities
191 = hPutStr if_hdl "_fixities_\n" >>
192 hPutCol if_hdl upp_fixity fixities
195 %************************************************************************
197 \subsection{Instance declarations}
199 %************************************************************************
203 ifaceInstances :: Handle -> Bag InstInfo -> IO IdSet -- The IdSet is the needed dfuns
204 ifaceInstances if_hdl inst_infos
205 | null togo_insts = return emptyIdSet
206 | otherwise = hPutStr if_hdl "_instances_\n" >>
207 hPutCol if_hdl pp_inst (sortLt lt_inst togo_insts) >>
210 togo_insts = filter is_togo_inst (bagToList inst_infos)
211 needed_ids = mkIdSet [dfun_id | InstInfo _ _ _ _ _ dfun_id _ _ _ <- togo_insts]
212 is_togo_inst (InstInfo _ _ _ _ _ dfun_id _ _ _) = isLocallyDefined dfun_id
215 lt_inst (InstInfo _ _ _ _ _ dfun_id1 _ _ _)
216 (InstInfo _ _ _ _ _ dfun_id2 _ _ _)
217 = getOccName dfun_id1 < getOccName dfun_id2
218 -- The dfuns are assigned names df1, df2, etc, in order of original textual
219 -- occurrence, and this makes as good a sort order as any
222 pp_inst (InstInfo clas tvs ty theta _ dfun_id _ _ _)
224 forall_ty = mkSigmaTy tvs theta (mkDictTy clas ty)
225 renumbered_ty = renumber_ty forall_ty
227 hcat [ptext SLIT("instance "), ppr_ty renumbered_ty,
228 ptext SLIT(" = "), ppr_unqual_name dfun_id, semi]
232 %************************************************************************
234 \subsection{Printing values}
236 %************************************************************************
239 ifaceId :: (Id -> IdInfo) -- This function "knows" the extra info added
240 -- by the STG passes. Sigh
242 -> IdSet -- Set of Ids that are needed by earlier interface
243 -- file emissions. If the Id isn't in this set, and isn't
244 -- exported, there's no need to emit anything
245 -> Bool -- True <=> recursive, so don't print unfolding
247 -> CoreExpr -- The Id's right hand side
248 -> Maybe (Doc, IdSet) -- The emitted stuff, plus a possibly-augmented set of needed Ids
250 ifaceId get_idinfo needed_ids is_rec id rhs
251 | not (id `elementOfIdSet` needed_ids || -- Needed [no id in needed_ids has omitIfaceSigForId]
252 (isExported id && not (omitIfaceSigForId id))) -- or exported and not to be omitted
253 = Nothing -- Well, that was easy!
255 ifaceId get_idinfo needed_ids is_rec id rhs
256 = Just (hsep [sig_pretty, pp_double_semi, prag_pretty], new_needed_ids)
258 pp_double_semi = ptext SLIT(";;")
259 idinfo = get_idinfo id
260 inline_pragma = getInlinePragma id
262 ty_pretty = pprType PprInterface (initNmbr (nmbrType (idType id)))
263 sig_pretty = hcat [ppr PprInterface (getOccName id), ptext SLIT(" _:_ "), ty_pretty]
266 | opt_OmitInterfacePragmas = empty
267 | otherwise = hsep [arity_pretty, strict_pretty, unfold_pretty, pp_double_semi]
269 ------------ Arity --------------
270 arity_pretty = ppArityInfo PprInterface (arityInfo idinfo)
272 ------------ Strictness --------------
273 strict_info = strictnessInfo idinfo
274 maybe_worker = getWorkerId_maybe strict_info
275 strict_pretty = ppStrictnessInfo PprInterface strict_info
277 ------------ Unfolding --------------
278 unfold_pretty | show_unfold = hsep [ptext SLIT("_U_"), pprIfaceUnfolding rhs]
281 show_unfold = not implicit_unfolding && -- Not unnecessary
282 not dodgy_unfolding -- Not dangerous
284 implicit_unfolding = maybeToBool maybe_worker ||
285 bottomIsGuaranteed strict_info
287 dodgy_unfolding = case guidance of -- True <=> too big to show, or the Inline pragma
288 UnfoldNever -> True -- says it shouldn't be inlined
291 guidance = calcUnfoldingGuidance inline_pragma
292 opt_InterfaceUnfoldThreshold
296 ------------ Extra free Ids --------------
297 new_needed_ids = (needed_ids `minusIdSet` unitIdSet id) `unionIdSets`
300 extra_ids | opt_OmitInterfacePragmas = emptyIdSet
301 | otherwise = worker_ids `unionIdSets`
304 worker_ids = case maybe_worker of
305 Just wkr -> unitIdSet wkr
306 Nothing -> emptyIdSet
308 unfold_ids | show_unfold = free_vars
309 | otherwise = emptyIdSet
311 (_,free_vars) = addExprFVs interesting emptyIdSet rhs
312 interesting bound id = isLocallyDefined id &&
313 not (id `elementOfIdSet` bound) &&
314 not (omitIfaceSigForId id)
319 -> IdSet -- These Ids are needed already
320 -> [Id] -- Ids used at code-gen time; they have better pragma info!
321 -> [CoreBinding] -- In dependency order, later depend on earlier
324 ifaceBinds hdl needed_ids final_ids binds
325 = mapIO (printDoc OneLineMode hdl) pretties >>
328 final_id_map = listToUFM [(id,id) | id <- final_ids]
329 get_idinfo id = case lookupUFM final_id_map id of
330 Just id' -> getIdInfo id'
331 Nothing -> pprTrace "ifaceBinds not found:" (ppr PprDebug id) $
334 pretties = go needed_ids (reverse binds) -- Reverse so that later things will
335 -- provoke earlier ones to be emitted
336 go needed [] = if not (isEmptyIdSet needed) then
337 pprTrace "ifaceBinds: free vars:"
338 (sep (map (ppr PprDebug) (idSetToList needed))) $
343 go needed (NonRec id rhs : binds)
344 = case ifaceId get_idinfo needed False id rhs of
345 Nothing -> go needed binds
346 Just (pretty, needed') -> pretty : go needed' binds
348 -- Recursive groups are a bit more of a pain. We may only need one to
349 -- start with, but it may call out the next one, and so on. So we
350 -- have to look for a fixed point.
351 go needed (Rec pairs : binds)
352 = pretties ++ go needed'' binds
354 (needed', pretties) = go_rec needed pairs
355 needed'' = needed' `minusIdSet` mkIdSet (map fst pairs)
356 -- Later ones may spuriously cause earlier ones to be "needed" again
358 go_rec :: IdSet -> [(Id,CoreExpr)] -> (IdSet, [Doc])
360 | null pretties = (needed, [])
361 | otherwise = (final_needed, more_pretties ++ pretties)
363 reduced_pairs = [pair | (pair,Nothing) <- pairs `zip` maybes]
364 pretties = catMaybes maybes
365 (needed', maybes) = mapAccumL do_one needed pairs
366 (final_needed, more_pretties) = go_rec needed' reduced_pairs
368 do_one needed (id,rhs) = case ifaceId get_idinfo needed True id rhs of
369 Nothing -> (needed, Nothing)
370 Just (pretty, needed') -> (needed', Just pretty)
374 %************************************************************************
376 \subsection{Random small things}
378 %************************************************************************
381 ifaceTyCons hdl tycons = hPutCol hdl upp_tycon (sortLt (<) (filter (for_iface_name . getName) tycons ))
382 ifaceClasses hdl classes = hPutCol hdl upp_class (sortLt (<) (filter (for_iface_name . getName) classes))
384 for_iface_name name = isLocallyDefined name &&
385 not (isWiredInName name)
387 upp_tycon tycon = ifaceTyCon PprInterface tycon
388 upp_class clas = ifaceClass PprInterface clas
393 ifaceTyCon :: PprStyle -> TyCon -> Doc
396 DataTyCon uniq name kind tyvars theta data_cons deriv new_or_data
397 -> hsep [ ptext (keyword new_or_data),
398 ppr_decl_context sty theta,
400 hsep (map (pprTyVarBndr sty) tyvars),
402 hsep (punctuate (ptext SLIT(" | ")) (map ppr_con data_cons)),
406 SynTyCon uniq name kind arity tyvars ty
407 -> hsep [ ptext SLIT("type"),
409 hsep (map (pprTyVarBndr sty) tyvars),
414 other -> pprPanic "pprIfaceTyDecl" (ppr PprDebug tycon)
416 keyword NewType = SLIT("newtype")
417 keyword DataType = SLIT("data")
421 = hsep [ ppr sty name,
422 hsep (map ppr_arg_ty (strict_marks `zip` arg_tys))
426 = hsep [ ppr sty name,
427 braces $ hsep $ punctuate comma (map ppr_field (strict_marks `zip` field_labels))
430 field_labels = dataConFieldLabels data_con
431 arg_tys = dataConRawArgTys data_con
432 strict_marks = dataConStrictMarks data_con
433 name = getName data_con
435 ppr_arg_ty (strict_mark, ty) = ppr_strict_mark strict_mark <> pprParendType sty ty
437 ppr_strict_mark NotMarkedStrict = empty
438 ppr_strict_mark MarkedStrict = ptext SLIT("! ")
439 -- The extra space helps the lexical analyser that lexes
440 -- interface files; it doesn't make the rigid operator/identifier
441 -- distinction, so "!a" is a valid identifier so far as it is concerned
443 ppr_field (strict_mark, field_label)
444 = hsep [ ppr sty (fieldLabelName field_label),
446 ppr_strict_mark strict_mark <> pprParendType sty (fieldLabelType field_label)
450 = hsep [ptext SLIT("class"),
451 ppr_decl_context sty theta,
452 ppr sty clas, -- Print the name
453 pprTyVarBndr sty tyvar,
458 (tyvar, super_classes, ops) = classSig clas
459 theta = super_classes `zip` repeat (mkTyVarTy tyvar)
461 pp_ops | null ops = empty
462 | otherwise = hsep [ptext SLIT("where"),
463 braces (hsep (punctuate semi (map ppr_classop ops)))
466 ppr_classop op = hsep [ppr sty (getOccName op),
468 ppr sty (classOpLocalType op)
471 ppr_decl_context :: PprStyle -> [(Class,Type)] -> Doc
472 ppr_decl_context sty [] = empty
473 ppr_decl_context sty theta
474 = braces (hsep (punctuate comma (map (ppr_dict) theta)))
478 ppr_dict (clas,ty) = hsep [ppr sty clas, ppr sty ty]
481 %************************************************************************
483 \subsection{Random small things}
485 %************************************************************************
487 When printing export lists, we print like this:
489 AvailTC C [C, x, y] C(x,y)
490 AvailTC C [x, y] C!(x,y) -- Exporting x, y but not C
493 upp_avail NotAvailable = empty
494 upp_avail (Avail name) = upp_occname (getOccName name)
495 upp_avail (AvailTC name []) = empty
496 upp_avail (AvailTC name ns) = hcat [upp_occname (getOccName name), bang, upp_export ns']
498 bang | name `elem` ns = empty
499 | otherwise = char '!'
500 ns' = filter (/= name) ns
502 upp_export [] = empty
503 upp_export names = hcat [char '(',
504 hsep (map (upp_occname . getOccName) names),
507 upp_fixity (occ, (Fixity prec dir, prov)) = hcat [upp_dir dir, space,
509 upp_occname occ, semi]
510 upp_dir InfixR = ptext SLIT("infixr")
511 upp_dir InfixL = ptext SLIT("infixl")
512 upp_dir InfixN = ptext SLIT("infix")
514 ppr_unqual_name :: NamedThing a => a -> Doc -- Just its occurrence name
515 ppr_unqual_name name = upp_occname (getOccName name)
517 ppr_name :: NamedThing a => a -> Doc -- Its full name
518 ppr_name n = ptext (nameString (getName n))
520 upp_occname :: OccName -> Doc
521 upp_occname occ = ptext (occNameString occ)
523 upp_module :: Module -> Doc
524 upp_module mod = ptext mod
526 uppSemid x = ppr PprInterface x <> semi -- micro util
528 ppr_ty ty = pprType PprInterface ty
529 ppr_tyvar tv = ppr PprInterface tv
530 ppr_tyvar_bndr tv = pprTyVarBndr PprInterface tv
532 ppr_decl decl = ppr PprInterface decl <> semi
534 renumber_ty ty = initNmbr (nmbrType ty)
538 %************************************************************************
540 \subsection{Comparisons
542 %************************************************************************
545 The various sorts above simply prevent unnecessary "wobbling" when
546 things change that don't have to. We therefore compare lexically, not
550 lt_avail :: AvailInfo -> AvailInfo -> Bool
552 a1 `lt_avail` a2 = availName a1 `lt_name` availName a2
554 lt_name :: Name -> Name -> Bool
555 n1 `lt_name` n2 = modAndOcc n1 < modAndOcc n2
557 lt_lexical :: NamedThing a => a -> a -> Bool
558 lt_lexical a1 a2 = getName a1 `lt_name` getName a2
560 lt_imp_vers :: ImportVersion a -> ImportVersion a -> Bool
561 lt_imp_vers (m1,_,_) (m2,_,_) = m1 < m2
563 sort_versions vs = sortLt lt_vers vs
565 lt_vers :: LocalVersion Name -> LocalVersion Name -> Bool
566 lt_vers (n1,v1) (n2,v2) = n1 `lt_name` n2
575 hPutCol hdl fmt xs = mapIO (printDoc OneLineMode hdl . fmt) xs
577 mapIO :: (a -> IO b) -> [a] -> IO ()
578 mapIO f [] = return ()
579 mapIO f (x:xs) = f x >> mapIO f xs