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