HsUtils.hs 36.8 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 57
  mkHsSpliceTy, mkHsSpliceE, mkHsSpliceTE, mkHsSplice,
  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 $
125
    Match 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))
Alan Zimmerman's avatar
Alan Zimmerman committed
132
unguardedGRHSs rhs@(L loc _) = GRHSs (unguardedRHS loc rhs) emptyLocalBinds
133

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

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

mkMatchGroupName :: Origin -> [LMatch Name (Located (body Name))]
             -> MatchGroup Name (Located (body Name))
mkMatchGroupName origin matches = MG { mg_alts = matches, mg_arg_tys = []
                                     , mg_res_ty = placeHolderType
                                     , mg_origin = origin }
148

149 150 151 152 153 154
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)

155
mkHsLam :: [LPat RdrName] -> LHsExpr RdrName -> LHsExpr RdrName
156
mkHsLam pats body = mkHsPar (L (getLoc body) (HsLam matches))
157
        where
158
          matches = mkMatchGroup Generated [mkSimpleMatch pats body]
159 160

mkHsLams :: [TyVar] -> [EvVar] -> LHsExpr Id -> LHsExpr Id
161 162
mkHsLams tyvars dicts expr = mkLHsWrap (mkWpTyLams tyvars
                                       <.> mkWpLams dicts) expr
163 164

mkHsConApp :: DataCon -> [Type] -> [HsExpr Id] -> LHsExpr Id
165 166
-- Used for constructing dictionary terms etc, so no locations
mkHsConApp data_con tys args
167 168 169 170
  = foldl mk_app (nlHsTyApp (dataConWrapId data_con) tys) args
  where
    mk_app f a = noLoc (HsApp f (noLoc a))

171
mkSimpleHsAlt :: LPat id -> (Located (body id)) -> LMatch id (Located (body id))
172
-- A simple lambda with a single pattern, no binds, no guards; pre-typechecking
173
mkSimpleHsAlt pat expr
174 175
  = mkSimpleMatch [pat] expr

176
nlHsTyApp :: name -> [Type] -> LHsExpr name
177
nlHsTyApp fun_id tys = noLoc (HsWrap (mkWpTyApps tys) (HsVar fun_id))
178

179 180 181
nlHsTyApps :: name -> [Type] -> [LHsExpr name] -> LHsExpr name
nlHsTyApps fun_id tys xs = foldl nlHsApp (nlHsTyApp fun_id tys) xs

182 183 184 185 186 187 188 189 190 191 192
--------- 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

193

194
-------------------------------
195 196 197
-- These are the bits of syntax that contain rebindable names
-- See RnEnv.lookupSyntaxName

198
mkHsIntegral   :: String -> Integer -> PostTc RdrName Type -> HsOverLit RdrName
199
mkHsFractional :: FractionalLit -> PostTc RdrName Type -> HsOverLit RdrName
200
mkHsIsString :: String -> FastString -> PostTc RdrName Type -> HsOverLit RdrName
201 202 203
mkHsDo         :: HsStmtContext Name -> [ExprLStmt RdrName] -> HsExpr RdrName
mkHsComp       :: HsStmtContext Name -> [ExprLStmt RdrName] -> LHsExpr RdrName
               -> HsExpr RdrName
twanvl's avatar
twanvl committed
204 205 206 207

mkNPat      :: HsOverLit id -> Maybe (SyntaxExpr id) -> Pat id
mkNPlusKPat :: Located id -> HsOverLit id -> Pat id

208
mkLastStmt :: Located (bodyR idR) -> StmtLR idL idR (Located (bodyR idR))
209 210
mkBodyStmt :: Located (bodyR RdrName)
           -> StmtLR idL RdrName (Located (bodyR RdrName))
211
mkBindStmt :: LPat idL -> Located (bodyR idR) -> StmtLR idL idR (Located (bodyR idR))
212

213 214 215 216
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
217 218


219 220 221
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
222

223 224
noRebindableInfo :: PlaceHolder
noRebindableInfo = PlaceHolder -- Just another placeholder;
225

226 227 228 229
mkHsDo ctxt stmts = HsDo ctxt stmts placeHolderType
mkHsComp ctxt stmts expr = mkHsDo ctxt (stmts ++ [last_stmt])
  where
    last_stmt = L (getLoc expr) $ mkLastStmt expr
