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,
38 %************************************************************************
40 \subsection{Public interfaces for Core printing (excluding instances)}
42 %************************************************************************
44 @pprParendCoreExpr@ puts parens around non-atomic Core expressions.
47 pprCoreBindings :: OutputableBndr b => [Bind b] -> SDoc
48 pprCoreBinding :: OutputableBndr b => Bind b -> SDoc
49 pprCoreExpr :: OutputableBndr b => Expr b -> SDoc
50 pprParendExpr :: OutputableBndr b => Expr b -> SDoc
52 pprCoreBindings = pprTopBinds
53 pprCoreBinding = pprTopBind
55 instance OutputableBndr b => Outputable (Bind b) where
56 ppr bind = ppr_bind bind
58 instance OutputableBndr b => Outputable (Expr b) where
59 ppr expr = pprCoreExpr expr
63 %************************************************************************
67 %************************************************************************
70 pprTopBinds :: OutputableBndr a => [Bind a] -> SDoc
71 pprTopBinds binds = vcat (map pprTopBind binds)
73 pprTopBind :: OutputableBndr a => Bind a -> SDoc
74 pprTopBind (NonRec binder expr)
75 = ppr_binding (binder,expr) $$ blankLine
78 = ptext (sLit "Rec { }")
79 pprTopBind (Rec (b:bs))
80 = vcat [ptext (sLit "Rec {"),
82 vcat [blankLine $$ ppr_binding b | b <- bs],
83 ptext (sLit "end Rec }"),
88 ppr_bind :: OutputableBndr b => Bind b -> SDoc
90 ppr_bind (NonRec val_bdr expr) = ppr_binding (val_bdr, expr)
91 ppr_bind (Rec binds) = vcat (map pp binds)
93 pp bind = ppr_binding bind <> semi
95 ppr_binding :: OutputableBndr b => (b, Expr b) -> SDoc
96 ppr_binding (val_bdr, expr)
97 = pprBndr LetBind val_bdr $$
98 hang (ppr val_bdr <+> equals) 2 (pprCoreExpr expr)
102 pprParendExpr expr = ppr_expr parens expr
103 pprCoreExpr expr = ppr_expr noParens expr
105 noParens :: SDoc -> SDoc
110 ppr_expr :: OutputableBndr b => (SDoc -> SDoc) -> Expr b -> SDoc
111 -- The function adds parens in context that need
112 -- an atomic value (e.g. function args)
114 ppr_expr add_par (Type ty) = add_par (ptext (sLit "TYPE") <+> ppr ty) -- Wierd
116 ppr_expr _ (Var name) = ppr name
117 ppr_expr _ (Lit lit) = ppr lit
119 ppr_expr add_par (Cast expr co)
121 sep [pprParendExpr expr,
122 ptext (sLit "`cast`") <+> pprCo co]
124 pprCo co | opt_SuppressCoercions = ptext (sLit "...")
126 $ sep [ppr co, dcolon <+> pprEqPred (coercionKind co)]
129 ppr_expr add_par expr@(Lam _ _)
131 (bndrs, body) = collectBinders expr
134 hang (ptext (sLit "\\") <+> sep (map (pprBndr LambdaBind) bndrs) <+> arrow)
137 ppr_expr add_par expr@(App {})
138 = case collectArgs expr of { (fun, args) ->
140 pp_args = sep (map pprArg args)
141 val_args = dropWhile isTypeArg args -- Drop the type arguments for tuples
142 pp_tup_args = sep (punctuate comma (map pprCoreExpr val_args))
145 Var f -> case isDataConWorkId_maybe f of
146 -- Notice that we print the *worker*
147 -- for tuples in paren'd format.
148 Just dc | saturated && isTupleTyCon tc
149 -> tupleParens (tupleTyConBoxity tc) pp_tup_args
152 saturated = val_args `lengthIs` idArity f
154 _ -> add_par (hang (ppr f) 2 pp_args)
156 _ -> add_par (hang (pprParendExpr fun) 2 pp_args)
159 ppr_expr add_par (Case expr var ty [(con,args,rhs)])
161 sep [sep [ptext (sLit "case") <+> pprCoreExpr expr,
162 ifPprDebug (braces (ppr ty)),
163 sep [ptext (sLit "of") <+> ppr_bndr var,
164 char '{' <+> ppr_case_pat con args]
170 ppr_bndr = pprBndr CaseBind
172 ppr_expr add_par (Case expr var ty alts)
174 sep [sep [ptext (sLit "case")
176 <+> ifPprDebug (braces (ppr ty)),
177 ptext (sLit "of") <+> ppr_bndr var <+> char '{'],
178 nest 2 (sep (punctuate semi (map pprCoreAlt alts))),
182 ppr_bndr = pprBndr CaseBind
185 -- special cases: let ... in let ...
186 -- ("disgusting" SLPJ)
189 ppr_expr add_par (Let bind@(NonRec val_bdr rhs@(Let _ _)) body)
192 hsep [ptext (sLit "let {"), (pprBndr LetBind val_bdr $$ ppr val_bndr), equals],
193 nest 2 (pprCoreExpr rhs),
197 ppr_expr add_par (Let bind@(NonRec val_bdr rhs) expr@(Let _ _))
199 (hang (ptext (sLit "let {"))
200 2 (hsep [ppr_binding (val_bdr,rhs),
201 ptext (sLit "} in")])
206 -- General case (recursive case, too)
207 ppr_expr add_par (Let bind expr)
209 sep [hang (ptext keyword) 2 (ppr_bind bind <+> ptext (sLit "} in")),
212 keyword = case bind of
213 Rec _ -> (sLit "letrec {")
214 NonRec _ _ -> (sLit "let {")
216 ppr_expr add_par (Note (SCC cc) expr)
217 = add_par (sep [pprCostCentreCore cc, pprCoreExpr expr])
219 ppr_expr add_par (Note (CoreNote s) expr)
221 sep [sep [ptext (sLit "__core_note"), pprHsString (mkFastString s)],
224 pprCoreAlt :: OutputableBndr a => (AltCon, [a] , Expr a) -> SDoc
225 pprCoreAlt (con, args, rhs)
226 = hang (ppr_case_pat con args) 2 (pprCoreExpr rhs)
228 ppr_case_pat :: OutputableBndr a => AltCon -> [a] -> SDoc
229 ppr_case_pat (DataAlt dc) args
231 = tupleParens (tupleTyConBoxity tc) (hsep (punctuate comma (map ppr_bndr args))) <+> arrow
233 ppr_bndr = pprBndr CaseBind
236 ppr_case_pat con args
237 = ppr con <+> sep (map ppr_bndr args) <+> arrow
239 ppr_bndr = pprBndr CaseBind
241 pprArg :: OutputableBndr a => Expr a -> SDoc
242 pprArg (Type ty) = ptext (sLit "@") <+> pprParendType ty
243 pprArg expr = pprParendExpr expr
246 Other printing bits-and-bobs used with the general @pprCoreBinding@
247 and @pprCoreExpr@ functions.
250 instance OutputableBndr Var where
251 pprBndr = pprCoreBinder
253 pprCoreBinder :: BindingSite -> Var -> SDoc
254 pprCoreBinder LetBind binder
255 | isTyVar binder = pprKindedTyVarBndr binder
256 | otherwise = pprTypedBinder binder $$
257 ppIdInfo binder (idInfo binder)
259 -- Lambda bound type variables are preceded by "@"
260 pprCoreBinder LambdaBind bndr
262 = getPprStyle $ \ sty ->
263 if debugStyle sty then
264 parens (pprTypedBinder bndr)
268 = parens (pprTypedBinder bndr)
270 -- Case bound things don't get a signature or a herald, unless we have debug on
271 pprCoreBinder CaseBind bndr
272 | isDeadBinder bndr -- False for tyvars
275 = getPprStyle $ \ sty ->
276 if debugStyle sty then
277 parens (pprTypedBinder bndr)
279 if isDeadBinder bndr then char '_'
280 else pprUntypedBinder bndr
282 pprUntypedBinder :: Var -> SDoc
283 pprUntypedBinder binder
284 | isTyVar binder = ptext (sLit "@") <+> ppr binder -- NB: don't print kind
285 | otherwise = pprIdBndr binder
287 pprTypedBinder :: Var -> SDoc
288 -- Print binder with a type or kind signature (not paren'd)
289 pprTypedBinder binder
290 | isTyVar binder = pprKindedTyVarBndr binder
291 | otherwise = hang (pprIdBndr binder) 2 (dcolon <+> pprType (idType binder))
293 pprKindedTyVarBndr :: TyVar -> SDoc
294 -- Print a type variable binder with its kind (but not if *)
295 pprKindedTyVarBndr tyvar
296 = ptext (sLit "@") <+> ppr tyvar <> opt_kind
298 opt_kind -- Print the kind if not *
299 | isLiftedTypeKind kind = empty
300 | otherwise = dcolon <> pprKind kind
301 kind = tyVarKind tyvar
303 -- pprIdBndr does *not* print the type
304 -- When printing any Id binder in debug mode, we print its inline pragma and one-shot-ness
305 pprIdBndr :: Id -> SDoc
306 pprIdBndr id = ppr id <+> pprIdBndrInfo (idInfo id)
308 pprIdBndrInfo :: IdInfo -> SDoc
310 = megaSeqIdInfo info `seq` doc -- The seq is useful for poking on black holes
312 prag_info = inlinePragInfo info
313 occ_info = occInfo info
314 dmd_info = newDemandInfo info
315 lbv_info = lbvarInfo info
317 has_prag = not (isDefaultInlinePragma prag_info)
318 has_occ = not (isNoOcc occ_info)
319 has_dmd = case dmd_info of { Nothing -> False; Just d -> not (isTop d) }
320 has_lbv = not (hasNoLBVarInfo lbv_info)
323 [ (has_prag, ptext (sLit "InlPrag=") <> ppr prag_info)
324 , (has_occ, ptext (sLit "Occ=") <> ppr occ_info)
325 , (has_dmd, ptext (sLit "Dmd=") <> ppr dmd_info)
326 , (has_lbv , ptext (sLit "Lbv=") <> ppr lbv_info)
331 -----------------------------------------------------
332 -- IdDetails and IdInfo
333 -----------------------------------------------------
336 ppIdInfo :: Id -> IdInfo -> SDoc
339 [ (True, pp_scope <> ppr (idDetails id))
340 , (has_arity, ptext (sLit "Arity=") <> int arity)
341 , (has_caf_info, ptext (sLit "Caf=") <> ppr caf_info)
342 , (has_strictness, ptext (sLit "Str=") <> pprNewStrictness str_info)
343 , (has_unf, ptext (sLit "Unf=") <> ppr unf_info)
344 , (not (null rules), ptext (sLit "RULES:") <+> vcat (map pprRule rules))
345 ] -- Inline pragma, occ, demand, lbvar info
346 -- printed out with all binders (when debug is on);
347 -- see PprCore.pprIdBndr
349 pp_scope | isGlobalId id = ptext (sLit "GblId")
350 | isExportedId id = ptext (sLit "LclIdX")
351 | otherwise = ptext (sLit "LclId")
353 arity = arityInfo info
354 has_arity = arity /= 0
356 caf_info = cafInfo info
357 has_caf_info = not (mayHaveCafRefs caf_info)
359 str_info = newStrictnessInfo info
360 has_strictness = isJust str_info
362 unf_info = unfoldingInfo info
363 has_unf = hasSomeUnfolding unf_info
365 rules = specInfoRules (specInfo info)
367 showAttributes :: [(Bool,SDoc)] -> SDoc
370 | otherwise = brackets (sep (punctuate comma docs))
372 docs = [d | (True,d) <- stuff]
375 -----------------------------------------------------
376 -- Unfolding and UnfoldingGuidance
377 -----------------------------------------------------
380 instance Outputable UnfoldingGuidance where
381 ppr UnfoldNever = ptext (sLit "NEVER")
382 ppr (InlineRule { ir_info = info, ir_sat = sat })
383 = ptext (sLit "InlineRule") <> ppr (sat,info)
384 ppr (UnfoldIfGoodArgs { ug_args = cs, ug_size = size, ug_res = discount })
385 = hsep [ ptext (sLit "IF_ARGS"),
386 brackets (hsep (map int cs)),
390 instance Outputable InlSatFlag where
391 ppr InlSat = ptext (sLit "sat")
392 ppr InlUnSat = ptext (sLit "unsat")
394 instance Outputable InlineRuleInfo where
395 ppr (InlWrapper w) = ptext (sLit "worker=") <> ppr w
396 ppr InlSmall = ptext (sLit "small")
397 ppr InlAlways = ptext (sLit "always")
398 ppr InlVanilla = ptext (sLit "-")
400 instance Outputable Unfolding where
401 ppr NoUnfolding = ptext (sLit "No unfolding")
402 ppr (OtherCon cs) = ptext (sLit "OtherCon") <+> ppr cs
403 ppr (DFunUnfolding con ops) = ptext (sLit "DFun") <+> ppr con
404 <+> brackets (pprWithCommas pprParendExpr ops)
405 ppr (CoreUnfolding { uf_tmpl=rhs, uf_is_top=top, uf_is_value=hnf
406 , uf_is_conlike=conlike, uf_is_cheap=cheap
407 , uf_expandable=exp, uf_guidance=g, uf_arity=arity})
408 = ptext (sLit "Unf") <> braces (pp_info $$ pp_rhs)
410 pp_info = fsep $ punctuate comma
411 [ ptext (sLit "TopLvl=") <> ppr top
412 , ptext (sLit "Arity=") <> int arity
413 , ptext (sLit "Value=") <> ppr hnf
414 , ptext (sLit "ConLike=") <> ppr conlike
415 , ptext (sLit "Cheap=") <> ppr cheap
416 , ptext (sLit "Expandable=") <> ppr exp
417 , ptext (sLit "Guidance=") <> ppr g ]
418 pp_tmpl = ptext (sLit "Tmpl=") <+> ppr rhs
420 UnfoldNever -> usually_empty
421 UnfoldIfGoodArgs {} -> usually_empty
423 usually_empty = ifPprDebug pp_tmpl
424 -- In this case show 'rhs' only in debug mode
427 -----------------------------------------------------
429 -----------------------------------------------------
432 instance Outputable CoreRule where
435 pprRules :: [CoreRule] -> SDoc
436 pprRules rules = vcat (map pprRule rules)
438 pprRule :: CoreRule -> SDoc
439 pprRule (BuiltinRule { ru_fn = fn, ru_name = name})
440 = ptext (sLit "Built in rule for") <+> ppr fn <> colon <+> doubleQuotes (ftext name)
442 pprRule (Rule { ru_name = name, ru_act = act, ru_fn = fn,
443 ru_bndrs = tpl_vars, ru_args = tpl_args,
445 = hang (doubleQuotes (ftext name) <+> ppr act)
446 4 (sep [ptext (sLit "forall") <+> braces (sep (map pprTypedBinder tpl_vars)),
447 nest 2 (ppr fn <+> sep (map pprArg tpl_args)),
448 nest 2 (ptext (sLit "=") <+> pprCoreExpr rhs)