HsUtils.hs 41.7 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
  isInfixFunBind,
43 44

  -- Literals
45
  mkHsIntegral, mkHsFractional, mkHsIsString, mkHsString, mkHsStringPrimLit,
46 47

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

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

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

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

  -- Flags
67
  noRebindableInfo,
68 69

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

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

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

84 85
#include "HsVersions.h"

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

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

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

115 116 117 118 119
#if __GLASGOW_HASKELL__ < 709
import Data.Foldable ( foldMap )
import Data.Monoid ( mempty, mappend )
#endif

Austin Seipp's avatar
Austin Seipp committed
120 121 122
{-
************************************************************************
*                                                                      *
123
        Some useful helpers for constructing syntax
Austin Seipp's avatar
Austin Seipp committed
124 125
*                                                                      *
************************************************************************
126

127 128 129
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
130
-}
131 132 133 134

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

135
mkSimpleMatch :: [LPat id] -> Located (body id) -> LMatch id (Located (body id))
136
mkSimpleMatch pats rhs
137
  = L loc $
138
    Match NonFunBindMatch pats Nothing (unguardedGRHSs rhs)
139 140
  where
    loc = case pats of
141 142
                []      -> getLoc rhs
                (pat:_) -> combineSrcSpans (getLoc pat) (getLoc rhs)
143

144
unguardedGRHSs :: Located (body id) -> GRHSs id (Located (body id))
145 146
unguardedGRHSs rhs@(L loc _)
  = GRHSs (unguardedRHS loc rhs) (noLoc emptyLocalBinds)
147

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

151 152
mkMatchGroup :: Origin -> [LMatch RdrName (Located (body RdrName))]
             -> MatchGroup RdrName (Located (body RdrName))
153 154
mkMatchGroup origin matches = MG { mg_alts = mkLocatedList matches
                                 , mg_arg_tys = []
155 156 157
                                 , mg_res_ty = placeHolderType
                                 , mg_origin = origin }

158 159 160 161
mkLocatedList ::  [Located a] -> Located [Located a]
mkLocatedList [] = noLoc []
mkLocatedList ms = L (combineLocs (head ms) (last ms)) ms

162 163
mkMatchGroupName :: Origin -> [LMatch Name (Located (body Name))]
             -> MatchGroup Name (Located (body Name))
164 165
mkMatchGroupName origin matches = MG { mg_alts = mkLocatedList matches
                                     , mg_arg_tys = []
166 167
                                     , mg_res_ty = placeHolderType
                                     , mg_origin = origin }
168

169 170 171 172 173 174
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)

175
mkHsLam :: [LPat RdrName] -> LHsExpr RdrName -> LHsExpr RdrName
176
mkHsLam pats body = mkHsPar (L (getLoc body) (HsLam matches))
177
        where
178
          matches = mkMatchGroup Generated [mkSimpleMatch pats body]
179 180

mkHsLams :: [TyVar] -> [EvVar] -> LHsExpr Id -> LHsExpr Id
181 182
mkHsLams tyvars dicts expr = mkLHsWrap (mkWpTyLams tyvars
                                       <.> mkWpLams dicts) expr
183 184

mkHsConApp :: DataCon -> [Type] -> [HsExpr Id] -> LHsExpr Id
185 186
-- Used for constructing dictionary terms etc, so no locations
mkHsConApp data_con tys args
187 188 189 190
  = foldl mk_app (nlHsTyApp (dataConWrapId data_con) tys) args
  where
    mk_app f a = noLoc (HsApp f (noLoc a))

191
mkSimpleHsAlt :: LPat id -> (Located (body id)) -> LMatch id (Located (body id))
192
-- A simple lambda with a single pattern, no binds, no guards; pre-typechecking
193
mkSimpleHsAlt pat expr
194 195
  = mkSimpleMatch [pat] expr

196
nlHsTyApp :: name -> [Type] -> LHsExpr name
197
nlHsTyApp fun_id tys = noLoc (HsWrap (mkWpTyApps tys) (HsVar fun_id))
198

