Detect when old accessor is compatible with @binaryAPIAccessor

nicolasstucki · nicolasstucki · commit 6ae7082af89c · 2023-05-09T10:00:59.000+02:00
diff --git a/compiler/src/dotty/tools/dotc/inlines/PrepareInlineable.scala b/compiler/src/dotty/tools/dotc/inlines/PrepareInlineable.scala
@@ -110,13 +110,25 @@ object PrepareInlineable {
             s"Annotate ${accessed.name} with `$annot` to generate a stable accessor."
           else
             s"Annotate ${accessed.name} with `$annot` to make it accessible."
+
         val binaryCompat =
-          s"""Adding $annot may break binary compatibility if a previous version of this
-              |library was compiled with Scala 3.0-3.3, Binary compatibility should be checked
-              |using MiMa. To keep binary you can add the following accessor to ${accessor.owner.showKind} ${accessor.owner.name.stripModuleClassSuffix}:
-              |  @binaryAPI private[${accessor.owner.name.stripModuleClassSuffix}] ${accessorDefTree.show}
-              |
-              |""".stripMargin
+          val accessorClass = AccessProxies.hostForAccessorOf(accessed: Symbol)
+          val inlineAccessorMatches =
+            accessor.name == InlineAccessorName(accessed.name.asTermName).expandedName(accessorClass)
+          if !inlineAccessorMatches then
+            s"""Adding $annot may break binary compatibility if a previous version of this
+                |library was compiled with Scala 3.0-3.3, Binary compatibility should be checked
+                |using MiMa. To keep binary compatibility you can add the following accessor to ${accessor.owner.showKind} ${accessor.owner.name.stripModuleClassSuffix}:
+                |  @binaryAPI private[${accessor.owner.name.stripModuleClassSuffix}] ${accessorDefTree.show}
+                |
+                |""".stripMargin
+          else if !accessed.is(Private) then
+            s"""Adding $annot may break binary compatibility if a previous version of this
+                |library was compiled with Scala 3.0-3.3, Binary compatibility should be checked
+                |using MiMa. To keep binary compatibility you can use @binaryAPIAccessor on
+                |$accessed.""".stripMargin
+          else
+            ""
         report.warning(em"Generated unstable inline accessor for $accessed defined in ${accessed.owner}.\n\n$solution\n\n$binaryCompat", srcPos)
     }
 
diff --git a/tests/neg-custom-args/fatal-warnings/inline-unstable-accessors.check b/tests/neg-custom-args/fatal-warnings/inline-unstable-accessors.check
@@ -5,11 +5,6 @@
   |
   |    Annotate valBinaryAPI1 with `@binaryAPIAccessor` to generate a stable accessor.
   |
-  |    Adding @binaryAPIAccessor may break binary compatibility if a previous version of this
-  |    library was compiled with Scala 3.0-3.3, Binary compatibility should be checked
-  |    using MiMa. To keep binary you can add the following accessor to class A:
-  |      @binaryAPI private[A] final def foo$A$$inline$valBinaryAPI1: Int = this.valBinaryAPI1
-  |
 -- Error: tests/neg-custom-args/fatal-warnings/inline-unstable-accessors.scala:10:4 ------------------------------------
 10 |    valBinaryAPI2 + // error
    |    ^^^^^^^^^^^^^
@@ -19,9 +14,8 @@
    |
    |    Adding @binaryAPI may break binary compatibility if a previous version of this
    |    library was compiled with Scala 3.0-3.3, Binary compatibility should be checked
-   |    using MiMa. To keep binary you can add the following accessor to class A:
-   |      @binaryAPI private[A] def foo$A$$inline$valBinaryAPI2: Int = this.valBinaryAPI2
-   |
+   |    using MiMa. To keep binary compatibility you can use @binaryAPIAccessor on
+   |    val valBinaryAPI2.
 -- Error: tests/neg-custom-args/fatal-warnings/inline-unstable-accessors.scala:15:6 ------------------------------------
 15 |    a.valBinaryAPI2 + // error
    |    ^^^^^^^^^^^^^^^
