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