HsUtils.hs 45.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 #-}
19
{-# LANGUAGE TypeFamilies #-}
Ian Lynagh's avatar
Ian Lynagh committed
20

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

31 32
  nlHsTyApp, nlHsTyApps, nlHsVar, nlHsLit, nlHsApp, nlHsApps, nlHsSyntaxApps,
  nlHsIntLit, nlHsVarApps,
33
  nlHsDo, nlHsOpApp, nlHsLam, nlHsPar, nlHsIf, nlHsCase, nlList,
34
  mkLHsTupleExpr, mkLHsVarTuple, missingTupArg,
35
  toLHsSigWcType,
36

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

41
  -- Bindings
Simon Marlow's avatar
Simon Marlow committed
42 43
  mkFunBind, mkVarBind, mkHsVarBind, mk_easy_FunBind, mkTopFunBind,
  mkPatSynBind,
44
  isInfixFunBind,
45 46

  -- Literals
47
  mkHsIntegral, mkHsFractional, mkHsIsString, mkHsString, mkHsStringPrimLit,
48 49

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

  -- Types
56
  mkHsAppTy, mkHsAppTys, userHsTyVarBndrs, userHsLTyVarBndrs,
57
  mkLHsSigType, mkLHsSigWcType, mkClassOpSigs,
58
  nlHsAppTy, nlHsTyVar, nlHsFunTy, nlHsTyConApp,
59 60

  -- Stmts
61 62
  mkTransformStmt, mkTransformByStmt, mkBodyStmt, mkBindStmt, mkTcBindStmt,
  mkLastStmt,
63 64
  emptyTransStmt, mkGroupUsingStmt, mkGroupByUsingStmt,
  emptyRecStmt, emptyRecStmtName, emptyRecStmtId, mkRecStmt,
65 66

  -- Template Haskell
67
  mkHsSpliceTy, mkHsSpliceE, mkHsSpliceTE, mkUntypedSplice,
68
  mkHsQuasiQuote, unqualQuasiQuote,
69 70

  -- Flags
71
  noRebindableInfo,
72 73

  -- Collecting binders
74
  collectLocalBinders, collectHsValBinders, collectHsBindListBinders,
75
  collectHsIdBinders,
76 77 78 79
  collectHsBindsBinders, collectHsBindBinders, collectMethodBinders,
  collectPatBinders, collectPatsBinders,
  collectLStmtsBinders, collectStmtsBinders,
  collectLStmtBinders, collectStmtBinders,
80

81
  hsLTyClDeclBinders, hsTyClForeignBinders, hsPatSynBinders,
82
  hsForeignDeclsBinders, hsGroupBinders, hsDataFamInstBinders,
83

84 85
  -- Collecting implicit binders
  lStmtsImplicits, hsValBindsImplicits, lPatImplicits
86
  ) where
87

88 89
#include "HsVersions.h"

90
import HsDecls
91 92 93
import HsBinds
import HsExpr
import HsPat
94
import HsTypes
95
import HsLit
96
import PlaceHolder
97

98
import TcEvidence
99 100
import RdrName
import Var
101 102
import TyCoRep
import Type   ( filterOutInvisibleTypes )
103
import TysWiredIn ( unitTy )
104
import TcType
105 106
import DataCon
import Name
107
import NameSet
108
import BasicTypes
109
import SrcLoc
110 111
import FastString
import Util
112
import Bag
113
import Outputable
Simon Marlow's avatar
Simon Marlow committed
114
import Constants
115

116
import Data.Either
117 118
import Data.Function
import Data.List
119

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
mkHsApp :: LHsExpr name -> LHsExpr name -> LHsExpr name
mkHsApp e1 e2 = addCLoc e1 e2 (HsApp e1 e2)

172 173 174 175 176 177
mkHsAppType :: LHsExpr name -> LHsWcType name -> LHsExpr name
mkHsAppType e t = addCLoc e (hswc_body t) (HsAppType e t)

mkHsAppTypeOut :: LHsExpr Id -> LHsWcType Name -> LHsExpr Id
mkHsAppTypeOut e t = addCLoc e (hswc_body t) (HsAppTypeOut e t)

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

mkHsLams :: [TyVar] -> [EvVar] -> LHsExpr Id -> LHsExpr Id
184 185
mkHsLams tyvars dicts expr = mkLHsWrap (mkWpTyLams tyvars
                                       <.> mkWpLams dicts) expr