230

231 232 233
mkHsIf :: LHsExpr id -> LHsExpr id -> LHsExpr id -> HsExpr id
mkHsIf c a b = HsIf (Just noSyntaxExpr) c a b

234
mkNPat lit neg     = NPat lit neg noSyntaxExpr
235
mkNPlusKPat id lit = NPlusKPat id lit noSyntaxExpr noSyntaxExpr
236

237 238 239 240 241 242 243 244
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)
245

246
emptyTransStmt :: StmtLR idL idR (LHsExpr idR)
247
emptyTransStmt = TransStmt { trS_form = panic "emptyTransStmt: form"
248
                           , trS_stmts = [], trS_bndrs = []
249 250 251
                           , trS_by = Nothing, trS_using = noLoc noSyntaxExpr
                           , trS_ret = noSyntaxExpr, trS_bind = noSyntaxExpr
                           , trS_fmap = noSyntaxExpr }
252 253 254 255
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 }
256

257 258 259
mkLastStmt body     = LastStmt body noSyntaxExpr
mkBodyStmt body     = BodyStmt body noSyntaxExpr noSyntaxExpr placeHolderType
mkBindStmt pat body = BindStmt pat body noSyntaxExpr noSyntaxExpr
260 261


262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
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 }
277 278

-------------------------------
279 280
--- 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
281
mkHsOpApp :: LHsExpr id -> id -> LHsExpr id -> HsExpr id
282 283
mkHsOpApp e1 op e2 = OpApp e1 (noLoc (HsVar op)) (error "mkOpApp:fixity") e2

284 285
mkHsSplice :: LHsExpr RdrName -> HsSplice RdrName
mkHsSplice e = HsSplice unqualSplice e
286

287 288 289
unqualSplice :: RdrName
unqualSplice = mkRdrUnqual (mkVarOccFS (fsLit "splice"))

290
mkHsSpliceE :: LHsExpr RdrName -> HsExpr RdrName
291
mkHsSpliceE e = HsSpliceE False (mkHsSplice e)
292 293

mkHsSpliceTE :: LHsExpr RdrName -> HsExpr RdrName
294
mkHsSpliceTE e = HsSpliceE True (mkHsSplice e)
295

296
mkHsSpliceTy :: LHsExpr RdrName -> HsType RdrName
297
mkHsSpliceTy e = HsSpliceTy (mkHsSplice e) placeHolderKind
298

twanvl's avatar
twanvl committed
299
mkHsQuasiQuote :: RdrName -> SrcSpan -> FastString -> HsQuasiQuote RdrName
300
mkHsQuasiQuote quoter span quote = HsQuasiQuote quoter span quote
301

twanvl's avatar
twanvl committed
302
unqualQuasiQuote :: RdrName
Ian Lynagh's avatar
Ian Lynagh committed
303
unqualQuasiQuote = mkRdrUnqual (mkVarOccFS (fsLit "quasiquote"))
304 305
                -- A name (uniquified later) to
                -- identify the quasi-quote
306

twanvl's avatar
twanvl committed
307
mkHsString :: String -> HsLit
308
mkHsString s = HsString s (mkFastString s)
309 310

-------------
311
userHsTyVarBndrs :: SrcSpan -> [name] -> [Located (HsTyVarBndr name)]
312
-- Caller sets location
313
userHsTyVarBndrs loc bndrs = [ L loc (UserTyVar v) | v <- bndrs ]
314

Austin Seipp's avatar
Austin Seipp committed
315 316 317
{-
************************************************************************
*                                                                      *
318
        Constructing syntax with no location info
Austin Seipp's avatar
Austin Seipp committed
319 320 321
*                                                                      *
************************************************************************
-}
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337

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
338
nlHsIntLit :: Integer -> LHsExpr id
339
nlHsIntLit n = noLoc (HsLit (HsInt (show n) n))
340 341 342

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

344 345
nlHsVarApps :: id -> [id] -> LHsExpr id
nlHsVarApps f xs = noLoc (foldl mk (HsVar f) (map HsVar xs))
346 347
                 where
                   mk f a = HsApp (noLoc f) (noLoc a)
348

349
nlConVarPat :: RdrName -> [RdrName] -> LPat RdrName
350 351 352 353 354
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))

