RnBinds.lhs 39.3 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}
Ian Lynagh's avatar
Ian Lynagh committed
12 13 14 15
{-# OPTIONS -fno-warn-tabs #-}
-- The above warning supression flag is a temporary kludge.
-- While working on this module you are encouraged to remove it and
-- detab the module (please do the detabbing in a separate patch). See
16
--     http://ghc.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#TabsvsSpaces
Ian Lynagh's avatar
Ian Lynagh committed
17 18
-- for details

19 20
module RnBinds (
   -- Renaming top-level bindings
21
   rnTopBindsLHS, rnTopBindsRHS, rnValBindsRHS,
22 23 24 25 26 27

   -- Renaming local bindings
   rnLocalBindsAndThen, rnLocalValBindsLHS, rnLocalValBindsRHS,

   -- Other bindings
   rnMethodBinds, renameSigs, mkSigTvFn,
28
   rnMatchGroup, rnGRHSs, rnGRHS,
29
   makeMiniFixityEnv, MiniFixityEnv,
30
   HsSigCtxt(..)
31 32
   ) where

33
import {-# SOURCE #-} RnExpr( rnLExpr, rnStmts )
34 35

import HsSyn
36
import TcRnMonad
37
import TcEvidence     ( emptyTcEvBinds )
cactus's avatar
cactus committed
38
import RnTypes        ( bindSigTyVarsFV, rnHsSigType, rnLHsType, checkPrecMatch, rnContext )
39
import RnPat
cactus's avatar
cactus committed
40
import RnNames
41
import RnEnv
42
import DynFlags
43
import Module
44
import Name
45
import NameEnv
46
import NameSet
47
import RdrName          ( RdrName, rdrNameOcc )
Ian Lynagh's avatar
Ian Lynagh committed
48
import SrcLoc
49
import ListSetOps	( findDupsEq )
cactus's avatar
cactus committed
50
import BasicTypes	( RecFlag(..), Origin )
51
import Digraph		( SCC(..) )
52
import Bag
53
import Outputable
54
import FastString
55
import Data.List	( partition, sort )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
56
import Maybes		( orElse )
Ian Lynagh's avatar
Ian Lynagh committed
57
import Control.Monad
58
import Data.Traversable ( traverse )
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 110 111 112 113 114 115 116
\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}

%************************************************************************
%*									*
117
%* analysing polymorphic bindings (HsBindGroup, HsBind)
118 119 120 121 122 123 124 125 126 127 128
%*									*
%************************************************************************

\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
129
(a @FlatMonoBinds@) containing:
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 161 162 163 164 165 166 167

\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}
168 169
-- for top-level bindings, we need to make top-level names,
-- so we have a different entry point than for local bindings
170
rnTopBindsLHS :: MiniFixityEnv
171 172
              -> HsValBinds RdrName 
              -> RnM (HsValBindsLR Name RdrName)
173
rnTopBindsLHS fix_env binds
174
  = rnValBindsLHS (topRecNameMaker fix_env) binds
175

176
rnTopBindsRHS :: NameSet -> HsValBindsLR Name RdrName 
177
              -> RnM (HsValBinds Name, DefUses)
178
rnTopBindsRHS bound_names binds
179
  = do { is_boot <- tcIsHsBoot
180 181
       ; if is_boot 
         then rnTopBindsBoot binds
182
         else rnValBindsRHS (TopSigCtxt bound_names False) binds }
183 184

