PprCore.lhs 10.7 KB
Newer Older
1
%
2
% (c) The AQUA Project, Glasgow University, 1996-1998
3
4
5
6
7
8
9
10
11
%
%************************************************************************
%*									*
\section[PprCore]{Printing of Core syntax, including for interfaces}
%*									*
%************************************************************************

\begin{code}
module PprCore (
12
	pprCoreExpr, pprParendExpr,
13
	pprCoreBinding, pprCoreBindings, pprCoreAlt,
14
	pprRules
15
16
    ) where

17
#include "HsVersions.h"
18
19

import CoreSyn
20
import CostCentre	( pprCostCentreCore )
21
import Var		( Var )
22
23
import Id		( Id, idType, isDataConWorkId_maybe, idArity,
			  idInfo, globalIdDetails, isGlobalId, isExportedId 
24
			)
25
import Var		( TyVar, isTyVar, tyVarKind )
26
import IdInfo		( IdInfo, megaSeqIdInfo, 
27
28
			  inlinePragInfo, occInfo, newDemandInfo, 
			  lbvarInfo, hasNoLBVarInfo,
29
			  arityInfo, ppArityInfo, 
30
			  specInfo, pprNewStrictness,
31
			  workerInfo, ppWorkerInfo,
32
			  newStrictnessInfo, cafInfo, ppCafInfo, specInfoRules
33
			)
34
import NewDemand	( isTop )
35
#ifdef OLD_STRICTNESS
36
37
import Id		( idDemandInfo )
import IdInfo		( cprInfo, ppCprInfo, strictnessInfo, ppStrictnessInfo ) 
38
#endif
39

40
41
import DataCon		( dataConTyCon )
import TyCon		( tupleTyConBoxity, isTupleTyCon )
42
import Type		( pprParendType, pprType, pprParendKind )
43
import BasicTypes	( tupleParens, isNoOcc, isAlwaysActive )
sof's avatar
sof committed
44
import Util             ( lengthIs )
45
import Outputable
46
import FastString       ( mkFastString )
47
48
49
50
51
52
53
54
55
56
57
\end{code}

%************************************************************************
%*									*
\subsection{Public interfaces for Core printing (excluding instances)}
%*									*
%************************************************************************

@pprParendCoreExpr@ puts parens around non-atomic Core expressions.

\begin{code}
58
59
60
61
pprCoreBindings :: OutputableBndr b => [Bind b] -> SDoc
pprCoreBinding  :: OutputableBndr b => Bind b  -> SDoc
pprCoreExpr     :: OutputableBndr b => Expr b  -> SDoc
pprParendExpr   :: OutputableBndr b => Expr b  -> SDoc
62

63
64
pprCoreBindings = pprTopBinds
pprCoreBinding  = pprTopBind 
65

66
67
instance OutputableBndr b => Outputable (Bind b) where
    ppr bind = ppr_bind bind
68

69
70
instance OutputableBndr b => Outputable (Expr b) where
    ppr expr = pprCoreExpr expr
71
\end{code}
72

73
74
75

%************************************************************************
%*									*
76
\subsection{The guts}
77
78
79
80
%*									*
%************************************************************************

\begin{code}
81
pprTopBinds binds = vcat (map pprTopBind binds)
82

83
84
pprTopBind (NonRec binder expr)
 = ppr_binding (binder,expr) $$ text ""
85

86
pprTopBind (Rec binds)
87
  = vcat [ptext SLIT("Rec {"),
88
	  vcat (map ppr_binding binds),
89
90
	  ptext SLIT("end Rec }"),
	  text ""]
91
92
93
\end{code}

\begin{code}
94
ppr_bind :: OutputableBndr b => Bind b -> SDoc
95

96
97
98
99
ppr_bind (NonRec val_bdr expr) = ppr_binding (val_bdr, expr)
ppr_bind (Rec binds)  	       = vcat (map pp binds)
			       where
				 pp bind = ppr_binding bind <> semi
100

101
102
103
ppr_binding :: OutputableBndr b => (b, Expr b) -> SDoc
ppr_binding (val_bdr, expr)
  = pprBndr LetBind val_bdr $$ 
