2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 \section[TcModule]{Typechecking a whole module}
9 getModuleContents, tcRnStmt,
10 tcRnGetInfo, GetInfoResult,
20 #include "HsVersions.h"
24 import {-# SOURCE #-} TcSplice ( tcSpliceDecls )
27 import DynFlags ( DynFlag(..), DynFlags(..), dopt, GhcMode(..) )
28 import StaticFlags ( opt_PprStyle_Debug )
29 import Packages ( moduleToPackageConfig, mkPackageId, package,
31 import HsSyn ( HsModule(..), HsExtCore(..), HsGroup(..), LHsDecl,
32 SpliceDecl(..), HsBind(..), LHsBinds,
33 emptyGroup, appendGroups,
34 nlHsApp, nlHsVar, pprLHsBinds )
35 import RdrHsSyn ( findSplice )
37 import PrelNames ( runMainIOName, rootMainName, mAIN,
39 import RdrName ( RdrName, mkRdrUnqual, emptyGlobalRdrEnv )
40 import TcHsSyn ( zonkTopDecls )
41 import TcExpr ( tcInferRho )
43 import TcType ( tidyTopType, tcEqType, mkTyVarTys, substTyWith )
44 import Inst ( showLIE )
45 import InstEnv ( extendInstEnvList, Instance, pprInstances, instanceDFunId )
46 import TcBinds ( tcTopBinds, tcHsBootSigs )
47 import TcDefaults ( tcDefaults )
48 import TcEnv ( tcExtendGlobalValEnv, iDFunId )
49 import TcRules ( tcRules )
50 import TcForeign ( tcForeignImports, tcForeignExports )
51 import TcInstDcls ( tcInstDecls1, tcInstDecls2 )
52 import TcIface ( tcExtCoreBindings, tcHiBootIface )
53 import TcSimplify ( tcSimplifyTop )
54 import TcTyClsDecls ( tcTyAndClassDecls )
55 import LoadIface ( loadOrphanModules )
56 import RnNames ( importsFromLocalDecls, rnImports, exportsFromAvail,
57 reportUnusedNames, reportDeprecations )
58 import RnEnv ( lookupSrcOcc_maybe )
59 import RnSource ( rnSrcDecls, rnTyClDecls, checkModDeprec )
60 import PprCore ( pprRules, pprCoreBindings )
61 import CoreSyn ( CoreRule, bindersOfBinds )
62 import DataCon ( dataConWrapId )
63 import ErrUtils ( Messages, mkDumpDoc, showPass )
64 import Id ( Id, mkExportedLocalId, isLocalId, idName, idType )
66 import Module ( Module, ModuleEnv, mkModule, moduleEnvElts, elemModuleEnv )
67 import OccName ( mkVarOcc )
68 import Name ( Name, NamedThing(..), isExternalName, getSrcLoc, isWiredInName )
70 import TyCon ( tyConHasGenerics, isSynTyCon, getSynTyConDefn, tyConKind )
71 import SrcLoc ( srcLocSpan, Located(..), noLoc )
72 import DriverPhases ( HscSource(..), isHsBoot )
73 import HscTypes ( ModGuts(..), ModDetails(..), emptyModDetails,
74 HscEnv(..), ExternalPackageState(..),
75 IsBootInterface, noDependencies,
76 Deprecs( NoDeprecs ), plusDeprecs,
77 ForeignStubs(NoStubs), TyThing(..),
78 TypeEnv, lookupTypeEnv, hptInstances,
79 extendTypeEnvWithIds, typeEnvIds, typeEnvTyCons, typeEnvElts,
85 import HsSyn ( HsStmtContext(..), Stmt(..), HsExpr(..), HsBindGroup(..),
86 LStmt, LHsExpr, LHsType, mkVarBind,
87 collectLStmtsBinders, collectLStmtBinders, nlVarPat,
88 placeHolderType, noSyntaxExpr )
89 import RdrName ( GlobalRdrElt(..), globalRdrEnvElts,
90 unQualOK, lookupLocalRdrEnv, extendLocalRdrEnv )
91 import RnSource ( addTcgDUs )
92 import TcHsSyn ( mkHsLet, zonkTopLExpr, zonkTopBndrs )
93 import TcHsType ( kcHsType )
94 import TcMType ( zonkTcType, zonkQuantifiedTyVar )
95 import TcMatches ( tcStmts, tcDoStmt )
96 import TcSimplify ( tcSimplifyInteractive, tcSimplifyInfer )
97 import TcType ( Type, mkForAllTys, mkFunTys, mkTyConApp, tyVarsOfType,
98 isUnLiftedType, tyClsNamesOfDFunHead, tyClsNamesOfType, isUnitTy )
99 import TcEnv ( tcLookupTyCon, tcLookupId, tcLookupGlobal )
100 import RnTypes ( rnLHsType )
101 import Inst ( tcGetInstEnvs )
102 import InstEnv ( classInstances, instEnvElts )
103 import RnExpr ( rnStmts, rnLExpr )
104 import LoadIface ( loadSrcInterface, loadSysInterface )
105 import IfaceSyn ( IfaceDecl(..), IfaceClassOp(..), IfaceConDecl(..),
106 IfaceExtName(..), IfaceConDecls(..),
108 import IfaceType ( IfaceType, toIfaceType,
109 interactiveExtNameFun )
110 import IfaceEnv ( lookupOrig, ifaceExportNames )
111 import Module ( lookupModuleEnv, moduleSetElts, mkModuleSet )
112 import RnEnv ( lookupOccRn, dataTcOccs, lookupFixityRn )
113 import Id ( isImplicitId, setIdType, globalIdDetails )
114 import MkId ( unsafeCoerceId )
115 import DataCon ( dataConTyCon )
116 import TyCon ( tyConName )
117 import TysWiredIn ( mkListTy, unitTy )
118 import IdInfo ( GlobalIdDetails(..) )
120 import Var ( globaliseId )
121 import Name ( nameOccName, nameModule, isBuiltInSyntax, nameParent_maybe )
122 import OccName ( occNameUserString, isTcOcc )
123 import NameEnv ( delListFromNameEnv )
124 import PrelNames ( iNTERACTIVE, ioTyConName, printName, itName,
125 bindIOName, thenIOName, returnIOName )
126 import HscTypes ( InteractiveContext(..), HomeModInfo(..),
127 availNames, availName, ModIface(..), icPrintUnqual,
129 import BasicTypes ( RecFlag(..), Fixity )
130 import Panic ( ghcError, GhcException(..) )
131 import SrcLoc ( SrcLoc, unLoc, noSrcSpan )
134 import FastString ( mkFastString )
135 import Util ( sortLe )
136 import Bag ( unionBags, snocBag, emptyBag, unitBag, unionManyBags )
138 import Maybe ( isJust )
143 %************************************************************************
145 Typecheck and rename a module
147 %************************************************************************
153 -> Bool -- True <=> save renamed syntax
154 -> Located (HsModule RdrName)
155 -> IO (Messages, Maybe TcGblEnv)
157 tcRnModule hsc_env hsc_src save_rn_decls
158 (L loc (HsModule maybe_mod export_ies
159 import_decls local_decls mod_deprec))
160 = do { showPass (hsc_dflags hsc_env) "Renamer/typechecker" ;
162 let { this_mod = case maybe_mod of
163 Nothing -> mAIN -- 'module M where' is omitted
164 Just (L _ mod) -> mod } ; -- The normal case
166 initTc hsc_env hsc_src this_mod $
169 checkForPackageModule (hsc_dflags hsc_env) this_mod;
171 -- Deal with imports; sets tcg_rdr_env, tcg_imports
172 (rdr_env, imports) <- rnImports import_decls ;
174 let { dep_mods :: ModuleEnv (Module, IsBootInterface)
175 ; dep_mods = imp_dep_mods imports
177 -- We want instance declarations from all home-package
178 -- modules below this one, including boot modules, except
179 -- ourselves. The 'except ourselves' is so that we don't
180 -- get the instances from this module's hs-boot file
181 ; want_instances :: Module -> Bool
182 ; want_instances mod = mod `elemModuleEnv` dep_mods
184 ; home_insts = hptInstances hsc_env want_instances
187 -- Record boot-file info in the EPS, so that it's
188 -- visible to loadHiBootInterface in tcRnSrcDecls,
189 -- and any other incrementally-performed imports
190 updateEps_ (\eps -> eps { eps_is_boot = dep_mods }) ;
192 -- Update the gbl env
194 gbl { tcg_rdr_env = rdr_env,
195 tcg_inst_env = extendInstEnvList (tcg_inst_env gbl) home_insts,
196 tcg_imports = tcg_imports gbl `plusImportAvails` imports,
197 tcg_rn_decls = if save_rn_decls then
203 traceRn (text "rn1" <+> ppr (imp_dep_mods imports)) ;
204 -- Fail if there are any errors so far
205 -- The error printing (if needed) takes advantage
206 -- of the tcg_env we have now set
209 -- Load any orphan-module interfaces, so that
210 -- their rules and instance decls will be found
211 loadOrphanModules (imp_orphs imports) ;
213 traceRn (text "rn1a") ;
214 -- Rename and type check the declarations
215 tcg_env <- if isHsBoot hsc_src then
216 tcRnHsBootDecls local_decls
218 tcRnSrcDecls local_decls ;
219 setGblEnv tcg_env $ do {
221 traceRn (text "rn3") ;
223 -- Report the use of any deprecated things
224 -- We do this before processsing the export list so
225 -- that we don't bleat about re-exporting a deprecated
226 -- thing (especially via 'module Foo' export item)
227 -- Only uses in the body of the module are complained about
228 reportDeprecations tcg_env ;
230 -- Process the export list
231 exports <- exportsFromAvail (isJust maybe_mod) export_ies ;
233 -- Check whether the entire module is deprecated
234 -- This happens only once per module
235 let { mod_deprecs = checkModDeprec mod_deprec } ;
237 -- Add exports and deprecations to envt
238 let { final_env = tcg_env { tcg_exports = exports,
239 tcg_dus = tcg_dus tcg_env `plusDU` usesOnly exports,
240 tcg_deprecs = tcg_deprecs tcg_env `plusDeprecs`
242 -- A module deprecation over-rides the earlier ones
245 -- Report unused names
246 reportUnusedNames export_ies final_env ;
248 -- Dump output and return
253 -- This is really a sanity check that the user has given -package-name
254 -- if necessary. -package-name is only necessary when the package database
255 -- already contains the current package, because then we can't tell
256 -- whether a given module is in the current package or not, without knowing
257 -- the name of the current package.
258 checkForPackageModule dflags this_mod
259 | not (isHomeModule dflags this_mod),
260 Just (pkg,_) <- moduleToPackageConfig dflags this_mod =
262 ppr_pkg = ppr (mkPackageId (package pkg))
264 addErr (ptext SLIT("Module") <+> quotes (ppr this_mod) <+>
265 ptext SLIT("is a member of package") <+> ppr_pkg <> char '.' $$
266 ptext SLIT("To compile this module, please use -ignore-package") <+> ppr_pkg <> char '.')
267 | otherwise = return ()
271 %************************************************************************
273 Type-checking external-core modules
275 %************************************************************************
278 tcRnExtCore :: HscEnv
280 -> IO (Messages, Maybe ModGuts)
281 -- Nothing => some error occurred
283 tcRnExtCore hsc_env (HsExtCore this_mod decls src_binds)
284 -- The decls are IfaceDecls; all names are original names
285 = do { showPass (hsc_dflags hsc_env) "Renamer/typechecker" ;
287 initTc hsc_env ExtCoreFile this_mod $ do {
289 let { ldecls = map noLoc decls } ;
291 -- Deal with the type declarations; first bring their stuff
292 -- into scope, then rname them, then type check them
293 tcg_env <- importsFromLocalDecls (mkFakeGroup ldecls) ;
295 setGblEnv tcg_env $ do {
297 rn_decls <- rnTyClDecls ldecls ;
300 -- Dump trace of renaming part
301 rnDump (ppr rn_decls) ;
303 -- Typecheck them all together so that
304 -- any mutually recursive types are done right
305 tcg_env <- checkNoErrs (tcTyAndClassDecls emptyModDetails rn_decls) ;
306 -- Make the new type env available to stuff slurped from interface files
308 setGblEnv tcg_env $ do {
310 -- Now the core bindings
311 core_binds <- initIfaceExtCore (tcExtCoreBindings src_binds) ;
315 bndrs = bindersOfBinds core_binds ;
316 my_exports = mkNameSet (map idName bndrs) ;
317 -- ToDo: export the data types also?
319 final_type_env = extendTypeEnvWithIds (tcg_type_env tcg_env) bndrs ;
321 mod_guts = ModGuts { mg_module = this_mod,
323 mg_usages = [], -- ToDo: compute usage
324 mg_dir_imps = [], -- ??
325 mg_deps = noDependencies, -- ??
326 mg_exports = my_exports,
327 mg_types = final_type_env,
328 mg_insts = tcg_insts tcg_env,
330 mg_binds = core_binds,
333 mg_rdr_env = emptyGlobalRdrEnv,
334 mg_fix_env = emptyFixityEnv,
335 mg_deprecs = NoDeprecs,
339 tcCoreDump mod_guts ;
344 mkFakeGroup decls -- Rather clumsy; lots of unused fields
345 = HsGroup { hs_tyclds = decls, -- This is the one we want
346 hs_valds = [], hs_fords = [],
347 hs_instds = [], hs_fixds = [], hs_depds = [],
348 hs_ruleds = [], hs_defds = [] }
352 %************************************************************************
354 Type-checking the top level of a module
356 %************************************************************************
359 tcRnSrcDecls :: [LHsDecl RdrName] -> TcM TcGblEnv
360 -- Returns the variables free in the decls
361 -- Reason: solely to report unused imports and bindings
363 = do { -- Load the hi-boot interface for this module, if any
364 -- We do this now so that the boot_names can be passed
365 -- to tcTyAndClassDecls, because the boot_names are
366 -- automatically considered to be loop breakers
368 boot_iface <- tcHiBootIface mod ;
370 -- Do all the declarations
371 (tc_envs, lie) <- getLIE (tc_rn_src_decls boot_iface decls) ;
373 -- tcSimplifyTop deals with constant or ambiguous InstIds.
374 -- How could there be ambiguous ones? They can only arise if a
375 -- top-level decl falls under the monomorphism
376 -- restriction, and no subsequent decl instantiates its
377 -- type. (Usually, ambiguous type variables are resolved
378 -- during the generalisation step.)
379 traceTc (text "Tc8") ;
380 inst_binds <- setEnvs tc_envs (tcSimplifyTop lie) ;
381 -- Setting the global env exposes the instances to tcSimplifyTop
382 -- Setting the local env exposes the local Ids to tcSimplifyTop,
383 -- so that we get better error messages (monomorphism restriction)
385 -- Backsubstitution. This must be done last.
386 -- Even tcSimplifyTop may do some unification.
387 traceTc (text "Tc9") ;
388 let { (tcg_env, _) = tc_envs ;
389 TcGblEnv { tcg_type_env = type_env, tcg_binds = binds,
390 tcg_rules = rules, tcg_fords = fords } = tcg_env } ;
392 (bind_ids, binds', fords', rules') <- zonkTopDecls (binds `unionBags` inst_binds)
395 let { final_type_env = extendTypeEnvWithIds type_env bind_ids
396 ; tcg_env' = tcg_env { tcg_type_env = final_type_env,
399 tcg_fords = fords' } } ;
401 -- Make the new type env available to stuff slurped from interface files
402 writeMutVar (tcg_type_env_var tcg_env) final_type_env ;
404 -- Compare the hi-boot iface (if any) with the real thing
405 dfun_binds <- checkHiBootIface tcg_env' boot_iface ;
407 return (tcg_env' { tcg_binds = tcg_binds tcg_env' `unionBags` dfun_binds })
410 tc_rn_src_decls :: ModDetails -> [LHsDecl RdrName] -> TcM (TcGblEnv, TcLclEnv)
411 -- Loops around dealing with each top level inter-splice group
412 -- in turn, until it's dealt with the entire module
413 tc_rn_src_decls boot_details ds
414 = do { let { (first_group, group_tail) = findSplice ds } ;
415 -- If ds is [] we get ([], Nothing)
417 -- Type check the decls up to, but not including, the first splice
418 tc_envs@(tcg_env,tcl_env) <- tcRnGroup boot_details first_group ;
420 -- Bale out if errors; for example, error recovery when checking
421 -- the RHS of 'main' can mean that 'main' is not in the envt for
422 -- the subsequent checkMain test
427 -- If there is no splice, we're nearly done
429 Nothing -> do { -- Last thing: check for `main'
430 tcg_env <- checkMain ;
431 return (tcg_env, tcl_env)
434 -- If there's a splice, we must carry on
435 Just (SpliceDecl splice_expr, rest_ds) -> do {
437 failWithTc (text "Can't do a top-level splice; need a bootstrapped compiler")
440 -- Rename the splice expression, and get its supporting decls
441 (rn_splice_expr, splice_fvs) <- rnLExpr splice_expr ;
442 failIfErrsM ; -- Don't typecheck if renaming failed
444 -- Execute the splice
445 spliced_decls <- tcSpliceDecls rn_splice_expr ;
447 -- Glue them on the front of the remaining decls and loop
448 setGblEnv (tcg_env `addTcgDUs` usesOnly splice_fvs) $
449 tc_rn_src_decls boot_details (spliced_decls ++ rest_ds)
454 %************************************************************************
456 Compiling hs-boot source files, and
457 comparing the hi-boot interface with the real thing
459 %************************************************************************
462 tcRnHsBootDecls :: [LHsDecl RdrName] -> TcM TcGblEnv
463 tcRnHsBootDecls decls
464 = do { let { (first_group, group_tail) = findSplice decls }
467 Just stuff -> spliceInHsBootErr stuff
470 -- Rename the declarations
471 ; (tcg_env, rn_group) <- rnTopSrcDecls first_group
472 ; setGblEnv tcg_env $ do {
474 -- Todo: check no foreign decls, no rules, no default decls
476 -- Typecheck type/class decls
477 ; traceTc (text "Tc2")
478 ; let tycl_decls = hs_tyclds rn_group
479 ; tcg_env <- checkNoErrs (tcTyAndClassDecls emptyModDetails tycl_decls)
480 ; setGblEnv tcg_env $ do {
482 -- Typecheck instance decls
483 ; traceTc (text "Tc3")
484 ; (tcg_env, inst_infos, _binds) <- tcInstDecls1 tycl_decls (hs_instds rn_group)
485 ; setGblEnv tcg_env $ do {
487 -- Typecheck value declarations
488 ; traceTc (text "Tc5")
489 ; val_ids <- tcHsBootSigs (hs_valds rn_group)
492 -- No simplification or zonking to do
493 ; traceTc (text "Tc7a")
494 ; gbl_env <- getGblEnv
496 -- Make the final type-env
497 -- Include the dfun_ids so that their type sigs get
498 -- are written into the interface file
499 ; let { type_env0 = tcg_type_env gbl_env
500 ; type_env1 = extendTypeEnvWithIds type_env0 val_ids
501 ; type_env2 = extendTypeEnvWithIds type_env1 dfun_ids
502 ; dfun_ids = map iDFunId inst_infos }
503 ; return (gbl_env { tcg_type_env = type_env2 })
506 spliceInHsBootErr (SpliceDecl (L loc _), _)
507 = addErrAt loc (ptext SLIT("Splices are not allowed in hs-boot files"))
510 Once we've typechecked the body of the module, we want to compare what
511 we've found (gathered in a TypeEnv) with the hi-boot details (if any).
514 checkHiBootIface :: TcGblEnv -> ModDetails -> TcM (LHsBinds Id)
515 -- Compare the hi-boot file for this module (if there is one)
516 -- with the type environment we've just come up with
517 -- In the common case where there is no hi-boot file, the list
518 -- of boot_names is empty.
520 -- The bindings we return give bindings for the dfuns defined in the
521 -- hs-boot file, such as $fbEqT = $fEqT
524 (TcGblEnv { tcg_insts = local_insts, tcg_type_env = local_type_env })
525 (ModDetails { md_insts = boot_insts, md_types = boot_type_env })
526 = do { mapM_ check_one (typeEnvElts boot_type_env)
527 ; dfun_binds <- mapM check_inst boot_insts
528 ; return (unionManyBags dfun_binds) }
534 = case lookupTypeEnv local_type_env name of
535 Nothing -> addErrTc (missingBootThing boot_thing)
536 Just real_thing -> check_thing boot_thing real_thing
538 name = getName boot_thing
540 no_check name = isWiredInName name -- No checking for wired-in names. In particular,
541 -- 'error' is handled by a rather gross hack
542 -- (see comments in GHC.Err.hs-boot)
543 || name `elem` dfun_names
544 dfun_names = map getName boot_insts
547 = case [dfun | inst <- local_insts,
548 let dfun = instanceDFunId inst,
549 idType dfun `tcEqType` boot_inst_ty ] of
550 [] -> do { addErrTc (instMisMatch boot_inst); return emptyBag }
551 (dfun:_) -> return (unitBag $ noLoc $ VarBind local_boot_dfun (nlHsVar dfun))
553 boot_dfun = instanceDFunId boot_inst
554 boot_inst_ty = idType boot_dfun
555 local_boot_dfun = mkExportedLocalId (idName boot_dfun) boot_inst_ty
558 check_thing (ATyCon boot_tc) (ATyCon real_tc)
559 | isSynTyCon boot_tc && isSynTyCon real_tc,
560 defn1 `tcEqType` substTyWith tvs2 (mkTyVarTys tvs1) defn2
563 | tyConKind boot_tc == tyConKind real_tc
566 (tvs1, defn1) = getSynTyConDefn boot_tc
567 (tvs2, defn2) = getSynTyConDefn boot_tc
569 check_thing (AnId boot_id) (AnId real_id)
570 | idType boot_id `tcEqType` idType real_id
573 check_thing (ADataCon dc1) (ADataCon dc2)
574 | idType (dataConWrapId dc1) `tcEqType` idType (dataConWrapId dc2)
577 -- Can't declare a class in a hi-boot file
579 check_thing boot_thing real_thing -- Default case; failure
580 = addErrAt (srcLocSpan (getSrcLoc real_thing))
581 (bootMisMatch real_thing)
584 missingBootThing thing
585 = ppr thing <+> ptext SLIT("is defined in the hs-boot file, but not in the module")
587 = ppr thing <+> ptext SLIT("has conflicting definitions in the module and its hs-boot file")
590 2 (ptext SLIT("is defined in the hs-boot file, but not in the module"))
594 %************************************************************************
596 Type-checking the top level of a module
598 %************************************************************************
600 tcRnGroup takes a bunch of top-level source-code declarations, and
602 * gets supporting declarations from interface files
605 * and augments the TcGblEnv with the results
607 In Template Haskell it may be called repeatedly for each group of
608 declarations. It expects there to be an incoming TcGblEnv in the
609 monad; it augments it and returns the new TcGblEnv.
612 tcRnGroup :: ModDetails -> HsGroup RdrName -> TcM (TcGblEnv, TcLclEnv)
613 -- Returns the variables free in the decls, for unused-binding reporting
614 tcRnGroup boot_details decls
615 = do { -- Rename the declarations
616 (tcg_env, rn_decls) <- rnTopSrcDecls decls ;
617 setGblEnv tcg_env $ do {
619 -- Typecheck the declarations
620 tcTopSrcDecls boot_details rn_decls
623 ------------------------------------------------
624 rnTopSrcDecls :: HsGroup RdrName -> TcM (TcGblEnv, HsGroup Name)
626 = do { -- Bring top level binders into scope
627 tcg_env <- importsFromLocalDecls group ;
628 setGblEnv tcg_env $ do {
630 failIfErrsM ; -- No point in continuing if (say) we have duplicate declarations
632 -- Rename the source decls
633 (tcg_env, rn_decls) <- rnSrcDecls group ;
636 -- save the renamed syntax, if we want it
638 | Just grp <- tcg_rn_decls tcg_env
639 = tcg_env{ tcg_rn_decls = Just (appendGroups grp rn_decls) }
643 -- Dump trace of renaming part
644 rnDump (ppr rn_decls) ;
646 return (tcg_env', rn_decls)
649 ------------------------------------------------
650 tcTopSrcDecls :: ModDetails -> HsGroup Name -> TcM (TcGblEnv, TcLclEnv)
651 tcTopSrcDecls boot_details
652 (HsGroup { hs_tyclds = tycl_decls,
653 hs_instds = inst_decls,
654 hs_fords = foreign_decls,
655 hs_defds = default_decls,
656 hs_ruleds = rule_decls,
657 hs_valds = val_binds })
658 = do { -- Type-check the type and class decls, and all imported decls
659 -- The latter come in via tycl_decls
660 traceTc (text "Tc2") ;
662 tcg_env <- checkNoErrs (tcTyAndClassDecls boot_details tycl_decls) ;
663 -- tcTyAndClassDecls recovers internally, but if anything gave rise to
664 -- an error we'd better stop now, to avoid a cascade
666 -- Make these type and class decls available to stuff slurped from interface files
667 writeMutVar (tcg_type_env_var tcg_env) (tcg_type_env tcg_env) ;
670 setGblEnv tcg_env $ do {
671 -- Source-language instances, including derivings,
672 -- and import the supporting declarations
673 traceTc (text "Tc3") ;
674 (tcg_env, inst_infos, deriv_binds) <- tcInstDecls1 tycl_decls inst_decls ;
675 setGblEnv tcg_env $ do {
677 -- Foreign import declarations next. No zonking necessary
678 -- here; we can tuck them straight into the global environment.
679 traceTc (text "Tc4") ;
680 (fi_ids, fi_decls) <- tcForeignImports foreign_decls ;
681 tcExtendGlobalValEnv fi_ids $ do {
683 -- Default declarations
684 traceTc (text "Tc4a") ;
685 default_tys <- tcDefaults default_decls ;
686 updGblEnv (\gbl -> gbl { tcg_default = default_tys }) $ do {
688 -- Value declarations next
689 -- We also typecheck any extra binds that came out
690 -- of the "deriving" process (deriv_binds)
691 traceTc (text "Tc5") ;
692 (tc_val_binds, tcl_env) <- tcTopBinds (val_binds ++ deriv_binds) ;
693 setLclTypeEnv tcl_env $ do {
695 -- Second pass over class and instance declarations,
696 traceTc (text "Tc6") ;
697 (inst_binds, tcl_env) <- tcInstDecls2 tycl_decls inst_infos ;
698 showLIE (text "after instDecls2") ;
701 -- They need to be zonked, so we return them
702 traceTc (text "Tc7") ;
703 (foe_binds, foe_decls) <- tcForeignExports foreign_decls ;
706 rules <- tcRules rule_decls ;
709 traceTc (text "Tc7a") ;
710 tcg_env <- getGblEnv ;
711 let { all_binds = tc_val_binds `unionBags`
712 inst_binds `unionBags`
715 -- Extend the GblEnv with the (as yet un-zonked)
716 -- bindings, rules, foreign decls
717 tcg_env' = tcg_env { tcg_binds = tcg_binds tcg_env `unionBags` all_binds,
718 tcg_rules = tcg_rules tcg_env ++ rules,
719 tcg_fords = tcg_fords tcg_env ++ foe_decls ++ fi_decls } } ;
720 return (tcg_env', tcl_env)
725 %************************************************************************
729 %************************************************************************
733 = do { ghci_mode <- getGhciMode ;
734 tcg_env <- getGblEnv ;
736 let { main_mod = case mainModIs dflags of {
737 Just mod -> mkModule mod ;
739 main_fn = case mainFunIs dflags of {
740 Just fn -> mkRdrUnqual (mkVarOcc (mkFastString fn)) ;
741 Nothing -> main_RDR_Unqual } } ;
743 check_main ghci_mode tcg_env main_mod main_fn
747 check_main ghci_mode tcg_env main_mod main_fn
748 -- If we are in module Main, check that 'main' is defined.
749 -- It may be imported from another module!
752 -- Blimey: a whole page of code to do this...
757 = addErrCtxt mainCtxt $
758 do { mb_main <- lookupSrcOcc_maybe main_fn
759 -- Check that 'main' is in scope
760 -- It might be imported from another module!
762 Nothing -> do { complain_no_main
765 { let { rhs = nlHsApp (nlHsVar runMainIOName) (nlHsVar main_name) }
766 -- :Main.main :: IO () = runMainIO main
768 ; (main_expr, ty) <- setSrcSpan (srcLocSpan (getSrcLoc main_name)) $
771 ; let { root_main_id = mkExportedLocalId rootMainName ty ;
772 main_bind = noLoc (VarBind root_main_id main_expr) }
774 ; return (tcg_env { tcg_binds = tcg_binds tcg_env
776 tcg_dus = tcg_dus tcg_env
777 `plusDU` usesOnly (unitFV main_name)
778 -- Record the use of 'main', so that we don't
779 -- complain about it being defined but not used
783 mod = tcg_mod tcg_env
785 complain_no_main | ghci_mode == Interactive = return ()
786 | otherwise = failWithTc noMainMsg
787 -- In interactive mode, don't worry about the absence of 'main'
788 -- In other modes, fail altogether, so that we don't go on
789 -- and complain a second time when processing the export list.
791 mainCtxt = ptext SLIT("When checking the type of the main function") <+> quotes (ppr main_fn)
792 noMainMsg = ptext SLIT("The main function") <+> quotes (ppr main_fn)
793 <+> ptext SLIT("is not defined in module") <+> quotes (ppr main_mod)
796 %*********************************************************
800 %*********************************************************
804 setInteractiveContext :: HscEnv -> InteractiveContext -> TcRn a -> TcRn a
805 setInteractiveContext hsc_env icxt thing_inside
807 -- Initialise the tcg_inst_env with instances
808 -- from all home modules. This mimics the more selective
809 -- call to hptInstances in tcRnModule
810 dfuns = hptInstances hsc_env (\mod -> True)
812 updGblEnv (\env -> env {
813 tcg_rdr_env = ic_rn_gbl_env icxt,
814 tcg_type_env = ic_type_env icxt,
815 tcg_inst_env = extendInstEnvList (tcg_inst_env env) dfuns }) $
817 updLclEnv (\env -> env { tcl_rdr = ic_rn_local_env icxt }) $
819 do { traceTc (text "setIC" <+> ppr (ic_type_env icxt))
826 -> InteractiveContext
828 -> IO (Maybe (InteractiveContext, [Name], LHsExpr Id))
829 -- The returned [Name] is the same as the input except for
830 -- ExprStmt, in which case the returned [Name] is [itName]
832 -- The returned TypecheckedHsExpr is of type IO [ () ],
833 -- a list of the bound values, coerced to ().
835 tcRnStmt hsc_env ictxt rdr_stmt
836 = initTcPrintErrors hsc_env iNTERACTIVE $
837 setInteractiveContext hsc_env ictxt $ do {
839 -- Rename; use CmdLineMode because tcRnStmt is only used interactively
840 (([rn_stmt], _), fvs) <- rnStmts DoExpr [rdr_stmt] (return ((), emptyFVs)) ;
841 traceRn (text "tcRnStmt" <+> vcat [ppr rdr_stmt, ppr rn_stmt, ppr fvs]) ;
844 -- The real work is done here
845 (bound_ids, tc_expr) <- mkPlan rn_stmt ;
846 zonked_expr <- zonkTopLExpr tc_expr ;
847 zonked_ids <- zonkTopBndrs bound_ids ;
849 -- None of the Ids should be of unboxed type, because we
850 -- cast them all to HValues in the end!
851 mappM bad_unboxed (filter (isUnLiftedType . idType) zonked_ids) ;
853 traceTc (text "tcs 1") ;
854 let { -- (a) Make all the bound ids "global" ids, now that
855 -- they're notionally top-level bindings. This is
856 -- important: otherwise when we come to compile an expression
857 -- using these ids later, the byte code generator will consider
858 -- the occurrences to be free rather than global.
860 -- (b) Tidy their types; this is important, because :info may
861 -- ask to look at them, and :info expects the things it looks
862 -- up to have tidy types
863 global_ids = map globaliseAndTidy zonked_ids ;
865 -- Update the interactive context
866 rn_env = ic_rn_local_env ictxt ;
867 type_env = ic_type_env ictxt ;
869 bound_names = map idName global_ids ;
870 new_rn_env = extendLocalRdrEnv rn_env bound_names ;
872 -- Remove any shadowed bindings from the type_env;
873 -- they are inaccessible but might, I suppose, cause
874 -- a space leak if we leave them there
875 shadowed = [ n | name <- bound_names,
876 let rdr_name = mkRdrUnqual (nameOccName name),
877 Just n <- [lookupLocalRdrEnv rn_env rdr_name] ] ;
879 filtered_type_env = delListFromNameEnv type_env shadowed ;
880 new_type_env = extendTypeEnvWithIds filtered_type_env global_ids ;
882 new_ic = ictxt { ic_rn_local_env = new_rn_env,
883 ic_type_env = new_type_env }
886 dumpOptTcRn Opt_D_dump_tc
887 (vcat [text "Bound Ids" <+> pprWithCommas ppr global_ids,
888 text "Typechecked expr" <+> ppr zonked_expr]) ;
890 returnM (new_ic, bound_names, zonked_expr)
893 bad_unboxed id = addErr (sep [ptext SLIT("GHCi can't bind a variable of unlifted type:"),
894 nest 2 (ppr id <+> dcolon <+> ppr (idType id))])
896 globaliseAndTidy :: Id -> Id
898 -- Give the Id a Global Name, and tidy its type
899 = setIdType (globaliseId VanillaGlobal id) tidy_type
901 tidy_type = tidyTopType (idType id)
904 Here is the grand plan, implemented in tcUserStmt
906 What you type The IO [HValue] that hscStmt returns
907 ------------- ------------------------------------
908 let pat = expr ==> let pat = expr in return [coerce HVal x, coerce HVal y, ...]
911 pat <- expr ==> expr >>= \ pat -> return [coerce HVal x, coerce HVal y, ...]
914 expr (of IO type) ==> expr >>= \ it -> return [coerce HVal it]
915 [NB: result not printed] bindings: [it]
917 expr (of non-IO type, ==> let it = expr in print it >> return [coerce HVal it]
918 result showable) bindings: [it]
920 expr (of non-IO type,
921 result not showable) ==> error
925 ---------------------------
926 type PlanResult = ([Id], LHsExpr Id)
927 type Plan = TcM PlanResult
929 runPlans :: [Plan] -> TcM PlanResult
930 -- Try the plans in order. If one fails (by raising an exn), try the next.
931 -- If one succeeds, take it.
932 runPlans [] = panic "runPlans"
934 runPlans (p:ps) = tryTcLIE_ (runPlans ps) p
937 mkPlan :: LStmt Name -> TcM PlanResult
938 mkPlan (L loc (ExprStmt expr _ _))
939 = do { uniq <- newUnique
940 ; let fresh_it = itName uniq
941 the_bind = mkVarBind noSrcSpan fresh_it expr
942 let_stmt = L loc $ LetStmt [HsBindGroup (unitBag the_bind) [] NonRecursive]
943 bind_stmt = L loc $ BindStmt (nlVarPat fresh_it) expr
944 (HsVar bindIOName) noSyntaxExpr
945 print_it = L loc $ ExprStmt (nlHsApp (nlHsVar printName) (nlHsVar fresh_it))
946 (HsVar thenIOName) placeHolderType
949 -- [it <- e; print it] but not if it::()
951 -- [let it = e; print it]
953 ; runPlans [do { stuff@([it_id], _) <- tcGhciStmts [bind_stmt, print_it]
954 ; it_ty <- zonkTcType (idType it_id)
955 ; ifM (isUnitTy it_ty) failM
957 tcGhciStmts [bind_stmt],
958 tcGhciStmts [let_stmt, print_it],
959 tcGhciStmts [let_stmt]
962 mkPlan stmt@(L loc _)
963 | [L _ v] <- collectLStmtBinders stmt -- One binder
964 = do { let print_v = L loc $ ExprStmt (nlHsApp (nlHsVar printName) (nlHsVar v))
965 (HsVar thenIOName) placeHolderType
967 -- [stmt; print v] but not if v::()
969 ; runPlans [do { stuff@([v_id], _) <- tcGhciStmts [stmt, print_v]
970 ; v_ty <- zonkTcType (idType v_id)
971 ; ifM (isUnitTy v_ty) failM
978 ---------------------------
979 tcGhciStmts :: [LStmt Name] -> TcM PlanResult
981 = do { ioTyCon <- tcLookupTyCon ioTyConName ;
982 ret_id <- tcLookupId returnIOName ; -- return @ IO
984 io_ty = mkTyConApp ioTyCon [] ;
985 ret_ty = mkListTy unitTy ;
986 io_ret_ty = mkTyConApp ioTyCon [ret_ty] ;
988 names = map unLoc (collectLStmtsBinders stmts) ;
990 -- mk_return builds the expression
991 -- returnIO @ [()] [coerce () x, .., coerce () z]
993 -- Despite the inconvenience of building the type applications etc,
994 -- this *has* to be done in type-annotated post-typecheck form
995 -- because we are going to return a list of *polymorphic* values
996 -- coerced to type (). If we built a *source* stmt
997 -- return [coerce x, ..., coerce z]
998 -- then the type checker would instantiate x..z, and we wouldn't
999 -- get their *polymorphic* values. (And we'd get ambiguity errs
1000 -- if they were overloaded, since they aren't applied to anything.)
1001 mk_return ids = nlHsApp (noLoc $ TyApp (nlHsVar ret_id) [ret_ty])
1002 (noLoc $ ExplicitList unitTy (map mk_item ids)) ;
1003 mk_item id = nlHsApp (noLoc $ TyApp (nlHsVar unsafeCoerceId) [idType id, unitTy])
1007 -- OK, we're ready to typecheck the stmts
1008 traceTc (text "tcs 2") ;
1009 ((tc_stmts, ids), lie) <- getLIE $
1010 tcStmts DoExpr (tcDoStmt io_ty io_ret_ty) stmts $
1011 mappM tcLookupId names ;
1012 -- Look up the names right in the middle,
1013 -- where they will all be in scope
1015 -- Simplify the context
1016 const_binds <- checkNoErrs (tcSimplifyInteractive lie) ;
1017 -- checkNoErrs ensures that the plan fails if context redn fails
1019 return (ids, mkHsLet const_binds $
1020 noLoc (HsDo DoExpr tc_stmts (mk_return ids) io_ret_ty))
1025 tcRnExpr just finds the type of an expression
1029 -> InteractiveContext
1032 tcRnExpr hsc_env ictxt rdr_expr
1033 = initTcPrintErrors hsc_env iNTERACTIVE $
1034 setInteractiveContext hsc_env ictxt $ do {
1036 (rn_expr, fvs) <- rnLExpr rdr_expr ;
1039 -- Now typecheck the expression;
1040 -- it might have a rank-2 type (e.g. :t runST)
1041 ((tc_expr, res_ty), lie) <- getLIE (tcInferRho rn_expr) ;
1042 ((qtvs, _, dict_ids), lie_top) <- getLIE (tcSimplifyInfer smpl_doc (tyVarsOfType res_ty) lie) ;
1043 tcSimplifyInteractive lie_top ;
1044 qtvs' <- mappM zonkQuantifiedTyVar qtvs ;
1046 let { all_expr_ty = mkForAllTys qtvs' $
1047 mkFunTys (map idType dict_ids) $
1049 zonkTcType all_expr_ty
1052 smpl_doc = ptext SLIT("main expression")
1055 tcRnType just finds the kind of a type
1059 -> InteractiveContext
1062 tcRnType hsc_env ictxt rdr_type
1063 = initTcPrintErrors hsc_env iNTERACTIVE $
1064 setInteractiveContext hsc_env ictxt $ do {
1066 rn_type <- rnLHsType doc rdr_type ;
1069 -- Now kind-check the type
1070 (ty', kind) <- kcHsType rn_type ;
1074 doc = ptext SLIT("In GHCi input")
1080 %************************************************************************
1082 More GHCi stuff, to do with browsing and getting info
1084 %************************************************************************
1088 getModuleExports :: HscEnv -> Module -> IO (Maybe NameSet)
1089 getModuleExports hsc_env mod
1090 = initTcPrintErrors hsc_env iNTERACTIVE (tcGetModuleExports mod)
1092 tcGetModuleExports :: Module -> TcM NameSet
1093 tcGetModuleExports mod = do
1094 iface <- load_iface mod
1095 loadOrphanModules (dep_orphs (mi_deps iface))
1096 -- Load any orphan-module interfaces,
1097 -- so their instances are visible
1098 ifaceExportNames (mi_exports iface)
1104 -> Module -- Module to inspect
1105 -> Bool -- Grab just the exports, or the whole toplev
1106 -> IO (Maybe [IfaceDecl])
1108 getModuleContents hsc_env mod exports_only
1109 = initTcPrintErrors hsc_env iNTERACTIVE (get_mod_contents exports_only)
1111 get_mod_contents exports_only
1112 | not exports_only -- We want the whole top-level type env
1113 -- so it had better be a home module
1114 = do { hpt <- getHpt
1115 ; case lookupModuleEnv hpt mod of
1116 Just mod_info -> return (map (toIfaceDecl ext_nm) $
1119 md_types (hm_details mod_info))
1120 Nothing -> ghcError (ProgramError (showSDoc (noRdrEnvErr mod)))
1121 -- This is a system error; the module should be in the HPT
1124 | otherwise -- Want the exports only
1125 = do { iface <- load_iface mod
1126 ; mappM get_decl [ (mod,avail) | (mod, avails) <- mi_exports iface
1130 get_decl (mod, avail)
1131 = do { main_name <- lookupOrig mod (availName avail)
1132 ; thing <- tcLookupGlobal main_name
1133 ; return (filter_decl (availNames avail) (toIfaceDecl ext_nm thing)) }
1135 ext_nm = interactiveExtNameFun (icPrintUnqual (hsc_IC hsc_env))
1137 ---------------------
1138 filter_decl occs decl@(IfaceClass {ifSigs = sigs})
1139 = decl { ifSigs = filter (keep_sig occs) sigs }
1140 filter_decl occs decl@(IfaceData {ifCons = IfDataTyCon cons})
1141 = decl { ifCons = IfDataTyCon (filter (keep_con occs) cons) }
1142 filter_decl occs decl@(IfaceData {ifCons = IfNewTyCon con})
1143 | keep_con occs con = decl
1144 | otherwise = decl {ifCons = IfAbstractTyCon} -- Hmm?
1145 filter_decl occs decl
1148 keep_sig occs (IfaceClassOp occ _ _) = occ `elem` occs
1149 keep_con occs con = ifConOcc con `elem` occs
1151 wantToSee (AnId id) = not (isImplicitId id)
1152 wantToSee (ADataCon _) = False -- They'll come via their TyCon
1155 ---------------------
1156 load_iface mod = loadSrcInterface doc mod False {- Not boot iface -}
1158 doc = ptext SLIT("context for compiling statements")
1160 ---------------------
1161 noRdrEnvErr mod = ptext SLIT("No top-level environment available for module")
1162 <+> quotes (ppr mod)
1166 type GetInfoResult = (String, IfaceDecl, Fixity, SrcLoc,
1167 [(IfaceType,SrcLoc)] -- Instances
1170 tcRnLookupRdrName :: HscEnv -> RdrName -> IO (Maybe [Name])
1172 tcRnLookupRdrName hsc_env rdr_name
1173 = initTcPrintErrors hsc_env iNTERACTIVE $
1174 setInteractiveContext hsc_env (hsc_IC hsc_env) $
1175 lookup_rdr_name rdr_name
1178 lookup_rdr_name rdr_name = do {
1179 -- If the identifier is a constructor (begins with an
1180 -- upper-case letter), then we need to consider both
1181 -- constructor and type class identifiers.
1182 let { rdr_names = dataTcOccs rdr_name } ;
1184 -- results :: [Either Messages Name]
1185 results <- mapM (tryTcErrs . lookupOccRn) rdr_names ;
1187 traceRn (text "xx" <+> vcat [ppr rdr_names, ppr (map snd results)]);
1188 -- The successful lookups will be (Just name)
1189 let { (warns_s, good_names) = unzip [ (msgs, name)
1190 | (msgs, Just name) <- results] ;
1191 errs_s = [msgs | (msgs, Nothing) <- results] } ;
1193 -- Fail if nothing good happened, else add warnings
1194 if null good_names then
1195 -- No lookup succeeded, so
1196 -- pick the first error message and report it
1197 -- ToDo: If one of the errors is "could be Foo.X or Baz.X",
1198 -- while the other is "X is not in scope",
1199 -- we definitely want the former; but we might pick the latter
1200 do { addMessages (head errs_s) ; failM }
1201 else -- Add deprecation warnings
1202 mapM_ addMessages warns_s ;
1208 tcRnGetInfo :: HscEnv
1209 -> InteractiveContext
1211 -> IO (Maybe [GetInfoResult])
1213 -- Used to implemnent :info in GHCi
1215 -- Look up a RdrName and return all the TyThings it might be
1216 -- A capitalised RdrName is given to us in the DataName namespace,
1217 -- but we want to treat it as *both* a data constructor
1218 -- *and* as a type or class constructor;
1219 -- hence the call to dataTcOccs, and we return up to two results
1220 tcRnGetInfo hsc_env ictxt rdr_name
1221 = initTcPrintErrors hsc_env iNTERACTIVE $
1222 setInteractiveContext hsc_env ictxt $ do {
1224 -- Load the interface for all unqualified types and classes
1225 -- That way we will find all the instance declarations
1226 -- (Packages have not orphan modules, and we assume that
1227 -- in the home package all relevant modules are loaded.)
1228 loadUnqualIfaces ictxt ;
1230 good_names <- lookup_rdr_name rdr_name ;
1232 -- And lookup up the entities, avoiding duplicates, which arise
1233 -- because constructors and record selectors are represented by
1234 -- their parent declaration
1235 let { do_one name = do { thing <- tcLookupGlobal name
1236 ; fixity <- lookupFixityRn name
1237 ; ispecs <- lookupInsts print_unqual thing
1238 ; return (str, toIfaceDecl ext_nm thing, fixity,
1240 [(toIfaceType ext_nm (idType dfun), getSrcLoc dfun)
1241 | dfun <- map instanceDFunId ispecs ]
1244 -- str is the the naked occurrence name
1245 -- after stripping off qualification and parens (+)
1246 str = occNameUserString (nameOccName name)
1249 | Just p <- nameParent_maybe n = p `elem` good_names
1253 -- For the SrcLoc, the 'thing' has better info than
1254 -- the 'name' because getting the former forced the
1255 -- declaration to be loaded into the cache
1257 mapM do_one (filter (not . parent_is_there) good_names)
1258 -- Filter out names whose parent is also there
1259 -- Good example is '[]', which is both a type and data constructor
1263 ext_nm = interactiveExtNameFun print_unqual
1264 print_unqual = icPrintUnqual ictxt
1266 lookupInsts :: PrintUnqualified -> TyThing -> TcM [Instance]
1267 -- Filter the instances by the ones whose tycons (or clases resp)
1268 -- are in scope unqualified. Otherwise we list a whole lot too many!
1269 lookupInsts print_unqual (AClass cls)
1270 = do { inst_envs <- tcGetInstEnvs
1272 | ispec <- classInstances inst_envs cls
1273 , plausibleDFun print_unqual (instanceDFunId ispec) ] }
1275 lookupInsts print_unqual (ATyCon tc)
1276 = do { eps <- getEps -- Load all instances for all classes that are
1277 -- in the type environment (which are all the ones
1278 -- we've seen in any interface file so far)
1279 ; (pkg_ie, home_ie) <- tcGetInstEnvs -- Search all
1281 | ispec <- instEnvElts home_ie ++ instEnvElts pkg_ie
1282 , let dfun = instanceDFunId ispec
1284 , plausibleDFun print_unqual dfun ] }
1286 relevant df = tc_name `elemNameSet` tyClsNamesOfDFunHead (idType df)
1287 tc_name = tyConName tc
1289 lookupInsts print_unqual other = return []
1291 plausibleDFun print_unqual dfun -- Dfun involving only names that print unqualified
1292 = all ok (nameSetToList (tyClsNamesOfType (idType dfun)))
1294 ok name | isBuiltInSyntax name = True
1295 | isExternalName name = print_unqual (nameModule name) (nameOccName name)
1298 toIfaceDecl :: (Name -> IfaceExtName) -> TyThing -> IfaceDecl
1299 toIfaceDecl ext_nm thing
1300 = tyThingToIfaceDecl ext_nm (munge thing)
1302 -- munge transforms a thing to its "parent" thing
1303 munge (ADataCon dc) = ATyCon (dataConTyCon dc)
1304 munge (AnId id) = case globalIdDetails id of
1305 RecordSelId tc lbl -> ATyCon tc
1306 ClassOpId cls -> AClass cls
1308 munge other_thing = other_thing
1310 loadUnqualIfaces :: InteractiveContext -> TcM ()
1311 -- Load the home module for everything that is in scope unqualified
1312 -- This is so that we can accurately report the instances for
1314 loadUnqualIfaces ictxt
1316 mapM_ (loadSysInterface doc) (moduleSetElts (mkModuleSet unqual_mods))
1318 unqual_mods = [ nameModule name
1319 | gre <- globalRdrEnvElts (ic_rn_gbl_env ictxt),
1320 let name = gre_name gre,
1321 isTcOcc (nameOccName name), -- Types and classes only
1322 unQualOK gre ] -- In scope unqualified
1323 doc = ptext SLIT("Need interface for module whose export(s) are in scope unqualified")
1327 %************************************************************************
1331 %************************************************************************
1334 rnDump :: SDoc -> TcRn ()
1335 -- Dump, with a banner, if -ddump-rn
1336 rnDump doc = do { dumpOptTcRn Opt_D_dump_rn (mkDumpDoc "Renamer" doc) }
1338 tcDump :: TcGblEnv -> TcRn ()
1340 = do { dflags <- getDOpts ;
1342 -- Dump short output if -ddump-types or -ddump-tc
1343 ifM (dopt Opt_D_dump_types dflags || dopt Opt_D_dump_tc dflags)
1344 (dumpTcRn short_dump) ;
1346 -- Dump bindings if -ddump-tc
1347 dumpOptTcRn Opt_D_dump_tc (mkDumpDoc "Typechecker" full_dump)
1350 short_dump = pprTcGblEnv env
1351 full_dump = pprLHsBinds (tcg_binds env)
1352 -- NB: foreign x-d's have undefined's in their types;
1353 -- hence can't show the tc_fords
1356 = do { dflags <- getDOpts ;
1357 ifM (dopt Opt_D_dump_types dflags || dopt Opt_D_dump_tc dflags)
1358 (dumpTcRn (pprModGuts mod_guts)) ;
1360 -- Dump bindings if -ddump-tc
1361 dumpOptTcRn Opt_D_dump_tc (mkDumpDoc "Typechecker" full_dump) }
1363 full_dump = pprCoreBindings (mg_binds mod_guts)
1365 -- It's unpleasant having both pprModGuts and pprModDetails here
1366 pprTcGblEnv :: TcGblEnv -> SDoc
1367 pprTcGblEnv (TcGblEnv { tcg_type_env = type_env,
1368 tcg_insts = dfun_ids,
1370 tcg_imports = imports })
1371 = vcat [ ppr_types dfun_ids type_env
1372 , ppr_insts dfun_ids
1373 , vcat (map ppr rules)
1374 , ppr_gen_tycons (typeEnvTyCons type_env)
1375 , ptext SLIT("Dependent modules:") <+> ppr (moduleEnvElts (imp_dep_mods imports))
1376 , ptext SLIT("Dependent packages:") <+> ppr (imp_dep_pkgs imports)]
1378 pprModGuts :: ModGuts -> SDoc
1379 pprModGuts (ModGuts { mg_types = type_env,
1381 = vcat [ ppr_types [] type_env,
1385 ppr_types :: [Instance] -> TypeEnv -> SDoc
1386 ppr_types ispecs type_env
1387 = text "TYPE SIGNATURES" $$ nest 4 (ppr_sigs ids)
1389 dfun_ids = map instanceDFunId ispecs
1390 ids = [id | id <- typeEnvIds type_env, want_sig id]
1391 want_sig id | opt_PprStyle_Debug = True
1392 | otherwise = isLocalId id &&
1393 isExternalName (idName id) &&
1394 not (id `elem` dfun_ids)
1395 -- isLocalId ignores data constructors, records selectors etc.
1396 -- The isExternalName ignores local dictionary and method bindings
1397 -- that the type checker has invented. Top-level user-defined things
1398 -- have External names.
1400 ppr_insts :: [Instance] -> SDoc
1401 ppr_insts [] = empty
1402 ppr_insts ispecs = text "INSTANCES" $$ nest 2 (pprInstances ispecs)
1404 ppr_sigs :: [Var] -> SDoc
1406 -- Print type signatures; sort by OccName
1407 = vcat (map ppr_sig (sortLe le_sig ids))
1409 le_sig id1 id2 = getOccName id1 <= getOccName id2
1410 ppr_sig id = ppr id <+> dcolon <+> ppr (tidyTopType (idType id))
1412 ppr_rules :: [CoreRule] -> SDoc
1413 ppr_rules [] = empty
1414 ppr_rules rs = vcat [ptext SLIT("{-# RULES"),
1415 nest 4 (pprRules rs),
1418 ppr_gen_tycons [] = empty
1419 ppr_gen_tycons tcs = vcat [ptext SLIT("Tycons with generics:"),
1420 nest 2 (fsep (map ppr (filter tyConHasGenerics tcs)))]