2 % (c) The University of Glasgow 2006
3 % (c) The AQUA Project, Glasgow University, 1996-1998
6 Printing of Core syntax
10 pprCoreExpr, pprParendExpr,
11 pprCoreBinding, pprCoreBindings, pprCoreAlt,
36 %************************************************************************
38 \subsection{Public interfaces for Core printing (excluding instances)}
40 %************************************************************************
42 @pprParendCoreExpr@ puts parens around non-atomic Core expressions.
45 pprCoreBindings :: OutputableBndr b => [Bind b] -> SDoc
46 pprCoreBinding :: OutputableBndr b => Bind b -> SDoc
47 pprCoreExpr :: OutputableBndr b => Expr b -> SDoc
48 pprParendExpr :: OutputableBndr b => Expr b -> SDoc
50 pprCoreBindings = pprTopBinds
51 pprCoreBinding = pprTopBind
53 instance OutputableBndr b => Outputable (Bind b) where
54 ppr bind = ppr_bind bind
56 instance OutputableBndr b => Outputable (Expr b) where
57 ppr expr = pprCoreExpr expr
61 %************************************************************************
65 %************************************************************************
68 pprTopBinds :: OutputableBndr a => [Bind a] -> SDoc
69 pprTopBinds binds = vcat (map pprTopBind binds)
71 pprTopBind :: OutputableBndr a => Bind a -> SDoc
72 pprTopBind (NonRec binder expr)
73 = ppr_binding (binder,expr) $$ text ""
75 pprTopBind (Rec binds)
76 = vcat [ptext (sLit "Rec {"),
77 vcat (map ppr_binding binds),
78 ptext (sLit "end Rec }"),
83 ppr_bind :: OutputableBndr b => Bind b -> SDoc
85 ppr_bind (NonRec val_bdr expr) = ppr_binding (val_bdr, expr)
86 ppr_bind (Rec binds) = vcat (map pp binds)
88 pp bind = ppr_binding bind <> semi
90 ppr_binding :: OutputableBndr b => (b, Expr b) -> SDoc
91 ppr_binding (val_bdr, expr)
92 = pprBndr LetBind val_bdr $$
93 hang (ppr val_bdr <+> equals) 2 (pprCoreExpr expr)
97 pprParendExpr expr = ppr_expr parens expr
98 pprCoreExpr expr = ppr_expr noParens expr
100 noParens :: SDoc -> SDoc
105 ppr_expr :: OutputableBndr b => (SDoc -> SDoc) -> Expr b -> SDoc
106 -- The function adds parens in context that need
107 -- an atomic value (e.g. function args)
109 ppr_expr add_par (Type ty) = add_par (ptext (sLit "TYPE") <+> ppr ty) -- Wierd
111 ppr_expr _ (Var name) = ppr name
112 ppr_expr _ (Lit lit) = ppr lit
114 ppr_expr add_par (Cast expr co)
116 sep [pprParendExpr expr,
117 ptext (sLit "`cast`") <+> parens (pprCo co)]
119 pprCo co = sep [ppr co, dcolon <+> ppr (coercionKindPredTy co)]
122 ppr_expr add_par expr@(Lam _ _)
124 (bndrs, body) = collectBinders expr
127 hang (ptext (sLit "\\") <+> sep (map (pprBndr LambdaBind) bndrs) <+> arrow)
130 ppr_expr add_par expr@(App {})
131 = case collectArgs expr of { (fun, args) ->
133 pp_args = sep (map pprArg args)
134 val_args = dropWhile isTypeArg args -- Drop the type arguments for tuples
135 pp_tup_args = sep (punctuate comma (map pprCoreExpr val_args))
138 Var f -> case isDataConWorkId_maybe f of
139 -- Notice that we print the *worker*
140 -- for tuples in paren'd format.
141 Just dc | saturated && isTupleTyCon tc
142 -> tupleParens (tupleTyConBoxity tc) pp_tup_args
145 saturated = val_args `lengthIs` idArity f
147 _ -> add_par (hang (ppr f) 2 pp_args)
149 _ -> add_par (hang (pprParendExpr fun) 2 pp_args)
152 ppr_expr add_par (Case expr var ty [(con,args,rhs)])
154 sep [sep [ptext (sLit "case") <+> pprCoreExpr expr,
155 ifPprDebug (braces (ppr ty)),
156 sep [ptext (sLit "of") <+> ppr_bndr var,
157 char '{' <+> ppr_case_pat con args]
163 ppr_bndr = pprBndr CaseBind
165 ppr_expr add_par (Case expr var ty alts)
167 sep [sep [ptext (sLit "case")
169 <+> ifPprDebug (braces (ppr ty)),
170 ptext (sLit "of") <+> ppr_bndr var <+> char '{'],
171 nest 2 (sep (punctuate semi (map pprCoreAlt alts))),
175 ppr_bndr = pprBndr CaseBind
178 -- special cases: let ... in let ...
179 -- ("disgusting" SLPJ)
182 ppr_expr add_par (Let bind@(NonRec val_bdr rhs@(Let _ _)) body)
185 hsep [ptext (sLit "let {"), (pprBndr LetBind val_bdr $$ ppr val_bndr), equals],
186 nest 2 (pprCoreExpr rhs),
190 ppr_expr add_par (Let bind@(NonRec val_bdr rhs) expr@(Let _ _))
192 (hang (ptext (sLit "let {"))
193 2 (hsep [ppr_binding (val_bdr,rhs),
194 ptext (sLit "} in")])
199 -- General case (recursive case, too)
200 ppr_expr add_par (Let bind expr)
202 sep [hang (ptext keyword) 2 (ppr_bind bind <+> ptext (sLit "} in")),
205 keyword = case bind of
206 Rec _ -> (sLit "letrec {")
207 NonRec _ _ -> (sLit "let {")
209 ppr_expr add_par (Note (SCC cc) expr)
210 = add_par (sep [pprCostCentreCore cc, pprCoreExpr expr])
212 ppr_expr add_par (Note (CoreNote s) expr)
214 sep [sep [ptext (sLit "__core_note"), pprHsString (mkFastString s)],
217 pprCoreAlt :: OutputableBndr a => (AltCon, [a] , Expr a) -> SDoc
218 pprCoreAlt (con, args, rhs)
219 = hang (ppr_case_pat con args) 2 (pprCoreExpr rhs)
221 ppr_case_pat :: OutputableBndr a => AltCon -> [a] -> SDoc
222 ppr_case_pat (DataAlt dc) args
224 = tupleParens (tupleTyConBoxity tc) (hsep (punctuate comma (map ppr_bndr args))) <+> arrow
226 ppr_bndr = pprBndr CaseBind
229 ppr_case_pat con args
230 = ppr con <+> sep (map ppr_bndr args) <+> arrow
232 ppr_bndr = pprBndr CaseBind
234 pprArg :: OutputableBndr a => Expr a -> SDoc
235 pprArg (Type ty) = ptext (sLit "@") <+> pprParendType ty
236 pprArg expr = pprParendExpr expr
239 Other printing bits-and-bobs used with the general @pprCoreBinding@
240 and @pprCoreExpr@ functions.
243 instance OutputableBndr Var where
244 pprBndr = pprCoreBinder
246 pprCoreBinder :: BindingSite -> Var -> SDoc
247 pprCoreBinder LetBind binder
248 | isTyVar binder = pprKindedTyVarBndr binder
250 = vcat [sig, pprIdDetails binder, pragmas]
252 sig = pprTypedBinder binder
253 pragmas = ppIdInfo binder (idInfo binder)
255 -- Lambda bound type variables are preceded by "@"
256 pprCoreBinder LambdaBind bndr
258 = getPprStyle $ \ sty ->
259 if debugStyle sty then
260 parens (pprTypedBinder bndr)
264 = parens (pprTypedBinder bndr)
266 -- Case bound things don't get a signature or a herald, unless we have debug on
267 pprCoreBinder CaseBind bndr
268 | isDeadBinder bndr -- False for tyvars
271 = getPprStyle $ \ sty ->
272 if debugStyle sty then
273 parens (pprTypedBinder bndr)
275 if isDeadBinder bndr then char '_'
276 else pprUntypedBinder bndr
278 pprUntypedBinder :: Var -> SDoc
279 pprUntypedBinder binder
280 | isTyVar binder = ptext (sLit "@") <+> ppr binder -- NB: don't print kind
281 | otherwise = pprIdBndr binder
283 pprTypedBinder :: Var -> SDoc
284 -- Print binder with a type or kind signature (not paren'd)
285 pprTypedBinder binder
286 | isTyVar binder = pprKindedTyVarBndr binder
287 | otherwise = pprIdBndr binder <+> dcolon <+> pprType (idType binder)
289 pprKindedTyVarBndr :: TyVar -> SDoc
290 -- Print a type variable binder with its kind (but not if *)
291 pprKindedTyVarBndr tyvar
292 = ptext (sLit "@") <+> ppr tyvar <> opt_kind
294 opt_kind -- Print the kind if not *
295 | isLiftedTypeKind kind = empty
296 | otherwise = dcolon <> pprKind kind
297 kind = tyVarKind tyvar
299 -- pprIdBndr does *not* print the type
300 -- When printing any Id binder in debug mode, we print its inline pragma and one-shot-ness
301 pprIdBndr :: Id -> SDoc
302 pprIdBndr id = ppr id <+> pprIdBndrInfo (idInfo id)
304 pprIdBndrInfo :: IdInfo -> SDoc
306 = megaSeqIdInfo info `seq` doc -- The seq is useful for poking on black holes
308 prag_info = inlinePragInfo info
309 occ_info = occInfo info
310 dmd_info = newDemandInfo info
311 lbv_info = lbvarInfo info
313 no_info = isAlwaysActive prag_info && isNoOcc occ_info &&
314 (case dmd_info of { Nothing -> True; Just d -> isTop d }) &&
315 hasNoLBVarInfo lbv_info
317 doc | no_info = empty
319 = brackets $ hsep [ppr prag_info, ppr occ_info,
320 ppr dmd_info, ppr lbv_info
321 #ifdef OLD_STRICTNESS
322 , ppr (demandInfo id)
328 -----------------------------------------------------
330 -----------------------------------------------------
333 pprIdDetails :: Id -> SDoc
334 pprIdDetails id | isGlobalId id = ppr (globalIdDetails id)
335 | isExportedId id = ptext (sLit "[Exported]")
338 ppIdInfo :: Id -> IdInfo -> SDoc
341 vcat [ ppArityInfo a,
342 ppCafInfo (cafInfo info),
343 #ifdef OLD_STRICTNESS
347 pprNewStrictness (newStrictnessInfo info),
348 pprInlineInfo (unfoldingInfo info),
349 if null rules then empty
350 else ptext (sLit "RULES:") <+> vcat (map pprRule rules)
351 -- Inline pragma, occ, demand, lbvar info
352 -- printed out with all binders (when debug is on);
353 -- see PprCore.pprIdBndr
357 #ifdef OLD_STRICTNESS
358 s = strictnessInfo info
361 rules = specInfoRules (specInfo info)
364 -----------------------------------------------------
365 -- Unfolding and UnfoldingGuidance
366 -----------------------------------------------------
369 instance Outputable UnfoldingGuidance where
370 ppr UnfoldNever = ptext (sLit "NEVER")
371 ppr (UnfoldIfGoodArgs { ug_arity = v, ug_args = cs
372 , ug_size = size, ug_res = discount })
373 = hsep [ ptext (sLit "IF_ARGS"), int v,
374 brackets (hsep (map int cs)),
378 instance Outputable Unfolding where
379 ppr NoUnfolding = ptext (sLit "No unfolding")
380 ppr (OtherCon cs) = ptext (sLit "OtherCon") <+> ppr cs
381 ppr (CompulsoryUnfolding e) = ptext (sLit "Compulsory") <+> ppr e
382 ppr (InlineRule { uf_tmpl = e, uf_is_value = hnf, uf_arity = arity, uf_worker = wkr })
383 = ptext (sLit "INLINE") <+> sep [ppr arity <+> ppr hnf <+> ppr wkr, ppr e]
384 ppr (CoreUnfolding e top hnf cheap g)
385 = ptext (sLit "Unf") <+> sep [ppr top <+> ppr hnf <+> ppr cheap <+> ppr g,
388 pprInlineInfo :: Unfolding -> SDoc -- Print an inline RULE
389 pprInlineInfo unf | isInlineRule unf = ppr unf
393 -----------------------------------------------------
395 -----------------------------------------------------
398 instance Outputable CoreRule where
401 pprRules :: [CoreRule] -> SDoc
402 pprRules rules = vcat (map pprRule rules)
404 pprRule :: CoreRule -> SDoc
405 pprRule (BuiltinRule { ru_fn = fn, ru_name = name})
406 = ptext (sLit "Built in rule for") <+> ppr fn <> colon <+> doubleQuotes (ftext name)
408 pprRule (Rule { ru_name = name, ru_act = act, ru_fn = fn,
409 ru_bndrs = tpl_vars, ru_args = tpl_args,
411 = hang (doubleQuotes (ftext name) <+> ppr act)
412 4 (sep [ptext (sLit "forall") <+> braces (sep (map pprTypedBinder tpl_vars)),
413 nest 2 (ppr fn <+> sep (map pprArg tpl_args)),
414 nest 2 (ptext (sLit "=") <+> pprCoreExpr rhs)