compiler/iface/MkIface.lhs

   1 %
   2 % (c) The University of Glasgow 2006
   3 % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
   4 %
   5
   6 \begin{code}
   7 module MkIface (
   8         mkUsageInfo,    -- Construct the usage info for a module
   9
  10         mkIface,        -- Build a ModIface from a ModGuts,
  11                         -- including computing version information
  12
  13         writeIfaceFile, -- Write the interface file
  14
  15         checkOldIface,  -- See if recompilation is required, by
  16                         -- comparing version information
  17
  18         tyThingToIfaceDecl -- Converting things to their Iface equivalents
  19  ) where
  20 \end{code}
  21
  22         -----------------------------------------------
  23                 MkIface.lhs deals with versioning
  24         -----------------------------------------------
  25
  26 Here's the version-related info in an interface file
  27
  28   module Foo 8          -- module-version
  29              3          -- export-list-version
  30              2          -- rule-version
  31     Usages:     -- Version info for what this compilation of Foo imported
  32         Baz 3           -- Module version
  33             [4]         -- The export-list version if Foo depended on it
  34             (g,2)       -- Function and its version
  35             (T,1)       -- Type and its version
  36
  37     <version> f :: Int -> Int {- Unfolding: \x -> Wib.t[2] x -}
  38                 -- The [2] says that f's unfolding
  39                 -- mentions verison 2 of Wib.t
  40
  41         -----------------------------------------------
  42                         Basic idea
  43         -----------------------------------------------
  44
  45 Basic idea:
  46   * In the mi_usages information in an interface, we record the
  47     version number of each free variable of the module
  48
  49   * In mkIface, we compute the version number of each exported thing A.f
  50     by comparing its A.f's info with its new info, and bumping its
  51     version number if it differs.  If A.f mentions B.g, and B.g's version
  52     number has changed, then we count A.f as having changed too.
  53
  54   * In checkOldIface we compare the mi_usages for the module with
  55     the actual version info for all each thing recorded in mi_usages
  56
  57
  58 Fixities
  59 ~~~~~~~~
  60 We count A.f as changing if its fixity changes
  61
  62 Rules
  63 ~~~~~
  64 If a rule changes, we want to recompile any module that might be
  65 affected by that rule.  For non-orphan rules, this is relatively easy.
  66 If module M defines f, and a rule for f, just arrange that the version
  67 number for M.f changes if any of the rules for M.f change.  Any module
  68 that does not depend on M.f can't be affected by the rule-change
  69 either.
  70
  71 Orphan rules (ones whose 'head function' is not defined in M) are
  72 harder.  Here's what we do.
  73
  74   * We have a per-module orphan-rule version number which changes if
  75     any orphan rule changes. (It's unaffected by non-orphan rules.)
  76
  77   * We record usage info for any orphan module 'below' this one,
  78     giving the orphan-rule version number.  We recompile if this
  79     changes.
  80
  81 The net effect is that if an orphan rule changes, we recompile every
  82 module above it.  That's very conservative, but it's devilishly hard
  83 to know what it might affect, so we just have to be conservative.
  84
  85 Instance decls
  86 ~~~~~~~~~~~~~~
  87 In an iface file we have
  88      module A where
  89         instance Eq a => Eq [a]  =  dfun29
  90         dfun29 :: ...
  91
  92 We have a version number for dfun29, covering its unfolding
  93 etc. Suppose we are compiling a module M that imports A only
  94 indirectly.  If typechecking M uses this instance decl, we record the
  95 dependency on A.dfun29 as if it were a free variable of the module
  96 (via the tcg_inst_usages accumulator).  That means that A will appear
  97 in M's usage list.  If the shape of the instance declaration changes,
  98 then so will dfun29's version, triggering a recompilation.
  99
 100 Adding an instance declaration, or changing an instance decl that is
 101 not currently used, is more tricky.  (This really only makes a
 102 difference when we have overlapping instance decls, because then the
 103 new instance decl might kick in to override the old one.)  We handle
 104 this in a very similar way that we handle rules above.
 105
 106   * For non-orphan instance decls, identify one locally-defined tycon/class
 107     mentioned in the decl.  Treat the instance decl as part of the defn of that
 108     tycon/class, so that if the shape of the instance decl changes, so does the
 109     tycon/class; that in turn will force recompilation of anything that uses
 110     that tycon/class.
 111
 112   * For orphan instance decls, act the same way as for orphan rules.
 113     Indeed, we use the same global orphan-rule version number.
 114
 115 mkUsageInfo
 116 ~~~~~~~~~~~
 117 mkUsageInfo figures out what the ``usage information'' for this
 118 moudule is; that is, what it must record in its interface file as the
 119 things it uses.
 120
 121 We produce a line for every module B below the module, A, currently being
 122 compiled:
 123         import B <n> ;
 124 to record the fact that A does import B indirectly.  This is used to decide
 125 to look to look for B.hi rather than B.hi-boot when compiling a module that
 126 imports A.  This line says that A imports B, but uses nothing in it.
 127 So we'll get an early bale-out when compiling A if B's version changes.
 128
 129 The usage information records:
 130
 131 \begin{itemize}
 132 \item   (a) anything reachable from its body code
 133 \item   (b) any module exported with a @module Foo@
 134 \item   (c) anything reachable from an exported item
 135 \end{itemize}
 136
 137 Why (b)?  Because if @Foo@ changes then this module's export list
 138 will change, so we must recompile this module at least as far as
 139 making a new interface file --- but in practice that means complete
 140 recompilation.
 141
 142 Why (c)?  Consider this:
 143 \begin{verbatim}
 144         module A( f, g ) where  |       module B( f ) where
 145           import B( f )         |         f = h 3
 146           g = ...               |         h = ...
 147 \end{verbatim}
 148
 149 Here, @B.f@ isn't used in A.  Should we nevertheless record @B.f@ in
 150 @A@'s usages?  Our idea is that we aren't going to touch A.hi if it is
 151 *identical* to what it was before.  If anything about @B.f@ changes
 152 than anyone who imports @A@ should be recompiled in case they use
 153 @B.f@ (they'll get an early exit if they don't).  So, if anything
 154 about @B.f@ changes we'd better make sure that something in A.hi
 155 changes, and the convenient way to do that is to record the version
 156 number @B.f@ in A.hi in the usage list.  If B.f changes that'll force a
 157 complete recompiation of A, which is overkill but it's the only way to
 158 write a new, slightly different, A.hi.
 159
 160 But the example is tricker.  Even if @B.f@ doesn't change at all,
 161 @B.h@ may do so, and this change may not be reflected in @f@'s version
 162 number.  But with -O, a module that imports A must be recompiled if
 163 @B.h@ changes!  So A must record a dependency on @B.h@.  So we treat
 164 the occurrence of @B.f@ in the export list *just as if* it were in the
 165 code of A, and thereby haul in all the stuff reachable from it.
 166
 167         *** Conclusion: if A mentions B.f in its export list,
 168             behave just as if A mentioned B.f in its source code,
 169             and slurp in B.f and all its transitive closure ***
 170
 171 [NB: If B was compiled with -O, but A isn't, we should really *still*
 172 haul in all the unfoldings for B, in case the module that imports A *is*
 173 compiled with -O.  I think this is the case.]
 174
 175
 176 \begin{code}
 177 #include "HsVersions.h"
 178
 179 import IfaceSyn
 180 import IfaceType
 181 import LoadIface
 182 import Id
 183 import IdInfo
 184 import NewDemand
 185 import CoreSyn
 186 import Class
 187 import TyCon
 188 import DataCon
 189 import Type
 190 import TcType
 191 import InstEnv
 192 import FamInstEnv
 193 import TcRnMonad
 194 import HscTypes
 195
 196 import DynFlags
 197 import Name
 198 import NameEnv
 199 import NameSet
 200 import OccName
 201 import Module
 202 import BinIface
 203 import Unique
 204 import ErrUtils
 205 import Digraph
 206 import SrcLoc
 207 import PackageConfig    hiding ( Version )
 208 import Outputable
 209 import BasicTypes       hiding ( SuccessFlag(..) )
 210 import UniqFM
 211 import Util             hiding ( eqListBy )
 212 import FiniteMap
 213 import FastString
 214 import Maybes
 215
 216 import Control.Monad
 217 import Data.List
 218 \end{code}
 219
 220
 221
 222 %************************************************************************
 223 %*                                                                      *
 224 \subsection{Completing an interface}
 225 %*                                                                      *
 226 %************************************************************************
 227
 228 \begin{code}
 229 mkIface :: HscEnv
 230         -> Maybe ModIface       -- The old interface, if we have it
 231         -> ModGuts              -- Usages, deprecations, etc
 232         -> ModDetails           -- The trimmed, tidied interface
 233         -> IO (ModIface,        -- The new one, complete with decls and versions
 234                Bool)            -- True <=> there was an old Iface, and the new one
 235                                 --          is identical, so no need to write it
 236
 237 mkIface hsc_env maybe_old_iface
 238         (ModGuts{     mg_module    = this_mod,
 239                       mg_boot      = is_boot,
 240                       mg_usages    = usages,
 241                       mg_deps      = deps,
 242                       mg_rdr_env   = rdr_env,
 243                       mg_fix_env   = fix_env,
 244                       mg_deprecs   = src_deprecs })
 245         (ModDetails{  md_insts     = insts,
 246                       md_fam_insts = fam_insts,
 247                       md_rules     = rules,
 248                       md_types     = type_env,
 249                       md_exports   = exports })
 250
 251 -- NB:  notice that mkIface does not look at the bindings
 252 --      only at the TypeEnv.  The previous Tidy phase has
 253 --      put exactly the info into the TypeEnv that we want
 254 --      to expose in the interface
 255
 256   = do  { eps <- hscEPS hsc_env
 257         ; let   { entities = typeEnvElts type_env ;
 258                   decls  = [ tyThingToIfaceDecl entity
 259                            | entity <- entities,
 260                              let name = getName entity,
 261                              not (isImplicitTyThing entity),
 262                                 -- No implicit Ids and class tycons in the interface file
 263                              not (isWiredInName name),
 264                                 -- Nor wired-in things; the compiler knows about them anyhow
 265                              nameIsLocalOrFrom this_mod name  ]
 266                                 -- Sigh: see Note [Root-main Id] in TcRnDriver
 267
 268                 ; fixities    = [(occ,fix) | FixItem occ fix _ <- nameEnvElts fix_env]
 269                 ; deprecs     = mkIfaceDeprec src_deprecs
 270                 ; iface_rules = map coreRuleToIfaceRule rules
 271                 ; iface_insts = map instanceToIfaceInst insts
 272                 ; iface_fam_insts = map famInstToIfaceFamInst fam_insts
 273
 274                 ; intermediate_iface = ModIface {
 275                         mi_module   = this_mod,
 276                         mi_boot     = is_boot,
 277                         mi_deps     = deps,
 278                         mi_usages   = usages,
 279                         mi_exports  = mkIfaceExports exports,
 280
 281                         -- Sort these lexicographically, so that
 282                         -- the result is stable across compilations
 283                         mi_insts    = sortLe le_inst iface_insts,
 284                         mi_fam_insts= sortLe le_fam_inst iface_fam_insts,
 285                         mi_rules    = sortLe le_rule iface_rules,
 286
 287                         mi_fixities = fixities,
 288                         mi_deprecs  = deprecs,
 289                         mi_globals  = Just rdr_env,
 290
 291                         -- Left out deliberately: filled in by addVersionInfo
 292                         mi_mod_vers  = initialVersion,
 293                         mi_exp_vers  = initialVersion,
 294                         mi_rule_vers = initialVersion,
 295                         mi_orphan    = False,   -- Always set by addVersionInfo, but
 296                                                 -- it's a strict field, so we can't omit it.
 297                         mi_finsts    = False,   -- Ditto
 298                         mi_decls     = deliberatelyOmitted "decls",
 299                         mi_ver_fn    = deliberatelyOmitted "ver_fn",
 300
 301                         -- And build the cached values
 302                         mi_dep_fn = mkIfaceDepCache deprecs,
 303                         mi_fix_fn = mkIfaceFixCache fixities }
 304
 305                 -- Add version information
 306                 ; ext_ver_fn = mkParentVerFun hsc_env eps
 307                 ; (new_iface, no_change_at_all, pp_diffs, pp_orphs)
 308                         = _scc_ "versioninfo"
 309                          addVersionInfo ext_ver_fn maybe_old_iface
 310                                          intermediate_iface decls
 311                 }
 312
 313                 -- Debug printing
 314         ; when (isJust pp_orphs && dopt Opt_WarnOrphans dflags)
 315                (printDump (expectJust "mkIface" pp_orphs))
 316         ; when (dopt Opt_D_dump_hi_diffs dflags) (printDump pp_diffs)
 317         ; dumpIfSet_dyn dflags Opt_D_dump_hi "FINAL INTERFACE"
 318                         (pprModIface new_iface)
 319
 320         ; return (new_iface, no_change_at_all) }
 321   where
 322      r1 `le_rule`     r2 = ifRuleName      r1    <=    ifRuleName      r2
 323      i1 `le_inst`     i2 = ifDFun          i1 `le_occ` ifDFun          i2
 324      i1 `le_fam_inst` i2 = ifFamInstTcName i1 `le_occ` ifFamInstTcName i2
 325
 326      le_occ :: Name -> Name -> Bool
 327         -- Compare lexicographically by OccName, *not* by unique, because
 328         -- the latter is not stable across compilations
 329      le_occ n1 n2 = nameOccName n1 <= nameOccName n2
 330
 331      dflags = hsc_dflags hsc_env
 332      deliberatelyOmitted x = panic ("Deliberately omitted: " ++ x)
 333      ifFamInstTcName = ifaceTyConName . ifFamInstTyCon
 334
 335
 336 -----------------------------
 337 writeIfaceFile :: DynFlags -> ModLocation -> ModIface -> IO ()
 338 writeIfaceFile dflags location new_iface
 339     = do createDirectoryHierarchy (directoryOf hi_file_path)
 340          writeBinIface dflags hi_file_path new_iface
 341     where hi_file_path = ml_hi_file location
 342
 343
 344 -- -----------------------------------------------------------------------------
 345 -- Look up parents and versions of Names
 346
 347 -- This is like a global version of the mi_ver_fn field in each ModIface.
 348 -- Given a Name, it finds the ModIface, and then uses mi_ver_fn to get
 349 -- the parent and version info.
 350
 351 mkParentVerFun
 352         :: HscEnv                       -- needed to look up versions
 353         -> ExternalPackageState         -- ditto
 354         -> (Name -> (OccName,Version))
 355 mkParentVerFun hsc_env eps
 356   = \name ->
 357       let
 358         mod = nameModule name
 359         occ = nameOccName name
 360         iface = lookupIfaceByModule (hsc_dflags hsc_env) hpt pit mod `orElse`
 361                    pprPanic "lookupVers2" (ppr mod <+> ppr occ)
 362       in
 363         mi_ver_fn iface occ `orElse`
 364                  pprPanic "lookupVers1" (ppr mod <+> ppr occ)
 365   where
 366       hpt = hsc_HPT hsc_env
 367       pit = eps_PIT eps
 368
 369 -----------------------------------------------------------------------------
 370 -- Compute version numbers for local decls
 371
 372 addVersionInfo
 373         :: (Name -> (OccName,Version))  -- lookup parents and versions of names
 374         -> Maybe ModIface  -- The old interface, read from M.hi
 375         -> ModIface        -- The new interface (lacking decls)
 376         -> [IfaceDecl]     -- The new decls
 377         -> (ModIface,   -- Updated interface
 378             Bool,          -- True <=> no changes at all; no need to write Iface
 379             SDoc,          -- Differences
 380             Maybe SDoc) -- Warnings about orphans
 381
 382 addVersionInfo ver_fn Nothing new_iface new_decls
 383 -- No old interface, so definitely write a new one!
 384   = (new_iface { mi_orphan = anyNothing ifInstOrph (mi_insts new_iface)
 385                                 || anyNothing ifRuleOrph (mi_rules new_iface)
 386                , mi_finsts = not . null $ mi_fam_insts new_iface
 387                , mi_decls  = [(initialVersion, decl) | decl <- new_decls]
 388                , mi_ver_fn = mkIfaceVerCache (zip (repeat initialVersion)
 389                                                   new_decls)
 390                },
 391      False,
 392      ptext SLIT("No old interface file"),
 393      pprOrphans orph_insts orph_rules)
 394   where
 395     orph_insts = filter (isNothing . ifInstOrph) (mi_insts new_iface)
 396     orph_rules = filter (isNothing . ifRuleOrph) (mi_rules new_iface)
 397
 398 addVersionInfo ver_fn (Just old_iface@(ModIface {
 399                                            mi_mod_vers  = old_mod_vers,
 400                                            mi_exp_vers  = old_exp_vers,
 401                                            mi_rule_vers = old_rule_vers,
 402                                            mi_decls     = old_decls,
 403                                            mi_ver_fn    = old_decl_vers,
 404                                            mi_fix_fn    = old_fixities }))
 405                new_iface@(ModIface { mi_fix_fn = new_fixities })
 406                new_decls
 407  | no_change_at_all
 408  = (old_iface,  True,   ptext SLIT("Interface file unchanged"), pp_orphs)
 409  | otherwise
 410  = (final_iface, False, vcat [ptext SLIT("Interface file has changed"),
 411                               nest 2 pp_diffs], pp_orphs)
 412  where
 413     final_iface = new_iface {
 414                 mi_mod_vers  = bump_unless no_output_change old_mod_vers,
 415                 mi_exp_vers  = bump_unless no_export_change old_exp_vers,
 416                 mi_rule_vers = bump_unless no_rule_change   old_rule_vers,
 417                 mi_orphan    = not (null new_orph_rules && null new_orph_insts),
 418                 mi_finsts    = not . null $ mi_fam_insts new_iface,
 419                 mi_decls     = decls_w_vers,
 420                 mi_ver_fn    = mkIfaceVerCache decls_w_vers }
 421
 422     decls_w_vers = [(add_vers decl, decl) | decl <- new_decls]
 423
 424     -------------------
 425     (old_non_orph_insts, old_orph_insts) =
 426         mkOrphMap ifInstOrph (mi_insts old_iface)
 427     (new_non_orph_insts, new_orph_insts) =
 428         mkOrphMap ifInstOrph (mi_insts new_iface)
 429     old_fam_insts = mi_fam_insts old_iface
 430     new_fam_insts = mi_fam_insts new_iface
 431     same_insts occ = eqMaybeBy  (eqListBy eqIfInst)
 432                                 (lookupOccEnv old_non_orph_insts occ)
 433                                 (lookupOccEnv new_non_orph_insts occ)
 434
 435     (old_non_orph_rules, old_orph_rules) =
 436         mkOrphMap ifRuleOrph (mi_rules old_iface)
 437     (new_non_orph_rules, new_orph_rules) =
 438         mkOrphMap ifRuleOrph (mi_rules new_iface)
 439     same_rules occ = eqMaybeBy  (eqListBy eqIfRule)
 440                                 (lookupOccEnv old_non_orph_rules occ)
 441                                 (lookupOccEnv new_non_orph_rules occ)
 442     -------------------
 443     -- Computing what changed
 444     no_output_change = no_decl_change   && no_rule_change &&
 445                        no_export_change && no_deprec_change
 446     no_export_change = mi_exports new_iface == mi_exports old_iface
 447                                 -- Kept sorted
 448     no_decl_change   = isEmptyOccSet changed_occs
 449     no_rule_change   = not (changedWrtNames changed_occs (eqListBy eqIfRule old_orph_rules new_orph_rules)
 450                          || changedWrtNames changed_occs (eqListBy eqIfInst old_orph_insts new_orph_insts)
 451                          || changedWrtNames changed_occs (eqListBy eqIfFamInst old_fam_insts new_fam_insts))
 452     no_deprec_change = mi_deprecs new_iface == mi_deprecs old_iface
 453
 454         -- If the usages havn't changed either, we don't need to write the interface file
 455     no_other_changes = mi_usages new_iface == mi_usages old_iface &&
 456                        mi_deps new_iface == mi_deps old_iface
 457     no_change_at_all = no_output_change && no_other_changes
 458
 459     pp_diffs = vcat [pp_change no_export_change "Export list"
 460                         (ppr old_exp_vers <+> arrow <+> ppr (mi_exp_vers final_iface)),
 461                      pp_change no_rule_change "Rules"
 462                         (ppr old_rule_vers <+> arrow <+> ppr (mi_rule_vers final_iface)),
 463                      pp_change no_deprec_change "Deprecations" empty,
 464                      pp_change no_other_changes  "Usages" empty,
 465                      pp_decl_diffs]
 466     pp_change True  what info = empty
 467     pp_change False what info = text what <+> ptext SLIT("changed") <+> info
 468
 469     -------------------
 470     old_decl_env = mkOccEnv [(ifName decl, decl) | (_,decl) <- old_decls]
 471     same_fixity n = bool (old_fixities n == new_fixities n)
 472
 473     -------------------
 474     -- Adding version info
 475     new_version = bumpVersion old_mod_vers
 476                         -- Start from the old module version, not from
 477                         -- zero so that if you remove f, and then add
 478                         -- it again, you don't thereby reduce f's
 479                         -- version number
 480
 481     add_vers decl | occ `elemOccSet` changed_occs = new_version
 482                   | otherwise = snd (expectJust "add_vers" (old_decl_vers occ))
 483                                 -- If it's unchanged, there jolly well
 484                   where         -- should be an old version number
 485                     occ = ifName decl
 486
 487     -------------------
 488     -- Deciding which declarations have changed
 489
 490     -- For each local decl, the IfaceEq gives the list of things that
 491     -- must be unchanged for the declaration as a whole to be unchanged.
 492     eq_info :: [(OccName, IfaceEq)]
 493     eq_info = map check_eq new_decls
 494     check_eq new_decl
 495          | Just old_decl <- lookupOccEnv old_decl_env occ
 496          = (occ, new_decl `eqIfDecl` old_decl &&& eq_indirects new_decl)
 497          | otherwise {- No corresponding old decl -}
 498          = (occ, NotEqual)
 499         where
 500           occ = ifName new_decl
 501
 502     eq_indirects :: IfaceDecl -> IfaceEq
 503                 -- When seeing if two decls are the same, remember to
 504                 -- check whether any relevant fixity or rules have changed
 505     eq_indirects (IfaceId {ifName = occ}) = eq_ind_occ occ
 506     eq_indirects (IfaceClass {ifName = cls_occ, ifSigs = sigs})
 507         = same_insts cls_occ &&&
 508           eq_ind_occs [op | IfaceClassOp op _ _ <- sigs]
 509     eq_indirects (IfaceData {ifName = tc_occ, ifCons = cons})
 510         = same_insts tc_occ &&& same_fixity tc_occ &&&  -- The TyCon can have a fixity too
 511           eq_ind_occs (map ifConOcc (visibleIfConDecls cons))
 512     eq_indirects other = Equal  -- Synonyms and foreign declarations
 513
 514     eq_ind_occ :: OccName -> IfaceEq    -- For class ops and Ids; check fixity and rules
 515     eq_ind_occ occ = same_fixity occ &&& same_rules occ
 516     eq_ind_occs = foldr ((&&&) . eq_ind_occ) Equal
 517
 518     -- The Occs of declarations that changed.
 519     changed_occs :: OccSet
 520     changed_occs = computeChangedOccs ver_fn (mi_module new_iface)
 521                          (mi_usages old_iface) eq_info
 522
 523     -------------------
 524     -- Diffs
 525     pp_decl_diffs :: SDoc       -- Nothing => no changes
 526     pp_decl_diffs
 527         | isEmptyOccSet changed_occs = empty
 528         | otherwise
 529         = vcat [ptext SLIT("Changed occs:") <+> ppr (occSetElts changed_occs),
 530                 ptext SLIT("Version change for these decls:"),
 531                 nest 2 (vcat (map show_change new_decls))]
 532
 533     eq_env = mkOccEnv eq_info
 534     show_change new_decl
 535         | not (occ `elemOccSet` changed_occs) = empty
 536         | otherwise
 537         = vcat [ppr occ <+> ppr (old_decl_vers occ) <+> arrow <+> ppr new_version,
 538                 nest 2 why]
 539         where
 540           occ = ifName new_decl
 541           why = case lookupOccEnv eq_env occ of
 542                     Just (EqBut names) -> sep [ppr occ <> colon, ptext SLIT("Free vars (only) changed:"),
 543                                               nest 2 (braces (fsep (map ppr (occSetElts
 544                                                 (occs `intersectOccSet` changed_occs)))))]
 545                            where occs = mkOccSet (map nameOccName (nameSetToList names))
 546                     Just NotEqual
 547                         | Just old_decl <- lookupOccEnv old_decl_env occ
 548                         -> vcat [ptext SLIT("Old:") <+> ppr old_decl,
 549                          ptext SLIT("New:") <+> ppr new_decl]
 550                         | otherwise
 551                         -> ppr occ <+> ptext SLIT("only in new interface")
 552                     other -> pprPanic "MkIface.show_change" (ppr occ)
 553
 554     pp_orphs = pprOrphans new_orph_insts new_orph_rules
 555
 556
 557 pprOrphans insts rules
 558   | null insts && null rules = Nothing
 559   | otherwise
 560   = Just $ vcat [
 561         if null insts then empty else
 562              hang (ptext SLIT("Warning: orphan instances:"))
 563                 2 (vcat (map ppr insts)),
 564         if null rules then empty else
 565              hang (ptext SLIT("Warning: orphan rules:"))
 566                 2 (vcat (map ppr rules))
 567     ]
 568
 569 computeChangedOccs
 570         :: (Name -> (OccName,Version))     -- get parents and versions
 571         -> Module                       -- This module
 572         -> [Usage]                      -- Usages from old iface
 573         -> [(OccName, IfaceEq)]         -- decl names, equality conditions
 574         -> OccSet                       -- set of things that have changed
 575 computeChangedOccs ver_fn this_module old_usages eq_info
 576   = foldl add_changes emptyOccSet (stronglyConnComp edges)
 577   where
 578
 579     -- return True if an external name has changed
 580     name_changed :: Name -> Bool
 581     name_changed nm
 582         | Just ents <- lookupUFM usg_modmap (moduleName mod)
 583         = case lookupUFM ents parent_occ of
 584                 Nothing -> pprPanic "computeChangedOccs" (ppr nm)
 585                 Just v  -> v < new_version
 586         | otherwise = False -- must be in another package
 587       where
 588          mod = nameModule nm
 589          (parent_occ, new_version) = ver_fn nm
 590
 591     -- Turn the usages from the old ModIface into a mapping
 592     usg_modmap = listToUFM [ (usg_mod usg, listToUFM (usg_entities usg))
 593                            | usg <- old_usages ]
 594
 595     get_local_eq_info :: GenIfaceEq NameSet -> GenIfaceEq OccSet
 596     get_local_eq_info Equal = Equal
 597     get_local_eq_info NotEqual = NotEqual
 598     get_local_eq_info (EqBut ns) = foldNameSet f Equal ns
 599         where f name eq | nameModule name == this_module =
 600                           EqBut (unitOccSet (nameOccName name)) `and_occifeq` eq
 601                         | name_changed name = NotEqual
 602                         | otherwise = eq
 603
 604     local_eq_infos = mapSnd get_local_eq_info eq_info
 605
 606     edges :: [((OccName, OccIfaceEq), Unique, [Unique])]
 607     edges = [ (node, getUnique occ, map getUnique occs)
 608             | node@(occ, iface_eq) <- local_eq_infos
 609             , let occs = case iface_eq of
 610                            EqBut occ_set -> occSetElts occ_set
 611                            other -> [] ]
 612
 613     -- Changes in declarations
 614     add_changes :: OccSet -> SCC (OccName, OccIfaceEq) -> OccSet
 615     add_changes so_far (AcyclicSCC (occ, iface_eq))
 616         | changedWrt so_far iface_eq -- This one has changed
 617         = extendOccSet so_far occ
 618     add_changes so_far (CyclicSCC pairs)
 619         | changedWrt so_far (foldr1 and_occifeq iface_eqs)
 620                 -- One of this group has changed
 621         = extendOccSetList so_far occs
 622         where (occs, iface_eqs) = unzip pairs
 623     add_changes so_far other = so_far
 624
 625 type OccIfaceEq = GenIfaceEq OccSet
 626
 627 changedWrt :: OccSet -> OccIfaceEq -> Bool
 628 changedWrt so_far Equal        = False
 629 changedWrt so_far NotEqual     = True
 630 changedWrt so_far (EqBut kids) = so_far `intersectsOccSet` kids
 631
 632 changedWrtNames :: OccSet -> IfaceEq -> Bool
 633 changedWrtNames so_far Equal        = False
 634 changedWrtNames so_far NotEqual     = True
 635 changedWrtNames so_far (EqBut kids) =
 636   so_far `intersectsOccSet` mkOccSet (map nameOccName (nameSetToList kids))
 637
 638 and_occifeq :: OccIfaceEq -> OccIfaceEq -> OccIfaceEq
 639 Equal       `and_occifeq` x         = x
 640 NotEqual    `and_occifeq` x         = NotEqual
 641 EqBut nms   `and_occifeq` Equal       = EqBut nms
 642 EqBut nms   `and_occifeq` NotEqual    = NotEqual
 643 EqBut nms1  `and_occifeq` EqBut nms2  = EqBut (nms1 `unionOccSets` nms2)
 644
 645 ----------------------
 646 -- mkOrphMap partitions instance decls or rules into
 647 --      (a) an OccEnv for ones that are not orphans,
 648 --          mapping the local OccName to a list of its decls
 649 --      (b) a list of orphan decls
 650 mkOrphMap :: (decl -> Maybe OccName)    -- (Just occ) for a non-orphan decl, keyed by occ
 651                                         -- Nothing for an orphan decl
 652           -> [decl]                     -- Sorted into canonical order
 653           -> (OccEnv [decl],            -- Non-orphan decls associated with their key;
 654                                         --      each sublist in canonical order
 655               [decl])                   -- Orphan decls; in canonical order
 656 mkOrphMap get_key decls
 657   = foldl go (emptyOccEnv, []) decls
 658   where
 659     go (non_orphs, orphs) d
 660         | Just occ <- get_key d
 661         = (extendOccEnv_C (\ ds _ -> d:ds) non_orphs occ [d], orphs)
 662         | otherwise = (non_orphs, d:orphs)
 663
 664 anyNothing :: (a -> Maybe b) -> [a] -> Bool
 665 anyNothing p []     = False
 666 anyNothing p (x:xs) = isNothing (p x) || anyNothing p xs
 667
 668 ----------------------
 669 mkIfaceDeprec :: Deprecations -> IfaceDeprecs
 670 mkIfaceDeprec NoDeprecs        = NoDeprecs
 671 mkIfaceDeprec (DeprecAll t)    = DeprecAll t
 672 mkIfaceDeprec (DeprecSome env) = DeprecSome (sortLe (<=) (nameEnvElts env))
 673
 674 ----------------------
 675 bump_unless :: Bool -> Version -> Version
 676 bump_unless True  v = v -- True <=> no change
 677 bump_unless False v = bumpVersion v
 678 \end{code}
 679
 680
 681 %*********************************************************
 682 %*                                                      *
 683 \subsection{Keeping track of what we've slurped, and version numbers}
 684 %*                                                      *
 685 %*********************************************************
 686
 687
 688 \begin{code}
 689 mkUsageInfo :: HscEnv
 690             -> ModuleEnv (Module, Bool, SrcSpan)
 691             -> [(ModuleName, IsBootInterface)]
 692             -> NameSet -> IO [Usage]
 693 mkUsageInfo hsc_env dir_imp_mods dep_mods used_names
 694   = do  { eps <- hscEPS hsc_env
 695         ; let usages = mk_usage_info (eps_PIT eps) hsc_env
 696                                      dir_imp_mods dep_mods used_names
 697         ; usages `seqList`  return usages }
 698          -- seq the list of Usages returned: occasionally these
 699          -- don't get evaluated for a while and we can end up hanging on to
 700          -- the entire collection of Ifaces.
 701
 702 mk_usage_info pit hsc_env dir_imp_mods dep_mods used_names
 703   = mapCatMaybes mkUsage dep_mods
 704         -- ToDo: do we need to sort into canonical order?
 705   where
 706     hpt = hsc_HPT hsc_env
 707     dflags = hsc_dflags hsc_env
 708
 709     -- ent_map groups together all the things imported and used
 710     -- from a particular module in this package
 711     ent_map :: ModuleEnv [OccName]
 712     ent_map  = foldNameSet add_mv emptyModuleEnv used_names
 713     add_mv name mv_map
 714         | isWiredInName name = mv_map  -- ignore wired-in names
 715         | otherwise
 716         = case nameModule_maybe name of
 717              Nothing  -> mv_map         -- ignore internal names
 718              Just mod -> extendModuleEnv_C add_item mv_map mod [occ]
 719                    where
 720                      occ = nameOccName name
 721                      add_item occs _ = occ:occs
 722
 723     depend_on_exports mod = case lookupModuleEnv dir_imp_mods mod of
 724                                 Just (_,no_imp,_) -> not no_imp
 725                                 Nothing           -> True
 726
 727     -- We want to create a Usage for a home module if
 728     --  a) we used something from; has something in used_names
 729     --  b) we imported all of it, even if we used nothing from it
 730     --          (need to recompile if its export list changes: export_vers)
 731     --  c) is a home-package orphan or family-instance module (need to
 732     --          recompile if its instance decls change: rules_vers)
 733     mkUsage :: (ModuleName, IsBootInterface) -> Maybe Usage
 734     mkUsage (mod_name, _)
 735       |  isNothing maybe_iface          -- We can't depend on it if we didn't
 736       || (null used_occs                -- load its interface.
 737           && isNothing export_vers
 738           && not orphan_mod
 739           && not finsts_mod)
 740       = Nothing                 -- Record no usage info
 741
 742       | otherwise
 743       = Just (Usage { usg_name     = mod_name,
 744                       usg_mod      = mod_vers,
 745                       usg_exports  = export_vers,
 746                       usg_entities = fmToList ent_vers,
 747                       usg_rules    = rules_vers })
 748       where
 749         maybe_iface  = lookupIfaceByModule dflags hpt pit mod
 750                 -- In one-shot mode, the interfaces for home-package
 751                 -- modules accumulate in the PIT not HPT.  Sigh.
 752
 753         mod = mkModule (thisPackage dflags) mod_name
 754
 755         Just iface   = maybe_iface
 756         orphan_mod   = mi_orphan    iface
 757         finsts_mod   = mi_finsts    iface
 758         version_env  = mi_ver_fn    iface
 759         mod_vers     = mi_mod_vers  iface
 760         rules_vers   = mi_rule_vers iface
 761         export_vers | depend_on_exports mod = Just (mi_exp_vers iface)
 762                     | otherwise             = Nothing
 763
 764         used_occs = lookupModuleEnv ent_map mod `orElse` []
 765
 766         -- Making a FiniteMap here ensures that (a) we remove duplicates
 767         -- when we have usages on several subordinates of a single parent,
 768         -- and (b) that the usages emerge in a canonical order, which
 769         -- is why we use FiniteMap rather than OccEnv: FiniteMap works
 770         -- using Ord on the OccNames, which is a lexicographic ordering.
 771         ent_vers :: FiniteMap OccName Version
 772         ent_vers = listToFM (map lookup_occ used_occs)
 773
 774         lookup_occ occ =
 775             case version_env occ of
 776                 Nothing -> pprTrace "hmm, strange" (ppr mod <+> ppr occ) $
 777                            (occ, initialVersion) -- does this ever happen?
 778                 Just (parent, version) -> (parent, version)
 779 \end{code}
 780
 781 \begin{code}
 782 mkIfaceExports :: [AvailInfo]
 783                -> [(Module, [GenAvailInfo OccName])]
 784   -- Group by module and sort by occurrence
 785   -- This keeps the list in canonical order
 786 mkIfaceExports exports
 787   = [ (mod, eltsFM avails)
 788     | (mod, avails) <- fmToList groupFM
 789     ]
 790   where
 791         -- Deliberately use FiniteMap rather than UniqFM so we
 792         -- get a canonical ordering
 793     groupFM :: ModuleEnv (FiniteMap FastString (GenAvailInfo OccName))
 794     groupFM = foldl add emptyModuleEnv exports
 795
 796     add env avail
 797       = extendModuleEnv_C add_avail env mod (unitFM avail_fs avail_occ)
 798       where
 799         avail_occ = availToOccs avail
 800         mod  = nameModule (availName avail)
 801         avail_fs = occNameFS (availName avail_occ)
 802         add_avail avail_fm _ = addToFM avail_fm avail_fs avail_occ
 803
 804     availToOccs (Avail n) = Avail (nameOccName n)
 805     availToOccs (AvailTC tc ns) = AvailTC (nameOccName tc) (map nameOccName ns)
 806 \end{code}
 807
 808
 809 %************************************************************************
 810 %*                                                                      *
 811         Load the old interface file for this module (unless
 812         we have it aleady), and check whether it is up to date
 813
 814 %*                                                                      *
 815 %************************************************************************
 816
 817 \begin{code}
 818 checkOldIface :: HscEnv
 819               -> ModSummary
 820               -> Bool                   -- Source unchanged
 821               -> Maybe ModIface         -- Old interface from compilation manager, if any
 822               -> IO (RecompileRequired, Maybe ModIface)
 823
 824 checkOldIface hsc_env mod_summary source_unchanged maybe_iface
 825   = do  { showPass (hsc_dflags hsc_env)
 826                    ("Checking old interface for " ++
 827                         showSDoc (ppr (ms_mod mod_summary))) ;
 828
 829         ; initIfaceCheck hsc_env $
 830           check_old_iface hsc_env mod_summary source_unchanged maybe_iface
 831      }
 832
 833 check_old_iface hsc_env mod_summary source_unchanged maybe_iface
 834  =  do  -- CHECK WHETHER THE SOURCE HAS CHANGED
 835     { ifM (not source_unchanged)
 836            (traceHiDiffs (nest 4 (text "Source file changed or recompilation check turned off")))
 837
 838      -- If the source has changed and we're in interactive mode, avoid reading
 839      -- an interface; just return the one we might have been supplied with.
 840     ; ghc_mode <- getGhcMode
 841     ; if (ghc_mode == Interactive || ghc_mode == JustTypecheck)
 842          && not source_unchanged then
 843          return (outOfDate, maybe_iface)
 844       else
 845       case maybe_iface of {
 846         Just old_iface -> do -- Use the one we already have
 847           { traceIf (text "We already have the old interface for" <+> ppr (ms_mod mod_summary))
 848           ; recomp <- checkVersions hsc_env source_unchanged old_iface
 849           ; return (recomp, Just old_iface) }
 850
 851       ; Nothing -> do
 852
 853         -- Try and read the old interface for the current module
 854         -- from the .hi file left from the last time we compiled it
 855     { let iface_path = msHiFilePath mod_summary
 856     ; read_result <- readIface (ms_mod mod_summary) iface_path False
 857     ; case read_result of {
 858          Failed err -> do       -- Old interface file not found, or garbled; give up
 859                 { traceIf (text "FYI: cannot read old interface file:"
 860                                  $$ nest 4 err)
 861                 ; return (outOfDate, Nothing) }
 862
 863       ;  Succeeded iface -> do
 864
 865         -- We have got the old iface; check its versions
 866     { traceIf (text "Read the interface file" <+> text iface_path)
 867     ; recomp <- checkVersions hsc_env source_unchanged iface
 868     ; returnM (recomp, Just iface)
 869     }}}}}
 870 \end{code}
 871
 872 @recompileRequired@ is called from the HscMain.   It checks whether
 873 a recompilation is required.  It needs access to the persistent state,
 874 finder, etc, because it may have to load lots of interface files to
 875 check their versions.
 876
 877 \begin{code}
 878 type RecompileRequired = Bool
 879 upToDate  = False       -- Recompile not required
 880 outOfDate = True        -- Recompile required
 881
 882 checkVersions :: HscEnv
 883               -> Bool           -- True <=> source unchanged
 884               -> ModIface       -- Old interface
 885               -> IfG RecompileRequired
 886 checkVersions hsc_env source_unchanged iface
 887   | not source_unchanged
 888   = returnM outOfDate
 889   | otherwise
 890   = do  { traceHiDiffs (text "Considering whether compilation is required for" <+>
 891                         ppr (mi_module iface) <> colon)
 892
 893         -- Source code unchanged and no errors yet... carry on
 894
 895         -- First put the dependent-module info, read from the old interface, into the envt,
 896         -- so that when we look for interfaces we look for the right one (.hi or .hi-boot)
 897         --
 898         -- It's just temporary because either the usage check will succeed
 899         -- (in which case we are done with this module) or it'll fail (in which
 900         -- case we'll compile the module from scratch anyhow).
 901         --
 902         -- We do this regardless of compilation mode, although in --make mode
 903         -- all the dependent modules should be in the HPT already, so it's
 904         -- quite redundant
 905         ; updateEps_ $ \eps  -> eps { eps_is_boot = mod_deps }
 906
 907         ; let this_pkg = thisPackage (hsc_dflags hsc_env)
 908         ; checkList [checkModUsage this_pkg u | u <- mi_usages iface]
 909     }
 910   where
 911         -- This is a bit of a hack really
 912     mod_deps :: ModuleNameEnv (ModuleName, IsBootInterface)
 913     mod_deps = mkModDeps (dep_mods (mi_deps iface))
 914
 915 checkModUsage :: PackageId ->Usage -> IfG RecompileRequired
 916 -- Given the usage information extracted from the old
 917 -- M.hi file for the module being compiled, figure out
 918 -- whether M needs to be recompiled.
 919
 920 checkModUsage this_pkg (Usage { usg_name = mod_name, usg_mod = old_mod_vers,
 921                                 usg_rules = old_rule_vers,
 922                                 usg_exports = maybe_old_export_vers,
 923                                 usg_entities = old_decl_vers })
 924   =     -- Load the imported interface is possible
 925     let
 926         doc_str = sep [ptext SLIT("need version info for"), ppr mod_name]
 927     in
 928     traceHiDiffs (text "Checking usages for module" <+> ppr mod_name) `thenM_`
 929
 930     let
 931         mod = mkModule this_pkg mod_name
 932     in
 933     loadInterface doc_str mod ImportBySystem            `thenM` \ mb_iface ->
 934         -- Load the interface, but don't complain on failure;
 935         -- Instead, get an Either back which we can test
 936
 937     case mb_iface of {
 938         Failed exn ->  (out_of_date (sep [ptext SLIT("Can't find version number for module"),
 939                                        ppr mod_name]));
 940                 -- Couldn't find or parse a module mentioned in the
 941                 -- old interface file.  Don't complain -- it might just be that
 942                 -- the current module doesn't need that import and it's been deleted
 943
 944         Succeeded iface ->
 945     let
 946         new_mod_vers    = mi_mod_vers  iface
 947         new_decl_vers   = mi_ver_fn    iface
 948         new_export_vers = mi_exp_vers  iface
 949         new_rule_vers   = mi_rule_vers iface
 950     in
 951         -- CHECK MODULE
 952     checkModuleVersion old_mod_vers new_mod_vers        `thenM` \ recompile ->
 953     if not recompile then
 954         returnM upToDate
 955     else
 956
 957         -- CHECK EXPORT LIST
 958     if checkExportList maybe_old_export_vers new_export_vers then
 959         out_of_date_vers (ptext SLIT("  Export list changed"))
 960                          (expectJust "checkModUsage" maybe_old_export_vers)
 961                          new_export_vers
 962     else
 963
 964         -- CHECK RULES
 965     if old_rule_vers /= new_rule_vers then
 966         out_of_date_vers (ptext SLIT("  Rules changed"))
 967                          old_rule_vers new_rule_vers
 968     else
 969
 970         -- CHECK ITEMS ONE BY ONE
 971     checkList [checkEntityUsage new_decl_vers u | u <- old_decl_vers]   `thenM` \ recompile ->
 972     if recompile then
 973         returnM outOfDate       -- This one failed, so just bail out now
 974     else
 975         up_to_date (ptext SLIT("  Great!  The bits I use are up to date"))
 976     }
 977
 978 ------------------------
 979 checkModuleVersion old_mod_vers new_mod_vers
 980   | new_mod_vers == old_mod_vers
 981   = up_to_date (ptext SLIT("Module version unchanged"))
 982
 983   | otherwise
 984   = out_of_date_vers (ptext SLIT("  Module version has changed"))
 985                      old_mod_vers new_mod_vers
 986
 987 ------------------------
 988 checkExportList Nothing  new_vers = upToDate
 989 checkExportList (Just v) new_vers = v /= new_vers
 990
 991 ------------------------
 992 checkEntityUsage new_vers (name,old_vers)
 993   = case new_vers name of
 994
 995         Nothing       ->        -- We used it before, but it ain't there now
 996                           out_of_date (sep [ptext SLIT("No longer exported:"), ppr name])
 997
 998         Just (_, new_vers)      -- It's there, but is it up to date?
 999           | new_vers == old_vers -> traceHiDiffs (text "  Up to date" <+> ppr name <+> parens (ppr new_vers)) `thenM_`
