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