HsUtils.hs 41.4 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
unguardedGRHSs rhs@(L loc _) = GRHSs (unguardedRHS loc rhs) emptyLocalBinds
146

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

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

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

162 163 164 165 166 167
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)

168
mkHsLam :: [LPat RdrName] -> LHsExpr RdrName -> LHsExpr RdrName
169
mkHsLam pats body = mkHsPar (L (getLoc body) (HsLam matches))
170
        where
171
          matches = mkMatchGroup Generated [mkSimpleMatch pats body]
172 173

mkHsLams :: [TyVar] -> [EvVar] -> LHsExpr Id -> LHsExpr Id
174 175
mkHsLams tyvars dicts expr = mkLHsWrap (mkWpTyLams tyvars
                                       <.> mkWpLams dicts) expr
176 177

mkHsConApp :: DataCon -> [Type] -> [HsExpr Id] -> LHsExpr Id
178 179
-- Used for constructing dictionary terms etc, so no locations
mkHsConApp data_con tys args
180 181 182 183
  = foldl mk_app (nlHsTyApp (dataConWrapId data_con) tys) args
  where
    mk_app f a = noLoc (HsApp f (noLoc a))

184
mkSimpleHsAlt :: LPat id -> (Located (body id)) -> LMatch id (Located (body id))
185
-- A simple lambda with a single pattern, no binds, no guards; pre-typechecking
186
mkSimpleHsAlt pat expr
187 188
  = mkSimpleMatch [pat] expr

189
nlHsTyApp :: name -> [Type] -> LHsExpr name
190
nlHsTyApp fun_id tys = noLoc (HsWrap (mkWpTyApps tys) (HsVar fun_id))
191

192 193 194
nlHsTyApps :: name -> [Type] -> [LHsExpr name] -> LHsExpr name
nlHsTyApps fun_id tys xs = foldl nlHsApp (nlHsTyApp fun_id tys) xs

195 196 197 198 199 200 201 202 203 204 205
--------- 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

206

207
-------------------------------
208 209 210
-- These are the bits of syntax that contain rebindable names
-- See RnEnv.lookupSyntaxName

211
mkHsIntegral   :: String -> Integer -> PostTc RdrName Type -> HsOverLit RdrName
212
mkHsFractional :: FractionalLit -> PostTc RdrName Type -> HsOverLit RdrName
213
mkHsIsString :: String -> FastString -> PostTc RdrName Type -> HsOverLit RdrName
214 215 216
mkHsDo         :: HsStmtContext Name -> [ExprLStmt RdrName] -> HsExpr RdrName
mkHsComp       :: HsStmtContext Name -> [ExprLStmt RdrName] -> LHsExpr RdrName
               -> HsExpr RdrName
twanvl's avatar
twanvl committed
217

Alan Zimmerman's avatar
Alan Zimmerman committed
218 219
mkNPat      :: Located (HsOverLit id) -> Maybe (SyntaxExpr id) -> Pat id
mkNPlusKPat :: Located id -> Located (HsOverLit id) -> Pat id
twanvl's avatar
twanvl committed
220

221
mkLastStmt :: Located (bodyR idR) -> StmtLR idL idR (Located (bodyR idR))
222 223
mkBodyStmt :: Located (bodyR RdrName)
           -> StmtLR idL RdrName (Located (bodyR RdrName))
224
mkBindStmt :: LPat idL -> Located (bodyR idR) -> StmtLR idL idR (Located (bodyR idR))
225

226 227 228 229
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
230 231


232 233 234
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
235

236 237
noRebindableInfo :: PlaceHolder
noRebindableInfo = PlaceHolder -- Just another placeholder;
238

239
mkHsDo ctxt stmts = HsDo ctxt stmts placeHolderType
240 241 242
mkHsComp ctxt stmts expr = mkHsDo ctxt (stmts ++ [last_stmt])
  where
    last_stmt = L (getLoc expr) $ mkLastStmt expr
243

244 245 246
mkHsIf :: LHsExpr id -> LHsExpr id -> LHsExpr id -> HsExpr id
mkHsIf c a b = HsIf (Just noSyntaxExpr) c a b

247
mkNPat lit neg     = NPat lit neg noSyntaxExpr
248
mkNPlusKPat id lit = NPlusKPat id lit noSyntaxExpr noSyntaxExpr
249

