ghc/compiler/hsSyn/HsExpr.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1994
   3 %
   4 \section[HsExpr]{Abstract Haskell syntax: expressions}
   5
   6 \begin{code}
   7 #include "HsVersions.h"
   8
   9 module HsExpr where
  10
  11 import Ubiq{-uitous-}
  12 import HsLoop -- for paranoia checking
  13
  14 -- friends:
  15 import HsBinds          ( HsBinds )
  16 import HsLit            ( HsLit )
  17 import HsMatches        ( pprMatches, pprMatch, Match )
  18 import HsTypes          ( PolyType )
  19
  20 -- others:
  21 import Id               ( DictVar(..), GenId, Id(..) )
  22 import Name             ( pprNonSym, pprSym )
  23 import Outputable       ( interppSP, interpp'SP, ifnotPprForUser )
  24 import PprType          ( pprGenType, pprParendGenType, GenType{-instance-} )
  25 import Pretty
  26 import PprStyle         ( PprStyle(..) )
  27 import SrcLoc           ( SrcLoc )
  28 import Usage            ( GenUsage{-instance-} )
  29 import Util             ( panic{-ToDo:rm eventually-} )
  30 \end{code}
  31
  32 %************************************************************************
  33 %*                                                                      *
  34 \subsection{Expressions proper}
  35 %*                                                                      *
  36 %************************************************************************
  37
  38 \begin{code}
  39 data HsExpr tyvar uvar id pat
  40   = HsVar       id                              -- variable
  41   | HsLit       HsLit                           -- literal
  42   | HsLitOut    HsLit                           -- TRANSLATION
  43                 (GenType tyvar uvar)            -- (with its type)
  44
  45   | HsLam       (Match  tyvar uvar id pat)      -- lambda
  46   | HsApp       (HsExpr tyvar uvar id pat)      -- application
  47                 (HsExpr tyvar uvar id pat)
  48
  49   -- Operator applications:
  50   -- NB Bracketed ops such as (+) come out as Vars.
  51
  52   -- NB We need an expr for the operator in an OpApp/Section since
  53   -- the typechecker may need to apply the operator to a few types.
  54
  55   | OpApp       (HsExpr tyvar uvar id pat)      -- left operand
  56                 (HsExpr tyvar uvar id pat)      -- operator
  57                 (HsExpr tyvar uvar id pat)      -- right operand
  58
  59   -- We preserve prefix negation and parenthesis for the precedence parser.
  60   -- They are eventually removed by the type checker.
  61
  62   | NegApp      (HsExpr tyvar uvar id pat)      -- negated expr
  63                 id                              -- the negate id
  64
  65   | HsPar       (HsExpr tyvar uvar id pat)      -- parenthesised expr
  66
  67   | SectionL    (HsExpr tyvar uvar id pat)      -- operand
  68                 (HsExpr tyvar uvar id pat)      -- operator
  69   | SectionR    (HsExpr tyvar uvar id pat)      -- operator
  70                 (HsExpr tyvar uvar id pat)      -- operand
  71
  72   | HsCase      (HsExpr tyvar uvar id pat)
  73                 [Match  tyvar uvar id pat]      -- must have at least one Match
  74                 SrcLoc
  75
  76   | HsIf        (HsExpr tyvar uvar id pat)      --  predicate
  77                 (HsExpr tyvar uvar id pat)      --  then part
  78                 (HsExpr tyvar uvar id pat)      --  else part
  79                 SrcLoc
  80
  81   | HsLet       (HsBinds tyvar uvar id pat)     -- let(rec)
  82                 (HsExpr  tyvar uvar id pat)
  83
  84   | HsDo        [Stmt tyvar uvar id pat]        -- "do":one or more stmts
  85                 SrcLoc
  86
  87   | HsDoOut     [Stmt tyvar uvar id pat]        -- "do":one or more stmts
  88                 id id                           -- Monad and MonadZero dicts
  89                 SrcLoc
  90
  91   | ListComp    (HsExpr tyvar uvar id pat)      -- list comprehension
  92                 [Qual   tyvar uvar id pat]      -- at least one Qual(ifier)
  93
  94   | ExplicitList                -- syntactic list
  95                 [HsExpr tyvar uvar id pat]
  96   | ExplicitListOut             -- TRANSLATION
  97                 (GenType tyvar uvar)    -- Gives type of components of list
  98                 [HsExpr tyvar uvar id pat]
  99
 100   | ExplicitTuple               -- tuple
 101                 [HsExpr tyvar uvar id pat]
 102                                 -- NB: Unit is ExplicitTuple []
 103                                 -- for tuples, we can get the types
 104                                 -- direct from the components
 105
 106         -- Record construction
 107   | RecordCon   (HsExpr tyvar uvar id pat)      -- Always (HsVar id) until type checker,
 108                                                 -- but the latter adds its type args too
 109                 (HsRecordBinds tyvar uvar id pat)
 110
 111         -- Record update
 112   | RecordUpd   (HsExpr tyvar uvar id pat)
 113                 (HsRecordBinds tyvar uvar id pat)
 114
 115   | RecordUpdOut (HsExpr tyvar uvar id pat)     -- TRANSLATION
 116                  [id]                           -- Dicts needed for construction
 117                  (HsRecordBinds tyvar uvar id pat)
 118
 119   | ExprWithTySig               -- signature binding
 120                 (HsExpr tyvar uvar id pat)
 121                 (PolyType id)
 122   | ArithSeqIn                  -- arithmetic sequence
 123                 (ArithSeqInfo tyvar uvar id pat)
 124   | ArithSeqOut
 125                 (HsExpr       tyvar uvar id pat) -- (typechecked, of course)
 126                 (ArithSeqInfo tyvar uvar id pat)
 127
 128   | CCall       FAST_STRING     -- call into the C world; string is
 129                 [HsExpr tyvar uvar id pat]      -- the C function; exprs are the
 130                                 -- arguments to pass.
 131                 Bool            -- True <=> might cause Haskell
 132                                 -- garbage-collection (must generate
 133                                 -- more paranoid code)
 134                 Bool            -- True <=> it's really a "casm"
 135                                 -- NOTE: this CCall is the *boxed*
 136                                 -- version; the desugarer will convert
 137                                 -- it into the unboxed "ccall#".
 138                 (GenType tyvar uvar)    -- The result type; will be *bottom*
 139                                 -- until the typechecker gets ahold of it
 140
 141   | HsSCC       FAST_STRING     -- "set cost centre" (_scc_) annotation
 142                 (HsExpr tyvar uvar id pat) -- expr whose cost is to be measured
 143 \end{code}
 144
 145 Everything from here on appears only in typechecker output.
 146
 147 \begin{code}
 148   | TyLam                       -- TRANSLATION
 149                 [tyvar]
 150                 (HsExpr tyvar uvar id pat)
 151   | TyApp                       -- TRANSLATION
 152                 (HsExpr  tyvar uvar id pat) -- generated by Spec
 153                 [GenType tyvar uvar]
 154
 155   -- DictLam and DictApp are "inverses"
 156   |  DictLam
 157                 [id]
 158                 (HsExpr tyvar uvar id pat)
 159   |  DictApp
 160                 (HsExpr tyvar uvar id pat)
 161                 [id]
 162
 163   -- ClassDictLam and Dictionary are "inverses" (see note below)
 164   |  ClassDictLam
 165                 [id]            -- superclass dicts
 166                 [id]            -- methods
 167                 (HsExpr tyvar uvar id pat)
 168   |  Dictionary
 169                 [id]            -- superclass dicts
 170                 [id]            -- methods
 171
 172   |  SingleDict                 -- a simple special case of Dictionary
 173                 id              -- local dictionary name
 174
 175   |  HsCon                      -- TRANSLATION; a constructor application
 176         Id                      -- used only in the RHS of constructor definitions
 177         [GenType tyvar uvar]
 178         [HsExpr tyvar uvar id pat]
 179
 180 type HsRecordBinds tyvar uvar id pat
 181   = [(id, HsExpr tyvar uvar id pat, Bool)]
 182         -- True <=> source code used "punning",
 183         -- i.e. {op1, op2} rather than {op1=e1, op2=e2}
 184 \end{code}
 185
 186 A @Dictionary@, unless of length 0 or 1, becomes a tuple.  A
 187 @ClassDictLam dictvars methods expr@ is, therefore:
 188 \begin{verbatim}
 189 \ x -> case x of ( dictvars-and-methods-tuple ) -> expr
 190 \end{verbatim}
 191
 192 \begin{code}
 193 instance (NamedThing id, Outputable id, Outputable pat,
 194           Eq tyvar, Outputable tyvar, Eq uvar, Outputable uvar) =>
 195                 Outputable (HsExpr tyvar uvar id pat) where
 196     ppr = pprExpr
 197 \end{code}
 198
 199 \begin{code}
 200 pprExpr sty (HsVar v) = pprNonSym sty v
 201
 202 pprExpr sty (HsLit    lit)   = ppr sty lit
 203 pprExpr sty (HsLitOut lit _) = ppr sty lit
 204
 205 pprExpr sty (HsLam match)
 206   = ppCat [ppStr "\\", ppNest 2 (pprMatch sty True match)]
 207
 208 pprExpr sty expr@(HsApp e1 e2)
 209   = let (fun, args) = collect_args expr [] in
 210     ppHang (pprExpr sty fun) 4 (ppSep (map (pprExpr sty) args))
 211   where
 212     collect_args (HsApp fun arg) args = collect_args fun (arg:args)
 213     collect_args fun             args = (fun, args)
 214
 215 pprExpr sty (OpApp e1 op e2)
 216   = case op of
 217       HsVar v -> pp_infixly v
 218       _       -> pp_prefixly
 219   where
 220     pp_e1 = pprExpr sty e1
 221     pp_e2 = pprExpr sty e2
 222
 223     pp_prefixly
 224       = ppHang (pprExpr sty op) 4 (ppSep [pp_e1, pp_e2])
 225
 226     pp_infixly v
 227       = ppSep [pp_e1, ppCat [pprSym sty v, pp_e2]]
 228
 229 pprExpr sty (NegApp e _)
 230   = ppBeside (ppChar '-') (pprParendExpr sty e)
 231
 232 pprExpr sty (HsPar e)
 233   = ppParens (pprExpr sty e)
 234
 235 pprExpr sty (SectionL expr op)
 236   = case op of
 237       HsVar v -> pp_infixly v
 238       _       -> pp_prefixly
 239   where
 240     pp_expr = pprParendExpr sty expr
 241
 242     pp_prefixly = ppHang (ppCat [ppStr "( \\ _x ->", ppr sty op])
 243                        4 (ppCat [pp_expr, ppStr "_x )"])
 244     pp_infixly v
 245       = ppSep [ ppBeside ppLparen pp_expr,
 246                 ppBeside (pprSym sty v) ppRparen ]
 247
 248 pprExpr sty (SectionR op expr)
 249   = case op of
 250       HsVar v -> pp_infixly v
 251       _       -> pp_prefixly
 252   where
 253     pp_expr = pprParendExpr sty expr
 254
 255     pp_prefixly = ppHang (ppCat [ppStr "( \\ _x ->", ppr sty op, ppPStr SLIT("_x")])
 256                        4 (ppBeside pp_expr ppRparen)
 257     pp_infixly v
 258       = ppSep [ ppBeside ppLparen (pprSym sty v),
 259                 ppBeside pp_expr  ppRparen ]
 260
 261 pprExpr sty (HsCase expr matches _)
 262   = ppSep [ ppSep [ppPStr SLIT("case"), ppNest 4 (pprExpr sty expr), ppPStr SLIT("of")],
 263             ppNest 2 (pprMatches sty (True, ppNil) matches) ]
 264
 265 pprExpr sty (HsIf e1 e2 e3 _)
 266   = ppSep [ppCat [ppPStr SLIT("if"), ppNest 2 (pprExpr sty e1), ppPStr SLIT("then")],
 267            ppNest 4 (pprExpr sty e2),
 268            ppPStr SLIT("else"),
 269            ppNest 4 (pprExpr sty e3)]
 270
 271 -- special case: let ... in let ...
 272 pprExpr sty (HsLet binds expr@(HsLet _ _))
 273   = ppSep [ppHang (ppPStr SLIT("let")) 2 (ppCat [ppr sty binds, ppPStr SLIT("in")]),
 274            ppr sty expr]
 275
 276 pprExpr sty (HsLet binds expr)
 277   = ppSep [ppHang (ppPStr SLIT("let")) 2 (ppr sty binds),
 278            ppHang (ppPStr SLIT("in"))  2 (ppr sty expr)]
 279
 280 pprExpr sty (HsDo stmts _)
 281   = ppCat [ppPStr SLIT("do"), ppAboves (map (ppr sty) stmts)]
 282 pprExpr sty (HsDoOut stmts _ _ _)
 283   = ppCat [ppPStr SLIT("do"), ppAboves (map (ppr sty) stmts)]
 284
 285 pprExpr sty (ListComp expr quals)
 286   = ppHang (ppCat [ppLbrack, pprExpr sty expr, ppChar '|'])
 287          4 (ppSep [interpp'SP sty quals, ppRbrack])
 288
 289 pprExpr sty (ExplicitList exprs)
 290   = ppBracket (ppInterleave ppComma (map (pprExpr sty) exprs))
 291 pprExpr sty (ExplicitListOut ty exprs)
 292   = ppBesides [ ppBracket (ppInterleave ppComma (map (pprExpr sty) exprs)),
 293                 ifnotPprForUser sty (ppBeside ppSP (ppParens (pprGenType sty ty))) ]
 294
 295 pprExpr sty (ExplicitTuple exprs)
 296   = ppParens (ppInterleave ppComma (map (pprExpr sty) exprs))
 297
 298 pprExpr sty (RecordCon con  rbinds)
 299   = pp_rbinds sty (ppr sty con) rbinds
 300
 301 pprExpr sty (RecordUpd aexp rbinds)
 302   = pp_rbinds sty (pprParendExpr sty aexp) rbinds
 303 pprExpr sty (RecordUpdOut aexp _ rbinds)
 304   = pp_rbinds sty (pprParendExpr sty aexp) rbinds
 305
 306 pprExpr sty (ExprWithTySig expr sig)
 307   = ppHang (ppBesides [ppLparen, ppNest 2 (pprExpr sty expr), ppPStr SLIT(" ::")])
 308          4 (ppBeside  (ppr sty sig) ppRparen)
 309
 310 pprExpr sty (ArithSeqIn info)
 311   = ppBracket (ppr sty info)
 312 pprExpr sty (ArithSeqOut expr info)
 313   = case sty of
 314         PprForUser ->
 315           ppBracket (ppr sty info)
 316         _          ->
 317           ppBesides [ppLbrack, ppParens (ppr sty expr), ppr sty info, ppRbrack]
 318
 319 pprExpr sty (CCall fun args _ is_asm result_ty)
 320   = ppHang (if is_asm
 321             then ppBesides [ppStr "_casm_ ``", ppPStr fun, ppStr "''"]
 322             else ppBeside  (ppPStr SLIT("_ccall_ ")) (ppPStr fun))
 323          4 (ppSep (map (pprParendExpr sty) args))
 324
 325 pprExpr sty (HsSCC label expr)
 326   = ppSep [ ppBeside (ppPStr SLIT("_scc_ ")) (ppBesides [ppChar '"', ppPStr label, ppChar '"']),
 327             pprParendExpr sty expr ]
 328
 329 pprExpr sty (TyLam tyvars expr)
 330   = ppHang (ppCat [ppStr "/\\", interppSP sty tyvars, ppStr "->"])
 331          4 (pprExpr sty expr)
 332
 333 pprExpr sty (TyApp expr [ty])
 334   = ppHang (pprExpr sty expr) 4 (pprParendGenType sty ty)
 335
 336 pprExpr sty (TyApp expr tys)
 337   = ppHang (pprExpr sty expr)
 338          4 (ppBracket (interpp'SP sty tys))
 339
 340 pprExpr sty (DictLam dictvars expr)
 341   = ppHang (ppCat [ppStr "\\{-dict-}", interppSP sty dictvars, ppStr "->"])
 342          4 (pprExpr sty expr)
 343
 344 pprExpr sty (DictApp expr [dname])
 345   = ppHang (pprExpr sty expr) 4 (ppr sty dname)
 346
 347 pprExpr sty (DictApp expr dnames)
 348   = ppHang (pprExpr sty expr)
 349          4 (ppBracket (interpp'SP sty dnames))
 350
 351 pprExpr sty (ClassDictLam dicts methods expr)
 352   = ppHang (ppCat [ppStr "\\{-classdict-}",
 353                    ppBracket (interppSP sty dicts),
 354                    ppBracket (interppSP sty methods),
 355                    ppStr "->"])
 356          4 (pprExpr sty expr)
 357
 358 pprExpr sty (Dictionary dicts methods)
 359   = ppSep [ppBesides [ppLparen, ppPStr SLIT("{-dict-}")],
 360            ppBracket (interpp'SP sty dicts),
 361            ppBesides [ppBracket (interpp'SP sty methods), ppRparen]]
 362
 363 pprExpr sty (SingleDict dname)
 364   = ppCat [ppPStr SLIT("{-singleDict-}"), ppr sty dname]
 365
 366 pprExpr sty (HsCon con tys exprs)
 367   = ppCat [ppPStr SLIT("{-HsCon-}"), ppr sty con, interppSP sty tys, interppSP sty exprs]
 368 \end{code}
 369
 370 Parenthesize unless very simple:
 371 \begin{code}
 372 pprParendExpr :: (NamedThing id, Outputable id, Outputable pat,
 373                   Eq tyvar, Outputable tyvar, Eq uvar, Outputable uvar)
 374               => PprStyle -> HsExpr tyvar uvar id pat -> Pretty
 375
 376 pprParendExpr sty expr
 377   = let
 378         pp_as_was = pprExpr sty expr
 379     in
 380     case expr of
 381       HsLit l               -> ppr sty l
 382       HsLitOut l _          -> ppr sty l
 383       HsVar _               -> pp_as_was
 384       ExplicitList _        -> pp_as_was
 385       ExplicitListOut _ _   -> pp_as_was
 386       ExplicitTuple _       -> pp_as_was
 387       _                     -> ppParens pp_as_was
 388 \end{code}
 389
 390 %************************************************************************
 391 %*                                                                      *
 392 \subsection{Record binds}
 393 %*                                                                      *
 394 %************************************************************************
 395
 396 \begin{code}
 397 pp_rbinds :: (NamedThing id, Outputable id, Outputable pat,
 398                   Eq tyvar, Outputable tyvar, Eq uvar, Outputable uvar)
 399               => PprStyle -> Pretty
 400               -> HsRecordBinds tyvar uvar id pat -> Pretty
 401
 402 pp_rbinds sty thing rbinds
 403   = ppHang thing 4
 404         (ppBesides [ppChar '{', ppInterleave ppComma (map (pp_rbind sty) rbinds), ppChar '}'])
 405   where
 406     pp_rbind PprForUser (v, _, True) = ppr PprForUser v
 407     pp_rbind sty        (v, e, _)    = ppCat [ppr sty v, ppStr "=", ppr sty e]
 408 \end{code}
 409
 410 %************************************************************************
 411 %*                                                                      *
 412 \subsection{Do stmts}
 413 %*                                                                      *
 414 %************************************************************************
 415
 416 \begin{code}
 417 data Stmt tyvar uvar id pat
 418   = BindStmt    pat
 419                 (HsExpr  tyvar uvar id pat)
 420                 SrcLoc
 421   | ExprStmt    (HsExpr  tyvar uvar id pat)
 422                 SrcLoc
 423   | LetStmt     (HsBinds tyvar uvar id pat)
 424 \end{code}
 425
 426 \begin{code}
 427 instance (NamedThing id, Outputable id, Outputable pat,
 428           Eq tyvar, Outputable tyvar, Eq uvar, Outputable uvar) =>
 429                 Outputable (Stmt tyvar uvar id pat) where
 430     ppr sty (BindStmt pat expr _)
 431      = ppCat [ppr sty pat, ppStr "<-", ppr sty expr]
 432     ppr sty (LetStmt binds)
 433      = ppCat [ppPStr SLIT("let"), ppr sty binds]
 434     ppr sty (ExprStmt expr _)
 435      = ppr sty expr
 436 \end{code}
 437
 438 %************************************************************************
 439 %*                                                                      *
 440 \subsection{Enumerations and list comprehensions}
 441 %*                                                                      *
 442 %************************************************************************
 443
 444 \begin{code}
 445 data ArithSeqInfo  tyvar uvar id pat
 446   = From            (HsExpr tyvar uvar id pat)
 447   | FromThen        (HsExpr tyvar uvar id pat)
 448                     (HsExpr tyvar uvar id pat)
 449   | FromTo          (HsExpr tyvar uvar id pat)
 450                     (HsExpr tyvar uvar id pat)
 451   | FromThenTo      (HsExpr tyvar uvar id pat)
 452                     (HsExpr tyvar uvar id pat)
 453                     (HsExpr tyvar uvar id pat)
 454 \end{code}
 455
 456 \begin{code}
 457 instance (NamedThing id, Outputable id, Outputable pat,
 458           Eq tyvar, Outputable tyvar, Eq uvar, Outputable uvar) =>
 459                 Outputable (ArithSeqInfo tyvar uvar id pat) where
 460     ppr sty (From e1)           = ppBesides [ppr sty e1, pp_dotdot]
 461     ppr sty (FromThen e1 e2)    = ppBesides [ppr sty e1, pp'SP, ppr sty e2, pp_dotdot]
 462     ppr sty (FromTo e1 e3)      = ppBesides [ppr sty e1, pp_dotdot, ppr sty e3]
 463     ppr sty (FromThenTo e1 e2 e3)
 464       = ppBesides [ppr sty e1, pp'SP, ppr sty e2, pp_dotdot, ppr sty e3]
 465
 466 pp_dotdot = ppPStr SLIT(" .. ")
 467 \end{code}
 468
 469 ``Qualifiers'' in list comprehensions:
 470 \begin{code}
 471 data Qual tyvar uvar id pat
 472   = GeneratorQual   pat
 473                     (HsExpr  tyvar uvar id pat)
 474   | LetQual         (HsBinds tyvar uvar id pat)
 475   | FilterQual      (HsExpr  tyvar uvar id pat)
 476 \end{code}
 477
 478 \begin{code}
 479 instance (NamedThing id, Outputable id, Outputable pat,
 480           Eq tyvar, Outputable tyvar, Eq uvar, Outputable uvar) =>
 481                 Outputable (Qual tyvar uvar id pat) where
 482     ppr sty (GeneratorQual pat expr)
 483      = ppCat [ppr sty pat, ppStr "<-", ppr sty expr]
 484     ppr sty (LetQual binds)
 485      = ppCat [ppPStr SLIT("let"), ppr sty binds]
 486     ppr sty (FilterQual expr)
 487      = ppr sty expr
 488 \end{code}