Elide some details when printing core for human inspection

Author: timsueberkrueb

effekt/shared/src/main/scala/effekt/core/DeclarationContext.scala

@@ -1,7 +1,7 @@
 package effekt.core
 
 import effekt.util.messages.ErrorReporter
-import PrettyPrinter.*
+import HumanReadablePrettyPrinter.*
 
 /**
  * Context for transformations of a [[core.ModuleDecl]] that provides the declarations for this module.

effekt/shared/src/main/scala/effekt/core/PrettyPrinter.scala

@@ -4,21 +4,14 @@ package core
 import effekt.core.Type.{PromptSymbol, ResumeSymbol}
 import effekt.source.FeatureFlag
 import kiama.output.ParenPrettyPrinter
+import kiama.output.PrettyPrinterTypes.Document
 
 import scala.language.implicitConversions
 import effekt.symbols.{Name, Wildcard, builtins}
 
-object PrettyPrinter extends ParenPrettyPrinter {
-
-  import kiama.output.PrettyPrinterTypes.Document
-
+class PrettyPrinter(humanReadable: Boolean) extends ParenPrettyPrinter {
   override val defaultIndent = 2
 
-  def formatHumanReadable(t: ModuleDecl): Document = {
-    val renamer = effekt.core.TestRenamer(Names(builtins.coreBuiltins))
-    format(renamer(t))
-  }
-
   def format(t: ModuleDecl): Document =
     pretty(toDoc(t), 4)
 
@@ -57,9 +50,9 @@ object PrettyPrinter extends ParenPrettyPrinter {
     // The order of toplevel items must match the parser (where the order is currently fixed).
     val includes = vsep(m.includes.map { im => "import" <+> im })
     val decls = vsep(m.declarations.map(toDoc))
-    val externs = vsep(m.externs.map(toDoc))
+    val externs = if humanReadable then emptyDoc else vsep(m.externs.map(toDoc))
     val defs = toDoc(m.definitions)
-    val exports = vsep(m.exports.map { id => "export" <+> toDoc(id) })
+    val exports = if humanReadable then emptyDoc else vsep(m.exports.map { id => "export" <+> toDoc(id) })
 
     "module" <+> m.path <>
       emptyline <>
@@ -102,7 +95,7 @@ object PrettyPrinter extends ParenPrettyPrinter {
 
   def toDoc(b: Block, preventBraces: Boolean = false): Doc = b match {
     case BlockVar(id, tpe, capt) =>
-      toDoc(id) <> ":" <+> toDoc(tpe) <+> "@" <+> toDoc(capt)
+      toDoc(id) <> (if humanReadable then emptyDoc else ":" <+> toDoc(tpe) <+> "@" <+> toDoc(capt))
     case BlockLit(tps, cps, vps, bps, body) =>
       val doc = space <> paramsToDoc(tps, cps, vps, bps) <+> "=>" <+> nest(line <> toDocStmts(body)) <> line
       if preventBraces then doc else braces { doc }
@@ -124,7 +117,7 @@ object PrettyPrinter extends ParenPrettyPrinter {
     case Literal((), _)            => "()"
     case Literal(s: String, _)     => stringLiteral(s)
     case Literal(value, _)         => value.toString
-    case ValueVar(id, tpe)         => toDoc(id) <> ":" <+> toDoc(tpe)
+    case ValueVar(id, tpe)         => toDoc(id) <> (if humanReadable then emptyDoc else ":" <+> toDoc(tpe))
 
     case PureApp(b, targs, vargs)  => parens(toDoc(b)) <> argsToDoc(targs, vargs, Nil)
     case Make(data, tag, targs, vargs)    => "make" <+> toDoc(data) <+> toDoc(tag) <> argsToDoc(targs, vargs, Nil)
@@ -346,3 +339,18 @@ object PrettyPrinter extends ParenPrettyPrinter {
     multi <> s <> multi
   }
 }
+
+/**
+ * Instance of PrettyPrinter that produces output that can be parsed back by the core parser.
+ */
+object ReparsablePrettyPrinter extends PrettyPrinter(false) {}
+
+/**
+ * Instance of PrettyPrinter that produces less verbose, more human-readable output.
+ */
+object HumanReadablePrettyPrinter extends PrettyPrinter(true) {
+  def renameAndFormat(t: ModuleDecl): Document = {
+    val renamer = effekt.core.TestRenamer(Names(builtins.coreBuiltins))
+    format(renamer(t))
+  }
+}