250 251 252 253 254 255 256 257
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)
258

259
emptyTransStmt :: StmtLR idL idR (LHsExpr idR)
260
emptyTransStmt = TransStmt { trS_form = panic "emptyTransStmt: form"
261
                           , trS_stmts = [], trS_bndrs = []
262 263 264
                           , trS_by = Nothing, trS_using = noLoc noSyntaxExpr
                           , trS_ret = noSyntaxExpr, trS_bind = noSyntaxExpr
                           , trS_fmap = noSyntaxExpr }
265 266 267 268
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 }
269

Simon Marlow's avatar
Simon Marlow committed
270
mkLastStmt body     = LastStmt body False noSyntaxExpr
271 272
mkBodyStmt body     = BodyStmt body noSyntaxExpr noSyntaxExpr placeHolderType
mkBindStmt pat body = BindStmt pat body noSyntaxExpr noSyntaxExpr
273 274


275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
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 }
290 291

-------------------------------
292 293
--- 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
294
mkHsOpApp :: LHsExpr id -> id -> LHsExpr id -> HsExpr id
295 296
mkHsOpApp e1 op e2 = OpApp e1 (noLoc (HsVar op)) (error "mkOpApp:fixity") e2

297 298 299
unqualSplice :: RdrName
unqualSplice = mkRdrUnqual (mkVarOccFS (fsLit "splice"))

300 301 302
mkUntypedSplice :: LHsExpr RdrName -> HsSplice RdrName
mkUntypedSplice e = HsUntypedSplice unqualSplice e

303
mkHsSpliceE :: LHsExpr RdrName -> HsExpr RdrName
304
mkHsSpliceE e = HsSpliceE (mkUntypedSplice e)
305 306

mkHsSpliceTE :: LHsExpr RdrName -> HsExpr RdrName
307
mkHsSpliceTE e = HsSpliceE (HsTypedSplice unqualSplice e)
308

309
mkHsSpliceTy :: LHsExpr RdrName -> HsType RdrName
310
mkHsSpliceTy e = HsSpliceTy (HsUntypedSplice unqualSplice e) placeHolderKind
311

312 313
mkHsQuasiQuote :: RdrName -> SrcSpan -> FastString -> HsSplice RdrName
mkHsQuasiQuote quoter span quote = HsQuasiQuote unqualSplice quoter span quote
314

twanvl's avatar
twanvl committed
315
unqualQuasiQuote :: RdrName
Ian Lynagh's avatar
Ian Lynagh committed
316
unqualQuasiQuote = mkRdrUnqual (mkVarOccFS (fsLit "quasiquote"))
317 318
                -- A name (uniquified later) to
                -- identify the quasi-quote
319

twanvl's avatar
twanvl committed
320
mkHsString :: String -> HsLit
321
mkHsString s = HsString s (mkFastString s)
322

323 324 325 326
mkHsStringPrimLit :: FastString -> HsLit
mkHsStringPrimLit fs
  = HsStringPrim (unpackFS fs) (fastStringToByteString fs)

327
-------------
328
userHsTyVarBndrs :: SrcSpan -> [name] -> [Located (HsTyVarBndr name)]
329
-- Caller sets location
330
userHsTyVarBndrs loc bndrs = [ L loc (UserTyVar v) | v <- bndrs ]
331

Austin Seipp's avatar
Austin Seipp committed
332 333 334
{-
************************************************************************
*                                                                      *
335
        Constructing syntax with no location info
Austin Seipp's avatar
Austin Seipp committed
336 337 338
*                                                                      *
************************************************************************
-}
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354

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
355
nlHsIntLit :: Integer -> LHsExpr id
356
nlHsIntLit n = noLoc (HsLit (HsInt (show n) n))
357 358 359

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

361 362
nlHsVarApps :: id -> [id] -> LHsExpr id
nlHsVarApps f xs = noLoc (foldl mk (HsVar f) (map HsVar xs))
363 364
                 where
                   mk f a = HsApp (noLoc f) (noLoc a)
365

366
nlConVarPat :: RdrName -> [RdrName] -> LPat RdrName
367 368
nlConVarPat con vars = nlConPat con (map nlVarPat vars)

369 370 371
nlConVarPatName :: Name -> [Name] -> LPat Name
nlConVarPatName con vars = nlConPatName con (map nlVarPat vars)

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

