ghc/compiler/main/MkIface.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
   3 %
   4 \section[MkIface]{Print an interface for a module}
   5
   6 \begin{code}
   7 module MkIface (
   8         startIface, endIface, ifaceDecls
   9     ) where
  10
  11 #include "HsVersions.h"
  12
  13 import IO               ( Handle, hPutStr, openFile,
  14                           hClose, hPutStrLn, IOMode(..) )
  15
  16 import HsSyn
  17 import BasicTypes       ( Fixity(..), FixityDirection(..), NewOrData(..) )
  18 import RnMonad
  19 import RnEnv            ( availName )
  20
  21 import TcInstUtil       ( InstInfo(..) )
  22
  23 import CmdLineOpts
  24 import Id               ( Id, idType, idInfo, omitIfaceSigForId, isUserExportedId,
  25                           getIdSpecialisation
  26                         )
  27 import Var              ( isId )
  28 import VarSet
  29 import DataCon          ( StrictnessMark(..), dataConSig, dataConFieldLabels, dataConStrictMarks )
  30 import IdInfo           ( IdInfo, StrictnessInfo(..), ArityInfo, InlinePragInfo(..), inlinePragInfo,
  31                           arityInfo, ppArityInfo, arityLowerBound,
  32                           strictnessInfo, ppStrictnessInfo, isBottomingStrictness,
  33                           cafInfo, ppCafInfo, specInfo,
  34                           cprInfo, ppCprInfo, pprInlinePragInfo,
  35                           occInfo, OccInfo(..),
  36                           workerExists, workerInfo, ppWorkerInfo
  37                         )
  38 import CoreSyn          ( CoreExpr, CoreBind, Bind(..), rulesRules, rulesRhsFreeVars )
  39 import CoreFVs          ( exprSomeFreeVars, ruleSomeLhsFreeVars, ruleSomeFreeVars )
  40 import CoreUnfold       ( calcUnfoldingGuidance, okToUnfoldInHiFile, couldBeSmallEnoughToInline )
  41 import Module           ( moduleString, pprModule, pprModuleName )
  42 import Name             ( isLocallyDefined, isWiredInName, nameRdrName, nameModule,
  43                           Name, NamedThing(..)
  44                         )
  45 import OccName          ( OccName, pprOccName )
  46 import TyCon            ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon,
  47                           tyConTheta, tyConTyVars, tyConDataCons
  48                         )
  49 import Class            ( Class, classExtraBigSig )
  50 import FieldLabel       ( fieldLabelName, fieldLabelType )
  51 import Type             ( mkSigmaTy, splitSigmaTy, mkDictTy, tidyTopType,
  52                           deNoteType, classesToPreds,
  53                           Type, ThetaType, PredType(..), ClassContext
  54                         )
  55
  56 import PprType
  57 import PprCore          ( pprIfaceUnfolding, pprCoreRule )
  58 import FunDeps          ( pprFundeps )
  59 import Rules            ( pprProtoCoreRule, ProtoCoreRule(..) )
  60
  61 import Bag              ( bagToList, isEmptyBag )
  62 import Maybes           ( catMaybes, maybeToBool )
  63 import FiniteMap        ( emptyFM, addToFM, addToFM_C, fmToList, FiniteMap )
  64 import UniqFM           ( lookupUFM, listToUFM )
  65 import UniqSet          ( uniqSetToList )
  66 import Util             ( sortLt, mapAccumL )
  67 import Bag
  68 import Outputable
  69 \end{code}
  70
  71 We have a function @startIface@ to open the output file and put
  72 (something like) ``interface Foo'' in it.  It gives back a handle
  73 for subsequent additions to the interface file.
  74
  75 We then have one-function-per-block-of-interface-stuff, e.g.,
  76 @ifaceExportList@ produces the @__exports__@ section; it appends
  77 to the handle provided by @startIface@.
  78
  79 NOTE: ALWAYS remember that ghc-iface.lprl rewrites the interface file,
  80 so you have to keep it in synch with the code below. Otherwise you'll
  81 lose the happiest years of your life, believe me...  -- SUP
  82
  83 \begin{code}
  84 startIface  :: Module -> InterfaceDetails
  85             -> IO (Maybe Handle) -- Nothing <=> don't do an interface
  86
  87 ifaceDecls :: Maybe Handle
  88            -> [TyCon] -> [Class]
  89            -> Bag InstInfo
  90            -> [Id]              -- Ids used at code-gen time; they have better pragma info!
  91            -> [CoreBind]        -- In dependency order, later depend on earlier
  92            -> [ProtoCoreRule]   -- Rules
  93            -> [Deprecation Name]
  94            -> IO ()
  95
  96 endIface    :: Maybe Handle -> IO ()
  97 \end{code}
  98
  99 \begin{code}
 100 startIface mod (InterfaceDetails has_orphans import_usages (ExportEnv avails fixities _) _)
 101   = case opt_ProduceHi of
 102       Nothing -> return Nothing ; -- not producing any .hi file
 103
 104       Just fn -> do
 105         if_hdl <- openFile fn WriteMode
 106         hPutStr         if_hdl ("__interface " ++ moduleString mod)
 107         hPutStr         if_hdl (' ' : show (opt_HiVersion :: Int) ++ orphan_indicator)
 108         hPutStrLn       if_hdl " where"
 109         ifaceExports    if_hdl avails
 110         ifaceImports    if_hdl import_usages
 111         ifaceFixities   if_hdl fixities
 112         return (Just if_hdl)
 113   where
 114     orphan_indicator | has_orphans = " !"
 115                      | otherwise   = ""
 116
 117 endIface Nothing        = return ()
 118 endIface (Just if_hdl)  = hPutStr if_hdl "\n" >> hClose if_hdl
 119 \end{code}
 120
 121
 122 \begin{code}
 123 ifaceDecls Nothing tycons classes inst_info final_ids simplified rules _ = return ()
 124 ifaceDecls (Just hdl)
 125            tycons classes
 126            inst_infos
 127            final_ids
 128            binds
 129            orphan_rules         -- Rules defined locally for an Id that is *not* defined locally
 130            deprecations
 131   | null_decls = return ()
 132         --  You could have a module with just (re-)exports/instances in it
 133   | otherwise
 134   = ifaceClasses hdl classes                    >>
 135     ifaceInstances hdl inst_infos               >>= \ inst_ids ->
 136     ifaceTyCons hdl tycons                      >>
 137     ifaceBinds hdl (inst_ids `unionVarSet` orphan_rule_ids)
 138                final_ids binds                  >>= \ emitted_ids ->
 139     ifaceRules hdl orphan_rules emitted_ids     >>
 140     ifaceDeprecations hdl deprecations
 141   where
 142      orphan_rule_ids = unionVarSets [ ruleSomeFreeVars interestingId rule
 143                                     | ProtoCoreRule _ _ rule <- orphan_rules]
 144
 145      null_decls = null binds            &&
 146                   null tycons           &&
 147                   null classes          &&
 148                   isEmptyBag inst_infos &&
 149                   null orphan_rules     &&
 150                   null deprecations
 151 \end{code}
 152
 153 \begin{code}
 154 ifaceImports :: Handle -> VersionInfo Name -> IO ()
 155 ifaceImports if_hdl import_usages
 156   = hPutCol if_hdl upp_uses (sortLt lt_imp_vers import_usages)
 157   where
 158     upp_uses (m, mv, has_orphans, whats_imported)
 159       = hsep [ptext SLIT("import"), pprModuleName m,
 160               int mv, pp_orphan,
 161               upp_import_versions whats_imported
 162         ] <> semi
 163       where
 164         pp_orphan | has_orphans = ptext SLIT("!")
 165                   | otherwise   = empty
 166
 167         -- Importing the whole module is indicated by an empty list
 168     upp_import_versions Everything = empty
 169
 170         -- For imported versions we do print the version number
 171     upp_import_versions (Specifically nvs)
 172       = dcolon <+> hsep [ hsep [ppr_unqual_name n, int v] | (n,v) <- sort_versions nvs ]
 173
 174 {- SUP: What's this??
 175 ifaceModuleDeps if_hdl [] = return ()
 176 ifaceModuleDeps if_hdl mod_deps
 177   = let
 178         lines = map ppr_mod_dep mod_deps
 179         ppr_mod_dep (mod, contains_orphans)
 180            | contains_orphans = pprModuleName mod <+> ptext SLIT("!")
 181            | otherwise        = pprModuleName mod
 182     in
 183     printForIface if_hdl (ptext SLIT("__depends") <+> vcat lines <> ptext SLIT(" ;")) >>
 184     hPutStr if_hdl "\n"
 185 -}
 186
 187 ifaceExports :: Handle -> Avails -> IO ()
 188 ifaceExports if_hdl [] = return ()
 189 ifaceExports if_hdl avails
 190   = hPutCol if_hdl do_one_module (fmToList export_fm)
 191   where
 192         -- Sort them into groups by module
 193     export_fm :: FiniteMap Module [AvailInfo]
 194     export_fm = foldr insert emptyFM avails
 195
 196     insert avail efm = addToFM_C (++) efm mod [avail]
 197                      where
 198                        mod = nameModule (availName avail)
 199
 200         -- Print one module's worth of stuff
 201     do_one_module :: (Module, [AvailInfo]) -> SDoc
 202     do_one_module (mod_name, avails@(avail1:_))
 203         = ptext SLIT("__export ") <>
 204           hsep [pprModule mod_name,
 205                 hsep (map upp_avail (sortLt lt_avail avails))
 206           ] <> semi
 207
 208 ifaceFixities :: Handle -> Fixities -> IO ()
 209 ifaceFixities if_hdl [] = return ()
 210 ifaceFixities if_hdl fixities
 211   = hPutCol if_hdl upp_fixity fixities
 212
 213 ifaceRules :: Handle -> [ProtoCoreRule] -> IdSet -> IO ()
 214 ifaceRules if_hdl rules emitted
 215   | null orphan_rule_pretties && null local_id_pretties
 216   = return ()
 217   | otherwise
 218   = printForIface if_hdl (vcat [
 219                 ptext SLIT("{-## __R"),
 220                 vcat orphan_rule_pretties,
 221                 vcat local_id_pretties,
 222                 ptext SLIT("##-}")
 223        ])
 224   where
 225     orphan_rule_pretties =  [ pprCoreRule (Just fn) rule
 226                             | ProtoCoreRule _ fn rule <- rules
 227                             ]
 228     local_id_pretties = [ pprCoreRule (Just fn) rule
 229                         | fn <- varSetElems emitted,
 230                           rule <- rulesRules (getIdSpecialisation fn),
 231                           all (`elemVarSet` emitted) (varSetElems (ruleSomeLhsFreeVars interestingId rule))
 232                                 -- Spit out a rule only if all its lhs free vars are emitted
 233                         ]
 234
 235 ifaceDeprecations :: Handle -> [Deprecation Name] -> IO ()
 236 ifaceDeprecations if_hdl [] = return ()
 237 ifaceDeprecations if_hdl deprecations
 238   = printForIface if_hdl (vcat [
 239                 ptext SLIT("{-## __D"),
 240                 vcat [ pprIfaceDeprec d <> semi | d <- deprecations ],
 241                 ptext SLIT("##-}")
 242        ])
 243   where
 244     -- SUP: TEMPORARY HACK, ignoring module deprecations and constructors for now
 245     pprIfaceDeprec (Deprecation (IEModuleContents _) txt) =           doubleQuotes (ppr txt)
 246     pprIfaceDeprec (Deprecation (IEVar            n) txt) = ppr n <+> doubleQuotes (ppr txt)
 247 \end{code}
 248
 249 %************************************************************************
 250 %*                                                                      *
 251 \subsection{Instance declarations}
 252 %*                                                                      *
 253 %************************************************************************
 254
 255
 256 \begin{code}
 257 ifaceInstances :: Handle -> Bag InstInfo -> IO IdSet            -- The IdSet is the needed dfuns
 258 ifaceInstances if_hdl inst_infos
 259   | null togo_insts = return emptyVarSet
 260   | otherwise       = hPutCol if_hdl pp_inst (sortLt lt_inst togo_insts) >>
 261                       return needed_ids
 262   where
 263     togo_insts  = filter is_togo_inst (bagToList inst_infos)
 264     needed_ids  = mkVarSet [dfun_id | InstInfo _ _ _ _ dfun_id _ _ _ <- togo_insts]
 265     is_togo_inst (InstInfo _ _ _ _ dfun_id _ _ _) = isLocallyDefined dfun_id
 266
 267     -------
 268     lt_inst (InstInfo _ _ _ _ dfun_id1 _ _ _)
 269             (InstInfo _ _ _ _ dfun_id2 _ _ _)
 270       = getOccName dfun_id1 < getOccName dfun_id2
 271         -- The dfuns are assigned names df1, df2, etc, in order of original textual
 272         -- occurrence, and this makes as good a sort order as any
 273
 274     -------
 275     pp_inst (InstInfo clas tvs tys theta dfun_id _ _ _)
 276       = let
 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.
 286             forall_ty     = mkSigmaTy tvs (classesToPreds theta)
 287                                       (deNoteType (mkDictTy clas tys))
 288             renumbered_ty = tidyTopType forall_ty
 289         in
 290         hcat [ptext SLIT("instance "), pprType renumbered_ty,
 291                     ptext SLIT(" = "), ppr_unqual_name dfun_id, semi]
 292 \end{code}
 293
 294
 295 %************************************************************************
 296 %*                                                                      *
 297 \subsection{Printing values}
 298 %*                                                                      *
 299 %************************************************************************
 300
 301 \begin{code}
 302 ifaceId :: (Id -> IdInfo)               -- This function "knows" the extra info added
 303                                         -- by the STG passes.  Sigh
 304
 305             -> IdSet                    -- Set of Ids that are needed by earlier interface
 306                                         -- file emissions.  If the Id isn't in this set, and isn't
 307                                         -- exported, there's no need to emit anything
 308             -> Bool                     -- True <=> recursive, so don't print unfolding
 309             -> Id
 310             -> CoreExpr                 -- The Id's right hand side
 311             -> Maybe (SDoc, IdSet)      -- The emitted stuff, plus any *extra* needed Ids
 312
 313 ifaceId get_idinfo needed_ids is_rec id rhs
 314   | not (id `elemVarSet` needed_ids ||          -- Needed [no id in needed_ids has omitIfaceSigForId]
 315          (isUserExportedId id && not (omitIfaceSigForId id)))   -- or exported and not to be omitted
 316   = Nothing             -- Well, that was easy!
 317
 318 ifaceId get_idinfo needed_ids is_rec id rhs
 319   = ASSERT2( arity_matches_strictness, ppr id )
 320     Just (hsep [sig_pretty, prag_pretty, char ';'], new_needed_ids)
 321   where
 322     core_idinfo = idInfo id
 323     stg_idinfo  = get_idinfo id
 324
 325     ty_pretty  = pprType (idType id)
 326     sig_pretty = hsep [ppr (getOccName id), dcolon, ty_pretty]
 327
 328     prag_pretty
 329      | opt_OmitInterfacePragmas = empty
 330      | otherwise                = hsep [ptext SLIT("{-##"),
 331                                         arity_pretty,
 332                                         caf_pretty,
 333                                         cpr_pretty,
 334                                         strict_pretty,
 335                                         wrkr_pretty,
 336                                         unfold_pretty,
 337                                         ptext SLIT("##-}")]
 338
 339     ------------  Arity  --------------
 340     arity_info    = arityInfo stg_idinfo
 341     arity_pretty  = ppArityInfo arity_info
 342
 343     ------------ Caf Info --------------
 344     caf_pretty = ppCafInfo (cafInfo stg_idinfo)
 345
 346     ------------ CPR Info --------------
 347     cpr_pretty = ppCprInfo (cprInfo core_idinfo)
 348
 349     ------------  Strictness  --------------
 350     strict_info   = strictnessInfo core_idinfo
 351     bottoming_fn  = isBottomingStrictness strict_info
 352     strict_pretty = ppStrictnessInfo strict_info
 353
 354     ------------  Worker  --------------
 355     work_info     = workerInfo core_idinfo
 356     has_worker    = workerExists work_info
 357     wrkr_pretty   = ppWorkerInfo work_info
 358     Just work_id  = work_info
 359
 360
 361     ------------  Occ info  --------------
 362     loop_breaker  = case occInfo core_idinfo of
 363                         IAmALoopBreaker -> True
 364                         other           -> False
 365
 366     ------------  Unfolding  --------------
 367     inline_pragma  = inlinePragInfo core_idinfo
 368     dont_inline    = case inline_pragma of
 369                         IMustNotBeINLINEd False Nothing -> True -- Unconditional NOINLINE
 370                         other                           -> False
 371
 372
 373     unfold_pretty | show_unfold = ptext SLIT("__U") <> pprInlinePragInfo inline_pragma <+> pprIfaceUnfolding rhs
 374                   | otherwise   = empty
 375
 376     show_unfold = not has_worker         &&     -- Not unnecessary
 377                   not bottoming_fn       &&     -- Not necessary
 378                   not dont_inline        &&
 379                   not loop_breaker       &&
 380                   rhs_is_small           &&     -- Small enough
 381                   okToUnfoldInHiFile rhs        -- No casms etc
 382
 383     rhs_is_small = couldBeSmallEnoughToInline (calcUnfoldingGuidance opt_UF_HiFileThreshold rhs)
 384
 385     ------------  Specialisations --------------
 386     spec_info   = specInfo core_idinfo
 387
 388     ------------  Extra free Ids  --------------
 389     new_needed_ids | opt_OmitInterfacePragmas = emptyVarSet
 390                    | otherwise                = worker_ids      `unionVarSet`
 391                                                 unfold_ids      `unionVarSet`
 392                                                 spec_ids
 393
 394     worker_ids | has_worker && interestingId work_id = unitVarSet work_id
 395                         -- Conceivably, the worker might come from
 396                         -- another module
 397                | otherwise                         = emptyVarSet
 398
 399     spec_ids = filterVarSet interestingId (rulesRhsFreeVars spec_info)
 400
 401     unfold_ids | show_unfold = find_fvs rhs
 402                | otherwise   = emptyVarSet
 403
 404     find_fvs expr = exprSomeFreeVars interestingId expr
 405
 406     ------------ Sanity checking --------------
 407         -- The arity of a wrapper function should match its strictness,
 408         -- or else an importing module will get very confused indeed.
 409         -- [later: actually all that is necessary is for strictness to exceed arity]
 410     arity_matches_strictness
 411         = not has_worker ||
 412           case strict_info of
 413             StrictnessInfo ds _ -> length ds >= arityLowerBound arity_info
 414             other               -> True
 415
 416 interestingId id = isId id && isLocallyDefined id &&
 417                    not (omitIfaceSigForId id)
 418 \end{code}
 419
 420 \begin{code}
 421 ifaceBinds :: Handle
 422            -> IdSet             -- These Ids are needed already
 423            -> [Id]              -- Ids used at code-gen time; they have better pragma info!
 424            -> [CoreBind]        -- In dependency order, later depend on earlier
 425            -> IO IdSet          -- Set of Ids actually spat out
 426
 427 ifaceBinds hdl needed_ids final_ids binds
 428   = mapIO (printForIface hdl) (bagToList pretties)      >>
 429     hPutStr hdl "\n"                                    >>
 430     return emitted
 431   where
 432     final_id_map  = listToUFM [(id,id) | id <- final_ids]
 433     get_idinfo id = case lookupUFM final_id_map id of
 434                         Just id' -> idInfo id'
 435                         Nothing  -> pprTrace "ifaceBinds not found:" (ppr id) $
 436                                     idInfo id
 437
 438     (pretties, emitted) = go needed_ids (reverse binds) emptyBag emptyVarSet
 439                         -- Reverse so that later things will
 440                         -- provoke earlier ones to be emitted
 441     go needed [] pretties emitted
 442         | not (isEmptyVarSet needed) = pprTrace "ifaceBinds: free vars:"
 443                                           (sep (map ppr (varSetElems needed)))
 444                                        (pretties, emitted)
 445         | otherwise                  = (pretties, emitted)
 446
 447     go needed (NonRec id rhs : binds) pretties emitted
 448         = case ifaceId get_idinfo needed False id rhs of
 449                 Nothing               -> go needed binds pretties emitted
 450                 Just (pretty, extras) -> let
 451                         needed' = (needed `unionVarSet` extras) `delVarSet` id
 452                         -- 'extras' can include the Id itself via a rule
 453                         emitted' = emitted `extendVarSet` id
 454                         in
 455                         go needed' binds (pretty `consBag` pretties) emitted'
 456
 457         -- Recursive groups are a bit more of a pain.  We may only need one to
 458         -- start with, but it may call out the next one, and so on.  So we
 459         -- have to look for a fixed point.
 460     go needed (Rec pairs : binds) pretties emitted
 461         = go needed' binds pretties' emitted'
 462         where
 463           (new_pretties, new_emitted, extras) = go_rec needed pairs
 464           pretties' = new_pretties `unionBags` pretties
 465           needed'   = (needed `unionVarSet` extras) `minusVarSet` mkVarSet (map fst pairs)
 466           emitted'  = emitted `unionVarSet` new_emitted
 467
 468     go_rec :: IdSet -> [(Id,CoreExpr)] -> (Bag SDoc, IdSet, IdSet)
 469     go_rec needed pairs
 470         | null pretties = (emptyBag, emptyVarSet, emptyVarSet)
 471         | otherwise     = (more_pretties `unionBags`   listToBag pretties,
 472                            more_emitted  `unionVarSet` mkVarSet emitted,
 473                            more_extras   `unionVarSet` extras)
 474         where
 475           maybes               = map do_one pairs
 476           emitted              = [id   | ((id,_), Just _)  <- pairs `zip` maybes]
 477           reduced_pairs        = [pair | (pair,   Nothing) <- pairs `zip` maybes]
 478           (pretties, extras_s) = unzip (catMaybes maybes)
 479           extras               = unionVarSets extras_s
 480           (more_pretties, more_emitted, more_extras) = go_rec extras reduced_pairs
 481
 482           do_one (id,rhs) = ifaceId get_idinfo needed True id rhs
 483 \end{code}
 484
 485
 486 %************************************************************************
 487 %*                                                                      *
 488 \subsection{Random small things}
 489 %*                                                                      *
 490 %************************************************************************
 491
 492 \begin{code}
 493 ifaceTyCons hdl tycons   = hPutCol hdl upp_tycon (sortLt (<) (filter (for_iface_name . getName) tycons))
 494 ifaceClasses hdl classes = hPutCol hdl upp_class (sortLt (<) (filter (for_iface_name . getName) classes))
 495
 496 for_iface_name name = isLocallyDefined name &&
 497                       not (isWiredInName name)
 498
 499 upp_tycon tycon = ifaceTyCon tycon
 500 upp_class clas  = ifaceClass clas
 501 \end{code}
 502
 503
 504 \begin{code}
 505 ifaceTyCon :: TyCon -> SDoc
 506 ifaceTyCon tycon
 507   | isSynTyCon tycon
 508   = hsep [ ptext SLIT("type"),
 509            ppr (getName tycon),
 510            pprTyVarBndrs tyvars,
 511            ptext SLIT("="),
 512            ppr ty,
 513            semi
 514     ]
 515   where
 516     (tyvars, ty) = getSynTyConDefn tycon
 517
 518 ifaceTyCon tycon
 519   | isAlgTyCon tycon
 520   = hsep [ ptext keyword,
 521            ppr_decl_class_context (tyConTheta tycon),
 522            ppr (getName tycon),
 523            pprTyVarBndrs (tyConTyVars tycon),
 524            ptext SLIT("="),
 525            hsep (punctuate (ptext SLIT(" | ")) (map ppr_con (tyConDataCons tycon))),
 526            semi
 527     ]
 528   where
 529     keyword | isNewTyCon tycon = SLIT("newtype")
 530             | otherwise        = SLIT("data")
 531
 532     tyvars = tyConTyVars tycon
 533
 534     ppr_con data_con
 535         | null field_labels
 536         = ASSERT( tycon == tycon1 && tyvars == tyvars1 )
 537           hsep [  ppr_ex ex_tyvars ex_theta,
 538                   ppr name,
 539                   hsep (map ppr_arg_ty (strict_marks `zip` arg_tys))
 540                 ]
 541
 542         | otherwise
 543         = hsep [  ppr_ex ex_tyvars ex_theta,
 544                   ppr name,
 545                   braces $ hsep $ punctuate comma (map ppr_field (strict_marks `zip` field_labels))
 546                 ]
 547           where
 548            (tyvars1, theta1, ex_tyvars, ex_theta, arg_tys, tycon1) = dataConSig data_con
 549            field_labels   = dataConFieldLabels data_con
 550            strict_marks   = dataConStrictMarks data_con
 551            name           = getName            data_con
 552
 553     ppr_ex [] ex_theta = ASSERT( null ex_theta ) empty
 554     ppr_ex ex_tvs ex_theta = ptext SLIT("__forall") <+> brackets (pprTyVarBndrs ex_tvs)
 555                              <+> pprIfaceClasses ex_theta <+> ptext SLIT("=>")
 556
 557     ppr_arg_ty (strict_mark, ty) = ppr_strict_mark strict_mark <> pprParendType ty
 558
 559     ppr_strict_mark NotMarkedStrict        = empty
 560     ppr_strict_mark (MarkedUnboxed _ _)    = ptext SLIT("! ! ")
 561     ppr_strict_mark MarkedStrict           = ptext SLIT("! ")
 562
 563     ppr_field (strict_mark, field_label)
 564         = hsep [ ppr (fieldLabelName field_label),
 565                   dcolon,
 566                   ppr_strict_mark strict_mark <> pprParendType (fieldLabelType field_label)
 567                 ]
 568
 569 ifaceTyCon tycon
 570   = pprPanic "pprIfaceTyDecl" (ppr tycon)
 571
 572 ifaceClass clas
 573   = hsep [ptext SLIT("class"),
 574            ppr_decl_class_context sc_theta,
 575            ppr clas,                    -- Print the name
 576            pprTyVarBndrs clas_tyvars,
 577            pprFundeps clas_fds,
 578            pp_ops,
 579            semi
 580           ]
 581    where
 582      (clas_tyvars, clas_fds, sc_theta, _, op_stuff) = classExtraBigSig clas
 583
 584      pp_ops | null op_stuff  = empty
 585             | otherwise      = hsep [ptext SLIT("where"),
 586                                      braces (hsep (punctuate semi (map ppr_classop op_stuff)))
 587                                ]
 588
 589      ppr_classop (sel_id, dm_id, explicit_dm)
 590         = ASSERT( sel_tyvars == clas_tyvars)
 591           hsep [ppr (getOccName sel_id),
 592                 if explicit_dm then equals else empty,
 593                 dcolon,
 594                 ppr op_ty
 595           ]
 596         where
 597           (sel_tyvars, _, op_ty) = splitSigmaTy (idType sel_id)
 598
 599 ppr_decl_context :: ThetaType -> SDoc
 600 ppr_decl_context []    = empty
 601 ppr_decl_context theta = pprIfaceTheta theta <+> ptext SLIT(" =>")
 602
 603 ppr_decl_class_context :: ClassContext -> SDoc
 604 ppr_decl_class_context []    = empty
 605 ppr_decl_class_context ctxt  = pprIfaceClasses ctxt <+> ptext SLIT(" =>")
 606
 607 pprIfaceTheta :: ThetaType -> SDoc      -- Use braces rather than parens in interface files
 608 pprIfaceTheta []    = empty
 609 pprIfaceTheta theta = braces (hsep (punctuate comma [pprIfacePred p | p <- theta]))
 610
 611 -- ZZ - not sure who uses this - i.e. whether IParams really show up or not
 612 -- (it's not used to print normal value signatures)
 613 pprIfacePred :: PredType -> SDoc
 614 pprIfacePred (Class clas tys) = pprConstraint clas tys
 615 pprIfacePred (IParam n ty)    = char '?' <> ppr n <+> ptext SLIT("::") <+> ppr ty
 616
 617 pprIfaceClasses :: ClassContext -> SDoc
 618 pprIfaceClasses []    = empty
 619 pprIfaceClasses theta = braces (hsep (punctuate comma [pprConstraint c tys | (c,tys) <- theta]))
 620 \end{code}
 621
 622 %************************************************************************
 623 %*                                                                      *
 624 \subsection{Random small things}
 625 %*                                                                      *
 626 %************************************************************************
 627
 628 When printing export lists, we print like this:
 629         Avail   f               f
 630         AvailTC C [C, x, y]     C(x,y)
 631         AvailTC C [x, y]        C!(x,y)         -- Exporting x, y but not C
 632
 633 \begin{code}
 634 upp_avail :: AvailInfo -> SDoc
 635 upp_avail (Avail name)      = pprOccName (getOccName name)
 636 upp_avail (AvailTC name []) = empty
 637 upp_avail (AvailTC name ns) = hcat [pprOccName (getOccName name), bang, upp_export ns']
 638                             where
 639                               bang | name `elem` ns = empty
 640                                    | otherwise      = char '|'
 641                               ns' = filter (/= name) ns
 642
 643 upp_export :: [Name] -> SDoc
 644 upp_export []    = empty
 645 upp_export names = braces (hsep (map (pprOccName . getOccName) names))
 646
 647 upp_fixity :: (Name, Fixity) -> SDoc
 648 upp_fixity (name, fixity) = hsep [ptext SLIT("0"), ppr fixity, ppr name, semi]
 649         -- Dummy version number!
 650
 651 ppr_unqual_name :: NamedThing a => a -> SDoc            -- Just its occurrence name
 652 ppr_unqual_name name = pprOccName (getOccName name)
 653 \end{code}
 654
 655
 656 %************************************************************************
 657 %*                                                                      *
 658 \subsection{Comparisons}
 659 %*                                                                      *
 660 %************************************************************************
 661
 662
 663 The various sorts above simply prevent unnecessary "wobbling" when
 664 things change that don't have to.  We therefore compare lexically, not
 665 by unique
 666
 667 \begin{code}
 668 lt_avail :: AvailInfo -> AvailInfo -> Bool
 669
 670 a1 `lt_avail` a2 = availName a1 `lt_name` availName a2
 671
 672 lt_name :: Name -> Name -> Bool
 673 n1 `lt_name` n2 = nameRdrName n1 < nameRdrName n2
 674
 675 lt_lexical :: NamedThing a => a -> a -> Bool
 676 lt_lexical a1 a2 = getName a1 `lt_name` getName a2
 677
 678 lt_imp_vers :: ImportVersion a -> ImportVersion a -> Bool
 679 lt_imp_vers (m1,_,_,_) (m2,_,_,_) = m1 < m2
 680
 681 sort_versions vs = sortLt lt_vers vs
 682
 683 lt_vers :: LocalVersion Name -> LocalVersion Name -> Bool
 684 lt_vers (n1,v1) (n2,v2) = n1 `lt_name` n2
 685 \end{code}
 686
 687
 688 \begin{code}
 689 hPutCol :: Handle
 690         -> (a -> SDoc)
 691         -> [a]
 692         -> IO ()
 693 hPutCol hdl fmt xs = mapIO (printForIface hdl . fmt) xs
 694
 695 mapIO :: (a -> IO b) -> [a] -> IO ()
 696 mapIO f []     = return ()
 697 mapIO f (x:xs) = f x >> mapIO f xs
 698 \end{code}