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