X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Fmain%2FMkIface.lhs;h=129afc12ef0bea28f2d0de4aded37cb22f25f2d6;hb=5cf27e8f1731c52fe63a5b9615f927484164c61b;hp=b8091421356a44e1fe3910525cd2d4927cdbfb37;hpb=68a1f0233996ed79824d11d946e9801473f6946c;p=ghc-hetmet.git diff --git a/ghc/compiler/main/MkIface.lhs b/ghc/compiler/main/MkIface.lhs index b809142..129afc1 100644 --- a/ghc/compiler/main/MkIface.lhs +++ b/ghc/compiler/main/MkIface.lhs @@ -1,5 +1,5 @@ % -% (c) The GRASP/AQUA Project, Glasgow University, 1993-1995 +% (c) The GRASP/AQUA Project, Glasgow University, 1993-1996 % \section[MkIface]{Print an interface for a module} @@ -7,602 +7,440 @@ #include "HsVersions.h" module MkIface ( - mkInterface, - - -- and to make the interface self-sufficient... - Bag, CE(..), GlobalSwitch, FixityDecl, Id, - Name, PrettyRep, StgBinding, TCE(..), UniqFM, InstInfo + startIface, endIface, + ifaceUsages, + ifaceVersions, + ifaceExportList, + ifaceFixities, + ifaceInstanceModules, + ifaceDecls, + ifaceInstances, + ifacePragmas ) where -IMPORT_Trace -- ToDo: rm (debugging) - -import AbsPrel ( mkLiftTy, pRELUDE_CORE, pRELUDE_BUILTIN ) -import AbsSyn ( FixityDecl(..), RenamedFixityDecl(..), MonoBinds, - RenamedMonoBinds(..), Name, RenamedPat(..), Sig +import Ubiq{-uitous-} + +import Bag ( emptyBag, snocBag, bagToList ) +import Class ( GenClass(..){-instance NamedThing-}, GenClassOp(..) ) +import CmdLineOpts ( opt_ProduceHi ) +import FieldLabel ( FieldLabel{-instance NamedThing-} ) +import FiniteMap ( fmToList ) +import HsSyn +import Id ( idType, dataConSig, dataConFieldLabels, + dataConStrictMarks, StrictnessMark(..), + GenId{-instance NamedThing/Outputable-} ) -import AbsUniType -import Bag -import CE -import CmdLineOpts -- ( GlobalSwitch(..) ) -import FiniteMap -import Id -import IdInfo -- plenty from here -import Maybes ( catMaybes, Maybe(..) ) -import Outputable -import Pretty -import StgSyn -import TCE -import TcInstDcls ( InstInfo(..) ) -import Util +import Name ( nameOrigName, origName, nameOf, + exportFlagOn, nameExportFlag, ExportFlag(..), + ltLexical, isExported, getExportFlag, + isLexSym, isLocallyDefined, + RdrName(..){-instance Outputable-}, + Name{-instance NamedThing-} + ) +import ParseUtils ( UsagesMap(..), VersionsMap(..) ) +import PprEnv -- not sure how much... +import PprStyle ( PprStyle(..) ) +import PprType -- most of it (??) +import Pretty ( prettyToUn ) +import Unpretty -- ditto +import RnHsSyn ( RenamedHsModule(..), RnName{-instance NamedThing-} ) +import TcModule ( TcIfaceInfo(..) ) +import TcInstUtil ( InstInfo(..) ) +import TyCon ( TyCon(..){-instance NamedThing-}, NewOrData(..) ) +import Type ( mkSigmaTy, mkDictTy, getAppTyCon ) +import Util ( sortLt, 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 + = let + on = origName n + s = nameOf on + pp = prettyToUn (ppr PprInterface on) + in + (if isLexSym s then uppParens else id) pp +ppr_unq_name n + = let + on = origName n + s = nameOf on + pp = uppPStr s + in + (if isLexSym s then uppParens else id) pp \end{code} -%************************************************************************ -%* * -\subsection[main-MkIface]{Main routine for making interfaces} -%* * -%************************************************************************ +We have a function @startIface@ to open the output file and put +(something like) ``interface Foo'' in it. It gives back a handle +for subsequent additions to the interface file. -Misc points: -\begin{enumerate} -\item -We get the general what-to-export information from the ``environments'' -produced by the typechecker (the \tr{[RenamedFixityDecl]} through -\tr{Bag InstInfo} arguments). - -\item -{\em However:} Whereas (for example) an \tr{InstInfo} will have -\tr{Ids} in it that identify the constant methods for that instance, -those particular \tr{Ids} {\em do not have} the best @IdInfos@!!! -Those @IdInfos@ were figured out long after the \tr{InstInfo} was -created. - -That's why we actually look at the final \tr{PlainStgBindings} that go -into the code-generator: they have the best @IdInfos@ on them. -Whenever, we are about to print info about an @Id@, we look in the -Ids-from-STG-bindings list to see if we have an ``equivalent'' @Id@ -with presumably-better @IdInfo@. - -\item -We play this same game whether for values, classes (for their -method-selectors and default-methods), or instances (for their -@DictFunIds@ or constant-methods). - -Of course, for imported things, what we got from the typechecker is -all we're gonna get. - -\item -We {\em sort} things in the interface into some ``canonical'' order; -otherwise, with heavily-recursive modules, you can have (unchanged) -information ``move around'' in the interface file---deeply unfriendly -to \tr{make}. -\end{enumerate} +We then have one-function-per-block-of-interface-stuff, e.g., +@ifaceExportList@ produces the @__exports__@ section; it appends +to the handle provided by @startIface@. \begin{code} -mkInterface :: (GlobalSwitch -> Bool) - -> FAST_STRING - -> (FAST_STRING -> Bool, -- is something in export list, explicitly? - FAST_STRING -> Bool) -- is a module among the "dotdot" exported modules? - -> IdEnv UnfoldingDetails - -> FiniteMap TyCon [(Bool, [Maybe UniType])] - -> ([RenamedFixityDecl], -- interface info from the typecheck - [Id], - CE, - TCE, - Bag InstInfo) - -> [PlainStgBinding] - -> Pretty - -mkInterface sw_chkr modname export_list_fns inline_env tycon_specs - (fixity_decls, global_ids, ce, tce, inst_infos) - stg_binds - = let - -- first, gather up the things we want to export: - - exported_tycons = [ tc | tc <- rngTCE tce, - isExported tc, - is_exportable_tycon_or_class sw_chkr export_list_fns tc ] - exported_classes = [ c | c <- rngCE ce, - isExported c, - is_exportable_tycon_or_class sw_chkr export_list_fns c ] - exported_inst_infos = [ i | i <- bagToList inst_infos, - is_exported_inst_info sw_chkr export_list_fns i ] - exported_vals - = [ v | v <- global_ids, - isExported v && not (isDataCon v) && not (isClassOpId v) ] - - -- We also have to worry about TyCons/Classes that are - -- *mentioned* in exported things (e.g., values' types or - -- instances), so that we can be sure to do an import decl for - -- them, for original-naming purposes: - - (mentioned_tycons, mentioned_classes) - = foldr ( \ (tcs1, cls1) (tcs2, cls2) - -> (tcs1 `unionBags` tcs2, cls1 `unionBags` cls2) ) - (emptyBag, emptyBag) - (map getMentionedTyConsAndClassesFromClass exported_classes ++ - map getMentionedTyConsAndClassesFromTyCon exported_tycons ++ - map getMentionedTyConsAndClassesFromId exported_vals ++ - map getMentionedTyConsAndClassesFromInstInfo exported_inst_infos) - - mentionable_classes - = filter (is_mentionable sw_chkr) (bagToList mentioned_classes) - mentionable_tycons - = [ tc | tc <- bagToList mentioned_tycons, - is_mentionable sw_chkr tc, - not (isPrimTyCon tc) ] - - nondup_mentioned_tycons = fst (removeDups cmpTyCon mentionable_tycons) - nondup_mentioned_classes = fst (removeDups cmpClass mentionable_classes) - - -- Next: as discussed in the notes, we want the top-level - -- Ids straight from the final STG code, so we can use - -- their IdInfos to print pragmas; we slurp them out here, - -- then pass them to the printing functions, which may - -- use them. - - better_ids = collectExportedStgBinders stg_binds - - -- Make a lookup function for convenient access: - - better_id_fn i - = if not (isLocallyDefined i) - then i -- can't be among our "better_ids" - else - let - eq_fn = if isTopLevId i -- can't trust uniqs - then (\ x y -> getOrigName x == getOrigName y) - else eqId - in - case [ x | x <- better_ids, x `eq_fn` i ] of - [] -> pprPanic "better_id_fn:" (ppr PprShowAll i) - i - [x] -> x - _ -> panic "better_id_fn" - - -- Finally, we sort everything lexically, so that we always - -- get the same interface from the same information: - - sorted_mentioned_tycons = sortLt ltLexical nondup_mentioned_tycons - sorted_mentioned_classes = sortLt ltLexical nondup_mentioned_classes - - sorted_tycons = sortLt ltLexical exported_tycons - sorted_classes = sortLt ltLexical exported_classes - sorted_vals = sortLt ltLexical exported_vals - sorted_inst_infos = sortLt lt_lexical_inst_info exported_inst_infos - in - if (any_purely_local sorted_tycons sorted_classes sorted_vals) then - -- this will be less of a HACK when we teach - -- mkInterface to do I/O (WDP 94/10) - error "Can't produce interface file because of errors!\n" - else --- trace ("mkIface:Ids:"++(ppShow 80 (ppr PprDebug global_ids))) ( - ppAboves - [ppPStr SLIT("{-# GHC_PRAGMA INTERFACE VERSION 6 #-}"), - ppCat [ppPStr SLIT("interface"), ppPStr modname, ppPStr SLIT("where")], - - do_import_decls sw_chkr modname - sorted_vals sorted_mentioned_classes sorted_mentioned_tycons, - -- Mustn't give the data constructors to do_import_decls, - -- because they aren't explicitly imported; their tycon is. - -- ToDo: modify if we ever add renaming properly. - - ppAboves (map (do_fixity sw_chkr) fixity_decls), - ppAboves (map (pprIfaceClass sw_chkr better_id_fn inline_env) sorted_classes), - ppAboves (map (do_tycon sw_chkr tycon_specs) sorted_tycons), - ppAboves (map (do_value sw_chkr better_id_fn inline_env) sorted_vals), - ppAboves (map (do_instance sw_chkr better_id_fn inline_env) sorted_inst_infos), - - ppChar '\n' - ] --- ) - where - any_purely_local tycons classes vals - = any bad_tc tycons || any bad_cl classes || any bad_id vals - where - bad_cl cl - = case (maybePurelyLocalClass cl) of - Nothing -> False - Just xs -> naughty_trace cl xs - - bad_id id - = case (maybePurelyLocalType (getIdUniType id)) of - Nothing -> False - Just xs -> naughty_trace id xs - - bad_tc tc - = case (maybePurelyLocalTyCon tc) of - Nothing -> False - Just xs -> if exported_abs then False else naughty_trace tc xs - where - exported_abs = case (getExportFlag tc) of { ExportAbs -> True; _ -> False } - - naughty_trace x things - = pprTrace "Can't export -- `" - (ppBesides [ppr PprForUser x, ppStr "' mentions purely local things: ", - ppInterleave pp'SP things]) - True +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 + -> RenamedHsModule + -> 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 + -> IO () +ifacePragmas = panic "ifacePragmas" -- stub \end{code} -%************************************************************************ -%* * -\subsection[imports-MkIface]{Generating `import' declarations in an interface} -%* * -%************************************************************************ +\begin{code} +startIface mod + = case opt_ProduceHi of + Nothing -> return Nothing -- not producing any .hi file + Just fn -> + openFile fn WriteMode >>= \ if_hdl -> + hPutStr if_hdl ("interface "++ _UNPK_ mod) >> + return (Just if_hdl) + +endIface Nothing = return () +endIface (Just if_hdl) = hPutStr if_hdl "\n" >> hClose if_hdl +\end{code} -Not handling renaming yet (ToDo) +\begin{code} +ifaceUsages Nothing{-no iface handle-} _ = return () + +ifaceUsages (Just if_hdl) usages + | null usages_list + = return () + | otherwise + = hPutStr if_hdl "\n__usages__\n" >> + hPutStr if_hdl (uppShow 0 (uppAboves (map upp_uses usages_list))) + where + usages_list = fmToList usages -We gather up lots of (module, name) pairs for which we might print an -import declaration. We sort them, for the usual canonicalisation -reasons. NB: We {\em assume} the lists passed in don't have duplicates in -them! expect). + upp_uses (m, (mv, versions)) + = uppBesides [uppPStr m, uppSP, uppPStr SLIT(" :: "), + upp_versions (fmToList versions), uppSemi] -All rather horribly turgid (WDP). + upp_versions nvs + = uppIntersperse upp'SP{-'-} [ uppCat [uppPStr n, uppInt v] | (n,v) <- nvs ] +\end{code} \begin{code} -do_import_decls - :: (GlobalSwitch -> Bool) - -> FAST_STRING - -> [Id] -> [Class] -> [TyCon] - -> Pretty +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)) + where + version_list = fmToList version_info -do_import_decls sw_chkr mod_name vals classes tycons - = let - -- Conjure up (module, name, maybe_renaming) triples for all - -- the potentially import-decls things: + upp_versions nvs + = uppAboves [ uppPStr n | (n,v) <- nvs ] +\end{code} - vals_names, classes_names, tycons_names :: [(FAST_STRING, FAST_STRING, [Maybe FAST_STRING])] - vals_names = map get_val_triple vals - classes_names = map get_class_triple classes - tycons_names = map get_tycon_triple tycons +\begin{code} +ifaceInstanceModules Nothing{-no iface handle-} _ = return () +ifaceInstanceModules (Just _) [] = return () - -- sort the (module, name, renaming) triples and chop - -- them into per-module groups: +ifaceInstanceModules (Just if_hdl) imods + = hPutStr if_hdl "\n__instance_modules__\n" >> + hPutStr if_hdl (uppShow 0 (uppCat (map uppPStr imods))) +\end{code} - ie_list = sortLt lt (tycons_names ++ classes_names ++ vals_names) +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. Note that the ``module'' now contains all the +imported things that we are dealing with, thus including any entities +that we are re-exporting from somewhere else. +\begin{code} +ifaceExportList Nothing{-no iface handle-} _ = return () + +ifaceExportList (Just if_hdl) + (HsModule _ _ _ _ _ typedecls _ classdecls _ _ _ binds sigs _) + = let + name_flag_pairs :: Bag (Name, ExportFlag) + name_flag_pairs + = foldr from_ty + (foldr from_cls + (foldr from_sig + (from_binds binds emptyBag{-init accum-}) + sigs) + classdecls) + typedecls + + sorted_pairs = sortLt lexical_lt (bagToList name_flag_pairs) - per_module_groups = runs same_module ie_list in - ppAboves (map print_a_decl per_module_groups) + hPutStr if_hdl "\n__exports__\n" >> + hPutStr if_hdl (uppShow 0 (uppAboves (map upp_pair sorted_pairs))) where - lt, same_module :: (FAST_STRING, FAST_STRING, [Maybe FAST_STRING]) - -> (FAST_STRING, FAST_STRING, [Maybe FAST_STRING]) -> Bool - - lt (m1, ie1, _) (m2, ie2, _) - = case _CMP_STRING_ m1 m2 of { LT_ -> True; EQ_ -> ie1 < ie2; GT__ -> False } - - same_module (m1, _, _) (m2, _, _) = m1 == m2 - - compiling_the_prelude = sw_chkr CompilingPrelude - - print_a_decl :: [(FAST_STRING, FAST_STRING, [Maybe FAST_STRING])] -> Pretty - {- - Obviously, if the module in question is this one, - don't print an import declaration. - - If it's a Prelude* module, we don't print the TyCons/ - Classes, because the compiler supposedly knows about - them already (and they are PreludeCore things anyway). - - But if we are compiling a Prelude module, then we - try to do it as "normally" as possible. - -} - print_a_decl (ielist@((m,_,_) : _)) - | m == mod_name - || (not compiling_the_prelude && - (m == pRELUDE_CORE || m == pRELUDE_BUILTIN)) - = ppNil - - | otherwise - = ppBesides [ppPStr SLIT("import "), ppPStr m, ppLparen, - ppIntersperse pp'SP{-'-} (map pp_str [n | (_,n,_) <- ielist]), - ppRparen, - case (grab_non_Nothings [rns | (_,_,rns) <- ielist]) of - [] -> ppNil - renamings -> pp_renamings renamings - ] - where - isnt_tycon_ish :: FAST_STRING -> Bool - isnt_tycon_ish str = not (isConop str) + from_ty (TyData _ n _ _ _ _ _) acc = maybe_add acc n + from_ty (TyNew _ n _ _ _ _ _) acc = maybe_add acc n + from_ty (TySynonym n _ _ _) acc = maybe_add acc n - grab_non_Nothings :: [[Maybe FAST_STRING]] -> [FAST_STRING] + from_cls (ClassDecl _ n _ _ _ _ _) acc = maybe_add acc n - grab_non_Nothings rns = catMaybes (concat rns) + from_sig (Sig n _ _ _) acc = maybe_add acc n - pp_str :: FAST_STRING -> Pretty - pp_str pstr - = if isAvarop pstr then ppStr ("("++str++")") else ppPStr pstr - where - str = _UNPK_ pstr + from_binds bs acc = maybe_add_list acc (collectTopLevelBinders bs) - pp_renamings strs - = ppBesides [ ppPStr SLIT(" renaming "), ppLparen, ppIntersperse pp'SP{-'-} (map ppPStr strs), ppRparen ] -\end{code} + -------------- + maybe_add :: Bag (Name, ExportFlag) -> RnName -> Bag (Name, ExportFlag) -Most of the huff and puff here is to ferret out renaming strings. + maybe_add acc rn + | exportFlagOn ef = acc `snocBag` (n, ef) + | otherwise = acc + where + n = getName rn + ef = nameExportFlag n -\begin{code} -get_val_triple :: Id -> (FAST_STRING, FAST_STRING, [Maybe FAST_STRING]) -get_class_triple :: Class -> (FAST_STRING, FAST_STRING, [Maybe FAST_STRING]) -get_tycon_triple :: TyCon -> (FAST_STRING, FAST_STRING, [Maybe FAST_STRING]) - -get_val_triple id - = case (generic_triple id) of { (a,b,rn) -> - (a,b,[rn]) } - -get_class_triple clas - = case (generic_triple clas) of { (orig_mod, orig_nm, clas_rn) -> - let - nm_to_print = case (getExportFlag clas) of - ExportAll -> orig_nm _APPEND_ SLIT("(..)") -- nothing like a good HACK! - ExportAbs -> orig_nm - NotExported -> orig_nm - --- Ops don't have renaming info (bug) ToDo --- ops = getClassOps clas --- ops_rns = [ rn | (_,_,rn) <- map generic_triple ops ] - in - (orig_mod, nm_to_print, [clas_rn]) } - -get_tycon_triple tycon - = case (generic_triple tycon) of { (orig_mod, orig_nm, tycon_rn) -> - let - nm_to_print = case (getExportFlag tycon) of - ExportAll -> orig_nm _APPEND_ SLIT("(..)") -- nothing like a good HACK! - ExportAbs -> orig_nm - NotExported -> orig_nm - - cons = getTyConDataCons tycon - cons_rns = [ rn | (_,_,rn) <- map generic_triple cons ] - in - (orig_mod, nm_to_print, tycon_rn : cons_rns) } - -generic_triple thing - = case (getOrigName thing) of { (orig_mod, orig_nm) -> - case (getOccurrenceName thing) of { occur_name -> - (orig_mod, orig_nm, - if orig_nm == occur_name - then Nothing - else Just (orig_nm _APPEND_ SLIT(" to ") _APPEND_ occur_name) - )}} -\end{code} + -------------- + maybe_add_list acc [] = acc + maybe_add_list acc (n:ns) = maybe_add (maybe_add_list acc ns) n -%************************************************************************ -%* * -\subsection[fixities-MkIface]{Generating fixity declarations in an interface} -%* * -%************************************************************************ + -------------- + lexical_lt (n1,_) (n2,_) = nameOrigName n1 < nameOrigName n2 + -------------- + upp_pair (n, ef) + = uppBeside (ppr_name n) (upp_export ef) + where + upp_export ExportAll = uppPStr SLIT("(..)") + upp_export ExportAbs = uppNil +\end{code} \begin{code} -do_fixity :: (GlobalSwitch -> Bool) -> RenamedFixityDecl -> Pretty +ifaceFixities Nothing{-no iface handle-} _ = return () -do_fixity sw_chkr fixity_decl - = case (getExportFlag (get_name fixity_decl)) of - ExportAll -> ppr (PprInterface sw_chkr) fixity_decl - _ -> ppNil +ifaceFixities (Just if_hdl) (HsModule _ _ _ _ fixities _ _ _ _ _ _ _ _ _) + = let + local_fixities = filter from_here fixities + in + if null local_fixities then + return () + else + hPutStr if_hdl "\n__fixities__\n" >> + hPutStr if_hdl (uppShow 0 (uppAboves (map uppSemid local_fixities))) where - get_name (InfixL n _) = n - get_name (InfixR n _) = n - get_name (InfixN n _) = n + from_here (InfixL v _) = isLocallyDefined v + from_here (InfixR v _) = isLocallyDefined v + from_here (InfixN v _) = isLocallyDefined v \end{code} -%************************************************************************ -%* * -\subsection[tycons-MkIface]{Generating tycon declarations in an interface} -%* * -%************************************************************************ - \begin{code} -do_tycon :: (GlobalSwitch -> Bool) -> FiniteMap TyCon [(Bool, [Maybe UniType])] -> TyCon -> Pretty +ifaceDecls Nothing{-no iface handle-} _ = return () -do_tycon sw_chkr tycon_specs_map tycon - = pprTyCon (PprInterface sw_chkr) tycon tycon_specs - where - tycon_specs = map snd (lookupWithDefaultFM tycon_specs_map [] tycon) -\end{code} +ifaceDecls (Just if_hdl) (vals, tycons, classes, _) + = let +-- exported_classes = filter isExported classes +-- exported_tycons = filter isExported tycons + exported_vals = filter isExported vals -%************************************************************************ -%* * -\subsection[values-MkIface]{Generating a value's signature in an interface} -%* * -%************************************************************************ + sorted_classes = sortLt ltLexical classes + sorted_tycons = sortLt ltLexical tycons + sorted_vals = sortLt ltLexical exported_vals + in + if (null sorted_classes && null sorted_tycons && null sorted_vals) then + -- You could have a module with just 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]])) +\end{code} \begin{code} -do_value :: (GlobalSwitch -> Bool) - -> (Id -> Id) - -> IdEnv UnfoldingDetails - -> Id - -> Pretty +ifaceInstances Nothing{-no iface handle-} _ = return () -do_value sw_chkr better_id_fn inline_env val +ifaceInstances (Just if_hdl) (_, _, _, insts) = let - sty = PprInterface sw_chkr - better_val = better_id_fn val - name_str = getOccurrenceName better_val -- NB: not orig name! - - id_info = getIdInfo better_val - - val_ty = let - orig_ty = getIdUniType val - final_ty = getIdUniType better_val - in --- ASSERT (orig_ty == final_ty || mkLiftTy orig_ty == final_ty) - ASSERT (if (orig_ty == final_ty || mkLiftTy orig_ty == final_ty) then True else pprTrace "do_value:" (ppCat [ppr PprDebug val, ppr PprDebug better_val]) False) - orig_ty - - -- Note: We export the type of the original val - -- The type of an unboxed val will have been *lifted* by the desugarer - -- In this case we export an unlifted type, but id_info which assumes - -- a lifted Id i.e. extracted from better_val (above) - -- The importing module must lift the Id before using the imported id_info - - pp_id_info - = if sw_chkr OmitInterfacePragmas - || boringIdInfo id_info - then ppNil - else ppCat [ppPStr SLIT("\t{-# GHC_PRAGMA"), - ppIdInfo sty better_val True{-yes specs-} - better_id_fn inline_env id_info, - ppPStr SLIT("#-}")] + exported_insts = filter is_exported_inst (bagToList insts) + + sorted_insts = sortLt lt_inst exported_insts in - ppAbove (ppCat [ppr_non_op name_str, - ppPStr SLIT("::"), pprUniType sty val_ty]) - pp_id_info + if null exported_insts then + return () + else + hPutStr if_hdl "\n__instances__\n" >> + hPutStr if_hdl (uppShow 0 (uppAboves (map pp_inst sorted_insts))) + where + is_exported_inst (InstInfo clas _ ty _ _ _ _ _ from_here _ _ _) + = from_here -- && ... --- sadly duplicates Outputable.pprNonOp (ToDo) + ------- + lt_inst (InstInfo clas1 _ ty1 _ _ _ _ _ _ _ _ _) + (InstInfo clas2 _ ty2 _ _ _ _ _ _ _ _ _) + = let + tycon1 = fst (getAppTyCon ty1) + tycon2 = fst (getAppTyCon ty2) + in + case (origName clas1 `cmp` origName clas2) of + LT_ -> True + GT_ -> False + EQ_ -> origName tycon1 < origName tycon2 -ppr_non_op str - = if isAvarop str -- NOT NEEDED: || isAconop - then ppBesides [ppLparen, ppPStr str, ppRparen] - else ppPStr str + ------- + pp_inst (InstInfo clas tvs ty theta _ _ _ _ _ _ _ _) + = let + forall_ty = mkSigmaTy tvs theta (mkDictTy clas ty) + renumbered_ty = initNmbr (nmbrType forall_ty) + in + uppBesides [uppPStr SLIT("instance "), ppr_ty renumbered_ty, uppSemi] \end{code} %************************************************************************ %* * -\subsection[instances-MkIface]{Generating instance declarations in an interface} +\subsection{Printing tycons, classes, ...} %* * %************************************************************************ -The types of ``dictionary functions'' (dfuns) have just the required -info for instance declarations in interfaces. However, the dfuns that -GHC really uses have {\em extra} dictionaries passed to them (for -efficiency). When we print interfaces, we want to omit that -dictionary information. (It can be reconsituted on the other end, -from instance and class decls). - \begin{code} -do_instance :: (GlobalSwitch -> Bool) - -> (Id -> Id) - -> IdEnv UnfoldingDetails - -> InstInfo - -> Pretty - -do_instance sw_chkr better_id_fn inline_env - (InstInfo clas tv_tmpls ty inst_decl_theta dfun_theta dfun_id constm_ids _ from_here modname _ _) - = let - sty = PprInterface sw_chkr - - better_dfun = better_id_fn dfun_id - better_dfun_info = getIdInfo better_dfun - better_constms = map better_id_fn constm_ids - - class_op_strs = map getClassOpString (getClassOps clas) - - pragma_begin - = ppCat [ppPStr SLIT("\t{-# GHC_PRAGMA"), pp_modname, ppPStr SLIT("{-dfun-}"), - ppIdInfo sty better_dfun False{-NO specs-} - better_id_fn inline_env better_dfun_info] - - pragma_end = ppPStr SLIT("#-}") - - pp_modname = if _NULL_ modname - then ppNil - else ppCat [ppStr "_M_", ppPStr modname] - - name_pragma_pairs - = pp_the_list [ ppCat [ppChar '\t', ppr_non_op op, ppEquals, - ppChar '{' , - ppIdInfo sty constm True{-YES, specs-} - better_id_fn inline_env - (getIdInfo constm), - ppChar '}' ] - | (op, constm) <- class_op_strs `zip` better_constms ] - -#ifdef DEBUG - pp_the_list [] = panic "MkIface: no class_ops or better_constms?" -#endif - pp_the_list [p] = p - pp_the_list (p:ps) = ppAbove (ppBeside p ppComma) (pp_the_list ps) - - real_stuff - = ppCat [ppPStr SLIT("instance"), - ppr sty (mkSigmaTy tv_tmpls inst_decl_theta (mkDictTy clas ty))] - in - if sw_chkr OmitInterfacePragmas - || boringIdInfo better_dfun_info - then real_stuff - else ppAbove real_stuff - ({-ppNest 8 -} -- ppNest does nothing - if null better_constms - then ppCat [pragma_begin, pragma_end] - else ppAbove pragma_begin (ppCat [name_pragma_pairs, pragma_end]) - ) -\end{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_theta 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_theta :: TyVar -> [Class] -> Unpretty -%************************************************************************ -%* * -\subsection[utils-InstInfos]{Utility functions for @InstInfos@} -%* * -%************************************************************************ + ppr_theta tv [] = uppNil + ppr_theta tv [sc] = uppBeside (ppr_assert tv sc) (uppPStr SLIT(" =>")) + ppr_theta tv super_classes + = uppBesides [uppLparen, + uppIntersperse upp'SP{-'-} (map (ppr_assert tv) super_classes), + uppStr ") =>"] -ToDo: perhaps move. + ppr_assert tv (Class _ n _ _ _ _ _ _ _ _) = uppCat [ppr_name n, ppr_tyvar tv] + + ppr_op (ClassOp o _ ty) = pp_sig (Unqual o) ty +\end{code} -Classes/TyCons are ``known,'' more-or-less. Prelude TyCons are -``completely'' known---they don't need to be mentioned in interfaces. -Classes usually don't need to be mentioned in interfaces, but if we're -compiling the prelude, then we treat them without special favours. \begin{code} -is_exportable_tycon_or_class sw_chkr export_list_fns tc - = if not (fromPreludeCore tc) then - True - else - in_export_list_or_among_dotdot_modules - (sw_chkr CompilingPrelude) -- ignore M.. stuff if compiling prelude - export_list_fns tc +ppr_val v ty -- renumber the type first! + = --pprTrace "ppr_val:" (ppr PprDebug v) $ + pp_sig v (initNmbr (nmbrType ty)) -in_export_list_or_among_dotdot_modules ignore_Mdotdots (in_export_list, among_dotdot_modules) tc - = if in_export_list (getOccurrenceName tc) then - True - else --- pprTrace "in_export:" (ppAbove (ppr PprDebug ignore_Mdotdots) (ppPStr (getOccurrenceName tc))) ( - if ignore_Mdotdots then - False - else - any among_dotdot_modules (getInformingModules tc) --- ) +pp_sig op ty + = uppBesides [ppr_name op, uppPStr SLIT(" :: "), ppr_ty ty, uppSemi] +\end{code} -is_mentionable sw_chkr tc - = not (from_PreludeCore_or_Builtin tc) || (sw_chkr CompilingPrelude) - where - from_PreludeCore_or_Builtin thing - = let - mod_name = fst (getOrigName thing) - in - mod_name == pRELUDE_CORE || mod_name == pRELUDE_BUILTIN +\begin{code} +ppr_tycon tycon + = --pprTrace "ppr_tycon:" (ppr PprDebug tycon) $ + ppr_tc (initNmbr (nmbrTyCon tycon)) -is_exported_inst_info sw_chkr export_list_fns - (InstInfo clas _ ty _ _ _ _ _ from_here _ _ _) - = let - is_fun_tycon = isFunType ty +------------------------ +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* -}" ] - seems_exported = instanceIsExported clas ty from_here +ppr_tc (TupleTyCon _ n _) + = uppCat [ uppStr "{- ", ppr_name n, uppStr "-}" ] - (tycon, _, _) = getUniDataTyCon ty +ppr_tc (SynTyCon _ n _ _ tvs expand) + = let + pp_tyvars = map ppr_tyvar tvs in - if (sw_chkr OmitReexportedInstances && not from_here) then - False -- Flag says to violate Haskell rules, blatantly - - else if not (sw_chkr CompilingPrelude) - || not (is_fun_tycon || fromPreludeCore tycon) - || not (fromPreludeCore clas) then - seems_exported -- take what we got - - else -- compiling Prelude & tycon/class are Prelude things... - from_here - || in_export_list_or_among_dotdot_modules True{-ignore M..s-} export_list_fns clas - || (not is_fun_tycon - && in_export_list_or_among_dotdot_modules True{-ignore M..s-} export_list_fns tycon) -\end{code} + 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), + pp_unabstract_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[uppLparen, + uppInterleave uppComma [uppCat [ppr_name c, ppr_ty t] | (c,t) <- cs], + uppRparen, uppPStr SLIT(" =>")] + + yes_we_print_condecls + = case (getExportFlag n) of + ExportAbs -> False + other -> True + + pp_unabstract_condecls + = if yes_we_print_condecls + then uppCat [uppEquals, pp_condecls] + else uppNil + + pp_condecls + = let + (c:cs) = cons + in + uppCat ((ppr_con c) : (map ppr_next_con cs)) -\begin{code} -lt_lexical_inst_info (InstInfo _ _ _ _ _ dfun1 _ _ _ _ _ _) (InstInfo _ _ _ _ _ dfun2 _ _ _ _ _ _) - = ltLexical dfun1 dfun2 -\end{code} + ppr_next_con con = uppCat [uppChar '|', ppr_con con] -\begin{code} -getMentionedTyConsAndClassesFromInstInfo (InstInfo clas _ ty _ dfun_theta _ _ _ _ _ _ _) - = case (getMentionedTyConsAndClassesFromUniType ty) of { (ts, cs) -> - case [ c | (c, _) <- dfun_theta ] of { theta_classes -> - (ts, (cs `unionBags` listToBag theta_classes) `snocBag` clas) - }} + ppr_con con + = let + (_, _, con_arg_tys, _) = dataConSig con + labels = dataConFieldLabels con -- none if not a record + strict_marks = dataConStrictMarks con + in + uppCat [ppr_unq_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_unq_name l, uppPStr SLIT(" :: "), + case b of { MarkedStrict -> uppChar '!'; _ -> uppNil }, + ppr_ty t] \end{code}