RnBinds.lhs 32.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
%
% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
%
\section[RnBinds]{Renaming and dependency analysis of bindings}

This module does renaming and dependency analysis on value bindings in
the abstract syntax.  It does {\em not} do cycle-checks on class or
type-synonym declarations; those cannot be done at this stage because
they may be affected by renaming (which isn't fully worked out yet).

\begin{code}
12 13 14 15
module RnBinds (rnTopBinds, rnTopBindsLHS, rnTopBindsRHS, -- use these for top-level bindings
                rnLocalBindsAndThen, rnValBindsLHS, rnValBindsRHS, -- or these for local bindings
                rnMethodBinds, renameSigs, mkSigTvFn,
                rnMatchGroup, rnGRHSs,
16
                makeMiniFixityEnv, MiniFixityEnv
17 18
   ) where

19
import {-# SOURCE #-} RnExpr( rnLExpr, rnStmts )
20 21 22 23

import HsSyn
import RdrHsSyn
import RnHsSyn
24
import TcRnMonad
25
import RnTypes        ( rnHsSigType, rnLHsType, checkPrecMatch)
26
import RnPat          (rnPats, rnBindPat,
27 28
                       NameMaker, localRecNameMaker, topRecNameMaker, applyNameMaker
                      )
29
                      
30
import RnEnv
31
import DynFlags	( DynFlag(..) )
32
import Name
33
import NameEnv
34
import NameSet
35
import RdrName		( RdrName, rdrNameOcc )
Ian Lynagh's avatar
Ian Lynagh committed
36
import SrcLoc
37
import ListSetOps	( findDupsEq )
38
import BasicTypes	( RecFlag(..) )
39
import Digraph		( SCC(..), stronglyConnCompFromEdgedVertices )
40
import Bag
41
import Outputable
42
import FastString
43
import Data.List	( partition )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
44
import Maybes		( orElse )
Ian Lynagh's avatar
Ian Lynagh committed
45
import Control.Monad
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
\end{code}

-- ToDo: Put the annotations into the monad, so that they arrive in the proper
-- place and can be used when complaining.

The code tree received by the function @rnBinds@ contains definitions
in where-clauses which are all apparently mutually recursive, but which may
not really depend upon each other. For example, in the top level program
\begin{verbatim}
f x = y where a = x
	      y = x
\end{verbatim}
the definitions of @a@ and @y@ do not depend on each other at all.
Unfortunately, the typechecker cannot always check such definitions.
\footnote{Mycroft, A. 1984. Polymorphic type schemes and recursive
definitions. In Proceedings of the International Symposium on Programming,
Toulouse, pp. 217-39. LNCS 167. Springer Verlag.}
However, the typechecker usually can check definitions in which only the
strongly connected components have been collected into recursive bindings.
This is precisely what the function @rnBinds@ does.

ToDo: deal with case where a single monobinds binds the same variable
twice.

The vertag tag is a unique @Int@; the tags only need to be unique
within one @MonoBinds@, so that unique-Int plumbing is done explicitly
(heavy monad machinery not needed).


%************************************************************************
%*									*
%* naming conventions							*
%*									*
%************************************************************************

\subsection[name-conventions]{Name conventions}

The basic algorithm involves walking over the tree and returning a tuple
containing the new tree plus its free variables. Some functions, such
as those walking polymorphic bindings (HsBinds) and qualifier lists in
list comprehensions (@Quals@), return the variables bound in local
environments. These are then used to calculate the free variables of the
expression evaluated in these environments.

Conventions for variable names are as follows:
\begin{itemize}
\item
new code is given a prime to distinguish it from the old.

\item
a set of variables defined in @Exp@ is written @dvExp@

\item
a set of variables free in @Exp@ is written @fvExp@
\end{itemize}

%************************************************************************
%*									*
104
%* analysing polymorphic bindings (HsBindGroup, HsBind)
105 106 107 108 109 110 111 112 113 114 115
%*									*
%************************************************************************

\subsubsection[dep-HsBinds]{Polymorphic bindings}

Non-recursive expressions are reconstructed without any changes at top
level, although their component expressions may have to be altered.
However, non-recursive expressions are currently not expected as
\Haskell{} programs, and this code should not be executed.

Monomorphic bindings contain information that is returned in a tuple
116
(a @FlatMonoBinds@) containing:
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154

\begin{enumerate}
\item
a unique @Int@ that serves as the ``vertex tag'' for this binding.

\item
the name of a function or the names in a pattern. These are a set
referred to as @dvLhs@, the defined variables of the left hand side.

\item
the free variables of the body. These are referred to as @fvBody@.

\item
the definition's actual code. This is referred to as just @code@.
\end{enumerate}

The function @nonRecDvFv@ returns two sets of variables. The first is
the set of variables defined in the set of monomorphic bindings, while the
second is the set of free variables in those bindings.

The set of variables defined in a non-recursive binding is just the
union of all of them, as @union@ removes duplicates. However, the
free variables in each successive set of cumulative bindings is the
union of those in the previous set plus those of the newest binding after
the defined variables of the previous set have been removed.

@rnMethodBinds@ deals only with the declarations in class and
instance declarations.	It expects only to see @FunMonoBind@s, and
it expects the global environment to contain bindings for the binders
(which are all class operations).

%************************************************************************
%*									*
\subsubsection{ Top-level bindings}
%*									*
%************************************************************************

\begin{code}
155 156
-- for top-level bindings, we need to make top-level names,
-- so we have a different entry point than for local bindings
157
rnTopBindsLHS :: MiniFixityEnv
158 159
              -> HsValBinds RdrName 
              -> RnM (HsValBindsLR Name RdrName)
160 161 162 163
rnTopBindsLHS fix_env binds
  = do { let (boundNames,doc) = bindersAndDoc binds 
       ; mod <- getModule
       ; rnValBindsLHSFromDoc (topRecNameMaker mod fix_env) boundNames doc binds }
164

165
rnTopBindsRHS :: NameSet	-- Names bound by these binds
166 167 168 169 170 171 172 173 174
              -> HsValBindsLR Name RdrName 
              -> RnM (HsValBinds Name, DefUses)
rnTopBindsRHS bound_names binds = 
    do { is_boot <- tcIsHsBoot
       ; if is_boot 
         then rnTopBindsBoot binds
         else rnValBindsRHSGen (\x -> x) -- don't trim free vars
                               bound_names binds }

175
-- Wrapper if we don't need to do anything in between the left and right,
176 177
-- or anything else in the scope of the left
--
178
-- Never used when there are fixity declarations
179 180 181
rnTopBinds :: HsValBinds RdrName 
           -> RnM (HsValBinds Name, DefUses)
rnTopBinds b = 
182
  do nl <- rnTopBindsLHS emptyFsEnv b
183
     let bound_names = map unLoc (collectHsValBinders nl)
184
     bindLocalNames bound_names $ rnTopBindsRHS (mkNameSet bound_names) nl
185 186 187
       

rnTopBindsBoot :: HsValBindsLR Name RdrName -> RnM (HsValBinds Name, DefUses)
188 189
-- A hs-boot file has no bindings. 
-- 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')) }
Ian Lynagh's avatar
Ian Lynagh committed
194
rnTopBindsBoot b = pprPanic "rnTopBindsBoot" (ppr b)
195 196 197 198 199 200 201 202 203 204 205
\end{code}



%*********************************************************
%*							*
		HsLocalBinds
%*							*
%*********************************************************

\begin{code}
206 207 208 209 210
rnLocalBindsAndThen :: HsLocalBinds RdrName
                    -> (HsLocalBinds Name -> RnM (result, FreeVars))
                    -> RnM (result, FreeVars)
-- This version (a) assumes that the binding vars are *not* already in scope
--		 (b) removes the binders from the free vars of the thing inside
211 212 213 214 215 216
-- The parser doesn't produce ThenBinds
rnLocalBindsAndThen EmptyLocalBinds thing_inside
  = thing_inside EmptyLocalBinds

rnLocalBindsAndThen (HsValBinds val_binds) thing_inside
  = rnValBindsAndThen val_binds $ \ val_binds' -> 
217
      thing_inside (HsValBinds val_binds')
218

219 220 221 222
rnLocalBindsAndThen (HsIPBinds binds) thing_inside = do
    (binds',fv_binds) <- rnIPBinds binds
    (thing, fvs_thing) <- thing_inside (HsIPBinds binds')
    return (thing, fvs_thing `plusFV` fv_binds)
223

Ian Lynagh's avatar
Ian Lynagh committed
224
rnIPBinds :: HsIPBinds RdrName -> RnM (HsIPBinds Name, FreeVars)
225 226 227
rnIPBinds (IPBinds ip_binds _no_dict_binds) = do
    (ip_binds', fvs_s) <- mapAndUnzipM (wrapLocFstM rnIPBind) ip_binds
    return (IPBinds ip_binds' emptyLHsBinds, plusFVs fvs_s)
228

Ian Lynagh's avatar
Ian Lynagh committed
229
rnIPBind :: IPBind RdrName -> RnM (IPBind Name, FreeVars)
230 231 232
rnIPBind (IPBind n expr) = do
    name <- newIPNameRn  n
    (expr',fvExpr) <- rnLExpr expr
233
    return (IPBind name expr', fvExpr)
234 235
\end{code}

236

237 238
%************************************************************************
%*									*
239
		ValBinds
240 241 242 243
%*									*
%************************************************************************

\begin{code}
244 245
-- wrapper for local binds
-- creates the documentation info and calls the helper below
246
rnValBindsLHS :: MiniFixityEnv
247 248 249 250 251 252 253 254 255 256
              -> HsValBinds RdrName
              -> RnM (HsValBindsLR Name RdrName)
rnValBindsLHS fix_env binds = 
    let (boundNames,doc) = bindersAndDoc binds 
    in rnValBindsLHSFromDoc_Local boundNames doc fix_env binds

-- a helper used for local binds that does the duplicates check,
-- just so we don't forget to do it somewhere
rnValBindsLHSFromDoc_Local :: [Located RdrName] -- RdrNames of the LHS (so we don't have to gather them twice)
                           -> SDoc              -- doc string for dup names and shadowing
257
                           -> MiniFixityEnv
258 259 260 261 262 263 264
                           -> HsValBinds RdrName
                           -> RnM (HsValBindsLR Name RdrName)

rnValBindsLHSFromDoc_Local boundNames doc fix_env binds = do
     -- Do error checking: we need to check for dups here because we
     -- don't don't bind all of the variables from the ValBinds at once
     -- with bindLocatedLocals any more.
265
     checkDupAndShadowedRdrNames doc boundNames
266 267 268 269 270 271 272 273 274 275 276

     -- (Note that we don't want to do this at the top level, since
     -- sorting out duplicates and shadowing there happens elsewhere.
     -- The behavior is even different. For example,
     --   import A(f)
     --   f = ...
     -- should not produce a shadowing warning (but it will produce
     -- an ambiguity warning if you use f), but
     --   import A(f)
     --   g = let f = ... in f
     -- should.
277
     rnValBindsLHSFromDoc (localRecNameMaker fix_env) boundNames doc binds 
278 279 280

bindersAndDoc :: HsValBinds RdrName -> ([Located RdrName], SDoc)
bindersAndDoc binds = 
281
    let
282 283 284
        -- the unrenamed bndrs for error checking and reporting
        orig = collectHsValBinders binds
        doc = text "In the binding group for:" <+> pprWithCommas ppr (map unLoc orig)
285
    in
286 287 288 289 290
      (orig, doc)

-- renames the left-hand sides
-- generic version used both at the top level and for local binds
-- does some error checking, but not what gets done elsewhere at the top level
291
rnValBindsLHSFromDoc :: NameMaker 
292 293 294 295
                     -> [Located RdrName] -- RdrNames of the LHS (so we don't have to gather them twice)
                     -> SDoc              -- doc string for dup names and shadowing
                     -> HsValBinds RdrName
                     -> RnM (HsValBindsLR Name RdrName)
Ian Lynagh's avatar
Ian Lynagh committed
296
rnValBindsLHSFromDoc topP _original_bndrs doc (ValBindsIn mbinds sigs) = do
297
     -- rename the LHSes
298
     mbinds' <- mapBagM (rnBindLHS topP doc) mbinds
299
     return $ ValBindsIn mbinds' sigs
Ian Lynagh's avatar
Ian Lynagh committed
300
rnValBindsLHSFromDoc _ _ _ b = pprPanic "rnValBindsLHSFromDoc" (ppr b)
301

302 303
-- General version used both from the top-level and for local things
-- Assumes the LHS vars are in scope
304
--
305
-- Does not bind the local fixity declarations
306 307 308
rnValBindsRHSGen :: (FreeVars -> FreeVars)  -- for trimming free var sets
                     -- The trimming function trims the free vars we attach to a
                     -- binding so that it stays reasonably small
309
                 -> NameSet	-- Names bound by the LHSes
310 311 312
                 -> HsValBindsLR Name RdrName
                 -> RnM (HsValBinds Name, DefUses)

313
rnValBindsRHSGen trim bound_names (ValBindsIn mbinds sigs) = do
314
   -- rename the sigs
315
   sigs' <- renameSigs (Just bound_names) okBindSig sigs
316 317
   -- rename the RHSes
   binds_w_dus <- mapBagM (rnBind (mkSigTvFn sigs') trim) mbinds
Ian Lynagh's avatar
Ian Lynagh committed
318 319 320 321 322
   case depAnalBinds binds_w_dus of
       (anal_binds, anal_dus) ->
           do let valbind' = ValBindsOut anal_binds sigs'
                  valbind'_dus = usesOnly (hsSigsFVs sigs') `plusDU` anal_dus
              return (valbind', valbind'_dus)
323

Ian Lynagh's avatar
Ian Lynagh committed
324 325
rnValBindsRHSGen _ _ b = pprPanic "rnValBindsRHSGen" (ppr b)

326
-- Wrapper for local binds
327
--
328
-- The *client* of this function is responsible for checking for unused binders;
329 330
-- it doesn't (and can't: we don't have the thing inside the binds) happen here
--
331
-- The client is also responsible for bringing the fixities into scope
332
rnValBindsRHS :: NameSet  -- names bound by the LHSes
333 334 335 336
              -> HsValBindsLR Name RdrName
              -> RnM (HsValBinds Name, DefUses)
rnValBindsRHS bound_names binds = 
  rnValBindsRHSGen (\ fvs -> -- only keep the names the names from this group
337
                    intersectNameSet bound_names fvs) bound_names binds
338

339 340 341 342 343 344 345 346 347

-- for local binds
-- wrapper that does both the left- and right-hand sides 
--
-- here there are no local fixity decls passed in;
-- the local fixity decls come from the ValBinds sigs
rnValBindsAndThen :: HsValBinds RdrName
                  -> (HsValBinds Name -> RnM (result, FreeVars))
                  -> RnM (result, FreeVars)
348 349 350 351 352
rnValBindsAndThen binds@(ValBindsIn _ sigs) thing_inside
 = do	{ let (original_bndrs, doc) = bindersAndDoc binds

	      -- (A) Create the local fixity environment 
	; new_fixities <- makeMiniFixityEnv [L loc sig | L loc (FixSig sig) <- sigs]
353

354 355 356
	      -- (B) Rename the LHSes 
	; new_lhs <- rnValBindsLHSFromDoc_Local original_bndrs doc new_fixities binds
	; let bound_names = map unLoc $ collectHsValBinders new_lhs
357

358 359
	      --     ...and bring them (and their fixities) into scope
	; bindLocalNamesFV_WithFixities bound_names new_fixities $ do
360

361
	{      -- (C) Do the RHS and thing inside
362
	  (binds', dus) <- rnValBindsRHS (mkNameSet bound_names) new_lhs 
363
        ; (result, result_fvs) <- thing_inside binds'
364

365 366 367 368 369 370
		-- Report unused bindings based on the (accurate) 
		-- findUses.  E.g.
		-- 	let x = x in 3
		-- should report 'x' unused
	; let real_uses = findUses dus result_fvs
	; warnUnusedLocalBinds bound_names real_uses
371

372 373 374
	; let
            -- The variables "used" in the val binds are: 
            --   (1) the uses of the binds (duUses)
375
            --   (2) the FVs of the thing-inside
376 377 378 379 380 381
            all_uses = duUses dus `plusFV` result_fvs
		-- Note [Unused binding hack]
		-- ~~~~~~~~~~~~~~~~~~~~~~~~~~
		-- Note that *in contrast* to the above reporting of
		-- unused bindings, (1) above uses duUses to return *all* 
		-- the uses, even if the binding is unused.  Otherwise consider:
382 383 384 385 386
                --	x = 3
                --	y = let p = x in 'x'	-- NB: p not used
                -- If we don't "see" the dependency of 'y' on 'x', we may put the
                -- bindings in the wrong order, and the type checker will complain
                -- that x isn't in scope
387 388 389 390 391 392 393
		--
		-- But note that this means we won't report 'x' as unused, 
		-- whereas we would if we had { x = 3; p = x; y = 'x' }

	; return (result, all_uses) }}
         	-- The bound names are pruned out of all_uses
	        -- by the bindLocalNamesFV call above
Ian Lynagh's avatar
Ian Lynagh committed
394 395

rnValBindsAndThen bs _ = pprPanic "rnValBindsAndThen" (ppr bs)
396 397 398 399 400 401 402 403


-- Process the fixity declarations, making a FastString -> (Located Fixity) map
-- (We keep the location around for reporting duplicate fixity declarations.)
-- 
-- Checks for duplicates, but not that only locally defined things are fixed.
-- Note: for local fixity declarations, duplicates would also be checked in
--       check_sigs below.  But we also use this function at the top level.
404 405 406

makeMiniFixityEnv :: [LFixitySig RdrName] -> RnM MiniFixityEnv

407
makeMiniFixityEnv decls = foldlM add_one emptyFsEnv decls
408 409 410 411 412 413
 where
   add_one env (L loc (FixitySig (L name_loc name) fixity)) = do
     { -- this fixity decl is a duplicate iff
       -- the ReaderName's OccName's FastString is already in the env
       -- (we only need to check the local fix_env because
       --  definitions of non-local will be caught elsewhere)
414 415
       let { fs = occNameFS (rdrNameOcc name)
           ; fix_item = L loc fixity };
416

417 418
       case lookupFsEnv env fs of
         Nothing -> return $ extendFsEnv env fs fix_item
419 420
         Just (L loc' _) -> do
           { setSrcSpan loc $ 
421
             addLocErr (L name_loc name) (dupFixityDecl loc')
422 423 424
           ; return env}
     }

Ian Lynagh's avatar
Ian Lynagh committed
425
dupFixityDecl :: SrcSpan -> RdrName -> SDoc
426
dupFixityDecl loc rdr_name
Ian Lynagh's avatar
Ian Lynagh committed
427 428
  = vcat [ptext (sLit "Multiple fixity declarations for") <+> quotes (ppr rdr_name),
	  ptext (sLit "also at ") <+> ppr loc]
429

430
---------------------
431

432 433
-- renaming a single bind

434
rnBindLHS :: NameMaker
435 436 437 438 439 440 441
          -> SDoc 
          -> LHsBind RdrName
          -- returns the renamed left-hand side,
          -- and the FreeVars *of the LHS*
          -- (i.e., any free variables of the pattern)
          -> RnM (LHsBindLR Name RdrName)

Ian Lynagh's avatar
Ian Lynagh committed
442 443 444 445
rnBindLHS name_maker _ (L loc (PatBind { pat_lhs = pat, 
                                         pat_rhs = grhss, 
                                         pat_rhs_ty=pat_rhs_ty
                                       })) 
446 447
  = setSrcSpan loc $ do
      -- we don't actually use the FV processing of rnPatsAndThen here
448
      (pat',pat'_fvs) <- rnBindPat name_maker pat
449 450 451 452 453 454 455 456 457 458
      return (L loc (PatBind { pat_lhs = pat', 
                               pat_rhs = grhss, 
                               -- we temporarily store the pat's FVs here;
                               -- gets updated to the FVs of the whole bind
                               -- when doing the RHS below
                               bind_fvs = pat'_fvs,
                               -- these will get ignored in the next pass,
                               -- when we rename the RHS
			       pat_rhs_ty = pat_rhs_ty }))

Ian Lynagh's avatar
Ian Lynagh committed
459 460 461 462 463 464
rnBindLHS name_maker _ (L loc (FunBind { fun_id = name@(L nameLoc _), 
                                         fun_infix = inf, 
                                         fun_matches = matches,
                                         fun_co_fn = fun_co_fn, 
                                         fun_tick = fun_tick
                                       }))
465
  = setSrcSpan loc $ 
466
    do { newname <- applyNameMaker name_maker name
467 468 469 470 471 472 473 474 475 476
       ; return (L loc (FunBind { fun_id = L nameLoc newname, 
                             	  fun_infix = inf, 
                             	  fun_matches = matches,
                             	  -- we temporatily store the LHS's FVs (empty in this case) here
                             	  -- gets updated when doing the RHS below
                             	  bind_fvs = emptyFVs,
                             	  -- everything else will get ignored in the next pass
                             	  fun_co_fn = fun_co_fn, 
                             	  fun_tick = fun_tick
                             	  })) }
477

Ian Lynagh's avatar
Ian Lynagh committed
478 479
rnBindLHS _ _ b = pprPanic "rnBindLHS" (ppr b)

480 481 482 483 484
-- assumes the left-hands-side vars are in scope
rnBind :: (Name -> [Name])		-- Signature tyvar function
       -> (FreeVars -> FreeVars)	-- Trimming function for rhs free vars
       -> LHsBindLR Name RdrName
       -> RnM (LHsBind Name, [Name], Uses)
Ian Lynagh's avatar
Ian Lynagh committed
485 486 487 488 489
rnBind _ trim (L loc (PatBind { pat_lhs = pat,
                                pat_rhs = grhss, 
                                -- pat fvs were stored here while
                                -- processing the LHS          
                                bind_fvs=pat_fvs }))
490 491
  = setSrcSpan loc $ 
    do	{let bndrs = collectPatBinders pat
492

493 494
	; (grhss', fvs) <- rnGRHSs PatBindRhs grhss
		-- No scoped type variables for pattern bindings
Ian Lynagh's avatar
Ian Lynagh committed
495
	; let fvs' = trim fvs
496

497
	; fvs' `seq` -- See Note [Free-variable space leak]
Ian Lynagh's avatar
Ian Lynagh committed
498
      return (L loc (PatBind { pat_lhs = pat,
499 500
                                  pat_rhs = grhss', 
				     pat_rhs_ty = placeHolderType, 
Ian Lynagh's avatar
Ian Lynagh committed
501
                                  bind_fvs = fvs' }),
502
		  bndrs, pat_fvs `plusFV` fvs) }
503

504 505 506 507 508 509 510 511 512 513 514
rnBind sig_fn 
       trim 
       (L loc (FunBind { fun_id = name, 
                         fun_infix = inf, 
                         fun_matches = matches,
                         -- no pattern FVs
                         bind_fvs = _
                       })) 
       -- invariant: no free vars here when it's a FunBind
  = setSrcSpan loc $ 
    do	{ let plain_name = unLoc name
515

516 517 518
	; (matches', fvs) <- bindSigTyVarsFV (sig_fn plain_name) $
				-- bindSigTyVars tests for Opt_ScopedTyVars
			     rnMatchGroup (FunRhs plain_name inf) matches
Ian Lynagh's avatar
Ian Lynagh committed
519
	; let fvs' = trim fvs
520

521
	; checkPrecMatch inf plain_name matches'
522

523
	; fvs' `seq` -- See Note [Free-variable space leak]
Ian Lynagh's avatar
Ian Lynagh committed
524
      return (L loc (FunBind { fun_id = name,
525 526
                                  fun_infix = inf, 
                                  fun_matches = matches',
Ian Lynagh's avatar
Ian Lynagh committed
527
				     bind_fvs = fvs',
528 529 530 531
                                  fun_co_fn = idHsWrapper, 
                                  fun_tick = Nothing }), 
		  [plain_name], fvs)
      }
Ian Lynagh's avatar
Ian Lynagh committed
532 533

rnBind _ _ b = pprPanic "rnBind" (ppr b)
534 535 536 537 538 539 540 541 542 543 544 545 546 547

{-
Note [Free-variable space leak]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We have
    fvs' = trim fvs
and we seq fvs' before turning it as part of a record.

The reason is that trim is sometimes something like
    \xs -> intersectNameSet (mkNameSet bound_names) xs
and we don't want to retain the list bound_names. This showed up in
trac ticket #1136.
-}

548 549 550
---------------------
depAnalBinds :: Bag (LHsBind Name, [Name], Uses)
	     -> ([(RecFlag, LHsBinds Name)], DefUses)
551 552
-- Dependency analysis; this is important so that 
-- unused-binding reporting is accurate
553 554 555
depAnalBinds binds_w_dus
  = (map get_binds sccs, map get_du sccs)
  where
556
    sccs = stronglyConnCompFromEdgedVertices edges
557 558 559

    keyd_nodes = bagToList binds_w_dus `zip` [0::Int ..]

560 561
    edges = [ (node, key, [key | n <- nameSetToList uses,
			         Just key <- [lookupNameEnv key_map n] ])
562
	    | (node@(_,_,uses), key) <- keyd_nodes ]
563

564 565 566
    key_map :: NameEnv Int	-- Which binding it comes from
    key_map = mkNameEnv [(bndr, key) | ((_, bndrs, _), key) <- keyd_nodes
				     , bndr <- bndrs ]
567

568
    get_binds (AcyclicSCC (bind, _, _)) = (NonRecursive, unitBag bind)
Ian Lynagh's avatar
Ian Lynagh committed
569
    get_binds (CyclicSCC  binds_w_dus)  = (Recursive, listToBag [b | (b,_,_) <- binds_w_dus])
570

571 572 573 574 575
    get_du (AcyclicSCC (_, bndrs, uses)) = (Just (mkNameSet bndrs), uses)
    get_du (CyclicSCC  binds_w_dus)      = (Just defs, uses)
	where
	  defs = mkNameSet [b | (_,bs,_) <- binds_w_dus, b <- bs]
	  uses = unionManyNameSets [u | (_,_,u) <- binds_w_dus]
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595


---------------------
-- Bind the top-level forall'd type variables in the sigs.
-- E.g 	f :: a -> a
--	f = rhs
--	The 'a' scopes over the rhs
--
-- NB: there'll usually be just one (for a function binding)
--     but if there are many, one may shadow the rest; too bad!
--	e.g  x :: [a] -> [a]
--	     y :: [(a,a)] -> a
--	     (x,y) = e
--      In e, 'a' will be in scope, and it'll be the one from 'y'!

mkSigTvFn :: [LSig Name] -> (Name -> [Name])
-- Return a lookup function that maps an Id Name to the names
-- of the type variables that should scope over its body..
mkSigTvFn sigs
  = \n -> lookupNameEnv env n `orElse` []
596
  where
597 598
    env :: NameEnv [Name]
    env = mkNameEnv [ (name, map hsLTyVarName ltvs)
599 600
		    | L _ (TypeSig (L _ name) 
			           (L _ (HsForAllTy Explicit ltvs _ _))) <- sigs]
601 602
	-- Note the pattern-match on "Explicit"; we only bind
	-- type variables from signatures with an explicit top-level for-all
603 604 605 606
\end{code}


@rnMethodBinds@ is used for the method bindings of a class and an instance
607
declaration.   Like @rnBinds@ but without dependency analysis.
608 609 610 611 612 613 614 615 616 617 618 619 620 621

NOTA BENE: we record each {\em binder} of a method-bind group as a free variable.
That's crucial when dealing with an instance decl:
\begin{verbatim}
	instance Foo (T a) where
	   op x = ...
\end{verbatim}
This might be the {\em sole} occurrence of @op@ for an imported class @Foo@,
and unless @op@ occurs we won't treat the type signature of @op@ in the class
decl for @Foo@ as a source of instance-decl gates.  But we should!  Indeed,
in many ways the @op@ in an instance decl is just like an occurrence, not
a binder.

\begin{code}
622
rnMethodBinds :: Name			-- Class name
623
	      -> (Name -> [Name])	-- Signature tyvar function
624
	      -> [Name]			-- Names for generic type variables
625
	      -> LHsBinds RdrName
626
	      -> RnM (LHsBinds Name, FreeVars)
627

628
rnMethodBinds cls sig_fn gen_tyvars binds
629 630
  = foldM do_one (emptyBag,emptyFVs) (bagToList binds)
  where do_one (binds,fvs) bind = do
631
	   (bind', fvs_bind) <- rnMethodBind cls sig_fn gen_tyvars bind
632
	   return (bind' `unionBags` binds, fvs_bind `plusFV` fvs)
633

Ian Lynagh's avatar
Ian Lynagh committed
634 635 636 637 638
rnMethodBind :: Name
	      -> (Name -> [Name])
	      -> [Name]
	      -> LHsBindLR RdrName RdrName
	      -> RnM (Bag (LHsBindLR Name Name), FreeVars)
639 640
rnMethodBind cls sig_fn gen_tyvars (L loc (FunBind { fun_id = name, fun_infix = inf, 
					             fun_matches = MatchGroup matches _ }))
641
  = setSrcSpan loc $ do
642
    sel_name <- wrapLocM (lookupInstDeclBndr cls) name
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
    let plain_name = unLoc sel_name
        -- We use the selector name as the binder

    bindSigTyVarsFV (sig_fn plain_name) $ do
     (new_matches, fvs) <- mapFvRn (rn_match plain_name) matches
     let
         new_group = MatchGroup new_matches placeHolderType

     checkPrecMatch inf plain_name new_group
     return (unitBag (L loc (FunBind {
                                fun_id = sel_name, fun_infix = inf,
                                fun_matches = new_group,
                                bind_fvs = fvs, fun_co_fn = idHsWrapper,
                                fun_tick = Nothing })),
             fvs `addOneFV` plain_name)
        -- The 'fvs' field isn't used for method binds
659
  where
660 661
	-- Truly gruesome; bring into scope the correct members of the generic 
	-- type variables.  See comments in RnSource.rnSourceDecl(ClassDecl)
662
    rn_match sel_name match@(L _ (Match (L _ (TypePat ty) : _) _ _))
663
	= extendTyVarEnvFVRn gen_tvs 	$
664
	  rnMatch (FunRhs sel_name inf) match
665
	where
666
	  tvs     = map (rdrNameOcc.unLoc) (extractHsTyRdrTyVars ty)
667 668
	  gen_tvs = [tv | tv <- gen_tyvars, nameOccName tv `elem` tvs] 

669
    rn_match sel_name match = rnMatch (FunRhs sel_name inf) match
670

671 672

-- Can't handle method pattern-bindings which bind multiple methods.
Ian Lynagh's avatar
Ian Lynagh committed
673
rnMethodBind _ _ _ mbind@(L _ (PatBind _ _ _ _)) = do
674 675
    addLocErr mbind methodBindErr
    return (emptyBag, emptyFVs)
Ian Lynagh's avatar
Ian Lynagh committed
676 677

rnMethodBind _ _ _ b = pprPanic "rnMethodBind" (ppr b)
678 679 680
\end{code}


681

682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
%************************************************************************
%*									*
\subsubsection[dep-Sigs]{Signatures (and user-pragmas for values)}
%*									*
%************************************************************************

@renameSigs@ checks for:
\begin{enumerate}
\item more than one sig for one thing;
\item signatures given for things not bound here;
\end{enumerate}
%
At the moment we don't gather free-var info from the types in
signatures.  We'd only need this if we wanted to report unused tyvars.

\begin{code}
698 699 700 701
renameSigs :: Maybe NameSet		-- If (Just ns) complain if the sig isn't for one of ns
	   -> (Sig RdrName -> Bool) 	-- Complain about the wrong kind of signature if this is False
	   -> [LSig RdrName]
	   -> RnM [LSig Name]
702
-- Renames the signatures and performs error checks
703 704 705 706 707 708
renameSigs mb_names ok_sig sigs 
  = do	{ let (good_sigs, bad_sigs) = partition (ok_sig . unLoc) sigs
	; mapM_ unknownSigErr bad_sigs			-- Misplaced
	; mapM_ dupSigDeclErr (findDupsEq eqHsSig sigs)	-- Duplicate
	; sigs' <- mapM (wrapLocM (renameSig mb_names)) good_sigs
	; return sigs' } 
709 710

----------------------
711
-- We use lookupSigOccRn in the signatures, which is a little bit unsatisfactory
712 713 714 715 716 717 718 719
-- because this won't work for:
--	instance Foo T where
--	  {-# INLINE op #-}
--	  Baz.op = ...
-- We'll just rename the INLINE prag to refer to whatever other 'op'
-- is in scope.  (I'm assuming that Baz.op isn't in scope unqualified.)
-- Doesn't seem worth much trouble to sort this.

720 721
renameSig :: Maybe NameSet -> Sig RdrName -> RnM (Sig Name)
-- FixitySig is renamed elsewhere.
722 723
renameSig _ (IdSig x)
  = return (IdSig x)	  -- Actually this never occurs
724
renameSig mb_names sig@(TypeSig v ty)
725
  = do	{ new_v <- lookupSigOccRn mb_names sig v
726 727 728 729 730 731 732 733
	; new_ty <- rnHsSigType (quotes (ppr v)) ty
	; return (TypeSig new_v new_ty) }

renameSig _ (SpecInstSig ty)
  = do	{ new_ty <- rnLHsType (text "A SPECIALISE instance pragma") ty
	; return (SpecInstSig new_ty) }

renameSig mb_names sig@(SpecSig v ty inl)
734
  = do	{ new_v <- lookupSigOccRn mb_names sig v
735 736 737 738
	; new_ty <- rnHsSigType (quotes (ppr v)) ty
	; return (SpecSig new_v new_ty inl) }

renameSig mb_names sig@(InlineSig v s)
739
  = do	{ new_v <- lookupSigOccRn mb_names sig v
740 741 742
	; return (InlineSig new_v s) }

renameSig mb_names sig@(FixSig (FixitySig v f))
743
  = do	{ new_v <- lookupSigOccRn mb_names sig v
744
	; return (FixSig (FixitySig new_v f)) }
745 746 747
\end{code}


Thomas Schilling's avatar
Thomas Schilling committed
748 749
%************************************************************************
%*									*
750
\subsection{Match}
Thomas Schilling's avatar
Thomas Schilling committed
751 752
%*									*
%************************************************************************
753 754 755

\begin{code}
rnMatchGroup :: HsMatchContext Name -> MatchGroup RdrName -> RnM (MatchGroup Name, FreeVars)
756 757 758
rnMatchGroup ctxt (MatchGroup ms _) 
  = do { (new_ms, ms_fvs) <- mapFvRn (rnMatch ctxt) ms
       ; return (MatchGroup new_ms placeHolderType, ms_fvs) }
759 760 761 762

rnMatch :: HsMatchContext Name -> LMatch RdrName -> RnM (LMatch Name, FreeVars)
rnMatch ctxt  = wrapLocFstM (rnMatch' ctxt)

Ian Lynagh's avatar
Ian Lynagh committed
763
rnMatch' :: HsMatchContext Name -> Match RdrName -> RnM (Match Name, FreeVars)
764 765 766 767 768 769 770 771 772
rnMatch' ctxt match@(Match pats maybe_rhs_sig grhss)
  = do 	{ 	-- Result type signatures are no longer supported
	  case maybe_rhs_sig of	
	        Nothing -> return ()
	        Just ty -> addLocErr ty (resSigErr ctxt match)


	       -- Now the main event
	       -- note that there are no local ficity decls for matches
773
	; rnPats ctxt pats	$ \ pats' -> do
774 775 776
	{ (grhss', grhss_fvs) <- rnGRHSs ctxt grhss

	; return (Match pats' Nothing grhss', grhss_fvs) }}
777 778
	-- The bindPatSigTyVarsFV and rnPatsAndThen will remove the bound FVs
  where
779 780 781 782 783 784

resSigErr :: HsMatchContext Name -> Match RdrName -> HsType RdrName -> SDoc 
resSigErr ctxt match ty
   = vcat [ ptext (sLit "Illegal result type signature") <+> quotes (ppr ty)
	  , nest 2 $ ptext (sLit "Result signatures are no longer supported in pattern matches")
 	  , pprMatchInCtxt ctxt match ]
785 786 787 788 789 790 791 792 793 794 795 796 797
\end{code}


%************************************************************************
%*									*
\subsubsection{Guarded right-hand sides (GRHSs)}
%*									*
%************************************************************************

\begin{code}
rnGRHSs :: HsMatchContext Name -> GRHSs RdrName -> RnM (GRHSs Name, FreeVars)

rnGRHSs ctxt (GRHSs grhss binds)
798 799 800
  = rnLocalBindsAndThen binds	$ \ binds' -> do
    (grhss', fvGRHSs) <- mapFvRn (rnGRHS ctxt) grhss
    return (GRHSs grhss' binds', fvGRHSs)
801 802 803 804

rnGRHS :: HsMatchContext Name -> LGRHS RdrName -> RnM (LGRHS Name, FreeVars)
rnGRHS ctxt = wrapLocFstM (rnGRHS' ctxt)

Ian Lynagh's avatar
Ian Lynagh committed
805
rnGRHS' :: HsMatchContext Name -> GRHS RdrName -> RnM (GRHS Name, FreeVars)
806
rnGRHS' ctxt (GRHS guards rhs)
Ian Lynagh's avatar
Ian Lynagh committed
807
  = do	{ pattern_guards_allowed <- doptM Opt_PatternGuards
808 809
	; ((guards', rhs'), fvs) <- rnStmts (PatGuard ctxt) guards $
				    rnLExpr rhs
810

811
	; unless (pattern_guards_allowed || is_standard_guard guards')
812 813
	  	 (addWarn (nonStdGuardErr guards'))

814 815 816 817 818 819 820
	; return (GRHS guards' rhs', fvs) }
  where
	-- Standard Haskell 1.4 guards are just a single boolean
	-- expression, rather than a list of qualifiers as in the
	-- Glasgow extension
    is_standard_guard []                     = True
    is_standard_guard [L _ (ExprStmt _ _ _)] = True
Ian Lynagh's avatar
Ian Lynagh committed
821
    is_standard_guard _                      = False
822 823
\end{code}

824 825 826 827 828 829 830
%************************************************************************
%*									*
\subsection{Error messages}
%*									*
%************************************************************************

\begin{code}
831
dupSigDeclErr :: [LSig RdrName] -> RnM ()
832
dupSigDeclErr sigs@(L loc sig : _)
833
  = addErrAt loc $
Ian Lynagh's avatar
Ian Lynagh committed
834
	vcat [ptext (sLit "Duplicate") <+> what_it_is <> colon,
835
	      nest 2 (vcat (map ppr_sig sigs))]
836
  where
837 838
    what_it_is = hsSigDoc sig
    ppr_sig (L loc sig) = ppr loc <> colon <+> ppr sig
Ian Lynagh's avatar
Ian Lynagh committed
839
dupSigDeclErr [] = panic "dupSigDeclErr"
840

841
unknownSigErr :: LSig RdrName -> RnM ()
842
unknownSigErr (L loc sig)
843 844
  = addErrAt loc $
    sep [ptext (sLit "Misplaced") <+> hsSigDoc sig <> colon, ppr sig]
845

Ian Lynagh's avatar
Ian Lynagh committed
846
methodBindErr :: HsBindLR RdrName RdrName -> SDoc
847
methodBindErr mbind
Ian Lynagh's avatar
Ian Lynagh committed
848
 =  hang (ptext (sLit "Pattern bindings (except simple variables) not allowed in instance declarations"))
849 850
       2 (ppr mbind)

Ian Lynagh's avatar
Ian Lynagh committed
851
bindsInHsBootFile :: LHsBindsLR Name RdrName -> SDoc
852
bindsInHsBootFile mbinds
Ian Lynagh's avatar
Ian Lynagh committed
853
  = hang (ptext (sLit "Bindings in hs-boot files are not allowed"))
854
       2 (ppr mbinds)
855

Ian Lynagh's avatar
Ian Lynagh committed
856
nonStdGuardErr :: [LStmtLR Name Name] -> SDoc
857
nonStdGuardErr guards
Ian Lynagh's avatar
Ian Lynagh committed
858
  = hang (ptext (sLit "accepting non-standard pattern guards (use -XPatternGuards to suppress this message)"))
859
       4 (interpp'SP guards)
860
\end{code}