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         mkModDetails, mkModDetailsFromIface, completeIface,
   9         writeIface, pprIface
  10   ) where
  11
  12 #include "HsVersions.h"
  13
  14 import HsSyn
  15 import HsCore           ( HsIdInfo(..), UfExpr(..), toUfExpr, toUfBndr )
  16 import HsTypes          ( toHsTyVars )
  17 import BasicTypes       ( Fixity(..), NewOrData(..),
  18                           Version, initialVersion, bumpVersion, isLoopBreaker
  19                         )
  20 import RnMonad
  21 import RnHsSyn          ( RenamedInstDecl, RenamedTyClDecl )
  22 import TcHsSyn          ( TypecheckedRuleDecl )
  23 import HscTypes         ( VersionInfo(..), ModIface(..), ModDetails(..),
  24                           IfaceDecls, mkIfaceDecls, dcl_tycl, dcl_rules, dcl_insts,
  25                           TyThing(..), DFunId, TypeEnv, isTyClThing, Avails,
  26                           WhatsImported(..), GenAvailInfo(..),
  27                           ImportVersion, AvailInfo, Deprecations(..)
  28                         )
  29
  30 import CmdLineOpts
  31 import Id               ( Id, idType, idInfo, omitIfaceSigForId, isUserExportedId, hasNoBinding,
  32                           idSpecialisation, idName, setIdInfo
  33                         )
  34 import Var              ( isId )
  35 import VarSet
  36 import DataCon          ( StrictnessMark(..), dataConSig, dataConFieldLabels, dataConStrictMarks )
  37 import IdInfo           -- Lots
  38 import CoreSyn          ( CoreExpr, CoreBind, Bind(..), CoreRule(..), IdCoreRule,
  39                           isBuiltinRule, rulesRules, rulesRhsFreeVars, emptyCoreRules,
  40                           bindersOfBinds
  41                         )
  42 import CoreFVs          ( exprSomeFreeVars, ruleSomeLhsFreeVars, ruleSomeFreeVars )
  43 import CoreUnfold       ( okToUnfoldInHiFile, mkTopUnfolding, neverUnfold, unfoldingTemplate, noUnfolding )
  44 import Name             ( isLocallyDefined, getName, nameModule,
  45                           Name, NamedThing(..)
  46                         )
  47 import Name     -- Env
  48 import OccName          ( pprOccName )
  49 import TyCon            ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon,
  50                           tyConTheta, tyConTyVars, tyConDataCons, tyConFamilySize, isClassTyCon
  51                         )
  52 import Class            ( classExtraBigSig, DefMeth(..) )
  53 import FieldLabel       ( fieldLabelType )
  54 import Type             ( splitSigmaTy, tidyTopType, deNoteType )
  55 import SrcLoc           ( noSrcLoc )
  56 import Outputable
  57 import Module           ( ModuleName )
  58
  59 import List             ( partition )
  60 import IO               ( IOMode(..), openFile, hClose )
  61 \end{code}
  62
  63
  64 %************************************************************************
  65 %*                                                                      *
  66 \subsection{Write a new interface file}
  67 %*                                                                      *
  68 %************************************************************************
  69
  70 \begin{code}
  71 mkModDetails :: TypeEnv -> [DFunId]     -- From typechecker
  72              -> [CoreBind] -> [Id]      -- Final bindings, plus the top-level Ids from the
  73                                         -- code generator; they have authoritative arity info
  74              -> [IdCoreRule]            -- Tidy orphan rules
  75              -> ModDetails
  76 mkModDetails type_env dfun_ids tidy_binds stg_ids orphan_rules
  77   = ModDetails { md_types = new_type_env,
  78                  md_rules = rule_dcls,
  79                  md_insts = dfun_ids }
  80   where
  81         -- The competed type environment is gotten from
  82         --      a) keeping the types and classes
  83         --      b) removing all Ids,
  84         --      c) adding Ids with correct IdInfo, including unfoldings,
  85         --              gotten from the bindings
  86         -- From (c) we keep only those Ids with Global names, plus Ids
  87         --          accessible from them (notably via unfoldings)
  88         -- This truncates the type environment to include only the
  89         -- exported Ids and things needed from them, which saves space
  90         --
  91         -- However, we do keep things like constructors, which should not appear
  92         -- in interface files, because they are needed by importing modules when
  93         -- using the compilation manager
  94     new_type_env = mkNameEnv [(getName tycl, tycl) | tycl <- orig_type_env, isTyClThing tycl]
  95                         `plusNameEnv`
  96                    mkNameEnv [(idName id, AnId id) | id <- final_ids]
  97
  98     orig_type_env = nameEnvElts type_env
  99
 100     final_ids = bindsToIds (mkVarSet dfun_ids `unionVarSet` orphan_rule_ids)
 101                            (mkVarSet stg_ids)
 102                            tidy_binds
 103
 104         -- The complete rules are gotten by combining
 105         --      a) the orphan rules
 106         --      b) rules embedded in the top-level Ids
 107     rule_dcls | opt_OmitInterfacePragmas = []
 108               | otherwise                 = getRules orphan_rules tidy_binds (mkVarSet final_ids)
 109
 110     orphan_rule_ids = unionVarSets [ ruleSomeFreeVars interestingId rule
 111                                    | (_, rule) <- orphan_rules]
 112
 113
 114 -- This version is used when we are re-linking a module
 115 -- so we've only run the type checker on its previous interface
 116 mkModDetailsFromIface :: TypeEnv -> [DFunId]    -- From typechecker
 117                       -> [TypecheckedRuleDecl]
 118                       -> ModDetails
 119 mkModDetailsFromIface type_env dfun_ids rules
 120   = ModDetails { md_types = type_env,
 121                  md_rules = rule_dcls,
 122                  md_insts = dfun_ids }
 123   where
 124     rule_dcls = [(id,rule) | IfaceRuleOut id rule <- rules]
 125         -- All the rules from an interface are of the IfaceRuleOut form
 126
 127
 128 completeIface :: Maybe ModIface         -- The old interface, if we have it
 129               -> ModIface               -- The new one, minus the decls and versions
 130               -> ModDetails             -- The ModDetails for this module
 131               -> (ModIface, Maybe SDoc) -- The new one, complete with decls and versions
 132                                         -- The SDoc is a debug document giving differences
 133                                         -- Nothing => no change
 134
 135         -- NB: 'Nothing' means that even the usages havn't changed, so there's no
 136         --     need to write a new interface file.  But even if the usages have
 137         --     changed, the module version may not have.
 138 completeIface maybe_old_iface new_iface mod_details
 139   = addVersionInfo maybe_old_iface (new_iface { mi_decls = new_decls })
 140   where
 141      new_decls   = mkIfaceDecls ty_cls_dcls rule_dcls inst_dcls
 142      inst_dcls   = map ifaceInstance (md_insts mod_details)
 143      ty_cls_dcls = foldNameEnv ifaceTyCls [] (md_types mod_details)
 144      rule_dcls   = map ifaceRule (md_rules mod_details)
 145 \end{code}
 146
 147
 148 %************************************************************************
 149 %*                                                                      *
 150 \subsection{Types and classes}
 151 %*                                                                      *
 152 %************************************************************************
 153
 154 \begin{code}
 155 ifaceTyCls :: TyThing -> [RenamedTyClDecl] -> [RenamedTyClDecl]
 156 ifaceTyCls (AClass clas) so_far
 157   = cls_decl : so_far
 158   where
 159     cls_decl = ClassDecl (toHsContext sc_theta)
 160                          (getName clas)
 161                          (toHsTyVars clas_tyvars)
 162                          (toHsFDs clas_fds)
 163                          (map toClassOpSig op_stuff)
 164                          EmptyMonoBinds
 165                          [] noSrcLoc
 166
 167     (clas_tyvars, clas_fds, sc_theta, _, op_stuff) = classExtraBigSig clas
 168
 169     toClassOpSig (sel_id, def_meth)
 170         = ASSERT(sel_tyvars == clas_tyvars)
 171           ClassOpSig (getName sel_id) (Just def_meth') (toHsType op_ty) noSrcLoc
 172         where
 173           (sel_tyvars, _, op_ty) = splitSigmaTy (idType sel_id)
 174           def_meth' = case def_meth of
 175                          NoDefMeth  -> NoDefMeth
 176                          GenDefMeth -> GenDefMeth
 177                          DefMeth id -> DefMeth (getName id)
 178
 179 ifaceTyCls (ATyCon tycon) so_far
 180   | isClassTyCon tycon = so_far
 181   | otherwise          = ty_decl : so_far
 182   where
 183     ty_decl | isSynTyCon tycon
 184             = TySynonym (getName tycon)(toHsTyVars tyvars)
 185                         (toHsType syn_ty) noSrcLoc
 186
 187             | isAlgTyCon tycon
 188             = TyData new_or_data (toHsContext (tyConTheta tycon))
 189                      (getName tycon)
 190                      (toHsTyVars tyvars)
 191                      (map ifaceConDecl (tyConDataCons tycon))
 192                      (tyConFamilySize tycon)
 193                      Nothing noSrcLoc (panic "gen1") (panic "gen2")
 194
 195             | otherwise = pprPanic "ifaceTyCls" (ppr tycon)
 196
 197     tyvars      = tyConTyVars tycon
 198     (_, syn_ty) = getSynTyConDefn tycon
 199     new_or_data | isNewTyCon tycon = NewType
 200                 | otherwise        = DataType
 201
 202     ifaceConDecl data_con
 203         = ConDecl (getName data_con) (error "ifaceConDecl")
 204                   (toHsTyVars ex_tyvars)
 205                   (toHsContext ex_theta)
 206                   details noSrcLoc
 207         where
 208           (tyvars1, _, ex_tyvars, ex_theta, arg_tys, tycon1) = dataConSig data_con
 209           field_labels   = dataConFieldLabels data_con
 210           strict_marks   = dataConStrictMarks data_con
 211           details | null field_labels
 212                   = ASSERT( tycon == tycon1 && tyvars == tyvars1 )
 213                     VanillaCon (zipWith mk_bang_ty strict_marks arg_tys)
 214
 215                   | otherwise
 216                   = RecCon (zipWith mk_field strict_marks field_labels)
 217
 218     mk_bang_ty NotMarkedStrict     ty = Unbanged (toHsType ty)
 219     mk_bang_ty (MarkedUnboxed _ _) ty = Unpacked (toHsType ty)
 220     mk_bang_ty MarkedStrict        ty = Banged   (toHsType ty)
 221
 222     mk_field strict_mark field_label
 223         = ([getName field_label], mk_bang_ty strict_mark (fieldLabelType field_label))
 224
 225 ifaceTyCls (AnId id) so_far
 226   | omitIfaceSigForId id = so_far
 227   | otherwise            = iface_sig : so_far
 228   where
 229     iface_sig = IfaceSig (getName id) (toHsType id_type) hs_idinfo noSrcLoc
 230
 231     id_type = idType id
 232     id_info = idInfo id
 233
 234     hs_idinfo | opt_OmitInterfacePragmas = []
 235               | otherwise                = arity_hsinfo  ++ caf_hsinfo  ++ cpr_hsinfo ++
 236                                            strict_hsinfo ++ wrkr_hsinfo ++ unfold_hsinfo
 237
 238     ------------  Arity  --------------
 239     arity_hsinfo = case arityInfo id_info of
 240                         a@(ArityExactly n) -> [HsArity a]
 241                         other              -> []
 242
 243     ------------ Caf Info --------------
 244     caf_hsinfo = case cafInfo id_info of
 245                    NoCafRefs -> [HsNoCafRefs]
 246                    otherwise -> []
 247
 248     ------------ CPR Info --------------
 249     cpr_hsinfo = case cprInfo id_info of
 250                    ReturnsCPR -> [HsCprInfo]
 251                    NoCPRInfo  -> []
 252
 253     ------------  Strictness  --------------
 254     strict_hsinfo = case strictnessInfo id_info of
 255                         NoStrictnessInfo -> []
 256                         info             -> [HsStrictness info]
 257
 258
 259     ------------  Worker  --------------
 260     wrkr_hsinfo = case workerInfo id_info of
 261                     HasWorker work_id wrap_arity -> [HsWorker (getName work_id)]
 262                     NoWorker                     -> []
 263
 264     ------------  Unfolding  --------------
 265     unfold_info = unfoldingInfo id_info
 266     inline_prag = inlinePragInfo id_info
 267     rhs         = unfoldingTemplate unfold_info
 268     unfold_hsinfo | neverUnfold unfold_info = []
 269                   | otherwise               = [HsUnfold inline_prag (toUfExpr rhs)]
 270 \end{code}
 271
 272
 273 %************************************************************************
 274 %*                                                                      *
 275 \subsection{Instances and rules}
 276 %*                                                                      *
 277 %************************************************************************
 278
 279 \begin{code}
 280 ifaceInstance :: DFunId -> RenamedInstDecl
 281 ifaceInstance dfun_id
 282   = InstDecl (toHsType tidy_ty) EmptyMonoBinds [] (Just (getName dfun_id)) noSrcLoc
 283   where
 284     tidy_ty = tidyTopType (deNoteType (idType dfun_id))
 285                 -- The deNoteType is very important.   It removes all type
 286                 -- synonyms from the instance type in interface files.
 287                 -- That in turn makes sure that when reading in instance decls
 288                 -- from interface files that the 'gating' mechanism works properly.
 289                 -- Otherwise you could have
 290                 --      type Tibble = T Int
 291                 --      instance Foo Tibble where ...
 292                 -- and this instance decl wouldn't get imported into a module
 293                 -- that mentioned T but not Tibble.
 294
 295 ifaceRule (id, BuiltinRule _)
 296   = pprTrace "toHsRule: builtin" (ppr id) (bogusIfaceRule id)
 297
 298 ifaceRule (id, Rule name bndrs args rhs)
 299   = IfaceRule name (map toUfBndr bndrs) (getName id)
 300               (map toUfExpr args) (toUfExpr rhs) noSrcLoc
 301
 302 bogusIfaceRule id
 303   = IfaceRule SLIT("bogus") [] (getName id) [] (UfVar (getName id)) noSrcLoc
 304 \end{code}
 305
 306
 307 %************************************************************************
 308 %*                                                                      *
 309 \subsection{Compute final Ids}
 310 %*                                                                      *
 311 %************************************************************************
 312
 313 A "final Id" has exactly the IdInfo for going into an interface file, or
 314 exporting to another module.
 315
 316 \begin{code}
 317 bindsToIds :: IdSet             -- These Ids are needed already
 318            -> IdSet             -- Ids used at code-gen time; they have better pragma info!
 319            -> [CoreBind]        -- In dependency order, later depend on earlier
 320            -> [Id]              -- Set of Ids actually spat out, complete with exactly the IdInfo
 321                                 -- they need for exporting to another module
 322
 323 bindsToIds needed_ids codegen_ids binds
 324   = go needed_ids (reverse binds) []
 325                 -- Reverse so that later things will
 326                 -- provoke earlier ones to be emitted
 327   where
 328         -- The 'needed' set contains the Ids that are needed by earlier
 329         -- interface file emissions.  If the Id isn't in this set, and isn't
 330         -- exported, there's no need to emit anything
 331     need_id needed_set id = id `elemVarSet` needed_set || isUserExportedId id
 332
 333     go needed [] emitted
 334         | not (isEmptyVarSet needed) = pprTrace "ifaceBinds: free vars:"
 335                                           (sep (map ppr (varSetElems needed)))
 336                                        emitted
 337         | otherwise                  = emitted
 338
 339     go needed (NonRec id rhs : binds) emitted
 340         | need_id needed id = go new_needed binds (new_id:emitted)
 341         | otherwise         = go needed     binds emitted
 342         where
 343           (new_id, extras) = mkFinalId codegen_ids False id rhs
 344           new_needed       = (needed `unionVarSet` extras) `delVarSet` id
 345
 346         -- Recursive groups are a bit more of a pain.  We may only need one to
 347         -- start with, but it may call out the next one, and so on.  So we
 348         -- have to look for a fixed point.  We don't want necessarily them all,
 349         -- because without -O we may only need the first one (if we don't emit
 350         -- its unfolding)
 351     go needed (Rec pairs : binds) emitted
 352         = go needed' binds emitted'
 353         where
 354           (new_emitted, extras) = go_rec needed pairs
 355           needed'  = (needed `unionVarSet` extras) `minusVarSet` mkVarSet (map fst pairs)
 356           emitted' = new_emitted ++ emitted
 357
 358     go_rec :: IdSet -> [(Id,CoreExpr)] -> ([Id], IdSet)
 359     go_rec needed pairs
 360         | null needed_prs = ([], emptyVarSet)
 361         | otherwise       = (emitted ++           more_emitted,
 362                              extras `unionVarSet` more_extras)
 363         where
 364           (needed_prs,leftover_prs)   = partition is_needed pairs
 365           (emitted, extras_s)         = unzip [ mkFinalId codegen_ids True id rhs
 366                                               | (id,rhs) <- needed_prs, not (omitIfaceSigForId id)]
 367           extras                      = unionVarSets extras_s
 368           (more_emitted, more_extras) = go_rec extras leftover_prs
 369
 370           is_needed (id,_) = need_id needed id
 371 \end{code}
 372
 373
 374
 375 \begin{code}
 376 mkFinalId :: IdSet              -- The Ids with arity info from the code generator
 377           -> Bool               -- True <=> recursive, so don't include unfolding
 378           -> Id
 379           -> CoreExpr           -- The Id's right hand side
 380           -> (Id, IdSet)        -- The emitted id, plus any *extra* needed Ids
 381
 382 mkFinalId codegen_ids is_rec id rhs
 383   | omitIfaceSigForId id
 384   = (id, emptyVarSet)           -- An optimisation for top-level constructors and suchlike
 385   | otherwise
 386   = (id `setIdInfo` new_idinfo, new_needed_ids)
 387   where
 388     core_idinfo = idInfo id
 389     stg_idinfo  = case lookupVarSet codegen_ids id of
 390                         Just id' -> idInfo id'
 391                         Nothing  -> pprTrace "ifaceBinds not found:" (ppr id) $
 392                                     idInfo id
 393
 394     new_idinfo | opt_OmitInterfacePragmas
 395                = vanillaIdInfo
 396                | otherwise
 397                = core_idinfo `setArityInfo`      arity_info
 398                              `setCafInfo`        cafInfo stg_idinfo
 399                              `setUnfoldingInfo`  unfold_info
 400                              `setWorkerInfo`     worker_info
 401                              `setSpecInfo`       emptyCoreRules
 402         -- We zap the specialisations because they are
 403         -- passed on separately through the modules IdCoreRules
 404
 405     ------------  Arity  --------------
 406     arity_info = arityInfo stg_idinfo
 407     stg_arity  = arityLowerBound arity_info
 408
 409     ------------  Worker  --------------
 410         -- We only treat a function as having a worker if
 411         -- the exported arity (which is now the number of visible lambdas)
 412         -- is the same as the arity at the moment of the w/w split
 413         -- If so, we can safely omit the unfolding inside the wrapper, and
 414         -- instead re-generate it from the type/arity/strictness info
 415         -- But if the arity has changed, we just take the simple path and
 416         -- put the unfolding into the interface file, forgetting the fact
 417         -- that it's a wrapper.
 418         --
 419         -- How can this happen?  Sometimes we get
 420         --      f = coerce t (\x y -> $wf x y)
 421         -- at the moment of w/w split; but the eta reducer turns it into
 422         --      f = coerce t $wf
 423         -- which is perfectly fine except that the exposed arity so far as
 424         -- the code generator is concerned (zero) differs from the arity
 425         -- when we did the split (2).
 426         --
 427         -- All this arises because we use 'arity' to mean "exactly how many
 428         -- top level lambdas are there" in interface files; but during the
 429         -- compilation of this module it means "how many things can I apply
 430         -- this to".
 431     worker_info = case workerInfo core_idinfo of
 432                      info@(HasWorker work_id wrap_arity)
 433                         | wrap_arity == stg_arity -> info
 434                         | otherwise               -> pprTrace "ifaceId: arity change:" (ppr id)
 435                                                      NoWorker
 436                      NoWorker                     -> NoWorker
 437
 438     has_worker = case worker_info of
 439                    HasWorker _ _ -> True
 440                    other         -> False
 441
 442     HasWorker work_id _ = worker_info
 443
 444     ------------  Unfolding  --------------
 445     inline_pragma  = inlinePragInfo core_idinfo
 446     dont_inline    = isNeverInlinePrag inline_pragma
 447     loop_breaker   = isLoopBreaker (occInfo core_idinfo)
 448     bottoming_fn   = isBottomingStrictness (strictnessInfo core_idinfo)
 449
 450     unfolding    = mkTopUnfolding rhs
 451     rhs_is_small = not (neverUnfold unfolding)
 452
 453     unfold_info | show_unfold = unfolding
 454                 | otherwise   = noUnfolding
 455
 456     show_unfold = not has_worker         &&     -- Not unnecessary
 457                   not bottoming_fn       &&     -- Not necessary
 458                   not dont_inline        &&
 459                   not loop_breaker       &&
 460                   rhs_is_small           &&     -- Small enough
 461                   okToUnfoldInHiFile rhs        -- No casms etc
 462
 463
 464     ------------  Extra free Ids  --------------
 465     new_needed_ids | opt_OmitInterfacePragmas = emptyVarSet
 466                    | otherwise                = worker_ids      `unionVarSet`
 467                                                 unfold_ids      `unionVarSet`
 468                                                 spec_ids
 469
 470     spec_ids = filterVarSet interestingId (rulesRhsFreeVars (specInfo core_idinfo))
 471
 472     worker_ids | has_worker && interestingId work_id = unitVarSet work_id
 473                         -- Conceivably, the worker might come from
 474                         -- another module
 475                | otherwise = emptyVarSet
 476
 477     unfold_ids | show_unfold = find_fvs rhs
 478                | otherwise   = emptyVarSet
 479
 480     find_fvs expr = exprSomeFreeVars interestingId expr
 481
 482 interestingId id = isId id && isLocallyDefined id && not (hasNoBinding id)
 483 \end{code}
 484
 485
 486 \begin{code}
 487 getRules :: [IdCoreRule]        -- Orphan rules
 488          -> [CoreBind]          -- Bindings, with rules in the top-level Ids
 489          -> IdSet               -- Ids that are exported, so we need their rules
 490          -> [IdCoreRule]
 491 getRules orphan_rules binds emitted
 492   = orphan_rules ++ local_rules
 493   where
 494     local_rules  = [ (fn, rule)
 495                    | fn <- bindersOfBinds binds,
 496                      fn `elemVarSet` emitted,
 497                      rule <- rulesRules (idSpecialisation fn),
 498                      not (isBuiltinRule rule),
 499                                 -- We can't print builtin rules in interface files
 500                                 -- Since they are built in, an importing module
 501                                 -- will have access to them anyway
 502
 503                         -- Sept 00: I've disabled this test.  It doesn't stop many, if any, rules
 504                         -- from coming out, and to make it work properly we need to add ????
 505                         --      (put it back in for now)
 506                      all (`elemVarSet` emitted) (varSetElems (ruleSomeLhsFreeVars interestingId rule))
 507                                 -- Spit out a rule only if all its lhs free vars are emitted
 508                                 -- This is a good reason not to do it when we emit the Id itself
 509                    ]
 510 \end{code}
 511
 512
 513 %************************************************************************
 514 %*                                                                      *
 515 \subsection{Checking if the new interface is up to date
 516 %*                                                                      *
 517 %************************************************************************
 518
 519 \begin{code}
 520 addVersionInfo :: Maybe ModIface                -- The old interface, read from M.hi
 521                -> ModIface                      -- The new interface decls
 522                -> (ModIface, Maybe SDoc)        -- Nothing => no change; no need to write new Iface
 523                                                 -- Just mi => Here is the new interface to write
 524                                                 --            with correct version numbers
 525
 526 -- NB: the fixities, declarations, rules are all assumed
 527 -- to be sorted by increasing order of hsDeclName, so that
 528 -- we can compare for equality
 529
 530 addVersionInfo Nothing new_iface
 531 -- No old interface, so definitely write a new one!
 532   = (new_iface, Just (text "No old interface available"))
 533
 534 addVersionInfo (Just old_iface@(ModIface { mi_version = old_version,
 535                                            mi_decls   = old_decls,
 536                                            mi_fixities = old_fixities }))
 537                new_iface@(ModIface { mi_decls = new_decls,
 538                                      mi_fixities = new_fixities })
 539
 540   | no_output_change && no_usage_change
 541   = (old_iface, Nothing)
 542
 543   | otherwise           -- Add updated version numbers
 544   = (final_iface, Just pp_tc_diffs)
 545
 546   where
 547     final_iface = new_iface { mi_version = new_version }
 548     new_version = VersionInfo { vers_module  = bumpVersion no_output_change (vers_module  old_version),
 549                                 vers_exports = bumpVersion no_export_change (vers_exports old_version),
 550                                 vers_rules   = bumpVersion no_rule_change   (vers_rules   old_version),
 551                                 vers_decls   = tc_vers }
 552
 553     no_output_change = no_tc_change && no_rule_change && no_export_change
 554     no_usage_change  = mi_usages old_iface == mi_usages new_iface
 555
 556     no_export_change = mi_exports old_iface == mi_exports new_iface             -- Kept sorted
 557     no_rule_change   = dcl_rules old_decls  == dcl_rules  new_decls             -- Ditto
 558
 559         -- Fill in the version number on the new declarations by looking at the old declarations.
 560         -- Set the flag if anything changes.
 561         -- Assumes that the decls are sorted by hsDeclName.
 562     old_vers_decls = vers_decls old_version
 563     (no_tc_change,  pp_tc_diffs,  tc_vers) = diffDecls old_vers_decls old_fixities new_fixities
 564                                                        (dcl_tycl old_decls) (dcl_tycl new_decls)
 565
 566
 567
 568 diffDecls :: NameEnv Version                            -- Old version map
 569           -> NameEnv Fixity -> NameEnv Fixity           -- Old and new fixities
 570           -> [RenamedTyClDecl] -> [RenamedTyClDecl]     -- Old and new decls
 571           -> (Bool,             -- True <=> no change
 572               SDoc,             -- Record of differences
 573               NameEnv Version)  -- New version
 574
 575 diffDecls old_vers old_fixities new_fixities old new
 576   = diff True empty emptyNameEnv old new
 577   where
 578         -- When seeing if two decls are the same,
 579         -- remember to check whether any relevant fixity has changed
 580     eq_tc  d1 d2 = d1 == d2 && all (same_fixity . fst) (tyClDeclNames d1)
 581     same_fixity n = lookupNameEnv old_fixities n == lookupNameEnv new_fixities n
 582
 583     diff ok_so_far pp new_vers []  []      = (ok_so_far, pp, new_vers)
 584     diff ok_so_far pp new_vers old []      = (False,     pp, new_vers)
 585     diff ok_so_far pp new_vers [] (nd:nds) = diff False (pp $$ only_new nd) new_vers [] nds
 586     diff ok_so_far pp new_vers (od:ods) (nd:nds)
 587         = case nameOccName od_name `compare` nameOccName nd_name of
 588                 LT -> diff False (pp $$ only_old od) new_vers ods      (nd:nds)
 589                 GT -> diff False (pp $$ only_new nd) new_vers (od:ods) nds
 590                 EQ | od `eq_tc` nd -> diff ok_so_far pp                    new_vers  ods nds
 591                    | otherwise     -> diff False     (pp $$ changed od nd) new_vers' ods nds
 592         where
 593           od_name = tyClDeclName od
 594           nd_name = tyClDeclName nd
 595           new_vers' = extendNameEnv new_vers nd_name
 596                                     (bumpVersion True (lookupNameEnv_NF old_vers od_name))
 597
 598     only_old d   = ptext SLIT("Only in old iface:") <+> ppr d
 599     only_new d   = ptext SLIT("Only in new iface:") <+> ppr d
 600     changed d nd = ptext SLIT("Changed in iface: ") <+> ((ptext SLIT("Old:") <+> ppr d) $$
 601                                                          (ptext SLIT("New:") <+> ppr nd))
 602 \end{code}
 603
 604
 605
 606 %************************************************************************
 607 %*                                                                      *
 608 \subsection{Writing an interface file}
 609 %*                                                                      *
 610 %************************************************************************
 611
 612 \begin{code}
 613 writeIface :: FilePath -> ModIface -> IO ()
 614 writeIface hi_path mod_iface
 615   = do  { if_hdl <- openFile hi_path WriteMode
 616         ; printForIface if_hdl from_this_mod (pprIface mod_iface)
 617         ; hClose if_hdl
 618         }
 619   where
 620         -- Print names unqualified if they are from this module
 621     from_this_mod n = nameModule n == this_mod
 622     this_mod = mi_module mod_iface
 623
 624 pprIface :: ModIface -> SDoc
 625 pprIface iface
 626  = vcat [ ptext SLIT("__interface")
 627                 <+> doubleQuotes (ptext opt_InPackage)
 628                 <+> ppr (mi_module iface) <+> ppr (vers_module version_info)
 629                 <+> pp_sub_vers
 630                 <+> (if mi_orphan iface then char '!' else empty)
 631                 <+> int opt_HiVersion
 632                 <+> ptext SLIT("where")
 633
 634         , vcat (map pprExport (mi_exports iface))
 635         , vcat (map pprUsage (mi_usages iface))
 636
 637         , pprFixities (mi_fixities iface) (dcl_tycl decls)
 638         , pprIfaceDecls (vers_decls version_info) decls
 639         , pprDeprecs (mi_deprecs iface)
 640         ]
 641   where
 642     version_info = mi_version iface
 643     decls        = mi_decls iface
 644     exp_vers     = vers_exports version_info
 645     rule_vers    = vers_rules version_info
 646
 647     pp_sub_vers | exp_vers == initialVersion && rule_vers == initialVersion = empty
 648                 | otherwise = brackets (ppr exp_vers <+> ppr rule_vers)
 649 \end{code}
 650
 651 When printing export lists, we print like this:
 652         Avail   f               f
 653         AvailTC C [C, x, y]     C(x,y)
 654         AvailTC C [x, y]        C!(x,y)         -- Exporting x, y but not C
 655
 656 \begin{code}
 657 pprExport :: (ModuleName, Avails) -> SDoc
 658 pprExport (mod, items)
 659  = hsep [ ptext SLIT("__export "), ppr mod, hsep (map pp_avail items) ] <> semi
 660   where
 661     pp_avail :: AvailInfo -> SDoc
 662     pp_avail (Avail name)                    = pprOcc name
 663     pp_avail (AvailTC n [])                  = empty
 664     pp_avail (AvailTC n (n':ns)) | n==n'     = pprOcc n             <> pp_export ns
 665                                  | otherwise = pprOcc n <> char '|' <> pp_export (n':ns)
 666
 667     pp_export []    = empty
 668     pp_export names = braces (hsep (map pprOcc names))
 669
 670 pprOcc :: Name -> SDoc  -- Print the occurrence name only
 671 pprOcc n = pprOccName (nameOccName n)
 672 \end{code}
 673
 674
 675 \begin{code}
 676 pprUsage :: ImportVersion Name -> SDoc
 677 pprUsage (m, has_orphans, is_boot, whats_imported)
 678   = hsep [ptext SLIT("import"), ppr m,
 679           pp_orphan, pp_boot,
 680           pp_versions whats_imported
 681     ] <> semi
 682   where
 683     pp_orphan | has_orphans = char '!'
 684               | otherwise   = empty
 685     pp_boot   | is_boot     = char '@'
 686               | otherwise   = empty
 687
 688         -- Importing the whole module is indicated by an empty list
 689     pp_versions NothingAtAll                = empty
 690     pp_versions (Everything v)              = dcolon <+> int v
 691     pp_versions (Specifically vm ve nvs vr) = dcolon <+> int vm <+> pp_export_version ve <+> int vr
 692                                               <+> hsep [ pprOcc n <+> int v | (n,v) <- nvs ]
 693
 694         -- HACK for the moment: print the export-list version even if
 695         -- we don't use it, so that syntax of interface files doesn't change
 696     pp_export_version Nothing  = int 1
 697     pp_export_version (Just v) = int v
 698 \end{code}
 699
 700 \begin{code}
 701 pprIfaceDecls version_map decls
 702   = vcat [ vcat [ppr i <+> semi | i <- dcl_insts decls]
 703          , vcat (map ppr_decl (dcl_tycl decls))
 704          , pprRules (dcl_rules decls)
 705          ]
 706   where
 707     ppr_decl d  = ppr_vers d <+> ppr d <> semi
 708
 709         -- Print the version for the decl
 710     ppr_vers d = case lookupNameEnv version_map (tyClDeclName d) of
 711                    Nothing -> empty
 712                    Just v  -> int v
 713 \end{code}
 714
 715 \begin{code}
 716 pprFixities fixity_map decls
 717   = hsep [ ppr fix <+> ppr n
 718          | d <- decls,
 719            (n,_) <- tyClDeclNames d,
 720            Just fix <- [lookupNameEnv fixity_map n]] <> semi
 721
 722 pprRules []    = empty
 723 pprRules rules = hsep [ptext SLIT("{-## __R"), vcat (map ppr rules), ptext SLIT("##-}")]
 724
 725 pprDeprecs NoDeprecs = empty
 726 pprDeprecs deprecs   = ptext SLIT("{-## __D") <+> guts <+> ptext SLIT("##-}")
 727                      where
 728                        guts = case deprecs of
 729                                 DeprecAll txt  -> ptext txt
 730                                 DeprecSome env -> pp_deprecs env
 731
 732 pp_deprecs env = vcat (punctuate semi (map pp_deprec (nameEnvElts env)))
 733                where
 734                  pp_deprec (name, txt) = pprOcc name <+> ptext txt
 735 \end{code}