Add Outputable.blankLine and use it
[ghc-hetmet.git] / compiler / coreSyn / PprCore.lhs
index a3c1f6f..84bf868 100644 (file)
@@ -12,8 +12,6 @@ module PprCore (
        pprRules
     ) where
 
-#include "HsVersions.h"
-
 import CoreSyn
 import CostCentre
 import Var
@@ -29,6 +27,7 @@ import DataCon
 import TyCon
 import Type
 import Coercion
+import StaticFlags
 import BasicTypes
 import Util
 import Outputable
@@ -67,16 +66,21 @@ instance OutputableBndr b => Outputable (Expr b) where
 %************************************************************************
 
 \begin{code}
+pprTopBinds :: OutputableBndr a => [Bind a] -> SDoc
 pprTopBinds binds = vcat (map pprTopBind binds)
 
+pprTopBind :: OutputableBndr a => Bind a -> SDoc
 pprTopBind (NonRec binder expr)
- = ppr_binding (binder,expr) $$ text ""
-
-pprTopBind (Rec binds)
-  = vcat [ptext SLIT("Rec {"),
-         vcat (map ppr_binding binds),
-         ptext SLIT("end Rec }"),
-         text ""]
+ = ppr_binding (binder,expr) $$ blankLine
+
+pprTopBind (Rec [])
+  = ptext (sLit "Rec { }")
+pprTopBind (Rec (b:bs))
+  = vcat [ptext (sLit "Rec {"),
+         ppr_binding b,
+         vcat [blankLine $$ ppr_binding b | b <- bs],
+         ptext (sLit "end Rec }"),
+         blankLine]
 \end{code}
 
 \begin{code}
@@ -106,17 +110,19 @@ ppr_expr :: OutputableBndr b => (SDoc -> SDoc) -> Expr b -> SDoc
        -- The function adds parens in context that need
        -- an atomic value (e.g. function args)
 
-ppr_expr add_par (Type ty)  = add_par (ptext SLIT("TYPE") <+> ppr ty)  -- Wierd
+ppr_expr add_par (Type ty)  = add_par (ptext (sLit "TYPE") <+> ppr ty) -- Wierd
                   
-ppr_expr add_par (Var name) = ppr name
-ppr_expr add_par (Lit lit)  = ppr lit
+ppr_expr _       (Var name) = ppr name
+ppr_expr _       (Lit lit)  = ppr lit
 
 ppr_expr add_par (Cast expr co) 
   = add_par $
     sep [pprParendExpr expr, 
-        ptext SLIT("`cast`") <+> parens (pprCo co)]
+        ptext (sLit "`cast`") <+> pprCo co]
   where
-    pprCo co = sep [ppr co, dcolon <+> ppr (coercionKindPredTy co)]
+    pprCo co | opt_SuppressCoercions = ptext (sLit "...")
+             | otherwise = parens
+                         $ sep [ppr co, dcolon <+> ppr (coercionKindPredTy co)]
         
 
 ppr_expr add_par expr@(Lam _ _)
@@ -124,10 +130,10 @@ ppr_expr add_par expr@(Lam _ _)
        (bndrs, body) = collectBinders expr
     in
     add_par $
-    hang (ptext SLIT("\\") <+> sep (map (pprBndr LambdaBind) bndrs) <+> arrow)
+    hang (ptext (sLit "\\") <+> sep (map (pprBndr LambdaBind) bndrs) <+> arrow)
         2 (pprCoreExpr body)
 
-ppr_expr add_par expr@(App fun arg)
+ppr_expr add_par expr@(App {})
   = case collectArgs expr of { (fun, args) -> 
     let
        pp_args     = sep (map pprArg args)
@@ -144,16 +150,16 @@ ppr_expr add_par expr@(App fun arg)
                             tc        = dataConTyCon dc
                             saturated = val_args `lengthIs` idArity f
 
-                  other -> add_par (hang (ppr f) 2 pp_args)
+                  _ -> add_par (hang (ppr f) 2 pp_args)
 
-       other -> add_par (hang (pprParendExpr fun) 2 pp_args)
+       _ -> add_par (hang (pprParendExpr fun) 2 pp_args)
     }
 
 ppr_expr add_par (Case expr var ty [(con,args,rhs)])
   = add_par $
