SourceInfo: simplify the common case for makeMessage, print it differently

core/src/main/scala/chisel3/Data.scala

@@ -644,7 +644,7 @@ abstract class Data extends HasId with NamedComponent with SourceInfoDoc {
     visibleFromWhen match {
       case Some(sourceInfo) =>
         throwException(
-          s"operand '$this' has escaped the scope of the when (${sourceInfo.makeMessage(x => x)}) in which it was constructed."
+          s"operand '$this' has escaped the scope of the when (${sourceInfo.makeMessage()}) in which it was constructed."
         )
       case None => ()
     }

core/src/main/scala/chisel3/Mem.scala

@@ -66,7 +66,7 @@ sealed abstract class MemBase[T <: Data](val t: T, val length: BigInt, sourceInf
 
   protected def clockWarning(sourceInfo: Option[SourceInfo], dir: MemPortDirection): Unit = {
     // Turn into pretty String if possible, if not, Builder.deprecated will find one via stack trace
-    val infoStr = sourceInfo.collect { case s => s.makeMessage(x => x) }
+    val infoStr = sourceInfo.collect { case s => s.makeMessage() }
     Builder.deprecated(
       "The clock used to initialize the memory is different than the one used to initialize the port. " +
         "If this is intentional, please pass the clock explicitly when creating the port. This behavior will be an error in 3.6.0",

core/src/main/scala/chisel3/Module.scala

@@ -612,14 +612,14 @@ package experimental {
             if (_namespace.contains(name)) {
               Builder.error(
                 s"""Unable to name port $port to "$name" in $this,""" +
-                  s" name is already taken by another port! ${source.makeMessage(x => x)}"
+                  s" name is already taken by another port! ${source.makeMessage()}"
               )(UnlocatableSourceInfo)
             }
             port.setRef(ModuleIO(this, _namespace.name(name)))
           case None =>
             Builder.error(
               s"Unable to name port $port in $this, " +
-                s"try making it a public field of the Module ${source.makeMessage(x => x)}"
+                s"try making it a public field of the Module ${source.makeMessage()}"
             )(UnlocatableSourceInfo)
             port.setRef(ModuleIO(this, "<UNNAMED>"))
         }

core/src/main/scala/chisel3/RawModule.scala

@@ -125,7 +125,7 @@ abstract class RawModule extends BaseModule {
       if (port._computeName(None).isEmpty) {
         Builder.error(
           s"Unable to name port $port in $this, " +
-            s"try making it a public field of the Module ${source.makeMessage(x => x)}"
+            s"try making it a public field of the Module ${source.makeMessage()}"
         )(UnlocatableSourceInfo)
       }
     }

core/src/main/scala/chisel3/experimental/SourceInfo.scala

@@ -26,14 +26,14 @@ sealed trait SourceInfo {
     *
     * Make a useful message if SourceInfo is available, nothing otherwise
     */
-  def makeMessage(f: String => String): String
+  def makeMessage(f: String => String = x => x): String
 
   /** The filename for the originating source file, if known */
   def filenameOption: Option[String]
 }
 
 sealed trait NoSourceInfo extends SourceInfo {
-  def makeMessage(f: String => String): String = ""
+  def makeMessage(f: String => String = x => x): String = ""
   def filenameOption: Option[String] = None
 }
 
@@ -51,9 +51,13 @@ case object DeprecatedSourceInfo extends NoSourceInfo
   * @note A column == 0 indicates no column
   */
 case class SourceLine(filename: String, line: Int, col: Int) extends SourceInfo {
-  def makeMessage(f: String => String): String = f(s"@[${this.serialize}]")
+  def makeMessage(f: String => String = x => x): String = f(s"@[${this.prettyPrint}]")
   def filenameOption: Option[String] = Some(filename)
 
+  def prettyPrint: String = {
+    if (col == 0) s"$filename:$line" else s"$filename:$line:$col"
+  }
+
   /** Convert to String for FIRRTL emission */
   def serialize: String = {
     if (col == 0) s"$filename $line" else s"$filename $line:$col"

core/src/main/scala/chisel3/experimental/dataview/DataView.scala

@@ -57,7 +57,7 @@ sealed class DataView[T: DataProduct, V <: Data] private[chisel3] (
   def total: Boolean = _total
 
   override def toString: String = {
-    val base = sourceInfo.makeMessage(x => x)
+    val base = sourceInfo.makeMessage()
     val loc = if (base.nonEmpty) base else "@unknown"
     val name = if (total) "DataView" else "PartialDataView"
     s"$name(defined $loc)"

core/src/main/scala/chisel3/internal/MonoConnect.scala

@@ -55,11 +55,11 @@ private[chisel3] object MonoConnect {
     )
   def SourceEscapedWhenScopeException(source: Data, whenInfo: SourceInfo) =
     MonoConnectException(
-      s"Source ${formatName(source)} has escaped the scope of the when (${whenInfo.makeMessage(x => x)}) in which it was constructed."
+      s"Source ${formatName(source)} has escaped the scope of the when (${whenInfo.makeMessage()}) in which it was constructed."
     )
   def SinkEscapedWhenScopeException(sink: Data, whenInfo: SourceInfo) =
     MonoConnectException(
-      s"Sink ${formatName(sink)} has escaped the scope of the when (${whenInfo.makeMessage(x => x)}) in which it was constructed."
+      s"Sink ${formatName(sink)} has escaped the scope of the when (${whenInfo.makeMessage()}) in which it was constructed."
     )
   def UnknownRelationException =
     MonoConnectException("Sink or source unavailable to current module.")

src/main/scala/chisel3/simulator/PeekPokeAPI.scala

@@ -19,7 +19,7 @@ trait PeekPokeAPI {
       sourceInfo:   SourceInfo,
       extraContext: Seq[String]
     ): FailedExpectationException[T] = {
-      val fullMessage = s"$message ${sourceInfo.makeMessage(x => x)}" +
+      val fullMessage = s"$message ${sourceInfo.makeMessage()}" +
         (if (extraContext.nonEmpty) s"\n${extraContext.mkString("\n")}" else "")
       new FailedExpectationException(observed, expected, fullMessage)
     }

src/test/scala/chiselTests/SourceLocatorSpec.scala

@@ -4,7 +4,7 @@ package chiselTests
 
 import circt.stage.ChiselStage.emitCHIRRTL
 import chisel3._
-import chisel3.experimental.{BaseModule, ExtModule, SourceLine}
+import chisel3.experimental.{BaseModule, ExtModule, SourceInfo, SourceLine}
 import chisel3.experimental.hierarchy.Definition
 import firrtl.ir.FileInfo
 
@@ -109,4 +109,13 @@ class SourceLocatorSpec extends ChiselFunSpec with Utils {
       chirrtl should include(s"module RawModuleChild : @[$thisFile 14:9]")
     }
   }
+
+  describe("(3) SourceLocator.makeMessage()") {
+    it("(3.a) Should have click-to-source functionality") {
+      val locator = SourceInfo.materialize
+      // This click-to-source works in VSCode terminal, uncomment to manually test
+      // println(s"Try clicking to this source locator! ${locator.makeMessage()}")
+      locator.makeMessage() should include(s"$thisFile:115:32")
+    }
+  }
 }

src/test/scala/chiselTests/experimental/hierarchy/InstantiateSpec.scala

@@ -412,7 +412,7 @@ class InstantiateSpec extends ChiselFunSpec with Utils {
       val chirrtl = convert(new Top {
         val inst = Instantiate(new OneArg(3))
       }).serialize
-      chirrtl should include(s"inst inst of OneArg ${info.makeMessage(x => x)}")
+      chirrtl should include(s"inst inst of OneArg ${info.makeMessage()}")
     }
 
     it("should support BlackBoxes") {