ghc/compiler/typecheck/TcModule.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section[TcModule]{Typechecking a whole module}
   5
   6 \begin{code}
   7 module TcModule (
   8         typecheckModule,
   9         TcResults(..)
  10     ) where
  11
  12 #include "HsVersions.h"
  13
  14 import CmdLineOpts      ( DynFlag(..), DynFlags, opt_PprStyle_Debug )
  15 import HsSyn            ( HsBinds(..), MonoBinds(..), HsDecl(..) )
  16 import HsTypes          ( toHsType )
  17 import RnHsSyn          ( RenamedHsDecl )
  18 import TcHsSyn          ( TypecheckedMonoBinds,
  19                           TypecheckedForeignDecl, TypecheckedRuleDecl,
  20                           zonkTopBinds, zonkForeignExports, zonkRules
  21                         )
  22
  23 import TcMonad
  24 import Inst             ( plusLIE )
  25 import TcBinds          ( tcTopBinds )
  26 import TcClassDcl       ( tcClassDecls2, mkImplicitClassBinds )
  27 import TcDefaults       ( tcDefaults )
  28 import TcEnv            ( TcEnv, InstInfo(iDFunId), tcExtendGlobalValEnv,
  29                           tcEnvTyCons, tcEnvClasses,  isLocalThing,
  30                           RecTcEnv, tcSetEnv, tcSetInstEnv, initTcEnv, getTcGEnv
  31                         )
  32 import TcRules          ( tcRules )
  33 import TcForeign        ( tcForeignImports, tcForeignExports )
  34 import TcIfaceSig       ( tcInterfaceSigs )
  35 import TcInstDcls       ( tcInstDecls1, tcInstDecls2 )
  36 import TcSimplify       ( tcSimplifyTop )
  37 import TcTyClsDecls     ( tcTyAndClassDecls )
  38 import TcTyDecls        ( mkImplicitDataBinds )
  39
  40 import CoreUnfold       ( unfoldingTemplate )
  41 import Type             ( funResultTy, splitForAllTys )
  42 import Bag              ( isEmptyBag )
  43 import ErrUtils         ( printErrorsAndWarnings, dumpIfSet_dyn, showPass )
  44 import Id               ( idType, idUnfolding )
  45 import Module           ( Module )
  46 import Name             ( Name, toRdrName )
  47 import Name             ( nameEnvElts, lookupNameEnv )
  48 import TyCon            ( tyConGenInfo )
  49 import Util
  50 import BasicTypes       ( EP(..), Fixity )
  51 import Bag              ( isEmptyBag )
  52 import Outputable
  53 import HscTypes         ( PersistentCompilerState(..), HomeSymbolTable,
  54                           PackageTypeEnv, DFunId, ModIface(..),
  55                           TypeEnv, extendTypeEnvList,
  56                           TyThing(..), mkTypeEnv )
  57 import List             ( partition )
  58 \end{code}
  59
  60 Outside-world interface:
  61 \begin{code}
  62
  63 -- Convenient type synonyms first:
  64 data TcResults
  65   = TcResults {
  66         tc_pcs     :: PersistentCompilerState,  -- Augmented with imported information,
  67                                                 -- (but not stuff from this module)
  68
  69         -- All these fields have info *just for this module*
  70         tc_env     :: TypeEnv,                  -- The top level TypeEnv
  71         tc_insts   :: [DFunId],                 -- Instances
  72         tc_binds   :: TypecheckedMonoBinds,     -- Bindings
  73         tc_fords   :: [TypecheckedForeignDecl], -- Foreign import & exports.
  74         tc_rules   :: [TypecheckedRuleDecl]     -- Transformation rules
  75     }
  76
  77 ---------------
  78 typecheckModule
  79         :: DynFlags
  80         -> Module
  81         -> PersistentCompilerState
  82         -> HomeSymbolTable
  83         -> ModIface             -- Iface for this module
  84         -> PrintUnqualified     -- For error printing
  85         -> [RenamedHsDecl]
  86         -> IO (Maybe TcResults)
  87
  88 typecheckModule dflags this_mod pcs hst mod_iface unqual decls
  89   = do  { showPass dflags "Typechecker";
  90         ; env <- initTcEnv hst (pcs_PTE pcs)
  91
  92         ; (maybe_result, (warns,errs)) <- initTc dflags env tc_module
  93
  94         ; let { maybe_tc_result :: Maybe TcResults ;
  95                 maybe_tc_result = case maybe_result of
  96                                         Nothing    -> Nothing
  97                                         Just (_,r) -> Just r }
  98
  99         ; printErrorsAndWarnings unqual (errs,warns)
 100         ; printTcDump dflags maybe_tc_result
 101
 102         ; if isEmptyBag errs then
 103              return maybe_tc_result
 104            else
 105              return Nothing
 106         }
 107   where
 108     tc_module :: TcM (RecTcEnv, TcResults)
 109     tc_module = fixTc (\ ~(unf_env ,_) -> tcModule pcs hst get_fixity this_mod decls unf_env)
 110
 111     fixity_env = mi_fixities mod_iface
 112
 113     get_fixity :: Name -> Maybe Fixity
 114     get_fixity nm = lookupNameEnv fixity_env nm
 115 \end{code}
 116
 117 The internal monster:
 118 \begin{code}
 119 tcModule :: PersistentCompilerState
 120          -> HomeSymbolTable
 121          -> (Name -> Maybe Fixity)
 122          -> Module
 123          -> [RenamedHsDecl]
 124          -> RecTcEnv            -- The knot-tied environment
 125          -> TcM (TcEnv, TcResults)
 126
 127   -- (unf_env :: RecTcEnv) is used for type-checking interface pragmas
 128   -- which is done lazily [ie failure just drops the pragma
 129   -- without having any global-failure effect].
 130   --
 131   -- unf_env is also used to get the pragama info
 132   -- for imported dfuns and default methods
 133
 134 tcModule pcs hst get_fixity this_mod decls unf_env
 135   =              -- Type-check the type and class decls
 136     tcTyAndClassDecls unf_env decls             `thenTc` \ env ->
 137     tcSetEnv env                                $
 138     let
 139         classes = tcEnvClasses env
 140         tycons  = tcEnvTyCons env       -- INCLUDES tycons derived from classes
 141     in
 142
 143         -- Typecheck the instance decls, includes deriving
 144     tcInstDecls1 (pcs_insts pcs) (pcs_PRS pcs)
 145                  hst unf_env get_fixity this_mod
 146                  tycons decls           `thenTc` \ (new_pcs_insts, inst_env, local_inst_info, deriv_binds) ->
 147     tcSetInstEnv inst_env                       $
 148
 149         -- Default declarations
 150     tcDefaults decls                            `thenTc` \ defaulting_tys ->
 151     tcSetDefaultTys defaulting_tys              $
 152
 153     -- Interface type signatures
 154     -- We tie a knot so that the Ids read out of interfaces are in scope
 155     --   when we read their pragmas.
 156     -- What we rely on is that pragmas are typechecked lazily; if
 157     --   any type errors are found (ie there's an inconsistency)
 158     --   we silently discard the pragma
 159     -- We must do this before mkImplicitDataBinds (which comes next), since
 160     -- the latter looks up unpackCStringId, for example, which is usually
 161     -- imported
 162     tcInterfaceSigs unf_env decls               `thenTc` \ sig_ids ->
 163     tcExtendGlobalValEnv sig_ids                $
 164
 165     -- Create any necessary record selector Ids and their bindings
 166     -- "Necessary" includes data and newtype declarations
 167     -- We don't create bindings for dictionary constructors;
 168     -- they are always fully applied, and the bindings are just there
 169     -- to support partial applications
 170     mkImplicitDataBinds  this_mod tycons        `thenTc`    \ (data_ids, imp_data_binds) ->
 171     mkImplicitClassBinds this_mod classes       `thenNF_Tc` \ (cls_ids,  imp_cls_binds) ->
 172
 173     -- Extend the global value environment with
 174     --  (a) constructors
 175     --  (b) record selectors
 176     --  (c) class op selectors
 177     --  (d) default-method ids... where? I can't see where these are
 178     --      put into the envt, and I'm worried that the zonking phase
 179     --      will find they aren't there and complain.
 180     tcExtendGlobalValEnv data_ids               $
 181     tcExtendGlobalValEnv cls_ids                $
 182     tcGetEnv                                    `thenTc` \ unf_env ->
 183
 184         -- Foreign import declarations next
 185     tcForeignImports decls                      `thenTc`    \ (fo_ids, foi_decls) ->
 186     tcExtendGlobalValEnv fo_ids                 $
 187
 188     -- Value declarations next.
 189     -- We also typecheck any extra binds that came out of the "deriving" process
 190     tcTopBinds (get_binds decls `ThenBinds` deriv_binds)        `thenTc` \ ((val_binds, env), lie_valdecls) ->
 191     tcSetEnv env $
 192
 193         -- Foreign export declarations next
 194     tcForeignExports decls              `thenTc`    \ (lie_fodecls, foe_binds, foe_decls) ->
 195
 196         -- Second pass over class and instance declarations,
 197         -- to compile the bindings themselves.
 198     tcInstDecls2  local_inst_info               `thenNF_Tc` \ (lie_instdecls, inst_binds) ->
 199     tcClassDecls2 this_mod decls                `thenNF_Tc` \ (lie_clasdecls, cls_dm_binds) ->
 200     tcRules (pcs_rules pcs) this_mod decls      `thenNF_Tc` \ (new_pcs_rules, lie_rules, local_rules) ->
 201
 202          -- Deal with constant or ambiguous InstIds.  How could
 203          -- there be ambiguous ones?  They can only arise if a
 204          -- top-level decl falls under the monomorphism
 205          -- restriction, and no subsequent decl instantiates its
 206          -- type.  (Usually, ambiguous type variables are resolved
 207          -- during the generalisation step.)
 208     let
 209         lie_alldecls = lie_valdecls     `plusLIE`
 210                    lie_instdecls        `plusLIE`
 211                    lie_clasdecls        `plusLIE`
 212                    lie_fodecls          `plusLIE`
 213                    lie_rules
 214     in
 215     tcSimplifyTop lie_alldecls                  `thenTc` \ const_inst_binds ->
 216
 217         -- Backsubstitution.    This must be done last.
 218         -- Even tcSimplifyTop may do some unification.
 219     let
 220         all_binds = imp_data_binds      `AndMonoBinds`
 221                     imp_cls_binds       `AndMonoBinds`
 222                     val_binds           `AndMonoBinds`
 223                     inst_binds          `AndMonoBinds`
 224                     cls_dm_binds        `AndMonoBinds`
 225                     const_inst_binds    `AndMonoBinds`
 226                     foe_binds
 227     in
 228     zonkTopBinds all_binds              `thenNF_Tc` \ (all_binds', final_env)  ->
 229     tcSetEnv final_env                  $
 230         -- zonkTopBinds puts all the top-level Ids into the tcGEnv
 231     zonkForeignExports foe_decls        `thenNF_Tc` \ foe_decls' ->
 232     zonkRules local_rules               `thenNF_Tc` \ local_rules' ->
 233
 234
 235     let (local_things, imported_things) = partition (isLocalThing this_mod)
 236                                                     (nameEnvElts (getTcGEnv final_env))
 237
 238         local_type_env :: TypeEnv
 239         local_type_env = mkTypeEnv local_things
 240
 241         new_pte :: PackageTypeEnv
 242         new_pte = extendTypeEnvList (pcs_PTE pcs) imported_things
 243
 244         final_pcs :: PersistentCompilerState
 245         final_pcs = pcs { pcs_PTE   = new_pte,
 246                           pcs_insts = new_pcs_insts,
 247                           pcs_rules = new_pcs_rules
 248                     }
 249     in
 250     returnTc (unf_env,
 251               TcResults { tc_pcs     = final_pcs,
 252                           tc_env     = local_type_env,
 253                           tc_binds   = all_binds',
 254                           tc_insts   = map iDFunId local_inst_info,
 255                           tc_fords   = foi_decls ++ foe_decls',
 256                           tc_rules   = local_rules'
 257                         }
 258     )
 259
 260 get_binds decls = foldr ThenBinds EmptyBinds [binds | ValD binds <- decls]
 261 \end{code}
 262
 263
 264
 265 %************************************************************************
 266 %*                                                                      *
 267 \subsection{Dumping output}
 268 %*                                                                      *
 269 %************************************************************************
 270
 271 \begin{code}
 272 printTcDump dflags Nothing = return ()
 273 printTcDump dflags (Just results)
 274   = do dumpIfSet_dyn dflags Opt_D_dump_types
 275                      "Type signatures" (dump_sigs results)
 276        dumpIfSet_dyn dflags Opt_D_dump_tc
 277                      "Typechecked" (dump_tc results)
 278
 279 dump_tc results
 280   = vcat [ppr (tc_binds results),
 281           pp_rules (tc_rules results),
 282           ppr_gen_tycons [tc | ATyCon tc <- nameEnvElts (tc_env results)]
 283     ]
 284
 285 dump_sigs results       -- Print type signatures
 286   =     -- Convert to HsType so that we get source-language style printing
 287         -- And sort by RdrName
 288     vcat $ map ppr_sig $ sortLt lt_sig $
 289     [ (toRdrName id, toHsType (idType id))
 290     | AnId id <- nameEnvElts (tc_env results),
 291       want_sig id
 292     ]
 293   where
 294     lt_sig (n1,_) (n2,_) = n1 < n2
 295     ppr_sig (n,t)        = ppr n <+> dcolon <+> ppr t
 296
 297     want_sig id | opt_PprStyle_Debug = True
 298                 | otherwise          = True     -- For now
 299
 300 ppr_gen_tycons tcs = vcat [ptext SLIT("{-# Generic type constructor details"),
 301                            vcat (map ppr_gen_tycon tcs),
 302                            ptext SLIT("#-}")
 303                      ]
 304
 305 -- x&y are now Id's, not CoreExpr's
 306 ppr_gen_tycon tycon
 307   | Just ep <- tyConGenInfo tycon
 308   = (ppr tycon <> colon) $$ nest 4 (ppr_ep ep)
 309
 310   | otherwise = ppr tycon <> colon <+> ptext SLIT("Not derivable")
 311
 312 ppr_ep (EP from to)
 313   = vcat [ ptext SLIT("Rep type:") <+> ppr (funResultTy from_tau),
 314            ptext SLIT("From:") <+> ppr (unfoldingTemplate (idUnfolding from)),
 315            ptext SLIT("To:")   <+> ppr (unfoldingTemplate (idUnfolding to))
 316     ]
 317   where
 318     (_,from_tau) = splitForAllTys (idType from)
 319
 320 pp_rules [] = empty
 321 pp_rules rs = vcat [ptext SLIT("{-# RULES"),
 322                     nest 4 (vcat (map ppr rs)),
 323                     ptext SLIT("#-}")]
 324 \end{code}