186 187

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

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

199
nlHsTyApp :: name -> [Type] -> LHsExpr name
200
nlHsTyApp fun_id tys = noLoc (HsWrap (mkWpTyApps tys) (HsVar (noLoc fun_id)))
201

202 203 204
nlHsTyApps :: name -> [Type] -> [LHsExpr name] -> LHsExpr name
nlHsTyApps fun_id tys xs = foldl nlHsApp (nlHsTyApp fun_id tys) xs

205 206 207 208 209 210 211 212 213 214 215
--------- 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

216

217
-------------------------------
218 219 220
-- These are the bits of syntax that contain rebindable names
-- See RnEnv.lookupSyntaxName

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

228 229
mkNPat      :: Located (HsOverLit RdrName) -> Maybe (SyntaxExpr RdrName) -> Pat RdrName
mkNPlusKPat :: Located RdrName -> Located (HsOverLit RdrName) -> Pat RdrName
twanvl's avatar
twanvl committed
230

231
mkLastStmt :: Located (bodyR idR) -> StmtLR idL idR (Located (bodyR idR))
232 233
mkBodyStmt :: Located (bodyR RdrName)
           -> StmtLR idL RdrName (Located (bodyR RdrName))
234 235 236 237
mkBindStmt :: (PostTc idR Type ~ PlaceHolder)
           => LPat idL -> Located (bodyR idR)
           -> StmtLR idL idR (Located (bodyR idR))
mkTcBindStmt :: LPat Id -> Located (bodyR Id) -> StmtLR Id Id (Located (bodyR Id))
238

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


245 246 247
mkHsIntegral src i  = OverLit (HsIntegral   src i) noRebindableInfo noExpr
mkHsFractional   f  = OverLit (HsFractional     f) noRebindableInfo noExpr
mkHsIsString src s  = OverLit (HsIsString   src s) noRebindableInfo noExpr
248

249 250
noRebindableInfo :: PlaceHolder
noRebindableInfo = PlaceHolder -- Just another placeholder;
251

252
mkHsDo ctxt stmts = HsDo ctxt (mkLocatedList stmts) placeHolderType
253 254 255
mkHsComp ctxt stmts expr = mkHsDo ctxt (stmts ++ [last_stmt])
  where
    last_stmt = L (getLoc expr) $ mkLastStmt expr
256

257 258 259
mkHsIf :: LHsExpr id -> LHsExpr id -> LHsExpr id -> HsExpr id
mkHsIf c a b = HsIf (Just noSyntaxExpr) c a b

260 261
mkNPat lit neg     = NPat lit neg noSyntaxExpr placeHolderType
mkNPlusKPat id lit = NPlusKPat id lit (unLoc lit) noSyntaxExpr noSyntaxExpr placeHolderType
262

263 264
mkTransformStmt    :: (PostTc idR Type ~ PlaceHolder)
                   => [ExprLStmt idL] -> LHsExpr idR
265
                   -> StmtLR idL idR (LHsExpr idL)
266 267
mkTransformByStmt  :: (PostTc idR Type ~ PlaceHolder)
                   => [ExprLStmt idL] -> LHsExpr idR -> LHsExpr idR
268
                   -> StmtLR idL idR (LHsExpr idL)
269 270
mkGroupUsingStmt   :: (PostTc idR Type ~ PlaceHolder)
                   => [ExprLStmt idL]                -> LHsExpr idR
271
                   -> StmtLR idL idR (LHsExpr idL)
272 273
mkGroupByUsingStmt :: (PostTc idR Type ~ PlaceHolder)
                   => [ExprLStmt idL] -> LHsExpr idR -> LHsExpr idR
274
                   -> StmtLR idL idR (LHsExpr idL)
275

276
emptyTransStmt :: (PostTc idR Type ~ PlaceHolder) => StmtLR idL idR (LHsExpr idR)
277
emptyTransStmt = TransStmt { trS_form = panic "emptyTransStmt: form"
278
                           , trS_stmts = [], trS_bndrs = []
279
                           , trS_by = Nothing, trS_using = noLoc noExpr
280
                           , trS_ret = noSyntaxExpr, trS_bind = noSyntaxExpr
281 282
                           , trS_bind_arg_ty = PlaceHolder
                           , trS_fmap = noExpr }