199 200 201
nlHsTyApps :: name -> [Type] -> [LHsExpr name] -> LHsExpr name
nlHsTyApps fun_id tys xs = foldl nlHsApp (nlHsTyApp fun_id tys) xs

202 203 204 205 206 207 208 209 210 211 212
--------- 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

213

214
-------------------------------
215 216 217
-- These are the bits of syntax that contain rebindable names
-- See RnEnv.lookupSyntaxName

218
mkHsIntegral   :: String -> Integer -> PostTc RdrName Type -> HsOverLit RdrName
219
mkHsFractional :: FractionalLit -> PostTc RdrName Type -> HsOverLit RdrName
220
mkHsIsString :: String -> FastString -> PostTc RdrName Type -> HsOverLit RdrName
221 222 223
mkHsDo         :: HsStmtContext Name -> [ExprLStmt RdrName] -> HsExpr RdrName
mkHsComp       :: HsStmtContext Name -> [ExprLStmt RdrName] -> LHsExpr RdrName
               -> HsExpr RdrName
twanvl's avatar
twanvl committed
224

Alan Zimmerman's avatar
Alan Zimmerman committed
225 226
mkNPat      :: Located (HsOverLit id) -> Maybe (SyntaxExpr id) -> Pat id
mkNPlusKPat :: Located id -> Located (HsOverLit id) -> Pat id
twanvl's avatar
twanvl committed
227

228
mkLastStmt :: Located (bodyR idR) -> StmtLR idL idR (Located (bodyR idR))
229 230
mkBodyStmt :: Located (bodyR RdrName)
           -> StmtLR idL RdrName (Located (bodyR RdrName))
231
mkBindStmt :: LPat idL -> Located (bodyR idR) -> StmtLR idL idR (Located (bodyR idR))
232

233 234 235 236
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
237 238


239 240 241
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
242

243 244
noRebindableInfo :: PlaceHolder
noRebindableInfo = PlaceHolder -- Just another placeholder;
245

246
mkHsDo ctxt stmts = HsDo ctxt (mkLocatedList stmts) placeHolderType
247 248 249
mkHsComp ctxt stmts expr = mkHsDo ctxt (stmts ++ [last_stmt])
  where
    last_stmt = L (getLoc expr) $ mkLastStmt expr
250

251 252 253
mkHsIf :: LHsExpr id -> LHsExpr id -> LHsExpr id -> HsExpr id
mkHsIf c a b = HsIf (Just noSyntaxExpr) c a b

254
mkNPat lit neg     = NPat lit neg noSyntaxExpr
255
mkNPlusKPat id lit = NPlusKPat id lit noSyntaxExpr noSyntaxExpr
256

257 258 259 260 261 262 263 264
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)
265

266
emptyTransStmt :: StmtLR idL idR (LHsExpr idR)
267
emptyTransStmt = TransStmt { trS_form = panic "emptyTransStmt: form"
268
                           , trS_stmts = [], trS_bndrs = []
269 270 271
                           , trS_by = Nothing, trS_using = noLoc noSyntaxExpr
                           , trS_ret = noSyntaxExpr, trS_bind = noSyntaxExpr
                           , trS_fmap = noSyntaxExpr }
272 273 274 275
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 }
276

Simon Marlow's avatar
Simon Marlow committed
277
mkLastStmt body     = LastStmt body False noSyntaxExpr
278 279
mkBodyStmt body     = BodyStmt body noSyntaxExpr noSyntaxExpr placeHolderType
mkBindStmt pat body = BindStmt pat body noSyntaxExpr noSyntaxExpr
280 281


282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
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 }
297 298

-------------------------------
299 300
--- 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
301
mkHsOpApp :: LHsExpr id -> id -> LHsExpr id -> HsExpr id
302 303
mkHsOpApp e1 op e2 = OpApp e1 (noLoc (HsVar op)) (error "mkOpApp:fixity") e2

304 305 306
unqualSplice :: RdrName
unqualSplice = mkRdrUnqual (mkVarOccFS (fsLit "splice"))

307 308 309
mkUntypedSplice :: LHsExpr RdrName -> HsSplice RdrName
mkUntypedSplice e = HsUntypedSplice unqualSplice e