375
nlConPat :: RdrName -> [LPat RdrName] -> LPat RdrName
376 377
nlConPat con pats = noLoc (ConPatIn (noLoc con) (PrefixCon pats))

378 379 380
nlConPatName :: Name -> [LPat Name] -> LPat Name
nlConPatName con pats = noLoc (ConPatIn (noLoc con) (PrefixCon pats))

381 382 383 384 385
nlNullaryConPat :: id -> LPat id
nlNullaryConPat con = noLoc (ConPatIn (noLoc con) (PrefixCon []))

nlWildConPat :: DataCon -> LPat RdrName
nlWildConPat con = noLoc (ConPatIn (noLoc (getRdrName con))
386 387
                         (PrefixCon (nOfThem (dataConSourceArity con)
                                             nlWildPat)))
388

389 390
nlWildPat :: LPat RdrName
nlWildPat  = noLoc (WildPat placeHolderType )  -- Pre-typechecking
391

392 393 394 395 396 397 398 399
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
400
nlHsDo ctxt stmts = noLoc (mkHsDo ctxt stmts)
401

twanvl's avatar
twanvl committed
402
nlHsOpApp :: LHsExpr id -> id -> LHsExpr id -> LHsExpr id
403 404
nlHsOpApp e1 op e2 = noLoc (mkHsOpApp e1 op e2)

405
nlHsLam  :: LMatch RdrName (LHsExpr RdrName) -> LHsExpr RdrName
twanvl's avatar
twanvl committed
406 407
nlHsPar  :: LHsExpr id -> LHsExpr id
nlHsIf   :: LHsExpr id -> LHsExpr id -> LHsExpr id -> LHsExpr id
408 409 410
nlHsCase :: LHsExpr RdrName -> [LMatch RdrName (LHsExpr RdrName)]
         -> LHsExpr RdrName
nlList   :: [LHsExpr RdrName] -> LHsExpr RdrName
twanvl's avatar
twanvl committed
411

412
nlHsLam match          = noLoc (HsLam (mkMatchGroup Generated [match]))
413 414 415 416
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)
417

twanvl's avatar
twanvl committed
418 419 420 421
nlHsAppTy :: LHsType name -> LHsType name -> LHsType name
nlHsTyVar :: name                         -> LHsType name
nlHsFunTy :: LHsType name -> LHsType name -> LHsType name

422 423 424
nlHsAppTy f t           = noLoc (HsAppTy f t)
nlHsTyVar x             = noLoc (HsTyVar x)
nlHsFunTy a b           = noLoc (HsFunTy a b)
425

twanvl's avatar
twanvl committed
426
nlHsTyConApp :: name -> [LHsType name] -> LHsType name
427
nlHsTyConApp tycon tys  = foldl nlHsAppTy (nlHsTyVar tycon) tys
428

Austin Seipp's avatar
Austin Seipp committed
429
{-
430 431
Tuples.  All these functions are *pre-typechecker* because they lack
types on the tuple.
Austin Seipp's avatar
Austin Seipp committed
432
-}
433 434 435 436

mkLHsTupleExpr :: [LHsExpr a] -> LHsExpr a
-- Makes a pre-typechecker boxed tuple, deals with 1 case
mkLHsTupleExpr [e] = e
437
mkLHsTupleExpr es  = noLoc $ ExplicitTuple (map (noLoc . Present) es) Boxed
438 439 440

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

442
nlTuplePat :: [LPat id] -> Boxity -> LPat id
443
nlTuplePat pats box = noLoc (TuplePat pats box [])
444

445
missingTupArg :: HsTupArg RdrName
446
missingTupArg = Missing placeHolderType
447

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

This is needed to implement GeneralizedNewtypeDeriving.
Austin Seipp's avatar
Austin Seipp committed
516
-}
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534

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

Alan Zimmerman's avatar
Alan Zimmerman committed
546 547
    mk_hs_tvb tv = noLoc $ KindedTyVar (noLoc (getRdrName tv))
                                       (toHsKind (tyVarKind tv))
548 549 550 551

toHsKind :: Kind -> LHsKind RdrName
toHsKind = toHsType

552 553 554 555 556 557
--------- 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
558
                 | otherwise           = HsWrap co_fn e
559

