\section[MkIface]{Print an interface for a module}
\begin{code}
-#include "HsVersions.h"
-
module MkIface (
startIface, endIface,
ifaceMain,
ifaceDecls
) where
-IMP_Ubiq(){-uitous-}
-IMPORT_1_3(IO(Handle,hPutStr,openFile,hClose,IOMode(..)))
+#include "HsVersions.h"
+
+import IO ( Handle, hPutStr, openFile, hClose, IOMode(..) )
import HsSyn
import RdrHsSyn ( RdrName(..) )
-import RnHsSyn ( SYN_IE(RenamedHsModule) )
+import RnHsSyn ( RenamedHsModule )
+import BasicTypes ( Fixity(..), FixityDirection(..), NewOrData(..), IfaceFlavour(..),
+ pprModule
+ )
import RnMonad
+import RnEnv ( availName, ifaceFlavour )
import TcInstUtil ( InstInfo(..) )
+import WorkWrap ( getWorkerIdAndCons )
import CmdLineOpts
-import Id ( idType, dataConRawArgTys, dataConFieldLabels, isDataCon,
- getIdInfo, idWantsToBeINLINEd, omitIfaceSigForId,
+import Id ( idType, dataConRawArgTys, dataConFieldLabels,
+ getIdInfo, getInlinePragma, omitIfaceSigForId,
dataConStrictMarks, StrictnessMark(..),
- SYN_IE(IdSet), idSetToList, unionIdSets, unitIdSet, minusIdSet,
+ IdSet, idSetToList, unionIdSets, unitIdSet, minusIdSet,
isEmptyIdSet, elementOfIdSet, emptyIdSet, mkIdSet,
- GenId{-instance NamedThing/Outputable-}
+ pprId,
+ Id
+
)
-import IdInfo ( StrictnessInfo, ArityInfo, Unfolding,
+import IdInfo ( IdInfo, StrictnessInfo, ArityInfo,
arityInfo, ppArityInfo, strictnessInfo, ppStrictnessInfo,
- getWorkerId_maybe, bottomIsGuaranteed
+ bottomIsGuaranteed, workerExists,
)
-import CoreSyn ( SYN_IE(CoreExpr), SYN_IE(CoreBinding), GenCoreExpr, GenCoreBinding(..) )
-import CoreUnfold ( calcUnfoldingGuidance, UnfoldingGuidance(..) )
+import CoreSyn ( CoreExpr, CoreBinding, GenCoreExpr, GenCoreBinding(..) )
+import CoreUnfold ( calcUnfoldingGuidance, UnfoldingGuidance(..), Unfolding )
import FreeVars ( addExprFVs )
-import Name ( isLocallyDefined, isWiredInName, modAndOcc, getName, pprOccName,
- OccName, occNameString, nameOccName, nameString, isExported, pprNonSym,
- Name {-instance NamedThing-}, Provenance
+import Name ( isLocallyDefined, isWiredInName, modAndOcc, nameModule, pprOccName,
+ OccName, occNameString, nameOccName, nameString, isExported,
+ Name {-instance NamedThing-}, Provenance, NamedThing(..)
)
-import TyCon ( TyCon(..){-instance NamedThing-}, NewOrData(..) )
-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 TyCon ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon,
+ tyConTheta, tyConTyVars, tyConDataCons
+ )
+import Class ( Class, classBigSig )
+import FieldLabel ( fieldLabelName, fieldLabelType )
+import Type ( mkSigmaTy, splitSigmaTy, mkDictTy,
+ mkTyVarTys, Type, ThetaType
+ )
import PprEnv -- not sure how much...
-import PprStyle ( PprStyle(..) )
import PprType
import PprCore ( pprIfaceUnfolding )
-import Pretty
-import Unpretty -- ditto
-
-import Bag ( bagToList )
+import Bag ( bagToList, isEmptyBag )
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 )
-
+import Util ( sortLt, zipWithEqual, zipWith3Equal, mapAccumL )
+import Outputable
\end{code}
We have a function @startIface@ to open the output file and put
ifaceDecls :: Maybe Handle
- -> RenamedHsModule
+ -> [TyCon] -> [Class]
-> Bag InstInfo
-> [Id] -- Ids used at code-gen time; they have better pragma info!
-> [CoreBinding] -- In dependency order, later depend on earlier
ifaceFixities if_hdl fixities >>
return ()
-ifaceDecls Nothing rn_mod inst_info final_ids simplified = return ()
+ifaceDecls Nothing tycons classes inst_info final_ids simplified = return ()
ifaceDecls (Just hdl)
- (HsModule _ _ _ _ _ decls _)
+ tycons classes
inst_infos
final_ids binds
- | null decls = return ()
+ | 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 >>
+ ifaceClasses hdl classes >>
+ ifaceTyCons hdl tycons >>
ifaceBinds hdl needed_ids final_ids binds >>
return ()
+ where
+ null_decls = null binds &&
+ null tycons &&
+ null classes &&
+ isEmptyBag inst_infos
\end{code}
\begin{code}
= 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]
+ upp_uses (m, hif, mv, whats_imported)
+ = hsep [pprModule m, pp_hif hif, int mv, ptext SLIT("::"),
+ upp_import_versions whats_imported
+ ] <> semi
- -- 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 ]
+ -- Importing the whole module is indicated by an empty list
+ upp_import_versions Everything = empty
+ -- For imported versions we do print the version number
+ upp_import_versions (Specifically nvs)
+ = hsep [ hsep [ppr_unqual_name n, int v] | (n,v) <- sort_versions nvs ]
ifaceInstanceModules if_hdl [] = return ()
ifaceInstanceModules if_hdl imods
= hPutStr if_hdl "_instance_modules_\n" >>
- hPutStr if_hdl (uppShow 0 (uppCat (map uppPStr imods))) >>
+ printForIface if_hdl (hsep (map ptext (sortLt (<) imods))) >>
hPutStr if_hdl "\n"
ifaceExports if_hdl [] = return ()
-- Sort them into groups by module
export_fm :: FiniteMap Module [AvailInfo]
export_fm = foldr insert emptyFM avails
- insert avail@(Avail name _) efm = addToFM_C (++) efm mod [avail]
- where
- (mod,_) = modAndOcc name
+
insert NotAvailable efm = efm
+ insert avail efm = addToFM_C (++) efm mod [avail]
+ where
+ mod = nameModule (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]
+ do_one_module (mod_name, avails@(avail1:_))
+ = hsep [pp_hif (ifaceFlavour (availName avail1)),
+ pprModule mod_name,
+ hsep (map upp_avail (sortLt lt_avail avails))
+ ] <> semi
+
+-- The "!" indicates that the exported things came from a hi-boot interface
+pp_hif HiFile = empty
+pp_hif HiBootFile = char '!'
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}
%************************************************************************
-- occurrence, and this makes as good a sort order as any
-------
- pp_inst (InstInfo clas tvs ty theta _ dfun_id _ _ _)
+ pp_inst (InstInfo clas tvs tys theta _ dfun_id _ _ _)
= let
- forall_ty = mkSigmaTy tvs theta (mkDictTy clas ty)
- renumbered_ty = renumber_ty forall_ty
+ forall_ty = mkSigmaTy tvs theta (mkDictTy clas tys)
+ renumbered_ty = nmbrGlobalType forall_ty
in
- uppBesides [uppPStr SLIT("instance "), ppr_ty renumbered_ty,
- uppPStr SLIT(" = "), ppr_unqual_name dfun_id, uppSemi]
+ hcat [ptext SLIT("instance "), pprType renumbered_ty,
+ ptext SLIT(" = "), ppr_unqual_name dfun_id, semi]
\end{code}
-> 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
+ -> Maybe (SDoc, 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]
= Nothing -- Well, that was easy!
ifaceId get_idinfo needed_ids is_rec id rhs
- = Just (ppCat [sig_pretty, prag_pretty, ppSemi], new_needed_ids)
+ = Just (hsep [sig_pretty, pp_double_semi, prag_pretty], new_needed_ids)
where
- idinfo = get_idinfo id
- inline_pragma = idWantsToBeINLINEd id
+ pp_double_semi = ptext SLIT(";;")
+ idinfo = get_idinfo id
+ inline_pragma = getInlinePragma id
- ty_pretty = pprType PprInterface (initNmbr (nmbrType (idType id)))
- sig_pretty = ppBesides [ppr PprInterface (getOccName id), ppPStr SLIT(" :: "), ty_pretty]
+ ty_pretty = pprType (nmbrGlobalType (idType id))
+ sig_pretty = hcat [ppr (getOccName id), ptext SLIT(" _:_ "), ty_pretty]
- prag_pretty | opt_OmitInterfacePragmas = ppNil
- | otherwise = ppCat [arity_pretty, strict_pretty, unfold_pretty]
+ prag_pretty
+ | opt_OmitInterfacePragmas = empty
+ | otherwise = hsep [arity_pretty, strict_pretty, unfold_pretty, pp_double_semi]
------------ Arity --------------
- arity_pretty = ppArityInfo PprInterface (arityInfo idinfo)
+ arity_pretty = ppArityInfo (arityInfo idinfo)
------------ Strictness --------------
strict_info = strictnessInfo idinfo
- maybe_worker = getWorkerId_maybe strict_info
- strict_pretty = ppStrictnessInfo PprInterface strict_info
+ has_worker = workerExists strict_info
+ strict_pretty = ppStrictnessInfo strict_info <+> wrkr_pretty
+
+ wrkr_pretty | not has_worker = empty
+ | null con_list = pprId work_id
+ | otherwise = pprId work_id <+>
+ braces (hsep (map (pprId) con_list))
+
+ (work_id, wrapper_cons) = getWorkerIdAndCons id rhs
+ con_list = idSetToList wrapper_cons
------------ Unfolding --------------
- unfold_pretty | show_unfold = ppCat [ppStr "_U_", pprIfaceUnfolding rhs]
- | otherwise = ppNil
+ unfold_pretty | show_unfold = hsep [ptext SLIT("_U_"), pprIfaceUnfolding rhs]
+ | otherwise = empty
- show_unfold = not implicit_unfolding && -- Unnecessary
- (inline_pragma || not dodgy_unfolding) -- Dangerous
+ show_unfold = not implicit_unfolding && -- Not unnecessary
+ not dodgy_unfolding -- Not dangerous
- implicit_unfolding = maybeToBool maybe_worker ||
+ implicit_unfolding = has_worker ||
bottomIsGuaranteed strict_info
- dodgy_unfolding = is_rec || -- No recursive unfoldings please!
- case guidance of -- Too big to show
- UnfoldNever -> True
+ dodgy_unfolding = case guidance of -- True <=> too big to show, or the Inline pragma
+ UnfoldNever -> True -- says it shouldn't be inlined
other -> False
guidance = calcUnfoldingGuidance inline_pragma
| otherwise = worker_ids `unionIdSets`
unfold_ids
- worker_ids = case maybe_worker of
- Just wkr -> unitIdSet wkr
- Nothing -> emptyIdSet
+ worker_ids | has_worker = unitIdSet work_id
+ | otherwise = emptyIdSet
unfold_ids | show_unfold = free_vars
| otherwise = emptyIdSet
-> IO ()
ifaceBinds hdl needed_ids final_ids binds
- = hPutStr hdl (uppShow 0 (prettyToUn (ppAboves pretties))) >>
+ = mapIO (printForIface hdl) 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) $
+ Nothing -> pprTrace "ifaceBinds not found:" (ppr 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))) $
+ (sep (map ppr (idSetToList needed))) $
[]
else
[]
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 :: IdSet -> [(Id,CoreExpr)] -> (IdSet, [SDoc])
go_rec needed pairs
| null pretties = (needed, [])
| otherwise = (final_needed, more_pretties ++ pretties)
\subsection{Random small things}
%* *
%************************************************************************
-
+
\begin{code}
-upp_avail NotAvailable = uppNil
-upp_avail (Avail name ns) = uppBesides [upp_occname (getOccName name), upp_export ns]
-
-upp_export [] = uppNil
-upp_export names = uppBesides [uppStr "(",
- uppIntersperse uppSP (map (upp_occname . getOccName) names),
- uppStr ")"]
-
-upp_fixity (occ, Fixity prec dir, prov) = uppBesides [upp_dir dir, uppSP,
- uppInt prec, uppSP,
- upp_occname occ, uppSemi]
-upp_dir InfixR = uppStr "infixr"
-upp_dir InfixL = uppStr "infixl"
-upp_dir InfixN = uppStr "infix"
-
-ppr_unqual_name :: NamedThing a => a -> Unpretty -- Just its occurrence name
-ppr_unqual_name name = upp_occname (getOccName name)
+ifaceTyCons hdl tycons = hPutCol hdl upp_tycon (sortLt (<) (filter (for_iface_name . getName) tycons ))
+ifaceClasses hdl classes = hPutCol hdl upp_class (sortLt (<) (filter (for_iface_name . getName) classes))
-ppr_name :: NamedThing a => a -> Unpretty -- Its full name
-ppr_name n = uppPStr (nameString (getName n))
+for_iface_name name = isLocallyDefined name &&
+ not (isWiredInName name)
-upp_occname :: OccName -> Unpretty
-upp_occname occ = uppPStr (occNameString occ)
+upp_tycon tycon = ifaceTyCon tycon
+upp_class clas = ifaceClass clas
+\end{code}
-upp_module :: Module -> Unpretty
-upp_module mod = uppPStr mod
-uppSemid x = uppBeside (prettyToUn (ppr PprInterface x)) uppSemi -- micro util
+\begin{code}
+ifaceTyCon :: TyCon -> SDoc
+ifaceTyCon tycon
+ | isSynTyCon tycon
+ = hsep [ ptext SLIT("type"),
+ ppr (getName tycon),
+ pprTyVarBndrs tyvars,
+ ptext SLIT("="),
+ ppr ty,
+ semi
+ ]
+ where
+ (tyvars, ty) = getSynTyConDefn tycon
+
+ifaceTyCon tycon
+ | isAlgTyCon tycon
+ = hsep [ ptext keyword,
+ ppr_decl_context (tyConTheta tycon),
+ ppr (getName tycon),
+ pprTyVarBndrs (tyConTyVars tycon),
+ ptext SLIT("="),
+ hsep (punctuate (ptext SLIT(" | ")) (map ppr_con (tyConDataCons tycon))),
+ semi
+ ]
+ where
+ keyword | isNewTyCon tycon = SLIT("newtype")
+ | otherwise = SLIT("data")
+
+ ppr_con data_con
+ | null field_labels
+ = hsep [ ppr name,
+ hsep (map ppr_arg_ty (strict_marks `zip` arg_tys))
+ ]
+
+ | otherwise
+ = hsep [ ppr name,
+ braces $ hsep $ punctuate comma (map ppr_field (strict_marks `zip` field_labels))
+ ]
+ where
+ field_labels = dataConFieldLabels data_con
+ arg_tys = dataConRawArgTys data_con
+ strict_marks = dataConStrictMarks data_con
+ name = getName data_con
+
+ ppr_arg_ty (strict_mark, ty) = ppr_strict_mark strict_mark <> pprParendType ty
+
+ ppr_strict_mark NotMarkedStrict = empty
+ ppr_strict_mark MarkedStrict = ptext SLIT("! ")
+ -- The extra space helps the lexical analyser that lexes
+ -- interface files; it doesn't make the rigid operator/identifier
+ -- distinction, so "!a" is a valid identifier so far as it is concerned
+
+ ppr_field (strict_mark, field_label)
+ = hsep [ ppr (fieldLabelName field_label),
+ ptext SLIT("::"),
+ ppr_strict_mark strict_mark <> pprParendType (fieldLabelType field_label)
+ ]
+
+ifaceTyCon tycon
+ = pprPanic "pprIfaceTyDecl" (ppr tycon)
+
+ifaceClass clas
+ = hsep [ptext SLIT("class"),
+ ppr_decl_context sc_theta,
+ ppr clas, -- Print the name
+ pprTyVarBndrs clas_tyvars,
+ pp_ops,
+ semi
+ ]
+ where
+ (clas_tyvars, sc_theta, _, sel_ids, defms) = classBigSig clas
+
+ pp_ops | null sel_ids = empty
+ | otherwise = hsep [ptext SLIT("where"),
+ braces (hsep (punctuate semi (zipWith ppr_classop sel_ids defms)))
+ ]
+
+ ppr_classop sel_id maybe_defm
+ = ASSERT( sel_tyvars == clas_tyvars)
+ hsep [ppr (getOccName sel_id),
+ if maybeToBool maybe_defm then equals else empty,
+ ptext SLIT("::"),
+ ppr op_ty
+ ]
+ where
+ (sel_tyvars, _, op_ty) = splitSigmaTy (idType sel_id)
+
+ppr_decl_context :: ThetaType -> SDoc
+ppr_decl_context [] = empty
+ppr_decl_context theta
+ = braces (hsep (punctuate comma (map (ppr_dict) theta)))
+ <>
+ ptext SLIT(" =>")
+ where
+ ppr_dict (clas,tys) = ppr clas <+> hsep (map pprParendType tys)
+\end{code}
-ppr_ty ty = prettyToUn (pprType PprInterface ty)
-ppr_tyvar tv = prettyToUn (ppr PprInterface tv)
-ppr_tyvar_bndr tv = prettyToUn (pprTyVarBndr PprInterface tv)
+%************************************************************************
+%* *
+\subsection{Random small things}
+%* *
+%************************************************************************
+
+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}
+upp_avail NotAvailable = empty
+upp_avail (Avail name) = upp_occname (getOccName name)
+upp_avail (AvailTC name []) = empty
+upp_avail (AvailTC name ns) = hcat [upp_occname (getOccName name), bang, upp_export ns']
+ where
+ bang | name `elem` ns = empty
+ | otherwise = char '|'
+ ns' = filter (/= name) ns
+
+upp_export [] = empty
+upp_export names = parens (hsep (map (upp_occname . getOccName) names))
-ppr_decl decl = prettyToUn (ppr PprInterface decl) `uppBeside` uppSemi
+upp_fixity (occ, fixity) = hcat [ppr fixity, space, upp_occname occ, semi]
-renumber_ty ty = initNmbr (nmbrType ty)
+ppr_unqual_name :: NamedThing a => a -> SDoc -- Just its occurrence name
+ppr_unqual_name name = upp_occname (getOccName name)
+
+upp_occname :: OccName -> SDoc
+upp_occname occ = ptext (occNameString occ)
\end{code}
\begin{code}
lt_avail :: AvailInfo -> AvailInfo -> Bool
-NotAvailable `lt_avail` (Avail _ _) = True
-(Avail n1 _) `lt_avail` (Avail n2 _) = n1 `lt_name` n2
-any `lt_avail` NotAvailable = False
+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 a1 a2 = getName a1 `lt_name` getName a2
lt_imp_vers :: ImportVersion a -> ImportVersion a -> Bool
-lt_imp_vers (m1,_,_) (m2,_,_) = m1 < m2
+lt_imp_vers (m1,_,_,_) (m2,_,_,_) = m1 < m2
sort_versions vs = sortLt lt_vers vs
\begin{code}
hPutCol :: Handle
- -> (a -> Unpretty)
+ -> (a -> SDoc)
-> [a]
-> IO ()
-hPutCol hdl fmt xs = hPutStr hdl (uppShow 0 (uppAboves (map fmt xs))) >>
- hPutStr hdl "\n"
+hPutCol hdl fmt xs = mapIO (printForIface hdl . fmt) xs
+
+mapIO :: (a -> IO b) -> [a] -> IO ()
+mapIO f [] = return ()
+mapIO f (x:xs) = f x >> mapIO f xs
\end{code}
projects / ghc-hetmet.git / blobdiff