310
mkHsSpliceE :: LHsExpr RdrName -> HsExpr RdrName
311
mkHsSpliceE e = HsSpliceE (mkUntypedSplice e)
312 313

mkHsSpliceTE :: LHsExpr RdrName -> HsExpr RdrName
314
mkHsSpliceTE e = HsSpliceE (HsTypedSplice unqualSplice e)
315

316
mkHsSpliceTy :: LHsExpr RdrName -> HsType RdrName
317
mkHsSpliceTy e = HsSpliceTy (HsUntypedSplice unqualSplice e) placeHolderKind
318

319 320
mkHsQuasiQuote :: RdrName -> SrcSpan -> FastString -> HsSplice RdrName
mkHsQuasiQuote quoter span quote = HsQuasiQuote unqualSplice quoter span quote
321

twanvl's avatar
twanvl committed
322
unqualQuasiQuote :: RdrName
Ian Lynagh's avatar
Ian Lynagh committed
323
unqualQuasiQuote = mkRdrUnqual (mkVarOccFS (fsLit "quasiquote"))
324 325
                -- A name (uniquified later) to
                -- identify the quasi-quote
326

twanvl's avatar
twanvl committed
327
mkHsString :: String -> HsLit
328
mkHsString s = HsString s (mkFastString s)
329

330 331 332 333
mkHsStringPrimLit :: FastString -> HsLit
mkHsStringPrimLit fs
  = HsStringPrim (unpackFS fs) (fastStringToByteString fs)

334
-------------
335
userHsTyVarBndrs :: SrcSpan -> [name] -> [Located (HsTyVarBndr name)]
336
-- Caller sets location
337
userHsTyVarBndrs loc bndrs = [ L loc (UserTyVar v) | v <- bndrs ]
338

Austin Seipp's avatar
Austin Seipp committed
339 340 341
{-
************************************************************************
*                                                                      *
342
        Constructing syntax with no location info
Austin Seipp's avatar
Austin Seipp committed
343 344 345
*                                                                      *
************************************************************************
-}
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361

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
362
nlHsIntLit :: Integer -> LHsExpr id
363
nlHsIntLit n = noLoc (HsLit (HsInt (show n) n))
364 365 366

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

368 369
nlHsVarApps :: id -> [id] -> LHsExpr id
nlHsVarApps f xs = noLoc (foldl mk (HsVar f) (map HsVar xs))
370 371
                 where
                   mk f a = HsApp (noLoc f) (noLoc a)
372

373
nlConVarPat :: RdrName -> [RdrName] -> LPat RdrName
374 375
nlConVarPat con vars = nlConPat con (map nlVarPat vars)

376 377 378
nlConVarPatName :: Name -> [Name] -> LPat Name
nlConVarPatName con vars = nlConPatName con (map nlVarPat vars)

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

382
nlConPat :: RdrName -> [LPat RdrName] -> LPat RdrName
383 384
nlConPat con pats = noLoc (ConPatIn (noLoc con) (PrefixCon pats))

385 386 387
nlConPatName :: Name -> [LPat Name] -> LPat Name
nlConPatName con pats = noLoc (ConPatIn (noLoc con) (PrefixCon pats))

388 389 390 391 392
nlNullaryConPat :: id -> LPat id
nlNullaryConPat con = noLoc (ConPatIn (noLoc con) (PrefixCon []))

nlWildConPat :: DataCon -> LPat RdrName
nlWildConPat con = noLoc (ConPatIn (noLoc (getRdrName con))
393 394
                         (PrefixCon (nOfThem (dataConSourceArity con)
                                             nlWildPat)))
395

396 397
nlWildPat :: LPat RdrName
nlWildPat  = noLoc (WildPat placeHolderType )  -- Pre-typechecking
398

399 400 401 402 403 404 405 406
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
407
nlHsDo ctxt stmts = noLoc (mkHsDo ctxt stmts)
408

twanvl's avatar
twanvl committed
409
nlHsOpApp :: LHsExpr id -> id -> LHsExpr id -> LHsExpr id
410 411
nlHsOpApp e1 op e2 = noLoc (mkHsOpApp e1 op e2)

