compiler/typecheck/TcRnDriver.lhs

   1 %
   2 % (c) The University of Glasgow 2006
   3 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   4 %
   5 \section[TcModule]{Typechecking a whole module}
   6
   7 \begin{code}
   8 module TcRnDriver (
   9 #ifdef GHCI
  10         tcRnStmt, tcRnExpr, tcRnType,
  11         tcRnLookupRdrName,
  12         tcRnLookupName,
  13         tcRnGetInfo,
  14         getModuleExports,
  15 #endif
  16         tcRnModule,
  17         tcTopSrcDecls,
  18         tcRnExtCore
  19     ) where
  20
  21 #include "HsVersions.h"
  22
  23 import IO
  24 #ifdef GHCI
  25 import {-# SOURCE #-} TcSplice ( tcSpliceDecls )
  26 #endif
  27
  28 import DynFlags
  29 import StaticFlags
  30 import HsSyn
  31 import RdrHsSyn
  32
  33 import PrelNames
  34 import RdrName
  35 import TcHsSyn
  36 import TcExpr
  37 import TcRnMonad
  38 import TcType
  39 import Inst
  40 import FamInst
  41 import InstEnv
  42 import FamInstEnv
  43 import TcBinds
  44 import TcDefaults
  45 import TcEnv
  46 import TcRules
  47 import TcForeign
  48 import TcInstDcls
  49 import TcIface
  50 import MkIface
  51 import IfaceSyn
  52 import TcSimplify
  53 import TcTyClsDecls
  54 import LoadIface
  55 import RnNames
  56 import RnEnv
  57 import RnSource
  58 import RnHsDoc
  59 import PprCore
  60 import CoreSyn
  61 import ErrUtils
  62 import Id
  63 import Var
  64 import Module
  65 import UniqFM
  66 import Name
  67 import NameEnv
  68 import NameSet
  69 import TyCon
  70 import SrcLoc
  71 import HscTypes
  72 import ListSetOps
  73 import Outputable
  74
  75 #ifdef GHCI
  76 import Linker
  77 import DataCon
  78 import TcHsType
  79 import TcMType
  80 import TcMatches
  81 import TcGadt
  82 import RnTypes
  83 import RnExpr
  84 import IfaceEnv
  85 import MkId
  86 import TysWiredIn
  87 import IdInfo
  88 import {- Kind parts of -} Type
  89 import BasicTypes
  90 import Foreign.Ptr( Ptr )
  91 #endif
  92
  93 import FastString
  94 import Maybes
  95 import Util
  96 import Bag
  97
  98 import Control.Monad    ( unless )
  99 import Data.Maybe       ( isJust )
 100
 101 \end{code}
 102
 103
 104
 105 %************************************************************************
 106 %*                                                                      *
 107         Typecheck and rename a module
 108 %*                                                                      *
 109 %************************************************************************
 110
 111
 112 \begin{code}
 113 tcRnModule :: HscEnv
 114            -> HscSource
 115            -> Bool              -- True <=> save renamed syntax
 116            -> Located (HsModule RdrName)
 117            -> IO (Messages, Maybe TcGblEnv)
 118
 119 tcRnModule hsc_env hsc_src save_rn_syntax
 120          (L loc (HsModule maybe_mod export_ies
 121                           import_decls local_decls mod_deprec _
 122                           module_info maybe_doc))
 123  = do { showPass (hsc_dflags hsc_env) "Renamer/typechecker" ;
 124
 125    let { this_pkg = thisPackage (hsc_dflags hsc_env) ;
 126          this_mod = case maybe_mod of
 127                         Nothing  -> mAIN        -- 'module M where' is omitted
 128                         Just (L _ mod) -> mkModule this_pkg mod } ;
 129                                                 -- The normal case
 130
 131    initTc hsc_env hsc_src save_rn_syntax this_mod $
 132    setSrcSpan loc $
 133    do {         -- Deal with imports;
 134         tcg_env <- tcRnImports hsc_env this_mod import_decls ;
 135         setGblEnv tcg_env               $ do {
 136
 137                 -- Load the hi-boot interface for this module, if any
 138                 -- We do this now so that the boot_names can be passed
 139                 -- to tcTyAndClassDecls, because the boot_names are
 140                 -- automatically considered to be loop breakers
 141                 --
 142                 -- Do this *after* tcRnImports, so that we know whether
 143                 -- a module that we import imports us; and hence whether to
 144                 -- look for a hi-boot file
 145         boot_iface <- tcHiBootIface hsc_src this_mod ;
 146
 147                 -- Rename and type check the declarations
 148         traceRn (text "rn1a") ;
 149         tcg_env <- if isHsBoot hsc_src then
 150                         tcRnHsBootDecls local_decls
 151                    else
 152                         tcRnSrcDecls boot_iface local_decls ;
 153         setGblEnv tcg_env               $ do {
 154
 155                 -- Report the use of any deprecated things
 156                 -- We do this *before* processsing the export list so
 157                 -- that we don't bleat about re-exporting a deprecated
 158                 -- thing (especially via 'module Foo' export item)
 159                 -- That is, only uses in the *body* of the module are complained about
 160         traceRn (text "rn3") ;
 161         failIfErrsM ;   -- finishDeprecations crashes sometimes
 162                         -- as a result of typechecker repairs (e.g. unboundNames)
 163         tcg_env <- finishDeprecations (hsc_dflags hsc_env) mod_deprec tcg_env ;
 164
 165                 -- Process the export list
 166         tcg_env <- rnExports (isJust maybe_mod) export_ies tcg_env ;
 167         traceRn (text "rn4") ;
 168
 169         -- Compare the hi-boot iface (if any) with the real thing
 170         -- Must be done after processing the exports
 171         tcg_env <- checkHiBootIface tcg_env boot_iface ;
 172
 173         -- Make the new type env available to stuff slurped from interface files
 174         -- Must do this after checkHiBootIface, because the latter might add new
 175         -- bindings for boot_dfuns, which may be mentioned in imported unfoldings
 176         writeMutVar (tcg_type_env_var tcg_env) (tcg_type_env tcg_env) ;
 177
 178                 -- Rename the Haddock documentation
 179         tcg_env <- rnHaddock module_info maybe_doc tcg_env ;
 180
 181                 -- Report unused names
 182         reportUnusedNames export_ies tcg_env ;
 183
 184                 -- Dump output and return
 185         tcDump tcg_env ;
 186         return tcg_env
 187     }}}}
 188 \end{code}
 189
 190
 191 %************************************************************************
 192 %*                                                                      *
 193                 Import declarations
 194 %*                                                                      *
 195 %************************************************************************
 196
 197 \begin{code}
 198 tcRnImports :: HscEnv -> Module -> [LImportDecl RdrName] -> TcM TcGblEnv
 199 tcRnImports hsc_env this_mod import_decls
 200   = do  { (rn_imports, rdr_env, imports,hpc_info) <- rnImports import_decls ;
 201
 202         ; let { dep_mods :: ModuleNameEnv (ModuleName, IsBootInterface)
 203               ; dep_mods = imp_dep_mods imports
 204
 205                 -- We want instance declarations from all home-package
 206                 -- modules below this one, including boot modules, except
 207                 -- ourselves.  The 'except ourselves' is so that we don't
 208                 -- get the instances from this module's hs-boot file
 209               ; want_instances :: ModuleName -> Bool
 210               ; want_instances mod = mod `elemUFM` dep_mods
 211                                    && mod /= moduleName this_mod
 212               ; (home_insts, home_fam_insts) = hptInstances hsc_env
 213                                                             want_instances
 214               } ;
 215
 216                 -- Record boot-file info in the EPS, so that it's
 217                 -- visible to loadHiBootInterface in tcRnSrcDecls,
 218                 -- and any other incrementally-performed imports
 219         ; updateEps_ (\eps -> eps { eps_is_boot = dep_mods }) ;
 220
 221                 -- Update the gbl env
 222         ; updGblEnv ( \ gbl ->
 223             gbl {
 224               tcg_rdr_env      = plusOccEnv (tcg_rdr_env gbl) rdr_env,
 225               tcg_imports      = tcg_imports gbl `plusImportAvails` imports,
 226               tcg_rn_imports   = fmap (const rn_imports) (tcg_rn_imports gbl),
 227               tcg_inst_env     = extendInstEnvList (tcg_inst_env gbl) home_insts,
 228               tcg_fam_inst_env = extendFamInstEnvList (tcg_fam_inst_env gbl)
 229                                                       home_fam_insts,
 230               tcg_hpc          = hpc_info
 231             }) $ do {
 232
 233         ; traceRn (text "rn1" <+> ppr (imp_dep_mods imports))
 234                 -- Fail if there are any errors so far
 235                 -- The error printing (if needed) takes advantage
 236                 -- of the tcg_env we have now set
 237 --      ; traceIf (text "rdr_env: " <+> ppr rdr_env)
 238         ; failIfErrsM
 239
 240                 -- Load any orphan-module and family instance-module
 241                 -- interfaces, so that their rules and instance decls will be
 242                 -- found.
 243         ; loadOrphanModules (imp_orphs  imports) False
 244         ; loadOrphanModules (imp_finsts imports) True
 245
 246                 -- Check type-familily consistency
 247         ; traceRn (text "rn1: checking family instance consistency")
 248         ; let { dir_imp_mods = map (\ (mod, _, _) -> mod)
 249                              . moduleEnvElts
 250                              . imp_mods
 251                              $ imports }
 252         ; checkFamInstConsistency (imp_finsts imports) dir_imp_mods ;
 253
 254         ; getGblEnv } }
 255 \end{code}
 256
 257
 258 %************************************************************************
 259 %*                                                                      *
 260         Type-checking external-core modules
 261 %*                                                                      *
 262 %************************************************************************
 263
 264 \begin{code}
 265 tcRnExtCore :: HscEnv
 266             -> HsExtCore RdrName
 267             -> IO (Messages, Maybe ModGuts)
 268         -- Nothing => some error occurred
 269
 270 tcRnExtCore hsc_env (HsExtCore this_mod decls src_binds)
 271         -- The decls are IfaceDecls; all names are original names
 272  = do { showPass (hsc_dflags hsc_env) "Renamer/typechecker" ;
 273
 274    initTc hsc_env ExtCoreFile False this_mod $ do {
 275
 276    let { ldecls  = map noLoc decls } ;
 277
 278         -- Deal with the type declarations; first bring their stuff
 279         -- into scope, then rname them, then type check them
 280    tcg_env  <- importsFromLocalDecls (mkFakeGroup ldecls) ;
 281
 282    setGblEnv tcg_env $ do {
 283
 284    rn_decls <- rnTyClDecls ldecls ;
 285    failIfErrsM ;
 286
 287         -- Dump trace of renaming part
 288    rnDump (ppr rn_decls) ;
 289
 290         -- Typecheck them all together so that
 291         -- any mutually recursive types are done right
 292    tcg_env <- checkNoErrs (tcTyAndClassDecls emptyModDetails rn_decls) ;
 293         -- Make the new type env available to stuff slurped from interface files
 294
 295    setGblEnv tcg_env $ do {
 296
 297         -- Now the core bindings
 298    core_binds <- initIfaceExtCore (tcExtCoreBindings src_binds) ;
 299
 300         -- Wrap up
 301    let {
 302         bndrs      = bindersOfBinds core_binds ;
 303         my_exports = map (Avail . idName) bndrs ;
 304                 -- ToDo: export the data types also?
 305
 306         final_type_env = extendTypeEnvWithIds (tcg_type_env tcg_env) bndrs ;
 307
 308         mod_guts = ModGuts {    mg_module    = this_mod,
 309                                 mg_boot      = False,
 310                                 mg_usages    = [],              -- ToDo: compute usage
 311                                 mg_dir_imps  = [],              -- ??
 312                                 mg_deps      = noDependencies,  -- ??
 313                                 mg_exports   = my_exports,
 314                                 mg_types     = final_type_env,
 315                                 mg_insts     = tcg_insts tcg_env,
 316                                 mg_fam_insts = tcg_fam_insts tcg_env,
 317                                 mg_inst_env  = tcg_inst_env tcg_env,
 318                                 mg_fam_inst_env = tcg_fam_inst_env tcg_env,
 319                                 mg_rules     = [],
 320                                 mg_binds     = core_binds,
 321
 322                                 -- Stubs
 323                                 mg_rdr_env   = emptyGlobalRdrEnv,
 324                                 mg_fix_env   = emptyFixityEnv,
 325                                 mg_deprecs   = NoDeprecs,
 326                                 mg_foreign   = NoStubs,
 327                                 mg_hpc_info  = emptyHpcInfo False,
 328                                 mg_modBreaks = emptyModBreaks,
 329                                 mg_vect_info = noVectInfo
 330                     } } ;
 331
 332    tcCoreDump mod_guts ;
 333
 334    return mod_guts
 335    }}}}
 336
 337 mkFakeGroup decls -- Rather clumsy; lots of unused fields
 338   = emptyRdrGroup { hs_tyclds = decls }
 339 \end{code}
 340
 341
 342 %************************************************************************
 343 %*                                                                      *
 344         Type-checking the top level of a module
 345 %*                                                                      *
 346 %************************************************************************
 347
 348 \begin{code}
 349 tcRnSrcDecls :: ModDetails -> [LHsDecl RdrName] -> TcM TcGblEnv
 350         -- Returns the variables free in the decls
 351         -- Reason: solely to report unused imports and bindings
 352 tcRnSrcDecls boot_iface decls
 353  = do {         -- Do all the declarations
 354         (tc_envs, lie) <- getLIE $ tc_rn_src_decls boot_iface decls ;
 355
 356              --         Finish simplifying class constraints
 357              --
 358              -- tcSimplifyTop deals with constant or ambiguous InstIds.
 359              -- How could there be ambiguous ones?  They can only arise if a
 360              -- top-level decl falls under the monomorphism restriction
 361              -- and no subsequent decl instantiates its type.
 362              --
 363              -- We do this after checkMain, so that we use the type info
 364              -- thaat checkMain adds
 365              --
 366              -- We do it with both global and local env in scope:
 367              --  * the global env exposes the instances to tcSimplifyTop
 368              --  * the local env exposes the local Ids to tcSimplifyTop,
 369              --    so that we get better error messages (monomorphism restriction)
 370         traceTc (text "Tc8") ;
 371         inst_binds <- setEnvs tc_envs (tcSimplifyTop lie) ;
 372
 373             -- Backsubstitution.  This must be done last.
 374             -- Even tcSimplifyTop may do some unification.
 375         traceTc (text "Tc9") ;
 376         let { (tcg_env, _) = tc_envs
 377             ; TcGblEnv { tcg_type_env = type_env, tcg_binds = binds,
 378                          tcg_rules = rules, tcg_fords = fords } = tcg_env
 379             ; all_binds = binds `unionBags` inst_binds } ;
 380
 381         (bind_ids, binds', fords', rules') <- zonkTopDecls all_binds rules fords ;
 382
 383         let { final_type_env = extendTypeEnvWithIds type_env bind_ids
 384             ; tcg_env' = tcg_env { tcg_type_env = final_type_env,
 385                                    tcg_binds = binds',
 386                                    tcg_rules = rules',
 387                                    tcg_fords = fords' } } ;
 388
 389         return (tcg_env' { tcg_binds = tcg_binds tcg_env' })
 390    }
 391
 392 tc_rn_src_decls :: ModDetails -> [LHsDecl RdrName] -> TcM (TcGblEnv, TcLclEnv)
 393 -- Loops around dealing with each top level inter-splice group
 394 -- in turn, until it's dealt with the entire module
 395 tc_rn_src_decls boot_details ds
 396  = do { let { (first_group, group_tail) = findSplice ds } ;
 397                 -- If ds is [] we get ([], Nothing)
 398
 399         -- Deal with decls up to, but not including, the first splice
 400         (tcg_env, rn_decls) <- checkNoErrs $ rnTopSrcDecls first_group ;
 401                 -- checkNoErrs: stop if renaming fails
 402
 403         (tcg_env, tcl_env) <- setGblEnv tcg_env $
 404                               tcTopSrcDecls boot_details rn_decls ;
 405
 406         -- If there is no splice, we're nearly done
 407         setEnvs (tcg_env, tcl_env) $
 408         case group_tail of {
 409            Nothing -> do { tcg_env <- checkMain ;       -- Check for `main'
 410                            return (tcg_env, tcl_env)
 411                       } ;
 412
 413         -- If there's a splice, we must carry on
 414            Just (SpliceDecl splice_expr, rest_ds) -> do {
 415 #ifndef GHCI
 416         failWithTc (text "Can't do a top-level splice; need a bootstrapped compiler")
 417 #else
 418
 419         -- Rename the splice expression, and get its supporting decls
 420         (rn_splice_expr, splice_fvs) <- checkNoErrs (rnLExpr splice_expr) ;
 421                 -- checkNoErrs: don't typecheck if renaming failed
 422         rnDump (ppr rn_splice_expr) ;
 423
 424         -- Execute the splice
 425         spliced_decls <- tcSpliceDecls rn_splice_expr ;
 426
 427         -- Glue them on the front of the remaining decls and loop
 428         setGblEnv (tcg_env `addTcgDUs` usesOnly splice_fvs) $
 429         tc_rn_src_decls boot_details (spliced_decls ++ rest_ds)
 430 #endif /* GHCI */
 431     } } }
 432 \end{code}
 433
 434 %************************************************************************
 435 %*                                                                      *
 436         Compiling hs-boot source files, and
 437         comparing the hi-boot interface with the real thing
 438 %*                                                                      *
 439 %************************************************************************
 440
 441 \begin{code}
 442 tcRnHsBootDecls :: [LHsDecl RdrName] -> TcM TcGblEnv
 443 tcRnHsBootDecls decls
 444    = do { let { (first_group, group_tail) = findSplice decls }
 445
 446         ; case group_tail of
 447              Just stuff -> spliceInHsBootErr stuff
 448              Nothing    -> return ()
 449
 450                 -- Rename the declarations
 451         ; (tcg_env, rn_group) <- rnTopSrcDecls first_group
 452         ; setGblEnv tcg_env $ do {
 453
 454         -- Todo: check no foreign decls, no rules, no default decls
 455
 456                 -- Typecheck type/class decls
 457         ; traceTc (text "Tc2")
 458         ; let tycl_decls = hs_tyclds rn_group
 459         ; tcg_env <- checkNoErrs (tcTyAndClassDecls emptyModDetails tycl_decls)
 460         ; setGblEnv tcg_env     $ do {
 461
 462                 -- Typecheck instance decls
 463         ; traceTc (text "Tc3")
 464         ; (tcg_env, inst_infos, _deriv_binds)
 465             <- tcInstDecls1 tycl_decls (hs_instds rn_group) (hs_derivds rn_group)
 466         ; setGblEnv tcg_env     $ do {
 467
 468                 -- Typecheck value declarations
 469         ; traceTc (text "Tc5")
 470         ; val_ids <- tcHsBootSigs (hs_valds rn_group)
 471
 472                 -- Wrap up
 473                 -- No simplification or zonking to do
 474         ; traceTc (text "Tc7a")
 475         ; gbl_env <- getGblEnv
 476
 477                 -- Make the final type-env
 478                 -- Include the dfun_ids so that their type sigs
 479                 -- are written into the interface file
 480         ; let { type_env0 = tcg_type_env gbl_env
 481               ; type_env1 = extendTypeEnvWithIds type_env0 val_ids
 482               ; type_env2 = extendTypeEnvWithIds type_env1 dfun_ids
 483               ; dfun_ids = map iDFunId inst_infos }
 484         ; return (gbl_env { tcg_type_env = type_env2 })
 485    }}}}
 486
 487 spliceInHsBootErr (SpliceDecl (L loc _), _)
 488   = addErrAt loc (ptext SLIT("Splices are not allowed in hs-boot files"))
 489 \end{code}
 490
 491 Once we've typechecked the body of the module, we want to compare what
 492 we've found (gathered in a TypeEnv) with the hi-boot details (if any).
 493
 494 \begin{code}
 495 checkHiBootIface :: TcGblEnv -> ModDetails -> TcM TcGblEnv
 496 -- Compare the hi-boot file for this module (if there is one)
 497 -- with the type environment we've just come up with
 498 -- In the common case where there is no hi-boot file, the list
 499 -- of boot_names is empty.
 500 --
 501 -- The bindings we return give bindings for the dfuns defined in the
 502 -- hs-boot file, such as        $fbEqT = $fEqT
 503
 504 checkHiBootIface
 505         tcg_env@(TcGblEnv { tcg_src = hs_src, tcg_binds = binds,
 506                             tcg_insts = local_insts, tcg_fam_insts = local_fam_insts,
 507                             tcg_type_env = local_type_env, tcg_exports = local_exports })
 508         (ModDetails { md_insts = boot_insts, md_fam_insts = boot_fam_insts,
 509                       md_types = boot_type_env, md_exports = boot_exports })
 510   | isHsBoot hs_src     -- Current module is already a hs-boot file!
 511   = return tcg_env
 512
 513   | otherwise
 514   = do  { traceTc (text "checkHiBootIface" <+> (ppr boot_type_env $$ ppr boot_insts $$
 515                                 ppr boot_exports)) ;
 516
 517                 -- Check the exports of the boot module, one by one
 518         ; mapM_ check_export boot_exports
 519
 520                 -- Check instance declarations
 521         ; mb_dfun_prs <- mapM check_inst boot_insts
 522         ; let tcg_env' = tcg_env { tcg_binds    = binds `unionBags` dfun_binds,
 523                                    tcg_type_env = extendTypeEnvWithIds local_type_env boot_dfuns }
 524               dfun_prs   = catMaybes mb_dfun_prs
 525               boot_dfuns = map fst dfun_prs
 526               dfun_binds = listToBag [ noLoc $ VarBind boot_dfun (nlHsVar dfun)
 527                                      | (boot_dfun, dfun) <- dfun_prs ]
 528
 529                 -- Check for no family instances
 530         ; unless (null boot_fam_insts) $
 531             panic ("TcRnDriver.checkHiBootIface: Cannot handle family " ++
 532                    "instances in boot files yet...")
 533             -- FIXME: Why?  The actual comparison is not hard, but what would
 534             --        be the equivalent to the dfun bindings returned for class
 535             --        instances?  We can't easily equate tycons...
 536
 537         ; return tcg_env' }
 538   where
 539     check_export boot_avail     -- boot_avail is exported by the boot iface
 540       | name `elem` dfun_names = return ()
 541       | isWiredInName name     = return ()      -- No checking for wired-in names.  In particular,
 542                                                 -- 'error' is handled by a rather gross hack
 543                                                 -- (see comments in GHC.Err.hs-boot)
 544
 545         -- Check that the actual module exports the same thing
 546       | not (null missing_names)
 547       = addErrTc (missingBootThing (head missing_names) "exported by")
 548
 549         -- If the boot module does not *define* the thing, we are done
 550         -- (it simply re-exports it, and names match, so nothing further to do)
 551       | isNothing mb_boot_thing = return ()
 552
 553         -- Check that the actual module also defines the thing, and
 554         -- then compare the definitions
 555       | Just real_thing <- lookupTypeEnv local_type_env name
 556       = do { let boot_decl = tyThingToIfaceDecl (fromJust mb_boot_thing)
 557                  real_decl = tyThingToIfaceDecl real_thing
 558            ; checkTc (checkBootDecl boot_decl real_decl)
 559                      (bootMisMatch real_thing boot_decl real_decl) }
 560                 -- The easiest way to check compatibility is to convert to
 561                 -- iface syntax, where we already have good comparison functions
 562
 563       | otherwise
 564       = addErrTc (missingBootThing name "defined in")
 565       where
 566         name          = availName boot_avail
 567         mb_boot_thing = lookupTypeEnv boot_type_env name
 568         missing_names = case lookupNameEnv local_export_env name of
 569                           Nothing    -> [name]
 570                           Just avail -> availNames boot_avail `minusList` availNames avail
 571
 572     dfun_names = map getName boot_insts
 573
 574     local_export_env :: NameEnv AvailInfo
 575     local_export_env = availsToNameEnv local_exports
 576
 577     check_inst :: Instance -> TcM (Maybe (Id, Id))
 578         -- Returns a pair of the boot dfun in terms of the equivalent real dfun
 579     check_inst boot_inst
 580         = case [dfun | inst <- local_insts,
 581                        let dfun = instanceDFunId inst,
 582                        idType dfun `tcEqType` boot_inst_ty ] of
 583             [] -> do { addErrTc (instMisMatch boot_inst); return Nothing }
 584             (dfun:_) -> return (Just (local_boot_dfun, dfun))
 585         where
 586           boot_dfun = instanceDFunId boot_inst
 587           boot_inst_ty = idType boot_dfun
 588           local_boot_dfun = Id.mkExportedLocalId (idName boot_dfun) boot_inst_ty
 589
 590
 591 ----------------
 592 missingBootThing thing what
 593   = ppr thing <+> ptext SLIT("is exported by the hs-boot file, but not")
 594               <+> text what <+> ptext SLIT("the module")
 595
 596 bootMisMatch thing boot_decl real_decl
 597   = vcat [ppr thing <+> ptext SLIT("has conflicting definitions in the module and its hs-boot file"),
 598           ptext SLIT("Main module:") <+> ppr real_decl,
 599           ptext SLIT("Boot file:  ") <+> ppr boot_decl]
 600
 601 instMisMatch inst
 602   = hang (ppr inst)
 603        2 (ptext SLIT("is defined in the hs-boot file, but not in the module itself"))
 604 \end{code}
 605
 606
 607 %************************************************************************
 608 %*                                                                      *
 609         Type-checking the top level of a module
 610 %*                                                                      *
 611 %************************************************************************
 612
 613 tcRnGroup takes a bunch of top-level source-code declarations, and
 614  * renames them
 615  * gets supporting declarations from interface files
 616  * typechecks them
 617  * zonks them
 618  * and augments the TcGblEnv with the results
 619
 620 In Template Haskell it may be called repeatedly for each group of
 621 declarations.  It expects there to be an incoming TcGblEnv in the
 622 monad; it augments it and returns the new TcGblEnv.
 623
 624 \begin{code}
 625 ------------------------------------------------
 626 rnTopSrcDecls :: HsGroup RdrName -> TcM (TcGblEnv, HsGroup Name)
 627 rnTopSrcDecls group
 628  = do {         -- Bring top level binders into scope
 629         tcg_env <- importsFromLocalDecls group ;
 630         setGblEnv tcg_env $ do {
 631
 632         failIfErrsM ;   -- No point in continuing if (say) we have duplicate declarations
 633
 634                 -- Rename the source decls
 635         (tcg_env, rn_decls) <- rnSrcDecls group ;
 636         failIfErrsM ;
 637
 638                 -- save the renamed syntax, if we want it
 639         let { tcg_env'
 640                 | Just grp <- tcg_rn_decls tcg_env
 641                   = tcg_env{ tcg_rn_decls = Just (appendGroups grp rn_decls) }
 642                 | otherwise
 643                    = tcg_env };
 644
 645                 -- Dump trace of renaming part
 646         rnDump (ppr rn_decls) ;
 647
 648         return (tcg_env', rn_decls)
 649    }}
 650
 651 ------------------------------------------------
 652 tcTopSrcDecls :: ModDetails -> HsGroup Name -> TcM (TcGblEnv, TcLclEnv)
 653 tcTopSrcDecls boot_details
 654         (HsGroup { hs_tyclds = tycl_decls,
 655                    hs_instds = inst_decls,
 656                    hs_derivds = deriv_decls,
 657                    hs_fords  = foreign_decls,
 658                    hs_defds  = default_decls,
 659                    hs_ruleds = rule_decls,
 660                    hs_valds  = val_binds })
 661  = do {         -- Type-check the type and class decls, and all imported decls
 662                 -- The latter come in via tycl_decls
 663         traceTc (text "Tc2") ;
 664
 665         tcg_env <- checkNoErrs (tcTyAndClassDecls boot_details tycl_decls) ;
 666         -- tcTyAndClassDecls recovers internally, but if anything gave rise to
 667         -- an error we'd better stop now, to avoid a cascade
 668
 669         -- Make these type and class decls available to stuff slurped from interface files
 670         writeMutVar (tcg_type_env_var tcg_env) (tcg_type_env tcg_env) ;
 671
 672
 673         setGblEnv tcg_env       $ do {
 674                 -- Source-language instances, including derivings,
 675                 -- and import the supporting declarations
 676         traceTc (text "Tc3") ;
 677         (tcg_env, inst_infos, deriv_binds)
 678             <- tcInstDecls1 tycl_decls inst_decls deriv_decls;
 679         setGblEnv tcg_env       $ do {
 680
 681                 -- Foreign import declarations next.  No zonking necessary
 682                 -- here; we can tuck them straight into the global environment.
 683         traceTc (text "Tc4") ;
 684         (fi_ids, fi_decls) <- tcForeignImports foreign_decls ;
 685         tcExtendGlobalValEnv fi_ids     $ do {
 686
 687                 -- Default declarations
 688         traceTc (text "Tc4a") ;
 689         default_tys <- tcDefaults default_decls ;
 690         updGblEnv (\gbl -> gbl { tcg_default = default_tys }) $ do {
 691
 692                 -- Value declarations next
 693                 -- We also typecheck any extra binds that came out
 694                 -- of the "deriving" process (deriv_binds)
 695         traceTc (text "Tc5") ;
 696         (tc_val_binds,   tcl_env) <- tcTopBinds val_binds ;
 697         setLclTypeEnv tcl_env   $ do {
 698
 699                 -- Now GHC-generated derived bindings and generics.
 700                 -- Do not generate warnings from compiler-generated code.
 701         (tc_deriv_binds, tcl_env) <- discardWarnings $
 702                                  tcTopBinds deriv_binds ;
 703
 704                 -- Second pass over class and instance declarations,
 705         traceTc (text "Tc6") ;
 706         (inst_binds, tcl_env)     <- setLclTypeEnv tcl_env $ tcInstDecls2 tycl_decls inst_infos ;
 707         showLIE (text "after instDecls2") ;
 708
 709                 -- Foreign exports
 710                 -- They need to be zonked, so we return them
 711         traceTc (text "Tc7") ;
 712         (foe_binds, foe_decls) <- tcForeignExports foreign_decls ;
 713
 714                 -- Rules
 715         rules <- tcRules rule_decls ;
 716
 717                 -- Wrap up
 718         traceTc (text "Tc7a") ;
 719         tcg_env <- getGblEnv ;
 720         let { all_binds = tc_val_binds   `unionBags`
 721                           tc_deriv_binds `unionBags`
 722                           inst_binds     `unionBags`
 723                           foe_binds  ;
 724
 725                 -- Extend the GblEnv with the (as yet un-zonked)
 726                 -- bindings, rules, foreign decls
 727               tcg_env' = tcg_env {  tcg_binds = tcg_binds tcg_env `unionBags` all_binds,
 728                                     tcg_rules = tcg_rules tcg_env ++ rules,
 729                                     tcg_fords = tcg_fords tcg_env ++ foe_decls ++ fi_decls } } ;
 730         return (tcg_env', tcl_env)
 731     }}}}}}
 732 \end{code}
 733
 734
 735 %************************************************************************
 736 %*                                                                      *
 737         Checking for 'main'
 738 %*                                                                      *
 739 %************************************************************************
 740
 741 \begin{code}
 742 checkMain :: TcM TcGblEnv
 743 -- If we are in module Main, check that 'main' is defined.
 744 checkMain
 745   = do { tcg_env   <- getGblEnv ;
 746          dflags    <- getDOpts ;
 747          check_main dflags tcg_env
 748     }
 749
 750 check_main dflags tcg_env
 751  | mod /= main_mod
 752  = traceTc (text "checkMain not" <+> ppr main_mod <+> ppr mod) >>
 753    return tcg_env
 754
 755  | otherwise
 756  = do   { mb_main <- lookupSrcOcc_maybe main_fn
 757                 -- Check that 'main' is in scope
 758                 -- It might be imported from another module!
 759         ; case mb_main of {
 760              Nothing -> do { traceTc (text "checkMain fail" <+> ppr main_mod <+> ppr main_fn)
 761                            ; complain_no_main
 762                            ; return tcg_env } ;
 763              Just main_name -> do
 764
 765         { traceTc (text "checkMain found" <+> ppr main_mod <+> ppr main_fn)
 766         ; let { rhs = nlHsApp (nlHsVar runMainIOName) (nlHsVar main_name) }
 767                         -- :Main.main :: IO () = runMainIO main
 768
 769         ; (main_expr, ty) <- addErrCtxt mainCtxt                        $
 770                              setSrcSpan (srcLocSpan (getSrcLoc main_name)) $
 771                              tcInferRho rhs
 772
 773                 -- See Note [Root-main Id]
 774         ; let { root_main_name =  mkExternalName rootMainKey rOOT_MAIN
 775                                    (mkVarOccFS FSLIT("main"))
 776                                    (getSrcSpan main_name)
 777               ; root_main_id = Id.mkExportedLocalId root_main_name ty
 778               ; main_bind    = noLoc (VarBind root_main_id main_expr) }
 779
 780         ; return (tcg_env { tcg_binds = tcg_binds tcg_env
 781                                         `snocBag` main_bind,
 782                             tcg_dus   = tcg_dus tcg_env
 783                                         `plusDU` usesOnly (unitFV main_name)
 784                         -- Record the use of 'main', so that we don't
 785                         -- complain about it being defined but not used
 786                  })
 787     }}}
 788   where
 789     mod          = tcg_mod tcg_env
 790     main_mod     = mainModIs dflags
 791     main_is_flag = mainFunIs dflags
 792
 793     main_fn  = case main_is_flag of
 794                   Just fn -> mkRdrUnqual (mkVarOccFS (mkFastString fn))
 795                   Nothing -> main_RDR_Unqual
 796
 797     complain_no_main | ghcLink dflags == LinkInMemory = return ()
 798                      | otherwise = failWithTc noMainMsg
 799         -- In interactive mode, don't worry about the absence of 'main'
 800         -- In other modes, fail altogether, so that we don't go on
 801         -- and complain a second time when processing the export list.
 802
 803     mainCtxt  = ptext SLIT("When checking the type of the") <+> pp_main_fn
 804     noMainMsg = ptext SLIT("The") <+> pp_main_fn
 805                 <+> ptext SLIT("is not defined in module") <+> quotes (ppr main_mod)
 806     pp_main_fn | isJust main_is_flag = ptext SLIT("main function") <+> quotes (ppr main_fn)
 807                | otherwise           = ptext SLIT("function") <+> quotes (ppr main_fn)
 808 \end{code}
 809
 810 Note [Root-main Id]
 811 ~~~~~~~~~~~~~~~~~~~
 812 The function that the RTS invokes is always :Main.main, which we call
 813 root_main_id.  (Because GHC allows the user to have a module not
 814 called Main as the main module, we can't rely on the main function
 815 being called "Main.main".  That's why root_main_id has a fixed module
 816 ":Main".)
 817
 818 This is unusual: it's a LocalId whose Name has a Module from another
 819 module.  Tiresomely, we must filter it out again in MkIface, les we
 820 get two defns for 'main' in the interface file!
 821
 822
 823 %*********************************************************
 824 %*                                                       *
 825                 GHCi stuff
 826 %*                                                       *
 827 %*********************************************************
 828
 829 \begin{code}
 830 #ifdef GHCI
 831 setInteractiveContext :: HscEnv -> InteractiveContext -> TcRn a -> TcRn a
 832 setInteractiveContext hsc_env icxt thing_inside
 833   = let
 834         -- Initialise the tcg_inst_env with instances
 835         -- from all home modules.  This mimics the more selective
 836         -- call to hptInstances in tcRnModule
 837         dfuns = fst (hptInstances hsc_env (\mod -> True))
 838     in
 839     updGblEnv (\env -> env {
 840         tcg_rdr_env  = ic_rn_gbl_env icxt,
 841         tcg_inst_env = extendInstEnvList (tcg_inst_env env) dfuns }) $
 842
 843
 844     tcExtendGhciEnv (ic_tmp_ids icxt) $
 845         -- tcExtendGhciEnv does lots:
 846         --   - it extends the local type env (tcl_env) with the given Ids,
 847         --   - it extends the local rdr env (tcl_rdr) with the Names from
 848         --     the given Ids
 849         --   - it adds the free tyvars of the Ids to the tcl_tyvars
 850         --     set.
 851         --
 852         -- later ids in ic_tmp_ids must shadow earlier ones with the same
 853         -- OccName, and tcExtendIdEnv implements this behaviour.
 854
 855     do  { traceTc (text "setIC" <+> ppr (ic_tmp_ids icxt))
 856         ; thing_inside }
 857 \end{code}
 858
 859
 860 \begin{code}
 861 tcRnStmt :: HscEnv
 862          -> InteractiveContext
 863          -> LStmt RdrName
 864          -> IO (Maybe ([Id], LHsExpr Id))
 865                 -- The returned [Id] is the list of new Ids bound by
 866                 -- this statement.  It can be used to extend the
 867                 -- InteractiveContext via extendInteractiveContext.
 868                 --
 869                 -- The returned TypecheckedHsExpr is of type IO [ () ],
 870                 -- a list of the bound values, coerced to ().
 871
 872 tcRnStmt hsc_env ictxt rdr_stmt
 873   = initTcPrintErrors hsc_env iNTERACTIVE $
 874     setInteractiveContext hsc_env ictxt $ do {
 875
 876     -- Rename; use CmdLineMode because tcRnStmt is only used interactively
 877     (([rn_stmt], _), fvs) <- rnStmts DoExpr [rdr_stmt] (return ((), emptyFVs)) ;
 878     traceRn (text "tcRnStmt" <+> vcat [ppr rdr_stmt, ppr rn_stmt, ppr fvs]) ;
 879     failIfErrsM ;
 880
 881     -- The real work is done here
 882     (bound_ids, tc_expr) <- mkPlan rn_stmt ;
 883     zonked_expr <- zonkTopLExpr tc_expr ;
 884     zonked_ids  <- zonkTopBndrs bound_ids ;
 885
 886         -- None of the Ids should be of unboxed type, because we
 887         -- cast them all to HValues in the end!
 888     mappM bad_unboxed (filter (isUnLiftedType . idType) zonked_ids) ;
 889
 890     traceTc (text "tcs 1") ;
 891     let {       -- (a) Make all the bound ids "global" ids, now that
 892                 --     they're notionally top-level bindings.  This is
 893                 --     important: otherwise when we come to compile an expression
 894                 --     using these ids later, the byte code generator will consider
 895                 --     the occurrences to be free rather than global.
 896                 --
 897                 -- (b) Tidy their types; this is important, because :info may
 898                 --     ask to look at them, and :info expects the things it looks
 899                 --     up to have tidy types
 900         global_ids = map globaliseAndTidy zonked_ids ;
 901
 902 {- ---------------------------------------------
 903    At one stage I removed any shadowed bindings from the type_env;
 904    they are inaccessible but might, I suppose, cause a space leak if we leave them there.
 905    However, with Template Haskell they aren't necessarily inaccessible.  Consider this
 906    GHCi session
 907          Prelude> let f n = n * 2 :: Int
 908          Prelude> fName <- runQ [| f |]
 909          Prelude> $(return $ AppE fName (LitE (IntegerL 7)))
 910          14
 911          Prelude> let f n = n * 3 :: Int
 912          Prelude> $(return $ AppE fName (LitE (IntegerL 7)))
 913    In the last line we use 'fName', which resolves to the *first* 'f'
 914    in scope. If we delete it from the type env, GHCi crashes because
 915    it doesn't expect that.
 916
 917    Hence this code is commented out
 918
 919 -------------------------------------------------- -}
 920     } ;
 921
 922     dumpOptTcRn Opt_D_dump_tc
 923         (vcat [text "Bound Ids" <+> pprWithCommas ppr global_ids,
 924                text "Typechecked expr" <+> ppr zonked_expr]) ;
 925
 926     returnM (global_ids, zonked_expr)
 927     }
 928   where
 929     bad_unboxed id = addErr (sep [ptext SLIT("GHCi can't bind a variable of unlifted type:"),
 930                                   nest 2 (ppr id <+> dcolon <+> ppr (idType id))])
 931
 932 globaliseAndTidy :: Id -> Id
 933 globaliseAndTidy id
 934 -- Give the Id a Global Name, and tidy its type
 935   = Id.setIdType (globaliseId VanillaGlobal id) tidy_type
 936   where
 937     tidy_type = tidyTopType (idType id)
 938 \end{code}
 939
 940 Here is the grand plan, implemented in tcUserStmt
 941
 942         What you type                   The IO [HValue] that hscStmt returns
 943         -------------                   ------------------------------------
 944         let pat = expr          ==>     let pat = expr in return [coerce HVal x, coerce HVal y, ...]
 945                                         bindings: [x,y,...]
 946
 947         pat <- expr             ==>     expr >>= \ pat -> return [coerce HVal x, coerce HVal y, ...]
 948                                         bindings: [x,y,...]
 949
 950         expr (of IO type)       ==>     expr >>= \ it -> return [coerce HVal it]
 951           [NB: result not printed]      bindings: [it]
 952
 953         expr (of non-IO type,   ==>     let it = expr in print it >> return [coerce HVal it]
 954           result showable)              bindings: [it]
 955
 956         expr (of non-IO type,
 957           result not showable)  ==>     error
 958
 959
 960 \begin{code}
 961 ---------------------------
 962 type PlanResult = ([Id], LHsExpr Id)
 963 type Plan = TcM PlanResult
 964
 965 runPlans :: [Plan] -> TcM PlanResult
 966 -- Try the plans in order.  If one fails (by raising an exn), try the next.
 967 -- If one succeeds, take it.
 968 runPlans []     = panic "runPlans"
 969 runPlans [p]    = p
 970 runPlans (p:ps) = tryTcLIE_ (runPlans ps) p
 971
 972 --------------------
 973 mkPlan :: LStmt Name -> TcM PlanResult
 974 mkPlan (L loc (ExprStmt expr _ _))      -- An expression typed at the prompt
 975   = do  { uniq <- newUnique             -- is treated very specially
 976         ; let fresh_it  = itName uniq
 977               the_bind  = L loc $ mkFunBind (L loc fresh_it) matches
 978               matches   = [mkMatch [] expr emptyLocalBinds]
 979               let_stmt  = L loc $ LetStmt (HsValBinds (ValBindsOut [(NonRecursive,unitBag the_bind)] []))
 980               bind_stmt = L loc $ BindStmt (nlVarPat fresh_it) expr
 981                                            (HsVar bindIOName) noSyntaxExpr
 982               print_it  = L loc $ ExprStmt (nlHsApp (nlHsVar printName) (nlHsVar fresh_it))
 983                                            (HsVar thenIOName) placeHolderType
 984
 985         -- The plans are:
 986         --      [it <- e; print it]     but not if it::()
 987         --      [it <- e]
 988         --      [let it = e; print it]
 989         ; runPlans [    -- Plan A
 990                     do { stuff@([it_id], _) <- tcGhciStmts [bind_stmt, print_it]
 991                        ; it_ty <- zonkTcType (idType it_id)
 992                        ; ifM (isUnitTy it_ty) failM
 993                        ; return stuff },
 994
 995                         -- Plan B; a naked bind statment
 996                     tcGhciStmts [bind_stmt],
 997
 998                         -- Plan C; check that the let-binding is typeable all by itself.
 999                         -- If not, fail; if so, try to print it.
1000                         -- The two-step process avoids getting two errors: one from
1001                         -- the expression itself, and one from the 'print it' part
1002                         -- This two-step story is very clunky, alas
1003                     do { checkNoErrs (tcGhciStmts [let_stmt])
1004                                 --- checkNoErrs defeats the error recovery of let-bindings
1005                        ; tcGhciStmts [let_stmt, print_it] }
1006           ]}
1007
1008 mkPlan stmt@(L loc (BindStmt {}))
1009   | [L _ v] <- collectLStmtBinders stmt         -- One binder, for a bind stmt
1010   = do  { let print_v  = L loc $ ExprStmt (nlHsApp (nlHsVar printName) (nlHsVar v))
1011                                            (HsVar thenIOName) placeHolderType
1012
1013         ; print_bind_result <- doptM Opt_PrintBindResult
1014         ; let print_plan = do
1015                   { stuff@([v_id], _) <- tcGhciStmts [stmt, print_v]
1016                   ; v_ty <- zonkTcType (idType v_id)
1017                   ; ifM (isUnitTy v_ty || not (isTauTy v_ty)) failM
1018                   ; return stuff }
1019
1020         -- The plans are:
1021         --      [stmt; print v]         but not if v::()
1022         --      [stmt]
1023         ; runPlans ((if print_bind_result then [print_plan] else []) ++
1024                     [tcGhciStmts [stmt]])
1025         }
1026
1027 mkPlan stmt
1028   = tcGhciStmts [stmt]
1029
1030 ---------------------------
1031 tcGhciStmts :: [LStmt Name] -> TcM PlanResult
1032 tcGhciStmts stmts
1033  = do { ioTyCon <- tcLookupTyCon ioTyConName ;
1034         ret_id  <- tcLookupId returnIOName ;            -- return @ IO
1035         let {
1036             io_ty     = mkTyConApp ioTyCon [] ;
1037             ret_ty    = mkListTy unitTy ;
1038             io_ret_ty = mkTyConApp ioTyCon [ret_ty] ;
1039             tc_io_stmts stmts = tcStmts DoExpr (tcDoStmt io_ty) stmts
1040                                         (emptyRefinement, io_ret_ty) ;
1041
1042             names = map unLoc (collectLStmtsBinders stmts) ;
1043
1044                 -- mk_return builds the expression
1045                 --      returnIO @ [()] [coerce () x, ..,  coerce () z]
1046                 --
1047                 -- Despite the inconvenience of building the type applications etc,
1048                 -- this *has* to be done in type-annotated post-typecheck form
1049                 -- because we are going to return a list of *polymorphic* values
1050                 -- coerced to type (). If we built a *source* stmt
1051                 --      return [coerce x, ..., coerce z]
1052                 -- then the type checker would instantiate x..z, and we wouldn't
1053                 -- get their *polymorphic* values.  (And we'd get ambiguity errs
1054                 -- if they were overloaded, since they aren't applied to anything.)
1055             mk_return ids = nlHsApp (nlHsTyApp ret_id [ret_ty])
1056                                     (noLoc $ ExplicitList unitTy (map mk_item ids)) ;
1057             mk_item id = nlHsApp (nlHsTyApp unsafeCoerceId [idType id, unitTy])
1058                                  (nlHsVar id)
1059          } ;
1060
1061         -- OK, we're ready to typecheck the stmts
1062         traceTc (text "tcs 2") ;
1063         ((tc_stmts, ids), lie) <- getLIE $ tc_io_stmts stmts $ \ _ ->
1064                                            mappM tcLookupId names ;
1065                                         -- Look up the names right in the middle,
1066                                         -- where they will all be in scope
1067
1068         -- Simplify the context
1069         const_binds <- checkNoErrs (tcSimplifyInteractive lie) ;
1070                 -- checkNoErrs ensures that the plan fails if context redn fails
1071
1072         return (ids, mkHsDictLet const_binds $
1073                      noLoc (HsDo DoExpr tc_stmts (mk_return ids) io_ret_ty))
1074     }
1075 \end{code}
1076
1077
1078 tcRnExpr just finds the type of an expression
1079
1080 \begin{code}
1081 tcRnExpr :: HscEnv
1082          -> InteractiveContext
1083          -> LHsExpr RdrName
1084          -> IO (Maybe Type)
1085 tcRnExpr hsc_env ictxt rdr_expr
1086   = initTcPrintErrors hsc_env iNTERACTIVE $
1087     setInteractiveContext hsc_env ictxt $ do {
1088
1089     (rn_expr, fvs) <- rnLExpr rdr_expr ;
1090     failIfErrsM ;
1091
1092         -- Now typecheck the expression;
1093         -- it might have a rank-2 type (e.g. :t runST)
1094     ((tc_expr, res_ty), lie)       <- getLIE (tcInferRho rn_expr) ;
1095     ((qtvs, dict_insts, _), lie_top) <- getLIE (tcSimplifyInfer smpl_doc (tyVarsOfType res_ty) lie)  ;
1096     tcSimplifyInteractive lie_top ;
1097
1098     let { all_expr_ty = mkForAllTys qtvs $
1099                         mkFunTys (map (idType . instToId) dict_insts)   $
1100                         res_ty } ;
1101     zonkTcType all_expr_ty
1102     }
1103   where
1104     smpl_doc = ptext SLIT("main expression")
1105 \end{code}
1106
1107 tcRnType just finds the kind of a type
1108
1109 \begin{code}
1110 tcRnType :: HscEnv
1111          -> InteractiveContext
1112          -> LHsType RdrName
1113          -> IO (Maybe Kind)
1114 tcRnType hsc_env ictxt rdr_type
1115   = initTcPrintErrors hsc_env iNTERACTIVE $
1116     setInteractiveContext hsc_env ictxt $ do {
1117
1118     rn_type <- rnLHsType doc rdr_type ;
1119     failIfErrsM ;
1120
1121         -- Now kind-check the type
1122     (ty', kind) <- kcHsType rn_type ;
1123     return kind
1124     }
1125   where
1126     doc = ptext SLIT("In GHCi input")
1127
1128 #endif /* GHCi */
1129 \end{code}
1130
1131
1132 %************************************************************************
1133 %*                                                                      *
1134         More GHCi stuff, to do with browsing and getting info
1135 %*                                                                      *
1136 %************************************************************************
1137
1138 \begin{code}
1139 #ifdef GHCI
1140 -- ASSUMES that the module is either in the HomePackageTable or is
1141 -- a package module with an interface on disk.  If neither of these is
1142 -- true, then the result will be an error indicating the interface
1143 -- could not be found.
1144 getModuleExports :: HscEnv -> Module -> IO (Messages, Maybe [AvailInfo])
1145 getModuleExports hsc_env mod
1146   = let
1147       ic        = hsc_IC hsc_env
1148       checkMods = ic_toplev_scope ic ++ ic_exports ic
1149     in
1150     initTc hsc_env HsSrcFile False iNTERACTIVE (tcGetModuleExports mod checkMods)
1151
1152 -- Get the export avail info and also load all orphan and family-instance
1153 -- modules.  Finally, check that the family instances of all modules in the
1154 -- interactive context are consistent (these modules are in the second
1155 -- argument).
1156 tcGetModuleExports :: Module -> [Module] -> TcM [AvailInfo]
1157 tcGetModuleExports mod directlyImpMods
1158   = do { let doc = ptext SLIT("context for compiling statements")
1159        ; iface <- initIfaceTcRn $ loadSysInterface doc mod
1160
1161                 -- Load any orphan-module and family instance-module
1162                 -- interfaces, so their instances are visible.
1163        ; loadOrphanModules (dep_orphs (mi_deps iface)) False
1164        ; loadOrphanModules (dep_finsts (mi_deps iface)) True
1165
1166                 -- Check that the family instances of all directly loaded
1167                 -- modules are consistent.
1168        ; checkFamInstConsistency (dep_finsts (mi_deps iface)) directlyImpMods
1169
1170        ; ifaceExportNames (mi_exports iface)
1171        }
1172
1173 tcRnLookupRdrName :: HscEnv -> RdrName -> IO (Maybe [Name])
1174 tcRnLookupRdrName hsc_env rdr_name
1175   = initTcPrintErrors hsc_env iNTERACTIVE $
1176     setInteractiveContext hsc_env (hsc_IC hsc_env) $
1177     lookup_rdr_name rdr_name
1178
1179 lookup_rdr_name rdr_name = do {
1180         -- If the identifier is a constructor (begins with an
1181         -- upper-case letter), then we need to consider both
1182         -- constructor and type class identifiers.
1183     let { rdr_names = dataTcOccs rdr_name } ;
1184
1185         -- results :: [Either Messages Name]
1186     results <- mapM (tryTcErrs . lookupOccRn) rdr_names ;
1187
1188     traceRn (text "xx" <+> vcat [ppr rdr_names, ppr (map snd results)]);
1189         -- The successful lookups will be (Just name)
1190     let { (warns_s, good_names) = unzip [ (msgs, name)
1191                                         | (msgs, Just name) <- results] ;
1192           errs_s = [msgs | (msgs, Nothing) <- results] } ;
1193
1194         -- Fail if nothing good happened, else add warnings
1195     if null good_names then
1196                 -- No lookup succeeded, so
1197                 -- pick the first error message and report it
1198                 -- ToDo: If one of the errors is "could be Foo.X or Baz.X",
1199                 --       while the other is "X is not in scope",
1200                 --       we definitely want the former; but we might pick the latter
1201         do { addMessages (head errs_s) ; failM }
1202       else                      -- Add deprecation warnings
1203         mapM_ addMessages warns_s ;
1204
1205     return good_names
1206  }
1207
1208 tcRnLookupName :: HscEnv -> Name -> IO (Maybe TyThing)
1209 tcRnLookupName hsc_env name
1210   = initTcPrintErrors hsc_env iNTERACTIVE $
1211     setInteractiveContext hsc_env (hsc_IC hsc_env) $
1212     tcRnLookupName' name
1213
1214 -- To look up a name we have to look in the local environment (tcl_lcl)
1215 -- as well as the global environment, which is what tcLookup does.
1216 -- But we also want a TyThing, so we have to convert:
1217
1218 tcRnLookupName' :: Name -> TcRn TyThing
1219 tcRnLookupName' name = do
1220    tcthing <- tcLookup name
1221    case tcthing of
1222      AGlobal thing    -> return thing
1223      ATcId{tct_id=id} -> return (AnId id)
1224      _ -> panic "tcRnLookupName'"
1225
1226 tcRnGetInfo :: HscEnv
1227             -> Name
1228             -> IO (Maybe (TyThing, Fixity, [Instance]))
1229
1230 -- Used to implemnent :info in GHCi
1231 --
1232 -- Look up a RdrName and return all the TyThings it might be
1233 -- A capitalised RdrName is given to us in the DataName namespace,
1234 -- but we want to treat it as *both* a data constructor
1235 --  *and* as a type or class constructor;
1236 -- hence the call to dataTcOccs, and we return up to two results
1237 tcRnGetInfo hsc_env name
1238   = initTcPrintErrors hsc_env iNTERACTIVE $
1239     let ictxt = hsc_IC hsc_env in
1240     setInteractiveContext hsc_env ictxt $ do
1241
1242         -- Load the interface for all unqualified types and classes
1243         -- That way we will find all the instance declarations
1244         -- (Packages have not orphan modules, and we assume that
1245         --  in the home package all relevant modules are loaded.)
1246     loadUnqualIfaces ictxt
1247
1248     thing <- tcRnLookupName' name
1249     fixity <- lookupFixityRn name
1250     ispecs <- lookupInsts (icPrintUnqual ictxt) thing
1251     return (thing, fixity, ispecs)
1252
1253 lookupInsts :: PrintUnqualified -> TyThing -> TcM [Instance]
1254 -- Filter the instances by the ones whose tycons (or clases resp)
1255 -- are in scope unqualified.  Otherwise we list a whole lot too many!
1256 lookupInsts print_unqual (AClass cls)
1257   = do  { inst_envs <- tcGetInstEnvs
1258         ; return [ ispec
1259                  | ispec <- classInstances inst_envs cls
1260                  , plausibleDFun print_unqual (instanceDFunId ispec) ] }
1261
1262 lookupInsts print_unqual (ATyCon tc)
1263   = do  { eps <- getEps -- Load all instances for all classes that are
1264                         -- in the type environment (which are all the ones
1265                         -- we've seen in any interface file so far)
1266         ; (pkg_ie, home_ie) <- tcGetInstEnvs    -- Search all
1267         ; return [ ispec
1268                  | ispec <- instEnvElts home_ie ++ instEnvElts pkg_ie
1269                  , let dfun = instanceDFunId ispec
1270                  , relevant dfun
1271                  , plausibleDFun print_unqual dfun ] }
1272   where
1273     relevant df = tc_name `elemNameSet` tyClsNamesOfDFunHead (idType df)
1274     tc_name     = tyConName tc
1275
1276 lookupInsts print_unqual other = return []
1277
1278 plausibleDFun print_unqual dfun -- Dfun involving only names that print unqualified
1279   = all ok (nameSetToList (tyClsNamesOfType (idType dfun)))
1280   where
1281     ok name | isBuiltInSyntax name = True
1282             | isExternalName name  =
1283                 isNothing $ fst print_unqual (nameModule name)
1284                                              (nameOccName name)
1285             | otherwise            = True
1286
1287 loadUnqualIfaces :: InteractiveContext -> TcM ()
1288 -- Load the home module for everything that is in scope unqualified
1289 -- This is so that we can accurately report the instances for
1290 -- something
1291 loadUnqualIfaces ictxt
1292   = initIfaceTcRn $
1293     mapM_ (loadSysInterface doc) (moduleSetElts (mkModuleSet unqual_mods))
1294   where
1295     unqual_mods = [ nameModule name
1296                   | gre <- globalRdrEnvElts (ic_rn_gbl_env ictxt),
1297                     let name = gre_name gre,
1298                     not (isInternalName name),
1299                     isTcOcc (nameOccName name),  -- Types and classes only
1300                     unQualOK gre ]               -- In scope unqualified
1301     doc = ptext SLIT("Need interface for module whose export(s) are in scope unqualified")
1302 #endif /* GHCI */
1303 \end{code}
1304
1305 %************************************************************************
1306 %*                                                                      *
1307                 Degugging output
1308 %*                                                                      *
1309 %************************************************************************
1310
1311 \begin{code}
1312 rnDump :: SDoc -> TcRn ()
1313 -- Dump, with a banner, if -ddump-rn
1314 rnDump doc = do { dumpOptTcRn Opt_D_dump_rn (mkDumpDoc "Renamer" doc) }
1315
1316 tcDump :: TcGblEnv -> TcRn ()
1317 tcDump env
1318  = do { dflags <- getDOpts ;
1319
1320         -- Dump short output if -ddump-types or -ddump-tc
1321         ifM (dopt Opt_D_dump_types dflags || dopt Opt_D_dump_tc dflags)
1322             (dumpTcRn short_dump) ;
1323
1324         -- Dump bindings if -ddump-tc
1325         dumpOptTcRn Opt_D_dump_tc (mkDumpDoc "Typechecker" full_dump)
1326    }
1327   where
1328     short_dump = pprTcGblEnv env
1329     full_dump  = pprLHsBinds (tcg_binds env)
1330         -- NB: foreign x-d's have undefined's in their types;
1331         --     hence can't show the tc_fords
1332
1333 tcCoreDump mod_guts
1334  = do { dflags <- getDOpts ;
1335         ifM (dopt Opt_D_dump_types dflags || dopt Opt_D_dump_tc dflags)
1336             (dumpTcRn (pprModGuts mod_guts)) ;
1337
1338         -- Dump bindings if -ddump-tc
1339         dumpOptTcRn Opt_D_dump_tc (mkDumpDoc "Typechecker" full_dump) }
1340   where
1341     full_dump = pprCoreBindings (mg_binds mod_guts)
1342
1343 -- It's unpleasant having both pprModGuts and pprModDetails here
1344 pprTcGblEnv :: TcGblEnv -> SDoc
1345 pprTcGblEnv (TcGblEnv { tcg_type_env  = type_env,
1346                         tcg_insts     = insts,
1347                         tcg_fam_insts = fam_insts,
1348                         tcg_rules     = rules,
1349                         tcg_imports   = imports })
1350   = vcat [ ppr_types insts type_env
1351          , ppr_tycons fam_insts type_env
1352          , ppr_insts insts
1353          , ppr_fam_insts fam_insts
1354          , vcat (map ppr rules)
1355          , ppr_gen_tycons (typeEnvTyCons type_env)
1356          , ptext SLIT("Dependent modules:") <+> ppr (eltsUFM (imp_dep_mods imports))
1357          , ptext SLIT("Dependent packages:") <+> ppr (imp_dep_pkgs imports)]
1358
1359 pprModGuts :: ModGuts -> SDoc
1360 pprModGuts (ModGuts { mg_types = type_env,
1361                       mg_rules = rules })
1362   = vcat [ ppr_types [] type_env,
1363            ppr_rules rules ]
1364
1365 ppr_types :: [Instance] -> TypeEnv -> SDoc
1366 ppr_types insts type_env
1367   = text "TYPE SIGNATURES" $$ nest 4 (ppr_sigs ids)
1368   where
1369     dfun_ids = map instanceDFunId insts
1370     ids = [id | id <- typeEnvIds type_env, want_sig id]
1371     want_sig id | opt_PprStyle_Debug = True
1372                 | otherwise          = isLocalId id &&
1373                                        isExternalName (idName id) &&
1374                                        not (id `elem` dfun_ids)
1375         -- isLocalId ignores data constructors, records selectors etc.
1376         -- The isExternalName ignores local dictionary and method bindings
1377         -- that the type checker has invented.  Top-level user-defined things
1378         -- have External names.
1379
1380 ppr_tycons :: [FamInst] -> TypeEnv -> SDoc
1381 ppr_tycons fam_insts type_env
1382   = text "TYPE CONSTRUCTORS" $$ nest 4 (ppr_tydecls tycons)
1383   where
1384     fi_tycons = map famInstTyCon fam_insts
1385     tycons = [tycon | tycon <- typeEnvTyCons type_env, want_tycon tycon]
1386     want_tycon tycon | opt_PprStyle_Debug = True
1387                      | otherwise          = not (isImplicitTyCon tycon) &&
1388                                             isExternalName (tyConName tycon) &&
1389                                             not (tycon `elem` fi_tycons)
1390
1391 ppr_insts :: [Instance] -> SDoc
1392 ppr_insts []     = empty
1393 ppr_insts ispecs = text "INSTANCES" $$ nest 2 (pprInstances ispecs)
1394
1395 ppr_fam_insts :: [FamInst] -> SDoc
1396 ppr_fam_insts []        = empty
1397 ppr_fam_insts fam_insts =
1398   text "FAMILY INSTANCES" $$ nest 2 (pprFamInsts fam_insts)
1399
1400 ppr_sigs :: [Var] -> SDoc
1401 ppr_sigs ids
1402         -- Print type signatures; sort by OccName
1403   = vcat (map ppr_sig (sortLe le_sig ids))
1404   where
1405     le_sig id1 id2 = getOccName id1 <= getOccName id2
1406     ppr_sig id = ppr id <+> dcolon <+> ppr (tidyTopType (idType id))
1407
1408 ppr_tydecls :: [TyCon] -> SDoc
1409 ppr_tydecls tycons
1410         -- Print type constructor info; sort by OccName
1411   = vcat (map ppr_tycon (sortLe le_sig tycons))
1412   where
1413     le_sig tycon1 tycon2 = getOccName tycon1 <= getOccName tycon2
1414     ppr_tycon tycon
1415       | isCoercionTyCon tycon = ptext SLIT("coercion") <+> ppr tycon
1416       | otherwise             = ppr (tyThingToIfaceDecl (ATyCon tycon))
1417
1418 ppr_rules :: [CoreRule] -> SDoc
1419 ppr_rules [] = empty
1420 ppr_rules rs = vcat [ptext SLIT("{-# RULES"),
1421                       nest 4 (pprRules rs),
1422                       ptext SLIT("#-}")]
1423
1424 ppr_gen_tycons []  = empty
1425 ppr_gen_tycons tcs = vcat [ptext SLIT("Tycons with generics:"),
1426                            nest 2 (fsep (map ppr (filter tyConHasGenerics tcs)))]
1427 \end{code}