Add 'rec' to stmts in a 'do', and deprecate 'mdo'
[ghc-hetmet.git] / compiler / rename / RnExpr.lhs
index 32d4c4c..4ce7182 100644 (file)
@@ -32,24 +32,20 @@ import RnTypes              ( rnHsTypeFVs, rnSplice, checkTH,
 import RnPat
 import DynFlags                ( DynFlag(..) )
 import BasicTypes      ( FixityDirection(..) )
-import PrelNames       ( hasKey, assertIdKey, assertErrorName,
-                         loopAName, choiceAName, appAName, arrAName, composeAName, firstAName,
-                         negateName, thenMName, bindMName, failMName, groupWithName )
+import PrelNames
 
 import Name
 import NameSet
 import RdrName
 import LoadIface       ( loadInterfaceForName )
 import UniqSet
-import List            ( nub )
+import Data.List
 import Util            ( isSingleton )
 import ListSetOps      ( removeDups )
 import Maybes          ( expectJust )
 import Outputable
 import SrcLoc
 import FastString
-
-import List            ( unzip4 )
 import Control.Monad
 \end{code}
 
@@ -240,20 +236,24 @@ rnExpr (ExplicitPArr _ exps)
   = rnExprs exps                       `thenM` \ (exps', fvs) ->
     return  (ExplicitPArr placeHolderType exps', fvs)
 
-rnExpr (ExplicitTuple exps boxity)
-  = checkTupSize (length exps)                 `thenM_`
-    rnExprs exps                               `thenM` \ (exps', fvs) ->
-    return (ExplicitTuple exps' boxity, fvs)
+rnExpr (ExplicitTuple tup_args boxity)
+  = do { checkTupleSection tup_args
+       ; checkTupSize (length tup_args)
+       ; (tup_args', fvs) <- mapAndUnzipM rnTupArg tup_args
+       ; return (ExplicitTuple tup_args' boxity, plusFVs fvs) }
+  where
+    rnTupArg (Present e) = do { (e',fvs) <- rnLExpr e; return (Present e', fvs) }
+    rnTupArg (Missing _) = return (Missing placeHolderType, emptyFVs)
 
 rnExpr (RecordCon con_id _ rbinds)
   = do { conname <- lookupLocatedOccRn con_id
-       ; (rbinds', fvRbinds) <- rnHsRecFields_Con conname rnLExpr rbinds
+       ; (rbinds', fvRbinds) <- rnHsRecBinds (HsRecFieldCon (unLoc conname)) rbinds
        ; return (RecordCon conname noPostTcExpr rbinds', 
                  fvRbinds `addOneFV` unLoc conname) }
 
 rnExpr (RecordUpd expr rbinds _ _ _)
   = do { (expr', fvExpr) <- rnLExpr expr
-       ; (rbinds', fvRbinds) <- rnHsRecFields_Update rnLExpr rbinds
+       ; (rbinds', fvRbinds) <- rnHsRecBinds HsRecFieldUpd rbinds
        ; return (RecordUpd expr' rbinds' [] [] [], 
                  fvExpr `plusFV` fvRbinds) }
 
@@ -306,7 +306,7 @@ rnExpr e@(ELazyPat {}) = patSynErr e
 \begin{code}
 rnExpr (HsProc pat body)
   = newArrowScope $
-    rnPatsAndThen_LocalRightwards ProcExpr [pat] $ \ [pat'] ->
+    rnPats ProcExpr [pat] $ \ [pat'] ->
     rnCmdTop body               `thenM` \ (body',fvBody) ->
     return (HsProc pat' body', fvBody)
 
@@ -363,6 +363,26 @@ rnSection other = pprPanic "rnSection" (ppr other)
 
 %************************************************************************
 %*                                                                     *
+       Records
+%*                                                                     *
+%************************************************************************
+
+\begin{code}
+rnHsRecBinds :: HsRecFieldContext -> HsRecordBinds RdrName
+             -> RnM (HsRecordBinds Name, FreeVars)
+rnHsRecBinds ctxt rec_binds@(HsRecFields { rec_dotdot = dd })
+  = do { (flds, fvs) <- rnHsRecFields1 ctxt HsVar rec_binds
+       ; (flds', fvss) <- mapAndUnzipM rn_field flds
+       ; return (HsRecFields { rec_flds = flds', rec_dotdot = dd }, 
+                 fvs `plusFV` plusFVs fvss) }
+  where 
+    rn_field fld = do { (arg', fvs) <- rnLExpr (hsRecFieldArg fld)
+                      ; return (fld { hsRecFieldArg = arg' }, fvs) }
+\end{code}
+
+
+%************************************************************************
+%*                                                                     *
        Arrow commands
 %*                                                                     *
 %************************************************************************
@@ -432,8 +452,8 @@ convertOpFormsStmt (BindStmt pat cmd _ _)
   = BindStmt pat (convertOpFormsLCmd cmd) noSyntaxExpr noSyntaxExpr
 convertOpFormsStmt (ExprStmt cmd _ _)
   = ExprStmt (convertOpFormsLCmd cmd) noSyntaxExpr placeHolderType
-convertOpFormsStmt (RecStmt stmts lvs rvs es binds)
-  = RecStmt (map (fmap convertOpFormsStmt) stmts) lvs rvs es binds
+convertOpFormsStmt stmt@(RecStmt { recS_stmts = stmts })
+  = stmt { recS_stmts = map (fmap convertOpFormsStmt) stmts }
 convertOpFormsStmt stmt = stmt
 
 convertOpFormsMatch :: MatchGroup id -> MatchGroup id
@@ -515,14 +535,13 @@ methodNamesLStmt :: Located (StmtLR Name Name) -> FreeVars
 methodNamesLStmt = methodNamesStmt . unLoc
 
 methodNamesStmt :: StmtLR Name Name -> FreeVars
-methodNamesStmt (ExprStmt cmd _ _)     = methodNamesLCmd cmd
-methodNamesStmt (BindStmt _ cmd _ _) = methodNamesLCmd cmd
-methodNamesStmt (RecStmt stmts _ _ _ _)
-  = methodNamesStmts stmts `addOneFV` loopAName
-methodNamesStmt (LetStmt _)  = emptyFVs
-methodNamesStmt (ParStmt _) = emptyFVs
-methodNamesStmt (TransformStmt _ _ _) = emptyFVs
-methodNamesStmt (GroupStmt _ _) = emptyFVs
+methodNamesStmt (ExprStmt cmd _ _)               = methodNamesLCmd cmd
+methodNamesStmt (BindStmt _ cmd _ _)             = methodNamesLCmd cmd
+methodNamesStmt (RecStmt { recS_stmts = stmts }) = methodNamesStmts stmts `addOneFV` loopAName
+methodNamesStmt (LetStmt _)                      = emptyFVs
+methodNamesStmt (ParStmt _)                      = emptyFVs
+methodNamesStmt (TransformStmt _ _ _)            = emptyFVs
+methodNamesStmt (GroupStmt _ _)                  = emptyFVs
    -- ParStmt, TransformStmt and GroupStmt can't occur in commands, but it's not convenient to error 
    -- here so we just do what's convenient
 \end{code}
@@ -568,8 +587,8 @@ rnArithSeq (FromThenTo expr1 expr2 expr3)
 rnBracket :: HsBracket RdrName -> RnM (HsBracket Name, FreeVars)
 rnBracket (VarBr n) = do { name <- lookupOccRn n
                         ; this_mod <- getModule
-                        ; checkM (nameIsLocalOrFrom this_mod name) $   -- Reason: deprecation checking asumes the
-                          do { loadInterfaceForName msg name           -- home interface is loaded, and this is the
+                        ; unless (nameIsLocalOrFrom this_mod name) $   -- Reason: deprecation checking asumes the
+                          do { _ <- loadInterfaceForName msg name      -- home interface is loaded, and this is the
                              ; return () }                             -- only way that is going to happen
                         ; return (VarBr name, unitFV name) }
                    where
@@ -614,67 +633,95 @@ rnStmts ctxt        = rnNormalStmts ctxt
 rnNormalStmts :: HsStmtContext Name -> [LStmt RdrName]
              -> RnM (thing, FreeVars)
              -> RnM (([LStmt Name], thing), FreeVars)  
--- Used for cases *other* than recursive mdo
--- Implements nested scopes
-
 rnNormalStmts _ [] thing_inside 
   = do { (thing, fvs) <- thing_inside
        ; return (([],thing), fvs) } 
 
-rnNormalStmts ctxt (L loc stmt : stmts) thing_inside
-  = do { ((stmt', (stmts', thing)), fvs) <- rnStmt ctxt stmt $
-            rnNormalStmts ctxt stmts thing_inside
-       ; return (((L loc stmt' : stmts'), thing), fvs) }
+rnNormalStmts ctxt (stmt@(L loc _) : stmts) thing_inside
+  = do { ((stmts1, (stmts2, thing)), fvs) 
+            <- setSrcSpan loc $
+               rnStmt ctxt stmt $
+               rnNormalStmts ctxt stmts thing_inside
+       ; return (((stmts1 ++ stmts2), thing), fvs) }
 
 
-rnStmt :: HsStmtContext Name -> Stmt RdrName
+rnStmt :: HsStmtContext Name -> LStmt RdrName
        -> RnM (thing, FreeVars)
-       -> RnM ((Stmt Name, thing), FreeVars)
+       -> RnM (([LStmt Name], thing), FreeVars)
 
-rnStmt _ (ExprStmt expr _ _) thing_inside
+rnStmt _ (L loc (ExprStmt expr _ _)) thing_inside
   = do { (expr', fv_expr) <- rnLExpr expr
        ; (then_op, fvs1)  <- lookupSyntaxName thenMName
        ; (thing, fvs2)    <- thing_inside
-       ; return ((ExprStmt expr' then_op placeHolderType, thing),
+       ; return (([L loc (ExprStmt expr' then_op placeHolderType)], thing),
                  fv_expr `plusFV` fvs1 `plusFV` fvs2) }
 
-rnStmt ctxt (BindStmt pat expr _ _) thing_inside
+rnStmt ctxt (L loc (BindStmt pat expr _ _)) thing_inside
   = do { (expr', fv_expr) <- rnLExpr expr
                -- The binders do not scope over the expression
        ; (bind_op, fvs1) <- lookupSyntaxName bindMName
        ; (fail_op, fvs2) <- lookupSyntaxName failMName
-       ; rnPatsAndThen_LocalRightwards (StmtCtxt ctxt) [pat] $ \ [pat'] -> do
+       ; rnPats (StmtCtxt ctxt) [pat] $ \ [pat'] -> do
        { (thing, fvs3) <- thing_inside
-       ; return ((BindStmt pat' expr' bind_op fail_op, thing),
+       ; return (([L loc (BindStmt pat' expr' bind_op fail_op)], thing),
                  fv_expr `plusFV` fvs1 `plusFV` fvs2 `plusFV` fvs3) }}
        -- fv_expr shouldn't really be filtered by the rnPatsAndThen
        -- but it does not matter because the names are unique
 
-rnStmt ctxt (LetStmt binds) thing_inside 
+rnStmt ctxt (L loc (LetStmt binds)) thing_inside 
   = do { checkLetStmt ctxt binds
        ; rnLocalBindsAndThen binds $ \binds' -> do
        { (thing, fvs) <- thing_inside
-        ; return ((LetStmt binds', thing), fvs) }  }
+        ; return (([L loc (LetStmt binds')], thing), fvs) }  }
 
-rnStmt ctxt (RecStmt rec_stmts _ _ _ _) thing_inside
+rnStmt ctxt (L _ (RecStmt { recS_stmts = rec_stmts })) thing_inside
   = do { checkRecStmt ctxt
-       ; rn_rec_stmts_and_then rec_stmts       $ \ segs -> do
-       { (thing, fvs) <- thing_inside
+
+       -- Step1: Bring all the binders of the mdo into scope
+       -- (Remember that this also removes the binders from the
+       -- finally-returned free-vars.)
+       -- And rename each individual stmt, making a
+       -- singleton segment.  At this stage the FwdRefs field
+       -- isn't finished: it's empty for all except a BindStmt
+       -- for which it's the fwd refs within the bind itself
+       -- (This set may not be empty, because we're in a recursive 
+       -- context.)
+        ; rn_rec_stmts_and_then rec_stmts      $ \ segs -> do
+
+       { (thing, fvs_later) <- thing_inside
+       ; (return_op, fvs1)  <- lookupSyntaxName returnMName
+       ; (mfix_op,   fvs2)  <- lookupSyntaxName mfixName
+       ; (bind_op,   fvs3)  <- lookupSyntaxName bindMName
        ; let
+               -- Step 2: Fill in the fwd refs.
+               --         The segments are all singletons, but their fwd-ref
+               --         field mentions all the things used by the segment
+               --         that are bound after their use
            segs_w_fwd_refs          = addFwdRefs segs
-           (ds, us, fs, rec_stmts') = unzip4 segs_w_fwd_refs
-           later_vars = nameSetToList (plusFVs ds `intersectNameSet` fvs)
-           fwd_vars   = nameSetToList (plusFVs fs)
-           uses       = plusFVs us
-           rec_stmt   = RecStmt rec_stmts' later_vars fwd_vars [] emptyLHsBinds
-       ; return ((rec_stmt, thing), uses `plusFV` fvs) } }
-
-rnStmt ctxt (ParStmt segs) thing_inside
+
+               -- Step 3: Group together the segments to make bigger segments
+               --         Invariant: in the result, no segment uses a variable
+               --                    bound in a later segment
+           grouped_segs = glomSegments segs_w_fwd_refs
+
+               -- Step 4: Turn the segments into Stmts
+               --         Use RecStmt when and only when there are fwd refs
+               --         Also gather up the uses from the end towards the
+               --         start, so we can tell the RecStmt which things are
+               --         used 'after' the RecStmt
+           empty_rec_stmt = emptyRecStmt { recS_ret_fn  = return_op
+                                          , recS_mfix_fn = mfix_op
+                                          , recS_bind_fn = bind_op }
+           (rec_stmts', fvs) = segsToStmts empty_rec_stmt grouped_segs fvs_later
+
+       ; return ((rec_stmts', thing), fvs `plusFV` fvs1 `plusFV` fvs2 `plusFV` fvs3) } }
+
+rnStmt ctxt (L loc (ParStmt segs)) thing_inside
   = do { checkParStmt ctxt
        ; ((segs', thing), fvs) <- rnParallelStmts (ParStmtCtxt ctxt) segs thing_inside
-       ; return ((ParStmt segs', thing), fvs) }
+       ; return (([L loc (ParStmt segs')], thing), fvs) }
 
-rnStmt ctxt (TransformStmt (stmts, _) usingExpr maybeByExpr) thing_inside = do
+rnStmt ctxt (L loc (TransformStmt (stmts, _) usingExpr maybeByExpr)) thing_inside = do
     checkTransformStmt ctxt
     
     (usingExpr', fv_usingExpr) <- rnLExpr usingExpr
@@ -685,14 +732,15 @@ rnStmt ctxt (TransformStmt (stmts, _) usingExpr maybeByExpr) thing_inside = do
             
             return ((maybeByExpr', thing), fv_maybeByExpr `plusFV` fv_thing)
     
-    return ((TransformStmt (stmts', binders) usingExpr' maybeByExpr', thing), fv_usingExpr `plusFV` fvs)
+    return (([L loc (TransformStmt (stmts', binders) usingExpr' maybeByExpr')], thing), 
+             fv_usingExpr `plusFV` fvs)
   where
     rnMaybeLExpr Nothing = return (Nothing, emptyFVs)
     rnMaybeLExpr (Just expr) = do
         (expr', fv_expr) <- rnLExpr expr
         return (Just expr', fv_expr)
         
-rnStmt ctxt (GroupStmt (stmts, _) groupByClause) thing_inside = do
+rnStmt ctxt (L loc (GroupStmt (stmts, _) groupByClause)) thing_inside = do
     checkTransformStmt ctxt
     
     -- We must rename the using expression in the context before the transform is begun
@@ -749,7 +797,7 @@ rnStmt ctxt (GroupStmt (stmts, _) groupByClause) thing_inside = do
             return ((groupByClause', usedBinderMap, thing), fv_groupByClause `plusFV` real_fv_thing)
     
     traceRn (text "rnStmt: implicitly rebound these used binders:" <+> ppr usedBinderMap)
-    return ((GroupStmt (stmts', usedBinderMap) groupByClause', thing), fvs)
+    return (([L loc (GroupStmt (stmts', usedBinderMap) groupByClause')], thing), fvs)
   
 rnNormalStmtsAndFindUsedBinders :: HsStmtContext Name 
           -> [LStmt RdrName]
@@ -792,9 +840,9 @@ rnParallelStmts ctxt segs thing_inside = do
     where
         go orig_lcl_env bndrs [] = do 
             let (bndrs', dups) = removeDups cmpByOcc bndrs
-                inner_env = extendLocalRdrEnv orig_lcl_env bndrs'
+                inner_env = extendLocalRdrEnvList orig_lcl_env bndrs'
             
-            mapM dupErr dups
+            mapM_ dupErr dups
             (thing, fvs) <- setLocalRdrEnv inner_env thing_inside
             return (([], thing), fvs)
 
@@ -836,39 +884,12 @@ rnMDoStmts :: [LStmt RdrName]
           -> RnM (thing, FreeVars)
           -> RnM (([LStmt Name], thing), FreeVars)     
 rnMDoStmts stmts thing_inside
-  =    -- Step1: Bring all the binders of the mdo into scope
-       -- (Remember that this also removes the binders from the
-       -- finally-returned free-vars.)
-       -- And rename each individual stmt, making a
-       -- singleton segment.  At this stage the FwdRefs field
-       -- isn't finished: it's empty for all except a BindStmt
-       -- for which it's the fwd refs within the bind itself
-       -- (This set may not be empty, because we're in a recursive 
-       -- context.)
-     rn_rec_stmts_and_then stmts $ \ segs -> do {
-
-       ; (thing, fvs_later) <- thing_inside
-
-       ; let
-       -- Step 2: Fill in the fwd refs.
-       --         The segments are all singletons, but their fwd-ref
-       --         field mentions all the things used by the segment
-       --         that are bound after their use
-           segs_w_fwd_refs = addFwdRefs segs
-
-       -- Step 3: Group together the segments to make bigger segments
-       --         Invariant: in the result, no segment uses a variable
-       --                    bound in a later segment
+  = rn_rec_stmts_and_then stmts $ \ segs -> do
+    { (thing, fvs_later) <- thing_inside
+    ; let   segs_w_fwd_refs = addFwdRefs segs
            grouped_segs = glomSegments segs_w_fwd_refs
-
-       -- Step 4: Turn the segments into Stmts
-       --         Use RecStmt when and only when there are fwd refs
-       --         Also gather up the uses from the end towards the
-       --         start, so we can tell the RecStmt which things are
-       --         used 'after' the RecStmt
-           (stmts', fvs) = segsToStmts grouped_segs fvs_later
-
-       ; return ((stmts', thing), fvs) }
+           (stmts', fvs) = segsToStmts emptyRecStmt grouped_segs fvs_later
+    ; return ((stmts', thing), fvs) }
 
 ---------------------------------------------
 
@@ -935,7 +956,8 @@ rn_rec_stmt_lhs fix_env (L loc (LetStmt (HsValBinds binds)))
                  emptyFVs
                  )]
 
-rn_rec_stmt_lhs fix_env (L _ (RecStmt stmts _ _ _ _))  -- Flatten Rec inside Rec
+-- XXX Do we need to do something with the return and mfix names?
+rn_rec_stmt_lhs fix_env (L _ (RecStmt { recS_stmts = stmts })) -- Flatten Rec inside Rec
     = rn_rec_stmts_lhs fix_env stmts
 
 rn_rec_stmt_lhs _ stmt@(L _ (ParStmt _))       -- Syntactically illegal in mdo
@@ -998,16 +1020,16 @@ rn_rec_stmt all_bndrs (L loc (LetStmt (HsValBinds binds'))) _ = do
            emptyNameSet, L loc (LetStmt (HsValBinds binds')))]
 
 -- no RecStmt case becuase they get flattened above when doing the LHSes
-rn_rec_stmt _ stmt@(L _ (RecStmt _ _ _ _ _)) _ 
+rn_rec_stmt _ stmt@(L _ (RecStmt {})) _
   = pprPanic "rn_rec_stmt: RecStmt" (ppr stmt)
 
-rn_rec_stmt _ stmt@(L _ (ParStmt _)) _ -- Syntactically illegal in mdo
+rn_rec_stmt _ stmt@(L _ (ParStmt {})) _        -- Syntactically illegal in mdo
   = pprPanic "rn_rec_stmt: ParStmt" (ppr stmt)
 
-rn_rec_stmt _ stmt@(L _ (TransformStmt _ _ _)) _       -- Syntactically illegal in mdo
+rn_rec_stmt _ stmt@(L _ (TransformStmt {})) _  -- Syntactically illegal in mdo
   = pprPanic "rn_rec_stmt: TransformStmt" (ppr stmt)
 
-rn_rec_stmt _ stmt@(L _ (GroupStmt _ _)) _     -- Syntactically illegal in mdo
+rn_rec_stmt _ stmt@(L _ (GroupStmt {})) _      -- Syntactically illegal in mdo
   = pprPanic "rn_rec_stmt: GroupStmt" (ppr stmt)
 
 rn_rec_stmt _ (L _ (LetStmt EmptyLocalBinds)) _
@@ -1098,23 +1120,24 @@ glomSegments ((defs,uses,fwds,stmt) : segs)
 
 
 ----------------------------------------------------
-segsToStmts :: [Segment [LStmt Name]] 
+segsToStmts :: Stmt Name               -- A RecStmt with the SyntaxOps filled in
+            -> [Segment [LStmt Name]] 
            -> FreeVars                 -- Free vars used 'later'
            -> ([LStmt Name], FreeVars)
 
-segsToStmts [] fvs_later = ([], fvs_later)
-segsToStmts ((defs, uses, fwds, ss) : segs) fvs_later
+segsToStmts _ [] fvs_later = ([], fvs_later)
+segsToStmts empty_rec_stmt ((defs, uses, fwds, ss) : segs) fvs_later
   = ASSERT( not (null ss) )
     (new_stmt : later_stmts, later_uses `plusFV` uses)
   where
-    (later_stmts, later_uses) = segsToStmts segs fvs_later
+    (later_stmts, later_uses) = segsToStmts empty_rec_stmt segs fvs_later
     new_stmt | non_rec  = head ss
-            | otherwise = L (getLoc (head ss)) $ 
-                          RecStmt ss (nameSetToList used_later) (nameSetToList fwds) 
-                                     [] emptyLHsBinds
-            where
-              non_rec    = isSingleton ss && isEmptyNameSet fwds
-              used_later = defs `intersectNameSet` later_uses
+            | otherwise = L (getLoc (head ss)) rec_stmt 
+    rec_stmt = empty_rec_stmt { recS_stmts     = ss
+                              , recS_later_ids = nameSetToList used_later
+                              , recS_rec_ids   = nameSetToList fwds }
+    non_rec    = isSingleton ss && isEmptyNameSet fwds
+    used_later = defs `intersectNameSet` later_uses
                                -- The ones needed after the RecStmt
 \end{code}
 
@@ -1165,10 +1188,7 @@ checkLetStmt _ctxt            _binds            = return ()
 ---------
 checkRecStmt :: HsStmtContext Name -> RnM ()
 checkRecStmt (MDoExpr {}) = return ()  -- Recursive stmt ok in 'mdo'
-checkRecStmt (DoExpr {})  = return ()  -- ..and in 'do' but only because of arrows:
-                                       --   proc x -> do { ...rec... }
-                                       -- We don't have enough context to distinguish this situation here
-                                       --      so we leave it to the type checker
+checkRecStmt (DoExpr {})  = return ()  -- and in 'do'
 checkRecStmt ctxt        = addErr msg
   where
     msg = ptext (sLit "Illegal 'rec' stmt in") <+> pprStmtContext ctxt
@@ -1194,7 +1214,15 @@ checkTransformStmt (TransformStmtCtxt ctxt) = checkTransformStmt ctxt    -- Ok to n
 checkTransformStmt ctxt = addErr msg
   where
     msg = ptext (sLit "Illegal transform or grouping in") <+> pprStmtContext ctxt
-    
+
+---------
+checkTupleSection :: [HsTupArg RdrName] -> RnM ()
+checkTupleSection args
+  = do { tuple_section <- doptM Opt_TupleSections
+       ; checkErr (all tupArgPresent args || tuple_section) msg }
+  where
+    msg = ptext (sLit "Illegal tuple section: use -XTupleSections")
+
 ---------
 sectionErr :: HsExpr RdrName -> SDoc
 sectionErr expr