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