@@ -31,7 +25,7 @@
    |
    |    Adding @binaryAPI may break binary compatibility if a previous version of this
    |    library was compiled with Scala 3.0-3.3, Binary compatibility should be checked
-   |    using MiMa. To keep binary you can add the following accessor to class B:
+   |    using MiMa. To keep binary compatibility you can add the following accessor to class B:
    |      @binaryAPI private[B] def inline$valBinaryAPI2$i1(x$0: foo.A): Int = x$0.valBinaryAPI2
    |
 -- Error: tests/neg-custom-args/fatal-warnings/inline-unstable-accessors.scala:24:4 ------------------------------------
@@ -43,7 +37,7 @@
    |
    |    Adding @binaryAPIAccessor may break binary compatibility if a previous version of this
    |    library was compiled with Scala 3.0-3.3, Binary compatibility should be checked
-   |    using MiMa. To keep binary you can add the following accessor to class C:
+   |    using MiMa. To keep binary compatibility you can add the following accessor to class C:
    |      @binaryAPI private[C] final def inline$valBinaryAPI1: Int = this.valBinaryAPI1
    |
 -- Error: tests/neg-custom-args/fatal-warnings/inline-unstable-accessors.scala:25:4 ------------------------------------
@@ -55,7 +49,7 @@
    |
    |    Adding @binaryAPI may break binary compatibility if a previous version of this
    |    library was compiled with Scala 3.0-3.3, Binary compatibility should be checked
-   |    using MiMa. To keep binary you can add the following accessor to class C:
+   |    using MiMa. To keep binary compatibility you can add the following accessor to class C:
    |      @binaryAPI private[C] def inline$valBinaryAPI2: Int = this.valBinaryAPI2
    |
 -- Error: tests/neg-custom-args/fatal-warnings/inline-unstable-accessors.scala:30:6 ------------------------------------
@@ -67,7 +61,7 @@
    |
    |    Adding @binaryAPI may break binary compatibility if a previous version of this
    |    library was compiled with Scala 3.0-3.3, Binary compatibility should be checked
-   |    using MiMa. To keep binary you can add the following accessor to class D:
+   |    using MiMa. To keep binary compatibility you can add the following accessor to class D:
    |      @binaryAPI private[D] def inline$valBinaryAPI2$i2(x$0: foo.C): Int = x$0.valBinaryAPI2
    |
 -- Error: tests/neg-custom-args/fatal-warnings/inline-unstable-accessors.scala:39:4 ------------------------------------
@@ -79,7 +73,7 @@
    |
    |    Adding @binaryAPIAccessor may break binary compatibility if a previous version of this
    |    library was compiled with Scala 3.0-3.3, Binary compatibility should be checked
-   |    using MiMa. To keep binary you can add the following accessor to object E:
+   |    using MiMa. To keep binary compatibility you can add the following accessor to object E:
    |      @binaryAPI private[E] final def inline$valBinaryAPI1: Int = foo.E.valBinaryAPI1
    |
 -- Error: tests/neg-custom-args/fatal-warnings/inline-unstable-accessors.scala:40:4 ------------------------------------
@@ -91,7 +85,7 @@
    |
    |    Adding @binaryAPI may break binary compatibility if a previous version of this
    |    library was compiled with Scala 3.0-3.3, Binary compatibility should be checked
-   |    using MiMa. To keep binary you can add the following accessor to object E:
+   |    using MiMa. To keep binary compatibility you can add the following accessor to object E:
    |      @binaryAPI private[E] def inline$valBinaryAPI2: Int = foo.E.valBinaryAPI2
    |
 -- Error: tests/neg-custom-args/fatal-warnings/inline-unstable-accessors.scala:45:6 ------------------------------------
