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     pprIfaceDeprec (DeprecMod    txt) =           doubleQuotes (ppr txt)
 245     pprIfaceDeprec (DeprecName n txt) = ppr n <+> doubleQuotes (ppr txt)
 246 \end{code}
 247
 248 %************************************************************************
 249 %*                                                                      *
 250 \subsection{Instance declarations}
 251 %*                                                                      *
 252 %************************************************************************
 253
 254
 255 \begin{code}
 256 ifaceInstances :: Handle -> Bag InstInfo -> IO IdSet            -- The IdSet is the needed dfuns
 257 ifaceInstances if_hdl inst_infos
 258   | null togo_insts = return emptyVarSet
 259   | otherwise       = hPutCol if_hdl pp_inst (sortLt lt_inst togo_insts) >>
 260                       return needed_ids
 261   where
 262     togo_insts  = filter is_togo_inst (bagToList inst_infos)
 263     needed_ids  = mkVarSet [dfun_id | InstInfo _ _ _ _ dfun_id _ _ _ <- togo_insts]
 264     is_togo_inst (InstInfo _ _ _ _ dfun_id _ _ _) = isLocallyDefined dfun_id
 265
 266     -------
 267     lt_inst (InstInfo _ _ _ _ dfun_id1 _ _ _)
 268             (InstInfo _ _ _ _ dfun_id2 _ _ _)
 269       = getOccName dfun_id1 < getOccName dfun_id2
 270         -- The dfuns are assigned names df1, df2, etc, in order of original textual
 271         -- occurrence, and this makes as good a sort order as any
 272
 273     -------
 274     pp_inst (InstInfo clas tvs tys theta dfun_id _ _ _)
 275       = let
 276                 -- The deNoteType is very important.   It removes all type
 277                 -- synonyms from the instance type in interface files.
 278                 -- That in turn makes sure that when reading in instance decls
 279                 -- from interface files that the 'gating' mechanism works properly.
 280                 -- Otherwise you could have
 281                 --      type Tibble = T Int
 282                 --      instance Foo Tibble where ...
 283                 -- and this instance decl wouldn't get imported into a module
 284                 -- that mentioned T but not Tibble.
 285             forall_ty     = mkSigmaTy tvs (classesToPreds theta)
 286                                       (deNoteType (mkDictTy clas tys))
 287             renumbered_ty = tidyTopType forall_ty
 288         in
 289         hcat [ptext SLIT("instance "), pprType renumbered_ty,
 290                     ptext SLIT(" = "), ppr_unqual_name dfun_id, semi]
 291 \end{code}
 292
 293
 294 %************************************************************************
 295 %*                                                                      *
 296 \subsection{Printing values}
 297 %*                                                                      *
 298 %************************************************************************
 299
 300 \begin{code}
 301 ifaceId :: (Id -> IdInfo)               -- This function "knows" the extra info added
 302                                         -- by the STG passes.  Sigh
 303
 304             -> IdSet                    -- Set of Ids that are needed by earlier interface
 305                                         -- file emissions.  If the Id isn't in this set, and isn't
 306                                         -- exported, there's no need to emit anything
 307             -> Bool                     -- True <=> recursive, so don't print unfolding
 308             -> Id
 309             -> CoreExpr                 -- The Id's right hand side
 310             -> Maybe (SDoc, IdSet)      -- The emitted stuff, plus any *extra* needed Ids
 311
 312 ifaceId get_idinfo needed_ids is_rec id rhs
 313   | not (id `elemVarSet` needed_ids ||          -- Needed [no id in needed_ids has omitIfaceSigForId]
 314          (isUserExportedId id && not (omitIfaceSigForId id)))   -- or exported and not to be omitted
 315   = Nothing             -- Well, that was easy!
 316
 317 ifaceId get_idinfo needed_ids is_rec id rhs
 318   = ASSERT2( arity_matches_strictness, ppr id )
 319     Just (hsep [sig_pretty, prag_pretty, char ';'], new_needed_ids)
 320   where
 321     core_idinfo = idInfo id
 322     stg_idinfo  = get_idinfo id
 323
 324     ty_pretty  = pprType (idType id)
 325     sig_pretty = hsep [ppr (getOccName id), dcolon, ty_pretty]
 326
 327     prag_pretty
 328      | opt_OmitInterfacePragmas = empty
 329      | otherwise                = hsep [ptext SLIT("{-##"),
 330                                         arity_pretty,
 331                                         caf_pretty,
 332                                         cpr_pretty,
 333                                         strict_pretty,
 334                                         wrkr_pretty,
 335                                         unfold_pretty,
 336                                         ptext SLIT("##-}")]
 337
 338     ------------  Arity  --------------
 339     arity_info    = arityInfo stg_idinfo
 340     arity_pretty  = ppArityInfo arity_info
 341
 342     ------------ Caf Info --------------
 343     caf_pretty = ppCafInfo (cafInfo stg_idinfo)
 344
 345     ------------ CPR Info --------------
 346     cpr_pretty = ppCprInfo (cprInfo core_idinfo)
 347
 348     ------------  Strictness  --------------
 349     strict_info   = strictnessInfo core_idinfo
 350     bottoming_fn  = isBottomingStrictness strict_info
 351     strict_pretty = ppStrictnessInfo strict_info
 352
 353     ------------  Worker  --------------
 354     work_info     = workerInfo core_idinfo
 355     has_worker    = workerExists work_info
 356     wrkr_pretty   = ppWorkerInfo work_info
 357     Just work_id  = work_info
 358
 359
 360     ------------  Occ info  --------------
 361     loop_breaker  = case occInfo core_idinfo of
 362                         IAmALoopBreaker -> True
 363                         other           -> False
 364
 365     ------------  Unfolding  --------------
 366     inline_pragma  = inlinePragInfo core_idinfo
 367     dont_inline    = case inline_pragma of
 368                         IMustNotBeINLINEd False Nothing -> True -- Unconditional NOINLINE
 369                         other                           -> False
 370
 371
 372     unfold_pretty | show_unfold = ptext SLIT("__U") <> pprInlinePragInfo inline_pragma <+> pprIfaceUnfolding rhs
 373                   | otherwise   = empty
 374
 375     show_unfold = not has_worker         &&     -- Not unnecessary
 376                   not bottoming_fn       &&     -- Not necessary
 377                   not dont_inline        &&
 378                   not loop_breaker       &&
 379                   rhs_is_small           &&     -- Small enough
 380                   okToUnfoldInHiFile rhs        -- No casms etc
 381
 382     rhs_is_small = couldBeSmallEnoughToInline (calcUnfoldingGuidance opt_UF_HiFileThreshold rhs)
 383
 384     ------------  Specialisations --------------
 385     spec_info   = specInfo core_idinfo
 386
 387     ------------  Extra free Ids  --------------
 388     new_needed_ids | opt_OmitInterfacePragmas = emptyVarSet
 389                    | otherwise                = worker_ids      `unionVarSet`
 390                                                 unfold_ids      `unionVarSet`
 391                                                 spec_ids
 392
 393     worker_ids | has_worker && interestingId work_id = unitVarSet work_id
 394                         -- Conceivably, the worker might come from
 395                         -- another module
 396                | otherwise                         = emptyVarSet
 397
 398     spec_ids = filterVarSet interestingId (rulesRhsFreeVars spec_info)
 399
 400     unfold_ids | show_unfold = find_fvs rhs
 401                | otherwise   = emptyVarSet
 402
 403     find_fvs expr = exprSomeFreeVars interestingId expr
 404
 405     ------------ Sanity checking --------------
 406         -- The arity of a wrapper function should match its strictness,
 407         -- or else an importing module will get very confused indeed.
 408         -- [later: actually all that is necessary is for strictness to exceed arity]
 409     arity_matches_strictness
 410         = not has_worker ||
 411           case strict_info of
 412             StrictnessInfo ds _ -> length ds >= arityLowerBound arity_info
 413             other               -> True
 414
 415 interestingId id = isId id && isLocallyDefined id &&
 416                    not (omitIfaceSigForId id)
 417 \end{code}
 418
 419 \begin{code}
 420 ifaceBinds :: Handle
 421            -> IdSet             -- These Ids are needed already
 422            -> [Id]              -- Ids used at code-gen time; they have better pragma info!
 423            -> [CoreBind]        -- In dependency order, later depend on earlier
 424            -> IO IdSet          -- Set of Ids actually spat out
 425
 426 ifaceBinds hdl needed_ids final_ids binds
 427   = mapIO (printForIface hdl) (bagToList pretties)      >>
 428     hPutStr hdl "\n"                                    >>
 429     return emitted
 430   where
 431     final_id_map  = listToUFM [(id,id) | id <- final_ids]
 432     get_idinfo id = case lookupUFM final_id_map id of
 433                         Just id' -> idInfo id'
 434                         Nothing  -> pprTrace "ifaceBinds not found:" (ppr id) $
 435                                     idInfo id
 436
 437     (pretties, emitted) = go needed_ids (reverse binds) emptyBag emptyVarSet
 438                         -- Reverse so that later things will
 439                         -- provoke earlier ones to be emitted
 440     go needed [] pretties emitted
 441         | not (isEmptyVarSet needed) = pprTrace "ifaceBinds: free vars:"
 442                                           (sep (map ppr (varSetElems needed)))
 443                                        (pretties, emitted)
 444         | otherwise                  = (pretties, emitted)
 445
 446     go needed (NonRec id rhs : binds) pretties emitted
 447         = case ifaceId get_idinfo needed False id rhs of
 448                 Nothing               -> go needed binds pretties emitted
 449                 Just (pretty, extras) -> let
 450                         needed' = (needed `unionVarSet` extras) `delVarSet` id
 451                         -- 'extras' can include the Id itself via a rule
 452                         emitted' = emitted `extendVarSet` id
 453                         in
 454                         go needed' binds (pretty `consBag` pretties) emitted'
 455
 456         -- Recursive groups are a bit more of a pain.  We may only need one to
 457         -- start with, but it may call out the next one, and so on.  So we
 458         -- have to look for a fixed point.
 459     go needed (Rec pairs : binds) pretties emitted
 460         = go needed' binds pretties' emitted'
 461         where
 462           (new_pretties, new_emitted, extras) = go_rec needed pairs
 463           pretties' = new_pretties `unionBags` pretties
 464           needed'   = (needed `unionVarSet` extras) `minusVarSet` mkVarSet (map fst pairs)
 465           emitted'  = emitted `unionVarSet` new_emitted
 466
 467     go_rec :: IdSet -> [(Id,CoreExpr)] -> (Bag SDoc, IdSet, IdSet)
 468     go_rec needed pairs
 469         | null pretties = (emptyBag, emptyVarSet, emptyVarSet)
 470         | otherwise     = (more_pretties `unionBags`   listToBag pretties,
 471                            more_emitted  `unionVarSet` mkVarSet emitted,
 472                            more_extras   `unionVarSet` extras)
 473         where
 474           maybes               = map do_one pairs
 475           emitted              = [id   | ((id,_), Just _)  <- pairs `zip` maybes]
 476           reduced_pairs        = [pair | (pair,   Nothing) <- pairs `zip` maybes]
 477           (pretties, extras_s) = unzip (catMaybes maybes)
 478           extras               = unionVarSets extras_s
 479           (more_pretties, more_emitted, more_extras) = go_rec extras reduced_pairs
 480
 481           do_one (id,rhs) = ifaceId get_idinfo needed True id rhs
 482 \end{code}
 483
 484
 485 %************************************************************************
 486 %*                                                                      *
 487 \subsection{Random small things}
 488 %*                                                                      *
 489 %************************************************************************
 490
 491 \begin{code}
 492 ifaceTyCons hdl tycons   = hPutCol hdl upp_tycon (sortLt (<) (filter (for_iface_name . getName) tycons))
 493 ifaceClasses hdl classes = hPutCol hdl upp_class (sortLt (<) (filter (for_iface_name . getName) classes))
 494
 495 for_iface_name name = isLocallyDefined name &&
 496                       not (isWiredInName name)
 497
 498 upp_tycon tycon = ifaceTyCon tycon
 499 upp_class clas  = ifaceClass clas
 500 \end{code}
 501
 502
 503 \begin{code}
 504 ifaceTyCon :: TyCon -> SDoc
 505 ifaceTyCon tycon
 506   | isSynTyCon tycon
 507   = hsep [ ptext SLIT("type"),
 508            ppr (getName tycon),
 509            pprTyVarBndrs tyvars,
 510            ptext SLIT("="),
 511            ppr ty,
 512            semi
 513     ]
 514   where
 515     (tyvars, ty) = getSynTyConDefn tycon
 516
 517 ifaceTyCon tycon
 518   | isAlgTyCon tycon
 519   = hsep [ ptext keyword,
 520            ppr_decl_class_context (tyConTheta tycon),
 521            ppr (getName tycon),
 522            pprTyVarBndrs (tyConTyVars tycon),
 523            ptext SLIT("="),
 524            hsep (punctuate (ptext SLIT(" | ")) (map ppr_con (tyConDataCons tycon))),
 525            semi
 526     ]
 527   where
 528     keyword | isNewTyCon tycon = SLIT("newtype")
 529             | otherwise        = SLIT("data")
 530
 531     tyvars = tyConTyVars tycon
 532
 533     ppr_con data_con
 534         | null field_labels
 535         = ASSERT( tycon == tycon1 && tyvars == tyvars1 )
 536           hsep [  ppr_ex ex_tyvars ex_theta,
 537                   ppr name,
 538                   hsep (map ppr_arg_ty (strict_marks `zip` arg_tys))
 539                 ]
 540
 541         | otherwise
 542         = hsep [  ppr_ex ex_tyvars ex_theta,
 543                   ppr name,
 544                   braces $ hsep $ punctuate comma (map ppr_field (strict_marks `zip` field_labels))
 545                 ]
 546           where
 547            (tyvars1, theta1, ex_tyvars, ex_theta, arg_tys, tycon1) = dataConSig data_con
 548            field_labels   = dataConFieldLabels data_con
 549            strict_marks   = dataConStrictMarks data_con
 550            name           = getName            data_con
 551
 552     ppr_ex [] ex_theta = ASSERT( null ex_theta ) empty
 553     ppr_ex ex_tvs ex_theta = ptext SLIT("__forall") <+> brackets (pprTyVarBndrs ex_tvs)
 554                              <+> pprIfaceClasses ex_theta <+> ptext SLIT("=>")
 555
 556     ppr_arg_ty (strict_mark, ty) = ppr_strict_mark strict_mark <> pprParendType ty
 557
 558     ppr_strict_mark NotMarkedStrict        = empty
 559     ppr_strict_mark (MarkedUnboxed _ _)    = ptext SLIT("! ! ")
 560     ppr_strict_mark MarkedStrict           = ptext SLIT("! ")
 561
 562     ppr_field (strict_mark, field_label)
 563         = hsep [ ppr (fieldLabelName field_label),
 564                   dcolon,
 565                   ppr_strict_mark strict_mark <> pprParendType (fieldLabelType field_label)
 566                 ]
 567
 568 ifaceTyCon tycon
 569   = pprPanic "pprIfaceTyDecl" (ppr tycon)
 570
 571 ifaceClass clas
 572   = hsep [ptext SLIT("class"),
 573            ppr_decl_class_context sc_theta,
 574            ppr clas,                    -- Print the name
 575            pprTyVarBndrs clas_tyvars,
 576            pprFundeps clas_fds,
 577            pp_ops,
 578            semi
 579           ]
 580    where
 581      (clas_tyvars, clas_fds, sc_theta, _, op_stuff) = classExtraBigSig clas
 582
 583      pp_ops | null op_stuff  = empty
 584             | otherwise      = hsep [ptext SLIT("where"),
 585                                      braces (hsep (punctuate semi (map ppr_classop op_stuff)))
 586                                ]
 587
 588      ppr_classop (sel_id, dm_id, explicit_dm)
 589         = ASSERT( sel_tyvars == clas_tyvars)
 590           hsep [ppr (getOccName sel_id),
 591                 if explicit_dm then equals else empty,
 592                 dcolon,
 593                 ppr op_ty
 594           ]
 595         where
 596           (sel_tyvars, _, op_ty) = splitSigmaTy (idType sel_id)
 597
 598 ppr_decl_context :: ThetaType -> SDoc
 599 ppr_decl_context []    = empty
 600 ppr_decl_context theta = pprIfaceTheta theta <+> ptext SLIT(" =>")
 601
 602 ppr_decl_class_context :: ClassContext -> SDoc
 603 ppr_decl_class_context []    = empty
 604 ppr_decl_class_context ctxt  = pprIfaceClasses ctxt <+> ptext SLIT(" =>")
 605
 606 pprIfaceTheta :: ThetaType -> SDoc      -- Use braces rather than parens in interface files
 607 pprIfaceTheta []    = empty
 608 pprIfaceTheta theta = braces (hsep (punctuate comma [pprIfacePred p | p <- theta]))
 609
 610 -- ZZ - not sure who uses this - i.e. whether IParams really show up or not
 611 -- (it's not used to print normal value signatures)
 612 pprIfacePred :: PredType -> SDoc
 613 pprIfacePred (Class clas tys) = pprConstraint clas tys
 614 pprIfacePred (IParam n ty)    = char '?' <> ppr n <+> ptext SLIT("::") <+> ppr ty
 615
 616 pprIfaceClasses :: ClassContext -> SDoc
 617 pprIfaceClasses []    = empty
 618 pprIfaceClasses theta = braces (hsep (punctuate comma [pprConstraint c tys | (c,tys) <- theta]))
 619 \end{code}
 620
 621 %************************************************************************
 622 %*                                                                      *
 623 \subsection{Random small things}
 624 %*                                                                      *
 625 %************************************************************************
 626
 627 When printing export lists, we print like this:
 628         Avail   f               f
 629         AvailTC C [C, x, y]     C(x,y)
 630         AvailTC C [x, y]        C!(x,y)         -- Exporting x, y but not C
 631
 632 \begin{code}
 633 upp_avail :: AvailInfo -> SDoc
 634 upp_avail (Avail name)      = pprOccName (getOccName name)
 635 upp_avail (AvailTC name []) = empty
 636 upp_avail (AvailTC name ns) = hcat [pprOccName (getOccName name), bang, upp_export ns']
 637                             where
 638                               bang | name `elem` ns = empty
 639                                    | otherwise      = char '|'
 640                               ns' = filter (/= name) ns
 641
 642 upp_export :: [Name] -> SDoc
 643 upp_export []    = empty
 644 upp_export names = braces (hsep (map (pprOccName . getOccName) names))
 645
 646 upp_fixity :: (Name, Fixity) -> SDoc
 647 upp_fixity (name, fixity) = hsep [ptext SLIT("0"), ppr fixity, ppr name, semi]
 648         -- Dummy version number!
 649
 650 ppr_unqual_name :: NamedThing a => a -> SDoc            -- Just its occurrence name
 651 ppr_unqual_name name = pprOccName (getOccName name)
 652 \end{code}
 653
 654
 655 %************************************************************************
 656 %*                                                                      *
 657 \subsection{Comparisons}
 658 %*                                                                      *
 659 %************************************************************************
 660
 661
 662 The various sorts above simply prevent unnecessary "wobbling" when
 663 things change that don't have to.  We therefore compare lexically, not
 664 by unique
 665
 666 \begin{code}
 667 lt_avail :: AvailInfo -> AvailInfo -> Bool
 668
 669 a1 `lt_avail` a2 = availName a1 `lt_name` availName a2
 670
 671 lt_name :: Name -> Name -> Bool
 672 n1 `lt_name` n2 = nameRdrName n1 < nameRdrName n2
 673
 674 lt_lexical :: NamedThing a => a -> a -> Bool
 675 lt_lexical a1 a2 = getName a1 `lt_name` getName a2
 676
 677 lt_imp_vers :: ImportVersion a -> ImportVersion a -> Bool
 678 lt_imp_vers (m1,_,_,_) (m2,_,_,_) = m1 < m2
 679
 680 sort_versions vs = sortLt lt_vers vs
 681
 682 lt_vers :: LocalVersion Name -> LocalVersion Name -> Bool
 683 lt_vers (n1,v1) (n2,v2) = n1 `lt_name` n2
 684 \end{code}
 685
 686
 687 \begin{code}
 688 hPutCol :: Handle
 689         -> (a -> SDoc)
 690         -> [a]
 691         -> IO ()
 692 hPutCol hdl fmt xs = mapIO (printForIface hdl . fmt) xs
 693
 694 mapIO :: (a -> IO b) -> [a] -> IO ()
 695 mapIO f []     = return ()
 696 mapIO f (x:xs) = f x >> mapIO f xs
 697 \end{code}