104
    hang (ppr val_bdr <+> equals) 2 (pprCoreExpr expr)
105
106
107
\end{code}

\begin{code}
108
109
pprParendExpr   expr = ppr_expr parens expr
pprCoreExpr expr = ppr_expr noParens expr
110
111
112

noParens :: SDoc -> SDoc
noParens pp = pp
113
114
115
\end{code}

\begin{code}
116
ppr_expr :: OutputableBndr b => (SDoc -> SDoc) -> Expr b -> SDoc
117
118
	-- The function adds parens in context that need
	-- an atomic value (e.g. function args)
119

120
ppr_expr add_par (Type ty)  = add_par (ptext SLIT("TYPE") <+> ppr ty)	-- Wierd
121
	           
122
123
ppr_expr add_par (Var name) = ppr name
ppr_expr add_par (Lit lit)  = ppr lit
124

125
ppr_expr add_par expr@(Lam _ _)
126
  = let
127
	(bndrs, body) = collectBinders expr
128
    in
129
    add_par $
130
131
    hang (ptext SLIT("\\") <+> sep (map (pprBndr LambdaBind) bndrs) <+> arrow)
	 2 (pprCoreExpr body)
132

133
ppr_expr add_par expr@(App fun arg)
134
135
  = case collectArgs expr of { (fun, args) -> 
    let
136
	pp_args     = sep (map pprArg args)
137
	val_args    = dropWhile isTypeArg args	 -- Drop the type arguments for tuples
138
	pp_tup_args = sep (punctuate comma (map pprArg val_args))
139
    in
140
    case fun of
141
	Var f -> case isDataConWorkId_maybe f of
142
143
			-- Notice that we print the *worker*
			-- for tuples in paren'd format.
144
145
146
147
		   Just dc | saturated && isTupleTyCon tc
			   -> tupleParens (tupleTyConBoxity tc) pp_tup_args
			   where
			     tc	       = dataConTyCon dc
sof's avatar
sof committed
148
			     saturated = val_args `lengthIs` idArity f
149

150
		   other -> add_par (hang (ppr f) 2 pp_args)
151

152
	other -> add_par (hang (pprParendExpr fun) 2 pp_args)
153
154
    }

155
ppr_expr add_par (Case expr var ty [(con,args,rhs)])
156
  = add_par $
157
158
    sep [sep [ptext SLIT("case") <+> pprCoreExpr expr,
	      ifPprDebug (braces (ppr ty)),
159
	      hsep [ptext SLIT("of"),
160
		    ppr_bndr var, 
161
		    char '{',
162
		    ppr_case_pat con args
163
	  ]],
164
	 pprCoreExpr rhs,
165
166
	 char '}'
    ]
167
  where
168
    ppr_bndr = pprBndr CaseBind
169

170
ppr_expr add_par (Case expr var ty alts)
171
  = add_par $
172
173
174
    sep [sep [ptext SLIT("case")
		<+> pprCoreExpr expr
		<+> ifPprDebug (braces (ppr ty)),
175
	      ptext SLIT("of") <+> ppr_bndr var <+> char '{'],
176
	 nest 2 (sep (punctuate semi (map pprCoreAlt alts))),
177
178
179
	 char '}'
    ]
  where
180
    ppr_bndr = pprBndr CaseBind
181
 
182
183
184
185

-- special cases: let ... in let ...
-- ("disgusting" SLPJ)

186
187
{-
ppr_expr add_par (Let bind@(NonRec val_bdr rhs@(Let _ _)) body)
188
189
  = add_par $
    vcat [
190
191
      hsep [ptext SLIT("let {"), (pprBndr LetBind val_bdr $$ ppr val_bndr), equals],
      nest 2 (pprCoreExpr rhs),
sof's avatar
sof committed
192
      ptext SLIT("} in"),
193
194
      pprCoreExpr body ]
-}
195

196
ppr_expr add_par (Let bind@(NonRec val_bdr rhs) expr@(Let _ _))
197
198
  = add_par
    (hang (ptext SLIT("let {"))
199
200
	  2 (hsep [ppr_binding (val_bdr,rhs),
		   ptext SLIT("} in")])
201
     $$
202
     pprCoreExpr expr)