@@ -103,6 +97,6 @@
    |
    |    Adding @binaryAPI may break binary compatibility if a previous version of this
    |    library was compiled with Scala 3.0-3.3, Binary compatibility should be checked
-   |    using MiMa. To keep binary you can add the following accessor to object F:
+   |    using MiMa. To keep binary compatibility you can add the following accessor to object F:
    |      @binaryAPI private[F] def inline$valBinaryAPI2$i3(x$0: foo.E): Int = x$0.valBinaryAPI2
    |

Original file line number	Diff line number	Diff line change
`@@ -5,11 +5,6 @@`
`5`	`5`	`\|`
`6`	`6`	\| Annotate valBinaryAPI1 with `@binaryAPIAccessor` to generate a stable accessor.
`7`	`7`	`\|`
`8`		`- \| Adding @binaryAPIAccessor may break binary compatibility if a previous version of this`
`9`		`- \| library was compiled with Scala 3.0-3.3, Binary compatibility should be checked`
`10`		`- \| using MiMa. To keep binary you can add the following accessor to class A:`
`11`		`- \| @binaryAPI private[A] final def foo$A$$inline$valBinaryAPI1: Int = this.valBinaryAPI1`
`12`		`- \|`
`13`	`8`	`-- Error: tests/neg-custom-args/fatal-warnings/inline-unstable-accessors.scala:10:4 ------------------------------------`
`14`	`9`	`10 \| valBinaryAPI2 + // error`
`15`	`10`	`\| ^^^^^^^^^^^^^`
`@@ -19,9 +14,8 @@`
`19`	`14`	`\|`
`20`	`15`	`\| Adding @binaryAPI may break binary compatibility if a previous version of this`
`21`	`16`	`\| library was compiled with Scala 3.0-3.3, Binary compatibility should be checked`
`22`		`- \| using MiMa. To keep binary you can add the following accessor to class A:`
`23`		`- \| @binaryAPI private[A] def foo$A$$inline$valBinaryAPI2: Int = this.valBinaryAPI2`
`24`		`- \|`
	`17`	`+ \| using MiMa. To keep binary compatibility you can use @binaryAPIAccessor on`
	`18`	`+ \| val valBinaryAPI2.`
`25`	`19`	`-- Error: tests/neg-custom-args/fatal-warnings/inline-unstable-accessors.scala:15:6 ------------------------------------`
`26`	`20`	`15 \| a.valBinaryAPI2 + // error`
`27`	`21`	`\| ^^^^^^^^^^^^^^^`
`@@ -31,7 +25,7 @@`
`31`	`25`	`\|`
`32`	`26`	`\| Adding @binaryAPI may break binary compatibility if a previous version of this`
`33`	`27`	`\| library was compiled with Scala 3.0-3.3, Binary compatibility should be checked`
`34`		`- \| using MiMa. To keep binary you can add the following accessor to class B:`
	`28`	`+ \| using MiMa. To keep binary compatibility you can add the following accessor to class B:`
`35`	`29`	`\| @binaryAPI private[B] def inline$valBinaryAPI2$i1(x$0: foo.A): Int = x$0.valBinaryAPI2`
`36`	`30`	`\|`
`37`	`31`	`-- Error: tests/neg-custom-args/fatal-warnings/inline-unstable-accessors.scala:24:4 ------------------------------------`
`@@ -43,7 +37,7 @@`
`43`	`37`	`\|`
`44`	`38`	`\| Adding @binaryAPIAccessor may break binary compatibility if a previous version of this`
`45`	`39`	`\| library was compiled with Scala 3.0-3.3, Binary compatibility should be checked`
`46`		`- \| using MiMa. To keep binary you can add the following accessor to class C:`
	`40`	`+ \| using MiMa. To keep binary compatibility you can add the following accessor to class C:`