1000                                     returnM upToDate
1001           | otherwise            -> out_of_date_vers (ptext SLIT("  Out of date:") <+> ppr name)
1002                                                      old_vers new_vers
1003
1004 up_to_date  msg = traceHiDiffs msg `thenM_` returnM upToDate
1005 out_of_date msg = traceHiDiffs msg `thenM_` returnM outOfDate
1006 out_of_date_vers msg old_vers new_vers
1007   = out_of_date (hsep [msg, ppr old_vers, ptext SLIT("->"), ppr new_vers])
1008
1009 ----------------------
1010 checkList :: [IfG RecompileRequired] -> IfG RecompileRequired
1011 -- This helper is used in two places
1012 checkList []             = returnM upToDate
1013 checkList (check:checks) = check        `thenM` \ recompile ->
1014                            if recompile then
1015                                 returnM outOfDate
1016                            else
1017                                 checkList checks
1018 \end{code}
1019
1020 %************************************************************************
1021 %*                                                                      *
1022                 Converting things to their Iface equivalents
1023 %*                                                                      *
1024 %************************************************************************
1025
1026 \begin{code}
1027 tyThingToIfaceDecl :: TyThing -> IfaceDecl
1028 -- Assumption: the thing is already tidied, so that locally-bound names
1029 --             (lambdas, for-alls) already have non-clashing OccNames
1030 -- Reason: Iface stuff uses OccNames, and the conversion here does
1031 --         not do tidying on the way
1032 tyThingToIfaceDecl (AnId id)
1033   = IfaceId { ifName   = getOccName id,
1034               ifType   = toIfaceType (idType id),
1035               ifIdInfo = info }
1036   where
1037     info = case toIfaceIdInfo (idInfo id) of
1038                 []    -> NoInfo
1039                 items -> HasInfo items
1040
1041 tyThingToIfaceDecl (AClass clas)
1042   = IfaceClass { ifCtxt   = toIfaceContext sc_theta,
1043                  ifName   = getOccName clas,
1044                  ifTyVars = toIfaceTvBndrs clas_tyvars,
1045                  ifFDs    = map toIfaceFD clas_fds,
1046                  ifATs    = map (tyThingToIfaceDecl . ATyCon) clas_ats,
1047                  ifSigs   = map toIfaceClassOp op_stuff,
1048                  ifRec    = boolToRecFlag (isRecursiveTyCon tycon) }
1049   where
1050     (clas_tyvars, clas_fds, sc_theta, _, clas_ats, op_stuff)
1051       = classExtraBigSig clas
1052     tycon = classTyCon clas
1053
1054     toIfaceClassOp (sel_id, def_meth)
1055         = ASSERT(sel_tyvars == clas_tyvars)
1056           IfaceClassOp (getOccName sel_id) def_meth (toIfaceType op_ty)
1057         where
1058                 -- Be careful when splitting the type, because of things
1059                 -- like         class Foo a where
1060                 --                op :: (?x :: String) => a -> a
1061                 -- and          class Baz a where
1062                 --                op :: (Ord a) => a -> a
1063           (sel_tyvars, rho_ty) = splitForAllTys (idType sel_id)
1064           op_ty                = funResultTy rho_ty
1065
1066     toIfaceFD (tvs1, tvs2) = (map getFS tvs1, map getFS tvs2)
1067
1068 tyThingToIfaceDecl (ATyCon tycon)
1069   | isSynTyCon tycon
1070   = IfaceSyn {  ifName   = getOccName tycon,
1071                 ifTyVars = toIfaceTvBndrs tyvars,
1072                 ifOpenSyn = syn_isOpen,
1073                 ifSynRhs  = toIfaceType syn_tyki }
1074
1075   | isAlgTyCon tycon
1076   = IfaceData { ifName    = getOccName tycon,
1077                 ifTyVars  = toIfaceTvBndrs tyvars,
1078                 ifCtxt    = toIfaceContext (tyConStupidTheta tycon),
1079                 ifCons    = ifaceConDecls (algTyConRhs tycon),
1080                 ifRec     = boolToRecFlag (isRecursiveTyCon tycon),
1081                 ifGadtSyntax = isGadtSyntaxTyCon tycon,
1082                 ifGeneric = tyConHasGenerics tycon,
1083                 ifFamInst = famInstToIface (tyConFamInst_maybe tycon)}
1084
1085   | isForeignTyCon tycon
1086   = IfaceForeign { ifName    = getOccName tycon,
1087                    ifExtName = tyConExtName tycon }
1088
1089   | otherwise = pprPanic "toIfaceDecl" (ppr tycon)
1090   where
1091     tyvars = tyConTyVars tycon
1092     (syn_isOpen, syn_tyki) = case synTyConRhs tycon of
1093                                OpenSynTyCon ki -> (True , ki)
1094                                SynonymTyCon ty -> (False, ty)
1095
1096     ifaceConDecls (NewTyCon { data_con = con })    =
1097       IfNewTyCon  (ifaceConDecl con)
1098     ifaceConDecls (DataTyCon { data_cons = cons }) =
1099       IfDataTyCon (map ifaceConDecl cons)
1100     ifaceConDecls OpenDataTyCon                    = IfOpenDataTyCon
1101     ifaceConDecls OpenNewTyCon                     = IfOpenNewTyCon
1102     ifaceConDecls AbstractTyCon                    = IfAbstractTyCon
1103         -- The last case happens when a TyCon has been trimmed during tidying
1104         -- Furthermore, tyThingToIfaceDecl is also used
1105         -- in TcRnDriver for GHCi, when browsing a module, in which case the
1106         -- AbstractTyCon case is perfectly sensible.
1107
1108     ifaceConDecl data_con
1109         = IfCon   { ifConOcc     = getOccName (dataConName data_con),
1110                     ifConInfix   = dataConIsInfix data_con,
1111                     ifConUnivTvs = toIfaceTvBndrs (dataConUnivTyVars data_con),
1112                     ifConExTvs   = toIfaceTvBndrs (dataConExTyVars data_con),
1113                     ifConEqSpec  = to_eq_spec (dataConEqSpec data_con),
1114                     ifConCtxt    = toIfaceContext (dataConTheta data_con),
1115                     ifConArgTys  = map toIfaceType (dataConOrigArgTys data_con),
1116                     ifConFields  = map getOccName
1117                                        (dataConFieldLabels data_con),
1118                     ifConStricts = dataConStrictMarks data_con }
1119
1120     to_eq_spec spec = [(getOccName tv, toIfaceType ty) | (tv,ty) <- spec]
1121
1122     famInstToIface Nothing                    = Nothing
1123     famInstToIface (Just (famTyCon, instTys)) =
1124       Just (toIfaceTyCon famTyCon, map toIfaceType instTys)
1125
1126 tyThingToIfaceDecl (ADataCon dc)
1127  = pprPanic "toIfaceDecl" (ppr dc)      -- Should be trimmed out earlier
1128
1129
1130 getFS x = occNameFS (getOccName x)
1131
1132 --------------------------
1133 instanceToIfaceInst :: Instance -> IfaceInst
1134 instanceToIfaceInst ispec@(Instance { is_dfun = dfun_id, is_flag = oflag,
1135                                       is_cls = cls, is_tcs = mb_tcs,
1136                                       is_orph = orph })
1137   = IfaceInst { ifDFun    = getName dfun_id,
1138                 ifOFlag   = oflag,
1139                 ifInstCls = cls,
1140                 ifInstTys = map do_rough mb_tcs,
1141                 ifInstOrph = orph }
1142   where
1143     do_rough Nothing  = Nothing
1144     do_rough (Just n) = Just (toIfaceTyCon_name n)
1145
1146 --------------------------
1147 famInstToIfaceFamInst :: FamInst -> IfaceFamInst
1148 famInstToIfaceFamInst fi@(FamInst { fi_tycon = tycon,
1149                                             fi_fam = fam, fi_tcs = mb_tcs })
1150   = IfaceFamInst { ifFamInstTyCon  = toIfaceTyCon tycon
1151                  , ifFamInstFam    = fam
1152                  , ifFamInstTys    = map do_rough mb_tcs }
1153   where
1154     do_rough Nothing  = Nothing
1155     do_rough (Just n) = Just (toIfaceTyCon_name n)
1156
1157 --------------------------
1158 toIfaceIdInfo :: IdInfo -> [IfaceInfoItem]
1159 toIfaceIdInfo id_info
1160   = catMaybes [arity_hsinfo, caf_hsinfo, strict_hsinfo,
1161                inline_hsinfo, wrkr_hsinfo,  unfold_hsinfo]
1162   where
1163     ------------  Arity  --------------
1164     arity_info = arityInfo id_info
1165     arity_hsinfo | arity_info == 0 = Nothing
1166                  | otherwise       = Just (HsArity arity_info)
1167
1168     ------------ Caf Info --------------
1169     caf_info   = cafInfo id_info
1170     caf_hsinfo = case caf_info of
1171                    NoCafRefs -> Just HsNoCafRefs
1172                    _other    -> Nothing
1173
1174     ------------  Strictness  --------------
1175         -- No point in explicitly exporting TopSig
1176     strict_hsinfo = case newStrictnessInfo id_info of
1177                         Just sig | not (isTopSig sig) -> Just (HsStrictness sig)
1178                         _other                        -> Nothing
1179
1180     ------------  Worker  --------------
1181     work_info   = workerInfo id_info
1182     has_worker  = case work_info of { HasWorker _ _ -> True; other -> False }
1183     wrkr_hsinfo = case work_info of
1184                     HasWorker work_id wrap_arity ->
1185                         Just (HsWorker ((idName work_id)) wrap_arity)
1186                     NoWorker -> Nothing
1187
1188     ------------  Unfolding  --------------
1189     -- The unfolding is redundant if there is a worker
1190     unfold_info  = unfoldingInfo id_info
1191     rhs          = unfoldingTemplate unfold_info
1192     no_unfolding = neverUnfold unfold_info
1193                         -- The CoreTidy phase retains unfolding info iff
1194                         -- we want to expose the unfolding, taking into account
1195                         -- unconditional NOINLINE, etc.  See TidyPgm.addExternal
1196     unfold_hsinfo | no_unfolding = Nothing
1197                   | has_worker   = Nothing      -- Unfolding is implicit
1198                   | otherwise    = Just (HsUnfold (toIfaceExpr rhs))
1199
1200     ------------  Inline prag  --------------
1201     inline_prag = inlinePragInfo id_info
1202     inline_hsinfo | isAlwaysActive inline_prag     = Nothing
1203                   | no_unfolding && not has_worker = Nothing
1204                         -- If the iface file give no unfolding info, we
1205                         -- don't need to say when inlining is OK!
1206                   | otherwise                      = Just (HsInline inline_prag)
1207
1208 --------------------------
1209 coreRuleToIfaceRule :: CoreRule -> IfaceRule
1210 coreRuleToIfaceRule (BuiltinRule { ru_fn = fn})
1211   = pprTrace "toHsRule: builtin" (ppr fn) $
1212     bogusIfaceRule fn
1213
1214 coreRuleToIfaceRule (Rule { ru_name = name, ru_fn = fn,
1215                             ru_act = act, ru_bndrs = bndrs,
1216                             ru_args = args, ru_rhs = rhs, ru_orph = orph })
1217   = IfaceRule { ifRuleName  = name, ifActivation = act,
1218                 ifRuleBndrs = map toIfaceBndr bndrs,
1219                 ifRuleHead  = fn,
1220                 ifRuleArgs  = map do_arg args,
1221                 ifRuleRhs   = toIfaceExpr rhs,
1222                 ifRuleOrph  = orph }
1223   where
1224         -- For type args we must remove synonyms from the outermost
1225         -- level.  Reason: so that when we read it back in we'll
1226         -- construct the same ru_rough field as we have right now;
1227         -- see tcIfaceRule
1228     do_arg (Type ty) = IfaceType (toIfaceType (deNoteType ty))
1229     do_arg arg       = toIfaceExpr arg
1230
1231 bogusIfaceRule :: Name -> IfaceRule
1232 bogusIfaceRule id_name
1233   = IfaceRule { ifRuleName = FSLIT("bogus"), ifActivation = NeverActive,
1234         ifRuleBndrs = [], ifRuleHead = id_name, ifRuleArgs = [],
1235         ifRuleRhs = IfaceExt id_name, ifRuleOrph = Nothing }
1236
1237 ---------------------
1238 toIfaceExpr :: CoreExpr -> IfaceExpr
1239 toIfaceExpr (Var v)       = toIfaceVar v
1240 toIfaceExpr (Lit l)       = IfaceLit l
1241 toIfaceExpr (Type ty)     = IfaceType (toIfaceType ty)
1242 toIfaceExpr (Lam x b)     = IfaceLam (toIfaceBndr x) (toIfaceExpr b)
1243 toIfaceExpr (App f a)     = toIfaceApp f [a]
1244 toIfaceExpr (Case s x ty as) = IfaceCase (toIfaceExpr s) (getFS x) (toIfaceType ty) (map toIfaceAlt as)
1245 toIfaceExpr (Let b e)     = IfaceLet (toIfaceBind b) (toIfaceExpr e)
1246 toIfaceExpr (Cast e co)   = IfaceCast (toIfaceExpr e) (toIfaceType co)
1247 toIfaceExpr (Note n e)    = IfaceNote (toIfaceNote n) (toIfaceExpr e)
1248
1249 ---------------------
1250 toIfaceNote (SCC cc)      = IfaceSCC cc
1251 toIfaceNote InlineMe      = IfaceInlineMe
1252 toIfaceNote (CoreNote s)  = IfaceCoreNote s
1253
1254 ---------------------
1255 toIfaceBind (NonRec b r) = IfaceNonRec (toIfaceIdBndr b) (toIfaceExpr r)
1256 toIfaceBind (Rec prs)    = IfaceRec [(toIfaceIdBndr b, toIfaceExpr r) | (b,r) <- prs]
1257
1258 ---------------------
1259 toIfaceAlt (c,bs,r) = (toIfaceCon c, map getFS bs, toIfaceExpr r)
1260
1261 ---------------------
1262 toIfaceCon (DataAlt dc) | isTupleTyCon tc = IfaceTupleAlt (tupleTyConBoxity tc)
1263                         | otherwise       = IfaceDataAlt (getName dc)
1264                         where
1265                           tc = dataConTyCon dc
1266
1267 toIfaceCon (LitAlt l) = IfaceLitAlt l
1268 toIfaceCon DEFAULT    = IfaceDefault
1269
1270 ---------------------
1271 toIfaceApp (App f a) as = toIfaceApp f (a:as)
1272 toIfaceApp (Var v) as
1273   = case isDataConWorkId_maybe v of
1274         -- We convert the *worker* for tuples into IfaceTuples
1275         Just dc |  isTupleTyCon tc && saturated
1276                 -> IfaceTuple (tupleTyConBoxity tc) tup_args
1277           where
1278             val_args  = dropWhile isTypeArg as
1279             saturated = val_args `lengthIs` idArity v
1280             tup_args  = map toIfaceExpr val_args
1281             tc        = dataConTyCon dc
1282
1283         other -> mkIfaceApps (toIfaceVar v) as
1284
1285 toIfaceApp e as = mkIfaceApps (toIfaceExpr e) as
1286
1287 mkIfaceApps f as = foldl (\f a -> IfaceApp f (toIfaceExpr a)) f as
1288
1289 ---------------------
1290 toIfaceVar :: Id -> IfaceExpr
1291 toIfaceVar v
1292   | Just fcall <- isFCallId_maybe v = IfaceFCall fcall (toIfaceType (idType v))
1293           -- Foreign calls have special syntax
1294   | isExternalName name             = IfaceExt name
1295   | otherwise                       = IfaceLcl (getFS name)
1296   where
1297     name = idName v
1298 \end{code}