%
-% (c) The AQUA Project, Glasgow University, 1996
+% (c) The AQUA Project, Glasgow University, 1996-1998
%
%************************************************************************
%* *
\begin{code}
module PprCore (
- pprCoreExpr, pprIfaceUnfolding,
- pprCoreBinding, pprCoreBindings,
- pprGenericBindings
+ pprCoreExpr, pprParendExpr,
+ pprCoreBinding, pprCoreBindings, pprIdBndr,
+ pprCoreBinding, pprCoreBindings, pprCoreAlt,
+ pprIdRules, pprCoreRule
) where
#include "HsVersions.h"
import CoreSyn
-import CostCentre ( showCostCentre )
-import Id ( idType, idInfo, isTupleCon,
- DataCon, GenId{-instances-}, Id
- )
-import IdInfo ( ppIdInfo, ppStrictnessInfo )
-import Literal ( Literal{-instances-} )
-import Outputable -- quite a few things
-import PprEnv
+import CostCentre ( pprCostCentreCore )
+import Id ( Id, idType, isDataConId_maybe, idLBVarInfo, idArity,
+ idInfo, idInlinePragma, idOccInfo,
+#ifdef OLD_STRICTNESS
+ idDemandInfo,
+#endif
+ globalIdDetails, isGlobalId, isExportedId,
+ isSpecPragmaId, idNewDemandInfo
+ )
+import Var ( isTyVar )
+import IdInfo ( IdInfo, megaSeqIdInfo,
+ arityInfo, ppArityInfo,
+ specInfo, ppStrictnessInfo,
+ workerInfo, ppWorkerInfo,
+ tyGenInfo, ppTyGenInfo,
+ newStrictnessInfo,
+#ifdef OLD_STRICTNESS
+ cprInfo, ppCprInfo,
+ strictnessInfo,
+#endif
+ )
+import DataCon ( dataConTyCon )
+import TyCon ( tupleTyConBoxity, isTupleTyCon )
import PprType ( pprParendType, pprTyVarBndr )
-import PrimOp ( PrimOp{-instances-} )
-import TyVar ( GenTyVar{-instances-} )
-import Unique ( Unique{-instances-} )
-import Util ( panic{-ToDo:rm-} )
+import BasicTypes ( tupleParens )
+import PprEnv
+import Util ( lengthIs )
+import Outputable
\end{code}
%************************************************************************
Un-annotated core dumps
~~~~~~~~~~~~~~~~~~~~~~~
\begin{code}
-pprCoreBindings :: [CoreBinding] -> SDoc
-pprCoreBinding :: CoreBinding -> SDoc
-pprCoreExpr :: CoreExpr -> SDoc
+pprCoreBindings :: [CoreBind] -> SDoc
+pprCoreBinding :: CoreBind -> SDoc
+pprCoreExpr :: CoreExpr -> SDoc
+pprParendExpr :: CoreExpr -> SDoc
pprCoreBindings = pprTopBinds pprCoreEnv
pprCoreBinding = pprTopBind pprCoreEnv
-pprCoreExpr = ppr_expr pprCoreEnv
+pprCoreExpr = ppr_noparend_expr pprCoreEnv
+pprParendExpr = ppr_parend_expr pprCoreEnv
+pprArg = ppr_arg pprCoreEnv
+pprCoreAlt = ppr_alt pprCoreEnv
-pprCoreEnv = init_ppr_env ppr pprCoreBinder ppr
+pprCoreEnv = initCoreEnv pprCoreBinder
\end{code}
Printer for unfoldings in interfaces
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
\begin{code}
-pprIfaceUnfolding :: CoreExpr -> SDoc
-pprIfaceUnfolding = ppr_expr pprIfaceEnv
-
-pprIfaceEnv = init_ppr_env pprTyVarBndr pprIfaceBinder ppr
-\end{code}
-
-Generic Core (possibly annotated binders etc)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-\begin{code}
-pprGenericBindings :: (Outputable bndr, Outputable occ) => [GenCoreBinding bndr occ flexi] -> SDoc
-pprGenericBindings = pprTopBinds pprGenericEnv
-
-pprGenericEnv :: (Outputable bndr, Outputable occ) => PprEnv flexi bndr occ
-pprGenericEnv = init_ppr_env ppr (\_ -> ppr) ppr
-
-pprGenericArgEnv :: (Outputable occ) => PprEnv flexi bndr occ
-pprGenericArgEnv = init_ppr_env ppr (error "ppr_bndr") ppr
-
-instance (Outputable bndr, Outputable occ) => Outputable (GenCoreBinding bndr occ flexi) where
+instance Outputable b => Outputable (Bind b) where
ppr bind = ppr_bind pprGenericEnv bind
-instance (Outputable bndr, Outputable occ) => Outputable (GenCoreExpr bndr occ flexi) where
- ppr expr = ppr_expr pprGenericEnv expr
+instance Outputable b => Outputable (Expr b) where
+ ppr expr = ppr_noparend_expr pprGenericEnv expr
-instance (Outputable occ) => Outputable (GenCoreArg occ flexi) where
- ppr arg = ppr_arg pprGenericArgEnv arg
-
-instance (Outputable bndr, Outputable occ) => Outputable (GenCoreCaseAlts bndr occ flexi) where
- ppr alts = ppr_alts pprGenericEnv alts
-
-instance (Outputable bndr, Outputable occ) => Outputable (GenCoreCaseDefault bndr occ flexi) where
- ppr deflt = ppr_default pprGenericEnv deflt
+pprGenericEnv :: Outputable b => PprEnv b
+pprGenericEnv = initCoreEnv (\site -> ppr)
\end{code}
-
%************************************************************************
%* *
\subsection{Instance declarations for Core printing}
\begin{code}
-init_ppr_env tvbndr pbdr pocc
+initCoreEnv pbdr
= initPprEnv
- (Just ppr) -- literals
- (Just ppr) -- data cons
- (Just ppr_prim) -- primops
- (Just (\ cc -> text (showCostCentre True cc)))
+ (Just pprCostCentreCore) -- Cost centres
- (Just tvbndr) -- tyvar binders
(Just ppr) -- tyvar occs
(Just pprParendType) -- types
- (Just pbdr) (Just pocc) -- value vars
- where
-
- -- We add a "!" to distinguish Primitive applications from ordinary applications.
- -- But not when printing for interfaces, where they are treated
- -- as ordinary applications
- ppr_prim prim = getPprStyle (\sty -> if ifaceStyle sty then
- ppr prim
- else
- ppr prim <> char '!')
-
+ (Just pbdr) (Just ppr) -- value vars
+ -- Use pprIdBndr for this last one as a debugging device.
\end{code}
%************************************************************************
pprTopBinds pe binds = vcat (map (pprTopBind pe) binds)
pprTopBind pe (NonRec binder expr)
- = sep [ppr_binding_pe pe (binder,expr)] $$ text ""
+ = ppr_binding_pe pe (binder,expr) $$ text ""
pprTopBind pe (Rec binds)
= vcat [ptext SLIT("Rec {"),
\end{code}
\begin{code}
+ppr_bind :: PprEnv b -> Bind b -> SDoc
+
ppr_bind pe (NonRec val_bdr expr) = ppr_binding_pe pe (val_bdr, expr)
ppr_bind pe (Rec binds) = vcat (map pp binds)
where
pp bind = ppr_binding_pe pe bind <> semi
+ppr_binding_pe :: PprEnv b -> (b, Expr b) -> SDoc
ppr_binding_pe pe (val_bdr, expr)
- = sep [pValBndr pe LetBind val_bdr,
- nest 2 (equals <+> ppr_expr pe expr)]
+ = sep [pBndr pe LetBind val_bdr,
+ nest 2 (equals <+> ppr_noparend_expr pe expr)]
\end{code}
\begin{code}
-ppr_parend_expr pe expr
- = let
- parenify
- = case expr of
- Var _ -> id -- leave unchanged
- Lit _ -> id
- _ -> parens -- wraps in parens
- in
- parenify (ppr_expr pe expr)
+ppr_parend_expr pe expr = ppr_expr parens pe expr
+ppr_noparend_expr pe expr = ppr_expr noParens pe expr
+
+noParens :: SDoc -> SDoc
+noParens pp = pp
\end{code}
\begin{code}
-ppr_expr pe (Var name) = pOcc pe name
-ppr_expr pe (Lit lit) = pLit pe lit
-
-ppr_expr pe (Con con args)
- = pCon pe con <+> (braces $ sep (map (ppr_arg pe) args))
+ppr_expr :: (SDoc -> SDoc) -> PprEnv b -> Expr b -> SDoc
+ -- The function adds parens in context that need
+ -- an atomic value (e.g. function args)
-ppr_expr pe (Prim prim args)
- = pPrim pe prim <+> (sep (map (ppr_arg pe) args))
+ppr_expr add_par pe (Type ty) = add_par (ptext SLIT("TYPE") <+> ppr ty) -- Wierd
+
+ppr_expr add_par pe (Var name) = pOcc pe name
+ppr_expr add_par pe (Lit lit) = ppr lit
-ppr_expr pe expr@(Lam _ _)
+ppr_expr add_par pe expr@(Lam _ _)
= let
- (tyvars, vars, body) = collectBinders expr
+ (bndrs, body) = collectBinders expr
in
- hang (hsep [pp_vars SLIT("_/\\_") (pTyVarB pe) tyvars,
- pp_vars SLIT("\\") (pValBndr pe LambdaBind) vars])
- 4 (ppr_expr pe body)
- where
- pp_vars lam pp [] = empty
- pp_vars lam pp vs
- = hsep [ptext lam, hsep (map pp vs), ptext SLIT("->")]
-
-ppr_expr pe expr@(App fun arg)
- = let
- (final_fun, final_args) = go fun [arg]
- go (App fun arg) args_so_far = go fun (arg:args_so_far)
- go fun args_so_far = (fun, args_so_far)
+ add_par $
+ hang (ptext SLIT("\\") <+> sep (map (pBndr pe LambdaBind) bndrs) <+> arrow)
+ 2 (ppr_noparend_expr pe body)
+
+ppr_expr add_par pe expr@(App fun arg)
+ = case collectArgs expr of { (fun, args) ->
+ let
+ pp_args = sep (map (ppr_arg pe) args)
+ val_args = dropWhile isTypeArg args -- Drop the type arguments for tuples
+ pp_tup_args = sep (punctuate comma (map (ppr_arg pe) val_args))
in
- hang (ppr_parend_expr pe final_fun) 4 (sep (map (ppr_arg pe) final_args))
-
-ppr_expr pe (Case expr alts)
- | only_one_alt alts
- -- johan thinks that single case patterns should be on same line as case,
- -- and no indent; all sane persons agree with him.
- = let
- ppr_bndr = pValBndr pe CaseBind
-
- ppr_alt (AlgAlts [] (BindDefault n _)) = (<>) (ppr_bndr n) ppr_arrow
- ppr_alt (PrimAlts [] (BindDefault n _)) = (<>) (ppr_bndr n) ppr_arrow
- ppr_alt (PrimAlts ((l, _):[]) NoDefault)= (<>) (pLit pe l) ppr_arrow
- ppr_alt (AlgAlts ((con, params, _):[]) NoDefault)
- = hsep [pCon pe con,
- hsep (map ppr_bndr params),
- ppr_arrow]
-
- ppr_rhs (AlgAlts [] (BindDefault _ expr)) = ppr_expr pe expr
- ppr_rhs (AlgAlts ((_,_,expr):[]) NoDefault) = ppr_expr pe expr
- ppr_rhs (PrimAlts [] (BindDefault _ expr)) = ppr_expr pe expr
- ppr_rhs (PrimAlts ((_,expr):[]) NoDefault) = ppr_expr pe expr
-
-
- ppr_arrow = ptext SLIT(" ->")
- in
- sep
- [sep [pp_keyword, nest 4 (ppr_expr pe expr), text "of {", ppr_alt alts],
- (<>) (ppr_rhs alts) (text ";}")]
-
- | otherwise -- default "case" printing
- = sep
- [sep [pp_keyword, nest 4 (ppr_expr pe expr), ptext SLIT("of {")],
- nest 2 (ppr_alts pe alts),
- text "}"]
+ case fun of
+ Var f -> case isDataConId_maybe f of
+ -- Notice that we print the *worker*
+ -- for tuples in paren'd format.
+ Just dc | saturated && isTupleTyCon tc
+ -> tupleParens (tupleTyConBoxity tc) pp_tup_args
+ where
+ tc = dataConTyCon dc
+ saturated = val_args `lengthIs` idArity f
+
+ other -> add_par (hang (pOcc pe f) 2 pp_args)
+
+ other -> add_par (hang (ppr_parend_expr pe fun) 2 pp_args)
+ }
+
+ppr_expr add_par pe (Case expr var [(con,args,rhs)])
+ = add_par $
+ sep [sep [ptext SLIT("case") <+> ppr_noparend_expr pe expr,
+ hsep [ptext SLIT("of"),
+ ppr_bndr var,
+ char '{',
+ ppr_case_pat pe con args
+ ]],
+ ppr_noparend_expr pe rhs,
+ char '}'
+ ]
+ where
+ ppr_bndr = pBndr pe CaseBind
+
+ppr_expr add_par pe (Case expr var alts)
+ = add_par $
+ sep [sep [ptext SLIT("case") <+> ppr_noparend_expr pe expr,
+ ptext SLIT("of") <+> ppr_bndr var <+> char '{'],
+ nest 2 (sep (punctuate semi (map (ppr_alt pe) alts))),
+ char '}'
+ ]
where
- pp_keyword = case alts of
- AlgAlts _ _ -> ptext SLIT("case")
- PrimAlts _ _ -> ptext SLIT("case#")
+ ppr_bndr = pBndr pe CaseBind
+
-- special cases: let ... in let ...
-- ("disgusting" SLPJ)
-ppr_expr pe (Let bind@(NonRec val_bdr rhs@(Let _ _)) body)
- = vcat [
- hsep [ptext SLIT("let {"), pValBndr pe LetBind val_bdr, equals],
- nest 2 (ppr_expr pe rhs),
+ppr_expr add_par pe (Let bind@(NonRec val_bdr rhs@(Let _ _)) body)
+ = add_par $
+ vcat [
+ hsep [ptext SLIT("let {"), pBndr pe LetBind val_bdr, equals],
+ nest 2 (ppr_noparend_expr pe rhs),
ptext SLIT("} in"),
- ppr_expr pe body ]
+ ppr_noparend_expr pe body ]
-ppr_expr pe (Let bind@(NonRec val_bdr rhs) expr@(Let _ _))
- = ($$)
- (hang (ptext SLIT("let {"))
- 2 (hsep [hang (hsep [pValBndr pe LetBind val_bdr, equals])
- 4 (ppr_expr pe rhs),
- ptext SLIT("} in")]))
- (ppr_expr pe expr)
+ppr_expr add_par pe (Let bind@(NonRec val_bdr rhs) expr@(Let _ _))
+ = add_par
+ (hang (ptext SLIT("let {"))
+ 2 (hsep [hang (hsep [pBndr pe LetBind val_bdr, equals])
+ 2 (ppr_noparend_expr pe rhs),
+ ptext SLIT("} in")])
+ $$
+ ppr_noparend_expr pe expr)
-- general case (recursive case, too)
-ppr_expr pe (Let bind expr)
- = sep [hang (ptext keyword) 2 (ppr_bind pe bind),
- hang (ptext SLIT("} in ")) 2 (ppr_expr pe expr)]
+ppr_expr add_par pe (Let bind expr)
+ = add_par $
+ sep [hang (ptext keyword) 2 (ppr_bind pe bind),
+ hang (ptext SLIT("} in ")) 2 (ppr_noparend_expr pe expr)]
where
keyword = case bind of
- Rec _ -> SLIT("_letrec_ {")
+ Rec _ -> SLIT("__letrec {")
NonRec _ _ -> SLIT("let {")
-ppr_expr pe (Note (SCC cc) expr)
- = sep [hsep [ptext SLIT("_scc_"), pSCC pe cc],
- ppr_parend_expr pe expr ]
-
-ppr_expr pe (Note (Coerce to_ty from_ty) expr)
- = sep [hsep [ptext SLIT("_coerce_"), pTy pe to_ty, pTy pe from_ty],
+ppr_expr add_par pe (Note (SCC cc) expr)
+ = add_par (sep [pSCC pe cc, ppr_noparend_expr pe expr])
+
+#ifdef DEBUG
+ppr_expr add_par pe (Note (Coerce to_ty from_ty) expr)
+ = add_par $
+ getPprStyle $ \ sty ->
+ if debugStyle sty then
+ sep [ptext SLIT("__coerce") <+> sep [pTy pe to_ty, pTy pe from_ty],
+ ppr_parend_expr pe expr]
+ else
+ sep [hsep [ptext SLIT("__coerce"), pTy pe to_ty],
+ ppr_parend_expr pe expr]
+#else
+ppr_expr add_par pe (Note (Coerce to_ty from_ty) expr)
+ = add_par $
+ sep [sep [ptext SLIT("__coerce"), nest 2 (pTy pe to_ty)],
ppr_parend_expr pe expr]
+#endif
-ppr_expr pe (Note InlineCall expr)
- = ptext SLIT("_inline_") <+> ppr_parend_expr pe expr
+ppr_expr add_par pe (Note InlineCall expr)
+ = add_par (ptext SLIT("__inline_call") <+> ppr_parend_expr pe expr)
-only_one_alt (AlgAlts [] (BindDefault _ _)) = True
-only_one_alt (AlgAlts (_:[]) NoDefault) = True
-only_one_alt (PrimAlts [] (BindDefault _ _)) = True
-only_one_alt (PrimAlts (_:[]) NoDefault) = True
-only_one_alt _ = False
-\end{code}
+ppr_expr add_par pe (Note InlineMe expr)
+ = add_par $ ptext SLIT("__inline_me") <+> ppr_parend_expr pe expr
-\begin{code}
-ppr_alts pe (AlgAlts alts deflt)
- = vcat [ vcat (map ppr_alt alts), ppr_default pe deflt ]
+ppr_alt pe (con, args, rhs)
+ = hang (ppr_case_pat pe con args) 2 (ppr_noparend_expr pe rhs)
+
+ppr_case_pat pe con@(DataAlt dc) args
+ | isTupleTyCon tc
+ = tupleParens (tupleTyConBoxity tc) (hsep (punctuate comma (map ppr_bndr args))) <+> arrow
where
- ppr_arrow = ptext SLIT("->")
- ppr_bndr = pValBndr pe CaseBind
-
- ppr_alt (con, params, expr)
- = hang (if isTupleCon con then
- hsep [parens (hsep (punctuate comma (map ppr_bndr params))),
- ppr_arrow]
- else
- hsep [pCon pe con,
- hsep (map ppr_bndr params),
- ppr_arrow]
- )
- 4 (ppr_expr pe expr <> semi)
-
-ppr_alts pe (PrimAlts alts deflt)
- = vcat [ vcat (map ppr_alt alts), ppr_default pe deflt ]
+ ppr_bndr = pBndr pe CaseBind
+ tc = dataConTyCon dc
+
+ppr_case_pat pe con args
+ = ppr con <+> hsep (map ppr_bndr args) <+> arrow
where
- ppr_alt (lit, expr)
- = hang (hsep [pLit pe lit, ptext SLIT("->")])
- 4 (ppr_expr pe expr <> semi)
-\end{code}
+ ppr_bndr = pBndr pe CaseBind
-\begin{code}
-ppr_default pe NoDefault = empty
+ppr_arg pe (Type ty) = ptext SLIT("@") <+> pTy pe ty
+ppr_arg pe expr = ppr_parend_expr pe expr
-ppr_default pe (BindDefault val_bdr expr)
- = hang (hsep [pValBndr pe CaseBind val_bdr, ptext SLIT("->")])
- 4 (ppr_expr pe expr <> semi)
-\end{code}
-
-\begin{code}
-ppr_arg pe (LitArg lit) = pLit pe lit
-ppr_arg pe (VarArg v) = pOcc pe v
-ppr_arg pe (TyArg ty) = ptext SLIT("_@_ ") <> pTy pe ty
+arrow = ptext SLIT("->")
\end{code}
Other printing bits-and-bobs used with the general @pprCoreBinding@
\begin{code}
-- Used for printing dump info
pprCoreBinder LetBind binder
- = vcat [sig, pragmas, ppr binder]
+ = vcat [sig, pprIdDetails binder, pragmas, ppr binder]
where
sig = pprTypedBinder binder
- pragmas = ppIdInfo False{-no specs, thanks-} (idInfo binder)
+ pragmas = ppIdInfo binder (idInfo binder)
-pprCoreBinder LambdaBind binder = pprTypedBinder binder
-pprCoreBinder CaseBind binder = ppr binder
+-- Lambda bound type variables are preceded by "@"
+pprCoreBinder LambdaBind bndr = pprTypedBinder bndr
+-- Case bound things don't get a signature or a herald
+pprCoreBinder CaseBind bndr = pprUntypedBinder bndr
--- Used for printing interface-file unfoldings
-pprIfaceBinder CaseBind binder = ppr binder
-pprIfaceBinder other binder = pprTypedBinder binder
+pprUntypedBinder binder
+ | isTyVar binder = ptext SLIT("@") <+> ppr binder -- NB: don't print kind
+ | otherwise = pprIdBndr binder
pprTypedBinder binder
- = ppr binder <+> ptext SLIT("::") <+> pprParendType (idType binder)
+ | isTyVar binder = ptext SLIT("@") <+> pprTyVarBndr binder
+ | otherwise = pprIdBndr binder <+> dcolon <+> pprParendType (idType binder)
-- The space before the :: is important; it helps the lexer
-- when reading inferfaces. Otherwise it would lex "a::b" as one thing.
--
-- It's important that the type is parenthesised too, at least when
-- printing interfaces, because we get \ x::(a->b) y::(c->d) -> ...
+
+-- pprIdBndr does *not* print the type
+-- When printing any Id binder in debug mode, we print its inline pragma and one-shot-ness
+pprIdBndr id = ppr id <+>
+ (megaSeqIdInfo (idInfo id) `seq`
+ -- Useful for poking on black holes
+ ifPprDebug (ppr (idInlinePragma id) <+> ppr (idOccInfo id) <+>
+#ifdef OLD_STRICTNESS
+ ppr (idDemandInfo id) <+>
+#endif
+ ppr (idNewDemandInfo id) <+>
+ ppr (idLBVarInfo id)))
+\end{code}
+
+
+\begin{code}
+pprIdDetails :: Id -> SDoc
+pprIdDetails id | isGlobalId id = ppr (globalIdDetails id)
+ | isExportedId id = ptext SLIT("[Exported]")
+ | isSpecPragmaId id = ptext SLIT("[SpecPrag]")
+ | otherwise = empty
+
+ppIdInfo :: Id -> IdInfo -> SDoc
+ppIdInfo b info
+ = hsep [ ppArityInfo a,
+ ppTyGenInfo g,
+ ppWorkerInfo (workerInfo info),
+#ifdef OLD_STRICTNESS
+ ppStrictnessInfo s,
+ ppCprInfo m,
+#endif
+ ppr (newStrictnessInfo info),
+ vcat (map (pprCoreRule (ppr b)) (rulesRules p))
+ -- Inline pragma, occ, demand, lbvar info
+ -- printed out with all binders (when debug is on);
+ -- see PprCore.pprIdBndr
+ ]
+ where
+ a = arityInfo info
+ g = tyGenInfo info
+#ifdef OLD_STRICTNESS
+ s = strictnessInfo info
+ m = cprInfo info
+#endif
+ p = specInfo info
+\end{code}
+
+
+\begin{code}
+pprIdRules :: [IdCoreRule] -> SDoc
+pprIdRules rules = vcat (map pprIdRule rules)
+
+pprIdRule :: IdCoreRule -> SDoc
+pprIdRule (id,rule) = pprCoreRule (ppr id) rule
+
+pprCoreRule :: SDoc -> CoreRule -> SDoc
+pprCoreRule pp_fn (BuiltinRule name _)
+ = ifPprDebug (ptext SLIT("Built in rule for") <+> pp_fn <> colon <+> doubleQuotes (ptext name))
+
+pprCoreRule pp_fn (Rule name act tpl_vars tpl_args rhs)
+ = doubleQuotes (ptext name) <+> ppr act <+>
+ sep [
+ ptext SLIT("__forall") <+> braces (sep (map pprTypedBinder tpl_vars)),
+ nest 2 (pp_fn <+> sep (map pprArg tpl_args)),
+ nest 2 (ptext SLIT("=") <+> pprCoreExpr rhs)
+ ] <+> semi
\end{code}