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