Adapt search to new renderer

Author: romanowski

scala3doc-js/src/searchbar/PageEntry.scala

@@ -4,10 +4,10 @@ import scala.scalajs.js
 
 @js.native
 trait PageEntryJS extends js.Object {
-  val name: String = js.native
-  val description: String = js.native
-  val location: String = js.native
-  val searchKeys: js.Array[String] = js.native
+  val n: String = js.native
+  val t: String = js.native
+  val d: String = js.native
+  val l: String = js.native
 }
 
 case class PageEntry(
@@ -23,10 +23,10 @@ object PageEntry {
     s.headOption.map(firstLetter => firstLetter.toString ++ s.tail.filter(_.isUpper))
 
   def apply(jsObj: PageEntryJS): PageEntry = PageEntry(
-    jsObj.name,
-    jsObj.description,
-    jsObj.location,
-    jsObj.searchKeys.head.toLowerCase,
-    createAcronym(jsObj.searchKeys.head)
+    jsObj.t,
+    jsObj.d,
+    jsObj.l,
+    jsObj.n.toLowerCase,
+    createAcronym(jsObj.n)
   )
 }

scala3doc-js/src/searchbar/engine/SearchbarEngine.scala

@@ -2,8 +2,8 @@ package dotty.dokka
 
 import math.Ordering.Implicits.seqOrdering
 
-class SearchbarEngine(pages: List[PageEntry]) {
-  def query(query: List[Matchers]): List[PageEntry] = {
+class SearchbarEngine(pages: List[PageEntry]):
+  def query(query: List[Matchers]): List[PageEntry] =
     pages
       .map( page =>
         page -> query.map(matcher => matcher(page))
@@ -17,5 +17,3 @@ class SearchbarEngine(pages: List[PageEntry]) {
       .map {
         case (page, matchResults) => page
       }
-  }
-}

scala3doc/src/dotty/renderers/HtmlRenderer.scala

@@ -61,6 +61,8 @@ class HtmlRenderer(rootPackage: Member, val members: Map[DRI, Member], buildNode
   val hiddenPages: Seq[Page] =
     staticSite.toSeq.flatMap(c => c.orphanedTemplates.map(templateToPage(_, c)))
 
+  val allPages = navigablePage +: hiddenPages
+
   def renderContent(page: Page) = page.content match
     case m: Member =>
       val signatureRenderer = new SignatureRenderer:
@@ -103,15 +105,14 @@ class HtmlRenderer(rootPackage: Member, val members: Map[DRI, Member], buildNode
         files.map(p => siteRoot.relativize(p).toString).toList
     }
 
-    val siteResourcesPaths =
-      (navigablePage +: hiddenPages).toSet.flatMap(specificResources) ++ siteImages
+    val siteResourcesPaths = allPages.toSet.flatMap(specificResources) ++ siteImages
 
-    val resources = siteResourcesPaths.toSeq.map(pathToResource) ++ allResources(rootPackage)
+    val resources = siteResourcesPaths.toSeq.map(pathToResource) ++ allResources(allPages)
     resources.flatMap(renderResource)
 
   def render(): Unit =
     val renderedResources = renderResources()
-    val sites = (navigablePage +: hiddenPages).map(renderPage(_, Vector.empty))
+    val sites = allPages.map(renderPage(_, Vector.empty))
 
   def mkHead(page: Page): AppliedTag =
     val resources = page.content match
@@ -187,7 +188,7 @@ class HtmlRenderer(rootPackage: Member, val members: Map[DRI, Member], buildNode
         div (id := "leftToggler")(
           span(cls := "icon-toggler")
         ),
-        div(id := "searchBar"),
+        div(id := "scala3doc-searchBar"),
         main(
           div(id := "content")(
             parentsHtml,

scala3doc/src/dotty/renderers/Locations.scala

@@ -71,12 +71,14 @@ trait Locations(using ctx: DocContext):
     pathTo(to.split("/").toList, from)
 
   def resolveRoot(dri: DRI, path: String): String = resolveRoot(rawLocation(dri), path)
+  def absolutePath(dri: DRI): String = rawLocation(dri).mkString("", "/", ".html")
 
   def resolveLink(dri: DRI, url: String): String =
     if URI(url).isAbsolute then url else resolveRoot(dri, url)
 
-  def pathToRoot(dri: DRI): String =
-    pathTo(rawLocation(dri), Nil).dropRight(1)
+  def pathToRoot(dri: DRI): String = rawLocation(dri).drop(1).map(_ => "..") match
+    case Nil => ""
+    case seq => seq.mkString("", "/", "/")
 
   def driExisits(dri: DRI) = true // TODO implement checks!
 

scala3doc/src/dotty/renderers/Resources.scala

@@ -60,6 +60,7 @@ trait Resources(using ctx: DocContext) extends Locations, Writter:
       "styles/diagram.css",
       "styles/filter-bar.css",
       "styles/search-bar.css",
+      "styles/scala3doc-searchbar.css",
       "hljs/highlight.pack.js",
       "hljs/LICENSE",
       "scripts/hljs-scala3.js",
@@ -71,6 +72,7 @@ trait Resources(using ctx: DocContext) extends Locations, Writter:
       "scripts/components/Input.js",
       "scripts/components/FilterGroup.js",
       "scripts/components/Filter.js",
+      "scripts/searchbar.js"
     ).map(dottyRes)
 
     val urls = List(
@@ -82,18 +84,58 @@ trait Resources(using ctx: DocContext) extends Locations, Writter:
 
     fromResources ++ urls ++ projectLogo ++ Seq(scala3docVersionFile, dynamicJsData)
 
-  val memberResourcesPaths = memberResources.map(_.path)
-
-  val scala3docLogo = dottyRes("images/scala3doc_logo.svg")
-
-  def packageList(topLevelPackage: Member) = Resource.Text("scala3doc/package-list", "TODO")
-
-  def allResources(topLevelPackage: Member): Seq[Resource] = memberResources ++ Seq(
+  val searchDataPath = "scripts/searchData.js"
+  val memberResourcesPaths = Seq(searchDataPath) ++ memberResources.map(_.path)
+
+  case class PageEntry(
+    dri: DRI,
+    name: String,
+    text: String,
+    descr: String,
+  ):
+    // for jackson
+    def getL: String = absolutePath(dri)
+    def getN: String = name
+    def getT: String = text
+    def getD: String = descr
+
+  def searchData(pages: Seq[Page]) =
+    def flattenToText(signature: Signature): String =
+      signature.map {
+        case Link(name, dri) => name
+        case s: String => s
+      }.mkString
+
+    def processPage(page: Page): Seq[PageEntry] =
+      val res =  page.content match
+        case m: Member =>
+          val descr = m.dri.location.replace("/", ".")
+          def processMember(member: Member): Seq[PageEntry] =
+            val signatureBuilder = ScalaSignatureProvider.rawSignature(member, InlineSignatureBuilder()).asInstanceOf[InlineSignatureBuilder]
+            val sig = Signature(member.kind.name, " ") ++ Seq(Link(member.name, member.dri)) ++ signatureBuilder.names.reverse
+            val entry = PageEntry(member.dri, member.name, flattenToText(sig), descr)
+            val children = member
+                .membersBy(m => m.kind != dotty.dokka.model.api.Kind.Package && !m.kind.isInstanceOf[Classlike])
+                .filter(m => m.origin == Origin.RegularlyDefined && m.inheritedFrom.isEmpty)
+            Seq(entry) ++ children.flatMap(processMember)
+
+          processMember(m)
+        case _ =>
+          Seq(PageEntry(page.link.dri, page.link.name, page.link.name, ""))
+
+      res ++ page.children.flatMap(processPage)
+
+    val entries = pages.flatMap(processPage).toArray
+    val entriesText = new ObjectMapper().writeValueAsString(entries)
+    Resource.Text(searchDataPath, s"pages = $entriesText;")
+
+
+  def allResources(pages: Seq[Page]): Seq[Resource] = memberResources ++ Seq(
     dottyRes("favicon.ico"),
     dottyRes("fonts/dotty-icons.woff"),
     dottyRes("fonts/dotty-icons.ttf"),
-    scala3docLogo,
-    packageList(topLevelPackage)
+    dottyRes("images/scala3doc_logo.svg"),
+    searchData(pages)
   )
 
   def renderResource(resource: Resource): Seq[String] =

scala3doc/src/dotty/renderers/Writter.scala

@@ -17,8 +17,8 @@ trait Writter(using ctx: DocContext) extends Locations:
     if !Files.exists(absPath.getParent) then Files.createDirectories(absPath.getParent)
     absPath
 
-  def write(dri: DRI, content: AppliedTag, ext: String = ".html"): String =
-    val path = rawLocation(dri).mkString("", "/", ext)
+  def write(dri: DRI, content: AppliedTag): String =
+    val path = absolutePath(dri)
     Files.write(dest(path), content.toString.getBytes)
     path