ghc/compiler/hsSyn/HsUtils.lhs

   1 %
   2 % (c) The University of Glasgow, 1992-2003
   3 %
   4
   5 Here we collect a variety of helper functions that construct or
   6 analyse HsSyn.  All these functions deal with generic HsSyn; functions
   7 which deal with the intantiated versions are located elsewhere:
   8
   9    Parameterised by     Module
  10    ----------------     -------------
  11    RdrName              parser/RdrHsSyn
  12    Name                 rename/RnHsSyn
  13    Id                   typecheck/TcHsSyn
  14
  15 \begin{code}
  16 module HsUtils where
  17
  18 #include "HsVersions.h"
  19
  20 import HsBinds
  21 import HsExpr
  22 import HsPat
  23 import HsTypes
  24 import HsLit
  25
  26 import RdrName          ( RdrName, getRdrName, mkRdrUnqual )
  27 import Var              ( Id )
  28 import Type             ( Type )
  29 import DataCon          ( DataCon, dataConWrapId, dataConSourceArity )
  30 import OccName          ( mkVarOccFS )
  31 import Name             ( Name )
  32 import BasicTypes       ( RecFlag(..) )
  33 import SrcLoc
  34 import FastString       ( mkFastString )
  35 import Outputable
  36 import Util             ( nOfThem )
  37 import Bag
  38 \end{code}
  39
  40
  41 %************************************************************************
  42 %*                                                                      *
  43         Some useful helpers for constructing syntax
  44 %*                                                                      *
  45 %************************************************************************
  46
  47 These functions attempt to construct a not-completely-useless SrcSpan
  48 from their components, compared with the nl* functions below which
  49 just attach noSrcSpan to everything.
  50
  51 \begin{code}
  52 mkHsPar :: LHsExpr id -> LHsExpr id
  53 mkHsPar e = L (getLoc e) (HsPar e)
  54
  55 -- gaw 2004
  56 mkSimpleMatch :: [LPat id] -> LHsExpr id -> LMatch id
  57 mkSimpleMatch pats rhs
  58   = L loc $
  59     Match pats Nothing (GRHSs (unguardedRHS rhs) emptyLocalBinds)
  60   where
  61     loc = case pats of
  62                 []      -> getLoc rhs
  63                 (pat:_) -> combineSrcSpans (getLoc pat) (getLoc rhs)
  64
  65 unguardedRHS :: LHsExpr id -> [LGRHS id]
  66 unguardedRHS rhs@(L loc _) = [L loc (GRHS [] rhs)]
  67
  68 mkHsAppTy :: LHsType name -> LHsType name -> LHsType name
  69 mkHsAppTy t1 t2 = addCLoc t1 t2 (HsAppTy t1 t2)
  70
  71 mkHsApp :: LHsExpr name -> LHsExpr name -> LHsExpr name
  72 mkHsApp e1 e2 = addCLoc e1 e2 (HsApp e1 e2)
  73
  74 mkHsTyApp :: LHsExpr name -> [Type] -> LHsExpr name
  75 mkHsTyApp expr []  = expr
  76 mkHsTyApp expr tys = L (getLoc expr) (TyApp expr tys)
  77
  78 mkHsDictApp :: LHsExpr name -> [name] -> LHsExpr name
  79 mkHsDictApp expr []      = expr
  80 mkHsDictApp expr dict_vars = L (getLoc expr) (DictApp expr dict_vars)
  81
  82 mkHsLam :: [LPat id] -> LHsExpr id -> LHsExpr id
  83 mkHsLam pats body = mkHsPar (L (getLoc body) (HsLam matches))
  84         where
  85           matches = mkMatchGroup [mkSimpleMatch pats body]
  86
  87 mkMatchGroup :: [LMatch id] -> MatchGroup id
  88 mkMatchGroup matches = MatchGroup matches placeHolderType
  89
  90 mkHsTyLam []     expr = expr
  91 mkHsTyLam tyvars expr = L (getLoc expr) (TyLam tyvars expr)
  92
  93 mkHsDictLam []    expr = expr
  94 mkHsDictLam dicts expr = L (getLoc expr) (DictLam dicts expr)
  95
  96 mkHsDictLet :: LHsBinds Id -> LHsExpr Id -> LHsExpr Id
  97 -- Used for the dictionary bindings gotten from TcSimplify
  98 -- We make them recursive to be on the safe side
  99 mkHsDictLet binds expr
 100   | isEmptyLHsBinds binds = expr
 101   | otherwise             = L (getLoc expr) (HsLet (HsValBinds val_binds) expr)
 102                           where
 103                             val_binds = ValBindsOut [(Recursive, binds)] []
 104
 105 mkHsConApp :: DataCon -> [Type] -> [HsExpr Id] -> LHsExpr Id
 106 -- Used for constructing dictinoary terms etc, so no locations
 107 mkHsConApp data_con tys args
 108   = foldl mk_app (noLoc (HsVar (dataConWrapId data_con)) `mkHsTyApp` tys) args
 109   where
 110     mk_app f a = noLoc (HsApp f (noLoc a))
 111
 112 mkSimpleHsAlt :: LPat id -> LHsExpr id -> LMatch id
 113 -- A simple lambda with a single pattern, no binds, no guards; pre-typechecking
 114 mkSimpleHsAlt pat expr
 115   = mkSimpleMatch [pat] expr
 116
 117 -------------------------------
 118 -- These are the bits of syntax that contain rebindable names
 119 -- See RnEnv.lookupSyntaxName
 120
 121 mkHsIntegral   i       = HsIntegral   i  noSyntaxExpr
 122 mkHsFractional f       = HsFractional f  noSyntaxExpr
 123 mkHsDo ctxt stmts body = HsDo ctxt stmts body placeHolderType
 124
 125 mkNPat lit neg     = NPat lit neg noSyntaxExpr placeHolderType
 126 mkNPlusKPat id lit = NPlusKPat id lit noSyntaxExpr noSyntaxExpr
 127
 128 mkExprStmt expr     = ExprStmt expr noSyntaxExpr placeHolderType
 129 mkBindStmt pat expr = BindStmt pat expr noSyntaxExpr noSyntaxExpr
 130 mkRecStmt stmts     = RecStmt stmts [] [] [] emptyLHsBinds
 131
 132 -------------------------------
 133 --- A useful function for building @OpApps@.  The operator is always a
 134 -- variable, and we don't know the fixity yet.
 135 mkHsOpApp e1 op e2 = OpApp e1 (noLoc (HsVar op)) (error "mkOpApp:fixity") e2
 136
 137 mkHsSplice e = HsSplice unqualSplice e
 138
 139 unqualSplice = mkRdrUnqual (mkVarOccFS FSLIT("splice"))
 140                 -- A name (uniquified later) to
 141                 -- identify the splice
 142
 143 mkHsString s = HsString (mkFastString s)
 144
 145 -------------
 146 userHsTyVarBndrs :: [Located name] -> [Located (HsTyVarBndr name)]
 147 userHsTyVarBndrs bndrs = [ L loc (UserTyVar v) | L loc v <- bndrs ]
 148 \end{code}
 149
 150
 151 %************************************************************************
 152 %*                                                                      *
 153         Constructing syntax with no location info
 154 %*                                                                      *
 155 %************************************************************************
 156
 157 \begin{code}
 158 nlHsVar :: id -> LHsExpr id
 159 nlHsVar n = noLoc (HsVar n)
 160
 161 nlHsLit :: HsLit -> LHsExpr id
 162 nlHsLit n = noLoc (HsLit n)
 163
 164 nlVarPat :: id -> LPat id
 165 nlVarPat n = noLoc (VarPat n)
 166
 167 nlLitPat :: HsLit -> LPat id
 168 nlLitPat l = noLoc (LitPat l)
 169
 170 nlHsApp :: LHsExpr id -> LHsExpr id -> LHsExpr id
 171 nlHsApp f x = noLoc (HsApp f x)
 172
 173 nlHsIntLit n = noLoc (HsLit (HsInt n))
 174
 175 nlHsApps :: id -> [LHsExpr id] -> LHsExpr id
 176 nlHsApps f xs = foldl nlHsApp (nlHsVar f) xs
 177
 178 nlHsVarApps :: id -> [id] -> LHsExpr id
 179 nlHsVarApps f xs = noLoc (foldl mk (HsVar f) (map HsVar xs))
 180                  where
 181                    mk f a = HsApp (noLoc f) (noLoc a)
 182
 183 nlConVarPat :: id -> [id] -> LPat id
 184 nlConVarPat con vars = nlConPat con (map nlVarPat vars)
 185
 186 nlInfixConPat :: id -> LPat id -> LPat id -> LPat id
 187 nlInfixConPat con l r = noLoc (ConPatIn (noLoc con) (InfixCon l r))
 188
 189 nlConPat :: id -> [LPat id] -> LPat id
 190 nlConPat con pats = noLoc (ConPatIn (noLoc con) (PrefixCon pats))
 191
 192 nlNullaryConPat :: id -> LPat id
 193 nlNullaryConPat con = noLoc (ConPatIn (noLoc con) (PrefixCon []))
 194
 195 nlWildConPat :: DataCon -> LPat RdrName
 196 nlWildConPat con = noLoc (ConPatIn (noLoc (getRdrName con))
 197                                    (PrefixCon (nOfThem (dataConSourceArity con) nlWildPat)))
 198
 199 nlTuplePat pats box = noLoc (TuplePat pats box)
 200 nlWildPat  = noLoc (WildPat placeHolderType)    -- Pre-typechecking
 201
 202 nlHsDo :: HsStmtContext Name -> [LStmt id] -> LHsExpr id -> LHsExpr id
 203 nlHsDo ctxt stmts body = noLoc (mkHsDo ctxt stmts body)
 204
 205 nlHsOpApp e1 op e2 = noLoc (mkHsOpApp e1 op e2)
 206
 207 nlHsLam match           = noLoc (HsLam (mkMatchGroup [match]))
 208 nlHsPar e               = noLoc (HsPar e)
 209 nlHsIf cond true false  = noLoc (HsIf cond true false)
 210 nlHsCase expr matches   = noLoc (HsCase expr (mkMatchGroup matches))
 211 nlTuple exprs box       = noLoc (ExplicitTuple exprs box)
 212 nlList exprs            = noLoc (ExplicitList placeHolderType exprs)
 213
 214 nlHsAppTy f t           = noLoc (HsAppTy f t)
 215 nlHsTyVar x             = noLoc (HsTyVar x)
 216 nlHsFunTy a b           = noLoc (HsFunTy a b)
 217 \end{code}
 218
 219
 220
 221 %************************************************************************
 222 %*                                                                      *
 223                 Bindings; with a location at the top
 224 %*                                                                      *
 225 %************************************************************************
 226
 227 \begin{code}
 228 mkFunBind :: Located id -> [LMatch id] -> HsBind id
 229 -- Not infix, with place holders for coercion and free vars
 230 mkFunBind fn ms = FunBind { fun_id = fn, fun_infix = False, fun_matches = mkMatchGroup ms,
 231                             fun_co_fn = idCoercion, bind_fvs = placeHolderNames }
 232
 233
 234 mkVarBind :: SrcSpan -> RdrName -> LHsExpr RdrName -> LHsBind RdrName
 235 mkVarBind loc var rhs = mk_easy_FunBind loc var [] rhs
 236
 237 ------------
 238 mk_easy_FunBind :: SrcSpan -> RdrName -> [LPat RdrName]
 239                 -> LHsExpr RdrName -> LHsBind RdrName
 240
 241 mk_easy_FunBind loc fun pats expr
 242   = L loc $ mkFunBind (L loc fun) [mkMatch pats expr emptyLocalBinds]
 243
 244 ------------
 245 mk_FunBind :: SrcSpan -> RdrName
 246            -> [([LPat RdrName], LHsExpr RdrName)]
 247            -> LHsBind RdrName
 248
 249 mk_FunBind loc fun [] = panic "TcGenDeriv:mk_FunBind"
 250 mk_FunBind loc fun pats_and_exprs
 251   = L loc $ mkFunBind (L loc fun) matches
 252   where
 253     matches = [mkMatch p e emptyLocalBinds | (p,e) <-pats_and_exprs]
 254
 255 ------------
 256 mkMatch :: [LPat id] -> LHsExpr id -> HsLocalBinds id -> LMatch id
 257 mkMatch pats expr binds
 258   = noLoc (Match (map paren pats) Nothing
 259                  (GRHSs (unguardedRHS expr) binds))
 260   where
 261     paren p = case p of
 262                 L _ (VarPat _) -> p
 263                 L l _          -> L l (ParPat p)
 264 \end{code}
 265
 266
 267 %************************************************************************
 268 %*                                                                      *
 269         Collecting binders from HsBindGroups and HsBinds
 270 %*                                                                      *
 271 %************************************************************************
 272
 273 Get all the binders in some HsBindGroups, IN THE ORDER OF APPEARANCE. eg.
 274
 275 ...
 276 where
 277   (x, y) = ...
 278   f i j  = ...
 279   [a, b] = ...
 280
 281 it should return [x, y, f, a, b] (remember, order important).
 282
 283 \begin{code}
 284 collectLocalBinders :: HsLocalBinds name -> [Located name]
 285 collectLocalBinders (HsValBinds val_binds) = collectHsValBinders val_binds
 286 collectLocalBinders (HsIPBinds _)   = []
 287 collectLocalBinders EmptyLocalBinds = []
 288
 289 collectHsValBinders :: HsValBinds name -> [Located name]
 290 collectHsValBinders (ValBindsIn binds sigs)  = collectHsBindLocatedBinders binds
 291 collectHsValBinders (ValBindsOut binds sigs) = foldr collect_one [] binds
 292   where
 293    collect_one (_,binds) acc = foldrBag (collectAcc . unLoc) acc binds
 294
 295 collectAcc :: HsBind name -> [Located name] -> [Located name]
 296 collectAcc (PatBind { pat_lhs = p }) acc = collectLocatedPatBinders p ++ acc
 297 collectAcc (FunBind { fun_id = f })  acc    = f : acc
 298 collectAcc (VarBind { var_id = f })  acc    = noLoc f : acc
 299 collectAcc (AbsBinds { abs_exports = dbinds, abs_binds = binds }) acc
 300   = [noLoc dp | (_,dp,_,_) <- dbinds] ++ acc
 301         -- ++ foldr collectAcc acc binds
 302         -- I don't think we want the binders from the nested binds
 303         -- The only time we collect binders from a typechecked
 304         -- binding (hence see AbsBinds) is in zonking in TcHsSyn
 305
 306 collectHsBindBinders :: LHsBinds name -> [name]
 307 collectHsBindBinders binds = map unLoc (collectHsBindLocatedBinders binds)
 308
 309 collectHsBindLocatedBinders :: LHsBinds name -> [Located name]
 310 collectHsBindLocatedBinders binds = foldrBag (collectAcc . unLoc) [] binds
 311 \end{code}
 312
 313
 314 %************************************************************************
 315 %*                                                                      *
 316         Getting binders from statements
 317 %*                                                                      *
 318 %************************************************************************
 319
 320 \begin{code}
 321 collectLStmtsBinders :: [LStmt id] -> [Located id]
 322 collectLStmtsBinders = concatMap collectLStmtBinders
 323
 324 collectStmtsBinders :: [Stmt id] -> [Located id]
 325 collectStmtsBinders = concatMap collectStmtBinders
 326
 327 collectLStmtBinders :: LStmt id -> [Located id]
 328 collectLStmtBinders = collectStmtBinders . unLoc
 329
 330 collectStmtBinders :: Stmt id -> [Located id]
 331   -- Id Binders for a Stmt... [but what about pattern-sig type vars]?
 332 collectStmtBinders (BindStmt pat _ _ _) = collectLocatedPatBinders pat
 333 collectStmtBinders (LetStmt binds)      = collectLocalBinders binds
 334 collectStmtBinders (ExprStmt _ _ _)     = []
 335 collectStmtBinders (RecStmt ss _ _ _ _) = collectLStmtsBinders ss
 336 collectStmtBinders other                = panic "collectStmtBinders"
 337 \end{code}
 338
 339
 340 %************************************************************************
 341 %*                                                                      *
 342 %*      Gathering stuff out of patterns
 343 %*                                                                      *
 344 %************************************************************************
 345
 346 This function @collectPatBinders@ works with the ``collectBinders''
 347 functions for @HsBinds@, etc.  The order in which the binders are
 348 collected is important; see @HsBinds.lhs@.
 349
 350 It collects the bounds *value* variables in renamed patterns; type variables
 351 are *not* collected.
 352
 353 \begin{code}
 354 collectPatBinders :: LPat a -> [a]
 355 collectPatBinders pat = map unLoc (collectLocatedPatBinders pat)
 356
 357 collectLocatedPatBinders :: LPat a -> [Located a]
 358 collectLocatedPatBinders pat = collectl pat []
 359
 360 collectPatsBinders :: [LPat a] -> [a]
 361 collectPatsBinders pats = map unLoc (collectLocatedPatsBinders pats)
 362
 363 collectLocatedPatsBinders :: [LPat a] -> [Located a]
 364 collectLocatedPatsBinders pats = foldr collectl [] pats
 365
 366 ---------------------
 367 collectl (L l pat) bndrs
 368   = go pat
 369   where
 370     go (VarPat var)               = L l var : bndrs
 371     go (VarPatOut var bs)         = L l var : collectHsBindLocatedBinders bs
 372                                     ++ bndrs
 373     go (WildPat _)                = bndrs
 374     go (LazyPat pat)              = collectl pat bndrs
 375     go (AsPat a pat)              = a : collectl pat bndrs
 376     go (ParPat  pat)              = collectl pat bndrs
 377
 378     go (ListPat pats _)           = foldr collectl bndrs pats
 379     go (PArrPat pats _)           = foldr collectl bndrs pats
 380     go (TuplePat pats _)          = foldr collectl bndrs pats
 381
 382     go (ConPatIn c ps)            = foldr collectl bndrs (hsConArgs ps)
 383     go (ConPatOut c _ ds bs ps _) = map noLoc ds
 384                                     ++ collectHsBindLocatedBinders bs
 385                                     ++ foldr collectl bndrs (hsConArgs ps)
 386     go (LitPat _)                 = bndrs
 387     go (NPat _ _ _ _)             = bndrs
 388     go (NPlusKPat n _ _ _)        = n : bndrs
 389
 390     go (SigPatIn pat _)           = collectl pat bndrs
 391     go (SigPatOut pat _)          = collectl pat bndrs
 392     go (TypePat ty)               = bndrs
 393     go (DictPat ids1 ids2)        = map noLoc ids1 ++ map noLoc ids2
 394                                     ++ bndrs
 395 \end{code}
 396
 397 \begin{code}
 398 collectSigTysFromPats :: [InPat name] -> [LHsType name]
 399 collectSigTysFromPats pats = foldr collect_lpat [] pats
 400
 401 collectSigTysFromPat :: InPat name -> [LHsType name]
 402 collectSigTysFromPat pat = collect_lpat pat []
 403
 404 collect_lpat pat acc = collect_pat (unLoc pat) acc
 405
 406 collect_pat (SigPatIn pat ty)  acc = collect_lpat pat (ty:acc)
 407 collect_pat (TypePat ty)       acc = ty:acc
 408
 409 collect_pat (LazyPat pat)      acc = collect_lpat pat acc
 410 collect_pat (AsPat a pat)      acc = collect_lpat pat acc
 411 collect_pat (ParPat  pat)      acc = collect_lpat pat acc
 412 collect_pat (ListPat pats _)   acc = foldr collect_lpat acc pats
 413 collect_pat (PArrPat pats _)   acc = foldr collect_lpat acc pats
 414 collect_pat (TuplePat pats _)  acc = foldr collect_lpat acc pats
 415 collect_pat (ConPatIn c ps)    acc = foldr collect_lpat acc (hsConArgs ps)
 416 collect_pat other              acc = acc        -- Literals, vars, wildcard
 417 \end{code}