HsUtils.hs 40 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, coToHsWrapperR, 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

Simon Marlow's avatar
Simon Marlow committed
35 36 37 38
  -- * Constructing general big tuples
  -- $big_tuples
  mkChunkified, chunkify,

39
  -- Bindings
Simon Marlow's avatar
Simon Marlow committed
40 41
  mkFunBind, mkVarBind, mkHsVarBind, mk_easy_FunBind, mkTopFunBind,
  mkPatSynBind,
42 43

  -- Literals
44
  mkHsIntegral, mkHsFractional, mkHsIsString, mkHsString,
45 46

  -- Patterns
47 48 49
  mkNPat, mkNPlusKPat, nlVarPat, nlLitPat, nlConVarPat, nlConPat,
  nlConPatName, nlInfixConPat, nlNullaryConPat, nlWildConPat, nlWildPat,
  nlWildPatName, nlWildPatId, nlTuplePat, mkParPat,
Simon Marlow's avatar
Simon Marlow committed
50
  mkBigLHsVarTup, mkBigLHsTup, mkBigLHsVarPatTup, mkBigLHsPatTup,
51 52 53

  -- Types
  mkHsAppTy, userHsTyVarBndrs,
54
  nlHsAppTy, nlHsTyVar, nlHsFunTy, nlHsTyConApp,
55 56

  -- Stmts
57
  mkTransformStmt, mkTransformByStmt, mkBodyStmt, mkBindStmt, mkLastStmt,
58 59
  emptyTransStmt, mkGroupUsingStmt, mkGroupByUsingStmt,
  emptyRecStmt, emptyRecStmtName, emptyRecStmtId, mkRecStmt,
60 61

  -- Template Haskell
62
  mkHsSpliceTy, mkHsSpliceE, mkHsSpliceTE, mkUntypedSplice,
63
  mkHsQuasiQuote, unqualQuasiQuote,
64 65

  -- Flags
66
  noRebindableInfo,
67 68

  -- Collecting binders
69
  collectLocalBinders, collectHsValBinders, collectHsBindListBinders,
70
  collectHsIdBinders,
71 72 73 74
  collectHsBindsBinders, collectHsBindBinders, collectMethodBinders,
  collectPatBinders, collectPatsBinders,
  collectLStmtsBinders, collectStmtsBinders,
  collectLStmtBinders, collectStmtBinders,
75

76
  hsLTyClDeclBinders, hsTyClForeignBinders, hsPatSynBinders,
77
  hsForeignDeclsBinders, hsGroupBinders, hsDataFamInstBinders,
78

79 80
  -- Collecting implicit binders
  lStmtsImplicits, hsValBindsImplicits, lPatImplicits
81
  ) where
82

83 84
#include "HsVersions.h"

85
import HsDecls
86 87 88
import HsBinds
import HsExpr
import HsPat
89
import HsTypes
90
import HsLit
91
import PlaceHolder
92

93
import TcEvidence
94 95
import RdrName
import Var
96
import TypeRep
97 98
import TcType
import Kind
99 100
import DataCon
import Name
101
import NameSet
102
import BasicTypes
103
import SrcLoc
104 105
import FastString
import Util
106
import Bag
107
import Outputable
Simon Marlow's avatar
Simon Marlow committed
108
import Constants
109

110
import Data.Either
111 112
import Data.Function
import Data.List
113

Austin Seipp's avatar
Austin Seipp committed
114 115 116
{-
************************************************************************
*                                                                      *
117
        Some useful helpers for constructing syntax
Austin Seipp's avatar
Austin Seipp committed
118 119
*                                                                      *
************************************************************************
120

121 122 123
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
124
-}
125 126 127 128

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

129
mkSimpleMatch :: [LPat id] -> Located (body id) -> LMatch id (Located (body id))
130
mkSimpleMatch pats rhs
131
  = L loc $
Alan Zimmerman's avatar
Alan Zimmerman committed
132
    Match Nothing pats Nothing (unguardedGRHSs rhs)
133 134
  where
    loc = case pats of
135 136
                []      -> getLoc rhs
                (pat:_) -> combineSrcSpans (getLoc pat) (getLoc rhs)
137

