compiler/deSugar/DsExpr.lhs

   1 %
   2 % (c) The University of Glasgow 2006
   3 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   4 %
   5
   6 Desugaring exporessions.
   7
   8 \begin{code}
   9 module DsExpr ( dsExpr, dsLExpr, dsLocalBinds, dsValBinds, dsLit ) where
  10
  11 #include "HsVersions.h"
  12
  13
  14 import Match
  15 import MatchLit
  16 import DsBinds
  17 import DsGRHSs
  18 import DsListComp
  19 import DsUtils
  20 import DsArrows
  21 import DsMonad
  22
  23 #ifdef GHCI
  24 import PrelNames
  25         -- Template Haskell stuff iff bootstrapped
  26 import DsMeta
  27 #endif
  28
  29 import HsSyn
  30 import TcHsSyn
  31
  32 -- NB: The desugarer, which straddles the source and Core worlds, sometimes
  33 --     needs to see source types
  34 import TcType
  35 import Type
  36 import CoreSyn
  37 import CoreUtils
  38
  39 import CostCentre
  40 import Id
  41 import PrelInfo
  42 import DataCon
  43 import TyCon
  44 import TysWiredIn
  45 import BasicTypes
  46 import PrelNames
  47 import SrcLoc
  48 import Util
  49 import Bag
  50 import Outputable
  51 import FastString
  52 \end{code}
  53
  54
  55 %************************************************************************
  56 %*                                                                      *
  57                 dsLocalBinds, dsValBinds
  58 %*                                                                      *
  59 %************************************************************************
  60
  61 \begin{code}
  62 dsLocalBinds :: HsLocalBinds Id -> CoreExpr -> DsM CoreExpr
  63 dsLocalBinds EmptyLocalBinds    body = return body
  64 dsLocalBinds (HsValBinds binds) body = dsValBinds binds body
  65 dsLocalBinds (HsIPBinds binds)  body = dsIPBinds  binds body
  66
  67 -------------------------
  68 dsValBinds :: HsValBinds Id -> CoreExpr -> DsM CoreExpr
  69 dsValBinds (ValBindsOut binds _) body = foldrDs ds_val_bind body binds
  70
  71 -------------------------
  72 dsIPBinds (IPBinds ip_binds dict_binds) body
  73   = do  { prs <- dsLHsBinds dict_binds
  74         ; let inner = Let (Rec prs) body
  75                 -- The dict bindings may not be in
  76                 -- dependency order; hence Rec
  77         ; foldrDs ds_ip_bind inner ip_binds }
  78   where
  79     ds_ip_bind (L _ (IPBind n e)) body
  80       = dsLExpr e       `thenDs` \ e' ->
  81         returnDs (Let (NonRec (ipNameName n) e') body)
  82
  83 -------------------------
  84 ds_val_bind :: (RecFlag, LHsBinds Id) -> CoreExpr -> DsM CoreExpr
  85 -- Special case for bindings which bind unlifted variables
  86 -- We need to do a case right away, rather than building
  87 -- a tuple and doing selections.
  88 -- Silently ignore INLINE and SPECIALISE pragmas...
  89 ds_val_bind (NonRecursive, hsbinds) body
  90   | [L _ (AbsBinds [] [] exports binds)] <- bagToList hsbinds,
  91     (L loc bind : null_binds) <- bagToList binds,
  92     isBangHsBind bind
  93     || isUnboxedTupleBind bind
  94     || or [isUnLiftedType (idType g) | (_, g, _, _) <- exports]
  95   = let
  96       body_w_exports                  = foldr bind_export body exports
  97       bind_export (tvs, g, l, _) body = ASSERT( null tvs )
  98                                         bindNonRec g (Var l) body
  99     in
 100     ASSERT (null null_binds)
 101         -- Non-recursive, non-overloaded bindings only come in ones
 102         -- ToDo: in some bizarre case it's conceivable that there
 103         --       could be dict binds in the 'binds'.  (See the notes
 104         --       below.  Then pattern-match would fail.  Urk.)
 105     putSrcSpanDs loc    $
 106     case bind of
 107       FunBind { fun_id = L _ fun, fun_matches = matches, fun_co_fn = co_fn, fun_tick = tick }
 108         -> matchWrapper (FunRhs (idName fun)) matches           `thenDs` \ (args, rhs) ->
 109            ASSERT( null args )  -- Functions aren't lifted
 110            ASSERT( isIdHsWrapper co_fn )
 111            mkOptTickBox tick rhs                                `thenDs` \ rhs' ->
 112            returnDs (bindNonRec fun rhs' body_w_exports)
 113
 114       PatBind {pat_lhs = pat, pat_rhs = grhss, pat_rhs_ty = ty }
 115         ->      -- let C x# y# = rhs in body
 116                 -- ==> case rhs of C x# y# -> body
 117            putSrcSpanDs loc                     $
 118            do { rhs <- dsGuarded grhss ty
 119               ; let upat = unLoc pat
 120                     eqn = EqnInfo { eqn_pats = [upat],
 121                                     eqn_rhs = cantFailMatchResult body_w_exports }
 122               ; var    <- selectMatchVar upat
 123               ; result <- matchEquations PatBindRhs [var] [eqn] (exprType body)
 124               ; return (scrungleMatch var rhs result) }
 125
 126       other -> pprPanic "dsLet: unlifted" (pprLHsBinds hsbinds $$ ppr body)
 127
 128
 129 -- Ordinary case for bindings; none should be unlifted
 130 ds_val_bind (is_rec, binds) body
 131   = do  { prs <- dsLHsBinds binds
 132         ; ASSERT( not (any (isUnLiftedType . idType . fst) prs) )
 133           case prs of
 134             []    -> return body
 135             other -> return (Let (Rec prs) body) }
 136         -- Use a Rec regardless of is_rec.
 137         -- Why? Because it allows the binds to be all
 138         -- mixed up, which is what happens in one rare case
 139         -- Namely, for an AbsBind with no tyvars and no dicts,
 140         --         but which does have dictionary bindings.
 141         -- See notes with TcSimplify.inferLoop [NO TYVARS]
 142         -- It turned out that wrapping a Rec here was the easiest solution
 143         --
 144         -- NB The previous case dealt with unlifted bindings, so we
 145         --    only have to deal with lifted ones now; so Rec is ok
 146
 147 isUnboxedTupleBind :: HsBind Id -> Bool
 148 isUnboxedTupleBind (PatBind { pat_rhs_ty = ty }) = isUnboxedTupleType ty
 149 isUnboxedTupleBind other                         = False
 150
 151 scrungleMatch :: Id -> CoreExpr -> CoreExpr -> CoreExpr
 152 -- Returns something like (let var = scrut in body)
 153 -- but if var is an unboxed-tuple type, it inlines it in a fragile way
 154 -- Special case to handle unboxed tuple patterns; they can't appear nested
 155 -- The idea is that
 156 --      case e of (# p1, p2 #) -> rhs
 157 -- should desugar to
 158 --      case e of (# x1, x2 #) -> ... match p1, p2 ...
 159 -- NOT
 160 --      let x = e in case x of ....
 161 --
 162 -- But there may be a big
 163 --      let fail = ... in case e of ...
 164 -- wrapping the whole case, which complicates matters slightly
 165 -- It all seems a bit fragile.  Test is dsrun013.
 166
 167 scrungleMatch var scrut body
 168   | isUnboxedTupleType (idType var) = scrungle body
 169   | otherwise                       = bindNonRec var scrut body
 170   where
 171     scrungle (Case (Var x) bndr ty alts)
 172                     | x == var = Case scrut bndr ty alts
 173     scrungle (Let binds body)  = Let binds (scrungle body)
 174     scrungle other = panic ("scrungleMatch: tuple pattern:\n" ++ showSDoc (ppr other))
 175
 176 \end{code}
 177
 178 %************************************************************************
 179 %*                                                                      *
 180 \subsection[DsExpr-vars-and-cons]{Variables, constructors, literals}
 181 %*                                                                      *
 182 %************************************************************************
 183
 184 \begin{code}
 185 dsLExpr :: LHsExpr Id -> DsM CoreExpr
 186
 187 dsLExpr (L loc e) = putSrcSpanDs loc $ dsExpr e
 188
 189 dsExpr :: HsExpr Id -> DsM CoreExpr
 190 dsExpr (HsPar e)              = dsLExpr e
 191 dsExpr (ExprWithTySigOut e _) = dsLExpr e
 192 dsExpr (HsVar var)            = returnDs (Var var)
 193 dsExpr (HsIPVar ip)           = returnDs (Var (ipNameName ip))
 194 dsExpr (HsLit lit)            = dsLit lit
 195 dsExpr (HsOverLit lit)        = dsOverLit lit
 196 dsExpr (HsWrap co_fn e)       = dsCoercion co_fn (dsExpr e)
 197
 198 dsExpr (NegApp expr neg_expr)
 199   = do  { core_expr <- dsLExpr expr
 200         ; core_neg  <- dsExpr neg_expr
 201         ; return (core_neg `App` core_expr) }
 202
 203 dsExpr expr@(HsLam a_Match)
 204   = matchWrapper LambdaExpr a_Match     `thenDs` \ (binders, matching_code) ->
 205     returnDs (mkLams binders matching_code)
 206
 207 dsExpr expr@(HsApp fun arg)
 208   = dsLExpr fun         `thenDs` \ core_fun ->
 209     dsLExpr arg         `thenDs` \ core_arg ->
 210     returnDs (core_fun `mkDsApp` core_arg)
 211 \end{code}
 212
 213 Operator sections.  At first it looks as if we can convert
 214 \begin{verbatim}
 215         (expr op)
 216 \end{verbatim}
 217 to
 218 \begin{verbatim}
 219         \x -> op expr x
 220 \end{verbatim}
 221
 222 But no!  expr might be a redex, and we can lose laziness badly this
 223 way.  Consider
 224 \begin{verbatim}
 225         map (expr op) xs
 226 \end{verbatim}
 227 for example.  So we convert instead to
 228 \begin{verbatim}
 229         let y = expr in \x -> op y x
 230 \end{verbatim}
 231 If \tr{expr} is actually just a variable, say, then the simplifier
 232 will sort it out.
 233
 234 \begin{code}
 235 dsExpr (OpApp e1 op _ e2)
 236   = dsLExpr op                                          `thenDs` \ core_op ->
 237     -- for the type of y, we need the type of op's 2nd argument
 238     dsLExpr e1                          `thenDs` \ x_core ->
 239     dsLExpr e2                          `thenDs` \ y_core ->
 240     returnDs (mkDsApps core_op [x_core, y_core])
 241
 242 dsExpr (SectionL expr op)       -- Desugar (e !) to ((!) e)
 243   = dsLExpr op                          `thenDs` \ core_op ->
 244     dsLExpr expr                        `thenDs` \ x_core ->
 245     returnDs (mkDsApp core_op x_core)
 246
 247 -- dsLExpr (SectionR op expr)   -- \ x -> op x expr
 248 dsExpr (SectionR op expr)
 249   = dsLExpr op                  `thenDs` \ core_op ->
 250     -- for the type of x, we need the type of op's 2nd argument
 251     let
 252         (x_ty:y_ty:_, _) = splitFunTys (exprType core_op)
 253         -- See comment with SectionL
 254     in
 255     dsLExpr expr                                `thenDs` \ y_core ->
 256     newSysLocalDs x_ty                  `thenDs` \ x_id ->
 257     newSysLocalDs y_ty                  `thenDs` \ y_id ->
 258
 259     returnDs (bindNonRec y_id y_core $
 260               Lam x_id (mkDsApps core_op [Var x_id, Var y_id]))
 261
 262 dsExpr (HsSCC cc expr)
 263   = dsLExpr expr                        `thenDs` \ core_expr ->
 264     getModuleDs                 `thenDs` \ mod_name ->
 265     returnDs (Note (SCC (mkUserCC cc mod_name)) core_expr)
 266
 267
 268 -- hdaume: core annotation
 269
 270 dsExpr (HsCoreAnn fs expr)
 271   = dsLExpr expr        `thenDs` \ core_expr ->
 272     returnDs (Note (CoreNote $ unpackFS fs) core_expr)
 273
 274 dsExpr (HsCase discrim matches)
 275   = dsLExpr discrim                     `thenDs` \ core_discrim ->
 276     matchWrapper CaseAlt matches        `thenDs` \ ([discrim_var], matching_code) ->
 277     returnDs (scrungleMatch discrim_var core_discrim matching_code)
 278
 279 -- Pepe: The binds are in scope in the body but NOT in the binding group
 280 --       This is to avoid silliness in breakpoints
 281 dsExpr (HsLet binds body)
 282   = (bindLocalsDs (map unLoc $ collectLocalBinders binds) $
 283      dsLExpr body) `thenDs` \ body' ->
 284     dsLocalBinds binds body'
 285
 286 -- We need the `ListComp' form to use `deListComp' (rather than the "do" form)
 287 -- because the interpretation of `stmts' depends on what sort of thing it is.
 288 --
 289 dsExpr (HsDo ListComp stmts body result_ty)
 290   =     -- Special case for list comprehensions
 291     dsListComp stmts body elt_ty
 292   where
 293     [elt_ty] = tcTyConAppArgs result_ty
 294
 295 dsExpr (HsDo DoExpr stmts body result_ty)
 296   = dsDo stmts body result_ty
 297
 298 dsExpr (HsDo (MDoExpr tbl) stmts body result_ty)
 299   = dsMDo tbl stmts body result_ty
 300
 301 dsExpr (HsDo PArrComp stmts body result_ty)
 302   =     -- Special case for array comprehensions
 303     dsPArrComp (map unLoc stmts) body elt_ty
 304   where
 305     [elt_ty] = tcTyConAppArgs result_ty
 306
 307 dsExpr (HsIf guard_expr then_expr else_expr)
 308   = dsLExpr guard_expr  `thenDs` \ core_guard ->
 309     dsLExpr then_expr   `thenDs` \ core_then ->
 310     dsLExpr else_expr   `thenDs` \ core_else ->
 311     returnDs (mkIfThenElse core_guard core_then core_else)
 312 \end{code}
 313
 314
 315 \noindent
 316 \underline{\bf Various data construction things}
 317 %              ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 318 \begin{code}
 319 dsExpr (ExplicitList ty xs)
 320   = go xs
 321   where
 322     go []     = returnDs (mkNilExpr ty)
 323     go (x:xs) = dsLExpr x                               `thenDs` \ core_x ->
 324                 go xs                                   `thenDs` \ core_xs ->
 325                 returnDs (mkConsExpr ty core_x core_xs)
 326
 327 -- we create a list from the array elements and convert them into a list using
 328 -- `PrelPArr.toP'
 329 --
 330 --  * the main disadvantage to this scheme is that `toP' traverses the list
 331 --   twice: once to determine the length and a second time to put to elements
 332 --   into the array; this inefficiency could be avoided by exposing some of
 333 --   the innards of `PrelPArr' to the compiler (ie, have a `PrelPArrBase') so
 334 --   that we can exploit the fact that we already know the length of the array
 335 --   here at compile time
 336 --
 337 dsExpr (ExplicitPArr ty xs)
 338   = dsLookupGlobalId toPName                            `thenDs` \toP      ->
 339     dsExpr (ExplicitList ty xs)                         `thenDs` \coreList ->
 340     returnDs (mkApps (Var toP) [Type ty, coreList])
 341
 342 dsExpr (ExplicitTuple expr_list boxity)
 343   = mappM dsLExpr expr_list       `thenDs` \ core_exprs  ->
 344     returnDs (mkConApp (tupleCon boxity (length expr_list))
 345                        (map (Type .  exprType) core_exprs ++ core_exprs))
 346
 347 dsExpr (ArithSeq expr (From from))
 348   = dsExpr expr           `thenDs` \ expr2 ->
 349     dsLExpr from          `thenDs` \ from2 ->
 350     returnDs (App expr2 from2)
 351
 352 dsExpr (ArithSeq expr (FromTo from two))
 353   = dsExpr expr           `thenDs` \ expr2 ->
 354     dsLExpr from          `thenDs` \ from2 ->
 355     dsLExpr two           `thenDs` \ two2 ->
 356     returnDs (mkApps expr2 [from2, two2])
 357
 358 dsExpr (ArithSeq expr (FromThen from thn))
 359   = dsExpr expr           `thenDs` \ expr2 ->
 360     dsLExpr from          `thenDs` \ from2 ->
 361     dsLExpr thn           `thenDs` \ thn2 ->
 362     returnDs (mkApps expr2 [from2, thn2])
 363
 364 dsExpr (ArithSeq expr (FromThenTo from thn two))
 365   = dsExpr expr           `thenDs` \ expr2 ->
 366     dsLExpr from          `thenDs` \ from2 ->
 367     dsLExpr thn           `thenDs` \ thn2 ->
 368     dsLExpr two           `thenDs` \ two2 ->
 369     returnDs (mkApps expr2 [from2, thn2, two2])
 370
 371 dsExpr (PArrSeq expr (FromTo from two))
 372   = dsExpr expr           `thenDs` \ expr2 ->
 373     dsLExpr from          `thenDs` \ from2 ->
 374     dsLExpr two           `thenDs` \ two2 ->
 375     returnDs (mkApps expr2 [from2, two2])
 376
 377 dsExpr (PArrSeq expr (FromThenTo from thn two))
 378   = dsExpr expr           `thenDs` \ expr2 ->
 379     dsLExpr from          `thenDs` \ from2 ->
 380     dsLExpr thn           `thenDs` \ thn2 ->
 381     dsLExpr two           `thenDs` \ two2 ->
 382     returnDs (mkApps expr2 [from2, thn2, two2])
 383
 384 dsExpr (PArrSeq expr _)
 385   = panic "DsExpr.dsExpr: Infinite parallel array!"
 386     -- the parser shouldn't have generated it and the renamer and typechecker
 387     -- shouldn't have let it through
 388 \end{code}
 389
 390 \noindent
 391 \underline{\bf Record construction and update}
 392 %              ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 393 For record construction we do this (assuming T has three arguments)
 394 \begin{verbatim}
 395         T { op2 = e }
 396 ==>
 397         let err = /\a -> recConErr a
 398         T (recConErr t1 "M.lhs/230/op1")
 399           e
 400           (recConErr t1 "M.lhs/230/op3")
 401 \end{verbatim}
 402 @recConErr@ then converts its arugment string into a proper message
 403 before printing it as
 404 \begin{verbatim}
 405         M.lhs, line 230: missing field op1 was evaluated
 406 \end{verbatim}
 407
 408 We also handle @C{}@ as valid construction syntax for an unlabelled
 409 constructor @C@, setting all of @C@'s fields to bottom.
 410
 411 \begin{code}
 412 dsExpr (RecordCon (L _ data_con_id) con_expr (HsRecordBinds rbinds))
 413   = dsExpr con_expr     `thenDs` \ con_expr' ->
 414     let
 415         (arg_tys, _) = tcSplitFunTys (exprType con_expr')
 416         -- A newtype in the corner should be opaque;
 417         -- hence TcType.tcSplitFunTys
 418
 419         mk_arg (arg_ty, lbl)    -- Selector id has the field label as its name
 420           = case [rhs | (L _ sel_id, rhs) <- rbinds, lbl == idName sel_id] of
 421               (rhs:rhss) -> ASSERT( null rhss )
 422                             dsLExpr rhs
 423               []         -> mkErrorAppDs rEC_CON_ERROR_ID arg_ty (showSDoc (ppr lbl))
 424         unlabelled_bottom arg_ty = mkErrorAppDs rEC_CON_ERROR_ID arg_ty ""
 425
 426         labels = dataConFieldLabels (idDataCon data_con_id)
 427         -- The data_con_id is guaranteed to be the wrapper id of the constructor
 428     in
 429
 430     (if null labels
 431         then mappM unlabelled_bottom arg_tys
 432         else mappM mk_arg (zipEqual "dsExpr:RecordCon" arg_tys labels))
 433         `thenDs` \ con_args ->
 434
 435     returnDs (mkApps con_expr' con_args)
 436 \end{code}
 437
 438 Record update is a little harder. Suppose we have the decl:
 439 \begin{verbatim}
 440         data T = T1 {op1, op2, op3 :: Int}
 441                | T2 {op4, op2 :: Int}
 442                | T3
 443 \end{verbatim}
 444 Then we translate as follows:
 445 \begin{verbatim}
 446         r { op2 = e }
 447 ===>
 448         let op2 = e in
 449         case r of
 450           T1 op1 _ op3 -> T1 op1 op2 op3
 451           T2 op4 _     -> T2 op4 op2
 452           other        -> recUpdError "M.lhs/230"
 453 \end{verbatim}
 454 It's important that we use the constructor Ids for @T1@, @T2@ etc on the
 455 RHSs, and do not generate a Core constructor application directly, because the constructor
 456 might do some argument-evaluation first; and may have to throw away some
 457 dictionaries.
 458
 459 \begin{code}
 460 dsExpr (RecordUpd record_expr (HsRecordBinds []) record_in_ty record_out_ty)
 461   = dsLExpr record_expr
 462
 463 dsExpr expr@(RecordUpd record_expr (HsRecordBinds rbinds) record_in_ty record_out_ty)
 464   = dsLExpr record_expr         `thenDs` \ record_expr' ->
 465
 466         -- Desugar the rbinds, and generate let-bindings if
 467         -- necessary so that we don't lose sharing
 468
 469     let
 470         in_inst_tys  = tcTyConAppArgs record_in_ty      -- Newtype opaque
 471         out_inst_tys = tcTyConAppArgs record_out_ty     -- Newtype opaque
 472         in_out_ty    = mkFunTy record_in_ty record_out_ty
 473
 474         mk_val_arg field old_arg_id
 475           = case [rhs | (L _ sel_id, rhs) <- rbinds, field == idName sel_id] of
 476               (rhs:rest) -> ASSERT(null rest) rhs
 477               []         -> nlHsVar old_arg_id
 478
 479         mk_alt con
 480           = ASSERT( isVanillaDataCon con )
 481             newSysLocalsDs (dataConInstOrigArgTys con in_inst_tys) `thenDs` \ arg_ids ->
 482                 -- This call to dataConInstOrigArgTys won't work for existentials
 483                 -- but existentials don't have record types anyway
 484             let
 485                 val_args = zipWithEqual "dsExpr:RecordUpd" mk_val_arg
 486                                         (dataConFieldLabels con) arg_ids
 487                 rhs = foldl (\a b -> nlHsApp a b)
 488                             (nlHsTyApp (dataConWrapId con) out_inst_tys)
 489                             val_args
 490             in
 491             returnDs (mkSimpleMatch [mkPrefixConPat con (map nlVarPat arg_ids) record_in_ty] rhs)
 492     in
 493         -- Record stuff doesn't work for existentials
 494         -- The type checker checks for this, but we need
 495         -- worry only about the constructors that are to be updated
 496     ASSERT2( all isVanillaDataCon cons_to_upd, ppr expr )
 497
 498         -- It's important to generate the match with matchWrapper,
 499         -- and the right hand sides with applications of the wrapper Id
 500         -- so that everything works when we are doing fancy unboxing on the
 501         -- constructor aguments.
 502     mappM mk_alt cons_to_upd                            `thenDs` \ alts ->
 503     matchWrapper RecUpd (MatchGroup alts in_out_ty)     `thenDs` \ ([discrim_var], matching_code) ->
 504
 505     returnDs (bindNonRec discrim_var record_expr' matching_code)
 506
 507   where
 508     updated_fields :: [FieldLabel]
 509     updated_fields = [ idName sel_id | (L _ sel_id,_) <- rbinds]
 510
 511         -- Get the type constructor from the record_in_ty
 512         -- so that we are sure it'll have all its DataCons
 513         -- (In GHCI, it's possible that some TyCons may not have all
 514         --  their constructors, in a module-loop situation.)
 515     tycon       = tcTyConAppTyCon record_in_ty
 516     data_cons   = tyConDataCons tycon
 517     cons_to_upd = filter has_all_fields data_cons
 518
 519     has_all_fields :: DataCon -> Bool
 520     has_all_fields con_id
 521       = all (`elem` con_fields) updated_fields
 522       where
 523         con_fields = dataConFieldLabels con_id
 524 \end{code}
 525
 526 Here is where we desugar the Template Haskell brackets and escapes
 527
 528 \begin{code}
 529 -- Template Haskell stuff
 530
 531 #ifdef GHCI     /* Only if bootstrapping */
 532 dsExpr (HsBracketOut x ps) = dsBracket x ps
 533 dsExpr (HsSpliceE s)       = pprPanic "dsExpr:splice" (ppr s)
 534 #endif
 535
 536 -- Arrow notation extension
 537 dsExpr (HsProc pat cmd) = dsProcExpr pat cmd
 538 \end{code}
 539
 540 Hpc Support
 541
 542 \begin{code}
 543 dsExpr (HsTick ix e) = do
 544   e' <- dsLExpr e
 545   mkTickBox ix e'
 546
 547 -- There is a problem here. The then and else branches
 548 -- have no free variables, so they are open to lifting.
 549 -- We need someway of stopping this.
 550 -- This will make no difference to binary coverage
 551 -- (did you go here: YES or NO), but will effect accurate
 552 -- tick counting.
 553
 554 dsExpr (HsBinTick ixT ixF e) = do
 555   e2 <- dsLExpr e
 556   do { ASSERT(exprType e2 `coreEqType` boolTy)
 557        mkBinaryTickBox ixT ixF e2
 558      }
 559 \end{code}
 560
 561 \begin{code}
 562
 563 #ifdef DEBUG
 564 -- HsSyn constructs that just shouldn't be here:
 565 dsExpr (ExprWithTySig _ _)  = panic "dsExpr:ExprWithTySig"
 566 #endif
 567
 568 \end{code}
 569
 570 %--------------------------------------------------------------------
 571
 572 Desugar 'do' and 'mdo' expressions (NOT list comprehensions, they're
 573 handled in DsListComp).  Basically does the translation given in the
 574 Haskell 98 report:
 575
 576 \begin{code}
 577 dsDo    :: [LStmt Id]
 578         -> LHsExpr Id
 579         -> Type                 -- Type of the whole expression
 580         -> DsM CoreExpr
 581
 582 dsDo stmts body result_ty
 583   = go (map unLoc stmts)
 584   where
 585     go [] = dsLExpr body
 586
 587     go (ExprStmt rhs then_expr _ : stmts)
 588       = do { rhs2 <- dsLExpr rhs
 589            ; then_expr2 <- dsExpr then_expr
 590            ; rest <- go stmts
 591            ; returnDs (mkApps then_expr2 [rhs2, rest]) }
 592
 593     go (LetStmt binds : stmts)
 594       = do { rest <- bindLocalsDs (map unLoc$ collectLocalBinders binds) $
 595                       go stmts
 596            ; dsLocalBinds binds rest }
 597
 598     -- Notice how due to the placement of bindLocals, binders in this stmt
 599     -- are available in posterior stmts but Not in this one rhs.
 600     -- This is to avoid silliness in breakpoints
 601     go (BindStmt pat rhs bind_op fail_op : stmts)
 602       =
 603        do { body  <- bindLocalsDs (collectPatBinders pat) $ go stmts
 604            ; var   <- selectSimpleMatchVarL pat
 605            ; match <- matchSinglePat (Var var) (StmtCtxt DoExpr) pat
 606                                   result_ty (cantFailMatchResult body)
 607            ; match_code <- handle_failure pat match fail_op
 608            ; rhs'       <- dsLExpr rhs
 609            ; bind_op'   <- dsExpr bind_op
 610            ; returnDs (mkApps bind_op' [rhs', Lam var match_code]) }
 611
 612     -- In a do expression, pattern-match failure just calls
 613     -- the monadic 'fail' rather than throwing an exception
 614     handle_failure pat match fail_op
 615       | matchCanFail match
 616       = do { fail_op' <- dsExpr fail_op
 617            ; fail_msg <- mkStringExpr (mk_fail_msg pat)
 618            ; extractMatchResult match (App fail_op' fail_msg) }
 619       | otherwise
 620       = extractMatchResult match (error "It can't fail")
 621
 622 mk_fail_msg pat = "Pattern match failure in do expression at " ++
 623                   showSDoc (ppr (getLoc pat))
 624 \end{code}
 625
 626 Translation for RecStmt's:
 627 -----------------------------
 628 We turn (RecStmt [v1,..vn] stmts) into:
 629
 630   (v1,..,vn) <- mfix (\~(v1,..vn). do stmts
 631                                       return (v1,..vn))
 632
 633 \begin{code}
 634 dsMDo   :: PostTcTable
 635         -> [LStmt Id]
 636         -> LHsExpr Id
 637         -> Type                 -- Type of the whole expression
 638         -> DsM CoreExpr
 639
 640 dsMDo tbl stmts body result_ty
 641   = go (map unLoc stmts)
 642   where
 643     (m_ty, b_ty) = tcSplitAppTy result_ty       -- result_ty must be of the form (m b)
 644     mfix_id   = lookupEvidence tbl mfixName
 645     return_id = lookupEvidence tbl returnMName
 646     bind_id   = lookupEvidence tbl bindMName
 647     then_id   = lookupEvidence tbl thenMName
 648     fail_id   = lookupEvidence tbl failMName
 649     ctxt      = MDoExpr tbl
 650
 651     go [] = dsLExpr body
 652
 653     go (LetStmt binds : stmts)
 654       = do { rest <- go stmts
 655            ; dsLocalBinds binds rest }
 656
 657     go (ExprStmt rhs _ rhs_ty : stmts)
 658       = do { rhs2 <- dsLExpr rhs
 659            ; rest <- go stmts
 660            ; returnDs (mkApps (Var then_id) [Type rhs_ty, Type b_ty, rhs2, rest]) }
 661
 662     go (BindStmt pat rhs _ _ : stmts)
 663       = do { body  <- bindLocalsDs (collectPatBinders pat) $ go stmts
 664            ; var   <- selectSimpleMatchVarL pat
 665            ; match <- matchSinglePat (Var var) (StmtCtxt ctxt) pat
 666                                   result_ty (cantFailMatchResult body)
 667            ; fail_msg   <- mkStringExpr (mk_fail_msg pat)
 668            ; let fail_expr = mkApps (Var fail_id) [Type b_ty, fail_msg]
 669            ; match_code <- extractMatchResult match fail_expr
 670
 671            ; rhs'       <- dsLExpr rhs
 672            ; returnDs (mkApps (Var bind_id) [Type (hsLPatType pat), Type b_ty,
 673                                              rhs', Lam var match_code]) }
 674
 675     go (RecStmt rec_stmts later_ids rec_ids rec_rets binds : stmts)
 676       = ASSERT( length rec_ids > 0 )
 677         ASSERT( length rec_ids == length rec_rets )
 678         go (new_bind_stmt : let_stmt : stmts)
 679       where
 680         new_bind_stmt = mkBindStmt (mk_tup_pat later_pats) mfix_app
 681         let_stmt = LetStmt (HsValBinds (ValBindsOut [(Recursive, binds)] []))
 682
 683
 684                 -- Remove the later_ids that appear (without fancy coercions)
 685                 -- in rec_rets, because there's no need to knot-tie them separately
 686                 -- See Note [RecStmt] in HsExpr
 687         later_ids'   = filter (`notElem` mono_rec_ids) later_ids
 688         mono_rec_ids = [ id | HsVar id <- rec_rets ]
 689
 690         mfix_app = nlHsApp (nlHsTyApp mfix_id [tup_ty]) mfix_arg
 691         mfix_arg = noLoc $ HsLam (MatchGroup [mkSimpleMatch [mfix_pat] body]
 692                                              (mkFunTy tup_ty body_ty))
 693
 694         -- The rec_tup_pat must bind the rec_ids only; remember that the
 695         --      trimmed_laters may share the same Names
 696         -- Meanwhile, the later_pats must bind the later_vars
 697         rec_tup_pats = map mk_wild_pat later_ids' ++ map nlVarPat rec_ids
 698         later_pats   = map nlVarPat    later_ids' ++ map mk_later_pat rec_ids
 699         rets         = map nlHsVar     later_ids' ++ map noLoc rec_rets
 700
 701         mfix_pat = noLoc $ LazyPat $ mk_tup_pat rec_tup_pats
 702         body     = noLoc $ HsDo ctxt rec_stmts return_app body_ty
 703         body_ty = mkAppTy m_ty tup_ty
 704         tup_ty  = mkCoreTupTy (map idType (later_ids' ++ rec_ids))
 705                   -- mkCoreTupTy deals with singleton case
 706
 707         return_app  = nlHsApp (nlHsTyApp return_id [tup_ty])
 708                               (mk_ret_tup rets)
 709
 710         mk_wild_pat :: Id -> LPat Id
 711         mk_wild_pat v = noLoc $ WildPat $ idType v
 712
 713         mk_later_pat :: Id -> LPat Id
 714         mk_later_pat v | v `elem` later_ids' = mk_wild_pat v
 715                        | otherwise           = nlVarPat v
 716
 717         mk_tup_pat :: [LPat Id] -> LPat Id
 718         mk_tup_pat [p] = p
 719         mk_tup_pat ps  = noLoc $ mkVanillaTuplePat ps Boxed
 720
 721         mk_ret_tup :: [LHsExpr Id] -> LHsExpr Id
 722         mk_ret_tup [r] = r
 723         mk_ret_tup rs  = noLoc $ ExplicitTuple rs Boxed
 724 \end{code}