RnBinds.lhs 34 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          (rnPatsAndThen_LocalRightwards, rnBindPat,
27 28
                       NameMaker, localRecNameMaker, topRecNameMaker, applyNameMaker
                      )
29
                      
30
import RnEnv
31
import PrelNames	( mkUnboundName )
32
import DynFlags	( DynFlag(..) )
33
import Name
34
import NameEnv
35
import NameSet
36
import RdrName		( RdrName, rdrNameOcc )
Ian Lynagh's avatar
Ian Lynagh committed
37
import SrcLoc
38
import ListSetOps	( findDupsEq )
39
import BasicTypes	( RecFlag(..) )
40
import Digraph		( SCC(..), stronglyConnCompFromEdgedVertices )
41
import Bag
42
import Outputable
43
import FastString
44
import Data.List	( partition )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
45
import Maybes		( orElse )
46
import Monad		( foldM, unless )
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 104
\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}

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

\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
117
(a @FlatMonoBinds@) containing:
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 155

\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}
156 157
-- for top-level bindings, we need to make top-level names,
-- so we have a different entry point than for local bindings
158
rnTopBindsLHS :: MiniFixityEnv
159 160 161
              -> HsValBinds RdrName 
              -> RnM (HsValBindsLR Name RdrName)
rnTopBindsLHS fix_env binds = 
162
    (uncurry $ rnValBindsLHSFromDoc (topRecNameMaker fix_env)) (bindersAndDoc binds) binds
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181

rnTopBindsRHS :: [Name] -- the names bound by these binds
              -> 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 }
  

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

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 309 310 311 312
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
                 -> [Name]  -- names bound by the LHSes
                 -> HsValBindsLR Name RdrName
                 -> RnM (HsValBinds Name, DefUses)

313
rnValBindsRHSGen trim bound_names (ValBindsIn mbinds sigs) = do
314
   -- rename the sigs
315
   env <- getGblEnv
Ian Lynagh's avatar
Ian Lynagh committed
316
   traceRn (ptext (sLit "Rename sigs") <+> ppr (tcg_rdr_env env))
317
   sigs' <- renameSigs (Just (mkNameSet bound_names)) okBindSig sigs
318 319
   -- rename the RHSes
   binds_w_dus <- mapBagM (rnBind (mkSigTvFn sigs') trim) mbinds
Ian Lynagh's avatar
Ian Lynagh committed
320 321 322 323 324
   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)
325

Ian Lynagh's avatar
Ian Lynagh committed
326 327
rnValBindsRHSGen _ _ b = pprPanic "rnValBindsRHSGen" (ppr b)

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

341 342 343 344 345 346 347 348 349

-- 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)
350 351 352 353 354
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]
355

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

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

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

367 368 369 370 371 372
		-- 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
373

374 375 376
	; let
            -- The variables "used" in the val binds are: 
            --   (1) the uses of the binds (duUses)
377
            --   (2) the FVs of the thing-inside
378 379 380 381 382 383
            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:
384 385 386 387 388
                --	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
389 390 391 392 393 394 395
		--
		-- 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
396 397

rnValBindsAndThen bs _ = pprPanic "rnValBindsAndThen" (ppr bs)
398 399 400 401 402 403 404 405


-- 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.
406 407 408

makeMiniFixityEnv :: [LFixitySig RdrName] -> RnM MiniFixityEnv

409
makeMiniFixityEnv decls = foldlM add_one emptyFsEnv decls
410 411 412 413 414 415
 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)
416 417
       let { fs = occNameFS (rdrNameOcc name)
           ; fix_item = L loc fixity };
418

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

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

432
---------------------
433

434 435
-- renaming a single bind

436
rnBindLHS :: NameMaker
437 438 439 440 441 442 443
          -> 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
444 445 446 447
rnBindLHS name_maker _ (L loc (PatBind { pat_lhs = pat, 
                                         pat_rhs = grhss, 
                                         pat_rhs_ty=pat_rhs_ty
                                       })) 
448 449
  = setSrcSpan loc $ do
      -- we don't actually use the FV processing of rnPatsAndThen here
450
      (pat',pat'_fvs) <- rnBindPat name_maker pat
451 452 453 454 455 456 457 458 459 460
      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
461 462 463 464 465 466
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
                                       }))
467 468 469 470 471 472 473 474 475 476 477 478 479
  = setSrcSpan loc $ 
    do { (newname, _fvs) <- applyNameMaker name_maker name $ \ newname ->
		 	    return (newname, emptyFVs) 
       ; 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
                             	  })) }
480

Ian Lynagh's avatar
Ian Lynagh committed
481 482
rnBindLHS _ _ b = pprPanic "rnBindLHS" (ppr b)

