compiler/typecheck/TcRnDriver.lhs

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