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