[project @ 1996-06-05 06:44:31 by partain]
[ghc-hetmet.git] / ghc / compiler / deSugar / DsUtils.lhs
1 %
2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
3 %
4 \section[DsUtils]{Utilities for desugaring}
5
6 This module exports some utility functions of no great interest.
7
8 \begin{code}
9 #include "HsVersions.h"
10
11 module DsUtils (
12         CanItFail(..), EquationInfo(..), MatchResult(..),
13
14         combineGRHSMatchResults,
15         combineMatchResults,
16         dsExprToAtom,
17         mkCoAlgCaseMatchResult,
18         mkAppDs, mkConDs, mkPrimDs, mkErrorAppDs,
19         mkCoLetsMatchResult,
20         mkCoPrimCaseMatchResult,
21         mkFailurePair,
22         mkGuardedMatchResult,
23         mkSelectorBinds,
24         mkTupleBind,
25         mkTupleExpr,
26         selectMatchVars,
27         showForErr
28     ) where
29
30 IMP_Ubiq()
31 IMPORT_DELOOPER(DsLoop)         ( match, matchSimply )
32
33 import HsSyn            ( HsExpr(..), OutPat(..), HsLit(..),
34                           Match, HsBinds, Stmt, Qual, PolyType, ArithSeqInfo )
35 import TcHsSyn          ( TypecheckedPat(..) )
36 import DsHsSyn          ( outPatType )
37 import CoreSyn
38
39 import DsMonad
40
41 import CoreUtils        ( coreExprType, mkCoreIfThenElse )
42 import PprStyle         ( PprStyle(..) )
43 import PrelVals         ( iRREFUT_PAT_ERROR_ID, voidId )
44 import Pretty           ( ppShow )
45 import Id               ( idType, dataConArgTys, mkTupleCon,
46                           pprId{-ToDo:rm-},
47                           DataCon(..), DictVar(..), Id(..), GenId )
48 import Literal          ( Literal(..) )
49 import TyCon            ( mkTupleTyCon, isNewTyCon, tyConDataCons )
50 import Type             ( mkTyVarTys, mkRhoTy, mkForAllTys, mkFunTys,
51                           mkTheta, isUnboxedType, applyTyCon, getAppTyCon
52                         )
53 import TysWiredIn       ( voidTy )
54 import UniqSet          ( mkUniqSet, minusUniqSet, uniqSetToList, UniqSet(..) )
55 import Util             ( panic, assertPanic, pprTrace{-ToDo:rm-} )
56 import PprCore{-ToDo:rm-}
57 --import PprType--ToDo:rm
58 import Pretty--ToDo:rm
59 import TyVar--ToDo:rm
60 import Unique--ToDo:rm
61 import Usage--ToDo:rm
62 \end{code}
63
64 %************************************************************************
65 %*                                                                      *
66 %* type synonym EquationInfo and access functions for its pieces        *
67 %*                                                                      *
68 %************************************************************************
69 \subsection[EquationInfo-synonym]{@EquationInfo@: a useful synonym}
70
71 The ``equation info'' used by @match@ is relatively complicated and
72 worthy of a type synonym and a few handy functions.
73
74 \begin{code}
75 data EquationInfo
76   = EqnInfo
77         [TypecheckedPat]    -- the patterns for an eqn
78         MatchResult         -- Encapsulates the guards and bindings
79 \end{code}
80
81 \begin{code}
82 data MatchResult
83   = MatchResult
84         CanItFail
85         Type            -- Type of argument expression
86
87         (CoreExpr -> CoreExpr)
88                         -- Takes a expression to plug in at the
89                         -- failure point(s). The expression should
90                         -- be duplicatable!
91
92         DsMatchContext  -- The context info is used when producing warnings
93                         -- about shadowed patterns.  It's the context
94                         -- of the *first* thing matched in this group.
95                         -- Should perhaps be a list of them all!
96
97 data CanItFail = CanFail | CantFail
98
99 orFail CantFail CantFail = CantFail
100 orFail _        _        = CanFail
101
102
103 mkCoLetsMatchResult :: [CoreBinding] -> MatchResult -> MatchResult
104 mkCoLetsMatchResult binds (MatchResult can_it_fail ty body_fn cxt)
105   = MatchResult can_it_fail ty (\body -> mkCoLetsAny binds (body_fn body)) cxt
106
107 mkGuardedMatchResult :: CoreExpr -> MatchResult -> DsM MatchResult
108 mkGuardedMatchResult pred_expr (MatchResult can_it_fail ty body_fn cxt)
109   = returnDs (MatchResult CanFail
110                           ty
111                           (\fail -> mkCoreIfThenElse pred_expr (body_fn fail) fail)
112                           cxt
113     )
114
115 mkCoPrimCaseMatchResult :: Id                           -- Scrutinee
116                     -> [(Literal, MatchResult)] -- Alternatives
117                     -> DsM MatchResult
118 mkCoPrimCaseMatchResult var alts
119   = newSysLocalDs (idType var)  `thenDs` \ wild ->
120     returnDs (MatchResult CanFail
121                           ty1
122                           (mk_case alts wild)
123                           cxt1)
124   where
125     ((_,MatchResult _ ty1 _ cxt1) : _) = alts
126
127     mk_case alts wild fail_expr
128       = Case (Var var) (PrimAlts final_alts (BindDefault wild fail_expr))
129       where
130         final_alts = [ (lit, body_fn fail_expr)
131                      | (lit, MatchResult _ _ body_fn _) <- alts
132                      ]
133
134
135 mkCoAlgCaseMatchResult :: Id                            -- Scrutinee
136                     -> [(DataCon, [Id], MatchResult)]   -- Alternatives
137                     -> DsM MatchResult
138
139 mkCoAlgCaseMatchResult var alts
140   | isNewTyCon tycon            -- newtype case; use a let
141   = ASSERT( newtype_sanity )
142     returnDs (mkCoLetsMatchResult [coercion_bind] match_result)
143
144   | otherwise                   -- datatype case  
145   =         -- Find all the constructors in the type which aren't
146             -- explicitly mentioned in the alternatives:
147     case un_mentioned_constructors of
148         [] ->   -- All constructors mentioned, so no default needed
149                 returnDs (MatchResult can_any_alt_fail
150                                       ty1
151                                       (mk_case alts (\ignore -> NoDefault))
152                                       cxt1)
153
154         [con] ->     -- Just one constructor missing, so add a case for it
155                      -- We need to build new locals for the args of the constructor,
156                      -- and figuring out their types is somewhat tiresome.
157                 let
158                         arg_tys = dataConArgTys con tycon_arg_tys
159                 in
160                 newSysLocalsDs arg_tys  `thenDs` \ arg_ids ->
161
162                      -- Now we are ready to construct the new alternative
163                 let
164                         new_alt = (con, arg_ids, MatchResult CanFail ty1 id NoMatchContext)
165                 in
166                 returnDs (MatchResult CanFail
167                                       ty1
168                                       (mk_case (new_alt:alts) (\ignore -> NoDefault))
169                                       cxt1)
170
171         other ->      -- Many constructors missing, so use a default case
172                 newSysLocalDs scrut_ty          `thenDs` \ wild ->
173                 returnDs (MatchResult CanFail
174                                       ty1
175                                       (mk_case alts (\fail_expr -> BindDefault wild fail_expr))
176                                       cxt1)
177   where
178         -- Common stuff
179     scrut_ty = idType var
180     (tycon, tycon_arg_tys) = --pprTrace "CoAlgCase:" (pprType PprDebug scrut_ty) $ 
181                              getAppTyCon scrut_ty
182
183         -- Stuff for newtype
184     (con_id, arg_ids, match_result) = head alts
185     arg_id                          = head arg_ids
186     coercion_bind                   = NonRec arg_id (Coerce (CoerceOut con_id) 
187                                                             (idType arg_id)
188                                                             (Var var))
189     newtype_sanity                  = null (tail alts) && null (tail arg_ids)
190
191         -- Stuff for data types
192     data_cons = tyConDataCons tycon
193
194     un_mentioned_constructors
195       = uniqSetToList (mkUniqSet data_cons `minusUniqSet` mkUniqSet [ con | (con, _, _) <- alts] )
196
197     match_results = [match_result | (_,_,match_result) <- alts]
198     (MatchResult _ ty1 _ cxt1 : _) = match_results
199     can_any_alt_fail = foldr1 orFail [can_it_fail | MatchResult can_it_fail _ _ _ <- match_results]
200
201     mk_case alts deflt_fn fail_expr
202       = Case (Var var) (AlgAlts final_alts (deflt_fn fail_expr))
203       where
204         final_alts = [ (con, args, body_fn fail_expr)
205                      | (con, args, MatchResult _ _ body_fn _) <- alts
206                      ]
207
208
209 combineMatchResults :: MatchResult -> MatchResult -> DsM MatchResult
210 combineMatchResults (MatchResult CanFail      ty1 body_fn1 cxt1)
211                     (MatchResult can_it_fail2 ty2 body_fn2 cxt2)
212   = mkFailurePair ty1           `thenDs` \ (bind_fn, duplicatable_expr) ->
213     let
214         new_body_fn1 = \body1 -> Let (bind_fn body1) (body_fn1 duplicatable_expr)
215         new_body_fn2 = \body2 -> new_body_fn1 (body_fn2 body2)
216     in
217     returnDs (MatchResult can_it_fail2 ty1 new_body_fn2 cxt1)
218
219 combineMatchResults match_result1@(MatchResult CantFail ty body_fn1 cxt1)
220                                   match_result2
221   = returnDs match_result1
222
223
224 -- The difference in combineGRHSMatchResults is that there is no
225 -- need to let-bind to avoid code duplication
226 combineGRHSMatchResults :: MatchResult -> MatchResult -> DsM MatchResult
227 combineGRHSMatchResults (MatchResult CanFail     ty1 body_fn1 cxt1)
228                         (MatchResult can_it_fail ty2 body_fn2 cxt2)
229   = returnDs (MatchResult can_it_fail ty1 (\ body -> body_fn1 (body_fn2 body)) cxt1)
230
231 combineGRHSMatchResults match_result1 match_result2
232   =     -- Delegate to avoid duplication of code
233     combineMatchResults match_result1 match_result2
234 \end{code}
235
236 %************************************************************************
237 %*                                                                      *
238 \subsection[dsExprToAtom]{Take an expression and produce an atom}
239 %*                                                                      *
240 %************************************************************************
241
242 \begin{code}
243 dsExprToAtom :: CoreExpr                    -- The argument expression
244              -> (CoreArg -> DsM CoreExpr)   -- Something taking the argument *atom*,
245                                             -- and delivering an expression E
246              -> DsM CoreExpr                -- Either E or let x=arg-expr in E
247
248 dsExprToAtom (Var v) continue_with = continue_with (VarArg v)
249 dsExprToAtom (Lit v) continue_with = continue_with (LitArg v)
250
251 dsExprToAtom arg_expr continue_with
252   = let
253         ty = coreExprType arg_expr
254     in
255     newSysLocalDs ty                    `thenDs` \ arg_id ->
256     continue_with (VarArg arg_id)       `thenDs` \ body   ->
257     returnDs (
258         if isUnboxedType ty
259         then Case arg_expr (PrimAlts [] (BindDefault arg_id body))
260         else Let (NonRec arg_id arg_expr) body
261     )
262
263 dsExprsToAtoms :: [CoreExpr]
264                -> ([CoreArg] -> DsM CoreExpr)
265                -> DsM CoreExpr
266
267 dsExprsToAtoms [] continue_with
268   = continue_with []
269
270 dsExprsToAtoms (arg:args) continue_with
271   = dsExprToAtom   arg  $ \ arg_atom  ->
272     dsExprsToAtoms args $ \ arg_atoms ->
273     continue_with (arg_atom:arg_atoms)
274 \end{code}
275
276 %************************************************************************
277 %*                                                                      *
278 \subsection{Desugarer's versions of some Core functions}
279 %*                                                                      *
280 %************************************************************************
281
282 \begin{code}
283 mkAppDs  :: CoreExpr -> [Type] -> [CoreExpr] -> DsM CoreExpr
284 mkConDs  :: Id       -> [Type] -> [CoreExpr] -> DsM CoreExpr
285 mkPrimDs :: PrimOp   -> [Type] -> [CoreExpr] -> DsM CoreExpr
286
287 mkAppDs fun tys arg_exprs 
288   = dsExprsToAtoms arg_exprs $ \ vals ->
289     returnDs (mkApp fun [] tys vals)
290
291 mkConDs con tys arg_exprs
292   = dsExprsToAtoms arg_exprs $ \ vals ->
293     returnDs (mkCon con [] tys vals)
294
295 mkPrimDs op tys arg_exprs
296   = dsExprsToAtoms arg_exprs $ \ vals ->
297     returnDs (mkPrim op [] tys vals)
298 \end{code}
299
300 \begin{code}
301 showForErr :: Outputable a => a -> String               -- Boring but useful
302 showForErr thing = ppShow 80 (ppr PprForUser thing)
303
304 mkErrorAppDs :: Id              -- The error function
305              -> Type            -- Type to which it should be applied
306              -> String          -- The error message string to pass
307              -> DsM CoreExpr
308
309 mkErrorAppDs err_id ty msg
310   = getSrcLocDs                 `thenDs` \ (file, line) ->
311     let
312         full_msg = file ++ "|" ++ line ++ "|" ++msg
313         msg_lit  = NoRepStr (_PK_ full_msg)
314     in
315     returnDs (mkApp (Var err_id) [] [ty] [LitArg msg_lit])
316 \end{code}
317
318 %************************************************************************
319 %*                                                                      *
320 \subsection[mkSelectorBind]{Make a selector bind}
321 %*                                                                      *
322 %************************************************************************
323
324 This is used in various places to do with lazy patterns.
325 For each binder $b$ in the pattern, we create a binding:
326
327     b = case v of pat' -> b'
328
329 where pat' is pat with each binder b cloned into b'.
330
331 ToDo: making these bindings should really depend on whether there's
332 much work to be done per binding.  If the pattern is complex, it
333 should be de-mangled once, into a tuple (and then selected from).
334 Otherwise the demangling can be in-line in the bindings (as here).
335
336 Boring!  Boring!  One error message per binder.  The above ToDo is
337 even more helpful.  Something very similar happens for pattern-bound
338 expressions.
339
340 \begin{code}
341 mkSelectorBinds :: [TyVar]          -- Variables wrt which the pattern is polymorphic
342                 -> TypecheckedPat   -- The pattern
343                 -> [(Id,Id)]        -- Monomorphic and polymorphic binders for
344                                     -- the pattern
345                 -> CoreExpr    -- Expression to which the pattern is bound
346                 -> DsM [(Id,CoreExpr)]
347
348 mkSelectorBinds tyvars pat locals_and_globals val_expr
349   = if is_simple_tuple_pat pat then
350         mkTupleBind tyvars [] locals_and_globals val_expr
351     else
352         mkErrorAppDs iRREFUT_PAT_ERROR_ID res_ty ""     `thenDs` \ error_msg ->
353         matchSimply val_expr pat res_ty local_tuple error_msg `thenDs` \ tuple_expr ->
354         mkTupleBind tyvars [] locals_and_globals tuple_expr
355   where
356     locals      = [local | (local, _) <- locals_and_globals]
357     local_tuple = mkTupleExpr locals
358     res_ty      = coreExprType local_tuple
359
360     is_simple_tuple_pat (TuplePat ps) = all is_var_pat ps
361     is_simple_tuple_pat other         = False
362
363     is_var_pat (VarPat v) = True
364     is_var_pat other      = False -- Even wild-card patterns aren't acceptable
365 \end{code}
366
367 We're about to match against some patterns.  We want to make some
368 @Ids@ to use as match variables.  If a pattern has an @Id@ readily at
369 hand, which should indeed be bound to the pattern as a whole, then use it;
370 otherwise, make one up.
371 \begin{code}
372 selectMatchVars :: [TypecheckedPat] -> DsM [Id]
373 selectMatchVars pats
374   = mapDs var_from_pat_maybe pats
375   where
376     var_from_pat_maybe (VarPat var)     = returnDs var
377     var_from_pat_maybe (AsPat var pat)  = returnDs var
378     var_from_pat_maybe (LazyPat pat)    = var_from_pat_maybe pat
379     var_from_pat_maybe other_pat
380       = newSysLocalDs (outPatType other_pat) -- OK, better make up one...
381 \end{code}
382
383 \begin{code}
384 mkTupleBind :: [TyVar]      -- Abstract wrt these...
385         -> [DictVar]        -- ... and these
386
387         -> [(Id, Id)]       -- Local, global pairs, equal in number
388                             -- to the size of the tuple.  The types
389                             -- of the globals is the generalisation of
390                             -- the corresp local, wrt the tyvars and dicts
391
392         -> CoreExpr    -- Expr whose value is a tuple; the expression
393                             -- may mention the tyvars and dicts
394
395         -> DsM [(Id, CoreExpr)] -- Bindings for the globals
396 \end{code}
397
398 The general call is
399 \begin{verbatim}
400         mkTupleBind tyvars dicts [(l1,g1), ..., (ln,gn)] tup_expr
401 \end{verbatim}
402 If $n=1$, the result is:
403 \begin{verbatim}
404         g1 = /\ tyvars -> \ dicts -> rhs
405 \end{verbatim}
406 Otherwise, the result is:
407 \begin{verbatim}
408         tup = /\ tyvars -> \ dicts -> tup_expr
409         g1  = /\ tyvars -> \ dicts -> case (tup tyvars dicts) of
410                                         (l1, ..., ln) -> l1
411         ...etc...
412 \end{verbatim}
413
414 \begin{code}
415 mkTupleBind tyvars dicts [(local,global)] tuple_expr
416   = returnDs [(global, mkLam tyvars dicts tuple_expr)]
417 \end{code}
418
419 The general case:
420
421 \begin{code}
422 mkTupleBind tyvars dicts local_global_prs tuple_expr
423   = --pprTrace "mkTupleBind:\n" (ppAboves [ppCat (map (pprId PprShowAll) locals), ppCat (map (pprId PprShowAll) globals), {-ppr PprDebug local_tuple, pprType PprDebug res_ty,-} ppr PprDebug tuple_expr]) $
424
425     newSysLocalDs tuple_var_ty  `thenDs` \ tuple_var ->
426
427     zipWithDs (mk_selector (Var tuple_var))
428               local_global_prs
429               [(0::Int) .. (length local_global_prs - 1)]
430                                 `thenDs` \ tup_selectors ->
431     returnDs (
432         (tuple_var, mkLam tyvars dicts tuple_expr)
433         : tup_selectors
434     )
435   where
436     locals, globals :: [Id]
437     locals  = [local  | (local,global) <- local_global_prs]
438     globals = [global | (local,global) <- local_global_prs]
439
440     no_of_binders = length local_global_prs
441     tyvar_tys = mkTyVarTys tyvars
442
443     tuple_var_ty :: Type
444     tuple_var_ty
445       = mkForAllTys tyvars $
446         mkRhoTy theta      $
447         applyTyCon (mkTupleTyCon no_of_binders)
448                    (map idType locals)
449       where
450         theta = mkTheta (map idType dicts)
451
452     mk_selector :: CoreExpr -> (Id, Id) -> Int -> DsM (Id, CoreExpr)
453
454     mk_selector tuple_var_expr (local, global) which_local
455       = mapDs duplicateLocalDs locals{-the whole bunch-} `thenDs` \ binders ->
456         let
457             selected = binders !! which_local
458         in
459         returnDs (
460             global,
461             mkLam tyvars dicts (
462                 mkTupleSelector
463                     (mkValApp (mkTyApp tuple_var_expr tyvar_tys)
464                               (map VarArg dicts))
465                     binders
466                     selected)
467         )
468 \end{code}
469
470 @mkTupleExpr@ builds a tuple; the inverse to @mkTupleSelector@.  If it
471 has only one element, it is the identity function.
472 \begin{code}
473 mkTupleExpr :: [Id] -> CoreExpr
474
475 mkTupleExpr []   = Con (mkTupleCon 0) []
476 mkTupleExpr [id] = Var id
477 mkTupleExpr ids  = mkCon (mkTupleCon (length ids))
478                          [{-usages-}]
479                          (map idType ids)
480                          [ VarArg i | i <- ids ]
481 \end{code}
482
483
484 @mkTupleSelector@ builds a selector which scrutises the given
485 expression and extracts the one name from the list given.
486 If you want the no-shadowing rule to apply, the caller
487 is responsible for making sure that none of these names
488 are in scope.
489
490 If there is just one id in the ``tuple'', then the selector is
491 just the identity.
492
493 \begin{code}
494 mkTupleSelector :: CoreExpr     -- Scrutinee
495                 -> [Id]                 -- The tuple args
496                 -> Id                   -- The selected one
497                 -> CoreExpr
498
499 mkTupleSelector expr [] the_var = panic "mkTupleSelector"
500
501 mkTupleSelector expr [var] should_be_the_same_var
502   = ASSERT(var == should_be_the_same_var)
503     expr
504
505 mkTupleSelector expr vars the_var
506  = Case expr (AlgAlts [(mkTupleCon arity, vars, Var the_var)]
507                           NoDefault)
508  where
509    arity = length vars
510 \end{code}
511
512
513 %************************************************************************
514 %*                                                                      *
515 \subsection[mkFailurePair]{Code for pattern-matching and other failures}
516 %*                                                                      *
517 %************************************************************************
518
519 Generally, we handle pattern matching failure like this: let-bind a
520 fail-variable, and use that variable if the thing fails:
521 \begin{verbatim}
522         let fail.33 = error "Help"
523         in
524         case x of
525                 p1 -> ...
526                 p2 -> fail.33
527                 p3 -> fail.33
528                 p4 -> ...
529 \end{verbatim}
530 Then
531 \begin{itemize}
532 \item
533 If the case can't fail, then there'll be no mention of fail.33, and the
534 simplifier will later discard it.
535
536 \item
537 If it can fail in only one way, then the simplifier will inline it.
538
539 \item
540 Only if it is used more than once will the let-binding remain.
541 \end{itemize}
542
543 There's a problem when the result of the case expression is of
544 unboxed type.  Then the type of fail.33 is unboxed too, and
545 there is every chance that someone will change the let into a case:
546 \begin{verbatim}
547         case error "Help" of
548           fail.33 -> case ....
549 \end{verbatim}
550
551 which is of course utterly wrong.  Rather than drop the condition that
552 only boxed types can be let-bound, we just turn the fail into a function
553 for the primitive case:
554 \begin{verbatim}
555         let fail.33 :: Void -> Int#
556             fail.33 = \_ -> error "Help"
557         in
558         case x of
559                 p1 -> ...
560                 p2 -> fail.33 void
561                 p3 -> fail.33 void
562                 p4 -> ...
563 \end{verbatim}
564
565 Now fail.33 is a function, so it can be let-bound.
566
567 \begin{code}
568 mkFailurePair :: Type           -- Result type of the whole case expression
569               -> DsM (CoreExpr -> CoreBinding,
570                                 -- Binds the newly-created fail variable
571                                 -- to either the expression or \ _ -> expression
572                       CoreExpr) -- Either the fail variable, or fail variable
573                                 -- applied to unit tuple
574 mkFailurePair ty
575   | isUnboxedType ty
576   = newFailLocalDs (mkFunTys [voidTy] ty)       `thenDs` \ fail_fun_var ->
577     newSysLocalDs voidTy                        `thenDs` \ fail_fun_arg ->
578     returnDs (\ body ->
579                 NonRec fail_fun_var (Lam (ValBinder fail_fun_arg) body),
580               App (Var fail_fun_var) (VarArg voidId))
581
582   | otherwise
583   = newFailLocalDs ty           `thenDs` \ fail_var ->
584     returnDs (\ body -> NonRec fail_var body, Var fail_var)
585 \end{code}
586
587
588