-    sep [sep [ptext SLIT("case") <+> pprCoreExpr expr,
+    sep [sep [ptext (sLit "case") <+> pprCoreExpr expr,
              ifPprDebug (braces (ppr ty)),
-             sep [ptext SLIT("of") <+> ppr_bndr var, 
+             sep [ptext (sLit "of") <+> ppr_bndr var, 
                   char '{' <+> ppr_case_pat con args]
          ],
         pprCoreExpr rhs,
@@ -164,10 +170,10 @@ ppr_expr add_par (Case expr var ty [(con,args,rhs)])
 
 ppr_expr add_par (Case expr var ty alts)
   = add_par $
-    sep [sep [ptext SLIT("case")
+    sep [sep [ptext (sLit "case")
                <+> pprCoreExpr expr
                <+> ifPprDebug (braces (ppr ty)),
-             ptext SLIT("of") <+> ppr_bndr var <+> char '{'],
+             ptext (sLit "of") <+> ppr_bndr var <+> char '{'],
         nest 2 (sep (punctuate semi (map pprCoreAlt alts))),
         char '}'
     ]
@@ -182,45 +188,47 @@ ppr_expr add_par (Case expr var ty alts)
 ppr_expr add_par (Let bind@(NonRec val_bdr rhs@(Let _ _)) body)
   = add_par $
     vcat [
-      hsep [ptext SLIT("let {"), (pprBndr LetBind val_bdr $$ ppr val_bndr), equals],
+      hsep [ptext (sLit "let {"), (pprBndr LetBind val_bdr $$ ppr val_bndr), equals],
       nest 2 (pprCoreExpr rhs),
-      ptext SLIT("} in"),
+      ptext (sLit "} in"),
       pprCoreExpr body ]
--}
 
 ppr_expr add_par (Let bind@(NonRec val_bdr rhs) expr@(Let _ _))
   = add_par
-    (hang (ptext SLIT("let {"))
+    (hang (ptext (sLit "let {"))
          2 (hsep [ppr_binding (val_bdr,rhs),
-                  ptext SLIT("} in")])
+                  ptext (sLit "} in")])
      $$
      pprCoreExpr expr)
+-}
 
--- general case (recursive case, too)
+-- General case (recursive case, too)
 ppr_expr add_par (Let bind expr)
   = add_par $
-    sep [hang (ptext keyword) 2 (ppr_bind bind),
-        hang (ptext SLIT("} in ")) 2 (pprCoreExpr expr)]
+    sep [hang (ptext keyword) 2 (ppr_bind bind <+> ptext (sLit "} in")),
+        pprCoreExpr expr]
   where
     keyword = case bind of
-               Rec _      -> SLIT("__letrec {")
-               NonRec _ _ -> SLIT("let {")
+               Rec _      -> (sLit "letrec {")
+               NonRec _ _ -> (sLit "let {")
 
 ppr_expr add_par (Note (SCC cc) expr)
   = add_par (sep [pprCostCentreCore cc, pprCoreExpr expr])
 
 ppr_expr add_par (Note InlineMe expr)
-  = add_par $ ptext SLIT("__inline_me") <+> pprParendExpr expr
+  = add_par $ ptext (sLit "__inline_me") <+> pprParendExpr expr
 
 ppr_expr add_par (Note (CoreNote s) expr)
   = add_par $ 
-    sep [sep [ptext SLIT("__core_note"), pprHsString (mkFastString s)],
+    sep [sep [ptext (sLit "__core_note"), pprHsString (mkFastString s)],
          pprParendExpr expr]
 
+pprCoreAlt :: OutputableBndr a => (AltCon, [a] , Expr a) -> SDoc
 pprCoreAlt (con, args, rhs) 
   = hang (ppr_case_pat con args) 2 (pprCoreExpr rhs)
 
-ppr_case_pat con@(DataAlt dc) args
+ppr_case_pat :: OutputableBndr a => AltCon -> [a] -> SDoc
+ppr_case_pat (DataAlt dc) args
   | isTupleTyCon tc
   = tupleParens (tupleTyConBoxity tc) (hsep (punctuate comma (map ppr_bndr args))) <+> arrow
   where
@@ -232,7 +240,8 @@ ppr_case_pat con args
   where
     ppr_bndr = pprBndr CaseBind
 
-pprArg (Type ty) = ptext SLIT("@") <+> pprParendType ty
+pprArg :: OutputableBndr a => Expr a -> SDoc
+pprArg (Type ty) = ptext (sLit "@") <+> pprParendType ty
 pprArg expr      = pprParendExpr expr
 \end{code}
 
@@ -245,13 +254,23 @@ instance OutputableBndr Var where
 
 pprCoreBinder :: BindingSite -> Var -> SDoc
 pprCoreBinder LetBind binder
-  = vcat [sig, pprIdDetails binder, pragmas]
+  | isTyVar binder = pprKindedTyVarBndr binder
+  | otherwise
+  = vcat [sig, pprIdExtras binder, pragmas]
   where
     sig     = pprTypedBinder binder
     pragmas = ppIdInfo binder (idInfo binder)
 
 -- Lambda bound type variables are preceded by "@"
-pprCoreBinder LambdaBind bndr = parens (pprTypedBinder bndr)
+pprCoreBinder LambdaBind bndr 
+  | isDeadBinder bndr
+  = getPprStyle $ \ sty ->
+    if debugStyle sty then
+       parens (pprTypedBinder bndr)
+    else
+       char '_'
+  | otherwise
+  = parens (pprTypedBinder bndr)
 
 -- Case bound things don't get a signature or a herald, unless we have debug on
 pprCoreBinder CaseBind bndr 
@@ -259,40 +278,45 @@ pprCoreBinder CaseBind bndr
     if debugStyle sty then
        parens (pprTypedBinder bndr)
     else
-       pprUntypedBinder bndr
+       if isDeadBinder bndr then char '_'
+       else pprUntypedBinder bndr
 
+pprUntypedBinder :: Var -> SDoc
 pprUntypedBinder binder
-  | isTyVar binder = ptext SLIT("@") <+> ppr binder    -- NB: don't print kind
+  | isTyVar binder = ptext (sLit "@") <+> ppr binder   -- NB: don't print kind
   | otherwise      = pprIdBndr binder
 
+pprTypedBinder :: Var -> SDoc
+-- Print binder with a type or kind signature (not paren'd)
 pprTypedBinder binder
-  | isTyVar binder  = ptext SLIT("@") <+> pprTyVarBndr binder
+  | isTyVar binder  = pprKindedTyVarBndr binder
   | otherwise      = pprIdBndr binder <+> dcolon <+> pprType (idType binder)
 
-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
+pprKindedTyVarBndr :: TyVar -> SDoc
+-- Print a type variable binder with its kind (but not if *)
+pprKindedTyVarBndr tyvar
+  = ptext (sLit "@") <+> ppr tyvar <> opt_kind
   where
+    opt_kind   -- Print the kind if not *
+       | isLiftedTypeKind kind = empty
+       | otherwise = dcolon <> pprKind kind
     kind = tyVarKind tyvar
 
 -- 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 -> SDoc
 pprIdBndr id = ppr id <+> pprIdBndrInfo (idInfo id)
 
+pprIdBndrInfo :: IdInfo -> SDoc
 pprIdBndrInfo info 
-  = megaSeqIdInfo `seq` doc -- The seq is useful for poking on black holes
+  = megaSeqIdInfo info `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 && 
+    no_info = isDefaultInlinePragma prag_info && isNoOcc occ_info && 
              (case dmd_info of { Nothing -> True; Just d -> isTop d }) &&
              hasNoLBVarInfo lbv_info
 
@@ -308,13 +332,15 @@ pprIdBndrInfo info
 
 
 \begin{code}
-pprIdDetails :: Id -> SDoc
-pprIdDetails id | isGlobalId id     = ppr (globalIdDetails id)
-               | isExportedId id   = ptext SLIT("[Exported]")
-               | otherwise         = empty
+pprIdExtras :: Id -> SDoc
+pprIdExtras id = pp_scope <> ppr (idDetails id)
+  where
+    pp_scope | isGlobalId id   = ptext (sLit "GblId")
+            | isExportedId id = ptext (sLit "LclIdX")
+            | otherwise       = ptext (sLit "LclId")
 
 ppIdInfo :: Id -> IdInfo -> SDoc
-ppIdInfo b info
+ppIdInfo _ info
   = brackets $
     vcat [  ppArityInfo a,
            ppWorkerInfo (workerInfo info),
@@ -325,7 +351,7 @@ ppIdInfo b info
 #endif
            pprNewStrictness (newStrictnessInfo info),
            if null rules then empty
-           else ptext SLIT("RULES:") <+> vcat (map pprRule rules)
+           else ptext (sLit "RULES:") <+> vcat (map pprRule rules)
        -- Inline pragma, occ, demand, lbvar info
        -- printed out with all binders (when debug is on); 
        -- see PprCore.pprIdBndr
@@ -349,14 +375,14 @@ pprRules rules = vcat (map pprRule rules)
 
 pprRule :: CoreRule -> SDoc
 pprRule (BuiltinRule { ru_fn = fn, ru_name = name})
-  = ptext SLIT("Built in rule for") <+> ppr fn <> colon <+> doubleQuotes (ftext name)
+  = ptext (sLit "Built in rule for") <+> ppr fn <> colon <+> doubleQuotes (ftext name)
 
 pprRule (Rule { ru_name = name, ru_act = act, ru_fn = fn,
                ru_bndrs = tpl_vars, ru_args = tpl_args,
                ru_rhs = rhs })
   = hang (doubleQuotes (ftext name) <+> ppr act)
-       4 (sep [ptext SLIT("forall") <+> braces (sep (map pprTypedBinder tpl_vars)),
+       4 (sep [ptext (sLit "forall") <+> braces (sep (map pprTypedBinder tpl_vars)),
               nest 2 (ppr fn <+> sep (map pprArg tpl_args)),
-              nest 2 (ptext SLIT("=") <+> pprCoreExpr rhs)
+              nest 2 (ptext (sLit "=") <+> pprCoreExpr rhs)
            ])
 \end{code}