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