355
nlConPat :: RdrName -> [LPat RdrName] -> LPat RdrName
356 357
nlConPat con pats = noLoc (ConPatIn (noLoc con) (PrefixCon pats))

358 359 360
nlConPatName :: Name -> [LPat Name] -> LPat Name
nlConPatName con pats = noLoc (ConPatIn (noLoc con) (PrefixCon pats))

361 362 363 364 365
nlNullaryConPat :: id -> LPat id
nlNullaryConPat con = noLoc (ConPatIn (noLoc con) (PrefixCon []))

nlWildConPat :: DataCon -> LPat RdrName
nlWildConPat con = noLoc (ConPatIn (noLoc (getRdrName con))
366 367
                         (PrefixCon (nOfThem (dataConSourceArity con)
                                             nlWildPat)))
368

369 370
nlWildPat :: LPat RdrName
nlWildPat  = noLoc (WildPat placeHolderType )  -- Pre-typechecking
371

372 373 374 375 376 377 378 379
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
380
nlHsDo ctxt stmts = noLoc (mkHsDo ctxt stmts)
381

twanvl's avatar
twanvl committed
382
nlHsOpApp :: LHsExpr id -> id -> LHsExpr id -> LHsExpr id
383 384
nlHsOpApp e1 op e2 = noLoc (mkHsOpApp e1 op e2)

385
nlHsLam  :: LMatch RdrName (LHsExpr RdrName) -> LHsExpr RdrName
twanvl's avatar
twanvl committed
386 387
nlHsPar  :: LHsExpr id -> LHsExpr id
nlHsIf   :: LHsExpr id -> LHsExpr id -> LHsExpr id -> LHsExpr id
388 389 390
nlHsCase :: LHsExpr RdrName -> [LMatch RdrName (LHsExpr RdrName)]
         -> LHsExpr RdrName
nlList   :: [LHsExpr RdrName] -> LHsExpr RdrName
twanvl's avatar
twanvl committed
391

392
nlHsLam match          = noLoc (HsLam (mkMatchGroup Generated [match]))
393 394 395 396
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)
397

twanvl's avatar
twanvl committed
398 399 400 401
nlHsAppTy :: LHsType name -> LHsType name -> LHsType name
nlHsTyVar :: name                         -> LHsType name
nlHsFunTy :: LHsType name -> LHsType name -> LHsType name

402 403 404
nlHsAppTy f t           = noLoc (HsAppTy f t)
nlHsTyVar x             = noLoc (HsTyVar x)
nlHsFunTy a b           = noLoc (HsFunTy a b)
405

twanvl's avatar
twanvl committed
406
nlHsTyConApp :: name -> [LHsType name] -> LHsType name
407
nlHsTyConApp tycon tys  = foldl nlHsAppTy (nlHsTyVar tycon) tys
408

Austin Seipp's avatar
Austin Seipp committed
409
{-
410 411
Tuples.  All these functions are *pre-typechecker* because they lack
types on the tuple.
Austin Seipp's avatar
Austin Seipp committed
412
-}
413 414 415 416

mkLHsTupleExpr :: [LHsExpr a] -> LHsExpr a
-- Makes a pre-typechecker boxed tuple, deals with 1 case
mkLHsTupleExpr [e] = e
417
mkLHsTupleExpr es  = noLoc $ ExplicitTuple (map (noLoc . Present) es) Boxed
418 419 420

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

422
nlTuplePat :: [LPat id] -> Boxity -> LPat id
423
nlTuplePat pats box = noLoc (TuplePat pats box [])
424

425
missingTupArg :: HsTupArg RdrName
426
missingTupArg = Missing placeHolderType
427

