Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sources of synthetic classes to sources jar #20904

Merged
merged 2 commits into from
Jul 12, 2024
Merged

Add sources of synthetic classes to sources jar #20904

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27bd975
Add sources of synthetic classes to sources jar
Florian3k Jul 1, 2024
32b5843
apply fixes from review
Florian3k Jul 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions library-aux/src/scala/AnyKind.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package scala

/** The super-type of all types.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/** The super-type of all types.
/** AnyKind plays a special role in Scala's subtype system:
* It is a supertype of all other types no matter what their kind is.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This docstring is copied from Definitions.scala:

scala3/compiler/src/dotty/tools/dotc/core/Definitions.scala

Lines 2453 to 2458 in 010ed5a

add(AnyKindClass,
"""/** The super-type of all types.
| *
| * See [[https://docs.scala-lang.org/scala3/reference/other-new-features/kind-polymorphism.html]].
| */
""".stripMargin)

It is also source of truth for scaladoc generation. I think those comments should be kept in sync.
Should I change it in Definitions.scala as well?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes please!

*
* See [[https://docs.scala-lang.org/scala3/reference/other-new-features/kind-polymorphism.html]].
*/
final abstract class AnyKind
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It makes no sense for this type to be final. It definitely has subclasses, including AnyRef.

Suggested change
final abstract class AnyKind
abstract class AnyKind

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I based it on Definitions.scala:

scala3/compiler/src/dotty/tools/dotc/core/Definitions.scala

Lines 450 to 451 in 75a15c2

@tu lazy val AnyKindClass: ClassSymbol = {
val cls = newCompleteClassSymbol(ScalaPackageClass, tpnme.AnyKind, AbstractFinal | Permanent, Nil, newScope(0))

When trying to extend AnyKind, the following errors are reported:

$ scala-cli repl            
Welcome to Scala 3.4.2 (11, Java OpenJDK 64-Bit Server VM).
Type in expressions for evaluation. Or try :help.
                                                                                                                                                                                                                                                   
scala> class Test extends AnyKind
-- [E093] Syntax Error: --------------------------------------------------------
1 |class Test extends AnyKind
  |      ^
  |      class Test cannot extend final class AnyKind
  |
  | longer explanation available when compiling with `-explain`
-- Error: ----------------------------------------------------------------------
1 |class Test extends AnyKind
  |                   ^^^^^^^
  |                   AnyKind does not have a constructor
2 errors found

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definitions is what works for the compiler with the minimum amount of work. From a spec point of view, AnyKind is not even a class (nor a trait). It's a completely unique thing. The error message that you mention is definitely not a good message. We shouldn't tailor the doc to that poor message. We should tailor it to the real spec as much as possible instead.

(Arguably it should even be an abstract type as well, but since Nothing is presented as a class, it makes "less not" sense to also use a class here.)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs even say "It is declared abstract and final"

7 changes: 7 additions & 0 deletions library-aux/src/scala/Matchable.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package scala

/** The base trait of types that can be safely pattern matched against.
*
* See [[https://docs.scala-lang.org/scala3/reference/other-new-features/matchable.html]].
*/
trait Matchable
7 changes: 7 additions & 0 deletions library-aux/src/scala/andType.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package scala

/** The intersection of two types.
*
* See [[https://docs.scala-lang.org/scala3/reference/new-types/intersection-types.html]].
*/
type &[A, B]
7 changes: 7 additions & 0 deletions library-aux/src/scala/orType.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package scala

/** The union of two types.
*
* See [[https://docs.scala-lang.org/scala3/reference/new-types/union-types.html]].
*/
type |[A, B]
6 changes: 5 additions & 1 deletion project/Build.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -987,7 +987,11 @@ object Build {
"-sourcepath", (Compile / sourceDirectories).value.map(_.getAbsolutePath).distinct.mkString(File.pathSeparator),
"-Yexplicit-nulls",
),
(Compile / doc / scalacOptions) ++= ScaladocConfigs.DefaultGenerationSettings.value.settings
(Compile / doc / scalacOptions) ++= ScaladocConfigs.DefaultGenerationSettings.value.settings,
(Compile / packageSrc / mappings) ++= {
val auxBase = (ThisBuild / baseDirectory).value / "library-aux/src"
auxBase ** "*.scala" pair io.Path.relativeTo(auxBase)
},
)

lazy val `scala3-library` = project.in(file("library")).asDottyLibrary(NonBootstrapped)
Expand Down
Loading