Pretty print top-level definitions object symbol

Author: nicolasstucki

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

@@ -109,7 +109,7 @@ object NameOps {
         false
     }
 
-    /** is this the name of an object enclosing packagel-level definitions? */
+    /** is this the name of an object enclosing package-level definitions? */
     def isPackageObjectName: Boolean = name match {
       case name: TermName => name == nme.PACKAGE || name.endsWith(str.TOPLEVEL_SUFFIX)
       case name: TypeName =>
@@ -119,6 +119,16 @@ object NameOps {
         }
     }
 
+    /** is this the name of an object enclosing top-level definitions? */
+    def isTopLevelPackageObjectName: Boolean = name match {
+      case name: TermName => name.endsWith(str.TOPLEVEL_SUFFIX)
+      case name: TypeName =>
+        name.toTermName match {
+          case ModuleClassName(original) => original.isTopLevelPackageObjectName
+          case _ => false
+        }
+    }
+
     /** Convert this module name to corresponding module class name */
     def moduleClassName: TypeName = name.derived(ModuleClassName).toTypeName
 

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

@@ -672,6 +672,10 @@ object SymDenotations {
     def isPackageObject(using Context): Boolean =
       name.isPackageObjectName && owner.is(Package) && this.is(Module)
 
+    /** Is this symbol a package object containing top-level definitions? */
+    def isTopLevelDefinitionsObject(using Context): Boolean =
+      name.isTopLevelPackageObjectName && owner.is(Package) && this.is(Module)
+
     /** Is this symbol a toplevel definition in a package object? */
     def isWrappedToplevelDef(using Context): Boolean =
       !isConstructor && owner.isPackageObject

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

@@ -1113,13 +1113,18 @@ class RefinedPrinter(_ctx: Context) extends PlainPrinter(_ctx) {
         fullNameString(sym)
       else if (sym.is(ModuleClass) && sym.isPackageObject && sym.name.stripModuleClassSuffix == tpnme.PACKAGE)
         nameString(sym.owner.name)
+      else if (sym.is(ModuleClass) && sym.isTopLevelDefinitionsObject)
+        nameString(sym.owner.name)
       else if (sym.is(ModuleClass))
         nameString(sym.name.stripModuleClassSuffix) + idString(sym)
       else if (hasMeaninglessName(sym))
         simpleNameString(sym.owner) + idString(sym)
       else
         nameString(sym)
-    (keywordText(kindString(sym)) ~~ {
+
+    if sym.is(ModuleClass) && sym.isTopLevelDefinitionsObject then
+      "top-level definition in package " + nameString(sym.owner.name)
+    else (keywordText(kindString(sym)) ~~ {
       if (sym.isAnonymousClass)
         toTextParents(sym.info.parents) ~~ "{...}"
       else

tests/neg-macros/annot-result-owner.check

@@ -2,7 +2,7 @@
 -- Error: tests/neg-macros/annot-result-owner/Test_2.scala:1:0 ---------------------------------------------------------
 1 |@insertVal // error
   |^^^^^^^^^^
-  |macro annotation @insertVal added value definitionWithWrongOwner$macro$1 with an inconsistent owner. Expected it to be owned by package object Test_2$package but was owned by method foo.
+  |macro annotation @insertVal added value definitionWithWrongOwner$macro$1 with an inconsistent owner. Expected it to be owned by top-level definition in package <empty> but was owned by method foo.
 -- Error: tests/neg-macros/annot-result-owner/Test_2.scala:5:2 ---------------------------------------------------------
 5 |  @insertVal // error
   |  ^^^^^^^^^^

tests/neg/i12573.check

@@ -1,9 +1,9 @@
 -- [E008] Not Found Error: tests/neg/i12573.scala:23:38 ----------------------------------------------------------------
 23 |val w: Value[8] = DFBits(Value[8](8)).getDFType.width // error
    |                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-   |         value getDFType is not a member of DFBits[(8 : Int)].
-   |         Extension methods were tried, but the search failed with:
+   |value getDFType is not a member of DFBits[(8 : Int)].
+   |Extension methods were tried, but the search failed with:
    |
-   |             method getDFType cannot be accessed as a member of DFType.type from package object i12573$package.
-   |              Access to protected method getDFType not permitted because enclosing package object i12573$package
-   |              is not a subclass of object DFType where target is defined
+   |    method getDFType cannot be accessed as a member of DFType.type from top-level definition in package <empty>.
+   |     Access to protected method getDFType not permitted because enclosing top-level definition in package <empty>
+   |     is not a subclass of object DFType where target is defined

tests/neg/not-accessible.check

@@ -9,12 +9,12 @@
 -- [E173] Reference Error: tests/neg/not-accessible.scala:13:23 --------------------------------------------------------
 13 |    def test(a: A) = a.x // error
    |                     ^^^
-   |               value x cannot be accessed as a member of (a : foo.A) from package object not-accessible$package.
+   |                 value x cannot be accessed as a member of (a : foo.A) from top-level definition in package bar.
 -- [E173] Reference Error: tests/neg/not-accessible.scala:5:21 ---------------------------------------------------------
 5 |  def test(a: A) = a.x // error
   |                   ^^^
-  |                 value x cannot be accessed as a member of (a : foo.A) from package object not-accessible$package.
+  |                   value x cannot be accessed as a member of (a : foo.A) from top-level definition in package foo.
 -- [E173] Reference Error: tests/neg/not-accessible.scala:15:23 --------------------------------------------------------
 15 |def test(a: foo.A) = a.x // error
    |                     ^^^
-   |               value x cannot be accessed as a member of (a : foo.A) from package object not-accessible$package.
+   |             value x cannot be accessed as a member of (a : foo.A) from top-level definition in package <empty>.