560
mkHsWrapCo :: TcCoercionN   -- A Nominal coercion  a ~N b
561
           -> HsExpr id -> HsExpr id
Joachim Breitner's avatar
Joachim Breitner committed
562
mkHsWrapCo co e = mkHsWrap (coToHsWrapper co) e
563

564
mkHsWrapCoR :: TcCoercionR   -- A Representational coercion  a ~R b
565 566 567
            -> HsExpr id -> HsExpr id
mkHsWrapCoR co e = mkHsWrap (coToHsWrapperR co) e

568
mkLHsWrapCo :: TcCoercion -> LHsExpr id -> LHsExpr id
Joachim Breitner's avatar
Joachim Breitner committed
569
mkLHsWrapCo co (L loc e) = L loc (mkHsWrapCo co e)
570

571 572 573 574
mkHsCmdCast :: TcCoercion -> HsCmd id -> HsCmd id
mkHsCmdCast co cmd | isTcReflCo co = cmd
                   | otherwise     = HsCmdCast co cmd

575
coToHsWrapper :: TcCoercion -> HsWrapper   -- A Nominal coercion
576
coToHsWrapper co | isTcReflCo co = idHsWrapper
Joachim Breitner's avatar
Joachim Breitner committed
577
                 | otherwise     = mkWpCast (mkTcSubCo co)
578

579 580 581 582
coToHsWrapperR :: TcCoercion -> HsWrapper   -- A Representational coercion
coToHsWrapperR co | isTcReflCo co = idHsWrapper
                  | otherwise     = mkWpCast co

583 584
mkHsWrapPat :: HsWrapper -> Pat id -> Type -> Pat id
mkHsWrapPat co_fn p ty | isIdHsWrapper co_fn = p
585
                       | otherwise           = CoPat co_fn p ty
586

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
587
-- input coercion is Nominal
588 589
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
590
                        | otherwise     = CoPat (mkWpCast (mkTcSubCo co)) pat ty
591 592 593

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

{-
596
l
Austin Seipp's avatar
Austin Seipp committed
597 598
************************************************************************
*                                                                      *
599
                Bindings; with a location at the top
Austin Seipp's avatar
Austin Seipp committed
600 601 602
*                                                                      *
************************************************************************
-}
603

604 605
mkFunBind :: Located RdrName -> [LMatch RdrName (LHsExpr RdrName)]
          -> HsBind RdrName
606
-- Not infix, with place holders for coercion and free vars
607
mkFunBind fn ms = FunBind { fun_id = fn
608 609
                          , fun_matches = mkMatchGroup Generated ms
                          , fun_co_fn = idHsWrapper
610
                          , bind_fvs = placeHolderNames
611
                          , fun_tick = [] }
612

613 614
mkTopFunBind :: Origin -> Located Name -> [LMatch Name (LHsExpr Name)]
             -> HsBind Name
615
-- In Name-land, with empty bind_fvs
616
mkTopFunBind origin fn ms = FunBind { fun_id = fn
617
                                    , fun_matches = mkMatchGroupName origin ms
618
                                    , fun_co_fn = idHsWrapper
619 620
                                    , bind_fvs = emptyNameSet -- NB: closed
                                                              --     binding
621
                                    , fun_tick = [] }
622

623
mkHsVarBind :: SrcSpan -> RdrName -> LHsExpr RdrName -> LHsBind RdrName
624 625 626 627
mkHsVarBind loc var rhs = mk_easy_FunBind loc var [] rhs

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

630 631
mkPatSynBind :: Located RdrName -> HsPatSynDetails (Located RdrName)
             -> LPat RdrName -> HsPatSynDir RdrName -> HsBind RdrName
632 633 634 635 636 637 638
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
639

640 641 642 643 644 645 646 647 648 649
-- |If any of the matches in the 'FunBind' are infix, the 'FunBind' is
-- considered infix.
isInfixFunBind :: HsBindLR id1 id2 -> Bool
isInfixFunBind (FunBind _ (MG matches _ _ _) _ _ _)
  = any isInfix matches
  where
    isInfix (L _ match) = isInfixMatch match
isInfixFunBind _ = False


650
------------
651
mk_easy_FunBind :: SrcSpan -> RdrName -> [LPat RdrName]
652
                -> LHsExpr RdrName -> LHsBind RdrName