138
unguardedGRHSs :: Located (body id) -> GRHSs id (Located (body id))
139
unguardedGRHSs rhs@(L loc _) = GRHSs (unguardedRHS loc rhs) emptyLocalBinds
140

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

144 145
mkMatchGroup :: Origin -> [LMatch RdrName (Located (body RdrName))]
             -> MatchGroup RdrName (Located (body RdrName))
146
mkMatchGroup origin matches = MG { mg_alts = matches, mg_arg_tys = []
147 148 149 150 151
                                 , mg_res_ty = placeHolderType
                                 , mg_origin = origin }

mkMatchGroupName :: Origin -> [LMatch Name (Located (body Name))]
             -> MatchGroup Name (Located (body Name))
152
mkMatchGroupName origin matches = MG { mg_alts = 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 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

Simon Marlow's avatar
Simon Marlow committed
264
mkLastStmt body     = LastStmt body False noSyntaxExpr
265 266
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

Simon Marlow's avatar
Simon Marlow committed
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
mkLHsPatTup :: [LPat id] -> LPat id
mkLHsPatTup []     = noLoc $ TuplePat [] Boxed []
mkLHsPatTup [lpat] = lpat
mkLHsPatTup lpats  = L (getLoc (head lpats)) $ TuplePat lpats Boxed []

-- The Big equivalents for the source tuple expressions
mkBigLHsVarTup :: [id] -> LHsExpr id
mkBigLHsVarTup ids = mkBigLHsTup (map nlHsVar ids)

mkBigLHsTup :: [LHsExpr id] -> LHsExpr id
mkBigLHsTup = mkChunkified mkLHsTupleExpr

-- The Big equivalents for the source tuple patterns
mkBigLHsVarPatTup :: [id] -> LPat id
mkBigLHsVarPatTup bs = mkBigLHsPatTup (map nlVarPat bs)

mkBigLHsPatTup :: [LPat id] -> LPat id
mkBigLHsPatTup = mkChunkified mkLHsPatTup

-- $big_tuples
-- #big_tuples#
--
-- GHCs built in tuples can only go up to 'mAX_TUPLE_SIZE' in arity, but
-- we might concievably want to build such a massive tuple as part of the
-- output of a desugaring stage (notably that for list comprehensions).
--
-- We call tuples above this size \"big tuples\", and emulate them by
-- creating and pattern matching on >nested< tuples that are expressible
-- by GHC.
--
-- Nesting policy: it's better to have a 2-tuple of 10-tuples (3 objects)
-- than a 10-tuple of 2-tuples (11 objects), so we want the leaves of any
-- construction to be big.
--
-- If you just use the 'mkBigCoreTup', 'mkBigCoreVarTupTy', 'mkTupleSelector'
-- and 'mkTupleCase' functions to do all your work with tuples you should be
-- fine, and not have to worry about the arity limitation at all.

-- | Lifts a \"small\" constructor into a \"big\" constructor by recursive decompositon
mkChunkified :: ([a] -> a)      -- ^ \"Small\" constructor function, of maximum input arity 'mAX_TUPLE_SIZE'
             -> [a]             -- ^ Possible \"big\" list of things to construct from
             -> a               -- ^ Constructed thing made possible by recursive decomposition
mkChunkified small_tuple as = mk_big_tuple (chunkify as)
  where
        -- Each sub-list is short enough to fit in a tuple
    mk_big_tuple [as] = small_tuple as
    mk_big_tuple as_s = mk_big_tuple (chunkify (map small_tuple as_s))

chunkify :: [a] -> [[a]]
-- ^ Split a list into lists that are small enough to have a corresponding
-- tuple arity. The sub-lists of the result all have length <= 'mAX_TUPLE_SIZE'
-- But there may be more than 'mAX_TUPLE_SIZE' sub-lists
chunkify xs
  | n_xs <= mAX_TUPLE_SIZE = [xs]
  | otherwise              = split xs
  where
    n_xs     = length xs
    split [] = []
    split xs = take mAX_TUPLE_SIZE xs : split (drop mAX_TUPLE_SIZE xs)

Austin Seipp's avatar
Austin Seipp committed
495 496 497
{-
************************************************************************
*                                                                      *
498
        Converting a Type to an HsType RdrName
Austin Seipp's avatar
Austin Seipp committed
499 500
*                                                                      *
************************************************************************
501 502

This is needed to implement GeneralizedNewtypeDeriving.
Austin Seipp's avatar
Austin Seipp committed
503
-}
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521

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)
522
    to_hs_type (TyConApp tc args) = nlHsTyConApp (getRdrName tc) (map toHsType args')
523
       where
Simon Peyton Jones's avatar
Simon Peyton Jones committed
524 525 526
         args' = filterOut isKind args
         -- Source-language types have _implicit_ kind arguments,
         -- so we must remove them here (Trac #8563)
527 528 529
    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
530 531
    to_hs_type (LitTy (NumTyLit n)) = noLoc $ HsTyLit (HsNumTy "" n)
    to_hs_type (LitTy (StrTyLit s)) = noLoc $ HsTyLit (HsStrTy "" s)
532

Alan Zimmerman's avatar
Alan Zimmerman committed
533 534
    mk_hs_tvb tv = noLoc $ KindedTyVar (noLoc (getRdrName tv))
                                       (toHsKind (tyVarKind tv))
535 536 537 538

toHsKind :: Kind -> LHsKind RdrName
toHsKind = toHsType

539 540 541 542 543 544
--------- 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
545
                 | otherwise           = HsWrap co_fn e
546

547
mkHsWrapCo :: TcCoercionN   -- A Nominal coercion  a ~N b
548
           -> HsExpr id -> HsExpr id
Joachim Breitner's avatar
Joachim Breitner committed
549
mkHsWrapCo co e = mkHsWrap (coToHsWrapper co) e
550

551
mkHsWrapCoR :: TcCoercionR   -- A Representational coercion  a ~R b
552 553 554
            -> HsExpr id -> HsExpr id
mkHsWrapCoR co e = mkHsWrap (coToHsWrapperR co) e

555
mkLHsWrapCo :: TcCoercion -> LHsExpr id -> LHsExpr id
Joachim Breitner's avatar
Joachim Breitner committed
556
mkLHsWrapCo co (L loc e) = L loc (mkHsWrapCo co e)
557

558 559 560 561
mkHsCmdCast :: TcCoercion -> HsCmd id -> HsCmd id
mkHsCmdCast co cmd | isTcReflCo co = cmd
                   | otherwise     = HsCmdCast co cmd

562
coToHsWrapper :: TcCoercion -> HsWrapper   -- A Nominal coercion
563
coToHsWrapper co | isTcReflCo co = idHsWrapper
Joachim Breitner's avatar
Joachim Breitner committed
564
                 | otherwise     = mkWpCast (mkTcSubCo co)
565

566 567 568 569
coToHsWrapperR :: TcCoercion -> HsWrapper   -- A Representational coercion
coToHsWrapperR co | isTcReflCo co = idHsWrapper
                  | otherwise     = mkWpCast co

570 571
mkHsWrapPat :: HsWrapper -> Pat id -> Type -> Pat id
mkHsWrapPat co_fn p ty | isIdHsWrapper co_fn = p
572
                       | otherwise           = CoPat co_fn p ty
573

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
574
-- input coercion is Nominal
575 576
mkHsWrapPatCo :: TcCoercion -> Pat id -> Type -> Pat id
mkHsWrapPatCo co pat ty | isTcReflCo co = pat
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
577
                        | otherwise     = CoPat (mkWpCast (mkTcSubCo co)) pat ty
578 579 580

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

{-
583
l
Austin Seipp's avatar
Austin Seipp committed
584 585
************************************************************************
*                                                                      *
586
                Bindings; with a location at the top
Austin Seipp's avatar
Austin Seipp committed
587 588 589
*                                                                      *
************************************************************************
-}
590

591 592
mkFunBind :: Located RdrName -> [LMatch RdrName (LHsExpr RdrName)]
          -> HsBind RdrName
593
-- Not infix, with place holders for coercion and free vars
594
mkFunBind fn ms = FunBind { fun_id = fn, fun_infix = False
595 596
                          , fun_matches = mkMatchGroup Generated ms
                          , fun_co_fn = idHsWrapper
597
                          , bind_fvs = placeHolderNames
598
                          , fun_tick = [] }
599

600 601
mkTopFunBind :: Origin -> Located Name -> [LMatch Name (LHsExpr Name)]
             -> HsBind Name
602
-- In Name-land, with empty bind_fvs
603
mkTopFunBind origin fn ms = FunBind { fun_id = fn, fun_infix = False
604
                                    , fun_matches = mkMatchGroupName origin ms
605
                                    , fun_co_fn = idHsWrapper
606 607
                                    , bind_fvs = emptyNameSet -- NB: closed
                                                              --     binding
608
                                    , fun_tick = [] }
609

610
mkHsVarBind :: SrcSpan -> RdrName -> LHsExpr RdrName -> LHsBind RdrName
611 612 613 614
mkHsVarBind loc var rhs = mk_easy_FunBind loc var [] rhs

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

617 618
mkPatSynBind :: Located RdrName -> HsPatSynDetails (Located RdrName)
             -> LPat RdrName -> HsPatSynDir RdrName -> HsBind RdrName
619 620 621 622 623 624 625
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
626

627
------------
628
mk_easy_FunBind :: SrcSpan -> RdrName -> [LPat RdrName]
629
                -> LHsExpr RdrName -> LHsBind RdrName
630
mk_easy_FunBind loc fun pats expr
631
  = L loc $ mkFunBind (L loc fun) [mkMatch pats expr emptyLocalBinds]
632

633
------------
634 635
mkMatch :: [LPat id] -> LHsExpr id -> HsLocalBinds id -> LMatch id (LHsExpr id)
mkMatch pats expr binds
Alan Zimmerman's avatar
Alan Zimmerman committed
636
  = noLoc (Match Nothing (map paren pats) Nothing
637
                 (GRHSs (unguardedRHS noSrcSpan expr) binds))
638
  where
639 640
    paren lp@(L l p) | hsPatNeedsParens p = L l (ParPat lp)
                     | otherwise          = lp
641

Austin Seipp's avatar
Austin Seipp committed
642 643 644
{-
************************************************************************
*                                                                      *
645
        Collecting binders
Austin Seipp's avatar
Austin Seipp committed
646 647
*                                                                      *
************************************************************************
648 649 650 651 652 653 654 655 656 657 658

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

659 660 661
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
662
to return a [Name] or [Id].  Before renaming the record punning
663 664
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
665
-}
666 667 668

----------------- Bindings --------------------------
collectLocalBinders :: HsLocalBindsLR idL idR -> [idL]
669 670 671 672
collectLocalBinders (HsValBinds binds) = collectHsIdBinders binds
                                         -- No pattern synonyms here
collectLocalBinders (HsIPBinds _)      = []
collectLocalBinders EmptyLocalBinds    = []
673

674 675 676 677
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
678 679

collectHsBindBinders :: HsBindLR idL idR -> [idL]
680 681
-- Collect both Ids and pattern-synonym binders
collectHsBindBinders b = collect_bind False b []
682

683
collectHsBindsBinders :: LHsBindsLR idL idR -> [idL]
684
collectHsBindsBinders binds = collect_binds False binds []
685

686
collectHsBindListBinders :: [LHsBindLR idL idR] -> [idL]
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
-- 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
711

712 713
collectMethodBinders :: LHsBindsLR RdrName idR -> [Located RdrName]
-- Used exclusively for the bindings of an instance decl which are all FunBinds
714
collectMethodBinders binds = foldrBag (get . unLoc) [] binds
715
  where
cactus's avatar
cactus committed
716
    get (FunBind { fun_id = f }) fs = f : fs
717
    get _                        fs = fs
718
       -- Someone else complains about non-FunBinds
719

720
----------------- Statements --------------------------
721
collectLStmtsBinders :: [LStmtLR idL idR body] -> [idL]
722
collectLStmtsBinders = concatMap collectLStmtBinders
723

724
collectStmtsBinders :: [StmtLR idL idR body] -> [idL]
725 726
collectStmtsBinders = concatMap collectStmtBinders

727
collectLStmtBinders :: LStmtLR idL idR body -> [idL]
728 729
collectLStmtBinders = collectStmtBinders . unLoc

730
collectStmtBinders :: StmtLR idL idR body -> [idL]
731
  -- Id Binders for a Stmt... [but what about pattern-sig type vars]?
732 733 734 735 736 737
collectStmtBinders (BindStmt pat _ _ _) = collectPatBinders pat
collectStmtBinders (LetStmt binds)      = collectLocalBinders binds
collectStmtBinders (BodyStmt {})        = []
collectStmtBinders (LastStmt {})        = []
collectStmtBinders (ParStmt xs _ _)     = collectLStmtsBinders
                                        $ [s | ParStmtBlock ss _ _ <- xs, s <- ss]
738 739
collectStmtBinders (TransStmt { trS_stmts = stmts }) = collectLStmtsBinders stmts
collectStmtBinders (RecStmt { recS_stmts = ss })     = collectLStmtsBinders ss
Simon Marlow's avatar
Simon Marlow committed
740
collectStmtBinders ApplicativeStmt{} = []
741 742


743
----------------- Patterns --------------------------
744
collectPatBinders :: LPat a -> [a]
745
collectPatBinders pat = collect_lpat pat []
746 747

collectPatsBinders :: [LPat a] -> [a]
748
collectPatsBinders pats = foldr collect_lpat [] pats
749

750 751 752
-------------
collect_lpat :: LPat name -> [name] -> [name]
collect_lpat (L _ pat) bndrs
753 754
  = go pat
  where
755 756 757 758 759
    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
760
    go (ViewPat _ pat _)          = collect_lpat pat bndrs
761 762
    go (ParPat  pat)              = collect_lpat pat bndrs

763
    go (ListPat pats _ _)         = foldr collect_lpat bndrs pats
764 765 766
    go (PArrPat pats _)           = foldr collect_lpat bndrs pats
    go (TuplePat pats _ _)        = foldr collect_lpat bndrs pats

767 768
    go (ConPatIn _ ps)            = foldr collect_lpat bndrs (hsConPatArgs ps)
    go (ConPatOut {pat_args=ps})  = foldr collect_lpat bndrs (hsConPatArgs ps)
769 770 771
        -- See Note [Dictionary binders in ConPatOut]
    go (LitPat _)                 = bndrs
    go (NPat _ _ _)               = bndrs
772
    go (NPlusKPat (L _ n) _ _ _)  = n : bndrs
773 774 775

    go (SigPatIn pat _)           = collect_lpat pat bndrs
    go (SigPatOut pat _)          = collect_lpat pat bndrs
gmainland's avatar
gmainland committed
776
    go (SplicePat _)              = bndrs
777
    go (CoPat _ pat _)            = go pat
778

Austin Seipp's avatar
Austin Seipp committed
779
{-
780
Note [Dictionary binders in ConPatOut] See also same Note in DsArrows
781 782 783 784 785 786 787 788 789
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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
790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
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
805
-}
Ross Paterson's avatar
Ross Paterson committed
806

807 808 809 810
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
811
  ++ hsTyClForeignBinders tycl_decls inst_decls foreign_decls
812

813 814
hsTyClForeignBinders :: [TyClGroup Name] -> [LInstDecl Name]
                     -> [LForeignDecl Name] -> [Name]
815
-- We need to look at instance declarations too,
816
-- because their associated types may bind data constructors
817 818 819 820 821
hsTyClForeignBinders tycl_decls inst_decls foreign_decls
  = map unLoc $
    hsForeignDeclsBinders foreign_decls ++
    concatMap (concatMap hsLTyClDeclBinders . group_tyclds) tycl_decls ++
    concatMap hsLInstDeclBinders inst_decls
822

823
-------------------
824
hsLTyClDeclBinders :: Eq name => Located (TyClDecl name) -> [Located name]
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
825
-- ^ Returns all the /binding/ names of the decl.
826 827
-- 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
828
-- occurrence.  We use the equality to filter out duplicate field names.
Simon Peyton Jones's avatar
Simon Peyton Jones committed
829
--
830 831
-- 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
832 833 834 835 836 837 838 839

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
840
    [ 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
841 842
hsLTyClDeclBinders (L loc (DataDecl    { tcdLName = L _ name, tcdDataDefn = defn }))
  = L loc name : hsDataDefnBinders defn
843 844

-------------------
845 846 847 848 849 850 851
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]

-------------------
852
hsPatSynBinders :: HsValBinds RdrName -> [Located RdrName]
853 854
-- Collect pattern-synonym binders only, not Ids
-- See Note [SrcSpan for binders]
855 856
hsPatSynBinders (ValBindsIn binds _) = foldrBag addPatSynBndr [] binds
hsPatSynBinders _ = panic "hsPatSynBinders"
857 858 859 860 861 862 863 864 865 866 867 868

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 } }))
869
  = concatMap (hsDataFamInstBinders . unLoc) dfis
