{-
(c) The University of Glasgow 2006
(c) The GRASP/AQUA Project, Glasgow University, 1992-1998


Matching guarded right-hand-sides (GRHSs)
-}

{-# LANGUAGE CPP #-}
{-# LANGUAGE ViewPatterns #-}

module DsGRHSs ( dsGuarded, dsGRHSs, dsGRHS, isTrueLHsExpr ) where

#include "HsVersions.h"

import GhcPrelude

import {-# SOURCE #-} DsExpr  ( dsLExpr, dsLocalBinds )
import {-# SOURCE #-} Match   ( matchSinglePatVar )

import GHC.Hs
import MkCore
import CoreSyn
import CoreUtils (bindNonRec)

import BasicTypes (Origin(FromSource))
import DynFlags
import GHC.HsToCore.PmCheck (needToRunPmCheck, addTyCsDs, addPatTmCs, addScrutTmCs)
import DsMonad
import DsUtils
import Type   ( Type )
import Name
import Util
import SrcLoc
import Outputable

{-
@dsGuarded@ is used for pattern bindings.
It desugars:
\begin{verbatim}
        | g1 -> e1
        ...
        | gn -> en
        where binds
\end{verbatim}
producing an expression with a runtime error in the corner if
necessary.  The type argument gives the type of the @ei@.
-}

dsGuarded :: GRHSs GhcTc (LHsExpr GhcTc) -> Type -> DsM CoreExpr
dsGuarded :: GRHSs GhcTc (LHsExpr GhcTc) -> Type -> DsM CoreExpr
dsGuarded GRHSs GhcTc (LHsExpr GhcTc)
grhss Type
rhs_ty = do
    MatchResult
match_result <- HsMatchContext Name
-> GRHSs GhcTc (LHsExpr GhcTc) -> Type -> DsM MatchResult
dsGRHSs HsMatchContext Name
forall id. HsMatchContext id
PatBindRhs GRHSs GhcTc (LHsExpr GhcTc)
grhss Type
rhs_ty
    CoreExpr
error_expr <- Id -> Type -> SDoc -> DsM CoreExpr
mkErrorAppDs Id
nON_EXHAUSTIVE_GUARDS_ERROR_ID Type
rhs_ty SDoc
empty
    MatchResult -> CoreExpr -> DsM CoreExpr
extractMatchResult MatchResult
match_result CoreExpr
error_expr

-- In contrast, @dsGRHSs@ produces a @MatchResult@.

dsGRHSs :: HsMatchContext Name
        -> GRHSs GhcTc (LHsExpr GhcTc)          -- Guarded RHSs
        -> Type                                 -- Type of RHS
        -> DsM MatchResult
dsGRHSs :: HsMatchContext Name
-> GRHSs GhcTc (LHsExpr GhcTc) -> Type -> DsM MatchResult
dsGRHSs HsMatchContext Name
hs_ctx (GRHSs XCGRHSs GhcTc (LHsExpr GhcTc)
_ [LGRHS GhcTc (LHsExpr GhcTc)]
grhss LHsLocalBinds GhcTc
binds) Type
rhs_ty
  = ASSERT( notNull grhss )
    do { [MatchResult]
match_results <- (LGRHS GhcTc (LHsExpr GhcTc) -> DsM MatchResult)
-> [LGRHS GhcTc (LHsExpr GhcTc)]
-> IOEnv (Env DsGblEnv DsLclEnv) [MatchResult]
forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM (HsMatchContext Name
-> Type -> LGRHS GhcTc (LHsExpr GhcTc) -> DsM MatchResult
dsGRHS HsMatchContext Name
hs_ctx Type
rhs_ty) [LGRHS GhcTc (LHsExpr GhcTc)]
grhss
       ; let match_result1 :: MatchResult
match_result1 = (MatchResult -> MatchResult -> MatchResult)
-> [MatchResult] -> MatchResult
forall (t :: * -> *) a. Foldable t => (a -> a -> a) -> t a -> a
foldr1 MatchResult -> MatchResult -> MatchResult
combineMatchResults [MatchResult]
match_results
             match_result2 :: MatchResult
match_result2 = (CoreExpr -> DsM CoreExpr) -> MatchResult -> MatchResult
adjustMatchResultDs (LHsLocalBinds GhcTc -> CoreExpr -> DsM CoreExpr
dsLocalBinds LHsLocalBinds GhcTc
binds) MatchResult
match_result1
                             -- NB: nested dsLet inside matchResult
       ; MatchResult -> DsM MatchResult
forall (m :: * -> *) a. Monad m => a -> m a
return MatchResult
match_result2 }
dsGRHSs HsMatchContext Name
_ (XGRHSs XXGRHSs GhcTc (LHsExpr GhcTc)
nec) Type
_ = NoExtCon -> DsM MatchResult
forall a. NoExtCon -> a
noExtCon XXGRHSs GhcTc (LHsExpr GhcTc)
NoExtCon
nec

dsGRHS :: HsMatchContext Name -> Type -> LGRHS GhcTc (LHsExpr GhcTc)
       -> DsM MatchResult
dsGRHS :: HsMatchContext Name
-> Type -> LGRHS GhcTc (LHsExpr GhcTc) -> DsM MatchResult
dsGRHS HsMatchContext Name
hs_ctx Type
rhs_ty (LGRHS GhcTc (LHsExpr GhcTc)
-> Located (SrcSpanLess (LGRHS GhcTc (LHsExpr GhcTc)))
forall a. HasSrcSpan a => a -> Located (SrcSpanLess a)
dL->L SrcSpan
_ (GRHS _ guards rhs))
  = [GuardStmt GhcTc]
-> HsStmtContext Name -> LHsExpr GhcTc -> Type -> DsM MatchResult
matchGuards ((GuardLStmt GhcTc -> GuardStmt GhcTc)
-> [GuardLStmt GhcTc] -> [GuardStmt GhcTc]
forall a b. (a -> b) -> [a] -> [b]
map GuardLStmt GhcTc -> GuardStmt GhcTc
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc [GuardLStmt GhcTc]
guards) (HsMatchContext Name -> HsStmtContext Name
forall id. HsMatchContext id -> HsStmtContext id
PatGuard HsMatchContext Name
hs_ctx) LHsExpr GhcTc
rhs Type
rhs_ty
dsGRHS HsMatchContext Name
_ Type
_ (LGRHS GhcTc (LHsExpr GhcTc)
-> Located (SrcSpanLess (LGRHS GhcTc (LHsExpr GhcTc)))
forall a. HasSrcSpan a => a -> Located (SrcSpanLess a)
dL->L SrcSpan
_ (XGRHS nec)) = NoExtCon -> DsM MatchResult
forall a. NoExtCon -> a
noExtCon XXGRHS GhcTc (LHsExpr GhcTc)
NoExtCon
nec
dsGRHS HsMatchContext Name
_ Type
_ LGRHS GhcTc (LHsExpr GhcTc)
_ = String -> DsM MatchResult
forall a. String -> a
panic String
"dsGRHS: Impossible Match" -- due to #15884

{-
************************************************************************
*                                                                      *
*  matchGuard : make a MatchResult from a guarded RHS                  *
*                                                                      *
************************************************************************
-}

matchGuards :: [GuardStmt GhcTc]     -- Guard
            -> HsStmtContext Name    -- Context
            -> LHsExpr GhcTc         -- RHS
            -> Type                  -- Type of RHS of guard
            -> DsM MatchResult

-- See comments with HsExpr.Stmt re what a BodyStmt means
-- Here we must be in a guard context (not do-expression, nor list-comp)

matchGuards :: [GuardStmt GhcTc]
-> HsStmtContext Name -> LHsExpr GhcTc -> Type -> DsM MatchResult
matchGuards [] HsStmtContext Name
_ LHsExpr GhcTc
rhs Type
_
  = do  { CoreExpr
core_rhs <- LHsExpr GhcTc -> DsM CoreExpr
dsLExpr LHsExpr GhcTc
rhs
        ; MatchResult -> DsM MatchResult
forall (m :: * -> *) a. Monad m => a -> m a
return (CoreExpr -> MatchResult
cantFailMatchResult CoreExpr
core_rhs) }

        -- BodyStmts must be guards
        -- Turn an "otherwise" guard is a no-op.  This ensures that
        -- you don't get a "non-exhaustive eqns" message when the guards
        -- finish in "otherwise".
        -- NB:  The success of this clause depends on the typechecker not
        --      wrapping the 'otherwise' in empty HsTyApp or HsWrap constructors
        --      If it does, you'll get bogus overlap warnings
matchGuards (BodyStmt XBodyStmt GhcTc GhcTc (LHsExpr GhcTc)
_ LHsExpr GhcTc
e SyntaxExpr GhcTc
_ SyntaxExpr GhcTc
_ : [GuardStmt GhcTc]
stmts) HsStmtContext Name
ctx LHsExpr GhcTc
rhs Type
rhs_ty
  | Just CoreExpr -> DsM CoreExpr
addTicks <- LHsExpr GhcTc -> Maybe (CoreExpr -> DsM CoreExpr)
isTrueLHsExpr LHsExpr GhcTc
e = do
    MatchResult
match_result <- [GuardStmt GhcTc]
-> HsStmtContext Name -> LHsExpr GhcTc -> Type -> DsM MatchResult
matchGuards [GuardStmt GhcTc]
stmts HsStmtContext Name
ctx LHsExpr GhcTc
rhs Type
rhs_ty
    MatchResult -> DsM MatchResult
forall (m :: * -> *) a. Monad m => a -> m a
return ((CoreExpr -> DsM CoreExpr) -> MatchResult -> MatchResult
adjustMatchResultDs CoreExpr -> DsM CoreExpr
addTicks MatchResult
match_result)
matchGuards (BodyStmt XBodyStmt GhcTc GhcTc (LHsExpr GhcTc)
_ LHsExpr GhcTc
expr SyntaxExpr GhcTc
_ SyntaxExpr GhcTc
_ : [GuardStmt GhcTc]
stmts) HsStmtContext Name
ctx LHsExpr GhcTc
rhs Type
rhs_ty = do
    MatchResult
match_result <- [GuardStmt GhcTc]
-> HsStmtContext Name -> LHsExpr GhcTc -> Type -> DsM MatchResult
matchGuards [GuardStmt GhcTc]
stmts HsStmtContext Name
ctx LHsExpr GhcTc
rhs Type
rhs_ty
    CoreExpr
pred_expr <- LHsExpr GhcTc -> DsM CoreExpr
dsLExpr LHsExpr GhcTc
expr
    MatchResult -> DsM MatchResult
forall (m :: * -> *) a. Monad m => a -> m a
return (CoreExpr -> MatchResult -> MatchResult
mkGuardedMatchResult CoreExpr
pred_expr MatchResult
match_result)

matchGuards (LetStmt XLetStmt GhcTc GhcTc (LHsExpr GhcTc)
_ LHsLocalBinds GhcTc
binds : [GuardStmt GhcTc]
stmts) HsStmtContext Name
ctx LHsExpr GhcTc
rhs Type
rhs_ty = do
    MatchResult
match_result <- [GuardStmt GhcTc]
-> HsStmtContext Name -> LHsExpr GhcTc -> Type -> DsM MatchResult
matchGuards [GuardStmt GhcTc]
stmts HsStmtContext Name
ctx LHsExpr GhcTc
rhs Type
rhs_ty
    MatchResult -> DsM MatchResult
forall (m :: * -> *) a. Monad m => a -> m a
return ((CoreExpr -> DsM CoreExpr) -> MatchResult -> MatchResult
adjustMatchResultDs (LHsLocalBinds GhcTc -> CoreExpr -> DsM CoreExpr
dsLocalBinds LHsLocalBinds GhcTc
binds) MatchResult
match_result)
        -- NB the dsLet occurs inside the match_result
        -- Reason: dsLet takes the body expression as its argument
        --         so we can't desugar the bindings without the
        --         body expression in hand

matchGuards (BindStmt XBindStmt GhcTc GhcTc (LHsExpr GhcTc)
_ LPat GhcTc
pat LHsExpr GhcTc
bind_rhs SyntaxExpr GhcTc
_ SyntaxExpr GhcTc
_ : [GuardStmt GhcTc]
stmts) HsStmtContext Name
ctx LHsExpr GhcTc
rhs Type
rhs_ty = do
    let upat :: SrcSpanLess (Located (Pat GhcTc))
upat = Located (Pat GhcTc) -> SrcSpanLess (Located (Pat GhcTc))
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc Located (Pat GhcTc)
LPat GhcTc
pat
        dicts :: Bag Id
dicts = Pat GhcTc -> Bag Id
collectEvVarsPat Pat GhcTc
upat
    Id
match_var <- Pat GhcTc -> DsM Id
selectMatchVar Pat GhcTc
upat

    DynFlags
dflags <- IOEnv (Env DsGblEnv DsLclEnv) DynFlags
forall (m :: * -> *). HasDynFlags m => m DynFlags
getDynFlags
    MatchResult
match_result <-
      -- See Note [Type and Term Equality Propagation] in Check
      Bool
-> (DsM MatchResult -> DsM MatchResult)
-> DsM MatchResult
-> DsM MatchResult
forall a. Bool -> (a -> a) -> a -> a
applyWhen (DynFlags -> Origin -> Bool
needToRunPmCheck DynFlags
dflags Origin
FromSource)
                -- FromSource might not be accurate, but at worst
                -- we do superfluous calls to the pattern match
                -- oracle.
                (Bag Id -> DsM MatchResult -> DsM MatchResult
forall a. Bag Id -> DsM a -> DsM a
addTyCsDs Bag Id
dicts (DsM MatchResult -> DsM MatchResult)
-> (DsM MatchResult -> DsM MatchResult)
-> DsM MatchResult
-> DsM MatchResult
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Maybe (LHsExpr GhcTc) -> [Id] -> DsM MatchResult -> DsM MatchResult
forall a. Maybe (LHsExpr GhcTc) -> [Id] -> DsM a -> DsM a
addScrutTmCs (LHsExpr GhcTc -> Maybe (LHsExpr GhcTc)
forall a. a -> Maybe a
Just LHsExpr GhcTc
bind_rhs) [Id
match_var] (DsM MatchResult -> DsM MatchResult)
-> (DsM MatchResult -> DsM MatchResult)
-> DsM MatchResult
-> DsM MatchResult
forall b c a. (b -> c) -> (a -> b) -> a -> c
. [Pat GhcTc] -> [Id] -> DsM MatchResult -> DsM MatchResult
forall a. [Pat GhcTc] -> [Id] -> DsM a -> DsM a
addPatTmCs [Pat GhcTc
upat] [Id
match_var])
                ([GuardStmt GhcTc]
-> HsStmtContext Name -> LHsExpr GhcTc -> Type -> DsM MatchResult
matchGuards [GuardStmt GhcTc]
stmts HsStmtContext Name
ctx LHsExpr GhcTc
rhs Type
rhs_ty)
    CoreExpr
core_rhs <- LHsExpr GhcTc -> DsM CoreExpr
dsLExpr LHsExpr GhcTc
bind_rhs
    MatchResult
match_result' <- Id
-> HsMatchContext Name
-> LPat GhcTc
-> Type
-> MatchResult
-> DsM MatchResult
matchSinglePatVar Id
match_var (HsStmtContext Name -> HsMatchContext Name
forall id. HsStmtContext id -> HsMatchContext id
StmtCtxt HsStmtContext Name
ctx) LPat GhcTc
pat Type
rhs_ty
                                       MatchResult
match_result
    MatchResult -> DsM MatchResult
forall (f :: * -> *) a. Applicative f => a -> f a
pure (MatchResult -> DsM MatchResult) -> MatchResult -> DsM MatchResult
forall a b. (a -> b) -> a -> b
$ DsWrapper -> MatchResult -> MatchResult
adjustMatchResult (Id -> CoreExpr -> DsWrapper
bindNonRec Id
match_var CoreExpr
core_rhs) MatchResult
match_result'

matchGuards (LastStmt  {} : [GuardStmt GhcTc]
_) HsStmtContext Name
_ LHsExpr GhcTc
_ Type
_ = String -> DsM MatchResult
forall a. String -> a
panic String
"matchGuards LastStmt"
matchGuards (ParStmt   {} : [GuardStmt GhcTc]
_) HsStmtContext Name
_ LHsExpr GhcTc
_ Type
_ = String -> DsM MatchResult
forall a. String -> a
panic String
"matchGuards ParStmt"
matchGuards (TransStmt {} : [GuardStmt GhcTc]
_) HsStmtContext Name
_ LHsExpr GhcTc
_ Type
_ = String -> DsM MatchResult
forall a. String -> a
panic String
"matchGuards TransStmt"
matchGuards (RecStmt   {} : [GuardStmt GhcTc]
_) HsStmtContext Name
_ LHsExpr GhcTc
_ Type
_ = String -> DsM MatchResult
forall a. String -> a
panic String
"matchGuards RecStmt"
matchGuards (ApplicativeStmt {} : [GuardStmt GhcTc]
_) HsStmtContext Name
_ LHsExpr GhcTc
_ Type
_ =
  String -> DsM MatchResult
forall a. String -> a
panic String
"matchGuards ApplicativeLastStmt"
matchGuards (XStmtLR XXStmtLR GhcTc GhcTc (LHsExpr GhcTc)
nec : [GuardStmt GhcTc]
_) HsStmtContext Name
_ LHsExpr GhcTc
_ Type
_ =
  NoExtCon -> DsM MatchResult
forall a. NoExtCon -> a
noExtCon XXStmtLR GhcTc GhcTc (LHsExpr GhcTc)
NoExtCon
nec

{-
Should {\em fail} if @e@ returns @D@
\begin{verbatim}
f x | p <- e', let C y# = e, f y# = r1
    | otherwise          = r2
\end{verbatim}
-}