2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 \section[RnBinds]{Renaming and dependency analysis of bindings}
6 This module does renaming and dependency analysis on value bindings in
7 the abstract syntax. It does {\em not} do cycle-checks on class or
8 type-synonym declarations; those cannot be done at this stage because
9 they may be affected by renaming (which isn't fully worked out yet).
12 module RnBinds (rnTopBinds, rnTopBindsLHS, rnTopBindsRHS, -- use these for top-level bindings
13 rnLocalBindsAndThen, rnValBindsLHS, rnValBindsRHS, -- or these for local bindings
14 rnMethodBinds, renameSigs, mkSigTvFn,
15 rnMatchGroup, rnGRHSs,
16 makeMiniFixityEnv, MiniFixityEnv
19 import {-# SOURCE #-} RnExpr( rnLExpr, rnStmts )
25 import RnTypes ( rnHsSigType, rnLHsType, checkPrecMatch)
26 import RnPat (rnPatsAndThen_LocalRightwards, rnBindPat,
27 NameMaker, localRecNameMaker, topRecNameMaker, applyNameMaker
31 import PrelNames ( mkUnboundName )
32 import DynFlags ( DynFlag(..) )
36 import RdrName ( RdrName, rdrNameOcc )
38 import ListSetOps ( findDupsEq )
39 import BasicTypes ( RecFlag(..) )
40 import Digraph ( SCC(..), stronglyConnCompFromEdgedVertices )
44 import Data.List ( partition )
45 import Maybes ( orElse )
46 import Monad ( foldM, unless )
49 -- ToDo: Put the annotations into the monad, so that they arrive in the proper
50 -- place and can be used when complaining.
52 The code tree received by the function @rnBinds@ contains definitions
53 in where-clauses which are all apparently mutually recursive, but which may
54 not really depend upon each other. For example, in the top level program
59 the definitions of @a@ and @y@ do not depend on each other at all.
60 Unfortunately, the typechecker cannot always check such definitions.
61 \footnote{Mycroft, A. 1984. Polymorphic type schemes and recursive
62 definitions. In Proceedings of the International Symposium on Programming,
63 Toulouse, pp. 217-39. LNCS 167. Springer Verlag.}
64 However, the typechecker usually can check definitions in which only the
65 strongly connected components have been collected into recursive bindings.
66 This is precisely what the function @rnBinds@ does.
68 ToDo: deal with case where a single monobinds binds the same variable
71 The vertag tag is a unique @Int@; the tags only need to be unique
72 within one @MonoBinds@, so that unique-Int plumbing is done explicitly
73 (heavy monad machinery not needed).
76 %************************************************************************
78 %* naming conventions *
80 %************************************************************************
82 \subsection[name-conventions]{Name conventions}
84 The basic algorithm involves walking over the tree and returning a tuple
85 containing the new tree plus its free variables. Some functions, such
86 as those walking polymorphic bindings (HsBinds) and qualifier lists in
87 list comprehensions (@Quals@), return the variables bound in local
88 environments. These are then used to calculate the free variables of the
89 expression evaluated in these environments.
91 Conventions for variable names are as follows:
94 new code is given a prime to distinguish it from the old.
97 a set of variables defined in @Exp@ is written @dvExp@
100 a set of variables free in @Exp@ is written @fvExp@
103 %************************************************************************
105 %* analysing polymorphic bindings (HsBindGroup, HsBind)
107 %************************************************************************
109 \subsubsection[dep-HsBinds]{Polymorphic bindings}
111 Non-recursive expressions are reconstructed without any changes at top
112 level, although their component expressions may have to be altered.
113 However, non-recursive expressions are currently not expected as
114 \Haskell{} programs, and this code should not be executed.
116 Monomorphic bindings contain information that is returned in a tuple
117 (a @FlatMonoBinds@) containing:
121 a unique @Int@ that serves as the ``vertex tag'' for this binding.
124 the name of a function or the names in a pattern. These are a set
125 referred to as @dvLhs@, the defined variables of the left hand side.
128 the free variables of the body. These are referred to as @fvBody@.
131 the definition's actual code. This is referred to as just @code@.
134 The function @nonRecDvFv@ returns two sets of variables. The first is
135 the set of variables defined in the set of monomorphic bindings, while the
136 second is the set of free variables in those bindings.
138 The set of variables defined in a non-recursive binding is just the
139 union of all of them, as @union@ removes duplicates. However, the
140 free variables in each successive set of cumulative bindings is the
141 union of those in the previous set plus those of the newest binding after
142 the defined variables of the previous set have been removed.
144 @rnMethodBinds@ deals only with the declarations in class and
145 instance declarations. It expects only to see @FunMonoBind@s, and
146 it expects the global environment to contain bindings for the binders
147 (which are all class operations).
149 %************************************************************************
151 \subsubsection{ Top-level bindings}
153 %************************************************************************
156 -- for top-level bindings, we need to make top-level names,
157 -- so we have a different entry point than for local bindings
158 rnTopBindsLHS :: MiniFixityEnv
159 -> HsValBinds RdrName
160 -> RnM (HsValBindsLR Name RdrName)
161 rnTopBindsLHS fix_env binds =
162 (uncurry $ rnValBindsLHSFromDoc (topRecNameMaker fix_env)) (bindersAndDoc binds) binds
164 rnTopBindsRHS :: [Name] -- the names bound by these binds
165 -> HsValBindsLR Name RdrName
166 -> RnM (HsValBinds Name, DefUses)
167 rnTopBindsRHS bound_names binds =
168 do { is_boot <- tcIsHsBoot
170 then rnTopBindsBoot binds
171 else rnValBindsRHSGen (\x -> x) -- don't trim free vars
175 -- wrapper if we don't need to do anything in between the left and right,
176 -- or anything else in the scope of the left
178 -- never used when there are fixity declarations
179 rnTopBinds :: HsValBinds RdrName
180 -> RnM (HsValBinds Name, DefUses)
182 do nl <- rnTopBindsLHS emptyFsEnv b
183 let bound_names = map unLoc (collectHsValBinders nl)
184 bindLocalNames bound_names $ rnTopBindsRHS bound_names nl
187 rnTopBindsBoot :: HsValBindsLR Name RdrName -> RnM (HsValBinds Name, DefUses)
188 -- A hs-boot file has no bindings.
189 -- Return a single HsBindGroup with empty binds and renamed signatures
190 rnTopBindsBoot (ValBindsIn mbinds sigs)
191 = do { checkErr (isEmptyLHsBinds mbinds) (bindsInHsBootFile mbinds)
192 ; sigs' <- renameSigs Nothing okHsBootSig sigs
193 ; return (ValBindsOut [] sigs', usesOnly (hsSigsFVs sigs')) }
194 rnTopBindsBoot b = pprPanic "rnTopBindsBoot" (ppr b)
199 %*********************************************************
203 %*********************************************************
206 rnLocalBindsAndThen :: HsLocalBinds RdrName
207 -> (HsLocalBinds Name -> RnM (result, FreeVars))
208 -> RnM (result, FreeVars)
209 -- This version (a) assumes that the binding vars are *not* already in scope
210 -- (b) removes the binders from the free vars of the thing inside
211 -- The parser doesn't produce ThenBinds
212 rnLocalBindsAndThen EmptyLocalBinds thing_inside
213 = thing_inside EmptyLocalBinds
215 rnLocalBindsAndThen (HsValBinds val_binds) thing_inside
216 = rnValBindsAndThen val_binds $ \ val_binds' ->
217 thing_inside (HsValBinds val_binds')
219 rnLocalBindsAndThen (HsIPBinds binds) thing_inside = do
220 (binds',fv_binds) <- rnIPBinds binds
221 (thing, fvs_thing) <- thing_inside (HsIPBinds binds')
222 return (thing, fvs_thing `plusFV` fv_binds)
224 rnIPBinds :: HsIPBinds RdrName -> RnM (HsIPBinds Name, FreeVars)
225 rnIPBinds (IPBinds ip_binds _no_dict_binds) = do
226 (ip_binds', fvs_s) <- mapAndUnzipM (wrapLocFstM rnIPBind) ip_binds
227 return (IPBinds ip_binds' emptyLHsBinds, plusFVs fvs_s)
229 rnIPBind :: IPBind RdrName -> RnM (IPBind Name, FreeVars)
230 rnIPBind (IPBind n expr) = do
231 name <- newIPNameRn n
232 (expr',fvExpr) <- rnLExpr expr
233 return (IPBind name expr', fvExpr)
237 %************************************************************************
241 %************************************************************************
244 -- wrapper for local binds
245 -- creates the documentation info and calls the helper below
246 rnValBindsLHS :: MiniFixityEnv
247 -> HsValBinds RdrName
248 -> RnM (HsValBindsLR Name RdrName)
249 rnValBindsLHS fix_env binds =
250 let (boundNames,doc) = bindersAndDoc binds
251 in rnValBindsLHSFromDoc_Local boundNames doc fix_env binds
253 -- a helper used for local binds that does the duplicates check,
254 -- just so we don't forget to do it somewhere
255 rnValBindsLHSFromDoc_Local :: [Located RdrName] -- RdrNames of the LHS (so we don't have to gather them twice)
256 -> SDoc -- doc string for dup names and shadowing
258 -> HsValBinds RdrName
259 -> RnM (HsValBindsLR Name RdrName)
261 rnValBindsLHSFromDoc_Local boundNames doc fix_env binds = do
262 -- Do error checking: we need to check for dups here because we
263 -- don't don't bind all of the variables from the ValBinds at once
264 -- with bindLocatedLocals any more.
265 checkDupAndShadowedRdrNames doc boundNames
267 -- (Note that we don't want to do this at the top level, since
268 -- sorting out duplicates and shadowing there happens elsewhere.
269 -- The behavior is even different. For example,
272 -- should not produce a shadowing warning (but it will produce
273 -- an ambiguity warning if you use f), but
275 -- g = let f = ... in f
277 rnValBindsLHSFromDoc (localRecNameMaker fix_env) boundNames doc binds
279 bindersAndDoc :: HsValBinds RdrName -> ([Located RdrName], SDoc)
280 bindersAndDoc binds =
282 -- the unrenamed bndrs for error checking and reporting
283 orig = collectHsValBinders binds
284 doc = text "In the binding group for:" <+> pprWithCommas ppr (map unLoc orig)
288 -- renames the left-hand sides
289 -- generic version used both at the top level and for local binds
290 -- does some error checking, but not what gets done elsewhere at the top level
291 rnValBindsLHSFromDoc :: NameMaker
292 -> [Located RdrName] -- RdrNames of the LHS (so we don't have to gather them twice)
293 -> SDoc -- doc string for dup names and shadowing
294 -> HsValBinds RdrName
295 -> RnM (HsValBindsLR Name RdrName)
296 rnValBindsLHSFromDoc topP _original_bndrs doc (ValBindsIn mbinds sigs) = do
298 mbinds' <- mapBagM (rnBindLHS topP doc) mbinds
299 return $ ValBindsIn mbinds' sigs
300 rnValBindsLHSFromDoc _ _ _ b = pprPanic "rnValBindsLHSFromDoc" (ppr b)
302 -- General version used both from the top-level and for local things
303 -- Assumes the LHS vars are in scope
305 -- Does not bind the local fixity declarations
306 rnValBindsRHSGen :: (FreeVars -> FreeVars) -- for trimming free var sets
307 -- The trimming function trims the free vars we attach to a
308 -- binding so that it stays reasonably small
309 -> [Name] -- names bound by the LHSes
310 -> HsValBindsLR Name RdrName
311 -> RnM (HsValBinds Name, DefUses)
313 rnValBindsRHSGen trim bound_names (ValBindsIn mbinds sigs) = do
316 traceRn (ptext (sLit "Rename sigs") <+> ppr (tcg_rdr_env env))
317 sigs' <- renameSigs (Just (mkNameSet bound_names)) okBindSig sigs
319 binds_w_dus <- mapBagM (rnBind (mkSigTvFn sigs') trim) mbinds
320 let (anal_binds, anal_dus) = depAnalBinds binds_w_dus
321 (valbind', valbind'_dus) = (ValBindsOut anal_binds sigs',
322 usesOnly (hsSigsFVs sigs') `plusDU` anal_dus)
323 return (valbind', valbind'_dus)
325 rnValBindsRHSGen _ _ b = pprPanic "rnValBindsRHSGen" (ppr b)
327 -- Wrapper for local binds
329 -- The *client* of this function is responsible for checking for unused binders;
330 -- it doesn't (and can't: we don't have the thing inside the binds) happen here
332 -- The client is also responsible for bringing the fixities into scope
333 rnValBindsRHS :: [Name] -- names bound by the LHSes
334 -> HsValBindsLR Name RdrName
335 -> RnM (HsValBinds Name, DefUses)
336 rnValBindsRHS bound_names binds =
337 rnValBindsRHSGen (\ fvs -> -- only keep the names the names from this group
338 intersectNameSet (mkNameSet bound_names) fvs) bound_names binds
342 -- wrapper that does both the left- and right-hand sides
344 -- here there are no local fixity decls passed in;
345 -- the local fixity decls come from the ValBinds sigs
346 rnValBindsAndThen :: HsValBinds RdrName
347 -> (HsValBinds Name -> RnM (result, FreeVars))
348 -> RnM (result, FreeVars)
349 rnValBindsAndThen binds@(ValBindsIn _ sigs) thing_inside
350 = do { let (original_bndrs, doc) = bindersAndDoc binds
352 -- (A) Create the local fixity environment
353 ; new_fixities <- makeMiniFixityEnv [L loc sig | L loc (FixSig sig) <- sigs]
355 -- (B) Rename the LHSes
356 ; new_lhs <- rnValBindsLHSFromDoc_Local original_bndrs doc new_fixities binds
357 ; let bound_names = map unLoc $ collectHsValBinders new_lhs
359 -- ...and bring them (and their fixities) into scope
360 ; bindLocalNamesFV_WithFixities bound_names new_fixities $ do
362 { -- (C) Do the RHS and thing inside
363 (binds', dus) <- rnValBindsRHS bound_names new_lhs
364 ; (result, result_fvs) <- thing_inside binds'
366 -- Report unused bindings based on the (accurate)
369 -- should report 'x' unused
370 ; let real_uses = findUses dus result_fvs
371 ; warnUnusedLocalBinds bound_names real_uses
374 -- The variables "used" in the val binds are:
375 -- (1) the uses of the binds (duUses)
376 -- (2) the FVs of the thing-inside
377 all_uses = duUses dus `plusFV` result_fvs
378 -- Note [Unused binding hack]
379 -- ~~~~~~~~~~~~~~~~~~~~~~~~~~
380 -- Note that *in contrast* to the above reporting of
381 -- unused bindings, (1) above uses duUses to return *all*
382 -- the uses, even if the binding is unused. Otherwise consider:
384 -- y = let p = x in 'x' -- NB: p not used
385 -- If we don't "see" the dependency of 'y' on 'x', we may put the
386 -- bindings in the wrong order, and the type checker will complain
387 -- that x isn't in scope
389 -- But note that this means we won't report 'x' as unused,
390 -- whereas we would if we had { x = 3; p = x; y = 'x' }
392 ; return (result, all_uses) }}
393 -- The bound names are pruned out of all_uses
394 -- by the bindLocalNamesFV call above
396 rnValBindsAndThen bs _ = pprPanic "rnValBindsAndThen" (ppr bs)
399 -- Process the fixity declarations, making a FastString -> (Located Fixity) map
400 -- (We keep the location around for reporting duplicate fixity declarations.)
402 -- Checks for duplicates, but not that only locally defined things are fixed.
403 -- Note: for local fixity declarations, duplicates would also be checked in
404 -- check_sigs below. But we also use this function at the top level.
406 makeMiniFixityEnv :: [LFixitySig RdrName] -> RnM MiniFixityEnv
408 makeMiniFixityEnv decls = foldlM add_one emptyFsEnv decls
410 add_one env (L loc (FixitySig (L name_loc name) fixity)) = do
411 { -- this fixity decl is a duplicate iff
412 -- the ReaderName's OccName's FastString is already in the env
413 -- (we only need to check the local fix_env because
414 -- definitions of non-local will be caught elsewhere)
415 let { fs = occNameFS (rdrNameOcc name)
416 ; fix_item = L loc fixity };
418 case lookupFsEnv env fs of
419 Nothing -> return $ extendFsEnv env fs fix_item
420 Just (L loc' _) -> do
422 addLocErr (L name_loc name) (dupFixityDecl loc')
426 dupFixityDecl :: SrcSpan -> RdrName -> SDoc
427 dupFixityDecl loc rdr_name
428 = vcat [ptext (sLit "Multiple fixity declarations for") <+> quotes (ppr rdr_name),
429 ptext (sLit "also at ") <+> ppr loc]
431 ---------------------
433 -- renaming a single bind
435 rnBindLHS :: NameMaker
438 -- returns the renamed left-hand side,
439 -- and the FreeVars *of the LHS*
440 -- (i.e., any free variables of the pattern)
441 -> RnM (LHsBindLR Name RdrName)
443 rnBindLHS name_maker _ (L loc (PatBind { pat_lhs = pat,
445 pat_rhs_ty=pat_rhs_ty
447 = setSrcSpan loc $ do
448 -- we don't actually use the FV processing of rnPatsAndThen here
449 (pat',pat'_fvs) <- rnBindPat name_maker pat
450 return (L loc (PatBind { pat_lhs = pat',
452 -- we temporarily store the pat's FVs here;
453 -- gets updated to the FVs of the whole bind
454 -- when doing the RHS below
456 -- these will get ignored in the next pass,
457 -- when we rename the RHS
458 pat_rhs_ty = pat_rhs_ty }))
460 rnBindLHS name_maker _ (L loc (FunBind { fun_id = name@(L nameLoc _),
462 fun_matches = matches,
463 fun_co_fn = fun_co_fn,
467 do { (newname, _fvs) <- applyNameMaker name_maker name $ \ newname ->
468 return (newname, emptyFVs)
469 ; return (L loc (FunBind { fun_id = L nameLoc newname,
471 fun_matches = matches,
472 -- we temporatily store the LHS's FVs (empty in this case) here
473 -- gets updated when doing the RHS below
475 -- everything else will get ignored in the next pass
476 fun_co_fn = fun_co_fn,
480 rnBindLHS _ _ b = pprPanic "rnBindLHS" (ppr b)
482 -- assumes the left-hands-side vars are in scope
483 rnBind :: (Name -> [Name]) -- Signature tyvar function
484 -> (FreeVars -> FreeVars) -- Trimming function for rhs free vars
485 -> LHsBindLR Name RdrName
486 -> RnM (LHsBind Name, [Name], Uses)
487 rnBind _ trim (L loc (PatBind { pat_lhs = pat,
489 -- pat fvs were stored here while
490 -- processing the LHS
493 do {let bndrs = collectPatBinders pat
495 ; (grhss', fvs) <- rnGRHSs PatBindRhs grhss
496 -- No scoped type variables for pattern bindings
498 ; return (L loc (PatBind { pat_lhs = pat,
500 pat_rhs_ty = placeHolderType,
501 bind_fvs = trim fvs }),
502 bndrs, pat_fvs `plusFV` fvs) }
506 (L loc (FunBind { fun_id = name,
508 fun_matches = matches,
512 -- invariant: no free vars here when it's a FunBind
514 do { let plain_name = unLoc name
516 ; (matches', fvs) <- bindSigTyVarsFV (sig_fn plain_name) $
517 -- bindSigTyVars tests for Opt_ScopedTyVars
518 rnMatchGroup (FunRhs plain_name inf) matches
520 ; checkPrecMatch inf plain_name matches'
522 ; return (L loc (FunBind { fun_id = name,
524 fun_matches = matches',
526 fun_co_fn = idHsWrapper,
527 fun_tick = Nothing }),
531 rnBind _ _ b = pprPanic "rnBind" (ppr b)
533 ---------------------
534 depAnalBinds :: Bag (LHsBind Name, [Name], Uses)
535 -> ([(RecFlag, LHsBinds Name)], DefUses)
536 -- Dependency analysis; this is important so that
537 -- unused-binding reporting is accurate
538 depAnalBinds binds_w_dus
539 = (map get_binds sccs, map get_du sccs)
541 sccs = stronglyConnCompFromEdgedVertices edges
543 keyd_nodes = bagToList binds_w_dus `zip` [0::Int ..]
545 edges = [ (node, key, [key | n <- nameSetToList uses,
546 Just key <- [lookupNameEnv key_map n] ])
547 | (node@(_,_,uses), key) <- keyd_nodes ]
549 key_map :: NameEnv Int -- Which binding it comes from
550 key_map = mkNameEnv [(bndr, key) | ((_, bndrs, _), key) <- keyd_nodes
553 get_binds (AcyclicSCC (bind, _, _)) = (NonRecursive, unitBag bind)
554 get_binds (CyclicSCC binds_w_dus) = (Recursive, listToBag [b | (b,_,_) <- binds_w_dus])
556 get_du (AcyclicSCC (_, bndrs, uses)) = (Just (mkNameSet bndrs), uses)
557 get_du (CyclicSCC binds_w_dus) = (Just defs, uses)
559 defs = mkNameSet [b | (_,bs,_) <- binds_w_dus, b <- bs]
560 uses = unionManyNameSets [u | (_,_,u) <- binds_w_dus]
563 ---------------------
564 -- Bind the top-level forall'd type variables in the sigs.
567 -- The 'a' scopes over the rhs
569 -- NB: there'll usually be just one (for a function binding)
570 -- but if there are many, one may shadow the rest; too bad!
571 -- e.g x :: [a] -> [a]
574 -- In e, 'a' will be in scope, and it'll be the one from 'y'!
576 mkSigTvFn :: [LSig Name] -> (Name -> [Name])
577 -- Return a lookup function that maps an Id Name to the names
578 -- of the type variables that should scope over its body..
580 = \n -> lookupNameEnv env n `orElse` []
582 env :: NameEnv [Name]
583 env = mkNameEnv [ (name, map hsLTyVarName ltvs)
584 | L _ (TypeSig (L _ name)
585 (L _ (HsForAllTy Explicit ltvs _ _))) <- sigs]
586 -- Note the pattern-match on "Explicit"; we only bind
587 -- type variables from signatures with an explicit top-level for-all
591 @rnMethodBinds@ is used for the method bindings of a class and an instance
592 declaration. Like @rnBinds@ but without dependency analysis.
594 NOTA BENE: we record each {\em binder} of a method-bind group as a free variable.
595 That's crucial when dealing with an instance decl:
597 instance Foo (T a) where
600 This might be the {\em sole} occurrence of @op@ for an imported class @Foo@,
601 and unless @op@ occurs we won't treat the type signature of @op@ in the class
602 decl for @Foo@ as a source of instance-decl gates. But we should! Indeed,
603 in many ways the @op@ in an instance decl is just like an occurrence, not
607 rnMethodBinds :: Name -- Class name
608 -> (Name -> [Name]) -- Signature tyvar function
609 -> [Name] -- Names for generic type variables
611 -> RnM (LHsBinds Name, FreeVars)
613 rnMethodBinds cls sig_fn gen_tyvars binds
614 = foldM do_one (emptyBag,emptyFVs) (bagToList binds)
615 where do_one (binds,fvs) bind = do
616 (bind', fvs_bind) <- rnMethodBind cls sig_fn gen_tyvars bind
617 return (bind' `unionBags` binds, fvs_bind `plusFV` fvs)
622 -> LHsBindLR RdrName RdrName
623 -> RnM (Bag (LHsBindLR Name Name), FreeVars)
624 rnMethodBind cls sig_fn gen_tyvars (L loc (FunBind { fun_id = name, fun_infix = inf,
625 fun_matches = MatchGroup matches _ }))
626 = setSrcSpan loc $ do
627 sel_name <- lookupInstDeclBndr cls name
628 let plain_name = unLoc sel_name
629 -- We use the selector name as the binder
631 bindSigTyVarsFV (sig_fn plain_name) $ do
632 (new_matches, fvs) <- mapFvRn (rn_match plain_name) matches
634 new_group = MatchGroup new_matches placeHolderType
636 checkPrecMatch inf plain_name new_group
637 return (unitBag (L loc (FunBind {
638 fun_id = sel_name, fun_infix = inf,
639 fun_matches = new_group,
640 bind_fvs = fvs, fun_co_fn = idHsWrapper,
641 fun_tick = Nothing })),
642 fvs `addOneFV` plain_name)
643 -- The 'fvs' field isn't used for method binds
645 -- Truly gruesome; bring into scope the correct members of the generic
646 -- type variables. See comments in RnSource.rnSourceDecl(ClassDecl)
647 rn_match sel_name match@(L _ (Match (L _ (TypePat ty) : _) _ _))
648 = extendTyVarEnvFVRn gen_tvs $
649 rnMatch (FunRhs sel_name inf) match
651 tvs = map (rdrNameOcc.unLoc) (extractHsTyRdrTyVars ty)
652 gen_tvs = [tv | tv <- gen_tyvars, nameOccName tv `elem` tvs]
654 rn_match sel_name match = rnMatch (FunRhs sel_name inf) match
657 -- Can't handle method pattern-bindings which bind multiple methods.
658 rnMethodBind _ _ _ mbind@(L _ (PatBind _ _ _ _)) = do
659 addLocErr mbind methodBindErr
660 return (emptyBag, emptyFVs)
662 rnMethodBind _ _ _ b = pprPanic "rnMethodBind" (ppr b)
667 %************************************************************************
669 \subsubsection[dep-Sigs]{Signatures (and user-pragmas for values)}
671 %************************************************************************
673 @renameSigs@ checks for:
675 \item more than one sig for one thing;
676 \item signatures given for things not bound here;
679 At the moment we don't gather free-var info from the types in
680 signatures. We'd only need this if we wanted to report unused tyvars.
683 renameSigs :: Maybe NameSet -- If (Just ns) complain if the sig isn't for one of ns
684 -> (Sig RdrName -> Bool) -- Complain about the wrong kind of signature if this is False
687 -- Renames the signatures and performs error checks
688 renameSigs mb_names ok_sig sigs
689 = do { let (good_sigs, bad_sigs) = partition (ok_sig . unLoc) sigs
690 ; mapM_ unknownSigErr bad_sigs -- Misplaced
691 ; mapM_ dupSigDeclErr (findDupsEq eqHsSig sigs) -- Duplicate
692 ; sigs' <- mapM (wrapLocM (renameSig mb_names)) good_sigs
695 ----------------------
696 -- We use lookupSigOccRn in the signatures, which is a little bit unsatisfactory
697 -- because this won't work for:
698 -- instance Foo T where
701 -- We'll just rename the INLINE prag to refer to whatever other 'op'
702 -- is in scope. (I'm assuming that Baz.op isn't in scope unqualified.)
703 -- Doesn't seem worth much trouble to sort this.
705 renameSig :: Maybe NameSet -> Sig RdrName -> RnM (Sig Name)
706 -- FixitySig is renamed elsewhere.
707 renameSig mb_names sig@(TypeSig v ty)
708 = do { new_v <- lookupSigLocOccRn mb_names sig v
709 ; new_ty <- rnHsSigType (quotes (ppr v)) ty
710 ; return (TypeSig new_v new_ty) }
712 renameSig _ (SpecInstSig ty)
713 = do { new_ty <- rnLHsType (text "A SPECIALISE instance pragma") ty
714 ; return (SpecInstSig new_ty) }
716 renameSig mb_names sig@(SpecSig v ty inl)
717 = do { new_v <- lookupSigLocOccRn mb_names sig v
718 ; new_ty <- rnHsSigType (quotes (ppr v)) ty
719 ; return (SpecSig new_v new_ty inl) }
721 renameSig mb_names sig@(InlineSig v s)
722 = do { new_v <- lookupSigLocOccRn mb_names sig v
723 ; return (InlineSig new_v s) }
725 renameSig mb_names sig@(FixSig (FixitySig v f))
726 = do { new_v <- lookupSigLocOccRn mb_names sig v
727 ; return (FixSig (FixitySig new_v f)) }
729 -- lookupSigOccRn is used for type signatures and pragmas
735 -- It's clear that the 'f' in the signature must refer to A.f
736 -- The Haskell98 report does not stipulate this, but it will!
737 -- So we must treat the 'f' in the signature in the same way
738 -- as the binding occurrence of 'f', using lookupBndrRn
740 -- However, consider this case:
744 -- We don't want to say 'f' is out of scope; instead, we want to
745 -- return the imported 'f', so that later on the reanamer will
746 -- correctly report "misplaced type sig".
748 lookupSigLocOccRn :: Maybe NameSet -> Sig RdrName -> Located RdrName -> RnM (Located Name)
749 lookupSigLocOccRn mb_names sig = wrapLocM (lookupSigOccRn mb_names sig)
751 lookupSigOccRn :: Maybe NameSet -> Sig RdrName -> RdrName -> RnM Name
752 lookupSigOccRn mb_names sig v
753 = do { mb_n <- lookupBndrRn_maybe v
755 Just n -> case mb_names of {
756 Nothing -> return n ;
757 Just ns | n `elemNameSet` ns -> return n
758 | otherwise -> bale_out_with local_msg } ;
761 { mb_n <- lookupGreRn_maybe v
763 Just _ -> bale_out_with import_msg
764 Nothing -> bale_out_with empty
768 = do { addErr (sep [ ptext (sLit "The") <+> hsSigDoc sig
769 <+> ptext (sLit "for") <+> quotes (ppr v)
770 , nest 2 $ ptext (sLit "lacks an accompanying binding")]
772 ; return (mkUnboundName v) }
774 local_msg = parens $ ptext (sLit "The") <+> hsSigDoc sig <+> ptext (sLit "must be given where")
775 <+> quotes (ppr v) <+> ptext (sLit "is declared")
777 import_msg = parens $ ptext (sLit "You cannot give a") <+> hsSigDoc sig
778 <+> ptext (sLit "an imported value")
782 %************************************************************************
786 %************************************************************************
789 rnMatchGroup :: HsMatchContext Name -> MatchGroup RdrName -> RnM (MatchGroup Name, FreeVars)
790 rnMatchGroup ctxt (MatchGroup ms _) = do
791 (new_ms, ms_fvs) <- mapFvRn (rnMatch ctxt) ms
792 return (MatchGroup new_ms placeHolderType, ms_fvs)
794 rnMatch :: HsMatchContext Name -> LMatch RdrName -> RnM (LMatch Name, FreeVars)
795 rnMatch ctxt = wrapLocFstM (rnMatch' ctxt)
797 rnMatch' :: HsMatchContext Name -> Match RdrName -> RnM (Match Name, FreeVars)
798 rnMatch' ctxt match@(Match pats maybe_rhs_sig grhss)
799 = do { -- Result type signatures are no longer supported
800 case maybe_rhs_sig of
802 Just ty -> addLocErr ty (resSigErr ctxt match)
805 -- Now the main event
806 -- note that there are no local ficity decls for matches
807 ; rnPatsAndThen_LocalRightwards ctxt pats $ \ pats' -> do
808 { (grhss', grhss_fvs) <- rnGRHSs ctxt grhss
810 ; return (Match pats' Nothing grhss', grhss_fvs) }}
811 -- The bindPatSigTyVarsFV and rnPatsAndThen will remove the bound FVs
814 resSigErr :: HsMatchContext Name -> Match RdrName -> HsType RdrName -> SDoc
815 resSigErr ctxt match ty
816 = vcat [ ptext (sLit "Illegal result type signature") <+> quotes (ppr ty)
817 , nest 2 $ ptext (sLit "Result signatures are no longer supported in pattern matches")
818 , pprMatchInCtxt ctxt match ]
822 %************************************************************************
824 \subsubsection{Guarded right-hand sides (GRHSs)}
826 %************************************************************************
829 rnGRHSs :: HsMatchContext Name -> GRHSs RdrName -> RnM (GRHSs Name, FreeVars)
831 rnGRHSs ctxt (GRHSs grhss binds)
832 = rnLocalBindsAndThen binds $ \ binds' -> do
833 (grhss', fvGRHSs) <- mapFvRn (rnGRHS ctxt) grhss
834 return (GRHSs grhss' binds', fvGRHSs)
836 rnGRHS :: HsMatchContext Name -> LGRHS RdrName -> RnM (LGRHS Name, FreeVars)
837 rnGRHS ctxt = wrapLocFstM (rnGRHS' ctxt)
839 rnGRHS' :: HsMatchContext Name -> GRHS RdrName -> RnM (GRHS Name, FreeVars)
840 rnGRHS' ctxt (GRHS guards rhs)
841 = do { pattern_guards_allowed <- doptM Opt_PatternGuards
842 ; ((guards', rhs'), fvs) <- rnStmts (PatGuard ctxt) guards $
845 ; unless (pattern_guards_allowed || is_standard_guard guards')
846 (addWarn (nonStdGuardErr guards'))
848 ; return (GRHS guards' rhs', fvs) }
850 -- Standard Haskell 1.4 guards are just a single boolean
851 -- expression, rather than a list of qualifiers as in the
853 is_standard_guard [] = True
854 is_standard_guard [L _ (ExprStmt _ _ _)] = True
855 is_standard_guard _ = False
858 %************************************************************************
860 \subsection{Error messages}
862 %************************************************************************
865 dupSigDeclErr :: [LSig RdrName] -> RnM ()
866 dupSigDeclErr sigs@(L loc sig : _)
868 vcat [ptext (sLit "Duplicate") <+> what_it_is <> colon,
869 nest 2 (vcat (map ppr_sig sigs))]
871 what_it_is = hsSigDoc sig
872 ppr_sig (L loc sig) = ppr loc <> colon <+> ppr sig
873 dupSigDeclErr [] = panic "dupSigDeclErr"
875 unknownSigErr :: LSig RdrName -> RnM ()
876 unknownSigErr (L loc sig)
878 sep [ptext (sLit "Misplaced") <+> hsSigDoc sig <> colon, ppr sig]
880 methodBindErr :: HsBindLR RdrName RdrName -> SDoc
882 = hang (ptext (sLit "Pattern bindings (except simple variables) not allowed in instance declarations"))
885 bindsInHsBootFile :: LHsBindsLR Name RdrName -> SDoc
886 bindsInHsBootFile mbinds
887 = hang (ptext (sLit "Bindings in hs-boot files are not allowed"))
890 nonStdGuardErr :: [LStmtLR Name Name] -> SDoc
891 nonStdGuardErr guards
892 = hang (ptext (sLit "accepting non-standard pattern guards (use -XPatternGuards to suppress this message)"))
893 4 (interpp'SP guards)