RnBinds.lhs 31.4 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 16 17 18 19 20 21 22 23
module RnBinds (
   -- Renaming top-level bindings
   rnTopBinds, rnTopBindsLHS, rnTopBindsRHS, 

   -- Renaming local bindings
   rnLocalBindsAndThen, rnLocalValBindsLHS, rnLocalValBindsRHS,

   -- Other bindings
   rnMethodBinds, renameSigs, mkSigTvFn,
   rnMatchGroup, rnGRHSs,
   makeMiniFixityEnv, MiniFixityEnv,
   misplacedSigErr
24 25
   ) where

26
import {-# SOURCE #-} RnExpr( rnLExpr, rnStmts )
27 28 29

import HsSyn
import RnHsSyn
30
import TcRnMonad
31
import RnTypes        ( rnHsSigType, rnLHsType, checkPrecMatch)
32
import RnPat          (rnPats, rnBindPat,
33 34
                       NameMaker, localRecNameMaker, topRecNameMaker, applyNameMaker
                      )
35
                      
36
import RnEnv
37
import DynFlags
38
import Name
39
import NameEnv
40
import NameSet
41
import RdrName		( RdrName, rdrNameOcc )
Ian Lynagh's avatar
Ian Lynagh committed
42
import SrcLoc
43
import ListSetOps	( findDupsEq )
44
import BasicTypes	( RecFlag(..) )
45
import Digraph		( SCC(..), stronglyConnCompFromEdgedVertices )
46
import Bag
47
import Outputable
48
import FastString
49
import Data.List	( partition )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
50
import Maybes		( orElse )
Ian Lynagh's avatar
Ian Lynagh committed
51
import Control.Monad
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 105 106 107 108 109
\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}

%************************************************************************
%*									*
110
%* analysing polymorphic bindings (HsBindGroup, HsBind)
111 112 113 114 115 116 117 118 119 120 121
%*									*
%************************************************************************

\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
122
(a @FlatMonoBinds@) containing:
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 156 157 158 159 160

\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}
161 162
-- for top-level bindings, we need to make top-level names,
-- so we have a different entry point than for local bindings
163
rnTopBindsLHS :: MiniFixityEnv
164 165
              -> HsValBinds RdrName 
              -> RnM (HsValBindsLR Name RdrName)
166
rnTopBindsLHS fix_env binds
167
  = rnValBindsLHS (topRecNameMaker fix_env) binds
168

169
rnTopBindsRHS :: HsValBindsLR Name RdrName 
170
              -> RnM (HsValBinds Name, DefUses)
171 172
rnTopBindsRHS binds
  = do { is_boot <- tcIsHsBoot
173 174
       ; if is_boot 
         then rnTopBindsBoot binds
175 176 177
         else rnValBindsRHS noTrimFVs -- don't trim free vars
                            Nothing   -- Allow SPEC prags for imports
                            binds }
178

179
-- Wrapper if we don't need to do anything in between the left and right,
180 181
-- or anything else in the scope of the left
--
182
-- Never used when there are fixity declarations
183 184
rnTopBinds :: HsValBinds RdrName 
           -> RnM (HsValBinds Name, DefUses)
185 186 187 188 189
rnTopBinds b
  = do { nl <- rnTopBindsLHS emptyFsEnv b
       ; let bound_names = collectHsValBinders nl
       ; bindLocalNames bound_names $ 
         rnValBindsRHS noTrimFVs (Just (mkNameSet bound_names)) nl }
190 191 192
       

rnTopBindsBoot :: HsValBindsLR Name RdrName -> RnM (HsValBinds Name, DefUses)
193 194
-- A hs-boot file has no bindings. 
-- Return a single HsBindGroup with empty binds and renamed signatures
195
rnTopBindsBoot (ValBindsIn mbinds sigs)
196
  = do	{ checkErr (isEmptyLHsBinds mbinds) (bindsInHsBootFile mbinds)
197
	; sigs' <- renameSigs Nothing okHsBootSig sigs
198
	; return (ValBindsOut [] sigs', usesOnly (hsSigsFVs sigs')) }