203
204

-- general case (recursive case, too)
205
ppr_expr add_par (Let bind expr)
206
  = add_par $
207
208
    sep [hang (ptext keyword) 2 (ppr_bind bind),
	 hang (ptext SLIT("} in ")) 2 (pprCoreExpr expr)]
209
210
  where
    keyword = case bind of
211
		Rec _      -> SLIT("__letrec {")
212
		NonRec _ _ -> SLIT("let {")
213

214
215
ppr_expr add_par (Note (SCC cc) expr)
  = add_par (sep [pprCostCentreCore cc, pprCoreExpr expr])
216

sof's avatar
sof committed
217
#ifdef DEBUG
218
ppr_expr add_par (Note (Coerce to_ty from_ty) expr)
219
220
 = add_par $
   getPprStyle $ \ sty ->
221
   if debugStyle sty then
222
223
224
      sep [ptext SLIT("__coerce") <+> 
		sep [pprParendType to_ty, pprParendType from_ty],
	   pprParendExpr expr]
sof's avatar
sof committed
225
   else
226
227
      sep [hsep [ptext SLIT("__coerce"), pprParendType to_ty],
	          pprParendExpr expr]
sof's avatar
sof committed
228
#else
229
ppr_expr add_par (Note (Coerce to_ty from_ty) expr)
230
  = add_par $
231
232
    sep [sep [ptext SLIT("__coerce"), nest 2 (pprParendType to_ty)],
	 pprParendExpr expr]
sof's avatar
sof committed
233
#endif
234

235
236
ppr_expr add_par (Note InlineCall expr)
  = add_par (ptext SLIT("__inline_call") <+> pprParendExpr expr)
237

238
239
ppr_expr add_par (Note InlineMe expr)
  = add_par $ ptext SLIT("__inline_me") <+> pprParendExpr expr
240

241
242
243
244
245
ppr_expr add_par (Note (CoreNote s) expr)
  = add_par $ 
    sep [sep [ptext SLIT("__core_note"), pprHsString (mkFastString s)],
         pprParendExpr expr]

246
247
pprCoreAlt (con, args, rhs) 
  = hang (ppr_case_pat con args) 2 (pprCoreExpr rhs)
248

249
ppr_case_pat con@(DataAlt dc) args
250
251
  | isTupleTyCon tc
  = tupleParens (tupleTyConBoxity tc) (hsep (punctuate comma (map ppr_bndr args))) <+> arrow
252
  where
253
    ppr_bndr = pprBndr CaseBind
254
    tc = dataConTyCon dc
255

256
ppr_case_pat con args
257
  = ppr con <+> hsep (map ppr_bndr args) <+> arrow
258
  where
259
    ppr_bndr = pprBndr CaseBind
260

261
262
pprArg (Type ty) = ptext SLIT("@") <+> pprParendType ty
pprArg expr      = pprParendExpr expr
263
264
265
266
267
268
\end{code}

Other printing bits-and-bobs used with the general @pprCoreBinding@
and @pprCoreExpr@ functions.

\begin{code}
269
270
271
272
instance OutputableBndr Var where
  pprBndr = pprCoreBinder

pprCoreBinder :: BindingSite -> Var -> SDoc
273
pprCoreBinder LetBind binder
274
  = vcat [sig, pprIdDetails binder, pragmas]
275
  where
276
    sig     = pprTypedBinder binder
277
    pragmas = ppIdInfo binder (idInfo binder)
278

279
-- Lambda bound type variables are preceded by "@"
280
pprCoreBinder LambdaBind bndr = parens (pprTypedBinder bndr)
281

282
283
-- Case bound things don't get a signature or a herald
pprCoreBinder CaseBind bndr = pprUntypedBinder bndr
284

285
pprUntypedBinder binder
286
  | isTyVar binder = ptext SLIT("@") <+> ppr binder	-- NB: don't print kind
287
288
  | otherwise      = pprIdBndr binder