283 284 285 286
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 }
287

Simon Marlow's avatar
Simon Marlow committed
288
mkLastStmt body     = LastStmt body False noSyntaxExpr
289
mkBodyStmt body     = BodyStmt body noSyntaxExpr noSyntaxExpr placeHolderType
290 291 292
mkBindStmt pat body = BindStmt pat body noSyntaxExpr noSyntaxExpr PlaceHolder
mkTcBindStmt pat body = BindStmt pat body noSyntaxExpr noSyntaxExpr unitTy
  -- don't use placeHolderTypeTc above, because that panics during zonking
293

294 295 296 297 298 299 300 301
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
302 303
     , recS_bind_fn = noSyntaxExpr, recS_bind_ty = tyVal
     , recS_later_rets = []
304 305 306 307
     , recS_rec_rets = [], recS_ret_ty = tyVal }

emptyRecStmt     = emptyRecStmt' placeHolderType
emptyRecStmtName = emptyRecStmt' placeHolderType
308
emptyRecStmtId   = emptyRecStmt' unitTy -- a panic might trigger during zonking
309
mkRecStmt stmts  = emptyRecStmt { recS_stmts = stmts }
310 311

-------------------------------
312 313
--- 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
314
mkHsOpApp :: LHsExpr id -> id -> LHsExpr id -> HsExpr id
315 316
mkHsOpApp e1 op e2 = OpApp e1 (noLoc (HsVar (noLoc op)))
                           (error "mkOpApp:fixity") e2
317

318 319 320
unqualSplice :: RdrName
unqualSplice = mkRdrUnqual (mkVarOccFS (fsLit "splice"))

321 322 323
mkUntypedSplice :: LHsExpr RdrName -> HsSplice RdrName
mkUntypedSplice e = HsUntypedSplice unqualSplice e

324
mkHsSpliceE :: LHsExpr RdrName -> HsExpr RdrName
325
mkHsSpliceE e = HsSpliceE (mkUntypedSplice e)
326 327

mkHsSpliceTE :: LHsExpr RdrName -> HsExpr RdrName
328
mkHsSpliceTE e = HsSpliceE (HsTypedSplice unqualSplice e)
329

330
mkHsSpliceTy :: LHsExpr RdrName -> HsType RdrName
331
mkHsSpliceTy e = HsSpliceTy (HsUntypedSplice unqualSplice e) placeHolderKind
332

333 334
mkHsQuasiQuote :: RdrName -> SrcSpan -> FastString -> HsSplice RdrName
mkHsQuasiQuote quoter span quote = HsQuasiQuote unqualSplice quoter span quote
335

twanvl's avatar
twanvl committed
336
unqualQuasiQuote :: RdrName
Ian Lynagh's avatar
Ian Lynagh committed
337
unqualQuasiQuote = mkRdrUnqual (mkVarOccFS (fsLit "quasiquote"))
338 339
                -- A name (uniquified later) to
                -- identify the quasi-quote
340

twanvl's avatar
twanvl committed
341
mkHsString :: String -> HsLit
342
mkHsString s = HsString s (mkFastString s)
343

344 345 346 347
mkHsStringPrimLit :: FastString -> HsLit
mkHsStringPrimLit fs
  = HsStringPrim (unpackFS fs) (fastStringToByteString fs)

348
-------------
349 350 351 352 353
userHsLTyVarBndrs :: SrcSpan -> [Located name] -> [LHsTyVarBndr name]
-- Caller sets location
userHsLTyVarBndrs loc bndrs = [ L loc (UserTyVar v) | v <- bndrs ]

userHsTyVarBndrs :: SrcSpan -> [name] -> [LHsTyVarBndr name]
354
-- Caller sets location
355
userHsTyVarBndrs loc bndrs = [ L loc (UserTyVar (L loc v)) | v <- bndrs ]
356

357

Austin Seipp's avatar
Austin Seipp committed
358 359 360
{-
************************************************************************
*                                                                      *
361
        Constructing syntax with no location info
Austin Seipp's avatar
Austin Seipp committed
362 363 364
*                                                                      *
************************************************************************
-}
365 366

