Skip to content

Commit eb6aaa0

Browse files
nicolasstuckinicolasstucki
authored
Merge pull request #14455 from dwijnand/shown
Switch our string interpolators to use Show/Shown
2 parents c084b46 + e5ed401 commit eb6aaa0

File tree

13 files changed

+158
-74
lines changed

13 files changed

+158
-74
lines changed

‎compiler/src/dotty/tools/backend/sjs/JSExportsGen.scala‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ final class JSExportsGen(jsCodeGen: JSCodeGen)(using Context) {
119119
if (kind != overallKind) {
120120
bad = true
121121
report.error(
122-
em"export overload conflicts with export of $firstSym: they are of different types ($kind / $overallKind)",
122+
em"export overload conflicts with export of $firstSym: they are of different types (${kind.tryToShow} / ${overallKind.tryToShow})",
123123
info.pos)
124124
}
125125
}

‎compiler/src/dotty/tools/dotc/core/Decorators.scala‎

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@ package dotty.tools
22
package dotc
33
package core
44

5-
import annotation.tailrec
6-
import Symbols._
7-
import Contexts._, Names._, Phases._, printing.Texts._
8-
import collection.mutable.ListBuffer
9-
import dotty.tools.dotc.transform.MegaPhase
10-
import printing.Formatting._
5+
import scala.annotation.tailrec
6+
import scala.collection.mutable.ListBuffer
7+
import scala.util.control.NonFatal
8+
9+
import Contexts._, Names._, Phases._, Symbols._
10+
import printing.{ Printer, Showable }, printing.Formatting._, printing.Texts._
11+
import transform.MegaPhase
1112