Austin Seipp's avatar
Austin Seipp committed
428 429 430
{-
************************************************************************
*                                                                      *
431
        Converting a Type to an HsType RdrName
Austin Seipp's avatar
Austin Seipp committed
432 433
*                                                                      *
************************************************************************
434 435

This is needed to implement GeneralizedNewtypeDeriving.
Austin Seipp's avatar
Austin Seipp committed
436
-}
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454

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)
455
    to_hs_type (TyConApp tc args) = nlHsTyConApp (getRdrName tc) (map toHsType args')
456
       where
Simon Peyton Jones's avatar
Simon Peyton Jones committed
457 458 459
         args' = filterOut isKind args
         -- Source-language types have _implicit_ kind arguments,
         -- so we must remove them here (Trac #8563)
460 461 462 463 464 465 466 467 468 469 470
    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)
    to_hs_type (LitTy (NumTyLit n)) = noLoc $ HsTyLit (HsNumTy n)
    to_hs_type (LitTy (StrTyLit s)) = noLoc $ HsTyLit (HsStrTy s)

    mk_hs_tvb tv = noLoc $ KindedTyVar (getRdrName tv) (toHsKind (tyVarKind tv))

toHsKind :: Kind -> LHsKind RdrName
toHsKind = toHsType

471 472 473 474 475 476
--------- 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
477
                 | otherwise           = HsWrap co_fn e
478

479 480
mkHsWrapCo :: TcCoercion   -- A Nominal coercion  a ~N b
           -> HsExpr id -> HsExpr id
Joachim Breitner's avatar
Joachim Breitner committed
481
mkHsWrapCo co e = mkHsWrap (coToHsWrapper co) e
482

483 484 485 486
mkHsWrapCoR :: TcCoercion   -- A Representational coercion  a ~R b
            -> HsExpr id -> HsExpr id
mkHsWrapCoR co e = mkHsWrap (coToHsWrapperR co) e

487
mkLHsWrapCo :: TcCoercion -> LHsExpr id -> LHsExpr id
Joachim Breitner's avatar
Joachim Breitner committed
488
mkLHsWrapCo co (L loc e) = L loc (mkHsWrapCo co e)
489

490 491 492 493
mkHsCmdCast :: TcCoercion -> HsCmd id -> HsCmd id
mkHsCmdCast co cmd | isTcReflCo co = cmd
                   | otherwise     = HsCmdCast co cmd

494
coToHsWrapper :: TcCoercion -> HsWrapper   -- A Nominal coercion
495
coToHsWrapper co | isTcReflCo co = idHsWrapper
Joachim Breitner's avatar
Joachim Breitner committed
496
                 | otherwise     = mkWpCast (mkTcSubCo co)
497

498 499 500 501
coToHsWrapperR :: TcCoercion -> HsWrapper   -- A Representational coercion
coToHsWrapperR co | isTcReflCo co = idHsWrapper
                  | otherwise     = mkWpCast co

502 503
mkHsWrapPat :: HsWrapper -> Pat id -> Type -> Pat id
mkHsWrapPat co_fn p ty | isIdHsWrapper co_fn = p
504
                       | otherwise           = CoPat co_fn p ty
505 506 507

mkHsWrapPatCo :: TcCoercion -> Pat id -> Type -> Pat id
mkHsWrapPatCo co pat ty | isTcReflCo co = pat
Joachim Breitner's avatar
Joachim Breitner committed
508
                        | otherwise     = CoPat (mkWpCast co) pat ty
509 510 511

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

{-
514
l
Austin Seipp's avatar
Austin Seipp committed
515 516
************************************************************************
*                                                                      *
517
                Bindings; with a location at the top
Austin Seipp's avatar
Austin Seipp committed
518 519 520
*                                                                      *
************************************************************************
-}
521

522 523
mkFunBind :: Located RdrName -> [LMatch RdrName (LHsExpr RdrName)]
          -> HsBind RdrName
524
-- Not infix, with place holders for coercion and free vars
525
mkFunBind fn ms = FunBind { fun_id = fn, fun_infix = False
526 527
                          , fun_matches = mkMatchGroup Generated ms
                          , fun_co_fn = idHsWrapper
528
                          , bind_fvs = placeHolderNames
529
                          , fun_tick = [] }
530

531 532
mkTopFunBind :: Origin -> Located Name -> [LMatch Name (LHsExpr Name)]
             -> HsBind Name
533
-- In Name-land, with empty bind_fvs
534
mkTopFunBind origin fn ms = FunBind { fun_id = fn, fun_infix = False
535
                                    , fun_matches = mkMatchGroupName origin ms
536
                                    , fun_co_fn = idHsWrapper
537 538
                                    , bind_fvs = emptyNameSet -- NB: closed
                                                              --     binding
539
                                    , fun_tick = [] }
540

541
mkHsVarBind :: SrcSpan -> RdrName -> LHsExpr RdrName -> LHsBind RdrName
542 543 544 545
mkHsVarBind loc var rhs = mk_easy_FunBind loc var [] rhs

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

548 549
mkPatSynBind :: Located RdrName -> HsPatSynDetails (Located RdrName)
             -> LPat RdrName -> HsPatSynDir RdrName -> HsBind RdrName
550 551 552 553 554 555 556
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
557

558
------------
559
mk_easy_FunBind :: SrcSpan -> RdrName -> [LPat RdrName]
560
                -> LHsExpr RdrName -> LHsBind RdrName
561
mk_easy_FunBind loc fun pats expr
562
  = L loc $ mkFunBind (L loc fun) [mkMatch pats expr emptyLocalBinds]
563

564
------------
565
mkMatch :: [LPat id] -> LHsExpr id -> HsLocalBinds id -> LMatch id (LHsExpr id)
566
mkMatch pats expr binds
567
  = noLoc (Match (map paren pats) Nothing
Alan Zimmerman's avatar
Alan Zimmerman committed
568
                 (GRHSs (unguardedRHS noSrcSpan expr) binds))
569
  where
570 571
    paren lp@(L l p) | hsPatNeedsParens p = L l (ParPat lp)
                     | otherwise          = lp
572

Austin Seipp's avatar
Austin Seipp committed
573 574 575
{-
************************************************************************
*                                                                      *
576
        Collecting binders
Austin Seipp's avatar
Austin Seipp committed
577 578
*                                                                      *
************************************************************************
579 580 581 582 583 584 585 586 587 588 589

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).

590 591 592
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
593
to return a [Name] or [Id].  Before renaming the record punning
594 595
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
596
-}
597 598 599