653
mk_easy_FunBind loc fun pats expr
654
  = L loc $ mkFunBind (L loc fun) [mkMatch pats expr emptyLocalBinds]
655

656
------------
657 658
mkMatch :: [LPat id] -> LHsExpr id -> HsLocalBinds id -> LMatch id (LHsExpr id)
mkMatch pats expr binds
659
  = noLoc (Match NonFunBindMatch (map paren pats) Nothing
660
                 (GRHSs (unguardedRHS noSrcSpan expr) binds))
661
  where
662 663
    paren lp@(L l p) | hsPatNeedsParens p = L l (ParPat lp)
                     | otherwise          = lp
664

Austin Seipp's avatar
Austin Seipp committed
665 666 667
{-
************************************************************************
*                                                                      *
668
        Collecting binders
Austin Seipp's avatar
Austin Seipp committed
669 670
*                                                                      *
************************************************************************
671 672 673 674 675 676 677 678 679 680 681

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

682 683 684
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
685
to return a [Name] or [Id].  Before renaming the record punning
686 687
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
688
-}
689 690 691

----------------- Bindings --------------------------
collectLocalBinders :: HsLocalBindsLR idL idR -> [idL]
692 693 694 695
collectLocalBinders (HsValBinds binds) = collectHsIdBinders binds
                                         -- No pattern synonyms here
collectLocalBinders (HsIPBinds _)      = []
collectLocalBinders EmptyLocalBinds    = []
696

697 698 699 700
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
701 702

collectHsBindBinders :: HsBindLR idL idR -> [idL]
703 704
-- Collect both Ids and pattern-synonym binders
collectHsBindBinders b = collect_bind False b []
705

706
collectHsBindsBinders :: LHsBindsLR idL idR -> [idL]
707
collectHsBindsBinders binds = collect_binds False binds []
708

709
collectHsBindListBinders :: [LHsBindLR idL idR] -> [idL]
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
-- 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
734

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

743
----------------- Statements --------------------------
744
collectLStmtsBinders :: [LStmtLR idL idR body] -> [idL]
745
collectLStmtsBinders = concatMap collectLStmtBinders
746

747
collectStmtsBinders :: [StmtLR idL idR body] -> [idL]
748 749
collectStmtsBinders = concatMap collectStmtBinders

750
collectLStmtBinders :: LStmtLR idL idR body -> [idL]
751 752
collectLStmtBinders = collectStmtBinders . unLoc

753
collectStmtBinders :: StmtLR idL idR body -> [idL]
754
  -- Id Binders for a Stmt... [but what about pattern-sig type vars]?
755 756 757 758 759 760
collectStmtBinders (BindStmt pat _ _ _) = collectPatBinders pat
collectStmtBinders (LetStmt binds)      = collectLocalBinders binds
collectStmtBinders (BodyStmt {})        = []
collectStmtBinders (LastStmt {})        = []
collectStmtBinders (ParStmt xs _ _)     = collectLStmtsBinders
                                        $ [s | ParStmtBlock ss _ _ <- xs, s <- ss]
761 762
collectStmtBinders (TransStmt { trS_stmts = stmts }) = collectLStmtsBinders stmts
collectStmtBinders (RecStmt { recS_stmts = ss })     = collectLStmtsBinders ss
Simon Marlow's avatar
Simon Marlow committed
763
collectStmtBinders ApplicativeStmt{} = []
764 765


766
----------------- Patterns --------------------------
767
collectPatBinders :: LPat a -> [a]
768
collectPatBinders pat = collect_lpat pat []
769 770

collectPatsBinders :: [LPat a] -> [a]
771
collectPatsBinders pats = foldr collect_lpat [] pats
772

773 774 775
-------------
collect_lpat :: LPat name -> [name] -> [name]
collect_lpat (L _ pat) bndrs
776 777
  = go pat
  where
778 779 780 781 782
    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
783
    go (ViewPat _ pat _)          = collect_lpat pat bndrs
784 785
    go (ParPat  pat)              = collect_lpat pat bndrs

786
    go (ListPat pats _ _)         = foldr collect_lpat bndrs pats
787 788 789
    go (PArrPat pats _)           = foldr collect_lpat bndrs pats
    go (TuplePat pats _ _)        = foldr collect_lpat bndrs pats

