ghc/compiler/rename/RnIfaces.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section[RnIfaces]{Cacheing and Renaming of Interfaces}
   5
   6 \begin{code}
   7 module RnIfaces (
   8         findAndReadIface,
   9
  10         getInterfaceExports, getDeferredDecls,
  11         getImportedInstDecls, getImportedRules,
  12         lookupFixityRn, loadHomeInterface,
  13         importDecl, ImportDeclResult(..), recordLocalSlurps, loadBuiltinRules,
  14         mkImportExportInfo, getSlurped,
  15
  16         checkModUsage, outOfDate, upToDate,
  17
  18         getDeclBinders, getDeclSysBinders,
  19         removeContext           -- removeContext probably belongs somewhere else
  20     ) where
  21
  22 #include "HsVersions.h"
  23
  24 import CmdLineOpts      ( opt_NoPruneDecls, opt_NoPruneTyDecls, opt_IgnoreIfacePragmas )
  25 import HsSyn            ( HsDecl(..), TyClDecl(..), InstDecl(..), IfaceSig(..),
  26                           HsType(..), ConDecl(..), IE(..), ConDetails(..), Sig(..),
  27                           ForeignDecl(..), ForKind(..), isDynamicExtName,
  28                           FixitySig(..), RuleDecl(..),
  29                           isClassOpSig, DeprecDecl(..)
  30                         )
  31 import HsImpExp         ( ieNames )
  32 import CoreSyn          ( CoreRule )
  33 import BasicTypes       ( Version, NewOrData(..) )
  34 import RdrHsSyn         ( RdrNameHsDecl, RdrNameInstDecl, RdrNameRuleDecl,
  35                           RdrNameDeprecation, RdrNameIE,
  36                           extractHsTyRdrNames
  37                         )
  38 import RnEnv
  39 import RnMonad
  40 import ParseIface       ( parseIface, IfaceStuff(..) )
  41
  42 import Name             ( Name {-instance NamedThing-}, nameOccName,
  43                           nameModule, isLocallyDefined,
  44                           isWiredInName, NamedThing(..),
  45                           elemNameEnv, extendNameEnv
  46                          )
  47 import Module           ( Module, mkVanillaModule, pprModuleName,
  48                           moduleName, isLocalModule,
  49                           ModuleName, WhereFrom(..),
  50                         )
  51 import RdrName          ( RdrName, rdrNameOcc )
  52 import NameSet
  53 import SrcLoc           ( mkSrcLoc, SrcLoc )
  54 import PrelInfo         ( cCallishTyKeys )
  55 import Maybes           ( maybeToBool )
  56 import Unique           ( Uniquable(..) )
  57 import StringBuffer     ( hGetStringBuffer )
  58 import FastString       ( mkFastString )
  59 import ErrUtils         ( Message )
  60 import Util             ( sortLt )
  61 import Lex
  62 import FiniteMap
  63 import Outputable
  64 import Bag
  65
  66 import List     ( nub )
  67 \end{code}
  68
  69
  70 %*********************************************************
  71 %*                                                      *
  72 \subsection{Loading a new interface file}
  73 %*                                                      *
  74 %*********************************************************
  75
  76 \begin{code}
  77 loadHomeInterface :: SDoc -> Name -> RnM d Ifaces
  78 loadHomeInterface doc_str name
  79   = loadInterface doc_str (moduleName (nameModule name)) ImportBySystem
  80
  81 loadOrphanModules :: [ModuleName] -> RnM d ()
  82 loadOrphanModules mods
  83   | null mods = returnRn ()
  84   | otherwise = traceRn (text "Loading orphan modules:" <+>
  85                          fsep (map pprModuleName mods))         `thenRn_`
  86                 mapRn_ load mods                                `thenRn_`
  87                 returnRn ()
  88   where
  89     load mod   = loadInterface (mk_doc mod) mod ImportBySystem
  90     mk_doc mod = pprModuleName mod <+> ptext SLIT("is a orphan-instance module")
  91
  92
  93 loadInterface :: SDoc -> ModuleName -> WhereFrom -> RnM d Ifaces
  94 loadInterface doc mod from
  95   = tryLoadInterface doc mod from       `thenRn` \ (ifaces, maybe_err) ->
  96     case maybe_err of
  97         Nothing  -> returnRn ifaces
  98         Just err -> failWithRn ifaces err
  99
 100 tryLoadInterface :: SDoc -> ModuleName -> WhereFrom -> RnM d (Ifaces, Maybe Message)
 101         -- Returns (Just err) if an error happened
 102         -- Guarantees to return with iImpModInfo m --> (... Just cts)
 103         -- (If the load fails, we plug in a vanilla placeholder
 104 tryLoadInterface doc_str mod_name from
 105  = getIfacesRn                  `thenRn` \ ifaces ->
 106    let
 107         mod_map  = iImpModInfo ifaces
 108         mod_info = lookupFM mod_map mod_name
 109
 110         hi_boot_file = case from of {
 111                          ImportByUser       -> False ;          -- Not hi-boot
 112                          ImportByUserSource -> True ;           -- hi-boot
 113                          ImportBySystem     ->
 114                        case mod_info of
 115                          Just (_, is_boot, _) -> is_boot
 116
 117                          Nothing -> False
 118                                 -- We're importing a module we know absolutely
 119                                 -- nothing about, so we assume it's from
 120                                 -- another package, where we aren't doing
 121                                 -- dependency tracking. So it won't be a hi-boot file.
 122                        }
 123         redundant_source_import
 124           = case (from, mod_info) of
 125                 (ImportByUserSource, Just (_,False,_)) -> True
 126                 other                                    -> False
 127    in
 128         -- CHECK WHETHER WE HAVE IT ALREADY
 129    case mod_info of {
 130         Just (_, _, Just _)
 131                 ->      -- We're read it already so don't re-read it
 132                     returnRn (ifaces, Nothing) ;
 133
 134         _ ->
 135
 136         -- Issue a warning for a redundant {- SOURCE -} import
 137         -- NB that we arrange to read all the ordinary imports before
 138         -- any of the {- SOURCE -} imports
 139    warnCheckRn  (not redundant_source_import)
 140                 (warnRedundantSourceImport mod_name)    `thenRn_`
 141
 142         -- READ THE MODULE IN
 143    findAndReadIface doc_str mod_name hi_boot_file   `thenRn` \ read_result ->
 144    case read_result of {
 145         Left err ->     -- Not found, so add an empty export env to the Ifaces map
 146                         -- so that we don't look again
 147            let
 148                 mod         = mkVanillaModule mod_name
 149                 new_mod_map = addToFM mod_map mod_name (False, False, Just (mod, 0, 0, 0, from, []))
 150                 new_ifaces  = ifaces { iImpModInfo = new_mod_map }
 151            in
 152            setIfacesRn new_ifaces               `thenRn_`
 153            returnRn (new_ifaces, Just err) ;
 154
 155         -- Found and parsed!
 156         Right iface ->
 157
 158         -- LOAD IT INTO Ifaces
 159
 160         -- NB: *first* we do loadDecl, so that the provenance of all the locally-defined
 161         ---    names is done correctly (notably, whether this is an .hi file or .hi-boot file).
 162         --     If we do loadExport first the wrong info gets into the cache (unless we
 163         --      explicitly tag each export which seems a bit of a bore)
 164
 165     getModuleRn                 `thenRn` \ this_mod ->
 166     let
 167         mod = pi_mod iface
 168     in
 169         -- Sanity check.  If we're system-importing a module we know nothing at all
 170         -- about, it should be from a different package to this one
 171     WARN( not (maybeToBool mod_info) &&
 172           case from of { ImportBySystem -> True; other -> False } &&
 173           isLocalModule mod,
 174           ppr mod )
 175     foldlRn (loadDecl mod)      (iDecls ifaces)   (pi_decls iface)      `thenRn` \ new_decls ->
 176     foldlRn (loadInstDecl mod)  (iInsts ifaces)   (pi_insts iface)      `thenRn` \ new_insts ->
 177     loadRules mod               (iRules ifaces)   (pi_rules iface)      `thenRn` \ new_rules ->
 178     loadFixDecls mod_name       (iFixes ifaces)   (pi_fixity iface)     `thenRn` \ new_fixities ->
 179     foldlRn (loadDeprec mod)    (iDeprecs ifaces) (pi_deprecs iface)    `thenRn` \ new_deprecs ->
 180     mapRn (loadExport this_mod) (pi_exports iface)                      `thenRn` \ avails_s ->
 181     let
 182         -- For an explicit user import, add to mod_map info about
 183         -- the things the imported module depends on, extracted
 184         -- from its usage info.
 185         mod_map1 = case from of
 186                         ImportByUser -> addModDeps mod (pi_usages iface) mod_map
 187                         other        -> mod_map
 188
 189         -- Now add info about this module
 190         mod_map2    = addToFM mod_map1 mod_name mod_details
 191         cts         = (pi_mod iface, pi_vers iface,
 192                        fst (pi_fixity iface), fst (pi_rules iface),
 193                        from, concat avails_s)
 194         mod_details = (pi_orphan iface, hi_boot_file, Just cts)
 195
 196         new_ifaces = ifaces { iImpModInfo = mod_map2,
 197                               iDecls      = new_decls,
 198                               iFixes      = new_fixities,
 199                               iInsts      = new_insts,
 200                               iRules      = new_rules,
 201                               iDeprecs    = new_deprecs }
 202     in
 203     setIfacesRn new_ifaces              `thenRn_`
 204     returnRn (new_ifaces, Nothing)
 205     }}
 206
 207 -----------------------------------------------------
 208 --      Adding module dependencies from the
 209 --      import decls in the interface file
 210 -----------------------------------------------------
 211
 212 addModDeps :: Module -> [ImportVersion a]
 213            -> ImportedModuleInfo -> ImportedModuleInfo
 214 -- (addModDeps M ivs deps)
 215 -- We are importing module M, and M.hi contains 'import' decls given by ivs
 216 addModDeps mod new_deps mod_deps
 217   = foldr add mod_deps filtered_new_deps
 218   where
 219         -- Don't record dependencies when importing a module from another package
 220         -- Except for its descendents which contain orphans,
 221         -- and in that case, forget about the boot indicator
 222     filtered_new_deps
 223         | isLocalModule mod = [ (imp_mod, (has_orphans, is_boot, Nothing))
 224                               | (imp_mod, has_orphans, is_boot, _) <- new_deps
 225                               ]
 226         | otherwise         = [ (imp_mod, (True, False, Nothing))
 227                               | (imp_mod, has_orphans, _, _) <- new_deps,
 228                                 has_orphans
 229                               ]
 230     add (imp_mod, dep) deps = addToFM_C combine deps imp_mod dep
 231
 232     combine old@(_, old_is_boot, cts) new
 233         | maybeToBool cts || not old_is_boot = old      -- Keep the old info if it's already loaded
 234                                                         -- or if it's a non-boot pending load
 235         | otherwise                          = new      -- Otherwise pick new info
 236
 237
 238 -----------------------------------------------------
 239 --      Loading the export list
 240 -----------------------------------------------------
 241
 242 loadExport :: Module -> ExportItem -> RnM d [AvailInfo]
 243 loadExport this_mod (mod, entities)
 244   | mod == moduleName this_mod = returnRn []
 245         -- If the module exports anything defined in this module, just ignore it.
 246         -- Reason: otherwise it looks as if there are two local definition sites
 247         -- for the thing, and an error gets reported.  Easiest thing is just to
 248         -- filter them out up front. This situation only arises if a module
 249         -- imports itself, or another module that imported it.  (Necessarily,
 250         -- this invoves a loop.)  Consequence: if you say
 251         --      module A where
 252         --         import B( AType )
 253         --         type AType = ...
 254         --
 255         --      module B( AType ) where
 256         --         import {-# SOURCE #-} A( AType )
 257         --
 258         -- then you'll get a 'B does not export AType' message.  A bit bogus
 259         -- but it's a bogus thing to do!
 260
 261   | otherwise
 262   = mapRn (load_entity mod) entities
 263   where
 264     new_name mod occ = newGlobalName mod occ
 265
 266     load_entity mod (Avail occ)
 267       = new_name mod occ        `thenRn` \ name ->
 268         returnRn (Avail name)
 269     load_entity mod (AvailTC occ occs)
 270       = new_name mod occ              `thenRn` \ name ->
 271         mapRn (new_name mod) occs     `thenRn` \ names ->
 272         returnRn (AvailTC name names)
 273
 274
 275 -----------------------------------------------------
 276 --      Loading type/class/value decls
 277 -----------------------------------------------------
 278
 279 loadDecl :: Module
 280          -> DeclsMap
 281          -> (Version, RdrNameHsDecl)
 282          -> RnM d DeclsMap
 283
 284 loadDecl mod decls_map (version, decl)
 285   = getDeclBinders new_name decl        `thenRn` \ maybe_avail ->
 286     case maybe_avail of {
 287         Nothing -> returnRn decls_map;  -- No bindings
 288         Just avail ->
 289
 290     getDeclSysBinders new_name decl     `thenRn` \ sys_bndrs ->
 291     let
 292         full_avail    = addSysAvails avail sys_bndrs
 293                 -- Add the sys-binders to avail.  When we import the decl,
 294                 -- it's full_avail that will get added to the 'already-slurped' set (iSlurp)
 295                 -- If we miss out sys-binders, we'll read the decl multiple times!
 296
 297         main_name     = availName avail
 298         new_decls_map = foldl add_decl decls_map
 299                                        [ (name, (version, full_avail, name==main_name, (mod, decl')))
 300                                        | name <- availNames full_avail]
 301         add_decl decls_map (name, stuff)
 302           = WARN( name `elemNameEnv` decls_map, ppr name )
 303             extendNameEnv decls_map name stuff
 304     in
 305     returnRn new_decls_map
 306     }
 307   where
 308         -- newTopBinder puts into the cache the binder with the
 309         -- module information set correctly.  When the decl is later renamed,
 310         -- the binding site will thereby get the correct module.
 311         -- There maybe occurrences that don't have the correct Module, but
 312         -- by the typechecker will propagate the binding definition to all
 313         -- the occurrences, so that doesn't matter
 314     new_name rdr_name loc = newTopBinder mod (rdrNameOcc rdr_name)
 315
 316     {-
 317       If a signature decl is being loaded, and optIgnoreIfacePragmas is on,
 318       we toss away unfolding information.
 319
 320       Also, if the signature is loaded from a module we're importing from source,
 321       we do the same. This is to avoid situations when compiling a pair of mutually
 322       recursive modules, peering at unfolding info in the interface file of the other,
 323       e.g., you compile A, it looks at B's interface file and may as a result change
 324       its interface file. Hence, B is recompiled, maybe changing its interface file,
 325       which will the unfolding info used in A to become invalid. Simple way out is to
 326       just ignore unfolding info.
 327
 328       [Jan 99: I junked the second test above.  If we're importing from an hi-boot
 329        file there isn't going to *be* any pragma info.  Maybe the above comment
 330        dates from a time where we picked up a .hi file first if it existed?]
 331     -}
 332     decl' = case decl of
 333                SigD (IfaceSig name tp ls loc) | opt_IgnoreIfacePragmas
 334                          ->  SigD (IfaceSig name tp [] loc)
 335                other     -> decl
 336
 337 -----------------------------------------------------
 338 --      Loading fixity decls
 339 -----------------------------------------------------
 340
 341 loadFixDecls mod_name fixity_env (version, decls)
 342   | null decls = returnRn fixity_env
 343
 344   | otherwise
 345   = mapRn (loadFixDecl mod_name) decls  `thenRn` \ to_add ->
 346     returnRn (extendNameEnvList fixity_env to_add)
 347
 348 loadFixDecl mod_name sig@(FixitySig rdr_name fixity loc)
 349   = newGlobalName mod_name (rdrNameOcc rdr_name)        `thenRn` \ name ->
 350     returnRn (name, FixitySig name fixity loc)
 351
 352
 353 -----------------------------------------------------
 354 --      Loading instance decls
 355 -----------------------------------------------------
 356
 357 loadInstDecl :: Module
 358              -> IfaceInsts
 359              -> RdrNameInstDecl
 360              -> RnM d IfaceInsts
 361 loadInstDecl mod insts decl@(InstDecl inst_ty binds uprags dfun_name src_loc)
 362   =
 363         -- Find out what type constructors and classes are "gates" for the
 364         -- instance declaration.  If all these "gates" are slurped in then
 365         -- we should slurp the instance decl too.
 366         --
 367         -- We *don't* want to count names in the context part as gates, though.
 368         -- For example:
 369         --              instance Foo a => Baz (T a) where ...
 370         --
 371         -- Here the gates are Baz and T, but *not* Foo.
 372     let
 373         munged_inst_ty = removeContext inst_ty
 374         free_names     = extractHsTyRdrNames munged_inst_ty
 375     in
 376     setModuleRn mod $
 377     mapRn lookupOrigName free_names     `thenRn` \ gate_names ->
 378     returnRn ((mkNameSet gate_names, (mod, InstD decl)) `consBag` insts)
 379
 380
 381 -- In interface files, the instance decls now look like
 382 --      forall a. Foo a -> Baz (T a)
 383 -- so we have to strip off function argument types as well
 384 -- as the bit before the '=>' (which is always empty in interface files)
 385 removeContext (HsForAllTy tvs cxt ty) = HsForAllTy tvs [] (removeFuns ty)
 386 removeContext ty                      = removeFuns ty
 387
 388 removeFuns (HsFunTy _ ty) = removeFuns ty
 389 removeFuns ty               = ty
 390
 391
 392 -----------------------------------------------------
 393 --      Loading Rules
 394 -----------------------------------------------------
 395
 396 loadRules :: Module -> IfaceRules
 397           -> (Version, [RdrNameRuleDecl])
 398           -> RnM d IfaceRules
 399 loadRules mod rule_bag (version, rules)
 400   | null rules || opt_IgnoreIfacePragmas
 401   = returnRn rule_bag
 402   | otherwise
 403   = setModuleRn mod                     $
 404     mapRn (loadRule mod) rules          `thenRn` \ new_rules ->
 405     returnRn (rule_bag `unionBags` listToBag new_rules)
 406
 407 loadRule :: Module -> RdrNameRuleDecl -> RnM d GatedDecl
 408 -- "Gate" the rule simply by whether the rule variable is
 409 -- needed.  We can refine this later.
 410 loadRule mod decl@(IfaceRule _ _ var _ _ src_loc)
 411   = lookupOrigName var          `thenRn` \ var_name ->
 412     returnRn (unitNameSet var_name, (mod, RuleD decl))
 413
 414 loadBuiltinRules :: [(RdrName, CoreRule)] -> RnMG ()
 415 loadBuiltinRules builtin_rules
 416   = getIfacesRn                         `thenRn` \ ifaces ->
 417     mapRn loadBuiltinRule builtin_rules `thenRn` \ rule_decls ->
 418     setIfacesRn (ifaces { iRules = iRules ifaces `unionBags` listToBag rule_decls })
 419
 420 loadBuiltinRule (var, rule)
 421   = lookupOrigName var          `thenRn` \ var_name ->
 422     returnRn (unitNameSet var_name, (nameModule var_name, RuleD (IfaceRuleOut var rule)))
 423
 424
 425 -----------------------------------------------------
 426 --      Loading Deprecations
 427 -----------------------------------------------------
 428
 429 loadDeprec :: Module -> DeprecationEnv -> RdrNameDeprecation -> RnM d DeprecationEnv
 430 loadDeprec mod deprec_env (Deprecation (IEModuleContents _) txt _)
 431   = traceRn (text "module deprecation not yet implemented:" <+> ppr mod <> colon <+> ppr txt) `thenRn_`
 432         -- SUP: TEMPORARY HACK, ignoring module deprecations for now
 433     returnRn deprec_env
 434
 435 loadDeprec mod deprec_env (Deprecation ie txt _)
 436   = setModuleRn mod                                     $
 437     mapRn lookupOrigName (ieNames ie)           `thenRn` \ names ->
 438     traceRn (text "loaded deprecation(s) for" <+> hcat (punctuate comma (map ppr names)) <> colon <+> ppr txt) `thenRn_`
 439     returnRn (extendNameEnvList deprec_env (zip names (repeat txt)))
 440 \end{code}
 441
 442
 443 %********************************************************
 444 %*                                                      *
 445 \subsection{Checking usage information}
 446 %*                                                      *
 447 %********************************************************
 448
 449 \begin{code}
 450 upToDate  = True
 451 outOfDate = False
 452
 453 checkModUsage :: [ImportVersion OccName] -> RnMG Bool
 454 -- Given the usage information extracted from the old
 455 -- M.hi file for the module being compiled, figure out
 456 -- whether M needs to be recompiled.
 457
 458 checkModUsage [] = returnRn upToDate            -- Yes!  Everything is up to date!
 459
 460 checkModUsage ((mod_name, _, _, NothingAtAll) : rest)
 461         -- If CurrentModule.hi contains
 462         --      import Foo :: ;
 463         -- then that simply records that Foo lies below CurrentModule in the
 464         -- hierarchy, but CurrentModule doesn't depend in any way on Foo.
 465         -- In this case we don't even want to open Foo's interface.
 466   = traceRn (ptext SLIT("Nothing used from:") <+> ppr mod_name) `thenRn_`
 467     checkModUsage rest  -- This one's ok, so check the rest
 468
 469 checkModUsage ((mod_name, _, _, whats_imported)  : rest)
 470   = tryLoadInterface doc_str mod_name ImportBySystem    `thenRn` \ (ifaces, maybe_err) ->
 471     case maybe_err of {
 472         Just err -> out_of_date (sep [ptext SLIT("Can't find version number for module"),
 473                                       pprModuleName mod_name]) ;
 474                 -- Couldn't find or parse a module mentioned in the
 475                 -- old interface file.  Don't complain -- it might just be that
 476                 -- the current module doesn't need that import and it's been deleted
 477
 478         Nothing ->
 479     let
 480         (_, new_mod_vers, new_fix_vers, new_rule_vers, _, _)
 481                 = case lookupFM (iImpModInfo ifaces) mod_name of
 482                            Just (_, _, Just stuff) -> stuff
 483
 484         old_mod_vers = case whats_imported of
 485                          Everything v        -> v
 486                          Specifically v _ _ _ -> v
 487                          -- NothingAtAll case dealt with by previous eqn for checkModUsage
 488     in
 489         -- If the module version hasn't changed, just move on
 490     if new_mod_vers == old_mod_vers then
 491         traceRn (sep [ptext SLIT("Module version unchanged:"), pprModuleName mod_name])
 492         `thenRn_` checkModUsage rest
 493     else
 494     traceRn (sep [ptext SLIT("Module version has changed:"), pprModuleName mod_name])
 495     `thenRn_`
 496         -- Module version changed, so check entities inside
 497
 498         -- If the usage info wants to say "I imported everything from this module"
 499         --     it does so by making whats_imported equal to Everything
 500         -- In that case, we must recompile
 501     case whats_imported of {    -- NothingAtAll dealt with earlier
 502
 503       Everything _
 504         -> out_of_date (ptext SLIT("...and I needed the whole module")) ;
 505
 506       Specifically _ old_fix_vers old_rule_vers old_local_vers ->
 507
 508     if old_fix_vers /= new_fix_vers then
 509         out_of_date (ptext SLIT("Fixities changed"))
 510     else if old_rule_vers /= new_rule_vers then
 511         out_of_date (ptext SLIT("Rules changed"))
 512     else
 513         -- Non-empty usage list, so check item by item
 514     checkEntityUsage mod_name (iDecls ifaces) old_local_vers    `thenRn` \ up_to_date ->
 515     if up_to_date then
 516         traceRn (ptext SLIT("...but the bits I use haven't."))  `thenRn_`
 517         checkModUsage rest      -- This one's ok, so check the rest
 518     else
 519         returnRn outOfDate      -- This one failed, so just bail out now
 520     }}
 521   where
 522     doc_str = sep [ptext SLIT("need version info for"), pprModuleName mod_name]
 523
 524
 525 checkEntityUsage mod decls []
 526   = returnRn upToDate   -- Yes!  All up to date!
 527
 528 checkEntityUsage mod decls ((occ_name,old_vers) : rest)
 529   = newGlobalName mod occ_name  `thenRn` \ name ->
 530     case lookupNameEnv decls name of
 531
 532         Nothing       ->        -- We used it before, but it ain't there now
 533                           out_of_date (sep [ptext SLIT("No longer exported:"), ppr name])
 534
 535         Just (new_vers,_,_,_)   -- It's there, but is it up to date?
 536                 | new_vers == old_vers
 537                         -- Up to date, so check the rest
 538                 -> checkEntityUsage mod decls rest
 539
 540                 | otherwise
 541                         -- Out of date, so bale out
 542                 -> out_of_date (sep [ptext SLIT("Out of date:"), ppr name])
 543
 544 out_of_date msg = traceRn msg `thenRn_` returnRn outOfDate
 545 \end{code}
 546
 547
 548 %*********************************************************
 549 %*                                                      *
 550 \subsection{Getting in a declaration}
 551 %*                                                      *
 552 %*********************************************************
 553
 554 \begin{code}
 555 importDecl :: Name -> RnMG ImportDeclResult
 556
 557 data ImportDeclResult
 558   = AlreadySlurped
 559   | WiredIn
 560   | Deferred
 561   | HereItIs (Module, RdrNameHsDecl)
 562
 563 importDecl name
 564   = getSlurped                          `thenRn` \ already_slurped ->
 565     if name `elemNameSet` already_slurped then
 566         returnRn AlreadySlurped -- Already dealt with
 567
 568     else if isLocallyDefined name then  -- Don't bring in decls from
 569                                         -- the renamed module's own interface file
 570         addWarnRn (importDeclWarn name) `thenRn_`
 571         returnRn AlreadySlurped
 572
 573     else if isWiredInName name then
 574         -- When we find a wired-in name we must load its
 575         -- home module so that we find any instance decls therein
 576         loadHomeInterface doc name      `thenRn_`
 577         returnRn WiredIn
 578
 579     else getNonWiredInDecl name
 580   where
 581     doc = ptext SLIT("need home module for wired in thing") <+> ppr name
 582
 583
 584 {-      I don't think this is necessary any more; SLPJ May 00
 585     load_home name
 586         | name `elemNameSet` source_binders = returnRn ()
 587                 -- When compiling the prelude, a wired-in thing may
 588                 -- be defined in this module, in which case we don't
 589                 -- want to load its home module!
 590                 -- Using 'isLocallyDefined' doesn't work because some of
 591                 -- the free variables returned are simply 'listTyCon_Name',
 592                 -- with a system provenance.  We could look them up every time
 593                 -- but that seems a waste.
 594         | otherwise = loadHomeInterface doc name        `thenRn_`
 595                       returnRn ()
 596 -}
 597
 598 getNonWiredInDecl :: Name -> RnMG ImportDeclResult
 599 getNonWiredInDecl needed_name
 600   = traceRn doc_str                             `thenRn_`
 601     loadHomeInterface doc_str needed_name       `thenRn` \ ifaces ->
 602     case lookupNameEnv (iDecls ifaces) needed_name of
 603
 604       Just (version, avail, is_tycon_name, decl@(_, TyClD (TyData DataType _ _ _ _ ncons _ _ _ _ _)))
 605         -- This case deals with deferred import of algebraic data types
 606
 607         |  not opt_NoPruneTyDecls
 608
 609         && (opt_IgnoreIfacePragmas || ncons > 1)
 610                 -- We only defer if imported interface pragmas are ingored
 611                 -- or if it's not a product type.
 612                 -- Sole reason: The wrapper for a strict function may need to look
 613                 -- inside its arg, and hence need to see its arg type's constructors.
 614
 615         && not (getUnique tycon_name `elem` cCallishTyKeys)
 616                 -- Never defer ccall types; we have to unbox them,
 617                 -- and importing them does no harm
 618
 619         ->      -- OK, so we're importing a deferrable data type
 620             if needed_name == tycon_name then
 621                 -- The needed_name is the TyCon of a data type decl
 622                 -- Record that it's slurped, put it in the deferred set
 623                 -- and don't return a declaration at all
 624                 setIfacesRn (recordSlurp (ifaces {iDeferred = iDeferred ifaces
 625                                                               `addOneToNameSet` tycon_name})
 626                                          version (AvailTC needed_name [needed_name]))   `thenRn_`
 627                 returnRn Deferred
 628             else
 629                 -- The needed name is a constructor of a data type decl,
 630                 -- getting a constructor, so remove the TyCon from the deferred set
 631                 -- (if it's there) and return the full declaration
 632                  setIfacesRn (recordSlurp (ifaces {iDeferred = iDeferred ifaces
 633                                                                `delFromNameSet` tycon_name})
 634                                     version avail)      `thenRn_`
 635                  returnRn (HereItIs decl)
 636         where
 637            tycon_name = availName avail
 638
 639       Just (version,avail,_,decl)
 640         -> setIfacesRn (recordSlurp ifaces version avail)       `thenRn_`
 641            returnRn (HereItIs decl)
 642
 643       Nothing
 644         -> addErrRn (getDeclErr needed_name)    `thenRn_`
 645            returnRn AlreadySlurped
 646   where
 647      doc_str = ptext SLIT("need decl for") <+> ppr needed_name
 648
 649 getDeferredDecls :: RnMG [(Module, RdrNameHsDecl)]
 650 getDeferredDecls
 651   = getIfacesRn         `thenRn` \ ifaces ->
 652     let
 653         decls_map           = iDecls ifaces
 654         deferred_names      = nameSetToList (iDeferred ifaces)
 655         get_abstract_decl n = case lookupNameEnv decls_map n of
 656                                  Just (_, _, _, decl) -> decl
 657     in
 658     traceRn (sep [text "getDeferredDecls", nest 4 (fsep (map ppr deferred_names))])     `thenRn_`
 659     returnRn (map get_abstract_decl deferred_names)
 660 \end{code}
 661
 662 @getWiredInDecl@ maps a wired-in @Name@ to what it makes available.
 663 It behaves exactly as if the wired in decl were actually in an interface file.
 664 Specifically,
 665 \begin{itemize}
 666 \item   if the wired-in name is a data type constructor or a data constructor,
 667         it brings in the type constructor and all the data constructors; and
 668         marks as ``occurrences'' any free vars of the data con.
 669
 670 \item   similarly for synonum type constructor
 671
 672 \item   if the wired-in name is another wired-in Id, it marks as ``occurrences''
 673         the free vars of the Id's type.
 674
 675 \item   it loads the interface file for the wired-in thing for the
 676         sole purpose of making sure that its instance declarations are available
 677 \end{itemize}
 678 All this is necessary so that we know all types that are ``in play'', so
 679 that we know just what instances to bring into scope.
 680
 681
 682
 683
 684 %*********************************************************
 685 %*                                                      *
 686 \subsection{Getting what a module exports}
 687 %*                                                      *
 688 %*********************************************************
 689
 690 @getInterfaceExports@ is called only for directly-imported modules.
 691
 692 \begin{code}
 693 getInterfaceExports :: ModuleName -> WhereFrom -> RnMG (Module, Avails)
 694 getInterfaceExports mod_name from
 695   = loadInterface doc_str mod_name from `thenRn` \ ifaces ->
 696     case lookupFM (iImpModInfo ifaces) mod_name of
 697         Just (_, _, Just (mod, _, _, _, _, avails)) -> returnRn (mod, avails)
 698         -- loadInterface always puts something in the map
 699         -- even if it's a fake
 700   where
 701     doc_str = sep [pprModuleName mod_name, ptext SLIT("is directly imported")]
 702 \end{code}
 703
 704
 705 %*********************************************************
 706 %*                                                      *
 707 \subsection{Instance declarations are handled specially}
 708 %*                                                      *
 709 %*********************************************************
 710
 711 \begin{code}
 712 getImportedInstDecls :: NameSet -> RnMG [(Module,RdrNameHsDecl)]
 713 getImportedInstDecls gates
 714   =     -- First, load any orphan-instance modules that aren't aready loaded
 715         -- Orphan-instance modules are recorded in the module dependecnies
 716     getIfacesRn                                         `thenRn` \ ifaces ->
 717     let
 718         orphan_mods =
 719           [mod | (mod, (True, _, Nothing)) <- fmToList (iImpModInfo ifaces)]
 720     in
 721     loadOrphanModules orphan_mods                       `thenRn_`
 722
 723         -- Now we're ready to grab the instance declarations
 724         -- Find the un-gated ones and return them,
 725         -- removing them from the bag kept in Ifaces
 726     getIfacesRn                                         `thenRn` \ ifaces ->
 727     let
 728         (decls, new_insts) = selectGated gates (iInsts ifaces)
 729     in
 730     setIfacesRn (ifaces { iInsts = new_insts })         `thenRn_`
 731
 732     traceRn (sep [text "getImportedInstDecls:",
 733                   nest 4 (fsep (map ppr gate_list)),
 734                   text "Slurped" <+> int (length decls) <+> text "instance declarations",
 735                   nest 4 (vcat (map ppr_brief_inst_decl decls))])       `thenRn_`
 736     returnRn decls
 737   where
 738     gate_list      = nameSetToList gates
 739
 740 ppr_brief_inst_decl (mod, InstD (InstDecl inst_ty _ _ _ _))
 741   = case inst_ty of
 742         HsForAllTy _ _ tau -> ppr tau
 743         other              -> ppr inst_ty
 744
 745 getImportedRules :: RnMG [(Module,RdrNameHsDecl)]
 746 getImportedRules
 747   | opt_IgnoreIfacePragmas = returnRn []
 748   | otherwise
 749   = getIfacesRn         `thenRn` \ ifaces ->
 750     let
 751         gates              = iSlurp ifaces      -- Anything at all that's been slurped
 752         rules              = iRules ifaces
 753         (decls, new_rules) = selectGated gates rules
 754     in
 755     if null decls then
 756         returnRn []
 757     else
 758     setIfacesRn (ifaces { iRules = new_rules })              `thenRn_`
 759     traceRn (sep [text "getImportedRules:",
 760                   text "Slurped" <+> int (length decls) <+> text "rules"])   `thenRn_`
 761     returnRn decls
 762
 763 selectGated gates decl_bag
 764         -- Select only those decls whose gates are *all* in 'gates'
 765 #ifdef DEBUG
 766   | opt_NoPruneDecls    -- Just to try the effect of not gating at all
 767   = (foldrBag (\ (_,d) ds -> d:ds) [] decl_bag, emptyBag)       -- Grab them all
 768
 769   | otherwise
 770 #endif
 771   = foldrBag select ([], emptyBag) decl_bag
 772   where
 773     select (reqd, decl) (yes, no)
 774         | isEmptyNameSet (reqd `minusNameSet` gates) = (decl:yes, no)
 775         | otherwise                                  = (yes,      (reqd,decl) `consBag` no)
 776
 777 lookupFixityRn :: Name -> RnMS Fixity
 778 lookupFixityRn name
 779   | isLocallyDefined name
 780   = getFixityEnv                        `thenRn` \ local_fix_env ->
 781     returnRn (lookupFixity local_fix_env name)
 782
 783   | otherwise   -- Imported
 784       -- For imported names, we have to get their fixities by doing a loadHomeInterface,
 785       -- and consulting the Ifaces that comes back from that, because the interface
 786       -- file for the Name might not have been loaded yet.  Why not?  Suppose you import module A,
 787       -- which exports a function 'f', which is defined in module B.  Then B isn't loaded
 788       -- right away (after all, it's possible that nothing from B will be used).
 789       -- When we come across a use of 'f', we need to know its fixity, and it's then,
 790       -- and only then, that we load B.hi.  That is what's happening here.
 791   = loadHomeInterface doc name          `thenRn` \ ifaces ->
 792     returnRn (lookupFixity (iFixes ifaces) name)
 793   where
 794     doc = ptext SLIT("Checking fixity for") <+> ppr name
 795 \end{code}
 796
 797
 798 %*********************************************************
 799 %*                                                      *
 800 \subsection{Keeping track of what we've slurped, and version numbers}
 801 %*                                                      *
 802 %*********************************************************
 803
 804 getImportVersions figures out what the ``usage information'' for this
 805 moudule is; that is, what it must record in its interface file as the
 806 things it uses.  It records:
 807
 808 \begin{itemize}
 809 \item   (a) anything reachable from its body code
 810 \item   (b) any module exported with a @module Foo@
 811 \item   (c) anything reachable from an exported item
 812 \end{itemize}
 813
 814 Why (b)?  Because if @Foo@ changes then this module's export list
 815 will change, so we must recompile this module at least as far as
 816 making a new interface file --- but in practice that means complete
 817 recompilation.
 818
 819 Why (c)?  Consider this:
 820 \begin{verbatim}
 821         module A( f, g ) where  |       module B( f ) where
 822           import B( f )         |         f = h 3
 823           g = ...               |         h = ...
 824 \end{verbatim}
 825
 826 Here, @B.f@ isn't used in A.  Should we nevertheless record @B.f@ in
 827 @A@'s usages?  Our idea is that we aren't going to touch A.hi if it is
 828 *identical* to what it was before.  If anything about @B.f@ changes
 829 than anyone who imports @A@ should be recompiled in case they use
 830 @B.f@ (they'll get an early exit if they don't).  So, if anything
 831 about @B.f@ changes we'd better make sure that something in A.hi
 832 changes, and the convenient way to do that is to record the version
 833 number @B.f@ in A.hi in the usage list.  If B.f changes that'll force a
 834 complete recompiation of A, which is overkill but it's the only way to
 835 write a new, slightly different, A.hi.
 836
 837 But the example is tricker.  Even if @B.f@ doesn't change at all,
 838 @B.h@ may do so, and this change may not be reflected in @f@'s version
 839 number.  But with -O, a module that imports A must be recompiled if
 840 @B.h@ changes!  So A must record a dependency on @B.h@.  So we treat
 841 the occurrence of @B.f@ in the export list *just as if* it were in the
 842 code of A, and thereby haul in all the stuff reachable from it.
 843
 844 [NB: If B was compiled with -O, but A isn't, we should really *still*
 845 haul in all the unfoldings for B, in case the module that imports A *is*
 846 compiled with -O.  I think this is the case.]
 847
 848 Even if B is used at all we get a usage line for B
 849         import B <n> :: ... ;
 850 in A.hi, to record the fact that A does import B.  This is used to decide
 851 to look to look for B.hi rather than B.hi-boot when compiling a module that
 852 imports A.  This line says that A imports B, but uses nothing in it.
 853 So we'll get an early bale-out when compiling A if B's version changes.
 854
 855 \begin{code}
 856 mkImportExportInfo :: ModuleName                        -- Name of this module
 857                    -> Avails                            -- Info about exports
 858                    -> Maybe [RdrNameIE]                 -- The export header
 859                    -> RnMG ([ExportItem],               -- Export info for iface file; sorted
 860                             [ImportVersion OccName])    -- Import info for iface file; sorted
 861                         -- Both results are sorted into canonical order to
 862                         -- reduce needless wobbling of interface files
 863
 864 mkImportExportInfo this_mod export_avails exports
 865   = getIfacesRn                                 `thenRn` \ ifaces ->
 866     let
 867         export_all_mods = case exports of
 868                                 Nothing -> []
 869                                 Just es -> [mod | IEModuleContents mod <- es,
 870                                                   mod /= this_mod]
 871
 872         mod_map   = iImpModInfo ifaces
 873         imp_names = iVSlurp     ifaces
 874
 875         -- mv_map groups together all the things imported from a particular module.
 876         mv_map :: FiniteMap ModuleName [(OccName,Version)]
 877         mv_map = foldr add_mv emptyFM imp_names
 878
 879         add_mv (name, version) mv_map = addItem mv_map (moduleName (nameModule name))
 880                                                        (nameOccName name, version)
 881
 882         -- Build the result list by adding info for each module.
 883         -- For (a) a library module, we don't record it at all unless it contains orphans
 884         --         (We must never lose track of orphans.)
 885         --
 886         --     (b) a source-imported module, don't record the dependency at all
 887         --
 888         -- (b) may seem a bit strange.  The idea is that the usages in a .hi file records
 889         -- *all* the module's dependencies other than the loop-breakers.  We use
 890         -- this info in findAndReadInterface to decide whether to look for a .hi file or
 891         -- a .hi-boot file.
 892         --
 893         -- This means we won't track version changes, or orphans, from .hi-boot files.
 894         -- The former is potentially rather bad news.  It could be fixed by recording
 895         -- whether something is a boot file along with the usage info for it, but
 896         -- I can't be bothered just now.
 897
 898         mk_imp_info mod_name (has_orphans, is_boot, contents) so_far
 899            | mod_name == this_mod       -- Check if M appears in the set of modules 'below' M
 900                                         -- This seems like a convenient place to check
 901            = WARN( not is_boot, ptext SLIT("Wierd:") <+> ppr this_mod <+>
 902                                 ptext SLIT("imports itself (perhaps indirectly)") )
 903              so_far
 904
 905            | otherwise
 906            = let
 907                 go_for_it exports = (mod_name, has_orphans, is_boot, exports)
 908                                     : so_far
 909              in
 910              case contents of
 911                 Nothing ->      -- We didn't even open the interface
 912                         -- This happens when a module, Foo, that we explicitly imported has
 913                         -- 'import Baz' in its interface file, recording that Baz is below
 914                         -- Foo in the module dependency hierarchy.  We want to propagate this
 915                         -- information.  The Nothing says that we didn't even open the interface
 916                         -- file but we must still propagate the dependeny info.
 917                         -- The module in question must be a local module (in the same package)
 918                    go_for_it NothingAtAll
 919
 920                 Just (mod, mod_vers, fix_vers, rule_vers, how_imported, _)
 921                    |  is_sys_import && is_lib_module && not has_orphans
 922                    -> so_far
 923
 924                    |  is_lib_module                     -- Record the module but not detailed
 925                    || mod_name `elem` export_all_mods   -- version information for the imports
 926                    -> go_for_it (Everything mod_vers)
 927
 928                    |  otherwise
 929                    -> case lookupFM mv_map mod_name of
 930                         Just whats_imported -> go_for_it (Specifically mod_vers fix_vers rule_vers
 931                                                                        (sortImport whats_imported))
 932                         Nothing             -> go_for_it NothingAtAll
 933                                                 -- This happens if you have
 934                                                 --      import Foo
 935                                                 -- but don't actually *use* anything from Foo
 936                                                 -- In which case record an empty dependency list
 937                    where
 938                      is_lib_module = not (isLocalModule mod)
 939                      is_sys_import = case how_imported of
 940                                         ImportBySystem -> True
 941                                         other          -> False
 942
 943
 944         import_info = foldFM mk_imp_info [] mod_map
 945
 946         -- Sort exports into groups by module
 947         export_fm :: FiniteMap ModuleName [RdrAvailInfo]
 948         export_fm = foldr insert emptyFM export_avails
 949
 950         insert avail efm = addItem efm (moduleName (nameModule (availName avail)))
 951                                        (rdrAvailInfo avail)
 952
 953         export_info = [(m, sortExport as) | (m,as) <- fmToList export_fm]
 954     in
 955     traceRn (text "Modules in Ifaces: " <+> fsep (map ppr (keysFM mod_map)))    `thenRn_`
 956     returnRn (export_info, import_info)
 957
 958
 959 addItem :: FiniteMap ModuleName [a] -> ModuleName -> a -> FiniteMap ModuleName [a]
 960 addItem fm mod x = addToFM_C add_item fm mod [x]
 961                  where
 962                    add_item xs _ = x:xs
 963
 964 sortImport :: [(OccName,Version)] -> [(OccName,Version)]
 965         -- Make the usage lists appear in canonical order
 966 sortImport vs = sortLt lt vs
 967               where
 968                 lt (n1,v1) (n2,v2) = n1 < n2
 969
 970 sortExport :: [RdrAvailInfo] -> [RdrAvailInfo]
 971 sortExport as = sortLt lt as
 972               where
 973                 lt a1 a2 = availName a1 < availName a2
 974 \end{code}
 975
 976 \begin{code}
 977 getSlurped
 978   = getIfacesRn         `thenRn` \ ifaces ->
 979     returnRn (iSlurp ifaces)
 980
 981 recordSlurp ifaces@(Ifaces { iSlurp = slurped_names, iVSlurp = imp_names })
 982             version avail
 983   = let
 984         new_slurped_names = addAvailToNameSet slurped_names avail
 985         new_imp_names = (availName avail, version) : imp_names
 986     in
 987     ifaces { iSlurp  = new_slurped_names, iVSlurp = new_imp_names }
 988
 989 recordLocalSlurps local_avails
 990   = getIfacesRn         `thenRn` \ ifaces ->
 991     let
 992         new_slurped_names = foldl addAvailToNameSet (iSlurp ifaces) local_avails
 993     in
 994     setIfacesRn (ifaces { iSlurp  = new_slurped_names })
 995 \end{code}
 996
 997
 998 %*********************************************************
 999 %*                                                      *
1000 \subsection{Getting binders out of a declaration}
1001 %*                                                      *
1002 %*********************************************************
1003
1004 @getDeclBinders@ returns the names for a @RdrNameHsDecl@.
1005 It's used for both source code (from @availsFromDecl@) and interface files
1006 (from @loadDecl@).
1007
1008 It doesn't deal with source-code specific things: @ValD@, @DefD@.  They
1009 are handled by the sourc-code specific stuff in @RnNames@.
1010
1011 \begin{code}
1012 getDeclBinders :: (RdrName -> SrcLoc -> RnM d Name)     -- New-name function
1013                 -> RdrNameHsDecl
1014                 -> RnM d (Maybe AvailInfo)
1015
1016 getDeclBinders new_name (TyClD (TyData _ _ tycon _ condecls _ _ _ src_loc _ _))
1017   = new_name tycon src_loc                      `thenRn` \ tycon_name ->
1018     getConFieldNames new_name condecls          `thenRn` \ sub_names ->
1019     returnRn (Just (AvailTC tycon_name (tycon_name : nub sub_names)))
1020         -- The "nub" is because getConFieldNames can legitimately return duplicates,
1021         -- when a record declaration has the same field in multiple constructors
1022
1023 getDeclBinders new_name (TyClD (TySynonym tycon _ _ src_loc))
1024   = new_name tycon src_loc              `thenRn` \ tycon_name ->
1025     returnRn (Just (AvailTC tycon_name [tycon_name]))
1026
1027 getDeclBinders new_name (TyClD (ClassDecl _ cname _ _ sigs _ _ _ src_loc))
1028   = new_name cname src_loc                      `thenRn` \ class_name ->
1029
1030         -- Record the names for the class ops
1031     let
1032         -- just want class-op sigs
1033         op_sigs = filter isClassOpSig sigs
1034     in
1035     mapRn (getClassOpNames new_name) op_sigs    `thenRn` \ sub_names ->
1036
1037     returnRn (Just (AvailTC class_name (class_name : sub_names)))
1038
1039 getDeclBinders new_name (SigD (IfaceSig var ty prags src_loc))
1040   = new_name var src_loc                        `thenRn` \ var_name ->
1041     returnRn (Just (Avail var_name))
1042
1043 getDeclBinders new_name (FixD _)    = returnRn Nothing
1044 getDeclBinders new_name (DeprecD _) = returnRn Nothing
1045
1046     -- foreign declarations
1047 getDeclBinders new_name (ForD (ForeignDecl nm kind _ dyn _ loc))
1048   | binds_haskell_name kind dyn
1049   = new_name nm loc                 `thenRn` \ name ->
1050     returnRn (Just (Avail name))
1051
1052   | otherwise           -- a foreign export
1053   = lookupOrigName nm `thenRn_`
1054     returnRn Nothing
1055
1056 getDeclBinders new_name (DefD _)  = returnRn Nothing
1057 getDeclBinders new_name (InstD _) = returnRn Nothing
1058 getDeclBinders new_name (RuleD _) = returnRn Nothing
1059
1060 binds_haskell_name (FoImport _) _   = True
1061 binds_haskell_name FoLabel      _   = True
1062 binds_haskell_name FoExport  ext_nm = isDynamicExtName ext_nm
1063
1064 ----------------
1065 getConFieldNames new_name (ConDecl con _ _ _ (RecCon fielddecls) src_loc : rest)
1066   = mapRn (\n -> new_name n src_loc) (con:fields)       `thenRn` \ cfs ->
1067     getConFieldNames new_name rest                      `thenRn` \ ns  ->
1068     returnRn (cfs ++ ns)
1069   where
1070     fields = concat (map fst fielddecls)
1071
1072 getConFieldNames new_name (ConDecl con _ _ _ condecl src_loc : rest)
1073   = new_name con src_loc                `thenRn` \ n ->
1074     getConFieldNames new_name rest      `thenRn` \ ns ->
1075     returnRn (n : ns)
1076
1077 getConFieldNames new_name [] = returnRn []
1078
1079 getClassOpNames new_name (ClassOpSig op _ _ src_loc) = new_name op src_loc
1080 \end{code}
1081
1082 @getDeclSysBinders@ gets the implicit binders introduced by a decl.
1083 A the moment that's just the tycon and datacon that come with a class decl.
1084 They aren't returned by @getDeclBinders@ because they aren't in scope;
1085 but they {\em should} be put into the @DeclsMap@ of this module.
1086
1087 Note that this excludes the default-method names of a class decl,
1088 and the dict fun of an instance decl, because both of these have
1089 bindings of their own elsewhere.
1090
1091 \begin{code}
1092 getDeclSysBinders new_name (TyClD (ClassDecl _ cname _ _ sigs _ _ names
1093                                    src_loc))
1094   = sequenceRn [new_name n src_loc | n <- names]
1095
1096 getDeclSysBinders new_name (TyClD (TyData _ _ _ _ cons _ _ _ _ _ _))
1097   = sequenceRn [new_name wkr_name src_loc | ConDecl _ wkr_name _ _ _ src_loc <- cons]
1098
1099 getDeclSysBinders new_name other_decl
1100   = returnRn []
1101 \end{code}
1102
1103 %*********************************************************
1104 %*                                                      *
1105 \subsection{Reading an interface file}
1106 %*                                                      *
1107 %*********************************************************
1108
1109 \begin{code}
1110 findAndReadIface :: SDoc -> ModuleName
1111                  -> IsBootInterface     -- True  <=> Look for a .hi-boot file
1112                                         -- False <=> Look for .hi file
1113                  -> RnM d (Either Message ParsedIface)
1114         -- Nothing <=> file not found, or unreadable, or illegible
1115         -- Just x  <=> successfully found and parsed
1116
1117 findAndReadIface doc_str mod_name hi_boot_file
1118   = traceRn trace_msg                   `thenRn_`
1119       -- we keep two maps for interface files,
1120       -- one for 'normal' ones, the other for .hi-boot files,
1121       -- hence the need to signal which kind we're interested.
1122
1123     --getHiMaps                 `thenRn` \ (search_path, hi_map, hiboot_map) ->
1124     let
1125         bomb = panic "findAndReadInterface: hi_maps: FIXME"
1126         search_path = panic "findAndReadInterface: search_path: FIXME"
1127         relevant_map | hi_boot_file = bomb --hiboot_map
1128                      | otherwise    = bomb --hi_map
1129     in
1130     case lookupFM relevant_map mod_name of
1131         -- Found the file
1132       Just fpath -> traceRn (ptext SLIT("...reading from") <+> text fpath)      `thenRn_`
1133                     readIface mod_name fpath
1134
1135         -- Can't find it
1136       Nothing    -> traceRn (ptext SLIT("...not found"))        `thenRn_`
1137                     returnRn (Left (noIfaceErr mod_name hi_boot_file search_path))
1138
1139   where
1140     trace_msg = sep [hsep [ptext SLIT("Reading"),
1141                            if hi_boot_file then ptext SLIT("[boot]") else empty,
1142                            ptext SLIT("interface for"),
1143                            pprModuleName mod_name <> semi],
1144                      nest 4 (ptext SLIT("reason:") <+> doc_str)]
1145 \end{code}
1146
1147 @readIface@ tries just the one file.
1148
1149 \begin{code}
1150 readIface :: ModuleName -> String -> RnM d (Either Message ParsedIface)
1151         -- Nothing <=> file not found, or unreadable, or illegible
1152         -- Just x  <=> successfully found and parsed
1153 readIface wanted_mod file_path
1154   = ioToRnM (hGetStringBuffer False file_path)       `thenRn` \ read_result ->
1155     case read_result of
1156         Right contents    ->
1157              case parseIface contents
1158                         PState{ bol = 0#, atbol = 1#,
1159                                 context = [],
1160                                 glasgow_exts = 1#,
1161                                 loc = mkSrcLoc (mkFastString file_path) 1 } of
1162                   POk _  (PIface iface) ->
1163                       warnCheckRn (read_mod == wanted_mod)
1164                                   (hiModuleNameMismatchWarn wanted_mod read_mod) `thenRn_`
1165                       returnRn (Right iface)
1166                     where
1167                       read_mod = moduleName (pi_mod iface)
1168
1169                   PFailed err   -> bale_out err
1170                   parse_result  -> bale_out empty
1171                         -- This last case can happen if the interface file is (say) empty
1172                         -- in which case the parser thinks it looks like an IdInfo or
1173                         -- something like that.  Just an artefact of the fact that the
1174                         -- parser is used for several purposes at once.
1175
1176         Left io_err -> bale_out (text (show io_err))
1177   where
1178     bale_out err = returnRn (Left (badIfaceFile file_path err))
1179 \end{code}
1180
1181 %*********************************************************
1182 %*                                                       *
1183 \subsection{Errors}
1184 %*                                                       *
1185 %*********************************************************
1186
1187 \begin{code}
1188 noIfaceErr mod_name boot_file search_path
1189   = vcat [ptext SLIT("Could not find interface file for") <+> quotes (pprModuleName mod_name),
1190           ptext SLIT("in the directories") <+>
1191                         -- \& to avoid cpp interpreting this string as a
1192                         -- comment starter with a pre-4.06 mkdependHS --SDM
1193                 vcat [ text dir <> text "/\&*" <> pp_suffix suffix
1194                      | (dir,suffix) <- search_path]
1195         ]
1196   where
1197     pp_suffix suffix | boot_file = ptext SLIT(".hi-boot")
1198                      | otherwise = text suffix
1199
1200 badIfaceFile file err
1201   = vcat [ptext SLIT("Bad interface file:") <+> text file,
1202           nest 4 err]
1203
1204 getDeclErr name
1205   = vcat [ptext SLIT("Failed to find interface decl for") <+> quotes (ppr name),
1206           ptext SLIT("from module") <+> quotes (ppr (nameModule name))
1207          ]
1208
1209 importDeclWarn name
1210   = sep [ptext SLIT(
1211     "Compiler tried to import decl from interface file with same name as module."),
1212          ptext SLIT(
1213     "(possible cause: module name clashes with interface file already in scope.)")
1214         ] $$
1215     hsep [ptext SLIT("name:"), quotes (ppr name)]
1216
1217 warnRedundantSourceImport mod_name
1218   = ptext SLIT("Unnecessary {- SOURCE -} in the import of module")
1219           <+> quotes (pprModuleName mod_name)
1220
1221 hiModuleNameMismatchWarn :: ModuleName -> ModuleName  -> Message
1222 hiModuleNameMismatchWarn requested_mod read_mod =
1223     hsep [ ptext SLIT("Something is amiss; requested module name")
1224          , pprModuleName requested_mod
1225          , ptext SLIT("differs from name found in the interface file")
1226          , pprModuleName read_mod
1227          ]
1228
1229 \end{code}