rnTopBindsBoot :: HsValBindsLR Name RdrName -> RnM (HsValBinds Name, DefUses)
185 186
-- A hs-boot file has no bindings. 
-- Return a single HsBindGroup with empty binds and renamed signatures
187
rnTopBindsBoot (ValBindsIn mbinds sigs)
188
  = do	{ checkErr (isEmptyLHsBinds mbinds) (bindsInHsBootFile mbinds)
189 190
	; (sigs', fvs) <- renameSigs HsBootCtxt sigs
	; return (ValBindsOut [] sigs', usesOnly fvs) }
Ian Lynagh's avatar
Ian Lynagh committed
191
rnTopBindsBoot b = pprPanic "rnTopBindsBoot" (ppr b)
192 193 194 195 196 197 198 199 200 201
\end{code}


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

\begin{code}
202 203 204 205 206
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
207 208 209 210 211
-- The parser doesn't produce ThenBinds
rnLocalBindsAndThen EmptyLocalBinds thing_inside
  = thing_inside EmptyLocalBinds

rnLocalBindsAndThen (HsValBinds val_binds) thing_inside
212
  = rnLocalValBindsAndThen val_binds $ \ val_binds' -> 
213
      thing_inside (HsValBinds val_binds')
214

215 216 217 218
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)
219

Ian Lynagh's avatar
Ian Lynagh committed
220
rnIPBinds :: HsIPBinds RdrName -> RnM (HsIPBinds Name, FreeVars)
221 222
rnIPBinds (IPBinds ip_binds _no_dict_binds) = do
    (ip_binds', fvs_s) <- mapAndUnzipM (wrapLocFstM rnIPBind) ip_binds
223
    return (IPBinds ip_binds' emptyTcEvBinds, plusFVs fvs_s)
224

Ian Lynagh's avatar
Ian Lynagh committed
225
rnIPBind :: IPBind RdrName -> RnM (IPBind Name, FreeVars)
226
rnIPBind (IPBind ~(Left n) expr) = do
227
    (expr',fvExpr) <- rnLExpr expr
228
    return (IPBind (Left n) expr', fvExpr)
229 230
\end{code}

231

232 233
%************************************************************************
%*									*
234
		ValBinds
235 236 237 238
%*									*
%************************************************************************

\begin{code}
239 240
-- Renaming local binding gropus 
-- Does duplicate/shadow check
241 242 243 244
rnLocalValBindsLHS :: MiniFixityEnv
                   -> HsValBinds RdrName
                   -> RnM ([Name], HsValBindsLR Name RdrName)
rnLocalValBindsLHS fix_env binds 
245 246 247 248 249 250 251
  = do { binds' <- rnValBindsLHS (localRecNameMaker fix_env) binds 

         -- Check for duplicates and shadowing
	 -- Must do this *after* renaming the patterns
	 -- See Note [Collect binders only after renaming] in HsUtils

         -- We need to check for dups here because we
252 253 254 255 256 257 258 259 260 261 262 263 264
     	 -- 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.
265
       ; let bound_names = collectHsValBinders binds'
266 267
       ; envs <- getRdrEnvs
       ; checkDupAndShadowedNames envs bound_names
268

269
       ; return (bound_names, binds') }
270 271 272 273

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

284
rnValBindsLHS _ b = pprPanic "rnValBindsLHSFromDoc" (ppr b)
285

286 287
-- General version used both from the top-level and for local things
-- Assumes the LHS vars are in scope
288
--
289
-- Does not bind the local fixity declarations
290 291 292
rnValBindsRHS :: HsSigCtxt 
              -> HsValBindsLR Name RdrName
              -> RnM (HsValBinds Name, DefUses)
293

294
rnValBindsRHS ctxt (ValBindsIn mbinds sigs)
295
  = do { (sigs', sig_fvs) <- renameSigs ctxt sigs
cactus's avatar
cactus committed
296
       ; binds_w_dus <- mapBagM (rnLBind (mkSigTvFn sigs')) mbinds
297
       ; case depAnalBinds binds_w_dus of
298 299 300
           (anal_binds, anal_dus) -> return (valbind', valbind'_dus)
              where
                valbind' = ValBindsOut anal_binds sigs'
301
                valbind'_dus = anal_dus `plusDU` usesOnly sig_fvs
302 303 304
			       -- Put the sig uses *after* the bindings
			       -- so that the binders are removed from 
			       -- the uses in the sigs
305 306
       }

307
rnValBindsRHS _ b = pprPanic "rnValBindsRHS" (ppr b)
Ian Lynagh's avatar
Ian Lynagh committed
308

309
-- Wrapper for local binds
310
--
311
-- The *client* of this function is responsible for checking for unused binders;
312 313
-- it doesn't (and can't: we don't have the thing inside the binds) happen here
--
314
-- The client is also responsible for bringing the fixities into scope
315 316 317 318
rnLocalValBindsRHS :: NameSet  -- names bound by the LHSes
                   -> HsValBindsLR Name RdrName
                   -> RnM (HsValBinds Name, DefUses)
rnLocalValBindsRHS bound_names binds
319
  = rnValBindsRHS (LocalBindCtxt bound_names) binds
320 321 322 323 324 325

-- 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
326 327 328 329
rnLocalValBindsAndThen :: HsValBinds RdrName
                       -> (HsValBinds Name -> RnM (result, FreeVars))
                       -> RnM (result, FreeVars)
rnLocalValBindsAndThen binds@(ValBindsIn _ sigs) thing_inside
330 331
 = do	{     -- (A) Create the local fixity environment 
	  new_fixities <- makeMiniFixityEnv [L loc sig | L loc (FixSig sig) <- sigs]
332

333
	      -- (B) Rename the LHSes 
334
	; (bound_names, new_lhs) <- rnLocalValBindsLHS new_fixities binds
335

336
	      --     ...and bring them (and their fixities) into scope
337 338
	; bindLocalNamesFV bound_names              $
          addLocalFixities new_fixities bound_names $ do
339

340
	{      -- (C) Do the RHS and thing inside
341
	  (binds', dus) <- rnLocalValBindsRHS (mkNameSet bound_names) new_lhs 
342
        ; (result, result_fvs) <- thing_inside binds'
343

344 345 346 347 348
		-- 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
349 350 351
	      -- Insert fake uses for variables introduced implicitly by wildcards (#4404)
	      implicit_uses = hsValBindsImplicits binds'
	; warnUnusedLocalBinds bound_names (real_uses `unionNameSets` implicit_uses)
352

353 354
	; let
            -- The variables "used" in the val binds are: 
355
            --   (1) the uses of the binds (allUses)
356
            --   (2) the FVs of the thing-inside
357
            all_uses = allUses dus `plusFV` result_fvs
358 359 360 361 362
		-- 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:
363 364 365 366 367
                --	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
368 369 370 371 372 373 374
		--
		-- 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
375

376
rnLocalValBindsAndThen bs _ = pprPanic "rnLocalValBindsAndThen" (ppr bs)
377 378 379 380 381 382 383 384


-- 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.
385 386 387

makeMiniFixityEnv :: [LFixitySig RdrName] -> RnM MiniFixityEnv

388
makeMiniFixityEnv decls = foldlM add_one emptyFsEnv decls
389 390 391 392 393 394
 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)
395 396
       let { fs = occNameFS (rdrNameOcc name)
           ; fix_item = L loc fixity };
397

398 399
       case lookupFsEnv env fs of
         Nothing -> return $ extendFsEnv env fs fix_item
400 401
         Just (L loc' _) -> do
           { setSrcSpan loc $ 
402
             addErrAt name_loc (dupFixityDecl loc' name)
403 404 405
           ; return env}
     }

Ian Lynagh's avatar
Ian Lynagh committed
406
dupFixityDecl :: SrcSpan -> RdrName -> SDoc
407
dupFixityDecl loc rdr_name
Ian Lynagh's avatar
Ian Lynagh committed
408 409
  = vcat [ptext (sLit "Multiple fixity declarations for") <+> quotes (ppr rdr_name),
	  ptext (sLit "also at ") <+> ppr loc]
410

411
---------------------
412

413 414
-- renaming a single bind

415
rnBindLHS :: NameMaker
416
          -> SDoc 
cactus's avatar
cactus committed
417
          -> HsBind RdrName
418 419 420
          -- returns the renamed left-hand side,
          -- and the FreeVars *of the LHS*
          -- (i.e., any free variables of the pattern)
cactus's avatar
cactus committed
421
          -> RnM (HsBindLR Name RdrName)
422

cactus's avatar
cactus committed
423 424
rnBindLHS name_maker _ bind@(PatBind { pat_lhs = pat })
  = do
425
      -- we don't actually use the FV processing of rnPatsAndThen here
426
      (pat',pat'_fvs) <- rnBindPat name_maker pat
cactus's avatar
cactus committed
427
      return (bind { pat_lhs = pat', bind_fvs = pat'_fvs })
428 429 430
                -- We temporarily store the pat's FVs in bind_fvs;
                -- gets updated to the FVs of the whole bind
                -- when doing the RHS below
431

cactus's avatar
cactus committed
432 433 434 435 436
rnBindLHS name_maker _ bind@(FunBind { fun_id = name@(L nameLoc _) })
  = do { newname <- applyNameMaker name_maker name
       ; return (bind { fun_id = L nameLoc newname }) } 

rnBindLHS name_maker _ bind@(PatSynBind{ patsyn_id = rdrname@(L nameLoc _) })
437 438 439
  = do { unless (isTopRecNameMaker name_maker) $
           addErr localPatternSynonymErr
       ; addLocM checkConName rdrname
cactus's avatar
cactus committed
440 441
       ; name <- applyNameMaker name_maker rdrname
       ; return (bind{ patsyn_id = L nameLoc name }) }
442 443 444 445 446
  where
    localPatternSynonymErr :: SDoc
    localPatternSynonymErr
      = hang (ptext (sLit "Illegal pattern synonym declaration"))
           2 (ptext (sLit "Pattern synonym declarations are only valid in the top-level scope"))
cactus's avatar
cactus committed
447 448 449 450 451 452 453 454 455 456

rnBindLHS _ _ b = pprPanic "rnBindHS" (ppr b)

rnLBind :: (Name -> [Name])		-- Signature tyvar function
        -> (Origin, LHsBindLR Name RdrName)
        -> RnM ((Origin, LHsBind Name), [Name], Uses)
rnLBind sig_fn (origin, (L loc bind))
  = setSrcSpan loc $
    do { (bind', bndrs, dus) <- rnBind sig_fn bind
       ; return ((origin, L loc bind'), bndrs, dus) }
Ian Lynagh's avatar
Ian Lynagh committed
457

458 459
-- assumes the left-hands-side vars are in scope
rnBind :: (Name -> [Name])		-- Signature tyvar function
cactus's avatar
cactus committed
460 461 462 463 464 465 466 467
       -> HsBindLR Name RdrName
       -> RnM (HsBind Name, [Name], Uses)
rnBind _ bind@(PatBind { pat_lhs = pat
                       , pat_rhs = grhss 
                                   -- pat fvs were stored in bind_fvs
                                   -- after processing the LHS
                       , bind_fvs = pat_fvs })
  = do	{ mod <- getModule
468
        ; (grhss', rhs_fvs) <- rnGRHSs PatBindRhs rnLExpr grhss
469

470
		-- No scoped type variables for pattern bindings
471 472 473 474 475
	; let all_fvs = pat_fvs `plusFV` rhs_fvs
              fvs'    = filterNameSet (nameIsLocalOrFrom mod) all_fvs
	        -- Keep locally-defined Names
		-- As well as dependency analysis, we need these for the
		-- MonoLocalBinds test in TcBinds.decideGeneralisationPlan
476 477
              bndrs = collectPatBinders pat
              bind' = bind { pat_rhs  = grhss', bind_fvs = fvs' }
478 479 480 481 482 483 484 485 486
              is_wild_pat = case pat of
                              L _ (WildPat {}) -> True
                              _                -> False

        -- Warn if the pattern binds no variables, except for the
        -- entirely-explicit idiom    _ = rhs
        -- which (a) is not that different from  _v = rhs
        --       (b) is sometimes used to give a type sig for,
        --           or an occurrence of, a variable on the RHS
ian@well-typed.com's avatar
ian@well-typed.com committed
487
        ; whenWOptM Opt_WarnUnusedBinds $
488 489
          when (null bndrs && not is_wild_pat) $
          addWarn $ unusedPatBindWarn bind'
490

491
	; fvs' `seq` -- See Note [Free-variable space leak]
cactus's avatar
cactus committed
492
          return (bind', bndrs, all_fvs) }
493

cactus's avatar
cactus committed
494 495 496
rnBind sig_fn bind@(FunBind { fun_id = name 
                            , fun_infix = is_infix 
                            , fun_matches = matches }) 
497
       -- invariant: no free vars here when it's a FunBind
cactus's avatar
cactus committed
498
  = do	{ let plain_name = unLoc name
499

500
	; (matches', rhs_fvs) <- bindSigTyVarsFV (sig_fn plain_name) $
501
				-- bindSigTyVars tests for Opt_ScopedTyVars
502
			         rnMatchGroup (FunRhs plain_name is_infix) rnLExpr matches
503
	; when is_infix $ checkPrecMatch plain_name matches'
504

505 506 507 508 509
        ; mod <- getModule
        ; let fvs' = filterNameSet (nameIsLocalOrFrom mod) rhs_fvs
	        -- Keep locally-defined Names
		-- As well as dependency analysis, we need these for the
		-- MonoLocalBinds test in TcBinds.decideGeneralisationPlan
510

511
	; fvs' `seq` -- See Note [Free-variable space leak]
cactus's avatar
cactus committed
512 513
          return (bind { fun_matches = matches'
	               , bind_fvs   = fvs' },
514
		  [plain_name], rhs_fvs)
515
      }
Ian Lynagh's avatar
Ian Lynagh committed
516

cactus's avatar
cactus committed
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
rnBind _sig_fn bind@(PatSynBind { patsyn_id = L _ name
                                , patsyn_args = details
                                , patsyn_def = pat
                                , patsyn_dir = dir })
       -- invariant: no free vars here when it's a FunBind
  = do	{ pattern_synonym_ok <- xoptM Opt_PatternSynonyms
        ; unless pattern_synonym_ok (addErr patternSynonymErr)

        ; ((pat', details'), fvs) <- rnPat PatSyn pat $ \pat' -> do
         -- We check the 'RdrName's instead of the 'Name's
         -- so that the binding locations are reported
         -- from the left-hand side
        { (details', fvs) <- case details of
               PrefixPatSyn vars ->
                   do { checkDupRdrNames vars
                      ; names <- mapM lookupVar vars
                      ; return (PrefixPatSyn names, mkFVs (map unLoc names)) }
               InfixPatSyn var1 var2 ->
                   do { checkDupRdrNames [var1, var2]
                      ; name1 <- lookupVar var1
                      ; name2 <- lookupVar var2
                      -- ; checkPrecMatch -- TODO
                      ; return (InfixPatSyn name1 name2, mkFVs (map unLoc [name1, name2])) }
        ; return ((pat', details'), fvs) }
        ; dir' <- case dir of
            Unidirectional -> return Unidirectional
            ImplicitBidirectional -> return ImplicitBidirectional

        ; mod <- getModule
        ; let fvs' = filterNameSet (nameIsLocalOrFrom mod) fvs
	        -- Keep locally-defined Names
		-- As well as dependency analysis, we need these for the
		-- MonoLocalBinds test in TcBinds.decideGeneralisationPlan

        ; let bind' = bind{ patsyn_args = details'
                          , patsyn_def = pat'
                          , patsyn_dir = dir'
                          , bind_fvs = fvs' }

        ; fvs' `seq` -- See Note [Free-variable space leak]
          return (bind', [name], fvs)
      }
  where
    lookupVar = wrapLocM lookupOccRn

    patternSynonymErr :: SDoc
    patternSynonymErr
      = hang (ptext (sLit "Illegal pattern synonym declaration"))
           2 (ptext (sLit "Use -XPatternSynonyms to enable this extension"))


568
rnBind _ b = pprPanic "rnBind" (ppr b)
569 570 571 572 573 574 575 576 577 578 579 580 581 582

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

583
---------------------
cactus's avatar
cactus committed
584
depAnalBinds :: Bag ((Origin, LHsBind Name), [Name], Uses)
585
	     -> ([(RecFlag, LHsBinds Name)], DefUses)
586 587
-- Dependency analysis; this is important so that 
-- unused-binding reporting is accurate
588 589 590
depAnalBinds binds_w_dus
  = (map get_binds sccs, map get_du sccs)
  where
591 592 593
    sccs = depAnal (\(_, defs, _) -> defs)
                   (\(_, _, uses) -> nameSetToList uses)
                   (bagToList binds_w_dus)
594

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

598 599 600 601 602
    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]
603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621

---------------------
-- 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` []
622
  where
623
    env :: NameEnv [Name]
624
    env = mkNameEnv [ (name, hsLKiTyVarNames ltvs)  -- Kind variables and type variables
625 626 627
		    | L _ (TypeSig names
			           (L _ (HsForAllTy Explicit ltvs _ _))) <- sigs
                    , (L _ name) <- names]
628 629
	-- Note the pattern-match on "Explicit"; we only bind
	-- type variables from signatures with an explicit top-level for-all
630 631 632 633
\end{code}


@rnMethodBinds@ is used for the method bindings of a class and an instance
634
declaration.   Like @rnBinds@ but without dependency analysis.
635 636 637 638 639 640 641 642 643 644 645 646 647 648

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}
649
rnMethodBinds :: Name			-- Class name
650
	      -> (Name -> [Name])	-- Signature tyvar function
651
	      -> LHsBinds RdrName
652
	      -> RnM (LHsBinds Name, FreeVars)
653

dreixel's avatar
dreixel committed
654
rnMethodBinds cls sig_fn binds
655 656 657 658 659 660 661 662 663 664 665 666
  = 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) }
667
  where 
668
    meth_names  = collectMethodBinders binds
cactus's avatar
cactus committed
669
    do_one (binds,fvs) (origin,bind)
dreixel's avatar
dreixel committed
670
       = do { (bind', fvs_bind) <- rnMethodBind cls sig_fn bind
cactus's avatar
cactus committed
671 672
            ; let bind'' = mapBag (\bind -> (origin,bind)) bind'
	    ; return (binds `unionBags` bind'', fvs_bind `plusFV` fvs) }
673

Ian Lynagh's avatar
Ian Lynagh committed
674 675 676 677
rnMethodBind :: Name
	      -> (Name -> [Name])
	      -> LHsBindLR RdrName RdrName
	      -> RnM (Bag (LHsBindLR Name Name), FreeVars)
dreixel's avatar
dreixel committed
678
rnMethodBind cls sig_fn 
679
             (L loc bind@(FunBind { fun_id = name, fun_infix = is_infix 
680
				  , fun_matches = MG { mg_alts = matches } }))
681
  = setSrcSpan loc $ do
682
    sel_name <- wrapLocM (lookupInstDeclBndr cls (ptext (sLit "method"))) name
683 684 685
    let plain_name = unLoc sel_name
        -- We use the selector name as the binder

686
    (new_matches, fvs) <- bindSigTyVarsFV (sig_fn plain_name) $
687
                          mapFvRn (rnMatch (FunRhs plain_name is_infix) rnLExpr) matches
688
    let new_group = mkMatchGroup new_matches
689

690
    when is_infix $ checkPrecMatch plain_name new_group
691 692 693
    return (unitBag (L loc (bind { fun_id      = sel_name 
                                 , fun_matches = new_group
                                 , bind_fvs    = fvs })),
694 695
             fvs `addOneFV` plain_name)
        -- The 'fvs' field isn't used for method binds
696 697

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

dreixel's avatar
dreixel committed
702
rnMethodBind _ _ b = pprPanic "rnMethodBind" (ppr b)
703 704 705
\end{code}


706

707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
%************************************************************************
%*									*
\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}
723
renameSigs :: HsSigCtxt 
724
	   -> [LSig RdrName]
725
	   -> RnM ([LSig Name], FreeVars)
726
-- Renames the signatures and performs error checks
727
renameSigs ctxt sigs 
728
  = do	{ mapM_ dupSigDeclErr (findDupSigs sigs)
729 730 731

	; checkDupMinimalSigs sigs

732
	; (sigs', sig_fvs) <- mapFvRn (wrapLocFstM (renameSig ctxt)) sigs
733

734
	; let (good_sigs, bad_sigs) = partition (okHsSig ctxt) sigs'
735 736
	; mapM_ misplacedSigErr bad_sigs		 -- Misplaced

737
	; return (good_sigs, sig_fvs) } 
738 739

----------------------
740
-- We use lookupSigOccRn in the signatures, which is a little bit unsatisfactory
741 742 743 744 745 746 747 748
-- 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.

749
renameSig :: HsSigCtxt -> Sig RdrName -> RnM (Sig Name, FreeVars)
750
-- FixitySig is renamed elsewhere.
751
renameSig _ (IdSig x)
752
  = return (IdSig x, emptyFVs)	  -- Actually this never occurs
753 754 755

renameSig ctxt sig@(TypeSig vs ty)
  = do	{ new_vs <- mapM (lookupSigOccRn ctxt sig) vs
756 757
	; (new_ty, fvs) <- rnHsSigType (ppr_sig_bndrs vs) ty
	; return (TypeSig new_vs new_ty, fvs) }
758

759
renameSig ctxt sig@(GenericSig vs ty)
760 761
  = do	{ defaultSigs_on <- xoptM Opt_DefaultSignatures
        ; unless defaultSigs_on (addErr (defaultSigErr sig))
762
        ; new_v <- mapM (lookupSigOccRn ctxt sig) vs
763 764
	; (new_ty, fvs) <- rnHsSigType (ppr_sig_bndrs vs) ty
	; return (GenericSig new_v new_ty, fvs) }
765

766
renameSig _ (SpecInstSig ty)
767 768
  = do	{ (new_ty, fvs) <- rnLHsType SpecInstSigCtx ty
	; return (SpecInstSig new_ty,fvs) }
769

770 771 772
-- {-# 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
773
-- then the SPECIALISE pragma is ambiguous, unlike all other signatures
774 775
renameSig ctxt sig@(SpecSig v ty inl)
  = do	{ new_v <- case ctxt of 
776 777
                     TopSigCtxt {} -> lookupLocatedOccRn v
                     _             -> lookupSigOccRn ctxt sig v
778 779
	; (new_ty, fvs) <- rnHsSigType (quotes (ppr v)) ty
	; return (SpecSig new_v new_ty inl, fvs) }
780

781 782
renameSig ctxt sig@(InlineSig v s)
  = do	{ new_v <- lookupSigOccRn ctxt sig v
783
	; return (InlineSig new_v s, emptyFVs) }
784

785 786
renameSig ctxt sig@(FixSig (FixitySig v f))
  = do	{ new_v <- lookupSigOccRn ctxt sig v
787
	; return (FixSig (FixitySig new_v f), emptyFVs) }
788

789 790 791 792
renameSig ctxt sig@(MinimalSig bf)
  = do new_bf <- traverse (lookupSigOccRn ctxt sig) bf
       return (MinimalSig new_bf, emptyFVs)

cactus's avatar
cactus committed
793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
renameSig ctxt sig@(PatSynSig v args ty prov req)
  = do	v' <- lookupSigOccRn ctxt sig v
        let doc = quotes (ppr v)
            rn_type = rnHsSigType doc
        (ty', fvs1) <- rn_type ty
        (args', fvs2) <- case args of
            PrefixPatSyn tys ->
                do (tys, fvs) <- unzip <$> mapM rn_type tys
                   return (PrefixPatSyn tys, plusFVs fvs)
            InfixPatSyn left right ->
                do (left', fvs1) <- rn_type left
                   (right', fvs2) <- rn_type right
                   return (InfixPatSyn left' right', fvs1 `plusFV` fvs2)
        (prov', fvs3) <- rnContext (TypeSigCtx doc) prov
        (req', fvs4) <- rnContext (TypeSigCtx doc) req
        let fvs = plusFVs [fvs1, fvs2, fvs3, fvs4]
        return (PatSynSig v' args' ty' prov' req', fvs)

811 812
ppr_sig_bndrs :: [Located RdrName] -> SDoc
ppr_sig_bndrs bs = quotes (pprWithCommas ppr bs)
813 814 815 816 817 818 819

okHsSig :: HsSigCtxt -> LSig a -> Bool
okHsSig ctxt (L _ sig) 
  = case (sig, ctxt) of
     (GenericSig {}, ClsDeclCtxt {}) -> True
     (GenericSig {}, _)              -> False

820
     (TypeSig {}, _)              -> True
821

cactus's avatar
cactus committed
822 823 824
     (PatSynSig {}, TopSigCtxt{}) -> True
     (PatSynSig {}, _)            -> False

825 826 827
     (FixSig {}, InstDeclCtxt {}) -> False
     (FixSig {}, _)               -> True

828
     (IdSig {}, TopSigCtxt {})   -> True
829 830
     (IdSig {}, InstDeclCtxt {}) -> True
     (IdSig {}, _)               -> False
831 832 833 834

     (InlineSig {}, HsBootCtxt) -> False
     (InlineSig {}, _)          -> True

835
     (SpecSig {}, TopSigCtxt {})    -> True
836 837 838 839 840 841
     (SpecSig {}, LocalBindCtxt {}) -> True
     (SpecSig {}, InstDeclCtxt {})  -> True
     (SpecSig {}, _)                -> False

     (SpecInstSig {}, InstDeclCtxt {}) -> True
     (SpecInstSig {}, _)               -> False
842

843 844 845
     (MinimalSig {}, ClsDeclCtxt {}) -> True
     (MinimalSig {}, _)              -> False

846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
-------------------
findDupSigs :: [LSig RdrName] -> [[(Located RdrName, Sig RdrName)]]
-- Check for duplicates on RdrName version, 
-- because renamed version has unboundName for
-- not-in-scope binders, which gives bogus dup-sig errors
-- 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
--             default op :: Eq a => a -> a
findDupSigs sigs
  = findDupsEq matching_sig (concatMap (expand_sig . unLoc) sigs)
  where
    expand_sig sig@(FixSig (FixitySig n _)) = [(n,sig)]
    expand_sig sig@(InlineSig n _)          = [(n,sig)]
    expand_sig sig@(TypeSig  ns _)   = [(n,sig) | n <- ns]
    expand_sig sig@(GenericSig ns _) = [(n,sig) | n <- ns]
    expand_sig _ = []

    matching_sig (L _ n1,sig1) (L _ n2,sig2) = n1 == n2 && mtch sig1 sig2
    mtch (FixSig {})     (FixSig {})     = True
    mtch (InlineSig {})  (InlineSig {})  = True
    mtch (TypeSig {})    (TypeSig {})    = True
    mtch (GenericSig {}) (GenericSig {}) = True
    mtch _ _ = False
871 872 873 874 875 876 877

-- Warn about multiple MINIMAL signatures
checkDupMinimalSigs :: [LSig RdrName] -> RnM ()
checkDupMinimalSigs sigs
  = case filter isMinimalLSig sigs of
      minSigs@(_:_:_) -> dupMinimalSigErr minSigs
      _ -> return ()
878 879 880
\end{code}


Thomas Schilling's avatar
Thomas Schilling committed
881 882
%************************************************************************
%*									*
883
\subsection{Match}
Thomas Schilling's avatar
Thomas Schilling committed
884 885
%*									*
%************************************************************************
886 887

\begin{code}
888 889 890 891
rnMatchGroup :: Outputable (body RdrName) => HsMatchContext Name
             -> (Located (body RdrName) -> RnM (Located (body Name), FreeVars))
             -> MatchGroup RdrName (Located (body RdrName))
             -> RnM (MatchGroup Name (Located (body Name)), FreeVars)
892 893 894 895 896
rnMatchGroup ctxt rnBody (MG { mg_alts = ms }) 
  = do { empty_case_ok <- xoptM Opt_EmptyCase
       ; when (null ms && not empty_case_ok) (addErr (emptyCaseErr ctxt))
       ; (new_ms, ms_fvs) <- mapFvRn (rnMatch ctxt rnBody) ms
       ; return (mkMatchGroup new_ms, ms_fvs) }
897

898 899 900 901 902 903 904 905 906 907 908
rnMatch :: Outputable (body RdrName) => HsMatchContext Name
        -> (Located (body RdrName) -> RnM (Located (body Name), FreeVars))
        -> LMatch RdrName (Located (body RdrName))
        -> RnM (LMatch Name (Located (body Name)), FreeVars)
rnMatch ctxt rnBody = wrapLocFstM (rnMatch' ctxt rnBody)

rnMatch' :: Outputable (body RdrName) => HsMatchContext Name 
         -> (Located (body RdrName) -> RnM (Located (body Name), FreeVars))
         -> Match RdrName (Located (body RdrName))
         -> RnM (Match Name (Located (body Name)), FreeVars)
rnMatch' ctxt rnBody match@(Match pats maybe_rhs_sig grhss)
909 910 911
  = do 	{ 	-- Result type signatures are no longer supported
	  case maybe_rhs_sig of	
	        Nothing -> return ()
912
	        Just (L loc ty) -> addErrAt loc (resSigErr ctxt match ty)
913 914 915

	       -- Now the main event
	       -- note that there are no local ficity decls for matches
916
	; rnPats ctxt pats	$ \ pats' -> do
917
	{ (grhss', grhss_fvs) <- rnGRHSs ctxt rnBody grhss
918 919 920

	; return (Match pats' Nothing grhss', grhss_fvs) }}

921
emptyCaseErr :: HsMatchContext Name -> SDoc
Krzysztof Gogolewski's avatar
Typos  
Krzysztof Gogolewski committed
922
emptyCaseErr ctxt = hang (ptext (sLit "Empty list of alternatives in") <+> pp_ctxt)
923
                       2 (ptext (sLit "Use EmptyCase to allow this"))
924 925 926 927 928 929 930
  where
    pp_ctxt = case ctxt of
                CaseAlt    -> ptext (sLit "case expression")
                LambdaExpr -> ptext (sLit "\\case expression")
                _ -> ptext (sLit "(unexpected)") <+> pprMatchContextNoun ctxt
 

931
resSigErr :: Outputable body => HsMatchContext Name -> Match RdrName body -> HsType RdrName -> SDoc 
932 933 934 935
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 ]
936 937 938 939 940 941 942 943 944 945
\end{code}


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

\begin{code}
946 947 948 949 950
rnGRHSs :: HsMatchContext Name 
        -> (Located (body RdrName) -> RnM (Located (body Name), FreeVars))
        -> GRHSs RdrName (Located (body RdrName))
        -> RnM (GRHSs Name (Located (body Name)), FreeVars)
rnGRHSs ctxt rnBody (GRHSs grhss binds)
951
  = rnLocalBindsAndThen binds	$ \ binds' -> do
952
    (grhss', fvGRHSs) <- mapFvRn (rnGRHS ctxt rnBody) grhss
953
    return (GRHSs grhss' binds', fvGRHSs)
954

955 956 957 958 959 960 961 962 963 964 965
rnGRHS :: HsMatchContext Name 
       -> (Located (body RdrName) -> RnM (Located (body Name), FreeVars))
       -> LGRHS RdrName (Located (body RdrName))
       -> RnM (LGRHS Name (Located (body Name)), FreeVars)
rnGRHS ctxt rnBody = wrapLocFstM (rnGRHS' ctxt rnBody)

rnGRHS' :: HsMatchContext Name 
        -> (Located (body RdrName) -> RnM (Located (body Name), FreeVars))
        -> GRHS RdrName (Located (body RdrName))
        -> RnM (GRHS Name (Located (body Name)), FreeVars)
rnGRHS' ctxt rnBody (GRHS guards rhs)
966
  = do	{ pattern_guards_allowed <- xoptM Opt_PatternGuards
967 968
        ; ((guards', rhs'), fvs) <- rnStmts (PatGuard ctxt) rnLExpr guards $ \ _ ->
				    rnBody rhs
969

970
	; unless (pattern_guards_allowed || is_standard_guard guards')
971 972
	  	 (addWarn (nonStdGuardErr guards'))

973 974 975 976 977
	; 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
978
    is_standard_guard []                       = True
979
    is_standard_guard [L _ (BodyStmt _ _ _ _)] = True
980
    is_standard_guard _                        = False
981 982
\end{code}

983 984 985 986 987 988 989
%************************************************************************
%*									*
\subsection{Error messages}
%*									*
%************************************************************************

\begin{code}
990 991
dupSigDeclErr :: [(Located RdrName, Sig RdrName)] -> RnM ()
dupSigDeclErr pairs@((L loc name, sig) : _)
992
  = addErrAt loc $
993 994 995
    vcat [ ptext (sLit "Duplicate") <+> what_it_is 
           <> ptext (sLit "s for") <+> quotes (ppr name)
         , ptext (sLit "at") <+> vcat (map ppr $ sort $ map (getLoc . fst) pairs) ]
996
  where
997
    what_it_is = hsSigDoc sig
998

Ian Lynagh's avatar
Ian Lynagh committed
999
dupSigDeclErr [] = panic "dupSigDeclErr"
1000

1001 1002
misplacedSigErr :: LSig Name -> RnM ()
misplacedSigErr (L loc sig)
1003 1004
  = addErrAt loc $
    sep [ptext (sLit "Misplaced") <+> hsSigDoc sig <> colon, ppr sig]
1005

1006 1007
defaultSigErr :: Sig RdrName -> SDoc
defaultSigErr sig = vcat [ hang (ptext (sLit "Unexpected default signature:"))
1008
                              2 (ppr sig)
1009
                         , ptext (sLit "Use DefaultSignatures to enable default signatures") ]
1010

Ian Lynagh's avatar
Ian Lynagh committed
1011
methodBindErr :: HsBindLR RdrName RdrName -> SDoc
1012
methodBindErr mbind
Ian Lynagh's avatar
Ian Lynagh committed
1013
 =  hang (ptext (sLit "Pattern bindings (except simple variables) not allowed in instance declarations"))
1014 1015
       2 (ppr mbind)

Ian Lynagh's avatar
Ian Lynagh committed
1016
bindsInHsBootFile :: LHsBindsLR Name RdrName -> SDoc
1017
bindsInHsBootFile mbinds
Ian Lynagh's avatar
Ian Lynagh committed
1018
  = hang (ptext (sLit "Bindings in hs-boot files are not allowed"))
1019
       2 (ppr mbinds)
1020

1021
nonStdGuardErr :: Outputable body => [LStmtLR Name Name body] -> SDoc
1022
nonStdGuardErr guards
1023
  = hang (ptext (sLit "accepting non-standard pattern guards (use PatternGuards to suppress this message)"))
1024
       4 (interpp'SP guards)
1025

1026 1027 1028 1029
unusedPatBindWarn :: HsBind Name -> SDoc
unusedPatBindWarn bind
  = hang (ptext (sLit "This pattern-binding binds no variables:"))
       2 (ppr bind)
1030 1031 1032 1033 1034 1035 1036 1037

dupMinimalSigErr :: [LSig RdrName] -> RnM ()
dupMinimalSigErr sigs@(L loc _ : _)
  = addErrAt loc $
    vcat [ ptext (sLit "Multiple minimal complete definitions")
         , ptext (sLit "at") <+> vcat (map ppr $ sort $ map getLoc sigs)
         , ptext (sLit "Combine alternative minimal complete definitions with `|'") ]
dupMinimalSigErr [] = panic "dupMinimalSigErr"
1038
\end{code}