790 791
    go (ConPatIn _ ps)            = foldr collect_lpat bndrs (hsConPatArgs ps)
    go (ConPatOut {pat_args=ps})  = foldr collect_lpat bndrs (hsConPatArgs ps)
792 793 794
        -- See Note [Dictionary binders in ConPatOut]
    go (LitPat _)                 = bndrs
    go (NPat _ _ _)               = bndrs
795
    go (NPlusKPat (L _ n) _ _ _)  = n : bndrs
796 797 798

    go (SigPatIn pat _)           = collect_lpat pat bndrs
    go (SigPatOut pat _)          = collect_lpat pat bndrs
gmainland's avatar
gmainland committed
799
    go (SplicePat _)              = bndrs
800
    go (CoPat _ pat _)            = go pat
801

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

830 831 832 833
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
834
  ++ hsTyClForeignBinders tycl_decls inst_decls foreign_decls
835

836 837
hsTyClForeignBinders :: [TyClGroup Name] -> [LInstDecl Name]
                     -> [LForeignDecl Name] -> [Name]
838
-- We need to look at instance declarations too,
839
-- because their associated types may bind data constructors
840
hsTyClForeignBinders tycl_decls inst_decls foreign_decls
841 842 843 844 845 846
  = 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
847

848
-------------------
849 850 851 852 853 854
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
855
--
856 857
-- 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
858 859

hsLTyClDeclBinders (L loc (FamDecl { tcdFam = FamilyDecl { fdLName = L _ name } }))
860 861
  = ([L loc name], [])
hsLTyClDeclBinders (L loc (SynDecl     { tcdLName = L _ name })) = ([L loc name], [])
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
862 863
hsLTyClDeclBinders (L loc (ClassDecl   { tcdLName = L _ cls_name
                                       , tcdSigs = sigs, tcdATs = ats }))
864 865 866 867
  = (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
868
hsLTyClDeclBinders (L loc (DataDecl    { tcdLName = L _ name, tcdDataDefn = defn }))
869
  = (\ (xs, ys) -> (L loc name : xs, ys)) $ hsDataDefnBinders defn
870 871

-------------------
872 873 874 875 876 877
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
878 879


880
-------------------
Matthew Pickering's avatar
Matthew Pickering committed
881 882
hsPatSynBinders :: HsValBinds RdrName
                -> ([Located RdrName], [Located RdrName])
883 884
-- Collect pattern-synonym binders only, not Ids
-- See Note [SrcSpan for binders]
Matthew Pickering's avatar
Matthew Pickering committed
885
hsPatSynBinders (ValBindsIn binds _) = foldrBag addPatSynBndr ([],[]) binds
886
hsPatSynBinders _ = panic "hsPatSynBinders"
887

Matthew Pickering's avatar
Matthew Pickering committed
888 889
addPatSynBndr :: LHsBindLR id id -> ([Located id], [Located id])
                -> ([Located id], [Located id]) -- (selectors, other)
890
-- See Note [SrcSpan for binders]
Matthew Pickering's avatar
Matthew Pickering committed
891 892 893 894 895 896
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)
897
  | otherwise
Matthew Pickering's avatar
Matthew Pickering committed
898
  = (sels, pss)
899 900

-------------------
901
hsLInstDeclBinders :: LInstDecl name -> ([Located name], [LFieldOcc name])
902
hsLInstDeclBinders (L _ (ClsInstD { cid_inst = ClsInstDecl { cid_datafam_insts = dfis } }))
903
  = foldMap (hsDataFamInstBinders . unLoc) dfis
904 905
hsLInstDeclBinders (L _ (DataFamInstD { dfid_inst = fi }))
  = hsDataFamInstBinders fi
906
hsLInstDeclBinders (L _ (TyFamInstD {})) = mempty
907 908

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

-------------------
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
916
-- the SrcLoc returned are for the whole declarations, not just the names
917
hsDataDefnBinders :: HsDataDefn name -> ([Located name], [LFieldOcc name])
918 919
hsDataDefnBinders (HsDataDefn { dd_cons = cons })
  = hsConDeclsBinders cons
920
  -- See Note [Binders in family instances]
921

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

Austin Seipp's avatar
Austin Seipp committed
947
{-
948 949 950 951 952 953 954 955 956 957

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

958 959
Note [Binders in family instances]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
960
In a type or data family instance declaration, the type