2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 \section[RnExpr]{Renaming of expressions}
6 Basically dependency analysis.
8 Handles @Match@, @GRHSs@, @HsExpr@, and @Qualifier@ datatypes. In
9 general, all of these functions return a renamed thing, and a set of
14 rnLExpr, rnExpr, rnStmts
17 #include "HsVersions.h"
19 import RnSource ( rnSrcDecls, rnSplice, checkTH )
20 import RnBinds ( rnLocalBindsAndThen, rnValBinds,
21 rnMatchGroup, trimWith )
26 import OccName ( plusOccEnv )
27 import RnNames ( getLocalDeclBinders, extendRdrEnvRn )
28 import RnTypes ( rnHsTypeFVs, rnLPat, rnOverLit, rnPatsAndThen, rnLit,
29 mkOpFormRn, mkOpAppRn, mkNegAppRn, checkSectionPrec,
30 dupFieldErr, checkTupSize )
31 import DynFlags ( DynFlag(..) )
32 import BasicTypes ( FixityDirection(..) )
33 import SrcLoc ( SrcSpan )
34 import PrelNames ( thFAKE, hasKey, assertIdKey, assertErrorName,
35 loopAName, choiceAName, appAName, arrAName, composeAName, firstAName,
36 negateName, thenMName, bindMName, failMName )
37 #if defined(GHCI) && defined(BREAKPOINT)
38 import PrelNames ( breakpointJumpName, breakpointCondJumpName
39 , undefined_RDR, breakpointIdKey, breakpointCondIdKey )
40 import UniqFM ( eltsUFM )
41 import DynFlags ( GhcMode(..) )
42 import Name ( isTyVarName )
44 import Name ( Name, nameOccName, nameIsLocalOrFrom )
46 import RdrName ( RdrName, emptyGlobalRdrEnv, extendLocalRdrEnv, lookupLocalRdrEnv )
47 import LoadIface ( loadInterfaceForName )
48 import UniqFM ( isNullUFM )
49 import UniqSet ( emptyUniqSet )
51 import Util ( isSingleton )
52 import ListSetOps ( removeDups )
53 import Maybes ( expectJust )
55 import SrcLoc ( Located(..), unLoc, getLoc, cmpLocated )
58 import List ( unzip4 )
62 %************************************************************************
64 \subsubsection{Expressions}
66 %************************************************************************
69 rnExprs :: [LHsExpr RdrName] -> RnM ([LHsExpr Name], FreeVars)
70 rnExprs ls = rnExprs' ls emptyUniqSet
72 rnExprs' [] acc = returnM ([], acc)
73 rnExprs' (expr:exprs) acc
74 = rnLExpr expr `thenM` \ (expr', fvExpr) ->
76 -- Now we do a "seq" on the free vars because typically it's small
77 -- or empty, especially in very long lists of constants
79 acc' = acc `plusFV` fvExpr
81 (grubby_seqNameSet acc' rnExprs') exprs acc' `thenM` \ (exprs', fvExprs) ->
82 returnM (expr':exprs', fvExprs)
84 -- Grubby little function to do "seq" on namesets; replace by proper seq when GHC can do seq
85 grubby_seqNameSet ns result | isNullUFM ns = result
89 Variables. We look up the variable and return the resulting name.
92 rnLExpr :: LHsExpr RdrName -> RnM (LHsExpr Name, FreeVars)
93 rnLExpr = wrapLocFstM rnExpr
95 rnExpr :: HsExpr RdrName -> RnM (HsExpr Name, FreeVars)
98 = do name <- lookupOccRn v
99 localRdrEnv <- getLocalRdrEnv
101 ignore_asserts <- doptM Opt_IgnoreAsserts
102 ignore_breakpoints <- doptM Opt_IgnoreBreakpoints
103 ghcMode <- getGhcMode
104 let conds = [ (name `hasKey` assertIdKey
105 && not ignore_asserts,
106 do (e, fvs) <- mkAssertErrorExpr
107 return (e, fvs `addOneFV` name))
108 #if defined(GHCI) && defined(BREAKPOINT)
109 , (name `hasKey` breakpointIdKey
110 && not ignore_breakpoints
111 && ghcMode == Interactive,
112 do let isWantedName = not.isTyVarName
113 (e, fvs) <- mkBreakpointExpr (filter isWantedName (eltsUFM localRdrEnv))
114 return (e, fvs `addOneFV` name)
116 , (name `hasKey` breakpointCondIdKey
117 && not ignore_breakpoints
118 && ghcMode == Interactive,
119 do let isWantedName = not.isTyVarName
120 (e, fvs) <- mkBreakpointCondExpr (filter isWantedName (eltsUFM localRdrEnv))
121 return (e, fvs `addOneFV` name)
125 case lookup True conds of
126 Just action -> action
127 Nothing -> return (HsVar name, unitFV name)
130 = newIPNameRn v `thenM` \ name ->
131 returnM (HsIPVar name, emptyFVs)
135 returnM (HsLit lit, emptyFVs)
137 rnExpr (HsOverLit lit)
138 = rnOverLit lit `thenM` \ (lit', fvs) ->
139 returnM (HsOverLit lit', fvs)
141 rnExpr (HsApp fun arg)
142 = rnLExpr fun `thenM` \ (fun',fvFun) ->
143 rnLExpr arg `thenM` \ (arg',fvArg) ->
144 returnM (HsApp fun' arg', fvFun `plusFV` fvArg)
146 rnExpr (OpApp e1 op _ e2)
147 = rnLExpr e1 `thenM` \ (e1', fv_e1) ->
148 rnLExpr e2 `thenM` \ (e2', fv_e2) ->
149 rnLExpr op `thenM` \ (op'@(L _ (HsVar op_name)), fv_op) ->
152 -- When renaming code synthesised from "deriving" declarations
153 -- we used to avoid fixity stuff, but we can't easily tell any
154 -- more, so I've removed the test. Adding HsPars in TcGenDeriv
155 -- should prevent bad things happening.
156 lookupFixityRn op_name `thenM` \ fixity ->
157 mkOpAppRn e1' op' fixity e2' `thenM` \ final_e ->
160 fv_e1 `plusFV` fv_op `plusFV` fv_e2)
163 = rnLExpr e `thenM` \ (e', fv_e) ->
164 lookupSyntaxName negateName `thenM` \ (neg_name, fv_neg) ->
165 mkNegAppRn e' neg_name `thenM` \ final_e ->
166 returnM (final_e, fv_e `plusFV` fv_neg)
169 = rnLExpr e `thenM` \ (e', fvs_e) ->
170 returnM (HsPar e', fvs_e)
172 -- Template Haskell extensions
173 -- Don't ifdef-GHCI them because we want to fail gracefully
174 -- (not with an rnExpr crash) in a stage-1 compiler.
175 rnExpr e@(HsBracket br_body)
176 = checkTH e "bracket" `thenM_`
177 rnBracket br_body `thenM` \ (body', fvs_e) ->
178 returnM (HsBracket body', fvs_e)
180 rnExpr e@(HsSpliceE splice)
181 = rnSplice splice `thenM` \ (splice', fvs) ->
182 returnM (HsSpliceE splice', fvs)
184 rnExpr section@(SectionL expr op)
185 = rnLExpr expr `thenM` \ (expr', fvs_expr) ->
186 rnLExpr op `thenM` \ (op', fvs_op) ->
187 checkSectionPrec InfixL section op' expr' `thenM_`
188 returnM (SectionL expr' op', fvs_op `plusFV` fvs_expr)
190 rnExpr section@(SectionR op expr)
191 = rnLExpr op `thenM` \ (op', fvs_op) ->
192 rnLExpr expr `thenM` \ (expr', fvs_expr) ->
193 checkSectionPrec InfixR section op' expr' `thenM_`
194 returnM (SectionR op' expr', fvs_op `plusFV` fvs_expr)
196 rnExpr (HsCoreAnn ann expr)
197 = rnLExpr expr `thenM` \ (expr', fvs_expr) ->
198 returnM (HsCoreAnn ann expr', fvs_expr)
200 rnExpr (HsSCC lbl expr)
201 = rnLExpr expr `thenM` \ (expr', fvs_expr) ->
202 returnM (HsSCC lbl expr', fvs_expr)
204 rnExpr (HsLam matches)
205 = rnMatchGroup LambdaExpr matches `thenM` \ (matches', fvMatch) ->
206 returnM (HsLam matches', fvMatch)
208 rnExpr (HsCase expr matches)
209 = rnLExpr expr `thenM` \ (new_expr, e_fvs) ->
210 rnMatchGroup CaseAlt matches `thenM` \ (new_matches, ms_fvs) ->
211 returnM (HsCase new_expr new_matches, e_fvs `plusFV` ms_fvs)
213 rnExpr (HsLet binds expr)
214 = rnLocalBindsAndThen binds $ \ binds' ->
215 rnLExpr expr `thenM` \ (expr',fvExpr) ->
216 returnM (HsLet binds' expr', fvExpr)
218 rnExpr e@(HsDo do_or_lc stmts body _)
219 = do { ((stmts', body'), fvs) <- rnStmts do_or_lc stmts $
221 ; return (HsDo do_or_lc stmts' body' placeHolderType, fvs) }
223 rnExpr (ExplicitList _ exps)
224 = rnExprs exps `thenM` \ (exps', fvs) ->
225 returnM (ExplicitList placeHolderType exps', fvs `addOneFV` listTyCon_name)
227 rnExpr (ExplicitPArr _ exps)
228 = rnExprs exps `thenM` \ (exps', fvs) ->
229 returnM (ExplicitPArr placeHolderType exps', fvs)
231 rnExpr e@(ExplicitTuple exps boxity)
232 = checkTupSize tup_size `thenM_`
233 rnExprs exps `thenM` \ (exps', fvs) ->
234 returnM (ExplicitTuple exps' boxity, fvs `addOneFV` tycon_name)
236 tup_size = length exps
237 tycon_name = tupleTyCon_name boxity tup_size
239 rnExpr (RecordCon con_id _ rbinds)
240 = lookupLocatedOccRn con_id `thenM` \ conname ->
241 rnRbinds "construction" rbinds `thenM` \ (rbinds', fvRbinds) ->
242 returnM (RecordCon conname noPostTcExpr rbinds',
243 fvRbinds `addOneFV` unLoc conname)
245 rnExpr (RecordUpd expr rbinds _ _)
246 = rnLExpr expr `thenM` \ (expr', fvExpr) ->
247 rnRbinds "update" rbinds `thenM` \ (rbinds', fvRbinds) ->
248 returnM (RecordUpd expr' rbinds' placeHolderType placeHolderType,
249 fvExpr `plusFV` fvRbinds)
251 rnExpr (ExprWithTySig expr pty)
252 = rnLExpr expr `thenM` \ (expr', fvExpr) ->
253 rnHsTypeFVs doc pty `thenM` \ (pty', fvTy) ->
254 returnM (ExprWithTySig expr' pty', fvExpr `plusFV` fvTy)
256 doc = text "In an expression type signature"
258 rnExpr (HsIf p b1 b2)
259 = rnLExpr p `thenM` \ (p', fvP) ->
260 rnLExpr b1 `thenM` \ (b1', fvB1) ->
261 rnLExpr b2 `thenM` \ (b2', fvB2) ->
262 returnM (HsIf p' b1' b2', plusFVs [fvP, fvB1, fvB2])
265 = rnHsTypeFVs doc a `thenM` \ (t, fvT) ->
266 returnM (HsType t, fvT)
268 doc = text "In a type argument"
270 rnExpr (ArithSeq _ seq)
271 = rnArithSeq seq `thenM` \ (new_seq, fvs) ->
272 returnM (ArithSeq noPostTcExpr new_seq, fvs)
274 rnExpr (PArrSeq _ seq)
275 = rnArithSeq seq `thenM` \ (new_seq, fvs) ->
276 returnM (PArrSeq noPostTcExpr new_seq, fvs)
279 These three are pattern syntax appearing in expressions.
280 Since all the symbols are reservedops we can simply reject them.
281 We return a (bogus) EWildPat in each case.
284 rnExpr e@EWildPat = patSynErr e
285 rnExpr e@(EAsPat {}) = patSynErr e
286 rnExpr e@(ELazyPat {}) = patSynErr e
289 %************************************************************************
293 %************************************************************************
296 rnExpr (HsProc pat body)
298 rnPatsAndThen ProcExpr [pat] $ \ [pat'] ->
299 rnCmdTop body `thenM` \ (body',fvBody) ->
300 returnM (HsProc pat' body', fvBody)
302 rnExpr (HsArrApp arrow arg _ ho rtl)
303 = select_arrow_scope (rnLExpr arrow) `thenM` \ (arrow',fvArrow) ->
304 rnLExpr arg `thenM` \ (arg',fvArg) ->
305 returnM (HsArrApp arrow' arg' placeHolderType ho rtl,
306 fvArrow `plusFV` fvArg)
308 select_arrow_scope tc = case ho of
309 HsHigherOrderApp -> tc
310 HsFirstOrderApp -> escapeArrowScope tc
313 rnExpr (HsArrForm op (Just _) [arg1, arg2])
314 = escapeArrowScope (rnLExpr op)
315 `thenM` \ (op'@(L _ (HsVar op_name)),fv_op) ->
316 rnCmdTop arg1 `thenM` \ (arg1',fv_arg1) ->
317 rnCmdTop arg2 `thenM` \ (arg2',fv_arg2) ->
321 lookupFixityRn op_name `thenM` \ fixity ->
322 mkOpFormRn arg1' op' fixity arg2' `thenM` \ final_e ->
325 fv_arg1 `plusFV` fv_op `plusFV` fv_arg2)
327 rnExpr (HsArrForm op fixity cmds)
328 = escapeArrowScope (rnLExpr op) `thenM` \ (op',fvOp) ->
329 rnCmdArgs cmds `thenM` \ (cmds',fvCmds) ->
330 returnM (HsArrForm op' fixity cmds', fvOp `plusFV` fvCmds)
332 rnExpr other = pprPanic "rnExpr: unexpected expression" (ppr other)
333 -- DictApp, DictLam, TyApp, TyLam
337 %************************************************************************
341 %************************************************************************
344 rnCmdArgs [] = returnM ([], emptyFVs)
346 = rnCmdTop arg `thenM` \ (arg',fvArg) ->
347 rnCmdArgs args `thenM` \ (args',fvArgs) ->
348 returnM (arg':args', fvArg `plusFV` fvArgs)
351 rnCmdTop = wrapLocFstM rnCmdTop'
353 rnCmdTop' (HsCmdTop cmd _ _ _)
354 = rnLExpr (convertOpFormsLCmd cmd) `thenM` \ (cmd', fvCmd) ->
356 cmd_names = [arrAName, composeAName, firstAName] ++
357 nameSetToList (methodNamesCmd (unLoc cmd'))
359 -- Generate the rebindable syntax for the monad
360 lookupSyntaxTable cmd_names `thenM` \ (cmd_names', cmd_fvs) ->
362 returnM (HsCmdTop cmd' [] placeHolderType cmd_names',
363 fvCmd `plusFV` cmd_fvs)
365 ---------------------------------------------------
366 -- convert OpApp's in a command context to HsArrForm's
368 convertOpFormsLCmd :: LHsCmd id -> LHsCmd id
369 convertOpFormsLCmd = fmap convertOpFormsCmd
371 convertOpFormsCmd :: HsCmd id -> HsCmd id
373 convertOpFormsCmd (HsApp c e) = HsApp (convertOpFormsLCmd c) e
374 convertOpFormsCmd (HsLam match) = HsLam (convertOpFormsMatch match)
375 convertOpFormsCmd (OpApp c1 op fixity c2)
377 arg1 = L (getLoc c1) $ HsCmdTop (convertOpFormsLCmd c1) [] placeHolderType []
378 arg2 = L (getLoc c2) $ HsCmdTop (convertOpFormsLCmd c2) [] placeHolderType []
380 HsArrForm op (Just fixity) [arg1, arg2]
382 convertOpFormsCmd (HsPar c) = HsPar (convertOpFormsLCmd c)
385 convertOpFormsCmd (HsCase exp matches)
386 = HsCase exp (convertOpFormsMatch matches)
388 convertOpFormsCmd (HsIf exp c1 c2)
389 = HsIf exp (convertOpFormsLCmd c1) (convertOpFormsLCmd c2)
391 convertOpFormsCmd (HsLet binds cmd)
392 = HsLet binds (convertOpFormsLCmd cmd)
394 convertOpFormsCmd (HsDo ctxt stmts body ty)
395 = HsDo ctxt (map (fmap convertOpFormsStmt) stmts)
396 (convertOpFormsLCmd body) ty
398 -- Anything else is unchanged. This includes HsArrForm (already done),
399 -- things with no sub-commands, and illegal commands (which will be
400 -- caught by the type checker)
401 convertOpFormsCmd c = c
403 convertOpFormsStmt (BindStmt pat cmd _ _)
404 = BindStmt pat (convertOpFormsLCmd cmd) noSyntaxExpr noSyntaxExpr
405 convertOpFormsStmt (ExprStmt cmd _ _)
406 = ExprStmt (convertOpFormsLCmd cmd) noSyntaxExpr placeHolderType
407 convertOpFormsStmt (RecStmt stmts lvs rvs es binds)
408 = RecStmt (map (fmap convertOpFormsStmt) stmts) lvs rvs es binds
409 convertOpFormsStmt stmt = stmt
411 convertOpFormsMatch (MatchGroup ms ty)
412 = MatchGroup (map (fmap convert) ms) ty
413 where convert (Match pat mty grhss)
414 = Match pat mty (convertOpFormsGRHSs grhss)
416 convertOpFormsGRHSs (GRHSs grhss binds)
417 = GRHSs (map convertOpFormsGRHS grhss) binds
419 convertOpFormsGRHS = fmap convert
421 convert (GRHS stmts cmd) = GRHS stmts (convertOpFormsLCmd cmd)
423 ---------------------------------------------------
424 type CmdNeeds = FreeVars -- Only inhabitants are
425 -- appAName, choiceAName, loopAName
427 -- find what methods the Cmd needs (loop, choice, apply)
428 methodNamesLCmd :: LHsCmd Name -> CmdNeeds
429 methodNamesLCmd = methodNamesCmd . unLoc
431 methodNamesCmd :: HsCmd Name -> CmdNeeds
433 methodNamesCmd cmd@(HsArrApp _arrow _arg _ HsFirstOrderApp _rtl)
435 methodNamesCmd cmd@(HsArrApp _arrow _arg _ HsHigherOrderApp _rtl)
437 methodNamesCmd cmd@(HsArrForm {}) = emptyFVs
439 methodNamesCmd (HsPar c) = methodNamesLCmd c
441 methodNamesCmd (HsIf p c1 c2)
442 = methodNamesLCmd c1 `plusFV` methodNamesLCmd c2 `addOneFV` choiceAName
444 methodNamesCmd (HsLet b c) = methodNamesLCmd c
446 methodNamesCmd (HsDo sc stmts body ty)
447 = methodNamesStmts stmts `plusFV` methodNamesLCmd body
449 methodNamesCmd (HsApp c e) = methodNamesLCmd c
451 methodNamesCmd (HsLam match) = methodNamesMatch match
453 methodNamesCmd (HsCase scrut matches)
454 = methodNamesMatch matches `addOneFV` choiceAName
456 methodNamesCmd other = emptyFVs
457 -- Other forms can't occur in commands, but it's not convenient
458 -- to error here so we just do what's convenient.
459 -- The type checker will complain later
461 ---------------------------------------------------
462 methodNamesMatch (MatchGroup ms _)
463 = plusFVs (map do_one ms)
465 do_one (L _ (Match pats sig_ty grhss)) = methodNamesGRHSs grhss
467 -------------------------------------------------
469 methodNamesGRHSs (GRHSs grhss binds) = plusFVs (map methodNamesGRHS grhss)
471 -------------------------------------------------
472 methodNamesGRHS (L _ (GRHS stmts rhs)) = methodNamesLCmd rhs
474 ---------------------------------------------------
475 methodNamesStmts stmts = plusFVs (map methodNamesLStmt stmts)
477 ---------------------------------------------------
478 methodNamesLStmt = methodNamesStmt . unLoc
480 methodNamesStmt (ExprStmt cmd _ _) = methodNamesLCmd cmd
481 methodNamesStmt (BindStmt pat cmd _ _) = methodNamesLCmd cmd
482 methodNamesStmt (RecStmt stmts _ _ _ _)
483 = methodNamesStmts stmts `addOneFV` loopAName
484 methodNamesStmt (LetStmt b) = emptyFVs
485 methodNamesStmt (ParStmt ss) = emptyFVs
486 -- ParStmt can't occur in commands, but it's not convenient to error
487 -- here so we just do what's convenient
491 %************************************************************************
495 %************************************************************************
498 rnArithSeq (From expr)
499 = rnLExpr expr `thenM` \ (expr', fvExpr) ->
500 returnM (From expr', fvExpr)
502 rnArithSeq (FromThen expr1 expr2)
503 = rnLExpr expr1 `thenM` \ (expr1', fvExpr1) ->
504 rnLExpr expr2 `thenM` \ (expr2', fvExpr2) ->
505 returnM (FromThen expr1' expr2', fvExpr1 `plusFV` fvExpr2)
507 rnArithSeq (FromTo expr1 expr2)
508 = rnLExpr expr1 `thenM` \ (expr1', fvExpr1) ->
509 rnLExpr expr2 `thenM` \ (expr2', fvExpr2) ->
510 returnM (FromTo expr1' expr2', fvExpr1 `plusFV` fvExpr2)
512 rnArithSeq (FromThenTo expr1 expr2 expr3)
513 = rnLExpr expr1 `thenM` \ (expr1', fvExpr1) ->
514 rnLExpr expr2 `thenM` \ (expr2', fvExpr2) ->
515 rnLExpr expr3 `thenM` \ (expr3', fvExpr3) ->
516 returnM (FromThenTo expr1' expr2' expr3',
517 plusFVs [fvExpr1, fvExpr2, fvExpr3])
521 %************************************************************************
523 \subsubsection{@Rbinds@s and @Rpats@s: in record expressions}
525 %************************************************************************
529 = mappM_ field_dup_err dup_fields `thenM_`
530 mapFvRn rn_rbind rbinds `thenM` \ (rbinds', fvRbind) ->
531 returnM (rbinds', fvRbind)
533 (_, dup_fields) = removeDups cmpLocated [ f | (f,_) <- rbinds ]
535 field_dup_err dups = mappM_ (\f -> addLocErr f (dupFieldErr str)) dups
537 rn_rbind (field, expr)
538 = lookupLocatedGlobalOccRn field `thenM` \ fieldname ->
539 rnLExpr expr `thenM` \ (expr', fvExpr) ->
540 returnM ((fieldname, expr'), fvExpr `addOneFV` unLoc fieldname)
543 %************************************************************************
545 Template Haskell brackets
547 %************************************************************************
550 rnBracket (VarBr n) = do { name <- lookupOccRn n
551 ; this_mod <- getModule
552 ; checkM (nameIsLocalOrFrom this_mod name) $ -- Reason: deprecation checking asumes the
553 do { loadInterfaceForName msg name -- home interface is loaded, and this is the
554 ; return () } -- only way that is going to happen
555 ; returnM (VarBr name, unitFV name) }
557 msg = ptext SLIT("Need interface for Template Haskell quoted Name")
559 rnBracket (ExpBr e) = do { (e', fvs) <- rnLExpr e
560 ; return (ExpBr e', fvs) }
561 rnBracket (PatBr p) = do { (p', fvs) <- rnLPat p
562 ; return (PatBr p', fvs) }
563 rnBracket (TypBr t) = do { (t', fvs) <- rnHsTypeFVs doc t
564 ; return (TypBr t', fvs) }
566 doc = ptext SLIT("In a Template-Haskell quoted type")
567 rnBracket (DecBr group)
568 = do { gbl_env <- getGblEnv
570 ; let gbl_env1 = gbl_env { tcg_mod = thFAKE }
571 -- Note the thFAKE. The top-level names from the bracketed
572 -- declarations will go into the name cache, and we don't want them to
573 -- confuse the Names for the current module.
574 -- By using a pretend module, thFAKE, we keep them safely out of the way.
576 ; names <- getLocalDeclBinders gbl_env1 group
577 ; rdr_env' <- extendRdrEnvRn emptyGlobalRdrEnv names
578 -- Furthermore, the names in the bracket shouldn't conflict with
579 -- existing top-level names E.g.
581 -- bar = [d| foo = 1|]
582 -- But both 'foo's get a LocalDef provenance, so we'd get a complaint unless
583 -- we start with an emptyGlobalRdrEnv
585 ; setGblEnv (gbl_env { tcg_rdr_env = tcg_rdr_env gbl_env1 `plusOccEnv` rdr_env',
586 tcg_dus = emptyDUs }) $ do
587 -- Notice plusOccEnv, not plusGlobalRdrEnv. In this situation we want
588 -- to *shadow* top-level bindings. (See the 'foo' example above.)
589 -- If we don't shadow, we'll get an ambiguity complaint when we do
590 -- a lookupTopBndrRn (which uses lookupGreLocalRn) on the binder of the 'foo'
592 -- Furthermore, arguably if the splice does define foo, that should hide
593 -- any foo's further out
595 -- The emptyDUs is so that we just collect uses for this group alone
597 { (tcg_env, group') <- rnSrcDecls group
598 -- Discard the tcg_env; it contains only extra info about fixity
599 ; return (DecBr group', allUses (tcg_dus tcg_env)) } }
602 %************************************************************************
604 \subsubsection{@Stmt@s: in @do@ expressions}
606 %************************************************************************
609 rnStmts :: HsStmtContext Name -> [LStmt RdrName]
610 -> RnM (thing, FreeVars)
611 -> RnM (([LStmt Name], thing), FreeVars)
613 rnStmts (MDoExpr _) = rnMDoStmts
614 rnStmts ctxt = rnNormalStmts ctxt
616 rnNormalStmts :: HsStmtContext Name -> [LStmt RdrName]
617 -> RnM (thing, FreeVars)
618 -> RnM (([LStmt Name], thing), FreeVars)
619 -- Used for cases *other* than recursive mdo
620 -- Implements nested scopes
622 rnNormalStmts ctxt [] thing_inside
623 = do { (thing, fvs) <- thing_inside
624 ; return (([],thing), fvs) }
626 rnNormalStmts ctxt (L loc stmt : stmts) thing_inside
627 = do { ((stmt', (stmts', thing)), fvs)
628 <- rnStmt ctxt stmt $
629 rnNormalStmts ctxt stmts thing_inside
630 ; return (((L loc stmt' : stmts'), thing), fvs) }
632 rnStmt :: HsStmtContext Name -> Stmt RdrName
633 -> RnM (thing, FreeVars)
634 -> RnM ((Stmt Name, thing), FreeVars)
636 rnStmt ctxt (ExprStmt expr _ _) thing_inside
637 = do { (expr', fv_expr) <- rnLExpr expr
638 ; (then_op, fvs1) <- lookupSyntaxName thenMName
639 ; (thing, fvs2) <- thing_inside
640 ; return ((ExprStmt expr' then_op placeHolderType, thing),
641 fv_expr `plusFV` fvs1 `plusFV` fvs2) }
643 rnStmt ctxt (BindStmt pat expr _ _) thing_inside
644 = do { (expr', fv_expr) <- rnLExpr expr
645 -- The binders do not scope over the expression
646 ; (bind_op, fvs1) <- lookupSyntaxName bindMName
647 ; (fail_op, fvs2) <- lookupSyntaxName failMName
648 ; rnPatsAndThen (StmtCtxt ctxt) [pat] $ \ [pat'] -> do
649 { (thing, fvs3) <- thing_inside
650 ; return ((BindStmt pat' expr' bind_op fail_op, thing),
651 fv_expr `plusFV` fvs1 `plusFV` fvs2 `plusFV` fvs3) }}
652 -- fv_expr shouldn't really be filtered by the rnPatsAndThen
653 -- but it does not matter because the names are unique
655 rnStmt ctxt (LetStmt binds) thing_inside
656 = do { checkErr (ok ctxt binds)
657 (badIpBinds (ptext SLIT("a parallel list comprehension:")) binds)
658 ; rnLocalBindsAndThen binds $ \ binds' -> do
659 { (thing, fvs) <- thing_inside
660 ; return ((LetStmt binds', thing), fvs) }}
662 -- We do not allow implicit-parameter bindings in a parallel
663 -- list comprehension. I'm not sure what it might mean.
664 ok (ParStmtCtxt _) (HsIPBinds _) = False
667 rnStmt ctxt (RecStmt rec_stmts _ _ _ _) thing_inside
668 = bindLocatedLocalsRn doc (collectLStmtsBinders rec_stmts) $ \ bndrs ->
669 rn_rec_stmts bndrs rec_stmts `thenM` \ segs ->
670 thing_inside `thenM` \ (thing, fvs) ->
672 segs_w_fwd_refs = addFwdRefs segs
673 (ds, us, fs, rec_stmts') = unzip4 segs_w_fwd_refs
674 later_vars = nameSetToList (plusFVs ds `intersectNameSet` fvs)
675 fwd_vars = nameSetToList (plusFVs fs)
677 rec_stmt = RecStmt rec_stmts' later_vars fwd_vars [] emptyLHsBinds
679 returnM ((rec_stmt, thing), uses `plusFV` fvs)
681 doc = text "In a recursive do statement"
683 rnStmt ctxt (ParStmt segs) thing_inside
684 = do { opt_GlasgowExts <- doptM Opt_GlasgowExts
685 ; checkM opt_GlasgowExts parStmtErr
686 ; orig_lcl_env <- getLocalRdrEnv
687 ; ((segs',thing), fvs) <- go orig_lcl_env [] segs
688 ; return ((ParStmt segs', thing), fvs) }
690 -- type ParSeg id = [([LStmt id], [id])]
691 -- go :: NameSet -> [ParSeg RdrName]
692 -- -> RnM (([ParSeg Name], thing), FreeVars)
694 go orig_lcl_env bndrs []
695 = do { let { (bndrs', dups) = removeDups cmpByOcc bndrs
696 ; inner_env = extendLocalRdrEnv orig_lcl_env bndrs' }
698 ; (thing, fvs) <- setLocalRdrEnv inner_env thing_inside
699 ; return (([], thing), fvs) }
701 go orig_lcl_env bndrs_so_far ((stmts, _) : segs)
702 = do { ((stmts', (bndrs, segs', thing)), fvs)
703 <- rnNormalStmts par_ctxt stmts $ do
704 { -- Find the Names that are bound by stmts
705 lcl_env <- getLocalRdrEnv
706 ; let { rdr_bndrs = collectLStmtsBinders stmts
707 ; bndrs = map ( expectJust "rnStmt"
708 . lookupLocalRdrEnv lcl_env
710 ; new_bndrs = nub bndrs ++ bndrs_so_far
711 -- The nub is because there might be shadowing
713 -- So we'll look up (Unqual x) twice, getting
714 -- the second binding both times, which is the
717 -- Typecheck the thing inside, passing on all
718 -- the Names bound, but separately; revert the envt
719 ; ((segs', thing), fvs) <- setLocalRdrEnv orig_lcl_env $
720 go orig_lcl_env new_bndrs segs
722 -- Figure out which of the bound names are used
723 ; let used_bndrs = filter (`elemNameSet` fvs) bndrs
724 ; return ((used_bndrs, segs', thing), fvs) }
726 ; let seg' = (stmts', bndrs)
727 ; return (((seg':segs'), thing),
728 delListFromNameSet fvs bndrs) }
730 par_ctxt = ParStmtCtxt ctxt
732 cmpByOcc n1 n2 = nameOccName n1 `compare` nameOccName n2
733 dupErr vs = addErr (ptext SLIT("Duplicate binding in parallel list comprehension for:")
734 <+> quotes (ppr (head vs)))
738 %************************************************************************
740 \subsubsection{mdo expressions}
742 %************************************************************************
745 type FwdRefs = NameSet
746 type Segment stmts = (Defs,
747 Uses, -- May include defs
748 FwdRefs, -- A subset of uses that are
749 -- (a) used before they are bound in this segment, or
750 -- (b) used here, and bound in subsequent segments
751 stmts) -- Either Stmt or [Stmt]
754 ----------------------------------------------------
755 rnMDoStmts :: [LStmt RdrName]
756 -> RnM (thing, FreeVars)
757 -> RnM (([LStmt Name], thing), FreeVars)
758 rnMDoStmts stmts thing_inside
759 = -- Step1: bring all the binders of the mdo into scope
760 -- Remember that this also removes the binders from the
761 -- finally-returned free-vars
762 bindLocatedLocalsRn doc (collectLStmtsBinders stmts) $ \ bndrs ->
764 -- Step 2: Rename each individual stmt, making a
765 -- singleton segment. At this stage the FwdRefs field
766 -- isn't finished: it's empty for all except a BindStmt
767 -- for which it's the fwd refs within the bind itself
768 -- (This set may not be empty, because we're in a recursive
770 segs <- rn_rec_stmts bndrs stmts
772 ; (thing, fvs_later) <- thing_inside
775 -- Step 3: Fill in the fwd refs.
776 -- The segments are all singletons, but their fwd-ref
777 -- field mentions all the things used by the segment
778 -- that are bound after their use
779 segs_w_fwd_refs = addFwdRefs segs
781 -- Step 4: Group together the segments to make bigger segments
782 -- Invariant: in the result, no segment uses a variable
783 -- bound in a later segment
784 grouped_segs = glomSegments segs_w_fwd_refs
786 -- Step 5: Turn the segments into Stmts
787 -- Use RecStmt when and only when there are fwd refs
788 -- Also gather up the uses from the end towards the
789 -- start, so we can tell the RecStmt which things are
790 -- used 'after' the RecStmt
791 (stmts', fvs) = segsToStmts grouped_segs fvs_later
793 ; return ((stmts', thing), fvs) }
795 doc = text "In a recursive mdo-expression"
797 ---------------------------------------------
798 rn_rec_stmts :: [Name] -> [LStmt RdrName] -> RnM [Segment (LStmt Name)]
799 rn_rec_stmts bndrs stmts = mappM (rn_rec_stmt bndrs) stmts `thenM` \ segs_s ->
800 returnM (concat segs_s)
802 ----------------------------------------------------
803 rn_rec_stmt :: [Name] -> LStmt RdrName -> RnM [Segment (LStmt Name)]
804 -- Rename a Stmt that is inside a RecStmt (or mdo)
805 -- Assumes all binders are already in scope
806 -- Turns each stmt into a singleton Stmt
808 rn_rec_stmt all_bndrs (L loc (ExprStmt expr _ _))
809 = rnLExpr expr `thenM` \ (expr', fvs) ->
810 lookupSyntaxName thenMName `thenM` \ (then_op, fvs1) ->
811 returnM [(emptyNameSet, fvs `plusFV` fvs1, emptyNameSet,
812 L loc (ExprStmt expr' then_op placeHolderType))]
814 rn_rec_stmt all_bndrs (L loc (BindStmt pat expr _ _))
815 = rnLExpr expr `thenM` \ (expr', fv_expr) ->
816 rnLPat pat `thenM` \ (pat', fv_pat) ->
817 lookupSyntaxName bindMName `thenM` \ (bind_op, fvs1) ->
818 lookupSyntaxName failMName `thenM` \ (fail_op, fvs2) ->
820 bndrs = mkNameSet (collectPatBinders pat')
821 fvs = fv_expr `plusFV` fv_pat `plusFV` fvs1 `plusFV` fvs2
823 returnM [(bndrs, fvs, bndrs `intersectNameSet` fvs,
824 L loc (BindStmt pat' expr' bind_op fail_op))]
826 rn_rec_stmt all_bndrs (L loc (LetStmt binds@(HsIPBinds _)))
827 = do { addErr (badIpBinds (ptext SLIT("an mdo expression")) binds)
830 rn_rec_stmt all_bndrs (L loc (LetStmt (HsValBinds binds)))
831 = rnValBinds (trimWith all_bndrs) binds `thenM` \ (binds', du_binds) ->
832 returnM [(duDefs du_binds, duUses du_binds,
833 emptyNameSet, L loc (LetStmt (HsValBinds binds')))]
835 rn_rec_stmt all_bndrs (L loc (RecStmt stmts _ _ _ _)) -- Flatten Rec inside Rec
836 = rn_rec_stmts all_bndrs stmts
838 rn_rec_stmt all_bndrs stmt@(L _ (ParStmt _)) -- Syntactically illegal in mdo
839 = pprPanic "rn_rec_stmt" (ppr stmt)
841 ---------------------------------------------
842 addFwdRefs :: [Segment a] -> [Segment a]
843 -- So far the segments only have forward refs *within* the Stmt
844 -- (which happens for bind: x <- ...x...)
845 -- This function adds the cross-seg fwd ref info
848 = fst (foldr mk_seg ([], emptyNameSet) pairs)
850 mk_seg (defs, uses, fwds, stmts) (segs, later_defs)
851 = (new_seg : segs, all_defs)
853 new_seg = (defs, uses, new_fwds, stmts)
854 all_defs = later_defs `unionNameSets` defs
855 new_fwds = fwds `unionNameSets` (uses `intersectNameSet` later_defs)
856 -- Add the downstream fwd refs here
858 ----------------------------------------------------
859 -- Glomming the singleton segments of an mdo into
860 -- minimal recursive groups.
862 -- At first I thought this was just strongly connected components, but
863 -- there's an important constraint: the order of the stmts must not change.
866 -- mdo { x <- ...y...
873 -- Here, the first stmt mention 'y', which is bound in the third.
874 -- But that means that the innocent second stmt (p <- z) gets caught
875 -- up in the recursion. And that in turn means that the binding for
876 -- 'z' has to be included... and so on.
878 -- Start at the tail { r <- x }
879 -- Now add the next one { z <- y ; r <- x }
880 -- Now add one more { q <- x ; z <- y ; r <- x }
881 -- Now one more... but this time we have to group a bunch into rec
882 -- { rec { y <- ...x... ; q <- x ; z <- y } ; r <- x }
883 -- Now one more, which we can add on without a rec
885 -- rec { y <- ...x... ; q <- x ; z <- y } ;
887 -- Finally we add the last one; since it mentions y we have to
888 -- glom it togeher with the first two groups
889 -- { rec { x <- ...y...; p <- z ; y <- ...x... ;
890 -- q <- x ; z <- y } ;
893 glomSegments :: [Segment (LStmt Name)] -> [Segment [LStmt Name]]
896 glomSegments ((defs,uses,fwds,stmt) : segs)
897 -- Actually stmts will always be a singleton
898 = (seg_defs, seg_uses, seg_fwds, seg_stmts) : others
900 segs' = glomSegments segs
901 (extras, others) = grab uses segs'
902 (ds, us, fs, ss) = unzip4 extras
904 seg_defs = plusFVs ds `plusFV` defs
905 seg_uses = plusFVs us `plusFV` uses
906 seg_fwds = plusFVs fs `plusFV` fwds
907 seg_stmts = stmt : concat ss
909 grab :: NameSet -- The client
911 -> ([Segment a], -- Needed by the 'client'
912 [Segment a]) -- Not needed by the client
913 -- The result is simply a split of the input
915 = (reverse yeses, reverse noes)
917 (noes, yeses) = span not_needed (reverse dus)
918 not_needed (defs,_,_,_) = not (intersectsNameSet defs uses)
921 ----------------------------------------------------
922 segsToStmts :: [Segment [LStmt Name]]
923 -> FreeVars -- Free vars used 'later'
924 -> ([LStmt Name], FreeVars)
926 segsToStmts [] fvs_later = ([], fvs_later)
927 segsToStmts ((defs, uses, fwds, ss) : segs) fvs_later
928 = ASSERT( not (null ss) )
929 (new_stmt : later_stmts, later_uses `plusFV` uses)
931 (later_stmts, later_uses) = segsToStmts segs fvs_later
932 new_stmt | non_rec = head ss
933 | otherwise = L (getLoc (head ss)) $
934 RecStmt ss (nameSetToList used_later) (nameSetToList fwds)
937 non_rec = isSingleton ss && isEmptyNameSet fwds
938 used_later = defs `intersectNameSet` later_uses
939 -- The ones needed after the RecStmt
942 %************************************************************************
944 \subsubsection{breakpoint utils}
946 %************************************************************************
949 #if defined(GHCI) && defined(BREAKPOINT)
950 mkBreakpointExpr :: [Name] -> RnM (HsExpr Name, FreeVars)
951 mkBreakpointExpr = mkBreakpointExpr' breakpointJumpName
953 mkBreakpointCondExpr :: [Name] -> RnM (HsExpr Name, FreeVars)
954 mkBreakpointCondExpr = mkBreakpointExpr' breakpointCondJumpName
956 mkBreakpointExpr' :: Name -> [Name] -> RnM (HsExpr Name, FreeVars)
957 mkBreakpointExpr' breakpointFunc scope
958 = do sloc <- getSrcSpanM
959 undef <- lookupOccRn undefined_RDR
961 lHsApp x y = inLoc (HsApp x y)
962 mkExpr fnName args = mkExpr' fnName (reverse args)
963 mkExpr' fnName [] = inLoc (HsVar fnName)
964 mkExpr' fnName (arg:args)
965 = lHsApp (mkExpr' fnName args) (inLoc arg)
966 expr = unLoc $ mkExpr breakpointFunc [mkScopeArg scope, HsVar undef, msg]
967 mkScopeArg args = unLoc $ mkExpr undef (map HsVar args)
968 msg = srcSpanLit sloc
969 return (expr, emptyFVs)
972 srcSpanLit :: SrcSpan -> HsExpr Name
973 srcSpanLit span = HsLit (HsString (mkFastString (showSDoc (ppr span))))
976 %************************************************************************
978 \subsubsection{Assertion utils}
980 %************************************************************************
983 mkAssertErrorExpr :: RnM (HsExpr Name, FreeVars)
984 -- Return an expression for (assertError "Foo.hs:27")
986 = getSrcSpanM `thenM` \ sloc ->
988 expr = HsApp (L sloc (HsVar assertErrorName))
989 (L sloc (srcSpanLit sloc))
991 returnM (expr, emptyFVs)
994 %************************************************************************
996 \subsubsection{Errors}
998 %************************************************************************
1001 patSynErr e = do { addErr (sep [ptext SLIT("Pattern syntax in expression context:"),
1003 ; return (EWildPat, emptyFVs) }
1005 parStmtErr = addErr (ptext SLIT("Illegal parallel list comprehension: use -fglasgow-exts"))
1007 badIpBinds what binds
1008 = hang (ptext SLIT("Implicit-parameter bindings illegal in") <+> what)