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         tcRnRecoverDataCon,
  16 #endif
  17         tcRnModule,
  18         tcTopSrcDecls,
  19         tcRnExtCore
  20     ) where
  21
  22 #include "HsVersions.h"
  23
  24 import IO
  25 #ifdef GHCI
  26 import {-# SOURCE #-} TcSplice ( tcSpliceDecls )
  27 #endif
  28
  29 import DynFlags
  30 import StaticFlags
  31 import HsSyn
  32 import RdrHsSyn
  33
  34 import PrelNames
  35 import RdrName
  36 import TcHsSyn
  37 import TcExpr
  38 import TcRnMonad
  39 import TcType
  40 import Inst
  41 import FamInst
  42 import InstEnv
  43 import FamInstEnv
  44 import TcBinds
  45 import TcDefaults
  46 import TcEnv
  47 import TcRules
  48 import TcForeign
  49 import TcInstDcls
  50 import TcIface
  51 import MkIface
  52 import IfaceSyn
  53 import TcSimplify
  54 import TcTyClsDecls
  55 import LoadIface
  56 import RnNames
  57 import RnEnv
  58 import RnSource
  59 import RnHsDoc
  60 import PprCore
  61 import CoreSyn
  62 import ErrUtils
  63 import Id
  64 import Var
  65 import Module
  66 import UniqFM
  67 import Name
  68 import NameEnv
  69 import NameSet
  70 import TyCon
  71 import SrcLoc
  72 import HscTypes
  73 import ListSetOps
  74 import Outputable
  75
  76 #ifdef GHCI
  77 import Linker
  78 import DataCon
  79 import TcHsType
  80 import TcMType
  81 import TcMatches
  82 import TcGadt
  83 import RnTypes
  84 import RnExpr
  85 import IfaceEnv
  86 import MkId
  87 import TysWiredIn
  88 import IdInfo
  89 import {- Kind parts of -} Type
  90 import BasicTypes
  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 import Foreign.Ptr      ( Ptr )
 101
 102 \end{code}
 103
 104
 105
 106 %************************************************************************
 107 %*                                                                      *
 108         Typecheck and rename a module
 109 %*                                                                      *
 110 %************************************************************************
 111
 112
 113 \begin{code}
 114 tcRnModule :: HscEnv
 115            -> HscSource
 116            -> Bool              -- True <=> save renamed syntax
 117            -> Located (HsModule RdrName)
 118            -> IO (Messages, Maybe TcGblEnv)
 119
 120 tcRnModule hsc_env hsc_src save_rn_syntax
 121          (L loc (HsModule maybe_mod export_ies
 122                           import_decls local_decls mod_deprec _
 123                           module_info maybe_doc))
 124  = do { showPass (hsc_dflags hsc_env) "Renamer/typechecker" ;
 125
 126    let { this_pkg = thisPackage (hsc_dflags hsc_env) ;
 127          this_mod = case maybe_mod of
 128                         Nothing  -> mAIN        -- 'module M where' is omitted
 129                         Just (L _ mod) -> mkModule this_pkg mod } ;
 130                                                 -- The normal case
 131
 132    initTc hsc_env hsc_src save_rn_syntax this_mod $
 133    setSrcSpan loc $
 134    do {         -- Deal with imports;
 135         tcg_env <- tcRnImports hsc_env this_mod import_decls ;
 136         setGblEnv tcg_env               $ do {
 137
 138                 -- Load the hi-boot interface for this module, if any
 139                 -- We do this now so that the boot_names can be passed
 140                 -- to tcTyAndClassDecls, because the boot_names are
 141                 -- automatically considered to be loop breakers
 142                 --
 143                 -- Do this *after* tcRnImports, so that we know whether
 144                 -- a module that we import imports us; and hence whether to
 145                 -- look for a hi-boot file
 146         boot_iface <- tcHiBootIface hsc_src this_mod ;
 147
 148                 -- Rename and type check the declarations
 149         traceRn (text "rn1a") ;
 150         tcg_env <- if isHsBoot hsc_src then
 151                         tcRnHsBootDecls local_decls
 152                    else
 153                         tcRnSrcDecls boot_iface local_decls ;
 154         setGblEnv tcg_env               $ do {
 155
 156                 -- Report the use of any deprecated things
 157                 -- We do this *before* processsing the export list so
 158                 -- that we don't bleat about re-exporting a deprecated
 159                 -- thing (especially via 'module Foo' export item)
 160                 -- That is, only uses in the *body* of the module are complained about
 161         traceRn (text "rn3") ;
 162         failIfErrsM ;   -- finishDeprecations crashes sometimes
 163                         -- as a result of typechecker repairs (e.g. unboundNames)
 164         tcg_env <- finishDeprecations (hsc_dflags hsc_env) mod_deprec tcg_env ;
 165
 166                 -- Process the export list
 167         tcg_env <- rnExports (isJust maybe_mod) export_ies tcg_env ;
 168         traceRn (text "rn4") ;
 169
 170         -- Compare the hi-boot iface (if any) with the real thing
 171         -- Must be done after processing the exports
 172         tcg_env <- checkHiBootIface tcg_env boot_iface ;
 173
 174         -- Make the new type env available to stuff slurped from interface files
 175         -- Must do this after checkHiBootIface, because the latter might add new
 176         -- bindings for boot_dfuns, which may be mentioned in imported unfoldings
 177         writeMutVar (tcg_type_env_var tcg_env) (tcg_type_env tcg_env) ;
 178
 179                 -- Rename the Haddock documentation
 180         tcg_env <- rnHaddock module_info maybe_doc tcg_env ;
 181
 182                 -- Report unused names
 183         reportUnusedNames export_ies tcg_env ;
 184
 185                 -- Dump output and return
 186         tcDump tcg_env ;
 187         return tcg_env
 188     }}}}
 189 \end{code}
 190
 191
 192 %************************************************************************
 193 %*                                                                      *
 194                 Import declarations
 195 %*                                                                      *
 196 %************************************************************************
 197
 198 \begin{code}
 199 tcRnImports :: HscEnv -> Module -> [LImportDecl RdrName] -> TcM TcGblEnv
 200 tcRnImports hsc_env this_mod import_decls
 201   = do  { (rn_imports, rdr_env, imports) <- rnImports import_decls ;
 202
 203         ; let { dep_mods :: ModuleNameEnv (ModuleName, IsBootInterface)
 204               ; dep_mods = imp_dep_mods imports
 205
 206                 -- We want instance declarations from all home-package
 207                 -- modules below this one, including boot modules, except
 208                 -- ourselves.  The 'except ourselves' is so that we don't
 209                 -- get the instances from this module's hs-boot file
 210               ; want_instances :: ModuleName -> Bool
 211               ; want_instances mod = mod `elemUFM` dep_mods
 212                                    && mod /= moduleName this_mod
 213               ; home_insts = hptInstances hsc_env 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 { tcg_rdr_env    = plusOccEnv (tcg_rdr_env gbl) rdr_env,
 224                       tcg_imports    = tcg_imports gbl `plusImportAvails` imports,
 225                       tcg_rn_imports = fmap (const rn_imports) (tcg_rn_imports gbl),
 226                       tcg_inst_env   = extendInstEnvList (tcg_inst_env gbl) home_insts
 227                 }) $ do {
 228
 229         ; traceRn (text "rn1" <+> ppr (imp_dep_mods imports))
 230                 -- Fail if there are any errors so far
 231                 -- The error printing (if needed) takes advantage
 232                 -- of the tcg_env we have now set
 233 --      ; traceIf (text "rdr_env: " <+> ppr rdr_env)
 234         ; failIfErrsM
 235
 236                 -- Load any orphan-module and family instance-module
 237                 -- interfaces, so that their rules and instance decls will be
 238                 -- found.
 239         ; loadOrphanModules (imp_orphs  imports) False
 240         ; loadOrphanModules (imp_finsts imports) True
 241
 242                 -- Check type-familily consistency
 243         ; traceRn (text "rn1: checking family instance consistency")
 244         ; let { dir_imp_mods = map (\ (mod, _, _) -> mod)
 245                              . moduleEnvElts
 246                              . imp_mods
 247                              $ imports }
 248         ; checkFamInstConsistency (imp_finsts imports) dir_imp_mods ;
 249
 250         ; getGblEnv } }
 251 \end{code}
 252
 253
 254 %************************************************************************
 255 %*                                                                      *
 256         Type-checking external-core modules
 257 %*                                                                      *
 258 %************************************************************************
 259
 260 \begin{code}
 261 tcRnExtCore :: HscEnv
 262             -> HsExtCore RdrName
 263             -> IO (Messages, Maybe ModGuts)
 264         -- Nothing => some error occurred
 265
 266 tcRnExtCore hsc_env (HsExtCore this_mod decls src_binds)
 267         -- The decls are IfaceDecls; all names are original names
 268  = do { showPass (hsc_dflags hsc_env) "Renamer/typechecker" ;
 269
 270    initTc hsc_env ExtCoreFile False this_mod $ do {
 271
 272    let { ldecls  = map noLoc decls } ;
 273
 274         -- Deal with the type declarations; first bring their stuff
 275         -- into scope, then rname them, then type check them
 276    tcg_env  <- importsFromLocalDecls (mkFakeGroup ldecls) ;
 277
 278    setGblEnv tcg_env $ do {
 279
 280    rn_decls <- rnTyClDecls ldecls ;
 281    failIfErrsM ;
 282
 283         -- Dump trace of renaming part
 284    rnDump (ppr rn_decls) ;
 285
 286         -- Typecheck them all together so that
 287         -- any mutually recursive types are done right
 288    tcg_env <- checkNoErrs (tcTyAndClassDecls emptyModDetails rn_decls) ;
 289         -- Make the new type env available to stuff slurped from interface files
 290
 291    setGblEnv tcg_env $ do {
 292
 293         -- Now the core bindings
 294    core_binds <- initIfaceExtCore (tcExtCoreBindings src_binds) ;
 295
 296         -- Wrap up
 297    let {
 298         bndrs      = bindersOfBinds core_binds ;
 299         my_exports = map (Avail . idName) bndrs ;
 300                 -- ToDo: export the data types also?
 301
 302         final_type_env = extendTypeEnvWithIds (tcg_type_env tcg_env) bndrs ;
 303
 304         mod_guts = ModGuts {    mg_module    = this_mod,
 305                                 mg_boot      = False,
 306                                 mg_usages    = [],              -- ToDo: compute usage
 307                                 mg_dir_imps  = [],              -- ??
 308                                 mg_deps      = noDependencies,  -- ??
 309                                 mg_exports   = my_exports,
 310                                 mg_types     = final_type_env,
 311                                 mg_insts     = tcg_insts tcg_env,
 312                                 mg_fam_insts = tcg_fam_insts tcg_env,
 313                                 mg_fam_inst_env = tcg_fam_inst_env tcg_env,
 314                                 mg_rules     = [],
 315                                 mg_binds     = core_binds,
 316
 317                                 -- Stubs
 318                                 mg_rdr_env   = emptyGlobalRdrEnv,
 319                                 mg_fix_env   = emptyFixityEnv,
 320                                 mg_deprecs   = NoDeprecs,
 321                                 mg_foreign   = NoStubs,
 322                                 mg_hpc_info  = noHpcInfo,
 323                                 mg_modBreaks = emptyModBreaks
 324                     } } ;
 325
 326    tcCoreDump mod_guts ;
 327
 328    return mod_guts
 329    }}}}
 330
 331 mkFakeGroup decls -- Rather clumsy; lots of unused fields
 332   = emptyRdrGroup { hs_tyclds = decls }
 333 \end{code}
 334
 335
 336 %************************************************************************
 337 %*                                                                      *
 338         Type-checking the top level of a module
 339 %*                                                                      *
 340 %************************************************************************
 341
 342 \begin{code}
 343 tcRnSrcDecls :: ModDetails -> [LHsDecl RdrName] -> TcM TcGblEnv
 344         -- Returns the variables free in the decls
 345         -- Reason: solely to report unused imports and bindings
 346 tcRnSrcDecls boot_iface decls
 347  = do {         -- Do all the declarations
 348         (tc_envs, lie) <- getLIE $ tc_rn_src_decls boot_iface decls ;
 349
 350              --         Finish simplifying class constraints
 351              --
 352              -- tcSimplifyTop deals with constant or ambiguous InstIds.
 353              -- How could there be ambiguous ones?  They can only arise if a
 354              -- top-level decl falls under the monomorphism restriction
 355              -- and no subsequent decl instantiates its type.
 356              --
 357              -- We do this after checkMain, so that we use the type info
 358              -- thaat checkMain adds
 359              --
 360              -- We do it with both global and local env in scope:
 361              --  * the global env exposes the instances to tcSimplifyTop
 362              --  * the local env exposes the local Ids to tcSimplifyTop,
 363              --    so that we get better error messages (monomorphism restriction)
 364         traceTc (text "Tc8") ;
 365         inst_binds <- setEnvs tc_envs (tcSimplifyTop lie) ;
 366
 367             -- Backsubstitution.  This must be done last.
 368             -- Even tcSimplifyTop may do some unification.
 369         traceTc (text "Tc9") ;
 370         let { (tcg_env, _) = tc_envs
 371             ; TcGblEnv { tcg_type_env = type_env, tcg_binds = binds,
 372                          tcg_rules = rules, tcg_fords = fords } = tcg_env
 373             ; all_binds = binds `unionBags` inst_binds } ;
 374
 375         (bind_ids, binds', fords', rules') <- zonkTopDecls all_binds rules fords ;
 376
 377         let { final_type_env = extendTypeEnvWithIds type_env bind_ids
 378             ; tcg_env' = tcg_env { tcg_type_env = final_type_env,
 379                                    tcg_binds = binds',
 380                                    tcg_rules = rules',
 381                                    tcg_fords = fords' } } ;
 382
 383         return (tcg_env' { tcg_binds = tcg_binds tcg_env' })
 384    }
 385
 386 tc_rn_src_decls :: ModDetails -> [LHsDecl RdrName] -> TcM (TcGblEnv, TcLclEnv)
 387 -- Loops around dealing with each top level inter-splice group
 388 -- in turn, until it's dealt with the entire module
 389 tc_rn_src_decls boot_details ds
 390  = do { let { (first_group, group_tail) = findSplice ds } ;
 391                 -- If ds is [] we get ([], Nothing)
 392
 393         -- Deal with decls up to, but not including, the first splice
 394         (tcg_env, rn_decls) <- checkNoErrs $ rnTopSrcDecls first_group ;
 395                 -- checkNoErrs: stop if renaming fails
 396
 397         (tcg_env, tcl_env) <- setGblEnv tcg_env $
 398                               tcTopSrcDecls boot_details rn_decls ;
 399
 400         -- If there is no splice, we're nearly done
 401         setEnvs (tcg_env, tcl_env) $
 402         case group_tail of {
 403            Nothing -> do { tcg_env <- checkMain ;       -- Check for `main'
 404                            return (tcg_env, tcl_env)
 405                       } ;
 406
 407         -- If there's a splice, we must carry on
 408            Just (SpliceDecl splice_expr, rest_ds) -> do {
 409 #ifndef GHCI
 410         failWithTc (text "Can't do a top-level splice; need a bootstrapped compiler")
 411 #else
 412
 413         -- Rename the splice expression, and get its supporting decls
 414         (rn_splice_expr, splice_fvs) <- checkNoErrs (rnLExpr splice_expr) ;
 415                 -- checkNoErrs: don't typecheck if renaming failed
 416         rnDump (ppr rn_splice_expr) ;
 417
 418         -- Execute the splice
 419         spliced_decls <- tcSpliceDecls rn_splice_expr ;
 420
 421         -- Glue them on the front of the remaining decls and loop
 422         setGblEnv (tcg_env `addTcgDUs` usesOnly splice_fvs) $
 423         tc_rn_src_decls boot_details (spliced_decls ++ rest_ds)
 424 #endif /* GHCI */
 425     } } }
 426 \end{code}
 427
 428 %************************************************************************
 429 %*                                                                      *
 430         Compiling hs-boot source files, and
 431         comparing the hi-boot interface with the real thing
 432 %*                                                                      *
 433 %************************************************************************
 434
 435 \begin{code}
 436 tcRnHsBootDecls :: [LHsDecl RdrName] -> TcM TcGblEnv
 437 tcRnHsBootDecls decls
 438    = do { let { (first_group, group_tail) = findSplice decls }
 439
 440         ; case group_tail of
 441              Just stuff -> spliceInHsBootErr stuff
 442              Nothing    -> return ()
 443
 444                 -- Rename the declarations
 445         ; (tcg_env, rn_group) <- rnTopSrcDecls first_group
 446         ; setGblEnv tcg_env $ do {
 447
 448         -- Todo: check no foreign decls, no rules, no default decls
 449
 450                 -- Typecheck type/class decls
 451         ; traceTc (text "Tc2")
 452         ; let tycl_decls = hs_tyclds rn_group
 453         ; tcg_env <- checkNoErrs (tcTyAndClassDecls emptyModDetails tycl_decls)
 454         ; setGblEnv tcg_env     $ do {
 455
 456                 -- Typecheck instance decls
 457         ; traceTc (text "Tc3")
 458         ; (tcg_env, inst_infos, _deriv_binds)
 459             <- tcInstDecls1 tycl_decls (hs_instds rn_group) (hs_derivds rn_group)
 460         ; setGblEnv tcg_env     $ do {
 461
 462                 -- Typecheck value declarations
 463         ; traceTc (text "Tc5")
 464         ; val_ids <- tcHsBootSigs (hs_valds rn_group)
 465
 466                 -- Wrap up
 467                 -- No simplification or zonking to do
 468         ; traceTc (text "Tc7a")
 469         ; gbl_env <- getGblEnv
 470
 471                 -- Make the final type-env
 472                 -- Include the dfun_ids so that their type sigs
 473                 -- are written into the interface file
 474         ; let { type_env0 = tcg_type_env gbl_env
 475               ; type_env1 = extendTypeEnvWithIds type_env0 val_ids
 476               ; type_env2 = extendTypeEnvWithIds type_env1 dfun_ids
 477               ; dfun_ids = map iDFunId inst_infos }
 478         ; return (gbl_env { tcg_type_env = type_env2 })
 479    }}}}
 480
 481 spliceInHsBootErr (SpliceDecl (L loc _), _)
 482   = addErrAt loc (ptext SLIT("Splices are not allowed in hs-boot files"))
 483 \end{code}
 484
 485 Once we've typechecked the body of the module, we want to compare what
 486 we've found (gathered in a TypeEnv) with the hi-boot details (if any).
 487
 488 \begin{code}
 489 checkHiBootIface :: TcGblEnv -> ModDetails -> TcM TcGblEnv
 490 -- Compare the hi-boot file for this module (if there is one)
 491 -- with the type environment we've just come up with
 492 -- In the common case where there is no hi-boot file, the list
 493 -- of boot_names is empty.
 494 --
 495 -- The bindings we return give bindings for the dfuns defined in the
 496 -- hs-boot file, such as        $fbEqT = $fEqT
 497
 498 checkHiBootIface
 499         tcg_env@(TcGblEnv { tcg_src = hs_src, tcg_binds = binds,
 500                             tcg_insts = local_insts, tcg_fam_insts = local_fam_insts,
 501                             tcg_type_env = local_type_env, tcg_exports = local_exports })
 502         (ModDetails { md_insts = boot_insts, md_fam_insts = boot_fam_insts,
 503                       md_types = boot_type_env, md_exports = boot_exports })
 504   | isHsBoot hs_src     -- Current module is already a hs-boot file!
 505   = return tcg_env
 506
 507   | otherwise
 508   = do  { traceTc (text "checkHiBootIface" <+> (ppr boot_type_env $$ ppr boot_insts $$
 509                                 ppr boot_exports)) ;
 510
 511                 -- Check the exports of the boot module, one by one
 512         ; mapM_ check_export boot_exports
 513
 514                 -- Check instance declarations
 515         ; mb_dfun_prs <- mapM check_inst boot_insts
 516         ; let tcg_env' = tcg_env { tcg_binds    = binds `unionBags` dfun_binds,
 517                                    tcg_type_env = extendTypeEnvWithIds local_type_env boot_dfuns }
 518               dfun_prs   = catMaybes mb_dfun_prs
 519               boot_dfuns = map fst dfun_prs
 520               dfun_binds = listToBag [ noLoc $ VarBind boot_dfun (nlHsVar dfun)
 521                                      | (boot_dfun, dfun) <- dfun_prs ]
 522
 523                 -- Check for no family instances
 524         ; unless (null boot_fam_insts) $
 525             panic ("TcRnDriver.checkHiBootIface: Cannot handle family " ++
 526                    "instances in boot files yet...")
 527             -- FIXME: Why?  The actual comparison is not hard, but what would
 528             --        be the equivalent to the dfun bindings returned for class
 529             --        instances?  We can't easily equate tycons...
 530
 531         ; return tcg_env' }
 532   where
 533     check_export boot_avail     -- boot_avail is exported by the boot iface
 534       | name `elem` dfun_names = return ()
 535       | isWiredInName name     = return ()      -- No checking for wired-in names.  In particular,
 536                                                 -- 'error' is handled by a rather gross hack
 537                                                 -- (see comments in GHC.Err.hs-boot)
 538
 539         -- Check that the actual module exports the same thing
 540       | not (null missing_names)
 541       = addErrTc (missingBootThing (head missing_names) "exported by")
 542
 543         -- If the boot module does not *define* the thing, we are done
 544         -- (it simply re-exports it, and names match, so nothing further to do)
 545       | isNothing mb_boot_thing = return ()
 546
 547         -- Check that the actual module also defines the thing, and
 548         -- then compare the definitions
 549       | Just real_thing <- lookupTypeEnv local_type_env name
 550       = do { let boot_decl = tyThingToIfaceDecl (fromJust mb_boot_thing)
 551                  real_decl = tyThingToIfaceDecl real_thing
 552            ; checkTc (checkBootDecl boot_decl real_decl)
 553                      (bootMisMatch real_thing boot_decl real_decl) }
 554                 -- The easiest way to check compatibility is to convert to
 555                 -- iface syntax, where we already have good comparison functions
 556
 557       | otherwise
 558       = addErrTc (missingBootThing name "defined in")
 559       where
 560         name          = availName boot_avail
 561         mb_boot_thing = lookupTypeEnv boot_type_env name
 562         missing_names = case lookupNameEnv local_export_env name of
 563                           Nothing    -> [name]
 564                           Just avail -> availNames boot_avail `minusList` availNames avail
 565
 566     dfun_names = map getName boot_insts
 567
 568     local_export_env :: NameEnv AvailInfo
 569     local_export_env = availsToNameEnv local_exports
 570
 571     check_inst :: Instance -> TcM (Maybe (Id, Id))
 572         -- Returns a pair of the boot dfun in terms of the equivalent real dfun
 573     check_inst boot_inst
 574         = case [dfun | inst <- local_insts,
 575                        let dfun = instanceDFunId inst,
 576                        idType dfun `tcEqType` boot_inst_ty ] of
 577             [] -> do { addErrTc (instMisMatch boot_inst); return Nothing }
 578             (dfun:_) -> return (Just (local_boot_dfun, dfun))
 579         where
 580           boot_dfun = instanceDFunId boot_inst
 581           boot_inst_ty = idType boot_dfun
 582           local_boot_dfun = Id.mkExportedLocalId (idName boot_dfun) boot_inst_ty
 583
 584
 585 ----------------
 586 missingBootThing thing what
 587   = ppr thing <+> ptext SLIT("is exported by the hs-boot file, but not")
 588               <+> text what <+> ptext SLIT("the module")
 589
 590 bootMisMatch thing boot_decl real_decl
 591   = vcat [ppr thing <+> ptext SLIT("has conflicting definitions in the module and its hs-boot file"),
 592           ptext SLIT("Main module:") <+> ppr real_decl,
 593           ptext SLIT("Boot file:  ") <+> ppr boot_decl]
 594
 595 instMisMatch inst
 596   = hang (ppr inst)
 597        2 (ptext SLIT("is defined in the hs-boot file, but not in the module itself"))
 598 \end{code}
 599
 600
 601 %************************************************************************
 602 %*                                                                      *
 603         Type-checking the top level of a module
 604 %*                                                                      *
 605 %************************************************************************
 606
 607 tcRnGroup takes a bunch of top-level source-code declarations, and
 608  * renames them
 609  * gets supporting declarations from interface files
 610  * typechecks them
 611  * zonks them
 612  * and augments the TcGblEnv with the results
 613
 614 In Template Haskell it may be called repeatedly for each group of
 615 declarations.  It expects there to be an incoming TcGblEnv in the
 616 monad; it augments it and returns the new TcGblEnv.
 617
 618 \begin{code}
 619 ------------------------------------------------
 620 rnTopSrcDecls :: HsGroup RdrName -> TcM (TcGblEnv, HsGroup Name)
 621 rnTopSrcDecls group
 622  = do {         -- Bring top level binders into scope
 623         tcg_env <- importsFromLocalDecls group ;
 624         setGblEnv tcg_env $ do {
 625
 626         failIfErrsM ;   -- No point in continuing if (say) we have duplicate declarations
 627
 628                 -- Rename the source decls
 629         (tcg_env, rn_decls) <- rnSrcDecls group ;
 630         failIfErrsM ;
 631
 632                 -- save the renamed syntax, if we want it
 633         let { tcg_env'
 634                 | Just grp <- tcg_rn_decls tcg_env
 635                   = tcg_env{ tcg_rn_decls = Just (appendGroups grp rn_decls) }
 636                 | otherwise
 637                    = tcg_env };
 638
 639                 -- Dump trace of renaming part
 640         rnDump (ppr rn_decls) ;
 641
 642         return (tcg_env', rn_decls)
 643    }}
 644
 645 ------------------------------------------------
 646 tcTopSrcDecls :: ModDetails -> HsGroup Name -> TcM (TcGblEnv, TcLclEnv)
 647 tcTopSrcDecls boot_details
 648         (HsGroup { hs_tyclds = tycl_decls,
 649                    hs_instds = inst_decls,
 650                    hs_derivds = deriv_decls,
 651                    hs_fords  = foreign_decls,
 652                    hs_defds  = default_decls,
 653                    hs_ruleds = rule_decls,
 654                    hs_valds  = val_binds })
 655  = do {         -- Type-check the type and class decls, and all imported decls
 656                 -- The latter come in via tycl_decls
 657         traceTc (text "Tc2") ;
 658
 659         tcg_env <- checkNoErrs (tcTyAndClassDecls boot_details tycl_decls) ;
 660         -- tcTyAndClassDecls recovers internally, but if anything gave rise to
 661         -- an error we'd better stop now, to avoid a cascade
 662
 663         -- Make these type and class decls available to stuff slurped from interface files
 664         writeMutVar (tcg_type_env_var tcg_env) (tcg_type_env tcg_env) ;
 665
 666
 667         setGblEnv tcg_env       $ do {
 668                 -- Source-language instances, including derivings,
 669                 -- and import the supporting declarations
 670         traceTc (text "Tc3") ;
 671         (tcg_env, inst_infos, deriv_binds)
 672             <- tcInstDecls1 tycl_decls inst_decls deriv_decls;
 673         setGblEnv tcg_env       $ do {
 674
 675                 -- Foreign import declarations next.  No zonking necessary
 676                 -- here; we can tuck them straight into the global environment.
 677         traceTc (text "Tc4") ;
 678         (fi_ids, fi_decls) <- tcForeignImports foreign_decls ;
 679         tcExtendGlobalValEnv fi_ids     $ do {
 680
 681                 -- Default declarations
 682         traceTc (text "Tc4a") ;
 683         default_tys <- tcDefaults default_decls ;
 684         updGblEnv (\gbl -> gbl { tcg_default = default_tys }) $ do {
 685
 686                 -- Value declarations next
 687                 -- We also typecheck any extra binds that came out
 688                 -- of the "deriving" process (deriv_binds)
 689         traceTc (text "Tc5") ;
 690         (tc_val_binds, tcl_env) <- tcTopBinds (val_binds `plusHsValBinds` deriv_binds) ;
 691         setLclTypeEnv tcl_env   $ do {
 692
 693                 -- Second pass over class and instance declarations,
 694         traceTc (text "Tc6") ;
 695         (inst_binds, tcl_env) <- tcInstDecls2 tycl_decls inst_infos ;
 696         showLIE (text "after instDecls2") ;
 697
 698                 -- Foreign exports
 699                 -- They need to be zonked, so we return them
 700         traceTc (text "Tc7") ;
 701         (foe_binds, foe_decls) <- tcForeignExports foreign_decls ;
 702
 703                 -- Rules
 704         rules <- tcRules rule_decls ;
 705
 706                 -- Wrap up
 707         traceTc (text "Tc7a") ;
 708         tcg_env <- getGblEnv ;
 709         let { all_binds = tc_val_binds   `unionBags`
 710                           inst_binds     `unionBags`
 711                           foe_binds  ;
 712
 713                 -- Extend the GblEnv with the (as yet un-zonked)
 714                 -- bindings, rules, foreign decls
 715               tcg_env' = tcg_env {  tcg_binds = tcg_binds tcg_env `unionBags` all_binds,
 716                                     tcg_rules = tcg_rules tcg_env ++ rules,
 717                                     tcg_fords = tcg_fords tcg_env ++ foe_decls ++ fi_decls } } ;
 718         return (tcg_env', tcl_env)
 719     }}}}}}
 720 \end{code}
 721
 722
 723 %************************************************************************
 724 %*                                                                      *
 725         Checking for 'main'
 726 %*                                                                      *
 727 %************************************************************************
 728
 729 \begin{code}
 730 checkMain :: TcM TcGblEnv
 731 -- If we are in module Main, check that 'main' is defined.
 732 checkMain
 733   = do { tcg_env   <- getGblEnv ;
 734          dflags    <- getDOpts ;
 735          let { main_mod = mainModIs dflags ;
 736                main_fn  = case mainFunIs dflags of {
 737                                 Just fn -> mkRdrUnqual (mkVarOccFS (mkFastString fn)) ;
 738                                 Nothing -> main_RDR_Unqual } } ;
 739
 740          check_main dflags tcg_env main_mod main_fn
 741     }
 742
 743
 744 check_main dflags tcg_env main_mod main_fn
 745  | mod /= main_mod
 746  = traceTc (text "checkMain not" <+> ppr main_mod <+> ppr mod) >>
 747    return tcg_env
 748
 749  | otherwise
 750  = addErrCtxt mainCtxt                  $
 751    do   { mb_main <- lookupSrcOcc_maybe main_fn
 752                 -- Check that 'main' is in scope
 753                 -- It might be imported from another module!
 754         ; case mb_main of {
 755              Nothing -> do { traceTc (text "checkMain fail" <+> ppr main_mod <+> ppr main_fn)
 756                            ; complain_no_main
 757                            ; return tcg_env } ;
 758              Just main_name -> do
 759         { traceTc (text "checkMain found" <+> ppr main_mod <+> ppr main_fn)
 760         ; let { rhs = nlHsApp (nlHsVar runMainIOName) (nlHsVar main_name) }
 761                         -- :Main.main :: IO () = runMainIO main
 762
 763         ; (main_expr, ty) <- setSrcSpan (srcLocSpan (getSrcLoc main_name)) $
 764                              tcInferRho rhs
 765
 766                 -- See Note [Root-main Id]
 767         ; let { root_main_name =  mkExternalName rootMainKey rOOT_MAIN
 768                                    (mkVarOccFS FSLIT("main"))
 769                                    (getSrcLoc main_name)
 770               ; root_main_id = Id.mkExportedLocalId root_main_name ty
 771               ; main_bind    = noLoc (VarBind root_main_id main_expr) }
 772
 773         ; return (tcg_env { tcg_binds = tcg_binds tcg_env
 774                                         `snocBag` main_bind,
 775                             tcg_dus   = tcg_dus tcg_env
 776                                         `plusDU` usesOnly (unitFV main_name)
 777                         -- Record the use of 'main', so that we don't
 778                         -- complain about it being defined but not used
 779                  })
 780     }}}
 781   where
 782     mod = tcg_mod tcg_env
 783
 784     complain_no_main | ghcLink dflags == LinkInMemory = return ()
 785                      | otherwise = failWithTc noMainMsg
 786         -- In interactive mode, don't worry about the absence of 'main'
 787         -- In other modes, fail altogether, so that we don't go on
 788         -- and complain a second time when processing the export list.
 789
 790     mainCtxt  = ptext SLIT("When checking the type of the main function") <+> quotes (ppr main_fn)
 791     noMainMsg = ptext SLIT("The main function") <+> quotes (ppr main_fn)
 792                 <+> ptext SLIT("is not defined in module") <+> quotes (ppr main_mod)
 793 \end{code}
 794
 795 Note [Root-main Id]
 796 ~~~~~~~~~~~~~~~~~~~
 797 The function that the RTS invokes is always :Main.main, which we call
 798 root_main_id.  (Because GHC allows the user to have a module not
 799 called Main as the main module, we can't rely on the main function
 800 being called "Main.main".  That's why root_main_id has a fixed module
 801 ":Main".)
 802
 803 This is unusual: it's a LocalId whose Name has a Module from another
 804 module.  Tiresomely, we must filter it out again in MkIface, les we
 805 get two defns for 'main' in the interface file!
 806
 807
 808 %*********************************************************
 809 %*                                                       *
 810                 GHCi stuff
 811 %*                                                       *
 812 %*********************************************************
 813
 814 \begin{code}
 815 #ifdef GHCI
 816 setInteractiveContext :: HscEnv -> InteractiveContext -> TcRn a -> TcRn a
 817 setInteractiveContext hsc_env icxt thing_inside
 818   = let
 819         -- Initialise the tcg_inst_env with instances
 820         -- from all home modules.  This mimics the more selective
 821         -- call to hptInstances in tcRnModule
 822         dfuns = hptInstances hsc_env (\mod -> True)
 823     in
 824     updGblEnv (\env -> env {
 825         tcg_rdr_env  = ic_rn_gbl_env icxt,
 826         tcg_inst_env = extendInstEnvList (tcg_inst_env env) dfuns }) $
 827
 828
 829     tcExtendIdEnv (typeEnvIds (ic_type_env icxt)) $
 830         -- tcExtendIdEnv does lots:
 831         --   - it extends the local type env (tcl_env) with the given Ids,
 832         --   - it extends the local rdr env (tcl_rdr) with the Names from
 833         --     the given Ids
 834         --   - it adds the free tyvars of the Ids to the tcl_tyvars
 835         --     set.
 836         --
 837         -- We should have no Ids with the same name in the
 838         -- ic_type_env, otherwise we'll end up with shadowing in the
 839         -- tcl_rdr, and it's random which one will be in scope.
 840
 841     do  { traceTc (text "setIC" <+> ppr (ic_type_env icxt))
 842         ; thing_inside }
 843 \end{code}
 844
 845
 846 \begin{code}
 847 tcRnStmt :: HscEnv
 848          -> InteractiveContext
 849          -> LStmt RdrName
 850          -> IO (Maybe (InteractiveContext, [Name], LHsExpr Id))
 851                 -- The returned [Name] is the same as the input except for
 852                 -- ExprStmt, in which case the returned [Name] is [itName]
 853                 --
 854                 -- The returned TypecheckedHsExpr is of type IO [ () ],
 855                 -- a list of the bound values, coerced to ().
 856
 857 tcRnStmt hsc_env ictxt rdr_stmt
 858   = initTcPrintErrors hsc_env iNTERACTIVE $
 859     setInteractiveContext hsc_env ictxt $ do {
 860
 861     -- Rename; use CmdLineMode because tcRnStmt is only used interactively
 862     (([rn_stmt], _), fvs) <- rnStmts DoExpr [rdr_stmt] (return ((), emptyFVs)) ;
 863     traceRn (text "tcRnStmt" <+> vcat [ppr rdr_stmt, ppr rn_stmt, ppr fvs]) ;
 864     failIfErrsM ;
 865
 866     -- The real work is done here
 867     (bound_ids, tc_expr) <- mkPlan rn_stmt ;
 868     zonked_expr <- zonkTopLExpr tc_expr ;
 869     zonked_ids  <- zonkTopBndrs bound_ids ;
 870
 871         -- None of the Ids should be of unboxed type, because we
 872         -- cast them all to HValues in the end!
 873     mappM bad_unboxed (filter (isUnLiftedType . idType) zonked_ids) ;
 874
 875     traceTc (text "tcs 1") ;
 876     let {       -- (a) Make all the bound ids "global" ids, now that
 877                 --     they're notionally top-level bindings.  This is
 878                 --     important: otherwise when we come to compile an expression
 879                 --     using these ids later, the byte code generator will consider
 880                 --     the occurrences to be free rather than global.
 881                 --
 882                 -- (b) Tidy their types; this is important, because :info may
 883                 --     ask to look at them, and :info expects the things it looks
 884                 --     up to have tidy types
 885         global_ids = map globaliseAndTidy zonked_ids ;
 886
 887                 -- Update the interactive context
 888         type_env = ic_type_env ictxt ;
 889
 890         bound_names = map idName global_ids ;
 891
 892 {- ---------------------------------------------
 893    At one stage I removed any shadowed bindings from the type_env;
 894    they are inaccessible but might, I suppose, cause a space leak if we leave them there.
 895    However, with Template Haskell they aren't necessarily inaccessible.  Consider this
 896    GHCi session
 897          Prelude> let f n = n * 2 :: Int
 898          Prelude> fName <- runQ [| f |]
 899          Prelude> $(return $ AppE fName (LitE (IntegerL 7)))
 900          14
 901          Prelude> let f n = n * 3 :: Int
 902          Prelude> $(return $ AppE fName (LitE (IntegerL 7)))
 903    In the last line we use 'fName', which resolves to the *first* 'f'
 904    in scope. If we delete it from the type env, GHCi crashes because
 905    it doesn't expect that.
 906
 907    Hence this code is commented out
 908
 909 -------------------------------------------------- -}
 910
 911         old_bound_names = map idName (typeEnvIds (ic_type_env ictxt)) ;
 912         shadowed = [ n | name <- bound_names,
 913                          n <- old_bound_names,
 914                          nameOccName name == nameOccName n ] ;
 915
 916         filtered_type_env = delListFromNameEnv type_env shadowed ;
 917
 918         new_type_env = extendTypeEnvWithIds filtered_type_env global_ids ;
 919         new_ic = ictxt { ic_type_env = new_type_env }
 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 (new_ic, bound_names, 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 tcRnRecoverDataCon :: HscEnv -> Ptr () -> IO (Maybe DataCon)
1209 tcRnRecoverDataCon hsc_env ptr
1210   = initTcPrintErrors hsc_env iNTERACTIVE $
1211     setInteractiveContext hsc_env (hsc_IC hsc_env) $ do
1212         name <- dataConInfoPtrToName ptr
1213         tcLookupDataCon name
1214
1215 tcRnLookupName :: HscEnv -> Name -> IO (Maybe TyThing)
1216 tcRnLookupName hsc_env name
1217   = initTcPrintErrors hsc_env iNTERACTIVE $
1218     setInteractiveContext hsc_env (hsc_IC hsc_env) $
1219     tcRnLookupName' name
1220
1221 -- To look up a name we have to look in the local environment (tcl_lcl)
1222 -- as well as the global environment, which is what tcLookup does.
1223 -- But we also want a TyThing, so we have to convert:
1224
1225 tcRnLookupName' :: Name -> TcRn TyThing
1226 tcRnLookupName' name = do
1227    tcthing <- tcLookup name
1228    case tcthing of
1229      AGlobal thing    -> return thing
1230      ATcId{tct_id=id} -> return (AnId id)
1231      _ -> panic "tcRnLookupName'"
1232
1233 tcRnGetInfo :: HscEnv
1234             -> Name
1235             -> IO (Maybe (TyThing, Fixity, [Instance]))
1236
1237 -- Used to implemnent :info in GHCi
1238 --
1239 -- Look up a RdrName and return all the TyThings it might be
1240 -- A capitalised RdrName is given to us in the DataName namespace,
1241 -- but we want to treat it as *both* a data constructor
1242 --  *and* as a type or class constructor;
1243 -- hence the call to dataTcOccs, and we return up to two results
1244 tcRnGetInfo hsc_env name
1245   = initTcPrintErrors hsc_env iNTERACTIVE $
1246     let ictxt = hsc_IC hsc_env in
1247     setInteractiveContext hsc_env ictxt $ do
1248
1249         -- Load the interface for all unqualified types and classes
1250         -- That way we will find all the instance declarations
1251         -- (Packages have not orphan modules, and we assume that
1252         --  in the home package all relevant modules are loaded.)
1253     loadUnqualIfaces ictxt
1254
1255     thing <- tcRnLookupName' name
1256     fixity <- lookupFixityRn name
1257     ispecs <- lookupInsts (icPrintUnqual ictxt) thing
1258     return (thing, fixity, ispecs)
1259
1260 lookupInsts :: PrintUnqualified -> TyThing -> TcM [Instance]
1261 -- Filter the instances by the ones whose tycons (or clases resp)
1262 -- are in scope unqualified.  Otherwise we list a whole lot too many!
1263 lookupInsts print_unqual (AClass cls)
1264   = do  { inst_envs <- tcGetInstEnvs
1265         ; return [ ispec
1266                  | ispec <- classInstances inst_envs cls
1267                  , plausibleDFun print_unqual (instanceDFunId ispec) ] }
1268
1269 lookupInsts print_unqual (ATyCon tc)
1270   = do  { eps <- getEps -- Load all instances for all classes that are
1271                         -- in the type environment (which are all the ones
1272                         -- we've seen in any interface file so far)
1273         ; (pkg_ie, home_ie) <- tcGetInstEnvs    -- Search all
1274         ; return [ ispec
1275                  | ispec <- instEnvElts home_ie ++ instEnvElts pkg_ie
1276                  , let dfun = instanceDFunId ispec
1277                  , relevant dfun
1278                  , plausibleDFun print_unqual dfun ] }
1279   where
1280     relevant df = tc_name `elemNameSet` tyClsNamesOfDFunHead (idType df)
1281     tc_name     = tyConName tc
1282
1283 lookupInsts print_unqual other = return []
1284
1285 plausibleDFun print_unqual dfun -- Dfun involving only names that print unqualified
1286   = all ok (nameSetToList (tyClsNamesOfType (idType dfun)))
1287   where
1288     ok name | isBuiltInSyntax name = True
1289             | isExternalName name  =
1290                 isNothing $ fst print_unqual (nameModule name)
1291                                              (nameOccName name)
1292             | otherwise            = True
1293
1294 loadUnqualIfaces :: InteractiveContext -> TcM ()
1295 -- Load the home module for everything that is in scope unqualified
1296 -- This is so that we can accurately report the instances for
1297 -- something
1298 loadUnqualIfaces ictxt
1299   = initIfaceTcRn $
1300     mapM_ (loadSysInterface doc) (moduleSetElts (mkModuleSet unqual_mods))
1301   where
1302     unqual_mods = [ nameModule name
1303                   | gre <- globalRdrEnvElts (ic_rn_gbl_env ictxt),
1304                     let name = gre_name gre,
1305                     not (isInternalName name),
1306                     isTcOcc (nameOccName name),  -- Types and classes only
1307                     unQualOK gre ]               -- In scope unqualified
1308     doc = ptext SLIT("Need interface for module whose export(s) are in scope unqualified")
1309 #endif /* GHCI */
1310 \end{code}
1311
1312 %************************************************************************
1313 %*                                                                      *
1314                 Degugging output
1315 %*                                                                      *
1316 %************************************************************************
1317
1318 \begin{code}
1319 rnDump :: SDoc -> TcRn ()
1320 -- Dump, with a banner, if -ddump-rn
1321 rnDump doc = do { dumpOptTcRn Opt_D_dump_rn (mkDumpDoc "Renamer" doc) }
1322
1323 tcDump :: TcGblEnv -> TcRn ()
1324 tcDump env
1325  = do { dflags <- getDOpts ;
1326
1327         -- Dump short output if -ddump-types or -ddump-tc
1328         ifM (dopt Opt_D_dump_types dflags || dopt Opt_D_dump_tc dflags)
1329             (dumpTcRn short_dump) ;
1330
1331         -- Dump bindings if -ddump-tc
1332         dumpOptTcRn Opt_D_dump_tc (mkDumpDoc "Typechecker" full_dump)
1333    }
1334   where
1335     short_dump = pprTcGblEnv env
1336     full_dump  = pprLHsBinds (tcg_binds env)
1337         -- NB: foreign x-d's have undefined's in their types;
1338         --     hence can't show the tc_fords
1339
1340 tcCoreDump mod_guts
1341  = do { dflags <- getDOpts ;
1342         ifM (dopt Opt_D_dump_types dflags || dopt Opt_D_dump_tc dflags)
1343             (dumpTcRn (pprModGuts mod_guts)) ;
1344
1345         -- Dump bindings if -ddump-tc
1346         dumpOptTcRn Opt_D_dump_tc (mkDumpDoc "Typechecker" full_dump) }
1347   where
1348     full_dump = pprCoreBindings (mg_binds mod_guts)
1349
1350 -- It's unpleasant having both pprModGuts and pprModDetails here
1351 pprTcGblEnv :: TcGblEnv -> SDoc
1352 pprTcGblEnv (TcGblEnv { tcg_type_env  = type_env,
1353                         tcg_insts     = insts,
1354                         tcg_fam_insts = fam_insts,
1355                         tcg_rules     = rules,
1356                         tcg_imports   = imports })
1357   = vcat [ ppr_types insts type_env
1358          , ppr_tycons fam_insts type_env
1359          , ppr_insts insts
1360          , ppr_fam_insts fam_insts
1361          , vcat (map ppr rules)
1362          , ppr_gen_tycons (typeEnvTyCons type_env)
1363          , ptext SLIT("Dependent modules:") <+> ppr (eltsUFM (imp_dep_mods imports))
1364          , ptext SLIT("Dependent packages:") <+> ppr (imp_dep_pkgs imports)]
1365
1366 pprModGuts :: ModGuts -> SDoc
1367 pprModGuts (ModGuts { mg_types = type_env,
1368                       mg_rules = rules })
1369   = vcat [ ppr_types [] type_env,
1370            ppr_rules rules ]
1371
1372 ppr_types :: [Instance] -> TypeEnv -> SDoc
1373 ppr_types insts type_env
1374   = text "TYPE SIGNATURES" $$ nest 4 (ppr_sigs ids)
1375   where
1376     dfun_ids = map instanceDFunId insts
1377     ids = [id | id <- typeEnvIds type_env, want_sig id]
1378     want_sig id | opt_PprStyle_Debug = True
1379                 | otherwise          = isLocalId id &&
1380                                        isExternalName (idName id) &&
1381                                        not (id `elem` dfun_ids)
1382         -- isLocalId ignores data constructors, records selectors etc.
1383         -- The isExternalName ignores local dictionary and method bindings
1384         -- that the type checker has invented.  Top-level user-defined things
1385         -- have External names.
1386
1387 ppr_tycons :: [FamInst] -> TypeEnv -> SDoc
1388 ppr_tycons fam_insts type_env
1389   = text "TYPE CONSTRUCTORS" $$ nest 4 (ppr_tydecls tycons)
1390   where
1391     fi_tycons = map famInstTyCon fam_insts
1392     tycons = [tycon | tycon <- typeEnvTyCons type_env, want_tycon tycon]
1393     want_tycon tycon | opt_PprStyle_Debug = True
1394                      | otherwise          = not (isImplicitTyCon tycon) &&
1395                                             isExternalName (tyConName tycon) &&
1396                                             not (tycon `elem` fi_tycons)
1397
1398 ppr_insts :: [Instance] -> SDoc
1399 ppr_insts []     = empty
1400 ppr_insts ispecs = text "INSTANCES" $$ nest 2 (pprInstances ispecs)
1401
1402 ppr_fam_insts :: [FamInst] -> SDoc
1403 ppr_fam_insts []        = empty
1404 ppr_fam_insts fam_insts =
1405   text "FAMILY INSTANCES" $$ nest 2 (pprFamInsts fam_insts)
1406
1407 ppr_sigs :: [Var] -> SDoc
1408 ppr_sigs ids
1409         -- Print type signatures; sort by OccName
1410   = vcat (map ppr_sig (sortLe le_sig ids))
1411   where
1412     le_sig id1 id2 = getOccName id1 <= getOccName id2
1413     ppr_sig id = ppr id <+> dcolon <+> ppr (tidyTopType (idType id))
1414
1415 ppr_tydecls :: [TyCon] -> SDoc
1416 ppr_tydecls tycons
1417         -- Print type constructor info; sort by OccName
1418   = vcat (map ppr_tycon (sortLe le_sig tycons))
1419   where
1420     le_sig tycon1 tycon2 = getOccName tycon1 <= getOccName tycon2
1421     ppr_tycon tycon
1422       | isCoercionTyCon tycon = ptext SLIT("coercion") <+> ppr tycon
1423       | otherwise             = ppr (tyThingToIfaceDecl (ATyCon tycon))
1424
1425 ppr_rules :: [CoreRule] -> SDoc
1426 ppr_rules [] = empty
1427 ppr_rules rs = vcat [ptext SLIT("{-# RULES"),
1428                       nest 4 (pprRules rs),
1429                       ptext SLIT("#-}")]
1430
1431 ppr_gen_tycons []  = empty
1432 ppr_gen_tycons tcs = vcat [ptext SLIT("Tycons with generics:"),
1433                            nest 2 (fsep (map ppr (filter tyConHasGenerics tcs)))]
1434 \end{code}