`47`	`41`	`\| @binaryAPI private[C] final def inline$valBinaryAPI1: Int = this.valBinaryAPI1`
`48`	`42`	`\|`
`49`	`43`	`-- Error: tests/neg-custom-args/fatal-warnings/inline-unstable-accessors.scala:25:4 ------------------------------------`
`@@ -55,7 +49,7 @@`
`55`	`49`	`\|`
`56`	`50`	`\| Adding @binaryAPI may break binary compatibility if a previous version of this`
`57`	`51`	`\| library was compiled with Scala 3.0-3.3, Binary compatibility should be checked`
`58`		`- \| using MiMa. To keep binary you can add the following accessor to class C:`
	`52`	`+ \| using MiMa. To keep binary compatibility you can add the following accessor to class C:`
`59`	`53`	`\| @binaryAPI private[C] def inline$valBinaryAPI2: Int = this.valBinaryAPI2`
`60`	`54`	`\|`
`61`	`55`	`-- Error: tests/neg-custom-args/fatal-warnings/inline-unstable-accessors.scala:30:6 ------------------------------------`
`@@ -67,7 +61,7 @@`
`67`	`61`	`\|`
`68`	`62`	`\| Adding @binaryAPI may break binary compatibility if a previous version of this`
`69`	`63`	`\| library was compiled with Scala 3.0-3.3, Binary compatibility should be checked`
`70`		`- \| using MiMa. To keep binary you can add the following accessor to class D:`
	`64`	`+ \| using MiMa. To keep binary compatibility you can add the following accessor to class D:`
`71`	`65`	`\| @binaryAPI private[D] def inline$valBinaryAPI2$i2(x$0: foo.C): Int = x$0.valBinaryAPI2`
`72`	`66`	`\|`
`73`	`67`	`-- Error: tests/neg-custom-args/fatal-warnings/inline-unstable-accessors.scala:39:4 ------------------------------------`
`@@ -79,7 +73,7 @@`
`79`	`73`	`\|`
`80`	`74`	`\| Adding @binaryAPIAccessor may break binary compatibility if a previous version of this`
`81`	`75`	`\| library was compiled with Scala 3.0-3.3, Binary compatibility should be checked`
`82`		`- \| using MiMa. To keep binary you can add the following accessor to object E:`
	`76`	`+ \| using MiMa. To keep binary compatibility you can add the following accessor to object E:`
`83`	`77`	`\| @binaryAPI private[E] final def inline$valBinaryAPI1: Int = foo.E.valBinaryAPI1`
`84`	`78`	`\|`
`85`	`79`	`-- Error: tests/neg-custom-args/fatal-warnings/inline-unstable-accessors.scala:40:4 ------------------------------------`
`@@ -91,7 +85,7 @@`
`91`	`85`	`\|`
`92`	`86`	`\| Adding @binaryAPI may break binary compatibility if a previous version of this`
`93`	`87`	`\| library was compiled with Scala 3.0-3.3, Binary compatibility should be checked`
`94`		`- \| using MiMa. To keep binary you can add the following accessor to object E:`
	`88`	`+ \| using MiMa. To keep binary compatibility you can add the following accessor to object E:`
`95`	`89`	`\| @binaryAPI private[E] def inline$valBinaryAPI2: Int = foo.E.valBinaryAPI2`
`96`	`90`	`\|`
`97`	`91`	`-- Error: tests/neg-custom-args/fatal-warnings/inline-unstable-accessors.scala:45:6 ------------------------------------`
`@@ -103,6 +97,6 @@`
`103`	`97`	`\|`
`104`	`98`	`\| Adding @binaryAPI may break binary compatibility if a previous version of this`
`105`	`99`	`\| library was compiled with Scala 3.0-3.3, Binary compatibility should be checked`
`106`		`- \| using MiMa. To keep binary you can add the following accessor to object F:`
	`100`	`+ \| using MiMa. To keep binary compatibility you can add the following accessor to object F:`
`107`	`101`	`\| @binaryAPI private[F] def inline$valBinaryAPI2$i3(x$0: foo.E): Int = x$0.valBinaryAPI2`
`108`	`102`	`\|`