\section[MkIface]{Print an interface for a module}
\begin{code}
-#include "HsVersions.h"
-
module MkIface (
startIface, endIface,
- ifaceUsages,
- ifaceVersions,
- ifaceExportList,
- ifaceFixities,
- ifaceInstanceModules,
- ifaceDecls,
- ifaceInstances,
- ifacePragmas
+ 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 Bag ( bagToList )
-import Class ( GenClass(..){-instance NamedThing-}, GenClassOp(..) )
-import CmdLineOpts ( opt_ProduceHi )
-import FieldLabel ( FieldLabel{-instance NamedThing-} )
-import FiniteMap ( emptyFM, addToFM, lookupFM, fmToList, eltsFM, FiniteMap )
import HsSyn
-import Id ( idType, dataConRawArgTys, dataConFieldLabels, isDataCon,
- dataConStrictMarks, StrictnessMark(..),
- GenId{-instance NamedThing/Outputable-}
+import RdrHsSyn ( RdrName(..) )
+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,
+ getIdInfo, getInlinePragma, omitIfaceSigForId,
+ dataConStrictMarks, StrictnessMark(..),
+ IdSet, idSetToList, unionIdSets, unitIdSet, minusIdSet,
+ isEmptyIdSet, elementOfIdSet, emptyIdSet, mkIdSet,
+ pprId,
+ Id
+
)
-import Maybes ( maybeToBool )
-import Name ( origName, nameOf, moduleOf,
- exportFlagOn, nameExportFlag, ExportFlag(..),
- isLexSym, isLexCon, isLocallyDefined, isWiredInName,
- RdrName(..){-instance Outputable-},
- OrigName(..){-instance Ord-},
- Name{-instance NamedThing-}
+import IdInfo ( IdInfo, StrictnessInfo, ArityInfo,
+ arityInfo, ppArityInfo, strictnessInfo, ppStrictnessInfo,
+ bottomIsGuaranteed, workerExists,
)
-import ParseUtils ( UsagesMap(..), VersionsMap(..) )
+import CoreSyn ( CoreExpr, CoreBinding, GenCoreExpr, GenCoreBinding(..) )
+import CoreUnfold ( calcUnfoldingGuidance, UnfoldingGuidance(..), Unfolding )
+import FreeVars ( addExprFVs )
+import Name ( isLocallyDefined, isWiredInName, modAndOcc, nameModule, pprOccName,
+ OccName, occNameString, nameOccName, nameString, isExported,
+ Name {-instance NamedThing-}, Provenance, NamedThing(..)
+ )
+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 -- most of it (??)
---import PrelMods ( modulesWithBuiltins )
-import PrelInfo ( builtinValNamesMap, builtinTcNamesMap )
-import Pretty ( prettyToUn )
-import Unpretty -- ditto
-import RnHsSyn ( isRnConstr, SYN_IE(RenamedHsModule), RnName(..) )
-import RnUtils ( SYN_IE(RnEnv) {-, pprRnEnv ToDo:rm-} )
-import TcModule ( SYN_IE(TcIfaceInfo) )
-import TcInstUtil ( InstInfo(..) )
-import TyCon ( TyCon(..){-instance NamedThing-}, NewOrData(..) )
-import Type ( mkSigmaTy, mkDictTy, getAppTyCon, splitForAllTy )
-import Util ( sortLt, removeDups, zipWithEqual, zipWith3Equal, assertPanic, panic{-ToDo:rm-}{-, pprTrace ToDo:rm-} )
-
-uppSemid x = uppBeside (prettyToUn (ppr PprInterface x)) uppSemi -- micro util
-ppr_ty ty = prettyToUn (pprType PprInterface ty)
-ppr_tyvar tv = prettyToUn (ppr PprInterface tv)
-ppr_name n
- = case (origName "ppr_name" n) of { OrigName m s ->
- uppBesides [uppPStr m, uppChar '.', uppPStr s] }
+import PprType
+import PprCore ( pprIfaceUnfolding )
+
+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 )
+import Outputable
\end{code}
We have a function @startIface@ to open the output file and put
\begin{code}
startIface :: Module
-> IO (Maybe Handle) -- Nothing <=> don't do an interface
-endIface :: Maybe Handle -> IO ()
-ifaceUsages
- :: Maybe Handle
- -> UsagesMap
- -> IO ()
-ifaceVersions
- :: Maybe Handle
- -> VersionsMap
- -> IO ()
-ifaceExportList
- :: Maybe Handle
- -> (Name -> ExportFlag, ([(Name,ExportFlag)], [(Name,ExportFlag)]))
- -> RnEnv
- -> IO ()
-ifaceFixities
- :: Maybe Handle
- -> RenamedHsModule
- -> IO ()
-ifaceInstanceModules
- :: Maybe Handle
- -> [Module]
- -> IO ()
-ifaceDecls :: Maybe Handle
- -> TcIfaceInfo -- info produced by typechecker, for interfaces
- -> IO ()
-ifaceInstances
- :: Maybe Handle
- -> TcIfaceInfo -- as above
- -> IO ()
-ifacePragmas
- :: Maybe Handle
+
+ifaceMain :: Maybe Handle
+ -> InterfaceDetails
-> IO ()
-ifacePragmas = panic "ifacePragmas" -- stub
+
+
+ifaceDecls :: Maybe Handle
+ -> [TyCon] -> [Class]
+ -> Bag InstInfo
+ -> [Id] -- Ids used at code-gen time; they have better pragma info!
+ -> [CoreBinding] -- In dependency order, later depend on earlier
+ -> IO ()
+
+endIface :: Maybe Handle -> IO ()
\end{code}
\begin{code}
Nothing -> return Nothing -- not producing any .hi file
Just fn ->
openFile fn WriteMode >>= \ if_hdl ->
- hPutStr if_hdl ("{-# GHC_PRAGMA INTERFACE VERSION 20 #-}\ninterface "++ _UNPK_ mod) >>
+ hPutStr if_hdl ("{-# GHC_PRAGMA INTERFACE VERSION 20 #-}\n_interface_ "++ _UNPK_ mod ++ "\n") >>
return (Just if_hdl)
endIface Nothing = return ()
endIface (Just if_hdl) = hPutStr if_hdl "\n" >> hClose if_hdl
\end{code}
-\begin{code}
-ifaceUsages Nothing{-no iface handle-} _ = return ()
-ifaceUsages (Just if_hdl) usages
- | null usages_list
- = return ()
+\begin{code}
+ifaceMain Nothing iface_stuff = return ()
+ifaceMain (Just if_hdl)
+ (import_usages, ExportEnv avails fixities, instance_modules)
+ =
+ ifaceInstanceModules if_hdl instance_modules >>
+ ifaceUsages if_hdl import_usages >>
+ ifaceExports if_hdl avails >>
+ ifaceFixities if_hdl fixities >>
+ return ()
+
+ifaceDecls Nothing tycons classes inst_info final_ids simplified = return ()
+ifaceDecls (Just hdl)
+ tycons classes
+ inst_infos
+ final_ids binds
+ | null_decls = return ()
+ -- You could have a module with just (re-)exports/instances in it
| otherwise
- = hPutStr if_hdl "\n__usages__\n" >>
- hPutStr if_hdl (uppShow 0 (uppAboves (map upp_uses usages_list)))
+ = ifaceInstances hdl inst_infos >>= \ needed_ids ->
+ hPutStr hdl "_declarations_\n" >>
+ ifaceClasses hdl classes >>
+ ifaceTyCons hdl tycons >>
+ ifaceBinds hdl needed_ids final_ids binds >>
+ return ()
where
- usages_list = fmToList usages -- NO: filter has_no_builtins (...)
-
--- has_no_builtins (m, _)
--- = m `notElem` modulesWithBuiltins
--- -- Don't *have* to do this; save gratuitous spillage in
--- -- every interface. Could be flag-controlled...
-
- upp_uses (m, (mv, versions))
- = uppBesides [uppPStr m, uppSP, uppInt mv, uppPStr SLIT(" :: "),
- upp_versions (fmToList versions), uppSemi]
-
- upp_versions nvs
- = uppIntersperse uppSP [ uppCat [uppPStr n, uppInt v] | (n,v) <- nvs ]
+ null_decls = null binds &&
+ null tycons &&
+ null classes &&
+ isEmptyBag inst_infos
\end{code}
\begin{code}
-ifaceVersions Nothing{-no iface handle-} _ = return ()
-
-ifaceVersions (Just if_hdl) version_info
- | null version_list
- = return ()
- | otherwise
- = hPutStr if_hdl "\n__versions__\n" >>
- hPutStr if_hdl (uppShow 0 (upp_versions version_list))
- -- NB: when compiling Prelude.hs, this will spew out
- -- stuff for [], (), (,), etc. [i.e., builtins], which
- -- we'd rather it didn't. The version-mangling in
- -- the driver will ignore them.
+ifaceUsages if_hdl import_usages
+ = hPutStr if_hdl "_usages_\n" >>
+ hPutCol if_hdl upp_uses (sortLt lt_imp_vers import_usages)
where
- version_list = fmToList version_info
+ upp_uses (m, hif, mv, whats_imported)
+ = hsep [pprModule m, pp_hif hif, int mv, ptext SLIT("::"),
+ upp_import_versions whats_imported
+ ] <> semi
+
+ -- 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" >>
+ printForIface if_hdl (hsep (map ptext (sortLt (<) imods))) >>
+ hPutStr if_hdl "\n"
+
+ifaceExports if_hdl [] = return ()
+ifaceExports if_hdl avails
+ = hPutStr if_hdl "_exports_\n" >>
+ hPutCol if_hdl do_one_module (fmToList export_fm)
+ where
+ -- Sort them into groups by module
+ export_fm :: FiniteMap Module [AvailInfo]
+ export_fm = foldr insert emptyFM avails
+
+ 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@(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
+\end{code}
- upp_versions nvs
- = uppAboves [ uppPStr n | (n,v) <- nvs ]
-\end{code}
+%************************************************************************
+%* *
+\subsection{Instance declarations}
+%* *
+%************************************************************************
-\begin{code}
-ifaceInstanceModules Nothing{-no iface handle-} _ = return ()
-ifaceInstanceModules (Just _) [] = return ()
-ifaceInstanceModules (Just if_hdl) imods
- = hPutStr if_hdl "\n__instance_modules__\n" >>
- hPutStr if_hdl (uppShow 0 (uppCat (map uppPStr imods)))
+\begin{code}
+ifaceInstances :: Handle -> Bag InstInfo -> IO IdSet -- The IdSet is the needed dfuns
+ifaceInstances if_hdl inst_infos
+ | null togo_insts = return emptyIdSet
+ | otherwise = hPutStr if_hdl "_instances_\n" >>
+ hPutCol if_hdl pp_inst (sortLt lt_inst togo_insts) >>
+ return needed_ids
+ where
+ togo_insts = filter is_togo_inst (bagToList inst_infos)
+ needed_ids = mkIdSet [dfun_id | InstInfo _ _ _ _ _ dfun_id _ _ _ <- togo_insts]
+ is_togo_inst (InstInfo _ _ _ _ _ dfun_id _ _ _) = isLocallyDefined dfun_id
+
+ -------
+ lt_inst (InstInfo _ _ _ _ _ dfun_id1 _ _ _)
+ (InstInfo _ _ _ _ _ dfun_id2 _ _ _)
+ = getOccName dfun_id1 < getOccName dfun_id2
+ -- The dfuns are assigned names df1, df2, etc, in order of original textual
+ -- occurrence, and this makes as good a sort order as any
+
+ -------
+ pp_inst (InstInfo clas tvs tys theta _ dfun_id _ _ _)
+ = let
+ forall_ty = mkSigmaTy tvs theta (mkDictTy clas tys)
+ renumbered_ty = nmbrGlobalType forall_ty
+ in
+ hcat [ptext SLIT("instance "), pprType renumbered_ty,
+ ptext SLIT(" = "), ppr_unqual_name dfun_id, semi]
\end{code}
-Export list: grab the Names of things that are marked Exported, sort
-(so the interface file doesn't ``wobble'' from one compilation to the
-next...), and print. We work from the renamer's final ``RnEnv'',
-which has all the names we might possibly be interested in.
-(Note that the ``module X'' export items can cause a lot of grief.)
+
+%************************************************************************
+%* *
+\subsection{Printing values}
+%* *
+%************************************************************************
+
\begin{code}
-ifaceExportList Nothing{-no iface handle-} _ _ = return ()
-
-ifaceExportList (Just if_hdl)
- (export_fn, (dotdot_vals, dotdot_tcs))
- rn_env@((qual, unqual, tc_qual, tc_unqual), _)
- = let
- name_flag_pairs :: FiniteMap OrigName ExportFlag
- name_flag_pairs
- = foldr (from_wired True{-val-ish-})
- (foldr (from_wired False{-tycon-ish-})
- (foldr (from_dotdot True{-val-ish-})
- (foldr (from_dotdot False{-tycon-ish-})
- (foldr from_val
- (foldr from_val
- (foldr from_tc
- (foldr from_tc emptyFM{-init accum-}
- (eltsFM tc_unqual))
- (eltsFM tc_qual))
- (eltsFM unqual))
- (eltsFM qual))
- dotdot_tcs)
- dotdot_vals)
- (eltsFM builtinTcNamesMap))
- (eltsFM builtinValNamesMap)
-
- sorted_pairs = sortLt lexical_lt (fmToList name_flag_pairs)
-
- in
- --pprTrace "Exporting:" (pprRnEnv PprDebug rn_env) $
- hPutStr if_hdl "\n__exports__\n" >>
- hPutStr if_hdl (uppShow 0 (uppAboves (map upp_pair sorted_pairs)))
+ifaceId :: (Id -> IdInfo) -- This function "knows" the extra info added
+ -- by the STG passes. Sigh
+
+ -> IdSet -- Set of Ids that are needed by earlier interface
+ -- file emissions. If the Id isn't in this set, and isn't
+ -- exported, there's no need to emit anything
+ -> Bool -- True <=> recursive, so don't print unfolding
+ -> Id
+ -> CoreExpr -- The Id's right hand side
+ -> 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]
+ (isExported id && not (omitIfaceSigForId id))) -- or exported and not to be omitted
+ = Nothing -- Well, that was easy!
+
+ifaceId get_idinfo needed_ids is_rec id rhs
+ = Just (hsep [sig_pretty, pp_double_semi, prag_pretty], new_needed_ids)
where
- from_val rn acc
- | fun_looking rn && exportFlagOn ef = addToFM acc on ef
- | otherwise = acc
- where
- ef = export_fn n -- NB: using the export fn!
- n = getName rn
- on = origName "from_val" n
-
- -- fun_looking: must avoid class ops and data constructors
- -- and record fieldnames
- fun_looking (RnName _) = True
- fun_looking (WiredInId i) = not (isDataCon i)
- fun_looking _ = False
-
- from_tc rn acc
- | exportFlagOn ef = addToFM acc on ef
- | otherwise = acc
- where
- ef = export_fn n -- NB: using the export fn!
- n = getName rn
- on = origName "from_tc" n
-
- from_dotdot is_valish (n,ef) acc
- | is_valish && isLexCon str = acc
- | exportFlagOn ef = addToFM acc on ef
- | otherwise = acc
- where
- on = origName "from_dotdot" n
- (OrigName _ str) = on
-
- from_wired is_val_ish rn acc
- | is_val_ish && not (fun_looking rn)
- = acc -- these things don't cause export-ery
- | exportFlagOn ef = addToFM acc on ef
- | otherwise = acc
- where
- n = getName rn
- ef = export_fn n
- on = origName "from_wired" n
-
- --------------
- lexical_lt (n1,_) (n2,_) = n1 < n2
-
- --------------
- upp_pair (OrigName m n, ef)
- = uppBesides [uppPStr m, uppSP, uppPStr n, uppSP, upp_export ef]
- where
- upp_export ExportAll = uppPStr SLIT("(..)")
- upp_export ExportAbs = uppNil
+ pp_double_semi = ptext SLIT(";;")
+ idinfo = get_idinfo id
+ inline_pragma = getInlinePragma id
+
+ ty_pretty = pprType (nmbrGlobalType (idType id))
+ sig_pretty = hcat [ppr (getOccName id), ptext SLIT(" _:_ "), ty_pretty]
+
+ prag_pretty
+ | opt_OmitInterfacePragmas = empty
+ | otherwise = hsep [arity_pretty, strict_pretty, unfold_pretty, pp_double_semi]
+
+ ------------ Arity --------------
+ arity_pretty = ppArityInfo (arityInfo idinfo)
+
+ ------------ Strictness --------------
+ strict_info = strictnessInfo idinfo
+ 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 = hsep [ptext SLIT("_U_"), pprIfaceUnfolding rhs]
+ | otherwise = empty
+
+ show_unfold = not implicit_unfolding && -- Not unnecessary
+ not dodgy_unfolding -- Not dangerous
+
+ implicit_unfolding = has_worker ||
+ bottomIsGuaranteed strict_info
+
+ 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
+ opt_InterfaceUnfoldThreshold
+ rhs
+
+
+ ------------ Extra free Ids --------------
+ new_needed_ids = (needed_ids `minusIdSet` unitIdSet id) `unionIdSets`
+ extra_ids
+
+ extra_ids | opt_OmitInterfacePragmas = emptyIdSet
+ | otherwise = worker_ids `unionIdSets`
+ unfold_ids
+
+ worker_ids | has_worker = unitIdSet work_id
+ | otherwise = emptyIdSet
+
+ unfold_ids | show_unfold = free_vars
+ | otherwise = emptyIdSet
+ where
+ (_,free_vars) = addExprFVs interesting emptyIdSet rhs
+ interesting bound id = isLocallyDefined id &&
+ not (id `elementOfIdSet` bound) &&
+ not (omitIfaceSigForId id)
\end{code}
\begin{code}
-ifaceFixities Nothing{-no iface handle-} _ = return ()
-
-ifaceFixities (Just if_hdl) (HsModule _ _ _ _ fixities _ _ _ _ _ _ _ _ _)
- = let
- pp_fixities = foldr go [] fixities
- in
- if null pp_fixities then
- return ()
- else
- hPutStr if_hdl "\n__fixities__\n" >>
- hPutStr if_hdl (uppShow 0 (uppAboves pp_fixities))
+ifaceBinds :: Handle
+ -> IdSet -- These Ids are needed already
+ -> [Id] -- Ids used at code-gen time; they have better pragma info!
+ -> [CoreBinding] -- In dependency order, later depend on earlier
+ -> IO ()
+
+ifaceBinds hdl needed_ids final_ids binds
+ = mapIO (printForIface hdl) pretties >>
+ hPutStr hdl "\n"
where
- go (InfixL v i) acc = (if isLocallyDefined v then (:) (print_fix "l" i v) else id) acc
- go (InfixR v i) acc = (if isLocallyDefined v then (:) (print_fix "r" i v) else id) acc
- go (InfixN v i) acc = (if isLocallyDefined v then (:) (print_fix "" i v) else id) acc
-
- print_fix suff prec var
- = uppBesides [uppPStr SLIT("infix"), uppStr suff, uppSP, uppInt prec, uppSP, ppr_name var, uppSemi]
+ 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 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:"
+ (sep (map ppr (idSetToList needed))) $
+ []
+ else
+ []
+
+ go needed (NonRec id rhs : binds)
+ = case ifaceId get_idinfo needed False id rhs of
+ Nothing -> go needed binds
+ Just (pretty, needed') -> pretty : go needed' binds
+
+ -- Recursive groups are a bit more of a pain. We may only need one to
+ -- start with, but it may call out the next one, and so on. So we
+ -- have to look for a fixed point.
+ go needed (Rec pairs : binds)
+ = pretties ++ go needed'' binds
+ where
+ (needed', pretties) = go_rec needed pairs
+ needed'' = needed' `minusIdSet` mkIdSet (map fst pairs)
+ -- Later ones may spuriously cause earlier ones to be "needed" again
+
+ go_rec :: IdSet -> [(Id,CoreExpr)] -> (IdSet, [SDoc])
+ go_rec needed pairs
+ | null pretties = (needed, [])
+ | otherwise = (final_needed, more_pretties ++ pretties)
+ where
+ reduced_pairs = [pair | (pair,Nothing) <- pairs `zip` maybes]
+ pretties = catMaybes maybes
+ (needed', maybes) = mapAccumL do_one needed pairs
+ (final_needed, more_pretties) = go_rec needed' reduced_pairs
+
+ do_one needed (id,rhs) = case ifaceId get_idinfo needed True id rhs of
+ Nothing -> (needed, Nothing)
+ Just (pretty, needed') -> (needed', Just pretty)
\end{code}
+
+%************************************************************************
+%* *
+\subsection{Random small things}
+%* *
+%************************************************************************
+
\begin{code}
-non_wired x = not (isWiredInName (getName x)) --ToDo:move?
-
-ifaceDecls Nothing{-no iface handle-} _ = return ()
-
-ifaceDecls (Just if_hdl) (vals, tycons, classes, _)
- = ASSERT(all isLocallyDefined vals)
- ASSERT(all isLocallyDefined tycons)
- ASSERT(all isLocallyDefined classes)
- let
- nonwired_classes = filter non_wired classes
- nonwired_tycons = filter non_wired tycons
- nonwired_vals = filter non_wired vals
-
- lt_lexical a b = origName "lt_lexical" a < origName "lt_lexical" b
-
- sorted_classes = sortLt lt_lexical nonwired_classes
- sorted_tycons = sortLt lt_lexical nonwired_tycons
- sorted_vals = sortLt lt_lexical nonwired_vals
- in
- if (null sorted_classes && null sorted_tycons && null sorted_vals) then
- -- You could have a module with just (re-)exports/instances in it
- return ()
- else
- hPutStr if_hdl "\n__declarations__\n" >>
- hPutStr if_hdl (uppShow 0 (uppAboves [
- uppAboves (map ppr_class sorted_classes),
- uppAboves (map ppr_tycon sorted_tycons),
- uppAboves [ppr_val v (idType v) | v <- sorted_vals]]))
+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))
+
+for_iface_name name = isLocallyDefined name &&
+ not (isWiredInName name)
+
+upp_tycon tycon = ifaceTyCon tycon
+upp_class clas = ifaceClass clas
\end{code}
+
\begin{code}
-ifaceInstances Nothing{-no iface handle-} _ = return ()
-
-ifaceInstances (Just if_hdl) (_, _, _, insts)
- = let
- togo_insts = filter is_togo_inst (bagToList insts)
-
- sorted_insts = sortLt lt_inst togo_insts
- in
- if null togo_insts then
- return ()
- else
- hPutStr if_hdl "\n__instances__\n" >>
- hPutStr if_hdl (uppShow 0 (uppAboves (map pp_inst sorted_insts)))
+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
- is_togo_inst (InstInfo clas _ ty _ _ _ _ _ from_here _ _ _)
- = from_here -- && ...
-
- -------
- lt_inst (InstInfo clas1 _ ty1 _ _ _ _ _ _ _ _ _)
- (InstInfo clas2 _ ty2 _ _ _ _ _ _ _ _ _)
- = let
- tycon1 = fst (getAppTyCon ty1)
- tycon2 = fst (getAppTyCon ty2)
- in
- case (origName "lt_inst" clas1 `cmp` origName "lt_inst" clas2) of
- LT_ -> True
- GT_ -> False
- EQ_ -> origName "lt_inst2" tycon1 < origName "lt_inst2" tycon2
-
- -------
- pp_inst (InstInfo clas tvs ty theta _ _ _ _ _ _ _ _)
- = let
- forall_ty = mkSigmaTy tvs theta (mkDictTy clas ty)
- renumbered_ty = initNmbr (nmbrType forall_ty)
- in
- case (splitForAllTy renumbered_ty) of { (rtvs, rrho_ty) ->
- uppBesides [uppPStr SLIT("instance "), ppr_forall rtvs, ppr_ty rrho_ty, uppSemi] }
+ 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}
%************************************************************************
-%* *
-\subsection{Printing tycons, classes, ...}
-%* *
+%* *
+\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}
-ppr_class :: Class -> Unpretty
-
-ppr_class c
- = --pprTrace "ppr_class:" (ppr PprDebug c) $
- case (initNmbr (nmbrClass c)) of { -- renumber it!
- Class _ n tyvar super_classes sdsels ops sels defms insts links ->
-
- uppCat [uppPStr SLIT("class"), ppr_context tyvar super_classes,
- ppr_name n, ppr_tyvar tyvar,
- if null ops
- then uppSemi
- else uppCat [uppStr "where {", uppCat (map ppr_op ops), uppStr "};"]]
- }
- where
- ppr_context :: TyVar -> [Class] -> Unpretty
+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
- ppr_context tv [] = uppNil
--- ppr_context tv [sc] = uppBeside (ppr_assert tv sc) (uppPStr SLIT(" =>"))
- ppr_context tv super_classes
- = uppBesides [uppStr "{{",
- uppIntersperse upp'SP{-'-} (map (ppr_assert tv) super_classes),
- uppStr "}} =>"]
+upp_export [] = empty
+upp_export names = parens (hsep (map (upp_occname . getOccName) names))
- ppr_assert tv (Class _ n _ _ _ _ _ _ _ _) = uppCat [ppr_name n, ppr_tyvar tv]
+upp_fixity (occ, fixity) = hcat [ppr fixity, space, upp_occname occ, semi]
- clas_mod = moduleOf (origName "ppr_class" c)
+ppr_unqual_name :: NamedThing a => a -> SDoc -- Just its occurrence name
+ppr_unqual_name name = upp_occname (getOccName name)
- ppr_op (ClassOp o _ ty) = pp_sig (Qual clas_mod o) ty
+upp_occname :: OccName -> SDoc
+upp_occname occ = ptext (occNameString occ)
\end{code}
+
+%************************************************************************
+%* *
+\subsection{Comparisons
+%* *
+%************************************************************************
+
+
+The various sorts above simply prevent unnecessary "wobbling" when
+things change that don't have to. We therefore compare lexically, not
+by unique
+
\begin{code}
-ppr_val v ty -- renumber the type first!
- = --pprTrace "ppr_val:" (ppr PprDebug v) $
- pp_sig v (initNmbr (nmbrType ty))
+lt_avail :: AvailInfo -> AvailInfo -> Bool
+
+a1 `lt_avail` a2 = availName a1 `lt_name` availName a2
+
+lt_name :: Name -> Name -> Bool
+n1 `lt_name` n2 = modAndOcc n1 < modAndOcc n2
-pp_sig op ty
- = case (splitForAllTy ty) of { (tvs, rho_ty) ->
- uppBesides [ppr_name op, uppPStr SLIT(" :: "), ppr_forall tvs, ppr_ty rho_ty, uppSemi] }
+lt_lexical :: NamedThing a => a -> a -> Bool
+lt_lexical a1 a2 = getName a1 `lt_name` getName a2
-ppr_forall [] = uppNil
-ppr_forall tvs = uppBesides [ uppStr "__forall__ [", uppInterleave uppComma (map ppr_tyvar tvs), uppStr "] " ]
+lt_imp_vers :: ImportVersion a -> ImportVersion a -> Bool
+lt_imp_vers (m1,_,_,_) (m2,_,_,_) = m1 < m2
+
+sort_versions vs = sortLt lt_vers vs
+
+lt_vers :: LocalVersion Name -> LocalVersion Name -> Bool
+lt_vers (n1,v1) (n2,v2) = n1 `lt_name` n2
\end{code}
+
\begin{code}
-ppr_tycon tycon
- = --pprTrace "ppr_tycon:" (ppr PprDebug tycon) $
- ppr_tc (initNmbr (nmbrTyCon tycon))
-
-------------------------
-ppr_tc (PrimTyCon _ n _ _)
- = uppCat [ uppStr "{- data", ppr_name n, uppStr " *built-in* -}" ]
-
-ppr_tc FunTyCon
- = uppCat [ uppStr "{- data", ppr_name FunTyCon, uppStr " *built-in* -}" ]
-
-ppr_tc (TupleTyCon _ n _)
- = uppCat [ uppStr "{- ", ppr_name n, uppStr "-}" ]
-
-ppr_tc (SynTyCon _ n _ _ tvs expand)
- = let
- pp_tyvars = map ppr_tyvar tvs
- in
- uppBesides [uppPStr SLIT("type "), ppr_name n, uppSP, uppIntersperse uppSP pp_tyvars,
- uppPStr SLIT(" = "), ppr_ty expand, uppSemi]
-
-ppr_tc this_tycon@(DataTyCon u n k tvs ctxt cons derivings data_or_new)
- = uppCat [pp_data_or_new,
- ppr_context ctxt,
- ppr_name n,
- uppIntersperse uppSP (map ppr_tyvar tvs),
- uppEquals, pp_condecls,
- uppSemi]
- -- NB: we do not print deriving info in interfaces
- where
- pp_data_or_new = case data_or_new of
- DataType -> uppPStr SLIT("data")
- NewType -> uppPStr SLIT("newtype")
-
- ppr_context [] = uppNil
--- ppr_context [(c,t)] = uppCat [ppr_name c, ppr_ty t, uppPStr SLIT("=>")]
- ppr_context cs
- = uppBesides[uppStr "{{",
- uppInterleave uppComma [uppCat [ppr_name c, ppr_ty t] | (c,t) <- cs],
- uppStr "}}", uppPStr SLIT(" =>")]
-
- pp_condecls
- = let
- (c:cs) = cons
- in
- uppCat ((ppr_con c) : (map ppr_next_con cs))
-
- ppr_next_con con = uppCat [uppChar '|', ppr_con con]
-
- ppr_con con
- = let
- con_arg_tys = dataConRawArgTys con
- labels = dataConFieldLabels con -- none if not a record
- strict_marks = dataConStrictMarks con
- in
- uppCat [ppr_name con, ppr_fields labels strict_marks con_arg_tys]
-
- ppr_fields labels strict_marks con_arg_tys
- = if null labels then -- not a record thingy
- uppIntersperse uppSP (zipWithEqual "ppr_fields" ppr_bang_ty strict_marks con_arg_tys)
- else
- uppCat [ uppChar '{',
- uppInterleave uppComma (zipWith3Equal "ppr_field" ppr_field labels strict_marks con_arg_tys),
- uppChar '}' ]
-
- ppr_bang_ty b t
- = uppBeside (case b of { MarkedStrict -> uppChar '!'; _ -> uppNil })
- (prettyToUn (pprParendType PprInterface t))
-
- ppr_field l b t
- = uppBesides [ppr_name l, uppPStr SLIT(" :: "),
- case b of { MarkedStrict -> uppChar '!'; _ -> uppNil },
- ppr_ty t]
+hPutCol :: Handle
+ -> (a -> SDoc)
+ -> [a]
+ -> IO ()
+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