Signature coloring

Author: pikinier20

scaladoc/resources/dotty_res/styles/scalastyle.css

@@ -672,7 +672,7 @@ footer .mode {
 }
 .documentableElement .annotations {
   color: var(--grey600);
-  margin-left: 10em;
+  margin-left: 10.5em;
   display: none;
 }
 
@@ -885,6 +885,35 @@ footer .socials {
   height: 8px;
 }
 
+/* Signature coloring */
+
+:root {
+  --type-link: var(--blue500);
+  --type: var(--grey700);
+  --keyword: var(--red500);
+}
+
+:root.theme-dark {
+  --type-link: var(--blue400);
+  --keyword: var(--red400);
+}
+
+.signature *[t="t"]:not([href]) { /* Types without links */
+  color: var(--type);
+}
+
+.signature *[t="t"] { /* Types with links */
+  color: var(--type-link);
+}
+
+.signature *[t="k"] { /* Keywords */
+  color: var(--keyword);
+}
+
+.signature *:not[t] { /* Plain text */
+
+}
+
 /* Large Screens */
 @media(min-width: 1100px) {
   :root {

scaladoc/src/dotty/tools/scaladoc/api.scala

@@ -57,7 +57,7 @@ enum Kind(val name: String):
   case Trait(typeParams: Seq[TypeParameter], argsLists: Seq[ParametersList])
     extends Kind("trait") with Classlike
   case Enum(typeParams: Seq[TypeParameter], argsLists: Seq[ParametersList]) extends Kind("enum") with Classlike
-  case EnumCase(kind: Object.type | Type | Val.type | Class) extends Kind("case")
+  case EnumCase(kind: Object.type | Kind.Type | Val.type | Class) extends Kind("case")
   case Def(typeParams: Seq[TypeParameter], argsLists: Seq[ParametersList])
     extends Kind("def")
   case Extension(on: ExtensionTarget, m: Kind.Def) extends Kind("def")
@@ -117,15 +117,19 @@ case class TypeParameter(
   signature: Signature
 )
 
-// TODO (longterm) properly represent signatures
 case class Link(name: String, dri: DRI)
-type Signature = Seq[String | Link]
 
-object Signature:
-  def apply(names: (String | Link)*): Signature = names // TO batter dotty shortcommings in union types
+sealed trait SignaturePart
 
-extension (s: Signature)
-  def join(a: Signature): Signature = s ++ a
+// TODO (longterm) properly represent signatures
+case class Type(name: String, dri: Option[DRI]) extends SignaturePart
+case class Keyword(name: String) extends SignaturePart
+case class Plain(txt: String) extends SignaturePart
+
+type Signature = List[SignaturePart]
+
+object Signature:
+  def apply(names: (SignaturePart)*): Signature = names.toList
 
 case class LinkToType(signature: Signature, dri: DRI, kind: Kind)
 
@@ -230,8 +234,9 @@ extension (m: Module)
 extension (s: Signature)
   def getName: String =
     s.map {
-      case s: String => s
-      case l: Link => l.name
+      case Plain(s) => s
+      case Type(s, _) => s
+      case Keyword(s) => s
     }.mkString
 
 case class TastyMemberSource(path: java.nio.file.Path, lineNumber: Int)

scaladoc/src/dotty/tools/scaladoc/renderers/MemberRenderer.scala

@@ -280,13 +280,13 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
       }.collect {
         case (Some(on), members) =>
           val typeSig = InlineSignatureBuilder()
-            .text("extension ")
+            .keyword("extension ")
             .generics(on.typeParams)
             .asInstanceOf[InlineSignatureBuilder].names.reverse
           val argsSig = InlineSignatureBuilder()
             .functionParameters(on.argsLists)
             .asInstanceOf[InlineSignatureBuilder].names.reverse
-          val sig = typeSig ++ Signature(s"(${on.name}: ") ++ on.signature ++ Signature(")") ++ argsSig
+          val sig = typeSig ++ Signature(Plain(s"(${on.name}: ")) ++ on.signature ++ Signature(Plain(")")) ++ argsSig
           MGroup(span(sig.map(renderElement)), members.sortBy(_.name).toSeq, on.name)
       }.toSeq
 

scaladoc/src/dotty/tools/scaladoc/renderers/Resources.scala

@@ -127,8 +127,9 @@ trait Resources(using ctx: DocContext) extends Locations, Writer:
   def searchData(pages: Seq[Page]) =
     def flattenToText(signature: Signature): String =
       signature.map {
-        case Link(name, dri) => name
-        case s: String => s
+        case Type(name, dri) => name
+        case Plain(s) => s
+        case Keyword(s) => s
       }.mkString
 
     def mkEntry(dri: DRI, name: String, text: String, descr: String, kind: String) = jsonObject(
@@ -145,7 +146,7 @@ trait Resources(using ctx: DocContext) extends Locations, Writer:
           val descr = m.dri.asFileLocation
           def processMember(member: Member): Seq[JSON] =
             val signatureBuilder = ScalaSignatureProvider.rawSignature(member, InlineSignatureBuilder()).asInstanceOf[InlineSignatureBuilder]
-            val sig = Signature(member.kind.name, " ") ++ Seq(Link(member.name, member.dri)) ++ signatureBuilder.names.reverse
+            val sig = Signature(Plain(s"${member.kind.name} "), Plain(member.name)) ++ signatureBuilder.names.reverse
             val entry = mkEntry(member.dri, member.name, flattenToText(sig), descr, member.kind.name)
             val children = member
                 .membersBy(m => m.kind != Kind.Package && !m.kind.isInstanceOf[Classlike])

scaladoc/src/dotty/tools/scaladoc/renderers/SignatureRenderer.scala

@@ -15,7 +15,7 @@ trait SignatureRenderer:
   def currentDri: DRI
   def link(dri: DRI): Option[String]
 
-  def renderElement(e: String | (String, DRI) | Link) = renderElementWith(e)
+  def renderElement(e: SignaturePart) = renderElementWith(e)
 
   def renderLink(name: String, dri: DRI, modifiers: AppliedAttr*) =
     renderLinkContent(name, dri, modifiers:_*)
@@ -28,7 +28,10 @@ trait SignatureRenderer:
       case Some(link) => a(href := link, modifiers)(content)
       case _ => unresolvedLink(content, modifiers:_*)
 
-  def renderElementWith(e: String | (String, DRI) | Link, modifiers: AppliedAttr*) = e match
-    case (name, dri) => renderLink(name, dri, modifiers:_*)
-    case name: String => raw(name)
-    case Link(name, dri) => renderLink(name, dri, modifiers:_*)
+  def renderElementWith(e: SignaturePart, modifiers: AppliedAttr*) = e match
+    case Type(name, Some(dri)) =>
+      val attrs = Seq(Attr("t") := "t") ++ modifiers
+      renderLink(name, dri, attrs:_*)
+    case Type(name, None) => span(Attr("t") := "t")(name)
+    case Keyword(name) => span(Attr("t") := "k")(name)
+    case Plain(name) => raw(name)

scaladoc/src/dotty/tools/scaladoc/tasty/ClassLikeSupport.scala

@@ -435,7 +435,7 @@ trait ClassLikeSupport:
     val signature = contextBounds.get(name) match
       case None => boundsSignature
       case Some(contextBoundsSignature) =>
-        boundsSignature ++ DSignature(" : ") ++ contextBoundsSignature
+        boundsSignature ++ DSignature(Plain(" : ")) ++ contextBoundsSignature
 
     TypeParameter(
       argument.symbol.getAnnotations(),
@@ -546,8 +546,8 @@ trait ClassLikeSupport:
               case Nil => Left((name, original))
               case typeParam :: _ =>
                 val name = nameForRef(typeParam)
-                val signature = Seq(s"([$name] =>> ") ++ original.asSignature ++ Seq(")")
-                Right(name -> signature)
+                val signature = Seq(Plain("(["), dotty.tools.scaladoc.Type(name, None), Plain("]"), Keyword(" =>> ")) ++ original.asSignature ++ Seq(Plain(")"))
+                Right(name -> signature.toList)
         }
 
       val newParams = notEvidences ++ paramsThatLookLikeContextBounds