nlHsVar :: id -> LHsExpr id
367
nlHsVar n = noLoc (HsVar (noLoc n))
368 369 370 371 372

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

nlVarPat :: id -> LPat id
373
nlVarPat n = noLoc (VarPat (noLoc n))
374 375 376 377 378 379 380

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

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

381 382 383 384 385 386 387 388 389 390 391 392
nlHsSyntaxApps :: SyntaxExpr id -> [LHsExpr id] -> LHsExpr id
nlHsSyntaxApps (SyntaxExpr { syn_expr      = fun
                           , syn_arg_wraps = arg_wraps
                           , syn_res_wrap  = res_wrap }) args
  | [] <- arg_wraps   -- in the noSyntaxExpr case
  = ASSERT( isIdHsWrapper res_wrap )
    foldl nlHsApp (noLoc fun) args

  | otherwise
  = mkLHsWrap res_wrap (foldl nlHsApp (noLoc fun) (zipWithEqual "nlHsSyntaxApps"
                                                     mkLHsWrap arg_wraps args))

twanvl's avatar
twanvl committed
393
nlHsIntLit :: Integer -> LHsExpr id
394
nlHsIntLit n = noLoc (HsLit (HsInt (show n) n))
395 396 397

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

399
nlHsVarApps :: id -> [id] -> LHsExpr id
400
nlHsVarApps f xs = noLoc (foldl mk (HsVar (noLoc f)) (map (HsVar . noLoc) xs))
401 402
                 where
                   mk f a = HsApp (noLoc f) (noLoc a)
403

404
nlConVarPat :: RdrName -> [RdrName] -> LPat RdrName
405 406
nlConVarPat con vars = nlConPat con (map nlVarPat vars)

407 408 409
nlConVarPatName :: Name -> [Name] -> LPat Name
nlConVarPatName con vars = nlConPatName con (map nlVarPat vars)

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

413
nlConPat :: RdrName -> [LPat RdrName] -> LPat RdrName
414 415
nlConPat con pats = noLoc (ConPatIn (noLoc con) (PrefixCon pats))

416 417 418
nlConPatName :: Name -> [LPat Name] -> LPat Name
nlConPatName con pats = noLoc (ConPatIn (noLoc con) (PrefixCon pats))

419 420 421 422 423
nlNullaryConPat :: id -> LPat id
nlNullaryConPat con = noLoc (ConPatIn (noLoc con) (PrefixCon []))

nlWildConPat :: DataCon -> LPat RdrName
nlWildConPat con = noLoc (ConPatIn (noLoc (getRdrName con))
424 425
                         (PrefixCon (nOfThem (dataConSourceArity con)
                                             nlWildPat)))
426

427 428
nlWildPat :: LPat RdrName
nlWildPat  = noLoc (WildPat placeHolderType )  -- Pre-typechecking
429

430 431 432 433 434 435 436 437
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
438
nlHsDo ctxt stmts = noLoc (mkHsDo ctxt stmts)
439

twanvl's avatar
twanvl committed
440
nlHsOpApp :: LHsExpr id -> id -> LHsExpr id -> LHsExpr id
441 442
nlHsOpApp e1 op e2 = noLoc (mkHsOpApp e1 op e2)

443
nlHsLam  :: LMatch RdrName (LHsExpr RdrName) -> LHsExpr RdrName
twanvl's avatar
twanvl committed
444 445
nlHsPar  :: LHsExpr id -> LHsExpr id
nlHsIf   :: LHsExpr id -> LHsExpr id -> LHsExpr id -> LHsExpr id
446 447 448
nlHsCase :: LHsExpr RdrName -> [LMatch RdrName (LHsExpr RdrName)]
         -> LHsExpr RdrName
nlList   :: [LHsExpr RdrName] -> LHsExpr RdrName
twanvl's avatar
twanvl committed
449

450
nlHsLam match          = noLoc (HsLam (mkMatchGroup Generated [match]))
451 452 453 454
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)
455

twanvl's avatar
twanvl committed
456 457 458 459
nlHsAppTy :: LHsType name -> LHsType name -> LHsType name
nlHsTyVar :: name                         -> LHsType name
nlHsFunTy :: LHsType name -> LHsType name -> LHsType name

460
nlHsAppTy f t           = noLoc (HsAppTy f t)
461
nlHsTyVar x             = noLoc (HsTyVar (noLoc x))
462
nlHsFunTy a b           = noLoc (HsFunTy a b)
463