870 871 872
hsLInstDeclBinders (L _ (DataFamInstD { dfid_inst = fi }))
  = hsDataFamInstBinders fi
hsLInstDeclBinders (L _ (TyFamInstD {})) = []
873 874

-------------------
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
875
-- the SrcLoc returned are for the whole declarations, not just the names
876 877 878 879
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
880 881

-------------------
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
882
-- the SrcLoc returned are for the whole declarations, not just the names
883
hsDataDefnBinders :: Eq name => HsDataDefn name -> [Located name]
884 885
hsDataDefnBinders (HsDataDefn { dd_cons = cons })
  = hsConDeclsBinders cons
886
  -- See Note [Binders in family instances]
887

888
-------------------
889
hsConDeclsBinders :: forall name. (Eq name) => [LConDecl name] -> [Located name]
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
890
  -- See hsLTyClDeclBinders for what this does
891 892
  -- The function is boringly complicated because of the records
  -- And since we only have equality, we have to be a little careful
893 894 895 896
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
897 898
          -- 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
899 900 901
          case r of
             -- remove only the first occurrence of any seen field in order to
             -- avoid circumventing detection of duplicate fields (#9156)
902 903
             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
904 905
                  where r' = remSeen (concatMap (cd_fld_names . unLoc)
                                                (unLoc flds))