483 484 485 486 487
-- 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
488 489 490 491 492
rnBind _ trim (L loc (PatBind { pat_lhs = pat,
                                pat_rhs = grhss, 
                                -- pat fvs were stored here while
                                -- processing the LHS          
                                bind_fvs=pat_fvs }))
493 494
  = setSrcSpan loc $ 
    do	{let bndrs = collectPatBinders pat
495

496 497
	; (grhss', fvs) <- rnGRHSs PatBindRhs grhss
		-- No scoped type variables for pattern bindings
498

499 500 501 502 503
	; return (L loc (PatBind { pat_lhs = pat, 
                                  pat_rhs = grhss', 
				     pat_rhs_ty = placeHolderType, 
                                  bind_fvs = trim fvs }), 
		  bndrs, pat_fvs `plusFV` fvs) }
504

505 506 507 508 509 510 511 512 513 514 515
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
516

517 518 519
	; (matches', fvs) <- bindSigTyVarsFV (sig_fn plain_name) $
				-- bindSigTyVars tests for Opt_ScopedTyVars
			     rnMatchGroup (FunRhs plain_name inf) matches
520

521
	; checkPrecMatch inf plain_name matches'
522

523 524 525 526 527 528 529 530
	; return (L loc (FunBind { fun_id = name, 
                                  fun_infix = inf, 
                                  fun_matches = matches',
				     bind_fvs = trim fvs, 
                                  fun_co_fn = idHsWrapper, 
                                  fun_tick = Nothing }), 
		  [plain_name], fvs)
      }
Ian Lynagh's avatar
Ian Lynagh committed
531 532

rnBind _ _ b = pprPanic "rnBind" (ppr b)
533
		
534 535 536
---------------------
depAnalBinds :: Bag (LHsBind Name, [Name], Uses)
	     -> ([(RecFlag, LHsBinds Name)], DefUses)
537 538
-- Dependency analysis; this is important so that 
-- unused-binding reporting is accurate
539 540 541
depAnalBinds binds_w_dus
  = (map get_binds sccs, map get_du sccs)
  where
542
    sccs = stronglyConnCompFromEdgedVertices edges
543 544 545

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

546 547
    edges = [ (node, key, [key | n <- nameSetToList uses,
			         Just key <- [lookupNameEnv key_map n] ])
548
	    | (node@(_,_,uses), key) <- keyd_nodes ]
549

550 551 552
    key_map :: NameEnv Int	-- Which binding it comes from
    key_map = mkNameEnv [(bndr, key) | ((_, bndrs, _), key) <- keyd_nodes
				     , bndr <- bndrs ]
553

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

557 558 559 560 561
    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]
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581