twanvl's avatar
twanvl committed
464
nlHsTyConApp :: name -> [LHsType name] -> LHsType name
465
nlHsTyConApp tycon tys  = foldl nlHsAppTy (nlHsTyVar tycon) tys
466

Austin Seipp's avatar
Austin Seipp committed
467
{-
468 469
Tuples.  All these functions are *pre-typechecker* because they lack
types on the tuple.
Austin Seipp's avatar
Austin Seipp committed
470
-}
471 472 473 474

mkLHsTupleExpr :: [LHsExpr a] -> LHsExpr a
-- Makes a pre-typechecker boxed tuple, deals with 1 case
mkLHsTupleExpr [e] = e
475
mkLHsTupleExpr es  = noLoc $ ExplicitTuple (map (noLoc . Present) es) Boxed
476 477 478

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

480
nlTuplePat :: [LPat id] -> Boxity -> LPat id
481
nlTuplePat pats box = noLoc (TuplePat pats box [])
482

483
missingTupArg :: HsTupArg RdrName
484
missingTupArg = Missing placeHolderType
485

Simon Marlow's avatar
Simon Marlow committed
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 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
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
546 547 548
{-
************************************************************************
*                                                                      *
549
        LHsSigType and LHsSigWcType
Austin Seipp's avatar
Austin Seipp committed
550
*                                                                      *
551
********************************************************************* -}
552

553 554
mkLHsSigType :: LHsType RdrName -> LHsSigType RdrName
mkLHsSigType ty = mkHsImplicitBndrs ty
555

556 557
mkLHsSigWcType :: LHsType RdrName -> LHsSigWcType RdrName
mkLHsSigWcType ty = mkHsImplicitBndrs (mkHsWildCardBndrs ty)
558

559 560 561 562 563 564
mkClassOpSigs :: [LSig RdrName] -> [LSig RdrName]
-- Convert TypeSig to ClassOpSig
-- The former is what is parsed, but the latter is
-- what we need in class/instance declarations
mkClassOpSigs sigs
  = map fiddle sigs
565
  where
566 567
    fiddle (L loc (TypeSig nms ty)) = L loc (ClassOpSig False nms (dropWildCards ty))
    fiddle sig                      = sig
568

569 570 571 572 573 574 575 576 577 578
toLHsSigWcType :: Type -> LHsSigWcType RdrName
-- ^ Converting a Type to an HsType RdrName
-- This is needed to implement GeneralizedNewtypeDeriving.
--
-- Note that we use 'getRdrName' extensively, which
-- generates Exact RdrNames rather than strings.
toLHsSigWcType ty
  = mkLHsSigWcType (go ty)
  where
    go :: Type -> LHsType RdrName
579
    go ty@(ForAllTy (Anon arg) _)
580 581 582 583
      | isPredTy arg
      , (theta, tau) <- tcSplitPhiTy ty
      = noLoc (HsQualTy { hst_ctxt = noLoc (map go theta)
                        , hst_body = go tau })
584 585 586 587 588
    go (ForAllTy (Anon arg) res) = nlHsFunTy (go arg) (go res)
    go ty@(ForAllTy {})
      | (tvs, tau) <- tcSplitForAllTys ty
      = noLoc (HsForAllTy { hst_bndrs = map go_tv tvs
                          , hst_body = go tau })
