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