----------------- Bindings --------------------------
collectLocalBinders :: HsLocalBindsLR idL idR -> [idL]
600 601 602 603
collectLocalBinders (HsValBinds binds) = collectHsIdBinders binds
                                         -- No pattern synonyms here
collectLocalBinders (HsIPBinds _)      = []
collectLocalBinders EmptyLocalBinds    = []
604

605 606 607 608
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
609 610

collectHsBindBinders :: HsBindLR idL idR -> [idL]
611 612
-- Collect both Ids and pattern-synonym binders
collectHsBindBinders b = collect_bind False b []
613

614
collectHsBindsBinders :: LHsBindsLR idL idR -> [idL]
615
collectHsBindsBinders binds = collect_binds False binds []
616

617
collectHsBindListBinders :: [LHsBindLR idL idR] -> [idL]
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
-- 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
642

643 644
collectMethodBinders :: LHsBindsLR RdrName idR -> [Located RdrName]
-- Used exclusively for the bindings of an instance decl which are all FunBinds
645
collectMethodBinders binds = foldrBag (get . unLoc) [] binds
646
  where
cactus's avatar
cactus committed
647
    get (FunBind { fun_id = f }) fs = f : fs
648
    get _                        fs = fs
649
       -- Someone else complains about non-FunBinds
650

651
----------------- Statements --------------------------
652
collectLStmtsBinders :: [LStmtLR idL idR body] -> [idL]
653
collectLStmtsBinders = concatMap collectLStmtBinders
654

655
collectStmtsBinders :: [StmtLR idL idR body] -> [idL]
656 657
collectStmtsBinders = concatMap collectStmtBinders

658
collectLStmtBinders :: LStmtLR idL idR body -> [idL]
659 660
collectLStmtBinders = collectStmtBinders . unLoc

661
collectStmtBinders :: StmtLR idL idR body -> [idL]
662
  -- Id Binders for a Stmt... [but what about pattern-sig type vars]?
663
collectStmtBinders (BindStmt pat _ _ _) = collectPatBinders pat
664
collectStmtBinders (LetStmt binds)      = collectLocalBinders binds
665
collectStmtBinders (BodyStmt {})        = []
666
collectStmtBinders (LastStmt {})        = []
667 668
collectStmtBinders (ParStmt xs _ _)     = collectLStmtsBinders
                                        $ [s | ParStmtBlock ss _ _ <- xs, s <- ss]
669 670
collectStmtBinders (TransStmt { trS_stmts = stmts }) = collectLStmtsBinders stmts
collectStmtBinders (RecStmt { recS_stmts = ss })     = collectLStmtsBinders ss
671 672