effekt/shared/src/main/scala/effekt/generator/chez/ChezScheme.scala

@@ -36,7 +36,7 @@ trait ChezScheme extends Compiler[String] {
   override def supportedFeatureFlags: List[String] = List("chez")
 
   override def prettyIR(source: Source, stage: Stage)(using Context): Option[Document] = stage match {
-    case Stage.Core => Core(source).map { res => core.PrettyPrinter.formatHumanReadable(res.core) }
+    case Stage.Core => Core(source).map { res => core.HumanReadablePrettyPrinter.renameAndFormat(res.core) }
     case Stage.CPS => None
     case Stage.Machine => None
     case Stage.Target => Separate(source).map { res => pretty(res) }

effekt/shared/src/main/scala/effekt/generator/chez/ChezSchemeCPS.scala

@@ -14,8 +14,8 @@ class ChezSchemeCPS extends Compiler[String] {
   override def supportedFeatureFlags: List[String] = List("chez", "chezCPS")
 
   override def prettyIR(source: Source, stage: Stage)(using C: Context): Option[Document] = stage match {
-    case Stage.Core if C.config.optimize() => Optimized(source).map { (_, _, res) => core.PrettyPrinter.formatHumanReadable(res) }
-    case Stage.Core => Core(source).map { res => core.PrettyPrinter.formatHumanReadable(res.core) }
+    case Stage.Core if C.config.optimize() => Optimized(source).map { (_, _, res) => core.HumanReadablePrettyPrinter.renameAndFormat(res) }
+    case Stage.Core => Core(source).map { res => core.HumanReadablePrettyPrinter.renameAndFormat(res.core) }
     case Stage.CPS => CPSTransformed(source).map { (_, _, _, res) => cps.PrettyPrinter.format(res) }
     case Stage.Machine => None
     case Stage.Target => LSP(source)

effekt/shared/src/main/scala/effekt/generator/js/JavaScript.scala

@@ -18,9 +18,9 @@ class JavaScript(additionalFeatureFlags: List[String] = Nil) extends Compiler[St
   override def supportedFeatureFlags: List[String] = additionalFeatureFlags ++ TransformerCps.jsFeatureFlags
 
   override def prettyIR(source: Source, stage: Stage)(using C: Context): Option[Document] = stage match {
-    case Stage.Core if C.config.optimize() => Optimized(source).map { (_, _, res) => core.PrettyPrinter.formatHumanReadable(res) }
+    case Stage.Core if C.config.optimize() => Optimized(source).map { (_, _, res) => core.HumanReadablePrettyPrinter.renameAndFormat(res) }
     case Stage.CPS => CPSTransformed(source).map { (_, _, _, res) => cps.PrettyPrinter.format(res) }
-    case Stage.Core => Core(source).map { res => core.PrettyPrinter.formatHumanReadable(res.core) }
+    case Stage.Core => Core(source).map { res => core.HumanReadablePrettyPrinter.renameAndFormat(res.core) }
     case Stage.Machine => None
     case Stage.Target => CompileLSP(source).map { pretty }
   }

effekt/shared/src/main/scala/effekt/generator/llvm/LLVM.scala

@@ -18,7 +18,7 @@ class LLVM extends Compiler[String] {
   override def supportedFeatureFlags: List[String] = Transformer.llvmFeatureFlags
 
   override def prettyIR(source: Source, stage: Stage)(using Context): Option[Document] = stage match {
-    case Stage.Core => steps.afterCore(source).map { res => core.PrettyPrinter.formatHumanReadable(res.core) }
+    case Stage.Core => steps.afterCore(source).map { res => core.HumanReadablePrettyPrinter.renameAndFormat(res.core) }
     case Stage.CPS => None
     case Stage.Machine => steps.afterMachine(source).map { res => machine.PrettyPrinter.format(res.program) }
     case Stage.Target => steps.afterLLVM(source).map { res => pretty(res) }

effekt/shared/src/main/scala/effekt/util/Debug.scala

@@ -14,7 +14,7 @@ val showGeneric: PartialFunction[Any, String] = {
 
 val show: PartialFunction[Any, String] =
   TypePrinter.show orElse
-    core.PrettyPrinter.show orElse
+    core.HumanReadablePrettyPrinter.show orElse
     generator.js.PrettyPrinter.show orElse
     cps.PrettyPrinter.show orElse
     showGeneric