Add NameNormalizer

Author: pikinier20

scala3doc/src/dotty/dokka/tasty/ClassLikeSupport.scala

@@ -30,7 +30,7 @@ trait ClassLikeSupport:
   object DClass:
     def apply[T >: DClass](classDef: ClassDef)(
       dri: DRI = classDef.symbol.dri,
-      name: String = classDef.name,
+      name: String = classDef.symbol.normalizedName,
       signatureOnly: Boolean = false,
       modifiers: Seq[Modifier] = classDef.symbol.getExtraModifiers(),
     ): DClass =
@@ -109,7 +109,7 @@ trait ClassLikeSupport:
   private def parseMember(s: Tree): Option[Member] = processTreeOpt(s)(s match
       case dd: DefDef if !dd.symbol.isHiddenByVisibility && !dd.symbol.isSyntheticFunc && dd.symbol.isExtensionMethod =>
         dd.symbol.extendedSymbol.map { extSym =>
-          val target = ExtensionTarget(extSym.symbol.name, extSym.tpt.dokkaType.asSignature, extSym.tpt.symbol.dri)
+          val target = ExtensionTarget(extSym.symbol.normalizedName, extSym.tpt.dokkaType.asSignature, extSym.tpt.symbol.dri)
           parseMethod(dd.symbol, kind = Kind.Extension(target))
         }
       // TODO check given methods?
@@ -164,7 +164,7 @@ trait ClassLikeSupport:
   private def parseInheritedMember(s: Tree): Option[Member] = processTreeOpt(s)(s match
     case c: ClassDef if c.symbol.shouldDocumentClasslike && !c.symbol.isGiven => Some(parseClasslike(c, signatureOnly = true))
     case other => parseMember(other)
-  ).map(_.withOrigin(Origin.InheritedFrom(s.symbol.owner.name, s.symbol.owner.dri)))
+  ).map(_.withOrigin(Origin.InheritedFrom(s.symbol.owner.normalizedName, s.symbol.owner.dri)))
 
   extension (c: ClassDef):
     def membersToDocument = c.body.filterNot(_.symbol.isHiddenByVisibility)
@@ -197,7 +197,7 @@ trait ClassLikeSupport:
     }.toList
 
     def getParameterModifier(parameter: Symbol): String =
-      val fieldSymbol = c.symbol.field(parameter.name)
+      val fieldSymbol = c.symbol.field(parameter.normalizedName)
       if fieldSymbol.flags.is(Flags.Mutable) then "var "
       else if fieldSymbol.flags.is(Flags.ParamAccessor) && !c.symbol.flags.is(Flags.Case) && !fieldSymbol.flags.is(Flags.Private) then "val "
       else ""
@@ -221,7 +221,6 @@ trait ClassLikeSupport:
 
   def parseObject(classDef: ClassDef, signatureOnly: Boolean = false)(using ctx: Context): DClass =
     DClass(classDef)(
-      name = classDef.name.stripSuffix("$"),
       // All objects are final so we do not need final modifer!
       modifiers = classDef.symbol.getExtraModifiers().filter(_ != Modifier.Final),
       signatureOnly = signatureOnly
@@ -266,11 +265,7 @@ trait ClassLikeSupport:
           Kind.Implicit(Kind.Def, None)
       else kind
 
-    val name = methodKind match
-      case Kind.Constructor => "this"
-      case Kind.Given(_, _) => methodSymbol.name.stripPrefix("given_")
-      case Kind.Extension(_) => methodSymbol.name.stripPrefix("extension_")
-      case _ => methodSymbol.name
+    val name = method.symbol.normalizedName
 
     new DFunction(
       methodSymbol.dri,
@@ -302,7 +297,7 @@ trait ClassLikeSupport:
   def parseArgument(argument: ValDef, prefix: Symbol => String, isExtendedSymbol: Boolean = false, isGrouped: Boolean = false): DParameter =
     new DParameter(
       argument.symbol.dri,
-      prefix(argument.symbol) + argument.symbol.name,
+      prefix(argument.symbol) + argument.symbol.normalizedName,
       argument.symbol.documentation.asJava,
       null,
       argument.tpt.dokkaType,
@@ -320,7 +315,7 @@ trait ClassLikeSupport:
       else ""
 
     new DTypeParameter(
-      Invariance(TypeParameter(argument.symbol.dri, variancePrefix + argument.symbol.name, null)),
+      Invariance(TypeParameter(argument.symbol.dri, variancePrefix + argument.symbol.normalizedName, null)),
       argument.symbol.documentation.asJava,
       null,
       JList(argument.rhs.dokkaType),
@@ -343,7 +338,7 @@ trait ClassLikeSupport:
 
     new DProperty(
       typeDef.symbol.dri,
-      typeDef.name,
+      typeDef.symbol.normalizedName,
       /*documentation =*/ typeDef.symbol.documentation.asJava,
       /*expectPresentInSet =*/ null, // unused
       /*sources =*/ JMap(),
@@ -374,7 +369,7 @@ trait ClassLikeSupport:
 
     new DProperty(
       valDef.symbol.dri,
-      valDef.name,
+      valDef.symbol.normalizedName,
       /*documentation =*/ valDef.symbol.documentation.asJava,
       /*expectPresentInSet =*/ null, // unused
       /*sources =*/ JMap(),

scala3doc/src/dotty/dokka/tasty/NameNormalizer.scala

@@ -0,0 +1,14 @@
+package dotty.dokka.tasty
+
+import dotty.dokka._
+
+trait NameNormalizer:
+    self: TastyParser =>
+    import qctx.reflect._
+    extension (s: Symbol) def normalizedName: String = {
+        val withoutGivenPrefix = if s.isGiven then s.name.stripPrefix("given_") else s.name
+        val withoutExtensionPrefix = if s.isExtensionMethod then withoutGivenPrefix.stripPrefix("extension_") else withoutGivenPrefix
+        val withoutObjectSuffix = if s.flags.is(Flags.Object) then withoutExtensionPrefix.stripSuffix("$") else withoutExtensionPrefix
+        val constructorNormalizedName = if s.isClassConstructor then "this" else withoutObjectSuffix
+        constructorNormalizedName
+    }

scala3doc/src/dotty/dokka/tasty/TastyParser.scala

@@ -157,7 +157,7 @@ trait DokkaBaseTastyInspector:
 
 /** Parses a single Tasty compilation unit. */
 case class TastyParser(qctx: QuoteContext, inspector: DokkaBaseTastyInspector, config: DottyDokkaConfig)
-    extends ScaladocSupport with BasicSupport with TypesSupport with ClassLikeSupport with SyntheticsSupport with PackageSupport:
+    extends ScaladocSupport with BasicSupport with TypesSupport with ClassLikeSupport with SyntheticsSupport with PackageSupport with NameNormalizer:
   import qctx.reflect._
 
   def sourceSet = inspector.sourceSet

scala3doc/src/dotty/dokka/tasty/TypesSupport.scala

@@ -61,7 +61,7 @@ trait TypesSupport:
 
   private def link(symbol: Symbol)(using cxt: Context): List[JProjection] = {
     val suffix = if symbol.isValDef then texts(".type") else Nil
-    (new TypeParameter(symbol.dri, symbol.name, null)) :: suffix
+    (new TypeParameter(symbol.dri, symbol.normalizedName, null)) :: suffix
   }
 
   private def commas(lists: List[List[JProjection]]) = lists match