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