Ian Lynagh's avatar
Ian Lynagh committed
199
rnTopBindsBoot b = pprPanic "rnTopBindsBoot" (ppr b)
200 201 202 203 204 205 206 207 208 209
\end{code}


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

\begin{code}
210 211 212 213 214
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
215 216 217 218 219
-- The parser doesn't produce ThenBinds
rnLocalBindsAndThen EmptyLocalBinds thing_inside
  = thing_inside EmptyLocalBinds

rnLocalBindsAndThen (HsValBinds val_binds) thing_inside
220
  = rnLocalValBindsAndThen val_binds $ \ val_binds' -> 
221
      thing_inside (HsValBinds val_binds')
222

223 224 225 226
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)
227

Ian Lynagh's avatar
Ian Lynagh committed
228
rnIPBinds :: HsIPBinds RdrName -> RnM (HsIPBinds Name, FreeVars)
229 230
rnIPBinds (IPBinds ip_binds _no_dict_binds) = do
    (ip_binds', fvs_s) <- mapAndUnzipM (wrapLocFstM rnIPBind) ip_binds
231
    return (IPBinds ip_binds' emptyTcEvBinds, plusFVs fvs_s)
232

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

240

241 242
%************************************************************************
%*									*
243
		ValBinds
244 245 246 247
%*									*
%************************************************************************

\begin{code}
248 249
-- Renaming local binding gropus 
-- Does duplicate/shadow check
250 251 252 253
rnLocalValBindsLHS :: MiniFixityEnv
                   -> HsValBinds RdrName
                   -> RnM ([Name], HsValBindsLR Name RdrName)
rnLocalValBindsLHS fix_env binds 
254 255 256 257 258 259 260 261 262 263 264 265 266 267
  = 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.
         -- 
     	 -- 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.
268
       ; binds' <- rnValBindsLHS (localRecNameMaker fix_env) binds 
269
       ; let bound_names = collectHsValBinders binds'
270 271 272
       ; envs <- getRdrEnvs
       ; checkDupAndShadowedNames envs bound_names
       ; return (bound_names, binds') }
273 274 275 276

-- 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
277 278 279 280
rnValBindsLHS :: NameMaker 
              -> HsValBinds RdrName
              -> RnM (HsValBindsLR Name RdrName)
rnValBindsLHS topP (ValBindsIn mbinds sigs)
281 282 283
  = do { mbinds' <- mapBagM (rnBindLHS topP doc) mbinds
       ; return $ ValBindsIn mbinds' sigs }
  where
284
    bndrs = collectHsBindsBinders mbinds
285 286
    doc   = text "In the binding group for:" <+> pprWithCommas ppr bndrs

287
rnValBindsLHS _ b = pprPanic "rnValBindsLHSFromDoc" (ppr b)
288

289 290
-- General version used both from the top-level and for local things
-- Assumes the LHS vars are in scope
291
--
292
-- Does not bind the local fixity declarations
293
rnValBindsRHS :: (FreeVars -> FreeVars)  -- for trimming free var sets
294 295
                     -- The trimming function trims the free vars we attach to a
                     -- binding so that it stays reasonably small
296 297 298 299 300 301 302
               -> Maybe NameSet	-- Names bound by the LHSes
	       	  		-- Nothing if expect sigs for imports
               -> HsValBindsLR Name RdrName
               -> RnM (HsValBinds Name, DefUses)

rnValBindsRHS trim mb_bound_names (ValBindsIn mbinds sigs)
  = do { sigs' <- renameSigs mb_bound_names okBindSig sigs
303 304
       ; binds_w_dus <- mapBagM (rnBind (mkSigTvFn sigs') trim) mbinds
       ; case depAnalBinds binds_w_dus of
305 306 307
           (anal_binds, anal_dus) -> return (valbind', valbind'_dus)
              where
                valbind' = ValBindsOut anal_binds sigs'
308 309 310 311
                valbind'_dus = anal_dus `plusDU` usesOnly (hsSigsFVs sigs')
			       -- Put the sig uses *after* the bindings
			       -- so that the binders are removed from 
			       -- the uses in the sigs
312 313 314
       }

rnValBindsRHS _ _ b = pprPanic "rnValBindsRHS" (ppr b)
315

316 317
noTrimFVs :: FreeVars -> FreeVars
noTrimFVs fvs = fvs
Ian Lynagh's avatar
Ian Lynagh committed
318

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

-- 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
339 340 341 342
rnLocalValBindsAndThen :: HsValBinds RdrName
                       -> (HsValBinds Name -> RnM (result, FreeVars))
                       -> RnM (result, FreeVars)
rnLocalValBindsAndThen binds@(ValBindsIn _ sigs) thing_inside
343 344
 = do	{     -- (A) Create the local fixity environment 
	  new_fixities <- makeMiniFixityEnv [L loc sig | L loc (FixSig sig) <- sigs]
345

346
	      -- (B) Rename the LHSes 
347
	; (bound_names, new_lhs) <- rnLocalValBindsLHS new_fixities binds
348

349
	      --     ...and bring them (and their fixities) into scope
350 351
	; bindLocalNamesFV bound_names              $
          addLocalFixities new_fixities bound_names $ do
352

353
	{      -- (C) Do the RHS and thing inside
354
	  (binds', dus) <- rnLocalValBindsRHS (mkNameSet bound_names) new_lhs 
355
        ; (result, result_fvs) <- thing_inside binds'
356

357 358 359 360 361
		-- 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
362 363 364
	      -- Insert fake uses for variables introduced implicitly by wildcards (#4404)
	      implicit_uses = hsValBindsImplicits binds'
	; warnUnusedLocalBinds bound_names (real_uses `unionNameSets` implicit_uses)
365

366 367
	; let
            -- The variables "used" in the val binds are: 
368
            --   (1) the uses of the binds (allUses)
369
            --   (2) the FVs of the thing-inside
370
            all_uses = allUses dus `plusFV` result_fvs
371 372 373 374 375
		-- 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:
376 377 378 379 380
                --	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
381 382 383 384 385 386 387
		--
		-- 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
388

389
rnLocalValBindsAndThen bs _ = pprPanic "rnLocalValBindsAndThen" (ppr bs)
390 391 392 393 394 395 396 397


-- 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.
398 399 400

makeMiniFixityEnv :: [LFixitySig RdrName] -> RnM MiniFixityEnv

401
makeMiniFixityEnv decls = foldlM add_one emptyFsEnv decls
402 403 404 405 406 407
 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)
408 409
       let { fs = occNameFS (rdrNameOcc name)
           ; fix_item = L loc fixity };
410

411 412
       case lookupFsEnv env fs of
         Nothing -> return $ extendFsEnv env fs fix_item
413 414
         Just (L loc' _) -> do
           { setSrcSpan loc $ 
415
             addErrAt name_loc (dupFixityDecl loc' name)
416 417 418
           ; return env}
     }

Ian Lynagh's avatar
Ian Lynagh committed
419
dupFixityDecl :: SrcSpan -> RdrName -> SDoc
420
dupFixityDecl loc rdr_name
Ian Lynagh's avatar
Ian Lynagh committed
421 422
  = vcat [ptext (sLit "Multiple fixity declarations for") <+> quotes (ppr rdr_name),
	  ptext (sLit "also at ") <+> ppr loc]
423

424
---------------------
425

426 427
-- renaming a single bind

428
rnBindLHS :: NameMaker
429 430 431 432 433 434 435
          -> 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)

436
rnBindLHS name_maker _ (L loc bind@(PatBind { pat_lhs = pat }))
437 438
  = setSrcSpan loc $ do
      -- we don't actually use the FV processing of rnPatsAndThen here
439
      (pat',pat'_fvs) <- rnBindPat name_maker pat
440 441 442 443 444 445
      return (L loc (bind { pat_lhs = pat', bind_fvs = pat'_fvs }))
                -- We temporarily store the pat's FVs in bind_fvs;
                -- gets updated to the FVs of the whole bind
                -- when doing the RHS below
                            
rnBindLHS name_maker _ (L loc bind@(FunBind { fun_id = name@(L nameLoc _) }))
446
  = setSrcSpan loc $ 
447
    do { newname <- applyNameMaker name_maker name
448
       ; return (L loc (bind { fun_id = L nameLoc newname })) } 
449

Ian Lynagh's avatar
Ian Lynagh committed
450 451
rnBindLHS _ _ b = pprPanic "rnBindLHS" (ppr b)

452 453 454 455 456
-- 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)
457 458 459
rnBind _ trim (L loc bind@(PatBind { pat_lhs = pat
                                   , pat_rhs = grhss 
                                      -- pat fvs were stored in bind_fvs
460
                                      -- after processing the LHS
461
                                   , bind_fvs = pat_fvs }))
462
  = setSrcSpan loc $ 
463
    do	{ let bndrs = collectPatBinders pat
464

465 466
	; (grhss', fvs) <- rnGRHSs PatBindRhs grhss
		-- No scoped type variables for pattern bindings
467 468
	; let all_fvs = pat_fvs `plusFV` fvs
              fvs'    = trim all_fvs
469

470
	; fvs' `seq` -- See Note [Free-variable space leak]
471 472
          return (L loc (bind { pat_rhs  = grhss' 
			      , bind_fvs = fvs' }),
473
		  bndrs, all_fvs) }
474

475 476 477 478
rnBind sig_fn trim 
       (L loc bind@(FunBind { fun_id = name 
                            , fun_infix = is_infix 
                            , fun_matches = matches })) 
479
       -- invariant: no free vars here when it's a FunBind
480
  = setSrcSpan loc $
481
    do	{ let plain_name = unLoc name
482

483 484
	; (matches', fvs) <- bindSigTyVarsFV (sig_fn plain_name) $
				-- bindSigTyVars tests for Opt_ScopedTyVars
485
			     rnMatchGroup (FunRhs plain_name is_infix) matches
Ian Lynagh's avatar
Ian Lynagh committed
486
	; let fvs' = trim fvs
487

488
	; when is_infix $ checkPrecMatch plain_name matches'
489

490
	; fvs' `seq` -- See Note [Free-variable space leak]
491

492 493
          return (L loc (bind { fun_matches = matches'
			      , bind_fvs   = fvs' }), 
494 495
		  [plain_name], fvs)
      }
Ian Lynagh's avatar
Ian Lynagh committed
496 497

rnBind _ _ b = pprPanic "rnBind" (ppr b)
498 499 500 501 502 503 504 505 506 507 508 509 510 511

{-
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.
-}

512 513 514
---------------------
depAnalBinds :: Bag (LHsBind Name, [Name], Uses)
	     -> ([(RecFlag, LHsBinds Name)], DefUses)
515 516
-- Dependency analysis; this is important so that 
-- unused-binding reporting is accurate
517 518 519
depAnalBinds binds_w_dus
  = (map get_binds sccs, map get_du sccs)
  where
520
    sccs = stronglyConnCompFromEdgedVertices edges
521 522 523

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

524 525
    edges = [ (node, key, [key | n <- nameSetToList uses,
			         Just key <- [lookupNameEnv key_map n] ])
526
	    | (node@(_,_,uses), key) <- keyd_nodes ]
527

528 529 530
    key_map :: NameEnv Int	-- Which binding it comes from
    key_map = mkNameEnv [(bndr, key) | ((_, bndrs, _), key) <- keyd_nodes
				     , bndr <- bndrs ]
531

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

535 536 537 538 539
    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]
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559


---------------------
-- 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` []
560
  where
561 562
    env :: NameEnv [Name]
    env = mkNameEnv [ (name, map hsLTyVarName ltvs)
563 564
		    | L _ (TypeSig (L _ name) 
			           (L _ (HsForAllTy Explicit ltvs _ _))) <- sigs]
565 566
	-- Note the pattern-match on "Explicit"; we only bind
	-- type variables from signatures with an explicit top-level for-all
567 568 569 570
\end{code}


@rnMethodBinds@ is used for the method bindings of a class and an instance
571
declaration.   Like @rnBinds@ but without dependency analysis.
572 573 574 575 576 577 578 579 580 581 582 583 584 585

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}
586
rnMethodBinds :: Name			-- Class name
587
	      -> (Name -> [Name])	-- Signature tyvar function
588
	      -> LHsBinds RdrName
589
	      -> RnM (LHsBinds Name, FreeVars)
590

dreixel's avatar
dreixel committed
591
rnMethodBinds cls sig_fn binds
592 593 594 595 596 597 598 599 600 601 602 603
  = do { checkDupRdrNames meth_names
	     -- Check that the same method is not given twice in the
	     -- same instance decl	instance C T where
	     --			      f x = ...
	     --			      g y = ...
	     --			      f x = ...
	     -- We must use checkDupRdrNames because the Name of the
	     -- method is the Name of the class selector, whose SrcSpan
	     -- points to the class declaration; and we use rnMethodBinds
	     -- for instance decls too

       ; foldlM do_one (emptyBag, emptyFVs) (bagToList binds) }
604
  where 
605
    meth_names  = collectMethodBinders binds
606
    do_one (binds,fvs) bind 
dreixel's avatar
dreixel committed
607
       = do { (bind', fvs_bind) <- rnMethodBind cls sig_fn bind
608
	    ; return (binds `unionBags` bind', fvs_bind `plusFV` fvs) }
609

Ian Lynagh's avatar
Ian Lynagh committed
610 611 612 613
rnMethodBind :: Name
	      -> (Name -> [Name])
	      -> LHsBindLR RdrName RdrName
	      -> RnM (Bag (LHsBindLR Name Name), FreeVars)
dreixel's avatar
dreixel committed
614
rnMethodBind cls sig_fn 
615 616
             (L loc bind@(FunBind { fun_id = name, fun_infix = is_infix 
				  , fun_matches = MatchGroup matches _ }))
617
  = setSrcSpan loc $ do
618
    sel_name <- wrapLocM (lookupInstDeclBndr cls) name
619 620 621
    let plain_name = unLoc sel_name
        -- We use the selector name as the binder

622
    (new_matches, fvs) <- bindSigTyVarsFV (sig_fn plain_name) $
dreixel's avatar
dreixel committed
623
                          mapFvRn (rnMatch (FunRhs plain_name is_infix)) matches
624
    let new_group = MatchGroup new_matches placeHolderType
625

626
    when is_infix $ checkPrecMatch plain_name new_group
627 628 629
    return (unitBag (L loc (bind { fun_id      = sel_name 
                                 , fun_matches = new_group
                                 , bind_fvs    = fvs })),
630 631
             fvs `addOneFV` plain_name)
        -- The 'fvs' field isn't used for method binds
632 633

-- Can't handle method pattern-bindings which bind multiple methods.
dreixel's avatar
dreixel committed
634
rnMethodBind _ _ (L loc bind@(PatBind {})) = do
635
    addErrAt loc (methodBindErr bind)
636
    return (emptyBag, emptyFVs)
Ian Lynagh's avatar
Ian Lynagh committed
637

dreixel's avatar
dreixel committed
638
rnMethodBind _ _ b = pprPanic "rnMethodBind" (ppr b)
639 640 641
\end{code}


642

643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
%************************************************************************
%*									*
\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}
659
renameSigs :: Maybe NameSet		-- If (Just ns) complain if the sig isn't for one of ns
660
	   -> (Sig Name -> Bool) 	-- Complain about the wrong kind of signature if this is False
661 662
	   -> [LSig RdrName]
	   -> RnM [LSig Name]
663
-- Renames the signatures and performs error checks
664
renameSigs mb_names ok_sig sigs 
665 666 667 668
  = do	{ mapM_ dupSigDeclErr (findDupsEq eqHsSig sigs)  -- Duplicate
	  	-- Check for duplicates on RdrName version, 
		-- because renamed version has unboundName for
		-- not-in-scope binders, which gives bogus dup-sig errors
669 670 671 672
		-- NB: in a class decl, a 'generic' sig is not considered 
		--     equal to an ordinary sig, so we allow, say
		--     	     class C a where
		--	       op :: a -> a
dreixel's avatar
dreixel committed
673
 		--             default op :: Eq a => a -> a
674
		
675 676 677 678 679 680
	; sigs' <- mapM (wrapLocM (renameSig mb_names)) sigs

	; let (good_sigs, bad_sigs) = partition (ok_sig . unLoc) sigs'
	; mapM_ misplacedSigErr bad_sigs		 -- Misplaced

	; return good_sigs } 
681 682

----------------------
683
-- We use lookupSigOccRn in the signatures, which is a little bit unsatisfactory
684 685 686 687 688 689 690 691
-- 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.

692 693
renameSig :: Maybe NameSet -> Sig RdrName -> RnM (Sig Name)
-- FixitySig is renamed elsewhere.
694 695
renameSig _ (IdSig x)
  = return (IdSig x)	  -- Actually this never occurs
696
renameSig mb_names sig@(TypeSig v ty)
697
  = do	{ new_v <- lookupSigOccRn mb_names sig v
698 699 700
	; new_ty <- rnHsSigType (quotes (ppr v)) ty
	; return (TypeSig new_v new_ty) }

701
renameSig mb_names sig@(GenericSig v ty)
702 703
  = do	{ defaultSigs_on <- xoptM Opt_DefaultSignatures
        ; unless defaultSigs_on (addErr (defaultSigErr sig))
704
        ; new_v <- lookupSigOccRn mb_names sig v
705
	; new_ty <- rnHsSigType (quotes (ppr v)) ty
dreixel's avatar
dreixel committed
706
	; return (GenericSig new_v new_ty) }
707

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

712 713 714
-- {-# SPECIALISE #-} pragmas can refer to imported Ids
-- so, in the top-level case (when mb_names is Nothing)
-- we use lookupOccRn.  If there's both an imported and a local 'f'
simonpj's avatar
simonpj committed
715
-- then the SPECIALISE pragma is ambiguous, unlike all other signatures
716
renameSig mb_names sig@(SpecSig v ty inl)
717 718 719
  = do	{ new_v <- case mb_names of
                     Just {} -> lookupSigOccRn mb_names sig v
                     Nothing -> lookupLocatedOccRn v
720 721 722 723
	; new_ty <- rnHsSigType (quotes (ppr v)) ty
	; return (SpecSig new_v new_ty inl) }

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

renameSig mb_names sig@(FixSig (FixitySig v f))
728
  = do	{ new_v <- lookupSigOccRn mb_names sig v
729
	; return (FixSig (FixitySig new_v f)) }
730 731 732
\end{code}


Thomas Schilling's avatar
Thomas Schilling committed
733 734
%************************************************************************
%*									*
735
\subsection{Match}
Thomas Schilling's avatar
Thomas Schilling committed
736 737
%*									*
%************************************************************************
738 739 740

\begin{code}
rnMatchGroup :: HsMatchContext Name -> MatchGroup RdrName -> RnM (MatchGroup Name, FreeVars)
741 742 743
rnMatchGroup ctxt (MatchGroup ms _) 
  = do { (new_ms, ms_fvs) <- mapFvRn (rnMatch ctxt) ms
       ; return (MatchGroup new_ms placeHolderType, ms_fvs) }
744 745 746 747

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

Ian Lynagh's avatar
Ian Lynagh committed
748
rnMatch' :: HsMatchContext Name -> Match RdrName -> RnM (Match Name, FreeVars)
749 750 751 752
rnMatch' ctxt match@(Match pats maybe_rhs_sig grhss)
  = do 	{ 	-- Result type signatures are no longer supported
	  case maybe_rhs_sig of	
	        Nothing -> return ()
753
	        Just (L loc ty) -> addErrAt loc (resSigErr ctxt match ty)
754 755 756

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

	; return (Match pats' Nothing grhss', grhss_fvs) }}
761
	-- The bindPatSigTyVarsFV and rnPatsAndThen will remove the bound FVs
762 763 764 765 766 767

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 ]
768 769 770 771 772 773 774 775 776 777 778 779 780
\end{code}


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

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

rnGRHSs ctxt (GRHSs grhss binds)
781 782 783
  = rnLocalBindsAndThen binds	$ \ binds' -> do
    (grhss', fvGRHSs) <- mapFvRn (rnGRHS ctxt) grhss
    return (GRHSs grhss' binds', fvGRHSs)
784 785 786 787

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

Ian Lynagh's avatar
Ian Lynagh committed
788
rnGRHS' :: HsMatchContext Name -> GRHS RdrName -> RnM (GRHS Name, FreeVars)
789
rnGRHS' ctxt (GRHS guards rhs)
790
  = do	{ pattern_guards_allowed <- xoptM Opt_PatternGuards
791
        ; ((guards', rhs'), fvs) <- rnStmts (PatGuard ctxt) guards $ \ _ ->
792
				    rnLExpr rhs
793

794
	; unless (pattern_guards_allowed || is_standard_guard guards')
795 796
	  	 (addWarn (nonStdGuardErr guards'))

797 798 799 800 801
	; 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
802 803 804
    is_standard_guard []                       = True
    is_standard_guard [L _ (ExprStmt _ _ _ _)] = True
    is_standard_guard _                        = False
805 806
\end{code}

807 808 809 810 811 812 813
%************************************************************************
%*									*
\subsection{Error messages}
%*									*
%************************************************************************

\begin{code}
814
dupSigDeclErr :: [LSig RdrName] -> RnM ()
815
dupSigDeclErr sigs@(L loc sig : _)
816
  = addErrAt loc $
Ian Lynagh's avatar
Ian Lynagh committed
817
	vcat [ptext (sLit "Duplicate") <+> what_it_is <> colon,
818
	      nest 2 (vcat (map ppr_sig sigs))]
819
  where
820 821
    what_it_is = hsSigDoc sig
    ppr_sig (L loc sig) = ppr loc <> colon <+> ppr sig
Ian Lynagh's avatar
Ian Lynagh committed
822
dupSigDeclErr [] = panic "dupSigDeclErr"
823

824 825
misplacedSigErr :: LSig Name -> RnM ()
misplacedSigErr (L loc sig)
826 827
  = addErrAt loc $
    sep [ptext (sLit "Misplaced") <+> hsSigDoc sig <> colon, ppr sig]
828

829 830
defaultSigErr :: Sig RdrName -> SDoc
defaultSigErr sig = vcat [ hang (ptext (sLit "Unexpected default signature:"))
831
                              2 (ppr sig)
832
                         , ptext (sLit "Use -XDefaultSignatures to enable default signatures") ] 
833

Ian Lynagh's avatar
Ian Lynagh committed
834
methodBindErr :: HsBindLR RdrName RdrName -> SDoc
835
methodBindErr mbind
Ian Lynagh's avatar
Ian Lynagh committed
836
 =  hang (ptext (sLit "Pattern bindings (except simple variables) not allowed in instance declarations"))
837 838
       2 (ppr mbind)

Ian Lynagh's avatar
Ian Lynagh committed
839
bindsInHsBootFile :: LHsBindsLR Name RdrName -> SDoc
840
bindsInHsBootFile mbinds
Ian Lynagh's avatar
Ian Lynagh committed
841
  = hang (ptext (sLit "Bindings in hs-boot files are not allowed"))
842
       2 (ppr mbinds)
843

Ian Lynagh's avatar
Ian Lynagh committed
844
nonStdGuardErr :: [LStmtLR Name Name] -> SDoc
845
nonStdGuardErr guards
Ian Lynagh's avatar
Ian Lynagh committed
846
  = hang (ptext (sLit "accepting non-standard pattern guards (use -XPatternGuards to suppress this message)"))
847
       4 (interpp'SP guards)
848

849
\end{code}