589 590 591 592 593
    go (TyVarTy tv)         = nlHsTyVar (getRdrName tv)
    go (AppTy t1 t2)        = nlHsAppTy (go t1) (go t2)
    go (LitTy (NumTyLit n)) = noLoc $ HsTyLit (HsNumTy "" n)
    go (LitTy (StrTyLit s)) = noLoc $ HsTyLit (HsStrTy "" s)
    go (TyConApp tc args)   = nlHsTyConApp (getRdrName tc) (map go args')
594
       where
595 596 597 598 599
         args' = filterOutInvisibleTypes tc args
    go (CastTy ty _)        = go ty
    go (CoercionTy co)      = pprPanic "toLHsSigWcType" (ppr co)

         -- Source-language types have _invisible_ kind arguments,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
600
         -- so we must remove them here (Trac #8563)
601

602 603 604
    go_tv :: TyVar -> LHsTyVarBndr RdrName
    go_tv tv = noLoc $ KindedTyVar (noLoc (getRdrName tv))
                                   (go (tyVarKind tv))
605 606


607 608 609 610 611 612
{- *********************************************************************
*                                                                      *
    --------- HsWrappers: type args, dict args, casts ---------
*                                                                      *
********************************************************************* -}

613 614 615 616 617
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
618
                 | otherwise           = HsWrap co_fn e
619

620
mkHsWrapCo :: TcCoercionN   -- A Nominal coercion  a ~N b
621
           -> HsExpr id -> HsExpr id
622
mkHsWrapCo co e = mkHsWrap (mkWpCastN co) e
623

624
mkHsWrapCoR :: TcCoercionR   -- A Representational coercion  a ~R b
625
            -> HsExpr id -> HsExpr id
626
mkHsWrapCoR co e = mkHsWrap (mkWpCastR co) e
627

628
mkLHsWrapCo :: TcCoercionN -> LHsExpr id -> LHsExpr id
Joachim Breitner's avatar
Joachim Breitner committed
629
mkLHsWrapCo co (L loc e) = L loc (mkHsWrapCo co e)
630

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
631 632 633 634 635 636
mkHsCmdWrap :: HsWrapper -> HsCmd id -> HsCmd id
mkHsCmdWrap w cmd | isIdHsWrapper w = cmd
                  | otherwise       = HsCmdWrap w cmd

mkLHsCmdWrap :: HsWrapper -> LHsCmd id -> LHsCmd id
mkLHsCmdWrap w (L loc c) = L loc (mkHsCmdWrap w c)
637

638 639
mkHsWrapPat :: HsWrapper -> Pat id -> Type -> Pat id
mkHsWrapPat co_fn p ty | isIdHsWrapper co_fn = p
640
                       | otherwise           = CoPat co_fn p ty
641

642
mkHsWrapPatCo :: TcCoercionN -> Pat id -> Type -> Pat id
643
mkHsWrapPatCo co pat ty | isTcReflCo co = pat
644
                        | otherwise     = CoPat (mkWpCastN co) pat ty
645 646 647

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

{-
650
l
Austin Seipp's avatar
Austin Seipp committed
651 652
************************************************************************
*                                                                      *
653
                Bindings; with a location at the top
Austin Seipp's avatar
Austin Seipp committed
654 655 656
*                                                                      *
************************************************************************
-}
657

658 659
mkFunBind :: Located RdrName -> [LMatch RdrName (LHsExpr RdrName)]
          -> HsBind RdrName
660
-- Not infix, with place holders for coercion and free vars
661
mkFunBind fn ms = FunBind { fun_id = fn
662 663
                          , fun_matches = mkMatchGroup Generated ms
                          , fun_co_fn = idHsWrapper
664
                          , bind_fvs = placeHolderNames
665
                          , fun_tick = [] }
666

667 668
mkTopFunBind :: Origin -> Located Name -> [LMatch Name (LHsExpr Name)]
             -> HsBind Name
669
-- In Name-land, with empty bind_fvs
670
mkTopFunBind origin fn ms = FunBind { fun_id = fn
671
                                    , fun_matches = mkMatchGroupName origin ms
672
                                    , fun_co_fn = idHsWrapper
673 674
                                    , bind_fvs = emptyNameSet -- NB: closed
                                                              --     binding
675
                                    , fun_tick = [] }
676

677
mkHsVarBind :: SrcSpan -> RdrName -> LHsExpr RdrName -> LHsBind RdrName
678 679 680 681
mkHsVarBind loc var rhs = mk_easy_FunBind loc var [] rhs

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

684 685
mkPatSynBind :: Located RdrName -> HsPatSynDetails (Located RdrName)
             -> LPat RdrName -> HsPatSynDir RdrName -> HsBind RdrName
686 687 688 689 690 691 692
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
693

694 695 696 697
-- |If any of the matches in the 'FunBind' are infix, the 'FunBind' is
-- considered infix.
isInfixFunBind :: HsBindLR id1 id2 -> Bool
isInfixFunBind (FunBind _ (MG matches _ _ _) _ _ _)
698
  = any (isInfixMatch . unLoc) (unLoc matches)
699 700 701
isInfixFunBind _ = False


702
------------
703
mk_easy_FunBind :: SrcSpan -> RdrName -> [LPat RdrName]
704
                -> LHsExpr RdrName -> LHsBind RdrName
705
mk_easy_FunBind loc fun pats expr
706
  = L loc $ mkFunBind (L loc fun) [mkMatch pats expr (noLoc emptyLocalBinds)]
707

708
------------
709 710 711
mkMatch :: [LPat id] -> LHsExpr id -> Located (HsLocalBinds id)
        -> LMatch id (LHsExpr id)
mkMatch pats expr lbinds
712
  = noLoc (Match NonFunBindMatch (map paren pats) Nothing
713
                 (GRHSs (unguardedRHS noSrcSpan expr) lbinds))
714
  where
715 716
    paren lp@(L l p) | hsPatNeedsParens p = L l (ParPat lp)
                     | otherwise          = lp
717

Austin Seipp's avatar
Austin Seipp committed
718 719 720
{-
************************************************************************
*                                                                      *
721
        Collecting binders
Austin Seipp's avatar
Austin Seipp committed
722 723
*                                                                      *
************************************************************************
724 725 726 727 728 729 730 731 732 733 734

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

735 736 737
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
738
to return a [Name] or [Id].  Before renaming the record punning
739 740
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
741
-}
742 743 744

----------------- Bindings --------------------------
collectLocalBinders :: HsLocalBindsLR idL idR -> [idL]
745 746 747 748
collectLocalBinders (HsValBinds binds) = collectHsIdBinders binds
                                         -- No pattern synonyms here
collectLocalBinders (HsIPBinds _)      = []
collectLocalBinders EmptyLocalBinds    = []
749

750 751 752 753
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
754 755

collectHsBindBinders :: HsBindLR idL idR -> [idL]
756 757
-- Collect both Ids and pattern-synonym binders
collectHsBindBinders b = collect_bind False b []
758

759
collectHsBindsBinders :: LHsBindsLR idL idR -> [idL]
760
collectHsBindsBinders binds = collect_binds False binds []
761

762
collectHsBindListBinders :: [LHsBindLR idL idR] -> [idL]
763 764 765 766 767 768 769 770 771 772 773
-- 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]
774
-- Collect Ids, or Ids + pattern synonyms, depending on boolean flag
775 776 777 778 779 780 781 782 783 784
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
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
785
collect_bind _ (AbsBindsSig { abs_sig_export = poly }) acc = poly : acc
786 787
collect_bind omitPatSyn (PatSynBind (PSB { psb_id = L _ ps })) acc =
    if omitPatSyn then acc else ps : acc
788

789 790
collectMethodBinders :: LHsBindsLR RdrName idR -> [Located RdrName]
-- Used exclusively for the bindings of an instance decl which are all FunBinds
791
collectMethodBinders binds = foldrBag (get . unLoc) [] binds
792
  where
cactus's avatar
cactus committed
793
    get (FunBind { fun_id = f }) fs = f : fs
794
    get _                        fs = fs
795
       -- Someone else complains about non-FunBinds
796

797
----------------- Statements --------------------------
798
collectLStmtsBinders :: [LStmtLR idL idR body] -> [idL]
799
collectLStmtsBinders = concatMap collectLStmtBinders
800

801
collectStmtsBinders :: [StmtLR idL idR body] -> [idL]
802 803
collectStmtsBinders = concatMap collectStmtBinders

804
collectLStmtBinders :: LStmtLR idL idR body -> [idL]
805 806
collectLStmtBinders = collectStmtBinders . unLoc

807
collectStmtBinders :: StmtLR idL idR body -> [idL]
808
  -- Id Binders for a Stmt... [but what about pattern-sig type vars]?
809
collectStmtBinders (BindStmt pat _ _ _ _)= collectPatBinders pat
810 811 812
collectStmtBinders (LetStmt (L _ binds)) = collectLocalBinders binds
collectStmtBinders (BodyStmt {})         = []
collectStmtBinders (LastStmt {})         = []
813
collectStmtBinders (ParStmt xs _ _ _) = collectLStmtsBinders
814
                                      $ [s | ParStmtBlock ss _ _ <- xs, s <- ss]
815 816
collectStmtBinders (TransStmt { trS_stmts = stmts }) = collectLStmtsBinders stmts
collectStmtBinders (RecStmt { recS_stmts = ss })     = collectLStmtsBinders ss
Simon Marlow's avatar
Simon Marlow committed
817
collectStmtBinders ApplicativeStmt{} = []
818 819


820
----------------- Patterns --------------------------
821
collectPatBinders :: LPat a -> [a]
822
collectPatBinders pat = collect_lpat pat []
823 824

collectPatsBinders :: [LPat a] -> [a]
825
collectPatsBinders pats = foldr collect_lpat [] pats
826

827 828 829
-------------
collect_lpat :: LPat name -> [name] -> [name]
collect_lpat (L _ pat) bndrs
830 831
  = go pat
  where
832
    go (VarPat (L _ var))         = var : bndrs
833 834 835 836
    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
837
    go (ViewPat _ pat _)          = collect_lpat pat bndrs
838 839
    go (ParPat  pat)              = collect_lpat pat bndrs

840
    go (ListPat pats _ _)         = foldr collect_lpat bndrs pats
841 842 843
    go (PArrPat pats _)           = foldr collect_lpat bndrs pats
    go (TuplePat pats _ _)        = foldr collect_lpat bndrs pats

844 845
    go (ConPatIn _ ps)            = foldr collect_lpat bndrs (hsConPatArgs ps)
    go (ConPatOut {pat_args=ps})  = foldr collect_lpat bndrs (hsConPatArgs ps)
846 847
        -- See Note [Dictionary binders in ConPatOut]
    go (LitPat _)                 = bndrs
848 849
    go (NPat {})                  = bndrs
    go (NPlusKPat (L _ n) _ _ _ _ _)= n : bndrs
850 851 852

    go (SigPatIn pat _)           = collect_lpat pat bndrs
    go (SigPatOut pat _)          = collect_lpat pat bndrs
gmainland's avatar
gmainland committed
853
    go (SplicePat _)              = bndrs
854
    go (CoPat _ pat _)            = go pat
855

Austin Seipp's avatar
Austin Seipp committed
856
{-
857
Note [Dictionary binders in ConPatOut] See also same Note in DsArrows
858 859 860 861 862 863 864 865 866
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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
867 868 869 870 871 872 873 874 875 876 877 878 879 880 881
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
882
-}
Ross Paterson's avatar
Ross Paterson committed
883

884 885 886 887
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
888
  ++ hsTyClForeignBinders tycl_decls inst_decls foreign_decls
889

890 891
hsTyClForeignBinders :: [TyClGroup Name] -> [LInstDecl Name]
                     -> [LForeignDecl Name] -> [Name]
892
-- We need to look at instance declarations too,
893
-- because their associated types may bind data constructors
894
hsTyClForeignBinders tycl_decls inst_decls foreign_decls
895 896 897 898 899 900
  = 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
901

902
-------------------
903 904 905 906 907 908
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
909
--
910 911
-- 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
912 913

hsLTyClDeclBinders (L loc (FamDecl { tcdFam = FamilyDecl { fdLName = L _ name } }))
914 915
  = ([L loc name], [])
hsLTyClDeclBinders (L loc (SynDecl     { tcdLName = L _ name })) = ([L loc name], [])
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
916 917
hsLTyClDeclBinders (L loc (ClassDecl   { tcdLName = L _ cls_name
                                       , tcdSigs = sigs, tcdATs = ats }))
918
  = (L loc cls_name :
919 920
     [ L fam_loc fam_name | L fam_loc (FamilyDecl { fdLName = L _ fam_name }) <- ats ] ++
     [ L mem_loc mem_name | L mem_loc (ClassOpSig False ns _) <- sigs, L _ mem_name <- ns ]
921
    , [])
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
922
hsLTyClDeclBinders (L loc (DataDecl    { tcdLName = L _ name, tcdDataDefn = defn }))
923
  = (\ (xs, ys) -> (L loc name : xs, ys)) $ hsDataDefnBinders defn
924 925

-------------------
926 927 928 929
hsForeignDeclsBinders :: [LForeignDecl name] -> [Located name]
-- See Note [SrcSpan for binders]
hsForeignDeclsBinders foreign_decls
  = [ L decl_loc n
930
    | L decl_loc (ForeignImport { fd_name = L _ n }) <- foreign_decls]
931