673
----------------- Patterns --------------------------
674
collectPatBinders :: LPat a -> [a]
675
collectPatBinders pat = collect_lpat pat []
676 677

collectPatsBinders :: [LPat a] -> [a]
678
collectPatsBinders pats = foldr collect_lpat [] pats
679

680 681 682
-------------
collect_lpat :: LPat name -> [name] -> [name]
collect_lpat (L _ pat) bndrs
683 684
  = go pat
  where
685 686 687 688 689
    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
690
    go (ViewPat _ pat _)          = collect_lpat pat bndrs
691 692
    go (ParPat  pat)              = collect_lpat pat bndrs

693
    go (ListPat pats _ _)         = foldr collect_lpat bndrs pats
694 695 696
    go (PArrPat pats _)           = foldr collect_lpat bndrs pats
    go (TuplePat pats _ _)        = foldr collect_lpat bndrs pats

697 698
    go (ConPatIn _ ps)            = foldr collect_lpat bndrs (hsConPatArgs ps)
    go (ConPatOut {pat_args=ps})  = foldr collect_lpat bndrs (hsConPatArgs ps)
699 700 701
        -- See Note [Dictionary binders in ConPatOut]
    go (LitPat _)                 = bndrs
    go (NPat _ _ _)               = bndrs
702
    go (NPlusKPat (L _ n) _ _ _)  = n : bndrs
703 704 705

    go (SigPatIn pat _)           = collect_lpat pat bndrs
    go (SigPatOut pat _)          = collect_lpat pat bndrs
gmainland's avatar
gmainland committed
706
    go (SplicePat _)              = bndrs
707
    go (QuasiQuotePat _)          = bndrs
708
    go (CoPat _ pat _)            = go pat
709

Austin Seipp's avatar
Austin Seipp committed
710
{-
711
Note [Dictionary binders in ConPatOut] See also same Note in DsArrows
712 713 714 715 716 717 718 719 720
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
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
736
-}
Ross Paterson's avatar
Ross Paterson committed
737

738 739 740 741
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
742
  ++ hsTyClForeignBinders tycl_decls inst_decls foreign_decls
743

744 745
hsTyClForeignBinders :: [TyClGroup Name] -> [LInstDecl Name]
                     -> [LForeignDecl Name] -> [Name]
746
-- We need to look at instance declarations too,
747
-- because their associated types may bind data constructors
748 749 750 751 752
hsTyClForeignBinders tycl_decls inst_decls foreign_decls
  = map unLoc $
    hsForeignDeclsBinders foreign_decls ++
    concatMap (concatMap hsLTyClDeclBinders . group_tyclds) tycl_decls ++
    concatMap hsLInstDeclBinders inst_decls
753

754
-------------------
755
hsLTyClDeclBinders :: Eq name => Located (TyClDecl name) -> [Located name]
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
756
-- ^ Returns all the /binding/ names of the decl.
757 758
-- 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
759
-- occurrence.  We use the equality to filter out duplicate field names.
Simon Peyton Jones's avatar
Simon Peyton Jones committed
760
--
761 762
-- 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
763 764 765 766 767 768 769 770

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
771
    [ 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
772 773
hsLTyClDeclBinders (L loc (DataDecl    { tcdLName = L _ name, tcdDataDefn = defn }))
  = L loc name : hsDataDefnBinders defn
774 775

-------------------
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
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 } }))
799
  = concatMap (hsDataFamInstBinders . unLoc) dfis
800 801 802
hsLInstDeclBinders (L _ (DataFamInstD { dfid_inst = fi }))
  = hsDataFamInstBinders fi
hsLInstDeclBinders (L _ (TyFamInstD {})) = []
803 804

-------------------
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
805
-- the SrcLoc returned are for the whole declarations, not just the names
806 807 808 809
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
810 811

-------------------
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
812
-- the SrcLoc returned are for the whole declarations, not just the names
813
hsDataDefnBinders :: Eq name => HsDataDefn name -> [Located name]
814 815
hsDataDefnBinders (HsDataDefn { dd_cons = cons })
  = hsConDeclsBinders cons
816
  -- See Note [Binders in family instances]
817

818
-------------------
819
hsConDeclsBinders :: forall name. (Eq name) => [LConDecl name] -> [Located name]
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
820
  -- See hsLTyClDeclBinders for what this does