---------------------
-- 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` []
582
  where
583 584
    env :: NameEnv [Name]
    env = mkNameEnv [ (name, map hsLTyVarName ltvs)
585 586
		    | L _ (TypeSig (L _ name) 
			           (L _ (HsForAllTy Explicit ltvs _ _))) <- sigs]
587 588
	-- Note the pattern-match on "Explicit"; we only bind
	-- type variables from signatures with an explicit top-level for-all
589 590 591 592
\end{code}


@rnMethodBinds@ is used for the method bindings of a class and an instance
593
declaration.   Like @rnBinds@ but without dependency analysis.
594 595 596 597 598 599 600 601 602 603 604 605 606 607

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}
608
rnMethodBinds :: Name			-- Class name
609
	      -> (Name -> [Name])	-- Signature tyvar function
610
	      -> [Name]			-- Names for generic type variables
611
	      -> LHsBinds RdrName
612
	      -> RnM (LHsBinds Name, FreeVars)
613

614
rnMethodBinds cls sig_fn gen_tyvars binds
615 616
  = foldM do_one (emptyBag,emptyFVs) (bagToList binds)
  where do_one (binds,fvs) bind = do
617
	   (bind', fvs_bind) <- rnMethodBind cls sig_fn gen_tyvars bind
618
	   return (bind' `unionBags` binds, fvs_bind `plusFV` fvs)
619

Ian Lynagh's avatar
Ian Lynagh committed
620 621 622 623 624
rnMethodBind :: Name
	      -> (Name -> [Name])
	      -> [Name]
	      -> LHsBindLR RdrName RdrName
	      -> RnM (Bag (LHsBindLR Name Name), FreeVars)
625 626
rnMethodBind cls sig_fn gen_tyvars (L loc (FunBind { fun_id = name, fun_infix = inf, 
					             fun_matches = MatchGroup matches _ }))
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
  = setSrcSpan loc $ do
    sel_name <- lookupInstDeclBndr cls name
    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
645
  where
646 647
	-- Truly gruesome; bring into scope the correct members of the generic 
	-- type variables.  See comments in RnSource.rnSourceDecl(ClassDecl)
648
    rn_match sel_name match@(L _ (Match (L _ (TypePat ty) : _) _ _))
649
	= extendTyVarEnvFVRn gen_tvs 	$
650
	  rnMatch (FunRhs sel_name inf) match
651
	where
652
	  tvs     = map (rdrNameOcc.unLoc) (extractHsTyRdrTyVars ty)
653 654
	  gen_tvs = [tv | tv <- gen_tyvars, nameOccName tv `elem` tvs] 

655
    rn_match sel_name match = rnMatch (FunRhs sel_name inf) match
656

657 658

-- Can't handle method pattern-bindings which bind multiple methods.
Ian Lynagh's avatar
Ian Lynagh committed
659
rnMethodBind _ _ _ mbind@(L _ (PatBind _ _ _ _)) = do
660 661
    addLocErr mbind methodBindErr
    return (emptyBag, emptyFVs)
Ian Lynagh's avatar
Ian Lynagh committed
662 663

rnMethodBind _ _ _ b = pprPanic "rnMethodBind" (ppr b)
664 665 666
\end{code}


667

668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
%************************************************************************
%*									*
\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}
684 685 686 687
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]
688
-- Renames the signatures and performs error checks
689 690 691 692 693 694
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' } 
695 696

----------------------
697
-- We use lookupSigOccRn in the signatures, which is a little bit unsatisfactory
698 699 700 701 702 703 704 705
-- 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.

706 707 708
renameSig :: Maybe NameSet -> Sig RdrName -> RnM (Sig Name)
-- FixitySig is renamed elsewhere.
renameSig mb_names sig@(TypeSig v ty)
709
  = do	{ new_v <- lookupSigLocOccRn mb_names sig v
710 711 712 713 714 715 716 717
	; 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)
718
  = do	{ new_v <- lookupSigLocOccRn mb_names sig v
719 720 721 722
	; new_ty <- rnHsSigType (quotes (ppr v)) ty
	; return (SpecSig new_v new_ty inl) }

renameSig mb_names sig@(InlineSig v s)
723
  = do	{ new_v <- lookupSigLocOccRn mb_names sig v
724 725 726
	; return (InlineSig new_v s) }

renameSig mb_names sig@(FixSig (FixitySig v f))
727
  = do	{ new_v <- lookupSigLocOccRn mb_names sig v
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
	; return (FixSig (FixitySig new_v f)) }

-- lookupSigOccRn is used for type signatures and pragmas
-- Is this valid?
--   module A
--	import M( f )
--	f :: Int -> Int
--	f x = x
-- It's clear that the 'f' in the signature must refer to A.f
-- The Haskell98 report does not stipulate this, but it will!
-- So we must treat the 'f' in the signature in the same way
-- as the binding occurrence of 'f', using lookupBndrRn
--
-- However, consider this case:
--	import M( f )
--	f :: Int -> Int
--	g x = x
-- We don't want to say 'f' is out of scope; instead, we want to
-- return the imported 'f', so that later on the reanamer will
-- correctly report "misplaced type sig".

749 750 751 752 753
lookupSigLocOccRn :: Maybe NameSet -> Sig RdrName -> Located RdrName -> RnM (Located Name)
lookupSigLocOccRn mb_names sig = wrapLocM (lookupSigOccRn mb_names sig)

lookupSigOccRn :: Maybe NameSet -> Sig RdrName -> RdrName -> RnM Name
lookupSigOccRn mb_names sig v
754 755 756
  = do 	{ mb_n <- lookupBndrRn_maybe v
	; case mb_n of {
	    Just n  -> case mb_names of {
757 758
			Nothing 		     -> return n ;
			Just ns | n `elemNameSet` ns -> return n 
759 760 761 762 763 764 765 766 767 768 769 770 771 772
				| otherwise -> bale_out_with local_msg } ;
		          
	    Nothing -> do
    	{ mb_n <- lookupGreRn_maybe v
	; case mb_n of
	    Just _  -> bale_out_with import_msg
	    Nothing -> bale_out_with empty
	} }}
  where
    bale_out_with msg 
	= do { addErr (sep [ ptext (sLit "The") <+> hsSigDoc sig
				<+> ptext (sLit "for") <+> quotes (ppr v)
			   , nest 2 $ ptext (sLit "lacks an accompanying binding")]
		       $$ nest 2 msg)
773
	     ; return (mkUnboundName v) }
774 775 776 777 778 779

    local_msg = parens $ ptext (sLit "The")  <+> hsSigDoc sig <+> ptext (sLit "must be given where")
			 <+> quotes (ppr v) <+> ptext (sLit "is declared")

    import_msg = parens $ ptext (sLit "You cannot give a") <+> hsSigDoc sig
			  <+> ptext (sLit "an imported value")
780 781 782
\end{code}


Thomas Schilling's avatar
Thomas Schilling committed
783 784
%************************************************************************
%*									*
785
\subsection{Match}
Thomas Schilling's avatar
Thomas Schilling committed
786 787
%*									*
%************************************************************************
788 789 790

\begin{code}
rnMatchGroup :: HsMatchContext Name -> MatchGroup RdrName -> RnM (MatchGroup Name, FreeVars)
791 792 793
rnMatchGroup ctxt (MatchGroup ms _) 
  = do { (new_ms, ms_fvs) <- mapFvRn (rnMatch ctxt) ms
       ; return (MatchGroup new_ms placeHolderType, ms_fvs) }
794 795 796 797

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

Ian Lynagh's avatar
Ian Lynagh committed
798
rnMatch' :: HsMatchContext Name -> Match RdrName -> RnM (Match Name, FreeVars)
799 800 801 802 803 804 805 806 807 808 809 810 811
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
	; rnPatsAndThen_LocalRightwards ctxt pats	$ \ pats' -> do
	{ (grhss', grhss_fvs) <- rnGRHSs ctxt grhss

	; return (Match pats' Nothing grhss', grhss_fvs) }}
812 813
	-- The bindPatSigTyVarsFV and rnPatsAndThen will remove the bound FVs
  where
814 815 816 817 818 819

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 ]
820 821 822 823 824 825 826 827 828 829 830 831 832
\end{code}


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

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

rnGRHSs ctxt (GRHSs grhss binds)
833 834 835
  = rnLocalBindsAndThen binds	$ \ binds' -> do
    (grhss', fvGRHSs) <- mapFvRn (rnGRHS ctxt) grhss
    return (GRHSs grhss' binds', fvGRHSs)
836 837 838 839

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

Ian Lynagh's avatar
Ian Lynagh committed
840
rnGRHS' :: HsMatchContext Name -> GRHS RdrName -> RnM (GRHS Name, FreeVars)
841
rnGRHS' ctxt (GRHS guards rhs)
Ian Lynagh's avatar
Ian Lynagh committed
842
  = do	{ pattern_guards_allowed <- doptM Opt_PatternGuards
843 844
	; ((guards', rhs'), fvs) <- rnStmts (PatGuard ctxt) guards $
				    rnLExpr rhs
845

846
	; unless (pattern_guards_allowed || is_standard_guard guards')
847 848
	  	 (addWarn (nonStdGuardErr guards'))

849 850 851 852 853 854 855
	; 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
856
    is_standard_guard _                      = False
857 858
\end{code}

859 860 861 862 863 864 865
%************************************************************************
%*									*
\subsection{Error messages}
%*									*
%************************************************************************

\begin{code}
866
dupSigDeclErr :: [LSig RdrName] -> RnM ()
867
dupSigDeclErr sigs@(L loc sig : _)
868
  = addErrAt loc $
Ian Lynagh's avatar
Ian Lynagh committed
869
	vcat [ptext (sLit "Duplicate") <+> what_it_is <> colon,
870
	      nest 2 (vcat (map ppr_sig sigs))]
871
  where
872 873
    what_it_is = hsSigDoc sig
    ppr_sig (L loc sig) = ppr loc <> colon <+> ppr sig
Ian Lynagh's avatar
Ian Lynagh committed
874
dupSigDeclErr [] = panic "dupSigDeclErr"
875

876
unknownSigErr :: LSig RdrName -> RnM ()
877
unknownSigErr (L loc sig)
878 879
  = addErrAt loc $
    sep [ptext (sLit "Misplaced") <+> hsSigDoc sig <> colon, ppr sig]
880

Ian Lynagh's avatar
Ian Lynagh committed
881
methodBindErr :: HsBindLR RdrName RdrName -> SDoc
882
methodBindErr mbind
Ian Lynagh's avatar
Ian Lynagh committed
883
 =  hang (ptext (sLit "Pattern bindings (except simple variables) not allowed in instance declarations"))
884 885
       2 (ppr mbind)

Ian Lynagh's avatar
Ian Lynagh committed
886
bindsInHsBootFile :: LHsBindsLR Name RdrName -> SDoc
887
bindsInHsBootFile mbinds
Ian Lynagh's avatar
Ian Lynagh committed
888
  = hang (ptext (sLit "Bindings in hs-boot files are not allowed"))
889
       2 (ppr mbinds)
890

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