sbt.internal.inc.Problem: add "rendered" field

See sbt/util#175 for more information.

Author: smarter

internal/zinc-compile-core/src/main/scala/sbt/internal/inc/FilteredReporter.scala

@@ -78,15 +78,20 @@ class FilteredReporter(
    * registered as problems so that users of `problems()` receive them.
    */
   override def log(problem: Problem): Unit = {
-    val (category, position, message, severity) =
-      (problem.category, problem.position, problem.message, problem.severity)
+    import sbt.util.InterfaceUtil
+
+    val (category, position, message, severity, rendered) =
+      (problem.category,
+       problem.position,
+       problem.message,
+       problem.severity,
+       InterfaceUtil.jo2o(problem.rendered))
     val dontShow = isFiltered(position, message, severity)
     if (!dontShow) super.log(problem)
     else {
       // Even if we don't display, we do want to register the problem
-      import sbt.util.InterfaceUtil
       val transformedPos: Position = positionMapper(position)
-      val problem = InterfaceUtil.problem(category, transformedPos, message, severity)
+      val problem = InterfaceUtil.problem(category, transformedPos, message, severity, rendered)
       allProblems += problem
       ()
     }

internal/zinc-compile-core/src/main/scala/sbt/internal/inc/LoggedReporter.scala

@@ -21,11 +21,11 @@ import scala.collection.mutable
 import LoggedReporter._
 import sbt.internal.util.ManagedLogger
 import sbt.internal.util.codec._
+import sbt.util.InterfaceUtil.jo2o
 import Severity.{ Error, Warn, Info => SInfo }
 
 object LoggedReporter {
   final class PositionKey(pos: Position) {
-    import sbt.util.InterfaceUtil.jo2o
     def offset = pos.offset
     def sourceFile = pos.sourceFile
 
@@ -121,11 +121,15 @@ class LoggedReporter(
 
   override def log(problem0: Problem): Unit = {
     import sbt.util.InterfaceUtil
-    val (category, position, message, severity) =
-      (problem0.category, problem0.position, problem0.message, problem0.severity)
+    val (category, position, message, severity, rendered) =
+      (problem0.category,
+       problem0.position,
+       problem0.message,
+       problem0.severity,
+       jo2o(problem0.rendered))
     // Note: positions in reported errors can be fixed with `sourcePositionMapper`.
     val transformedPos: Position = sourcePositionMapper(position)
-    val problem = InterfaceUtil.problem(category, transformedPos, message, severity)
+    val problem = InterfaceUtil.problem(category, transformedPos, message, severity, rendered)
     allProblems += problem
     severity match {
       case Warn | Error =>

internal/zinc-compile-core/src/main/scala/sbt/internal/inc/ProblemStringFormats.scala

@@ -20,21 +20,22 @@ import sbt.util.InterfaceUtil.jo2o
 trait ProblemStringFormats {
   implicit lazy val ProblemStringFormat: ShowLines[Problem] = new ShowLines[Problem] {
     def showLines(p: Problem): Seq[String] =
-      p match {
-        case p if !p.position.sourcePath.isPresent && !p.position.line.isPresent =>
-          Vector(p.message)
-        case _ =>
-          val pos = p.position
-          val sourcePrefix = jo2o(pos.sourcePath).getOrElse("")
-          val columnNumber = jo2o(pos.pointer).fold(1)(_.toInt + 1)
-          val lineNumberString = jo2o(pos.line).fold(":")(":" + _ + ":" + columnNumber + ":") + " "
-          val line1 = sourcePrefix + lineNumberString + p.message
-          val lineContent = pos.lineContent
-          if (!lineContent.isEmpty) {
-            Vector(line1, lineContent) ++
-              (for { space <- jo2o(pos.pointerSpace) } yield
-                (space + "^")).toVector // pointer to the column position of the error/warning
-          } else Vector(line1)
+      if (p.rendered.isPresent)
+        Vector(p.rendered.get)
+      else if (!p.position.sourcePath.isPresent && !p.position.line.isPresent)
+        Vector(p.message)
+      else {
+        val pos = p.position
+        val sourcePrefix = jo2o(pos.sourcePath).getOrElse("")
+        val columnNumber = jo2o(pos.pointer).fold(1)(_.toInt + 1)
+        val lineNumberString = jo2o(pos.line).fold(":")(":" + _ + ":" + columnNumber + ":") + " "
+        val line1 = sourcePrefix + lineNumberString + p.message
+        val lineContent = pos.lineContent
+        if (!lineContent.isEmpty) {
+          Vector(line1, lineContent) ++
+            (for { space <- jo2o(pos.pointerSpace) } yield
+              (space + "^")).toVector // pointer to the column position of the error/warning
+        } else Vector(line1)
       }
   }
 }

internal/zinc-compile-core/src/main/scala/sbt/internal/inc/javac/DiagnosticsReporter.scala

@@ -45,7 +45,7 @@ final class DiagnosticsReporter(reporter: Reporter) extends DiagnosticListener[J
     val msg = d.getMessage(null)
     val pos: xsbti.Position = PositionImpl(d)
     if (severity == Severity.Error) errorEncountered = true
-    reporter.log(problem("", pos, msg, severity))
+    reporter.log(problem("", pos, msg, severity, rendered = None))
   }
 }
 

internal/zinc-persist/src/main/protobuf/schema.proto

@@ -79,6 +79,7 @@ message Problem {
     Severity severity = 2;
     string message = 3;
     Position position = 4;
+    string rendered = 5;
 }
 
 message SourceInfo {

internal/zinc-persist/src/main/scala/sbt/internal/inc/binary/converters/ProtobufReaders.scala

@@ -21,6 +21,8 @@ import sbt.internal.inc.binary.converters.ProtobufDefaults.{ Classes, ReadersCon
 import sbt.internal.util.Relation
 import xsbti.api._
 
+import ProtobufDefaults.{ MissingString, MissingInt }
+
 final class ProtobufReaders(mapper: ReadMapper) {
   def fromPathString(path: String): File = {
     java.nio.file.Paths.get(path).toFile
@@ -115,11 +117,6 @@ final class ProtobufReaders(mapper: ReadMapper) {
   }
 
   def fromPosition(position: schema.Position): Position = {
-    import ProtobufDefaults.{ MissingString, MissingInt }
-    def fromString(value: String): Option[String] =
-      if (value == MissingString) None else Some(value)
-    def fromInt(value: Int): Option[Integer] =
-      if (value == MissingInt) None else Some(value)
     InterfaceUtil.position(
       line0 = fromInt(position.line),
       content = position.lineContent,
@@ -146,14 +143,21 @@ final class ProtobufReaders(mapper: ReadMapper) {
     }
   }
 
+  private def fromString(value: String): Option[String] =
+    if (value == MissingString) None else Some(value)
+
+  private def fromInt(value: Int): Option[Integer] =
+    if (value == MissingInt) None else Some(value)
+
   def fromProblem(problem: schema.Problem): Problem = {
     val category = problem.category
     val message = problem.message
     val severity = fromSeverity(problem.severity)
     val position = problem.position
       .map(fromPosition)
       .getOrElse(ReadersFeedback.ExpectedPositionInProblem.!!)
-    InterfaceUtil.problem(category, position, message, severity)
+    val rendered = fromString(problem.rendered)
+    InterfaceUtil.problem(category, position, message, severity, rendered)
   }
 
   def fromSourceInfo(sourceInfo: schema.SourceInfo): SourceInfo = {

internal/zinc-persist/src/main/scala/sbt/internal/inc/text/TextAnalysisFormat.scala

@@ -101,7 +101,7 @@ class TextAnalysisFormat(val mappers: ReadWriteMappers)
   }
   private implicit val companionsFomrat: Format[Companions] = CompanionsFormat
   private implicit def problemFormat: Format[Problem] =
-    asProduct4(problem)(p => (p.category, p.position, p.message, p.severity))
+    asProduct5(problem)(p => (p.category, p.position, p.message, p.severity, jo2o(p.rendered)))
   private implicit def positionFormat: Format[Position] =
     asProduct13(position)(
       p =>