412
nlHsLam  :: LMatch RdrName (LHsExpr RdrName) -> LHsExpr RdrName
twanvl's avatar
twanvl committed
413 414
nlHsPar  :: LHsExpr id -> LHsExpr id
nlHsIf   :: LHsExpr id -> LHsExpr id -> LHsExpr id -> LHsExpr id
415 416 417
nlHsCase :: LHsExpr RdrName -> [LMatch RdrName (LHsExpr RdrName)]
         -> LHsExpr RdrName
nlList   :: [LHsExpr RdrName] -> LHsExpr RdrName
twanvl's avatar
twanvl committed
418

419
nlHsLam match          = noLoc (HsLam (mkMatchGroup Generated [match]))
420 421 422 423
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)
424

twanvl's avatar
twanvl committed
425 426 427 428
nlHsAppTy :: LHsType name -> LHsType name -> LHsType name
nlHsTyVar :: name                         -> LHsType name
nlHsFunTy :: LHsType name -> LHsType name -> LHsType name

429 430 431
nlHsAppTy f t           = noLoc (HsAppTy f t)
nlHsTyVar x             = noLoc (HsTyVar x)
nlHsFunTy a b           = noLoc (HsFunTy a b)
432

twanvl's avatar
twanvl committed
433
nlHsTyConApp :: name -> [LHsType name] -> LHsType name
434
nlHsTyConApp tycon tys  = foldl nlHsAppTy (nlHsTyVar tycon) tys
435

Austin Seipp's avatar
Austin Seipp committed
436
{-
437 438
Tuples.  All these functions are *pre-typechecker* because they lack
types on the tuple.
Austin Seipp's avatar
Austin Seipp committed
439
-}
440 441 442 443

mkLHsTupleExpr :: [LHsExpr a] -> LHsExpr a
-- Makes a pre-typechecker boxed tuple, deals with 1 case
mkLHsTupleExpr [e] = e
444
mkLHsTupleExpr es  = noLoc $ ExplicitTuple (map (noLoc . Present) es) Boxed
445 446 447

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

449
nlTuplePat :: [LPat id] -> Boxity -> LPat id
450
nlTuplePat pats box = noLoc (TuplePat pats box [])
451

452
missingTupArg :: HsTupArg RdrName
453
missingTupArg = Missing placeHolderType
454

