HsUtils.hs 37.3 KB
Newer Older
Austin Seipp's avatar
Austin Seipp committed
1 2
{-
(c) The University of Glasgow, 1992-2006
3

4

5 6
Here we collect a variety of helper functions that construct or
analyse HsSyn.  All these functions deal with generic HsSyn; functions
7
which deal with the instantiated versions are located elsewhere:
8

9
   Parameterised by     Module
10
   ----------------     -------------
11 12 13
   RdrName              parser/RdrHsSyn
   Name                 rename/RnHsSyn
   Id                   typecheck/TcHsSyn
Austin Seipp's avatar
Austin Seipp committed
14
-}
15

16
{-# LANGUAGE CPP #-}
17 18
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE FlexibleContexts #-}
Ian Lynagh's avatar
Ian Lynagh committed
19

20 21 22
module HsUtils(
  -- Terms
  mkHsPar, mkHsApp, mkHsConApp, mkSimpleHsAlt,
23 24
  mkSimpleMatch, unguardedGRHSs, unguardedRHS,
  mkMatchGroup, mkMatchGroupName, mkMatch, mkHsLam, mkHsIf,
25
  mkHsWrap, mkLHsWrap, mkHsWrapCo, mkHsWrapCoR, mkLHsWrapCo,
26
  coToHsWrapper, mkHsDictLet, mkHsLams,
27
  mkHsOpApp, mkHsDo, mkHsComp, mkHsWrapPat, mkHsWrapPatCo,
28
  mkLHsPar, mkHsCmdCast,
29

30
  nlHsTyApp, nlHsTyApps, nlHsVar, nlHsLit, nlHsApp, nlHsApps, nlHsIntLit, nlHsVarApps,
31
  nlHsDo, nlHsOpApp, nlHsLam, nlHsPar, nlHsIf, nlHsCase, nlList,
32 33
  mkLHsTupleExpr, mkLHsVarTuple, missingTupArg,
  toHsType, toHsKind,
34

35
  -- Bindings
cactus's avatar
cactus committed
36
  mkFunBind, mkVarBind, mkHsVarBind, mk_easy_FunBind, mkTopFunBind, mkPatSynBind,
37 38

  -- Literals
39
  mkHsIntegral, mkHsFractional, mkHsIsString, mkHsString,
40 41

  -- Patterns
42 43 44
  mkNPat, mkNPlusKPat, nlVarPat, nlLitPat, nlConVarPat, nlConPat,
  nlConPatName, nlInfixConPat, nlNullaryConPat, nlWildConPat, nlWildPat,
  nlWildPatName, nlWildPatId, nlTuplePat, mkParPat,
45 46 47

  -- Types
  mkHsAppTy, userHsTyVarBndrs,
48
  nlHsAppTy, nlHsTyVar, nlHsFunTy, nlHsTyConApp,
49 50

  -- Stmts
51
  mkTransformStmt, mkTransformByStmt, mkBodyStmt, mkBindStmt, mkLastStmt,
52 53
  emptyTransStmt, mkGroupUsingStmt, mkGroupByUsingStmt,
  emptyRecStmt, emptyRecStmtName, emptyRecStmtId, mkRecStmt,
54 55

  -- Template Haskell
56
  mkHsSpliceTy, mkHsSpliceE, mkHsSpliceTE, mkUntypedSplice,
57
  mkHsQuasiQuote, unqualQuasiQuote,
58 59

  -- Flags
60
  noRebindableInfo,
61 62

  -- Collecting binders
63
  collectLocalBinders, collectHsValBinders, collectHsBindListBinders,
64
  collectHsIdBinders,
65 66 67 68
  collectHsBindsBinders, collectHsBindBinders, collectMethodBinders,
  collectPatBinders, collectPatsBinders,
  collectLStmtsBinders, collectStmtsBinders,
  collectLStmtBinders, collectStmtBinders,
69

70
  hsLTyClDeclBinders, hsTyClForeignBinders, hsPatSynBinders,
71
  hsForeignDeclsBinders, hsGroupBinders, hsDataFamInstBinders,
72

73 74
  -- Collecting implicit binders
  lStmtsImplicits, hsValBindsImplicits, lPatImplicits
75
  ) where
76

77 78
#include "HsVersions.h"

79
import HsDecls
80 81 82
import HsBinds
import HsExpr
import HsPat
83
import HsTypes
84
import HsLit
85
import PlaceHolder
86

87
import TcEvidence
88 89
import RdrName
import Var
90
import TypeRep
91 92
import TcType
import Kind
93 94
import DataCon
import Name
95
import NameSet
96
import BasicTypes
97
import SrcLoc
98 99
import FastString
import Util
100
import Bag
101
import Outputable
102

103
import Data.Either
104 105
import Data.Function
import Data.List
106

Austin Seipp's avatar
Austin Seipp committed
107 108 109
{-
************************************************************************
*                                                                      *
110
        Some useful helpers for constructing syntax
Austin Seipp's avatar
Austin Seipp committed
111 112
*                                                                      *
************************************************************************
113

114 115 116
These functions attempt to construct a not-completely-useless SrcSpan
from their components, compared with the nl* functions below which
just attach noSrcSpan to everything.
Austin Seipp's avatar
Austin Seipp committed
117
-}
118 119 120 121

mkHsPar :: LHsExpr id -> LHsExpr id
mkHsPar e = L (getLoc e) (HsPar e)

122
mkSimpleMatch :: [LPat id] -> Located (body id) -> LMatch id (Located (body id))
123
mkSimpleMatch pats rhs
124
  = L loc $
Alan Zimmerman's avatar
Alan Zimmerman committed
125
    Match Nothing pats Nothing (unguardedGRHSs rhs)
126 127
  where
    loc = case pats of
128 129
                []      -> getLoc rhs
                (pat:_) -> combineSrcSpans (getLoc pat) (getLoc rhs)
130

131
unguardedGRHSs :: Located (body id) -> GRHSs id (Located (body id))
132 133
unguardedGRHSs rhs@(L loc _)
  = GRHSs (unguardedRHS loc rhs) (noLoc emptyLocalBinds)
134

Alan Zimmerman's avatar
Alan Zimmerman committed
135 136
unguardedRHS :: SrcSpan -> Located (body id) -> [LGRHS id (Located (body id))]
unguardedRHS loc rhs = [L loc (GRHS [] rhs)]
137

138 139
mkMatchGroup :: Origin -> [LMatch RdrName (Located (body RdrName))]
             -> MatchGroup RdrName (Located (body RdrName))
140 141
mkMatchGroup origin matches = MG { mg_alts = mkLocatedList matches
                                 , mg_arg_tys = []
142 143 144
                                 , mg_res_ty = placeHolderType
                                 , mg_origin = origin }

145 146 147 148
mkLocatedList ::  [Located a] -> Located [Located a]
mkLocatedList [] = noLoc []
mkLocatedList ms = L (combineLocs (head ms) (last ms)) ms

149 150
mkMatchGroupName :: Origin -> [LMatch Name (Located (body Name))]
             -> MatchGroup Name (Located (body Name))
151 152
mkMatchGroupName origin matches = MG { mg_alts = mkLocatedList matches
                                     , mg_arg_tys = []
153 154
                                     , mg_res_ty = placeHolderType
                                     , mg_origin = origin }
155

156 157 158 159 160 161
mkHsAppTy :: LHsType name -> LHsType name -> LHsType name
mkHsAppTy t1 t2 = addCLoc t1 t2 (HsAppTy t1 t2)

mkHsApp :: LHsExpr name -> LHsExpr name -> LHsExpr name
mkHsApp e1 e2 = addCLoc e1 e2 (HsApp e1 e2)

162
mkHsLam :: [LPat RdrName] -> LHsExpr RdrName -> LHsExpr RdrName
163
mkHsLam pats body = mkHsPar (L (getLoc body) (HsLam matches))
164
        where
165
          matches = mkMatchGroup Generated [mkSimpleMatch pats body]
166 167

mkHsLams :: [TyVar] -> [EvVar] -> LHsExpr Id -> LHsExpr Id
168 169
mkHsLams tyvars dicts expr = mkLHsWrap (mkWpTyLams tyvars
                                       <.> mkWpLams dicts) expr
170 171

mkHsConApp :: DataCon -> [Type] -> [HsExpr Id] -> LHsExpr Id
172 173
-- Used for constructing dictionary terms etc, so no locations
mkHsConApp data_con tys args
174 175 176 177
  = foldl mk_app (nlHsTyApp (dataConWrapId data_con) tys) args
  where
    mk_app f a = noLoc (HsApp f (noLoc a))

178
mkSimpleHsAlt :: LPat id -> (Located (body id)) -> LMatch id (Located (body id))
179
-- A simple lambda with a single pattern, no binds, no guards; pre-typechecking
180
mkSimpleHsAlt pat expr
181 182
  = mkSimpleMatch [pat] expr

183
nlHsTyApp :: name -> [Type] -> LHsExpr name
184
nlHsTyApp fun_id tys = noLoc (HsWrap (mkWpTyApps tys) (HsVar fun_id))
185

186 187 188
nlHsTyApps :: name -> [Type] -> [LHsExpr name] -> LHsExpr name
nlHsTyApps fun_id tys xs = foldl nlHsApp (nlHsTyApp fun_id tys) xs

189 190 191 192 193 194 195 196 197 198 199
--------- Adding parens ---------
mkLHsPar :: LHsExpr name -> LHsExpr name
-- Wrap in parens if hsExprNeedsParens says it needs them
-- So   'f x'  becomes '(f x)', but '3' stays as '3'
mkLHsPar le@(L loc e) | hsExprNeedsParens e = L loc (HsPar le)
                      | otherwise           = le

mkParPat :: LPat name -> LPat name
mkParPat lp@(L loc p) | hsPatNeedsParens p = L loc (ParPat lp)
                      | otherwise          = lp

200

201
-------------------------------
202 203 204
-- These are the bits of syntax that contain rebindable names
-- See RnEnv.lookupSyntaxName

205
mkHsIntegral   :: String -> Integer -> PostTc RdrName Type -> HsOverLit RdrName
206
mkHsFractional :: FractionalLit -> PostTc RdrName Type -> HsOverLit RdrName
207
mkHsIsString :: String -> FastString -> PostTc RdrName Type -> HsOverLit RdrName
208 209 210
mkHsDo         :: HsStmtContext Name -> [ExprLStmt RdrName] -> HsExpr RdrName
mkHsComp       :: HsStmtContext Name -> [ExprLStmt RdrName] -> LHsExpr RdrName
               -> HsExpr RdrName
twanvl's avatar
twanvl committed
211

Alan Zimmerman's avatar
Alan Zimmerman committed
212 213
mkNPat      :: Located (HsOverLit id) -> Maybe (SyntaxExpr id) -> Pat id
mkNPlusKPat :: Located id -> Located (HsOverLit id) -> Pat id
twanvl's avatar
twanvl committed
214

215
mkLastStmt :: Located (bodyR idR) -> StmtLR idL idR (Located (bodyR idR))
216 217
mkBodyStmt :: Located (bodyR RdrName)
           -> StmtLR idL RdrName (Located (bodyR RdrName))
218
mkBindStmt :: LPat idL -> Located (bodyR idR) -> StmtLR idL idR (Located (bodyR idR))
219

220 221 222 223
emptyRecStmt     :: StmtLR idL  RdrName bodyR
emptyRecStmtName :: StmtLR Name Name    bodyR
emptyRecStmtId   :: StmtLR Id   Id      bodyR
mkRecStmt    :: [LStmtLR idL RdrName bodyR] -> StmtLR idL RdrName bodyR
twanvl's avatar
twanvl committed
224 225


226 227 228
mkHsIntegral src i  = OverLit (HsIntegral   src i) noRebindableInfo noSyntaxExpr
mkHsFractional   f  = OverLit (HsFractional     f) noRebindableInfo noSyntaxExpr
mkHsIsString src s  = OverLit (HsIsString   src s) noRebindableInfo noSyntaxExpr
229

230 231
noRebindableInfo :: PlaceHolder
noRebindableInfo = PlaceHolder -- Just another placeholder;
232

233
mkHsDo ctxt stmts = HsDo ctxt (mkLocatedList stmts) placeHolderType
234 235 236
mkHsComp ctxt stmts expr = mkHsDo ctxt (stmts ++ [last_stmt])
  where
    last_stmt = L (getLoc expr) $ mkLastStmt expr
237

238 239 240
mkHsIf :: LHsExpr id -> LHsExpr id -> LHsExpr id -> HsExpr id
mkHsIf c a b = HsIf (Just noSyntaxExpr) c a b

241
mkNPat lit neg     = NPat lit neg noSyntaxExpr
242
mkNPlusKPat id lit = NPlusKPat id lit noSyntaxExpr noSyntaxExpr
243

244 245 246 247 248 249 250 251
mkTransformStmt    :: [ExprLStmt idL] -> LHsExpr idR
                   -> StmtLR idL idR (LHsExpr idL)
mkTransformByStmt  :: [ExprLStmt idL] -> LHsExpr idR -> LHsExpr idR
                   -> StmtLR idL idR (LHsExpr idL)
mkGroupUsingStmt   :: [ExprLStmt idL]                -> LHsExpr idR
                   -> StmtLR idL idR (LHsExpr idL)
mkGroupByUsingStmt :: [ExprLStmt idL] -> LHsExpr idR -> LHsExpr idR
                   -> StmtLR idL idR (LHsExpr idL)
252

253
emptyTransStmt :: StmtLR idL idR (LHsExpr idR)
254
emptyTransStmt = TransStmt { trS_form = panic "emptyTransStmt: form"
255
                           , trS_stmts = [], trS_bndrs = []
256 257 258
                           , trS_by = Nothing, trS_using = noLoc noSyntaxExpr
                           , trS_ret = noSyntaxExpr, trS_bind = noSyntaxExpr
                           , trS_fmap = noSyntaxExpr }
259 260 261 262
mkTransformStmt    ss u   = emptyTransStmt { trS_form = ThenForm,  trS_stmts = ss, trS_using = u }
mkTransformByStmt  ss u b = emptyTransStmt { trS_form = ThenForm,  trS_stmts = ss, trS_using = u, trS_by = Just b }
mkGroupUsingStmt   ss u   = emptyTransStmt { trS_form = GroupForm, trS_stmts = ss, trS_using = u }
mkGroupByUsingStmt ss b u = emptyTransStmt { trS_form = GroupForm, trS_stmts = ss, trS_using = u, trS_by = Just b }
263

264 265 266
mkLastStmt body     = LastStmt body noSyntaxExpr
mkBodyStmt body     = BodyStmt body noSyntaxExpr noSyntaxExpr placeHolderType
mkBindStmt pat body = BindStmt pat body noSyntaxExpr noSyntaxExpr
267 268


269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
emptyRecStmt' :: forall idL idR body.
                       PostTc idR Type -> StmtLR idL idR body
emptyRecStmt' tyVal =
   RecStmt
     { recS_stmts = [], recS_later_ids = []
     , recS_rec_ids = []
     , recS_ret_fn = noSyntaxExpr
     , recS_mfix_fn = noSyntaxExpr
     , recS_bind_fn = noSyntaxExpr, recS_later_rets = []
     , recS_rec_rets = [], recS_ret_ty = tyVal }

emptyRecStmt     = emptyRecStmt' placeHolderType
emptyRecStmtName = emptyRecStmt' placeHolderType
emptyRecStmtId   = emptyRecStmt' placeHolderTypeTc
mkRecStmt stmts  = emptyRecStmt { recS_stmts = stmts }
284 285

-------------------------------
286 287
--- A useful function for building @OpApps@.  The operator is always a
-- variable, and we don't know the fixity yet.
twanvl's avatar
twanvl committed
288
mkHsOpApp :: LHsExpr id -> id -> LHsExpr id -> HsExpr id
289 290
mkHsOpApp e1 op e2 = OpApp e1 (noLoc (HsVar op)) (error "mkOpApp:fixity") e2

291 292 293
unqualSplice :: RdrName
unqualSplice = mkRdrUnqual (mkVarOccFS (fsLit "splice"))

294 295 296
mkUntypedSplice :: LHsExpr RdrName -> HsSplice RdrName
mkUntypedSplice e = HsUntypedSplice unqualSplice e

297
mkHsSpliceE :: LHsExpr RdrName -> HsExpr RdrName
298
mkHsSpliceE e = HsSpliceE (mkUntypedSplice e)
299 300

mkHsSpliceTE :: LHsExpr RdrName -> HsExpr RdrName
301
mkHsSpliceTE e = HsSpliceE (HsTypedSplice unqualSplice e)
302

303
mkHsSpliceTy :: LHsExpr RdrName -> HsType RdrName
304
mkHsSpliceTy e = HsSpliceTy (HsUntypedSplice unqualSplice e) placeHolderKind
305

306 307
mkHsQuasiQuote :: RdrName -> SrcSpan -> FastString -> HsSplice RdrName
mkHsQuasiQuote quoter span quote = HsQuasiQuote unqualSplice quoter span quote
308

twanvl's avatar
twanvl committed
309
unqualQuasiQuote :: RdrName
Ian Lynagh's avatar
Ian Lynagh committed
310
unqualQuasiQuote = mkRdrUnqual (mkVarOccFS (fsLit "quasiquote"))
311 312
                -- A name (uniquified later) to
                -- identify the quasi-quote
313

twanvl's avatar
twanvl committed
314
mkHsString :: String -> HsLit
315
mkHsString s = HsString s (mkFastString s)
316 317

-------------
318
userHsTyVarBndrs :: SrcSpan -> [name] -> [Located (HsTyVarBndr name)]
319
-- Caller sets location
320
userHsTyVarBndrs loc bndrs = [ L loc (UserTyVar v) | v <- bndrs ]
321

Austin Seipp's avatar
Austin Seipp committed
322 323 324
{-
************************************************************************
*                                                                      *
325
        Constructing syntax with no location info
Austin Seipp's avatar
Austin Seipp committed
326 327 328
*                                                                      *
************************************************************************
-}
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344

nlHsVar :: id -> LHsExpr id
nlHsVar n = noLoc (HsVar n)

nlHsLit :: HsLit -> LHsExpr id
nlHsLit n = noLoc (HsLit n)

nlVarPat :: id -> LPat id
nlVarPat n = noLoc (VarPat n)

nlLitPat :: HsLit -> LPat id
nlLitPat l = noLoc (LitPat l)

nlHsApp :: LHsExpr id -> LHsExpr id -> LHsExpr id
nlHsApp f x = noLoc (HsApp f x)

twanvl's avatar
twanvl committed
345
nlHsIntLit :: Integer -> LHsExpr id
346
nlHsIntLit n = noLoc (HsLit (HsInt (show n) n))
347 348 349

nlHsApps :: id -> [LHsExpr id] -> LHsExpr id
nlHsApps f xs = foldl nlHsApp (nlHsVar f) xs
350

351 352
nlHsVarApps :: id -> [id] -> LHsExpr id
nlHsVarApps f xs = noLoc (foldl mk (HsVar f) (map HsVar xs))
353 354
                 where
                   mk f a = HsApp (noLoc f) (noLoc a)
355

356
nlConVarPat :: RdrName -> [RdrName] -> LPat RdrName
357 358 359 360 361
nlConVarPat con vars = nlConPat con (map nlVarPat vars)

nlInfixConPat :: id -> LPat id -> LPat id -> LPat id
nlInfixConPat con l r = noLoc (ConPatIn (noLoc con) (InfixCon l r))

362
nlConPat :: RdrName -> [LPat RdrName] -> LPat RdrName
363 364
nlConPat con pats = noLoc (ConPatIn (noLoc con) (PrefixCon pats))

365 366 367
nlConPatName :: Name -> [LPat Name] -> LPat Name
nlConPatName con pats = noLoc (ConPatIn (noLoc con) (PrefixCon pats))

368 369 370 371 372
nlNullaryConPat :: id -> LPat id
nlNullaryConPat con = noLoc (ConPatIn (noLoc con) (PrefixCon []))

nlWildConPat :: DataCon -> LPat RdrName
nlWildConPat con = noLoc (ConPatIn (noLoc (getRdrName con))
373 374
                         (PrefixCon (nOfThem (dataConSourceArity con)
                                             nlWildPat)))
375

376 377
nlWildPat :: LPat RdrName
nlWildPat  = noLoc (WildPat placeHolderType )  -- Pre-typechecking
378

379 380 381 382 383 384 385 386
nlWildPatName :: LPat Name
nlWildPatName  = noLoc (WildPat placeHolderType )  -- Pre-typechecking

nlWildPatId :: LPat Id
nlWildPatId  = noLoc (WildPat placeHolderTypeTc )  -- Post-typechecking

nlHsDo :: HsStmtContext Name -> [LStmt RdrName (LHsExpr RdrName)]
       -> LHsExpr RdrName
387
nlHsDo ctxt stmts = noLoc (mkHsDo ctxt stmts)
388

twanvl's avatar
twanvl committed
389
nlHsOpApp :: LHsExpr id -> id -> LHsExpr id -> LHsExpr id
390 391
nlHsOpApp e1 op e2 = noLoc (mkHsOpApp e1 op e2)

392
nlHsLam  :: LMatch RdrName (LHsExpr RdrName) -> LHsExpr RdrName
twanvl's avatar
twanvl committed
393 394
nlHsPar  :: LHsExpr id -> LHsExpr id
nlHsIf   :: LHsExpr id -> LHsExpr id -> LHsExpr id -> LHsExpr id
395 396 397
nlHsCase :: LHsExpr RdrName -> [LMatch RdrName (LHsExpr RdrName)]
         -> LHsExpr RdrName
nlList   :: [LHsExpr RdrName] -> LHsExpr RdrName
twanvl's avatar
twanvl committed
398

399
nlHsLam match          = noLoc (HsLam (mkMatchGroup Generated [match]))
400 401 402 403
nlHsPar e              = noLoc (HsPar e)
nlHsIf cond true false = noLoc (mkHsIf cond true false)
nlHsCase expr matches  = noLoc (HsCase expr (mkMatchGroup Generated matches))
nlList exprs           = noLoc (ExplicitList placeHolderType Nothing exprs)
404

twanvl's avatar
twanvl committed
405 406 407 408
nlHsAppTy :: LHsType name -> LHsType name -> LHsType name
nlHsTyVar :: name                         -> LHsType name
nlHsFunTy :: LHsType name -> LHsType name -> LHsType name

409 410 411
nlHsAppTy f t           = noLoc (HsAppTy f t)
nlHsTyVar x             = noLoc (HsTyVar x)
nlHsFunTy a b           = noLoc (HsFunTy a b)
412

twanvl's avatar
twanvl committed
413
nlHsTyConApp :: name -> [LHsType name] -> LHsType name
414
nlHsTyConApp tycon tys  = foldl nlHsAppTy (nlHsTyVar tycon) tys
415

Austin Seipp's avatar
Austin Seipp committed
416
{-
417 418
Tuples.  All these functions are *pre-typechecker* because they lack
types on the tuple.
Austin Seipp's avatar
Austin Seipp committed
419
-}
420 421 422 423

mkLHsTupleExpr :: [LHsExpr a] -> LHsExpr a
-- Makes a pre-typechecker boxed tuple, deals with 1 case
mkLHsTupleExpr [e] = e
424
mkLHsTupleExpr es  = noLoc $ ExplicitTuple (map (noLoc . Present) es) Boxed
425 426 427

mkLHsVarTuple :: [a] -> LHsExpr a
mkLHsVarTuple ids  = mkLHsTupleExpr (map nlHsVar ids)
428

429
nlTuplePat :: [LPat id] -> Boxity -> LPat id
430
nlTuplePat pats box = noLoc (TuplePat pats box [])
431

432
missingTupArg :: HsTupArg RdrName
433
missingTupArg = Missing placeHolderType
434

Austin Seipp's avatar
Austin Seipp committed
435 436 437
{-
************************************************************************
*                                                                      *
438
        Converting a Type to an HsType RdrName
Austin Seipp's avatar
Austin Seipp committed
439 440
*                                                                      *
************************************************************************
441 442

This is needed to implement GeneralizedNewtypeDeriving.
Austin Seipp's avatar
Austin Seipp committed
443
-}
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461

toHsType :: Type -> LHsType RdrName
toHsType ty
  | [] <- tvs_only
  , [] <- theta
  = to_hs_type tau
  | otherwise
  = noLoc $
    mkExplicitHsForAllTy (map mk_hs_tvb tvs_only)
                         (noLoc $ map toHsType theta)
                         (to_hs_type tau)

  where
    (tvs, theta, tau) = tcSplitSigmaTy ty
    tvs_only = filter isTypeVar tvs

    to_hs_type (TyVarTy tv) = nlHsTyVar (getRdrName tv)
    to_hs_type (AppTy t1 t2) = nlHsAppTy (toHsType t1) (toHsType t2)
462
    to_hs_type (TyConApp tc args) = nlHsTyConApp (getRdrName tc) (map toHsType args')
463
       where
Simon Peyton Jones's avatar
Simon Peyton Jones committed
464 465 466
         args' = filterOut isKind args
         -- Source-language types have _implicit_ kind arguments,
         -- so we must remove them here (Trac #8563)
467 468 469
    to_hs_type (FunTy arg res) = ASSERT( not (isConstraintKind (typeKind arg)) )
                                 nlHsFunTy (toHsType arg) (toHsType res)
    to_hs_type t@(ForAllTy {}) = pprPanic "toHsType" (ppr t)
Alan Zimmerman's avatar
Alan Zimmerman committed
470 471
    to_hs_type (LitTy (NumTyLit n)) = noLoc $ HsTyLit (HsNumTy "" n)
    to_hs_type (LitTy (StrTyLit s)) = noLoc $ HsTyLit (HsStrTy "" s)
472

Alan Zimmerman's avatar
Alan Zimmerman committed
473 474
    mk_hs_tvb tv = noLoc $ KindedTyVar (noLoc (getRdrName tv))
                                       (toHsKind (tyVarKind tv))
475 476 477 478

toHsKind :: Kind -> LHsKind RdrName
toHsKind = toHsType

479 480 481 482 483 484
--------- HsWrappers: type args, dict args, casts ---------
mkLHsWrap :: HsWrapper -> LHsExpr id -> LHsExpr id
mkLHsWrap co_fn (L loc e) = L loc (mkHsWrap co_fn e)

mkHsWrap :: HsWrapper -> HsExpr id -> HsExpr id
mkHsWrap co_fn e | isIdHsWrapper co_fn = e
485
                 | otherwise           = HsWrap co_fn e
486

487 488
mkHsWrapCo :: TcCoercion   -- A Nominal coercion  a ~N b
           -> HsExpr id -> HsExpr id
Joachim Breitner's avatar
Joachim Breitner committed
489
mkHsWrapCo co e = mkHsWrap (coToHsWrapper co) e
490

491 492 493 494
mkHsWrapCoR :: TcCoercion   -- A Representational coercion  a ~R b
            -> HsExpr id -> HsExpr id
mkHsWrapCoR co e = mkHsWrap (coToHsWrapperR co) e

495
mkLHsWrapCo :: TcCoercion -> LHsExpr id -> LHsExpr id
Joachim Breitner's avatar
Joachim Breitner committed
496
mkLHsWrapCo co (L loc e) = L loc (mkHsWrapCo co e)
497

498 499 500 501
mkHsCmdCast :: TcCoercion -> HsCmd id -> HsCmd id
mkHsCmdCast co cmd | isTcReflCo co = cmd
                   | otherwise     = HsCmdCast co cmd

502
coToHsWrapper :: TcCoercion -> HsWrapper   -- A Nominal coercion
503
coToHsWrapper co | isTcReflCo co = idHsWrapper
Joachim Breitner's avatar
Joachim Breitner committed
504
                 | otherwise     = mkWpCast (mkTcSubCo co)
505

506 507 508 509
coToHsWrapperR :: TcCoercion -> HsWrapper   -- A Representational coercion
coToHsWrapperR co | isTcReflCo co = idHsWrapper
                  | otherwise     = mkWpCast co

510 511
mkHsWrapPat :: HsWrapper -> Pat id -> Type -> Pat id
mkHsWrapPat co_fn p ty | isIdHsWrapper co_fn = p
512
                       | otherwise           = CoPat co_fn p ty
513 514 515

mkHsWrapPatCo :: TcCoercion -> Pat id -> Type -> Pat id
mkHsWrapPatCo co pat ty | isTcReflCo co = pat
Joachim Breitner's avatar
Joachim Breitner committed
516
                        | otherwise     = CoPat (mkWpCast co) pat ty
517 518 519

mkHsDictLet :: TcEvBinds -> LHsExpr Id -> LHsExpr Id
mkHsDictLet ev_binds expr = mkLHsWrap (mkWpLet ev_binds) expr
Austin Seipp's avatar
Austin Seipp committed
520 521

{-
522
l
Austin Seipp's avatar
Austin Seipp committed
523 524
************************************************************************
*                                                                      *
525
                Bindings; with a location at the top
Austin Seipp's avatar
Austin Seipp committed
526 527 528
*                                                                      *
************************************************************************
-}
529

530 531
mkFunBind :: Located RdrName -> [LMatch RdrName (LHsExpr RdrName)]
          -> HsBind RdrName
532
-- Not infix, with place holders for coercion and free vars
533
mkFunBind fn ms = FunBind { fun_id = fn, fun_infix = False
534 535
                          , fun_matches = mkMatchGroup Generated ms
                          , fun_co_fn = idHsWrapper
536
                          , bind_fvs = placeHolderNames
537
                          , fun_tick = [] }
538

539 540
mkTopFunBind :: Origin -> Located Name -> [LMatch Name (LHsExpr Name)]
             -> HsBind Name
541
-- In Name-land, with empty bind_fvs
542
mkTopFunBind origin fn ms = FunBind { fun_id = fn, fun_infix = False
543
                                    , fun_matches = mkMatchGroupName origin ms
544
                                    , fun_co_fn = idHsWrapper
545 546
                                    , bind_fvs = emptyNameSet -- NB: closed
                                                              --     binding
547
                                    , fun_tick = [] }
548

549
mkHsVarBind :: SrcSpan -> RdrName -> LHsExpr RdrName -> LHsBind RdrName
550 551 552 553
mkHsVarBind loc var rhs = mk_easy_FunBind loc var [] rhs

mkVarBind :: id -> LHsExpr id -> LHsBind id
mkVarBind var rhs = L (getLoc rhs) $
554
                    VarBind { var_id = var, var_rhs = rhs, var_inline = False }
555

556 557
mkPatSynBind :: Located RdrName -> HsPatSynDetails (Located RdrName)
             -> LPat RdrName -> HsPatSynDir RdrName -> HsBind RdrName
558 559 560 561 562 563 564
mkPatSynBind name details lpat dir = PatSynBind psb
  where
    psb = PSB{ psb_id = name
             , psb_args = details
             , psb_def = lpat
             , psb_dir = dir
             , psb_fvs = placeHolderNames }
cactus's avatar
cactus committed
565

566
------------
567
mk_easy_FunBind :: SrcSpan -> RdrName -> [LPat RdrName]
568
                -> LHsExpr RdrName -> LHsBind RdrName
569
mk_easy_FunBind loc fun pats expr
570
  = L loc $ mkFunBind (L loc fun) [mkMatch pats expr (noLoc emptyLocalBinds)]
571

572
------------
573 574 575
mkMatch :: [LPat id] -> LHsExpr id -> Located (HsLocalBinds id)
        -> LMatch id (LHsExpr id)
mkMatch pats expr lbinds
Alan Zimmerman's avatar
Alan Zimmerman committed
576
  = noLoc (Match Nothing (map paren pats) Nothing
577
                 (GRHSs (unguardedRHS noSrcSpan expr) lbinds))
578
  where
579 580
    paren lp@(L l p) | hsPatNeedsParens p = L l (ParPat lp)
                     | otherwise          = lp
581

Austin Seipp's avatar
Austin Seipp committed
582 583 584
{-
************************************************************************
*                                                                      *
585
        Collecting binders
Austin Seipp's avatar
Austin Seipp committed
586 587
*                                                                      *
************************************************************************
588 589 590 591 592 593 594 595 596 597 598

Get all the binders in some HsBindGroups, IN THE ORDER OF APPEARANCE. eg.

...
where
  (x, y) = ...
  f i j  = ...
  [a, b] = ...

it should return [x, y, f, a, b] (remember, order important).

599 600 601
Note [Collect binders only after renaming]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
These functions should only be used on HsSyn *after* the renamer,
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
602
to return a [Name] or [Id].  Before renaming the record punning
603 604
and wild-card mechanism makes it hard to know what is bound.
So these functions should not be applied to (HsSyn RdrName)
Austin Seipp's avatar
Austin Seipp committed
605
-}
606 607 608

----------------- Bindings --------------------------
collectLocalBinders :: HsLocalBindsLR idL idR -> [idL]
609 610 611 612
collectLocalBinders (HsValBinds binds) = collectHsIdBinders binds
                                         -- No pattern synonyms here
collectLocalBinders (HsIPBinds _)      = []
collectLocalBinders EmptyLocalBinds    = []
613

614 615 616 617
collectHsIdBinders, collectHsValBinders :: HsValBindsLR idL idR -> [idL]
-- Collect Id binders only, or Ids + pattern synonmys, respectively
collectHsIdBinders  = collect_hs_val_binders True
collectHsValBinders = collect_hs_val_binders False
618 619

collectHsBindBinders :: HsBindLR idL idR -> [idL]
620 621
-- Collect both Ids and pattern-synonym binders
collectHsBindBinders b = collect_bind False b []
622

623
collectHsBindsBinders :: LHsBindsLR idL idR -> [idL]
624
collectHsBindsBinders binds = collect_binds False binds []
625

626
collectHsBindListBinders :: [LHsBindLR idL idR] -> [idL]
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
-- Same as collectHsBindsBinders, but works over a list of bindings
collectHsBindListBinders = foldr (collect_bind False . unLoc) []

collect_hs_val_binders :: Bool -> HsValBindsLR idL idR -> [idL]
collect_hs_val_binders ps (ValBindsIn  binds _) = collect_binds     ps binds []
collect_hs_val_binders ps (ValBindsOut binds _) = collect_out_binds ps binds

collect_out_binds :: Bool -> [(RecFlag, LHsBinds id)] -> [id]
collect_out_binds ps = foldr (collect_binds ps . snd) []

collect_binds :: Bool -> LHsBindsLR idL idR -> [idL] -> [idL]
-- Collect Ids, or Ids + patter synonyms, depending on boolean flag
collect_binds ps binds acc = foldrBag (collect_bind ps . unLoc) acc binds

collect_bind :: Bool -> HsBindLR idL idR -> [idL] -> [idL]
collect_bind _ (PatBind { pat_lhs = p })           acc = collect_lpat p acc
collect_bind _ (FunBind { fun_id = L _ f })        acc = f : acc
collect_bind _ (VarBind { var_id = f })            acc = f : acc
collect_bind _ (AbsBinds { abs_exports = dbinds }) acc = map abe_poly dbinds ++ acc
        -- I don't think we want the binders from the abe_binds
        -- The only time we collect binders from a typechecked
        -- binding (hence see AbsBinds) is in zonking in TcHsSyn
collect_bind omitPatSyn (PatSynBind (PSB { psb_id = L _ ps })) acc =
    if omitPatSyn then acc else ps : acc
651

652 653
collectMethodBinders :: LHsBindsLR RdrName idR -> [Located RdrName]
-- Used exclusively for the bindings of an instance decl which are all FunBinds
654
collectMethodBinders binds = foldrBag (get . unLoc) [] binds
655
  where
cactus's avatar
cactus committed
656
    get (FunBind { fun_id = f }) fs = f : fs
657
    get _                        fs = fs
658
       -- Someone else complains about non-FunBinds
659

660
----------------- Statements --------------------------
661
collectLStmtsBinders :: [LStmtLR idL idR body] -> [idL]
662
collectLStmtsBinders = concatMap collectLStmtBinders
663

664
collectStmtsBinders :: [StmtLR idL idR body] -> [idL]
665 666
collectStmtsBinders = concatMap collectStmtBinders

667
collectLStmtBinders :: LStmtLR idL idR body -> [idL]
668 669
collectLStmtBinders = collectStmtBinders . unLoc

670
collectStmtBinders :: StmtLR idL idR body -> [idL]
671
  -- Id Binders for a Stmt... [but what about pattern-sig type vars]?
672 673 674 675 676 677
collectStmtBinders (BindStmt pat _ _ _)  = collectPatBinders pat
collectStmtBinders (LetStmt (L _ binds)) = collectLocalBinders binds
collectStmtBinders (BodyStmt {})         = []
collectStmtBinders (LastStmt {})         = []
collectStmtBinders (ParStmt xs _ _)   = collectLStmtsBinders
                                      $ [s | ParStmtBlock ss _ _ <- xs, s <- ss]
678 679
collectStmtBinders (TransStmt { trS_stmts = stmts }) = collectLStmtsBinders stmts
collectStmtBinders (RecStmt { recS_stmts = ss })     = collectLStmtsBinders ss
680 681


682
----------------- Patterns --------------------------
683
collectPatBinders :: LPat a -> [a]
684
collectPatBinders pat = collect_lpat pat []
685 686

collectPatsBinders :: [LPat a] -> [a]
687
collectPatsBinders pats = foldr collect_lpat [] pats
688

689 690 691
-------------
collect_lpat :: LPat name -> [name] -> [name]
collect_lpat (L _ pat) bndrs
692 693
  = go pat
  where
694 695 696 697 698
    go (VarPat var)               = var : bndrs
    go (WildPat _)                = bndrs
    go (LazyPat pat)              = collect_lpat pat bndrs
    go (BangPat pat)              = collect_lpat pat bndrs
    go (AsPat (L _ a) pat)        = a : collect_lpat pat bndrs
699
    go (ViewPat _ pat _)          = collect_lpat pat bndrs
700 701
    go (ParPat  pat)              = collect_lpat pat bndrs

702
    go (ListPat pats _ _)         = foldr collect_lpat bndrs pats
703 704 705
    go (PArrPat pats _)           = foldr collect_lpat bndrs pats
    go (TuplePat pats _ _)        = foldr collect_lpat bndrs pats

706 707
    go (ConPatIn _ ps)            = foldr collect_lpat bndrs (hsConPatArgs ps)
    go (ConPatOut {pat_args=ps})  = foldr collect_lpat bndrs (hsConPatArgs ps)
708 709 710
        -- See Note [Dictionary binders in ConPatOut]
    go (LitPat _)                 = bndrs
    go (NPat _ _ _)               = bndrs
711
    go (NPlusKPat (L _ n) _ _ _)  = n : bndrs
712 713 714

    go (SigPatIn pat _)           = collect_lpat pat bndrs
    go (SigPatOut pat _)          = collect_lpat pat bndrs
gmainland's avatar
gmainland committed
715
    go (SplicePat _)              = bndrs
716
    go (CoPat _ pat _)            = go pat
717

Austin Seipp's avatar
Austin Seipp committed
718
{-
719
Note [Dictionary binders in ConPatOut] See also same Note in DsArrows
720 721 722 723 724 725 726 727 728
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Do *not* gather (a) dictionary and (b) dictionary bindings as binders
of a ConPatOut pattern.  For most calls it doesn't matter, because
it's pre-typechecker and there are no ConPatOuts.  But it does matter
more in the desugarer; for example, DsUtils.mkSelectorBinds uses
collectPatBinders.  In a lazy pattern, for example f ~(C x y) = ...,
we want to generate bindings for x,y but not for dictionaries bound by
C.  (The type checker ensures they would not be used.)

Ross Paterson's avatar
Ross Paterson committed
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
Desugaring of arrow case expressions needs these bindings (see DsArrows
and arrowcase1), but SPJ (Jan 2007) says it's safer for it to use its
own pat-binder-collector:

Here's the problem.  Consider

data T a where
   C :: Num a => a -> Int -> T a

f ~(C (n+1) m) = (n,m)

Here, the pattern (C (n+1)) binds a hidden dictionary (d::Num a),
and *also* uses that dictionary to match the (n+1) pattern.  Yet, the
variables bound by the lazy pattern are n,m, *not* the dictionary d.
So in mkSelectorBinds in DsUtils, we want just m,n as the variables bound.
Austin Seipp's avatar
Austin Seipp committed
744
-}
Ross Paterson's avatar
Ross Paterson committed
745

746 747 748 749
hsGroupBinders :: HsGroup Name -> [Name]
hsGroupBinders (HsGroup { hs_valds = val_decls, hs_tyclds = tycl_decls,
                          hs_instds = inst_decls, hs_fords = foreign_decls })
  =  collectHsValBinders val_decls
750
  ++ hsTyClForeignBinders tycl_decls inst_decls foreign_decls
751

752 753
hsTyClForeignBinders :: [TyClGroup Name] -> [LInstDecl Name]
                     -> [LForeignDecl Name] -> [Name]
754
-- We need to look at instance declarations too,
755
-- because their associated types may bind data constructors
756 757 758 759 760
hsTyClForeignBinders tycl_decls inst_decls foreign_decls
  = map unLoc $
    hsForeignDeclsBinders foreign_decls ++
    concatMap (concatMap hsLTyClDeclBinders . group_tyclds) tycl_decls ++
    concatMap hsLInstDeclBinders inst_decls
761

762
-------------------
763
hsLTyClDeclBinders :: Eq name => Located (TyClDecl name) -> [Located name]
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
764
-- ^ Returns all the /binding/ names of the decl.
765 766
-- The first one is guaranteed to be the name of the decl. For record fields
-- mentioned in multiple constructors, the SrcLoc will be from the first
Gabor Greif's avatar
Gabor Greif committed
767
-- occurrence.  We use the equality to filter out duplicate field names.
Simon Peyton Jones's avatar
Simon Peyton Jones committed
768
--
769 770
-- Each returned (Located name) has a SrcSpan for the /whole/ declaration.
-- See Note [SrcSpan for binders]
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
771 772 773 774 775 776 777 778

hsLTyClDeclBinders (L loc (FamDecl { tcdFam = FamilyDecl { fdLName = L _ name } }))
  = [L loc name]
hsLTyClDeclBinders (L loc (SynDecl     { tcdLName = L _ name })) = [L loc name]
hsLTyClDeclBinders (L loc (ClassDecl   { tcdLName = L _ cls_name
                                       , tcdSigs = sigs, tcdATs = ats }))
  = L loc cls_name :
    [ L fam_loc fam_name | L fam_loc (FamilyDecl { fdLName = L _ fam_name }) <- ats ] ++
thomasw's avatar
thomasw committed
779
    [ L mem_loc mem_name | L mem_loc (TypeSig ns _ _) <- sigs, L _ mem_name <- ns ]
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
780 781
hsLTyClDeclBinders (L loc (DataDecl    { tcdLName = L _ name, tcdDataDefn = defn }))
  = L loc name : hsDataDefnBinders defn
782 783

-------------------
784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
hsForeignDeclsBinders :: [LForeignDecl name] -> [Located name]
-- See Note [SrcSpan for binders]
hsForeignDeclsBinders foreign_decls
  = [ L decl_loc n
    | L decl_loc (ForeignImport (L _ n) _ _ _) <- foreign_decls]

-------------------
hsPatSynBinders :: LHsBindsLR idL idR -> [Located idL]
-- Collect pattern-synonym binders only, not Ids
-- See Note [SrcSpan for binders]
hsPatSynBinders binds = foldrBag addPatSynBndr [] binds

addPatSynBndr :: LHsBindLR idL idR -> [Located idL] -> [Located idL]
-- See Note [SrcSpan for binders]
addPatSynBndr bind pss
  | L bind_loc (PatSynBind (PSB { psb_id = L _ n })) <- bind
  = L bind_loc n : pss
  | otherwise
  = pss

-------------------
hsLInstDeclBinders :: Eq name => LInstDecl name -> [Located name]
hsLInstDeclBinders (L _ (ClsInstD { cid_inst = ClsInstDecl { cid_datafam_insts = dfis } }))
807
  = concatMap (hsDataFamInstBinders . unLoc) dfis
808 809 810
hsLInstDeclBinders (L _ (DataFamInstD { dfid_inst = fi }))
  = hsDataFamInstBinders fi
hsLInstDeclBinders (L _ (TyFamInstD {})) = []
811 812

-------------------
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
813
-- the SrcLoc returned are for the whole declarations, not just the names
814 815 816 817
hsDataFamInstBinders :: Eq name => DataFamInstDecl name -> [Located name]
hsDataFamInstBinders (DataFamInstDecl { dfid_defn = defn })
  = hsDataDefnBinders defn
  -- There can't be repeated symbols because only data instances have binders
818 819

-------------------
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
820
-- the SrcLoc returned are for the whole declarations, not just the names
821
hsDataDefnBinders :: Eq name => HsDataDefn name -> [Located name]
822 823
hsDataDefnBinders (HsDataDefn { dd_cons = cons })
  = hsConDeclsBinders cons
824
  -- See Note [Binders in family instances]
825

826
-------------------
827
hsConDeclsBinders :: forall name. (Eq name) => [LConDecl name] -> [Located name]
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
828
  -- See hsLTyClDeclBinders for what this does
829 830
  -- The function is boringly complicated because of the records
  -- And since we only have equality, we have to be a little careful
831 832 833 834
hsConDeclsBinders cons = go id cons
  where go :: ([Located name] -> [Located name]) -> [LConDecl name] -> [Located name]
        go _ [] = []
        go remSeen (r:rs) =
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
835 836
          -- don't re-mangle the location of field names, because we don't
          -- have a record of the full location of the field declaration anyway
837 838 839
          case r of
             -- remove only the first occurrence of any seen field in order to
             -- avoid circumventing detection of duplicate fields (#9156)
840 841
             L loc (ConDecl { con_names = names, con_details = RecCon flds }) ->
               (map (L loc . unLoc) names) ++ r' ++ go remSeen' rs
Alan Zimmerman's avatar
Alan Zimmerman committed
842 843
                  where r' = remSeen (concatMap (cd_fld_names . unLoc)
                                                (unLoc flds))
844
                        remSeen' = foldr (.) remSeen [deleteBy ((==) `on` unLoc) v | v <- r']
845 846
             L loc (ConDecl { con_names = names }) ->
                (map (L loc . unLoc) names) ++ go remSeen rs
847

Austin Seipp's avatar
Austin Seipp committed
848
{-
849 850 851 852 853 854 855 856 857 858

Note [SrcSpan for binders]
~~~~~~~~~~~~~~~~~~~~~~~~~~
When extracting the (Located RdrNme) for a binder, at least for the
main name (the TyCon of a type declaration etc), we want to give it
the @SrcSpan@ of the whole /declaration/, not just the name itself
(which is how it appears in the syntax tree).  This SrcSpan (for the
entire declaration) is used as the SrcSpan for the Name that is
finally produced, and hence for error messages.  (See Trac #8607.)

859 860
Note [Binders in family instances]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
861
In a type or data family instance declaration, the type
862 863 864 865
constructor is an *occurrence* not a binding site
    type instance T Int = Int -> Int   -- No binders
    data instance S Bool = S1 | S2     -- Binders are S1,S2

866

Austin Seipp's avatar
Austin Seipp committed
867 868
************************************************************************
*                                                                      *
869
        Collecting binders the user did not write
Austin Seipp's avatar
Austin Seipp committed
870 871
*                                                                      *
************************************************************************
872 873 874 875 876 877

The job of this family of functions is to run through binding sites and find the set of all Names
that were defined "implicitly", without being explicitly written by the user.

The main purpose is to find names introduced by record wildcards so that we can avoid
warning the user when they don't use those names (#4404)
Austin Seipp's avatar
Austin Seipp committed
878
-}
879

880
lStmtsImplicits :: [LStmtLR Name idR (Located (body idR))] -> NameSet
881 882
lStmtsImplicits = hs_lstmts
  where
883
    hs_lstmts :: [LStmtLR Name idR (Located (body idR))] -> NameSet
884
    hs_lstmts = foldr (\stmt rest -> unionNameSet (hs_stmt (unLoc stmt)) rest) emptyNameSet
885

886 887 888 889 890 891
    hs_stmt (BindStmt pat _ _ _)  = lPatImplicits pat
    hs_stmt (LetStmt (L _ binds)) = hs_local_binds binds
    hs_stmt (BodyStmt {})         = emptyNameSet
    hs_stmt (LastStmt {})         = emptyNameSet
    hs_stmt (ParStmt xs _ _)
                         = hs_lstmts [s | ParStmtBlock ss _ _ <- xs, s <- ss]
892 893
    hs_stmt (TransStmt { trS_stmts = stmts }) = hs_lstmts stmts
    hs_stmt (RecStmt { recS_stmts = ss })     = hs_lstmts ss
894

895 896 897 898 899 900
    hs_local_binds (HsValBinds val_binds) = hsValBindsImplicits val_binds
    hs_local_binds (HsIPBinds _)         = emptyNameSet
    hs_local_binds EmptyLocalBinds       = emptyNameSet

hsValBindsImplicits :: HsValBindsLR Name idR -> NameSet
hsValBindsImplicits (ValBindsOut binds _)
901
  = foldr (unionNameSet . lhsBindsImplicits . snd) emptyNameSet binds
902
hsValBindsImplicits (ValBindsIn binds _)
903 904 905
  = lhsBindsImplicits binds

lhsBindsImplicits :: LHsBindsLR Name idR -> NameSet
906
lhsBindsImplicits = foldBag unionNameSet (lhs_bind . unLoc) emptyNameSet
907
  where
cactus's avatar
cactus committed
908
    lhs_bind (PatBind { pat_lhs = lpat }) = lPatImplicits lpat
909
    lhs_bind _ = emptyNameSet
910 911 912 913 914

lPatImplicits :: LPat Name -> NameSet
lPatImplicits = hs_lpat
  where
    hs_lpat (L _ pat) = hs_pat pat
915

916
    hs_lpats = foldr (\pat rest -> hs_lpat pat `unionNameSet` rest) emptyNameSet
917

918 919 920 921 922
    hs_pat (LazyPat pat)       = hs_lpat pat
    hs_pat (BangPat pat)       = hs_lpat pat
    hs_pat (AsPat _ pat)       = hs_lpat pat
    hs_pat (ViewPat _ pat _)   = hs_lpat pat
    hs_pat (ParPat  pat)       = hs_lpat pat
923
    hs_pat (ListPat pats _ _)  = hs_lpats pats
924 925 926 927 928 929
    hs_pat (PArrPat pats _)    = hs_lpats pats
    hs_pat (TuplePat pats _ _) = hs_lpats pats

    hs_pat (SigPatIn pat _)  = hs_lpat pat
    hs_pat (SigPatOut pat _) = hs_lpat pat
    hs_pat (CoPat _ pat _)   = hs_pat pat
930

931 932
    hs_pat (ConPatIn _ ps)           = details ps
    hs_pat (ConPatOut {pat_args=ps}) = details ps
933

934
    hs_pat _ = emptyNameSet
935

936
    details (PrefixCon ps)   = hs_lpats ps
937
    details (RecCon fs)      = hs_lpats explicit `unionNameSet` mkNameSet (collectPatsBinders implicit)
938 939
      where (explicit, implicit) = partitionEithers [if pat_explicit then Left pat else Right pat
                                                    | (i, fld) <- [0..] `zip` rec_flds fs
940 941
                                                    , let pat = hsRecFieldArg
                                                                     (unLoc fld)