906
                        remSeen' = foldr (.) remSeen [deleteBy ((==) `on` unLoc) v | v <- r']
907 908
             L loc (ConDecl { con_names = names }) ->
                (map (L loc . unLoc) names) ++ go remSeen rs
909

Austin Seipp's avatar
Austin Seipp committed
910
{-
911 912 913 914 915 916 917 918 919 920

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

921 922
Note [Binders in family instances]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
923
In a type or data family instance declaration, the type
924 925 926 927
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

928

Austin Seipp's avatar
Austin Seipp committed
929 930
************************************************************************
*                                                                      *
931
        Collecting binders the user did not write
Austin Seipp's avatar
Austin Seipp committed
932 933
*                                                                      *
************************************************************************
934 935 936 937 938 939

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
940
-}
941

942
lStmtsImplicits :: [LStmtLR Name idR (Located (body idR))] -> NameSet
943 944
lStmtsImplicits = hs_lstmts
  where
945
    hs_lstmts :: [LStmtLR Name idR (Located (body idR))] -> NameSet
946
    hs_lstmts = foldr (\stmt rest -> unionNameSet (hs_stmt (unLoc stmt)) rest) emptyNameSet
947

Simon Marlow's avatar
Simon Marlow committed
948
    hs_stmt :: StmtLR Name idR (Located (body idR)) -> NameSet
949
    hs_stmt (BindStmt pat _ _ _) = lPatImplicits pat
Simon Marlow's avatar
Simon Marlow committed
950 951 952
    hs_stmt (ApplicativeStmt args _ _) = unionNameSets (map do_arg args)
      where do_arg (_, ApplicativeArgOne pat _) = lPatImplicits pat
            do_arg (_, ApplicativeArgMany stmts _ _) = hs_lstmts stmts
953 954 955 956
    hs_stmt (LetStmt 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]
957 958
    hs_stmt (TransStmt { trS_stmts = stmts }) = hs_lstmts stmts
    hs_stmt (RecStmt { recS_stmts = ss })     = hs_lstmts ss
959

960 961 962 963 964 965
    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 _)
966
  = foldr (unionNameSet . lhsBindsImplicits . snd) emptyNameSet binds
967
hsValBindsImplicits (ValBindsIn binds _)
968 969 970
  = lhsBindsImplicits binds

lhsBindsImplicits :: LHsBindsLR Name idR -> NameSet