ghc/compiler/typecheck/TcHsSyn.lhs

   1 %
   2 % (c) The AQUA Project, Glasgow University, 1996-1998
   3 %
   4 \section[TcHsSyn]{Specialisations of the @HsSyn@ syntax for the typechecker}
   5
   6 This module is an extension of @HsSyn@ syntax, for use in the type
   7 checker.
   8
   9 \begin{code}
  10 module TcHsSyn (
  11         TcMonoBinds, TcHsBinds, TcPat,
  12         TcExpr, TcGRHSs, TcGRHS, TcMatch,
  13         TcStmt, TcArithSeqInfo, TcRecordBinds,
  14         TcHsModule, TcDictBinds,
  15         TcForeignDecl,
  16
  17         TypecheckedHsBinds, TypecheckedRuleDecl,
  18         TypecheckedMonoBinds, TypecheckedPat,
  19         TypecheckedHsExpr, TypecheckedArithSeqInfo,
  20         TypecheckedStmt, TypecheckedForeignDecl,
  21         TypecheckedMatch, TypecheckedHsModule,
  22         TypecheckedGRHSs, TypecheckedGRHS,
  23         TypecheckedRecordBinds, TypecheckedDictBinds,
  24         TypecheckedMatchContext, TypecheckedCoreBind,
  25
  26         mkHsTyApp, mkHsDictApp, mkHsConApp,
  27         mkHsTyLam, mkHsDictLam, mkHsLet,
  28         hsLitType, hsPatType,
  29
  30         -- re-exported from TcMonad
  31         TcId, TcIdSet,
  32
  33         zonkTopBinds, zonkTopDecls, zonkTopExpr,
  34         zonkId, zonkTopBndrs
  35   ) where
  36
  37 #include "HsVersions.h"
  38
  39 -- friends:
  40 import HsSyn    -- oodles of it
  41
  42 -- others:
  43 import Id       ( idType, setIdType, Id )
  44 import DataCon  ( dataConWrapId )
  45
  46 import TcRnMonad
  47 import Type       ( Type )
  48 import TcType     ( TcType, TcTyVar, eqKind, isTypeKind, mkTyVarTy,
  49                     tcGetTyVar, isAnyTypeKind, mkTyConApp )
  50 import qualified  Type
  51 import TcMType    ( zonkTcTyVarToTyVar, zonkType, zonkTcType, zonkTcTyVars,
  52                     putTcTyVar )
  53 import TysPrim    ( charPrimTy, intPrimTy, floatPrimTy,
  54                     doublePrimTy, addrPrimTy
  55                   )
  56 import TysWiredIn ( charTy, stringTy, intTy, integerTy,
  57                     mkListTy, mkPArrTy, mkTupleTy, unitTy,
  58                     voidTy, listTyCon, tupleTyCon )
  59 import TyCon      ( mkPrimTyCon, tyConKind )
  60 import PrimRep    ( PrimRep(VoidRep) )
  61 import CoreSyn    ( CoreExpr )
  62 import Name       ( Name, getOccName, mkInternalName, mkDerivedTyConOcc )
  63 import Var        ( isId, isLocalVar, tyVarKind )
  64 import VarSet
  65 import VarEnv
  66 import BasicTypes ( RecFlag(..), Boxity(..), IPName(..), ipNameName, mapIPName )
  67 import Maybes     ( orElse )
  68 import Unique     ( Uniquable(..) )
  69 import SrcLoc     ( noSrcLoc )
  70 import Bag
  71 import Outputable
  72 \end{code}
  73
  74
  75 Type definitions
  76 ~~~~~~~~~~~~~~~~
  77
  78 The @Tc...@ datatypes are the ones that apply {\em during} type checking.
  79 All the types in @Tc...@ things have mutable type-variables in them for
  80 unification.
  81
  82 At the end of type checking we zonk everything to @Typechecked...@ datatypes,
  83 which have immutable type variables in them.
  84
  85 \begin{code}
  86 type TcHsBinds          = HsBinds       TcId
  87 type TcMonoBinds        = MonoBinds     TcId
  88 type TcDictBinds        = TcMonoBinds
  89 type TcPat              = OutPat        TcId
  90 type TcExpr             = HsExpr        TcId
  91 type TcGRHSs            = GRHSs         TcId
  92 type TcGRHS             = GRHS          TcId
  93 type TcMatch            = Match         TcId
  94 type TcStmt             = Stmt          TcId
  95 type TcArithSeqInfo     = ArithSeqInfo  TcId
  96 type TcRecordBinds      = HsRecordBinds TcId
  97 type TcHsModule         = HsModule      TcId
  98 type TcForeignDecl      = ForeignDecl  TcId
  99 type TcRuleDecl         = RuleDecl     TcId
 100
 101 type TypecheckedPat             = OutPat        Id
 102 type TypecheckedMonoBinds       = MonoBinds     Id
 103 type TypecheckedDictBinds       = TypecheckedMonoBinds
 104 type TypecheckedHsBinds         = HsBinds       Id
 105 type TypecheckedHsExpr          = HsExpr        Id
 106 type TypecheckedArithSeqInfo    = ArithSeqInfo  Id
 107 type TypecheckedStmt            = Stmt          Id
 108 type TypecheckedMatch           = Match         Id
 109 type TypecheckedGRHSs           = GRHSs         Id
 110 type TypecheckedGRHS            = GRHS          Id
 111 type TypecheckedRecordBinds     = HsRecordBinds Id
 112 type TypecheckedHsModule        = HsModule      Id
 113 type TypecheckedForeignDecl     = ForeignDecl   Id
 114 type TypecheckedRuleDecl        = RuleDecl      Id
 115 type TypecheckedCoreBind        = (Id, CoreExpr)
 116
 117 type TypecheckedMatchContext    = HsMatchContext Name   -- Keeps consistency with
 118                                                         -- HsDo arg StmtContext
 119 \end{code}
 120
 121 \begin{code}
 122 mkHsTyApp expr []  = expr
 123 mkHsTyApp expr tys = TyApp expr tys
 124
 125 mkHsDictApp expr []      = expr
 126 mkHsDictApp expr dict_vars = DictApp expr dict_vars
 127
 128 mkHsTyLam []     expr = expr
 129 mkHsTyLam tyvars expr = TyLam tyvars expr
 130
 131 mkHsDictLam []    expr = expr
 132 mkHsDictLam dicts expr = DictLam dicts expr
 133
 134 mkHsLet EmptyMonoBinds expr = expr
 135 mkHsLet mbinds         expr = HsLet (MonoBind mbinds [] Recursive) expr
 136
 137 mkHsConApp data_con tys args = foldl HsApp (HsVar (dataConWrapId data_con) `mkHsTyApp` tys) args
 138 \end{code}
 139
 140
 141 %************************************************************************
 142 %*                                                                      *
 143 \subsection[mkFailurePair]{Code for pattern-matching and other failures}
 144 %*                                                                      *
 145 %************************************************************************
 146
 147 Note: If @hsPatType@ doesn't bear a strong resemblance to @exprType@,
 148 then something is wrong.
 149 \begin{code}
 150 hsPatType :: TypecheckedPat -> Type
 151
 152 hsPatType (ParPat pat)            = hsPatType pat
 153 hsPatType (WildPat ty)            = ty
 154 hsPatType (VarPat var)            = idType var
 155 hsPatType (LazyPat pat)           = hsPatType pat
 156 hsPatType (LitPat lit)            = hsLitType lit
 157 hsPatType (AsPat var pat)         = idType var
 158 hsPatType (ListPat _ ty)          = mkListTy ty
 159 hsPatType (PArrPat _ ty)          = mkPArrTy ty
 160 hsPatType (TuplePat pats box)     = mkTupleTy box (length pats) (map hsPatType pats)
 161 hsPatType (ConPatOut _ _ ty _ _)  = ty
 162 hsPatType (SigPatOut _ ty _)      = ty
 163 hsPatType (NPatOut lit ty _)      = ty
 164 hsPatType (NPlusKPatOut id _ _ _) = idType id
 165 hsPatType (DictPat ds ms)         = case (ds ++ ms) of
 166                                        []  -> unitTy
 167                                        [d] -> idType d
 168                                        ds  -> mkTupleTy Boxed (length ds) (map idType ds)
 169
 170
 171 hsLitType :: HsLit -> TcType
 172 hsLitType (HsChar c)       = charTy
 173 hsLitType (HsCharPrim c)   = charPrimTy
 174 hsLitType (HsString str)   = stringTy
 175 hsLitType (HsStringPrim s) = addrPrimTy
 176 hsLitType (HsInt i)        = intTy
 177 hsLitType (HsIntPrim i)    = intPrimTy
 178 hsLitType (HsInteger i)    = integerTy
 179 hsLitType (HsRat _ ty)     = ty
 180 hsLitType (HsFloatPrim f)  = floatPrimTy
 181 hsLitType (HsDoublePrim d) = doublePrimTy
 182 hsLitType (HsLitLit _ ty)  = ty
 183 \end{code}
 184
 185 \begin{code}
 186 -- zonkId is used *during* typechecking just to zonk the Id's type
 187 zonkId :: TcId -> TcM TcId
 188 zonkId id
 189   = zonkTcType (idType id) `thenM` \ ty' ->
 190     returnM (setIdType id ty')
 191 \end{code}
 192
 193
 194 %************************************************************************
 195 %*                                                                      *
 196 \subsection[BackSubst-HsBinds]{Running a substitution over @HsBinds@}
 197 %*                                                                      *
 198 %************************************************************************
 199
 200 This zonking pass runs over the bindings
 201
 202  a) to convert TcTyVars to TyVars etc, dereferencing any bindings etc
 203  b) convert unbound TcTyVar to Void
 204  c) convert each TcId to an Id by zonking its type
 205
 206 The type variables are converted by binding mutable tyvars to immutable ones
 207 and then zonking as normal.
 208
 209 The Ids are converted by binding them in the normal Tc envt; that
 210 way we maintain sharing; eg an Id is zonked at its binding site and they
 211 all occurrences of that Id point to the common zonked copy
 212
 213 It's all pretty boring stuff, because HsSyn is such a large type, and
 214 the environment manipulation is tiresome.
 215
 216 \begin{code}
 217 data ZonkEnv = ZonkEnv  (TcType -> TcM Type)    -- How to zonk a type
 218                         (IdEnv Id)              -- What variables are in scope
 219         -- Maps an Id to its zonked version; both have the same Name
 220         -- Is only consulted lazily; hence knot-tying
 221
 222 emptyZonkEnv = ZonkEnv zonkTypeZapping emptyVarEnv
 223
 224 extendZonkEnv :: ZonkEnv -> [Id] -> ZonkEnv
 225 extendZonkEnv (ZonkEnv zonk_ty env) ids
 226   = ZonkEnv zonk_ty (extendVarEnvList env [(id,id) | id <- ids])
 227
 228 setZonkType :: ZonkEnv -> (TcType -> TcM Type) -> ZonkEnv
 229 setZonkType (ZonkEnv _ env) zonk_ty = ZonkEnv zonk_ty env
 230
 231 mkZonkEnv :: [Id] -> ZonkEnv
 232 mkZonkEnv ids = extendZonkEnv emptyZonkEnv ids
 233
 234 zonkIdOcc :: ZonkEnv -> TcId -> Id
 235 -- Ids defined in this module should be in the envt;
 236 -- ignore others.  (Actually, data constructors are also
 237 -- not LocalVars, even when locally defined, but that is fine.)
 238 --
 239 -- Actually, Template Haskell works in 'chunks' of declarations, and
 240 -- an earlier chunk won't be in the 'env' that the zonking phase
 241 -- carries around.  Instead it'll be in the tcg_gbl_env, already fully
 242 -- zonked.  There's no point in looking it up there (except for error
 243 -- checking), and it's not conveniently to hand; hence the simple
 244 -- 'orElse' case in the LocalVar branch.
 245 --
 246 -- Even without template splices, in module Main, the checking of
 247 -- 'main' is done as a separte chunk.
 248 zonkIdOcc (ZonkEnv zonk_ty env) id
 249   | isLocalVar id = lookupVarEnv env id `orElse` id
 250   | otherwise     = id
 251
 252 zonkIdOccs env ids = map (zonkIdOcc env) ids
 253
 254 -- zonkIdBndr is used *after* typechecking to get the Id's type
 255 -- to its final form.  The TyVarEnv give
 256 zonkIdBndr :: ZonkEnv -> TcId -> TcM Id
 257 zonkIdBndr env id
 258   = zonkTcTypeToType env (idType id)    `thenM` \ ty' ->
 259     returnM (setIdType id ty')
 260
 261 zonkIdBndrs :: ZonkEnv -> [TcId] -> TcM [Id]
 262 zonkIdBndrs env ids = mappM (zonkIdBndr env) ids
 263
 264 zonkTopBndrs :: [TcId] -> TcM [Id]
 265 zonkTopBndrs ids = zonkIdBndrs emptyZonkEnv ids
 266 \end{code}
 267
 268
 269 \begin{code}
 270 zonkTopExpr :: TcExpr -> TcM TypecheckedHsExpr
 271 zonkTopExpr e = zonkExpr emptyZonkEnv e
 272
 273 zonkTopDecls :: TcMonoBinds -> [TcRuleDecl] -> [TcForeignDecl]
 274              -> TcM ([Id],
 275                         TypecheckedMonoBinds,
 276                         [TypecheckedForeignDecl],
 277                         [TypecheckedRuleDecl])
 278 zonkTopDecls binds rules fords  -- Top level is implicitly recursive
 279   = fixM (\ ~(new_ids, _, _, _) ->
 280         let
 281            zonk_env = mkZonkEnv new_ids
 282         in
 283         zonkMonoBinds zonk_env binds            `thenM` \ (binds', new_ids) ->
 284         zonkRules zonk_env rules                `thenM` \ rules' ->
 285         zonkForeignExports zonk_env fords       `thenM` \ fords' ->
 286
 287         returnM (bagToList new_ids, binds', fords', rules')
 288     )
 289
 290 zonkTopBinds :: TcMonoBinds -> TcM ([Id], TypecheckedMonoBinds)
 291 zonkTopBinds binds
 292   = fixM (\ ~(new_ids, _) ->
 293         let
 294            zonk_env = mkZonkEnv new_ids
 295         in
 296         zonkMonoBinds zonk_env binds            `thenM` \ (binds', new_ids) ->
 297         returnM (bagToList new_ids, binds')
 298     )
 299
 300 ---------------------------------------------
 301 zonkBinds :: ZonkEnv -> TcHsBinds -> TcM (ZonkEnv, TypecheckedHsBinds)
 302 zonkBinds env EmptyBinds = returnM (env, EmptyBinds)
 303
 304 zonkBinds env (ThenBinds b1 b2)
 305   = zonkBinds env b1    `thenM` \ (env1, b1') ->
 306     zonkBinds env1 b2   `thenM` \ (env2, b2') ->
 307     returnM (env2, b1' `ThenBinds` b2')
 308
 309 zonkBinds env (MonoBind bind sigs is_rec)
 310   = ASSERT( null sigs )
 311     fixM (\ ~(_, _, new_ids) ->
 312         let
 313            env1 = extendZonkEnv env (bagToList new_ids)
 314         in
 315         zonkMonoBinds env1 bind `thenM` \ (new_bind, new_ids) ->
 316         returnM (env1, new_bind, new_ids)
 317     )                           `thenM` \ (env1, new_bind, _) ->
 318    returnM (env1, mkMonoBind new_bind [] is_rec)
 319
 320 ---------------------------------------------
 321 zonkMonoBinds :: ZonkEnv -> TcMonoBinds
 322               -> TcM (TypecheckedMonoBinds, Bag Id)
 323
 324 zonkMonoBinds env EmptyMonoBinds = returnM (EmptyMonoBinds, emptyBag)
 325
 326 zonkMonoBinds env (AndMonoBinds mbinds1 mbinds2)
 327   = zonkMonoBinds env mbinds1           `thenM` \ (b1', ids1) ->
 328     zonkMonoBinds env mbinds2           `thenM` \ (b2', ids2) ->
 329     returnM (b1' `AndMonoBinds` b2',
 330              ids1 `unionBags` ids2)
 331
 332 zonkMonoBinds env (PatMonoBind pat grhss locn)
 333   = zonkPat env pat     `thenM` \ (new_pat, ids) ->
 334     zonkGRHSs env grhss `thenM` \ new_grhss ->
 335     returnM (PatMonoBind new_pat new_grhss locn, ids)
 336
 337 zonkMonoBinds env (VarMonoBind var expr)
 338   = zonkIdBndr env var  `thenM` \ new_var ->
 339     zonkExpr env expr   `thenM` \ new_expr ->
 340     returnM (VarMonoBind new_var new_expr, unitBag new_var)
 341
 342 zonkMonoBinds env (FunMonoBind var inf ms locn)
 343   = zonkIdBndr env var                  `thenM` \ new_var ->
 344     mappM (zonkMatch env) ms            `thenM` \ new_ms ->
 345     returnM (FunMonoBind new_var inf new_ms locn, unitBag new_var)
 346
 347
 348 zonkMonoBinds env (AbsBinds tyvars dicts exports inlines val_bind)
 349   = mappM zonkTcTyVarToTyVar tyvars     `thenM` \ new_tyvars ->
 350         -- No need to extend tyvar env: the effects are
 351         -- propagated through binding the tyvars themselves
 352
 353     zonkIdBndrs env dicts               `thenM` \ new_dicts ->
 354     fixM (\ ~(_, _, val_bind_ids) ->
 355         let
 356           env1 = extendZonkEnv (extendZonkEnv env new_dicts)
 357                                (bagToList val_bind_ids)
 358         in
 359         zonkMonoBinds env1 val_bind             `thenM` \ (new_val_bind, val_bind_ids) ->
 360         mappM (zonkExport env1) exports `thenM` \ new_exports ->
 361         returnM (new_val_bind, new_exports, val_bind_ids)
 362     )                                           `thenM ` \ (new_val_bind, new_exports, _) ->
 363     let
 364         new_globals = listToBag [global | (_, global, local) <- new_exports]
 365     in
 366     returnM (AbsBinds new_tyvars new_dicts new_exports inlines new_val_bind,
 367                  new_globals)
 368   where
 369     zonkExport env (tyvars, global, local)
 370         = zonkTcTyVars tyvars           `thenM` \ tys ->
 371           let
 372                 new_tyvars = map (tcGetTyVar "zonkExport") tys
 373                 -- This isn't the binding occurrence of these tyvars
 374                 -- but they should *be* tyvars.  Hence tcGetTyVar.
 375           in
 376           zonkIdBndr env global         `thenM` \ new_global ->
 377           returnM (new_tyvars, new_global, zonkIdOcc env local)
 378 \end{code}
 379
 380 %************************************************************************
 381 %*                                                                      *
 382 \subsection[BackSubst-Match-GRHSs]{Match and GRHSs}
 383 %*                                                                      *
 384 %************************************************************************
 385
 386 \begin{code}
 387 zonkMatch :: ZonkEnv -> TcMatch -> TcM TypecheckedMatch
 388
 389 zonkMatch env (Match pats _ grhss)
 390   = zonkPats env pats                                           `thenM` \ (new_pats, new_ids) ->
 391     zonkGRHSs (extendZonkEnv env (bagToList new_ids)) grhss     `thenM` \ new_grhss ->
 392     returnM (Match new_pats Nothing new_grhss)
 393
 394 -------------------------------------------------------------------------
 395 zonkGRHSs :: ZonkEnv -> TcGRHSs -> TcM TypecheckedGRHSs
 396
 397 zonkGRHSs env (GRHSs grhss binds ty)
 398   = zonkBinds env binds         `thenM` \ (new_env, new_binds) ->
 399     let
 400         zonk_grhs (GRHS guarded locn)
 401           = zonkStmts new_env guarded  `thenM` \ new_guarded ->
 402             returnM (GRHS new_guarded locn)
 403     in
 404     mappM zonk_grhs grhss       `thenM` \ new_grhss ->
 405     zonkTcTypeToType env ty     `thenM` \ new_ty ->
 406     returnM (GRHSs new_grhss new_binds new_ty)
 407 \end{code}
 408
 409 %************************************************************************
 410 %*                                                                      *
 411 \subsection[BackSubst-HsExpr]{Running a zonkitution over a TypeCheckedExpr}
 412 %*                                                                      *
 413 %************************************************************************
 414
 415 \begin{code}
 416 zonkExprs :: ZonkEnv -> [TcExpr] -> TcM [TypecheckedHsExpr]
 417 zonkExpr  :: ZonkEnv -> TcExpr -> TcM TypecheckedHsExpr
 418
 419 zonkExprs env exprs = mappM (zonkExpr env) exprs
 420
 421
 422 zonkExpr env (HsVar id)
 423   = returnM (HsVar (zonkIdOcc env id))
 424
 425 zonkExpr env (HsIPVar id)
 426   = returnM (HsIPVar (mapIPName (zonkIdOcc env) id))
 427
 428 zonkExpr env (HsLit (HsRat f ty))
 429   = zonkTcTypeToType env ty        `thenM` \ new_ty  ->
 430     returnM (HsLit (HsRat f new_ty))
 431
 432 zonkExpr env (HsLit (HsLitLit lit ty))
 433   = zonkTcTypeToType env ty         `thenM` \ new_ty  ->
 434     returnM (HsLit (HsLitLit lit new_ty))
 435
 436 zonkExpr env (HsLit lit)
 437   = returnM (HsLit lit)
 438
 439 -- HsOverLit doesn't appear in typechecker output
 440
 441 zonkExpr env (HsLam match)
 442   = zonkMatch env match `thenM` \ new_match ->
 443     returnM (HsLam new_match)
 444
 445 zonkExpr env (HsApp e1 e2)
 446   = zonkExpr env e1     `thenM` \ new_e1 ->
 447     zonkExpr env e2     `thenM` \ new_e2 ->
 448     returnM (HsApp new_e1 new_e2)
 449
 450 zonkExpr env (HsBracketOut body bs)
 451   = mappM zonk_b bs     `thenM` \ bs' ->
 452     returnM (HsBracketOut body bs')
 453   where
 454     zonk_b (n,e) = zonkExpr env e       `thenM` \ e' ->
 455                    returnM (n,e')
 456
 457 zonkExpr env (HsSplice n e loc) = WARN( True, ppr e )   -- Should not happen
 458                                   returnM (HsSplice n e loc)
 459
 460 zonkExpr env (OpApp e1 op fixity e2)
 461   = zonkExpr env e1     `thenM` \ new_e1 ->
 462     zonkExpr env op     `thenM` \ new_op ->
 463     zonkExpr env e2     `thenM` \ new_e2 ->
 464     returnM (OpApp new_e1 new_op fixity new_e2)
 465
 466 zonkExpr env (NegApp _ _) = panic "zonkExpr env: NegApp"
 467
 468 zonkExpr env (HsPar e)
 469   = zonkExpr env e      `thenM` \new_e ->
 470     returnM (HsPar new_e)
 471
 472 zonkExpr env (SectionL expr op)
 473   = zonkExpr env expr   `thenM` \ new_expr ->
 474     zonkExpr env op             `thenM` \ new_op ->
 475     returnM (SectionL new_expr new_op)
 476
 477 zonkExpr env (SectionR op expr)
 478   = zonkExpr env op             `thenM` \ new_op ->
 479     zonkExpr env expr           `thenM` \ new_expr ->
 480     returnM (SectionR new_op new_expr)
 481
 482 zonkExpr env (HsCase expr ms src_loc)
 483   = zonkExpr env expr           `thenM` \ new_expr ->
 484     mappM (zonkMatch env) ms    `thenM` \ new_ms ->
 485     returnM (HsCase new_expr new_ms src_loc)
 486
 487 zonkExpr env (HsIf e1 e2 e3 src_loc)
 488   = zonkExpr env e1     `thenM` \ new_e1 ->
 489     zonkExpr env e2     `thenM` \ new_e2 ->
 490     zonkExpr env e3     `thenM` \ new_e3 ->
 491     returnM (HsIf new_e1 new_e2 new_e3 src_loc)
 492
 493 zonkExpr env (HsLet binds expr)
 494   = zonkBinds env binds         `thenM` \ (new_env, new_binds) ->
 495     zonkExpr new_env expr       `thenM` \ new_expr ->
 496     returnM (HsLet new_binds new_expr)
 497
 498 zonkExpr env (HsWith expr binds is_with)
 499   = mappM zonk_ip_bind binds    `thenM` \ new_binds ->
 500     let
 501         env1 = extendZonkEnv env (map (ipNameName . fst) new_binds)
 502     in
 503     zonkExpr env1 expr          `thenM` \ new_expr ->
 504     returnM (HsWith new_expr new_binds is_with)
 505     where
 506         zonk_ip_bind (n, e)
 507             = mapIPNameTc (zonkIdBndr env) n    `thenM` \ n' ->
 508               zonkExpr env e                    `thenM` \ e' ->
 509               returnM (n', e')
 510
 511 zonkExpr env (HsDo do_or_lc stmts ids ty src_loc)
 512   = zonkStmts env stmts         `thenM` \ new_stmts ->
 513     zonkTcTypeToType env ty     `thenM` \ new_ty   ->
 514     returnM (HsDo do_or_lc new_stmts
 515                       (zonkIdOccs env ids)
 516                       new_ty src_loc)
 517
 518 zonkExpr env (ExplicitList ty exprs)
 519   = zonkTcTypeToType env ty     `thenM` \ new_ty ->
 520     zonkExprs env exprs         `thenM` \ new_exprs ->
 521     returnM (ExplicitList new_ty new_exprs)
 522
 523 zonkExpr env (ExplicitPArr ty exprs)
 524   = zonkTcTypeToType env ty     `thenM` \ new_ty ->
 525     zonkExprs env exprs         `thenM` \ new_exprs ->
 526     returnM (ExplicitPArr new_ty new_exprs)
 527
 528 zonkExpr env (ExplicitTuple exprs boxed)
 529   = zonkExprs env exprs         `thenM` \ new_exprs ->
 530     returnM (ExplicitTuple new_exprs boxed)
 531
 532 zonkExpr env (RecordConOut data_con con_expr rbinds)
 533   = zonkExpr env con_expr       `thenM` \ new_con_expr ->
 534     zonkRbinds env rbinds       `thenM` \ new_rbinds ->
 535     returnM (RecordConOut data_con new_con_expr new_rbinds)
 536
 537 zonkExpr env (RecordUpd _ _) = panic "zonkExpr env:RecordUpd"
 538
 539 zonkExpr env (RecordUpdOut expr in_ty out_ty rbinds)
 540   = zonkExpr env expr           `thenM` \ new_expr ->
 541     zonkTcTypeToType env in_ty  `thenM` \ new_in_ty ->
 542     zonkTcTypeToType env out_ty `thenM` \ new_out_ty ->
 543     zonkRbinds env rbinds       `thenM` \ new_rbinds ->
 544     returnM (RecordUpdOut new_expr new_in_ty new_out_ty new_rbinds)
 545
 546 zonkExpr env (ExprWithTySig _ _) = panic "zonkExpr env:ExprWithTySig"
 547 zonkExpr env (ArithSeqIn _)      = panic "zonkExpr env:ArithSeqIn"
 548 zonkExpr env (PArrSeqIn _)       = panic "zonkExpr env:PArrSeqIn"
 549
 550 zonkExpr env (ArithSeqOut expr info)
 551   = zonkExpr env expr           `thenM` \ new_expr ->
 552     zonkArithSeq env info       `thenM` \ new_info ->
 553     returnM (ArithSeqOut new_expr new_info)
 554
 555 zonkExpr env (PArrSeqOut expr info)
 556   = zonkExpr env expr           `thenM` \ new_expr ->
 557     zonkArithSeq env info       `thenM` \ new_info ->
 558     returnM (PArrSeqOut new_expr new_info)
 559
 560 zonkExpr env (HsCCall fun args may_gc is_casm result_ty)
 561   = zonkExprs env args                  `thenM` \ new_args ->
 562     zonkTcTypeToType env result_ty      `thenM` \ new_result_ty ->
 563     returnM (HsCCall fun new_args may_gc is_casm new_result_ty)
 564
 565 zonkExpr env (HsSCC lbl expr)
 566   = zonkExpr env expr   `thenM` \ new_expr ->
 567     returnM (HsSCC lbl new_expr)
 568
 569 zonkExpr env (TyLam tyvars expr)
 570   = mappM zonkTcTyVarToTyVar tyvars     `thenM` \ new_tyvars ->
 571         -- No need to extend tyvar env; see AbsBinds
 572
 573     zonkExpr env expr                   `thenM` \ new_expr ->
 574     returnM (TyLam new_tyvars new_expr)
 575
 576 zonkExpr env (TyApp expr tys)
 577   = zonkExpr env expr                   `thenM` \ new_expr ->
 578     mappM (zonkTcTypeToType env) tys    `thenM` \ new_tys ->
 579     returnM (TyApp new_expr new_tys)
 580
 581 zonkExpr env (DictLam dicts expr)
 582   = zonkIdBndrs env dicts       `thenM` \ new_dicts ->
 583     let
 584         env1 = extendZonkEnv env new_dicts
 585     in
 586     zonkExpr env1 expr          `thenM` \ new_expr ->
 587     returnM (DictLam new_dicts new_expr)
 588
 589 zonkExpr env (DictApp expr dicts)
 590   = zonkExpr env expr                   `thenM` \ new_expr ->
 591     returnM (DictApp new_expr (zonkIdOccs env dicts))
 592
 593
 594
 595 -------------------------------------------------------------------------
 596 zonkArithSeq :: ZonkEnv -> TcArithSeqInfo -> TcM TypecheckedArithSeqInfo
 597
 598 zonkArithSeq env (From e)
 599   = zonkExpr env e              `thenM` \ new_e ->
 600     returnM (From new_e)
 601
 602 zonkArithSeq env (FromThen e1 e2)
 603   = zonkExpr env e1     `thenM` \ new_e1 ->
 604     zonkExpr env e2     `thenM` \ new_e2 ->
 605     returnM (FromThen new_e1 new_e2)
 606
 607 zonkArithSeq env (FromTo e1 e2)
 608   = zonkExpr env e1     `thenM` \ new_e1 ->
 609     zonkExpr env e2     `thenM` \ new_e2 ->
 610     returnM (FromTo new_e1 new_e2)
 611
 612 zonkArithSeq env (FromThenTo e1 e2 e3)
 613   = zonkExpr env e1     `thenM` \ new_e1 ->
 614     zonkExpr env e2     `thenM` \ new_e2 ->
 615     zonkExpr env e3     `thenM` \ new_e3 ->
 616     returnM (FromThenTo new_e1 new_e2 new_e3)
 617
 618
 619 -------------------------------------------------------------------------
 620 zonkStmts :: ZonkEnv -> [TcStmt] -> TcM [TypecheckedStmt]
 621
 622 zonkStmts env [] = returnM []
 623
 624 zonkStmts env (ParStmtOut bndrstmtss : stmts)
 625   = mappM (mappM zonkId) bndrss         `thenM` \ new_bndrss ->
 626     mappM (zonkStmts env) stmtss        `thenM` \ new_stmtss ->
 627     let
 628         new_binders = concat new_bndrss
 629         env1 = extendZonkEnv env new_binders
 630     in
 631     zonkStmts env1 stmts                `thenM` \ new_stmts ->
 632     returnM (ParStmtOut (zip new_bndrss new_stmtss) : new_stmts)
 633   where
 634     (bndrss, stmtss) = unzip bndrstmtss
 635
 636 zonkStmts env (RecStmt vs segStmts rets : stmts)
 637   = mappM zonkId vs             `thenM` \ new_vs ->
 638     let
 639         env1 = extendZonkEnv env new_vs
 640     in
 641     zonkStmts env1 segStmts     `thenM` \ new_segStmts ->
 642     zonkExprs env1 rets         `thenM` \ new_rets ->
 643     zonkStmts env1 stmts        `thenM` \ new_stmts ->
 644     returnM (RecStmt new_vs new_segStmts new_rets : new_stmts)
 645
 646 zonkStmts env (ResultStmt expr locn : stmts)
 647   = zonkExpr env expr   `thenM` \ new_expr ->
 648     zonkStmts env stmts `thenM` \ new_stmts ->
 649     returnM (ResultStmt new_expr locn : new_stmts)
 650
 651 zonkStmts env (ExprStmt expr ty locn : stmts)
 652   = zonkExpr env expr           `thenM` \ new_expr ->
 653     zonkTcTypeToType env ty     `thenM` \ new_ty ->
 654     zonkStmts env stmts         `thenM` \ new_stmts ->
 655     returnM (ExprStmt new_expr new_ty locn : new_stmts)
 656
 657 zonkStmts env (LetStmt binds : stmts)
 658   = zonkBinds env binds         `thenM` \ (new_env, new_binds) ->
 659     zonkStmts new_env stmts     `thenM` \ new_stmts ->
 660     returnM (LetStmt new_binds : new_stmts)
 661
 662 zonkStmts env (BindStmt pat expr locn : stmts)
 663   = zonkExpr env expr                   `thenM` \ new_expr ->
 664     zonkPat env pat                     `thenM` \ (new_pat, new_ids) ->
 665     let
 666         env1 = extendZonkEnv env (bagToList new_ids)
 667     in
 668     zonkStmts env1 stmts                `thenM` \ new_stmts ->
 669     returnM (BindStmt new_pat new_expr locn : new_stmts)
 670
 671
 672
 673 -------------------------------------------------------------------------
 674 zonkRbinds :: ZonkEnv -> TcRecordBinds -> TcM TypecheckedRecordBinds
 675
 676 zonkRbinds env rbinds
 677   = mappM zonk_rbind rbinds
 678   where
 679     zonk_rbind (field, expr)
 680       = zonkExpr env expr       `thenM` \ new_expr ->
 681         returnM (zonkIdOcc env field, new_expr)
 682
 683 -------------------------------------------------------------------------
 684 mapIPNameTc :: (a -> TcM b) -> IPName a -> TcM (IPName b)
 685 mapIPNameTc f (Dupable n) = f n  `thenM` \ r -> returnM (Dupable r)
 686 mapIPNameTc f (Linear  n) = f n  `thenM` \ r -> returnM (Linear r)
 687 \end{code}
 688
 689
 690 %************************************************************************
 691 %*                                                                      *
 692 \subsection[BackSubst-Pats]{Patterns}
 693 %*                                                                      *
 694 %************************************************************************
 695
 696 \begin{code}
 697 zonkPat :: ZonkEnv -> TcPat -> TcM (TypecheckedPat, Bag Id)
 698
 699 zonkPat env (ParPat p)
 700   = zonkPat env p       `thenM` \ (new_p, ids) ->
 701     returnM (ParPat new_p, ids)
 702
 703 zonkPat env (WildPat ty)
 704   = zonkTcTypeToType env ty   `thenM` \ new_ty ->
 705     returnM (WildPat new_ty, emptyBag)
 706
 707 zonkPat env (VarPat v)
 708   = zonkIdBndr env v        `thenM` \ new_v ->
 709     returnM (VarPat new_v, unitBag new_v)
 710
 711 zonkPat env (LazyPat pat)
 712   = zonkPat env pat         `thenM` \ (new_pat, ids) ->
 713     returnM (LazyPat new_pat, ids)
 714
 715 zonkPat env (AsPat n pat)
 716   = zonkIdBndr env n        `thenM` \ new_n ->
 717     zonkPat env pat         `thenM` \ (new_pat, ids) ->
 718     returnM (AsPat new_n new_pat, new_n `consBag` ids)
 719
 720 zonkPat env (ListPat pats ty)
 721   = zonkTcTypeToType env ty     `thenM` \ new_ty ->
 722     zonkPats env pats           `thenM` \ (new_pats, ids) ->
 723     returnM (ListPat new_pats new_ty, ids)
 724
 725 zonkPat env (PArrPat pats ty)
 726   = zonkTcTypeToType env ty     `thenM` \ new_ty ->
 727     zonkPats env pats           `thenM` \ (new_pats, ids) ->
 728     returnM (PArrPat new_pats new_ty, ids)
 729
 730 zonkPat env (TuplePat pats boxed)
 731   = zonkPats env pats                   `thenM` \ (new_pats, ids) ->
 732     returnM (TuplePat new_pats boxed, ids)
 733
 734 zonkPat env (ConPatOut n stuff ty tvs dicts)
 735   = zonkTcTypeToType env ty             `thenM` \ new_ty ->
 736     mappM zonkTcTyVarToTyVar tvs        `thenM` \ new_tvs ->
 737     zonkIdBndrs env dicts               `thenM` \ new_dicts ->
 738     let
 739         env1 = extendZonkEnv env new_dicts
 740     in
 741     zonkConStuff env stuff              `thenM` \ (new_stuff, ids) ->
 742     returnM (ConPatOut n new_stuff new_ty new_tvs new_dicts,
 743                  listToBag new_dicts `unionBags` ids)
 744
 745 zonkPat env (LitPat lit) = returnM (LitPat lit, emptyBag)
 746
 747 zonkPat env (SigPatOut pat ty expr)
 748   = zonkPat env pat             `thenM` \ (new_pat, ids) ->
 749     zonkTcTypeToType env ty     `thenM` \ new_ty  ->
 750     zonkExpr env expr           `thenM` \ new_expr ->
 751     returnM (SigPatOut new_pat new_ty new_expr, ids)
 752
 753 zonkPat env (NPatOut lit ty expr)
 754   = zonkTcTypeToType env ty     `thenM` \ new_ty   ->
 755     zonkExpr env expr           `thenM` \ new_expr ->
 756     returnM (NPatOut lit new_ty new_expr, emptyBag)
 757
 758 zonkPat env (NPlusKPatOut n k e1 e2)
 759   = zonkIdBndr env n            `thenM` \ new_n ->
 760     zonkExpr env e1                     `thenM` \ new_e1 ->
 761     zonkExpr env e2                     `thenM` \ new_e2 ->
 762     returnM (NPlusKPatOut new_n k new_e1 new_e2, unitBag new_n)
 763
 764 zonkPat env (DictPat ds ms)
 765   = zonkIdBndrs env ds      `thenM` \ new_ds ->
 766     zonkIdBndrs env ms     `thenM` \ new_ms ->
 767     returnM (DictPat new_ds new_ms,
 768                  listToBag new_ds `unionBags` listToBag new_ms)
 769
 770 ---------------------------
 771 zonkConStuff env (PrefixCon pats)
 772   = zonkPats env pats           `thenM` \ (new_pats, ids) ->
 773     returnM (PrefixCon new_pats, ids)
 774
 775 zonkConStuff env (InfixCon p1 p2)
 776   = zonkPat env p1              `thenM` \ (new_p1, ids1) ->
 777     zonkPat env p2              `thenM` \ (new_p2, ids2) ->
 778     returnM (InfixCon new_p1 new_p2, ids1 `unionBags` ids2)
 779
 780 zonkConStuff env (RecCon rpats)
 781   = mapAndUnzipM zonk_rpat rpats        `thenM` \ (new_rpats, ids_s) ->
 782     returnM (RecCon new_rpats, unionManyBags ids_s)
 783   where
 784     zonk_rpat (f, pat)
 785       = zonkPat env pat         `thenM` \ (new_pat, ids) ->
 786         returnM ((f, new_pat), ids)
 787
 788 ---------------------------
 789 zonkPats env []
 790   = returnM ([], emptyBag)
 791
 792 zonkPats env (pat:pats)
 793   = zonkPat env pat     `thenM` \ (pat',  ids1) ->
 794     zonkPats env pats   `thenM` \ (pats', ids2) ->
 795     returnM (pat':pats', ids1 `unionBags` ids2)
 796 \end{code}
 797
 798 %************************************************************************
 799 %*                                                                      *
 800 \subsection[BackSubst-Foreign]{Foreign exports}
 801 %*                                                                      *
 802 %************************************************************************
 803
 804
 805 \begin{code}
 806 zonkForeignExports :: ZonkEnv -> [TcForeignDecl] -> TcM [TypecheckedForeignDecl]
 807 zonkForeignExports env ls = mappM (zonkForeignExport env) ls
 808
 809 zonkForeignExport :: ZonkEnv -> TcForeignDecl -> TcM (TypecheckedForeignDecl)
 810 zonkForeignExport env (ForeignExport i hs_ty spec isDeprec src_loc) =
 811    returnM (ForeignExport (zonkIdOcc env i) undefined spec isDeprec src_loc)
 812 \end{code}
 813
 814 \begin{code}
 815 zonkRules :: ZonkEnv -> [TcRuleDecl] -> TcM [TypecheckedRuleDecl]
 816 zonkRules env rs = mappM (zonkRule env) rs
 817
 818 zonkRule env (HsRule name act vars lhs rhs loc)
 819   = mappM zonk_bndr vars                `thenM` \ new_bndrs ->
 820     newMutVar emptyVarSet               `thenM` \ unbound_tv_set ->
 821     let
 822         env_rhs = extendZonkEnv env (filter isId new_bndrs)
 823         -- Type variables don't need an envt
 824         -- They are bound through the mutable mechanism
 825
 826         env_lhs = setZonkType env_rhs (zonkTypeCollecting unbound_tv_set)
 827         -- We need to gather the type variables mentioned on the LHS so we can
 828         -- quantify over them.  Example:
 829         --   data T a = C
 830         --
 831         --   foo :: T a -> Int
 832         --   foo C = 1
 833         --
 834         --   {-# RULES "myrule"  foo C = 1 #-}
 835         --
 836         -- After type checking the LHS becomes (foo a (C a))
 837         -- and we do not want to zap the unbound tyvar 'a' to (), because
 838         -- that limits the applicability of the rule.  Instead, we
 839         -- want to quantify over it!
 840         --
 841         -- It's easiest to find the free tyvars here. Attempts to do so earlier
 842         -- are tiresome, because (a) the data type is big and (b) finding the
 843         -- free type vars of an expression is necessarily monadic operation.
 844         --      (consider /\a -> f @ b, where b is side-effected to a)
 845     in
 846     zonkExpr env_lhs lhs                `thenM` \ new_lhs ->
 847     zonkExpr env_rhs rhs                `thenM` \ new_rhs ->
 848
 849     readMutVar unbound_tv_set           `thenM` \ unbound_tvs ->
 850     let
 851         final_bndrs = map RuleBndr (varSetElems unbound_tvs ++ new_bndrs)
 852         -- I hate this map RuleBndr stuff
 853     in
 854     returnM (HsRule name act final_bndrs new_lhs new_rhs loc)
 855   where
 856    zonk_bndr (RuleBndr v)
 857         | isId v    = zonkIdBndr env v
 858         | otherwise = zonkTcTyVarToTyVar v
 859
 860 zonkRule env (IfaceRuleOut fun rule)
 861   = returnM (IfaceRuleOut (zonkIdOcc env fun) rule)
 862 \end{code}
 863
 864
 865 %************************************************************************
 866 %*                                                                      *
 867 \subsection[BackSubst-Foreign]{Foreign exports}
 868 %*                                                                      *
 869 %************************************************************************
 870
 871 \begin{code}
 872 zonkTcTypeToType :: ZonkEnv -> TcType -> TcM Type
 873 zonkTcTypeToType (ZonkEnv zonk_ty _) ty = zonk_ty ty
 874
 875 zonkTypeCollecting :: TcRef TyVarSet -> TcType -> TcM Type
 876 -- This variant collects unbound type variables in a mutable variable
 877 zonkTypeCollecting unbound_tv_set
 878   = zonkType zonk_unbound_tyvar
 879   where
 880     zonk_unbound_tyvar tv
 881         = zonkTcTyVarToTyVar tv                                 `thenM` \ tv' ->
 882           readMutVar unbound_tv_set                             `thenM` \ tv_set ->
 883           writeMutVar unbound_tv_set (extendVarSet tv_set tv')  `thenM_`
 884           return (mkTyVarTy tv')
 885
 886 zonkTypeZapping :: TcType -> TcM Type
 887 -- This variant is used for everything except the LHS of rules
 888 -- It zaps unbound type variables to (), or some other arbitrary type
 889 zonkTypeZapping ty
 890   = zonkType zonk_unbound_tyvar ty
 891   where
 892         -- Zonk a mutable but unbound type variable to an arbitrary type
 893         -- We know it's unbound even though we don't carry an environment,
 894         -- because at the binding site for a type variable we bind the
 895         -- mutable tyvar to a fresh immutable one.  So the mutable store
 896         -- plays the role of an environment.  If we come across a mutable
 897         -- type variable that isn't so bound, it must be completely free.
 898     zonk_unbound_tyvar tv = putTcTyVar tv (mkArbitraryType tv)
 899
 900
 901 -- When the type checker finds a type variable with no binding,
 902 -- which means it can be instantiated with an arbitrary type, it
 903 -- usually instantiates it to Void.  Eg.
 904 --
 905 --      length []
 906 -- ===>
 907 --      length Void (Nil Void)
 908 --
 909 -- But in really obscure programs, the type variable might have
 910 -- a kind other than *, so we need to invent a suitably-kinded type.
 911 --
 912 -- This commit uses
 913 --      Void for kind *
 914 --      List for kind *->*
 915 --      Tuple for kind *->...*->*
 916 --
 917 -- which deals with most cases.  (Previously, it only dealt with
 918 -- kind *.)
 919 --
 920 -- In the other cases, it just makes up a TyCon with a suitable
 921 -- kind.  If this gets into an interface file, anyone reading that
 922 -- file won't understand it.  This is fixable (by making the client
 923 -- of the interface file make up a TyCon too) but it is tiresome and
 924 -- never happens, so I am leaving it
 925
 926 mkArbitraryType :: TcTyVar -> Type
 927 -- Make up an arbitrary type whose kind is the same as the tyvar.
 928 -- We'll use this to instantiate the (unbound) tyvar.
 929 mkArbitraryType tv
 930   | isAnyTypeKind kind = voidTy         -- The vastly common case
 931   | otherwise          = mkTyConApp tycon []
 932   where
 933     kind       = tyVarKind tv
 934     (args,res) = Type.splitFunTys kind  -- Kinds are simple; use Type.splitFunTys
 935
 936     tycon | kind `eqKind` tyConKind listTyCon   -- *->*
 937           = listTyCon                           -- No tuples this size
 938
 939           | all isTypeKind args && isTypeKind res
 940           = tupleTyCon Boxed (length args)      -- *-> ... ->*->*
 941
 942           | otherwise
 943           = pprTrace "Urk! Inventing strangely-kinded void TyCon:" (ppr tc_name $$ ppr kind) $
 944             mkPrimTyCon tc_name kind 0 [] VoidRep
 945                 -- Same name as the tyvar, apart from making it start with a colon (sigh)
 946                 -- I dread to think what will happen if this gets out into an
 947                 -- interface file.  Catastrophe likely.  Major sigh.
 948
 949     tc_name = mkInternalName (getUnique tv) (mkDerivedTyConOcc (getOccName tv)) noSrcLoc
 950 \end{code}