Fix #481: use a safe recompilation check when Template Haskell is
[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[TcMovectle]{Typechecking a whole module}
6
7 \begin{code}
8 module TcRnDriver (
9 #ifdef GHCI
10         tcRnStmt, tcRnExpr, tcRnType,
11         tcRnLookupRdrName,
12         getModuleExports,
13 #endif
14         tcRnImports,
15         tcRnLookupName,
16         tcRnGetInfo,
17         tcRnModule, 
18         tcTopSrcDecls,
19         tcRnExtCore
20     ) where
21
22 #ifdef GHCI
23 import {-# SOURCE #-} TcSplice ( tcSpliceDecls )
24 #endif
25
26 import DynFlags
27 import StaticFlags
28 import HsSyn
29 import PrelNames
30 import RdrName
31 import TcHsSyn
32 import TcExpr
33 import TcRnMonad
34 import Coercion
35 import FamInst
36 import InstEnv
37 import FamInstEnv
38 import TcAnnotations
39 import TcBinds
40 import TcType   ( tidyTopType )
41 import TcDefaults
42 import TcEnv
43 import TcRules
44 import TcForeign
45 import TcInstDcls
46 import TcIface
47 import TcMType
48 import MkIface
49 import IfaceSyn
50 import TcSimplify
51 import TcTyClsDecls
52 import LoadIface
53 import RnNames
54 import RnEnv
55 import RnSource
56 import PprCore
57 import CoreSyn
58 import ErrUtils
59 import Id
60 import VarEnv
61 import Var
62 import Module
63 import UniqFM
64 import Name
65 import NameEnv
66 import NameSet
67 import TyCon
68 import SrcLoc
69 import HscTypes
70 import ListSetOps
71 import Outputable
72 import DataCon
73 import Type
74 import Class
75 import TcType   ( orphNamesOfDFunHead )
76 import Inst     ( tcGetInstEnvs )
77 import Data.List ( sortBy )
78
79 #ifdef GHCI
80 import TcType   ( isUnitTy, isTauTy )
81 import CoreUtils( mkPiTypes )
82 import TcHsType
83 import TcMatches
84 import RnTypes
85 import RnExpr
86 import IfaceEnv
87 import MkId
88 import BasicTypes
89 import TidyPgm    ( globaliseAndTidyId )
90 import TysWiredIn ( unitTy, mkListTy )
91 #endif
92
93 import FastString
94 import Maybes
95 import Util
96 import Bag
97
98 import Control.Monad
99
100 #include "HsVersions.h"
101 \end{code}
102
103 %************************************************************************
104 %*                                                                      *
105         Typecheck and rename a module
106 %*                                                                      *
107 %************************************************************************
108
109
110 \begin{code}
111 tcRnModule :: HscEnv 
112            -> HscSource
113            -> Bool              -- True <=> save renamed syntax
114            -> Located (HsModule RdrName)
115            -> IO (Messages, Maybe TcGblEnv)
116
117 tcRnModule hsc_env hsc_src save_rn_syntax
118          (L loc (HsModule maybe_mod export_ies 
119                           import_decls local_decls mod_deprec
120                           maybe_doc_hdr))
121  = do { showPass (hsc_dflags hsc_env) "Renamer/typechecker" ;
122
123    let { this_pkg = thisPackage (hsc_dflags hsc_env) ;
124          this_mod = case maybe_mod of
125                         Nothing  -> mAIN        -- 'module M where' is omitted
126                         Just (L _ mod) -> mkModule this_pkg mod } ;
127                                                 -- The normal case
128                 
129    initTc hsc_env hsc_src save_rn_syntax this_mod $ 
130    setSrcSpan loc $
131    do {         -- Deal with imports;
132         tcg_env <- tcRnImports hsc_env this_mod import_decls ;
133         setGblEnv tcg_env               $ do {
134
135                 -- Load the hi-boot interface for this module, if any
136                 -- We do this now so that the boot_names can be passed
137                 -- to tcTyAndClassDecls, because the boot_names are 
138                 -- automatically considered to be loop breakers
139                 --
140                 -- Do this *after* tcRnImports, so that we know whether
141                 -- a module that we import imports us; and hence whether to
142                 -- look for a hi-boot file
143         boot_iface <- tcHiBootIface hsc_src this_mod ;
144
145                 -- Rename and type check the declarations
146         traceRn (text "rn1a") ;
147         tcg_env <- if isHsBoot hsc_src then
148                         tcRnHsBootDecls local_decls
149                    else 
150                         tcRnSrcDecls boot_iface local_decls ;
151         setGblEnv tcg_env               $ do {
152
153                 -- Report the use of any deprecated things
154                 -- We do this *before* processsing the export list so
155                 -- that we don't bleat about re-exporting a deprecated
156                 -- thing (especially via 'module Foo' export item)
157                 -- That is, only uses in the *body* of the module are complained about
158         traceRn (text "rn3") ;
159         failIfErrsM ;   -- finishWarnings crashes sometimes 
160                         -- as a result of typechecker repairs (e.g. unboundNames)
161         tcg_env <- finishWarnings (hsc_dflags hsc_env) mod_deprec tcg_env ;
162
163                 -- Process the export list
164         traceRn (text "rn4a: before exports");
165         tcg_env <- rnExports (isJust maybe_mod) export_ies tcg_env ;
166         traceRn (text "rn4b: after exportss") ;
167
168                 -- Check that main is exported (must be after rnExports)
169         checkMainExported tcg_env ;
170
171         -- Compare the hi-boot iface (if any) with the real thing
172         -- Must be done after processing the exports
173         tcg_env <- checkHiBootIface tcg_env boot_iface ;
174
175         -- The new type env is already available to stuff slurped from 
176         -- interface files, via TcEnv.updateGlobalTypeEnv
177         -- It's important that this includes the stuff in checkHiBootIface, 
178         -- because the latter might add new bindings for boot_dfuns, 
179         -- which may be mentioned in imported unfoldings
180
181                 -- Don't need to rename the Haddock documentation,
182                 -- it's not parsed by GHC anymore.
183         tcg_env <- return (tcg_env { tcg_doc_hdr = maybe_doc_hdr }) ;
184
185                 -- Report unused names
186         reportUnusedNames export_ies tcg_env ;
187
188                 -- Dump output and return
189         tcDump tcg_env ;
190         return tcg_env
191     }}}}
192 \end{code}
193
194
195 %************************************************************************
196 %*                                                                      *
197                 Import declarations
198 %*                                                                      *
199 %************************************************************************
200
201 \begin{code}
202 tcRnImports :: HscEnv -> Module -> [LImportDecl RdrName] -> TcM TcGblEnv
203 tcRnImports hsc_env this_mod import_decls
204   = do  { (rn_imports, rdr_env, imports,hpc_info) <- rnImports import_decls ;
205
206         ; let { dep_mods :: ModuleNameEnv (ModuleName, IsBootInterface)
207                 -- Make sure we record the dependencies from the DynFlags in the EPS or we
208                 -- end up hitting the sanity check in LoadIface.loadInterface that
209                 -- checks for unknown home-package modules being loaded. We put
210                 -- these dependencies on the left so their (non-source) imports
211                 -- take precedence over the (possibly-source) imports on the right.
212                 -- We don't add them to any other field (e.g. the imp_dep_mods of
213                 -- imports) because we don't want to load their instances etc.
214               ; dep_mods = listToUFM [(mod_nm, (mod_nm, False)) | mod_nm <- dynFlagDependencies (hsc_dflags hsc_env)]
215                                 `plusUFM` imp_dep_mods imports
216
217                 -- We want instance declarations from all home-package
218                 -- modules below this one, including boot modules, except
219                 -- ourselves.  The 'except ourselves' is so that we don't
220                 -- get the instances from this module's hs-boot file
221               ; want_instances :: ModuleName -> Bool
222               ; want_instances mod = mod `elemUFM` dep_mods
223                                    && mod /= moduleName this_mod
224               ; (home_insts, home_fam_insts) = hptInstances hsc_env 
225                                                             want_instances
226               } ;
227
228                 -- Record boot-file info in the EPS, so that it's 
229                 -- visible to loadHiBootInterface in tcRnSrcDecls,
230                 -- and any other incrementally-performed imports
231         ; updateEps_ (\eps -> eps { eps_is_boot = dep_mods }) ;
232
233                 -- Update the gbl env
234         ; updGblEnv ( \ gbl -> 
235             gbl { 
236               tcg_rdr_env      = plusOccEnv (tcg_rdr_env gbl) rdr_env,
237               tcg_imports      = tcg_imports gbl `plusImportAvails` imports,
238               tcg_rn_imports   = rn_imports,
239               tcg_inst_env     = extendInstEnvList (tcg_inst_env gbl) home_insts,
240               tcg_fam_inst_env = extendFamInstEnvList (tcg_fam_inst_env gbl) 
241                                                       home_fam_insts,
242               tcg_hpc          = hpc_info
243             }) $ do {
244
245         ; traceRn (text "rn1" <+> ppr (imp_dep_mods imports))
246                 -- Fail if there are any errors so far
247                 -- The error printing (if needed) takes advantage 
248                 -- of the tcg_env we have now set
249 --      ; traceIf (text "rdr_env: " <+> ppr rdr_env)
250         ; failIfErrsM
251
252                 -- Load any orphan-module and family instance-module
253                 -- interfaces, so that their rules and instance decls will be
254                 -- found.
255         ; loadOrphanModules (imp_orphs  imports) False
256
257                 -- Check type-family consistency
258         ; traceRn (text "rn1: checking family instance consistency")
259         ; let { dir_imp_mods = moduleEnvKeys
260                              . imp_mods 
261                              $ imports }
262         ; checkFamInstConsistency (imp_finsts imports) dir_imp_mods ;
263
264         ; getGblEnv } }
265 \end{code}
266
267
268 %************************************************************************
269 %*                                                                      *
270         Type-checking external-core modules
271 %*                                                                      *
272 %************************************************************************
273
274 \begin{code}
275 tcRnExtCore :: HscEnv 
276             -> HsExtCore RdrName
277             -> IO (Messages, Maybe ModGuts)
278         -- Nothing => some error occurred 
279
280 tcRnExtCore hsc_env (HsExtCore this_mod decls src_binds)
281         -- The decls are IfaceDecls; all names are original names
282  = do { showPass (hsc_dflags hsc_env) "Renamer/typechecker" ;
283
284    initTc hsc_env ExtCoreFile False this_mod $ do {
285
286    let { ldecls  = map noLoc decls } ;
287
288        -- bring the type and class decls into scope
289        -- ToDo: check that this doesn't need to extract the val binds.
290        --       It seems that only the type and class decls need to be in scope below because
291        --          (a) tcTyAndClassDecls doesn't need the val binds, and 
292        --          (b) tcExtCoreBindings doesn't need anything
293        --              (in fact, it might not even need to be in the scope of
294        --               this tcg_env at all)
295    avails  <- getLocalNonValBinders (mkFakeGroup ldecls) ;
296    tc_envs <- extendGlobalRdrEnvRn avails emptyFsEnv {- no fixity decls -} ;
297
298    setEnvs tc_envs $ do {
299
300    (rn_decls, _fvs) <- checkNoErrs $ rnTyClDecls [ldecls] ;
301
302         -- Dump trace of renaming part
303    rnDump (ppr rn_decls) ;
304
305         -- Typecheck them all together so that
306         -- any mutually recursive types are done right
307         -- Just discard the auxiliary bindings; they are generated 
308         -- only for Haskell source code, and should already be in Core
309    (tcg_env, _aux_binds) <- tcTyAndClassDecls emptyModDetails rn_decls ;
310
311    setGblEnv tcg_env $ do {
312         -- Make the new type env available to stuff slurped from interface files
313    
314         -- Now the core bindings
315    core_binds <- initIfaceExtCore (tcExtCoreBindings src_binds) ;
316
317         -- Wrap up
318    let {
319         bndrs      = bindersOfBinds core_binds ;
320         my_exports = map (Avail . idName) bndrs ;
321                 -- ToDo: export the data types also?
322
323         final_type_env = 
324              extendTypeEnvWithIds (tcg_type_env tcg_env) bndrs ;
325
326         mod_guts = ModGuts {    mg_module    = this_mod,
327                                 mg_boot      = False,
328                                 mg_used_names = emptyNameSet, -- ToDo: compute usage
329                                 mg_used_th   = False,
330                                 mg_dir_imps  = emptyModuleEnv, -- ??
331                                 mg_deps      = noDependencies,  -- ??
332                                 mg_exports   = my_exports,
333                                 mg_types     = final_type_env,
334                                 mg_insts     = tcg_insts tcg_env,
335                                 mg_fam_insts = tcg_fam_insts tcg_env,
336                                 mg_inst_env  = tcg_inst_env tcg_env,
337                                 mg_fam_inst_env = tcg_fam_inst_env tcg_env,
338                                 mg_rules     = [],
339                                 mg_vect_decls = [],
340                                 mg_anns      = [],
341                                 mg_binds     = core_binds,
342
343                                 -- Stubs
344                                 mg_rdr_env   = emptyGlobalRdrEnv,
345                                 mg_fix_env   = emptyFixityEnv,
346                                 mg_warns     = NoWarnings,
347                                 mg_foreign   = NoStubs,
348                                 mg_hpc_info  = emptyHpcInfo False,
349                                 mg_modBreaks = emptyModBreaks,
350                                 mg_vect_info = noVectInfo,
351                                 mg_trust_pkg = False
352                     } } ;
353
354    tcCoreDump mod_guts ;
355
356    return mod_guts
357    }}}}
358
359 mkFakeGroup :: [LTyClDecl a] -> HsGroup a
360 mkFakeGroup decls -- Rather clumsy; lots of unused fields
361   = emptyRdrGroup { hs_tyclds = [decls] }
362 \end{code}
363
364
365 %************************************************************************
366 %*                                                                      *
367         Type-checking the top level of a module
368 %*                                                                      *
369 %************************************************************************
370
371 \begin{code}
372 tcRnSrcDecls :: ModDetails -> [LHsDecl RdrName] -> TcM TcGblEnv
373         -- Returns the variables free in the decls
374         -- Reason: solely to report unused imports and bindings
375 tcRnSrcDecls boot_iface decls
376  = do {         -- Do all the declarations
377         (tc_envs, lie) <- captureConstraints $ tc_rn_src_decls boot_iface decls ;
378       ; traceTc "Tc8" empty ;
379       ; setEnvs tc_envs $ 
380    do { 
381
382              --         Finish simplifying class constraints
383              -- 
384              -- simplifyTop deals with constant or ambiguous InstIds.  
385              -- How could there be ambiguous ones?  They can only arise if a
386              -- top-level decl falls under the monomorphism restriction
387              -- and no subsequent decl instantiates its type.
388              --
389              -- We do this after checkMain, so that we use the type info 
390              -- thaat checkMain adds
391              -- 
392              -- We do it with both global and local env in scope:
393              --  * the global env exposes the instances to simplifyTop
394              --  * the local env exposes the local Ids to simplifyTop, 
395              --    so that we get better error messages (monomorphism restriction)
396         new_ev_binds <- simplifyTop lie ;
397         traceTc "Tc9" empty ;
398
399         failIfErrsM ;   -- Don't zonk if there have been errors
400                         -- It's a waste of time; and we may get debug warnings
401                         -- about strangely-typed TyCons!
402
403         -- Zonk the final code.  This must be done last.
404         -- Even simplifyTop may do some unification.
405         -- This pass also warns about missing type signatures
406         let { (tcg_env, _) = tc_envs
407             ; TcGblEnv { tcg_type_env  = type_env,
408                          tcg_binds     = binds,
409                          tcg_sigs      = sig_ns,
410                          tcg_ev_binds  = cur_ev_binds,
411                          tcg_imp_specs = imp_specs,
412                          tcg_rules     = rules,
413                          tcg_vects     = vects,
414                          tcg_fords     = fords } = tcg_env
415             ; all_ev_binds = cur_ev_binds `unionBags` new_ev_binds } ;
416
417         (bind_ids, ev_binds', binds', fords', imp_specs', rules', vects') 
418             <- zonkTopDecls all_ev_binds binds sig_ns rules vects imp_specs fords ;
419         
420         let { final_type_env = extendTypeEnvWithIds type_env bind_ids
421             ; tcg_env' = tcg_env { tcg_binds    = binds',
422                                    tcg_ev_binds = ev_binds',
423                                    tcg_imp_specs = imp_specs',
424                                    tcg_rules    = rules', 
425                                    tcg_vects    = vects', 
426                                    tcg_fords    = fords' } } ;
427
428         setGlobalTypeEnv tcg_env' final_type_env                                   
429    } }
430
431 tc_rn_src_decls :: ModDetails -> [LHsDecl RdrName] -> TcM (TcGblEnv, TcLclEnv)
432 -- Loops around dealing with each top level inter-splice group 
433 -- in turn, until it's dealt with the entire module
434 tc_rn_src_decls boot_details ds
435  = do { (first_group, group_tail) <- findSplice ds  ;
436                 -- If ds is [] we get ([], Nothing)
437
438         -- Deal with decls up to, but not including, the first splice
439         (tcg_env, rn_decls) <- rnTopSrcDecls first_group ;
440                 -- rnTopSrcDecls fails if there are any errors
441
442         (tcg_env, tcl_env) <- setGblEnv tcg_env $ 
443                               tcTopSrcDecls boot_details rn_decls ;
444
445         -- If there is no splice, we're nearly done
446         setEnvs (tcg_env, tcl_env) $ 
447         case group_tail of {
448            Nothing -> do { tcg_env <- checkMain ;       -- Check for `main'
449                            return (tcg_env, tcl_env) 
450                       } ;
451
452 #ifndef GHCI
453         -- There shouldn't be a splice
454            Just (SpliceDecl {}, _) -> do {
455         failWithTc (text "Can't do a top-level splice; need a bootstrapped compiler")
456 #else
457         -- If there's a splice, we must carry on
458            Just (SpliceDecl splice_expr _, rest_ds) -> do {
459
460         -- Rename the splice expression, and get its supporting decls
461         (rn_splice_expr, splice_fvs) <- checkNoErrs (rnLExpr splice_expr) ;
462                 -- checkNoErrs: don't typecheck if renaming failed
463         rnDump (ppr rn_splice_expr) ;
464
465         -- Execute the splice
466         spliced_decls <- tcSpliceDecls rn_splice_expr ;
467
468         -- Glue them on the front of the remaining decls and loop
469         setGblEnv (tcg_env `addTcgDUs` usesOnly splice_fvs) $
470         tc_rn_src_decls boot_details (spliced_decls ++ rest_ds)
471 #endif /* GHCI */
472     } } }
473 \end{code}
474
475 %************************************************************************
476 %*                                                                      *
477         Compiling hs-boot source files, and
478         comparing the hi-boot interface with the real thing
479 %*                                                                      *
480 %************************************************************************
481
482 \begin{code}
483 tcRnHsBootDecls :: [LHsDecl RdrName] -> TcM TcGblEnv
484 tcRnHsBootDecls decls
485    = do { (first_group, group_tail) <- findSplice decls
486
487                 -- Rename the declarations
488         ; (tcg_env, HsGroup { 
489                    hs_tyclds = tycl_decls, 
490                    hs_instds = inst_decls,
491                    hs_derivds = deriv_decls,
492                    hs_fords  = for_decls,
493                    hs_defds  = def_decls,  
494                    hs_ruleds = rule_decls, 
495                    hs_vects  = vect_decls, 
496                    hs_annds  = _,
497                    hs_valds  = val_binds }) <- rnTopSrcDecls first_group
498         ; (gbl_env, lie) <- captureConstraints $ setGblEnv tcg_env $ do {
499
500
501                 -- Check for illegal declarations
502         ; case group_tail of
503              Just (SpliceDecl d _, _) -> badBootDecl "splice" d
504              Nothing                  -> return ()
505         ; mapM_ (badBootDecl "foreign") for_decls
506         ; mapM_ (badBootDecl "default") def_decls
507         ; mapM_ (badBootDecl "rule")    rule_decls
508         ; mapM_ (badBootDecl "vect")    vect_decls
509
510                 -- Typecheck type/class decls
511         ; traceTc "Tc2" empty
512         ; (tcg_env, aux_binds) 
513                <- tcTyAndClassDecls emptyModDetails tycl_decls
514         ; setGblEnv tcg_env    $ do {
515
516                 -- Typecheck instance decls
517                 -- Family instance declarations are rejected here
518         ; traceTc "Tc3" empty
519         ; (tcg_env, inst_infos, _deriv_binds) 
520             <- tcInstDecls1 (concat tycl_decls) inst_decls deriv_decls
521
522         ; setGblEnv tcg_env     $ do {
523
524                 -- Typecheck value declarations
525         ; traceTc "Tc5" empty 
526         ; val_ids <- tcHsBootSigs val_binds
527
528                 -- Wrap up
529                 -- No simplification or zonking to do
530         ; traceTc "Tc7a" empty
531         ; gbl_env <- getGblEnv 
532         
533                 -- Make the final type-env
534                 -- Include the dfun_ids so that their type sigs
535                 -- are written into the interface file. 
536                 -- And similarly the aux_ids from aux_binds
537         ; let { type_env0 = tcg_type_env gbl_env
538               ; type_env1 = extendTypeEnvWithIds type_env0 val_ids
539               ; type_env2 = extendTypeEnvWithIds type_env1 dfun_ids 
540               ; type_env3 = extendTypeEnvWithIds type_env2 aux_ids 
541               ; dfun_ids = map iDFunId inst_infos
542               ; aux_ids  = case aux_binds of
543                              ValBindsOut _ sigs -> [id | L _ (IdSig id) <- sigs]
544                              _                  -> panic "tcRnHsBoodDecls"
545               }
546
547         ; setGlobalTypeEnv gbl_env type_env3
548    }}}
549    ; traceTc "boot" (ppr lie); return gbl_env }
550
551 badBootDecl :: String -> Located decl -> TcM ()
552 badBootDecl what (L loc _) 
553   = addErrAt loc (char 'A' <+> text what 
554       <+> ptext (sLit "declaration is not (currently) allowed in a hs-boot file"))
555 \end{code}
556
557 Once we've typechecked the body of the module, we want to compare what
558 we've found (gathered in a TypeEnv) with the hi-boot details (if any).
559
560 \begin{code}
561 checkHiBootIface :: TcGblEnv -> ModDetails -> TcM TcGblEnv
562 -- Compare the hi-boot file for this module (if there is one)
563 -- with the type environment we've just come up with
564 -- In the common case where there is no hi-boot file, the list
565 -- of boot_names is empty.
566 --
567 -- The bindings we return give bindings for the dfuns defined in the
568 -- hs-boot file, such as        $fbEqT = $fEqT
569
570 checkHiBootIface
571         tcg_env@(TcGblEnv { tcg_src = hs_src, tcg_binds = binds,
572                             tcg_insts = local_insts, 
573                             tcg_type_env = local_type_env, tcg_exports = local_exports })
574         (ModDetails { md_insts = boot_insts, md_fam_insts = boot_fam_insts,
575                       md_types = boot_type_env, md_exports = boot_exports })
576   | isHsBoot hs_src     -- Current module is already a hs-boot file!
577   = return tcg_env      
578
579   | otherwise
580   = do  { traceTc "checkHiBootIface" $ vcat
581              [ ppr boot_type_env, ppr boot_insts, ppr boot_exports]
582
583                 -- Check the exports of the boot module, one by one
584         ; mapM_ check_export boot_exports
585
586                 -- Check for no family instances
587         ; unless (null boot_fam_insts) $
588             panic ("TcRnDriver.checkHiBootIface: Cannot handle family " ++
589                    "instances in boot files yet...")
590             -- FIXME: Why?  The actual comparison is not hard, but what would
591             --        be the equivalent to the dfun bindings returned for class
592             --        instances?  We can't easily equate tycons...
593
594                 -- Check instance declarations
595         ; mb_dfun_prs <- mapM check_inst boot_insts
596         ; let dfun_prs   = catMaybes mb_dfun_prs
597               boot_dfuns = map fst dfun_prs
598               dfun_binds = listToBag [ mkVarBind boot_dfun (nlHsVar dfun)
599                                      | (boot_dfun, dfun) <- dfun_prs ]
600               type_env'  = extendTypeEnvWithIds local_type_env boot_dfuns
601               tcg_env'   = tcg_env { tcg_binds = binds `unionBags` dfun_binds }
602
603         ; failIfErrsM
604         ; setGlobalTypeEnv tcg_env' type_env' }
605              -- Update the global type env *including* the knot-tied one
606              -- so that if the source module reads in an interface unfolding
607              -- mentioning one of the dfuns from the boot module, then it
608              -- can "see" that boot dfun.   See Trac #4003
609   where
610     check_export boot_avail     -- boot_avail is exported by the boot iface
611       | name `elem` dfun_names = return ()      
612       | isWiredInName name     = return ()      -- No checking for wired-in names.  In particular,
613                                                 -- 'error' is handled by a rather gross hack
614                                                 -- (see comments in GHC.Err.hs-boot)
615
616         -- Check that the actual module exports the same thing
617       | not (null missing_names)
618       = addErrAt (nameSrcSpan (head missing_names)) 
619                  (missingBootThing (head missing_names) "exported by")
620
621         -- If the boot module does not *define* the thing, we are done
622         -- (it simply re-exports it, and names match, so nothing further to do)
623       | isNothing mb_boot_thing = return ()
624
625         -- Check that the actual module also defines the thing, and 
626         -- then compare the definitions
627       | Just real_thing <- lookupTypeEnv local_type_env name,
628         Just boot_thing <- mb_boot_thing
629       = when (not (checkBootDecl boot_thing real_thing))
630             $ addErrAt (nameSrcSpan (getName boot_thing))
631                        (let boot_decl = tyThingToIfaceDecl 
632                                                (fromJust mb_boot_thing)
633                             real_decl = tyThingToIfaceDecl real_thing
634                         in bootMisMatch real_thing boot_decl real_decl)
635
636       | otherwise
637       = addErrTc (missingBootThing name "defined in")
638       where
639         name          = availName boot_avail
640         mb_boot_thing = lookupTypeEnv boot_type_env name
641         missing_names = case lookupNameEnv local_export_env name of
642                           Nothing    -> [name]
643                           Just avail -> availNames boot_avail `minusList` availNames avail
644                  
645     dfun_names = map getName boot_insts
646
647     local_export_env :: NameEnv AvailInfo
648     local_export_env = availsToNameEnv local_exports
649
650     check_inst :: Instance -> TcM (Maybe (Id, Id))
651         -- Returns a pair of the boot dfun in terms of the equivalent real dfun
652     check_inst boot_inst
653         = case [dfun | inst <- local_insts, 
654                        let dfun = instanceDFunId inst,
655                        idType dfun `eqType` boot_inst_ty ] of
656             [] -> do { traceTc "check_inst" (vcat [ text "local_insts" <+> vcat (map (ppr . idType . instanceDFunId) local_insts)
657                                                   , text "boot_inst"   <+> ppr boot_inst
658                                                   , text "boot_inst_ty" <+> ppr boot_inst_ty
659                                                   ]) 
660                      ; addErrTc (instMisMatch boot_inst); return Nothing }
661             (dfun:_) -> return (Just (local_boot_dfun, dfun))
662         where
663           boot_dfun = instanceDFunId boot_inst
664           boot_inst_ty = idType boot_dfun
665           local_boot_dfun = Id.mkExportedLocalId (idName boot_dfun) boot_inst_ty
666
667
668 -- This has to compare the TyThing from the .hi-boot file to the TyThing
669 -- in the current source file.  We must be careful to allow alpha-renaming
670 -- where appropriate, and also the boot declaration is allowed to omit
671 -- constructors and class methods.
672 --
673 -- See rnfail055 for a good test of this stuff.
674
675 checkBootDecl :: TyThing -> TyThing -> Bool
676
677 checkBootDecl (AnId id1) (AnId id2)
678   = ASSERT(id1 == id2) 
679     (idType id1 `eqType` idType id2)
680
681 checkBootDecl (ATyCon tc1) (ATyCon tc2)
682   = checkBootTyCon tc1 tc2
683
684 checkBootDecl (AClass c1)  (AClass c2)
685   = let 
686        (clas_tyvars1, clas_fds1, sc_theta1, _, ats1, op_stuff1) 
687           = classExtraBigSig c1
688        (clas_tyvars2, clas_fds2, sc_theta2, _, ats2, op_stuff2) 
689           = classExtraBigSig c2
690
691        env0 = mkRnEnv2 emptyInScopeSet
692        env = rnBndrs2 env0 clas_tyvars1 clas_tyvars2
693
694        eqSig (id1, def_meth1) (id2, def_meth2)
695          = idName id1 == idName id2 &&
696            eqTypeX env op_ty1 op_ty2 &&
697            def_meth1 == def_meth2
698          where
699           (_, rho_ty1) = splitForAllTys (idType id1)
700           op_ty1 = funResultTy rho_ty1
701           (_, rho_ty2) = splitForAllTys (idType id2)
702           op_ty2 = funResultTy rho_ty2
703
704        eqFD (as1,bs1) (as2,bs2) = 
705          eqListBy (eqTypeX env) (mkTyVarTys as1) (mkTyVarTys as2) &&
706          eqListBy (eqTypeX env) (mkTyVarTys bs1) (mkTyVarTys bs2)
707
708        same_kind tv1 tv2 = eqKind (tyVarKind tv1) (tyVarKind tv2)
709     in
710        eqListBy same_kind clas_tyvars1 clas_tyvars2 &&
711              -- Checks kind of class
712        eqListBy eqFD clas_fds1 clas_fds2 &&
713        (null sc_theta1 && null op_stuff1 && null ats1
714         ||   -- Above tests for an "abstract" class
715         eqListBy (eqPredX env) sc_theta1 sc_theta2 &&
716         eqListBy eqSig op_stuff1 op_stuff2 &&
717         eqListBy checkBootTyCon ats1 ats2)
718
719 checkBootDecl (ADataCon dc1) (ADataCon _)
720   = pprPanic "checkBootDecl" (ppr dc1)
721
722 checkBootDecl _ _ = False -- probably shouldn't happen
723
724 ----------------
725 checkBootTyCon :: TyCon -> TyCon -> Bool
726 checkBootTyCon tc1 tc2
727   | not (eqKind (tyConKind tc1) (tyConKind tc2))
728   = False       -- First off, check the kind
729
730   | isSynTyCon tc1 && isSynTyCon tc2
731   = ASSERT(tc1 == tc2)
732     let tvs1 = tyConTyVars tc1; tvs2 = tyConTyVars tc2
733         env = rnBndrs2 env0 tvs1 tvs2
734
735         eqSynRhs SynFamilyTyCon SynFamilyTyCon
736             = True
737         eqSynRhs (SynonymTyCon t1) (SynonymTyCon t2)
738             = eqTypeX env t1 t2
739         eqSynRhs _ _ = False
740     in
741     equalLength tvs1 tvs2 &&
742     eqSynRhs (synTyConRhs tc1) (synTyConRhs tc2)
743
744   | isAlgTyCon tc1 && isAlgTyCon tc2
745   = ASSERT(tc1 == tc2)
746     eqKind (tyConKind tc1) (tyConKind tc2) &&
747     eqListBy eqPred (tyConStupidTheta tc1) (tyConStupidTheta tc2) &&
748     eqAlgRhs (algTyConRhs tc1) (algTyConRhs tc2)
749
750   | isForeignTyCon tc1 && isForeignTyCon tc2
751   = eqKind (tyConKind tc1) (tyConKind tc2) &&
752     tyConExtName tc1 == tyConExtName tc2
753
754   | otherwise = False
755   where 
756         env0 = mkRnEnv2 emptyInScopeSet
757
758         eqAlgRhs AbstractTyCon _ = True
759         eqAlgRhs DataFamilyTyCon{} DataFamilyTyCon{} = True
760         eqAlgRhs tc1@DataTyCon{} tc2@DataTyCon{} =
761             eqListBy eqCon (data_cons tc1) (data_cons tc2)
762         eqAlgRhs tc1@NewTyCon{} tc2@NewTyCon{} =
763             eqCon (data_con tc1) (data_con tc2)
764         eqAlgRhs _ _ = False
765
766         eqCon c1 c2
767           =  dataConName c1 == dataConName c2
768           && dataConIsInfix c1 == dataConIsInfix c2
769           && dataConStrictMarks c1 == dataConStrictMarks c2
770           && dataConFieldLabels c1 == dataConFieldLabels c2
771           && eqType (dataConUserType c1) (dataConUserType c2)
772
773 ----------------
774 missingBootThing :: Name -> String -> SDoc
775 missingBootThing name what
776   = ppr name <+> ptext (sLit "is exported by the hs-boot file, but not") 
777               <+> text what <+> ptext (sLit "the module")
778
779 bootMisMatch :: TyThing -> IfaceDecl -> IfaceDecl -> SDoc
780 bootMisMatch thing boot_decl real_decl
781   = vcat [ppr thing <+> ptext (sLit "has conflicting definitions in the module and its hs-boot file"),
782           ptext (sLit "Main module:") <+> ppr real_decl,
783           ptext (sLit "Boot file:  ") <+> ppr boot_decl]
784
785 instMisMatch :: Instance -> SDoc
786 instMisMatch inst
787   = hang (ppr inst)
788        2 (ptext (sLit "is defined in the hs-boot file, but not in the module itself"))
789 \end{code}
790
791
792 %************************************************************************
793 %*                                                                      *
794         Type-checking the top level of a module
795 %*                                                                      *
796 %************************************************************************
797
798 tcRnGroup takes a bunch of top-level source-code declarations, and
799  * renames them
800  * gets supporting declarations from interface files
801  * typechecks them
802  * zonks them
803  * and augments the TcGblEnv with the results
804
805 In Template Haskell it may be called repeatedly for each group of
806 declarations.  It expects there to be an incoming TcGblEnv in the
807 monad; it augments it and returns the new TcGblEnv.
808
809 \begin{code}
810 ------------------------------------------------
811 rnTopSrcDecls :: HsGroup RdrName -> TcM (TcGblEnv, HsGroup Name)
812 -- Fails if there are any errors
813 rnTopSrcDecls group
814  = do { -- Rename the source decls
815         traceTc "rn12" empty ;
816         (tcg_env, rn_decls) <- checkNoErrs $ rnSrcDecls group ;
817         traceTc "rn13" empty ;
818
819         -- save the renamed syntax, if we want it
820         let { tcg_env'
821                 | Just grp <- tcg_rn_decls tcg_env
822                   = tcg_env{ tcg_rn_decls = Just (appendGroups grp rn_decls) }
823                 | otherwise
824                    = tcg_env };
825
826                 -- Dump trace of renaming part
827         rnDump (ppr rn_decls) ;
828
829         return (tcg_env', rn_decls)
830    }
831
832 ------------------------------------------------
833 tcTopSrcDecls :: ModDetails -> HsGroup Name -> TcM (TcGblEnv, TcLclEnv)
834 tcTopSrcDecls boot_details
835         (HsGroup { hs_tyclds = tycl_decls, 
836                    hs_instds = inst_decls,
837                    hs_derivds = deriv_decls,
838                    hs_fords  = foreign_decls,
839                    hs_defds  = default_decls,
840                    hs_annds  = annotation_decls,
841                    hs_ruleds = rule_decls,
842                    hs_vects  = vect_decls,
843                    hs_valds  = val_binds })
844  = do {         -- Type-check the type and class decls, and all imported decls
845                 -- The latter come in via tycl_decls
846         traceTc "Tc2" empty ;
847
848         (tcg_env, aux_binds) <- tcTyAndClassDecls boot_details tycl_decls ;
849                 -- If there are any errors, tcTyAndClassDecls fails here
850         
851         setGblEnv tcg_env       $ do {
852
853                 -- Source-language instances, including derivings,
854                 -- and import the supporting declarations
855         traceTc "Tc3" empty ;
856         (tcg_env, inst_infos, deriv_binds) 
857             <- tcInstDecls1 (concat tycl_decls) inst_decls deriv_decls;
858         setGblEnv tcg_env       $ do {
859
860                 -- Foreign import declarations next. 
861         traceTc "Tc4" empty ;
862         (fi_ids, fi_decls) <- tcForeignImports foreign_decls ;
863         tcExtendGlobalValEnv fi_ids     $ do {
864
865                 -- Default declarations
866         traceTc "Tc4a" empty ;
867         default_tys <- tcDefaults default_decls ;
868         updGblEnv (\gbl -> gbl { tcg_default = default_tys }) $ do {
869         
870                 -- Now GHC-generated derived bindings, generics, and selectors
871                 -- Do not generate warnings from compiler-generated code;
872                 -- hence the use of discardWarnings
873         (tc_aux_binds,   specs1, tcl_env) <- discardWarnings (tcTopBinds aux_binds) ;
874         (tc_deriv_binds, specs2, tcl_env) <- setLclTypeEnv tcl_env $ 
875                                              discardWarnings (tcTopBinds deriv_binds) ;
876
877                 -- Value declarations next
878         traceTc "Tc5" empty ;
879         (tc_val_binds, specs3, tcl_env) <- setLclTypeEnv tcl_env $
880                                            tcTopBinds val_binds;
881
882         setLclTypeEnv tcl_env $ do {    -- Environment doesn't change now
883
884                 -- Second pass over class and instance declarations, 
885                 -- now using the kind-checked decls
886         traceTc "Tc6" empty ;
887         inst_binds <- tcInstDecls2 (concat tycl_decls) inst_infos ;
888
889                 -- Foreign exports
890         traceTc "Tc7" empty ;
891         (foe_binds, foe_decls) <- tcForeignExports foreign_decls ;
892
893                 -- Annotations
894         annotations <- tcAnnotations annotation_decls ;
895
896                 -- Rules
897         rules <- tcRules rule_decls ;
898
899                 -- Vectorisation declarations
900         vects <- tcVectDecls vect_decls ;
901
902                 -- Wrap up
903         traceTc "Tc7a" empty ;
904         tcg_env <- getGblEnv ;
905         let { all_binds = tc_val_binds   `unionBags`
906                           tc_deriv_binds `unionBags`
907                           tc_aux_binds   `unionBags`
908                           inst_binds     `unionBags`
909                           foe_binds
910
911             ; sig_names = mkNameSet (collectHsValBinders val_binds) 
912                           `minusNameSet` getTypeSigNames val_binds
913
914                 -- Extend the GblEnv with the (as yet un-zonked) 
915                 -- bindings, rules, foreign decls
916             ; tcg_env' = tcg_env { tcg_binds = tcg_binds tcg_env `unionBags` all_binds
917                                  , tcg_imp_specs = tcg_imp_specs tcg_env ++ specs1 ++ specs2 ++
918                                                    specs3
919                                  , tcg_sigs  = tcg_sigs tcg_env `unionNameSets` sig_names
920                                  , tcg_rules = tcg_rules tcg_env ++ rules
921                                  , tcg_vects = tcg_vects tcg_env ++ vects
922                                  , tcg_anns  = tcg_anns tcg_env ++ annotations
923                                  , tcg_fords = tcg_fords tcg_env ++ foe_decls ++ fi_decls } } ;
924         return (tcg_env', tcl_env)
925     }}}}}}
926 \end{code}
927
928
929 %************************************************************************
930 %*                                                                      *
931         Checking for 'main'
932 %*                                                                      *
933 %************************************************************************
934
935 \begin{code}
936 checkMain :: TcM TcGblEnv
937 -- If we are in module Main, check that 'main' is defined.
938 checkMain 
939   = do { tcg_env   <- getGblEnv ;
940          dflags    <- getDOpts ;
941          check_main dflags tcg_env
942     }
943
944 check_main :: DynFlags -> TcGblEnv -> TcM TcGblEnv
945 check_main dflags tcg_env
946  | mod /= main_mod
947  = traceTc "checkMain not" (ppr main_mod <+> ppr mod) >>
948    return tcg_env
949
950  | otherwise
951  = do   { mb_main <- lookupGlobalOccRn_maybe main_fn
952                 -- Check that 'main' is in scope
953                 -- It might be imported from another module!
954         ; case mb_main of {
955              Nothing -> do { traceTc "checkMain fail" (ppr main_mod <+> ppr main_fn)
956                            ; complain_no_main   
957                            ; return tcg_env } ;
958              Just main_name -> do
959
960         { traceTc "checkMain found" (ppr main_mod <+> ppr main_fn)
961         ; let loc = srcLocSpan (getSrcLoc main_name)
962         ; ioTyCon <- tcLookupTyCon ioTyConName
963         ; res_ty <- newFlexiTyVarTy liftedTypeKind
964         ; main_expr
965                 <- addErrCtxt mainCtxt    $
966                    tcMonoExpr (L loc (HsVar main_name)) (mkTyConApp ioTyCon [res_ty])
967
968                 -- See Note [Root-main Id]
969                 -- Construct the binding
970                 --      :Main.main :: IO res_ty = runMainIO res_ty main 
971         ; run_main_id <- tcLookupId runMainIOName
972         ; let { root_main_name =  mkExternalName rootMainKey rOOT_MAIN 
973                                    (mkVarOccFS (fsLit "main")) 
974                                    (getSrcSpan main_name)
975               ; root_main_id = Id.mkExportedLocalId root_main_name 
976                                                     (mkTyConApp ioTyCon [res_ty])
977               ; co  = mkWpTyApps [res_ty]
978               ; rhs = nlHsApp (mkLHsWrap co (nlHsVar run_main_id)) main_expr
979               ; main_bind = mkVarBind root_main_id rhs }
980
981         ; return (tcg_env { tcg_main  = Just main_name,
982                             tcg_binds = tcg_binds tcg_env
983                                         `snocBag` main_bind,
984                             tcg_dus   = tcg_dus tcg_env
985                                         `plusDU` usesOnly (unitFV main_name)
986                         -- Record the use of 'main', so that we don't 
987                         -- complain about it being defined but not used
988                  })
989     }}}
990   where
991     mod          = tcg_mod tcg_env
992     main_mod     = mainModIs dflags
993     main_fn      = getMainFun dflags
994
995     complain_no_main | ghcLink dflags == LinkInMemory = return ()
996                      | otherwise = failWithTc noMainMsg
997         -- In interactive mode, don't worry about the absence of 'main'
998         -- In other modes, fail altogether, so that we don't go on
999         -- and complain a second time when processing the export list.
1000
1001     mainCtxt  = ptext (sLit "When checking the type of the") <+> pp_main_fn
1002     noMainMsg = ptext (sLit "The") <+> pp_main_fn
1003                 <+> ptext (sLit "is not defined in module") <+> quotes (ppr main_mod)
1004     pp_main_fn = ppMainFn main_fn
1005
1006 ppMainFn :: RdrName -> SDoc
1007 ppMainFn main_fn
1008   | main_fn == main_RDR_Unqual
1009   = ptext (sLit "function") <+> quotes (ppr main_fn)
1010   | otherwise
1011   = ptext (sLit "main function") <+> quotes (ppr main_fn)
1012                
1013 -- | Get the unqualified name of the function to use as the \"main\" for the main module.
1014 -- Either returns the default name or the one configured on the command line with -main-is
1015 getMainFun :: DynFlags -> RdrName
1016 getMainFun dflags = case (mainFunIs dflags) of
1017     Just fn -> mkRdrUnqual (mkVarOccFS (mkFastString fn))
1018     Nothing -> main_RDR_Unqual
1019
1020 checkMainExported :: TcGblEnv -> TcM ()
1021 checkMainExported tcg_env = do
1022   dflags    <- getDOpts
1023   case tcg_main tcg_env of
1024     Nothing -> return () -- not the main module
1025     Just main_name -> do
1026       let main_mod = mainModIs dflags
1027       checkTc (main_name `elem` concatMap availNames (tcg_exports tcg_env)) $
1028               ptext (sLit "The") <+> ppMainFn (nameRdrName main_name) <+>
1029               ptext (sLit "is not exported by module") <+> quotes (ppr main_mod)
1030 \end{code}
1031
1032 Note [Root-main Id]
1033 ~~~~~~~~~~~~~~~~~~~
1034 The function that the RTS invokes is always :Main.main, which we call
1035 root_main_id.  (Because GHC allows the user to have a module not
1036 called Main as the main module, we can't rely on the main function
1037 being called "Main.main".  That's why root_main_id has a fixed module
1038 ":Main".)  
1039
1040 This is unusual: it's a LocalId whose Name has a Module from another
1041 module.  Tiresomely, we must filter it out again in MkIface, les we
1042 get two defns for 'main' in the interface file!
1043
1044
1045 %*********************************************************
1046 %*                                                       *
1047                 GHCi stuff
1048 %*                                                       *
1049 %*********************************************************
1050
1051 \begin{code}
1052 setInteractiveContext :: HscEnv -> InteractiveContext -> TcRn a -> TcRn a
1053 setInteractiveContext hsc_env icxt thing_inside 
1054   = let -- Initialise the tcg_inst_env with instances from all home modules.  
1055         -- This mimics the more selective call to hptInstances in tcRnModule.
1056         (home_insts, home_fam_insts) = hptInstances hsc_env (\_ -> True)
1057     in
1058     updGblEnv (\env -> env { 
1059         tcg_rdr_env      = ic_rn_gbl_env icxt,
1060         tcg_inst_env     = extendInstEnvList    (tcg_inst_env env) home_insts,
1061         tcg_fam_inst_env = extendFamInstEnvList (tcg_fam_inst_env env) 
1062                                                 home_fam_insts 
1063       }) $
1064
1065     tcExtendGhciEnv (ic_tmp_ids icxt) $
1066         -- tcExtendGhciEnv does lots: 
1067         --   - it extends the local type env (tcl_env) with the given Ids,
1068         --   - it extends the local rdr env (tcl_rdr) with the Names from 
1069         --     the given Ids
1070         --   - it adds the free tyvars of the Ids to the tcl_tyvars
1071         --     set.
1072         --
1073         -- later ids in ic_tmp_ids must shadow earlier ones with the same
1074         -- OccName, and tcExtendIdEnv implements this behaviour.
1075
1076     do  { traceTc "setIC" (ppr (ic_tmp_ids icxt))
1077         ; thing_inside }
1078 \end{code}
1079
1080
1081 \begin{code}
1082 #ifdef GHCI
1083 tcRnStmt :: HscEnv
1084          -> InteractiveContext
1085          -> LStmt RdrName
1086          -> IO (Messages, Maybe ([Id], LHsExpr Id))
1087                 -- The returned [Id] is the list of new Ids bound by
1088                 -- this statement.  It can be used to extend the
1089                 -- InteractiveContext via extendInteractiveContext.
1090                 --
1091                 -- The returned TypecheckedHsExpr is of type IO [ () ],
1092                 -- a list of the bound values, coerced to ().
1093
1094 tcRnStmt hsc_env ictxt rdr_stmt
1095   = initTcPrintErrors hsc_env iNTERACTIVE $ 
1096     setInteractiveContext hsc_env ictxt $ do {
1097
1098     -- Rename; use CmdLineMode because tcRnStmt is only used interactively
1099     (([rn_stmt], _), fvs) <- rnStmts GhciStmt [rdr_stmt] $ \_ ->
1100                              return ((), emptyFVs) ;
1101     traceRn (text "tcRnStmt" <+> vcat [ppr rdr_stmt, ppr rn_stmt, ppr fvs]) ;
1102     failIfErrsM ;
1103     rnDump (ppr rn_stmt) ;
1104     
1105     -- The real work is done here
1106     (bound_ids, tc_expr) <- mkPlan rn_stmt ;
1107     zonked_expr <- zonkTopLExpr tc_expr ;
1108     zonked_ids  <- zonkTopBndrs bound_ids ;
1109     
1110         -- None of the Ids should be of unboxed type, because we
1111         -- cast them all to HValues in the end!
1112     mapM_ bad_unboxed (filter (isUnLiftedType . idType) zonked_ids) ;
1113
1114     traceTc "tcs 1" empty ;
1115     let { global_ids = map globaliseAndTidyId zonked_ids } ;
1116         -- Note [Interactively-bound Ids in GHCi]
1117
1118 {- ---------------------------------------------
1119    At one stage I removed any shadowed bindings from the type_env;
1120    they are inaccessible but might, I suppose, cause a space leak if we leave them there.
1121    However, with Template Haskell they aren't necessarily inaccessible.  Consider this
1122    GHCi session
1123          Prelude> let f n = n * 2 :: Int
1124          Prelude> fName <- runQ [| f |]
1125          Prelude> $(return $ AppE fName (LitE (IntegerL 7)))
1126          14
1127          Prelude> let f n = n * 3 :: Int
1128          Prelude> $(return $ AppE fName (LitE (IntegerL 7)))
1129    In the last line we use 'fName', which resolves to the *first* 'f'
1130    in scope. If we delete it from the type env, GHCi crashes because
1131    it doesn't expect that.
1132  
1133    Hence this code is commented out
1134
1135 -------------------------------------------------- -}
1136
1137     dumpOptTcRn Opt_D_dump_tc 
1138         (vcat [text "Bound Ids" <+> pprWithCommas ppr global_ids,
1139                text "Typechecked expr" <+> ppr zonked_expr]) ;
1140
1141     return (global_ids, zonked_expr)
1142     }
1143   where
1144     bad_unboxed id = addErr (sep [ptext (sLit "GHCi can't bind a variable of unlifted type:"),
1145                                   nest 2 (ppr id <+> dcolon <+> ppr (idType id))])
1146 \end{code}
1147
1148 Note [Interactively-bound Ids in GHCi]
1149 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1150 The Ids bound by previous Stmts in Template Haskell are currently
1151         a) GlobalIds
1152         b) with an Internal Name (not External)
1153         c) and a tidied type
1154
1155  (a) They must be GlobalIds (not LocalIds) otherwise when we come to
1156      compile an expression using these ids later, the byte code
1157      generator will consider the occurrences to be free rather than
1158      global.
1159
1160  (b) They retain their Internal names becuase we don't have a suitable
1161      Module to name them with.  We could revisit this choice.
1162
1163  (c) Their types are tidied.  This is important, because :info may ask
1164      to look at them, and :info expects the things it looks up to have
1165      tidy types
1166         
1167
1168 --------------------------------------------------------------------------
1169                 Typechecking Stmts in GHCi
1170
1171 Here is the grand plan, implemented in tcUserStmt
1172
1173         What you type                   The IO [HValue] that hscStmt returns
1174         -------------                   ------------------------------------
1175         let pat = expr          ==>     let pat = expr in return [coerce HVal x, coerce HVal y, ...]
1176                                         bindings: [x,y,...]
1177
1178         pat <- expr             ==>     expr >>= \ pat -> return [coerce HVal x, coerce HVal y, ...]
1179                                         bindings: [x,y,...]
1180
1181         expr (of IO type)       ==>     expr >>= \ it -> return [coerce HVal it]
1182           [NB: result not printed]      bindings: [it]
1183           
1184         expr (of non-IO type,   ==>     let it = expr in print it >> return [coerce HVal it]
1185           result showable)              bindings: [it]
1186
1187         expr (of non-IO type, 
1188           result not showable)  ==>     error
1189
1190
1191 \begin{code}
1192 ---------------------------
1193 type PlanResult = ([Id], LHsExpr Id)
1194 type Plan = TcM PlanResult
1195
1196 runPlans :: [Plan] -> TcM PlanResult
1197 -- Try the plans in order.  If one fails (by raising an exn), try the next.
1198 -- If one succeeds, take it.
1199 runPlans []     = panic "runPlans"
1200 runPlans [p]    = p
1201 runPlans (p:ps) = tryTcLIE_ (runPlans ps) p
1202
1203 --------------------
1204 mkPlan :: LStmt Name -> TcM PlanResult
1205 mkPlan (L loc (ExprStmt expr _ _ _))    -- An expression typed at the prompt 
1206   = do  { uniq <- newUnique             -- is treated very specially
1207         ; let fresh_it  = itName uniq
1208               the_bind  = L loc $ mkFunBind (L loc fresh_it) matches
1209               matches   = [mkMatch [] expr emptyLocalBinds]
1210               let_stmt  = L loc $ LetStmt (HsValBinds (ValBindsOut [(NonRecursive,unitBag the_bind)] []))
1211               bind_stmt = L loc $ BindStmt (nlVarPat fresh_it) expr
1212                                            (HsVar bindIOName) noSyntaxExpr 
1213               print_it  = L loc $ ExprStmt (nlHsApp (nlHsVar printName) (nlHsVar fresh_it))
1214                                            (HsVar thenIOName) noSyntaxExpr placeHolderType
1215
1216         -- The plans are:
1217         --      [it <- e; print it]     but not if it::()
1218         --      [it <- e]               
1219         --      [let it = e; print it]  
1220         ; runPlans [    -- Plan A
1221                     do { stuff@([it_id], _) <- tcGhciStmts [bind_stmt, print_it]
1222                        ; it_ty <- zonkTcType (idType it_id)
1223                        ; when (isUnitTy it_ty) failM
1224                        ; return stuff },
1225
1226                         -- Plan B; a naked bind statment
1227                     tcGhciStmts [bind_stmt],    
1228
1229                         -- Plan C; check that the let-binding is typeable all by itself.
1230                         -- If not, fail; if so, try to print it.
1231                         -- The two-step process avoids getting two errors: one from
1232                         -- the expression itself, and one from the 'print it' part
1233                         -- This two-step story is very clunky, alas
1234                     do { _ <- checkNoErrs (tcGhciStmts [let_stmt]) 
1235                                 --- checkNoErrs defeats the error recovery of let-bindings
1236                        ; tcGhciStmts [let_stmt, print_it] }
1237           ]}
1238
1239 mkPlan stmt@(L loc (BindStmt {}))
1240   | [v] <- collectLStmtBinders stmt             -- One binder, for a bind stmt 
1241   = do  { let print_v  = L loc $ ExprStmt (nlHsApp (nlHsVar printName) (nlHsVar v))
1242                                           (HsVar thenIOName) noSyntaxExpr placeHolderType
1243
1244         ; print_bind_result <- doptM Opt_PrintBindResult
1245         ; let print_plan = do
1246                   { stuff@([v_id], _) <- tcGhciStmts [stmt, print_v]
1247                   ; v_ty <- zonkTcType (idType v_id)
1248                   ; when (isUnitTy v_ty || not (isTauTy v_ty)) failM
1249                   ; return stuff }
1250
1251         -- The plans are:
1252         --      [stmt; print v]         but not if v::()
1253         --      [stmt]
1254         ; runPlans ((if print_bind_result then [print_plan] else []) ++
1255                     [tcGhciStmts [stmt]])
1256         }
1257
1258 mkPlan stmt
1259   = tcGhciStmts [stmt]
1260
1261 ---------------------------
1262 tcGhciStmts :: [LStmt Name] -> TcM PlanResult
1263 tcGhciStmts stmts
1264  = do { ioTyCon <- tcLookupTyCon ioTyConName ;
1265         ret_id  <- tcLookupId returnIOName ;            -- return @ IO
1266         let {
1267             ret_ty    = mkListTy unitTy ;
1268             io_ret_ty = mkTyConApp ioTyCon [ret_ty] ;
1269             tc_io_stmts stmts = tcStmtsAndThen GhciStmt tcDoStmt stmts io_ret_ty ;
1270             names = collectLStmtsBinders stmts ;
1271          } ;
1272
1273         -- OK, we're ready to typecheck the stmts
1274         traceTc "TcRnDriver.tcGhciStmts: tc stmts" empty ;
1275         ((tc_stmts, ids), lie) <- captureConstraints $ 
1276                                   tc_io_stmts stmts  $ \ _ ->
1277                                   mapM tcLookupId names  ;
1278                         -- Look up the names right in the middle,
1279                         -- where they will all be in scope
1280
1281         -- Simplify the context
1282         traceTc "TcRnDriver.tcGhciStmts: simplify ctxt" empty ;
1283         const_binds <- checkNoErrs (simplifyInteractive lie) ;
1284                 -- checkNoErrs ensures that the plan fails if context redn fails
1285
1286         traceTc "TcRnDriver.tcGhciStmts: done" empty ;
1287         let {   -- mk_return builds the expression
1288                 --      returnIO @ [()] [coerce () x, ..,  coerce () z]
1289                 --
1290                 -- Despite the inconvenience of building the type applications etc,
1291                 -- this *has* to be done in type-annotated post-typecheck form
1292                 -- because we are going to return a list of *polymorphic* values
1293                 -- coerced to type (). If we built a *source* stmt
1294                 --      return [coerce x, ..., coerce z]
1295                 -- then the type checker would instantiate x..z, and we wouldn't
1296                 -- get their *polymorphic* values.  (And we'd get ambiguity errs
1297                 -- if they were overloaded, since they aren't applied to anything.)
1298             ret_expr = nlHsApp (nlHsTyApp ret_id [ret_ty]) 
1299                        (noLoc $ ExplicitList unitTy (map mk_item ids)) ;
1300             mk_item id = nlHsApp (nlHsTyApp unsafeCoerceId [idType id, unitTy])
1301                                  (nlHsVar id) ;
1302             stmts = tc_stmts ++ [noLoc (mkLastStmt ret_expr)]
1303         } ;
1304         return (ids, mkHsDictLet (EvBinds const_binds) $
1305                      noLoc (HsDo GhciStmt stmts io_ret_ty))
1306     }
1307 \end{code}
1308
1309
1310 tcRnExpr just finds the type of an expression
1311
1312 \begin{code}
1313 tcRnExpr :: HscEnv
1314          -> InteractiveContext
1315          -> LHsExpr RdrName
1316          -> IO (Messages, Maybe Type)
1317 tcRnExpr hsc_env ictxt rdr_expr
1318   = initTcPrintErrors hsc_env iNTERACTIVE $ 
1319     setInteractiveContext hsc_env ictxt $ do {
1320
1321     (rn_expr, _fvs) <- rnLExpr rdr_expr ;
1322     failIfErrsM ;
1323
1324         -- Now typecheck the expression; 
1325         -- it might have a rank-2 type (e.g. :t runST)
1326     uniq <- newUnique ;
1327     let { fresh_it  = itName uniq } ;
1328     ((_tc_expr, res_ty), lie)   <- captureConstraints (tcInferRho rn_expr) ;
1329     ((qtvs, dicts, _), lie_top) <- captureConstraints $ 
1330                                    simplifyInfer TopLevel False {- No MR for now -}
1331                                                  [(fresh_it, res_ty)]
1332                                                  lie  ;
1333     _ <- simplifyInteractive lie_top ;       -- Ignore the dicionary bindings
1334
1335     let { all_expr_ty = mkForAllTys qtvs (mkPiTypes dicts res_ty) } ;
1336     zonkTcType all_expr_ty
1337     }
1338 \end{code}
1339
1340 tcRnType just finds the kind of a type
1341
1342 \begin{code}
1343 tcRnType :: HscEnv
1344          -> InteractiveContext
1345          -> LHsType RdrName
1346          -> IO (Messages, Maybe Kind)
1347 tcRnType hsc_env ictxt rdr_type
1348   = initTcPrintErrors hsc_env iNTERACTIVE $ 
1349     setInteractiveContext hsc_env ictxt $ do {
1350
1351     rn_type <- rnLHsType doc rdr_type ;
1352     failIfErrsM ;
1353
1354         -- Now kind-check the type
1355     (_ty', kind) <- kcLHsType rn_type ;
1356     return kind
1357     }
1358   where
1359     doc = ptext (sLit "In GHCi input")
1360
1361 #endif /* GHCi */
1362 \end{code}
1363
1364
1365 %************************************************************************
1366 %*                                                                      *
1367         More GHCi stuff, to do with browsing and getting info
1368 %*                                                                      *
1369 %************************************************************************
1370
1371 \begin{code}
1372 #ifdef GHCI
1373 -- | ASSUMES that the module is either in the 'HomePackageTable' or is
1374 -- a package module with an interface on disk.  If neither of these is
1375 -- true, then the result will be an error indicating the interface
1376 -- could not be found.
1377 getModuleExports :: HscEnv -> Module -> IO (Messages, Maybe [AvailInfo])
1378 getModuleExports hsc_env mod
1379   = initTc hsc_env HsSrcFile False iNTERACTIVE (tcGetModuleExports mod)
1380
1381 -- Get the export avail info and also load all orphan and family-instance
1382 -- modules.  Finally, check that the family instances of all modules in the
1383 -- interactive context are consistent (these modules are in the second
1384 -- argument).
1385 tcGetModuleExports :: Module -> TcM [AvailInfo]
1386 tcGetModuleExports mod
1387   = do { let doc = ptext (sLit "context for compiling statements")
1388        ; iface <- initIfaceTcRn $ loadSysInterface doc mod
1389
1390                 -- Load any orphan-module and family instance-module
1391                 -- interfaces, so their instances are visible.
1392        ; loadOrphanModules (dep_orphs (mi_deps iface)) False 
1393
1394        ; ifaceExportNames (mi_exports iface)
1395        }
1396
1397 tcRnLookupRdrName :: HscEnv -> RdrName -> IO (Messages, Maybe [Name])
1398 tcRnLookupRdrName hsc_env rdr_name 
1399   = initTcPrintErrors hsc_env iNTERACTIVE $ 
1400     setInteractiveContext hsc_env (hsc_IC hsc_env) $ 
1401     lookup_rdr_name rdr_name
1402
1403 lookup_rdr_name :: RdrName -> TcM [Name]
1404 lookup_rdr_name rdr_name = do {
1405         -- If the identifier is a constructor (begins with an
1406         -- upper-case letter), then we need to consider both
1407         -- constructor and type class identifiers.
1408     let { rdr_names = dataTcOccs rdr_name } ;
1409
1410         -- results :: [Either Messages Name]
1411     results <- mapM (tryTcErrs . lookupOccRn) rdr_names ;
1412
1413     traceRn (text "xx" <+> vcat [ppr rdr_names, ppr (map snd results)]);
1414         -- The successful lookups will be (Just name)
1415     let { (warns_s, good_names) = unzip [ (msgs, name) 
1416                                         | (msgs, Just name) <- results] ;
1417           errs_s = [msgs | (msgs, Nothing) <- results] } ;
1418
1419         -- Fail if nothing good happened, else add warnings
1420     if null good_names then
1421                 -- No lookup succeeded, so
1422                 -- pick the first error message and report it
1423                 -- ToDo: If one of the errors is "could be Foo.X or Baz.X",
1424                 --       while the other is "X is not in scope", 
1425                 --       we definitely want the former; but we might pick the latter
1426         do { addMessages (head errs_s) ; failM }
1427       else                      -- Add deprecation warnings
1428         mapM_ addMessages warns_s ;
1429     
1430     return good_names
1431  }
1432 #endif
1433
1434 tcRnLookupName :: HscEnv -> Name -> IO (Messages, Maybe TyThing)
1435 tcRnLookupName hsc_env name
1436   = initTcPrintErrors hsc_env iNTERACTIVE $ 
1437     setInteractiveContext hsc_env (hsc_IC hsc_env) $
1438     tcRnLookupName' name
1439
1440 -- To look up a name we have to look in the local environment (tcl_lcl)
1441 -- as well as the global environment, which is what tcLookup does. 
1442 -- But we also want a TyThing, so we have to convert:
1443
1444 tcRnLookupName' :: Name -> TcRn TyThing
1445 tcRnLookupName' name = do
1446    tcthing <- tcLookup name
1447    case tcthing of
1448      AGlobal thing    -> return thing
1449      ATcId{tct_id=id} -> return (AnId id)
1450      _ -> panic "tcRnLookupName'"
1451
1452 tcRnGetInfo :: HscEnv
1453             -> Name
1454             -> IO (Messages, Maybe (TyThing, Fixity, [Instance]))
1455
1456 -- Used to implement :info in GHCi
1457 --
1458 -- Look up a RdrName and return all the TyThings it might be
1459 -- A capitalised RdrName is given to us in the DataName namespace,
1460 -- but we want to treat it as *both* a data constructor 
1461 --  *and* as a type or class constructor; 
1462 -- hence the call to dataTcOccs, and we return up to two results
1463 tcRnGetInfo hsc_env name
1464   = initTcPrintErrors hsc_env iNTERACTIVE $
1465     tcRnGetInfo' hsc_env name
1466
1467 tcRnGetInfo' :: HscEnv
1468              -> Name
1469              -> TcRn (TyThing, Fixity, [Instance])
1470 tcRnGetInfo' hsc_env name
1471   = let ictxt = hsc_IC hsc_env in
1472     setInteractiveContext hsc_env ictxt $ do
1473
1474         -- Load the interface for all unqualified types and classes
1475         -- That way we will find all the instance declarations
1476         -- (Packages have not orphan modules, and we assume that
1477         --  in the home package all relevant modules are loaded.)
1478     loadUnqualIfaces ictxt
1479
1480     thing  <- tcRnLookupName' name
1481     fixity <- lookupFixityRn name
1482     ispecs <- lookupInsts thing
1483     return (thing, fixity, ispecs)
1484
1485 lookupInsts :: TyThing -> TcM [Instance]
1486 lookupInsts (AClass cls)
1487   = do  { inst_envs <- tcGetInstEnvs
1488         ; return (classInstances inst_envs cls) }
1489
1490 lookupInsts (ATyCon tc)
1491   = do  { (pkg_ie, home_ie) <- tcGetInstEnvs
1492                 -- Load all instances for all classes that are
1493                 -- in the type environment (which are all the ones
1494                 -- we've seen in any interface file so far)
1495         ; return [ ispec        -- Search all
1496                  | ispec <- instEnvElts home_ie ++ instEnvElts pkg_ie
1497                  , let dfun = instanceDFunId ispec
1498                  , relevant dfun ] } 
1499   where
1500     relevant df = tc_name `elemNameSet` orphNamesOfDFunHead (idType df)
1501     tc_name     = tyConName tc            
1502
1503 lookupInsts _ = return []
1504
1505 loadUnqualIfaces :: InteractiveContext -> TcM ()
1506 -- Load the home module for everything that is in scope unqualified
1507 -- This is so that we can accurately report the instances for 
1508 -- something
1509 loadUnqualIfaces ictxt
1510   = initIfaceTcRn $
1511     mapM_ (loadSysInterface doc) (moduleSetElts (mkModuleSet unqual_mods))
1512   where
1513     unqual_mods = [ nameModule name
1514                   | gre <- globalRdrEnvElts (ic_rn_gbl_env ictxt),
1515                     let name = gre_name gre,
1516                     not (isInternalName name),
1517                     isTcOcc (nameOccName name),  -- Types and classes only
1518                     unQualOK gre ]               -- In scope unqualified
1519     doc = ptext (sLit "Need interface for module whose export(s) are in scope unqualified")
1520 \end{code}
1521
1522 %************************************************************************
1523 %*                                                                      *
1524                 Degugging output
1525 %*                                                                      *
1526 %************************************************************************
1527
1528 \begin{code}
1529 rnDump :: SDoc -> TcRn ()
1530 -- Dump, with a banner, if -ddump-rn
1531 rnDump doc = do { dumpOptTcRn Opt_D_dump_rn (mkDumpDoc "Renamer" doc) }
1532
1533 tcDump :: TcGblEnv -> TcRn ()
1534 tcDump env
1535  = do { dflags <- getDOpts ;
1536
1537         -- Dump short output if -ddump-types or -ddump-tc
1538         when (dopt Opt_D_dump_types dflags || dopt Opt_D_dump_tc dflags)
1539              (dumpTcRn short_dump) ;
1540
1541         -- Dump bindings if -ddump-tc
1542         dumpOptTcRn Opt_D_dump_tc (mkDumpDoc "Typechecker" full_dump)
1543    }
1544   where
1545     short_dump = pprTcGblEnv env
1546     full_dump  = pprLHsBinds (tcg_binds env)
1547         -- NB: foreign x-d's have undefined's in their types; 
1548         --     hence can't show the tc_fords
1549
1550 tcCoreDump :: ModGuts -> TcM ()
1551 tcCoreDump mod_guts
1552  = do { dflags <- getDOpts ;
1553         when (dopt Opt_D_dump_types dflags || dopt Opt_D_dump_tc dflags)
1554              (dumpTcRn (pprModGuts mod_guts)) ;
1555
1556         -- Dump bindings if -ddump-tc
1557         dumpOptTcRn Opt_D_dump_tc (mkDumpDoc "Typechecker" full_dump) }
1558   where
1559     full_dump = pprCoreBindings (mg_binds mod_guts)
1560
1561 -- It's unpleasant having both pprModGuts and pprModDetails here
1562 pprTcGblEnv :: TcGblEnv -> SDoc
1563 pprTcGblEnv (TcGblEnv { tcg_type_env  = type_env, 
1564                         tcg_insts     = insts, 
1565                         tcg_fam_insts = fam_insts, 
1566                         tcg_rules     = rules,
1567                         tcg_vects     = vects,
1568                         tcg_imports   = imports })
1569   = vcat [ ppr_types insts type_env
1570          , ppr_tycons fam_insts type_env
1571          , ppr_insts insts
1572          , ppr_fam_insts fam_insts
1573          , vcat (map ppr rules)
1574          , vcat (map ppr vects)
1575          , ptext (sLit "Dependent modules:") <+> 
1576                 ppr (sortBy cmp_mp $ eltsUFM (imp_dep_mods imports))
1577          , ptext (sLit "Dependent packages:") <+> 
1578                 ppr (sortBy stablePackageIdCmp $ imp_dep_pkgs imports)]
1579   where         -- The two uses of sortBy are just to reduce unnecessary
1580                 -- wobbling in testsuite output
1581     cmp_mp (mod_name1, is_boot1) (mod_name2, is_boot2)
1582         = (mod_name1 `stableModuleNameCmp` mod_name2)
1583                   `thenCmp`     
1584           (is_boot1 `compare` is_boot2)
1585
1586 pprModGuts :: ModGuts -> SDoc
1587 pprModGuts (ModGuts { mg_types = type_env,
1588                       mg_rules = rules })
1589   = vcat [ ppr_types [] type_env,
1590            ppr_rules rules ]
1591
1592 ppr_types :: [Instance] -> TypeEnv -> SDoc
1593 ppr_types insts type_env
1594   = text "TYPE SIGNATURES" $$ nest 4 (ppr_sigs ids)
1595   where
1596     dfun_ids = map instanceDFunId insts
1597     ids = [id | id <- typeEnvIds type_env, want_sig id]
1598     want_sig id | opt_PprStyle_Debug = True
1599                 | otherwise          = isLocalId id && 
1600                                        isExternalName (idName id) && 
1601                                        not (id `elem` dfun_ids)
1602         -- isLocalId ignores data constructors, records selectors etc.
1603         -- The isExternalName ignores local dictionary and method bindings
1604         -- that the type checker has invented.  Top-level user-defined things 
1605         -- have External names.
1606
1607 ppr_tycons :: [FamInst] -> TypeEnv -> SDoc
1608 ppr_tycons fam_insts type_env
1609   = vcat [ text "TYPE CONSTRUCTORS"
1610          ,   nest 2 (ppr_tydecls tycons)
1611          , text "COERCION AXIOMS" 
1612          ,   nest 2 (vcat (map pprCoAxiom (typeEnvCoAxioms type_env))) ]
1613   where
1614     fi_tycons = map famInstTyCon fam_insts
1615     tycons = [tycon | tycon <- typeEnvTyCons type_env, want_tycon tycon]
1616     want_tycon tycon | opt_PprStyle_Debug = True
1617                      | otherwise          = not (isImplicitTyCon tycon) &&
1618                                             isExternalName (tyConName tycon) &&
1619                                             not (tycon `elem` fi_tycons)
1620
1621 ppr_insts :: [Instance] -> SDoc
1622 ppr_insts []     = empty
1623 ppr_insts ispecs = text "INSTANCES" $$ nest 2 (pprInstances ispecs)
1624
1625 ppr_fam_insts :: [FamInst] -> SDoc
1626 ppr_fam_insts []        = empty
1627 ppr_fam_insts fam_insts = 
1628   text "FAMILY INSTANCES" $$ nest 2 (pprFamInsts fam_insts)
1629
1630 ppr_sigs :: [Var] -> SDoc
1631 ppr_sigs ids
1632         -- Print type signatures; sort by OccName 
1633   = vcat (map ppr_sig (sortLe le_sig ids))
1634   where
1635     le_sig id1 id2 = getOccName id1 <= getOccName id2
1636     ppr_sig id = ppr id <+> dcolon <+> ppr (tidyTopType (idType id))
1637
1638 ppr_tydecls :: [TyCon] -> SDoc
1639 ppr_tydecls tycons
1640         -- Print type constructor info; sort by OccName 
1641   = vcat (map ppr_tycon (sortLe le_sig tycons))
1642   where
1643     le_sig tycon1 tycon2 = getOccName tycon1 <= getOccName tycon2
1644     ppr_tycon tycon = ppr (tyThingToIfaceDecl (ATyCon tycon))
1645
1646 ppr_rules :: [CoreRule] -> SDoc
1647 ppr_rules [] = empty
1648 ppr_rules rs = vcat [ptext (sLit "{-# RULES"),
1649                       nest 2 (pprRules rs),
1650                       ptext (sLit "#-}")]
1651 \end{code}