289
pprTypedBinder binder
290
  | isTyVar binder  = ptext SLIT("@") <+> pprTyVarBndr binder
291
  | otherwise	    = pprIdBndr binder <+> dcolon <+> pprType (idType binder)
292

293
294
295
296
297
298
299
300
301
302
303
pprTyVarBndr :: TyVar -> SDoc
pprTyVarBndr tyvar
  = getPprStyle $ \ sty ->
    if debugStyle sty then
        hsep [ppr tyvar, dcolon, pprParendKind kind]
		-- See comments with ppDcolon in PprCore.lhs
    else
        ppr tyvar
  where
    kind = tyVarKind tyvar

304
-- pprIdBndr does *not* print the type
305
-- When printing any Id binder in debug mode, we print its inline pragma and one-shot-ness
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
pprIdBndr id = ppr id <+> pprIdBndrInfo (idInfo id)

pprIdBndrInfo info 
  = megaSeqIdInfo `seq` doc -- The seq is useful for poking on black holes
  where
    prag_info = inlinePragInfo info
    occ_info  = occInfo info
    dmd_info  = newDemandInfo info
    lbv_info  = lbvarInfo info

    no_info = isAlwaysActive prag_info && isNoOcc occ_info && 
	      (case dmd_info of { Nothing -> True; Just d -> isTop d }) &&
	      hasNoLBVarInfo lbv_info

    doc | no_info = empty
 	| otherwise
        = brackets $ hcat [ppr prag_info, ppr occ_info, 
			   ppr dmd_info, ppr lbv_info
324
#ifdef OLD_STRICTNESS
325
			   , ppr (demandInfo id)
326
#endif
327
			  ]
328
\end{code}
329
330
331


\begin{code}
332
333
334
335
336
pprIdDetails :: Id -> SDoc
pprIdDetails id | isGlobalId id     = ppr (globalIdDetails id)
		| isExportedId id   = ptext SLIT("[Exported]")
		| otherwise	    = empty

337
338
ppIdInfo :: Id -> IdInfo -> SDoc
ppIdInfo b info
339
340
  = brackets $
    vcat [  ppArityInfo a,
341
	    ppWorkerInfo (workerInfo info),
342
	    ppCafInfo (cafInfo info),
343
#ifdef OLD_STRICTNESS
344
	    ppStrictnessInfo s,
345
            ppCprInfo m,
346
#endif
347
	    pprNewStrictness (newStrictnessInfo info),
348
	    if null rules then empty
349
	    else ptext SLIT("RULES:") <+> vcat (map pprRule rules)
350
351
352
	-- Inline pragma, occ, demand, lbvar info
	-- printed out with all binders (when debug is on); 
	-- see PprCore.pprIdBndr
353
354
355
	]
  where
    a = arityInfo info
356
#ifdef OLD_STRICTNESS
357
    s = strictnessInfo info
358
    m = cprInfo info
359
#endif
360
    rules = specInfoRules (specInfo info)
361
362
\end{code}

363

364
\begin{code}
365
366
instance Outputable CoreRule where
   ppr = pprRule
367

368
369
pprRules :: [CoreRule] -> SDoc
pprRules rules = vcat (map pprRule rules)
370

371
372
373
pprRule :: CoreRule -> SDoc
pprRule (BuiltinRule { ru_fn = fn, ru_name = name})
  = ptext SLIT("Built in rule for") <+> ppr fn <> colon <+> doubleQuotes (ftext name)
374

375
376
377
pprRule (Rule { ru_name = name, ru_act = act, ru_fn = fn,
		ru_bndrs = tpl_vars, ru_args = tpl_args,
		ru_rhs = rhs })
378
  = doubleQuotes (ftext name) <+> ppr act <+>
379
380
    sep [
	  ptext SLIT("__forall") <+> braces (sep (map pprTypedBinder tpl_vars)),
381
	  nest 2 (ppr fn <+> sep (map pprArg tpl_args)),
chak's avatar
chak committed
382
	  nest 2 (ptext SLIT("=") <+> pprCoreExpr rhs)
383
    ] <+> semi
384
\end{code}