Merge pull request #4973 from dotty-staging/fix-4936-forbidden-object-flags

Fix #4936: Forbid (or warn on) redundant/illegal object flags

Author: nicolasstucki

compiler/src/dotty/tools/dotc/core/NameOps.scala

@@ -10,7 +10,7 @@ import Definitions._
 
 object NameOps {
 
-  final object compactify {
+  object compactify {
     lazy val md5: MessageDigest = MessageDigest.getInstance("MD5")
 
     /** COMPACTIFY

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

@@ -2422,6 +2422,16 @@ object Parsers {
 
     def objectDefRest(start: Offset, mods: Modifiers, name: TermName): ModuleDef = {
       val template = templateOpt(emptyConstructor)
+
+      def flagPos(flag: FlagSet) = mods.mods.find(_.flags == flag).get.pos
+      if (mods is Abstract)
+        syntaxError(hl"""${Abstract} modifier cannot be used for objects""", flagPos(Abstract))
+      if (mods is Sealed)
+        syntaxError(hl"""${Sealed} modifier is redundant for objects""", flagPos(Sealed))
+      // Maybe this should be an error; see https://github.com/scala/bug/issues/11094.
+      if (mods is Final)
+        warning(hl"""${Final} modifier is redundant for objects""", source atPos flagPos(Final))
+
       finalizeDef(ModuleDef(name, template), mods, start)
     }
 

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

@@ -80,9 +80,8 @@ object Formatting {
           hl.show
         case hb: HighlightBuffer =>
           hb.toString
-        case str: String =>
-          SyntaxHighlighting.highlight(str)
-        case _ => super.showArg(arg)
+        case _ =>
+          SyntaxHighlighting.highlight(super.showArg(arg))
       }
   }
 

compiler/test/dotty/tools/vulpix/Status.scala

@@ -4,4 +4,4 @@ package vulpix
 sealed trait Status
 final case class Success(output: String) extends Status
 final case class Failure(output: String) extends Status
-final case object Timeout extends Status
+case object Timeout extends Status

doc-tool/src/dotty/tools/dottydoc/model/references.scala

@@ -11,7 +11,7 @@ object references {
   final case class BoundsReference(low: Reference, high: Reference) extends Reference
   final case class NamedReference(title: String, ref: Reference, isByName: Boolean = false, isRepeated: Boolean = false) extends Reference
   final case class ConstantReference(title: String) extends Reference
-  final case object EmptyReference extends Reference
+  case object EmptyReference extends Reference
 
   /** Use MaterializableLink for entities that need be picklable */
   sealed trait MaterializableLink { def title: String }

semanticdb/src/dotty/semanticdb/Scala.scala

@@ -148,7 +148,7 @@ object Scala {
     }
   }
   object Descriptor {
-    final case object None extends Descriptor { def value: String = "" }
+    case object None extends Descriptor { def value: String = "" }
     final case class Term(value: String) extends Descriptor
     final case class Method(value: String, disambiguator: String) extends Descriptor
     final case class Type(value: String) extends Descriptor

tests/neg-custom-args/fatal-warnings/i4936.scala

@@ -0,0 +1 @@
+final object Foo // error

tests/neg/i3471.scala

@@ -0,0 +1 @@
+sealed object Fun // error

tests/neg/i4936.scala

@@ -0,0 +1,4 @@
+abstract object Foo // error
+sealed final abstract case object Bar // error // error
+
+abstract override object Baz // error

tests/patmat/i3645.scala

@@ -13,8 +13,8 @@ object App {
     }
 
     sealed abstract class K[A]
-    final case object KAge extends K[Age]
-    final case object KInt extends K[Int]
+    case object KAge extends K[Age]
+    case object KInt extends K[Int]
 
     val kint: K[Age] = Age.subst[K](KInt)
     def get(k: K[Age]): String = k match {