Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
dotty.tools.scaladoc.renderers.HtmlRenderer.scala Maven / Gradle / Ivy
package dotty.tools.scaladoc
package renderers
import util.HTML._
import dotty.tools.scaladoc.site._
import org.jsoup.Jsoup
import java.nio.file.Files
class HtmlRenderer(rootPackage: Member, members: Map[DRI, Member])(using ctx: DocContext)
extends Renderer(rootPackage, members, extension = "html"):
override def pageContent(page: Page, parents: Vector[Link]): AppliedTag =
val PageContent(content, toc) = renderContent(page)
val contentStr =
content.toString.stripPrefix("\n").stripPrefix("").stripSuffix("\n").stripSuffix("
")
val document = Jsoup.parse(contentStr)
val docHead = raw(document.head().html())
val docBody = raw(document.body().html())
val attrs: List[AppliedAttr] = (page.content match
case ResolvedTemplate(loadedTemplate, _) =>
val path = loadedTemplate.templateFile.file.toPath
ctx.sourceLinks.repoSummary(path) match
case Some(DefinedRepoSummary("github", org, repo)) =>
ctx.sourceLinks.fullPath(relativePath(path)).fold(Nil) { contributorsFilename =>
List[AppliedAttr](
Attr("data-githubContributorsUrl") := s"https://api.github.com/repos/$org/$repo",
Attr("data-githubContributorsFilename") := s"$contributorsFilename",
)
}
case _ => Nil
case _ => Nil)
:+ (Attr("data-pathToRoot") := pathToRoot(page.link.dri))
:+ (Attr("data-rawLocation") := rawLocation(page.link.dri).mkString("/"))
:+ (Attr("data-dynamicSideMenu") := ctx.args.dynamicSideMenu.toString)
val htmlTag = html(attrs*)(
head((mkHead(page) :+ docHead)*),
body(
if !page.hasFrame then docBody
else mkFrame(page.link, parents, docBody, toc)
)
)
val doctypeTag = s""
val finalTag = raw(doctypeTag + htmlTag.toString)
finalTag
override def render(): Unit =
val renderedResources = renderResources()
if ctx.args.dynamicSideMenu then serializeSideMenu()
super.render()
private def serializeSideMenu() =
import com.fasterxml.jackson.databind.*
import com.fasterxml.jackson.databind.node.ObjectNode
import com.fasterxml.jackson.databind.node.TextNode
val mapper = new ObjectMapper();
def serializePage(page: Page): ObjectNode =
import scala.jdk.CollectionConverters.SeqHasAsJava
val children = mapper.createArrayNode().addAll(page.children.filterNot(_.hidden).map(serializePage).asJava)
val location = mapper.createArrayNode().addAll(rawLocation(page.link.dri).map(TextNode(_)).asJava)
val obj = mapper.createObjectNode()
obj.set("name", new TextNode(page.link.name))
obj.set("location", location)
obj.set("kind", page.content match
case m: Member if m.needsOwnPage => new TextNode(m.kind.name)
case _ => null
)
obj.set("children", children)
obj
val rootNode = mapper.createObjectNode()
rootNode.set("docs", rootDocsPage.map(serializePage).orNull)
rootNode.set("api", rootApiPage.map(serializePage).orNull)
val jsonString = mapper.writer().writeValueAsString(rootNode);
renderResource(Resource.Text("dynamicSideMenu.json", jsonString))
private def renderResources(): Seq[String] =
import scala.util.Using
import scala.jdk.CollectionConverters._
// All static site resources need to be in _assets folder
val staticSiteResources = staticSite
.map(_.root.toPath.resolve("_assets").toFile)
.filter(f => f.exists && f.isDirectory)
.toSeq
.flatMap { resourceFile =>
resourceFile.listFiles.toSeq.map(_.toPath).flatMap { file =>
Using(Files.walk(file)) { stream =>
stream.iterator().asScala.toSeq
.map(from => Resource.File(resourceFile.toPath.relativize(from).toString, from))
}.fold (
{ t =>
report.warn(s"Error occured while processing _assets file.", t)
Seq.empty
},
identity
)
}
}
val resources = staticSiteResources ++ allResources(allPages) ++ onlyRenderedResources
resources.flatMap(renderResource)
def mkHead(page: Page): Seq[TagArg] =
val resources = page.content match
case t: ResolvedTemplate =>
t.resolved.resources ++ (if t.hasFrame then commonResourcesPaths ++ staticSiteOnlyResourcesPaths else Nil)
case _ =>
commonResourcesPaths ++ apiOnlyResourcesPaths
val earlyResources = page.content match
case t: ResolvedTemplate => if t.hasFrame then earlyCommonResourcePaths else Nil
case _ => earlyCommonResourcePaths
Seq(
meta(charset := "utf-8"),
meta(util.HTML.name := "viewport", content := "width=device-width, initial-scale=1, maximum-scale=1"),
title(page.link.name),
canonicalUrl(absolutePath(page.link.dri)),
link(
rel := "shortcut icon",
`type` := "image/x-icon",
href := resolveLink(page.link.dri, "favicon.ico")
),
linkResources(page.link.dri, earlyResources, deferJs = false).toList,
linkResources(page.link.dri, resources, deferJs = true).toList,
script(raw(s"""var pathToRoot = "${pathToRoot(page.link.dri)}";""")),
ctx.args.versionsDictionaryUrl match
case Some(url) => script(raw(s"""var versionsDictionaryUrl = "$url";"""))
case None => ""
)
private def buildNavigation(pageLink: Link): (Option[(Boolean, Seq[AppliedTag])], Option[(Boolean, Seq[AppliedTag])]) =
def navigationIcon(member: Member) = member match {
case m if m.needsOwnPage => Seq(span(cls := s"micon ${member.kind.name.take(2)}"))
case _ => Nil
}
def renderNested(nav: Page, nestLevel: Int, prefix: String = ""): (Boolean, AppliedTag) =
val isApi = nav.content.isInstanceOf[Member]
val isSelected = nav.link.dri == pageLink.dri
val isTopElement = nestLevel == 0
val name = nav.content match {
case m: Member if m.kind == Kind.Package =>
m.name.stripPrefix(prefix).stripPrefix(".")
case _ => nav.link.name
}
val newPrefix = if prefix == "" then name else s"$prefix.$name"
def linkHtml(expanded: Boolean = false, withArrow: Boolean = false) =
val attrs: Seq[String] = Seq(
Option.when(isSelected || expanded)("h100"),
Option.when(isSelected)("selected"),
Option.when(expanded)("expanded cs"),
Option.when(!isApi)("de"),
).flatten
val icon = nav.content match {
case m: Member => navigationIcon(m)
case _ => Nil
}
Seq(
span(cls := s"nh " + attrs.mkString(" "))(
if withArrow then Seq(button(cls := s"ar icon-button ${if isSelected || expanded then "expanded" else ""}")) else Nil,
a(href := (if isSelected then "#" else pathToPage(pageLink.dri, nav.link.dri)))(icon, span(name))
)
)
nav.children.filterNot(_.hidden) match
case Nil => isSelected -> div(cls := s"ni n$nestLevel ${if isSelected then "expanded" else ""}")(linkHtml())
case children =>
val nested = children.map(renderNested(_, nestLevel + 1, newPrefix))
val expanded = nested.exists(_._1)
val attr =
if expanded || isSelected then Seq(cls := s"ni n$nestLevel expanded") else Seq(cls := s"ni n$nestLevel")
(isSelected || expanded) -> div(attr)(
linkHtml(expanded, true),
nested.map(_._2)
)
val isRootApiPageSelected = rootApiPage.fold(false)(_.link.dri == pageLink.dri)
val isDocsApiPageSelected = rootDocsPage.fold(false)(_.link.dri == pageLink.dri)
val apiNav = rootApiPage.map { p => p.children.filterNot(_.hidden).map(renderNested(_, 0)) match
case entries => (entries.exists(_._1) || isRootApiPageSelected, entries.map(_._2))
}
val docsNav = rootDocsPage.map { p => p.children.filterNot(_.hidden).map(renderNested(_, 0)) match
case entries => (entries.exists(_._1) || isDocsApiPageSelected, entries.map(_._2))
}
(apiNav, docsNav)
private def hasSocialLinks = !args.socialLinks.isEmpty
private def socialLinks =
def icon(link: SocialLinks) = link.className
args.socialLinks.map { link =>
a(href := link.url) (
link match
case SocialLinks.Custom(_, lightIcon, darkIcon) =>
Seq(
button(cls := s"icon-button ${icon(link)}", style := s"--bgimage:url(../../../../images/$lightIcon)"),
button(cls := s"icon-button ${icon(link)}-dark", style := s"--bgimage-dark:url(../../../../images/$darkIcon)")
)
case _ =>
button(cls := s"icon-button ${icon(link)}")
)
}
private def renderTableOfContents(toc: Seq[TocEntry]): Option[AppliedTag] =
def renderTocRec(level: Int, rest: Seq[TocEntry]): Seq[AppliedTag] =
rest match {
case Nil => Nil
case head :: tail if head.level == level =>
val (nested, rest) = tail.span(_.level > level)
val nestedList = if nested.nonEmpty then Seq(ul(renderTocRec(level + 1, nested))) else Nil
li(a(href := head.anchor)(head.content), nestedList) +: renderTocRec(level, rest)
case rest @ (head :: tail) if head.level > level =>
val (prefix, suffix) = rest.span(_.level > level)
li(ul(renderTocRec(level + 1, prefix))) +: renderTocRec(level, suffix)
}
if toc.nonEmpty then
val minLevel = toc.minBy(_.level).level
Some(nav(cls := "toc-nav")(ul(cls := "toc-list")(renderTocRec(minLevel, toc))))
else None
private def mkFrame(link: Link, parents: Vector[Link], content: AppliedTag, toc: Seq[TocEntry]): AppliedTag =
val projectLogoElem =
projectLogo.flatMap {
case Resource.File(path, _) =>
Some(span(id := "project-logo", cls := "project-logo")(img(src := resolveRoot(link.dri, path))))
case _ => None
}
val darkProjectLogoElem =
darkProjectLogo.orElse(projectLogo).flatMap {
case Resource.File(path, _) =>
Some(span(id := "dark-project-logo", cls := "project-logo")(img(src := resolveRoot(link.dri, path))))
case _ => None
}
val parentsHtml =
val innerTags = parents.flatMap[TagArg](b => Seq(
a(href := pathToPage(link.dri, b.dri))(b.name),
"/"
)).dropRight(1)
div(cls := "breadcrumbs container")(innerTags*)
val dynamicSideMenu = ctx.args.dynamicSideMenu
val (apiNavOpt, docsNavOpt) = if dynamicSideMenu then (None, None) else buildNavigation(link)
def textFooter: String =
args.projectFooter.getOrElse("")
def quickLinks(mobile: Boolean = false): TagArg =
val className = if mobile then "mobile-menu-item" else "text-button"
args.quickLinks.map { quickLink =>
a(href := quickLink.url, cls := className)(quickLink.text)
}
div(id := "")(
div(id := "header", cls := "body-small")(
div(cls := "header-container-left")(
a(href := pathToRoot(link.dri), cls := "logo-container")(
projectLogoElem.toSeq,
darkProjectLogoElem.toSeq,
span(cls := "project-name h300")(args.name)
),
span(onclick := "dropdownHandler(event)", cls := "text-button with-arrow", id := "dropdown-trigger")(
a(args.projectVersion.map(v => div(cls:="projectVersion")(v)).toSeq),
),
div(id := "version-dropdown", cls := "dropdown-menu") ()
),
div(cls:="header-container-right")(
button(id := "search-toggle", cls := "icon-button"),
quickLinks(),
span(id := "theme-toggle", cls := "icon-button"),
span(id := "mobile-menu-toggle", cls := "icon-button hamburger"),
),
),
div(id := "mobile-menu")(
div(cls := "mobile-menu-header body-small")(
span(cls := "mobile-menu-logo")(
projectLogoElem.toSeq,
darkProjectLogoElem.toSeq,
span(cls := "project-name h300")(args.name)
),
button(id := "mobile-menu-close", cls := "icon-button close"),
),
div(cls := "mobile-menu-container body-medium")(
input(id := "mobile-scaladoc-searchbar-input", cls := "scaladoc-searchbar-input", `type` := "search", `placeholder`:= "Find anything"),
quickLinks(mobile = true),
span(id := "mobile-theme-toggle", cls := "mobile-menu-item mode"),
)
),
span(id := "mobile-sidebar-toggle", cls := "floating-button"),
div(id := "leftColumn", cls := "body-small")(
if dynamicSideMenu then Nil else Seq(
div(cls:= "switcher-container")(
docsNavOpt match {
case Some(isDocsActive, docsNav) =>
Seq(a(id := "docs-nav-button", cls:= s"switcher h100 ${if isDocsActive then "selected" else ""}", href := pathToPage(link.dri, rootDocsPage.get.link.dri))("Docs"))
case _ => Nil
},
apiNavOpt match {
case Some(isApiActive, apiNav) =>
Seq(a(id := "api-nav-button", cls:= s"switcher h100 ${if isApiActive then "selected" else ""}", href := pathToPage(link.dri, rootApiPage.get.link.dri))("API"))
case _ => Nil
}
),
apiNavOpt
.filter(_._1)
.map(apiNav => nav(id := "api-nav", cls := s"side-menu")(apiNav._2))
.orElse(docsNavOpt.map(docsNav => nav(id := "docs-nav", cls := s"side-menu")(docsNav._2)))
.get
)
),
div(id := "footer", cls := "body-small")(
div(cls := "left-container")(
"Generated with"
),
div(cls := "right-container")(
socialLinks,
div(cls := "text")(textFooter)
),
div(cls := "text-mobile")(textFooter)
),
div(id := "scaladoc-searchBar"),
div(id := "main")(
parentsHtml,
div(id := "content", cls := "body-medium")(
div(content),
div(id := "toc", cls:="body-small")(
renderTableOfContents(toc).fold(Nil) { toc =>
div(id := "toc-container")(
span(cls := "toc-title h200")("In this article"),
toc,
)
},
),
),
div(id := "footer", cls := "body-small mobile-footer")(
div(cls := "left-container")(
"Generated with"
),
div(cls := "right-container")(
socialLinks,
div(cls := "text")(textFooter)
),
div(cls := "text-mobile")(textFooter)
),
),
)