Simon Marlow's avatar
Simon Marlow committed
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 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
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
515 516 517
{-
************************************************************************
*                                                                      *
518
        Converting a Type to an HsType RdrName
Austin Seipp's avatar
Austin Seipp committed
519 520
*                                                                      *
************************************************************************
521 522

This is needed to implement GeneralizedNewtypeDeriving.
Austin Seipp's avatar
Austin Seipp committed
523
-}
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541

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)
542
    to_hs_type (TyConApp tc args) = nlHsTyConApp (getRdrName tc) (map toHsType args')
543
       where
Simon Peyton Jones's avatar
Simon Peyton Jones committed
544 545 546
         args' = filterOut isKind args
         -- Source-language types have _implicit_ kind arguments,
         -- so we must remove them here (Trac #8563)
547 548 549
    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
550 551
    to_hs_type (LitTy (NumTyLit n)) = noLoc $ HsTyLit (HsNumTy "" n)
    to_hs_type (LitTy (StrTyLit s)) = noLoc $ HsTyLit (HsStrTy "" s)
552

Alan Zimmerman's avatar
Alan Zimmerman committed
553 554
    mk_hs_tvb tv = noLoc $ KindedTyVar (noLoc (getRdrName tv))
                                       (toHsKind (tyVarKind tv))
555 556 557 558

toHsKind :: Kind -> LHsKind RdrName
toHsKind = toHsType

559 560 561 562 563 564
--------- 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
565
                 | otherwise           = HsWrap co_fn e
566

567
mkHsWrapCo :: TcCoercionN   -- A Nominal coercion  a ~N b
568
           -> HsExpr id -> HsExpr id
Joachim Breitner's avatar
Joachim Breitner committed
569
mkHsWrapCo co e = mkHsWrap (coToHsWrapper co) e
570

571
mkHsWrapCoR :: TcCoercionR   -- A Representational coercion  a ~R b
572 573 574
            -> HsExpr id -> HsExpr id
mkHsWrapCoR co e = mkHsWrap (coToHsWrapperR co) e

575
mkLHsWrapCo :: TcCoercion -> LHsExpr id -> LHsExpr id
Joachim Breitner's avatar
Joachim Breitner committed
576
mkLHsWrapCo co (L loc e) = L loc (mkHsWrapCo co e)
577

578 579 580 581
mkHsCmdCast :: TcCoercion -> HsCmd id -> HsCmd id
mkHsCmdCast co cmd | isTcReflCo co = cmd
                   | otherwise     = HsCmdCast co cmd

582
coToHsWrapper :: TcCoercion -> HsWrapper   -- A Nominal coercion
583
coToHsWrapper co | isTcReflCo co = idHsWrapper
Joachim Breitner's avatar
Joachim Breitner committed
584
                 | otherwise     = mkWpCast (mkTcSubCo co)
585

586 587 588 589
coToHsWrapperR :: TcCoercion -> HsWrapper   -- A Representational coercion
coToHsWrapperR co | isTcReflCo co = idHsWrapper
                  | otherwise     = mkWpCast co

590 591
mkHsWrapPat :: HsWrapper -> Pat id -> Type -> Pat id
mkHsWrapPat co_fn p ty | isIdHsWrapper co_fn = p
592
                       | otherwise           = CoPat co_fn p ty
593

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
594
-- input coercion is Nominal
595 596
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
597
                        | otherwise     = CoPat (mkWpCast (mkTcSubCo co)) pat ty
598 599 600

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

{-
603
l
Austin Seipp's avatar
Austin Seipp committed
604 605
************************************************************************
*                                                                      *
606
                Bindings; with a location at the top
Austin Seipp's avatar
Austin Seipp committed
607 608 609
*                                                                      *
************************************************************************
-}
610

611 612
mkFunBind :: Located RdrName -> [LMatch RdrName (LHsExpr RdrName)]
          -> HsBind RdrName
613
-- Not infix, with place holders for coercion and free vars
614
mkFunBind fn ms = FunBind { fun_id = fn
615 616
                          , fun_matches = mkMatchGroup Generated ms
                          , fun_co_fn = idHsWrapper
617
                          , bind_fvs = placeHolderNames
618
                          , fun_tick = [] }
619

620 621
mkTopFunBind :: Origin -> Located Name -> [LMatch Name (LHsExpr Name)]
             -> HsBind Name
622
-- In Name-land, with empty bind_fvs
623
mkTopFunBind origin fn ms = FunBind { fun_id = fn
624
                                    , fun_matches = mkMatchGroupName origin ms
625
                                    , fun_co_fn = idHsWrapper
626 627
                                    , bind_fvs = emptyNameSet -- NB: closed
                                                              --     binding
628
                                    , fun_tick = [] }
629

630
mkHsVarBind :: SrcSpan -> RdrName -> LHsExpr RdrName -> LHsBind RdrName
631 632 633 634
mkHsVarBind loc var rhs = mk_easy_FunBind loc var [] rhs

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

637 638
mkPatSynBind :: Located RdrName -> HsPatSynDetails (Located RdrName)
             -> LPat RdrName -> HsPatSynDir RdrName -> HsBind RdrName
639 640 641 642 643 644 645
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
646

647 648 649 650
-- |If any of the matches in the 'FunBind' are infix, the 'FunBind' is
-- considered infix.
isInfixFunBind :: HsBindLR id1 id2 -> Bool
isInfixFunBind (FunBind _ (MG matches _ _ _) _ _ _)
651
  = any (isInfixMatch . unLoc) (unLoc matches)
652 653 654
isInfixFunBind _ = False


655
------------
656
mk_easy_FunBind :: SrcSpan -> RdrName -> [LPat RdrName]
657
                -> LHsExpr RdrName -> LHsBind RdrName
658
mk_easy_FunBind loc fun pats expr
659
  = L loc $ mkFunBind (L loc fun) [mkMatch pats expr (noLoc emptyLocalBinds)]
660

661
------------
662 663 664
mkMatch :: [LPat id] -> LHsExpr id -> Located (HsLocalBinds id)
        -> LMatch id (LHsExpr id)
mkMatch pats expr lbinds
665
  = noLoc (Match NonFunBindMatch (map paren pats) Nothing
666
                 (GRHSs (unguardedRHS noSrcSpan expr) lbinds))
667
  where
668 669
    paren lp@(L l p) | hsPatNeedsParens p = L l (ParPat lp)
                     | otherwise          = lp
670

Austin Seipp's avatar
Austin Seipp committed
671 672 673
{-
************************************************************************
*                                                                      *
674
        Collecting binders
Austin Seipp's avatar
Austin Seipp committed
675 676
*                                                                      *
************************************************************************
677 678 679 680 681 682 683 684 685 686 687

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

688 689 690
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
691
to return a [Name] or [Id].  Before renaming the record punning
692 693
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
694
-}
695 696 697

----------------- Bindings --------------------------
collectLocalBinders :: HsLocalBindsLR idL idR -> [idL]
698 699 700 701
collectLocalBinders (HsValBinds binds) = collectHsIdBinders binds
                                         -- No pattern synonyms here
collectLocalBinders (HsIPBinds _)      = []
collectLocalBinders EmptyLocalBinds    = []
702

703 704 705 706
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
707 708

collectHsBindBinders :: HsBindLR idL idR -> [idL]
709 710
-- Collect both Ids and pattern-synonym binders
collectHsBindBinders b = collect_bind False b []
711

712
collectHsBindsBinders :: LHsBindsLR idL idR -> [idL]
713
collectHsBindsBinders binds = collect_binds False binds []
714

715
collectHsBindListBinders :: [LHsBindLR idL idR] -> [idL]
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
-- 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
740

741 742
collectMethodBinders :: LHsBindsLR RdrName idR -> [Located RdrName]
-- Used exclusively for the bindings of an instance decl which are all FunBinds
743
collectMethodBinders binds = foldrBag (get . unLoc) [] binds
744
  where
cactus's avatar
cactus committed
745
    get (FunBind { fun_id = f }) fs = f : fs
746
    get _                        fs = fs
747
       -- Someone else complains about non-FunBinds
748

749
----------------- Statements --------------------------
750
collectLStmtsBinders :: [LStmtLR idL idR body] -> [idL]
751
collectLStmtsBinders = concatMap collectLStmtBinders
752

753
collectStmtsBinders :: [StmtLR idL idR body] -> [idL]
754 755
collectStmtsBinders = concatMap collectStmtBinders

756
collectLStmtBinders :: LStmtLR idL idR body -> [idL]
757 758
collectLStmtBinders = collectStmtBinders . unLoc

759
collectStmtBinders :: StmtLR idL idR body -> [idL]
760
  -- Id Binders for a Stmt... [but what about pattern-sig type vars]?
761 762 763 764 765 766
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]
767 768
collectStmtBinders (TransStmt { trS_stmts = stmts }) = collectLStmtsBinders stmts
collectStmtBinders (RecStmt { recS_stmts = ss })     = collectLStmtsBinders ss
Simon Marlow's avatar
Simon Marlow committed
769
collectStmtBinders ApplicativeStmt{} = []
770 771


772
----------------- Patterns --------------------------
773
collectPatBinders :: LPat a -> [a]
774
collectPatBinders pat = collect_lpat pat []
775 776

collectPatsBinders :: [LPat a] -> [a]
777
collectPatsBinders pats = foldr collect_lpat [] pats
778

779 780 781
-------------
collect_lpat :: LPat name -> [name] -> [name]
collect_lpat (L _ pat) bndrs
782 783
  = go pat
  where
784 785 786 787 788
    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
789
    go (ViewPat _ pat _)          = collect_lpat pat bndrs
790 791
    go (ParPat  pat)              = collect_lpat pat bndrs

792
    go (ListPat pats _ _)         = foldr collect_lpat bndrs pats
793 794 795
    go (PArrPat pats _)           = foldr collect_lpat bndrs pats
    go (TuplePat pats _ _)        = foldr collect_lpat bndrs pats

796 797
    go (ConPatIn _ ps)            = foldr collect_lpat bndrs (hsConPatArgs ps)
    go (ConPatOut {pat_args=ps})  = foldr collect_lpat bndrs (hsConPatArgs ps)
798 799 800
        -- See Note [Dictionary binders in ConPatOut]
    go (LitPat _)                 = bndrs
    go (NPat _ _ _)               = bndrs
801
    go (NPlusKPat (L _ n) _ _ _)  = n : bndrs
802 803 804

    go (SigPatIn pat _)           = collect_lpat pat bndrs
    go (SigPatOut pat _)          = collect_lpat pat bndrs
gmainland's avatar
gmainland committed
805
    go (SplicePat _)              = bndrs
806
    go (CoPat _ pat _)            = go pat
807

Austin Seipp's avatar
Austin Seipp committed
808
{-
809
Note [Dictionary binders in ConPatOut] See also same Note in DsArrows
810 811 812 813 814 815 816 817 818
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
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
834
-}
Ross Paterson's avatar
Ross Paterson committed
835

836 837 838 839
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
840
  ++ hsTyClForeignBinders tycl_decls inst_decls foreign_decls
841

842 843
hsTyClForeignBinders :: [TyClGroup Name] -> [LInstDecl Name]
                     -> [LForeignDecl Name] -> [Name]
844
-- We need to look at instance declarations too,
845
-- because their associated types may bind data constructors
846
hsTyClForeignBinders tycl_decls inst_decls foreign_decls
847 848 849 850 851 852
  = map unLoc (hsForeignDeclsBinders foreign_decls)
    ++ getSelectorNames (foldMap (foldMap hsLTyClDeclBinders . group_tyclds) tycl_decls
                        `mappend` foldMap hsLInstDeclBinders inst_decls)
  where
    getSelectorNames :: ([Located Name], [LFieldOcc Name]) -> [Name]
    getSelectorNames (ns, fs) = map unLoc ns ++ map (selectorFieldOcc.unLoc) fs
853

854
-------------------
855 856 857 858 859 860
hsLTyClDeclBinders :: Located (TyClDecl name) -> ([Located name], [LFieldOcc name])
-- ^ Returns all the /binding/ names of the decl.  The first one is
-- guaranteed to be the name of the decl. The first component
-- represents all binding names except record fields; the second
-- represents field occurrences. For record fields mentioned in
-- multiple constructors, the SrcLoc will be from the first occurrence.
Simon Peyton Jones's avatar
Simon Peyton Jones committed
861
--
862 863
-- 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
864 865

hsLTyClDeclBinders (L loc (FamDecl { tcdFam = FamilyDecl { fdLName = L _ name } }))
866 867
  = ([L loc name], [])
hsLTyClDeclBinders (L loc (SynDecl     { tcdLName = L _ name })) = ([L loc name], [])
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
868 869
hsLTyClDeclBinders (L loc (ClassDecl   { tcdLName = L _ cls_name
                                       , tcdSigs = sigs, tcdATs = ats }))
870 871 872 873
  = (L loc cls_name :
       [ L fam_loc fam_name | L fam_loc (FamilyDecl { fdLName = L _ fam_name }) <- ats ] ++
       [ 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
874
hsLTyClDeclBinders (L loc (DataDecl    { tcdLName = L _ name, tcdDataDefn = defn }))
875
  = (\ (xs, ys) -> (L loc name : xs, ys)) $ hsDataDefnBinders defn
876 877

-------------------
878 879 880 881 882 883
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]

Matthew Pickering's avatar
Matthew Pickering committed
884 885


886
-------------------
Matthew Pickering's avatar
Matthew Pickering committed
887 888
hsPatSynBinders :: HsValBinds RdrName
                -> ([Located RdrName], [Located RdrName])
889 890
-- Collect pattern-synonym binders only, not Ids
-- See Note [SrcSpan for binders]
Matthew Pickering's avatar
Matthew Pickering committed
891
hsPatSynBinders (ValBindsIn binds _) = foldrBag addPatSynBndr ([],[]) binds
892
hsPatSynBinders _ = panic "hsPatSynBinders"
893

Matthew Pickering's avatar
Matthew Pickering committed
894 895
addPatSynBndr :: LHsBindLR id id -> ([Located id], [Located id])
                -> ([Located id], [Located id]) -- (selectors, other)
896
-- See Note [SrcSpan for binders]
Matthew Pickering's avatar
Matthew Pickering committed
897 898 899 900 901 902
addPatSynBndr bind (sels, pss)
  | L bind_loc (PatSynBind (PSB { psb_id = L _ n
                                , psb_args = RecordPatSyn as })) <- bind
  = (map recordPatSynSelectorId as ++ sels, L bind_loc n : pss)
  | L bind_loc (PatSynBind (PSB { psb_id = L _ n})) <- bind
  = (sels, L bind_loc n : pss)
903
  | otherwise
Matthew Pickering's avatar
Matthew Pickering committed
904
  = (sels, pss)
905 906

-------------------
907
hsLInstDeclBinders :: LInstDecl name -> ([Located name], [LFieldOcc name])
908
hsLInstDeclBinders (L _ (ClsInstD { cid_inst = ClsInstDecl { cid_datafam_insts = dfis } }))
909
  = foldMap (hsDataFamInstBinders . unLoc) dfis
910 911
hsLInstDeclBinders (L _ (DataFamInstD { dfid_inst = fi }))
  = hsDataFamInstBinders fi
912
hsLInstDeclBinders (L _ (TyFamInstD {})) = mempty
913 914

-------------------
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
915
-- the SrcLoc returned are for the whole declarations, not just the names
916
hsDataFamInstBinders :: DataFamInstDecl name -> ([Located name], [LFieldOcc name])
917 918 919
hsDataFamInstBinders (DataFamInstDecl { dfid_defn = defn })
  = hsDataDefnBinders defn
  -- There can't be repeated symbols because only data instances have binders
920 921

-------------------
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
922
-- the SrcLoc returned are for the whole declarations, not just the names
923
hsDataDefnBinders :: HsDataDefn name -> ([Located name], [LFieldOcc name])
924 925
hsDataDefnBinders (HsDataDefn { dd_cons = cons })
  = hsConDeclsBinders cons
926
  -- See Note [Binders in family instances]
927

928
-------------------
929
hsConDeclsBinders :: [LConDecl name] -> ([Located name], [LFieldOcc name])
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
930
  -- See hsLTyClDeclBinders for what this does
931 932
  -- The function is boringly complicated because of the records
  -- And since we only have equality, we have to be a little careful
933
hsConDeclsBinders cons = go id cons
934 935 936
  where go :: ([LFieldOcc name] -> [LFieldOcc name])
           -> [LConDecl name] -> ([Located name], [LFieldOcc name])
        go _ [] = ([], [])
937
        go remSeen (r:rs) =
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
938 939
          -- 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
940 941 942
          case r of
             -- remove only the first occurrence of any seen field in order to
             -- avoid circumventing detection of duplicate fields (#9156)
943
             L loc (ConDecl { con_names = names, con_details = RecCon flds }) ->
944
               (map (L loc . unLoc) names ++ ns, r' ++ fs)
Alan Zimmerman's avatar
Alan Zimmerman committed
945 946
                  where r' = remSeen (concatMap (cd_fld_names . unLoc)
                                                (unLoc flds))
947 948
                        remSeen' = foldr (.) remSeen [deleteBy ((==) `on` rdrNameFieldOcc . unLoc) v | v <- r']
                        (ns, fs) = go remSeen' rs
949
             L loc (ConDecl { con_names = names }) ->
950 951
                (map (L loc . unLoc) names ++ ns, fs)
                  where (ns, fs) = go remSeen rs
952

Austin Seipp's avatar
Austin Seipp committed
953
{-