821 822
  -- The function is boringly complicated because of the records
  -- And since we only have equality, we have to be a little careful
823 824 825 826
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
827 828
          -- 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
829 830 831
          case r of
             -- remove only the first occurrence of any seen field in order to
             -- avoid circumventing detection of duplicate fields (#9156)
832 833 834
             L loc (ConDecl { con_names = names, con_details = RecCon flds }) ->
               (map (L loc . unLoc) names) ++ r' ++ go remSeen' rs
                  where r' = remSeen (concatMap (cd_fld_names . unLoc) flds)
835
                        remSeen' = foldr (.) remSeen [deleteBy ((==) `on` unLoc) v | v <- r']
836 837
             L loc (ConDecl { con_names = names }) ->
                (map (L loc . unLoc) names) ++ go remSeen rs
838

Austin Seipp's avatar
Austin Seipp committed
839
{-
840 841 842 843 844 845 846 847 848 849

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.)

850 851
Note [Binders in family instances]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
852
In a type or data family instance declaration, the type
853 854 855 856
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

857

Austin Seipp's avatar
Austin Seipp committed
858 859
************************************************************************
*                                                                      *
860
        Collecting binders the user did not write
Austin Seipp's avatar
Austin Seipp committed
861 862
*                                                                      *
************************************************************************
863 864 865 866 867 868

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
869
-}
870

871
lStmtsImplicits :: [LStmtLR Name idR (Located (body idR))] -> NameSet
872 873
lStmtsImplicits = hs_lstmts
  where
874
    hs_lstmts :: [LStmtLR Name idR (Located (body idR))] -> NameSet
875
    hs_lstmts = foldr (\stmt rest -> unionNameSet (hs_stmt (unLoc stmt)) rest) emptyNameSet
876

877 878
    hs_stmt (BindStmt pat _ _ _) = lPatImplicits pat
    hs_stmt (LetStmt binds)      = hs_local_binds binds
879
    hs_stmt (BodyStmt {})        = emptyNameSet
880
    hs_stmt (LastStmt {})        = emptyNameSet
881
    hs_stmt (ParStmt xs _ _)     = hs_lstmts [s | ParStmtBlock ss _ _ <- xs, s <- ss]
882 883
    hs_stmt (TransStmt { trS_stmts = stmts }) = hs_lstmts stmts
    hs_stmt (RecStmt { recS_stmts = ss })     = hs_lstmts ss
884

885 886 887 888 889 890
    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 _)
891
  = foldr (unionNameSet . lhsBindsImplicits . snd) emptyNameSet binds
892
hsValBindsImplicits (ValBindsIn binds _)
893 894 895
  = lhsBindsImplicits binds

lhsBindsImplicits :: LHsBindsLR Name idR -> NameSet
896
lhsBindsImplicits = foldBag unionNameSet (lhs_bind . unLoc) emptyNameSet
897
  where
cactus's avatar
cactus committed
898
    lhs_bind (PatBind { pat_lhs = lpat }) = lPatImplicits lpat
899
    lhs_bind _ = emptyNameSet
900 901 902 903 904

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

906
    hs_lpats = foldr (\pat rest -> hs_lpat pat `unionNameSet` rest) emptyNameSet
907

908 909 910 911 912
    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
913
    hs_pat (ListPat pats _ _)  = hs_lpats pats
914 915 916 917 918 919
    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
920

921 922
    hs_pat (ConPatIn _ ps)           = details ps
    hs_pat (ConPatOut {pat_args=ps}) = details ps
923

924
    hs_pat _ = emptyNameSet
925

926
    details (PrefixCon ps)   = hs_lpats ps
927
    details (RecCon fs)      = hs_lpats explicit `unionNameSet` mkNameSet (collectPatsBinders implicit)
928 929
      where (explicit, implicit) = partitionEithers [if pat_explicit then Left pat else Right pat
                                                    | (i, fld) <- [0..] `zip` rec_flds fs
930 931
                                                    , let pat = hsRecFieldArg
                                                                     (unLoc fld)
932
                                                          pat_explicit = maybe True (i<) (rec_dotdot fs)]
933
    details (InfixCon p1 p2) = hs_lpat p1 `unionNameSet` hs_lpat p2