2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
4 \section[MkIface]{Print an interface for a module}
8 mkModDetails, mkModDetailsFromIface, completeIface,
12 #include "HsVersions.h"
15 import HsCore ( HsIdInfo(..), UfExpr(..), toUfExpr, toUfBndr )
16 import HsTypes ( toHsTyVars )
17 import BasicTypes ( Fixity(..), NewOrData(..),
18 Version, initialVersion, bumpVersion, isLoopBreaker
21 import RnHsSyn ( RenamedInstDecl, RenamedTyClDecl )
22 import TcHsSyn ( TypecheckedRuleDecl )
23 import HscTypes ( VersionInfo(..), IfaceDecls(..), ModIface(..), ModDetails(..),
24 TyThing(..), DFunId, TypeEnv, isTyClThing, Avails,
25 WhatsImported(..), GenAvailInfo(..),
26 ImportVersion, AvailInfo, Deprecations(..),
31 import Id ( Id, idType, idInfo, omitIfaceSigForId, isUserExportedId, hasNoBinding,
32 idSpecialisation, idName, setIdInfo
36 import DataCon ( StrictnessMark(..), dataConSig, dataConFieldLabels, dataConStrictMarks )
38 import CoreSyn ( CoreExpr, CoreBind, Bind(..), CoreRule(..), IdCoreRule,
39 isBuiltinRule, rulesRules, rulesRhsFreeVars, emptyCoreRules,
42 import CoreFVs ( exprSomeFreeVars, ruleSomeLhsFreeVars, ruleSomeFreeVars )
43 import CoreUnfold ( okToUnfoldInHiFile, mkTopUnfolding, neverUnfold, unfoldingTemplate, noUnfolding )
44 import Name ( isLocallyDefined, getName,
46 plusNameEnv, lookupNameEnv, emptyNameEnv, mkNameEnv,
47 extendNameEnv, lookupNameEnv_NF, nameEnvElts
49 import OccName ( pprOccName )
50 import TyCon ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon,
51 tyConTheta, tyConTyVars, tyConDataCons, tyConFamilySize
53 import Class ( classExtraBigSig, DefMeth(..) )
54 import FieldLabel ( fieldLabelType )
55 import Type ( splitSigmaTy, tidyTopType, deNoteType )
56 import SrcLoc ( noSrcLoc )
58 import Module ( ModuleName, moduleName )
59 import Finder ( findModule )
61 import List ( partition )
62 import IO ( IOMode(..), openFile, hClose )
66 %************************************************************************
68 \subsection{Write a new interface file}
70 %************************************************************************
73 mkModDetails :: TypeEnv -> [DFunId] -- From typechecker
74 -> [CoreBind] -> [Id] -- Final bindings, plus the top-level Ids from the
75 -- code generator; they have authoritative arity info
76 -> [IdCoreRule] -- Tidy orphan rules
78 mkModDetails type_env dfun_ids tidy_binds stg_ids orphan_rules
79 = ModDetails { md_types = new_type_env,
83 -- The competed type environment is gotten from
84 -- a) keeping the types and classes
85 -- b) removing all Ids, and Ids with correct IdInfo
86 -- gotten from the bindings
87 new_type_env = mkNameEnv [(getName tycl, tycl) | tycl <- orig_type_env, isTyClThing tycl]
89 mkNameEnv [(idName id, AnId id) | id <- final_ids]
91 orig_type_env = nameEnvElts type_env
93 final_ids = bindsToIds (mkVarSet dfun_ids `unionVarSet` orphan_rule_ids)
97 -- The complete rules are gotten by combining
98 -- a) the orphan rules
99 -- b) rules embedded in the top-level Ids
100 rule_dcls | opt_OmitInterfacePragmas = []
101 | otherwise = getRules orphan_rules tidy_binds (mkVarSet final_ids)
103 orphan_rule_ids = unionVarSets [ ruleSomeFreeVars interestingId rule
104 | (_, rule) <- orphan_rules]
107 -- This version is used when we are re-linking a module
108 -- so we've only run the type checker on its previous interface
109 mkModDetailsFromIface :: TypeEnv -> [DFunId] -- From typechecker
110 -> [TypecheckedRuleDecl]
112 mkModDetailsFromIface type_env dfun_ids rules
113 = ModDetails { md_types = type_env,
114 md_rules = rule_dcls,
115 md_insts = dfun_ids }
117 rule_dcls = [(id,rule) | IfaceRuleOut id rule <- rules]
118 -- All the rules from an interface are of the IfaceRuleOut form
121 completeIface :: Maybe ModIface -- The old interface, if we have it
122 -> ModIface -- The new one, minus the decls and versions
123 -> ModDetails -- The ModDetails for this module
124 -> Maybe (ModIface, SDoc) -- The new one, complete with decls and versions
125 -- The SDoc is a debug document giving differences
126 -- Nothing => no change
128 -- NB: 'Nothing' means that even the usages havn't changed, so there's no
129 -- need to write a new interface file. But even if the usages have
130 -- changed, the module version may not have.
132 -- The IO in the type is solely for debug output
133 -- In particular, dumping a record of what has changed
134 completeIface maybe_old_iface new_iface mod_details
135 = addVersionInfo maybe_old_iface (new_iface { mi_decls = new_decls })
137 new_decls = IfaceDecls { dcl_tycl = ty_cls_dcls,
138 dcl_insts = inst_dcls,
139 dcl_rules = rule_dcls }
141 inst_dcls = map ifaceInstance (md_insts mod_details)
142 ty_cls_dcls = map ifaceTyCls (nameEnvElts (md_types mod_details))
143 rule_dcls = map ifaceRule (md_rules mod_details)
147 %************************************************************************
149 \subsection{Types and classes}
151 %************************************************************************
154 ifaceTyCls :: TyThing -> RenamedTyClDecl
155 ifaceTyCls (AClass clas)
156 = ClassDecl (toHsContext sc_theta)
158 (toHsTyVars clas_tyvars)
160 (map toClassOpSig op_stuff)
164 (clas_tyvars, clas_fds, sc_theta, _, op_stuff) = classExtraBigSig clas
166 toClassOpSig (sel_id, def_meth)
167 = ASSERT(sel_tyvars == clas_tyvars)
168 ClassOpSig (getName sel_id) (Just def_meth') (toHsType op_ty) noSrcLoc
170 (sel_tyvars, _, op_ty) = splitSigmaTy (idType sel_id)
171 def_meth' = case def_meth of
172 NoDefMeth -> NoDefMeth
173 GenDefMeth -> GenDefMeth
174 DefMeth id -> DefMeth (getName id)
176 ifaceTyCls (ATyCon tycon)
178 = TySynonym (getName tycon)(toHsTyVars tyvars) (toHsType ty) noSrcLoc
180 (tyvars, ty) = getSynTyConDefn tycon
182 ifaceTyCls (ATyCon tycon)
184 = TyData new_or_data (toHsContext (tyConTheta tycon))
187 (map ifaceConDecl (tyConDataCons tycon))
188 (tyConFamilySize tycon)
189 Nothing noSrcLoc (panic "gen1") (panic "gen2")
191 tyvars = tyConTyVars tycon
192 new_or_data | isNewTyCon tycon = NewType
193 | otherwise = DataType
195 ifaceConDecl data_con
196 = ConDecl (getName data_con) (error "ifaceConDecl")
197 (toHsTyVars ex_tyvars)
198 (toHsContext ex_theta)
201 (tyvars1, _, ex_tyvars, ex_theta, arg_tys, tycon1) = dataConSig data_con
202 field_labels = dataConFieldLabels data_con
203 strict_marks = dataConStrictMarks data_con
204 details | null field_labels
205 = ASSERT( tycon == tycon1 && tyvars == tyvars1 )
206 VanillaCon (zipWith mk_bang_ty strict_marks arg_tys)
209 = RecCon (zipWith mk_field strict_marks field_labels)
211 mk_bang_ty NotMarkedStrict ty = Unbanged (toHsType ty)
212 mk_bang_ty (MarkedUnboxed _ _) ty = Unpacked (toHsType ty)
213 mk_bang_ty MarkedStrict ty = Banged (toHsType ty)
215 mk_field strict_mark field_label
216 = ([getName field_label], mk_bang_ty strict_mark (fieldLabelType field_label))
218 ifaceTyCls (ATyCon tycon) = pprPanic "ifaceTyCls" (ppr tycon)
221 = IfaceSig (getName id) (toHsType id_type) hs_idinfo noSrcLoc
226 hs_idinfo | opt_OmitInterfacePragmas = []
227 | otherwise = arity_hsinfo ++ caf_hsinfo ++ cpr_hsinfo ++
228 strict_hsinfo ++ wrkr_hsinfo ++ unfold_hsinfo
230 ------------ Arity --------------
231 arity_hsinfo = case arityInfo id_info of
232 a@(ArityExactly n) -> [HsArity a]
235 ------------ Caf Info --------------
236 caf_hsinfo = case cafInfo id_info of
237 NoCafRefs -> [HsNoCafRefs]
240 ------------ CPR Info --------------
241 cpr_hsinfo = case cprInfo id_info of
242 ReturnsCPR -> [HsCprInfo]
245 ------------ Strictness --------------
246 strict_hsinfo = case strictnessInfo id_info of
247 NoStrictnessInfo -> []
248 info -> [HsStrictness info]
251 ------------ Worker --------------
252 wrkr_hsinfo = case workerInfo id_info of
253 HasWorker work_id wrap_arity -> [HsWorker (getName work_id)]
256 ------------ Unfolding --------------
257 unfold_info = unfoldingInfo id_info
258 inline_prag = inlinePragInfo id_info
259 rhs = unfoldingTemplate unfold_info
260 unfold_hsinfo | neverUnfold unfold_info = []
261 | otherwise = [HsUnfold inline_prag (toUfExpr rhs)]
265 %************************************************************************
267 \subsection{Instances and rules}
269 %************************************************************************
272 ifaceInstance :: DFunId -> RenamedInstDecl
273 ifaceInstance dfun_id
274 = InstDecl (toHsType tidy_ty) EmptyMonoBinds [] (Just (getName dfun_id)) noSrcLoc
276 tidy_ty = tidyTopType (deNoteType (idType dfun_id))
277 -- The deNoteType is very important. It removes all type
278 -- synonyms from the instance type in interface files.
279 -- That in turn makes sure that when reading in instance decls
280 -- from interface files that the 'gating' mechanism works properly.
281 -- Otherwise you could have
282 -- type Tibble = T Int
283 -- instance Foo Tibble where ...
284 -- and this instance decl wouldn't get imported into a module
285 -- that mentioned T but not Tibble.
287 ifaceRule (id, BuiltinRule _)
288 = pprTrace "toHsRule: builtin" (ppr id) (bogusIfaceRule id)
290 ifaceRule (id, Rule name bndrs args rhs)
291 = IfaceRule name (map toUfBndr bndrs) (getName id)
292 (map toUfExpr args) (toUfExpr rhs) noSrcLoc
295 = IfaceRule SLIT("bogus") [] (getName id) [] (UfVar (getName id)) noSrcLoc
299 %************************************************************************
301 \subsection{Compute final Ids}
303 %************************************************************************
305 A "final Id" has exactly the IdInfo for going into an interface file, or
306 exporting to another module.
309 bindsToIds :: IdSet -- These Ids are needed already
310 -> IdSet -- Ids used at code-gen time; they have better pragma info!
311 -> [CoreBind] -- In dependency order, later depend on earlier
312 -> [Id] -- Set of Ids actually spat out, complete with exactly the IdInfo
313 -- they need for exporting to another module
315 bindsToIds needed_ids codegen_ids binds
316 = go needed_ids (reverse binds) []
317 -- Reverse so that later things will
318 -- provoke earlier ones to be emitted
320 -- The 'needed' set contains the Ids that are needed by earlier
321 -- interface file emissions. If the Id isn't in this set, and isn't
322 -- exported, there's no need to emit anything
323 need_id needed_set id = id `elemVarSet` needed_set || isUserExportedId id
326 | not (isEmptyVarSet needed) = pprTrace "ifaceBinds: free vars:"
327 (sep (map ppr (varSetElems needed)))
329 | otherwise = emitted
331 go needed (NonRec id rhs : binds) emitted
333 = if omitIfaceSigForId id then
334 go (needed `delVarSet` id) binds (id:emitted)
336 go ((needed `unionVarSet` extras) `delVarSet` id)
340 = go needed binds emitted
342 (new_id, extras) = mkFinalId codegen_ids False id rhs
344 -- Recursive groups are a bit more of a pain. We may only need one to
345 -- start with, but it may call out the next one, and so on. So we
346 -- have to look for a fixed point. We don't want necessarily them all,
347 -- because without -O we may only need the first one (if we don't emit
349 go needed (Rec pairs : binds) emitted
350 = go needed' binds emitted'
352 (new_emitted, extras) = go_rec needed pairs
353 needed' = (needed `unionVarSet` extras) `minusVarSet` mkVarSet (map fst pairs)
354 emitted' = new_emitted ++ emitted
356 go_rec :: IdSet -> [(Id,CoreExpr)] -> ([Id], IdSet)
358 | null needed_prs = ([], emptyVarSet)
359 | otherwise = (emitted ++ more_emitted,
360 extras `unionVarSet` more_extras)
362 (needed_prs,leftover_prs) = partition is_needed pairs
363 (emitted, extras_s) = unzip [ mkFinalId codegen_ids True id rhs
364 | (id,rhs) <- needed_prs, not (omitIfaceSigForId id)]
365 extras = unionVarSets extras_s
366 (more_emitted, more_extras) = go_rec extras leftover_prs
368 is_needed (id,_) = need_id needed id
374 mkFinalId :: IdSet -- The Ids with arity info from the code generator
375 -> Bool -- True <=> recursive, so don't include unfolding
377 -> CoreExpr -- The Id's right hand side
378 -> (Id, IdSet) -- The emitted id, plus any *extra* needed Ids
380 mkFinalId codegen_ids is_rec id rhs
381 = (id `setIdInfo` new_idinfo, new_needed_ids)
383 core_idinfo = idInfo id
384 stg_idinfo = case lookupVarSet codegen_ids id of
385 Just id' -> idInfo id'
386 Nothing -> pprTrace "ifaceBinds not found:" (ppr id) $
389 new_idinfo | opt_OmitInterfacePragmas
392 = core_idinfo `setArityInfo` arity_info
393 `setCafInfo` cafInfo stg_idinfo
394 `setUnfoldingInfo` unfold_info
395 `setWorkerInfo` worker_info
396 `setSpecInfo` emptyCoreRules
397 -- We zap the specialisations because they are
398 -- passed on separately through the modules IdCoreRules
400 ------------ Arity --------------
401 arity_info = arityInfo stg_idinfo
402 stg_arity = arityLowerBound arity_info
404 ------------ Worker --------------
405 -- We only treat a function as having a worker if
406 -- the exported arity (which is now the number of visible lambdas)
407 -- is the same as the arity at the moment of the w/w split
408 -- If so, we can safely omit the unfolding inside the wrapper, and
409 -- instead re-generate it from the type/arity/strictness info
410 -- But if the arity has changed, we just take the simple path and
411 -- put the unfolding into the interface file, forgetting the fact
412 -- that it's a wrapper.
414 -- How can this happen? Sometimes we get
415 -- f = coerce t (\x y -> $wf x y)
416 -- at the moment of w/w split; but the eta reducer turns it into
418 -- which is perfectly fine except that the exposed arity so far as
419 -- the code generator is concerned (zero) differs from the arity
420 -- when we did the split (2).
422 -- All this arises because we use 'arity' to mean "exactly how many
423 -- top level lambdas are there" in interface files; but during the
424 -- compilation of this module it means "how many things can I apply
426 worker_info = case workerInfo core_idinfo of
427 info@(HasWorker work_id wrap_arity)
428 | wrap_arity == stg_arity -> info
429 | otherwise -> pprTrace "ifaceId: arity change:" (ppr id)
433 has_worker = case worker_info of
434 HasWorker _ _ -> True
437 HasWorker work_id _ = worker_info
439 ------------ Unfolding --------------
440 inline_pragma = inlinePragInfo core_idinfo
441 dont_inline = isNeverInlinePrag inline_pragma
442 loop_breaker = isLoopBreaker (occInfo core_idinfo)
443 bottoming_fn = isBottomingStrictness (strictnessInfo core_idinfo)
445 unfolding = mkTopUnfolding rhs
446 rhs_is_small = neverUnfold unfolding
448 unfold_info | show_unfold = unfolding
449 | otherwise = noUnfolding
451 show_unfold = not has_worker && -- Not unnecessary
452 not bottoming_fn && -- Not necessary
455 rhs_is_small && -- Small enough
456 okToUnfoldInHiFile rhs -- No casms etc
459 ------------ Extra free Ids --------------
460 new_needed_ids | opt_OmitInterfacePragmas = emptyVarSet
461 | otherwise = worker_ids `unionVarSet`
462 unfold_ids `unionVarSet`
465 spec_ids = filterVarSet interestingId (rulesRhsFreeVars (specInfo core_idinfo))
467 worker_ids | has_worker && interestingId work_id = unitVarSet work_id
468 -- Conceivably, the worker might come from
470 | otherwise = emptyVarSet
472 unfold_ids | show_unfold = find_fvs rhs
473 | otherwise = emptyVarSet
475 find_fvs expr = exprSomeFreeVars interestingId expr
477 interestingId id = isId id && isLocallyDefined id && not (hasNoBinding id)
482 getRules :: [IdCoreRule] -- Orphan rules
483 -> [CoreBind] -- Bindings, with rules in the top-level Ids
484 -> IdSet -- Ids that are exported, so we need their rules
486 getRules orphan_rules binds emitted
487 = orphan_rules ++ local_rules
489 local_rules = [ (fn, rule)
490 | fn <- bindersOfBinds binds,
491 fn `elemVarSet` emitted,
492 rule <- rulesRules (idSpecialisation fn),
493 not (isBuiltinRule rule),
494 -- We can't print builtin rules in interface files
495 -- Since they are built in, an importing module
496 -- will have access to them anyway
498 -- Sept 00: I've disabled this test. It doesn't stop many, if any, rules
499 -- from coming out, and to make it work properly we need to add ????
500 -- (put it back in for now)
501 all (`elemVarSet` emitted) (varSetElems (ruleSomeLhsFreeVars interestingId rule))
502 -- Spit out a rule only if all its lhs free vars are emitted
503 -- This is a good reason not to do it when we emit the Id itself
508 %************************************************************************
510 \subsection{Checking if the new interface is up to date
512 %************************************************************************
515 addVersionInfo :: Maybe ModIface -- The old interface, read from M.hi
516 -> ModIface -- The new interface decls
517 -> Maybe (ModIface, SDoc) -- Nothing => no change; no need to write new Iface
518 -- Just mi => Here is the new interface to write
519 -- with correct version numbers
521 -- NB: the fixities, declarations, rules are all assumed
522 -- to be sorted by increasing order of hsDeclName, so that
523 -- we can compare for equality
525 addVersionInfo Nothing new_iface
526 -- No old interface, so definitely write a new one!
527 = Just (new_iface, text "No old interface available")
529 addVersionInfo (Just old_iface@(ModIface { mi_version = old_version,
530 mi_decls = old_decls,
531 mi_fixities = old_fixities }))
532 new_iface@(ModIface { mi_decls = new_decls,
533 mi_fixities = new_fixities })
535 | no_output_change && no_usage_change
538 | otherwise -- Add updated version numbers
539 = Just (final_iface, pp_tc_diffs)
542 final_iface = new_iface { mi_version = new_version }
543 new_version = VersionInfo { vers_module = bumpVersion no_output_change (vers_module old_version),
544 vers_exports = bumpVersion no_export_change (vers_exports old_version),
545 vers_rules = bumpVersion no_rule_change (vers_rules old_version),
546 vers_decls = tc_vers }
548 no_output_change = no_tc_change && no_rule_change && no_export_change
549 no_usage_change = mi_usages old_iface == mi_usages new_iface
551 no_export_change = mi_exports old_iface == mi_exports new_iface -- Kept sorted
552 no_rule_change = dcl_rules old_decls == dcl_rules new_decls -- Ditto
554 -- Fill in the version number on the new declarations by looking at the old declarations.
555 -- Set the flag if anything changes.
556 -- Assumes that the decls are sorted by hsDeclName.
557 old_vers_decls = vers_decls old_version
558 (no_tc_change, pp_tc_diffs, tc_vers) = diffDecls old_vers_decls old_fixities new_fixities
559 (dcl_tycl old_decls) (dcl_tycl new_decls)
563 diffDecls :: NameEnv Version -- Old version map
564 -> NameEnv Fixity -> NameEnv Fixity -- Old and new fixities
565 -> [RenamedTyClDecl] -> [RenamedTyClDecl] -- Old and new decls
566 -> (Bool, -- True <=> no change
567 SDoc, -- Record of differences
568 NameEnv Version) -- New version
570 diffDecls old_vers old_fixities new_fixities old new
571 = diff True empty emptyNameEnv old new
573 -- When seeing if two decls are the same,
574 -- remember to check whether any relevant fixity has changed
575 eq_tc d1 d2 = d1 == d2 && all (same_fixity . fst) (tyClDeclNames d1)
576 same_fixity n = lookupNameEnv old_fixities n == lookupNameEnv new_fixities n
578 diff ok_so_far pp new_vers [] [] = (ok_so_far, pp, new_vers)
579 diff ok_so_far pp new_vers old [] = (False, pp, new_vers)
580 diff ok_so_far pp new_vers [] (nd:nds) = diff False (pp $$ only_new nd) new_vers [] nds
581 diff ok_so_far pp new_vers (od:ods) (nd:nds)
582 = case od_name `compare` nd_name of
583 LT -> diff False (pp $$ only_old od) new_vers ods (nd:nds)
584 GT -> diff False (pp $$ only_new nd) new_vers (od:ods) nds
585 EQ | od `eq_tc` nd -> diff ok_so_far pp new_vers ods nds
586 | otherwise -> diff False (pp $$ changed od nd) new_vers' ods nds
588 od_name = tyClDeclName od
589 nd_name = tyClDeclName nd
590 new_vers' = extendNameEnv new_vers nd_name
591 (bumpVersion True (lookupNameEnv_NF old_vers od_name))
593 only_old d = ptext SLIT("Only in old iface:") <+> ppr d
594 only_new d = ptext SLIT("Only in new iface:") <+> ppr d
595 changed d nd = ptext SLIT("Changed in iface: ") <+> ((ptext SLIT("Old:") <+> ppr d) $$
596 (ptext SLIT("New:") <+> ppr nd))
601 %************************************************************************
603 \subsection{Writing an interface file}
605 %************************************************************************
608 writeIface :: Maybe ModIface -> IO ()
612 writeIface (Just mod_iface)
613 = do { maybe_found <- findModule mod_name ;
614 ; case maybe_found of {
615 Nothing -> printErrs (text "Can't write interface file for" <+> ppr mod_name) ;
618 do { let filename = hi_file locn
619 ; if_hdl <- openFile filename WriteMode
620 ; printForIface if_hdl (pprIface mod_iface)
624 mod_name = moduleName (mi_module mod_iface)
626 pprIface :: ModIface -> SDoc
628 = vcat [ ptext SLIT("__interface")
629 <+> doubleQuotes (ptext opt_InPackage)
630 <+> ppr (mi_module iface) <+> ppr (vers_module version_info)
632 <+> (if mi_orphan iface then char '!' else empty)
633 <+> int opt_HiVersion
634 <+> ptext SLIT("where")
636 , vcat (map pprExport (mi_exports iface))
637 , vcat (map pprUsage (mi_usages iface))
639 , pprIfaceDecls (vers_decls version_info)
643 , pprDeprecs (mi_deprecs iface)
646 version_info = mi_version iface
647 exp_vers = vers_exports version_info
648 rule_vers = vers_rules version_info
650 pp_sub_vers | exp_vers == initialVersion && rule_vers == initialVersion = empty
651 | otherwise = brackets (ppr exp_vers <+> ppr rule_vers)
654 When printing export lists, we print like this:
656 AvailTC C [C, x, y] C(x,y)
657 AvailTC C [x, y] C!(x,y) -- Exporting x, y but not C
660 pprExport :: (ModuleName, Avails) -> SDoc
661 pprExport (mod, items)
662 = hsep [ ptext SLIT("__export "), ppr mod, hsep (map pp_avail items) ] <> semi
664 ppr_name :: Name -> SDoc -- Print the occurrence name only
665 ppr_name n = ppr (nameOccName n)
667 pp_avail :: AvailInfo -> SDoc
668 pp_avail (Avail name) = ppr_name name
669 pp_avail (AvailTC name []) = empty
670 pp_avail (AvailTC name ns) = hcat [ppr_name name, bang, pp_export ns']
672 bang | name `elem` ns = empty
673 | otherwise = char '|'
674 ns' = filter (/= name) ns
677 pp_export names = braces (hsep (map ppr_name names))
682 pprUsage :: ImportVersion Name -> SDoc
683 pprUsage (m, has_orphans, is_boot, whats_imported)
684 = hsep [ptext SLIT("import"), ppr m,
686 pp_versions whats_imported
689 pp_orphan | has_orphans = char '!'
691 pp_boot | is_boot = char '@'
694 -- Importing the whole module is indicated by an empty list
695 pp_versions NothingAtAll = empty
696 pp_versions (Everything v) = dcolon <+> int v
697 pp_versions (Specifically vm ve nvs vr) = dcolon <+> int vm <+> pp_export_version ve <+> int vr
698 <+> hsep [ ppr n <+> int v | (n,v) <- nvs ]
700 -- HACK for the moment: print the export-list version even if
701 -- we don't use it, so that syntax of interface files doesn't change
702 pp_export_version Nothing = int 1
703 pp_export_version (Just v) = int v
707 pprIfaceDecls version_map fixity_map decls
708 = vcat [ vcat [ppr i <+> semi | i <- dcl_insts decls]
709 , vcat (map ppr_decl (dcl_tycl decls))
710 , pprRules (dcl_rules decls)
713 ppr_decl d = (ppr_vers d <+> ppr d <> semi) $$ ppr_fixes d
715 -- Print the version for the decl
716 ppr_vers d = case lookupNameEnv version_map (tyClDeclName d) of
720 -- Print fixities relevant to the decl
721 ppr_fixes d = vcat [ ppr fix <+> ppr n <> semi
722 | (n,_) <- tyClDeclNames d,
723 Just fix <- [lookupNameEnv fixity_map n]
729 pprRules rules = hsep [ptext SLIT("{-## __R"), vcat (map ppr rules), ptext SLIT("##-}")]
731 pprDeprecs NoDeprecs = empty
732 pprDeprecs deprecs = ptext SLIT("{-## __D") <+> guts <+> ptext SLIT("##-}")
734 guts = case deprecs of
735 DeprecAll txt -> ptext txt
736 DeprecSome env -> pp_deprecs env
738 pp_deprecs env = vcat (punctuate semi (map pp_deprec (nameEnvElts env)))
740 pp_deprec (name, txt) = pprOccName (nameOccName name) <+> ptext txt