1213
/** This object provides useful implicit decorators for types defined elsewhere */
1314
object Decorators {
@@ -246,13 +247,29 @@ object Decorators {
246247
}
247248

248249
extension [T](x: T)
249-
def showing(
250-
op: WrappedResult[T] ?=> String,
251-
printer: config.Printers.Printer = config.Printers.default): T = {
252-
printer.println(op(using WrappedResult(x)))
250+
def showing[U](
251+
op: WrappedResult[U] ?=> String,
252+
printer: config.Printers.Printer = config.Printers.default)(using c: Conversion[T, U] | Null = null): T = {
253+
// either the use of `$result` was driven by the expected type of `Shown`
254+
// which led to the summoning of `Conversion[T, Shown]` (which we'll invoke)
255+
// or no such conversion was found so we'll consume the result as it is instead
256+
val obj = if c == null then x.asInstanceOf[U] else c(x)
257+
printer.println(op(using WrappedResult(obj)))
253258
x
254259
}
255260

261+
/** Instead of `toString` call `show` on `Showable` values, falling back to `toString` if an exception is raised. */
262+
def tryToShow(using Context): String = x match
263+
case x: Showable =>
264+
try x.show
265+
catch
266+
case ex: CyclicReference => "... (caught cyclic reference) ..."
267+
case NonFatal(ex)
268+
if !ctx.mode.is(Mode.PrintShowExceptions) && !ctx.settings.YshowPrintErrors.value =>
269+
val msg = ex match { case te: TypeError => te.toMessage case _ => ex.getMessage }
270+
s"[cannot display due to $msg, raw string = $x]"
271+
case _ => String.valueOf(x).nn
272+
256273
extension [T](x: T)
257274
def assertingErrorsReported(using Context): T = {
258275
assert(ctx.reporter.errorsReported)
@@ -269,19 +286,19 @@ object Decorators {
269286

270287
extension (sc: StringContext)
271288
/** General purpose string formatting */
272-
def i(args: Any*)(using Context): String =
289+
def i(args: Shown*)(using Context): String =
273290
new StringFormatter(sc).assemble(args)
274291

275292
/** Formatting for error messages: Like `i` but suppress follow-on
276293
* error messages after the first one if some of their arguments are "non-sensical".
277294
*/
278-
def em(args: Any*)(using Context): String =
295+
def em(args: Shown*)(using Context): String =
279296
new ErrorMessageFormatter(sc).assemble(args)
280297

281298
/** Formatting with added explanations: Like `em`, but add explanations to
282299
* give more info about type variables and to disambiguate where needed.
283300
*/
284-
def ex(args: Any*)(using Context): String =
301+
def ex(args: Shown*)(using Context): String =
285302
explained(em(args: _*))
286303

287304
extension [T <: AnyRef](arr: Array[T])

‎compiler/src/dotty/tools/dotc/core/TypeComparer.scala‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2730,15 +2730,16 @@ object TypeComparer {
27302730
*/
27312731
val Fresh: Repr = 4
27322732

2733-
extension (approx: Repr)
2734-
def low: Boolean = (approx & LoApprox) != 0
2735-
def high: Boolean = (approx & HiApprox) != 0
2736-
def addLow: Repr = approx | LoApprox
2737-
def addHigh: Repr = approx | HiApprox
2738-
def show: String =
2739-
val lo = if low then " (left is approximated)" else ""
2740-
val hi = if high then " (right is approximated)" else ""
2741-
lo ++ hi
2733+
object Repr:
2734+
extension (approx: Repr)
2735+
def low: Boolean = (approx & LoApprox) != 0
2736+
def high: Boolean = (approx & HiApprox) != 0
2737+
def addLow: Repr = approx | LoApprox
2738+
def addHigh: Repr = approx | HiApprox
2739+
def show: String =
2740+
val lo = if low then " (left is approximated)" else ""
2741+
val hi = if high then " (right is approximated)" else ""
2742+
lo ++ hi
27422743
end ApproxState
27432744
type ApproxState = ApproxState.Repr
27442745

‎compiler/src/dotty/tools/dotc/interactive/Completion.scala‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ object Completion {
161161
| prefix = ${completer.prefix},
162162
| term = ${completer.mode.is(Mode.Term)},
163163
| type = ${completer.mode.is(Mode.Type)}
164-
| results = $backtickCompletions%, %""")
164+
| results = $backtickedCompletions%, %""")
165165
(offset, backtickedCompletions)
166166
}
167167

‎compiler/src/dotty/tools/dotc/parsing/Parsers.scala‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -606,7 +606,7 @@ object Parsers {
606606
if startIndentWidth <= nextIndentWidth then
607607
i"""Line is indented too far to the right, or a `{` is missing before:
608608
|
609-
|$t"""
609+
|${t.tryToShow}"""
610610
else
611611
in.spaceTabMismatchMsg(startIndentWidth, nextIndentWidth),
612612
in.next.offset

‎compiler/src/dotty/tools/dotc/printing/Formatting.scala‎

Lines changed: 76 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,99 @@
1-
package dotty.tools.dotc
1+
package dotty.tools
2+
package dotc
23
package printing
34

45
import scala.language.unsafeNulls
56

7+
import scala.collection.mutable
8+
69
import core._
710
import Texts._, Types._, Flags._, Symbols._, Contexts._
8-
import collection.mutable
911
import Decorators._
10-
import scala.util.control.NonFatal
1112
import reporting.Message
1213
import util.DiffUtil
1314
import Highlighting._
1415

1516
object Formatting {
1617

18+
object ShownDef:
19+
/** Represents a value that has been "shown" and can be consumed by StringFormatter.
20+
* Not just a string because it may be a Seq that StringFormatter will intersperse with the trailing separator.
21+
* Also, it's not a `String | Seq[String]` because then we'd need a Context to call `Showable#show`. We could
22+
* make Context a requirement for a Show instance but then we'd have lots of instances instead of just one ShowAny
23+
* instance. We could also try to make `Show#show` require the Context, but then that breaks the Conversion. */
24+
opaque type Shown = Any
25+
object Shown:
26+
given [A: Show]: Conversion[A, Shown] = Show[A].show(_)
27+
28+
sealed abstract class Show[-T]:
29+
/** Show a value T by returning a "shown" result. */
30+
def show(x: T): Shown
31+
32+
/** The base implementation, passing the argument to StringFormatter which will try to `.show` it. */
33+
object ShowAny extends Show[Any]:
34+
def show(x: Any): Shown = x
35+
36+
class ShowImplicits2:
37+
given Show[Product] = ShowAny
38+
39+
class ShowImplicits1 extends ShowImplicits2:
40+
given Show[ImplicitRef] = ShowAny
41+
given Show[Names.Designator] = ShowAny
42+
given Show[util.SrcPos] = ShowAny
43+
44+
object Show extends ShowImplicits1:
45+
inline def apply[A](using inline z: Show[A]): Show[A] = z
46+
47+
given [X: Show]: Show[Seq[X]] with
48+
def show(x: Seq[X]) = x.map(Show[X].show)
49+
50+
given [A: Show, B: Show]: Show[(A, B)] with
51+
def show(x: (A, B)) = (Show[A].show(x._1), Show[B].show(x._2))
52+
53+
given [X: Show]: Show[X | Null] with
54+
def show(x: X | Null) = if x == null then "null" else Show[X].show(x.nn)
55+
56+
given Show[FlagSet] with
57+
def show(x: FlagSet) = x.flagsString
58+
59+
given Show[TypeComparer.ApproxState] with
60+
def show(x: TypeComparer.ApproxState) = TypeComparer.ApproxState.Repr.show(x)
61+
62+
given Show[Showable] = ShowAny
63+
given Show[Shown] = ShowAny
64+
given Show[Int] = ShowAny
65+
given Show[Char] = ShowAny
66+
given Show[Boolean] = ShowAny
67+
given Show[String] = ShowAny
68+
given Show[Class[?]] = ShowAny
69+
given Show[Exception] = ShowAny
70+
given Show[StringBuffer] = ShowAny
71+
given Show[CompilationUnit] = ShowAny
72+
given Show[Phases.Phase] = ShowAny
73+
given Show[TyperState] = ShowAny
74+
given Show[config.ScalaVersion] = ShowAny
75+
given Show[io.AbstractFile] = ShowAny
76+
given Show[parsing.Scanners.Scanner] = ShowAny
77+
given Show[util.SourceFile] = ShowAny
78+
given Show[util.Spans.Span] = ShowAny
79+
given Show[tasty.TreeUnpickler#OwnerTree] = ShowAny
80+
end Show
81+
end ShownDef
82+
export ShownDef.{ Show, Shown }
83+
1784
/** General purpose string formatter, with the following features:
1885
*
19-
* 1) On all Showables, `show` is called instead of `toString`
20-
* 2) Exceptions raised by a `show` are handled by falling back to `toString`.
21-
* 3) Sequences can be formatted using the desired separator between two `%` signs,
86+
* 1. Invokes the `show` extension method on the interpolated arguments.
87+
* 2. Sequences can be formatted using the desired separator between two `%` signs,
2288
* eg `i"myList = (${myList}%, %)"`
23-
* 4) Safe handling of multi-line margins. Left margins are skipped om the parts
89+
* 3. Safe handling of multi-line margins. Left margins are stripped on the parts
2490
* of the string context *before* inserting the arguments. That way, we guard
2591
* against accidentally treating an interpolated value as a margin.
2692
*/
2793
class StringFormatter(protected val sc: StringContext) {
28-
protected def showArg(arg: Any)(using Context): String = arg match {
29-
case arg: Showable =>
30-
try arg.show
31-
catch {
32-
case ex: CyclicReference => "... (caught cyclic reference) ..."
33-
case NonFatal(ex)
34-
if !ctx.mode.is(Mode.PrintShowExceptions) &&
35-
!ctx.settings.YshowPrintErrors.value =>
36-
val msg = ex match
37-
case te: TypeError => te.toMessage
38-
case _ => ex.getMessage
39-
s"[cannot display due to $msg, raw string = ${arg.toString}]"
40-
}
41-
case _ => String.valueOf(arg)
42-
}
94+
protected def showArg(arg: Any)(using Context): String = arg.tryToShow
4395

44-
private def treatArg(arg: Any, suffix: String)(using Context): (Any, String) = arg match {
96+
private def treatArg(arg: Shown, suffix: String)(using Context): (Any, String) = arg match {
4597
case arg: Seq[?] if suffix.nonEmpty && suffix.head == '%' =>
4698
val (rawsep, rest) = suffix.tail.span(_ != '%')
4799
val sep = StringContext.processEscapes(rawsep)
@@ -51,7 +103,7 @@ object Formatting {
51103
(showArg(arg), suffix)
52104
}
53105

54-
def assemble(args: Seq[Any])(using Context): String = {
106+
def assemble(args: Seq[Shown])(using Context): String = {
55107
def isLineBreak(c: Char) = c == '\n' || c == '\f' // compatible with StringLike#isLineBreak
56108
def stripTrailingPart(s: String) = {
57109
val (pre, post) = s.span(c => !isLineBreak(c))
@@ -77,18 +129,6 @@ object Formatting {
77129
override protected def showArg(arg: Any)(using Context): String =
78130
wrapNonSensical(arg, super.showArg(arg)(using errorMessageCtx))
79131

80-
class SyntaxFormatter(sc: StringContext) extends StringFormatter(sc) {
81-
override protected def showArg(arg: Any)(using Context): String =
82-
arg match {
83-
case hl: Highlight =>
84-
hl.show
85-
case hb: HighlightBuffer =>
86-
hb.toString
87-
case _ =>
88-
SyntaxHighlighting.highlight(super.showArg(arg))
89-
}
90-
}
91-
92132
private def wrapNonSensical(arg: Any, str: String)(using Context): String = {
93133
import Message._
94134
def isSensical(arg: Any): Boolean = arg match {

‎compiler/src/dotty/tools/dotc/reporting/messages.scala‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1759,7 +1759,9 @@ import transform.SymUtils._
17591759

17601760
class ClassAndCompanionNameClash(cls: Symbol, other: Symbol)(using Context)
17611761
extends NamingMsg(ClassAndCompanionNameClashID) {
1762-
def msg = em"Name clash: both ${cls.owner} and its companion object defines ${cls.name.stripModuleClassSuffix}"
1762+
def msg =
1763+
val name = cls.name.stripModuleClassSuffix
1764+
em"Name clash: both ${cls.owner} and its companion object defines $name"
17631765
def explain =
17641766
em"""|A ${cls.kindString} and its companion object cannot both define a ${hl("class")}, ${hl("trait")} or ${hl("object")} with the same name:
17651767
| - ${cls.owner} defines ${cls}

‎compiler/src/dotty/tools/dotc/sbt/ExtractAPI.scala‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -776,7 +776,7 @@ private class ExtractAPICollector(using Context) extends ThunkHolder {
776776
case n: Name =>
777777
h = nameHash(n, h)
778778
case elem =>
779-
cannotHash(what = i"`$elem` of unknown class ${elem.getClass}", elem, tree)
779+
cannotHash(what = i"`${elem.tryToShow}` of unknown class ${elem.getClass}", elem, tree)
780780
h
781781
end iteratorHash
782782

‎compiler/src/dotty/tools/dotc/transform/AccessProxies.scala‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ abstract class AccessProxies {
5858

5959
/** Add all needed accessors to the `body` of class `cls` */
6060
def addAccessorDefs(cls: Symbol, body: List[Tree])(using Context): List[Tree] = {
61-
val accDefs = accessorDefs(cls)
61+
val accDefs = accessorDefs(cls).toList
6262
transforms.println(i"add accessors for $cls: $accDefs%, %")
6363
if (accDefs.isEmpty) body else body ++ accDefs
6464
}

‎compiler/src/dotty/tools/dotc/transform/DropOuterAccessors.scala‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ class DropOuterAccessors extends MiniPhase with IdentityDenotTransformer:
8080
cpy.Block(rhs)(inits.filterNot(dropOuterInit), expr)
8181
})
8282
assert(droppedParamAccessors.isEmpty,
83-
i"""Failed to eliminate: $droppedParamAccessors
83+
i"""Failed to eliminate: ${droppedParamAccessors.toList}
8484
when dropping outer accessors for ${ctx.owner} with
8585
$impl""")
8686
cpy.Template(impl)(constr = constr1, body = body1)

0 commit comments

Comments
 (0)