Merge pull request #3483 from maseev/iss1589-cyclic-inheritence-error-message

Add an error message for a cyclic inheritance case

Author: nicolasstucki

compiler/src/dotty/tools/dotc/reporting/diagnostic/ErrorMessageID.java

@@ -116,6 +116,7 @@ public enum ErrorMessageID {
     PackageNameAlreadyDefinedID,
     UnapplyInvalidNumberOfArgumentsID,
     StaticFieldsOnlyAllowedInObjectsID,
+    CyclicInheritanceID,
     ;
 
     public int errorNumber() {

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

@@ -1949,4 +1949,21 @@ object messages {
     val explanation =
       hl"${"@static"} members are only allowed inside objects."
   }
+
+  case class CyclicInheritance(symbol: Symbol, addendum: String)(implicit ctx: Context) extends Message(CyclicInheritanceID) {
+    val kind = "Syntax"
+    val msg = hl"Cyclic inheritance: $symbol extends itself$addendum"
+    val explanation = {
+      val codeExample = "class A extends A"
+
+      hl"""Cyclic inheritance is prohibited in Dotty.
+          |Consider the following example:
+          |
+          |$codeExample
+          |
+          |The example mentioned above would fail because this type of inheritance hierarchy
+          |creates a "cycle" where a not yet defined class A extends itself which makes
+          |impossible to instantiate an object of this class"""
+    }
+  }
 }

compiler/src/dotty/tools/dotc/typer/Namer.scala

@@ -869,7 +869,7 @@ class Namer { typer: Typer =>
                 "\n(Note that inheriting a class of the same name is no longer allowed)"
               case _ => ""
             }
-            ctx.error(i"cyclic inheritance: $cls extends itself$addendum", parent.pos)
+            ctx.error(CyclicInheritance(cls, addendum), parent.pos)
             defn.ObjectType
           }
           else {

compiler/test/dotty/tools/dotc/reporting/ErrorMessagesTests.scala

@@ -1225,7 +1225,6 @@ class ErrorMessagesTests extends ErrorMessagesTest {
         assertEquals("(class Int, class String)", argTypes.map(_.typeSymbol).mkString("(", ", ", ")"))
       }
 
-
   @Test def staticOnlyAllowedInsideObjects =
     checkMessagesAfter("checkStatic") {
       """
@@ -1238,4 +1237,16 @@ class ErrorMessagesTests extends ErrorMessagesTest {
       val StaticFieldsOnlyAllowedInObjects(field) = messages.head
       assertEquals(field.show, "method bar")
     }
+
+  @Test def cyclicInheritance =
+    checkMessagesAfter("frontend") {
+      "class A extends A"
+    }
+    .expect { (ictx, messages) =>
+      implicit val ctx: Context = ictx
+
+      assertMessageCount(1, messages)
+      val CyclicInheritance(symbol, _) :: Nil = messages
+      assertEquals("class A", symbol.show)
+    }
 }